level=0, show_full_path=False)
if options.debug:
- print_debug(config, str(options.debug), not options.no_label, logger,
+ CFGMGR.print_debug(config, str(options.debug), logger, not options.no_label,
level=0, show_full_path=False)
# case : edit user pyconf file or application file
class Machine(object):
- '''Class to manage a ssh connection on a machine
- '''
+ """\
+ Manage a ssh connection on a machine
+ """
def __init__(self,
name,
host,
def connect(self, logger):
'''Initiate the ssh connection to the remote machine
- :param logger src.logger.Logger: The logger instance
+ :param logger: The logger instance
:return: Nothing
- :rtype: N\A
'''
self._connection_successful = False
"""\
Verify if the connection to the remote machine has succeed
- :param logger src.logger.Logger: The logger instance
+ :param logger: The logger instance
:return: True if the connection has succeed, False if not
:rtype: bool
"""
'''Execute the command on the remote machine
:param command str: The command to be run
- :param logger src.logger.Logger: The logger instance
+ :param logger: The logger instance
:return: the stdin, stdout, and stderr of the executing command,
as a 3-tuple
:rtype: (paramiko.channel.ChannelFile, paramiko.channel.ChannelFile,
Prints the informations relative to the machine in the logger
(terminal traces and log file)
- :param logger src.logger.Logger: The logger instance
+ :param logger: The logger instance
:return: Nothing
:rtype: N\A
"""
# Create or update the hat xml that gives access to all the commands log files
logger.info(_("Generating the hat log file (can be long) ... "))
xmlHatFilePath = os.path.join(logDir, 'hat.xml')
- src.logger.update_hat_xml(logDir,
- application = config.VARS.application,
- notShownCommands = notShownCommands)
+ UTS.update_hat_xml(logDir,
+ application = config.VARS.application,
+ notShownCommands = notShownCommands)
logger.info("<OK>\n")
# open the hat xml in the user editor
if not options.no_browser:
- logger.info(_("\nOpening the log file\n"))
+ logger.info(_("Opening the log file"))
res = SYSS.show_in_editor(config.USER.browser, xmlHatFilePath, logger)
return res
- #!/usr/bin/env python
-#-*- coding:utf-8 -*-
+
LOCAL :
{
base : 'default'
{
project_file_paths :
[
- "/volatile/wambeke/SAT5/SAT5_S840_MATIX24/SAT_SALOME/salome.pyconf",
+ #"/volatile/wambeke/SAT5/SAT5_S840_MATIX24/SAT_SALOME/salome.pyconf",
# "/home/uranietm/proJET/saTJOBS/saT5/uranie.pyconf",
# cloned 2017/12 for matix
- "/home/matix/GitRepo/uranie/saT5/uranie.pyconf",
- "/volatile/wambeke/SAT5/SAT_MATIX/matix.pyconf"
+ #"/home/matix/GitRepo/uranie/saT5/uranie.pyconf",
+ #"/volatile/wambeke/SAT5/SAT_MATIX/matix.pyconf"
+ "/home/christian/SAT_SALOME/salome.pyconf"
+ "/home/christian/SAT_MATIX/matix.pyconf"
+ #"/home/christian/SAT_MATIX"
]
}
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: d7bdbf2f29518819f629c0dfc8f7331a
+config: 5297f00c73a42e7ad92f1035fc2613c1
tags: 645f666f9bcd5a90fca523b33c5a78b7
-
<!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>Overview: module code — salomeTools 5.0.0dev documentation</title>
+
<link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
- <script type="text/javascript" src="../_static/documentation_options.js"></script>
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
- <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/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="top" title="salomeTools 5.0.0dev documentation" href="../index.html" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
- </head><body>
+ </head>
+ <body role="document">
<div class="document">
<h1>All modules for which code is available</h1>
<ul><li><a href="src/ElementTree.html">src.ElementTree</a></li>
-<li><a href="src/__init__.html">src.__init__</a></li>
<li><a href="src/architecture.html">src.architecture</a></li>
+<li><a href="src/catchAll.html">src.catchAll</a></li>
<li><a href="src/colorama/ansi.html">src.colorama.ansi</a></li>
<li><a href="src/colorama/ansitowin32.html">src.colorama.ansitowin32</a></li>
<li><a href="src/colorama/initialise.html">src.colorama.initialise</a></li>
<li><a href="src/colorama/win32.html">src.colorama.win32</a></li>
<li><a href="src/colorama/winterm.html">src.colorama.winterm</a></li>
+<li><a href="src/coloringSat.html">src.coloringSat</a></li>
<li><a href="src/compilation.html">src.compilation</a></li>
+<li><a href="src/configManager.html">src.configManager</a></li>
<li><a href="src/debug.html">src.debug</a></li>
<li><a href="src/environment.html">src.environment</a></li>
+<li><a href="src/environs.html">src.environs</a></li>
+<li><a href="src/example/essai_logging_1.html">src.example.essai_logging_1</a></li>
+<li><a href="src/example/essai_logging_2.html">src.example.essai_logging_2</a></li>
+<li><a href="src/exceptionSat.html">src.exceptionSat</a></li>
<li><a href="src/fileEnviron.html">src.fileEnviron</a></li>
<li><a href="src/fork.html">src.fork</a></li>
-<li><a href="src/logger.html">src.logger</a></li>
+<li><a href="src/loggingSat.html">src.loggingSat</a></li>
<li><a href="src/options.html">src.options</a></li>
-<li><a href="src/printcolors.html">src.printcolors</a></li>
<li><a href="src/product.html">src.product</a></li>
<li><a href="src/pyconf.html">src.pyconf</a></li>
+<li><a href="src/returnCode.html">src.returnCode</a></li>
+<li><a href="src/salomeTools.html">src.salomeTools</a></li>
<li><a href="src/system.html">src.system</a></li>
<li><a href="src/template.html">src.template</a></li>
<li><a href="src/test_module.html">src.test_module</a></li>
+<li><a href="src/utilsSat.html">src.utilsSat</a></li>
<li><a href="src/xmlManager.html">src.xmlManager</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" />
+ <div><input type="text" name="q" /></div>
+ <div><input type="submit" value="Go" /></div>
<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>
©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>
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.9</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
</div>
-
<!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.ElementTree — salomeTools 5.0.0dev documentation</title>
+
<link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
- <script type="text/javascript" src="../../_static/documentation_options.js"></script>
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
- <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/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="top" title="salomeTools 5.0.0dev documentation" href="../../index.html" />
+ <link rel="up" title="Module code" href="../index.html" />
<link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
- </head><body>
+ </head>
+ <body role="document">
<div class="document">
<div class="viewcode-block" id="ElementTree.parse"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.ElementTree.ElementTree.parse">[docs]</a> <span class="k">def</span> <span class="nf">parse</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">source</span><span class="p">,</span> <span class="n">parser</span><span class="o">=</span><span class="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 14/11/2017 Ajout de traces pour essayer de decouvrir le pb</span>
- <span class="c1"># de remontee de log des tests</span>
- <span class="c1">#print "TRACES OP - ElementTree.py/ElementTree.parse() source = '#%s#'" %source</span>
<span class="n">source</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="n">source</span><span class="p">,</span> <span class="s2">"rb"</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">parser</span><span class="p">:</span>
<span class="n">parser</span> <span class="o">=</span> <span class="n">XMLTreeBuilder</span><span class="p">()</span>
<span class="c1"># @return An ElementTree instance</span>
<div class="viewcode-block" id="parse"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.ElementTree.parse">[docs]</a><span class="k">def</span> <span class="nf">parse</span><span class="p">(</span><span class="n">source</span><span class="p">,</span> <span class="n">parser</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
- <span class="c1"># OP 14/11/2017 Ajout de traces pour essayer de decouvrir le pb</span>
- <span class="c1"># de remontee de log des tests</span>
- <span class="c1">#print "TRACES OP - ElementTree.py/parse() source = '#%s#'" %source</span>
<span class="n">tree</span> <span class="o">=</span> <span class="n">ElementTree</span><span class="p">()</span>
<span class="n">tree</span><span class="o">.</span><span class="n">parse</span><span class="p">(</span><span class="n">source</span><span class="p">,</span> <span class="n">parser</span><span class="p">)</span>
<span class="k">return</span> <span class="n">tree</span></div>
<span class="c1"># @param data Encoded data.</span>
<div class="viewcode-block" id="XMLTreeBuilder.feed"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.ElementTree.XMLTreeBuilder.feed">[docs]</a> <span class="k">def</span> <span class="nf">feed</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">data</span><span class="p">):</span>
- <span class="c1"># OP 14/11/2017 Ajout de traces pour essayer de decouvrir le pb</span>
- <span class="c1"># de remontee de log des tests</span>
- <span class="c1">#print "TRACES OP - ElementTree.py/XMLTreeBuilder.feed() data = '#%s#'" %data</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_parser</span><span class="o">.</span><span class="n">Parse</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span></div>
<span class="c1">##</span>
</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" />
+ <div><input type="text" name="q" /></div>
+ <div><input type="submit" value="Go" /></div>
<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>
©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>
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.9</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
</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.__init__ — salomeTools 5.0.0dev documentation</title>
- <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
- <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
- <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.__init__</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.__init__.SatException">[docs]</a><span class="k">class</span> <span class="nc">SatException</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
- <span class="sd">"""rename Exception Class"""</span>
- <span class="k">pass</span></div>
-
-<div class="viewcode-block" id="ensure_path_exists"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.__init__.ensure_path_exists">[docs]</a><span class="k">def</span> <span class="nf">ensure_path_exists</span><span class="p">(</span><span class="n">p</span><span class="p">):</span>
- <span class="sd">"""Create a path if not existing</span>
-<span class="sd"> </span>
-<span class="sd"> :param p str: The path.</span>
-<span class="sd"> """</span>
- <span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">p</span><span class="p">):</span>
- <span class="n">os</span><span class="o">.</span><span class="n">makedirs</span><span class="p">(</span><span class="n">p</span><span class="p">)</span></div>
-
-<div class="viewcode-block" id="check_config_has_application"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.__init__.check_config_has_application">[docs]</a><span class="k">def</span> <span class="nf">check_config_has_application</span><span class="p">(</span> <span class="n">config</span><span class="p">,</span> <span class="n">details</span> <span class="o">=</span> <span class="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.__init__.check_config_has_profile">[docs]</a><span class="k">def</span> <span class="nf">check_config_has_profile</span><span class="p">(</span> <span class="n">config</span><span class="p">,</span> <span class="n">details</span> <span class="o">=</span> <span class="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.__init__.config_has_application">[docs]</a><span class="k">def</span> <span class="nf">config_has_application</span><span class="p">(</span> <span class="n">config</span> <span class="p">):</span>
- <span class="k">return</span> <span class="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.__init__.get_cfg_param">[docs]</a><span class="k">def</span> <span class="nf">get_cfg_param</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">param_name</span><span class="p">,</span> <span class="n">default</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> eearch for param_name value in config.</span>
-<span class="sd"> if param_name is not in config </span>
-<span class="sd"> then return default,</span>
-<span class="sd"> else return the found value</span>
-<span class="sd"> </span>
-<span class="sd"> :param config class 'common.pyconf.Config': The config.</span>
-<span class="sd"> :param param_name str: the name of the parameter to get the value</span>
-<span class="sd"> :param default str: The value to return if param_name is not in config</span>
-<span class="sd"> :return: see initial description of the function</span>
-<span class="sd"> :rtype: str</span>
-<span class="sd"> """</span>
- <span class="k">if</span> <span class="n">param_name</span> <span class="ow">in</span> <span class="n">config</span><span class="p">:</span>
- <span class="k">return</span> <span class="n">config</span><span class="p">[</span><span class="n">param_name</span><span class="p">]</span>
- <span class="k">return</span> <span class="n">default</span></div>
-
-<div class="viewcode-block" id="print_info"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.__init__.print_info">[docs]</a><span class="k">def</span> <span class="nf">print_info</span><span class="p">(</span><span class="n">logger</span><span class="p">,</span> <span class="n">info</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Prints the tuples that are in info variable in a formatted way.</span>
-<span class="sd"> </span>
-<span class="sd"> :param logger Logger: The logging instance to use for the prints.</span>
-<span class="sd"> :param info list: The list of tuples to display</span>
-<span class="sd"> """</span>
- <span class="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.__init__.get_base_path">[docs]</a><span class="k">def</span> <span class="nf">get_base_path</span><span class="p">(</span><span class="n">config</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Returns the path of the products base.</span>
-<span class="sd"> </span>
-<span class="sd"> :param config Config: The global Config instance.</span>
-<span class="sd"> :return: The path of the products base.</span>
-<span class="sd"> :rtype: str</span>
-<span class="sd"> """</span>
- <span class="k">if</span> <span class="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.__init__.get_launcher_name">[docs]</a><span class="k">def</span> <span class="nf">get_launcher_name</span><span class="p">(</span><span class="n">config</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Returns the name of salome launcher.</span>
-<span class="sd"> </span>
-<span class="sd"> :param config Config: The global Config instance.</span>
-<span class="sd"> :return: The name of salome launcher.</span>
-<span class="sd"> :rtype: str</span>
-<span class="sd"> """</span>
- <span class="n">check_config_has_application</span><span class="p">(</span><span class="n">config</span><span class="p">)</span>
- <span class="k">if</span> <span class="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.__init__.get_log_path">[docs]</a><span class="k">def</span> <span class="nf">get_log_path</span><span class="p">(</span><span class="n">config</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Returns the path of the logs.</span>
-<span class="sd"> </span>
-<span class="sd"> :param config Config: The global Config instance.</span>
-<span class="sd"> :return: The path of the logs.</span>
-<span class="sd"> :rtype: str</span>
-<span class="sd"> """</span>
- <span class="k">if</span> <span class="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.__init__.get_salome_version">[docs]</a><span class="k">def</span> <span class="nf">get_salome_version</span><span class="p">(</span><span class="n">config</span><span class="p">):</span>
- <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">config</span><span class="o">.</span><span class="n">APPLICATION</span><span class="p">,</span> <span class="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.__init__.only_numbers">[docs]</a><span class="k">def</span> <span class="nf">only_numbers</span><span class="p">(</span><span class="n">str_num</span><span class="p">):</span>
- <span class="k">return</span> <span class="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.__init__.read_config_from_a_file">[docs]</a><span class="k">def</span> <span class="nf">read_config_from_a_file</span><span class="p">(</span><span class="n">filePath</span><span class="p">):</span>
- <span class="k">try</span><span class="p">:</span>
- <span class="n">cfg_file</span> <span class="o">=</span> <span class="n">pyconf</span><span class="o">.</span><span class="n">Config</span><span class="p">(</span><span class="n">filePath</span><span class="p">)</span>
- <span class="k">except</span> <span class="n">pyconf</span><span class="o">.</span><span class="n">ConfigError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
- <span class="k">raise</span> <span class="n">SatException</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="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.__init__.get_tmp_filename">[docs]</a><span class="k">def</span> <span class="nf">get_tmp_filename</span><span class="p">(</span><span class="n">cfg</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
- <span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">cfg</span><span class="o">.</span><span class="n">VARS</span><span class="o">.</span><span class="n">tmp_root</span><span class="p">):</span>
- <span class="n">os</span><span class="o">.</span><span class="n">makedirs</span><span class="p">(</span><span class="n">cfg</span><span class="o">.</span><span class="n">VARS</span><span class="o">.</span><span class="n">tmp_root</span><span class="p">)</span>
-
- <span class="k">return</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">cfg</span><span class="o">.</span><span class="n">VARS</span><span class="o">.</span><span class="n">tmp_root</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span></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.__init__.Path">[docs]</a><span class="k">class</span> <span class="nc">Path</span><span class="p">:</span>
- <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">path</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">path</span><span class="p">)</span>
-
- <span class="k">def</span> <span class="nf">__add__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
- <span class="k">return</span> <span class="n">Path</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">other</span><span class="p">)))</span>
-
- <span class="k">def</span> <span class="nf">__abs__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
- <span class="k">return</span> <span class="n">Path</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">abspath</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">))</span>
-
- <span class="k">def</span> <span class="nf">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
- <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">path</span>
-
- <span class="k">def</span> <span class="nf">__eq__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
- <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">path</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">path</span>
-
-<div class="viewcode-block" id="Path.exists"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.__init__.Path.exists">[docs]</a> <span class="k">def</span> <span class="nf">exists</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
- <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">islink</span><span class="p">()</span> <span class="ow">or</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">)</span></div>
-
-<div class="viewcode-block" id="Path.islink"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.__init__.Path.islink">[docs]</a> <span class="k">def</span> <span class="nf">islink</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
- <span class="k">return</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">islink</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">)</span></div>
-
-<div class="viewcode-block" id="Path.isdir"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.__init__.Path.isdir">[docs]</a> <span class="k">def</span> <span class="nf">isdir</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
- <span class="k">return</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isdir</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">)</span></div>
-
-<div class="viewcode-block" id="Path.isfile"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.__init__.Path.isfile">[docs]</a> <span class="k">def</span> <span class="nf">isfile</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
- <span class="k">return</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isfile</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">)</span></div>
-
-<div class="viewcode-block" id="Path.list"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.__init__.Path.list">[docs]</a> <span class="k">def</span> <span class="nf">list</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
- <span class="k">return</span> <span class="p">[</span><span class="n">Path</span><span class="p">(</span><span class="n">p</span><span class="p">)</span> <span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="n">os</span><span class="o">.</span><span class="n">listdir</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">)]</span></div>
-
-<div class="viewcode-block" id="Path.dir"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.__init__.Path.dir">[docs]</a> <span class="k">def</span> <span class="nf">dir</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
- <span class="k">return</span> <span class="n">Path</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">))</span></div>
-
-<div class="viewcode-block" id="Path.base"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.__init__.Path.base">[docs]</a> <span class="k">def</span> <span class="nf">base</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
- <span class="k">return</span> <span class="n">Path</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">basename</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">))</span></div>
-
-<div class="viewcode-block" id="Path.make"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.__init__.Path.make">[docs]</a> <span class="k">def</span> <span class="nf">make</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">mode</span><span class="o">=</span><span class="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.__init__.Path.chmod">[docs]</a> <span class="k">def</span> <span class="nf">chmod</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">mode</span><span class="p">):</span>
- <span class="n">os</span><span class="o">.</span><span class="n">chmod</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">,</span> <span class="n">mode</span><span class="p">)</span></div>
-
-<div class="viewcode-block" id="Path.rm"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.__init__.Path.rm">[docs]</a> <span class="k">def</span> <span class="nf">rm</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
- <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">islink</span><span class="p">():</span>
- <span class="n">os</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">)</span>
- <span class="k">else</span><span class="p">:</span>
- <span class="n">shutil</span><span class="o">.</span><span class="n">rmtree</span><span class="p">(</span> <span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">,</span> <span class="n">onerror</span> <span class="o">=</span> <span class="n">handleRemoveReadonly</span> <span class="p">)</span></div>
-
-<div class="viewcode-block" id="Path.copy"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.__init__.Path.copy">[docs]</a> <span class="k">def</span> <span class="nf">copy</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">smart</span><span class="o">=</span><span class="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.__init__.Path.smartcopy">[docs]</a> <span class="k">def</span> <span class="nf">smartcopy</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span>
- <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">copy</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="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.__init__.Path.readlink">[docs]</a> <span class="k">def</span> <span class="nf">readlink</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
- <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">islink</span><span class="p">():</span>
- <span class="k">return</span> <span class="n">os</span><span class="o">.</span><span class="n">readlink</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">)</span>
- <span class="k">else</span><span class="p">:</span>
- <span class="k">return</span> <span class="kc">False</span></div>
-
-<div class="viewcode-block" id="Path.symlink"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.__init__.Path.symlink">[docs]</a> <span class="k">def</span> <span class="nf">symlink</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span>
- <span class="k">try</span><span class="p">:</span>
- <span class="n">os</span><span class="o">.</span><span class="n">symlink</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">path</span><span class="p">),</span> <span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">)</span>
- <span class="k">return</span> <span class="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.__init__.Path.copylink">[docs]</a> <span class="k">def</span> <span class="nf">copylink</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span>
- <span class="k">try</span><span class="p">:</span>
- <span class="n">os</span><span class="o">.</span><span class="n">symlink</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">readlink</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">),</span> <span class="nb">str</span><span class="p">(</span><span class="n">path</span><span class="p">))</span>
- <span class="k">return</span> <span class="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.__init__.Path.copydir">[docs]</a> <span class="k">def</span> <span class="nf">copydir</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">dst</span><span class="p">,</span> <span class="n">smart</span><span class="o">=</span><span class="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.__init__.Path.copyfile">[docs]</a> <span class="k">def</span> <span class="nf">copyfile</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span>
- <span class="k">try</span><span class="p">:</span>
- <span class="n">shutil</span><span class="o">.</span><span class="n">copy2</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">path</span><span class="p">))</span>
- <span class="k">return</span> <span class="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.__init__.find_file_in_lpath">[docs]</a><span class="k">def</span> <span class="nf">find_file_in_lpath</span><span class="p">(</span><span class="n">file_name</span><span class="p">,</span> <span class="n">lpath</span><span class="p">,</span> <span class="n">additional_dir</span> <span class="o">=</span> <span class="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.__init__.handleRemoveReadonly">[docs]</a><span class="k">def</span> <span class="nf">handleRemoveReadonly</span><span class="p">(</span><span class="n">func</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">exc</span><span class="p">):</span>
- <span class="n">excvalue</span> <span class="o">=</span> <span class="n">exc</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
- <span class="k">if</span> <span class="n">func</span> <span class="ow">in</span> <span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">rmdir</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">remove</span><span class="p">)</span> <span class="ow">and</span> <span class="n">excvalue</span><span class="o">.</span><span class="n">errno</span> <span class="o">==</span> <span class="n">errno</span><span class="o">.</span><span class="n">EACCES</span><span class="p">:</span>
- <span class="n">os</span><span class="o">.</span><span class="n">chmod</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">stat</span><span class="o">.</span><span class="n">S_IRWXU</span><span class="o">|</span> <span class="n">stat</span><span class="o">.</span><span class="n">S_IRWXG</span><span class="o">|</span> <span class="n">stat</span><span class="o">.</span><span class="n">S_IRWXO</span><span class="p">)</span> <span class="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.__init__.deepcopy_list">[docs]</a><span class="k">def</span> <span class="nf">deepcopy_list</span><span class="p">(</span><span class="n">input_list</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Do a deep copy of a list</span>
-<span class="sd"> </span>
-<span class="sd"> :param input_list List: The list to copy</span>
-<span class="sd"> :return: The copy of the list</span>
-<span class="sd"> :rtype: List</span>
-<span class="sd"> """</span>
- <span class="n">res</span> <span class="o">=</span> <span class="p">[]</span>
- <span class="k">for</span> <span class="n">elem</span> <span class="ow">in</span> <span class="n">input_list</span><span class="p">:</span>
- <span class="n">res</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">elem</span><span class="p">)</span>
- <span class="k">return</span> <span class="n">res</span></div>
-
-<div class="viewcode-block" id="remove_item_from_list"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.__init__.remove_item_from_list">[docs]</a><span class="k">def</span> <span class="nf">remove_item_from_list</span><span class="p">(</span><span class="n">input_list</span><span class="p">,</span> <span class="n">item</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Remove all occurences of item from input_list</span>
-<span class="sd"> </span>
-<span class="sd"> :param input_list List: The list to modify</span>
-<span class="sd"> :return: The without any item</span>
-<span class="sd"> :rtype: List</span>
-<span class="sd"> """</span>
- <span class="n">res</span> <span class="o">=</span> <span class="p">[]</span>
- <span class="k">for</span> <span class="n">elem</span> <span class="ow">in</span> <span class="n">input_list</span><span class="p">:</span>
- <span class="k">if</span> <span class="n">elem</span> <span class="o">==</span> <span class="n">item</span><span class="p">:</span>
- <span class="k">continue</span>
- <span class="n">res</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">elem</span><span class="p">)</span>
- <span class="k">return</span> <span class="n">res</span></div>
-
-<div class="viewcode-block" id="parse_date"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.__init__.parse_date">[docs]</a><span class="k">def</span> <span class="nf">parse_date</span><span class="p">(</span><span class="n">date</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Transform YYYYMMDD_hhmmss into YYYY-MM-DD hh:mm:ss.</span>
-<span class="sd"> </span>
-<span class="sd"> :param date str: The date to transform</span>
-<span class="sd"> :return: The date in the new format</span>
-<span class="sd"> :rtype: str</span>
-<span class="sd"> """</span>
- <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">date</span><span class="p">)</span> <span class="o">!=</span> <span class="mi">15</span><span class="p">:</span>
- <span class="k">return</span> <span class="n">date</span>
- <span class="n">res</span> <span class="o">=</span> <span class="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.__init__.merge_dicts">[docs]</a><span class="k">def</span> <span class="nf">merge_dicts</span><span class="p">(</span><span class="o">*</span><span class="n">dict_args</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Given any number of dicts, shallow copy and merge into a new dict,</span>
-<span class="sd"> precedence goes to key value pairs in latter dicts.</span>
-<span class="sd"> """</span>
- <span class="n">result</span> <span class="o">=</span> <span class="p">{}</span>
- <span class="k">for</span> <span class="n">dictionary</span> <span class="ow">in</span> <span class="n">dict_args</span><span class="p">:</span>
- <span class="n">result</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">dictionary</span><span class="p">)</span>
- <span class="k">return</span> <span class="n">result</span></div>
-
-<div class="viewcode-block" id="replace_in_file"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.__init__.replace_in_file">[docs]</a><span class="k">def</span> <span class="nf">replace_in_file</span><span class="p">(</span><span class="n">filein</span><span class="p">,</span> <span class="n">strin</span><span class="p">,</span> <span class="n">strout</span><span class="p">):</span>
- <span class="sd">"""Replace <strin> by <strout> in file <filein>"""</span>
- <span class="n">shutil</span><span class="o">.</span><span class="n">move</span><span class="p">(</span><span class="n">filein</span><span class="p">,</span> <span class="n">filein</span> <span class="o">+</span> <span class="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.__init__.get_property_in_product_cfg">[docs]</a><span class="k">def</span> <span class="nf">get_property_in_product_cfg</span><span class="p">(</span><span class="n">product_cfg</span><span class="p">,</span> <span class="n">pprty</span><span class="p">):</span>
- <span class="k">if</span> <span class="ow">not</span> <span class="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.__init__.activate_mesa_property">[docs]</a><span class="k">def</span> <span class="nf">activate_mesa_property</span><span class="p">(</span><span class="n">config</span><span class="p">):</span>
- <span class="sd">"""Add mesa property into application properties</span>
-<span class="sd"> </span>
-<span class="sd"> :param config Config: The global configuration. It must have an application!</span>
-<span class="sd"> """</span>
- <span class="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">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="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
-
<!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.architecture — salomeTools 5.0.0dev documentation</title>
+
<link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
- <script type="text/javascript" src="../../_static/documentation_options.js"></script>
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
- <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/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="top" title="salomeTools 5.0.0dev documentation" href="../../index.html" />
+ <link rel="up" title="Module code" href="../index.html" />
<link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
- </head><body>
+ </head>
+ <body role="document">
<div class="document">
<span class="sd">on which SAT is running</span>
<span class="sd">'''</span>
-<span class="kn">import</span> <span class="nn">os</span><span class="o">,</span> <span class="nn">sys</span><span class="o">,</span> <span class="nn">platform</span>
+<span class="kn">import</span> <span class="nn">os</span>
+<span class="kn">import</span> <span class="nn">sys</span>
+<span class="kn">import</span> <span class="nn">platform</span>
<div class="viewcode-block" id="is_windows"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.architecture.is_windows">[docs]</a><span class="k">def</span> <span class="nf">is_windows</span><span class="p">():</span>
<span class="sd">'''method that checks windows OS</span>
</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" />
+ <div><input type="text" name="q" /></div>
+ <div><input type="submit" value="Go" /></div>
<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>
©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>
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.9</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
</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="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>src.catchAll — 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">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+ <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/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="top" title="salomeTools 5.0.0dev documentation" href="../../index.html" />
+ <link rel="up" title="Module code" href="../index.html" />
+
+ <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+ </head>
+ <body role="document">
+
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <h1>Source code for src.catchAll</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-20xx 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">define class as a simple dictionary with keys</span>
+<span class="sd">with pretty print __str__ and __repr__ (indented as recursive)</span>
+<span class="sd">and jsonDumps()</span>
+
+<span class="sd">usage:</span>
+<span class="sd"> >> import catchAll as CAA</span>
+<span class="sd"> >> a = CAA.CatchAll()</span>
+<span class="sd"> >> a.tintin = "reporter"</span>
+<span class="sd"> >> a.milou = "dog"</span>
+<span class="sd"> >> print("a=%s" % a)</span>
+<span class="sd"> >> print("tintin: %s" % a.tintin)</span>
+<span class="sd">"""</span>
+
+<span class="kn">import</span> <span class="nn">pprint</span> <span class="k">as</span> <span class="nn">PP</span>
+<span class="kn">import</span> <span class="nn">json</span>
+
+<span class="c1">########################################################################################</span>
+<span class="c1"># json utils</span>
+<span class="c1">########################################################################################</span>
+<div class="viewcode-block" id="dumper"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.catchAll.dumper">[docs]</a><span class="k">def</span> <span class="nf">dumper</span><span class="p">(</span><span class="n">obj</span><span class="p">):</span>
+ <span class="sd">"""to json explore subclass object as dict"""</span>
+ <span class="k">return</span> <span class="n">obj</span><span class="o">.</span><span class="vm">__dict__</span></div>
+
+<div class="viewcode-block" id="dumperType"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.catchAll.dumperType">[docs]</a><span class="k">def</span> <span class="nf">dumperType</span><span class="p">(</span><span class="n">obj</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> to get a "_type" to trace json subclass object,</span>
+<span class="sd"> but ignore all attributes begining with '_'</span>
+<span class="sd"> """</span>
+ <span class="n">typeatt</span> <span class="o">=</span> <span class="s2">"_type"</span>
+ <span class="n">aDict</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">((</span><span class="n">k</span><span class="p">,</span><span class="n">v</span><span class="p">)</span> <span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">obj</span><span class="o">.</span><span class="vm">__dict__</span><span class="o">.</span><span class="n">iteritems</span><span class="p">()</span> <span class="k">if</span> <span class="n">k</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">!=</span> <span class="s2">"_"</span> <span class="ow">or</span> <span class="n">k</span> <span class="o">==</span> <span class="n">typeatt</span><span class="p">)</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">aDict</span><span class="o">.</span><span class="n">has_key</span><span class="p">(</span><span class="n">typeatt</span><span class="p">):</span> <span class="n">aDict</span><span class="p">[</span><span class="n">typeatt</span><span class="p">]</span> <span class="o">=</span> <span class="n">obj</span><span class="o">.</span><span class="vm">__class__</span><span class="o">.</span><span class="vm">__name__</span>
+ <span class="k">return</span> <span class="n">aDict</span></div>
+
+<div class="viewcode-block" id="jsonDumps"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.catchAll.jsonDumps">[docs]</a><span class="k">def</span> <span class="nf">jsonDumps</span><span class="p">(</span><span class="n">obj</span><span class="p">):</span>
+ <span class="sd">"""to get direct default jsonDumps method"""</span>
+ <span class="k">return</span> <span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="n">dumperType</span><span class="p">,</span> <span class="n">sort_keys</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">indent</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span></div>
+
+
+<span class="c1">########################################################################################</span>
+<div class="viewcode-block" id="CatchAll"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.catchAll.CatchAll">[docs]</a><span class="k">class</span> <span class="nc">CatchAll</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> class as simple dynamic dictionary </span>
+<span class="sd"> with predefined keys as properties in</span>
+<span class="sd"> inherited classes through __init__ method. Or NOT. </span>
+<span class="sd"> with pretty print __str__ and __repr__ (indented as recursive)</span>
+<span class="sd"> with jsonDumps()</span>
+<span class="sd"> </span>
+<span class="sd"> usage:</span>
+<span class="sd"> </span>
+<span class="sd"> >> import catchAll as CAA</span>
+<span class="sd"> >> a = CAA.CatchAll()</span>
+<span class="sd"> >> a.tintin = "reporter"</span>
+<span class="sd"> >> a.milou = "dog"</span>
+<span class="sd"> >> print("a=%s" % a)</span>
+<span class="sd"> >> print("tintin: %s" % a.tintin)</span>
+
+<span class="sd"> as</span>
+<span class="sd"> </span>
+<span class="sd"> >> a = {}</span>
+<span class="sd"> >> a["tintin"] = "reporter"</span>
+<span class="sd"> >> a["milou"] = "dog"</span>
+<span class="sd"> >> print("tintin: %s" % a["tintin"]</span>
+<span class="sd"> """</span>
+
+ <span class="k">def</span> <span class="nf">__repr__asList</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> goal is to be unambiguous</span>
+<span class="sd"> an ordered list representation is better for test (and visualize) (in)equality</span>
+<span class="sd"> """</span>
+ <span class="n">aList</span> <span class="o">=</span> <span class="p">[]</span>
+ <span class="k">for</span> <span class="n">k</span> <span class="ow">in</span> <span class="nb">sorted</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="vm">__dict__</span><span class="o">.</span><span class="n">keys</span><span class="p">()):</span>
+ <span class="k">if</span> <span class="n">k</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">!=</span> <span class="s1">'_'</span><span class="p">:</span>
+ <span class="n">aList</span><span class="o">.</span><span class="n">append</span><span class="p">(</span> <span class="p">[</span><span class="n">k</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="vm">__dict__</span><span class="p">[</span><span class="n">k</span><span class="p">]]</span> <span class="p">)</span>
+ <span class="k">return</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="o">+</span> <span class="s2">" = "</span> <span class="o">+</span> <span class="n">aList</span><span class="o">.</span><span class="fm">__repr__</span><span class="p">()</span>
+
+ <span class="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="sd">"""goal is to be unambiguous, easy human readeable"""</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_reprIndent</span><span class="p">()</span>
+
+ <span class="k">def</span> <span class="nf">_reprIndent</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">indent</span><span class="o">=</span><span class="mi">0</span><span class="p">):</span>
+ <span class="n">res</span> <span class="o">=</span> <span class="s2">""</span>
+ <span class="n">newIndent</span> <span class="o">=</span> <span class="n">indent</span> <span class="o">+</span> <span class="mi">2</span>
+ <span class="k">for</span> <span class="n">k</span> <span class="ow">in</span> <span class="nb">sorted</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="vm">__dict__</span><span class="o">.</span><span class="n">keys</span><span class="p">()):</span>
+ <span class="k">if</span> <span class="n">k</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">!=</span> <span class="s1">'_'</span><span class="p">:</span>
+ <span class="n">kk</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="vm">__dict__</span><span class="p">[</span><span class="n">k</span><span class="p">]</span>
+ <span class="k">if</span> <span class="nb">issubclass</span><span class="p">(</span><span class="n">CatchAll</span><span class="p">,</span> <span class="n">kk</span><span class="o">.</span><span class="vm">__class__</span><span class="p">):</span>
+ <span class="n">res</span> <span class="o">+=</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span> <span class="o">+</span> <span class="s2">" "</span><span class="o">*</span><span class="n">newIndent</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="o">%</span> <span class="p">(</span><span class="n">k</span><span class="p">,</span> <span class="n">kk</span><span class="o">.</span><span class="n">_reprIndent</span><span class="p">(</span><span class="n">newIndent</span><span class="p">))</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">skk</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">PP</span><span class="o">.</span><span class="n">pformat</span><span class="p">(</span><span class="n">kk</span><span class="p">),</span> <span class="n">newIndent</span><span class="p">)</span>
+ <span class="n">res</span> <span class="o">+=</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span> <span class="o">+</span> <span class="s2">" "</span><span class="o">*</span><span class="n">newIndent</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="o">%</span> <span class="p">(</span><span class="n">k</span><span class="p">,</span> <span class="n">skk</span><span class="p">)</span>
+ <span class="k">return</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="o">+</span> <span class="s2">"("</span> <span class="o">+</span> <span class="n">res</span> <span class="o">+</span> <span class="s2">")"</span>
+
+ <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">txt</span><span class="p">,</span> <span class="n">indent</span><span class="p">):</span>
+ <span class="n">txts</span> <span class="o">=</span> <span class="n">txt</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
+ <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">txt</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="p">(</span><span class="s2">"</span><span class="se">\n</span><span class="s2">"</span> <span class="o">+</span> <span class="s2">" "</span><span class="o">*</span><span class="n">indent</span><span class="p">)</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">txts</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">return</span> <span class="n">txt</span>
+
+
+<div class="viewcode-block" id="CatchAll.jsonDumps"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.catchAll.CatchAll.jsonDumps">[docs]</a> <span class="k">def</span> <span class="nf">jsonDumps</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="k">return</span> <span class="n">jsonDumps</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span></div></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>
+ <form class="search" action="../../search.html" method="get">
+ <div><input type="text" name="q" /></div>
+ <div><input type="submit" value="Go" /></div>
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</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.4.9</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
+
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
-
<!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.colorama.ansi — salomeTools 5.0.0dev documentation</title>
+
<link rel="stylesheet" href="../../../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
- <script type="text/javascript" src="../../../_static/documentation_options.js"></script>
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
<script type="text/javascript" src="../../../_static/jquery.js"></script>
<script type="text/javascript" src="../../../_static/underscore.js"></script>
<script type="text/javascript" src="../../../_static/doctools.js"></script>
- <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/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="top" title="salomeTools 5.0.0dev documentation" href="../../../index.html" />
+ <link rel="up" title="Module code" href="../../index.html" />
<link rel="stylesheet" href="../../../_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
- </head><body>
+ </head>
+ <body role="document">
<div class="document">
</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" />
+ <div><input type="text" name="q" /></div>
+ <div><input type="submit" value="Go" /></div>
<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>
©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>
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.9</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
</div>
-
<!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.colorama.ansitowin32 — salomeTools 5.0.0dev documentation</title>
+
<link rel="stylesheet" href="../../../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
- <script type="text/javascript" src="../../../_static/documentation_options.js"></script>
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
<script type="text/javascript" src="../../../_static/jquery.js"></script>
<script type="text/javascript" src="../../../_static/underscore.js"></script>
<script type="text/javascript" src="../../../_static/doctools.js"></script>
- <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/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="top" title="salomeTools 5.0.0dev documentation" href="../../../index.html" />
+ <link rel="up" title="Module code" href="../../index.html" />
<link rel="stylesheet" href="../../../_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
- </head><body>
+ </head>
+ <body role="document">
<div class="document">
</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" />
+ <div><input type="text" name="q" /></div>
+ <div><input type="submit" value="Go" /></div>
<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>
©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>
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.9</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
</div>
-
<!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.colorama.initialise — salomeTools 5.0.0dev documentation</title>
+
<link rel="stylesheet" href="../../../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
- <script type="text/javascript" src="../../../_static/documentation_options.js"></script>
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
<script type="text/javascript" src="../../../_static/jquery.js"></script>
<script type="text/javascript" src="../../../_static/underscore.js"></script>
<script type="text/javascript" src="../../../_static/doctools.js"></script>
- <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/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="top" title="salomeTools 5.0.0dev documentation" href="../../../index.html" />
+ <link rel="up" title="Module code" href="../../index.html" />
<link rel="stylesheet" href="../../../_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
- </head><body>
+ </head>
+ <body role="document">
<div class="document">
<span class="n">sys</span><span class="o">.</span><span class="n">stderr</span> <span class="o">=</span> <span class="n">orig_stderr</span></div>
-<div class="viewcode-block" id="colorama_text"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.initialise.colorama_text">[docs]</a><span class="nd">@contextlib</span><span class="o">.</span><span class="n">contextmanager</span>
-<span class="k">def</span> <span class="nf">colorama_text</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
+<span class="nd">@contextlib</span><span class="o">.</span><span class="n">contextmanager</span>
+<div class="viewcode-block" id="colorama_text"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.initialise.colorama_text">[docs]</a><span class="k">def</span> <span class="nf">colorama_text</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="n">init</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">yield</span>
</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" />
+ <div><input type="text" name="q" /></div>
+ <div><input type="submit" value="Go" /></div>
<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>
©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>
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.9</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
</div>
-
<!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.colorama.win32 — salomeTools 5.0.0dev documentation</title>
+
<link rel="stylesheet" href="../../../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
- <script type="text/javascript" src="../../../_static/documentation_options.js"></script>
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
<script type="text/javascript" src="../../../_static/jquery.js"></script>
<script type="text/javascript" src="../../../_static/underscore.js"></script>
<script type="text/javascript" src="../../../_static/doctools.js"></script>
- <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/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="top" title="salomeTools 5.0.0dev documentation" href="../../../index.html" />
+ <link rel="up" title="Module code" href="../../index.html" />
<link rel="stylesheet" href="../../../_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
- </head><body>
+ </head>
+ <body role="document">
<div class="document">
</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" />
+ <div><input type="text" name="q" /></div>
+ <div><input type="submit" value="Go" /></div>
<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>
©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>
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.9</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
</div>
-
<!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.colorama.winterm — salomeTools 5.0.0dev documentation</title>
+
<link rel="stylesheet" href="../../../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
- <script type="text/javascript" src="../../../_static/documentation_options.js"></script>
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
<script type="text/javascript" src="../../../_static/jquery.js"></script>
<script type="text/javascript" src="../../../_static/underscore.js"></script>
<script type="text/javascript" src="../../../_static/doctools.js"></script>
- <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/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="top" title="salomeTools 5.0.0dev documentation" href="../../../index.html" />
+ <link rel="up" title="Module code" href="../../index.html" />
<link rel="stylesheet" href="../../../_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
- </head><body>
+ </head>
+ <body role="document">
<div class="document">
</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" />
+ <div><input type="text" name="q" /></div>
+ <div><input type="submit" value="Go" /></div>
<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>
©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>
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.9</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
</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="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>src.coloringSat — 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">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+ <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/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="top" title="salomeTools 5.0.0dev documentation" href="../../index.html" />
+ <link rel="up" title="Module code" href="../index.html" />
+
+ <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+ </head>
+ <body role="document">
+
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <h1>Source code for src.coloringSat</h1><div class="highlight"><pre>
+<span></span><span class="ch">#!/usr/bin/env python</span>
+<span class="c1"># -*- coding: utf-8 -*-</span>
+
+<span class="sd">"""</span>
+<span class="sd">simple tagging as '<color>' for simple coloring log messages on terminal(s)</span>
+<span class="sd">window or unix or ios using backend colorama</span>
+
+<span class="sd">using '<color>' because EZ human readable</span>
+<span class="sd">so '<color>' are not supposed existing in log message</span>
+<span class="sd">"{}".format() is not choosen because "{}" are present</span>
+<span class="sd">in log messages of contents of python dict (as JSON) etc.</span>
+
+<span class="sd">example:</span>
+<span class="sd">>> log("this is in <green>color green<reset>, OK is in blue: <blue>OK?")</span>
+<span class="sd">"""</span>
+
+<span class="kn">import</span> <span class="nn">os</span>
+<span class="kn">import</span> <span class="nn">sys</span>
+<span class="kn">import</span> <span class="nn">pprint</span> <span class="k">as</span> <span class="nn">PP</span>
+
+<span class="n">_verbose</span> <span class="o">=</span> <span class="kc">True</span>
+<span class="n">_name</span> <span class="o">=</span> <span class="s2">"coloringSat"</span>
+
+<span class="sd">""" </span>
+<span class="sd">https://github.com/tartley/colorama</span>
+<span class="sd">init(wrap=True):</span>
+
+<span class="sd">On Windows, colorama works by replacing sys.stdout and sys.stderr </span>
+<span class="sd">with proxy objects, which override the .write() method to do their work. </span>
+<span class="sd">If this wrapping causes you problems, </span>
+<span class="sd">then this can be disabled by passing init(wrap=False). </span>
+<span class="sd">The default behaviour is to wrap if autoreset or strip or convert are True.</span>
+
+<span class="sd">When wrapping is disabled, colored printing on non-Windows platforms </span>
+<span class="sd">will continue to work as normal. </span>
+<span class="sd">To do cross-platform colored output, </span>
+<span class="sd">you can use Colorama's AnsiToWin32 proxy directly:</span>
+
+<span class="sd">example:</span>
+<span class="sd"> import sys</span>
+<span class="sd"> from colorama import init, AnsiToWin32, Fore</span>
+<span class="sd"> init(wrap=False)</span>
+<span class="sd"> stream = AnsiToWin32(sys.stderr).stream</span>
+<span class="sd"> # Python 2</span>
+<span class="sd"> print >>stream, Fore.BLUE + 'blue text on stderr'</span>
+<span class="sd"> # Python 3</span>
+<span class="sd"> print(Fore.BLUE + 'blue text on stderr', file=stream)</span>
+<span class="sd">"""</span>
+
+<span class="kn">import</span> <span class="nn">colorama</span> <span class="k">as</span> <span class="nn">CLRM</span>
+<span class="kn">from</span> <span class="nn">colorama</span> <span class="k">import</span> <span class="n">Fore</span> <span class="k">as</span> <span class="n">FG</span>
+<span class="kn">from</span> <span class="nn">colorama</span> <span class="k">import</span> <span class="n">Style</span> <span class="k">as</span> <span class="n">ST</span>
+<span class="c1">#from colorama import AnsiToWin32</span>
+<span class="kn">from</span> <span class="nn">colorama</span> <span class="k">import</span> <span class="n">AnsiToWin32</span> <span class="c1"># debug is os.name == 'nt' ?</span>
+
+<span class="n">CLRM</span><span class="o">.</span><span class="n">init</span><span class="p">(</span><span class="n">wrap</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span> <span class="c1"># choose NO wrapping</span>
+
+<span class="sd">"""</span>
+<span class="sd">from colorama:</span>
+<span class="sd">Available formatting constants are:</span>
+<span class="sd">Fore: BLACK, RED, GREEN, YELLOW, BLUE, MAGENTA, CYAN, WHITE, RESET.</span>
+<span class="sd">Back: BLACK, RED, GREEN, YELLOW, BLUE, MAGENTA, CYAN, WHITE, RESET.</span>
+<span class="sd">Style: DIM, NORMAL, BRIGHT, RESET_ALL</span>
+
+<span class="sd">n.b. DIM is not assumed in win32</span>
+<span class="sd">"""</span>
+
+<span class="c1"># dir(ST)</span>
+
+<span class="c1"># order matters for items replaces forward to color</span>
+<span class="n">_tags</span> <span class="o">=</span> <span class="p">(</span>
+ <span class="p">(</span><span class="s2">"<black>"</span><span class="p">,</span> <span class="n">FG</span><span class="o">.</span><span class="n">BLACK</span><span class="p">),</span>
+ <span class="p">(</span><span class="s2">"<red>"</span><span class="p">,</span> <span class="n">FG</span><span class="o">.</span><span class="n">RED</span><span class="p">),</span>
+ <span class="p">(</span><span class="s2">"<green>"</span><span class="p">,</span> <span class="n">FG</span><span class="o">.</span><span class="n">GREEN</span><span class="p">),</span>
+ <span class="p">(</span><span class="s2">"<yellow>"</span><span class="p">,</span> <span class="n">FG</span><span class="o">.</span><span class="n">YELLOW</span><span class="p">),</span>
+ <span class="p">(</span><span class="s2">"<blue>"</span><span class="p">,</span> <span class="n">FG</span><span class="o">.</span><span class="n">BLUE</span><span class="p">),</span>
+ <span class="p">(</span><span class="s2">"<magenta>"</span><span class="p">,</span> <span class="n">FG</span><span class="o">.</span><span class="n">MAGENTA</span><span class="p">),</span>
+ <span class="p">(</span><span class="s2">"<cyan>"</span><span class="p">,</span> <span class="n">FG</span><span class="o">.</span><span class="n">CYAN</span><span class="p">),</span>
+ <span class="p">(</span><span class="s2">"<white>"</span><span class="p">,</span> <span class="n">FG</span><span class="o">.</span><span class="n">WHITE</span><span class="p">),</span>
+ <span class="p">(</span><span class="s2">"<bright>"</span><span class="p">,</span> <span class="n">ST</span><span class="o">.</span><span class="n">BRIGHT</span><span class="p">),</span>
+ <span class="p">(</span><span class="s2">"<normal>"</span><span class="p">,</span> <span class="n">ST</span><span class="o">.</span><span class="n">NORMAL</span><span class="p">),</span>
+ <span class="p">(</span><span class="s2">"<reset>"</span><span class="p">,</span> <span class="n">ST</span><span class="o">.</span><span class="n">RESET_ALL</span><span class="p">),</span>
+ <span class="p">(</span><span class="s2">"<info>"</span><span class="p">,</span> <span class="n">ST</span><span class="o">.</span><span class="n">RESET_ALL</span><span class="p">),</span>
+ <span class="p">(</span><span class="s2">"<header>"</span><span class="p">,</span> <span class="n">FG</span><span class="o">.</span><span class="n">BLUE</span><span class="p">),</span>
+ <span class="p">(</span><span class="s2">"<label>"</span><span class="p">,</span> <span class="n">FG</span><span class="o">.</span><span class="n">CYAN</span><span class="p">),</span>
+ <span class="p">(</span><span class="s2">"<success>"</span><span class="p">,</span> <span class="n">FG</span><span class="o">.</span><span class="n">GREEN</span><span class="p">),</span>
+ <span class="p">(</span><span class="s2">"<warning>"</span><span class="p">,</span> <span class="n">FG</span><span class="o">.</span><span class="n">RED</span><span class="p">),</span>
+ <span class="p">(</span><span class="s2">"<error>"</span><span class="p">,</span> <span class="n">FG</span><span class="o">.</span><span class="n">RED</span> <span class="o">+</span> <span class="n">ST</span><span class="o">.</span><span class="n">BRIGHT</span><span class="p">),</span>
+ <span class="p">(</span><span class="s2">"<critical>"</span><span class="p">,</span> <span class="n">FG</span><span class="o">.</span><span class="n">RED</span> <span class="o">+</span> <span class="n">ST</span><span class="o">.</span><span class="n">BRIGHT</span><span class="p">),</span>
+ <span class="p">(</span><span class="s2">"<OK>"</span><span class="p">,</span> <span class="n">FG</span><span class="o">.</span><span class="n">GREEN</span> <span class="o">+</span> <span class="n">ST</span><span class="o">.</span><span class="n">BRIGHT</span> <span class="o">+</span> <span class="s2">"OK"</span> <span class="o">+</span> <span class="n">ST</span><span class="o">.</span><span class="n">RESET_ALL</span><span class="p">),</span>
+ <span class="p">(</span><span class="s2">"<KO>"</span><span class="p">,</span> <span class="n">FG</span><span class="o">.</span><span class="n">RED</span> <span class="o">+</span> <span class="n">ST</span><span class="o">.</span><span class="n">BRIGHT</span> <span class="o">+</span> <span class="s2">"KO"</span> <span class="o">+</span> <span class="n">ST</span><span class="o">.</span><span class="n">RESET_ALL</span><span class="p">),</span>
+<span class="p">)</span>
+
+<span class="c1"># _tagsNone = ((i, "") for i,j in _tags) # to clean tags when log not tty</span>
+<span class="c1"># reversed order matters for item replaces backward to no color</span>
+<span class="n">_tagsNone</span> <span class="o">=</span> <span class="nb">reversed</span><span class="p">(</span> <span class="p">(</span>
+ <span class="p">(</span><span class="s2">"<black>"</span><span class="p">,</span> <span class="s2">""</span><span class="p">),</span>
+ <span class="p">(</span><span class="s2">"<red>"</span><span class="p">,</span> <span class="s2">""</span><span class="p">),</span>
+ <span class="p">(</span><span class="s2">"<green>"</span><span class="p">,</span> <span class="s2">""</span><span class="p">),</span>
+ <span class="p">(</span><span class="s2">"<yellow>"</span><span class="p">,</span> <span class="s2">""</span><span class="p">),</span>
+ <span class="p">(</span><span class="s2">"<blue>"</span><span class="p">,</span> <span class="s2">""</span><span class="p">),</span>
+ <span class="p">(</span><span class="s2">"<magenta>"</span><span class="p">,</span> <span class="s2">""</span><span class="p">),</span>
+ <span class="p">(</span><span class="s2">"<cyan>"</span><span class="p">,</span> <span class="s2">""</span><span class="p">),</span>
+ <span class="p">(</span><span class="s2">"<white>"</span><span class="p">,</span> <span class="s2">""</span><span class="p">),</span>
+ <span class="p">(</span><span class="s2">"<bright>"</span><span class="p">,</span> <span class="s2">""</span><span class="p">),</span>
+ <span class="p">(</span><span class="s2">"<normal>"</span><span class="p">,</span> <span class="s2">""</span><span class="p">),</span>
+ <span class="p">(</span><span class="s2">"<reset>"</span><span class="p">,</span> <span class="s2">""</span><span class="p">),</span>
+ <span class="p">(</span><span class="s2">"<info>"</span><span class="p">,</span> <span class="s2">""</span><span class="p">),</span>
+ <span class="p">(</span><span class="s2">"<header>"</span><span class="p">,</span> <span class="s2">""</span><span class="p">),</span>
+ <span class="p">(</span><span class="s2">"<label>"</span><span class="p">,</span> <span class="s2">""</span><span class="p">),</span>
+ <span class="p">(</span><span class="s2">"<success>"</span><span class="p">,</span> <span class="s2">""</span><span class="p">),</span>
+ <span class="p">(</span><span class="s2">"<warning>"</span><span class="p">,</span> <span class="s2">""</span><span class="p">),</span>
+ <span class="p">(</span><span class="s2">"<error>"</span><span class="p">,</span> <span class="s2">""</span><span class="p">),</span>
+ <span class="p">(</span><span class="s2">"<critical>"</span><span class="p">,</span> <span class="s2">""</span><span class="p">),</span>
+ <span class="p">(</span><span class="s2">"<OK>"</span><span class="p">,</span> <span class="s2">"OK"</span><span class="p">),</span>
+ <span class="p">(</span><span class="s2">"<KO>"</span><span class="p">,</span> <span class="s2">"KO"</span><span class="p">),</span>
+<span class="p">)</span> <span class="p">)</span>
+
+<div class="viewcode-block" id="indent"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.coloringSat.indent">[docs]</a><span class="k">def</span> <span class="nf">indent</span><span class="p">(</span><span class="n">msg</span><span class="p">,</span> <span class="n">nb</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 nb car (spaces) multi lines message except first one"""</span>
+ <span class="n">s</span> <span class="o">=</span> <span class="n">msg</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
+ <span class="n">res</span> <span class="o">=</span> <span class="p">(</span><span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="o">+</span><span class="n">car</span><span class="o">*</span><span class="n">nb</span><span class="p">)</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">s</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">res</span></div>
+
+<div class="viewcode-block" id="log"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.coloringSat.log">[docs]</a><span class="k">def</span> <span class="nf">log</span><span class="p">(</span><span class="n">msg</span><span class="p">):</span>
+ <span class="sd">"""elementary log stdout for debug if _verbose"""</span>
+ <span class="n">prefix</span> <span class="o">=</span> <span class="s2">"</span><span class="si">%s</span><span class="s2">.log: "</span> <span class="o">%</span> <span class="n">_name</span>
+ <span class="n">nb</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">prefix</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">_verbose</span><span class="p">:</span>
+ <span class="n">ini</span> <span class="o">=</span> <span class="n">prefix</span> <span class="o">+</span> <span class="n">indent</span><span class="p">(</span><span class="n">msg</span><span class="p">,</span> <span class="n">nb</span><span class="p">)</span>
+ <span class="n">res</span> <span class="o">=</span> <span class="n">toColor</span><span class="p">(</span><span class="n">ini</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">res</span> <span class="o">!=</span> <span class="n">ini</span><span class="p">:</span>
+ <span class="n">res</span> <span class="o">=</span> <span class="n">res</span> <span class="o">+</span> <span class="n">toColor</span><span class="p">(</span><span class="s2">"<reset>"</span><span class="p">)</span>
+ <span class="nb">print</span><span class="p">(</span><span class="n">res</span><span class="p">)</span></div>
+
+<div class="viewcode-block" id="ColoringStream"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.coloringSat.ColoringStream">[docs]</a><span class="k">class</span> <span class="nc">ColoringStream</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> write my stream class</span>
+<span class="sd"> only write and flush are used for the streaming</span>
+<span class="sd"> https://docs.python.org/2/library/logging.handlers.html</span>
+<span class="sd"> https://stackoverflow.com/questions/31999627/storing-logger-messages-in-a-string</span>
+<span class="sd"> """</span>
+ <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logs</span> <span class="o">=</span> <span class="s1">''</span>
+
+<div class="viewcode-block" id="ColoringStream.write"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.coloringSat.ColoringStream.write">[docs]</a> <span class="k">def</span> <span class="nf">write</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">astr</span><span class="p">):</span>
+ <span class="c1"># log("UnittestStream.write('%s')" % astr)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logs</span> <span class="o">+=</span> <span class="n">astr</span></div>
+
+<div class="viewcode-block" id="ColoringStream.flush"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.coloringSat.ColoringStream.flush">[docs]</a> <span class="k">def</span> <span class="nf">flush</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="k">pass</span></div>
+
+ <span class="k">def</span> <span class="nf">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">logs</span></div>
+
+<div class="viewcode-block" id="toColor"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.coloringSat.toColor">[docs]</a><span class="k">def</span> <span class="nf">toColor</span><span class="p">(</span><span class="n">msg</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> automatically clean the message of color tags '<red> ... </span>
+<span class="sd"> if the terminal output stdout is redirected by user</span>
+<span class="sd"> if not, replace tags with ansi color codes</span>
+<span class="sd"> </span>
+<span class="sd"> example:</span>
+<span class="sd"> >> sat compile SALOME > log.txt</span>
+<span class="sd"> """</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="p">(</span><span class="s1">'isatty'</span> <span class="ow">in</span> <span class="nb">dir</span><span class="p">(</span><span class="n">sys</span><span class="o">.</span><span class="n">stdout</span><span class="p">)</span> <span class="ow">and</span> <span class="n">sys</span><span class="o">.</span><span class="n">stdout</span><span class="o">.</span><span class="n">isatty</span><span class="p">()):</span>
+ <span class="c1"># clean the message color (if the terminal is redirected by user)</span>
+ <span class="k">return</span> <span class="n">replace</span><span class="p">(</span><span class="n">msg</span><span class="p">,</span> <span class="n">_tagsNone</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">return</span> <span class="n">replace</span><span class="p">(</span><span class="n">msg</span><span class="p">,</span> <span class="n">_tags</span><span class="p">)</span></div>
+
+<div class="viewcode-block" id="cleanColors"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.coloringSat.cleanColors">[docs]</a><span class="k">def</span> <span class="nf">cleanColors</span><span class="p">(</span><span class="n">msg</span><span class="p">):</span>
+ <span class="sd">"""clean the message of color tags '<red> ... """</span>
+ <span class="k">return</span> <span class="n">replace</span><span class="p">(</span><span class="n">msg</span><span class="p">,</span> <span class="n">_tagsNone</span><span class="p">)</span></div>
+
+<div class="viewcode-block" id="toColor_AnsiToWin32"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.coloringSat.toColor_AnsiToWin32">[docs]</a><span class="k">def</span> <span class="nf">toColor_AnsiToWin32</span><span class="p">(</span><span class="n">msg</span><span class="p">):</span>
+ <span class="sd">"""for test debug no wrapping"""</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="p">(</span><span class="s1">'isatty'</span> <span class="ow">in</span> <span class="nb">dir</span><span class="p">(</span><span class="n">sys</span><span class="o">.</span><span class="n">stdout</span><span class="p">)</span> <span class="ow">and</span> <span class="n">sys</span><span class="o">.</span><span class="n">stdout</span><span class="o">.</span><span class="n">isatty</span><span class="p">()):</span>
+ <span class="c1"># clean the message color if the terminal is redirected by user</span>
+ <span class="c1"># ex: sat compile appli > log.txt</span>
+ <span class="k">return</span> <span class="n">replace</span><span class="p">(</span><span class="n">msg</span><span class="p">,</span> <span class="n">_tagsNone</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">msgAnsi</span> <span class="o">=</span> <span class="n">replace</span><span class="p">(</span><span class="n">msg</span><span class="p">,</span> <span class="n">_tags</span><span class="p">)</span>
+ <span class="n">streamOut</span> <span class="o">=</span> <span class="n">ColoringStream</span><span class="p">()</span>
+ <span class="n">atw</span> <span class="o">=</span> <span class="n">AnsiToWin32</span><span class="p">(</span><span class="n">streamOut</span><span class="p">,</span> <span class="n">convert</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
+ <span class="n">streamIn</span> <span class="o">=</span> <span class="n">atw</span><span class="o">.</span><span class="n">stream</span>
+ <span class="nb">print</span> <span class="s2">"should_wrap"</span><span class="p">,</span><span class="n">atw</span><span class="o">.</span><span class="n">should_wrap</span><span class="p">(),</span><span class="n">atw</span><span class="o">.</span><span class="n">convert</span><span class="p">,</span><span class="n">atw</span><span class="o">.</span><span class="n">strip</span><span class="p">,</span><span class="n">atw</span><span class="o">.</span><span class="n">autoreset</span>
+ <span class="n">streamIn</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">msgAnsi</span><span class="p">)</span>
+ <span class="c1">#AnsiToWin32(streamOut).write_and_convert(msgAnsi)</span>
+ <span class="c1"># print "streamOut",str(streamOut)</span>
+ <span class="k">return</span> <span class="nb">str</span><span class="p">(</span><span class="n">streamOut</span><span class="p">)</span></div>
+
+<div class="viewcode-block" id="replace"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.coloringSat.replace">[docs]</a><span class="k">def</span> <span class="nf">replace</span><span class="p">(</span><span class="n">msg</span><span class="p">,</span> <span class="n">tags</span><span class="p">):</span>
+ <span class="n">s</span> <span class="o">=</span> <span class="n">msg</span>
+ <span class="k">for</span> <span class="n">r</span> <span class="ow">in</span> <span class="n">tags</span><span class="p">:</span>
+ <span class="n">s</span> <span class="o">=</span> <span class="n">s</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="o">*</span><span class="n">r</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">s</span></div>
+
+<span class="k">if</span> <span class="vm">__name__</span> <span class="o">==</span> <span class="s2">"__main__"</span><span class="p">:</span>
+ <span class="c1">#log(FG.BLUE + 'blue text on stdout'+ ST.RESET_ALL)</span>
+ <span class="n">log</span><span class="p">(</span><span class="s2">"import <green>colorama at <blue></span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="n">CLRM</span><span class="o">.</span><span class="vm">__file__</span><span class="p">)</span>
+ <span class="n">log</span><span class="p">(</span><span class="s2">"import <green>colorama<reset> in <blue></span><span class="si">%s</span><span class="s2">: <OK>"</span> <span class="o">%</span> <span class="vm">__file__</span><span class="p">)</span>
+ <span class="n">log</span><span class="p">(</span><span class="s2">"import <green>colorama<reset> in <blue></span><span class="si">%s</span><span class="s2">: <KO>"</span> <span class="o">%</span> <span class="vm">__file__</span><span class="p">)</span>
+ <span class="n">log</span><span class="p">(</span><span class="s2">"import <green>colorama in <blue></span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="vm">__file__</span><span class="p">)</span>
+ <span class="n">log</span><span class="p">(</span><span class="s2">"set <green>green and not reset..."</span><span class="p">)</span>
+ <span class="n">log</span><span class="p">(</span><span class="s2">"...and here is not green because appended reset at end of message"</span><span class="p">)</span>
+ <span class="n">log</span><span class="p">(</span><span class="s2">"dir(FG):</span><span class="se">\n</span><span class="s2"><blue></span><span class="si">%s</span><span class="s2"> ... <OK> or <KO> ??"</span> <span class="o">%</span> <span class="nb">dir</span><span class="p">(</span><span class="n">FG</span><span class="p">))</span>
+ <span class="n">log</span><span class="p">(</span><span class="s2">"dir(ST):</span><span class="se">\n</span><span class="s2"><blue></span><span class="si">%s</span><span class="s2"> ... <OK> or <KO> ??"</span> <span class="o">%</span> <span class="nb">dir</span><span class="p">(</span><span class="n">ST</span><span class="p">))</span>
+
+
+</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>
+ <form class="search" action="../../search.html" method="get">
+ <div><input type="text" name="q" /></div>
+ <div><input type="submit" value="Go" /></div>
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</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.4.9</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
+
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
-
<!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.compilation — salomeTools 5.0.0dev documentation</title>
+
<link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
- <script type="text/javascript" src="../../_static/documentation_options.js"></script>
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
- <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/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="top" title="salomeTools 5.0.0dev documentation" href="../../index.html" />
+ <link rel="up" title="Module code" href="../index.html" />
<link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
- </head><body>
+ </head>
+ <body role="document">
<div class="document">
<span class="kn">import</span> <span class="nn">sys</span>
<span class="kn">import</span> <span class="nn">shutil</span>
-<span class="kn">import</span> <span class="nn">src</span>
+<span class="kn">from</span> <span class="nn">src.options</span> <span class="k">import</span> <span class="n">OptResult</span>
+<span class="kn">import</span> <span class="nn">src.utilsSat</span> <span class="k">as</span> <span class="nn">UTS</span>
+
<span class="n">C_COMPILE_ENV_LIST</span> <span class="o">=</span> <span class="p">[</span><span class="s2">"CC"</span><span class="p">,</span>
<span class="s2">"CXX"</span><span class="p">,</span>
<span class="n">config</span><span class="p">,</span>
<span class="n">logger</span><span class="p">,</span>
<span class="n">product_info</span><span class="p">,</span>
- <span class="n">options</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">options</span><span class="o">.</span><span class="n">OptResult</span><span class="p">(),</span>
+ <span class="n">options</span> <span class="o">=</span> <span class="n">OptResult</span><span class="p">(),</span>
<span class="n">check_src</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">config</span> <span class="o">=</span> <span class="n">config</span>
<span class="bp">self</span><span class="o">.</span><span class="n">logger</span> <span class="o">=</span> <span class="n">logger</span>
<span class="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="c1">##</span>
- <span class="c1"># Shortcut method to log in log file.</span>
<div class="viewcode-block" id="Builder.log"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.compilation.Builder.log">[docs]</a> <span class="k">def</span> <span class="nf">log</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">text</span><span class="p">,</span> <span class="n">level</span><span class="p">,</span> <span class="n">showInfo</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">text</span><span class="p">,</span> <span class="n">level</span><span class="p">,</span> <span class="n">showInfo</span><span class="p">)</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">logTxtFile</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">src</span><span class="o">.</span><span class="n">printcolors</span><span class="o">.</span><span class="n">cleancolor</span><span class="p">(</span><span class="n">text</span><span class="p">))</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">flush</span><span class="p">()</span></div>
+ <span class="sd">"""Shortcut method to log in log file."""</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="n">text</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">logTxtFile</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">UTS</span><span class="o">.</span><span class="n">cleancolor</span><span class="p">(</span><span class="n">text</span><span class="p">))</span></div>
- <span class="c1">##</span>
- <span class="c1"># Shortcut method to log a command.</span>
<div class="viewcode-block" id="Builder.log_command"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.compilation.Builder.log_command">[docs]</a> <span class="k">def</span> <span class="nf">log_command</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">command</span><span class="p">):</span>
+ <span class="sd">"""Shortcut method to log a command."""</span>
<span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="p">(</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="n">command</span><span class="p">,</span> <span class="mi">5</span><span class="p">)</span></div>
- <span class="c1">##</span>
- <span class="c1"># Prepares the environment.</span>
- <span class="c1"># Build two environment: one for building and one for testing (launch).</span>
<div class="viewcode-block" id="Builder.prepare"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.compilation.Builder.prepare">[docs]</a> <span class="k">def</span> <span class="nf">prepare</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Prepares the environment.</span>
+<span class="sd"> Build two environment: one for building and one for testing (launch).</span>
+<span class="sd"> """</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">build_dir</span><span class="o">.</span><span class="n">exists</span><span class="p">():</span>
<span class="c1"># create build dir</span>
<span class="n">hh</span> <span class="o">=</span> <span class="s1">'MSBUILD /m:</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="nb">str</span><span class="p">(</span><span class="n">nb_proc</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">debug_mode</span><span class="p">:</span>
- <span class="n">hh</span> <span class="o">+=</span> <span class="s2">" "</span> <span class="o">+</span> <span class="n">src</span><span class="o">.</span><span class="n">printcolors</span><span class="o">.</span><span class="n">printcWarning</span><span class="p">(</span><span class="s2">"DEBUG"</span><span class="p">)</span>
+ <span class="n">hh</span> <span class="o">+=</span> <span class="s2">" "</span> <span class="o">+</span> <span class="n">UTS</span><span class="o">.</span><span class="n">red</span><span class="p">(</span><span class="s2">"DEBUG"</span><span class="p">)</span>
<span class="c1"># make</span>
<span class="n">command</span> <span class="o">=</span> <span class="s1">'msbuild'</span>
<span class="n">command</span> <span class="o">=</span> <span class="n">command</span> <span class="o">+</span> <span class="s2">" /maxcpucount:"</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">nb_proc</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_result</span><span class="p">()</span></div>
- <span class="c1">##</span>
- <span class="c1"># Performs a build with a script.</span>
<div class="viewcode-block" id="Builder.do_python_script_build"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.compilation.Builder.do_python_script_build">[docs]</a> <span class="k">def</span> <span class="nf">do_python_script_build</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">script</span><span class="p">,</span> <span class="n">nb_proc</span><span class="p">):</span>
+ <span class="sd">"""Performs a build with a script."""</span>
<span class="c1"># script found</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s2">"Compile </span><span class="si">%(product)s</span><span class="s2"> using script </span><span class="si">%(script)s</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span> <span class="o">%</span> \
- <span class="p">{</span> <span class="s1">'product'</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">product_info</span><span class="o">.</span><span class="n">name</span><span class="p">,</span>
- <span class="s1">'script'</span><span class="p">:</span> <span class="n">src</span><span class="o">.</span><span class="n">printcolors</span><span class="o">.</span><span class="n">printcLabel</span><span class="p">(</span><span class="n">script</span><span class="p">)</span> <span class="p">},</span> <span class="mi">4</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s2">"Compile </span><span class="si">%s</span><span class="s2"> using script </span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span> <span class="o">%</span> \
+ <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">product_info</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">UTS</span><span class="o">.</span><span class="n">label</span><span class="p">(</span><span class="n">script</span><span class="p">))</span> <span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="kn">import</span> <span class="nn">imp</span>
<span class="n">product</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">product_info</span><span class="o">.</span><span class="n">name</span>
<span class="n">retcode</span> <span class="o">=</span> <span class="n">pymodule</span><span class="o">.</span><span class="n">compil</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="p">,</span> <span class="bp">self</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="p">)</span>
<span class="k">except</span><span class="p">:</span>
<span class="n">__</span><span class="p">,</span> <span class="n">exceptionValue</span><span class="p">,</span> <span class="n">exceptionTraceback</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">exc_info</span><span class="p">()</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">exceptionValue</span><span class="p">),</span> <span class="mi">1</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">exceptionValue</span><span class="p">))</span>
<span class="kn">import</span> <span class="nn">traceback</span>
<span class="n">traceback</span><span class="o">.</span><span class="n">print_tb</span><span class="p">(</span><span class="n">exceptionTraceback</span><span class="p">)</span>
<span class="n">traceback</span><span class="o">.</span><span class="n">print_exc</span><span class="p">()</span>
<span class="n">retcode</span> <span class="o">=</span> <span class="mi">1</span>
<span class="k">finally</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">put_txt_log_in_appli_log_dir</span><span class="p">(</span><span class="s2">"script"</span><span class="p">)</span>
-
<span class="k">return</span> <span class="n">retcode</span></div>
<div class="viewcode-block" id="Builder.complete_environment"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.compilation.Builder.complete_environment">[docs]</a> <span class="k">def</span> <span class="nf">complete_environment</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">make_options</span><span class="p">):</span>
<span class="k">if</span> <span class="n">extension</span> <span class="o">==</span> <span class="s2">"py"</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">do_python_script_build</span><span class="p">(</span><span class="n">script</span><span class="p">,</span> <span class="n">nb_proc</span><span class="p">)</span>
- <span class="n">msg</span> <span class="o">=</span> <span class="n">_</span><span class="p">(</span><span class="s2">"The script </span><span class="si">%s</span><span class="s2"> must have .sh, .bat or .py extension."</span> <span class="o">%</span> <span class="n">script</span><span class="p">)</span>
- <span class="k">raise</span> <span class="n">src</span><span class="o">.</span><span class="n">SatException</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span></div>
+ <span class="n">msg</span> <span class="o">=</span> <span class="n">_</span><span class="p">(</span><span class="s2">"The script </span><span class="si">%s</span><span class="s2"> must have .sh, .bat or .py extension."</span><span class="p">)</span> <span class="o">%</span> <span class="n">script</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="Builder.put_txt_log_in_appli_log_dir"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.compilation.Builder.put_txt_log_in_appli_log_dir">[docs]</a> <span class="k">def</span> <span class="nf">put_txt_log_in_appli_log_dir</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">file_name</span><span class="p">):</span>
<span class="sd">'''Put the txt log (that contain the system logs, like make command</span>
<span class="s2">"LOGS"</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">product_info</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
<span class="n">file_path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">dir_where_to_put</span><span class="p">,</span> <span class="n">file_name</span><span class="p">)</span>
- <span class="n">src</span><span class="o">.</span><span class="n">ensure_path_exists</span><span class="p">(</span><span class="n">dir_where_to_put</span><span class="p">)</span>
+ <span class="n">UTS</span><span class="o">.</span><span class="n">ensure_path_exists</span><span class="p">(</span><span class="n">dir_where_to_put</span><span class="p">)</span>
<span class="c1"># write the logTxtFile copy it to the destination, and then recreate </span>
<span class="c1"># it as it was</span>
<span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">logTxtFile</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
</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" />
+ <div><input type="text" name="q" /></div>
+ <div><input type="submit" value="Go" /></div>
<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>
©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>
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.9</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
</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="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>src.configManager — 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">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+ <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/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="top" title="salomeTools 5.0.0dev documentation" href="../../index.html" />
+ <link rel="up" title="Module code" href="../index.html" />
+
+ <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+ </head>
+ <body role="document">
+
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <h1>Source code for src.configManager</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-2012 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="kn">import</span> <span class="nn">os</span>
+<span class="kn">import</span> <span class="nn">platform</span>
+<span class="kn">import</span> <span class="nn">datetime</span>
+<span class="kn">import</span> <span class="nn">shutil</span>
+<span class="kn">import</span> <span class="nn">sys</span>
+
+<span class="kn">import</span> <span class="nn">src.debug</span> <span class="k">as</span> <span class="nn">DBG</span>
+<span class="kn">import</span> <span class="nn">src.loggingSat</span> <span class="k">as</span> <span class="nn">LOG</span>
+<span class="kn">import</span> <span class="nn">src.returnCode</span> <span class="k">as</span> <span class="nn">RCO</span>
+<span class="kn">import</span> <span class="nn">src.architecture</span> <span class="k">as</span> <span class="nn">ARCH</span>
+<span class="kn">import</span> <span class="nn">src.utilsSat</span> <span class="k">as</span> <span class="nn">UTS</span>
+<span class="kn">import</span> <span class="nn">src.pyconf</span> <span class="k">as</span> <span class="nn">PYCONF</span>
+
+<div class="viewcode-block" id="ConfigOpener"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.configManager.ConfigOpener">[docs]</a><span class="k">class</span> <span class="nc">ConfigOpener</span><span class="p">:</span>
+ <span class="sd">"""</span>
+<span class="sd"> Class that helps to find an application pyconf </span>
+<span class="sd"> in all the possible directories (pathList)</span>
+<span class="sd"> """</span>
+ <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">pathList</span><span class="p">):</span>
+ <span class="sd">'''Initialization</span>
+<span class="sd"> </span>
+<span class="sd"> :param pathList list: The list of paths where to search a pyconf.</span>
+<span class="sd"> '''</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">pathList</span> <span class="o">=</span> <span class="n">pathList</span>
+
+ <span class="k">def</span> <span class="nf">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
+ <span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isabs</span><span class="p">(</span><span class="n">name</span><span class="p">):</span>
+ <span class="k">return</span> <span class="n">PYCONF</span><span class="o">.</span><span class="n">ConfigInputStream</span><span class="p">(</span><span class="nb">open</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="s1">'rb'</span><span class="p">))</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">return</span> <span class="n">PYCONF</span><span class="o">.</span><span class="n">ConfigInputStream</span><span class="p">(</span>
+ <span class="nb">open</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_path</span><span class="p">(</span><span class="n">name</span><span class="p">),</span> <span class="n">name</span> <span class="p">),</span> <span class="s1">'rb'</span><span class="p">)</span> <span class="p">)</span>
+ <span class="k">raise</span> <span class="ne">IOError</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s2">"Configuration file '</span><span class="si">%s</span><span class="s2">' not found"</span><span class="p">)</span> <span class="o">%</span> <span class="n">name</span><span class="p">)</span>
+
+<div class="viewcode-block" id="ConfigOpener.get_path"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.configManager.ConfigOpener.get_path">[docs]</a> <span class="k">def</span> <span class="nf">get_path</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">'''The method that returns the entire path of the pyconf searched</span>
+<span class="sd"> :param name str: The name of the searched pyconf.</span>
+<span class="sd"> '''</span>
+ <span class="k">for</span> <span class="n">path</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">pathList</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">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">path</span><span class="p">,</span> <span class="n">name</span><span class="p">)):</span>
+ <span class="k">return</span> <span class="n">path</span>
+ <span class="k">raise</span> <span class="ne">IOError</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s2">"Configuration file '</span><span class="si">%s</span><span class="s2">' not found"</span><span class="p">)</span> <span class="o">%</span> <span class="n">name</span><span class="p">)</span></div></div>
+
+<div class="viewcode-block" id="ConfigManager"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.configManager.ConfigManager">[docs]</a><span class="k">class</span> <span class="nc">ConfigManager</span><span class="p">:</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Class that manages the read of all the config .pyconf files of salomeTools</span>
+<span class="sd"> """</span>
+ <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">runner</span><span class="p">):</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">runner</span> <span class="o">=</span> <span class="n">runner</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span> <span class="o">=</span> <span class="n">runner</span><span class="o">.</span><span class="n">getLogger</span><span class="p">()</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">datadir</span> <span class="o">=</span> <span class="kc">None</span>
+
+ <span class="k">def</span> <span class="nf">_create_vars</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">application</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">command</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">datadir</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
+ <span class="sd">"""Create a dictionary that stores all information about machine,</span>
+<span class="sd"> user, date, repositories, etc...</span>
+<span class="sd"> </span>
+<span class="sd"> :param application str: The application for which salomeTools is called.</span>
+<span class="sd"> :param command str: The command that is called.</span>
+<span class="sd"> :param datadir str: The repository that contain external data </span>
+<span class="sd"> for salomeTools.</span>
+<span class="sd"> :return: The dictionary that stores all information.</span>
+<span class="sd"> :rtype: dict</span>
+<span class="sd"> """</span>
+ <span class="n">var</span> <span class="o">=</span> <span class="p">{}</span>
+ <span class="n">var</span><span class="p">[</span><span class="s1">'user'</span><span class="p">]</span> <span class="o">=</span> <span class="n">ARCH</span><span class="o">.</span><span class="n">get_user</span><span class="p">()</span>
+ <span class="n">var</span><span class="p">[</span><span class="s1">'salometoolsway'</span><span class="p">]</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span>
+ <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="n">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="vm">__file__</span><span class="p">)))</span>
+ <span class="n">var</span><span class="p">[</span><span class="s1">'srcDir'</span><span class="p">]</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">var</span><span class="p">[</span><span class="s1">'salometoolsway'</span><span class="p">],</span> <span class="s1">'src'</span><span class="p">)</span>
+ <span class="n">var</span><span class="p">[</span><span class="s1">'internal_dir'</span><span class="p">]</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">var</span><span class="p">[</span><span class="s1">'srcDir'</span><span class="p">],</span> <span class="s1">'internal_config'</span><span class="p">)</span>
+ <span class="n">var</span><span class="p">[</span><span class="s1">'sep'</span><span class="p">]</span><span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">sep</span>
+
+ <span class="c1"># datadir has a default location</span>
+ <span class="n">var</span><span class="p">[</span><span class="s1">'datadir'</span><span class="p">]</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">var</span><span class="p">[</span><span class="s1">'salometoolsway'</span><span class="p">],</span> <span class="s1">'data'</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">datadir</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
+ <span class="n">var</span><span class="p">[</span><span class="s1">'datadir'</span><span class="p">]</span> <span class="o">=</span> <span class="n">datadir</span>
+
+ <span class="n">var</span><span class="p">[</span><span class="s1">'personalDir'</span><span class="p">]</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">expanduser</span><span class="p">(</span><span class="s1">'~'</span><span class="p">),</span>
+ <span class="s1">'.salomeTools'</span><span class="p">)</span>
+ <span class="n">UTS</span><span class="o">.</span><span class="n">ensure_path_exists</span><span class="p">(</span><span class="n">var</span><span class="p">[</span><span class="s1">'personalDir'</span><span class="p">])</span>
+
+ <span class="n">var</span><span class="p">[</span><span class="s1">'personal_applications_dir'</span><span class="p">]</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">var</span><span class="p">[</span><span class="s1">'personalDir'</span><span class="p">],</span>
+ <span class="s2">"Applications"</span><span class="p">)</span>
+ <span class="n">UTS</span><span class="o">.</span><span class="n">ensure_path_exists</span><span class="p">(</span><span class="n">var</span><span class="p">[</span><span class="s1">'personal_applications_dir'</span><span class="p">])</span>
+
+ <span class="n">var</span><span class="p">[</span><span class="s1">'personal_products_dir'</span><span class="p">]</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">var</span><span class="p">[</span><span class="s1">'personalDir'</span><span class="p">],</span>
+ <span class="s2">"products"</span><span class="p">)</span>
+ <span class="n">UTS</span><span class="o">.</span><span class="n">ensure_path_exists</span><span class="p">(</span><span class="n">var</span><span class="p">[</span><span class="s1">'personal_products_dir'</span><span class="p">])</span>
+
+ <span class="n">var</span><span class="p">[</span><span class="s1">'personal_archives_dir'</span><span class="p">]</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">var</span><span class="p">[</span><span class="s1">'personalDir'</span><span class="p">],</span>
+ <span class="s2">"Archives"</span><span class="p">)</span>
+ <span class="n">UTS</span><span class="o">.</span><span class="n">ensure_path_exists</span><span class="p">(</span><span class="n">var</span><span class="p">[</span><span class="s1">'personal_archives_dir'</span><span class="p">])</span>
+
+ <span class="n">var</span><span class="p">[</span><span class="s1">'personal_jobs_dir'</span><span class="p">]</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">var</span><span class="p">[</span><span class="s1">'personalDir'</span><span class="p">],</span>
+ <span class="s2">"Jobs"</span><span class="p">)</span>
+ <span class="n">UTS</span><span class="o">.</span><span class="n">ensure_path_exists</span><span class="p">(</span><span class="n">var</span><span class="p">[</span><span class="s1">'personal_jobs_dir'</span><span class="p">])</span>
+
+ <span class="n">var</span><span class="p">[</span><span class="s1">'personal_machines_dir'</span><span class="p">]</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">var</span><span class="p">[</span><span class="s1">'personalDir'</span><span class="p">],</span>
+ <span class="s2">"Machines"</span><span class="p">)</span>
+ <span class="n">UTS</span><span class="o">.</span><span class="n">ensure_path_exists</span><span class="p">(</span><span class="n">var</span><span class="p">[</span><span class="s1">'personal_machines_dir'</span><span class="p">])</span>
+
+ <span class="c1"># read linux distributions dictionary</span>
+ <span class="n">distrib_cfg</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">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">var</span><span class="p">[</span><span class="s1">'srcDir'</span><span class="p">],</span>
+ <span class="s1">'internal_config'</span><span class="p">,</span>
+ <span class="s1">'distrib.pyconf'</span><span class="p">))</span>
+
+ <span class="c1"># set platform parameters</span>
+ <span class="n">dist_name</span> <span class="o">=</span> <span class="n">ARCH</span><span class="o">.</span><span class="n">get_distribution</span><span class="p">(</span><span class="n">codes</span><span class="o">=</span><span class="n">distrib_cfg</span><span class="o">.</span><span class="n">DISTRIBUTIONS</span><span class="p">)</span>
+ <span class="n">dist_version</span> <span class="o">=</span> <span class="n">ARCH</span><span class="o">.</span><span class="n">get_distrib_version</span><span class="p">(</span><span class="n">dist_name</span><span class="p">,</span>
+ <span class="n">codes</span><span class="o">=</span><span class="n">distrib_cfg</span><span class="o">.</span><span class="n">VERSIONS</span><span class="p">)</span>
+ <span class="n">dist</span> <span class="o">=</span> <span class="n">dist_name</span> <span class="o">+</span> <span class="n">dist_version</span>
+
+ <span class="n">var</span><span class="p">[</span><span class="s1">'dist_name'</span><span class="p">]</span> <span class="o">=</span> <span class="n">dist_name</span>
+ <span class="n">var</span><span class="p">[</span><span class="s1">'dist_version'</span><span class="p">]</span> <span class="o">=</span> <span class="n">dist_version</span>
+ <span class="n">var</span><span class="p">[</span><span class="s1">'dist'</span><span class="p">]</span> <span class="o">=</span> <span class="n">dist</span>
+ <span class="n">var</span><span class="p">[</span><span class="s1">'python'</span><span class="p">]</span> <span class="o">=</span> <span class="n">ARCH</span><span class="o">.</span><span class="n">get_python_version</span><span class="p">()</span>
+
+ <span class="n">var</span><span class="p">[</span><span class="s1">'nb_proc'</span><span class="p">]</span> <span class="o">=</span> <span class="n">ARCH</span><span class="o">.</span><span class="n">get_nb_proc</span><span class="p">()</span>
+ <span class="n">node_name</span> <span class="o">=</span> <span class="n">platform</span><span class="o">.</span><span class="n">node</span><span class="p">()</span>
+ <span class="n">var</span><span class="p">[</span><span class="s1">'node'</span><span class="p">]</span> <span class="o">=</span> <span class="n">node_name</span>
+ <span class="n">var</span><span class="p">[</span><span class="s1">'hostname'</span><span class="p">]</span> <span class="o">=</span> <span class="n">node_name</span>
+
+ <span class="c1"># set date parameters</span>
+ <span class="n">dt</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">now</span><span class="p">()</span>
+ <span class="n">var</span><span class="p">[</span><span class="s1">'date'</span><span class="p">]</span> <span class="o">=</span> <span class="n">dt</span><span class="o">.</span><span class="n">strftime</span><span class="p">(</span><span class="s1">'%Y%m</span><span class="si">%d</span><span class="s1">'</span><span class="p">)</span>
+ <span class="n">var</span><span class="p">[</span><span class="s1">'datehour'</span><span class="p">]</span> <span class="o">=</span> <span class="n">dt</span><span class="o">.</span><span class="n">strftime</span><span class="p">(</span><span class="s1">'%Y%m</span><span class="si">%d</span><span class="s1">_%H%M%S'</span><span class="p">)</span>
+ <span class="n">var</span><span class="p">[</span><span class="s1">'hour'</span><span class="p">]</span> <span class="o">=</span> <span class="n">dt</span><span class="o">.</span><span class="n">strftime</span><span class="p">(</span><span class="s1">'%H%M%S'</span><span class="p">)</span>
+
+ <span class="n">var</span><span class="p">[</span><span class="s1">'command'</span><span class="p">]</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">command</span><span class="p">)</span>
+ <span class="n">var</span><span class="p">[</span><span class="s1">'application'</span><span class="p">]</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">application</span><span class="p">)</span>
+
+ <span class="c1"># Root dir for temporary files </span>
+ <span class="n">var</span><span class="p">[</span><span class="s1">'tmp_root'</span><span class="p">]</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">sep</span> <span class="o">+</span> <span class="s1">'tmp'</span> <span class="o">+</span> <span class="n">os</span><span class="o">.</span><span class="n">sep</span> <span class="o">+</span> <span class="n">var</span><span class="p">[</span><span class="s1">'user'</span><span class="p">]</span>
+ <span class="c1"># particular win case </span>
+ <span class="k">if</span> <span class="n">ARCH</span><span class="o">.</span><span class="n">is_windows</span><span class="p">()</span> <span class="p">:</span>
+ <span class="n">var</span><span class="p">[</span><span class="s1">'tmp_root'</span><span class="p">]</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">expanduser</span><span class="p">(</span><span class="s1">'~'</span><span class="p">)</span> <span class="o">+</span> <span class="n">os</span><span class="o">.</span><span class="n">sep</span> <span class="o">+</span> <span class="s1">'tmp'</span>
+
+ <span class="k">return</span> <span class="n">var</span>
+
+<div class="viewcode-block" id="ConfigManager.get_command_line_overrides"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.configManager.ConfigManager.get_command_line_overrides">[docs]</a> <span class="k">def</span> <span class="nf">get_command_line_overrides</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">options</span><span class="p">,</span> <span class="n">sections</span><span class="p">):</span>
+ <span class="sd">'''get all the overwrites that are in the command line</span>
+<span class="sd"> </span>
+<span class="sd"> :param options: the options from salomeTools class </span>
+<span class="sd"> initialization (like -l5 or --overwrite)</span>
+<span class="sd"> :param sections str: The config section to overwrite.</span>
+<span class="sd"> :return: The list of all the overwrites to apply.</span>
+<span class="sd"> :rtype: list</span>
+<span class="sd"> '''</span>
+ <span class="c1"># when there are no options or not the overwrite option, </span>
+ <span class="c1"># return an empty list</span>
+ <span class="k">if</span> <span class="n">options</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">or</span> <span class="n">options</span><span class="o">.</span><span class="n">overwrite</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
+ <span class="k">return</span> <span class="p">[]</span>
+
+ <span class="n">over</span> <span class="o">=</span> <span class="p">[]</span>
+ <span class="k">for</span> <span class="n">section</span> <span class="ow">in</span> <span class="n">sections</span><span class="p">:</span>
+ <span class="c1"># only overwrite the sections that correspond to the option </span>
+ <span class="n">over</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="nb">filter</span><span class="p">(</span><span class="k">lambda</span> <span class="n">l</span><span class="p">:</span> <span class="n">l</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="n">section</span> <span class="o">+</span> <span class="s2">"."</span><span class="p">),</span>
+ <span class="n">options</span><span class="o">.</span><span class="n">overwrite</span><span class="p">))</span>
+ <span class="k">return</span> <span class="n">over</span></div>
+
+<div class="viewcode-block" id="ConfigManager.get_config"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.configManager.ConfigManager.get_config">[docs]</a> <span class="k">def</span> <span class="nf">get_config</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">application</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">options</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">command</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
+ <span class="n">datadir</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
+ <span class="sd">'''get the config from all the configuration files.</span>
+<span class="sd"> </span>
+<span class="sd"> :param application str: The application for which salomeTools is called.</span>
+<span class="sd"> :param options class Options: The general salomeTools</span>
+<span class="sd"> options (--overwrite or -v5, for example)</span>
+<span class="sd"> :param command str: The command that is called.</span>
+<span class="sd"> :param datadir str: The repository that contain </span>
+<span class="sd"> external data for salomeTools.</span>
+<span class="sd"> :return: The final config.</span>
+<span class="sd"> :rtype: class 'PYCONF.Config'</span>
+<span class="sd"> '''</span>
+
+ <span class="c1"># create a ConfigMerger to handle merge</span>
+ <span class="n">merger</span> <span class="o">=</span> <span class="n">PYCONF</span><span class="o">.</span><span class="n">ConfigMerger</span><span class="p">()</span> <span class="c1">#MergeHandler())</span>
+
+ <span class="c1"># create the configuration instance</span>
+ <span class="n">cfg</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="c1"># =====================================================================</span>
+ <span class="c1"># create VARS section</span>
+ <span class="n">var</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_create_vars</span><span class="p">(</span><span class="n">application</span><span class="o">=</span><span class="n">application</span><span class="p">,</span> <span class="n">command</span><span class="o">=</span><span class="n">command</span><span class="p">,</span>
+ <span class="n">datadir</span><span class="o">=</span><span class="n">datadir</span><span class="p">)</span>
+ <span class="c1"># add VARS to config</span>
+ <span class="n">cfg</span><span class="o">.</span><span class="n">VARS</span> <span class="o">=</span> <span class="n">PYCONF</span><span class="o">.</span><span class="n">Mapping</span><span class="p">(</span><span class="n">cfg</span><span class="p">)</span>
+ <span class="k">for</span> <span class="n">variable</span> <span class="ow">in</span> <span class="n">var</span><span class="p">:</span>
+ <span class="n">cfg</span><span class="o">.</span><span class="n">VARS</span><span class="p">[</span><span class="n">variable</span><span class="p">]</span> <span class="o">=</span> <span class="n">var</span><span class="p">[</span><span class="n">variable</span><span class="p">]</span>
+
+ <span class="c1"># apply overwrite from command line if needed</span>
+ <span class="k">for</span> <span class="n">rule</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_command_line_overrides</span><span class="p">(</span><span class="n">options</span><span class="p">,</span> <span class="p">[</span><span class="s2">"VARS"</span><span class="p">]):</span>
+ <span class="n">exec</span><span class="p">(</span><span class="s1">'cfg.'</span> <span class="o">+</span> <span class="n">rule</span><span class="p">)</span> <span class="c1"># this cannot be factorized because of the exec</span>
+
+ <span class="c1"># =====================================================================</span>
+ <span class="c1"># Load INTERNAL config</span>
+ <span class="c1"># read src/internal_config/salomeTools.pyconf</span>
+ <span class="n">PYCONF</span><span class="o">.</span><span class="n">streamOpener</span> <span class="o">=</span> <span class="n">ConfigOpener</span><span class="p">([</span>
+ <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">cfg</span><span class="o">.</span><span class="n">VARS</span><span class="o">.</span><span class="n">srcDir</span><span class="p">,</span> <span class="s1">'internal_config'</span><span class="p">)])</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="n">internal_cfg</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="nb">open</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">cfg</span><span class="o">.</span><span class="n">VARS</span><span class="o">.</span><span class="n">srcDir</span><span class="p">,</span>
+ <span class="s1">'internal_config'</span><span class="p">,</span> <span class="s1">'salomeTools.pyconf'</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="ne">Exception</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s2">"Error in configuration file:"</span>
+ <span class="s2">" salomeTools.pyconf</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">'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="n">merger</span><span class="o">.</span><span class="n">merge</span><span class="p">(</span><span class="n">cfg</span><span class="p">,</span> <span class="n">internal_cfg</span><span class="p">)</span>
+
+ <span class="c1"># apply overwrite from command line if needed</span>
+ <span class="k">for</span> <span class="n">rule</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_command_line_overrides</span><span class="p">(</span><span class="n">options</span><span class="p">,</span> <span class="p">[</span><span class="s2">"INTERNAL"</span><span class="p">]):</span>
+ <span class="n">exec</span><span class="p">(</span><span class="s1">'cfg.'</span> <span class="o">+</span> <span class="n">rule</span><span class="p">)</span> <span class="c1"># this cannot be factorized because of the exec </span>
+
+ <span class="c1"># =====================================================================</span>
+ <span class="c1"># Load LOCAL config file</span>
+ <span class="c1"># search only in the data directory</span>
+ <span class="n">PYCONF</span><span class="o">.</span><span class="n">streamOpener</span> <span class="o">=</span> <span class="n">ConfigOpener</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">datadir</span><span class="p">])</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="n">local_cfg</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="nb">open</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">cfg</span><span class="o">.</span><span class="n">VARS</span><span class="o">.</span><span class="n">datadir</span><span class="p">,</span>
+ <span class="s1">'local.pyconf'</span><span class="p">)),</span>
+ <span class="n">PWD</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'LOCAL'</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">datadir</span><span class="p">)</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="ne">Exception</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s2">"Error in configuration file: "</span>
+ <span class="s2">"local.pyconf</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">'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">except</span> <span class="ne">IOError</span> <span class="k">as</span> <span class="n">error</span><span class="p">:</span>
+ <span class="n">e</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">error</span><span class="p">)</span>
+ <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span> <span class="n">e</span> <span class="p">);</span>
+ <span class="n">merger</span><span class="o">.</span><span class="n">merge</span><span class="p">(</span><span class="n">cfg</span><span class="p">,</span> <span class="n">local_cfg</span><span class="p">)</span>
+
+ <span class="c1"># When the key is "default", put the default value</span>
+ <span class="k">if</span> <span class="n">cfg</span><span class="o">.</span><span class="n">LOCAL</span><span class="o">.</span><span class="n">base</span> <span class="o">==</span> <span class="s2">"default"</span><span class="p">:</span>
+ <span class="n">cfg</span><span class="o">.</span><span class="n">LOCAL</span><span class="o">.</span><span class="n">base</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">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">salometoolsway</span><span class="p">,</span>
+ <span class="s2">".."</span><span class="p">,</span>
+ <span class="s2">"BASE"</span><span class="p">))</span>
+ <span class="k">if</span> <span class="n">cfg</span><span class="o">.</span><span class="n">LOCAL</span><span class="o">.</span><span class="n">workdir</span> <span class="o">==</span> <span class="s2">"default"</span><span class="p">:</span>
+ <span class="n">cfg</span><span class="o">.</span><span class="n">LOCAL</span><span class="o">.</span><span class="n">workdir</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">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">salometoolsway</span><span class="p">,</span>
+ <span class="s2">".."</span><span class="p">))</span>
+ <span class="k">if</span> <span class="n">cfg</span><span class="o">.</span><span class="n">LOCAL</span><span class="o">.</span><span class="n">log_dir</span> <span class="o">==</span> <span class="s2">"default"</span><span class="p">:</span>
+ <span class="n">cfg</span><span class="o">.</span><span class="n">LOCAL</span><span class="o">.</span><span class="n">log_dir</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">abspath</span><span class="p">(</span>
+ <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">cfg</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">".."</span><span class="p">,</span>
+ <span class="s2">"LOGS"</span><span class="p">))</span>
+
+ <span class="k">if</span> <span class="n">cfg</span><span class="o">.</span><span class="n">LOCAL</span><span class="o">.</span><span class="n">archive_dir</span> <span class="o">==</span> <span class="s2">"default"</span><span class="p">:</span>
+ <span class="n">cfg</span><span class="o">.</span><span class="n">LOCAL</span><span class="o">.</span><span class="n">archive_dir</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">abspath</span><span class="p">(</span>
+ <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">cfg</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">".."</span><span class="p">,</span>
+ <span class="s2">"ARCHIVES"</span><span class="p">))</span>
+
+ <span class="c1"># apply overwrite from command line if needed</span>
+ <span class="k">for</span> <span class="n">rule</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_command_line_overrides</span><span class="p">(</span><span class="n">options</span><span class="p">,</span> <span class="p">[</span><span class="s2">"LOCAL"</span><span class="p">]):</span>
+ <span class="n">exec</span><span class="p">(</span><span class="s1">'cfg.'</span> <span class="o">+</span> <span class="n">rule</span><span class="p">)</span> <span class="c1"># this cannot be factorized because of the exec</span>
+
+ <span class="c1"># =====================================================================</span>
+ <span class="c1"># Load the PROJECTS</span>
+ <span class="n">projects_cfg</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">projects_cfg</span><span class="o">.</span><span class="n">addMapping</span><span class="p">(</span><span class="s2">"PROJECTS"</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="n">projects_cfg</span><span class="p">),</span>
+ <span class="s2">"The projects</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
+ <span class="n">projects_cfg</span><span class="o">.</span><span class="n">PROJECTS</span><span class="o">.</span><span class="n">addMapping</span><span class="p">(</span><span class="s2">"projects"</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="n">cfg</span><span class="o">.</span><span class="n">PROJECTS</span><span class="p">),</span>
+ <span class="s2">"The projects definition</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
+
+ <span class="k">for</span> <span class="n">project_pyconf_path</span> <span class="ow">in</span> <span class="n">cfg</span><span class="o">.</span><span class="n">PROJECTS</span><span class="o">.</span><span class="n">project_file_paths</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">project_pyconf_path</span><span class="p">):</span>
+ <span class="n">msg</span> <span class="o">=</span> <span class="n">_</span><span class="p">(</span><span class="s2">"Cannot find project file <red></span><span class="si">%s</span><span class="s2"><reset>, Ignored."</span><span class="p">)</span> <span class="o">%</span> <span class="n">project_pyconf_path</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
+ <span class="k">continue</span>
+ <span class="n">project_name</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">basename</span><span class="p">(</span><span class="n">project_pyconf_path</span><span class="p">)[:</span><span class="o">-</span><span class="nb">len</span><span class="p">(</span><span class="s2">".pyconf"</span><span class="p">)]</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="n">project_pyconf_dir</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="n">project_pyconf_path</span><span class="p">)</span>
+ <span class="n">project_cfg</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="nb">open</span><span class="p">(</span><span class="n">project_pyconf_path</span><span class="p">),</span>
+ <span class="n">PWD</span><span class="o">=</span><span class="p">(</span><span class="s2">""</span><span class="p">,</span> <span class="n">project_pyconf_dir</span><span class="p">))</span>
+ <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
+ <span class="n">msg</span> <span class="o">=</span> <span class="n">_</span><span class="p">(</span><span class="s2">"ERROR: Error in configuration file: </span><span class="si">%(file_path)s</span><span class="se">\n</span><span class="s2"> </span><span class="si">%(error)s</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span> <span class="o">%</span> \
+ <span class="p">{</span><span class="s1">'file_path'</span> <span class="p">:</span> <span class="n">project_pyconf_path</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="n">sys</span><span class="o">.</span><span class="n">stdout</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
+ <span class="k">continue</span>
+ <span class="n">projects_cfg</span><span class="o">.</span><span class="n">PROJECTS</span><span class="o">.</span><span class="n">projects</span><span class="o">.</span><span class="n">addMapping</span><span class="p">(</span><span class="n">project_name</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="n">projects_cfg</span><span class="o">.</span><span class="n">PROJECTS</span><span class="o">.</span><span class="n">projects</span><span class="p">),</span>
+ <span class="s2">"The </span><span class="si">%s</span><span class="s2"> project</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span> <span class="n">project_name</span><span class="p">)</span>
+ <span class="n">projects_cfg</span><span class="o">.</span><span class="n">PROJECTS</span><span class="o">.</span><span class="n">projects</span><span class="p">[</span><span class="n">project_name</span><span class="p">]</span><span class="o">=</span><span class="n">project_cfg</span>
+ <span class="n">projects_cfg</span><span class="o">.</span><span class="n">PROJECTS</span><span class="o">.</span><span class="n">projects</span><span class="p">[</span><span class="n">project_name</span><span class="p">][</span><span class="s2">"file_path"</span><span class="p">]</span> <span class="o">=</span> \
+ <span class="n">project_pyconf_path</span>
+
+ <span class="n">merger</span><span class="o">.</span><span class="n">merge</span><span class="p">(</span><span class="n">cfg</span><span class="p">,</span> <span class="n">projects_cfg</span><span class="p">)</span>
+
+ <span class="c1"># apply overwrite from command line if needed</span>
+ <span class="k">for</span> <span class="n">rule</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_command_line_overrides</span><span class="p">(</span><span class="n">options</span><span class="p">,</span> <span class="p">[</span><span class="s2">"PROJECTS"</span><span class="p">]):</span>
+ <span class="n">exec</span><span class="p">(</span><span class="s1">'cfg.'</span> <span class="o">+</span> <span class="n">rule</span><span class="p">)</span> <span class="c1"># this cannot be factorized because of the exec</span>
+
+ <span class="c1"># =====================================================================</span>
+ <span class="c1"># Create the paths where to search the application configurations, </span>
+ <span class="c1"># the product configurations, the products archives, </span>
+ <span class="c1"># the jobs configurations and the machines configurations</span>
+ <span class="n">cfg</span><span class="o">.</span><span class="n">addMapping</span><span class="p">(</span><span class="s2">"PATHS"</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="n">cfg</span><span class="p">),</span> <span class="s2">"The paths</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
+ <span class="n">cfg</span><span class="o">.</span><span class="n">PATHS</span><span class="p">[</span><span class="s2">"APPLICATIONPATH"</span><span class="p">]</span> <span class="o">=</span> <span class="n">PYCONF</span><span class="o">.</span><span class="n">Sequence</span><span class="p">(</span><span class="n">cfg</span><span class="o">.</span><span class="n">PATHS</span><span class="p">)</span>
+ <span class="n">cfg</span><span class="o">.</span><span class="n">PATHS</span><span class="o">.</span><span class="n">APPLICATIONPATH</span><span class="o">.</span><span class="n">append</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">personal_applications_dir</span><span class="p">,</span> <span class="s2">""</span><span class="p">)</span>
+
+ <span class="n">cfg</span><span class="o">.</span><span class="n">PATHS</span><span class="p">[</span><span class="s2">"PRODUCTPATH"</span><span class="p">]</span> <span class="o">=</span> <span class="n">PYCONF</span><span class="o">.</span><span class="n">Sequence</span><span class="p">(</span><span class="n">cfg</span><span class="o">.</span><span class="n">PATHS</span><span class="p">)</span>
+ <span class="n">cfg</span><span class="o">.</span><span class="n">PATHS</span><span class="o">.</span><span class="n">PRODUCTPATH</span><span class="o">.</span><span class="n">append</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">personal_products_dir</span><span class="p">,</span> <span class="s2">""</span><span class="p">)</span>
+ <span class="n">cfg</span><span class="o">.</span><span class="n">PATHS</span><span class="p">[</span><span class="s2">"ARCHIVEPATH"</span><span class="p">]</span> <span class="o">=</span> <span class="n">PYCONF</span><span class="o">.</span><span class="n">Sequence</span><span class="p">(</span><span class="n">cfg</span><span class="o">.</span><span class="n">PATHS</span><span class="p">)</span>
+ <span class="n">cfg</span><span class="o">.</span><span class="n">PATHS</span><span class="o">.</span><span class="n">ARCHIVEPATH</span><span class="o">.</span><span class="n">append</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">personal_archives_dir</span><span class="p">,</span> <span class="s2">""</span><span class="p">)</span>
+ <span class="n">cfg</span><span class="o">.</span><span class="n">PATHS</span><span class="p">[</span><span class="s2">"JOBPATH"</span><span class="p">]</span> <span class="o">=</span> <span class="n">PYCONF</span><span class="o">.</span><span class="n">Sequence</span><span class="p">(</span><span class="n">cfg</span><span class="o">.</span><span class="n">PATHS</span><span class="p">)</span>
+ <span class="n">cfg</span><span class="o">.</span><span class="n">PATHS</span><span class="o">.</span><span class="n">JOBPATH</span><span class="o">.</span><span class="n">append</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">personal_jobs_dir</span><span class="p">,</span> <span class="s2">""</span><span class="p">)</span>
+ <span class="n">cfg</span><span class="o">.</span><span class="n">PATHS</span><span class="p">[</span><span class="s2">"MACHINEPATH"</span><span class="p">]</span> <span class="o">=</span> <span class="n">PYCONF</span><span class="o">.</span><span class="n">Sequence</span><span class="p">(</span><span class="n">cfg</span><span class="o">.</span><span class="n">PATHS</span><span class="p">)</span>
+ <span class="n">cfg</span><span class="o">.</span><span class="n">PATHS</span><span class="o">.</span><span class="n">MACHINEPATH</span><span class="o">.</span><span class="n">append</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">personal_machines_dir</span><span class="p">,</span> <span class="s2">""</span><span class="p">)</span>
+
+ <span class="c1"># initialise the path with local directory</span>
+ <span class="n">cfg</span><span class="o">.</span><span class="n">PATHS</span><span class="p">[</span><span class="s2">"ARCHIVEPATH"</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">cfg</span><span class="o">.</span><span class="n">LOCAL</span><span class="o">.</span><span class="n">archive_dir</span><span class="p">,</span> <span class="s2">""</span><span class="p">)</span>
+
+ <span class="c1"># Loop over the projects in order to complete the PATHS variables</span>
+ <span class="k">for</span> <span class="n">project</span> <span class="ow">in</span> <span class="n">cfg</span><span class="o">.</span><span class="n">PROJECTS</span><span class="o">.</span><span class="n">projects</span><span class="p">:</span>
+ <span class="k">for</span> <span class="n">PATH</span> <span class="ow">in</span> <span class="p">[</span><span class="s2">"APPLICATIONPATH"</span><span class="p">,</span>
+ <span class="s2">"PRODUCTPATH"</span><span class="p">,</span>
+ <span class="s2">"ARCHIVEPATH"</span><span class="p">,</span>
+ <span class="s2">"JOBPATH"</span><span class="p">,</span>
+ <span class="s2">"MACHINEPATH"</span><span class="p">]:</span>
+ <span class="k">if</span> <span class="n">PATH</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">cfg</span><span class="o">.</span><span class="n">PROJECTS</span><span class="o">.</span><span class="n">projects</span><span class="p">[</span><span class="n">project</span><span class="p">]:</span>
+ <span class="k">continue</span>
+ <span class="n">cfg</span><span class="o">.</span><span class="n">PATHS</span><span class="p">[</span><span class="n">PATH</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">cfg</span><span class="o">.</span><span class="n">PROJECTS</span><span class="o">.</span><span class="n">projects</span><span class="p">[</span><span class="n">project</span><span class="p">][</span><span class="n">PATH</span><span class="p">],</span> <span class="s2">""</span><span class="p">)</span>
+
+ <span class="c1"># apply overwrite from command line if needed</span>
+ <span class="k">for</span> <span class="n">rule</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_command_line_overrides</span><span class="p">(</span><span class="n">options</span><span class="p">,</span> <span class="p">[</span><span class="s2">"PATHS"</span><span class="p">]):</span>
+ <span class="n">exec</span><span class="p">(</span><span class="s1">'cfg.'</span> <span class="o">+</span> <span class="n">rule</span><span class="p">)</span> <span class="c1"># this cannot be factorized because of the exec</span>
+
+ <span class="c1"># =====================================================================</span>
+ <span class="c1"># Load APPLICATION config file</span>
+ <span class="k">if</span> <span class="n">application</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
+ <span class="c1"># search APPLICATION file in all directories in configPath</span>
+ <span class="n">cp</span> <span class="o">=</span> <span class="n">cfg</span><span class="o">.</span><span class="n">PATHS</span><span class="o">.</span><span class="n">APPLICATIONPATH</span>
+ <span class="n">PYCONF</span><span class="o">.</span><span class="n">streamOpener</span> <span class="o">=</span> <span class="n">ConfigOpener</span><span class="p">(</span><span class="n">cp</span><span class="p">)</span>
+ <span class="n">do_merge</span> <span class="o">=</span> <span class="kc">True</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="n">application_cfg</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">application</span> <span class="o">+</span> <span class="s1">'.pyconf'</span><span class="p">)</span>
+ <span class="k">except</span> <span class="ne">IOError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
+ <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s2">"</span><span class="si">%s</span><span class="se">\n</span><span class="s2">(use 'config --list' to get the"</span>
+ <span class="s2">" list of available applications)"</span><span class="p">)</span> <span class="o">%</span> <span class="n">e</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">if</span> <span class="p">(</span><span class="ow">not</span> <span class="p">(</span><span class="s1">'-e'</span> <span class="ow">in</span> <span class="n">parser</span><span class="o">.</span><span class="n">parse_args</span><span class="p">()[</span><span class="mi">1</span><span class="p">])</span>
+ <span class="ow">or</span> <span class="p">(</span><span class="s1">'--edit'</span> <span class="ow">in</span> <span class="n">parser</span><span class="o">.</span><span class="n">parse_args</span><span class="p">()[</span><span class="mi">1</span><span class="p">])</span>
+ <span class="ow">and</span> <span class="n">command</span> <span class="o">==</span> <span class="s1">'config'</span><span class="p">):</span>
+ <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span>
+ <span class="n">_</span><span class="p">(</span><span class="s2">"Error in configuration file: (1)s.pyconf</span><span class="se">\n</span><span class="s2"> </span><span class="si">%(2)s</span><span class="s2">"</span><span class="p">)</span> <span class="o">%</span> \
+ <span class="p">{</span> <span class="s1">'application'</span><span class="p">:</span> <span class="n">application</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="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">sys</span><span class="o">.</span><span class="n">stdout</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">UTS</span><span class="o">.</span><span class="n">red</span><span class="p">(</span>
+ <span class="s2">"There is an error in the file </span><span class="si">%s</span><span class="s2">.pyconf.</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span> \
+ <span class="n">cfg</span><span class="o">.</span><span class="n">VARS</span><span class="o">.</span><span class="n">application</span><span class="p">))</span>
+ <span class="n">do_merge</span> <span class="o">=</span> <span class="kc">False</span>
+ <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
+ <span class="k">if</span> <span class="p">(</span> <span class="ow">not</span><span class="p">(</span><span class="s1">'-e'</span> <span class="ow">in</span> <span class="n">parser</span><span class="o">.</span><span class="n">parse_args</span><span class="p">()[</span><span class="mi">1</span><span class="p">])</span> <span class="ow">or</span>
+ <span class="p">(</span><span class="s1">'--edit'</span> <span class="ow">in</span> <span class="n">parser</span><span class="o">.</span><span class="n">parse_args</span><span class="p">()[</span><span class="mi">1</span><span class="p">])</span> <span class="ow">and</span>
+ <span class="n">command</span> <span class="o">==</span> <span class="s1">'config'</span> <span class="p">):</span>
+ <span class="n">sys</span><span class="o">.</span><span class="n">stdout</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">UTS</span><span class="o">.</span><span class="n">red</span><span class="p">(</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="nb">str</span><span class="p">(</span><span class="n">e</span><span class="p">)))</span>
+ <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span>
+ <span class="n">_</span><span class="p">(</span><span class="s2">"Error in configuration file: </span><span class="si">%s</span><span class="s2">.pyconf</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span> <span class="o">%</span> <span class="n">application</span> <span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">sys</span><span class="o">.</span><span class="n">stdout</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">UTS</span><span class="o">.</span><span class="n">red</span><span class="p">(</span>
+ <span class="s2">"ERROR: in file </span><span class="si">%s</span><span class="s2">.pyconf. Opening the file with the default viewer</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span> \
+ <span class="n">cfg</span><span class="o">.</span><span class="n">VARS</span><span class="o">.</span><span class="n">application</span><span class="p">))</span>
+ <span class="n">sys</span><span class="o">.</span><span class="n">stdout</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">"</span><span class="se">\n</span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span> <span class="n">UTS</span><span class="o">.</span><span class="n">red</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="n">do_merge</span> <span class="o">=</span> <span class="kc">False</span>
+
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">cfg</span><span class="p">[</span><span class="s1">'open_application'</span><span class="p">]</span> <span class="o">=</span> <span class="s1">'yes'</span>
+
+ <span class="c1"># =====================================================================</span>
+ <span class="c1"># Load product config files in PRODUCTS section</span>
+ <span class="n">products_cfg</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">products_cfg</span><span class="o">.</span><span class="n">addMapping</span><span class="p">(</span><span class="s2">"PRODUCTS"</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="n">products_cfg</span><span class="p">),</span>
+ <span class="s2">"The products</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">application</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
+ <span class="n">PYCONF</span><span class="o">.</span><span class="n">streamOpener</span> <span class="o">=</span> <span class="n">ConfigOpener</span><span class="p">(</span><span class="n">cfg</span><span class="o">.</span><span class="n">PATHS</span><span class="o">.</span><span class="n">PRODUCTPATH</span><span class="p">)</span>
+ <span class="k">for</span> <span class="n">product_name</span> <span class="ow">in</span> <span class="n">application_cfg</span><span class="o">.</span><span class="n">APPLICATION</span><span class="o">.</span><span class="n">products</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
+ <span class="c1"># Loop on all files that are in softsDir directory</span>
+ <span class="c1"># and read their config</span>
+ <span class="n">product_file_name</span> <span class="o">=</span> <span class="n">product_name</span> <span class="o">+</span> <span class="s2">".pyconf"</span>
+ <span class="n">product_file_path</span> <span class="o">=</span> <span class="n">UTS</span><span class="o">.</span><span class="n">find_file_in_lpath</span><span class="p">(</span><span class="n">product_file_name</span><span class="p">,</span> <span class="n">cfg</span><span class="o">.</span><span class="n">PATHS</span><span class="o">.</span><span class="n">PRODUCTPATH</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">product_file_path</span><span class="p">:</span>
+ <span class="n">products_dir</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="n">product_file_path</span><span class="p">)</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="n">prod_cfg</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="nb">open</span><span class="p">(</span><span class="n">product_file_path</span><span class="p">),</span>
+ <span class="n">PWD</span><span class="o">=</span><span class="p">(</span><span class="s2">""</span><span class="p">,</span> <span class="n">products_dir</span><span class="p">))</span>
+ <span class="n">prod_cfg</span><span class="o">.</span><span class="n">from_file</span> <span class="o">=</span> <span class="n">product_file_path</span>
+ <span class="n">products_cfg</span><span class="o">.</span><span class="n">PRODUCTS</span><span class="p">[</span><span class="n">product_name</span><span class="p">]</span> <span class="o">=</span> <span class="n">prod_cfg</span>
+ <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
+ <span class="n">msg</span> <span class="o">=</span> <span class="n">_</span><span class="p">(</span>
+ <span class="s2">"WARNING: Error in configuration file: </span><span class="si">%(prod)s</span><span class="se">\n</span><span class="s2"> </span><span class="si">%(error)s</span><span class="s2">"</span> <span class="o">%</span> \
+ <span class="p">{</span><span class="s1">'prod'</span> <span class="p">:</span> <span class="n">product_name</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="n">sys</span><span class="o">.</span><span class="n">stdout</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
+
+ <span class="n">merger</span><span class="o">.</span><span class="n">merge</span><span class="p">(</span><span class="n">cfg</span><span class="p">,</span> <span class="n">products_cfg</span><span class="p">)</span>
+
+ <span class="c1"># apply overwrite from command line if needed</span>
+ <span class="k">for</span> <span class="n">rule</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_command_line_overrides</span><span class="p">(</span><span class="n">options</span><span class="p">,</span> <span class="p">[</span><span class="s2">"PRODUCTS"</span><span class="p">]):</span>
+ <span class="n">exec</span><span class="p">(</span><span class="s1">'cfg.'</span> <span class="o">+</span> <span class="n">rule</span><span class="p">)</span> <span class="c1"># this cannot be factorized because of the exec</span>
+
+ <span class="k">if</span> <span class="n">do_merge</span><span class="p">:</span>
+ <span class="n">merger</span><span class="o">.</span><span class="n">merge</span><span class="p">(</span><span class="n">cfg</span><span class="p">,</span> <span class="n">application_cfg</span><span class="p">)</span>
+
+ <span class="c1"># default launcher name ('salome')</span>
+ <span class="k">if</span> <span class="p">(</span><span class="s1">'profile'</span> <span class="ow">in</span> <span class="n">cfg</span><span class="o">.</span><span class="n">APPLICATION</span> <span class="ow">and</span>
+ <span class="s1">'launcher_name'</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">cfg</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">cfg</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="o">=</span> <span class="s1">'salome'</span>
+
+ <span class="c1"># apply overwrite from command line if needed</span>
+ <span class="k">for</span> <span class="n">rule</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_command_line_overrides</span><span class="p">(</span><span class="n">options</span><span class="p">,</span>
+ <span class="p">[</span><span class="s2">"APPLICATION"</span><span class="p">]):</span>
+ <span class="c1"># this cannot be factorized because of the exec</span>
+ <span class="n">exec</span><span class="p">(</span><span class="s1">'cfg.'</span> <span class="o">+</span> <span class="n">rule</span><span class="p">)</span>
+
+ <span class="c1"># =====================================================================</span>
+ <span class="c1"># load USER config</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">set_user_config_file</span><span class="p">(</span><span class="n">cfg</span><span class="p">)</span>
+ <span class="n">user_cfg_file</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_user_config_file</span><span class="p">()</span>
+ <span class="n">user_cfg</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="nb">open</span><span class="p">(</span><span class="n">user_cfg_file</span><span class="p">))</span>
+ <span class="n">merger</span><span class="o">.</span><span class="n">merge</span><span class="p">(</span><span class="n">cfg</span><span class="p">,</span> <span class="n">user_cfg</span><span class="p">)</span>
+
+ <span class="c1"># apply overwrite from command line if needed</span>
+ <span class="k">for</span> <span class="n">rule</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_command_line_overrides</span><span class="p">(</span><span class="n">options</span><span class="p">,</span> <span class="p">[</span><span class="s2">"USER"</span><span class="p">]):</span>
+ <span class="n">exec</span><span class="p">(</span><span class="s1">'cfg.'</span> <span class="o">+</span> <span class="n">rule</span><span class="p">)</span> <span class="c1"># this cannot be factorize because of the exec</span>
+
+ <span class="k">return</span> <span class="n">cfg</span></div>
+
+<div class="viewcode-block" id="ConfigManager.set_user_config_file"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.configManager.ConfigManager.set_user_config_file">[docs]</a> <span class="k">def</span> <span class="nf">set_user_config_file</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">config</span><span class="p">):</span>
+ <span class="sd">'''Set the user config file name and path.</span>
+<span class="sd"> If necessary, build it from another one or create it from scratch.</span>
+<span class="sd"> </span>
+<span class="sd"> :param config class 'PYCONF.Config': The global config </span>
+<span class="sd"> (containing all pyconf).</span>
+<span class="sd"> '''</span>
+ <span class="c1"># get the expected name and path of the file</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">config_file_name</span> <span class="o">=</span> <span class="s1">'SAT.pyconf'</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">user_config_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">personalDir</span><span class="p">,</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">config_file_name</span><span class="p">)</span>
+
+ <span class="c1"># if pyconf does not exist, create it from scratch</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="bp">self</span><span class="o">.</span><span class="n">user_config_file_path</span><span class="p">):</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">create_config_file</span><span class="p">(</span><span class="n">config</span><span class="p">)</span></div>
+
+<div class="viewcode-block" id="ConfigManager.create_config_file"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.configManager.ConfigManager.create_config_file">[docs]</a> <span class="k">def</span> <span class="nf">create_config_file</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">config</span><span class="p">):</span>
+ <span class="sd">'''This method is called when there are no user config file. </span>
+<span class="sd"> It build it from scratch.</span>
+<span class="sd"> </span>
+<span class="sd"> :param config class 'PYCONF.Config': The global config.</span>
+<span class="sd"> :return: the config corresponding to the file created.</span>
+<span class="sd"> :rtype: config class 'PYCONF.Config'</span>
+<span class="sd"> '''</span>
+
+ <span class="n">cfg_name</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_user_config_file</span><span class="p">()</span>
+
+ <span class="n">user_cfg</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="c1">#</span>
+ <span class="n">user_cfg</span><span class="o">.</span><span class="n">addMapping</span><span class="p">(</span><span class="s1">'USER'</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="n">user_cfg</span><span class="p">),</span> <span class="s2">""</span><span class="p">)</span>
+
+ <span class="n">user_cfg</span><span class="o">.</span><span class="n">USER</span><span class="o">.</span><span class="n">addMapping</span><span class="p">(</span><span class="s1">'cvs_user'</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">user</span><span class="p">,</span>
+ <span class="s2">"This is the user name used to access salome cvs base.</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
+ <span class="n">user_cfg</span><span class="o">.</span><span class="n">USER</span><span class="o">.</span><span class="n">addMapping</span><span class="p">(</span><span class="s1">'svn_user'</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">user</span><span class="p">,</span>
+ <span class="s2">"This is the user name used to access salome svn base.</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
+ <span class="n">user_cfg</span><span class="o">.</span><span class="n">USER</span><span class="o">.</span><span class="n">addMapping</span><span class="p">(</span><span class="s1">'output_verbose_level'</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span>
+ <span class="s2">"This is the default output_verbose_level you want."</span>
+ <span class="s2">" 0=>no output, 5=>debug.</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
+ <span class="n">user_cfg</span><span class="o">.</span><span class="n">USER</span><span class="o">.</span><span class="n">addMapping</span><span class="p">(</span><span class="s1">'publish_dir'</span><span class="p">,</span>
+ <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">expanduser</span><span class="p">(</span><span class="s1">'~'</span><span class="p">),</span>
+ <span class="s1">'websupport'</span><span class="p">,</span>
+ <span class="s1">'satreport'</span><span class="p">),</span>
+ <span class="s2">""</span><span class="p">)</span>
+ <span class="n">user_cfg</span><span class="o">.</span><span class="n">USER</span><span class="o">.</span><span class="n">addMapping</span><span class="p">(</span><span class="s1">'editor'</span><span class="p">,</span>
+ <span class="s1">'vi'</span><span class="p">,</span>
+ <span class="s2">"This is the editor used to "</span>
+ <span class="s2">"modify configuration files</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
+ <span class="n">user_cfg</span><span class="o">.</span><span class="n">USER</span><span class="o">.</span><span class="n">addMapping</span><span class="p">(</span><span class="s1">'browser'</span><span class="p">,</span>
+ <span class="s1">'firefox'</span><span class="p">,</span>
+ <span class="s2">"This is the browser used to "</span>
+ <span class="s2">"read html documentation</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
+ <span class="n">user_cfg</span><span class="o">.</span><span class="n">USER</span><span class="o">.</span><span class="n">addMapping</span><span class="p">(</span><span class="s1">'pdf_viewer'</span><span class="p">,</span>
+ <span class="s1">'evince'</span><span class="p">,</span>
+ <span class="s2">"This is the pdf_viewer used "</span>
+ <span class="s2">"to read pdf documentation</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
+<span class="c1"># CNC 25/10/17 : plus nécessaire a priori</span>
+<span class="c1"># user_cfg.USER.addMapping("base",</span>
+<span class="c1"># PYCONF.Reference(</span>
+<span class="c1"># user_cfg,</span>
+<span class="c1"># PYCONF.DOLLAR,</span>
+<span class="c1"># 'workdir + $VARS.sep + "BASE"'),</span>
+<span class="c1"># "The products installation base (could be "</span>
+<span class="c1"># "ignored if this key exists in the local.pyconf"</span>
+<span class="c1"># " file of salomTools).\n")</span>
+
+ <span class="c1"># </span>
+ <span class="n">UTS</span><span class="o">.</span><span class="n">ensure_path_exists</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">personalDir</span><span class="p">)</span>
+ <span class="n">UTS</span><span class="o">.</span><span class="n">ensure_path_exists</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">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">personalDir</span><span class="p">,</span>
+ <span class="s1">'Applications'</span><span class="p">))</span>
+
+ <span class="n">f</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="n">cfg_name</span><span class="p">,</span> <span class="s1">'w'</span><span class="p">)</span>
+ <span class="n">user_cfg</span><span class="o">.</span><span class="n">__save__</span><span class="p">(</span><span class="n">f</span><span class="p">)</span>
+ <span class="n">f</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
+
+ <span class="k">return</span> <span class="n">user_cfg</span> </div>
+
+<div class="viewcode-block" id="ConfigManager.get_user_config_file"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.configManager.ConfigManager.get_user_config_file">[docs]</a> <span class="k">def</span> <span class="nf">get_user_config_file</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="sd">'''Get the user config file</span>
+<span class="sd"> :return: path to the user config file.</span>
+<span class="sd"> :rtype: str</span>
+<span class="sd"> '''</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">user_config_file_path</span><span class="p">:</span>
+ <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span>
+ <span class="n">_</span><span class="p">(</span><span class="s2">"Error in get_user_config_file: missing user config file path"</span><span class="p">)</span> <span class="p">)</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">user_config_file_path</span> </div></div>
+
+<div class="viewcode-block" id="check_path"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.configManager.check_path">[docs]</a><span class="k">def</span> <span class="nf">check_path</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">ext</span><span class="o">=</span><span class="p">[]):</span>
+ <span class="sd">'''Construct a text with the input path and "not found" if it does not</span>
+<span class="sd"> exist.</span>
+<span class="sd"> </span>
+<span class="sd"> :param path Str: the path to check.</span>
+<span class="sd"> :param ext List: An extension. Verify that the path extension </span>
+<span class="sd"> is in the list</span>
+<span class="sd"> :return: The string of the path with information</span>
+<span class="sd"> :rtype: Str</span>
+<span class="sd"> '''</span>
+ <span class="c1"># check if file exists</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">path</span><span class="p">):</span>
+ <span class="k">return</span> <span class="s2">"path '</span><span class="si">%s</span><span class="s2">' ** not found"</span> <span class="o">%</span> <span class="n">path</span>
+
+ <span class="c1"># check extension</span>
+ <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">ext</span><span class="p">)</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span>
+ <span class="n">fe</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">splitext</span><span class="p">(</span><span class="n">path</span><span class="p">)[</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span>
+ <span class="k">if</span> <span class="n">fe</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">ext</span><span class="p">:</span>
+ <span class="k">return</span> <span class="s2">"path '</span><span class="si">%s</span><span class="s2">' ** bad extension"</span> <span class="o">%</span> <span class="n">path</span>
+
+ <span class="k">return</span> <span class="n">path</span></div>
+
+<div class="viewcode-block" id="show_product_info"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.configManager.show_product_info">[docs]</a><span class="k">def</span> <span class="nf">show_product_info</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">logger</span><span class="p">):</span>
+ <span class="sd">'''Display on the terminal and logger information about a product.</span>
+<span class="sd"> </span>
+<span class="sd"> :param config Config: the global configuration.</span>
+<span class="sd"> :param name Str: The name of the product</span>
+<span class="sd"> :param logger Logger: The logger instance to use for the display</span>
+<span class="sd"> '''</span>
+
+ <span class="k">def</span> <span class="nf">msgAdd</span><span class="p">(</span><span class="n">label</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> local short named macro for convenience</span>
+<span class="sd"> appending show_product_info.msg variable</span>
+<span class="sd"> """</span>
+ <span class="n">msg</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="se">\n</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">label</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
+ <span class="k">return</span>
+
+ <span class="n">msg</span> <span class="o">=</span> <span class="s2">""</span> <span class="c1"># used msgAdd()</span>
+ <span class="n">msg</span> <span class="o">+=</span> <span class="n">_</span><span class="p">(</span><span class="s2">"</span><span class="si">%s</span><span class="s2"> is a product</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span> <span class="o">%</span> <span class="n">UTS</span><span class="o">.</span><span class="n">blue</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
+ <span class="n">pinfo</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">product</span><span class="o">.</span><span class="n">get_product_config</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span>
+
+ <span class="k">if</span> <span class="s2">"depend"</span> <span class="ow">in</span> <span class="n">pinfo</span><span class="p">:</span>
+ <span class="n">msgAdd</span><span class="p">(</span><span class="s2">"depends on"</span><span class="p">,</span> <span class="s1">', '</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">pinfo</span><span class="o">.</span><span class="n">depend</span><span class="p">))</span>
+
+ <span class="k">if</span> <span class="s2">"opt_depend"</span> <span class="ow">in</span> <span class="n">pinfo</span><span class="p">:</span>
+ <span class="n">msgAdd</span><span class="p">(</span><span class="s2">"optional"</span><span class="p">,</span> <span class="s1">', '</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">pinfo</span><span class="o">.</span><span class="n">opt_depend</span><span class="p">))</span>
+
+ <span class="c1"># information on pyconf</span>
+ <span class="n">msg</span> <span class="o">+=</span> <span class="n">UTS</span><span class="o">.</span><span class="n">label</span><span class="p">(</span><span class="s2">"configuration:</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
+ <span class="k">if</span> <span class="s2">"from_file"</span> <span class="ow">in</span> <span class="n">pinfo</span><span class="p">:</span>
+ <span class="n">msgAdd</span><span class="p">(</span><span class="s2">"pyconf file path"</span><span class="p">,</span> <span class="n">pinfo</span><span class="o">.</span><span class="n">from_file</span><span class="p">)</span>
+ <span class="k">if</span> <span class="s2">"section"</span> <span class="ow">in</span> <span class="n">pinfo</span><span class="p">:</span>
+ <span class="n">msgAdd</span><span class="p">(</span><span class="s2">"section"</span><span class="p">,</span> <span class="n">pinfo</span><span class="o">.</span><span class="n">section</span><span class="p">)</span>
+
+ <span class="c1"># information on prepare</span>
+ <span class="n">msg</span> <span class="o">+=</span> <span class="n">UTS</span><span class="o">.</span><span class="n">label</span><span class="p">(</span><span class="s2">"prepare:</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
+
+ <span class="n">is_dev</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">product</span><span class="o">.</span><span class="n">product_is_dev</span><span class="p">(</span><span class="n">pinfo</span><span class="p">)</span>
+ <span class="n">method</span> <span class="o">=</span> <span class="n">pinfo</span><span class="o">.</span><span class="n">get_source</span>
+ <span class="k">if</span> <span class="n">is_dev</span><span class="p">:</span>
+ <span class="n">method</span> <span class="o">+=</span> <span class="s2">" (dev)"</span>
+ <span class="n">msgAdd</span><span class="p">(</span><span class="s2">"get method"</span><span class="p">,</span> <span class="n">method</span><span class="p">)</span>
+
+ <span class="k">if</span> <span class="n">method</span> <span class="o">==</span> <span class="s1">'cvs'</span><span class="p">:</span>
+ <span class="n">msgAdd</span><span class="p">(</span><span class="s2">"server"</span><span class="p">,</span> <span class="n">pinfo</span><span class="o">.</span><span class="n">cvs_info</span><span class="o">.</span><span class="n">server</span><span class="p">)</span>
+ <span class="n">msgAdd</span><span class="p">(</span><span class="s2">"base module"</span><span class="p">,</span> <span class="n">pinfo</span><span class="o">.</span><span class="n">cvs_info</span><span class="o">.</span><span class="n">module_base</span><span class="p">)</span>
+ <span class="n">msgAdd</span><span class="p">(</span><span class="s2">"source"</span><span class="p">,</span> <span class="n">pinfo</span><span class="o">.</span><span class="n">cvs_info</span><span class="o">.</span><span class="n">source</span><span class="p">)</span>
+ <span class="n">msgAdd</span><span class="p">(</span><span class="s2">"tag"</span><span class="p">,</span> <span class="n">pinfo</span><span class="o">.</span><span class="n">cvs_info</span><span class="o">.</span><span class="n">tag</span><span class="p">)</span>
+
+ <span class="k">elif</span> <span class="n">method</span> <span class="o">==</span> <span class="s1">'svn'</span><span class="p">:</span>
+ <span class="n">msgAdd</span><span class="p">(</span><span class="s2">"repo"</span><span class="p">,</span> <span class="n">pinfo</span><span class="o">.</span><span class="n">svn_info</span><span class="o">.</span><span class="n">repo</span><span class="p">)</span>
+
+ <span class="k">elif</span> <span class="n">method</span> <span class="o">==</span> <span class="s1">'git'</span><span class="p">:</span>
+ <span class="n">msgAdd</span><span class="p">(</span><span class="s2">"repo"</span><span class="p">,</span> <span class="n">pinfo</span><span class="o">.</span><span class="n">git_info</span><span class="o">.</span><span class="n">repo</span><span class="p">)</span>
+ <span class="n">msgAdd</span><span class="p">(</span><span class="s2">"tag"</span><span class="p">,</span> <span class="n">pinfo</span><span class="o">.</span><span class="n">git_info</span><span class="o">.</span><span class="n">tag</span><span class="p">)</span>
+
+ <span class="k">elif</span> <span class="n">method</span> <span class="o">==</span> <span class="s1">'archive'</span><span class="p">:</span>
+ <span class="n">msgAdd</span><span class="p">(</span><span class="s2">"get from"</span><span class="p">,</span> <span class="n">check_path</span><span class="p">(</span><span class="n">pinfo</span><span class="o">.</span><span class="n">archive_info</span><span class="o">.</span><span class="n">archive_name</span><span class="p">))</span>
+
+ <span class="k">if</span> <span class="s1">'patches'</span> <span class="ow">in</span> <span class="n">pinfo</span><span class="p">:</span>
+ <span class="k">for</span> <span class="n">patch</span> <span class="ow">in</span> <span class="n">pinfo</span><span class="o">.</span><span class="n">patches</span><span class="p">:</span>
+ <span class="n">msgAdd</span><span class="p">(</span><span class="s2">"patch"</span><span class="p">,</span> <span class="n">check_path</span><span class="p">(</span><span class="n">patch</span><span class="p">))</span>
+
+ <span class="k">if</span> <span class="n">src</span><span class="o">.</span><span class="n">product</span><span class="o">.</span><span class="n">product_is_fixed</span><span class="p">(</span><span class="n">pinfo</span><span class="p">):</span>
+ <span class="n">msgAdd</span><span class="p">(</span><span class="s2">"install_dir"</span><span class="p">,</span> <span class="n">check_path</span><span class="p">(</span><span class="n">pinfo</span><span class="o">.</span><span class="n">install_dir</span><span class="p">))</span>
+
+ <span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span> <span class="c1"># return possible</span>
+ <span class="k">if</span> <span class="n">src</span><span class="o">.</span><span class="n">product</span><span class="o">.</span><span class="n">product_is_native</span><span class="p">(</span><span class="n">pinfo</span><span class="p">)</span> <span class="ow">or</span> <span class="n">src</span><span class="o">.</span><span class="n">product</span><span class="o">.</span><span class="n">product_is_fixed</span><span class="p">(</span><span class="n">pinfo</span><span class="p">):</span>
+ <span class="k">return</span>
+
+ <span class="c1"># information on compilation</span>
+ <span class="n">msg</span> <span class="o">=</span> <span class="s2">"</span><span class="se">\n\n</span><span class="s2">"</span>
+ <span class="k">if</span> <span class="n">src</span><span class="o">.</span><span class="n">product</span><span class="o">.</span><span class="n">product_compiles</span><span class="p">(</span><span class="n">pinfo</span><span class="p">):</span>
+ <span class="n">msg</span> <span class="o">+=</span> <span class="s2">"compile:</span><span class="se">\n</span><span class="s2">"</span>
+ <span class="n">msgAdd</span><span class="p">(</span><span class="s2">"compilation method"</span><span class="p">,</span> <span class="n">pinfo</span><span class="o">.</span><span class="n">build_source</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">pinfo</span><span class="o">.</span><span class="n">build_source</span> <span class="o">==</span> <span class="s2">"script"</span> <span class="ow">and</span> <span class="s2">"compil_script"</span> <span class="ow">in</span> <span class="n">pinfo</span><span class="p">:</span>
+ <span class="n">msgAdd</span><span class="p">(</span><span class="s2">"Compilation script"</span><span class="p">,</span> <span class="n">pinfo</span><span class="o">.</span><span class="n">compil_script</span><span class="p">)</span>
+ <span class="k">if</span> <span class="s1">'nb_proc'</span> <span class="ow">in</span> <span class="n">pinfo</span><span class="p">:</span>
+ <span class="n">msgAdd</span><span class="p">(</span><span class="s2">"make -j"</span><span class="p">,</span> <span class="n">pinfo</span><span class="o">.</span><span class="n">nb_proc</span><span class="p">)</span>
+ <span class="n">msgAdd</span><span class="p">(</span><span class="s2">"source dir"</span><span class="p">,</span> <span class="n">check_path</span><span class="p">(</span><span class="n">pinfo</span><span class="o">.</span><span class="n">source_dir</span><span class="p">))</span>
+ <span class="k">if</span> <span class="s1">'install_dir'</span> <span class="ow">in</span> <span class="n">pinfo</span><span class="p">:</span>
+ <span class="n">msgAdd</span><span class="p">(</span><span class="s2">"build dir"</span><span class="p">,</span> <span class="n">check_path</span><span class="p">(</span><span class="n">pinfo</span><span class="o">.</span><span class="n">build_dir</span><span class="p">))</span>
+ <span class="n">msgAdd</span><span class="p">(</span><span class="s2">"install dir"</span><span class="p">,</span> <span class="n">check_path</span><span class="p">(</span><span class="n">pinfo</span><span class="o">.</span><span class="n">install_dir</span><span class="p">))</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">msg</span> <span class="o">+=</span> <span class="s2">" </span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span> <span class="n">UTS</span><span class="o">.</span><span class="n">red</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s2">"no install dir"</span><span class="p">))</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">msg</span> <span class="o">+=</span> <span class="s2">"</span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span> <span class="n">UTS</span><span class="o">.</span><span class="n">red</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s2">"This product does not compile"</span><span class="p">))</span>
+
+ <span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
+
+ <span class="c1"># information on environment</span>
+ <span class="n">msg</span> <span class="o">=</span> <span class="n">UTS</span><span class="o">.</span><span class="n">label</span><span class="p">(</span><span class="s2">"</span><span class="se">\n</span><span class="s2">environ:</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
+ <span class="k">if</span> <span class="s2">"environ"</span> <span class="ow">in</span> <span class="n">pinfo</span> <span class="ow">and</span> <span class="s2">"env_script"</span> <span class="ow">in</span> <span class="n">pinfo</span><span class="o">.</span><span class="n">environ</span><span class="p">:</span>
+ <span class="n">msgAdd</span><span class="p">(</span><span class="s2">"script"</span><span class="p">,</span> <span class="n">check_path</span><span class="p">(</span><span class="n">pinfo</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">env_script</span><span class="p">))</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
+
+ <span class="n">zz</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">environment</span><span class="o">.</span><span class="n">SalomeEnviron</span><span class="p">(</span>
+ <span class="n">config</span><span class="p">,</span> <span class="n">src</span><span class="o">.</span><span class="n">fileEnviron</span><span class="o">.</span><span class="n">ScreenEnviron</span><span class="p">(</span><span class="n">logger</span><span class="p">),</span> <span class="kc">False</span><span class="p">)</span>
+ <span class="n">zz</span><span class="o">.</span><span class="n">set_python_libdirs</span><span class="p">()</span>
+
+ <span class="n">zz</span><span class="o">.</span><span class="n">set_a_product</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">logger</span><span class="p">)</span>
+ <span class="k">return</span></div>
+
+<div class="viewcode-block" id="show_patchs"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.configManager.show_patchs">[docs]</a><span class="k">def</span> <span class="nf">show_patchs</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">logger</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Prints all the used patchs in the application.</span>
+<span class="sd"> </span>
+<span class="sd"> :param config Config: the global configuration.</span>
+<span class="sd"> :param logger Logger: The logger instance to use for the display</span>
+<span class="sd"> """</span>
+ <span class="n">len_max</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">p</span><span class="p">)</span> <span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="n">config</span><span class="o">.</span><span class="n">APPLICATION</span><span class="o">.</span><span class="n">products</span><span class="p">])</span> <span class="o">+</span> <span class="mi">2</span>
+ <span class="n">msg</span> <span class="o">=</span> <span class="s2">""</span>
+ <span class="k">for</span> <span class="n">product</span> <span class="ow">in</span> <span class="n">config</span><span class="o">.</span><span class="n">APPLICATION</span><span class="o">.</span><span class="n">products</span><span class="p">:</span>
+ <span class="n">nb</span> <span class="o">=</span> <span class="n">len_max</span><span class="o">-</span><span class="nb">len</span><span class="p">(</span><span class="n">product</span><span class="p">)</span><span class="o">-</span><span class="mi">2</span>
+ <span class="n">product_info</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">product</span><span class="o">.</span><span class="n">get_product_config</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">product</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">src</span><span class="o">.</span><span class="n">product</span><span class="o">.</span><span class="n">product_has_patches</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
+ <span class="n">msg</span> <span class="o">+=</span> <span class="s2">"<header></span><span class="si">%s</span><span class="s2">: <reset>"</span> <span class="o">%</span> <span class="n">product</span>
+ <span class="n">msg</span> <span class="o">+=</span> <span class="s2">" "</span><span class="o">*</span><span class="n">nb</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="n">product_info</span><span class="o">.</span><span class="n">patches</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
+ <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">product_info</span><span class="o">.</span><span class="n">patches</span><span class="p">)</span> <span class="o">></span> <span class="mi">1</span><span class="p">:</span>
+ <span class="k">for</span> <span class="n">patch</span> <span class="ow">in</span> <span class="n">product_info</span><span class="o">.</span><span class="n">patches</span><span class="p">[</span><span class="mi">1</span><span class="p">:]:</span>
+ <span class="n">msg</span> <span class="o">+=</span> <span class="s2">" "</span><span class="o">*</span><span class="n">nb</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="n">patch</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="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
+ <span class="k">return</span></div>
+
+<div class="viewcode-block" id="getConfigColored"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.configManager.getConfigColored">[docs]</a><span class="k">def</span> <span class="nf">getConfigColored</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">stream</span><span class="p">,</span> <span class="n">show_label</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">level</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">show_full_path</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Get a colored representation value from a config pyconf instance.</span>
+<span class="sd"> used recursively from the initial path.</span>
+<span class="sd"> </span>
+<span class="sd"> :param config class 'PYCONF.Config': The configuration from which the value is displayed.</span>
+<span class="sd"> :param path str: the path in the configuration of the value to print.</span>
+<span class="sd"> :param show_label boolean: if True, do a basic display. (useful for bash completion)</span>
+<span class="sd"> :param stream: the output stream used</span>
+<span class="sd"> :param level int: The number of spaces to add before display.</span>
+<span class="sd"> :param show_full_path: display full path, else relative</span>
+<span class="sd"> """</span>
+
+ <span class="c1"># Make sure that the path does not ends with a point</span>
+ <span class="k">if</span> <span class="n">path</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s1">'.'</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="o">-</span><span class="mi">1</span><span class="p">]</span>
+
+ <span class="c1"># display all the path or not</span>
+ <span class="k">if</span> <span class="n">show_full_path</span><span class="p">:</span>
+ <span class="n">vname</span> <span class="o">=</span> <span class="n">path</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">vname</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">'.'</span><span class="p">)[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
+
+ <span class="c1"># number of spaces before the display</span>
+ <span class="n">tab_level</span> <span class="o">=</span> <span class="s2">" "</span> <span class="o">*</span> <span class="n">level</span>
+
+ <span class="c1"># call to the function that gets the value of the path.</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="n">val</span> <span class="o">=</span> <span class="n">config</span><span class="o">.</span><span class="n">getByPath</span><span class="p">(</span><span class="n">path</span><span class="p">)</span>
+ <span class="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">stream</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">tab_level</span> <span class="o">+</span> <span class="s2">"<header></span><span class="si">%s</span><span class="s2">: <red>ERROR </span><span class="si">%s</span><span class="s2"><reset></span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">vname</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="k">return</span>
+
+ <span class="c1"># in this case, display only the value</span>
+ <span class="k">if</span> <span class="n">show_label</span><span class="p">:</span>
+ <span class="n">stream</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">tab_level</span> <span class="o">+</span> <span class="s2">"<header></span><span class="si">%s</span><span class="s2">: <reset>"</span> <span class="o">%</span> <span class="n">vname</span><span class="p">)</span>
+
+ <span class="c1"># The case where the value has under values, </span>
+ <span class="c1"># do a recursive call to the function</span>
+ <span class="k">if</span> <span class="nb">dir</span><span class="p">(</span><span class="n">val</span><span class="p">)</span><span class="o">.</span><span class="fm">__contains__</span><span class="p">(</span><span class="s1">'keys'</span><span class="p">):</span>
+ <span class="k">if</span> <span class="n">show_label</span><span class="p">:</span> <span class="n">stream</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
+ <span class="k">for</span> <span class="n">v</span> <span class="ow">in</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">val</span><span class="o">.</span><span class="n">keys</span><span class="p">()):</span>
+ <span class="n">getConfigColored</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">path</span> <span class="o">+</span> <span class="s1">'.'</span> <span class="o">+</span> <span class="n">v</span><span class="p">,</span> <span class="n">stream</span><span class="p">,</span> <span class="n">show_label</span><span class="p">,</span> <span class="n">level</span> <span class="o">+</span> <span class="mi">1</span><span class="p">)</span>
+ <span class="k">elif</span> <span class="n">val</span><span class="o">.</span><span class="vm">__class__</span> <span class="o">==</span> <span class="n">PYCONF</span><span class="o">.</span><span class="n">Sequence</span> <span class="ow">or</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">val</span><span class="p">,</span> <span class="nb">list</span><span class="p">):</span>
+ <span class="c1"># in this case, value is a list (or a Sequence)</span>
+ <span class="k">if</span> <span class="n">show_label</span><span class="p">:</span> <span class="n">stream</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
+ <span class="n">index</span> <span class="o">=</span> <span class="mi">0</span>
+ <span class="k">for</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">val</span><span class="p">:</span>
+ <span class="n">p</span> <span class="o">=</span> <span class="n">path</span> <span class="o">+</span> <span class="s2">"["</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">index</span><span class="p">)</span> <span class="o">+</span> <span class="s2">"]"</span>
+ <span class="n">getConfigColored</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">p</span><span class="p">,</span> <span class="n">stream</span><span class="p">,</span> <span class="n">show_label</span><span class="p">,</span> <span class="n">level</span> <span class="o">+</span> <span class="mi">1</span><span class="p">)</span>
+ <span class="n">index</span> <span class="o">+=</span> <span class="mi">1</span>
+ <span class="k">else</span><span class="p">:</span> <span class="c1"># case where val is just a str</span>
+ <span class="n">stream</span><span class="o">.</span><span class="n">write</span><span class="p">(</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="n">val</span><span class="p">)</span></div>
+
+<div class="viewcode-block" id="print_value"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.configManager.print_value">[docs]</a><span class="k">def</span> <span class="nf">print_value</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">logger</span><span class="p">,</span> <span class="n">show_label</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">level</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">show_full_path</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> print a colored representation value from a config pyconf instance.</span>
+<span class="sd"> used recursively from the initial path.</span>
+<span class="sd"> </span>
+<span class="sd"> :param see getConfigColored</span>
+<span class="sd"> """</span>
+ <span class="n">outStream</span> <span class="o">=</span> <span class="n">DBG</span><span class="o">.</span><span class="n">OutStream</span><span class="p">()</span>
+ <span class="n">getConfigColored</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">outStream</span><span class="p">,</span> <span class="n">show_label</span><span class="p">,</span> <span class="n">level</span><span class="p">,</span> <span class="n">show_full_path</span><span class="p">)</span>
+ <span class="n">res</span> <span class="o">=</span> <span class="n">outStream</span><span class="o">.</span><span class="n">getvalue</span><span class="p">()</span> <span class="c1"># stream not closed</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
+ <span class="k">return</span></div>
+
+
+<div class="viewcode-block" id="print_debug"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.configManager.print_debug">[docs]</a><span class="k">def</span> <span class="nf">print_debug</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">logger</span><span class="p">,</span> <span class="n">show_label</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">level</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">show_full_path</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> logger output for debugging a config/pyconf</span>
+<span class="sd"> lines contains: path : expression --> 'evaluation'</span>
+<span class="sd"> </span>
+<span class="sd"> example:</span>
+<span class="sd"> PROJECTS.projects.salome.project_path : $PWD --> '/tmp/SALOME'</span>
+<span class="sd"> """</span>
+ <span class="n">path</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">aPath</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">path</span> <span class="o">==</span> <span class="s2">"."</span> <span class="p">:</span>
+ <span class="n">val</span> <span class="o">=</span> <span class="n">config</span>
+ <span class="n">path</span> <span class="o">=</span> <span class="s2">""</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">path</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s1">'.'</span><span class="p">):</span> <span class="c1"># Make sure that the path does not ends with a point</span>
+ <span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="p">[:</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
+ <span class="n">val</span> <span class="o">=</span> <span class="n">config</span><span class="o">.</span><span class="n">getByPath</span><span class="p">(</span><span class="n">path</span><span class="p">)</span>
+
+ <span class="n">outStream</span> <span class="o">=</span> <span class="n">DBG</span><span class="o">.</span><span class="n">OutStream</span><span class="p">()</span>
+ <span class="n">DBG</span><span class="o">.</span><span class="n">saveConfigDbg</span><span class="p">(</span><span class="n">val</span><span class="p">,</span> <span class="n">outStream</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">res</span> <span class="o">=</span> <span class="n">outStream</span><span class="o">.</span><span class="n">value</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
+ <span class="k">return</span></div>
+
+
+<div class="viewcode-block" id="get_config_children"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.configManager.get_config_children">[docs]</a><span class="k">def</span> <span class="nf">get_config_children</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">args</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Gets the names of the children of the given parameter.</span>
+<span class="sd"> Useful only for completion mechanism</span>
+<span class="sd"> </span>
+<span class="sd"> :param config Config: The configuration where to read the values</span>
+<span class="sd"> :param args: The path in the config from which get the keys</span>
+<span class="sd"> """</span>
+ <span class="n">vals</span> <span class="o">=</span> <span class="p">[]</span>
+ <span class="n">rootkeys</span> <span class="o">=</span> <span class="n">config</span><span class="o">.</span><span class="n">keys</span><span class="p">()</span>
+
+ <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">args</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
+ <span class="c1"># no parameter returns list of root keys</span>
+ <span class="n">vals</span> <span class="o">=</span> <span class="n">rootkeys</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">parent</span> <span class="o">=</span> <span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
+ <span class="n">pos</span> <span class="o">=</span> <span class="n">parent</span><span class="o">.</span><span class="n">rfind</span><span class="p">(</span><span class="s1">'.'</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">pos</span> <span class="o"><</span> <span class="mi">0</span><span class="p">:</span>
+ <span class="c1"># Case where there is only on key as parameter.</span>
+ <span class="c1"># For example VARS</span>
+ <span class="n">vals</span> <span class="o">=</span> <span class="p">[</span><span class="n">m</span> <span class="k">for</span> <span class="n">m</span> <span class="ow">in</span> <span class="n">rootkeys</span> <span class="k">if</span> <span class="n">m</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="n">parent</span><span class="p">)]</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="c1"># Case where there is a part from a key</span>
+ <span class="c1"># for example VARS.us (for VARS.user)</span>
+ <span class="n">head</span> <span class="o">=</span> <span class="n">parent</span><span class="p">[</span><span class="mi">0</span><span class="p">:</span><span class="n">pos</span><span class="p">]</span>
+ <span class="n">tail</span> <span class="o">=</span> <span class="n">parent</span><span class="p">[</span><span class="n">pos</span><span class="o">+</span><span class="mi">1</span><span class="p">:]</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="n">a</span> <span class="o">=</span> <span class="n">config</span><span class="o">.</span><span class="n">getByPath</span><span class="p">(</span><span class="n">head</span><span class="p">)</span>
+ <span class="k">if</span> <span class="nb">dir</span><span class="p">(</span><span class="n">a</span><span class="p">)</span><span class="o">.</span><span class="fm">__contains__</span><span class="p">(</span><span class="s1">'keys'</span><span class="p">):</span>
+ <span class="n">vals</span> <span class="o">=</span> <span class="nb">map</span><span class="p">(</span><span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="n">head</span> <span class="o">+</span> <span class="s1">'.'</span> <span class="o">+</span> <span class="n">x</span><span class="p">,</span>
+ <span class="p">[</span><span class="n">m</span> <span class="k">for</span> <span class="n">m</span> <span class="ow">in</span> <span class="n">a</span><span class="o">.</span><span class="n">keys</span><span class="p">()</span> <span class="k">if</span> <span class="n">m</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="n">tail</span><span class="p">)])</span>
+ <span class="k">except</span><span class="p">:</span>
+ <span class="k">pass</span>
+
+ <span class="k">for</span> <span class="n">v</span> <span class="ow">in</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">vals</span><span class="p">):</span>
+ <span class="n">sys</span><span class="o">.</span><span class="n">stdout</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">"</span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span> <span class="n">v</span><span class="p">)</span></div>
+
+
+<span class="k">def</span> <span class="nf">_getConfig</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">appliToLoad</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Load the configuration (all pyconf)</span>
+<span class="sd"> and returns the config from some files .pyconf</span>
+<span class="sd"> """</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">runner</span><span class="o">.</span><span class="n">config</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
+ <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s2">"config existing yet in '</span><span class="si">%s</span><span class="s2">' instance"</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">runner</span><span class="o">.</span><span class="n">getClassName</span><span class="p">())</span>
+
+
+ <span class="c1"># read the configuration from all the pyconf files </span>
+ <span class="n">cfgManager</span> <span class="o">=</span> <span class="n">getConfigManager</span><span class="p">()</span> <span class="c1"># commands.config.ConfigManager()</span>
+ <span class="n">DBG</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">"appli to load"</span><span class="p">,</span> <span class="n">appliToLoad</span><span class="p">,</span> <span class="kc">True</span><span class="p">)</span>
+ <span class="n">config</span> <span class="o">=</span> <span class="n">cfgManager</span><span class="o">.</span><span class="n">get_config</span><span class="p">(</span><span class="n">datadir</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">runner</span><span class="o">.</span><span class="n">datadir</span><span class="p">,</span>
+ <span class="n">application</span><span class="o">=</span><span class="n">appliToLoad</span><span class="p">,</span>
+ <span class="n">options</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">runner</span><span class="o">.</span><span class="n">options</span><span class="p">,</span>
+ <span class="n">command</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">runner</span><span class="o">.</span><span class="n">nameAppliLoaded</span> <span class="o">=</span> <span class="n">appliToLoad</span>
+ <span class="c1"># DBG.write("appli loaded", config, True)</span>
+
+ <span class="c1"># Set the verbose mode if called</span>
+ <span class="n">DBG</span><span class="o">.</span><span class="n">tofix</span><span class="p">(</span><span class="s2">"verbose/batch/logger_add_link -1/False/None"</span><span class="p">,</span> <span class="kc">True</span><span class="p">)</span>
+ <span class="n">verbose</span> <span class="o">=</span> <span class="o">-</span><span class="mi">1</span>
+ <span class="n">batch</span> <span class="o">=</span> <span class="kc">False</span>
+ <span class="n">logger_add_link</span> <span class="o">=</span> <span class="kc">None</span>
+ <span class="k">if</span> <span class="n">verbose</span> <span class="o">></span> <span class="o">-</span><span class="mi">1</span><span class="p">:</span>
+ <span class="n">verbose_save</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">options</span><span class="o">.</span><span class="n">output_verbose_level</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">options</span><span class="o">.</span><span class="fm">__setattr__</span><span class="p">(</span><span class="s2">"output_verbose_level"</span><span class="p">,</span> <span class="n">verbose</span><span class="p">)</span>
+
+ <span class="c1"># Set batch mode if called</span>
+ <span class="k">if</span> <span class="n">batch</span><span class="p">:</span>
+ <span class="n">batch_save</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">options</span><span class="o">.</span><span class="n">batch</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">options</span><span class="o">.</span><span class="fm">__setattr__</span><span class="p">(</span><span class="s2">"batch"</span><span class="p">,</span> <span class="kc">True</span><span class="p">)</span>
+
+ <span class="c1"># set output level</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">runner</span><span class="o">.</span><span class="n">options</span><span class="o">.</span><span class="n">output_verbose_level</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
+ <span class="n">config</span><span class="o">.</span><span class="n">USER</span><span class="o">.</span><span class="n">output_verbose_level</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">runner</span><span class="o">.</span><span class="n">options</span><span class="o">.</span><span class="n">output_verbose_level</span>
+ <span class="k">if</span> <span class="n">config</span><span class="o">.</span><span class="n">USER</span><span class="o">.</span><span class="n">output_verbose_level</span> <span class="o"><</span> <span class="mi">1</span><span class="p">:</span>
+ <span class="n">config</span><span class="o">.</span><span class="n">USER</span><span class="o">.</span><span class="n">output_verbose_level</span> <span class="o">=</span> <span class="mi">0</span>
+ <span class="n">silent</span> <span class="o">=</span> <span class="p">(</span><span class="n">config</span><span class="o">.</span><span class="n">USER</span><span class="o">.</span><span class="n">output_verbose_level</span> <span class="o">==</span> <span class="mi">0</span><span class="p">)</span>
+
+ <span class="c1"># create log file</span>
+ <span class="n">micro_command</span> <span class="o">=</span> <span class="kc">False</span>
+ <span class="k">if</span> <span class="n">logger_add_link</span><span class="p">:</span>
+ <span class="n">micro_command</span> <span class="o">=</span> <span class="kc">True</span>
+ <span class="n">logger_command</span> <span class="o">=</span> <span class="n">UTS</span><span class="o">.</span><span class="n">getNewLogger</span><span class="p">(</span><span class="n">config</span><span class="p">,</span>
+ <span class="n">silent_sysstd</span><span class="o">=</span><span class="n">silent</span><span class="p">,</span>
+ <span class="n">all_in_terminal</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">runner</span><span class="o">.</span><span class="n">options</span><span class="o">.</span><span class="n">all_in_terminal</span><span class="p">,</span>
+ <span class="n">micro_command</span><span class="o">=</span><span class="n">micro_command</span><span class="p">)</span>
+
+ <span class="c1"># Check that the path given by the logs_paths_in_file option</span>
+ <span class="c1"># is a file path that can be written</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">runner</span><span class="o">.</span><span class="n">options</span><span class="o">.</span><span class="n">logs_paths_in_file</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">micro_command</span><span class="p">:</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">options</span><span class="o">.</span><span class="n">logs_paths_in_file</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">abspath</span><span class="p">(</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">options</span><span class="o">.</span><span class="n">logs_paths_in_file</span><span class="p">)</span>
+ <span class="n">dir_file</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">options</span><span class="o">.</span><span class="n">logs_paths_in_file</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">dir_file</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">dir_file</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">options</span><span class="o">.</span><span class="n">logs_paths_in_file</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">options</span><span class="o">.</span><span class="n">logs_paths_in_file</span><span class="p">)</span>
+ <span class="n">file_test</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">options</span><span class="o">.</span><span class="n">logs_paths_in_file</span><span class="p">,</span> <span class="s2">"w"</span><span class="p">)</span>
+ <span class="n">file_test</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
+ <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
+ <span class="n">msg</span> <span class="o">=</span> <span class="n">_</span><span class="p">(</span><span class="s2">"""</span><span class="se">\</span>
+<span class="s2">The logs_paths_in_file option will not be taken into account.</span>
+<span class="s2">Here is the error:"""</span><span class="p">)</span>
+ <span class="n">logger_command</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="s2">"</span><span class="si">%s</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">msg</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="bp">self</span><span class="o">.</span><span class="n">options</span><span class="o">.</span><span class="n">logs_paths_in_file</span> <span class="o">=</span> <span class="kc">None</span>
+
+ <span class="k">return</span> <span class="n">config</span>
+
+<div class="viewcode-block" id="get_products_list"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.configManager.get_products_list">[docs]</a><span class="k">def</span> <span class="nf">get_products_list</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">options</span><span class="p">,</span> <span class="n">cfg</span><span class="p">,</span> <span class="n">logger</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Gives the product list with their informations from </span>
+<span class="sd"> configuration regarding the passed options.</span>
+<span class="sd"> </span>
+<span class="sd"> :param options Options: The Options instance that stores the commands arguments</span>
+<span class="sd"> :param config Config: The global configuration</span>
+<span class="sd"> :param logger Logger: The logger instance to use for the display and logging</span>
+<span class="sd"> :return: The list of (product name, product_informations).</span>
+<span class="sd"> :rtype: List</span>
+<span class="sd"> """</span>
+ <span class="c1"># Get the products to be prepared, regarding the options</span>
+ <span class="k">if</span> <span class="n">options</span><span class="o">.</span><span class="n">products</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
+ <span class="c1"># No options, get all products sources</span>
+ <span class="n">products</span> <span class="o">=</span> <span class="n">cfg</span><span class="o">.</span><span class="n">APPLICATION</span><span class="o">.</span><span class="n">products</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="c1"># if option --products, check that all products of the command line</span>
+ <span class="c1"># are present in the application.</span>
+ <span class="n">products</span> <span class="o">=</span> <span class="n">options</span><span class="o">.</span><span class="n">products</span>
+ <span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="n">products</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">p</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">cfg</span><span class="o">.</span><span class="n">APPLICATION</span><span class="o">.</span><span class="n">products</span><span class="p">:</span>
+ <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s2">"Product </span><span class="si">%(product)s</span><span class="s2"> "</span>
+ <span class="s2">"not defined in application </span><span class="si">%(application)s</span><span class="s2">"</span><span class="p">)</span> <span class="o">%</span>
+ <span class="p">{</span> <span class="s1">'product'</span><span class="p">:</span> <span class="n">p</span><span class="p">,</span> <span class="s1">'application'</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">application</span><span class="p">}</span> <span class="p">)</span>
+
+ <span class="c1"># Construct the list of tuple containing </span>
+ <span class="c1"># the products name and their definition</span>
+ <span class="n">products_infos</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">product</span><span class="o">.</span><span class="n">get_products_infos</span><span class="p">(</span><span class="n">products</span><span class="p">,</span> <span class="n">cfg</span><span class="p">)</span>
+
+ <span class="k">return</span> <span class="n">products_infos</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>
+ <form class="search" action="../../search.html" method="get">
+ <div><input type="text" name="q" /></div>
+ <div><input type="submit" value="Go" /></div>
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</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.4.9</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
+
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
-
<!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.debug — salomeTools 5.0.0dev documentation</title>
+
<link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
- <script type="text/javascript" src="../../_static/documentation_options.js"></script>
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
- <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/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="top" title="salomeTools 5.0.0dev documentation" href="../../index.html" />
+ <link rel="up" title="Module code" href="../index.html" />
<link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
- </head><body>
+ </head>
+ <body role="document">
<div class="document">
<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">"""</span>
<span class="sd">This file assume DEBUG functionalities use</span>
+<span class="sd">Print salomeTools debug messages in sys.stderr.</span>
+<span class="sd">Show pretty print debug representation from instances of SAT classes </span>
+<span class="sd">(pretty print src.pyconf.Config)</span>
-<span class="sd">- print debug messages in sys.stderr for salomeTools</span>
-<span class="sd">- show pretty print debug representation from instances of SAT classes</span>
-<span class="sd"> (pretty print src.pyconf.Config), and python dict/list etc. (as 'aVariable')</span>
-
-<span class="sd">WARNING: obviously supposedly show messages in SAT development phase, not production</span>
+<span class="sd">WARNING: supposedly show messages in SAT development phase, not production</span>
<span class="sd">usage:</span>
<span class="sd">>> import debug as DBG</span>
<span class="sd">>> DBG.write("aTitle", aVariable) # not shown in production </span>
-<span class="sd">>> DBG.write("aTitle", aVariable, True) # unconditionaly shown (as show=True)</span>
-
-<span class="sd">to set show message as development phase:</span>
-<span class="sd">>> DBG.push_debug(True)</span>
-
-<span class="sd">to set no show message as production phase:</span>
-<span class="sd">>> DBG.push_debug(False)</span>
-
-<span class="sd">to set show message temporary as development phase, only in a method:</span>
-<span class="sd">>> def aMethodToDebug(...):</span>
-<span class="sd">>> DBG.push_debug(True) #force show as appended status</span>
-<span class="sd">>> etc. method code with some DBG.write()</span>
-<span class="sd">>> DBG.pop_debug() #restore previous status (show or not show)</span>
-<span class="sd">>> return</span>
-
-<span class="sd">to set a message for future fix, as temporary problem to not forget:</span>
-<span class="sd">DBG.tofix("aTitle", aVariable, True/False) #True/False in production shown, or not</span>
-
-<span class="sd">in command line interface you could redirect stderr to file 'myDebug.log':</span>
-<span class="sd">>> sat compile ... 2> myDebug.log # only stderr</span>
-<span class="sd">>> sat compile ... &> myDebug.log # stdout and stderr</span>
+<span class="sd">>> DBG.write("aTitle", aVariable, True) # unconditionaly shown </span>
<span class="sd">"""</span>
<span class="kn">import</span> <span class="nn">os</span>
<span class="n">_debug</span> <span class="o">=</span> <span class="p">[</span><span class="kc">False</span><span class="p">]</span> <span class="c1">#support push/pop for temporary activate debug outputs</span>
+<span class="n">_user</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s1">'USER'</span><span class="p">]</span>
+<span class="c1"># wambeke is christian at home</span>
+<span class="n">_developpers</span> <span class="o">=</span> <span class="p">[</span><span class="s2">"christian"</span><span class="p">,</span> <span class="s2">"wambeke"</span><span class="p">,</span> <span class="s2">"crouzet"</span><span class="p">]</span> <span class="c1"># crouzet, kloss ...</span>
+
+
<div class="viewcode-block" id="indent"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.debug.indent">[docs]</a><span class="k">def</span> <span class="nf">indent</span><span class="p">(</span><span class="n">text</span><span class="p">,</span> <span class="n">amount</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span> <span class="n">ch</span><span class="o">=</span><span class="s1">' '</span><span class="p">):</span>
<span class="sd">"""indent multi lines message"""</span>
<span class="n">padding</span> <span class="o">=</span> <span class="n">amount</span> <span class="o">*</span> <span class="n">ch</span>
<div class="viewcode-block" id="write"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.debug.write">[docs]</a><span class="k">def</span> <span class="nf">write</span><span class="p">(</span><span class="n">title</span><span class="p">,</span> <span class="n">var</span><span class="o">=</span><span class="s2">""</span><span class="p">,</span> <span class="n">force</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">fmt</span><span class="o">=</span><span class="s2">"</span><span class="se">\n</span><span class="s2">#### DEBUG: </span><span class="si">%s</span><span class="s2">:</span><span class="se">\n</span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span><span class="p">):</span>
<span class="sd">"""write sys.stderr a message if _debug[-1]==True or optionaly force=True"""</span>
<span class="k">if</span> <span class="n">_debug</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="ow">or</span> <span class="n">force</span><span class="p">:</span>
- <span class="k">if</span> <span class="s1">'src.pyconf.'</span> <span class="ow">in</span> <span class="nb">str</span><span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="n">var</span><span class="p">)):</span>
+ <span class="k">if</span> <span class="s1">'.Config'</span> <span class="ow">in</span> <span class="nb">str</span><span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="n">var</span><span class="p">)):</span>
<span class="n">sys</span><span class="o">.</span><span class="n">stderr</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">fmt</span> <span class="o">%</span> <span class="p">(</span><span class="n">title</span><span class="p">,</span> <span class="n">indent</span><span class="p">(</span><span class="n">getStrConfigDbg</span><span class="p">(</span><span class="n">var</span><span class="p">))))</span>
+ <span class="k">if</span> <span class="s1">'loggingSat.UnittestStream'</span> <span class="ow">in</span> <span class="nb">str</span><span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="n">var</span><span class="p">)):</span>
+ <span class="n">sys</span><span class="o">.</span><span class="n">stderr</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">fmt</span> <span class="o">%</span> <span class="p">(</span><span class="n">title</span><span class="p">,</span> <span class="n">indent</span><span class="p">(</span><span class="n">var</span><span class="o">.</span><span class="n">getLogs</span><span class="p">())))</span>
<span class="k">elif</span> <span class="nb">type</span><span class="p">(</span><span class="n">var</span><span class="p">)</span> <span class="ow">is</span> <span class="ow">not</span> <span class="nb">str</span><span class="p">:</span>
<span class="n">sys</span><span class="o">.</span><span class="n">stderr</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">fmt</span> <span class="o">%</span> <span class="p">(</span><span class="n">title</span><span class="p">,</span> <span class="n">indent</span><span class="p">(</span><span class="n">PP</span><span class="o">.</span><span class="n">pformat</span><span class="p">(</span><span class="n">var</span><span class="p">))))</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span></div>
<div class="viewcode-block" id="tofix"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.debug.tofix">[docs]</a><span class="k">def</span> <span class="nf">tofix</span><span class="p">(</span><span class="n">title</span><span class="p">,</span> <span class="n">var</span><span class="o">=</span><span class="s2">""</span><span class="p">,</span> <span class="n">force</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
- <span class="sd">"""\</span>
+ <span class="sd">"""</span>
<span class="sd"> write sys.stderr a message if _debug[-1]==True or optionaly force=True</span>
-<span class="sd"> use this only if no logger accessible for classic </span>
-<span class="sd"> logger.warning(message) or logger.debug(message)</span>
+<span class="sd"> use this only if no logger accessible for classic logger.warning(message)</span>
<span class="sd"> """</span>
<span class="n">fmt</span> <span class="o">=</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">#### TOFIX: </span><span class="si">%s</span><span class="s2">:</span><span class="se">\n</span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span>
<span class="n">write</span><span class="p">(</span><span class="n">title</span><span class="p">,</span> <span class="n">var</span><span class="p">,</span> <span class="n">force</span><span class="p">,</span> <span class="n">fmt</span><span class="p">)</span></div>
<span class="n">config</span><span class="o">.</span><span class="n">__save__</span><span class="p">(</span><span class="n">aStream</span><span class="p">,</span> <span class="n">indent</span><span class="p">)</span> </div>
<div class="viewcode-block" id="getStrConfigStd"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.debug.getStrConfigStd">[docs]</a><span class="k">def</span> <span class="nf">getStrConfigStd</span><span class="p">(</span><span class="n">config</span><span class="p">):</span>
- <span class="sd">"""set string as saveConfigStd, as file .pyconf"""</span>
+ <span class="sd">"""set string as saveConfigStd, </span>
+<span class="sd"> as file .pyconf"""</span>
<span class="n">outStream</span> <span class="o">=</span> <span class="n">OutStream</span><span class="p">()</span>
<span class="n">saveConfigStd</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">outStream</span><span class="p">)</span>
<span class="k">return</span> <span class="n">outStream</span><span class="o">.</span><span class="n">value</span></div>
<div class="viewcode-block" id="getStrConfigDbg"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.debug.getStrConfigDbg">[docs]</a><span class="k">def</span> <span class="nf">getStrConfigDbg</span><span class="p">(</span><span class="n">config</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> set string as saveConfigDbg, </span>
-<span class="sd"> as (path expression evaluation) for debug</span>
-<span class="sd"> """</span>
+ <span class="sd">"""set string as saveConfigDbg, </span>
+<span class="sd"> as (path expression evaluation) for debug"""</span>
<span class="n">outStream</span> <span class="o">=</span> <span class="n">OutStream</span><span class="p">()</span>
<span class="n">saveConfigDbg</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">outStream</span><span class="p">)</span>
<span class="k">return</span> <span class="n">outStream</span><span class="o">.</span><span class="n">value</span></div>
</div>
<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" />
+ <div><input type="text" name="q" /></div>
+ <div><input type="submit" value="Go" /></div>
<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>
©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>
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.9</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
</div>
-
<!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.environment — salomeTools 5.0.0dev documentation</title>
+
<link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
- <script type="text/javascript" src="../../_static/documentation_options.js"></script>
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
- <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/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="top" title="salomeTools 5.0.0dev documentation" href="../../index.html" />
+ <link rel="up" title="Module code" href="../index.html" />
<link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
- </head><body>
+ </head>
+ <body role="document">
<div class="document">
<span class="kn">import</span> <span class="nn">string</span>
<span class="kn">import</span> <span class="nn">sys</span>
-<span class="kn">import</span> <span class="nn">src</span>
-<span class="kn">import</span> <span class="nn">src.debug</span> <span class="k">as</span> <span class="nn">DBG</span>
-<span class="kn">import</span> <span class="nn">pprint</span> <span class="k">as</span> <span class="nn">PP</span>
+<span class="kn">import</span> <span class="nn">src.pyconf</span> <span class="k">as</span> <span class="nn">PYCONF</span>
<div class="viewcode-block" id="Environ"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.Environ">[docs]</a><span class="k">class</span> <span class="nc">Environ</span><span class="p">:</span>
- <span class="sd">"""\</span>
-<span class="sd"> Class to manage the environment context</span>
-<span class="sd"> """</span>
+ <span class="sd">'''Class to manage the environment context</span>
+<span class="sd"> '''</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">environ</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
- <span class="sd">"""Initialization. If the environ argument is passed, the environment</span>
+ <span class="sd">'''Initialization. If the environ argument is passed, the environment</span>
<span class="sd"> will be add to it, else it is the external environment.</span>
<span class="sd"> </span>
<span class="sd"> :param environ dict: </span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="k">if</span> <span class="n">environ</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">environ</span> <span class="o">=</span> <span class="n">environ</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">environ</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span>
<span class="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
- <span class="sd">"""easy non exhaustive quick resume for debug print"""</span>
- <span class="k">return</span> <span class="s2">"</span><span class="si">%s</span><span class="s2">(</span><span class="se">\n</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">PP</span><span class="o">.</span><span class="n">pformat</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="p">))</span>
+ <span class="sd">"""easy non exhaustive quick resume for debug print</span>
+<span class="sd"> """</span>
+ <span class="n">res</span><span class="o">=</span><span class="p">{}</span>
+ <span class="n">res</span><span class="p">[</span><span class="s2">"environ"</span><span class="p">]</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">environ</span>
+ <span class="k">return</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="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">res</span><span class="p">)[</span><span class="mi">0</span><span class="p">:</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="o">+</span> <span class="s2">" ...etc...}"</span>
<span class="k">def</span> <span class="nf">_expandvars</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> replace some $VARIABLE into its actual value in the environment</span>
+ <span class="sd">'''replace some $VARIABLE into its actual value in the environment</span>
<span class="sd"> </span>
<span class="sd"> :param value str: the string to be replaced</span>
<span class="sd"> :return: the replaced variable</span>
<span class="sd"> :rtype: str</span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="k">if</span> <span class="s2">"$"</span> <span class="ow">in</span> <span class="n">value</span><span class="p">:</span>
<span class="c1"># The string.Template class is a string class </span>
<span class="c1"># for supporting $-substitutions</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">value</span> <span class="o">=</span> <span class="n">zt</span><span class="o">.</span><span class="n">substitute</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">KeyError</span> <span class="k">as</span> <span class="n">exc</span><span class="p">:</span>
- <span class="k">raise</span> <span class="n">src</span><span class="o">.</span><span class="n">SatException</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s2">"Missing definition "</span>
- <span class="s2">"in environment: </span><span class="si">%s</span><span class="s2">"</span><span class="p">)</span> <span class="o">%</span> <span class="nb">str</span><span class="p">(</span><span class="n">exc</span><span class="p">))</span>
+ <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span>
+ <span class="n">_</span><span class="p">(</span><span class="s2">"Missing definition in environment: </span><span class="si">%s</span><span class="s2">"</span><span class="p">)</span> <span class="o">%</span> <span class="nb">str</span><span class="p">(</span><span class="n">exc</span><span class="p">)</span> <span class="p">)</span>
<span class="k">return</span> <span class="n">value</span>
<div class="viewcode-block" id="Environ.append_value"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.Environ.append_value">[docs]</a> <span class="k">def</span> <span class="nf">append_value</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">sep</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">pathsep</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> append value to key using sep</span>
+ <span class="sd">'''append value to key using sep</span>
<span class="sd"> </span>
<span class="sd"> :param key str: the environment variable to append</span>
<span class="sd"> :param value str: the value to append to key</span>
<span class="sd"> :param sep str: the separator string</span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="c1"># check if the key is already in the environment</span>
<span class="k">if</span> <span class="n">key</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="p">:</span>
<span class="n">value_list</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="n">key</span><span class="p">]</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">sep</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span></div>
<div class="viewcode-block" id="Environ.append"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.Environ.append">[docs]</a> <span class="k">def</span> <span class="nf">append</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">sep</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">pathsep</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Same as append_value but the value argument can be a list</span>
+ <span class="sd">'''Same as append_value but the value argument can be a list</span>
<span class="sd"> </span>
<span class="sd"> :param key str: the environment variable to append</span>
<span class="sd"> :param value str or list: the value(s) to append to key</span>
<span class="sd"> :param sep str: the separator string</span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">list</span><span class="p">):</span>
<span class="k">for</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">value</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">append_value</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">v</span><span class="p">,</span> <span class="n">sep</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">append_value</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">sep</span><span class="p">)</span></div>
<div class="viewcode-block" id="Environ.prepend_value"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.Environ.prepend_value">[docs]</a> <span class="k">def</span> <span class="nf">prepend_value</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">sep</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">pathsep</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> prepend value to key using sep</span>
+ <span class="sd">'''prepend value to key using sep</span>
<span class="sd"> </span>
<span class="sd"> :param key str: the environment variable to prepend</span>
<span class="sd"> :param value str: the value to prepend to key</span>
<span class="sd"> :param sep str: the separator string</span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="k">if</span> <span class="n">key</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="p">:</span>
<span class="n">value_list</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="n">key</span><span class="p">]</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">sep</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">value</span> <span class="ow">in</span> <span class="n">value_list</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span></div>
<div class="viewcode-block" id="Environ.prepend"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.Environ.prepend">[docs]</a> <span class="k">def</span> <span class="nf">prepend</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">sep</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">pathsep</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Same as prepend_value but the value argument can be a list</span>
+ <span class="sd">'''Same as prepend_value but the value argument can be a list</span>
<span class="sd"> </span>
<span class="sd"> :param key str: the environment variable to prepend</span>
<span class="sd"> :param value str or list: the value(s) to prepend to key</span>
<span class="sd"> :param sep str: the separator string</span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">list</span><span class="p">):</span>
<span class="k">for</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">value</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">prepend_value</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">v</span><span class="p">,</span> <span class="n">sep</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">prepend_value</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">sep</span><span class="p">)</span></div>
<div class="viewcode-block" id="Environ.is_defined"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.Environ.is_defined">[docs]</a> <span class="k">def</span> <span class="nf">is_defined</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Check if the key exists in the environment</span>
+ <span class="sd">'''Check if the key exists in the environment</span>
<span class="sd"> </span>
<span class="sd"> :param key str: the environment variable to check</span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="k">return</span> <span class="n">key</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">keys</span><span class="p">()</span></div>
<div class="viewcode-block" id="Environ.set"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.Environ.set">[docs]</a> <span class="k">def</span> <span class="nf">set</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Set the environment variable "key" to value "value"</span>
+ <span class="sd">'''Set the environment variable "key" to value "value"</span>
<span class="sd"> </span>
<span class="sd"> :param key str: the environment variable to set</span>
<span class="sd"> :param value str: the value</span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_expandvars</span><span class="p">(</span><span class="n">value</span><span class="p">)</span></div>
<div class="viewcode-block" id="Environ.get"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.Environ.get">[docs]</a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Get the value of the environment variable "key"</span>
+ <span class="sd">'''Get the value of the environment variable "key"</span>
<span class="sd"> </span>
<span class="sd"> :param key str: the environment variable</span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="k">if</span> <span class="n">key</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="n">key</span><span class="p">]</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="s2">""</span></div>
<div class="viewcode-block" id="Environ.command_value"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.Environ.command_value">[docs]</a> <span class="k">def</span> <span class="nf">command_value</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">command</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Get the value given by the system command "command" </span>
-<span class="sd"> and put it in the environment variable key</span>
+ <span class="sd">'''Get the value given by the system command "command" </span>
+<span class="sd"> and put it in the environment variable key</span>
<span class="sd"> </span>
<span class="sd"> :param key str: the environment variable</span>
<span class="sd"> :param command str: the command to execute</span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="n">value</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">Popen</span><span class="p">(</span><span class="n">command</span><span class="p">,</span>
<span class="n">shell</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
<span class="n">stdout</span><span class="o">=</span><span class="n">subprocess</span><span class="o">.</span><span class="n">PIPE</span><span class="p">,</span>
<div class="viewcode-block" id="SalomeEnviron"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.SalomeEnviron">[docs]</a><span class="k">class</span> <span class="nc">SalomeEnviron</span><span class="p">:</span>
- <span class="sd">"""\</span>
-<span class="sd"> Class to manage the environment of SALOME.</span>
+ <span class="sd">"""Class to manage the environment of SALOME.</span>
<span class="sd"> """</span>
+
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
<span class="n">cfg</span><span class="p">,</span>
<span class="n">environ</span><span class="p">,</span>
<span class="n">forBuild</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
<span class="n">for_package</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">enable_simple_env_script</span> <span class="o">=</span> <span class="kc">True</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Initialization.</span>
+ <span class="sd">'''Initialization.</span>
<span class="sd"> :param cfg Config: the global config</span>
<span class="sd"> :param environ Environ: the Environ instance where </span>
<span class="sd"> else a build one</span>
<span class="sd"> :param for_package str: If not None, produce a relative environment </span>
<span class="sd"> designed for a package. </span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="bp">self</span><span class="o">.</span><span class="n">environ</span> <span class="o">=</span> <span class="n">environ</span>
<span class="bp">self</span><span class="o">.</span><span class="n">cfg</span> <span class="o">=</span> <span class="n">cfg</span>
<span class="bp">self</span><span class="o">.</span><span class="n">forBuild</span> <span class="o">=</span> <span class="n">forBuild</span>
<span class="bp">self</span><span class="o">.</span><span class="n">silent</span> <span class="o">=</span> <span class="kc">False</span>
<span class="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
- <span class="sd">"""easy almost exhaustive quick resume for debug print"""</span>
- <span class="n">res</span> <span class="o">=</span> <span class="p">{</span>
- <span class="s2">"environ"</span> <span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="p">,</span>
- <span class="s2">"forBuild"</span> <span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">forBuild</span><span class="p">,</span>
- <span class="s2">"for_package"</span> <span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">for_package</span><span class="p">,</span>
- <span class="p">}</span>
- <span class="k">return</span> <span class="s2">"</span><span class="si">%s</span><span class="s2">(</span><span class="se">\n</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">PP</span><span class="o">.</span><span class="n">pformat</span><span class="p">(</span><span class="n">res</span><span class="p">))</span>
+ <span class="sd">"""easy non exhaustive quick resume for debug print"""</span>
+ <span class="n">res</span><span class="o">=</span><span class="p">{}</span>
+ <span class="n">res</span><span class="p">[</span><span class="s2">"environ"</span><span class="p">]</span><span class="o">=</span><span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="p">)</span>
+ <span class="n">res</span><span class="p">[</span><span class="s2">"forBuild"</span><span class="p">]</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">forBuild</span>
+ <span class="k">return</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="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">res</span><span class="p">)[</span><span class="mi">0</span><span class="p">:</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="o">+</span> <span class="s2">" ...etc...}"</span>
<div class="viewcode-block" id="SalomeEnviron.append"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.SalomeEnviron.append">[docs]</a> <span class="k">def</span> <span class="nf">append</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">sep</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">pathsep</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> append value to key using sep</span>
+ <span class="sd">'''append value to key using sep</span>
<span class="sd"> </span>
<span class="sd"> :param key str: the environment variable to append</span>
<span class="sd"> :param value str: the value to append to key</span>
<span class="sd"> :param sep str: the separator string</span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">sep</span><span class="p">)</span></div>
<div class="viewcode-block" id="SalomeEnviron.prepend"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.SalomeEnviron.prepend">[docs]</a> <span class="k">def</span> <span class="nf">prepend</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">sep</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">pathsep</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> prepend value to key using sep</span>
+ <span class="sd">'''prepend value to key using sep</span>
<span class="sd"> </span>
<span class="sd"> :param key str: the environment variable to prepend</span>
<span class="sd"> :param value str: the value to prepend to key</span>
<span class="sd"> :param sep str: the separator string</span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">prepend</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">sep</span><span class="p">)</span></div>
<div class="viewcode-block" id="SalomeEnviron.is_defined"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.SalomeEnviron.is_defined">[docs]</a> <span class="k">def</span> <span class="nf">is_defined</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Check if the key exists in the environment</span>
+ <span class="sd">'''Check if the key exists in the environment</span>
<span class="sd"> </span>
<span class="sd"> :param key str: the environment variable to check</span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">is_defined</span><span class="p">(</span><span class="n">key</span><span class="p">)</span></div>
<div class="viewcode-block" id="SalomeEnviron.get"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.SalomeEnviron.get">[docs]</a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Get the value of the environment variable "key"</span>
+ <span class="sd">'''Get the value of the environment variable "key"</span>
<span class="sd"> </span>
<span class="sd"> :param key str: the environment variable</span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">key</span><span class="p">)</span></div>
<div class="viewcode-block" id="SalomeEnviron.set"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.SalomeEnviron.set">[docs]</a> <span class="k">def</span> <span class="nf">set</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Set the environment variable "key" to value "value"</span>
+ <span class="sd">'''Set the environment variable "key" to value "value"</span>
<span class="sd"> </span>
<span class="sd"> :param key str: the environment variable to set</span>
<span class="sd"> :param value str: the value</span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="c1"># check if value needs to be evaluated</span>
<span class="k">if</span> <span class="n">value</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">value</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s2">"`"</span><span class="p">)</span> <span class="ow">and</span> <span class="n">value</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s2">"`"</span><span class="p">):</span>
<span class="n">res</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">Popen</span><span class="p">(</span><span class="s2">"echo </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="n">value</span><span class="p">,</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span></div>
<div class="viewcode-block" id="SalomeEnviron.dump"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.SalomeEnviron.dump">[docs]</a> <span class="k">def</span> <span class="nf">dump</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">out</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Write the environment to out</span>
+ <span class="sd">"""Write the environment to out</span>
<span class="sd"> </span>
<span class="sd"> :param out file: the stream where to write the environment</span>
<span class="sd"> """</span>
<span class="n">out</span><span class="o">.</span><span class="n">write</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="se">\n</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">k</span><span class="p">,</span> <span class="n">value</span><span class="p">))</span></div>
<div class="viewcode-block" id="SalomeEnviron.add_line"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.SalomeEnviron.add_line">[docs]</a> <span class="k">def</span> <span class="nf">add_line</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">nb_line</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Add empty lines to the out stream (in case of file generation)</span>
+ <span class="sd">"""Add empty lines to the out stream (in case of file generation)</span>
<span class="sd"> </span>
<span class="sd"> :param nb_line int: the number of empty lines to add</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">add_line</span><span class="p">(</span><span class="n">nb_line</span><span class="p">)</span></div>
<div class="viewcode-block" id="SalomeEnviron.add_comment"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.SalomeEnviron.add_comment">[docs]</a> <span class="k">def</span> <span class="nf">add_comment</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">comment</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Add a commentary to the out stream (in case of file generation)</span>
+ <span class="sd">"""Add a commentary to the out stream (in case of file generation)</span>
<span class="sd"> </span>
<span class="sd"> :param comment str: the commentary to add</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">add_comment</span><span class="p">(</span><span class="n">comment</span><span class="p">)</span></div>
<div class="viewcode-block" id="SalomeEnviron.add_warning"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.SalomeEnviron.add_warning">[docs]</a> <span class="k">def</span> <span class="nf">add_warning</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">warning</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Add a warning to the out stream (in case of file generation)</span>
+ <span class="sd">"""Add a warning to the out stream (in case of file generation)</span>
<span class="sd"> </span>
<span class="sd"> :param warning str: the warning to add</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">add_warning</span><span class="p">(</span><span class="n">warning</span><span class="p">)</span></div>
<div class="viewcode-block" id="SalomeEnviron.finish"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.SalomeEnviron.finish">[docs]</a> <span class="k">def</span> <span class="nf">finish</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">required</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Add a final instruction in the out file (in case of file generation)</span>
+ <span class="sd">"""Add a final instruction in the out file (in case of file generation)</span>
<span class="sd"> </span>
<span class="sd"> :param required bool: Do nothing if required is False</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">finish</span><span class="p">(</span><span class="n">required</span><span class="p">)</span></div>
<div class="viewcode-block" id="SalomeEnviron.set_python_libdirs"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.SalomeEnviron.set_python_libdirs">[docs]</a> <span class="k">def</span> <span class="nf">set_python_libdirs</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
- <span class="sd">"""Set some generic variables for python library paths"""</span>
+ <span class="sd">"""Set some generic variables for python library paths</span>
+<span class="sd"> """</span>
<span class="n">ver</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'PYTHON_VERSION'</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s1">'PYTHON_LIBDIR0'</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="s1">'lib'</span><span class="p">,</span>
<span class="s1">'python'</span> <span class="o">+</span> <span class="n">ver</span><span class="p">,</span>
<span class="k">return</span> <span class="n">lProdName</span></div>
<div class="viewcode-block" id="SalomeEnviron.set_application_env"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.SalomeEnviron.set_application_env">[docs]</a> <span class="k">def</span> <span class="nf">set_application_env</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">logger</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Sets the environment defined in the APPLICATION file.</span>
+ <span class="sd">"""Sets the environment defined in the APPLICATION file.</span>
<span class="sd"> </span>
<span class="sd"> :param logger Logger: The logger instance to display messages</span>
<span class="sd"> """</span>
- <span class="c1"># add variable PRODUCT_ROOT_DIR as $workdir in APPLICATION.environ section if not present</span>
- <span class="k">try</span><span class="p">:</span>
- <span class="n">tmp</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">cfg</span><span class="o">.</span><span class="n">APPLICATION</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">PRODUCT_ROOT_DIR</span>
- <span class="k">except</span><span class="p">:</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">cfg</span><span class="o">.</span><span class="n">APPLICATION</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">PRODUCT_ROOT_DIR</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">pyconf</span><span class="o">.</span><span class="n">Reference</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">cfg</span><span class="p">,</span> <span class="n">src</span><span class="o">.</span><span class="n">pyconf</span><span class="o">.</span><span class="n">DOLLAR</span><span class="p">,</span> <span class="s2">"workdir"</span><span class="p">)</span>
- <span class="n">DBG</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">"set_application_env add default Config.APPLICATION.environ.PRODUCT_ROOT_DIR"</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">cfg</span><span class="o">.</span><span class="n">APPLICATION</span><span class="o">.</span><span class="n">environ</span><span class="p">)</span>
-
<span class="c1"># Set the variables defined in the "environ" section</span>
<span class="k">if</span> <span class="s1">'environ'</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">cfg</span><span class="o">.</span><span class="n">APPLICATION</span><span class="p">:</span>
<span class="c1"># we write PRODUCT environment it in order to conform to </span>
<span class="sd"> :param logger Logger: The logger instance to display messages </span>
<span class="sd"> """</span>
<span class="c1"># set root dir</span>
- <span class="n">DBG</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">"set_salome_minimal_product_env"</span><span class="p">,</span> <span class="n">product_info</span><span class="p">)</span>
<span class="n">root_dir</span> <span class="o">=</span> <span class="n">product_info</span><span class="o">.</span><span class="n">name</span> <span class="o">+</span> <span class="s2">"_ROOT_DIR"</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_defined</span><span class="p">(</span><span class="n">root_dir</span><span class="p">):</span>
<span class="k">if</span> <span class="s1">'install_dir'</span> <span class="ow">in</span> <span class="n">product_info</span> <span class="ow">and</span> <span class="n">product_info</span><span class="o">.</span><span class="n">install_dir</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">root_dir</span><span class="p">,</span> <span class="n">product_info</span><span class="o">.</span><span class="n">install_dir</span><span class="p">)</span>
<span class="k">elif</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">silent</span><span class="p">:</span>
- <span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">" "</span> <span class="o">+</span> <span class="n">_</span><span class="p">(</span><span class="s2">"No install_dir for product </span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span> <span class="o">%</span>
- <span class="n">product_info</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="mi">5</span><span class="p">)</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s2">"No install_dir for product </span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span> <span class="o">%</span> <span class="n">product_info</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
- <span class="n">source_in_package</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">get_property_in_product_cfg</span><span class="p">(</span><span class="n">product_info</span><span class="p">,</span>
- <span class="s2">"sources_in_package"</span><span class="p">)</span>
+ <span class="n">source_in_package</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">get_property_in_product_cfg</span><span class="p">(</span><span class="n">product_info</span><span class="p">,</span> <span class="s2">"sources_in_package"</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">for_package</span> <span class="ow">or</span> <span class="n">source_in_package</span> <span class="o">==</span> <span class="s2">"yes"</span><span class="p">:</span>
<span class="c1"># set source dir, unless no source dir</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">src</span><span class="o">.</span><span class="n">product</span><span class="o">.</span><span class="n">product_is_fixed</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">for_package</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">src_dir</span><span class="p">,</span> <span class="n">product_info</span><span class="o">.</span><span class="n">source_dir</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">src_dir</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="s2">"out_dir_Path"</span><span class="p">,</span>
- <span class="s2">"SOURCES"</span><span class="p">,</span>
- <span class="n">product_info</span><span class="o">.</span><span class="n">name</span><span class="p">))</span></div>
+ <span class="n">srcDir</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="s2">"out_dir_Path"</span><span class="p">,</span> <span class="s2">"SOURCES"</span><span class="p">,</span> <span class="n">product_info</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">src_dir</span><span class="p">,</span> <span class="n">srcDir</span><span class="p">)</span></div>
<div class="viewcode-block" id="SalomeEnviron.set_salome_generic_product_env"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.SalomeEnviron.set_salome_generic_product_env">[docs]</a> <span class="k">def</span> <span class="nf">set_salome_generic_product_env</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">pi</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Sets the generic environment for a SALOME product.</span>
+ <span class="sd">"""Sets the generic environment for a SALOME product.</span>
<span class="sd"> </span>
<span class="sd"> :param pi Config: The product description</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">prepend</span><span class="p">(</span><span class="s1">'PYTHONPATH'</span><span class="p">,</span> <span class="n">l</span><span class="p">)</span></div>
<div class="viewcode-block" id="SalomeEnviron.set_cpp_env"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.SalomeEnviron.set_cpp_env">[docs]</a> <span class="k">def</span> <span class="nf">set_cpp_env</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">product_info</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Sets the generic environment for a SALOME cpp product.</span>
+ <span class="sd">"""Sets the generic environment for a SALOME cpp product.</span>
<span class="sd"> </span>
<span class="sd"> :param product_info Config: The product description</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">prepend</span><span class="p">(</span><span class="s1">'PYTHONPATH'</span><span class="p">,</span> <span class="n">l</span><span class="p">)</span></div>
<div class="viewcode-block" id="SalomeEnviron.load_cfg_environment"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.SalomeEnviron.load_cfg_environment">[docs]</a> <span class="k">def</span> <span class="nf">load_cfg_environment</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cfg_env</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Loads environment defined in cfg_env </span>
+ <span class="sd">"""Loads environment defined in cfg_env </span>
<span class="sd"> </span>
<span class="sd"> :param cfg_env Config: A config containing an environment </span>
<span class="sd"> """</span>
<span class="k">continue</span>
<span class="c1"># if it is a dict, do not do anything</span>
- <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">val</span><span class="p">,</span> <span class="n">src</span><span class="o">.</span><span class="n">pyconf</span><span class="o">.</span><span class="n">Mapping</span><span class="p">):</span>
+ <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">val</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="k">continue</span>
<span class="c1"># if it is a list, loop on its values</span>
- <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">val</span><span class="p">,</span> <span class="n">src</span><span class="o">.</span><span class="n">pyconf</span><span class="o">.</span><span class="n">Sequence</span><span class="p">):</span>
+ <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">val</span><span class="p">,</span> <span class="n">PYCONF</span><span class="o">.</span><span class="n">Sequence</span><span class="p">):</span>
<span class="c1"># transform into list of strings</span>
<span class="n">l_val</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">val</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">env_def</span><span class="p">,</span> <span class="n">val</span><span class="p">)</span></div>
<div class="viewcode-block" id="SalomeEnviron.set_a_product"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.SalomeEnviron.set_a_product">[docs]</a> <span class="k">def</span> <span class="nf">set_a_product</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">product</span><span class="p">,</span> <span class="n">logger</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Sets the environment of a product. </span>
+ <span class="sd">"""Sets the environment of a product. </span>
<span class="sd"> </span>
<span class="sd"> :param product str: The product name</span>
<span class="sd"> :param logger Logger: The logger instance to display messages</span>
<span class="c1"># Get the informations corresponding to the product</span>
<span class="n">pi</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">product</span><span class="o">.</span><span class="n">get_product_config</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">cfg</span><span class="p">,</span> <span class="n">product</span><span class="p">)</span>
-
- <span class="c1"># skip mesa products (if any) at run time, </span>
- <span class="c1"># unless use_mesa property was activated</span>
- <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">forBuild</span><span class="p">:</span>
- <span class="k">if</span> <span class="ow">not</span> <span class="p">(</span><span class="s2">"APPLICATION"</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">cfg</span> <span class="ow">and</span>
- <span class="s2">"properties"</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">cfg</span><span class="o">.</span><span class="n">APPLICATION</span> <span class="ow">and</span>
- <span class="s2">"use_mesa"</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">cfg</span><span class="o">.</span><span class="n">APPLICATION</span><span class="o">.</span><span class="n">properties</span> <span class="ow">and</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">cfg</span><span class="o">.</span><span class="n">APPLICATION</span><span class="o">.</span><span class="n">properties</span><span class="o">.</span><span class="n">use_mesa</span> <span class="o">==</span> <span class="s2">"yes"</span><span class="p">)</span> <span class="p">:</span>
- <span class="k">if</span> <span class="p">(</span><span class="s2">"properties"</span> <span class="ow">in</span> <span class="n">pi</span> <span class="ow">and</span>
- <span class="s2">"is_mesa"</span> <span class="ow">in</span> <span class="n">pi</span><span class="o">.</span><span class="n">properties</span> <span class="ow">and</span>
- <span class="n">pi</span><span class="o">.</span><span class="n">properties</span><span class="o">.</span><span class="n">is_mesa</span> <span class="o">==</span> <span class="s2">"yes"</span><span class="p">)</span> <span class="p">:</span>
- <span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s2">"Skip mesa product </span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span> <span class="o">%</span> <span class="n">pi</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="mi">4</span><span class="p">)</span>
- <span class="k">return</span>
-
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">for_package</span><span class="p">:</span>
- <span class="n">pi</span><span class="o">.</span><span class="n">install_dir</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="s2">"out_dir_Path"</span><span class="p">,</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">for_package</span><span class="p">,</span>
- <span class="n">pi</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
+ <span class="n">pi</span><span class="o">.</span><span class="n">install_dir</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="s2">"out_dir_Path"</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">for_package</span><span class="p">,</span> <span class="n">pi</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">silent</span><span class="p">:</span>
- <span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s2">"Setting environment for </span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span> <span class="o">%</span> <span class="n">product</span><span class="p">,</span> <span class="mi">4</span><span class="p">)</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s2">"Setting environment for </span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span> <span class="o">%</span> <span class="n">product</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">add_line</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">add_comment</span><span class="p">(</span><span class="s1">'setting environ for '</span> <span class="o">+</span> <span class="n">product</span><span class="p">)</span>
<span class="n">env_script</span> <span class="o">=</span> <span class="n">product_info</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">env_script</span>
<span class="c1"># Check that the script exists</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">env_script</span><span class="p">):</span>
- <span class="k">raise</span> <span class="n">src</span><span class="o">.</span><span class="n">SatException</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s2">"Environment script not found: </span><span class="si">%s</span><span class="s2">"</span><span class="p">)</span> <span class="o">%</span>
- <span class="n">env_script</span><span class="p">)</span>
+ <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s2">"Environment script not found: </span><span class="si">%s</span><span class="s2">"</span><span class="p">)</span> <span class="o">%</span> <span class="n">env_script</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">silent</span> <span class="ow">and</span> <span class="n">logger</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
- <span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">" ** load </span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span> <span class="n">env_script</span><span class="p">,</span> <span class="mi">4</span><span class="p">)</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">" ** load </span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span> <span class="n">env_script</span><span class="p">)</span>
<span class="c1"># import the script and run the set_env function</span>
<span class="k">try</span><span class="p">:</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="n">pyproduct</span><span class="o">.</span><span class="n">set_env</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">product_info</span><span class="o">.</span><span class="n">install_dir</span><span class="p">,</span> <span class="n">product_info</span><span class="o">.</span><span class="n">version</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">if</span> <span class="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>
- <span class="n">__</span><span class="p">,</span> <span class="n">exceptionValue</span><span class="p">,</span> <span class="n">exceptionTraceback</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">exc_info</span><span class="p">()</span>
+ <span class="n">tmp</span> <span class="p">,</span> <span class="n">exceptionValue</span><span class="p">,</span> <span class="n">exceptionTraceback</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">exc_info</span><span class="p">()</span>
<span class="nb">print</span><span class="p">(</span><span class="n">exceptionValue</span><span class="p">)</span>
<span class="kn">import</span> <span class="nn">traceback</span>
<span class="n">traceback</span><span class="o">.</span><span class="n">print_tb</span><span class="p">(</span><span class="n">exceptionTraceback</span><span class="p">)</span>
<span class="n">traceback</span><span class="o">.</span><span class="n">print_exc</span><span class="p">()</span></div>
<div class="viewcode-block" id="SalomeEnviron.run_simple_env_script"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.SalomeEnviron.run_simple_env_script">[docs]</a> <span class="k">def</span> <span class="nf">run_simple_env_script</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">script_path</span><span class="p">,</span> <span class="n">logger</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Runs an environment script. Same as run_env_script, but with a </span>
-<span class="sd"> script path as parameter.</span>
+ <span class="sd">"""Runs an environment script. Same as run_env_script, but with a </span>
+<span class="sd"> script path as parameter.</span>
<span class="sd"> </span>
<span class="sd"> :param script_path str: a path to an environment script</span>
<span class="sd"> :param logger Logger: The logger instance to display messages</span>
<span class="k">return</span>
<span class="c1"># Check that the script exists</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">script_path</span><span class="p">):</span>
- <span class="k">raise</span> <span class="n">src</span><span class="o">.</span><span class="n">SatException</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s2">"Environment script not found: </span><span class="si">%s</span><span class="s2">"</span><span class="p">)</span> <span class="o">%</span>
- <span class="n">script_path</span><span class="p">)</span>
+ <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s2">"Environment script not found: </span><span class="si">%s</span><span class="s2">"</span><span class="p">)</span> <span class="o">%</span> <span class="n">script_path</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">silent</span> <span class="ow">and</span> <span class="n">logger</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
- <span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">" ** load </span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span> <span class="n">script_path</span><span class="p">,</span> <span class="mi">4</span><span class="p">)</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">" ** load </span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span> <span class="n">script_path</span><span class="p">)</span>
<span class="n">script_basename</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">basename</span><span class="p">(</span><span class="n">script_path</span><span class="p">)</span>
<span class="k">if</span> <span class="n">script_basename</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s2">".py"</span><span class="p">):</span>
<span class="n">traceback</span><span class="o">.</span><span class="n">print_exc</span><span class="p">()</span></div>
<div class="viewcode-block" id="SalomeEnviron.set_products"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.SalomeEnviron.set_products">[docs]</a> <span class="k">def</span> <span class="nf">set_products</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">logger</span><span class="p">,</span> <span class="n">src_root</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Sets the environment for all the products. </span>
+ <span class="sd">"""Sets the environment for all the products. </span>
<span class="sd"> </span>
<span class="sd"> :param logger Logger: The logger instance to display messages</span>
<span class="sd"> :param src_root src: the application working directory</span>
<span class="bp">self</span><span class="o">.</span><span class="n">finish</span><span class="p">(</span><span class="kc">False</span><span class="p">)</span></div>
<div class="viewcode-block" id="SalomeEnviron.set_full_environ"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.SalomeEnviron.set_full_environ">[docs]</a> <span class="k">def</span> <span class="nf">set_full_environ</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">logger</span><span class="p">,</span> <span class="n">env_info</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Sets the full environment for products </span>
-<span class="sd"> specified in env_info dictionary. </span>
+ <span class="sd">"""Sets the full environment for products </span>
+<span class="sd"> specified in env_info dictionary. </span>
<span class="sd"> </span>
<span class="sd"> :param logger Logger: The logger instance to display messages</span>
<span class="sd"> :param env_info list: the list of products</span>
<span class="sd"> """</span>
- <span class="n">DBG</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">"set_full_environ for"</span><span class="p">,</span> <span class="n">env_info</span><span class="p">)</span>
- <span class="c1"># DBG.write("set_full_environ config", self.cfg.APPLICATION.environ, True)</span>
<span class="c1"># set product environ</span>
<span class="bp">self</span><span class="o">.</span><span class="n">set_application_env</span><span class="p">(</span><span class="n">logger</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">set_a_product</span><span class="p">(</span><span class="n">product</span><span class="p">,</span> <span class="n">logger</span><span class="p">)</span></div></div>
<div class="viewcode-block" id="FileEnvWriter"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.FileEnvWriter">[docs]</a><span class="k">class</span> <span class="nc">FileEnvWriter</span><span class="p">:</span>
- <span class="sd">"""\</span>
-<span class="sd"> Class to dump the environment to a file.</span>
+ <span class="sd">"""Class to dump the environment to a file.</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">config</span><span class="p">,</span> <span class="n">logger</span><span class="p">,</span> <span class="n">out_dir</span><span class="p">,</span> <span class="n">src_root</span><span class="p">,</span> <span class="n">env_info</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Initialization.</span>
+ <span class="sd">"""Initialization</span>
<span class="sd"> :param cfg Config: the global config</span>
<span class="sd"> :param logger Logger: The logger instance to display messages</span>
<span class="bp">self</span><span class="o">.</span><span class="n">env_info</span> <span class="o">=</span> <span class="n">env_info</span>
<div class="viewcode-block" id="FileEnvWriter.write_env_file"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.FileEnvWriter.write_env_file">[docs]</a> <span class="k">def</span> <span class="nf">write_env_file</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filename</span><span class="p">,</span> <span class="n">forBuild</span><span class="p">,</span> <span class="n">shell</span><span class="p">,</span> <span class="n">for_package</span> <span class="o">=</span> <span class="kc">None</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Create an environment file.</span>
+ <span class="sd">"""Create an environment file.</span>
<span class="sd"> </span>
<span class="sd"> :param filename str: the file path</span>
<span class="sd"> :param forBuild bool: if true, the build environment</span>
<span class="sd"> :rtype: str</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">silent</span><span class="p">:</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s2">"Create environment file </span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span> <span class="o">%</span>
- <span class="n">src</span><span class="o">.</span><span class="n">printcolors</span><span class="o">.</span><span class="n">printcLabel</span><span class="p">(</span><span class="n">filename</span><span class="p">),</span> <span class="mi">3</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s2">"Create environment file </span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span> <span class="o">%</span> <span class="n">UTS</span><span class="o">.</span><span class="n">label</span><span class="p">(</span><span class="n">filename</span><span class="p">))</span>
<span class="c1"># create then env object</span>
<span class="n">env_file</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">out_dir</span><span class="p">,</span> <span class="n">filename</span><span class="p">),</span> <span class="s2">"w"</span><span class="p">)</span>
- <span class="n">tmp</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">fileEnviron</span><span class="o">.</span><span class="n">get_file_environ</span><span class="p">(</span><span class="n">env_file</span><span class="p">,</span>
- <span class="n">shell</span><span class="p">,</span>
- <span class="p">{})</span>
+ <span class="n">tmp</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">fileEnviron</span><span class="o">.</span><span class="n">get_file_environ</span><span class="p">(</span><span class="n">env_file</span><span class="p">,</span> <span class="n">shell</span><span class="p">,</span> <span class="p">{})</span>
<span class="n">env</span> <span class="o">=</span> <span class="n">SalomeEnviron</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="p">,</span> <span class="n">tmp</span><span class="p">,</span> <span class="n">forBuild</span><span class="p">,</span> <span class="n">for_package</span><span class="o">=</span><span class="n">for_package</span><span class="p">)</span>
<span class="n">env</span><span class="o">.</span><span class="n">silent</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">silent</span>
<span class="c1"># The list of products to launch</span>
<span class="n">lProductsName</span> <span class="o">=</span> <span class="n">env</span><span class="o">.</span><span class="n">get_names</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">APPLICATION</span><span class="o">.</span><span class="n">products</span><span class="o">.</span><span class="n">keys</span><span class="p">())</span>
- <span class="n">env</span><span class="o">.</span><span class="n">set</span><span class="p">(</span> <span class="s2">"SALOME_MODULES"</span><span class="p">,</span> <span class="s1">','</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">lProductsName</span><span class="p">))</span>
+ <span class="n">env</span><span class="o">.</span><span class="n">set</span><span class="p">(</span> <span class="s2">"SALOME_MODULES"</span><span class="p">,</span> <span class="s1">','</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">lProductsName</span><span class="p">))</span>
- <span class="c1"># set the products</span>
- <span class="n">env</span><span class="o">.</span><span class="n">set_products</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="p">,</span>
- <span class="n">src_root</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">src_root</span><span class="p">)</span>
+ <span class="c1"># set the product</span>
+ <span class="n">env</span><span class="o">.</span><span class="n">set_products</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="p">,</span> <span class="n">src_root</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">src_root</span><span class="p">)</span>
<span class="c1"># add cleanup and close</span>
<span class="n">env</span><span class="o">.</span><span class="n">finish</span><span class="p">(</span><span class="kc">True</span><span class="p">)</span>
<span class="n">additional_env</span> <span class="o">=</span> <span class="p">{},</span>
<span class="n">for_package</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">with_commercial</span> <span class="o">=</span> <span class="kc">True</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Append to current opened aFile a cfgForPy </span>
-<span class="sd"> environment (SALOME python launcher).</span>
+ <span class="sd">"""Append to current opened aFile a cfgForPy </span>
+<span class="sd"> environment (SALOME python launcher).</span>
<span class="sd"> </span>
<span class="sd"> :param filename str: the file path</span>
<span class="sd"> :param additional_env dict: a dictionary of additional variables </span>
<span class="sd"> designed for a package. </span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">silent</span><span class="p">:</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s2">"Create configuration file </span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span> <span class="o">%</span>
- <span class="n">src</span><span class="o">.</span><span class="n">printcolors</span><span class="o">.</span><span class="n">printcLabel</span><span class="p">(</span><span class="n">filename</span><span class="o">.</span><span class="n">name</span><span class="p">),</span> <span class="mi">3</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s2">"Create configuration file </span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span> <span class="o">%</span> <span class="n">UTS</span><span class="o">.</span><span class="n">label</span><span class="p">(</span><span class="n">filename</span><span class="o">.</span><span class="n">name</span><span class="p">))</span>
<span class="c1"># create then env object</span>
<span class="n">tmp</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">fileEnviron</span><span class="o">.</span><span class="n">get_file_environ</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span>
<span class="n">tmp</span><span class="p">,</span>
<span class="n">forBuild</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
<span class="n">for_package</span><span class="o">=</span><span class="n">for_package</span><span class="p">,</span>
- <span class="n">enable_simple_env_script</span> <span class="o">=</span> <span class="n">with_commercial</span><span class="p">)</span>
+ <span class="n">enable_simple_env_script</span><span class="o">=</span><span class="n">with_commercial</span><span class="p">)</span>
<span class="n">env</span><span class="o">.</span><span class="n">silent</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">silent</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">env_info</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="c1"># The list of products to launch</span>
<span class="n">lProductsName</span> <span class="o">=</span> <span class="n">env</span><span class="o">.</span><span class="n">get_names</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">APPLICATION</span><span class="o">.</span><span class="n">products</span><span class="o">.</span><span class="n">keys</span><span class="p">())</span>
- <span class="n">env</span><span class="o">.</span><span class="n">set</span><span class="p">(</span> <span class="s2">"SALOME_MODULES"</span><span class="p">,</span> <span class="s1">','</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">lProductsName</span><span class="p">))</span>
+ <span class="n">env</span><span class="o">.</span><span class="n">set</span><span class="p">(</span> <span class="s2">"SALOME_MODULES"</span><span class="p">,</span> <span class="s1">','</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">lProductsName</span><span class="p">))</span>
<span class="c1"># set the products</span>
<span class="n">env</span><span class="o">.</span><span class="n">set_products</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="p">,</span>
<span class="sd"> Definition of a Shell.</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">extension</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Initialization.</span>
+ <span class="sd">"""Initialization.</span>
<span class="sd"> :param name str: the shell name</span>
<span class="sd"> :param extension str: the shell extension</span>
<span class="bp">self</span><span class="o">.</span><span class="n">extension</span> <span class="o">=</span> <span class="n">extension</span></div>
<div class="viewcode-block" id="load_environment"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environment.load_environment">[docs]</a><span class="k">def</span> <span class="nf">load_environment</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">build</span><span class="p">,</span> <span class="n">logger</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Loads the environment (used to run the tests, for example).</span>
+ <span class="sd">"""Loads the environment (used to run the tests, for example).</span>
<span class="sd"> </span>
<span class="sd"> :param config Config: the global config</span>
<span class="sd"> :param build bool: build environement if True</span>
</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" />
+ <div><input type="text" name="q" /></div>
+ <div><input type="submit" value="Go" /></div>
<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>
©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>
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.9</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
</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="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>src.environs — 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">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+ <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/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="top" title="salomeTools 5.0.0dev documentation" href="../../index.html" />
+ <link rel="up" title="Module code" href="../index.html" />
+
+ <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+ </head>
+ <body role="document">
+
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <h1>Source code for src.environs</h1><div class="highlight"><pre>
+<span></span><span class="ch">#!/usr/bin/env python</span>
+<span class="c1">#-*- coding:utf-8 -*-</span>
+
+<span class="vm">__doc__</span><span class="o">=</span><span class="s2">"""</span>
+<span class="s2">Utility for print environment variables</span>
+
+<span class="s2">examples: </span>
+<span class="s2"> - split all or specific environment variables $XXX(s)...</span>
+<span class="s2"> >> environs.py -> all</span>
+<span class="s2"> >> environs.py SHELL PATH -> specific $SHELL $PATH</span>
+<span class="s2"> </span>
+<span class="s2"> - split all or specific environment variables on pattern $*XXX*(s)...</span>
+<span class="s2"> >> environs.py --pat ROOT -> specific $*ROOT* </span>
+<span class="s2"> </span>
+<span class="s2"> - split search specific substrings in contents of environment variables $XXX(s)...</span>
+<span class="s2"> >> environs.py --grep usr -> all specific environment variables containing usr</span>
+
+<span class="s2">tips:</span>
+<span class="s2"> - create unix alias as shortcut for bash console</span>
+<span class="s2"> >> alias envs=".../environs.py"</span>
+<span class="s2">"""</span>
+
+<span class="kn">import</span> <span class="nn">sys</span>
+<span class="kn">import</span> <span class="nn">os</span>
+
+<span class="k">def</span> <span class="nf">_test_var_args</span><span class="p">(</span><span class="n">args</span><span class="p">):</span>
+ <span class="k">for</span> <span class="n">arg</span> <span class="ow">in</span> <span class="n">args</span><span class="p">:</span>
+ <span class="nb">print</span> <span class="s2">"another arg:"</span><span class="p">,</span> <span class="n">arg</span>
+
+<span class="k">def</span> <span class="nf">_printOneLineOrNot</span><span class="p">(</span><span class="n">i</span><span class="p">,</span> <span class="n">env</span><span class="p">):</span>
+ <span class="n">splitenv</span> <span class="o">=</span> <span class="n">env</span><span class="p">[</span><span class="n">i</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">done</span> <span class="o">=</span> <span class="kc">False</span>
+ <span class="n">nb</span> <span class="o">=</span> <span class="mi">20</span>
+ <span class="k">for</span> <span class="n">j</span> <span class="ow">in</span> <span class="n">splitenv</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">j</span><span class="o">!=</span><span class="s2">""</span><span class="p">:</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">done</span><span class="p">:</span>
+ <span class="nb">print</span> <span class="s2">"</span><span class="si">{:<30}</span><span class="s2"> = </span><span class="si">{}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">i</span><span class="p">,</span> <span class="n">j</span><span class="p">)</span>
+ <span class="n">done</span><span class="o">=</span><span class="kc">True</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="nb">print</span> <span class="s2">"</span><span class="si">{:<30}</span><span class="s2"> </span><span class="si">{}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="s2">" "</span><span class="p">,</span> <span class="n">j</span><span class="p">)</span>
+
+<div class="viewcode-block" id="print_split_environs"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environs.print_split_environs">[docs]</a><span class="k">def</span> <span class="nf">print_split_environs</span><span class="p">(</span><span class="n">args</span><span class="o">=</span><span class="p">[]):</span>
+ <span class="n">env</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">environ</span>
+ <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">env</span><span class="p">):</span>
+ <span class="k">if</span> <span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">args</span><span class="p">)</span><span class="o">==</span><span class="mi">0</span><span class="p">)</span> <span class="ow">or</span> <span class="p">(</span><span class="n">i</span> <span class="ow">in</span> <span class="n">args</span><span class="p">):</span>
+ <span class="n">_printOneLineOrNot</span><span class="p">(</span><span class="n">i</span><span class="p">,</span> <span class="n">env</span><span class="p">)</span></div>
+
+<div class="viewcode-block" id="print_split_pattern_environs"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environs.print_split_pattern_environs">[docs]</a><span class="k">def</span> <span class="nf">print_split_pattern_environs</span><span class="p">(</span><span class="n">args</span><span class="o">=</span><span class="p">[]):</span>
+ <span class="n">env</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">environ</span>
+ <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">env</span><span class="p">):</span>
+ <span class="n">ok</span> <span class="o">=</span> <span class="kc">False</span>
+ <span class="k">for</span> <span class="n">j</span> <span class="ow">in</span> <span class="n">args</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">j</span> <span class="ow">in</span> <span class="n">i</span><span class="p">:</span>
+ <span class="n">ok</span> <span class="o">=</span> <span class="kc">True</span>
+ <span class="c1">#print "i %s j %s %s" % (i,j,ok)</span>
+ <span class="k">if</span> <span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">args</span><span class="p">)</span><span class="o">==</span><span class="mi">0</span><span class="p">)</span> <span class="ow">or</span> <span class="p">(</span><span class="n">ok</span><span class="p">):</span>
+ <span class="n">_printOneLineOrNot</span><span class="p">(</span><span class="n">i</span><span class="p">,</span> <span class="n">env</span><span class="p">)</span></div>
+
+<div class="viewcode-block" id="print_grep_environs"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.environs.print_grep_environs">[docs]</a><span class="k">def</span> <span class="nf">print_grep_environs</span><span class="p">(</span><span class="n">args</span><span class="o">=</span><span class="p">[]):</span>
+ <span class="n">env</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">environ</span>
+ <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">env</span><span class="p">):</span>
+ <span class="k">for</span> <span class="n">j</span> <span class="ow">in</span> <span class="n">env</span><span class="p">[</span><span class="n">i</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">for</span> <span class="n">a</span> <span class="ow">in</span> <span class="n">args</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">a</span> <span class="ow">in</span> <span class="n">j</span><span class="p">:</span>
+ <span class="c1">#print i+" contains "+j</span>
+ <span class="nb">print</span> <span class="s1">'</span><span class="si">{:<20}</span><span class="s1"> contains </span><span class="si">{}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">i</span><span class="p">,</span><span class="n">j</span><span class="p">)</span></div>
+
+
+<span class="k">if</span> <span class="vm">__name__</span> <span class="o">==</span> <span class="s1">'__main__'</span><span class="p">:</span>
+ <span class="kn">import</span> <span class="nn">sys</span>
+ <span class="n">args</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="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">args</span><span class="p">)</span><span class="o"><</span><span class="mi">1</span><span class="p">:</span>
+ <span class="n">print_split_environs</span><span class="p">()</span>
+ <span class="k">elif</span> <span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="ow">in</span> <span class="p">[</span><span class="s2">"-h"</span><span class="p">,</span><span class="s2">"--help"</span><span class="p">]:</span>
+ <span class="nb">print</span> <span class="vm">__doc__</span>
+ <span class="k">elif</span> <span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="ow">in</span> <span class="p">[</span><span class="s2">"-g"</span><span class="p">,</span><span class="s2">"--grep"</span><span class="p">]:</span>
+ <span class="n">print_grep_environs</span><span class="p">(</span><span class="n">args</span><span class="p">[</span><span class="mi">1</span><span class="p">:])</span>
+ <span class="k">elif</span> <span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="ow">in</span> <span class="p">[</span><span class="s2">"-p"</span><span class="p">,</span><span class="s2">"--pat"</span><span class="p">]:</span>
+ <span class="n">print_split_pattern_environs</span><span class="p">(</span><span class="n">args</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">print_split_environs</span><span class="p">(</span><span class="n">args</span><span class="p">)</span>
+
+</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>
+ <form class="search" action="../../search.html" method="get">
+ <div><input type="text" name="q" /></div>
+ <div><input type="submit" value="Go" /></div>
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</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.4.9</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
+
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
--- /dev/null
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>src.example.essai_logging_1 — 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">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../../_static/doctools.js"></script>
+ <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/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="top" title="salomeTools 5.0.0dev documentation" href="../../../index.html" />
+ <link rel="up" title="Module code" href="../../index.html" />
+
+ <link rel="stylesheet" href="../../../_static/custom.css" type="text/css" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+ </head>
+ <body role="document">
+
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <h1>Source code for src.example.essai_logging_1</h1><div class="highlight"><pre>
+<span></span><span class="ch">#!/usr/bin/env python</span>
+<span class="c1"># -*- coding: utf-8 -*-</span>
+
+<span class="sd">"""</span>
+<span class="sd">http://sametmax.com/ecrire-des-logs-en-python/</span>
+<span class="sd">https://docs.python.org/3/library/time.html#time.strftime</span>
+
+<span class="sd">essai utilisation logger plusieurs handler format different</span>
+
+<span class="sd"> /usr/lib/python2.7/logging/__init__.pyc</span>
+
+<span class="sd"> init MyLogger, fmt='%(asctime)s :: %(levelname)-8s :: %(message)s', level='20'</span>
+
+<span class="sd"> 2018-03-11 18:51:21 :: INFO :: test logger info</span>
+<span class="sd"> 2018-03-11 18:51:21 :: WARNING :: test logger warning</span>
+<span class="sd"> 2018-03-11 18:51:21 :: ERROR :: test logger error</span>
+<span class="sd"> 2018-03-11 18:51:21 :: CRITICAL :: test logger critical</span>
+
+<span class="sd"> init MyLogger, fmt='None', level='10'</span>
+
+<span class="sd"> 2018-03-11 18:51:21 :: DEBUG :: test logger debug</span>
+<span class="sd"> test logger debug</span>
+<span class="sd"> 2018-03-11 18:51:21 :: INFO :: test logger info</span>
+<span class="sd"> test logger info</span>
+<span class="sd"> 2018-03-11 18:51:21 :: WARNING :: test logger warning</span>
+<span class="sd"> test logger warning</span>
+<span class="sd"> 2018-03-11 18:51:21 :: ERROR :: test logger error</span>
+<span class="sd"> test logger error</span>
+<span class="sd"> 2018-03-11 18:51:21 :: CRITICAL :: test logger critical</span>
+<span class="sd"> test logger critical</span>
+<span class="sd">"""</span>
+
+<span class="kn">import</span> <span class="nn">os</span>
+<span class="kn">import</span> <span class="nn">sys</span>
+<span class="kn">import</span> <span class="nn">logging</span>
+<span class="kn">import</span> <span class="nn">pprint</span> <span class="k">as</span> <span class="nn">PP</span>
+
+<span class="nb">print</span> <span class="n">logging</span><span class="o">.</span><span class="vm">__file__</span>
+
+<div class="viewcode-block" id="initMyLogger"><a class="viewcode-back" href="../../../commands/apidoc/src.example.html#src.example.essai_logging_1.initMyLogger">[docs]</a><span class="k">def</span> <span class="nf">initMyLogger</span><span class="p">(</span><span class="n">fmt</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">level</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
+ <span class="c1"># http://sametmax.com/ecrire-des-logs-en-python/</span>
+ <span class="c1"># https://docs.python.org/3/library/time.html#time.strftime</span>
+ <span class="nb">print</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">init MyLogger, fmt='</span><span class="si">%s</span><span class="s2">', level='</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">fmt</span><span class="p">,</span> <span class="n">level</span><span class="p">)</span>
+ <span class="n">logger</span> <span class="o">=</span> <span class="n">getMyLogger</span><span class="p">()</span>
+ <span class="n">handler</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">StreamHandler</span><span class="p">()</span> <span class="c1"># Logging vers console</span>
+ <span class="k">if</span> <span class="n">fmt</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
+ <span class="n">formatter</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">Formatter</span><span class="p">(</span><span class="n">fmt</span><span class="p">,</span> <span class="s2">"%Y-%m-</span><span class="si">%d</span><span class="s2"> %H:%M:%S"</span><span class="p">)</span>
+ <span class="n">handler</span><span class="o">.</span><span class="n">setFormatter</span><span class="p">(</span><span class="n">formatter</span><span class="p">)</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">addHandler</span><span class="p">(</span><span class="n">handler</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">level</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">setLevel</span><span class="p">(</span><span class="n">level</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">setLevel</span><span class="p">(</span><span class="n">logger</span><span class="o">.</span><span class="n">INFO</span><span class="p">)</span> <span class="c1"># ou DEBUG</span></div>
+ <span class="c1"># logger.info('\n' + PP.pformat(dir(logger)))</span>
+
+<div class="viewcode-block" id="getMyLogger"><a class="viewcode-back" href="../../../commands/apidoc/src.example.html#src.example.essai_logging_1.getMyLogger">[docs]</a><span class="k">def</span> <span class="nf">getMyLogger</span><span class="p">():</span>
+ <span class="k">return</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="s1">'MyLogger'</span><span class="p">)</span></div>
+
+<div class="viewcode-block" id="testLogger1"><a class="viewcode-back" href="../../../commands/apidoc/src.example.html#src.example.essai_logging_1.testLogger1">[docs]</a><span class="k">def</span> <span class="nf">testLogger1</span><span class="p">():</span>
+ <span class="n">logger</span> <span class="o">=</span> <span class="n">getMyLogger</span><span class="p">()</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s1">'test logger debug'</span><span class="p">)</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">'test logger info'</span><span class="p">)</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="s1">'test logger warning'</span><span class="p">)</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="s1">'test logger error'</span><span class="p">)</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">critical</span><span class="p">(</span><span class="s1">'test logger critical'</span><span class="p">)</span></div>
+
+<span class="k">if</span> <span class="vm">__name__</span> <span class="o">==</span> <span class="s2">"__main__"</span><span class="p">:</span>
+ <span class="n">initMyLogger</span><span class="p">(</span><span class="s1">'</span><span class="si">%(asctime)s</span><span class="s1"> :: </span><span class="si">%(levelname)-8s</span><span class="s1"> :: </span><span class="si">%(message)s</span><span class="s1">'</span><span class="p">,</span> <span class="n">level</span><span class="o">=</span><span class="n">logging</span><span class="o">.</span><span class="n">INFO</span><span class="p">)</span>
+ <span class="n">testLogger1</span><span class="p">()</span>
+ <span class="n">initMyLogger</span><span class="p">(</span><span class="n">level</span><span class="o">=</span><span class="n">logging</span><span class="o">.</span><span class="n">DEBUG</span><span class="p">)</span>
+ <span class="n">testLogger1</span><span class="p">()</span>
+</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>
+ <form class="search" action="../../../search.html" method="get">
+ <div><input type="text" name="q" /></div>
+ <div><input type="submit" value="Go" /></div>
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</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.4.9</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
+
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
--- /dev/null
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>src.example.essai_logging_2 — 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">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../../_static/doctools.js"></script>
+ <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/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="top" title="salomeTools 5.0.0dev documentation" href="../../../index.html" />
+ <link rel="up" title="Module code" href="../../index.html" />
+
+ <link rel="stylesheet" href="../../../_static/custom.css" type="text/css" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+ </head>
+ <body role="document">
+
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <h1>Source code for src.example.essai_logging_2</h1><div class="highlight"><pre>
+<span></span><span class="ch">#!/usr/bin/env python</span>
+<span class="c1"># -*- coding: utf-8 -*-</span>
+
+<span class="sd">"""</span>
+<span class="sd">http://sametmax.com/ecrire-des-logs-en-python/</span>
+<span class="sd">https://docs.python.org/3/library/time.html#time.strftime</span>
+
+<span class="sd">essai utilisation logger un handler format different </span>
+<span class="sd">sur info() pas de format et su other format</span>
+
+<span class="sd"> /usr/lib/python2.7/logging/__init__.pyc</span>
+
+<span class="sd"> init MyLogger, fmt='%(asctime)s :: %(levelname)-8s :: %(message)s', level='20'</span>
+
+<span class="sd"> test logger info</span>
+<span class="sd"> 2018-03-11 18:51:51 :: WARNING :: test logger warning</span>
+<span class="sd"> 2018-03-11 18:51:51 :: ERROR :: test logger error</span>
+<span class="sd"> 2018-03-11 18:51:51 :: CRITICAL :: test logger critical</span>
+
+<span class="sd">"""</span>
+
+<span class="kn">import</span> <span class="nn">os</span>
+<span class="kn">import</span> <span class="nn">sys</span>
+<span class="kn">import</span> <span class="nn">logging</span>
+<span class="kn">import</span> <span class="nn">pprint</span> <span class="k">as</span> <span class="nn">PP</span>
+
+<span class="nb">print</span> <span class="n">logging</span><span class="o">.</span><span class="vm">__file__</span>
+
+<div class="viewcode-block" id="MyFormatter"><a class="viewcode-back" href="../../../commands/apidoc/src.example.html#src.example.essai_logging_2.MyFormatter">[docs]</a><span class="k">class</span> <span class="nc">MyFormatter</span><span class="p">(</span><span class="n">logging</span><span class="o">.</span><span class="n">Formatter</span><span class="p">):</span>
+<div class="viewcode-block" id="MyFormatter.format"><a class="viewcode-back" href="../../../commands/apidoc/src.example.html#src.example.essai_logging_2.MyFormatter.format">[docs]</a> <span class="k">def</span> <span class="nf">format</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">record</span><span class="p">):</span>
+ <span class="c1"># print "", record.levelname #type(record), dir(record)</span>
+ <span class="k">if</span> <span class="n">record</span><span class="o">.</span><span class="n">levelname</span> <span class="o">==</span> <span class="s2">"INFO"</span><span class="p">:</span>
+ <span class="k">return</span> <span class="nb">str</span><span class="p">(</span><span class="n">record</span><span class="o">.</span><span class="n">msg</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">return</span> <span class="nb">super</span><span class="p">(</span><span class="n">MyFormatter</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">record</span><span class="p">)</span></div></div>
+
+<div class="viewcode-block" id="initMyLogger"><a class="viewcode-back" href="../../../commands/apidoc/src.example.html#src.example.essai_logging_2.initMyLogger">[docs]</a><span class="k">def</span> <span class="nf">initMyLogger</span><span class="p">(</span><span class="n">fmt</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">level</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
+ <span class="c1"># http://sametmax.com/ecrire-des-logs-en-python/</span>
+ <span class="c1"># https://docs.python.org/3/library/time.html#time.strftime</span>
+ <span class="nb">print</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">init MyLogger, fmt='</span><span class="si">%s</span><span class="s2">', level='</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">fmt</span><span class="p">,</span> <span class="n">level</span><span class="p">)</span>
+ <span class="n">logger</span> <span class="o">=</span> <span class="n">getMyLogger</span><span class="p">()</span>
+ <span class="n">handler</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">StreamHandler</span><span class="p">()</span> <span class="c1"># Logging vers console</span>
+ <span class="k">if</span> <span class="n">fmt</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
+ <span class="c1"># formatter = logging.Formatter(fmt, "%Y-%m-%d %H:%M:%S")</span>
+ <span class="n">formatter</span> <span class="o">=</span><span class="n">MyFormatter</span><span class="p">(</span><span class="n">fmt</span><span class="p">,</span> <span class="s2">"%Y-%m-</span><span class="si">%d</span><span class="s2"> %H:%M:%S"</span><span class="p">)</span>
+ <span class="n">handler</span><span class="o">.</span><span class="n">setFormatter</span><span class="p">(</span><span class="n">formatter</span><span class="p">)</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">addHandler</span><span class="p">(</span><span class="n">handler</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">level</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">setLevel</span><span class="p">(</span><span class="n">level</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">setLevel</span><span class="p">(</span><span class="n">logger</span><span class="o">.</span><span class="n">INFO</span><span class="p">)</span> <span class="c1"># ou DEBUG</span></div>
+ <span class="c1"># logger.info('\n' + PP.pformat(dir(logger)))</span>
+
+<div class="viewcode-block" id="getMyLogger"><a class="viewcode-back" href="../../../commands/apidoc/src.example.html#src.example.essai_logging_2.getMyLogger">[docs]</a><span class="k">def</span> <span class="nf">getMyLogger</span><span class="p">():</span>
+ <span class="k">return</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="s1">'MyLogger'</span><span class="p">)</span></div>
+
+<div class="viewcode-block" id="testLogger1"><a class="viewcode-back" href="../../../commands/apidoc/src.example.html#src.example.essai_logging_2.testLogger1">[docs]</a><span class="k">def</span> <span class="nf">testLogger1</span><span class="p">():</span>
+ <span class="n">logger</span> <span class="o">=</span> <span class="n">getMyLogger</span><span class="p">()</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s1">'test logger debug'</span><span class="p">)</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">'test logger info'</span><span class="p">)</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="s1">'test logger warning'</span><span class="p">)</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="s1">'test logger error'</span><span class="p">)</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">critical</span><span class="p">(</span><span class="s1">'test logger critical'</span><span class="p">)</span></div>
+
+<span class="k">if</span> <span class="vm">__name__</span> <span class="o">==</span> <span class="s2">"__main__"</span><span class="p">:</span>
+ <span class="n">initMyLogger</span><span class="p">(</span><span class="s1">'</span><span class="si">%(asctime)s</span><span class="s1"> :: </span><span class="si">%(levelname)-8s</span><span class="s1"> :: </span><span class="si">%(message)s</span><span class="s1">'</span><span class="p">,</span> <span class="n">level</span><span class="o">=</span><span class="n">logging</span><span class="o">.</span><span class="n">INFO</span><span class="p">)</span>
+ <span class="n">testLogger1</span><span class="p">()</span>
+
+</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>
+ <form class="search" action="../../../search.html" method="get">
+ <div><input type="text" name="q" /></div>
+ <div><input type="submit" value="Go" /></div>
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</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.4.9</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
+
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
--- /dev/null
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>src.exceptionSat — 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">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+ <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/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="top" title="salomeTools 5.0.0dev documentation" href="../../index.html" />
+ <link rel="up" title="Module code" href="../index.html" />
+
+ <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+ </head>
+ <body role="document">
+
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <h1>Source code for src.exceptionSat</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-2018 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>
+
+
+<div class="viewcode-block" id="ExceptionSat"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.exceptionSat.ExceptionSat">[docs]</a><span class="k">class</span> <span class="nc">ExceptionSat</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
+ <span class="sd">'''rename Exception Class for sat convenience (for future...)</span>
+<span class="sd"> '''</span>
+ <span class="k">pass</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>
+ <form class="search" action="../../search.html" method="get">
+ <div><input type="text" name="q" /></div>
+ <div><input type="submit" value="Go" /></div>
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</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.4.9</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
+
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
-
<!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.fileEnviron — salomeTools 5.0.0dev documentation</title>
+
<link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
- <script type="text/javascript" src="../../_static/documentation_options.js"></script>
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
- <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/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="top" title="salomeTools 5.0.0dev documentation" href="../../index.html" />
+ <link rel="up" title="Module code" href="../index.html" />
<link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
- </head><body>
+ </head>
+ <body role="document">
<div class="document">
<span class="c1"># Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</span>
<span class="kn">import</span> <span class="nn">os</span>
-<span class="kn">import</span> <span class="nn">pprint</span> <span class="k">as</span> <span class="nn">PP</span>
-<span class="kn">import</span> <span class="nn">src.debug</span> <span class="k">as</span> <span class="nn">DBG</span>
-<span class="n">bat_header</span><span class="o">=</span><span class="s2">"""</span><span class="se">\</span>
-<span class="s2">@echo off</span>
+<span class="n">bat_header</span><span class="o">=</span><span class="s2">"""@echo off</span>
<span class="s2">rem The following variables are used only in case of a sat package</span>
<span class="s2">set out_dir_Path=%~dp0</span>
<span class="s2">"""</span>
-<span class="n">bash_header</span><span class="o">=</span><span class="s2">"""</span><span class="se">\</span>
-<span class="s2">#!/bin/bash</span>
+<span class="n">bash_header</span><span class="o">=</span><span class="s2">"""#!/bin/bash</span>
<span class="s2">##########################################################################</span>
<span class="s2">#</span>
<span class="s2">#### cleandup ###</span>
<span class="s2">###########################################################################</span>
<span class="s2">"""</span>
-<span class="n">cfg_header</span><span class="o">=</span><span class="s2">"""</span><span class="se">\</span>
-<span class="s2">[SALOME Configuration]</span>
-<span class="s2">"""</span>
+<span class="n">cfg_header</span><span class="o">=</span><span class="s1">'''[SALOME Configuration]</span>
+<span class="s1">'''</span>
-<span class="n">Launcher_header</span><span class="o">=</span><span class="s2">"""</span><span class="se">\</span>
-<span class="s2"># a generated SALOME Configuration file using python syntax</span>
-<span class="s2">"""</span>
+<span class="n">Launcher_header</span><span class="o">=</span><span class="s1">'''# a generated SALOME Configuration file using python syntax</span>
+<span class="s1">'''</span>
<div class="viewcode-block" id="get_file_environ"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.get_file_environ">[docs]</a><span class="k">def</span> <span class="nf">get_file_environ</span><span class="p">(</span><span class="n">output</span><span class="p">,</span> <span class="n">shell</span><span class="p">,</span> <span class="n">environ</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""Instantiate correct FileEnvironment sub-class.</span>
<span class="k">return</span> <span class="n">ContextFileEnviron</span><span class="p">(</span><span class="n">output</span><span class="p">,</span> <span class="n">environ</span><span class="p">)</span>
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s2">"FileEnviron: Unknown shell = </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="n">shell</span><span class="p">)</span></div>
-<div class="viewcode-block" id="FileEnviron"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.FileEnviron">[docs]</a><span class="k">class</span> <span class="nc">FileEnviron</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Base class for shell environment</span>
+<div class="viewcode-block" id="FileEnviron"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.FileEnviron">[docs]</a><span class="k">class</span> <span class="nc">FileEnviron</span><span class="p">:</span>
+ <span class="sd">"""Base class for shell environment</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">output</span><span class="p">,</span> <span class="n">environ</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Initialization</span>
+ <span class="sd">"""Initialization</span>
<span class="sd"> </span>
<span class="sd"> :param output file: the output file stream.</span>
<span class="sd"> :param environ dict: a potential additional environment.</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_do_init</span><span class="p">(</span><span class="n">output</span><span class="p">,</span> <span class="n">environ</span><span class="p">)</span>
- <span class="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> easy non exhaustive quick resume for debug print"""</span>
- <span class="n">res</span> <span class="o">=</span> <span class="p">{</span>
- <span class="s2">"output"</span> <span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">output</span><span class="p">,</span>
- <span class="s2">"environ"</span> <span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="p">,</span>
- <span class="p">}</span>
- <span class="k">return</span> <span class="s2">"</span><span class="si">%s</span><span class="s2">(</span><span class="se">\n</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">PP</span><span class="o">.</span><span class="n">pformat</span><span class="p">(</span><span class="n">res</span><span class="p">))</span>
-
-
<span class="k">def</span> <span class="nf">_do_init</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">output</span><span class="p">,</span> <span class="n">environ</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Initialization</span>
+ <span class="sd">"""Initialization</span>
<span class="sd"> </span>
<span class="sd"> :param output file: the output file stream.</span>
<span class="sd"> :param environ dict: a potential additional environment.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">output</span> <span class="o">=</span> <span class="n">output</span>
<span class="bp">self</span><span class="o">.</span><span class="n">toclean</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">if</span> <span class="n">environ</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
- <span class="c1">#if str(type(environ)) == "<type 'instance'>":</span>
- <span class="k">if</span> <span class="nb">id</span><span class="p">(</span><span class="n">environ</span><span class="p">)</span> <span class="o">==</span> <span class="nb">id</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">):</span>
- <span class="n">DBG</span><span class="o">.</span><span class="n">tofix</span><span class="p">(</span><span class="s2">"set </span><span class="si">%s</span><span class="s2"> environ as python os.environ, are you sure it is safe ?"</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="vm">__class__</span><span class="o">.</span><span class="vm">__name__</span><span class="p">,</span> <span class="kc">True</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">environ</span> <span class="o">=</span> <span class="n">environ</span>
<span class="k">else</span><span class="p">:</span>
- <span class="n">DBG</span><span class="o">.</span><span class="n">tofix</span><span class="p">(</span><span class="s2">"set </span><span class="si">%s</span><span class="s2"> environ as COPY of python os.environ, are you sure it is safe ?"</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="vm">__class__</span><span class="o">.</span><span class="vm">__name__</span><span class="p">,</span> <span class="kc">True</span><span class="p">)</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">environ</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">)</span> <span class="c1">#make a copy cvw 180320</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">environ</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span>
<div class="viewcode-block" id="FileEnviron.add_line"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.FileEnviron.add_line">[docs]</a> <span class="k">def</span> <span class="nf">add_line</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">number</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Add some empty lines in the shell file</span>
+ <span class="sd">"""Add some empty lines in the shell file</span>
<span class="sd"> </span>
<span class="sd"> :param number int: the number of lines to add</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">output</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">"</span><span class="se">\n</span><span class="s2">"</span> <span class="o">*</span> <span class="n">number</span><span class="p">)</span></div>
<div class="viewcode-block" id="FileEnviron.add_comment"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.FileEnviron.add_comment">[docs]</a> <span class="k">def</span> <span class="nf">add_comment</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">comment</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Add a comment in the shell file</span>
+ <span class="sd">"""Add a comment in the shell file</span>
<span class="sd"> </span>
<span class="sd"> :param comment str: the comment to add</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">output</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">"# </span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span> <span class="n">comment</span><span class="p">)</span></div>
<div class="viewcode-block" id="FileEnviron.add_echo"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.FileEnviron.add_echo">[docs]</a> <span class="k">def</span> <span class="nf">add_echo</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">text</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Add a "echo" in the shell file</span>
+ <span class="sd">"""Add a "echo" in the shell file</span>
<span class="sd"> </span>
<span class="sd"> :param text str: the text to echo</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">output</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">'echo </span><span class="si">%s</span><span class="s1">"</span><span class="se">\n</span><span class="s1">'</span> <span class="o">%</span> <span class="n">text</span><span class="p">)</span></div>
<div class="viewcode-block" id="FileEnviron.add_warning"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.FileEnviron.add_warning">[docs]</a> <span class="k">def</span> <span class="nf">add_warning</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">warning</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Add a warning "echo" in the shell file</span>
+ <span class="sd">"""Add a warning "echo" in the shell file</span>
<span class="sd"> </span>
<span class="sd"> :param warning str: the text to echo</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">output</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">'echo "WARNING </span><span class="si">%s</span><span class="s1">"</span><span class="se">\n</span><span class="s1">'</span> <span class="o">%</span> <span class="n">warning</span><span class="p">)</span></div>
<div class="viewcode-block" id="FileEnviron.append_value"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.FileEnviron.append_value">[docs]</a> <span class="k">def</span> <span class="nf">append_value</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">sep</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">pathsep</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> append value to key using sep</span>
+ <span class="sd">'''append value to key using sep</span>
<span class="sd"> </span>
<span class="sd"> :param key str: the environment variable to append</span>
<span class="sd"> :param value str: the value to append to key</span>
<span class="sd"> :param sep str: the separator string</span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="bp">self</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">key</span><span class="p">)</span> <span class="o">+</span> <span class="n">sep</span> <span class="o">+</span> <span class="n">value</span><span class="p">)</span>
<span class="k">if</span> <span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">sep</span><span class="p">)</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">toclean</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">toclean</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">key</span><span class="p">,</span> <span class="n">sep</span><span class="p">))</span></div>
<div class="viewcode-block" id="FileEnviron.append"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.FileEnviron.append">[docs]</a> <span class="k">def</span> <span class="nf">append</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">sep</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">pathsep</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Same as append_value but the value argument can be a list</span>
+ <span class="sd">'''Same as append_value but the value argument can be a list</span>
<span class="sd"> </span>
<span class="sd"> :param key str: the environment variable to append</span>
<span class="sd"> :param value str or list: the value(s) to append to key</span>
<span class="sd"> :param sep str: the separator string</span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">list</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">append_value</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">sep</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">value</span><span class="p">),</span> <span class="n">sep</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">append_value</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">sep</span><span class="p">)</span></div>
<div class="viewcode-block" id="FileEnviron.prepend_value"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.FileEnviron.prepend_value">[docs]</a> <span class="k">def</span> <span class="nf">prepend_value</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">sep</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">pathsep</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> prepend value to key using sep</span>
+ <span class="sd">'''prepend value to key using sep</span>
<span class="sd"> </span>
<span class="sd"> :param key str: the environment variable to prepend</span>
<span class="sd"> :param value str: the value to prepend to key</span>
<span class="sd"> :param sep str: the separator string</span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="bp">self</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span> <span class="o">+</span> <span class="n">sep</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">key</span><span class="p">))</span>
<span class="k">if</span> <span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">sep</span><span class="p">)</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">toclean</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">toclean</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">key</span><span class="p">,</span> <span class="n">sep</span><span class="p">))</span></div>
<div class="viewcode-block" id="FileEnviron.prepend"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.FileEnviron.prepend">[docs]</a> <span class="k">def</span> <span class="nf">prepend</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">sep</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">pathsep</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Same as prepend_value but the value argument can be a list</span>
+ <span class="sd">'''Same as prepend_value but the value argument can be a list</span>
<span class="sd"> </span>
<span class="sd"> :param key str: the environment variable to prepend</span>
<span class="sd"> :param value str or list: the value(s) to prepend to key</span>
<span class="sd"> :param sep str: the separator string</span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">list</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">prepend_value</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">sep</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">value</span><span class="p">),</span> <span class="n">sep</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">prepend_value</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">sep</span><span class="p">)</span></div>
<div class="viewcode-block" id="FileEnviron.is_defined"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.FileEnviron.is_defined">[docs]</a> <span class="k">def</span> <span class="nf">is_defined</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Check if the key exists in the environment</span>
+ <span class="sd">'''Check if the key exists in the environment</span>
<span class="sd"> </span>
<span class="sd"> :param key str: the environment variable to check</span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="k">return</span> <span class="p">(</span><span class="n">key</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="p">)</span></div>
<div class="viewcode-block" id="FileEnviron.set"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.FileEnviron.set">[docs]</a> <span class="k">def</span> <span class="nf">set</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Set the environment variable 'key' to value 'value'</span>
+ <span class="sd">'''Set the environment variable "key" to value "value"</span>
<span class="sd"> </span>
<span class="sd"> :param key str: the environment variable to set</span>
<span class="sd"> :param value str: the value</span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="s2">"set is not implement for this shell!"</span><span class="p">)</span></div>
<div class="viewcode-block" id="FileEnviron.get"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.FileEnviron.get">[docs]</a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Get the value of the environment variable "key"</span>
+ <span class="sd">'''Get the value of the environment variable "key"</span>
<span class="sd"> </span>
<span class="sd"> :param key str: the environment variable</span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="k">return</span> <span class="s1">'${</span><span class="si">%s</span><span class="s1">}'</span> <span class="o">%</span> <span class="n">key</span></div>
<div class="viewcode-block" id="FileEnviron.command_value"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.FileEnviron.command_value">[docs]</a> <span class="k">def</span> <span class="nf">command_value</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">command</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Get the value given by the system command "command" </span>
-<span class="sd"> and put it in the environment variable key.</span>
-<span class="sd"> Has to be overwritten in the derived classes</span>
-<span class="sd"> This can be seen as a virtual method</span>
+ <span class="sd">'''Get the value given by the system command "command" </span>
+<span class="sd"> and put it in the environment variable key.</span>
+<span class="sd"> Has to be overwritten in the derived classes</span>
+<span class="sd"> This can be seen as a virtual method</span>
<span class="sd"> </span>
<span class="sd"> :param key str: the environment variable</span>
<span class="sd"> :param command str: the command to execute</span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="s2">"command_value is not implement "</span>
<span class="s2">"for this shell!"</span><span class="p">)</span></div>
<span class="bp">self</span><span class="o">.</span><span class="n">output</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">'clean </span><span class="si">%s</span><span class="s1"> "</span><span class="si">%s</span><span class="s1">"</span><span class="se">\n</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">sep</span><span class="p">))</span></div></div>
<div class="viewcode-block" id="BashFileEnviron"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.BashFileEnviron">[docs]</a><span class="k">class</span> <span class="nc">BashFileEnviron</span><span class="p">(</span><span class="n">FileEnviron</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Class for bash shell.</span>
+ <span class="sd">"""Class for bash shell.</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">output</span><span class="p">,</span> <span class="n">environ</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""Initialization</span>
<span class="bp">self</span><span class="o">.</span><span class="n">output</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">bash_header</span><span class="p">)</span>
<div class="viewcode-block" id="BashFileEnviron.set"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.BashFileEnviron.set">[docs]</a> <span class="k">def</span> <span class="nf">set</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
- <span class="sd">"""Set the environment variable "key" to value "value"</span>
+ <span class="sd">'''Set the environment variable "key" to value "value"</span>
<span class="sd"> </span>
<span class="sd"> :param key str: the environment variable to set</span>
<span class="sd"> :param value str: the value</span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="bp">self</span><span class="o">.</span><span class="n">output</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">'export </span><span class="si">%s</span><span class="s1">="</span><span class="si">%s</span><span class="s1">"</span><span class="se">\n</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span></div>
<div class="viewcode-block" id="BashFileEnviron.command_value"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.BashFileEnviron.command_value">[docs]</a> <span class="k">def</span> <span class="nf">command_value</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">command</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Get the value given by the system command "command" </span>
-<span class="sd"> and put it in the environment variable key.</span>
-<span class="sd"> Has to be overwritten in the derived classes</span>
-<span class="sd"> This can be seen as a virtual method</span>
+ <span class="sd">'''Get the value given by the system command "command" </span>
+<span class="sd"> and put it in the environment variable key.</span>
+<span class="sd"> Has to be overwritten in the derived classes</span>
+<span class="sd"> This can be seen as a virtual method</span>
<span class="sd"> </span>
<span class="sd"> :param key str: the environment variable</span>
<span class="sd"> :param command str: the command to execute</span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="bp">self</span><span class="o">.</span><span class="n">output</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">'export </span><span class="si">%s</span><span class="s1">=$(</span><span class="si">%s</span><span class="s1">)</span><span class="se">\n</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">command</span><span class="p">))</span></div>
<div class="viewcode-block" id="BashFileEnviron.finish"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.BashFileEnviron.finish">[docs]</a> <span class="k">def</span> <span class="nf">finish</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">required</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
<span class="n">FileEnviron</span><span class="o">.</span><span class="n">finish</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">required</span><span class="p">)</span></div></div>
<div class="viewcode-block" id="BatFileEnviron"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.BatFileEnviron">[docs]</a><span class="k">class</span> <span class="nc">BatFileEnviron</span><span class="p">(</span><span class="n">FileEnviron</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> for Windows batch shell.</span>
+ <span class="sd">"""for Windows batch shell.</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">output</span><span class="p">,</span> <span class="n">environ</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""Initialization</span>
<span class="bp">self</span><span class="o">.</span><span class="n">output</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">"rem </span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span> <span class="n">comment</span><span class="p">)</span></div>
<div class="viewcode-block" id="BatFileEnviron.get"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.BatFileEnviron.get">[docs]</a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span>
- <span class="sd">"""Get the value of the environment variable "key"</span>
+ <span class="sd">'''Get the value of the environment variable "key"</span>
<span class="sd"> </span>
<span class="sd"> :param key str: the environment variable</span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="k">return</span> <span class="s1">'</span><span class="si">%%%s%%</span><span class="s1">'</span> <span class="o">%</span> <span class="n">key</span></div>
<div class="viewcode-block" id="BatFileEnviron.set"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.BatFileEnviron.set">[docs]</a> <span class="k">def</span> <span class="nf">set</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
- <span class="sd">"""Set the environment variable "key" to value "value"</span>
+ <span class="sd">'''Set the environment variable "key" to value "value"</span>
<span class="sd"> </span>
<span class="sd"> :param key str: the environment variable to set</span>
<span class="sd"> :param value str: the value</span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="bp">self</span><span class="o">.</span><span class="n">output</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">'set </span><span class="si">%s</span><span class="s1">=</span><span class="si">%s</span><span class="se">\n</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span></div>
<div class="viewcode-block" id="BatFileEnviron.command_value"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.BatFileEnviron.command_value">[docs]</a> <span class="k">def</span> <span class="nf">command_value</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">command</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Get the value given by the system command "command" </span>
-<span class="sd"> and put it in the environment variable key.</span>
-<span class="sd"> Has to be overwritten in the derived classes</span>
-<span class="sd"> This can be seen as a virtual method</span>
+ <span class="sd">'''Get the value given by the system command "command" </span>
+<span class="sd"> and put it in the environment variable key.</span>
+<span class="sd"> Has to be overwritten in the derived classes</span>
+<span class="sd"> This can be seen as a virtual method</span>
<span class="sd"> </span>
<span class="sd"> :param key str: the environment variable</span>
<span class="sd"> :param command str: the command to execute</span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="bp">self</span><span class="o">.</span><span class="n">output</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">'</span><span class="si">%s</span><span class="s1"> > tmp.txt</span><span class="se">\n</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">command</span><span class="p">))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">output</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">'set /p </span><span class="si">%s</span><span class="s1"> =< tmp.txt</span><span class="se">\n</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">key</span><span class="p">))</span></div>
<div class="viewcode-block" id="BatFileEnviron.finish"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.BatFileEnviron.finish">[docs]</a> <span class="k">def</span> <span class="nf">finish</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">required</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Add a final instruction in the out file (in case of file generation)</span>
-<span class="sd"> In the particular windows case, do nothing</span>
+ <span class="sd">"""Add a final instruction in the out file (in case of file generation)</span>
+<span class="sd"> In the particular windows case, do nothing</span>
<span class="sd"> </span>
<span class="sd"> :param required bool: Do nothing if required is False</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">output</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">cfg_header</span><span class="p">)</span>
<div class="viewcode-block" id="ContextFileEnviron.set"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.ContextFileEnviron.set">[docs]</a> <span class="k">def</span> <span class="nf">set</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
- <span class="sd">"""Set the environment variable "key" to value "value"</span>
+ <span class="sd">'''Set the environment variable "key" to value "value"</span>
<span class="sd"> </span>
<span class="sd"> :param key str: the environment variable to set</span>
<span class="sd"> :param value str: the value</span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="bp">self</span><span class="o">.</span><span class="n">output</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">'</span><span class="si">%s</span><span class="s1">="</span><span class="si">%s</span><span class="s1">"</span><span class="se">\n</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span></div>
<div class="viewcode-block" id="ContextFileEnviron.get"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.ContextFileEnviron.get">[docs]</a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span>
- <span class="sd">"""Get the value of the environment variable "key"</span>
+ <span class="sd">'''Get the value of the environment variable "key"</span>
<span class="sd"> </span>
<span class="sd"> :param key str: the environment variable</span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="k">return</span> <span class="s1">'%(</span><span class="si">{0}</span><span class="s1">)s'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">key</span><span class="p">)</span></div>
<div class="viewcode-block" id="ContextFileEnviron.command_value"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.ContextFileEnviron.command_value">[docs]</a> <span class="k">def</span> <span class="nf">command_value</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">command</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Get the value given by the system command "command" </span>
-<span class="sd"> and put it in the environment variable key.</span>
-<span class="sd"> Has to be overwritten in the derived classes</span>
-<span class="sd"> This can be seen as a virtual method</span>
+ <span class="sd">'''Get the value given by the system command "command" </span>
+<span class="sd"> and put it in the environment variable key.</span>
+<span class="sd"> Has to be overwritten in the derived classes</span>
+<span class="sd"> This can be seen as a virtual method</span>
<span class="sd"> </span>
<span class="sd"> :param key str: the environment variable</span>
<span class="sd"> :param command str: the command to execute</span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="s2">"command_value is not implement "</span>
<span class="s2">"for salome context files!"</span><span class="p">)</span></div>
<span class="bp">self</span><span class="o">.</span><span class="n">add_comment</span><span class="p">(</span><span class="s2">"WARNING </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="n">warning</span><span class="p">)</span></div>
<div class="viewcode-block" id="ContextFileEnviron.prepend_value"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.ContextFileEnviron.prepend_value">[docs]</a> <span class="k">def</span> <span class="nf">prepend_value</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">sep</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">pathsep</span><span class="p">):</span>
- <span class="sd">"""prepend value to key using sep</span>
+ <span class="sd">'''prepend value to key using sep</span>
<span class="sd"> </span>
<span class="sd"> :param key str: the environment variable to prepend</span>
<span class="sd"> :param value str: the value to prepend to key</span>
<span class="sd"> :param sep str: the separator string</span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="bp">self</span><span class="o">.</span><span class="n">output</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">'ADD_TO_</span><span class="si">%s</span><span class="s1">: </span><span class="si">%s</span><span class="se">\n</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">))</span></div>
<div class="viewcode-block" id="ContextFileEnviron.append_value"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.ContextFileEnviron.append_value">[docs]</a> <span class="k">def</span> <span class="nf">append_value</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">sep</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">pathsep</span><span class="p">):</span>
- <span class="sd">"""append value to key using sep</span>
+ <span class="sd">'''append value to key using sep</span>
<span class="sd"> </span>
<span class="sd"> :param key str: the environment variable to append</span>
<span class="sd"> :param value str: the value to append to key</span>
<span class="sd"> :param sep str: the separator string</span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="bp">self</span><span class="o">.</span><span class="n">prepend_value</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span></div>
<div class="viewcode-block" id="ContextFileEnviron.finish"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.ContextFileEnviron.finish">[docs]</a> <span class="k">def</span> <span class="nf">finish</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">required</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
<span class="k">return</span></div></div>
<div class="viewcode-block" id="special_path_separator"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.special_path_separator">[docs]</a><span class="k">def</span> <span class="nf">special_path_separator</span><span class="p">(</span><span class="n">name</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> TCLLIBPATH, TKLIBPATH, PV_PLUGIN_PATH environments variables need</span>
-<span class="sd"> some exotic path separator.</span>
-<span class="sd"> This function gives the separator regarding the name of the variable</span>
-<span class="sd"> to append or prepend.</span>
+ <span class="sd">"""TCLLIBPATH, TKLIBPATH, PV_PLUGIN_PATH environments variables need</span>
+<span class="sd"> some exotic path separator.</span>
+<span class="sd"> This function gives the separator regarding the name of the variable</span>
+<span class="sd"> to append or prepend.</span>
<span class="sd"> </span>
<span class="sd"> :param name str: The name of the variable to find the separator</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="n">res</span></div>
<div class="viewcode-block" id="LauncherFileEnviron"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron">[docs]</a><span class="k">class</span> <span class="nc">LauncherFileEnviron</span><span class="p">:</span>
- <span class="sd">"""\</span>
-<span class="sd"> Class to generate a launcher file script </span>
-<span class="sd"> (in python syntax) SalomeContext API</span>
+ <span class="sd">"""Class to generate a launcher file script </span>
+<span class="sd"> (in python syntax) SalomeContext API</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">output</span><span class="p">,</span> <span class="n">environ</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""Initialization</span>
<span class="s2">"PYTHONPATH"</span><span class="p">:</span> <span class="s2">"PythonPath"</span><span class="p">}</span>
<div class="viewcode-block" id="LauncherFileEnviron.change_to_launcher"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.change_to_launcher">[docs]</a> <span class="k">def</span> <span class="nf">change_to_launcher</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> """</span>
<span class="n">res</span><span class="o">=</span><span class="n">value</span>
<span class="k">return</span> <span class="n">res</span></div>
<span class="bp">self</span><span class="o">.</span><span class="n">output</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">'# "WARNING </span><span class="si">%s</span><span class="s1">"</span><span class="se">\n</span><span class="s1">'</span> <span class="o">%</span> <span class="n">warning</span><span class="p">)</span></div>
<div class="viewcode-block" id="LauncherFileEnviron.append_value"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.append_value">[docs]</a> <span class="k">def</span> <span class="nf">append_value</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">sep</span><span class="o">=</span><span class="s2">":"</span><span class="p">):</span>
- <span class="sd">"""append value to key using sep</span>
+ <span class="sd">'''append value to key using sep</span>
<span class="sd"> </span>
<span class="sd"> :param key str: the environment variable to append</span>
<span class="sd"> :param value str: the value to append to key</span>
<span class="sd"> :param sep str: the separator string</span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_defined</span><span class="p">(</span><span class="n">key</span><span class="p">)</span> <span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
<span class="k">else</span> <span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span></div>
<div class="viewcode-block" id="LauncherFileEnviron.append"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.append">[docs]</a> <span class="k">def</span> <span class="nf">append</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">sep</span><span class="o">=</span><span class="s2">":"</span><span class="p">):</span>
- <span class="sd">"""Same as append_value but the value argument can be a list</span>
+ <span class="sd">'''Same as append_value but the value argument can be a list</span>
<span class="sd"> </span>
<span class="sd"> :param key str: the environment variable to append</span>
<span class="sd"> :param value str or list: the value(s) to append to key</span>
<span class="sd"> :param sep str: the separator string</span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">list</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">append_value</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">sep</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">value</span><span class="p">),</span> <span class="n">sep</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">append_value</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">sep</span><span class="p">)</span></div>
<div class="viewcode-block" id="LauncherFileEnviron.prepend_value"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.prepend_value">[docs]</a> <span class="k">def</span> <span class="nf">prepend_value</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">sep</span><span class="o">=</span><span class="s2">":"</span><span class="p">):</span>
- <span class="sd">"""prepend value to key using sep</span>
+ <span class="sd">'''prepend value to key using sep</span>
<span class="sd"> </span>
<span class="sd"> :param key str: the environment variable to prepend</span>
<span class="sd"> :param value str: the value to prepend to key</span>
<span class="sd"> :param sep str: the separator string</span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_defined</span><span class="p">(</span><span class="n">key</span><span class="p">)</span> <span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
<span class="k">else</span> <span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span></div>
<div class="viewcode-block" id="LauncherFileEnviron.prepend"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.prepend">[docs]</a> <span class="k">def</span> <span class="nf">prepend</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">sep</span><span class="o">=</span><span class="s2">":"</span><span class="p">):</span>
- <span class="sd">"""Same as prepend_value but the value argument can be a list</span>
+ <span class="sd">'''Same as prepend_value but the value argument can be a list</span>
<span class="sd"> </span>
<span class="sd"> :param key str: the environment variable to prepend</span>
<span class="sd"> :param value str or list: the value(s) to prepend to key</span>
<span class="sd"> :param sep str: the separator string</span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">list</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">prepend_value</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">sep</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">value</span><span class="p">),</span> <span class="n">sep</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">prepend_value</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">sep</span><span class="p">)</span></div>
<div class="viewcode-block" id="LauncherFileEnviron.is_defined"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.is_defined">[docs]</a> <span class="k">def</span> <span class="nf">is_defined</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span>
- <span class="sd">"""Check if the key exists in the environment</span>
+ <span class="sd">'''Check if the key exists in the environment</span>
<span class="sd"> </span>
<span class="sd"> :param key str: the environment variable to check</span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="k">return</span> <span class="n">key</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">keys</span><span class="p">()</span></div>
<div class="viewcode-block" id="LauncherFileEnviron.get"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.get">[docs]</a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span>
- <span class="sd">"""Get the value of the environment variable "key"</span>
+ <span class="sd">'''Get the value of the environment variable "key"</span>
<span class="sd"> </span>
<span class="sd"> :param key str: the environment variable</span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="k">return</span> <span class="s1">'${</span><span class="si">%s</span><span class="s1">}'</span> <span class="o">%</span> <span class="n">key</span></div>
<div class="viewcode-block" id="LauncherFileEnviron.set"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.set">[docs]</a> <span class="k">def</span> <span class="nf">set</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
- <span class="sd">"""Set the environment variable "key" to value "value"</span>
+ <span class="sd">'''Set the environment variable "key" to value "value"</span>
<span class="sd"> </span>
<span class="sd"> :param key str: the environment variable to set</span>
<span class="sd"> :param value str: the value</span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="bp">self</span><span class="o">.</span><span class="n">output</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">begin</span><span class="o">+</span><span class="bp">self</span><span class="o">.</span><span class="n">setVarEnv</span><span class="o">+</span>
<span class="s1">'(r"</span><span class="si">%s</span><span class="s1">", r"</span><span class="si">%s</span><span class="s1">", overwrite=True)</span><span class="se">\n</span><span class="s1">'</span> <span class="o">%</span>
<span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">change_to_launcher</span><span class="p">(</span><span class="n">value</span><span class="p">)))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span></div>
<div class="viewcode-block" id="LauncherFileEnviron.add"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.add">[docs]</a> <span class="k">def</span> <span class="nf">add</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
- <span class="sd">"""prepend value to key using sep</span>
+ <span class="sd">'''prepend value to key using sep</span>
<span class="sd"> </span>
<span class="sd"> :param key str: the environment variable to prepend</span>
<span class="sd"> :param value str: the value to prepend to key</span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="k">if</span> <span class="n">key</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">specialKeys</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
<span class="bp">self</span><span class="o">.</span><span class="n">output</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">begin</span><span class="o">+</span><span class="s1">'addTo</span><span class="si">%s</span><span class="s1">(r"</span><span class="si">%s</span><span class="s1">")</span><span class="se">\n</span><span class="s1">'</span> <span class="o">%</span>
<span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">specialKeys</span><span class="p">[</span><span class="n">key</span><span class="p">],</span>
<span class="bp">self</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="n">key</span><span class="p">]</span><span class="o">+=</span><span class="n">sep</span><span class="o">+</span><span class="n">value</span> <span class="c1">#here yes we know os for current execution</span></div>
<div class="viewcode-block" id="LauncherFileEnviron.command_value"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.command_value">[docs]</a> <span class="k">def</span> <span class="nf">command_value</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">command</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Get the value given by the system command "command" </span>
-<span class="sd"> and put it in the environment variable key.</span>
+ <span class="sd">'''Get the value given by the system command "command" </span>
+<span class="sd"> and put it in the environment variable key.</span>
<span class="sd"> </span>
<span class="sd"> :param key str: the environment variable</span>
<span class="sd"> :param command str: the command to execute</span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="bp">self</span><span class="o">.</span><span class="n">output</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">indent</span><span class="o">+</span><span class="s1">'#`</span><span class="si">%s</span><span class="s1">`</span><span class="se">\n</span><span class="s1">'</span> <span class="o">%</span> <span class="n">command</span><span class="p">)</span>
<span class="kn">import</span> <span class="nn">shlex</span><span class="o">,</span> <span class="nn">subprocess</span>
<span class="bp">self</span><span class="o">.</span><span class="n">output</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">indent</span><span class="o">+</span><span class="s2">"# </span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span> <span class="n">comment</span><span class="p">)</span></div>
<div class="viewcode-block" id="LauncherFileEnviron.finish"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.finish">[docs]</a> <span class="k">def</span> <span class="nf">finish</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">required</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Add a final instruction in the out file (in case of file generation)</span>
-<span class="sd"> In the particular launcher case, do nothing</span>
+ <span class="sd">"""Add a final instruction in the out file (in case of file generation)</span>
+<span class="sd"> In the particular launcher case, do nothing</span>
<span class="sd"> </span>
<span class="sd"> :param required bool: Do nothing if required is False</span>
<span class="sd"> """</span>
<div class="viewcode-block" id="ScreenEnviron.write"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.ScreenEnviron.write">[docs]</a> <span class="k">def</span> <span class="nf">write</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">command</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">sign</span><span class="o">=</span><span class="s2">"="</span><span class="p">):</span>
<span class="kn">import</span> <span class="nn">src</span>
<span class="bp">self</span><span class="o">.</span><span class="n">output</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">" </span><span class="si">%s%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="se">\n</span><span class="s2">"</span> <span class="o">%</span> \
- <span class="p">(</span><span class="n">src</span><span class="o">.</span><span class="n">printcolors</span><span class="o">.</span><span class="n">printcLabel</span><span class="p">(</span><span class="n">command</span><span class="p">),</span>
+ <span class="p">(</span><span class="n">UTS</span><span class="o">.</span><span class="n">label</span><span class="p">(</span><span class="n">command</span><span class="p">),</span>
<span class="s2">" "</span> <span class="o">*</span> <span class="p">(</span><span class="mi">12</span> <span class="o">-</span> <span class="nb">len</span><span class="p">(</span><span class="n">command</span><span class="p">)),</span>
- <span class="n">src</span><span class="o">.</span><span class="n">printcolors</span><span class="o">.</span><span class="n">printcInfo</span><span class="p">(</span><span class="n">name</span><span class="p">),</span> <span class="n">sign</span><span class="p">,</span> <span class="n">value</span><span class="p">))</span></div>
+ <span class="n">UTS</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="n">name</span><span class="p">),</span> <span class="n">sign</span><span class="p">,</span> <span class="n">value</span><span class="p">))</span></div>
<div class="viewcode-block" id="ScreenEnviron.is_defined"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fileEnviron.ScreenEnviron.is_defined">[docs]</a> <span class="k">def</span> <span class="nf">is_defined</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">defined</span><span class="o">.</span><span class="n">has_key</span><span class="p">(</span><span class="n">name</span><span class="p">)</span></div>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">"load"</span><span class="p">,</span> <span class="n">script</span><span class="p">,</span> <span class="s2">""</span><span class="p">,</span> <span class="n">sign</span><span class="o">=</span><span class="s2">""</span><span class="p">)</span></div></div>
<span class="c1"># The SALOME launcher template </span>
-<span class="n">withProfile</span> <span class="o">=</span> <span class="s2">"""</span><span class="se">\</span>
-<span class="s2">#! /usr/bin/env python</span>
+<span class="n">withProfile</span> <span class="o">=</span> <span class="s2">"""#! /usr/bin/env python</span>
<span class="s2">################################################################</span>
<span class="s2"># WARNING: this file is automatically generated by SalomeTools #</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"> 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"> 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"> context.runSalome(args)</span>
<span class="s2"> #print 'Thank you for using SALOME!'</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"> "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>
</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" />
+ <div><input type="text" name="q" /></div>
+ <div><input type="submit" value="Go" /></div>
<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>
©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>
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.9</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
</div>
-
<!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.fork — salomeTools 5.0.0dev documentation</title>
+
<link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
- <script type="text/javascript" src="../../_static/documentation_options.js"></script>
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
- <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/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="top" title="salomeTools 5.0.0dev documentation" href="../../index.html" />
+ <link rel="up" title="Module code" href="../index.html" />
<link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
- </head><body>
+ </head>
+ <body role="document">
<div class="document">
<span class="kn">import</span> <span class="nn">pickle</span>
<span class="kn">import</span> <span class="nn">subprocess</span>
+
<div class="viewcode-block" id="show_progress"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fork.show_progress">[docs]</a><span class="k">def</span> <span class="nf">show_progress</span><span class="p">(</span><span class="n">logger</span><span class="p">,</span> <span class="n">top</span><span class="p">,</span> <span class="n">delai</span><span class="p">,</span> <span class="n">ss</span><span class="o">=</span><span class="s2">""</span><span class="p">):</span>
<span class="sd">"""shortcut function to display the progression</span>
<span class="sd"> </span>
<span class="sd"> :param delai int: the number max</span>
<span class="sd"> :param ss str: the string to display</span>
<span class="sd"> """</span>
- <span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">"</span><span class="se">\r</span><span class="si">%s</span><span class="se">\r</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="s2">" "</span> <span class="o">*</span> <span class="mi">30</span><span class="p">),</span> <span class="n">ss</span><span class="p">,</span> <span class="n">top</span><span class="p">,</span> <span class="p">(</span><span class="n">delai</span> <span class="o">-</span> <span class="n">top</span><span class="p">)),</span> <span class="mi">4</span><span class="p">,</span>
- <span class="kc">False</span><span class="p">)</span>
- <span class="n">logger</span><span class="o">.</span><span class="n">flush</span><span class="p">()</span></div>
+ <span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">"</span><span class="se">\r</span><span class="si">%s</span><span class="se">\r</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="s2">" "</span> <span class="o">*</span> <span class="mi">30</span><span class="p">),</span> <span class="n">ss</span><span class="p">,</span> <span class="n">top</span><span class="p">,</span> <span class="p">(</span><span class="n">delai</span> <span class="o">-</span> <span class="n">top</span><span class="p">)))</span></div>
-<div class="viewcode-block" id="write_back"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fork.write_back">[docs]</a><span class="k">def</span> <span class="nf">write_back</span><span class="p">(</span><span class="n">logger</span><span class="p">,</span> <span class="n">message</span><span class="p">,</span> <span class="n">level</span><span class="p">):</span>
+
+<div class="viewcode-block" id="write_back"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fork.write_back">[docs]</a><span class="k">def</span> <span class="nf">write_back</span><span class="p">(</span><span class="n">logger</span><span class="p">,</span> <span class="n">message</span><span class="p">):</span>
<span class="sd">"""shortcut function to write at the begin of the line</span>
<span class="sd"> </span>
<span class="sd"> :param logger Logger: The logging instance</span>
<span class="sd"> :param message str: the text to display</span>
<span class="sd"> :param level int: the level of verbosity</span>
<span class="sd"> """</span>
- <span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">"</span><span class="se">\r</span><span class="si">%s</span><span class="se">\r</span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="p">((</span><span class="s2">" "</span> <span class="o">*</span> <span class="mi">40</span><span class="p">),</span> <span class="n">message</span><span class="p">),</span> <span class="n">level</span><span class="p">)</span></div>
+ <span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">"</span><span class="se">\r</span><span class="si">%s</span><span class="se">\r</span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="p">((</span><span class="s2">" "</span> <span class="o">*</span> <span class="mi">40</span><span class="p">),</span> <span class="n">message</span><span class="p">))</span></div>
+
-<span class="c1"># Launch command</span>
-<span class="c1"># --------------</span>
<div class="viewcode-block" id="launch_command"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fork.launch_command">[docs]</a><span class="k">def</span> <span class="nf">launch_command</span><span class="p">(</span><span class="n">cmd</span><span class="p">,</span> <span class="n">logger</span><span class="p">,</span> <span class="n">cwd</span><span class="p">,</span> <span class="n">args</span><span class="o">=</span><span class="p">[],</span> <span class="n">log</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
+ <span class="sd">"""Launch command"""</span>
<span class="k">if</span> <span class="n">log</span><span class="p">:</span>
<span class="n">log</span> <span class="o">=</span> <span class="n">file</span><span class="p">(</span><span class="n">log</span><span class="p">,</span> <span class="s2">"a"</span><span class="p">)</span>
- <span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">"launch: </span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span> <span class="n">cmd</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="n">screenOnly</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">"launch: </span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span> <span class="n">cmd</span><span class="p">)</span>
<span class="k">for</span> <span class="n">arg</span> <span class="ow">in</span> <span class="n">args</span><span class="p">:</span>
<span class="n">cmd</span> <span class="o">+=</span> <span class="s2">" "</span> <span class="o">+</span> <span class="n">arg</span>
<span class="n">prs</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">Popen</span><span class="p">(</span><span class="n">cmd</span><span class="p">,</span>
<span class="n">executable</span><span class="o">=</span><span class="s1">'/bin/bash'</span><span class="p">)</span>
<span class="k">return</span> <span class="n">prs</span></div>
-<span class="c1"># Launch a batch</span>
-<span class="c1"># --------------</span>
+
<div class="viewcode-block" id="batch"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fork.batch">[docs]</a><span class="k">def</span> <span class="nf">batch</span><span class="p">(</span><span class="n">cmd</span><span class="p">,</span> <span class="n">logger</span><span class="p">,</span> <span class="n">cwd</span><span class="p">,</span> <span class="n">args</span><span class="o">=</span><span class="p">[],</span> <span class="n">log</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">delai</span><span class="o">=</span><span class="mi">20</span><span class="p">,</span> <span class="n">sommeil</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
+ <span class="sd">"""Launch a batch"""</span>
<span class="n">proc</span> <span class="o">=</span> <span class="n">launch_command</span><span class="p">(</span><span class="n">cmd</span><span class="p">,</span> <span class="n">logger</span><span class="p">,</span> <span class="n">cwd</span><span class="p">,</span> <span class="n">args</span><span class="p">,</span> <span class="n">log</span><span class="p">)</span>
<span class="n">top</span> <span class="o">=</span> <span class="mi">0</span>
<span class="n">sys</span><span class="o">.</span><span class="n">stdout</span><span class="o">.</span><span class="n">softspace</span> <span class="o">=</span> <span class="kc">True</span>
<span class="k">if</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span> <span class="o">-</span> <span class="n">begin</span> <span class="o">>=</span> <span class="mi">1</span><span class="p">:</span>
<span class="n">show_progress</span><span class="p">(</span><span class="n">logger</span><span class="p">,</span> <span class="n">top</span><span class="p">,</span> <span class="n">delai</span><span class="p">,</span> <span class="s2">"batch:"</span><span class="p">)</span>
<span class="k">if</span> <span class="n">top</span> <span class="o">==</span> <span class="n">delai</span><span class="p">:</span>
- <span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">"batch: time out KILL</span><span class="se">\n</span><span class="s2">"</span><span class="p">,</span> <span class="mi">3</span><span class="p">)</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">"batch: time out KILL"</span><span class="p">)</span>
<span class="kn">import</span> <span class="nn">signal</span>
<span class="n">os</span><span class="o">.</span><span class="n">kill</span><span class="p">(</span><span class="n">proc</span><span class="o">.</span><span class="n">pid</span><span class="p">,</span> <span class="n">signal</span><span class="o">.</span><span class="n">SIGTERM</span><span class="p">)</span>
<span class="k">break</span>
<span class="n">top</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="n">sys</span><span class="o">.</span><span class="n">stdout</span><span class="o">.</span><span class="n">flush</span><span class="p">()</span>
<span class="k">else</span><span class="p">:</span>
- <span class="n">write_back</span><span class="p">(</span><span class="n">logger</span><span class="p">,</span> <span class="s2">"batch: exit (</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="nb">str</span><span class="p">(</span><span class="n">proc</span><span class="o">.</span><span class="n">returncode</span><span class="p">),</span> <span class="mi">5</span><span class="p">)</span>
+ <span class="n">write_back</span><span class="p">(</span><span class="n">logger</span><span class="p">,</span> <span class="s2">"batch: exit (</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="nb">str</span><span class="p">(</span><span class="n">proc</span><span class="o">.</span><span class="n">returncode</span><span class="p">))</span>
<span class="k">return</span> <span class="p">(</span><span class="n">proc</span><span class="o">.</span><span class="n">returncode</span> <span class="o">==</span> <span class="mi">0</span><span class="p">),</span> <span class="n">top</span></div>
-<span class="c1"># Launch a salome process</span>
-<span class="c1"># -----------------------</span>
+
<div class="viewcode-block" id="batch_salome"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.fork.batch_salome">[docs]</a><span class="k">def</span> <span class="nf">batch_salome</span><span class="p">(</span><span class="n">cmd</span><span class="p">,</span> <span class="n">logger</span><span class="p">,</span> <span class="n">cwd</span><span class="p">,</span> <span class="n">args</span><span class="p">,</span> <span class="n">getTmpDir</span><span class="p">,</span>
<span class="n">pendant</span><span class="o">=</span><span class="s2">"SALOME_Session_Server"</span><span class="p">,</span> <span class="n">fin</span><span class="o">=</span><span class="s2">"killSalome.py"</span><span class="p">,</span>
<span class="n">log</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">delai</span><span class="o">=</span><span class="mi">20</span><span class="p">,</span> <span class="n">sommeil</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">delaiapp</span><span class="o">=</span><span class="mi">0</span><span class="p">):</span>
+ <span class="sd">"""Launch a salome process"""</span>
<span class="n">beginTime</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span>
<span class="n">launch_command</span><span class="p">(</span><span class="n">cmd</span><span class="p">,</span> <span class="n">logger</span><span class="p">,</span> <span class="n">cwd</span><span class="p">,</span> <span class="n">args</span><span class="p">,</span> <span class="n">log</span><span class="p">)</span>
<span class="k">if</span> <span class="n">found</span><span class="p">:</span>
<span class="n">write_back</span><span class="p">(</span><span class="n">logger</span><span class="p">,</span> <span class="s2">"batch_salome: started</span><span class="se">\n</span><span class="s2">"</span><span class="p">,</span> <span class="mi">5</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
- <span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">"batch_salome: FAILED to launch salome or appli</span><span class="se">\n</span><span class="s2">"</span><span class="p">,</span> <span class="mi">3</span><span class="p">)</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="s2">"batch_salome: FAILED to launch salome or appli"</span><span class="p">)</span>
<span class="k">return</span> <span class="kc">False</span><span class="p">,</span> <span class="o">-</span><span class="mi">1</span>
<span class="c1"># salome launched run the script</span>
<span class="n">show_progress</span><span class="p">(</span><span class="n">logger</span><span class="p">,</span> <span class="n">top</span><span class="p">,</span> <span class="n">delai</span><span class="p">,</span> <span class="s2">"running salome or appli:"</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">access</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">tmp_dir</span><span class="p">,</span> <span class="n">pidictFile</span><span class="p">),</span> <span class="n">os</span><span class="o">.</span><span class="n">F_OK</span><span class="p">):</span>
- <span class="n">write_back</span><span class="p">(</span><span class="n">logger</span><span class="p">,</span> <span class="s2">"batch_salome: exit</span><span class="se">\n</span><span class="s2">"</span><span class="p">,</span> <span class="mi">5</span><span class="p">)</span>
+ <span class="n">write_back</span><span class="p">(</span><span class="n">logger</span><span class="p">,</span> <span class="s2">"batch_salome: exit"</span><span class="p">)</span>
<span class="n">code</span> <span class="o">=</span> <span class="kc">True</span>
<span class="k">elif</span> <span class="n">top</span> <span class="o">>=</span> <span class="n">delai</span><span class="p">:</span>
<span class="c1"># timeout kill the test</span>
<span class="n">os</span><span class="o">.</span><span class="n">system</span><span class="p">(</span><span class="n">fin</span><span class="p">)</span>
- <span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">"batch_salome: time out KILL</span><span class="se">\n</span><span class="s2">"</span><span class="p">,</span> <span class="mi">3</span><span class="p">)</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">"batch_salome: time out KILL"</span><span class="p">)</span>
<span class="n">code</span> <span class="o">=</span> <span class="kc">False</span>
<span class="k">else</span><span class="p">:</span>
<span class="c1"># still waiting</span>
</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" />
+ <div><input type="text" name="q" /></div>
+ <div><input type="submit" value="Go" /></div>
<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>
©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>
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.9</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
</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.logger — salomeTools 5.0.0dev documentation</title>
- <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
- <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
- <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.logger</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-2012 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">Implements the classes and method relative to the logging</span>
-<span class="sd">"""</span>
-
-<span class="kn">import</span> <span class="nn">sys</span>
-<span class="kn">import</span> <span class="nn">os</span>
-<span class="kn">import</span> <span class="nn">datetime</span>
-<span class="kn">import</span> <span class="nn">re</span>
-<span class="kn">import</span> <span class="nn">tempfile</span>
-
-<span class="kn">import</span> <span class="nn">src</span>
-<span class="kn">from</span> <span class="nn">.</span> <span class="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">xmlManager</span>
-
-<span class="n">log_macro_command_file_expression</span> <span class="o">=</span> <span class="s2">"^[0-9]</span><span class="si">{8}</span><span class="s2">_+[0-9]</span><span class="si">{6}</span><span class="s2">_+.*\.xml$"</span>
-<span class="n">log_all_command_file_expression</span> <span class="o">=</span> <span class="s2">"^.*[0-9]</span><span class="si">{8}</span><span class="s2">_+[0-9]</span><span class="si">{6}</span><span class="s2">_+.*\.xml$"</span>
-
-<div class="viewcode-block" id="Logger"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.logger.Logger">[docs]</a><span class="k">class</span> <span class="nc">Logger</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Class to handle log mechanism.</span>
-<span class="sd"> """</span>
- <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
- <span class="n">config</span><span class="p">,</span>
- <span class="n">silent_sysstd</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
- <span class="n">all_in_terminal</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
- <span class="n">micro_command</span> <span class="o">=</span> <span class="kc">False</span><span class="p">):</span>
- <span class="sd">"""Initialization</span>
-<span class="sd"> </span>
-<span class="sd"> :param config pyconf.Config: The global configuration.</span>
-<span class="sd"> :param silent_sysstd boolean: if True, do not write anything</span>
-<span class="sd"> in terminal.</span>
-<span class="sd"> """</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">config</span> <span class="o">=</span> <span class="n">config</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">default_level</span> <span class="o">=</span> <span class="mi">3</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">silentSysStd</span> <span class="o">=</span> <span class="n">silent_sysstd</span>
-
- <span class="c1"># Construct xml log file location for sat prints.</span>
- <span class="n">prefix</span> <span class="o">=</span> <span class="s2">""</span>
- <span class="k">if</span> <span class="n">micro_command</span><span class="p">:</span>
- <span class="n">prefix</span> <span class="o">=</span> <span class="s2">"micro_"</span>
- <span class="n">hour_command_host</span> <span class="o">=</span> <span class="p">(</span><span class="n">config</span><span class="o">.</span><span class="n">VARS</span><span class="o">.</span><span class="n">datehour</span> <span class="o">+</span> <span class="s2">"_"</span> <span class="o">+</span>
- <span class="n">config</span><span class="o">.</span><span class="n">VARS</span><span class="o">.</span><span class="n">command</span> <span class="o">+</span> <span class="s2">"_"</span> <span class="o">+</span>
- <span class="n">config</span><span class="o">.</span><span class="n">VARS</span><span class="o">.</span><span class="n">hostname</span><span class="p">)</span>
- <span class="n">logFileName</span> <span class="o">=</span> <span class="n">prefix</span> <span class="o">+</span> <span class="n">hour_command_host</span> <span class="o">+</span> <span class="s2">".xml"</span>
- <span class="n">log_dir</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">get_log_path</span><span class="p">(</span><span class="n">config</span><span class="p">)</span>
- <span class="n">logFilePath</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">log_dir</span><span class="p">,</span> <span class="n">logFileName</span><span class="p">)</span>
- <span class="c1"># Construct txt file location in order to log </span>
- <span class="c1"># the external commands calls (cmake, make, git clone, etc...)</span>
- <span class="n">txtFileName</span> <span class="o">=</span> <span class="n">prefix</span> <span class="o">+</span> <span class="n">hour_command_host</span> <span class="o">+</span> <span class="s2">".txt"</span>
- <span class="n">txtFilePath</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">log_dir</span><span class="p">,</span> <span class="s2">"OUT"</span><span class="p">,</span> <span class="n">txtFileName</span><span class="p">)</span>
-
- <span class="n">src</span><span class="o">.</span><span class="n">ensure_path_exists</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="n">logFilePath</span><span class="p">))</span>
- <span class="n">src</span><span class="o">.</span><span class="n">ensure_path_exists</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="n">txtFilePath</span><span class="p">))</span>
-
- <span class="c1"># The path of the log files (one for sat traces, and the other for </span>
- <span class="c1"># the system commands traces)</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">logFileName</span> <span class="o">=</span> <span class="n">logFileName</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">logFilePath</span> <span class="o">=</span> <span class="n">logFilePath</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">txtFileName</span> <span class="o">=</span> <span class="n">txtFileName</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">txtFilePath</span> <span class="o">=</span> <span class="n">txtFilePath</span>
-
- <span class="c1"># The list of all log files corresponding to the current command and</span>
- <span class="c1"># the commands called by the current command</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">l_logFiles</span> <span class="o">=</span> <span class="p">[</span><span class="n">logFilePath</span><span class="p">,</span> <span class="n">txtFilePath</span><span class="p">]</span>
-
- <span class="c1"># Initialize xml instance and put first fields </span>
- <span class="c1"># like beginTime, user, command, etc... </span>
- <span class="bp">self</span><span class="o">.</span><span class="n">xmlFile</span> <span class="o">=</span> <span class="n">xmlManager</span><span class="o">.</span><span class="n">XmlLogFile</span><span class="p">(</span><span class="n">logFilePath</span><span class="p">,</span> <span class="s2">"SATcommand"</span><span class="p">,</span>
- <span class="n">attrib</span> <span class="o">=</span> <span class="p">{</span><span class="s2">"application"</span> <span class="p">:</span> <span class="n">config</span><span class="o">.</span><span class="n">VARS</span><span class="o">.</span><span class="n">application</span><span class="p">})</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">put_initial_xml_fields</span><span class="p">()</span>
- <span class="c1"># Initialize the txt file for reading</span>
- <span class="k">try</span><span class="p">:</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">logTxtFile</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">txtFilePath</span><span class="p">),</span> <span class="s1">'w'</span><span class="p">)</span>
- <span class="k">except</span> <span class="ne">IOError</span><span class="p">:</span>
- <span class="c1">#msg1 = _("WARNING! Trying to write to a file that"</span>
- <span class="c1"># " is not accessible:")</span>
- <span class="c1">#msg2 = _("The logs won't be written.")</span>
- <span class="c1">#print("%s\n%s\n%s\n" % (src.printcolors.printcWarning(msg1),</span>
- <span class="c1"># src.printcolors.printcLabel(str(self.txtFilePath)),</span>
- <span class="c1"># src.printcolors.printcWarning(msg2) ))</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">logTxtFile</span> <span class="o">=</span> <span class="n">tempfile</span><span class="o">.</span><span class="n">TemporaryFile</span><span class="p">()</span>
-
- <span class="c1"># If the option all_in_terminal was called, all the system commands</span>
- <span class="c1"># are redirected to the terminal</span>
- <span class="k">if</span> <span class="n">all_in_terminal</span><span class="p">:</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">logTxtFile</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">__stdout__</span>
-
-<div class="viewcode-block" id="Logger.put_initial_xml_fields"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.logger.Logger.put_initial_xml_fields">[docs]</a> <span class="k">def</span> <span class="nf">put_initial_xml_fields</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Called at class initialization: Put all fields </span>
-<span class="sd"> corresponding to the command context (user, time, ...)</span>
-<span class="sd"> """</span>
- <span class="c1"># command name</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">xmlFile</span><span class="o">.</span><span class="n">add_simple_node</span><span class="p">(</span><span class="s2">"Site"</span><span class="p">,</span> <span class="n">attrib</span><span class="o">=</span><span class="p">{</span><span class="s2">"command"</span> <span class="p">:</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">VARS</span><span class="o">.</span><span class="n">command</span><span class="p">})</span>
- <span class="c1"># version of salomeTools</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">xmlFile</span><span class="o">.</span><span class="n">append_node_attrib</span><span class="p">(</span><span class="s2">"Site"</span><span class="p">,</span> <span class="n">attrib</span><span class="o">=</span><span class="p">{</span><span class="s2">"satversion"</span> <span class="p">:</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">INTERNAL</span><span class="o">.</span><span class="n">sat_version</span><span class="p">})</span>
- <span class="c1"># machine name on which the command has been launched</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">xmlFile</span><span class="o">.</span><span class="n">append_node_attrib</span><span class="p">(</span><span class="s2">"Site"</span><span class="p">,</span> <span class="n">attrib</span><span class="o">=</span><span class="p">{</span><span class="s2">"hostname"</span> <span class="p">:</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">VARS</span><span class="o">.</span><span class="n">hostname</span><span class="p">})</span>
- <span class="c1"># Distribution of the machine</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">xmlFile</span><span class="o">.</span><span class="n">append_node_attrib</span><span class="p">(</span><span class="s2">"Site"</span><span class="p">,</span> <span class="n">attrib</span><span class="o">=</span><span class="p">{</span><span class="s2">"OS"</span> <span class="p">:</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">VARS</span><span class="o">.</span><span class="n">dist</span><span class="p">})</span>
- <span class="c1"># The user that have launched the command</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">xmlFile</span><span class="o">.</span><span class="n">append_node_attrib</span><span class="p">(</span><span class="s2">"Site"</span><span class="p">,</span> <span class="n">attrib</span><span class="o">=</span><span class="p">{</span><span class="s2">"user"</span> <span class="p">:</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">VARS</span><span class="o">.</span><span class="n">user</span><span class="p">})</span>
- <span class="c1"># The time when command was launched</span>
- <span class="n">Y</span><span class="p">,</span> <span class="n">m</span><span class="p">,</span> <span class="n">dd</span><span class="p">,</span> <span class="n">H</span><span class="p">,</span> <span class="n">M</span><span class="p">,</span> <span class="n">S</span> <span class="o">=</span> <span class="n">date_to_datetime</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">VARS</span><span class="o">.</span><span class="n">datehour</span><span class="p">)</span>
- <span class="n">date_hour</span> <span class="o">=</span> <span class="s2">"</span><span class="si">%2s</span><span class="s2">/</span><span class="si">%2s</span><span class="s2">/</span><span class="si">%4s</span><span class="s2"> </span><span class="si">%2s</span><span class="s2">h</span><span class="si">%2s</span><span class="s2">m</span><span class="si">%2s</span><span class="s2">s"</span> <span class="o">%</span> <span class="p">(</span><span class="n">dd</span><span class="p">,</span> <span class="n">m</span><span class="p">,</span> <span class="n">Y</span><span class="p">,</span> <span class="n">H</span><span class="p">,</span> <span class="n">M</span><span class="p">,</span> <span class="n">S</span><span class="p">)</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">xmlFile</span><span class="o">.</span><span class="n">append_node_attrib</span><span class="p">(</span><span class="s2">"Site"</span><span class="p">,</span> <span class="n">attrib</span><span class="o">=</span><span class="p">{</span><span class="s2">"beginTime"</span> <span class="p">:</span>
- <span class="n">date_hour</span><span class="p">})</span>
- <span class="c1"># The application if any</span>
- <span class="k">if</span> <span class="s2">"APPLICATION"</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="p">:</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">xmlFile</span><span class="o">.</span><span class="n">append_node_attrib</span><span class="p">(</span><span class="s2">"Site"</span><span class="p">,</span>
- <span class="n">attrib</span><span class="o">=</span><span class="p">{</span><span class="s2">"application"</span> <span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">VARS</span><span class="o">.</span><span class="n">application</span><span class="p">})</span>
- <span class="c1"># The initialization of the trace node</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">xmlFile</span><span class="o">.</span><span class="n">add_simple_node</span><span class="p">(</span><span class="s2">"Log"</span><span class="p">,</span><span class="n">text</span><span class="o">=</span><span class="s2">""</span><span class="p">)</span>
- <span class="c1"># The system commands logs</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">xmlFile</span><span class="o">.</span><span class="n">add_simple_node</span><span class="p">(</span><span class="s2">"OutLog"</span><span class="p">,</span>
- <span class="n">text</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="s2">"OUT"</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">txtFileName</span><span class="p">))</span>
- <span class="c1"># The initialization of the node where </span>
- <span class="c1"># to put the links to the other sat commands that can be called by any</span>
- <span class="c1"># command </span>
- <span class="bp">self</span><span class="o">.</span><span class="n">xmlFile</span><span class="o">.</span><span class="n">add_simple_node</span><span class="p">(</span><span class="s2">"Links"</span><span class="p">)</span></div>
-
-<div class="viewcode-block" id="Logger.add_link"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.logger.Logger.add_link">[docs]</a> <span class="k">def</span> <span class="nf">add_link</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
- <span class="n">log_file_name</span><span class="p">,</span>
- <span class="n">command_name</span><span class="p">,</span>
- <span class="n">command_res</span><span class="p">,</span>
- <span class="n">full_launched_command</span><span class="p">):</span>
- <span class="sd">"""Add a link to another log file.</span>
-<span class="sd"> </span>
-<span class="sd"> :param log_file_name str: The file name of the link.</span>
-<span class="sd"> :param command_name str: The name of the command linked.</span>
-<span class="sd"> :param command_res str: The result of the command linked. "0" or "1"</span>
-<span class="sd"> :parma full_launched_command str: The full lanch command </span>
-<span class="sd"> ("sat command ...")</span>
-<span class="sd"> """</span>
- <span class="n">xmlLinks</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">xmlFile</span><span class="o">.</span><span class="n">xmlroot</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="s2">"Links"</span><span class="p">)</span>
- <span class="n">src</span><span class="o">.</span><span class="n">xmlManager</span><span class="o">.</span><span class="n">add_simple_node</span><span class="p">(</span><span class="n">xmlLinks</span><span class="p">,</span>
- <span class="s2">"link"</span><span class="p">,</span>
- <span class="n">text</span> <span class="o">=</span> <span class="n">log_file_name</span><span class="p">,</span>
- <span class="n">attrib</span> <span class="o">=</span> <span class="p">{</span><span class="s2">"command"</span> <span class="p">:</span> <span class="n">command_name</span><span class="p">,</span>
- <span class="s2">"passed"</span> <span class="p">:</span> <span class="n">command_res</span><span class="p">,</span>
- <span class="s2">"launchedCommand"</span> <span class="p">:</span> <span class="n">full_launched_command</span><span class="p">})</span></div>
-
-<div class="viewcode-block" id="Logger.write"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.logger.Logger.write">[docs]</a> <span class="k">def</span> <span class="nf">write</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">message</span><span class="p">,</span> <span class="n">level</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">screenOnly</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> function used in the commands </span>
-<span class="sd"> to print in the terminal and the log file.</span>
-<span class="sd"> </span>
-<span class="sd"> :param message str: The message to print.</span>
-<span class="sd"> :param level int: The output level corresponding </span>
-<span class="sd"> to the message 0 < level < 6.</span>
-<span class="sd"> :param screenOnly boolean: if True, do not write in log file.</span>
-<span class="sd"> """</span>
- <span class="c1"># do not write message starting with \r to log file</span>
- <span class="k">if</span> <span class="ow">not</span> <span class="n">message</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s2">"</span><span class="se">\r</span><span class="s2">"</span><span class="p">)</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">screenOnly</span><span class="p">:</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">xmlFile</span><span class="o">.</span><span class="n">append_node_text</span><span class="p">(</span><span class="s2">"Log"</span><span class="p">,</span>
- <span class="n">printcolors</span><span class="o">.</span><span class="n">cleancolor</span><span class="p">(</span><span class="n">message</span><span class="p">))</span>
-
- <span class="c1"># get user or option output level</span>
- <span class="n">current_output_verbose_level</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">USER</span><span class="o">.</span><span class="n">output_verbose_level</span>
- <span class="k">if</span> <span class="ow">not</span> <span class="p">(</span><span class="s1">'isatty'</span> <span class="ow">in</span> <span class="nb">dir</span><span class="p">(</span><span class="n">sys</span><span class="o">.</span><span class="n">stdout</span><span class="p">)</span> <span class="ow">and</span> <span class="n">sys</span><span class="o">.</span><span class="n">stdout</span><span class="o">.</span><span class="n">isatty</span><span class="p">()):</span>
- <span class="c1"># clean the message color if the terminal is redirected by user</span>
- <span class="c1"># ex: sat compile appli > log.txt</span>
- <span class="n">message</span> <span class="o">=</span> <span class="n">printcolors</span><span class="o">.</span><span class="n">cleancolor</span><span class="p">(</span><span class="n">message</span><span class="p">)</span>
-
- <span class="c1"># Print message regarding the output level value</span>
- <span class="k">if</span> <span class="n">level</span><span class="p">:</span>
- <span class="k">if</span> <span class="n">level</span> <span class="o"><=</span> <span class="n">current_output_verbose_level</span> <span class="ow">and</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">silentSysStd</span><span class="p">:</span>
- <span class="n">sys</span><span class="o">.</span><span class="n">stdout</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">message</span><span class="p">)</span>
- <span class="k">else</span><span class="p">:</span>
- <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">default_level</span> <span class="o"><=</span> <span class="n">current_output_verbose_level</span> <span class="ow">and</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">silentSysStd</span><span class="p">:</span>
- <span class="n">sys</span><span class="o">.</span><span class="n">stdout</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">message</span><span class="p">)</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">flush</span><span class="p">()</span></div>
-
-<div class="viewcode-block" id="Logger.error"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.logger.Logger.error">[docs]</a> <span class="k">def</span> <span class="nf">error</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">message</span><span class="p">):</span>
- <span class="sd">"""Print an error.</span>
-<span class="sd"> </span>
-<span class="sd"> :param message str: The message to print.</span>
-<span class="sd"> """</span>
- <span class="c1"># Print in the log file</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">xmlFile</span><span class="o">.</span><span class="n">append_node_text</span><span class="p">(</span><span class="s2">"traces"</span><span class="p">,</span> <span class="n">_</span><span class="p">(</span><span class="s1">'ERROR:'</span><span class="p">)</span> <span class="o">+</span> <span class="n">message</span><span class="p">)</span>
-
- <span class="c1"># Print in the terminal and clean colors if the terminal </span>
- <span class="c1"># is redirected by user</span>
- <span class="k">if</span> <span class="ow">not</span> <span class="p">(</span><span class="s1">'isatty'</span> <span class="ow">in</span> <span class="nb">dir</span><span class="p">(</span><span class="n">sys</span><span class="o">.</span><span class="n">stderr</span><span class="p">)</span> <span class="ow">and</span> <span class="n">sys</span><span class="o">.</span><span class="n">stderr</span><span class="o">.</span><span class="n">isatty</span><span class="p">()):</span>
- <span class="n">sys</span><span class="o">.</span><span class="n">stderr</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">printcolors</span><span class="o">.</span><span class="n">printcError</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s1">'ERROR:'</span><span class="p">)</span> <span class="o">+</span> <span class="n">message</span><span class="p">))</span>
- <span class="k">else</span><span class="p">:</span>
- <span class="n">sys</span><span class="o">.</span><span class="n">stderr</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s1">'ERROR:'</span><span class="p">)</span> <span class="o">+</span> <span class="n">message</span><span class="p">)</span></div>
-
-<div class="viewcode-block" id="Logger.flush"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.logger.Logger.flush">[docs]</a> <span class="k">def</span> <span class="nf">flush</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
- <span class="sd">"""Flush terminal"""</span>
- <span class="n">sys</span><span class="o">.</span><span class="n">stdout</span><span class="o">.</span><span class="n">flush</span><span class="p">()</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">logTxtFile</span><span class="o">.</span><span class="n">flush</span><span class="p">()</span></div>
-
-<div class="viewcode-block" id="Logger.end_write"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.logger.Logger.end_write">[docs]</a> <span class="k">def</span> <span class="nf">end_write</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">attribute</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Called just after command end: Put all fields </span>
-<span class="sd"> corresponding to the command end context (time).</span>
-<span class="sd"> Write the log xml file on the hard drive.</span>
-<span class="sd"> And display the command to launch to get the log</span>
-<span class="sd"> </span>
-<span class="sd"> :param attribute dict: the attribute to add to the node "Site".</span>
-<span class="sd"> """</span>
- <span class="c1"># Get current time (end of command) and format it</span>
- <span class="n">dt</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">now</span><span class="p">()</span>
- <span class="n">Y</span><span class="p">,</span> <span class="n">m</span><span class="p">,</span> <span class="n">dd</span><span class="p">,</span> <span class="n">H</span><span class="p">,</span> <span class="n">M</span><span class="p">,</span> <span class="n">S</span> <span class="o">=</span> <span class="n">date_to_datetime</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">VARS</span><span class="o">.</span><span class="n">datehour</span><span class="p">)</span>
- <span class="n">t0</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="p">(</span><span class="nb">int</span><span class="p">(</span><span class="n">Y</span><span class="p">),</span> <span class="nb">int</span><span class="p">(</span><span class="n">m</span><span class="p">),</span> <span class="nb">int</span><span class="p">(</span><span class="n">dd</span><span class="p">),</span> <span class="nb">int</span><span class="p">(</span><span class="n">H</span><span class="p">),</span> <span class="nb">int</span><span class="p">(</span><span class="n">M</span><span class="p">),</span> <span class="nb">int</span><span class="p">(</span><span class="n">S</span><span class="p">))</span>
- <span class="n">tf</span> <span class="o">=</span> <span class="n">dt</span>
- <span class="n">delta</span> <span class="o">=</span> <span class="n">tf</span> <span class="o">-</span> <span class="n">t0</span>
- <span class="n">total_time</span> <span class="o">=</span> <span class="n">timedelta_total_seconds</span><span class="p">(</span><span class="n">delta</span><span class="p">)</span>
- <span class="n">hours</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">total_time</span> <span class="o">/</span> <span class="mi">3600</span><span class="p">)</span>
- <span class="n">minutes</span> <span class="o">=</span> <span class="nb">int</span><span class="p">((</span><span class="n">total_time</span> <span class="o">-</span> <span class="n">hours</span><span class="o">*</span><span class="mi">3600</span><span class="p">)</span> <span class="o">/</span> <span class="mi">60</span><span class="p">)</span>
- <span class="n">seconds</span> <span class="o">=</span> <span class="n">total_time</span> <span class="o">-</span> <span class="n">hours</span><span class="o">*</span><span class="mi">3600</span> <span class="o">-</span> <span class="n">minutes</span><span class="o">*</span><span class="mi">60</span>
- <span class="c1"># Add the fields corresponding to the end time</span>
- <span class="c1"># and the total time of command</span>
- <span class="n">endtime</span> <span class="o">=</span> <span class="n">dt</span><span class="o">.</span><span class="n">strftime</span><span class="p">(</span><span class="s1">'%Y/%m/</span><span class="si">%d</span><span class="s1"> %Hh%Mm%Ss'</span><span class="p">)</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">xmlFile</span><span class="o">.</span><span class="n">append_node_attrib</span><span class="p">(</span><span class="s2">"Site"</span><span class="p">,</span> <span class="n">attrib</span><span class="o">=</span><span class="p">{</span><span class="s2">"endTime"</span> <span class="p">:</span> <span class="n">endtime</span><span class="p">})</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">xmlFile</span><span class="o">.</span><span class="n">append_node_attrib</span><span class="p">(</span><span class="s2">"Site"</span><span class="p">,</span>
- <span class="n">attrib</span><span class="o">=</span><span class="p">{</span><span class="s2">"TotalTime"</span> <span class="p">:</span> <span class="s2">"</span><span class="si">%i</span><span class="s2">h</span><span class="si">%i</span><span class="s2">m</span><span class="si">%i</span><span class="s2">s"</span> <span class="o">%</span> <span class="p">(</span><span class="n">hours</span><span class="p">,</span> <span class="n">minutes</span><span class="p">,</span> <span class="n">seconds</span><span class="p">)})</span>
-
- <span class="c1"># Add the attribute passed to the method</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">xmlFile</span><span class="o">.</span><span class="n">append_node_attrib</span><span class="p">(</span><span class="s2">"Site"</span><span class="p">,</span> <span class="n">attrib</span><span class="o">=</span><span class="n">attribute</span><span class="p">)</span>
-
- <span class="c1"># Call the method to write the xml file on the hard drive</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">xmlFile</span><span class="o">.</span><span class="n">write_tree</span><span class="p">(</span><span class="n">stylesheet</span> <span class="o">=</span> <span class="s2">"command.xsl"</span><span class="p">)</span>
-
- <span class="c1"># Dump the config in a pyconf file in the log directory</span>
- <span class="n">logDir</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">get_log_path</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="p">)</span>
- <span class="n">dumpedPyconfFileName</span> <span class="o">=</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">VARS</span><span class="o">.</span><span class="n">datehour</span>
- <span class="o">+</span> <span class="s2">"_"</span>
- <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">VARS</span><span class="o">.</span><span class="n">command</span>
- <span class="o">+</span> <span class="s2">".pyconf"</span><span class="p">)</span>
- <span class="n">dumpedPyconfFilePath</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">logDir</span><span class="p">,</span> <span class="s1">'OUT'</span><span class="p">,</span> <span class="n">dumpedPyconfFileName</span><span class="p">)</span>
- <span class="k">try</span><span class="p">:</span>
- <span class="n">f</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="n">dumpedPyconfFilePath</span><span class="p">,</span> <span class="s1">'w'</span><span class="p">)</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">__save__</span><span class="p">(</span><span class="n">f</span><span class="p">)</span>
- <span class="n">f</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
- <span class="k">except</span> <span class="ne">IOError</span><span class="p">:</span>
- <span class="k">pass</span></div></div>
-
-<div class="viewcode-block" id="date_to_datetime"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.logger.date_to_datetime">[docs]</a><span class="k">def</span> <span class="nf">date_to_datetime</span><span class="p">(</span><span class="n">date</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> From a string date in format YYYYMMDD_HHMMSS</span>
-<span class="sd"> returns list year, mon, day, hour, minutes, seconds </span>
-<span class="sd"> </span>
-<span class="sd"> :param date str: The date in format YYYYMMDD_HHMMSS</span>
-<span class="sd"> :return: the same date and time in separate variables.</span>
-<span class="sd"> :rtype: (str,str,str,str,str,str)</span>
-<span class="sd"> """</span>
- <span class="n">Y</span> <span class="o">=</span> <span class="n">date</span><span class="p">[:</span><span class="mi">4</span><span class="p">]</span>
- <span class="n">m</span> <span class="o">=</span> <span class="n">date</span><span class="p">[</span><span class="mi">4</span><span class="p">:</span><span class="mi">6</span><span class="p">]</span>
- <span class="n">dd</span> <span class="o">=</span> <span class="n">date</span><span class="p">[</span><span class="mi">6</span><span class="p">:</span><span class="mi">8</span><span class="p">]</span>
- <span class="n">H</span> <span class="o">=</span> <span class="n">date</span><span class="p">[</span><span class="mi">9</span><span class="p">:</span><span class="mi">11</span><span class="p">]</span>
- <span class="n">M</span> <span class="o">=</span> <span class="n">date</span><span class="p">[</span><span class="mi">11</span><span class="p">:</span><span class="mi">13</span><span class="p">]</span>
- <span class="n">S</span> <span class="o">=</span> <span class="n">date</span><span class="p">[</span><span class="mi">13</span><span class="p">:</span><span class="mi">15</span><span class="p">]</span>
- <span class="k">return</span> <span class="n">Y</span><span class="p">,</span> <span class="n">m</span><span class="p">,</span> <span class="n">dd</span><span class="p">,</span> <span class="n">H</span><span class="p">,</span> <span class="n">M</span><span class="p">,</span> <span class="n">S</span></div>
-
-<div class="viewcode-block" id="timedelta_total_seconds"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.logger.timedelta_total_seconds">[docs]</a><span class="k">def</span> <span class="nf">timedelta_total_seconds</span><span class="p">(</span><span class="n">timedelta</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Replace total_seconds from datetime module </span>
-<span class="sd"> in order to be compatible with old python versions</span>
-<span class="sd"> </span>
-<span class="sd"> :param timedelta datetime.timedelta: The delta between two dates</span>
-<span class="sd"> :return: The number of seconds corresponding to timedelta.</span>
-<span class="sd"> :rtype: float</span>
-<span class="sd"> """</span>
- <span class="k">return</span> <span class="p">(</span>
- <span class="n">timedelta</span><span class="o">.</span><span class="n">microseconds</span> <span class="o">+</span> <span class="mf">0.0</span> <span class="o">+</span>
- <span class="p">(</span><span class="n">timedelta</span><span class="o">.</span><span class="n">seconds</span> <span class="o">+</span> <span class="n">timedelta</span><span class="o">.</span><span class="n">days</span> <span class="o">*</span> <span class="mi">24</span> <span class="o">*</span> <span class="mi">3600</span><span class="p">)</span> <span class="o">*</span> <span class="mi">10</span> <span class="o">**</span> <span class="mi">6</span><span class="p">)</span> <span class="o">/</span> <span class="mi">10</span> <span class="o">**</span> <span class="mi">6</span></div>
-
-<div class="viewcode-block" id="show_command_log"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.logger.show_command_log">[docs]</a><span class="k">def</span> <span class="nf">show_command_log</span><span class="p">(</span><span class="n">logFilePath</span><span class="p">,</span> <span class="n">cmd</span><span class="p">,</span> <span class="n">application</span><span class="p">,</span> <span class="n">notShownCommands</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Used in updateHatXml. </span>
-<span class="sd"> Determine if the log xml file logFilePath </span>
-<span class="sd"> has to be shown or not in the hat log.</span>
-<span class="sd"> </span>
-<span class="sd"> :param logFilePath str: the path to the command xml log file</span>
-<span class="sd"> :param cmd str: the command of the log file</span>
-<span class="sd"> :param application str: the application passed as parameter </span>
-<span class="sd"> to the salomeTools command</span>
-<span class="sd"> :param notShownCommands list: the list of commands </span>
-<span class="sd"> that are not shown by default</span>
-<span class="sd"> </span>
-<span class="sd"> :return: True if cmd is not in notShownCommands and the application </span>
-<span class="sd"> in the log file corresponds to application</span>
-<span class="sd"> :rtype: boolean</span>
-<span class="sd"> """</span>
- <span class="c1"># When the command is not in notShownCommands, no need to go further :</span>
- <span class="c1"># Do not show</span>
- <span class="k">if</span> <span class="n">cmd</span> <span class="ow">in</span> <span class="n">notShownCommands</span><span class="p">:</span>
- <span class="k">return</span> <span class="kc">False</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span>
-
- <span class="c1"># Get the application of the log file</span>
- <span class="k">try</span><span class="p">:</span>
- <span class="n">logFileXml</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">xmlManager</span><span class="o">.</span><span class="n">ReadXmlFile</span><span class="p">(</span><span class="n">logFilePath</span><span class="p">)</span>
- <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
- <span class="n">msg</span> <span class="o">=</span> <span class="n">_</span><span class="p">(</span><span class="s2">"WARNING: the log file </span><span class="si">%s</span><span class="s2"> cannot be read:"</span> <span class="o">%</span> <span class="n">logFilePath</span><span class="p">)</span>
- <span class="n">sys</span><span class="o">.</span><span class="n">stdout</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">printcolors</span><span class="o">.</span><span class="n">printcWarning</span><span class="p">(</span><span class="s2">"</span><span class="si">%s</span><span class="se">\n</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="n">msg</span><span class="p">,</span> <span class="n">e</span><span class="p">)))</span>
- <span class="k">return</span> <span class="kc">False</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span>
-
- <span class="k">if</span> <span class="s1">'application'</span> <span class="ow">in</span> <span class="n">logFileXml</span><span class="o">.</span><span class="n">xmlroot</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
- <span class="n">appliLog</span> <span class="o">=</span> <span class="n">logFileXml</span><span class="o">.</span><span class="n">xmlroot</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'application'</span><span class="p">)</span>
- <span class="n">launched_cmd</span> <span class="o">=</span> <span class="n">logFileXml</span><span class="o">.</span><span class="n">xmlroot</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="s1">'Site'</span><span class="p">)</span><span class="o">.</span><span class="n">attrib</span><span class="p">[</span><span class="s1">'launchedCommand'</span><span class="p">]</span>
- <span class="c1"># if it corresponds, then the log has to be shown</span>
- <span class="k">if</span> <span class="n">appliLog</span> <span class="o">==</span> <span class="n">application</span><span class="p">:</span>
- <span class="k">return</span> <span class="kc">True</span><span class="p">,</span> <span class="n">appliLog</span><span class="p">,</span> <span class="n">launched_cmd</span>
- <span class="k">elif</span> <span class="n">application</span> <span class="o">!=</span> <span class="s1">'None'</span><span class="p">:</span>
- <span class="k">return</span> <span class="kc">False</span><span class="p">,</span> <span class="n">appliLog</span><span class="p">,</span> <span class="n">launched_cmd</span>
-
- <span class="k">return</span> <span class="kc">True</span><span class="p">,</span> <span class="n">appliLog</span><span class="p">,</span> <span class="n">launched_cmd</span>
-
- <span class="k">if</span> <span class="n">application</span> <span class="o">==</span> <span class="s1">'None'</span><span class="p">:</span>
- <span class="k">return</span> <span class="kc">True</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span>
-
- <span class="k">return</span> <span class="kc">False</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span></div>
-
-<div class="viewcode-block" id="list_log_file"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.logger.list_log_file">[docs]</a><span class="k">def</span> <span class="nf">list_log_file</span><span class="p">(</span><span class="n">dirPath</span><span class="p">,</span> <span class="n">expression</span><span class="p">):</span>
- <span class="sd">"""Find all files corresponding to expression in dirPath</span>
-<span class="sd"> </span>
-<span class="sd"> :param dirPath str: the directory where to search the files</span>
-<span class="sd"> :param expression str: the regular expression of files to find</span>
-<span class="sd"> :return: the list of files path and informations about it</span>
-<span class="sd"> :rtype: list</span>
-<span class="sd"> """</span>
- <span class="n">lRes</span> <span class="o">=</span> <span class="p">[]</span>
- <span class="k">for</span> <span class="n">fileName</span> <span class="ow">in</span> <span class="n">os</span><span class="o">.</span><span class="n">listdir</span><span class="p">(</span><span class="n">dirPath</span><span class="p">):</span>
- <span class="c1"># YYYYMMDD_HHMMSS_namecmd.xml</span>
- <span class="n">sExpr</span> <span class="o">=</span> <span class="n">expression</span>
- <span class="n">oExpr</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="n">sExpr</span><span class="p">)</span>
- <span class="k">if</span> <span class="n">oExpr</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">fileName</span><span class="p">):</span>
- <span class="n">file_name</span> <span class="o">=</span> <span class="n">fileName</span>
- <span class="k">if</span> <span class="n">fileName</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s2">"micro_"</span><span class="p">):</span>
- <span class="n">file_name</span> <span class="o">=</span> <span class="n">fileName</span><span class="p">[</span><span class="nb">len</span><span class="p">(</span><span class="s2">"micro_"</span><span class="p">):]</span>
- <span class="c1"># get date and hour and format it</span>
- <span class="n">date_hour_cmd_host</span> <span class="o">=</span> <span class="n">file_name</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">'_'</span><span class="p">)</span>
- <span class="n">date_not_formated</span> <span class="o">=</span> <span class="n">date_hour_cmd_host</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
- <span class="n">date</span> <span class="o">=</span> <span class="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_not_formated</span><span class="p">[</span><span class="mi">6</span><span class="p">:</span><span class="mi">8</span><span class="p">],</span>
- <span class="n">date_not_formated</span><span class="p">[</span><span class="mi">4</span><span class="p">:</span><span class="mi">6</span><span class="p">],</span>
- <span class="n">date_not_formated</span><span class="p">[</span><span class="mi">0</span><span class="p">:</span><span class="mi">4</span><span class="p">])</span>
- <span class="n">hour_not_formated</span> <span class="o">=</span> <span class="n">date_hour_cmd_host</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
- <span class="n">hour</span> <span class="o">=</span> <span class="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">hour_not_formated</span><span class="p">[</span><span class="mi">0</span><span class="p">:</span><span class="mi">2</span><span class="p">],</span>
- <span class="n">hour_not_formated</span><span class="p">[</span><span class="mi">2</span><span class="p">:</span><span class="mi">4</span><span class="p">],</span>
- <span class="n">hour_not_formated</span><span class="p">[</span><span class="mi">4</span><span class="p">:</span><span class="mi">6</span><span class="p">])</span>
- <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">date_hour_cmd_host</span><span class="p">)</span> <span class="o"><</span> <span class="mi">4</span><span class="p">:</span>
- <span class="n">cmd</span> <span class="o">=</span> <span class="n">date_hour_cmd_host</span><span class="p">[</span><span class="mi">2</span><span class="p">][:</span><span class="o">-</span><span class="nb">len</span><span class="p">(</span><span class="s1">'.xml'</span><span class="p">)]</span>
- <span class="n">host</span> <span class="o">=</span> <span class="s2">""</span>
- <span class="k">else</span><span class="p">:</span>
- <span class="n">cmd</span> <span class="o">=</span> <span class="n">date_hour_cmd_host</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span>
- <span class="n">host</span> <span class="o">=</span> <span class="n">date_hour_cmd_host</span><span class="p">[</span><span class="mi">3</span><span class="p">][:</span><span class="o">-</span><span class="nb">len</span><span class="p">(</span><span class="s1">'.xml'</span><span class="p">)]</span>
- <span class="n">lRes</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">dirPath</span><span class="p">,</span> <span class="n">fileName</span><span class="p">),</span>
- <span class="n">date_not_formated</span><span class="p">,</span>
- <span class="n">date</span><span class="p">,</span>
- <span class="n">hour_not_formated</span><span class="p">,</span>
- <span class="n">hour</span><span class="p">,</span>
- <span class="n">cmd</span><span class="p">,</span>
- <span class="n">host</span><span class="p">))</span>
- <span class="k">return</span> <span class="n">lRes</span></div>
-
-<div class="viewcode-block" id="update_hat_xml"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.logger.update_hat_xml">[docs]</a><span class="k">def</span> <span class="nf">update_hat_xml</span><span class="p">(</span><span class="n">logDir</span><span class="p">,</span> <span class="n">application</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">notShownCommands</span> <span class="o">=</span> <span class="p">[]):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Create the xml file in logDir that contain all the xml file </span>
-<span class="sd"> and have a name like YYYYMMDD_HHMMSS_namecmd.xml</span>
-<span class="sd"> </span>
-<span class="sd"> :param logDir str: the directory to parse</span>
-<span class="sd"> :param application str: the name of the application if there is any</span>
-<span class="sd"> """</span>
- <span class="c1"># Create an instance of XmlLogFile class to create hat.xml file</span>
- <span class="n">xmlHatFilePath</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">logDir</span><span class="p">,</span> <span class="s1">'hat.xml'</span><span class="p">)</span>
- <span class="n">xmlHat</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">xmlManager</span><span class="o">.</span><span class="n">XmlLogFile</span><span class="p">(</span><span class="n">xmlHatFilePath</span><span class="p">,</span>
- <span class="s2">"LOGlist"</span><span class="p">,</span> <span class="p">{</span><span class="s2">"application"</span> <span class="p">:</span> <span class="n">application</span><span class="p">})</span>
- <span class="c1"># parse the log directory to find all the command logs, </span>
- <span class="c1"># then add it to the xml file</span>
- <span class="n">lLogFile</span> <span class="o">=</span> <span class="n">list_log_file</span><span class="p">(</span><span class="n">logDir</span><span class="p">,</span> <span class="n">log_macro_command_file_expression</span><span class="p">)</span>
- <span class="k">for</span> <span class="n">filePath</span><span class="p">,</span> <span class="n">__</span><span class="p">,</span> <span class="n">date</span><span class="p">,</span> <span class="n">__</span><span class="p">,</span> <span class="n">hour</span><span class="p">,</span> <span class="n">cmd</span><span class="p">,</span> <span class="n">__</span> <span class="ow">in</span> <span class="n">lLogFile</span><span class="p">:</span>
- <span class="n">showLog</span><span class="p">,</span> <span class="n">cmdAppli</span><span class="p">,</span> <span class="n">full_cmd</span> <span class="o">=</span> <span class="n">show_command_log</span><span class="p">(</span><span class="n">filePath</span><span class="p">,</span> <span class="n">cmd</span><span class="p">,</span>
- <span class="n">application</span><span class="p">,</span> <span class="n">notShownCommands</span><span class="p">)</span>
- <span class="c1">#if cmd not in notShownCommands:</span>
- <span class="k">if</span> <span class="n">showLog</span><span class="p">:</span>
- <span class="c1"># add a node to the hat.xml file</span>
- <span class="n">xmlHat</span><span class="o">.</span><span class="n">add_simple_node</span><span class="p">(</span><span class="s2">"LogCommand"</span><span class="p">,</span>
- <span class="n">text</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">basename</span><span class="p">(</span><span class="n">filePath</span><span class="p">),</span>
- <span class="n">attrib</span> <span class="o">=</span> <span class="p">{</span><span class="s2">"date"</span> <span class="p">:</span> <span class="n">date</span><span class="p">,</span>
- <span class="s2">"hour"</span> <span class="p">:</span> <span class="n">hour</span><span class="p">,</span>
- <span class="s2">"cmd"</span> <span class="p">:</span> <span class="n">cmd</span><span class="p">,</span>
- <span class="s2">"application"</span> <span class="p">:</span> <span class="n">cmdAppli</span><span class="p">,</span>
- <span class="s2">"full_command"</span> <span class="p">:</span> <span class="n">full_cmd</span><span class="p">})</span>
-
- <span class="c1"># Write the file on the hard drive</span>
- <span class="n">xmlHat</span><span class="o">.</span><span class="n">write_tree</span><span class="p">(</span><span class="s1">'hat.xsl'</span><span class="p">)</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
--- /dev/null
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>src.loggingSat — 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">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+ <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/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="top" title="salomeTools 5.0.0dev documentation" href="../../index.html" />
+ <link rel="up" title="Module code" href="../index.html" />
+
+ <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+ </head>
+ <body role="document">
+
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <h1>Source code for src.loggingSat</h1><div class="highlight"><pre>
+<span></span><span class="ch">#!/usr/bin/env python</span>
+<span class="c1"># -*- coding: utf-8 -*-</span>
+
+<span class="sd">"""</span>
+<span class="sd">http://sametmax.com/ecrire-des-logs-en-python/</span>
+<span class="sd">https://docs.python.org/3/library/time.html#time.strftime</span>
+
+<span class="sd">use logging package for salometools</span>
+
+<span class="sd">handler:</span>
+<span class="sd"> on info() no format</span>
+<span class="sd"> on other formatted indented on multi lines messages</span>
+<span class="sd">"""</span>
+
+<span class="kn">import</span> <span class="nn">os</span>
+<span class="kn">import</span> <span class="nn">sys</span>
+<span class="kn">import</span> <span class="nn">logging</span>
+<span class="kn">import</span> <span class="nn">pprint</span> <span class="k">as</span> <span class="nn">PP</span>
+<span class="kn">import</span> <span class="nn">src.coloringSat</span> <span class="k">as</span> <span class="nn">COLS</span>
+
+<span class="n">_verbose</span> <span class="o">=</span> <span class="kc">False</span>
+<span class="n">_name</span> <span class="o">=</span> <span class="s2">"loggingSat"</span>
+
+<div class="viewcode-block" id="indent"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.loggingSat.indent">[docs]</a><span class="k">def</span> <span class="nf">indent</span><span class="p">(</span><span class="n">msg</span><span class="p">,</span> <span class="n">nb</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 nb car (spaces) multi lines message except first one"""</span>
+ <span class="n">s</span> <span class="o">=</span> <span class="n">msg</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
+ <span class="n">res</span> <span class="o">=</span> <span class="p">(</span><span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="o">+</span><span class="n">car</span><span class="o">*</span><span class="n">nb</span><span class="p">)</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">s</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">res</span></div>
+
+<div class="viewcode-block" id="indentUnittest"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.loggingSat.indentUnittest">[docs]</a><span class="k">def</span> <span class="nf">indentUnittest</span><span class="p">(</span><span class="n">msg</span><span class="p">,</span> <span class="n">prefix</span><span class="o">=</span><span class="s2">" | "</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> indent car multi lines message except first one</span>
+<span class="sd"> car default is less spaces for size logs files</span>
+<span class="sd"> keep human readable</span>
+<span class="sd"> """</span>
+ <span class="n">s</span> <span class="o">=</span> <span class="n">msg</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
+ <span class="n">res</span> <span class="o">=</span> <span class="p">(</span><span class="s2">"</span><span class="se">\n</span><span class="s2">"</span> <span class="o">+</span> <span class="n">prefix</span><span class="p">)</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">s</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">res</span></div>
+
+<div class="viewcode-block" id="log"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.loggingSat.log">[docs]</a><span class="k">def</span> <span class="nf">log</span><span class="p">(</span><span class="n">msg</span><span class="p">):</span>
+ <span class="sd">"""elementary log when no logger yet"""</span>
+ <span class="n">prefix</span> <span class="o">=</span> <span class="s2">"</span><span class="si">%s</span><span class="s2">.log: "</span> <span class="o">%</span> <span class="n">_name</span>
+ <span class="n">nb</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">prefix</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">_verbose</span><span class="p">:</span> <span class="nb">print</span><span class="p">(</span><span class="n">prefix</span> <span class="o">+</span> <span class="n">indent</span><span class="p">(</span><span class="n">msg</span><span class="p">,</span> <span class="n">nb</span><span class="p">))</span></div>
+
+<span class="n">log</span><span class="p">(</span><span class="s2">"import logging on </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="n">logging</span><span class="o">.</span><span class="vm">__file__</span><span class="p">)</span>
+
+<span class="n">_loggerDefaultName</span> <span class="o">=</span> <span class="s1">'SatDefaultLogger'</span>
+<span class="n">_loggerUnittestName</span> <span class="o">=</span> <span class="s1">'SatUnittestLogger'</span>
+
+
+<div class="viewcode-block" id="getDefaultLogger"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.loggingSat.getDefaultLogger">[docs]</a><span class="k">def</span> <span class="nf">getDefaultLogger</span><span class="p">():</span>
+ <span class="n">log</span><span class="p">(</span><span class="s2">"getDefaultLogger </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="n">_loggerDefaultName</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="n">_loggerDefaultName</span><span class="p">)</span></div>
+
+<div class="viewcode-block" id="getUnittestLogger"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.loggingSat.getUnittestLogger">[docs]</a><span class="k">def</span> <span class="nf">getUnittestLogger</span><span class="p">():</span>
+ <span class="n">log</span><span class="p">(</span><span class="s2">"getUnittestLogger </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="n">_loggerUnittestName</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="n">_loggerUnittestName</span><span class="p">)</span></div>
+
+<div class="viewcode-block" id="dirLogger"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.loggingSat.dirLogger">[docs]</a><span class="k">def</span> <span class="nf">dirLogger</span><span class="p">(</span><span class="n">logger</span><span class="p">):</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">'dir(logger name=</span><span class="si">%s</span><span class="s1">):</span><span class="se">\n</span><span class="s1">'</span> <span class="o">%</span> <span class="n">logger</span><span class="o">.</span><span class="n">name</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="nb">dir</span><span class="p">(</span><span class="n">logger</span><span class="p">)))</span></div>
+
+<span class="n">_loggerDefault</span> <span class="o">=</span> <span class="n">getDefaultLogger</span><span class="p">()</span>
+<span class="n">_loggerUnittest</span> <span class="o">=</span> <span class="n">getUnittestLogger</span><span class="p">()</span>
+
+
+<div class="viewcode-block" id="DefaultFormatter"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.loggingSat.DefaultFormatter">[docs]</a><span class="k">class</span> <span class="nc">DefaultFormatter</span><span class="p">(</span><span class="n">logging</span><span class="o">.</span><span class="n">Formatter</span><span class="p">):</span>
+
+ <span class="c1"># to set color prefix, problem with indent format</span>
+ <span class="n">_ColorLevelname</span> <span class="o">=</span> <span class="p">{</span>
+ <span class="s2">"DEBUG"</span><span class="p">:</span> <span class="s2">"<blue>"</span><span class="p">,</span>
+ <span class="s2">"INFO"</span><span class="p">:</span> <span class="s2">"<green>"</span><span class="p">,</span>
+ <span class="s2">"WARNING"</span><span class="p">:</span> <span class="s2">"<red>"</span><span class="p">,</span>
+ <span class="s2">"ERROR"</span><span class="p">:</span> <span class="s2">"<yellow>"</span><span class="p">,</span>
+ <span class="s2">"CRITICAL"</span><span class="p">:</span> <span class="s2">"<yellow>"</span><span class="p">,</span>
+ <span class="p">}</span>
+
+<div class="viewcode-block" id="DefaultFormatter.format"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.loggingSat.DefaultFormatter.format">[docs]</a> <span class="k">def</span> <span class="nf">format</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">record</span><span class="p">):</span>
+ <span class="k">if</span> <span class="n">record</span><span class="o">.</span><span class="n">levelname</span> <span class="o">==</span> <span class="s2">"INFO"</span><span class="p">:</span>
+ <span class="n">res</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">record</span><span class="o">.</span><span class="n">msg</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="c1">#record.levelname = self.setColorLevelname(record.levelname)</span>
+ <span class="n">res</span> <span class="o">=</span> <span class="n">indent</span><span class="p">(</span><span class="nb">super</span><span class="p">(</span><span class="n">DefaultFormatter</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">record</span><span class="p">),</span> <span class="mi">12</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">COLS</span><span class="o">.</span><span class="n">toColor</span><span class="p">(</span><span class="n">res</span><span class="p">)</span></div>
+
+<div class="viewcode-block" id="DefaultFormatter.setColorLevelname"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.loggingSat.DefaultFormatter.setColorLevelname">[docs]</a> <span class="k">def</span> <span class="nf">setColorLevelname</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">levelname</span><span class="p">):</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_ColorLevelname</span><span class="p">[</span><span class="n">levelname</span><span class="p">]</span> <span class="o">+</span> <span class="n">levelname</span> <span class="o">+</span> <span class="s2">"<reset>"</span></div></div>
+
+
+<div class="viewcode-block" id="UnittestFormatter"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.loggingSat.UnittestFormatter">[docs]</a><span class="k">class</span> <span class="nc">UnittestFormatter</span><span class="p">(</span><span class="n">logging</span><span class="o">.</span><span class="n">Formatter</span><span class="p">):</span>
+<div class="viewcode-block" id="UnittestFormatter.format"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.loggingSat.UnittestFormatter.format">[docs]</a> <span class="k">def</span> <span class="nf">format</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">record</span><span class="p">):</span>
+ <span class="c1"># print "", record.levelname #type(record), dir(record)</span>
+ <span class="c1"># nb = len("2018-03-17 12:15:41 :: INFO :: ")</span>
+ <span class="n">res</span> <span class="o">=</span> <span class="n">indentUnittest</span><span class="p">(</span><span class="nb">super</span><span class="p">(</span><span class="n">UnittestFormatter</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">record</span><span class="p">),</span> <span class="s2">" | "</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">COLS</span><span class="o">.</span><span class="n">toColor</span><span class="p">(</span><span class="n">res</span><span class="p">)</span></div></div>
+
+
+<div class="viewcode-block" id="UnittestStream"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.loggingSat.UnittestStream">[docs]</a><span class="k">class</span> <span class="nc">UnittestStream</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> write my stream class</span>
+<span class="sd"> only write and flush are used for the streaming</span>
+<span class="sd"> https://docs.python.org/2/library/logging.handlers.html</span>
+<span class="sd"> https://stackoverflow.com/questions/31999627/storing-logger-messages-in-a-string</span>
+<span class="sd"> """</span>
+ <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_logs</span> <span class="o">=</span> <span class="s1">''</span>
+
+<div class="viewcode-block" id="UnittestStream.getLogs"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.loggingSat.UnittestStream.getLogs">[docs]</a> <span class="k">def</span> <span class="nf">getLogs</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">_logs</span></div>
+
+<div class="viewcode-block" id="UnittestStream.getLogsAndClear"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.loggingSat.UnittestStream.getLogsAndClear">[docs]</a> <span class="k">def</span> <span class="nf">getLogsAndClear</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="n">res</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_logs</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_logs</span> <span class="o">=</span> <span class="s1">''</span>
+ <span class="k">return</span> <span class="n">res</span></div>
+
+<div class="viewcode-block" id="UnittestStream.write"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.loggingSat.UnittestStream.write">[docs]</a> <span class="k">def</span> <span class="nf">write</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">astr</span><span class="p">):</span>
+ <span class="c1"># log("UnittestStream.write('%s')" % astr)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_logs</span> <span class="o">+=</span> <span class="n">astr</span></div>
+
+<div class="viewcode-block" id="UnittestStream.flush"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.loggingSat.UnittestStream.flush">[docs]</a> <span class="k">def</span> <span class="nf">flush</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="k">pass</span></div>
+
+ <span class="k">def</span> <span class="nf">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_logs</span></div>
+
+
+<div class="viewcode-block" id="initLoggerAsDefault"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.loggingSat.initLoggerAsDefault">[docs]</a><span class="k">def</span> <span class="nf">initLoggerAsDefault</span><span class="p">(</span><span class="n">logger</span><span class="p">,</span> <span class="n">fmt</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">level</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> init logger as prefixed message and indented message if multi line</span>
+<span class="sd"> exept info() outed 'as it' without any format</span>
+<span class="sd"> """</span>
+ <span class="n">log</span><span class="p">(</span><span class="s2">"initLoggerAsDefault name=</span><span class="si">%s</span><span class="se">\n</span><span class="s2">fmt='</span><span class="si">%s</span><span class="s2">' level='</span><span class="si">%s</span><span class="s2">'"</span> <span class="o">%</span> <span class="p">(</span><span class="n">logger</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">fmt</span><span class="p">,</span> <span class="n">level</span><span class="p">))</span>
+ <span class="n">handler</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">StreamHandler</span><span class="p">(</span><span class="n">sys</span><span class="o">.</span><span class="n">stdout</span><span class="p">)</span> <span class="c1"># Logging vers console</span>
+ <span class="k">if</span> <span class="n">fmt</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
+ <span class="c1"># formatter = logging.Formatter(fmt, "%Y-%m-%d %H:%M:%S")</span>
+ <span class="n">formatter</span> <span class="o">=</span> <span class="n">DefaultFormatter</span><span class="p">(</span><span class="n">fmt</span><span class="p">,</span> <span class="s2">"%y-%m-</span><span class="si">%d</span><span class="s2"> %H:%M:%S"</span><span class="p">)</span>
+ <span class="n">handler</span><span class="o">.</span><span class="n">setFormatter</span><span class="p">(</span><span class="n">formatter</span><span class="p">)</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">addHandler</span><span class="p">(</span><span class="n">handler</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">level</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">setLevel</span><span class="p">(</span><span class="n">level</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">setLevel</span><span class="p">(</span><span class="n">logger</span><span class="o">.</span><span class="n">INFO</span><span class="p">)</span></div>
+
+
+<div class="viewcode-block" id="initLoggerAsUnittest"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.loggingSat.initLoggerAsUnittest">[docs]</a><span class="k">def</span> <span class="nf">initLoggerAsUnittest</span><span class="p">(</span><span class="n">logger</span><span class="p">,</span> <span class="n">fmt</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">level</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> init logger as silent on stdout/stderr</span>
+<span class="sd"> used for retrieve messages in memory for post execution unittest</span>
+<span class="sd"> https://docs.python.org/2/library/logging.handlers.html</span>
+<span class="sd"> """</span>
+ <span class="n">log</span><span class="p">(</span><span class="s2">"initLoggerAsUnittest name=</span><span class="si">%s</span><span class="se">\n</span><span class="s2">fmt='</span><span class="si">%s</span><span class="s2">' level='</span><span class="si">%s</span><span class="s2">'"</span> <span class="o">%</span> <span class="p">(</span><span class="n">logger</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">fmt</span><span class="p">,</span> <span class="n">level</span><span class="p">))</span>
+ <span class="n">stream</span> <span class="o">=</span> <span class="n">UnittestStream</span><span class="p">()</span>
+ <span class="n">handler</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">StreamHandler</span><span class="p">(</span><span class="n">stream</span><span class="p">)</span> <span class="c1"># Logging vers stream</span>
+ <span class="k">if</span> <span class="n">fmt</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
+ <span class="c1"># formatter = logging.Formatter(fmt, "%Y-%m-%d %H:%M:%S")</span>
+ <span class="n">formatter</span> <span class="o">=</span> <span class="n">UnittestFormatter</span><span class="p">(</span><span class="n">fmt</span><span class="p">,</span> <span class="s2">"%Y-%m-</span><span class="si">%d</span><span class="s2"> %H:%M:%S"</span><span class="p">)</span>
+ <span class="n">handler</span><span class="o">.</span><span class="n">setFormatter</span><span class="p">(</span><span class="n">formatter</span><span class="p">)</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">addHandler</span><span class="p">(</span><span class="n">handler</span><span class="p">)</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">stream</span> <span class="o">=</span> <span class="n">stream</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">getLogs</span> <span class="o">=</span> <span class="n">stream</span><span class="o">.</span><span class="n">getLogs</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">getLogsAndClear</span> <span class="o">=</span> <span class="n">stream</span><span class="o">.</span><span class="n">getLogsAndClear</span>
+ <span class="k">if</span> <span class="n">level</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">setLevel</span><span class="p">(</span><span class="n">level</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">setLevel</span><span class="p">(</span><span class="n">logger</span><span class="o">.</span><span class="n">DEBUG</span><span class="p">)</span></div>
+
+
+<div class="viewcode-block" id="testLogger_1"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.loggingSat.testLogger_1">[docs]</a><span class="k">def</span> <span class="nf">testLogger_1</span><span class="p">(</span><span class="n">logger</span><span class="p">):</span>
+ <span class="sd">"""small test"""</span>
+ <span class="c1"># dirLogger(logger)</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s1">'test logger debug'</span><span class="p">)</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">'test logger info'</span><span class="p">)</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="s1">'test logger warning'</span><span class="p">)</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="s1">'test logger error'</span><span class="p">)</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">critical</span><span class="p">(</span><span class="s1">'test logger critical'</span><span class="p">)</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">test logger info: no indent</span><span class="se">\n</span><span class="s1">- second line</span><span class="se">\n</span><span class="s1">- third line</span><span class="se">\n</span><span class="s1">'</span><span class="p">)</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="s1">'test logger warning:</span><span class="se">\n</span><span class="s1">- second line</span><span class="se">\n</span><span class="s1">- third line'</span><span class="p">)</span></div>
+
+
+<span class="k">if</span> <span class="vm">__name__</span> <span class="o">==</span> <span class="s2">"__main__"</span><span class="p">:</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s2">"</span><span class="se">\n</span><span class="s2">**** DEFAULT logger"</span><span class="p">)</span>
+ <span class="n">logdef</span> <span class="o">=</span> <span class="n">getDefaultLogger</span><span class="p">()</span>
+ <span class="c1"># problem if add +2? if append 2 setColorLevelname <color><reset>, not fixed</span>
+ <span class="n">initLoggerAsDefault</span><span class="p">(</span><span class="n">logdef</span><span class="p">,</span> <span class="s1">'</span><span class="si">%(levelname)-8s</span><span class="s1"> :: </span><span class="si">%(message)s</span><span class="s1">'</span><span class="p">,</span> <span class="n">level</span><span class="o">=</span><span class="n">logging</span><span class="o">.</span><span class="n">INFO</span><span class="p">)</span>
+ <span class="n">testLogger_1</span><span class="p">(</span><span class="n">logdef</span><span class="p">)</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s2">"</span><span class="se">\n</span><span class="s2">**** UNITTEST logger"</span><span class="p">)</span>
+ <span class="n">loguni</span> <span class="o">=</span> <span class="n">getUnittestLogger</span><span class="p">()</span>
+ <span class="n">initLoggerAsUnittest</span><span class="p">(</span><span class="n">loguni</span><span class="p">,</span> <span class="s1">'</span><span class="si">%(asctime)s</span><span class="s1"> :: </span><span class="si">%(levelname)-8s</span><span class="s1"> :: </span><span class="si">%(message)s</span><span class="s1">'</span><span class="p">,</span> <span class="n">level</span><span class="o">=</span><span class="n">logging</span><span class="o">.</span><span class="n">DEBUG</span><span class="p">)</span>
+ <span class="n">testLogger_1</span><span class="p">(</span><span class="n">loguni</span><span class="p">)</span> <span class="c1"># is silent</span>
+ <span class="c1"># log("loguni.streamUnittest:\n%s" % loguni.streamUnittest)</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s2">"loguni.streamUnittest:</span><span class="se">\n</span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="n">loguni</span><span class="o">.</span><span class="n">streamUnittest</span><span class="p">)</span>
+
+ <span class="kn">from</span> <span class="nn">colorama</span> <span class="k">import</span> <span class="n">Fore</span> <span class="k">as</span> <span class="n">FG</span>
+ <span class="kn">from</span> <span class="nn">colorama</span> <span class="k">import</span> <span class="n">Style</span> <span class="k">as</span> <span class="n">ST</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s2">"this is </span><span class="si">%s</span><span class="s2">colored in green</span><span class="si">%s</span><span class="s2"> !!!"</span> <span class="o">%</span> <span class="p">(</span><span class="n">FG</span><span class="o">.</span><span class="n">GREEN</span><span class="p">,</span> <span class="n">ST</span><span class="o">.</span><span class="n">RESET_ALL</span><span class="p">))</span>
+
+<span class="k">else</span><span class="p">:</span>
+ <span class="n">_loggerDefault</span> <span class="o">=</span> <span class="n">getDefaultLogger</span><span class="p">()</span>
+ <span class="n">_loggerUnittest</span> <span class="o">=</span> <span class="n">getUnittestLogger</span><span class="p">()</span>
+ <span class="n">initLoggerAsDefault</span><span class="p">(</span><span class="n">_loggerDefault</span><span class="p">,</span> <span class="s1">'</span><span class="si">%(levelname)-8s</span><span class="s1"> :: </span><span class="si">%(message)s</span><span class="s1">'</span><span class="p">,</span> <span class="n">level</span><span class="o">=</span><span class="n">logging</span><span class="o">.</span><span class="n">INFO</span><span class="p">)</span>
+ <span class="n">initLoggerAsUnittest</span><span class="p">(</span><span class="n">_loggerUnittest</span><span class="p">,</span> <span class="s1">'</span><span class="si">%(asctime)s</span><span class="s1"> :: </span><span class="si">%(levelname)-8s</span><span class="s1"> :: </span><span class="si">%(message)s</span><span class="s1">'</span><span class="p">,</span> <span class="n">level</span><span class="o">=</span><span class="n">logging</span><span class="o">.</span><span class="n">DEBUG</span><span class="p">)</span>
+</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>
+ <form class="search" action="../../search.html" method="get">
+ <div><input type="text" name="q" /></div>
+ <div><input type="submit" value="Go" /></div>
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</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.4.9</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
+
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
-
<!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.options — salomeTools 5.0.0dev documentation</title>
+
<link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
- <script type="text/javascript" src="../../_static/documentation_options.js"></script>
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
- <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/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="top" title="salomeTools 5.0.0dev documentation" href="../../index.html" />
+ <link rel="up" title="Module code" href="../index.html" />
<link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
- </head><body>
+ </head>
+ <body role="document">
<div class="document">
<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">from</span> <span class="nn">.</span> <span class="k">import</span> <span class="n">printcolors</span>
+<span class="kn">import</span> <span class="nn">pprint</span> <span class="k">as</span> <span class="nn">PP</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"> >> print(options.level)</span>
+<span class="sd"> >> 5</span>
+<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">'''Initialization</span>
<span class="sd"> '''</span>
<span class="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"> :rtype: str,int,list,boolean,level</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"> :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>
+ <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 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="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">'''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="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">"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">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"> :return: Nothing.</span>
<span class="sd"> :rtype: N\A</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="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="n">src</span><span class="o">.</span><span class="n">KOSYS</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">"""for convenience </span>
+<span class="sd"> returns (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">'''Method that 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"> :return: colored string</span>
<span class="sd"> :rtype: N\A</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="s2">"<header>"</span> <span class="o">+</span> <span class="n">_</span><span class="p">(</span><span class="s2">"Available options are:"</span><span class="p">)</span> <span class="o">+</span> <span class="s2">"<reset>"</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.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"> 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="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="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">"</span><span class="se">\n\n</span><span class="s2">"</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="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="n">opt</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
+ <span class="c1"># TODO test in (lowercase) debug info warning error critical</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="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>
+
+ <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">'''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">'''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>
</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" />
+ <div><input type="text" name="q" /></div>
+ <div><input type="submit" value="Go" /></div>
<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>
©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>
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.9</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
</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.printcolors — salomeTools 5.0.0dev documentation</title>
- <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
- <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
- <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.printcolors</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">'''In this file is stored the mechanism that manage color prints in the terminal</span>
-<span class="sd">'''</span>
-
-<span class="c1"># define constant to use in scripts</span>
-<span class="n">COLOR_ERROR</span> <span class="o">=</span> <span class="s1">'ERROR'</span>
-<span class="n">COLOR_WARNING</span> <span class="o">=</span> <span class="s1">'WARNING'</span>
-<span class="n">COLOR_SUCCESS</span> <span class="o">=</span> <span class="s1">'SUCCESS'</span>
-<span class="n">COLOR_LABEL</span> <span class="o">=</span> <span class="s1">'LABEL'</span>
-<span class="n">COLOR_HEADER</span> <span class="o">=</span> <span class="s1">'HEADER'</span>
-<span class="n">COLOR_INFO</span> <span class="o">=</span> <span class="s1">'INFO'</span>
-<span class="n">COLOR_HIGLIGHT</span> <span class="o">=</span> <span class="s1">'HIGHLIGHT'</span>
-
-<span class="c1"># the color map to use to print the colors</span>
-<span class="n">__colormap__</span> <span class="o">=</span> <span class="p">{</span>
- <span class="n">COLOR_ERROR</span><span class="p">:</span> <span class="s1">'</span><span class="se">\033</span><span class="s1">[1m</span><span class="se">\033</span><span class="s1">[31m'</span><span class="p">,</span>
- <span class="n">COLOR_SUCCESS</span><span class="p">:</span> <span class="s1">'</span><span class="se">\033</span><span class="s1">[1m</span><span class="se">\033</span><span class="s1">[32m'</span><span class="p">,</span>
- <span class="n">COLOR_WARNING</span><span class="p">:</span> <span class="s1">'</span><span class="se">\033</span><span class="s1">[33m'</span><span class="p">,</span>
- <span class="n">COLOR_HEADER</span><span class="p">:</span> <span class="s1">'</span><span class="se">\033</span><span class="s1">[34m'</span><span class="p">,</span>
- <span class="n">COLOR_INFO</span><span class="p">:</span> <span class="s1">'</span><span class="se">\033</span><span class="s1">[35m'</span><span class="p">,</span>
- <span class="n">COLOR_LABEL</span><span class="p">:</span> <span class="s1">'</span><span class="se">\033</span><span class="s1">[36m'</span><span class="p">,</span>
- <span class="n">COLOR_HIGLIGHT</span><span class="p">:</span> <span class="s1">'</span><span class="se">\033</span><span class="s1">[97m</span><span class="se">\033</span><span class="s1">[43m'</span>
-<span class="p">}</span>
-
-<span class="c1"># list of available codes</span>
-<span class="n">__code_range__</span> <span class="o">=</span> <span class="p">([</span><span class="mi">1</span><span class="p">,</span> <span class="mi">4</span><span class="p">]</span> <span class="o">+</span> <span class="nb">list</span><span class="p">(</span><span class="nb">range</span><span class="p">(</span><span class="mi">30</span><span class="p">,</span> <span class="mi">38</span><span class="p">))</span> <span class="o">+</span> <span class="nb">list</span><span class="p">(</span><span class="nb">range</span><span class="p">(</span><span class="mi">40</span><span class="p">,</span> <span class="mi">48</span><span class="p">))</span>
- <span class="o">+</span> <span class="nb">list</span><span class="p">(</span><span class="nb">range</span><span class="p">(</span><span class="mi">90</span><span class="p">,</span> <span class="mi">98</span><span class="p">))</span> <span class="o">+</span> <span class="nb">list</span><span class="p">(</span><span class="nb">range</span><span class="p">(</span><span class="mi">100</span><span class="p">,</span> <span class="mi">108</span><span class="p">)))</span>
-
-<div class="viewcode-block" id="printc"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.printcolors.printc">[docs]</a><span class="k">def</span> <span class="nf">printc</span><span class="p">(</span><span class="n">txt</span><span class="p">,</span> <span class="n">code</span><span class="o">=</span><span class="s1">''</span><span class="p">):</span>
- <span class="sd">'''print a text with colors</span>
-<span class="sd"> </span>
-<span class="sd"> :param txt str: The text to be printed.</span>
-<span class="sd"> :param code str: The color to use.</span>
-<span class="sd"> :return: The colored text.</span>
-<span class="sd"> :rtype: str</span>
-<span class="sd"> '''</span>
- <span class="c1"># no code means 'auto mode' (works only for OK, KO, NO and ERR*)</span>
- <span class="k">if</span> <span class="n">code</span> <span class="o">==</span> <span class="s1">''</span><span class="p">:</span>
- <span class="n">striptxt</span> <span class="o">=</span> <span class="n">txt</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span>
- <span class="k">if</span> <span class="n">striptxt</span> <span class="o">==</span> <span class="s2">"OK"</span><span class="p">:</span>
- <span class="n">code</span> <span class="o">=</span> <span class="n">COLOR_SUCCESS</span>
- <span class="k">elif</span> <span class="n">striptxt</span> <span class="ow">in</span> <span class="p">[</span><span class="s2">"KO"</span><span class="p">,</span> <span class="s2">"NO"</span><span class="p">]</span> <span class="ow">or</span> <span class="n">striptxt</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s2">"ERR"</span><span class="p">):</span>
- <span class="n">code</span> <span class="o">=</span> <span class="n">COLOR_ERROR</span>
- <span class="k">else</span><span class="p">:</span>
- <span class="k">return</span> <span class="n">txt</span>
-
- <span class="c1"># no code => output the originial text</span>
- <span class="k">if</span> <span class="n">code</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">__colormap__</span><span class="o">.</span><span class="n">keys</span><span class="p">()</span> <span class="ow">or</span> <span class="n">__colormap__</span><span class="p">[</span><span class="n">code</span><span class="p">]</span> <span class="o">==</span> <span class="s1">''</span><span class="p">:</span>
- <span class="k">return</span> <span class="n">txt</span>
-
- <span class="k">return</span> <span class="n">__colormap__</span><span class="p">[</span><span class="n">code</span><span class="p">]</span> <span class="o">+</span> <span class="n">txt</span> <span class="o">+</span> <span class="s1">'</span><span class="se">\033</span><span class="s1">[0m'</span></div>
-
-<div class="viewcode-block" id="printcInfo"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.printcolors.printcInfo">[docs]</a><span class="k">def</span> <span class="nf">printcInfo</span><span class="p">(</span><span class="n">txt</span><span class="p">):</span>
- <span class="sd">'''print a text info color</span>
-<span class="sd"> </span>
-<span class="sd"> :param txt str: The text to be printed.</span>
-<span class="sd"> :return: The colored text.</span>
-<span class="sd"> :rtype: str</span>
-<span class="sd"> '''</span>
- <span class="k">return</span> <span class="n">printc</span><span class="p">(</span><span class="n">txt</span><span class="p">,</span> <span class="n">COLOR_INFO</span><span class="p">)</span></div>
-
-<div class="viewcode-block" id="printcError"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.printcolors.printcError">[docs]</a><span class="k">def</span> <span class="nf">printcError</span><span class="p">(</span><span class="n">txt</span><span class="p">):</span>
- <span class="sd">'''print a text error color</span>
-<span class="sd"> </span>
-<span class="sd"> :param txt str: The text to be printed.</span>
-<span class="sd"> :return: The colored text.</span>
-<span class="sd"> :rtype: str</span>
-<span class="sd"> '''</span>
- <span class="k">return</span> <span class="n">printc</span><span class="p">(</span><span class="n">txt</span><span class="p">,</span> <span class="n">COLOR_ERROR</span><span class="p">)</span></div>
-
-<div class="viewcode-block" id="printcWarning"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.printcolors.printcWarning">[docs]</a><span class="k">def</span> <span class="nf">printcWarning</span><span class="p">(</span><span class="n">txt</span><span class="p">):</span>
- <span class="sd">'''print a text warning color</span>
-<span class="sd"> </span>
-<span class="sd"> :param txt str: The text to be printed.</span>
-<span class="sd"> :return: The colored text.</span>
-<span class="sd"> :rtype: str</span>
-<span class="sd"> '''</span>
- <span class="k">return</span> <span class="n">printc</span><span class="p">(</span><span class="n">txt</span><span class="p">,</span> <span class="n">COLOR_WARNING</span><span class="p">)</span></div>
-
-<div class="viewcode-block" id="printcHeader"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.printcolors.printcHeader">[docs]</a><span class="k">def</span> <span class="nf">printcHeader</span><span class="p">(</span><span class="n">txt</span><span class="p">):</span>
- <span class="sd">'''print a text header color</span>
-<span class="sd"> </span>
-<span class="sd"> :param txt str: The text to be printed.</span>
-<span class="sd"> :return: The colored text.</span>
-<span class="sd"> :rtype: str</span>
-<span class="sd"> '''</span>
- <span class="k">return</span> <span class="n">printc</span><span class="p">(</span><span class="n">txt</span><span class="p">,</span> <span class="n">COLOR_HEADER</span><span class="p">)</span></div>
-
-<div class="viewcode-block" id="printcLabel"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.printcolors.printcLabel">[docs]</a><span class="k">def</span> <span class="nf">printcLabel</span><span class="p">(</span><span class="n">txt</span><span class="p">):</span>
- <span class="sd">'''print a text label color</span>
-<span class="sd"> </span>
-<span class="sd"> :param txt str: The text to be printed.</span>
-<span class="sd"> :return: The colored text.</span>
-<span class="sd"> :rtype: str</span>
-<span class="sd"> '''</span>
- <span class="k">return</span> <span class="n">printc</span><span class="p">(</span><span class="n">txt</span><span class="p">,</span> <span class="n">COLOR_LABEL</span><span class="p">)</span></div>
-
-<div class="viewcode-block" id="printcSuccess"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.printcolors.printcSuccess">[docs]</a><span class="k">def</span> <span class="nf">printcSuccess</span><span class="p">(</span><span class="n">txt</span><span class="p">):</span>
- <span class="sd">'''print a text success color</span>
-<span class="sd"> </span>
-<span class="sd"> :param txt str: The text to be printed.</span>
-<span class="sd"> :return: The colored text.</span>
-<span class="sd"> :rtype: str</span>
-<span class="sd"> '''</span>
- <span class="k">return</span> <span class="n">printc</span><span class="p">(</span><span class="n">txt</span><span class="p">,</span> <span class="n">COLOR_SUCCESS</span><span class="p">)</span></div>
-
-<div class="viewcode-block" id="printcHighlight"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.printcolors.printcHighlight">[docs]</a><span class="k">def</span> <span class="nf">printcHighlight</span><span class="p">(</span><span class="n">txt</span><span class="p">):</span>
- <span class="sd">'''print a text highlight color</span>
-<span class="sd"> </span>
-<span class="sd"> :param txt str: The text to be printed.</span>
-<span class="sd"> :return: The colored text.</span>
-<span class="sd"> :rtype: str</span>
-<span class="sd"> '''</span>
- <span class="k">return</span> <span class="n">printc</span><span class="p">(</span><span class="n">txt</span><span class="p">,</span> <span class="n">COLOR_HIGLIGHT</span><span class="p">)</span></div>
-
-<div class="viewcode-block" id="cleancolor"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.printcolors.cleancolor">[docs]</a><span class="k">def</span> <span class="nf">cleancolor</span><span class="p">(</span><span class="n">message</span><span class="p">):</span>
- <span class="sd">'''remove color from a colored text.</span>
-<span class="sd"> </span>
-<span class="sd"> :param message str: The text to be cleaned.</span>
-<span class="sd"> :return: The cleaned text.</span>
-<span class="sd"> :rtype: str</span>
-<span class="sd"> '''</span>
- <span class="k">if</span> <span class="n">message</span> <span class="o">==</span> <span class="kc">None</span><span class="p">:</span>
- <span class="k">return</span> <span class="n">message</span>
-
- <span class="n">message</span> <span class="o">=</span> <span class="n">message</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'</span><span class="se">\033</span><span class="s1">[0m'</span><span class="p">,</span> <span class="s1">''</span><span class="p">)</span>
- <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="n">__code_range__</span><span class="p">:</span>
- <span class="n">message</span> <span class="o">=</span> <span class="n">message</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'</span><span class="se">\033</span><span class="s1">[</span><span class="si">%d</span><span class="s1">m'</span> <span class="o">%</span> <span class="n">i</span><span class="p">,</span> <span class="s1">''</span><span class="p">)</span>
- <span class="k">return</span> <span class="n">message</span></div>
-
-<div class="viewcode-block" id="print_value"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.printcolors.print_value">[docs]</a><span class="k">def</span> <span class="nf">print_value</span><span class="p">(</span><span class="n">logger</span><span class="p">,</span> <span class="n">label</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">level</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">suffix</span><span class="o">=</span><span class="s2">""</span><span class="p">):</span>
- <span class="sd">'''shortcut method to print a label and a value with the info color</span>
-<span class="sd"> </span>
-<span class="sd"> :param logger class logger: the logger instance.</span>
-<span class="sd"> :param label int: the label to print.</span>
-<span class="sd"> :param value str: the value to print.</span>
-<span class="sd"> :param level int: the level of verboseness.</span>
-<span class="sd"> :param suffix str: the suffix to add at the end.</span>
-<span class="sd"> '''</span>
- <span class="k">if</span> <span class="n">logger</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
- <span class="nb">print</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="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">label</span><span class="p">,</span> <span class="n">printcInfo</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)),</span> <span class="n">suffix</span><span class="p">))</span>
- <span class="k">else</span><span class="p">:</span>
- <span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="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="se">\n</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">label</span><span class="p">,</span> <span class="n">printcInfo</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)),</span>
- <span class="n">suffix</span><span class="p">),</span> <span class="n">level</span><span class="p">)</span></div>
-
-<div class="viewcode-block" id="print_color_range"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.printcolors.print_color_range">[docs]</a><span class="k">def</span> <span class="nf">print_color_range</span><span class="p">(</span><span class="n">start</span><span class="p">,</span> <span class="n">end</span><span class="p">):</span>
- <span class="sd">'''print possible range values for colors</span>
-<span class="sd"> </span>
-<span class="sd"> :param start int: The smaller value.</span>
-<span class="sd"> :param end int: The bigger value.</span>
-<span class="sd"> '''</span>
- <span class="k">for</span> <span class="n">k</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">start</span><span class="p">,</span> <span class="n">end</span><span class="o">+</span><span class="mi">1</span><span class="p">):</span>
- <span class="nb">print</span><span class="p">(</span><span class="s2">"</span><span class="se">\033</span><span class="s2">[</span><span class="si">%d</span><span class="s2">m</span><span class="si">%3d</span><span class="se">\033</span><span class="s2">[0m"</span> <span class="o">%</span> <span class="p">(</span><span class="n">k</span><span class="p">,</span> <span class="n">k</span><span class="p">),)</span>
- <span class="nb">print</span></div>
-
-<span class="c1"># This method prints the color map</span>
-<div class="viewcode-block" id="print_color_map"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.printcolors.print_color_map">[docs]</a><span class="k">def</span> <span class="nf">print_color_map</span><span class="p">():</span>
- <span class="sd">'''This method prints the color map</span>
-<span class="sd"> '''</span>
- <span class="nb">print</span><span class="p">(</span><span class="s2">"colormap:"</span><span class="p">)</span>
- <span class="nb">print</span><span class="p">(</span><span class="s2">"{"</span><span class="p">)</span>
- <span class="k">for</span> <span class="n">k</span> <span class="ow">in</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">__colormap__</span><span class="o">.</span><span class="n">keys</span><span class="p">()):</span>
- <span class="n">codes</span> <span class="o">=</span> <span class="n">__colormap__</span><span class="p">[</span><span class="n">k</span><span class="p">]</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">'</span><span class="se">\033</span><span class="s1">['</span><span class="p">)</span>
- <span class="n">codes</span> <span class="o">=</span> <span class="nb">filter</span><span class="p">(</span><span class="k">lambda</span> <span class="n">l</span><span class="p">:</span> <span class="nb">len</span><span class="p">(</span><span class="n">l</span><span class="p">)</span> <span class="o">></span> <span class="mi">0</span><span class="p">,</span> <span class="n">codes</span><span class="p">)</span>
- <span class="n">codes</span> <span class="o">=</span> <span class="nb">map</span><span class="p">(</span><span class="k">lambda</span> <span class="n">l</span><span class="p">:</span> <span class="n">l</span><span class="p">[:</span><span class="o">-</span><span class="mi">1</span><span class="p">],</span> <span class="n">codes</span><span class="p">)</span>
- <span class="nb">print</span><span class="p">(</span><span class="n">printc</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">k</span><span class="p">,</span> <span class="s1">';'</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">codes</span><span class="p">)),</span> <span class="n">k</span><span class="p">))</span>
- <span class="nb">print</span><span class="p">(</span><span class="s2">"}"</span><span class="p">)</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
-
<!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.product — salomeTools 5.0.0dev documentation</title>
+
<link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
- <script type="text/javascript" src="../../_static/documentation_options.js"></script>
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
- <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/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="top" title="salomeTools 5.0.0dev documentation" href="../../index.html" />
+ <link rel="up" title="Module code" href="../index.html" />
<link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
- </head><body>
+ </head>
+ <body role="document">
<div class="document">
<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">In this file are implemented the methods </span>
-<span class="sd">relative to the product notion of salomeTools</span>
-<span class="sd">"""</span>
+<span class="sd">'''In this file are implemented the methods </span>
+<span class="sd"> relative to the product notion of salomeTools</span>
+<span class="sd">'''</span>
<span class="kn">import</span> <span class="nn">os</span>
<span class="kn">import</span> <span class="nn">re</span>
-<span class="kn">import</span> <span class="nn">src</span>
-<span class="kn">import</span> <span class="nn">src.debug</span> <span class="k">as</span> <span class="nn">DBG</span>
+<span class="kn">import</span> <span class="nn">src.pyconf</span> <span class="k">as</span> <span class="nn">PYCONF</span>
+<span class="kn">import</span> <span class="nn">src.utilsSat</span> <span class="k">as</span> <span class="nn">UTS</span>
<span class="n">AVAILABLE_VCS</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'git'</span><span class="p">,</span> <span class="s1">'svn'</span><span class="p">,</span> <span class="s1">'cvs'</span><span class="p">]</span>
<span class="n">config_expression</span> <span class="o">=</span> <span class="s2">"^config-\d+$"</span>
<span class="n">VERSION_DELIMITER</span> <span class="o">=</span> <span class="s2">"_to_"</span>
<div class="viewcode-block" id="get_product_config"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.get_product_config">[docs]</a><span class="k">def</span> <span class="nf">get_product_config</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">product_name</span><span class="p">,</span> <span class="n">with_install_dir</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
- <span class="sd">"""Get the specific configuration of a product from the global configuration</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Get the specific configuration of a product from the global configuration</span>
<span class="sd"> </span>
<span class="sd"> :param config Config: The global configuration</span>
<span class="sd"> :param product_name str: The name of the product</span>
<span class="n">dev</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="nb">isinstance</span><span class="p">(</span><span class="n">version</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="n">dic_version</span> <span class="o">=</span> <span class="n">version</span>
<span class="c1"># Get the version/tag</span>
<span class="k">if</span> <span class="ow">not</span> <span class="s1">'tag'</span> <span class="ow">in</span> <span class="n">dic_version</span><span class="p">:</span>
<span class="k">if</span> <span class="n">version</span> <span class="o">==</span> <span class="s2">"native"</span><span class="p">:</span>
<span class="n">prod_info</span><span class="o">.</span><span class="n">get_source</span> <span class="o">=</span> <span class="s2">"native"</span>
<span class="k">elif</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">get_source</span> <span class="o">==</span> <span class="s2">"native"</span><span class="p">:</span>
- <span class="n">msg</span> <span class="o">=</span> <span class="n">_</span><span class="p">(</span><span class="s2">"The product </span><span class="si">%(prod)s</span><span class="s2"> has version </span><span class="si">%(ver)s</span><span class="s2"> but is "</span>
- <span class="s2">"declared as native in its definition"</span> <span class="o">%</span>
- <span class="p">{</span> <span class="s1">'prod'</span><span class="p">:</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="s1">'ver'</span><span class="p">:</span> <span class="n">version</span><span class="p">})</span>
- <span class="k">raise</span> <span class="n">src</span><span class="o">.</span><span class="n">SatException</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
+ <span class="n">msg</span> <span class="o">=</span> <span class="n">_</span><span class="p">(</span><span class="s2">"The product </span><span class="si">%s</span><span class="s2"> has version </span><span class="si">%s</span><span class="s2"> but is declared as native in its definition"</span><span class="p">)</span> <span class="o">%</span> \
+ <span class="p">(</span><span class="n">prod_info</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">version</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"># If there is no definition but the product is declared as native,</span>
<span class="c1"># construct a new definition containing only the get_source key</span>
<span class="k">if</span> <span class="n">prod_info</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">version</span> <span class="o">==</span> <span class="s2">"native"</span><span class="p">:</span>
- <span class="n">prod_info</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">pyconf</span><span class="o">.</span><span class="n">Config</span><span class="p">()</span>
+ <span class="n">prod_info</span> <span class="o">=</span> <span class="n">PYCONF</span><span class="o">.</span><span class="n">Config</span><span class="p">()</span>
<span class="n">prod_info</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">product_name</span>
<span class="n">prod_info</span><span class="o">.</span><span class="n">get_source</span> <span class="o">=</span> <span class="s2">"native"</span>
<span class="c1"># If there is no definition but the product is fixed,</span>
<span class="c1"># construct a new definition containing only the product name</span>
<span class="k">if</span> <span class="n">prod_info</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isdir</span><span class="p">(</span><span class="n">version</span><span class="p">):</span>
- <span class="n">prod_info</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">pyconf</span><span class="o">.</span><span class="n">Config</span><span class="p">()</span>
+ <span class="n">prod_info</span> <span class="o">=</span> <span class="n">PYCONF</span><span class="o">.</span><span class="n">Config</span><span class="p">()</span>
<span class="n">prod_info</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">product_name</span>
<span class="n">prod_info</span><span class="o">.</span><span class="n">get_source</span> <span class="o">=</span> <span class="s2">"fixed"</span>
- <span class="n">prod_info</span><span class="o">.</span><span class="n">addMapping</span><span class="p">(</span><span class="s2">"environ"</span><span class="p">,</span> <span class="n">src</span><span class="o">.</span><span class="n">pyconf</span><span class="o">.</span><span class="n">Mapping</span><span class="p">(</span><span class="n">prod_info</span><span class="p">),</span> <span class="s2">""</span><span class="p">)</span>
+ <span class="n">prod_info</span><span class="o">.</span><span class="n">addMapping</span><span class="p">(</span><span class="s2">"environ"</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="n">prod_info</span><span class="p">),</span> <span class="s2">""</span><span class="p">)</span>
<span class="c1"># If prod_info is still None, it means that there is no product definition</span>
<span class="c1"># in the config. The user has to provide it.</span>
<span class="k">if</span> <span class="n">prod_info</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
- <span class="n">prod_pyconf_path</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">find_file_in_lpath</span><span class="p">(</span><span class="n">product_name</span> <span class="o">+</span> <span class="s2">".pyconf"</span><span class="p">,</span>
+ <span class="n">prod_pyconf_path</span> <span class="o">=</span> <span class="n">UTS</span><span class="o">.</span><span class="n">find_file_in_lpath</span><span class="p">(</span><span class="n">product_name</span> <span class="o">+</span> <span class="s2">".pyconf"</span><span class="p">,</span>
<span class="n">config</span><span class="o">.</span><span class="n">PATHS</span><span class="o">.</span><span class="n">PRODUCTPATH</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">prod_pyconf_path</span><span class="p">:</span>
<span class="n">msg</span> <span class="o">=</span> <span class="n">_</span><span class="p">(</span><span class="s2">"""</span><span class="se">\</span>
<span class="s2">No definition found for the product </span><span class="si">%(1)s</span><span class="s2">.</span>
-<span class="s2">Please create a </span><span class="si">%(2)s</span><span class="s2">.pyconf file somewhere in:</span>
-<span class="si">%(3)s</span><span class="s2">"""</span><span class="p">)</span> <span class="o">%</span> <span class="p">{</span>
+<span class="s2">Please create a </span><span class="si">%(2)s</span><span class="s2">.pyconf file somewhere in:</span><span class="se">\n</span><span class="si">%(3)s</span><span class="s2">"""</span><span class="p">)</span> <span class="o">%</span> <span class="p">{</span>
<span class="s2">"1"</span><span class="p">:</span> <span class="n">product_name</span><span class="p">,</span>
<span class="s2">"2"</span><span class="p">:</span> <span class="n">product_name</span><span class="p">,</span>
<span class="s2">"3"</span><span class="p">:</span> <span class="n">config</span><span class="o">.</span><span class="n">PATHS</span><span class="o">.</span><span class="n">PRODUCTPATH</span> <span class="p">}</span>
<span class="s2">No definition corresponding to the version </span><span class="si">%(1)s</span><span class="s2"> was found in the file:</span>
<span class="s2"> </span><span class="si">%(2)s</span><span class="s2">.</span>
<span class="s2">Please add a section in it."""</span><span class="p">)</span> <span class="o">%</span> <span class="p">{</span><span class="s2">"1"</span> <span class="p">:</span> <span class="n">vv</span><span class="p">,</span> <span class="s2">"2"</span> <span class="p">:</span> <span class="n">prod_pyconf_path</span><span class="p">}</span>
- <span class="k">raise</span> <span class="n">src</span><span class="o">.</span><span class="n">SatException</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
+ <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="n">msg</span><span class="p">)</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="k">if</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">get_source</span> <span class="o">==</span> <span class="s2">"archive"</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="s2">"archive_info"</span> <span class="ow">in</span> <span class="n">prod_info</span><span class="p">:</span>
<span class="n">prod_info</span><span class="o">.</span><span class="n">addMapping</span><span class="p">(</span><span class="s2">"archive_info"</span><span class="p">,</span>
- <span class="n">src</span><span class="o">.</span><span class="n">pyconf</span><span class="o">.</span><span class="n">Mapping</span><span class="p">(</span><span class="n">prod_info</span><span class="p">),</span>
+ <span class="n">PYCONF</span><span class="o">.</span><span class="n">Mapping</span><span class="p">(</span><span class="n">prod_info</span><span class="p">),</span>
<span class="s2">""</span><span class="p">)</span>
<span class="k">if</span> <span class="s2">"archive_name"</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">archive_info</span><span class="p">:</span>
<span class="n">arch_name</span> <span class="o">=</span> <span class="n">product_name</span> <span class="o">+</span> <span class="s2">"-"</span> <span class="o">+</span> <span class="n">version</span> <span class="o">+</span> <span class="s2">".tar.gz"</span>
- <span class="n">arch_path</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">find_file_in_lpath</span><span class="p">(</span><span class="n">arch_name</span><span class="p">,</span>
+ <span class="n">arch_path</span> <span class="o">=</span> <span class="n">UTS</span><span class="o">.</span><span class="n">find_file_in_lpath</span><span class="p">(</span><span class="n">arch_name</span><span class="p">,</span>
<span class="n">config</span><span class="o">.</span><span class="n">PATHS</span><span class="o">.</span><span class="n">ARCHIVEPATH</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">arch_path</span><span class="p">:</span>
- <span class="n">msg</span> <span class="o">=</span> <span class="n">_</span><span class="p">(</span><span class="s2">"Archive </span><span class="si">%(1)s</span><span class="s2"> for </span><span class="si">%(2)s</span><span class="s2"> not found in config.PATHS.ARCHIVEPATH"</span><span class="p">)</span> <span class="o">%</span> \
+ <span class="n">msg</span> <span class="o">=</span> <span class="n">_</span><span class="p">(</span><span class="s2">"Archive </span><span class="si">%(1)s</span><span class="s2"> for </span><span class="si">%(2)s</span><span class="s2"> not found.</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span> <span class="o">%</span> \
<span class="p">{</span><span class="s2">"1"</span> <span class="p">:</span> <span class="n">arch_name</span><span class="p">,</span> <span class="s2">"2"</span> <span class="p">:</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">name</span><span class="p">}</span>
- <span class="n">DBG</span><span class="o">.</span><span class="n">tofix</span><span class="p">(</span><span class="n">msg</span><span class="p">,</span> <span class="n">config</span><span class="o">.</span><span class="n">PATHS</span><span class="o">.</span><span class="n">ARCHIVEPATH</span><span class="p">)</span>
- <span class="n">prod_info</span><span class="o">.</span><span class="n">archive_info</span><span class="o">.</span><span class="n">archive_name</span> <span class="o">=</span> <span class="n">arch_name</span> <span class="c1">#without path</span>
- <span class="c1"># raise src.SatException(msg) #may be a warning, continue #8646</span>
- <span class="k">else</span><span class="p">:</span>
- <span class="n">prod_info</span><span class="o">.</span><span class="n">archive_info</span><span class="o">.</span><span class="n">archive_name</span> <span class="o">=</span> <span class="n">arch_path</span>
+ <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
+ <span class="n">prod_info</span><span class="o">.</span><span class="n">archive_info</span><span class="o">.</span><span class="n">archive_name</span> <span class="o">=</span> <span class="n">arch_path</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">if</span> <span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">basename</span><span class="p">(</span><span class="n">prod_info</span><span class="o">.</span><span class="n">archive_info</span><span class="o">.</span><span class="n">archive_name</span><span class="p">)</span> <span class="o">==</span>
<span class="n">prod_info</span><span class="o">.</span><span class="n">archive_info</span><span class="o">.</span><span class="n">archive_name</span><span class="p">):</span>
<span class="n">arch_name</span> <span class="o">=</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">archive_info</span><span class="o">.</span><span class="n">archive_name</span>
- <span class="n">arch_path</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">find_file_in_lpath</span><span class="p">(</span>
+ <span class="n">arch_path</span> <span class="o">=</span> <span class="n">UTS</span><span class="o">.</span><span class="n">find_file_in_lpath</span><span class="p">(</span>
<span class="n">arch_name</span><span class="p">,</span>
<span class="n">config</span><span class="o">.</span><span class="n">PATHS</span><span class="o">.</span><span class="n">ARCHIVEPATH</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">arch_path</span><span class="p">:</span>
- <span class="n">msg</span> <span class="o">=</span> <span class="n">_</span><span class="p">(</span><span class="s2">"Archive </span><span class="si">%(1)s</span><span class="s2"> for </span><span class="si">%(2)s</span><span class="s2"> not found in config.PATHS.ARCHIVEPATH"</span><span class="p">)</span> <span class="o">%</span> \
+ <span class="n">msg</span> <span class="o">=</span> <span class="n">_</span><span class="p">(</span><span class="s2">"Archive </span><span class="si">%(1)s</span><span class="s2"> for </span><span class="si">%(2)s</span><span class="s2"> not found:</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span> <span class="o">%</span> \
<span class="p">{</span><span class="s2">"1"</span> <span class="p">:</span> <span class="n">arch_name</span><span class="p">,</span> <span class="s2">"2"</span> <span class="p">:</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">name</span><span class="p">}</span>
- <span class="n">DBG</span><span class="o">.</span><span class="n">tofix</span><span class="p">(</span><span class="n">msg</span><span class="p">,</span> <span class="n">config</span><span class="o">.</span><span class="n">PATHS</span><span class="o">.</span><span class="n">ARCHIVEPATH</span><span class="p">)</span> <span class="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="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
<span class="n">prod_info</span><span class="o">.</span><span class="n">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="n">msg</span> <span class="o">=</span> <span class="n">_</span><span class="p">(</span><span class="s2">"""</span><span class="se">\</span>
<span class="s2">No compilation script found for the product </span><span class="si">%s</span><span class="s2">.</span>
<span class="s2">Please provide a 'compil_script' key in its definition."""</span><span class="p">)</span> <span class="o">%</span> <span class="n">product_name</span>
- <span class="k">raise</span> <span class="n">src</span><span class="o">.</span><span class="n">SatException</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
+ <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
<span class="c1"># Get the path of the script</span>
<span class="n">script</span> <span class="o">=</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">compil_script</span>
<span class="n">script_name</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">basename</span><span class="p">(</span><span class="n">script</span><span class="p">)</span>
<span class="k">if</span> <span class="n">script</span> <span class="o">==</span> <span class="n">script_name</span><span class="p">:</span>
<span class="c1"># Only a name is given. Search in the default directory</span>
- <span class="n">script_path</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">find_file_in_lpath</span><span class="p">(</span><span class="n">script_name</span><span class="p">,</span>
+ <span class="n">script_path</span> <span class="o">=</span> <span class="n">UTS</span><span class="o">.</span><span class="n">find_file_in_lpath</span><span class="p">(</span><span class="n">script_name</span><span class="p">,</span>
<span class="n">config</span><span class="o">.</span><span class="n">PATHS</span><span class="o">.</span><span class="n">PRODUCTPATH</span><span class="p">,</span>
<span class="s2">"compil_scripts"</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">script_path</span><span class="p">:</span>
- <span class="k">raise</span> <span class="n">src</span><span class="o">.</span><span class="n">SatException</span><span class="p">(</span>
+ <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span>
<span class="n">_</span><span class="p">(</span><span class="s2">"Compilation script not found: </span><span class="si">%s</span><span class="s2">"</span><span class="p">)</span> <span class="o">%</span> <span class="n">script_name</span><span class="p">)</span>
<span class="n">prod_info</span><span class="o">.</span><span class="n">compil_script</span> <span class="o">=</span> <span class="n">script_path</span>
<span class="k">if</span> <span class="n">src</span><span class="o">.</span><span class="n">architecture</span><span class="o">.</span><span class="n">is_windows</span><span class="p">():</span>
<span class="c1"># Check that the script is executable</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">access</span><span class="p">(</span><span class="n">prod_info</span><span class="o">.</span><span class="n">compil_script</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">X_OK</span><span class="p">):</span>
- <span class="c1">#raise src.SatException(</span>
+ <span class="c1">#raise Exception(</span>
<span class="c1"># _("Compilation script cannot be executed: %s") % </span>
<span class="c1"># prod_info.compil_script)</span>
- <span class="n">DBG</span><span class="o">.</span><span class="n">tofix</span><span class="p">(</span><span class="s2">"Compilation script cannot be executed:"</span><span class="p">,</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">compil_script</span><span class="p">)</span>
+ <span class="nb">print</span><span class="p">(</span><span class="s2">"Compilation script cannot be executed: </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">compil_script</span><span class="p">)</span>
<span class="c1"># Get the full paths of all the patches</span>
<span class="k">if</span> <span class="n">product_has_patches</span><span class="p">(</span><span class="n">prod_info</span><span class="p">):</span>
<span class="n">patches</span> <span class="o">=</span> <span class="p">[]</span>
- <span class="k">try</span><span class="p">:</span>
- <span class="k">for</span> <span class="n">patch</span> <span class="ow">in</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">patches</span><span class="p">:</span>
- <span class="n">patch_path</span> <span class="o">=</span> <span class="n">patch</span>
- <span class="c1"># If only a filename, then search for the patch in the PRODUCTPATH</span>
- <span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">basename</span><span class="p">(</span><span class="n">patch_path</span><span class="p">)</span> <span class="o">==</span> <span class="n">patch_path</span><span class="p">:</span>
- <span class="c1"># Search in the PRODUCTPATH/patches</span>
- <span class="n">patch_path</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">find_file_in_lpath</span><span class="p">(</span><span class="n">patch</span><span class="p">,</span>
- <span class="n">config</span><span class="o">.</span><span class="n">PATHS</span><span class="o">.</span><span class="n">PRODUCTPATH</span><span class="p">,</span>
- <span class="s2">"patches"</span><span class="p">)</span>
- <span class="k">if</span> <span class="ow">not</span> <span class="n">patch_path</span><span class="p">:</span>
- <span class="n">msg</span> <span class="o">=</span> <span class="n">_</span><span class="p">(</span><span class="s2">"Patch </span><span class="si">%(patch_name)s</span><span class="s2"> for </span><span class="si">%(prod_name)s</span><span class="s2"> not found:"</span>
- <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span> <span class="p">{</span><span class="s2">"patch_name"</span> <span class="p">:</span> <span class="n">patch</span><span class="p">,</span>
- <span class="s2">"prod_name"</span> <span class="p">:</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">name</span><span class="p">})</span>
- <span class="k">raise</span> <span class="n">src</span><span class="o">.</span><span class="n">SatException</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
- <span class="n">patches</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">patch_path</span><span class="p">)</span>
- <span class="k">except</span><span class="p">:</span>
- <span class="n">DBG</span><span class="o">.</span><span class="n">tofix</span><span class="p">(</span><span class="s2">"problem in prod_info.patches"</span><span class="p">,</span> <span class="n">prod_info</span><span class="p">)</span>
+ <span class="k">for</span> <span class="n">patch</span> <span class="ow">in</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">patches</span><span class="p">:</span>
+ <span class="n">patch_path</span> <span class="o">=</span> <span class="n">patch</span>
+ <span class="c1"># If only a filename, then search for the patch in the PRODUCTPATH</span>
+ <span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">basename</span><span class="p">(</span><span class="n">patch_path</span><span class="p">)</span> <span class="o">==</span> <span class="n">patch_path</span><span class="p">:</span>
+ <span class="c1"># Search in the PRODUCTPATH/patches</span>
+ <span class="n">patch_path</span> <span class="o">=</span> <span class="n">UTS</span><span class="o">.</span><span class="n">find_file_in_lpath</span><span class="p">(</span><span class="n">patch</span><span class="p">,</span>
+ <span class="n">config</span><span class="o">.</span><span class="n">PATHS</span><span class="o">.</span><span class="n">PRODUCTPATH</span><span class="p">,</span>
+ <span class="s2">"patches"</span><span class="p">)</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">patch_path</span><span class="p">:</span>
+ <span class="n">msg</span> <span class="o">=</span> <span class="n">_</span><span class="p">(</span><span class="s2">"Patch </span><span class="si">%(1)s</span><span class="s2"> for </span><span class="si">%(2)s</span><span class="s2"> not found:</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span> <span class="o">%</span> \
+ <span class="p">{</span><span class="s2">"1"</span> <span class="p">:</span> <span class="n">patch</span><span class="p">,</span> <span class="s2">"2"</span> <span class="p">:</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">name</span><span class="p">}</span>
+ <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
+ <span class="n">patches</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">patch_path</span><span class="p">)</span>
<span class="n">prod_info</span><span class="o">.</span><span class="n">patches</span> <span class="o">=</span> <span class="n">patches</span>
<span class="c1"># Get the full paths of the environment scripts</span>
<span class="c1"># in the PRODUCTPATH/env_scripts</span>
<span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">basename</span><span class="p">(</span><span class="n">env_script_path</span><span class="p">)</span> <span class="o">==</span> <span class="n">env_script_path</span><span class="p">:</span>
<span class="c1"># Search in the PRODUCTPATH/env_scripts</span>
- <span class="n">env_script_path</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">find_file_in_lpath</span><span class="p">(</span>
+ <span class="n">env_script_path</span> <span class="o">=</span> <span class="n">UTS</span><span class="o">.</span><span class="n">find_file_in_lpath</span><span class="p">(</span>
<span class="n">prod_info</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">env_script</span><span class="p">,</span>
<span class="n">config</span><span class="o">.</span><span class="n">PATHS</span><span class="o">.</span><span class="n">PRODUCTPATH</span><span class="p">,</span>
<span class="s2">"env_scripts"</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">env_script_path</span><span class="p">:</span>
- <span class="n">msg</span> <span class="o">=</span> <span class="n">_</span><span class="p">(</span><span class="s2">"Environment script </span><span class="si">%(env_name)s</span><span class="s2"> for </span><span class="si">%(prod_name)s</span><span class="s2"> not "</span>
- <span class="s2">"found.</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span> <span class="p">{</span><span class="s2">"env_name"</span> <span class="p">:</span> <span class="n">env_script_path</span><span class="p">,</span>
- <span class="s2">"prod_name"</span> <span class="p">:</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">name</span><span class="p">})</span>
- <span class="k">raise</span> <span class="n">src</span><span class="o">.</span><span class="n">SatException</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
+ <span class="n">msg</span> <span class="o">=</span> <span class="n">_</span><span class="p">(</span><span class="s2">"Environment script </span><span class="si">%(1)s</span><span class="s2"> for </span><span class="si">%(2)s</span><span class="s2"> not found.</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span> <span class="o">%</span> \
+ <span class="p">{</span><span class="s2">"1"</span> <span class="p">:</span> <span class="n">env_script_path</span><span class="p">,</span> <span class="s2">"2"</span> <span class="p">:</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">name</span><span class="p">}</span>
+ <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
<span class="n">prod_info</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">env_script</span> <span class="o">=</span> <span class="n">env_script_path</span>
<span class="k">return</span> <span class="n">prod_info</span></div>
<div class="viewcode-block" id="get_product_section"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.get_product_section">[docs]</a><span class="k">def</span> <span class="nf">get_product_section</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">product_name</span><span class="p">,</span> <span class="n">version</span><span class="p">,</span> <span class="n">section</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
- <span class="sd">"""Get the product description from the configuration</span>
+ <span class="sd">'''Get the product description from the configuration</span>
<span class="sd"> </span>
<span class="sd"> :param config Config: The global configuration</span>
<span class="sd"> :param product_name str: The product name</span>
<span class="sd"> explicitly given</span>
<span class="sd"> :return: The product description</span>
<span class="sd"> :rtype: Config</span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="c1"># if section is not None, try to get the corresponding section</span>
<span class="k">if</span> <span class="n">section</span><span class="p">:</span>
<span class="k">return</span> <span class="kc">None</span></div>
<div class="viewcode-block" id="get_install_dir"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.get_install_dir">[docs]</a><span class="k">def</span> <span class="nf">get_install_dir</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">base</span><span class="p">,</span> <span class="n">version</span><span class="p">,</span> <span class="n">prod_info</span><span class="p">):</span>
- <span class="sd">"""Compute the installation directory of a given product </span>
+ <span class="sd">"""\</span>
+<span class="sd"> Compute the installation directory of a given product </span>
<span class="sd"> </span>
<span class="sd"> :param config Config: The global configuration</span>
-<span class="sd"> :param base str: This corresponds to the value given by user in its </span>
-<span class="sd"> application.pyconf for the specific product. If "yes", the</span>
-<span class="sd"> user wants the product to be in base. If "no", he wants the</span>
-<span class="sd"> product to be in the application workdir</span>
+<span class="sd"> :param base str: 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</span>
<span class="sd"> :param version str: The version of the product</span>
-<span class="sd"> :param product_info Config: The configuration specific to </span>
-<span class="sd"> the product</span>
-<span class="sd"> </span>
+<span class="sd"> :param product_info Config: The configuration specific to the product</span>
<span class="sd"> :return: The path of the product installation</span>
<span class="sd"> :rtype: str</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="n">install_dir</span></div>
<div class="viewcode-block" id="get_base_install_dir"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.get_base_install_dir">[docs]</a><span class="k">def</span> <span class="nf">get_base_install_dir</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">prod_info</span><span class="p">,</span> <span class="n">version</span><span class="p">):</span>
- <span class="sd">"""Compute the installation directory of a product in base </span>
+ <span class="sd">'''Compute the installation directory of a product in base </span>
<span class="sd"> </span>
<span class="sd"> :param config Config: The global configuration</span>
<span class="sd"> :param product_info Config: The configuration specific to </span>
<span class="sd"> :param version str: The version of the product </span>
<span class="sd"> :return: The path of the product installation</span>
<span class="sd"> :rtype: str</span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="n">base_path</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">get_base_path</span><span class="p">(</span><span class="n">config</span><span class="p">)</span>
<span class="n">prod_dir</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">base_path</span><span class="p">,</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">name</span> <span class="o">+</span> <span class="s2">"-"</span> <span class="o">+</span> <span class="n">version</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">prod_dir</span><span class="p">):</span>
<span class="k">return</span> <span class="n">install_dir</span></div>
<div class="viewcode-block" id="check_config_exists"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.check_config_exists">[docs]</a><span class="k">def</span> <span class="nf">check_config_exists</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">prod_dir</span><span class="p">,</span> <span class="n">prod_info</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Verify that the installation directory of a product in a base exists</span>
-<span class="sd"> Check all the config-<i> directory and verify the sat-config.pyconf file</span>
-<span class="sd"> that is in it </span>
+ <span class="sd">'''Verify that the installation directory of a product in a base exists</span>
+<span class="sd"> Check all the config-<i> directory and verify the sat-config.pyconf file</span>
+<span class="sd"> that is in it </span>
<span class="sd"> </span>
<span class="sd"> :param config Config: The global configuration</span>
<span class="sd"> :param prod_dir str: The product installation directory path </span>
<span class="sd"> :return: True or false is the installation is found or not </span>
<span class="sd"> and if it is found, the path of the found installation</span>
<span class="sd"> :rtype: (boolean, str)</span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="c1"># check if the directories or files of the directory corresponds to the </span>
<span class="c1"># directory installation of the product</span>
<span class="n">l_dir_and_files</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">listdir</span><span class="p">(</span><span class="n">prod_dir</span><span class="p">)</span>
<span class="c1"># If there is no dependency, it is the right path</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">prod_info</span><span class="o">.</span><span class="n">depend</span><span class="p">)</span><span class="o">==</span><span class="mi">0</span><span class="p">:</span>
- <span class="n">compile_cfg</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">pyconf</span><span class="o">.</span><span class="n">Config</span><span class="p">(</span><span class="n">config_file</span><span class="p">)</span>
+ <span class="n">compile_cfg</span> <span class="o">=</span> <span class="n">PYCONF</span><span class="o">.</span><span class="n">Config</span><span class="p">(</span><span class="n">config_file</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">compile_cfg</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">return</span> <span class="kc">True</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">prod_dir</span><span class="p">,</span> <span class="n">dir_or_file</span><span class="p">)</span>
<span class="k">continue</span>
<span class="c1"># check if there is the config described in the file corresponds the </span>
<span class="c1"># dependencies of the product</span>
<span class="n">config_corresponds</span> <span class="o">=</span> <span class="kc">True</span>
- <span class="n">compile_cfg</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">pyconf</span><span class="o">.</span><span class="n">Config</span><span class="p">(</span><span class="n">config_file</span><span class="p">)</span>
+ <span class="n">compile_cfg</span> <span class="o">=</span> <span class="n">PYCONF</span><span class="o">.</span><span class="n">Config</span><span class="p">(</span><span class="n">config_file</span><span class="p">)</span>
<span class="k">for</span> <span class="n">prod_dep</span> <span class="ow">in</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">depend</span><span class="p">:</span>
<span class="c1"># if the dependency is not in the config, </span>
<span class="c1"># the config does not correspond</span>
<div class="viewcode-block" id="get_products_infos"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.get_products_infos">[docs]</a><span class="k">def</span> <span class="nf">get_products_infos</span><span class="p">(</span><span class="n">lproducts</span><span class="p">,</span> <span class="n">config</span><span class="p">):</span>
- <span class="sd">"""Get the specific configuration of a list of products</span>
+ <span class="sd">'''Get the specific configuration of a list of products</span>
<span class="sd"> </span>
<span class="sd"> :param lproducts List: The list of product names</span>
<span class="sd"> :param config Config: The global configuration</span>
<span class="sd"> :return: the list of tuples </span>
<span class="sd"> (product name, specific configuration of the product)</span>
<span class="sd"> :rtype: [(str, Config)]</span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="n">products_infos</span> <span class="o">=</span> <span class="p">[]</span>
<span class="c1"># Loop on product names</span>
<span class="k">for</span> <span class="n">prod</span> <span class="ow">in</span> <span class="n">lproducts</span><span class="p">:</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">msg</span> <span class="o">=</span> <span class="n">_</span><span class="p">(</span><span class="s2">"The </span><span class="si">%s</span><span class="s2"> product has no definition "</span>
<span class="s2">"in the configuration."</span><span class="p">)</span> <span class="o">%</span> <span class="n">prod</span>
- <span class="k">raise</span> <span class="n">src</span><span class="o">.</span><span class="n">SatException</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
+ <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
<span class="k">return</span> <span class="n">products_infos</span></div>
<div class="viewcode-block" id="get_product_dependencies"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.get_product_dependencies">[docs]</a><span class="k">def</span> <span class="nf">get_product_dependencies</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">product_info</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Get recursively the list of products that are </span>
-<span class="sd"> in the product_info dependencies</span>
+ <span class="sd">'''Get recursively the list of products that are </span>
+<span class="sd"> in the product_info dependencies</span>
<span class="sd"> </span>
<span class="sd"> :param config Config: The global configuration</span>
<span class="sd"> :param product_info Config: The configuration specific to </span>
<span class="sd"> the product</span>
<span class="sd"> :return: the list of products in dependence</span>
<span class="sd"> :rtype: list</span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="k">if</span> <span class="s2">"depend"</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">product_info</span> <span class="ow">or</span> <span class="n">product_info</span><span class="o">.</span><span class="n">depend</span> <span class="o">==</span> <span class="p">[]:</span>
<span class="k">return</span> <span class="p">[]</span>
<span class="n">res</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">return</span> <span class="n">res</span></div>
<div class="viewcode-block" id="check_installation"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.check_installation">[docs]</a><span class="k">def</span> <span class="nf">check_installation</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Verify if a product is well installed. Checks install directory presence</span>
-<span class="sd"> and some additional files if it is defined in the config </span>
+ <span class="sd">'''Verify if a product is well installed. Checks install directory presence</span>
+<span class="sd"> and some additional files if it is defined in the config </span>
<span class="sd"> </span>
<span class="sd"> :param product_info Config: The configuration specific to </span>
<span class="sd"> the product</span>
<span class="sd"> :return: True if it is well installed</span>
<span class="sd"> :rtype: boolean</span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">product_compiles</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
<span class="k">return</span> <span class="kc">True</span>
<span class="n">install_dir</span> <span class="o">=</span> <span class="n">product_info</span><span class="o">.</span><span class="n">install_dir</span>
<span class="k">return</span> <span class="kc">False</span>
<span class="k">return</span> <span class="kc">True</span></div>
-<div class="viewcode-block" id="check_source"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.check_source">[docs]</a><span class="k">def</span> <span class="nf">check_source</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
- <span class="sd">"""Verify if a sources of product is preset. Checks source directory presence</span>
-<span class="sd"> </span>
-<span class="sd"> :param product_info Config: The configuration specific to </span>
-<span class="sd"> the product</span>
-<span class="sd"> :return: True if it is well installed</span>
-<span class="sd"> :rtype: boolean</span>
-<span class="sd"> """</span>
- <span class="n">DBG</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">"check_source product_info"</span><span class="p">,</span> <span class="n">product_info</span><span class="p">)</span>
- <span class="n">source_dir</span> <span class="o">=</span> <span class="n">product_info</span><span class="o">.</span><span class="n">source_dir</span>
- <span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">source_dir</span><span class="p">):</span>
- <span class="k">return</span> <span class="kc">False</span>
- <span class="k">if</span> <span class="p">(</span><span class="s2">"present_files"</span> <span class="ow">in</span> <span class="n">product_info</span> <span class="ow">and</span>
- <span class="s2">"source"</span> <span class="ow">in</span> <span class="n">product_info</span><span class="o">.</span><span class="n">present_files</span><span class="p">):</span>
- <span class="k">for</span> <span class="n">file_relative_path</span> <span class="ow">in</span> <span class="n">product_info</span><span class="o">.</span><span class="n">present_files</span><span class="o">.</span><span class="n">source</span><span class="p">:</span>
- <span class="n">file_path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">source_dir</span><span class="p">,</span> <span class="n">file_relative_path</span><span class="p">)</span>
- <span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">file_path</span><span class="p">):</span>
- <span class="k">return</span> <span class="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">'''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="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">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">'''Know if a product is of type salome</span>
<span class="sd"> </span>
<span class="sd"> :param product_info Config: The configuration specific to </span>
<span class="sd"> the product</span>
-<span class="sd"> :return: True if the product is a SALOME module, else False</span>
+<span class="sd"> :return: True if the product is salome, else False</span>
<span class="sd"> :rtype: boolean</span>
-<span class="sd"> """</span>
- <span class="k">return</span> <span class="p">(</span><span class="s2">"properties"</span> <span class="ow">in</span> <span class="n">product_info</span> <span class="ow">and</span>
- <span class="s2">"is_SALOME_module"</span> <span class="ow">in</span> <span class="n">product_info</span><span class="o">.</span><span class="n">properties</span> <span class="ow">and</span>
- <span class="n">product_info</span><span class="o">.</span><span class="n">properties</span><span class="o">.</span><span class="n">is_SALOME_module</span> <span class="o">==</span> <span class="s2">"yes"</span><span class="p">)</span></div>
+<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">'salome'</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_fixed"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.product_is_fixed">[docs]</a><span class="k">def</span> <span class="nf">product_is_fixed</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
- <span class="sd">"""Know if a product is fixed</span>
+ <span class="sd">'''Know if a product is fixed</span>
<span class="sd"> </span>
<span class="sd"> :param product_info Config: The configuration specific to </span>
<span class="sd"> the product</span>
<span class="sd"> :return: True if the product is fixed, else False</span>
<span class="sd"> :rtype: boolean</span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="n">get_src</span> <span class="o">=</span> <span class="n">product_info</span><span class="o">.</span><span class="n">get_source</span>
<span class="k">return</span> <span class="n">get_src</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="o">==</span> <span class="s1">'fixed'</span></div>
<div class="viewcode-block" id="product_is_native"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.product_is_native">[docs]</a><span class="k">def</span> <span class="nf">product_is_native</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
- <span class="sd">"""Know if a product is native</span>
+ <span class="sd">'''Know if a product is native</span>
<span class="sd"> </span>
<span class="sd"> :param product_info Config: The configuration specific to </span>
<span class="sd"> the product</span>
<span class="sd"> :return: True if the product is native, else False</span>
<span class="sd"> :rtype: boolean</span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="n">get_src</span> <span class="o">=</span> <span class="n">product_info</span><span class="o">.</span><span class="n">get_source</span>
<span class="k">return</span> <span class="n">get_src</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="o">==</span> <span class="s1">'native'</span></div>
<div class="viewcode-block" id="product_is_dev"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.product_is_dev">[docs]</a><span class="k">def</span> <span class="nf">product_is_dev</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
- <span class="sd">"""Know if a product is in dev mode</span>
+ <span class="sd">'''Know if a product is in dev mode</span>
<span class="sd"> </span>
<span class="sd"> :param product_info Config: The configuration specific to </span>
<span class="sd"> the product</span>
<span class="sd"> :return: True if the product is in dev mode, else False</span>
<span class="sd"> :rtype: boolean</span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="n">dev</span> <span class="o">=</span> <span class="n">product_info</span><span class="o">.</span><span class="n">dev</span>
- <span class="n">res</span> <span class="o">=</span> <span class="p">(</span><span class="n">dev</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="o">==</span> <span class="s1">'yes'</span><span class="p">)</span>
- <span class="n">DBG</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">'product_is_dev </span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="n">product_info</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">res</span><span class="p">)</span>
- <span class="c1"># if product_info.name == "XDATA": return True #test #10569</span>
- <span class="k">return</span> <span class="n">res</span></div>
+ <span class="k">return</span> <span class="n">dev</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="o">==</span> <span class="s1">'yes'</span></div>
<div class="viewcode-block" id="product_is_debug"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.product_is_debug">[docs]</a><span class="k">def</span> <span class="nf">product_is_debug</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
- <span class="sd">"""Know if a product is in debug mode</span>
+ <span class="sd">'''Know if a product is in debug mode</span>
<span class="sd"> </span>
<span class="sd"> :param product_info Config: The configuration specific to </span>
<span class="sd"> the product</span>
<span class="sd"> :return: True if the product is in debug mode, else False</span>
<span class="sd"> :rtype: boolean</span>
-<span class="sd"> """</span>
+<span class="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_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">'''Know if a product is compiled using the autotools</span>
<span class="sd"> </span>
<span class="sd"> :param product_info Config: The configuration specific to </span>
<span class="sd"> the product</span>
<span class="sd"> :return: True if the product is autotools, else False</span>
<span class="sd"> :rtype: boolean</span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="n">build_src</span> <span class="o">=</span> <span class="n">product_info</span><span class="o">.</span><span class="n">build_source</span>
<span class="k">return</span> <span class="n">build_src</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="o">==</span> <span class="s1">'autotools'</span></div>
<div class="viewcode-block" id="product_is_cmake"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.product_is_cmake">[docs]</a><span class="k">def</span> <span class="nf">product_is_cmake</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
- <span class="sd">"""Know if a product is compiled using the cmake</span>
+ <span class="sd">'''Know if a product is compiled using the cmake</span>
<span class="sd"> </span>
<span class="sd"> :param product_info Config: The configuration specific to </span>
<span class="sd"> the product</span>
<span class="sd"> :return: True if the product is cmake, else False</span>
<span class="sd"> :rtype: boolean</span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="n">build_src</span> <span class="o">=</span> <span class="n">product_info</span><span class="o">.</span><span class="n">build_source</span>
<span class="k">return</span> <span class="n">build_src</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="o">==</span> <span class="s1">'cmake'</span></div>
<div class="viewcode-block" id="product_is_vcs"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.product_is_vcs">[docs]</a><span class="k">def</span> <span class="nf">product_is_vcs</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
- <span class="sd">"""Know if a product is download using git, svn or cvs (not archive)</span>
+ <span class="sd">'''Know if a product is download using git, svn or cvs (not archive)</span>
<span class="sd"> </span>
<span class="sd"> :param product_info Config: The configuration specific to </span>
<span class="sd"> the product</span>
<span class="sd"> :return: True if the product is vcs, else False</span>
<span class="sd"> :rtype: boolean</span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="k">return</span> <span class="n">product_info</span><span class="o">.</span><span class="n">get_source</span> <span class="ow">in</span> <span class="n">AVAILABLE_VCS</span></div>
+<div class="viewcode-block" id="product_is_SALOME"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.product_is_SALOME">[docs]</a><span class="k">def</span> <span class="nf">product_is_SALOME</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
+ <span class="sd">'''Know if a product is a SALOME module</span>
+<span class="sd"> </span>
+<span class="sd"> :param product_info Config: The configuration specific to </span>
+<span class="sd"> the product</span>
+<span class="sd"> :return: True if the product is a SALOME module, else False</span>
+<span class="sd"> :rtype: boolean</span>
+<span class="sd"> '''</span>
+ <span class="k">return</span> <span class="p">(</span><span class="s2">"properties"</span> <span class="ow">in</span> <span class="n">product_info</span> <span class="ow">and</span>
+ <span class="s2">"is_SALOME_module"</span> <span class="ow">in</span> <span class="n">product_info</span><span class="o">.</span><span class="n">properties</span> <span class="ow">and</span>
+ <span class="n">product_info</span><span class="o">.</span><span class="n">properties</span><span class="o">.</span><span class="n">is_SALOME_module</span> <span class="o">==</span> <span class="s2">"yes"</span><span class="p">)</span></div>
+
<div class="viewcode-block" id="product_is_smesh_plugin"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.product_is_smesh_plugin">[docs]</a><span class="k">def</span> <span class="nf">product_is_smesh_plugin</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
- <span class="sd">"""Know if a product is a SMESH plugin</span>
+ <span class="sd">'''Know if a product is a SMESH plugin</span>
<span class="sd"> </span>
<span class="sd"> :param product_info Config: The configuration specific to </span>
<span class="sd"> the product</span>
<span class="sd"> :return: True if the product is a SMESH plugin, else False</span>
<span class="sd"> :rtype: boolean</span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="k">return</span> <span class="p">(</span><span class="s2">"properties"</span> <span class="ow">in</span> <span class="n">product_info</span> <span class="ow">and</span>
<span class="s2">"smesh_plugin"</span> <span class="ow">in</span> <span class="n">product_info</span><span class="o">.</span><span class="n">properties</span> <span class="ow">and</span>
<span class="n">product_info</span><span class="o">.</span><span class="n">properties</span><span class="o">.</span><span class="n">smesh_plugin</span> <span class="o">==</span> <span class="s2">"yes"</span><span class="p">)</span></div>
<div class="viewcode-block" id="product_is_cpp"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.product_is_cpp">[docs]</a><span class="k">def</span> <span class="nf">product_is_cpp</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
- <span class="sd">"""Know if a product is cpp</span>
+ <span class="sd">'''Know if a product is cpp</span>
<span class="sd"> </span>
<span class="sd"> :param product_info Config: The configuration specific to </span>
<span class="sd"> the product</span>
<span class="sd"> :return: True if the product is a cpp, else False</span>
<span class="sd"> :rtype: boolean</span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="k">return</span> <span class="p">(</span><span class="s2">"properties"</span> <span class="ow">in</span> <span class="n">product_info</span> <span class="ow">and</span>
<span class="s2">"cpp"</span> <span class="ow">in</span> <span class="n">product_info</span><span class="o">.</span><span class="n">properties</span> <span class="ow">and</span>
<span class="n">product_info</span><span class="o">.</span><span class="n">properties</span><span class="o">.</span><span class="n">cpp</span> <span class="o">==</span> <span class="s2">"yes"</span><span class="p">)</span></div>
<div class="viewcode-block" id="product_compiles"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.product_compiles">[docs]</a><span class="k">def</span> <span class="nf">product_compiles</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
- <span class="sd">"""\</span>
-<span class="sd"> Know if a product compiles or not </span>
-<span class="sd"> (some products do not have a compilation procedure)</span>
+ <span class="sd">'''Know if a product compiles or not (some products do not have a </span>
+<span class="sd"> compilation procedure)</span>
<span class="sd"> </span>
<span class="sd"> :param product_info Config: The configuration specific to </span>
<span class="sd"> the product</span>
<span class="sd"> :return: True if the product compiles, else False</span>
<span class="sd"> :rtype: boolean</span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="k">return</span> <span class="ow">not</span><span class="p">(</span><span class="s2">"properties"</span> <span class="ow">in</span> <span class="n">product_info</span> <span class="ow">and</span>
<span class="s2">"compilation"</span> <span class="ow">in</span> <span class="n">product_info</span><span class="o">.</span><span class="n">properties</span> <span class="ow">and</span>
<span class="n">product_info</span><span class="o">.</span><span class="n">properties</span><span class="o">.</span><span class="n">compilation</span> <span class="o">==</span> <span class="s2">"no"</span><span class="p">)</span></div>
<div class="viewcode-block" id="product_has_script"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.product_has_script">[docs]</a><span class="k">def</span> <span class="nf">product_has_script</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
- <span class="sd">"""Know if a product has a compilation script</span>
+ <span class="sd">'''Know if a product has a compilation script</span>
<span class="sd"> </span>
<span class="sd"> :param product_info Config: The configuration specific to </span>
<span class="sd"> the product</span>
<span class="sd"> :return: True if the product it has a compilation script, else False</span>
<span class="sd"> :rtype: boolean</span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="k">if</span> <span class="s2">"build_source"</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">product_info</span><span class="p">:</span>
<span class="c1"># Native case</span>
<span class="k">return</span> <span class="kc">False</span>
<span class="k">return</span> <span class="n">build_src</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="o">==</span> <span class="s1">'script'</span></div>
<div class="viewcode-block" id="product_has_env_script"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.product_has_env_script">[docs]</a><span class="k">def</span> <span class="nf">product_has_env_script</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
- <span class="sd">"""Know if a product has an environment script</span>
+ <span class="sd">'''Know if a product has an environment script</span>
<span class="sd"> </span>
<span class="sd"> :param product_info Config: The configuration specific to </span>
<span class="sd"> the product</span>
<span class="sd"> :return: True if the product it has an environment script, else False</span>
<span class="sd"> :rtype: boolean</span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="k">return</span> <span class="s2">"environ"</span> <span class="ow">in</span> <span class="n">product_info</span> <span class="ow">and</span> <span class="s2">"env_script"</span> <span class="ow">in</span> <span class="n">product_info</span><span class="o">.</span><span class="n">environ</span></div>
<div class="viewcode-block" id="product_has_patches"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.product_has_patches">[docs]</a><span class="k">def</span> <span class="nf">product_has_patches</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
- <span class="sd">"""Know if a product has one or more patches</span>
+ <span class="sd">'''Know if a product has one or more patches</span>
<span class="sd"> </span>
<span class="sd"> :param product_info Config: The configuration specific to </span>
<span class="sd"> the product</span>
<span class="sd"> :return: True if the product has one or more patches</span>
<span class="sd"> :rtype: boolean</span>
-<span class="sd"> """</span>
- <span class="n">res</span> <span class="o">=</span> <span class="p">(</span> <span class="s2">"patches"</span> <span class="ow">in</span> <span class="n">product_info</span> <span class="ow">and</span> <span class="nb">len</span><span class="p">(</span><span class="n">product_info</span><span class="o">.</span><span class="n">patches</span><span class="p">)</span> <span class="o">></span> <span class="mi">0</span> <span class="p">)</span>
- <span class="n">DBG</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">'product_has_patches </span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="n">product_info</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">res</span><span class="p">)</span>
- <span class="c1"># if product_info.name == "XDATA": return True #test #10569</span>
- <span class="k">return</span> <span class="n">res</span></div>
+<span class="sd"> '''</span>
+ <span class="k">return</span> <span class="s2">"patches"</span> <span class="ow">in</span> <span class="n">product_info</span> <span class="ow">and</span> <span class="nb">len</span><span class="p">(</span><span class="n">product_info</span><span class="o">.</span><span class="n">patches</span><span class="p">)</span> <span class="o">></span> <span class="mi">0</span></div>
<div class="viewcode-block" id="product_has_logo"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.product_has_logo">[docs]</a><span class="k">def</span> <span class="nf">product_has_logo</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
- <span class="sd">"""Know if a product has a logo (YACSGEN generate)</span>
+ <span class="sd">'''Know if a product has a logo (YACSGEN generate)</span>
<span class="sd"> </span>
<span class="sd"> :param product_info Config: The configuration specific to </span>
<span class="sd"> the product</span>
<span class="sd"> :return: The path of the logo if the product has a logo, else False</span>
<span class="sd"> :rtype: Str</span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="k">if</span> <span class="p">(</span><span class="s2">"properties"</span> <span class="ow">in</span> <span class="n">product_info</span> <span class="ow">and</span>
<span class="s2">"logo"</span> <span class="ow">in</span> <span class="n">product_info</span><span class="o">.</span><span class="n">properties</span><span class="p">):</span>
<span class="k">return</span> <span class="n">product_info</span><span class="o">.</span><span class="n">properties</span><span class="o">.</span><span class="n">logo</span>
<span class="k">return</span> <span class="kc">False</span></div>
<div class="viewcode-block" id="product_has_salome_gui"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.product_has_salome_gui">[docs]</a><span class="k">def</span> <span class="nf">product_has_salome_gui</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
- <span class="sd">"""Know if a product has a SALOME gui</span>
+ <span class="sd">'''Know if a product has a SALOME gui</span>
<span class="sd"> </span>
<span class="sd"> :param product_info Config: The configuration specific to </span>
<span class="sd"> the product</span>
<span class="sd"> :return: True if the product has a SALOME gui, else False</span>
<span class="sd"> :rtype: Boolean</span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="k">return</span> <span class="p">(</span><span class="s2">"properties"</span> <span class="ow">in</span> <span class="n">product_info</span> <span class="ow">and</span>
<span class="s2">"has_salome_gui"</span> <span class="ow">in</span> <span class="n">product_info</span><span class="o">.</span><span class="n">properties</span> <span class="ow">and</span>
<span class="n">product_info</span><span class="o">.</span><span class="n">properties</span><span class="o">.</span><span class="n">has_salome_gui</span> <span class="o">==</span> <span class="s2">"yes"</span><span class="p">)</span></div>
<div class="viewcode-block" id="product_is_mpi"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.product_is_mpi">[docs]</a><span class="k">def</span> <span class="nf">product_is_mpi</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
- <span class="sd">"""Know if a product has openmpi in its dependencies</span>
+ <span class="sd">'''Know if a product has openmpi in its dependencies</span>
<span class="sd"> </span>
<span class="sd"> :param product_info Config: The configuration specific to </span>
<span class="sd"> the product</span>
<span class="sd"> :return: True if the product has openmpi inits dependencies</span>
<span class="sd"> :rtype: boolean</span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="k">return</span> <span class="s2">"openmpi"</span> <span class="ow">in</span> <span class="n">product_info</span><span class="o">.</span><span class="n">depend</span></div>
<div class="viewcode-block" id="product_is_generated"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.product_is_generated">[docs]</a><span class="k">def</span> <span class="nf">product_is_generated</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
- <span class="sd">"""Know if a product is generated (YACSGEN)</span>
+ <span class="sd">'''Know if a product is generated (YACSGEN)</span>
<span class="sd"> </span>
<span class="sd"> :param product_info Config: The configuration specific to </span>
<span class="sd"> the product</span>
<span class="sd"> :return: True if the product is generated</span>
<span class="sd"> :rtype: boolean</span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="k">return</span> <span class="p">(</span><span class="s2">"properties"</span> <span class="ow">in</span> <span class="n">product_info</span> <span class="ow">and</span>
<span class="s2">"generate"</span> <span class="ow">in</span> <span class="n">product_info</span><span class="o">.</span><span class="n">properties</span> <span class="ow">and</span>
<span class="n">product_info</span><span class="o">.</span><span class="n">properties</span><span class="o">.</span><span class="n">generate</span> <span class="o">==</span> <span class="s2">"yes"</span><span class="p">)</span></div>
<div class="viewcode-block" id="get_product_components"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.get_product_components">[docs]</a><span class="k">def</span> <span class="nf">get_product_components</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
- <span class="sd">"""Get the component list to generate with the product</span>
+ <span class="sd">'''Get the component list to generate with the product</span>
<span class="sd"> </span>
<span class="sd"> :param product_info Config: The configuration specific to </span>
<span class="sd"> the product</span>
<span class="sd"> :return: The list of names of the components</span>
<span class="sd"> :rtype: List</span>
<span class="sd"> </span>
-<span class="sd"> """</span>
+<span class="sd"> '''</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">product_is_generated</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
<span class="k">return</span> <span class="p">[]</span>
</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" />
+ <div><input type="text" name="q" /></div>
+ <div><input type="submit" value="Go" /></div>
<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>
©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>
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.9</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
</div>
-
<!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.pyconf — salomeTools 5.0.0dev documentation</title>
+
<link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
- <script type="text/javascript" src="../../_static/documentation_options.js"></script>
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
- <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/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="top" title="salomeTools 5.0.0dev documentation" href="../../index.html" />
+ <link rel="up" title="Module code" href="../index.html" />
<link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
- </head><body>
+ </head>
+ <body role="document">
<div class="document">
<span class="bp">self</span><span class="o">.</span><span class="n">stream</span><span class="o">.</span><span class="n">close</span><span class="p">()</span></div></div>
<div class="viewcode-block" id="defaultStreamOpener"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.defaultStreamOpener">[docs]</a><span class="k">def</span> <span class="nf">defaultStreamOpener</span><span class="p">(</span><span class="n">name</span><span class="p">):</span>
- <span class="sd">"""\</span>
+ <span class="sd">"""</span>
<span class="sd"> This function returns a read-only stream, given its name. The name passed</span>
<span class="sd"> in should correspond to an existing stream, otherwise an exception will be</span>
<span class="sd"> raised.</span>
<span class="k">return</span> <span class="n">s</span><span class="o">.</span><span class="n">isalnum</span><span class="p">()</span></div>
<div class="viewcode-block" id="makePath"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.makePath">[docs]</a><span class="k">def</span> <span class="nf">makePath</span><span class="p">(</span><span class="n">prefix</span><span class="p">,</span> <span class="n">suffix</span><span class="p">):</span>
- <span class="sd">"""\</span>
+ <span class="sd">"""</span>
<span class="sd"> Make a path from a prefix and suffix.</span>
-<span class="sd"> Examples:</span>
+<span class="sd"> Examples::</span>
<span class="sd"> makePath('', 'suffix') -> 'suffix'</span>
<span class="sd"> makePath('prefix', 'suffix') -> 'prefix.suffix'</span>
<span class="sd"> makePath('prefix', '[1]') -> 'prefix[1]'</span>
-<span class="sd"> @param prefix: The prefix to use. If it evaluates as false, the suffix is returned.</span>
-<span class="sd"> @type prefix: str</span>
-<span class="sd"> @param suffix: The suffix to use. It is either an identifier or an index in brackets.</span>
-<span class="sd"> @type suffix: str</span>
-<span class="sd"> @return: The path concatenation of prefix and suffix, with adot if the suffix is not a bracketed index.</span>
-<span class="sd"> @rtype: str</span>
+<span class="sd"> @param prefix: The prefix to use. If it evaluates as false, the suffix is returned.</span>
+<span class="sd"> @type prefix: str</span>
+<span class="sd"> @param suffix: The suffix to use. It is either an identifier or an index in brackets.</span>
+<span class="sd"> @type suffix: str</span>
+<span class="sd"> @return: The path concatenation of prefix and suffix, with a dot if the suffix is not a bracketed index.</span>
+<span class="sd"> @rtype: str</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">prefix</span><span class="p">:</span>
<span class="n">rv</span> <span class="o">=</span> <span class="n">suffix</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">return</span> <span class="nb">eval</span><span class="p">(</span><span class="n">s</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
- <span class="k">raise</span> <span class="n">ConfigError</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="p">))</span></div></div>
+ <span class="k">raise</span> <span class="n">ConfigError</span><span class="p">(</span><span class="s2">"Config path not found: '</span><span class="si">%s</span><span class="s2">'"</span> <span class="o">%</span> <span class="n">path</span><span class="p">)</span></div></div>
<div class="viewcode-block" id="Sequence"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.Sequence">[docs]</a><span class="k">class</span> <span class="nc">Sequence</span><span class="p">(</span><span class="n">Container</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="n">ref</span><span class="o">.</span><span class="n">addElement</span><span class="p">(</span><span class="n">LBRACK</span><span class="p">,</span> <span class="n">tv</span><span class="p">)</span></div></div>
<div class="viewcode-block" id="defaultMergeResolve"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.pyconf.defaultMergeResolve">[docs]</a><span class="k">def</span> <span class="nf">defaultMergeResolve</span><span class="p">(</span><span class="n">map1</span><span class="p">,</span> <span class="n">map2</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span>
- <span class="sd">"""\</span>
+ <span class="sd">"""</span>
<span class="sd"> A default resolver for merge conflicts. </span>
<span class="sd"> Returns a string indicating what action to take to resolve the conflict.</span>
<span class="sd"> @type map2: L{Mapping}.</span>
<span class="sd"> @param key: The key in map2 (which also exists in map1).</span>
<span class="sd"> @type key: str</span>
-
-<span class="sd"> @return: One of "merge", "append", "mismatch" or "overwrite"</span>
-<span class="sd"> indicating what action should be taken. This should</span>
-<span class="sd"> be appropriate to the objects being merged - e.g.</span>
-<span class="sd"> there is no point returning "merge" if the two objects</span>
-<span class="sd"> are instances of L{Sequence}.</span>
-
+<span class="sd"> @return: One of "merge", "append", "mismatch" or "overwrite" </span>
+<span class="sd"> indicating what action should be taken. This should</span>
+<span class="sd"> be appropriate to the objects being merged - e.g.</span>
+<span class="sd"> there is no point returning "merge" if the two objects</span>
+<span class="sd"> are instances of L{Sequence}.</span>
<span class="sd"> @rtype: str</span>
<span class="sd"> """</span>
<span class="n">obj1</span> <span class="o">=</span> <span class="n">map1</span><span class="p">[</span><span class="n">key</span><span class="p">]</span>
<span class="k">except</span> <span class="n">ConfigError</span><span class="p">:</span>
<span class="k">pass</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">found</span><span class="p">:</span>
- <span class="k">raise</span> <span class="n">ConfigError</span><span class="p">(</span><span class="s2">"unable to resolve </span><span class="si">%r</span><span class="s2">"</span> <span class="o">%</span> <span class="n">path</span><span class="p">)</span>
+ <span class="k">raise</span> <span class="n">ConfigError</span><span class="p">(</span><span class="s2">"ConfigList path not found '</span><span class="si">%r</span><span class="s2">'"</span> <span class="o">%</span> <span class="n">path</span><span class="p">)</span>
<span class="k">return</span> <span class="n">rv</span></div></div>
</pre></div>
</div>
<div 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" />
+ <div><input type="text" name="q" /></div>
+ <div><input type="submit" value="Go" /></div>
<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>
©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>
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.9</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
</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="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>src.returnCode — 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">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+ <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/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="top" title="salomeTools 5.0.0dev documentation" href="../../index.html" />
+ <link rel="up" title="Module code" href="../index.html" />
+
+ <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+ </head>
+ <body role="document">
+
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <h1>Source code for src.returnCode</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) 2018-20xx 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">This file contains ReturnCode class</span>
+<span class="sd">usage:</span>
+<span class="sd">>> import returnCode as RCO</span>
+<span class="sd">"""</span>
+
+<span class="kn">import</span> <span class="nn">pprint</span> <span class="k">as</span> <span class="nn">PP</span>
+
+<span class="c1">#####################################################</span>
+<div class="viewcode-block" id="ReturnCode"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.returnCode.ReturnCode">[docs]</a><span class="k">class</span> <span class="nc">ReturnCode</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
+
+ <span class="sd">"""\</span>
+<span class="sd"> assume simple return code for methods, with explanation as 'why'</span>
+<span class="sd"> obviously why is why it is not OK, </span>
+<span class="sd"> but also why is why it is OK (if you want). </span>
+<span class="sd"> and optionnaly contains a return value as self.getValue()</span>
+<span class="sd"> </span>
+<span class="sd"> usage:</span>
+<span class="sd"> >> import returnCode as RCO</span>
+<span class="sd"> </span>
+<span class="sd"> >> aValue = doSomethingToReturn()</span>
+<span class="sd"> >> return RCO.ReturnCode("KO", "there is no problem here", aValue)</span>
+<span class="sd"> >> return RCO.ReturnCode("KO", "there is a problem here because etc", None)</span>
+<span class="sd"> >> return RCO.ReturnCode("TIMEOUT_STATUS", "too long here because etc")</span>
+<span class="sd"> >> return RCO.ReturnCode("NA", "not applicable here because etc")</span>
+<span class="sd"> </span>
+<span class="sd"> >> rc = doSomething()</span>
+<span class="sd"> >> print("short returnCode string", str(rc))</span>
+<span class="sd"> >> print("long returnCode string with value", repr(rc))</span>
+<span class="sd"> </span>
+<span class="sd"> >> rc1 = RCO.ReturnCode("OK", ...)</span>
+<span class="sd"> >> rc2 = RCO.ReturnCode("KO", ...)</span>
+<span class="sd"> >> rcFinal = rc1 + rc2</span>
+<span class="sd"> >> print("long returnCode string with value", repr(rcFinal)) # KO!</span>
+<span class="sd"> """</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="c1"># not applicable</span>
+ <span class="n">UNKNOWN_STATUS</span> <span class="o">=</span> <span class="s2">"ND"</span> <span class="c1"># not defined</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="c1"># integer for sys.exit(anInt)</span>
+ <span class="c1"># OKSYS and KOSYS seems equal on linux or windows</span>
+ <span class="n">OKSYS</span> <span class="o">=</span> <span class="mi">0</span> <span class="c1"># OK </span>
+ <span class="n">KOSYS</span> <span class="o">=</span> <span class="mi">1</span> <span class="c1"># KO</span>
+ <span class="n">NASYS</span> <span class="o">=</span> <span class="mi">2</span> <span class="c1"># KO not applicable return code</span>
+ <span class="n">NDSYS</span> <span class="o">=</span> <span class="mi">3</span> <span class="c1"># KO not defined return code</span>
+ <span class="n">KFSYS</span> <span class="o">=</span> <span class="mi">4</span> <span class="c1"># KO known failure return code</span>
+ <span class="n">TOSYS</span> <span class="o">=</span> <span class="mi">5</span> <span class="c1"># KO time out</span>
+
+ <span class="n">_TOSYS</span> <span class="o">=</span> <span class="p">{</span>
+ <span class="n">OK_STATUS</span><span class="p">:</span> <span class="n">OKSYS</span><span class="p">,</span>
+ <span class="n">KO_STATUS</span><span class="p">:</span> <span class="n">KOSYS</span><span class="p">,</span>
+ <span class="n">NA_STATUS</span><span class="p">:</span> <span class="n">NASYS</span><span class="p">,</span>
+ <span class="n">UNKNOWN_STATUS</span><span class="p">:</span> <span class="n">NDSYS</span><span class="p">,</span>
+ <span class="n">KNOWNFAILURE_STATUS</span><span class="p">:</span> <span class="n">KFSYS</span><span class="p">,</span>
+ <span class="n">TIMEOUT_STATUS</span><span class="p">:</span> <span class="n">TOSYS</span><span class="p">,</span>
+ <span class="p">}</span>
+ <span class="n">_DEFAULT_WHY</span> <span class="o">=</span> <span class="s2">"No given explanation"</span>
+ <span class="n">_DEFAULT_VALUE</span> <span class="o">=</span> <span class="s2">"Not set"</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">status</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">why</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">value</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_why</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_DEFAULT_WHY</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_value</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_DEFAULT_VALUE</span>
+ <span class="k">if</span> <span class="n">status</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_status</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">UNKNOWN_STATUS</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">setStatus</span><span class="p">(</span><span class="n">status</span><span class="p">,</span> <span class="n">why</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="sd">"""complete with value, 'ok, why, value' message"""</span>
+ <span class="n">res</span> <span class="o">=</span> <span class="s1">'</span><span class="si">%s</span><span class="s1">: "</span><span class="si">%s</span><span class="s1">" for value: </span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_status</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_why</span><span class="p">,</span> <span class="n">PP</span><span class="o">.</span><span class="n">pformat</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_value</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">"""without value, only simple 'ok, why' message"""</span>
+ <span class="n">res</span> <span class="o">=</span> <span class="s1">'</span><span class="si">%s</span><span class="s1">: "</span><span class="si">%s</span><span class="s1">"'</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_status</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_why</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">res</span>
+
+<div class="viewcode-block" id="ReturnCode.indent"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.returnCode.ReturnCode.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="o">=</span><span class="mi">5</span><span class="p">,</span> <span class="n">ch</span><span class="o">=</span><span class="s1">' '</span><span class="p">):</span>
+ <span class="sd">"""indent multi lines message"""</span>
+ <span class="n">padding</span> <span class="o">=</span> <span class="n">amount</span> <span class="o">*</span> <span class="n">ch</span>
+ <span class="n">res</span> <span class="o">=</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>
+ <span class="k">return</span> <span class="n">res</span><span class="p">[</span><span class="n">amount</span><span class="p">:]</span></div>
+
+ <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">rc2</span><span class="p">):</span>
+ <span class="sd">"""allows expression 'returnCode1 + returnCode2 + ...' """</span>
+ <span class="n">isOk</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">isOk</span><span class="p">()</span> <span class="ow">and</span> <span class="n">rc2</span><span class="o">.</span><span class="n">isOk</span><span class="p">()</span>
+ <span class="n">newWhy</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_toList</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">getWhy</span><span class="p">())</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">_toList</span><span class="p">(</span><span class="n">rc2</span><span class="o">.</span><span class="n">getWhy</span><span class="p">())</span>
+ <span class="n">newValue</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_toList</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">getValue</span><span class="p">())</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">_toList</span><span class="p">(</span><span class="n">rc2</span><span class="o">.</span><span class="n">getValue</span><span class="p">())</span>
+ <span class="k">if</span> <span class="n">isOk</span><span class="p">:</span>
+ <span class="k">return</span> <span class="n">ReturnCode</span><span class="p">(</span><span class="s2">"OK"</span><span class="p">,</span> <span class="n">newWhy</span><span class="p">,</span> <span class="n">newValue</span> <span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">return</span> <span class="n">ReturnCode</span><span class="p">(</span><span class="s2">"KO"</span><span class="p">,</span> <span class="n">newWhy</span><span class="p">,</span> <span class="n">newValue</span> <span class="p">)</span>
+
+ <span class="k">def</span> <span class="nf">_toList</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">strOrList</span><span class="p">):</span>
+ <span class="sd">"""internal use"""</span>
+ <span class="k">if</span> <span class="nb">type</span><span class="p">(</span><span class="n">strOrList</span><span class="p">)</span> <span class="ow">is</span> <span class="ow">not</span> <span class="nb">list</span><span class="p">:</span>
+ <span class="k">return</span> <span class="p">[</span><span class="n">strOrList</span><span class="p">]</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">return</span> <span class="n">strOrList</span>
+
+<div class="viewcode-block" id="ReturnCode.toSys"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.returnCode.ReturnCode.toSys">[docs]</a> <span class="k">def</span> <span class="nf">toSys</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_TOSYS</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">_status</span><span class="p">]</span>
+ <span class="k">except</span><span class="p">:</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_TOSYS</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">NA_STATUS</span><span class="p">]</span></div>
+
+<div class="viewcode-block" id="ReturnCode.getWhy"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.returnCode.ReturnCode.getWhy">[docs]</a> <span class="k">def</span> <span class="nf">getWhy</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">_why</span></div>
+
+<div class="viewcode-block" id="ReturnCode.setWhy"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.returnCode.ReturnCode.setWhy">[docs]</a> <span class="k">def</span> <span class="nf">setWhy</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">why</span><span class="p">):</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_why</span> <span class="o">=</span> <span class="n">why</span></div>
+
+<div class="viewcode-block" id="ReturnCode.getValue"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.returnCode.ReturnCode.getValue">[docs]</a> <span class="k">def</span> <span class="nf">getValue</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">_value</span></div>
+
+<div class="viewcode-block" id="ReturnCode.setValue"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.returnCode.ReturnCode.setValue">[docs]</a> <span class="k">def</span> <span class="nf">setValue</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_value</span> <span class="o">=</span> <span class="n">value</span></div>
+
+<div class="viewcode-block" id="ReturnCode.setStatus"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.returnCode.ReturnCode.setStatus">[docs]</a> <span class="k">def</span> <span class="nf">setStatus</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">status</span><span class="p">,</span> <span class="n">why</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">value</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
+ <span class="k">if</span> <span class="n">why</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
+ <span class="n">aWhy</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_DEFAULT_WHY</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">aWhy</span> <span class="o">=</span> <span class="n">why</span>
+
+ <span class="k">if</span> <span class="n">status</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_TOSYS</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_status</span> <span class="o">=</span> <span class="n">status</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_why</span> <span class="o">=</span> <span class="n">aWhy</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_status</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">NA_STATUS</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_why</span> <span class="o">=</span> <span class="s2">"Error status '</span><span class="si">%s</span><span class="s2">' for '</span><span class="si">%s</span><span class="s2">'"</span> <span class="o">%</span> <span class="p">(</span><span class="n">status</span><span class="p">,</span> <span class="n">aWhy</span><span class="p">)</span>
+
+ <span class="k">if</span> <span class="n">value</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_value</span> <span class="o">=</span> <span class="n">value</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_value</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_DEFAULT_VALUE</span></div>
+
+<div class="viewcode-block" id="ReturnCode.isOk"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.returnCode.ReturnCode.isOk">[docs]</a> <span class="k">def</span> <span class="nf">isOk</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="bp">self</span><span class="o">.</span><span class="n">_status</span> <span class="o">==</span> <span class="bp">self</span><span class="o">.</span><span class="n">OK_STATUS</span><span class="p">)</span></div></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>
+ <form class="search" action="../../search.html" method="get">
+ <div><input type="text" name="q" /></div>
+ <div><input type="submit" value="Go" /></div>
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</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.4.9</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
+
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
--- /dev/null
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>src.salomeTools — salomeTools 5.0.0dev documentation</title>
+
+ <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
+ <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+ <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/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="top" title="salomeTools 5.0.0dev documentation" href="../../index.html" />
+ <link rel="up" title="Module code" href="../index.html" />
+
+ <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+ </head>
+ <body role="document">
+
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <h1>Source code for src.salomeTools</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-2018 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">This file is the main entry file to salomeTools</span>
+<span class="sd">NO __main__ entry allowed, use 'sat' (in parent directory)</span>
+<span class="sd">"""</span>
+
+<span class="c1">########################################################################</span>
+<span class="c1"># NO __main__ entry allowed, use sat</span>
+<span class="c1">########################################################################</span>
+<span class="k">if</span> <span class="vm">__name__</span> <span class="o">==</span> <span class="s2">"__main__"</span><span class="p">:</span>
+ <span class="n">sys</span><span class="o">.</span><span class="n">stderr</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">"</span><span class="se">\n</span><span class="s2">ERROR: 'salomeTools.py' is not main command entry for sat: use 'sat' instead.</span><span class="se">\n\n</span><span class="s2">"</span><span class="p">)</span>
+ <span class="n">KOSYS</span> <span class="o">=</span> <span class="mi">1</span> <span class="c1"># avoid import src</span>
+ <span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="n">KOSYS</span><span class="p">)</span>
+
+<span class="kn">import</span> <span class="nn">os</span>
+<span class="kn">import</span> <span class="nn">sys</span>
+<span class="kn">import</span> <span class="nn">re</span>
+<span class="kn">import</span> <span class="nn">tempfile</span>
+<span class="kn">import</span> <span class="nn">imp</span>
+<span class="kn">import</span> <span class="nn">gettext</span>
+<span class="kn">import</span> <span class="nn">traceback</span>
+<span class="kn">import</span> <span class="nn">subprocess</span> <span class="k">as</span> <span class="nn">SP</span>
+<span class="kn">import</span> <span class="nn">pprint</span> <span class="k">as</span> <span class="nn">PP</span>
+
+<span class="kn">import</span> <span class="nn">src</span> <span class="c1"># for __version__</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>
+<span class="kn">import</span> <span class="nn">src.returnCode</span> <span class="k">as</span> <span class="nn">RCO</span> <span class="c1"># Easy (ok/ko, why) return methods code</span>
+<span class="kn">from</span> <span class="nn">src.options</span> <span class="k">import</span> <span class="n">Options</span>
+<span class="kn">import</span> <span class="nn">configManager</span> <span class="k">as</span> <span class="nn">CFGMGR</span>
+
+<span class="c1"># get path to src</span>
+<span class="n">rootdir</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">realpath</span><span class="p">(</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">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="vm">__file__</span><span class="p">),</span> <span class="s2">".."</span><span class="p">)</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">"sat rootdir"</span><span class="p">,</span> <span class="n">rootdir</span><span class="p">)</span>
+<span class="n">srcdir</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">rootdir</span><span class="p">,</span> <span class="s2">"src"</span><span class="p">)</span>
+<span class="n">cmdsdir</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">rootdir</span><span class="p">,</span> <span class="s2">"commands"</span><span class="p">)</span>
+
+<span class="c1"># load resources for internationalization</span>
+<span class="n">gettext</span><span class="o">.</span><span class="n">install</span><span class="p">(</span><span class="s2">"salomeTools"</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">srcdir</span><span class="p">,</span> <span class="s2">"i18n"</span><span class="p">))</span>
+
+<span class="c1"># The possible hooks : </span>
+<span class="c1"># pre is for hooks to be executed before commands</span>
+<span class="c1"># post is for hooks to be executed after commands</span>
+<span class="n">C_PRE_HOOK</span> <span class="o">=</span> <span class="s2">"pre"</span>
+<span class="n">C_POST_HOOK</span> <span class="o">=</span> <span class="s2">"post"</span>
+
+<span class="n">_LANG</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"LANG"</span><span class="p">]</span> <span class="c1"># original locale</span>
+
+<span class="c1">########################################################################</span>
+<span class="c1"># utility methods</span>
+<span class="c1">########################################################################</span>
+<div class="viewcode-block" id="find_command_list"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.salomeTools.find_command_list">[docs]</a><span class="k">def</span> <span class="nf">find_command_list</span><span class="p">(</span><span class="n">dirPath</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Parse files in dirPath that end with '.py' : it gives commands list</span>
+<span class="sd"> </span>
+<span class="sd"> :param dirPath str: The directory path where to search the commands</span>
+<span class="sd"> :return: cmd_list : the list containing the commands name </span>
+<span class="sd"> :rtype: list</span>
+<span class="sd"> """</span>
+ <span class="n">cmd_list</span> <span class="o">=</span> <span class="p">[]</span>
+ <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">os</span><span class="o">.</span><span class="n">listdir</span><span class="p">(</span><span class="n">dirPath</span><span class="p">):</span>
+ <span class="k">if</span> <span class="n">item</span> <span class="ow">in</span> <span class="p">[</span><span class="s2">"__init__.py"</span><span class="p">]:</span> <span class="c1">#avoid theses files</span>
+ <span class="k">continue</span>
+ <span class="k">if</span> <span class="n">item</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s2">".py"</span><span class="p">):</span>
+ <span class="n">cmd_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">item</span><span class="p">[:</span><span class="o">-</span><span class="nb">len</span><span class="p">(</span><span class="s2">".py"</span><span class="p">)])</span>
+ <span class="k">return</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">cmd_list</span><span class="p">)</span></div>
+
+<span class="c1"># The list of valid salomeTools commands from cmdsdir</span>
+<span class="c1"># ['config', 'compile', 'prepare', ...]</span>
+<span class="n">_COMMANDS_NAMES</span> <span class="o">=</span> <span class="n">find_command_list</span><span class="p">(</span><span class="n">cmdsdir</span><span class="p">)</span>
+
+<div class="viewcode-block" id="getCommandsList"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.salomeTools.getCommandsList">[docs]</a><span class="k">def</span> <span class="nf">getCommandsList</span><span class="p">():</span>
+ <span class="sd">"""Gives commands list (as basename of files .py in directory commands"""</span>
+ <span class="k">return</span> <span class="n">_COMMANDS_NAMES</span></div>
+
+<div class="viewcode-block" id="launchSat"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.salomeTools.launchSat">[docs]</a><span class="k">def</span> <span class="nf">launchSat</span><span class="p">(</span><span class="n">command</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> launch sat as subprocess popen</span>
+<span class="sd"> command as string ('sat --help' for example)</span>
+<span class="sd"> used for unittest, or else...</span>
+<span class="sd"> returns tuple (stdout, stderr)</span>
+<span class="sd"> """</span>
+ <span class="k">if</span> <span class="s2">"sat"</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">command</span><span class="o">.</span><span class="n">split</span><span class="p">()[</span><span class="mi">0</span><span class="p">]:</span>
+ <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s2">"Not a valid command for launchSat: '</span><span class="si">%s</span><span class="s2">'"</span><span class="p">)</span> <span class="o">%</span> <span class="n">command</span><span class="p">)</span>
+ <span class="n">env</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">)</span> <span class="c1"># copy</span>
+ <span class="c1"># theorically useless, in user environ $PATH,</span>
+ <span class="c1"># on ne sait jamais</span>
+ <span class="c1"># https://docs.python.org/2/library/os.html</span>
+ <span class="c1"># On some platforms, including FreeBSD and Mac OS X, </span>
+ <span class="c1"># setting environ may cause memory leaks.</span>
+ <span class="c1"># see test/initializeTest.py</span>
+ <span class="k">if</span> <span class="n">rootdir</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">env</span><span class="p">[</span><span class="s2">"PATH"</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">env</span><span class="p">[</span><span class="s2">"PATH"</span><span class="p">]</span> <span class="o">=</span> <span class="n">rootdir</span> <span class="o">+</span> <span class="s2">":"</span> <span class="o">+</span> <span class="n">env</span><span class="p">[</span><span class="s2">"PATH"</span><span class="p">]</span>
+ <span class="c1"># TODO setLocale not 'fr' on subprocesses, why not?</span>
+ <span class="c1"># env["LANG"] == ''</span>
+ <span class="n">res</span> <span class="o">=</span> <span class="n">SP</span><span class="o">.</span><span class="n">Popen</span><span class="p">(</span><span class="n">command</span><span class="p">,</span> <span class="n">shell</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">env</span><span class="o">=</span><span class="n">env</span><span class="p">,</span> <span class="n">stdout</span><span class="o">=</span><span class="n">SP</span><span class="o">.</span><span class="n">PIPE</span><span class="p">,</span> <span class="n">stderr</span><span class="o">=</span><span class="n">SP</span><span class="o">.</span><span class="n">PIPE</span><span class="p">)</span><span class="o">.</span><span class="n">communicate</span><span class="p">()</span>
+ <span class="k">return</span> <span class="n">res</span></div>
+
+<div class="viewcode-block" id="setNotLocale"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.salomeTools.setNotLocale">[docs]</a><span class="k">def</span> <span class="nf">setNotLocale</span><span class="p">():</span>
+ <span class="sd">"""force english at any moment"""</span>
+ <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"LANG"</span><span class="p">]</span> <span class="o">=</span> <span class="s1">''</span>
+ <span class="n">gettext</span><span class="o">.</span><span class="n">install</span><span class="p">(</span><span class="s2">"salomeTools"</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">srcdir</span><span class="p">,</span> <span class="s2">"i18n"</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">"setNotLocale"</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"LANG"</span><span class="p">])</span></div>
+
+<div class="viewcode-block" id="setLocale"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.salomeTools.setLocale">[docs]</a><span class="k">def</span> <span class="nf">setLocale</span><span class="p">():</span>
+ <span class="sd">"""\</span>
+<span class="sd"> reset initial locale at any moment </span>
+<span class="sd"> 'fr' or else (TODO) from initial environment var '$LANG'</span>
+<span class="sd"> 'i18n' as 'internationalization'</span>
+<span class="sd"> """</span>
+ <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"LANG"</span><span class="p">]</span> <span class="o">=</span> <span class="n">_LANG</span>
+ <span class="n">gettext</span><span class="o">.</span><span class="n">install</span><span class="p">(</span><span class="s2">"salomeTools"</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">srcdir</span><span class="p">,</span> <span class="s2">"i18n"</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">"setLocale"</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"LANG"</span><span class="p">])</span></div>
+
+<div class="viewcode-block" id="getVersion"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.salomeTools.getVersion">[docs]</a><span class="k">def</span> <span class="nf">getVersion</span><span class="p">():</span>
+ <span class="sd">"""get version number as string"""</span>
+ <span class="k">return</span> <span class="n">src</span><span class="o">.</span><span class="n">__version__</span></div>
+
+<div class="viewcode-block" id="assumeAsList"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.salomeTools.assumeAsList">[docs]</a><span class="k">def</span> <span class="nf">assumeAsList</span><span class="p">(</span><span class="n">strOrList</span><span class="p">):</span>
+ <span class="sd">"""return a list as sys.argv if string"""</span>
+ <span class="k">if</span> <span class="nb">type</span><span class="p">(</span><span class="n">strOrList</span><span class="p">)</span> <span class="ow">is</span> <span class="nb">list</span><span class="p">:</span>
+ <span class="k">return</span> <span class="nb">list</span><span class="p">(</span><span class="n">strOrList</span><span class="p">)</span> <span class="c1"># copy</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">res</span> <span class="o">=</span> <span class="n">strOrList</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="p">[</span><span class="n">r</span> <span class="k">for</span> <span class="n">r</span> <span class="ow">in</span> <span class="n">res</span> <span class="k">if</span> <span class="n">r</span> <span class="o">!=</span> <span class="s2">""</span><span class="p">]</span> <span class="c1"># supposed string to split for convenience</span></div>
+
+<span class="c1">########################################################################</span>
+<span class="c1"># _BaseCmd class</span>
+<span class="c1">########################################################################</span>
+<span class="k">class</span> <span class="nc">_BaseCommand</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> _BaseCmd is the base class for all inherited commands of salomeTools</span>
+<span class="sd"> instancied as classes 'Command' in files '.../commands/*.py'</span>
+<span class="sd"> """</span>
+
+ <span class="c1"># supposed never seen, set "config", "prepare"... in inherited commands</span>
+ <span class="n">name</span> <span class="o">=</span> <span class="s2">"salomeTools"</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">runner</span><span class="p">):</span>
+ <span class="c1"># runner (as caller) usually as Sat instance</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_runner</span> <span class="o">=</span> <span class="n">runner</span>
+ <span class="c1"># config pyconf usually loaded in runner, but sometimes local value</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_config</span> <span class="o">=</span> <span class="kc">None</span>
+ <span class="c1"># logger (from caller) usually as Sat instance logger, but sometimes local value</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_logger</span> <span class="o">=</span> <span class="n">runner</span><span class="o">.</span><span class="n">logger</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_options</span> <span class="o">=</span> <span class="kc">None</span>
+
+ <span class="k">def</span> <span class="nf">getClassName</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> returns 'config.Command' or prepare.Command' for example </span>
+<span class="sd"> as inherited classes 'Command' in files</span>
+<span class="sd"> '.../commands/config.py' or '.../commands/prepare.py'</span>
+<span class="sd"> """</span>
+ <span class="k">return</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="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="vm">__class__</span><span class="o">.</span><span class="vm">__name__</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">tmp</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="s2">)</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="n">getClassName</span><span class="p">(),</span> <span class="n">tmp</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">run</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cmd_arguments</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> virtual example method for Command instance</span>
+<span class="sd"> have to return RCO.ReturnCode()</span>
+<span class="sd"> """</span>
+ <span class="k">return</span> <span class="n">RCO</span><span class="o">.</span><span class="n">ReturnCode</span><span class="p">(</span><span class="s2">"KO"</span><span class="p">,</span> <span class="s2">"_BaseCommand.run() have not to be instancied and called"</span><span class="p">)</span>
+
+ <span class="k">def</span> <span class="nf">setLogger</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">logger</span><span class="p">):</span>
+ <span class="sd">"""set logger for run command"""</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_logger</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
+ <span class="c1"># supposed logger.debug for future</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_logger</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="s2">"change logger for </span><span class="si">%s</span><span class="s2">, are you sure"</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">getClassName</span><span class="p">())</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_logger</span> <span class="o">=</span> <span class="n">logger</span>
+
+ <span class="k">def</span> <span class="nf">getLogger</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">_logger</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
+ <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s2">"</span><span class="si">%s</span><span class="s2"> instance needs self._logger not None, fix it."</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">getClassName</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">_logger</span>
+
+ <span class="k">def</span> <span class="nf">getOptions</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">_options</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
+ <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s2">"</span><span class="si">%s</span><span class="s2"> instance needs self._option not None, fix it."</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">getClassName</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">_options</span>
+
+ <span class="k">def</span> <span class="nf">getParserWithHelp</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="sd">"""returns elementary parser with help option set"""</span>
+ <span class="n">parser</span> <span class="o">=</span> <span class="n">Options</span><span class="p">()</span>
+ <span class="n">parser</span><span class="o">.</span><span class="n">add_option</span><span class="p">(</span><span class="s1">'h'</span><span class="p">,</span> <span class="s1">'help'</span><span class="p">,</span> <span class="s1">'boolean'</span><span class="p">,</span> <span class="s1">'help'</span><span class="p">,</span> <span class="n">_</span><span class="p">(</span><span class="s2">"shows help on command."</span><span class="p">))</span>
+ <span class="k">return</span> <span class="n">parser</span>
+
+ <span class="k">def</span> <span class="nf">getRunner</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">_runner</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
+ <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s2">"</span><span class="si">%s</span><span class="s2"> instance needs self.runner not None, fix it."</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">getClassName</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">_runner</span>
+
+ <span class="k">def</span> <span class="nf">getConfig</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> supposedly (for now) no multiply local config(s)</span>
+<span class="sd"> only one config in runner.config</span>
+<span class="sd"> may be some for future...</span>
+<span class="sd"> """</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_runner</span><span class="o">.</span><span class="n">config</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="s2">"</span><span class="si">%s</span><span class="s2"> instance have runner.config None, fix it."</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">getClassName</span><span class="p">())</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_runner</span><span class="o">.</span><span class="n">config</span>
+
+ <span class="k">def</span> <span class="nf">assumeAsList</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">strOrList</span><span class="p">):</span>
+ <span class="k">return</span> <span class="n">assumeAsList</span><span class="p">(</span><span class="n">strOrList</span><span class="p">)</span>
+
+ <span class="k">def</span> <span class="nf">getParser</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s2">"_BaseCmd class have not to be instancied, only for inheritage"</span><span class="p">)</span>
+
+ <span class="k">def</span> <span class="nf">parseArguments</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cmd_arguments</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> smart parse command arguments skip</span>
+<span class="sd"> first argument name appli to load, if present</span>
+<span class="sd"> """</span>
+ <span class="n">argList</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">assumeAsList</span><span class="p">(</span><span class="n">cmd_arguments</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">"</span><span class="si">%s</span><span class="s2">.Command arguments"</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">argList</span><span class="p">)</span>
+ <span class="n">commandOptions</span><span class="p">,</span> <span class="n">remaindersArgs</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">getParser</span><span class="p">()</span><span class="o">.</span><span class="n">parse_args</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">"</span><span class="si">%s</span><span class="s2">.Command options"</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">commandOptions</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">"</span><span class="si">%s</span><span class="s2">.Command remainders arguments"</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">remaindersArgs</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">remaindersArgs</span> <span class="o">!=</span> <span class="p">[]:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">getLogger</span><span class="p">()</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="s2">"</span><span class="si">%s</span><span class="s2">.Command have unknown remainders arguments:</span><span class="se">\n</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="n">name</span><span class="p">,</span> <span class="n">remaindersArgs</span><span class="p">))</span>
+ <span class="k">return</span> <span class="n">commandOptions</span><span class="p">,</span> <span class="n">remaindersArgs</span>
+
+ <span class="k">def</span> <span class="nf">description</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> method called when salomeTools have '--help' argument.</span>
+<span class="sd"> returns The text to display for the command description</span>
+<span class="sd"> which is current Command class docstring 'self.__doc__',</span>
+<span class="sd"> with traduction</span>
+<span class="sd"> """</span>
+ <span class="k">return</span> <span class="n">_</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="vm">__doc__</span><span class="p">)</span>
+
+ <span class="k">def</span> <span class="nf">run</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cmd_arguments</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> method called when salomeTools processes command(s) parameters"""</span>
+ <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s2">"_BaseCmd class have not to be instancied, useful only for inheritage"</span><span class="p">)</span>
+
+ <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"> Prints help for a command. Function called with </span>
+<span class="sd"> 'sat --help <command>' or</span>
+<span class="sd"> 'sat --help <command> --help' or</span>
+<span class="sd"> 'sat <command>' without any trailing arguments</span>
+<span class="sd"> """</span>
+ <span class="n">msg</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="bp">self</span><span class="o">.</span><span class="n">_logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
+
+ <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">"""get string help for inherited Command classes"""</span>
+ <span class="n">version</span> <span class="o">=</span> <span class="n">getVersion</span><span class="p">()</span> <span class="o">+</span> <span class="s2">"</span><span class="se">\n\n</span><span class="s2">"</span> <span class="c1"># salomeTools version</span>
+ <span class="n">msg</span> <span class="o">=</span> <span class="s2">"<header>Version:<reset> "</span> <span class="o">+</span> <span class="n">version</span>
+ <span class="c1"># description of the command that is done in the command.py file</span>
+ <span class="n">msg</span> <span class="o">+=</span> <span class="s2">"<header>Description:<reset></span><span class="se">\n</span><span class="s2">"</span>
+ <span class="n">msg</span> <span class="o">+=</span> <span class="bp">self</span><span class="o">.</span><span class="n">description</span><span class="p">()</span> <span class="o">+</span> <span class="s2">"</span><span class="se">\n\n</span><span class="s2">"</span>
+
+ <span class="c1"># description of the command options</span>
+ <span class="n">msg</span> <span class="o">+=</span> <span class="bp">self</span><span class="o">.</span><span class="n">getParser</span><span class="p">()</span><span class="o">.</span><span class="n">get_help</span><span class="p">()</span> <span class="o">+</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span>
+ <span class="k">return</span> <span class="n">msg</span>
+
+<span class="c1">########################################################################</span>
+<span class="c1"># Sat class</span>
+<span class="c1">########################################################################</span>
+<div class="viewcode-block" id="Sat"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.salomeTools.Sat">[docs]</a><span class="k">class</span> <span class="nc">Sat</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
+ <span class="sd">"""The main class that stores all the commands of salomeTools</span>
+<span class="sd"> (usually known as 'runner' argument in Command classes)</span>
+<span class="sd"> """</span>
+ <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">logger</span><span class="p">):</span>
+ <span class="sd">"""Initialization</span>
+<span class="sd"> </span>
+<span class="sd"> :param logger: The logger to use</span>
+<span class="sd"> """</span>
+
+ <span class="c1"># Read the salomeTools prefixes options before the 'commands' tag</span>
+ <span class="c1"># sat <options> <args></span>
+ <span class="c1"># (the list of possible options is at the beginning of this file)</span>
+
+
+ <span class="bp">self</span><span class="o">.</span><span class="n">CONFIG_FILENAME</span> <span class="o">=</span> <span class="s2">"sat-config.pyconf"</span>
+
+ <span class="bp">self</span><span class="o">.</span><span class="n">configManager</span> <span class="o">=</span> <span class="kc">None</span> <span class="c1"># the config Manager that will be used to set self.config</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">config</span> <span class="o">=</span> <span class="kc">None</span> <span class="c1"># the config that will be read using pyconf module</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span> <span class="o">=</span> <span class="n">logger</span> <span class="c1"># the logger that will be use</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">arguments</span> <span class="o">=</span> <span class="kc">None</span> <span class="c1"># args are postfixes options: args[0] is the 'commands' command</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">options</span> <span class="o">=</span> <span class="kc">None</span> <span class="c1"># the options passed to salomeTools</span>
+
+ <span class="c1"># the directory that contain all the external </span>
+ <span class="c1"># data (like software pyconf and software scripts)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">datadir</span> <span class="o">=</span> <span class="kc">None</span> <span class="c1"># default value will be <salomeTools root>/data</span>
+
+ <span class="c1"># contains commands classes needed (think micro commands)</span>
+ <span class="c1"># if useful 'a la demande'</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">commands</span> <span class="o">=</span> <span class="p">{}</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">nameCommandToLoad</span> <span class="o">=</span> <span class="kc">None</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">nameAppliToLoad</span> <span class="o">=</span> <span class="kc">None</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">commandArguments</span> <span class="o">=</span> <span class="kc">None</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">nameAppliLoaded</span> <span class="o">=</span> <span class="kc">None</span>
+
+ <span class="bp">self</span><span class="o">.</span><span class="n">parser</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_getParser</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">aDict</span> <span class="o">=</span> <span class="p">{</span>
+ <span class="s2">"arguments"</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">arguments</span><span class="p">,</span>
+ <span class="s2">"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="s2">"datadir"</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">datadir</span><span class="p">,</span>
+ <span class="s2">"commands"</span><span class="p">:</span> <span class="nb">sorted</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">commands</span><span class="o">.</span><span class="n">keys</span><span class="p">()),</span>
+ <span class="p">}</span>
+ <span class="n">tmp</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">"Sat(</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="se">\n</span><span class="s2">"</span> <span class="o">%</span> <span class="n">tmp</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="Sat.getLogger"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.salomeTools.Sat.getLogger">[docs]</a> <span class="k">def</span> <span class="nf">getLogger</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">logger</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> <span class="c1"># could use owner Sat instance logger</span>
+ <span class="kn">import</span> <span class="nn">src.loggingSat</span> <span class="k">as</span> <span class="nn">LOG</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">=</span><span class="n">LOG</span><span class="o">.</span><span class="n">getDefaultLogger</span><span class="p">()</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">critical</span><span class="p">(</span><span class="s2">"Sat logger not set, unexpected situation, fixed as default"</span><span class="p">)</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">logger</span>
+ <span class="k">else</span><span class="p">:</span> <span class="c1"># could use local logger</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">logger</span></div>
+
+<div class="viewcode-block" id="Sat.getConfig"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.salomeTools.Sat.getConfig">[docs]</a> <span class="k">def</span> <span class="nf">getConfig</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">config</span></div>
+
+<div class="viewcode-block" id="Sat.assumeAsList"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.salomeTools.Sat.assumeAsList">[docs]</a> <span class="k">def</span> <span class="nf">assumeAsList</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">strOrList</span><span class="p">):</span>
+ <span class="k">return</span> <span class="n">assumeAsList</span><span class="p">(</span><span class="n">strOrList</span><span class="p">)</span></div>
+
+ <span class="k">def</span> <span class="nf">_getParser</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Define all possible <options> for salomeTools/sat command: 'sat <options> <args>'</span>
+<span class="sd"> (internal use only)</span>
+<span class="sd"> """</span>
+ <span class="n">parser</span> <span class="o">=</span> <span class="n">Options</span><span class="p">()</span>
+ <span class="n">parser</span><span class="o">.</span><span class="n">add_option</span><span class="p">(</span><span class="s1">'h'</span><span class="p">,</span> <span class="s1">'help'</span><span class="p">,</span> <span class="s1">'boolean'</span><span class="p">,</span> <span class="s1">'help'</span><span class="p">,</span>
+ <span class="n">_</span><span class="p">(</span><span class="s2">"shows global help or help on a specific command."</span><span class="p">))</span>
+ <span class="n">parser</span><span class="o">.</span><span class="n">add_option</span><span class="p">(</span><span class="s1">'o'</span><span class="p">,</span> <span class="s1">'overwrite'</span><span class="p">,</span> <span class="s1">'list'</span><span class="p">,</span> <span class="s2">"overwrite"</span><span class="p">,</span>
+ <span class="n">_</span><span class="p">(</span><span class="s2">"overwrites a configuration parameters."</span><span class="p">))</span>
+ <span class="n">parser</span><span class="o">.</span><span class="n">add_option</span><span class="p">(</span><span class="s1">'g'</span><span class="p">,</span> <span class="s1">'debug'</span><span class="p">,</span> <span class="s1">'boolean'</span><span class="p">,</span> <span class="s1">'debug_mode'</span><span class="p">,</span>
+ <span class="n">_</span><span class="p">(</span><span class="s2">"run salomeTools in debug mode."</span><span class="p">))</span>
+ <span class="n">parser</span><span class="o">.</span><span class="n">add_option</span><span class="p">(</span><span class="s1">'v'</span><span class="p">,</span> <span class="s1">'verbose'</span><span class="p">,</span> <span class="s1">'int'</span><span class="p">,</span> <span class="s2">"output_verbose_level"</span><span class="p">,</span>
+ <span class="n">_</span><span class="p">(</span><span class="s2">"change output verbose level (default is 3)."</span><span class="p">))</span>
+ <span class="n">parser</span><span class="o">.</span><span class="n">add_option</span><span class="p">(</span><span class="s1">'b'</span><span class="p">,</span> <span class="s1">'batch'</span><span class="p">,</span> <span class="s1">'boolean'</span><span class="p">,</span> <span class="s2">"batch"</span><span class="p">,</span>
+ <span class="n">_</span><span class="p">(</span><span class="s2">"batch mode (no question)."</span><span class="p">))</span>
+ <span class="n">parser</span><span class="o">.</span><span class="n">add_option</span><span class="p">(</span><span class="s1">'t'</span><span class="p">,</span> <span class="s1">'all_in_terminal'</span><span class="p">,</span> <span class="s1">'boolean'</span><span class="p">,</span> <span class="s2">"all_in_terminal"</span><span class="p">,</span>
+ <span class="n">_</span><span class="p">(</span><span class="s2">"all traces in the terminal (for example compilation logs)."</span><span class="p">))</span>
+ <span class="n">parser</span><span class="o">.</span><span class="n">add_option</span><span class="p">(</span><span class="s1">'l'</span><span class="p">,</span> <span class="s1">'logs_paths_in_file'</span><span class="p">,</span> <span class="s1">'string'</span><span class="p">,</span> <span class="s2">"logs_paths_in_file"</span><span class="p">,</span>
+ <span class="n">_</span><span class="p">(</span><span class="s2">"put the command result and paths to log files."</span><span class="p">))</span>
+ <span class="k">return</span> <span class="n">parser</span>
+
+
+<div class="viewcode-block" id="Sat.parseArguments"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.salomeTools.Sat.parseArguments">[docs]</a> <span class="k">def</span> <span class="nf">parseArguments</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">arguments</span><span class="p">):</span>
+ <span class="n">args</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">assumeAsList</span><span class="p">(</span><span class="n">arguments</span><span class="p">)</span>
+ <span class="n">genericOptions</span><span class="p">,</span> <span class="n">remaindersArgs</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">parse_args</span><span class="p">(</span><span class="n">args</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">"Sat generic options"</span><span class="p">,</span> <span class="n">genericOptions</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">"Sat remainders arguments"</span><span class="p">,</span> <span class="n">remaindersArgs</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">genericOptions</span><span class="p">,</span> <span class="n">remaindersArgs</span></div>
+
+
+ <span class="k">def</span> <span class="nf">_getModule</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">"""</span>
+<span class="sd"> load and add module Command 'name' in dict self.commands</span>
+<span class="sd"> have to be called only one time maximum for each module Command</span>
+<span class="sd"> """</span>
+ <span class="k">if</span> <span class="n">name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">_COMMANDS_NAMES</span><span class="p">:</span>
+ <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s2">"module command not valid: '</span><span class="si">%s</span><span class="s2">'"</span><span class="p">)</span> <span class="o">%</span> <span class="n">name</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">name</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">commands</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
+ <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s2">"module command existing yet: '</span><span class="si">%s</span><span class="s2">', use getModule"</span><span class="p">)</span> <span class="o">%</span> <span class="n">name</span><span class="p">)</span>
+ <span class="n">file_</span><span class="p">,</span> <span class="n">pathname</span><span class="p">,</span> <span class="n">description</span> <span class="o">=</span> <span class="n">imp</span><span class="o">.</span><span class="n">find_module</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="p">[</span><span class="n">cmdsdir</span><span class="p">])</span>
+ <span class="c1"># could raise Exception in load (catched in sat, logger.critical)</span>
+ <span class="n">module</span> <span class="o">=</span> <span class="n">imp</span><span class="o">.</span><span class="n">load_module</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">file_</span><span class="p">,</span> <span class="n">pathname</span><span class="p">,</span> <span class="n">description</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">commands</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">module</span> <span class="c1"># store module loaded (only one time)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">"Sat load module command </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="n">name</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">module</span>
+
+<div class="viewcode-block" id="Sat.getModule"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.salomeTools.Sat.getModule">[docs]</a> <span class="k">def</span> <span class="nf">getModule</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">"""</span>
+<span class="sd"> returns only-one-time loaded module Command 'name'</span>
+<span class="sd"> assume load if not done yet</span>
+<span class="sd"> """</span>
+ <span class="k">if</span> <span class="n">name</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">commands</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">commands</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">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_getModule</span><span class="p">(</span><span class="n">name</span><span class="p">)</span></div>
+
+<div class="viewcode-block" id="Sat.getCommandInstance"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.salomeTools.Sat.getCommandInstance">[docs]</a> <span class="k">def</span> <span class="nf">getCommandInstance</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">"""\</span>
+<span class="sd"> returns inherited instance of Command(_BaseCmd) for command 'name'</span>
+<span class="sd"> if module not loaded yet, load it.</span>
+<span class="sd"> """</span>
+ <span class="n">module</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">getModule</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="n">commandInstance</span> <span class="o">=</span> <span class="n">module</span><span class="o">.</span><span class="n">Command</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="c1"># set runner as 'parent' (and logger...)</span>
+ <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
+ <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s2">"Problem instance </span><span class="si">%s</span><span class="s2">.Command(): </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">e</span><span class="p">))</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">"Sat new instance </span><span class="si">%s</span><span class="s2">.Command()"</span> <span class="o">%</span> <span class="n">name</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">commandInstance</span> </div>
+
+<div class="viewcode-block" id="Sat.execute_cli"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.salomeTools.Sat.execute_cli">[docs]</a> <span class="k">def</span> <span class="nf">execute_cli</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cli_arguments</span><span class="p">):</span>
+ <span class="sd">"""select first argument as a command in directory 'commands', and launch on arguments</span>
+<span class="sd"> </span>
+<span class="sd"> :param args str or list, The sat cli arguments (as sys.argv)</span>
+<span class="sd"> """</span>
+ <span class="n">args</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">assumeAsList</span><span class="p">(</span><span class="n">cli_arguments</span><span class="p">)</span>
+
+ <span class="c1"># print general help and returns</span>
+ <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">args</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">print_help</span><span class="p">()</span>
+ <span class="k">return</span> <span class="n">RCO</span><span class="o">.</span><span class="n">ReturnCode</span><span class="p">(</span><span class="s2">"OK"</span><span class="p">,</span> <span class="s2">"No arguments, as 'sat --help'"</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="n">remainderArgs</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">parseArguments</span><span class="p">(</span><span class="n">args</span><span class="p">)</span>
+
+ <span class="c1"># if the help option has been called, print command help and returns</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">options</span><span class="o">.</span><span class="n">help</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">print_help</span><span class="p">()</span>
+ <span class="k">return</span> <span class="n">RCO</span><span class="o">.</span><span class="n">ReturnCode</span><span class="p">(</span><span class="s2">"OK"</span><span class="p">,</span> <span class="s2">"Option --help"</span><span class="p">)</span>
+
+ <span class="bp">self</span><span class="o">.</span><span class="n">nameCommandToLoad</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">nameAppliToLoad</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">commandArguments</span> <span class="o">=</span> \
+ <span class="bp">self</span><span class="o">.</span><span class="n">getCommandAndAppli</span><span class="p">(</span><span class="n">remainderArgs</span><span class="p">)</span>
+
+ <span class="n">cfgManager</span> <span class="o">=</span> <span class="n">CFGMGR</span><span class="o">.</span><span class="n">ConfigManager</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">config</span> <span class="o">=</span> <span class="n">cfgManager</span><span class="o">.</span><span class="n">get_config</span><span class="p">(</span>
+ <span class="n">application</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">nameAppliToLoad</span><span class="p">,</span>
+ <span class="n">options</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">options</span><span class="p">,</span>
+ <span class="n">command</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">nameCommandToLoad</span><span class="p">,</span>
+ <span class="n">datadir</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span>
+
+ <span class="c1"># create/get dynamically the command instance to call its 'run' method</span>
+ <span class="n">cmdInstance</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">getCommandInstance</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">nameCommandToLoad</span><span class="p">)</span>
+
+ <span class="c1"># Run the command using the arguments</span>
+ <span class="n">returnCode</span> <span class="o">=</span> <span class="n">cmdInstance</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">commandArguments</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">returnCode</span></div>
+
+<div class="viewcode-block" id="Sat.getCommandAndAppli"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.salomeTools.Sat.getCommandAndAppli">[docs]</a> <span class="k">def</span> <span class="nf">getCommandAndAppli</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">arguments</span><span class="p">):</span>
+ <span class="n">args</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">assumeAsList</span><span class="p">(</span><span class="n">arguments</span><span class="p">)</span>
+ <span class="n">namecmd</span><span class="p">,</span> <span class="n">nameAppli</span><span class="p">,</span> <span class="n">remainderArgs</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="p">[]</span>
+ <span class="n">iremain</span> <span class="o">=</span> <span class="mi">0</span>
+ <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">args</span><span class="p">)</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span>
+ <span class="k">if</span> <span class="s2">"-"</span> <span class="o">!=</span> <span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">][</span><span class="mi">0</span><span class="p">]:</span>
+ <span class="n">namecmd</span> <span class="o">=</span> <span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
+ <span class="n">iremain</span> <span class="o">=</span> <span class="mi">1</span>
+ <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">args</span><span class="p">)</span> <span class="o">></span> <span class="mi">1</span><span class="p">:</span>
+ <span class="k">if</span> <span class="s2">"-"</span> <span class="o">!=</span> <span class="n">args</span><span class="p">[</span><span class="mi">1</span><span class="p">][</span><span class="mi">0</span><span class="p">]:</span>
+ <span class="n">nameAppli</span> <span class="o">=</span> <span class="n">args</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
+ <span class="n">iremain</span> <span class="o">=</span> <span class="mi">2</span>
+ <span class="n">remainderArgs</span> <span class="o">=</span> <span class="n">args</span><span class="p">[</span><span class="n">iremain</span><span class="p">:]</span>
+ <span class="n">res</span> <span class="o">=</span> <span class="p">(</span><span class="n">namecmd</span><span class="p">,</span> <span class="n">nameAppli</span><span class="p">,</span> <span class="n">remainderArgs</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">"getCommandAndAppli"</span><span class="p">,</span> <span class="n">res</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">res</span></div>
+
+
+<div class="viewcode-block" id="Sat.get_help"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.salomeTools.Sat.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">"""get general help colored string"""</span>
+ <span class="n">msg</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">getColoredVersion</span><span class="p">()</span> <span class="o">+</span> <span class="s2">"</span><span class="se">\n\n</span><span class="s2">"</span>
+ <span class="n">msg</span> <span class="o">+=</span> <span class="s2">"<header>Usage:<reset> sat [generic_options] <command> [product] [command_options]</span><span class="se">\n\n</span><span class="s2">"</span>
+ <span class="n">msg</span> <span class="o">+=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_getParser</span><span class="p">()</span><span class="o">.</span><span class="n">get_help</span><span class="p">()</span> <span class="o">+</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span>
+ <span class="n">msg</span> <span class="o">+=</span> <span class="s2">"<header>"</span> <span class="o">+</span> <span class="n">_</span><span class="p">(</span><span class="s2">"Available commands are:"</span><span class="p">)</span> <span class="o">+</span> <span class="s2">"<reset></span><span class="se">\n\n</span><span class="s2">"</span>
+ <span class="k">for</span> <span class="n">command</span> <span class="ow">in</span> <span class="n">_COMMANDS_NAMES</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="p">(</span><span class="n">command</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="c1"># how to get the help for a specific command</span>
+ <span class="n">msg</span> <span class="o">+=</span> <span class="s2">"<header>"</span> <span class="o">+</span> <span class="n">_</span><span class="p">(</span><span class="s2">"Getting the help for a specific command: "</span><span class="p">)</span> <span class="o">+</span> \
+ <span class="s2">"<reset>sat <command> --help</span><span class="se">\n</span><span class="s2">"</span>
+ <span class="k">return</span> <span class="n">msg</span></div>
+
+<div class="viewcode-block" id="Sat.print_help"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.salomeTools.Sat.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">"""prints salomeTools general help"""</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">get_help</span><span class="p">())</span></div>
+
+<div class="viewcode-block" id="Sat.getConfigManager"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.salomeTools.Sat.getConfigManager">[docs]</a> <span class="k">def</span> <span class="nf">getConfigManager</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="kn">import</span> <span class="nn">src.configManager</span> <span class="k">as</span> <span class="nn">CFGMGR</span>
+ <span class="k">return</span> <span class="n">CFGMGR</span><span class="o">.</span><span class="n">ConfigManager</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="p">)</span></div>
+
+<div class="viewcode-block" id="Sat.getColoredVersion"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.salomeTools.Sat.getColoredVersion">[docs]</a> <span class="k">def</span> <span class="nf">getColoredVersion</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="sd">"""get colored salomeTools version message"""</span>
+ <span class="n">version</span> <span class="o">=</span> <span class="n">getVersion</span><span class="p">()</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
+ <span class="c1"># verify coherency with config.INTERNAL.sat_version</span>
+ <span class="k">if</span> <span class="n">config</span><span class="o">.</span><span class="n">INTERNAL</span><span class="o">.</span><span class="n">sat_version</span> <span class="o">!=</span> <span class="n">version</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="s2">"verify version with INTERNAL.sat_version"</span><span class="p">)</span>
+ <span class="n">msg</span> <span class="o">=</span> <span class="s2">"<header>Version:<reset> "</span> <span class="o">+</span> <span class="n">version</span>
+ <span class="k">return</span> <span class="n">msg</span></div></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>
+ <form class="search" action="../../search.html" method="get">
+ <div><input type="text" name="q" /></div>
+ <div><input type="submit" value="Go" /></div>
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</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.4.9</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
+
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
-
<!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.system — salomeTools 5.0.0dev documentation</title>
+
<link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
- <script type="text/javascript" src="../../_static/documentation_options.js"></script>
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
- <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/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="top" title="salomeTools 5.0.0dev documentation" href="../../index.html" />
+ <link rel="up" title="Module code" href="../index.html" />
<link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
- </head><body>
+ </head>
+ <body role="document">
<div class="document">
<span class="c1"># Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</span>
<span class="sd">'''</span>
-<span class="sd">In this file : all functions that do a system call, </span>
+<span class="sd">All utilities method doing a system call, </span>
<span class="sd">like open a browser or an editor, or call a git command</span>
+
+<span class="sd">usage:</span>
+<span class="sd"> >> import src.system as SYSS</span>
<span class="sd">'''</span>
<span class="kn">import</span> <span class="nn">subprocess</span>
<span class="kn">import</span> <span class="nn">os</span>
<span class="kn">import</span> <span class="nn">tarfile</span>
-
-<span class="kn">from</span> <span class="nn">.</span> <span class="k">import</span> <span class="n">printcolors</span>
+<span class="kn">import</span> <span class="nn">src.returnCode</span> <span class="k">as</span> <span class="nn">RCO</span>
<div class="viewcode-block" id="show_in_editor"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.system.show_in_editor">[docs]</a><span class="k">def</span> <span class="nf">show_in_editor</span><span class="p">(</span><span class="n">editor</span><span class="p">,</span> <span class="n">filePath</span><span class="p">,</span> <span class="n">logger</span><span class="p">):</span>
- <span class="sd">'''open filePath using editor.</span>
+ <span class="sd">"""\</span>
+<span class="sd"> open filePath using editor.</span>
<span class="sd"> </span>
<span class="sd"> :param editor str: The editor to use.</span>
<span class="sd"> :param filePath str: The path to the file to open.</span>
-<span class="sd"> '''</span>
+<span class="sd"> """</span>
<span class="c1"># default editor is vi</span>
<span class="k">if</span> <span class="n">editor</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">or</span> <span class="nb">len</span><span class="p">(</span><span class="n">editor</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="n">editor</span> <span class="o">=</span> <span class="s1">'vi'</span>
<span class="k">try</span><span class="p">:</span>
<span class="c1"># launch cmd using subprocess.Popen</span>
<span class="n">cmd</span> <span class="o">=</span> <span class="n">editor</span> <span class="o">%</span> <span class="n">filePath</span>
- <span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">'Launched command:</span><span class="se">\n</span><span class="s1">'</span> <span class="o">+</span> <span class="n">cmd</span> <span class="o">+</span> <span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">,</span> <span class="mi">5</span><span class="p">)</span>
+ <span class="n">msg</span> <span class="o">=</span> <span class="s2">"show_in_editor command: '</span><span class="si">%s</span><span class="s2">'"</span> <span class="o">%</span> <span class="n">cmd</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
<span class="n">p</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">Popen</span><span class="p">(</span><span class="n">cmd</span><span class="p">,</span> <span class="n">shell</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="n">p</span><span class="o">.</span><span class="n">communicate</span><span class="p">()</span>
+ <span class="k">return</span> <span class="n">RCO</span><span class="o">.</span><span class="n">ReturnCode</span><span class="p">(</span><span class="s2">"OK"</span><span class="p">,</span> <span class="n">msg</span><span class="p">)</span>
<span class="k">except</span><span class="p">:</span>
- <span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">printcolors</span><span class="o">.</span><span class="n">printcError</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s2">"Unable to edit file </span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
- <span class="o">%</span> <span class="n">filePath</span><span class="p">),</span> <span class="mi">1</span><span class="p">)</span></div>
+ <span class="n">msg</span> <span class="o">=</span> <span class="n">_</span><span class="p">(</span><span class="s2">"Unable to edit file '</span><span class="si">%s</span><span class="s2">'"</span><span class="p">)</span> <span class="o">%</span> <span class="n">filePath</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">RCO</span><span class="o">.</span><span class="n">ReturnCode</span><span class="p">(</span><span class="s2">"KO"</span><span class="p">,</span> <span class="n">msg</span><span class="p">)</span></div>
<div class="viewcode-block" id="git_extract"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.system.git_extract">[docs]</a><span class="k">def</span> <span class="nf">git_extract</span><span class="p">(</span><span class="n">from_what</span><span class="p">,</span> <span class="n">tag</span><span class="p">,</span> <span class="n">where</span><span class="p">,</span> <span class="n">logger</span><span class="p">,</span> <span class="n">environment</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
- <span class="sd">'''Extracts sources from a git repository.</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Extracts sources from a git repository.</span>
<span class="sd"> </span>
<span class="sd"> :param from_what str: The remote git repository.</span>
<span class="sd"> :param tag str: The tag.</span>
<span class="sd"> extracting.</span>
<span class="sd"> :return: True if the extraction is successful</span>
<span class="sd"> :rtype: boolean</span>
-<span class="sd"> '''</span>
+<span class="sd"> """</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">where</span><span class="o">.</span><span class="n">exists</span><span class="p">():</span>
<span class="n">where</span><span class="o">.</span><span class="n">make</span><span class="p">()</span>
<span class="k">if</span> <span class="n">tag</span> <span class="o">==</span> <span class="s2">"master"</span> <span class="ow">or</span> <span class="n">tag</span> <span class="o">==</span> <span class="s2">"HEAD"</span><span class="p">:</span>
<span class="s1">'where'</span><span class="p">:</span> <span class="nb">str</span><span class="p">(</span><span class="n">where</span><span class="p">),</span>
<span class="s1">'where_git'</span><span class="p">:</span> <span class="n">where_git</span> <span class="p">}</span>
- <span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">command</span> <span class="o">+</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">,</span> <span class="mi">5</span><span class="p">)</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">"git_extract </span><span class="se">\n</span><span class="s2">"</span> <span class="o">+</span> <span class="n">command</span><span class="p">)</span>
<span class="n">logger</span><span class="o">.</span><span class="n">logTxtFile</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">"</span><span class="se">\n</span><span class="s2">"</span> <span class="o">+</span> <span class="n">command</span> <span class="o">+</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
<span class="n">logger</span><span class="o">.</span><span class="n">logTxtFile</span><span class="o">.</span><span class="n">flush</span><span class="p">()</span>
<span class="k">return</span> <span class="p">(</span><span class="n">res</span> <span class="o">==</span> <span class="mi">0</span><span class="p">)</span></div>
<div class="viewcode-block" id="archive_extract"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.system.archive_extract">[docs]</a><span class="k">def</span> <span class="nf">archive_extract</span><span class="p">(</span><span class="n">from_what</span><span class="p">,</span> <span class="n">where</span><span class="p">,</span> <span class="n">logger</span><span class="p">):</span>
- <span class="sd">'''Extracts sources from an archive.</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Extracts sources from an archive.</span>
<span class="sd"> </span>
<span class="sd"> :param from_what str: The path to the archive.</span>
<span class="sd"> :param where str: The path where to extract.</span>
<span class="sd"> :param logger Logger: The logger instance to use.</span>
<span class="sd"> :return: True if the extraction is successful</span>
<span class="sd"> :rtype: boolean</span>
-<span class="sd"> '''</span>
+<span class="sd"> """</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">archive</span> <span class="o">=</span> <span class="n">tarfile</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="n">from_what</span><span class="p">)</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="n">archive</span><span class="o">.</span><span class="n">getmembers</span><span class="p">():</span>
<span class="n">archive</span><span class="o">.</span><span class="n">extract</span><span class="p">(</span><span class="n">i</span><span class="p">,</span> <span class="n">path</span><span class="o">=</span><span class="nb">str</span><span class="p">(</span><span class="n">where</span><span class="p">))</span>
<span class="k">return</span> <span class="kc">True</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">commonprefix</span><span class="p">(</span><span class="n">archive</span><span class="o">.</span><span class="n">getnames</span><span class="p">())</span>
<span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">exc</span><span class="p">:</span>
- <span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">"archive_extract: </span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span> <span class="n">exc</span><span class="p">)</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="s2">"archive_extract: </span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span> <span class="n">exc</span><span class="p">)</span>
<span class="k">return</span> <span class="kc">False</span><span class="p">,</span> <span class="kc">None</span></div>
<div class="viewcode-block" id="cvs_extract"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.system.cvs_extract">[docs]</a><span class="k">def</span> <span class="nf">cvs_extract</span><span class="p">(</span><span class="n">protocol</span><span class="p">,</span> <span class="n">user</span><span class="p">,</span> <span class="n">server</span><span class="p">,</span> <span class="n">base</span><span class="p">,</span> <span class="n">tag</span><span class="p">,</span> <span class="n">product</span><span class="p">,</span> <span class="n">where</span><span class="p">,</span>
<span class="n">logger</span><span class="p">,</span> <span class="n">checkout</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">environment</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
- <span class="sd">'''Extracts sources from a cvs repository.</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Extracts sources from a cvs repository.</span>
<span class="sd"> </span>
<span class="sd"> :param protocol str: The cvs protocol.</span>
<span class="sd"> :param user str: The user to be used.</span>
<span class="sd"> extracting.</span>
<span class="sd"> :return: True if the extraction is successful</span>
<span class="sd"> :rtype: boolean</span>
-<span class="sd"> '''</span>
+<span class="sd"> """</span>
<span class="n">opttag</span> <span class="o">=</span> <span class="s1">''</span>
<span class="k">if</span> <span class="n">tag</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="nb">len</span><span class="p">(</span><span class="n">tag</span><span class="p">)</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span>
<span class="p">{</span> <span class="s1">'root'</span><span class="p">:</span> <span class="n">server</span><span class="p">,</span> <span class="s1">'base'</span><span class="p">:</span> <span class="n">base</span><span class="p">,</span> <span class="s1">'where'</span><span class="p">:</span> <span class="nb">str</span><span class="p">(</span><span class="n">where</span><span class="o">.</span><span class="n">base</span><span class="p">()),</span>
<span class="s1">'tag'</span><span class="p">:</span> <span class="n">opttag</span><span class="p">,</span> <span class="s1">'product'</span><span class="p">:</span> <span class="n">product</span><span class="p">,</span> <span class="s1">'command'</span><span class="p">:</span> <span class="n">cmd</span> <span class="p">}</span>
- <span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">command</span> <span class="o">+</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">,</span> <span class="mi">5</span><span class="p">)</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="n">command</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">where</span><span class="o">.</span><span class="n">dir</span><span class="p">()</span><span class="o">.</span><span class="n">exists</span><span class="p">():</span>
<span class="n">where</span><span class="o">.</span><span class="n">dir</span><span class="p">()</span><span class="o">.</span><span class="n">make</span><span class="p">()</span>
<span class="n">logger</span><span class="p">,</span>
<span class="n">checkout</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
<span class="n">environment</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
- <span class="sd">'''Extracts sources from a svn repository.</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Extracts sources from a svn repository.</span>
<span class="sd"> </span>
<span class="sd"> :param user str: The user to be used.</span>
<span class="sd"> :param from_what str: The remote git repository.</span>
<span class="sd"> extracting.</span>
<span class="sd"> :return: True if the extraction is successful</span>
<span class="sd"> :rtype: boolean</span>
-<span class="sd"> '''</span>
+<span class="sd"> """</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">where</span><span class="o">.</span><span class="n">exists</span><span class="p">():</span>
<span class="n">where</span><span class="o">.</span><span class="n">make</span><span class="p">()</span>
<span class="n">logger</span><span class="o">.</span><span class="n">logTxtFile</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">command</span> <span class="o">+</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
- <span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">command</span> <span class="o">+</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">,</span> <span class="mi">5</span><span class="p">)</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="n">command</span><span class="p">)</span>
<span class="n">logger</span><span class="o">.</span><span class="n">logTxtFile</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">"</span><span class="se">\n</span><span class="s2">"</span> <span class="o">+</span> <span class="n">command</span> <span class="o">+</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
<span class="n">logger</span><span class="o">.</span><span class="n">logTxtFile</span><span class="o">.</span><span class="n">flush</span><span class="p">()</span>
<span class="n">res</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">call</span><span class="p">(</span><span class="n">command</span><span class="p">,</span>
</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" />
+ <div><input type="text" name="q" /></div>
+ <div><input type="submit" value="Go" /></div>
<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>
©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>
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.9</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
</div>
-
<!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.template — salomeTools 5.0.0dev documentation</title>
+
<link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
- <script type="text/javascript" src="../../_static/documentation_options.js"></script>
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
- <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/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="top" title="salomeTools 5.0.0dev documentation" href="../../index.html" />
+ <link rel="up" title="Module code" href="../index.html" />
<link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
- </head><body>
+ </head>
+ <body role="document">
<div class="document">
</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" />
+ <div><input type="text" name="q" /></div>
+ <div><input type="submit" value="Go" /></div>
<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>
©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>
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.9</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
</div>
-
<!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.test_module — salomeTools 5.0.0dev documentation</title>
+
<link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
- <script type="text/javascript" src="../../_static/documentation_options.js"></script>
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
- <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/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="top" title="salomeTools 5.0.0dev documentation" href="../../index.html" />
+ <link rel="up" title="Module code" href="../index.html" />
<link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
- </head><body>
+ </head>
+ <body role="document">
<div class="document">
<h1>Source code for src.test_module</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"># Copyright (C) 2010-2018 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="kn">import</span> <span class="nn">imp</span>
<span class="kn">import</span> <span class="nn">subprocess</span>
-<span class="kn">from</span> <span class="nn">.</span> <span class="k">import</span> <span class="n">fork</span>
-<span class="kn">import</span> <span class="nn">src</span>
+<span class="kn">import</span> <span class="nn">src.pyconf</span> <span class="k">as</span> <span class="nn">PYCONF</span>
+<span class="kn">import</span> <span class="nn">src.utilsSat</span> <span class="k">as</span> <span class="nn">UTS</span>
<span class="c1"># directories not considered as test grids</span>
<span class="n">C_IGNORE_GRIDS</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'.git'</span><span class="p">,</span> <span class="s1">'.svn'</span><span class="p">,</span> <span class="s1">'RESSOURCES'</span><span class="p">]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">known_errors</span> <span class="o">=</span> <span class="kc">None</span>
<span class="c1"># create section for results</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">TESTS</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">pyconf</span><span class="o">.</span><span class="n">Sequence</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">TESTS</span> <span class="o">=</span> <span class="n">PYCONF</span><span class="o">.</span><span class="n">Sequence</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">nb_run</span> <span class="o">=</span> <span class="mi">0</span>
<span class="bp">self</span><span class="o">.</span><span class="n">nb_succeed</span> <span class="o">=</span> <span class="mi">0</span>
<span class="n">symlinks</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<div class="viewcode-block" id="Test.prepare_testbase_from_dir"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.test_module.Test.prepare_testbase_from_dir">[docs]</a> <span class="k">def</span> <span class="nf">prepare_testbase_from_dir</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">testbase_name</span><span class="p">,</span> <span class="n">testbase_dir</span><span class="p">):</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s2">"get test base from dir: </span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span> <span class="o">%</span> \
- <span class="n">src</span><span class="o">.</span><span class="n">printcolors</span><span class="o">.</span><span class="n">printcLabel</span><span class="p">(</span><span class="n">testbase_dir</span><span class="p">),</span> <span class="mi">3</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s2">"get test base from dir: </span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span> <span class="o">%</span> <span class="n">UTS</span><span class="o">.</span><span class="n">label</span><span class="p">(</span><span class="n">testbase_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">access</span><span class="p">(</span><span class="n">testbase_dir</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">X_OK</span><span class="p">):</span>
- <span class="k">raise</span> <span class="n">src</span><span class="o">.</span><span class="n">SatException</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s2">"testbase </span><span class="si">%(name)s</span><span class="s2"> (</span><span class="si">%(dir)s</span><span class="s2">) does not "</span>
- <span class="s2">"exist ...</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span> <span class="o">%</span> <span class="p">{</span> <span class="s1">'name'</span><span class="p">:</span> <span class="n">testbase_name</span><span class="p">,</span>
- <span class="s1">'dir'</span><span class="p">:</span> <span class="n">testbase_dir</span> <span class="p">})</span>
+ <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span>
+ <span class="n">_</span><span class="p">(</span><span class="s2">"testbase </span><span class="si">%(name)s</span><span class="s2"> (</span><span class="si">%(dir)s</span><span class="s2">) does not exist ...</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span> <span class="o">%</span> \
+ <span class="p">{</span> <span class="s1">'name'</span><span class="p">:</span> <span class="n">testbase_name</span><span class="p">,</span> <span class="s1">'dir'</span><span class="p">:</span> <span class="n">testbase_dir</span> <span class="p">}</span> <span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_copy_dir</span><span class="p">(</span><span class="n">testbase_dir</span><span class="p">,</span>
<span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">tmp_working_dir</span><span class="p">,</span> <span class="s1">'BASES'</span><span class="p">,</span> <span class="n">testbase_name</span><span class="p">))</span></div>
<span class="n">testbase_name</span><span class="p">,</span>
<span class="n">testbase_base</span><span class="p">,</span>
<span class="n">testbase_tag</span><span class="p">):</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span>
- <span class="n">_</span><span class="p">(</span><span class="s2">"get test base '</span><span class="si">%(testbase)s</span><span class="s2">' with '</span><span class="si">%(tag)s</span><span class="s2">' tag from git</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span> <span class="o">%</span> <span class="p">{</span>
- <span class="s2">"testbase"</span> <span class="p">:</span> <span class="n">src</span><span class="o">.</span><span class="n">printcolors</span><span class="o">.</span><span class="n">printcLabel</span><span class="p">(</span><span class="n">testbase_name</span><span class="p">),</span>
- <span class="s2">"tag"</span> <span class="p">:</span> <span class="n">src</span><span class="o">.</span><span class="n">printcolors</span><span class="o">.</span><span class="n">printcLabel</span><span class="p">(</span><span class="n">testbase_tag</span><span class="p">)},</span>
- <span class="mi">3</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span> <span class="n">_</span><span class="p">(</span><span class="s2">"get test base '</span><span class="si">%s</span><span class="s2">' with '</span><span class="si">%s</span><span class="s2">' tag from git</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span> <span class="o">%</span> \
+ <span class="p">(</span><span class="n">UTS</span><span class="o">.</span><span class="n">label</span><span class="p">(</span><span class="n">testbase_name</span><span class="p">),</span> <span class="n">UTS</span><span class="o">.</span><span class="n">label</span><span class="p">(</span><span class="n">testbase_tag</span><span class="p">))</span> <span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">def</span> <span class="nf">set_signal</span><span class="p">():</span> <span class="c1"># pragma: no cover</span>
<span class="sd">"""see http://bugs.python.org/issue1652"""</span>
<span class="s1">'base'</span><span class="p">:</span> <span class="n">testbase_base</span><span class="p">,</span>
<span class="s1">'dir'</span><span class="p">:</span> <span class="n">testbase_name</span> <span class="p">}</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">"> </span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span> <span class="n">cmd</span><span class="p">,</span> <span class="mi">5</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">"> </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="n">cmd</span><span class="p">)</span>
<span class="k">if</span> <span class="n">src</span><span class="o">.</span><span class="n">architecture</span><span class="o">.</span><span class="n">is_windows</span><span class="p">():</span>
<span class="c1"># preexec_fn not supported on windows platform</span>
<span class="n">res</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">call</span><span class="p">(</span><span class="n">cmd</span><span class="p">,</span>
<span class="n">stdout</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">logTxtFile</span><span class="p">,</span>
<span class="n">stderr</span><span class="o">=</span><span class="n">subprocess</span><span class="o">.</span><span class="n">PIPE</span><span class="p">)</span>
<span class="k">if</span> <span class="n">res</span> <span class="o">!=</span> <span class="mi">0</span><span class="p">:</span>
- <span class="k">raise</span> <span class="n">src</span><span class="o">.</span><span class="n">SatException</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s2">"Error: unable to get test base "</span>
+ <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s2">"Error: unable to get test base "</span>
<span class="s2">"'</span><span class="si">%(name)s</span><span class="s2">' from git '</span><span class="si">%(repo)s</span><span class="s2">'."</span><span class="p">)</span> <span class="o">%</span> \
<span class="p">{</span> <span class="s1">'name'</span><span class="p">:</span> <span class="n">testbase_name</span><span class="p">,</span>
<span class="s1">'repo'</span><span class="p">:</span> <span class="n">testbase_base</span> <span class="p">})</span>
<span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span></div>
<div class="viewcode-block" id="Test.prepare_testbase_from_svn"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.test_module.Test.prepare_testbase_from_svn">[docs]</a> <span class="k">def</span> <span class="nf">prepare_testbase_from_svn</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">user</span><span class="p">,</span> <span class="n">testbase_name</span><span class="p">,</span> <span class="n">testbase_base</span><span class="p">):</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s2">"get test base '</span><span class="si">%s</span><span class="s2">' from svn</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span> <span class="o">%</span> \
- <span class="n">src</span><span class="o">.</span><span class="n">printcolors</span><span class="o">.</span><span class="n">printcLabel</span><span class="p">(</span><span class="n">testbase_name</span><span class="p">),</span> <span class="mi">3</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s2">"get test base '</span><span class="si">%s</span><span class="s2">' from svn</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span> <span class="o">%</span> <span class="n">UTS</span><span class="o">.</span><span class="n">label</span><span class="p">(</span><span class="n">testbase_name</span><span class="p">))</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">def</span> <span class="nf">set_signal</span><span class="p">():</span> <span class="c1"># pragma: no cover</span>
<span class="sd">"""see http://bugs.python.org/issue1652"""</span>
<span class="s1">'dir'</span><span class="p">:</span> <span class="n">testbase_name</span> <span class="p">}</span>
<span class="c1"># Get the application environment</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s2">"Set the application environment</span><span class="se">\n</span><span class="s2">"</span><span class="p">),</span> <span class="mi">5</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s2">"Set the application environment"</span><span class="p">))</span>
<span class="n">env_appli</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">environment</span><span class="o">.</span><span class="n">SalomeEnviron</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="p">,</span>
<span class="n">src</span><span class="o">.</span><span class="n">environment</span><span class="o">.</span><span class="n">Environ</span><span class="p">(</span><span class="nb">dict</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">)))</span>
<span class="n">env_appli</span><span class="o">.</span><span class="n">set_application_env</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="p">)</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">"> </span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span> <span class="n">cmd</span><span class="p">,</span> <span class="mi">5</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">"> </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="n">cmd</span><span class="p">)</span>
<span class="k">if</span> <span class="n">src</span><span class="o">.</span><span class="n">architecture</span><span class="o">.</span><span class="n">is_windows</span><span class="p">():</span>
<span class="c1"># preexec_fn not supported on windows platform</span>
<span class="n">res</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">call</span><span class="p">(</span><span class="n">cmd</span><span class="p">,</span>
<span class="n">env</span><span class="o">=</span><span class="n">env_appli</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">environ</span><span class="p">,)</span>
<span class="k">if</span> <span class="n">res</span> <span class="o">!=</span> <span class="mi">0</span><span class="p">:</span>
- <span class="k">raise</span> <span class="n">src</span><span class="o">.</span><span class="n">SatException</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s2">"Error: unable to get test base '%(nam"</span>
- <span class="s2">"e)s' from svn '</span><span class="si">%(repo)s</span><span class="s2">'."</span><span class="p">)</span> <span class="o">%</span> \
- <span class="p">{</span> <span class="s1">'name'</span><span class="p">:</span> <span class="n">testbase_name</span><span class="p">,</span>
- <span class="s1">'repo'</span><span class="p">:</span> <span class="n">testbase_base</span> <span class="p">})</span>
+ <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span>
+ <span class="n">_</span><span class="p">(</span><span class="s2">"ERROR: unable to get test base '</span><span class="si">%(name)s</span><span class="s2">' from svn '</span><span class="si">%(repo)s</span><span class="s2">'."</span><span class="p">)</span> <span class="o">%</span> \
+ <span class="p">{</span> <span class="s1">'name'</span><span class="p">:</span> <span class="n">testbase_name</span><span class="p">,</span> <span class="s1">'repo'</span><span class="p">:</span> <span class="n">testbase_base</span> <span class="p">}</span> <span class="p">)</span>
<span class="k">except</span> <span class="ne">OSError</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s2">"svn is not installed. exiting...</span><span class="se">\n</span><span class="s2">"</span><span class="p">))</span>
<span class="c1">##</span>
<span class="c1"># Configure tests base.</span>
<div class="viewcode-block" id="Test.prepare_testbase"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.test_module.Test.prepare_testbase">[docs]</a> <span class="k">def</span> <span class="nf">prepare_testbase</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">test_base_name</span><span class="p">):</span>
- <span class="n">src</span><span class="o">.</span><span class="n">printcolors</span><span class="o">.</span><span class="n">print_value</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="p">,</span>
- <span class="n">_</span><span class="p">(</span><span class="s2">"Test base"</span><span class="p">),</span>
- <span class="n">test_base_name</span><span class="p">,</span>
- <span class="mi">3</span><span class="p">)</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span>
+ <span class="n">logger</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">logger</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">info</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="se">\n</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s2">"Test base"</span><span class="p">),</span> <span class="n">test_base_name</span><span class="p">))</span>
<span class="c1"># search for the test base</span>
<span class="n">test_base_info</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">return</span> <span class="mi">0</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">test_base_info</span><span class="p">:</span>
- <span class="n">message</span> <span class="o">=</span> <span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s2">"########## ERROR: test base '</span><span class="si">%s</span><span class="s2">' not found</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span> <span class="o">%</span>
- <span class="n">test_base_name</span><span class="p">)</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">"</span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span> <span class="n">src</span><span class="o">.</span><span class="n">printcolors</span><span class="o">.</span><span class="n">printcError</span><span class="p">(</span><span class="n">message</span><span class="p">))</span>
+ <span class="n">msg</span> <span class="o">=</span> <span class="n">_</span><span class="p">(</span><span class="s2">"test base '</span><span class="si">%s</span><span class="s2">' not found</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span> <span class="o">%</span> <span class="n">test_base_name</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="n">UTS</span><span class="o">.</span><span class="n">red</span><span class="p">(</span><span class="n">msg</span><span class="p">))</span>
<span class="k">return</span> <span class="mi">1</span>
<span class="k">if</span> <span class="n">test_base_info</span><span class="o">.</span><span class="n">get_sources</span> <span class="o">==</span> <span class="s2">"dir"</span><span class="p">:</span>
<span class="n">test_base_name</span><span class="p">,</span>
<span class="n">test_base_info</span><span class="o">.</span><span class="n">info</span><span class="o">.</span><span class="n">base</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
- <span class="k">raise</span> <span class="n">src</span><span class="o">.</span><span class="n">SatException</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s2">"unknown source type '</span><span class="si">%(type)s</span><span class="s2">' for test b"</span>
- <span class="s2">"ase '</span><span class="si">%(base)s</span><span class="s2">' ...</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span> <span class="o">%</span> <span class="p">{</span>
- <span class="s1">'type'</span><span class="p">:</span> <span class="n">test_base_info</span><span class="o">.</span><span class="n">get_sources</span><span class="p">,</span>
- <span class="s1">'base'</span><span class="p">:</span> <span class="n">test_base_name</span> <span class="p">})</span>
+ <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span>
+ <span class="n">_</span><span class="p">(</span><span class="s2">"unknown source type '</span><span class="si">%(type)s</span><span class="s2">' for test base '</span><span class="si">%(base)s</span><span class="s2">' ...</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span> <span class="o">%</span> \
+ <span class="p">{</span><span class="s1">'type'</span><span class="p">:</span> <span class="n">test_base_info</span><span class="o">.</span><span class="n">get_sources</span><span class="p">,</span> <span class="s1">'base'</span><span class="p">:</span> <span class="n">test_base_name</span> <span class="p">}</span> <span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">currentTestBase</span> <span class="o">=</span> <span class="n">test_base_name</span></div>
<div class="viewcode-block" id="Test.generate_script"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.test_module.Test.generate_script">[docs]</a> <span class="k">def</span> <span class="nf">generate_script</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">listTest</span><span class="p">,</span> <span class="n">script_path</span><span class="p">,</span> <span class="n">ignoreList</span><span class="p">):</span>
<span class="c1"># open template file</span>
<span class="n">template_file</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">VARS</span><span class="o">.</span><span class="n">srcDir</span><span class="p">,</span>
- <span class="s2">"test"</span><span class="p">,</span>
- <span class="s2">"scriptTemplate.py"</span><span class="p">),</span> <span class="s1">'r'</span><span class="p">)</span>
+ <span class="s2">"test_module"</span><span class="p">,</span>
+ <span class="s2">"script_test_module.pyTemplate"</span><span class="p">),</span> <span class="s1">'r'</span><span class="p">)</span>
<span class="n">template</span> <span class="o">=</span> <span class="n">string</span><span class="o">.</span><span class="n">Template</span><span class="p">(</span><span class="n">template_file</span><span class="o">.</span><span class="n">read</span><span class="p">())</span>
<span class="c1"># create substitution dictionary</span>
<span class="n">d</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span>
<span class="n">d</span><span class="p">[</span><span class="s1">'resourcesWay'</span><span class="p">]</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">currentDir</span><span class="p">,</span> <span class="s1">'RESSOURCES'</span><span class="p">)</span>
<span class="n">d</span><span class="p">[</span><span class="s1">'tmpDir'</span><span class="p">]</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">tmp_working_dir</span><span class="p">,</span> <span class="s1">'WORK'</span><span class="p">)</span>
- <span class="n">d</span><span class="p">[</span><span class="s1">'toolsWay'</span><span class="p">]</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">VARS</span><span class="o">.</span><span class="n">srcDir</span><span class="p">,</span> <span class="s2">"test"</span><span class="p">)</span>
+ <span class="n">d</span><span class="p">[</span><span class="s1">'toolsWay'</span><span class="p">]</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">VARS</span><span class="o">.</span><span class="n">srcDir</span><span class="p">,</span> <span class="s2">"test_module"</span><span class="p">)</span>
<span class="n">d</span><span class="p">[</span><span class="s1">'sessionDir'</span><span class="p">]</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">currentDir</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">currentgrid</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">currentsession</span><span class="p">)</span>
<span class="n">stdout</span><span class="o">=</span><span class="n">subprocess</span><span class="o">.</span><span class="n">PIPE</span><span class="p">,</span>
<span class="n">shell</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
<span class="n">executable</span><span class="o">=</span><span class="s1">'/bin/bash'</span><span class="p">)</span><span class="o">.</span><span class="n">communicate</span><span class="p">()</span>
- <span class="c1">#print "TRACES OP - test_module.py/Test.get_tmp_dir() subproc_res = "</span>
+ <span class="nb">print</span> <span class="s2">"TRACES OP - test_module.py/Test.get_tmp_dir() subproc_res = "</span>
<span class="k">for</span> <span class="n">resLine</span> <span class="ow">in</span> <span class="n">subproc_res</span><span class="p">:</span>
- <span class="nb">print</span> <span class="s2">"- '#</span><span class="si">%s</span><span class="s2">#'"</span> <span class="o">%</span><span class="n">resLine</span>
+ <span class="nb">print</span> <span class="s2">"- '#</span><span class="si">%s</span><span class="s2">#'"</span> <span class="o">%</span> <span class="n">resLine</span>
<span class="n">root_dir</span> <span class="o">=</span> <span class="n">subproc_res</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">split</span><span class="p">()[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
<span class="c1"># OP 14/11/2017 Ajout de traces pour essayer de decouvrir le pb</span>
<span class="c1"># de remontee de log des tests</span>
- <span class="c1">#print "TRACES OP - test_module.py/Test.get_tmp_dir() root_dir = '#%s#'" %root_dir</span>
+ <span class="nb">print</span> <span class="s2">"TRACES OP - test_module.py/Test.get_tmp_dir() root_dir = '#</span><span class="si">%s</span><span class="s2">#'"</span> <span class="o">%</span> <span class="n">root_dir</span>
<span class="c1"># import grid salome_utils from KERNEL that gives </span>
<span class="c1"># the right getTmpDir function</span>
<span class="n">elapsed</span> <span class="o">=</span> <span class="o">-</span><span class="mi">1</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">currentsession</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s2">"NOGUI_"</span><span class="p">):</span>
<span class="c1"># runSalome -t (bash)</span>
- <span class="n">status</span><span class="p">,</span> <span class="n">elapsed</span> <span class="o">=</span> <span class="n">fork</span><span class="o">.</span><span class="n">batch</span><span class="p">(</span><span class="n">binSalome</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="p">,</span>
- <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">tmp_working_dir</span><span class="p">,</span>
- <span class="s2">"WORK"</span><span class="p">),</span>
- <span class="p">[</span> <span class="s2">"-t"</span><span class="p">,</span>
- <span class="s2">"--shutdown-server=1"</span><span class="p">,</span>
- <span class="n">script_path</span> <span class="p">],</span>
- <span class="n">delai</span><span class="o">=</span><span class="n">time_out</span><span class="p">,</span>
- <span class="n">log</span><span class="o">=</span><span class="n">logWay</span><span class="p">)</span>
+ <span class="n">status</span><span class="p">,</span> <span class="n">elapsed</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">fork</span><span class="o">.</span><span class="n">batch</span><span class="p">(</span>
+ <span class="n">binSalome</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="p">,</span>
+ <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">tmp_working_dir</span><span class="p">,</span> <span class="s2">"WORK"</span><span class="p">),</span>
+ <span class="p">[</span> <span class="s2">"-t"</span><span class="p">,</span> <span class="s2">"--shutdown-server=1"</span><span class="p">,</span> <span class="n">script_path</span> <span class="p">],</span>
+ <span class="n">delai</span><span class="o">=</span><span class="n">time_out</span><span class="p">,</span> <span class="n">log</span><span class="o">=</span><span class="n">logWay</span> <span class="p">)</span>
<span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">currentsession</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s2">"PY_"</span><span class="p">):</span>
<span class="c1"># python script.py</span>
- <span class="n">status</span><span class="p">,</span> <span class="n">elapsed</span> <span class="o">=</span> <span class="n">fork</span><span class="o">.</span><span class="n">batch</span><span class="p">(</span><span class="n">binPython</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="p">,</span>
- <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">tmp_working_dir</span><span class="p">,</span>
- <span class="s2">"WORK"</span><span class="p">),</span>
- <span class="p">[</span><span class="n">script_path</span><span class="p">],</span>
- <span class="n">delai</span><span class="o">=</span><span class="n">time_out</span><span class="p">,</span> <span class="n">log</span><span class="o">=</span><span class="n">logWay</span><span class="p">)</span>
+ <span class="n">status</span><span class="p">,</span> <span class="n">elapsed</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">fork</span><span class="o">.</span><span class="n">batch</span><span class="p">(</span>
+ <span class="n">binPython</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="p">,</span>
+ <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">tmp_working_dir</span><span class="p">,</span> <span class="s2">"WORK"</span><span class="p">),</span>
+ <span class="p">[</span><span class="n">script_path</span><span class="p">],</span>
+ <span class="n">delai</span><span class="o">=</span><span class="n">time_out</span><span class="p">,</span> <span class="n">log</span><span class="o">=</span><span class="n">logWay</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">opt</span> <span class="o">=</span> <span class="s2">"-z 0"</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">show_desktop</span><span class="p">:</span> <span class="n">opt</span> <span class="o">=</span> <span class="s2">"--show-desktop=0"</span>
- <span class="n">status</span><span class="p">,</span> <span class="n">elapsed</span> <span class="o">=</span> <span class="n">fork</span><span class="o">.</span><span class="n">batch_salome</span><span class="p">(</span><span class="n">binSalome</span><span class="p">,</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="p">,</span>
- <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">tmp_working_dir</span><span class="p">,</span>
- <span class="s2">"WORK"</span><span class="p">),</span>
- <span class="p">[</span> <span class="n">opt</span><span class="p">,</span>
- <span class="s2">"--shutdown-server=1"</span><span class="p">,</span>
- <span class="n">script_path</span> <span class="p">],</span>
- <span class="n">getTmpDir</span><span class="o">=</span><span class="n">tmpDir</span><span class="p">,</span>
- <span class="n">fin</span><span class="o">=</span><span class="n">killSalome</span><span class="p">,</span>
- <span class="n">delai</span><span class="o">=</span><span class="n">time_out</span><span class="p">,</span>
- <span class="n">log</span><span class="o">=</span><span class="n">logWay</span><span class="p">,</span>
- <span class="n">delaiapp</span><span class="o">=</span><span class="n">time_out_salome</span><span class="p">)</span>
-
- <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">"status = </span><span class="si">%s</span><span class="s2">, elapsed = </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="n">status</span><span class="p">,</span> <span class="n">elapsed</span><span class="p">),</span>
- <span class="mi">5</span><span class="p">)</span>
+ <span class="n">status</span><span class="p">,</span> <span class="n">elapsed</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">fork</span><span class="o">.</span><span class="n">batch_salome</span><span class="p">(</span>
+ <span class="n">binSalome</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="p">,</span>
+ <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">tmp_working_dir</span><span class="p">,</span> <span class="s2">"WORK"</span><span class="p">),</span>
+ <span class="p">[</span> <span class="n">opt</span><span class="p">,</span> <span class="s2">"--shutdown-server=1"</span><span class="p">,</span> <span class="n">script_path</span> <span class="p">],</span>
+ <span class="n">getTmpDir</span><span class="o">=</span><span class="n">tmpDir</span><span class="p">,</span>
+ <span class="n">fin</span><span class="o">=</span><span class="n">killSalome</span><span class="p">,</span>
+ <span class="n">delai</span><span class="o">=</span><span class="n">time_out</span><span class="p">,</span>
+ <span class="n">log</span><span class="o">=</span><span class="n">logWay</span><span class="p">,</span>
+ <span class="n">delaiapp</span><span class="o">=</span><span class="n">time_out_salome</span><span class="p">)</span>
+
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">"status = </span><span class="si">%s</span><span class="s2">, elapsed = </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="n">status</span><span class="p">,</span> <span class="n">elapsed</span><span class="p">))</span>
<span class="c1"># create the test result to add in the config object</span>
- <span class="n">test_info</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">pyconf</span><span class="o">.</span><span class="n">Mapping</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="p">)</span>
+ <span class="n">test_info</span> <span class="o">=</span> <span class="n">PYCONF</span><span class="o">.</span><span class="n">Mapping</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="p">)</span>
<span class="n">test_info</span><span class="o">.</span><span class="n">testbase</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">currentTestBase</span>
<span class="n">test_info</span><span class="o">.</span><span class="n">grid</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">currentgrid</span>
<span class="n">test_info</span><span class="o">.</span><span class="n">session</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">currentsession</span>
- <span class="n">test_info</span><span class="o">.</span><span class="n">script</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">pyconf</span><span class="o">.</span><span class="n">Sequence</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="p">)</span>
+ <span class="n">test_info</span><span class="o">.</span><span class="n">script</span> <span class="o">=</span> <span class="n">PYCONF</span><span class="o">.</span><span class="n">Sequence</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="p">)</span>
<span class="n">script_results</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">read_results</span><span class="p">(</span><span class="n">listTest</span><span class="p">,</span> <span class="n">elapsed</span> <span class="o">==</span> <span class="n">time_out</span><span class="p">)</span>
<span class="k">for</span> <span class="n">sr</span> <span class="ow">in</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">script_results</span><span class="o">.</span><span class="n">keys</span><span class="p">()):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">nb_run</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="c1"># create script result</span>
- <span class="n">script_info</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">pyconf</span><span class="o">.</span><span class="n">Mapping</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="p">)</span>
+ <span class="n">script_info</span> <span class="o">=</span> <span class="n">PYCONF</span><span class="o">.</span><span class="n">Mapping</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="p">)</span>
<span class="n">script_info</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">sr</span>
<span class="n">script_info</span><span class="o">.</span><span class="n">res</span> <span class="o">=</span> <span class="n">script_results</span><span class="p">[</span><span class="n">sr</span><span class="p">][</span><span class="mi">0</span><span class="p">]</span>
<span class="n">script_info</span><span class="o">.</span><span class="n">time</span> <span class="o">=</span> <span class="n">script_results</span><span class="p">[</span><span class="n">sr</span><span class="p">][</span><span class="mi">1</span><span class="p">]</span>
<span class="n">kfres</span> <span class="o">=</span> <span class="n">script_results</span><span class="p">[</span><span class="n">sr</span><span class="p">][</span><span class="mi">3</span><span class="p">]</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">kfres</span><span class="p">)</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span>
- <span class="n">script_info</span><span class="o">.</span><span class="n">known_error</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">pyconf</span><span class="o">.</span><span class="n">Mapping</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="p">)</span>
+ <span class="n">script_info</span><span class="o">.</span><span class="n">known_error</span> <span class="o">=</span> <span class="n">PYCONF</span><span class="o">.</span><span class="n">Mapping</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="p">)</span>
<span class="n">script_info</span><span class="o">.</span><span class="n">known_error</span><span class="o">.</span><span class="n">date</span> <span class="o">=</span> <span class="n">kfres</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="n">script_info</span><span class="o">.</span><span class="n">known_error</span><span class="o">.</span><span class="n">expected</span> <span class="o">=</span> <span class="n">kfres</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
<span class="n">script_info</span><span class="o">.</span><span class="n">known_error</span><span class="o">.</span><span class="n">comment</span> <span class="o">=</span> <span class="n">kfres</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span>
<span class="n">exectime</span> <span class="o">=</span> <span class="s2">""</span>
<span class="n">sp</span> <span class="o">=</span> <span class="s2">"."</span> <span class="o">*</span> <span class="p">(</span><span class="mi">35</span> <span class="o">-</span> <span class="nb">len</span><span class="p">(</span><span class="n">script_info</span><span class="o">.</span><span class="n">name</span><span class="p">))</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">write_test_margin</span><span class="p">(</span><span class="mi">3</span><span class="p">),</span> <span class="mi">3</span><span class="p">)</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">"script </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="se">\n</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span>
- <span class="n">src</span><span class="o">.</span><span class="n">printcolors</span><span class="o">.</span><span class="n">printcLabel</span><span class="p">(</span><span class="n">script_info</span><span class="o">.</span><span class="n">name</span><span class="p">),</span>
- <span class="n">sp</span><span class="p">,</span>
- <span class="n">src</span><span class="o">.</span><span class="n">printcolors</span><span class="o">.</span><span class="n">printc</span><span class="p">(</span><span class="n">script_info</span><span class="o">.</span><span class="n">res</span><span class="p">),</span>
- <span class="n">exectime</span><span class="p">),</span> <span class="mi">3</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">write_test_margin</span><span class="p">(</span><span class="mi">3</span><span class="p">))</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">"script </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="se">\n</span><span class="s2">"</span> <span class="o">%</span> \
+ <span class="p">(</span><span class="n">UTS</span><span class="o">.</span><span class="n">label</span><span class="p">(</span><span class="n">script_info</span><span class="o">.</span><span class="n">name</span><span class="p">),</span> <span class="n">sp</span><span class="p">,</span> <span class="n">script_info</span><span class="o">.</span><span class="n">res</span><span class="p">,</span> <span class="n">exectime</span><span class="p">))</span>
<span class="k">if</span> <span class="n">script_info</span> <span class="ow">and</span> <span class="nb">len</span><span class="p">(</span><span class="n">callback</span><span class="p">)</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">"Exception in </span><span class="si">%s</span><span class="se">\n</span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span> \
- <span class="p">(</span><span class="n">script_info</span><span class="o">.</span><span class="n">name</span><span class="p">,</span>
- <span class="n">src</span><span class="o">.</span><span class="n">printcolors</span><span class="o">.</span><span class="n">printcWarning</span><span class="p">(</span><span class="n">callback</span><span class="p">)),</span> <span class="mi">2</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="s2">"Exception in </span><span class="si">%s</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">script_info</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">UTS</span><span class="o">.</span><span class="n">red</span><span class="p">(</span><span class="n">callback</span><span class="p">)))</span>
<span class="k">if</span> <span class="n">script_info</span><span class="o">.</span><span class="n">res</span> <span class="o">==</span> <span class="n">src</span><span class="o">.</span><span class="n">OK_STATUS</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">nb_succeed</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="c1"># Runs all tests of a session.</span>
<div class="viewcode-block" id="Test.run_session_tests"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.test_module.Test.run_session_tests">[docs]</a> <span class="k">def</span> <span class="nf">run_session_tests</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">write_test_margin</span><span class="p">(</span><span class="mi">2</span><span class="p">),</span> <span class="mi">3</span><span class="p">)</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">"Session = </span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span> <span class="n">src</span><span class="o">.</span><span class="n">printcolors</span><span class="o">.</span><span class="n">printcLabel</span><span class="p">(</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">currentsession</span><span class="p">),</span> <span class="mi">3</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">write_test_margin</span><span class="p">(</span><span class="mi">2</span><span class="p">))</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">"Session = </span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span> <span class="n">UTS</span><span class="o">.</span><span class="n">label</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">currentsession</span><span class="p">))</span>
<span class="c1"># prepare list of tests to run</span>
<span class="n">tests</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">listdir</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">currentDir</span><span class="p">,</span>
<span class="c1">##</span>
<span class="c1"># Runs all tests of a grid.</span>
<div class="viewcode-block" id="Test.run_grid_tests"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.test_module.Test.run_grid_tests">[docs]</a> <span class="k">def</span> <span class="nf">run_grid_tests</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">write_test_margin</span><span class="p">(</span><span class="mi">1</span><span class="p">),</span> <span class="mi">3</span><span class="p">)</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">"grid = </span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span> <span class="n">src</span><span class="o">.</span><span class="n">printcolors</span><span class="o">.</span><span class="n">printcLabel</span><span class="p">(</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">currentgrid</span><span class="p">),</span> <span class="mi">3</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">write_test_margin</span><span class="p">(</span><span class="mi">1</span><span class="p">))</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">"grid = </span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span> <span class="n">UTS</span><span class="o">.</span><span class="n">label</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">currentgrid</span><span class="p">))</span>
<span class="n">grid_path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">currentDir</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">currentgrid</span><span class="p">)</span>
<span class="n">sessions</span> <span class="o">=</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">sessions</span><span class="p">,</span> <span class="n">key</span><span class="o">=</span><span class="nb">str</span><span class="o">.</span><span class="n">lower</span><span class="p">)</span>
<span class="k">for</span> <span class="n">session_</span> <span class="ow">in</span> <span class="n">sessions</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">grid_path</span><span class="p">,</span> <span class="n">session_</span><span class="p">)):</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">write_test_margin</span><span class="p">(</span><span class="mi">2</span><span class="p">),</span> <span class="mi">3</span><span class="p">)</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">src</span><span class="o">.</span><span class="n">printcolors</span><span class="o">.</span><span class="n">printcWarning</span><span class="p">(</span><span class="s2">"Session </span><span class="si">%s</span><span class="s2"> not"</span>
- <span class="s2">" found"</span> <span class="o">%</span> <span class="n">session_</span><span class="p">)</span> <span class="o">+</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">write_test_margin</span><span class="p">(</span><span class="mi">2</span><span class="p">))</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="s2">"Session </span><span class="si">%s</span><span class="s2"> not found"</span> <span class="o">%</span> <span class="n">session_</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">currentsession</span> <span class="o">=</span> <span class="n">session_</span>
<span class="bp">self</span><span class="o">.</span><span class="n">run_session_tests</span><span class="p">()</span></div>
- <span class="c1">##</span>
- <span class="c1"># Runs test testbase.</span>
+
<div class="viewcode-block" id="Test.run_testbase_tests"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.test_module.Test.run_testbase_tests">[docs]</a> <span class="k">def</span> <span class="nf">run_testbase_tests</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="sd">"""Runs test testbase"""</span>
+ <span class="n">logger</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">logger</span>
<span class="n">res_dir</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">currentDir</span><span class="p">,</span> <span class="s2">"RESSOURCES"</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">"fix what the pythonpath ?"</span><span class="p">,</span> <span class="p">)</span>
<span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s1">'PYTHONPATH'</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span><span class="n">res_dir</span> <span class="o">+</span>
<span class="n">os</span><span class="o">.</span><span class="n">pathsep</span> <span class="o">+</span>
<span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s1">'PYTHONPATH'</span><span class="p">])</span>
+
+ <span class="n">DBG</span><span class="o">.</span><span class="n">tofix</span><span class="p">(</span><span class="s2">"fix what the hell is the pythonpath ?"</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s1">'PYTHONPATH'</span><span class="p">],</span> <span class="kc">True</span><span class="p">)</span>
+
<span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s1">'TT_BASE_RESSOURCES'</span><span class="p">]</span> <span class="o">=</span> <span class="n">res_dir</span>
- <span class="n">src</span><span class="o">.</span><span class="n">printcolors</span><span class="o">.</span><span class="n">print_value</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="p">,</span>
- <span class="s2">"TT_BASE_RESSOURCES"</span><span class="p">,</span>
- <span class="n">res_dir</span><span class="p">,</span>
- <span class="mi">4</span><span class="p">)</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">,</span> <span class="mi">4</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span>
-
- <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">write_test_margin</span><span class="p">(</span><span class="mi">0</span><span class="p">),</span> <span class="mi">3</span><span class="p">)</span>
- <span class="n">testbase_label</span> <span class="o">=</span> <span class="s2">"Test base = </span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span> <span class="n">src</span><span class="o">.</span><span class="n">printcolors</span><span class="o">.</span><span class="n">printcLabel</span><span class="p">(</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">currentTestBase</span><span class="p">)</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">testbase_label</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">"-"</span> <span class="o">*</span> <span class="nb">len</span><span class="p">(</span><span class="n">src</span><span class="o">.</span><span class="n">printcolors</span><span class="o">.</span><span class="n">cleancolor</span><span class="p">(</span><span class="n">testbase_label</span><span class="p">)),</span>
- <span class="mi">3</span><span class="p">)</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">debug</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="se">\n</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="s2">"TT_BASE_RESSOURCES"</span><span class="p">,</span> <span class="n">res_dir</span><span class="p">))</span>
+
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">write_test_margin</span><span class="p">(</span><span class="mi">0</span><span class="p">))</span>
+ <span class="n">testbase_label</span> <span class="o">=</span> <span class="s2">"Test base = </span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span> <span class="n">UTS</span><span class="o">.</span><span class="n">label</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">currentTestBase</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="n">testbase_label</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">"-"</span> <span class="o">*</span> <span class="nb">len</span><span class="p">(</span><span class="n">UTS</span><span class="o">.</span><span class="n">cleancolor</span><span class="p">(</span><span class="n">testbase_label</span><span class="p">)))</span>
<span class="c1"># load settings</span>
<span class="n">settings_file</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">res_dir</span><span class="p">,</span> <span class="s2">"test_settings.py"</span><span class="p">)</span>
<span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">settings_file</span><span class="p">):</span>
<span class="n">gdic</span><span class="p">,</span> <span class="n">ldic</span> <span class="o">=</span> <span class="p">{},</span> <span class="p">{}</span>
<span class="n">execfile</span><span class="p">(</span><span class="n">settings_file</span><span class="p">,</span> <span class="n">gdic</span><span class="p">,</span> <span class="n">ldic</span><span class="p">)</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s2">"Load test settings</span><span class="se">\n</span><span class="s2">"</span><span class="p">),</span> <span class="mi">3</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s2">"Load test settings"</span><span class="p">))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">settings</span> <span class="o">=</span> <span class="n">ldic</span><span class="p">[</span><span class="s1">'settings_dic'</span><span class="p">]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">ignore_tests</span> <span class="o">=</span> <span class="n">ldic</span><span class="p">[</span><span class="s1">'known_failures_list'</span><span class="p">]</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">ignore_tests</span><span class="p">,</span> <span class="nb">list</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">ignore_tests</span> <span class="o">=</span> <span class="p">{}</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">src</span><span class="o">.</span><span class="n">printcolors</span><span class="o">.</span><span class="n">printcWarning</span><span class="p">(</span><span class="s2">"known_failur"</span>
- <span class="s2">"es_list must be a dictionary (not a list)"</span><span class="p">)</span> <span class="o">+</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="s2">"known failures must be a dictionary (not a list)"</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">ignore_tests</span> <span class="o">=</span> <span class="p">{}</span>
<span class="bp">self</span><span class="o">.</span><span class="n">settings</span><span class="o">.</span><span class="n">clear</span><span class="p">()</span>
<span class="n">grids</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">grids</span> <span class="c1"># given by user</span>
<span class="k">else</span><span class="p">:</span>
<span class="c1"># select all the grids (i.e. directories) in the directory</span>
- <span class="n">grids</span> <span class="o">=</span> <span class="nb">filter</span><span class="p">(</span><span class="k">lambda</span> <span class="n">l</span><span class="p">:</span> <span class="n">l</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">C_IGNORE_GRIDS</span><span class="p">,</span>
- <span class="n">os</span><span class="o">.</span><span class="n">listdir</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">currentDir</span><span class="p">))</span>
- <span class="n">grids</span> <span class="o">=</span> <span class="nb">filter</span><span class="p">(</span><span class="k">lambda</span> <span class="n">l</span><span class="p">:</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isdir</span><span class="p">(</span>
- <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">currentDir</span><span class="p">,</span> <span class="n">l</span><span class="p">)),</span>
- <span class="n">grids</span><span class="p">)</span>
+ <span class="n">grids</span> <span class="o">=</span> <span class="nb">filter</span><span class="p">(</span><span class="k">lambda</span> <span class="n">l</span><span class="p">:</span> <span class="n">l</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">C_IGNORE_GRIDS</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">listdir</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">currentDir</span><span class="p">))</span>
+ <span class="n">grids</span> <span class="o">=</span> <span class="nb">filter</span><span class="p">(</span><span class="k">lambda</span> <span class="n">l</span><span class="p">:</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isdir</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">currentDir</span><span class="p">,</span> <span class="n">l</span><span class="p">)),</span> <span class="n">grids</span><span class="p">)</span>
<span class="n">grids</span> <span class="o">=</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">grids</span><span class="p">,</span> <span class="n">key</span><span class="o">=</span><span class="nb">str</span><span class="o">.</span><span class="n">lower</span><span class="p">)</span>
<span class="k">for</span> <span class="n">grid</span> <span class="ow">in</span> <span class="n">grids</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">currentDir</span><span class="p">,</span> <span class="n">grid</span><span class="p">)):</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">write_test_margin</span><span class="p">(</span><span class="mi">1</span><span class="p">),</span> <span class="mi">3</span><span class="p">)</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">src</span><span class="o">.</span><span class="n">printcolors</span><span class="o">.</span><span class="n">printcWarning</span><span class="p">(</span>
- <span class="s2">"grid </span><span class="si">%s</span><span class="s2"> does not exist</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span> <span class="n">grid</span><span class="p">),</span> <span class="mi">3</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">write_test_margin</span><span class="p">(</span><span class="mi">1</span><span class="p">))</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="s2">"grid </span><span class="si">%s</span><span class="s2"> does not exist"</span> <span class="o">%</span> <span class="n">grid</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">currentgrid</span> <span class="o">=</span> <span class="n">grid</span>
<span class="bp">self</span><span class="o">.</span><span class="n">run_grid_tests</span><span class="p">()</span></div>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">script</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">return</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">script</span><span class="p">):</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">src</span><span class="o">.</span><span class="n">printcolors</span><span class="o">.</span><span class="n">printcWarning</span><span class="p">(</span><span class="s2">"WARNING: scrip"</span>
- <span class="s2">"t not found: </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="n">script</span><span class="p">)</span> <span class="o">+</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>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="s2">"script not found: </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="n">script</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">src</span><span class="o">.</span><span class="n">printcolors</span><span class="o">.</span><span class="n">printcHeader</span><span class="p">(</span><span class="s2">"----------- sta"</span>
- <span class="s2">"rt </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="n">script_name</span><span class="p">)</span> <span class="o">+</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>
- <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">"Run script: </span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span> <span class="n">script</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">"----------- start </span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span> <span class="n">script_name</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">"Run script: </span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span> <span class="n">script</span><span class="p">)</span>
<span class="n">subprocess</span><span class="o">.</span><span class="n">Popen</span><span class="p">(</span><span class="n">script</span><span class="p">,</span> <span class="n">shell</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span><span class="o">.</span><span class="n">wait</span><span class="p">()</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">src</span><span class="o">.</span><span class="n">printcolors</span><span class="o">.</span><span class="n">printcHeader</span><span class="p">(</span><span class="s2">"----------- end"</span>
- <span class="s2">" </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="n">script_name</span><span class="p">)</span> <span class="o">+</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>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">"----------- end </span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span> <span class="n">script_name</span><span class="p">)</span></div>
<div class="viewcode-block" id="Test.run_all_tests"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.test_module.Test.run_all_tests">[docs]</a> <span class="k">def</span> <span class="nf">run_all_tests</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">initTime</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">now</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">run_script</span><span class="p">(</span><span class="s1">'test_setup'</span><span class="p">)</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span>
-
- <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">src</span><span class="o">.</span><span class="n">printcolors</span><span class="o">.</span><span class="n">printcHeader</span><span class="p">(</span>
- <span class="n">_</span><span class="p">(</span><span class="s2">"=== STARTING TESTS"</span><span class="p">))</span> <span class="o">+</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>
- <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">currentDir</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">tmp_working_dir</span><span class="p">,</span>
- <span class="s1">'BASES'</span><span class="p">,</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">currentTestBase</span><span class="p">)</span>
+
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">"</span><span class="se">\n\n</span><span class="s2">"</span> <span class="o">+</span> <span class="n">_</span><span class="p">(</span><span class="s2">"=== STARTING TESTS</span><span class="se">\n</span><span class="s2">"</span><span class="p">))</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">currentDir</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">tmp_working_dir</span><span class="p">,</span> <span class="s1">'BASES'</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">currentTestBase</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">run_testbase_tests</span><span class="p">()</span>
<span class="c1"># calculate total execution time</span>
<span class="n">totalTime</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">now</span><span class="p">()</span> <span class="o">-</span> <span class="n">initTime</span>
<span class="n">totalTime</span> <span class="o">-=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">timedelta</span><span class="p">(</span><span class="n">microseconds</span><span class="o">=</span><span class="n">totalTime</span><span class="o">.</span><span class="n">microseconds</span><span class="p">)</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">src</span><span class="o">.</span><span class="n">printcolors</span><span class="o">.</span><span class="n">printcHeader</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s2">"=== END TESTS"</span><span class="p">)),</span> <span class="mi">2</span><span class="p">)</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">" </span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span> <span class="n">src</span><span class="o">.</span><span class="n">printcolors</span><span class="o">.</span><span class="n">printcInfo</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">totalTime</span><span class="p">)),</span>
- <span class="mi">2</span><span class="p">,</span>
- <span class="kc">False</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">"</span><span class="se">\n\n</span><span class="s2">"</span> <span class="o">+</span> <span class="n">_</span><span class="p">(</span><span class="s2">"=== END TESTS </span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span> <span class="o">%</span> <span class="nb">str</span><span class="p">(</span><span class="n">totalTime</span><span class="p">))</span>
- <span class="c1">#</span>
<span class="c1"># Start the tests</span>
- <span class="c1">#</span>
<span class="bp">self</span><span class="o">.</span><span class="n">run_script</span><span class="p">(</span><span class="s1">'test_cleanup'</span><span class="p">)</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span>
<span class="c1"># evaluate results</span>
- <span class="n">res_count</span> <span class="o">=</span> <span class="s2">"</span><span class="si">%d</span><span class="s2"> / </span><span class="si">%d</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">nb_succeed</span><span class="p">,</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">nb_run</span> <span class="o">-</span> <span class="bp">self</span><span class="o">.</span><span class="n">nb_acknoledge</span><span class="p">)</span>
-
- <span class="n">res_out</span> <span class="o">=</span> <span class="n">_</span><span class="p">(</span><span class="s2">"Tests Results: </span><span class="si">%(succeed)d</span><span class="s2"> / </span><span class="si">%(total)d</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span> <span class="o">%</span> \
- <span class="p">{</span> <span class="s1">'succeed'</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">nb_succeed</span><span class="p">,</span> <span class="s1">'total'</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">nb_run</span> <span class="p">}</span>
+ <span class="n">res_count</span> <span class="o">=</span> <span class="s2">"(</span><span class="si">%d</span><span class="s2">/</span><span class="si">%d</span><span class="s2">)"</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">nb_succeed</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">nb_run</span> <span class="o">-</span> <span class="bp">self</span><span class="o">.</span><span class="n">nb_acknoledge</span><span class="p">)</span>
+ <span class="n">res_out</span> <span class="o">=</span> <span class="n">_</span><span class="p">(</span><span class="s2">"Tests Results: (</span><span class="si">%d</span><span class="s2">/</span><span class="si">%d</span><span class="s2">)</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">nb_succeed</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">nb_run</span><span class="p">)</span>
+
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">nb_succeed</span> <span class="o">==</span> <span class="bp">self</span><span class="o">.</span><span class="n">nb_run</span><span class="p">:</span>
- <span class="n">res_out</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">printcolors</span><span class="o">.</span><span class="n">printcSuccess</span><span class="p">(</span><span class="n">res_out</span><span class="p">)</span>
+ <span class="n">res_out</span> <span class="o">=</span> <span class="n">UTS</span><span class="o">.</span><span class="n">green</span><span class="p">(</span><span class="n">res_out</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
- <span class="n">res_out</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">printcolors</span><span class="o">.</span><span class="n">printcError</span><span class="p">(</span><span class="n">res_out</span><span class="p">)</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">res_out</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
+ <span class="n">res_out</span> <span class="o">=</span> <span class="n">UTS</span><span class="o">.</span><span class="n">red</span><span class="p">(</span><span class="n">res_out</span><span class="p">)</span>
+
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="n">res_out</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">nb_timeout</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s2">"</span><span class="si">%d</span><span class="s2"> tests TIMEOUT</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">nb_timeout</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s2">"</span><span class="si">%d</span><span class="s2"> tests TIMEOUT</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">nb_timeout</span><span class="p">)</span>
<span class="n">res_count</span> <span class="o">+=</span> <span class="s2">" TO: </span><span class="si">%d</span><span class="s2">"</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">nb_timeout</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">nb_not_run</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s2">"</span><span class="si">%d</span><span class="s2"> tests not executed</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">nb_not_run</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s2">"</span><span class="si">%d</span><span class="s2"> tests not executed</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">nb_not_run</span><span class="p">)</span>
<span class="n">res_count</span> <span class="o">+=</span> <span class="s2">" NR: </span><span class="si">%d</span><span class="s2">"</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">nb_not_run</span>
- <span class="n">status</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">OK_STATUS</span>
+ <span class="n">status</span> <span class="o">=</span> <span class="s2">"<OK>"</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">nb_run</span> <span class="o">-</span> <span class="bp">self</span><span class="o">.</span><span class="n">nb_succeed</span> <span class="o">-</span> <span class="bp">self</span><span class="o">.</span><span class="n">nb_acknoledge</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span>
- <span class="n">status</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">KO_STATUS</span>
+ <span class="n">status</span> <span class="o">=</span> <span class="s2">"<KO>"</span>
<span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">nb_acknoledge</span><span class="p">:</span>
- <span class="n">status</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">KNOWNFAILURE_STATUS</span>
+ <span class="n">status</span> <span class="o">=</span> <span class="n">UTS</span><span class="o">.</span><span class="n">green</span><span class="p">(</span><span class="s2">"KNOWN FAILURE"</span><span class="p">)</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s2">"Status: </span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span> <span class="n">status</span><span class="p">),</span> <span class="mi">3</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s2">"Status: </span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span> <span class="o">%</span> <span class="n">status</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">nb_run</span> <span class="o">-</span> <span class="bp">self</span><span class="o">.</span><span class="n">nb_succeed</span> <span class="o">-</span> <span class="bp">self</span><span class="o">.</span><span class="n">nb_acknoledge</span></div>
- <span class="c1">##</span>
<span class="c1"># Write margin to show test results.</span>
<div class="viewcode-block" id="Test.write_test_margin"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.test_module.Test.write_test_margin">[docs]</a> <span class="k">def</span> <span class="nf">write_test_margin</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">tab</span><span class="p">):</span>
+ <span class="sd">"""indent with '| ... +' to show test results."""</span>
<span class="k">if</span> <span class="n">tab</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">return</span> <span class="s2">""</span>
<span class="k">return</span> <span class="s2">"| "</span> <span class="o">*</span> <span class="p">(</span><span class="n">tab</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span> <span class="o">+</span> <span class="s2">"+ "</span></div></div>
</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" />
+ <div><input type="text" name="q" /></div>
+ <div><input type="submit" value="Go" /></div>
<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>
©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>
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.9</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
</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="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>src.utilsSat — 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">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+ <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/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="top" title="salomeTools 5.0.0dev documentation" href="../../index.html" />
+ <link rel="up" title="Module code" href="../index.html" />
+
+ <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+ </head>
+ <body role="document">
+
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <h1>Source code for src.utilsSat</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-2018 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">utilities for sat</span>
+<span class="sd">general useful simple methods</span>
+<span class="sd">all-in-one import srs.utilsSat as UTS</span>
+
+<span class="sd">usage:</span>
+<span class="sd">>> import srsc.utilsSat as UTS</span>
+<span class="sd">>> UTS.ensure_path_exists(path)</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">import</span> <span class="nn">datetime</span>
+<span class="kn">import</span> <span class="nn">re</span>
+<span class="kn">import</span> <span class="nn">tempfile</span>
+
+<span class="kn">import</span> <span class="nn">src.returnCode</span> <span class="k">as</span> <span class="nn">RCO</span>
+
+<span class="c1">##############################################################################</span>
+<span class="c1"># file system utilities</span>
+<span class="c1">##############################################################################</span>
+<div class="viewcode-block" id="ensure_path_exists"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.utilsSat.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="replace_in_file"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.utilsSat.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="k">with</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="k">as</span> <span class="n">f</span><span class="p">:</span>
+ <span class="n">contents</span> <span class="o">=</span> <span class="n">f</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>
+ <span class="n">shutil</span><span class="o">.</span><span class="n">move</span><span class="p">(</span><span class="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="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">filein</span><span class="p">,</span> <span class="s2">"w"</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
+ <span class="n">f</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">contents</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>
+
+<span class="c1">##############################################################################</span>
+<span class="c1"># Utils class to simplify path manipulations.</span>
+<span class="c1">##############################################################################</span>
+<div class="viewcode-block" id="Path"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.utilsSat.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.utilsSat.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.utilsSat.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.utilsSat.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.utilsSat.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.utilsSat.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.utilsSat.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.utilsSat.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.utilsSat.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.utilsSat.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.utilsSat.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.utilsSat.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.utilsSat.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.utilsSat.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.utilsSat.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.utilsSat.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.utilsSat.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.utilsSat.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.utilsSat.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">"""Find in all the directories in lpath list the file that has the same name</span>
+<span class="sd"> as file_name. If it is found, return the full path of the file, else,</span>
+<span class="sd"> return False. </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.utilsSat.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>
+
+<span class="c1">##############################################################################</span>
+<span class="c1"># pyconf config utilities</span>
+<span class="c1">##############################################################################</span>
+<div class="viewcode-block" id="check_config_has_application"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.utilsSat.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="ne">Exception</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.utilsSat.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">'''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="ne">Exception</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.utilsSat.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.utilsSat.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">'''Search for param_name value in config.</span>
+<span class="sd"> If param_name is not in config, 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="get_base_path"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.utilsSat.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">'''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="p">)</span> <span class="o">%</span> <span class="n">local_file_path</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="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.utilsSat.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">'''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.utilsSat.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">'''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="p">)</span> <span class="o">%</span> <span class="n">local_file_path</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="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.utilsSat.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.utilsSat.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.utilsSat.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="ne">Exception</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="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.utilsSat.get_tmp_filename">[docs]</a><span class="k">def</span> <span class="nf">get_tmp_filename</span><span class="p">(</span><span class="n">config</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">config</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">config</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">config</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>
+
+<div class="viewcode-block" id="get_property_in_product_cfg"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.utilsSat.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>
+
+<span class="c1">##############################################################################</span>
+<span class="c1"># logger and color utilities</span>
+<span class="c1">##############################################################################</span>
+<div class="viewcode-block" id="formatTuples"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.utilsSat.formatTuples">[docs]</a><span class="k">def</span> <span class="nf">formatTuples</span><span class="p">(</span><span class="n">tuples</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> format 'label = value' the tuples in a tabulated way.</span>
+<span class="sd"> </span>
+<span class="sd"> :param tuples list: The list of tuples to format</span>
+<span class="sd"> :return: The tabulated text. (mutiples lines)</span>
+<span class="sd"> """</span>
+ <span class="c1"># find the maximum length of the first value of the tuples</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">tuples</span><span class="p">))</span>
+ <span class="c1"># Print each item of tuples with good indentation</span>
+ <span class="n">msg</span> <span class="o">=</span> <span class="s2">""</span>
+ <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="n">tuples</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">msg</span> <span class="o">+=</span> <span class="n">sp</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="se">\n</span><span class="s2">"</span> <span class="o">%</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">i</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span> <span class="c1"># tuples, may be longer</span>
+ <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">tuples</span><span class="p">)</span> <span class="o">></span> <span class="mi">1</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="c1"># for long list</span>
+ <span class="k">return</span> <span class="n">msg</span></div>
+
+<div class="viewcode-block" id="formatValue"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.utilsSat.formatValue">[docs]</a><span class="k">def</span> <span class="nf">formatValue</span><span class="p">(</span><span class="n">label</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">suffix</span><span class="o">=</span><span class="s2">""</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> format 'label = value' with the info color</span>
+<span class="sd"> </span>
+<span class="sd"> :param label int: the label to print.</span>
+<span class="sd"> :param value str: the value to print.</span>
+<span class="sd"> :param suffix str: the optionnal suffix to add at the end.</span>
+<span class="sd"> """</span>
+ <span class="n">msg</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="o">%</span> <span class="p">(</span><span class="n">label</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">suffix</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">msg</span></div>
+
+<div class="viewcode-block" id="logger_info_tuples"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.utilsSat.logger_info_tuples">[docs]</a><span class="k">def</span> <span class="nf">logger_info_tuples</span><span class="p">(</span><span class="n">logger</span><span class="p">,</span> <span class="n">tuples</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> for convenience</span>
+<span class="sd"> format as formatTuples() and call logger.info()</span>
+<span class="sd"> """</span>
+ <span class="n">msg</span> <span class="o">=</span> <span class="n">formatTuples</span><span class="p">(</span><span class="n">tuples</span><span class="p">)</span>
+ <span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span></div>
+
+<span class="c1"># for convenience </span>
+<span class="n">_colors</span> <span class="o">=</span> <span class="s2">"BLACK RED GREEN YELLOW BLUE MAGENTA CYAN WHITE"</span><span class="o">.</span><span class="n">lower</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>
+
+<div class="viewcode-block" id="black"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.utilsSat.black">[docs]</a><span class="k">def</span> <span class="nf">black</span><span class="p">(</span><span class="n">msg</span><span class="p">):</span>
+ <span class="k">return</span> <span class="s2">"<black>"</span><span class="o">+</span><span class="n">msg</span><span class="o">+</span><span class="s2">"<reset>"</span></div>
+
+<div class="viewcode-block" id="red"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.utilsSat.red">[docs]</a><span class="k">def</span> <span class="nf">red</span><span class="p">(</span><span class="n">msg</span><span class="p">):</span>
+ <span class="k">return</span> <span class="s2">"<red>"</span><span class="o">+</span><span class="n">msg</span><span class="o">+</span><span class="s2">"<reset>"</span></div>
+
+<div class="viewcode-block" id="green"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.utilsSat.green">[docs]</a><span class="k">def</span> <span class="nf">green</span><span class="p">(</span><span class="n">msg</span><span class="p">):</span>
+ <span class="k">return</span> <span class="s2">"<green>"</span><span class="o">+</span><span class="n">msg</span><span class="o">+</span><span class="s2">"<reset>"</span></div>
+
+<div class="viewcode-block" id="yellow"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.utilsSat.yellow">[docs]</a><span class="k">def</span> <span class="nf">yellow</span><span class="p">(</span><span class="n">msg</span><span class="p">):</span>
+ <span class="k">return</span> <span class="s2">"<yellow>"</span><span class="o">+</span><span class="n">msg</span><span class="o">+</span><span class="s2">"<reset>"</span></div>
+
+<div class="viewcode-block" id="blue"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.utilsSat.blue">[docs]</a><span class="k">def</span> <span class="nf">blue</span><span class="p">(</span><span class="n">msg</span><span class="p">):</span>
+ <span class="k">return</span> <span class="s2">"<blue>"</span><span class="o">+</span><span class="n">msg</span><span class="o">+</span><span class="s2">"<reset>"</span></div>
+
+<div class="viewcode-block" id="magenta"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.utilsSat.magenta">[docs]</a><span class="k">def</span> <span class="nf">magenta</span><span class="p">(</span><span class="n">msg</span><span class="p">):</span>
+ <span class="k">return</span> <span class="s2">"<magenta>"</span><span class="o">+</span><span class="n">msg</span><span class="o">+</span><span class="s2">"<reset>"</span></div>
+
+<div class="viewcode-block" id="cyan"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.utilsSat.cyan">[docs]</a><span class="k">def</span> <span class="nf">cyan</span><span class="p">(</span><span class="n">msg</span><span class="p">):</span>
+ <span class="k">return</span> <span class="s2">"<cyan>"</span><span class="o">+</span><span class="n">msg</span><span class="o">+</span><span class="s2">"<reset>"</span></div>
+
+<div class="viewcode-block" id="white"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.utilsSat.white">[docs]</a><span class="k">def</span> <span class="nf">white</span><span class="p">(</span><span class="n">msg</span><span class="p">):</span>
+ <span class="k">return</span> <span class="s2">"<white>"</span><span class="o">+</span><span class="n">msg</span><span class="o">+</span><span class="s2">"<reset>"</span></div>
+
+<div class="viewcode-block" id="normal"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.utilsSat.normal">[docs]</a><span class="k">def</span> <span class="nf">normal</span><span class="p">(</span><span class="n">msg</span><span class="p">):</span>
+ <span class="k">return</span> <span class="s2">"<normal>"</span><span class="o">+</span><span class="n">msg</span><span class="o">+</span><span class="s2">"<reset>"</span></div>
+
+<div class="viewcode-block" id="reset"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.utilsSat.reset">[docs]</a><span class="k">def</span> <span class="nf">reset</span><span class="p">(</span><span class="n">msg</span><span class="p">):</span>
+ <span class="k">return</span> <span class="s2">"<reset>"</span><span class="o">+</span><span class="n">msg</span></div>
+
+<div class="viewcode-block" id="info"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.utilsSat.info">[docs]</a><span class="k">def</span> <span class="nf">info</span><span class="p">(</span><span class="n">msg</span><span class="p">):</span>
+ <span class="k">return</span> <span class="s2">"<info>"</span><span class="o">+</span><span class="n">msg</span><span class="o">+</span><span class="s2">"<reset>"</span></div>
+
+<div class="viewcode-block" id="header"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.utilsSat.header">[docs]</a><span class="k">def</span> <span class="nf">header</span><span class="p">(</span><span class="n">msg</span><span class="p">):</span>
+ <span class="k">return</span> <span class="s2">"<info>"</span><span class="o">+</span><span class="n">msg</span><span class="o">+</span><span class="s2">"<reset>"</span></div>
+
+<div class="viewcode-block" id="label"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.utilsSat.label">[docs]</a><span class="k">def</span> <span class="nf">label</span><span class="p">(</span><span class="n">msg</span><span class="p">):</span>
+ <span class="k">return</span> <span class="s2">"<label>"</span><span class="o">+</span><span class="n">msg</span><span class="o">+</span><span class="s2">"<reset>"</span></div>
+
+<div class="viewcode-block" id="success"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.utilsSat.success">[docs]</a><span class="k">def</span> <span class="nf">success</span><span class="p">(</span><span class="n">msg</span><span class="p">):</span>
+ <span class="k">return</span> <span class="s2">"<success>"</span><span class="o">+</span><span class="n">msg</span><span class="o">+</span><span class="s2">"<reset>"</span></div>
+
+<div class="viewcode-block" id="warning"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.utilsSat.warning">[docs]</a><span class="k">def</span> <span class="nf">warning</span><span class="p">(</span><span class="n">msg</span><span class="p">):</span>
+ <span class="k">return</span> <span class="s2">"<warning>"</span><span class="o">+</span><span class="n">msg</span><span class="o">+</span><span class="s2">"<reset>"</span></div>
+
+<div class="viewcode-block" id="error"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.utilsSat.error">[docs]</a><span class="k">def</span> <span class="nf">error</span><span class="p">(</span><span class="n">msg</span><span class="p">):</span>
+ <span class="k">return</span> <span class="s2">"<error>"</span><span class="o">+</span><span class="n">msg</span><span class="o">+</span><span class="s2">"<reset>"</span></div>
+
+<div class="viewcode-block" id="critical"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.utilsSat.critical">[docs]</a><span class="k">def</span> <span class="nf">critical</span><span class="p">(</span><span class="n">msg</span><span class="p">):</span>
+ <span class="k">return</span> <span class="s2">"<critical>"</span><span class="o">+</span><span class="n">msg</span><span class="o">+</span><span class="s2">"<reset>"</span></div>
+
+
+<span class="c1">##############################################################################</span>
+<span class="c1"># list and dict utilities</span>
+<span class="c1">##############################################################################</span>
+<div class="viewcode-block" id="deepcopy_list"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.utilsSat.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">""" 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.utilsSat.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">""" 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="merge_dicts"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.utilsSat.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>
+
+
+<span class="c1">##############################################################################</span>
+<span class="c1"># date utilities</span>
+<span class="c1">##############################################################################</span>
+<div class="viewcode-block" id="parse_date"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.utilsSat.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">"""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>
+
+
+<span class="c1">##############################################################################</span>
+<span class="c1"># log utilities (TODO: set in loggingSat class, later, changing tricky xml ?</span>
+<span class="c1">##############################################################################</span>
+
+
+<div class="viewcode-block" id="date_to_datetime"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.utilsSat.date_to_datetime">[docs]</a><span class="k">def</span> <span class="nf">date_to_datetime</span><span class="p">(</span><span class="n">date</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> From a string date in format YYYYMMDD_HHMMSS</span>
+<span class="sd"> returns list year, mon, day, hour, minutes, seconds </span>
+<span class="sd"> </span>
+<span class="sd"> :param date str: The date in format YYYYMMDD_HHMMSS</span>
+<span class="sd"> :return: the same date and time in separate variables.</span>
+<span class="sd"> :rtype: (str,str,str,str,str,str)</span>
+<span class="sd"> """</span>
+ <span class="n">Y</span> <span class="o">=</span> <span class="n">date</span><span class="p">[:</span><span class="mi">4</span><span class="p">]</span>
+ <span class="n">m</span> <span class="o">=</span> <span class="n">date</span><span class="p">[</span><span class="mi">4</span><span class="p">:</span><span class="mi">6</span><span class="p">]</span>
+ <span class="n">dd</span> <span class="o">=</span> <span class="n">date</span><span class="p">[</span><span class="mi">6</span><span class="p">:</span><span class="mi">8</span><span class="p">]</span>
+ <span class="n">H</span> <span class="o">=</span> <span class="n">date</span><span class="p">[</span><span class="mi">9</span><span class="p">:</span><span class="mi">11</span><span class="p">]</span>
+ <span class="n">M</span> <span class="o">=</span> <span class="n">date</span><span class="p">[</span><span class="mi">11</span><span class="p">:</span><span class="mi">13</span><span class="p">]</span>
+ <span class="n">S</span> <span class="o">=</span> <span class="n">date</span><span class="p">[</span><span class="mi">13</span><span class="p">:</span><span class="mi">15</span><span class="p">]</span>
+ <span class="k">return</span> <span class="n">Y</span><span class="p">,</span> <span class="n">m</span><span class="p">,</span> <span class="n">dd</span><span class="p">,</span> <span class="n">H</span><span class="p">,</span> <span class="n">M</span><span class="p">,</span> <span class="n">S</span></div>
+
+<div class="viewcode-block" id="timedelta_total_seconds"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.utilsSat.timedelta_total_seconds">[docs]</a><span class="k">def</span> <span class="nf">timedelta_total_seconds</span><span class="p">(</span><span class="n">timedelta</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Replace total_seconds from datetime module </span>
+<span class="sd"> in order to be compatible with old python versions</span>
+<span class="sd"> </span>
+<span class="sd"> :param timedelta datetime.timedelta: The delta between two dates</span>
+<span class="sd"> :return: The number of seconds corresponding to timedelta.</span>
+<span class="sd"> :rtype: float</span>
+<span class="sd"> """</span>
+ <span class="k">return</span> <span class="p">(</span>
+ <span class="n">timedelta</span><span class="o">.</span><span class="n">microseconds</span> <span class="o">+</span> <span class="mf">0.0</span> <span class="o">+</span>
+ <span class="p">(</span><span class="n">timedelta</span><span class="o">.</span><span class="n">seconds</span> <span class="o">+</span> <span class="n">timedelta</span><span class="o">.</span><span class="n">days</span> <span class="o">*</span> <span class="mi">24</span> <span class="o">*</span> <span class="mi">3600</span><span class="p">)</span> <span class="o">*</span> <span class="mi">10</span> <span class="o">**</span> <span class="mi">6</span><span class="p">)</span> <span class="o">/</span> <span class="mi">10</span> <span class="o">**</span> <span class="mi">6</span></div>
+
+<span class="n">_log_macro_command_file_expression</span> <span class="o">=</span> <span class="s2">"^[0-9]</span><span class="si">{8}</span><span class="s2">_+[0-9]</span><span class="si">{6}</span><span class="s2">_+.*\.xml$"</span>
+<span class="n">_log_all_command_file_expression</span> <span class="o">=</span> <span class="s2">"^.*[0-9]</span><span class="si">{8}</span><span class="s2">_+[0-9]</span><span class="si">{6}</span><span class="s2">_+.*\.xml$"</span>
+
+<div class="viewcode-block" id="show_command_log"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.utilsSat.show_command_log">[docs]</a><span class="k">def</span> <span class="nf">show_command_log</span><span class="p">(</span><span class="n">logFilePath</span><span class="p">,</span> <span class="n">cmd</span><span class="p">,</span> <span class="n">application</span><span class="p">,</span> <span class="n">notShownCommands</span><span class="p">):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Used in updateHatXml. </span>
+<span class="sd"> Determine if the log xml file logFilePath </span>
+<span class="sd"> has to be shown or not in the hat log.</span>
+<span class="sd"> </span>
+<span class="sd"> :param logFilePath str: the path to the command xml log file</span>
+<span class="sd"> :param cmd str: the command of the log file</span>
+<span class="sd"> :param application str: the application passed as parameter </span>
+<span class="sd"> to the salomeTools command</span>
+<span class="sd"> :param notShownCommands list: the list of commands </span>
+<span class="sd"> that are not shown by default</span>
+<span class="sd"> </span>
+<span class="sd"> :return: RCO.ReturnCode("OK") if cmd is not in notShownCommands and the application </span>
+<span class="sd"> in the log file corresponds to application</span>
+<span class="sd"> ReturnCode value is tuple (appliLog, launched_cmd)</span>
+<span class="sd"> """</span>
+ <span class="c1"># When the command is not in notShownCommands, no need to go further :</span>
+ <span class="c1"># Do not show</span>
+
+ <span class="kn">import</span> <span class="nn">src.xmlManager</span> <span class="k">as</span> <span class="nn">XMLMGR</span> <span class="c1"># avoid import cross utilsSat</span>
+
+ <span class="k">if</span> <span class="n">cmd</span> <span class="ow">in</span> <span class="n">notShownCommands</span><span class="p">:</span>
+ <span class="k">return</span> <span class="n">RCO</span><span class="o">.</span><span class="n">ReturnCode</span><span class="p">(</span><span class="s2">"KO"</span><span class="p">,</span> <span class="s2">"in notShownCommands"</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
+
+ <span class="c1"># Get the application of the log file</span>
+ <span class="k">if</span> <span class="kc">True</span><span class="p">:</span> <span class="c1">#try:</span>
+ <span class="n">logFileXml</span> <span class="o">=</span> <span class="n">XMLMGR</span><span class="o">.</span><span class="n">ReadXmlFile</span><span class="p">(</span><span class="n">logFilePath</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span> <span class="c1">#except Exception as e:</span>
+ <span class="n">msg</span> <span class="o">=</span> <span class="n">_</span><span class="p">(</span><span class="s2">"The log file '</span><span class="si">%s</span><span class="s2">' cannot be read:"</span> <span class="o">%</span> <span class="n">logFilePath</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">RCO</span><span class="o">.</span><span class="n">ReturnCode</span><span class="p">(</span><span class="s2">"KO"</span><span class="p">,</span> <span class="n">msg</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
+
+ <span class="k">if</span> <span class="s1">'application'</span> <span class="ow">in</span> <span class="n">logFileXml</span><span class="o">.</span><span class="n">xmlroot</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
+ <span class="n">appliLog</span> <span class="o">=</span> <span class="n">logFileXml</span><span class="o">.</span><span class="n">xmlroot</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'application'</span><span class="p">)</span>
+ <span class="n">launched_cmd</span> <span class="o">=</span> <span class="n">logFileXml</span><span class="o">.</span><span class="n">xmlroot</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="s1">'Site'</span><span class="p">)</span><span class="o">.</span><span class="n">attrib</span><span class="p">[</span><span class="s1">'launchedCommand'</span><span class="p">]</span>
+ <span class="c1"># if it corresponds, then the log has to be shown</span>
+ <span class="k">if</span> <span class="n">appliLog</span> <span class="o">==</span> <span class="n">application</span><span class="p">:</span>
+ <span class="k">return</span> <span class="n">RCO</span><span class="o">.</span><span class="n">ReturnCode</span><span class="p">(</span><span class="s2">"OK"</span><span class="p">,</span> <span class="s2">"appliLog == application"</span><span class="p">,</span> <span class="p">(</span><span class="n">appliLog</span><span class="p">,</span> <span class="n">launched_cmd</span><span class="p">))</span>
+ <span class="k">elif</span> <span class="n">application</span> <span class="o">!=</span> <span class="s1">'None'</span><span class="p">:</span>
+ <span class="k">return</span> <span class="n">RCO</span><span class="o">.</span><span class="n">ReturnCode</span><span class="p">(</span><span class="s2">"KO"</span><span class="p">,</span> <span class="s2">"application != 'None'"</span><span class="p">,</span> <span class="p">(</span><span class="n">appliLog</span><span class="p">,</span> <span class="n">launched_cmd</span><span class="p">))</span>
+
+ <span class="k">return</span> <span class="n">RCO</span><span class="o">.</span><span class="n">ReturnCode</span><span class="p">(</span><span class="s2">"OK"</span><span class="p">,</span> <span class="s2">""</span><span class="p">,</span> <span class="p">(</span><span class="n">appliLog</span><span class="p">,</span> <span class="n">launched_cmd</span><span class="p">))</span>
+
+ <span class="k">if</span> <span class="n">application</span> <span class="o">==</span> <span class="s1">'None'</span><span class="p">:</span>
+ <span class="k">return</span> <span class="n">RCO</span><span class="o">.</span><span class="n">ReturnCode</span><span class="p">(</span><span class="s2">"OK"</span><span class="p">,</span> <span class="s2">"application == 'None'"</span><span class="p">,</span> <span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">))</span>
+
+ <span class="k">return</span> <span class="n">RCO</span><span class="o">.</span><span class="n">ReturnCode</span><span class="p">(</span><span class="s2">"KO"</span><span class="p">,</span> <span class="s2">""</span><span class="p">,</span> <span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">))</span></div>
+
+<div class="viewcode-block" id="list_log_file"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.utilsSat.list_log_file">[docs]</a><span class="k">def</span> <span class="nf">list_log_file</span><span class="p">(</span><span class="n">dirPath</span><span class="p">,</span> <span class="n">expression</span><span class="p">):</span>
+ <span class="sd">"""Find all files corresponding to expression in dirPath</span>
+<span class="sd"> </span>
+<span class="sd"> :param dirPath str: the directory where to search the files</span>
+<span class="sd"> :param expression str: the regular expression of files to find</span>
+<span class="sd"> :return: the list of files path and informations about it</span>
+<span class="sd"> :rtype: list</span>
+<span class="sd"> """</span>
+ <span class="n">lRes</span> <span class="o">=</span> <span class="p">[]</span>
+ <span class="k">for</span> <span class="n">fileName</span> <span class="ow">in</span> <span class="n">os</span><span class="o">.</span><span class="n">listdir</span><span class="p">(</span><span class="n">dirPath</span><span class="p">):</span>
+ <span class="c1"># YYYYMMDD_HHMMSS_namecmd.xml</span>
+ <span class="n">sExpr</span> <span class="o">=</span> <span class="n">expression</span>
+ <span class="n">oExpr</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="n">sExpr</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">oExpr</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">fileName</span><span class="p">):</span>
+ <span class="n">file_name</span> <span class="o">=</span> <span class="n">fileName</span>
+ <span class="k">if</span> <span class="n">fileName</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s2">"micro_"</span><span class="p">):</span>
+ <span class="n">file_name</span> <span class="o">=</span> <span class="n">fileName</span><span class="p">[</span><span class="nb">len</span><span class="p">(</span><span class="s2">"micro_"</span><span class="p">):]</span>
+ <span class="c1"># get date and hour and format it</span>
+ <span class="n">date_hour_cmd_host</span> <span class="o">=</span> <span class="n">file_name</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">'_'</span><span class="p">)</span>
+ <span class="n">date_not_formated</span> <span class="o">=</span> <span class="n">date_hour_cmd_host</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
+ <span class="n">date</span> <span class="o">=</span> <span class="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_not_formated</span><span class="p">[</span><span class="mi">6</span><span class="p">:</span><span class="mi">8</span><span class="p">],</span>
+ <span class="n">date_not_formated</span><span class="p">[</span><span class="mi">4</span><span class="p">:</span><span class="mi">6</span><span class="p">],</span>
+ <span class="n">date_not_formated</span><span class="p">[</span><span class="mi">0</span><span class="p">:</span><span class="mi">4</span><span class="p">])</span>
+ <span class="n">hour_not_formated</span> <span class="o">=</span> <span class="n">date_hour_cmd_host</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
+ <span class="n">hour</span> <span class="o">=</span> <span class="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">hour_not_formated</span><span class="p">[</span><span class="mi">0</span><span class="p">:</span><span class="mi">2</span><span class="p">],</span>
+ <span class="n">hour_not_formated</span><span class="p">[</span><span class="mi">2</span><span class="p">:</span><span class="mi">4</span><span class="p">],</span>
+ <span class="n">hour_not_formated</span><span class="p">[</span><span class="mi">4</span><span class="p">:</span><span class="mi">6</span><span class="p">])</span>
+ <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">date_hour_cmd_host</span><span class="p">)</span> <span class="o"><</span> <span class="mi">4</span><span class="p">:</span>
+ <span class="n">cmd</span> <span class="o">=</span> <span class="n">date_hour_cmd_host</span><span class="p">[</span><span class="mi">2</span><span class="p">][:</span><span class="o">-</span><span class="nb">len</span><span class="p">(</span><span class="s1">'.xml'</span><span class="p">)]</span>
+ <span class="n">host</span> <span class="o">=</span> <span class="s2">""</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">cmd</span> <span class="o">=</span> <span class="n">date_hour_cmd_host</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span>
+ <span class="n">host</span> <span class="o">=</span> <span class="n">date_hour_cmd_host</span><span class="p">[</span><span class="mi">3</span><span class="p">][:</span><span class="o">-</span><span class="nb">len</span><span class="p">(</span><span class="s1">'.xml'</span><span class="p">)]</span>
+ <span class="n">lRes</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">dirPath</span><span class="p">,</span> <span class="n">fileName</span><span class="p">),</span>
+ <span class="n">date_not_formated</span><span class="p">,</span>
+ <span class="n">date</span><span class="p">,</span>
+ <span class="n">hour_not_formated</span><span class="p">,</span>
+ <span class="n">hour</span><span class="p">,</span>
+ <span class="n">cmd</span><span class="p">,</span>
+ <span class="n">host</span><span class="p">))</span>
+ <span class="k">return</span> <span class="n">lRes</span></div>
+
+<div class="viewcode-block" id="update_hat_xml"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.utilsSat.update_hat_xml">[docs]</a><span class="k">def</span> <span class="nf">update_hat_xml</span><span class="p">(</span><span class="n">logDir</span><span class="p">,</span> <span class="n">application</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">notShownCommands</span> <span class="o">=</span> <span class="p">[]):</span>
+ <span class="sd">"""\</span>
+<span class="sd"> Create the xml file in logDir that contain all the xml file </span>
+<span class="sd"> and have a name like YYYYMMDD_HHMMSS_namecmd.xml</span>
+<span class="sd"> </span>
+<span class="sd"> :param logDir str: the directory to parse</span>
+<span class="sd"> :param application str: the name of the application if there is any</span>
+<span class="sd"> """</span>
+ <span class="c1"># Create an instance of XmlLogFile class to create hat.xml file</span>
+
+ <span class="kn">import</span> <span class="nn">src.xmlManager</span> <span class="k">as</span> <span class="nn">XMLMGR</span> <span class="c1"># avoid import cross utilsSat </span>
+
+ <span class="n">xmlHatFilePath</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">logDir</span><span class="p">,</span> <span class="s1">'hat.xml'</span><span class="p">)</span>
+ <span class="n">xmlHat</span> <span class="o">=</span> <span class="n">XMLMGR</span><span class="o">.</span><span class="n">XmlLogFile</span><span class="p">(</span><span class="n">xmlHatFilePath</span><span class="p">,</span> <span class="s2">"LOGlist"</span><span class="p">,</span> <span class="p">{</span><span class="s2">"application"</span> <span class="p">:</span> <span class="n">application</span><span class="p">})</span>
+ <span class="c1"># parse the log directory to find all the command logs, </span>
+ <span class="c1"># then add it to the xml file</span>
+ <span class="n">lLogFile</span> <span class="o">=</span> <span class="n">list_log_file</span><span class="p">(</span><span class="n">logDir</span><span class="p">,</span> <span class="n">_log_macro_command_file_expression</span><span class="p">)</span>
+ <span class="k">for</span> <span class="n">filePath</span><span class="p">,</span> <span class="n">__</span><span class="p">,</span> <span class="n">date</span><span class="p">,</span> <span class="n">__</span><span class="p">,</span> <span class="n">hour</span><span class="p">,</span> <span class="n">cmd</span><span class="p">,</span> <span class="n">__</span> <span class="ow">in</span> <span class="n">lLogFile</span><span class="p">:</span>
+ <span class="n">showLog</span><span class="p">,</span> <span class="n">cmdAppli</span><span class="p">,</span> <span class="n">full_cmd</span> <span class="o">=</span> <span class="n">show_command_log</span><span class="p">(</span><span class="n">filePath</span><span class="p">,</span> <span class="n">cmd</span><span class="p">,</span>
+ <span class="n">application</span><span class="p">,</span> <span class="n">notShownCommands</span><span class="p">)</span>
+ <span class="c1">#if cmd not in notShownCommands:</span>
+ <span class="k">if</span> <span class="n">showLog</span><span class="p">:</span>
+ <span class="c1"># add a node to the hat.xml file</span>
+ <span class="n">xmlHat</span><span class="o">.</span><span class="n">add_simple_node</span><span class="p">(</span><span class="s2">"LogCommand"</span><span class="p">,</span>
+ <span class="n">text</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">basename</span><span class="p">(</span><span class="n">filePath</span><span class="p">),</span>
+ <span class="n">attrib</span> <span class="o">=</span> <span class="p">{</span><span class="s2">"date"</span> <span class="p">:</span> <span class="n">date</span><span class="p">,</span>
+ <span class="s2">"hour"</span> <span class="p">:</span> <span class="n">hour</span><span class="p">,</span>
+ <span class="s2">"cmd"</span> <span class="p">:</span> <span class="n">cmd</span><span class="p">,</span>
+ <span class="s2">"application"</span> <span class="p">:</span> <span class="n">cmdAppli</span><span class="p">,</span>
+ <span class="s2">"full_command"</span> <span class="p">:</span> <span class="n">full_cmd</span><span class="p">})</span>
+
+ <span class="c1"># Write the file on the hard drive</span>
+ <span class="n">xmlHat</span><span class="o">.</span><span class="n">write_tree</span><span class="p">(</span><span class="s1">'hat.xsl'</span><span class="p">)</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>
+ <form class="search" action="../../search.html" method="get">
+ <div><input type="text" name="q" /></div>
+ <div><input type="submit" value="Go" /></div>
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</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.4.9</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
+
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
-
<!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.xmlManager — salomeTools 5.0.0dev documentation</title>
+
<link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
- <script type="text/javascript" src="../../_static/documentation_options.js"></script>
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
- <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/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="top" title="salomeTools 5.0.0dev documentation" href="../../index.html" />
+ <link rel="up" title="Module code" href="../index.html" />
<link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
- </head><body>
+ </head>
+ <body role="document">
<div class="document">
<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">"""Utilities to read xml logging files</span>
+
+<span class="sd">usage:</span>
+<span class="sd"> >> import src.xmlManager as XMLMGR</span>
+<span class="sd">"""</span>
+
<span class="kn">import</span> <span class="nn">os</span>
<span class="k">try</span><span class="p">:</span> <span class="c1"># For python2</span>
<span class="kn">import</span> <span class="nn">sys</span>
<span class="k">except</span><span class="p">:</span>
<span class="k">pass</span>
-<span class="kn">import</span> <span class="nn">src</span>
-<span class="kn">from</span> <span class="nn">.</span> <span class="k">import</span> <span class="n">ElementTree</span> <span class="k">as</span> <span class="n">etree</span>
+<span class="kn">import</span> <span class="nn">src.ElementTree</span> <span class="k">as</span> <span class="nn">etree</span>
+<span class="kn">import</span> <span class="nn">src.utilsSat</span> <span class="k">as</span> <span class="nn">UTS</span>
<div class="viewcode-block" id="XmlLogFile"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.xmlManager.XmlLogFile">[docs]</a><span class="k">class</span> <span class="nc">XmlLogFile</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">'''Class to manage writing in salomeTools xml log file</span>
<span class="c1"># Initialize the filePath and ensure that the directory </span>
<span class="c1"># that contain the file exists (make it if necessary)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">logFile</span> <span class="o">=</span> <span class="n">filePath</span>
- <span class="n">src</span><span class="o">.</span><span class="n">ensure_path_exists</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="n">filePath</span><span class="p">))</span>
+ <span class="n">UTS</span><span class="o">.</span><span class="n">ensure_path_exists</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="n">filePath</span><span class="p">))</span>
<span class="c1"># Initialize the field that contain the xml in memory</span>
<span class="bp">self</span><span class="o">.</span><span class="n">xmlroot</span> <span class="o">=</span> <span class="n">etree</span><span class="o">.</span><span class="n">Element</span><span class="p">(</span><span class="n">rootname</span><span class="p">,</span> <span class="n">attrib</span> <span class="o">=</span> <span class="n">attrib</span><span class="p">)</span>
</div>
<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" />
+ <div><input type="text" name="q" /></div>
+ <div><input type="submit" value="Go" /></div>
<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>
©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>
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.9</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
</div>
+++ /dev/null
-src
-===
-
-.. toctree::
- :maxdepth: 4
-
- src
--- /dev/null
+src
+===
+
+.. toctree::
+ :maxdepth: 4
+
+ src
+++ /dev/null
-colorama Package
-================
-
-:mod:`colorama` Package
------------------------
-
-.. automodule:: src.colorama
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`ansi` Module
-------------------
-
-.. automodule:: src.colorama.ansi
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`ansitowin32` Module
--------------------------
-
-.. automodule:: src.colorama.ansitowin32
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`initialise` Module
-------------------------
-
-.. automodule:: src.colorama.initialise
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`win32` Module
--------------------
-
-.. automodule:: src.colorama.win32
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`winterm` Module
----------------------
-
-.. automodule:: src.colorama.winterm
- :members:
- :undoc-members:
- :show-inheritance:
-
--- /dev/null
+src.colorama package
+====================
+
+Submodules
+----------
+
+src.colorama.ansi module
+------------------------
+
+.. automodule:: src.colorama.ansi
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+src.colorama.ansitowin32 module
+-------------------------------
+
+.. automodule:: src.colorama.ansitowin32
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+src.colorama.initialise module
+------------------------------
+
+.. automodule:: src.colorama.initialise
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+src.colorama.win32 module
+-------------------------
+
+.. automodule:: src.colorama.win32
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+src.colorama.winterm module
+---------------------------
+
+.. automodule:: src.colorama.winterm
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: src.colorama
+ :members:
+ :undoc-members:
+ :show-inheritance:
--- /dev/null
+src.example package
+===================
+
+Submodules
+----------
+
+src.example.essai_logging_1 module
+----------------------------------
+
+.. automodule:: src.example.essai_logging_1
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+src.example.essai_logging_2 module
+----------------------------------
+
+.. automodule:: src.example.essai_logging_2
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: src.example
+ :members:
+ :undoc-members:
+ :show-inheritance:
+++ /dev/null
-src Package
-===========
-
-:mod:`src` Package
-------------------
-
-.. automodule:: src.__init__
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`ElementTree` Module
--------------------------
-
-.. automodule:: src.ElementTree
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`architecture` Module
---------------------------
-
-.. automodule:: src.architecture
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`compilation` Module
--------------------------
-
-.. automodule:: src.compilation
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`debug` Module
--------------------
-
-.. automodule:: src.debug
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`environment` Module
--------------------------
-
-.. automodule:: src.environment
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`fileEnviron` Module
--------------------------
-
-.. automodule:: src.fileEnviron
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`fork` Module
-------------------
-
-.. automodule:: src.fork
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`logger` Module
---------------------
-
-.. automodule:: src.logger
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`options` Module
----------------------
-
-.. automodule:: src.options
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`printcolors` Module
--------------------------
-
-.. automodule:: src.printcolors
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`product` Module
----------------------
-
-.. automodule:: src.product
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`pyconf` Module
---------------------
-
-.. automodule:: src.pyconf
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`system` Module
---------------------
-
-.. automodule:: src.system
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`template` Module
-----------------------
-
-.. automodule:: src.template
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`test_module` Module
--------------------------
-
-.. automodule:: src.test_module
- :members:
- :undoc-members:
- :show-inheritance:
-
-:mod:`xmlManager` Module
-------------------------
-
-.. automodule:: src.xmlManager
- :members:
- :undoc-members:
- :show-inheritance:
-
-Subpackages
------------
-
-.. toctree::
-
- src.colorama
-
--- /dev/null
+src package
+===========
+
+Subpackages
+-----------
+
+.. toctree::
+
+ src.colorama
+ src.example
+
+Submodules
+----------
+
+src.ElementTree module
+----------------------
+
+.. automodule:: src.ElementTree
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+src.architecture module
+-----------------------
+
+.. automodule:: src.architecture
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+src.catchAll module
+-------------------
+
+.. automodule:: src.catchAll
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+src.coloringSat module
+----------------------
+
+.. automodule:: src.coloringSat
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+src.compilation module
+----------------------
+
+.. automodule:: src.compilation
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+src.configManager module
+------------------------
+
+.. automodule:: src.configManager
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+src.debug module
+----------------
+
+.. automodule:: src.debug
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+src.environment module
+----------------------
+
+.. automodule:: src.environment
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+src.environs module
+-------------------
+
+.. automodule:: src.environs
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+src.exceptionSat module
+-----------------------
+
+.. automodule:: src.exceptionSat
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+src.fileEnviron module
+----------------------
+
+.. automodule:: src.fileEnviron
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+src.fork module
+---------------
+
+.. automodule:: src.fork
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+src.loggingSat module
+---------------------
+
+.. automodule:: src.loggingSat
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+src.options module
+------------------
+
+.. automodule:: src.options
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+src.product module
+------------------
+
+.. automodule:: src.product
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+src.pyconf module
+-----------------
+
+.. automodule:: src.pyconf
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+src.returnCode module
+---------------------
+
+.. automodule:: src.returnCode
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+src.salomeTools module
+----------------------
+
+.. automodule:: src.salomeTools
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+src.system module
+-----------------
+
+.. automodule:: src.system
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+src.template module
+-------------------
+
+.. automodule:: src.template
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+src.test_module module
+----------------------
+
+.. automodule:: src.test_module
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+src.utilsSat module
+-------------------
+
+.. automodule:: src.utilsSat
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+src.xmlManager module
+---------------------
+
+.. automodule:: src.xmlManager
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: src
+ :members:
+ :undoc-members:
+ :show-inheritance:
+++ /dev/null
-
-.. include:: ../../rst_prolog.rst
-
-Command application
-*********************
-
-Description
-===========
-The **application** command creates a virtual SALOME_ application.
-Virtual SALOME applications are used to start SALOME when distribution is needed.
-
-Usage
-=====
-* Create an application: ::
-
- sat application <application>
-
- Create the virtual application directory in the salomeTool application directory ``$APPLICATION.workdir``.
-
-* Give a name to the application: ::
-
- sat application <application> --name <my_application_name>
-
- *Remark*: this option overrides the name given in the virtual_app section of the configuration file ``$APPLICATION.virtual_app.name``.
-
-* Change the directory where the application is created: ::
-
- sat application <application> --target <my_application_directory>
-
-* Set a specific SALOME_ resources catalog (it will be used for the distribution of components on distant machines): ::
-
- sat application <application> --catalog <path_to_catalog>
-
- Note that the catalog specified will be copied to the application directory.
-
-* Generate the catalog for a list of machines: ::
-
- sat application <application> --gencat machine1,machine2,machine3
-
- This will create a catalog by querying each machine through ssh protocol (memory, number of processor) with ssh.
-
-* Generate a mesa application (if mesa and llvm are parts of the application). Use this option only if you have to use salome through ssh and have problems with ssh X forwarding of OpengGL modules (like Paravis): ::
-
- sat launcher <application> --use_mesa
-
-Some useful configuration pathes
-=================================
-
-The virtual application can be configured with the virtual_app section of the configutation file.
-
-* **APPLICATION.virtual_app**
-
- * **name** : name of the launcher (to replace the default runAppli).
- * **application_name** : (optional) the name of the virtual application directory, if missing the default value is ``$name + _appli``.
-
--- /dev/null
+
+.. include:: ../../rst_prolog.rst
+
+Command application
+*********************
+
+Description
+===========
+The **application** command creates a virtual SALOME_ application.
+Virtual SALOME applications are used to start SALOME when distribution is needed.
+
+Usage
+=====
+* Create an application: ::
+
+ sat application <application>
+
+ Create the virtual application directory in the salomeTool application directory ``$APPLICATION.workdir``.
+
+* Give a name to the application: ::
+
+ sat application <application> --name <my_application_name>
+
+ *Remark*: this option overrides the name given in the virtual_app section of the configuration file ``$APPLICATION.virtual_app.name``.
+
+* Change the directory where the application is created: ::
+
+ sat application <application> --target <my_application_directory>
+
+* Set a specific SALOME_ resources catalog (it will be used for the distribution of components on distant machines): ::
+
+ sat application <application> --catalog <path_to_catalog>
+
+ Note that the catalog specified will be copied to the application directory.
+
+* Generate the catalog for a list of machines: ::
+
+ sat application <application> --gencat machine1,machine2,machine3
+
+ This will create a catalog by querying each machine through ssh protocol (memory, number of processor) with ssh.
+
+* Generate a mesa application (if mesa and llvm are parts of the application). Use this option only if you have to use salome through ssh and have problems with ssh X forwarding of OpengGL modules (like Paravis): ::
+
+ sat launcher <application> --use_mesa
+
+Some useful configuration pathes
+=================================
+
+The virtual application can be configured with the virtual_app section of the configutation file.
+
+* **APPLICATION.virtual_app**
+
+ * **name** : name of the launcher (to replace the default runAppli).
+ * **application_name** : (optional) the name of the virtual application directory, if missing the default value is ``$name + _appli``.
+
+++ /dev/null
-
-.. include:: ../../rst_prolog.rst
-
-Command clean
-****************
-
-Description
-============
-
-The **clean** command removes products in the *source, build, or install* directories of an application. Theses directories are usually named ``SOURCES, BUILD, INSTALL``.
-
-Use the options to define what directories you want to suppress and to set the list of products
-
-
-Usage
-=======
-
-* Clean all previously created *build* and *install* directories (example application as *SALOME_xx*):
-
- .. code-block:: bash
-
- # take care, is long time to restore, sometimes
- sat clean SALOME-xx --build --install
-
-* Clean previously created *build* and *install* directories, only for products with property *is_salome_module*:
-
- .. code-block:: bash
-
- sat clean SALOME-xxx --build --install \
- --properties is_salome_module:yes
-
-
-Availables options
-======================
-
- * **--products** : Products to clean.
-
- * **--properties** :
-
- | Filter the products by their properties.
- | Syntax: *--properties <property>:<value>*
-
- * **--sources** : Clean the product source directories.
-
- * **--build** : Clean the product build directories.
-
- * **--install** : Clean the product install directories.
-
- * **--all** : Clean the product source, build and install directories.
-
- * **--sources_without_dev** :
-
- | Do not clean the products in development mode,
- | (they could have VCS_ commits pending).
-
-
-
-Some useful configuration pathes
-=================================
-
-No specific configuration.
--- /dev/null
+
+.. include:: ../../rst_prolog.rst
+
+Command clean
+****************
+
+Description
+============
+
+The **clean** command removes products in the *source, build, or install* directories of an application. Theses directories are usually named ``SOURCES, BUILD, INSTALL``.
+
+Use the options to define what directories you want to suppress and to set the list of products
+
+
+Usage
+=======
+
+* Clean all previously created *build* and *install* directories (example application as *SALOME_xx*):
+
+ .. code-block:: bash
+
+ # take care, is long time to restore, sometimes
+ sat clean SALOME-xx --build --install
+
+* Clean previously created *build* and *install* directories, only for products with property *is_salome_module*:
+
+ .. code-block:: bash
+
+ sat clean SALOME-xxx --build --install \
+ --properties is_salome_module:yes
+
+
+Availables options
+======================
+
+ * **--products** : Products to clean.
+
+ * **--properties** :
+
+ | Filter the products by their properties.
+ | Syntax: *--properties <property>:<value>*
+
+ * **--sources** : Clean the product source directories.
+
+ * **--build** : Clean the product build directories.
+
+ * **--install** : Clean the product install directories.
+
+ * **--all** : Clean the product source, build and install directories.
+
+ * **--sources_without_dev** :
+
+ | Do not clean the products in development mode,
+ | (they could have VCS_ commits pending).
+
+
+
+Some useful configuration pathes
+=================================
+
+No specific configuration.
+++ /dev/null
-
-.. include:: ../../rst_prolog.rst
-
-Command compile
-****************
-
-Description
-===========
-The **compile** command allows compiling the products of a SALOME_ application.
-
-
-Usage
-=====
-* Compile a complete application: ::
-
- sat compile <application>
-
-* Compile only some products: ::
-
- sat compile <application> --products <product1>,<product2> ...
-
-* Use *sat -t* to duplicate the logs in the terminal (by default the log are stored and displayed with *sat log* command): ::
-
- sat -t compile <application> --products <product1>
-
-* Compile a module and its dependencies: ::
-
- sat compile <application> --products med --with_fathers
-
-* Compile a module and the modules depending on it (for example plugins): ::
-
- sat compile <application> --products med --with_children
-
-* Clean the build and install directories before starting compilation: ::
-
- sat compile <application> --products GEOM --clean_all
-
- .. note:: | a warning will be shown if option *--products* is missing
- | (as it will clean everything)
-
-* Clean only the install directories before starting compilation: ::
-
- sat compile <application> --clean_install
-
-* Add options for make: ::
-
- sat compile <application> --products <product> --make_flags <flags>
-
-* Use the *--check* option to execute the unit tests after compilation: ::
-
- sat compile <application> --check
-
-* Remove the build directory after successful compilation (some build directory like qt are big): ::
-
- sat compile <application> --products qt --clean_build_after
-
-* Stop the compilation as soon as the compilation of a module fails: ::
-
- sat compile <product> --stop_first_fail
-
-* Do not compile, just show if products are installed or not, and where is the installation: ::
-
- sat compile <application> --show
-
-
-Some useful configuration pathes
-=================================
-
-The way to compile a product is defined in the *pyconf file configuration*.
-The main options are:
-
- * **build_source** : the method used to build the product (cmake/autotools/script)
- * **compil_script** : the compilation script if build_source is equal to "script"
- * **cmake_options** : additional options for cmake.
- * **nb_proc** : number of jobs to use with make for this product.
--- /dev/null
+
+.. include:: ../../rst_prolog.rst
+
+Command compile
+****************
+
+Description
+===========
+The **compile** command allows compiling the products of a SALOME_ application.
+
+
+Usage
+=====
+* Compile a complete application: ::
+
+ sat compile <application>
+
+* Compile only some products: ::
+
+ sat compile <application> --products <product1>,<product2> ...
+
+* Use *sat -t* to duplicate the logs in the terminal (by default the log are stored and displayed with *sat log* command): ::
+
+ sat -t compile <application> --products <product1>
+
+* Compile a module and its dependencies: ::
+
+ sat compile <application> --products med --with_fathers
+
+* Compile a module and the modules depending on it (for example plugins): ::
+
+ sat compile <application> --products med --with_children
+
+* Clean the build and install directories before starting compilation: ::
+
+ sat compile <application> --products GEOM --clean_all
+
+ .. note:: | a warning will be shown if option *--products* is missing
+ | (as it will clean everything)
+
+* Clean only the install directories before starting compilation: ::
+
+ sat compile <application> --clean_install
+
+* Add options for make: ::
+
+ sat compile <application> --products <product> --make_flags <flags>
+
+* Use the *--check* option to execute the unit tests after compilation: ::
+
+ sat compile <application> --check
+
+* Remove the build directory after successful compilation (some build directory like qt are big): ::
+
+ sat compile <application> --products qt --clean_build_after
+
+* Stop the compilation as soon as the compilation of a module fails: ::
+
+ sat compile <product> --stop_first_fail
+
+* Do not compile, just show if products are installed or not, and where is the installation: ::
+
+ sat compile <application> --show
+
+
+Some useful configuration pathes
+=================================
+
+The way to compile a product is defined in the *pyconf file configuration*.
+The main options are:
+
+ * **build_source** : the method used to build the product (cmake/autotools/script)
+ * **compil_script** : the compilation script if build_source is equal to "script"
+ * **cmake_options** : additional options for cmake.
+ * **nb_proc** : number of jobs to use with make for this product.
+++ /dev/null
-
-.. include:: ../../rst_prolog.rst
-
-Command config
-******************
-
-Description
-===========
-The **config** command manages sat configuration.
-It allows display, manipulation and operation on configuration files
-
-Usage
-=====
-* Edit the user personal configuration file ``$HOME/.salomeTools/SAT.pyconf``. It is used to store the user personal choices, like the favorite editor, browser, pdf viewer: ::
-
- sat config --edit
-
-* List the available applications (they come from the sat projects defined in ``data/local.pyconf``: ::
-
- sat config --list
-
-* Edit the configuration of an application: ::
-
- sat config <application> --edit
-
-* Copy an application configuration file into the user personal directory: ::
-
- sat config <application> --copy [new_name]
-
-* | Print the value of a configuration parameter.
- | Use the automatic completion to get recursively the parameter names.
- | Use *--no_label* option to get *only* the value, *without* label (useful in automatic scripts).
- | Examples (with *SALOME-xx* as *SALOME-8.4.0* ):
-
- .. code-block:: bash
-
- # sat config --value <parameter_path>
- sat config --value . # all the configuration
- sat config --value LOCAL
- sat config --value LOCAL.workdir
-
- # sat config <application> --value <parameter_path>
- sat config SALOME-xx --value APPLICATION.workdir
- sat config SALOME-xx --no_label --value APPLICATION.workdir
-
-* | Print in one-line-by-value mode the value of a configuration parameter,
- | with its source *expression*, if any.
- | This is a debug mode, useful for developers.
- | Prints the parameter path, the source expression if any, and the final value:
-
- ::
-
- sat config SALOME-xx -g USER
-
- .. note:: And so, *not only for fun*, to get **all expressions** of configuration
-
- .. code-block:: bash
-
- sat config SALOME-xx -g . | grep -e "-->"
-
-
-* Print the patches that are applied: ::
-
- sat config SALOME-xx --show_patchs
-
-* Get information on a product configuration:
-
-.. code-block:: bash
-
- # sat config <application> --info <product>
- sat config SALOME-xx --info KERNEL
- sat config SALOME-xx --info qt
-
-Some useful configuration pathes
-=================================
-
-Exploring a current configuration.
-
-* **PATHS**: To get list of directories where to find files.
-
-* **USER**: To get user preferences (editor, pdf viewer, web browser, default working dir).
-
-sat commands: ::
-
- sat config SALOME-xx -v PATHS
- sat config SALOME-xx -v USERS
-
-
-
--- /dev/null
+
+.. include:: ../../rst_prolog.rst
+
+Command config
+******************
+
+Description
+===========
+The **config** command manages sat configuration.
+It allows display, manipulation and operation on configuration files
+
+Usage
+=====
+* Edit the user personal configuration file ``$HOME/.salomeTools/SAT.pyconf``. It is used to store the user personal choices, like the favorite editor, browser, pdf viewer: ::
+
+ sat config --edit
+
+* List the available applications (they come from the sat projects defined in ``data/local.pyconf``: ::
+
+ sat config --list
+
+* Edit the configuration of an application: ::
+
+ sat config <application> --edit
+
+* Copy an application configuration file into the user personal directory: ::
+
+ sat config <application> --copy [new_name]
+
+* | Print the value of a configuration parameter.
+ | Use the automatic completion to get recursively the parameter names.
+ | Use *--no_label* option to get *only* the value, *without* label (useful in automatic scripts).
+ | Examples (with *SALOME-xx* as *SALOME-8.4.0* ):
+
+ .. code-block:: bash
+
+ # sat config --value <parameter_path>
+ sat config --value . # all the configuration
+ sat config --value LOCAL
+ sat config --value LOCAL.workdir
+
+ # sat config <application> --value <parameter_path>
+ sat config SALOME-xx --value APPLICATION.workdir
+ sat config SALOME-xx --no_label --value APPLICATION.workdir
+
+* | Print in one-line-by-value mode the value of a configuration parameter,
+ | with its source *expression*, if any.
+ | This is a debug mode, useful for developers.
+ | Prints the parameter path, the source expression if any, and the final value:
+
+ ::
+
+ sat config SALOME-xx -g USER
+
+ .. note:: And so, *not only for fun*, to get **all expressions** of configuration
+
+ .. code-block:: bash
+
+ sat config SALOME-xx -g . | grep -e "-->"
+
+
+* Print the patches that are applied: ::
+
+ sat config SALOME-xx --show_patchs
+
+* Get information on a product configuration:
+
+.. code-block:: bash
+
+ # sat config <application> --info <product>
+ sat config SALOME-xx --info KERNEL
+ sat config SALOME-xx --info qt
+
+Some useful configuration pathes
+=================================
+
+Exploring a current configuration.
+
+* **PATHS**: To get list of directories where to find files.
+
+* **USER**: To get user preferences (editor, pdf viewer, web browser, default working dir).
+
+sat commands: ::
+
+ sat config SALOME-xx -v PATHS
+ sat config SALOME-xx -v USERS
+
+
+
+++ /dev/null
-
-.. include:: ../../rst_prolog.rst
-
-Command environ
-****************
-
-Description
-===========
-The **environ** command generates the environment files used
-to run and compile your application (as SALOME_ is an example).
-
-.. note ::
- these files are **not** required,
- salomeTool set the environment himself, when compiling.
- And so does the salome launcher.
-
- These files are useful when someone wants to check the environment.
- They could be used in debug mode to set the environment for *gdb*.
-
-The configuration part at the end of this page explains how
-to specify the environment used by sat (at build or run time),
-and saved in some files by *sat environ* command.
-
-Usage
-=====
-* Create the shell environment files of the application: ::
-
- sat environ <application>
-
-* Create the environment files of the application for a given shell.
- Options are bash, bat (for windows) and cfg (the configuration format used by SALOME_): ::
-
- sat environ <application> --shell [bash|cfg|all]
-
-* Use a different prefix for the files (default is 'env'):
-
- .. code-block:: bash
-
- # This will create file <prefix>_launch.sh, <prefix>_build.sh
- sat environ <application> --prefix <prefix>
-
-* Use a different target directory for the files:
-
- .. code-block:: bash
-
- # This will create file env_launch.sh, env_build.sh
- # in the directory corresponding to <path>
- sat environ <application> --target <path>
-
-* Generate the environment files only with the given products:
-
- .. code-block:: bash
-
- # This will create the environment files only for the given products
- # and their prerequisites.
- # It is useful when you want to visualise which environment uses
- # sat to compile a given product.
- sat environ <application> --product <product1>,<product2>, ...
-
-
-Configuration
-=============
-
-The specification of the environment can be done through several mechanisms.
-
-1. For salome products (the products with the property ``is_SALOME_module`` as ``yes``) the environment is set automatically by sat, in respect with SALOME_ requirements.
-
-2. For other products, the environment is set with the use of the environ section within the pyconf file of the product. The user has two possibilities, either set directly the environment within the section, or specify a python script which wil be used to set the environment programmatically.
-
-Within the section, the user can define environment variables. He can also modify PATH variables, by appending or prepending directories.
-In the following example, we prepend *<install_dir>/lib* to ``LD_LIBRARY_PATH`` (note the *left first* underscore), append *<install_dir>/lib* to ``PYTHONPATH`` (note the *right last* underscore), and set ``LAPACK_ROOT_DIR`` to *<install_dir>*:
-
-.. code-block:: bash
-
- environ :
- {
- _LD_LIBRARY_PATH : $install_dir + $VARS.sep + "lib"
- PYTHONPATH_ : $install_dir + $VARS.sep + "lib"
- LAPACK_ROOT_DIR : $install_dir
- }
-
-It is possible to distinguish the build environment from the launch environment: use a subsection called *build* or *launch*. In the example below, ``LD_LIBRARY_PATH`` and ``PYTHONPATH`` are only modified at run time, not at compile time:
-
-.. code-block:: bash
-
- environ :
- {
- build :
- {
- LAPACK_ROOT_DIR : $install_dir
- }
- launch :
- {
- LAPACK_ROOT_DIR : $install_dir
- _LD_LIBRARY_PATH : $install_dir + $VARS.sep + "lib"
- PYTHONPATH_ : $install_dir + $VARS.sep + "lib"
- }
- }
-
-3. The last possibility is to set the environment with a python script. The script should be provided in the *products/env_scripts* directory of the sat project, and its name is specified in the environment section with the key ``environ.env_script``:
-
-.. code-block:: python
-
- environ :
- {
- env_script : 'lapack.py'
- }
-
-Please note that the two modes are complementary and are both taken into account.
-Most of the time, the first mode is sufficient.
-
-The second mode can be used when the environment has to be set programmatically.
-The developer implements a handle (as a python method)
-which is called by sat to set the environment.
-Here is an example:
-
-.. code-block:: python
-
-
- #!/usr/bin/env python
- #-*- coding:utf-8 -*-
-
- import os.path
- import platform
-
- def set_env(env, prereq_dir, version):
- env.set("TRUST_ROOT_DIR",prereq_dir)
- env.prepend('PATH', os.path.join(prereq_dir, 'bin'))
- env.prepend('PATH', os.path.join(prereq_dir, 'include'))
- env.prepend('LD_LIBRARY_PATH', os.path.join(prereq_dir, 'lib'))
- return
-
-SalomeTools defines four handles:
-
-* **set_env(env, prereq_dir, version)** : used at build and run time.
-* **set_env_launch(env, prereq_dir, version)** : used only at run time (if defined!)
-* **set_env_build(env, prereq_dir, version)** : used only at build time (if defined!)
-* **set_native_env(env)** : used only for native products, at build and run time.
-
--- /dev/null
+
+.. include:: ../../rst_prolog.rst
+
+Command environ
+****************
+
+Description
+===========
+The **environ** command generates the environment files used
+to run and compile your application (as SALOME_ is an example).
+
+.. note ::
+ these files are **not** required,
+ salomeTool set the environment himself, when compiling.
+ And so does the salome launcher.
+
+ These files are useful when someone wants to check the environment.
+ They could be used in debug mode to set the environment for *gdb*.
+
+The configuration part at the end of this page explains how
+to specify the environment used by sat (at build or run time),
+and saved in some files by *sat environ* command.
+
+Usage
+=====
+* Create the shell environment files of the application: ::
+
+ sat environ <application>
+
+* Create the environment files of the application for a given shell.
+ Options are bash, bat (for windows) and cfg (the configuration format used by SALOME_): ::
+
+ sat environ <application> --shell [bash|cfg|all]
+
+* Use a different prefix for the files (default is 'env'):
+
+ .. code-block:: bash
+
+ # This will create file <prefix>_launch.sh, <prefix>_build.sh
+ sat environ <application> --prefix <prefix>
+
+* Use a different target directory for the files:
+
+ .. code-block:: bash
+
+ # This will create file env_launch.sh, env_build.sh
+ # in the directory corresponding to <path>
+ sat environ <application> --target <path>
+
+* Generate the environment files only with the given products:
+
+ .. code-block:: bash
+
+ # This will create the environment files only for the given products
+ # and their prerequisites.
+ # It is useful when you want to visualise which environment uses
+ # sat to compile a given product.
+ sat environ <application> --product <product1>,<product2>, ...
+
+
+Configuration
+=============
+
+The specification of the environment can be done through several mechanisms.
+
+1. For salome products (the products with the property ``is_SALOME_module`` as ``yes``) the environment is set automatically by sat, in respect with SALOME_ requirements.
+
+2. For other products, the environment is set with the use of the environ section within the pyconf file of the product. The user has two possibilities, either set directly the environment within the section, or specify a python script which wil be used to set the environment programmatically.
+
+Within the section, the user can define environment variables. He can also modify PATH variables, by appending or prepending directories.
+In the following example, we prepend *<install_dir>/lib* to ``LD_LIBRARY_PATH`` (note the *left first* underscore), append *<install_dir>/lib* to ``PYTHONPATH`` (note the *right last* underscore), and set ``LAPACK_ROOT_DIR`` to *<install_dir>*:
+
+.. code-block:: bash
+
+ environ :
+ {
+ _LD_LIBRARY_PATH : $install_dir + $VARS.sep + "lib"
+ PYTHONPATH_ : $install_dir + $VARS.sep + "lib"
+ LAPACK_ROOT_DIR : $install_dir
+ }
+
+It is possible to distinguish the build environment from the launch environment: use a subsection called *build* or *launch*. In the example below, ``LD_LIBRARY_PATH`` and ``PYTHONPATH`` are only modified at run time, not at compile time:
+
+.. code-block:: bash
+
+ environ :
+ {
+ build :
+ {
+ LAPACK_ROOT_DIR : $install_dir
+ }
+ launch :
+ {
+ LAPACK_ROOT_DIR : $install_dir
+ _LD_LIBRARY_PATH : $install_dir + $VARS.sep + "lib"
+ PYTHONPATH_ : $install_dir + $VARS.sep + "lib"
+ }
+ }
+
+3. The last possibility is to set the environment with a python script. The script should be provided in the *products/env_scripts* directory of the sat project, and its name is specified in the environment section with the key ``environ.env_script``:
+
+.. code-block:: python
+
+ environ :
+ {
+ env_script : 'lapack.py'
+ }
+
+Please note that the two modes are complementary and are both taken into account.
+Most of the time, the first mode is sufficient.
+
+The second mode can be used when the environment has to be set programmatically.
+The developer implements a handle (as a python method)
+which is called by sat to set the environment.
+Here is an example:
+
+.. code-block:: python
+
+
+ #!/usr/bin/env python
+ #-*- coding:utf-8 -*-
+
+ import os.path
+ import platform
+
+ def set_env(env, prereq_dir, version):
+ env.set("TRUST_ROOT_DIR",prereq_dir)
+ env.prepend('PATH', os.path.join(prereq_dir, 'bin'))
+ env.prepend('PATH', os.path.join(prereq_dir, 'include'))
+ env.prepend('LD_LIBRARY_PATH', os.path.join(prereq_dir, 'lib'))
+ return
+
+SalomeTools defines four handles:
+
+* **set_env(env, prereq_dir, version)** : used at build and run time.
+* **set_env_launch(env, prereq_dir, version)** : used only at run time (if defined!)
+* **set_env_build(env, prereq_dir, version)** : used only at build time (if defined!)
+* **set_native_env(env)** : used only for native products, at build and run time.
+
+++ /dev/null
-
-.. include:: ../../rst_prolog.rst
-
-Command generate
-****************
-
-Description
-===========
-The **generate** command generates and compile SALOME modules from cpp modules using YACSGEN.
-
-.. note:: This command uses YACSGEN to generate the module. It needs to be specified with *--yacsgen* option, or defined in the product or by the environment variable ``$YACSGEN_ROOT_DIR``.
-
-
-Remarks
-=======
-* This command will only apply on the CPP modules of the application, those who have both properties: ::
-
- cpp : "yes"
- generate : "yes"
-
-* The cpp module are usually computational components, and the generated module brings the CORBA layer which allows distributing the compononent on remore machines. cpp modules should conform to YACSGEN/hxx2salome requirements (please refer to YACSGEN documentation)
-
-
-Usage
-=====
-* Generate all the modules of a product: ::
-
- sat generate <application>
-
-* Generate only specific modules: ::
-
- sat generate <application> --products <list_of_products>
-
- Remark: modules which don't have the *generate* property are ignored.
-
-* Use a specific version of YACSGEN: ::
-
- sat generate <application> --yacsgen <path_to_yacsgen>
-
--- /dev/null
+
+.. include:: ../../rst_prolog.rst
+
+Command generate
+****************
+
+Description
+===========
+The **generate** command generates and compile SALOME modules from cpp modules using YACSGEN.
+
+.. note:: This command uses YACSGEN to generate the module. It needs to be specified with *--yacsgen* option, or defined in the product or by the environment variable ``$YACSGEN_ROOT_DIR``.
+
+
+Remarks
+=======
+* This command will only apply on the CPP modules of the application, those who have both properties: ::
+
+ cpp : "yes"
+ generate : "yes"
+
+* The cpp module are usually computational components, and the generated module brings the CORBA layer which allows distributing the compononent on remore machines. cpp modules should conform to YACSGEN/hxx2salome requirements (please refer to YACSGEN documentation)
+
+
+Usage
+=====
+* Generate all the modules of a product: ::
+
+ sat generate <application>
+
+* Generate only specific modules: ::
+
+ sat generate <application> --products <list_of_products>
+
+ Remark: modules which don't have the *generate* property are ignored.
+
+* Use a specific version of YACSGEN: ::
+
+ sat generate <application> --yacsgen <path_to_yacsgen>
+
+++ /dev/null
-
-.. include:: ../../rst_prolog.rst
-
-Command launcher
-******************
-
-Description
-===========
-The **launcher** command creates a SALOME launcher, a python script file to start SALOME_.
-
-
-Usage
-=====
-* Create a launcher: ::
-
- sat launcher <application>
-
- Generate a launcher in the application directory, i.e ``$APPLICATION.workdir``.
-
-* Create a launcher with a given name (default name is ``APPLICATION.profile.launcher_name``) ::
-
- sat launcher <application> --name ZeLauncher
-
- The launcher will be called *ZeLauncher*.
-
-* Set a specific resources catalog: ::
-
- sat launcher <application> --catalog <path of a salome resources catalog>
-
- Note that the catalog specified will be copied to the profile directory.
-
-* Generate the catalog for a list of machines: ::
-
- sat launcher <application> --gencat <list of machines>
-
- This will create a catalog by querying each machine (memory, number of processor) with ssh.
-
-* Generate a mesa launcher (if mesa and llvm are parts of the application). Use this option only if you have to use salome through ssh and have problems with ssh X forwarding of OpengGL modules (like Paravis): ::
-
- sat launcher <application> --use_mesa
-
-
-Configuration
-=============
-
-Some useful configuration pathes:
-
-* **APPLICATION.profile**
-
- * **product** : the name of the profile product (the product in charge of holding the application stuff, like logos, splashscreen)
- * **launcher_name** : the name of the launcher.
-
--- /dev/null
+
+.. include:: ../../rst_prolog.rst
+
+Command launcher
+******************
+
+Description
+===========
+The **launcher** command creates a SALOME launcher, a python script file to start SALOME_.
+
+
+Usage
+=====
+* Create a launcher: ::
+
+ sat launcher <application>
+
+ Generate a launcher in the application directory, i.e ``$APPLICATION.workdir``.
+
+* Create a launcher with a given name (default name is ``APPLICATION.profile.launcher_name``) ::
+
+ sat launcher <application> --name ZeLauncher
+
+ The launcher will be called *ZeLauncher*.
+
+* Set a specific resources catalog: ::
+
+ sat launcher <application> --catalog <path of a salome resources catalog>
+
+ Note that the catalog specified will be copied to the profile directory.
+
+* Generate the catalog for a list of machines: ::
+
+ sat launcher <application> --gencat <list of machines>
+
+ This will create a catalog by querying each machine (memory, number of processor) with ssh.
+
+* Generate a mesa launcher (if mesa and llvm are parts of the application). Use this option only if you have to use salome through ssh and have problems with ssh X forwarding of OpengGL modules (like Paravis): ::
+
+ sat launcher <application> --use_mesa
+
+
+Configuration
+=============
+
+Some useful configuration pathes:
+
+* **APPLICATION.profile**
+
+ * **product** : the name of the profile product (the product in charge of holding the application stuff, like logos, splashscreen)
+ * **launcher_name** : the name of the launcher.
+
+++ /dev/null
-
-.. include:: ../../rst_prolog.rst
-
-Command log
-****************
-
-Description
-===========
-The **log** command displays sat log in a web browser or in a terminal.
-
-Usage
-=====
-* Show (in a web browser) the log of the commands corresponding to an application: ::
-
- sat log <application>
-
-* Show the log for commands that do not use any application: ::
-
- sat log
-
-* The --terminal (or -t) display the log directly in the terminal, through a CLI_ interactive menu: ::
-
- sat log <application> --terminal
-
-* The --last option displays only the last command: ::
-
- sat log <application> --last
-
-* To access the last compilation log in terminal mode, use --last_terminal option: ::
-
- sat log <application> --last_terminal
-
-* The --clean (int) option erases the n older log files and print the number of remaining log files: ::
-
- sat log <application> --clean 50
-
-
-
-Some useful configuration pathes
-=================================
-
-* **USER**
-
- * **browser** : The browser used to show the log (by default *firefox*).
- * **log_dir** : The directory used to store the log files.
-
--- /dev/null
+
+.. include:: ../../rst_prolog.rst
+
+Command log
+****************
+
+Description
+===========
+The **log** command displays sat log in a web browser or in a terminal.
+
+Usage
+=====
+* Show (in a web browser) the log of the commands corresponding to an application: ::
+
+ sat log <application>
+
+* Show the log for commands that do not use any application: ::
+
+ sat log
+
+* The --terminal (or -t) display the log directly in the terminal, through a CLI_ interactive menu: ::
+
+ sat log <application> --terminal
+
+* The --last option displays only the last command: ::
+
+ sat log <application> --last
+
+* To access the last compilation log in terminal mode, use --last_terminal option: ::
+
+ sat log <application> --last_terminal
+
+* The --clean (int) option erases the n older log files and print the number of remaining log files: ::
+
+ sat log <application> --clean 50
+
+
+
+Some useful configuration pathes
+=================================
+
+* **USER**
+
+ * **browser** : The browser used to show the log (by default *firefox*).
+ * **log_dir** : The directory used to store the log files.
+
+++ /dev/null
-
-.. include:: ../../rst_prolog.rst
-
-Command package
-****************
-
-Description
-============
-The **package** command creates a SALOME_ archive (usually a compressed Tar_ file .tgz).
-This tar file is used later to intall SALOME on other remote computer.
-
-Depending on the selected options, the archive includes sources and binaries
-of SALOME products and prerequisites.
-
-Usually utility *salomeTools* is included in the archive.
-
-.. note::
- By default the package includes the sources of prerequisites and products.
- To select a subset use the *--without_property* or *--with_vcs* options.
-
-
-Usage
-=====
-* Create a package for a product (example as *SALOME_xx*): ::
-
- sat package SALOME_xx
-
- This command will create an archive named ``SALOME_xx.tgz``
- in the working directory (``USER.workDir``).
- If the archive already exists, do nothing.
-
-
-* Create a package with a specific name: ::
-
- sat package SALOME_xx --name YourSpecificName
-
-.. note::
- By default, the archive is created in the working directory of the user (``USER.workDir``).
-
- If the option *--name* is used with a path (relative or absolute) it will be used.
-
- If the option *--name* is not used and binaries (prerequisites and products)
- are included in the package, the OS_ architecture
- will be appended to the name (example: ``SALOME_xx-CO7.tgz``).
-
- Examples: ::
-
- # Creates SALOME_xx.tgz in $USER.workDir
- sat package SALOME_xx
-
- # Creates SALOME_xx_<arch>.tgz in $USER.workDir
- sat package SALOME_xx --binaries
-
- # Creates MySpecificName.tgz in $USER.workDir
- sat package SALOME_xx --name MySpecificName
-
-
-* Force the creation of the archive (if it already exists): ::
-
- sat package SALOME_xx --force
-
-
-* Include the binaries in the archive (products and prerequisites): ::
-
- sat package SALOME_xx --binaries
-
- This command will create an archive named ``SALOME_xx _<arch>.tgz``
- where <arch> is the OS_ architecture of the machine.
-
-
-* Do not delete Version Control System (VCS_) informations from the configurations files of the embedded salomeTools: ::
-
- sat package SALOME_xx --with_vcs
-
- The version control systems known by this option are CVS_, SVN_ and Git_.
-
-
-Some useful configuration pathes
-=================================
-
-No specific configuration.
--- /dev/null
+
+.. include:: ../../rst_prolog.rst
+
+Command package
+****************
+
+Description
+============
+The **package** command creates a SALOME_ archive (usually a compressed Tar_ file .tgz).
+This tar file is used later to intall SALOME on other remote computer.
+
+Depending on the selected options, the archive includes sources and binaries
+of SALOME products and prerequisites.
+
+Usually utility *salomeTools* is included in the archive.
+
+.. note::
+ By default the package includes the sources of prerequisites and products.
+ To select a subset use the *--without_property* or *--with_vcs* options.
+
+
+Usage
+=====
+* Create a package for a product (example as *SALOME_xx*): ::
+
+ sat package SALOME_xx
+
+ This command will create an archive named ``SALOME_xx.tgz``
+ in the working directory (``USER.workDir``).
+ If the archive already exists, do nothing.
+
+
+* Create a package with a specific name: ::
+
+ sat package SALOME_xx --name YourSpecificName
+
+.. note::
+ By default, the archive is created in the working directory of the user (``USER.workDir``).
+
+ If the option *--name* is used with a path (relative or absolute) it will be used.
+
+ If the option *--name* is not used and binaries (prerequisites and products)
+ are included in the package, the OS_ architecture
+ will be appended to the name (example: ``SALOME_xx-CO7.tgz``).
+
+ Examples: ::
+
+ # Creates SALOME_xx.tgz in $USER.workDir
+ sat package SALOME_xx
+
+ # Creates SALOME_xx_<arch>.tgz in $USER.workDir
+ sat package SALOME_xx --binaries
+
+ # Creates MySpecificName.tgz in $USER.workDir
+ sat package SALOME_xx --name MySpecificName
+
+
+* Force the creation of the archive (if it already exists): ::
+
+ sat package SALOME_xx --force
+
+
+* Include the binaries in the archive (products and prerequisites): ::
+
+ sat package SALOME_xx --binaries
+
+ This command will create an archive named ``SALOME_xx _<arch>.tgz``
+ where <arch> is the OS_ architecture of the machine.
+
+
+* Do not delete Version Control System (VCS_) informations from the configurations files of the embedded salomeTools: ::
+
+ sat package SALOME_xx --with_vcs
+
+ The version control systems known by this option are CVS_, SVN_ and Git_.
+
+
+Some useful configuration pathes
+=================================
+
+No specific configuration.
+++ /dev/null
-
-.. include:: ../../rst_prolog.rst
-
-Command prepare
-****************
-
-Description
-===========
-The **prepare** command brings the sources of an application in the *sources
-application directory*, in order to compile them with the compile command.
-
-The sources can be prepared from VCS software (*cvs, svn, git*), an archive or a directory.
-
-.. warning:: When sat prepares a product, it first removes the
- existing directory, except if the development mode is activated.
- When you are working on a product, you need to declare in
- the application configuration this product in **dev** mode.
-
-Remarks
-=======
-
-VCS bases (git, svn, cvs)
--------------------------
-
-The *prepare* command does not manage authentication on the cvs server.
-For example, to prepare modules from a cvs server, you first need to login once.
-
-To avoid typing a password for each product,
-you may use a ssh key with passphrase, or store your password
-(in .cvspass or .gitconfig files).
-If you have security concerns, it is also possible to use
-a bash agent and type your password only once.
-
-
-
-Dev mode
---------
-
-By default *prepare* uses *export* mode: it creates an image
-of the sources, corresponding to the tag or branch specified,
-without any link to the VCS base.
-To perform a *checkout* (svn, cvs) or a *git clone* (git),
-you need to declare the product in dev mode in your application configuration:
-edit the application configuration file (pyconf) and modify the product declaration:
-
-.. code-block:: bash
-
- sat config <application> -e
- # and edit the product section:
- # <product> : {tag : "my_tag", dev : "yes", debug : "yes"}
-
-The first time you will execute the *sat prepare* command,
-your module will be downloaded in *checkout* mode
-(inside the SOURCES directory of the application.
-Then, you can develop in this repository, and finally push
-them in the base when they are ready.
-If you type during the development process by mistake
-a *sat prepare* command, the sources in dev mode will
-not be altered/removed (Unless you use -f option)
-
-
-Usage
-=====
-* Prepare the sources of a complete application in SOURCES directory (all products): ::
-
- sat prepare <application>
-
-* Prepare only some modules: ::
-
- sat prepare <application> --products <product1>,<product2> ...
-
-* Use --force to force to prepare the products in development mode
- (this will remove the sources and do a new clone/checkout): ::
-
- sat prepare <application> --force
-
-* Use --force_patch to force to apply patch to the products
- in development mode (otherwise they are not applied): ::
-
- sat prepare <application> --force_patch
-
-
-Some useful configuration pathes
-=================================
-
-Command *sat prepare* uses the *pyconf file configuration* of each product to know how to get the sources.
-
-.. note:: to verify configuration of a product, and get name of this *pyconf files configuration*
-
- .. code-block :: bash
-
- sat config <application> --info <product>
-
-
-* **get_method**: the method to use to prepare the module, possible values are cvs, git, archive, dir.
-* **git_info** : (used if get_method = git) information to prepare sources from git.
-* **svn_info** : (used if get_method = svn) information to prepare sources from cvs.
-* **cvs_info** : (used if get_method = cvs) information to prepare sources from cvs.
-* **archive_info** : (used if get_method = archive) the path to the archive.
-* **dir_info** : (used if get_method = dir) the directory with the sources.
--- /dev/null
+
+.. include:: ../../rst_prolog.rst
+
+Command prepare
+****************
+
+Description
+===========
+The **prepare** command brings the sources of an application in the *sources
+application directory*, in order to compile them with the compile command.
+
+The sources can be prepared from VCS software (*cvs, svn, git*), an archive or a directory.
+
+.. warning:: When sat prepares a product, it first removes the
+ existing directory, except if the development mode is activated.
+ When you are working on a product, you need to declare in
+ the application configuration this product in **dev** mode.
+
+Remarks
+=======
+
+VCS bases (git, svn, cvs)
+-------------------------
+
+The *prepare* command does not manage authentication on the cvs server.
+For example, to prepare modules from a cvs server, you first need to login once.
+
+To avoid typing a password for each product,
+you may use a ssh key with passphrase, or store your password
+(in .cvspass or .gitconfig files).
+If you have security concerns, it is also possible to use
+a bash agent and type your password only once.
+
+
+
+Dev mode
+--------
+
+By default *prepare* uses *export* mode: it creates an image
+of the sources, corresponding to the tag or branch specified,
+without any link to the VCS base.
+To perform a *checkout* (svn, cvs) or a *git clone* (git),
+you need to declare the product in dev mode in your application configuration:
+edit the application configuration file (pyconf) and modify the product declaration:
+
+.. code-block:: bash
+
+ sat config <application> -e
+ # and edit the product section:
+ # <product> : {tag : "my_tag", dev : "yes", debug : "yes"}
+
+The first time you will execute the *sat prepare* command,
+your module will be downloaded in *checkout* mode
+(inside the SOURCES directory of the application.
+Then, you can develop in this repository, and finally push
+them in the base when they are ready.
+If you type during the development process by mistake
+a *sat prepare* command, the sources in dev mode will
+not be altered/removed (Unless you use -f option)
+
+
+Usage
+=====
+* Prepare the sources of a complete application in SOURCES directory (all products): ::
+
+ sat prepare <application>
+
+* Prepare only some modules: ::
+
+ sat prepare <application> --products <product1>,<product2> ...
+
+* Use --force to force to prepare the products in development mode
+ (this will remove the sources and do a new clone/checkout): ::
+
+ sat prepare <application> --force
+
+* Use --force_patch to force to apply patch to the products
+ in development mode (otherwise they are not applied): ::
+
+ sat prepare <application> --force_patch
+
+
+Some useful configuration pathes
+=================================
+
+Command *sat prepare* uses the *pyconf file configuration* of each product to know how to get the sources.
+
+.. note:: to verify configuration of a product, and get name of this *pyconf files configuration*
+
+ .. code-block :: bash
+
+ sat config <application> --info <product>
+
+
+* **get_method**: the method to use to prepare the module, possible values are cvs, git, archive, dir.
+* **git_info** : (used if get_method = git) information to prepare sources from git.
+* **svn_info** : (used if get_method = svn) information to prepare sources from cvs.
+* **cvs_info** : (used if get_method = cvs) information to prepare sources from cvs.
+* **archive_info** : (used if get_method = archive) the path to the archive.
+* **dir_info** : (used if get_method = dir) the directory with the sources.
+++ /dev/null
-*************
-Configuration
-*************
-
-*salomeTools* uses files to store its configuration parameters.
-
-There are several configuration files which are loaded by salomeTools in a specific order.
-When all the files are loaded a *config* object is created.
-Then, this object is passed to all command scripts.
-
-
-Syntax
-======
-The configuration files use a python-like structure format
-(see `config module <http://www.red-dove.com/config-doc/>`_ for a complete description).
-
-* **{}** define a dictionary,
-* **[]** define a list,
-* **@** can be used to include a file,
-* **$prefix** reference to another parameter (ex: ``$PRODUCT.name``),
-* **#** comments.
-
-.. note:: in this documentation a reference to a configuration parameter will be noted ``XXX.YYY``.
-
-Description
-===========
-
-.. _VARS-Section:
-
-VARS section
--------------
-| This section is dynamically created by salomeTools at run time.
-| It contains information about the environment: date, time, OS, architecture etc.
-
-::
-
- # to get the current setting
- sat config --value VARS
-
-PRODUCTS section
-------------------
-| This section is defined in the product file.
-| It contains instructions on how to build a version of SALOME (list of prerequisites-products and versions)
-
-::
-
- # to get the current setting
- sat config SALOME-xx --value PRODUCTS
-
-APPLICATION section
----------------------
-| This section is optional, it is also defined in the product file.
-| It gives additional parameters to create an application based on SALOME, as versions of products to use.
-
-::
-
- # to get the current setting
- sat config SALOME-xx --value APPLICATION
-
-
-.. _USER-Section:
-
-USER section
---------------
-This section is defined by the user configuration file,
-``~/.salomeTools/salomeTools.pyconf``.
-
-The ``USER`` section defines some parameters (not exhaustive):
-
-* **workDir** :
-
- | The working directory.
- | Each product will be usually installed here (in sub-directories).
-
-* **browser** : The web browser to use (*firefox*).
-
-* **editor** : The editor to use (*vi, pluma*).
-
-* and other user preferences.
-
-::
-
- # to get the current setting
- sat config SALOME-xx --value USER
-
-
-
-
--- /dev/null
+*************
+Configuration
+*************
+
+*salomeTools* uses files to store its configuration parameters.
+
+There are several configuration files which are loaded by salomeTools in a specific order.
+When all the files are loaded a *config* object is created.
+Then, this object is passed to all command scripts.
+
+
+Syntax
+======
+The configuration files use a python-like structure format
+(see `config module <http://www.red-dove.com/config-doc/>`_ for a complete description).
+
+* **{}** define a dictionary,
+* **[]** define a list,
+* **@** can be used to include a file,
+* **$prefix** reference to another parameter (ex: ``$PRODUCT.name``),
+* **#** comments.
+
+.. note:: in this documentation a reference to a configuration parameter will be noted ``XXX.YYY``.
+
+Description
+===========
+
+.. _VARS-Section:
+
+VARS section
+-------------
+| This section is dynamically created by salomeTools at run time.
+| It contains information about the environment: date, time, OS, architecture etc.
+
+::
+
+ # to get the current setting
+ sat config --value VARS
+
+PRODUCTS section
+------------------
+| This section is defined in the product file.
+| It contains instructions on how to build a version of SALOME (list of prerequisites-products and versions)
+
+::
+
+ # to get the current setting
+ sat config SALOME-xx --value PRODUCTS
+
+APPLICATION section
+---------------------
+| This section is optional, it is also defined in the product file.
+| It gives additional parameters to create an application based on SALOME, as versions of products to use.
+
+::
+
+ # to get the current setting
+ sat config SALOME-xx --value APPLICATION
+
+
+.. _USER-Section:
+
+USER section
+--------------
+This section is defined by the user configuration file,
+``~/.salomeTools/salomeTools.pyconf``.
+
+The ``USER`` section defines some parameters (not exhaustive):
+
+* **workDir** :
+
+ | The working directory.
+ | Each product will be usually installed here (in sub-directories).
+
+* **browser** : The web browser to use (*firefox*).
+
+* **editor** : The editor to use (*vi, pluma*).
+
+* and other user preferences.
+
+::
+
+ # to get the current setting
+ sat config SALOME-xx --value USER
+
+
+
+
+++ /dev/null
-
-.. include:: ../rst_prolog.rst
-
-.. empty first toctree is used for pdf contents maxdepth, see sphinx/builders/latex/__init__.py, toctrees[0].get('maxdepth')
-
-.. toctree::
- :maxdepth: 2
-
-************
-Salome Tools
-************
-
-.. image:: images/sat_about.png
- :scale: 100 %
- :align: center
-
-.. warning:: This documentation is under construction.
-
-The **Sa**\ lome\ **T**\ ools (sat) is a suite of commands
-that can be used to perform operations on SALOME_.
-
-For example, sat allows you to compile SALOME's codes
-(prerequisites, products)
-create application, run tests, create package, etc.
-
-This utility code is a set of Python_ scripts files.
-
-Find a `pdf version of this documentation <SatPdf_>`_
-
-
-Quick start
-===========
-
-.. toctree::
- :maxdepth: 1
-
- Installation of salomeTools <installation_of_sat>
- Configuration <configuration>
- Usage of salomeTools <usage_of_sat>
-
-List of Commands
-================
-
-.. toctree::
- :maxdepth: 1
-
- config <commands/config>
- prepare <commands/prepare>
- compile <commands/compile>
- launcher <commands/launcher>
- application <commands/application>
- log <commands/log>
- environ <commands/environ>
- clean <commands/clean>
- package <commands/package>
- generate <commands/generate>
-
-Developer documentation
-=======================
-
-.. toctree::
- :maxdepth: 1
-
- Add a command <write_command>
-
-
-Code documentation
-==================
-
-.. toctree::
- :maxdepth: 1
-
- SAT modules <commands/apidoc/modules.rst>
-
-
-Release Notes
-=============
-
-.. toctree::
- :maxdepth: 1
-
- Release Notes 5.0.0 <release_notes/release_notes_5.0.0>
-
--- /dev/null
+
+.. include:: ../rst_prolog.rst
+
+.. empty first toctree is used for pdf contents maxdepth, see sphinx/builders/latex/__init__.py, toctrees[0].get('maxdepth')
+
+.. toctree::
+ :maxdepth: 2
+
+************
+Salome Tools
+************
+
+.. image:: images/sat_about.png
+ :scale: 100 %
+ :align: center
+
+.. warning:: This documentation is under construction.
+
+The **Sa**\ lome\ **T**\ ools (sat) is a suite of commands
+that can be used to perform operations on SALOME_.
+
+For example, sat allows you to compile SALOME's codes
+(prerequisites, products)
+create application, run tests, create package, etc.
+
+This utility code is a set of Python_ scripts files.
+
+Find a `pdf version of this documentation <SatPdf_>`_
+
+
+Quick start
+===========
+
+.. toctree::
+ :maxdepth: 1
+
+ Installation of salomeTools <installation_of_sat>
+ Configuration <configuration>
+ Usage of salomeTools <usage_of_sat>
+
+List of Commands
+================
+
+.. toctree::
+ :maxdepth: 1
+
+ config <commands/config>
+ prepare <commands/prepare>
+ compile <commands/compile>
+ launcher <commands/launcher>
+ application <commands/application>
+ log <commands/log>
+ environ <commands/environ>
+ clean <commands/clean>
+ package <commands/package>
+ generate <commands/generate>
+
+Developer documentation
+=======================
+
+.. toctree::
+ :maxdepth: 1
+
+ Add a command <write_command>
+
+
+Code documentation
+==================
+
+.. toctree::
+ :maxdepth: 1
+
+ SAT modules <commands/apidoc/modules.rst>
+
+
+Release Notes
+=============
+
+.. toctree::
+ :maxdepth: 1
+
+ Release Notes 5.0.0 <release_notes/release_notes_5.0.0>
+
+++ /dev/null
-************
-Installation
-************
-
-Usually user could find (and use) command **sat** directly after a 'detar' installation of SALOME.
-
-.. code-block:: bash
-
- tar -xf .../SALOME_xx.tgz
- cd SALOME_xx
- ls -l sat # sat -> salomeTools/sat
-
-
-Python package (scripts of salomeTools) actually remains in directory *salomeTools*.
-
--- /dev/null
+************
+Installation
+************
+
+Usually user could find (and use) command **sat** directly after a 'detar' installation of SALOME.
+
+.. code-block:: bash
+
+ tar -xf .../SALOME_xx.tgz
+ cd SALOME_xx
+ ls -l sat # sat -> salomeTools/sat
+
+
+Python package (scripts of salomeTools) actually remains in directory *salomeTools*.
+
+++ /dev/null
-***************
-Release notes
-***************
-
-In construction.
--- /dev/null
+***************
+Release notes
+***************
+
+In construction.
+++ /dev/null
-
-.. include:: ../rst_prolog.rst
-
-********************
-Usage of SAlomeTools
-********************
-
-Usage
-=====
-sat usage is a Command Line Interface (CLI_).
-
-.. code-block:: bash
-
- sat [generic_options] [command] [product] [command_options]
-
-Options of sat
---------------
-
-Useful *not exhaustive* generic options of *sat* CLI.
-
-*--help or -h*
-...............
-
-Get help as simple text.
-
-.. code-block:: bash
-
- sat --help # get the list of existing commands
- sat --help compile # get the help on a specific command 'compile'
-
-
-*--debug or -g*
-................
-
-Execution in debug mode allows to see more trace and *stack* if an exception is raised.
-
-*--verbose or -v*
-..................
-
-Change verbosity level (default is 3).
-
-.. code-block:: bash
-
- # for product 'SALOME_xx' for example
- # execute compile command in debug mode with trace level 4
- sat -g -v 4 compile SALOME_xx
-
-
-Build a SALOME product
-======================
-
-Get the list of available products
-----------------------------------
-
-To get the list of the current available products in your context:
-
-.. code-block:: bash
-
- sat config --list
-
-Prepare sources of a product
-----------------------------
-
-To prepare (get) *all* the sources of a product (*SALOME_xx* for example):
-
-.. code-block:: bash
-
- sat prepare SALOME_xx
-
-| The sources are usually copied in directories
-| *$USER.workDir + SALOME_xx... + SOURCES + $PRODUCT.name*
-
-
-Compile SALOME
-----------------
-
-To compile products:
-
-.. code-block:: bash
-
- # compile all prerequisites/products
- sat compile SALOME_xx
-
- # compile only 2 products (KERNEL and SAMPLES), if not done yet
- sat compile SALOME_xx --products KERNEL,SAMPLES
-
- # compile only 2 products, unconditionaly
- sat compile SALOME_xx ---products SAMPLES --clean_all
-
-
-| The products are usually build in the directories
-| *$USER.workDir + SALOME_xx... + BUILD + $PRODUCT.name*
-|
-| The products are usually installed in the directories
-| *$USER.workDir + SALOME_xx... + INSTALL + $PRODUCT.name*
-
-
--- /dev/null
+
+.. include:: ../rst_prolog.rst
+
+********************
+Usage of SAlomeTools
+********************
+
+Usage
+=====
+sat usage is a Command Line Interface (CLI_).
+
+.. code-block:: bash
+
+ sat [generic_options] [command] [product] [command_options]
+
+Options of sat
+--------------
+
+Useful *not exhaustive* generic options of *sat* CLI.
+
+*--help or -h*
+...............
+
+Get help as simple text.
+
+.. code-block:: bash
+
+ sat --help # get the list of existing commands
+ sat --help compile # get the help on a specific command 'compile'
+
+
+*--debug or -g*
+................
+
+Execution in debug mode allows to see more trace and *stack* if an exception is raised.
+
+*--verbose or -v*
+..................
+
+Change verbosity level (default is 3).
+
+.. code-block:: bash
+
+ # for product 'SALOME_xx' for example
+ # execute compile command in debug mode with trace level 4
+ sat -g -v 4 compile SALOME_xx
+
+
+Build a SALOME product
+======================
+
+Get the list of available products
+----------------------------------
+
+To get the list of the current available products in your context:
+
+.. code-block:: bash
+
+ sat config --list
+
+Prepare sources of a product
+----------------------------
+
+To prepare (get) *all* the sources of a product (*SALOME_xx* for example):
+
+.. code-block:: bash
+
+ sat prepare SALOME_xx
+
+| The sources are usually copied in directories
+| *$USER.workDir + SALOME_xx... + SOURCES + $PRODUCT.name*
+
+
+Compile SALOME
+----------------
+
+To compile products:
+
+.. code-block:: bash
+
+ # compile all prerequisites/products
+ sat compile SALOME_xx
+
+ # compile only 2 products (KERNEL and SAMPLES), if not done yet
+ sat compile SALOME_xx --products KERNEL,SAMPLES
+
+ # compile only 2 products, unconditionaly
+ sat compile SALOME_xx ---products SAMPLES --clean_all
+
+
+| The products are usually build in the directories
+| *$USER.workDir + SALOME_xx... + BUILD + $PRODUCT.name*
+|
+| The products are usually installed in the directories
+| *$USER.workDir + SALOME_xx... + INSTALL + $PRODUCT.name*
+
+
+++ /dev/null
-
-.. include:: ../rst_prolog.rst
-
-
-Add a user custom command
-***************************
-
-Introduction
-============
-
-.. note:: This documentation is for Python_ developers.
-
-
-The salomeTools product provides a simple way to develop commands.
-The first thing to do is to add a file with *.py* extension in the ``commands`` directory of salomeTools.
-
-Here are the basic requirements that must be followed in this file in order to add a command.
-
-Basic requirements
-==================
-
-By adding a file *mycommand.py* in the ``commands`` directory, salomeTools will define a new command named ``mycommand``.
-
-In *mycommand.py*, there must be the following method: ::
-
- def run(args, runner, logger):
- # your algorithm ...
- pass
-
-In fact, at this point, the command will already be functional.
-But there are some useful services provided by salomeTools :
-
-* You can give some options to your command:
-
-.. code-block:: python
-
- import src
-
- # Define all possible option for mycommand command : 'sat mycommand <options>'
- parser = src.options.Options()
- parser.add_option('m', 'myoption', \
- 'boolean', 'myoption', \
- 'My option changes the behavior of my command.')
-
- def run(args, runner, logger):
- # Parse the options
- (options, args) = parser.parse_args(args)
- # algorithm
-
-
-* You can add a *description* method that will display a message when the user will call the help:
-
-
-.. code-block:: python
- :emphasize-lines: 9,10
-
- import src
-
- # Define all possible option for mycommand command : 'sat mycommand <options>'
- parser = src.options.Options()
- parser.add_option('m', 'myoption', \
- 'boolean', 'myoption', \
- 'My option changes the behavior of my command.')
-
- def description():
- return _("The help of mycommand.")
-
- def run(args, runner, logger):
- # Parse the options
- (options, args) = parser.parse_args(args)
- # algorithm
-
-HowTo access salomeTools config and other commands
-========================================================
-
-The *runner* variable is an python instance of *Sat* class.
-It gives access to *runner.cfg* which is the data model defined from all
-*configuration pyconf files* of salomeTools
-For example, *runner.cfg.APPLICATION.workdir*
-contains the root directory of the current application.
-
-The *runner* variable gives also access to other commands of salomeTools:
-
-.. code-block:: python
-
- # as CLI_ 'sat prepare ...'
- runner.prepare(runner.cfg.VARS.application)
-
-HowTo logger
-==============
-
-The logger variable is an instance of the Logger class.
-It gives access to the write method.
-
-When this method is called, the message passed as parameter
-will be displayed in the terminal and written in an xml log file.
-
-.. code-block:: python
-
- logger.write("My message", 3) # 3 as default
-
-The second argument defines the level of verbosity
-that is wanted for this message.
-It has to be between 1 and 5 (the most verbose level).
-
-HELLO example
-==============
-
-Here is a *hello* command, file *commands/hello.py*:
-
-.. code-block:: python
-
- import src
-
- """
- hello.py
- Define all possible options for hello command:
- sat hello <options>
- """
-
- parser = src.options.Options()
- parser.add_option('f', 'french', 'boolean', 'french', "french set hello message in french.")
-
- def description():
- return _("The help of hello.")
-
- def run(args, runner, logger):
- # Parse the options
- (options, args) = parser.parse_args(args)
- # algorithm
- if not options.french:
- logger.write('HELLO! WORLD!\n')
- else:
- logger.write('Bonjour tout le monde!\n')
-
-A first call of hello:
-
-.. code-block:: bash
-
- # Get the help of hello:
- ./sat --help hello
-
- # To get bonjour
- ./sat hello --french
- Bonjour tout le monde!
-
- # To get hello
- ./sat hello
- HELLO! WORLD!
-
- # To get the log
- ./sat log
-
-
-
-
-
--- /dev/null
+
+.. include:: ../rst_prolog.rst
+
+
+Add a user custom command
+***************************
+
+Introduction
+============
+
+.. note:: This documentation is for Python_ developers.
+
+
+The salomeTools product provides a simple way to develop commands.
+The first thing to do is to add a file with *.py* extension in the ``commands`` directory of salomeTools.
+
+Here are the basic requirements that must be followed in this file in order to add a command.
+
+Basic requirements
+==================
+
+.. warning:: ALL THIS IS OBSOLETE FOR SAT 5.1
+
+By adding a file *mycommand.py* in the ``commands`` directory, salomeTools will define a new command named ``mycommand``.
+
+In *mycommand.py*, there must be the following method: ::
+
+ def run(args, runner, logger):
+ # your algorithm ...
+ pass
+
+In fact, at this point, the command will already be functional.
+But there are some useful services provided by salomeTools :
+
+* You can give some options to your command:
+
+.. code-block:: python
+
+ import src
+
+ # Define all possible option for mycommand command : 'sat mycommand <options>'
+ parser = src.options.Options()
+ parser.add_option('m', 'myoption', \
+ 'boolean', 'myoption', \
+ 'My option changes the behavior of my command.')
+
+ def run(args, runner, logger):
+ # Parse the options
+ (options, args) = parser.parse_args(args)
+ # algorithm
+
+
+* You can add a *description* method that will display a message when the user will call the help:
+
+
+.. code-block:: python
+ :emphasize-lines: 9,10
+
+ import src
+
+ # Define all possible option for mycommand command : 'sat mycommand <options>'
+ parser = src.options.Options()
+ parser.add_option('m', 'myoption', \
+ 'boolean', 'myoption', \
+ 'My option changes the behavior of my command.')
+
+ def description():
+ return _("The help of mycommand.")
+
+ def run(args, runner, logger):
+ # Parse the options
+ (options, args) = parser.parse_args(args)
+ # algorithm
+
+HowTo access salomeTools config and other commands
+========================================================
+
+The *runner* variable is an python instance of *Sat* class.
+It gives access to *runner.getConfig()* which is the data model defined from all
+*configuration pyconf files* of salomeTools
+For example, *runner.cfg.APPLICATION.workdir*
+contains the root directory of the current application.
+
+The *runner* variable gives also access to other commands of salomeTools:
+
+.. code-block:: python
+
+ # as CLI_ 'sat prepare ...'
+ runner.prepare(runner.cfg.VARS.application)
+
+HowTo logger
+==============
+
+The logger variable is an instance of the python ``logging`` package class.
+It gives access to ``debug, info, warning, error, critical`` methods.
+
+Using these methods, the message passed as parameter
+will be displayed in the terminal and written in an xml log file.
+
+.. code-block:: python
+
+ logger.info("My message")
+
+
+HELLO example
+==============
+
+Here is a *hello* command, file *commands/hello.py*:
+
+.. code-block:: python
+
+ import src
+
+ """
+ hello.py
+ Define all possible options for hello command:
+ sat hello <options>
+ """
+
+ parser = src.options.Options()
+ parser.add_option('f', 'french', 'boolean', 'french', "french set hello message in french.")
+
+ def description():
+ return _("The help of hello.")
+
+ def run(args, runner, logger):
+ # Parse the options
+ (options, args) = parser.parse_args(args)
+ # algorithm
+ if not options.french:
+ logger.write('HELLO! WORLD!\n')
+ else:
+ logger.write('Bonjour tout le monde!\n')
+
+A first call of hello:
+
+.. code-block:: bash
+
+ # Get the help of hello:
+ ./sat --help hello
+
+ # To get bonjour
+ ./sat hello --french
+ Bonjour tout le monde!
+
+ # To get hello
+ ./sat hello
+ HELLO! WORLD!
+
+ # To get the log
+ ./sat log
+
+
+
+
+
*
* Sphinx stylesheet -- basic theme.
*
- * :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
}
div.sphinxsidebar #searchbox input[type="text"] {
- float: left;
- width: 80%;
- padding: 0.25em;
- box-sizing: border-box;
-}
-
-div.sphinxsidebar #searchbox input[type="submit"] {
- float: left;
- width: 20%;
- border-left: none;
- padding: 0.25em;
- box-sizing: border-box;
+ width: 170px;
}
-
img {
border: 0;
max-width: 100%;
table.contentstable {
width: 90%;
- margin-left: auto;
- margin-right: auto;
}
table.contentstable p.biglink {
vertical-align: top;
}
-table.indextable ul {
+table.indextable dl, table.indextable dd {
margin-top: 0;
margin-bottom: 0;
- list-style-type: none;
-}
-
-table.indextable > tbody > tr > td > ul {
- padding-left: 0em;
}
table.indextable tr.pcap {
padding: 0.4em;
}
-/* -- domain module index --------------------------------------------------- */
-
-table.modindextable td {
- padding: 2px;
- border-collapse: collapse;
-}
-
/* -- general body styles --------------------------------------------------- */
-div.body {
- min-width: 450px;
- max-width: 800px;
-}
-
div.body p, div.body dd, div.body li, div.body blockquote {
-moz-hyphens: auto;
-ms-hyphens: auto;
text-align: left;
}
+.field-list ul {
+ padding-left: 1em;
+}
+
.first {
margin-top: 0 !important;
}
border-collapse: collapse;
}
-table.align-center {
- margin-left: auto;
- margin-right: auto;
-}
-
table caption span.caption-number {
font-style: italic;
}
border-bottom: 1px solid #aaa;
}
+table.field-list td, table.field-list th {
+ border: 0 !important;
+}
+
table.footnote td, table.footnote th {
border: 0 !important;
}
div.figure p.caption span.caption-text {
}
-/* -- field list styles ----------------------------------------------------- */
-
-table.field-list td, table.field-list th {
- border: 0 !important;
-}
-
-.field-list ul {
- margin: 0;
- padding-left: 1em;
-}
-
-.field-list p {
- margin: 0;
-}
-
-.field-name {
- -moz-hyphens: manual;
- -ms-hyphens: manual;
- -webkit-hyphens: manual;
- hyphens: manual;
-}
/* -- other body styles ----------------------------------------------------- */
margin-left: 30px;
}
-dt:target, span.highlighted {
+dt:target, .highlighted {
background-color: #fbe54e;
}
-rect.highlighted {
- fill: #fbe54e;
-}
-
dl.glossary dt {
font-weight: bold;
font-size: 1.1em;
}
+.field-list ul {
+ margin: 0;
+ padding-left: 1em;
+}
+
+.field-list p {
+ margin: 0;
+}
+
.optional {
font-size: 1.3em;
}
float: right;
}
-span.eqno a.headerlink {
- position: relative;
- left: 0px;
- z-index: 1;
-}
-
-div.math:hover a.headerlink {
- visibility: visible;
-}
-
/* -- printout stylesheet --------------------------------------------------- */
@media print {
*
* Sphinx JavaScript utilities for all documentation.
*
- * :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
* it will always return arrays of strings for the value parts.
*/
jQuery.getQueryParameters = function(s) {
- if (typeof s === 'undefined')
+ if (typeof s == 'undefined')
s = document.location.search;
var parts = s.substr(s.indexOf('?') + 1).split('&');
var result = {};
* span elements with the given class name.
*/
jQuery.fn.highlightText = function(text, className) {
- function highlight(node, addItems) {
- if (node.nodeType === 3) {
+ function highlight(node) {
+ if (node.nodeType == 3) {
var val = node.nodeValue;
var pos = val.toLowerCase().indexOf(text);
- if (pos >= 0 &&
- !jQuery(node.parentNode).hasClass(className) &&
- !jQuery(node.parentNode).hasClass("nohighlight")) {
- var span;
- var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
- if (isInSVG) {
- span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
- } else {
- span = document.createElement("span");
- span.className = className;
- }
+ if (pos >= 0 && !jQuery(node.parentNode).hasClass(className)) {
+ var span = document.createElement("span");
+ span.className = className;
span.appendChild(document.createTextNode(val.substr(pos, text.length)));
node.parentNode.insertBefore(span, node.parentNode.insertBefore(
document.createTextNode(val.substr(pos + text.length)),
node.nextSibling));
node.nodeValue = val.substr(0, pos);
- if (isInSVG) {
- var bbox = span.getBBox();
- var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
- rect.x.baseVal.value = bbox.x;
- rect.y.baseVal.value = bbox.y;
- rect.width.baseVal.value = bbox.width;
- rect.height.baseVal.value = bbox.height;
- rect.setAttribute('class', className);
- var parentOfText = node.parentNode.parentNode;
- addItems.push({
- "parent": node.parentNode,
- "target": rect});
- }
}
}
else if (!jQuery(node).is("button, select, textarea")) {
jQuery.each(node.childNodes, function() {
- highlight(this, addItems);
+ highlight(this);
});
}
}
- var addItems = [];
- var result = this.each(function() {
- highlight(this, addItems);
+ return this.each(function() {
+ highlight(this);
});
- for (var i = 0; i < addItems.length; ++i) {
- jQuery(addItems[i].parent).before(addItems[i].target);
- }
- return result;
};
/*
* i18n support
*/
TRANSLATIONS : {},
- PLURAL_EXPR : function(n) { return n === 1 ? 0 : 1; },
+ PLURAL_EXPR : function(n) { return n == 1 ? 0 : 1; },
LOCALE : 'unknown',
// gettext and ngettext don't access this so that the functions
// can safely bound to a different name (_ = Documentation.gettext)
gettext : function(string) {
var translated = Documentation.TRANSLATIONS[string];
- if (typeof translated === 'undefined')
+ if (typeof translated == 'undefined')
return string;
- return (typeof translated === 'string') ? translated : translated[0];
+ return (typeof translated == 'string') ? translated : translated[0];
},
ngettext : function(singular, plural, n) {
var translated = Documentation.TRANSLATIONS[singular];
- if (typeof translated === 'undefined')
+ if (typeof translated == 'undefined')
return (n == 1) ? singular : plural;
return translated[Documentation.PLURALEXPR(n)];
},
* see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075
*/
fixFirefoxAnchorBug : function() {
- if (document.location.hash && $.browser.mozilla)
+ if (document.location.hash)
window.setTimeout(function() {
document.location.href += '';
}, 10);
var src = $(this).attr('src');
var idnum = $(this).attr('id').substr(7);
$('tr.cg-' + idnum).toggle();
- if (src.substr(-9) === 'minus.png')
+ if (src.substr(-9) == 'minus.png')
$(this).attr('src', src.substr(0, src.length-9) + 'plus.png');
else
$(this).attr('src', src.substr(0, src.length-8) + 'minus.png');
var path = document.location.pathname;
var parts = path.split(/\//);
$.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() {
- if (this === '..')
+ if (this == '..')
parts.pop();
});
var url = parts.join('/');
+++ /dev/null
-var DOCUMENTATION_OPTIONS = {
- URL_ROOT: '',
- VERSION: '5.0.0dev',
- LANGUAGE: 'None',
- COLLAPSE_INDEX: false,
- FILE_SUFFIX: '.html',
- HAS_SOURCE: true,
- SOURCELINK_SUFFIX: '.txt'
-};
\ No newline at end of file
+++ /dev/null
-/*!
- * jQuery JavaScript Library v3.2.1
- * https://jquery.com/
- *
- * Includes Sizzle.js
- * https://sizzlejs.com/
- *
- * Copyright JS Foundation and other contributors
- * Released under the MIT license
- * https://jquery.org/license
- *
- * Date: 2017-03-20T18:59Z
- */
-( function( global, factory ) {
-
- "use strict";
-
- if ( typeof module === "object" && typeof module.exports === "object" ) {
-
- // For CommonJS and CommonJS-like environments where a proper `window`
- // is present, execute the factory and get jQuery.
- // For environments that do not have a `window` with a `document`
- // (such as Node.js), expose a factory as module.exports.
- // This accentuates the need for the creation of a real `window`.
- // e.g. var jQuery = require("jquery")(window);
- // See ticket #14549 for more info.
- module.exports = global.document ?
- factory( global, true ) :
- function( w ) {
- if ( !w.document ) {
- throw new Error( "jQuery requires a window with a document" );
- }
- return factory( w );
- };
- } else {
- factory( global );
- }
-
-// Pass this if window is not defined yet
-} )( typeof window !== "undefined" ? window : this, function( window, noGlobal ) {
-
-// Edge <= 12 - 13+, Firefox <=18 - 45+, IE 10 - 11, Safari 5.1 - 9+, iOS 6 - 9.1
-// throw exceptions when non-strict code (e.g., ASP.NET 4.5) accesses strict mode
-// arguments.callee.caller (trac-13335). But as of jQuery 3.0 (2016), strict mode should be common
-// enough that all such attempts are guarded in a try block.
-"use strict";
-
-var arr = [];
-
-var document = window.document;
-
-var getProto = Object.getPrototypeOf;
-
-var slice = arr.slice;
-
-var concat = arr.concat;
-
-var push = arr.push;
-
-var indexOf = arr.indexOf;
-
-var class2type = {};
-
-var toString = class2type.toString;
-
-var hasOwn = class2type.hasOwnProperty;
-
-var fnToString = hasOwn.toString;
-
-var ObjectFunctionString = fnToString.call( Object );
-
-var support = {};
-
-
-
- function DOMEval( code, doc ) {
- doc = doc || document;
-
- var script = doc.createElement( "script" );
-
- script.text = code;
- doc.head.appendChild( script ).parentNode.removeChild( script );
- }
-/* global Symbol */
-// Defining this global in .eslintrc.json would create a danger of using the global
-// unguarded in another place, it seems safer to define global only for this module
-
-
-
-var
- version = "3.2.1",
-
- // Define a local copy of jQuery
- jQuery = function( selector, context ) {
-
- // The jQuery object is actually just the init constructor 'enhanced'
- // Need init if jQuery is called (just allow error to be thrown if not included)
- return new jQuery.fn.init( selector, context );
- },
-
- // Support: Android <=4.0 only
- // Make sure we trim BOM and NBSP
- rtrim = /^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g,
-
- // Matches dashed string for camelizing
- rmsPrefix = /^-ms-/,
- rdashAlpha = /-([a-z])/g,
-
- // Used by jQuery.camelCase as callback to replace()
- fcamelCase = function( all, letter ) {
- return letter.toUpperCase();
- };
-
-jQuery.fn = jQuery.prototype = {
-
- // The current version of jQuery being used
- jquery: version,
-
- constructor: jQuery,
-
- // The default length of a jQuery object is 0
- length: 0,
-
- toArray: function() {
- return slice.call( this );
- },
-
- // Get the Nth element in the matched element set OR
- // Get the whole matched element set as a clean array
- get: function( num ) {
-
- // Return all the elements in a clean array
- if ( num == null ) {
- return slice.call( this );
- }
-
- // Return just the one element from the set
- return num < 0 ? this[ num + this.length ] : this[ num ];
- },
-
- // Take an array of elements and push it onto the stack
- // (returning the new matched element set)
- pushStack: function( elems ) {
-
- // Build a new jQuery matched element set
- var ret = jQuery.merge( this.constructor(), elems );
-
- // Add the old object onto the stack (as a reference)
- ret.prevObject = this;
-
- // Return the newly-formed element set
- return ret;
- },
-
- // Execute a callback for every element in the matched set.
- each: function( callback ) {
- return jQuery.each( this, callback );
- },
-
- map: function( callback ) {
- return this.pushStack( jQuery.map( this, function( elem, i ) {
- return callback.call( elem, i, elem );
- } ) );
- },
-
- slice: function() {
- return this.pushStack( slice.apply( this, arguments ) );
- },
-
- first: function() {
- return this.eq( 0 );
- },
-
- last: function() {
- return this.eq( -1 );
- },
-
- eq: function( i ) {
- var len = this.length,
- j = +i + ( i < 0 ? len : 0 );
- return this.pushStack( j >= 0 && j < len ? [ this[ j ] ] : [] );
- },
-
- end: function() {
- return this.prevObject || this.constructor();
- },
-
- // For internal use only.
- // Behaves like an Array's method, not like a jQuery method.
- push: push,
- sort: arr.sort,
- splice: arr.splice
-};
-
-jQuery.extend = jQuery.fn.extend = function() {
- var options, name, src, copy, copyIsArray, clone,
- target = arguments[ 0 ] || {},
- i = 1,
- length = arguments.length,
- deep = false;
-
- // Handle a deep copy situation
- if ( typeof target === "boolean" ) {
- deep = target;
-
- // Skip the boolean and the target
- target = arguments[ i ] || {};
- i++;
- }
-
- // Handle case when target is a string or something (possible in deep copy)
- if ( typeof target !== "object" && !jQuery.isFunction( target ) ) {
- target = {};
- }
-
- // Extend jQuery itself if only one argument is passed
- if ( i === length ) {
- target = this;
- i--;
- }
-
- for ( ; i < length; i++ ) {
-
- // Only deal with non-null/undefined values
- if ( ( options = arguments[ i ] ) != null ) {
-
- // Extend the base object
- for ( name in options ) {
- src = target[ name ];
- copy = options[ name ];
-
- // Prevent never-ending loop
- if ( target === copy ) {
- continue;
- }
-
- // Recurse if we're merging plain objects or arrays
- if ( deep && copy && ( jQuery.isPlainObject( copy ) ||
- ( copyIsArray = Array.isArray( copy ) ) ) ) {
-
- if ( copyIsArray ) {
- copyIsArray = false;
- clone = src && Array.isArray( src ) ? src : [];
-
- } else {
- clone = src && jQuery.isPlainObject( src ) ? src : {};
- }
-
- // Never move original objects, clone them
- target[ name ] = jQuery.extend( deep, clone, copy );
-
- // Don't bring in undefined values
- } else if ( copy !== undefined ) {
- target[ name ] = copy;
- }
- }
- }
- }
-
- // Return the modified object
- return target;
-};
-
-jQuery.extend( {
-
- // Unique for each copy of jQuery on the page
- expando: "jQuery" + ( version + Math.random() ).replace( /\D/g, "" ),
-
- // Assume jQuery is ready without the ready module
- isReady: true,
-
- error: function( msg ) {
- throw new Error( msg );
- },
-
- noop: function() {},
-
- isFunction: function( obj ) {
- return jQuery.type( obj ) === "function";
- },
-
- isWindow: function( obj ) {
- return obj != null && obj === obj.window;
- },
-
- isNumeric: function( obj ) {
-
- // As of jQuery 3.0, isNumeric is limited to
- // strings and numbers (primitives or objects)
- // that can be coerced to finite numbers (gh-2662)
- var type = jQuery.type( obj );
- return ( type === "number" || type === "string" ) &&
-
- // parseFloat NaNs numeric-cast false positives ("")
- // ...but misinterprets leading-number strings, particularly hex literals ("0x...")
- // subtraction forces infinities to NaN
- !isNaN( obj - parseFloat( obj ) );
- },
-
- isPlainObject: function( obj ) {
- var proto, Ctor;
-
- // Detect obvious negatives
- // Use toString instead of jQuery.type to catch host objects
- if ( !obj || toString.call( obj ) !== "[object Object]" ) {
- return false;
- }
-
- proto = getProto( obj );
-
- // Objects with no prototype (e.g., `Object.create( null )`) are plain
- if ( !proto ) {
- return true;
- }
-
- // Objects with prototype are plain iff they were constructed by a global Object function
- Ctor = hasOwn.call( proto, "constructor" ) && proto.constructor;
- return typeof Ctor === "function" && fnToString.call( Ctor ) === ObjectFunctionString;
- },
-
- isEmptyObject: function( obj ) {
-
- /* eslint-disable no-unused-vars */
- // See https://github.com/eslint/eslint/issues/6125
- var name;
-
- for ( name in obj ) {
- return false;
- }
- return true;
- },
-
- type: function( obj ) {
- if ( obj == null ) {
- return obj + "";
- }
-
- // Support: Android <=2.3 only (functionish RegExp)
- return typeof obj === "object" || typeof obj === "function" ?
- class2type[ toString.call( obj ) ] || "object" :
- typeof obj;
- },
-
- // Evaluates a script in a global context
- globalEval: function( code ) {
- DOMEval( code );
- },
-
- // Convert dashed to camelCase; used by the css and data modules
- // Support: IE <=9 - 11, Edge 12 - 13
- // Microsoft forgot to hump their vendor prefix (#9572)
- camelCase: function( string ) {
- return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase );
- },
-
- each: function( obj, callback ) {
- var length, i = 0;
-
- if ( isArrayLike( obj ) ) {
- length = obj.length;
- for ( ; i < length; i++ ) {
- if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) {
- break;
- }
- }
- } else {
- for ( i in obj ) {
- if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) {
- break;
- }
- }
- }
-
- return obj;
- },
-
- // Support: Android <=4.0 only
- trim: function( text ) {
- return text == null ?
- "" :
- ( text + "" ).replace( rtrim, "" );
- },
-
- // results is for internal usage only
- makeArray: function( arr, results ) {
- var ret = results || [];
-
- if ( arr != null ) {
- if ( isArrayLike( Object( arr ) ) ) {
- jQuery.merge( ret,
- typeof arr === "string" ?
- [ arr ] : arr
- );
- } else {
- push.call( ret, arr );
- }
- }
-
- return ret;
- },
-
- inArray: function( elem, arr, i ) {
- return arr == null ? -1 : indexOf.call( arr, elem, i );
- },
-
- // Support: Android <=4.0 only, PhantomJS 1 only
- // push.apply(_, arraylike) throws on ancient WebKit
- merge: function( first, second ) {
- var len = +second.length,
- j = 0,
- i = first.length;
-
- for ( ; j < len; j++ ) {
- first[ i++ ] = second[ j ];
- }
-
- first.length = i;
-
- return first;
- },
-
- grep: function( elems, callback, invert ) {
- var callbackInverse,
- matches = [],
- i = 0,
- length = elems.length,
- callbackExpect = !invert;
-
- // Go through the array, only saving the items
- // that pass the validator function
- for ( ; i < length; i++ ) {
- callbackInverse = !callback( elems[ i ], i );
- if ( callbackInverse !== callbackExpect ) {
- matches.push( elems[ i ] );
- }
- }
-
- return matches;
- },
-
- // arg is for internal usage only
- map: function( elems, callback, arg ) {
- var length, value,
- i = 0,
- ret = [];
-
- // Go through the array, translating each of the items to their new values
- if ( isArrayLike( elems ) ) {
- length = elems.length;
- for ( ; i < length; i++ ) {
- value = callback( elems[ i ], i, arg );
-
- if ( value != null ) {
- ret.push( value );
- }
- }
-
- // Go through every key on the object,
- } else {
- for ( i in elems ) {
- value = callback( elems[ i ], i, arg );
-
- if ( value != null ) {
- ret.push( value );
- }
- }
- }
-
- // Flatten any nested arrays
- return concat.apply( [], ret );
- },
-
- // A global GUID counter for objects
- guid: 1,
-
- // Bind a function to a context, optionally partially applying any
- // arguments.
- proxy: function( fn, context ) {
- var tmp, args, proxy;
-
- if ( typeof context === "string" ) {
- tmp = fn[ context ];
- context = fn;
- fn = tmp;
- }
-
- // Quick check to determine if target is callable, in the spec
- // this throws a TypeError, but we will just return undefined.
- if ( !jQuery.isFunction( fn ) ) {
- return undefined;
- }
-
- // Simulated bind
- args = slice.call( arguments, 2 );
- proxy = function() {
- return fn.apply( context || this, args.concat( slice.call( arguments ) ) );
- };
-
- // Set the guid of unique handler to the same of original handler, so it can be removed
- proxy.guid = fn.guid = fn.guid || jQuery.guid++;
-
- return proxy;
- },
-
- now: Date.now,
-
- // jQuery.support is not used in Core but other projects attach their
- // properties to it so it needs to exist.
- support: support
-} );
-
-if ( typeof Symbol === "function" ) {
- jQuery.fn[ Symbol.iterator ] = arr[ Symbol.iterator ];
-}
-
-// Populate the class2type map
-jQuery.each( "Boolean Number String Function Array Date RegExp Object Error Symbol".split( " " ),
-function( i, name ) {
- class2type[ "[object " + name + "]" ] = name.toLowerCase();
-} );
-
-function isArrayLike( obj ) {
-
- // Support: real iOS 8.2 only (not reproducible in simulator)
- // `in` check used to prevent JIT error (gh-2145)
- // hasOwn isn't used here due to false negatives
- // regarding Nodelist length in IE
- var length = !!obj && "length" in obj && obj.length,
- type = jQuery.type( obj );
-
- if ( type === "function" || jQuery.isWindow( obj ) ) {
- return false;
- }
-
- return type === "array" || length === 0 ||
- typeof length === "number" && length > 0 && ( length - 1 ) in obj;
-}
-var Sizzle =
-/*!
- * Sizzle CSS Selector Engine v2.3.3
- * https://sizzlejs.com/
- *
- * Copyright jQuery Foundation and other contributors
- * Released under the MIT license
- * http://jquery.org/license
- *
- * Date: 2016-08-08
- */
-(function( window ) {
-
-var i,
- support,
- Expr,
- getText,
- isXML,
- tokenize,
- compile,
- select,
- outermostContext,
- sortInput,
- hasDuplicate,
-
- // Local document vars
- setDocument,
- document,
- docElem,
- documentIsHTML,
- rbuggyQSA,
- rbuggyMatches,
- matches,
- contains,
-
- // Instance-specific data
- expando = "sizzle" + 1 * new Date(),
- preferredDoc = window.document,
- dirruns = 0,
- done = 0,
- classCache = createCache(),
- tokenCache = createCache(),
- compilerCache = createCache(),
- sortOrder = function( a, b ) {
- if ( a === b ) {
- hasDuplicate = true;
- }
- return 0;
- },
-
- // Instance methods
- hasOwn = ({}).hasOwnProperty,
- arr = [],
- pop = arr.pop,
- push_native = arr.push,
- push = arr.push,
- slice = arr.slice,
- // Use a stripped-down indexOf as it's faster than native
- // https://jsperf.com/thor-indexof-vs-for/5
- indexOf = function( list, elem ) {
- var i = 0,
- len = list.length;
- for ( ; i < len; i++ ) {
- if ( list[i] === elem ) {
- return i;
- }
- }
- return -1;
- },
-
- booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|ismap|loop|multiple|open|readonly|required|scoped",
-
- // Regular expressions
-
- // http://www.w3.org/TR/css3-selectors/#whitespace
- whitespace = "[\\x20\\t\\r\\n\\f]",
-
- // http://www.w3.org/TR/CSS21/syndata.html#value-def-identifier
- identifier = "(?:\\\\.|[\\w-]|[^\0-\\xa0])+",
-
- // Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors
- attributes = "\\[" + whitespace + "*(" + identifier + ")(?:" + whitespace +
- // Operator (capture 2)
- "*([*^$|!~]?=)" + whitespace +
- // "Attribute values must be CSS identifiers [capture 5] or strings [capture 3 or capture 4]"
- "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" + whitespace +
- "*\\]",
-
- pseudos = ":(" + identifier + ")(?:\\((" +
- // To reduce the number of selectors needing tokenize in the preFilter, prefer arguments:
- // 1. quoted (capture 3; capture 4 or capture 5)
- "('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|" +
- // 2. simple (capture 6)
- "((?:\\\\.|[^\\\\()[\\]]|" + attributes + ")*)|" +
- // 3. anything else (capture 2)
- ".*" +
- ")\\)|)",
-
- // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter
- rwhitespace = new RegExp( whitespace + "+", "g" ),
- rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + whitespace + "+$", "g" ),
-
- rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ),
- rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace + "*" ),
-
- rattributeQuotes = new RegExp( "=" + whitespace + "*([^\\]'\"]*?)" + whitespace + "*\\]", "g" ),
-
- rpseudo = new RegExp( pseudos ),
- ridentifier = new RegExp( "^" + identifier + "$" ),
-
- matchExpr = {
- "ID": new RegExp( "^#(" + identifier + ")" ),
- "CLASS": new RegExp( "^\\.(" + identifier + ")" ),
- "TAG": new RegExp( "^(" + identifier + "|[*])" ),
- "ATTR": new RegExp( "^" + attributes ),
- "PSEUDO": new RegExp( "^" + pseudos ),
- "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" + whitespace +
- "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" + whitespace +
- "*(\\d+)|))" + whitespace + "*\\)|)", "i" ),
- "bool": new RegExp( "^(?:" + booleans + ")$", "i" ),
- // For use in libraries implementing .is()
- // We use this for POS matching in `select`
- "needsContext": new RegExp( "^" + whitespace + "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" +
- whitespace + "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" )
- },
-
- rinputs = /^(?:input|select|textarea|button)$/i,
- rheader = /^h\d$/i,
-
- rnative = /^[^{]+\{\s*\[native \w/,
-
- // Easily-parseable/retrievable ID or TAG or CLASS selectors
- rquickExpr = /^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,
-
- rsibling = /[+~]/,
-
- // CSS escapes
- // http://www.w3.org/TR/CSS21/syndata.html#escaped-characters
- runescape = new RegExp( "\\\\([\\da-f]{1,6}" + whitespace + "?|(" + whitespace + ")|.)", "ig" ),
- funescape = function( _, escaped, escapedWhitespace ) {
- var high = "0x" + escaped - 0x10000;
- // NaN means non-codepoint
- // Support: Firefox<24
- // Workaround erroneous numeric interpretation of +"0x"
- return high !== high || escapedWhitespace ?
- escaped :
- high < 0 ?
- // BMP codepoint
- String.fromCharCode( high + 0x10000 ) :
- // Supplemental Plane codepoint (surrogate pair)
- String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 );
- },
-
- // CSS string/identifier serialization
- // https://drafts.csswg.org/cssom/#common-serializing-idioms
- rcssescape = /([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,
- fcssescape = function( ch, asCodePoint ) {
- if ( asCodePoint ) {
-
- // U+0000 NULL becomes U+FFFD REPLACEMENT CHARACTER
- if ( ch === "\0" ) {
- return "\uFFFD";
- }
-
- // Control characters and (dependent upon position) numbers get escaped as code points
- return ch.slice( 0, -1 ) + "\\" + ch.charCodeAt( ch.length - 1 ).toString( 16 ) + " ";
- }
-
- // Other potentially-special ASCII characters get backslash-escaped
- return "\\" + ch;
- },
-
- // Used for iframes
- // See setDocument()
- // Removing the function wrapper causes a "Permission Denied"
- // error in IE
- unloadHandler = function() {
- setDocument();
- },
-
- disabledAncestor = addCombinator(
- function( elem ) {
- return elem.disabled === true && ("form" in elem || "label" in elem);
- },
- { dir: "parentNode", next: "legend" }
- );
-
-// Optimize for push.apply( _, NodeList )
-try {
- push.apply(
- (arr = slice.call( preferredDoc.childNodes )),
- preferredDoc.childNodes
- );
- // Support: Android<4.0
- // Detect silently failing push.apply
- arr[ preferredDoc.childNodes.length ].nodeType;
-} catch ( e ) {
- push = { apply: arr.length ?
-
- // Leverage slice if possible
- function( target, els ) {
- push_native.apply( target, slice.call(els) );
- } :
-
- // Support: IE<9
- // Otherwise append directly
- function( target, els ) {
- var j = target.length,
- i = 0;
- // Can't trust NodeList.length
- while ( (target[j++] = els[i++]) ) {}
- target.length = j - 1;
- }
- };
-}
-
-function Sizzle( selector, context, results, seed ) {
- var m, i, elem, nid, match, groups, newSelector,
- newContext = context && context.ownerDocument,
-
- // nodeType defaults to 9, since context defaults to document
- nodeType = context ? context.nodeType : 9;
-
- results = results || [];
-
- // Return early from calls with invalid selector or context
- if ( typeof selector !== "string" || !selector ||
- nodeType !== 1 && nodeType !== 9 && nodeType !== 11 ) {
-
- return results;
- }
-
- // Try to shortcut find operations (as opposed to filters) in HTML documents
- if ( !seed ) {
-
- if ( ( context ? context.ownerDocument || context : preferredDoc ) !== document ) {
- setDocument( context );
- }
- context = context || document;
-
- if ( documentIsHTML ) {
-
- // If the selector is sufficiently simple, try using a "get*By*" DOM method
- // (excepting DocumentFragment context, where the methods don't exist)
- if ( nodeType !== 11 && (match = rquickExpr.exec( selector )) ) {
-
- // ID selector
- if ( (m = match[1]) ) {
-
- // Document context
- if ( nodeType === 9 ) {
- if ( (elem = context.getElementById( m )) ) {
-
- // Support: IE, Opera, Webkit
- // TODO: identify versions
- // getElementById can match elements by name instead of ID
- if ( elem.id === m ) {
- results.push( elem );
- return results;
- }
- } else {
- return results;
- }
-
- // Element context
- } else {
-
- // Support: IE, Opera, Webkit
- // TODO: identify versions
- // getElementById can match elements by name instead of ID
- if ( newContext && (elem = newContext.getElementById( m )) &&
- contains( context, elem ) &&
- elem.id === m ) {
-
- results.push( elem );
- return results;
- }
- }
-
- // Type selector
- } else if ( match[2] ) {
- push.apply( results, context.getElementsByTagName( selector ) );
- return results;
-
- // Class selector
- } else if ( (m = match[3]) && support.getElementsByClassName &&
- context.getElementsByClassName ) {
-
- push.apply( results, context.getElementsByClassName( m ) );
- return results;
- }
- }
-
- // Take advantage of querySelectorAll
- if ( support.qsa &&
- !compilerCache[ selector + " " ] &&
- (!rbuggyQSA || !rbuggyQSA.test( selector )) ) {
-
- if ( nodeType !== 1 ) {
- newContext = context;
- newSelector = selector;
-
- // qSA looks outside Element context, which is not what we want
- // Thanks to Andrew Dupont for this workaround technique
- // Support: IE <=8
- // Exclude object elements
- } else if ( context.nodeName.toLowerCase() !== "object" ) {
-
- // Capture the context ID, setting it first if necessary
- if ( (nid = context.getAttribute( "id" )) ) {
- nid = nid.replace( rcssescape, fcssescape );
- } else {
- context.setAttribute( "id", (nid = expando) );
- }
-
- // Prefix every selector in the list
- groups = tokenize( selector );
- i = groups.length;
- while ( i-- ) {
- groups[i] = "#" + nid + " " + toSelector( groups[i] );
- }
- newSelector = groups.join( "," );
-
- // Expand context for sibling selectors
- newContext = rsibling.test( selector ) && testContext( context.parentNode ) ||
- context;
- }
-
- if ( newSelector ) {
- try {
- push.apply( results,
- newContext.querySelectorAll( newSelector )
- );
- return results;
- } catch ( qsaError ) {
- } finally {
- if ( nid === expando ) {
- context.removeAttribute( "id" );
- }
- }
- }
- }
- }
- }
-
- // All others
- return select( selector.replace( rtrim, "$1" ), context, results, seed );
-}
-
-/**
- * Create key-value caches of limited size
- * @returns {function(string, object)} Returns the Object data after storing it on itself with
- * property name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength)
- * deleting the oldest entry
- */
-function createCache() {
- var keys = [];
-
- function cache( key, value ) {
- // Use (key + " ") to avoid collision with native prototype properties (see Issue #157)
- if ( keys.push( key + " " ) > Expr.cacheLength ) {
- // Only keep the most recent entries
- delete cache[ keys.shift() ];
- }
- return (cache[ key + " " ] = value);
- }
- return cache;
-}
-
-/**
- * Mark a function for special use by Sizzle
- * @param {Function} fn The function to mark
- */
-function markFunction( fn ) {
- fn[ expando ] = true;
- return fn;
-}
-
-/**
- * Support testing using an element
- * @param {Function} fn Passed the created element and returns a boolean result
- */
-function assert( fn ) {
- var el = document.createElement("fieldset");
-
- try {
- return !!fn( el );
- } catch (e) {
- return false;
- } finally {
- // Remove from its parent by default
- if ( el.parentNode ) {
- el.parentNode.removeChild( el );
- }
- // release memory in IE
- el = null;
- }
-}
-
-/**
- * Adds the same handler for all of the specified attrs
- * @param {String} attrs Pipe-separated list of attributes
- * @param {Function} handler The method that will be applied
- */
-function addHandle( attrs, handler ) {
- var arr = attrs.split("|"),
- i = arr.length;
-
- while ( i-- ) {
- Expr.attrHandle[ arr[i] ] = handler;
- }
-}
-
-/**
- * Checks document order of two siblings
- * @param {Element} a
- * @param {Element} b
- * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b
- */
-function siblingCheck( a, b ) {
- var cur = b && a,
- diff = cur && a.nodeType === 1 && b.nodeType === 1 &&
- a.sourceIndex - b.sourceIndex;
-
- // Use IE sourceIndex if available on both nodes
- if ( diff ) {
- return diff;
- }
-
- // Check if b follows a
- if ( cur ) {
- while ( (cur = cur.nextSibling) ) {
- if ( cur === b ) {
- return -1;
- }
- }
- }
-
- return a ? 1 : -1;
-}
-
-/**
- * Returns a function to use in pseudos for input types
- * @param {String} type
- */
-function createInputPseudo( type ) {
- return function( elem ) {
- var name = elem.nodeName.toLowerCase();
- return name === "input" && elem.type === type;
- };
-}
-
-/**
- * Returns a function to use in pseudos for buttons
- * @param {String} type
- */
-function createButtonPseudo( type ) {
- return function( elem ) {
- var name = elem.nodeName.toLowerCase();
- return (name === "input" || name === "button") && elem.type === type;
- };
-}
-
-/**
- * Returns a function to use in pseudos for :enabled/:disabled
- * @param {Boolean} disabled true for :disabled; false for :enabled
- */
-function createDisabledPseudo( disabled ) {
-
- // Known :disabled false positives: fieldset[disabled] > legend:nth-of-type(n+2) :can-disable
- return function( elem ) {
-
- // Only certain elements can match :enabled or :disabled
- // https://html.spec.whatwg.org/multipage/scripting.html#selector-enabled
- // https://html.spec.whatwg.org/multipage/scripting.html#selector-disabled
- if ( "form" in elem ) {
-
- // Check for inherited disabledness on relevant non-disabled elements:
- // * listed form-associated elements in a disabled fieldset
- // https://html.spec.whatwg.org/multipage/forms.html#category-listed
- // https://html.spec.whatwg.org/multipage/forms.html#concept-fe-disabled
- // * option elements in a disabled optgroup
- // https://html.spec.whatwg.org/multipage/forms.html#concept-option-disabled
- // All such elements have a "form" property.
- if ( elem.parentNode && elem.disabled === false ) {
-
- // Option elements defer to a parent optgroup if present
- if ( "label" in elem ) {
- if ( "label" in elem.parentNode ) {
- return elem.parentNode.disabled === disabled;
- } else {
- return elem.disabled === disabled;
- }
- }
-
- // Support: IE 6 - 11
- // Use the isDisabled shortcut property to check for disabled fieldset ancestors
- return elem.isDisabled === disabled ||
-
- // Where there is no isDisabled, check manually
- /* jshint -W018 */
- elem.isDisabled !== !disabled &&
- disabledAncestor( elem ) === disabled;
- }
-
- return elem.disabled === disabled;
-
- // Try to winnow out elements that can't be disabled before trusting the disabled property.
- // Some victims get caught in our net (label, legend, menu, track), but it shouldn't
- // even exist on them, let alone have a boolean value.
- } else if ( "label" in elem ) {
- return elem.disabled === disabled;
- }
-
- // Remaining elements are neither :enabled nor :disabled
- return false;
- };
-}
-
-/**
- * Returns a function to use in pseudos for positionals
- * @param {Function} fn
- */
-function createPositionalPseudo( fn ) {
- return markFunction(function( argument ) {
- argument = +argument;
- return markFunction(function( seed, matches ) {
- var j,
- matchIndexes = fn( [], seed.length, argument ),
- i = matchIndexes.length;
-
- // Match elements found at the specified indexes
- while ( i-- ) {
- if ( seed[ (j = matchIndexes[i]) ] ) {
- seed[j] = !(matches[j] = seed[j]);
- }
- }
- });
- });
-}
-
-/**
- * Checks a node for validity as a Sizzle context
- * @param {Element|Object=} context
- * @returns {Element|Object|Boolean} The input node if acceptable, otherwise a falsy value
- */
-function testContext( context ) {
- return context && typeof context.getElementsByTagName !== "undefined" && context;
-}
-
-// Expose support vars for convenience
-support = Sizzle.support = {};
-
-/**
- * Detects XML nodes
- * @param {Element|Object} elem An element or a document
- * @returns {Boolean} True iff elem is a non-HTML XML node
- */
-isXML = Sizzle.isXML = function( elem ) {
- // documentElement is verified for cases where it doesn't yet exist
- // (such as loading iframes in IE - #4833)
- var documentElement = elem && (elem.ownerDocument || elem).documentElement;
- return documentElement ? documentElement.nodeName !== "HTML" : false;
-};
-
-/**
- * Sets document-related variables once based on the current document
- * @param {Element|Object} [doc] An element or document object to use to set the document
- * @returns {Object} Returns the current document
- */
-setDocument = Sizzle.setDocument = function( node ) {
- var hasCompare, subWindow,
- doc = node ? node.ownerDocument || node : preferredDoc;
-
- // Return early if doc is invalid or already selected
- if ( doc === document || doc.nodeType !== 9 || !doc.documentElement ) {
- return document;
- }
-
- // Update global variables
- document = doc;
- docElem = document.documentElement;
- documentIsHTML = !isXML( document );
-
- // Support: IE 9-11, Edge
- // Accessing iframe documents after unload throws "permission denied" errors (jQuery #13936)
- if ( preferredDoc !== document &&
- (subWindow = document.defaultView) && subWindow.top !== subWindow ) {
-
- // Support: IE 11, Edge
- if ( subWindow.addEventListener ) {
- subWindow.addEventListener( "unload", unloadHandler, false );
-
- // Support: IE 9 - 10 only
- } else if ( subWindow.attachEvent ) {
- subWindow.attachEvent( "onunload", unloadHandler );
- }
- }
-
- /* Attributes
- ---------------------------------------------------------------------- */
-
- // Support: IE<8
- // Verify that getAttribute really returns attributes and not properties
- // (excepting IE8 booleans)
- support.attributes = assert(function( el ) {
- el.className = "i";
- return !el.getAttribute("className");
- });
-
- /* getElement(s)By*
- ---------------------------------------------------------------------- */
-
- // Check if getElementsByTagName("*") returns only elements
- support.getElementsByTagName = assert(function( el ) {
- el.appendChild( document.createComment("") );
- return !el.getElementsByTagName("*").length;
- });
-
- // Support: IE<9
- support.getElementsByClassName = rnative.test( document.getElementsByClassName );
-
- // Support: IE<10
- // Check if getElementById returns elements by name
- // The broken getElementById methods don't pick up programmatically-set names,
- // so use a roundabout getElementsByName test
- support.getById = assert(function( el ) {
- docElem.appendChild( el ).id = expando;
- return !document.getElementsByName || !document.getElementsByName( expando ).length;
- });
-
- // ID filter and find
- if ( support.getById ) {
- Expr.filter["ID"] = function( id ) {
- var attrId = id.replace( runescape, funescape );
- return function( elem ) {
- return elem.getAttribute("id") === attrId;
- };
- };
- Expr.find["ID"] = function( id, context ) {
- if ( typeof context.getElementById !== "undefined" && documentIsHTML ) {
- var elem = context.getElementById( id );
- return elem ? [ elem ] : [];
- }
- };
- } else {
- Expr.filter["ID"] = function( id ) {
- var attrId = id.replace( runescape, funescape );
- return function( elem ) {
- var node = typeof elem.getAttributeNode !== "undefined" &&
- elem.getAttributeNode("id");
- return node && node.value === attrId;
- };
- };
-
- // Support: IE 6 - 7 only
- // getElementById is not reliable as a find shortcut
- Expr.find["ID"] = function( id, context ) {
- if ( typeof context.getElementById !== "undefined" && documentIsHTML ) {
- var node, i, elems,
- elem = context.getElementById( id );
-
- if ( elem ) {
-
- // Verify the id attribute
- node = elem.getAttributeNode("id");
- if ( node && node.value === id ) {
- return [ elem ];
- }
-
- // Fall back on getElementsByName
- elems = context.getElementsByName( id );
- i = 0;
- while ( (elem = elems[i++]) ) {
- node = elem.getAttributeNode("id");
- if ( node && node.value === id ) {
- return [ elem ];
- }
- }
- }
-
- return [];
- }
- };
- }
-
- // Tag
- Expr.find["TAG"] = support.getElementsByTagName ?
- function( tag, context ) {
- if ( typeof context.getElementsByTagName !== "undefined" ) {
- return context.getElementsByTagName( tag );
-
- // DocumentFragment nodes don't have gEBTN
- } else if ( support.qsa ) {
- return context.querySelectorAll( tag );
- }
- } :
-
- function( tag, context ) {
- var elem,
- tmp = [],
- i = 0,
- // By happy coincidence, a (broken) gEBTN appears on DocumentFragment nodes too
- results = context.getElementsByTagName( tag );
-
- // Filter out possible comments
- if ( tag === "*" ) {
- while ( (elem = results[i++]) ) {
- if ( elem.nodeType === 1 ) {
- tmp.push( elem );
- }
- }
-
- return tmp;
- }
- return results;
- };
-
- // Class
- Expr.find["CLASS"] = support.getElementsByClassName && function( className, context ) {
- if ( typeof context.getElementsByClassName !== "undefined" && documentIsHTML ) {
- return context.getElementsByClassName( className );
- }
- };
-
- /* QSA/matchesSelector
- ---------------------------------------------------------------------- */
-
- // QSA and matchesSelector support
-
- // matchesSelector(:active) reports false when true (IE9/Opera 11.5)
- rbuggyMatches = [];
-
- // qSa(:focus) reports false when true (Chrome 21)
- // We allow this because of a bug in IE8/9 that throws an error
- // whenever `document.activeElement` is accessed on an iframe
- // So, we allow :focus to pass through QSA all the time to avoid the IE error
- // See https://bugs.jquery.com/ticket/13378
- rbuggyQSA = [];
-
- if ( (support.qsa = rnative.test( document.querySelectorAll )) ) {
- // Build QSA regex
- // Regex strategy adopted from Diego Perini
- assert(function( el ) {
- // Select is set to empty string on purpose
- // This is to test IE's treatment of not explicitly
- // setting a boolean content attribute,
- // since its presence should be enough
- // https://bugs.jquery.com/ticket/12359
- docElem.appendChild( el ).innerHTML = "<a id='" + expando + "'></a>" +
- "<select id='" + expando + "-\r\\' msallowcapture=''>" +
- "<option selected=''></option></select>";
-
- // Support: IE8, Opera 11-12.16
- // Nothing should be selected when empty strings follow ^= or $= or *=
- // The test attribute must be unknown in Opera but "safe" for WinRT
- // https://msdn.microsoft.com/en-us/library/ie/hh465388.aspx#attribute_section
- if ( el.querySelectorAll("[msallowcapture^='']").length ) {
- rbuggyQSA.push( "[*^$]=" + whitespace + "*(?:''|\"\")" );
- }
-
- // Support: IE8
- // Boolean attributes and "value" are not treated correctly
- if ( !el.querySelectorAll("[selected]").length ) {
- rbuggyQSA.push( "\\[" + whitespace + "*(?:value|" + booleans + ")" );
- }
-
- // Support: Chrome<29, Android<4.4, Safari<7.0+, iOS<7.0+, PhantomJS<1.9.8+
- if ( !el.querySelectorAll( "[id~=" + expando + "-]" ).length ) {
- rbuggyQSA.push("~=");
- }
-
- // Webkit/Opera - :checked should return selected option elements
- // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked
- // IE8 throws error here and will not see later tests
- if ( !el.querySelectorAll(":checked").length ) {
- rbuggyQSA.push(":checked");
- }
-
- // Support: Safari 8+, iOS 8+
- // https://bugs.webkit.org/show_bug.cgi?id=136851
- // In-page `selector#id sibling-combinator selector` fails
- if ( !el.querySelectorAll( "a#" + expando + "+*" ).length ) {
- rbuggyQSA.push(".#.+[+~]");
- }
- });
-
- assert(function( el ) {
- el.innerHTML = "<a href='' disabled='disabled'></a>" +
- "<select disabled='disabled'><option/></select>";
-
- // Support: Windows 8 Native Apps
- // The type and name attributes are restricted during .innerHTML assignment
- var input = document.createElement("input");
- input.setAttribute( "type", "hidden" );
- el.appendChild( input ).setAttribute( "name", "D" );
-
- // Support: IE8
- // Enforce case-sensitivity of name attribute
- if ( el.querySelectorAll("[name=d]").length ) {
- rbuggyQSA.push( "name" + whitespace + "*[*^$|!~]?=" );
- }
-
- // FF 3.5 - :enabled/:disabled and hidden elements (hidden elements are still enabled)
- // IE8 throws error here and will not see later tests
- if ( el.querySelectorAll(":enabled").length !== 2 ) {
- rbuggyQSA.push( ":enabled", ":disabled" );
- }
-
- // Support: IE9-11+
- // IE's :disabled selector does not pick up the children of disabled fieldsets
- docElem.appendChild( el ).disabled = true;
- if ( el.querySelectorAll(":disabled").length !== 2 ) {
- rbuggyQSA.push( ":enabled", ":disabled" );
- }
-
- // Opera 10-11 does not throw on post-comma invalid pseudos
- el.querySelectorAll("*,:x");
- rbuggyQSA.push(",.*:");
- });
- }
-
- if ( (support.matchesSelector = rnative.test( (matches = docElem.matches ||
- docElem.webkitMatchesSelector ||
- docElem.mozMatchesSelector ||
- docElem.oMatchesSelector ||
- docElem.msMatchesSelector) )) ) {
-
- assert(function( el ) {
- // Check to see if it's possible to do matchesSelector
- // on a disconnected node (IE 9)
- support.disconnectedMatch = matches.call( el, "*" );
-
- // This should fail with an exception
- // Gecko does not error, returns false instead
- matches.call( el, "[s!='']:x" );
- rbuggyMatches.push( "!=", pseudos );
- });
- }
-
- rbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join("|") );
- rbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join("|") );
-
- /* Contains
- ---------------------------------------------------------------------- */
- hasCompare = rnative.test( docElem.compareDocumentPosition );
-
- // Element contains another
- // Purposefully self-exclusive
- // As in, an element does not contain itself
- contains = hasCompare || rnative.test( docElem.contains ) ?
- function( a, b ) {
- var adown = a.nodeType === 9 ? a.documentElement : a,
- bup = b && b.parentNode;
- return a === bup || !!( bup && bup.nodeType === 1 && (
- adown.contains ?
- adown.contains( bup ) :
- a.compareDocumentPosition && a.compareDocumentPosition( bup ) & 16
- ));
- } :
- function( a, b ) {
- if ( b ) {
- while ( (b = b.parentNode) ) {
- if ( b === a ) {
- return true;
- }
- }
- }
- return false;
- };
-
- /* Sorting
- ---------------------------------------------------------------------- */
-
- // Document order sorting
- sortOrder = hasCompare ?
- function( a, b ) {
-
- // Flag for duplicate removal
- if ( a === b ) {
- hasDuplicate = true;
- return 0;
- }
-
- // Sort on method existence if only one input has compareDocumentPosition
- var compare = !a.compareDocumentPosition - !b.compareDocumentPosition;
- if ( compare ) {
- return compare;
- }
-
- // Calculate position if both inputs belong to the same document
- compare = ( a.ownerDocument || a ) === ( b.ownerDocument || b ) ?
- a.compareDocumentPosition( b ) :
-
- // Otherwise we know they are disconnected
- 1;
-
- // Disconnected nodes
- if ( compare & 1 ||
- (!support.sortDetached && b.compareDocumentPosition( a ) === compare) ) {
-
- // Choose the first element that is related to our preferred document
- if ( a === document || a.ownerDocument === preferredDoc && contains(preferredDoc, a) ) {
- return -1;
- }
- if ( b === document || b.ownerDocument === preferredDoc && contains(preferredDoc, b) ) {
- return 1;
- }
-
- // Maintain original order
- return sortInput ?
- ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) :
- 0;
- }
-
- return compare & 4 ? -1 : 1;
- } :
- function( a, b ) {
- // Exit early if the nodes are identical
- if ( a === b ) {
- hasDuplicate = true;
- return 0;
- }
-
- var cur,
- i = 0,
- aup = a.parentNode,
- bup = b.parentNode,
- ap = [ a ],
- bp = [ b ];
-
- // Parentless nodes are either documents or disconnected
- if ( !aup || !bup ) {
- return a === document ? -1 :
- b === document ? 1 :
- aup ? -1 :
- bup ? 1 :
- sortInput ?
- ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) :
- 0;
-
- // If the nodes are siblings, we can do a quick check
- } else if ( aup === bup ) {
- return siblingCheck( a, b );
- }
-
- // Otherwise we need full lists of their ancestors for comparison
- cur = a;
- while ( (cur = cur.parentNode) ) {
- ap.unshift( cur );
- }
- cur = b;
- while ( (cur = cur.parentNode) ) {
- bp.unshift( cur );
- }
-
- // Walk down the tree looking for a discrepancy
- while ( ap[i] === bp[i] ) {
- i++;
- }
-
- return i ?
- // Do a sibling check if the nodes have a common ancestor
- siblingCheck( ap[i], bp[i] ) :
-
- // Otherwise nodes in our document sort first
- ap[i] === preferredDoc ? -1 :
- bp[i] === preferredDoc ? 1 :
- 0;
- };
-
- return document;
-};
-
-Sizzle.matches = function( expr, elements ) {
- return Sizzle( expr, null, null, elements );
-};
-
-Sizzle.matchesSelector = function( elem, expr ) {
- // Set document vars if needed
- if ( ( elem.ownerDocument || elem ) !== document ) {
- setDocument( elem );
- }
-
- // Make sure that attribute selectors are quoted
- expr = expr.replace( rattributeQuotes, "='$1']" );
-
- if ( support.matchesSelector && documentIsHTML &&
- !compilerCache[ expr + " " ] &&
- ( !rbuggyMatches || !rbuggyMatches.test( expr ) ) &&
- ( !rbuggyQSA || !rbuggyQSA.test( expr ) ) ) {
-
- try {
- var ret = matches.call( elem, expr );
-
- // IE 9's matchesSelector returns false on disconnected nodes
- if ( ret || support.disconnectedMatch ||
- // As well, disconnected nodes are said to be in a document
- // fragment in IE 9
- elem.document && elem.document.nodeType !== 11 ) {
- return ret;
- }
- } catch (e) {}
- }
-
- return Sizzle( expr, document, null, [ elem ] ).length > 0;
-};
-
-Sizzle.contains = function( context, elem ) {
- // Set document vars if needed
- if ( ( context.ownerDocument || context ) !== document ) {
- setDocument( context );
- }
- return contains( context, elem );
-};
-
-Sizzle.attr = function( elem, name ) {
- // Set document vars if needed
- if ( ( elem.ownerDocument || elem ) !== document ) {
- setDocument( elem );
- }
-
- var fn = Expr.attrHandle[ name.toLowerCase() ],
- // Don't get fooled by Object.prototype properties (jQuery #13807)
- val = fn && hasOwn.call( Expr.attrHandle, name.toLowerCase() ) ?
- fn( elem, name, !documentIsHTML ) :
- undefined;
-
- return val !== undefined ?
- val :
- support.attributes || !documentIsHTML ?
- elem.getAttribute( name ) :
- (val = elem.getAttributeNode(name)) && val.specified ?
- val.value :
- null;
-};
-
-Sizzle.escape = function( sel ) {
- return (sel + "").replace( rcssescape, fcssescape );
-};
-
-Sizzle.error = function( msg ) {
- throw new Error( "Syntax error, unrecognized expression: " + msg );
-};
-
-/**
- * Document sorting and removing duplicates
- * @param {ArrayLike} results
- */
-Sizzle.uniqueSort = function( results ) {
- var elem,
- duplicates = [],
- j = 0,
- i = 0;
-
- // Unless we *know* we can detect duplicates, assume their presence
- hasDuplicate = !support.detectDuplicates;
- sortInput = !support.sortStable && results.slice( 0 );
- results.sort( sortOrder );
-
- if ( hasDuplicate ) {
- while ( (elem = results[i++]) ) {
- if ( elem === results[ i ] ) {
- j = duplicates.push( i );
- }
- }
- while ( j-- ) {
- results.splice( duplicates[ j ], 1 );
- }
- }
-
- // Clear input after sorting to release objects
- // See https://github.com/jquery/sizzle/pull/225
- sortInput = null;
-
- return results;
-};
-
-/**
- * Utility function for retrieving the text value of an array of DOM nodes
- * @param {Array|Element} elem
- */
-getText = Sizzle.getText = function( elem ) {
- var node,
- ret = "",
- i = 0,
- nodeType = elem.nodeType;
-
- if ( !nodeType ) {
- // If no nodeType, this is expected to be an array
- while ( (node = elem[i++]) ) {
- // Do not traverse comment nodes
- ret += getText( node );
- }
- } else if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) {
- // Use textContent for elements
- // innerText usage removed for consistency of new lines (jQuery #11153)
- if ( typeof elem.textContent === "string" ) {
- return elem.textContent;
- } else {
- // Traverse its children
- for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) {
- ret += getText( elem );
- }
- }
- } else if ( nodeType === 3 || nodeType === 4 ) {
- return elem.nodeValue;
- }
- // Do not include comment or processing instruction nodes
-
- return ret;
-};
-
-Expr = Sizzle.selectors = {
-
- // Can be adjusted by the user
- cacheLength: 50,
-
- createPseudo: markFunction,
-
- match: matchExpr,
-
- attrHandle: {},
-
- find: {},
-
- relative: {
- ">": { dir: "parentNode", first: true },
- " ": { dir: "parentNode" },
- "+": { dir: "previousSibling", first: true },
- "~": { dir: "previousSibling" }
- },
-
- preFilter: {
- "ATTR": function( match ) {
- match[1] = match[1].replace( runescape, funescape );
-
- // Move the given value to match[3] whether quoted or unquoted
- match[3] = ( match[3] || match[4] || match[5] || "" ).replace( runescape, funescape );
-
- if ( match[2] === "~=" ) {
- match[3] = " " + match[3] + " ";
- }
-
- return match.slice( 0, 4 );
- },
-
- "CHILD": function( match ) {
- /* matches from matchExpr["CHILD"]
- 1 type (only|nth|...)
- 2 what (child|of-type)
- 3 argument (even|odd|\d*|\d*n([+-]\d+)?|...)
- 4 xn-component of xn+y argument ([+-]?\d*n|)
- 5 sign of xn-component
- 6 x of xn-component
- 7 sign of y-component
- 8 y of y-component
- */
- match[1] = match[1].toLowerCase();
-
- if ( match[1].slice( 0, 3 ) === "nth" ) {
- // nth-* requires argument
- if ( !match[3] ) {
- Sizzle.error( match[0] );
- }
-
- // numeric x and y parameters for Expr.filter.CHILD
- // remember that false/true cast respectively to 0/1
- match[4] = +( match[4] ? match[5] + (match[6] || 1) : 2 * ( match[3] === "even" || match[3] === "odd" ) );
- match[5] = +( ( match[7] + match[8] ) || match[3] === "odd" );
-
- // other types prohibit arguments
- } else if ( match[3] ) {
- Sizzle.error( match[0] );
- }
-
- return match;
- },
-
- "PSEUDO": function( match ) {
- var excess,
- unquoted = !match[6] && match[2];
-
- if ( matchExpr["CHILD"].test( match[0] ) ) {
- return null;
- }
-
- // Accept quoted arguments as-is
- if ( match[3] ) {
- match[2] = match[4] || match[5] || "";
-
- // Strip excess characters from unquoted arguments
- } else if ( unquoted && rpseudo.test( unquoted ) &&
- // Get excess from tokenize (recursively)
- (excess = tokenize( unquoted, true )) &&
- // advance to the next closing parenthesis
- (excess = unquoted.indexOf( ")", unquoted.length - excess ) - unquoted.length) ) {
-
- // excess is a negative index
- match[0] = match[0].slice( 0, excess );
- match[2] = unquoted.slice( 0, excess );
- }
-
- // Return only captures needed by the pseudo filter method (type and argument)
- return match.slice( 0, 3 );
- }
- },
-
- filter: {
-
- "TAG": function( nodeNameSelector ) {
- var nodeName = nodeNameSelector.replace( runescape, funescape ).toLowerCase();
- return nodeNameSelector === "*" ?
- function() { return true; } :
- function( elem ) {
- return elem.nodeName && elem.nodeName.toLowerCase() === nodeName;
- };
- },
-
- "CLASS": function( className ) {
- var pattern = classCache[ className + " " ];
-
- return pattern ||
- (pattern = new RegExp( "(^|" + whitespace + ")" + className + "(" + whitespace + "|$)" )) &&
- classCache( className, function( elem ) {
- return pattern.test( typeof elem.className === "string" && elem.className || typeof elem.getAttribute !== "undefined" && elem.getAttribute("class") || "" );
- });
- },
-
- "ATTR": function( name, operator, check ) {
- return function( elem ) {
- var result = Sizzle.attr( elem, name );
-
- if ( result == null ) {
- return operator === "!=";
- }
- if ( !operator ) {
- return true;
- }
-
- result += "";
-
- return operator === "=" ? result === check :
- operator === "!=" ? result !== check :
- operator === "^=" ? check && result.indexOf( check ) === 0 :
- operator === "*=" ? check && result.indexOf( check ) > -1 :
- operator === "$=" ? check && result.slice( -check.length ) === check :
- operator === "~=" ? ( " " + result.replace( rwhitespace, " " ) + " " ).indexOf( check ) > -1 :
- operator === "|=" ? result === check || result.slice( 0, check.length + 1 ) === check + "-" :
- false;
- };
- },
-
- "CHILD": function( type, what, argument, first, last ) {
- var simple = type.slice( 0, 3 ) !== "nth",
- forward = type.slice( -4 ) !== "last",
- ofType = what === "of-type";
-
- return first === 1 && last === 0 ?
-
- // Shortcut for :nth-*(n)
- function( elem ) {
- return !!elem.parentNode;
- } :
-
- function( elem, context, xml ) {
- var cache, uniqueCache, outerCache, node, nodeIndex, start,
- dir = simple !== forward ? "nextSibling" : "previousSibling",
- parent = elem.parentNode,
- name = ofType && elem.nodeName.toLowerCase(),
- useCache = !xml && !ofType,
- diff = false;
-
- if ( parent ) {
-
- // :(first|last|only)-(child|of-type)
- if ( simple ) {
- while ( dir ) {
- node = elem;
- while ( (node = node[ dir ]) ) {
- if ( ofType ?
- node.nodeName.toLowerCase() === name :
- node.nodeType === 1 ) {
-
- return false;
- }
- }
- // Reverse direction for :only-* (if we haven't yet done so)
- start = dir = type === "only" && !start && "nextSibling";
- }
- return true;
- }
-
- start = [ forward ? parent.firstChild : parent.lastChild ];
-
- // non-xml :nth-child(...) stores cache data on `parent`
- if ( forward && useCache ) {
-
- // Seek `elem` from a previously-cached index
-
- // ...in a gzip-friendly way
- node = parent;
- outerCache = node[ expando ] || (node[ expando ] = {});
-
- // Support: IE <9 only
- // Defend against cloned attroperties (jQuery gh-1709)
- uniqueCache = outerCache[ node.uniqueID ] ||
- (outerCache[ node.uniqueID ] = {});
-
- cache = uniqueCache[ type ] || [];
- nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ];
- diff = nodeIndex && cache[ 2 ];
- node = nodeIndex && parent.childNodes[ nodeIndex ];
-
- while ( (node = ++nodeIndex && node && node[ dir ] ||
-
- // Fallback to seeking `elem` from the start
- (diff = nodeIndex = 0) || start.pop()) ) {
-
- // When found, cache indexes on `parent` and break
- if ( node.nodeType === 1 && ++diff && node === elem ) {
- uniqueCache[ type ] = [ dirruns, nodeIndex, diff ];
- break;
- }
- }
-
- } else {
- // Use previously-cached element index if available
- if ( useCache ) {
- // ...in a gzip-friendly way
- node = elem;
- outerCache = node[ expando ] || (node[ expando ] = {});
-
- // Support: IE <9 only
- // Defend against cloned attroperties (jQuery gh-1709)
- uniqueCache = outerCache[ node.uniqueID ] ||
- (outerCache[ node.uniqueID ] = {});
-
- cache = uniqueCache[ type ] || [];
- nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ];
- diff = nodeIndex;
- }
-
- // xml :nth-child(...)
- // or :nth-last-child(...) or :nth(-last)?-of-type(...)
- if ( diff === false ) {
- // Use the same loop as above to seek `elem` from the start
- while ( (node = ++nodeIndex && node && node[ dir ] ||
- (diff = nodeIndex = 0) || start.pop()) ) {
-
- if ( ( ofType ?
- node.nodeName.toLowerCase() === name :
- node.nodeType === 1 ) &&
- ++diff ) {
-
- // Cache the index of each encountered element
- if ( useCache ) {
- outerCache = node[ expando ] || (node[ expando ] = {});
-
- // Support: IE <9 only
- // Defend against cloned attroperties (jQuery gh-1709)
- uniqueCache = outerCache[ node.uniqueID ] ||
- (outerCache[ node.uniqueID ] = {});
-
- uniqueCache[ type ] = [ dirruns, diff ];
- }
-
- if ( node === elem ) {
- break;
- }
- }
- }
- }
- }
-
- // Incorporate the offset, then check against cycle size
- diff -= last;
- return diff === first || ( diff % first === 0 && diff / first >= 0 );
- }
- };
- },
-
- "PSEUDO": function( pseudo, argument ) {
- // pseudo-class names are case-insensitive
- // http://www.w3.org/TR/selectors/#pseudo-classes
- // Prioritize by case sensitivity in case custom pseudos are added with uppercase letters
- // Remember that setFilters inherits from pseudos
- var args,
- fn = Expr.pseudos[ pseudo ] || Expr.setFilters[ pseudo.toLowerCase() ] ||
- Sizzle.error( "unsupported pseudo: " + pseudo );
-
- // The user may use createPseudo to indicate that
- // arguments are needed to create the filter function
- // just as Sizzle does
- if ( fn[ expando ] ) {
- return fn( argument );
- }
-
- // But maintain support for old signatures
- if ( fn.length > 1 ) {
- args = [ pseudo, pseudo, "", argument ];
- return Expr.setFilters.hasOwnProperty( pseudo.toLowerCase() ) ?
- markFunction(function( seed, matches ) {
- var idx,
- matched = fn( seed, argument ),
- i = matched.length;
- while ( i-- ) {
- idx = indexOf( seed, matched[i] );
- seed[ idx ] = !( matches[ idx ] = matched[i] );
- }
- }) :
- function( elem ) {
- return fn( elem, 0, args );
- };
- }
-
- return fn;
- }
- },
-
- pseudos: {
- // Potentially complex pseudos
- "not": markFunction(function( selector ) {
- // Trim the selector passed to compile
- // to avoid treating leading and trailing
- // spaces as combinators
- var input = [],
- results = [],
- matcher = compile( selector.replace( rtrim, "$1" ) );
-
- return matcher[ expando ] ?
- markFunction(function( seed, matches, context, xml ) {
- var elem,
- unmatched = matcher( seed, null, xml, [] ),
- i = seed.length;
-
- // Match elements unmatched by `matcher`
- while ( i-- ) {
- if ( (elem = unmatched[i]) ) {
- seed[i] = !(matches[i] = elem);
- }
- }
- }) :
- function( elem, context, xml ) {
- input[0] = elem;
- matcher( input, null, xml, results );
- // Don't keep the element (issue #299)
- input[0] = null;
- return !results.pop();
- };
- }),
-
- "has": markFunction(function( selector ) {
- return function( elem ) {
- return Sizzle( selector, elem ).length > 0;
- };
- }),
-
- "contains": markFunction(function( text ) {
- text = text.replace( runescape, funescape );
- return function( elem ) {
- return ( elem.textContent || elem.innerText || getText( elem ) ).indexOf( text ) > -1;
- };
- }),
-
- // "Whether an element is represented by a :lang() selector
- // is based solely on the element's language value
- // being equal to the identifier C,
- // or beginning with the identifier C immediately followed by "-".
- // The matching of C against the element's language value is performed case-insensitively.
- // The identifier C does not have to be a valid language name."
- // http://www.w3.org/TR/selectors/#lang-pseudo
- "lang": markFunction( function( lang ) {
- // lang value must be a valid identifier
- if ( !ridentifier.test(lang || "") ) {
- Sizzle.error( "unsupported lang: " + lang );
- }
- lang = lang.replace( runescape, funescape ).toLowerCase();
- return function( elem ) {
- var elemLang;
- do {
- if ( (elemLang = documentIsHTML ?
- elem.lang :
- elem.getAttribute("xml:lang") || elem.getAttribute("lang")) ) {
-
- elemLang = elemLang.toLowerCase();
- return elemLang === lang || elemLang.indexOf( lang + "-" ) === 0;
- }
- } while ( (elem = elem.parentNode) && elem.nodeType === 1 );
- return false;
- };
- }),
-
- // Miscellaneous
- "target": function( elem ) {
- var hash = window.location && window.location.hash;
- return hash && hash.slice( 1 ) === elem.id;
- },
-
- "root": function( elem ) {
- return elem === docElem;
- },
-
- "focus": function( elem ) {
- return elem === document.activeElement && (!document.hasFocus || document.hasFocus()) && !!(elem.type || elem.href || ~elem.tabIndex);
- },
-
- // Boolean properties
- "enabled": createDisabledPseudo( false ),
- "disabled": createDisabledPseudo( true ),
-
- "checked": function( elem ) {
- // In CSS3, :checked should return both checked and selected elements
- // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked
- var nodeName = elem.nodeName.toLowerCase();
- return (nodeName === "input" && !!elem.checked) || (nodeName === "option" && !!elem.selected);
- },
-
- "selected": function( elem ) {
- // Accessing this property makes selected-by-default
- // options in Safari work properly
- if ( elem.parentNode ) {
- elem.parentNode.selectedIndex;
- }
-
- return elem.selected === true;
- },
-
- // Contents
- "empty": function( elem ) {
- // http://www.w3.org/TR/selectors/#empty-pseudo
- // :empty is negated by element (1) or content nodes (text: 3; cdata: 4; entity ref: 5),
- // but not by others (comment: 8; processing instruction: 7; etc.)
- // nodeType < 6 works because attributes (2) do not appear as children
- for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) {
- if ( elem.nodeType < 6 ) {
- return false;
- }
- }
- return true;
- },
-
- "parent": function( elem ) {
- return !Expr.pseudos["empty"]( elem );
- },
-
- // Element/input types
- "header": function( elem ) {
- return rheader.test( elem.nodeName );
- },
-
- "input": function( elem ) {
- return rinputs.test( elem.nodeName );
- },
-
- "button": function( elem ) {
- var name = elem.nodeName.toLowerCase();
- return name === "input" && elem.type === "button" || name === "button";
- },
-
- "text": function( elem ) {
- var attr;
- return elem.nodeName.toLowerCase() === "input" &&
- elem.type === "text" &&
-
- // Support: IE<8
- // New HTML5 attribute values (e.g., "search") appear with elem.type === "text"
- ( (attr = elem.getAttribute("type")) == null || attr.toLowerCase() === "text" );
- },
-
- // Position-in-collection
- "first": createPositionalPseudo(function() {
- return [ 0 ];
- }),
-
- "last": createPositionalPseudo(function( matchIndexes, length ) {
- return [ length - 1 ];
- }),
-
- "eq": createPositionalPseudo(function( matchIndexes, length, argument ) {
- return [ argument < 0 ? argument + length : argument ];
- }),
-
- "even": createPositionalPseudo(function( matchIndexes, length ) {
- var i = 0;
- for ( ; i < length; i += 2 ) {
- matchIndexes.push( i );
- }
- return matchIndexes;
- }),
-
- "odd": createPositionalPseudo(function( matchIndexes, length ) {
- var i = 1;
- for ( ; i < length; i += 2 ) {
- matchIndexes.push( i );
- }
- return matchIndexes;
- }),
-
- "lt": createPositionalPseudo(function( matchIndexes, length, argument ) {
- var i = argument < 0 ? argument + length : argument;
- for ( ; --i >= 0; ) {
- matchIndexes.push( i );
- }
- return matchIndexes;
- }),
-
- "gt": createPositionalPseudo(function( matchIndexes, length, argument ) {
- var i = argument < 0 ? argument + length : argument;
- for ( ; ++i < length; ) {
- matchIndexes.push( i );
- }
- return matchIndexes;
- })
- }
-};
-
-Expr.pseudos["nth"] = Expr.pseudos["eq"];
-
-// Add button/input type pseudos
-for ( i in { radio: true, checkbox: true, file: true, password: true, image: true } ) {
- Expr.pseudos[ i ] = createInputPseudo( i );
-}
-for ( i in { submit: true, reset: true } ) {
- Expr.pseudos[ i ] = createButtonPseudo( i );
-}
-
-// Easy API for creating new setFilters
-function setFilters() {}
-setFilters.prototype = Expr.filters = Expr.pseudos;
-Expr.setFilters = new setFilters();
-
-tokenize = Sizzle.tokenize = function( selector, parseOnly ) {
- var matched, match, tokens, type,
- soFar, groups, preFilters,
- cached = tokenCache[ selector + " " ];
-
- if ( cached ) {
- return parseOnly ? 0 : cached.slice( 0 );
- }
-
- soFar = selector;
- groups = [];
- preFilters = Expr.preFilter;
-
- while ( soFar ) {
-
- // Comma and first run
- if ( !matched || (match = rcomma.exec( soFar )) ) {
- if ( match ) {
- // Don't consume trailing commas as valid
- soFar = soFar.slice( match[0].length ) || soFar;
- }
- groups.push( (tokens = []) );
- }
-
- matched = false;
-
- // Combinators
- if ( (match = rcombinators.exec( soFar )) ) {
- matched = match.shift();
- tokens.push({
- value: matched,
- // Cast descendant combinators to space
- type: match[0].replace( rtrim, " " )
- });
- soFar = soFar.slice( matched.length );
- }
-
- // Filters
- for ( type in Expr.filter ) {
- if ( (match = matchExpr[ type ].exec( soFar )) && (!preFilters[ type ] ||
- (match = preFilters[ type ]( match ))) ) {
- matched = match.shift();
- tokens.push({
- value: matched,
- type: type,
- matches: match
- });
- soFar = soFar.slice( matched.length );
- }
- }
-
- if ( !matched ) {
- break;
- }
- }
-
- // Return the length of the invalid excess
- // if we're just parsing
- // Otherwise, throw an error or return tokens
- return parseOnly ?
- soFar.length :
- soFar ?
- Sizzle.error( selector ) :
- // Cache the tokens
- tokenCache( selector, groups ).slice( 0 );
-};
-
-function toSelector( tokens ) {
- var i = 0,
- len = tokens.length,
- selector = "";
- for ( ; i < len; i++ ) {
- selector += tokens[i].value;
- }
- return selector;
-}
-
-function addCombinator( matcher, combinator, base ) {
- var dir = combinator.dir,
- skip = combinator.next,
- key = skip || dir,
- checkNonElements = base && key === "parentNode",
- doneName = done++;
-
- return combinator.first ?
- // Check against closest ancestor/preceding element
- function( elem, context, xml ) {
- while ( (elem = elem[ dir ]) ) {
- if ( elem.nodeType === 1 || checkNonElements ) {
- return matcher( elem, context, xml );
- }
- }
- return false;
- } :
-
- // Check against all ancestor/preceding elements
- function( elem, context, xml ) {
- var oldCache, uniqueCache, outerCache,
- newCache = [ dirruns, doneName ];
-
- // We can't set arbitrary data on XML nodes, so they don't benefit from combinator caching
- if ( xml ) {
- while ( (elem = elem[ dir ]) ) {
- if ( elem.nodeType === 1 || checkNonElements ) {
- if ( matcher( elem, context, xml ) ) {
- return true;
- }
- }
- }
- } else {
- while ( (elem = elem[ dir ]) ) {
- if ( elem.nodeType === 1 || checkNonElements ) {
- outerCache = elem[ expando ] || (elem[ expando ] = {});
-
- // Support: IE <9 only
- // Defend against cloned attroperties (jQuery gh-1709)
- uniqueCache = outerCache[ elem.uniqueID ] || (outerCache[ elem.uniqueID ] = {});
-
- if ( skip && skip === elem.nodeName.toLowerCase() ) {
- elem = elem[ dir ] || elem;
- } else if ( (oldCache = uniqueCache[ key ]) &&
- oldCache[ 0 ] === dirruns && oldCache[ 1 ] === doneName ) {
-
- // Assign to newCache so results back-propagate to previous elements
- return (newCache[ 2 ] = oldCache[ 2 ]);
- } else {
- // Reuse newcache so results back-propagate to previous elements
- uniqueCache[ key ] = newCache;
-
- // A match means we're done; a fail means we have to keep checking
- if ( (newCache[ 2 ] = matcher( elem, context, xml )) ) {
- return true;
- }
- }
- }
- }
- }
- return false;
- };
-}
-
-function elementMatcher( matchers ) {
- return matchers.length > 1 ?
- function( elem, context, xml ) {
- var i = matchers.length;
- while ( i-- ) {
- if ( !matchers[i]( elem, context, xml ) ) {
- return false;
- }
- }
- return true;
- } :
- matchers[0];
-}
-
-function multipleContexts( selector, contexts, results ) {
- var i = 0,
- len = contexts.length;
- for ( ; i < len; i++ ) {
- Sizzle( selector, contexts[i], results );
- }
- return results;
-}
-
-function condense( unmatched, map, filter, context, xml ) {
- var elem,
- newUnmatched = [],
- i = 0,
- len = unmatched.length,
- mapped = map != null;
-
- for ( ; i < len; i++ ) {
- if ( (elem = unmatched[i]) ) {
- if ( !filter || filter( elem, context, xml ) ) {
- newUnmatched.push( elem );
- if ( mapped ) {
- map.push( i );
- }
- }
- }
- }
-
- return newUnmatched;
-}
-
-function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postSelector ) {
- if ( postFilter && !postFilter[ expando ] ) {
- postFilter = setMatcher( postFilter );
- }
- if ( postFinder && !postFinder[ expando ] ) {
- postFinder = setMatcher( postFinder, postSelector );
- }
- return markFunction(function( seed, results, context, xml ) {
- var temp, i, elem,
- preMap = [],
- postMap = [],
- preexisting = results.length,
-
- // Get initial elements from seed or context
- elems = seed || multipleContexts( selector || "*", context.nodeType ? [ context ] : context, [] ),
-
- // Prefilter to get matcher input, preserving a map for seed-results synchronization
- matcherIn = preFilter && ( seed || !selector ) ?
- condense( elems, preMap, preFilter, context, xml ) :
- elems,
-
- matcherOut = matcher ?
- // If we have a postFinder, or filtered seed, or non-seed postFilter or preexisting results,
- postFinder || ( seed ? preFilter : preexisting || postFilter ) ?
-
- // ...intermediate processing is necessary
- [] :
-
- // ...otherwise use results directly
- results :
- matcherIn;
-
- // Find primary matches
- if ( matcher ) {
- matcher( matcherIn, matcherOut, context, xml );
- }
-
- // Apply postFilter
- if ( postFilter ) {
- temp = condense( matcherOut, postMap );
- postFilter( temp, [], context, xml );
-
- // Un-match failing elements by moving them back to matcherIn
- i = temp.length;
- while ( i-- ) {
- if ( (elem = temp[i]) ) {
- matcherOut[ postMap[i] ] = !(matcherIn[ postMap[i] ] = elem);
- }
- }
- }
-
- if ( seed ) {
- if ( postFinder || preFilter ) {
- if ( postFinder ) {
- // Get the final matcherOut by condensing this intermediate into postFinder contexts
- temp = [];
- i = matcherOut.length;
- while ( i-- ) {
- if ( (elem = matcherOut[i]) ) {
- // Restore matcherIn since elem is not yet a final match
- temp.push( (matcherIn[i] = elem) );
- }
- }
- postFinder( null, (matcherOut = []), temp, xml );
- }
-
- // Move matched elements from seed to results to keep them synchronized
- i = matcherOut.length;
- while ( i-- ) {
- if ( (elem = matcherOut[i]) &&
- (temp = postFinder ? indexOf( seed, elem ) : preMap[i]) > -1 ) {
-
- seed[temp] = !(results[temp] = elem);
- }
- }
- }
-
- // Add elements to results, through postFinder if defined
- } else {
- matcherOut = condense(
- matcherOut === results ?
- matcherOut.splice( preexisting, matcherOut.length ) :
- matcherOut
- );
- if ( postFinder ) {
- postFinder( null, results, matcherOut, xml );
- } else {
- push.apply( results, matcherOut );
- }
- }
- });
-}
-
-function matcherFromTokens( tokens ) {
- var checkContext, matcher, j,
- len = tokens.length,
- leadingRelative = Expr.relative[ tokens[0].type ],
- implicitRelative = leadingRelative || Expr.relative[" "],
- i = leadingRelative ? 1 : 0,
-
- // The foundational matcher ensures that elements are reachable from top-level context(s)
- matchContext = addCombinator( function( elem ) {
- return elem === checkContext;
- }, implicitRelative, true ),
- matchAnyContext = addCombinator( function( elem ) {
- return indexOf( checkContext, elem ) > -1;
- }, implicitRelative, true ),
- matchers = [ function( elem, context, xml ) {
- var ret = ( !leadingRelative && ( xml || context !== outermostContext ) ) || (
- (checkContext = context).nodeType ?
- matchContext( elem, context, xml ) :
- matchAnyContext( elem, context, xml ) );
- // Avoid hanging onto element (issue #299)
- checkContext = null;
- return ret;
- } ];
-
- for ( ; i < len; i++ ) {
- if ( (matcher = Expr.relative[ tokens[i].type ]) ) {
- matchers = [ addCombinator(elementMatcher( matchers ), matcher) ];
- } else {
- matcher = Expr.filter[ tokens[i].type ].apply( null, tokens[i].matches );
-
- // Return special upon seeing a positional matcher
- if ( matcher[ expando ] ) {
- // Find the next relative operator (if any) for proper handling
- j = ++i;
- for ( ; j < len; j++ ) {
- if ( Expr.relative[ tokens[j].type ] ) {
- break;
- }
- }
- return setMatcher(
- i > 1 && elementMatcher( matchers ),
- i > 1 && toSelector(
- // If the preceding token was a descendant combinator, insert an implicit any-element `*`
- tokens.slice( 0, i - 1 ).concat({ value: tokens[ i - 2 ].type === " " ? "*" : "" })
- ).replace( rtrim, "$1" ),
- matcher,
- i < j && matcherFromTokens( tokens.slice( i, j ) ),
- j < len && matcherFromTokens( (tokens = tokens.slice( j )) ),
- j < len && toSelector( tokens )
- );
- }
- matchers.push( matcher );
- }
- }
-
- return elementMatcher( matchers );
-}
-
-function matcherFromGroupMatchers( elementMatchers, setMatchers ) {
- var bySet = setMatchers.length > 0,
- byElement = elementMatchers.length > 0,
- superMatcher = function( seed, context, xml, results, outermost ) {
- var elem, j, matcher,
- matchedCount = 0,
- i = "0",
- unmatched = seed && [],
- setMatched = [],
- contextBackup = outermostContext,
- // We must always have either seed elements or outermost context
- elems = seed || byElement && Expr.find["TAG"]( "*", outermost ),
- // Use integer dirruns iff this is the outermost matcher
- dirrunsUnique = (dirruns += contextBackup == null ? 1 : Math.random() || 0.1),
- len = elems.length;
-
- if ( outermost ) {
- outermostContext = context === document || context || outermost;
- }
-
- // Add elements passing elementMatchers directly to results
- // Support: IE<9, Safari
- // Tolerate NodeList properties (IE: "length"; Safari: <number>) matching elements by id
- for ( ; i !== len && (elem = elems[i]) != null; i++ ) {
- if ( byElement && elem ) {
- j = 0;
- if ( !context && elem.ownerDocument !== document ) {
- setDocument( elem );
- xml = !documentIsHTML;
- }
- while ( (matcher = elementMatchers[j++]) ) {
- if ( matcher( elem, context || document, xml) ) {
- results.push( elem );
- break;
- }
- }
- if ( outermost ) {
- dirruns = dirrunsUnique;
- }
- }
-
- // Track unmatched elements for set filters
- if ( bySet ) {
- // They will have gone through all possible matchers
- if ( (elem = !matcher && elem) ) {
- matchedCount--;
- }
-
- // Lengthen the array for every element, matched or not
- if ( seed ) {
- unmatched.push( elem );
- }
- }
- }
-
- // `i` is now the count of elements visited above, and adding it to `matchedCount`
- // makes the latter nonnegative.
- matchedCount += i;
-
- // Apply set filters to unmatched elements
- // NOTE: This can be skipped if there are no unmatched elements (i.e., `matchedCount`
- // equals `i`), unless we didn't visit _any_ elements in the above loop because we have
- // no element matchers and no seed.
- // Incrementing an initially-string "0" `i` allows `i` to remain a string only in that
- // case, which will result in a "00" `matchedCount` that differs from `i` but is also
- // numerically zero.
- if ( bySet && i !== matchedCount ) {
- j = 0;
- while ( (matcher = setMatchers[j++]) ) {
- matcher( unmatched, setMatched, context, xml );
- }
-
- if ( seed ) {
- // Reintegrate element matches to eliminate the need for sorting
- if ( matchedCount > 0 ) {
- while ( i-- ) {
- if ( !(unmatched[i] || setMatched[i]) ) {
- setMatched[i] = pop.call( results );
- }
- }
- }
-
- // Discard index placeholder values to get only actual matches
- setMatched = condense( setMatched );
- }
-
- // Add matches to results
- push.apply( results, setMatched );
-
- // Seedless set matches succeeding multiple successful matchers stipulate sorting
- if ( outermost && !seed && setMatched.length > 0 &&
- ( matchedCount + setMatchers.length ) > 1 ) {
-
- Sizzle.uniqueSort( results );
- }
- }
-
- // Override manipulation of globals by nested matchers
- if ( outermost ) {
- dirruns = dirrunsUnique;
- outermostContext = contextBackup;
- }
-
- return unmatched;
- };
-
- return bySet ?
- markFunction( superMatcher ) :
- superMatcher;
-}
-
-compile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) {
- var i,
- setMatchers = [],
- elementMatchers = [],
- cached = compilerCache[ selector + " " ];
-
- if ( !cached ) {
- // Generate a function of recursive functions that can be used to check each element
- if ( !match ) {
- match = tokenize( selector );
- }
- i = match.length;
- while ( i-- ) {
- cached = matcherFromTokens( match[i] );
- if ( cached[ expando ] ) {
- setMatchers.push( cached );
- } else {
- elementMatchers.push( cached );
- }
- }
-
- // Cache the compiled function
- cached = compilerCache( selector, matcherFromGroupMatchers( elementMatchers, setMatchers ) );
-
- // Save selector and tokenization
- cached.selector = selector;
- }
- return cached;
-};
-
-/**
- * A low-level selection function that works with Sizzle's compiled
- * selector functions
- * @param {String|Function} selector A selector or a pre-compiled
- * selector function built with Sizzle.compile
- * @param {Element} context
- * @param {Array} [results]
- * @param {Array} [seed] A set of elements to match against
- */
-select = Sizzle.select = function( selector, context, results, seed ) {
- var i, tokens, token, type, find,
- compiled = typeof selector === "function" && selector,
- match = !seed && tokenize( (selector = compiled.selector || selector) );
-
- results = results || [];
-
- // Try to minimize operations if there is only one selector in the list and no seed
- // (the latter of which guarantees us context)
- if ( match.length === 1 ) {
-
- // Reduce context if the leading compound selector is an ID
- tokens = match[0] = match[0].slice( 0 );
- if ( tokens.length > 2 && (token = tokens[0]).type === "ID" &&
- context.nodeType === 9 && documentIsHTML && Expr.relative[ tokens[1].type ] ) {
-
- context = ( Expr.find["ID"]( token.matches[0].replace(runescape, funescape), context ) || [] )[0];
- if ( !context ) {
- return results;
-
- // Precompiled matchers will still verify ancestry, so step up a level
- } else if ( compiled ) {
- context = context.parentNode;
- }
-
- selector = selector.slice( tokens.shift().value.length );
- }
-
- // Fetch a seed set for right-to-left matching
- i = matchExpr["needsContext"].test( selector ) ? 0 : tokens.length;
- while ( i-- ) {
- token = tokens[i];
-
- // Abort if we hit a combinator
- if ( Expr.relative[ (type = token.type) ] ) {
- break;
- }
- if ( (find = Expr.find[ type ]) ) {
- // Search, expanding context for leading sibling combinators
- if ( (seed = find(
- token.matches[0].replace( runescape, funescape ),
- rsibling.test( tokens[0].type ) && testContext( context.parentNode ) || context
- )) ) {
-
- // If seed is empty or no tokens remain, we can return early
- tokens.splice( i, 1 );
- selector = seed.length && toSelector( tokens );
- if ( !selector ) {
- push.apply( results, seed );
- return results;
- }
-
- break;
- }
- }
- }
- }
-
- // Compile and execute a filtering function if one is not provided
- // Provide `match` to avoid retokenization if we modified the selector above
- ( compiled || compile( selector, match ) )(
- seed,
- context,
- !documentIsHTML,
- results,
- !context || rsibling.test( selector ) && testContext( context.parentNode ) || context
- );
- return results;
-};
-
-// One-time assignments
-
-// Sort stability
-support.sortStable = expando.split("").sort( sortOrder ).join("") === expando;
-
-// Support: Chrome 14-35+
-// Always assume duplicates if they aren't passed to the comparison function
-support.detectDuplicates = !!hasDuplicate;
-
-// Initialize against the default document
-setDocument();
-
-// Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27)
-// Detached nodes confoundingly follow *each other*
-support.sortDetached = assert(function( el ) {
- // Should return 1, but returns 4 (following)
- return el.compareDocumentPosition( document.createElement("fieldset") ) & 1;
-});
-
-// Support: IE<8
-// Prevent attribute/property "interpolation"
-// https://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx
-if ( !assert(function( el ) {
- el.innerHTML = "<a href='#'></a>";
- return el.firstChild.getAttribute("href") === "#" ;
-}) ) {
- addHandle( "type|href|height|width", function( elem, name, isXML ) {
- if ( !isXML ) {
- return elem.getAttribute( name, name.toLowerCase() === "type" ? 1 : 2 );
- }
- });
-}
-
-// Support: IE<9
-// Use defaultValue in place of getAttribute("value")
-if ( !support.attributes || !assert(function( el ) {
- el.innerHTML = "<input/>";
- el.firstChild.setAttribute( "value", "" );
- return el.firstChild.getAttribute( "value" ) === "";
-}) ) {
- addHandle( "value", function( elem, name, isXML ) {
- if ( !isXML && elem.nodeName.toLowerCase() === "input" ) {
- return elem.defaultValue;
- }
- });
-}
-
-// Support: IE<9
-// Use getAttributeNode to fetch booleans when getAttribute lies
-if ( !assert(function( el ) {
- return el.getAttribute("disabled") == null;
-}) ) {
- addHandle( booleans, function( elem, name, isXML ) {
- var val;
- if ( !isXML ) {
- return elem[ name ] === true ? name.toLowerCase() :
- (val = elem.getAttributeNode( name )) && val.specified ?
- val.value :
- null;
- }
- });
-}
-
-return Sizzle;
-
-})( window );
-
-
-
-jQuery.find = Sizzle;
-jQuery.expr = Sizzle.selectors;
-
-// Deprecated
-jQuery.expr[ ":" ] = jQuery.expr.pseudos;
-jQuery.uniqueSort = jQuery.unique = Sizzle.uniqueSort;
-jQuery.text = Sizzle.getText;
-jQuery.isXMLDoc = Sizzle.isXML;
-jQuery.contains = Sizzle.contains;
-jQuery.escapeSelector = Sizzle.escape;
-
-
-
-
-var dir = function( elem, dir, until ) {
- var matched = [],
- truncate = until !== undefined;
-
- while ( ( elem = elem[ dir ] ) && elem.nodeType !== 9 ) {
- if ( elem.nodeType === 1 ) {
- if ( truncate && jQuery( elem ).is( until ) ) {
- break;
- }
- matched.push( elem );
- }
- }
- return matched;
-};
-
-
-var siblings = function( n, elem ) {
- var matched = [];
-
- for ( ; n; n = n.nextSibling ) {
- if ( n.nodeType === 1 && n !== elem ) {
- matched.push( n );
- }
- }
-
- return matched;
-};
-
-
-var rneedsContext = jQuery.expr.match.needsContext;
-
-
-
-function nodeName( elem, name ) {
-
- return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase();
-
-};
-var rsingleTag = ( /^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i );
-
-
-
-var risSimple = /^.[^:#\[\.,]*$/;
-
-// Implement the identical functionality for filter and not
-function winnow( elements, qualifier, not ) {
- if ( jQuery.isFunction( qualifier ) ) {
- return jQuery.grep( elements, function( elem, i ) {
- return !!qualifier.call( elem, i, elem ) !== not;
- } );
- }
-
- // Single element
- if ( qualifier.nodeType ) {
- return jQuery.grep( elements, function( elem ) {
- return ( elem === qualifier ) !== not;
- } );
- }
-
- // Arraylike of elements (jQuery, arguments, Array)
- if ( typeof qualifier !== "string" ) {
- return jQuery.grep( elements, function( elem ) {
- return ( indexOf.call( qualifier, elem ) > -1 ) !== not;
- } );
- }
-
- // Simple selector that can be filtered directly, removing non-Elements
- if ( risSimple.test( qualifier ) ) {
- return jQuery.filter( qualifier, elements, not );
- }
-
- // Complex selector, compare the two sets, removing non-Elements
- qualifier = jQuery.filter( qualifier, elements );
- return jQuery.grep( elements, function( elem ) {
- return ( indexOf.call( qualifier, elem ) > -1 ) !== not && elem.nodeType === 1;
- } );
-}
-
-jQuery.filter = function( expr, elems, not ) {
- var elem = elems[ 0 ];
-
- if ( not ) {
- expr = ":not(" + expr + ")";
- }
-
- if ( elems.length === 1 && elem.nodeType === 1 ) {
- return jQuery.find.matchesSelector( elem, expr ) ? [ elem ] : [];
- }
-
- return jQuery.find.matches( expr, jQuery.grep( elems, function( elem ) {
- return elem.nodeType === 1;
- } ) );
-};
-
-jQuery.fn.extend( {
- find: function( selector ) {
- var i, ret,
- len = this.length,
- self = this;
-
- if ( typeof selector !== "string" ) {
- return this.pushStack( jQuery( selector ).filter( function() {
- for ( i = 0; i < len; i++ ) {
- if ( jQuery.contains( self[ i ], this ) ) {
- return true;
- }
- }
- } ) );
- }
-
- ret = this.pushStack( [] );
-
- for ( i = 0; i < len; i++ ) {
- jQuery.find( selector, self[ i ], ret );
- }
-
- return len > 1 ? jQuery.uniqueSort( ret ) : ret;
- },
- filter: function( selector ) {
- return this.pushStack( winnow( this, selector || [], false ) );
- },
- not: function( selector ) {
- return this.pushStack( winnow( this, selector || [], true ) );
- },
- is: function( selector ) {
- return !!winnow(
- this,
-
- // If this is a positional/relative selector, check membership in the returned set
- // so $("p:first").is("p:last") won't return true for a doc with two "p".
- typeof selector === "string" && rneedsContext.test( selector ) ?
- jQuery( selector ) :
- selector || [],
- false
- ).length;
- }
-} );
-
-
-// Initialize a jQuery object
-
-
-// A central reference to the root jQuery(document)
-var rootjQuery,
-
- // A simple way to check for HTML strings
- // Prioritize #id over <tag> to avoid XSS via location.hash (#9521)
- // Strict HTML recognition (#11290: must start with <)
- // Shortcut simple #id case for speed
- rquickExpr = /^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/,
-
- init = jQuery.fn.init = function( selector, context, root ) {
- var match, elem;
-
- // HANDLE: $(""), $(null), $(undefined), $(false)
- if ( !selector ) {
- return this;
- }
-
- // Method init() accepts an alternate rootjQuery
- // so migrate can support jQuery.sub (gh-2101)
- root = root || rootjQuery;
-
- // Handle HTML strings
- if ( typeof selector === "string" ) {
- if ( selector[ 0 ] === "<" &&
- selector[ selector.length - 1 ] === ">" &&
- selector.length >= 3 ) {
-
- // Assume that strings that start and end with <> are HTML and skip the regex check
- match = [ null, selector, null ];
-
- } else {
- match = rquickExpr.exec( selector );
- }
-
- // Match html or make sure no context is specified for #id
- if ( match && ( match[ 1 ] || !context ) ) {
-
- // HANDLE: $(html) -> $(array)
- if ( match[ 1 ] ) {
- context = context instanceof jQuery ? context[ 0 ] : context;
-
- // Option to run scripts is true for back-compat
- // Intentionally let the error be thrown if parseHTML is not present
- jQuery.merge( this, jQuery.parseHTML(
- match[ 1 ],
- context && context.nodeType ? context.ownerDocument || context : document,
- true
- ) );
-
- // HANDLE: $(html, props)
- if ( rsingleTag.test( match[ 1 ] ) && jQuery.isPlainObject( context ) ) {
- for ( match in context ) {
-
- // Properties of context are called as methods if possible
- if ( jQuery.isFunction( this[ match ] ) ) {
- this[ match ]( context[ match ] );
-
- // ...and otherwise set as attributes
- } else {
- this.attr( match, context[ match ] );
- }
- }
- }
-
- return this;
-
- // HANDLE: $(#id)
- } else {
- elem = document.getElementById( match[ 2 ] );
-
- if ( elem ) {
-
- // Inject the element directly into the jQuery object
- this[ 0 ] = elem;
- this.length = 1;
- }
- return this;
- }
-
- // HANDLE: $(expr, $(...))
- } else if ( !context || context.jquery ) {
- return ( context || root ).find( selector );
-
- // HANDLE: $(expr, context)
- // (which is just equivalent to: $(context).find(expr)
- } else {
- return this.constructor( context ).find( selector );
- }
-
- // HANDLE: $(DOMElement)
- } else if ( selector.nodeType ) {
- this[ 0 ] = selector;
- this.length = 1;
- return this;
-
- // HANDLE: $(function)
- // Shortcut for document ready
- } else if ( jQuery.isFunction( selector ) ) {
- return root.ready !== undefined ?
- root.ready( selector ) :
-
- // Execute immediately if ready is not present
- selector( jQuery );
- }
-
- return jQuery.makeArray( selector, this );
- };
-
-// Give the init function the jQuery prototype for later instantiation
-init.prototype = jQuery.fn;
-
-// Initialize central reference
-rootjQuery = jQuery( document );
-
-
-var rparentsprev = /^(?:parents|prev(?:Until|All))/,
-
- // Methods guaranteed to produce a unique set when starting from a unique set
- guaranteedUnique = {
- children: true,
- contents: true,
- next: true,
- prev: true
- };
-
-jQuery.fn.extend( {
- has: function( target ) {
- var targets = jQuery( target, this ),
- l = targets.length;
-
- return this.filter( function() {
- var i = 0;
- for ( ; i < l; i++ ) {
- if ( jQuery.contains( this, targets[ i ] ) ) {
- return true;
- }
- }
- } );
- },
-
- closest: function( selectors, context ) {
- var cur,
- i = 0,
- l = this.length,
- matched = [],
- targets = typeof selectors !== "string" && jQuery( selectors );
-
- // Positional selectors never match, since there's no _selection_ context
- if ( !rneedsContext.test( selectors ) ) {
- for ( ; i < l; i++ ) {
- for ( cur = this[ i ]; cur && cur !== context; cur = cur.parentNode ) {
-
- // Always skip document fragments
- if ( cur.nodeType < 11 && ( targets ?
- targets.index( cur ) > -1 :
-
- // Don't pass non-elements to Sizzle
- cur.nodeType === 1 &&
- jQuery.find.matchesSelector( cur, selectors ) ) ) {
-
- matched.push( cur );
- break;
- }
- }
- }
- }
-
- return this.pushStack( matched.length > 1 ? jQuery.uniqueSort( matched ) : matched );
- },
-
- // Determine the position of an element within the set
- index: function( elem ) {
-
- // No argument, return index in parent
- if ( !elem ) {
- return ( this[ 0 ] && this[ 0 ].parentNode ) ? this.first().prevAll().length : -1;
- }
-
- // Index in selector
- if ( typeof elem === "string" ) {
- return indexOf.call( jQuery( elem ), this[ 0 ] );
- }
-
- // Locate the position of the desired element
- return indexOf.call( this,
-
- // If it receives a jQuery object, the first element is used
- elem.jquery ? elem[ 0 ] : elem
- );
- },
-
- add: function( selector, context ) {
- return this.pushStack(
- jQuery.uniqueSort(
- jQuery.merge( this.get(), jQuery( selector, context ) )
- )
- );
- },
-
- addBack: function( selector ) {
- return this.add( selector == null ?
- this.prevObject : this.prevObject.filter( selector )
- );
- }
-} );
-
-function sibling( cur, dir ) {
- while ( ( cur = cur[ dir ] ) && cur.nodeType !== 1 ) {}
- return cur;
-}
-
-jQuery.each( {
- parent: function( elem ) {
- var parent = elem.parentNode;
- return parent && parent.nodeType !== 11 ? parent : null;
- },
- parents: function( elem ) {
- return dir( elem, "parentNode" );
- },
- parentsUntil: function( elem, i, until ) {
- return dir( elem, "parentNode", until );
- },
- next: function( elem ) {
- return sibling( elem, "nextSibling" );
- },
- prev: function( elem ) {
- return sibling( elem, "previousSibling" );
- },
- nextAll: function( elem ) {
- return dir( elem, "nextSibling" );
- },
- prevAll: function( elem ) {
- return dir( elem, "previousSibling" );
- },
- nextUntil: function( elem, i, until ) {
- return dir( elem, "nextSibling", until );
- },
- prevUntil: function( elem, i, until ) {
- return dir( elem, "previousSibling", until );
- },
- siblings: function( elem ) {
- return siblings( ( elem.parentNode || {} ).firstChild, elem );
- },
- children: function( elem ) {
- return siblings( elem.firstChild );
- },
- contents: function( elem ) {
- if ( nodeName( elem, "iframe" ) ) {
- return elem.contentDocument;
- }
-
- // Support: IE 9 - 11 only, iOS 7 only, Android Browser <=4.3 only
- // Treat the template element as a regular one in browsers that
- // don't support it.
- if ( nodeName( elem, "template" ) ) {
- elem = elem.content || elem;
- }
-
- return jQuery.merge( [], elem.childNodes );
- }
-}, function( name, fn ) {
- jQuery.fn[ name ] = function( until, selector ) {
- var matched = jQuery.map( this, fn, until );
-
- if ( name.slice( -5 ) !== "Until" ) {
- selector = until;
- }
-
- if ( selector && typeof selector === "string" ) {
- matched = jQuery.filter( selector, matched );
- }
-
- if ( this.length > 1 ) {
-
- // Remove duplicates
- if ( !guaranteedUnique[ name ] ) {
- jQuery.uniqueSort( matched );
- }
-
- // Reverse order for parents* and prev-derivatives
- if ( rparentsprev.test( name ) ) {
- matched.reverse();
- }
- }
-
- return this.pushStack( matched );
- };
-} );
-var rnothtmlwhite = ( /[^\x20\t\r\n\f]+/g );
-
-
-
-// Convert String-formatted options into Object-formatted ones
-function createOptions( options ) {
- var object = {};
- jQuery.each( options.match( rnothtmlwhite ) || [], function( _, flag ) {
- object[ flag ] = true;
- } );
- return object;
-}
-
-/*
- * Create a callback list using the following parameters:
- *
- * options: an optional list of space-separated options that will change how
- * the callback list behaves or a more traditional option object
- *
- * By default a callback list will act like an event callback list and can be
- * "fired" multiple times.
- *
- * Possible options:
- *
- * once: will ensure the callback list can only be fired once (like a Deferred)
- *
- * memory: will keep track of previous values and will call any callback added
- * after the list has been fired right away with the latest "memorized"
- * values (like a Deferred)
- *
- * unique: will ensure a callback can only be added once (no duplicate in the list)
- *
- * stopOnFalse: interrupt callings when a callback returns false
- *
- */
-jQuery.Callbacks = function( options ) {
-
- // Convert options from String-formatted to Object-formatted if needed
- // (we check in cache first)
- options = typeof options === "string" ?
- createOptions( options ) :
- jQuery.extend( {}, options );
-
- var // Flag to know if list is currently firing
- firing,
-
- // Last fire value for non-forgettable lists
- memory,
-
- // Flag to know if list was already fired
- fired,
-
- // Flag to prevent firing
- locked,
-
- // Actual callback list
- list = [],
-
- // Queue of execution data for repeatable lists
- queue = [],
-
- // Index of currently firing callback (modified by add/remove as needed)
- firingIndex = -1,
-
- // Fire callbacks
- fire = function() {
-
- // Enforce single-firing
- locked = locked || options.once;
-
- // Execute callbacks for all pending executions,
- // respecting firingIndex overrides and runtime changes
- fired = firing = true;
- for ( ; queue.length; firingIndex = -1 ) {
- memory = queue.shift();
- while ( ++firingIndex < list.length ) {
-
- // Run callback and check for early termination
- if ( list[ firingIndex ].apply( memory[ 0 ], memory[ 1 ] ) === false &&
- options.stopOnFalse ) {
-
- // Jump to end and forget the data so .add doesn't re-fire
- firingIndex = list.length;
- memory = false;
- }
- }
- }
-
- // Forget the data if we're done with it
- if ( !options.memory ) {
- memory = false;
- }
-
- firing = false;
-
- // Clean up if we're done firing for good
- if ( locked ) {
-
- // Keep an empty list if we have data for future add calls
- if ( memory ) {
- list = [];
-
- // Otherwise, this object is spent
- } else {
- list = "";
- }
- }
- },
-
- // Actual Callbacks object
- self = {
-
- // Add a callback or a collection of callbacks to the list
- add: function() {
- if ( list ) {
-
- // If we have memory from a past run, we should fire after adding
- if ( memory && !firing ) {
- firingIndex = list.length - 1;
- queue.push( memory );
- }
-
- ( function add( args ) {
- jQuery.each( args, function( _, arg ) {
- if ( jQuery.isFunction( arg ) ) {
- if ( !options.unique || !self.has( arg ) ) {
- list.push( arg );
- }
- } else if ( arg && arg.length && jQuery.type( arg ) !== "string" ) {
-
- // Inspect recursively
- add( arg );
- }
- } );
- } )( arguments );
-
- if ( memory && !firing ) {
- fire();
- }
- }
- return this;
- },
-
- // Remove a callback from the list
- remove: function() {
- jQuery.each( arguments, function( _, arg ) {
- var index;
- while ( ( index = jQuery.inArray( arg, list, index ) ) > -1 ) {
- list.splice( index, 1 );
-
- // Handle firing indexes
- if ( index <= firingIndex ) {
- firingIndex--;
- }
- }
- } );
- return this;
- },
-
- // Check if a given callback is in the list.
- // If no argument is given, return whether or not list has callbacks attached.
- has: function( fn ) {
- return fn ?
- jQuery.inArray( fn, list ) > -1 :
- list.length > 0;
- },
-
- // Remove all callbacks from the list
- empty: function() {
- if ( list ) {
- list = [];
- }
- return this;
- },
-
- // Disable .fire and .add
- // Abort any current/pending executions
- // Clear all callbacks and values
- disable: function() {
- locked = queue = [];
- list = memory = "";
- return this;
- },
- disabled: function() {
- return !list;
- },
-
- // Disable .fire
- // Also disable .add unless we have memory (since it would have no effect)
- // Abort any pending executions
- lock: function() {
- locked = queue = [];
- if ( !memory && !firing ) {
- list = memory = "";
- }
- return this;
- },
- locked: function() {
- return !!locked;
- },
-
- // Call all callbacks with the given context and arguments
- fireWith: function( context, args ) {
- if ( !locked ) {
- args = args || [];
- args = [ context, args.slice ? args.slice() : args ];
- queue.push( args );
- if ( !firing ) {
- fire();
- }
- }
- return this;
- },
-
- // Call all the callbacks with the given arguments
- fire: function() {
- self.fireWith( this, arguments );
- return this;
- },
-
- // To know if the callbacks have already been called at least once
- fired: function() {
- return !!fired;
- }
- };
-
- return self;
-};
-
-
-function Identity( v ) {
- return v;
-}
-function Thrower( ex ) {
- throw ex;
-}
-
-function adoptValue( value, resolve, reject, noValue ) {
- var method;
-
- try {
-
- // Check for promise aspect first to privilege synchronous behavior
- if ( value && jQuery.isFunction( ( method = value.promise ) ) ) {
- method.call( value ).done( resolve ).fail( reject );
-
- // Other thenables
- } else if ( value && jQuery.isFunction( ( method = value.then ) ) ) {
- method.call( value, resolve, reject );
-
- // Other non-thenables
- } else {
-
- // Control `resolve` arguments by letting Array#slice cast boolean `noValue` to integer:
- // * false: [ value ].slice( 0 ) => resolve( value )
- // * true: [ value ].slice( 1 ) => resolve()
- resolve.apply( undefined, [ value ].slice( noValue ) );
- }
-
- // For Promises/A+, convert exceptions into rejections
- // Since jQuery.when doesn't unwrap thenables, we can skip the extra checks appearing in
- // Deferred#then to conditionally suppress rejection.
- } catch ( value ) {
-
- // Support: Android 4.0 only
- // Strict mode functions invoked without .call/.apply get global-object context
- reject.apply( undefined, [ value ] );
- }
-}
-
-jQuery.extend( {
-
- Deferred: function( func ) {
- var tuples = [
-
- // action, add listener, callbacks,
- // ... .then handlers, argument index, [final state]
- [ "notify", "progress", jQuery.Callbacks( "memory" ),
- jQuery.Callbacks( "memory" ), 2 ],
- [ "resolve", "done", jQuery.Callbacks( "once memory" ),
- jQuery.Callbacks( "once memory" ), 0, "resolved" ],
- [ "reject", "fail", jQuery.Callbacks( "once memory" ),
- jQuery.Callbacks( "once memory" ), 1, "rejected" ]
- ],
- state = "pending",
- promise = {
- state: function() {
- return state;
- },
- always: function() {
- deferred.done( arguments ).fail( arguments );
- return this;
- },
- "catch": function( fn ) {
- return promise.then( null, fn );
- },
-
- // Keep pipe for back-compat
- pipe: function( /* fnDone, fnFail, fnProgress */ ) {
- var fns = arguments;
-
- return jQuery.Deferred( function( newDefer ) {
- jQuery.each( tuples, function( i, tuple ) {
-
- // Map tuples (progress, done, fail) to arguments (done, fail, progress)
- var fn = jQuery.isFunction( fns[ tuple[ 4 ] ] ) && fns[ tuple[ 4 ] ];
-
- // deferred.progress(function() { bind to newDefer or newDefer.notify })
- // deferred.done(function() { bind to newDefer or newDefer.resolve })
- // deferred.fail(function() { bind to newDefer or newDefer.reject })
- deferred[ tuple[ 1 ] ]( function() {
- var returned = fn && fn.apply( this, arguments );
- if ( returned && jQuery.isFunction( returned.promise ) ) {
- returned.promise()
- .progress( newDefer.notify )
- .done( newDefer.resolve )
- .fail( newDefer.reject );
- } else {
- newDefer[ tuple[ 0 ] + "With" ](
- this,
- fn ? [ returned ] : arguments
- );
- }
- } );
- } );
- fns = null;
- } ).promise();
- },
- then: function( onFulfilled, onRejected, onProgress ) {
- var maxDepth = 0;
- function resolve( depth, deferred, handler, special ) {
- return function() {
- var that = this,
- args = arguments,
- mightThrow = function() {
- var returned, then;
-
- // Support: Promises/A+ section 2.3.3.3.3
- // https://promisesaplus.com/#point-59
- // Ignore double-resolution attempts
- if ( depth < maxDepth ) {
- return;
- }
-
- returned = handler.apply( that, args );
-
- // Support: Promises/A+ section 2.3.1
- // https://promisesaplus.com/#point-48
- if ( returned === deferred.promise() ) {
- throw new TypeError( "Thenable self-resolution" );
- }
-
- // Support: Promises/A+ sections 2.3.3.1, 3.5
- // https://promisesaplus.com/#point-54
- // https://promisesaplus.com/#point-75
- // Retrieve `then` only once
- then = returned &&
-
- // Support: Promises/A+ section 2.3.4
- // https://promisesaplus.com/#point-64
- // Only check objects and functions for thenability
- ( typeof returned === "object" ||
- typeof returned === "function" ) &&
- returned.then;
-
- // Handle a returned thenable
- if ( jQuery.isFunction( then ) ) {
-
- // Special processors (notify) just wait for resolution
- if ( special ) {
- then.call(
- returned,
- resolve( maxDepth, deferred, Identity, special ),
- resolve( maxDepth, deferred, Thrower, special )
- );
-
- // Normal processors (resolve) also hook into progress
- } else {
-
- // ...and disregard older resolution values
- maxDepth++;
-
- then.call(
- returned,
- resolve( maxDepth, deferred, Identity, special ),
- resolve( maxDepth, deferred, Thrower, special ),
- resolve( maxDepth, deferred, Identity,
- deferred.notifyWith )
- );
- }
-
- // Handle all other returned values
- } else {
-
- // Only substitute handlers pass on context
- // and multiple values (non-spec behavior)
- if ( handler !== Identity ) {
- that = undefined;
- args = [ returned ];
- }
-
- // Process the value(s)
- // Default process is resolve
- ( special || deferred.resolveWith )( that, args );
- }
- },
-
- // Only normal processors (resolve) catch and reject exceptions
- process = special ?
- mightThrow :
- function() {
- try {
- mightThrow();
- } catch ( e ) {
-
- if ( jQuery.Deferred.exceptionHook ) {
- jQuery.Deferred.exceptionHook( e,
- process.stackTrace );
- }
-
- // Support: Promises/A+ section 2.3.3.3.4.1
- // https://promisesaplus.com/#point-61
- // Ignore post-resolution exceptions
- if ( depth + 1 >= maxDepth ) {
-
- // Only substitute handlers pass on context
- // and multiple values (non-spec behavior)
- if ( handler !== Thrower ) {
- that = undefined;
- args = [ e ];
- }
-
- deferred.rejectWith( that, args );
- }
- }
- };
-
- // Support: Promises/A+ section 2.3.3.3.1
- // https://promisesaplus.com/#point-57
- // Re-resolve promises immediately to dodge false rejection from
- // subsequent errors
- if ( depth ) {
- process();
- } else {
-
- // Call an optional hook to record the stack, in case of exception
- // since it's otherwise lost when execution goes async
- if ( jQuery.Deferred.getStackHook ) {
- process.stackTrace = jQuery.Deferred.getStackHook();
- }
- window.setTimeout( process );
- }
- };
- }
-
- return jQuery.Deferred( function( newDefer ) {
-
- // progress_handlers.add( ... )
- tuples[ 0 ][ 3 ].add(
- resolve(
- 0,
- newDefer,
- jQuery.isFunction( onProgress ) ?
- onProgress :
- Identity,
- newDefer.notifyWith
- )
- );
-
- // fulfilled_handlers.add( ... )
- tuples[ 1 ][ 3 ].add(
- resolve(
- 0,
- newDefer,
- jQuery.isFunction( onFulfilled ) ?
- onFulfilled :
- Identity
- )
- );
-
- // rejected_handlers.add( ... )
- tuples[ 2 ][ 3 ].add(
- resolve(
- 0,
- newDefer,
- jQuery.isFunction( onRejected ) ?
- onRejected :
- Thrower
- )
- );
- } ).promise();
- },
-
- // Get a promise for this deferred
- // If obj is provided, the promise aspect is added to the object
- promise: function( obj ) {
- return obj != null ? jQuery.extend( obj, promise ) : promise;
- }
- },
- deferred = {};
-
- // Add list-specific methods
- jQuery.each( tuples, function( i, tuple ) {
- var list = tuple[ 2 ],
- stateString = tuple[ 5 ];
-
- // promise.progress = list.add
- // promise.done = list.add
- // promise.fail = list.add
- promise[ tuple[ 1 ] ] = list.add;
-
- // Handle state
- if ( stateString ) {
- list.add(
- function() {
-
- // state = "resolved" (i.e., fulfilled)
- // state = "rejected"
- state = stateString;
- },
-
- // rejected_callbacks.disable
- // fulfilled_callbacks.disable
- tuples[ 3 - i ][ 2 ].disable,
-
- // progress_callbacks.lock
- tuples[ 0 ][ 2 ].lock
- );
- }
-
- // progress_handlers.fire
- // fulfilled_handlers.fire
- // rejected_handlers.fire
- list.add( tuple[ 3 ].fire );
-
- // deferred.notify = function() { deferred.notifyWith(...) }
- // deferred.resolve = function() { deferred.resolveWith(...) }
- // deferred.reject = function() { deferred.rejectWith(...) }
- deferred[ tuple[ 0 ] ] = function() {
- deferred[ tuple[ 0 ] + "With" ]( this === deferred ? undefined : this, arguments );
- return this;
- };
-
- // deferred.notifyWith = list.fireWith
- // deferred.resolveWith = list.fireWith
- // deferred.rejectWith = list.fireWith
- deferred[ tuple[ 0 ] + "With" ] = list.fireWith;
- } );
-
- // Make the deferred a promise
- promise.promise( deferred );
-
- // Call given func if any
- if ( func ) {
- func.call( deferred, deferred );
- }
-
- // All done!
- return deferred;
- },
-
- // Deferred helper
- when: function( singleValue ) {
- var
-
- // count of uncompleted subordinates
- remaining = arguments.length,
-
- // count of unprocessed arguments
- i = remaining,
-
- // subordinate fulfillment data
- resolveContexts = Array( i ),
- resolveValues = slice.call( arguments ),
-
- // the master Deferred
- master = jQuery.Deferred(),
-
- // subordinate callback factory
- updateFunc = function( i ) {
- return function( value ) {
- resolveContexts[ i ] = this;
- resolveValues[ i ] = arguments.length > 1 ? slice.call( arguments ) : value;
- if ( !( --remaining ) ) {
- master.resolveWith( resolveContexts, resolveValues );
- }
- };
- };
-
- // Single- and empty arguments are adopted like Promise.resolve
- if ( remaining <= 1 ) {
- adoptValue( singleValue, master.done( updateFunc( i ) ).resolve, master.reject,
- !remaining );
-
- // Use .then() to unwrap secondary thenables (cf. gh-3000)
- if ( master.state() === "pending" ||
- jQuery.isFunction( resolveValues[ i ] && resolveValues[ i ].then ) ) {
-
- return master.then();
- }
- }
-
- // Multiple arguments are aggregated like Promise.all array elements
- while ( i-- ) {
- adoptValue( resolveValues[ i ], updateFunc( i ), master.reject );
- }
-
- return master.promise();
- }
-} );
-
-
-// These usually indicate a programmer mistake during development,
-// warn about them ASAP rather than swallowing them by default.
-var rerrorNames = /^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/;
-
-jQuery.Deferred.exceptionHook = function( error, stack ) {
-
- // Support: IE 8 - 9 only
- // Console exists when dev tools are open, which can happen at any time
- if ( window.console && window.console.warn && error && rerrorNames.test( error.name ) ) {
- window.console.warn( "jQuery.Deferred exception: " + error.message, error.stack, stack );
- }
-};
-
-
-
-
-jQuery.readyException = function( error ) {
- window.setTimeout( function() {
- throw error;
- } );
-};
-
-
-
-
-// The deferred used on DOM ready
-var readyList = jQuery.Deferred();
-
-jQuery.fn.ready = function( fn ) {
-
- readyList
- .then( fn )
-
- // Wrap jQuery.readyException in a function so that the lookup
- // happens at the time of error handling instead of callback
- // registration.
- .catch( function( error ) {
- jQuery.readyException( error );
- } );
-
- return this;
-};
-
-jQuery.extend( {
-
- // Is the DOM ready to be used? Set to true once it occurs.
- isReady: false,
-
- // A counter to track how many items to wait for before
- // the ready event fires. See #6781
- readyWait: 1,
-
- // Handle when the DOM is ready
- ready: function( wait ) {
-
- // Abort if there are pending holds or we're already ready
- if ( wait === true ? --jQuery.readyWait : jQuery.isReady ) {
- return;
- }
-
- // Remember that the DOM is ready
- jQuery.isReady = true;
-
- // If a normal DOM Ready event fired, decrement, and wait if need be
- if ( wait !== true && --jQuery.readyWait > 0 ) {
- return;
- }
-
- // If there are functions bound, to execute
- readyList.resolveWith( document, [ jQuery ] );
- }
-} );
-
-jQuery.ready.then = readyList.then;
-
-// The ready event handler and self cleanup method
-function completed() {
- document.removeEventListener( "DOMContentLoaded", completed );
- window.removeEventListener( "load", completed );
- jQuery.ready();
-}
-
-// Catch cases where $(document).ready() is called
-// after the browser event has already occurred.
-// Support: IE <=9 - 10 only
-// Older IE sometimes signals "interactive" too soon
-if ( document.readyState === "complete" ||
- ( document.readyState !== "loading" && !document.documentElement.doScroll ) ) {
-
- // Handle it asynchronously to allow scripts the opportunity to delay ready
- window.setTimeout( jQuery.ready );
-
-} else {
-
- // Use the handy event callback
- document.addEventListener( "DOMContentLoaded", completed );
-
- // A fallback to window.onload, that will always work
- window.addEventListener( "load", completed );
-}
-
-
-
-
-// Multifunctional method to get and set values of a collection
-// The value/s can optionally be executed if it's a function
-var access = function( elems, fn, key, value, chainable, emptyGet, raw ) {
- var i = 0,
- len = elems.length,
- bulk = key == null;
-
- // Sets many values
- if ( jQuery.type( key ) === "object" ) {
- chainable = true;
- for ( i in key ) {
- access( elems, fn, i, key[ i ], true, emptyGet, raw );
- }
-
- // Sets one value
- } else if ( value !== undefined ) {
- chainable = true;
-
- if ( !jQuery.isFunction( value ) ) {
- raw = true;
- }
-
- if ( bulk ) {
-
- // Bulk operations run against the entire set
- if ( raw ) {
- fn.call( elems, value );
- fn = null;
-
- // ...except when executing function values
- } else {
- bulk = fn;
- fn = function( elem, key, value ) {
- return bulk.call( jQuery( elem ), value );
- };
- }
- }
-
- if ( fn ) {
- for ( ; i < len; i++ ) {
- fn(
- elems[ i ], key, raw ?
- value :
- value.call( elems[ i ], i, fn( elems[ i ], key ) )
- );
- }
- }
- }
-
- if ( chainable ) {
- return elems;
- }
-
- // Gets
- if ( bulk ) {
- return fn.call( elems );
- }
-
- return len ? fn( elems[ 0 ], key ) : emptyGet;
-};
-var acceptData = function( owner ) {
-
- // Accepts only:
- // - Node
- // - Node.ELEMENT_NODE
- // - Node.DOCUMENT_NODE
- // - Object
- // - Any
- return owner.nodeType === 1 || owner.nodeType === 9 || !( +owner.nodeType );
-};
-
-
-
-
-function Data() {
- this.expando = jQuery.expando + Data.uid++;
-}
-
-Data.uid = 1;
-
-Data.prototype = {
-
- cache: function( owner ) {
-
- // Check if the owner object already has a cache
- var value = owner[ this.expando ];
-
- // If not, create one
- if ( !value ) {
- value = {};
-
- // We can accept data for non-element nodes in modern browsers,
- // but we should not, see #8335.
- // Always return an empty object.
- if ( acceptData( owner ) ) {
-
- // If it is a node unlikely to be stringify-ed or looped over
- // use plain assignment
- if ( owner.nodeType ) {
- owner[ this.expando ] = value;
-
- // Otherwise secure it in a non-enumerable property
- // configurable must be true to allow the property to be
- // deleted when data is removed
- } else {
- Object.defineProperty( owner, this.expando, {
- value: value,
- configurable: true
- } );
- }
- }
- }
-
- return value;
- },
- set: function( owner, data, value ) {
- var prop,
- cache = this.cache( owner );
-
- // Handle: [ owner, key, value ] args
- // Always use camelCase key (gh-2257)
- if ( typeof data === "string" ) {
- cache[ jQuery.camelCase( data ) ] = value;
-
- // Handle: [ owner, { properties } ] args
- } else {
-
- // Copy the properties one-by-one to the cache object
- for ( prop in data ) {
- cache[ jQuery.camelCase( prop ) ] = data[ prop ];
- }
- }
- return cache;
- },
- get: function( owner, key ) {
- return key === undefined ?
- this.cache( owner ) :
-
- // Always use camelCase key (gh-2257)
- owner[ this.expando ] && owner[ this.expando ][ jQuery.camelCase( key ) ];
- },
- access: function( owner, key, value ) {
-
- // In cases where either:
- //
- // 1. No key was specified
- // 2. A string key was specified, but no value provided
- //
- // Take the "read" path and allow the get method to determine
- // which value to return, respectively either:
- //
- // 1. The entire cache object
- // 2. The data stored at the key
- //
- if ( key === undefined ||
- ( ( key && typeof key === "string" ) && value === undefined ) ) {
-
- return this.get( owner, key );
- }
-
- // When the key is not a string, or both a key and value
- // are specified, set or extend (existing objects) with either:
- //
- // 1. An object of properties
- // 2. A key and value
- //
- this.set( owner, key, value );
-
- // Since the "set" path can have two possible entry points
- // return the expected data based on which path was taken[*]
- return value !== undefined ? value : key;
- },
- remove: function( owner, key ) {
- var i,
- cache = owner[ this.expando ];
-
- if ( cache === undefined ) {
- return;
- }
-
- if ( key !== undefined ) {
-
- // Support array or space separated string of keys
- if ( Array.isArray( key ) ) {
-
- // If key is an array of keys...
- // We always set camelCase keys, so remove that.
- key = key.map( jQuery.camelCase );
- } else {
- key = jQuery.camelCase( key );
-
- // If a key with the spaces exists, use it.
- // Otherwise, create an array by matching non-whitespace
- key = key in cache ?
- [ key ] :
- ( key.match( rnothtmlwhite ) || [] );
- }
-
- i = key.length;
-
- while ( i-- ) {
- delete cache[ key[ i ] ];
- }
- }
-
- // Remove the expando if there's no more data
- if ( key === undefined || jQuery.isEmptyObject( cache ) ) {
-
- // Support: Chrome <=35 - 45
- // Webkit & Blink performance suffers when deleting properties
- // from DOM nodes, so set to undefined instead
- // https://bugs.chromium.org/p/chromium/issues/detail?id=378607 (bug restricted)
- if ( owner.nodeType ) {
- owner[ this.expando ] = undefined;
- } else {
- delete owner[ this.expando ];
- }
- }
- },
- hasData: function( owner ) {
- var cache = owner[ this.expando ];
- return cache !== undefined && !jQuery.isEmptyObject( cache );
- }
-};
-var dataPriv = new Data();
-
-var dataUser = new Data();
-
-
-
-// Implementation Summary
-//
-// 1. Enforce API surface and semantic compatibility with 1.9.x branch
-// 2. Improve the module's maintainability by reducing the storage
-// paths to a single mechanism.
-// 3. Use the same single mechanism to support "private" and "user" data.
-// 4. _Never_ expose "private" data to user code (TODO: Drop _data, _removeData)
-// 5. Avoid exposing implementation details on user objects (eg. expando properties)
-// 6. Provide a clear path for implementation upgrade to WeakMap in 2014
-
-var rbrace = /^(?:\{[\w\W]*\}|\[[\w\W]*\])$/,
- rmultiDash = /[A-Z]/g;
-
-function getData( data ) {
- if ( data === "true" ) {
- return true;
- }
-
- if ( data === "false" ) {
- return false;
- }
-
- if ( data === "null" ) {
- return null;
- }
-
- // Only convert to a number if it doesn't change the string
- if ( data === +data + "" ) {
- return +data;
- }
-
- if ( rbrace.test( data ) ) {
- return JSON.parse( data );
- }
-
- return data;
-}
-
-function dataAttr( elem, key, data ) {
- var name;
-
- // If nothing was found internally, try to fetch any
- // data from the HTML5 data-* attribute
- if ( data === undefined && elem.nodeType === 1 ) {
- name = "data-" + key.replace( rmultiDash, "-$&" ).toLowerCase();
- data = elem.getAttribute( name );
-
- if ( typeof data === "string" ) {
- try {
- data = getData( data );
- } catch ( e ) {}
-
- // Make sure we set the data so it isn't changed later
- dataUser.set( elem, key, data );
- } else {
- data = undefined;
- }
- }
- return data;
-}
-
-jQuery.extend( {
- hasData: function( elem ) {
- return dataUser.hasData( elem ) || dataPriv.hasData( elem );
- },
-
- data: function( elem, name, data ) {
- return dataUser.access( elem, name, data );
- },
-
- removeData: function( elem, name ) {
- dataUser.remove( elem, name );
- },
-
- // TODO: Now that all calls to _data and _removeData have been replaced
- // with direct calls to dataPriv methods, these can be deprecated.
- _data: function( elem, name, data ) {
- return dataPriv.access( elem, name, data );
- },
-
- _removeData: function( elem, name ) {
- dataPriv.remove( elem, name );
- }
-} );
-
-jQuery.fn.extend( {
- data: function( key, value ) {
- var i, name, data,
- elem = this[ 0 ],
- attrs = elem && elem.attributes;
-
- // Gets all values
- if ( key === undefined ) {
- if ( this.length ) {
- data = dataUser.get( elem );
-
- if ( elem.nodeType === 1 && !dataPriv.get( elem, "hasDataAttrs" ) ) {
- i = attrs.length;
- while ( i-- ) {
-
- // Support: IE 11 only
- // The attrs elements can be null (#14894)
- if ( attrs[ i ] ) {
- name = attrs[ i ].name;
- if ( name.indexOf( "data-" ) === 0 ) {
- name = jQuery.camelCase( name.slice( 5 ) );
- dataAttr( elem, name, data[ name ] );
- }
- }
- }
- dataPriv.set( elem, "hasDataAttrs", true );
- }
- }
-
- return data;
- }
-
- // Sets multiple values
- if ( typeof key === "object" ) {
- return this.each( function() {
- dataUser.set( this, key );
- } );
- }
-
- return access( this, function( value ) {
- var data;
-
- // The calling jQuery object (element matches) is not empty
- // (and therefore has an element appears at this[ 0 ]) and the
- // `value` parameter was not undefined. An empty jQuery object
- // will result in `undefined` for elem = this[ 0 ] which will
- // throw an exception if an attempt to read a data cache is made.
- if ( elem && value === undefined ) {
-
- // Attempt to get data from the cache
- // The key will always be camelCased in Data
- data = dataUser.get( elem, key );
- if ( data !== undefined ) {
- return data;
- }
-
- // Attempt to "discover" the data in
- // HTML5 custom data-* attrs
- data = dataAttr( elem, key );
- if ( data !== undefined ) {
- return data;
- }
-
- // We tried really hard, but the data doesn't exist.
- return;
- }
-
- // Set the data...
- this.each( function() {
-
- // We always store the camelCased key
- dataUser.set( this, key, value );
- } );
- }, null, value, arguments.length > 1, null, true );
- },
-
- removeData: function( key ) {
- return this.each( function() {
- dataUser.remove( this, key );
- } );
- }
-} );
-
-
-jQuery.extend( {
- queue: function( elem, type, data ) {
- var queue;
-
- if ( elem ) {
- type = ( type || "fx" ) + "queue";
- queue = dataPriv.get( elem, type );
-
- // Speed up dequeue by getting out quickly if this is just a lookup
- if ( data ) {
- if ( !queue || Array.isArray( data ) ) {
- queue = dataPriv.access( elem, type, jQuery.makeArray( data ) );
- } else {
- queue.push( data );
- }
- }
- return queue || [];
- }
- },
-
- dequeue: function( elem, type ) {
- type = type || "fx";
-
- var queue = jQuery.queue( elem, type ),
- startLength = queue.length,
- fn = queue.shift(),
- hooks = jQuery._queueHooks( elem, type ),
- next = function() {
- jQuery.dequeue( elem, type );
- };
-
- // If the fx queue is dequeued, always remove the progress sentinel
- if ( fn === "inprogress" ) {
- fn = queue.shift();
- startLength--;
- }
-
- if ( fn ) {
-
- // Add a progress sentinel to prevent the fx queue from being
- // automatically dequeued
- if ( type === "fx" ) {
- queue.unshift( "inprogress" );
- }
-
- // Clear up the last queue stop function
- delete hooks.stop;
- fn.call( elem, next, hooks );
- }
-
- if ( !startLength && hooks ) {
- hooks.empty.fire();
- }
- },
-
- // Not public - generate a queueHooks object, or return the current one
- _queueHooks: function( elem, type ) {
- var key = type + "queueHooks";
- return dataPriv.get( elem, key ) || dataPriv.access( elem, key, {
- empty: jQuery.Callbacks( "once memory" ).add( function() {
- dataPriv.remove( elem, [ type + "queue", key ] );
- } )
- } );
- }
-} );
-
-jQuery.fn.extend( {
- queue: function( type, data ) {
- var setter = 2;
-
- if ( typeof type !== "string" ) {
- data = type;
- type = "fx";
- setter--;
- }
-
- if ( arguments.length < setter ) {
- return jQuery.queue( this[ 0 ], type );
- }
-
- return data === undefined ?
- this :
- this.each( function() {
- var queue = jQuery.queue( this, type, data );
-
- // Ensure a hooks for this queue
- jQuery._queueHooks( this, type );
-
- if ( type === "fx" && queue[ 0 ] !== "inprogress" ) {
- jQuery.dequeue( this, type );
- }
- } );
- },
- dequeue: function( type ) {
- return this.each( function() {
- jQuery.dequeue( this, type );
- } );
- },
- clearQueue: function( type ) {
- return this.queue( type || "fx", [] );
- },
-
- // Get a promise resolved when queues of a certain type
- // are emptied (fx is the type by default)
- promise: function( type, obj ) {
- var tmp,
- count = 1,
- defer = jQuery.Deferred(),
- elements = this,
- i = this.length,
- resolve = function() {
- if ( !( --count ) ) {
- defer.resolveWith( elements, [ elements ] );
- }
- };
-
- if ( typeof type !== "string" ) {
- obj = type;
- type = undefined;
- }
- type = type || "fx";
-
- while ( i-- ) {
- tmp = dataPriv.get( elements[ i ], type + "queueHooks" );
- if ( tmp && tmp.empty ) {
- count++;
- tmp.empty.add( resolve );
- }
- }
- resolve();
- return defer.promise( obj );
- }
-} );
-var pnum = ( /[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/ ).source;
-
-var rcssNum = new RegExp( "^(?:([+-])=|)(" + pnum + ")([a-z%]*)$", "i" );
-
-
-var cssExpand = [ "Top", "Right", "Bottom", "Left" ];
-
-var isHiddenWithinTree = function( elem, el ) {
-
- // isHiddenWithinTree might be called from jQuery#filter function;
- // in that case, element will be second argument
- elem = el || elem;
-
- // Inline style trumps all
- return elem.style.display === "none" ||
- elem.style.display === "" &&
-
- // Otherwise, check computed style
- // Support: Firefox <=43 - 45
- // Disconnected elements can have computed display: none, so first confirm that elem is
- // in the document.
- jQuery.contains( elem.ownerDocument, elem ) &&
-
- jQuery.css( elem, "display" ) === "none";
- };
-
-var swap = function( elem, options, callback, args ) {
- var ret, name,
- old = {};
-
- // Remember the old values, and insert the new ones
- for ( name in options ) {
- old[ name ] = elem.style[ name ];
- elem.style[ name ] = options[ name ];
- }
-
- ret = callback.apply( elem, args || [] );
-
- // Revert the old values
- for ( name in options ) {
- elem.style[ name ] = old[ name ];
- }
-
- return ret;
-};
-
-
-
-
-function adjustCSS( elem, prop, valueParts, tween ) {
- var adjusted,
- scale = 1,
- maxIterations = 20,
- currentValue = tween ?
- function() {
- return tween.cur();
- } :
- function() {
- return jQuery.css( elem, prop, "" );
- },
- initial = currentValue(),
- unit = valueParts && valueParts[ 3 ] || ( jQuery.cssNumber[ prop ] ? "" : "px" ),
-
- // Starting value computation is required for potential unit mismatches
- initialInUnit = ( jQuery.cssNumber[ prop ] || unit !== "px" && +initial ) &&
- rcssNum.exec( jQuery.css( elem, prop ) );
-
- if ( initialInUnit && initialInUnit[ 3 ] !== unit ) {
-
- // Trust units reported by jQuery.css
- unit = unit || initialInUnit[ 3 ];
-
- // Make sure we update the tween properties later on
- valueParts = valueParts || [];
-
- // Iteratively approximate from a nonzero starting point
- initialInUnit = +initial || 1;
-
- do {
-
- // If previous iteration zeroed out, double until we get *something*.
- // Use string for doubling so we don't accidentally see scale as unchanged below
- scale = scale || ".5";
-
- // Adjust and apply
- initialInUnit = initialInUnit / scale;
- jQuery.style( elem, prop, initialInUnit + unit );
-
- // Update scale, tolerating zero or NaN from tween.cur()
- // Break the loop if scale is unchanged or perfect, or if we've just had enough.
- } while (
- scale !== ( scale = currentValue() / initial ) && scale !== 1 && --maxIterations
- );
- }
-
- if ( valueParts ) {
- initialInUnit = +initialInUnit || +initial || 0;
-
- // Apply relative offset (+=/-=) if specified
- adjusted = valueParts[ 1 ] ?
- initialInUnit + ( valueParts[ 1 ] + 1 ) * valueParts[ 2 ] :
- +valueParts[ 2 ];
- if ( tween ) {
- tween.unit = unit;
- tween.start = initialInUnit;
- tween.end = adjusted;
- }
- }
- return adjusted;
-}
-
-
-var defaultDisplayMap = {};
-
-function getDefaultDisplay( elem ) {
- var temp,
- doc = elem.ownerDocument,
- nodeName = elem.nodeName,
- display = defaultDisplayMap[ nodeName ];
-
- if ( display ) {
- return display;
- }
-
- temp = doc.body.appendChild( doc.createElement( nodeName ) );
- display = jQuery.css( temp, "display" );
-
- temp.parentNode.removeChild( temp );
-
- if ( display === "none" ) {
- display = "block";
- }
- defaultDisplayMap[ nodeName ] = display;
-
- return display;
-}
-
-function showHide( elements, show ) {
- var display, elem,
- values = [],
- index = 0,
- length = elements.length;
-
- // Determine new display value for elements that need to change
- for ( ; index < length; index++ ) {
- elem = elements[ index ];
- if ( !elem.style ) {
- continue;
- }
-
- display = elem.style.display;
- if ( show ) {
-
- // Since we force visibility upon cascade-hidden elements, an immediate (and slow)
- // check is required in this first loop unless we have a nonempty display value (either
- // inline or about-to-be-restored)
- if ( display === "none" ) {
- values[ index ] = dataPriv.get( elem, "display" ) || null;
- if ( !values[ index ] ) {
- elem.style.display = "";
- }
- }
- if ( elem.style.display === "" && isHiddenWithinTree( elem ) ) {
- values[ index ] = getDefaultDisplay( elem );
- }
- } else {
- if ( display !== "none" ) {
- values[ index ] = "none";
-
- // Remember what we're overwriting
- dataPriv.set( elem, "display", display );
- }
- }
- }
-
- // Set the display of the elements in a second loop to avoid constant reflow
- for ( index = 0; index < length; index++ ) {
- if ( values[ index ] != null ) {
- elements[ index ].style.display = values[ index ];
- }
- }
-
- return elements;
-}
-
-jQuery.fn.extend( {
- show: function() {
- return showHide( this, true );
- },
- hide: function() {
- return showHide( this );
- },
- toggle: function( state ) {
- if ( typeof state === "boolean" ) {
- return state ? this.show() : this.hide();
- }
-
- return this.each( function() {
- if ( isHiddenWithinTree( this ) ) {
- jQuery( this ).show();
- } else {
- jQuery( this ).hide();
- }
- } );
- }
-} );
-var rcheckableType = ( /^(?:checkbox|radio)$/i );
-
-var rtagName = ( /<([a-z][^\/\0>\x20\t\r\n\f]+)/i );
-
-var rscriptType = ( /^$|\/(?:java|ecma)script/i );
-
-
-
-// We have to close these tags to support XHTML (#13200)
-var wrapMap = {
-
- // Support: IE <=9 only
- option: [ 1, "<select multiple='multiple'>", "</select>" ],
-
- // XHTML parsers do not magically insert elements in the
- // same way that tag soup parsers do. So we cannot shorten
- // this by omitting <tbody> or other required elements.
- thead: [ 1, "<table>", "</table>" ],
- col: [ 2, "<table><colgroup>", "</colgroup></table>" ],
- tr: [ 2, "<table><tbody>", "</tbody></table>" ],
- td: [ 3, "<table><tbody><tr>", "</tr></tbody></table>" ],
-
- _default: [ 0, "", "" ]
-};
-
-// Support: IE <=9 only
-wrapMap.optgroup = wrapMap.option;
-
-wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead;
-wrapMap.th = wrapMap.td;
-
-
-function getAll( context, tag ) {
-
- // Support: IE <=9 - 11 only
- // Use typeof to avoid zero-argument method invocation on host objects (#15151)
- var ret;
-
- if ( typeof context.getElementsByTagName !== "undefined" ) {
- ret = context.getElementsByTagName( tag || "*" );
-
- } else if ( typeof context.querySelectorAll !== "undefined" ) {
- ret = context.querySelectorAll( tag || "*" );
-
- } else {
- ret = [];
- }
-
- if ( tag === undefined || tag && nodeName( context, tag ) ) {
- return jQuery.merge( [ context ], ret );
- }
-
- return ret;
-}
-
-
-// Mark scripts as having already been evaluated
-function setGlobalEval( elems, refElements ) {
- var i = 0,
- l = elems.length;
-
- for ( ; i < l; i++ ) {
- dataPriv.set(
- elems[ i ],
- "globalEval",
- !refElements || dataPriv.get( refElements[ i ], "globalEval" )
- );
- }
-}
-
-
-var rhtml = /<|&#?\w+;/;
-
-function buildFragment( elems, context, scripts, selection, ignored ) {
- var elem, tmp, tag, wrap, contains, j,
- fragment = context.createDocumentFragment(),
- nodes = [],
- i = 0,
- l = elems.length;
-
- for ( ; i < l; i++ ) {
- elem = elems[ i ];
-
- if ( elem || elem === 0 ) {
-
- // Add nodes directly
- if ( jQuery.type( elem ) === "object" ) {
-
- // Support: Android <=4.0 only, PhantomJS 1 only
- // push.apply(_, arraylike) throws on ancient WebKit
- jQuery.merge( nodes, elem.nodeType ? [ elem ] : elem );
-
- // Convert non-html into a text node
- } else if ( !rhtml.test( elem ) ) {
- nodes.push( context.createTextNode( elem ) );
-
- // Convert html into DOM nodes
- } else {
- tmp = tmp || fragment.appendChild( context.createElement( "div" ) );
-
- // Deserialize a standard representation
- tag = ( rtagName.exec( elem ) || [ "", "" ] )[ 1 ].toLowerCase();
- wrap = wrapMap[ tag ] || wrapMap._default;
- tmp.innerHTML = wrap[ 1 ] + jQuery.htmlPrefilter( elem ) + wrap[ 2 ];
-
- // Descend through wrappers to the right content
- j = wrap[ 0 ];
- while ( j-- ) {
- tmp = tmp.lastChild;
- }
-
- // Support: Android <=4.0 only, PhantomJS 1 only
- // push.apply(_, arraylike) throws on ancient WebKit
- jQuery.merge( nodes, tmp.childNodes );
-
- // Remember the top-level container
- tmp = fragment.firstChild;
-
- // Ensure the created nodes are orphaned (#12392)
- tmp.textContent = "";
- }
- }
- }
-
- // Remove wrapper from fragment
- fragment.textContent = "";
-
- i = 0;
- while ( ( elem = nodes[ i++ ] ) ) {
-
- // Skip elements already in the context collection (trac-4087)
- if ( selection && jQuery.inArray( elem, selection ) > -1 ) {
- if ( ignored ) {
- ignored.push( elem );
- }
- continue;
- }
-
- contains = jQuery.contains( elem.ownerDocument, elem );
-
- // Append to fragment
- tmp = getAll( fragment.appendChild( elem ), "script" );
-
- // Preserve script evaluation history
- if ( contains ) {
- setGlobalEval( tmp );
- }
-
- // Capture executables
- if ( scripts ) {
- j = 0;
- while ( ( elem = tmp[ j++ ] ) ) {
- if ( rscriptType.test( elem.type || "" ) ) {
- scripts.push( elem );
- }
- }
- }
- }
-
- return fragment;
-}
-
-
-( function() {
- var fragment = document.createDocumentFragment(),
- div = fragment.appendChild( document.createElement( "div" ) ),
- input = document.createElement( "input" );
-
- // Support: Android 4.0 - 4.3 only
- // Check state lost if the name is set (#11217)
- // Support: Windows Web Apps (WWA)
- // `name` and `type` must use .setAttribute for WWA (#14901)
- input.setAttribute( "type", "radio" );
- input.setAttribute( "checked", "checked" );
- input.setAttribute( "name", "t" );
-
- div.appendChild( input );
-
- // Support: Android <=4.1 only
- // Older WebKit doesn't clone checked state correctly in fragments
- support.checkClone = div.cloneNode( true ).cloneNode( true ).lastChild.checked;
-
- // Support: IE <=11 only
- // Make sure textarea (and checkbox) defaultValue is properly cloned
- div.innerHTML = "<textarea>x</textarea>";
- support.noCloneChecked = !!div.cloneNode( true ).lastChild.defaultValue;
-} )();
-var documentElement = document.documentElement;
-
-
-
-var
- rkeyEvent = /^key/,
- rmouseEvent = /^(?:mouse|pointer|contextmenu|drag|drop)|click/,
- rtypenamespace = /^([^.]*)(?:\.(.+)|)/;
-
-function returnTrue() {
- return true;
-}
-
-function returnFalse() {
- return false;
-}
-
-// Support: IE <=9 only
-// See #13393 for more info
-function safeActiveElement() {
- try {
- return document.activeElement;
- } catch ( err ) { }
-}
-
-function on( elem, types, selector, data, fn, one ) {
- var origFn, type;
-
- // Types can be a map of types/handlers
- if ( typeof types === "object" ) {
-
- // ( types-Object, selector, data )
- if ( typeof selector !== "string" ) {
-
- // ( types-Object, data )
- data = data || selector;
- selector = undefined;
- }
- for ( type in types ) {
- on( elem, type, selector, data, types[ type ], one );
- }
- return elem;
- }
-
- if ( data == null && fn == null ) {
-
- // ( types, fn )
- fn = selector;
- data = selector = undefined;
- } else if ( fn == null ) {
- if ( typeof selector === "string" ) {
-
- // ( types, selector, fn )
- fn = data;
- data = undefined;
- } else {
-
- // ( types, data, fn )
- fn = data;
- data = selector;
- selector = undefined;
- }
- }
- if ( fn === false ) {
- fn = returnFalse;
- } else if ( !fn ) {
- return elem;
- }
-
- if ( one === 1 ) {
- origFn = fn;
- fn = function( event ) {
-
- // Can use an empty set, since event contains the info
- jQuery().off( event );
- return origFn.apply( this, arguments );
- };
-
- // Use same guid so caller can remove using origFn
- fn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ );
- }
- return elem.each( function() {
- jQuery.event.add( this, types, fn, data, selector );
- } );
-}
-
-/*
- * Helper functions for managing events -- not part of the public interface.
- * Props to Dean Edwards' addEvent library for many of the ideas.
- */
-jQuery.event = {
-
- global: {},
-
- add: function( elem, types, handler, data, selector ) {
-
- var handleObjIn, eventHandle, tmp,
- events, t, handleObj,
- special, handlers, type, namespaces, origType,
- elemData = dataPriv.get( elem );
-
- // Don't attach events to noData or text/comment nodes (but allow plain objects)
- if ( !elemData ) {
- return;
- }
-
- // Caller can pass in an object of custom data in lieu of the handler
- if ( handler.handler ) {
- handleObjIn = handler;
- handler = handleObjIn.handler;
- selector = handleObjIn.selector;
- }
-
- // Ensure that invalid selectors throw exceptions at attach time
- // Evaluate against documentElement in case elem is a non-element node (e.g., document)
- if ( selector ) {
- jQuery.find.matchesSelector( documentElement, selector );
- }
-
- // Make sure that the handler has a unique ID, used to find/remove it later
- if ( !handler.guid ) {
- handler.guid = jQuery.guid++;
- }
-
- // Init the element's event structure and main handler, if this is the first
- if ( !( events = elemData.events ) ) {
- events = elemData.events = {};
- }
- if ( !( eventHandle = elemData.handle ) ) {
- eventHandle = elemData.handle = function( e ) {
-
- // Discard the second event of a jQuery.event.trigger() and
- // when an event is called after a page has unloaded
- return typeof jQuery !== "undefined" && jQuery.event.triggered !== e.type ?
- jQuery.event.dispatch.apply( elem, arguments ) : undefined;
- };
- }
-
- // Handle multiple events separated by a space
- types = ( types || "" ).match( rnothtmlwhite ) || [ "" ];
- t = types.length;
- while ( t-- ) {
- tmp = rtypenamespace.exec( types[ t ] ) || [];
- type = origType = tmp[ 1 ];
- namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort();
-
- // There *must* be a type, no attaching namespace-only handlers
- if ( !type ) {
- continue;
- }
-
- // If event changes its type, use the special event handlers for the changed type
- special = jQuery.event.special[ type ] || {};
-
- // If selector defined, determine special event api type, otherwise given type
- type = ( selector ? special.delegateType : special.bindType ) || type;
-
- // Update special based on newly reset type
- special = jQuery.event.special[ type ] || {};
-
- // handleObj is passed to all event handlers
- handleObj = jQuery.extend( {
- type: type,
- origType: origType,
- data: data,
- handler: handler,
- guid: handler.guid,
- selector: selector,
- needsContext: selector && jQuery.expr.match.needsContext.test( selector ),
- namespace: namespaces.join( "." )
- }, handleObjIn );
-
- // Init the event handler queue if we're the first
- if ( !( handlers = events[ type ] ) ) {
- handlers = events[ type ] = [];
- handlers.delegateCount = 0;
-
- // Only use addEventListener if the special events handler returns false
- if ( !special.setup ||
- special.setup.call( elem, data, namespaces, eventHandle ) === false ) {
-
- if ( elem.addEventListener ) {
- elem.addEventListener( type, eventHandle );
- }
- }
- }
-
- if ( special.add ) {
- special.add.call( elem, handleObj );
-
- if ( !handleObj.handler.guid ) {
- handleObj.handler.guid = handler.guid;
- }
- }
-
- // Add to the element's handler list, delegates in front
- if ( selector ) {
- handlers.splice( handlers.delegateCount++, 0, handleObj );
- } else {
- handlers.push( handleObj );
- }
-
- // Keep track of which events have ever been used, for event optimization
- jQuery.event.global[ type ] = true;
- }
-
- },
-
- // Detach an event or set of events from an element
- remove: function( elem, types, handler, selector, mappedTypes ) {
-
- var j, origCount, tmp,
- events, t, handleObj,
- special, handlers, type, namespaces, origType,
- elemData = dataPriv.hasData( elem ) && dataPriv.get( elem );
-
- if ( !elemData || !( events = elemData.events ) ) {
- return;
- }
-
- // Once for each type.namespace in types; type may be omitted
- types = ( types || "" ).match( rnothtmlwhite ) || [ "" ];
- t = types.length;
- while ( t-- ) {
- tmp = rtypenamespace.exec( types[ t ] ) || [];
- type = origType = tmp[ 1 ];
- namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort();
-
- // Unbind all events (on this namespace, if provided) for the element
- if ( !type ) {
- for ( type in events ) {
- jQuery.event.remove( elem, type + types[ t ], handler, selector, true );
- }
- continue;
- }
-
- special = jQuery.event.special[ type ] || {};
- type = ( selector ? special.delegateType : special.bindType ) || type;
- handlers = events[ type ] || [];
- tmp = tmp[ 2 ] &&
- new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" );
-
- // Remove matching events
- origCount = j = handlers.length;
- while ( j-- ) {
- handleObj = handlers[ j ];
-
- if ( ( mappedTypes || origType === handleObj.origType ) &&
- ( !handler || handler.guid === handleObj.guid ) &&
- ( !tmp || tmp.test( handleObj.namespace ) ) &&
- ( !selector || selector === handleObj.selector ||
- selector === "**" && handleObj.selector ) ) {
- handlers.splice( j, 1 );
-
- if ( handleObj.selector ) {
- handlers.delegateCount--;
- }
- if ( special.remove ) {
- special.remove.call( elem, handleObj );
- }
- }
- }
-
- // Remove generic event handler if we removed something and no more handlers exist
- // (avoids potential for endless recursion during removal of special event handlers)
- if ( origCount && !handlers.length ) {
- if ( !special.teardown ||
- special.teardown.call( elem, namespaces, elemData.handle ) === false ) {
-
- jQuery.removeEvent( elem, type, elemData.handle );
- }
-
- delete events[ type ];
- }
- }
-
- // Remove data and the expando if it's no longer used
- if ( jQuery.isEmptyObject( events ) ) {
- dataPriv.remove( elem, "handle events" );
- }
- },
-
- dispatch: function( nativeEvent ) {
-
- // Make a writable jQuery.Event from the native event object
- var event = jQuery.event.fix( nativeEvent );
-
- var i, j, ret, matched, handleObj, handlerQueue,
- args = new Array( arguments.length ),
- handlers = ( dataPriv.get( this, "events" ) || {} )[ event.type ] || [],
- special = jQuery.event.special[ event.type ] || {};
-
- // Use the fix-ed jQuery.Event rather than the (read-only) native event
- args[ 0 ] = event;
-
- for ( i = 1; i < arguments.length; i++ ) {
- args[ i ] = arguments[ i ];
- }
-
- event.delegateTarget = this;
-
- // Call the preDispatch hook for the mapped type, and let it bail if desired
- if ( special.preDispatch && special.preDispatch.call( this, event ) === false ) {
- return;
- }
-
- // Determine handlers
- handlerQueue = jQuery.event.handlers.call( this, event, handlers );
-
- // Run delegates first; they may want to stop propagation beneath us
- i = 0;
- while ( ( matched = handlerQueue[ i++ ] ) && !event.isPropagationStopped() ) {
- event.currentTarget = matched.elem;
-
- j = 0;
- while ( ( handleObj = matched.handlers[ j++ ] ) &&
- !event.isImmediatePropagationStopped() ) {
-
- // Triggered event must either 1) have no namespace, or 2) have namespace(s)
- // a subset or equal to those in the bound event (both can have no namespace).
- if ( !event.rnamespace || event.rnamespace.test( handleObj.namespace ) ) {
-
- event.handleObj = handleObj;
- event.data = handleObj.data;
-
- ret = ( ( jQuery.event.special[ handleObj.origType ] || {} ).handle ||
- handleObj.handler ).apply( matched.elem, args );
-
- if ( ret !== undefined ) {
- if ( ( event.result = ret ) === false ) {
- event.preventDefault();
- event.stopPropagation();
- }
- }
- }
- }
- }
-
- // Call the postDispatch hook for the mapped type
- if ( special.postDispatch ) {
- special.postDispatch.call( this, event );
- }
-
- return event.result;
- },
-
- handlers: function( event, handlers ) {
- var i, handleObj, sel, matchedHandlers, matchedSelectors,
- handlerQueue = [],
- delegateCount = handlers.delegateCount,
- cur = event.target;
-
- // Find delegate handlers
- if ( delegateCount &&
-
- // Support: IE <=9
- // Black-hole SVG <use> instance trees (trac-13180)
- cur.nodeType &&
-
- // Support: Firefox <=42
- // Suppress spec-violating clicks indicating a non-primary pointer button (trac-3861)
- // https://www.w3.org/TR/DOM-Level-3-Events/#event-type-click
- // Support: IE 11 only
- // ...but not arrow key "clicks" of radio inputs, which can have `button` -1 (gh-2343)
- !( event.type === "click" && event.button >= 1 ) ) {
-
- for ( ; cur !== this; cur = cur.parentNode || this ) {
-
- // Don't check non-elements (#13208)
- // Don't process clicks on disabled elements (#6911, #8165, #11382, #11764)
- if ( cur.nodeType === 1 && !( event.type === "click" && cur.disabled === true ) ) {
- matchedHandlers = [];
- matchedSelectors = {};
- for ( i = 0; i < delegateCount; i++ ) {
- handleObj = handlers[ i ];
-
- // Don't conflict with Object.prototype properties (#13203)
- sel = handleObj.selector + " ";
-
- if ( matchedSelectors[ sel ] === undefined ) {
- matchedSelectors[ sel ] = handleObj.needsContext ?
- jQuery( sel, this ).index( cur ) > -1 :
- jQuery.find( sel, this, null, [ cur ] ).length;
- }
- if ( matchedSelectors[ sel ] ) {
- matchedHandlers.push( handleObj );
- }
- }
- if ( matchedHandlers.length ) {
- handlerQueue.push( { elem: cur, handlers: matchedHandlers } );
- }
- }
- }
- }
-
- // Add the remaining (directly-bound) handlers
- cur = this;
- if ( delegateCount < handlers.length ) {
- handlerQueue.push( { elem: cur, handlers: handlers.slice( delegateCount ) } );
- }
-
- return handlerQueue;
- },
-
- addProp: function( name, hook ) {
- Object.defineProperty( jQuery.Event.prototype, name, {
- enumerable: true,
- configurable: true,
-
- get: jQuery.isFunction( hook ) ?
- function() {
- if ( this.originalEvent ) {
- return hook( this.originalEvent );
- }
- } :
- function() {
- if ( this.originalEvent ) {
- return this.originalEvent[ name ];
- }
- },
-
- set: function( value ) {
- Object.defineProperty( this, name, {
- enumerable: true,
- configurable: true,
- writable: true,
- value: value
- } );
- }
- } );
- },
-
- fix: function( originalEvent ) {
- return originalEvent[ jQuery.expando ] ?
- originalEvent :
- new jQuery.Event( originalEvent );
- },
-
- special: {
- load: {
-
- // Prevent triggered image.load events from bubbling to window.load
- noBubble: true
- },
- focus: {
-
- // Fire native event if possible so blur/focus sequence is correct
- trigger: function() {
- if ( this !== safeActiveElement() && this.focus ) {
- this.focus();
- return false;
- }
- },
- delegateType: "focusin"
- },
- blur: {
- trigger: function() {
- if ( this === safeActiveElement() && this.blur ) {
- this.blur();
- return false;
- }
- },
- delegateType: "focusout"
- },
- click: {
-
- // For checkbox, fire native event so checked state will be right
- trigger: function() {
- if ( this.type === "checkbox" && this.click && nodeName( this, "input" ) ) {
- this.click();
- return false;
- }
- },
-
- // For cross-browser consistency, don't fire native .click() on links
- _default: function( event ) {
- return nodeName( event.target, "a" );
- }
- },
-
- beforeunload: {
- postDispatch: function( event ) {
-
- // Support: Firefox 20+
- // Firefox doesn't alert if the returnValue field is not set.
- if ( event.result !== undefined && event.originalEvent ) {
- event.originalEvent.returnValue = event.result;
- }
- }
- }
- }
-};
-
-jQuery.removeEvent = function( elem, type, handle ) {
-
- // This "if" is needed for plain objects
- if ( elem.removeEventListener ) {
- elem.removeEventListener( type, handle );
- }
-};
-
-jQuery.Event = function( src, props ) {
-
- // Allow instantiation without the 'new' keyword
- if ( !( this instanceof jQuery.Event ) ) {
- return new jQuery.Event( src, props );
- }
-
- // Event object
- if ( src && src.type ) {
- this.originalEvent = src;
- this.type = src.type;
-
- // Events bubbling up the document may have been marked as prevented
- // by a handler lower down the tree; reflect the correct value.
- this.isDefaultPrevented = src.defaultPrevented ||
- src.defaultPrevented === undefined &&
-
- // Support: Android <=2.3 only
- src.returnValue === false ?
- returnTrue :
- returnFalse;
-
- // Create target properties
- // Support: Safari <=6 - 7 only
- // Target should not be a text node (#504, #13143)
- this.target = ( src.target && src.target.nodeType === 3 ) ?
- src.target.parentNode :
- src.target;
-
- this.currentTarget = src.currentTarget;
- this.relatedTarget = src.relatedTarget;
-
- // Event type
- } else {
- this.type = src;
- }
-
- // Put explicitly provided properties onto the event object
- if ( props ) {
- jQuery.extend( this, props );
- }
-
- // Create a timestamp if incoming event doesn't have one
- this.timeStamp = src && src.timeStamp || jQuery.now();
-
- // Mark it as fixed
- this[ jQuery.expando ] = true;
-};
-
-// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding
-// https://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html
-jQuery.Event.prototype = {
- constructor: jQuery.Event,
- isDefaultPrevented: returnFalse,
- isPropagationStopped: returnFalse,
- isImmediatePropagationStopped: returnFalse,
- isSimulated: false,
-
- preventDefault: function() {
- var e = this.originalEvent;
-
- this.isDefaultPrevented = returnTrue;
-
- if ( e && !this.isSimulated ) {
- e.preventDefault();
- }
- },
- stopPropagation: function() {
- var e = this.originalEvent;
-
- this.isPropagationStopped = returnTrue;
-
- if ( e && !this.isSimulated ) {
- e.stopPropagation();
- }
- },
- stopImmediatePropagation: function() {
- var e = this.originalEvent;
-
- this.isImmediatePropagationStopped = returnTrue;
-
- if ( e && !this.isSimulated ) {
- e.stopImmediatePropagation();
- }
-
- this.stopPropagation();
- }
-};
-
-// Includes all common event props including KeyEvent and MouseEvent specific props
-jQuery.each( {
- altKey: true,
- bubbles: true,
- cancelable: true,
- changedTouches: true,
- ctrlKey: true,
- detail: true,
- eventPhase: true,
- metaKey: true,
- pageX: true,
- pageY: true,
- shiftKey: true,
- view: true,
- "char": true,
- charCode: true,
- key: true,
- keyCode: true,
- button: true,
- buttons: true,
- clientX: true,
- clientY: true,
- offsetX: true,
- offsetY: true,
- pointerId: true,
- pointerType: true,
- screenX: true,
- screenY: true,
- targetTouches: true,
- toElement: true,
- touches: true,
-
- which: function( event ) {
- var button = event.button;
-
- // Add which for key events
- if ( event.which == null && rkeyEvent.test( event.type ) ) {
- return event.charCode != null ? event.charCode : event.keyCode;
- }
-
- // Add which for click: 1 === left; 2 === middle; 3 === right
- if ( !event.which && button !== undefined && rmouseEvent.test( event.type ) ) {
- if ( button & 1 ) {
- return 1;
- }
-
- if ( button & 2 ) {
- return 3;
- }
-
- if ( button & 4 ) {
- return 2;
- }
-
- return 0;
- }
-
- return event.which;
- }
-}, jQuery.event.addProp );
-
-// Create mouseenter/leave events using mouseover/out and event-time checks
-// so that event delegation works in jQuery.
-// Do the same for pointerenter/pointerleave and pointerover/pointerout
-//
-// Support: Safari 7 only
-// Safari sends mouseenter too often; see:
-// https://bugs.chromium.org/p/chromium/issues/detail?id=470258
-// for the description of the bug (it existed in older Chrome versions as well).
-jQuery.each( {
- mouseenter: "mouseover",
- mouseleave: "mouseout",
- pointerenter: "pointerover",
- pointerleave: "pointerout"
-}, function( orig, fix ) {
- jQuery.event.special[ orig ] = {
- delegateType: fix,
- bindType: fix,
-
- handle: function( event ) {
- var ret,
- target = this,
- related = event.relatedTarget,
- handleObj = event.handleObj;
-
- // For mouseenter/leave call the handler if related is outside the target.
- // NB: No relatedTarget if the mouse left/entered the browser window
- if ( !related || ( related !== target && !jQuery.contains( target, related ) ) ) {
- event.type = handleObj.origType;
- ret = handleObj.handler.apply( this, arguments );
- event.type = fix;
- }
- return ret;
- }
- };
-} );
-
-jQuery.fn.extend( {
-
- on: function( types, selector, data, fn ) {
- return on( this, types, selector, data, fn );
- },
- one: function( types, selector, data, fn ) {
- return on( this, types, selector, data, fn, 1 );
- },
- off: function( types, selector, fn ) {
- var handleObj, type;
- if ( types && types.preventDefault && types.handleObj ) {
-
- // ( event ) dispatched jQuery.Event
- handleObj = types.handleObj;
- jQuery( types.delegateTarget ).off(
- handleObj.namespace ?
- handleObj.origType + "." + handleObj.namespace :
- handleObj.origType,
- handleObj.selector,
- handleObj.handler
- );
- return this;
- }
- if ( typeof types === "object" ) {
-
- // ( types-object [, selector] )
- for ( type in types ) {
- this.off( type, selector, types[ type ] );
- }
- return this;
- }
- if ( selector === false || typeof selector === "function" ) {
-
- // ( types [, fn] )
- fn = selector;
- selector = undefined;
- }
- if ( fn === false ) {
- fn = returnFalse;
- }
- return this.each( function() {
- jQuery.event.remove( this, types, fn, selector );
- } );
- }
-} );
-
-
-var
-
- /* eslint-disable max-len */
-
- // See https://github.com/eslint/eslint/issues/3229
- rxhtmlTag = /<(?!area|br|col|embed|hr|img|input|link|meta|param)(([a-z][^\/\0>\x20\t\r\n\f]*)[^>]*)\/>/gi,
-
- /* eslint-enable */
-
- // Support: IE <=10 - 11, Edge 12 - 13
- // In IE/Edge using regex groups here causes severe slowdowns.
- // See https://connect.microsoft.com/IE/feedback/details/1736512/
- rnoInnerhtml = /<script|<style|<link/i,
-
- // checked="checked" or checked
- rchecked = /checked\s*(?:[^=]|=\s*.checked.)/i,
- rscriptTypeMasked = /^true\/(.*)/,
- rcleanScript = /^\s*<!(?:\[CDATA\[|--)|(?:\]\]|--)>\s*$/g;
-
-// Prefer a tbody over its parent table for containing new rows
-function manipulationTarget( elem, content ) {
- if ( nodeName( elem, "table" ) &&
- nodeName( content.nodeType !== 11 ? content : content.firstChild, "tr" ) ) {
-
- return jQuery( ">tbody", elem )[ 0 ] || elem;
- }
-
- return elem;
-}
-
-// Replace/restore the type attribute of script elements for safe DOM manipulation
-function disableScript( elem ) {
- elem.type = ( elem.getAttribute( "type" ) !== null ) + "/" + elem.type;
- return elem;
-}
-function restoreScript( elem ) {
- var match = rscriptTypeMasked.exec( elem.type );
-
- if ( match ) {
- elem.type = match[ 1 ];
- } else {
- elem.removeAttribute( "type" );
- }
-
- return elem;
-}
-
-function cloneCopyEvent( src, dest ) {
- var i, l, type, pdataOld, pdataCur, udataOld, udataCur, events;
-
- if ( dest.nodeType !== 1 ) {
- return;
- }
-
- // 1. Copy private data: events, handlers, etc.
- if ( dataPriv.hasData( src ) ) {
- pdataOld = dataPriv.access( src );
- pdataCur = dataPriv.set( dest, pdataOld );
- events = pdataOld.events;
-
- if ( events ) {
- delete pdataCur.handle;
- pdataCur.events = {};
-
- for ( type in events ) {
- for ( i = 0, l = events[ type ].length; i < l; i++ ) {
- jQuery.event.add( dest, type, events[ type ][ i ] );
- }
- }
- }
- }
-
- // 2. Copy user data
- if ( dataUser.hasData( src ) ) {
- udataOld = dataUser.access( src );
- udataCur = jQuery.extend( {}, udataOld );
-
- dataUser.set( dest, udataCur );
- }
-}
-
-// Fix IE bugs, see support tests
-function fixInput( src, dest ) {
- var nodeName = dest.nodeName.toLowerCase();
-
- // Fails to persist the checked state of a cloned checkbox or radio button.
- if ( nodeName === "input" && rcheckableType.test( src.type ) ) {
- dest.checked = src.checked;
-
- // Fails to return the selected option to the default selected state when cloning options
- } else if ( nodeName === "input" || nodeName === "textarea" ) {
- dest.defaultValue = src.defaultValue;
- }
-}
-
-function domManip( collection, args, callback, ignored ) {
-
- // Flatten any nested arrays
- args = concat.apply( [], args );
-
- var fragment, first, scripts, hasScripts, node, doc,
- i = 0,
- l = collection.length,
- iNoClone = l - 1,
- value = args[ 0 ],
- isFunction = jQuery.isFunction( value );
-
- // We can't cloneNode fragments that contain checked, in WebKit
- if ( isFunction ||
- ( l > 1 && typeof value === "string" &&
- !support.checkClone && rchecked.test( value ) ) ) {
- return collection.each( function( index ) {
- var self = collection.eq( index );
- if ( isFunction ) {
- args[ 0 ] = value.call( this, index, self.html() );
- }
- domManip( self, args, callback, ignored );
- } );
- }
-
- if ( l ) {
- fragment = buildFragment( args, collection[ 0 ].ownerDocument, false, collection, ignored );
- first = fragment.firstChild;
-
- if ( fragment.childNodes.length === 1 ) {
- fragment = first;
- }
-
- // Require either new content or an interest in ignored elements to invoke the callback
- if ( first || ignored ) {
- scripts = jQuery.map( getAll( fragment, "script" ), disableScript );
- hasScripts = scripts.length;
-
- // Use the original fragment for the last item
- // instead of the first because it can end up
- // being emptied incorrectly in certain situations (#8070).
- for ( ; i < l; i++ ) {
- node = fragment;
-
- if ( i !== iNoClone ) {
- node = jQuery.clone( node, true, true );
-
- // Keep references to cloned scripts for later restoration
- if ( hasScripts ) {
-
- // Support: Android <=4.0 only, PhantomJS 1 only
- // push.apply(_, arraylike) throws on ancient WebKit
- jQuery.merge( scripts, getAll( node, "script" ) );
- }
- }
-
- callback.call( collection[ i ], node, i );
- }
-
- if ( hasScripts ) {
- doc = scripts[ scripts.length - 1 ].ownerDocument;
-
- // Reenable scripts
- jQuery.map( scripts, restoreScript );
-
- // Evaluate executable scripts on first document insertion
- for ( i = 0; i < hasScripts; i++ ) {
- node = scripts[ i ];
- if ( rscriptType.test( node.type || "" ) &&
- !dataPriv.access( node, "globalEval" ) &&
- jQuery.contains( doc, node ) ) {
-
- if ( node.src ) {
-
- // Optional AJAX dependency, but won't run scripts if not present
- if ( jQuery._evalUrl ) {
- jQuery._evalUrl( node.src );
- }
- } else {
- DOMEval( node.textContent.replace( rcleanScript, "" ), doc );
- }
- }
- }
- }
- }
- }
-
- return collection;
-}
-
-function remove( elem, selector, keepData ) {
- var node,
- nodes = selector ? jQuery.filter( selector, elem ) : elem,
- i = 0;
-
- for ( ; ( node = nodes[ i ] ) != null; i++ ) {
- if ( !keepData && node.nodeType === 1 ) {
- jQuery.cleanData( getAll( node ) );
- }
-
- if ( node.parentNode ) {
- if ( keepData && jQuery.contains( node.ownerDocument, node ) ) {
- setGlobalEval( getAll( node, "script" ) );
- }
- node.parentNode.removeChild( node );
- }
- }
-
- return elem;
-}
-
-jQuery.extend( {
- htmlPrefilter: function( html ) {
- return html.replace( rxhtmlTag, "<$1></$2>" );
- },
-
- clone: function( elem, dataAndEvents, deepDataAndEvents ) {
- var i, l, srcElements, destElements,
- clone = elem.cloneNode( true ),
- inPage = jQuery.contains( elem.ownerDocument, elem );
-
- // Fix IE cloning issues
- if ( !support.noCloneChecked && ( elem.nodeType === 1 || elem.nodeType === 11 ) &&
- !jQuery.isXMLDoc( elem ) ) {
-
- // We eschew Sizzle here for performance reasons: https://jsperf.com/getall-vs-sizzle/2
- destElements = getAll( clone );
- srcElements = getAll( elem );
-
- for ( i = 0, l = srcElements.length; i < l; i++ ) {
- fixInput( srcElements[ i ], destElements[ i ] );
- }
- }
-
- // Copy the events from the original to the clone
- if ( dataAndEvents ) {
- if ( deepDataAndEvents ) {
- srcElements = srcElements || getAll( elem );
- destElements = destElements || getAll( clone );
-
- for ( i = 0, l = srcElements.length; i < l; i++ ) {
- cloneCopyEvent( srcElements[ i ], destElements[ i ] );
- }
- } else {
- cloneCopyEvent( elem, clone );
- }
- }
-
- // Preserve script evaluation history
- destElements = getAll( clone, "script" );
- if ( destElements.length > 0 ) {
- setGlobalEval( destElements, !inPage && getAll( elem, "script" ) );
- }
-
- // Return the cloned set
- return clone;
- },
-
- cleanData: function( elems ) {
- var data, elem, type,
- special = jQuery.event.special,
- i = 0;
-
- for ( ; ( elem = elems[ i ] ) !== undefined; i++ ) {
- if ( acceptData( elem ) ) {
- if ( ( data = elem[ dataPriv.expando ] ) ) {
- if ( data.events ) {
- for ( type in data.events ) {
- if ( special[ type ] ) {
- jQuery.event.remove( elem, type );
-
- // This is a shortcut to avoid jQuery.event.remove's overhead
- } else {
- jQuery.removeEvent( elem, type, data.handle );
- }
- }
- }
-
- // Support: Chrome <=35 - 45+
- // Assign undefined instead of using delete, see Data#remove
- elem[ dataPriv.expando ] = undefined;
- }
- if ( elem[ dataUser.expando ] ) {
-
- // Support: Chrome <=35 - 45+
- // Assign undefined instead of using delete, see Data#remove
- elem[ dataUser.expando ] = undefined;
- }
- }
- }
- }
-} );
-
-jQuery.fn.extend( {
- detach: function( selector ) {
- return remove( this, selector, true );
- },
-
- remove: function( selector ) {
- return remove( this, selector );
- },
-
- text: function( value ) {
- return access( this, function( value ) {
- return value === undefined ?
- jQuery.text( this ) :
- this.empty().each( function() {
- if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) {
- this.textContent = value;
- }
- } );
- }, null, value, arguments.length );
- },
-
- append: function() {
- return domManip( this, arguments, function( elem ) {
- if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) {
- var target = manipulationTarget( this, elem );
- target.appendChild( elem );
- }
- } );
- },
-
- prepend: function() {
- return domManip( this, arguments, function( elem ) {
- if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) {
- var target = manipulationTarget( this, elem );
- target.insertBefore( elem, target.firstChild );
- }
- } );
- },
-
- before: function() {
- return domManip( this, arguments, function( elem ) {
- if ( this.parentNode ) {
- this.parentNode.insertBefore( elem, this );
- }
- } );
- },
-
- after: function() {
- return domManip( this, arguments, function( elem ) {
- if ( this.parentNode ) {
- this.parentNode.insertBefore( elem, this.nextSibling );
- }
- } );
- },
-
- empty: function() {
- var elem,
- i = 0;
-
- for ( ; ( elem = this[ i ] ) != null; i++ ) {
- if ( elem.nodeType === 1 ) {
-
- // Prevent memory leaks
- jQuery.cleanData( getAll( elem, false ) );
-
- // Remove any remaining nodes
- elem.textContent = "";
- }
- }
-
- return this;
- },
-
- clone: function( dataAndEvents, deepDataAndEvents ) {
- dataAndEvents = dataAndEvents == null ? false : dataAndEvents;
- deepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents;
-
- return this.map( function() {
- return jQuery.clone( this, dataAndEvents, deepDataAndEvents );
- } );
- },
-
- html: function( value ) {
- return access( this, function( value ) {
- var elem = this[ 0 ] || {},
- i = 0,
- l = this.length;
-
- if ( value === undefined && elem.nodeType === 1 ) {
- return elem.innerHTML;
- }
-
- // See if we can take a shortcut and just use innerHTML
- if ( typeof value === "string" && !rnoInnerhtml.test( value ) &&
- !wrapMap[ ( rtagName.exec( value ) || [ "", "" ] )[ 1 ].toLowerCase() ] ) {
-
- value = jQuery.htmlPrefilter( value );
-
- try {
- for ( ; i < l; i++ ) {
- elem = this[ i ] || {};
-
- // Remove element nodes and prevent memory leaks
- if ( elem.nodeType === 1 ) {
- jQuery.cleanData( getAll( elem, false ) );
- elem.innerHTML = value;
- }
- }
-
- elem = 0;
-
- // If using innerHTML throws an exception, use the fallback method
- } catch ( e ) {}
- }
-
- if ( elem ) {
- this.empty().append( value );
- }
- }, null, value, arguments.length );
- },
-
- replaceWith: function() {
- var ignored = [];
-
- // Make the changes, replacing each non-ignored context element with the new content
- return domManip( this, arguments, function( elem ) {
- var parent = this.parentNode;
-
- if ( jQuery.inArray( this, ignored ) < 0 ) {
- jQuery.cleanData( getAll( this ) );
- if ( parent ) {
- parent.replaceChild( elem, this );
- }
- }
-
- // Force callback invocation
- }, ignored );
- }
-} );
-
-jQuery.each( {
- appendTo: "append",
- prependTo: "prepend",
- insertBefore: "before",
- insertAfter: "after",
- replaceAll: "replaceWith"
-}, function( name, original ) {
- jQuery.fn[ name ] = function( selector ) {
- var elems,
- ret = [],
- insert = jQuery( selector ),
- last = insert.length - 1,
- i = 0;
-
- for ( ; i <= last; i++ ) {
- elems = i === last ? this : this.clone( true );
- jQuery( insert[ i ] )[ original ]( elems );
-
- // Support: Android <=4.0 only, PhantomJS 1 only
- // .get() because push.apply(_, arraylike) throws on ancient WebKit
- push.apply( ret, elems.get() );
- }
-
- return this.pushStack( ret );
- };
-} );
-var rmargin = ( /^margin/ );
-
-var rnumnonpx = new RegExp( "^(" + pnum + ")(?!px)[a-z%]+$", "i" );
-
-var getStyles = function( elem ) {
-
- // Support: IE <=11 only, Firefox <=30 (#15098, #14150)
- // IE throws on elements created in popups
- // FF meanwhile throws on frame elements through "defaultView.getComputedStyle"
- var view = elem.ownerDocument.defaultView;
-
- if ( !view || !view.opener ) {
- view = window;
- }
-
- return view.getComputedStyle( elem );
- };
-
-
-
-( function() {
-
- // Executing both pixelPosition & boxSizingReliable tests require only one layout
- // so they're executed at the same time to save the second computation.
- function computeStyleTests() {
-
- // This is a singleton, we need to execute it only once
- if ( !div ) {
- return;
- }
-
- div.style.cssText =
- "box-sizing:border-box;" +
- "position:relative;display:block;" +
- "margin:auto;border:1px;padding:1px;" +
- "top:1%;width:50%";
- div.innerHTML = "";
- documentElement.appendChild( container );
-
- var divStyle = window.getComputedStyle( div );
- pixelPositionVal = divStyle.top !== "1%";
-
- // Support: Android 4.0 - 4.3 only, Firefox <=3 - 44
- reliableMarginLeftVal = divStyle.marginLeft === "2px";
- boxSizingReliableVal = divStyle.width === "4px";
-
- // Support: Android 4.0 - 4.3 only
- // Some styles come back with percentage values, even though they shouldn't
- div.style.marginRight = "50%";
- pixelMarginRightVal = divStyle.marginRight === "4px";
-
- documentElement.removeChild( container );
-
- // Nullify the div so it wouldn't be stored in the memory and
- // it will also be a sign that checks already performed
- div = null;
- }
-
- var pixelPositionVal, boxSizingReliableVal, pixelMarginRightVal, reliableMarginLeftVal,
- container = document.createElement( "div" ),
- div = document.createElement( "div" );
-
- // Finish early in limited (non-browser) environments
- if ( !div.style ) {
- return;
- }
-
- // Support: IE <=9 - 11 only
- // Style of cloned element affects source element cloned (#8908)
- div.style.backgroundClip = "content-box";
- div.cloneNode( true ).style.backgroundClip = "";
- support.clearCloneStyle = div.style.backgroundClip === "content-box";
-
- container.style.cssText = "border:0;width:8px;height:0;top:0;left:-9999px;" +
- "padding:0;margin-top:1px;position:absolute";
- container.appendChild( div );
-
- jQuery.extend( support, {
- pixelPosition: function() {
- computeStyleTests();
- return pixelPositionVal;
- },
- boxSizingReliable: function() {
- computeStyleTests();
- return boxSizingReliableVal;
- },
- pixelMarginRight: function() {
- computeStyleTests();
- return pixelMarginRightVal;
- },
- reliableMarginLeft: function() {
- computeStyleTests();
- return reliableMarginLeftVal;
- }
- } );
-} )();
-
-
-function curCSS( elem, name, computed ) {
- var width, minWidth, maxWidth, ret,
-
- // Support: Firefox 51+
- // Retrieving style before computed somehow
- // fixes an issue with getting wrong values
- // on detached elements
- style = elem.style;
-
- computed = computed || getStyles( elem );
-
- // getPropertyValue is needed for:
- // .css('filter') (IE 9 only, #12537)
- // .css('--customProperty) (#3144)
- if ( computed ) {
- ret = computed.getPropertyValue( name ) || computed[ name ];
-
- if ( ret === "" && !jQuery.contains( elem.ownerDocument, elem ) ) {
- ret = jQuery.style( elem, name );
- }
-
- // A tribute to the "awesome hack by Dean Edwards"
- // Android Browser returns percentage for some values,
- // but width seems to be reliably pixels.
- // This is against the CSSOM draft spec:
- // https://drafts.csswg.org/cssom/#resolved-values
- if ( !support.pixelMarginRight() && rnumnonpx.test( ret ) && rmargin.test( name ) ) {
-
- // Remember the original values
- width = style.width;
- minWidth = style.minWidth;
- maxWidth = style.maxWidth;
-
- // Put in the new values to get a computed value out
- style.minWidth = style.maxWidth = style.width = ret;
- ret = computed.width;
-
- // Revert the changed values
- style.width = width;
- style.minWidth = minWidth;
- style.maxWidth = maxWidth;
- }
- }
-
- return ret !== undefined ?
-
- // Support: IE <=9 - 11 only
- // IE returns zIndex value as an integer.
- ret + "" :
- ret;
-}
-
-
-function addGetHookIf( conditionFn, hookFn ) {
-
- // Define the hook, we'll check on the first run if it's really needed.
- return {
- get: function() {
- if ( conditionFn() ) {
-
- // Hook not needed (or it's not possible to use it due
- // to missing dependency), remove it.
- delete this.get;
- return;
- }
-
- // Hook needed; redefine it so that the support test is not executed again.
- return ( this.get = hookFn ).apply( this, arguments );
- }
- };
-}
-
-
-var
-
- // Swappable if display is none or starts with table
- // except "table", "table-cell", or "table-caption"
- // See here for display values: https://developer.mozilla.org/en-US/docs/CSS/display
- rdisplayswap = /^(none|table(?!-c[ea]).+)/,
- rcustomProp = /^--/,
- cssShow = { position: "absolute", visibility: "hidden", display: "block" },
- cssNormalTransform = {
- letterSpacing: "0",
- fontWeight: "400"
- },
-
- cssPrefixes = [ "Webkit", "Moz", "ms" ],
- emptyStyle = document.createElement( "div" ).style;
-
-// Return a css property mapped to a potentially vendor prefixed property
-function vendorPropName( name ) {
-
- // Shortcut for names that are not vendor prefixed
- if ( name in emptyStyle ) {
- return name;
- }
-
- // Check for vendor prefixed names
- var capName = name[ 0 ].toUpperCase() + name.slice( 1 ),
- i = cssPrefixes.length;
-
- while ( i-- ) {
- name = cssPrefixes[ i ] + capName;
- if ( name in emptyStyle ) {
- return name;
- }
- }
-}
-
-// Return a property mapped along what jQuery.cssProps suggests or to
-// a vendor prefixed property.
-function finalPropName( name ) {
- var ret = jQuery.cssProps[ name ];
- if ( !ret ) {
- ret = jQuery.cssProps[ name ] = vendorPropName( name ) || name;
- }
- return ret;
-}
-
-function setPositiveNumber( elem, value, subtract ) {
-
- // Any relative (+/-) values have already been
- // normalized at this point
- var matches = rcssNum.exec( value );
- return matches ?
-
- // Guard against undefined "subtract", e.g., when used as in cssHooks
- Math.max( 0, matches[ 2 ] - ( subtract || 0 ) ) + ( matches[ 3 ] || "px" ) :
- value;
-}
-
-function augmentWidthOrHeight( elem, name, extra, isBorderBox, styles ) {
- var i,
- val = 0;
-
- // If we already have the right measurement, avoid augmentation
- if ( extra === ( isBorderBox ? "border" : "content" ) ) {
- i = 4;
-
- // Otherwise initialize for horizontal or vertical properties
- } else {
- i = name === "width" ? 1 : 0;
- }
-
- for ( ; i < 4; i += 2 ) {
-
- // Both box models exclude margin, so add it if we want it
- if ( extra === "margin" ) {
- val += jQuery.css( elem, extra + cssExpand[ i ], true, styles );
- }
-
- if ( isBorderBox ) {
-
- // border-box includes padding, so remove it if we want content
- if ( extra === "content" ) {
- val -= jQuery.css( elem, "padding" + cssExpand[ i ], true, styles );
- }
-
- // At this point, extra isn't border nor margin, so remove border
- if ( extra !== "margin" ) {
- val -= jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles );
- }
- } else {
-
- // At this point, extra isn't content, so add padding
- val += jQuery.css( elem, "padding" + cssExpand[ i ], true, styles );
-
- // At this point, extra isn't content nor padding, so add border
- if ( extra !== "padding" ) {
- val += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles );
- }
- }
- }
-
- return val;
-}
-
-function getWidthOrHeight( elem, name, extra ) {
-
- // Start with computed style
- var valueIsBorderBox,
- styles = getStyles( elem ),
- val = curCSS( elem, name, styles ),
- isBorderBox = jQuery.css( elem, "boxSizing", false, styles ) === "border-box";
-
- // Computed unit is not pixels. Stop here and return.
- if ( rnumnonpx.test( val ) ) {
- return val;
- }
-
- // Check for style in case a browser which returns unreliable values
- // for getComputedStyle silently falls back to the reliable elem.style
- valueIsBorderBox = isBorderBox &&
- ( support.boxSizingReliable() || val === elem.style[ name ] );
-
- // Fall back to offsetWidth/Height when value is "auto"
- // This happens for inline elements with no explicit setting (gh-3571)
- if ( val === "auto" ) {
- val = elem[ "offset" + name[ 0 ].toUpperCase() + name.slice( 1 ) ];
- }
-
- // Normalize "", auto, and prepare for extra
- val = parseFloat( val ) || 0;
-
- // Use the active box-sizing model to add/subtract irrelevant styles
- return ( val +
- augmentWidthOrHeight(
- elem,
- name,
- extra || ( isBorderBox ? "border" : "content" ),
- valueIsBorderBox,
- styles
- )
- ) + "px";
-}
-
-jQuery.extend( {
-
- // Add in style property hooks for overriding the default
- // behavior of getting and setting a style property
- cssHooks: {
- opacity: {
- get: function( elem, computed ) {
- if ( computed ) {
-
- // We should always get a number back from opacity
- var ret = curCSS( elem, "opacity" );
- return ret === "" ? "1" : ret;
- }
- }
- }
- },
-
- // Don't automatically add "px" to these possibly-unitless properties
- cssNumber: {
- "animationIterationCount": true,
- "columnCount": true,
- "fillOpacity": true,
- "flexGrow": true,
- "flexShrink": true,
- "fontWeight": true,
- "lineHeight": true,
- "opacity": true,
- "order": true,
- "orphans": true,
- "widows": true,
- "zIndex": true,
- "zoom": true
- },
-
- // Add in properties whose names you wish to fix before
- // setting or getting the value
- cssProps: {
- "float": "cssFloat"
- },
-
- // Get and set the style property on a DOM Node
- style: function( elem, name, value, extra ) {
-
- // Don't set styles on text and comment nodes
- if ( !elem || elem.nodeType === 3 || elem.nodeType === 8 || !elem.style ) {
- return;
- }
-
- // Make sure that we're working with the right name
- var ret, type, hooks,
- origName = jQuery.camelCase( name ),
- isCustomProp = rcustomProp.test( name ),
- style = elem.style;
-
- // Make sure that we're working with the right name. We don't
- // want to query the value if it is a CSS custom property
- // since they are user-defined.
- if ( !isCustomProp ) {
- name = finalPropName( origName );
- }
-
- // Gets hook for the prefixed version, then unprefixed version
- hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ];
-
- // Check if we're setting a value
- if ( value !== undefined ) {
- type = typeof value;
-
- // Convert "+=" or "-=" to relative numbers (#7345)
- if ( type === "string" && ( ret = rcssNum.exec( value ) ) && ret[ 1 ] ) {
- value = adjustCSS( elem, name, ret );
-
- // Fixes bug #9237
- type = "number";
- }
-
- // Make sure that null and NaN values aren't set (#7116)
- if ( value == null || value !== value ) {
- return;
- }
-
- // If a number was passed in, add the unit (except for certain CSS properties)
- if ( type === "number" ) {
- value += ret && ret[ 3 ] || ( jQuery.cssNumber[ origName ] ? "" : "px" );
- }
-
- // background-* props affect original clone's values
- if ( !support.clearCloneStyle && value === "" && name.indexOf( "background" ) === 0 ) {
- style[ name ] = "inherit";
- }
-
- // If a hook was provided, use that value, otherwise just set the specified value
- if ( !hooks || !( "set" in hooks ) ||
- ( value = hooks.set( elem, value, extra ) ) !== undefined ) {
-
- if ( isCustomProp ) {
- style.setProperty( name, value );
- } else {
- style[ name ] = value;
- }
- }
-
- } else {
-
- // If a hook was provided get the non-computed value from there
- if ( hooks && "get" in hooks &&
- ( ret = hooks.get( elem, false, extra ) ) !== undefined ) {
-
- return ret;
- }
-
- // Otherwise just get the value from the style object
- return style[ name ];
- }
- },
-
- css: function( elem, name, extra, styles ) {
- var val, num, hooks,
- origName = jQuery.camelCase( name ),
- isCustomProp = rcustomProp.test( name );
-
- // Make sure that we're working with the right name. We don't
- // want to modify the value if it is a CSS custom property
- // since they are user-defined.
- if ( !isCustomProp ) {
- name = finalPropName( origName );
- }
-
- // Try prefixed name followed by the unprefixed name
- hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ];
-
- // If a hook was provided get the computed value from there
- if ( hooks && "get" in hooks ) {
- val = hooks.get( elem, true, extra );
- }
-
- // Otherwise, if a way to get the computed value exists, use that
- if ( val === undefined ) {
- val = curCSS( elem, name, styles );
- }
-
- // Convert "normal" to computed value
- if ( val === "normal" && name in cssNormalTransform ) {
- val = cssNormalTransform[ name ];
- }
-
- // Make numeric if forced or a qualifier was provided and val looks numeric
- if ( extra === "" || extra ) {
- num = parseFloat( val );
- return extra === true || isFinite( num ) ? num || 0 : val;
- }
-
- return val;
- }
-} );
-
-jQuery.each( [ "height", "width" ], function( i, name ) {
- jQuery.cssHooks[ name ] = {
- get: function( elem, computed, extra ) {
- if ( computed ) {
-
- // Certain elements can have dimension info if we invisibly show them
- // but it must have a current display style that would benefit
- return rdisplayswap.test( jQuery.css( elem, "display" ) ) &&
-
- // Support: Safari 8+
- // Table columns in Safari have non-zero offsetWidth & zero
- // getBoundingClientRect().width unless display is changed.
- // Support: IE <=11 only
- // Running getBoundingClientRect on a disconnected node
- // in IE throws an error.
- ( !elem.getClientRects().length || !elem.getBoundingClientRect().width ) ?
- swap( elem, cssShow, function() {
- return getWidthOrHeight( elem, name, extra );
- } ) :
- getWidthOrHeight( elem, name, extra );
- }
- },
-
- set: function( elem, value, extra ) {
- var matches,
- styles = extra && getStyles( elem ),
- subtract = extra && augmentWidthOrHeight(
- elem,
- name,
- extra,
- jQuery.css( elem, "boxSizing", false, styles ) === "border-box",
- styles
- );
-
- // Convert to pixels if value adjustment is needed
- if ( subtract && ( matches = rcssNum.exec( value ) ) &&
- ( matches[ 3 ] || "px" ) !== "px" ) {
-
- elem.style[ name ] = value;
- value = jQuery.css( elem, name );
- }
-
- return setPositiveNumber( elem, value, subtract );
- }
- };
-} );
-
-jQuery.cssHooks.marginLeft = addGetHookIf( support.reliableMarginLeft,
- function( elem, computed ) {
- if ( computed ) {
- return ( parseFloat( curCSS( elem, "marginLeft" ) ) ||
- elem.getBoundingClientRect().left -
- swap( elem, { marginLeft: 0 }, function() {
- return elem.getBoundingClientRect().left;
- } )
- ) + "px";
- }
- }
-);
-
-// These hooks are used by animate to expand properties
-jQuery.each( {
- margin: "",
- padding: "",
- border: "Width"
-}, function( prefix, suffix ) {
- jQuery.cssHooks[ prefix + suffix ] = {
- expand: function( value ) {
- var i = 0,
- expanded = {},
-
- // Assumes a single number if not a string
- parts = typeof value === "string" ? value.split( " " ) : [ value ];
-
- for ( ; i < 4; i++ ) {
- expanded[ prefix + cssExpand[ i ] + suffix ] =
- parts[ i ] || parts[ i - 2 ] || parts[ 0 ];
- }
-
- return expanded;
- }
- };
-
- if ( !rmargin.test( prefix ) ) {
- jQuery.cssHooks[ prefix + suffix ].set = setPositiveNumber;
- }
-} );
-
-jQuery.fn.extend( {
- css: function( name, value ) {
- return access( this, function( elem, name, value ) {
- var styles, len,
- map = {},
- i = 0;
-
- if ( Array.isArray( name ) ) {
- styles = getStyles( elem );
- len = name.length;
-
- for ( ; i < len; i++ ) {
- map[ name[ i ] ] = jQuery.css( elem, name[ i ], false, styles );
- }
-
- return map;
- }
-
- return value !== undefined ?
- jQuery.style( elem, name, value ) :
- jQuery.css( elem, name );
- }, name, value, arguments.length > 1 );
- }
-} );
-
-
-function Tween( elem, options, prop, end, easing ) {
- return new Tween.prototype.init( elem, options, prop, end, easing );
-}
-jQuery.Tween = Tween;
-
-Tween.prototype = {
- constructor: Tween,
- init: function( elem, options, prop, end, easing, unit ) {
- this.elem = elem;
- this.prop = prop;
- this.easing = easing || jQuery.easing._default;
- this.options = options;
- this.start = this.now = this.cur();
- this.end = end;
- this.unit = unit || ( jQuery.cssNumber[ prop ] ? "" : "px" );
- },
- cur: function() {
- var hooks = Tween.propHooks[ this.prop ];
-
- return hooks && hooks.get ?
- hooks.get( this ) :
- Tween.propHooks._default.get( this );
- },
- run: function( percent ) {
- var eased,
- hooks = Tween.propHooks[ this.prop ];
-
- if ( this.options.duration ) {
- this.pos = eased = jQuery.easing[ this.easing ](
- percent, this.options.duration * percent, 0, 1, this.options.duration
- );
- } else {
- this.pos = eased = percent;
- }
- this.now = ( this.end - this.start ) * eased + this.start;
-
- if ( this.options.step ) {
- this.options.step.call( this.elem, this.now, this );
- }
-
- if ( hooks && hooks.set ) {
- hooks.set( this );
- } else {
- Tween.propHooks._default.set( this );
- }
- return this;
- }
-};
-
-Tween.prototype.init.prototype = Tween.prototype;
-
-Tween.propHooks = {
- _default: {
- get: function( tween ) {
- var result;
-
- // Use a property on the element directly when it is not a DOM element,
- // or when there is no matching style property that exists.
- if ( tween.elem.nodeType !== 1 ||
- tween.elem[ tween.prop ] != null && tween.elem.style[ tween.prop ] == null ) {
- return tween.elem[ tween.prop ];
- }
-
- // Passing an empty string as a 3rd parameter to .css will automatically
- // attempt a parseFloat and fallback to a string if the parse fails.
- // Simple values such as "10px" are parsed to Float;
- // complex values such as "rotate(1rad)" are returned as-is.
- result = jQuery.css( tween.elem, tween.prop, "" );
-
- // Empty strings, null, undefined and "auto" are converted to 0.
- return !result || result === "auto" ? 0 : result;
- },
- set: function( tween ) {
-
- // Use step hook for back compat.
- // Use cssHook if its there.
- // Use .style if available and use plain properties where available.
- if ( jQuery.fx.step[ tween.prop ] ) {
- jQuery.fx.step[ tween.prop ]( tween );
- } else if ( tween.elem.nodeType === 1 &&
- ( tween.elem.style[ jQuery.cssProps[ tween.prop ] ] != null ||
- jQuery.cssHooks[ tween.prop ] ) ) {
- jQuery.style( tween.elem, tween.prop, tween.now + tween.unit );
- } else {
- tween.elem[ tween.prop ] = tween.now;
- }
- }
- }
-};
-
-// Support: IE <=9 only
-// Panic based approach to setting things on disconnected nodes
-Tween.propHooks.scrollTop = Tween.propHooks.scrollLeft = {
- set: function( tween ) {
- if ( tween.elem.nodeType && tween.elem.parentNode ) {
- tween.elem[ tween.prop ] = tween.now;
- }
- }
-};
-
-jQuery.easing = {
- linear: function( p ) {
- return p;
- },
- swing: function( p ) {
- return 0.5 - Math.cos( p * Math.PI ) / 2;
- },
- _default: "swing"
-};
-
-jQuery.fx = Tween.prototype.init;
-
-// Back compat <1.8 extension point
-jQuery.fx.step = {};
-
-
-
-
-var
- fxNow, inProgress,
- rfxtypes = /^(?:toggle|show|hide)$/,
- rrun = /queueHooks$/;
-
-function schedule() {
- if ( inProgress ) {
- if ( document.hidden === false && window.requestAnimationFrame ) {
- window.requestAnimationFrame( schedule );
- } else {
- window.setTimeout( schedule, jQuery.fx.interval );
- }
-
- jQuery.fx.tick();
- }
-}
-
-// Animations created synchronously will run synchronously
-function createFxNow() {
- window.setTimeout( function() {
- fxNow = undefined;
- } );
- return ( fxNow = jQuery.now() );
-}
-
-// Generate parameters to create a standard animation
-function genFx( type, includeWidth ) {
- var which,
- i = 0,
- attrs = { height: type };
-
- // If we include width, step value is 1 to do all cssExpand values,
- // otherwise step value is 2 to skip over Left and Right
- includeWidth = includeWidth ? 1 : 0;
- for ( ; i < 4; i += 2 - includeWidth ) {
- which = cssExpand[ i ];
- attrs[ "margin" + which ] = attrs[ "padding" + which ] = type;
- }
-
- if ( includeWidth ) {
- attrs.opacity = attrs.width = type;
- }
-
- return attrs;
-}
-
-function createTween( value, prop, animation ) {
- var tween,
- collection = ( Animation.tweeners[ prop ] || [] ).concat( Animation.tweeners[ "*" ] ),
- index = 0,
- length = collection.length;
- for ( ; index < length; index++ ) {
- if ( ( tween = collection[ index ].call( animation, prop, value ) ) ) {
-
- // We're done with this property
- return tween;
- }
- }
-}
-
-function defaultPrefilter( elem, props, opts ) {
- var prop, value, toggle, hooks, oldfire, propTween, restoreDisplay, display,
- isBox = "width" in props || "height" in props,
- anim = this,
- orig = {},
- style = elem.style,
- hidden = elem.nodeType && isHiddenWithinTree( elem ),
- dataShow = dataPriv.get( elem, "fxshow" );
-
- // Queue-skipping animations hijack the fx hooks
- if ( !opts.queue ) {
- hooks = jQuery._queueHooks( elem, "fx" );
- if ( hooks.unqueued == null ) {
- hooks.unqueued = 0;
- oldfire = hooks.empty.fire;
- hooks.empty.fire = function() {
- if ( !hooks.unqueued ) {
- oldfire();
- }
- };
- }
- hooks.unqueued++;
-
- anim.always( function() {
-
- // Ensure the complete handler is called before this completes
- anim.always( function() {
- hooks.unqueued--;
- if ( !jQuery.queue( elem, "fx" ).length ) {
- hooks.empty.fire();
- }
- } );
- } );
- }
-
- // Detect show/hide animations
- for ( prop in props ) {
- value = props[ prop ];
- if ( rfxtypes.test( value ) ) {
- delete props[ prop ];
- toggle = toggle || value === "toggle";
- if ( value === ( hidden ? "hide" : "show" ) ) {
-
- // Pretend to be hidden if this is a "show" and
- // there is still data from a stopped show/hide
- if ( value === "show" && dataShow && dataShow[ prop ] !== undefined ) {
- hidden = true;
-
- // Ignore all other no-op show/hide data
- } else {
- continue;
- }
- }
- orig[ prop ] = dataShow && dataShow[ prop ] || jQuery.style( elem, prop );
- }
- }
-
- // Bail out if this is a no-op like .hide().hide()
- propTween = !jQuery.isEmptyObject( props );
- if ( !propTween && jQuery.isEmptyObject( orig ) ) {
- return;
- }
-
- // Restrict "overflow" and "display" styles during box animations
- if ( isBox && elem.nodeType === 1 ) {
-
- // Support: IE <=9 - 11, Edge 12 - 13
- // Record all 3 overflow attributes because IE does not infer the shorthand
- // from identically-valued overflowX and overflowY
- opts.overflow = [ style.overflow, style.overflowX, style.overflowY ];
-
- // Identify a display type, preferring old show/hide data over the CSS cascade
- restoreDisplay = dataShow && dataShow.display;
- if ( restoreDisplay == null ) {
- restoreDisplay = dataPriv.get( elem, "display" );
- }
- display = jQuery.css( elem, "display" );
- if ( display === "none" ) {
- if ( restoreDisplay ) {
- display = restoreDisplay;
- } else {
-
- // Get nonempty value(s) by temporarily forcing visibility
- showHide( [ elem ], true );
- restoreDisplay = elem.style.display || restoreDisplay;
- display = jQuery.css( elem, "display" );
- showHide( [ elem ] );
- }
- }
-
- // Animate inline elements as inline-block
- if ( display === "inline" || display === "inline-block" && restoreDisplay != null ) {
- if ( jQuery.css( elem, "float" ) === "none" ) {
-
- // Restore the original display value at the end of pure show/hide animations
- if ( !propTween ) {
- anim.done( function() {
- style.display = restoreDisplay;
- } );
- if ( restoreDisplay == null ) {
- display = style.display;
- restoreDisplay = display === "none" ? "" : display;
- }
- }
- style.display = "inline-block";
- }
- }
- }
-
- if ( opts.overflow ) {
- style.overflow = "hidden";
- anim.always( function() {
- style.overflow = opts.overflow[ 0 ];
- style.overflowX = opts.overflow[ 1 ];
- style.overflowY = opts.overflow[ 2 ];
- } );
- }
-
- // Implement show/hide animations
- propTween = false;
- for ( prop in orig ) {
-
- // General show/hide setup for this element animation
- if ( !propTween ) {
- if ( dataShow ) {
- if ( "hidden" in dataShow ) {
- hidden = dataShow.hidden;
- }
- } else {
- dataShow = dataPriv.access( elem, "fxshow", { display: restoreDisplay } );
- }
-
- // Store hidden/visible for toggle so `.stop().toggle()` "reverses"
- if ( toggle ) {
- dataShow.hidden = !hidden;
- }
-
- // Show elements before animating them
- if ( hidden ) {
- showHide( [ elem ], true );
- }
-
- /* eslint-disable no-loop-func */
-
- anim.done( function() {
-
- /* eslint-enable no-loop-func */
-
- // The final step of a "hide" animation is actually hiding the element
- if ( !hidden ) {
- showHide( [ elem ] );
- }
- dataPriv.remove( elem, "fxshow" );
- for ( prop in orig ) {
- jQuery.style( elem, prop, orig[ prop ] );
- }
- } );
- }
-
- // Per-property setup
- propTween = createTween( hidden ? dataShow[ prop ] : 0, prop, anim );
- if ( !( prop in dataShow ) ) {
- dataShow[ prop ] = propTween.start;
- if ( hidden ) {
- propTween.end = propTween.start;
- propTween.start = 0;
- }
- }
- }
-}
-
-function propFilter( props, specialEasing ) {
- var index, name, easing, value, hooks;
-
- // camelCase, specialEasing and expand cssHook pass
- for ( index in props ) {
- name = jQuery.camelCase( index );
- easing = specialEasing[ name ];
- value = props[ index ];
- if ( Array.isArray( value ) ) {
- easing = value[ 1 ];
- value = props[ index ] = value[ 0 ];
- }
-
- if ( index !== name ) {
- props[ name ] = value;
- delete props[ index ];
- }
-
- hooks = jQuery.cssHooks[ name ];
- if ( hooks && "expand" in hooks ) {
- value = hooks.expand( value );
- delete props[ name ];
-
- // Not quite $.extend, this won't overwrite existing keys.
- // Reusing 'index' because we have the correct "name"
- for ( index in value ) {
- if ( !( index in props ) ) {
- props[ index ] = value[ index ];
- specialEasing[ index ] = easing;
- }
- }
- } else {
- specialEasing[ name ] = easing;
- }
- }
-}
-
-function Animation( elem, properties, options ) {
- var result,
- stopped,
- index = 0,
- length = Animation.prefilters.length,
- deferred = jQuery.Deferred().always( function() {
-
- // Don't match elem in the :animated selector
- delete tick.elem;
- } ),
- tick = function() {
- if ( stopped ) {
- return false;
- }
- var currentTime = fxNow || createFxNow(),
- remaining = Math.max( 0, animation.startTime + animation.duration - currentTime ),
-
- // Support: Android 2.3 only
- // Archaic crash bug won't allow us to use `1 - ( 0.5 || 0 )` (#12497)
- temp = remaining / animation.duration || 0,
- percent = 1 - temp,
- index = 0,
- length = animation.tweens.length;
-
- for ( ; index < length; index++ ) {
- animation.tweens[ index ].run( percent );
- }
-
- deferred.notifyWith( elem, [ animation, percent, remaining ] );
-
- // If there's more to do, yield
- if ( percent < 1 && length ) {
- return remaining;
- }
-
- // If this was an empty animation, synthesize a final progress notification
- if ( !length ) {
- deferred.notifyWith( elem, [ animation, 1, 0 ] );
- }
-
- // Resolve the animation and report its conclusion
- deferred.resolveWith( elem, [ animation ] );
- return false;
- },
- animation = deferred.promise( {
- elem: elem,
- props: jQuery.extend( {}, properties ),
- opts: jQuery.extend( true, {
- specialEasing: {},
- easing: jQuery.easing._default
- }, options ),
- originalProperties: properties,
- originalOptions: options,
- startTime: fxNow || createFxNow(),
- duration: options.duration,
- tweens: [],
- createTween: function( prop, end ) {
- var tween = jQuery.Tween( elem, animation.opts, prop, end,
- animation.opts.specialEasing[ prop ] || animation.opts.easing );
- animation.tweens.push( tween );
- return tween;
- },
- stop: function( gotoEnd ) {
- var index = 0,
-
- // If we are going to the end, we want to run all the tweens
- // otherwise we skip this part
- length = gotoEnd ? animation.tweens.length : 0;
- if ( stopped ) {
- return this;
- }
- stopped = true;
- for ( ; index < length; index++ ) {
- animation.tweens[ index ].run( 1 );
- }
-
- // Resolve when we played the last frame; otherwise, reject
- if ( gotoEnd ) {
- deferred.notifyWith( elem, [ animation, 1, 0 ] );
- deferred.resolveWith( elem, [ animation, gotoEnd ] );
- } else {
- deferred.rejectWith( elem, [ animation, gotoEnd ] );
- }
- return this;
- }
- } ),
- props = animation.props;
-
- propFilter( props, animation.opts.specialEasing );
-
- for ( ; index < length; index++ ) {
- result = Animation.prefilters[ index ].call( animation, elem, props, animation.opts );
- if ( result ) {
- if ( jQuery.isFunction( result.stop ) ) {
- jQuery._queueHooks( animation.elem, animation.opts.queue ).stop =
- jQuery.proxy( result.stop, result );
- }
- return result;
- }
- }
-
- jQuery.map( props, createTween, animation );
-
- if ( jQuery.isFunction( animation.opts.start ) ) {
- animation.opts.start.call( elem, animation );
- }
-
- // Attach callbacks from options
- animation
- .progress( animation.opts.progress )
- .done( animation.opts.done, animation.opts.complete )
- .fail( animation.opts.fail )
- .always( animation.opts.always );
-
- jQuery.fx.timer(
- jQuery.extend( tick, {
- elem: elem,
- anim: animation,
- queue: animation.opts.queue
- } )
- );
-
- return animation;
-}
-
-jQuery.Animation = jQuery.extend( Animation, {
-
- tweeners: {
- "*": [ function( prop, value ) {
- var tween = this.createTween( prop, value );
- adjustCSS( tween.elem, prop, rcssNum.exec( value ), tween );
- return tween;
- } ]
- },
-
- tweener: function( props, callback ) {
- if ( jQuery.isFunction( props ) ) {
- callback = props;
- props = [ "*" ];
- } else {
- props = props.match( rnothtmlwhite );
- }
-
- var prop,
- index = 0,
- length = props.length;
-
- for ( ; index < length; index++ ) {
- prop = props[ index ];
- Animation.tweeners[ prop ] = Animation.tweeners[ prop ] || [];
- Animation.tweeners[ prop ].unshift( callback );
- }
- },
-
- prefilters: [ defaultPrefilter ],
-
- prefilter: function( callback, prepend ) {
- if ( prepend ) {
- Animation.prefilters.unshift( callback );
- } else {
- Animation.prefilters.push( callback );
- }
- }
-} );
-
-jQuery.speed = function( speed, easing, fn ) {
- var opt = speed && typeof speed === "object" ? jQuery.extend( {}, speed ) : {
- complete: fn || !fn && easing ||
- jQuery.isFunction( speed ) && speed,
- duration: speed,
- easing: fn && easing || easing && !jQuery.isFunction( easing ) && easing
- };
-
- // Go to the end state if fx are off
- if ( jQuery.fx.off ) {
- opt.duration = 0;
-
- } else {
- if ( typeof opt.duration !== "number" ) {
- if ( opt.duration in jQuery.fx.speeds ) {
- opt.duration = jQuery.fx.speeds[ opt.duration ];
-
- } else {
- opt.duration = jQuery.fx.speeds._default;
- }
- }
- }
-
- // Normalize opt.queue - true/undefined/null -> "fx"
- if ( opt.queue == null || opt.queue === true ) {
- opt.queue = "fx";
- }
-
- // Queueing
- opt.old = opt.complete;
-
- opt.complete = function() {
- if ( jQuery.isFunction( opt.old ) ) {
- opt.old.call( this );
- }
-
- if ( opt.queue ) {
- jQuery.dequeue( this, opt.queue );
- }
- };
-
- return opt;
-};
-
-jQuery.fn.extend( {
- fadeTo: function( speed, to, easing, callback ) {
-
- // Show any hidden elements after setting opacity to 0
- return this.filter( isHiddenWithinTree ).css( "opacity", 0 ).show()
-
- // Animate to the value specified
- .end().animate( { opacity: to }, speed, easing, callback );
- },
- animate: function( prop, speed, easing, callback ) {
- var empty = jQuery.isEmptyObject( prop ),
- optall = jQuery.speed( speed, easing, callback ),
- doAnimation = function() {
-
- // Operate on a copy of prop so per-property easing won't be lost
- var anim = Animation( this, jQuery.extend( {}, prop ), optall );
-
- // Empty animations, or finishing resolves immediately
- if ( empty || dataPriv.get( this, "finish" ) ) {
- anim.stop( true );
- }
- };
- doAnimation.finish = doAnimation;
-
- return empty || optall.queue === false ?
- this.each( doAnimation ) :
- this.queue( optall.queue, doAnimation );
- },
- stop: function( type, clearQueue, gotoEnd ) {
- var stopQueue = function( hooks ) {
- var stop = hooks.stop;
- delete hooks.stop;
- stop( gotoEnd );
- };
-
- if ( typeof type !== "string" ) {
- gotoEnd = clearQueue;
- clearQueue = type;
- type = undefined;
- }
- if ( clearQueue && type !== false ) {
- this.queue( type || "fx", [] );
- }
-
- return this.each( function() {
- var dequeue = true,
- index = type != null && type + "queueHooks",
- timers = jQuery.timers,
- data = dataPriv.get( this );
-
- if ( index ) {
- if ( data[ index ] && data[ index ].stop ) {
- stopQueue( data[ index ] );
- }
- } else {
- for ( index in data ) {
- if ( data[ index ] && data[ index ].stop && rrun.test( index ) ) {
- stopQueue( data[ index ] );
- }
- }
- }
-
- for ( index = timers.length; index--; ) {
- if ( timers[ index ].elem === this &&
- ( type == null || timers[ index ].queue === type ) ) {
-
- timers[ index ].anim.stop( gotoEnd );
- dequeue = false;
- timers.splice( index, 1 );
- }
- }
-
- // Start the next in the queue if the last step wasn't forced.
- // Timers currently will call their complete callbacks, which
- // will dequeue but only if they were gotoEnd.
- if ( dequeue || !gotoEnd ) {
- jQuery.dequeue( this, type );
- }
- } );
- },
- finish: function( type ) {
- if ( type !== false ) {
- type = type || "fx";
- }
- return this.each( function() {
- var index,
- data = dataPriv.get( this ),
- queue = data[ type + "queue" ],
- hooks = data[ type + "queueHooks" ],
- timers = jQuery.timers,
- length = queue ? queue.length : 0;
-
- // Enable finishing flag on private data
- data.finish = true;
-
- // Empty the queue first
- jQuery.queue( this, type, [] );
-
- if ( hooks && hooks.stop ) {
- hooks.stop.call( this, true );
- }
-
- // Look for any active animations, and finish them
- for ( index = timers.length; index--; ) {
- if ( timers[ index ].elem === this && timers[ index ].queue === type ) {
- timers[ index ].anim.stop( true );
- timers.splice( index, 1 );
- }
- }
-
- // Look for any animations in the old queue and finish them
- for ( index = 0; index < length; index++ ) {
- if ( queue[ index ] && queue[ index ].finish ) {
- queue[ index ].finish.call( this );
- }
- }
-
- // Turn off finishing flag
- delete data.finish;
- } );
- }
-} );
-
-jQuery.each( [ "toggle", "show", "hide" ], function( i, name ) {
- var cssFn = jQuery.fn[ name ];
- jQuery.fn[ name ] = function( speed, easing, callback ) {
- return speed == null || typeof speed === "boolean" ?
- cssFn.apply( this, arguments ) :
- this.animate( genFx( name, true ), speed, easing, callback );
- };
-} );
-
-// Generate shortcuts for custom animations
-jQuery.each( {
- slideDown: genFx( "show" ),
- slideUp: genFx( "hide" ),
- slideToggle: genFx( "toggle" ),
- fadeIn: { opacity: "show" },
- fadeOut: { opacity: "hide" },
- fadeToggle: { opacity: "toggle" }
-}, function( name, props ) {
- jQuery.fn[ name ] = function( speed, easing, callback ) {
- return this.animate( props, speed, easing, callback );
- };
-} );
-
-jQuery.timers = [];
-jQuery.fx.tick = function() {
- var timer,
- i = 0,
- timers = jQuery.timers;
-
- fxNow = jQuery.now();
-
- for ( ; i < timers.length; i++ ) {
- timer = timers[ i ];
-
- // Run the timer and safely remove it when done (allowing for external removal)
- if ( !timer() && timers[ i ] === timer ) {
- timers.splice( i--, 1 );
- }
- }
-
- if ( !timers.length ) {
- jQuery.fx.stop();
- }
- fxNow = undefined;
-};
-
-jQuery.fx.timer = function( timer ) {
- jQuery.timers.push( timer );
- jQuery.fx.start();
-};
-
-jQuery.fx.interval = 13;
-jQuery.fx.start = function() {
- if ( inProgress ) {
- return;
- }
-
- inProgress = true;
- schedule();
-};
-
-jQuery.fx.stop = function() {
- inProgress = null;
-};
-
-jQuery.fx.speeds = {
- slow: 600,
- fast: 200,
-
- // Default speed
- _default: 400
-};
-
-
-// Based off of the plugin by Clint Helfers, with permission.
-// https://web.archive.org/web/20100324014747/http://blindsignals.com/index.php/2009/07/jquery-delay/
-jQuery.fn.delay = function( time, type ) {
- time = jQuery.fx ? jQuery.fx.speeds[ time ] || time : time;
- type = type || "fx";
-
- return this.queue( type, function( next, hooks ) {
- var timeout = window.setTimeout( next, time );
- hooks.stop = function() {
- window.clearTimeout( timeout );
- };
- } );
-};
-
-
-( function() {
- var input = document.createElement( "input" ),
- select = document.createElement( "select" ),
- opt = select.appendChild( document.createElement( "option" ) );
-
- input.type = "checkbox";
-
- // Support: Android <=4.3 only
- // Default value for a checkbox should be "on"
- support.checkOn = input.value !== "";
-
- // Support: IE <=11 only
- // Must access selectedIndex to make default options select
- support.optSelected = opt.selected;
-
- // Support: IE <=11 only
- // An input loses its value after becoming a radio
- input = document.createElement( "input" );
- input.value = "t";
- input.type = "radio";
- support.radioValue = input.value === "t";
-} )();
-
-
-var boolHook,
- attrHandle = jQuery.expr.attrHandle;
-
-jQuery.fn.extend( {
- attr: function( name, value ) {
- return access( this, jQuery.attr, name, value, arguments.length > 1 );
- },
-
- removeAttr: function( name ) {
- return this.each( function() {
- jQuery.removeAttr( this, name );
- } );
- }
-} );
-
-jQuery.extend( {
- attr: function( elem, name, value ) {
- var ret, hooks,
- nType = elem.nodeType;
-
- // Don't get/set attributes on text, comment and attribute nodes
- if ( nType === 3 || nType === 8 || nType === 2 ) {
- return;
- }
-
- // Fallback to prop when attributes are not supported
- if ( typeof elem.getAttribute === "undefined" ) {
- return jQuery.prop( elem, name, value );
- }
-
- // Attribute hooks are determined by the lowercase version
- // Grab necessary hook if one is defined
- if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) {
- hooks = jQuery.attrHooks[ name.toLowerCase() ] ||
- ( jQuery.expr.match.bool.test( name ) ? boolHook : undefined );
- }
-
- if ( value !== undefined ) {
- if ( value === null ) {
- jQuery.removeAttr( elem, name );
- return;
- }
-
- if ( hooks && "set" in hooks &&
- ( ret = hooks.set( elem, value, name ) ) !== undefined ) {
- return ret;
- }
-
- elem.setAttribute( name, value + "" );
- return value;
- }
-
- if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) {
- return ret;
- }
-
- ret = jQuery.find.attr( elem, name );
-
- // Non-existent attributes return null, we normalize to undefined
- return ret == null ? undefined : ret;
- },
-
- attrHooks: {
- type: {
- set: function( elem, value ) {
- if ( !support.radioValue && value === "radio" &&
- nodeName( elem, "input" ) ) {
- var val = elem.value;
- elem.setAttribute( "type", value );
- if ( val ) {
- elem.value = val;
- }
- return value;
- }
- }
- }
- },
-
- removeAttr: function( elem, value ) {
- var name,
- i = 0,
-
- // Attribute names can contain non-HTML whitespace characters
- // https://html.spec.whatwg.org/multipage/syntax.html#attributes-2
- attrNames = value && value.match( rnothtmlwhite );
-
- if ( attrNames && elem.nodeType === 1 ) {
- while ( ( name = attrNames[ i++ ] ) ) {
- elem.removeAttribute( name );
- }
- }
- }
-} );
-
-// Hooks for boolean attributes
-boolHook = {
- set: function( elem, value, name ) {
- if ( value === false ) {
-
- // Remove boolean attributes when set to false
- jQuery.removeAttr( elem, name );
- } else {
- elem.setAttribute( name, name );
- }
- return name;
- }
-};
-
-jQuery.each( jQuery.expr.match.bool.source.match( /\w+/g ), function( i, name ) {
- var getter = attrHandle[ name ] || jQuery.find.attr;
-
- attrHandle[ name ] = function( elem, name, isXML ) {
- var ret, handle,
- lowercaseName = name.toLowerCase();
-
- if ( !isXML ) {
-
- // Avoid an infinite loop by temporarily removing this function from the getter
- handle = attrHandle[ lowercaseName ];
- attrHandle[ lowercaseName ] = ret;
- ret = getter( elem, name, isXML ) != null ?
- lowercaseName :
- null;
- attrHandle[ lowercaseName ] = handle;
- }
- return ret;
- };
-} );
-
-
-
-
-var rfocusable = /^(?:input|select|textarea|button)$/i,
- rclickable = /^(?:a|area)$/i;
-
-jQuery.fn.extend( {
- prop: function( name, value ) {
- return access( this, jQuery.prop, name, value, arguments.length > 1 );
- },
-
- removeProp: function( name ) {
- return this.each( function() {
- delete this[ jQuery.propFix[ name ] || name ];
- } );
- }
-} );
-
-jQuery.extend( {
- prop: function( elem, name, value ) {
- var ret, hooks,
- nType = elem.nodeType;
-
- // Don't get/set properties on text, comment and attribute nodes
- if ( nType === 3 || nType === 8 || nType === 2 ) {
- return;
- }
-
- if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) {
-
- // Fix name and attach hooks
- name = jQuery.propFix[ name ] || name;
- hooks = jQuery.propHooks[ name ];
- }
-
- if ( value !== undefined ) {
- if ( hooks && "set" in hooks &&
- ( ret = hooks.set( elem, value, name ) ) !== undefined ) {
- return ret;
- }
-
- return ( elem[ name ] = value );
- }
-
- if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) {
- return ret;
- }
-
- return elem[ name ];
- },
-
- propHooks: {
- tabIndex: {
- get: function( elem ) {
-
- // Support: IE <=9 - 11 only
- // elem.tabIndex doesn't always return the
- // correct value when it hasn't been explicitly set
- // https://web.archive.org/web/20141116233347/http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/
- // Use proper attribute retrieval(#12072)
- var tabindex = jQuery.find.attr( elem, "tabindex" );
-
- if ( tabindex ) {
- return parseInt( tabindex, 10 );
- }
-
- if (
- rfocusable.test( elem.nodeName ) ||
- rclickable.test( elem.nodeName ) &&
- elem.href
- ) {
- return 0;
- }
-
- return -1;
- }
- }
- },
-
- propFix: {
- "for": "htmlFor",
- "class": "className"
- }
-} );
-
-// Support: IE <=11 only
-// Accessing the selectedIndex property
-// forces the browser to respect setting selected
-// on the option
-// The getter ensures a default option is selected
-// when in an optgroup
-// eslint rule "no-unused-expressions" is disabled for this code
-// since it considers such accessions noop
-if ( !support.optSelected ) {
- jQuery.propHooks.selected = {
- get: function( elem ) {
-
- /* eslint no-unused-expressions: "off" */
-
- var parent = elem.parentNode;
- if ( parent && parent.parentNode ) {
- parent.parentNode.selectedIndex;
- }
- return null;
- },
- set: function( elem ) {
-
- /* eslint no-unused-expressions: "off" */
-
- var parent = elem.parentNode;
- if ( parent ) {
- parent.selectedIndex;
-
- if ( parent.parentNode ) {
- parent.parentNode.selectedIndex;
- }
- }
- }
- };
-}
-
-jQuery.each( [
- "tabIndex",
- "readOnly",
- "maxLength",
- "cellSpacing",
- "cellPadding",
- "rowSpan",
- "colSpan",
- "useMap",
- "frameBorder",
- "contentEditable"
-], function() {
- jQuery.propFix[ this.toLowerCase() ] = this;
-} );
-
-
-
-
- // Strip and collapse whitespace according to HTML spec
- // https://html.spec.whatwg.org/multipage/infrastructure.html#strip-and-collapse-whitespace
- function stripAndCollapse( value ) {
- var tokens = value.match( rnothtmlwhite ) || [];
- return tokens.join( " " );
- }
-
-
-function getClass( elem ) {
- return elem.getAttribute && elem.getAttribute( "class" ) || "";
-}
-
-jQuery.fn.extend( {
- addClass: function( value ) {
- var classes, elem, cur, curValue, clazz, j, finalValue,
- i = 0;
-
- if ( jQuery.isFunction( value ) ) {
- return this.each( function( j ) {
- jQuery( this ).addClass( value.call( this, j, getClass( this ) ) );
- } );
- }
-
- if ( typeof value === "string" && value ) {
- classes = value.match( rnothtmlwhite ) || [];
-
- while ( ( elem = this[ i++ ] ) ) {
- curValue = getClass( elem );
- cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " );
-
- if ( cur ) {
- j = 0;
- while ( ( clazz = classes[ j++ ] ) ) {
- if ( cur.indexOf( " " + clazz + " " ) < 0 ) {
- cur += clazz + " ";
- }
- }
-
- // Only assign if different to avoid unneeded rendering.
- finalValue = stripAndCollapse( cur );
- if ( curValue !== finalValue ) {
- elem.setAttribute( "class", finalValue );
- }
- }
- }
- }
-
- return this;
- },
-
- removeClass: function( value ) {
- var classes, elem, cur, curValue, clazz, j, finalValue,
- i = 0;
-
- if ( jQuery.isFunction( value ) ) {
- return this.each( function( j ) {
- jQuery( this ).removeClass( value.call( this, j, getClass( this ) ) );
- } );
- }
-
- if ( !arguments.length ) {
- return this.attr( "class", "" );
- }
-
- if ( typeof value === "string" && value ) {
- classes = value.match( rnothtmlwhite ) || [];
-
- while ( ( elem = this[ i++ ] ) ) {
- curValue = getClass( elem );
-
- // This expression is here for better compressibility (see addClass)
- cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " );
-
- if ( cur ) {
- j = 0;
- while ( ( clazz = classes[ j++ ] ) ) {
-
- // Remove *all* instances
- while ( cur.indexOf( " " + clazz + " " ) > -1 ) {
- cur = cur.replace( " " + clazz + " ", " " );
- }
- }
-
- // Only assign if different to avoid unneeded rendering.
- finalValue = stripAndCollapse( cur );
- if ( curValue !== finalValue ) {
- elem.setAttribute( "class", finalValue );
- }
- }
- }
- }
-
- return this;
- },
-
- toggleClass: function( value, stateVal ) {
- var type = typeof value;
-
- if ( typeof stateVal === "boolean" && type === "string" ) {
- return stateVal ? this.addClass( value ) : this.removeClass( value );
- }
-
- if ( jQuery.isFunction( value ) ) {
- return this.each( function( i ) {
- jQuery( this ).toggleClass(
- value.call( this, i, getClass( this ), stateVal ),
- stateVal
- );
- } );
- }
-
- return this.each( function() {
- var className, i, self, classNames;
-
- if ( type === "string" ) {
-
- // Toggle individual class names
- i = 0;
- self = jQuery( this );
- classNames = value.match( rnothtmlwhite ) || [];
-
- while ( ( className = classNames[ i++ ] ) ) {
-
- // Check each className given, space separated list
- if ( self.hasClass( className ) ) {
- self.removeClass( className );
- } else {
- self.addClass( className );
- }
- }
-
- // Toggle whole class name
- } else if ( value === undefined || type === "boolean" ) {
- className = getClass( this );
- if ( className ) {
-
- // Store className if set
- dataPriv.set( this, "__className__", className );
- }
-
- // If the element has a class name or if we're passed `false`,
- // then remove the whole classname (if there was one, the above saved it).
- // Otherwise bring back whatever was previously saved (if anything),
- // falling back to the empty string if nothing was stored.
- if ( this.setAttribute ) {
- this.setAttribute( "class",
- className || value === false ?
- "" :
- dataPriv.get( this, "__className__" ) || ""
- );
- }
- }
- } );
- },
-
- hasClass: function( selector ) {
- var className, elem,
- i = 0;
-
- className = " " + selector + " ";
- while ( ( elem = this[ i++ ] ) ) {
- if ( elem.nodeType === 1 &&
- ( " " + stripAndCollapse( getClass( elem ) ) + " " ).indexOf( className ) > -1 ) {
- return true;
- }
- }
-
- return false;
- }
-} );
-
-
-
-
-var rreturn = /\r/g;
-
-jQuery.fn.extend( {
- val: function( value ) {
- var hooks, ret, isFunction,
- elem = this[ 0 ];
-
- if ( !arguments.length ) {
- if ( elem ) {
- hooks = jQuery.valHooks[ elem.type ] ||
- jQuery.valHooks[ elem.nodeName.toLowerCase() ];
-
- if ( hooks &&
- "get" in hooks &&
- ( ret = hooks.get( elem, "value" ) ) !== undefined
- ) {
- return ret;
- }
-
- ret = elem.value;
-
- // Handle most common string cases
- if ( typeof ret === "string" ) {
- return ret.replace( rreturn, "" );
- }
-
- // Handle cases where value is null/undef or number
- return ret == null ? "" : ret;
- }
-
- return;
- }
-
- isFunction = jQuery.isFunction( value );
-
- return this.each( function( i ) {
- var val;
-
- if ( this.nodeType !== 1 ) {
- return;
- }
-
- if ( isFunction ) {
- val = value.call( this, i, jQuery( this ).val() );
- } else {
- val = value;
- }
-
- // Treat null/undefined as ""; convert numbers to string
- if ( val == null ) {
- val = "";
-
- } else if ( typeof val === "number" ) {
- val += "";
-
- } else if ( Array.isArray( val ) ) {
- val = jQuery.map( val, function( value ) {
- return value == null ? "" : value + "";
- } );
- }
-
- hooks = jQuery.valHooks[ this.type ] || jQuery.valHooks[ this.nodeName.toLowerCase() ];
-
- // If set returns undefined, fall back to normal setting
- if ( !hooks || !( "set" in hooks ) || hooks.set( this, val, "value" ) === undefined ) {
- this.value = val;
- }
- } );
- }
-} );
-
-jQuery.extend( {
- valHooks: {
- option: {
- get: function( elem ) {
-
- var val = jQuery.find.attr( elem, "value" );
- return val != null ?
- val :
-
- // Support: IE <=10 - 11 only
- // option.text throws exceptions (#14686, #14858)
- // Strip and collapse whitespace
- // https://html.spec.whatwg.org/#strip-and-collapse-whitespace
- stripAndCollapse( jQuery.text( elem ) );
- }
- },
- select: {
- get: function( elem ) {
- var value, option, i,
- options = elem.options,
- index = elem.selectedIndex,
- one = elem.type === "select-one",
- values = one ? null : [],
- max = one ? index + 1 : options.length;
-
- if ( index < 0 ) {
- i = max;
-
- } else {
- i = one ? index : 0;
- }
-
- // Loop through all the selected options
- for ( ; i < max; i++ ) {
- option = options[ i ];
-
- // Support: IE <=9 only
- // IE8-9 doesn't update selected after form reset (#2551)
- if ( ( option.selected || i === index ) &&
-
- // Don't return options that are disabled or in a disabled optgroup
- !option.disabled &&
- ( !option.parentNode.disabled ||
- !nodeName( option.parentNode, "optgroup" ) ) ) {
-
- // Get the specific value for the option
- value = jQuery( option ).val();
-
- // We don't need an array for one selects
- if ( one ) {
- return value;
- }
-
- // Multi-Selects return an array
- values.push( value );
- }
- }
-
- return values;
- },
-
- set: function( elem, value ) {
- var optionSet, option,
- options = elem.options,
- values = jQuery.makeArray( value ),
- i = options.length;
-
- while ( i-- ) {
- option = options[ i ];
-
- /* eslint-disable no-cond-assign */
-
- if ( option.selected =
- jQuery.inArray( jQuery.valHooks.option.get( option ), values ) > -1
- ) {
- optionSet = true;
- }
-
- /* eslint-enable no-cond-assign */
- }
-
- // Force browsers to behave consistently when non-matching value is set
- if ( !optionSet ) {
- elem.selectedIndex = -1;
- }
- return values;
- }
- }
- }
-} );
-
-// Radios and checkboxes getter/setter
-jQuery.each( [ "radio", "checkbox" ], function() {
- jQuery.valHooks[ this ] = {
- set: function( elem, value ) {
- if ( Array.isArray( value ) ) {
- return ( elem.checked = jQuery.inArray( jQuery( elem ).val(), value ) > -1 );
- }
- }
- };
- if ( !support.checkOn ) {
- jQuery.valHooks[ this ].get = function( elem ) {
- return elem.getAttribute( "value" ) === null ? "on" : elem.value;
- };
- }
-} );
-
-
-
-
-// Return jQuery for attributes-only inclusion
-
-
-var rfocusMorph = /^(?:focusinfocus|focusoutblur)$/;
-
-jQuery.extend( jQuery.event, {
-
- trigger: function( event, data, elem, onlyHandlers ) {
-
- var i, cur, tmp, bubbleType, ontype, handle, special,
- eventPath = [ elem || document ],
- type = hasOwn.call( event, "type" ) ? event.type : event,
- namespaces = hasOwn.call( event, "namespace" ) ? event.namespace.split( "." ) : [];
-
- cur = tmp = elem = elem || document;
-
- // Don't do events on text and comment nodes
- if ( elem.nodeType === 3 || elem.nodeType === 8 ) {
- return;
- }
-
- // focus/blur morphs to focusin/out; ensure we're not firing them right now
- if ( rfocusMorph.test( type + jQuery.event.triggered ) ) {
- return;
- }
-
- if ( type.indexOf( "." ) > -1 ) {
-
- // Namespaced trigger; create a regexp to match event type in handle()
- namespaces = type.split( "." );
- type = namespaces.shift();
- namespaces.sort();
- }
- ontype = type.indexOf( ":" ) < 0 && "on" + type;
-
- // Caller can pass in a jQuery.Event object, Object, or just an event type string
- event = event[ jQuery.expando ] ?
- event :
- new jQuery.Event( type, typeof event === "object" && event );
-
- // Trigger bitmask: & 1 for native handlers; & 2 for jQuery (always true)
- event.isTrigger = onlyHandlers ? 2 : 3;
- event.namespace = namespaces.join( "." );
- event.rnamespace = event.namespace ?
- new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ) :
- null;
-
- // Clean up the event in case it is being reused
- event.result = undefined;
- if ( !event.target ) {
- event.target = elem;
- }
-
- // Clone any incoming data and prepend the event, creating the handler arg list
- data = data == null ?
- [ event ] :
- jQuery.makeArray( data, [ event ] );
-
- // Allow special events to draw outside the lines
- special = jQuery.event.special[ type ] || {};
- if ( !onlyHandlers && special.trigger && special.trigger.apply( elem, data ) === false ) {
- return;
- }
-
- // Determine event propagation path in advance, per W3C events spec (#9951)
- // Bubble up to document, then to window; watch for a global ownerDocument var (#9724)
- if ( !onlyHandlers && !special.noBubble && !jQuery.isWindow( elem ) ) {
-
- bubbleType = special.delegateType || type;
- if ( !rfocusMorph.test( bubbleType + type ) ) {
- cur = cur.parentNode;
- }
- for ( ; cur; cur = cur.parentNode ) {
- eventPath.push( cur );
- tmp = cur;
- }
-
- // Only add window if we got to document (e.g., not plain obj or detached DOM)
- if ( tmp === ( elem.ownerDocument || document ) ) {
- eventPath.push( tmp.defaultView || tmp.parentWindow || window );
- }
- }
-
- // Fire handlers on the event path
- i = 0;
- while ( ( cur = eventPath[ i++ ] ) && !event.isPropagationStopped() ) {
-
- event.type = i > 1 ?
- bubbleType :
- special.bindType || type;
-
- // jQuery handler
- handle = ( dataPriv.get( cur, "events" ) || {} )[ event.type ] &&
- dataPriv.get( cur, "handle" );
- if ( handle ) {
- handle.apply( cur, data );
- }
-
- // Native handler
- handle = ontype && cur[ ontype ];
- if ( handle && handle.apply && acceptData( cur ) ) {
- event.result = handle.apply( cur, data );
- if ( event.result === false ) {
- event.preventDefault();
- }
- }
- }
- event.type = type;
-
- // If nobody prevented the default action, do it now
- if ( !onlyHandlers && !event.isDefaultPrevented() ) {
-
- if ( ( !special._default ||
- special._default.apply( eventPath.pop(), data ) === false ) &&
- acceptData( elem ) ) {
-
- // Call a native DOM method on the target with the same name as the event.
- // Don't do default actions on window, that's where global variables be (#6170)
- if ( ontype && jQuery.isFunction( elem[ type ] ) && !jQuery.isWindow( elem ) ) {
-
- // Don't re-trigger an onFOO event when we call its FOO() method
- tmp = elem[ ontype ];
-
- if ( tmp ) {
- elem[ ontype ] = null;
- }
-
- // Prevent re-triggering of the same event, since we already bubbled it above
- jQuery.event.triggered = type;
- elem[ type ]();
- jQuery.event.triggered = undefined;
-
- if ( tmp ) {
- elem[ ontype ] = tmp;
- }
- }
- }
- }
-
- return event.result;
- },
-
- // Piggyback on a donor event to simulate a different one
- // Used only for `focus(in | out)` events
- simulate: function( type, elem, event ) {
- var e = jQuery.extend(
- new jQuery.Event(),
- event,
- {
- type: type,
- isSimulated: true
- }
- );
-
- jQuery.event.trigger( e, null, elem );
- }
-
-} );
-
-jQuery.fn.extend( {
-
- trigger: function( type, data ) {
- return this.each( function() {
- jQuery.event.trigger( type, data, this );
- } );
- },
- triggerHandler: function( type, data ) {
- var elem = this[ 0 ];
- if ( elem ) {
- return jQuery.event.trigger( type, data, elem, true );
- }
- }
-} );
-
-
-jQuery.each( ( "blur focus focusin focusout resize scroll click dblclick " +
- "mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave " +
- "change select submit keydown keypress keyup contextmenu" ).split( " " ),
- function( i, name ) {
-
- // Handle event binding
- jQuery.fn[ name ] = function( data, fn ) {
- return arguments.length > 0 ?
- this.on( name, null, data, fn ) :
- this.trigger( name );
- };
-} );
-
-jQuery.fn.extend( {
- hover: function( fnOver, fnOut ) {
- return this.mouseenter( fnOver ).mouseleave( fnOut || fnOver );
- }
-} );
-
-
-
-
-support.focusin = "onfocusin" in window;
-
-
-// Support: Firefox <=44
-// Firefox doesn't have focus(in | out) events
-// Related ticket - https://bugzilla.mozilla.org/show_bug.cgi?id=687787
-//
-// Support: Chrome <=48 - 49, Safari <=9.0 - 9.1
-// focus(in | out) events fire after focus & blur events,
-// which is spec violation - http://www.w3.org/TR/DOM-Level-3-Events/#events-focusevent-event-order
-// Related ticket - https://bugs.chromium.org/p/chromium/issues/detail?id=449857
-if ( !support.focusin ) {
- jQuery.each( { focus: "focusin", blur: "focusout" }, function( orig, fix ) {
-
- // Attach a single capturing handler on the document while someone wants focusin/focusout
- var handler = function( event ) {
- jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ) );
- };
-
- jQuery.event.special[ fix ] = {
- setup: function() {
- var doc = this.ownerDocument || this,
- attaches = dataPriv.access( doc, fix );
-
- if ( !attaches ) {
- doc.addEventListener( orig, handler, true );
- }
- dataPriv.access( doc, fix, ( attaches || 0 ) + 1 );
- },
- teardown: function() {
- var doc = this.ownerDocument || this,
- attaches = dataPriv.access( doc, fix ) - 1;
-
- if ( !attaches ) {
- doc.removeEventListener( orig, handler, true );
- dataPriv.remove( doc, fix );
-
- } else {
- dataPriv.access( doc, fix, attaches );
- }
- }
- };
- } );
-}
-var location = window.location;
-
-var nonce = jQuery.now();
-
-var rquery = ( /\?/ );
-
-
-
-// Cross-browser xml parsing
-jQuery.parseXML = function( data ) {
- var xml;
- if ( !data || typeof data !== "string" ) {
- return null;
- }
-
- // Support: IE 9 - 11 only
- // IE throws on parseFromString with invalid input.
- try {
- xml = ( new window.DOMParser() ).parseFromString( data, "text/xml" );
- } catch ( e ) {
- xml = undefined;
- }
-
- if ( !xml || xml.getElementsByTagName( "parsererror" ).length ) {
- jQuery.error( "Invalid XML: " + data );
- }
- return xml;
-};
-
-
-var
- rbracket = /\[\]$/,
- rCRLF = /\r?\n/g,
- rsubmitterTypes = /^(?:submit|button|image|reset|file)$/i,
- rsubmittable = /^(?:input|select|textarea|keygen)/i;
-
-function buildParams( prefix, obj, traditional, add ) {
- var name;
-
- if ( Array.isArray( obj ) ) {
-
- // Serialize array item.
- jQuery.each( obj, function( i, v ) {
- if ( traditional || rbracket.test( prefix ) ) {
-
- // Treat each array item as a scalar.
- add( prefix, v );
-
- } else {
-
- // Item is non-scalar (array or object), encode its numeric index.
- buildParams(
- prefix + "[" + ( typeof v === "object" && v != null ? i : "" ) + "]",
- v,
- traditional,
- add
- );
- }
- } );
-
- } else if ( !traditional && jQuery.type( obj ) === "object" ) {
-
- // Serialize object item.
- for ( name in obj ) {
- buildParams( prefix + "[" + name + "]", obj[ name ], traditional, add );
- }
-
- } else {
-
- // Serialize scalar item.
- add( prefix, obj );
- }
-}
-
-// Serialize an array of form elements or a set of
-// key/values into a query string
-jQuery.param = function( a, traditional ) {
- var prefix,
- s = [],
- add = function( key, valueOrFunction ) {
-
- // If value is a function, invoke it and use its return value
- var value = jQuery.isFunction( valueOrFunction ) ?
- valueOrFunction() :
- valueOrFunction;
-
- s[ s.length ] = encodeURIComponent( key ) + "=" +
- encodeURIComponent( value == null ? "" : value );
- };
-
- // If an array was passed in, assume that it is an array of form elements.
- if ( Array.isArray( a ) || ( a.jquery && !jQuery.isPlainObject( a ) ) ) {
-
- // Serialize the form elements
- jQuery.each( a, function() {
- add( this.name, this.value );
- } );
-
- } else {
-
- // If traditional, encode the "old" way (the way 1.3.2 or older
- // did it), otherwise encode params recursively.
- for ( prefix in a ) {
- buildParams( prefix, a[ prefix ], traditional, add );
- }
- }
-
- // Return the resulting serialization
- return s.join( "&" );
-};
-
-jQuery.fn.extend( {
- serialize: function() {
- return jQuery.param( this.serializeArray() );
- },
- serializeArray: function() {
- return this.map( function() {
-
- // Can add propHook for "elements" to filter or add form elements
- var elements = jQuery.prop( this, "elements" );
- return elements ? jQuery.makeArray( elements ) : this;
- } )
- .filter( function() {
- var type = this.type;
-
- // Use .is( ":disabled" ) so that fieldset[disabled] works
- return this.name && !jQuery( this ).is( ":disabled" ) &&
- rsubmittable.test( this.nodeName ) && !rsubmitterTypes.test( type ) &&
- ( this.checked || !rcheckableType.test( type ) );
- } )
- .map( function( i, elem ) {
- var val = jQuery( this ).val();
-
- if ( val == null ) {
- return null;
- }
-
- if ( Array.isArray( val ) ) {
- return jQuery.map( val, function( val ) {
- return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) };
- } );
- }
-
- return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) };
- } ).get();
- }
-} );
-
-
-var
- r20 = /%20/g,
- rhash = /#.*$/,
- rantiCache = /([?&])_=[^&]*/,
- rheaders = /^(.*?):[ \t]*([^\r\n]*)$/mg,
-
- // #7653, #8125, #8152: local protocol detection
- rlocalProtocol = /^(?:about|app|app-storage|.+-extension|file|res|widget):$/,
- rnoContent = /^(?:GET|HEAD)$/,
- rprotocol = /^\/\//,
-
- /* Prefilters
- * 1) They are useful to introduce custom dataTypes (see ajax/jsonp.js for an example)
- * 2) These are called:
- * - BEFORE asking for a transport
- * - AFTER param serialization (s.data is a string if s.processData is true)
- * 3) key is the dataType
- * 4) the catchall symbol "*" can be used
- * 5) execution will start with transport dataType and THEN continue down to "*" if needed
- */
- prefilters = {},
-
- /* Transports bindings
- * 1) key is the dataType
- * 2) the catchall symbol "*" can be used
- * 3) selection will start with transport dataType and THEN go to "*" if needed
- */
- transports = {},
-
- // Avoid comment-prolog char sequence (#10098); must appease lint and evade compression
- allTypes = "*/".concat( "*" ),
-
- // Anchor tag for parsing the document origin
- originAnchor = document.createElement( "a" );
- originAnchor.href = location.href;
-
-// Base "constructor" for jQuery.ajaxPrefilter and jQuery.ajaxTransport
-function addToPrefiltersOrTransports( structure ) {
-
- // dataTypeExpression is optional and defaults to "*"
- return function( dataTypeExpression, func ) {
-
- if ( typeof dataTypeExpression !== "string" ) {
- func = dataTypeExpression;
- dataTypeExpression = "*";
- }
-
- var dataType,
- i = 0,
- dataTypes = dataTypeExpression.toLowerCase().match( rnothtmlwhite ) || [];
-
- if ( jQuery.isFunction( func ) ) {
-
- // For each dataType in the dataTypeExpression
- while ( ( dataType = dataTypes[ i++ ] ) ) {
-
- // Prepend if requested
- if ( dataType[ 0 ] === "+" ) {
- dataType = dataType.slice( 1 ) || "*";
- ( structure[ dataType ] = structure[ dataType ] || [] ).unshift( func );
-
- // Otherwise append
- } else {
- ( structure[ dataType ] = structure[ dataType ] || [] ).push( func );
- }
- }
- }
- };
-}
-
-// Base inspection function for prefilters and transports
-function inspectPrefiltersOrTransports( structure, options, originalOptions, jqXHR ) {
-
- var inspected = {},
- seekingTransport = ( structure === transports );
-
- function inspect( dataType ) {
- var selected;
- inspected[ dataType ] = true;
- jQuery.each( structure[ dataType ] || [], function( _, prefilterOrFactory ) {
- var dataTypeOrTransport = prefilterOrFactory( options, originalOptions, jqXHR );
- if ( typeof dataTypeOrTransport === "string" &&
- !seekingTransport && !inspected[ dataTypeOrTransport ] ) {
-
- options.dataTypes.unshift( dataTypeOrTransport );
- inspect( dataTypeOrTransport );
- return false;
- } else if ( seekingTransport ) {
- return !( selected = dataTypeOrTransport );
- }
- } );
- return selected;
- }
-
- return inspect( options.dataTypes[ 0 ] ) || !inspected[ "*" ] && inspect( "*" );
-}
-
-// A special extend for ajax options
-// that takes "flat" options (not to be deep extended)
-// Fixes #9887
-function ajaxExtend( target, src ) {
- var key, deep,
- flatOptions = jQuery.ajaxSettings.flatOptions || {};
-
- for ( key in src ) {
- if ( src[ key ] !== undefined ) {
- ( flatOptions[ key ] ? target : ( deep || ( deep = {} ) ) )[ key ] = src[ key ];
- }
- }
- if ( deep ) {
- jQuery.extend( true, target, deep );
- }
-
- return target;
-}
-
-/* Handles responses to an ajax request:
- * - finds the right dataType (mediates between content-type and expected dataType)
- * - returns the corresponding response
- */
-function ajaxHandleResponses( s, jqXHR, responses ) {
-
- var ct, type, finalDataType, firstDataType,
- contents = s.contents,
- dataTypes = s.dataTypes;
-
- // Remove auto dataType and get content-type in the process
- while ( dataTypes[ 0 ] === "*" ) {
- dataTypes.shift();
- if ( ct === undefined ) {
- ct = s.mimeType || jqXHR.getResponseHeader( "Content-Type" );
- }
- }
-
- // Check if we're dealing with a known content-type
- if ( ct ) {
- for ( type in contents ) {
- if ( contents[ type ] && contents[ type ].test( ct ) ) {
- dataTypes.unshift( type );
- break;
- }
- }
- }
-
- // Check to see if we have a response for the expected dataType
- if ( dataTypes[ 0 ] in responses ) {
- finalDataType = dataTypes[ 0 ];
- } else {
-
- // Try convertible dataTypes
- for ( type in responses ) {
- if ( !dataTypes[ 0 ] || s.converters[ type + " " + dataTypes[ 0 ] ] ) {
- finalDataType = type;
- break;
- }
- if ( !firstDataType ) {
- firstDataType = type;
- }
- }
-
- // Or just use first one
- finalDataType = finalDataType || firstDataType;
- }
-
- // If we found a dataType
- // We add the dataType to the list if needed
- // and return the corresponding response
- if ( finalDataType ) {
- if ( finalDataType !== dataTypes[ 0 ] ) {
- dataTypes.unshift( finalDataType );
- }
- return responses[ finalDataType ];
- }
-}
-
-/* Chain conversions given the request and the original response
- * Also sets the responseXXX fields on the jqXHR instance
- */
-function ajaxConvert( s, response, jqXHR, isSuccess ) {
- var conv2, current, conv, tmp, prev,
- converters = {},
-
- // Work with a copy of dataTypes in case we need to modify it for conversion
- dataTypes = s.dataTypes.slice();
-
- // Create converters map with lowercased keys
- if ( dataTypes[ 1 ] ) {
- for ( conv in s.converters ) {
- converters[ conv.toLowerCase() ] = s.converters[ conv ];
- }
- }
-
- current = dataTypes.shift();
-
- // Convert to each sequential dataType
- while ( current ) {
-
- if ( s.responseFields[ current ] ) {
- jqXHR[ s.responseFields[ current ] ] = response;
- }
-
- // Apply the dataFilter if provided
- if ( !prev && isSuccess && s.dataFilter ) {
- response = s.dataFilter( response, s.dataType );
- }
-
- prev = current;
- current = dataTypes.shift();
-
- if ( current ) {
-
- // There's only work to do if current dataType is non-auto
- if ( current === "*" ) {
-
- current = prev;
-
- // Convert response if prev dataType is non-auto and differs from current
- } else if ( prev !== "*" && prev !== current ) {
-
- // Seek a direct converter
- conv = converters[ prev + " " + current ] || converters[ "* " + current ];
-
- // If none found, seek a pair
- if ( !conv ) {
- for ( conv2 in converters ) {
-
- // If conv2 outputs current
- tmp = conv2.split( " " );
- if ( tmp[ 1 ] === current ) {
-
- // If prev can be converted to accepted input
- conv = converters[ prev + " " + tmp[ 0 ] ] ||
- converters[ "* " + tmp[ 0 ] ];
- if ( conv ) {
-
- // Condense equivalence converters
- if ( conv === true ) {
- conv = converters[ conv2 ];
-
- // Otherwise, insert the intermediate dataType
- } else if ( converters[ conv2 ] !== true ) {
- current = tmp[ 0 ];
- dataTypes.unshift( tmp[ 1 ] );
- }
- break;
- }
- }
- }
- }
-
- // Apply converter (if not an equivalence)
- if ( conv !== true ) {
-
- // Unless errors are allowed to bubble, catch and return them
- if ( conv && s.throws ) {
- response = conv( response );
- } else {
- try {
- response = conv( response );
- } catch ( e ) {
- return {
- state: "parsererror",
- error: conv ? e : "No conversion from " + prev + " to " + current
- };
- }
- }
- }
- }
- }
- }
-
- return { state: "success", data: response };
-}
-
-jQuery.extend( {
-
- // Counter for holding the number of active queries
- active: 0,
-
- // Last-Modified header cache for next request
- lastModified: {},
- etag: {},
-
- ajaxSettings: {
- url: location.href,
- type: "GET",
- isLocal: rlocalProtocol.test( location.protocol ),
- global: true,
- processData: true,
- async: true,
- contentType: "application/x-www-form-urlencoded; charset=UTF-8",
-
- /*
- timeout: 0,
- data: null,
- dataType: null,
- username: null,
- password: null,
- cache: null,
- throws: false,
- traditional: false,
- headers: {},
- */
-
- accepts: {
- "*": allTypes,
- text: "text/plain",
- html: "text/html",
- xml: "application/xml, text/xml",
- json: "application/json, text/javascript"
- },
-
- contents: {
- xml: /\bxml\b/,
- html: /\bhtml/,
- json: /\bjson\b/
- },
-
- responseFields: {
- xml: "responseXML",
- text: "responseText",
- json: "responseJSON"
- },
-
- // Data converters
- // Keys separate source (or catchall "*") and destination types with a single space
- converters: {
-
- // Convert anything to text
- "* text": String,
-
- // Text to html (true = no transformation)
- "text html": true,
-
- // Evaluate text as a json expression
- "text json": JSON.parse,
-
- // Parse text as xml
- "text xml": jQuery.parseXML
- },
-
- // For options that shouldn't be deep extended:
- // you can add your own custom options here if
- // and when you create one that shouldn't be
- // deep extended (see ajaxExtend)
- flatOptions: {
- url: true,
- context: true
- }
- },
-
- // Creates a full fledged settings object into target
- // with both ajaxSettings and settings fields.
- // If target is omitted, writes into ajaxSettings.
- ajaxSetup: function( target, settings ) {
- return settings ?
-
- // Building a settings object
- ajaxExtend( ajaxExtend( target, jQuery.ajaxSettings ), settings ) :
-
- // Extending ajaxSettings
- ajaxExtend( jQuery.ajaxSettings, target );
- },
-
- ajaxPrefilter: addToPrefiltersOrTransports( prefilters ),
- ajaxTransport: addToPrefiltersOrTransports( transports ),
-
- // Main method
- ajax: function( url, options ) {
-
- // If url is an object, simulate pre-1.5 signature
- if ( typeof url === "object" ) {
- options = url;
- url = undefined;
- }
-
- // Force options to be an object
- options = options || {};
-
- var transport,
-
- // URL without anti-cache param
- cacheURL,
-
- // Response headers
- responseHeadersString,
- responseHeaders,
-
- // timeout handle
- timeoutTimer,
-
- // Url cleanup var
- urlAnchor,
-
- // Request state (becomes false upon send and true upon completion)
- completed,
-
- // To know if global events are to be dispatched
- fireGlobals,
-
- // Loop variable
- i,
-
- // uncached part of the url
- uncached,
-
- // Create the final options object
- s = jQuery.ajaxSetup( {}, options ),
-
- // Callbacks context
- callbackContext = s.context || s,
-
- // Context for global events is callbackContext if it is a DOM node or jQuery collection
- globalEventContext = s.context &&
- ( callbackContext.nodeType || callbackContext.jquery ) ?
- jQuery( callbackContext ) :
- jQuery.event,
-
- // Deferreds
- deferred = jQuery.Deferred(),
- completeDeferred = jQuery.Callbacks( "once memory" ),
-
- // Status-dependent callbacks
- statusCode = s.statusCode || {},
-
- // Headers (they are sent all at once)
- requestHeaders = {},
- requestHeadersNames = {},
-
- // Default abort message
- strAbort = "canceled",
-
- // Fake xhr
- jqXHR = {
- readyState: 0,
-
- // Builds headers hashtable if needed
- getResponseHeader: function( key ) {
- var match;
- if ( completed ) {
- if ( !responseHeaders ) {
- responseHeaders = {};
- while ( ( match = rheaders.exec( responseHeadersString ) ) ) {
- responseHeaders[ match[ 1 ].toLowerCase() ] = match[ 2 ];
- }
- }
- match = responseHeaders[ key.toLowerCase() ];
- }
- return match == null ? null : match;
- },
-
- // Raw string
- getAllResponseHeaders: function() {
- return completed ? responseHeadersString : null;
- },
-
- // Caches the header
- setRequestHeader: function( name, value ) {
- if ( completed == null ) {
- name = requestHeadersNames[ name.toLowerCase() ] =
- requestHeadersNames[ name.toLowerCase() ] || name;
- requestHeaders[ name ] = value;
- }
- return this;
- },
-
- // Overrides response content-type header
- overrideMimeType: function( type ) {
- if ( completed == null ) {
- s.mimeType = type;
- }
- return this;
- },
-
- // Status-dependent callbacks
- statusCode: function( map ) {
- var code;
- if ( map ) {
- if ( completed ) {
-
- // Execute the appropriate callbacks
- jqXHR.always( map[ jqXHR.status ] );
- } else {
-
- // Lazy-add the new callbacks in a way that preserves old ones
- for ( code in map ) {
- statusCode[ code ] = [ statusCode[ code ], map[ code ] ];
- }
- }
- }
- return this;
- },
-
- // Cancel the request
- abort: function( statusText ) {
- var finalText = statusText || strAbort;
- if ( transport ) {
- transport.abort( finalText );
- }
- done( 0, finalText );
- return this;
- }
- };
-
- // Attach deferreds
- deferred.promise( jqXHR );
-
- // Add protocol if not provided (prefilters might expect it)
- // Handle falsy url in the settings object (#10093: consistency with old signature)
- // We also use the url parameter if available
- s.url = ( ( url || s.url || location.href ) + "" )
- .replace( rprotocol, location.protocol + "//" );
-
- // Alias method option to type as per ticket #12004
- s.type = options.method || options.type || s.method || s.type;
-
- // Extract dataTypes list
- s.dataTypes = ( s.dataType || "*" ).toLowerCase().match( rnothtmlwhite ) || [ "" ];
-
- // A cross-domain request is in order when the origin doesn't match the current origin.
- if ( s.crossDomain == null ) {
- urlAnchor = document.createElement( "a" );
-
- // Support: IE <=8 - 11, Edge 12 - 13
- // IE throws exception on accessing the href property if url is malformed,
- // e.g. http://example.com:80x/
- try {
- urlAnchor.href = s.url;
-
- // Support: IE <=8 - 11 only
- // Anchor's host property isn't correctly set when s.url is relative
- urlAnchor.href = urlAnchor.href;
- s.crossDomain = originAnchor.protocol + "//" + originAnchor.host !==
- urlAnchor.protocol + "//" + urlAnchor.host;
- } catch ( e ) {
-
- // If there is an error parsing the URL, assume it is crossDomain,
- // it can be rejected by the transport if it is invalid
- s.crossDomain = true;
- }
- }
-
- // Convert data if not already a string
- if ( s.data && s.processData && typeof s.data !== "string" ) {
- s.data = jQuery.param( s.data, s.traditional );
- }
-
- // Apply prefilters
- inspectPrefiltersOrTransports( prefilters, s, options, jqXHR );
-
- // If request was aborted inside a prefilter, stop there
- if ( completed ) {
- return jqXHR;
- }
-
- // We can fire global events as of now if asked to
- // Don't fire events if jQuery.event is undefined in an AMD-usage scenario (#15118)
- fireGlobals = jQuery.event && s.global;
-
- // Watch for a new set of requests
- if ( fireGlobals && jQuery.active++ === 0 ) {
- jQuery.event.trigger( "ajaxStart" );
- }
-
- // Uppercase the type
- s.type = s.type.toUpperCase();
-
- // Determine if request has content
- s.hasContent = !rnoContent.test( s.type );
-
- // Save the URL in case we're toying with the If-Modified-Since
- // and/or If-None-Match header later on
- // Remove hash to simplify url manipulation
- cacheURL = s.url.replace( rhash, "" );
-
- // More options handling for requests with no content
- if ( !s.hasContent ) {
-
- // Remember the hash so we can put it back
- uncached = s.url.slice( cacheURL.length );
-
- // If data is available, append data to url
- if ( s.data ) {
- cacheURL += ( rquery.test( cacheURL ) ? "&" : "?" ) + s.data;
-
- // #9682: remove data so that it's not used in an eventual retry
- delete s.data;
- }
-
- // Add or update anti-cache param if needed
- if ( s.cache === false ) {
- cacheURL = cacheURL.replace( rantiCache, "$1" );
- uncached = ( rquery.test( cacheURL ) ? "&" : "?" ) + "_=" + ( nonce++ ) + uncached;
- }
-
- // Put hash and anti-cache on the URL that will be requested (gh-1732)
- s.url = cacheURL + uncached;
-
- // Change '%20' to '+' if this is encoded form body content (gh-2658)
- } else if ( s.data && s.processData &&
- ( s.contentType || "" ).indexOf( "application/x-www-form-urlencoded" ) === 0 ) {
- s.data = s.data.replace( r20, "+" );
- }
-
- // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode.
- if ( s.ifModified ) {
- if ( jQuery.lastModified[ cacheURL ] ) {
- jqXHR.setRequestHeader( "If-Modified-Since", jQuery.lastModified[ cacheURL ] );
- }
- if ( jQuery.etag[ cacheURL ] ) {
- jqXHR.setRequestHeader( "If-None-Match", jQuery.etag[ cacheURL ] );
- }
- }
-
- // Set the correct header, if data is being sent
- if ( s.data && s.hasContent && s.contentType !== false || options.contentType ) {
- jqXHR.setRequestHeader( "Content-Type", s.contentType );
- }
-
- // Set the Accepts header for the server, depending on the dataType
- jqXHR.setRequestHeader(
- "Accept",
- s.dataTypes[ 0 ] && s.accepts[ s.dataTypes[ 0 ] ] ?
- s.accepts[ s.dataTypes[ 0 ] ] +
- ( s.dataTypes[ 0 ] !== "*" ? ", " + allTypes + "; q=0.01" : "" ) :
- s.accepts[ "*" ]
- );
-
- // Check for headers option
- for ( i in s.headers ) {
- jqXHR.setRequestHeader( i, s.headers[ i ] );
- }
-
- // Allow custom headers/mimetypes and early abort
- if ( s.beforeSend &&
- ( s.beforeSend.call( callbackContext, jqXHR, s ) === false || completed ) ) {
-
- // Abort if not done already and return
- return jqXHR.abort();
- }
-
- // Aborting is no longer a cancellation
- strAbort = "abort";
-
- // Install callbacks on deferreds
- completeDeferred.add( s.complete );
- jqXHR.done( s.success );
- jqXHR.fail( s.error );
-
- // Get transport
- transport = inspectPrefiltersOrTransports( transports, s, options, jqXHR );
-
- // If no transport, we auto-abort
- if ( !transport ) {
- done( -1, "No Transport" );
- } else {
- jqXHR.readyState = 1;
-
- // Send global event
- if ( fireGlobals ) {
- globalEventContext.trigger( "ajaxSend", [ jqXHR, s ] );
- }
-
- // If request was aborted inside ajaxSend, stop there
- if ( completed ) {
- return jqXHR;
- }
-
- // Timeout
- if ( s.async && s.timeout > 0 ) {
- timeoutTimer = window.setTimeout( function() {
- jqXHR.abort( "timeout" );
- }, s.timeout );
- }
-
- try {
- completed = false;
- transport.send( requestHeaders, done );
- } catch ( e ) {
-
- // Rethrow post-completion exceptions
- if ( completed ) {
- throw e;
- }
-
- // Propagate others as results
- done( -1, e );
- }
- }
-
- // Callback for when everything is done
- function done( status, nativeStatusText, responses, headers ) {
- var isSuccess, success, error, response, modified,
- statusText = nativeStatusText;
-
- // Ignore repeat invocations
- if ( completed ) {
- return;
- }
-
- completed = true;
-
- // Clear timeout if it exists
- if ( timeoutTimer ) {
- window.clearTimeout( timeoutTimer );
- }
-
- // Dereference transport for early garbage collection
- // (no matter how long the jqXHR object will be used)
- transport = undefined;
-
- // Cache response headers
- responseHeadersString = headers || "";
-
- // Set readyState
- jqXHR.readyState = status > 0 ? 4 : 0;
-
- // Determine if successful
- isSuccess = status >= 200 && status < 300 || status === 304;
-
- // Get response data
- if ( responses ) {
- response = ajaxHandleResponses( s, jqXHR, responses );
- }
-
- // Convert no matter what (that way responseXXX fields are always set)
- response = ajaxConvert( s, response, jqXHR, isSuccess );
-
- // If successful, handle type chaining
- if ( isSuccess ) {
-
- // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode.
- if ( s.ifModified ) {
- modified = jqXHR.getResponseHeader( "Last-Modified" );
- if ( modified ) {
- jQuery.lastModified[ cacheURL ] = modified;
- }
- modified = jqXHR.getResponseHeader( "etag" );
- if ( modified ) {
- jQuery.etag[ cacheURL ] = modified;
- }
- }
-
- // if no content
- if ( status === 204 || s.type === "HEAD" ) {
- statusText = "nocontent";
-
- // if not modified
- } else if ( status === 304 ) {
- statusText = "notmodified";
-
- // If we have data, let's convert it
- } else {
- statusText = response.state;
- success = response.data;
- error = response.error;
- isSuccess = !error;
- }
- } else {
-
- // Extract error from statusText and normalize for non-aborts
- error = statusText;
- if ( status || !statusText ) {
- statusText = "error";
- if ( status < 0 ) {
- status = 0;
- }
- }
- }
-
- // Set data for the fake xhr object
- jqXHR.status = status;
- jqXHR.statusText = ( nativeStatusText || statusText ) + "";
-
- // Success/Error
- if ( isSuccess ) {
- deferred.resolveWith( callbackContext, [ success, statusText, jqXHR ] );
- } else {
- deferred.rejectWith( callbackContext, [ jqXHR, statusText, error ] );
- }
-
- // Status-dependent callbacks
- jqXHR.statusCode( statusCode );
- statusCode = undefined;
-
- if ( fireGlobals ) {
- globalEventContext.trigger( isSuccess ? "ajaxSuccess" : "ajaxError",
- [ jqXHR, s, isSuccess ? success : error ] );
- }
-
- // Complete
- completeDeferred.fireWith( callbackContext, [ jqXHR, statusText ] );
-
- if ( fireGlobals ) {
- globalEventContext.trigger( "ajaxComplete", [ jqXHR, s ] );
-
- // Handle the global AJAX counter
- if ( !( --jQuery.active ) ) {
- jQuery.event.trigger( "ajaxStop" );
- }
- }
- }
-
- return jqXHR;
- },
-
- getJSON: function( url, data, callback ) {
- return jQuery.get( url, data, callback, "json" );
- },
-
- getScript: function( url, callback ) {
- return jQuery.get( url, undefined, callback, "script" );
- }
-} );
-
-jQuery.each( [ "get", "post" ], function( i, method ) {
- jQuery[ method ] = function( url, data, callback, type ) {
-
- // Shift arguments if data argument was omitted
- if ( jQuery.isFunction( data ) ) {
- type = type || callback;
- callback = data;
- data = undefined;
- }
-
- // The url can be an options object (which then must have .url)
- return jQuery.ajax( jQuery.extend( {
- url: url,
- type: method,
- dataType: type,
- data: data,
- success: callback
- }, jQuery.isPlainObject( url ) && url ) );
- };
-} );
-
-
-jQuery._evalUrl = function( url ) {
- return jQuery.ajax( {
- url: url,
-
- // Make this explicit, since user can override this through ajaxSetup (#11264)
- type: "GET",
- dataType: "script",
- cache: true,
- async: false,
- global: false,
- "throws": true
- } );
-};
-
-
-jQuery.fn.extend( {
- wrapAll: function( html ) {
- var wrap;
-
- if ( this[ 0 ] ) {
- if ( jQuery.isFunction( html ) ) {
- html = html.call( this[ 0 ] );
- }
-
- // The elements to wrap the target around
- wrap = jQuery( html, this[ 0 ].ownerDocument ).eq( 0 ).clone( true );
-
- if ( this[ 0 ].parentNode ) {
- wrap.insertBefore( this[ 0 ] );
- }
-
- wrap.map( function() {
- var elem = this;
-
- while ( elem.firstElementChild ) {
- elem = elem.firstElementChild;
- }
-
- return elem;
- } ).append( this );
- }
-
- return this;
- },
-
- wrapInner: function( html ) {
- if ( jQuery.isFunction( html ) ) {
- return this.each( function( i ) {
- jQuery( this ).wrapInner( html.call( this, i ) );
- } );
- }
-
- return this.each( function() {
- var self = jQuery( this ),
- contents = self.contents();
-
- if ( contents.length ) {
- contents.wrapAll( html );
-
- } else {
- self.append( html );
- }
- } );
- },
-
- wrap: function( html ) {
- var isFunction = jQuery.isFunction( html );
-
- return this.each( function( i ) {
- jQuery( this ).wrapAll( isFunction ? html.call( this, i ) : html );
- } );
- },
-
- unwrap: function( selector ) {
- this.parent( selector ).not( "body" ).each( function() {
- jQuery( this ).replaceWith( this.childNodes );
- } );
- return this;
- }
-} );
-
-
-jQuery.expr.pseudos.hidden = function( elem ) {
- return !jQuery.expr.pseudos.visible( elem );
-};
-jQuery.expr.pseudos.visible = function( elem ) {
- return !!( elem.offsetWidth || elem.offsetHeight || elem.getClientRects().length );
-};
-
-
-
-
-jQuery.ajaxSettings.xhr = function() {
- try {
- return new window.XMLHttpRequest();
- } catch ( e ) {}
-};
-
-var xhrSuccessStatus = {
-
- // File protocol always yields status code 0, assume 200
- 0: 200,
-
- // Support: IE <=9 only
- // #1450: sometimes IE returns 1223 when it should be 204
- 1223: 204
- },
- xhrSupported = jQuery.ajaxSettings.xhr();
-
-support.cors = !!xhrSupported && ( "withCredentials" in xhrSupported );
-support.ajax = xhrSupported = !!xhrSupported;
-
-jQuery.ajaxTransport( function( options ) {
- var callback, errorCallback;
-
- // Cross domain only allowed if supported through XMLHttpRequest
- if ( support.cors || xhrSupported && !options.crossDomain ) {
- return {
- send: function( headers, complete ) {
- var i,
- xhr = options.xhr();
-
- xhr.open(
- options.type,
- options.url,
- options.async,
- options.username,
- options.password
- );
-
- // Apply custom fields if provided
- if ( options.xhrFields ) {
- for ( i in options.xhrFields ) {
- xhr[ i ] = options.xhrFields[ i ];
- }
- }
-
- // Override mime type if needed
- if ( options.mimeType && xhr.overrideMimeType ) {
- xhr.overrideMimeType( options.mimeType );
- }
-
- // X-Requested-With header
- // For cross-domain requests, seeing as conditions for a preflight are
- // akin to a jigsaw puzzle, we simply never set it to be sure.
- // (it can always be set on a per-request basis or even using ajaxSetup)
- // For same-domain requests, won't change header if already provided.
- if ( !options.crossDomain && !headers[ "X-Requested-With" ] ) {
- headers[ "X-Requested-With" ] = "XMLHttpRequest";
- }
-
- // Set headers
- for ( i in headers ) {
- xhr.setRequestHeader( i, headers[ i ] );
- }
-
- // Callback
- callback = function( type ) {
- return function() {
- if ( callback ) {
- callback = errorCallback = xhr.onload =
- xhr.onerror = xhr.onabort = xhr.onreadystatechange = null;
-
- if ( type === "abort" ) {
- xhr.abort();
- } else if ( type === "error" ) {
-
- // Support: IE <=9 only
- // On a manual native abort, IE9 throws
- // errors on any property access that is not readyState
- if ( typeof xhr.status !== "number" ) {
- complete( 0, "error" );
- } else {
- complete(
-
- // File: protocol always yields status 0; see #8605, #14207
- xhr.status,
- xhr.statusText
- );
- }
- } else {
- complete(
- xhrSuccessStatus[ xhr.status ] || xhr.status,
- xhr.statusText,
-
- // Support: IE <=9 only
- // IE9 has no XHR2 but throws on binary (trac-11426)
- // For XHR2 non-text, let the caller handle it (gh-2498)
- ( xhr.responseType || "text" ) !== "text" ||
- typeof xhr.responseText !== "string" ?
- { binary: xhr.response } :
- { text: xhr.responseText },
- xhr.getAllResponseHeaders()
- );
- }
- }
- };
- };
-
- // Listen to events
- xhr.onload = callback();
- errorCallback = xhr.onerror = callback( "error" );
-
- // Support: IE 9 only
- // Use onreadystatechange to replace onabort
- // to handle uncaught aborts
- if ( xhr.onabort !== undefined ) {
- xhr.onabort = errorCallback;
- } else {
- xhr.onreadystatechange = function() {
-
- // Check readyState before timeout as it changes
- if ( xhr.readyState === 4 ) {
-
- // Allow onerror to be called first,
- // but that will not handle a native abort
- // Also, save errorCallback to a variable
- // as xhr.onerror cannot be accessed
- window.setTimeout( function() {
- if ( callback ) {
- errorCallback();
- }
- } );
- }
- };
- }
-
- // Create the abort callback
- callback = callback( "abort" );
-
- try {
-
- // Do send the request (this may raise an exception)
- xhr.send( options.hasContent && options.data || null );
- } catch ( e ) {
-
- // #14683: Only rethrow if this hasn't been notified as an error yet
- if ( callback ) {
- throw e;
- }
- }
- },
-
- abort: function() {
- if ( callback ) {
- callback();
- }
- }
- };
- }
-} );
-
-
-
-
-// Prevent auto-execution of scripts when no explicit dataType was provided (See gh-2432)
-jQuery.ajaxPrefilter( function( s ) {
- if ( s.crossDomain ) {
- s.contents.script = false;
- }
-} );
-
-// Install script dataType
-jQuery.ajaxSetup( {
- accepts: {
- script: "text/javascript, application/javascript, " +
- "application/ecmascript, application/x-ecmascript"
- },
- contents: {
- script: /\b(?:java|ecma)script\b/
- },
- converters: {
- "text script": function( text ) {
- jQuery.globalEval( text );
- return text;
- }
- }
-} );
-
-// Handle cache's special case and crossDomain
-jQuery.ajaxPrefilter( "script", function( s ) {
- if ( s.cache === undefined ) {
- s.cache = false;
- }
- if ( s.crossDomain ) {
- s.type = "GET";
- }
-} );
-
-// Bind script tag hack transport
-jQuery.ajaxTransport( "script", function( s ) {
-
- // This transport only deals with cross domain requests
- if ( s.crossDomain ) {
- var script, callback;
- return {
- send: function( _, complete ) {
- script = jQuery( "<script>" ).prop( {
- charset: s.scriptCharset,
- src: s.url
- } ).on(
- "load error",
- callback = function( evt ) {
- script.remove();
- callback = null;
- if ( evt ) {
- complete( evt.type === "error" ? 404 : 200, evt.type );
- }
- }
- );
-
- // Use native DOM manipulation to avoid our domManip AJAX trickery
- document.head.appendChild( script[ 0 ] );
- },
- abort: function() {
- if ( callback ) {
- callback();
- }
- }
- };
- }
-} );
-
-
-
-
-var oldCallbacks = [],
- rjsonp = /(=)\?(?=&|$)|\?\?/;
-
-// Default jsonp settings
-jQuery.ajaxSetup( {
- jsonp: "callback",
- jsonpCallback: function() {
- var callback = oldCallbacks.pop() || ( jQuery.expando + "_" + ( nonce++ ) );
- this[ callback ] = true;
- return callback;
- }
-} );
-
-// Detect, normalize options and install callbacks for jsonp requests
-jQuery.ajaxPrefilter( "json jsonp", function( s, originalSettings, jqXHR ) {
-
- var callbackName, overwritten, responseContainer,
- jsonProp = s.jsonp !== false && ( rjsonp.test( s.url ) ?
- "url" :
- typeof s.data === "string" &&
- ( s.contentType || "" )
- .indexOf( "application/x-www-form-urlencoded" ) === 0 &&
- rjsonp.test( s.data ) && "data"
- );
-
- // Handle iff the expected data type is "jsonp" or we have a parameter to set
- if ( jsonProp || s.dataTypes[ 0 ] === "jsonp" ) {
-
- // Get callback name, remembering preexisting value associated with it
- callbackName = s.jsonpCallback = jQuery.isFunction( s.jsonpCallback ) ?
- s.jsonpCallback() :
- s.jsonpCallback;
-
- // Insert callback into url or form data
- if ( jsonProp ) {
- s[ jsonProp ] = s[ jsonProp ].replace( rjsonp, "$1" + callbackName );
- } else if ( s.jsonp !== false ) {
- s.url += ( rquery.test( s.url ) ? "&" : "?" ) + s.jsonp + "=" + callbackName;
- }
-
- // Use data converter to retrieve json after script execution
- s.converters[ "script json" ] = function() {
- if ( !responseContainer ) {
- jQuery.error( callbackName + " was not called" );
- }
- return responseContainer[ 0 ];
- };
-
- // Force json dataType
- s.dataTypes[ 0 ] = "json";
-
- // Install callback
- overwritten = window[ callbackName ];
- window[ callbackName ] = function() {
- responseContainer = arguments;
- };
-
- // Clean-up function (fires after converters)
- jqXHR.always( function() {
-
- // If previous value didn't exist - remove it
- if ( overwritten === undefined ) {
- jQuery( window ).removeProp( callbackName );
-
- // Otherwise restore preexisting value
- } else {
- window[ callbackName ] = overwritten;
- }
-
- // Save back as free
- if ( s[ callbackName ] ) {
-
- // Make sure that re-using the options doesn't screw things around
- s.jsonpCallback = originalSettings.jsonpCallback;
-
- // Save the callback name for future use
- oldCallbacks.push( callbackName );
- }
-
- // Call if it was a function and we have a response
- if ( responseContainer && jQuery.isFunction( overwritten ) ) {
- overwritten( responseContainer[ 0 ] );
- }
-
- responseContainer = overwritten = undefined;
- } );
-
- // Delegate to script
- return "script";
- }
-} );
-
-
-
-
-// Support: Safari 8 only
-// In Safari 8 documents created via document.implementation.createHTMLDocument
-// collapse sibling forms: the second one becomes a child of the first one.
-// Because of that, this security measure has to be disabled in Safari 8.
-// https://bugs.webkit.org/show_bug.cgi?id=137337
-support.createHTMLDocument = ( function() {
- var body = document.implementation.createHTMLDocument( "" ).body;
- body.innerHTML = "<form></form><form></form>";
- return body.childNodes.length === 2;
-} )();
-
-
-// Argument "data" should be string of html
-// context (optional): If specified, the fragment will be created in this context,
-// defaults to document
-// keepScripts (optional): If true, will include scripts passed in the html string
-jQuery.parseHTML = function( data, context, keepScripts ) {
- if ( typeof data !== "string" ) {
- return [];
- }
- if ( typeof context === "boolean" ) {
- keepScripts = context;
- context = false;
- }
-
- var base, parsed, scripts;
-
- if ( !context ) {
-
- // Stop scripts or inline event handlers from being executed immediately
- // by using document.implementation
- if ( support.createHTMLDocument ) {
- context = document.implementation.createHTMLDocument( "" );
-
- // Set the base href for the created document
- // so any parsed elements with URLs
- // are based on the document's URL (gh-2965)
- base = context.createElement( "base" );
- base.href = document.location.href;
- context.head.appendChild( base );
- } else {
- context = document;
- }
- }
-
- parsed = rsingleTag.exec( data );
- scripts = !keepScripts && [];
-
- // Single tag
- if ( parsed ) {
- return [ context.createElement( parsed[ 1 ] ) ];
- }
-
- parsed = buildFragment( [ data ], context, scripts );
-
- if ( scripts && scripts.length ) {
- jQuery( scripts ).remove();
- }
-
- return jQuery.merge( [], parsed.childNodes );
-};
-
-
-/**
- * Load a url into a page
- */
-jQuery.fn.load = function( url, params, callback ) {
- var selector, type, response,
- self = this,
- off = url.indexOf( " " );
-
- if ( off > -1 ) {
- selector = stripAndCollapse( url.slice( off ) );
- url = url.slice( 0, off );
- }
-
- // If it's a function
- if ( jQuery.isFunction( params ) ) {
-
- // We assume that it's the callback
- callback = params;
- params = undefined;
-
- // Otherwise, build a param string
- } else if ( params && typeof params === "object" ) {
- type = "POST";
- }
-
- // If we have elements to modify, make the request
- if ( self.length > 0 ) {
- jQuery.ajax( {
- url: url,
-
- // If "type" variable is undefined, then "GET" method will be used.
- // Make value of this field explicit since
- // user can override it through ajaxSetup method
- type: type || "GET",
- dataType: "html",
- data: params
- } ).done( function( responseText ) {
-
- // Save response for use in complete callback
- response = arguments;
-
- self.html( selector ?
-
- // If a selector was specified, locate the right elements in a dummy div
- // Exclude scripts to avoid IE 'Permission Denied' errors
- jQuery( "<div>" ).append( jQuery.parseHTML( responseText ) ).find( selector ) :
-
- // Otherwise use the full result
- responseText );
-
- // If the request succeeds, this function gets "data", "status", "jqXHR"
- // but they are ignored because response was set above.
- // If it fails, this function gets "jqXHR", "status", "error"
- } ).always( callback && function( jqXHR, status ) {
- self.each( function() {
- callback.apply( this, response || [ jqXHR.responseText, status, jqXHR ] );
- } );
- } );
- }
-
- return this;
-};
-
-
-
-
-// Attach a bunch of functions for handling common AJAX events
-jQuery.each( [
- "ajaxStart",
- "ajaxStop",
- "ajaxComplete",
- "ajaxError",
- "ajaxSuccess",
- "ajaxSend"
-], function( i, type ) {
- jQuery.fn[ type ] = function( fn ) {
- return this.on( type, fn );
- };
-} );
-
-
-
-
-jQuery.expr.pseudos.animated = function( elem ) {
- return jQuery.grep( jQuery.timers, function( fn ) {
- return elem === fn.elem;
- } ).length;
-};
-
-
-
-
-jQuery.offset = {
- setOffset: function( elem, options, i ) {
- var curPosition, curLeft, curCSSTop, curTop, curOffset, curCSSLeft, calculatePosition,
- position = jQuery.css( elem, "position" ),
- curElem = jQuery( elem ),
- props = {};
-
- // Set position first, in-case top/left are set even on static elem
- if ( position === "static" ) {
- elem.style.position = "relative";
- }
-
- curOffset = curElem.offset();
- curCSSTop = jQuery.css( elem, "top" );
- curCSSLeft = jQuery.css( elem, "left" );
- calculatePosition = ( position === "absolute" || position === "fixed" ) &&
- ( curCSSTop + curCSSLeft ).indexOf( "auto" ) > -1;
-
- // Need to be able to calculate position if either
- // top or left is auto and position is either absolute or fixed
- if ( calculatePosition ) {
- curPosition = curElem.position();
- curTop = curPosition.top;
- curLeft = curPosition.left;
-
- } else {
- curTop = parseFloat( curCSSTop ) || 0;
- curLeft = parseFloat( curCSSLeft ) || 0;
- }
-
- if ( jQuery.isFunction( options ) ) {
-
- // Use jQuery.extend here to allow modification of coordinates argument (gh-1848)
- options = options.call( elem, i, jQuery.extend( {}, curOffset ) );
- }
-
- if ( options.top != null ) {
- props.top = ( options.top - curOffset.top ) + curTop;
- }
- if ( options.left != null ) {
- props.left = ( options.left - curOffset.left ) + curLeft;
- }
-
- if ( "using" in options ) {
- options.using.call( elem, props );
-
- } else {
- curElem.css( props );
- }
- }
-};
-
-jQuery.fn.extend( {
- offset: function( options ) {
-
- // Preserve chaining for setter
- if ( arguments.length ) {
- return options === undefined ?
- this :
- this.each( function( i ) {
- jQuery.offset.setOffset( this, options, i );
- } );
- }
-
- var doc, docElem, rect, win,
- elem = this[ 0 ];
-
- if ( !elem ) {
- return;
- }
-
- // Return zeros for disconnected and hidden (display: none) elements (gh-2310)
- // Support: IE <=11 only
- // Running getBoundingClientRect on a
- // disconnected node in IE throws an error
- if ( !elem.getClientRects().length ) {
- return { top: 0, left: 0 };
- }
-
- rect = elem.getBoundingClientRect();
-
- doc = elem.ownerDocument;
- docElem = doc.documentElement;
- win = doc.defaultView;
-
- return {
- top: rect.top + win.pageYOffset - docElem.clientTop,
- left: rect.left + win.pageXOffset - docElem.clientLeft
- };
- },
-
- position: function() {
- if ( !this[ 0 ] ) {
- return;
- }
-
- var offsetParent, offset,
- elem = this[ 0 ],
- parentOffset = { top: 0, left: 0 };
-
- // Fixed elements are offset from window (parentOffset = {top:0, left: 0},
- // because it is its only offset parent
- if ( jQuery.css( elem, "position" ) === "fixed" ) {
-
- // Assume getBoundingClientRect is there when computed position is fixed
- offset = elem.getBoundingClientRect();
-
- } else {
-
- // Get *real* offsetParent
- offsetParent = this.offsetParent();
-
- // Get correct offsets
- offset = this.offset();
- if ( !nodeName( offsetParent[ 0 ], "html" ) ) {
- parentOffset = offsetParent.offset();
- }
-
- // Add offsetParent borders
- parentOffset = {
- top: parentOffset.top + jQuery.css( offsetParent[ 0 ], "borderTopWidth", true ),
- left: parentOffset.left + jQuery.css( offsetParent[ 0 ], "borderLeftWidth", true )
- };
- }
-
- // Subtract parent offsets and element margins
- return {
- top: offset.top - parentOffset.top - jQuery.css( elem, "marginTop", true ),
- left: offset.left - parentOffset.left - jQuery.css( elem, "marginLeft", true )
- };
- },
-
- // This method will return documentElement in the following cases:
- // 1) For the element inside the iframe without offsetParent, this method will return
- // documentElement of the parent window
- // 2) For the hidden or detached element
- // 3) For body or html element, i.e. in case of the html node - it will return itself
- //
- // but those exceptions were never presented as a real life use-cases
- // and might be considered as more preferable results.
- //
- // This logic, however, is not guaranteed and can change at any point in the future
- offsetParent: function() {
- return this.map( function() {
- var offsetParent = this.offsetParent;
-
- while ( offsetParent && jQuery.css( offsetParent, "position" ) === "static" ) {
- offsetParent = offsetParent.offsetParent;
- }
-
- return offsetParent || documentElement;
- } );
- }
-} );
-
-// Create scrollLeft and scrollTop methods
-jQuery.each( { scrollLeft: "pageXOffset", scrollTop: "pageYOffset" }, function( method, prop ) {
- var top = "pageYOffset" === prop;
-
- jQuery.fn[ method ] = function( val ) {
- return access( this, function( elem, method, val ) {
-
- // Coalesce documents and windows
- var win;
- if ( jQuery.isWindow( elem ) ) {
- win = elem;
- } else if ( elem.nodeType === 9 ) {
- win = elem.defaultView;
- }
-
- if ( val === undefined ) {
- return win ? win[ prop ] : elem[ method ];
- }
-
- if ( win ) {
- win.scrollTo(
- !top ? val : win.pageXOffset,
- top ? val : win.pageYOffset
- );
-
- } else {
- elem[ method ] = val;
- }
- }, method, val, arguments.length );
- };
-} );
-
-// Support: Safari <=7 - 9.1, Chrome <=37 - 49
-// Add the top/left cssHooks using jQuery.fn.position
-// Webkit bug: https://bugs.webkit.org/show_bug.cgi?id=29084
-// Blink bug: https://bugs.chromium.org/p/chromium/issues/detail?id=589347
-// getComputedStyle returns percent when specified for top/left/bottom/right;
-// rather than make the css module depend on the offset module, just check for it here
-jQuery.each( [ "top", "left" ], function( i, prop ) {
- jQuery.cssHooks[ prop ] = addGetHookIf( support.pixelPosition,
- function( elem, computed ) {
- if ( computed ) {
- computed = curCSS( elem, prop );
-
- // If curCSS returns percentage, fallback to offset
- return rnumnonpx.test( computed ) ?
- jQuery( elem ).position()[ prop ] + "px" :
- computed;
- }
- }
- );
-} );
-
-
-// Create innerHeight, innerWidth, height, width, outerHeight and outerWidth methods
-jQuery.each( { Height: "height", Width: "width" }, function( name, type ) {
- jQuery.each( { padding: "inner" + name, content: type, "": "outer" + name },
- function( defaultExtra, funcName ) {
-
- // Margin is only for outerHeight, outerWidth
- jQuery.fn[ funcName ] = function( margin, value ) {
- var chainable = arguments.length && ( defaultExtra || typeof margin !== "boolean" ),
- extra = defaultExtra || ( margin === true || value === true ? "margin" : "border" );
-
- return access( this, function( elem, type, value ) {
- var doc;
-
- if ( jQuery.isWindow( elem ) ) {
-
- // $( window ).outerWidth/Height return w/h including scrollbars (gh-1729)
- return funcName.indexOf( "outer" ) === 0 ?
- elem[ "inner" + name ] :
- elem.document.documentElement[ "client" + name ];
- }
-
- // Get document width or height
- if ( elem.nodeType === 9 ) {
- doc = elem.documentElement;
-
- // Either scroll[Width/Height] or offset[Width/Height] or client[Width/Height],
- // whichever is greatest
- return Math.max(
- elem.body[ "scroll" + name ], doc[ "scroll" + name ],
- elem.body[ "offset" + name ], doc[ "offset" + name ],
- doc[ "client" + name ]
- );
- }
-
- return value === undefined ?
-
- // Get width or height on the element, requesting but not forcing parseFloat
- jQuery.css( elem, type, extra ) :
-
- // Set width or height on the element
- jQuery.style( elem, type, value, extra );
- }, type, chainable ? margin : undefined, chainable );
- };
- } );
-} );
-
-
-jQuery.fn.extend( {
-
- bind: function( types, data, fn ) {
- return this.on( types, null, data, fn );
- },
- unbind: function( types, fn ) {
- return this.off( types, null, fn );
- },
-
- delegate: function( selector, types, data, fn ) {
- return this.on( types, selector, data, fn );
- },
- undelegate: function( selector, types, fn ) {
-
- // ( namespace ) or ( selector, types [, fn] )
- return arguments.length === 1 ?
- this.off( selector, "**" ) :
- this.off( types, selector || "**", fn );
- }
-} );
-
-jQuery.holdReady = function( hold ) {
- if ( hold ) {
- jQuery.readyWait++;
- } else {
- jQuery.ready( true );
- }
-};
-jQuery.isArray = Array.isArray;
-jQuery.parseJSON = JSON.parse;
-jQuery.nodeName = nodeName;
-
-
-
-
-// Register as a named AMD module, since jQuery can be concatenated with other
-// files that may use define, but not via a proper concatenation script that
-// understands anonymous AMD modules. A named AMD is safest and most robust
-// way to register. Lowercase jquery is used because AMD module names are
-// derived from file names, and jQuery is normally delivered in a lowercase
-// file name. Do this after creating the global so that if an AMD module wants
-// to call noConflict to hide this version of jQuery, it will work.
-
-// Note that for maximum portability, libraries that are not jQuery should
-// declare themselves as anonymous modules, and avoid setting a global if an
-// AMD loader is present. jQuery is a special case. For more information, see
-// https://github.com/jrburke/requirejs/wiki/Updating-existing-libraries#wiki-anon
-
-if ( typeof define === "function" && define.amd ) {
- define( "jquery", [], function() {
- return jQuery;
- } );
-}
-
-
-
-
-var
-
- // Map over jQuery in case of overwrite
- _jQuery = window.jQuery,
-
- // Map over the $ in case of overwrite
- _$ = window.$;
-
-jQuery.noConflict = function( deep ) {
- if ( window.$ === jQuery ) {
- window.$ = _$;
- }
-
- if ( deep && window.jQuery === jQuery ) {
- window.jQuery = _jQuery;
- }
-
- return jQuery;
-};
-
-// Expose jQuery and $ identifiers, even in AMD
-// (#7102#comment:10, https://github.com/jquery/jquery/pull/557)
-// and CommonJS for browser emulators (#13566)
-if ( !noGlobal ) {
- window.jQuery = window.$ = jQuery;
-}
-
-
-
-
-return jQuery;
-} );
-/*! jQuery v3.2.1 | (c) JS Foundation and other contributors | jquery.org/license */
-!function(a,b){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=a.document?b(a,!0):function(a){if(!a.document)throw new Error("jQuery requires a window with a document");return b(a)}:b(a)}("undefined"!=typeof window?window:this,function(a,b){"use strict";var c=[],d=a.document,e=Object.getPrototypeOf,f=c.slice,g=c.concat,h=c.push,i=c.indexOf,j={},k=j.toString,l=j.hasOwnProperty,m=l.toString,n=m.call(Object),o={};function p(a,b){b=b||d;var c=b.createElement("script");c.text=a,b.head.appendChild(c).parentNode.removeChild(c)}var q="3.2.1",r=function(a,b){return new r.fn.init(a,b)},s=/^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g,t=/^-ms-/,u=/-([a-z])/g,v=function(a,b){return b.toUpperCase()};r.fn=r.prototype={jquery:q,constructor:r,length:0,toArray:function(){return f.call(this)},get:function(a){return null==a?f.call(this):a<0?this[a+this.length]:this[a]},pushStack:function(a){var b=r.merge(this.constructor(),a);return b.prevObject=this,b},each:function(a){return r.each(this,a)},map:function(a){return this.pushStack(r.map(this,function(b,c){return a.call(b,c,b)}))},slice:function(){return this.pushStack(f.apply(this,arguments))},first:function(){return this.eq(0)},last:function(){return this.eq(-1)},eq:function(a){var b=this.length,c=+a+(a<0?b:0);return this.pushStack(c>=0&&c<b?[this[c]]:[])},end:function(){return this.prevObject||this.constructor()},push:h,sort:c.sort,splice:c.splice},r.extend=r.fn.extend=function(){var a,b,c,d,e,f,g=arguments[0]||{},h=1,i=arguments.length,j=!1;for("boolean"==typeof g&&(j=g,g=arguments[h]||{},h++),"object"==typeof g||r.isFunction(g)||(g={}),h===i&&(g=this,h--);h<i;h++)if(null!=(a=arguments[h]))for(b in a)c=g[b],d=a[b],g!==d&&(j&&d&&(r.isPlainObject(d)||(e=Array.isArray(d)))?(e?(e=!1,f=c&&Array.isArray(c)?c:[]):f=c&&r.isPlainObject(c)?c:{},g[b]=r.extend(j,f,d)):void 0!==d&&(g[b]=d));return g},r.extend({expando:"jQuery"+(q+Math.random()).replace(/\D/g,""),isReady:!0,error:function(a){throw new Error(a)},noop:function(){},isFunction:function(a){return"function"===r.type(a)},isWindow:function(a){return null!=a&&a===a.window},isNumeric:function(a){var b=r.type(a);return("number"===b||"string"===b)&&!isNaN(a-parseFloat(a))},isPlainObject:function(a){var b,c;return!(!a||"[object Object]"!==k.call(a))&&(!(b=e(a))||(c=l.call(b,"constructor")&&b.constructor,"function"==typeof c&&m.call(c)===n))},isEmptyObject:function(a){var b;for(b in a)return!1;return!0},type:function(a){return null==a?a+"":"object"==typeof a||"function"==typeof a?j[k.call(a)]||"object":typeof a},globalEval:function(a){p(a)},camelCase:function(a){return a.replace(t,"ms-").replace(u,v)},each:function(a,b){var c,d=0;if(w(a)){for(c=a.length;d<c;d++)if(b.call(a[d],d,a[d])===!1)break}else for(d in a)if(b.call(a[d],d,a[d])===!1)break;return a},trim:function(a){return null==a?"":(a+"").replace(s,"")},makeArray:function(a,b){var c=b||[];return null!=a&&(w(Object(a))?r.merge(c,"string"==typeof a?[a]:a):h.call(c,a)),c},inArray:function(a,b,c){return null==b?-1:i.call(b,a,c)},merge:function(a,b){for(var c=+b.length,d=0,e=a.length;d<c;d++)a[e++]=b[d];return a.length=e,a},grep:function(a,b,c){for(var d,e=[],f=0,g=a.length,h=!c;f<g;f++)d=!b(a[f],f),d!==h&&e.push(a[f]);return e},map:function(a,b,c){var d,e,f=0,h=[];if(w(a))for(d=a.length;f<d;f++)e=b(a[f],f,c),null!=e&&h.push(e);else for(f in a)e=b(a[f],f,c),null!=e&&h.push(e);return g.apply([],h)},guid:1,proxy:function(a,b){var c,d,e;if("string"==typeof b&&(c=a[b],b=a,a=c),r.isFunction(a))return d=f.call(arguments,2),e=function(){return a.apply(b||this,d.concat(f.call(arguments)))},e.guid=a.guid=a.guid||r.guid++,e},now:Date.now,support:o}),"function"==typeof Symbol&&(r.fn[Symbol.iterator]=c[Symbol.iterator]),r.each("Boolean Number String Function Array Date RegExp Object Error Symbol".split(" "),function(a,b){j["[object "+b+"]"]=b.toLowerCase()});function w(a){var b=!!a&&"length"in a&&a.length,c=r.type(a);return"function"!==c&&!r.isWindow(a)&&("array"===c||0===b||"number"==typeof b&&b>0&&b-1 in a)}var x=function(a){var b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t,u="sizzle"+1*new Date,v=a.document,w=0,x=0,y=ha(),z=ha(),A=ha(),B=function(a,b){return a===b&&(l=!0),0},C={}.hasOwnProperty,D=[],E=D.pop,F=D.push,G=D.push,H=D.slice,I=function(a,b){for(var c=0,d=a.length;c<d;c++)if(a[c]===b)return c;return-1},J="checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|ismap|loop|multiple|open|readonly|required|scoped",K="[\\x20\\t\\r\\n\\f]",L="(?:\\\\.|[\\w-]|[^\0-\\xa0])+",M="\\["+K+"*("+L+")(?:"+K+"*([*^$|!~]?=)"+K+"*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|("+L+"))|)"+K+"*\\]",N=":("+L+")(?:\\((('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|((?:\\\\.|[^\\\\()[\\]]|"+M+")*)|.*)\\)|)",O=new RegExp(K+"+","g"),P=new RegExp("^"+K+"+|((?:^|[^\\\\])(?:\\\\.)*)"+K+"+$","g"),Q=new RegExp("^"+K+"*,"+K+"*"),R=new RegExp("^"+K+"*([>+~]|"+K+")"+K+"*"),S=new RegExp("="+K+"*([^\\]'\"]*?)"+K+"*\\]","g"),T=new RegExp(N),U=new RegExp("^"+L+"$"),V={ID:new RegExp("^#("+L+")"),CLASS:new RegExp("^\\.("+L+")"),TAG:new RegExp("^("+L+"|[*])"),ATTR:new RegExp("^"+M),PSEUDO:new RegExp("^"+N),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+K+"*(even|odd|(([+-]|)(\\d*)n|)"+K+"*(?:([+-]|)"+K+"*(\\d+)|))"+K+"*\\)|)","i"),bool:new RegExp("^(?:"+J+")$","i"),needsContext:new RegExp("^"+K+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+K+"*((?:-\\d)?\\d*)"+K+"*\\)|)(?=[^-]|$)","i")},W=/^(?:input|select|textarea|button)$/i,X=/^h\d$/i,Y=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,$=/[+~]/,_=new RegExp("\\\\([\\da-f]{1,6}"+K+"?|("+K+")|.)","ig"),aa=function(a,b,c){var d="0x"+b-65536;return d!==d||c?b:d<0?String.fromCharCode(d+65536):String.fromCharCode(d>>10|55296,1023&d|56320)},ba=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ca=function(a,b){return b?"\0"===a?"\ufffd":a.slice(0,-1)+"\\"+a.charCodeAt(a.length-1).toString(16)+" ":"\\"+a},da=function(){m()},ea=ta(function(a){return a.disabled===!0&&("form"in a||"label"in a)},{dir:"parentNode",next:"legend"});try{G.apply(D=H.call(v.childNodes),v.childNodes),D[v.childNodes.length].nodeType}catch(fa){G={apply:D.length?function(a,b){F.apply(a,H.call(b))}:function(a,b){var c=a.length,d=0;while(a[c++]=b[d++]);a.length=c-1}}}function ga(a,b,d,e){var f,h,j,k,l,o,r,s=b&&b.ownerDocument,w=b?b.nodeType:9;if(d=d||[],"string"!=typeof a||!a||1!==w&&9!==w&&11!==w)return d;if(!e&&((b?b.ownerDocument||b:v)!==n&&m(b),b=b||n,p)){if(11!==w&&(l=Z.exec(a)))if(f=l[1]){if(9===w){if(!(j=b.getElementById(f)))return d;if(j.id===f)return d.push(j),d}else if(s&&(j=s.getElementById(f))&&t(b,j)&&j.id===f)return d.push(j),d}else{if(l[2])return G.apply(d,b.getElementsByTagName(a)),d;if((f=l[3])&&c.getElementsByClassName&&b.getElementsByClassName)return G.apply(d,b.getElementsByClassName(f)),d}if(c.qsa&&!A[a+" "]&&(!q||!q.test(a))){if(1!==w)s=b,r=a;else if("object"!==b.nodeName.toLowerCase()){(k=b.getAttribute("id"))?k=k.replace(ba,ca):b.setAttribute("id",k=u),o=g(a),h=o.length;while(h--)o[h]="#"+k+" "+sa(o[h]);r=o.join(","),s=$.test(a)&&qa(b.parentNode)||b}if(r)try{return G.apply(d,s.querySelectorAll(r)),d}catch(x){}finally{k===u&&b.removeAttribute("id")}}}return i(a.replace(P,"$1"),b,d,e)}function ha(){var a=[];function b(c,e){return a.push(c+" ")>d.cacheLength&&delete b[a.shift()],b[c+" "]=e}return b}function ia(a){return a[u]=!0,a}function ja(a){var b=n.createElement("fieldset");try{return!!a(b)}catch(c){return!1}finally{b.parentNode&&b.parentNode.removeChild(b),b=null}}function ka(a,b){var c=a.split("|"),e=c.length;while(e--)d.attrHandle[c[e]]=b}function la(a,b){var c=b&&a,d=c&&1===a.nodeType&&1===b.nodeType&&a.sourceIndex-b.sourceIndex;if(d)return d;if(c)while(c=c.nextSibling)if(c===b)return-1;return a?1:-1}function ma(a){return function(b){var c=b.nodeName.toLowerCase();return"input"===c&&b.type===a}}function na(a){return function(b){var c=b.nodeName.toLowerCase();return("input"===c||"button"===c)&&b.type===a}}function oa(a){return function(b){return"form"in b?b.parentNode&&b.disabled===!1?"label"in b?"label"in b.parentNode?b.parentNode.disabled===a:b.disabled===a:b.isDisabled===a||b.isDisabled!==!a&&ea(b)===a:b.disabled===a:"label"in b&&b.disabled===a}}function pa(a){return ia(function(b){return b=+b,ia(function(c,d){var e,f=a([],c.length,b),g=f.length;while(g--)c[e=f[g]]&&(c[e]=!(d[e]=c[e]))})})}function qa(a){return a&&"undefined"!=typeof a.getElementsByTagName&&a}c=ga.support={},f=ga.isXML=function(a){var b=a&&(a.ownerDocument||a).documentElement;return!!b&&"HTML"!==b.nodeName},m=ga.setDocument=function(a){var b,e,g=a?a.ownerDocument||a:v;return g!==n&&9===g.nodeType&&g.documentElement?(n=g,o=n.documentElement,p=!f(n),v!==n&&(e=n.defaultView)&&e.top!==e&&(e.addEventListener?e.addEventListener("unload",da,!1):e.attachEvent&&e.attachEvent("onunload",da)),c.attributes=ja(function(a){return a.className="i",!a.getAttribute("className")}),c.getElementsByTagName=ja(function(a){return a.appendChild(n.createComment("")),!a.getElementsByTagName("*").length}),c.getElementsByClassName=Y.test(n.getElementsByClassName),c.getById=ja(function(a){return o.appendChild(a).id=u,!n.getElementsByName||!n.getElementsByName(u).length}),c.getById?(d.filter.ID=function(a){var b=a.replace(_,aa);return function(a){return a.getAttribute("id")===b}},d.find.ID=function(a,b){if("undefined"!=typeof b.getElementById&&p){var c=b.getElementById(a);return c?[c]:[]}}):(d.filter.ID=function(a){var b=a.replace(_,aa);return function(a){var c="undefined"!=typeof a.getAttributeNode&&a.getAttributeNode("id");return c&&c.value===b}},d.find.ID=function(a,b){if("undefined"!=typeof b.getElementById&&p){var c,d,e,f=b.getElementById(a);if(f){if(c=f.getAttributeNode("id"),c&&c.value===a)return[f];e=b.getElementsByName(a),d=0;while(f=e[d++])if(c=f.getAttributeNode("id"),c&&c.value===a)return[f]}return[]}}),d.find.TAG=c.getElementsByTagName?function(a,b){return"undefined"!=typeof b.getElementsByTagName?b.getElementsByTagName(a):c.qsa?b.querySelectorAll(a):void 0}:function(a,b){var c,d=[],e=0,f=b.getElementsByTagName(a);if("*"===a){while(c=f[e++])1===c.nodeType&&d.push(c);return d}return f},d.find.CLASS=c.getElementsByClassName&&function(a,b){if("undefined"!=typeof b.getElementsByClassName&&p)return b.getElementsByClassName(a)},r=[],q=[],(c.qsa=Y.test(n.querySelectorAll))&&(ja(function(a){o.appendChild(a).innerHTML="<a id='"+u+"'></a><select id='"+u+"-\r\\' msallowcapture=''><option selected=''></option></select>",a.querySelectorAll("[msallowcapture^='']").length&&q.push("[*^$]="+K+"*(?:''|\"\")"),a.querySelectorAll("[selected]").length||q.push("\\["+K+"*(?:value|"+J+")"),a.querySelectorAll("[id~="+u+"-]").length||q.push("~="),a.querySelectorAll(":checked").length||q.push(":checked"),a.querySelectorAll("a#"+u+"+*").length||q.push(".#.+[+~]")}),ja(function(a){a.innerHTML="<a href='' disabled='disabled'></a><select disabled='disabled'><option/></select>";var b=n.createElement("input");b.setAttribute("type","hidden"),a.appendChild(b).setAttribute("name","D"),a.querySelectorAll("[name=d]").length&&q.push("name"+K+"*[*^$|!~]?="),2!==a.querySelectorAll(":enabled").length&&q.push(":enabled",":disabled"),o.appendChild(a).disabled=!0,2!==a.querySelectorAll(":disabled").length&&q.push(":enabled",":disabled"),a.querySelectorAll("*,:x"),q.push(",.*:")})),(c.matchesSelector=Y.test(s=o.matches||o.webkitMatchesSelector||o.mozMatchesSelector||o.oMatchesSelector||o.msMatchesSelector))&&ja(function(a){c.disconnectedMatch=s.call(a,"*"),s.call(a,"[s!='']:x"),r.push("!=",N)}),q=q.length&&new RegExp(q.join("|")),r=r.length&&new RegExp(r.join("|")),b=Y.test(o.compareDocumentPosition),t=b||Y.test(o.contains)?function(a,b){var c=9===a.nodeType?a.documentElement:a,d=b&&b.parentNode;return a===d||!(!d||1!==d.nodeType||!(c.contains?c.contains(d):a.compareDocumentPosition&&16&a.compareDocumentPosition(d)))}:function(a,b){if(b)while(b=b.parentNode)if(b===a)return!0;return!1},B=b?function(a,b){if(a===b)return l=!0,0;var d=!a.compareDocumentPosition-!b.compareDocumentPosition;return d?d:(d=(a.ownerDocument||a)===(b.ownerDocument||b)?a.compareDocumentPosition(b):1,1&d||!c.sortDetached&&b.compareDocumentPosition(a)===d?a===n||a.ownerDocument===v&&t(v,a)?-1:b===n||b.ownerDocument===v&&t(v,b)?1:k?I(k,a)-I(k,b):0:4&d?-1:1)}:function(a,b){if(a===b)return l=!0,0;var c,d=0,e=a.parentNode,f=b.parentNode,g=[a],h=[b];if(!e||!f)return a===n?-1:b===n?1:e?-1:f?1:k?I(k,a)-I(k,b):0;if(e===f)return la(a,b);c=a;while(c=c.parentNode)g.unshift(c);c=b;while(c=c.parentNode)h.unshift(c);while(g[d]===h[d])d++;return d?la(g[d],h[d]):g[d]===v?-1:h[d]===v?1:0},n):n},ga.matches=function(a,b){return ga(a,null,null,b)},ga.matchesSelector=function(a,b){if((a.ownerDocument||a)!==n&&m(a),b=b.replace(S,"='$1']"),c.matchesSelector&&p&&!A[b+" "]&&(!r||!r.test(b))&&(!q||!q.test(b)))try{var d=s.call(a,b);if(d||c.disconnectedMatch||a.document&&11!==a.document.nodeType)return d}catch(e){}return ga(b,n,null,[a]).length>0},ga.contains=function(a,b){return(a.ownerDocument||a)!==n&&m(a),t(a,b)},ga.attr=function(a,b){(a.ownerDocument||a)!==n&&m(a);var e=d.attrHandle[b.toLowerCase()],f=e&&C.call(d.attrHandle,b.toLowerCase())?e(a,b,!p):void 0;return void 0!==f?f:c.attributes||!p?a.getAttribute(b):(f=a.getAttributeNode(b))&&f.specified?f.value:null},ga.escape=function(a){return(a+"").replace(ba,ca)},ga.error=function(a){throw new Error("Syntax error, unrecognized expression: "+a)},ga.uniqueSort=function(a){var b,d=[],e=0,f=0;if(l=!c.detectDuplicates,k=!c.sortStable&&a.slice(0),a.sort(B),l){while(b=a[f++])b===a[f]&&(e=d.push(f));while(e--)a.splice(d[e],1)}return k=null,a},e=ga.getText=function(a){var b,c="",d=0,f=a.nodeType;if(f){if(1===f||9===f||11===f){if("string"==typeof a.textContent)return a.textContent;for(a=a.firstChild;a;a=a.nextSibling)c+=e(a)}else if(3===f||4===f)return a.nodeValue}else while(b=a[d++])c+=e(b);return c},d=ga.selectors={cacheLength:50,createPseudo:ia,match:V,attrHandle:{},find:{},relative:{">":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(a){return a[1]=a[1].replace(_,aa),a[3]=(a[3]||a[4]||a[5]||"").replace(_,aa),"~="===a[2]&&(a[3]=" "+a[3]+" "),a.slice(0,4)},CHILD:function(a){return a[1]=a[1].toLowerCase(),"nth"===a[1].slice(0,3)?(a[3]||ga.error(a[0]),a[4]=+(a[4]?a[5]+(a[6]||1):2*("even"===a[3]||"odd"===a[3])),a[5]=+(a[7]+a[8]||"odd"===a[3])):a[3]&&ga.error(a[0]),a},PSEUDO:function(a){var b,c=!a[6]&&a[2];return V.CHILD.test(a[0])?null:(a[3]?a[2]=a[4]||a[5]||"":c&&T.test(c)&&(b=g(c,!0))&&(b=c.indexOf(")",c.length-b)-c.length)&&(a[0]=a[0].slice(0,b),a[2]=c.slice(0,b)),a.slice(0,3))}},filter:{TAG:function(a){var b=a.replace(_,aa).toLowerCase();return"*"===a?function(){return!0}:function(a){return a.nodeName&&a.nodeName.toLowerCase()===b}},CLASS:function(a){var b=y[a+" "];return b||(b=new RegExp("(^|"+K+")"+a+"("+K+"|$)"))&&y(a,function(a){return b.test("string"==typeof a.className&&a.className||"undefined"!=typeof a.getAttribute&&a.getAttribute("class")||"")})},ATTR:function(a,b,c){return function(d){var e=ga.attr(d,a);return null==e?"!="===b:!b||(e+="","="===b?e===c:"!="===b?e!==c:"^="===b?c&&0===e.indexOf(c):"*="===b?c&&e.indexOf(c)>-1:"$="===b?c&&e.slice(-c.length)===c:"~="===b?(" "+e.replace(O," ")+" ").indexOf(c)>-1:"|="===b&&(e===c||e.slice(0,c.length+1)===c+"-"))}},CHILD:function(a,b,c,d,e){var f="nth"!==a.slice(0,3),g="last"!==a.slice(-4),h="of-type"===b;return 1===d&&0===e?function(a){return!!a.parentNode}:function(b,c,i){var j,k,l,m,n,o,p=f!==g?"nextSibling":"previousSibling",q=b.parentNode,r=h&&b.nodeName.toLowerCase(),s=!i&&!h,t=!1;if(q){if(f){while(p){m=b;while(m=m[p])if(h?m.nodeName.toLowerCase()===r:1===m.nodeType)return!1;o=p="only"===a&&!o&&"nextSibling"}return!0}if(o=[g?q.firstChild:q.lastChild],g&&s){m=q,l=m[u]||(m[u]={}),k=l[m.uniqueID]||(l[m.uniqueID]={}),j=k[a]||[],n=j[0]===w&&j[1],t=n&&j[2],m=n&&q.childNodes[n];while(m=++n&&m&&m[p]||(t=n=0)||o.pop())if(1===m.nodeType&&++t&&m===b){k[a]=[w,n,t];break}}else if(s&&(m=b,l=m[u]||(m[u]={}),k=l[m.uniqueID]||(l[m.uniqueID]={}),j=k[a]||[],n=j[0]===w&&j[1],t=n),t===!1)while(m=++n&&m&&m[p]||(t=n=0)||o.pop())if((h?m.nodeName.toLowerCase()===r:1===m.nodeType)&&++t&&(s&&(l=m[u]||(m[u]={}),k=l[m.uniqueID]||(l[m.uniqueID]={}),k[a]=[w,t]),m===b))break;return t-=e,t===d||t%d===0&&t/d>=0}}},PSEUDO:function(a,b){var c,e=d.pseudos[a]||d.setFilters[a.toLowerCase()]||ga.error("unsupported pseudo: "+a);return e[u]?e(b):e.length>1?(c=[a,a,"",b],d.setFilters.hasOwnProperty(a.toLowerCase())?ia(function(a,c){var d,f=e(a,b),g=f.length;while(g--)d=I(a,f[g]),a[d]=!(c[d]=f[g])}):function(a){return e(a,0,c)}):e}},pseudos:{not:ia(function(a){var b=[],c=[],d=h(a.replace(P,"$1"));return d[u]?ia(function(a,b,c,e){var f,g=d(a,null,e,[]),h=a.length;while(h--)(f=g[h])&&(a[h]=!(b[h]=f))}):function(a,e,f){return b[0]=a,d(b,null,f,c),b[0]=null,!c.pop()}}),has:ia(function(a){return function(b){return ga(a,b).length>0}}),contains:ia(function(a){return a=a.replace(_,aa),function(b){return(b.textContent||b.innerText||e(b)).indexOf(a)>-1}}),lang:ia(function(a){return U.test(a||"")||ga.error("unsupported lang: "+a),a=a.replace(_,aa).toLowerCase(),function(b){var c;do if(c=p?b.lang:b.getAttribute("xml:lang")||b.getAttribute("lang"))return c=c.toLowerCase(),c===a||0===c.indexOf(a+"-");while((b=b.parentNode)&&1===b.nodeType);return!1}}),target:function(b){var c=a.location&&a.location.hash;return c&&c.slice(1)===b.id},root:function(a){return a===o},focus:function(a){return a===n.activeElement&&(!n.hasFocus||n.hasFocus())&&!!(a.type||a.href||~a.tabIndex)},enabled:oa(!1),disabled:oa(!0),checked:function(a){var b=a.nodeName.toLowerCase();return"input"===b&&!!a.checked||"option"===b&&!!a.selected},selected:function(a){return a.parentNode&&a.parentNode.selectedIndex,a.selected===!0},empty:function(a){for(a=a.firstChild;a;a=a.nextSibling)if(a.nodeType<6)return!1;return!0},parent:function(a){return!d.pseudos.empty(a)},header:function(a){return X.test(a.nodeName)},input:function(a){return W.test(a.nodeName)},button:function(a){var b=a.nodeName.toLowerCase();return"input"===b&&"button"===a.type||"button"===b},text:function(a){var b;return"input"===a.nodeName.toLowerCase()&&"text"===a.type&&(null==(b=a.getAttribute("type"))||"text"===b.toLowerCase())},first:pa(function(){return[0]}),last:pa(function(a,b){return[b-1]}),eq:pa(function(a,b,c){return[c<0?c+b:c]}),even:pa(function(a,b){for(var c=0;c<b;c+=2)a.push(c);return a}),odd:pa(function(a,b){for(var c=1;c<b;c+=2)a.push(c);return a}),lt:pa(function(a,b,c){for(var d=c<0?c+b:c;--d>=0;)a.push(d);return a}),gt:pa(function(a,b,c){for(var d=c<0?c+b:c;++d<b;)a.push(d);return a})}},d.pseudos.nth=d.pseudos.eq;for(b in{radio:!0,checkbox:!0,file:!0,password:!0,image:!0})d.pseudos[b]=ma(b);for(b in{submit:!0,reset:!0})d.pseudos[b]=na(b);function ra(){}ra.prototype=d.filters=d.pseudos,d.setFilters=new ra,g=ga.tokenize=function(a,b){var c,e,f,g,h,i,j,k=z[a+" "];if(k)return b?0:k.slice(0);h=a,i=[],j=d.preFilter;while(h){c&&!(e=Q.exec(h))||(e&&(h=h.slice(e[0].length)||h),i.push(f=[])),c=!1,(e=R.exec(h))&&(c=e.shift(),f.push({value:c,type:e[0].replace(P," ")}),h=h.slice(c.length));for(g in d.filter)!(e=V[g].exec(h))||j[g]&&!(e=j[g](e))||(c=e.shift(),f.push({value:c,type:g,matches:e}),h=h.slice(c.length));if(!c)break}return b?h.length:h?ga.error(a):z(a,i).slice(0)};function sa(a){for(var b=0,c=a.length,d="";b<c;b++)d+=a[b].value;return d}function ta(a,b,c){var d=b.dir,e=b.next,f=e||d,g=c&&"parentNode"===f,h=x++;return b.first?function(b,c,e){while(b=b[d])if(1===b.nodeType||g)return a(b,c,e);return!1}:function(b,c,i){var j,k,l,m=[w,h];if(i){while(b=b[d])if((1===b.nodeType||g)&&a(b,c,i))return!0}else while(b=b[d])if(1===b.nodeType||g)if(l=b[u]||(b[u]={}),k=l[b.uniqueID]||(l[b.uniqueID]={}),e&&e===b.nodeName.toLowerCase())b=b[d]||b;else{if((j=k[f])&&j[0]===w&&j[1]===h)return m[2]=j[2];if(k[f]=m,m[2]=a(b,c,i))return!0}return!1}}function ua(a){return a.length>1?function(b,c,d){var e=a.length;while(e--)if(!a[e](b,c,d))return!1;return!0}:a[0]}function va(a,b,c){for(var d=0,e=b.length;d<e;d++)ga(a,b[d],c);return c}function wa(a,b,c,d,e){for(var f,g=[],h=0,i=a.length,j=null!=b;h<i;h++)(f=a[h])&&(c&&!c(f,d,e)||(g.push(f),j&&b.push(h)));return g}function xa(a,b,c,d,e,f){return d&&!d[u]&&(d=xa(d)),e&&!e[u]&&(e=xa(e,f)),ia(function(f,g,h,i){var j,k,l,m=[],n=[],o=g.length,p=f||va(b||"*",h.nodeType?[h]:h,[]),q=!a||!f&&b?p:wa(p,m,a,h,i),r=c?e||(f?a:o||d)?[]:g:q;if(c&&c(q,r,h,i),d){j=wa(r,n),d(j,[],h,i),k=j.length;while(k--)(l=j[k])&&(r[n[k]]=!(q[n[k]]=l))}if(f){if(e||a){if(e){j=[],k=r.length;while(k--)(l=r[k])&&j.push(q[k]=l);e(null,r=[],j,i)}k=r.length;while(k--)(l=r[k])&&(j=e?I(f,l):m[k])>-1&&(f[j]=!(g[j]=l))}}else r=wa(r===g?r.splice(o,r.length):r),e?e(null,g,r,i):G.apply(g,r)})}function ya(a){for(var b,c,e,f=a.length,g=d.relative[a[0].type],h=g||d.relative[" "],i=g?1:0,k=ta(function(a){return a===b},h,!0),l=ta(function(a){return I(b,a)>-1},h,!0),m=[function(a,c,d){var e=!g&&(d||c!==j)||((b=c).nodeType?k(a,c,d):l(a,c,d));return b=null,e}];i<f;i++)if(c=d.relative[a[i].type])m=[ta(ua(m),c)];else{if(c=d.filter[a[i].type].apply(null,a[i].matches),c[u]){for(e=++i;e<f;e++)if(d.relative[a[e].type])break;return xa(i>1&&ua(m),i>1&&sa(a.slice(0,i-1).concat({value:" "===a[i-2].type?"*":""})).replace(P,"$1"),c,i<e&&ya(a.slice(i,e)),e<f&&ya(a=a.slice(e)),e<f&&sa(a))}m.push(c)}return ua(m)}function za(a,b){var c=b.length>0,e=a.length>0,f=function(f,g,h,i,k){var l,o,q,r=0,s="0",t=f&&[],u=[],v=j,x=f||e&&d.find.TAG("*",k),y=w+=null==v?1:Math.random()||.1,z=x.length;for(k&&(j=g===n||g||k);s!==z&&null!=(l=x[s]);s++){if(e&&l){o=0,g||l.ownerDocument===n||(m(l),h=!p);while(q=a[o++])if(q(l,g||n,h)){i.push(l);break}k&&(w=y)}c&&((l=!q&&l)&&r--,f&&t.push(l))}if(r+=s,c&&s!==r){o=0;while(q=b[o++])q(t,u,g,h);if(f){if(r>0)while(s--)t[s]||u[s]||(u[s]=E.call(i));u=wa(u)}G.apply(i,u),k&&!f&&u.length>0&&r+b.length>1&&ga.uniqueSort(i)}return k&&(w=y,j=v),t};return c?ia(f):f}return h=ga.compile=function(a,b){var c,d=[],e=[],f=A[a+" "];if(!f){b||(b=g(a)),c=b.length;while(c--)f=ya(b[c]),f[u]?d.push(f):e.push(f);f=A(a,za(e,d)),f.selector=a}return f},i=ga.select=function(a,b,c,e){var f,i,j,k,l,m="function"==typeof a&&a,n=!e&&g(a=m.selector||a);if(c=c||[],1===n.length){if(i=n[0]=n[0].slice(0),i.length>2&&"ID"===(j=i[0]).type&&9===b.nodeType&&p&&d.relative[i[1].type]){if(b=(d.find.ID(j.matches[0].replace(_,aa),b)||[])[0],!b)return c;m&&(b=b.parentNode),a=a.slice(i.shift().value.length)}f=V.needsContext.test(a)?0:i.length;while(f--){if(j=i[f],d.relative[k=j.type])break;if((l=d.find[k])&&(e=l(j.matches[0].replace(_,aa),$.test(i[0].type)&&qa(b.parentNode)||b))){if(i.splice(f,1),a=e.length&&sa(i),!a)return G.apply(c,e),c;break}}}return(m||h(a,n))(e,b,!p,c,!b||$.test(a)&&qa(b.parentNode)||b),c},c.sortStable=u.split("").sort(B).join("")===u,c.detectDuplicates=!!l,m(),c.sortDetached=ja(function(a){return 1&a.compareDocumentPosition(n.createElement("fieldset"))}),ja(function(a){return a.innerHTML="<a href='#'></a>","#"===a.firstChild.getAttribute("href")})||ka("type|href|height|width",function(a,b,c){if(!c)return a.getAttribute(b,"type"===b.toLowerCase()?1:2)}),c.attributes&&ja(function(a){return a.innerHTML="<input/>",a.firstChild.setAttribute("value",""),""===a.firstChild.getAttribute("value")})||ka("value",function(a,b,c){if(!c&&"input"===a.nodeName.toLowerCase())return a.defaultValue}),ja(function(a){return null==a.getAttribute("disabled")})||ka(J,function(a,b,c){var d;if(!c)return a[b]===!0?b.toLowerCase():(d=a.getAttributeNode(b))&&d.specified?d.value:null}),ga}(a);r.find=x,r.expr=x.selectors,r.expr[":"]=r.expr.pseudos,r.uniqueSort=r.unique=x.uniqueSort,r.text=x.getText,r.isXMLDoc=x.isXML,r.contains=x.contains,r.escapeSelector=x.escape;var y=function(a,b,c){var d=[],e=void 0!==c;while((a=a[b])&&9!==a.nodeType)if(1===a.nodeType){if(e&&r(a).is(c))break;d.push(a)}return d},z=function(a,b){for(var c=[];a;a=a.nextSibling)1===a.nodeType&&a!==b&&c.push(a);return c},A=r.expr.match.needsContext;function B(a,b){return a.nodeName&&a.nodeName.toLowerCase()===b.toLowerCase()}var C=/^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i,D=/^.[^:#\[\.,]*$/;function E(a,b,c){return r.isFunction(b)?r.grep(a,function(a,d){return!!b.call(a,d,a)!==c}):b.nodeType?r.grep(a,function(a){return a===b!==c}):"string"!=typeof b?r.grep(a,function(a){return i.call(b,a)>-1!==c}):D.test(b)?r.filter(b,a,c):(b=r.filter(b,a),r.grep(a,function(a){return i.call(b,a)>-1!==c&&1===a.nodeType}))}r.filter=function(a,b,c){var d=b[0];return c&&(a=":not("+a+")"),1===b.length&&1===d.nodeType?r.find.matchesSelector(d,a)?[d]:[]:r.find.matches(a,r.grep(b,function(a){return 1===a.nodeType}))},r.fn.extend({find:function(a){var b,c,d=this.length,e=this;if("string"!=typeof a)return this.pushStack(r(a).filter(function(){for(b=0;b<d;b++)if(r.contains(e[b],this))return!0}));for(c=this.pushStack([]),b=0;b<d;b++)r.find(a,e[b],c);return d>1?r.uniqueSort(c):c},filter:function(a){return this.pushStack(E(this,a||[],!1))},not:function(a){return this.pushStack(E(this,a||[],!0))},is:function(a){return!!E(this,"string"==typeof a&&A.test(a)?r(a):a||[],!1).length}});var F,G=/^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/,H=r.fn.init=function(a,b,c){var e,f;if(!a)return this;if(c=c||F,"string"==typeof a){if(e="<"===a[0]&&">"===a[a.length-1]&&a.length>=3?[null,a,null]:G.exec(a),!e||!e[1]&&b)return!b||b.jquery?(b||c).find(a):this.constructor(b).find(a);if(e[1]){if(b=b instanceof r?b[0]:b,r.merge(this,r.parseHTML(e[1],b&&b.nodeType?b.ownerDocument||b:d,!0)),C.test(e[1])&&r.isPlainObject(b))for(e in b)r.isFunction(this[e])?this[e](b[e]):this.attr(e,b[e]);return this}return f=d.getElementById(e[2]),f&&(this[0]=f,this.length=1),this}return a.nodeType?(this[0]=a,this.length=1,this):r.isFunction(a)?void 0!==c.ready?c.ready(a):a(r):r.makeArray(a,this)};H.prototype=r.fn,F=r(d);var I=/^(?:parents|prev(?:Until|All))/,J={children:!0,contents:!0,next:!0,prev:!0};r.fn.extend({has:function(a){var b=r(a,this),c=b.length;return this.filter(function(){for(var a=0;a<c;a++)if(r.contains(this,b[a]))return!0})},closest:function(a,b){var c,d=0,e=this.length,f=[],g="string"!=typeof a&&r(a);if(!A.test(a))for(;d<e;d++)for(c=this[d];c&&c!==b;c=c.parentNode)if(c.nodeType<11&&(g?g.index(c)>-1:1===c.nodeType&&r.find.matchesSelector(c,a))){f.push(c);break}return this.pushStack(f.length>1?r.uniqueSort(f):f)},index:function(a){return a?"string"==typeof a?i.call(r(a),this[0]):i.call(this,a.jquery?a[0]:a):this[0]&&this[0].parentNode?this.first().prevAll().length:-1},add:function(a,b){return this.pushStack(r.uniqueSort(r.merge(this.get(),r(a,b))))},addBack:function(a){return this.add(null==a?this.prevObject:this.prevObject.filter(a))}});function K(a,b){while((a=a[b])&&1!==a.nodeType);return a}r.each({parent:function(a){var b=a.parentNode;return b&&11!==b.nodeType?b:null},parents:function(a){return y(a,"parentNode")},parentsUntil:function(a,b,c){return y(a,"parentNode",c)},next:function(a){return K(a,"nextSibling")},prev:function(a){return K(a,"previousSibling")},nextAll:function(a){return y(a,"nextSibling")},prevAll:function(a){return y(a,"previousSibling")},nextUntil:function(a,b,c){return y(a,"nextSibling",c)},prevUntil:function(a,b,c){return y(a,"previousSibling",c)},siblings:function(a){return z((a.parentNode||{}).firstChild,a)},children:function(a){return z(a.firstChild)},contents:function(a){return B(a,"iframe")?a.contentDocument:(B(a,"template")&&(a=a.content||a),r.merge([],a.childNodes))}},function(a,b){r.fn[a]=function(c,d){var e=r.map(this,b,c);return"Until"!==a.slice(-5)&&(d=c),d&&"string"==typeof d&&(e=r.filter(d,e)),this.length>1&&(J[a]||r.uniqueSort(e),I.test(a)&&e.reverse()),this.pushStack(e)}});var L=/[^\x20\t\r\n\f]+/g;function M(a){var b={};return r.each(a.match(L)||[],function(a,c){b[c]=!0}),b}r.Callbacks=function(a){a="string"==typeof a?M(a):r.extend({},a);var b,c,d,e,f=[],g=[],h=-1,i=function(){for(e=e||a.once,d=b=!0;g.length;h=-1){c=g.shift();while(++h<f.length)f[h].apply(c[0],c[1])===!1&&a.stopOnFalse&&(h=f.length,c=!1)}a.memory||(c=!1),b=!1,e&&(f=c?[]:"")},j={add:function(){return f&&(c&&!b&&(h=f.length-1,g.push(c)),function d(b){r.each(b,function(b,c){r.isFunction(c)?a.unique&&j.has(c)||f.push(c):c&&c.length&&"string"!==r.type(c)&&d(c)})}(arguments),c&&!b&&i()),this},remove:function(){return r.each(arguments,function(a,b){var c;while((c=r.inArray(b,f,c))>-1)f.splice(c,1),c<=h&&h--}),this},has:function(a){return a?r.inArray(a,f)>-1:f.length>0},empty:function(){return f&&(f=[]),this},disable:function(){return e=g=[],f=c="",this},disabled:function(){return!f},lock:function(){return e=g=[],c||b||(f=c=""),this},locked:function(){return!!e},fireWith:function(a,c){return e||(c=c||[],c=[a,c.slice?c.slice():c],g.push(c),b||i()),this},fire:function(){return j.fireWith(this,arguments),this},fired:function(){return!!d}};return j};function N(a){return a}function O(a){throw a}function P(a,b,c,d){var e;try{a&&r.isFunction(e=a.promise)?e.call(a).done(b).fail(c):a&&r.isFunction(e=a.then)?e.call(a,b,c):b.apply(void 0,[a].slice(d))}catch(a){c.apply(void 0,[a])}}r.extend({Deferred:function(b){var c=[["notify","progress",r.Callbacks("memory"),r.Callbacks("memory"),2],["resolve","done",r.Callbacks("once memory"),r.Callbacks("once memory"),0,"resolved"],["reject","fail",r.Callbacks("once memory"),r.Callbacks("once memory"),1,"rejected"]],d="pending",e={state:function(){return d},always:function(){return f.done(arguments).fail(arguments),this},"catch":function(a){return e.then(null,a)},pipe:function(){var a=arguments;return r.Deferred(function(b){r.each(c,function(c,d){var e=r.isFunction(a[d[4]])&&a[d[4]];f[d[1]](function(){var a=e&&e.apply(this,arguments);a&&r.isFunction(a.promise)?a.promise().progress(b.notify).done(b.resolve).fail(b.reject):b[d[0]+"With"](this,e?[a]:arguments)})}),a=null}).promise()},then:function(b,d,e){var f=0;function g(b,c,d,e){return function(){var h=this,i=arguments,j=function(){var a,j;if(!(b<f)){if(a=d.apply(h,i),a===c.promise())throw new TypeError("Thenable self-resolution");j=a&&("object"==typeof a||"function"==typeof a)&&a.then,r.isFunction(j)?e?j.call(a,g(f,c,N,e),g(f,c,O,e)):(f++,j.call(a,g(f,c,N,e),g(f,c,O,e),g(f,c,N,c.notifyWith))):(d!==N&&(h=void 0,i=[a]),(e||c.resolveWith)(h,i))}},k=e?j:function(){try{j()}catch(a){r.Deferred.exceptionHook&&r.Deferred.exceptionHook(a,k.stackTrace),b+1>=f&&(d!==O&&(h=void 0,i=[a]),c.rejectWith(h,i))}};b?k():(r.Deferred.getStackHook&&(k.stackTrace=r.Deferred.getStackHook()),a.setTimeout(k))}}return r.Deferred(function(a){c[0][3].add(g(0,a,r.isFunction(e)?e:N,a.notifyWith)),c[1][3].add(g(0,a,r.isFunction(b)?b:N)),c[2][3].add(g(0,a,r.isFunction(d)?d:O))}).promise()},promise:function(a){return null!=a?r.extend(a,e):e}},f={};return r.each(c,function(a,b){var g=b[2],h=b[5];e[b[1]]=g.add,h&&g.add(function(){d=h},c[3-a][2].disable,c[0][2].lock),g.add(b[3].fire),f[b[0]]=function(){return f[b[0]+"With"](this===f?void 0:this,arguments),this},f[b[0]+"With"]=g.fireWith}),e.promise(f),b&&b.call(f,f),f},when:function(a){var b=arguments.length,c=b,d=Array(c),e=f.call(arguments),g=r.Deferred(),h=function(a){return function(c){d[a]=this,e[a]=arguments.length>1?f.call(arguments):c,--b||g.resolveWith(d,e)}};if(b<=1&&(P(a,g.done(h(c)).resolve,g.reject,!b),"pending"===g.state()||r.isFunction(e[c]&&e[c].then)))return g.then();while(c--)P(e[c],h(c),g.reject);return g.promise()}});var Q=/^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/;r.Deferred.exceptionHook=function(b,c){a.console&&a.console.warn&&b&&Q.test(b.name)&&a.console.warn("jQuery.Deferred exception: "+b.message,b.stack,c)},r.readyException=function(b){a.setTimeout(function(){throw b})};var R=r.Deferred();r.fn.ready=function(a){return R.then(a)["catch"](function(a){r.readyException(a)}),this},r.extend({isReady:!1,readyWait:1,ready:function(a){(a===!0?--r.readyWait:r.isReady)||(r.isReady=!0,a!==!0&&--r.readyWait>0||R.resolveWith(d,[r]))}}),r.ready.then=R.then;function S(){d.removeEventListener("DOMContentLoaded",S),
-a.removeEventListener("load",S),r.ready()}"complete"===d.readyState||"loading"!==d.readyState&&!d.documentElement.doScroll?a.setTimeout(r.ready):(d.addEventListener("DOMContentLoaded",S),a.addEventListener("load",S));var T=function(a,b,c,d,e,f,g){var h=0,i=a.length,j=null==c;if("object"===r.type(c)){e=!0;for(h in c)T(a,b,h,c[h],!0,f,g)}else if(void 0!==d&&(e=!0,r.isFunction(d)||(g=!0),j&&(g?(b.call(a,d),b=null):(j=b,b=function(a,b,c){return j.call(r(a),c)})),b))for(;h<i;h++)b(a[h],c,g?d:d.call(a[h],h,b(a[h],c)));return e?a:j?b.call(a):i?b(a[0],c):f},U=function(a){return 1===a.nodeType||9===a.nodeType||!+a.nodeType};function V(){this.expando=r.expando+V.uid++}V.uid=1,V.prototype={cache:function(a){var b=a[this.expando];return b||(b={},U(a)&&(a.nodeType?a[this.expando]=b:Object.defineProperty(a,this.expando,{value:b,configurable:!0}))),b},set:function(a,b,c){var d,e=this.cache(a);if("string"==typeof b)e[r.camelCase(b)]=c;else for(d in b)e[r.camelCase(d)]=b[d];return e},get:function(a,b){return void 0===b?this.cache(a):a[this.expando]&&a[this.expando][r.camelCase(b)]},access:function(a,b,c){return void 0===b||b&&"string"==typeof b&&void 0===c?this.get(a,b):(this.set(a,b,c),void 0!==c?c:b)},remove:function(a,b){var c,d=a[this.expando];if(void 0!==d){if(void 0!==b){Array.isArray(b)?b=b.map(r.camelCase):(b=r.camelCase(b),b=b in d?[b]:b.match(L)||[]),c=b.length;while(c--)delete d[b[c]]}(void 0===b||r.isEmptyObject(d))&&(a.nodeType?a[this.expando]=void 0:delete a[this.expando])}},hasData:function(a){var b=a[this.expando];return void 0!==b&&!r.isEmptyObject(b)}};var W=new V,X=new V,Y=/^(?:\{[\w\W]*\}|\[[\w\W]*\])$/,Z=/[A-Z]/g;function $(a){return"true"===a||"false"!==a&&("null"===a?null:a===+a+""?+a:Y.test(a)?JSON.parse(a):a)}function _(a,b,c){var d;if(void 0===c&&1===a.nodeType)if(d="data-"+b.replace(Z,"-$&").toLowerCase(),c=a.getAttribute(d),"string"==typeof c){try{c=$(c)}catch(e){}X.set(a,b,c)}else c=void 0;return c}r.extend({hasData:function(a){return X.hasData(a)||W.hasData(a)},data:function(a,b,c){return X.access(a,b,c)},removeData:function(a,b){X.remove(a,b)},_data:function(a,b,c){return W.access(a,b,c)},_removeData:function(a,b){W.remove(a,b)}}),r.fn.extend({data:function(a,b){var c,d,e,f=this[0],g=f&&f.attributes;if(void 0===a){if(this.length&&(e=X.get(f),1===f.nodeType&&!W.get(f,"hasDataAttrs"))){c=g.length;while(c--)g[c]&&(d=g[c].name,0===d.indexOf("data-")&&(d=r.camelCase(d.slice(5)),_(f,d,e[d])));W.set(f,"hasDataAttrs",!0)}return e}return"object"==typeof a?this.each(function(){X.set(this,a)}):T(this,function(b){var c;if(f&&void 0===b){if(c=X.get(f,a),void 0!==c)return c;if(c=_(f,a),void 0!==c)return c}else this.each(function(){X.set(this,a,b)})},null,b,arguments.length>1,null,!0)},removeData:function(a){return this.each(function(){X.remove(this,a)})}}),r.extend({queue:function(a,b,c){var d;if(a)return b=(b||"fx")+"queue",d=W.get(a,b),c&&(!d||Array.isArray(c)?d=W.access(a,b,r.makeArray(c)):d.push(c)),d||[]},dequeue:function(a,b){b=b||"fx";var c=r.queue(a,b),d=c.length,e=c.shift(),f=r._queueHooks(a,b),g=function(){r.dequeue(a,b)};"inprogress"===e&&(e=c.shift(),d--),e&&("fx"===b&&c.unshift("inprogress"),delete f.stop,e.call(a,g,f)),!d&&f&&f.empty.fire()},_queueHooks:function(a,b){var c=b+"queueHooks";return W.get(a,c)||W.access(a,c,{empty:r.Callbacks("once memory").add(function(){W.remove(a,[b+"queue",c])})})}}),r.fn.extend({queue:function(a,b){var c=2;return"string"!=typeof a&&(b=a,a="fx",c--),arguments.length<c?r.queue(this[0],a):void 0===b?this:this.each(function(){var c=r.queue(this,a,b);r._queueHooks(this,a),"fx"===a&&"inprogress"!==c[0]&&r.dequeue(this,a)})},dequeue:function(a){return this.each(function(){r.dequeue(this,a)})},clearQueue:function(a){return this.queue(a||"fx",[])},promise:function(a,b){var c,d=1,e=r.Deferred(),f=this,g=this.length,h=function(){--d||e.resolveWith(f,[f])};"string"!=typeof a&&(b=a,a=void 0),a=a||"fx";while(g--)c=W.get(f[g],a+"queueHooks"),c&&c.empty&&(d++,c.empty.add(h));return h(),e.promise(b)}});var aa=/[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/.source,ba=new RegExp("^(?:([+-])=|)("+aa+")([a-z%]*)$","i"),ca=["Top","Right","Bottom","Left"],da=function(a,b){return a=b||a,"none"===a.style.display||""===a.style.display&&r.contains(a.ownerDocument,a)&&"none"===r.css(a,"display")},ea=function(a,b,c,d){var e,f,g={};for(f in b)g[f]=a.style[f],a.style[f]=b[f];e=c.apply(a,d||[]);for(f in b)a.style[f]=g[f];return e};function fa(a,b,c,d){var e,f=1,g=20,h=d?function(){return d.cur()}:function(){return r.css(a,b,"")},i=h(),j=c&&c[3]||(r.cssNumber[b]?"":"px"),k=(r.cssNumber[b]||"px"!==j&&+i)&&ba.exec(r.css(a,b));if(k&&k[3]!==j){j=j||k[3],c=c||[],k=+i||1;do f=f||".5",k/=f,r.style(a,b,k+j);while(f!==(f=h()/i)&&1!==f&&--g)}return c&&(k=+k||+i||0,e=c[1]?k+(c[1]+1)*c[2]:+c[2],d&&(d.unit=j,d.start=k,d.end=e)),e}var ga={};function ha(a){var b,c=a.ownerDocument,d=a.nodeName,e=ga[d];return e?e:(b=c.body.appendChild(c.createElement(d)),e=r.css(b,"display"),b.parentNode.removeChild(b),"none"===e&&(e="block"),ga[d]=e,e)}function ia(a,b){for(var c,d,e=[],f=0,g=a.length;f<g;f++)d=a[f],d.style&&(c=d.style.display,b?("none"===c&&(e[f]=W.get(d,"display")||null,e[f]||(d.style.display="")),""===d.style.display&&da(d)&&(e[f]=ha(d))):"none"!==c&&(e[f]="none",W.set(d,"display",c)));for(f=0;f<g;f++)null!=e[f]&&(a[f].style.display=e[f]);return a}r.fn.extend({show:function(){return ia(this,!0)},hide:function(){return ia(this)},toggle:function(a){return"boolean"==typeof a?a?this.show():this.hide():this.each(function(){da(this)?r(this).show():r(this).hide()})}});var ja=/^(?:checkbox|radio)$/i,ka=/<([a-z][^\/\0>\x20\t\r\n\f]+)/i,la=/^$|\/(?:java|ecma)script/i,ma={option:[1,"<select multiple='multiple'>","</select>"],thead:[1,"<table>","</table>"],col:[2,"<table><colgroup>","</colgroup></table>"],tr:[2,"<table><tbody>","</tbody></table>"],td:[3,"<table><tbody><tr>","</tr></tbody></table>"],_default:[0,"",""]};ma.optgroup=ma.option,ma.tbody=ma.tfoot=ma.colgroup=ma.caption=ma.thead,ma.th=ma.td;function na(a,b){var c;return c="undefined"!=typeof a.getElementsByTagName?a.getElementsByTagName(b||"*"):"undefined"!=typeof a.querySelectorAll?a.querySelectorAll(b||"*"):[],void 0===b||b&&B(a,b)?r.merge([a],c):c}function oa(a,b){for(var c=0,d=a.length;c<d;c++)W.set(a[c],"globalEval",!b||W.get(b[c],"globalEval"))}var pa=/<|&#?\w+;/;function qa(a,b,c,d,e){for(var f,g,h,i,j,k,l=b.createDocumentFragment(),m=[],n=0,o=a.length;n<o;n++)if(f=a[n],f||0===f)if("object"===r.type(f))r.merge(m,f.nodeType?[f]:f);else if(pa.test(f)){g=g||l.appendChild(b.createElement("div")),h=(ka.exec(f)||["",""])[1].toLowerCase(),i=ma[h]||ma._default,g.innerHTML=i[1]+r.htmlPrefilter(f)+i[2],k=i[0];while(k--)g=g.lastChild;r.merge(m,g.childNodes),g=l.firstChild,g.textContent=""}else m.push(b.createTextNode(f));l.textContent="",n=0;while(f=m[n++])if(d&&r.inArray(f,d)>-1)e&&e.push(f);else if(j=r.contains(f.ownerDocument,f),g=na(l.appendChild(f),"script"),j&&oa(g),c){k=0;while(f=g[k++])la.test(f.type||"")&&c.push(f)}return l}!function(){var a=d.createDocumentFragment(),b=a.appendChild(d.createElement("div")),c=d.createElement("input");c.setAttribute("type","radio"),c.setAttribute("checked","checked"),c.setAttribute("name","t"),b.appendChild(c),o.checkClone=b.cloneNode(!0).cloneNode(!0).lastChild.checked,b.innerHTML="<textarea>x</textarea>",o.noCloneChecked=!!b.cloneNode(!0).lastChild.defaultValue}();var ra=d.documentElement,sa=/^key/,ta=/^(?:mouse|pointer|contextmenu|drag|drop)|click/,ua=/^([^.]*)(?:\.(.+)|)/;function va(){return!0}function wa(){return!1}function xa(){try{return d.activeElement}catch(a){}}function ya(a,b,c,d,e,f){var g,h;if("object"==typeof b){"string"!=typeof c&&(d=d||c,c=void 0);for(h in b)ya(a,h,c,d,b[h],f);return a}if(null==d&&null==e?(e=c,d=c=void 0):null==e&&("string"==typeof c?(e=d,d=void 0):(e=d,d=c,c=void 0)),e===!1)e=wa;else if(!e)return a;return 1===f&&(g=e,e=function(a){return r().off(a),g.apply(this,arguments)},e.guid=g.guid||(g.guid=r.guid++)),a.each(function(){r.event.add(this,b,e,d,c)})}r.event={global:{},add:function(a,b,c,d,e){var f,g,h,i,j,k,l,m,n,o,p,q=W.get(a);if(q){c.handler&&(f=c,c=f.handler,e=f.selector),e&&r.find.matchesSelector(ra,e),c.guid||(c.guid=r.guid++),(i=q.events)||(i=q.events={}),(g=q.handle)||(g=q.handle=function(b){return"undefined"!=typeof r&&r.event.triggered!==b.type?r.event.dispatch.apply(a,arguments):void 0}),b=(b||"").match(L)||[""],j=b.length;while(j--)h=ua.exec(b[j])||[],n=p=h[1],o=(h[2]||"").split(".").sort(),n&&(l=r.event.special[n]||{},n=(e?l.delegateType:l.bindType)||n,l=r.event.special[n]||{},k=r.extend({type:n,origType:p,data:d,handler:c,guid:c.guid,selector:e,needsContext:e&&r.expr.match.needsContext.test(e),namespace:o.join(".")},f),(m=i[n])||(m=i[n]=[],m.delegateCount=0,l.setup&&l.setup.call(a,d,o,g)!==!1||a.addEventListener&&a.addEventListener(n,g)),l.add&&(l.add.call(a,k),k.handler.guid||(k.handler.guid=c.guid)),e?m.splice(m.delegateCount++,0,k):m.push(k),r.event.global[n]=!0)}},remove:function(a,b,c,d,e){var f,g,h,i,j,k,l,m,n,o,p,q=W.hasData(a)&&W.get(a);if(q&&(i=q.events)){b=(b||"").match(L)||[""],j=b.length;while(j--)if(h=ua.exec(b[j])||[],n=p=h[1],o=(h[2]||"").split(".").sort(),n){l=r.event.special[n]||{},n=(d?l.delegateType:l.bindType)||n,m=i[n]||[],h=h[2]&&new RegExp("(^|\\.)"+o.join("\\.(?:.*\\.|)")+"(\\.|$)"),g=f=m.length;while(f--)k=m[f],!e&&p!==k.origType||c&&c.guid!==k.guid||h&&!h.test(k.namespace)||d&&d!==k.selector&&("**"!==d||!k.selector)||(m.splice(f,1),k.selector&&m.delegateCount--,l.remove&&l.remove.call(a,k));g&&!m.length&&(l.teardown&&l.teardown.call(a,o,q.handle)!==!1||r.removeEvent(a,n,q.handle),delete i[n])}else for(n in i)r.event.remove(a,n+b[j],c,d,!0);r.isEmptyObject(i)&&W.remove(a,"handle events")}},dispatch:function(a){var b=r.event.fix(a),c,d,e,f,g,h,i=new Array(arguments.length),j=(W.get(this,"events")||{})[b.type]||[],k=r.event.special[b.type]||{};for(i[0]=b,c=1;c<arguments.length;c++)i[c]=arguments[c];if(b.delegateTarget=this,!k.preDispatch||k.preDispatch.call(this,b)!==!1){h=r.event.handlers.call(this,b,j),c=0;while((f=h[c++])&&!b.isPropagationStopped()){b.currentTarget=f.elem,d=0;while((g=f.handlers[d++])&&!b.isImmediatePropagationStopped())b.rnamespace&&!b.rnamespace.test(g.namespace)||(b.handleObj=g,b.data=g.data,e=((r.event.special[g.origType]||{}).handle||g.handler).apply(f.elem,i),void 0!==e&&(b.result=e)===!1&&(b.preventDefault(),b.stopPropagation()))}return k.postDispatch&&k.postDispatch.call(this,b),b.result}},handlers:function(a,b){var c,d,e,f,g,h=[],i=b.delegateCount,j=a.target;if(i&&j.nodeType&&!("click"===a.type&&a.button>=1))for(;j!==this;j=j.parentNode||this)if(1===j.nodeType&&("click"!==a.type||j.disabled!==!0)){for(f=[],g={},c=0;c<i;c++)d=b[c],e=d.selector+" ",void 0===g[e]&&(g[e]=d.needsContext?r(e,this).index(j)>-1:r.find(e,this,null,[j]).length),g[e]&&f.push(d);f.length&&h.push({elem:j,handlers:f})}return j=this,i<b.length&&h.push({elem:j,handlers:b.slice(i)}),h},addProp:function(a,b){Object.defineProperty(r.Event.prototype,a,{enumerable:!0,configurable:!0,get:r.isFunction(b)?function(){if(this.originalEvent)return b(this.originalEvent)}:function(){if(this.originalEvent)return this.originalEvent[a]},set:function(b){Object.defineProperty(this,a,{enumerable:!0,configurable:!0,writable:!0,value:b})}})},fix:function(a){return a[r.expando]?a:new r.Event(a)},special:{load:{noBubble:!0},focus:{trigger:function(){if(this!==xa()&&this.focus)return this.focus(),!1},delegateType:"focusin"},blur:{trigger:function(){if(this===xa()&&this.blur)return this.blur(),!1},delegateType:"focusout"},click:{trigger:function(){if("checkbox"===this.type&&this.click&&B(this,"input"))return this.click(),!1},_default:function(a){return B(a.target,"a")}},beforeunload:{postDispatch:function(a){void 0!==a.result&&a.originalEvent&&(a.originalEvent.returnValue=a.result)}}}},r.removeEvent=function(a,b,c){a.removeEventListener&&a.removeEventListener(b,c)},r.Event=function(a,b){return this instanceof r.Event?(a&&a.type?(this.originalEvent=a,this.type=a.type,this.isDefaultPrevented=a.defaultPrevented||void 0===a.defaultPrevented&&a.returnValue===!1?va:wa,this.target=a.target&&3===a.target.nodeType?a.target.parentNode:a.target,this.currentTarget=a.currentTarget,this.relatedTarget=a.relatedTarget):this.type=a,b&&r.extend(this,b),this.timeStamp=a&&a.timeStamp||r.now(),void(this[r.expando]=!0)):new r.Event(a,b)},r.Event.prototype={constructor:r.Event,isDefaultPrevented:wa,isPropagationStopped:wa,isImmediatePropagationStopped:wa,isSimulated:!1,preventDefault:function(){var a=this.originalEvent;this.isDefaultPrevented=va,a&&!this.isSimulated&&a.preventDefault()},stopPropagation:function(){var a=this.originalEvent;this.isPropagationStopped=va,a&&!this.isSimulated&&a.stopPropagation()},stopImmediatePropagation:function(){var a=this.originalEvent;this.isImmediatePropagationStopped=va,a&&!this.isSimulated&&a.stopImmediatePropagation(),this.stopPropagation()}},r.each({altKey:!0,bubbles:!0,cancelable:!0,changedTouches:!0,ctrlKey:!0,detail:!0,eventPhase:!0,metaKey:!0,pageX:!0,pageY:!0,shiftKey:!0,view:!0,"char":!0,charCode:!0,key:!0,keyCode:!0,button:!0,buttons:!0,clientX:!0,clientY:!0,offsetX:!0,offsetY:!0,pointerId:!0,pointerType:!0,screenX:!0,screenY:!0,targetTouches:!0,toElement:!0,touches:!0,which:function(a){var b=a.button;return null==a.which&&sa.test(a.type)?null!=a.charCode?a.charCode:a.keyCode:!a.which&&void 0!==b&&ta.test(a.type)?1&b?1:2&b?3:4&b?2:0:a.which}},r.event.addProp),r.each({mouseenter:"mouseover",mouseleave:"mouseout",pointerenter:"pointerover",pointerleave:"pointerout"},function(a,b){r.event.special[a]={delegateType:b,bindType:b,handle:function(a){var c,d=this,e=a.relatedTarget,f=a.handleObj;return e&&(e===d||r.contains(d,e))||(a.type=f.origType,c=f.handler.apply(this,arguments),a.type=b),c}}}),r.fn.extend({on:function(a,b,c,d){return ya(this,a,b,c,d)},one:function(a,b,c,d){return ya(this,a,b,c,d,1)},off:function(a,b,c){var d,e;if(a&&a.preventDefault&&a.handleObj)return d=a.handleObj,r(a.delegateTarget).off(d.namespace?d.origType+"."+d.namespace:d.origType,d.selector,d.handler),this;if("object"==typeof a){for(e in a)this.off(e,b,a[e]);return this}return b!==!1&&"function"!=typeof b||(c=b,b=void 0),c===!1&&(c=wa),this.each(function(){r.event.remove(this,a,c,b)})}});var za=/<(?!area|br|col|embed|hr|img|input|link|meta|param)(([a-z][^\/\0>\x20\t\r\n\f]*)[^>]*)\/>/gi,Aa=/<script|<style|<link/i,Ba=/checked\s*(?:[^=]|=\s*.checked.)/i,Ca=/^true\/(.*)/,Da=/^\s*<!(?:\[CDATA\[|--)|(?:\]\]|--)>\s*$/g;function Ea(a,b){return B(a,"table")&&B(11!==b.nodeType?b:b.firstChild,"tr")?r(">tbody",a)[0]||a:a}function Fa(a){return a.type=(null!==a.getAttribute("type"))+"/"+a.type,a}function Ga(a){var b=Ca.exec(a.type);return b?a.type=b[1]:a.removeAttribute("type"),a}function Ha(a,b){var c,d,e,f,g,h,i,j;if(1===b.nodeType){if(W.hasData(a)&&(f=W.access(a),g=W.set(b,f),j=f.events)){delete g.handle,g.events={};for(e in j)for(c=0,d=j[e].length;c<d;c++)r.event.add(b,e,j[e][c])}X.hasData(a)&&(h=X.access(a),i=r.extend({},h),X.set(b,i))}}function Ia(a,b){var c=b.nodeName.toLowerCase();"input"===c&&ja.test(a.type)?b.checked=a.checked:"input"!==c&&"textarea"!==c||(b.defaultValue=a.defaultValue)}function Ja(a,b,c,d){b=g.apply([],b);var e,f,h,i,j,k,l=0,m=a.length,n=m-1,q=b[0],s=r.isFunction(q);if(s||m>1&&"string"==typeof q&&!o.checkClone&&Ba.test(q))return a.each(function(e){var f=a.eq(e);s&&(b[0]=q.call(this,e,f.html())),Ja(f,b,c,d)});if(m&&(e=qa(b,a[0].ownerDocument,!1,a,d),f=e.firstChild,1===e.childNodes.length&&(e=f),f||d)){for(h=r.map(na(e,"script"),Fa),i=h.length;l<m;l++)j=e,l!==n&&(j=r.clone(j,!0,!0),i&&r.merge(h,na(j,"script"))),c.call(a[l],j,l);if(i)for(k=h[h.length-1].ownerDocument,r.map(h,Ga),l=0;l<i;l++)j=h[l],la.test(j.type||"")&&!W.access(j,"globalEval")&&r.contains(k,j)&&(j.src?r._evalUrl&&r._evalUrl(j.src):p(j.textContent.replace(Da,""),k))}return a}function Ka(a,b,c){for(var d,e=b?r.filter(b,a):a,f=0;null!=(d=e[f]);f++)c||1!==d.nodeType||r.cleanData(na(d)),d.parentNode&&(c&&r.contains(d.ownerDocument,d)&&oa(na(d,"script")),d.parentNode.removeChild(d));return a}r.extend({htmlPrefilter:function(a){return a.replace(za,"<$1></$2>")},clone:function(a,b,c){var d,e,f,g,h=a.cloneNode(!0),i=r.contains(a.ownerDocument,a);if(!(o.noCloneChecked||1!==a.nodeType&&11!==a.nodeType||r.isXMLDoc(a)))for(g=na(h),f=na(a),d=0,e=f.length;d<e;d++)Ia(f[d],g[d]);if(b)if(c)for(f=f||na(a),g=g||na(h),d=0,e=f.length;d<e;d++)Ha(f[d],g[d]);else Ha(a,h);return g=na(h,"script"),g.length>0&&oa(g,!i&&na(a,"script")),h},cleanData:function(a){for(var b,c,d,e=r.event.special,f=0;void 0!==(c=a[f]);f++)if(U(c)){if(b=c[W.expando]){if(b.events)for(d in b.events)e[d]?r.event.remove(c,d):r.removeEvent(c,d,b.handle);c[W.expando]=void 0}c[X.expando]&&(c[X.expando]=void 0)}}}),r.fn.extend({detach:function(a){return Ka(this,a,!0)},remove:function(a){return Ka(this,a)},text:function(a){return T(this,function(a){return void 0===a?r.text(this):this.empty().each(function(){1!==this.nodeType&&11!==this.nodeType&&9!==this.nodeType||(this.textContent=a)})},null,a,arguments.length)},append:function(){return Ja(this,arguments,function(a){if(1===this.nodeType||11===this.nodeType||9===this.nodeType){var b=Ea(this,a);b.appendChild(a)}})},prepend:function(){return Ja(this,arguments,function(a){if(1===this.nodeType||11===this.nodeType||9===this.nodeType){var b=Ea(this,a);b.insertBefore(a,b.firstChild)}})},before:function(){return Ja(this,arguments,function(a){this.parentNode&&this.parentNode.insertBefore(a,this)})},after:function(){return Ja(this,arguments,function(a){this.parentNode&&this.parentNode.insertBefore(a,this.nextSibling)})},empty:function(){for(var a,b=0;null!=(a=this[b]);b++)1===a.nodeType&&(r.cleanData(na(a,!1)),a.textContent="");return this},clone:function(a,b){return a=null!=a&&a,b=null==b?a:b,this.map(function(){return r.clone(this,a,b)})},html:function(a){return T(this,function(a){var b=this[0]||{},c=0,d=this.length;if(void 0===a&&1===b.nodeType)return b.innerHTML;if("string"==typeof a&&!Aa.test(a)&&!ma[(ka.exec(a)||["",""])[1].toLowerCase()]){a=r.htmlPrefilter(a);try{for(;c<d;c++)b=this[c]||{},1===b.nodeType&&(r.cleanData(na(b,!1)),b.innerHTML=a);b=0}catch(e){}}b&&this.empty().append(a)},null,a,arguments.length)},replaceWith:function(){var a=[];return Ja(this,arguments,function(b){var c=this.parentNode;r.inArray(this,a)<0&&(r.cleanData(na(this)),c&&c.replaceChild(b,this))},a)}}),r.each({appendTo:"append",prependTo:"prepend",insertBefore:"before",insertAfter:"after",replaceAll:"replaceWith"},function(a,b){r.fn[a]=function(a){for(var c,d=[],e=r(a),f=e.length-1,g=0;g<=f;g++)c=g===f?this:this.clone(!0),r(e[g])[b](c),h.apply(d,c.get());return this.pushStack(d)}});var La=/^margin/,Ma=new RegExp("^("+aa+")(?!px)[a-z%]+$","i"),Na=function(b){var c=b.ownerDocument.defaultView;return c&&c.opener||(c=a),c.getComputedStyle(b)};!function(){function b(){if(i){i.style.cssText="box-sizing:border-box;position:relative;display:block;margin:auto;border:1px;padding:1px;top:1%;width:50%",i.innerHTML="",ra.appendChild(h);var b=a.getComputedStyle(i);c="1%"!==b.top,g="2px"===b.marginLeft,e="4px"===b.width,i.style.marginRight="50%",f="4px"===b.marginRight,ra.removeChild(h),i=null}}var c,e,f,g,h=d.createElement("div"),i=d.createElement("div");i.style&&(i.style.backgroundClip="content-box",i.cloneNode(!0).style.backgroundClip="",o.clearCloneStyle="content-box"===i.style.backgroundClip,h.style.cssText="border:0;width:8px;height:0;top:0;left:-9999px;padding:0;margin-top:1px;position:absolute",h.appendChild(i),r.extend(o,{pixelPosition:function(){return b(),c},boxSizingReliable:function(){return b(),e},pixelMarginRight:function(){return b(),f},reliableMarginLeft:function(){return b(),g}}))}();function Oa(a,b,c){var d,e,f,g,h=a.style;return c=c||Na(a),c&&(g=c.getPropertyValue(b)||c[b],""!==g||r.contains(a.ownerDocument,a)||(g=r.style(a,b)),!o.pixelMarginRight()&&Ma.test(g)&&La.test(b)&&(d=h.width,e=h.minWidth,f=h.maxWidth,h.minWidth=h.maxWidth=h.width=g,g=c.width,h.width=d,h.minWidth=e,h.maxWidth=f)),void 0!==g?g+"":g}function Pa(a,b){return{get:function(){return a()?void delete this.get:(this.get=b).apply(this,arguments)}}}var Qa=/^(none|table(?!-c[ea]).+)/,Ra=/^--/,Sa={position:"absolute",visibility:"hidden",display:"block"},Ta={letterSpacing:"0",fontWeight:"400"},Ua=["Webkit","Moz","ms"],Va=d.createElement("div").style;function Wa(a){if(a in Va)return a;var b=a[0].toUpperCase()+a.slice(1),c=Ua.length;while(c--)if(a=Ua[c]+b,a in Va)return a}function Xa(a){var b=r.cssProps[a];return b||(b=r.cssProps[a]=Wa(a)||a),b}function Ya(a,b,c){var d=ba.exec(b);return d?Math.max(0,d[2]-(c||0))+(d[3]||"px"):b}function Za(a,b,c,d,e){var f,g=0;for(f=c===(d?"border":"content")?4:"width"===b?1:0;f<4;f+=2)"margin"===c&&(g+=r.css(a,c+ca[f],!0,e)),d?("content"===c&&(g-=r.css(a,"padding"+ca[f],!0,e)),"margin"!==c&&(g-=r.css(a,"border"+ca[f]+"Width",!0,e))):(g+=r.css(a,"padding"+ca[f],!0,e),"padding"!==c&&(g+=r.css(a,"border"+ca[f]+"Width",!0,e)));return g}function $a(a,b,c){var d,e=Na(a),f=Oa(a,b,e),g="border-box"===r.css(a,"boxSizing",!1,e);return Ma.test(f)?f:(d=g&&(o.boxSizingReliable()||f===a.style[b]),"auto"===f&&(f=a["offset"+b[0].toUpperCase()+b.slice(1)]),f=parseFloat(f)||0,f+Za(a,b,c||(g?"border":"content"),d,e)+"px")}r.extend({cssHooks:{opacity:{get:function(a,b){if(b){var c=Oa(a,"opacity");return""===c?"1":c}}}},cssNumber:{animationIterationCount:!0,columnCount:!0,fillOpacity:!0,flexGrow:!0,flexShrink:!0,fontWeight:!0,lineHeight:!0,opacity:!0,order:!0,orphans:!0,widows:!0,zIndex:!0,zoom:!0},cssProps:{"float":"cssFloat"},style:function(a,b,c,d){if(a&&3!==a.nodeType&&8!==a.nodeType&&a.style){var e,f,g,h=r.camelCase(b),i=Ra.test(b),j=a.style;return i||(b=Xa(h)),g=r.cssHooks[b]||r.cssHooks[h],void 0===c?g&&"get"in g&&void 0!==(e=g.get(a,!1,d))?e:j[b]:(f=typeof c,"string"===f&&(e=ba.exec(c))&&e[1]&&(c=fa(a,b,e),f="number"),null!=c&&c===c&&("number"===f&&(c+=e&&e[3]||(r.cssNumber[h]?"":"px")),o.clearCloneStyle||""!==c||0!==b.indexOf("background")||(j[b]="inherit"),g&&"set"in g&&void 0===(c=g.set(a,c,d))||(i?j.setProperty(b,c):j[b]=c)),void 0)}},css:function(a,b,c,d){var e,f,g,h=r.camelCase(b),i=Ra.test(b);return i||(b=Xa(h)),g=r.cssHooks[b]||r.cssHooks[h],g&&"get"in g&&(e=g.get(a,!0,c)),void 0===e&&(e=Oa(a,b,d)),"normal"===e&&b in Ta&&(e=Ta[b]),""===c||c?(f=parseFloat(e),c===!0||isFinite(f)?f||0:e):e}}),r.each(["height","width"],function(a,b){r.cssHooks[b]={get:function(a,c,d){if(c)return!Qa.test(r.css(a,"display"))||a.getClientRects().length&&a.getBoundingClientRect().width?$a(a,b,d):ea(a,Sa,function(){return $a(a,b,d)})},set:function(a,c,d){var e,f=d&&Na(a),g=d&&Za(a,b,d,"border-box"===r.css(a,"boxSizing",!1,f),f);return g&&(e=ba.exec(c))&&"px"!==(e[3]||"px")&&(a.style[b]=c,c=r.css(a,b)),Ya(a,c,g)}}}),r.cssHooks.marginLeft=Pa(o.reliableMarginLeft,function(a,b){if(b)return(parseFloat(Oa(a,"marginLeft"))||a.getBoundingClientRect().left-ea(a,{marginLeft:0},function(){return a.getBoundingClientRect().left}))+"px"}),r.each({margin:"",padding:"",border:"Width"},function(a,b){r.cssHooks[a+b]={expand:function(c){for(var d=0,e={},f="string"==typeof c?c.split(" "):[c];d<4;d++)e[a+ca[d]+b]=f[d]||f[d-2]||f[0];return e}},La.test(a)||(r.cssHooks[a+b].set=Ya)}),r.fn.extend({css:function(a,b){return T(this,function(a,b,c){var d,e,f={},g=0;if(Array.isArray(b)){for(d=Na(a),e=b.length;g<e;g++)f[b[g]]=r.css(a,b[g],!1,d);return f}return void 0!==c?r.style(a,b,c):r.css(a,b)},a,b,arguments.length>1)}});function _a(a,b,c,d,e){return new _a.prototype.init(a,b,c,d,e)}r.Tween=_a,_a.prototype={constructor:_a,init:function(a,b,c,d,e,f){this.elem=a,this.prop=c,this.easing=e||r.easing._default,this.options=b,this.start=this.now=this.cur(),this.end=d,this.unit=f||(r.cssNumber[c]?"":"px")},cur:function(){var a=_a.propHooks[this.prop];return a&&a.get?a.get(this):_a.propHooks._default.get(this)},run:function(a){var b,c=_a.propHooks[this.prop];return this.options.duration?this.pos=b=r.easing[this.easing](a,this.options.duration*a,0,1,this.options.duration):this.pos=b=a,this.now=(this.end-this.start)*b+this.start,this.options.step&&this.options.step.call(this.elem,this.now,this),c&&c.set?c.set(this):_a.propHooks._default.set(this),this}},_a.prototype.init.prototype=_a.prototype,_a.propHooks={_default:{get:function(a){var b;return 1!==a.elem.nodeType||null!=a.elem[a.prop]&&null==a.elem.style[a.prop]?a.elem[a.prop]:(b=r.css(a.elem,a.prop,""),b&&"auto"!==b?b:0)},set:function(a){r.fx.step[a.prop]?r.fx.step[a.prop](a):1!==a.elem.nodeType||null==a.elem.style[r.cssProps[a.prop]]&&!r.cssHooks[a.prop]?a.elem[a.prop]=a.now:r.style(a.elem,a.prop,a.now+a.unit)}}},_a.propHooks.scrollTop=_a.propHooks.scrollLeft={set:function(a){a.elem.nodeType&&a.elem.parentNode&&(a.elem[a.prop]=a.now)}},r.easing={linear:function(a){return a},swing:function(a){return.5-Math.cos(a*Math.PI)/2},_default:"swing"},r.fx=_a.prototype.init,r.fx.step={};var ab,bb,cb=/^(?:toggle|show|hide)$/,db=/queueHooks$/;function eb(){bb&&(d.hidden===!1&&a.requestAnimationFrame?a.requestAnimationFrame(eb):a.setTimeout(eb,r.fx.interval),r.fx.tick())}function fb(){return a.setTimeout(function(){ab=void 0}),ab=r.now()}function gb(a,b){var c,d=0,e={height:a};for(b=b?1:0;d<4;d+=2-b)c=ca[d],e["margin"+c]=e["padding"+c]=a;return b&&(e.opacity=e.width=a),e}function hb(a,b,c){for(var d,e=(kb.tweeners[b]||[]).concat(kb.tweeners["*"]),f=0,g=e.length;f<g;f++)if(d=e[f].call(c,b,a))return d}function ib(a,b,c){var d,e,f,g,h,i,j,k,l="width"in b||"height"in b,m=this,n={},o=a.style,p=a.nodeType&&da(a),q=W.get(a,"fxshow");c.queue||(g=r._queueHooks(a,"fx"),null==g.unqueued&&(g.unqueued=0,h=g.empty.fire,g.empty.fire=function(){g.unqueued||h()}),g.unqueued++,m.always(function(){m.always(function(){g.unqueued--,r.queue(a,"fx").length||g.empty.fire()})}));for(d in b)if(e=b[d],cb.test(e)){if(delete b[d],f=f||"toggle"===e,e===(p?"hide":"show")){if("show"!==e||!q||void 0===q[d])continue;p=!0}n[d]=q&&q[d]||r.style(a,d)}if(i=!r.isEmptyObject(b),i||!r.isEmptyObject(n)){l&&1===a.nodeType&&(c.overflow=[o.overflow,o.overflowX,o.overflowY],j=q&&q.display,null==j&&(j=W.get(a,"display")),k=r.css(a,"display"),"none"===k&&(j?k=j:(ia([a],!0),j=a.style.display||j,k=r.css(a,"display"),ia([a]))),("inline"===k||"inline-block"===k&&null!=j)&&"none"===r.css(a,"float")&&(i||(m.done(function(){o.display=j}),null==j&&(k=o.display,j="none"===k?"":k)),o.display="inline-block")),c.overflow&&(o.overflow="hidden",m.always(function(){o.overflow=c.overflow[0],o.overflowX=c.overflow[1],o.overflowY=c.overflow[2]})),i=!1;for(d in n)i||(q?"hidden"in q&&(p=q.hidden):q=W.access(a,"fxshow",{display:j}),f&&(q.hidden=!p),p&&ia([a],!0),m.done(function(){p||ia([a]),W.remove(a,"fxshow");for(d in n)r.style(a,d,n[d])})),i=hb(p?q[d]:0,d,m),d in q||(q[d]=i.start,p&&(i.end=i.start,i.start=0))}}function jb(a,b){var c,d,e,f,g;for(c in a)if(d=r.camelCase(c),e=b[d],f=a[c],Array.isArray(f)&&(e=f[1],f=a[c]=f[0]),c!==d&&(a[d]=f,delete a[c]),g=r.cssHooks[d],g&&"expand"in g){f=g.expand(f),delete a[d];for(c in f)c in a||(a[c]=f[c],b[c]=e)}else b[d]=e}function kb(a,b,c){var d,e,f=0,g=kb.prefilters.length,h=r.Deferred().always(function(){delete i.elem}),i=function(){if(e)return!1;for(var b=ab||fb(),c=Math.max(0,j.startTime+j.duration-b),d=c/j.duration||0,f=1-d,g=0,i=j.tweens.length;g<i;g++)j.tweens[g].run(f);return h.notifyWith(a,[j,f,c]),f<1&&i?c:(i||h.notifyWith(a,[j,1,0]),h.resolveWith(a,[j]),!1)},j=h.promise({elem:a,props:r.extend({},b),opts:r.extend(!0,{specialEasing:{},easing:r.easing._default},c),originalProperties:b,originalOptions:c,startTime:ab||fb(),duration:c.duration,tweens:[],createTween:function(b,c){var d=r.Tween(a,j.opts,b,c,j.opts.specialEasing[b]||j.opts.easing);return j.tweens.push(d),d},stop:function(b){var c=0,d=b?j.tweens.length:0;if(e)return this;for(e=!0;c<d;c++)j.tweens[c].run(1);return b?(h.notifyWith(a,[j,1,0]),h.resolveWith(a,[j,b])):h.rejectWith(a,[j,b]),this}}),k=j.props;for(jb(k,j.opts.specialEasing);f<g;f++)if(d=kb.prefilters[f].call(j,a,k,j.opts))return r.isFunction(d.stop)&&(r._queueHooks(j.elem,j.opts.queue).stop=r.proxy(d.stop,d)),d;return r.map(k,hb,j),r.isFunction(j.opts.start)&&j.opts.start.call(a,j),j.progress(j.opts.progress).done(j.opts.done,j.opts.complete).fail(j.opts.fail).always(j.opts.always),r.fx.timer(r.extend(i,{elem:a,anim:j,queue:j.opts.queue})),j}r.Animation=r.extend(kb,{tweeners:{"*":[function(a,b){var c=this.createTween(a,b);return fa(c.elem,a,ba.exec(b),c),c}]},tweener:function(a,b){r.isFunction(a)?(b=a,a=["*"]):a=a.match(L);for(var c,d=0,e=a.length;d<e;d++)c=a[d],kb.tweeners[c]=kb.tweeners[c]||[],kb.tweeners[c].unshift(b)},prefilters:[ib],prefilter:function(a,b){b?kb.prefilters.unshift(a):kb.prefilters.push(a)}}),r.speed=function(a,b,c){var d=a&&"object"==typeof a?r.extend({},a):{complete:c||!c&&b||r.isFunction(a)&&a,duration:a,easing:c&&b||b&&!r.isFunction(b)&&b};return r.fx.off?d.duration=0:"number"!=typeof d.duration&&(d.duration in r.fx.speeds?d.duration=r.fx.speeds[d.duration]:d.duration=r.fx.speeds._default),null!=d.queue&&d.queue!==!0||(d.queue="fx"),d.old=d.complete,d.complete=function(){r.isFunction(d.old)&&d.old.call(this),d.queue&&r.dequeue(this,d.queue)},d},r.fn.extend({fadeTo:function(a,b,c,d){return this.filter(da).css("opacity",0).show().end().animate({opacity:b},a,c,d)},animate:function(a,b,c,d){var e=r.isEmptyObject(a),f=r.speed(b,c,d),g=function(){var b=kb(this,r.extend({},a),f);(e||W.get(this,"finish"))&&b.stop(!0)};return g.finish=g,e||f.queue===!1?this.each(g):this.queue(f.queue,g)},stop:function(a,b,c){var d=function(a){var b=a.stop;delete a.stop,b(c)};return"string"!=typeof a&&(c=b,b=a,a=void 0),b&&a!==!1&&this.queue(a||"fx",[]),this.each(function(){var b=!0,e=null!=a&&a+"queueHooks",f=r.timers,g=W.get(this);if(e)g[e]&&g[e].stop&&d(g[e]);else for(e in g)g[e]&&g[e].stop&&db.test(e)&&d(g[e]);for(e=f.length;e--;)f[e].elem!==this||null!=a&&f[e].queue!==a||(f[e].anim.stop(c),b=!1,f.splice(e,1));!b&&c||r.dequeue(this,a)})},finish:function(a){return a!==!1&&(a=a||"fx"),this.each(function(){var b,c=W.get(this),d=c[a+"queue"],e=c[a+"queueHooks"],f=r.timers,g=d?d.length:0;for(c.finish=!0,r.queue(this,a,[]),e&&e.stop&&e.stop.call(this,!0),b=f.length;b--;)f[b].elem===this&&f[b].queue===a&&(f[b].anim.stop(!0),f.splice(b,1));for(b=0;b<g;b++)d[b]&&d[b].finish&&d[b].finish.call(this);delete c.finish})}}),r.each(["toggle","show","hide"],function(a,b){var c=r.fn[b];r.fn[b]=function(a,d,e){return null==a||"boolean"==typeof a?c.apply(this,arguments):this.animate(gb(b,!0),a,d,e)}}),r.each({slideDown:gb("show"),slideUp:gb("hide"),slideToggle:gb("toggle"),fadeIn:{opacity:"show"},fadeOut:{opacity:"hide"},fadeToggle:{opacity:"toggle"}},function(a,b){r.fn[a]=function(a,c,d){return this.animate(b,a,c,d)}}),r.timers=[],r.fx.tick=function(){var a,b=0,c=r.timers;for(ab=r.now();b<c.length;b++)a=c[b],a()||c[b]!==a||c.splice(b--,1);c.length||r.fx.stop(),ab=void 0},r.fx.timer=function(a){r.timers.push(a),r.fx.start()},r.fx.interval=13,r.fx.start=function(){bb||(bb=!0,eb())},r.fx.stop=function(){bb=null},r.fx.speeds={slow:600,fast:200,_default:400},r.fn.delay=function(b,c){return b=r.fx?r.fx.speeds[b]||b:b,c=c||"fx",this.queue(c,function(c,d){var e=a.setTimeout(c,b);d.stop=function(){a.clearTimeout(e)}})},function(){var a=d.createElement("input"),b=d.createElement("select"),c=b.appendChild(d.createElement("option"));a.type="checkbox",o.checkOn=""!==a.value,o.optSelected=c.selected,a=d.createElement("input"),a.value="t",a.type="radio",o.radioValue="t"===a.value}();var lb,mb=r.expr.attrHandle;r.fn.extend({attr:function(a,b){return T(this,r.attr,a,b,arguments.length>1)},removeAttr:function(a){return this.each(function(){r.removeAttr(this,a)})}}),r.extend({attr:function(a,b,c){var d,e,f=a.nodeType;if(3!==f&&8!==f&&2!==f)return"undefined"==typeof a.getAttribute?r.prop(a,b,c):(1===f&&r.isXMLDoc(a)||(e=r.attrHooks[b.toLowerCase()]||(r.expr.match.bool.test(b)?lb:void 0)),void 0!==c?null===c?void r.removeAttr(a,b):e&&"set"in e&&void 0!==(d=e.set(a,c,b))?d:(a.setAttribute(b,c+""),c):e&&"get"in e&&null!==(d=e.get(a,b))?d:(d=r.find.attr(a,b),
-null==d?void 0:d))},attrHooks:{type:{set:function(a,b){if(!o.radioValue&&"radio"===b&&B(a,"input")){var c=a.value;return a.setAttribute("type",b),c&&(a.value=c),b}}}},removeAttr:function(a,b){var c,d=0,e=b&&b.match(L);if(e&&1===a.nodeType)while(c=e[d++])a.removeAttribute(c)}}),lb={set:function(a,b,c){return b===!1?r.removeAttr(a,c):a.setAttribute(c,c),c}},r.each(r.expr.match.bool.source.match(/\w+/g),function(a,b){var c=mb[b]||r.find.attr;mb[b]=function(a,b,d){var e,f,g=b.toLowerCase();return d||(f=mb[g],mb[g]=e,e=null!=c(a,b,d)?g:null,mb[g]=f),e}});var nb=/^(?:input|select|textarea|button)$/i,ob=/^(?:a|area)$/i;r.fn.extend({prop:function(a,b){return T(this,r.prop,a,b,arguments.length>1)},removeProp:function(a){return this.each(function(){delete this[r.propFix[a]||a]})}}),r.extend({prop:function(a,b,c){var d,e,f=a.nodeType;if(3!==f&&8!==f&&2!==f)return 1===f&&r.isXMLDoc(a)||(b=r.propFix[b]||b,e=r.propHooks[b]),void 0!==c?e&&"set"in e&&void 0!==(d=e.set(a,c,b))?d:a[b]=c:e&&"get"in e&&null!==(d=e.get(a,b))?d:a[b]},propHooks:{tabIndex:{get:function(a){var b=r.find.attr(a,"tabindex");return b?parseInt(b,10):nb.test(a.nodeName)||ob.test(a.nodeName)&&a.href?0:-1}}},propFix:{"for":"htmlFor","class":"className"}}),o.optSelected||(r.propHooks.selected={get:function(a){var b=a.parentNode;return b&&b.parentNode&&b.parentNode.selectedIndex,null},set:function(a){var b=a.parentNode;b&&(b.selectedIndex,b.parentNode&&b.parentNode.selectedIndex)}}),r.each(["tabIndex","readOnly","maxLength","cellSpacing","cellPadding","rowSpan","colSpan","useMap","frameBorder","contentEditable"],function(){r.propFix[this.toLowerCase()]=this});function pb(a){var b=a.match(L)||[];return b.join(" ")}function qb(a){return a.getAttribute&&a.getAttribute("class")||""}r.fn.extend({addClass:function(a){var b,c,d,e,f,g,h,i=0;if(r.isFunction(a))return this.each(function(b){r(this).addClass(a.call(this,b,qb(this)))});if("string"==typeof a&&a){b=a.match(L)||[];while(c=this[i++])if(e=qb(c),d=1===c.nodeType&&" "+pb(e)+" "){g=0;while(f=b[g++])d.indexOf(" "+f+" ")<0&&(d+=f+" ");h=pb(d),e!==h&&c.setAttribute("class",h)}}return this},removeClass:function(a){var b,c,d,e,f,g,h,i=0;if(r.isFunction(a))return this.each(function(b){r(this).removeClass(a.call(this,b,qb(this)))});if(!arguments.length)return this.attr("class","");if("string"==typeof a&&a){b=a.match(L)||[];while(c=this[i++])if(e=qb(c),d=1===c.nodeType&&" "+pb(e)+" "){g=0;while(f=b[g++])while(d.indexOf(" "+f+" ")>-1)d=d.replace(" "+f+" "," ");h=pb(d),e!==h&&c.setAttribute("class",h)}}return this},toggleClass:function(a,b){var c=typeof a;return"boolean"==typeof b&&"string"===c?b?this.addClass(a):this.removeClass(a):r.isFunction(a)?this.each(function(c){r(this).toggleClass(a.call(this,c,qb(this),b),b)}):this.each(function(){var b,d,e,f;if("string"===c){d=0,e=r(this),f=a.match(L)||[];while(b=f[d++])e.hasClass(b)?e.removeClass(b):e.addClass(b)}else void 0!==a&&"boolean"!==c||(b=qb(this),b&&W.set(this,"__className__",b),this.setAttribute&&this.setAttribute("class",b||a===!1?"":W.get(this,"__className__")||""))})},hasClass:function(a){var b,c,d=0;b=" "+a+" ";while(c=this[d++])if(1===c.nodeType&&(" "+pb(qb(c))+" ").indexOf(b)>-1)return!0;return!1}});var rb=/\r/g;r.fn.extend({val:function(a){var b,c,d,e=this[0];{if(arguments.length)return d=r.isFunction(a),this.each(function(c){var e;1===this.nodeType&&(e=d?a.call(this,c,r(this).val()):a,null==e?e="":"number"==typeof e?e+="":Array.isArray(e)&&(e=r.map(e,function(a){return null==a?"":a+""})),b=r.valHooks[this.type]||r.valHooks[this.nodeName.toLowerCase()],b&&"set"in b&&void 0!==b.set(this,e,"value")||(this.value=e))});if(e)return b=r.valHooks[e.type]||r.valHooks[e.nodeName.toLowerCase()],b&&"get"in b&&void 0!==(c=b.get(e,"value"))?c:(c=e.value,"string"==typeof c?c.replace(rb,""):null==c?"":c)}}}),r.extend({valHooks:{option:{get:function(a){var b=r.find.attr(a,"value");return null!=b?b:pb(r.text(a))}},select:{get:function(a){var b,c,d,e=a.options,f=a.selectedIndex,g="select-one"===a.type,h=g?null:[],i=g?f+1:e.length;for(d=f<0?i:g?f:0;d<i;d++)if(c=e[d],(c.selected||d===f)&&!c.disabled&&(!c.parentNode.disabled||!B(c.parentNode,"optgroup"))){if(b=r(c).val(),g)return b;h.push(b)}return h},set:function(a,b){var c,d,e=a.options,f=r.makeArray(b),g=e.length;while(g--)d=e[g],(d.selected=r.inArray(r.valHooks.option.get(d),f)>-1)&&(c=!0);return c||(a.selectedIndex=-1),f}}}}),r.each(["radio","checkbox"],function(){r.valHooks[this]={set:function(a,b){if(Array.isArray(b))return a.checked=r.inArray(r(a).val(),b)>-1}},o.checkOn||(r.valHooks[this].get=function(a){return null===a.getAttribute("value")?"on":a.value})});var sb=/^(?:focusinfocus|focusoutblur)$/;r.extend(r.event,{trigger:function(b,c,e,f){var g,h,i,j,k,m,n,o=[e||d],p=l.call(b,"type")?b.type:b,q=l.call(b,"namespace")?b.namespace.split("."):[];if(h=i=e=e||d,3!==e.nodeType&&8!==e.nodeType&&!sb.test(p+r.event.triggered)&&(p.indexOf(".")>-1&&(q=p.split("."),p=q.shift(),q.sort()),k=p.indexOf(":")<0&&"on"+p,b=b[r.expando]?b:new r.Event(p,"object"==typeof b&&b),b.isTrigger=f?2:3,b.namespace=q.join("."),b.rnamespace=b.namespace?new RegExp("(^|\\.)"+q.join("\\.(?:.*\\.|)")+"(\\.|$)"):null,b.result=void 0,b.target||(b.target=e),c=null==c?[b]:r.makeArray(c,[b]),n=r.event.special[p]||{},f||!n.trigger||n.trigger.apply(e,c)!==!1)){if(!f&&!n.noBubble&&!r.isWindow(e)){for(j=n.delegateType||p,sb.test(j+p)||(h=h.parentNode);h;h=h.parentNode)o.push(h),i=h;i===(e.ownerDocument||d)&&o.push(i.defaultView||i.parentWindow||a)}g=0;while((h=o[g++])&&!b.isPropagationStopped())b.type=g>1?j:n.bindType||p,m=(W.get(h,"events")||{})[b.type]&&W.get(h,"handle"),m&&m.apply(h,c),m=k&&h[k],m&&m.apply&&U(h)&&(b.result=m.apply(h,c),b.result===!1&&b.preventDefault());return b.type=p,f||b.isDefaultPrevented()||n._default&&n._default.apply(o.pop(),c)!==!1||!U(e)||k&&r.isFunction(e[p])&&!r.isWindow(e)&&(i=e[k],i&&(e[k]=null),r.event.triggered=p,e[p](),r.event.triggered=void 0,i&&(e[k]=i)),b.result}},simulate:function(a,b,c){var d=r.extend(new r.Event,c,{type:a,isSimulated:!0});r.event.trigger(d,null,b)}}),r.fn.extend({trigger:function(a,b){return this.each(function(){r.event.trigger(a,b,this)})},triggerHandler:function(a,b){var c=this[0];if(c)return r.event.trigger(a,b,c,!0)}}),r.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(a,b){r.fn[b]=function(a,c){return arguments.length>0?this.on(b,null,a,c):this.trigger(b)}}),r.fn.extend({hover:function(a,b){return this.mouseenter(a).mouseleave(b||a)}}),o.focusin="onfocusin"in a,o.focusin||r.each({focus:"focusin",blur:"focusout"},function(a,b){var c=function(a){r.event.simulate(b,a.target,r.event.fix(a))};r.event.special[b]={setup:function(){var d=this.ownerDocument||this,e=W.access(d,b);e||d.addEventListener(a,c,!0),W.access(d,b,(e||0)+1)},teardown:function(){var d=this.ownerDocument||this,e=W.access(d,b)-1;e?W.access(d,b,e):(d.removeEventListener(a,c,!0),W.remove(d,b))}}});var tb=a.location,ub=r.now(),vb=/\?/;r.parseXML=function(b){var c;if(!b||"string"!=typeof b)return null;try{c=(new a.DOMParser).parseFromString(b,"text/xml")}catch(d){c=void 0}return c&&!c.getElementsByTagName("parsererror").length||r.error("Invalid XML: "+b),c};var wb=/\[\]$/,xb=/\r?\n/g,yb=/^(?:submit|button|image|reset|file)$/i,zb=/^(?:input|select|textarea|keygen)/i;function Ab(a,b,c,d){var e;if(Array.isArray(b))r.each(b,function(b,e){c||wb.test(a)?d(a,e):Ab(a+"["+("object"==typeof e&&null!=e?b:"")+"]",e,c,d)});else if(c||"object"!==r.type(b))d(a,b);else for(e in b)Ab(a+"["+e+"]",b[e],c,d)}r.param=function(a,b){var c,d=[],e=function(a,b){var c=r.isFunction(b)?b():b;d[d.length]=encodeURIComponent(a)+"="+encodeURIComponent(null==c?"":c)};if(Array.isArray(a)||a.jquery&&!r.isPlainObject(a))r.each(a,function(){e(this.name,this.value)});else for(c in a)Ab(c,a[c],b,e);return d.join("&")},r.fn.extend({serialize:function(){return r.param(this.serializeArray())},serializeArray:function(){return this.map(function(){var a=r.prop(this,"elements");return a?r.makeArray(a):this}).filter(function(){var a=this.type;return this.name&&!r(this).is(":disabled")&&zb.test(this.nodeName)&&!yb.test(a)&&(this.checked||!ja.test(a))}).map(function(a,b){var c=r(this).val();return null==c?null:Array.isArray(c)?r.map(c,function(a){return{name:b.name,value:a.replace(xb,"\r\n")}}):{name:b.name,value:c.replace(xb,"\r\n")}}).get()}});var Bb=/%20/g,Cb=/#.*$/,Db=/([?&])_=[^&]*/,Eb=/^(.*?):[ \t]*([^\r\n]*)$/gm,Fb=/^(?:about|app|app-storage|.+-extension|file|res|widget):$/,Gb=/^(?:GET|HEAD)$/,Hb=/^\/\//,Ib={},Jb={},Kb="*/".concat("*"),Lb=d.createElement("a");Lb.href=tb.href;function Mb(a){return function(b,c){"string"!=typeof b&&(c=b,b="*");var d,e=0,f=b.toLowerCase().match(L)||[];if(r.isFunction(c))while(d=f[e++])"+"===d[0]?(d=d.slice(1)||"*",(a[d]=a[d]||[]).unshift(c)):(a[d]=a[d]||[]).push(c)}}function Nb(a,b,c,d){var e={},f=a===Jb;function g(h){var i;return e[h]=!0,r.each(a[h]||[],function(a,h){var j=h(b,c,d);return"string"!=typeof j||f||e[j]?f?!(i=j):void 0:(b.dataTypes.unshift(j),g(j),!1)}),i}return g(b.dataTypes[0])||!e["*"]&&g("*")}function Ob(a,b){var c,d,e=r.ajaxSettings.flatOptions||{};for(c in b)void 0!==b[c]&&((e[c]?a:d||(d={}))[c]=b[c]);return d&&r.extend(!0,a,d),a}function Pb(a,b,c){var d,e,f,g,h=a.contents,i=a.dataTypes;while("*"===i[0])i.shift(),void 0===d&&(d=a.mimeType||b.getResponseHeader("Content-Type"));if(d)for(e in h)if(h[e]&&h[e].test(d)){i.unshift(e);break}if(i[0]in c)f=i[0];else{for(e in c){if(!i[0]||a.converters[e+" "+i[0]]){f=e;break}g||(g=e)}f=f||g}if(f)return f!==i[0]&&i.unshift(f),c[f]}function Qb(a,b,c,d){var e,f,g,h,i,j={},k=a.dataTypes.slice();if(k[1])for(g in a.converters)j[g.toLowerCase()]=a.converters[g];f=k.shift();while(f)if(a.responseFields[f]&&(c[a.responseFields[f]]=b),!i&&d&&a.dataFilter&&(b=a.dataFilter(b,a.dataType)),i=f,f=k.shift())if("*"===f)f=i;else if("*"!==i&&i!==f){if(g=j[i+" "+f]||j["* "+f],!g)for(e in j)if(h=e.split(" "),h[1]===f&&(g=j[i+" "+h[0]]||j["* "+h[0]])){g===!0?g=j[e]:j[e]!==!0&&(f=h[0],k.unshift(h[1]));break}if(g!==!0)if(g&&a["throws"])b=g(b);else try{b=g(b)}catch(l){return{state:"parsererror",error:g?l:"No conversion from "+i+" to "+f}}}return{state:"success",data:b}}r.extend({active:0,lastModified:{},etag:{},ajaxSettings:{url:tb.href,type:"GET",isLocal:Fb.test(tb.protocol),global:!0,processData:!0,async:!0,contentType:"application/x-www-form-urlencoded; charset=UTF-8",accepts:{"*":Kb,text:"text/plain",html:"text/html",xml:"application/xml, text/xml",json:"application/json, text/javascript"},contents:{xml:/\bxml\b/,html:/\bhtml/,json:/\bjson\b/},responseFields:{xml:"responseXML",text:"responseText",json:"responseJSON"},converters:{"* text":String,"text html":!0,"text json":JSON.parse,"text xml":r.parseXML},flatOptions:{url:!0,context:!0}},ajaxSetup:function(a,b){return b?Ob(Ob(a,r.ajaxSettings),b):Ob(r.ajaxSettings,a)},ajaxPrefilter:Mb(Ib),ajaxTransport:Mb(Jb),ajax:function(b,c){"object"==typeof b&&(c=b,b=void 0),c=c||{};var e,f,g,h,i,j,k,l,m,n,o=r.ajaxSetup({},c),p=o.context||o,q=o.context&&(p.nodeType||p.jquery)?r(p):r.event,s=r.Deferred(),t=r.Callbacks("once memory"),u=o.statusCode||{},v={},w={},x="canceled",y={readyState:0,getResponseHeader:function(a){var b;if(k){if(!h){h={};while(b=Eb.exec(g))h[b[1].toLowerCase()]=b[2]}b=h[a.toLowerCase()]}return null==b?null:b},getAllResponseHeaders:function(){return k?g:null},setRequestHeader:function(a,b){return null==k&&(a=w[a.toLowerCase()]=w[a.toLowerCase()]||a,v[a]=b),this},overrideMimeType:function(a){return null==k&&(o.mimeType=a),this},statusCode:function(a){var b;if(a)if(k)y.always(a[y.status]);else for(b in a)u[b]=[u[b],a[b]];return this},abort:function(a){var b=a||x;return e&&e.abort(b),A(0,b),this}};if(s.promise(y),o.url=((b||o.url||tb.href)+"").replace(Hb,tb.protocol+"//"),o.type=c.method||c.type||o.method||o.type,o.dataTypes=(o.dataType||"*").toLowerCase().match(L)||[""],null==o.crossDomain){j=d.createElement("a");try{j.href=o.url,j.href=j.href,o.crossDomain=Lb.protocol+"//"+Lb.host!=j.protocol+"//"+j.host}catch(z){o.crossDomain=!0}}if(o.data&&o.processData&&"string"!=typeof o.data&&(o.data=r.param(o.data,o.traditional)),Nb(Ib,o,c,y),k)return y;l=r.event&&o.global,l&&0===r.active++&&r.event.trigger("ajaxStart"),o.type=o.type.toUpperCase(),o.hasContent=!Gb.test(o.type),f=o.url.replace(Cb,""),o.hasContent?o.data&&o.processData&&0===(o.contentType||"").indexOf("application/x-www-form-urlencoded")&&(o.data=o.data.replace(Bb,"+")):(n=o.url.slice(f.length),o.data&&(f+=(vb.test(f)?"&":"?")+o.data,delete o.data),o.cache===!1&&(f=f.replace(Db,"$1"),n=(vb.test(f)?"&":"?")+"_="+ub++ +n),o.url=f+n),o.ifModified&&(r.lastModified[f]&&y.setRequestHeader("If-Modified-Since",r.lastModified[f]),r.etag[f]&&y.setRequestHeader("If-None-Match",r.etag[f])),(o.data&&o.hasContent&&o.contentType!==!1||c.contentType)&&y.setRequestHeader("Content-Type",o.contentType),y.setRequestHeader("Accept",o.dataTypes[0]&&o.accepts[o.dataTypes[0]]?o.accepts[o.dataTypes[0]]+("*"!==o.dataTypes[0]?", "+Kb+"; q=0.01":""):o.accepts["*"]);for(m in o.headers)y.setRequestHeader(m,o.headers[m]);if(o.beforeSend&&(o.beforeSend.call(p,y,o)===!1||k))return y.abort();if(x="abort",t.add(o.complete),y.done(o.success),y.fail(o.error),e=Nb(Jb,o,c,y)){if(y.readyState=1,l&&q.trigger("ajaxSend",[y,o]),k)return y;o.async&&o.timeout>0&&(i=a.setTimeout(function(){y.abort("timeout")},o.timeout));try{k=!1,e.send(v,A)}catch(z){if(k)throw z;A(-1,z)}}else A(-1,"No Transport");function A(b,c,d,h){var j,m,n,v,w,x=c;k||(k=!0,i&&a.clearTimeout(i),e=void 0,g=h||"",y.readyState=b>0?4:0,j=b>=200&&b<300||304===b,d&&(v=Pb(o,y,d)),v=Qb(o,v,y,j),j?(o.ifModified&&(w=y.getResponseHeader("Last-Modified"),w&&(r.lastModified[f]=w),w=y.getResponseHeader("etag"),w&&(r.etag[f]=w)),204===b||"HEAD"===o.type?x="nocontent":304===b?x="notmodified":(x=v.state,m=v.data,n=v.error,j=!n)):(n=x,!b&&x||(x="error",b<0&&(b=0))),y.status=b,y.statusText=(c||x)+"",j?s.resolveWith(p,[m,x,y]):s.rejectWith(p,[y,x,n]),y.statusCode(u),u=void 0,l&&q.trigger(j?"ajaxSuccess":"ajaxError",[y,o,j?m:n]),t.fireWith(p,[y,x]),l&&(q.trigger("ajaxComplete",[y,o]),--r.active||r.event.trigger("ajaxStop")))}return y},getJSON:function(a,b,c){return r.get(a,b,c,"json")},getScript:function(a,b){return r.get(a,void 0,b,"script")}}),r.each(["get","post"],function(a,b){r[b]=function(a,c,d,e){return r.isFunction(c)&&(e=e||d,d=c,c=void 0),r.ajax(r.extend({url:a,type:b,dataType:e,data:c,success:d},r.isPlainObject(a)&&a))}}),r._evalUrl=function(a){return r.ajax({url:a,type:"GET",dataType:"script",cache:!0,async:!1,global:!1,"throws":!0})},r.fn.extend({wrapAll:function(a){var b;return this[0]&&(r.isFunction(a)&&(a=a.call(this[0])),b=r(a,this[0].ownerDocument).eq(0).clone(!0),this[0].parentNode&&b.insertBefore(this[0]),b.map(function(){var a=this;while(a.firstElementChild)a=a.firstElementChild;return a}).append(this)),this},wrapInner:function(a){return r.isFunction(a)?this.each(function(b){r(this).wrapInner(a.call(this,b))}):this.each(function(){var b=r(this),c=b.contents();c.length?c.wrapAll(a):b.append(a)})},wrap:function(a){var b=r.isFunction(a);return this.each(function(c){r(this).wrapAll(b?a.call(this,c):a)})},unwrap:function(a){return this.parent(a).not("body").each(function(){r(this).replaceWith(this.childNodes)}),this}}),r.expr.pseudos.hidden=function(a){return!r.expr.pseudos.visible(a)},r.expr.pseudos.visible=function(a){return!!(a.offsetWidth||a.offsetHeight||a.getClientRects().length)},r.ajaxSettings.xhr=function(){try{return new a.XMLHttpRequest}catch(b){}};var Rb={0:200,1223:204},Sb=r.ajaxSettings.xhr();o.cors=!!Sb&&"withCredentials"in Sb,o.ajax=Sb=!!Sb,r.ajaxTransport(function(b){var c,d;if(o.cors||Sb&&!b.crossDomain)return{send:function(e,f){var g,h=b.xhr();if(h.open(b.type,b.url,b.async,b.username,b.password),b.xhrFields)for(g in b.xhrFields)h[g]=b.xhrFields[g];b.mimeType&&h.overrideMimeType&&h.overrideMimeType(b.mimeType),b.crossDomain||e["X-Requested-With"]||(e["X-Requested-With"]="XMLHttpRequest");for(g in e)h.setRequestHeader(g,e[g]);c=function(a){return function(){c&&(c=d=h.onload=h.onerror=h.onabort=h.onreadystatechange=null,"abort"===a?h.abort():"error"===a?"number"!=typeof h.status?f(0,"error"):f(h.status,h.statusText):f(Rb[h.status]||h.status,h.statusText,"text"!==(h.responseType||"text")||"string"!=typeof h.responseText?{binary:h.response}:{text:h.responseText},h.getAllResponseHeaders()))}},h.onload=c(),d=h.onerror=c("error"),void 0!==h.onabort?h.onabort=d:h.onreadystatechange=function(){4===h.readyState&&a.setTimeout(function(){c&&d()})},c=c("abort");try{h.send(b.hasContent&&b.data||null)}catch(i){if(c)throw i}},abort:function(){c&&c()}}}),r.ajaxPrefilter(function(a){a.crossDomain&&(a.contents.script=!1)}),r.ajaxSetup({accepts:{script:"text/javascript, application/javascript, application/ecmascript, application/x-ecmascript"},contents:{script:/\b(?:java|ecma)script\b/},converters:{"text script":function(a){return r.globalEval(a),a}}}),r.ajaxPrefilter("script",function(a){void 0===a.cache&&(a.cache=!1),a.crossDomain&&(a.type="GET")}),r.ajaxTransport("script",function(a){if(a.crossDomain){var b,c;return{send:function(e,f){b=r("<script>").prop({charset:a.scriptCharset,src:a.url}).on("load error",c=function(a){b.remove(),c=null,a&&f("error"===a.type?404:200,a.type)}),d.head.appendChild(b[0])},abort:function(){c&&c()}}}});var Tb=[],Ub=/(=)\?(?=&|$)|\?\?/;r.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var a=Tb.pop()||r.expando+"_"+ub++;return this[a]=!0,a}}),r.ajaxPrefilter("json jsonp",function(b,c,d){var e,f,g,h=b.jsonp!==!1&&(Ub.test(b.url)?"url":"string"==typeof b.data&&0===(b.contentType||"").indexOf("application/x-www-form-urlencoded")&&Ub.test(b.data)&&"data");if(h||"jsonp"===b.dataTypes[0])return e=b.jsonpCallback=r.isFunction(b.jsonpCallback)?b.jsonpCallback():b.jsonpCallback,h?b[h]=b[h].replace(Ub,"$1"+e):b.jsonp!==!1&&(b.url+=(vb.test(b.url)?"&":"?")+b.jsonp+"="+e),b.converters["script json"]=function(){return g||r.error(e+" was not called"),g[0]},b.dataTypes[0]="json",f=a[e],a[e]=function(){g=arguments},d.always(function(){void 0===f?r(a).removeProp(e):a[e]=f,b[e]&&(b.jsonpCallback=c.jsonpCallback,Tb.push(e)),g&&r.isFunction(f)&&f(g[0]),g=f=void 0}),"script"}),o.createHTMLDocument=function(){var a=d.implementation.createHTMLDocument("").body;return a.innerHTML="<form></form><form></form>",2===a.childNodes.length}(),r.parseHTML=function(a,b,c){if("string"!=typeof a)return[];"boolean"==typeof b&&(c=b,b=!1);var e,f,g;return b||(o.createHTMLDocument?(b=d.implementation.createHTMLDocument(""),e=b.createElement("base"),e.href=d.location.href,b.head.appendChild(e)):b=d),f=C.exec(a),g=!c&&[],f?[b.createElement(f[1])]:(f=qa([a],b,g),g&&g.length&&r(g).remove(),r.merge([],f.childNodes))},r.fn.load=function(a,b,c){var d,e,f,g=this,h=a.indexOf(" ");return h>-1&&(d=pb(a.slice(h)),a=a.slice(0,h)),r.isFunction(b)?(c=b,b=void 0):b&&"object"==typeof b&&(e="POST"),g.length>0&&r.ajax({url:a,type:e||"GET",dataType:"html",data:b}).done(function(a){f=arguments,g.html(d?r("<div>").append(r.parseHTML(a)).find(d):a)}).always(c&&function(a,b){g.each(function(){c.apply(this,f||[a.responseText,b,a])})}),this},r.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(a,b){r.fn[b]=function(a){return this.on(b,a)}}),r.expr.pseudos.animated=function(a){return r.grep(r.timers,function(b){return a===b.elem}).length},r.offset={setOffset:function(a,b,c){var d,e,f,g,h,i,j,k=r.css(a,"position"),l=r(a),m={};"static"===k&&(a.style.position="relative"),h=l.offset(),f=r.css(a,"top"),i=r.css(a,"left"),j=("absolute"===k||"fixed"===k)&&(f+i).indexOf("auto")>-1,j?(d=l.position(),g=d.top,e=d.left):(g=parseFloat(f)||0,e=parseFloat(i)||0),r.isFunction(b)&&(b=b.call(a,c,r.extend({},h))),null!=b.top&&(m.top=b.top-h.top+g),null!=b.left&&(m.left=b.left-h.left+e),"using"in b?b.using.call(a,m):l.css(m)}},r.fn.extend({offset:function(a){if(arguments.length)return void 0===a?this:this.each(function(b){r.offset.setOffset(this,a,b)});var b,c,d,e,f=this[0];if(f)return f.getClientRects().length?(d=f.getBoundingClientRect(),b=f.ownerDocument,c=b.documentElement,e=b.defaultView,{top:d.top+e.pageYOffset-c.clientTop,left:d.left+e.pageXOffset-c.clientLeft}):{top:0,left:0}},position:function(){if(this[0]){var a,b,c=this[0],d={top:0,left:0};return"fixed"===r.css(c,"position")?b=c.getBoundingClientRect():(a=this.offsetParent(),b=this.offset(),B(a[0],"html")||(d=a.offset()),d={top:d.top+r.css(a[0],"borderTopWidth",!0),left:d.left+r.css(a[0],"borderLeftWidth",!0)}),{top:b.top-d.top-r.css(c,"marginTop",!0),left:b.left-d.left-r.css(c,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var a=this.offsetParent;while(a&&"static"===r.css(a,"position"))a=a.offsetParent;return a||ra})}}),r.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(a,b){var c="pageYOffset"===b;r.fn[a]=function(d){return T(this,function(a,d,e){var f;return r.isWindow(a)?f=a:9===a.nodeType&&(f=a.defaultView),void 0===e?f?f[b]:a[d]:void(f?f.scrollTo(c?f.pageXOffset:e,c?e:f.pageYOffset):a[d]=e)},a,d,arguments.length)}}),r.each(["top","left"],function(a,b){r.cssHooks[b]=Pa(o.pixelPosition,function(a,c){if(c)return c=Oa(a,b),Ma.test(c)?r(a).position()[b]+"px":c})}),r.each({Height:"height",Width:"width"},function(a,b){r.each({padding:"inner"+a,content:b,"":"outer"+a},function(c,d){r.fn[d]=function(e,f){var g=arguments.length&&(c||"boolean"!=typeof e),h=c||(e===!0||f===!0?"margin":"border");return T(this,function(b,c,e){var f;return r.isWindow(b)?0===d.indexOf("outer")?b["inner"+a]:b.document.documentElement["client"+a]:9===b.nodeType?(f=b.documentElement,Math.max(b.body["scroll"+a],f["scroll"+a],b.body["offset"+a],f["offset"+a],f["client"+a])):void 0===e?r.css(b,c,h):r.style(b,c,e,h)},b,g?e:void 0,g)}})}),r.fn.extend({bind:function(a,b,c){return this.on(a,null,b,c)},unbind:function(a,b){return this.off(a,null,b)},delegate:function(a,b,c,d){return this.on(b,a,c,d)},undelegate:function(a,b,c){return 1===arguments.length?this.off(a,"**"):this.off(b,a||"**",c)}}),r.holdReady=function(a){a?r.readyWait++:r.ready(!0)},r.isArray=Array.isArray,r.parseJSON=JSON.parse,r.nodeName=B,"function"==typeof define&&define.amd&&define("jquery",[],function(){return r});var Vb=a.jQuery,Wb=a.$;return r.noConflict=function(b){return a.$===r&&(a.$=Wb),b&&a.jQuery===r&&(a.jQuery=Vb),r},b||(a.jQuery=a.$=r),r});
+/*!
+ * jQuery JavaScript Library v3.1.1
+ * https://jquery.com/
+ *
+ * Includes Sizzle.js
+ * https://sizzlejs.com/
+ *
+ * Copyright jQuery Foundation and other contributors
+ * Released under the MIT license
+ * https://jquery.org/license
+ *
+ * Date: 2016-12-11T15:18Z
+ */
+( function( global, factory ) {
+
+ "use strict";
+
+ if ( typeof module === "object" && typeof module.exports === "object" ) {
+
+ // For CommonJS and CommonJS-like environments where a proper `window`
+ // is present, execute the factory and get jQuery.
+ // For environments that do not have a `window` with a `document`
+ // (such as Node.js), expose a factory as module.exports.
+ // This accentuates the need for the creation of a real `window`.
+ // e.g. var jQuery = require("jquery")(window);
+ // See ticket #14549 for more info.
+ module.exports = global.document ?
+ factory( global, true ) :
+ function( w ) {
+ if ( !w.document ) {
+ throw new Error( "jQuery requires a window with a document" );
+ }
+ return factory( w );
+ };
+ } else {
+ factory( global );
+ }
+
+// Pass this if window is not defined yet
+} )( typeof window !== "undefined" ? window : this, function( window, noGlobal ) {
+
+// Edge <= 12 - 13+, Firefox <=18 - 45+, IE 10 - 11, Safari 5.1 - 9+, iOS 6 - 9.1
+// throw exceptions when non-strict code (e.g., ASP.NET 4.5) accesses strict mode
+// arguments.callee.caller (trac-13335). But as of jQuery 3.0 (2016), strict mode should be common
+// enough that all such attempts are guarded in a try block.
+
+
+var arr = [];
+
+var document = window.document;
+
+var getProto = Object.getPrototypeOf;
+
+var slice = arr.slice;
+
+var concat = arr.concat;
+
+var push = arr.push;
+
+var indexOf = arr.indexOf;
+
+var class2type = {};
+
+var toString = class2type.toString;
+
+var hasOwn = class2type.hasOwnProperty;
+
+var fnToString = hasOwn.toString;
+
+var ObjectFunctionString = fnToString.call( Object );
+
+var support = {};
+
+
+
+ function DOMEval( code, doc ) {
+ doc = doc || document;
+
+ var script = doc.createElement( "script" );
+
+ script.text = code;
+ doc.head.appendChild( script ).parentNode.removeChild( script );
+ }
+/* global Symbol */
+// Defining this global in .eslintrc.json would create a danger of using the global
+// unguarded in another place, it seems safer to define global only for this module
+
+
+
+var
+ version = "3.1.1",
+
+ // Define a local copy of jQuery
+ jQuery = function( selector, context ) {
+
+ // The jQuery object is actually just the init constructor 'enhanced'
+ // Need init if jQuery is called (just allow error to be thrown if not included)
+ return new jQuery.fn.init( selector, context );
+ },
+
+ // Support: Android <=4.0 only
+ // Make sure we trim BOM and NBSP
+ rtrim = /^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g,
+
+ // Matches dashed string for camelizing
+ rmsPrefix = /^-ms-/,
+ rdashAlpha = /-([a-z])/g,
+
+ // Used by jQuery.camelCase as callback to replace()
+ fcamelCase = function( all, letter ) {
+ return letter.toUpperCase();
+ };
+
+jQuery.fn = jQuery.prototype = {
+
+ // The current version of jQuery being used
+ jquery: version,
+
+ constructor: jQuery,
+
+ // The default length of a jQuery object is 0
+ length: 0,
+
+ toArray: function() {
+ return slice.call( this );
+ },
+
+ // Get the Nth element in the matched element set OR
+ // Get the whole matched element set as a clean array
+ get: function( num ) {
+
+ // Return all the elements in a clean array
+ if ( num == null ) {
+ return slice.call( this );
+ }
+
+ // Return just the one element from the set
+ return num < 0 ? this[ num + this.length ] : this[ num ];
+ },
+
+ // Take an array of elements and push it onto the stack
+ // (returning the new matched element set)
+ pushStack: function( elems ) {
+
+ // Build a new jQuery matched element set
+ var ret = jQuery.merge( this.constructor(), elems );
+
+ // Add the old object onto the stack (as a reference)
+ ret.prevObject = this;
+
+ // Return the newly-formed element set
+ return ret;
+ },
+
+ // Execute a callback for every element in the matched set.
+ each: function( callback ) {
+ return jQuery.each( this, callback );
+ },
+
+ map: function( callback ) {
+ return this.pushStack( jQuery.map( this, function( elem, i ) {
+ return callback.call( elem, i, elem );
+ } ) );
+ },
+
+ slice: function() {
+ return this.pushStack( slice.apply( this, arguments ) );
+ },
+
+ first: function() {
+ return this.eq( 0 );
+ },
+
+ last: function() {
+ return this.eq( -1 );
+ },
+
+ eq: function( i ) {
+ var len = this.length,
+ j = +i + ( i < 0 ? len : 0 );
+ return this.pushStack( j >= 0 && j < len ? [ this[ j ] ] : [] );
+ },
+
+ end: function() {
+ return this.prevObject || this.constructor();
+ },
+
+ // For internal use only.
+ // Behaves like an Array's method, not like a jQuery method.
+ push: push,
+ sort: arr.sort,
+ splice: arr.splice
+};
+
+jQuery.extend = jQuery.fn.extend = function() {
+ var options, name, src, copy, copyIsArray, clone,
+ target = arguments[ 0 ] || {},
+ i = 1,
+ length = arguments.length,
+ deep = false;
+
+ // Handle a deep copy situation
+ if ( typeof target === "boolean" ) {
+ deep = target;
+
+ // Skip the boolean and the target
+ target = arguments[ i ] || {};
+ i++;
+ }
+
+ // Handle case when target is a string or something (possible in deep copy)
+ if ( typeof target !== "object" && !jQuery.isFunction( target ) ) {
+ target = {};
+ }
+
+ // Extend jQuery itself if only one argument is passed
+ if ( i === length ) {
+ target = this;
+ i--;
+ }
+
+ for ( ; i < length; i++ ) {
+
+ // Only deal with non-null/undefined values
+ if ( ( options = arguments[ i ] ) != null ) {
+
+ // Extend the base object
+ for ( name in options ) {
+ src = target[ name ];
+ copy = options[ name ];
+
+ // Prevent never-ending loop
+ if ( target === copy ) {
+ continue;
+ }
+
+ // Recurse if we're merging plain objects or arrays
+ if ( deep && copy && ( jQuery.isPlainObject( copy ) ||
+ ( copyIsArray = jQuery.isArray( copy ) ) ) ) {
+
+ if ( copyIsArray ) {
+ copyIsArray = false;
+ clone = src && jQuery.isArray( src ) ? src : [];
+
+ } else {
+ clone = src && jQuery.isPlainObject( src ) ? src : {};
+ }
+
+ // Never move original objects, clone them
+ target[ name ] = jQuery.extend( deep, clone, copy );
+
+ // Don't bring in undefined values
+ } else if ( copy !== undefined ) {
+ target[ name ] = copy;
+ }
+ }
+ }
+ }
+
+ // Return the modified object
+ return target;
+};
+
+jQuery.extend( {
+
+ // Unique for each copy of jQuery on the page
+ expando: "jQuery" + ( version + Math.random() ).replace( /\D/g, "" ),
+
+ // Assume jQuery is ready without the ready module
+ isReady: true,
+
+ error: function( msg ) {
+ throw new Error( msg );
+ },
+
+ noop: function() {},
+
+ isFunction: function( obj ) {
+ return jQuery.type( obj ) === "function";
+ },
+
+ isArray: Array.isArray,
+
+ isWindow: function( obj ) {
+ return obj != null && obj === obj.window;
+ },
+
+ isNumeric: function( obj ) {
+
+ // As of jQuery 3.0, isNumeric is limited to
+ // strings and numbers (primitives or objects)
+ // that can be coerced to finite numbers (gh-2662)
+ var type = jQuery.type( obj );
+ return ( type === "number" || type === "string" ) &&
+
+ // parseFloat NaNs numeric-cast false positives ("")
+ // ...but misinterprets leading-number strings, particularly hex literals ("0x...")
+ // subtraction forces infinities to NaN
+ !isNaN( obj - parseFloat( obj ) );
+ },
+
+ isPlainObject: function( obj ) {
+ var proto, Ctor;
+
+ // Detect obvious negatives
+ // Use toString instead of jQuery.type to catch host objects
+ if ( !obj || toString.call( obj ) !== "[object Object]" ) {
+ return false;
+ }
+
+ proto = getProto( obj );
+
+ // Objects with no prototype (e.g., `Object.create( null )`) are plain
+ if ( !proto ) {
+ return true;
+ }
+
+ // Objects with prototype are plain iff they were constructed by a global Object function
+ Ctor = hasOwn.call( proto, "constructor" ) && proto.constructor;
+ return typeof Ctor === "function" && fnToString.call( Ctor ) === ObjectFunctionString;
+ },
+
+ isEmptyObject: function( obj ) {
+
+ /* eslint-disable no-unused-vars */
+ // See https://github.com/eslint/eslint/issues/6125
+ var name;
+
+ for ( name in obj ) {
+ return false;
+ }
+ return true;
+ },
+
+ type: function( obj ) {
+ if ( obj == null ) {
+ return obj + "";
+ }
+
+ // Support: Android <=2.3 only (functionish RegExp)
+ return typeof obj === "object" || typeof obj === "function" ?
+ class2type[ toString.call( obj ) ] || "object" :
+ typeof obj;
+ },
+
+ // Evaluates a script in a global context
+ globalEval: function( code ) {
+ DOMEval( code );
+ },
+
+ // Convert dashed to camelCase; used by the css and data modules
+ // Support: IE <=9 - 11, Edge 12 - 13
+ // Microsoft forgot to hump their vendor prefix (#9572)
+ camelCase: function( string ) {
+ return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase );
+ },
+
+ nodeName: function( elem, name ) {
+ return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase();
+ },
+
+ each: function( obj, callback ) {
+ var length, i = 0;
+
+ if ( isArrayLike( obj ) ) {
+ length = obj.length;
+ for ( ; i < length; i++ ) {
+ if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) {
+ break;
+ }
+ }
+ } else {
+ for ( i in obj ) {
+ if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) {
+ break;
+ }
+ }
+ }
+
+ return obj;
+ },
+
+ // Support: Android <=4.0 only
+ trim: function( text ) {
+ return text == null ?
+ "" :
+ ( text + "" ).replace( rtrim, "" );
+ },
+
+ // results is for internal usage only
+ makeArray: function( arr, results ) {
+ var ret = results || [];
+
+ if ( arr != null ) {
+ if ( isArrayLike( Object( arr ) ) ) {
+ jQuery.merge( ret,
+ typeof arr === "string" ?
+ [ arr ] : arr
+ );
+ } else {
+ push.call( ret, arr );
+ }
+ }
+
+ return ret;
+ },
+
+ inArray: function( elem, arr, i ) {
+ return arr == null ? -1 : indexOf.call( arr, elem, i );
+ },
+
+ // Support: Android <=4.0 only, PhantomJS 1 only
+ // push.apply(_, arraylike) throws on ancient WebKit
+ merge: function( first, second ) {
+ var len = +second.length,
+ j = 0,
+ i = first.length;
+
+ for ( ; j < len; j++ ) {
+ first[ i++ ] = second[ j ];
+ }
+
+ first.length = i;
+
+ return first;
+ },
+
+ grep: function( elems, callback, invert ) {
+ var callbackInverse,
+ matches = [],
+ i = 0,
+ length = elems.length,
+ callbackExpect = !invert;
+
+ // Go through the array, only saving the items
+ // that pass the validator function
+ for ( ; i < length; i++ ) {
+ callbackInverse = !callback( elems[ i ], i );
+ if ( callbackInverse !== callbackExpect ) {
+ matches.push( elems[ i ] );
+ }
+ }
+
+ return matches;
+ },
+
+ // arg is for internal usage only
+ map: function( elems, callback, arg ) {
+ var length, value,
+ i = 0,
+ ret = [];
+
+ // Go through the array, translating each of the items to their new values
+ if ( isArrayLike( elems ) ) {
+ length = elems.length;
+ for ( ; i < length; i++ ) {
+ value = callback( elems[ i ], i, arg );
+
+ if ( value != null ) {
+ ret.push( value );
+ }
+ }
+
+ // Go through every key on the object,
+ } else {
+ for ( i in elems ) {
+ value = callback( elems[ i ], i, arg );
+
+ if ( value != null ) {
+ ret.push( value );
+ }
+ }
+ }
+
+ // Flatten any nested arrays
+ return concat.apply( [], ret );
+ },
+
+ // A global GUID counter for objects
+ guid: 1,
+
+ // Bind a function to a context, optionally partially applying any
+ // arguments.
+ proxy: function( fn, context ) {
+ var tmp, args, proxy;
+
+ if ( typeof context === "string" ) {
+ tmp = fn[ context ];
+ context = fn;
+ fn = tmp;
+ }
+
+ // Quick check to determine if target is callable, in the spec
+ // this throws a TypeError, but we will just return undefined.
+ if ( !jQuery.isFunction( fn ) ) {
+ return undefined;
+ }
+
+ // Simulated bind
+ args = slice.call( arguments, 2 );
+ proxy = function() {
+ return fn.apply( context || this, args.concat( slice.call( arguments ) ) );
+ };
+
+ // Set the guid of unique handler to the same of original handler, so it can be removed
+ proxy.guid = fn.guid = fn.guid || jQuery.guid++;
+
+ return proxy;
+ },
+
+ now: Date.now,
+
+ // jQuery.support is not used in Core but other projects attach their
+ // properties to it so it needs to exist.
+ support: support
+} );
+
+if ( typeof Symbol === "function" ) {
+ jQuery.fn[ Symbol.iterator ] = arr[ Symbol.iterator ];
+}
+
+// Populate the class2type map
+jQuery.each( "Boolean Number String Function Array Date RegExp Object Error Symbol".split( " " ),
+function( i, name ) {
+ class2type[ "[object " + name + "]" ] = name.toLowerCase();
+} );
+
+function isArrayLike( obj ) {
+
+ // Support: real iOS 8.2 only (not reproducible in simulator)
+ // `in` check used to prevent JIT error (gh-2145)
+ // hasOwn isn't used here due to false negatives
+ // regarding Nodelist length in IE
+ var length = !!obj && "length" in obj && obj.length,
+ type = jQuery.type( obj );
+
+ if ( type === "function" || jQuery.isWindow( obj ) ) {
+ return false;
+ }
+
+ return type === "array" || length === 0 ||
+ typeof length === "number" && length > 0 && ( length - 1 ) in obj;
+}
+var Sizzle =
+/*!
+ * Sizzle CSS Selector Engine v2.3.3
+ * https://sizzlejs.com/
+ *
+ * Copyright jQuery Foundation and other contributors
+ * Released under the MIT license
+ * http://jquery.org/license
+ *
+ * Date: 2016-08-08
+ */
+(function( window ) {
+
+var i,
+ support,
+ Expr,
+ getText,
+ isXML,
+ tokenize,
+ compile,
+ select,
+ outermostContext,
+ sortInput,
+ hasDuplicate,
+
+ // Local document vars
+ setDocument,
+ document,
+ docElem,
+ documentIsHTML,
+ rbuggyQSA,
+ rbuggyMatches,
+ matches,
+ contains,
+
+ // Instance-specific data
+ expando = "sizzle" + 1 * new Date(),
+ preferredDoc = window.document,
+ dirruns = 0,
+ done = 0,
+ classCache = createCache(),
+ tokenCache = createCache(),
+ compilerCache = createCache(),
+ sortOrder = function( a, b ) {
+ if ( a === b ) {
+ hasDuplicate = true;
+ }
+ return 0;
+ },
+
+ // Instance methods
+ hasOwn = ({}).hasOwnProperty,
+ arr = [],
+ pop = arr.pop,
+ push_native = arr.push,
+ push = arr.push,
+ slice = arr.slice,
+ // Use a stripped-down indexOf as it's faster than native
+ // https://jsperf.com/thor-indexof-vs-for/5
+ indexOf = function( list, elem ) {
+ var i = 0,
+ len = list.length;
+ for ( ; i < len; i++ ) {
+ if ( list[i] === elem ) {
+ return i;
+ }
+ }
+ return -1;
+ },
+
+ booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|ismap|loop|multiple|open|readonly|required|scoped",
+
+ // Regular expressions
+
+ // http://www.w3.org/TR/css3-selectors/#whitespace
+ whitespace = "[\\x20\\t\\r\\n\\f]",
+
+ // http://www.w3.org/TR/CSS21/syndata.html#value-def-identifier
+ identifier = "(?:\\\\.|[\\w-]|[^\0-\\xa0])+",
+
+ // Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors
+ attributes = "\\[" + whitespace + "*(" + identifier + ")(?:" + whitespace +
+ // Operator (capture 2)
+ "*([*^$|!~]?=)" + whitespace +
+ // "Attribute values must be CSS identifiers [capture 5] or strings [capture 3 or capture 4]"
+ "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" + whitespace +
+ "*\\]",
+
+ pseudos = ":(" + identifier + ")(?:\\((" +
+ // To reduce the number of selectors needing tokenize in the preFilter, prefer arguments:
+ // 1. quoted (capture 3; capture 4 or capture 5)
+ "('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|" +
+ // 2. simple (capture 6)
+ "((?:\\\\.|[^\\\\()[\\]]|" + attributes + ")*)|" +
+ // 3. anything else (capture 2)
+ ".*" +
+ ")\\)|)",
+
+ // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter
+ rwhitespace = new RegExp( whitespace + "+", "g" ),
+ rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + whitespace + "+$", "g" ),
+
+ rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ),
+ rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace + "*" ),
+
+ rattributeQuotes = new RegExp( "=" + whitespace + "*([^\\]'\"]*?)" + whitespace + "*\\]", "g" ),
+
+ rpseudo = new RegExp( pseudos ),
+ ridentifier = new RegExp( "^" + identifier + "$" ),
+
+ matchExpr = {
+ "ID": new RegExp( "^#(" + identifier + ")" ),
+ "CLASS": new RegExp( "^\\.(" + identifier + ")" ),
+ "TAG": new RegExp( "^(" + identifier + "|[*])" ),
+ "ATTR": new RegExp( "^" + attributes ),
+ "PSEUDO": new RegExp( "^" + pseudos ),
+ "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" + whitespace +
+ "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" + whitespace +
+ "*(\\d+)|))" + whitespace + "*\\)|)", "i" ),
+ "bool": new RegExp( "^(?:" + booleans + ")$", "i" ),
+ // For use in libraries implementing .is()
+ // We use this for POS matching in `select`
+ "needsContext": new RegExp( "^" + whitespace + "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" +
+ whitespace + "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" )
+ },
+
+ rinputs = /^(?:input|select|textarea|button)$/i,
+ rheader = /^h\d$/i,
+
+ rnative = /^[^{]+\{\s*\[native \w/,
+
+ // Easily-parseable/retrievable ID or TAG or CLASS selectors
+ rquickExpr = /^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,
+
+ rsibling = /[+~]/,
+
+ // CSS escapes
+ // http://www.w3.org/TR/CSS21/syndata.html#escaped-characters
+ runescape = new RegExp( "\\\\([\\da-f]{1,6}" + whitespace + "?|(" + whitespace + ")|.)", "ig" ),
+ funescape = function( _, escaped, escapedWhitespace ) {
+ var high = "0x" + escaped - 0x10000;
+ // NaN means non-codepoint
+ // Support: Firefox<24
+ // Workaround erroneous numeric interpretation of +"0x"
+ return high !== high || escapedWhitespace ?
+ escaped :
+ high < 0 ?
+ // BMP codepoint
+ String.fromCharCode( high + 0x10000 ) :
+ // Supplemental Plane codepoint (surrogate pair)
+ String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 );
+ },
+
+ // CSS string/identifier serialization
+ // https://drafts.csswg.org/cssom/#common-serializing-idioms
+ rcssescape = /([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,
+ fcssescape = function( ch, asCodePoint ) {
+ if ( asCodePoint ) {
+
+ // U+0000 NULL becomes U+FFFD REPLACEMENT CHARACTER
+ if ( ch === "\0" ) {
+ return "\uFFFD";
+ }
+
+ // Control characters and (dependent upon position) numbers get escaped as code points
+ return ch.slice( 0, -1 ) + "\\" + ch.charCodeAt( ch.length - 1 ).toString( 16 ) + " ";
+ }
+
+ // Other potentially-special ASCII characters get backslash-escaped
+ return "\\" + ch;
+ },
+
+ // Used for iframes
+ // See setDocument()
+ // Removing the function wrapper causes a "Permission Denied"
+ // error in IE
+ unloadHandler = function() {
+ setDocument();
+ },
+
+ disabledAncestor = addCombinator(
+ function( elem ) {
+ return elem.disabled === true && ("form" in elem || "label" in elem);
+ },
+ { dir: "parentNode", next: "legend" }
+ );
+
+// Optimize for push.apply( _, NodeList )
+try {
+ push.apply(
+ (arr = slice.call( preferredDoc.childNodes )),
+ preferredDoc.childNodes
+ );
+ // Support: Android<4.0
+ // Detect silently failing push.apply
+ arr[ preferredDoc.childNodes.length ].nodeType;
+} catch ( e ) {
+ push = { apply: arr.length ?
+
+ // Leverage slice if possible
+ function( target, els ) {
+ push_native.apply( target, slice.call(els) );
+ } :
+
+ // Support: IE<9
+ // Otherwise append directly
+ function( target, els ) {
+ var j = target.length,
+ i = 0;
+ // Can't trust NodeList.length
+ while ( (target[j++] = els[i++]) ) {}
+ target.length = j - 1;
+ }
+ };
+}
+
+function Sizzle( selector, context, results, seed ) {
+ var m, i, elem, nid, match, groups, newSelector,
+ newContext = context && context.ownerDocument,
+
+ // nodeType defaults to 9, since context defaults to document
+ nodeType = context ? context.nodeType : 9;
+
+ results = results || [];
+
+ // Return early from calls with invalid selector or context
+ if ( typeof selector !== "string" || !selector ||
+ nodeType !== 1 && nodeType !== 9 && nodeType !== 11 ) {
+
+ return results;
+ }
+
+ // Try to shortcut find operations (as opposed to filters) in HTML documents
+ if ( !seed ) {
+
+ if ( ( context ? context.ownerDocument || context : preferredDoc ) !== document ) {
+ setDocument( context );
+ }
+ context = context || document;
+
+ if ( documentIsHTML ) {
+
+ // If the selector is sufficiently simple, try using a "get*By*" DOM method
+ // (excepting DocumentFragment context, where the methods don't exist)
+ if ( nodeType !== 11 && (match = rquickExpr.exec( selector )) ) {
+
+ // ID selector
+ if ( (m = match[1]) ) {
+
+ // Document context
+ if ( nodeType === 9 ) {
+ if ( (elem = context.getElementById( m )) ) {
+
+ // Support: IE, Opera, Webkit
+ // TODO: identify versions
+ // getElementById can match elements by name instead of ID
+ if ( elem.id === m ) {
+ results.push( elem );
+ return results;
+ }
+ } else {
+ return results;
+ }
+
+ // Element context
+ } else {
+
+ // Support: IE, Opera, Webkit
+ // TODO: identify versions
+ // getElementById can match elements by name instead of ID
+ if ( newContext && (elem = newContext.getElementById( m )) &&
+ contains( context, elem ) &&
+ elem.id === m ) {
+
+ results.push( elem );
+ return results;
+ }
+ }
+
+ // Type selector
+ } else if ( match[2] ) {
+ push.apply( results, context.getElementsByTagName( selector ) );
+ return results;
+
+ // Class selector
+ } else if ( (m = match[3]) && support.getElementsByClassName &&
+ context.getElementsByClassName ) {
+
+ push.apply( results, context.getElementsByClassName( m ) );
+ return results;
+ }
+ }
+
+ // Take advantage of querySelectorAll
+ if ( support.qsa &&
+ !compilerCache[ selector + " " ] &&
+ (!rbuggyQSA || !rbuggyQSA.test( selector )) ) {
+
+ if ( nodeType !== 1 ) {
+ newContext = context;
+ newSelector = selector;
+
+ // qSA looks outside Element context, which is not what we want
+ // Thanks to Andrew Dupont for this workaround technique
+ // Support: IE <=8
+ // Exclude object elements
+ } else if ( context.nodeName.toLowerCase() !== "object" ) {
+
+ // Capture the context ID, setting it first if necessary
+ if ( (nid = context.getAttribute( "id" )) ) {
+ nid = nid.replace( rcssescape, fcssescape );
+ } else {
+ context.setAttribute( "id", (nid = expando) );
+ }
+
+ // Prefix every selector in the list
+ groups = tokenize( selector );
+ i = groups.length;
+ while ( i-- ) {
+ groups[i] = "#" + nid + " " + toSelector( groups[i] );
+ }
+ newSelector = groups.join( "," );
+
+ // Expand context for sibling selectors
+ newContext = rsibling.test( selector ) && testContext( context.parentNode ) ||
+ context;
+ }
+
+ if ( newSelector ) {
+ try {
+ push.apply( results,
+ newContext.querySelectorAll( newSelector )
+ );
+ return results;
+ } catch ( qsaError ) {
+ } finally {
+ if ( nid === expando ) {
+ context.removeAttribute( "id" );
+ }
+ }
+ }
+ }
+ }
+ }
+
+ // All others
+ return select( selector.replace( rtrim, "$1" ), context, results, seed );
+}
+
+/**
+ * Create key-value caches of limited size
+ * @returns {function(string, object)} Returns the Object data after storing it on itself with
+ * property name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength)
+ * deleting the oldest entry
+ */
+function createCache() {
+ var keys = [];
+
+ function cache( key, value ) {
+ // Use (key + " ") to avoid collision with native prototype properties (see Issue #157)
+ if ( keys.push( key + " " ) > Expr.cacheLength ) {
+ // Only keep the most recent entries
+ delete cache[ keys.shift() ];
+ }
+ return (cache[ key + " " ] = value);
+ }
+ return cache;
+}
+
+/**
+ * Mark a function for special use by Sizzle
+ * @param {Function} fn The function to mark
+ */
+function markFunction( fn ) {
+ fn[ expando ] = true;
+ return fn;
+}
+
+/**
+ * Support testing using an element
+ * @param {Function} fn Passed the created element and returns a boolean result
+ */
+function assert( fn ) {
+ var el = document.createElement("fieldset");
+
+ try {
+ return !!fn( el );
+ } catch (e) {
+ return false;
+ } finally {
+ // Remove from its parent by default
+ if ( el.parentNode ) {
+ el.parentNode.removeChild( el );
+ }
+ // release memory in IE
+ el = null;
+ }
+}
+
+/**
+ * Adds the same handler for all of the specified attrs
+ * @param {String} attrs Pipe-separated list of attributes
+ * @param {Function} handler The method that will be applied
+ */
+function addHandle( attrs, handler ) {
+ var arr = attrs.split("|"),
+ i = arr.length;
+
+ while ( i-- ) {
+ Expr.attrHandle[ arr[i] ] = handler;
+ }
+}
+
+/**
+ * Checks document order of two siblings
+ * @param {Element} a
+ * @param {Element} b
+ * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b
+ */
+function siblingCheck( a, b ) {
+ var cur = b && a,
+ diff = cur && a.nodeType === 1 && b.nodeType === 1 &&
+ a.sourceIndex - b.sourceIndex;
+
+ // Use IE sourceIndex if available on both nodes
+ if ( diff ) {
+ return diff;
+ }
+
+ // Check if b follows a
+ if ( cur ) {
+ while ( (cur = cur.nextSibling) ) {
+ if ( cur === b ) {
+ return -1;
+ }
+ }
+ }
+
+ return a ? 1 : -1;
+}
+
+/**
+ * Returns a function to use in pseudos for input types
+ * @param {String} type
+ */
+function createInputPseudo( type ) {
+ return function( elem ) {
+ var name = elem.nodeName.toLowerCase();
+ return name === "input" && elem.type === type;
+ };
+}
+
+/**
+ * Returns a function to use in pseudos for buttons
+ * @param {String} type
+ */
+function createButtonPseudo( type ) {
+ return function( elem ) {
+ var name = elem.nodeName.toLowerCase();
+ return (name === "input" || name === "button") && elem.type === type;
+ };
+}
+
+/**
+ * Returns a function to use in pseudos for :enabled/:disabled
+ * @param {Boolean} disabled true for :disabled; false for :enabled
+ */
+function createDisabledPseudo( disabled ) {
+
+ // Known :disabled false positives: fieldset[disabled] > legend:nth-of-type(n+2) :can-disable
+ return function( elem ) {
+
+ // Only certain elements can match :enabled or :disabled
+ // https://html.spec.whatwg.org/multipage/scripting.html#selector-enabled
+ // https://html.spec.whatwg.org/multipage/scripting.html#selector-disabled
+ if ( "form" in elem ) {
+
+ // Check for inherited disabledness on relevant non-disabled elements:
+ // * listed form-associated elements in a disabled fieldset
+ // https://html.spec.whatwg.org/multipage/forms.html#category-listed
+ // https://html.spec.whatwg.org/multipage/forms.html#concept-fe-disabled
+ // * option elements in a disabled optgroup
+ // https://html.spec.whatwg.org/multipage/forms.html#concept-option-disabled
+ // All such elements have a "form" property.
+ if ( elem.parentNode && elem.disabled === false ) {
+
+ // Option elements defer to a parent optgroup if present
+ if ( "label" in elem ) {
+ if ( "label" in elem.parentNode ) {
+ return elem.parentNode.disabled === disabled;
+ } else {
+ return elem.disabled === disabled;
+ }
+ }
+
+ // Support: IE 6 - 11
+ // Use the isDisabled shortcut property to check for disabled fieldset ancestors
+ return elem.isDisabled === disabled ||
+
+ // Where there is no isDisabled, check manually
+ /* jshint -W018 */
+ elem.isDisabled !== !disabled &&
+ disabledAncestor( elem ) === disabled;
+ }
+
+ return elem.disabled === disabled;
+
+ // Try to winnow out elements that can't be disabled before trusting the disabled property.
+ // Some victims get caught in our net (label, legend, menu, track), but it shouldn't
+ // even exist on them, let alone have a boolean value.
+ } else if ( "label" in elem ) {
+ return elem.disabled === disabled;
+ }
+
+ // Remaining elements are neither :enabled nor :disabled
+ return false;
+ };
+}
+
+/**
+ * Returns a function to use in pseudos for positionals
+ * @param {Function} fn
+ */
+function createPositionalPseudo( fn ) {
+ return markFunction(function( argument ) {
+ argument = +argument;
+ return markFunction(function( seed, matches ) {
+ var j,
+ matchIndexes = fn( [], seed.length, argument ),
+ i = matchIndexes.length;
+
+ // Match elements found at the specified indexes
+ while ( i-- ) {
+ if ( seed[ (j = matchIndexes[i]) ] ) {
+ seed[j] = !(matches[j] = seed[j]);
+ }
+ }
+ });
+ });
+}
+
+/**
+ * Checks a node for validity as a Sizzle context
+ * @param {Element|Object=} context
+ * @returns {Element|Object|Boolean} The input node if acceptable, otherwise a falsy value
+ */
+function testContext( context ) {
+ return context && typeof context.getElementsByTagName !== "undefined" && context;
+}
+
+// Expose support vars for convenience
+support = Sizzle.support = {};
+
+/**
+ * Detects XML nodes
+ * @param {Element|Object} elem An element or a document
+ * @returns {Boolean} True iff elem is a non-HTML XML node
+ */
+isXML = Sizzle.isXML = function( elem ) {
+ // documentElement is verified for cases where it doesn't yet exist
+ // (such as loading iframes in IE - #4833)
+ var documentElement = elem && (elem.ownerDocument || elem).documentElement;
+ return documentElement ? documentElement.nodeName !== "HTML" : false;
+};
+
+/**
+ * Sets document-related variables once based on the current document
+ * @param {Element|Object} [doc] An element or document object to use to set the document
+ * @returns {Object} Returns the current document
+ */
+setDocument = Sizzle.setDocument = function( node ) {
+ var hasCompare, subWindow,
+ doc = node ? node.ownerDocument || node : preferredDoc;
+
+ // Return early if doc is invalid or already selected
+ if ( doc === document || doc.nodeType !== 9 || !doc.documentElement ) {
+ return document;
+ }
+
+ // Update global variables
+ document = doc;
+ docElem = document.documentElement;
+ documentIsHTML = !isXML( document );
+
+ // Support: IE 9-11, Edge
+ // Accessing iframe documents after unload throws "permission denied" errors (jQuery #13936)
+ if ( preferredDoc !== document &&
+ (subWindow = document.defaultView) && subWindow.top !== subWindow ) {
+
+ // Support: IE 11, Edge
+ if ( subWindow.addEventListener ) {
+ subWindow.addEventListener( "unload", unloadHandler, false );
+
+ // Support: IE 9 - 10 only
+ } else if ( subWindow.attachEvent ) {
+ subWindow.attachEvent( "onunload", unloadHandler );
+ }
+ }
+
+ /* Attributes
+ ---------------------------------------------------------------------- */
+
+ // Support: IE<8
+ // Verify that getAttribute really returns attributes and not properties
+ // (excepting IE8 booleans)
+ support.attributes = assert(function( el ) {
+ el.className = "i";
+ return !el.getAttribute("className");
+ });
+
+ /* getElement(s)By*
+ ---------------------------------------------------------------------- */
+
+ // Check if getElementsByTagName("*") returns only elements
+ support.getElementsByTagName = assert(function( el ) {
+ el.appendChild( document.createComment("") );
+ return !el.getElementsByTagName("*").length;
+ });
+
+ // Support: IE<9
+ support.getElementsByClassName = rnative.test( document.getElementsByClassName );
+
+ // Support: IE<10
+ // Check if getElementById returns elements by name
+ // The broken getElementById methods don't pick up programmatically-set names,
+ // so use a roundabout getElementsByName test
+ support.getById = assert(function( el ) {
+ docElem.appendChild( el ).id = expando;
+ return !document.getElementsByName || !document.getElementsByName( expando ).length;
+ });
+
+ // ID filter and find
+ if ( support.getById ) {
+ Expr.filter["ID"] = function( id ) {
+ var attrId = id.replace( runescape, funescape );
+ return function( elem ) {
+ return elem.getAttribute("id") === attrId;
+ };
+ };
+ Expr.find["ID"] = function( id, context ) {
+ if ( typeof context.getElementById !== "undefined" && documentIsHTML ) {
+ var elem = context.getElementById( id );
+ return elem ? [ elem ] : [];
+ }
+ };
+ } else {
+ Expr.filter["ID"] = function( id ) {
+ var attrId = id.replace( runescape, funescape );
+ return function( elem ) {
+ var node = typeof elem.getAttributeNode !== "undefined" &&
+ elem.getAttributeNode("id");
+ return node && node.value === attrId;
+ };
+ };
+
+ // Support: IE 6 - 7 only
+ // getElementById is not reliable as a find shortcut
+ Expr.find["ID"] = function( id, context ) {
+ if ( typeof context.getElementById !== "undefined" && documentIsHTML ) {
+ var node, i, elems,
+ elem = context.getElementById( id );
+
+ if ( elem ) {
+
+ // Verify the id attribute
+ node = elem.getAttributeNode("id");
+ if ( node && node.value === id ) {
+ return [ elem ];
+ }
+
+ // Fall back on getElementsByName
+ elems = context.getElementsByName( id );
+ i = 0;
+ while ( (elem = elems[i++]) ) {
+ node = elem.getAttributeNode("id");
+ if ( node && node.value === id ) {
+ return [ elem ];
+ }
+ }
+ }
+
+ return [];
+ }
+ };
+ }
+
+ // Tag
+ Expr.find["TAG"] = support.getElementsByTagName ?
+ function( tag, context ) {
+ if ( typeof context.getElementsByTagName !== "undefined" ) {
+ return context.getElementsByTagName( tag );
+
+ // DocumentFragment nodes don't have gEBTN
+ } else if ( support.qsa ) {
+ return context.querySelectorAll( tag );
+ }
+ } :
+
+ function( tag, context ) {
+ var elem,
+ tmp = [],
+ i = 0,
+ // By happy coincidence, a (broken) gEBTN appears on DocumentFragment nodes too
+ results = context.getElementsByTagName( tag );
+
+ // Filter out possible comments
+ if ( tag === "*" ) {
+ while ( (elem = results[i++]) ) {
+ if ( elem.nodeType === 1 ) {
+ tmp.push( elem );
+ }
+ }
+
+ return tmp;
+ }
+ return results;
+ };
+
+ // Class
+ Expr.find["CLASS"] = support.getElementsByClassName && function( className, context ) {
+ if ( typeof context.getElementsByClassName !== "undefined" && documentIsHTML ) {
+ return context.getElementsByClassName( className );
+ }
+ };
+
+ /* QSA/matchesSelector
+ ---------------------------------------------------------------------- */
+
+ // QSA and matchesSelector support
+
+ // matchesSelector(:active) reports false when true (IE9/Opera 11.5)
+ rbuggyMatches = [];
+
+ // qSa(:focus) reports false when true (Chrome 21)
+ // We allow this because of a bug in IE8/9 that throws an error
+ // whenever `document.activeElement` is accessed on an iframe
+ // So, we allow :focus to pass through QSA all the time to avoid the IE error
+ // See https://bugs.jquery.com/ticket/13378
+ rbuggyQSA = [];
+
+ if ( (support.qsa = rnative.test( document.querySelectorAll )) ) {
+ // Build QSA regex
+ // Regex strategy adopted from Diego Perini
+ assert(function( el ) {
+ // Select is set to empty string on purpose
+ // This is to test IE's treatment of not explicitly
+ // setting a boolean content attribute,
+ // since its presence should be enough
+ // https://bugs.jquery.com/ticket/12359
+ docElem.appendChild( el ).innerHTML = "<a id='" + expando + "'></a>" +
+ "<select id='" + expando + "-\r\\' msallowcapture=''>" +
+ "<option selected=''></option></select>";
+
+ // Support: IE8, Opera 11-12.16
+ // Nothing should be selected when empty strings follow ^= or $= or *=
+ // The test attribute must be unknown in Opera but "safe" for WinRT
+ // https://msdn.microsoft.com/en-us/library/ie/hh465388.aspx#attribute_section
+ if ( el.querySelectorAll("[msallowcapture^='']").length ) {
+ rbuggyQSA.push( "[*^$]=" + whitespace + "*(?:''|\"\")" );
+ }
+
+ // Support: IE8
+ // Boolean attributes and "value" are not treated correctly
+ if ( !el.querySelectorAll("[selected]").length ) {
+ rbuggyQSA.push( "\\[" + whitespace + "*(?:value|" + booleans + ")" );
+ }
+
+ // Support: Chrome<29, Android<4.4, Safari<7.0+, iOS<7.0+, PhantomJS<1.9.8+
+ if ( !el.querySelectorAll( "[id~=" + expando + "-]" ).length ) {
+ rbuggyQSA.push("~=");
+ }
+
+ // Webkit/Opera - :checked should return selected option elements
+ // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked
+ // IE8 throws error here and will not see later tests
+ if ( !el.querySelectorAll(":checked").length ) {
+ rbuggyQSA.push(":checked");
+ }
+
+ // Support: Safari 8+, iOS 8+
+ // https://bugs.webkit.org/show_bug.cgi?id=136851
+ // In-page `selector#id sibling-combinator selector` fails
+ if ( !el.querySelectorAll( "a#" + expando + "+*" ).length ) {
+ rbuggyQSA.push(".#.+[+~]");
+ }
+ });
+
+ assert(function( el ) {
+ el.innerHTML = "<a href='' disabled='disabled'></a>" +
+ "<select disabled='disabled'><option/></select>";
+
+ // Support: Windows 8 Native Apps
+ // The type and name attributes are restricted during .innerHTML assignment
+ var input = document.createElement("input");
+ input.setAttribute( "type", "hidden" );
+ el.appendChild( input ).setAttribute( "name", "D" );
+
+ // Support: IE8
+ // Enforce case-sensitivity of name attribute
+ if ( el.querySelectorAll("[name=d]").length ) {
+ rbuggyQSA.push( "name" + whitespace + "*[*^$|!~]?=" );
+ }
+
+ // FF 3.5 - :enabled/:disabled and hidden elements (hidden elements are still enabled)
+ // IE8 throws error here and will not see later tests
+ if ( el.querySelectorAll(":enabled").length !== 2 ) {
+ rbuggyQSA.push( ":enabled", ":disabled" );
+ }
+
+ // Support: IE9-11+
+ // IE's :disabled selector does not pick up the children of disabled fieldsets
+ docElem.appendChild( el ).disabled = true;
+ if ( el.querySelectorAll(":disabled").length !== 2 ) {
+ rbuggyQSA.push( ":enabled", ":disabled" );
+ }
+
+ // Opera 10-11 does not throw on post-comma invalid pseudos
+ el.querySelectorAll("*,:x");
+ rbuggyQSA.push(",.*:");
+ });
+ }
+
+ if ( (support.matchesSelector = rnative.test( (matches = docElem.matches ||
+ docElem.webkitMatchesSelector ||
+ docElem.mozMatchesSelector ||
+ docElem.oMatchesSelector ||
+ docElem.msMatchesSelector) )) ) {
+
+ assert(function( el ) {
+ // Check to see if it's possible to do matchesSelector
+ // on a disconnected node (IE 9)
+ support.disconnectedMatch = matches.call( el, "*" );
+
+ // This should fail with an exception
+ // Gecko does not error, returns false instead
+ matches.call( el, "[s!='']:x" );
+ rbuggyMatches.push( "!=", pseudos );
+ });
+ }
+
+ rbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join("|") );
+ rbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join("|") );
+
+ /* Contains
+ ---------------------------------------------------------------------- */
+ hasCompare = rnative.test( docElem.compareDocumentPosition );
+
+ // Element contains another
+ // Purposefully self-exclusive
+ // As in, an element does not contain itself
+ contains = hasCompare || rnative.test( docElem.contains ) ?
+ function( a, b ) {
+ var adown = a.nodeType === 9 ? a.documentElement : a,
+ bup = b && b.parentNode;
+ return a === bup || !!( bup && bup.nodeType === 1 && (
+ adown.contains ?
+ adown.contains( bup ) :
+ a.compareDocumentPosition && a.compareDocumentPosition( bup ) & 16
+ ));
+ } :
+ function( a, b ) {
+ if ( b ) {
+ while ( (b = b.parentNode) ) {
+ if ( b === a ) {
+ return true;
+ }
+ }
+ }
+ return false;
+ };
+
+ /* Sorting
+ ---------------------------------------------------------------------- */
+
+ // Document order sorting
+ sortOrder = hasCompare ?
+ function( a, b ) {
+
+ // Flag for duplicate removal
+ if ( a === b ) {
+ hasDuplicate = true;
+ return 0;
+ }
+
+ // Sort on method existence if only one input has compareDocumentPosition
+ var compare = !a.compareDocumentPosition - !b.compareDocumentPosition;
+ if ( compare ) {
+ return compare;
+ }
+
+ // Calculate position if both inputs belong to the same document
+ compare = ( a.ownerDocument || a ) === ( b.ownerDocument || b ) ?
+ a.compareDocumentPosition( b ) :
+
+ // Otherwise we know they are disconnected
+ 1;
+
+ // Disconnected nodes
+ if ( compare & 1 ||
+ (!support.sortDetached && b.compareDocumentPosition( a ) === compare) ) {
+
+ // Choose the first element that is related to our preferred document
+ if ( a === document || a.ownerDocument === preferredDoc && contains(preferredDoc, a) ) {
+ return -1;
+ }
+ if ( b === document || b.ownerDocument === preferredDoc && contains(preferredDoc, b) ) {
+ return 1;
+ }
+
+ // Maintain original order
+ return sortInput ?
+ ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) :
+ 0;
+ }
+
+ return compare & 4 ? -1 : 1;
+ } :
+ function( a, b ) {
+ // Exit early if the nodes are identical
+ if ( a === b ) {
+ hasDuplicate = true;
+ return 0;
+ }
+
+ var cur,
+ i = 0,
+ aup = a.parentNode,
+ bup = b.parentNode,
+ ap = [ a ],
+ bp = [ b ];
+
+ // Parentless nodes are either documents or disconnected
+ if ( !aup || !bup ) {
+ return a === document ? -1 :
+ b === document ? 1 :
+ aup ? -1 :
+ bup ? 1 :
+ sortInput ?
+ ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) :
+ 0;
+
+ // If the nodes are siblings, we can do a quick check
+ } else if ( aup === bup ) {
+ return siblingCheck( a, b );
+ }
+
+ // Otherwise we need full lists of their ancestors for comparison
+ cur = a;
+ while ( (cur = cur.parentNode) ) {
+ ap.unshift( cur );
+ }
+ cur = b;
+ while ( (cur = cur.parentNode) ) {
+ bp.unshift( cur );
+ }
+
+ // Walk down the tree looking for a discrepancy
+ while ( ap[i] === bp[i] ) {
+ i++;
+ }
+
+ return i ?
+ // Do a sibling check if the nodes have a common ancestor
+ siblingCheck( ap[i], bp[i] ) :
+
+ // Otherwise nodes in our document sort first
+ ap[i] === preferredDoc ? -1 :
+ bp[i] === preferredDoc ? 1 :
+ 0;
+ };
+
+ return document;
+};
+
+Sizzle.matches = function( expr, elements ) {
+ return Sizzle( expr, null, null, elements );
+};
+
+Sizzle.matchesSelector = function( elem, expr ) {
+ // Set document vars if needed
+ if ( ( elem.ownerDocument || elem ) !== document ) {
+ setDocument( elem );
+ }
+
+ // Make sure that attribute selectors are quoted
+ expr = expr.replace( rattributeQuotes, "='$1']" );
+
+ if ( support.matchesSelector && documentIsHTML &&
+ !compilerCache[ expr + " " ] &&
+ ( !rbuggyMatches || !rbuggyMatches.test( expr ) ) &&
+ ( !rbuggyQSA || !rbuggyQSA.test( expr ) ) ) {
+
+ try {
+ var ret = matches.call( elem, expr );
+
+ // IE 9's matchesSelector returns false on disconnected nodes
+ if ( ret || support.disconnectedMatch ||
+ // As well, disconnected nodes are said to be in a document
+ // fragment in IE 9
+ elem.document && elem.document.nodeType !== 11 ) {
+ return ret;
+ }
+ } catch (e) {}
+ }
+
+ return Sizzle( expr, document, null, [ elem ] ).length > 0;
+};
+
+Sizzle.contains = function( context, elem ) {
+ // Set document vars if needed
+ if ( ( context.ownerDocument || context ) !== document ) {
+ setDocument( context );
+ }
+ return contains( context, elem );
+};
+
+Sizzle.attr = function( elem, name ) {
+ // Set document vars if needed
+ if ( ( elem.ownerDocument || elem ) !== document ) {
+ setDocument( elem );
+ }
+
+ var fn = Expr.attrHandle[ name.toLowerCase() ],
+ // Don't get fooled by Object.prototype properties (jQuery #13807)
+ val = fn && hasOwn.call( Expr.attrHandle, name.toLowerCase() ) ?
+ fn( elem, name, !documentIsHTML ) :
+ undefined;
+
+ return val !== undefined ?
+ val :
+ support.attributes || !documentIsHTML ?
+ elem.getAttribute( name ) :
+ (val = elem.getAttributeNode(name)) && val.specified ?
+ val.value :
+ null;
+};
+
+Sizzle.escape = function( sel ) {
+ return (sel + "").replace( rcssescape, fcssescape );
+};
+
+Sizzle.error = function( msg ) {
+ throw new Error( "Syntax error, unrecognized expression: " + msg );
+};
+
+/**
+ * Document sorting and removing duplicates
+ * @param {ArrayLike} results
+ */
+Sizzle.uniqueSort = function( results ) {
+ var elem,
+ duplicates = [],
+ j = 0,
+ i = 0;
+
+ // Unless we *know* we can detect duplicates, assume their presence
+ hasDuplicate = !support.detectDuplicates;
+ sortInput = !support.sortStable && results.slice( 0 );
+ results.sort( sortOrder );
+
+ if ( hasDuplicate ) {
+ while ( (elem = results[i++]) ) {
+ if ( elem === results[ i ] ) {
+ j = duplicates.push( i );
+ }
+ }
+ while ( j-- ) {
+ results.splice( duplicates[ j ], 1 );
+ }
+ }
+
+ // Clear input after sorting to release objects
+ // See https://github.com/jquery/sizzle/pull/225
+ sortInput = null;
+
+ return results;
+};
+
+/**
+ * Utility function for retrieving the text value of an array of DOM nodes
+ * @param {Array|Element} elem
+ */
+getText = Sizzle.getText = function( elem ) {
+ var node,
+ ret = "",
+ i = 0,
+ nodeType = elem.nodeType;
+
+ if ( !nodeType ) {
+ // If no nodeType, this is expected to be an array
+ while ( (node = elem[i++]) ) {
+ // Do not traverse comment nodes
+ ret += getText( node );
+ }
+ } else if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) {
+ // Use textContent for elements
+ // innerText usage removed for consistency of new lines (jQuery #11153)
+ if ( typeof elem.textContent === "string" ) {
+ return elem.textContent;
+ } else {
+ // Traverse its children
+ for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) {
+ ret += getText( elem );
+ }
+ }
+ } else if ( nodeType === 3 || nodeType === 4 ) {
+ return elem.nodeValue;
+ }
+ // Do not include comment or processing instruction nodes
+
+ return ret;
+};
+
+Expr = Sizzle.selectors = {
+
+ // Can be adjusted by the user
+ cacheLength: 50,
+
+ createPseudo: markFunction,
+
+ match: matchExpr,
+
+ attrHandle: {},
+
+ find: {},
+
+ relative: {
+ ">": { dir: "parentNode", first: true },
+ " ": { dir: "parentNode" },
+ "+": { dir: "previousSibling", first: true },
+ "~": { dir: "previousSibling" }
+ },
+
+ preFilter: {
+ "ATTR": function( match ) {
+ match[1] = match[1].replace( runescape, funescape );
+
+ // Move the given value to match[3] whether quoted or unquoted
+ match[3] = ( match[3] || match[4] || match[5] || "" ).replace( runescape, funescape );
+
+ if ( match[2] === "~=" ) {
+ match[3] = " " + match[3] + " ";
+ }
+
+ return match.slice( 0, 4 );
+ },
+
+ "CHILD": function( match ) {
+ /* matches from matchExpr["CHILD"]
+ 1 type (only|nth|...)
+ 2 what (child|of-type)
+ 3 argument (even|odd|\d*|\d*n([+-]\d+)?|...)
+ 4 xn-component of xn+y argument ([+-]?\d*n|)
+ 5 sign of xn-component
+ 6 x of xn-component
+ 7 sign of y-component
+ 8 y of y-component
+ */
+ match[1] = match[1].toLowerCase();
+
+ if ( match[1].slice( 0, 3 ) === "nth" ) {
+ // nth-* requires argument
+ if ( !match[3] ) {
+ Sizzle.error( match[0] );
+ }
+
+ // numeric x and y parameters for Expr.filter.CHILD
+ // remember that false/true cast respectively to 0/1
+ match[4] = +( match[4] ? match[5] + (match[6] || 1) : 2 * ( match[3] === "even" || match[3] === "odd" ) );
+ match[5] = +( ( match[7] + match[8] ) || match[3] === "odd" );
+
+ // other types prohibit arguments
+ } else if ( match[3] ) {
+ Sizzle.error( match[0] );
+ }
+
+ return match;
+ },
+
+ "PSEUDO": function( match ) {
+ var excess,
+ unquoted = !match[6] && match[2];
+
+ if ( matchExpr["CHILD"].test( match[0] ) ) {
+ return null;
+ }
+
+ // Accept quoted arguments as-is
+ if ( match[3] ) {
+ match[2] = match[4] || match[5] || "";
+
+ // Strip excess characters from unquoted arguments
+ } else if ( unquoted && rpseudo.test( unquoted ) &&
+ // Get excess from tokenize (recursively)
+ (excess = tokenize( unquoted, true )) &&
+ // advance to the next closing parenthesis
+ (excess = unquoted.indexOf( ")", unquoted.length - excess ) - unquoted.length) ) {
+
+ // excess is a negative index
+ match[0] = match[0].slice( 0, excess );
+ match[2] = unquoted.slice( 0, excess );
+ }
+
+ // Return only captures needed by the pseudo filter method (type and argument)
+ return match.slice( 0, 3 );
+ }
+ },
+
+ filter: {
+
+ "TAG": function( nodeNameSelector ) {
+ var nodeName = nodeNameSelector.replace( runescape, funescape ).toLowerCase();
+ return nodeNameSelector === "*" ?
+ function() { return true; } :
+ function( elem ) {
+ return elem.nodeName && elem.nodeName.toLowerCase() === nodeName;
+ };
+ },
+
+ "CLASS": function( className ) {
+ var pattern = classCache[ className + " " ];
+
+ return pattern ||
+ (pattern = new RegExp( "(^|" + whitespace + ")" + className + "(" + whitespace + "|$)" )) &&
+ classCache( className, function( elem ) {
+ return pattern.test( typeof elem.className === "string" && elem.className || typeof elem.getAttribute !== "undefined" && elem.getAttribute("class") || "" );
+ });
+ },
+
+ "ATTR": function( name, operator, check ) {
+ return function( elem ) {
+ var result = Sizzle.attr( elem, name );
+
+ if ( result == null ) {
+ return operator === "!=";
+ }
+ if ( !operator ) {
+ return true;
+ }
+
+ result += "";
+
+ return operator === "=" ? result === check :
+ operator === "!=" ? result !== check :
+ operator === "^=" ? check && result.indexOf( check ) === 0 :
+ operator === "*=" ? check && result.indexOf( check ) > -1 :
+ operator === "$=" ? check && result.slice( -check.length ) === check :
+ operator === "~=" ? ( " " + result.replace( rwhitespace, " " ) + " " ).indexOf( check ) > -1 :
+ operator === "|=" ? result === check || result.slice( 0, check.length + 1 ) === check + "-" :
+ false;
+ };
+ },
+
+ "CHILD": function( type, what, argument, first, last ) {
+ var simple = type.slice( 0, 3 ) !== "nth",
+ forward = type.slice( -4 ) !== "last",
+ ofType = what === "of-type";
+
+ return first === 1 && last === 0 ?
+
+ // Shortcut for :nth-*(n)
+ function( elem ) {
+ return !!elem.parentNode;
+ } :
+
+ function( elem, context, xml ) {
+ var cache, uniqueCache, outerCache, node, nodeIndex, start,
+ dir = simple !== forward ? "nextSibling" : "previousSibling",
+ parent = elem.parentNode,
+ name = ofType && elem.nodeName.toLowerCase(),
+ useCache = !xml && !ofType,
+ diff = false;
+
+ if ( parent ) {
+
+ // :(first|last|only)-(child|of-type)
+ if ( simple ) {
+ while ( dir ) {
+ node = elem;
+ while ( (node = node[ dir ]) ) {
+ if ( ofType ?
+ node.nodeName.toLowerCase() === name :
+ node.nodeType === 1 ) {
+
+ return false;
+ }
+ }
+ // Reverse direction for :only-* (if we haven't yet done so)
+ start = dir = type === "only" && !start && "nextSibling";
+ }
+ return true;
+ }
+
+ start = [ forward ? parent.firstChild : parent.lastChild ];
+
+ // non-xml :nth-child(...) stores cache data on `parent`
+ if ( forward && useCache ) {
+
+ // Seek `elem` from a previously-cached index
+
+ // ...in a gzip-friendly way
+ node = parent;
+ outerCache = node[ expando ] || (node[ expando ] = {});
+
+ // Support: IE <9 only
+ // Defend against cloned attroperties (jQuery gh-1709)
+ uniqueCache = outerCache[ node.uniqueID ] ||
+ (outerCache[ node.uniqueID ] = {});
+
+ cache = uniqueCache[ type ] || [];
+ nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ];
+ diff = nodeIndex && cache[ 2 ];
+ node = nodeIndex && parent.childNodes[ nodeIndex ];
+
+ while ( (node = ++nodeIndex && node && node[ dir ] ||
+
+ // Fallback to seeking `elem` from the start
+ (diff = nodeIndex = 0) || start.pop()) ) {
+
+ // When found, cache indexes on `parent` and break
+ if ( node.nodeType === 1 && ++diff && node === elem ) {
+ uniqueCache[ type ] = [ dirruns, nodeIndex, diff ];
+ break;
+ }
+ }
+
+ } else {
+ // Use previously-cached element index if available
+ if ( useCache ) {
+ // ...in a gzip-friendly way
+ node = elem;
+ outerCache = node[ expando ] || (node[ expando ] = {});
+
+ // Support: IE <9 only
+ // Defend against cloned attroperties (jQuery gh-1709)
+ uniqueCache = outerCache[ node.uniqueID ] ||
+ (outerCache[ node.uniqueID ] = {});
+
+ cache = uniqueCache[ type ] || [];
+ nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ];
+ diff = nodeIndex;
+ }
+
+ // xml :nth-child(...)
+ // or :nth-last-child(...) or :nth(-last)?-of-type(...)
+ if ( diff === false ) {
+ // Use the same loop as above to seek `elem` from the start
+ while ( (node = ++nodeIndex && node && node[ dir ] ||
+ (diff = nodeIndex = 0) || start.pop()) ) {
+
+ if ( ( ofType ?
+ node.nodeName.toLowerCase() === name :
+ node.nodeType === 1 ) &&
+ ++diff ) {
+
+ // Cache the index of each encountered element
+ if ( useCache ) {
+ outerCache = node[ expando ] || (node[ expando ] = {});
+
+ // Support: IE <9 only
+ // Defend against cloned attroperties (jQuery gh-1709)
+ uniqueCache = outerCache[ node.uniqueID ] ||
+ (outerCache[ node.uniqueID ] = {});
+
+ uniqueCache[ type ] = [ dirruns, diff ];
+ }
+
+ if ( node === elem ) {
+ break;
+ }
+ }
+ }
+ }
+ }
+
+ // Incorporate the offset, then check against cycle size
+ diff -= last;
+ return diff === first || ( diff % first === 0 && diff / first >= 0 );
+ }
+ };
+ },
+
+ "PSEUDO": function( pseudo, argument ) {
+ // pseudo-class names are case-insensitive
+ // http://www.w3.org/TR/selectors/#pseudo-classes
+ // Prioritize by case sensitivity in case custom pseudos are added with uppercase letters
+ // Remember that setFilters inherits from pseudos
+ var args,
+ fn = Expr.pseudos[ pseudo ] || Expr.setFilters[ pseudo.toLowerCase() ] ||
+ Sizzle.error( "unsupported pseudo: " + pseudo );
+
+ // The user may use createPseudo to indicate that
+ // arguments are needed to create the filter function
+ // just as Sizzle does
+ if ( fn[ expando ] ) {
+ return fn( argument );
+ }
+
+ // But maintain support for old signatures
+ if ( fn.length > 1 ) {
+ args = [ pseudo, pseudo, "", argument ];
+ return Expr.setFilters.hasOwnProperty( pseudo.toLowerCase() ) ?
+ markFunction(function( seed, matches ) {
+ var idx,
+ matched = fn( seed, argument ),
+ i = matched.length;
+ while ( i-- ) {
+ idx = indexOf( seed, matched[i] );
+ seed[ idx ] = !( matches[ idx ] = matched[i] );
+ }
+ }) :
+ function( elem ) {
+ return fn( elem, 0, args );
+ };
+ }
+
+ return fn;
+ }
+ },
+
+ pseudos: {
+ // Potentially complex pseudos
+ "not": markFunction(function( selector ) {
+ // Trim the selector passed to compile
+ // to avoid treating leading and trailing
+ // spaces as combinators
+ var input = [],
+ results = [],
+ matcher = compile( selector.replace( rtrim, "$1" ) );
+
+ return matcher[ expando ] ?
+ markFunction(function( seed, matches, context, xml ) {
+ var elem,
+ unmatched = matcher( seed, null, xml, [] ),
+ i = seed.length;
+
+ // Match elements unmatched by `matcher`
+ while ( i-- ) {
+ if ( (elem = unmatched[i]) ) {
+ seed[i] = !(matches[i] = elem);
+ }
+ }
+ }) :
+ function( elem, context, xml ) {
+ input[0] = elem;
+ matcher( input, null, xml, results );
+ // Don't keep the element (issue #299)
+ input[0] = null;
+ return !results.pop();
+ };
+ }),
+
+ "has": markFunction(function( selector ) {
+ return function( elem ) {
+ return Sizzle( selector, elem ).length > 0;
+ };
+ }),
+
+ "contains": markFunction(function( text ) {
+ text = text.replace( runescape, funescape );
+ return function( elem ) {
+ return ( elem.textContent || elem.innerText || getText( elem ) ).indexOf( text ) > -1;
+ };
+ }),
+
+ // "Whether an element is represented by a :lang() selector
+ // is based solely on the element's language value
+ // being equal to the identifier C,
+ // or beginning with the identifier C immediately followed by "-".
+ // The matching of C against the element's language value is performed case-insensitively.
+ // The identifier C does not have to be a valid language name."
+ // http://www.w3.org/TR/selectors/#lang-pseudo
+ "lang": markFunction( function( lang ) {
+ // lang value must be a valid identifier
+ if ( !ridentifier.test(lang || "") ) {
+ Sizzle.error( "unsupported lang: " + lang );
+ }
+ lang = lang.replace( runescape, funescape ).toLowerCase();
+ return function( elem ) {
+ var elemLang;
+ do {
+ if ( (elemLang = documentIsHTML ?
+ elem.lang :
+ elem.getAttribute("xml:lang") || elem.getAttribute("lang")) ) {
+
+ elemLang = elemLang.toLowerCase();
+ return elemLang === lang || elemLang.indexOf( lang + "-" ) === 0;
+ }
+ } while ( (elem = elem.parentNode) && elem.nodeType === 1 );
+ return false;
+ };
+ }),
+
+ // Miscellaneous
+ "target": function( elem ) {
+ var hash = window.location && window.location.hash;
+ return hash && hash.slice( 1 ) === elem.id;
+ },
+
+ "root": function( elem ) {
+ return elem === docElem;
+ },
+
+ "focus": function( elem ) {
+ return elem === document.activeElement && (!document.hasFocus || document.hasFocus()) && !!(elem.type || elem.href || ~elem.tabIndex);
+ },
+
+ // Boolean properties
+ "enabled": createDisabledPseudo( false ),
+ "disabled": createDisabledPseudo( true ),
+
+ "checked": function( elem ) {
+ // In CSS3, :checked should return both checked and selected elements
+ // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked
+ var nodeName = elem.nodeName.toLowerCase();
+ return (nodeName === "input" && !!elem.checked) || (nodeName === "option" && !!elem.selected);
+ },
+
+ "selected": function( elem ) {
+ // Accessing this property makes selected-by-default
+ // options in Safari work properly
+ if ( elem.parentNode ) {
+ elem.parentNode.selectedIndex;
+ }
+
+ return elem.selected === true;
+ },
+
+ // Contents
+ "empty": function( elem ) {
+ // http://www.w3.org/TR/selectors/#empty-pseudo
+ // :empty is negated by element (1) or content nodes (text: 3; cdata: 4; entity ref: 5),
+ // but not by others (comment: 8; processing instruction: 7; etc.)
+ // nodeType < 6 works because attributes (2) do not appear as children
+ for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) {
+ if ( elem.nodeType < 6 ) {
+ return false;
+ }
+ }
+ return true;
+ },
+
+ "parent": function( elem ) {
+ return !Expr.pseudos["empty"]( elem );
+ },
+
+ // Element/input types
+ "header": function( elem ) {
+ return rheader.test( elem.nodeName );
+ },
+
+ "input": function( elem ) {
+ return rinputs.test( elem.nodeName );
+ },
+
+ "button": function( elem ) {
+ var name = elem.nodeName.toLowerCase();
+ return name === "input" && elem.type === "button" || name === "button";
+ },
+
+ "text": function( elem ) {
+ var attr;
+ return elem.nodeName.toLowerCase() === "input" &&
+ elem.type === "text" &&
+
+ // Support: IE<8
+ // New HTML5 attribute values (e.g., "search") appear with elem.type === "text"
+ ( (attr = elem.getAttribute("type")) == null || attr.toLowerCase() === "text" );
+ },
+
+ // Position-in-collection
+ "first": createPositionalPseudo(function() {
+ return [ 0 ];
+ }),
+
+ "last": createPositionalPseudo(function( matchIndexes, length ) {
+ return [ length - 1 ];
+ }),
+
+ "eq": createPositionalPseudo(function( matchIndexes, length, argument ) {
+ return [ argument < 0 ? argument + length : argument ];
+ }),
+
+ "even": createPositionalPseudo(function( matchIndexes, length ) {
+ var i = 0;
+ for ( ; i < length; i += 2 ) {
+ matchIndexes.push( i );
+ }
+ return matchIndexes;
+ }),
+
+ "odd": createPositionalPseudo(function( matchIndexes, length ) {
+ var i = 1;
+ for ( ; i < length; i += 2 ) {
+ matchIndexes.push( i );
+ }
+ return matchIndexes;
+ }),
+
+ "lt": createPositionalPseudo(function( matchIndexes, length, argument ) {
+ var i = argument < 0 ? argument + length : argument;
+ for ( ; --i >= 0; ) {
+ matchIndexes.push( i );
+ }
+ return matchIndexes;
+ }),
+
+ "gt": createPositionalPseudo(function( matchIndexes, length, argument ) {
+ var i = argument < 0 ? argument + length : argument;
+ for ( ; ++i < length; ) {
+ matchIndexes.push( i );
+ }
+ return matchIndexes;
+ })
+ }
+};
+
+Expr.pseudos["nth"] = Expr.pseudos["eq"];
+
+// Add button/input type pseudos
+for ( i in { radio: true, checkbox: true, file: true, password: true, image: true } ) {
+ Expr.pseudos[ i ] = createInputPseudo( i );
+}
+for ( i in { submit: true, reset: true } ) {
+ Expr.pseudos[ i ] = createButtonPseudo( i );
+}
+
+// Easy API for creating new setFilters
+function setFilters() {}
+setFilters.prototype = Expr.filters = Expr.pseudos;
+Expr.setFilters = new setFilters();
+
+tokenize = Sizzle.tokenize = function( selector, parseOnly ) {
+ var matched, match, tokens, type,
+ soFar, groups, preFilters,
+ cached = tokenCache[ selector + " " ];
+
+ if ( cached ) {
+ return parseOnly ? 0 : cached.slice( 0 );
+ }
+
+ soFar = selector;
+ groups = [];
+ preFilters = Expr.preFilter;
+
+ while ( soFar ) {
+
+ // Comma and first run
+ if ( !matched || (match = rcomma.exec( soFar )) ) {
+ if ( match ) {
+ // Don't consume trailing commas as valid
+ soFar = soFar.slice( match[0].length ) || soFar;
+ }
+ groups.push( (tokens = []) );
+ }
+
+ matched = false;
+
+ // Combinators
+ if ( (match = rcombinators.exec( soFar )) ) {
+ matched = match.shift();
+ tokens.push({
+ value: matched,
+ // Cast descendant combinators to space
+ type: match[0].replace( rtrim, " " )
+ });
+ soFar = soFar.slice( matched.length );
+ }
+
+ // Filters
+ for ( type in Expr.filter ) {
+ if ( (match = matchExpr[ type ].exec( soFar )) && (!preFilters[ type ] ||
+ (match = preFilters[ type ]( match ))) ) {
+ matched = match.shift();
+ tokens.push({
+ value: matched,
+ type: type,
+ matches: match
+ });
+ soFar = soFar.slice( matched.length );
+ }
+ }
+
+ if ( !matched ) {
+ break;
+ }
+ }
+
+ // Return the length of the invalid excess
+ // if we're just parsing
+ // Otherwise, throw an error or return tokens
+ return parseOnly ?
+ soFar.length :
+ soFar ?
+ Sizzle.error( selector ) :
+ // Cache the tokens
+ tokenCache( selector, groups ).slice( 0 );
+};
+
+function toSelector( tokens ) {
+ var i = 0,
+ len = tokens.length,
+ selector = "";
+ for ( ; i < len; i++ ) {
+ selector += tokens[i].value;
+ }
+ return selector;
+}
+
+function addCombinator( matcher, combinator, base ) {
+ var dir = combinator.dir,
+ skip = combinator.next,
+ key = skip || dir,
+ checkNonElements = base && key === "parentNode",
+ doneName = done++;
+
+ return combinator.first ?
+ // Check against closest ancestor/preceding element
+ function( elem, context, xml ) {
+ while ( (elem = elem[ dir ]) ) {
+ if ( elem.nodeType === 1 || checkNonElements ) {
+ return matcher( elem, context, xml );
+ }
+ }
+ return false;
+ } :
+
+ // Check against all ancestor/preceding elements
+ function( elem, context, xml ) {
+ var oldCache, uniqueCache, outerCache,
+ newCache = [ dirruns, doneName ];
+
+ // We can't set arbitrary data on XML nodes, so they don't benefit from combinator caching
+ if ( xml ) {
+ while ( (elem = elem[ dir ]) ) {
+ if ( elem.nodeType === 1 || checkNonElements ) {
+ if ( matcher( elem, context, xml ) ) {
+ return true;
+ }
+ }
+ }
+ } else {
+ while ( (elem = elem[ dir ]) ) {
+ if ( elem.nodeType === 1 || checkNonElements ) {
+ outerCache = elem[ expando ] || (elem[ expando ] = {});
+
+ // Support: IE <9 only
+ // Defend against cloned attroperties (jQuery gh-1709)
+ uniqueCache = outerCache[ elem.uniqueID ] || (outerCache[ elem.uniqueID ] = {});
+
+ if ( skip && skip === elem.nodeName.toLowerCase() ) {
+ elem = elem[ dir ] || elem;
+ } else if ( (oldCache = uniqueCache[ key ]) &&
+ oldCache[ 0 ] === dirruns && oldCache[ 1 ] === doneName ) {
+
+ // Assign to newCache so results back-propagate to previous elements
+ return (newCache[ 2 ] = oldCache[ 2 ]);
+ } else {
+ // Reuse newcache so results back-propagate to previous elements
+ uniqueCache[ key ] = newCache;
+
+ // A match means we're done; a fail means we have to keep checking
+ if ( (newCache[ 2 ] = matcher( elem, context, xml )) ) {
+ return true;
+ }
+ }
+ }
+ }
+ }
+ return false;
+ };
+}
+
+function elementMatcher( matchers ) {
+ return matchers.length > 1 ?
+ function( elem, context, xml ) {
+ var i = matchers.length;
+ while ( i-- ) {
+ if ( !matchers[i]( elem, context, xml ) ) {
+ return false;
+ }
+ }
+ return true;
+ } :
+ matchers[0];
+}
+
+function multipleContexts( selector, contexts, results ) {
+ var i = 0,
+ len = contexts.length;
+ for ( ; i < len; i++ ) {
+ Sizzle( selector, contexts[i], results );
+ }
+ return results;
+}
+
+function condense( unmatched, map, filter, context, xml ) {
+ var elem,
+ newUnmatched = [],
+ i = 0,
+ len = unmatched.length,
+ mapped = map != null;
+
+ for ( ; i < len; i++ ) {
+ if ( (elem = unmatched[i]) ) {
+ if ( !filter || filter( elem, context, xml ) ) {
+ newUnmatched.push( elem );
+ if ( mapped ) {
+ map.push( i );
+ }
+ }
+ }
+ }
+
+ return newUnmatched;
+}
+
+function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postSelector ) {
+ if ( postFilter && !postFilter[ expando ] ) {
+ postFilter = setMatcher( postFilter );
+ }
+ if ( postFinder && !postFinder[ expando ] ) {
+ postFinder = setMatcher( postFinder, postSelector );
+ }
+ return markFunction(function( seed, results, context, xml ) {
+ var temp, i, elem,
+ preMap = [],
+ postMap = [],
+ preexisting = results.length,
+
+ // Get initial elements from seed or context
+ elems = seed || multipleContexts( selector || "*", context.nodeType ? [ context ] : context, [] ),
+
+ // Prefilter to get matcher input, preserving a map for seed-results synchronization
+ matcherIn = preFilter && ( seed || !selector ) ?
+ condense( elems, preMap, preFilter, context, xml ) :
+ elems,
+
+ matcherOut = matcher ?
+ // If we have a postFinder, or filtered seed, or non-seed postFilter or preexisting results,
+ postFinder || ( seed ? preFilter : preexisting || postFilter ) ?
+
+ // ...intermediate processing is necessary
+ [] :
+
+ // ...otherwise use results directly
+ results :
+ matcherIn;
+
+ // Find primary matches
+ if ( matcher ) {
+ matcher( matcherIn, matcherOut, context, xml );
+ }
+
+ // Apply postFilter
+ if ( postFilter ) {
+ temp = condense( matcherOut, postMap );
+ postFilter( temp, [], context, xml );
+
+ // Un-match failing elements by moving them back to matcherIn
+ i = temp.length;
+ while ( i-- ) {
+ if ( (elem = temp[i]) ) {
+ matcherOut[ postMap[i] ] = !(matcherIn[ postMap[i] ] = elem);
+ }
+ }
+ }
+
+ if ( seed ) {
+ if ( postFinder || preFilter ) {
+ if ( postFinder ) {
+ // Get the final matcherOut by condensing this intermediate into postFinder contexts
+ temp = [];
+ i = matcherOut.length;
+ while ( i-- ) {
+ if ( (elem = matcherOut[i]) ) {
+ // Restore matcherIn since elem is not yet a final match
+ temp.push( (matcherIn[i] = elem) );
+ }
+ }
+ postFinder( null, (matcherOut = []), temp, xml );
+ }
+
+ // Move matched elements from seed to results to keep them synchronized
+ i = matcherOut.length;
+ while ( i-- ) {
+ if ( (elem = matcherOut[i]) &&
+ (temp = postFinder ? indexOf( seed, elem ) : preMap[i]) > -1 ) {
+
+ seed[temp] = !(results[temp] = elem);
+ }
+ }
+ }
+
+ // Add elements to results, through postFinder if defined
+ } else {
+ matcherOut = condense(
+ matcherOut === results ?
+ matcherOut.splice( preexisting, matcherOut.length ) :
+ matcherOut
+ );
+ if ( postFinder ) {
+ postFinder( null, results, matcherOut, xml );
+ } else {
+ push.apply( results, matcherOut );
+ }
+ }
+ });
+}
+
+function matcherFromTokens( tokens ) {
+ var checkContext, matcher, j,
+ len = tokens.length,
+ leadingRelative = Expr.relative[ tokens[0].type ],
+ implicitRelative = leadingRelative || Expr.relative[" "],
+ i = leadingRelative ? 1 : 0,
+
+ // The foundational matcher ensures that elements are reachable from top-level context(s)
+ matchContext = addCombinator( function( elem ) {
+ return elem === checkContext;
+ }, implicitRelative, true ),
+ matchAnyContext = addCombinator( function( elem ) {
+ return indexOf( checkContext, elem ) > -1;
+ }, implicitRelative, true ),
+ matchers = [ function( elem, context, xml ) {
+ var ret = ( !leadingRelative && ( xml || context !== outermostContext ) ) || (
+ (checkContext = context).nodeType ?
+ matchContext( elem, context, xml ) :
+ matchAnyContext( elem, context, xml ) );
+ // Avoid hanging onto element (issue #299)
+ checkContext = null;
+ return ret;
+ } ];
+
+ for ( ; i < len; i++ ) {
+ if ( (matcher = Expr.relative[ tokens[i].type ]) ) {
+ matchers = [ addCombinator(elementMatcher( matchers ), matcher) ];
+ } else {
+ matcher = Expr.filter[ tokens[i].type ].apply( null, tokens[i].matches );
+
+ // Return special upon seeing a positional matcher
+ if ( matcher[ expando ] ) {
+ // Find the next relative operator (if any) for proper handling
+ j = ++i;
+ for ( ; j < len; j++ ) {
+ if ( Expr.relative[ tokens[j].type ] ) {
+ break;
+ }
+ }
+ return setMatcher(
+ i > 1 && elementMatcher( matchers ),
+ i > 1 && toSelector(
+ // If the preceding token was a descendant combinator, insert an implicit any-element `*`
+ tokens.slice( 0, i - 1 ).concat({ value: tokens[ i - 2 ].type === " " ? "*" : "" })
+ ).replace( rtrim, "$1" ),
+ matcher,
+ i < j && matcherFromTokens( tokens.slice( i, j ) ),
+ j < len && matcherFromTokens( (tokens = tokens.slice( j )) ),
+ j < len && toSelector( tokens )
+ );
+ }
+ matchers.push( matcher );
+ }
+ }
+
+ return elementMatcher( matchers );
+}
+
+function matcherFromGroupMatchers( elementMatchers, setMatchers ) {
+ var bySet = setMatchers.length > 0,
+ byElement = elementMatchers.length > 0,
+ superMatcher = function( seed, context, xml, results, outermost ) {
+ var elem, j, matcher,
+ matchedCount = 0,
+ i = "0",
+ unmatched = seed && [],
+ setMatched = [],
+ contextBackup = outermostContext,
+ // We must always have either seed elements or outermost context
+ elems = seed || byElement && Expr.find["TAG"]( "*", outermost ),
+ // Use integer dirruns iff this is the outermost matcher
+ dirrunsUnique = (dirruns += contextBackup == null ? 1 : Math.random() || 0.1),
+ len = elems.length;
+
+ if ( outermost ) {
+ outermostContext = context === document || context || outermost;
+ }
+
+ // Add elements passing elementMatchers directly to results
+ // Support: IE<9, Safari
+ // Tolerate NodeList properties (IE: "length"; Safari: <number>) matching elements by id
+ for ( ; i !== len && (elem = elems[i]) != null; i++ ) {
+ if ( byElement && elem ) {
+ j = 0;
+ if ( !context && elem.ownerDocument !== document ) {
+ setDocument( elem );
+ xml = !documentIsHTML;
+ }
+ while ( (matcher = elementMatchers[j++]) ) {
+ if ( matcher( elem, context || document, xml) ) {
+ results.push( elem );
+ break;
+ }
+ }
+ if ( outermost ) {
+ dirruns = dirrunsUnique;
+ }
+ }
+
+ // Track unmatched elements for set filters
+ if ( bySet ) {
+ // They will have gone through all possible matchers
+ if ( (elem = !matcher && elem) ) {
+ matchedCount--;
+ }
+
+ // Lengthen the array for every element, matched or not
+ if ( seed ) {
+ unmatched.push( elem );
+ }
+ }
+ }
+
+ // `i` is now the count of elements visited above, and adding it to `matchedCount`
+ // makes the latter nonnegative.
+ matchedCount += i;
+
+ // Apply set filters to unmatched elements
+ // NOTE: This can be skipped if there are no unmatched elements (i.e., `matchedCount`
+ // equals `i`), unless we didn't visit _any_ elements in the above loop because we have
+ // no element matchers and no seed.
+ // Incrementing an initially-string "0" `i` allows `i` to remain a string only in that
+ // case, which will result in a "00" `matchedCount` that differs from `i` but is also
+ // numerically zero.
+ if ( bySet && i !== matchedCount ) {
+ j = 0;
+ while ( (matcher = setMatchers[j++]) ) {
+ matcher( unmatched, setMatched, context, xml );
+ }
+
+ if ( seed ) {
+ // Reintegrate element matches to eliminate the need for sorting
+ if ( matchedCount > 0 ) {
+ while ( i-- ) {
+ if ( !(unmatched[i] || setMatched[i]) ) {
+ setMatched[i] = pop.call( results );
+ }
+ }
+ }
+
+ // Discard index placeholder values to get only actual matches
+ setMatched = condense( setMatched );
+ }
+
+ // Add matches to results
+ push.apply( results, setMatched );
+
+ // Seedless set matches succeeding multiple successful matchers stipulate sorting
+ if ( outermost && !seed && setMatched.length > 0 &&
+ ( matchedCount + setMatchers.length ) > 1 ) {
+
+ Sizzle.uniqueSort( results );
+ }
+ }
+
+ // Override manipulation of globals by nested matchers
+ if ( outermost ) {
+ dirruns = dirrunsUnique;
+ outermostContext = contextBackup;
+ }
+
+ return unmatched;
+ };
+
+ return bySet ?
+ markFunction( superMatcher ) :
+ superMatcher;
+}
+
+compile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) {
+ var i,
+ setMatchers = [],
+ elementMatchers = [],
+ cached = compilerCache[ selector + " " ];
+
+ if ( !cached ) {
+ // Generate a function of recursive functions that can be used to check each element
+ if ( !match ) {
+ match = tokenize( selector );
+ }
+ i = match.length;
+ while ( i-- ) {
+ cached = matcherFromTokens( match[i] );
+ if ( cached[ expando ] ) {
+ setMatchers.push( cached );
+ } else {
+ elementMatchers.push( cached );
+ }
+ }
+
+ // Cache the compiled function
+ cached = compilerCache( selector, matcherFromGroupMatchers( elementMatchers, setMatchers ) );
+
+ // Save selector and tokenization
+ cached.selector = selector;
+ }
+ return cached;
+};
+
+/**
+ * A low-level selection function that works with Sizzle's compiled
+ * selector functions
+ * @param {String|Function} selector A selector or a pre-compiled
+ * selector function built with Sizzle.compile
+ * @param {Element} context
+ * @param {Array} [results]
+ * @param {Array} [seed] A set of elements to match against
+ */
+select = Sizzle.select = function( selector, context, results, seed ) {
+ var i, tokens, token, type, find,
+ compiled = typeof selector === "function" && selector,
+ match = !seed && tokenize( (selector = compiled.selector || selector) );
+
+ results = results || [];
+
+ // Try to minimize operations if there is only one selector in the list and no seed
+ // (the latter of which guarantees us context)
+ if ( match.length === 1 ) {
+
+ // Reduce context if the leading compound selector is an ID
+ tokens = match[0] = match[0].slice( 0 );
+ if ( tokens.length > 2 && (token = tokens[0]).type === "ID" &&
+ context.nodeType === 9 && documentIsHTML && Expr.relative[ tokens[1].type ] ) {
+
+ context = ( Expr.find["ID"]( token.matches[0].replace(runescape, funescape), context ) || [] )[0];
+ if ( !context ) {
+ return results;
+
+ // Precompiled matchers will still verify ancestry, so step up a level
+ } else if ( compiled ) {
+ context = context.parentNode;
+ }
+
+ selector = selector.slice( tokens.shift().value.length );
+ }
+
+ // Fetch a seed set for right-to-left matching
+ i = matchExpr["needsContext"].test( selector ) ? 0 : tokens.length;
+ while ( i-- ) {
+ token = tokens[i];
+
+ // Abort if we hit a combinator
+ if ( Expr.relative[ (type = token.type) ] ) {
+ break;
+ }
+ if ( (find = Expr.find[ type ]) ) {
+ // Search, expanding context for leading sibling combinators
+ if ( (seed = find(
+ token.matches[0].replace( runescape, funescape ),
+ rsibling.test( tokens[0].type ) && testContext( context.parentNode ) || context
+ )) ) {
+
+ // If seed is empty or no tokens remain, we can return early
+ tokens.splice( i, 1 );
+ selector = seed.length && toSelector( tokens );
+ if ( !selector ) {
+ push.apply( results, seed );
+ return results;
+ }
+
+ break;
+ }
+ }
+ }
+ }
+
+ // Compile and execute a filtering function if one is not provided
+ // Provide `match` to avoid retokenization if we modified the selector above
+ ( compiled || compile( selector, match ) )(
+ seed,
+ context,
+ !documentIsHTML,
+ results,
+ !context || rsibling.test( selector ) && testContext( context.parentNode ) || context
+ );
+ return results;
+};
+
+// One-time assignments
+
+// Sort stability
+support.sortStable = expando.split("").sort( sortOrder ).join("") === expando;
+
+// Support: Chrome 14-35+
+// Always assume duplicates if they aren't passed to the comparison function
+support.detectDuplicates = !!hasDuplicate;
+
+// Initialize against the default document
+setDocument();
+
+// Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27)
+// Detached nodes confoundingly follow *each other*
+support.sortDetached = assert(function( el ) {
+ // Should return 1, but returns 4 (following)
+ return el.compareDocumentPosition( document.createElement("fieldset") ) & 1;
+});
+
+// Support: IE<8
+// Prevent attribute/property "interpolation"
+// https://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx
+if ( !assert(function( el ) {
+ el.innerHTML = "<a href='#'></a>";
+ return el.firstChild.getAttribute("href") === "#" ;
+}) ) {
+ addHandle( "type|href|height|width", function( elem, name, isXML ) {
+ if ( !isXML ) {
+ return elem.getAttribute( name, name.toLowerCase() === "type" ? 1 : 2 );
+ }
+ });
+}
+
+// Support: IE<9
+// Use defaultValue in place of getAttribute("value")
+if ( !support.attributes || !assert(function( el ) {
+ el.innerHTML = "<input/>";
+ el.firstChild.setAttribute( "value", "" );
+ return el.firstChild.getAttribute( "value" ) === "";
+}) ) {
+ addHandle( "value", function( elem, name, isXML ) {
+ if ( !isXML && elem.nodeName.toLowerCase() === "input" ) {
+ return elem.defaultValue;
+ }
+ });
+}
+
+// Support: IE<9
+// Use getAttributeNode to fetch booleans when getAttribute lies
+if ( !assert(function( el ) {
+ return el.getAttribute("disabled") == null;
+}) ) {
+ addHandle( booleans, function( elem, name, isXML ) {
+ var val;
+ if ( !isXML ) {
+ return elem[ name ] === true ? name.toLowerCase() :
+ (val = elem.getAttributeNode( name )) && val.specified ?
+ val.value :
+ null;
+ }
+ });
+}
+
+return Sizzle;
+
+})( window );
+
+
+
+jQuery.find = Sizzle;
+jQuery.expr = Sizzle.selectors;
+
+// Deprecated
+jQuery.expr[ ":" ] = jQuery.expr.pseudos;
+jQuery.uniqueSort = jQuery.unique = Sizzle.uniqueSort;
+jQuery.text = Sizzle.getText;
+jQuery.isXMLDoc = Sizzle.isXML;
+jQuery.contains = Sizzle.contains;
+jQuery.escapeSelector = Sizzle.escape;
+
+
+
+
+var dir = function( elem, dir, until ) {
+ var matched = [],
+ truncate = until !== undefined;
+
+ while ( ( elem = elem[ dir ] ) && elem.nodeType !== 9 ) {
+ if ( elem.nodeType === 1 ) {
+ if ( truncate && jQuery( elem ).is( until ) ) {
+ break;
+ }
+ matched.push( elem );
+ }
+ }
+ return matched;
+};
+
+
+var siblings = function( n, elem ) {
+ var matched = [];
+
+ for ( ; n; n = n.nextSibling ) {
+ if ( n.nodeType === 1 && n !== elem ) {
+ matched.push( n );
+ }
+ }
+
+ return matched;
+};
+
+
+var rneedsContext = jQuery.expr.match.needsContext;
+
+var rsingleTag = ( /^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i );
+
+
+
+var risSimple = /^.[^:#\[\.,]*$/;
+
+// Implement the identical functionality for filter and not
+function winnow( elements, qualifier, not ) {
+ if ( jQuery.isFunction( qualifier ) ) {
+ return jQuery.grep( elements, function( elem, i ) {
+ return !!qualifier.call( elem, i, elem ) !== not;
+ } );
+ }
+
+ // Single element
+ if ( qualifier.nodeType ) {
+ return jQuery.grep( elements, function( elem ) {
+ return ( elem === qualifier ) !== not;
+ } );
+ }
+
+ // Arraylike of elements (jQuery, arguments, Array)
+ if ( typeof qualifier !== "string" ) {
+ return jQuery.grep( elements, function( elem ) {
+ return ( indexOf.call( qualifier, elem ) > -1 ) !== not;
+ } );
+ }
+
+ // Simple selector that can be filtered directly, removing non-Elements
+ if ( risSimple.test( qualifier ) ) {
+ return jQuery.filter( qualifier, elements, not );
+ }
+
+ // Complex selector, compare the two sets, removing non-Elements
+ qualifier = jQuery.filter( qualifier, elements );
+ return jQuery.grep( elements, function( elem ) {
+ return ( indexOf.call( qualifier, elem ) > -1 ) !== not && elem.nodeType === 1;
+ } );
+}
+
+jQuery.filter = function( expr, elems, not ) {
+ var elem = elems[ 0 ];
+
+ if ( not ) {
+ expr = ":not(" + expr + ")";
+ }
+
+ if ( elems.length === 1 && elem.nodeType === 1 ) {
+ return jQuery.find.matchesSelector( elem, expr ) ? [ elem ] : [];
+ }
+
+ return jQuery.find.matches( expr, jQuery.grep( elems, function( elem ) {
+ return elem.nodeType === 1;
+ } ) );
+};
+
+jQuery.fn.extend( {
+ find: function( selector ) {
+ var i, ret,
+ len = this.length,
+ self = this;
+
+ if ( typeof selector !== "string" ) {
+ return this.pushStack( jQuery( selector ).filter( function() {
+ for ( i = 0; i < len; i++ ) {
+ if ( jQuery.contains( self[ i ], this ) ) {
+ return true;
+ }
+ }
+ } ) );
+ }
+
+ ret = this.pushStack( [] );
+
+ for ( i = 0; i < len; i++ ) {
+ jQuery.find( selector, self[ i ], ret );
+ }
+
+ return len > 1 ? jQuery.uniqueSort( ret ) : ret;
+ },
+ filter: function( selector ) {
+ return this.pushStack( winnow( this, selector || [], false ) );
+ },
+ not: function( selector ) {
+ return this.pushStack( winnow( this, selector || [], true ) );
+ },
+ is: function( selector ) {
+ return !!winnow(
+ this,
+
+ // If this is a positional/relative selector, check membership in the returned set
+ // so $("p:first").is("p:last") won't return true for a doc with two "p".
+ typeof selector === "string" && rneedsContext.test( selector ) ?
+ jQuery( selector ) :
+ selector || [],
+ false
+ ).length;
+ }
+} );
+
+
+// Initialize a jQuery object
+
+
+// A central reference to the root jQuery(document)
+var rootjQuery,
+
+ // A simple way to check for HTML strings
+ // Prioritize #id over <tag> to avoid XSS via location.hash (#9521)
+ // Strict HTML recognition (#11290: must start with <)
+ // Shortcut simple #id case for speed
+ rquickExpr = /^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/,
+
+ init = jQuery.fn.init = function( selector, context, root ) {
+ var match, elem;
+
+ // HANDLE: $(""), $(null), $(undefined), $(false)
+ if ( !selector ) {
+ return this;
+ }
+
+ // Method init() accepts an alternate rootjQuery
+ // so migrate can support jQuery.sub (gh-2101)
+ root = root || rootjQuery;
+
+ // Handle HTML strings
+ if ( typeof selector === "string" ) {
+ if ( selector[ 0 ] === "<" &&
+ selector[ selector.length - 1 ] === ">" &&
+ selector.length >= 3 ) {
+
+ // Assume that strings that start and end with <> are HTML and skip the regex check
+ match = [ null, selector, null ];
+
+ } else {
+ match = rquickExpr.exec( selector );
+ }
+
+ // Match html or make sure no context is specified for #id
+ if ( match && ( match[ 1 ] || !context ) ) {
+
+ // HANDLE: $(html) -> $(array)
+ if ( match[ 1 ] ) {
+ context = context instanceof jQuery ? context[ 0 ] : context;
+
+ // Option to run scripts is true for back-compat
+ // Intentionally let the error be thrown if parseHTML is not present
+ jQuery.merge( this, jQuery.parseHTML(
+ match[ 1 ],
+ context && context.nodeType ? context.ownerDocument || context : document,
+ true
+ ) );
+
+ // HANDLE: $(html, props)
+ if ( rsingleTag.test( match[ 1 ] ) && jQuery.isPlainObject( context ) ) {
+ for ( match in context ) {
+
+ // Properties of context are called as methods if possible
+ if ( jQuery.isFunction( this[ match ] ) ) {
+ this[ match ]( context[ match ] );
+
+ // ...and otherwise set as attributes
+ } else {
+ this.attr( match, context[ match ] );
+ }
+ }
+ }
+
+ return this;
+
+ // HANDLE: $(#id)
+ } else {
+ elem = document.getElementById( match[ 2 ] );
+
+ if ( elem ) {
+
+ // Inject the element directly into the jQuery object
+ this[ 0 ] = elem;
+ this.length = 1;
+ }
+ return this;
+ }
+
+ // HANDLE: $(expr, $(...))
+ } else if ( !context || context.jquery ) {
+ return ( context || root ).find( selector );
+
+ // HANDLE: $(expr, context)
+ // (which is just equivalent to: $(context).find(expr)
+ } else {
+ return this.constructor( context ).find( selector );
+ }
+
+ // HANDLE: $(DOMElement)
+ } else if ( selector.nodeType ) {
+ this[ 0 ] = selector;
+ this.length = 1;
+ return this;
+
+ // HANDLE: $(function)
+ // Shortcut for document ready
+ } else if ( jQuery.isFunction( selector ) ) {
+ return root.ready !== undefined ?
+ root.ready( selector ) :
+
+ // Execute immediately if ready is not present
+ selector( jQuery );
+ }
+
+ return jQuery.makeArray( selector, this );
+ };
+
+// Give the init function the jQuery prototype for later instantiation
+init.prototype = jQuery.fn;
+
+// Initialize central reference
+rootjQuery = jQuery( document );
+
+
+var rparentsprev = /^(?:parents|prev(?:Until|All))/,
+
+ // Methods guaranteed to produce a unique set when starting from a unique set
+ guaranteedUnique = {
+ children: true,
+ contents: true,
+ next: true,
+ prev: true
+ };
+
+jQuery.fn.extend( {
+ has: function( target ) {
+ var targets = jQuery( target, this ),
+ l = targets.length;
+
+ return this.filter( function() {
+ var i = 0;
+ for ( ; i < l; i++ ) {
+ if ( jQuery.contains( this, targets[ i ] ) ) {
+ return true;
+ }
+ }
+ } );
+ },
+
+ closest: function( selectors, context ) {
+ var cur,
+ i = 0,
+ l = this.length,
+ matched = [],
+ targets = typeof selectors !== "string" && jQuery( selectors );
+
+ // Positional selectors never match, since there's no _selection_ context
+ if ( !rneedsContext.test( selectors ) ) {
+ for ( ; i < l; i++ ) {
+ for ( cur = this[ i ]; cur && cur !== context; cur = cur.parentNode ) {
+
+ // Always skip document fragments
+ if ( cur.nodeType < 11 && ( targets ?
+ targets.index( cur ) > -1 :
+
+ // Don't pass non-elements to Sizzle
+ cur.nodeType === 1 &&
+ jQuery.find.matchesSelector( cur, selectors ) ) ) {
+
+ matched.push( cur );
+ break;
+ }
+ }
+ }
+ }
+
+ return this.pushStack( matched.length > 1 ? jQuery.uniqueSort( matched ) : matched );
+ },
+
+ // Determine the position of an element within the set
+ index: function( elem ) {
+
+ // No argument, return index in parent
+ if ( !elem ) {
+ return ( this[ 0 ] && this[ 0 ].parentNode ) ? this.first().prevAll().length : -1;
+ }
+
+ // Index in selector
+ if ( typeof elem === "string" ) {
+ return indexOf.call( jQuery( elem ), this[ 0 ] );
+ }
+
+ // Locate the position of the desired element
+ return indexOf.call( this,
+
+ // If it receives a jQuery object, the first element is used
+ elem.jquery ? elem[ 0 ] : elem
+ );
+ },
+
+ add: function( selector, context ) {
+ return this.pushStack(
+ jQuery.uniqueSort(
+ jQuery.merge( this.get(), jQuery( selector, context ) )
+ )
+ );
+ },
+
+ addBack: function( selector ) {
+ return this.add( selector == null ?
+ this.prevObject : this.prevObject.filter( selector )
+ );
+ }
+} );
+
+function sibling( cur, dir ) {
+ while ( ( cur = cur[ dir ] ) && cur.nodeType !== 1 ) {}
+ return cur;
+}
+
+jQuery.each( {
+ parent: function( elem ) {
+ var parent = elem.parentNode;
+ return parent && parent.nodeType !== 11 ? parent : null;
+ },
+ parents: function( elem ) {
+ return dir( elem, "parentNode" );
+ },
+ parentsUntil: function( elem, i, until ) {
+ return dir( elem, "parentNode", until );
+ },
+ next: function( elem ) {
+ return sibling( elem, "nextSibling" );
+ },
+ prev: function( elem ) {
+ return sibling( elem, "previousSibling" );
+ },
+ nextAll: function( elem ) {
+ return dir( elem, "nextSibling" );
+ },
+ prevAll: function( elem ) {
+ return dir( elem, "previousSibling" );
+ },
+ nextUntil: function( elem, i, until ) {
+ return dir( elem, "nextSibling", until );
+ },
+ prevUntil: function( elem, i, until ) {
+ return dir( elem, "previousSibling", until );
+ },
+ siblings: function( elem ) {
+ return siblings( ( elem.parentNode || {} ).firstChild, elem );
+ },
+ children: function( elem ) {
+ return siblings( elem.firstChild );
+ },
+ contents: function( elem ) {
+ return elem.contentDocument || jQuery.merge( [], elem.childNodes );
+ }
+}, function( name, fn ) {
+ jQuery.fn[ name ] = function( until, selector ) {
+ var matched = jQuery.map( this, fn, until );
+
+ if ( name.slice( -5 ) !== "Until" ) {
+ selector = until;
+ }
+
+ if ( selector && typeof selector === "string" ) {
+ matched = jQuery.filter( selector, matched );
+ }
+
+ if ( this.length > 1 ) {
+
+ // Remove duplicates
+ if ( !guaranteedUnique[ name ] ) {
+ jQuery.uniqueSort( matched );
+ }
+
+ // Reverse order for parents* and prev-derivatives
+ if ( rparentsprev.test( name ) ) {
+ matched.reverse();
+ }
+ }
+
+ return this.pushStack( matched );
+ };
+} );
+var rnothtmlwhite = ( /[^\x20\t\r\n\f]+/g );
+
+
+
+// Convert String-formatted options into Object-formatted ones
+function createOptions( options ) {
+ var object = {};
+ jQuery.each( options.match( rnothtmlwhite ) || [], function( _, flag ) {
+ object[ flag ] = true;
+ } );
+ return object;
+}
+
+/*
+ * Create a callback list using the following parameters:
+ *
+ * options: an optional list of space-separated options that will change how
+ * the callback list behaves or a more traditional option object
+ *
+ * By default a callback list will act like an event callback list and can be
+ * "fired" multiple times.
+ *
+ * Possible options:
+ *
+ * once: will ensure the callback list can only be fired once (like a Deferred)
+ *
+ * memory: will keep track of previous values and will call any callback added
+ * after the list has been fired right away with the latest "memorized"
+ * values (like a Deferred)
+ *
+ * unique: will ensure a callback can only be added once (no duplicate in the list)
+ *
+ * stopOnFalse: interrupt callings when a callback returns false
+ *
+ */
+jQuery.Callbacks = function( options ) {
+
+ // Convert options from String-formatted to Object-formatted if needed
+ // (we check in cache first)
+ options = typeof options === "string" ?
+ createOptions( options ) :
+ jQuery.extend( {}, options );
+
+ var // Flag to know if list is currently firing
+ firing,
+
+ // Last fire value for non-forgettable lists
+ memory,
+
+ // Flag to know if list was already fired
+ fired,
+
+ // Flag to prevent firing
+ locked,
+
+ // Actual callback list
+ list = [],
+
+ // Queue of execution data for repeatable lists
+ queue = [],
+
+ // Index of currently firing callback (modified by add/remove as needed)
+ firingIndex = -1,
+
+ // Fire callbacks
+ fire = function() {
+
+ // Enforce single-firing
+ locked = options.once;
+
+ // Execute callbacks for all pending executions,
+ // respecting firingIndex overrides and runtime changes
+ fired = firing = true;
+ for ( ; queue.length; firingIndex = -1 ) {
+ memory = queue.shift();
+ while ( ++firingIndex < list.length ) {
+
+ // Run callback and check for early termination
+ if ( list[ firingIndex ].apply( memory[ 0 ], memory[ 1 ] ) === false &&
+ options.stopOnFalse ) {
+
+ // Jump to end and forget the data so .add doesn't re-fire
+ firingIndex = list.length;
+ memory = false;
+ }
+ }
+ }
+
+ // Forget the data if we're done with it
+ if ( !options.memory ) {
+ memory = false;
+ }
+
+ firing = false;
+
+ // Clean up if we're done firing for good
+ if ( locked ) {
+
+ // Keep an empty list if we have data for future add calls
+ if ( memory ) {
+ list = [];
+
+ // Otherwise, this object is spent
+ } else {
+ list = "";
+ }
+ }
+ },
+
+ // Actual Callbacks object
+ self = {
+
+ // Add a callback or a collection of callbacks to the list
+ add: function() {
+ if ( list ) {
+
+ // If we have memory from a past run, we should fire after adding
+ if ( memory && !firing ) {
+ firingIndex = list.length - 1;
+ queue.push( memory );
+ }
+
+ ( function add( args ) {
+ jQuery.each( args, function( _, arg ) {
+ if ( jQuery.isFunction( arg ) ) {
+ if ( !options.unique || !self.has( arg ) ) {
+ list.push( arg );
+ }
+ } else if ( arg && arg.length && jQuery.type( arg ) !== "string" ) {
+
+ // Inspect recursively
+ add( arg );
+ }
+ } );
+ } )( arguments );
+
+ if ( memory && !firing ) {
+ fire();
+ }
+ }
+ return this;
+ },
+
+ // Remove a callback from the list
+ remove: function() {
+ jQuery.each( arguments, function( _, arg ) {
+ var index;
+ while ( ( index = jQuery.inArray( arg, list, index ) ) > -1 ) {
+ list.splice( index, 1 );
+
+ // Handle firing indexes
+ if ( index <= firingIndex ) {
+ firingIndex--;
+ }
+ }
+ } );
+ return this;
+ },
+
+ // Check if a given callback is in the list.
+ // If no argument is given, return whether or not list has callbacks attached.
+ has: function( fn ) {
+ return fn ?
+ jQuery.inArray( fn, list ) > -1 :
+ list.length > 0;
+ },
+
+ // Remove all callbacks from the list
+ empty: function() {
+ if ( list ) {
+ list = [];
+ }
+ return this;
+ },
+
+ // Disable .fire and .add
+ // Abort any current/pending executions
+ // Clear all callbacks and values
+ disable: function() {
+ locked = queue = [];
+ list = memory = "";
+ return this;
+ },
+ disabled: function() {
+ return !list;
+ },
+
+ // Disable .fire
+ // Also disable .add unless we have memory (since it would have no effect)
+ // Abort any pending executions
+ lock: function() {
+ locked = queue = [];
+ if ( !memory && !firing ) {
+ list = memory = "";
+ }
+ return this;
+ },
+ locked: function() {
+ return !!locked;
+ },
+
+ // Call all callbacks with the given context and arguments
+ fireWith: function( context, args ) {
+ if ( !locked ) {
+ args = args || [];
+ args = [ context, args.slice ? args.slice() : args ];
+ queue.push( args );
+ if ( !firing ) {
+ fire();
+ }
+ }
+ return this;
+ },
+
+ // Call all the callbacks with the given arguments
+ fire: function() {
+ self.fireWith( this, arguments );
+ return this;
+ },
+
+ // To know if the callbacks have already been called at least once
+ fired: function() {
+ return !!fired;
+ }
+ };
+
+ return self;
+};
+
+
+function Identity( v ) {
+ return v;
+}
+function Thrower( ex ) {
+ throw ex;
+}
+
+function adoptValue( value, resolve, reject ) {
+ var method;
+
+ try {
+
+ // Check for promise aspect first to privilege synchronous behavior
+ if ( value && jQuery.isFunction( ( method = value.promise ) ) ) {
+ method.call( value ).done( resolve ).fail( reject );
+
+ // Other thenables
+ } else if ( value && jQuery.isFunction( ( method = value.then ) ) ) {
+ method.call( value, resolve, reject );
+
+ // Other non-thenables
+ } else {
+
+ // Support: Android 4.0 only
+ // Strict mode functions invoked without .call/.apply get global-object context
+ resolve.call( undefined, value );
+ }
+
+ // For Promises/A+, convert exceptions into rejections
+ // Since jQuery.when doesn't unwrap thenables, we can skip the extra checks appearing in
+ // Deferred#then to conditionally suppress rejection.
+ } catch ( value ) {
+
+ // Support: Android 4.0 only
+ // Strict mode functions invoked without .call/.apply get global-object context
+ reject.call( undefined, value );
+ }
+}
+
+jQuery.extend( {
+
+ Deferred: function( func ) {
+ var tuples = [
+
+ // action, add listener, callbacks,
+ // ... .then handlers, argument index, [final state]
+ [ "notify", "progress", jQuery.Callbacks( "memory" ),
+ jQuery.Callbacks( "memory" ), 2 ],
+ [ "resolve", "done", jQuery.Callbacks( "once memory" ),
+ jQuery.Callbacks( "once memory" ), 0, "resolved" ],
+ [ "reject", "fail", jQuery.Callbacks( "once memory" ),
+ jQuery.Callbacks( "once memory" ), 1, "rejected" ]
+ ],
+ state = "pending",
+ promise = {
+ state: function() {
+ return state;
+ },
+ always: function() {
+ deferred.done( arguments ).fail( arguments );
+ return this;
+ },
+ "catch": function( fn ) {
+ return promise.then( null, fn );
+ },
+
+ // Keep pipe for back-compat
+ pipe: function( /* fnDone, fnFail, fnProgress */ ) {
+ var fns = arguments;
+
+ return jQuery.Deferred( function( newDefer ) {
+ jQuery.each( tuples, function( i, tuple ) {
+
+ // Map tuples (progress, done, fail) to arguments (done, fail, progress)
+ var fn = jQuery.isFunction( fns[ tuple[ 4 ] ] ) && fns[ tuple[ 4 ] ];
+
+ // deferred.progress(function() { bind to newDefer or newDefer.notify })
+ // deferred.done(function() { bind to newDefer or newDefer.resolve })
+ // deferred.fail(function() { bind to newDefer or newDefer.reject })
+ deferred[ tuple[ 1 ] ]( function() {
+ var returned = fn && fn.apply( this, arguments );
+ if ( returned && jQuery.isFunction( returned.promise ) ) {
+ returned.promise()
+ .progress( newDefer.notify )
+ .done( newDefer.resolve )
+ .fail( newDefer.reject );
+ } else {
+ newDefer[ tuple[ 0 ] + "With" ](
+ this,
+ fn ? [ returned ] : arguments
+ );
+ }
+ } );
+ } );
+ fns = null;
+ } ).promise();
+ },
+ then: function( onFulfilled, onRejected, onProgress ) {
+ var maxDepth = 0;
+ function resolve( depth, deferred, handler, special ) {
+ return function() {
+ var that = this,
+ args = arguments,
+ mightThrow = function() {
+ var returned, then;
+
+ // Support: Promises/A+ section 2.3.3.3.3
+ // https://promisesaplus.com/#point-59
+ // Ignore double-resolution attempts
+ if ( depth < maxDepth ) {
+ return;
+ }
+
+ returned = handler.apply( that, args );
+
+ // Support: Promises/A+ section 2.3.1
+ // https://promisesaplus.com/#point-48
+ if ( returned === deferred.promise() ) {
+ throw new TypeError( "Thenable self-resolution" );
+ }
+
+ // Support: Promises/A+ sections 2.3.3.1, 3.5
+ // https://promisesaplus.com/#point-54
+ // https://promisesaplus.com/#point-75
+ // Retrieve `then` only once
+ then = returned &&
+
+ // Support: Promises/A+ section 2.3.4
+ // https://promisesaplus.com/#point-64
+ // Only check objects and functions for thenability
+ ( typeof returned === "object" ||
+ typeof returned === "function" ) &&
+ returned.then;
+
+ // Handle a returned thenable
+ if ( jQuery.isFunction( then ) ) {
+
+ // Special processors (notify) just wait for resolution
+ if ( special ) {
+ then.call(
+ returned,
+ resolve( maxDepth, deferred, Identity, special ),
+ resolve( maxDepth, deferred, Thrower, special )
+ );
+
+ // Normal processors (resolve) also hook into progress
+ } else {
+
+ // ...and disregard older resolution values
+ maxDepth++;
+
+ then.call(
+ returned,
+ resolve( maxDepth, deferred, Identity, special ),
+ resolve( maxDepth, deferred, Thrower, special ),
+ resolve( maxDepth, deferred, Identity,
+ deferred.notifyWith )
+ );
+ }
+
+ // Handle all other returned values
+ } else {
+
+ // Only substitute handlers pass on context
+ // and multiple values (non-spec behavior)
+ if ( handler !== Identity ) {
+ that = undefined;
+ args = [ returned ];
+ }
+
+ // Process the value(s)
+ // Default process is resolve
+ ( special || deferred.resolveWith )( that, args );
+ }
+ },
+
+ // Only normal processors (resolve) catch and reject exceptions
+ process = special ?
+ mightThrow :
+ function() {
+ try {
+ mightThrow();
+ } catch ( e ) {
+
+ if ( jQuery.Deferred.exceptionHook ) {
+ jQuery.Deferred.exceptionHook( e,
+ process.stackTrace );
+ }
+
+ // Support: Promises/A+ section 2.3.3.3.4.1
+ // https://promisesaplus.com/#point-61
+ // Ignore post-resolution exceptions
+ if ( depth + 1 >= maxDepth ) {
+
+ // Only substitute handlers pass on context
+ // and multiple values (non-spec behavior)
+ if ( handler !== Thrower ) {
+ that = undefined;
+ args = [ e ];
+ }
+
+ deferred.rejectWith( that, args );
+ }
+ }
+ };
+
+ // Support: Promises/A+ section 2.3.3.3.1
+ // https://promisesaplus.com/#point-57
+ // Re-resolve promises immediately to dodge false rejection from
+ // subsequent errors
+ if ( depth ) {
+ process();
+ } else {
+
+ // Call an optional hook to record the stack, in case of exception
+ // since it's otherwise lost when execution goes async
+ if ( jQuery.Deferred.getStackHook ) {
+ process.stackTrace = jQuery.Deferred.getStackHook();
+ }
+ window.setTimeout( process );
+ }
+ };
+ }
+
+ return jQuery.Deferred( function( newDefer ) {
+
+ // progress_handlers.add( ... )
+ tuples[ 0 ][ 3 ].add(
+ resolve(
+ 0,
+ newDefer,
+ jQuery.isFunction( onProgress ) ?
+ onProgress :
+ Identity,
+ newDefer.notifyWith
+ )
+ );
+
+ // fulfilled_handlers.add( ... )
+ tuples[ 1 ][ 3 ].add(
+ resolve(
+ 0,
+ newDefer,
+ jQuery.isFunction( onFulfilled ) ?
+ onFulfilled :
+ Identity
+ )
+ );
+
+ // rejected_handlers.add( ... )
+ tuples[ 2 ][ 3 ].add(
+ resolve(
+ 0,
+ newDefer,
+ jQuery.isFunction( onRejected ) ?
+ onRejected :
+ Thrower
+ )
+ );
+ } ).promise();
+ },
+
+ // Get a promise for this deferred
+ // If obj is provided, the promise aspect is added to the object
+ promise: function( obj ) {
+ return obj != null ? jQuery.extend( obj, promise ) : promise;
+ }
+ },
+ deferred = {};
+
+ // Add list-specific methods
+ jQuery.each( tuples, function( i, tuple ) {
+ var list = tuple[ 2 ],
+ stateString = tuple[ 5 ];
+
+ // promise.progress = list.add
+ // promise.done = list.add
+ // promise.fail = list.add
+ promise[ tuple[ 1 ] ] = list.add;
+
+ // Handle state
+ if ( stateString ) {
+ list.add(
+ function() {
+
+ // state = "resolved" (i.e., fulfilled)
+ // state = "rejected"
+ state = stateString;
+ },
+
+ // rejected_callbacks.disable
+ // fulfilled_callbacks.disable
+ tuples[ 3 - i ][ 2 ].disable,
+
+ // progress_callbacks.lock
+ tuples[ 0 ][ 2 ].lock
+ );
+ }
+
+ // progress_handlers.fire
+ // fulfilled_handlers.fire
+ // rejected_handlers.fire
+ list.add( tuple[ 3 ].fire );
+
+ // deferred.notify = function() { deferred.notifyWith(...) }
+ // deferred.resolve = function() { deferred.resolveWith(...) }
+ // deferred.reject = function() { deferred.rejectWith(...) }
+ deferred[ tuple[ 0 ] ] = function() {
+ deferred[ tuple[ 0 ] + "With" ]( this === deferred ? undefined : this, arguments );
+ return this;
+ };
+
+ // deferred.notifyWith = list.fireWith
+ // deferred.resolveWith = list.fireWith
+ // deferred.rejectWith = list.fireWith
+ deferred[ tuple[ 0 ] + "With" ] = list.fireWith;
+ } );
+
+ // Make the deferred a promise
+ promise.promise( deferred );
+
+ // Call given func if any
+ if ( func ) {
+ func.call( deferred, deferred );
+ }
+
+ // All done!
+ return deferred;
+ },
+
+ // Deferred helper
+ when: function( singleValue ) {
+ var
+
+ // count of uncompleted subordinates
+ remaining = arguments.length,
+
+ // count of unprocessed arguments
+ i = remaining,
+
+ // subordinate fulfillment data
+ resolveContexts = Array( i ),
+ resolveValues = slice.call( arguments ),
+
+ // the master Deferred
+ master = jQuery.Deferred(),
+
+ // subordinate callback factory
+ updateFunc = function( i ) {
+ return function( value ) {
+ resolveContexts[ i ] = this;
+ resolveValues[ i ] = arguments.length > 1 ? slice.call( arguments ) : value;
+ if ( !( --remaining ) ) {
+ master.resolveWith( resolveContexts, resolveValues );
+ }
+ };
+ };
+
+ // Single- and empty arguments are adopted like Promise.resolve
+ if ( remaining <= 1 ) {
+ adoptValue( singleValue, master.done( updateFunc( i ) ).resolve, master.reject );
+
+ // Use .then() to unwrap secondary thenables (cf. gh-3000)
+ if ( master.state() === "pending" ||
+ jQuery.isFunction( resolveValues[ i ] && resolveValues[ i ].then ) ) {
+
+ return master.then();
+ }
+ }
+
+ // Multiple arguments are aggregated like Promise.all array elements
+ while ( i-- ) {
+ adoptValue( resolveValues[ i ], updateFunc( i ), master.reject );
+ }
+
+ return master.promise();
+ }
+} );
+
+
+// These usually indicate a programmer mistake during development,
+// warn about them ASAP rather than swallowing them by default.
+var rerrorNames = /^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/;
+
+jQuery.Deferred.exceptionHook = function( error, stack ) {
+
+ // Support: IE 8 - 9 only
+ // Console exists when dev tools are open, which can happen at any time
+ if ( window.console && window.console.warn && error && rerrorNames.test( error.name ) ) {
+ window.console.warn( "jQuery.Deferred exception: " + error.message, error.stack, stack );
+ }
+};
+
+
+
+
+jQuery.readyException = function( error ) {
+ window.setTimeout( function() {
+ throw error;
+ } );
+};
+
+
+
+
+// The deferred used on DOM ready
+var readyList = jQuery.Deferred();
+
+jQuery.fn.ready = function( fn ) {
+
+ readyList
+ .then( fn )
+
+ // Wrap jQuery.readyException in a function so that the lookup
+ // happens at the time of error handling instead of callback
+ // registration.
+ .catch( function( error ) {
+ jQuery.readyException( error );
+ } );
+
+ return this;
+};
+
+jQuery.extend( {
+
+ // Is the DOM ready to be used? Set to true once it occurs.
+ isReady: false,
+
+ // A counter to track how many items to wait for before
+ // the ready event fires. See #6781
+ readyWait: 1,
+
+ // Hold (or release) the ready event
+ holdReady: function( hold ) {
+ if ( hold ) {
+ jQuery.readyWait++;
+ } else {
+ jQuery.ready( true );
+ }
+ },
+
+ // Handle when the DOM is ready
+ ready: function( wait ) {
+
+ // Abort if there are pending holds or we're already ready
+ if ( wait === true ? --jQuery.readyWait : jQuery.isReady ) {
+ return;
+ }
+
+ // Remember that the DOM is ready
+ jQuery.isReady = true;
+
+ // If a normal DOM Ready event fired, decrement, and wait if need be
+ if ( wait !== true && --jQuery.readyWait > 0 ) {
+ return;
+ }
+
+ // If there are functions bound, to execute
+ readyList.resolveWith( document, [ jQuery ] );
+ }
+} );
+
+jQuery.ready.then = readyList.then;
+
+// The ready event handler and self cleanup method
+function completed() {
+ document.removeEventListener( "DOMContentLoaded", completed );
+ window.removeEventListener( "load", completed );
+ jQuery.ready();
+}
+
+// Catch cases where $(document).ready() is called
+// after the browser event has already occurred.
+// Support: IE <=9 - 10 only
+// Older IE sometimes signals "interactive" too soon
+if ( document.readyState === "complete" ||
+ ( document.readyState !== "loading" && !document.documentElement.doScroll ) ) {
+
+ // Handle it asynchronously to allow scripts the opportunity to delay ready
+ window.setTimeout( jQuery.ready );
+
+} else {
+
+ // Use the handy event callback
+ document.addEventListener( "DOMContentLoaded", completed );
+
+ // A fallback to window.onload, that will always work
+ window.addEventListener( "load", completed );
+}
+
+
+
+
+// Multifunctional method to get and set values of a collection
+// The value/s can optionally be executed if it's a function
+var access = function( elems, fn, key, value, chainable, emptyGet, raw ) {
+ var i = 0,
+ len = elems.length,
+ bulk = key == null;
+
+ // Sets many values
+ if ( jQuery.type( key ) === "object" ) {
+ chainable = true;
+ for ( i in key ) {
+ access( elems, fn, i, key[ i ], true, emptyGet, raw );
+ }
+
+ // Sets one value
+ } else if ( value !== undefined ) {
+ chainable = true;
+
+ if ( !jQuery.isFunction( value ) ) {
+ raw = true;
+ }
+
+ if ( bulk ) {
+
+ // Bulk operations run against the entire set
+ if ( raw ) {
+ fn.call( elems, value );
+ fn = null;
+
+ // ...except when executing function values
+ } else {
+ bulk = fn;
+ fn = function( elem, key, value ) {
+ return bulk.call( jQuery( elem ), value );
+ };
+ }
+ }
+
+ if ( fn ) {
+ for ( ; i < len; i++ ) {
+ fn(
+ elems[ i ], key, raw ?
+ value :
+ value.call( elems[ i ], i, fn( elems[ i ], key ) )
+ );
+ }
+ }
+ }
+
+ if ( chainable ) {
+ return elems;
+ }
+
+ // Gets
+ if ( bulk ) {
+ return fn.call( elems );
+ }
+
+ return len ? fn( elems[ 0 ], key ) : emptyGet;
+};
+var acceptData = function( owner ) {
+
+ // Accepts only:
+ // - Node
+ // - Node.ELEMENT_NODE
+ // - Node.DOCUMENT_NODE
+ // - Object
+ // - Any
+ return owner.nodeType === 1 || owner.nodeType === 9 || !( +owner.nodeType );
+};
+
+
+
+
+function Data() {
+ this.expando = jQuery.expando + Data.uid++;
+}
+
+Data.uid = 1;
+
+Data.prototype = {
+
+ cache: function( owner ) {
+
+ // Check if the owner object already has a cache
+ var value = owner[ this.expando ];
+
+ // If not, create one
+ if ( !value ) {
+ value = {};
+
+ // We can accept data for non-element nodes in modern browsers,
+ // but we should not, see #8335.
+ // Always return an empty object.
+ if ( acceptData( owner ) ) {
+
+ // If it is a node unlikely to be stringify-ed or looped over
+ // use plain assignment
+ if ( owner.nodeType ) {
+ owner[ this.expando ] = value;
+
+ // Otherwise secure it in a non-enumerable property
+ // configurable must be true to allow the property to be
+ // deleted when data is removed
+ } else {
+ Object.defineProperty( owner, this.expando, {
+ value: value,
+ configurable: true
+ } );
+ }
+ }
+ }
+
+ return value;
+ },
+ set: function( owner, data, value ) {
+ var prop,
+ cache = this.cache( owner );
+
+ // Handle: [ owner, key, value ] args
+ // Always use camelCase key (gh-2257)
+ if ( typeof data === "string" ) {
+ cache[ jQuery.camelCase( data ) ] = value;
+
+ // Handle: [ owner, { properties } ] args
+ } else {
+
+ // Copy the properties one-by-one to the cache object
+ for ( prop in data ) {
+ cache[ jQuery.camelCase( prop ) ] = data[ prop ];
+ }
+ }
+ return cache;
+ },
+ get: function( owner, key ) {
+ return key === undefined ?
+ this.cache( owner ) :
+
+ // Always use camelCase key (gh-2257)
+ owner[ this.expando ] && owner[ this.expando ][ jQuery.camelCase( key ) ];
+ },
+ access: function( owner, key, value ) {
+
+ // In cases where either:
+ //
+ // 1. No key was specified
+ // 2. A string key was specified, but no value provided
+ //
+ // Take the "read" path and allow the get method to determine
+ // which value to return, respectively either:
+ //
+ // 1. The entire cache object
+ // 2. The data stored at the key
+ //
+ if ( key === undefined ||
+ ( ( key && typeof key === "string" ) && value === undefined ) ) {
+
+ return this.get( owner, key );
+ }
+
+ // When the key is not a string, or both a key and value
+ // are specified, set or extend (existing objects) with either:
+ //
+ // 1. An object of properties
+ // 2. A key and value
+ //
+ this.set( owner, key, value );
+
+ // Since the "set" path can have two possible entry points
+ // return the expected data based on which path was taken[*]
+ return value !== undefined ? value : key;
+ },
+ remove: function( owner, key ) {
+ var i,
+ cache = owner[ this.expando ];
+
+ if ( cache === undefined ) {
+ return;
+ }
+
+ if ( key !== undefined ) {
+
+ // Support array or space separated string of keys
+ if ( jQuery.isArray( key ) ) {
+
+ // If key is an array of keys...
+ // We always set camelCase keys, so remove that.
+ key = key.map( jQuery.camelCase );
+ } else {
+ key = jQuery.camelCase( key );
+
+ // If a key with the spaces exists, use it.
+ // Otherwise, create an array by matching non-whitespace
+ key = key in cache ?
+ [ key ] :
+ ( key.match( rnothtmlwhite ) || [] );
+ }
+
+ i = key.length;
+
+ while ( i-- ) {
+ delete cache[ key[ i ] ];
+ }
+ }
+
+ // Remove the expando if there's no more data
+ if ( key === undefined || jQuery.isEmptyObject( cache ) ) {
+
+ // Support: Chrome <=35 - 45
+ // Webkit & Blink performance suffers when deleting properties
+ // from DOM nodes, so set to undefined instead
+ // https://bugs.chromium.org/p/chromium/issues/detail?id=378607 (bug restricted)
+ if ( owner.nodeType ) {
+ owner[ this.expando ] = undefined;
+ } else {
+ delete owner[ this.expando ];
+ }
+ }
+ },
+ hasData: function( owner ) {
+ var cache = owner[ this.expando ];
+ return cache !== undefined && !jQuery.isEmptyObject( cache );
+ }
+};
+var dataPriv = new Data();
+
+var dataUser = new Data();
+
+
+
+// Implementation Summary
+//
+// 1. Enforce API surface and semantic compatibility with 1.9.x branch
+// 2. Improve the module's maintainability by reducing the storage
+// paths to a single mechanism.
+// 3. Use the same single mechanism to support "private" and "user" data.
+// 4. _Never_ expose "private" data to user code (TODO: Drop _data, _removeData)
+// 5. Avoid exposing implementation details on user objects (eg. expando properties)
+// 6. Provide a clear path for implementation upgrade to WeakMap in 2014
+
+var rbrace = /^(?:\{[\w\W]*\}|\[[\w\W]*\])$/,
+ rmultiDash = /[A-Z]/g;
+
+function getData( data ) {
+ if ( data === "true" ) {
+ return true;
+ }
+
+ if ( data === "false" ) {
+ return false;
+ }
+
+ if ( data === "null" ) {
+ return null;
+ }
+
+ // Only convert to a number if it doesn't change the string
+ if ( data === +data + "" ) {
+ return +data;
+ }
+
+ if ( rbrace.test( data ) ) {
+ return JSON.parse( data );
+ }
+
+ return data;
+}
+
+function dataAttr( elem, key, data ) {
+ var name;
+
+ // If nothing was found internally, try to fetch any
+ // data from the HTML5 data-* attribute
+ if ( data === undefined && elem.nodeType === 1 ) {
+ name = "data-" + key.replace( rmultiDash, "-$&" ).toLowerCase();
+ data = elem.getAttribute( name );
+
+ if ( typeof data === "string" ) {
+ try {
+ data = getData( data );
+ } catch ( e ) {}
+
+ // Make sure we set the data so it isn't changed later
+ dataUser.set( elem, key, data );
+ } else {
+ data = undefined;
+ }
+ }
+ return data;
+}
+
+jQuery.extend( {
+ hasData: function( elem ) {
+ return dataUser.hasData( elem ) || dataPriv.hasData( elem );
+ },
+
+ data: function( elem, name, data ) {
+ return dataUser.access( elem, name, data );
+ },
+
+ removeData: function( elem, name ) {
+ dataUser.remove( elem, name );
+ },
+
+ // TODO: Now that all calls to _data and _removeData have been replaced
+ // with direct calls to dataPriv methods, these can be deprecated.
+ _data: function( elem, name, data ) {
+ return dataPriv.access( elem, name, data );
+ },
+
+ _removeData: function( elem, name ) {
+ dataPriv.remove( elem, name );
+ }
+} );
+
+jQuery.fn.extend( {
+ data: function( key, value ) {
+ var i, name, data,
+ elem = this[ 0 ],
+ attrs = elem && elem.attributes;
+
+ // Gets all values
+ if ( key === undefined ) {
+ if ( this.length ) {
+ data = dataUser.get( elem );
+
+ if ( elem.nodeType === 1 && !dataPriv.get( elem, "hasDataAttrs" ) ) {
+ i = attrs.length;
+ while ( i-- ) {
+
+ // Support: IE 11 only
+ // The attrs elements can be null (#14894)
+ if ( attrs[ i ] ) {
+ name = attrs[ i ].name;
+ if ( name.indexOf( "data-" ) === 0 ) {
+ name = jQuery.camelCase( name.slice( 5 ) );
+ dataAttr( elem, name, data[ name ] );
+ }
+ }
+ }
+ dataPriv.set( elem, "hasDataAttrs", true );
+ }
+ }
+
+ return data;
+ }
+
+ // Sets multiple values
+ if ( typeof key === "object" ) {
+ return this.each( function() {
+ dataUser.set( this, key );
+ } );
+ }
+
+ return access( this, function( value ) {
+ var data;
+
+ // The calling jQuery object (element matches) is not empty
+ // (and therefore has an element appears at this[ 0 ]) and the
+ // `value` parameter was not undefined. An empty jQuery object
+ // will result in `undefined` for elem = this[ 0 ] which will
+ // throw an exception if an attempt to read a data cache is made.
+ if ( elem && value === undefined ) {
+
+ // Attempt to get data from the cache
+ // The key will always be camelCased in Data
+ data = dataUser.get( elem, key );
+ if ( data !== undefined ) {
+ return data;
+ }
+
+ // Attempt to "discover" the data in
+ // HTML5 custom data-* attrs
+ data = dataAttr( elem, key );
+ if ( data !== undefined ) {
+ return data;
+ }
+
+ // We tried really hard, but the data doesn't exist.
+ return;
+ }
+
+ // Set the data...
+ this.each( function() {
+
+ // We always store the camelCased key
+ dataUser.set( this, key, value );
+ } );
+ }, null, value, arguments.length > 1, null, true );
+ },
+
+ removeData: function( key ) {
+ return this.each( function() {
+ dataUser.remove( this, key );
+ } );
+ }
+} );
+
+
+jQuery.extend( {
+ queue: function( elem, type, data ) {
+ var queue;
+
+ if ( elem ) {
+ type = ( type || "fx" ) + "queue";
+ queue = dataPriv.get( elem, type );
+
+ // Speed up dequeue by getting out quickly if this is just a lookup
+ if ( data ) {
+ if ( !queue || jQuery.isArray( data ) ) {
+ queue = dataPriv.access( elem, type, jQuery.makeArray( data ) );
+ } else {
+ queue.push( data );
+ }
+ }
+ return queue || [];
+ }
+ },
+
+ dequeue: function( elem, type ) {
+ type = type || "fx";
+
+ var queue = jQuery.queue( elem, type ),
+ startLength = queue.length,
+ fn = queue.shift(),
+ hooks = jQuery._queueHooks( elem, type ),
+ next = function() {
+ jQuery.dequeue( elem, type );
+ };
+
+ // If the fx queue is dequeued, always remove the progress sentinel
+ if ( fn === "inprogress" ) {
+ fn = queue.shift();
+ startLength--;
+ }
+
+ if ( fn ) {
+
+ // Add a progress sentinel to prevent the fx queue from being
+ // automatically dequeued
+ if ( type === "fx" ) {
+ queue.unshift( "inprogress" );
+ }
+
+ // Clear up the last queue stop function
+ delete hooks.stop;
+ fn.call( elem, next, hooks );
+ }
+
+ if ( !startLength && hooks ) {
+ hooks.empty.fire();
+ }
+ },
+
+ // Not public - generate a queueHooks object, or return the current one
+ _queueHooks: function( elem, type ) {
+ var key = type + "queueHooks";
+ return dataPriv.get( elem, key ) || dataPriv.access( elem, key, {
+ empty: jQuery.Callbacks( "once memory" ).add( function() {
+ dataPriv.remove( elem, [ type + "queue", key ] );
+ } )
+ } );
+ }
+} );
+
+jQuery.fn.extend( {
+ queue: function( type, data ) {
+ var setter = 2;
+
+ if ( typeof type !== "string" ) {
+ data = type;
+ type = "fx";
+ setter--;
+ }
+
+ if ( arguments.length < setter ) {
+ return jQuery.queue( this[ 0 ], type );
+ }
+
+ return data === undefined ?
+ this :
+ this.each( function() {
+ var queue = jQuery.queue( this, type, data );
+
+ // Ensure a hooks for this queue
+ jQuery._queueHooks( this, type );
+
+ if ( type === "fx" && queue[ 0 ] !== "inprogress" ) {
+ jQuery.dequeue( this, type );
+ }
+ } );
+ },
+ dequeue: function( type ) {
+ return this.each( function() {
+ jQuery.dequeue( this, type );
+ } );
+ },
+ clearQueue: function( type ) {
+ return this.queue( type || "fx", [] );
+ },
+
+ // Get a promise resolved when queues of a certain type
+ // are emptied (fx is the type by default)
+ promise: function( type, obj ) {
+ var tmp,
+ count = 1,
+ defer = jQuery.Deferred(),
+ elements = this,
+ i = this.length,
+ resolve = function() {
+ if ( !( --count ) ) {
+ defer.resolveWith( elements, [ elements ] );
+ }
+ };
+
+ if ( typeof type !== "string" ) {
+ obj = type;
+ type = undefined;
+ }
+ type = type || "fx";
+
+ while ( i-- ) {
+ tmp = dataPriv.get( elements[ i ], type + "queueHooks" );
+ if ( tmp && tmp.empty ) {
+ count++;
+ tmp.empty.add( resolve );
+ }
+ }
+ resolve();
+ return defer.promise( obj );
+ }
+} );
+var pnum = ( /[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/ ).source;
+
+var rcssNum = new RegExp( "^(?:([+-])=|)(" + pnum + ")([a-z%]*)$", "i" );
+
+
+var cssExpand = [ "Top", "Right", "Bottom", "Left" ];
+
+var isHiddenWithinTree = function( elem, el ) {
+
+ // isHiddenWithinTree might be called from jQuery#filter function;
+ // in that case, element will be second argument
+ elem = el || elem;
+
+ // Inline style trumps all
+ return elem.style.display === "none" ||
+ elem.style.display === "" &&
+
+ // Otherwise, check computed style
+ // Support: Firefox <=43 - 45
+ // Disconnected elements can have computed display: none, so first confirm that elem is
+ // in the document.
+ jQuery.contains( elem.ownerDocument, elem ) &&
+
+ jQuery.css( elem, "display" ) === "none";
+ };
+
+var swap = function( elem, options, callback, args ) {
+ var ret, name,
+ old = {};
+
+ // Remember the old values, and insert the new ones
+ for ( name in options ) {
+ old[ name ] = elem.style[ name ];
+ elem.style[ name ] = options[ name ];
+ }
+
+ ret = callback.apply( elem, args || [] );
+
+ // Revert the old values
+ for ( name in options ) {
+ elem.style[ name ] = old[ name ];
+ }
+
+ return ret;
+};
+
+
+
+
+function adjustCSS( elem, prop, valueParts, tween ) {
+ var adjusted,
+ scale = 1,
+ maxIterations = 20,
+ currentValue = tween ?
+ function() {
+ return tween.cur();
+ } :
+ function() {
+ return jQuery.css( elem, prop, "" );
+ },
+ initial = currentValue(),
+ unit = valueParts && valueParts[ 3 ] || ( jQuery.cssNumber[ prop ] ? "" : "px" ),
+
+ // Starting value computation is required for potential unit mismatches
+ initialInUnit = ( jQuery.cssNumber[ prop ] || unit !== "px" && +initial ) &&
+ rcssNum.exec( jQuery.css( elem, prop ) );
+
+ if ( initialInUnit && initialInUnit[ 3 ] !== unit ) {
+
+ // Trust units reported by jQuery.css
+ unit = unit || initialInUnit[ 3 ];
+
+ // Make sure we update the tween properties later on
+ valueParts = valueParts || [];
+
+ // Iteratively approximate from a nonzero starting point
+ initialInUnit = +initial || 1;
+
+ do {
+
+ // If previous iteration zeroed out, double until we get *something*.
+ // Use string for doubling so we don't accidentally see scale as unchanged below
+ scale = scale || ".5";
+
+ // Adjust and apply
+ initialInUnit = initialInUnit / scale;
+ jQuery.style( elem, prop, initialInUnit + unit );
+
+ // Update scale, tolerating zero or NaN from tween.cur()
+ // Break the loop if scale is unchanged or perfect, or if we've just had enough.
+ } while (
+ scale !== ( scale = currentValue() / initial ) && scale !== 1 && --maxIterations
+ );
+ }
+
+ if ( valueParts ) {
+ initialInUnit = +initialInUnit || +initial || 0;
+
+ // Apply relative offset (+=/-=) if specified
+ adjusted = valueParts[ 1 ] ?
+ initialInUnit + ( valueParts[ 1 ] + 1 ) * valueParts[ 2 ] :
+ +valueParts[ 2 ];
+ if ( tween ) {
+ tween.unit = unit;
+ tween.start = initialInUnit;
+ tween.end = adjusted;
+ }
+ }
+ return adjusted;
+}
+
+
+var defaultDisplayMap = {};
+
+function getDefaultDisplay( elem ) {
+ var temp,
+ doc = elem.ownerDocument,
+ nodeName = elem.nodeName,
+ display = defaultDisplayMap[ nodeName ];
+
+ if ( display ) {
+ return display;
+ }
+
+ temp = doc.body.appendChild( doc.createElement( nodeName ) );
+ display = jQuery.css( temp, "display" );
+
+ temp.parentNode.removeChild( temp );
+
+ if ( display === "none" ) {
+ display = "block";
+ }
+ defaultDisplayMap[ nodeName ] = display;
+
+ return display;
+}
+
+function showHide( elements, show ) {
+ var display, elem,
+ values = [],
+ index = 0,
+ length = elements.length;
+
+ // Determine new display value for elements that need to change
+ for ( ; index < length; index++ ) {
+ elem = elements[ index ];
+ if ( !elem.style ) {
+ continue;
+ }
+
+ display = elem.style.display;
+ if ( show ) {
+
+ // Since we force visibility upon cascade-hidden elements, an immediate (and slow)
+ // check is required in this first loop unless we have a nonempty display value (either
+ // inline or about-to-be-restored)
+ if ( display === "none" ) {
+ values[ index ] = dataPriv.get( elem, "display" ) || null;
+ if ( !values[ index ] ) {
+ elem.style.display = "";
+ }
+ }
+ if ( elem.style.display === "" && isHiddenWithinTree( elem ) ) {
+ values[ index ] = getDefaultDisplay( elem );
+ }
+ } else {
+ if ( display !== "none" ) {
+ values[ index ] = "none";
+
+ // Remember what we're overwriting
+ dataPriv.set( elem, "display", display );
+ }
+ }
+ }
+
+ // Set the display of the elements in a second loop to avoid constant reflow
+ for ( index = 0; index < length; index++ ) {
+ if ( values[ index ] != null ) {
+ elements[ index ].style.display = values[ index ];
+ }
+ }
+
+ return elements;
+}
+
+jQuery.fn.extend( {
+ show: function() {
+ return showHide( this, true );
+ },
+ hide: function() {
+ return showHide( this );
+ },
+ toggle: function( state ) {
+ if ( typeof state === "boolean" ) {
+ return state ? this.show() : this.hide();
+ }
+
+ return this.each( function() {
+ if ( isHiddenWithinTree( this ) ) {
+ jQuery( this ).show();
+ } else {
+ jQuery( this ).hide();
+ }
+ } );
+ }
+} );
+var rcheckableType = ( /^(?:checkbox|radio)$/i );
+
+var rtagName = ( /<([a-z][^\/\0>\x20\t\r\n\f]+)/i );
+
+var rscriptType = ( /^$|\/(?:java|ecma)script/i );
+
+
+
+// We have to close these tags to support XHTML (#13200)
+var wrapMap = {
+
+ // Support: IE <=9 only
+ option: [ 1, "<select multiple='multiple'>", "</select>" ],
+
+ // XHTML parsers do not magically insert elements in the
+ // same way that tag soup parsers do. So we cannot shorten
+ // this by omitting <tbody> or other required elements.
+ thead: [ 1, "<table>", "</table>" ],
+ col: [ 2, "<table><colgroup>", "</colgroup></table>" ],
+ tr: [ 2, "<table><tbody>", "</tbody></table>" ],
+ td: [ 3, "<table><tbody><tr>", "</tr></tbody></table>" ],
+
+ _default: [ 0, "", "" ]
+};
+
+// Support: IE <=9 only
+wrapMap.optgroup = wrapMap.option;
+
+wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead;
+wrapMap.th = wrapMap.td;
+
+
+function getAll( context, tag ) {
+
+ // Support: IE <=9 - 11 only
+ // Use typeof to avoid zero-argument method invocation on host objects (#15151)
+ var ret;
+
+ if ( typeof context.getElementsByTagName !== "undefined" ) {
+ ret = context.getElementsByTagName( tag || "*" );
+
+ } else if ( typeof context.querySelectorAll !== "undefined" ) {
+ ret = context.querySelectorAll( tag || "*" );
+
+ } else {
+ ret = [];
+ }
+
+ if ( tag === undefined || tag && jQuery.nodeName( context, tag ) ) {
+ return jQuery.merge( [ context ], ret );
+ }
+
+ return ret;
+}
+
+
+// Mark scripts as having already been evaluated
+function setGlobalEval( elems, refElements ) {
+ var i = 0,
+ l = elems.length;
+
+ for ( ; i < l; i++ ) {
+ dataPriv.set(
+ elems[ i ],
+ "globalEval",
+ !refElements || dataPriv.get( refElements[ i ], "globalEval" )
+ );
+ }
+}
+
+
+var rhtml = /<|&#?\w+;/;
+
+function buildFragment( elems, context, scripts, selection, ignored ) {
+ var elem, tmp, tag, wrap, contains, j,
+ fragment = context.createDocumentFragment(),
+ nodes = [],
+ i = 0,
+ l = elems.length;
+
+ for ( ; i < l; i++ ) {
+ elem = elems[ i ];
+
+ if ( elem || elem === 0 ) {
+
+ // Add nodes directly
+ if ( jQuery.type( elem ) === "object" ) {
+
+ // Support: Android <=4.0 only, PhantomJS 1 only
+ // push.apply(_, arraylike) throws on ancient WebKit
+ jQuery.merge( nodes, elem.nodeType ? [ elem ] : elem );
+
+ // Convert non-html into a text node
+ } else if ( !rhtml.test( elem ) ) {
+ nodes.push( context.createTextNode( elem ) );
+
+ // Convert html into DOM nodes
+ } else {
+ tmp = tmp || fragment.appendChild( context.createElement( "div" ) );
+
+ // Deserialize a standard representation
+ tag = ( rtagName.exec( elem ) || [ "", "" ] )[ 1 ].toLowerCase();
+ wrap = wrapMap[ tag ] || wrapMap._default;
+ tmp.innerHTML = wrap[ 1 ] + jQuery.htmlPrefilter( elem ) + wrap[ 2 ];
+
+ // Descend through wrappers to the right content
+ j = wrap[ 0 ];
+ while ( j-- ) {
+ tmp = tmp.lastChild;
+ }
+
+ // Support: Android <=4.0 only, PhantomJS 1 only
+ // push.apply(_, arraylike) throws on ancient WebKit
+ jQuery.merge( nodes, tmp.childNodes );
+
+ // Remember the top-level container
+ tmp = fragment.firstChild;
+
+ // Ensure the created nodes are orphaned (#12392)
+ tmp.textContent = "";
+ }
+ }
+ }
+
+ // Remove wrapper from fragment
+ fragment.textContent = "";
+
+ i = 0;
+ while ( ( elem = nodes[ i++ ] ) ) {
+
+ // Skip elements already in the context collection (trac-4087)
+ if ( selection && jQuery.inArray( elem, selection ) > -1 ) {
+ if ( ignored ) {
+ ignored.push( elem );
+ }
+ continue;
+ }
+
+ contains = jQuery.contains( elem.ownerDocument, elem );
+
+ // Append to fragment
+ tmp = getAll( fragment.appendChild( elem ), "script" );
+
+ // Preserve script evaluation history
+ if ( contains ) {
+ setGlobalEval( tmp );
+ }
+
+ // Capture executables
+ if ( scripts ) {
+ j = 0;
+ while ( ( elem = tmp[ j++ ] ) ) {
+ if ( rscriptType.test( elem.type || "" ) ) {
+ scripts.push( elem );
+ }
+ }
+ }
+ }
+
+ return fragment;
+}
+
+
+( function() {
+ var fragment = document.createDocumentFragment(),
+ div = fragment.appendChild( document.createElement( "div" ) ),
+ input = document.createElement( "input" );
+
+ // Support: Android 4.0 - 4.3 only
+ // Check state lost if the name is set (#11217)
+ // Support: Windows Web Apps (WWA)
+ // `name` and `type` must use .setAttribute for WWA (#14901)
+ input.setAttribute( "type", "radio" );
+ input.setAttribute( "checked", "checked" );
+ input.setAttribute( "name", "t" );
+
+ div.appendChild( input );
+
+ // Support: Android <=4.1 only
+ // Older WebKit doesn't clone checked state correctly in fragments
+ support.checkClone = div.cloneNode( true ).cloneNode( true ).lastChild.checked;
+
+ // Support: IE <=11 only
+ // Make sure textarea (and checkbox) defaultValue is properly cloned
+ div.innerHTML = "<textarea>x</textarea>";
+ support.noCloneChecked = !!div.cloneNode( true ).lastChild.defaultValue;
+} )();
+var documentElement = document.documentElement;
+
+
+
+var
+ rkeyEvent = /^key/,
+ rmouseEvent = /^(?:mouse|pointer|contextmenu|drag|drop)|click/,
+ rtypenamespace = /^([^.]*)(?:\.(.+)|)/;
+
+function returnTrue() {
+ return true;
+}
+
+function returnFalse() {
+ return false;
+}
+
+// Support: IE <=9 only
+// See #13393 for more info
+function safeActiveElement() {
+ try {
+ return document.activeElement;
+ } catch ( err ) { }
+}
+
+function on( elem, types, selector, data, fn, one ) {
+ var origFn, type;
+
+ // Types can be a map of types/handlers
+ if ( typeof types === "object" ) {
+
+ // ( types-Object, selector, data )
+ if ( typeof selector !== "string" ) {
+
+ // ( types-Object, data )
+ data = data || selector;
+ selector = undefined;
+ }
+ for ( type in types ) {
+ on( elem, type, selector, data, types[ type ], one );
+ }
+ return elem;
+ }
+
+ if ( data == null && fn == null ) {
+
+ // ( types, fn )
+ fn = selector;
+ data = selector = undefined;
+ } else if ( fn == null ) {
+ if ( typeof selector === "string" ) {
+
+ // ( types, selector, fn )
+ fn = data;
+ data = undefined;
+ } else {
+
+ // ( types, data, fn )
+ fn = data;
+ data = selector;
+ selector = undefined;
+ }
+ }
+ if ( fn === false ) {
+ fn = returnFalse;
+ } else if ( !fn ) {
+ return elem;
+ }
+
+ if ( one === 1 ) {
+ origFn = fn;
+ fn = function( event ) {
+
+ // Can use an empty set, since event contains the info
+ jQuery().off( event );
+ return origFn.apply( this, arguments );
+ };
+
+ // Use same guid so caller can remove using origFn
+ fn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ );
+ }
+ return elem.each( function() {
+ jQuery.event.add( this, types, fn, data, selector );
+ } );
+}
+
+/*
+ * Helper functions for managing events -- not part of the public interface.
+ * Props to Dean Edwards' addEvent library for many of the ideas.
+ */
+jQuery.event = {
+
+ global: {},
+
+ add: function( elem, types, handler, data, selector ) {
+
+ var handleObjIn, eventHandle, tmp,
+ events, t, handleObj,
+ special, handlers, type, namespaces, origType,
+ elemData = dataPriv.get( elem );
+
+ // Don't attach events to noData or text/comment nodes (but allow plain objects)
+ if ( !elemData ) {
+ return;
+ }
+
+ // Caller can pass in an object of custom data in lieu of the handler
+ if ( handler.handler ) {
+ handleObjIn = handler;
+ handler = handleObjIn.handler;
+ selector = handleObjIn.selector;
+ }
+
+ // Ensure that invalid selectors throw exceptions at attach time
+ // Evaluate against documentElement in case elem is a non-element node (e.g., document)
+ if ( selector ) {
+ jQuery.find.matchesSelector( documentElement, selector );
+ }
+
+ // Make sure that the handler has a unique ID, used to find/remove it later
+ if ( !handler.guid ) {
+ handler.guid = jQuery.guid++;
+ }
+
+ // Init the element's event structure and main handler, if this is the first
+ if ( !( events = elemData.events ) ) {
+ events = elemData.events = {};
+ }
+ if ( !( eventHandle = elemData.handle ) ) {
+ eventHandle = elemData.handle = function( e ) {
+
+ // Discard the second event of a jQuery.event.trigger() and
+ // when an event is called after a page has unloaded
+ return typeof jQuery !== "undefined" && jQuery.event.triggered !== e.type ?
+ jQuery.event.dispatch.apply( elem, arguments ) : undefined;
+ };
+ }
+
+ // Handle multiple events separated by a space
+ types = ( types || "" ).match( rnothtmlwhite ) || [ "" ];
+ t = types.length;
+ while ( t-- ) {
+ tmp = rtypenamespace.exec( types[ t ] ) || [];
+ type = origType = tmp[ 1 ];
+ namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort();
+
+ // There *must* be a type, no attaching namespace-only handlers
+ if ( !type ) {
+ continue;
+ }
+
+ // If event changes its type, use the special event handlers for the changed type
+ special = jQuery.event.special[ type ] || {};
+
+ // If selector defined, determine special event api type, otherwise given type
+ type = ( selector ? special.delegateType : special.bindType ) || type;
+
+ // Update special based on newly reset type
+ special = jQuery.event.special[ type ] || {};
+
+ // handleObj is passed to all event handlers
+ handleObj = jQuery.extend( {
+ type: type,
+ origType: origType,
+ data: data,
+ handler: handler,
+ guid: handler.guid,
+ selector: selector,
+ needsContext: selector && jQuery.expr.match.needsContext.test( selector ),
+ namespace: namespaces.join( "." )
+ }, handleObjIn );
+
+ // Init the event handler queue if we're the first
+ if ( !( handlers = events[ type ] ) ) {
+ handlers = events[ type ] = [];
+ handlers.delegateCount = 0;
+
+ // Only use addEventListener if the special events handler returns false
+ if ( !special.setup ||
+ special.setup.call( elem, data, namespaces, eventHandle ) === false ) {
+
+ if ( elem.addEventListener ) {
+ elem.addEventListener( type, eventHandle );
+ }
+ }
+ }
+
+ if ( special.add ) {
+ special.add.call( elem, handleObj );
+
+ if ( !handleObj.handler.guid ) {
+ handleObj.handler.guid = handler.guid;
+ }
+ }
+
+ // Add to the element's handler list, delegates in front
+ if ( selector ) {
+ handlers.splice( handlers.delegateCount++, 0, handleObj );
+ } else {
+ handlers.push( handleObj );
+ }
+
+ // Keep track of which events have ever been used, for event optimization
+ jQuery.event.global[ type ] = true;
+ }
+
+ },
+
+ // Detach an event or set of events from an element
+ remove: function( elem, types, handler, selector, mappedTypes ) {
+
+ var j, origCount, tmp,
+ events, t, handleObj,
+ special, handlers, type, namespaces, origType,
+ elemData = dataPriv.hasData( elem ) && dataPriv.get( elem );
+
+ if ( !elemData || !( events = elemData.events ) ) {
+ return;
+ }
+
+ // Once for each type.namespace in types; type may be omitted
+ types = ( types || "" ).match( rnothtmlwhite ) || [ "" ];
+ t = types.length;
+ while ( t-- ) {
+ tmp = rtypenamespace.exec( types[ t ] ) || [];
+ type = origType = tmp[ 1 ];
+ namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort();
+
+ // Unbind all events (on this namespace, if provided) for the element
+ if ( !type ) {
+ for ( type in events ) {
+ jQuery.event.remove( elem, type + types[ t ], handler, selector, true );
+ }
+ continue;
+ }
+
+ special = jQuery.event.special[ type ] || {};
+ type = ( selector ? special.delegateType : special.bindType ) || type;
+ handlers = events[ type ] || [];
+ tmp = tmp[ 2 ] &&
+ new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" );
+
+ // Remove matching events
+ origCount = j = handlers.length;
+ while ( j-- ) {
+ handleObj = handlers[ j ];
+
+ if ( ( mappedTypes || origType === handleObj.origType ) &&
+ ( !handler || handler.guid === handleObj.guid ) &&
+ ( !tmp || tmp.test( handleObj.namespace ) ) &&
+ ( !selector || selector === handleObj.selector ||
+ selector === "**" && handleObj.selector ) ) {
+ handlers.splice( j, 1 );
+
+ if ( handleObj.selector ) {
+ handlers.delegateCount--;
+ }
+ if ( special.remove ) {
+ special.remove.call( elem, handleObj );
+ }
+ }
+ }
+
+ // Remove generic event handler if we removed something and no more handlers exist
+ // (avoids potential for endless recursion during removal of special event handlers)
+ if ( origCount && !handlers.length ) {
+ if ( !special.teardown ||
+ special.teardown.call( elem, namespaces, elemData.handle ) === false ) {
+
+ jQuery.removeEvent( elem, type, elemData.handle );
+ }
+
+ delete events[ type ];
+ }
+ }
+
+ // Remove data and the expando if it's no longer used
+ if ( jQuery.isEmptyObject( events ) ) {
+ dataPriv.remove( elem, "handle events" );
+ }
+ },
+
+ dispatch: function( nativeEvent ) {
+
+ // Make a writable jQuery.Event from the native event object
+ var event = jQuery.event.fix( nativeEvent );
+
+ var i, j, ret, matched, handleObj, handlerQueue,
+ args = new Array( arguments.length ),
+ handlers = ( dataPriv.get( this, "events" ) || {} )[ event.type ] || [],
+ special = jQuery.event.special[ event.type ] || {};
+
+ // Use the fix-ed jQuery.Event rather than the (read-only) native event
+ args[ 0 ] = event;
+
+ for ( i = 1; i < arguments.length; i++ ) {
+ args[ i ] = arguments[ i ];
+ }
+
+ event.delegateTarget = this;
+
+ // Call the preDispatch hook for the mapped type, and let it bail if desired
+ if ( special.preDispatch && special.preDispatch.call( this, event ) === false ) {
+ return;
+ }
+
+ // Determine handlers
+ handlerQueue = jQuery.event.handlers.call( this, event, handlers );
+
+ // Run delegates first; they may want to stop propagation beneath us
+ i = 0;
+ while ( ( matched = handlerQueue[ i++ ] ) && !event.isPropagationStopped() ) {
+ event.currentTarget = matched.elem;
+
+ j = 0;
+ while ( ( handleObj = matched.handlers[ j++ ] ) &&
+ !event.isImmediatePropagationStopped() ) {
+
+ // Triggered event must either 1) have no namespace, or 2) have namespace(s)
+ // a subset or equal to those in the bound event (both can have no namespace).
+ if ( !event.rnamespace || event.rnamespace.test( handleObj.namespace ) ) {
+
+ event.handleObj = handleObj;
+ event.data = handleObj.data;
+
+ ret = ( ( jQuery.event.special[ handleObj.origType ] || {} ).handle ||
+ handleObj.handler ).apply( matched.elem, args );
+
+ if ( ret !== undefined ) {
+ if ( ( event.result = ret ) === false ) {
+ event.preventDefault();
+ event.stopPropagation();
+ }
+ }
+ }
+ }
+ }
+
+ // Call the postDispatch hook for the mapped type
+ if ( special.postDispatch ) {
+ special.postDispatch.call( this, event );
+ }
+
+ return event.result;
+ },
+
+ handlers: function( event, handlers ) {
+ var i, handleObj, sel, matchedHandlers, matchedSelectors,
+ handlerQueue = [],
+ delegateCount = handlers.delegateCount,
+ cur = event.target;
+
+ // Find delegate handlers
+ if ( delegateCount &&
+
+ // Support: IE <=9
+ // Black-hole SVG <use> instance trees (trac-13180)
+ cur.nodeType &&
+
+ // Support: Firefox <=42
+ // Suppress spec-violating clicks indicating a non-primary pointer button (trac-3861)
+ // https://www.w3.org/TR/DOM-Level-3-Events/#event-type-click
+ // Support: IE 11 only
+ // ...but not arrow key "clicks" of radio inputs, which can have `button` -1 (gh-2343)
+ !( event.type === "click" && event.button >= 1 ) ) {
+
+ for ( ; cur !== this; cur = cur.parentNode || this ) {
+
+ // Don't check non-elements (#13208)
+ // Don't process clicks on disabled elements (#6911, #8165, #11382, #11764)
+ if ( cur.nodeType === 1 && !( event.type === "click" && cur.disabled === true ) ) {
+ matchedHandlers = [];
+ matchedSelectors = {};
+ for ( i = 0; i < delegateCount; i++ ) {
+ handleObj = handlers[ i ];
+
+ // Don't conflict with Object.prototype properties (#13203)
+ sel = handleObj.selector + " ";
+
+ if ( matchedSelectors[ sel ] === undefined ) {
+ matchedSelectors[ sel ] = handleObj.needsContext ?
+ jQuery( sel, this ).index( cur ) > -1 :
+ jQuery.find( sel, this, null, [ cur ] ).length;
+ }
+ if ( matchedSelectors[ sel ] ) {
+ matchedHandlers.push( handleObj );
+ }
+ }
+ if ( matchedHandlers.length ) {
+ handlerQueue.push( { elem: cur, handlers: matchedHandlers } );
+ }
+ }
+ }
+ }
+
+ // Add the remaining (directly-bound) handlers
+ cur = this;
+ if ( delegateCount < handlers.length ) {
+ handlerQueue.push( { elem: cur, handlers: handlers.slice( delegateCount ) } );
+ }
+
+ return handlerQueue;
+ },
+
+ addProp: function( name, hook ) {
+ Object.defineProperty( jQuery.Event.prototype, name, {
+ enumerable: true,
+ configurable: true,
+
+ get: jQuery.isFunction( hook ) ?
+ function() {
+ if ( this.originalEvent ) {
+ return hook( this.originalEvent );
+ }
+ } :
+ function() {
+ if ( this.originalEvent ) {
+ return this.originalEvent[ name ];
+ }
+ },
+
+ set: function( value ) {
+ Object.defineProperty( this, name, {
+ enumerable: true,
+ configurable: true,
+ writable: true,
+ value: value
+ } );
+ }
+ } );
+ },
+
+ fix: function( originalEvent ) {
+ return originalEvent[ jQuery.expando ] ?
+ originalEvent :
+ new jQuery.Event( originalEvent );
+ },
+
+ special: {
+ load: {
+
+ // Prevent triggered image.load events from bubbling to window.load
+ noBubble: true
+ },
+ focus: {
+
+ // Fire native event if possible so blur/focus sequence is correct
+ trigger: function() {
+ if ( this !== safeActiveElement() && this.focus ) {
+ this.focus();
+ return false;
+ }
+ },
+ delegateType: "focusin"
+ },
+ blur: {
+ trigger: function() {
+ if ( this === safeActiveElement() && this.blur ) {
+ this.blur();
+ return false;
+ }
+ },
+ delegateType: "focusout"
+ },
+ click: {
+
+ // For checkbox, fire native event so checked state will be right
+ trigger: function() {
+ if ( this.type === "checkbox" && this.click && jQuery.nodeName( this, "input" ) ) {
+ this.click();
+ return false;
+ }
+ },
+
+ // For cross-browser consistency, don't fire native .click() on links
+ _default: function( event ) {
+ return jQuery.nodeName( event.target, "a" );
+ }
+ },
+
+ beforeunload: {
+ postDispatch: function( event ) {
+
+ // Support: Firefox 20+
+ // Firefox doesn't alert if the returnValue field is not set.
+ if ( event.result !== undefined && event.originalEvent ) {
+ event.originalEvent.returnValue = event.result;
+ }
+ }
+ }
+ }
+};
+
+jQuery.removeEvent = function( elem, type, handle ) {
+
+ // This "if" is needed for plain objects
+ if ( elem.removeEventListener ) {
+ elem.removeEventListener( type, handle );
+ }
+};
+
+jQuery.Event = function( src, props ) {
+
+ // Allow instantiation without the 'new' keyword
+ if ( !( this instanceof jQuery.Event ) ) {
+ return new jQuery.Event( src, props );
+ }
+
+ // Event object
+ if ( src && src.type ) {
+ this.originalEvent = src;
+ this.type = src.type;
+
+ // Events bubbling up the document may have been marked as prevented
+ // by a handler lower down the tree; reflect the correct value.
+ this.isDefaultPrevented = src.defaultPrevented ||
+ src.defaultPrevented === undefined &&
+
+ // Support: Android <=2.3 only
+ src.returnValue === false ?
+ returnTrue :
+ returnFalse;
+
+ // Create target properties
+ // Support: Safari <=6 - 7 only
+ // Target should not be a text node (#504, #13143)
+ this.target = ( src.target && src.target.nodeType === 3 ) ?
+ src.target.parentNode :
+ src.target;
+
+ this.currentTarget = src.currentTarget;
+ this.relatedTarget = src.relatedTarget;
+
+ // Event type
+ } else {
+ this.type = src;
+ }
+
+ // Put explicitly provided properties onto the event object
+ if ( props ) {
+ jQuery.extend( this, props );
+ }
+
+ // Create a timestamp if incoming event doesn't have one
+ this.timeStamp = src && src.timeStamp || jQuery.now();
+
+ // Mark it as fixed
+ this[ jQuery.expando ] = true;
+};
+
+// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding
+// https://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html
+jQuery.Event.prototype = {
+ constructor: jQuery.Event,
+ isDefaultPrevented: returnFalse,
+ isPropagationStopped: returnFalse,
+ isImmediatePropagationStopped: returnFalse,
+ isSimulated: false,
+
+ preventDefault: function() {
+ var e = this.originalEvent;
+
+ this.isDefaultPrevented = returnTrue;
+
+ if ( e && !this.isSimulated ) {
+ e.preventDefault();
+ }
+ },
+ stopPropagation: function() {
+ var e = this.originalEvent;
+
+ this.isPropagationStopped = returnTrue;
+
+ if ( e && !this.isSimulated ) {
+ e.stopPropagation();
+ }
+ },
+ stopImmediatePropagation: function() {
+ var e = this.originalEvent;
+
+ this.isImmediatePropagationStopped = returnTrue;
+
+ if ( e && !this.isSimulated ) {
+ e.stopImmediatePropagation();
+ }
+
+ this.stopPropagation();
+ }
+};
+
+// Includes all common event props including KeyEvent and MouseEvent specific props
+jQuery.each( {
+ altKey: true,
+ bubbles: true,
+ cancelable: true,
+ changedTouches: true,
+ ctrlKey: true,
+ detail: true,
+ eventPhase: true,
+ metaKey: true,
+ pageX: true,
+ pageY: true,
+ shiftKey: true,
+ view: true,
+ "char": true,
+ charCode: true,
+ key: true,
+ keyCode: true,
+ button: true,
+ buttons: true,
+ clientX: true,
+ clientY: true,
+ offsetX: true,
+ offsetY: true,
+ pointerId: true,
+ pointerType: true,
+ screenX: true,
+ screenY: true,
+ targetTouches: true,
+ toElement: true,
+ touches: true,
+
+ which: function( event ) {
+ var button = event.button;
+
+ // Add which for key events
+ if ( event.which == null && rkeyEvent.test( event.type ) ) {
+ return event.charCode != null ? event.charCode : event.keyCode;
+ }
+
+ // Add which for click: 1 === left; 2 === middle; 3 === right
+ if ( !event.which && button !== undefined && rmouseEvent.test( event.type ) ) {
+ if ( button & 1 ) {
+ return 1;
+ }
+
+ if ( button & 2 ) {
+ return 3;
+ }
+
+ if ( button & 4 ) {
+ return 2;
+ }
+
+ return 0;
+ }
+
+ return event.which;
+ }
+}, jQuery.event.addProp );
+
+// Create mouseenter/leave events using mouseover/out and event-time checks
+// so that event delegation works in jQuery.
+// Do the same for pointerenter/pointerleave and pointerover/pointerout
+//
+// Support: Safari 7 only
+// Safari sends mouseenter too often; see:
+// https://bugs.chromium.org/p/chromium/issues/detail?id=470258
+// for the description of the bug (it existed in older Chrome versions as well).
+jQuery.each( {
+ mouseenter: "mouseover",
+ mouseleave: "mouseout",
+ pointerenter: "pointerover",
+ pointerleave: "pointerout"
+}, function( orig, fix ) {
+ jQuery.event.special[ orig ] = {
+ delegateType: fix,
+ bindType: fix,
+
+ handle: function( event ) {
+ var ret,
+ target = this,
+ related = event.relatedTarget,
+ handleObj = event.handleObj;
+
+ // For mouseenter/leave call the handler if related is outside the target.
+ // NB: No relatedTarget if the mouse left/entered the browser window
+ if ( !related || ( related !== target && !jQuery.contains( target, related ) ) ) {
+ event.type = handleObj.origType;
+ ret = handleObj.handler.apply( this, arguments );
+ event.type = fix;
+ }
+ return ret;
+ }
+ };
+} );
+
+jQuery.fn.extend( {
+
+ on: function( types, selector, data, fn ) {
+ return on( this, types, selector, data, fn );
+ },
+ one: function( types, selector, data, fn ) {
+ return on( this, types, selector, data, fn, 1 );
+ },
+ off: function( types, selector, fn ) {
+ var handleObj, type;
+ if ( types && types.preventDefault && types.handleObj ) {
+
+ // ( event ) dispatched jQuery.Event
+ handleObj = types.handleObj;
+ jQuery( types.delegateTarget ).off(
+ handleObj.namespace ?
+ handleObj.origType + "." + handleObj.namespace :
+ handleObj.origType,
+ handleObj.selector,
+ handleObj.handler
+ );
+ return this;
+ }
+ if ( typeof types === "object" ) {
+
+ // ( types-object [, selector] )
+ for ( type in types ) {
+ this.off( type, selector, types[ type ] );
+ }
+ return this;
+ }
+ if ( selector === false || typeof selector === "function" ) {
+
+ // ( types [, fn] )
+ fn = selector;
+ selector = undefined;
+ }
+ if ( fn === false ) {
+ fn = returnFalse;
+ }
+ return this.each( function() {
+ jQuery.event.remove( this, types, fn, selector );
+ } );
+ }
+} );
+
+
+var
+
+ /* eslint-disable max-len */
+
+ // See https://github.com/eslint/eslint/issues/3229
+ rxhtmlTag = /<(?!area|br|col|embed|hr|img|input|link|meta|param)(([a-z][^\/\0>\x20\t\r\n\f]*)[^>]*)\/>/gi,
+
+ /* eslint-enable */
+
+ // Support: IE <=10 - 11, Edge 12 - 13
+ // In IE/Edge using regex groups here causes severe slowdowns.
+ // See https://connect.microsoft.com/IE/feedback/details/1736512/
+ rnoInnerhtml = /<script|<style|<link/i,
+
+ // checked="checked" or checked
+ rchecked = /checked\s*(?:[^=]|=\s*.checked.)/i,
+ rscriptTypeMasked = /^true\/(.*)/,
+ rcleanScript = /^\s*<!(?:\[CDATA\[|--)|(?:\]\]|--)>\s*$/g;
+
+function manipulationTarget( elem, content ) {
+ if ( jQuery.nodeName( elem, "table" ) &&
+ jQuery.nodeName( content.nodeType !== 11 ? content : content.firstChild, "tr" ) ) {
+
+ return elem.getElementsByTagName( "tbody" )[ 0 ] || elem;
+ }
+
+ return elem;
+}
+
+// Replace/restore the type attribute of script elements for safe DOM manipulation
+function disableScript( elem ) {
+ elem.type = ( elem.getAttribute( "type" ) !== null ) + "/" + elem.type;
+ return elem;
+}
+function restoreScript( elem ) {
+ var match = rscriptTypeMasked.exec( elem.type );
+
+ if ( match ) {
+ elem.type = match[ 1 ];
+ } else {
+ elem.removeAttribute( "type" );
+ }
+
+ return elem;
+}
+
+function cloneCopyEvent( src, dest ) {
+ var i, l, type, pdataOld, pdataCur, udataOld, udataCur, events;
+
+ if ( dest.nodeType !== 1 ) {
+ return;
+ }
+
+ // 1. Copy private data: events, handlers, etc.
+ if ( dataPriv.hasData( src ) ) {
+ pdataOld = dataPriv.access( src );
+ pdataCur = dataPriv.set( dest, pdataOld );
+ events = pdataOld.events;
+
+ if ( events ) {
+ delete pdataCur.handle;
+ pdataCur.events = {};
+
+ for ( type in events ) {
+ for ( i = 0, l = events[ type ].length; i < l; i++ ) {
+ jQuery.event.add( dest, type, events[ type ][ i ] );
+ }
+ }
+ }
+ }
+
+ // 2. Copy user data
+ if ( dataUser.hasData( src ) ) {
+ udataOld = dataUser.access( src );
+ udataCur = jQuery.extend( {}, udataOld );
+
+ dataUser.set( dest, udataCur );
+ }
+}
+
+// Fix IE bugs, see support tests
+function fixInput( src, dest ) {
+ var nodeName = dest.nodeName.toLowerCase();
+
+ // Fails to persist the checked state of a cloned checkbox or radio button.
+ if ( nodeName === "input" && rcheckableType.test( src.type ) ) {
+ dest.checked = src.checked;
+
+ // Fails to return the selected option to the default selected state when cloning options
+ } else if ( nodeName === "input" || nodeName === "textarea" ) {
+ dest.defaultValue = src.defaultValue;
+ }
+}
+
+function domManip( collection, args, callback, ignored ) {
+
+ // Flatten any nested arrays
+ args = concat.apply( [], args );
+
+ var fragment, first, scripts, hasScripts, node, doc,
+ i = 0,
+ l = collection.length,
+ iNoClone = l - 1,
+ value = args[ 0 ],
+ isFunction = jQuery.isFunction( value );
+
+ // We can't cloneNode fragments that contain checked, in WebKit
+ if ( isFunction ||
+ ( l > 1 && typeof value === "string" &&
+ !support.checkClone && rchecked.test( value ) ) ) {
+ return collection.each( function( index ) {
+ var self = collection.eq( index );
+ if ( isFunction ) {
+ args[ 0 ] = value.call( this, index, self.html() );
+ }
+ domManip( self, args, callback, ignored );
+ } );
+ }
+
+ if ( l ) {
+ fragment = buildFragment( args, collection[ 0 ].ownerDocument, false, collection, ignored );
+ first = fragment.firstChild;
+
+ if ( fragment.childNodes.length === 1 ) {
+ fragment = first;
+ }
+
+ // Require either new content or an interest in ignored elements to invoke the callback
+ if ( first || ignored ) {
+ scripts = jQuery.map( getAll( fragment, "script" ), disableScript );
+ hasScripts = scripts.length;
+
+ // Use the original fragment for the last item
+ // instead of the first because it can end up
+ // being emptied incorrectly in certain situations (#8070).
+ for ( ; i < l; i++ ) {
+ node = fragment;
+
+ if ( i !== iNoClone ) {
+ node = jQuery.clone( node, true, true );
+
+ // Keep references to cloned scripts for later restoration
+ if ( hasScripts ) {
+
+ // Support: Android <=4.0 only, PhantomJS 1 only
+ // push.apply(_, arraylike) throws on ancient WebKit
+ jQuery.merge( scripts, getAll( node, "script" ) );
+ }
+ }
+
+ callback.call( collection[ i ], node, i );
+ }
+
+ if ( hasScripts ) {
+ doc = scripts[ scripts.length - 1 ].ownerDocument;
+
+ // Reenable scripts
+ jQuery.map( scripts, restoreScript );
+
+ // Evaluate executable scripts on first document insertion
+ for ( i = 0; i < hasScripts; i++ ) {
+ node = scripts[ i ];
+ if ( rscriptType.test( node.type || "" ) &&
+ !dataPriv.access( node, "globalEval" ) &&
+ jQuery.contains( doc, node ) ) {
+
+ if ( node.src ) {
+
+ // Optional AJAX dependency, but won't run scripts if not present
+ if ( jQuery._evalUrl ) {
+ jQuery._evalUrl( node.src );
+ }
+ } else {
+ DOMEval( node.textContent.replace( rcleanScript, "" ), doc );
+ }
+ }
+ }
+ }
+ }
+ }
+
+ return collection;
+}
+
+function remove( elem, selector, keepData ) {
+ var node,
+ nodes = selector ? jQuery.filter( selector, elem ) : elem,
+ i = 0;
+
+ for ( ; ( node = nodes[ i ] ) != null; i++ ) {
+ if ( !keepData && node.nodeType === 1 ) {
+ jQuery.cleanData( getAll( node ) );
+ }
+
+ if ( node.parentNode ) {
+ if ( keepData && jQuery.contains( node.ownerDocument, node ) ) {
+ setGlobalEval( getAll( node, "script" ) );
+ }
+ node.parentNode.removeChild( node );
+ }
+ }
+
+ return elem;
+}
+
+jQuery.extend( {
+ htmlPrefilter: function( html ) {
+ return html.replace( rxhtmlTag, "<$1></$2>" );
+ },
+
+ clone: function( elem, dataAndEvents, deepDataAndEvents ) {
+ var i, l, srcElements, destElements,
+ clone = elem.cloneNode( true ),
+ inPage = jQuery.contains( elem.ownerDocument, elem );
+
+ // Fix IE cloning issues
+ if ( !support.noCloneChecked && ( elem.nodeType === 1 || elem.nodeType === 11 ) &&
+ !jQuery.isXMLDoc( elem ) ) {
+
+ // We eschew Sizzle here for performance reasons: https://jsperf.com/getall-vs-sizzle/2
+ destElements = getAll( clone );
+ srcElements = getAll( elem );
+
+ for ( i = 0, l = srcElements.length; i < l; i++ ) {
+ fixInput( srcElements[ i ], destElements[ i ] );
+ }
+ }
+
+ // Copy the events from the original to the clone
+ if ( dataAndEvents ) {
+ if ( deepDataAndEvents ) {
+ srcElements = srcElements || getAll( elem );
+ destElements = destElements || getAll( clone );
+
+ for ( i = 0, l = srcElements.length; i < l; i++ ) {
+ cloneCopyEvent( srcElements[ i ], destElements[ i ] );
+ }
+ } else {
+ cloneCopyEvent( elem, clone );
+ }
+ }
+
+ // Preserve script evaluation history
+ destElements = getAll( clone, "script" );
+ if ( destElements.length > 0 ) {
+ setGlobalEval( destElements, !inPage && getAll( elem, "script" ) );
+ }
+
+ // Return the cloned set
+ return clone;
+ },
+
+ cleanData: function( elems ) {
+ var data, elem, type,
+ special = jQuery.event.special,
+ i = 0;
+
+ for ( ; ( elem = elems[ i ] ) !== undefined; i++ ) {
+ if ( acceptData( elem ) ) {
+ if ( ( data = elem[ dataPriv.expando ] ) ) {
+ if ( data.events ) {
+ for ( type in data.events ) {
+ if ( special[ type ] ) {
+ jQuery.event.remove( elem, type );
+
+ // This is a shortcut to avoid jQuery.event.remove's overhead
+ } else {
+ jQuery.removeEvent( elem, type, data.handle );
+ }
+ }
+ }
+
+ // Support: Chrome <=35 - 45+
+ // Assign undefined instead of using delete, see Data#remove
+ elem[ dataPriv.expando ] = undefined;
+ }
+ if ( elem[ dataUser.expando ] ) {
+
+ // Support: Chrome <=35 - 45+
+ // Assign undefined instead of using delete, see Data#remove
+ elem[ dataUser.expando ] = undefined;
+ }
+ }
+ }
+ }
+} );
+
+jQuery.fn.extend( {
+ detach: function( selector ) {
+ return remove( this, selector, true );
+ },
+
+ remove: function( selector ) {
+ return remove( this, selector );
+ },
+
+ text: function( value ) {
+ return access( this, function( value ) {
+ return value === undefined ?
+ jQuery.text( this ) :
+ this.empty().each( function() {
+ if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) {
+ this.textContent = value;
+ }
+ } );
+ }, null, value, arguments.length );
+ },
+
+ append: function() {
+ return domManip( this, arguments, function( elem ) {
+ if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) {
+ var target = manipulationTarget( this, elem );
+ target.appendChild( elem );
+ }
+ } );
+ },
+
+ prepend: function() {
+ return domManip( this, arguments, function( elem ) {
+ if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) {
+ var target = manipulationTarget( this, elem );
+ target.insertBefore( elem, target.firstChild );
+ }
+ } );
+ },
+
+ before: function() {
+ return domManip( this, arguments, function( elem ) {
+ if ( this.parentNode ) {
+ this.parentNode.insertBefore( elem, this );
+ }
+ } );
+ },
+
+ after: function() {
+ return domManip( this, arguments, function( elem ) {
+ if ( this.parentNode ) {
+ this.parentNode.insertBefore( elem, this.nextSibling );
+ }
+ } );
+ },
+
+ empty: function() {
+ var elem,
+ i = 0;
+
+ for ( ; ( elem = this[ i ] ) != null; i++ ) {
+ if ( elem.nodeType === 1 ) {
+
+ // Prevent memory leaks
+ jQuery.cleanData( getAll( elem, false ) );
+
+ // Remove any remaining nodes
+ elem.textContent = "";
+ }
+ }
+
+ return this;
+ },
+
+ clone: function( dataAndEvents, deepDataAndEvents ) {
+ dataAndEvents = dataAndEvents == null ? false : dataAndEvents;
+ deepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents;
+
+ return this.map( function() {
+ return jQuery.clone( this, dataAndEvents, deepDataAndEvents );
+ } );
+ },
+
+ html: function( value ) {
+ return access( this, function( value ) {
+ var elem = this[ 0 ] || {},
+ i = 0,
+ l = this.length;
+
+ if ( value === undefined && elem.nodeType === 1 ) {
+ return elem.innerHTML;
+ }
+
+ // See if we can take a shortcut and just use innerHTML
+ if ( typeof value === "string" && !rnoInnerhtml.test( value ) &&
+ !wrapMap[ ( rtagName.exec( value ) || [ "", "" ] )[ 1 ].toLowerCase() ] ) {
+
+ value = jQuery.htmlPrefilter( value );
+
+ try {
+ for ( ; i < l; i++ ) {
+ elem = this[ i ] || {};
+
+ // Remove element nodes and prevent memory leaks
+ if ( elem.nodeType === 1 ) {
+ jQuery.cleanData( getAll( elem, false ) );
+ elem.innerHTML = value;
+ }
+ }
+
+ elem = 0;
+
+ // If using innerHTML throws an exception, use the fallback method
+ } catch ( e ) {}
+ }
+
+ if ( elem ) {
+ this.empty().append( value );
+ }
+ }, null, value, arguments.length );
+ },
+
+ replaceWith: function() {
+ var ignored = [];
+
+ // Make the changes, replacing each non-ignored context element with the new content
+ return domManip( this, arguments, function( elem ) {
+ var parent = this.parentNode;
+
+ if ( jQuery.inArray( this, ignored ) < 0 ) {
+ jQuery.cleanData( getAll( this ) );
+ if ( parent ) {
+ parent.replaceChild( elem, this );
+ }
+ }
+
+ // Force callback invocation
+ }, ignored );
+ }
+} );
+
+jQuery.each( {
+ appendTo: "append",
+ prependTo: "prepend",
+ insertBefore: "before",
+ insertAfter: "after",
+ replaceAll: "replaceWith"
+}, function( name, original ) {
+ jQuery.fn[ name ] = function( selector ) {
+ var elems,
+ ret = [],
+ insert = jQuery( selector ),
+ last = insert.length - 1,
+ i = 0;
+
+ for ( ; i <= last; i++ ) {
+ elems = i === last ? this : this.clone( true );
+ jQuery( insert[ i ] )[ original ]( elems );
+
+ // Support: Android <=4.0 only, PhantomJS 1 only
+ // .get() because push.apply(_, arraylike) throws on ancient WebKit
+ push.apply( ret, elems.get() );
+ }
+
+ return this.pushStack( ret );
+ };
+} );
+var rmargin = ( /^margin/ );
+
+var rnumnonpx = new RegExp( "^(" + pnum + ")(?!px)[a-z%]+$", "i" );
+
+var getStyles = function( elem ) {
+
+ // Support: IE <=11 only, Firefox <=30 (#15098, #14150)
+ // IE throws on elements created in popups
+ // FF meanwhile throws on frame elements through "defaultView.getComputedStyle"
+ var view = elem.ownerDocument.defaultView;
+
+ if ( !view || !view.opener ) {
+ view = window;
+ }
+
+ return view.getComputedStyle( elem );
+ };
+
+
+
+( function() {
+
+ // Executing both pixelPosition & boxSizingReliable tests require only one layout
+ // so they're executed at the same time to save the second computation.
+ function computeStyleTests() {
+
+ // This is a singleton, we need to execute it only once
+ if ( !div ) {
+ return;
+ }
+
+ div.style.cssText =
+ "box-sizing:border-box;" +
+ "position:relative;display:block;" +
+ "margin:auto;border:1px;padding:1px;" +
+ "top:1%;width:50%";
+ div.innerHTML = "";
+ documentElement.appendChild( container );
+
+ var divStyle = window.getComputedStyle( div );
+ pixelPositionVal = divStyle.top !== "1%";
+
+ // Support: Android 4.0 - 4.3 only, Firefox <=3 - 44
+ reliableMarginLeftVal = divStyle.marginLeft === "2px";
+ boxSizingReliableVal = divStyle.width === "4px";
+
+ // Support: Android 4.0 - 4.3 only
+ // Some styles come back with percentage values, even though they shouldn't
+ div.style.marginRight = "50%";
+ pixelMarginRightVal = divStyle.marginRight === "4px";
+
+ documentElement.removeChild( container );
+
+ // Nullify the div so it wouldn't be stored in the memory and
+ // it will also be a sign that checks already performed
+ div = null;
+ }
+
+ var pixelPositionVal, boxSizingReliableVal, pixelMarginRightVal, reliableMarginLeftVal,
+ container = document.createElement( "div" ),
+ div = document.createElement( "div" );
+
+ // Finish early in limited (non-browser) environments
+ if ( !div.style ) {
+ return;
+ }
+
+ // Support: IE <=9 - 11 only
+ // Style of cloned element affects source element cloned (#8908)
+ div.style.backgroundClip = "content-box";
+ div.cloneNode( true ).style.backgroundClip = "";
+ support.clearCloneStyle = div.style.backgroundClip === "content-box";
+
+ container.style.cssText = "border:0;width:8px;height:0;top:0;left:-9999px;" +
+ "padding:0;margin-top:1px;position:absolute";
+ container.appendChild( div );
+
+ jQuery.extend( support, {
+ pixelPosition: function() {
+ computeStyleTests();
+ return pixelPositionVal;
+ },
+ boxSizingReliable: function() {
+ computeStyleTests();
+ return boxSizingReliableVal;
+ },
+ pixelMarginRight: function() {
+ computeStyleTests();
+ return pixelMarginRightVal;
+ },
+ reliableMarginLeft: function() {
+ computeStyleTests();
+ return reliableMarginLeftVal;
+ }
+ } );
+} )();
+
+
+function curCSS( elem, name, computed ) {
+ var width, minWidth, maxWidth, ret,
+ style = elem.style;
+
+ computed = computed || getStyles( elem );
+
+ // Support: IE <=9 only
+ // getPropertyValue is only needed for .css('filter') (#12537)
+ if ( computed ) {
+ ret = computed.getPropertyValue( name ) || computed[ name ];
+
+ if ( ret === "" && !jQuery.contains( elem.ownerDocument, elem ) ) {
+ ret = jQuery.style( elem, name );
+ }
+
+ // A tribute to the "awesome hack by Dean Edwards"
+ // Android Browser returns percentage for some values,
+ // but width seems to be reliably pixels.
+ // This is against the CSSOM draft spec:
+ // https://drafts.csswg.org/cssom/#resolved-values
+ if ( !support.pixelMarginRight() && rnumnonpx.test( ret ) && rmargin.test( name ) ) {
+
+ // Remember the original values
+ width = style.width;
+ minWidth = style.minWidth;
+ maxWidth = style.maxWidth;
+
+ // Put in the new values to get a computed value out
+ style.minWidth = style.maxWidth = style.width = ret;
+ ret = computed.width;
+
+ // Revert the changed values
+ style.width = width;
+ style.minWidth = minWidth;
+ style.maxWidth = maxWidth;
+ }
+ }
+
+ return ret !== undefined ?
+
+ // Support: IE <=9 - 11 only
+ // IE returns zIndex value as an integer.
+ ret + "" :
+ ret;
+}
+
+
+function addGetHookIf( conditionFn, hookFn ) {
+
+ // Define the hook, we'll check on the first run if it's really needed.
+ return {
+ get: function() {
+ if ( conditionFn() ) {
+
+ // Hook not needed (or it's not possible to use it due
+ // to missing dependency), remove it.
+ delete this.get;
+ return;
+ }
+
+ // Hook needed; redefine it so that the support test is not executed again.
+ return ( this.get = hookFn ).apply( this, arguments );
+ }
+ };
+}
+
+
+var
+
+ // Swappable if display is none or starts with table
+ // except "table", "table-cell", or "table-caption"
+ // See here for display values: https://developer.mozilla.org/en-US/docs/CSS/display
+ rdisplayswap = /^(none|table(?!-c[ea]).+)/,
+ cssShow = { position: "absolute", visibility: "hidden", display: "block" },
+ cssNormalTransform = {
+ letterSpacing: "0",
+ fontWeight: "400"
+ },
+
+ cssPrefixes = [ "Webkit", "Moz", "ms" ],
+ emptyStyle = document.createElement( "div" ).style;
+
+// Return a css property mapped to a potentially vendor prefixed property
+function vendorPropName( name ) {
+
+ // Shortcut for names that are not vendor prefixed
+ if ( name in emptyStyle ) {
+ return name;
+ }
+
+ // Check for vendor prefixed names
+ var capName = name[ 0 ].toUpperCase() + name.slice( 1 ),
+ i = cssPrefixes.length;
+
+ while ( i-- ) {
+ name = cssPrefixes[ i ] + capName;
+ if ( name in emptyStyle ) {
+ return name;
+ }
+ }
+}
+
+function setPositiveNumber( elem, value, subtract ) {
+
+ // Any relative (+/-) values have already been
+ // normalized at this point
+ var matches = rcssNum.exec( value );
+ return matches ?
+
+ // Guard against undefined "subtract", e.g., when used as in cssHooks
+ Math.max( 0, matches[ 2 ] - ( subtract || 0 ) ) + ( matches[ 3 ] || "px" ) :
+ value;
+}
+
+function augmentWidthOrHeight( elem, name, extra, isBorderBox, styles ) {
+ var i,
+ val = 0;
+
+ // If we already have the right measurement, avoid augmentation
+ if ( extra === ( isBorderBox ? "border" : "content" ) ) {
+ i = 4;
+
+ // Otherwise initialize for horizontal or vertical properties
+ } else {
+ i = name === "width" ? 1 : 0;
+ }
+
+ for ( ; i < 4; i += 2 ) {
+
+ // Both box models exclude margin, so add it if we want it
+ if ( extra === "margin" ) {
+ val += jQuery.css( elem, extra + cssExpand[ i ], true, styles );
+ }
+
+ if ( isBorderBox ) {
+
+ // border-box includes padding, so remove it if we want content
+ if ( extra === "content" ) {
+ val -= jQuery.css( elem, "padding" + cssExpand[ i ], true, styles );
+ }
+
+ // At this point, extra isn't border nor margin, so remove border
+ if ( extra !== "margin" ) {
+ val -= jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles );
+ }
+ } else {
+
+ // At this point, extra isn't content, so add padding
+ val += jQuery.css( elem, "padding" + cssExpand[ i ], true, styles );
+
+ // At this point, extra isn't content nor padding, so add border
+ if ( extra !== "padding" ) {
+ val += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles );
+ }
+ }
+ }
+
+ return val;
+}
+
+function getWidthOrHeight( elem, name, extra ) {
+
+ // Start with offset property, which is equivalent to the border-box value
+ var val,
+ valueIsBorderBox = true,
+ styles = getStyles( elem ),
+ isBorderBox = jQuery.css( elem, "boxSizing", false, styles ) === "border-box";
+
+ // Support: IE <=11 only
+ // Running getBoundingClientRect on a disconnected node
+ // in IE throws an error.
+ if ( elem.getClientRects().length ) {
+ val = elem.getBoundingClientRect()[ name ];
+ }
+
+ // Some non-html elements return undefined for offsetWidth, so check for null/undefined
+ // svg - https://bugzilla.mozilla.org/show_bug.cgi?id=649285
+ // MathML - https://bugzilla.mozilla.org/show_bug.cgi?id=491668
+ if ( val <= 0 || val == null ) {
+
+ // Fall back to computed then uncomputed css if necessary
+ val = curCSS( elem, name, styles );
+ if ( val < 0 || val == null ) {
+ val = elem.style[ name ];
+ }
+
+ // Computed unit is not pixels. Stop here and return.
+ if ( rnumnonpx.test( val ) ) {
+ return val;
+ }
+
+ // Check for style in case a browser which returns unreliable values
+ // for getComputedStyle silently falls back to the reliable elem.style
+ valueIsBorderBox = isBorderBox &&
+ ( support.boxSizingReliable() || val === elem.style[ name ] );
+
+ // Normalize "", auto, and prepare for extra
+ val = parseFloat( val ) || 0;
+ }
+
+ // Use the active box-sizing model to add/subtract irrelevant styles
+ return ( val +
+ augmentWidthOrHeight(
+ elem,
+ name,
+ extra || ( isBorderBox ? "border" : "content" ),
+ valueIsBorderBox,
+ styles
+ )
+ ) + "px";
+}
+
+jQuery.extend( {
+
+ // Add in style property hooks for overriding the default
+ // behavior of getting and setting a style property
+ cssHooks: {
+ opacity: {
+ get: function( elem, computed ) {
+ if ( computed ) {
+
+ // We should always get a number back from opacity
+ var ret = curCSS( elem, "opacity" );
+ return ret === "" ? "1" : ret;
+ }
+ }
+ }
+ },
+
+ // Don't automatically add "px" to these possibly-unitless properties
+ cssNumber: {
+ "animationIterationCount": true,
+ "columnCount": true,
+ "fillOpacity": true,
+ "flexGrow": true,
+ "flexShrink": true,
+ "fontWeight": true,
+ "lineHeight": true,
+ "opacity": true,
+ "order": true,
+ "orphans": true,
+ "widows": true,
+ "zIndex": true,
+ "zoom": true
+ },
+
+ // Add in properties whose names you wish to fix before
+ // setting or getting the value
+ cssProps: {
+ "float": "cssFloat"
+ },
+
+ // Get and set the style property on a DOM Node
+ style: function( elem, name, value, extra ) {
+
+ // Don't set styles on text and comment nodes
+ if ( !elem || elem.nodeType === 3 || elem.nodeType === 8 || !elem.style ) {
+ return;
+ }
+
+ // Make sure that we're working with the right name
+ var ret, type, hooks,
+ origName = jQuery.camelCase( name ),
+ style = elem.style;
+
+ name = jQuery.cssProps[ origName ] ||
+ ( jQuery.cssProps[ origName ] = vendorPropName( origName ) || origName );
+
+ // Gets hook for the prefixed version, then unprefixed version
+ hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ];
+
+ // Check if we're setting a value
+ if ( value !== undefined ) {
+ type = typeof value;
+
+ // Convert "+=" or "-=" to relative numbers (#7345)
+ if ( type === "string" && ( ret = rcssNum.exec( value ) ) && ret[ 1 ] ) {
+ value = adjustCSS( elem, name, ret );
+
+ // Fixes bug #9237
+ type = "number";
+ }
+
+ // Make sure that null and NaN values aren't set (#7116)
+ if ( value == null || value !== value ) {
+ return;
+ }
+
+ // If a number was passed in, add the unit (except for certain CSS properties)
+ if ( type === "number" ) {
+ value += ret && ret[ 3 ] || ( jQuery.cssNumber[ origName ] ? "" : "px" );
+ }
+
+ // background-* props affect original clone's values
+ if ( !support.clearCloneStyle && value === "" && name.indexOf( "background" ) === 0 ) {
+ style[ name ] = "inherit";
+ }
+
+ // If a hook was provided, use that value, otherwise just set the specified value
+ if ( !hooks || !( "set" in hooks ) ||
+ ( value = hooks.set( elem, value, extra ) ) !== undefined ) {
+
+ style[ name ] = value;
+ }
+
+ } else {
+
+ // If a hook was provided get the non-computed value from there
+ if ( hooks && "get" in hooks &&
+ ( ret = hooks.get( elem, false, extra ) ) !== undefined ) {
+
+ return ret;
+ }
+
+ // Otherwise just get the value from the style object
+ return style[ name ];
+ }
+ },
+
+ css: function( elem, name, extra, styles ) {
+ var val, num, hooks,
+ origName = jQuery.camelCase( name );
+
+ // Make sure that we're working with the right name
+ name = jQuery.cssProps[ origName ] ||
+ ( jQuery.cssProps[ origName ] = vendorPropName( origName ) || origName );
+
+ // Try prefixed name followed by the unprefixed name
+ hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ];
+
+ // If a hook was provided get the computed value from there
+ if ( hooks && "get" in hooks ) {
+ val = hooks.get( elem, true, extra );
+ }
+
+ // Otherwise, if a way to get the computed value exists, use that
+ if ( val === undefined ) {
+ val = curCSS( elem, name, styles );
+ }
+
+ // Convert "normal" to computed value
+ if ( val === "normal" && name in cssNormalTransform ) {
+ val = cssNormalTransform[ name ];
+ }
+
+ // Make numeric if forced or a qualifier was provided and val looks numeric
+ if ( extra === "" || extra ) {
+ num = parseFloat( val );
+ return extra === true || isFinite( num ) ? num || 0 : val;
+ }
+ return val;
+ }
+} );
+
+jQuery.each( [ "height", "width" ], function( i, name ) {
+ jQuery.cssHooks[ name ] = {
+ get: function( elem, computed, extra ) {
+ if ( computed ) {
+
+ // Certain elements can have dimension info if we invisibly show them
+ // but it must have a current display style that would benefit
+ return rdisplayswap.test( jQuery.css( elem, "display" ) ) &&
+
+ // Support: Safari 8+
+ // Table columns in Safari have non-zero offsetWidth & zero
+ // getBoundingClientRect().width unless display is changed.
+ // Support: IE <=11 only
+ // Running getBoundingClientRect on a disconnected node
+ // in IE throws an error.
+ ( !elem.getClientRects().length || !elem.getBoundingClientRect().width ) ?
+ swap( elem, cssShow, function() {
+ return getWidthOrHeight( elem, name, extra );
+ } ) :
+ getWidthOrHeight( elem, name, extra );
+ }
+ },
+
+ set: function( elem, value, extra ) {
+ var matches,
+ styles = extra && getStyles( elem ),
+ subtract = extra && augmentWidthOrHeight(
+ elem,
+ name,
+ extra,
+ jQuery.css( elem, "boxSizing", false, styles ) === "border-box",
+ styles
+ );
+
+ // Convert to pixels if value adjustment is needed
+ if ( subtract && ( matches = rcssNum.exec( value ) ) &&
+ ( matches[ 3 ] || "px" ) !== "px" ) {
+
+ elem.style[ name ] = value;
+ value = jQuery.css( elem, name );
+ }
+
+ return setPositiveNumber( elem, value, subtract );
+ }
+ };
+} );
+
+jQuery.cssHooks.marginLeft = addGetHookIf( support.reliableMarginLeft,
+ function( elem, computed ) {
+ if ( computed ) {
+ return ( parseFloat( curCSS( elem, "marginLeft" ) ) ||
+ elem.getBoundingClientRect().left -
+ swap( elem, { marginLeft: 0 }, function() {
+ return elem.getBoundingClientRect().left;
+ } )
+ ) + "px";
+ }
+ }
+);
+
+// These hooks are used by animate to expand properties
+jQuery.each( {
+ margin: "",
+ padding: "",
+ border: "Width"
+}, function( prefix, suffix ) {
+ jQuery.cssHooks[ prefix + suffix ] = {
+ expand: function( value ) {
+ var i = 0,
+ expanded = {},
+
+ // Assumes a single number if not a string
+ parts = typeof value === "string" ? value.split( " " ) : [ value ];
+
+ for ( ; i < 4; i++ ) {
+ expanded[ prefix + cssExpand[ i ] + suffix ] =
+ parts[ i ] || parts[ i - 2 ] || parts[ 0 ];
+ }
+
+ return expanded;
+ }
+ };
+
+ if ( !rmargin.test( prefix ) ) {
+ jQuery.cssHooks[ prefix + suffix ].set = setPositiveNumber;
+ }
+} );
+
+jQuery.fn.extend( {
+ css: function( name, value ) {
+ return access( this, function( elem, name, value ) {
+ var styles, len,
+ map = {},
+ i = 0;
+
+ if ( jQuery.isArray( name ) ) {
+ styles = getStyles( elem );
+ len = name.length;
+
+ for ( ; i < len; i++ ) {
+ map[ name[ i ] ] = jQuery.css( elem, name[ i ], false, styles );
+ }
+
+ return map;
+ }
+
+ return value !== undefined ?
+ jQuery.style( elem, name, value ) :
+ jQuery.css( elem, name );
+ }, name, value, arguments.length > 1 );
+ }
+} );
+
+
+function Tween( elem, options, prop, end, easing ) {
+ return new Tween.prototype.init( elem, options, prop, end, easing );
+}
+jQuery.Tween = Tween;
+
+Tween.prototype = {
+ constructor: Tween,
+ init: function( elem, options, prop, end, easing, unit ) {
+ this.elem = elem;
+ this.prop = prop;
+ this.easing = easing || jQuery.easing._default;
+ this.options = options;
+ this.start = this.now = this.cur();
+ this.end = end;
+ this.unit = unit || ( jQuery.cssNumber[ prop ] ? "" : "px" );
+ },
+ cur: function() {
+ var hooks = Tween.propHooks[ this.prop ];
+
+ return hooks && hooks.get ?
+ hooks.get( this ) :
+ Tween.propHooks._default.get( this );
+ },
+ run: function( percent ) {
+ var eased,
+ hooks = Tween.propHooks[ this.prop ];
+
+ if ( this.options.duration ) {
+ this.pos = eased = jQuery.easing[ this.easing ](
+ percent, this.options.duration * percent, 0, 1, this.options.duration
+ );
+ } else {
+ this.pos = eased = percent;
+ }
+ this.now = ( this.end - this.start ) * eased + this.start;
+
+ if ( this.options.step ) {
+ this.options.step.call( this.elem, this.now, this );
+ }
+
+ if ( hooks && hooks.set ) {
+ hooks.set( this );
+ } else {
+ Tween.propHooks._default.set( this );
+ }
+ return this;
+ }
+};
+
+Tween.prototype.init.prototype = Tween.prototype;
+
+Tween.propHooks = {
+ _default: {
+ get: function( tween ) {
+ var result;
+
+ // Use a property on the element directly when it is not a DOM element,
+ // or when there is no matching style property that exists.
+ if ( tween.elem.nodeType !== 1 ||
+ tween.elem[ tween.prop ] != null && tween.elem.style[ tween.prop ] == null ) {
+ return tween.elem[ tween.prop ];
+ }
+
+ // Passing an empty string as a 3rd parameter to .css will automatically
+ // attempt a parseFloat and fallback to a string if the parse fails.
+ // Simple values such as "10px" are parsed to Float;
+ // complex values such as "rotate(1rad)" are returned as-is.
+ result = jQuery.css( tween.elem, tween.prop, "" );
+
+ // Empty strings, null, undefined and "auto" are converted to 0.
+ return !result || result === "auto" ? 0 : result;
+ },
+ set: function( tween ) {
+
+ // Use step hook for back compat.
+ // Use cssHook if its there.
+ // Use .style if available and use plain properties where available.
+ if ( jQuery.fx.step[ tween.prop ] ) {
+ jQuery.fx.step[ tween.prop ]( tween );
+ } else if ( tween.elem.nodeType === 1 &&
+ ( tween.elem.style[ jQuery.cssProps[ tween.prop ] ] != null ||
+ jQuery.cssHooks[ tween.prop ] ) ) {
+ jQuery.style( tween.elem, tween.prop, tween.now + tween.unit );
+ } else {
+ tween.elem[ tween.prop ] = tween.now;
+ }
+ }
+ }
+};
+
+// Support: IE <=9 only
+// Panic based approach to setting things on disconnected nodes
+Tween.propHooks.scrollTop = Tween.propHooks.scrollLeft = {
+ set: function( tween ) {
+ if ( tween.elem.nodeType && tween.elem.parentNode ) {
+ tween.elem[ tween.prop ] = tween.now;
+ }
+ }
+};
+
+jQuery.easing = {
+ linear: function( p ) {
+ return p;
+ },
+ swing: function( p ) {
+ return 0.5 - Math.cos( p * Math.PI ) / 2;
+ },
+ _default: "swing"
+};
+
+jQuery.fx = Tween.prototype.init;
+
+// Back compat <1.8 extension point
+jQuery.fx.step = {};
+
+
+
+
+var
+ fxNow, timerId,
+ rfxtypes = /^(?:toggle|show|hide)$/,
+ rrun = /queueHooks$/;
+
+function raf() {
+ if ( timerId ) {
+ window.requestAnimationFrame( raf );
+ jQuery.fx.tick();
+ }
+}
+
+// Animations created synchronously will run synchronously
+function createFxNow() {
+ window.setTimeout( function() {
+ fxNow = undefined;
+ } );
+ return ( fxNow = jQuery.now() );
+}
+
+// Generate parameters to create a standard animation
+function genFx( type, includeWidth ) {
+ var which,
+ i = 0,
+ attrs = { height: type };
+
+ // If we include width, step value is 1 to do all cssExpand values,
+ // otherwise step value is 2 to skip over Left and Right
+ includeWidth = includeWidth ? 1 : 0;
+ for ( ; i < 4; i += 2 - includeWidth ) {
+ which = cssExpand[ i ];
+ attrs[ "margin" + which ] = attrs[ "padding" + which ] = type;
+ }
+
+ if ( includeWidth ) {
+ attrs.opacity = attrs.width = type;
+ }
+
+ return attrs;
+}
+
+function createTween( value, prop, animation ) {
+ var tween,
+ collection = ( Animation.tweeners[ prop ] || [] ).concat( Animation.tweeners[ "*" ] ),
+ index = 0,
+ length = collection.length;
+ for ( ; index < length; index++ ) {
+ if ( ( tween = collection[ index ].call( animation, prop, value ) ) ) {
+
+ // We're done with this property
+ return tween;
+ }
+ }
+}
+
+function defaultPrefilter( elem, props, opts ) {
+ var prop, value, toggle, hooks, oldfire, propTween, restoreDisplay, display,
+ isBox = "width" in props || "height" in props,
+ anim = this,
+ orig = {},
+ style = elem.style,
+ hidden = elem.nodeType && isHiddenWithinTree( elem ),
+ dataShow = dataPriv.get( elem, "fxshow" );
+
+ // Queue-skipping animations hijack the fx hooks
+ if ( !opts.queue ) {
+ hooks = jQuery._queueHooks( elem, "fx" );
+ if ( hooks.unqueued == null ) {
+ hooks.unqueued = 0;
+ oldfire = hooks.empty.fire;
+ hooks.empty.fire = function() {
+ if ( !hooks.unqueued ) {
+ oldfire();
+ }
+ };
+ }
+ hooks.unqueued++;
+
+ anim.always( function() {
+
+ // Ensure the complete handler is called before this completes
+ anim.always( function() {
+ hooks.unqueued--;
+ if ( !jQuery.queue( elem, "fx" ).length ) {
+ hooks.empty.fire();
+ }
+ } );
+ } );
+ }
+
+ // Detect show/hide animations
+ for ( prop in props ) {
+ value = props[ prop ];
+ if ( rfxtypes.test( value ) ) {
+ delete props[ prop ];
+ toggle = toggle || value === "toggle";
+ if ( value === ( hidden ? "hide" : "show" ) ) {
+
+ // Pretend to be hidden if this is a "show" and
+ // there is still data from a stopped show/hide
+ if ( value === "show" && dataShow && dataShow[ prop ] !== undefined ) {
+ hidden = true;
+
+ // Ignore all other no-op show/hide data
+ } else {
+ continue;
+ }
+ }
+ orig[ prop ] = dataShow && dataShow[ prop ] || jQuery.style( elem, prop );
+ }
+ }
+
+ // Bail out if this is a no-op like .hide().hide()
+ propTween = !jQuery.isEmptyObject( props );
+ if ( !propTween && jQuery.isEmptyObject( orig ) ) {
+ return;
+ }
+
+ // Restrict "overflow" and "display" styles during box animations
+ if ( isBox && elem.nodeType === 1 ) {
+
+ // Support: IE <=9 - 11, Edge 12 - 13
+ // Record all 3 overflow attributes because IE does not infer the shorthand
+ // from identically-valued overflowX and overflowY
+ opts.overflow = [ style.overflow, style.overflowX, style.overflowY ];
+
+ // Identify a display type, preferring old show/hide data over the CSS cascade
+ restoreDisplay = dataShow && dataShow.display;
+ if ( restoreDisplay == null ) {
+ restoreDisplay = dataPriv.get( elem, "display" );
+ }
+ display = jQuery.css( elem, "display" );
+ if ( display === "none" ) {
+ if ( restoreDisplay ) {
+ display = restoreDisplay;
+ } else {
+
+ // Get nonempty value(s) by temporarily forcing visibility
+ showHide( [ elem ], true );
+ restoreDisplay = elem.style.display || restoreDisplay;
+ display = jQuery.css( elem, "display" );
+ showHide( [ elem ] );
+ }
+ }
+
+ // Animate inline elements as inline-block
+ if ( display === "inline" || display === "inline-block" && restoreDisplay != null ) {
+ if ( jQuery.css( elem, "float" ) === "none" ) {
+
+ // Restore the original display value at the end of pure show/hide animations
+ if ( !propTween ) {
+ anim.done( function() {
+ style.display = restoreDisplay;
+ } );
+ if ( restoreDisplay == null ) {
+ display = style.display;
+ restoreDisplay = display === "none" ? "" : display;
+ }
+ }
+ style.display = "inline-block";
+ }
+ }
+ }
+
+ if ( opts.overflow ) {
+ style.overflow = "hidden";
+ anim.always( function() {
+ style.overflow = opts.overflow[ 0 ];
+ style.overflowX = opts.overflow[ 1 ];
+ style.overflowY = opts.overflow[ 2 ];
+ } );
+ }
+
+ // Implement show/hide animations
+ propTween = false;
+ for ( prop in orig ) {
+
+ // General show/hide setup for this element animation
+ if ( !propTween ) {
+ if ( dataShow ) {
+ if ( "hidden" in dataShow ) {
+ hidden = dataShow.hidden;
+ }
+ } else {
+ dataShow = dataPriv.access( elem, "fxshow", { display: restoreDisplay } );
+ }
+
+ // Store hidden/visible for toggle so `.stop().toggle()` "reverses"
+ if ( toggle ) {
+ dataShow.hidden = !hidden;
+ }
+
+ // Show elements before animating them
+ if ( hidden ) {
+ showHide( [ elem ], true );
+ }
+
+ /* eslint-disable no-loop-func */
+
+ anim.done( function() {
+
+ /* eslint-enable no-loop-func */
+
+ // The final step of a "hide" animation is actually hiding the element
+ if ( !hidden ) {
+ showHide( [ elem ] );
+ }
+ dataPriv.remove( elem, "fxshow" );
+ for ( prop in orig ) {
+ jQuery.style( elem, prop, orig[ prop ] );
+ }
+ } );
+ }
+
+ // Per-property setup
+ propTween = createTween( hidden ? dataShow[ prop ] : 0, prop, anim );
+ if ( !( prop in dataShow ) ) {
+ dataShow[ prop ] = propTween.start;
+ if ( hidden ) {
+ propTween.end = propTween.start;
+ propTween.start = 0;
+ }
+ }
+ }
+}
+
+function propFilter( props, specialEasing ) {
+ var index, name, easing, value, hooks;
+
+ // camelCase, specialEasing and expand cssHook pass
+ for ( index in props ) {
+ name = jQuery.camelCase( index );
+ easing = specialEasing[ name ];
+ value = props[ index ];
+ if ( jQuery.isArray( value ) ) {
+ easing = value[ 1 ];
+ value = props[ index ] = value[ 0 ];
+ }
+
+ if ( index !== name ) {
+ props[ name ] = value;
+ delete props[ index ];
+ }
+
+ hooks = jQuery.cssHooks[ name ];
+ if ( hooks && "expand" in hooks ) {
+ value = hooks.expand( value );
+ delete props[ name ];
+
+ // Not quite $.extend, this won't overwrite existing keys.
+ // Reusing 'index' because we have the correct "name"
+ for ( index in value ) {
+ if ( !( index in props ) ) {
+ props[ index ] = value[ index ];
+ specialEasing[ index ] = easing;
+ }
+ }
+ } else {
+ specialEasing[ name ] = easing;
+ }
+ }
+}
+
+function Animation( elem, properties, options ) {
+ var result,
+ stopped,
+ index = 0,
+ length = Animation.prefilters.length,
+ deferred = jQuery.Deferred().always( function() {
+
+ // Don't match elem in the :animated selector
+ delete tick.elem;
+ } ),
+ tick = function() {
+ if ( stopped ) {
+ return false;
+ }
+ var currentTime = fxNow || createFxNow(),
+ remaining = Math.max( 0, animation.startTime + animation.duration - currentTime ),
+
+ // Support: Android 2.3 only
+ // Archaic crash bug won't allow us to use `1 - ( 0.5 || 0 )` (#12497)
+ temp = remaining / animation.duration || 0,
+ percent = 1 - temp,
+ index = 0,
+ length = animation.tweens.length;
+
+ for ( ; index < length; index++ ) {
+ animation.tweens[ index ].run( percent );
+ }
+
+ deferred.notifyWith( elem, [ animation, percent, remaining ] );
+
+ if ( percent < 1 && length ) {
+ return remaining;
+ } else {
+ deferred.resolveWith( elem, [ animation ] );
+ return false;
+ }
+ },
+ animation = deferred.promise( {
+ elem: elem,
+ props: jQuery.extend( {}, properties ),
+ opts: jQuery.extend( true, {
+ specialEasing: {},
+ easing: jQuery.easing._default
+ }, options ),
+ originalProperties: properties,
+ originalOptions: options,
+ startTime: fxNow || createFxNow(),
+ duration: options.duration,
+ tweens: [],
+ createTween: function( prop, end ) {
+ var tween = jQuery.Tween( elem, animation.opts, prop, end,
+ animation.opts.specialEasing[ prop ] || animation.opts.easing );
+ animation.tweens.push( tween );
+ return tween;
+ },
+ stop: function( gotoEnd ) {
+ var index = 0,
+
+ // If we are going to the end, we want to run all the tweens
+ // otherwise we skip this part
+ length = gotoEnd ? animation.tweens.length : 0;
+ if ( stopped ) {
+ return this;
+ }
+ stopped = true;
+ for ( ; index < length; index++ ) {
+ animation.tweens[ index ].run( 1 );
+ }
+
+ // Resolve when we played the last frame; otherwise, reject
+ if ( gotoEnd ) {
+ deferred.notifyWith( elem, [ animation, 1, 0 ] );
+ deferred.resolveWith( elem, [ animation, gotoEnd ] );
+ } else {
+ deferred.rejectWith( elem, [ animation, gotoEnd ] );
+ }
+ return this;
+ }
+ } ),
+ props = animation.props;
+
+ propFilter( props, animation.opts.specialEasing );
+
+ for ( ; index < length; index++ ) {
+ result = Animation.prefilters[ index ].call( animation, elem, props, animation.opts );
+ if ( result ) {
+ if ( jQuery.isFunction( result.stop ) ) {
+ jQuery._queueHooks( animation.elem, animation.opts.queue ).stop =
+ jQuery.proxy( result.stop, result );
+ }
+ return result;
+ }
+ }
+
+ jQuery.map( props, createTween, animation );
+
+ if ( jQuery.isFunction( animation.opts.start ) ) {
+ animation.opts.start.call( elem, animation );
+ }
+
+ jQuery.fx.timer(
+ jQuery.extend( tick, {
+ elem: elem,
+ anim: animation,
+ queue: animation.opts.queue
+ } )
+ );
+
+ // attach callbacks from options
+ return animation.progress( animation.opts.progress )
+ .done( animation.opts.done, animation.opts.complete )
+ .fail( animation.opts.fail )
+ .always( animation.opts.always );
+}
+
+jQuery.Animation = jQuery.extend( Animation, {
+
+ tweeners: {
+ "*": [ function( prop, value ) {
+ var tween = this.createTween( prop, value );
+ adjustCSS( tween.elem, prop, rcssNum.exec( value ), tween );
+ return tween;
+ } ]
+ },
+
+ tweener: function( props, callback ) {
+ if ( jQuery.isFunction( props ) ) {
+ callback = props;
+ props = [ "*" ];
+ } else {
+ props = props.match( rnothtmlwhite );
+ }
+
+ var prop,
+ index = 0,
+ length = props.length;
+
+ for ( ; index < length; index++ ) {
+ prop = props[ index ];
+ Animation.tweeners[ prop ] = Animation.tweeners[ prop ] || [];
+ Animation.tweeners[ prop ].unshift( callback );
+ }
+ },
+
+ prefilters: [ defaultPrefilter ],
+
+ prefilter: function( callback, prepend ) {
+ if ( prepend ) {
+ Animation.prefilters.unshift( callback );
+ } else {
+ Animation.prefilters.push( callback );
+ }
+ }
+} );
+
+jQuery.speed = function( speed, easing, fn ) {
+ var opt = speed && typeof speed === "object" ? jQuery.extend( {}, speed ) : {
+ complete: fn || !fn && easing ||
+ jQuery.isFunction( speed ) && speed,
+ duration: speed,
+ easing: fn && easing || easing && !jQuery.isFunction( easing ) && easing
+ };
+
+ // Go to the end state if fx are off or if document is hidden
+ if ( jQuery.fx.off || document.hidden ) {
+ opt.duration = 0;
+
+ } else {
+ if ( typeof opt.duration !== "number" ) {
+ if ( opt.duration in jQuery.fx.speeds ) {
+ opt.duration = jQuery.fx.speeds[ opt.duration ];
+
+ } else {
+ opt.duration = jQuery.fx.speeds._default;
+ }
+ }
+ }
+
+ // Normalize opt.queue - true/undefined/null -> "fx"
+ if ( opt.queue == null || opt.queue === true ) {
+ opt.queue = "fx";
+ }
+
+ // Queueing
+ opt.old = opt.complete;
+
+ opt.complete = function() {
+ if ( jQuery.isFunction( opt.old ) ) {
+ opt.old.call( this );
+ }
+
+ if ( opt.queue ) {
+ jQuery.dequeue( this, opt.queue );
+ }
+ };
+
+ return opt;
+};
+
+jQuery.fn.extend( {
+ fadeTo: function( speed, to, easing, callback ) {
+
+ // Show any hidden elements after setting opacity to 0
+ return this.filter( isHiddenWithinTree ).css( "opacity", 0 ).show()
+
+ // Animate to the value specified
+ .end().animate( { opacity: to }, speed, easing, callback );
+ },
+ animate: function( prop, speed, easing, callback ) {
+ var empty = jQuery.isEmptyObject( prop ),
+ optall = jQuery.speed( speed, easing, callback ),
+ doAnimation = function() {
+
+ // Operate on a copy of prop so per-property easing won't be lost
+ var anim = Animation( this, jQuery.extend( {}, prop ), optall );
+
+ // Empty animations, or finishing resolves immediately
+ if ( empty || dataPriv.get( this, "finish" ) ) {
+ anim.stop( true );
+ }
+ };
+ doAnimation.finish = doAnimation;
+
+ return empty || optall.queue === false ?
+ this.each( doAnimation ) :
+ this.queue( optall.queue, doAnimation );
+ },
+ stop: function( type, clearQueue, gotoEnd ) {
+ var stopQueue = function( hooks ) {
+ var stop = hooks.stop;
+ delete hooks.stop;
+ stop( gotoEnd );
+ };
+
+ if ( typeof type !== "string" ) {
+ gotoEnd = clearQueue;
+ clearQueue = type;
+ type = undefined;
+ }
+ if ( clearQueue && type !== false ) {
+ this.queue( type || "fx", [] );
+ }
+
+ return this.each( function() {
+ var dequeue = true,
+ index = type != null && type + "queueHooks",
+ timers = jQuery.timers,
+ data = dataPriv.get( this );
+
+ if ( index ) {
+ if ( data[ index ] && data[ index ].stop ) {
+ stopQueue( data[ index ] );
+ }
+ } else {
+ for ( index in data ) {
+ if ( data[ index ] && data[ index ].stop && rrun.test( index ) ) {
+ stopQueue( data[ index ] );
+ }
+ }
+ }
+
+ for ( index = timers.length; index--; ) {
+ if ( timers[ index ].elem === this &&
+ ( type == null || timers[ index ].queue === type ) ) {
+
+ timers[ index ].anim.stop( gotoEnd );
+ dequeue = false;
+ timers.splice( index, 1 );
+ }
+ }
+
+ // Start the next in the queue if the last step wasn't forced.
+ // Timers currently will call their complete callbacks, which
+ // will dequeue but only if they were gotoEnd.
+ if ( dequeue || !gotoEnd ) {
+ jQuery.dequeue( this, type );
+ }
+ } );
+ },
+ finish: function( type ) {
+ if ( type !== false ) {
+ type = type || "fx";
+ }
+ return this.each( function() {
+ var index,
+ data = dataPriv.get( this ),
+ queue = data[ type + "queue" ],
+ hooks = data[ type + "queueHooks" ],
+ timers = jQuery.timers,
+ length = queue ? queue.length : 0;
+
+ // Enable finishing flag on private data
+ data.finish = true;
+
+ // Empty the queue first
+ jQuery.queue( this, type, [] );
+
+ if ( hooks && hooks.stop ) {
+ hooks.stop.call( this, true );
+ }
+
+ // Look for any active animations, and finish them
+ for ( index = timers.length; index--; ) {
+ if ( timers[ index ].elem === this && timers[ index ].queue === type ) {
+ timers[ index ].anim.stop( true );
+ timers.splice( index, 1 );
+ }
+ }
+
+ // Look for any animations in the old queue and finish them
+ for ( index = 0; index < length; index++ ) {
+ if ( queue[ index ] && queue[ index ].finish ) {
+ queue[ index ].finish.call( this );
+ }
+ }
+
+ // Turn off finishing flag
+ delete data.finish;
+ } );
+ }
+} );
+
+jQuery.each( [ "toggle", "show", "hide" ], function( i, name ) {
+ var cssFn = jQuery.fn[ name ];
+ jQuery.fn[ name ] = function( speed, easing, callback ) {
+ return speed == null || typeof speed === "boolean" ?
+ cssFn.apply( this, arguments ) :
+ this.animate( genFx( name, true ), speed, easing, callback );
+ };
+} );
+
+// Generate shortcuts for custom animations
+jQuery.each( {
+ slideDown: genFx( "show" ),
+ slideUp: genFx( "hide" ),
+ slideToggle: genFx( "toggle" ),
+ fadeIn: { opacity: "show" },
+ fadeOut: { opacity: "hide" },
+ fadeToggle: { opacity: "toggle" }
+}, function( name, props ) {
+ jQuery.fn[ name ] = function( speed, easing, callback ) {
+ return this.animate( props, speed, easing, callback );
+ };
+} );
+
+jQuery.timers = [];
+jQuery.fx.tick = function() {
+ var timer,
+ i = 0,
+ timers = jQuery.timers;
+
+ fxNow = jQuery.now();
+
+ for ( ; i < timers.length; i++ ) {
+ timer = timers[ i ];
+
+ // Checks the timer has not already been removed
+ if ( !timer() && timers[ i ] === timer ) {
+ timers.splice( i--, 1 );
+ }
+ }
+
+ if ( !timers.length ) {
+ jQuery.fx.stop();
+ }
+ fxNow = undefined;
+};
+
+jQuery.fx.timer = function( timer ) {
+ jQuery.timers.push( timer );
+ if ( timer() ) {
+ jQuery.fx.start();
+ } else {
+ jQuery.timers.pop();
+ }
+};
+
+jQuery.fx.interval = 13;
+jQuery.fx.start = function() {
+ if ( !timerId ) {
+ timerId = window.requestAnimationFrame ?
+ window.requestAnimationFrame( raf ) :
+ window.setInterval( jQuery.fx.tick, jQuery.fx.interval );
+ }
+};
+
+jQuery.fx.stop = function() {
+ if ( window.cancelAnimationFrame ) {
+ window.cancelAnimationFrame( timerId );
+ } else {
+ window.clearInterval( timerId );
+ }
+
+ timerId = null;
+};
+
+jQuery.fx.speeds = {
+ slow: 600,
+ fast: 200,
+
+ // Default speed
+ _default: 400
+};
+
+
+// Based off of the plugin by Clint Helfers, with permission.
+// https://web.archive.org/web/20100324014747/http://blindsignals.com/index.php/2009/07/jquery-delay/
+jQuery.fn.delay = function( time, type ) {
+ time = jQuery.fx ? jQuery.fx.speeds[ time ] || time : time;
+ type = type || "fx";
+
+ return this.queue( type, function( next, hooks ) {
+ var timeout = window.setTimeout( next, time );
+ hooks.stop = function() {
+ window.clearTimeout( timeout );
+ };
+ } );
+};
+
+
+( function() {
+ var input = document.createElement( "input" ),
+ select = document.createElement( "select" ),
+ opt = select.appendChild( document.createElement( "option" ) );
+
+ input.type = "checkbox";
+
+ // Support: Android <=4.3 only
+ // Default value for a checkbox should be "on"
+ support.checkOn = input.value !== "";
+
+ // Support: IE <=11 only
+ // Must access selectedIndex to make default options select
+ support.optSelected = opt.selected;
+
+ // Support: IE <=11 only
+ // An input loses its value after becoming a radio
+ input = document.createElement( "input" );
+ input.value = "t";
+ input.type = "radio";
+ support.radioValue = input.value === "t";
+} )();
+
+
+var boolHook,
+ attrHandle = jQuery.expr.attrHandle;
+
+jQuery.fn.extend( {
+ attr: function( name, value ) {
+ return access( this, jQuery.attr, name, value, arguments.length > 1 );
+ },
+
+ removeAttr: function( name ) {
+ return this.each( function() {
+ jQuery.removeAttr( this, name );
+ } );
+ }
+} );
+
+jQuery.extend( {
+ attr: function( elem, name, value ) {
+ var ret, hooks,
+ nType = elem.nodeType;
+
+ // Don't get/set attributes on text, comment and attribute nodes
+ if ( nType === 3 || nType === 8 || nType === 2 ) {
+ return;
+ }
+
+ // Fallback to prop when attributes are not supported
+ if ( typeof elem.getAttribute === "undefined" ) {
+ return jQuery.prop( elem, name, value );
+ }
+
+ // Attribute hooks are determined by the lowercase version
+ // Grab necessary hook if one is defined
+ if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) {
+ hooks = jQuery.attrHooks[ name.toLowerCase() ] ||
+ ( jQuery.expr.match.bool.test( name ) ? boolHook : undefined );
+ }
+
+ if ( value !== undefined ) {
+ if ( value === null ) {
+ jQuery.removeAttr( elem, name );
+ return;
+ }
+
+ if ( hooks && "set" in hooks &&
+ ( ret = hooks.set( elem, value, name ) ) !== undefined ) {
+ return ret;
+ }
+
+ elem.setAttribute( name, value + "" );
+ return value;
+ }
+
+ if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) {
+ return ret;
+ }
+
+ ret = jQuery.find.attr( elem, name );
+
+ // Non-existent attributes return null, we normalize to undefined
+ return ret == null ? undefined : ret;
+ },
+
+ attrHooks: {
+ type: {
+ set: function( elem, value ) {
+ if ( !support.radioValue && value === "radio" &&
+ jQuery.nodeName( elem, "input" ) ) {
+ var val = elem.value;
+ elem.setAttribute( "type", value );
+ if ( val ) {
+ elem.value = val;
+ }
+ return value;
+ }
+ }
+ }
+ },
+
+ removeAttr: function( elem, value ) {
+ var name,
+ i = 0,
+
+ // Attribute names can contain non-HTML whitespace characters
+ // https://html.spec.whatwg.org/multipage/syntax.html#attributes-2
+ attrNames = value && value.match( rnothtmlwhite );
+
+ if ( attrNames && elem.nodeType === 1 ) {
+ while ( ( name = attrNames[ i++ ] ) ) {
+ elem.removeAttribute( name );
+ }
+ }
+ }
+} );
+
+// Hooks for boolean attributes
+boolHook = {
+ set: function( elem, value, name ) {
+ if ( value === false ) {
+
+ // Remove boolean attributes when set to false
+ jQuery.removeAttr( elem, name );
+ } else {
+ elem.setAttribute( name, name );
+ }
+ return name;
+ }
+};
+
+jQuery.each( jQuery.expr.match.bool.source.match( /\w+/g ), function( i, name ) {
+ var getter = attrHandle[ name ] || jQuery.find.attr;
+
+ attrHandle[ name ] = function( elem, name, isXML ) {
+ var ret, handle,
+ lowercaseName = name.toLowerCase();
+
+ if ( !isXML ) {
+
+ // Avoid an infinite loop by temporarily removing this function from the getter
+ handle = attrHandle[ lowercaseName ];
+ attrHandle[ lowercaseName ] = ret;
+ ret = getter( elem, name, isXML ) != null ?
+ lowercaseName :
+ null;
+ attrHandle[ lowercaseName ] = handle;
+ }
+ return ret;
+ };
+} );
+
+
+
+
+var rfocusable = /^(?:input|select|textarea|button)$/i,
+ rclickable = /^(?:a|area)$/i;
+
+jQuery.fn.extend( {
+ prop: function( name, value ) {
+ return access( this, jQuery.prop, name, value, arguments.length > 1 );
+ },
+
+ removeProp: function( name ) {
+ return this.each( function() {
+ delete this[ jQuery.propFix[ name ] || name ];
+ } );
+ }
+} );
+
+jQuery.extend( {
+ prop: function( elem, name, value ) {
+ var ret, hooks,
+ nType = elem.nodeType;
+
+ // Don't get/set properties on text, comment and attribute nodes
+ if ( nType === 3 || nType === 8 || nType === 2 ) {
+ return;
+ }
+
+ if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) {
+
+ // Fix name and attach hooks
+ name = jQuery.propFix[ name ] || name;
+ hooks = jQuery.propHooks[ name ];
+ }
+
+ if ( value !== undefined ) {
+ if ( hooks && "set" in hooks &&
+ ( ret = hooks.set( elem, value, name ) ) !== undefined ) {
+ return ret;
+ }
+
+ return ( elem[ name ] = value );
+ }
+
+ if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) {
+ return ret;
+ }
+
+ return elem[ name ];
+ },
+
+ propHooks: {
+ tabIndex: {
+ get: function( elem ) {
+
+ // Support: IE <=9 - 11 only
+ // elem.tabIndex doesn't always return the
+ // correct value when it hasn't been explicitly set
+ // https://web.archive.org/web/20141116233347/http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/
+ // Use proper attribute retrieval(#12072)
+ var tabindex = jQuery.find.attr( elem, "tabindex" );
+
+ if ( tabindex ) {
+ return parseInt( tabindex, 10 );
+ }
+
+ if (
+ rfocusable.test( elem.nodeName ) ||
+ rclickable.test( elem.nodeName ) &&
+ elem.href
+ ) {
+ return 0;
+ }
+
+ return -1;
+ }
+ }
+ },
+
+ propFix: {
+ "for": "htmlFor",
+ "class": "className"
+ }
+} );
+
+// Support: IE <=11 only
+// Accessing the selectedIndex property
+// forces the browser to respect setting selected
+// on the option
+// The getter ensures a default option is selected
+// when in an optgroup
+// eslint rule "no-unused-expressions" is disabled for this code
+// since it considers such accessions noop
+if ( !support.optSelected ) {
+ jQuery.propHooks.selected = {
+ get: function( elem ) {
+
+ /* eslint no-unused-expressions: "off" */
+
+ var parent = elem.parentNode;
+ if ( parent && parent.parentNode ) {
+ parent.parentNode.selectedIndex;
+ }
+ return null;
+ },
+ set: function( elem ) {
+
+ /* eslint no-unused-expressions: "off" */
+
+ var parent = elem.parentNode;
+ if ( parent ) {
+ parent.selectedIndex;
+
+ if ( parent.parentNode ) {
+ parent.parentNode.selectedIndex;
+ }
+ }
+ }
+ };
+}
+
+jQuery.each( [
+ "tabIndex",
+ "readOnly",
+ "maxLength",
+ "cellSpacing",
+ "cellPadding",
+ "rowSpan",
+ "colSpan",
+ "useMap",
+ "frameBorder",
+ "contentEditable"
+], function() {
+ jQuery.propFix[ this.toLowerCase() ] = this;
+} );
+
+
+
+
+ // Strip and collapse whitespace according to HTML spec
+ // https://html.spec.whatwg.org/multipage/infrastructure.html#strip-and-collapse-whitespace
+ function stripAndCollapse( value ) {
+ var tokens = value.match( rnothtmlwhite ) || [];
+ return tokens.join( " " );
+ }
+
+
+function getClass( elem ) {
+ return elem.getAttribute && elem.getAttribute( "class" ) || "";
+}
+
+jQuery.fn.extend( {
+ addClass: function( value ) {
+ var classes, elem, cur, curValue, clazz, j, finalValue,
+ i = 0;
+
+ if ( jQuery.isFunction( value ) ) {
+ return this.each( function( j ) {
+ jQuery( this ).addClass( value.call( this, j, getClass( this ) ) );
+ } );
+ }
+
+ if ( typeof value === "string" && value ) {
+ classes = value.match( rnothtmlwhite ) || [];
+
+ while ( ( elem = this[ i++ ] ) ) {
+ curValue = getClass( elem );
+ cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " );
+
+ if ( cur ) {
+ j = 0;
+ while ( ( clazz = classes[ j++ ] ) ) {
+ if ( cur.indexOf( " " + clazz + " " ) < 0 ) {
+ cur += clazz + " ";
+ }
+ }
+
+ // Only assign if different to avoid unneeded rendering.
+ finalValue = stripAndCollapse( cur );
+ if ( curValue !== finalValue ) {
+ elem.setAttribute( "class", finalValue );
+ }
+ }
+ }
+ }
+
+ return this;
+ },
+
+ removeClass: function( value ) {
+ var classes, elem, cur, curValue, clazz, j, finalValue,
+ i = 0;
+
+ if ( jQuery.isFunction( value ) ) {
+ return this.each( function( j ) {
+ jQuery( this ).removeClass( value.call( this, j, getClass( this ) ) );
+ } );
+ }
+
+ if ( !arguments.length ) {
+ return this.attr( "class", "" );
+ }
+
+ if ( typeof value === "string" && value ) {
+ classes = value.match( rnothtmlwhite ) || [];
+
+ while ( ( elem = this[ i++ ] ) ) {
+ curValue = getClass( elem );
+
+ // This expression is here for better compressibility (see addClass)
+ cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " );
+
+ if ( cur ) {
+ j = 0;
+ while ( ( clazz = classes[ j++ ] ) ) {
+
+ // Remove *all* instances
+ while ( cur.indexOf( " " + clazz + " " ) > -1 ) {
+ cur = cur.replace( " " + clazz + " ", " " );
+ }
+ }
+
+ // Only assign if different to avoid unneeded rendering.
+ finalValue = stripAndCollapse( cur );
+ if ( curValue !== finalValue ) {
+ elem.setAttribute( "class", finalValue );
+ }
+ }
+ }
+ }
+
+ return this;
+ },
+
+ toggleClass: function( value, stateVal ) {
+ var type = typeof value;
+
+ if ( typeof stateVal === "boolean" && type === "string" ) {
+ return stateVal ? this.addClass( value ) : this.removeClass( value );
+ }
+
+ if ( jQuery.isFunction( value ) ) {
+ return this.each( function( i ) {
+ jQuery( this ).toggleClass(
+ value.call( this, i, getClass( this ), stateVal ),
+ stateVal
+ );
+ } );
+ }
+
+ return this.each( function() {
+ var className, i, self, classNames;
+
+ if ( type === "string" ) {
+
+ // Toggle individual class names
+ i = 0;
+ self = jQuery( this );
+ classNames = value.match( rnothtmlwhite ) || [];
+
+ while ( ( className = classNames[ i++ ] ) ) {
+
+ // Check each className given, space separated list
+ if ( self.hasClass( className ) ) {
+ self.removeClass( className );
+ } else {
+ self.addClass( className );
+ }
+ }
+
+ // Toggle whole class name
+ } else if ( value === undefined || type === "boolean" ) {
+ className = getClass( this );
+ if ( className ) {
+
+ // Store className if set
+ dataPriv.set( this, "__className__", className );
+ }
+
+ // If the element has a class name or if we're passed `false`,
+ // then remove the whole classname (if there was one, the above saved it).
+ // Otherwise bring back whatever was previously saved (if anything),
+ // falling back to the empty string if nothing was stored.
+ if ( this.setAttribute ) {
+ this.setAttribute( "class",
+ className || value === false ?
+ "" :
+ dataPriv.get( this, "__className__" ) || ""
+ );
+ }
+ }
+ } );
+ },
+
+ hasClass: function( selector ) {
+ var className, elem,
+ i = 0;
+
+ className = " " + selector + " ";
+ while ( ( elem = this[ i++ ] ) ) {
+ if ( elem.nodeType === 1 &&
+ ( " " + stripAndCollapse( getClass( elem ) ) + " " ).indexOf( className ) > -1 ) {
+ return true;
+ }
+ }
+
+ return false;
+ }
+} );
+
+
+
+
+var rreturn = /\r/g;
+
+jQuery.fn.extend( {
+ val: function( value ) {
+ var hooks, ret, isFunction,
+ elem = this[ 0 ];
+
+ if ( !arguments.length ) {
+ if ( elem ) {
+ hooks = jQuery.valHooks[ elem.type ] ||
+ jQuery.valHooks[ elem.nodeName.toLowerCase() ];
+
+ if ( hooks &&
+ "get" in hooks &&
+ ( ret = hooks.get( elem, "value" ) ) !== undefined
+ ) {
+ return ret;
+ }
+
+ ret = elem.value;
+
+ // Handle most common string cases
+ if ( typeof ret === "string" ) {
+ return ret.replace( rreturn, "" );
+ }
+
+ // Handle cases where value is null/undef or number
+ return ret == null ? "" : ret;
+ }
+
+ return;
+ }
+
+ isFunction = jQuery.isFunction( value );
+
+ return this.each( function( i ) {
+ var val;
+
+ if ( this.nodeType !== 1 ) {
+ return;
+ }
+
+ if ( isFunction ) {
+ val = value.call( this, i, jQuery( this ).val() );
+ } else {
+ val = value;
+ }
+
+ // Treat null/undefined as ""; convert numbers to string
+ if ( val == null ) {
+ val = "";
+
+ } else if ( typeof val === "number" ) {
+ val += "";
+
+ } else if ( jQuery.isArray( val ) ) {
+ val = jQuery.map( val, function( value ) {
+ return value == null ? "" : value + "";
+ } );
+ }
+
+ hooks = jQuery.valHooks[ this.type ] || jQuery.valHooks[ this.nodeName.toLowerCase() ];
+
+ // If set returns undefined, fall back to normal setting
+ if ( !hooks || !( "set" in hooks ) || hooks.set( this, val, "value" ) === undefined ) {
+ this.value = val;
+ }
+ } );
+ }
+} );
+
+jQuery.extend( {
+ valHooks: {
+ option: {
+ get: function( elem ) {
+
+ var val = jQuery.find.attr( elem, "value" );
+ return val != null ?
+ val :
+
+ // Support: IE <=10 - 11 only
+ // option.text throws exceptions (#14686, #14858)
+ // Strip and collapse whitespace
+ // https://html.spec.whatwg.org/#strip-and-collapse-whitespace
+ stripAndCollapse( jQuery.text( elem ) );
+ }
+ },
+ select: {
+ get: function( elem ) {
+ var value, option, i,
+ options = elem.options,
+ index = elem.selectedIndex,
+ one = elem.type === "select-one",
+ values = one ? null : [],
+ max = one ? index + 1 : options.length;
+
+ if ( index < 0 ) {
+ i = max;
+
+ } else {
+ i = one ? index : 0;
+ }
+
+ // Loop through all the selected options
+ for ( ; i < max; i++ ) {
+ option = options[ i ];
+
+ // Support: IE <=9 only
+ // IE8-9 doesn't update selected after form reset (#2551)
+ if ( ( option.selected || i === index ) &&
+
+ // Don't return options that are disabled or in a disabled optgroup
+ !option.disabled &&
+ ( !option.parentNode.disabled ||
+ !jQuery.nodeName( option.parentNode, "optgroup" ) ) ) {
+
+ // Get the specific value for the option
+ value = jQuery( option ).val();
+
+ // We don't need an array for one selects
+ if ( one ) {
+ return value;
+ }
+
+ // Multi-Selects return an array
+ values.push( value );
+ }
+ }
+
+ return values;
+ },
+
+ set: function( elem, value ) {
+ var optionSet, option,
+ options = elem.options,
+ values = jQuery.makeArray( value ),
+ i = options.length;
+
+ while ( i-- ) {
+ option = options[ i ];
+
+ /* eslint-disable no-cond-assign */
+
+ if ( option.selected =
+ jQuery.inArray( jQuery.valHooks.option.get( option ), values ) > -1
+ ) {
+ optionSet = true;
+ }
+
+ /* eslint-enable no-cond-assign */
+ }
+
+ // Force browsers to behave consistently when non-matching value is set
+ if ( !optionSet ) {
+ elem.selectedIndex = -1;
+ }
+ return values;
+ }
+ }
+ }
+} );
+
+// Radios and checkboxes getter/setter
+jQuery.each( [ "radio", "checkbox" ], function() {
+ jQuery.valHooks[ this ] = {
+ set: function( elem, value ) {
+ if ( jQuery.isArray( value ) ) {
+ return ( elem.checked = jQuery.inArray( jQuery( elem ).val(), value ) > -1 );
+ }
+ }
+ };
+ if ( !support.checkOn ) {
+ jQuery.valHooks[ this ].get = function( elem ) {
+ return elem.getAttribute( "value" ) === null ? "on" : elem.value;
+ };
+ }
+} );
+
+
+
+
+// Return jQuery for attributes-only inclusion
+
+
+var rfocusMorph = /^(?:focusinfocus|focusoutblur)$/;
+
+jQuery.extend( jQuery.event, {
+
+ trigger: function( event, data, elem, onlyHandlers ) {
+
+ var i, cur, tmp, bubbleType, ontype, handle, special,
+ eventPath = [ elem || document ],
+ type = hasOwn.call( event, "type" ) ? event.type : event,
+ namespaces = hasOwn.call( event, "namespace" ) ? event.namespace.split( "." ) : [];
+
+ cur = tmp = elem = elem || document;
+
+ // Don't do events on text and comment nodes
+ if ( elem.nodeType === 3 || elem.nodeType === 8 ) {
+ return;
+ }
+
+ // focus/blur morphs to focusin/out; ensure we're not firing them right now
+ if ( rfocusMorph.test( type + jQuery.event.triggered ) ) {
+ return;
+ }
+
+ if ( type.indexOf( "." ) > -1 ) {
+
+ // Namespaced trigger; create a regexp to match event type in handle()
+ namespaces = type.split( "." );
+ type = namespaces.shift();
+ namespaces.sort();
+ }
+ ontype = type.indexOf( ":" ) < 0 && "on" + type;
+
+ // Caller can pass in a jQuery.Event object, Object, or just an event type string
+ event = event[ jQuery.expando ] ?
+ event :
+ new jQuery.Event( type, typeof event === "object" && event );
+
+ // Trigger bitmask: & 1 for native handlers; & 2 for jQuery (always true)
+ event.isTrigger = onlyHandlers ? 2 : 3;
+ event.namespace = namespaces.join( "." );
+ event.rnamespace = event.namespace ?
+ new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ) :
+ null;
+
+ // Clean up the event in case it is being reused
+ event.result = undefined;
+ if ( !event.target ) {
+ event.target = elem;
+ }
+
+ // Clone any incoming data and prepend the event, creating the handler arg list
+ data = data == null ?
+ [ event ] :
+ jQuery.makeArray( data, [ event ] );
+
+ // Allow special events to draw outside the lines
+ special = jQuery.event.special[ type ] || {};
+ if ( !onlyHandlers && special.trigger && special.trigger.apply( elem, data ) === false ) {
+ return;
+ }
+
+ // Determine event propagation path in advance, per W3C events spec (#9951)
+ // Bubble up to document, then to window; watch for a global ownerDocument var (#9724)
+ if ( !onlyHandlers && !special.noBubble && !jQuery.isWindow( elem ) ) {
+
+ bubbleType = special.delegateType || type;
+ if ( !rfocusMorph.test( bubbleType + type ) ) {
+ cur = cur.parentNode;
+ }
+ for ( ; cur; cur = cur.parentNode ) {
+ eventPath.push( cur );
+ tmp = cur;
+ }
+
+ // Only add window if we got to document (e.g., not plain obj or detached DOM)
+ if ( tmp === ( elem.ownerDocument || document ) ) {
+ eventPath.push( tmp.defaultView || tmp.parentWindow || window );
+ }
+ }
+
+ // Fire handlers on the event path
+ i = 0;
+ while ( ( cur = eventPath[ i++ ] ) && !event.isPropagationStopped() ) {
+
+ event.type = i > 1 ?
+ bubbleType :
+ special.bindType || type;
+
+ // jQuery handler
+ handle = ( dataPriv.get( cur, "events" ) || {} )[ event.type ] &&
+ dataPriv.get( cur, "handle" );
+ if ( handle ) {
+ handle.apply( cur, data );
+ }
+
+ // Native handler
+ handle = ontype && cur[ ontype ];
+ if ( handle && handle.apply && acceptData( cur ) ) {
+ event.result = handle.apply( cur, data );
+ if ( event.result === false ) {
+ event.preventDefault();
+ }
+ }
+ }
+ event.type = type;
+
+ // If nobody prevented the default action, do it now
+ if ( !onlyHandlers && !event.isDefaultPrevented() ) {
+
+ if ( ( !special._default ||
+ special._default.apply( eventPath.pop(), data ) === false ) &&
+ acceptData( elem ) ) {
+
+ // Call a native DOM method on the target with the same name as the event.
+ // Don't do default actions on window, that's where global variables be (#6170)
+ if ( ontype && jQuery.isFunction( elem[ type ] ) && !jQuery.isWindow( elem ) ) {
+
+ // Don't re-trigger an onFOO event when we call its FOO() method
+ tmp = elem[ ontype ];
+
+ if ( tmp ) {
+ elem[ ontype ] = null;
+ }
+
+ // Prevent re-triggering of the same event, since we already bubbled it above
+ jQuery.event.triggered = type;
+ elem[ type ]();
+ jQuery.event.triggered = undefined;
+
+ if ( tmp ) {
+ elem[ ontype ] = tmp;
+ }
+ }
+ }
+ }
+
+ return event.result;
+ },
+
+ // Piggyback on a donor event to simulate a different one
+ // Used only for `focus(in | out)` events
+ simulate: function( type, elem, event ) {
+ var e = jQuery.extend(
+ new jQuery.Event(),
+ event,
+ {
+ type: type,
+ isSimulated: true
+ }
+ );
+
+ jQuery.event.trigger( e, null, elem );
+ }
+
+} );
+
+jQuery.fn.extend( {
+
+ trigger: function( type, data ) {
+ return this.each( function() {
+ jQuery.event.trigger( type, data, this );
+ } );
+ },
+ triggerHandler: function( type, data ) {
+ var elem = this[ 0 ];
+ if ( elem ) {
+ return jQuery.event.trigger( type, data, elem, true );
+ }
+ }
+} );
+
+
+jQuery.each( ( "blur focus focusin focusout resize scroll click dblclick " +
+ "mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave " +
+ "change select submit keydown keypress keyup contextmenu" ).split( " " ),
+ function( i, name ) {
+
+ // Handle event binding
+ jQuery.fn[ name ] = function( data, fn ) {
+ return arguments.length > 0 ?
+ this.on( name, null, data, fn ) :
+ this.trigger( name );
+ };
+} );
+
+jQuery.fn.extend( {
+ hover: function( fnOver, fnOut ) {
+ return this.mouseenter( fnOver ).mouseleave( fnOut || fnOver );
+ }
+} );
+
+
+
+
+support.focusin = "onfocusin" in window;
+
+
+// Support: Firefox <=44
+// Firefox doesn't have focus(in | out) events
+// Related ticket - https://bugzilla.mozilla.org/show_bug.cgi?id=687787
+//
+// Support: Chrome <=48 - 49, Safari <=9.0 - 9.1
+// focus(in | out) events fire after focus & blur events,
+// which is spec violation - http://www.w3.org/TR/DOM-Level-3-Events/#events-focusevent-event-order
+// Related ticket - https://bugs.chromium.org/p/chromium/issues/detail?id=449857
+if ( !support.focusin ) {
+ jQuery.each( { focus: "focusin", blur: "focusout" }, function( orig, fix ) {
+
+ // Attach a single capturing handler on the document while someone wants focusin/focusout
+ var handler = function( event ) {
+ jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ) );
+ };
+
+ jQuery.event.special[ fix ] = {
+ setup: function() {
+ var doc = this.ownerDocument || this,
+ attaches = dataPriv.access( doc, fix );
+
+ if ( !attaches ) {
+ doc.addEventListener( orig, handler, true );
+ }
+ dataPriv.access( doc, fix, ( attaches || 0 ) + 1 );
+ },
+ teardown: function() {
+ var doc = this.ownerDocument || this,
+ attaches = dataPriv.access( doc, fix ) - 1;
+
+ if ( !attaches ) {
+ doc.removeEventListener( orig, handler, true );
+ dataPriv.remove( doc, fix );
+
+ } else {
+ dataPriv.access( doc, fix, attaches );
+ }
+ }
+ };
+ } );
+}
+var location = window.location;
+
+var nonce = jQuery.now();
+
+var rquery = ( /\?/ );
+
+
+
+// Cross-browser xml parsing
+jQuery.parseXML = function( data ) {
+ var xml;
+ if ( !data || typeof data !== "string" ) {
+ return null;
+ }
+
+ // Support: IE 9 - 11 only
+ // IE throws on parseFromString with invalid input.
+ try {
+ xml = ( new window.DOMParser() ).parseFromString( data, "text/xml" );
+ } catch ( e ) {
+ xml = undefined;
+ }
+
+ if ( !xml || xml.getElementsByTagName( "parsererror" ).length ) {
+ jQuery.error( "Invalid XML: " + data );
+ }
+ return xml;
+};
+
+
+var
+ rbracket = /\[\]$/,
+ rCRLF = /\r?\n/g,
+ rsubmitterTypes = /^(?:submit|button|image|reset|file)$/i,
+ rsubmittable = /^(?:input|select|textarea|keygen)/i;
+
+function buildParams( prefix, obj, traditional, add ) {
+ var name;
+
+ if ( jQuery.isArray( obj ) ) {
+
+ // Serialize array item.
+ jQuery.each( obj, function( i, v ) {
+ if ( traditional || rbracket.test( prefix ) ) {
+
+ // Treat each array item as a scalar.
+ add( prefix, v );
+
+ } else {
+
+ // Item is non-scalar (array or object), encode its numeric index.
+ buildParams(
+ prefix + "[" + ( typeof v === "object" && v != null ? i : "" ) + "]",
+ v,
+ traditional,
+ add
+ );
+ }
+ } );
+
+ } else if ( !traditional && jQuery.type( obj ) === "object" ) {
+
+ // Serialize object item.
+ for ( name in obj ) {
+ buildParams( prefix + "[" + name + "]", obj[ name ], traditional, add );
+ }
+
+ } else {
+
+ // Serialize scalar item.
+ add( prefix, obj );
+ }
+}
+
+// Serialize an array of form elements or a set of
+// key/values into a query string
+jQuery.param = function( a, traditional ) {
+ var prefix,
+ s = [],
+ add = function( key, valueOrFunction ) {
+
+ // If value is a function, invoke it and use its return value
+ var value = jQuery.isFunction( valueOrFunction ) ?
+ valueOrFunction() :
+ valueOrFunction;
+
+ s[ s.length ] = encodeURIComponent( key ) + "=" +
+ encodeURIComponent( value == null ? "" : value );
+ };
+
+ // If an array was passed in, assume that it is an array of form elements.
+ if ( jQuery.isArray( a ) || ( a.jquery && !jQuery.isPlainObject( a ) ) ) {
+
+ // Serialize the form elements
+ jQuery.each( a, function() {
+ add( this.name, this.value );
+ } );
+
+ } else {
+
+ // If traditional, encode the "old" way (the way 1.3.2 or older
+ // did it), otherwise encode params recursively.
+ for ( prefix in a ) {
+ buildParams( prefix, a[ prefix ], traditional, add );
+ }
+ }
+
+ // Return the resulting serialization
+ return s.join( "&" );
+};
+
+jQuery.fn.extend( {
+ serialize: function() {
+ return jQuery.param( this.serializeArray() );
+ },
+ serializeArray: function() {
+ return this.map( function() {
+
+ // Can add propHook for "elements" to filter or add form elements
+ var elements = jQuery.prop( this, "elements" );
+ return elements ? jQuery.makeArray( elements ) : this;
+ } )
+ .filter( function() {
+ var type = this.type;
+
+ // Use .is( ":disabled" ) so that fieldset[disabled] works
+ return this.name && !jQuery( this ).is( ":disabled" ) &&
+ rsubmittable.test( this.nodeName ) && !rsubmitterTypes.test( type ) &&
+ ( this.checked || !rcheckableType.test( type ) );
+ } )
+ .map( function( i, elem ) {
+ var val = jQuery( this ).val();
+
+ if ( val == null ) {
+ return null;
+ }
+
+ if ( jQuery.isArray( val ) ) {
+ return jQuery.map( val, function( val ) {
+ return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) };
+ } );
+ }
+
+ return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) };
+ } ).get();
+ }
+} );
+
+
+var
+ r20 = /%20/g,
+ rhash = /#.*$/,
+ rantiCache = /([?&])_=[^&]*/,
+ rheaders = /^(.*?):[ \t]*([^\r\n]*)$/mg,
+
+ // #7653, #8125, #8152: local protocol detection
+ rlocalProtocol = /^(?:about|app|app-storage|.+-extension|file|res|widget):$/,
+ rnoContent = /^(?:GET|HEAD)$/,
+ rprotocol = /^\/\//,
+
+ /* Prefilters
+ * 1) They are useful to introduce custom dataTypes (see ajax/jsonp.js for an example)
+ * 2) These are called:
+ * - BEFORE asking for a transport
+ * - AFTER param serialization (s.data is a string if s.processData is true)
+ * 3) key is the dataType
+ * 4) the catchall symbol "*" can be used
+ * 5) execution will start with transport dataType and THEN continue down to "*" if needed
+ */
+ prefilters = {},
+
+ /* Transports bindings
+ * 1) key is the dataType
+ * 2) the catchall symbol "*" can be used
+ * 3) selection will start with transport dataType and THEN go to "*" if needed
+ */
+ transports = {},
+
+ // Avoid comment-prolog char sequence (#10098); must appease lint and evade compression
+ allTypes = "*/".concat( "*" ),
+
+ // Anchor tag for parsing the document origin
+ originAnchor = document.createElement( "a" );
+ originAnchor.href = location.href;
+
+// Base "constructor" for jQuery.ajaxPrefilter and jQuery.ajaxTransport
+function addToPrefiltersOrTransports( structure ) {
+
+ // dataTypeExpression is optional and defaults to "*"
+ return function( dataTypeExpression, func ) {
+
+ if ( typeof dataTypeExpression !== "string" ) {
+ func = dataTypeExpression;
+ dataTypeExpression = "*";
+ }
+
+ var dataType,
+ i = 0,
+ dataTypes = dataTypeExpression.toLowerCase().match( rnothtmlwhite ) || [];
+
+ if ( jQuery.isFunction( func ) ) {
+
+ // For each dataType in the dataTypeExpression
+ while ( ( dataType = dataTypes[ i++ ] ) ) {
+
+ // Prepend if requested
+ if ( dataType[ 0 ] === "+" ) {
+ dataType = dataType.slice( 1 ) || "*";
+ ( structure[ dataType ] = structure[ dataType ] || [] ).unshift( func );
+
+ // Otherwise append
+ } else {
+ ( structure[ dataType ] = structure[ dataType ] || [] ).push( func );
+ }
+ }
+ }
+ };
+}
+
+// Base inspection function for prefilters and transports
+function inspectPrefiltersOrTransports( structure, options, originalOptions, jqXHR ) {
+
+ var inspected = {},
+ seekingTransport = ( structure === transports );
+
+ function inspect( dataType ) {
+ var selected;
+ inspected[ dataType ] = true;
+ jQuery.each( structure[ dataType ] || [], function( _, prefilterOrFactory ) {
+ var dataTypeOrTransport = prefilterOrFactory( options, originalOptions, jqXHR );
+ if ( typeof dataTypeOrTransport === "string" &&
+ !seekingTransport && !inspected[ dataTypeOrTransport ] ) {
+
+ options.dataTypes.unshift( dataTypeOrTransport );
+ inspect( dataTypeOrTransport );
+ return false;
+ } else if ( seekingTransport ) {
+ return !( selected = dataTypeOrTransport );
+ }
+ } );
+ return selected;
+ }
+
+ return inspect( options.dataTypes[ 0 ] ) || !inspected[ "*" ] && inspect( "*" );
+}
+
+// A special extend for ajax options
+// that takes "flat" options (not to be deep extended)
+// Fixes #9887
+function ajaxExtend( target, src ) {
+ var key, deep,
+ flatOptions = jQuery.ajaxSettings.flatOptions || {};
+
+ for ( key in src ) {
+ if ( src[ key ] !== undefined ) {
+ ( flatOptions[ key ] ? target : ( deep || ( deep = {} ) ) )[ key ] = src[ key ];
+ }
+ }
+ if ( deep ) {
+ jQuery.extend( true, target, deep );
+ }
+
+ return target;
+}
+
+/* Handles responses to an ajax request:
+ * - finds the right dataType (mediates between content-type and expected dataType)
+ * - returns the corresponding response
+ */
+function ajaxHandleResponses( s, jqXHR, responses ) {
+
+ var ct, type, finalDataType, firstDataType,
+ contents = s.contents,
+ dataTypes = s.dataTypes;
+
+ // Remove auto dataType and get content-type in the process
+ while ( dataTypes[ 0 ] === "*" ) {
+ dataTypes.shift();
+ if ( ct === undefined ) {
+ ct = s.mimeType || jqXHR.getResponseHeader( "Content-Type" );
+ }
+ }
+
+ // Check if we're dealing with a known content-type
+ if ( ct ) {
+ for ( type in contents ) {
+ if ( contents[ type ] && contents[ type ].test( ct ) ) {
+ dataTypes.unshift( type );
+ break;
+ }
+ }
+ }
+
+ // Check to see if we have a response for the expected dataType
+ if ( dataTypes[ 0 ] in responses ) {
+ finalDataType = dataTypes[ 0 ];
+ } else {
+
+ // Try convertible dataTypes
+ for ( type in responses ) {
+ if ( !dataTypes[ 0 ] || s.converters[ type + " " + dataTypes[ 0 ] ] ) {
+ finalDataType = type;
+ break;
+ }
+ if ( !firstDataType ) {
+ firstDataType = type;
+ }
+ }
+
+ // Or just use first one
+ finalDataType = finalDataType || firstDataType;
+ }
+
+ // If we found a dataType
+ // We add the dataType to the list if needed
+ // and return the corresponding response
+ if ( finalDataType ) {
+ if ( finalDataType !== dataTypes[ 0 ] ) {
+ dataTypes.unshift( finalDataType );
+ }
+ return responses[ finalDataType ];
+ }
+}
+
+/* Chain conversions given the request and the original response
+ * Also sets the responseXXX fields on the jqXHR instance
+ */
+function ajaxConvert( s, response, jqXHR, isSuccess ) {
+ var conv2, current, conv, tmp, prev,
+ converters = {},
+
+ // Work with a copy of dataTypes in case we need to modify it for conversion
+ dataTypes = s.dataTypes.slice();
+
+ // Create converters map with lowercased keys
+ if ( dataTypes[ 1 ] ) {
+ for ( conv in s.converters ) {
+ converters[ conv.toLowerCase() ] = s.converters[ conv ];
+ }
+ }
+
+ current = dataTypes.shift();
+
+ // Convert to each sequential dataType
+ while ( current ) {
+
+ if ( s.responseFields[ current ] ) {
+ jqXHR[ s.responseFields[ current ] ] = response;
+ }
+
+ // Apply the dataFilter if provided
+ if ( !prev && isSuccess && s.dataFilter ) {
+ response = s.dataFilter( response, s.dataType );
+ }
+
+ prev = current;
+ current = dataTypes.shift();
+
+ if ( current ) {
+
+ // There's only work to do if current dataType is non-auto
+ if ( current === "*" ) {
+
+ current = prev;
+
+ // Convert response if prev dataType is non-auto and differs from current
+ } else if ( prev !== "*" && prev !== current ) {
+
+ // Seek a direct converter
+ conv = converters[ prev + " " + current ] || converters[ "* " + current ];
+
+ // If none found, seek a pair
+ if ( !conv ) {
+ for ( conv2 in converters ) {
+
+ // If conv2 outputs current
+ tmp = conv2.split( " " );
+ if ( tmp[ 1 ] === current ) {
+
+ // If prev can be converted to accepted input
+ conv = converters[ prev + " " + tmp[ 0 ] ] ||
+ converters[ "* " + tmp[ 0 ] ];
+ if ( conv ) {
+
+ // Condense equivalence converters
+ if ( conv === true ) {
+ conv = converters[ conv2 ];
+
+ // Otherwise, insert the intermediate dataType
+ } else if ( converters[ conv2 ] !== true ) {
+ current = tmp[ 0 ];
+ dataTypes.unshift( tmp[ 1 ] );
+ }
+ break;
+ }
+ }
+ }
+ }
+
+ // Apply converter (if not an equivalence)
+ if ( conv !== true ) {
+
+ // Unless errors are allowed to bubble, catch and return them
+ if ( conv && s.throws ) {
+ response = conv( response );
+ } else {
+ try {
+ response = conv( response );
+ } catch ( e ) {
+ return {
+ state: "parsererror",
+ error: conv ? e : "No conversion from " + prev + " to " + current
+ };
+ }
+ }
+ }
+ }
+ }
+ }
+
+ return { state: "success", data: response };
+}
+
+jQuery.extend( {
+
+ // Counter for holding the number of active queries
+ active: 0,
+
+ // Last-Modified header cache for next request
+ lastModified: {},
+ etag: {},
+
+ ajaxSettings: {
+ url: location.href,
+ type: "GET",
+ isLocal: rlocalProtocol.test( location.protocol ),
+ global: true,
+ processData: true,
+ async: true,
+ contentType: "application/x-www-form-urlencoded; charset=UTF-8",
+
+ /*
+ timeout: 0,
+ data: null,
+ dataType: null,
+ username: null,
+ password: null,
+ cache: null,
+ throws: false,
+ traditional: false,
+ headers: {},
+ */
+
+ accepts: {
+ "*": allTypes,
+ text: "text/plain",
+ html: "text/html",
+ xml: "application/xml, text/xml",
+ json: "application/json, text/javascript"
+ },
+
+ contents: {
+ xml: /\bxml\b/,
+ html: /\bhtml/,
+ json: /\bjson\b/
+ },
+
+ responseFields: {
+ xml: "responseXML",
+ text: "responseText",
+ json: "responseJSON"
+ },
+
+ // Data converters
+ // Keys separate source (or catchall "*") and destination types with a single space
+ converters: {
+
+ // Convert anything to text
+ "* text": String,
+
+ // Text to html (true = no transformation)
+ "text html": true,
+
+ // Evaluate text as a json expression
+ "text json": JSON.parse,
+
+ // Parse text as xml
+ "text xml": jQuery.parseXML
+ },
+
+ // For options that shouldn't be deep extended:
+ // you can add your own custom options here if
+ // and when you create one that shouldn't be
+ // deep extended (see ajaxExtend)
+ flatOptions: {
+ url: true,
+ context: true
+ }
+ },
+
+ // Creates a full fledged settings object into target
+ // with both ajaxSettings and settings fields.
+ // If target is omitted, writes into ajaxSettings.
+ ajaxSetup: function( target, settings ) {
+ return settings ?
+
+ // Building a settings object
+ ajaxExtend( ajaxExtend( target, jQuery.ajaxSettings ), settings ) :
+
+ // Extending ajaxSettings
+ ajaxExtend( jQuery.ajaxSettings, target );
+ },
+
+ ajaxPrefilter: addToPrefiltersOrTransports( prefilters ),
+ ajaxTransport: addToPrefiltersOrTransports( transports ),
+
+ // Main method
+ ajax: function( url, options ) {
+
+ // If url is an object, simulate pre-1.5 signature
+ if ( typeof url === "object" ) {
+ options = url;
+ url = undefined;
+ }
+
+ // Force options to be an object
+ options = options || {};
+
+ var transport,
+
+ // URL without anti-cache param
+ cacheURL,
+
+ // Response headers
+ responseHeadersString,
+ responseHeaders,
+
+ // timeout handle
+ timeoutTimer,
+
+ // Url cleanup var
+ urlAnchor,
+
+ // Request state (becomes false upon send and true upon completion)
+ completed,
+
+ // To know if global events are to be dispatched
+ fireGlobals,
+
+ // Loop variable
+ i,
+
+ // uncached part of the url
+ uncached,
+
+ // Create the final options object
+ s = jQuery.ajaxSetup( {}, options ),
+
+ // Callbacks context
+ callbackContext = s.context || s,
+
+ // Context for global events is callbackContext if it is a DOM node or jQuery collection
+ globalEventContext = s.context &&
+ ( callbackContext.nodeType || callbackContext.jquery ) ?
+ jQuery( callbackContext ) :
+ jQuery.event,
+
+ // Deferreds
+ deferred = jQuery.Deferred(),
+ completeDeferred = jQuery.Callbacks( "once memory" ),
+
+ // Status-dependent callbacks
+ statusCode = s.statusCode || {},
+
+ // Headers (they are sent all at once)
+ requestHeaders = {},
+ requestHeadersNames = {},
+
+ // Default abort message
+ strAbort = "canceled",
+
+ // Fake xhr
+ jqXHR = {
+ readyState: 0,
+
+ // Builds headers hashtable if needed
+ getResponseHeader: function( key ) {
+ var match;
+ if ( completed ) {
+ if ( !responseHeaders ) {
+ responseHeaders = {};
+ while ( ( match = rheaders.exec( responseHeadersString ) ) ) {
+ responseHeaders[ match[ 1 ].toLowerCase() ] = match[ 2 ];
+ }
+ }
+ match = responseHeaders[ key.toLowerCase() ];
+ }
+ return match == null ? null : match;
+ },
+
+ // Raw string
+ getAllResponseHeaders: function() {
+ return completed ? responseHeadersString : null;
+ },
+
+ // Caches the header
+ setRequestHeader: function( name, value ) {
+ if ( completed == null ) {
+ name = requestHeadersNames[ name.toLowerCase() ] =
+ requestHeadersNames[ name.toLowerCase() ] || name;
+ requestHeaders[ name ] = value;
+ }
+ return this;
+ },
+
+ // Overrides response content-type header
+ overrideMimeType: function( type ) {
+ if ( completed == null ) {
+ s.mimeType = type;
+ }
+ return this;
+ },
+
+ // Status-dependent callbacks
+ statusCode: function( map ) {
+ var code;
+ if ( map ) {
+ if ( completed ) {
+
+ // Execute the appropriate callbacks
+ jqXHR.always( map[ jqXHR.status ] );
+ } else {
+
+ // Lazy-add the new callbacks in a way that preserves old ones
+ for ( code in map ) {
+ statusCode[ code ] = [ statusCode[ code ], map[ code ] ];
+ }
+ }
+ }
+ return this;
+ },
+
+ // Cancel the request
+ abort: function( statusText ) {
+ var finalText = statusText || strAbort;
+ if ( transport ) {
+ transport.abort( finalText );
+ }
+ done( 0, finalText );
+ return this;
+ }
+ };
+
+ // Attach deferreds
+ deferred.promise( jqXHR );
+
+ // Add protocol if not provided (prefilters might expect it)
+ // Handle falsy url in the settings object (#10093: consistency with old signature)
+ // We also use the url parameter if available
+ s.url = ( ( url || s.url || location.href ) + "" )
+ .replace( rprotocol, location.protocol + "//" );
+
+ // Alias method option to type as per ticket #12004
+ s.type = options.method || options.type || s.method || s.type;
+
+ // Extract dataTypes list
+ s.dataTypes = ( s.dataType || "*" ).toLowerCase().match( rnothtmlwhite ) || [ "" ];
+
+ // A cross-domain request is in order when the origin doesn't match the current origin.
+ if ( s.crossDomain == null ) {
+ urlAnchor = document.createElement( "a" );
+
+ // Support: IE <=8 - 11, Edge 12 - 13
+ // IE throws exception on accessing the href property if url is malformed,
+ // e.g. http://example.com:80x/
+ try {
+ urlAnchor.href = s.url;
+
+ // Support: IE <=8 - 11 only
+ // Anchor's host property isn't correctly set when s.url is relative
+ urlAnchor.href = urlAnchor.href;
+ s.crossDomain = originAnchor.protocol + "//" + originAnchor.host !==
+ urlAnchor.protocol + "//" + urlAnchor.host;
+ } catch ( e ) {
+
+ // If there is an error parsing the URL, assume it is crossDomain,
+ // it can be rejected by the transport if it is invalid
+ s.crossDomain = true;
+ }
+ }
+
+ // Convert data if not already a string
+ if ( s.data && s.processData && typeof s.data !== "string" ) {
+ s.data = jQuery.param( s.data, s.traditional );
+ }
+
+ // Apply prefilters
+ inspectPrefiltersOrTransports( prefilters, s, options, jqXHR );
+
+ // If request was aborted inside a prefilter, stop there
+ if ( completed ) {
+ return jqXHR;
+ }
+
+ // We can fire global events as of now if asked to
+ // Don't fire events if jQuery.event is undefined in an AMD-usage scenario (#15118)
+ fireGlobals = jQuery.event && s.global;
+
+ // Watch for a new set of requests
+ if ( fireGlobals && jQuery.active++ === 0 ) {
+ jQuery.event.trigger( "ajaxStart" );
+ }
+
+ // Uppercase the type
+ s.type = s.type.toUpperCase();
+
+ // Determine if request has content
+ s.hasContent = !rnoContent.test( s.type );
+
+ // Save the URL in case we're toying with the If-Modified-Since
+ // and/or If-None-Match header later on
+ // Remove hash to simplify url manipulation
+ cacheURL = s.url.replace( rhash, "" );
+
+ // More options handling for requests with no content
+ if ( !s.hasContent ) {
+
+ // Remember the hash so we can put it back
+ uncached = s.url.slice( cacheURL.length );
+
+ // If data is available, append data to url
+ if ( s.data ) {
+ cacheURL += ( rquery.test( cacheURL ) ? "&" : "?" ) + s.data;
+
+ // #9682: remove data so that it's not used in an eventual retry
+ delete s.data;
+ }
+
+ // Add or update anti-cache param if needed
+ if ( s.cache === false ) {
+ cacheURL = cacheURL.replace( rantiCache, "$1" );
+ uncached = ( rquery.test( cacheURL ) ? "&" : "?" ) + "_=" + ( nonce++ ) + uncached;
+ }
+
+ // Put hash and anti-cache on the URL that will be requested (gh-1732)
+ s.url = cacheURL + uncached;
+
+ // Change '%20' to '+' if this is encoded form body content (gh-2658)
+ } else if ( s.data && s.processData &&
+ ( s.contentType || "" ).indexOf( "application/x-www-form-urlencoded" ) === 0 ) {
+ s.data = s.data.replace( r20, "+" );
+ }
+
+ // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode.
+ if ( s.ifModified ) {
+ if ( jQuery.lastModified[ cacheURL ] ) {
+ jqXHR.setRequestHeader( "If-Modified-Since", jQuery.lastModified[ cacheURL ] );
+ }
+ if ( jQuery.etag[ cacheURL ] ) {
+ jqXHR.setRequestHeader( "If-None-Match", jQuery.etag[ cacheURL ] );
+ }
+ }
+
+ // Set the correct header, if data is being sent
+ if ( s.data && s.hasContent && s.contentType !== false || options.contentType ) {
+ jqXHR.setRequestHeader( "Content-Type", s.contentType );
+ }
+
+ // Set the Accepts header for the server, depending on the dataType
+ jqXHR.setRequestHeader(
+ "Accept",
+ s.dataTypes[ 0 ] && s.accepts[ s.dataTypes[ 0 ] ] ?
+ s.accepts[ s.dataTypes[ 0 ] ] +
+ ( s.dataTypes[ 0 ] !== "*" ? ", " + allTypes + "; q=0.01" : "" ) :
+ s.accepts[ "*" ]
+ );
+
+ // Check for headers option
+ for ( i in s.headers ) {
+ jqXHR.setRequestHeader( i, s.headers[ i ] );
+ }
+
+ // Allow custom headers/mimetypes and early abort
+ if ( s.beforeSend &&
+ ( s.beforeSend.call( callbackContext, jqXHR, s ) === false || completed ) ) {
+
+ // Abort if not done already and return
+ return jqXHR.abort();
+ }
+
+ // Aborting is no longer a cancellation
+ strAbort = "abort";
+
+ // Install callbacks on deferreds
+ completeDeferred.add( s.complete );
+ jqXHR.done( s.success );
+ jqXHR.fail( s.error );
+
+ // Get transport
+ transport = inspectPrefiltersOrTransports( transports, s, options, jqXHR );
+
+ // If no transport, we auto-abort
+ if ( !transport ) {
+ done( -1, "No Transport" );
+ } else {
+ jqXHR.readyState = 1;
+
+ // Send global event
+ if ( fireGlobals ) {
+ globalEventContext.trigger( "ajaxSend", [ jqXHR, s ] );
+ }
+
+ // If request was aborted inside ajaxSend, stop there
+ if ( completed ) {
+ return jqXHR;
+ }
+
+ // Timeout
+ if ( s.async && s.timeout > 0 ) {
+ timeoutTimer = window.setTimeout( function() {
+ jqXHR.abort( "timeout" );
+ }, s.timeout );
+ }
+
+ try {
+ completed = false;
+ transport.send( requestHeaders, done );
+ } catch ( e ) {
+
+ // Rethrow post-completion exceptions
+ if ( completed ) {
+ throw e;
+ }
+
+ // Propagate others as results
+ done( -1, e );
+ }
+ }
+
+ // Callback for when everything is done
+ function done( status, nativeStatusText, responses, headers ) {
+ var isSuccess, success, error, response, modified,
+ statusText = nativeStatusText;
+
+ // Ignore repeat invocations
+ if ( completed ) {
+ return;
+ }
+
+ completed = true;
+
+ // Clear timeout if it exists
+ if ( timeoutTimer ) {
+ window.clearTimeout( timeoutTimer );
+ }
+
+ // Dereference transport for early garbage collection
+ // (no matter how long the jqXHR object will be used)
+ transport = undefined;
+
+ // Cache response headers
+ responseHeadersString = headers || "";
+
+ // Set readyState
+ jqXHR.readyState = status > 0 ? 4 : 0;
+
+ // Determine if successful
+ isSuccess = status >= 200 && status < 300 || status === 304;
+
+ // Get response data
+ if ( responses ) {
+ response = ajaxHandleResponses( s, jqXHR, responses );
+ }
+
+ // Convert no matter what (that way responseXXX fields are always set)
+ response = ajaxConvert( s, response, jqXHR, isSuccess );
+
+ // If successful, handle type chaining
+ if ( isSuccess ) {
+
+ // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode.
+ if ( s.ifModified ) {
+ modified = jqXHR.getResponseHeader( "Last-Modified" );
+ if ( modified ) {
+ jQuery.lastModified[ cacheURL ] = modified;
+ }
+ modified = jqXHR.getResponseHeader( "etag" );
+ if ( modified ) {
+ jQuery.etag[ cacheURL ] = modified;
+ }
+ }
+
+ // if no content
+ if ( status === 204 || s.type === "HEAD" ) {
+ statusText = "nocontent";
+
+ // if not modified
+ } else if ( status === 304 ) {
+ statusText = "notmodified";
+
+ // If we have data, let's convert it
+ } else {
+ statusText = response.state;
+ success = response.data;
+ error = response.error;
+ isSuccess = !error;
+ }
+ } else {
+
+ // Extract error from statusText and normalize for non-aborts
+ error = statusText;
+ if ( status || !statusText ) {
+ statusText = "error";
+ if ( status < 0 ) {
+ status = 0;
+ }
+ }
+ }
+
+ // Set data for the fake xhr object
+ jqXHR.status = status;
+ jqXHR.statusText = ( nativeStatusText || statusText ) + "";
+
+ // Success/Error
+ if ( isSuccess ) {
+ deferred.resolveWith( callbackContext, [ success, statusText, jqXHR ] );
+ } else {
+ deferred.rejectWith( callbackContext, [ jqXHR, statusText, error ] );
+ }
+
+ // Status-dependent callbacks
+ jqXHR.statusCode( statusCode );
+ statusCode = undefined;
+
+ if ( fireGlobals ) {
+ globalEventContext.trigger( isSuccess ? "ajaxSuccess" : "ajaxError",
+ [ jqXHR, s, isSuccess ? success : error ] );
+ }
+
+ // Complete
+ completeDeferred.fireWith( callbackContext, [ jqXHR, statusText ] );
+
+ if ( fireGlobals ) {
+ globalEventContext.trigger( "ajaxComplete", [ jqXHR, s ] );
+
+ // Handle the global AJAX counter
+ if ( !( --jQuery.active ) ) {
+ jQuery.event.trigger( "ajaxStop" );
+ }
+ }
+ }
+
+ return jqXHR;
+ },
+
+ getJSON: function( url, data, callback ) {
+ return jQuery.get( url, data, callback, "json" );
+ },
+
+ getScript: function( url, callback ) {
+ return jQuery.get( url, undefined, callback, "script" );
+ }
+} );
+
+jQuery.each( [ "get", "post" ], function( i, method ) {
+ jQuery[ method ] = function( url, data, callback, type ) {
+
+ // Shift arguments if data argument was omitted
+ if ( jQuery.isFunction( data ) ) {
+ type = type || callback;
+ callback = data;
+ data = undefined;
+ }
+
+ // The url can be an options object (which then must have .url)
+ return jQuery.ajax( jQuery.extend( {
+ url: url,
+ type: method,
+ dataType: type,
+ data: data,
+ success: callback
+ }, jQuery.isPlainObject( url ) && url ) );
+ };
+} );
+
+
+jQuery._evalUrl = function( url ) {
+ return jQuery.ajax( {
+ url: url,
+
+ // Make this explicit, since user can override this through ajaxSetup (#11264)
+ type: "GET",
+ dataType: "script",
+ cache: true,
+ async: false,
+ global: false,
+ "throws": true
+ } );
+};
+
+
+jQuery.fn.extend( {
+ wrapAll: function( html ) {
+ var wrap;
+
+ if ( this[ 0 ] ) {
+ if ( jQuery.isFunction( html ) ) {
+ html = html.call( this[ 0 ] );
+ }
+
+ // The elements to wrap the target around
+ wrap = jQuery( html, this[ 0 ].ownerDocument ).eq( 0 ).clone( true );
+
+ if ( this[ 0 ].parentNode ) {
+ wrap.insertBefore( this[ 0 ] );
+ }
+
+ wrap.map( function() {
+ var elem = this;
+
+ while ( elem.firstElementChild ) {
+ elem = elem.firstElementChild;
+ }
+
+ return elem;
+ } ).append( this );
+ }
+
+ return this;
+ },
+
+ wrapInner: function( html ) {
+ if ( jQuery.isFunction( html ) ) {
+ return this.each( function( i ) {
+ jQuery( this ).wrapInner( html.call( this, i ) );
+ } );
+ }
+
+ return this.each( function() {
+ var self = jQuery( this ),
+ contents = self.contents();
+
+ if ( contents.length ) {
+ contents.wrapAll( html );
+
+ } else {
+ self.append( html );
+ }
+ } );
+ },
+
+ wrap: function( html ) {
+ var isFunction = jQuery.isFunction( html );
+
+ return this.each( function( i ) {
+ jQuery( this ).wrapAll( isFunction ? html.call( this, i ) : html );
+ } );
+ },
+
+ unwrap: function( selector ) {
+ this.parent( selector ).not( "body" ).each( function() {
+ jQuery( this ).replaceWith( this.childNodes );
+ } );
+ return this;
+ }
+} );
+
+
+jQuery.expr.pseudos.hidden = function( elem ) {
+ return !jQuery.expr.pseudos.visible( elem );
+};
+jQuery.expr.pseudos.visible = function( elem ) {
+ return !!( elem.offsetWidth || elem.offsetHeight || elem.getClientRects().length );
+};
+
+
+
+
+jQuery.ajaxSettings.xhr = function() {
+ try {
+ return new window.XMLHttpRequest();
+ } catch ( e ) {}
+};
+
+var xhrSuccessStatus = {
+
+ // File protocol always yields status code 0, assume 200
+ 0: 200,
+
+ // Support: IE <=9 only
+ // #1450: sometimes IE returns 1223 when it should be 204
+ 1223: 204
+ },
+ xhrSupported = jQuery.ajaxSettings.xhr();
+
+support.cors = !!xhrSupported && ( "withCredentials" in xhrSupported );
+support.ajax = xhrSupported = !!xhrSupported;
+
+jQuery.ajaxTransport( function( options ) {
+ var callback, errorCallback;
+
+ // Cross domain only allowed if supported through XMLHttpRequest
+ if ( support.cors || xhrSupported && !options.crossDomain ) {
+ return {
+ send: function( headers, complete ) {
+ var i,
+ xhr = options.xhr();
+
+ xhr.open(
+ options.type,
+ options.url,
+ options.async,
+ options.username,
+ options.password
+ );
+
+ // Apply custom fields if provided
+ if ( options.xhrFields ) {
+ for ( i in options.xhrFields ) {
+ xhr[ i ] = options.xhrFields[ i ];
+ }
+ }
+
+ // Override mime type if needed
+ if ( options.mimeType && xhr.overrideMimeType ) {
+ xhr.overrideMimeType( options.mimeType );
+ }
+
+ // X-Requested-With header
+ // For cross-domain requests, seeing as conditions for a preflight are
+ // akin to a jigsaw puzzle, we simply never set it to be sure.
+ // (it can always be set on a per-request basis or even using ajaxSetup)
+ // For same-domain requests, won't change header if already provided.
+ if ( !options.crossDomain && !headers[ "X-Requested-With" ] ) {
+ headers[ "X-Requested-With" ] = "XMLHttpRequest";
+ }
+
+ // Set headers
+ for ( i in headers ) {
+ xhr.setRequestHeader( i, headers[ i ] );
+ }
+
+ // Callback
+ callback = function( type ) {
+ return function() {
+ if ( callback ) {
+ callback = errorCallback = xhr.onload =
+ xhr.onerror = xhr.onabort = xhr.onreadystatechange = null;
+
+ if ( type === "abort" ) {
+ xhr.abort();
+ } else if ( type === "error" ) {
+
+ // Support: IE <=9 only
+ // On a manual native abort, IE9 throws
+ // errors on any property access that is not readyState
+ if ( typeof xhr.status !== "number" ) {
+ complete( 0, "error" );
+ } else {
+ complete(
+
+ // File: protocol always yields status 0; see #8605, #14207
+ xhr.status,
+ xhr.statusText
+ );
+ }
+ } else {
+ complete(
+ xhrSuccessStatus[ xhr.status ] || xhr.status,
+ xhr.statusText,
+
+ // Support: IE <=9 only
+ // IE9 has no XHR2 but throws on binary (trac-11426)
+ // For XHR2 non-text, let the caller handle it (gh-2498)
+ ( xhr.responseType || "text" ) !== "text" ||
+ typeof xhr.responseText !== "string" ?
+ { binary: xhr.response } :
+ { text: xhr.responseText },
+ xhr.getAllResponseHeaders()
+ );
+ }
+ }
+ };
+ };
+
+ // Listen to events
+ xhr.onload = callback();
+ errorCallback = xhr.onerror = callback( "error" );
+
+ // Support: IE 9 only
+ // Use onreadystatechange to replace onabort
+ // to handle uncaught aborts
+ if ( xhr.onabort !== undefined ) {
+ xhr.onabort = errorCallback;
+ } else {
+ xhr.onreadystatechange = function() {
+
+ // Check readyState before timeout as it changes
+ if ( xhr.readyState === 4 ) {
+
+ // Allow onerror to be called first,
+ // but that will not handle a native abort
+ // Also, save errorCallback to a variable
+ // as xhr.onerror cannot be accessed
+ window.setTimeout( function() {
+ if ( callback ) {
+ errorCallback();
+ }
+ } );
+ }
+ };
+ }
+
+ // Create the abort callback
+ callback = callback( "abort" );
+
+ try {
+
+ // Do send the request (this may raise an exception)
+ xhr.send( options.hasContent && options.data || null );
+ } catch ( e ) {
+
+ // #14683: Only rethrow if this hasn't been notified as an error yet
+ if ( callback ) {
+ throw e;
+ }
+ }
+ },
+
+ abort: function() {
+ if ( callback ) {
+ callback();
+ }
+ }
+ };
+ }
+} );
+
+
+
+
+// Prevent auto-execution of scripts when no explicit dataType was provided (See gh-2432)
+jQuery.ajaxPrefilter( function( s ) {
+ if ( s.crossDomain ) {
+ s.contents.script = false;
+ }
+} );
+
+// Install script dataType
+jQuery.ajaxSetup( {
+ accepts: {
+ script: "text/javascript, application/javascript, " +
+ "application/ecmascript, application/x-ecmascript"
+ },
+ contents: {
+ script: /\b(?:java|ecma)script\b/
+ },
+ converters: {
+ "text script": function( text ) {
+ jQuery.globalEval( text );
+ return text;
+ }
+ }
+} );
+
+// Handle cache's special case and crossDomain
+jQuery.ajaxPrefilter( "script", function( s ) {
+ if ( s.cache === undefined ) {
+ s.cache = false;
+ }
+ if ( s.crossDomain ) {
+ s.type = "GET";
+ }
+} );
+
+// Bind script tag hack transport
+jQuery.ajaxTransport( "script", function( s ) {
+
+ // This transport only deals with cross domain requests
+ if ( s.crossDomain ) {
+ var script, callback;
+ return {
+ send: function( _, complete ) {
+ script = jQuery( "<script>" ).prop( {
+ charset: s.scriptCharset,
+ src: s.url
+ } ).on(
+ "load error",
+ callback = function( evt ) {
+ script.remove();
+ callback = null;
+ if ( evt ) {
+ complete( evt.type === "error" ? 404 : 200, evt.type );
+ }
+ }
+ );
+
+ // Use native DOM manipulation to avoid our domManip AJAX trickery
+ document.head.appendChild( script[ 0 ] );
+ },
+ abort: function() {
+ if ( callback ) {
+ callback();
+ }
+ }
+ };
+ }
+} );
+
+
+
+
+var oldCallbacks = [],
+ rjsonp = /(=)\?(?=&|$)|\?\?/;
+
+// Default jsonp settings
+jQuery.ajaxSetup( {
+ jsonp: "callback",
+ jsonpCallback: function() {
+ var callback = oldCallbacks.pop() || ( jQuery.expando + "_" + ( nonce++ ) );
+ this[ callback ] = true;
+ return callback;
+ }
+} );
+
+// Detect, normalize options and install callbacks for jsonp requests
+jQuery.ajaxPrefilter( "json jsonp", function( s, originalSettings, jqXHR ) {
+
+ var callbackName, overwritten, responseContainer,
+ jsonProp = s.jsonp !== false && ( rjsonp.test( s.url ) ?
+ "url" :
+ typeof s.data === "string" &&
+ ( s.contentType || "" )
+ .indexOf( "application/x-www-form-urlencoded" ) === 0 &&
+ rjsonp.test( s.data ) && "data"
+ );
+
+ // Handle iff the expected data type is "jsonp" or we have a parameter to set
+ if ( jsonProp || s.dataTypes[ 0 ] === "jsonp" ) {
+
+ // Get callback name, remembering preexisting value associated with it
+ callbackName = s.jsonpCallback = jQuery.isFunction( s.jsonpCallback ) ?
+ s.jsonpCallback() :
+ s.jsonpCallback;
+
+ // Insert callback into url or form data
+ if ( jsonProp ) {
+ s[ jsonProp ] = s[ jsonProp ].replace( rjsonp, "$1" + callbackName );
+ } else if ( s.jsonp !== false ) {
+ s.url += ( rquery.test( s.url ) ? "&" : "?" ) + s.jsonp + "=" + callbackName;
+ }
+
+ // Use data converter to retrieve json after script execution
+ s.converters[ "script json" ] = function() {
+ if ( !responseContainer ) {
+ jQuery.error( callbackName + " was not called" );
+ }
+ return responseContainer[ 0 ];
+ };
+
+ // Force json dataType
+ s.dataTypes[ 0 ] = "json";
+
+ // Install callback
+ overwritten = window[ callbackName ];
+ window[ callbackName ] = function() {
+ responseContainer = arguments;
+ };
+
+ // Clean-up function (fires after converters)
+ jqXHR.always( function() {
+
+ // If previous value didn't exist - remove it
+ if ( overwritten === undefined ) {
+ jQuery( window ).removeProp( callbackName );
+
+ // Otherwise restore preexisting value
+ } else {
+ window[ callbackName ] = overwritten;
+ }
+
+ // Save back as free
+ if ( s[ callbackName ] ) {
+
+ // Make sure that re-using the options doesn't screw things around
+ s.jsonpCallback = originalSettings.jsonpCallback;
+
+ // Save the callback name for future use
+ oldCallbacks.push( callbackName );
+ }
+
+ // Call if it was a function and we have a response
+ if ( responseContainer && jQuery.isFunction( overwritten ) ) {
+ overwritten( responseContainer[ 0 ] );
+ }
+
+ responseContainer = overwritten = undefined;
+ } );
+
+ // Delegate to script
+ return "script";
+ }
+} );
+
+
+
+
+// Support: Safari 8 only
+// In Safari 8 documents created via document.implementation.createHTMLDocument
+// collapse sibling forms: the second one becomes a child of the first one.
+// Because of that, this security measure has to be disabled in Safari 8.
+// https://bugs.webkit.org/show_bug.cgi?id=137337
+support.createHTMLDocument = ( function() {
+ var body = document.implementation.createHTMLDocument( "" ).body;
+ body.innerHTML = "<form></form><form></form>";
+ return body.childNodes.length === 2;
+} )();
+
+
+// Argument "data" should be string of html
+// context (optional): If specified, the fragment will be created in this context,
+// defaults to document
+// keepScripts (optional): If true, will include scripts passed in the html string
+jQuery.parseHTML = function( data, context, keepScripts ) {
+ if ( typeof data !== "string" ) {
+ return [];
+ }
+ if ( typeof context === "boolean" ) {
+ keepScripts = context;
+ context = false;
+ }
+
+ var base, parsed, scripts;
+
+ if ( !context ) {
+
+ // Stop scripts or inline event handlers from being executed immediately
+ // by using document.implementation
+ if ( support.createHTMLDocument ) {
+ context = document.implementation.createHTMLDocument( "" );
+
+ // Set the base href for the created document
+ // so any parsed elements with URLs
+ // are based on the document's URL (gh-2965)
+ base = context.createElement( "base" );
+ base.href = document.location.href;
+ context.head.appendChild( base );
+ } else {
+ context = document;
+ }
+ }
+
+ parsed = rsingleTag.exec( data );
+ scripts = !keepScripts && [];
+
+ // Single tag
+ if ( parsed ) {
+ return [ context.createElement( parsed[ 1 ] ) ];
+ }
+
+ parsed = buildFragment( [ data ], context, scripts );
+
+ if ( scripts && scripts.length ) {
+ jQuery( scripts ).remove();
+ }
+
+ return jQuery.merge( [], parsed.childNodes );
+};
+
+
+/**
+ * Load a url into a page
+ */
+jQuery.fn.load = function( url, params, callback ) {
+ var selector, type, response,
+ self = this,
+ off = url.indexOf( " " );
+
+ if ( off > -1 ) {
+ selector = stripAndCollapse( url.slice( off ) );
+ url = url.slice( 0, off );
+ }
+
+ // If it's a function
+ if ( jQuery.isFunction( params ) ) {
+
+ // We assume that it's the callback
+ callback = params;
+ params = undefined;
+
+ // Otherwise, build a param string
+ } else if ( params && typeof params === "object" ) {
+ type = "POST";
+ }
+
+ // If we have elements to modify, make the request
+ if ( self.length > 0 ) {
+ jQuery.ajax( {
+ url: url,
+
+ // If "type" variable is undefined, then "GET" method will be used.
+ // Make value of this field explicit since
+ // user can override it through ajaxSetup method
+ type: type || "GET",
+ dataType: "html",
+ data: params
+ } ).done( function( responseText ) {
+
+ // Save response for use in complete callback
+ response = arguments;
+
+ self.html( selector ?
+
+ // If a selector was specified, locate the right elements in a dummy div
+ // Exclude scripts to avoid IE 'Permission Denied' errors
+ jQuery( "<div>" ).append( jQuery.parseHTML( responseText ) ).find( selector ) :
+
+ // Otherwise use the full result
+ responseText );
+
+ // If the request succeeds, this function gets "data", "status", "jqXHR"
+ // but they are ignored because response was set above.
+ // If it fails, this function gets "jqXHR", "status", "error"
+ } ).always( callback && function( jqXHR, status ) {
+ self.each( function() {
+ callback.apply( this, response || [ jqXHR.responseText, status, jqXHR ] );
+ } );
+ } );
+ }
+
+ return this;
+};
+
+
+
+
+// Attach a bunch of functions for handling common AJAX events
+jQuery.each( [
+ "ajaxStart",
+ "ajaxStop",
+ "ajaxComplete",
+ "ajaxError",
+ "ajaxSuccess",
+ "ajaxSend"
+], function( i, type ) {
+ jQuery.fn[ type ] = function( fn ) {
+ return this.on( type, fn );
+ };
+} );
+
+
+
+
+jQuery.expr.pseudos.animated = function( elem ) {
+ return jQuery.grep( jQuery.timers, function( fn ) {
+ return elem === fn.elem;
+ } ).length;
+};
+
+
+
+
+/**
+ * Gets a window from an element
+ */
+function getWindow( elem ) {
+ return jQuery.isWindow( elem ) ? elem : elem.nodeType === 9 && elem.defaultView;
+}
+
+jQuery.offset = {
+ setOffset: function( elem, options, i ) {
+ var curPosition, curLeft, curCSSTop, curTop, curOffset, curCSSLeft, calculatePosition,
+ position = jQuery.css( elem, "position" ),
+ curElem = jQuery( elem ),
+ props = {};
+
+ // Set position first, in-case top/left are set even on static elem
+ if ( position === "static" ) {
+ elem.style.position = "relative";
+ }
+
+ curOffset = curElem.offset();
+ curCSSTop = jQuery.css( elem, "top" );
+ curCSSLeft = jQuery.css( elem, "left" );
+ calculatePosition = ( position === "absolute" || position === "fixed" ) &&
+ ( curCSSTop + curCSSLeft ).indexOf( "auto" ) > -1;
+
+ // Need to be able to calculate position if either
+ // top or left is auto and position is either absolute or fixed
+ if ( calculatePosition ) {
+ curPosition = curElem.position();
+ curTop = curPosition.top;
+ curLeft = curPosition.left;
+
+ } else {
+ curTop = parseFloat( curCSSTop ) || 0;
+ curLeft = parseFloat( curCSSLeft ) || 0;
+ }
+
+ if ( jQuery.isFunction( options ) ) {
+
+ // Use jQuery.extend here to allow modification of coordinates argument (gh-1848)
+ options = options.call( elem, i, jQuery.extend( {}, curOffset ) );
+ }
+
+ if ( options.top != null ) {
+ props.top = ( options.top - curOffset.top ) + curTop;
+ }
+ if ( options.left != null ) {
+ props.left = ( options.left - curOffset.left ) + curLeft;
+ }
+
+ if ( "using" in options ) {
+ options.using.call( elem, props );
+
+ } else {
+ curElem.css( props );
+ }
+ }
+};
+
+jQuery.fn.extend( {
+ offset: function( options ) {
+
+ // Preserve chaining for setter
+ if ( arguments.length ) {
+ return options === undefined ?
+ this :
+ this.each( function( i ) {
+ jQuery.offset.setOffset( this, options, i );
+ } );
+ }
+
+ var docElem, win, rect, doc,
+ elem = this[ 0 ];
+
+ if ( !elem ) {
+ return;
+ }
+
+ // Support: IE <=11 only
+ // Running getBoundingClientRect on a
+ // disconnected node in IE throws an error
+ if ( !elem.getClientRects().length ) {
+ return { top: 0, left: 0 };
+ }
+
+ rect = elem.getBoundingClientRect();
+
+ // Make sure element is not hidden (display: none)
+ if ( rect.width || rect.height ) {
+ doc = elem.ownerDocument;
+ win = getWindow( doc );
+ docElem = doc.documentElement;
+
+ return {
+ top: rect.top + win.pageYOffset - docElem.clientTop,
+ left: rect.left + win.pageXOffset - docElem.clientLeft
+ };
+ }
+
+ // Return zeros for disconnected and hidden elements (gh-2310)
+ return rect;
+ },
+
+ position: function() {
+ if ( !this[ 0 ] ) {
+ return;
+ }
+
+ var offsetParent, offset,
+ elem = this[ 0 ],
+ parentOffset = { top: 0, left: 0 };
+
+ // Fixed elements are offset from window (parentOffset = {top:0, left: 0},
+ // because it is its only offset parent
+ if ( jQuery.css( elem, "position" ) === "fixed" ) {
+
+ // Assume getBoundingClientRect is there when computed position is fixed
+ offset = elem.getBoundingClientRect();
+
+ } else {
+
+ // Get *real* offsetParent
+ offsetParent = this.offsetParent();
+
+ // Get correct offsets
+ offset = this.offset();
+ if ( !jQuery.nodeName( offsetParent[ 0 ], "html" ) ) {
+ parentOffset = offsetParent.offset();
+ }
+
+ // Add offsetParent borders
+ parentOffset = {
+ top: parentOffset.top + jQuery.css( offsetParent[ 0 ], "borderTopWidth", true ),
+ left: parentOffset.left + jQuery.css( offsetParent[ 0 ], "borderLeftWidth", true )
+ };
+ }
+
+ // Subtract parent offsets and element margins
+ return {
+ top: offset.top - parentOffset.top - jQuery.css( elem, "marginTop", true ),
+ left: offset.left - parentOffset.left - jQuery.css( elem, "marginLeft", true )
+ };
+ },
+
+ // This method will return documentElement in the following cases:
+ // 1) For the element inside the iframe without offsetParent, this method will return
+ // documentElement of the parent window
+ // 2) For the hidden or detached element
+ // 3) For body or html element, i.e. in case of the html node - it will return itself
+ //
+ // but those exceptions were never presented as a real life use-cases
+ // and might be considered as more preferable results.
+ //
+ // This logic, however, is not guaranteed and can change at any point in the future
+ offsetParent: function() {
+ return this.map( function() {
+ var offsetParent = this.offsetParent;
+
+ while ( offsetParent && jQuery.css( offsetParent, "position" ) === "static" ) {
+ offsetParent = offsetParent.offsetParent;
+ }
+
+ return offsetParent || documentElement;
+ } );
+ }
+} );
+
+// Create scrollLeft and scrollTop methods
+jQuery.each( { scrollLeft: "pageXOffset", scrollTop: "pageYOffset" }, function( method, prop ) {
+ var top = "pageYOffset" === prop;
+
+ jQuery.fn[ method ] = function( val ) {
+ return access( this, function( elem, method, val ) {
+ var win = getWindow( elem );
+
+ if ( val === undefined ) {
+ return win ? win[ prop ] : elem[ method ];
+ }
+
+ if ( win ) {
+ win.scrollTo(
+ !top ? val : win.pageXOffset,
+ top ? val : win.pageYOffset
+ );
+
+ } else {
+ elem[ method ] = val;
+ }
+ }, method, val, arguments.length );
+ };
+} );
+
+// Support: Safari <=7 - 9.1, Chrome <=37 - 49
+// Add the top/left cssHooks using jQuery.fn.position
+// Webkit bug: https://bugs.webkit.org/show_bug.cgi?id=29084
+// Blink bug: https://bugs.chromium.org/p/chromium/issues/detail?id=589347
+// getComputedStyle returns percent when specified for top/left/bottom/right;
+// rather than make the css module depend on the offset module, just check for it here
+jQuery.each( [ "top", "left" ], function( i, prop ) {
+ jQuery.cssHooks[ prop ] = addGetHookIf( support.pixelPosition,
+ function( elem, computed ) {
+ if ( computed ) {
+ computed = curCSS( elem, prop );
+
+ // If curCSS returns percentage, fallback to offset
+ return rnumnonpx.test( computed ) ?
+ jQuery( elem ).position()[ prop ] + "px" :
+ computed;
+ }
+ }
+ );
+} );
+
+
+// Create innerHeight, innerWidth, height, width, outerHeight and outerWidth methods
+jQuery.each( { Height: "height", Width: "width" }, function( name, type ) {
+ jQuery.each( { padding: "inner" + name, content: type, "": "outer" + name },
+ function( defaultExtra, funcName ) {
+
+ // Margin is only for outerHeight, outerWidth
+ jQuery.fn[ funcName ] = function( margin, value ) {
+ var chainable = arguments.length && ( defaultExtra || typeof margin !== "boolean" ),
+ extra = defaultExtra || ( margin === true || value === true ? "margin" : "border" );
+
+ return access( this, function( elem, type, value ) {
+ var doc;
+
+ if ( jQuery.isWindow( elem ) ) {
+
+ // $( window ).outerWidth/Height return w/h including scrollbars (gh-1729)
+ return funcName.indexOf( "outer" ) === 0 ?
+ elem[ "inner" + name ] :
+ elem.document.documentElement[ "client" + name ];
+ }
+
+ // Get document width or height
+ if ( elem.nodeType === 9 ) {
+ doc = elem.documentElement;
+
+ // Either scroll[Width/Height] or offset[Width/Height] or client[Width/Height],
+ // whichever is greatest
+ return Math.max(
+ elem.body[ "scroll" + name ], doc[ "scroll" + name ],
+ elem.body[ "offset" + name ], doc[ "offset" + name ],
+ doc[ "client" + name ]
+ );
+ }
+
+ return value === undefined ?
+
+ // Get width or height on the element, requesting but not forcing parseFloat
+ jQuery.css( elem, type, extra ) :
+
+ // Set width or height on the element
+ jQuery.style( elem, type, value, extra );
+ }, type, chainable ? margin : undefined, chainable );
+ };
+ } );
+} );
+
+
+jQuery.fn.extend( {
+
+ bind: function( types, data, fn ) {
+ return this.on( types, null, data, fn );
+ },
+ unbind: function( types, fn ) {
+ return this.off( types, null, fn );
+ },
+
+ delegate: function( selector, types, data, fn ) {
+ return this.on( types, selector, data, fn );
+ },
+ undelegate: function( selector, types, fn ) {
+
+ // ( namespace ) or ( selector, types [, fn] )
+ return arguments.length === 1 ?
+ this.off( selector, "**" ) :
+ this.off( types, selector || "**", fn );
+ }
+} );
+
+jQuery.parseJSON = JSON.parse;
+
+
+
+
+// Register as a named AMD module, since jQuery can be concatenated with other
+// files that may use define, but not via a proper concatenation script that
+// understands anonymous AMD modules. A named AMD is safest and most robust
+// way to register. Lowercase jquery is used because AMD module names are
+// derived from file names, and jQuery is normally delivered in a lowercase
+// file name. Do this after creating the global so that if an AMD module wants
+// to call noConflict to hide this version of jQuery, it will work.
+
+// Note that for maximum portability, libraries that are not jQuery should
+// declare themselves as anonymous modules, and avoid setting a global if an
+// AMD loader is present. jQuery is a special case. For more information, see
+// https://github.com/jrburke/requirejs/wiki/Updating-existing-libraries#wiki-anon
+
+if ( typeof define === "function" && define.amd ) {
+ define( "jquery", [], function() {
+ return jQuery;
+ } );
+}
+
+
+
+
+var
+
+ // Map over jQuery in case of overwrite
+ _jQuery = window.jQuery,
+
+ // Map over the $ in case of overwrite
+ _$ = window.$;
+
+jQuery.noConflict = function( deep ) {
+ if ( window.$ === jQuery ) {
+ window.$ = _$;
+ }
+
+ if ( deep && window.jQuery === jQuery ) {
+ window.jQuery = _jQuery;
+ }
+
+ return jQuery;
+};
+
+// Expose jQuery and $ identifiers, even in AMD
+// (#7102#comment:10, https://github.com/jquery/jquery/pull/557)
+// and CommonJS for browser emulators (#13566)
+if ( !noGlobal ) {
+ window.jQuery = window.$ = jQuery;
+}
+
+
+
+
+return jQuery;
+} );
*
* Sphinx JavaScript utilities for the full-text search.
*
- * :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
}
// stem the word
var word = stemmer.stemWord(tmp[i].toLowerCase());
- // prevent stemmer from cutting word smaller than two chars
- if(word.length < 3 && tmp[i].length >= 3) {
- word = tmp[i];
- }
var toAppend;
// select the correct list
if (word[0] == '-') {
displayNextItem();
});
} else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) {
- var suffix = DOCUMENTATION_OPTIONS.SOURCELINK_SUFFIX;
- if (suffix === undefined) {
- suffix = '.txt';
- }
- $.ajax({url: DOCUMENTATION_OPTIONS.URL_ROOT + '_sources/' + item[5] + (item[5].slice(-suffix.length) === suffix ? '' : suffix),
+ $.ajax({url: DOCUMENTATION_OPTIONS.URL_ROOT + '_sources/' + item[0] + '.txt',
dataType: "text",
complete: function(jqxhr, textstatus) {
var data = jqxhr.responseText;
*/
performObjectSearch : function(object, otherterms) {
var filenames = this._index.filenames;
- var docnames = this._index.docnames;
var objects = this._index.objects;
var objnames = this._index.objnames;
var titles = this._index.titles;
} else {
score += Scorer.objPrioDefault;
}
- results.push([docnames[match[0]], fullname, '#'+anchor, descr, score, filenames[match[0]]]);
+ results.push([filenames[match[0]], fullname, '#'+anchor, descr, score]);
}
}
}
* search for full-text terms in the index
*/
performTermsSearch : function(searchterms, excluded, terms, titleterms) {
- var docnames = this._index.docnames;
var filenames = this._index.filenames;
var titles = this._index.titles;
// select one (max) score for the file.
// for better ranking, we should calculate ranking by using words statistics like basic tf-idf...
var score = $u.max($u.map(fileMap[file], function(w){return scoreMap[file][w]}));
- results.push([docnames[file], titles[file], '', null, score, filenames[file]]);
+ results.push([filenames[file], titles[file], '', null, score]);
}
}
return results;
+++ /dev/null
-// Underscore.js 1.3.1
-// (c) 2009-2012 Jeremy Ashkenas, DocumentCloud Inc.
-// Underscore is freely distributable under the MIT license.
-// Portions of Underscore are inspired or borrowed from Prototype,
-// Oliver Steele's Functional, and John Resig's Micro-Templating.
-// For all details and documentation:
-// http://documentcloud.github.com/underscore
-
-(function() {
-
- // Baseline setup
- // --------------
-
- // Establish the root object, `window` in the browser, or `global` on the server.
- var root = this;
-
- // Save the previous value of the `_` variable.
- var previousUnderscore = root._;
-
- // Establish the object that gets returned to break out of a loop iteration.
- var breaker = {};
-
- // Save bytes in the minified (but not gzipped) version:
- var ArrayProto = Array.prototype, ObjProto = Object.prototype, FuncProto = Function.prototype;
-
- // Create quick reference variables for speed access to core prototypes.
- var slice = ArrayProto.slice,
- unshift = ArrayProto.unshift,
- toString = ObjProto.toString,
- hasOwnProperty = ObjProto.hasOwnProperty;
-
- // All **ECMAScript 5** native function implementations that we hope to use
- // are declared here.
- var
- nativeForEach = ArrayProto.forEach,
- nativeMap = ArrayProto.map,
- nativeReduce = ArrayProto.reduce,
- nativeReduceRight = ArrayProto.reduceRight,
- nativeFilter = ArrayProto.filter,
- nativeEvery = ArrayProto.every,
- nativeSome = ArrayProto.some,
- nativeIndexOf = ArrayProto.indexOf,
- nativeLastIndexOf = ArrayProto.lastIndexOf,
- nativeIsArray = Array.isArray,
- nativeKeys = Object.keys,
- nativeBind = FuncProto.bind;
-
- // Create a safe reference to the Underscore object for use below.
- var _ = function(obj) { return new wrapper(obj); };
-
- // Export the Underscore object for **Node.js**, with
- // backwards-compatibility for the old `require()` API. If we're in
- // the browser, add `_` as a global object via a string identifier,
- // for Closure Compiler "advanced" mode.
- if (typeof exports !== 'undefined') {
- if (typeof module !== 'undefined' && module.exports) {
- exports = module.exports = _;
- }
- exports._ = _;
- } else {
- root['_'] = _;
- }
-
- // Current version.
- _.VERSION = '1.3.1';
-
- // Collection Functions
- // --------------------
-
- // The cornerstone, an `each` implementation, aka `forEach`.
- // Handles objects with the built-in `forEach`, arrays, and raw objects.
- // Delegates to **ECMAScript 5**'s native `forEach` if available.
- var each = _.each = _.forEach = function(obj, iterator, context) {
- if (obj == null) return;
- if (nativeForEach && obj.forEach === nativeForEach) {
- obj.forEach(iterator, context);
- } else if (obj.length === +obj.length) {
- for (var i = 0, l = obj.length; i < l; i++) {
- if (i in obj && iterator.call(context, obj[i], i, obj) === breaker) return;
- }
- } else {
- for (var key in obj) {
- if (_.has(obj, key)) {
- if (iterator.call(context, obj[key], key, obj) === breaker) return;
- }
- }
- }
- };
-
- // Return the results of applying the iterator to each element.
- // Delegates to **ECMAScript 5**'s native `map` if available.
- _.map = _.collect = function(obj, iterator, context) {
- var results = [];
- if (obj == null) return results;
- if (nativeMap && obj.map === nativeMap) return obj.map(iterator, context);
- each(obj, function(value, index, list) {
- results[results.length] = iterator.call(context, value, index, list);
- });
- if (obj.length === +obj.length) results.length = obj.length;
- return results;
- };
-
- // **Reduce** builds up a single result from a list of values, aka `inject`,
- // or `foldl`. Delegates to **ECMAScript 5**'s native `reduce` if available.
- _.reduce = _.foldl = _.inject = function(obj, iterator, memo, context) {
- var initial = arguments.length > 2;
- if (obj == null) obj = [];
- if (nativeReduce && obj.reduce === nativeReduce) {
- if (context) iterator = _.bind(iterator, context);
- return initial ? obj.reduce(iterator, memo) : obj.reduce(iterator);
- }
- each(obj, function(value, index, list) {
- if (!initial) {
- memo = value;
- initial = true;
- } else {
- memo = iterator.call(context, memo, value, index, list);
- }
- });
- if (!initial) throw new TypeError('Reduce of empty array with no initial value');
- return memo;
- };
-
- // The right-associative version of reduce, also known as `foldr`.
- // Delegates to **ECMAScript 5**'s native `reduceRight` if available.
- _.reduceRight = _.foldr = function(obj, iterator, memo, context) {
- var initial = arguments.length > 2;
- if (obj == null) obj = [];
- if (nativeReduceRight && obj.reduceRight === nativeReduceRight) {
- if (context) iterator = _.bind(iterator, context);
- return initial ? obj.reduceRight(iterator, memo) : obj.reduceRight(iterator);
- }
- var reversed = _.toArray(obj).reverse();
- if (context && !initial) iterator = _.bind(iterator, context);
- return initial ? _.reduce(reversed, iterator, memo, context) : _.reduce(reversed, iterator);
- };
-
- // Return the first value which passes a truth test. Aliased as `detect`.
- _.find = _.detect = function(obj, iterator, context) {
- var result;
- any(obj, function(value, index, list) {
- if (iterator.call(context, value, index, list)) {
- result = value;
- return true;
- }
- });
- return result;
- };
-
- // Return all the elements that pass a truth test.
- // Delegates to **ECMAScript 5**'s native `filter` if available.
- // Aliased as `select`.
- _.filter = _.select = function(obj, iterator, context) {
- var results = [];
- if (obj == null) return results;
- if (nativeFilter && obj.filter === nativeFilter) return obj.filter(iterator, context);
- each(obj, function(value, index, list) {
- if (iterator.call(context, value, index, list)) results[results.length] = value;
- });
- return results;
- };
-
- // Return all the elements for which a truth test fails.
- _.reject = function(obj, iterator, context) {
- var results = [];
- if (obj == null) return results;
- each(obj, function(value, index, list) {
- if (!iterator.call(context, value, index, list)) results[results.length] = value;
- });
- return results;
- };
-
- // Determine whether all of the elements match a truth test.
- // Delegates to **ECMAScript 5**'s native `every` if available.
- // Aliased as `all`.
- _.every = _.all = function(obj, iterator, context) {
- var result = true;
- if (obj == null) return result;
- if (nativeEvery && obj.every === nativeEvery) return obj.every(iterator, context);
- each(obj, function(value, index, list) {
- if (!(result = result && iterator.call(context, value, index, list))) return breaker;
- });
- return result;
- };
-
- // Determine if at least one element in the object matches a truth test.
- // Delegates to **ECMAScript 5**'s native `some` if available.
- // Aliased as `any`.
- var any = _.some = _.any = function(obj, iterator, context) {
- iterator || (iterator = _.identity);
- var result = false;
- if (obj == null) return result;
- if (nativeSome && obj.some === nativeSome) return obj.some(iterator, context);
- each(obj, function(value, index, list) {
- if (result || (result = iterator.call(context, value, index, list))) return breaker;
- });
- return !!result;
- };
-
- // Determine if a given value is included in the array or object using `===`.
- // Aliased as `contains`.
- _.include = _.contains = function(obj, target) {
- var found = false;
- if (obj == null) return found;
- if (nativeIndexOf && obj.indexOf === nativeIndexOf) return obj.indexOf(target) != -1;
- found = any(obj, function(value) {
- return value === target;
- });
- return found;
- };
-
- // Invoke a method (with arguments) on every item in a collection.
- _.invoke = function(obj, method) {
- var args = slice.call(arguments, 2);
- return _.map(obj, function(value) {
- return (_.isFunction(method) ? method || value : value[method]).apply(value, args);
- });
- };
-
- // Convenience version of a common use case of `map`: fetching a property.
- _.pluck = function(obj, key) {
- return _.map(obj, function(value){ return value[key]; });
- };
-
- // Return the maximum element or (element-based computation).
- _.max = function(obj, iterator, context) {
- if (!iterator && _.isArray(obj)) return Math.max.apply(Math, obj);
- if (!iterator && _.isEmpty(obj)) return -Infinity;
- var result = {computed : -Infinity};
- each(obj, function(value, index, list) {
- var computed = iterator ? iterator.call(context, value, index, list) : value;
- computed >= result.computed && (result = {value : value, computed : computed});
- });
- return result.value;
- };
-
- // Return the minimum element (or element-based computation).
- _.min = function(obj, iterator, context) {
- if (!iterator && _.isArray(obj)) return Math.min.apply(Math, obj);
- if (!iterator && _.isEmpty(obj)) return Infinity;
- var result = {computed : Infinity};
- each(obj, function(value, index, list) {
- var computed = iterator ? iterator.call(context, value, index, list) : value;
- computed < result.computed && (result = {value : value, computed : computed});
- });
- return result.value;
- };
-
- // Shuffle an array.
- _.shuffle = function(obj) {
- var shuffled = [], rand;
- each(obj, function(value, index, list) {
- if (index == 0) {
- shuffled[0] = value;
- } else {
- rand = Math.floor(Math.random() * (index + 1));
- shuffled[index] = shuffled[rand];
- shuffled[rand] = value;
- }
- });
- return shuffled;
- };
-
- // Sort the object's values by a criterion produced by an iterator.
- _.sortBy = function(obj, iterator, context) {
- return _.pluck(_.map(obj, function(value, index, list) {
- return {
- value : value,
- criteria : iterator.call(context, value, index, list)
- };
- }).sort(function(left, right) {
- var a = left.criteria, b = right.criteria;
- return a < b ? -1 : a > b ? 1 : 0;
- }), 'value');
- };
-
- // Groups the object's values by a criterion. Pass either a string attribute
- // to group by, or a function that returns the criterion.
- _.groupBy = function(obj, val) {
- var result = {};
- var iterator = _.isFunction(val) ? val : function(obj) { return obj[val]; };
- each(obj, function(value, index) {
- var key = iterator(value, index);
- (result[key] || (result[key] = [])).push(value);
- });
- return result;
- };
-
- // Use a comparator function to figure out at what index an object should
- // be inserted so as to maintain order. Uses binary search.
- _.sortedIndex = function(array, obj, iterator) {
- iterator || (iterator = _.identity);
- var low = 0, high = array.length;
- while (low < high) {
- var mid = (low + high) >> 1;
- iterator(array[mid]) < iterator(obj) ? low = mid + 1 : high = mid;
- }
- return low;
- };
-
- // Safely convert anything iterable into a real, live array.
- _.toArray = function(iterable) {
- if (!iterable) return [];
- if (iterable.toArray) return iterable.toArray();
- if (_.isArray(iterable)) return slice.call(iterable);
- if (_.isArguments(iterable)) return slice.call(iterable);
- return _.values(iterable);
- };
-
- // Return the number of elements in an object.
- _.size = function(obj) {
- return _.toArray(obj).length;
- };
-
- // Array Functions
- // ---------------
-
- // Get the first element of an array. Passing **n** will return the first N
- // values in the array. Aliased as `head`. The **guard** check allows it to work
- // with `_.map`.
- _.first = _.head = function(array, n, guard) {
- return (n != null) && !guard ? slice.call(array, 0, n) : array[0];
- };
-
- // Returns everything but the last entry of the array. Especcialy useful on
- // the arguments object. Passing **n** will return all the values in
- // the array, excluding the last N. The **guard** check allows it to work with
- // `_.map`.
- _.initial = function(array, n, guard) {
- return slice.call(array, 0, array.length - ((n == null) || guard ? 1 : n));
- };
-
- // Get the last element of an array. Passing **n** will return the last N
- // values in the array. The **guard** check allows it to work with `_.map`.
- _.last = function(array, n, guard) {
- if ((n != null) && !guard) {
- return slice.call(array, Math.max(array.length - n, 0));
- } else {
- return array[array.length - 1];
- }
- };
-
- // Returns everything but the first entry of the array. Aliased as `tail`.
- // Especially useful on the arguments object. Passing an **index** will return
- // the rest of the values in the array from that index onward. The **guard**
- // check allows it to work with `_.map`.
- _.rest = _.tail = function(array, index, guard) {
- return slice.call(array, (index == null) || guard ? 1 : index);
- };
-
- // Trim out all falsy values from an array.
- _.compact = function(array) {
- return _.filter(array, function(value){ return !!value; });
- };
-
- // Return a completely flattened version of an array.
- _.flatten = function(array, shallow) {
- return _.reduce(array, function(memo, value) {
- if (_.isArray(value)) return memo.concat(shallow ? value : _.flatten(value));
- memo[memo.length] = value;
- return memo;
- }, []);
- };
-
- // Return a version of the array that does not contain the specified value(s).
- _.without = function(array) {
- return _.difference(array, slice.call(arguments, 1));
- };
-
- // Produce a duplicate-free version of the array. If the array has already
- // been sorted, you have the option of using a faster algorithm.
- // Aliased as `unique`.
- _.uniq = _.unique = function(array, isSorted, iterator) {
- var initial = iterator ? _.map(array, iterator) : array;
- var result = [];
- _.reduce(initial, function(memo, el, i) {
- if (0 == i || (isSorted === true ? _.last(memo) != el : !_.include(memo, el))) {
- memo[memo.length] = el;
- result[result.length] = array[i];
- }
- return memo;
- }, []);
- return result;
- };
-
- // Produce an array that contains the union: each distinct element from all of
- // the passed-in arrays.
- _.union = function() {
- return _.uniq(_.flatten(arguments, true));
- };
-
- // Produce an array that contains every item shared between all the
- // passed-in arrays. (Aliased as "intersect" for back-compat.)
- _.intersection = _.intersect = function(array) {
- var rest = slice.call(arguments, 1);
- return _.filter(_.uniq(array), function(item) {
- return _.every(rest, function(other) {
- return _.indexOf(other, item) >= 0;
- });
- });
- };
-
- // Take the difference between one array and a number of other arrays.
- // Only the elements present in just the first array will remain.
- _.difference = function(array) {
- var rest = _.flatten(slice.call(arguments, 1));
- return _.filter(array, function(value){ return !_.include(rest, value); });
- };
-
- // Zip together multiple lists into a single array -- elements that share
- // an index go together.
- _.zip = function() {
- var args = slice.call(arguments);
- var length = _.max(_.pluck(args, 'length'));
- var results = new Array(length);
- for (var i = 0; i < length; i++) results[i] = _.pluck(args, "" + i);
- return results;
- };
-
- // If the browser doesn't supply us with indexOf (I'm looking at you, **MSIE**),
- // we need this function. Return the position of the first occurrence of an
- // item in an array, or -1 if the item is not included in the array.
- // Delegates to **ECMAScript 5**'s native `indexOf` if available.
- // If the array is large and already in sort order, pass `true`
- // for **isSorted** to use binary search.
- _.indexOf = function(array, item, isSorted) {
- if (array == null) return -1;
- var i, l;
- if (isSorted) {
- i = _.sortedIndex(array, item);
- return array[i] === item ? i : -1;
- }
- if (nativeIndexOf && array.indexOf === nativeIndexOf) return array.indexOf(item);
- for (i = 0, l = array.length; i < l; i++) if (i in array && array[i] === item) return i;
- return -1;
- };
-
- // Delegates to **ECMAScript 5**'s native `lastIndexOf` if available.
- _.lastIndexOf = function(array, item) {
- if (array == null) return -1;
- if (nativeLastIndexOf && array.lastIndexOf === nativeLastIndexOf) return array.lastIndexOf(item);
- var i = array.length;
- while (i--) if (i in array && array[i] === item) return i;
- return -1;
- };
-
- // Generate an integer Array containing an arithmetic progression. A port of
- // the native Python `range()` function. See
- // [the Python documentation](http://docs.python.org/library/functions.html#range).
- _.range = function(start, stop, step) {
- if (arguments.length <= 1) {
- stop = start || 0;
- start = 0;
- }
- step = arguments[2] || 1;
-
- var len = Math.max(Math.ceil((stop - start) / step), 0);
- var idx = 0;
- var range = new Array(len);
-
- while(idx < len) {
- range[idx++] = start;
- start += step;
- }
-
- return range;
- };
-
- // Function (ahem) Functions
- // ------------------
-
- // Reusable constructor function for prototype setting.
- var ctor = function(){};
-
- // Create a function bound to a given object (assigning `this`, and arguments,
- // optionally). Binding with arguments is also known as `curry`.
- // Delegates to **ECMAScript 5**'s native `Function.bind` if available.
- // We check for `func.bind` first, to fail fast when `func` is undefined.
- _.bind = function bind(func, context) {
- var bound, args;
- if (func.bind === nativeBind && nativeBind) return nativeBind.apply(func, slice.call(arguments, 1));
- if (!_.isFunction(func)) throw new TypeError;
- args = slice.call(arguments, 2);
- return bound = function() {
- if (!(this instanceof bound)) return func.apply(context, args.concat(slice.call(arguments)));
- ctor.prototype = func.prototype;
- var self = new ctor;
- var result = func.apply(self, args.concat(slice.call(arguments)));
- if (Object(result) === result) return result;
- return self;
- };
- };
-
- // Bind all of an object's methods to that object. Useful for ensuring that
- // all callbacks defined on an object belong to it.
- _.bindAll = function(obj) {
- var funcs = slice.call(arguments, 1);
- if (funcs.length == 0) funcs = _.functions(obj);
- each(funcs, function(f) { obj[f] = _.bind(obj[f], obj); });
- return obj;
- };
-
- // Memoize an expensive function by storing its results.
- _.memoize = function(func, hasher) {
- var memo = {};
- hasher || (hasher = _.identity);
- return function() {
- var key = hasher.apply(this, arguments);
- return _.has(memo, key) ? memo[key] : (memo[key] = func.apply(this, arguments));
- };
- };
-
- // Delays a function for the given number of milliseconds, and then calls
- // it with the arguments supplied.
- _.delay = function(func, wait) {
- var args = slice.call(arguments, 2);
- return setTimeout(function(){ return func.apply(func, args); }, wait);
- };
-
- // Defers a function, scheduling it to run after the current call stack has
- // cleared.
- _.defer = function(func) {
- return _.delay.apply(_, [func, 1].concat(slice.call(arguments, 1)));
- };
-
- // Returns a function, that, when invoked, will only be triggered at most once
- // during a given window of time.
- _.throttle = function(func, wait) {
- var context, args, timeout, throttling, more;
- var whenDone = _.debounce(function(){ more = throttling = false; }, wait);
- return function() {
- context = this; args = arguments;
- var later = function() {
- timeout = null;
- if (more) func.apply(context, args);
- whenDone();
- };
- if (!timeout) timeout = setTimeout(later, wait);
- if (throttling) {
- more = true;
- } else {
- func.apply(context, args);
- }
- whenDone();
- throttling = true;
- };
- };
-
- // Returns a function, that, as long as it continues to be invoked, will not
- // be triggered. The function will be called after it stops being called for
- // N milliseconds.
- _.debounce = function(func, wait) {
- var timeout;
- return function() {
- var context = this, args = arguments;
- var later = function() {
- timeout = null;
- func.apply(context, args);
- };
- clearTimeout(timeout);
- timeout = setTimeout(later, wait);
- };
- };
-
- // Returns a function that will be executed at most one time, no matter how
- // often you call it. Useful for lazy initialization.
- _.once = function(func) {
- var ran = false, memo;
- return function() {
- if (ran) return memo;
- ran = true;
- return memo = func.apply(this, arguments);
- };
- };
-
- // Returns the first function passed as an argument to the second,
- // allowing you to adjust arguments, run code before and after, and
- // conditionally execute the original function.
- _.wrap = function(func, wrapper) {
- return function() {
- var args = [func].concat(slice.call(arguments, 0));
- return wrapper.apply(this, args);
- };
- };
-
- // Returns a function that is the composition of a list of functions, each
- // consuming the return value of the function that follows.
- _.compose = function() {
- var funcs = arguments;
- return function() {
- var args = arguments;
- for (var i = funcs.length - 1; i >= 0; i--) {
- args = [funcs[i].apply(this, args)];
- }
- return args[0];
- };
- };
-
- // Returns a function that will only be executed after being called N times.
- _.after = function(times, func) {
- if (times <= 0) return func();
- return function() {
- if (--times < 1) { return func.apply(this, arguments); }
- };
- };
-
- // Object Functions
- // ----------------
-
- // Retrieve the names of an object's properties.
- // Delegates to **ECMAScript 5**'s native `Object.keys`
- _.keys = nativeKeys || function(obj) {
- if (obj !== Object(obj)) throw new TypeError('Invalid object');
- var keys = [];
- for (var key in obj) if (_.has(obj, key)) keys[keys.length] = key;
- return keys;
- };
-
- // Retrieve the values of an object's properties.
- _.values = function(obj) {
- return _.map(obj, _.identity);
- };
-
- // Return a sorted list of the function names available on the object.
- // Aliased as `methods`
- _.functions = _.methods = function(obj) {
- var names = [];
- for (var key in obj) {
- if (_.isFunction(obj[key])) names.push(key);
- }
- return names.sort();
- };
-
- // Extend a given object with all the properties in passed-in object(s).
- _.extend = function(obj) {
- each(slice.call(arguments, 1), function(source) {
- for (var prop in source) {
- obj[prop] = source[prop];
- }
- });
- return obj;
- };
-
- // Fill in a given object with default properties.
- _.defaults = function(obj) {
- each(slice.call(arguments, 1), function(source) {
- for (var prop in source) {
- if (obj[prop] == null) obj[prop] = source[prop];
- }
- });
- return obj;
- };
-
- // Create a (shallow-cloned) duplicate of an object.
- _.clone = function(obj) {
- if (!_.isObject(obj)) return obj;
- return _.isArray(obj) ? obj.slice() : _.extend({}, obj);
- };
-
- // Invokes interceptor with the obj, and then returns obj.
- // The primary purpose of this method is to "tap into" a method chain, in
- // order to perform operations on intermediate results within the chain.
- _.tap = function(obj, interceptor) {
- interceptor(obj);
- return obj;
- };
-
- // Internal recursive comparison function.
- function eq(a, b, stack) {
- // Identical objects are equal. `0 === -0`, but they aren't identical.
- // See the Harmony `egal` proposal: http://wiki.ecmascript.org/doku.php?id=harmony:egal.
- if (a === b) return a !== 0 || 1 / a == 1 / b;
- // A strict comparison is necessary because `null == undefined`.
- if (a == null || b == null) return a === b;
- // Unwrap any wrapped objects.
- if (a._chain) a = a._wrapped;
- if (b._chain) b = b._wrapped;
- // Invoke a custom `isEqual` method if one is provided.
- if (a.isEqual && _.isFunction(a.isEqual)) return a.isEqual(b);
- if (b.isEqual && _.isFunction(b.isEqual)) return b.isEqual(a);
- // Compare `[[Class]]` names.
- var className = toString.call(a);
- if (className != toString.call(b)) return false;
- switch (className) {
- // Strings, numbers, dates, and booleans are compared by value.
- case '[object String]':
- // Primitives and their corresponding object wrappers are equivalent; thus, `"5"` is
- // equivalent to `new String("5")`.
- return a == String(b);
- case '[object Number]':
- // `NaN`s are equivalent, but non-reflexive. An `egal` comparison is performed for
- // other numeric values.
- return a != +a ? b != +b : (a == 0 ? 1 / a == 1 / b : a == +b);
- case '[object Date]':
- case '[object Boolean]':
- // Coerce dates and booleans to numeric primitive values. Dates are compared by their
- // millisecond representations. Note that invalid dates with millisecond representations
- // of `NaN` are not equivalent.
- return +a == +b;
- // RegExps are compared by their source patterns and flags.
- case '[object RegExp]':
- return a.source == b.source &&
- a.global == b.global &&
- a.multiline == b.multiline &&
- a.ignoreCase == b.ignoreCase;
- }
- if (typeof a != 'object' || typeof b != 'object') return false;
- // Assume equality for cyclic structures. The algorithm for detecting cyclic
- // structures is adapted from ES 5.1 section 15.12.3, abstract operation `JO`.
- var length = stack.length;
- while (length--) {
- // Linear search. Performance is inversely proportional to the number of
- // unique nested structures.
- if (stack[length] == a) return true;
- }
- // Add the first object to the stack of traversed objects.
- stack.push(a);
- var size = 0, result = true;
- // Recursively compare objects and arrays.
- if (className == '[object Array]') {
- // Compare array lengths to determine if a deep comparison is necessary.
- size = a.length;
- result = size == b.length;
- if (result) {
- // Deep compare the contents, ignoring non-numeric properties.
- while (size--) {
- // Ensure commutative equality for sparse arrays.
- if (!(result = size in a == size in b && eq(a[size], b[size], stack))) break;
- }
- }
- } else {
- // Objects with different constructors are not equivalent.
- if ('constructor' in a != 'constructor' in b || a.constructor != b.constructor) return false;
- // Deep compare objects.
- for (var key in a) {
- if (_.has(a, key)) {
- // Count the expected number of properties.
- size++;
- // Deep compare each member.
- if (!(result = _.has(b, key) && eq(a[key], b[key], stack))) break;
- }
- }
- // Ensure that both objects contain the same number of properties.
- if (result) {
- for (key in b) {
- if (_.has(b, key) && !(size--)) break;
- }
- result = !size;
- }
- }
- // Remove the first object from the stack of traversed objects.
- stack.pop();
- return result;
- }
-
- // Perform a deep comparison to check if two objects are equal.
- _.isEqual = function(a, b) {
- return eq(a, b, []);
- };
-
- // Is a given array, string, or object empty?
- // An "empty" object has no enumerable own-properties.
- _.isEmpty = function(obj) {
- if (_.isArray(obj) || _.isString(obj)) return obj.length === 0;
- for (var key in obj) if (_.has(obj, key)) return false;
- return true;
- };
-
- // Is a given value a DOM element?
- _.isElement = function(obj) {
- return !!(obj && obj.nodeType == 1);
- };
-
- // Is a given value an array?
- // Delegates to ECMA5's native Array.isArray
- _.isArray = nativeIsArray || function(obj) {
- return toString.call(obj) == '[object Array]';
- };
-
- // Is a given variable an object?
- _.isObject = function(obj) {
- return obj === Object(obj);
- };
-
- // Is a given variable an arguments object?
- _.isArguments = function(obj) {
- return toString.call(obj) == '[object Arguments]';
- };
- if (!_.isArguments(arguments)) {
- _.isArguments = function(obj) {
- return !!(obj && _.has(obj, 'callee'));
- };
- }
-
- // Is a given value a function?
- _.isFunction = function(obj) {
- return toString.call(obj) == '[object Function]';
- };
-
- // Is a given value a string?
- _.isString = function(obj) {
- return toString.call(obj) == '[object String]';
- };
-
- // Is a given value a number?
- _.isNumber = function(obj) {
- return toString.call(obj) == '[object Number]';
- };
-
- // Is the given value `NaN`?
- _.isNaN = function(obj) {
- // `NaN` is the only value for which `===` is not reflexive.
- return obj !== obj;
- };
-
- // Is a given value a boolean?
- _.isBoolean = function(obj) {
- return obj === true || obj === false || toString.call(obj) == '[object Boolean]';
- };
-
- // Is a given value a date?
- _.isDate = function(obj) {
- return toString.call(obj) == '[object Date]';
- };
-
- // Is the given value a regular expression?
- _.isRegExp = function(obj) {
- return toString.call(obj) == '[object RegExp]';
- };
-
- // Is a given value equal to null?
- _.isNull = function(obj) {
- return obj === null;
- };
-
- // Is a given variable undefined?
- _.isUndefined = function(obj) {
- return obj === void 0;
- };
-
- // Has own property?
- _.has = function(obj, key) {
- return hasOwnProperty.call(obj, key);
- };
-
- // Utility Functions
- // -----------------
-
- // Run Underscore.js in *noConflict* mode, returning the `_` variable to its
- // previous owner. Returns a reference to the Underscore object.
- _.noConflict = function() {
- root._ = previousUnderscore;
- return this;
- };
-
- // Keep the identity function around for default iterators.
- _.identity = function(value) {
- return value;
- };
-
- // Run a function **n** times.
- _.times = function (n, iterator, context) {
- for (var i = 0; i < n; i++) iterator.call(context, i);
- };
-
- // Escape a string for HTML interpolation.
- _.escape = function(string) {
- return (''+string).replace(/&/g, '&').replace(/</g, '<').replace(/>/g, '>').replace(/"/g, '"').replace(/'/g, ''').replace(/\//g,'/');
- };
-
- // Add your own custom functions to the Underscore object, ensuring that
- // they're correctly added to the OOP wrapper as well.
- _.mixin = function(obj) {
- each(_.functions(obj), function(name){
- addToWrapper(name, _[name] = obj[name]);
- });
- };
-
- // Generate a unique integer id (unique within the entire client session).
- // Useful for temporary DOM ids.
- var idCounter = 0;
- _.uniqueId = function(prefix) {
- var id = idCounter++;
- return prefix ? prefix + id : id;
- };
-
- // By default, Underscore uses ERB-style template delimiters, change the
- // following template settings to use alternative delimiters.
- _.templateSettings = {
- evaluate : /<%([\s\S]+?)%>/g,
- interpolate : /<%=([\s\S]+?)%>/g,
- escape : /<%-([\s\S]+?)%>/g
- };
-
- // When customizing `templateSettings`, if you don't want to define an
- // interpolation, evaluation or escaping regex, we need one that is
- // guaranteed not to match.
- var noMatch = /.^/;
-
- // Within an interpolation, evaluation, or escaping, remove HTML escaping
- // that had been previously added.
- var unescape = function(code) {
- return code.replace(/\\\\/g, '\\').replace(/\\'/g, "'");
- };
-
- // JavaScript micro-templating, similar to John Resig's implementation.
- // Underscore templating handles arbitrary delimiters, preserves whitespace,
- // and correctly escapes quotes within interpolated code.
- _.template = function(str, data) {
- var c = _.templateSettings;
- var tmpl = 'var __p=[],print=function(){__p.push.apply(__p,arguments);};' +
- 'with(obj||{}){__p.push(\'' +
- str.replace(/\\/g, '\\\\')
- .replace(/'/g, "\\'")
- .replace(c.escape || noMatch, function(match, code) {
- return "',_.escape(" + unescape(code) + "),'";
- })
- .replace(c.interpolate || noMatch, function(match, code) {
- return "'," + unescape(code) + ",'";
- })
- .replace(c.evaluate || noMatch, function(match, code) {
- return "');" + unescape(code).replace(/[\r\n\t]/g, ' ') + ";__p.push('";
- })
- .replace(/\r/g, '\\r')
- .replace(/\n/g, '\\n')
- .replace(/\t/g, '\\t')
- + "');}return __p.join('');";
- var func = new Function('obj', '_', tmpl);
- if (data) return func(data, _);
- return function(data) {
- return func.call(this, data, _);
- };
- };
-
- // Add a "chain" function, which will delegate to the wrapper.
- _.chain = function(obj) {
- return _(obj).chain();
- };
-
- // The OOP Wrapper
- // ---------------
-
- // If Underscore is called as a function, it returns a wrapped object that
- // can be used OO-style. This wrapper holds altered versions of all the
- // underscore functions. Wrapped objects may be chained.
- var wrapper = function(obj) { this._wrapped = obj; };
-
- // Expose `wrapper.prototype` as `_.prototype`
- _.prototype = wrapper.prototype;
-
- // Helper function to continue chaining intermediate results.
- var result = function(obj, chain) {
- return chain ? _(obj).chain() : obj;
- };
-
- // A method to easily add functions to the OOP wrapper.
- var addToWrapper = function(name, func) {
- wrapper.prototype[name] = function() {
- var args = slice.call(arguments);
- unshift.call(args, this._wrapped);
- return result(func.apply(_, args), this._chain);
- };
- };
-
- // Add all of the Underscore functions to the wrapper object.
- _.mixin(_);
-
- // Add all mutator Array functions to the wrapper.
- each(['pop', 'push', 'reverse', 'shift', 'sort', 'splice', 'unshift'], function(name) {
- var method = ArrayProto[name];
- wrapper.prototype[name] = function() {
- var wrapped = this._wrapped;
- method.apply(wrapped, arguments);
- var length = wrapped.length;
- if ((name == 'shift' || name == 'splice') && length === 0) delete wrapped[0];
- return result(wrapped, this._chain);
- };
- });
-
- // Add all accessor Array functions to the wrapper.
- each(['concat', 'join', 'slice'], function(name) {
- var method = ArrayProto[name];
- wrapper.prototype[name] = function() {
- return result(method.apply(this._wrapped, arguments), this._chain);
- };
- });
-
- // Start chaining a wrapped Underscore object.
- wrapper.prototype.chain = function() {
- this._chain = true;
- return this;
- };
-
- // Extracts the result from a wrapped and chained object.
- wrapper.prototype.value = function() {
- return this._wrapped;
- };
-
-}).call(this);
-// Underscore.js 1.3.1
-// (c) 2009-2012 Jeremy Ashkenas, DocumentCloud Inc.
-// Underscore is freely distributable under the MIT license.
-// Portions of Underscore are inspired or borrowed from Prototype,
-// Oliver Steele's Functional, and John Resig's Micro-Templating.
-// For all details and documentation:
-// http://documentcloud.github.com/underscore
-(function(){function q(a,c,d){if(a===c)return a!==0||1/a==1/c;if(a==null||c==null)return a===c;if(a._chain)a=a._wrapped;if(c._chain)c=c._wrapped;if(a.isEqual&&b.isFunction(a.isEqual))return a.isEqual(c);if(c.isEqual&&b.isFunction(c.isEqual))return c.isEqual(a);var e=l.call(a);if(e!=l.call(c))return false;switch(e){case "[object String]":return a==String(c);case "[object Number]":return a!=+a?c!=+c:a==0?1/a==1/c:a==+c;case "[object Date]":case "[object Boolean]":return+a==+c;case "[object RegExp]":return a.source==
-c.source&&a.global==c.global&&a.multiline==c.multiline&&a.ignoreCase==c.ignoreCase}if(typeof a!="object"||typeof c!="object")return false;for(var f=d.length;f--;)if(d[f]==a)return true;d.push(a);var f=0,g=true;if(e=="[object Array]"){if(f=a.length,g=f==c.length)for(;f--;)if(!(g=f in a==f in c&&q(a[f],c[f],d)))break}else{if("constructor"in a!="constructor"in c||a.constructor!=c.constructor)return false;for(var h in a)if(b.has(a,h)&&(f++,!(g=b.has(c,h)&&q(a[h],c[h],d))))break;if(g){for(h in c)if(b.has(c,
-h)&&!f--)break;g=!f}}d.pop();return g}var r=this,G=r._,n={},k=Array.prototype,o=Object.prototype,i=k.slice,H=k.unshift,l=o.toString,I=o.hasOwnProperty,w=k.forEach,x=k.map,y=k.reduce,z=k.reduceRight,A=k.filter,B=k.every,C=k.some,p=k.indexOf,D=k.lastIndexOf,o=Array.isArray,J=Object.keys,s=Function.prototype.bind,b=function(a){return new m(a)};if(typeof exports!=="undefined"){if(typeof module!=="undefined"&&module.exports)exports=module.exports=b;exports._=b}else r._=b;b.VERSION="1.3.1";var j=b.each=
-b.forEach=function(a,c,d){if(a!=null)if(w&&a.forEach===w)a.forEach(c,d);else if(a.length===+a.length)for(var e=0,f=a.length;e<f;e++){if(e in a&&c.call(d,a[e],e,a)===n)break}else for(e in a)if(b.has(a,e)&&c.call(d,a[e],e,a)===n)break};b.map=b.collect=function(a,c,b){var e=[];if(a==null)return e;if(x&&a.map===x)return a.map(c,b);j(a,function(a,g,h){e[e.length]=c.call(b,a,g,h)});if(a.length===+a.length)e.length=a.length;return e};b.reduce=b.foldl=b.inject=function(a,c,d,e){var f=arguments.length>2;a==
-null&&(a=[]);if(y&&a.reduce===y)return e&&(c=b.bind(c,e)),f?a.reduce(c,d):a.reduce(c);j(a,function(a,b,i){f?d=c.call(e,d,a,b,i):(d=a,f=true)});if(!f)throw new TypeError("Reduce of empty array with no initial value");return d};b.reduceRight=b.foldr=function(a,c,d,e){var f=arguments.length>2;a==null&&(a=[]);if(z&&a.reduceRight===z)return e&&(c=b.bind(c,e)),f?a.reduceRight(c,d):a.reduceRight(c);var g=b.toArray(a).reverse();e&&!f&&(c=b.bind(c,e));return f?b.reduce(g,c,d,e):b.reduce(g,c)};b.find=b.detect=
-function(a,c,b){var e;E(a,function(a,g,h){if(c.call(b,a,g,h))return e=a,true});return e};b.filter=b.select=function(a,c,b){var e=[];if(a==null)return e;if(A&&a.filter===A)return a.filter(c,b);j(a,function(a,g,h){c.call(b,a,g,h)&&(e[e.length]=a)});return e};b.reject=function(a,c,b){var e=[];if(a==null)return e;j(a,function(a,g,h){c.call(b,a,g,h)||(e[e.length]=a)});return e};b.every=b.all=function(a,c,b){var e=true;if(a==null)return e;if(B&&a.every===B)return a.every(c,b);j(a,function(a,g,h){if(!(e=
-e&&c.call(b,a,g,h)))return n});return e};var E=b.some=b.any=function(a,c,d){c||(c=b.identity);var e=false;if(a==null)return e;if(C&&a.some===C)return a.some(c,d);j(a,function(a,b,h){if(e||(e=c.call(d,a,b,h)))return n});return!!e};b.include=b.contains=function(a,c){var b=false;if(a==null)return b;return p&&a.indexOf===p?a.indexOf(c)!=-1:b=E(a,function(a){return a===c})};b.invoke=function(a,c){var d=i.call(arguments,2);return b.map(a,function(a){return(b.isFunction(c)?c||a:a[c]).apply(a,d)})};b.pluck=
-function(a,c){return b.map(a,function(a){return a[c]})};b.max=function(a,c,d){if(!c&&b.isArray(a))return Math.max.apply(Math,a);if(!c&&b.isEmpty(a))return-Infinity;var e={computed:-Infinity};j(a,function(a,b,h){b=c?c.call(d,a,b,h):a;b>=e.computed&&(e={value:a,computed:b})});return e.value};b.min=function(a,c,d){if(!c&&b.isArray(a))return Math.min.apply(Math,a);if(!c&&b.isEmpty(a))return Infinity;var e={computed:Infinity};j(a,function(a,b,h){b=c?c.call(d,a,b,h):a;b<e.computed&&(e={value:a,computed:b})});
-return e.value};b.shuffle=function(a){var b=[],d;j(a,function(a,f){f==0?b[0]=a:(d=Math.floor(Math.random()*(f+1)),b[f]=b[d],b[d]=a)});return b};b.sortBy=function(a,c,d){return b.pluck(b.map(a,function(a,b,g){return{value:a,criteria:c.call(d,a,b,g)}}).sort(function(a,b){var c=a.criteria,d=b.criteria;return c<d?-1:c>d?1:0}),"value")};b.groupBy=function(a,c){var d={},e=b.isFunction(c)?c:function(a){return a[c]};j(a,function(a,b){var c=e(a,b);(d[c]||(d[c]=[])).push(a)});return d};b.sortedIndex=function(a,
-c,d){d||(d=b.identity);for(var e=0,f=a.length;e<f;){var g=e+f>>1;d(a[g])<d(c)?e=g+1:f=g}return e};b.toArray=function(a){return!a?[]:a.toArray?a.toArray():b.isArray(a)?i.call(a):b.isArguments(a)?i.call(a):b.values(a)};b.size=function(a){return b.toArray(a).length};b.first=b.head=function(a,b,d){return b!=null&&!d?i.call(a,0,b):a[0]};b.initial=function(a,b,d){return i.call(a,0,a.length-(b==null||d?1:b))};b.last=function(a,b,d){return b!=null&&!d?i.call(a,Math.max(a.length-b,0)):a[a.length-1]};b.rest=
-b.tail=function(a,b,d){return i.call(a,b==null||d?1:b)};b.compact=function(a){return b.filter(a,function(a){return!!a})};b.flatten=function(a,c){return b.reduce(a,function(a,e){if(b.isArray(e))return a.concat(c?e:b.flatten(e));a[a.length]=e;return a},[])};b.without=function(a){return b.difference(a,i.call(arguments,1))};b.uniq=b.unique=function(a,c,d){var d=d?b.map(a,d):a,e=[];b.reduce(d,function(d,g,h){if(0==h||(c===true?b.last(d)!=g:!b.include(d,g)))d[d.length]=g,e[e.length]=a[h];return d},[]);
-return e};b.union=function(){return b.uniq(b.flatten(arguments,true))};b.intersection=b.intersect=function(a){var c=i.call(arguments,1);return b.filter(b.uniq(a),function(a){return b.every(c,function(c){return b.indexOf(c,a)>=0})})};b.difference=function(a){var c=b.flatten(i.call(arguments,1));return b.filter(a,function(a){return!b.include(c,a)})};b.zip=function(){for(var a=i.call(arguments),c=b.max(b.pluck(a,"length")),d=Array(c),e=0;e<c;e++)d[e]=b.pluck(a,""+e);return d};b.indexOf=function(a,c,
-d){if(a==null)return-1;var e;if(d)return d=b.sortedIndex(a,c),a[d]===c?d:-1;if(p&&a.indexOf===p)return a.indexOf(c);for(d=0,e=a.length;d<e;d++)if(d in a&&a[d]===c)return d;return-1};b.lastIndexOf=function(a,b){if(a==null)return-1;if(D&&a.lastIndexOf===D)return a.lastIndexOf(b);for(var d=a.length;d--;)if(d in a&&a[d]===b)return d;return-1};b.range=function(a,b,d){arguments.length<=1&&(b=a||0,a=0);for(var d=arguments[2]||1,e=Math.max(Math.ceil((b-a)/d),0),f=0,g=Array(e);f<e;)g[f++]=a,a+=d;return g};
-var F=function(){};b.bind=function(a,c){var d,e;if(a.bind===s&&s)return s.apply(a,i.call(arguments,1));if(!b.isFunction(a))throw new TypeError;e=i.call(arguments,2);return d=function(){if(!(this instanceof d))return a.apply(c,e.concat(i.call(arguments)));F.prototype=a.prototype;var b=new F,g=a.apply(b,e.concat(i.call(arguments)));return Object(g)===g?g:b}};b.bindAll=function(a){var c=i.call(arguments,1);c.length==0&&(c=b.functions(a));j(c,function(c){a[c]=b.bind(a[c],a)});return a};b.memoize=function(a,
-c){var d={};c||(c=b.identity);return function(){var e=c.apply(this,arguments);return b.has(d,e)?d[e]:d[e]=a.apply(this,arguments)}};b.delay=function(a,b){var d=i.call(arguments,2);return setTimeout(function(){return a.apply(a,d)},b)};b.defer=function(a){return b.delay.apply(b,[a,1].concat(i.call(arguments,1)))};b.throttle=function(a,c){var d,e,f,g,h,i=b.debounce(function(){h=g=false},c);return function(){d=this;e=arguments;var b;f||(f=setTimeout(function(){f=null;h&&a.apply(d,e);i()},c));g?h=true:
-a.apply(d,e);i();g=true}};b.debounce=function(a,b){var d;return function(){var e=this,f=arguments;clearTimeout(d);d=setTimeout(function(){d=null;a.apply(e,f)},b)}};b.once=function(a){var b=false,d;return function(){if(b)return d;b=true;return d=a.apply(this,arguments)}};b.wrap=function(a,b){return function(){var d=[a].concat(i.call(arguments,0));return b.apply(this,d)}};b.compose=function(){var a=arguments;return function(){for(var b=arguments,d=a.length-1;d>=0;d--)b=[a[d].apply(this,b)];return b[0]}};
-b.after=function(a,b){return a<=0?b():function(){if(--a<1)return b.apply(this,arguments)}};b.keys=J||function(a){if(a!==Object(a))throw new TypeError("Invalid object");var c=[],d;for(d in a)b.has(a,d)&&(c[c.length]=d);return c};b.values=function(a){return b.map(a,b.identity)};b.functions=b.methods=function(a){var c=[],d;for(d in a)b.isFunction(a[d])&&c.push(d);return c.sort()};b.extend=function(a){j(i.call(arguments,1),function(b){for(var d in b)a[d]=b[d]});return a};b.defaults=function(a){j(i.call(arguments,
-1),function(b){for(var d in b)a[d]==null&&(a[d]=b[d])});return a};b.clone=function(a){return!b.isObject(a)?a:b.isArray(a)?a.slice():b.extend({},a)};b.tap=function(a,b){b(a);return a};b.isEqual=function(a,b){return q(a,b,[])};b.isEmpty=function(a){if(b.isArray(a)||b.isString(a))return a.length===0;for(var c in a)if(b.has(a,c))return false;return true};b.isElement=function(a){return!!(a&&a.nodeType==1)};b.isArray=o||function(a){return l.call(a)=="[object Array]"};b.isObject=function(a){return a===Object(a)};
-b.isArguments=function(a){return l.call(a)=="[object Arguments]"};if(!b.isArguments(arguments))b.isArguments=function(a){return!(!a||!b.has(a,"callee"))};b.isFunction=function(a){return l.call(a)=="[object Function]"};b.isString=function(a){return l.call(a)=="[object String]"};b.isNumber=function(a){return l.call(a)=="[object Number]"};b.isNaN=function(a){return a!==a};b.isBoolean=function(a){return a===true||a===false||l.call(a)=="[object Boolean]"};b.isDate=function(a){return l.call(a)=="[object Date]"};
-b.isRegExp=function(a){return l.call(a)=="[object RegExp]"};b.isNull=function(a){return a===null};b.isUndefined=function(a){return a===void 0};b.has=function(a,b){return I.call(a,b)};b.noConflict=function(){r._=G;return this};b.identity=function(a){return a};b.times=function(a,b,d){for(var e=0;e<a;e++)b.call(d,e)};b.escape=function(a){return(""+a).replace(/&/g,"&").replace(/</g,"<").replace(/>/g,">").replace(/"/g,""").replace(/'/g,"'").replace(/\//g,"/")};b.mixin=function(a){j(b.functions(a),
-function(c){K(c,b[c]=a[c])})};var L=0;b.uniqueId=function(a){var b=L++;return a?a+b:b};b.templateSettings={evaluate:/<%([\s\S]+?)%>/g,interpolate:/<%=([\s\S]+?)%>/g,escape:/<%-([\s\S]+?)%>/g};var t=/.^/,u=function(a){return a.replace(/\\\\/g,"\\").replace(/\\'/g,"'")};b.template=function(a,c){var d=b.templateSettings,d="var __p=[],print=function(){__p.push.apply(__p,arguments);};with(obj||{}){__p.push('"+a.replace(/\\/g,"\\\\").replace(/'/g,"\\'").replace(d.escape||t,function(a,b){return"',_.escape("+
-u(b)+"),'"}).replace(d.interpolate||t,function(a,b){return"',"+u(b)+",'"}).replace(d.evaluate||t,function(a,b){return"');"+u(b).replace(/[\r\n\t]/g," ")+";__p.push('"}).replace(/\r/g,"\\r").replace(/\n/g,"\\n").replace(/\t/g,"\\t")+"');}return __p.join('');",e=new Function("obj","_",d);return c?e(c,b):function(a){return e.call(this,a,b)}};b.chain=function(a){return b(a).chain()};var m=function(a){this._wrapped=a};b.prototype=m.prototype;var v=function(a,c){return c?b(a).chain():a},K=function(a,c){m.prototype[a]=
-function(){var a=i.call(arguments);H.call(a,this._wrapped);return v(c.apply(b,a),this._chain)}};b.mixin(b);j("pop,push,reverse,shift,sort,splice,unshift".split(","),function(a){var b=k[a];m.prototype[a]=function(){var d=this._wrapped;b.apply(d,arguments);var e=d.length;(a=="shift"||a=="splice")&&e===0&&delete d[0];return v(d,this._chain)}});j(["concat","join","slice"],function(a){var b=k[a];m.prototype[a]=function(){return v(b.apply(this._wrapped,arguments),this._chain)}});m.prototype.chain=function(){this._chain=
-true;return this};m.prototype.value=function(){return this._wrapped}}).call(this);
+// Underscore.js 1.8.3
+// http://underscorejs.org
+// (c) 2009-2015 Jeremy Ashkenas, DocumentCloud and Investigative Reporters & Editors
+// Underscore may be freely distributed under the MIT license.
+
+(function() {
+
+ // Baseline setup
+ // --------------
+
+ // Establish the root object, `window` in the browser, or `exports` on the server.
+ var root = this;
+
+ // Save the previous value of the `_` variable.
+ var previousUnderscore = root._;
+
+ // Save bytes in the minified (but not gzipped) version:
+ var ArrayProto = Array.prototype, ObjProto = Object.prototype, FuncProto = Function.prototype;
+
+ // Create quick reference variables for speed access to core prototypes.
+ var
+ push = ArrayProto.push,
+ slice = ArrayProto.slice,
+ toString = ObjProto.toString,
+ hasOwnProperty = ObjProto.hasOwnProperty;
+
+ // All **ECMAScript 5** native function implementations that we hope to use
+ // are declared here.
+ var
+ nativeIsArray = Array.isArray,
+ nativeKeys = Object.keys,
+ nativeBind = FuncProto.bind,
+ nativeCreate = Object.create;
+
+ // Naked function reference for surrogate-prototype-swapping.
+ var Ctor = function(){};
+
+ // Create a safe reference to the Underscore object for use below.
+ var _ = function(obj) {
+ if (obj instanceof _) return obj;
+ if (!(this instanceof _)) return new _(obj);
+ this._wrapped = obj;
+ };
+
+ // Export the Underscore object for **Node.js**, with
+ // backwards-compatibility for the old `require()` API. If we're in
+ // the browser, add `_` as a global object.
+ if (typeof exports !== 'undefined') {
+ if (typeof module !== 'undefined' && module.exports) {
+ exports = module.exports = _;
+ }
+ exports._ = _;
+ } else {
+ root._ = _;
+ }
+
+ // Current version.
+ _.VERSION = '1.8.3';
+
+ // Internal function that returns an efficient (for current engines) version
+ // of the passed-in callback, to be repeatedly applied in other Underscore
+ // functions.
+ var optimizeCb = function(func, context, argCount) {
+ if (context === void 0) return func;
+ switch (argCount == null ? 3 : argCount) {
+ case 1: return function(value) {
+ return func.call(context, value);
+ };
+ case 2: return function(value, other) {
+ return func.call(context, value, other);
+ };
+ case 3: return function(value, index, collection) {
+ return func.call(context, value, index, collection);
+ };
+ case 4: return function(accumulator, value, index, collection) {
+ return func.call(context, accumulator, value, index, collection);
+ };
+ }
+ return function() {
+ return func.apply(context, arguments);
+ };
+ };
+
+ // A mostly-internal function to generate callbacks that can be applied
+ // to each element in a collection, returning the desired result — either
+ // identity, an arbitrary callback, a property matcher, or a property accessor.
+ var cb = function(value, context, argCount) {
+ if (value == null) return _.identity;
+ if (_.isFunction(value)) return optimizeCb(value, context, argCount);
+ if (_.isObject(value)) return _.matcher(value);
+ return _.property(value);
+ };
+ _.iteratee = function(value, context) {
+ return cb(value, context, Infinity);
+ };
+
+ // An internal function for creating assigner functions.
+ var createAssigner = function(keysFunc, undefinedOnly) {
+ return function(obj) {
+ var length = arguments.length;
+ if (length < 2 || obj == null) return obj;
+ for (var index = 1; index < length; index++) {
+ var source = arguments[index],
+ keys = keysFunc(source),
+ l = keys.length;
+ for (var i = 0; i < l; i++) {
+ var key = keys[i];
+ if (!undefinedOnly || obj[key] === void 0) obj[key] = source[key];
+ }
+ }
+ return obj;
+ };
+ };
+
+ // An internal function for creating a new object that inherits from another.
+ var baseCreate = function(prototype) {
+ if (!_.isObject(prototype)) return {};
+ if (nativeCreate) return nativeCreate(prototype);
+ Ctor.prototype = prototype;
+ var result = new Ctor;
+ Ctor.prototype = null;
+ return result;
+ };
+
+ var property = function(key) {
+ return function(obj) {
+ return obj == null ? void 0 : obj[key];
+ };
+ };
+
+ // Helper for collection methods to determine whether a collection
+ // should be iterated as an array or as an object
+ // Related: http://people.mozilla.org/~jorendorff/es6-draft.html#sec-tolength
+ // Avoids a very nasty iOS 8 JIT bug on ARM-64. #2094
+ var MAX_ARRAY_INDEX = Math.pow(2, 53) - 1;
+ var getLength = property('length');
+ var isArrayLike = function(collection) {
+ var length = getLength(collection);
+ return typeof length == 'number' && length >= 0 && length <= MAX_ARRAY_INDEX;
+ };
+
+ // Collection Functions
+ // --------------------
+
+ // The cornerstone, an `each` implementation, aka `forEach`.
+ // Handles raw objects in addition to array-likes. Treats all
+ // sparse array-likes as if they were dense.
+ _.each = _.forEach = function(obj, iteratee, context) {
+ iteratee = optimizeCb(iteratee, context);
+ var i, length;
+ if (isArrayLike(obj)) {
+ for (i = 0, length = obj.length; i < length; i++) {
+ iteratee(obj[i], i, obj);
+ }
+ } else {
+ var keys = _.keys(obj);
+ for (i = 0, length = keys.length; i < length; i++) {
+ iteratee(obj[keys[i]], keys[i], obj);
+ }
+ }
+ return obj;
+ };
+
+ // Return the results of applying the iteratee to each element.
+ _.map = _.collect = function(obj, iteratee, context) {
+ iteratee = cb(iteratee, context);
+ var keys = !isArrayLike(obj) && _.keys(obj),
+ length = (keys || obj).length,
+ results = Array(length);
+ for (var index = 0; index < length; index++) {
+ var currentKey = keys ? keys[index] : index;
+ results[index] = iteratee(obj[currentKey], currentKey, obj);
+ }
+ return results;
+ };
+
+ // Create a reducing function iterating left or right.
+ function createReduce(dir) {
+ // Optimized iterator function as using arguments.length
+ // in the main function will deoptimize the, see #1991.
+ function iterator(obj, iteratee, memo, keys, index, length) {
+ for (; index >= 0 && index < length; index += dir) {
+ var currentKey = keys ? keys[index] : index;
+ memo = iteratee(memo, obj[currentKey], currentKey, obj);
+ }
+ return memo;
+ }
+
+ return function(obj, iteratee, memo, context) {
+ iteratee = optimizeCb(iteratee, context, 4);
+ var keys = !isArrayLike(obj) && _.keys(obj),
+ length = (keys || obj).length,
+ index = dir > 0 ? 0 : length - 1;
+ // Determine the initial value if none is provided.
+ if (arguments.length < 3) {
+ memo = obj[keys ? keys[index] : index];
+ index += dir;
+ }
+ return iterator(obj, iteratee, memo, keys, index, length);
+ };
+ }
+
+ // **Reduce** builds up a single result from a list of values, aka `inject`,
+ // or `foldl`.
+ _.reduce = _.foldl = _.inject = createReduce(1);
+
+ // The right-associative version of reduce, also known as `foldr`.
+ _.reduceRight = _.foldr = createReduce(-1);
+
+ // Return the first value which passes a truth test. Aliased as `detect`.
+ _.find = _.detect = function(obj, predicate, context) {
+ var key;
+ if (isArrayLike(obj)) {
+ key = _.findIndex(obj, predicate, context);
+ } else {
+ key = _.findKey(obj, predicate, context);
+ }
+ if (key !== void 0 && key !== -1) return obj[key];
+ };
+
+ // Return all the elements that pass a truth test.
+ // Aliased as `select`.
+ _.filter = _.select = function(obj, predicate, context) {
+ var results = [];
+ predicate = cb(predicate, context);
+ _.each(obj, function(value, index, list) {
+ if (predicate(value, index, list)) results.push(value);
+ });
+ return results;
+ };
+
+ // Return all the elements for which a truth test fails.
+ _.reject = function(obj, predicate, context) {
+ return _.filter(obj, _.negate(cb(predicate)), context);
+ };
+
+ // Determine whether all of the elements match a truth test.
+ // Aliased as `all`.
+ _.every = _.all = function(obj, predicate, context) {
+ predicate = cb(predicate, context);
+ var keys = !isArrayLike(obj) && _.keys(obj),
+ length = (keys || obj).length;
+ for (var index = 0; index < length; index++) {
+ var currentKey = keys ? keys[index] : index;
+ if (!predicate(obj[currentKey], currentKey, obj)) return false;
+ }
+ return true;
+ };
+
+ // Determine if at least one element in the object matches a truth test.
+ // Aliased as `any`.
+ _.some = _.any = function(obj, predicate, context) {
+ predicate = cb(predicate, context);
+ var keys = !isArrayLike(obj) && _.keys(obj),
+ length = (keys || obj).length;
+ for (var index = 0; index < length; index++) {
+ var currentKey = keys ? keys[index] : index;
+ if (predicate(obj[currentKey], currentKey, obj)) return true;
+ }
+ return false;
+ };
+
+ // Determine if the array or object contains a given item (using `===`).
+ // Aliased as `includes` and `include`.
+ _.contains = _.includes = _.include = function(obj, item, fromIndex, guard) {
+ if (!isArrayLike(obj)) obj = _.values(obj);
+ if (typeof fromIndex != 'number' || guard) fromIndex = 0;
+ return _.indexOf(obj, item, fromIndex) >= 0;
+ };
+
+ // Invoke a method (with arguments) on every item in a collection.
+ _.invoke = function(obj, method) {
+ var args = slice.call(arguments, 2);
+ var isFunc = _.isFunction(method);
+ return _.map(obj, function(value) {
+ var func = isFunc ? method : value[method];
+ return func == null ? func : func.apply(value, args);
+ });
+ };
+
+ // Convenience version of a common use case of `map`: fetching a property.
+ _.pluck = function(obj, key) {
+ return _.map(obj, _.property(key));
+ };
+
+ // Convenience version of a common use case of `filter`: selecting only objects
+ // containing specific `key:value` pairs.
+ _.where = function(obj, attrs) {
+ return _.filter(obj, _.matcher(attrs));
+ };
+
+ // Convenience version of a common use case of `find`: getting the first object
+ // containing specific `key:value` pairs.
+ _.findWhere = function(obj, attrs) {
+ return _.find(obj, _.matcher(attrs));
+ };
+
+ // Return the maximum element (or element-based computation).
+ _.max = function(obj, iteratee, context) {
+ var result = -Infinity, lastComputed = -Infinity,
+ value, computed;
+ if (iteratee == null && obj != null) {
+ obj = isArrayLike(obj) ? obj : _.values(obj);
+ for (var i = 0, length = obj.length; i < length; i++) {
+ value = obj[i];
+ if (value > result) {
+ result = value;
+ }
+ }
+ } else {
+ iteratee = cb(iteratee, context);
+ _.each(obj, function(value, index, list) {
+ computed = iteratee(value, index, list);
+ if (computed > lastComputed || computed === -Infinity && result === -Infinity) {
+ result = value;
+ lastComputed = computed;
+ }
+ });
+ }
+ return result;
+ };
+
+ // Return the minimum element (or element-based computation).
+ _.min = function(obj, iteratee, context) {
+ var result = Infinity, lastComputed = Infinity,
+ value, computed;
+ if (iteratee == null && obj != null) {
+ obj = isArrayLike(obj) ? obj : _.values(obj);
+ for (var i = 0, length = obj.length; i < length; i++) {
+ value = obj[i];
+ if (value < result) {
+ result = value;
+ }
+ }
+ } else {
+ iteratee = cb(iteratee, context);
+ _.each(obj, function(value, index, list) {
+ computed = iteratee(value, index, list);
+ if (computed < lastComputed || computed === Infinity && result === Infinity) {
+ result = value;
+ lastComputed = computed;
+ }
+ });
+ }
+ return result;
+ };
+
+ // Shuffle a collection, using the modern version of the
+ // [Fisher-Yates shuffle](http://en.wikipedia.org/wiki/Fisher–Yates_shuffle).
+ _.shuffle = function(obj) {
+ var set = isArrayLike(obj) ? obj : _.values(obj);
+ var length = set.length;
+ var shuffled = Array(length);
+ for (var index = 0, rand; index < length; index++) {
+ rand = _.random(0, index);
+ if (rand !== index) shuffled[index] = shuffled[rand];
+ shuffled[rand] = set[index];
+ }
+ return shuffled;
+ };
+
+ // Sample **n** random values from a collection.
+ // If **n** is not specified, returns a single random element.
+ // The internal `guard` argument allows it to work with `map`.
+ _.sample = function(obj, n, guard) {
+ if (n == null || guard) {
+ if (!isArrayLike(obj)) obj = _.values(obj);
+ return obj[_.random(obj.length - 1)];
+ }
+ return _.shuffle(obj).slice(0, Math.max(0, n));
+ };
+
+ // Sort the object's values by a criterion produced by an iteratee.
+ _.sortBy = function(obj, iteratee, context) {
+ iteratee = cb(iteratee, context);
+ return _.pluck(_.map(obj, function(value, index, list) {
+ return {
+ value: value,
+ index: index,
+ criteria: iteratee(value, index, list)
+ };
+ }).sort(function(left, right) {
+ var a = left.criteria;
+ var b = right.criteria;
+ if (a !== b) {
+ if (a > b || a === void 0) return 1;
+ if (a < b || b === void 0) return -1;
+ }
+ return left.index - right.index;
+ }), 'value');
+ };
+
+ // An internal function used for aggregate "group by" operations.
+ var group = function(behavior) {
+ return function(obj, iteratee, context) {
+ var result = {};
+ iteratee = cb(iteratee, context);
+ _.each(obj, function(value, index) {
+ var key = iteratee(value, index, obj);
+ behavior(result, value, key);
+ });
+ return result;
+ };
+ };
+
+ // Groups the object's values by a criterion. Pass either a string attribute
+ // to group by, or a function that returns the criterion.
+ _.groupBy = group(function(result, value, key) {
+ if (_.has(result, key)) result[key].push(value); else result[key] = [value];
+ });
+
+ // Indexes the object's values by a criterion, similar to `groupBy`, but for
+ // when you know that your index values will be unique.
+ _.indexBy = group(function(result, value, key) {
+ result[key] = value;
+ });
+
+ // Counts instances of an object that group by a certain criterion. Pass
+ // either a string attribute to count by, or a function that returns the
+ // criterion.
+ _.countBy = group(function(result, value, key) {
+ if (_.has(result, key)) result[key]++; else result[key] = 1;
+ });
+
+ // Safely create a real, live array from anything iterable.
+ _.toArray = function(obj) {
+ if (!obj) return [];
+ if (_.isArray(obj)) return slice.call(obj);
+ if (isArrayLike(obj)) return _.map(obj, _.identity);
+ return _.values(obj);
+ };
+
+ // Return the number of elements in an object.
+ _.size = function(obj) {
+ if (obj == null) return 0;
+ return isArrayLike(obj) ? obj.length : _.keys(obj).length;
+ };
+
+ // Split a collection into two arrays: one whose elements all satisfy the given
+ // predicate, and one whose elements all do not satisfy the predicate.
+ _.partition = function(obj, predicate, context) {
+ predicate = cb(predicate, context);
+ var pass = [], fail = [];
+ _.each(obj, function(value, key, obj) {
+ (predicate(value, key, obj) ? pass : fail).push(value);
+ });
+ return [pass, fail];
+ };
+
+ // Array Functions
+ // ---------------
+
+ // Get the first element of an array. Passing **n** will return the first N
+ // values in the array. Aliased as `head` and `take`. The **guard** check
+ // allows it to work with `_.map`.
+ _.first = _.head = _.take = function(array, n, guard) {
+ if (array == null) return void 0;
+ if (n == null || guard) return array[0];
+ return _.initial(array, array.length - n);
+ };
+
+ // Returns everything but the last entry of the array. Especially useful on
+ // the arguments object. Passing **n** will return all the values in
+ // the array, excluding the last N.
+ _.initial = function(array, n, guard) {
+ return slice.call(array, 0, Math.max(0, array.length - (n == null || guard ? 1 : n)));
+ };
+
+ // Get the last element of an array. Passing **n** will return the last N
+ // values in the array.
+ _.last = function(array, n, guard) {
+ if (array == null) return void 0;
+ if (n == null || guard) return array[array.length - 1];
+ return _.rest(array, Math.max(0, array.length - n));
+ };
+
+ // Returns everything but the first entry of the array. Aliased as `tail` and `drop`.
+ // Especially useful on the arguments object. Passing an **n** will return
+ // the rest N values in the array.
+ _.rest = _.tail = _.drop = function(array, n, guard) {
+ return slice.call(array, n == null || guard ? 1 : n);
+ };
+
+ // Trim out all falsy values from an array.
+ _.compact = function(array) {
+ return _.filter(array, _.identity);
+ };
+
+ // Internal implementation of a recursive `flatten` function.
+ var flatten = function(input, shallow, strict, startIndex) {
+ var output = [], idx = 0;
+ for (var i = startIndex || 0, length = getLength(input); i < length; i++) {
+ var value = input[i];
+ if (isArrayLike(value) && (_.isArray(value) || _.isArguments(value))) {
+ //flatten current level of array or arguments object
+ if (!shallow) value = flatten(value, shallow, strict);
+ var j = 0, len = value.length;
+ output.length += len;
+ while (j < len) {
+ output[idx++] = value[j++];
+ }
+ } else if (!strict) {
+ output[idx++] = value;
+ }
+ }
+ return output;
+ };
+
+ // Flatten out an array, either recursively (by default), or just one level.
+ _.flatten = function(array, shallow) {
+ return flatten(array, shallow, false);
+ };
+
+ // Return a version of the array that does not contain the specified value(s).
+ _.without = function(array) {
+ return _.difference(array, slice.call(arguments, 1));
+ };
+
+ // Produce a duplicate-free version of the array. If the array has already
+ // been sorted, you have the option of using a faster algorithm.
+ // Aliased as `unique`.
+ _.uniq = _.unique = function(array, isSorted, iteratee, context) {
+ if (!_.isBoolean(isSorted)) {
+ context = iteratee;
+ iteratee = isSorted;
+ isSorted = false;
+ }
+ if (iteratee != null) iteratee = cb(iteratee, context);
+ var result = [];
+ var seen = [];
+ for (var i = 0, length = getLength(array); i < length; i++) {
+ var value = array[i],
+ computed = iteratee ? iteratee(value, i, array) : value;
+ if (isSorted) {
+ if (!i || seen !== computed) result.push(value);
+ seen = computed;
+ } else if (iteratee) {
+ if (!_.contains(seen, computed)) {
+ seen.push(computed);
+ result.push(value);
+ }
+ } else if (!_.contains(result, value)) {
+ result.push(value);
+ }
+ }
+ return result;
+ };
+
+ // Produce an array that contains the union: each distinct element from all of
+ // the passed-in arrays.
+ _.union = function() {
+ return _.uniq(flatten(arguments, true, true));
+ };
+
+ // Produce an array that contains every item shared between all the
+ // passed-in arrays.
+ _.intersection = function(array) {
+ var result = [];
+ var argsLength = arguments.length;
+ for (var i = 0, length = getLength(array); i < length; i++) {
+ var item = array[i];
+ if (_.contains(result, item)) continue;
+ for (var j = 1; j < argsLength; j++) {
+ if (!_.contains(arguments[j], item)) break;
+ }
+ if (j === argsLength) result.push(item);
+ }
+ return result;
+ };
+
+ // Take the difference between one array and a number of other arrays.
+ // Only the elements present in just the first array will remain.
+ _.difference = function(array) {
+ var rest = flatten(arguments, true, true, 1);
+ return _.filter(array, function(value){
+ return !_.contains(rest, value);
+ });
+ };
+
+ // Zip together multiple lists into a single array -- elements that share
+ // an index go together.
+ _.zip = function() {
+ return _.unzip(arguments);
+ };
+
+ // Complement of _.zip. Unzip accepts an array of arrays and groups
+ // each array's elements on shared indices
+ _.unzip = function(array) {
+ var length = array && _.max(array, getLength).length || 0;
+ var result = Array(length);
+
+ for (var index = 0; index < length; index++) {
+ result[index] = _.pluck(array, index);
+ }
+ return result;
+ };
+
+ // Converts lists into objects. Pass either a single array of `[key, value]`
+ // pairs, or two parallel arrays of the same length -- one of keys, and one of
+ // the corresponding values.
+ _.object = function(list, values) {
+ var result = {};
+ for (var i = 0, length = getLength(list); i < length; i++) {
+ if (values) {
+ result[list[i]] = values[i];
+ } else {
+ result[list[i][0]] = list[i][1];
+ }
+ }
+ return result;
+ };
+
+ // Generator function to create the findIndex and findLastIndex functions
+ function createPredicateIndexFinder(dir) {
+ return function(array, predicate, context) {
+ predicate = cb(predicate, context);
+ var length = getLength(array);
+ var index = dir > 0 ? 0 : length - 1;
+ for (; index >= 0 && index < length; index += dir) {
+ if (predicate(array[index], index, array)) return index;
+ }
+ return -1;
+ };
+ }
+
+ // Returns the first index on an array-like that passes a predicate test
+ _.findIndex = createPredicateIndexFinder(1);
+ _.findLastIndex = createPredicateIndexFinder(-1);
+
+ // Use a comparator function to figure out the smallest index at which
+ // an object should be inserted so as to maintain order. Uses binary search.
+ _.sortedIndex = function(array, obj, iteratee, context) {
+ iteratee = cb(iteratee, context, 1);
+ var value = iteratee(obj);
+ var low = 0, high = getLength(array);
+ while (low < high) {
+ var mid = Math.floor((low + high) / 2);
+ if (iteratee(array[mid]) < value) low = mid + 1; else high = mid;
+ }
+ return low;
+ };
+
+ // Generator function to create the indexOf and lastIndexOf functions
+ function createIndexFinder(dir, predicateFind, sortedIndex) {
+ return function(array, item, idx) {
+ var i = 0, length = getLength(array);
+ if (typeof idx == 'number') {
+ if (dir > 0) {
+ i = idx >= 0 ? idx : Math.max(idx + length, i);
+ } else {
+ length = idx >= 0 ? Math.min(idx + 1, length) : idx + length + 1;
+ }
+ } else if (sortedIndex && idx && length) {
+ idx = sortedIndex(array, item);
+ return array[idx] === item ? idx : -1;
+ }
+ if (item !== item) {
+ idx = predicateFind(slice.call(array, i, length), _.isNaN);
+ return idx >= 0 ? idx + i : -1;
+ }
+ for (idx = dir > 0 ? i : length - 1; idx >= 0 && idx < length; idx += dir) {
+ if (array[idx] === item) return idx;
+ }
+ return -1;
+ };
+ }
+
+ // Return the position of the first occurrence of an item in an array,
+ // or -1 if the item is not included in the array.
+ // If the array is large and already in sort order, pass `true`
+ // for **isSorted** to use binary search.
+ _.indexOf = createIndexFinder(1, _.findIndex, _.sortedIndex);
+ _.lastIndexOf = createIndexFinder(-1, _.findLastIndex);
+
+ // Generate an integer Array containing an arithmetic progression. A port of
+ // the native Python `range()` function. See
+ // [the Python documentation](http://docs.python.org/library/functions.html#range).
+ _.range = function(start, stop, step) {
+ if (stop == null) {
+ stop = start || 0;
+ start = 0;
+ }
+ step = step || 1;
+
+ var length = Math.max(Math.ceil((stop - start) / step), 0);
+ var range = Array(length);
+
+ for (var idx = 0; idx < length; idx++, start += step) {
+ range[idx] = start;
+ }
+
+ return range;
+ };
+
+ // Function (ahem) Functions
+ // ------------------
+
+ // Determines whether to execute a function as a constructor
+ // or a normal function with the provided arguments
+ var executeBound = function(sourceFunc, boundFunc, context, callingContext, args) {
+ if (!(callingContext instanceof boundFunc)) return sourceFunc.apply(context, args);
+ var self = baseCreate(sourceFunc.prototype);
+ var result = sourceFunc.apply(self, args);
+ if (_.isObject(result)) return result;
+ return self;
+ };
+
+ // Create a function bound to a given object (assigning `this`, and arguments,
+ // optionally). Delegates to **ECMAScript 5**'s native `Function.bind` if
+ // available.
+ _.bind = function(func, context) {
+ if (nativeBind && func.bind === nativeBind) return nativeBind.apply(func, slice.call(arguments, 1));
+ if (!_.isFunction(func)) throw new TypeError('Bind must be called on a function');
+ var args = slice.call(arguments, 2);
+ var bound = function() {
+ return executeBound(func, bound, context, this, args.concat(slice.call(arguments)));
+ };
+ return bound;
+ };
+
+ // Partially apply a function by creating a version that has had some of its
+ // arguments pre-filled, without changing its dynamic `this` context. _ acts
+ // as a placeholder, allowing any combination of arguments to be pre-filled.
+ _.partial = function(func) {
+ var boundArgs = slice.call(arguments, 1);
+ var bound = function() {
+ var position = 0, length = boundArgs.length;
+ var args = Array(length);
+ for (var i = 0; i < length; i++) {
+ args[i] = boundArgs[i] === _ ? arguments[position++] : boundArgs[i];
+ }
+ while (position < arguments.length) args.push(arguments[position++]);
+ return executeBound(func, bound, this, this, args);
+ };
+ return bound;
+ };
+
+ // Bind a number of an object's methods to that object. Remaining arguments
+ // are the method names to be bound. Useful for ensuring that all callbacks
+ // defined on an object belong to it.
+ _.bindAll = function(obj) {
+ var i, length = arguments.length, key;
+ if (length <= 1) throw new Error('bindAll must be passed function names');
+ for (i = 1; i < length; i++) {
+ key = arguments[i];
+ obj[key] = _.bind(obj[key], obj);
+ }
+ return obj;
+ };
+
+ // Memoize an expensive function by storing its results.
+ _.memoize = function(func, hasher) {
+ var memoize = function(key) {
+ var cache = memoize.cache;
+ var address = '' + (hasher ? hasher.apply(this, arguments) : key);
+ if (!_.has(cache, address)) cache[address] = func.apply(this, arguments);
+ return cache[address];
+ };
+ memoize.cache = {};
+ return memoize;
+ };
+
+ // Delays a function for the given number of milliseconds, and then calls
+ // it with the arguments supplied.
+ _.delay = function(func, wait) {
+ var args = slice.call(arguments, 2);
+ return setTimeout(function(){
+ return func.apply(null, args);
+ }, wait);
+ };
+
+ // Defers a function, scheduling it to run after the current call stack has
+ // cleared.
+ _.defer = _.partial(_.delay, _, 1);
+
+ // Returns a function, that, when invoked, will only be triggered at most once
+ // during a given window of time. Normally, the throttled function will run
+ // as much as it can, without ever going more than once per `wait` duration;
+ // but if you'd like to disable the execution on the leading edge, pass
+ // `{leading: false}`. To disable execution on the trailing edge, ditto.
+ _.throttle = function(func, wait, options) {
+ var context, args, result;
+ var timeout = null;
+ var previous = 0;
+ if (!options) options = {};
+ var later = function() {
+ previous = options.leading === false ? 0 : _.now();
+ timeout = null;
+ result = func.apply(context, args);
+ if (!timeout) context = args = null;
+ };
+ return function() {
+ var now = _.now();
+ if (!previous && options.leading === false) previous = now;
+ var remaining = wait - (now - previous);
+ context = this;
+ args = arguments;
+ if (remaining <= 0 || remaining > wait) {
+ if (timeout) {
+ clearTimeout(timeout);
+ timeout = null;
+ }
+ previous = now;
+ result = func.apply(context, args);
+ if (!timeout) context = args = null;
+ } else if (!timeout && options.trailing !== false) {
+ timeout = setTimeout(later, remaining);
+ }
+ return result;
+ };
+ };
+
+ // Returns a function, that, as long as it continues to be invoked, will not
+ // be triggered. The function will be called after it stops being called for
+ // N milliseconds. If `immediate` is passed, trigger the function on the
+ // leading edge, instead of the trailing.
+ _.debounce = function(func, wait, immediate) {
+ var timeout, args, context, timestamp, result;
+
+ var later = function() {
+ var last = _.now() - timestamp;
+
+ if (last < wait && last >= 0) {
+ timeout = setTimeout(later, wait - last);
+ } else {
+ timeout = null;
+ if (!immediate) {
+ result = func.apply(context, args);
+ if (!timeout) context = args = null;
+ }
+ }
+ };
+
+ return function() {
+ context = this;
+ args = arguments;
+ timestamp = _.now();
+ var callNow = immediate && !timeout;
+ if (!timeout) timeout = setTimeout(later, wait);
+ if (callNow) {
+ result = func.apply(context, args);
+ context = args = null;
+ }
+
+ return result;
+ };
+ };
+
+ // Returns the first function passed as an argument to the second,
+ // allowing you to adjust arguments, run code before and after, and
+ // conditionally execute the original function.
+ _.wrap = function(func, wrapper) {
+ return _.partial(wrapper, func);
+ };
+
+ // Returns a negated version of the passed-in predicate.
+ _.negate = function(predicate) {
+ return function() {
+ return !predicate.apply(this, arguments);
+ };
+ };
+
+ // Returns a function that is the composition of a list of functions, each
+ // consuming the return value of the function that follows.
+ _.compose = function() {
+ var args = arguments;
+ var start = args.length - 1;
+ return function() {
+ var i = start;
+ var result = args[start].apply(this, arguments);
+ while (i--) result = args[i].call(this, result);
+ return result;
+ };
+ };
+
+ // Returns a function that will only be executed on and after the Nth call.
+ _.after = function(times, func) {
+ return function() {
+ if (--times < 1) {
+ return func.apply(this, arguments);
+ }
+ };
+ };
+
+ // Returns a function that will only be executed up to (but not including) the Nth call.
+ _.before = function(times, func) {
+ var memo;
+ return function() {
+ if (--times > 0) {
+ memo = func.apply(this, arguments);
+ }
+ if (times <= 1) func = null;
+ return memo;
+ };
+ };
+
+ // Returns a function that will be executed at most one time, no matter how
+ // often you call it. Useful for lazy initialization.
+ _.once = _.partial(_.before, 2);
+
+ // Object Functions
+ // ----------------
+
+ // Keys in IE < 9 that won't be iterated by `for key in ...` and thus missed.
+ var hasEnumBug = !{toString: null}.propertyIsEnumerable('toString');
+ var nonEnumerableProps = ['valueOf', 'isPrototypeOf', 'toString',
+ 'propertyIsEnumerable', 'hasOwnProperty', 'toLocaleString'];
+
+ function collectNonEnumProps(obj, keys) {
+ var nonEnumIdx = nonEnumerableProps.length;
+ var constructor = obj.constructor;
+ var proto = (_.isFunction(constructor) && constructor.prototype) || ObjProto;
+
+ // Constructor is a special case.
+ var prop = 'constructor';
+ if (_.has(obj, prop) && !_.contains(keys, prop)) keys.push(prop);
+
+ while (nonEnumIdx--) {
+ prop = nonEnumerableProps[nonEnumIdx];
+ if (prop in obj && obj[prop] !== proto[prop] && !_.contains(keys, prop)) {
+ keys.push(prop);
+ }
+ }
+ }
+
+ // Retrieve the names of an object's own properties.
+ // Delegates to **ECMAScript 5**'s native `Object.keys`
+ _.keys = function(obj) {
+ if (!_.isObject(obj)) return [];
+ if (nativeKeys) return nativeKeys(obj);
+ var keys = [];
+ for (var key in obj) if (_.has(obj, key)) keys.push(key);
+ // Ahem, IE < 9.
+ if (hasEnumBug) collectNonEnumProps(obj, keys);
+ return keys;
+ };
+
+ // Retrieve all the property names of an object.
+ _.allKeys = function(obj) {
+ if (!_.isObject(obj)) return [];
+ var keys = [];
+ for (var key in obj) keys.push(key);
+ // Ahem, IE < 9.
+ if (hasEnumBug) collectNonEnumProps(obj, keys);
+ return keys;
+ };
+
+ // Retrieve the values of an object's properties.
+ _.values = function(obj) {
+ var keys = _.keys(obj);
+ var length = keys.length;
+ var values = Array(length);
+ for (var i = 0; i < length; i++) {
+ values[i] = obj[keys[i]];
+ }
+ return values;
+ };
+
+ // Returns the results of applying the iteratee to each element of the object
+ // In contrast to _.map it returns an object
+ _.mapObject = function(obj, iteratee, context) {
+ iteratee = cb(iteratee, context);
+ var keys = _.keys(obj),
+ length = keys.length,
+ results = {},
+ currentKey;
+ for (var index = 0; index < length; index++) {
+ currentKey = keys[index];
+ results[currentKey] = iteratee(obj[currentKey], currentKey, obj);
+ }
+ return results;
+ };
+
+ // Convert an object into a list of `[key, value]` pairs.
+ _.pairs = function(obj) {
+ var keys = _.keys(obj);
+ var length = keys.length;
+ var pairs = Array(length);
+ for (var i = 0; i < length; i++) {
+ pairs[i] = [keys[i], obj[keys[i]]];
+ }
+ return pairs;
+ };
+
+ // Invert the keys and values of an object. The values must be serializable.
+ _.invert = function(obj) {
+ var result = {};
+ var keys = _.keys(obj);
+ for (var i = 0, length = keys.length; i < length; i++) {
+ result[obj[keys[i]]] = keys[i];
+ }
+ return result;
+ };
+
+ // Return a sorted list of the function names available on the object.
+ // Aliased as `methods`
+ _.functions = _.methods = function(obj) {
+ var names = [];
+ for (var key in obj) {
+ if (_.isFunction(obj[key])) names.push(key);
+ }
+ return names.sort();
+ };
+
+ // Extend a given object with all the properties in passed-in object(s).
+ _.extend = createAssigner(_.allKeys);
+
+ // Assigns a given object with all the own properties in the passed-in object(s)
+ // (https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object/assign)
+ _.extendOwn = _.assign = createAssigner(_.keys);
+
+ // Returns the first key on an object that passes a predicate test
+ _.findKey = function(obj, predicate, context) {
+ predicate = cb(predicate, context);
+ var keys = _.keys(obj), key;
+ for (var i = 0, length = keys.length; i < length; i++) {
+ key = keys[i];
+ if (predicate(obj[key], key, obj)) return key;
+ }
+ };
+
+ // Return a copy of the object only containing the whitelisted properties.
+ _.pick = function(object, oiteratee, context) {
+ var result = {}, obj = object, iteratee, keys;
+ if (obj == null) return result;
+ if (_.isFunction(oiteratee)) {
+ keys = _.allKeys(obj);
+ iteratee = optimizeCb(oiteratee, context);
+ } else {
+ keys = flatten(arguments, false, false, 1);
+ iteratee = function(value, key, obj) { return key in obj; };
+ obj = Object(obj);
+ }
+ for (var i = 0, length = keys.length; i < length; i++) {
+ var key = keys[i];
+ var value = obj[key];
+ if (iteratee(value, key, obj)) result[key] = value;
+ }
+ return result;
+ };
+
+ // Return a copy of the object without the blacklisted properties.
+ _.omit = function(obj, iteratee, context) {
+ if (_.isFunction(iteratee)) {
+ iteratee = _.negate(iteratee);
+ } else {
+ var keys = _.map(flatten(arguments, false, false, 1), String);
+ iteratee = function(value, key) {
+ return !_.contains(keys, key);
+ };
+ }
+ return _.pick(obj, iteratee, context);
+ };
+
+ // Fill in a given object with default properties.
+ _.defaults = createAssigner(_.allKeys, true);
+
+ // Creates an object that inherits from the given prototype object.
+ // If additional properties are provided then they will be added to the
+ // created object.
+ _.create = function(prototype, props) {
+ var result = baseCreate(prototype);
+ if (props) _.extendOwn(result, props);
+ return result;
+ };
+
+ // Create a (shallow-cloned) duplicate of an object.
+ _.clone = function(obj) {
+ if (!_.isObject(obj)) return obj;
+ return _.isArray(obj) ? obj.slice() : _.extend({}, obj);
+ };
+
+ // Invokes interceptor with the obj, and then returns obj.
+ // The primary purpose of this method is to "tap into" a method chain, in
+ // order to perform operations on intermediate results within the chain.
+ _.tap = function(obj, interceptor) {
+ interceptor(obj);
+ return obj;
+ };
+
+ // Returns whether an object has a given set of `key:value` pairs.
+ _.isMatch = function(object, attrs) {
+ var keys = _.keys(attrs), length = keys.length;
+ if (object == null) return !length;
+ var obj = Object(object);
+ for (var i = 0; i < length; i++) {
+ var key = keys[i];
+ if (attrs[key] !== obj[key] || !(key in obj)) return false;
+ }
+ return true;
+ };
+
+
+ // Internal recursive comparison function for `isEqual`.
+ var eq = function(a, b, aStack, bStack) {
+ // Identical objects are equal. `0 === -0`, but they aren't identical.
+ // See the [Harmony `egal` proposal](http://wiki.ecmascript.org/doku.php?id=harmony:egal).
+ if (a === b) return a !== 0 || 1 / a === 1 / b;
+ // A strict comparison is necessary because `null == undefined`.
+ if (a == null || b == null) return a === b;
+ // Unwrap any wrapped objects.
+ if (a instanceof _) a = a._wrapped;
+ if (b instanceof _) b = b._wrapped;
+ // Compare `[[Class]]` names.
+ var className = toString.call(a);
+ if (className !== toString.call(b)) return false;
+ switch (className) {
+ // Strings, numbers, regular expressions, dates, and booleans are compared by value.
+ case '[object RegExp]':
+ // RegExps are coerced to strings for comparison (Note: '' + /a/i === '/a/i')
+ case '[object String]':
+ // Primitives and their corresponding object wrappers are equivalent; thus, `"5"` is
+ // equivalent to `new String("5")`.
+ return '' + a === '' + b;
+ case '[object Number]':
+ // `NaN`s are equivalent, but non-reflexive.
+ // Object(NaN) is equivalent to NaN
+ if (+a !== +a) return +b !== +b;
+ // An `egal` comparison is performed for other numeric values.
+ return +a === 0 ? 1 / +a === 1 / b : +a === +b;
+ case '[object Date]':
+ case '[object Boolean]':
+ // Coerce dates and booleans to numeric primitive values. Dates are compared by their
+ // millisecond representations. Note that invalid dates with millisecond representations
+ // of `NaN` are not equivalent.
+ return +a === +b;
+ }
+
+ var areArrays = className === '[object Array]';
+ if (!areArrays) {
+ if (typeof a != 'object' || typeof b != 'object') return false;
+
+ // Objects with different constructors are not equivalent, but `Object`s or `Array`s
+ // from different frames are.
+ var aCtor = a.constructor, bCtor = b.constructor;
+ if (aCtor !== bCtor && !(_.isFunction(aCtor) && aCtor instanceof aCtor &&
+ _.isFunction(bCtor) && bCtor instanceof bCtor)
+ && ('constructor' in a && 'constructor' in b)) {
+ return false;
+ }
+ }
+ // Assume equality for cyclic structures. The algorithm for detecting cyclic
+ // structures is adapted from ES 5.1 section 15.12.3, abstract operation `JO`.
+
+ // Initializing stack of traversed objects.
+ // It's done here since we only need them for objects and arrays comparison.
+ aStack = aStack || [];
+ bStack = bStack || [];
+ var length = aStack.length;
+ while (length--) {
+ // Linear search. Performance is inversely proportional to the number of
+ // unique nested structures.
+ if (aStack[length] === a) return bStack[length] === b;
+ }
+
+ // Add the first object to the stack of traversed objects.
+ aStack.push(a);
+ bStack.push(b);
+
+ // Recursively compare objects and arrays.
+ if (areArrays) {
+ // Compare array lengths to determine if a deep comparison is necessary.
+ length = a.length;
+ if (length !== b.length) return false;
+ // Deep compare the contents, ignoring non-numeric properties.
+ while (length--) {
+ if (!eq(a[length], b[length], aStack, bStack)) return false;
+ }
+ } else {
+ // Deep compare objects.
+ var keys = _.keys(a), key;
+ length = keys.length;
+ // Ensure that both objects contain the same number of properties before comparing deep equality.
+ if (_.keys(b).length !== length) return false;
+ while (length--) {
+ // Deep compare each member
+ key = keys[length];
+ if (!(_.has(b, key) && eq(a[key], b[key], aStack, bStack))) return false;
+ }
+ }
+ // Remove the first object from the stack of traversed objects.
+ aStack.pop();
+ bStack.pop();
+ return true;
+ };
+
+ // Perform a deep comparison to check if two objects are equal.
+ _.isEqual = function(a, b) {
+ return eq(a, b);
+ };
+
+ // Is a given array, string, or object empty?
+ // An "empty" object has no enumerable own-properties.
+ _.isEmpty = function(obj) {
+ if (obj == null) return true;
+ if (isArrayLike(obj) && (_.isArray(obj) || _.isString(obj) || _.isArguments(obj))) return obj.length === 0;
+ return _.keys(obj).length === 0;
+ };
+
+ // Is a given value a DOM element?
+ _.isElement = function(obj) {
+ return !!(obj && obj.nodeType === 1);
+ };
+
+ // Is a given value an array?
+ // Delegates to ECMA5's native Array.isArray
+ _.isArray = nativeIsArray || function(obj) {
+ return toString.call(obj) === '[object Array]';
+ };
+
+ // Is a given variable an object?
+ _.isObject = function(obj) {
+ var type = typeof obj;
+ return type === 'function' || type === 'object' && !!obj;
+ };
+
+ // Add some isType methods: isArguments, isFunction, isString, isNumber, isDate, isRegExp, isError.
+ _.each(['Arguments', 'Function', 'String', 'Number', 'Date', 'RegExp', 'Error'], function(name) {
+ _['is' + name] = function(obj) {
+ return toString.call(obj) === '[object ' + name + ']';
+ };
+ });
+
+ // Define a fallback version of the method in browsers (ahem, IE < 9), where
+ // there isn't any inspectable "Arguments" type.
+ if (!_.isArguments(arguments)) {
+ _.isArguments = function(obj) {
+ return _.has(obj, 'callee');
+ };
+ }
+
+ // Optimize `isFunction` if appropriate. Work around some typeof bugs in old v8,
+ // IE 11 (#1621), and in Safari 8 (#1929).
+ if (typeof /./ != 'function' && typeof Int8Array != 'object') {
+ _.isFunction = function(obj) {
+ return typeof obj == 'function' || false;
+ };
+ }
+
+ // Is a given object a finite number?
+ _.isFinite = function(obj) {
+ return isFinite(obj) && !isNaN(parseFloat(obj));
+ };
+
+ // Is the given value `NaN`? (NaN is the only number which does not equal itself).
+ _.isNaN = function(obj) {
+ return _.isNumber(obj) && obj !== +obj;
+ };
+
+ // Is a given value a boolean?
+ _.isBoolean = function(obj) {
+ return obj === true || obj === false || toString.call(obj) === '[object Boolean]';
+ };
+
+ // Is a given value equal to null?
+ _.isNull = function(obj) {
+ return obj === null;
+ };
+
+ // Is a given variable undefined?
+ _.isUndefined = function(obj) {
+ return obj === void 0;
+ };
+
+ // Shortcut function for checking if an object has a given property directly
+ // on itself (in other words, not on a prototype).
+ _.has = function(obj, key) {
+ return obj != null && hasOwnProperty.call(obj, key);
+ };
+
+ // Utility Functions
+ // -----------------
+
+ // Run Underscore.js in *noConflict* mode, returning the `_` variable to its
+ // previous owner. Returns a reference to the Underscore object.
+ _.noConflict = function() {
+ root._ = previousUnderscore;
+ return this;
+ };
+
+ // Keep the identity function around for default iteratees.
+ _.identity = function(value) {
+ return value;
+ };
+
+ // Predicate-generating functions. Often useful outside of Underscore.
+ _.constant = function(value) {
+ return function() {
+ return value;
+ };
+ };
+
+ _.noop = function(){};
+
+ _.property = property;
+
+ // Generates a function for a given object that returns a given property.
+ _.propertyOf = function(obj) {
+ return obj == null ? function(){} : function(key) {
+ return obj[key];
+ };
+ };
+
+ // Returns a predicate for checking whether an object has a given set of
+ // `key:value` pairs.
+ _.matcher = _.matches = function(attrs) {
+ attrs = _.extendOwn({}, attrs);
+ return function(obj) {
+ return _.isMatch(obj, attrs);
+ };
+ };
+
+ // Run a function **n** times.
+ _.times = function(n, iteratee, context) {
+ var accum = Array(Math.max(0, n));
+ iteratee = optimizeCb(iteratee, context, 1);
+ for (var i = 0; i < n; i++) accum[i] = iteratee(i);
+ return accum;
+ };
+
+ // Return a random integer between min and max (inclusive).
+ _.random = function(min, max) {
+ if (max == null) {
+ max = min;
+ min = 0;
+ }
+ return min + Math.floor(Math.random() * (max - min + 1));
+ };
+
+ // A (possibly faster) way to get the current timestamp as an integer.
+ _.now = Date.now || function() {
+ return new Date().getTime();
+ };
+
+ // List of HTML entities for escaping.
+ var escapeMap = {
+ '&': '&',
+ '<': '<',
+ '>': '>',
+ '"': '"',
+ "'": ''',
+ '`': '`'
+ };
+ var unescapeMap = _.invert(escapeMap);
+
+ // Functions for escaping and unescaping strings to/from HTML interpolation.
+ var createEscaper = function(map) {
+ var escaper = function(match) {
+ return map[match];
+ };
+ // Regexes for identifying a key that needs to be escaped
+ var source = '(?:' + _.keys(map).join('|') + ')';
+ var testRegexp = RegExp(source);
+ var replaceRegexp = RegExp(source, 'g');
+ return function(string) {
+ string = string == null ? '' : '' + string;
+ return testRegexp.test(string) ? string.replace(replaceRegexp, escaper) : string;
+ };
+ };
+ _.escape = createEscaper(escapeMap);
+ _.unescape = createEscaper(unescapeMap);
+
+ // If the value of the named `property` is a function then invoke it with the
+ // `object` as context; otherwise, return it.
+ _.result = function(object, property, fallback) {
+ var value = object == null ? void 0 : object[property];
+ if (value === void 0) {
+ value = fallback;
+ }
+ return _.isFunction(value) ? value.call(object) : value;
+ };
+
+ // Generate a unique integer id (unique within the entire client session).
+ // Useful for temporary DOM ids.
+ var idCounter = 0;
+ _.uniqueId = function(prefix) {
+ var id = ++idCounter + '';
+ return prefix ? prefix + id : id;
+ };
+
+ // By default, Underscore uses ERB-style template delimiters, change the
+ // following template settings to use alternative delimiters.
+ _.templateSettings = {
+ evaluate : /<%([\s\S]+?)%>/g,
+ interpolate : /<%=([\s\S]+?)%>/g,
+ escape : /<%-([\s\S]+?)%>/g
+ };
+
+ // When customizing `templateSettings`, if you don't want to define an
+ // interpolation, evaluation or escaping regex, we need one that is
+ // guaranteed not to match.
+ var noMatch = /(.)^/;
+
+ // Certain characters need to be escaped so that they can be put into a
+ // string literal.
+ var escapes = {
+ "'": "'",
+ '\\': '\\',
+ '\r': 'r',
+ '\n': 'n',
+ '\u2028': 'u2028',
+ '\u2029': 'u2029'
+ };
+
+ var escaper = /\\|'|\r|\n|\u2028|\u2029/g;
+
+ var escapeChar = function(match) {
+ return '\\' + escapes[match];
+ };
+
+ // JavaScript micro-templating, similar to John Resig's implementation.
+ // Underscore templating handles arbitrary delimiters, preserves whitespace,
+ // and correctly escapes quotes within interpolated code.
+ // NB: `oldSettings` only exists for backwards compatibility.
+ _.template = function(text, settings, oldSettings) {
+ if (!settings && oldSettings) settings = oldSettings;
+ settings = _.defaults({}, settings, _.templateSettings);
+
+ // Combine delimiters into one regular expression via alternation.
+ var matcher = RegExp([
+ (settings.escape || noMatch).source,
+ (settings.interpolate || noMatch).source,
+ (settings.evaluate || noMatch).source
+ ].join('|') + '|$', 'g');
+
+ // Compile the template source, escaping string literals appropriately.
+ var index = 0;
+ var source = "__p+='";
+ text.replace(matcher, function(match, escape, interpolate, evaluate, offset) {
+ source += text.slice(index, offset).replace(escaper, escapeChar);
+ index = offset + match.length;
+
+ if (escape) {
+ source += "'+\n((__t=(" + escape + "))==null?'':_.escape(__t))+\n'";
+ } else if (interpolate) {
+ source += "'+\n((__t=(" + interpolate + "))==null?'':__t)+\n'";
+ } else if (evaluate) {
+ source += "';\n" + evaluate + "\n__p+='";
+ }
+
+ // Adobe VMs need the match returned to produce the correct offest.
+ return match;
+ });
+ source += "';\n";
+
+ // If a variable is not specified, place data values in local scope.
+ if (!settings.variable) source = 'with(obj||{}){\n' + source + '}\n';
+
+ source = "var __t,__p='',__j=Array.prototype.join," +
+ "print=function(){__p+=__j.call(arguments,'');};\n" +
+ source + 'return __p;\n';
+
+ try {
+ var render = new Function(settings.variable || 'obj', '_', source);
+ } catch (e) {
+ e.source = source;
+ throw e;
+ }
+
+ var template = function(data) {
+ return render.call(this, data, _);
+ };
+
+ // Provide the compiled source as a convenience for precompilation.
+ var argument = settings.variable || 'obj';
+ template.source = 'function(' + argument + '){\n' + source + '}';
+
+ return template;
+ };
+
+ // Add a "chain" function. Start chaining a wrapped Underscore object.
+ _.chain = function(obj) {
+ var instance = _(obj);
+ instance._chain = true;
+ return instance;
+ };
+
+ // OOP
+ // ---------------
+ // If Underscore is called as a function, it returns a wrapped object that
+ // can be used OO-style. This wrapper holds altered versions of all the
+ // underscore functions. Wrapped objects may be chained.
+
+ // Helper function to continue chaining intermediate results.
+ var result = function(instance, obj) {
+ return instance._chain ? _(obj).chain() : obj;
+ };
+
+ // Add your own custom functions to the Underscore object.
+ _.mixin = function(obj) {
+ _.each(_.functions(obj), function(name) {
+ var func = _[name] = obj[name];
+ _.prototype[name] = function() {
+ var args = [this._wrapped];
+ push.apply(args, arguments);
+ return result(this, func.apply(_, args));
+ };
+ });
+ };
+
+ // Add all of the Underscore functions to the wrapper object.
+ _.mixin(_);
+
+ // Add all mutator Array functions to the wrapper.
+ _.each(['pop', 'push', 'reverse', 'shift', 'sort', 'splice', 'unshift'], function(name) {
+ var method = ArrayProto[name];
+ _.prototype[name] = function() {
+ var obj = this._wrapped;
+ method.apply(obj, arguments);
+ if ((name === 'shift' || name === 'splice') && obj.length === 0) delete obj[0];
+ return result(this, obj);
+ };
+ });
+
+ // Add all accessor Array functions to the wrapper.
+ _.each(['concat', 'join', 'slice'], function(name) {
+ var method = ArrayProto[name];
+ _.prototype[name] = function() {
+ return result(this, method.apply(this._wrapped, arguments));
+ };
+ });
+
+ // Extracts the result from a wrapped and chained object.
+ _.prototype.value = function() {
+ return this._wrapped;
+ };
+
+ // Provide unwrapping proxy for some methods used in engine operations
+ // such as arithmetic and JSON stringification.
+ _.prototype.valueOf = _.prototype.toJSON = _.prototype.value;
+
+ _.prototype.toString = function() {
+ return '' + this._wrapped;
+ };
+
+ // AMD registration happens at the end for compatibility with AMD loaders
+ // that may not enforce next-turn semantics on modules. Even though general
+ // practice for AMD registration is to be anonymous, underscore registers
+ // as a named module because, like jQuery, it is a base library that is
+ // popular enough to be bundled in a third party lib, but not be part of
+ // an AMD load request. Those cases could generate an error when an
+ // anonymous define() is called outside of a loader request.
+ if (typeof define === 'function' && define.amd) {
+ define('underscore', [], function() {
+ return _;
+ });
+ }
+}.call(this));
*
* sphinx.websupport utilities for all documentation.
*
- * :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
li.hide();
// Determine where in the parents children list to insert this comment.
- for(var i=0; i < siblings.length; i++) {
+ for(i=0; i < siblings.length; i++) {
if (comp(comment, siblings[i]) <= 0) {
$('#cd' + siblings[i].id)
.parent()
-
<!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">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
- <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/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="top" title="salomeTools 5.0.0dev documentation" href="../../index.html" />
+ <link rel="next" title="src package" href="src.html" />
<link rel="prev" title="Add a user custom command" href="../../write_command.html" />
<link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
- </head><body>
+ </head>
+ <body role="document">
<div class="document">
<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>
+<li class="toctree-l3"><a class="reference internal" href="src.example.html">src.example package</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="src.example.html#submodules">Submodules</a></li>
+<li class="toctree-l4"><a class="reference internal" href="src.example.html#module-src.example.essai_logging_1">src.example.essai_logging_1 module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="src.example.html#module-src.example.essai_logging_2">src.example.essai_logging_2 module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="src.example.html#module-src.example">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.catchAll">src.catchAll module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="src.html#module-src.coloringSat">src.coloringSat 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.configManager">src.configManager 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.environs">src.environs module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="src.html#module-src.exceptionSat">src.exceptionSat 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.loggingSat">src.loggingSat 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.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.returnCode">src.returnCode module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="src.html#module-src.salomeTools">src.salomeTools 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.utilsSat">src.utilsSat 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>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
- <li><a href="../../_sources/commands/apidoc/modules.rst.txt"
+ <li><a href="../../_sources/commands/apidoc/modules.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" />
+ <div><input type="text" name="q" /></div>
+ <div><input type="submit" value="Go" /></div>
<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>
©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>
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.9</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
|
- <a href="../../_sources/commands/apidoc/modules.rst.txt"
+ <a href="../../_sources/commands/apidoc/modules.txt"
rel="nofollow">Page source</a>
</div>
-
<!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>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>
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
- <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/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="Release notes" href="../../release_notes/release_notes_5.0.0.html" />
- <link rel="prev" title="src Package" href="src.html" />
+ <link rel="top" title="salomeTools 5.0.0dev documentation" href="../../index.html" />
+ <link rel="up" title="src package" href="src.html" />
+ <link rel="next" title="src.example package" href="src.example.html" />
+ <link rel="prev" title="src package" href="src.html" />
<link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
- </head><body>
+ </head>
+ <body role="document">
<div class="document">
<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">
<dt id="src.colorama.ansi.AnsiBack">
<em class="property">class </em><code class="descclassname">src.colorama.ansi.</code><code class="descname">AnsiBack</code><a class="reference internal" href="../../_modules/src/colorama/ansi.html#AnsiBack"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.colorama.ansi.AnsiBack" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <a class="reference internal" href="#src.colorama.ansi.AnsiCodes" title="src.colorama.ansi.AnsiCodes"><code class="xref py py-class docutils literal notranslate"><span class="pre">src.colorama.ansi.AnsiCodes</span></code></a></p>
+<dd><p>Bases: <a class="reference internal" href="#src.colorama.ansi.AnsiCodes" title="src.colorama.ansi.AnsiCodes"><code class="xref py py-class docutils literal"><span class="pre">src.colorama.ansi.AnsiCodes</span></code></a></p>
<dl class="attribute">
<dt id="src.colorama.ansi.AnsiBack.BLACK">
<code class="descname">BLACK</code><em class="property"> = 40</em><a class="headerlink" href="#src.colorama.ansi.AnsiBack.BLACK" title="Permalink to this definition">¶</a></dt>
<dl class="class">
<dt id="src.colorama.ansi.AnsiCodes">
<em class="property">class </em><code class="descclassname">src.colorama.ansi.</code><code class="descname">AnsiCodes</code><a class="reference internal" href="../../_modules/src/colorama/ansi.html#AnsiCodes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.colorama.ansi.AnsiCodes" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
</dd></dl>
<dl class="class">
<dt id="src.colorama.ansi.AnsiCursor">
<em class="property">class </em><code class="descclassname">src.colorama.ansi.</code><code class="descname">AnsiCursor</code><a class="reference internal" href="../../_modules/src/colorama/ansi.html#AnsiCursor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.colorama.ansi.AnsiCursor" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<dl class="method">
<dt id="src.colorama.ansi.AnsiCursor.BACK">
<code class="descname">BACK</code><span class="sig-paren">(</span><em>n=1</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/colorama/ansi.html#AnsiCursor.BACK"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.colorama.ansi.AnsiCursor.BACK" title="Permalink to this definition">¶</a></dt>
<dl class="class">
<dt id="src.colorama.ansi.AnsiFore">
<em class="property">class </em><code class="descclassname">src.colorama.ansi.</code><code class="descname">AnsiFore</code><a class="reference internal" href="../../_modules/src/colorama/ansi.html#AnsiFore"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.colorama.ansi.AnsiFore" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <a class="reference internal" href="#src.colorama.ansi.AnsiCodes" title="src.colorama.ansi.AnsiCodes"><code class="xref py py-class docutils literal notranslate"><span class="pre">src.colorama.ansi.AnsiCodes</span></code></a></p>
+<dd><p>Bases: <a class="reference internal" href="#src.colorama.ansi.AnsiCodes" title="src.colorama.ansi.AnsiCodes"><code class="xref py py-class docutils literal"><span class="pre">src.colorama.ansi.AnsiCodes</span></code></a></p>
<dl class="attribute">
<dt id="src.colorama.ansi.AnsiFore.BLACK">
<code class="descname">BLACK</code><em class="property"> = 30</em><a class="headerlink" href="#src.colorama.ansi.AnsiFore.BLACK" title="Permalink to this definition">¶</a></dt>
<dl class="class">
<dt id="src.colorama.ansi.AnsiStyle">
<em class="property">class </em><code class="descclassname">src.colorama.ansi.</code><code class="descname">AnsiStyle</code><a class="reference internal" href="../../_modules/src/colorama/ansi.html#AnsiStyle"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.colorama.ansi.AnsiStyle" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <a class="reference internal" href="#src.colorama.ansi.AnsiCodes" title="src.colorama.ansi.AnsiCodes"><code class="xref py py-class docutils literal notranslate"><span class="pre">src.colorama.ansi.AnsiCodes</span></code></a></p>
+<dd><p>Bases: <a class="reference internal" href="#src.colorama.ansi.AnsiCodes" title="src.colorama.ansi.AnsiCodes"><code class="xref py py-class docutils literal"><span class="pre">src.colorama.ansi.AnsiCodes</span></code></a></p>
<dl class="attribute">
<dt id="src.colorama.ansi.AnsiStyle.BRIGHT">
<code class="descname">BRIGHT</code><em class="property"> = 1</em><a class="headerlink" href="#src.colorama.ansi.AnsiStyle.BRIGHT" title="Permalink to this definition">¶</a></dt>
</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>
-<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
-<p>Implements a ‘write()’ method which, on Windows, will strip ANSI character
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
+<p>Implements a 'write()' method which, on Windows, will strip ANSI character
sequences from the text, and if outputting to a tty, will convert them into
win32 function calls.</p>
<dl class="attribute">
<dt id="src.colorama.ansitowin32.AnsiToWin32.ANSI_CSI_RE">
-<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">
<dl class="class">
<dt id="src.colorama.ansitowin32.StreamWrapper">
<em class="property">class </em><code class="descclassname">src.colorama.ansitowin32.</code><code class="descname">StreamWrapper</code><span class="sig-paren">(</span><em>wrapped</em>, <em>converter</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/colorama/ansitowin32.html#StreamWrapper"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.colorama.ansitowin32.StreamWrapper" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>Wraps a stream (such as stdout), acting as a transparent proxy for all
-attribute access apart from method ‘write()’, which is delegated to our
+attribute access apart from method 'write()', which is delegated to our
Converter instance.</p>
<dl class="method">
<dt id="src.colorama.ansitowin32.StreamWrapper.write">
</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><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<dl class="attribute">
<dt id="src.colorama.winterm.WinColor.BLACK">
<code class="descname">BLACK</code><em class="property"> = 0</em><a class="headerlink" href="#src.colorama.winterm.WinColor.BLACK" title="Permalink to this definition">¶</a></dt>
<dl class="class">
<dt id="src.colorama.winterm.WinStyle">
<em class="property">class </em><code class="descclassname">src.colorama.winterm.</code><code class="descname">WinStyle</code><a class="reference internal" href="../../_modules/src/colorama/winterm.html#WinStyle"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.colorama.winterm.WinStyle" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<dl class="attribute">
<dt id="src.colorama.winterm.WinStyle.BRIGHT">
<code class="descname">BRIGHT</code><em class="property"> = 8</em><a class="headerlink" href="#src.colorama.winterm.WinStyle.BRIGHT" title="Permalink to this definition">¶</a></dt>
<dl class="class">
<dt id="src.colorama.winterm.WinTerm">
<em class="property">class </em><code class="descclassname">src.colorama.winterm.</code><code class="descname">WinTerm</code><a class="reference internal" href="../../_modules/src/colorama/winterm.html#WinTerm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.colorama.winterm.WinTerm" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<dl class="method">
<dt id="src.colorama.winterm.WinTerm.back">
<code class="descname">back</code><span class="sig-paren">(</span><em>back=None</em>, <em>light=False</em>, <em>on_stderr=False</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/colorama/winterm.html#WinTerm.back"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.colorama.winterm.WinTerm.back" title="Permalink to this definition">¶</a></dt>
</dd></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>Next: <a href="../../release_notes/release_notes_5.0.0.html" title="next chapter">Release notes</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="src.example.html" title="next chapter">src.example package</a></li>
</ul></li>
</ul></li>
</ul></li>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
- <li><a href="../../_sources/commands/apidoc/src.colorama.rst.txt"
+ <li><a href="../../_sources/commands/apidoc/src.colorama.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" />
+ <div><input type="text" name="q" /></div>
+ <div><input type="submit" value="Go" /></div>
<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>
©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>
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.9</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
|
- <a href="../../_sources/commands/apidoc/src.colorama.rst.txt"
+ <a href="../../_sources/commands/apidoc/src.colorama.txt"
rel="nofollow">Page source</a>
</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="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>src.example 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">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+ <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/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="top" title="salomeTools 5.0.0dev documentation" href="../../index.html" />
+ <link rel="up" title="src package" href="src.html" />
+ <link rel="next" title="Release notes" href="../../release_notes/release_notes_5.0.0.html" />
+ <link rel="prev" title="src.colorama package" href="src.colorama.html" />
+
+ <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+ </head>
+ <body role="document">
+
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <div class="section" id="src-example-package">
+<h1>src.example package<a class="headerlink" href="#src-example-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.example.essai_logging_1">
+<span id="src-example-essai-logging-1-module"></span><h2>src.example.essai_logging_1 module<a class="headerlink" href="#module-src.example.essai_logging_1" title="Permalink to this headline">¶</a></h2>
+<p><a class="reference external" href="http://sametmax.com/ecrire-des-logs-en-python/">http://sametmax.com/ecrire-des-logs-en-python/</a>
+<a class="reference external" href="https://docs.python.org/3/library/time.html#time.strftime">https://docs.python.org/3/library/time.html#time.strftime</a></p>
+<p>essai utilisation logger plusieurs handler format different</p>
+<blockquote>
+<div><p>/usr/lib/python2.7/logging/__init__.pyc</p>
+<p>init MyLogger, fmt='%(asctime)s :: %(levelname)-8s :: %(message)s', level='20'</p>
+<p>2018-03-11 18:51:21 :: INFO :: test logger info
+2018-03-11 18:51:21 :: WARNING :: test logger warning
+2018-03-11 18:51:21 :: ERROR :: test logger error
+2018-03-11 18:51:21 :: CRITICAL :: test logger critical</p>
+<p>init MyLogger, fmt='None', level='10'</p>
+<p>2018-03-11 18:51:21 :: DEBUG :: test logger debug
+test logger debug
+2018-03-11 18:51:21 :: INFO :: test logger info
+test logger info
+2018-03-11 18:51:21 :: WARNING :: test logger warning
+test logger warning
+2018-03-11 18:51:21 :: ERROR :: test logger error
+test logger error
+2018-03-11 18:51:21 :: CRITICAL :: test logger critical
+test logger critical</p>
+</div></blockquote>
+<dl class="function">
+<dt id="src.example.essai_logging_1.getMyLogger">
+<code class="descclassname">src.example.essai_logging_1.</code><code class="descname">getMyLogger</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/example/essai_logging_1.html#getMyLogger"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.example.essai_logging_1.getMyLogger" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="function">
+<dt id="src.example.essai_logging_1.initMyLogger">
+<code class="descclassname">src.example.essai_logging_1.</code><code class="descname">initMyLogger</code><span class="sig-paren">(</span><em>fmt=None</em>, <em>level=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/example/essai_logging_1.html#initMyLogger"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.example.essai_logging_1.initMyLogger" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="function">
+<dt id="src.example.essai_logging_1.testLogger1">
+<code class="descclassname">src.example.essai_logging_1.</code><code class="descname">testLogger1</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/example/essai_logging_1.html#testLogger1"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.example.essai_logging_1.testLogger1" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</div>
+<div class="section" id="module-src.example.essai_logging_2">
+<span id="src-example-essai-logging-2-module"></span><h2>src.example.essai_logging_2 module<a class="headerlink" href="#module-src.example.essai_logging_2" title="Permalink to this headline">¶</a></h2>
+<p><a class="reference external" href="http://sametmax.com/ecrire-des-logs-en-python/">http://sametmax.com/ecrire-des-logs-en-python/</a>
+<a class="reference external" href="https://docs.python.org/3/library/time.html#time.strftime">https://docs.python.org/3/library/time.html#time.strftime</a></p>
+<p>essai utilisation logger un handler format different
+sur info() pas de format et su other format</p>
+<blockquote>
+<div><p>/usr/lib/python2.7/logging/__init__.pyc</p>
+<p>init MyLogger, fmt='%(asctime)s :: %(levelname)-8s :: %(message)s', level='20'</p>
+<p>test logger info
+2018-03-11 18:51:51 :: WARNING :: test logger warning
+2018-03-11 18:51:51 :: ERROR :: test logger error
+2018-03-11 18:51:51 :: CRITICAL :: test logger critical</p>
+</div></blockquote>
+<dl class="class">
+<dt id="src.example.essai_logging_2.MyFormatter">
+<em class="property">class </em><code class="descclassname">src.example.essai_logging_2.</code><code class="descname">MyFormatter</code><span class="sig-paren">(</span><em>fmt=None</em>, <em>datefmt=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/example/essai_logging_2.html#MyFormatter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.example.essai_logging_2.MyFormatter" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">logging.Formatter</span></code></p>
+<dl class="method">
+<dt id="src.example.essai_logging_2.MyFormatter.format">
+<code class="descname">format</code><span class="sig-paren">(</span><em>record</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/example/essai_logging_2.html#MyFormatter.format"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.example.essai_logging_2.MyFormatter.format" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="function">
+<dt id="src.example.essai_logging_2.getMyLogger">
+<code class="descclassname">src.example.essai_logging_2.</code><code class="descname">getMyLogger</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/example/essai_logging_2.html#getMyLogger"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.example.essai_logging_2.getMyLogger" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="function">
+<dt id="src.example.essai_logging_2.initMyLogger">
+<code class="descclassname">src.example.essai_logging_2.</code><code class="descname">initMyLogger</code><span class="sig-paren">(</span><em>fmt=None</em>, <em>level=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/example/essai_logging_2.html#initMyLogger"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.example.essai_logging_2.initMyLogger" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="function">
+<dt id="src.example.essai_logging_2.testLogger1">
+<code class="descclassname">src.example.essai_logging_2.</code><code class="descname">testLogger1</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/example/essai_logging_2.html#testLogger1"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.example.essai_logging_2.testLogger1" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</div>
+<div class="section" id="module-src.example">
+<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-src.example" title="Permalink to this headline">¶</a></h2>
+</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="#">src.example package</a><ul>
+<li><a class="reference internal" href="#submodules">Submodules</a></li>
+<li><a class="reference internal" href="#module-src.example.essai_logging_1">src.example.essai_logging_1 module</a></li>
+<li><a class="reference internal" href="#module-src.example.essai_logging_2">src.example.essai_logging_2 module</a></li>
+<li><a class="reference internal" href="#module-src.example">Module contents</a></li>
+</ul>
+</li>
+</ul>
+<div class="relations">
+<h3>Related Topics</h3>
+<ul>
+ <li><a href="../../index.html">Documentation overview</a><ul>
+ <li><a href="modules.html">src</a><ul>
+ <li><a href="src.html">src package</a><ul>
+ <li>Previous: <a href="src.colorama.html" title="previous chapter">src.colorama package</a></li>
+ <li>Next: <a href="../../release_notes/release_notes_5.0.0.html" title="next chapter">Release notes</a></li>
+ </ul></li>
+ </ul></li>
+ </ul></li>
+</ul>
+</div>
+ <div role="note" aria-label="source link">
+ <h3>This Page</h3>
+ <ul class="this-page-menu">
+ <li><a href="../../_sources/commands/apidoc/src.example.txt"
+ rel="nofollow">Show Source</a></li>
+ </ul>
+ </div>
+<div id="searchbox" style="display: none" role="search">
+ <h3>Quick search</h3>
+ <form class="search" action="../../search.html" method="get">
+ <div><input type="text" name="q" /></div>
+ <div><input type="submit" value="Go" /></div>
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</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.4.9</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
+
+ |
+ <a href="../../_sources/commands/apidoc/src.example.txt"
+ rel="nofollow">Page source</a>
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
-
<!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 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">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
- <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/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="top" title="salomeTools 5.0.0dev documentation" href="../../index.html" />
+ <link rel="up" title="src" href="modules.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" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
- </head><body>
+ </head>
+ <body role="document">
<div class="document">
<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>
+<li class="toctree-l1"><a class="reference internal" href="src.example.html">src.example package</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="src.example.html#submodules">Submodules</a></li>
+<li class="toctree-l2"><a class="reference internal" href="src.example.html#module-src.example.essai_logging_1">src.example.essai_logging_1 module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="src.example.html#module-src.example.essai_logging_2">src.example.essai_logging_2 module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="src.example.html#module-src.example">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>
+<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>
-<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>
+</div>
+<div class="section" id="module-src.catchAll">
+<span id="src-catchall-module"></span><h2>src.catchAll module<a class="headerlink" href="#module-src.catchAll" title="Permalink to this headline">¶</a></h2>
+<p>define class as a simple dictionary with keys
+with pretty print __str__ and __repr__ (indented as recursive)
+and jsonDumps()</p>
+<dl class="docutils">
+<dt>usage:</dt>
+<dd>>> import catchAll as CAA
+>> a = CAA.CatchAll()
+>> a.tintin = "reporter"
+>> a.milou = "dog"
+>> print("a=%s" % a)
+>> print("tintin: %s" % a.tintin)</dd>
+</dl>
+<dl class="class">
+<dt id="src.catchAll.CatchAll">
+<em class="property">class </em><code class="descclassname">src.catchAll.</code><code class="descname">CatchAll</code><a class="reference internal" href="../../_modules/src/catchAll.html#CatchAll"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.catchAll.CatchAll" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
+<p>class as simple dynamic dictionary
+with predefined keys as properties in
+inherited classes through __init__ method. Or NOT.
+with pretty print __str__ and __repr__ (indented as recursive)
+with jsonDumps()</p>
+<p>usage:</p>
+<p>>> import catchAll as CAA
+>> a = CAA.CatchAll()
+>> a.tintin = "reporter"
+>> a.milou = "dog"
+>> print("a=%s" % a)
+>> print("tintin: %s" % a.tintin)</p>
+<p>as</p>
+<p>>> a = {}
+>> a["tintin"] = "reporter"
+>> a["milou"] = "dog"
+>> print("tintin: %s" % a["tintin"]</p>
+<dl class="method">
+<dt id="src.catchAll.CatchAll.jsonDumps">
+<code class="descname">jsonDumps</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/catchAll.html#CatchAll.jsonDumps"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.catchAll.CatchAll.jsonDumps" 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>
+</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>
+<dt id="src.catchAll.dumper">
+<code class="descclassname">src.catchAll.</code><code class="descname">dumper</code><span class="sig-paren">(</span><em>obj</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/catchAll.html#dumper"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.catchAll.dumper" title="Permalink to this definition">¶</a></dt>
+<dd><p>to json explore subclass object as dict</p>
+</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>
+<dt id="src.catchAll.dumperType">
+<code class="descclassname">src.catchAll.</code><code class="descname">dumperType</code><span class="sig-paren">(</span><em>obj</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/catchAll.html#dumperType"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.catchAll.dumperType" title="Permalink to this definition">¶</a></dt>
+<dd><p>to get a "_type" to trace json subclass object,
+but ignore all attributes begining with '_'</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>
+<dt id="src.catchAll.jsonDumps">
+<code class="descclassname">src.catchAll.</code><code class="descname">jsonDumps</code><span class="sig-paren">(</span><em>obj</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/catchAll.html#jsonDumps"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.catchAll.jsonDumps" title="Permalink to this definition">¶</a></dt>
+<dd><p>to get direct default jsonDumps method</p>
</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>
+</div>
+<div class="section" id="module-src.coloringSat">
+<span id="src-coloringsat-module"></span><h2>src.coloringSat module<a class="headerlink" href="#module-src.coloringSat" title="Permalink to this headline">¶</a></h2>
+<p>simple tagging as '<color>' for simple coloring log messages on terminal(s)
+window or unix or ios using backend colorama</p>
+<p>using '<color>' because EZ human readable
+so '<color>' are not supposed existing in log message
+"{}".format() is not choosen because "{}" are present
+in log messages of contents of python dict (as JSON) etc.</p>
+<p>example:
+>> log("this is in <green>color green<reset>, OK is in blue: <blue>OK?")</p>
+<dl class="class">
+<dt id="src.coloringSat.ColoringStream">
+<em class="property">class </em><code class="descclassname">src.coloringSat.</code><code class="descname">ColoringStream</code><a class="reference internal" href="../../_modules/src/coloringSat.html#ColoringStream"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.coloringSat.ColoringStream" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
+<p>write my stream class
+only write and flush are used for the streaming
+<a class="reference external" href="https://docs.python.org/2/library/logging.handlers.html">https://docs.python.org/2/library/logging.handlers.html</a>
+<a class="reference external" href="https://stackoverflow.com/questions/31999627/storing-logger-messages-in-a-string">https://stackoverflow.com/questions/31999627/storing-logger-messages-in-a-string</a></p>
+<dl class="method">
+<dt id="src.coloringSat.ColoringStream.flush">
+<code class="descname">flush</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/coloringSat.html#ColoringStream.flush"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.coloringSat.ColoringStream.flush" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.coloringSat.ColoringStream.write">
+<code class="descname">write</code><span class="sig-paren">(</span><em>astr</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/coloringSat.html#ColoringStream.write"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.coloringSat.ColoringStream.write" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
</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>
+<dt id="src.coloringSat.cleanColors">
+<code class="descclassname">src.coloringSat.</code><code class="descname">cleanColors</code><span class="sig-paren">(</span><em>msg</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/coloringSat.html#cleanColors"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.coloringSat.cleanColors" title="Permalink to this definition">¶</a></dt>
+<dd><p>clean the message of color tags '<red> ...</p>
+</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>
-<table class="docutils field-list" frame="void" rules="none">
-<col class="field-name" />
-<col class="field-body" />
-<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>List</strong> (<em>input_list</em>) – The list to modify</td>
-</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The without any item</td>
-</tr>
-<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">List</td>
-</tr>
-</tbody>
-</table>
+<dt id="src.coloringSat.indent">
+<code class="descclassname">src.coloringSat.</code><code class="descname">indent</code><span class="sig-paren">(</span><em>msg</em>, <em>nb</em>, <em>car=' '</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/coloringSat.html#indent"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.coloringSat.indent" title="Permalink to this definition">¶</a></dt>
+<dd><p>indent nb car (spaces) multi lines message except first one</p>
</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>
+<dt id="src.coloringSat.log">
+<code class="descclassname">src.coloringSat.</code><code class="descname">log</code><span class="sig-paren">(</span><em>msg</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/coloringSat.html#log"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.coloringSat.log" title="Permalink to this definition">¶</a></dt>
+<dd><p>elementary log stdout for debug if _verbose</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>
+<dt id="src.coloringSat.replace">
+<code class="descclassname">src.coloringSat.</code><code class="descname">replace</code><span class="sig-paren">(</span><em>msg</em>, <em>tags</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/coloringSat.html#replace"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.coloringSat.replace" 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>
+<dt id="src.coloringSat.toColor">
+<code class="descclassname">src.coloringSat.</code><code class="descname">toColor</code><span class="sig-paren">(</span><em>msg</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/coloringSat.html#toColor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.coloringSat.toColor" title="Permalink to this definition">¶</a></dt>
+<dd><p>automatically clean the message of color tags '<red> ...
+if the terminal output stdout is redirected by user
+if not, replace tags with ansi color codes</p>
+<p>example:
+>> sat compile SALOME > log.txt</p>
+</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>
+<dt id="src.coloringSat.toColor_AnsiToWin32">
+<code class="descclassname">src.coloringSat.</code><code class="descname">toColor_AnsiToWin32</code><span class="sig-paren">(</span><em>msg</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/coloringSat.html#toColor_AnsiToWin32"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.coloringSat.toColor_AnsiToWin32" title="Permalink to this definition">¶</a></dt>
+<dd><p>for test debug no wrapping</p>
+</dd></dl>
+</div>
+<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>
+<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.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.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.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.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.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.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.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.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.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.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.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.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>
+<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><p>Performs a build with a script.</p>
</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>
+<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="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>
+<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="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>
+<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><p>Shortcut method to log in log file.</p>
</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>
-<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>
-<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.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>
+<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><p>Shortcut method to log a command.</p>
+</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.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.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>
-
+<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><p>Prepares the environment.
+Build two environment: one for building and one for testing (launch).</p>
</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>
-<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>
-<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>
-<dd></dd></dl>
+<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>
+</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>
+<dt id="src.compilation.Builder.wmake">
+<code class="descname">wmake</code><span class="sig-paren">(</span><em>nb_proc</em>, <em>opt_nb_proc=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/compilation.html#Builder.wmake"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.compilation.Builder.wmake" title="Permalink to this definition">¶</a></dt>
<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>
+<div class="section" id="module-src.configManager">
+<span id="src-configmanager-module"></span><h2>src.configManager module<a class="headerlink" href="#module-src.configManager" title="Permalink to this headline">¶</a></h2>
+<dl class="class">
+<dt id="src.configManager.ConfigManager">
+<em class="property">class </em><code class="descclassname">src.configManager.</code><code class="descname">ConfigManager</code><span class="sig-paren">(</span><em>runner</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/configManager.html#ConfigManager"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.configManager.ConfigManager" title="Permalink to this definition">¶</a></dt>
+<dd><p>Class that manages the read of all the config .pyconf files of salomeTools</p>
+<dl class="method">
+<dt id="src.configManager.ConfigManager.create_config_file">
+<code class="descname">create_config_file</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/configManager.html#ConfigManager.create_config_file"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.configManager.ConfigManager.create_config_file" title="Permalink to this definition">¶</a></dt>
+<dd><dl class="docutils">
+<dt>This method is called when there are no user config file. </dt>
+<dd>It build it from scratch.</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 class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>class 'PYCONF.Config'</strong> (<em>config</em>) -- The global config.</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 class="field-even field"><th class="field-name">Returns:</th><td class="field-body">the config corresponding to the file created.</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-odd field"><th class="field-name">Return type:</th><td class="field-body">config class 'PYCONF.Config'</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>
+<dl class="method">
+<dt id="src.configManager.ConfigManager.get_command_line_overrides">
+<code class="descname">get_command_line_overrides</code><span class="sig-paren">(</span><em>options</em>, <em>sections</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/configManager.html#ConfigManager.get_command_line_overrides"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.configManager.ConfigManager.get_command_line_overrides" title="Permalink to this definition">¶</a></dt>
+<dd><p>get all the overwrites that are in the command line</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>L{Mapping}</strong> (<em>codes</em>) – The map containing distribution correlation table.</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>options</strong> -- the options from salomeTools class
+initialization (like -l5 or --overwrite)</li>
+<li><strong>str</strong> (<em>sections</em>) -- The config section to overwrite.</li>
+</ul>
+</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 class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The list of all the overwrites to apply.</p>
+</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"><p class="first last"><a class="reference internal" href="#src.utilsSat.Path.list" title="src.utilsSat.Path.list">list</a></p>
+</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>
+<dl class="method">
+<dt id="src.configManager.ConfigManager.get_config">
+<code class="descname">get_config</code><span class="sig-paren">(</span><em>application=None</em>, <em>options=None</em>, <em>command=None</em>, <em>datadir=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/configManager.html#ConfigManager.get_config"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.configManager.ConfigManager.get_config" title="Permalink to this definition">¶</a></dt>
+<dd><p>get the config from all the configuration files.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the number of processors.</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>str</strong> (<em>datadir</em>) -- The application for which salomeTools is called.</li>
+<li><strong>class Options</strong> (<a class="reference internal" href="#module-src.options" title="src.options"><em>options</em></a>) -- The general salomeTools
+options (--overwrite or -v5, for example)</li>
+<li><strong>str</strong> -- The command that is called.</li>
+<li><strong>str</strong> -- The repository that contain
+external data for salomeTools.</li>
+</ul>
+</td>
</tr>
-<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">str</td>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The final config.</p>
+</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">class 'PYCONF.Config'</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.configManager.ConfigManager.get_user_config_file">
+<code class="descname">get_user_config_file</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/configManager.html#ConfigManager.get_user_config_file"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.configManager.ConfigManager.get_user_config_file" title="Permalink to this definition">¶</a></dt>
+<dd><p>Get the user config file
+:return: path to the user config file.
+:rtype: str</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.configManager.ConfigManager.set_user_config_file">
+<code class="descname">set_user_config_file</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/configManager.html#ConfigManager.set_user_config_file"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.configManager.ConfigManager.set_user_config_file" title="Permalink to this definition">¶</a></dt>
+<dd><p>Set the user config file name and path.
+If necessary, build it from another one or create it from scratch.</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 'PYCONF.Config'</strong> (<em>config</em>) -- The global config
+(containing all pyconf).</td>
</tr>
</tbody>
</table>
</dd></dl>
+</dd></dl>
+
+<dl class="class">
+<dt id="src.configManager.ConfigOpener">
+<em class="property">class </em><code class="descclassname">src.configManager.</code><code class="descname">ConfigOpener</code><span class="sig-paren">(</span><em>pathList</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/configManager.html#ConfigOpener"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.configManager.ConfigOpener" title="Permalink to this definition">¶</a></dt>
+<dd><p>Class that helps to find an application pyconf
+in all the possible directories (pathList)</p>
+<dl class="method">
+<dt id="src.configManager.ConfigOpener.get_path">
+<code class="descname">get_path</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/configManager.html#ConfigOpener.get_path"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.configManager.ConfigOpener.get_path" title="Permalink to this definition">¶</a></dt>
+<dd><p>The method that returns the entire path of the pyconf searched
+:param name str: The name of the searched pyconf.</p>
+</dd></dl>
+
+</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>
+<dt id="src.configManager.check_path">
+<code class="descclassname">src.configManager.</code><code class="descname">check_path</code><span class="sig-paren">(</span><em>path</em>, <em>ext=[]</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/configManager.html#check_path"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.configManager.check_path" title="Permalink to this definition">¶</a></dt>
+<dd><dl class="docutils">
+<dt>Construct a text with the input path and "not found" if it does not</dt>
+<dd>exist.</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 version of the running python.</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>Str</strong> (<em>path</em>) -- the path to check.</li>
+<li><strong>List</strong> (<em>ext</em>) -- An extension. Verify that the path extension
+is in the list</li>
+</ul>
+</td>
</tr>
-<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">str</td>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The string of the path with information</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_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>
+<dt id="src.configManager.getConfigColored">
+<code class="descclassname">src.configManager.</code><code class="descname">getConfigColored</code><span class="sig-paren">(</span><em>config</em>, <em>path</em>, <em>stream</em>, <em>show_label=False</em>, <em>level=0</em>, <em>show_full_path=False</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/configManager.html#getConfigColored"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.configManager.getConfigColored" title="Permalink to this definition">¶</a></dt>
+<dd><p>Get a colored representation value from a config pyconf instance.
+used recursively from the initial path.</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 class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>class 'PYCONF.Config'</strong> (<em>config</em>) -- The configuration from which the value is displayed.</li>
+<li><strong>str</strong> (<em>path</em>) -- the path in the configuration of the value to print.</li>
+<li><strong>boolean</strong> (<em>show_label</em>) -- if True, do a basic display. (useful for bash completion)</li>
+<li><strong>stream</strong> -- the output stream used</li>
+<li><strong>int</strong> (<em>level</em>) -- The number of spaces to add before display.</li>
+<li><strong>show_full_path</strong> -- display full path, else relative</li>
+</ul>
+</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>
+<dt id="src.configManager.get_config_children">
+<code class="descclassname">src.configManager.</code><code class="descname">get_config_children</code><span class="sig-paren">(</span><em>config</em>, <em>args</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/configManager.html#get_config_children"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.configManager.get_config_children" title="Permalink to this definition">¶</a></dt>
+<dd><p>Gets the names of the children of the given parameter.
+Useful only for completion mechanism</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 class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>Config</strong> (<em>config</em>) -- The configuration where to read the values</li>
+<li><strong>args</strong> -- The path in the config from which get the keys</li>
+</ul>
+</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="function">
+<dt id="src.configManager.get_products_list">
+<code class="descclassname">src.configManager.</code><code class="descname">get_products_list</code><span class="sig-paren">(</span><em>self</em>, <em>options</em>, <em>cfg</em>, <em>logger</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/configManager.html#get_products_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.configManager.get_products_list" title="Permalink to this definition">¶</a></dt>
+<dd><p>Gives the product list with their informations from
+configuration regarding the passed options.</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>Options</strong> (<a class="reference internal" href="#module-src.options" title="src.options"><em>options</em></a>) -- The Options instance that stores the commands arguments</li>
+<li><strong>Config</strong> (<em>config</em>) -- The global configuration</li>
+<li><strong>Logger</strong> (<em>logger</em>) -- The logger instance to use for the display and logging</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The list of (product name, product_informations).</p>
+</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">List</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
-<dl class="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="function">
+<dt id="src.configManager.print_debug">
+<code class="descclassname">src.configManager.</code><code class="descname">print_debug</code><span class="sig-paren">(</span><em>config</em>, <em>path</em>, <em>logger</em>, <em>show_label=False</em>, <em>level=0</em>, <em>show_full_path=False</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/configManager.html#print_debug"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.configManager.print_debug" title="Permalink to this definition">¶</a></dt>
+<dd><p>logger output for debugging a config/pyconf
+lines contains: path : expression --> 'evaluation'</p>
+<p>example:
+PROJECTS.projects.salome.project_path : $PWD --> '/tmp/SALOME'</p>
+</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="function">
+<dt id="src.configManager.print_value">
+<code class="descclassname">src.configManager.</code><code class="descname">print_value</code><span class="sig-paren">(</span><em>config</em>, <em>path</em>, <em>logger</em>, <em>show_label=False</em>, <em>level=0</em>, <em>show_full_path=False</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/configManager.html#print_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.configManager.print_value" title="Permalink to this definition">¶</a></dt>
+<dd><p>print a colored representation value from a config pyconf instance.
+used recursively from the initial path.</p>
+<p>:param see getConfigColored</p>
+</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>
+<dl class="function">
+<dt id="src.configManager.show_patchs">
+<code class="descclassname">src.configManager.</code><code class="descname">show_patchs</code><span class="sig-paren">(</span><em>config</em>, <em>logger</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/configManager.html#show_patchs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.configManager.show_patchs" title="Permalink to this definition">¶</a></dt>
+<dd><p>Prints all the used patchs in the application.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Str</strong> (<em>file_name</em>) – the name of the file to write</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>Config</strong> (<em>config</em>) -- the global configuration.</li>
+<li><strong>Logger</strong> (<em>logger</em>) -- The logger instance to use for the display</li>
+</ul>
+</td>
</tr>
</tbody>
</table>
</dd></dl>
-<dl class="method">
-<dt id="src.compilation.Builder.wmake">
-<code class="descname">wmake</code><span class="sig-paren">(</span><em>nb_proc</em>, <em>opt_nb_proc=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/compilation.html#Builder.wmake"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.compilation.Builder.wmake" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
+<dl class="function">
+<dt id="src.configManager.show_product_info">
+<code class="descclassname">src.configManager.</code><code class="descname">show_product_info</code><span class="sig-paren">(</span><em>config</em>, <em>name</em>, <em>logger</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/configManager.html#show_product_info"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.configManager.show_product_info" title="Permalink to this definition">¶</a></dt>
+<dd><p>Display on the terminal and logger information about a product.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>Config</strong> (<em>config</em>) -- the global configuration.</li>
+<li><strong>Str</strong> (<em>name</em>) -- The name of the product</li>
+<li><strong>Logger</strong> (<em>logger</em>) -- The logger instance to use for the display</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
</dd></dl>
</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>
-<p>This file assume DEBUG functionalities use</p>
-<ul class="simple">
-<li>print debug messages in sys.stderr for salomeTools</li>
-<li>show pretty print debug representation from instances of SAT classes
-(pretty print src.pyconf.Config), and python dict/list etc. (as ‘aVariable’)</li>
-</ul>
-<p>WARNING: obviously supposedly show messages in SAT development phase, not production</p>
+<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
+Print salomeTools debug messages in sys.stderr.
+Show pretty print debug representation from instances of SAT classes
+(pretty print src.pyconf.Config)</p>
+<p>WARNING: supposedly show messages in SAT development phase, not production</p>
<p>usage:
>> import debug as DBG
->> DBG.write(“aTitle”, aVariable) # not shown in production
->> DBG.write(“aTitle”, aVariable, True) # unconditionaly shown (as show=True)</p>
-<p>to set show message as development phase:
->> DBG.push_debug(True)</p>
-<p>to set no show message as production phase:
->> DBG.push_debug(False)</p>
-<p>to set show message temporary as development phase, only in a method:
->> def aMethodToDebug(…):
->> DBG.push_debug(True) #force show as appended status
->> etc. method code with some DBG.write()
->> DBG.pop_debug() #restore previous status (show or not show)
->> return</p>
-<p>to set a message for future fix, as temporary problem to not forget:
-DBG.tofix(“aTitle”, aVariable, True/False) #True/False in production shown, or not</p>
-<p>in command line interface you could redirect stderr to file ‘myDebug.log’:
->> sat compile … 2> myDebug.log # only stderr
->> sat compile … &> myDebug.log # stdout and stderr</p>
+>> DBG.write("aTitle", aVariable) # not shown in production
+>> DBG.write("aTitle", aVariable, True) # unconditionaly shown</p>
<dl class="class">
<dt id="src.debug.InStream">
<em class="property">class </em><code class="descclassname">src.debug.</code><code class="descname">InStream</code><span class="sig-paren">(</span><em>buf=''</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/debug.html#InStream"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.debug.InStream" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">StringIO.StringIO</span></code></p>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">StringIO.StringIO</span></code></p>
<p>utility class for pyconf.Config input iostream</p>
</dd></dl>
<dl class="class">
<dt id="src.debug.OutStream">
<em class="property">class </em><code class="descclassname">src.debug.</code><code class="descname">OutStream</code><span class="sig-paren">(</span><em>buf=''</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/debug.html#OutStream"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.debug.OutStream" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">StringIO.StringIO</span></code></p>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">StringIO.StringIO</span></code></p>
<p>utility class for pyconf.Config output iostream</p>
<dl class="method">
<dt id="src.debug.OutStream.close">
<dl class="function">
<dt id="src.debug.getStrConfigStd">
<code class="descclassname">src.debug.</code><code class="descname">getStrConfigStd</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/debug.html#getStrConfigStd"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.debug.getStrConfigStd" title="Permalink to this definition">¶</a></dt>
-<dd><p>set string as saveConfigStd, as file .pyconf</p>
+<dd><p>set string as saveConfigStd,
+as file .pyconf</p>
</dd></dl>
<dl class="function">
<dt id="src.debug.tofix">
<code class="descclassname">src.debug.</code><code class="descname">tofix</code><span class="sig-paren">(</span><em>title</em>, <em>var=''</em>, <em>force=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/debug.html#tofix"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.debug.tofix" title="Permalink to this definition">¶</a></dt>
<dd><p>write sys.stderr a message if _debug[-1]==True or optionaly force=True
-use this only if no logger accessible for classic
-logger.warning(message) or logger.debug(message)</p>
+use this only if no logger accessible for classic logger.warning(message)</p>
</dd></dl>
<dl class="function">
</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>
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
-<li><strong>str</strong> (<em>sep</em>) – the environment variable to append</li>
-<li><strong>str</strong><strong> or </strong><strong>list</strong> (<em>value</em>) – the value(s) to append to key</li>
-<li><strong>str</strong> – the separator string</li>
+<li><strong>str</strong> (<em>sep</em>) -- the environment variable to append</li>
+<li><strong>str or list</strong> (<em>value</em>) -- the value(s) to append to key</li>
+<li><strong>str</strong> -- the separator string</li>
</ul>
</td>
</tr>
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
-<li><strong>str</strong> (<em>sep</em>) – the environment variable to append</li>
-<li><strong>str</strong> – the value to append to key</li>
-<li><strong>str</strong> – the separator string</li>
+<li><strong>str</strong> (<em>sep</em>) -- the environment variable to append</li>
+<li><strong>str</strong> -- the value to append to key</li>
+<li><strong>str</strong> -- the separator string</li>
</ul>
</td>
</tr>
<dl class="method">
<dt id="src.environment.Environ.command_value">
<code class="descname">command_value</code><span class="sig-paren">(</span><em>key</em>, <em>command</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/environment.html#Environ.command_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.environment.Environ.command_value" title="Permalink to this definition">¶</a></dt>
-<dd><p>Get the value given by the system command “command”
-and put it in the environment variable key</p>
+<dd><dl class="docutils">
+<dt>Get the value given by the system command "command" </dt>
+<dd>and put it in the environment variable key</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 last simple">
-<li><strong>str</strong> (<em>command</em>) – the environment variable</li>
-<li><strong>str</strong> – the command to execute</li>
+<li><strong>str</strong> (<em>command</em>) -- the environment variable</li>
+<li><strong>str</strong> -- the command to execute</li>
</ul>
</td>
</tr>
<dl class="method">
<dt id="src.environment.Environ.get">
<code class="descname">get</code><span class="sig-paren">(</span><em>key</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/environment.html#Environ.get"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.environment.Environ.get" title="Permalink to this definition">¶</a></dt>
-<dd><p>Get the value of the environment variable “key”</p>
+<dd><p>Get the value of the environment variable "key"</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>key</em>) – the environment variable</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>key</em>) -- the environment variable</td>
</tr>
</tbody>
</table>
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>key</em>) – the environment variable to check</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>key</em>) -- the environment variable to check</td>
</tr>
</tbody>
</table>
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
-<li><strong>str</strong> (<em>sep</em>) – the environment variable to prepend</li>
-<li><strong>str</strong><strong> or </strong><strong>list</strong> (<em>value</em>) – the value(s) to prepend to key</li>
-<li><strong>str</strong> – the separator string</li>
+<li><strong>str</strong> (<em>sep</em>) -- the environment variable to prepend</li>
+<li><strong>str or list</strong> (<em>value</em>) -- the value(s) to prepend to key</li>
+<li><strong>str</strong> -- the separator string</li>
</ul>
</td>
</tr>
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
-<li><strong>str</strong> (<em>sep</em>) – the environment variable to prepend</li>
-<li><strong>str</strong> – the value to prepend to key</li>
-<li><strong>str</strong> – the separator string</li>
+<li><strong>str</strong> (<em>sep</em>) -- the environment variable to prepend</li>
+<li><strong>str</strong> -- the value to prepend to key</li>
+<li><strong>str</strong> -- the separator string</li>
</ul>
</td>
</tr>
<dl class="method">
<dt id="src.environment.Environ.set">
<code class="descname">set</code><span class="sig-paren">(</span><em>key</em>, <em>value</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/environment.html#Environ.set"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.environment.Environ.set" title="Permalink to this definition">¶</a></dt>
-<dd><p>Set the environment variable “key” to value “value”</p>
+<dd><p>Set the environment variable "key" to value "value"</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
-<li><strong>str</strong> (<em>value</em>) – the environment variable to set</li>
-<li><strong>str</strong> – the value</li>
+<li><strong>str</strong> (<em>value</em>) -- the environment variable to set</li>
+<li><strong>str</strong> -- the value</li>
</ul>
</td>
</tr>
<dl class="method">
<dt id="src.environment.FileEnvWriter.write_cfgForPy_file">
<code class="descname">write_cfgForPy_file</code><span class="sig-paren">(</span><em>filename</em>, <em>additional_env={}</em>, <em>for_package=None</em>, <em>with_commercial=True</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/environment.html#FileEnvWriter.write_cfgForPy_file"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.environment.FileEnvWriter.write_cfgForPy_file" title="Permalink to this definition">¶</a></dt>
-<dd><p>Append to current opened aFile a cfgForPy
-environment (SALOME python launcher).</p>
+<dd><dl class="docutils">
+<dt>Append to current opened aFile a cfgForPy </dt>
+<dd>environment (SALOME python launcher).</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 last simple">
-<li><strong>str</strong> (<em>for_package</em>) – the file path</li>
-<li><strong>dict</strong> (<em>additional_env</em>) – a dictionary of additional variables
+<li><strong>str</strong> (<em>for_package</em>) -- the file path</li>
+<li><strong>dict</strong> (<em>additional_env</em>) -- a dictionary of additional variables
to add to the environment</li>
-<li><strong>str</strong> – If not None, produce a relative environment
+<li><strong>str</strong> -- If not None, produce a relative environment
designed for a package.</li>
</ul>
</td>
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
-<li><strong>str</strong> (<em>shell</em>) – the file path</li>
-<li><strong>bool</strong> (<em>forBuild</em>) – if true, the build environment</li>
-<li><strong>str</strong> – the type of file wanted (.sh, .bat)</li>
+<li><strong>str</strong> (<em>shell</em>) -- the file path</li>
+<li><strong>bool</strong> (<em>forBuild</em>) -- if true, the build environment</li>
+<li><strong>str</strong> -- the type of file wanted (.sh, .bat)</li>
</ul>
</td>
</tr>
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>comment</em>) – the commentary to add</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>comment</em>) -- the commentary to add</td>
</tr>
</tbody>
</table>
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>int</strong> (<em>nb_line</em>) – the number of empty lines to add</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>int</strong> (<em>nb_line</em>) -- the number of empty lines to add</td>
</tr>
</tbody>
</table>
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>warning</em>) – the warning to add</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<a class="reference internal" href="#src.utilsSat.warning" title="src.utilsSat.warning"><em>warning</em></a>) -- the warning to add</td>
</tr>
</tbody>
</table>
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
-<li><strong>str</strong> (<em>sep</em>) – the environment variable to append</li>
-<li><strong>str</strong> – the value to append to key</li>
-<li><strong>str</strong> – the separator string</li>
+<li><strong>str</strong> (<em>sep</em>) -- the environment variable to append</li>
+<li><strong>str</strong> -- the value to append to key</li>
+<li><strong>str</strong> -- the separator string</li>
</ul>
</td>
</tr>
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>file</strong> (<em>out</em>) – the stream where to write the environment</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>file</strong> (<em>out</em>) -- the stream where to write the environment</td>
</tr>
</tbody>
</table>
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>bool</strong> (<em>required</em>) – Do nothing if required is False</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>bool</strong> (<em>required</em>) -- Do nothing if required is False</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="src.environment.SalomeEnviron.get">
<code class="descname">get</code><span class="sig-paren">(</span><em>key</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/environment.html#SalomeEnviron.get"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.environment.SalomeEnviron.get" title="Permalink to this definition">¶</a></dt>
-<dd><p>Get the value of the environment variable “key”</p>
+<dd><p>Get the value of the environment variable "key"</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>key</em>) – the environment variable</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>key</em>) -- the environment variable</td>
</tr>
</tbody>
</table>
<dd><p>Get the products name to add in SALOME_MODULES environment variable
It is the name of the product, except in the case where the is a
component name. And it has to be in SALOME_MODULES variable only
-if the product has the property has_salome_hui = “yes”</p>
+if the product has the property has_salome_hui = "yes"</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>list</strong> (<em>lProducts</em>) – List of products to potentially add</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>list</strong> (<em>lProducts</em>) -- List of products to potentially add</td>
</tr>
</tbody>
</table>
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>key</em>) – the environment variable to check</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>key</em>) -- the environment variable to check</td>
</tr>
</tbody>
</table>
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>cfg_env</em>) – A config containing an environment</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>cfg_env</em>) -- A config containing an environment</td>
</tr>
</tbody>
</table>
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
-<li><strong>str</strong> (<em>sep</em>) – the environment variable to prepend</li>
-<li><strong>str</strong> – the value to prepend to key</li>
-<li><strong>str</strong> – the separator string</li>
+<li><strong>str</strong> (<em>sep</em>) -- the environment variable to prepend</li>
+<li><strong>str</strong> -- the value to prepend to key</li>
+<li><strong>str</strong> -- the separator string</li>
</ul>
</td>
</tr>
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
-<li><strong>Config</strong> (<em>product_info</em>) – The product description</li>
-<li><strong>Logger</strong> (<em>logger</em>) – The logger instance to display messages</li>
-<li><strong>Boolean</strong> (<em>native</em>) – if True load set_native_env instead of set_env</li>
+<li><strong>Config</strong> (<em>product_info</em>) -- The product description</li>
+<li><strong>Logger</strong> (<em>logger</em>) -- The logger instance to display messages</li>
+<li><strong>Boolean</strong> (<em>native</em>) -- if True load set_native_env instead of set_env</li>
</ul>
</td>
</tr>
<dl class="method">
<dt id="src.environment.SalomeEnviron.run_simple_env_script">
<code class="descname">run_simple_env_script</code><span class="sig-paren">(</span><em>script_path</em>, <em>logger=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/environment.html#SalomeEnviron.run_simple_env_script"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.environment.SalomeEnviron.run_simple_env_script" title="Permalink to this definition">¶</a></dt>
-<dd><p>Runs an environment script. Same as run_env_script, but with a
-script path as parameter.</p>
+<dd><dl class="docutils">
+<dt>Runs an environment script. Same as run_env_script, but with a </dt>
+<dd>script path as parameter.</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 last simple">
-<li><strong>str</strong> (<em>script_path</em>) – a path to an environment script</li>
-<li><strong>Logger</strong> (<em>logger</em>) – The logger instance to display messages</li>
+<li><strong>str</strong> (<em>script_path</em>) -- a path to an environment script</li>
+<li><strong>Logger</strong> (<em>logger</em>) -- The logger instance to display messages</li>
</ul>
</td>
</tr>
<dl class="method">
<dt id="src.environment.SalomeEnviron.set">
<code class="descname">set</code><span class="sig-paren">(</span><em>key</em>, <em>value</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/environment.html#SalomeEnviron.set"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.environment.SalomeEnviron.set" title="Permalink to this definition">¶</a></dt>
-<dd><p>Set the environment variable “key” to value “value”</p>
+<dd><p>Set the environment variable "key" to value "value"</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
-<li><strong>str</strong> (<em>value</em>) – the environment variable to set</li>
-<li><strong>str</strong> – the value</li>
+<li><strong>str</strong> (<em>value</em>) -- the environment variable to set</li>
+<li><strong>str</strong> -- the value</li>
</ul>
</td>
</tr>
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
-<li><strong>str</strong> (<em>product</em>) – The product name</li>
-<li><strong>Logger</strong> (<em>logger</em>) – The logger instance to display messages</li>
+<li><strong>str</strong> (<a class="reference internal" href="#module-src.product" title="src.product"><em>product</em></a>) -- The product name</li>
+<li><strong>Logger</strong> (<em>logger</em>) -- The logger instance to display messages</li>
</ul>
</td>
</tr>
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Logger</strong> (<em>logger</em>) – The logger instance to display messages</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Logger</strong> (<em>logger</em>) -- The logger instance to display messages</td>
</tr>
</tbody>
</table>
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>product_info</em>) – The product description</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>product_info</em>) -- The product description</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="src.environment.SalomeEnviron.set_full_environ">
<code class="descname">set_full_environ</code><span class="sig-paren">(</span><em>logger</em>, <em>env_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/environment.html#SalomeEnviron.set_full_environ"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.environment.SalomeEnviron.set_full_environ" title="Permalink to this definition">¶</a></dt>
-<dd><p>Sets the full environment for products
-specified in env_info dictionary.</p>
+<dd><dl class="docutils">
+<dt>Sets the full environment for products </dt>
+<dd>specified in env_info dictionary.</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 last simple">
-<li><strong>Logger</strong> (<em>logger</em>) – The logger instance to display messages</li>
-<li><strong>list</strong> (<em>env_info</em>) – the list of products</li>
+<li><strong>Logger</strong> (<em>logger</em>) -- The logger instance to display messages</li>
+<li><strong>list</strong> (<em>env_info</em>) -- the list of products</li>
</ul>
</td>
</tr>
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
-<li><strong>Logger</strong> (<em>logger</em>) – The logger instance to display messages</li>
-<li><strong>src</strong> (<em>src_root</em>) – the application working directory</li>
+<li><strong>Logger</strong> (<em>logger</em>) -- The logger instance to display messages</li>
+<li><strong>src</strong> (<em>src_root</em>) -- the application working directory</li>
</ul>
</td>
</tr>
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>pi</em>) – The product description</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>pi</em>) -- The product description</td>
</tr>
</tbody>
</table>
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
-<li><strong>Config</strong> (<em>product_info</em>) – The product description</li>
-<li><strong>Logger</strong> (<em>logger</em>) – The logger instance to display messages</li>
+<li><strong>Config</strong> (<em>product_info</em>) -- The product description</li>
+<li><strong>Logger</strong> (<em>logger</em>) -- The logger instance to display messages</li>
</ul>
</td>
</tr>
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
-<li><strong>Config</strong> (<em>config</em>) – the global config</li>
-<li><strong>bool</strong> (<em>build</em>) – build environement if True</li>
-<li><strong>Logger</strong> (<em>logger</em>) – The logger instance to display messages</li>
+<li><strong>Config</strong> (<em>config</em>) -- the global config</li>
+<li><strong>bool</strong> (<em>build</em>) -- build environement if True</li>
+<li><strong>Logger</strong> (<em>logger</em>) -- The logger instance to display messages</li>
</ul>
</td>
</tr>
</table>
</dd></dl>
+</div>
+<div class="section" id="module-src.environs">
+<span id="src-environs-module"></span><h2>src.environs module<a class="headerlink" href="#module-src.environs" title="Permalink to this headline">¶</a></h2>
+<p>Utility for print environment variables</p>
+<dl class="docutils">
+<dt>examples: </dt>
+<dd><ul class="first last simple">
+<li>split all or specific environment variables $XXX(s)...
+>> environs.py -> all
+>> environs.py SHELL PATH -> specific $SHELL $PATH</li>
+<li>split all or specific environment variables on pattern $*XXX*(s)...
+>> environs.py --pat ROOT -> specific $*ROOT*</li>
+<li>split search specific substrings in contents of environment variables $XXX(s)...
+>> environs.py --grep usr -> all specific environment variables containing usr</li>
+</ul>
+</dd>
+<dt>tips:</dt>
+<dd><ul class="first last simple">
+<li>create unix alias as shortcut for bash console
+>> alias envs=".../environs.py"</li>
+</ul>
+</dd>
+</dl>
+<dl class="function">
+<dt id="src.environs.print_grep_environs">
+<code class="descclassname">src.environs.</code><code class="descname">print_grep_environs</code><span class="sig-paren">(</span><em>args=[]</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/environs.html#print_grep_environs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.environs.print_grep_environs" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="function">
+<dt id="src.environs.print_split_environs">
+<code class="descclassname">src.environs.</code><code class="descname">print_split_environs</code><span class="sig-paren">(</span><em>args=[]</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/environs.html#print_split_environs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.environs.print_split_environs" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="function">
+<dt id="src.environs.print_split_pattern_environs">
+<code class="descclassname">src.environs.</code><code class="descname">print_split_pattern_environs</code><span class="sig-paren">(</span><em>args=[]</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/environs.html#print_split_pattern_environs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.environs.print_split_pattern_environs" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</div>
+<div class="section" id="module-src.exceptionSat">
+<span id="src-exceptionsat-module"></span><h2>src.exceptionSat module<a class="headerlink" href="#module-src.exceptionSat" title="Permalink to this headline">¶</a></h2>
+<dl class="exception">
+<dt id="src.exceptionSat.ExceptionSat">
+<em class="property">exception </em><code class="descclassname">src.exceptionSat.</code><code class="descname">ExceptionSat</code><a class="reference internal" href="../../_modules/src/exceptionSat.html#ExceptionSat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.exceptionSat.ExceptionSat" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">exceptions.Exception</span></code></p>
+<p>rename Exception Class for sat convenience (for future...)</p>
+</dd></dl>
+
</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>
-<dd><p>Bases: <a class="reference internal" href="#src.fileEnviron.FileEnviron" title="src.fileEnviron.FileEnviron"><code class="xref py py-class docutils literal notranslate"><span class="pre">src.fileEnviron.FileEnviron</span></code></a></p>
+<dd><p>Bases: <a class="reference internal" href="#src.fileEnviron.FileEnviron" title="src.fileEnviron.FileEnviron"><code class="xref py py-class docutils literal"><span class="pre">src.fileEnviron.FileEnviron</span></code></a></p>
<p>Class for bash shell.</p>
<dl class="method">
<dt id="src.fileEnviron.BashFileEnviron.command_value">
<code class="descname">command_value</code><span class="sig-paren">(</span><em>key</em>, <em>command</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#BashFileEnviron.command_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.BashFileEnviron.command_value" title="Permalink to this definition">¶</a></dt>
-<dd><p>Get the value given by the system command “command”
-and put it in the environment variable key.
+<dd><dl class="docutils">
+<dt>Get the value given by the system command "command" </dt>
+<dd>and put it in the environment variable key.
Has to be overwritten in the derived classes
-This can be seen as a virtual method</p>
+This can be seen as a virtual method</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 last simple">
-<li><strong>str</strong> (<em>command</em>) – the environment variable</li>
-<li><strong>str</strong> – the command to execute</li>
+<li><strong>str</strong> (<em>command</em>) -- the environment variable</li>
+<li><strong>str</strong> -- the command to execute</li>
</ul>
</td>
</tr>
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>bool</strong> (<em>required</em>) – Do nothing if required is False</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>bool</strong> (<em>required</em>) -- Do nothing if required is False</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="src.fileEnviron.BashFileEnviron.set">
<code class="descname">set</code><span class="sig-paren">(</span><em>key</em>, <em>value</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#BashFileEnviron.set"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.BashFileEnviron.set" title="Permalink to this definition">¶</a></dt>
-<dd><p>Set the environment variable “key” to value “value”</p>
+<dd><p>Set the environment variable "key" to value "value"</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
-<li><strong>str</strong> (<em>value</em>) – the environment variable to set</li>
-<li><strong>str</strong> – the value</li>
+<li><strong>str</strong> (<em>value</em>) -- the environment variable to set</li>
+<li><strong>str</strong> -- the value</li>
</ul>
</td>
</tr>
<dl class="class">
<dt id="src.fileEnviron.BatFileEnviron">
<em class="property">class </em><code class="descclassname">src.fileEnviron.</code><code class="descname">BatFileEnviron</code><span class="sig-paren">(</span><em>output</em>, <em>environ=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#BatFileEnviron"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.BatFileEnviron" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <a class="reference internal" href="#src.fileEnviron.FileEnviron" title="src.fileEnviron.FileEnviron"><code class="xref py py-class docutils literal notranslate"><span class="pre">src.fileEnviron.FileEnviron</span></code></a></p>
+<dd><p>Bases: <a class="reference internal" href="#src.fileEnviron.FileEnviron" title="src.fileEnviron.FileEnviron"><code class="xref py py-class docutils literal"><span class="pre">src.fileEnviron.FileEnviron</span></code></a></p>
<p>for Windows batch shell.</p>
<dl class="method">
<dt id="src.fileEnviron.BatFileEnviron.add_comment">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>comment</em>) – the comment to add</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>comment</em>) -- the comment to add</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="src.fileEnviron.BatFileEnviron.command_value">
<code class="descname">command_value</code><span class="sig-paren">(</span><em>key</em>, <em>command</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#BatFileEnviron.command_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.BatFileEnviron.command_value" title="Permalink to this definition">¶</a></dt>
-<dd><p>Get the value given by the system command “command”
-and put it in the environment variable key.
+<dd><dl class="docutils">
+<dt>Get the value given by the system command "command" </dt>
+<dd>and put it in the environment variable key.
Has to be overwritten in the derived classes
-This can be seen as a virtual method</p>
+This can be seen as a virtual method</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 last simple">
-<li><strong>str</strong> (<em>command</em>) – the environment variable</li>
-<li><strong>str</strong> – the command to execute</li>
+<li><strong>str</strong> (<em>command</em>) -- the environment variable</li>
+<li><strong>str</strong> -- the command to execute</li>
</ul>
</td>
</tr>
<dl class="method">
<dt id="src.fileEnviron.BatFileEnviron.finish">
<code class="descname">finish</code><span class="sig-paren">(</span><em>required=True</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#BatFileEnviron.finish"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.BatFileEnviron.finish" title="Permalink to this definition">¶</a></dt>
-<dd><p>Add a final instruction in the out file (in case of file generation)
-In the particular windows case, do nothing</p>
+<dd><dl class="docutils">
+<dt>Add a final instruction in the out file (in case of file generation)</dt>
+<dd>In the particular windows case, do nothing</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>bool</strong> (<em>required</em>) – Do nothing if required is False</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>bool</strong> (<em>required</em>) -- Do nothing if required is False</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="src.fileEnviron.BatFileEnviron.get">
<code class="descname">get</code><span class="sig-paren">(</span><em>key</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#BatFileEnviron.get"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.BatFileEnviron.get" title="Permalink to this definition">¶</a></dt>
-<dd><p>Get the value of the environment variable “key”</p>
+<dd><p>Get the value of the environment variable "key"</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>key</em>) – the environment variable</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>key</em>) -- the environment variable</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="src.fileEnviron.BatFileEnviron.set">
<code class="descname">set</code><span class="sig-paren">(</span><em>key</em>, <em>value</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#BatFileEnviron.set"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.BatFileEnviron.set" title="Permalink to this definition">¶</a></dt>
-<dd><p>Set the environment variable “key” to value “value”</p>
+<dd><p>Set the environment variable "key" to value "value"</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
-<li><strong>str</strong> (<em>value</em>) – the environment variable to set</li>
-<li><strong>str</strong> – the value</li>
+<li><strong>str</strong> (<em>value</em>) -- the environment variable to set</li>
+<li><strong>str</strong> -- the value</li>
</ul>
</td>
</tr>
<dl class="class">
<dt id="src.fileEnviron.ContextFileEnviron">
<em class="property">class </em><code class="descclassname">src.fileEnviron.</code><code class="descname">ContextFileEnviron</code><span class="sig-paren">(</span><em>output</em>, <em>environ=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#ContextFileEnviron"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.ContextFileEnviron" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <a class="reference internal" href="#src.fileEnviron.FileEnviron" title="src.fileEnviron.FileEnviron"><code class="xref py py-class docutils literal notranslate"><span class="pre">src.fileEnviron.FileEnviron</span></code></a></p>
+<dd><p>Bases: <a class="reference internal" href="#src.fileEnviron.FileEnviron" title="src.fileEnviron.FileEnviron"><code class="xref py py-class docutils literal"><span class="pre">src.fileEnviron.FileEnviron</span></code></a></p>
<p>Class for a salome context configuration file.</p>
<dl class="method">
<dt id="src.fileEnviron.ContextFileEnviron.add_echo">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>text</em>) – the comment to add</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>text</em>) -- the comment to add</td>
</tr>
</tbody>
</table>
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>text</em>) – the warning to add</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>text</em>) -- the warning to add</td>
</tr>
</tbody>
</table>
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
-<li><strong>str</strong> (<em>sep</em>) – the environment variable to append</li>
-<li><strong>str</strong> – the value to append to key</li>
-<li><strong>str</strong> – the separator string</li>
+<li><strong>str</strong> (<em>sep</em>) -- the environment variable to append</li>
+<li><strong>str</strong> -- the value to append to key</li>
+<li><strong>str</strong> -- the separator string</li>
</ul>
</td>
</tr>
<dl class="method">
<dt id="src.fileEnviron.ContextFileEnviron.command_value">
<code class="descname">command_value</code><span class="sig-paren">(</span><em>key</em>, <em>command</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#ContextFileEnviron.command_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.ContextFileEnviron.command_value" title="Permalink to this definition">¶</a></dt>
-<dd><p>Get the value given by the system command “command”
-and put it in the environment variable key.
+<dd><dl class="docutils">
+<dt>Get the value given by the system command "command" </dt>
+<dd>and put it in the environment variable key.
Has to be overwritten in the derived classes
-This can be seen as a virtual method</p>
+This can be seen as a virtual method</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 last simple">
-<li><strong>str</strong> (<em>command</em>) – the environment variable</li>
-<li><strong>str</strong> – the command to execute</li>
+<li><strong>str</strong> (<em>command</em>) -- the environment variable</li>
+<li><strong>str</strong> -- the command to execute</li>
</ul>
</td>
</tr>
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>bool</strong> (<em>required</em>) – Do nothing if required is False</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>bool</strong> (<em>required</em>) -- Do nothing if required is False</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="src.fileEnviron.ContextFileEnviron.get">
<code class="descname">get</code><span class="sig-paren">(</span><em>key</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#ContextFileEnviron.get"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.ContextFileEnviron.get" title="Permalink to this definition">¶</a></dt>
-<dd><p>Get the value of the environment variable “key”</p>
+<dd><p>Get the value of the environment variable "key"</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>key</em>) – the environment variable</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>key</em>) -- the environment variable</td>
</tr>
</tbody>
</table>
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
-<li><strong>str</strong> (<em>sep</em>) – the environment variable to prepend</li>
-<li><strong>str</strong> – the value to prepend to key</li>
-<li><strong>str</strong> – the separator string</li>
+<li><strong>str</strong> (<em>sep</em>) -- the environment variable to prepend</li>
+<li><strong>str</strong> -- the value to prepend to key</li>
+<li><strong>str</strong> -- the separator string</li>
</ul>
</td>
</tr>
<dl class="method">
<dt id="src.fileEnviron.ContextFileEnviron.set">
<code class="descname">set</code><span class="sig-paren">(</span><em>key</em>, <em>value</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#ContextFileEnviron.set"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.ContextFileEnviron.set" title="Permalink to this definition">¶</a></dt>
-<dd><p>Set the environment variable “key” to value “value”</p>
+<dd><p>Set the environment variable "key" to value "value"</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
-<li><strong>str</strong> (<em>value</em>) – the environment variable to set</li>
-<li><strong>str</strong> – the value</li>
+<li><strong>str</strong> (<em>value</em>) -- the environment variable to set</li>
+<li><strong>str</strong> -- the value</li>
</ul>
</td>
</tr>
<dl class="class">
<dt id="src.fileEnviron.FileEnviron">
<em class="property">class </em><code class="descclassname">src.fileEnviron.</code><code class="descname">FileEnviron</code><span class="sig-paren">(</span><em>output</em>, <em>environ=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#FileEnviron"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.FileEnviron" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
-<p>Base class for shell environment</p>
+<dd><p>Base class for shell environment</p>
<dl class="method">
<dt id="src.fileEnviron.FileEnviron.add_comment">
<code class="descname">add_comment</code><span class="sig-paren">(</span><em>comment</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#FileEnviron.add_comment"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.FileEnviron.add_comment" title="Permalink to this definition">¶</a></dt>
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>comment</em>) – the comment to add</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>comment</em>) -- the comment to add</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="src.fileEnviron.FileEnviron.add_echo">
<code class="descname">add_echo</code><span class="sig-paren">(</span><em>text</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#FileEnviron.add_echo"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.FileEnviron.add_echo" title="Permalink to this definition">¶</a></dt>
-<dd><p>Add a “echo” in the shell file</p>
+<dd><p>Add a "echo" in the shell file</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>text</em>) – the text to echo</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>text</em>) -- the text to echo</td>
</tr>
</tbody>
</table>
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>int</strong> (<em>number</em>) – the number of lines to add</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>int</strong> (<em>number</em>) -- the number of lines to add</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="src.fileEnviron.FileEnviron.add_warning">
<code class="descname">add_warning</code><span class="sig-paren">(</span><em>warning</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#FileEnviron.add_warning"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.FileEnviron.add_warning" title="Permalink to this definition">¶</a></dt>
-<dd><p>Add a warning “echo” in the shell file</p>
+<dd><p>Add a warning "echo" in the shell file</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>warning</em>) – the text to echo</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<a class="reference internal" href="#src.utilsSat.warning" title="src.utilsSat.warning"><em>warning</em></a>) -- the text to echo</td>
</tr>
</tbody>
</table>
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
-<li><strong>str</strong> (<em>sep</em>) – the environment variable to append</li>
-<li><strong>str</strong><strong> or </strong><strong>list</strong> (<em>value</em>) – the value(s) to append to key</li>
-<li><strong>str</strong> – the separator string</li>
+<li><strong>str</strong> (<em>sep</em>) -- the environment variable to append</li>
+<li><strong>str or list</strong> (<em>value</em>) -- the value(s) to append to key</li>
+<li><strong>str</strong> -- the separator string</li>
</ul>
</td>
</tr>
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
-<li><strong>str</strong> (<em>sep</em>) – the environment variable to append</li>
-<li><strong>str</strong> – the value to append to key</li>
-<li><strong>str</strong> – the separator string</li>
+<li><strong>str</strong> (<em>sep</em>) -- the environment variable to append</li>
+<li><strong>str</strong> -- the value to append to key</li>
+<li><strong>str</strong> -- the separator string</li>
</ul>
</td>
</tr>
<dl class="method">
<dt id="src.fileEnviron.FileEnviron.command_value">
<code class="descname">command_value</code><span class="sig-paren">(</span><em>key</em>, <em>command</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#FileEnviron.command_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.FileEnviron.command_value" title="Permalink to this definition">¶</a></dt>
-<dd><p>Get the value given by the system command “command”
-and put it in the environment variable key.
+<dd><dl class="docutils">
+<dt>Get the value given by the system command "command" </dt>
+<dd>and put it in the environment variable key.
Has to be overwritten in the derived classes
-This can be seen as a virtual method</p>
+This can be seen as a virtual method</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 last simple">
-<li><strong>str</strong> (<em>command</em>) – the environment variable</li>
-<li><strong>str</strong> – the command to execute</li>
+<li><strong>str</strong> (<em>command</em>) -- the environment variable</li>
+<li><strong>str</strong> -- the command to execute</li>
</ul>
</td>
</tr>
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>bool</strong> (<em>required</em>) – Do nothing if required is False</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>bool</strong> (<em>required</em>) -- Do nothing if required is False</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="src.fileEnviron.FileEnviron.get">
<code class="descname">get</code><span class="sig-paren">(</span><em>key</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#FileEnviron.get"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.FileEnviron.get" title="Permalink to this definition">¶</a></dt>
-<dd><p>Get the value of the environment variable “key”</p>
+<dd><p>Get the value of the environment variable "key"</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>key</em>) – the environment variable</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>key</em>) -- the environment variable</td>
</tr>
</tbody>
</table>
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>key</em>) – the environment variable to check</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>key</em>) -- the environment variable to check</td>
</tr>
</tbody>
</table>
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
-<li><strong>str</strong> (<em>sep</em>) – the environment variable to prepend</li>
-<li><strong>str</strong><strong> or </strong><strong>list</strong> (<em>value</em>) – the value(s) to prepend to key</li>
-<li><strong>str</strong> – the separator string</li>
+<li><strong>str</strong> (<em>sep</em>) -- the environment variable to prepend</li>
+<li><strong>str or list</strong> (<em>value</em>) -- the value(s) to prepend to key</li>
+<li><strong>str</strong> -- the separator string</li>
</ul>
</td>
</tr>
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
-<li><strong>str</strong> (<em>sep</em>) – the environment variable to prepend</li>
-<li><strong>str</strong> – the value to prepend to key</li>
-<li><strong>str</strong> – the separator string</li>
+<li><strong>str</strong> (<em>sep</em>) -- the environment variable to prepend</li>
+<li><strong>str</strong> -- the value to prepend to key</li>
+<li><strong>str</strong> -- the separator string</li>
</ul>
</td>
</tr>
<dl class="method">
<dt id="src.fileEnviron.FileEnviron.set">
<code class="descname">set</code><span class="sig-paren">(</span><em>key</em>, <em>value</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#FileEnviron.set"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.FileEnviron.set" title="Permalink to this definition">¶</a></dt>
-<dd><p>Set the environment variable ‘key’ to value ‘value’</p>
+<dd><p>Set the environment variable "key" to value "value"</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
-<li><strong>str</strong> (<em>value</em>) – the environment variable to set</li>
-<li><strong>str</strong> – the value</li>
+<li><strong>str</strong> (<em>value</em>) -- the environment variable to set</li>
+<li><strong>str</strong> -- the value</li>
</ul>
</td>
</tr>
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
-<li><strong>str</strong> (<em>value</em>) – the environment variable to prepend</li>
-<li><strong>str</strong> – the value to prepend to key</li>
+<li><strong>str</strong> (<em>value</em>) -- the environment variable to prepend</li>
+<li><strong>str</strong> -- the value to prepend to key</li>
</ul>
</td>
</tr>
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>text</em>) – the comment to add</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>text</em>) -- the comment to add</td>
</tr>
</tbody>
</table>
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>int</strong> (<em>number</em>) – the number of lines to add</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>int</strong> (<em>number</em>) -- the number of lines to add</td>
</tr>
</tbody>
</table>
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>text</em>) – the warning to add</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>text</em>) -- the warning to add</td>
</tr>
</tbody>
</table>
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
-<li><strong>str</strong> (<em>sep</em>) – the environment variable to append</li>
-<li><strong>str</strong><strong> or </strong><strong>list</strong> (<em>value</em>) – the value(s) to append to key</li>
-<li><strong>str</strong> – the separator string</li>
+<li><strong>str</strong> (<em>sep</em>) -- the environment variable to append</li>
+<li><strong>str or list</strong> (<em>value</em>) -- the value(s) to append to key</li>
+<li><strong>str</strong> -- the separator string</li>
</ul>
</td>
</tr>
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
-<li><strong>str</strong> (<em>sep</em>) – the environment variable to append</li>
-<li><strong>str</strong> – the value to append to key</li>
-<li><strong>str</strong> – the separator string</li>
+<li><strong>str</strong> (<em>sep</em>) -- the environment variable to append</li>
+<li><strong>str</strong> -- the value to append to key</li>
+<li><strong>str</strong> -- the separator string</li>
</ul>
</td>
</tr>
<dl class="method">
<dt id="src.fileEnviron.LauncherFileEnviron.command_value">
<code class="descname">command_value</code><span class="sig-paren">(</span><em>key</em>, <em>command</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#LauncherFileEnviron.command_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.LauncherFileEnviron.command_value" title="Permalink to this definition">¶</a></dt>
-<dd><p>Get the value given by the system command “command”
-and put it in the environment variable key.</p>
+<dd><dl class="docutils">
+<dt>Get the value given by the system command "command" </dt>
+<dd>and put it in the environment variable key.</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 last simple">
-<li><strong>str</strong> (<em>command</em>) – the environment variable</li>
-<li><strong>str</strong> – the command to execute</li>
+<li><strong>str</strong> (<em>command</em>) -- the environment variable</li>
+<li><strong>str</strong> -- the command to execute</li>
</ul>
</td>
</tr>
<dl class="method">
<dt id="src.fileEnviron.LauncherFileEnviron.finish">
<code class="descname">finish</code><span class="sig-paren">(</span><em>required=True</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#LauncherFileEnviron.finish"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.LauncherFileEnviron.finish" title="Permalink to this definition">¶</a></dt>
-<dd><p>Add a final instruction in the out file (in case of file generation)
-In the particular launcher case, do nothing</p>
+<dd><dl class="docutils">
+<dt>Add a final instruction in the out file (in case of file generation)</dt>
+<dd>In the particular launcher case, do nothing</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>bool</strong> (<em>required</em>) – Do nothing if required is False</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>bool</strong> (<em>required</em>) -- Do nothing if required is False</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="src.fileEnviron.LauncherFileEnviron.get">
<code class="descname">get</code><span class="sig-paren">(</span><em>key</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#LauncherFileEnviron.get"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.LauncherFileEnviron.get" title="Permalink to this definition">¶</a></dt>
-<dd><p>Get the value of the environment variable “key”</p>
+<dd><p>Get the value of the environment variable "key"</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>key</em>) – the environment variable</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>key</em>) -- the environment variable</td>
</tr>
</tbody>
</table>
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>key</em>) – the environment variable to check</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>key</em>) -- the environment variable to check</td>
</tr>
</tbody>
</table>
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
-<li><strong>str</strong> (<em>sep</em>) – the environment variable to prepend</li>
-<li><strong>str</strong><strong> or </strong><strong>list</strong> (<em>value</em>) – the value(s) to prepend to key</li>
-<li><strong>str</strong> – the separator string</li>
+<li><strong>str</strong> (<em>sep</em>) -- the environment variable to prepend</li>
+<li><strong>str or list</strong> (<em>value</em>) -- the value(s) to prepend to key</li>
+<li><strong>str</strong> -- the separator string</li>
</ul>
</td>
</tr>
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
-<li><strong>str</strong> (<em>sep</em>) – the environment variable to prepend</li>
-<li><strong>str</strong> – the value to prepend to key</li>
-<li><strong>str</strong> – the separator string</li>
+<li><strong>str</strong> (<em>sep</em>) -- the environment variable to prepend</li>
+<li><strong>str</strong> -- the value to prepend to key</li>
+<li><strong>str</strong> -- the separator string</li>
</ul>
</td>
</tr>
<dl class="method">
<dt id="src.fileEnviron.LauncherFileEnviron.set">
<code class="descname">set</code><span class="sig-paren">(</span><em>key</em>, <em>value</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#LauncherFileEnviron.set"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.LauncherFileEnviron.set" title="Permalink to this definition">¶</a></dt>
-<dd><p>Set the environment variable “key” to value “value”</p>
+<dd><p>Set the environment variable "key" to value "value"</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
-<li><strong>str</strong> (<em>value</em>) – the environment variable to set</li>
-<li><strong>str</strong> – the value</li>
+<li><strong>str</strong> (<em>value</em>) -- the environment variable to set</li>
+<li><strong>str</strong> -- the value</li>
</ul>
</td>
</tr>
<dl class="class">
<dt id="src.fileEnviron.ScreenEnviron">
<em class="property">class </em><code class="descclassname">src.fileEnviron.</code><code class="descname">ScreenEnviron</code><span class="sig-paren">(</span><em>output</em>, <em>environ=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#ScreenEnviron"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.ScreenEnviron" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <a class="reference internal" href="#src.fileEnviron.FileEnviron" title="src.fileEnviron.FileEnviron"><code class="xref py py-class docutils literal notranslate"><span class="pre">src.fileEnviron.FileEnviron</span></code></a></p>
+<dd><p>Bases: <a class="reference internal" href="#src.fileEnviron.FileEnviron" title="src.fileEnviron.FileEnviron"><code class="xref py py-class docutils literal"><span class="pre">src.fileEnviron.FileEnviron</span></code></a></p>
<dl class="method">
<dt id="src.fileEnviron.ScreenEnviron.add_comment">
<code class="descname">add_comment</code><span class="sig-paren">(</span><em>comment</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#ScreenEnviron.add_comment"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.ScreenEnviron.add_comment" title="Permalink to this definition">¶</a></dt>
-<dd><p>Add a comment in the shell file</p>
-<table class="docutils field-list" frame="void" rules="none">
-<col class="field-name" />
-<col class="field-body" />
-<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>comment</em>) – the comment to add</td>
-</tr>
-</tbody>
-</table>
-</dd></dl>
+<dd></dd></dl>
<dl class="method">
<dt id="src.fileEnviron.ScreenEnviron.add_echo">
<code class="descname">add_echo</code><span class="sig-paren">(</span><em>text</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#ScreenEnviron.add_echo"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.ScreenEnviron.add_echo" title="Permalink to this definition">¶</a></dt>
-<dd><p>Add a “echo” in the shell file</p>
-<table class="docutils field-list" frame="void" rules="none">
-<col class="field-name" />
-<col class="field-body" />
-<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>text</em>) – the text to echo</td>
-</tr>
-</tbody>
-</table>
-</dd></dl>
+<dd></dd></dl>
<dl class="method">
<dt id="src.fileEnviron.ScreenEnviron.add_line">
<code class="descname">add_line</code><span class="sig-paren">(</span><em>number</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#ScreenEnviron.add_line"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.ScreenEnviron.add_line" title="Permalink to this definition">¶</a></dt>
-<dd><p>Add some empty lines in the shell file</p>
-<table class="docutils field-list" frame="void" rules="none">
-<col class="field-name" />
-<col class="field-body" />
-<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>int</strong> (<em>number</em>) – the number of lines to add</td>
-</tr>
-</tbody>
-</table>
-</dd></dl>
+<dd></dd></dl>
<dl class="method">
<dt id="src.fileEnviron.ScreenEnviron.add_warning">
<code class="descname">add_warning</code><span class="sig-paren">(</span><em>warning</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#ScreenEnviron.add_warning"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.ScreenEnviron.add_warning" title="Permalink to this definition">¶</a></dt>
-<dd><p>Add a warning “echo” in the shell file</p>
-<table class="docutils field-list" frame="void" rules="none">
-<col class="field-name" />
-<col class="field-body" />
-<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>warning</em>) – the text to echo</td>
-</tr>
-</tbody>
-</table>
-</dd></dl>
+<dd></dd></dl>
<dl class="method">
<dt id="src.fileEnviron.ScreenEnviron.append">
<code class="descname">append</code><span class="sig-paren">(</span><em>name</em>, <em>value</em>, <em>sep=':'</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#ScreenEnviron.append"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.ScreenEnviron.append" title="Permalink to this definition">¶</a></dt>
-<dd><p>Same as append_value but the value argument can be a list</p>
-<table class="docutils field-list" frame="void" rules="none">
-<col class="field-name" />
-<col class="field-body" />
-<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
-<li><strong>str</strong> (<em>sep</em>) – the environment variable to append</li>
-<li><strong>str</strong><strong> or </strong><strong>list</strong> (<em>value</em>) – the value(s) to append to key</li>
-<li><strong>str</strong> – the separator string</li>
-</ul>
-</td>
-</tr>
-</tbody>
-</table>
-</dd></dl>
+<dd></dd></dl>
<dl class="method">
<dt id="src.fileEnviron.ScreenEnviron.command_value">
<code class="descname">command_value</code><span class="sig-paren">(</span><em>key</em>, <em>command</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#ScreenEnviron.command_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.ScreenEnviron.command_value" title="Permalink to this definition">¶</a></dt>
-<dd><p>Get the value given by the system command “command”
-and put it in the environment variable key.
-Has to be overwritten in the derived classes
-This can be seen as a virtual method</p>
-<table class="docutils field-list" frame="void" rules="none">
-<col class="field-name" />
-<col class="field-body" />
-<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
-<li><strong>str</strong> (<em>command</em>) – the environment variable</li>
-<li><strong>str</strong> – the command to execute</li>
-</ul>
-</td>
-</tr>
-</tbody>
-</table>
-</dd></dl>
+<dd></dd></dl>
<dl class="method">
<dt id="src.fileEnviron.ScreenEnviron.get">
<code class="descname">get</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#ScreenEnviron.get"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.ScreenEnviron.get" title="Permalink to this definition">¶</a></dt>
-<dd><p>Get the value of the environment variable “key”</p>
-<table class="docutils field-list" frame="void" rules="none">
-<col class="field-name" />
-<col class="field-body" />
-<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>key</em>) – the environment variable</td>
-</tr>
-</tbody>
-</table>
-</dd></dl>
+<dd></dd></dl>
<dl class="method">
<dt id="src.fileEnviron.ScreenEnviron.is_defined">
<code class="descname">is_defined</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#ScreenEnviron.is_defined"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.ScreenEnviron.is_defined" title="Permalink to this definition">¶</a></dt>
-<dd><p>Check if the key exists in the environment</p>
-<table class="docutils field-list" frame="void" rules="none">
-<col class="field-name" />
-<col class="field-body" />
-<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>key</em>) – the environment variable to check</td>
-</tr>
-</tbody>
-</table>
-</dd></dl>
+<dd></dd></dl>
<dl class="method">
<dt id="src.fileEnviron.ScreenEnviron.prepend">
<code class="descname">prepend</code><span class="sig-paren">(</span><em>name</em>, <em>value</em>, <em>sep=':'</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#ScreenEnviron.prepend"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.ScreenEnviron.prepend" title="Permalink to this definition">¶</a></dt>
-<dd><p>Same as prepend_value but the value argument can be a list</p>
-<table class="docutils field-list" frame="void" rules="none">
-<col class="field-name" />
-<col class="field-body" />
-<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
-<li><strong>str</strong> (<em>sep</em>) – the environment variable to prepend</li>
-<li><strong>str</strong><strong> or </strong><strong>list</strong> (<em>value</em>) – the value(s) to prepend to key</li>
-<li><strong>str</strong> – the separator string</li>
-</ul>
-</td>
-</tr>
-</tbody>
-</table>
-</dd></dl>
+<dd></dd></dl>
<dl class="method">
<dt id="src.fileEnviron.ScreenEnviron.run_env_script">
<dl class="method">
<dt id="src.fileEnviron.ScreenEnviron.set">
<code class="descname">set</code><span class="sig-paren">(</span><em>name</em>, <em>value</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#ScreenEnviron.set"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.ScreenEnviron.set" title="Permalink to this definition">¶</a></dt>
-<dd><p>Set the environment variable ‘key’ to value ‘value’</p>
-<table class="docutils field-list" frame="void" rules="none">
-<col class="field-name" />
-<col class="field-body" />
-<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
-<li><strong>str</strong> (<em>value</em>) – the environment variable to set</li>
-<li><strong>str</strong> – the value</li>
-</ul>
-</td>
-</tr>
-</tbody>
-</table>
-</dd></dl>
+<dd></dd></dl>
<dl class="method">
<dt id="src.fileEnviron.ScreenEnviron.write">
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
-<li><strong>file</strong> (<em>output</em>) – the output file stream.</li>
-<li><strong>str</strong> (<em>shell</em>) – the type of shell syntax to use.</li>
-<li><strong>dict</strong> (<em>environ</em>) – a potential additional environment.</li>
+<li><strong>file</strong> (<em>output</em>) -- the output file stream.</li>
+<li><strong>str</strong> (<em>shell</em>) -- the type of shell syntax to use.</li>
+<li><strong>dict</strong> (<em>environ</em>) -- a potential additional environment.</li>
</ul>
</td>
</tr>
<dl class="function">
<dt id="src.fileEnviron.special_path_separator">
<code class="descclassname">src.fileEnviron.</code><code class="descname">special_path_separator</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#special_path_separator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.special_path_separator" title="Permalink to this definition">¶</a></dt>
-<dd><p>TCLLIBPATH, TKLIBPATH, PV_PLUGIN_PATH environments variables need
-some exotic path separator.
+<dd><dl class="docutils">
+<dt>TCLLIBPATH, TKLIBPATH, PV_PLUGIN_PATH environments variables need</dt>
+<dd>some exotic path separator.
This function gives the separator regarding the name of the variable
-to append or prepend.</p>
+to append or prepend.</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>name</em>) – The name of the variable to find the separator</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>name</em>) -- The name of the variable to find the separator</td>
</tr>
</tbody>
</table>
</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>
-<dd></dd></dl>
+<dd><p>Launch a batch</p>
+</dd></dl>
<dl class="function">
<dt id="src.fork.batch_salome">
<code class="descclassname">src.fork.</code><code class="descname">batch_salome</code><span class="sig-paren">(</span><em>cmd</em>, <em>logger</em>, <em>cwd</em>, <em>args</em>, <em>getTmpDir</em>, <em>pendant='SALOME_Session_Server'</em>, <em>fin='killSalome.py'</em>, <em>log=None</em>, <em>delai=20</em>, <em>sommeil=1</em>, <em>delaiapp=0</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fork.html#batch_salome"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fork.batch_salome" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
+<dd><p>Launch a salome process</p>
+</dd></dl>
<dl class="function">
<dt id="src.fork.launch_command">
<code class="descclassname">src.fork.</code><code class="descname">launch_command</code><span class="sig-paren">(</span><em>cmd</em>, <em>logger</em>, <em>cwd</em>, <em>args=[]</em>, <em>log=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fork.html#launch_command"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fork.launch_command" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
+<dd><p>Launch command</p>
+</dd></dl>
<dl class="function">
<dt id="src.fork.show_progress">
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
-<li><strong>Logger</strong> (<em>logger</em>) – The logging instance</li>
-<li><strong>int</strong> (<em>delai</em>) – the number to display</li>
-<li><strong>int</strong> – the number max</li>
-<li><strong>str</strong> (<em>ss</em>) – the string to display</li>
+<li><strong>Logger</strong> (<em>logger</em>) -- The logging instance</li>
+<li><strong>int</strong> (<em>delai</em>) -- the number to display</li>
+<li><strong>int</strong> -- the number max</li>
+<li><strong>str</strong> (<em>ss</em>) -- the string to display</li>
</ul>
</td>
</tr>
<dl class="function">
<dt id="src.fork.write_back">
-<code class="descclassname">src.fork.</code><code class="descname">write_back</code><span class="sig-paren">(</span><em>logger</em>, <em>message</em>
, <em>level</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fork.html#write_back"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fork.write_back" title="Permalink to this definition">¶</a></dt>
+<code class="descclassname">src.fork.</code><code class="descname">write_back</code><span class="sig-paren">(</span><em>logger</em>, <em>message</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fork.html#write_back"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fork.write_back" title="Permalink to this definition">¶</a></dt>
<dd><p>shortcut function to write at the begin of the line</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
-<li><strong>Logger</strong> (<em>logger</em>) – The logging instance</li>
-<li><strong>str</strong> (<em>message</em>) – the text to display</li>
-<li><strong>int</strong> (<em>level</em>) – the level of verbosity</li>
+<li><strong>Logger</strong> (<em>logger</em>) -- The logging instance</li>
+<li><strong>str</strong> (<em>message</em>) -- the text to display</li>
+<li><strong>int</strong> (<em>level</em>) -- the level of verbosity</li>
</ul>
</td>
</tr>
</dd></dl>
</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>
-<p>Implements the classes and method relative to the logging</p>
+<div class="section" id="module-src.loggingSat">
+<span id="src-loggingsat-module"></span><h2>src.loggingSat module<a class="headerlink" href="#module-src.loggingSat" title="Permalink to this headline">¶</a></h2>
+<p><a class="reference external" href="http://sametmax.com/ecrire-des-logs-en-python/">http://sametmax.com/ecrire-des-logs-en-python/</a>
+<a class="reference external" href="https://docs.python.org/3/library/time.html#time.strftime">https://docs.python.org/3/library/time.html#time.strftime</a></p>
+<p>use logging package for salometools</p>
+<dl class="docutils">
+<dt>handler:</dt>
+<dd>on info() no format
+on other formatted indented on multi lines messages</dd>
+</dl>
+<dl class="class">
+<dt id="src.loggingSat.DefaultFormatter">
+<em class="property">class </em><code class="descclassname">src.loggingSat.</code><code class="descname">DefaultFormatter</code><span class="sig-paren">(</span><em>fmt=None</em>, <em>datefmt=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/loggingSat.html#DefaultFormatter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.loggingSat.DefaultFormatter" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">logging.Formatter</span></code></p>
+<dl class="method">
+<dt id="src.loggingSat.DefaultFormatter.format">
+<code class="descname">format</code><span class="sig-paren">(</span><em>record</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/loggingSat.html#DefaultFormatter.format"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.loggingSat.DefaultFormatter.format" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.loggingSat.DefaultFormatter.setColorLevelname">
+<code class="descname">setColorLevelname</code><span class="sig-paren">(</span><em>levelname</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/loggingSat.html#DefaultFormatter.setColorLevelname"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.loggingSat.DefaultFormatter.setColorLevelname" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="src.loggingSat.UnittestFormatter">
+<em class="property">class </em><code class="descclassname">src.loggingSat.</code><code class="descname">UnittestFormatter</code><span class="sig-paren">(</span><em>fmt=None</em>, <em>datefmt=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/loggingSat.html#UnittestFormatter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.loggingSat.UnittestFormatter" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">logging.Formatter</span></code></p>
+<dl class="method">
+<dt id="src.loggingSat.UnittestFormatter.format">
+<code class="descname">format</code><span class="sig-paren">(</span><em>record</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/loggingSat.html#UnittestFormatter.format"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.loggingSat.UnittestFormatter.format" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="src.loggingSat.UnittestStream">
+<em class="property">class </em><code class="descclassname">src.loggingSat.</code><code class="descname">UnittestStream</code><a class="reference internal" href="../../_modules/src/loggingSat.html#UnittestStream"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.loggingSat.UnittestStream" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
+<p>write my stream class
+only write and flush are used for the streaming
+<a class="reference external" href="https://docs.python.org/2/library/logging.handlers.html">https://docs.python.org/2/library/logging.handlers.html</a>
+<a class="reference external" href="https://stackoverflow.com/questions/31999627/storing-logger-messages-in-a-string">https://stackoverflow.com/questions/31999627/storing-logger-messages-in-a-string</a></p>
+<dl class="method">
+<dt id="src.loggingSat.UnittestStream.flush">
+<code class="descname">flush</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/loggingSat.html#UnittestStream.flush"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.loggingSat.UnittestStream.flush" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.loggingSat.UnittestStream.getLogs">
+<code class="descname">getLogs</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/loggingSat.html#UnittestStream.getLogs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.loggingSat.UnittestStream.getLogs" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.loggingSat.UnittestStream.getLogsAndClear">
+<code class="descname">getLogsAndClear</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/loggingSat.html#UnittestStream.getLogsAndClear"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.loggingSat.UnittestStream.getLogsAndClear" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.loggingSat.UnittestStream.write">
+<code class="descname">write</code><span class="sig-paren">(</span><em>astr</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/loggingSat.html#UnittestStream.write"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.loggingSat.UnittestStream.write" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="function">
+<dt id="src.loggingSat.dirLogger">
+<code class="descclassname">src.loggingSat.</code><code class="descname">dirLogger</code><span class="sig-paren">(</span><em>logger</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/loggingSat.html#dirLogger"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.loggingSat.dirLogger" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="function">
+<dt id="src.loggingSat.getDefaultLogger">
+<code class="descclassname">src.loggingSat.</code><code class="descname">getDefaultLogger</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/loggingSat.html#getDefaultLogger"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.loggingSat.getDefaultLogger" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="function">
+<dt id="src.loggingSat.getUnittestLogger">
+<code class="descclassname">src.loggingSat.</code><code class="descname">getUnittestLogger</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/loggingSat.html#getUnittestLogger"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.loggingSat.getUnittestLogger" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="function">
+<dt id="src.loggingSat.indent">
+<code class="descclassname">src.loggingSat.</code><code class="descname">indent</code><span class="sig-paren">(</span><em>msg</em>, <em>nb</em>, <em>car=' '</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/loggingSat.html#indent"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.loggingSat.indent" title="Permalink to this definition">¶</a></dt>
+<dd><p>indent nb car (spaces) multi lines message except first one</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.loggingSat.indentUnittest">
+<code class="descclassname">src.loggingSat.</code><code class="descname">indentUnittest</code><span class="sig-paren">(</span><em>msg</em>, <em>prefix=' | '</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/loggingSat.html#indentUnittest"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.loggingSat.indentUnittest" title="Permalink to this definition">¶</a></dt>
+<dd><p>indent car multi lines message except first one
+car default is less spaces for size logs files
+keep human readable</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.loggingSat.initLoggerAsDefault">
+<code class="descclassname">src.loggingSat.</code><code class="descname">initLoggerAsDefault</code><span class="sig-paren">(</span><em>logger</em>, <em>fmt=None</em>, <em>level=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/loggingSat.html#initLoggerAsDefault"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.loggingSat.initLoggerAsDefault" title="Permalink to this definition">¶</a></dt>
+<dd><p>init logger as prefixed message and indented message if multi line
+exept info() outed 'as it' without any format</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.loggingSat.initLoggerAsUnittest">
+<code class="descclassname">src.loggingSat.</code><code class="descname">initLoggerAsUnittest</code><span class="sig-paren">(</span><em>logger</em>, <em>fmt=None</em>, <em>level=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/loggingSat.html#initLoggerAsUnittest"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.loggingSat.initLoggerAsUnittest" title="Permalink to this definition">¶</a></dt>
+<dd><p>init logger as silent on stdout/stderr
+used for retrieve messages in memory for post execution unittest
+<a class="reference external" href="https://docs.python.org/2/library/logging.handlers.html">https://docs.python.org/2/library/logging.handlers.html</a></p>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.loggingSat.log">
+<code class="descclassname">src.loggingSat.</code><code class="descname">log</code><span class="sig-paren">(</span><em>msg</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/loggingSat.html#log"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.loggingSat.log" title="Permalink to this definition">¶</a></dt>
+<dd><p>elementary log when no logger yet</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.loggingSat.testLogger_1">
+<code class="descclassname">src.loggingSat.</code><code class="descname">testLogger_1</code><span class="sig-paren">(</span><em>logger</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/loggingSat.html#testLogger_1"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.loggingSat.testLogger_1" title="Permalink to this definition">¶</a></dt>
+<dd><p>small test</p>
+</dd></dl>
+
+</div>
+<div class="section" id="module-src.options">
+<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">
+<dt id="src.options.OptResult">
+<em class="property">class </em><code class="descclassname">src.options.</code><code class="descname">OptResult</code><a class="reference internal" href="../../_modules/src/options.html#OptResult"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.options.OptResult" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><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.</p>
+<dl class="docutils">
+<dt>example: </dt>
+<dd>>> print(options.level)
+>> 5</dd>
+</dl>
+</dd></dl>
+
<dl class="class">
-<dt id="src.logger.Logger">
-<em class="property">class </em><code class="descclassname">src.logger.</code><code class="descname">Logger</code><span class="sig-paren">(</span><em>config</em>, <em>silent_sysstd=False</em>, <em>all_in_terminal=False</em>, <em>micro_command=False</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/logger.html#Logger"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.logger.Logger" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
-<p>Class to handle log mechanism.</p>
+<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>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
+<p>Class to manage all salomeTools options</p>
<dl class="method">
-<dt id="src.logger.Logger.add_link">
-<code class="descname">add_link</code><span class="sig-paren">(</span><em>log_file_name</em>, <em>command_name</em>, <em>command_res</em>, <em>full_launched_command</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/logger.html#Logger.add_link"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.logger.Logger.add_link" title="Permalink to this definition">¶</a></dt>
-<dd><p>Add a link to another log file.</p>
+<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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
-<li><strong>str</strong> (<em>command_res</em>) – The file name of the link.</li>
-<li><strong>str</strong> – The name of the command linked.</li>
-<li><strong>str</strong> – The result of the command linked. “0” or “1”</li>
+<li><strong>str</strong> (<em>helpString</em>) -- The short name of the option
+(ex "l" for level option).</li>
+<li><strong>str</strong> -- The long name of the option
+(ex "level" for level option).</li>
+<li><strong>str</strong> -- The type of the option (ex "int").</li>
+<li><strong>str</strong> -- The name that will be used in the code.</li>
+<li><strong>str</strong> -- The text to display
+when user ask for help on a command.</li>
</ul>
</td>
</tr>
-<tr class="field-even field"><th class="field-name" colspan="2">Parma full_launched_command str:</th></tr>
-<tr class="field-even field"><td> </td><td class="field-body"><p class="first last">The full lanch command
-(“sat command …”)</p>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Nothing.</p>
+</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">NA</p>
</td>
</tr>
</tbody>
</dd></dl>
<dl class="method">
-<dt id="src.logger.Logger.end_write">
-<code class="descname">end_write</code><span class="sig-paren">(</span><em>attribute</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/logger.html#Logger.end_write"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.logger.Logger.end_write" title="Permalink to this definition">¶</a></dt>
-<dd><p>Called just after command end: Put all fields
-corresponding to the command end context (time).
-Write the log xml file on the hard drive.
-And display the command to launch to get the log</p>
+<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.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
+returns (shortName, longName, optionType, helpString')</p>
+</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>Method that 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">Parameters:</th><td class="field-body"><strong>dict</strong> (<em>attribute</em>) – the attribute to add to the node “Site”.</td>
+<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">colored string</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">NA</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
-<dt id="src.logger.Logger.error">
-<code class="descname">error</code><span class="sig-paren">(</span><em>message</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/logger.html#Logger.error"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.logger.Logger.error" title="Permalink to this definition">¶</a></dt>
-<dd><p>Print an error.</p>
+<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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>message</em>) – The message to print.</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>list</strong> (<em>argList</em>) -- the raw list of arguments that were passed</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">optResult, args : optResult is the option instance
+to manipulate in the code. args
+is the full raw list of passed options</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">(class 'common.options.OptResult',list)</td>
</tr>
</tbody>
</table>
</dd></dl>
-<dl class="method">
-<dt id="src.logger.Logger.flush">
-<code class="descname">flush</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/logger.html#Logger.flush"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.logger.Logger.flush" title="Permalink to this definition">¶</a></dt>
-<dd><p>Flush terminal</p>
-</dd></dl>
-
-<dl class="method">
-<dt id="src.logger.Logger.put_initial_xml_fields">
-<code class="descname">put_initial_xml_fields</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/logger.html#Logger.put_initial_xml_fields"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.logger.Logger.put_initial_xml_fields" title="Permalink to this definition">¶</a></dt>
-<dd><p>Called at class initialization: Put all fields
-corresponding to the command context (user, time, …)</p>
</dd></dl>
-<dl class="method">
-<dt id="src.logger.Logger.write">
-<code class="descname">write</code><span class="sig-paren">(</span><em>message</em>, <em>level=None</em>, <em>screenOnly=False</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/logger.html#Logger.write"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.logger.Logger.write" title="Permalink to this definition">¶</a></dt>
-<dd><p>function used in the commands
-to print in the terminal and the log file.</p>
+</div>
+<div class="section" id="module-src.product">
+<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">
+<dt id="src.product.check_config_exists">
+<code class="descclassname">src.product.</code><code class="descname">check_config_exists</code><span class="sig-paren">(</span><em>config</em>, <em>prod_dir</em>, <em>prod_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#check_config_exists"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.check_config_exists" title="Permalink to this definition">¶</a></dt>
+<dd><dl class="docutils">
+<dt>Verify that the installation directory of a product in a base exists</dt>
+<dd>Check all the config-<i> directory and verify the sat-config.pyconf file
+that is in it</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 last simple">
-<li><strong>str</strong> (<em>message</em>) – The message to print.</li>
-<li><strong>int</strong> (<em>level</em>) – The output level corresponding
-to the message 0 < level < 6.</li>
-<li><strong>boolean</strong> (<em>screenOnly</em>) – if True, do not write in log file.</li>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>Config</strong> (<em>product_info</em>) -- The global configuration</li>
+<li><strong>str</strong> (<em>prod_dir</em>) -- The product installation directory path
+(without config-<i>)</li>
+<li><strong>Config</strong> -- The configuration specific to
+the product</li>
</ul>
</td>
</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">True or false is the installation is found or not
+and if it is found, the path of the found installation</p>
+</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">(boolean, str)</p>
+</td>
+</tr>
</tbody>
</table>
</dd></dl>
-</dd></dl>
-
<dl class="function">
-<dt id="src.logger.date_to_datetime">
-<code class="descclassname">src.logger.</code><code class="descname">date_to_datetime</code><span class="sig-paren">(</span><em>date</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/logger.html#date_to_datetime"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.logger.date_to_datetime" title="Permalink to this definition">¶</a></dt>
-<dd><p>From a string date in format YYYYMMDD_HHMMSS
-returns list year, mon, day, hour, minutes, seconds</p>
+<dt id="src.product.check_installation">
+<code class="descclassname">src.product.</code><code class="descname">check_installation</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#check_installation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.check_installation" title="Permalink to this definition">¶</a></dt>
+<dd><dl class="docutils">
+<dt>Verify if a product is well installed. Checks install directory presence</dt>
+<dd>and some additional files if it is defined in the config</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>date</em>) – The date in format YYYYMMDD_HHMMSS</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>product_info</em>) -- The configuration specific to
+the product</td>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">the same date and time in separate variables.</td>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if it is well installed</td>
</tr>
-<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">(str,str,str,str,str,str)</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.logger.list_log_file">
-<code class="descclassname">src.logger.</code><code class="descname">list_log_file</code><span class="sig-paren">(</span><em>dirPath</em>, <em>expression</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/logger.html#list_log_file"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.logger.list_log_file" title="Permalink to this definition">¶</a></dt>
-<dd><p>Find all files corresponding to expression in dirPath</p>
+<dt id="src.product.get_base_install_dir">
+<code class="descclassname">src.product.</code><code class="descname">get_base_install_dir</code><span class="sig-paren">(</span><em>config</em>, <em>prod_info</em>, <em>version</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#get_base_install_dir"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.get_base_install_dir" title="Permalink to this definition">¶</a></dt>
+<dd><p>Compute the installation directory of a product in base</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
-<li><strong>str</strong> (<em>expression</em>) – the directory where to search the files</li>
-<li><strong>str</strong> – the regular expression of files to find</li>
+<li><strong>Config</strong> (<em>product_info</em>) -- The global configuration</li>
+<li><strong>Config</strong> -- The configuration specific to
+the product</li>
+<li><strong>str</strong> (<em>version</em>) -- The version of the product</li>
</ul>
</td>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">the list of files path and informations about it</p>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The path of the product installation</p>
</td>
</tr>
-<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">list</p>
+<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>
</dd></dl>
<dl class="function">
-<dt id="src.logger.show_command_log">
-<code class="descclassname">src.logger.</code><code class="descname">show_command_log</code><span class="sig-paren">(</span><em>logFilePath</em>, <em>cmd</em>, <em>application</em>, <em>notShownCommands</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/logger.html#show_command_log"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.logger.show_command_log" title="Permalink to this definition">¶</a></dt>
-<dd><p>Used in updateHatXml.
-Determine if the log xml file logFilePath
-has to be shown or not in the hat log.</p>
+<dt id="src.product.get_install_dir">
+<code class="descclassname">src.product.</code><code class="descname">get_install_dir</code><span class="sig-paren">(</span><em>config</em>, <em>base</em>, <em>version</em>, <em>prod_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#get_install_dir"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.get_install_dir" title="Permalink to this definition">¶</a></dt>
+<dd><p>Compute the installation directory of a given product</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
-<li><strong>str</strong> (<em>application</em>) – the path to the command xml log file</li>
-<li><strong>str</strong> – the command of the log file</li>
-<li><strong>str</strong> – the application passed as parameter
-to the salomeTools command</li>
-<li><strong>list</strong> (<em>notShownCommands</em>) – the list of commands
-that are not shown by default</li>
+<li><strong>Config</strong> (<em>product_info</em>) -- The global configuration</li>
+<li><strong>str</strong> (<em>version</em>) -- This corresponds to the value given by user in its application.pyconf for the specific product. If "yes", the user wants the product to be in base. If "no", he wants the product to be in the application workdir</li>
+<li><strong>str</strong> -- The version of the product</li>
+<li><strong>Config</strong> -- The configuration specific to the product</li>
</ul>
</td>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">True if cmd is not in notShownCommands and the application
-in the log file corresponds to application</p>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The path of the product installation</p>
</td>
</tr>
-<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">boolean</p>
+<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>
</dd></dl>
<dl class="function">
-<dt id="src.logger.timedelta_total_seconds">
-<code class="descclassname">src.logger.</code><code class="descname">timedelta_total_seconds</code><span class="sig-paren">(</span><em>timedelta</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/logger.html#timedelta_total_seconds"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.logger.timedelta_total_seconds" title="Permalink to this definition">¶</a></dt>
-<dd><p>Replace total_seconds from datetime module
-in order to be compatible with old python versions</p>
+<dt id="src.product.get_product_components">
+<code class="descclassname">src.product.</code><code class="descname">get_product_components</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#get_product_components"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.get_product_components" title="Permalink to this definition">¶</a></dt>
+<dd><p>Get the component list to generate with the product</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>datetime.timedelta</strong> (<em>timedelta</em>) – The delta between two dates</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>product_info</em>) -- The configuration specific to
+the product</td>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The number of seconds corresponding to timedelta.</td>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The list of names of the components</td>
</tr>
-<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">float</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.logger.update_hat_xml">
-<code class="descclassname">src.logger.</code><code class="descname">update_hat_xml</code><span class="sig-paren">(</span><em>logDir</em>, <em>application=None</em>, <em>notShownCommands=[]</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/logger.html#update_hat_xml"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.logger.update_hat_xml" title="Permalink to this definition">¶</a></dt>
-<dd><p>Create the xml file in logDir that contain all the xml file
-and have a name like YYYYMMDD_HHMMSS_namecmd.xml</p>
+<dt id="src.product.get_product_config">
+<code class="descclassname">src.product.</code><code class="descname">get_product_config</code><span class="sig-paren">(</span><em>config</em>, <em>product_name</em>, <em>with_install_dir=True</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#get_product_config"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.get_product_config" title="Permalink to this definition">¶</a></dt>
+<dd><p>Get the specific configuration of a product from the global configuration</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
-<li><strong>str</strong> (<em>application</em>) – the directory to parse</li>
-<li><strong>str</strong> – the name of the application if there is any</li>
-</ul>
-</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>Config</strong> (<em>config</em>) -- The global configuration</li>
+<li><strong>str</strong> (<em>product_name</em>) -- The name of the product</li>
+<li><strong>boolean</strong> (<em>with_install_dir</em>) -- If false, do not provide an install
+directory (at false only for internal use
+of the function check_config_exists)</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">the specific configuration of the product</p>
+</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="#src.pyconf.Config" title="src.pyconf.Config">Config</a></p>
+</td>
</tr>
</tbody>
</table>
</dd></dl>
-</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>
-<p>The Options class that manages the access to all options passed as
-parameters in salomeTools command lines</p>
-<dl class="class">
-<dt id="src.options.OptResult">
-<em class="property">class </em><code class="descclassname">src.options.</code><code class="descname">OptResult</code><a class="reference internal" href="../../_modules/src/options.html#OptResult"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.options.OptResult" title="Permalink to this definition">¶</a></dt>
-<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>
-</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>
-<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>
+<dl class="function">
+<dt id="src.product.get_product_dependencies">
+<code class="descclassname">src.product.</code><code class="descname">get_product_dependencies</code><span class="sig-paren">(</span><em>config</em>, <em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#get_product_dependencies"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.get_product_dependencies" title="Permalink to this definition">¶</a></dt>
<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>
+<dt>Get recursively the list of products that are </dt>
+<dd>in the product_info dependencies</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>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>Config</strong> (<em>product_info</em>) -- The global configuration</li>
+<li><strong>Config</strong> -- The configuration specific to
+the product</li>
</ul>
</td>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Nothing.</p>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">the list of products in dependence</p>
</td>
</tr>
-<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">NA</p>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="#src.utilsSat.Path.list" title="src.utilsSat.Path.list">list</a></p>
</td>
</tr>
</tbody>
</table>
</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>
+<dl class="function">
+<dt id="src.product.get_product_section">
+<code class="descclassname">src.product.</code><code class="descname">get_product_section</code><span class="sig-paren">(</span><em>config</em>, <em>product_name</em>, <em>version</em>, <em>section=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#get_product_section"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.get_product_section" title="Permalink to this definition">¶</a></dt>
+<dd><p>Get the product description from the configuration</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>list</strong> (<em>argList</em>) – the raw list of arguments that were passed</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>Config</strong> (<em>config</em>) -- The global configuration</li>
+<li><strong>str</strong> (<em>section</em>) -- The product name</li>
+<li><strong>str</strong> -- The version of the product</li>
+<li><strong>str</strong> -- The searched section (if not None, the section is
+explicitly given</li>
+</ul>
+</td>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">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-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The product description</p>
+</td>
</tr>
-<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">(class ‘common.options.OptResult’,list)</td>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="#src.pyconf.Config" title="src.pyconf.Config">Config</a></p>
+</td>
</tr>
</tbody>
</table>
</dd></dl>
-<dl class="method">
-<dt id="src.options.Options.print_help">
-<code class="descname">print_help</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/options.html#Options.print_help"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.options.Options.print_help" title="Permalink to this definition">¶</a></dt>
-<dd><p>Method that display all options stored in self.options and there help</p>
+<dl class="function">
+<dt id="src.product.get_products_infos">
+<code class="descclassname">src.product.</code><code class="descname">get_products_infos</code><span class="sig-paren">(</span><em>lproducts</em>, <em>config</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#get_products_infos"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.get_products_infos" title="Permalink to this definition">¶</a></dt>
+<dd><p>Get the specific configuration of a list of products</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Nothing.</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>List</strong> (<em>lproducts</em>) -- The list of product names</li>
+<li><strong>Config</strong> (<em>config</em>) -- The global configuration</li>
+</ul>
+</td>
</tr>
-<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">NA</td>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">the list of tuples
+(product name, specific configuration of the product)</p>
+</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">[(str, Config)]</p>
+</td>
</tr>
</tbody>
</table>
</dd></dl>
-</dd></dl>
-
-</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>
-<p>In this file is stored the mechanism that manage color prints in the terminal</p>
<dl class="function">
-<dt id="src.printcolors.cleancolor">
-<code class="descclassname">src.printcolors.</code><code class="descname">cleancolor</code><span class="sig-paren">(</span><em>message</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/printcolors.html#cleancolor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.printcolors.cleancolor" title="Permalink to this definition">¶</a></dt>
-<dd><p>remove color from a colored text.</p>
+<dt id="src.product.product_compiles">
+<code class="descclassname">src.product.</code><code class="descname">product_compiles</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#product_compiles"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.product_compiles" title="Permalink to this definition">¶</a></dt>
+<dd><dl class="docutils">
+<dt>Know if a product compiles or not (some products do not have a </dt>
+<dd>compilation procedure)</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>message</em>) – The text to be cleaned.</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>product_info</em>) -- The configuration specific to
+the product</td>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The cleaned text.</td>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product compiles, else False</td>
</tr>
-<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</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.printcolors.print_color_map">
-<code class="descclassname">src.printcolors.</code><code class="descname">print_color_map</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/printcolors.html#print_color_map"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.printcolors.print_color_map" title="Permalink to this definition">¶</a></dt>
-<dd><p>This method prints the color map</p>
-</dd></dl>
-
-<dl class="function">
-<dt id="src.printcolors.print_color_range">
-<code class="descclassname">src.printcolors.</code><code class="descname">print_color_range</code><span class="sig-paren">(</span><em>start</em>, <em>end</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/printcolors.html#print_color_range"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.printcolors.print_color_range" title="Permalink to this definition">¶</a></dt>
-<dd><p>print possible range values for colors</p>
+<dt id="src.product.product_has_env_script">
+<code class="descclassname">src.product.</code><code class="descname">product_has_env_script</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#product_has_env_script"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.product_has_env_script" title="Permalink to this definition">¶</a></dt>
+<dd><p>Know if a product has an environment script</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
-<li><strong>int</strong> (<em>end</em>) – The smaller value.</li>
-<li><strong>int</strong> – The bigger value.</li>
-</ul>
-</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>product_info</em>) -- The configuration specific to
+the product</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product it has an environment script, else False</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
-<dt id="src.printcolors.print_value">
-<code class="descclassname">src.printcolors.</code><code class="descname">print_value</code><span class="sig-paren">(</span><em>logger</em>, <em>label</em>, <em>value</em>, <em>level=1</em>, <em>suffix=''</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/printcolors.html#print_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.printcolors.print_value" title="Permalink to this definition">¶</a></dt>
-<dd><p>shortcut method to print a label and a value with the info color</p>
+<dt id="src.product.product_has_logo">
+<code class="descclassname">src.product.</code><code class="descname">product_has_logo</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#product_has_logo"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.product_has_logo" title="Permalink to this definition">¶</a></dt>
+<dd><p>Know if a product has a logo (YACSGEN generate)</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
-<li><strong>class logger</strong> (<em>logger</em>) – the logger instance.</li>
-<li><strong>int</strong> (<em>level</em>) – the label to print.</li>
-<li><strong>str</strong> (<em>suffix</em>) – the value to print.</li>
-<li><strong>int</strong> – the level of verboseness.</li>
-<li><strong>str</strong> – the suffix to add at the end.</li>
-</ul>
-</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>product_info</em>) -- The configuration specific to
+the product</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The path of the logo if the product has a logo, else False</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">Str</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
-<dt id="src.printcolors.printc">
-<code class="descclassname">src.printcolors.</code><code class="descname">printc</code><span class="sig-paren">(</span><em>txt</em>, <em>code=''</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/printcolors.html#printc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.printcolors.printc" title="Permalink to this definition">¶</a></dt>
-<dd><p>print a text with colors</p>
+<dt id="src.product.product_has_patches">
+<code class="descclassname">src.product.</code><code class="descname">product_has_patches</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#product_has_patches"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.product_has_patches" title="Permalink to this definition">¶</a></dt>
+<dd><p>Know if a product has one or more patches</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
-<li><strong>str</strong> (<em>code</em>) – The text to be printed.</li>
-<li><strong>str</strong> – The color to use.</li>
-</ul>
-</td>
+<tr 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"><p class="first">The colored text.</p>
-</td>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product has one or more patches</td>
</tr>
-<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">str</p>
-</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.printcolors.printcError">
-<code class="descclassname">src.printcolors.</code><code class="descname">printcError</code><span class="sig-paren">(</span><em>txt</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/printcolors.html#printcError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.printcolors.printcError" title="Permalink to this definition">¶</a></dt>
-<dd><p>print a text error color</p>
+<dt id="src.product.product_has_salome_gui">
+<code class="descclassname">src.product.</code><code class="descname">product_has_salome_gui</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#product_has_salome_gui"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.product_has_salome_gui" title="Permalink to this definition">¶</a></dt>
+<dd><p>Know if a product has a SALOME gui</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>txt</em>) – The text to be printed.</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>product_info</em>) -- The configuration specific to
+the product</td>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The colored text.</td>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product has a SALOME gui, else False</td>
</tr>
-<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</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.printcolors.printcHeader">
-<code class="descclassname">src.printcolors.</code><code class="descname">printcHeader</code><span class="sig-paren">(</span><em>txt</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/printcolors.html#printcHeader"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.printcolors.printcHeader" title="Permalink to this definition">¶</a></dt>
-<dd><p>print a text header color</p>
+<dt id="src.product.product_has_script">
+<code class="descclassname">src.product.</code><code class="descname">product_has_script</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#product_has_script"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.product_has_script" title="Permalink to this definition">¶</a></dt>
+<dd><p>Know if a product has a compilation script</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>txt</em>) – The text to be printed.</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>product_info</em>) -- The configuration specific to
+the product</td>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The colored text.</td>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product it has a compilation script, else False</td>
</tr>
-<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</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.printcolors.printcHighlight">
-<code class="descclassname">src.printcolors.</code><code class="descname">printcHighlight</code><span class="sig-paren">(</span><em>txt</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/printcolors.html#printcHighlight"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.printcolors.printcHighlight" title="Permalink to this definition">¶</a></dt>
-<dd><p>print a text highlight color</p>
+<dt id="src.product.product_is_SALOME">
+<code class="descclassname">src.product.</code><code class="descname">product_is_SALOME</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#product_is_SALOME"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.product_is_SALOME" title="Permalink to this definition">¶</a></dt>
+<dd><p>Know if a product is a SALOME module</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>txt</em>) – The text to be printed.</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>product_info</em>) -- The configuration specific to
+the product</td>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The colored text.</td>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product is a SALOME module, else False</td>
</tr>
-<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</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.printcolors.printcInfo">
-<code class="descclassname">src.printcolors.</code><code class="descname">printcInfo</code><span class="sig-paren">(</span><em>txt</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/printcolors.html#printcInfo"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.printcolors.printcInfo" title="Permalink to this definition">¶</a></dt>
-<dd><p>print a text info color</p>
+<dt id="src.product.product_is_autotools">
+<code class="descclassname">src.product.</code><code class="descname">product_is_autotools</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#product_is_autotools"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.product_is_autotools" title="Permalink to this definition">¶</a></dt>
+<dd><p>Know if a product is compiled using the autotools</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>txt</em>) – The text to be printed.</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>product_info</em>) -- The configuration specific to
+the product</td>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The colored text.</td>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product is autotools, else False</td>
</tr>
-<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</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.printcolors.printcLabel">
-<code class="descclassname">src.printcolors.</code><code class="descname">printcLabel</code><span class="sig-paren">(</span><em>txt</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/printcolors.html#printcLabel"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.printcolors.printcLabel" title="Permalink to this definition">¶</a></dt>
-<dd><p>print a text label color</p>
+<dt id="src.product.product_is_cmake">
+<code class="descclassname">src.product.</code><code class="descname">product_is_cmake</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#product_is_cmake"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.product_is_cmake" title="Permalink to this definition">¶</a></dt>
+<dd><p>Know if a product is compiled using the cmake</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>txt</em>) – The text to be printed.</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>product_info</em>) -- The configuration specific to
+the product</td>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The colored text.</td>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product is cmake, else False</td>
</tr>
-<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</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.printcolors.printcSuccess">
-<code class="descclassname">src.printcolors.</code><code class="descname">printcSuccess</code><span class="sig-paren">(</span><em>txt</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/printcolors.html#printcSuccess"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.printcolors.printcSuccess" title="Permalink to this definition">¶</a></dt>
-<dd><p>print a text success color</p>
+<dt id="src.product.product_is_cpp">
+<code class="descclassname">src.product.</code><code class="descname">product_is_cpp</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#product_is_cpp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.product_is_cpp" title="Permalink to this definition">¶</a></dt>
+<dd><p>Know if a product is cpp</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>txt</em>) – The text to be printed.</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>product_info</em>) -- The configuration specific to
+the product</td>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The colored text.</td>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product is a cpp, else False</td>
</tr>
-<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</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.printcolors.printcWarning">
-<code class="descclassname">src.printcolors.</code><code class="descname">printcWarning</code><span class="sig-paren">(</span><em>txt</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/printcolors.html#printcWarning"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.printcolors.printcWarning" title="Permalink to this definition">¶</a></dt>
-<dd><p>print a text warning color</p>
+<dt id="src.product.product_is_debug">
+<code class="descclassname">src.product.</code><code class="descname">product_is_debug</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#product_is_debug"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.product_is_debug" title="Permalink to this definition">¶</a></dt>
+<dd><p>Know if a product is in debug mode</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>txt</em>) – The text to be printed.</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>product_info</em>) -- The configuration specific to
+the product</td>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The colored text.</td>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product is in debug mode, else False</td>
</tr>
-<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>
+<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.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>
-<p>In this file are implemented the methods
-relative to the product notion of salomeTools</p>
<dl class="function">
-<dt id="src.product.check_config_exists">
-<code class="descclassname">src.product.</code><code class="descname">check_config_exists</code><span class="sig-paren">(</span><em>config</em>, <em>prod_dir</em>, <em>prod_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#check_config_exists"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.check_config_exists" title="Permalink to this definition">¶</a></dt>
-<dd><p>Verify that the installation directory of a product in a base exists
-Check all the config-<i> directory and verify the sat-config.pyconf file
-that is in it</p>
+<dt id="src.product.product_is_dev">
+<code class="descclassname">src.product.</code><code class="descname">product_is_dev</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#product_is_dev"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.product_is_dev" title="Permalink to this definition">¶</a></dt>
+<dd><p>Know if a product is in dev mode</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
-<li><strong>Config</strong> (<em>product_info</em>) – The global configuration</li>
-<li><strong>str</strong> (<em>prod_dir</em>) – The product installation directory path
-(without config-<i>)</li>
-<li><strong>Config</strong> – The configuration specific to
-the product</li>
-</ul>
-</td>
+<tr 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"><p class="first">True or false is the installation is found or not
-and if it is found, the path of the found installation</p>
-</td>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product is in dev mode, else False</td>
</tr>
-<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">(boolean, str)</p>
-</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.product.check_installation">
-<code class="descclassname">src.product.</code><code class="descname">check_installation</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#check_installation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.check_installation" title="Permalink to this definition">¶</a></dt>
-<dd><p>Verify if a product is well installed. Checks install directory presence
-and some additional files if it is defined in the config</p>
+<dt id="src.product.product_is_fixed">
+<code class="descclassname">src.product.</code><code class="descname">product_is_fixed</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#product_is_fixed"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.product_is_fixed" title="Permalink to this definition">¶</a></dt>
+<dd><p>Know if a product is fixed</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>product_info</em>) – The configuration specific to
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>product_info</em>) -- The configuration specific to
the product</td>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if it is well installed</td>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product is fixed, else False</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
</tr>
</dd></dl>
<dl class="function">
-<dt id="src.product.check_source">
-<code class="descclassname">src.product.</code><code class="descname">check_source</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#check_source"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.check_source" title="Permalink to this definition">¶</a></dt>
-<dd><p>Verify if a sources of product is preset. Checks source directory presence</p>
+<dt id="src.product.product_is_generated">
+<code class="descclassname">src.product.</code><code class="descname">product_is_generated</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#product_is_generated"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.product_is_generated" title="Permalink to this definition">¶</a></dt>
+<dd><p>Know if a product is generated (YACSGEN)</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>product_info</em>) – The configuration specific to
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>product_info</em>) -- The configuration specific to
the product</td>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if it is well installed</td>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product is generated</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
</tr>
</dd></dl>
<dl class="function">
-<dt id="src.product.get_base_install_dir">
-<code class="descclassname">src.product.</code><code class="descname">get_base_install_dir</code><span class="sig-paren">(</span><em>config</em>, <em>prod_info</em>, <em>version</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#get_base_install_dir"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.get_base_install_dir" title="Permalink to this definition">¶</a></dt>
-<dd><p>Compute the installation directory of a product in base</p>
+<dt id="src.product.product_is_mpi">
+<code class="descclassname">src.product.</code><code class="descname">product_is_mpi</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#product_is_mpi"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.product_is_mpi" title="Permalink to this definition">¶</a></dt>
+<dd><p>Know if a product has openmpi in its dependencies</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
-<li><strong>Config</strong> (<em>product_info</em>) – The global configuration</li>
-<li><strong>Config</strong> – The configuration specific to
-the product</li>
-<li><strong>str</strong> (<em>version</em>) – The version of the product</li>
-</ul>
-</td>
+<tr 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"><p class="first">The path of the product installation</p>
-</td>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product has openmpi inits dependencies</td>
</tr>
-<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">str</p>
-</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.product.get_install_dir">
-<code class="descclassname">src.product.</code><code class="descname">get_install_dir</code><span class="sig-paren">(</span><em>config</em>, <em>base</em>, <em>version</em>, <em>prod_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#get_install_dir"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.get_install_dir" title="Permalink to this definition">¶</a></dt>
-<dd><p>Compute the installation directory of a given product</p>
+<dt id="src.product.product_is_native">
+<code class="descclassname">src.product.</code><code class="descname">product_is_native</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#product_is_native"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.product_is_native" title="Permalink to this definition">¶</a></dt>
+<dd><p>Know if a product is native</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
-<li><strong>Config</strong> (<em>product_info</em>) – The global configuration</li>
-<li><strong>str</strong> (<em>version</em>) – This corresponds to the value given by user in its
-application.pyconf for the specific product. If “yes”, the
-user wants the product to be in base. If “no”, he wants the
-product to be in the application workdir</li>
-<li><strong>str</strong> – The version of the product</li>
-<li><strong>Config</strong> – The configuration specific to
-the product</li>
-</ul>
-</td>
+<tr 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"><p class="first">The path of the product installation</p>
-</td>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product is native, else False</td>
</tr>
-<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">str</p>
-</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.product.get_product_components">
-<code class="descclassname">src.product.</code><code class="descname">get_product_components</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#get_product_components"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.get_product_components" title="Permalink to this definition">¶</a></dt>
-<dd><p>Get the component list to generate with the product</p>
+<dt id="src.product.product_is_salome">
+<code class="descclassname">src.product.</code><code class="descname">product_is_salome</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#product_is_salome"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.product_is_salome" title="Permalink to this definition">¶</a></dt>
+<dd><p>Know if a product is of type salome</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>product_info</em>) – The configuration specific to
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>product_info</em>) -- The configuration specific to
the product</td>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The list of names of the components</td>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product is salome, else False</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.product.get_product_config">
-<code class="descclassname">src.product.</code><code class="descname">get_product_config</code><span class="sig-paren">(</span><em>config</em>, <em>product_name</em>, <em>with_install_dir=True</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#get_product_config"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.get_product_config" title="Permalink to this definition">¶</a></dt>
-<dd><p>Get the specific configuration of a product from the global configuration</p>
+<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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
-<li><strong>Config</strong> (<em>config</em>) – The global configuration</li>
-<li><strong>str</strong> (<em>product_name</em>) – The name of the product</li>
-<li><strong>boolean</strong> (<em>with_install_dir</em>) – If false, do not provide an install
-directory (at false only for internal use
-of the function check_config_exists)</li>
-</ul>
-</td>
+<tr 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"><p class="first">the specific configuration of the product</p>
-</td>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product has the sample type, else False</td>
</tr>
-<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="#src.pyconf.Config" title="src.pyconf.Config">Config</a></p>
-</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.product.get_product_dependencies">
-<code class="descclassname">src.product.</code><code class="descname">get_product_dependencies</code><span class="sig-paren">(</span><em>config</em>, <em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#get_product_dependencies"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.get_product_dependencies" title="Permalink to this definition">¶</a></dt>
-<dd><p>Get recursively the list of products that are
-in the product_info dependencies</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" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
-<li><strong>Config</strong> (<em>product_info</em>) – The global configuration</li>
-<li><strong>Config</strong> – The configuration specific to
-the product</li>
-</ul>
-</td>
+<tr 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"><p class="first">the list of products in dependence</p>
-</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"><p class="first last">list</p>
-</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.product.get_product_section">
-<code class="descclassname">src.product.</code><code class="descname">get_product_section</code><span class="sig-paren">(</span><em>config</em>, <em>product_name</em>, <em>version</em>, <em>section=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#get_product_section"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.get_product_section" title="Permalink to this definition">¶</a></dt>
-<dd><p>Get the product description from the configuration</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" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
-<li><strong>Config</strong> (<em>config</em>) – The global configuration</li>
-<li><strong>str</strong> (<em>section</em>) – The product name</li>
-<li><strong>str</strong> – The version of the product</li>
-<li><strong>str</strong> – The searched section (if not None, the section is
-explicitly given</li>
-</ul>
-</td>
+<tr 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"><p class="first">The product description</p>
-</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"><p class="first last"><a class="reference internal" href="#src.pyconf.Config" title="src.pyconf.Config">Config</a></p>
-</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.product.get_products_infos">
-<code class="descclassname">src.product.</code><code class="descname">get_products_infos</code><span class="sig-paren">(</span><em>lproducts</em>, <em>config</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#get_products_infos"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.get_products_infos" title="Permalink to this definition">¶</a></dt>
-<dd><p>Get the specific configuration of a list of products</p>
-<table class="docutils field-list" frame="void" rules="none">
-<col class="field-name" />
-<col class="field-body" />
-<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
-<li><strong>List</strong> (<em>lproducts</em>) – The list of product names</li>
-<li><strong>Config</strong> (<em>config</em>) – The global configuration</li>
-</ul>
-</td>
-</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">the list of tuples
-(product name, specific configuration of the product)</p>
-</td>
-</tr>
-<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">[(str, <a class="reference internal" href="#src.pyconf.Config" title="src.pyconf.Config">Config</a>)]</p>
-</td>
-</tr>
-</tbody>
-</table>
-</dd></dl>
+</div>
+<div class="section" id="module-src.pyconf">
+<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>
+<p>Development and testing has only been carried out (so far) on Python 2.3.4 and
+Python 2.4.2. See the test module (test_config.py) included in the
+U{distribution<<a class="reference external" href="http://www.red-dove.com/python_config">http://www.red-dove.com/python_config</a>.html|_blank>} (follow the
+download link).</p>
+<p>A simple example - with the example configuration file:</p>
+<div class="highlight-default"><div class="highlight"><pre><span></span>messages:
+[
+ {
+ stream : `sys.stderr`
+ message: 'Welcome'
+ name: 'Harry'
+ }
+ {
+ stream : `sys.stdout`
+ message: 'Welkom'
+ name: 'Ruud'
+ }
+ {
+ stream : $messages[0].stream
+ message: 'Bienvenue'
+ name: Yves
+ }
+]
+</pre></div>
+</div>
+<p>a program to read the configuration would be:</p>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">config</span> <span class="k">import</span> <span class="n">Config</span>
-<dl class="function">
-<dt id="src.product.product_compiles">
-<code class="descclassname">src.product.</code><code class="descname">product_compiles</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#product_compiles"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.product_compiles" title="Permalink to this definition">¶</a></dt>
-<dd><p>Know if a product compiles or not
-(some products do not have a compilation procedure)</p>
-<table class="docutils field-list" frame="void" rules="none">
-<col class="field-name" />
-<col class="field-body" />
-<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>product_info</em>) – The configuration specific to
-the product</td>
-</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product compiles, else False</td>
-</tr>
-<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
-</tr>
-</tbody>
-</table>
+<span class="n">f</span> <span class="o">=</span> <span class="n">file</span><span class="p">(</span><span class="s1">'simple.cfg'</span><span class="p">)</span>
+<span class="n">cfg</span> <span class="o">=</span> <span class="n">Config</span><span class="p">(</span><span class="n">f</span><span class="p">)</span>
+<span class="k">for</span> <span class="n">m</span> <span class="ow">in</span> <span class="n">cfg</span><span class="o">.</span><span class="n">messages</span><span class="p">:</span>
+ <span class="n">s</span> <span class="o">=</span> <span class="s1">'</span><span class="si">%s</span><span class="s1">, </span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">message</span><span class="p">,</span> <span class="n">m</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="nb">print</span> <span class="o">>></span> <span class="n">m</span><span class="o">.</span><span class="n">stream</span><span class="p">,</span> <span class="n">s</span>
+ <span class="k">except</span> <span class="ne">IOError</span><span class="p">,</span> <span class="n">e</span><span class="p">:</span>
+ <span class="nb">print</span> <span class="n">e</span>
+</pre></div>
+</div>
+<p>which, when run, would yield the console output:</p>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">Welcome</span><span class="p">,</span> <span class="n">Harry</span>
+<span class="n">Welkom</span><span class="p">,</span> <span class="n">Ruud</span>
+<span class="n">Bienvenue</span><span class="p">,</span> <span class="n">Yves</span>
+</pre></div>
+</div>
+<p>See U{this tutorial<<a class="reference external" href="http://www.red-dove.com/python_config">http://www.red-dove.com/python_config</a>.html|_blank>} for more
+information.</p>
+<p>#modified for salomeTools
+@version: 0.3.7.1</p>
+<p>@author: Vinay Sajip</p>
+<p>@copyright: Copyright (C) 2004-2007 Vinay Sajip. All Rights Reserved.</p>
+<p>@var streamOpener: The default stream opener. This is a factory function which
+takes a string (e.g. filename) and returns a stream suitable for reading. If
+unable to open the stream, an IOError exception should be thrown.</p>
+<p>The default value of this variable is L{defaultStreamOpener}. For an example
+of how it's used, see test_config.py (search for streamOpener).</p>
+<dl class="class">
+<dt id="src.pyconf.Config">
+<em class="property">class </em><code class="descclassname">src.pyconf.</code><code class="descname">Config</code><span class="sig-paren">(</span><em>streamOrFile=None</em>, <em>parent=None</em>, <em>PWD=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Config"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Config" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="#src.pyconf.Mapping" title="src.pyconf.Mapping"><code class="xref py py-class docutils literal"><span class="pre">src.pyconf.Mapping</span></code></a></p>
+<p>This class represents a configuration, and is the only one which clients
+need to interface to, under normal circumstances.</p>
+<dl class="class">
+<dt id="src.pyconf.Config.Namespace">
+<em class="property">class </em><code class="descname">Namespace</code><a class="reference internal" href="../../_modules/src/pyconf.html#Config.Namespace"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Config.Namespace" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
+<p>This internal class is used for implementing default namespaces.</p>
+<p>An instance acts as a namespace.</p>
</dd></dl>
-<dl class="function">
-<dt id="src.product.product_has_env_script">
-<code class="descclassname">src.product.</code><code class="descname">product_has_env_script</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#product_has_env_script"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.product_has_env_script" title="Permalink to this definition">¶</a></dt>
-<dd><p>Know if a product has an environment script</p>
-<table class="docutils field-list" frame="void" rules="none">
-<col class="field-name" />
-<col class="field-body" />
-<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>product_info</em>) – The configuration specific to
-the product</td>
-</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product it has an environment script, else False</td>
-</tr>
-<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
-</tr>
-</tbody>
-</table>
+<dl class="method">
+<dt id="src.pyconf.Config.addNamespace">
+<code class="descclassname">Config.</code><code class="descname">addNamespace</code><span class="sig-paren">(</span><em>ns</em>, <em>name=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Config.addNamespace"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Config.addNamespace" title="Permalink to this definition">¶</a></dt>
+<dd><p>Add a namespace to this configuration which can be used to evaluate
+(resolve) dotted-identifier expressions.
+@param ns: The namespace to be added.
+@type ns: A module or other namespace suitable for passing as an
+argument to vars().
+@param name: A name for the namespace, which, if specified, provides
+an additional level of indirection.
+@type name: str</p>
</dd></dl>
-<dl class="function">
-<dt id="src.product.product_has_logo">
-<code class="descclassname">src.product.</code><code class="descname">product_has_logo</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#product_has_logo"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.product_has_logo" title="Permalink to this definition">¶</a></dt>
-<dd><p>Know if a product has a logo (YACSGEN generate)</p>
-<table class="docutils field-list" frame="void" rules="none">
-<col class="field-name" />
-<col class="field-body" />
-<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>product_info</em>) – The configuration specific to
-the product</td>
-</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The path of the logo if the product has a logo, else False</td>
-</tr>
-<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">Str</td>
-</tr>
-</tbody>
-</table>
+<dl class="method">
+<dt id="src.pyconf.Config.getByPath">
+<code class="descclassname">Config.</code><code class="descname">getByPath</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Config.getByPath"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Config.getByPath" title="Permalink to this definition">¶</a></dt>
+<dd><p>Obtain a value in the configuration via its path.
+@param path: The path of the required value
+@type path: str
+@return the value at the specified path.
+@rtype: any
+@raise ConfigError: If the path is invalid</p>
</dd></dl>
-<dl class="function">
-<dt id="src.product.product_has_patches">
-<code class="descclassname">src.product.</code><code class="descname">product_has_patches</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#product_has_patches"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.product_has_patches" title="Permalink to this definition">¶</a></dt>
-<dd><p>Know if a product has one or more patches</p>
-<table class="docutils field-list" frame="void" rules="none">
-<col class="field-name" />
-<col class="field-body" />
-<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>product_info</em>) – The configuration specific to
-the product</td>
-</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product has one or more patches</td>
-</tr>
-<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
-</tr>
-</tbody>
-</table>
+<dl class="method">
+<dt id="src.pyconf.Config.load">
+<code class="descclassname">Config.</code><code class="descname">load</code><span class="sig-paren">(</span><em>stream</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Config.load"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Config.load" title="Permalink to this definition">¶</a></dt>
+<dd><p>Load the configuration from the specified stream. Multiple streams can
+be used to populate the same instance, as long as there are no
+clashing keys. The stream is closed.
+@param stream: A stream from which the configuration is read.
+@type stream: A read-only stream (file-like object).
+@raise ConfigError: if keys in the loaded configuration clash with
+existing keys.
+@raise ConfigFormatError: if there is a syntax error in the stream.</p>
</dd></dl>
-<dl class="function">
-<dt id="src.product.product_has_salome_gui">
-<code class="descclassname">src.product.</code><code class="descname">product_has_salome_gui</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#product_has_salome_gui"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.product_has_salome_gui" title="Permalink to this definition">¶</a></dt>
-<dd><p>Know if a product has a SALOME gui</p>
-<table class="docutils field-list" frame="void" rules="none">
-<col class="field-name" />
-<col class="field-body" />
-<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>product_info</em>) – The configuration specific to
-the product</td>
-</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product has a SALOME gui, else False</td>
-</tr>
-<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">Boolean</td>
-</tr>
-</tbody>
-</table>
+<dl class="method">
+<dt id="src.pyconf.Config.removeNamespace">
+<code class="descclassname">Config.</code><code class="descname">removeNamespace</code><span class="sig-paren">(</span><em>ns</em>, <em>name=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Config.removeNamespace"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Config.removeNamespace" title="Permalink to this definition">¶</a></dt>
+<dd><p>Remove a namespace added with L{addNamespace}.
+@param ns: The namespace to be removed.
+@param name: The name which was specified when L{addNamespace} was
+called.
+@type name: str</p>
</dd></dl>
-<dl class="function">
-<dt id="src.product.product_has_script">
-<code class="descclassname">src.product.</code><code class="descname">product_has_script</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#product_has_script"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.product_has_script" title="Permalink to this definition">¶</a></dt>
-<dd><p>Know if a product has a compilation script</p>
-<table class="docutils field-list" frame="void" rules="none">
-<col class="field-name" />
-<col class="field-body" />
-<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>product_info</em>) – The configuration specific to
-the product</td>
-</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product it has a compilation script, else False</td>
-</tr>
-<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
-</tr>
-</tbody>
-</table>
</dd></dl>
-<dl class="function">
-<dt id="src.product.product_is_autotools">
-<code class="descclassname">src.product.</code><code class="descname">product_is_autotools</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#product_is_autotools"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.product_is_autotools" title="Permalink to this definition">¶</a></dt>
-<dd><p>Know if a product is compiled using the autotools</p>
-<table class="docutils field-list" frame="void" rules="none">
-<col class="field-name" />
-<col class="field-body" />
-<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>product_info</em>) – The configuration specific to
-the product</td>
-</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product is autotools, else False</td>
-</tr>
-<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
-</tr>
-</tbody>
-</table>
+<dl class="exception">
+<dt id="src.pyconf.ConfigError">
+<em class="property">exception </em><code class="descclassname">src.pyconf.</code><code class="descname">ConfigError</code><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigError" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">exceptions.Exception</span></code></p>
+<p>This is the base class of exceptions raised by this module.</p>
</dd></dl>
-<dl class="function">
-<dt id="src.product.product_is_cmake">
-<code class="descclassname">src.product.</code><code class="descname">product_is_cmake</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#product_is_cmake"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.product_is_cmake" title="Permalink to this definition">¶</a></dt>
-<dd><p>Know if a product is compiled using the cmake</p>
-<table class="docutils field-list" frame="void" rules="none">
-<col class="field-name" />
-<col class="field-body" />
-<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>product_info</em>) – The configuration specific to
-the product</td>
-</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product is cmake, else False</td>
-</tr>
-<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
-</tr>
-</tbody>
-</table>
+<dl class="exception">
+<dt id="src.pyconf.ConfigFormatError">
+<em class="property">exception </em><code class="descclassname">src.pyconf.</code><code class="descname">ConfigFormatError</code><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigFormatError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigFormatError" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="#src.pyconf.ConfigError" title="src.pyconf.ConfigError"><code class="xref py py-class docutils literal"><span class="pre">src.pyconf.ConfigError</span></code></a></p>
+<p>This is the base class of exceptions raised due to syntax errors in
+configurations.</p>
</dd></dl>
-<dl class="function">
-<dt id="src.product.product_is_cpp">
-<code class="descclassname">src.product.</code><code class="descname">product_is_cpp</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#product_is_cpp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.product_is_cpp" title="Permalink to this definition">¶</a></dt>
-<dd><p>Know if a product is cpp</p>
-<table class="docutils field-list" frame="void" rules="none">
-<col class="field-name" />
-<col class="field-body" />
-<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>product_info</em>) – The configuration specific to
-the product</td>
-</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product is a cpp, else False</td>
-</tr>
-<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
-</tr>
-</tbody>
-</table>
-</dd></dl>
+<dl class="class">
+<dt id="src.pyconf.ConfigInputStream">
+<em class="property">class </em><code class="descclassname">src.pyconf.</code><code class="descname">ConfigInputStream</code><span class="sig-paren">(</span><em>stream</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigInputStream"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigInputStream" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
+<p>An input stream which can read either ANSI files with default encoding
+or Unicode files with BOMs.</p>
+<p>Handles UTF-8, UTF-16LE, UTF-16BE. Could handle UTF-32 if Python had
+built-in support.</p>
+<dl class="method">
+<dt id="src.pyconf.ConfigInputStream.close">
+<code class="descname">close</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigInputStream.close"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigInputStream.close" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.ConfigInputStream.read">
+<code class="descname">read</code><span class="sig-paren">(</span><em>size</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigInputStream.read"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigInputStream.read" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.ConfigInputStream.readline">
+<code class="descname">readline</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigInputStream.readline"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigInputStream.readline" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
-<dl class="function">
-<dt id="src.product.product_is_debug">
-<code class="descclassname">src.product.</code><code class="descname">product_is_debug</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#product_is_debug"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.product_is_debug" title="Permalink to this definition">¶</a></dt>
-<dd><p>Know if a product is in debug mode</p>
-<table class="docutils field-list" frame="void" rules="none">
-<col class="field-name" />
-<col class="field-body" />
-<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>product_info</em>) – The configuration specific to
-the product</td>
-</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product is in debug mode, else False</td>
-</tr>
-<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
-</tr>
-</tbody>
-</table>
</dd></dl>
-<dl class="function">
-<dt id="src.product.product_is_dev">
-<code class="descclassname">src.product.</code><code class="descname">product_is_dev</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#product_is_dev"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.product_is_dev" title="Permalink to this definition">¶</a></dt>
-<dd><p>Know if a product is in dev mode</p>
-<table class="docutils field-list" frame="void" rules="none">
-<col class="field-name" />
-<col class="field-body" />
-<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>product_info</em>) – The configuration specific to
-the product</td>
-</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product is in dev mode, else False</td>
-</tr>
-<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
-</tr>
-</tbody>
-</table>
+<dl class="class">
+<dt id="src.pyconf.ConfigList">
+<em class="property">class </em><code class="descclassname">src.pyconf.</code><code class="descname">ConfigList</code><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigList"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigList" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">list</span></code></p>
+<p>This class implements an ordered list of configurations and allows you
+to try getting the configuration from each entry in turn, returning
+the first successfully obtained value.</p>
+<dl class="method">
+<dt id="src.pyconf.ConfigList.getByPath">
+<code class="descname">getByPath</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigList.getByPath"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigList.getByPath" title="Permalink to this definition">¶</a></dt>
+<dd><p>Obtain a value from the first configuration in the list which defines
+it.</p>
+<p>@param path: The path of the value to retrieve.
+@type path: str
+@return: The value from the earliest configuration in the list which
+defines it.
+@rtype: any
+@raise ConfigError: If no configuration in the list has an entry with
+the specified path.</p>
</dd></dl>
-<dl class="function">
-<dt id="src.product.product_is_fixed">
-<code class="descclassname">src.product.</code><code class="descname">product_is_fixed</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#product_is_fixed"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.product_is_fixed" title="Permalink to this definition">¶</a></dt>
-<dd><p>Know if a product is fixed</p>
-<table class="docutils field-list" frame="void" rules="none">
-<col class="field-name" />
-<col class="field-body" />
-<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>product_info</em>) – The configuration specific to
-the product</td>
-</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product is fixed, else False</td>
-</tr>
-<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
-</tr>
-</tbody>
-</table>
</dd></dl>
-<dl class="function">
-<dt id="src.product.product_is_generated">
-<code class="descclassname">src.product.</code><code class="descname">product_is_generated</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#product_is_generated"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.product_is_generated" title="Permalink to this definition">¶</a></dt>
-<dd><p>Know if a product is generated (YACSGEN)</p>
-<table class="docutils field-list" frame="void" rules="none">
-<col class="field-name" />
-<col class="field-body" />
-<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>product_info</em>) – The configuration specific to
-the product</td>
-</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product is generated</td>
-</tr>
-<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
-</tr>
-</tbody>
-</table>
+<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></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"><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
+merge operand to the merge target. If a key exists in both configurations,
+then a resolver (a callable) is called to decide how to handle the
+conflict.</p>
+<dl class="method">
+<dt id="src.pyconf.ConfigMerger.handleMismatch">
+<code class="descname">handleMismatch</code><span class="sig-paren">(</span><em>obj1</em>, <em>obj2</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigMerger.handleMismatch"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigMerger.handleMismatch" title="Permalink to this definition">¶</a></dt>
+<dd><p>Handle a mismatch between two objects.</p>
+<p>@param obj1: The object to merge into.
+@type obj1: any
+@param obj2: The object to merge.
+@type obj2: any</p>
</dd></dl>
-<dl class="function">
-<dt id="src.product.product_is_mpi">
-<code class="descclassname">src.product.</code><code class="descname">product_is_mpi</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#product_is_mpi"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.product_is_mpi" title="Permalink to this definition">¶</a></dt>
-<dd><p>Know if a product has openmpi in its dependencies</p>
-<table class="docutils field-list" frame="void" rules="none">
-<col class="field-name" />
-<col class="field-body" />
-<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>product_info</em>) – The configuration specific to
-the product</td>
-</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product has openmpi inits dependencies</td>
-</tr>
-<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
-</tr>
-</tbody>
-</table>
+<dl class="method">
+<dt id="src.pyconf.ConfigMerger.merge">
+<code class="descname">merge</code><span class="sig-paren">(</span><em>merged</em>, <em>mergee</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigMerger.merge"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigMerger.merge" title="Permalink to this definition">¶</a></dt>
+<dd><p>Merge two configurations. The second configuration is unchanged,
+and the first is changed to reflect the results of the merge.</p>
+<p>@param merged: The configuration to merge into.
+@type merged: L{Config}.
+@param mergee: The configuration to merge.
+@type mergee: L{Config}.</p>
</dd></dl>
-<dl class="function">
-<dt id="src.product.product_is_native">
-<code class="descclassname">src.product.</code><code class="descname">product_is_native</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#product_is_native"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.product_is_native" title="Permalink to this definition">¶</a></dt>
-<dd><p>Know if a product is native</p>
-<table class="docutils field-list" frame="void" rules="none">
-<col class="field-name" />
-<col class="field-body" />
-<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>product_info</em>) – The configuration specific to
-the product</td>
-</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product is native, else False</td>
-</tr>
-<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
-</tr>
-</tbody>
-</table>
+<dl class="method">
+<dt id="src.pyconf.ConfigMerger.mergeMapping">
+<code class="descname">mergeMapping</code><span class="sig-paren">(</span><em>map1</em>, <em>map2</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigMerger.mergeMapping"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigMerger.mergeMapping" title="Permalink to this definition">¶</a></dt>
+<dd><p>Merge two mappings recursively. The second mapping is unchanged,
+and the first is changed to reflect the results of the merge.</p>
+<p>@param map1: The mapping to merge into.
+@type map1: L{Mapping}.
+@param map2: The mapping to merge.
+@type map2: L{Mapping}.</p>
</dd></dl>
-<dl class="function">
-<dt id="src.product.product_is_salome">
-<code class="descclassname">src.product.</code><code class="descname">product_is_salome</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#product_is_salome"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.product_is_salome" title="Permalink to this definition">¶</a></dt>
-<dd><p>Know if a product is a SALOME module</p>
-<table class="docutils field-list" frame="void" rules="none">
-<col class="field-name" />
-<col class="field-body" />
-<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>product_info</em>) – The configuration specific to
-the product</td>
-</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product is a SALOME module, else False</td>
-</tr>
-<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
-</tr>
-</tbody>
-</table>
+<dl class="method">
+<dt id="src.pyconf.ConfigMerger.mergeSequence">
+<code class="descname">mergeSequence</code><span class="sig-paren">(</span><em>seq1</em>, <em>seq2</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigMerger.mergeSequence"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigMerger.mergeSequence" title="Permalink to this definition">¶</a></dt>
+<dd><p>Merge two sequences. The second sequence is unchanged,
+and the first is changed to have the elements of the second
+appended to it.</p>
+<p>@param seq1: The sequence to merge into.
+@type seq1: L{Sequence}.
+@param seq2: The sequence to merge.
+@type seq2: L{Sequence}.</p>
</dd></dl>
-<dl class="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>
-<table class="docutils field-list" frame="void" rules="none">
-<col class="field-name" />
-<col class="field-body" />
-<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>product_info</em>) – The configuration specific to
-the product</td>
-</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product has the sample type, else False</td>
-</tr>
-<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
-</tr>
-</tbody>
-</table>
+<dl class="method">
+<dt id="src.pyconf.ConfigMerger.overwriteKeys">
+<code class="descname">overwriteKeys</code><span class="sig-paren">(</span><em>map1</em>, <em>seq2</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigMerger.overwriteKeys"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigMerger.overwriteKeys" title="Permalink to this definition">¶</a></dt>
+<dd><p>Renint variables. The second mapping is unchanged,
+and the first is changed depending the keys of the second mapping.
+@param map1: The mapping to reinit keys into.
+@type map1: L{Mapping}.
+@param map2: The mapping container reinit information.
+@type map2: L{Mapping}.</p>
</dd></dl>
-<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>
-<table class="docutils field-list" frame="void" rules="none">
-<col class="field-name" />
-<col class="field-body" />
-<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>product_info</em>) – The configuration specific to
-the product</td>
-</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product is a SMESH plugin, else False</td>
-</tr>
-<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
-</tr>
-</tbody>
-</table>
</dd></dl>
-<dl class="function">
-<dt id="src.product.product_is_vcs">
-<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" />
-<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>product_info</em>) – The configuration specific to
-the product</td>
-</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product is vcs, else False</td>
-</tr>
-<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
-</tr>
-</tbody>
-</table>
+<dl class="class">
+<dt id="src.pyconf.ConfigOutputStream">
+<em class="property">class </em><code class="descclassname">src.pyconf.</code><code class="descname">ConfigOutputStream</code><span class="sig-paren">(</span><em>stream</em>, <em>encoding=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigOutputStream"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigOutputStream" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
+<p>An output stream which can write either ANSI files with default encoding
+or Unicode files with BOMs.</p>
+<p>Handles UTF-8, UTF-16LE, UTF-16BE. Could handle UTF-32 if Python had
+built-in support.</p>
+<dl class="method">
+<dt id="src.pyconf.ConfigOutputStream.close">
+<code class="descname">close</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigOutputStream.close"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigOutputStream.close" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.ConfigOutputStream.flush">
+<code class="descname">flush</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigOutputStream.flush"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigOutputStream.flush" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.ConfigOutputStream.write">
+<code class="descname">write</code><span class="sig-paren">(</span><em>data</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigOutputStream.write"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigOutputStream.write" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
</dd></dl>
-</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>
-<p>This is a configuration module for Python.</p>
-<p>This module should work under Python versions >= 2.2, and cannot be used with
-earlier versions since it uses new-style classes.</p>
-<p>Development and testing has only been carried out (so far) on Python 2.3.4 and
-Python 2.4.2. See the test module (test_config.py) included in the
-U{distribution<<a class="reference external" href="http://www.red-dove.com/python_config">http://www.red-dove.com/python_config</a>.html|_blank>} (follow the
-download link).</p>
-<p>A simple example - with the example configuration file:</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>messages:
-[
- {
- stream : `sys.stderr`
- message: 'Welcome'
- name: 'Harry'
- }
- {
- stream : `sys.stdout`
- message: 'Welkom'
- name: 'Ruud'
- }
- {
- stream : $messages[0].stream
- message: 'Bienvenue'
- name: Yves
- }
-]
-</pre></div>
-</div>
-<p>a program to read the configuration would be:</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">config</span> <span class="k">import</span> <span class="n">Config</span>
+<dl class="class">
+<dt id="src.pyconf.ConfigReader">
+<em class="property">class </em><code class="descclassname">src.pyconf.</code><code class="descname">ConfigReader</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigReader"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigReader" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
+<p>This internal class implements a parser for configurations.</p>
+<dl class="method">
+<dt id="src.pyconf.ConfigReader.getChar">
+<code class="descname">getChar</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigReader.getChar"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigReader.getChar" title="Permalink to this definition">¶</a></dt>
+<dd><p>Get the next char from the stream. Update line and column numbers
+appropriately.</p>
+<p>@return: The next character from the stream.
+@rtype: str</p>
+</dd></dl>
-<span class="n">f</span> <span class="o">=</span> <span class="n">file</span><span class="p">(</span><span class="s1">'simple.cfg'</span><span class="p">)</span>
-<span class="n">cfg</span> <span class="o">=</span> <span class="n">Config</span><span class="p">(</span><span class="n">f</span><span class="p">)</span>
-<span class="k">for</span> <span class="n">m</span> <span class="ow">in</span> <span class="n">cfg</span><span class="o">.</span><span class="n">messages</span><span class="p">:</span>
- <span class="n">s</span> <span class="o">=</span> <span class="s1">'</span><span class="si">%s</span><span class="s1">, </span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">message</span><span class="p">,</span> <span class="n">m</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
- <span class="k">try</span><span class="p">:</span>
- <span class="nb">print</span> <span class="o">>></span> <span class="n">m</span><span class="o">.</span><span class="n">stream</span><span class="p">,</span> <span class="n">s</span>
- <span class="k">except</span> <span class="ne">IOError</span><span class="p">,</span> <span class="n">e</span><span class="p">:</span>
- <span class="nb">print</span> <span class="n">e</span>
-</pre></div>
-</div>
-<p>which, when run, would yield the console output:</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Welcome</span><span class="p">,</span> <span class="n">Harry</span>
-<span class="n">Welkom</span><span class="p">,</span> <span class="n">Ruud</span>
-<span class="n">Bienvenue</span><span class="p">,</span> <span class="n">Yves</span>
+<dl class="method">
+<dt id="src.pyconf.ConfigReader.getToken">
+<code class="descname">getToken</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigReader.getToken"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigReader.getToken" title="Permalink to this definition">¶</a></dt>
+<dd><p>Get a token from the stream. String values are returned in a form
+where you need to eval() the returned value to get the actual
+string. The return value is (token_type, token_value).</p>
+<p>Multiline string tokenizing is thanks to David Janes (BlogMatrix)</p>
+<p>@return: The next token.
+@rtype: A token tuple.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.ConfigReader.load">
+<code class="descname">load</code><span class="sig-paren">(</span><em>stream</em>, <em>parent=None</em>, <em>suffix=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigReader.load"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigReader.load" title="Permalink to this definition">¶</a></dt>
+<dd><p>Load the configuration from the specified stream.</p>
+<p>@param stream: A stream from which to load the configuration.
+@type stream: A stream (file-like object).
+@param parent: The parent of the configuration (to which this reader
+belongs) in the hierarchy. Specified when the configuration is
+included in another one.
+@type parent: A L{Container} instance.
+@param suffix: The suffix of this configuration in the parent
+configuration. Should be specified whenever the parent is not None.
+@raise ConfigError: If parent is specified but suffix is not.
+@raise ConfigFormatError: If there are syntax errors in the stream.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.ConfigReader.location">
+<code class="descname">location</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigReader.location"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigReader.location" title="Permalink to this definition">¶</a></dt>
+<dd><p>Return the current location (filename, line, column) in the stream
+as a string.</p>
+<p>Used when printing error messages,</p>
+<p>@return: A string representing a location in the stream being read.
+@rtype: str</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.ConfigReader.match">
+<code class="descname">match</code><span class="sig-paren">(</span><em>t</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigReader.match"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigReader.match" title="Permalink to this definition">¶</a></dt>
+<dd><p>Ensure that the current token type matches the specified value, and
+advance to the next token.</p>
+<p>@param t: The token type to match.
+@type t: A valid token type.
+@return: The token which was last read from the stream before this
+function is called.
+@rtype: a token tuple - see L{getToken}.
+@raise ConfigFormatError: If the token does not match what's expected.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.ConfigReader.parseFactor">
+<code class="descname">parseFactor</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigReader.parseFactor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigReader.parseFactor" title="Permalink to this definition">¶</a></dt>
+<dd><p>Parse a factor in an multiplicative expression (a * b, a / b, a % b)</p>
+<p>@return: the parsed factor
+@rtype: any scalar
+@raise ConfigFormatError: if a syntax error is found.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.ConfigReader.parseKeyValuePair">
+<code class="descname">parseKeyValuePair</code><span class="sig-paren">(</span><em>parent</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigReader.parseKeyValuePair"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigReader.parseKeyValuePair" title="Permalink to this definition">¶</a></dt>
+<dd><p>Parse a key-value pair, and add it to the provided L{Mapping}.</p>
+<p>@param parent: The mapping to add entries to.
+@type parent: A L{Mapping} instance.
+@raise ConfigFormatError: if a syntax error is found.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.ConfigReader.parseMapping">
+<code class="descname">parseMapping</code><span class="sig-paren">(</span><em>parent</em>, <em>suffix</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigReader.parseMapping"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigReader.parseMapping" title="Permalink to this definition">¶</a></dt>
+<dd><p>Parse a mapping.</p>
+<p>@param parent: The container to which the mapping will be added.
+@type parent: A L{Container} instance.
+@param suffix: The suffix for the value.
+@type suffix: str
+@return: a L{Mapping} instance representing the mapping.
+@rtype: L{Mapping}
+@raise ConfigFormatError: if a syntax error is found.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.ConfigReader.parseMappingBody">
+<code class="descname">parseMappingBody</code><span class="sig-paren">(</span><em>parent</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigReader.parseMappingBody"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigReader.parseMappingBody" title="Permalink to this definition">¶</a></dt>
+<dd><p>Parse the internals of a mapping, and add entries to the provided
+L{Mapping}.</p>
+<p>@param parent: The mapping to add entries to.
+@type parent: A L{Mapping} instance.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.ConfigReader.parseReference">
+<code class="descname">parseReference</code><span class="sig-paren">(</span><em>type</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigReader.parseReference"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigReader.parseReference" title="Permalink to this definition">¶</a></dt>
+<dd><p>Parse a reference.</p>
+<p>@return: the parsed reference
+@rtype: L{Reference}
+@raise ConfigFormatError: if a syntax error is found.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.ConfigReader.parseScalar">
+<code class="descname">parseScalar</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigReader.parseScalar"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigReader.parseScalar" title="Permalink to this definition">¶</a></dt>
+<dd><p>Parse a scalar - a terminal value such as a string or number, or
+an L{Expression} or L{Reference}.</p>
+<p>@return: the parsed scalar
+@rtype: any scalar
+@raise ConfigFormatError: if a syntax error is found.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.ConfigReader.parseSequence">
+<code class="descname">parseSequence</code><span class="sig-paren">(</span><em>parent</em>, <em>suffix</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigReader.parseSequence"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigReader.parseSequence" title="Permalink to this definition">¶</a></dt>
+<dd><p>Parse a sequence.</p>
+<p>@param parent: The container to which the sequence will be added.
+@type parent: A L{Container} instance.
+@param suffix: The suffix for the value.
+@type suffix: str
+@return: a L{Sequence} instance representing the sequence.
+@rtype: L{Sequence}
+@raise ConfigFormatError: if a syntax error is found.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.ConfigReader.parseSuffix">
+<code class="descname">parseSuffix</code><span class="sig-paren">(</span><em>ref</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigReader.parseSuffix"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigReader.parseSuffix" title="Permalink to this definition">¶</a></dt>
+<dd><p>Parse a reference suffix.</p>
+<p>@param ref: The reference of which this suffix is a part.
+@type ref: L{Reference}.
+@raise ConfigFormatError: if a syntax error is found.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.ConfigReader.parseTerm">
+<code class="descname">parseTerm</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigReader.parseTerm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigReader.parseTerm" title="Permalink to this definition">¶</a></dt>
+<dd><p>Parse a term in an additive expression (a + b, a - b)</p>
+<p>@return: the parsed term
+@rtype: any scalar
+@raise ConfigFormatError: if a syntax error is found.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.ConfigReader.parseValue">
+<code class="descname">parseValue</code><span class="sig-paren">(</span><em>parent</em>, <em>suffix</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigReader.parseValue"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigReader.parseValue" title="Permalink to this definition">¶</a></dt>
+<dd><p>Parse a value.</p>
+<p>@param parent: The container to which the value will be added.
+@type parent: A L{Container} instance.
+@param suffix: The suffix for the value.
+@type suffix: str
+@return: The value
+@rtype: any
+@raise ConfigFormatError: if a syntax error is found.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.ConfigReader.setStream">
+<code class="descname">setStream</code><span class="sig-paren">(</span><em>stream</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigReader.setStream"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigReader.setStream" title="Permalink to this definition">¶</a></dt>
+<dd><p>Set the stream to the specified value, and prepare to read from it.</p>
+<p>@param stream: A stream from which to load the configuration.
+@type stream: A stream (file-like object).</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="exception">
+<dt id="src.pyconf.ConfigResolutionError">
+<em class="property">exception </em><code class="descclassname">src.pyconf.</code><code class="descname">ConfigResolutionError</code><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigResolutionError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigResolutionError" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="#src.pyconf.ConfigError" title="src.pyconf.ConfigError"><code class="xref py py-class docutils literal"><span class="pre">src.pyconf.ConfigError</span></code></a></p>
+<p>This is the base class of exceptions raised due to semantic errors in
+configurations.</p>
+</dd></dl>
+
+<dl class="class">
+<dt id="src.pyconf.Container">
+<em class="property">class </em><code class="descclassname">src.pyconf.</code><code class="descname">Container</code><span class="sig-paren">(</span><em>parent</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Container"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Container" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
+<p>This internal class is the base class for mappings and sequences.</p>
+<p>@ivar path: A string which describes how to get
+to this instance from the root of the hierarchy.</p>
+<p>Example:</p>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">a</span><span class="o">.</span><span class="n">list</span><span class="o">.</span><span class="n">of</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="ow">or</span><span class="p">[</span><span class="s1">'more'</span><span class="p">]</span><span class="o">.</span><span class="n">elements</span>
</pre></div>
</div>
-<p>See U{this tutorial<<a class="reference external" href="http://www.red-dove.com/python_config">http://www.red-dove.com/python_config</a>.html|_blank>} for more
-information.</p>
-<p>#modified for salomeTools
-@version: 0.3.7.1</p>
-<p>@author: Vinay Sajip</p>
-<p>@copyright: Copyright (C) 2004-2007 Vinay Sajip. All Rights Reserved.</p>
-<p>@var streamOpener: The default stream opener. This is a factory function which
-takes a string (e.g. filename) and returns a stream suitable for reading. If
-unable to open the stream, an IOError exception should be thrown.</p>
-<p>The default value of this variable is L{defaultStreamOpener}. For an example
-of how it’s used, see test_config.py (search for streamOpener).</p>
+<dl class="method">
+<dt id="src.pyconf.Container.evaluate">
+<code class="descname">evaluate</code><span class="sig-paren">(</span><em>item</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Container.evaluate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Container.evaluate" title="Permalink to this definition">¶</a></dt>
+<dd><p>Evaluate items which are instances of L{Reference} or L{Expression}.</p>
+<p>L{Reference} instances are evaluated using L{Reference.resolve},
+and L{Expression} instances are evaluated using
+L{Expression.evaluate}.</p>
+<p>@param item: The item to be evaluated.
+@type item: any
+@return: If the item is an instance of L{Reference} or L{Expression},
+the evaluated value is returned, otherwise the item is returned
+unchanged.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.Container.setPath">
+<code class="descname">setPath</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Container.setPath"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Container.setPath" title="Permalink to this definition">¶</a></dt>
+<dd><p>Set the path for this instance.
+@param path: The path - a string which describes how to get
+to this instance from the root of the hierarchy.
+@type path: str</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.Container.writeToStream">
+<code class="descname">writeToStream</code><span class="sig-paren">(</span><em>stream</em>, <em>indent</em>, <em>container</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Container.writeToStream"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Container.writeToStream" title="Permalink to this definition">¶</a></dt>
+<dd><p>Write this instance to a stream at the specified indentation level.</p>
+<p>Should be redefined in subclasses.</p>
+<p>@param stream: The stream to write to
+@type stream: A writable stream (file-like object)
+@param indent: The indentation level
+@type indent: int
+@param container: The container of this instance
+@type container: L{Container}
+@raise NotImplementedError: If a subclass does not override this</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.Container.writeValue">
+<code class="descname">writeValue</code><span class="sig-paren">(</span><em>value</em>, <em>stream</em>, <em>indent</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Container.writeValue"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Container.writeValue" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
<dl class="class">
-<dt id="src.pyconf.Config">
-<em class="property">class </em><code class="descclassname">src.pyconf.</code><code class="descname">Config</code><span class="sig-paren">(</span><em>streamOrFile=None</em>, <em>parent=None</em>, <em>PWD=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Config"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Config" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <a class="reference internal" href="#src.pyconf.Mapping" title="src.pyconf.Mapping"><code class="xref py py-class docutils literal notranslate"><span class="pre">src.pyconf.Mapping</span></code></a></p>
-<p>This class represents a configuration, and is the only one which clients
-need to interface to, under normal circumstances.</p>
+<dt id="src.pyconf.Expression">
+<em class="property">class </em><code class="descclassname">src.pyconf.</code><code class="descname">Expression</code><span class="sig-paren">(</span><em>op</em>, <em>lhs</em>, <em>rhs</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Expression"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Expression" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
+<p>This internal class implements a value which is obtained by evaluating an expression.</p>
+<dl class="method">
+<dt id="src.pyconf.Expression.evaluate">
+<code class="descname">evaluate</code><span class="sig-paren">(</span><em>container</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Expression.evaluate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Expression.evaluate" title="Permalink to this definition">¶</a></dt>
+<dd><p>Evaluate this instance in the context of a container.</p>
+<p>@param container: The container to evaluate in from.
+@type container: L{Container}
+@return: The evaluated value.
+@rtype: any
+@raise ConfigResolutionError: If evaluation fails.
+@raise ZeroDivideError: If division by zero occurs.
+@raise TypeError: If the operation is invalid, e.g.
+subtracting one string from another.</p>
+</dd></dl>
+
+</dd></dl>
+
<dl class="class">
-<dt id="src.pyconf.Config.Namespace">
-<em class="property">class </em><code class="descname">Namespace</code><a class="reference internal" href="../../_modules/src/pyconf.html#Config.Namespace"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Config.Namespace" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
-<p>This internal class is used for implementing default namespaces.</p>
-<p>An instance acts as a namespace.</p>
+<dt id="src.pyconf.Mapping">
+<em class="property">class </em><code class="descclassname">src.pyconf.</code><code class="descname">Mapping</code><span class="sig-paren">(</span><em>parent=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Mapping"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Mapping" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="#src.pyconf.Container" title="src.pyconf.Container"><code class="xref py py-class docutils literal"><span class="pre">src.pyconf.Container</span></code></a></p>
+<p>This internal class implements key-value mappings in configurations.</p>
+<dl class="method">
+<dt id="src.pyconf.Mapping.addMapping">
+<code class="descname">addMapping</code><span class="sig-paren">(</span><em>key</em>, <em>value</em>, <em>comment</em>, <em>setting=False</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Mapping.addMapping"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Mapping.addMapping" title="Permalink to this definition">¶</a></dt>
+<dd><p>Add a key-value mapping with a comment.</p>
+<p>@param key: The key for the mapping.
+@type key: str
+@param value: The value for the mapping.
+@type value: any
+@param comment: The comment for the key (can be None).
+@type comment: str
+@param setting: If True, ignore clashes. This is set
+to true when called from L{__setattr__}.
+@raise ConfigFormatError: If an existing key is seen
+again and setting is False.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.Mapping.get">
+<code class="descname">get</code><span class="sig-paren">(</span><em>key</em>, <em>default=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Mapping.get"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Mapping.get" title="Permalink to this definition">¶</a></dt>
+<dd><p>Allows a dictionary-style get operation.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.Mapping.iteritems">
+<code class="descname">iteritems</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Mapping.iteritems"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Mapping.iteritems" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.Mapping.iterkeys">
+<code class="descname">iterkeys</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Mapping.iterkeys"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Mapping.iterkeys" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.Mapping.keys">
+<code class="descname">keys</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Mapping.keys"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Mapping.keys" title="Permalink to this definition">¶</a></dt>
+<dd><p>Return the keys in a similar way to a dictionary.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="src.pyconf.Mapping.writeToStream">
+<code class="descname">writeToStream</code><span class="sig-paren">(</span><em>stream</em>, <em>indent</em>, <em>container</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Mapping.writeToStream"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Mapping.writeToStream" title="Permalink to this definition">¶</a></dt>
+<dd><p>Write this instance to a stream at the specified indentation level.</p>
+<p>Should be redefined in subclasses.</p>
+<p>@param stream: The stream to write to
+@type stream: A writable stream (file-like object)
+@param indent: The indentation level
+@type indent: int
+@param container: The container of this instance
+@type container: L{Container}</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="src.pyconf.Reference">
+<em class="property">class </em><code class="descclassname">src.pyconf.</code><code class="descname">Reference</code><span class="sig-paren">(</span><em>config</em>, <em>type</em>, <em>ident</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Reference"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Reference" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
+<p>This internal class implements a value which is a reference to another value.</p>
+<dl class="method">
+<dt id="src.pyconf.Reference.addElement">
+<code class="descname">addElement</code><span class="sig-paren">(</span><em>type</em>, <em>ident</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Reference.addElement"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Reference.addElement" title="Permalink to this definition">¶</a></dt>
+<dd><p>Add an element to the reference.</p>
+<p>@param type: The type of reference.
+@type type: BACKTICK or DOLLAR
+@param ident: The identifier which continues the reference.
+@type ident: str</p>
</dd></dl>
<dl class="method">
-<dt id="src.pyconf.Config.addNamespace">
-<code class="descname">addNamespace</code><span class="sig-paren">(</span><em>ns</em>, <em>name=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Config.addNamespace"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Config.addNamespace" title="Permalink to this definition">¶</a></dt>
-<dd><p>Add a namespace to this configuration which can be used to evaluate
-(resolve) dotted-identifier expressions.
-@param ns: The namespace to be added.
-@type ns: A module or other namespace suitable for passing as an
-argument to vars().
-@param name: A name for the namespace, which, if specified, provides
-an additional level of indirection.
-@type name: str</p>
+<dt id="src.pyconf.Reference.findConfig">
+<code class="descname">findConfig</code><span class="sig-paren">(</span><em>container</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Reference.findConfig"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Reference.findConfig" title="Permalink to this definition">¶</a></dt>
+<dd><p>Find the closest enclosing configuration to the specified container.</p>
+<p>@param container: The container to start from.
+@type container: L{Container}
+@return: The closest enclosing configuration, or None.
+@rtype: L{Config}</p>
</dd></dl>
<dl class="method">
-<dt id="src.pyconf.Config.getByPath">
-<code class="descname">getByPath</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Config.getByPath"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Config.getByPath" title="Permalink to this definition">¶</a></dt>
-<dd><p>Obtain a value in the configuration via its path.
-@param path: The path of the required value
-@type path: str
-@return the value at the specified path.
+<dt id="src.pyconf.Reference.resolve">
+<code class="descname">resolve</code><span class="sig-paren">(</span><em>container</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Reference.resolve"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Reference.resolve" title="Permalink to this definition">¶</a></dt>
+<dd><p>Resolve this instance in the context of a container.</p>
+<p>@param container: The container to resolve from.
+@type container: L{Container}
+@return: The resolved value.
@rtype: any
-@raise ConfigError: If the path is invalid</p>
+@raise ConfigResolutionError: If resolution fails.</p>
+</dd></dl>
+
</dd></dl>
+<dl class="class">
+<dt id="src.pyconf.Sequence">
+<em class="property">class </em><code class="descclassname">src.pyconf.</code><code class="descname">Sequence</code><span class="sig-paren">(</span><em>parent=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Sequence"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Sequence" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="#src.pyconf.Container" title="src.pyconf.Container"><code class="xref py py-class docutils literal"><span class="pre">src.pyconf.Container</span></code></a></p>
+<p>This internal class implements a value which is a sequence of other values.</p>
+<dl class="class">
+<dt id="src.pyconf.Sequence.SeqIter">
+<em class="property">class </em><code class="descname">SeqIter</code><span class="sig-paren">(</span><em>seq</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Sequence.SeqIter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Sequence.SeqIter" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
+<p>This internal class implements an iterator for a L{Sequence} instance.</p>
<dl class="method">
-<dt id="src.pyconf.Config.load">
-<code class="descname">load</code><span class="sig-paren">(</span><em>stream</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Config.load"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Config.load" title="Permalink to this definition">¶</a></dt>
-<dd><p>Load the configuration from the specified stream. Multiple streams can
-be used to populate the same instance, as long as there are no
-clashing keys. The stream is closed.
-@param stream: A stream from which the configuration is read.
-@type stream: A read-only stream (file-like object).
-@raise ConfigError: if keys in the loaded configuration clash with
-existing keys.
-@raise ConfigFormatError: if there is a syntax error in the stream.</p>
+<dt id="src.pyconf.Sequence.SeqIter.next">
+<code class="descname">next</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Sequence.SeqIter.next"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Sequence.SeqIter.next" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
</dd></dl>
<dl class="method">
-<dt id="src.pyconf.Config.removeNamespace">
-<code class="descname">removeNamespace</code><span class="sig-paren">(</span><em>ns</em>, <em>name=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Config.removeNamespace"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Config.removeNamespace" title="Permalink to this definition">¶</a></dt>
-<dd><p>Remove a namespace added with L{addNamespace}.
-@param ns: The namespace to be removed.
-@param name: The name which was specified when L{addNamespace} was
-called.
-@type name: str</p>
+<dt id="src.pyconf.Sequence.append">
+<code class="descclassname">Sequence.</code><code class="descname">append</code><span class="sig-paren">(</span><em>item</em>, <em>comment</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Sequence.append"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Sequence.append" title="Permalink to this definition">¶</a></dt>
+<dd><p>Add an item to the sequence.</p>
+<p>@param item: The item to add.
+@type item: any
+@param comment: A comment for the item.
+@type comment: str</p>
</dd></dl>
+<dl class="method">
+<dt id="src.pyconf.Sequence.writeToStream">
+<code class="descclassname">Sequence.</code><code class="descname">writeToStream</code><span class="sig-paren">(</span><em>stream</em>, <em>indent</em>, <em>container</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Sequence.writeToStream"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Sequence.writeToStream" title="Permalink to this definition">¶</a></dt>
+<dd><p>Write this instance to a stream at the specified indentation level.</p>
+<p>Should be redefined in subclasses.</p>
+<p>@param stream: The stream to write to
+@type stream: A writable stream (file-like object)
+@param indent: The indentation level
+@type indent: int
+@param container: The container of this instance
+@type container: L{Container}</p>
</dd></dl>
-<dl class="exception">
-<dt id="src.pyconf.ConfigError">
-<em class="property">exception </em><code class="descclassname">src.pyconf.</code><code class="descname">ConfigError</code><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigError" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">exceptions.Exception</span></code></p>
-<p>This is the base class of exceptions raised by this module.</p>
</dd></dl>
-<dl class="exception">
-<dt id="src.pyconf.ConfigFormatError">
-<em class="property">exception </em><code class="descclassname">src.pyconf.</code><code class="descname">ConfigFormatError</code><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigFormatError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigFormatError" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <a class="reference internal" href="#src.pyconf.ConfigError" title="src.pyconf.ConfigError"><code class="xref py py-class docutils literal notranslate"><span class="pre">src.pyconf.ConfigError</span></code></a></p>
-<p>This is the base class of exceptions raised due to syntax errors in
-configurations.</p>
+<dl class="function">
+<dt id="src.pyconf.deepCopyMapping">
+<code class="descclassname">src.pyconf.</code><code class="descname">deepCopyMapping</code><span class="sig-paren">(</span><em>inMapping</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#deepCopyMapping"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.deepCopyMapping" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="function">
+<dt id="src.pyconf.defaultMergeResolve">
+<code class="descclassname">src.pyconf.</code><code class="descname">defaultMergeResolve</code><span class="sig-paren">(</span><em>map1</em>, <em>map2</em>, <em>key</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#defaultMergeResolve"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.defaultMergeResolve" title="Permalink to this definition">¶</a></dt>
+<dd><p>A default resolver for merge conflicts.
+Returns a string indicating what action to take to resolve the conflict.</p>
+<p>@param map1: The map being merged into.
+@type map1: L{Mapping}.
+@param map2: The map being used as the merge operand.
+@type map2: L{Mapping}.
+@param key: The key in map2 (which also exists in map1).
+@type key: str
+@return: One of "merge", "append", "mismatch" or "overwrite"
+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}.
+@rtype: str</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.pyconf.defaultStreamOpener">
+<code class="descclassname">src.pyconf.</code><code class="descname">defaultStreamOpener</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#defaultStreamOpener"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.defaultStreamOpener" title="Permalink to this definition">¶</a></dt>
+<dd><p>This function returns a read-only stream, given its name. The name passed
+in should correspond to an existing stream, otherwise an exception will be
+raised.</p>
+<p>This is the default value of L{streamOpener}; assign your own callable to
+streamOpener to return streams based on names. For example, you could use
+urllib2.urlopen().</p>
+<p>@param name: The name of a stream, most commonly a file name.
+@type name: str
+@return: A stream with the specified name.
+@rtype: A read-only stream (file-like object)</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.pyconf.isWord">
+<code class="descclassname">src.pyconf.</code><code class="descname">isWord</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#isWord"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.isWord" title="Permalink to this definition">¶</a></dt>
+<dd><p>See if a passed-in value is an identifier. If the value passed in is not a
+string, False is returned. An identifier consists of alphanumerics or
+underscore characters.</p>
+<p>Examples:</p>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">isWord</span><span class="p">(</span><span class="s1">'a word'</span><span class="p">)</span> <span class="o">-></span><span class="kc">False</span>
+<span class="n">isWord</span><span class="p">(</span><span class="s1">'award'</span><span class="p">)</span> <span class="o">-></span> <span class="kc">True</span>
+<span class="n">isWord</span><span class="p">(</span><span class="mi">9</span><span class="p">)</span> <span class="o">-></span> <span class="kc">False</span>
+<span class="n">isWord</span><span class="p">(</span><span class="s1">'a_b_c_'</span><span class="p">)</span> <span class="o">-></span><span class="kc">True</span>
+</pre></div>
+</div>
+<p>@note: isWord('9abc') will return True - not exactly correct, but adequate
+for the way it's used here.</p>
+<p>@param s: The name to be tested
+@type s: any
+@return: True if a word, else False
+@rtype: bool</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.pyconf.makePath">
+<code class="descclassname">src.pyconf.</code><code class="descname">makePath</code><span class="sig-paren">(</span><em>prefix</em>, <em>suffix</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#makePath"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.makePath" title="Permalink to this definition">¶</a></dt>
+<dd><p>Make a path from a prefix and suffix.</p>
+<p>Examples::
+makePath('', 'suffix') -> 'suffix'
+makePath('prefix', 'suffix') -> 'prefix.suffix'
+makePath('prefix', '[1]') -> 'prefix[1]'</p>
+<p>@param prefix: The prefix to use. If it evaluates as false, the suffix is returned.
+@type prefix: str
+@param suffix: The suffix to use. It is either an identifier or an index in brackets.
+@type suffix: str
+@return: The path concatenation of prefix and suffix, with a dot if the suffix is not a bracketed index.
+@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>
</dd></dl>
+</div>
+<div class="section" id="module-src.returnCode">
+<span id="src-returncode-module"></span><h2>src.returnCode module<a class="headerlink" href="#module-src.returnCode" title="Permalink to this headline">¶</a></h2>
+<p>This file contains ReturnCode class
+usage:
+>> import returnCode as RCO</p>
<dl class="class">
-<dt id="src.pyconf.ConfigInputStream">
-<em class="property">class </em><code class="descclassname">src.pyconf.</code><code class="descname">ConfigInputStream</code><span class="sig-paren">(</span><em>stream</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigInputStream"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigInputStream" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
-<p>An input stream which can read either ANSI files with default encoding
-or Unicode files with BOMs.</p>
-<p>Handles UTF-8, UTF-16LE, UTF-16BE. Could handle UTF-32 if Python had
-built-in support.</p>
-<dl class="method">
-<dt id="src.pyconf.ConfigInputStream.close">
-<code class="descname">close</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigInputStream.close"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigInputStream.close" title="Permalink to this definition">¶</a></dt>
+<dt id="src.returnCode.ReturnCode">
+<em class="property">class </em><code class="descclassname">src.returnCode.</code><code class="descname">ReturnCode</code><span class="sig-paren">(</span><em>status=None</em>, <em>why=None</em>, <em>value=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/returnCode.html#ReturnCode"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.returnCode.ReturnCode" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
+<p>assume simple return code for methods, with explanation as 'why'
+obviously why is why it is not OK,
+but also why is why it is OK (if you want).
+and optionnaly contains a return value as self.getValue()</p>
+<dl class="docutils">
+<dt>usage:</dt>
+<dd><p class="first">>> import returnCode as RCO</p>
+<p>>> aValue = doSomethingToReturn()
+>> return RCO.ReturnCode("KO", "there is no problem here", aValue)
+>> return RCO.ReturnCode("KO", "there is a problem here because etc", None)
+>> return RCO.ReturnCode("TIMEOUT_STATUS", "too long here because etc")
+>> return RCO.ReturnCode("NA", "not applicable here because etc")</p>
+<p>>> rc = doSomething()
+>> print("short returnCode string", str(rc))
+>> print("long returnCode string with value", repr(rc))</p>
+<p class="last">>> rc1 = RCO.ReturnCode("OK", ...)
+>> rc2 = RCO.ReturnCode("KO", ...)
+>> rcFinal = rc1 + rc2
+>> print("long returnCode string with value", repr(rcFinal)) # KO!</p>
+</dd>
+</dl>
+<dl class="attribute">
+<dt id="src.returnCode.ReturnCode.KFSYS">
+<code class="descname">KFSYS</code><em class="property"> = 4</em><a class="headerlink" href="#src.returnCode.ReturnCode.KFSYS" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
-<dl class="method">
-<dt id="src.pyconf.ConfigInputStream.read">
-<code class="descname">read</code><span class="sig-paren">(</span><em>size</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigInputStream.read"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigInputStream.read" title="Permalink to this definition">¶</a></dt>
+<dl class="attribute">
+<dt id="src.returnCode.ReturnCode.KNOWNFAILURE_STATUS">
+<code class="descname">KNOWNFAILURE_STATUS</code><em class="property"> = 'KF'</em><a class="headerlink" href="#src.returnCode.ReturnCode.KNOWNFAILURE_STATUS" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="src.returnCode.ReturnCode.KOSYS">
+<code class="descname">KOSYS</code><em class="property"> = 1</em><a class="headerlink" href="#src.returnCode.ReturnCode.KOSYS" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="src.returnCode.ReturnCode.KO_STATUS">
+<code class="descname">KO_STATUS</code><em class="property"> = 'KO'</em><a class="headerlink" href="#src.returnCode.ReturnCode.KO_STATUS" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="src.returnCode.ReturnCode.NASYS">
+<code class="descname">NASYS</code><em class="property"> = 2</em><a class="headerlink" href="#src.returnCode.ReturnCode.NASYS" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="src.returnCode.ReturnCode.NA_STATUS">
+<code class="descname">NA_STATUS</code><em class="property"> = 'NA'</em><a class="headerlink" href="#src.returnCode.ReturnCode.NA_STATUS" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="src.returnCode.ReturnCode.NDSYS">
+<code class="descname">NDSYS</code><em class="property"> = 3</em><a class="headerlink" href="#src.returnCode.ReturnCode.NDSYS" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="src.returnCode.ReturnCode.OKSYS">
+<code class="descname">OKSYS</code><em class="property"> = 0</em><a class="headerlink" href="#src.returnCode.ReturnCode.OKSYS" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="src.returnCode.ReturnCode.OK_STATUS">
+<code class="descname">OK_STATUS</code><em class="property"> = 'OK'</em><a class="headerlink" href="#src.returnCode.ReturnCode.OK_STATUS" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="src.returnCode.ReturnCode.TIMEOUT_STATUS">
+<code class="descname">TIMEOUT_STATUS</code><em class="property"> = 'TIMEOUT'</em><a class="headerlink" href="#src.returnCode.ReturnCode.TIMEOUT_STATUS" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="src.returnCode.ReturnCode.TOSYS">
+<code class="descname">TOSYS</code><em class="property"> = 5</em><a class="headerlink" href="#src.returnCode.ReturnCode.TOSYS" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="src.returnCode.ReturnCode.UNKNOWN_STATUS">
+<code class="descname">UNKNOWN_STATUS</code><em class="property"> = 'ND'</em><a class="headerlink" href="#src.returnCode.ReturnCode.UNKNOWN_STATUS" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
-<dt id="src.pyconf.ConfigInputStream.readline">
-<code class="descname">readline</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigInputStream.readline"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigInputStream.readline" title="Permalink to this definition">¶</a></dt>
+<dt id="src.returnCode.ReturnCode.getValue">
+<code class="descname">getValue</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/returnCode.html#ReturnCode.getValue"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.returnCode.ReturnCode.getValue" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
-</dd></dl>
+<dl class="method">
+<dt id="src.returnCode.ReturnCode.getWhy">
+<code class="descname">getWhy</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/returnCode.html#ReturnCode.getWhy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.returnCode.ReturnCode.getWhy" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
-<dl class="class">
-<dt id="src.pyconf.ConfigList">
-<em class="property">class </em><code class="descclassname">src.pyconf.</code><code class="descname">ConfigList</code><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigList"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigList" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></p>
-<p>This class implements an ordered list of configurations and allows you
-to try getting the configuration from each entry in turn, returning
-the first successfully obtained value.</p>
<dl class="method">
-<dt id="src.pyconf.ConfigList.getByPath">
-<code class="descname">getByPath</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigList.getByPath"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigList.getByPath" title="Permalink to this definition">¶</a></dt>
-<dd><p>Obtain a value from the first configuration in the list which defines
-it.</p>
-<p>@param path: The path of the value to retrieve.
-@type path: str
-@return: The value from the earliest configuration in the list which
-defines it.
-@rtype: any
-@raise ConfigError: If no configuration in the list has an entry with
-the specified path.</p>
+<dt id="src.returnCode.ReturnCode.indent">
+<code class="descname">indent</code><span class="sig-paren">(</span><em>text</em>, <em>amount=5</em>, <em>ch=' '</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/returnCode.html#ReturnCode.indent"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.returnCode.ReturnCode.indent" title="Permalink to this definition">¶</a></dt>
+<dd><p>indent multi lines message</p>
</dd></dl>
-</dd></dl>
+<dl class="method">
+<dt id="src.returnCode.ReturnCode.isOk">
+<code class="descname">isOk</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/returnCode.html#ReturnCode.isOk"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.returnCode.ReturnCode.isOk" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
-<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>
-<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
-merge operand to the merge target. If a key exists in both configurations,
-then a resolver (a callable) is called to decide how to handle the
-conflict.</p>
<dl class="method">
-<dt id="src.pyconf.ConfigMerger.handleMismatch">
-<code class="descname">handleMismatch</code><span class="sig-paren">(</span><em>obj1</em>, <em>obj2</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigMerger.handleMismatch"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigMerger.handleMismatch" title="Permalink to this definition">¶</a></dt>
-<dd><p>Handle a mismatch between two objects.</p>
-<p>@param obj1: The object to merge into.
-@type obj1: any
-@param obj2: The object to merge.
-@type obj2: any</p>
-</dd></dl>
+<dt id="src.returnCode.ReturnCode.setStatus">
+<code class="descname">setStatus</code><span class="sig-paren">(</span><em>status</em>, <em>why=None</em>, <em>value=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/returnCode.html#ReturnCode.setStatus"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.returnCode.ReturnCode.setStatus" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
<dl class="method">
-<dt id="src.pyconf.ConfigMerger.merge">
-<code class="descname">merge</code><span class="sig-paren">(</span><em>merged</em>, <em>mergee</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigMerger.merge"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigMerger.merge" title="Permalink to this definition">¶</a></dt>
-<dd><p>Merge two configurations. The second configuration is unchanged,
-and the first is changed to reflect the results of the merge.</p>
-<p>@param merged: The configuration to merge into.
-@type merged: L{Config}.
-@param mergee: The configuration to merge.
-@type mergee: L{Config}.</p>
-</dd></dl>
+<dt id="src.returnCode.ReturnCode.setValue">
+<code class="descname">setValue</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/returnCode.html#ReturnCode.setValue"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.returnCode.ReturnCode.setValue" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
<dl class="method">
-<dt id="src.pyconf.ConfigMerger.mergeMapping">
-<code class="descname">mergeMapping</code><span class="sig-paren">(</span><em>map1</em>, <em>map2</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigMerger.mergeMapping"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigMerger.mergeMapping" title="Permalink to this definition">¶</a></dt>
-<dd><p>Merge two mappings recursively. The second mapping is unchanged,
-and the first is changed to reflect the results of the merge.</p>
-<p>@param map1: The mapping to merge into.
-@type map1: L{Mapping}.
-@param map2: The mapping to merge.
-@type map2: L{Mapping}.</p>
+<dt id="src.returnCode.ReturnCode.setWhy">
+<code class="descname">setWhy</code><span class="sig-paren">(</span><em>why</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/returnCode.html#ReturnCode.setWhy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.returnCode.ReturnCode.setWhy" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.returnCode.ReturnCode.toSys">
+<code class="descname">toSys</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/returnCode.html#ReturnCode.toSys"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.returnCode.ReturnCode.toSys" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
</dd></dl>
+</div>
+<div class="section" id="module-src.salomeTools">
+<span id="src-salometools-module"></span><h2>src.salomeTools module<a class="headerlink" href="#module-src.salomeTools" title="Permalink to this headline">¶</a></h2>
+<p>This file is the main entry file to salomeTools
+NO __main__ entry allowed, use 'sat' (in parent directory)</p>
+<dl class="class">
+<dt id="src.salomeTools.Sat">
+<em class="property">class </em><code class="descclassname">src.salomeTools.</code><code class="descname">Sat</code><span class="sig-paren">(</span><em>logger</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/salomeTools.html#Sat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.salomeTools.Sat" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
+<p>The main class that stores all the commands of salomeTools
+(usually known as 'runner' argument in Command classes)</p>
+<dl class="method">
+<dt id="src.salomeTools.Sat.assumeAsList">
+<code class="descname">assumeAsList</code><span class="sig-paren">(</span><em>strOrList</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/salomeTools.html#Sat.assumeAsList"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.salomeTools.Sat.assumeAsList" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
<dl class="method">
-<dt id="src.pyconf.ConfigMerger.mergeSequence">
-<code class="descname">mergeSequence</code><span class="sig-paren">(</span><em>seq1</em>, <em>seq2</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigMerger.mergeSequence"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigMerger.mergeSequence" title="Permalink to this definition">¶</a></dt>
-<dd><p>Merge two sequences. The second sequence is unchanged,
-and the first is changed to have the elements of the second
-appended to it.</p>
-<p>@param seq1: The sequence to merge into.
-@type seq1: L{Sequence}.
-@param seq2: The sequence to merge.
-@type seq2: L{Sequence}.</p>
+<dt id="src.salomeTools.Sat.execute_cli">
+<code class="descname">execute_cli</code><span class="sig-paren">(</span><em>cli_arguments</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/salomeTools.html#Sat.execute_cli"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.salomeTools.Sat.execute_cli" title="Permalink to this definition">¶</a></dt>
+<dd><p>select first argument as a command in directory 'commands', and launch on arguments</p>
+<p>:param args str or list, The sat cli arguments (as sys.argv)</p>
</dd></dl>
<dl class="method">
-<dt id="src.pyconf.ConfigMerger.overwriteKeys">
-<code class="descname">overwriteKeys</code><span class="sig-paren">(</span><em>map1</em>, <em>seq2</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigMerger.overwriteKeys"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigMerger.overwriteKeys" title="Permalink to this definition">¶</a></dt>
-<dd><p>Renint variables. The second mapping is unchanged,
-and the first is changed depending the keys of the second mapping.
-@param map1: The mapping to reinit keys into.
-@type map1: L{Mapping}.
-@param map2: The mapping container reinit information.
-@type map2: L{Mapping}.</p>
+<dt id="src.salomeTools.Sat.getColoredVersion">
+<code class="descname">getColoredVersion</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/salomeTools.html#Sat.getColoredVersion"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.salomeTools.Sat.getColoredVersion" title="Permalink to this definition">¶</a></dt>
+<dd><p>get colored salomeTools version message</p>
</dd></dl>
+<dl class="method">
+<dt id="src.salomeTools.Sat.getCommandAndAppli">
+<code class="descname">getCommandAndAppli</code><span class="sig-paren">(</span><em>arguments</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/salomeTools.html#Sat.getCommandAndAppli"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.salomeTools.Sat.getCommandAndAppli" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="src.salomeTools.Sat.getCommandInstance">
+<code class="descname">getCommandInstance</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/salomeTools.html#Sat.getCommandInstance"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.salomeTools.Sat.getCommandInstance" title="Permalink to this definition">¶</a></dt>
+<dd><p>returns inherited instance of Command(_BaseCmd) for command 'name'
+if module not loaded yet, load it.</p>
</dd></dl>
-<dl class="class">
-<dt id="src.pyconf.ConfigOutputStream">
-<em class="property">class </em><code class="descclassname">src.pyconf.</code><code class="descname">ConfigOutputStream</code><span class="sig-paren">(</span><em>stream</em>, <em>encoding=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigOutputStream"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigOutputStream" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
-<p>An output stream which can write either ANSI files with default encoding
-or Unicode files with BOMs.</p>
-<p>Handles UTF-8, UTF-16LE, UTF-16BE. Could handle UTF-32 if Python had
-built-in support.</p>
<dl class="method">
-<dt id="src.pyconf.ConfigOutputStream.close">
-<code class="descname">close</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigOutputStream.close"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigOutputStream.close" title="Permalink to this definition">¶</a></dt>
+<dt id="src.salomeTools.Sat.getConfig">
+<code class="descname">getConfig</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/salomeTools.html#Sat.getConfig"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.salomeTools.Sat.getConfig" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
-<dt id="src.pyconf.ConfigOutputStream.flush">
-<code class="descname">flush</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigOutputStream.flush"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigOutputStream.flush" title="Permalink to this definition">¶</a></dt>
+<dt id="src.salomeTools.Sat.getConfigManager">
+<code class="descname">getConfigManager</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/salomeTools.html#Sat.getConfigManager"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.salomeTools.Sat.getConfigManager" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
-<dt id="src.pyconf.ConfigOutputStream.write">
-<code class="descname">write</code><span class="sig-paren">(</span><em>data</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigOutputStream.write"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigOutputStream.write" title="Permalink to this definition">¶</a></dt>
+<dt id="src.salomeTools.Sat.getLogger">
+<code class="descname">getLogger</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/salomeTools.html#Sat.getLogger"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.salomeTools.Sat.getLogger" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
+<dl class="method">
+<dt id="src.salomeTools.Sat.getModule">
+<code class="descname">getModule</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/salomeTools.html#Sat.getModule"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.salomeTools.Sat.getModule" title="Permalink to this definition">¶</a></dt>
+<dd><p>returns only-one-time loaded module Command 'name'
+assume load if not done yet</p>
</dd></dl>
-<dl class="class">
-<dt id="src.pyconf.ConfigReader">
-<em class="property">class </em><code class="descclassname">src.pyconf.</code><code class="descname">ConfigReader</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigReader"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigReader" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
-<p>This internal class implements a parser for configurations.</p>
<dl class="method">
-<dt id="src.pyconf.ConfigReader.getChar">
-<code class="descname">getChar</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigReader.getChar"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigReader.getChar" title="Permalink to this definition">¶</a></dt>
-<dd><p>Get the next char from the stream. Update line and column numbers
-appropriately.</p>
-<p>@return: The next character from the stream.
-@rtype: str</p>
+<dt id="src.salomeTools.Sat.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/salomeTools.html#Sat.get_help"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.salomeTools.Sat.get_help" title="Permalink to this definition">¶</a></dt>
+<dd><p>get general help colored string</p>
</dd></dl>
<dl class="method">
-<dt id="src.pyconf.ConfigReader.getToken">
-<code class="descname">getToken</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigReader.getToken"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigReader.getToken" title="Permalink to this definition">¶</a></dt>
-<dd><p>Get a token from the stream. String values are returned in a form
-where you need to eval() the returned value to get the actual
-string. The return value is (token_type, token_value).</p>
-<p>Multiline string tokenizing is thanks to David Janes (BlogMatrix)</p>
-<p>@return: The next token.
-@rtype: A token tuple.</p>
-</dd></dl>
+<dt id="src.salomeTools.Sat.parseArguments">
+<code class="descname">parseArguments</code><span class="sig-paren">(</span><em>arguments</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/salomeTools.html#Sat.parseArguments"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.salomeTools.Sat.parseArguments" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
<dl class="method">
-<dt id="src.pyconf.ConfigReader.load">
-<code class="descname">load</code><span class="sig-paren">(</span><em>stream</em>, <em>parent=None</em>, <em>suffix=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigReader.load"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigReader.load" title="Permalink to this definition">¶</a></dt>
-<dd><p>Load the configuration from the specified stream.</p>
-<p>@param stream: A stream from which to load the configuration.
-@type stream: A stream (file-like object).
-@param parent: The parent of the configuration (to which this reader
-belongs) in the hierarchy. Specified when the configuration is
-included in another one.
-@type parent: A L{Container} instance.
-@param suffix: The suffix of this configuration in the parent
-configuration. Should be specified whenever the parent is not None.
-@raise ConfigError: If parent is specified but suffix is not.
-@raise ConfigFormatError: If there are syntax errors in the stream.</p>
+<dt id="src.salomeTools.Sat.print_help">
+<code class="descname">print_help</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/salomeTools.html#Sat.print_help"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.salomeTools.Sat.print_help" title="Permalink to this definition">¶</a></dt>
+<dd><p>prints salomeTools general help</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="function">
+<dt id="src.salomeTools.assumeAsList">
+<code class="descclassname">src.salomeTools.</code><code class="descname">assumeAsList</code><span class="sig-paren">(</span><em>strOrList</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/salomeTools.html#assumeAsList"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.salomeTools.assumeAsList" title="Permalink to this definition">¶</a></dt>
+<dd><p>return a list as sys.argv if string</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.salomeTools.find_command_list">
+<code class="descclassname">src.salomeTools.</code><code class="descname">find_command_list</code><span class="sig-paren">(</span><em>dirPath</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/salomeTools.html#find_command_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.salomeTools.find_command_list" title="Permalink to this definition">¶</a></dt>
+<dd><p>Parse files in dirPath that end with '.py' : it gives commands 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>dirPath</em>) -- The directory path where to search the commands</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">cmd_list : the list containing the commands name</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#src.utilsSat.Path.list" title="src.utilsSat.Path.list">list</a></td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.salomeTools.getCommandsList">
+<code class="descclassname">src.salomeTools.</code><code class="descname">getCommandsList</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/salomeTools.html#getCommandsList"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.salomeTools.getCommandsList" title="Permalink to this definition">¶</a></dt>
+<dd><p>Gives commands list (as basename of files .py in directory commands</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.salomeTools.getVersion">
+<code class="descclassname">src.salomeTools.</code><code class="descname">getVersion</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/salomeTools.html#getVersion"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.salomeTools.getVersion" title="Permalink to this definition">¶</a></dt>
+<dd><p>get version number as string</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.salomeTools.launchSat">
+<code class="descclassname">src.salomeTools.</code><code class="descname">launchSat</code><span class="sig-paren">(</span><em>command</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/salomeTools.html#launchSat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.salomeTools.launchSat" title="Permalink to this definition">¶</a></dt>
+<dd><p>launch sat as subprocess popen
+command as string ('sat --help' for example)
+used for unittest, or else...
+returns tuple (stdout, stderr)</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.salomeTools.setLocale">
+<code class="descclassname">src.salomeTools.</code><code class="descname">setLocale</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/salomeTools.html#setLocale"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.salomeTools.setLocale" title="Permalink to this definition">¶</a></dt>
+<dd><p>reset initial locale at any moment
+'fr' or else (TODO) from initial environment var '$LANG'
+'i18n' as 'internationalization'</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.salomeTools.setNotLocale">
+<code class="descclassname">src.salomeTools.</code><code class="descname">setNotLocale</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/salomeTools.html#setNotLocale"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.salomeTools.setNotLocale" title="Permalink to this definition">¶</a></dt>
+<dd><p>force english at any moment</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>All utilities method doing a system call,
+like open a browser or an editor, or call a git command</p>
+<dl class="docutils">
+<dt>usage:</dt>
+<dd>>> import src.system as SYSS</dd>
+</dl>
+<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> (<a class="reference internal" href="#module-src.environment" title="src.environment"><em>environment</em></a>) -- 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> (<a class="reference internal" href="#module-src.environment" title="src.environment"><em>environment</em></a>) -- 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> (<a class="reference internal" href="#module-src.environment" title="src.environment"><em>environment</em></a>) -- 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"><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.pyconf.ConfigReader.location">
-<code class="descname">location</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigReader.location"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigReader.location" title="Permalink to this definition">¶</a></dt>
-<dd><p>Return the current location (filename, line, column) in the stream
-as a string.</p>
-<p>Used when printing error messages,</p>
-<p>@return: A string representing a location in the stream being read.
-@rtype: str</p>
-</dd></dl>
+<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.pyconf.ConfigReader.match">
-<code class="descname">match</code><span class="sig-paren">(</span><em>t</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigReader.match"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigReader.match" title="Permalink to this definition">¶</a></dt>
-<dd><p>Ensure that the current token type matches the specified value, and
-advance to the next token.</p>
-<p>@param t: The token type to match.
-@type t: A valid token type.
-@return: The token which was last read from the stream before this
-function is called.
-@rtype: a token tuple - see L{getToken}.
-@raise ConfigFormatError: If the token does not match what’s expected.</p>
-</dd></dl>
+<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.pyconf.ConfigReader.parseFactor">
-<code class="descname">parseFactor</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigReader.parseFactor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigReader.parseFactor" title="Permalink to this definition">¶</a></dt>
-<dd><p>Parse a factor in an multiplicative expression (a * b, a / b, a % b)</p>
-<p>@return: the parsed factor
-@rtype: any scalar
-@raise ConfigFormatError: if a syntax error is found.</p>
-</dd></dl>
+<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.pyconf.ConfigReader.parseKeyValuePair">
-<code class="descname">parseKeyValuePair</code><span class="sig-paren">(</span><em>parent</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigReader.parseKeyValuePair"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigReader.parseKeyValuePair" title="Permalink to this definition">¶</a></dt>
-<dd><p>Parse a key-value pair, and add it to the provided L{Mapping}.</p>
-<p>@param parent: The mapping to add entries to.
-@type parent: A L{Mapping} instance.
-@raise ConfigFormatError: if a syntax error is found.</p>
-</dd></dl>
+<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.pyconf.ConfigReader.parseMapping">
-<code class="descname">parseMapping</code><span class="sig-paren">(</span><em>parent</em>, <em>suffix</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigReader.parseMapping"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigReader.parseMapping" title="Permalink to this definition">¶</a></dt>
-<dd><p>Parse a mapping.</p>
-<p>@param parent: The container to which the mapping will be added.
-@type parent: A L{Container} instance.
-@param suffix: The suffix for the value.
-@type suffix: str
-@return: a L{Mapping} instance representing the mapping.
-@rtype: L{Mapping}
-@raise ConfigFormatError: if a syntax error is found.</p>
-</dd></dl>
+<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.pyconf.ConfigReader.parseMappingBody">
-<code class="descname">parseMappingBody</code><span class="sig-paren">(</span><em>parent</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigReader.parseMappingBody"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigReader.parseMappingBody" title="Permalink to this definition">¶</a></dt>
-<dd><p>Parse the internals of a mapping, and add entries to the provided
-L{Mapping}.</p>
-<p>@param parent: The mapping to add entries to.
-@type parent: A L{Mapping} instance.</p>
-</dd></dl>
+<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.pyconf.ConfigReader.parseReference">
-<code class="descname">parseReference</code><span class="sig-paren">(</span><em>type</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigReader.parseReference"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigReader.parseReference" title="Permalink to this definition">¶</a></dt>
-<dd><p>Parse a reference.</p>
-<p>@return: the parsed reference
-@rtype: L{Reference}
-@raise ConfigFormatError: if a syntax error is found.</p>
-</dd></dl>
+<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.pyconf.ConfigReader.parseScalar">
-<code class="descname">parseScalar</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigReader.parseScalar"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigReader.parseScalar" title="Permalink to this definition">¶</a></dt>
-<dd><p>Parse a scalar - a terminal value such as a string or number, or
-an L{Expression} or L{Reference}.</p>
-<p>@return: the parsed scalar
-@rtype: any scalar
-@raise ConfigFormatError: if a syntax error is found.</p>
-</dd></dl>
+<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.pyconf.ConfigReader.parseSequence">
-<code class="descname">parseSequence</code><span class="sig-paren">(</span><em>parent</em>, <em>suffix</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigReader.parseSequence"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigReader.parseSequence" title="Permalink to this definition">¶</a></dt>
-<dd><p>Parse a sequence.</p>
-<p>@param parent: The container to which the sequence will be added.
-@type parent: A L{Container} instance.
-@param suffix: The suffix for the value.
-@type suffix: str
-@return: a L{Sequence} instance representing the sequence.
-@rtype: L{Sequence}
-@raise ConfigFormatError: if a syntax error is found.</p>
-</dd></dl>
+<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.pyconf.ConfigReader.parseSuffix">
-<code class="descname">parseSuffix</code><span class="sig-paren">(</span><em>ref</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigReader.parseSuffix"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigReader.parseSuffix" title="Permalink to this definition">¶</a></dt>
-<dd><p>Parse a reference suffix.</p>
-<p>@param ref: The reference of which this suffix is a part.
-@type ref: L{Reference}.
-@raise ConfigFormatError: if a syntax error is found.</p>
-</dd></dl>
+<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.pyconf.ConfigReader.parseTerm">
-<code class="descname">parseTerm</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigReader.parseTerm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigReader.parseTerm" title="Permalink to this definition">¶</a></dt>
-<dd><p>Parse a term in an additive expression (a + b, a - b)</p>
-<p>@return: the parsed term
-@rtype: any scalar
-@raise ConfigFormatError: if a syntax error is found.</p>
-</dd></dl>
+<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.pyconf.ConfigReader.parseValue">
-<code class="descname">parseValue</code><span class="sig-paren">(</span><em>parent</em>, <em>suffix</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigReader.parseValue"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigReader.parseValue" title="Permalink to this definition">¶</a></dt>
-<dd><p>Parse a value.</p>
-<p>@param parent: The container to which the value will be added.
-@type parent: A L{Container} instance.
-@param suffix: The suffix for the value.
-@type suffix: str
-@return: The value
-@rtype: any
-@raise ConfigFormatError: if a syntax error is found.</p>
-</dd></dl>
+<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.pyconf.ConfigReader.setStream">
-<code class="descname">setStream</code><span class="sig-paren">(</span><em>stream</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigReader.setStream"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigReader.setStream" title="Permalink to this definition">¶</a></dt>
-<dd><p>Set the stream to the specified value, and prepare to read from it.</p>
-<p>@param stream: A stream from which to load the configuration.
-@type stream: A stream (file-like object).</p>
-</dd></dl>
-
+<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><p>Runs test testbase</p>
</dd></dl>
-<dl class="exception">
-<dt id="src.pyconf.ConfigResolutionError">
-<em class="property">exception </em><code class="descclassname">src.pyconf.</code><code class="descname">ConfigResolutionError</code><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigResolutionError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigResolutionError" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <a class="reference internal" href="#src.pyconf.ConfigError" title="src.pyconf.ConfigError"><code class="xref py py-class docutils literal notranslate"><span class="pre">src.pyconf.ConfigError</span></code></a></p>
-<p>This is the base class of exceptions raised due to semantic errors in
-configurations.</p>
-</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="class">
-<dt id="src.pyconf.Container">
-<em class="property">class </em><code class="descclassname">src.pyconf.</code><code class="descname">Container</code><span class="sig-paren">(</span><em>parent</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Container"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Container" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
-<p>This internal class is the base class for mappings and sequences.</p>
-<p>@ivar path: A string which describes how to get
-to this instance from the root of the hierarchy.</p>
-<p>Example:</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">a</span><span class="o">.</span><span class="n">list</span><span class="o">.</span><span class="n">of</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="ow">or</span><span class="p">[</span><span class="s1">'more'</span><span class="p">]</span><span class="o">.</span><span class="n">elements</span>
-</pre></div>
-</div>
<dl class="method">
-<dt id="src.pyconf.Container.evaluate">
-<code class="descname">evaluate</code><span class="sig-paren">(</span><em>item</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Container.evaluate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Container.evaluate" title="Permalink to this definition">¶</a></dt>
-<dd><p>Evaluate items which are instances of L{Reference} or L{Expression}.</p>
-<p>L{Reference} instances are evaluated using L{Reference.resolve},
-and L{Expression} instances are evaluated using
-L{Expression.evaluate}.</p>
-<p>@param item: The item to be evaluated.
-@type item: any
-@return: If the item is an instance of L{Reference} or L{Expression},
-the evaluated value is returned, otherwise the item is returned
-unchanged.</p>
-</dd></dl>
+<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.pyconf.Container.setPath">
-<code class="descname">setPath</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Container.setPath"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Container.setPath" title="Permalink to this definition">¶</a></dt>
-<dd><p>Set the path for this instance.
-@param path: The path - a string which describes how to get
-to this instance from the root of the hierarchy.
-@type path: str</p>
+<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><p>indent with '| ... +' to show test results.</p>
</dd></dl>
-<dl class="method">
-<dt id="src.pyconf.Container.writeToStream">
-<code class="descname">writeToStream</code><span class="sig-paren">(</span><em>stream</em>, <em>indent</em>, <em>container</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Container.writeToStream"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Container.writeToStream" title="Permalink to this definition">¶</a></dt>
-<dd><p>Write this instance to a stream at the specified indentation level.</p>
-<p>Should be redefined in subclasses.</p>
-<p>@param stream: The stream to write to
-@type stream: A writable stream (file-like object)
-@param indent: The indentation level
-@type indent: int
-@param container: The container of this instance
-@type container: L{Container}
-@raise NotImplementedError: If a subclass does not override this</p>
</dd></dl>
-<dl class="method">
-<dt id="src.pyconf.Container.writeValue">
-<code class="descname">writeValue</code><span class="sig-paren">(</span><em>value</em>, <em>stream</em>, <em>indent</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Container.writeValue"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Container.writeValue" title="Permalink to this definition">¶</a></dt>
+<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>
-</dd></dl>
-
+</div>
+<div class="section" id="module-src.utilsSat">
+<span id="src-utilssat-module"></span><h2>src.utilsSat module<a class="headerlink" href="#module-src.utilsSat" title="Permalink to this headline">¶</a></h2>
+<p>utilities for sat
+general useful simple methods
+all-in-one import srs.utilsSat as UTS</p>
+<p>usage:
+>> import srsc.utilsSat as UTS
+>> UTS.ensure_path_exists(path)</p>
<dl class="class">
-<dt id="src.pyconf.Expression">
-<em class="property">class </em><code class="descclassname">src.pyconf.</code><code class="descname">Expression</code><span class="sig-paren">(</span><em>op</em>, <em>lhs</em>, <em>rhs</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Expression"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Expression" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
-<p>This internal class implements a value which is obtained by evaluating an expression.</p>
-<dl class="method">
-<dt id="src.pyconf.Expression.evaluate">
-<code class="descname">evaluate</code><span class="sig-paren">(</span><em>container</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Expression.evaluate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Expression.evaluate" title="Permalink to this definition">¶</a></dt>
-<dd><p>Evaluate this instance in the context of a container.</p>
-<p>@param container: The container to evaluate in from.
-@type container: L{Container}
-@return: The evaluated value.
-@rtype: any
-@raise ConfigResolutionError: If evaluation fails.
-@raise ZeroDivideError: If division by zero occurs.
-@raise TypeError: If the operation is invalid, e.g.
-subtracting one string from another.</p>
-</dd></dl>
+<dt id="src.utilsSat.Path">
+<em class="property">class </em><code class="descclassname">src.utilsSat.</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/utilsSat.html#Path"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.utilsSat.Path" title="Permalink to this definition">¶</a></dt>
+<dd><dl class="method">
+<dt id="src.utilsSat.Path.base">
+<code class="descname">base</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/utilsSat.html#Path.base"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.utilsSat.Path.base" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
-</dd></dl>
+<dl class="method">
+<dt id="src.utilsSat.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/utilsSat.html#Path.chmod"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.utilsSat.Path.chmod" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
-<dl class="class">
-<dt id="src.pyconf.Mapping">
-<em class="property">class </em><code class="descclassname">src.pyconf.</code><code class="descname">Mapping</code><span class="sig-paren">(</span><em>parent=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Mapping"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Mapping" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <a class="reference internal" href="#src.pyconf.Container" title="src.pyconf.Container"><code class="xref py py-class docutils literal notranslate"><span class="pre">src.pyconf.Container</span></code></a></p>
-<p>This internal class implements key-value mappings in configurations.</p>
<dl class="method">
-<dt id="src.pyconf.Mapping.addMapping">
-<code class="descname">addMapping</code><span class="sig-paren">(</span><em>key</em>, <em>value</em>, <em>comment</em>, <em>setting=False</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Mapping.addMapping"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Mapping.addMapping" title="Permalink to this definition">¶</a></dt>
-<dd><p>Add a key-value mapping with a comment.</p>
-<p>@param key: The key for the mapping.
-@type key: str
-@param value: The value for the mapping.
-@type value: any
-@param comment: The comment for the key (can be None).
-@type comment: str
-@param setting: If True, ignore clashes. This is set
-to true when called from L{__setattr__}.
-@raise ConfigFormatError: If an existing key is seen
-again and setting is False.</p>
-</dd></dl>
+<dt id="src.utilsSat.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/utilsSat.html#Path.copy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.utilsSat.Path.copy" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
<dl class="method">
-<dt id="src.pyconf.Mapping.get">
-<code class="descname">get</code><span class="sig-paren">(</span><em>key</em>, <em>default=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Mapping.get"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Mapping.get" title="Permalink to this definition">¶</a></dt>
-<dd><p>Allows a dictionary-style get operation.</p>
-</dd></dl>
+<dt id="src.utilsSat.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/utilsSat.html#Path.copydir"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.utilsSat.Path.copydir" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
<dl class="method">
-<dt id="src.pyconf.Mapping.iteritems">
-<code class="descname">iteritems</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Mapping.iteritems"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Mapping.iteritems" title="Permalink to this definition">¶</a></dt>
+<dt id="src.utilsSat.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/utilsSat.html#Path.copyfile"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.utilsSat.Path.copyfile" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
-<dt id="src.pyconf.Mapping.iterkeys">
-<code class="descname">iterkeys</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Mapping.iterkeys"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Mapping.iterkeys" title="Permalink to this definition">¶</a></dt>
+<dt id="src.utilsSat.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/utilsSat.html#Path.copylink"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.utilsSat.Path.copylink" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
-<dt id="src.pyconf.Mapping.keys">
-<code class="descname">keys</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Mapping.keys"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Mapping.keys" title="Permalink to this definition">¶</a></dt>
-<dd><p>Return the keys in a similar way to a dictionary.</p>
-</dd></dl>
+<dt id="src.utilsSat.Path.dir">
+<code class="descname">dir</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/utilsSat.html#Path.dir"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.utilsSat.Path.dir" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
<dl class="method">
-<dt id="src.pyconf.Mapping.writeToStream">
-<code class="descname">writeToStream</code><span class="sig-paren">(</span><em>stream</em>, <em>indent</em>, <em>container</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Mapping.writeToStream"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Mapping.writeToStream" title="Permalink to this definition">¶</a></dt>
-<dd><p>Write this instance to a stream at the specified indentation level.</p>
-<p>Should be redefined in subclasses.</p>
-<p>@param stream: The stream to write to
-@type stream: A writable stream (file-like object)
-@param indent: The indentation level
-@type indent: int
-@param container: The container of this instance
-@type container: L{Container}</p>
-</dd></dl>
+<dt id="src.utilsSat.Path.exists">
+<code class="descname">exists</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/utilsSat.html#Path.exists"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.utilsSat.Path.exists" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
-</dd></dl>
+<dl class="method">
+<dt id="src.utilsSat.Path.isdir">
+<code class="descname">isdir</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/utilsSat.html#Path.isdir"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.utilsSat.Path.isdir" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
-<dl class="class">
-<dt id="src.pyconf.Reference">
-<em class="property">class </em><code class="descclassname">src.pyconf.</code><code class="descname">Reference</code><span class="sig-paren">(</span><em>config</em>, <em>type</em>, <em>ident</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Reference"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Reference" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
-<p>This internal class implements a value which is a reference to another value.</p>
<dl class="method">
-<dt id="src.pyconf.Reference.addElement">
-<code class="descname">addElement</code><span class="sig-paren">(</span><em>type</em>, <em>ident</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Reference.addElement"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Reference.addElement" title="Permalink to this definition">¶</a></dt>
-<dd><p>Add an element to the reference.</p>
-<p>@param type: The type of reference.
-@type type: BACKTICK or DOLLAR
-@param ident: The identifier which continues the reference.
-@type ident: str</p>
-</dd></dl>
+<dt id="src.utilsSat.Path.isfile">
+<code class="descname">isfile</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/utilsSat.html#Path.isfile"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.utilsSat.Path.isfile" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
<dl class="method">
-<dt id="src.pyconf.Reference.findConfig">
-<code class="descname">findConfig</code><span class="sig-paren">(</span><em>container</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Reference.findConfig"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Reference.findConfig" title="Permalink to this definition">¶</a></dt>
-<dd><p>Find the closest enclosing configuration to the specified container.</p>
-<p>@param container: The container to start from.
-@type container: L{Container}
-@return: The closest enclosing configuration, or None.
-@rtype: L{Config}</p>
-</dd></dl>
+<dt id="src.utilsSat.Path.islink">
+<code class="descname">islink</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/utilsSat.html#Path.islink"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.utilsSat.Path.islink" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
<dl class="method">
-<dt id="src.pyconf.Reference.resolve">
-<code class="descname">resolve</code><span class="sig-paren">(</span><em>container</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Reference.resolve"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Reference.resolve" title="Permalink to this definition">¶</a></dt>
-<dd><p>Resolve this instance in the context of a container.</p>
-<p>@param container: The container to resolve from.
-@type container: L{Container}
-@return: The resolved value.
-@rtype: any
-@raise ConfigResolutionError: If resolution fails.</p>
-</dd></dl>
+<dt id="src.utilsSat.Path.list">
+<code class="descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/utilsSat.html#Path.list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.utilsSat.Path.list" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
-</dd></dl>
+<dl class="method">
+<dt id="src.utilsSat.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/utilsSat.html#Path.make"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.utilsSat.Path.make" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
-<dl class="class">
-<dt id="src.pyconf.Sequence">
-<em class="property">class </em><code class="descclassname">src.pyconf.</code><code class="descname">Sequence</code><span class="sig-paren">(</span><em>parent=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Sequence"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Sequence" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <a class="reference internal" href="#src.pyconf.Container" title="src.pyconf.Container"><code class="xref py py-class docutils literal notranslate"><span class="pre">src.pyconf.Container</span></code></a></p>
-<p>This internal class implements a value which is a sequence of other values.</p>
-<dl class="class">
-<dt id="src.pyconf.Sequence.SeqIter">
-<em class="property">class </em><code class="descname">SeqIter</code><span class="sig-paren">(</span><em>seq</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Sequence.SeqIter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Sequence.SeqIter" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
-<p>This internal class implements an iterator for a L{Sequence} instance.</p>
<dl class="method">
-<dt id="src.pyconf.Sequence.SeqIter.next">
-<code class="descname">next</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Sequence.SeqIter.next"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Sequence.SeqIter.next" title="Permalink to this definition">¶</a></dt>
+<dt id="src.utilsSat.Path.readlink">
+<code class="descname">readlink</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/utilsSat.html#Path.readlink"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.utilsSat.Path.readlink" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
-</dd></dl>
+<dl class="method">
+<dt id="src.utilsSat.Path.rm">
+<code class="descname">rm</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/utilsSat.html#Path.rm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.utilsSat.Path.rm" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
<dl class="method">
-<dt id="src.pyconf.Sequence.append">
-<code class="descname">append</code><span class="sig-paren">(</span><em>item</em>, <em>comment</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Sequence.append"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Sequence.append" title="Permalink to this definition">¶</a></dt>
-<dd><p>Add an item to the sequence.</p>
-<p>@param item: The item to add.
-@type item: any
-@param comment: A comment for the item.
-@type comment: str</p>
-</dd></dl>
+<dt id="src.utilsSat.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/utilsSat.html#Path.smartcopy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.utilsSat.Path.smartcopy" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
<dl class="method">
-<dt id="src.pyconf.Sequence.writeToStream">
-<code class="descname">writeToStream</code><span class="sig-paren">(</span><em>stream</em>, <em>indent</em>, <em>container</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Sequence.writeToStream"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Sequence.writeToStream" title="Permalink to this definition">¶</a></dt>
-<dd><p>Write this instance to a stream at the specified indentation level.</p>
-<p>Should be redefined in subclasses.</p>
-<p>@param stream: The stream to write to
-@type stream: A writable stream (file-like object)
-@param indent: The indentation level
-@type indent: int
-@param container: The container of this instance
-@type container: L{Container}</p>
-</dd></dl>
+<dt id="src.utilsSat.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/utilsSat.html#Path.symlink"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.utilsSat.Path.symlink" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
</dd></dl>
<dl class="function">
-<dt id="src.pyconf.deepCopyMapping">
-<code class="descclassname">src.pyconf.</code><code class="descname">deepCopyMapping</code><span class="sig-paren">(</span><em>inMapping</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#deepCopyMapping"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.deepCopyMapping" title="Permalink to this definition">¶</a></dt>
+<dt id="src.utilsSat.black">
+<code class="descclassname">src.utilsSat.</code><code class="descname">black</code><span class="sig-paren">(</span><em>msg</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/utilsSat.html#black"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.utilsSat.black" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
-<dt id="src.pyconf.defaultMergeResolve">
-<code class="descclassname">src.pyconf.</code><code class="descname">defaultMergeResolve</code><span class="sig-paren">(</span><em>map1</em>, <em>map2</em>, <em>key</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#defaultMergeResolve"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.defaultMergeResolve" title="Permalink to this definition">¶</a></dt>
-<dd><p>A default resolver for merge conflicts.
-Returns a string indicating what action to take to resolve the conflict.</p>
-<p>@param map1: The map being merged into.
-@type map1: L{Mapping}.
-@param map2: The map being used as the merge operand.
-@type map2: L{Mapping}.
-@param key: The key in map2 (which also exists in map1).
-@type key: str</p>
-<dl class="docutils">
-<dt>@return: One of “merge”, “append”, “mismatch” or “overwrite”</dt>
-<dd>indicating what action should be taken. This should
-be appropriate to the objects being merged - e.g.
-there is no point returning “merge” if the two objects
-are instances of L{Sequence}.</dd>
-</dl>
-<p>@rtype: str</p>
+<dt id="src.utilsSat.blue">
+<code class="descclassname">src.utilsSat.</code><code class="descname">blue</code><span class="sig-paren">(</span><em>msg</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/utilsSat.html#blue"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.utilsSat.blue" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="function">
+<dt id="src.utilsSat.check_config_has_application">
+<code class="descclassname">src.utilsSat.</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/utilsSat.html#check_config_has_application"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.utilsSat.check_config_has_application" title="Permalink to this definition">¶</a></dt>
+<dd><p>check that the config has the key APPLICATION. Else raise an exception.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>class 'common.pyconf.Config'</strong> (<em>config</em>) -- The config.</td>
+</tr>
+</tbody>
+</table>
</dd></dl>
<dl class="function">
-<dt id="src.pyconf.defaultStreamOpener">
-<code class="descclassname">src.pyconf.</code><code class="descname">defaultStreamOpener</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#defaultStreamOpener"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.defaultStreamOpener" title="Permalink to this definition">¶</a></dt>
-<dd><p>This function returns a read-only stream, given its name. The name passed
-in should correspond to an existing stream, otherwise an exception will be
-raised.</p>
-<p>This is the default value of L{streamOpener}; assign your own callable to
-streamOpener to return streams based on names. For example, you could use
-urllib2.urlopen().</p>
-<p>@param name: The name of a stream, most commonly a file name.
-@type name: str
-@return: A stream with the specified name.
-@rtype: A read-only stream (file-like object)</p>
+<dt id="src.utilsSat.check_config_has_profile">
+<code class="descclassname">src.utilsSat.</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/utilsSat.html#check_config_has_profile"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.utilsSat.check_config_has_profile" title="Permalink to this definition">¶</a></dt>
+<dd><dl class="docutils">
+<dt>check that the config has the key APPLICATION.profile.</dt>
+<dd>Else, raise an exception.</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>class 'common.pyconf.Config'</strong> (<em>config</em>) -- The config.</td>
+</tr>
+</tbody>
+</table>
</dd></dl>
<dl class="function">
-<dt id="src.pyconf.isWord">
-<code class="descclassname">src.pyconf.</code><code class="descname">isWord</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#isWord"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.isWord" title="Permalink to this definition">¶</a></dt>
-<dd><p>See if a passed-in value is an identifier. If the value passed in is not a
-string, False is returned. An identifier consists of alphanumerics or
-underscore characters.</p>
-<p>Examples:</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">isWord</span><span class="p">(</span><span class="s1">'a word'</span><span class="p">)</span> <span class="o">-></span><span class="kc">False</span>
-<span class="n">isWord</span><span class="p">(</span><span class="s1">'award'</span><span class="p">)</span> <span class="o">-></span> <span class="kc">True</span>
-<span class="n">isWord</span><span class="p">(</span><span class="mi">9</span><span class="p">)</span> <span class="o">-></span> <span class="kc">False</span>
-<span class="n">isWord</span><span class="p">(</span><span class="s1">'a_b_c_'</span><span class="p">)</span> <span class="o">-></span><span class="kc">True</span>
-</pre></div>
-</div>
-<p>@note: isWord(‘9abc’) will return True - not exactly correct, but adequate
-for the way it’s used here.</p>
-<p>@param s: The name to be tested
-@type s: any
-@return: True if a word, else False
-@rtype: bool</p>
+<dt id="src.utilsSat.config_has_application">
+<code class="descclassname">src.utilsSat.</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/utilsSat.html#config_has_application"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.utilsSat.config_has_application" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="function">
+<dt id="src.utilsSat.critical">
+<code class="descclassname">src.utilsSat.</code><code class="descname">critical</code><span class="sig-paren">(</span><em>msg</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/utilsSat.html#critical"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.utilsSat.critical" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="function">
+<dt id="src.utilsSat.cyan">
+<code class="descclassname">src.utilsSat.</code><code class="descname">cyan</code><span class="sig-paren">(</span><em>msg</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/utilsSat.html#cyan"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.utilsSat.cyan" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="function">
+<dt id="src.utilsSat.date_to_datetime">
+<code class="descclassname">src.utilsSat.</code><code class="descname">date_to_datetime</code><span class="sig-paren">(</span><em>date</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/utilsSat.html#date_to_datetime"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.utilsSat.date_to_datetime" title="Permalink to this definition">¶</a></dt>
+<dd><p>From a string date in format YYYYMMDD_HHMMSS
+returns list year, mon, day, hour, minutes, seconds</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>date</em>) -- The date in format YYYYMMDD_HHMMSS</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">the same date and time in separate variables.</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">(str,str,str,str,str,str)</td>
+</tr>
+</tbody>
+</table>
</dd></dl>
<dl class="function">
-<dt id="src.pyconf.makePath">
-<code class="descclassname">src.pyconf.</code><code class="descname">makePath</code><span class="sig-paren">(</span><em>prefix</em>, <em>suffix</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#makePath"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.makePath" title="Permalink to this definition">¶</a></dt>
-<dd><p>Make a path from a prefix and suffix.</p>
-<p>Examples:
-makePath(‘’, ‘suffix’) -> ‘suffix’
-makePath(‘prefix’, ‘suffix’) -> ‘prefix.suffix’
-makePath(‘prefix’, ‘[1]’) -> ‘prefix[1]’</p>
-<p>@param prefix: The prefix to use. If it evaluates as false, the suffix is returned.
-@type prefix: str
-@param suffix: The suffix to use. It is either an identifier or an index in brackets.
-@type suffix: str
-@return: The path concatenation of prefix and suffix, with adot if the suffix is not a bracketed index.
-@rtype: str</p>
+<dt id="src.utilsSat.deepcopy_list">
+<code class="descclassname">src.utilsSat.</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/utilsSat.html#deepcopy_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.utilsSat.deepcopy_list" title="Permalink to this definition">¶</a></dt>
+<dd><p>Do a deep copy of a list</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>List</strong> (<em>input_list</em>) -- The list to copy</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The copy of the list</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">List</td>
+</tr>
+</tbody>
+</table>
</dd></dl>
<dl class="function">
-<dt id="src.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>
+<dt id="src.utilsSat.ensure_path_exists">
+<code class="descclassname">src.utilsSat.</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/utilsSat.html#ensure_path_exists"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.utilsSat.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.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>
+<dt id="src.utilsSat.error">
+<code class="descclassname">src.utilsSat.</code><code class="descname">error</code><span class="sig-paren">(</span><em>msg</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/utilsSat.html#error"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.utilsSat.error" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="function">
+<dt id="src.utilsSat.find_file_in_lpath">
+<code class="descclassname">src.utilsSat.</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/utilsSat.html#find_file_in_lpath"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.utilsSat.find_file_in_lpath" title="Permalink to this definition">¶</a></dt>
+<dd><dl class="docutils">
+<dt>Find in all the directories in lpath list the file that has the same name</dt>
+<dd>as file_name. If it is found, 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.</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 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>
+<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">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 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">boolean</p>
+<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>
</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>
+<dt id="src.utilsSat.formatTuples">
+<code class="descclassname">src.utilsSat.</code><code class="descname">formatTuples</code><span class="sig-paren">(</span><em>tuples</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/utilsSat.html#formatTuples"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.utilsSat.formatTuples" title="Permalink to this definition">¶</a></dt>
+<dd><p>format 'label = value' the tuples in a tabulated 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>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"><strong>list</strong> (<em>tuples</em>) -- The list of tuples to format</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The tabulated text. (mutiples lines)</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.utilsSat.formatValue">
+<code class="descclassname">src.utilsSat.</code><code class="descname">formatValue</code><span class="sig-paren">(</span><em>label</em>, <em>value</em>, <em>suffix=''</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/utilsSat.html#formatValue"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.utilsSat.formatValue" title="Permalink to this definition">¶</a></dt>
+<dd><p>format 'label = value' with the info color</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>int</strong> (<a class="reference internal" href="#src.utilsSat.label" title="src.utilsSat.label"><em>label</em></a>) -- the label to print.</li>
+<li><strong>str</strong> (<em>suffix</em>) -- the value to print.</li>
+<li><strong>str</strong> -- the optionnal suffix to add at the end.</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>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.utilsSat.get_base_path">
+<code class="descclassname">src.utilsSat.</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/utilsSat.html#get_base_path"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.utilsSat.get_base_path" title="Permalink to this definition">¶</a></dt>
+<dd><p>Returns the path of the products base.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>config</em>) -- The global Config instance.</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The path of the products base.</td>
</tr>
-<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">boolean</p>
-</td>
+<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.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.utilsSat.get_cfg_param">
+<code class="descclassname">src.utilsSat.</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/utilsSat.html#get_cfg_param"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.utilsSat.get_cfg_param" title="Permalink to this definition">¶</a></dt>
+<dd><dl class="docutils">
+<dt>Search for param_name value in config.</dt>
+<dd>If param_name is not in config, then return default,
+else, return the found value</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 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>
+<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">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">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">boolean</p>
+<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>
</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.utilsSat.get_launcher_name">
+<code class="descclassname">src.utilsSat.</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/utilsSat.html#get_launcher_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.utilsSat.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"><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 class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>config</em>) -- The global Config instance.</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The name of salome launcher.</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
-<dt id="src.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.utilsSat.get_log_path">
+<code class="descclassname">src.utilsSat.</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/utilsSat.html#get_log_path"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.utilsSat.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 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 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"><p class="first">True if the extraction is successful</p>
-</td>
+<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"><p class="first last">boolean</p>
-</td>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>
</tr>
</tbody>
</table>
</dd></dl>
-</div>
-<div class="section" id="module-src.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>
+<dl class="function">
+<dt id="src.utilsSat.get_property_in_product_cfg">
+<code class="descclassname">src.utilsSat.</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/utilsSat.html#get_property_in_product_cfg"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.utilsSat.get_property_in_product_cfg" 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>
+<dl class="function">
+<dt id="src.utilsSat.get_salome_version">
+<code class="descclassname">src.utilsSat.</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/utilsSat.html#get_salome_version"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.utilsSat.get_salome_version" 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>
+<dt id="src.utilsSat.get_tmp_filename">
+<code class="descclassname">src.utilsSat.</code><code class="descname">get_tmp_filename</code><span class="sig-paren">(</span><em>config</em>, <em>name</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/utilsSat.html#get_tmp_filename"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.utilsSat.get_tmp_filename" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
-</div>
-<div class="section" id="module-src.test_module">
-<span id="test-module-module"></span><h2><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>
-<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>
+<dl class="function">
+<dt id="src.utilsSat.green">
+<code class="descclassname">src.utilsSat.</code><code class="descname">green</code><span class="sig-paren">(</span><em>msg</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/utilsSat.html#green"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.utilsSat.green" 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>
+<dl class="function">
+<dt id="src.utilsSat.handleRemoveReadonly">
+<code class="descclassname">src.utilsSat.</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/utilsSat.html#handleRemoveReadonly"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.utilsSat.handleRemoveReadonly" 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>
+<dl class="function">
+<dt id="src.utilsSat.header">
+<code class="descclassname">src.utilsSat.</code><code class="descname">header</code><span class="sig-paren">(</span><em>msg</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/utilsSat.html#header"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.utilsSat.header" 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>
+<dl class="function">
+<dt id="src.utilsSat.info">
+<code class="descclassname">src.utilsSat.</code><code class="descname">info</code><span class="sig-paren">(</span><em>msg</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/utilsSat.html#info"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.utilsSat.info" 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>
+<dl class="function">
+<dt id="src.utilsSat.label">
+<code class="descclassname">src.utilsSat.</code><code class="descname">label</code><span class="sig-paren">(</span><em>msg</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/utilsSat.html#label"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.utilsSat.label" 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="function">
+<dt id="src.utilsSat.list_log_file">
+<code class="descclassname">src.utilsSat.</code><code class="descname">list_log_file</code><span class="sig-paren">(</span><em>dirPath</em>, <em>expression</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/utilsSat.html#list_log_file"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.utilsSat.list_log_file" title="Permalink to this definition">¶</a></dt>
+<dd><p>Find all files corresponding to expression in dirPath</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>str</strong> (<em>expression</em>) -- the directory where to search the files</li>
+<li><strong>str</strong> -- the regular expression of files to find</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">the list of files path and informations about it</p>
+</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="#src.utilsSat.Path.list" title="src.utilsSat.Path.list">list</a></p>
+</td>
+</tr>
+</tbody>
+</table>
+</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="function">
+<dt id="src.utilsSat.logger_info_tuples">
+<code class="descclassname">src.utilsSat.</code><code class="descname">logger_info_tuples</code><span class="sig-paren">(</span><em>logger</em>, <em>tuples</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/utilsSat.html#logger_info_tuples"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.utilsSat.logger_info_tuples" title="Permalink to this definition">¶</a></dt>
+<dd><p>for convenience
+format as formatTuples() and call logger.info()</p>
+</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>
+<dl class="function">
+<dt id="src.utilsSat.magenta">
+<code class="descclassname">src.utilsSat.</code><code class="descname">magenta</code><span class="sig-paren">(</span><em>msg</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/utilsSat.html#magenta"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.utilsSat.magenta" 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="function">
+<dt id="src.utilsSat.merge_dicts">
+<code class="descclassname">src.utilsSat.</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/utilsSat.html#merge_dicts"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.utilsSat.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="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>
+<dl class="function">
+<dt id="src.utilsSat.normal">
+<code class="descclassname">src.utilsSat.</code><code class="descname">normal</code><span class="sig-paren">(</span><em>msg</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/utilsSat.html#normal"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.utilsSat.normal" 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>
+<dl class="function">
+<dt id="src.utilsSat.only_numbers">
+<code class="descclassname">src.utilsSat.</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/utilsSat.html#only_numbers"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.utilsSat.only_numbers" 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="function">
+<dt id="src.utilsSat.parse_date">
+<code class="descclassname">src.utilsSat.</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/utilsSat.html#parse_date"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.utilsSat.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="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>
+<dl class="function">
+<dt id="src.utilsSat.read_config_from_a_file">
+<code class="descclassname">src.utilsSat.</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/utilsSat.html#read_config_from_a_file"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.utilsSat.read_config_from_a_file" 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>
+<dl class="function">
+<dt id="src.utilsSat.red">
+<code class="descclassname">src.utilsSat.</code><code class="descname">red</code><span class="sig-paren">(</span><em>msg</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/utilsSat.html#red"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.utilsSat.red" 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="function">
+<dt id="src.utilsSat.remove_item_from_list">
+<code class="descclassname">src.utilsSat.</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/utilsSat.html#remove_item_from_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.utilsSat.remove_item_from_list" title="Permalink to this definition">¶</a></dt>
+<dd><p>Remove all occurences of item from input_list</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>List</strong> (<em>input_list</em>) -- The list to modify</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The without any item</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">List</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
-<dl class="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>
+<dl class="function">
+<dt id="src.utilsSat.replace_in_file">
+<code class="descclassname">src.utilsSat.</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/utilsSat.html#replace_in_file"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.utilsSat.replace_in_file" title="Permalink to this definition">¶</a></dt>
+<dd><p>Replace <strin> by <strout> in file <filein></p>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.utilsSat.reset">
+<code class="descclassname">src.utilsSat.</code><code class="descname">reset</code><span class="sig-paren">(</span><em>msg</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/utilsSat.html#reset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.utilsSat.reset" 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>
+<dl class="function">
+<dt id="src.utilsSat.show_command_log">
+<code class="descclassname">src.utilsSat.</code><code class="descname">show_command_log</code><span class="sig-paren">(</span><em>logFilePath</em>, <em>cmd</em>, <em>application</em>, <em>notShownCommands</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/utilsSat.html#show_command_log"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.utilsSat.show_command_log" title="Permalink to this definition">¶</a></dt>
+<dd><p>Used in updateHatXml.
+Determine if the log xml file logFilePath
+has to be shown or not in the hat log.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>str</strong> (<em>application</em>) -- the path to the command xml log file</li>
+<li><strong>str</strong> -- the command of the log file</li>
+<li><strong>str</strong> -- the application passed as parameter
+to the salomeTools command</li>
+<li><strong>list</strong> (<em>notShownCommands</em>) -- the list of commands
+that are not shown by default</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">RCO.ReturnCode("OK") if cmd is not in notShownCommands and the application
+in the log file corresponds to application
+ReturnCode value is tuple (appliLog, launched_cmd)</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.utilsSat.success">
+<code class="descclassname">src.utilsSat.</code><code class="descname">success</code><span class="sig-paren">(</span><em>msg</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/utilsSat.html#success"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.utilsSat.success" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
+<dl class="function">
+<dt id="src.utilsSat.timedelta_total_seconds">
+<code class="descclassname">src.utilsSat.</code><code class="descname">timedelta_total_seconds</code><span class="sig-paren">(</span><em>timedelta</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/utilsSat.html#timedelta_total_seconds"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.utilsSat.timedelta_total_seconds" title="Permalink to this definition">¶</a></dt>
+<dd><p>Replace total_seconds from datetime module
+in order to be compatible with old python versions</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>datetime.timedelta</strong> (<em>timedelta</em>) -- The delta between two dates</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The number of seconds corresponding to timedelta.</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">float</td>
+</tr>
+</tbody>
+</table>
</dd></dl>
<dl class="function">
-<dt id="src.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>
+<dt id="src.utilsSat.update_hat_xml">
+<code class="descclassname">src.utilsSat.</code><code class="descname">update_hat_xml</code><span class="sig-paren">(</span><em>logDir</em>, <em>application=None</em>, <em>notShownCommands=[]</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/utilsSat.html#update_hat_xml"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.utilsSat.update_hat_xml" title="Permalink to this definition">¶</a></dt>
+<dd><p>Create the xml file in logDir that contain all the xml file
+and have a name like YYYYMMDD_HHMMSS_namecmd.xml</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>str</strong> (<em>application</em>) -- the directory to parse</li>
+<li><strong>str</strong> -- the name of the application if there is any</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="src.utilsSat.warning">
+<code class="descclassname">src.utilsSat.</code><code class="descname">warning</code><span class="sig-paren">(</span><em>msg</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/utilsSat.html#warning"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.utilsSat.warning" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="function">
+<dt id="src.utilsSat.white">
+<code class="descclassname">src.utilsSat.</code><code class="descname">white</code><span class="sig-paren">(</span><em>msg</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/utilsSat.html#white"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.utilsSat.white" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="function">
+<dt id="src.utilsSat.yellow">
+<code class="descclassname">src.utilsSat.</code><code class="descname">yellow</code><span class="sig-paren">(</span><em>msg</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/utilsSat.html#yellow"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.utilsSat.yellow" 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>
+<span id="src-xmlmanager-module"></span><h2>src.xmlManager module<a class="headerlink" href="#module-src.xmlManager" title="Permalink to this headline">¶</a></h2>
+<p>Utilities to read xml logging files</p>
+<dl class="docutils">
+<dt>usage:</dt>
+<dd>>> import src.xmlManager as XMLMGR</dd>
+</dl>
<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>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><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">
<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 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>
<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>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>
<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>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><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">
<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
+<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>
<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>
+<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>
<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>
+<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>
<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>str</strong> (<em>stylesheet</em>) -- The stylesheet to apply to the xml file</td>
</tr>
</tbody>
</table>
<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
+<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>
<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
+<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>
+<li><strong>dixt</strong> (<em>attrib</em>) -- The attrib to append</li>
</ul>
</td>
</tr>
<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>
+<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>
<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>
+<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>
</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>
+<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>
</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.catchAll">src.catchAll module</a></li>
+<li><a class="reference internal" href="#module-src.coloringSat">src.coloringSat 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.configManager">src.configManager 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.environs">src.environs module</a></li>
+<li><a class="reference internal" href="#module-src.exceptionSat">src.exceptionSat 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.loggingSat">src.loggingSat 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.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.returnCode">src.returnCode module</a></li>
+<li><a class="reference internal" href="#module-src.salomeTools">src.salomeTools 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.utilsSat">src.utilsSat 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>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
- <li><a href="../../_sources/commands/apidoc/src.rst.txt"
+ <li><a href="../../_sources/commands/apidoc/src.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" />
+ <div><input type="text" name="q" /></div>
+ <div><input type="submit" value="Go" /></div>
<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>
©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>
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.9</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
|
- <a href="../../_sources/commands/apidoc/src.rst.txt"
+ <a href="../../_sources/commands/apidoc/src.txt"
rel="nofollow">Page source</a>
</div>
-
<!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 application — salomeTools 5.0.0dev documentation</title>
+
<link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
- <script type="text/javascript" src="../_static/documentation_options.js"></script>
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
- <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/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="top" title="salomeTools 5.0.0dev documentation" href="../index.html" />
<link rel="next" title="Command log" href="log.html" />
<link rel="prev" title="Command launcher" href="launcher.html" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
- </head><body>
+ </head>
+ <body role="document">
<div class="document">
<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
<ul>
<li><p class="first">Create an application:</p>
-<div class="highlight-default
notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">application</span> <span class="o"><</span><span class="n">application</span><span class="o">></span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">application</span> <span class="o"><</span><span class="n">application</span><span class="o">></span>
</pre></div>
</div>
-<p>Create the virtual application directory in the salomeTool application directory <code class="docutils literal notranslate"><span class="pre">$APPLICATION.workdir</span></code>.</p>
+<p>Create the virtual application directory in the salomeTool application directory <code class="docutils literal"><span class="pre">$APPLICATION.workdir</span></code>.</p>
</li>
<li><p class="first">Give a name to the application:</p>
-<div class="highlight-default
notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">application</span> <span class="o"><</span><span class="n">application</span><span class="o">></span> <span class="o">--</span><span class="n">name</span> <span class="o"><</span><span class="n">my_application_name</span><span class="o">></span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">application</span> <span class="o"><</span><span class="n">application</span><span class="o">></span> <span class="o">--</span><span class="n">name</span> <span class="o"><</span><span class="n">my_application_name</span><span class="o">></span>
</pre></div>
</div>
-<p><em>Remark</em>: this option overrides the name given in the virtual_app section of the configuration file <code class="docutils literal notranslate"><span class="pre">$APPLICATION.virtual_app.name</span></code>.</p>
+<p><em>Remark</em>: this option overrides the name given in the virtual_app section of the configuration file <code class="docutils literal"><span class="pre">$APPLICATION.virtual_app.name</span></code>.</p>
</li>
<li><p class="first">Change the directory where the application is created:</p>
-<div class="highlight-default
notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">application</span> <span class="o"><</span><span class="n">application</span><span class="o">></span> <span class="o">--</span><span class="n">target</span> <span class="o"><</span><span class="n">my_application_directory</span><span class="o">></span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">application</span> <span class="o"><</span><span class="n">application</span><span class="o">></span> <span class="o">--</span><span class="n">target</span> <span class="o"><</span><span class="n">my_application_directory</span><span class="o">></span>
</pre></div>
</div>
</li>
<li><p class="first">Set a specific <a class="reference external" href="http://www.salome-platform.org">SALOME</a> resources catalog (it will be used for the distribution of components on distant machines):</p>
-<div class="highlight-default
notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">application</span> <span class="o"><</span><span class="n">application</span><span class="o">></span> <span class="o">--</span><span class="n">catalog</span> <span class="o"><</span><span class="n">path_to_catalog</span><span class="o">></span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">application</span> <span class="o"><</span><span class="n">application</span><span class="o">></span> <span class="o">--</span><span class="n">catalog</span> <span class="o"><</span><span class="n">path_to_catalog</span><span class="o">></span>
</pre></div>
</div>
<p>Note that the catalog specified will be copied to the application directory.</p>
</li>
<li><p class="first">Generate the catalog for a list of machines:</p>
-<div class="highlight-default
notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">application</span> <span class="o"><</span><span class="n">application</span><span class="o">></span> <span class="o">--</span><span class="n">gencat</span> <span class="n">machine1</span><span class="p">,</span><span class="n">machine2</span><span class="p">,</span><span class="n">machine3</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">application</span> <span class="o"><</span><span class="n">application</span><span class="o">></span> <span class="o">--</span><span class="n">gencat</span> <span class="n">machine1</span><span class="p">,</span><span class="n">machine2</span><span class="p">,</span><span class="n">machine3</span>
</pre></div>
</div>
<p>This will create a catalog by querying each machine through ssh protocol (memory, number of processor) with ssh.</p>
</li>
<li><p class="first">Generate a mesa application (if mesa and llvm are parts of the application). Use this option only if you have to use salome through ssh and have problems with ssh X forwarding of OpengGL modules (like Paravis):</p>
-<div class="highlight-default
notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">launcher</span> <span class="o"><</span><span class="n">application</span><span class="o">></span> <span class="o">--</span><span class="n">use_mesa</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">launcher</span> <span class="o"><</span><span class="n">application</span><span class="o">></span> <span class="o">--</span><span class="n">use_mesa</span>
</pre></div>
</div>
</li>
<ul class="simple">
<li><strong>APPLICATION.virtual_app</strong><ul>
<li><strong>name</strong> : name of the launcher (to replace the default runAppli).</li>
-<li><strong>application_name</strong> : (optional) the name of the virtual application directory, if missing the default value is <code class="docutils literal notranslate"><span class="pre">$name</span> <span class="pre">+</span> <span class="pre">_appli</span></code>.</li>
+<li><strong>application_name</strong> : (optional) the name of the virtual application directory, if missing the default value is <code class="docutils literal"><span class="pre">$name</span> <span class="pre">+</span> <span class="pre">_appli</span></code>.</li>
</ul>
</li>
</ul>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
- <li><a href="../_sources/commands/application.rst.txt"
+ <li><a href="../_sources/commands/application.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" />
+ <div><input type="text" name="q" /></div>
+ <div><input type="submit" value="Go" /></div>
<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>
©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>
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.9</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
|
- <a href="../_sources/commands/application.rst.txt"
+ <a href="../_sources/commands/application.txt"
rel="nofollow">Page source</a>
</div>
-
<!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 clean — salomeTools 5.0.0dev documentation</title>
+
<link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
- <script type="text/javascript" src="../_static/documentation_options.js"></script>
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
- <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/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="top" title="salomeTools 5.0.0dev documentation" href="../index.html" />
<link rel="next" title="Command package" href="package.html" />
<link rel="prev" title="Command environ" href="environ.html" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
- </head><body>
+ </head>
+ <body role="document">
<div class="document">
<h1>Command clean<a class="headerlink" href="#command-clean" title="Permalink to this headline">¶</a></h1>
<div class="section" id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
-<p>The <strong>clean</strong> command removes products in the <em>source, build, or install</em> directories of an application. Theses directories are usually named <code class="docutils literal notranslate"><span class="pre">SOURCES,</span> <span class="pre">BUILD,</span> <span class="pre">INSTALL</span></code>.</p>
+<p>The <strong>clean</strong> command removes products in the <em>source, build, or install</em> directories of an application. Theses directories are usually named <code class="docutils literal"><span class="pre">SOURCES,</span> <span class="pre">BUILD,</span> <span class="pre">INSTALL</span></code>.</p>
<p>Use the options to define what directories you want to suppress and to set the list of products</p>
</div>
<div class="section" id="usage">
<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
<ul>
<li><p class="first">Clean all previously created <em>build</em> and <em>install</em> directories (example application as <em>SALOME_xx</em>):</p>
-<div class="highlight-bash
notranslate"><div class="highlight"><pre><span></span><span class="c1"># take care, is long time to restore, sometimes</span>
+<div class="highlight-bash"><div class="highlight"><pre><span></span><span class="c1"># take care, is long time to restore, sometimes</span>
sat clean SALOME-xx --build --install
</pre></div>
</div>
</li>
<li><p class="first">Clean previously created <em>build</em> and <em>install</em> directories, only for products with property <em>is_salome_module</em>:</p>
-<div class="highlight-bash
notranslate"><div class="highlight"><pre><span></span>sat clean SALOME-xxx --build --install <span class="se">\</span>
+<div class="highlight-bash"><div class="highlight"><pre><span></span>sat clean SALOME-xxx --build --install <span class="se">\</span>
--properties is_salome_module:yes
</pre></div>
</div>
<h2>Availables options<a class="headerlink" href="#availables-options" title="Permalink to this headline">¶</a></h2>
<blockquote>
<div><ul>
-<li><p class="first"><strong>–products</strong> : Products to clean.</p>
+<li><p class="first"><strong>--products</strong> : Products to clean.</p>
</li>
-<li><p class="first"><strong>–properties</strong> :</p>
+<li><p class="first"><strong>--properties</strong> :</p>
<div class="line-block">
<div class="line">Filter the products by their properties.</div>
-<div class="line">Syntax: <em>–properties <property>:<value></em></div>
+<div class="line">Syntax: <em>--properties <property>:<value></em></div>
</div>
</li>
-<li><p class="first"><strong>–sources</strong> : Clean the product source directories.</p>
+<li><p class="first"><strong>--sources</strong> : Clean the product source directories.</p>
</li>
-<li><p class="first"><strong>–build</strong> : Clean the product build directories.</p>
+<li><p class="first"><strong>--build</strong> : Clean the product build directories.</p>
</li>
-<li><p class="first"><strong>–install</strong> : Clean the product install directories.</p>
+<li><p class="first"><strong>--install</strong> : Clean the product install directories.</p>
</li>
-<li><p class="first"><strong>–all</strong> : Clean the product source, build and install directories.</p>
+<li><p class="first"><strong>--all</strong> : Clean the product source, build and install directories.</p>
</li>
-<li><p class="first"><strong>–sources_without_dev</strong> :</p>
+<li><p class="first"><strong>--sources_without_dev</strong> :</p>
<div class="line-block">
<div class="line">Do not clean the products in development mode,</div>
<div class="line">(they could have <a class="reference external" href="https://en.wikipedia.org/wiki/Version_control">VCS</a> commits pending).</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
- <li><a href="../_sources/commands/clean.rst.txt"
+ <li><a href="../_sources/commands/clean.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" />
+ <div><input type="text" name="q" /></div>
+ <div><input type="submit" value="Go" /></div>
<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>
©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>
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.9</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
|
- <a href="../_sources/commands/clean.rst.txt"
+ <a href="../_sources/commands/clean.txt"
rel="nofollow">Page source</a>
</div>
-
<!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 compile — salomeTools 5.0.0dev documentation</title>
+
<link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
- <script type="text/javascript" src="../_static/documentation_options.js"></script>
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
- <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/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="top" title="salomeTools 5.0.0dev documentation" href="../index.html" />
<link rel="next" title="Command launcher" href="launcher.html" />
<link rel="prev" title="Command prepare" href="prepare.html" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
- </head><body>
+ </head>
+ <body role="document">
<div class="document">
<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
<ul>
<li><p class="first">Compile a complete application:</p>
-<div class="highlight-default
notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="nb">compile</span> <span class="o"><</span><span class="n">application</span><span class="o">></span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="nb">compile</span> <span class="o"><</span><span class="n">application</span><span class="o">></span>
</pre></div>
</div>
</li>
<li><p class="first">Compile only some products:</p>
-<div class="highlight-default
notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="nb">compile</span> <span class="o"><</span><span class="n">application</span><span class="o">></span> <span class="o">--</span><span class="n">products</span> <span class="o"><</span><span class="n">product1</span><span class="o">></span><span class="p">,</span><span class="o"><</span><span class="n">product2</span><span class="o">></span> <span class="o">...</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="nb">compile</span> <span class="o"><</span><span class="n">application</span><span class="o">></span> <span class="o">--</span><span class="n">products</span> <span class="o"><</span><span class="n">product1</span><span class="o">></span><span class="p">,</span><span class="o"><</span><span class="n">product2</span><span class="o">></span> <span class="o">...</span>
</pre></div>
</div>
</li>
<li><p class="first">Use <em>sat -t</em> to duplicate the logs in the terminal (by default the log are stored and displayed with <em>sat log</em> command):</p>
-<div class="highlight-default
notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="o">-</span><span class="n">t</span> <span class="nb">compile</span> <span class="o"><</span><span class="n">application</span><span class="o">></span> <span class="o">--</span><span class="n">products</span> <span class="o"><</span><span class="n">product1</span><span class="o">></span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="o">-</span><span class="n">t</span> <span class="nb">compile</span> <span class="o"><</span><span class="n">application</span><span class="o">></span> <span class="o">--</span><span class="n">products</span> <span class="o"><</span><span class="n">product1</span><span class="o">></span>
</pre></div>
</div>
</li>
<li><p class="first">Compile a module and its dependencies:</p>
-<div class="highlight-default
notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="nb">compile</span> <span class="o"><</span><span class="n">application</span><span class="o">></span> <span class="o">--</span><span class="n">products</span> <span class="n">med</span> <span class="o">--</span><span class="n">with_fathers</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="nb">compile</span> <span class="o"><</span><span class="n">application</span><span class="o">></span> <span class="o">--</span><span class="n">products</span> <span class="n">med</span> <span class="o">--</span><span class="n">with_fathers</span>
</pre></div>
</div>
</li>
<li><p class="first">Compile a module and the modules depending on it (for example plugins):</p>
-<div class="highlight-default
notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="nb">compile</span> <span class="o"><</span><span class="n">application</span><span class="o">></span> <span class="o">--</span><span class="n">products</span> <span class="n">med</span> <span class="o">--</span><span class="n">with_children</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="nb">compile</span> <span class="o"><</span><span class="n">application</span><span class="o">></span> <span class="o">--</span><span class="n">products</span> <span class="n">med</span> <span class="o">--</span><span class="n">with_children</span>
</pre></div>
</div>
</li>
<li><p class="first">Clean the build and install directories before starting compilation:</p>
-<div class="highlight-default
notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="nb">compile</span> <span class="o"><</span><span class="n">application</span><span class="o">></span> <span class="o">--</span><span class="n">products</span> <span class="n">GEOM</span> <span class="o">--</span><span class="n">clean_all</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="nb">compile</span> <span class="o"><</span><span class="n">application</span><span class="o">></span> <span class="o">--</span><span class="n">products</span> <span class="n">GEOM</span> <span class="o">--</span><span class="n">clean_all</span>
</pre></div>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<div class="last line-block">
-<div class="line">a warning will be shown if option <em>–products</em> is missing</div>
+<div class="line">a warning will be shown if option <em>--products</em> is missing</div>
<div class="line">(as it will clean everything)</div>
</div>
</div>
</li>
<li><p class="first">Clean only the install directories before starting compilation:</p>
-<div class="highlight-default
notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="nb">compile</span> <span class="o"><</span><span class="n">application</span><span class="o">></span> <span class="o">--</span><span class="n">clean_install</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="nb">compile</span> <span class="o"><</span><span class="n">application</span><span class="o">></span> <span class="o">--</span><span class="n">clean_install</span>
</pre></div>
</div>
</li>
<li><p class="first">Add options for make:</p>
-<div class="highlight-default
notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="nb">compile</span> <span class="o"><</span><span class="n">application</span><span class="o">></span> <span class="o">--</span><span class="n">products</span> <span class="o"><</span><span class="n">product</span><span class="o">></span> <span class="o">--</span><span class="n">make_flags</span> <span class="o"><</span><span class="n">flags</span><span class="o">></span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="nb">compile</span> <span class="o"><</span><span class="n">application</span><span class="o">></span> <span class="o">--</span><span class="n">products</span> <span class="o"><</span><span class="n">product</span><span class="o">></span> <span class="o">--</span><span class="n">make_flags</span> <span class="o"><</span><span class="n">flags</span><span class="o">></span>
</pre></div>
</div>
</li>
-<li><p class="first">Use the <em>–check</em> option to execute the unit tests after compilation:</p>
-<div class="highlight-default
notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="nb">compile</span> <span class="o"><</span><span class="n">application</span><span class="o">></span> <span class="o">--</span><span class="n">check</span>
+<li><p class="first">Use the <em>--check</em> option to execute the unit tests after compilation:</p>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="nb">compile</span> <span class="o"><</span><span class="n">application</span><span class="o">></span> <span class="o">--</span><span class="n">check</span>
</pre></div>
</div>
</li>
<li><p class="first">Remove the build directory after successful compilation (some build directory like qt are big):</p>
-<div class="highlight-default
notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="nb">compile</span> <span class="o"><</span><span class="n">application</span><span class="o">></span> <span class="o">--</span><span class="n">products</span> <span class="n">qt</span> <span class="o">--</span><span class="n">clean_build_after</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="nb">compile</span> <span class="o"><</span><span class="n">application</span><span class="o">></span> <span class="o">--</span><span class="n">products</span> <span class="n">qt</span> <span class="o">--</span><span class="n">clean_build_after</span>
</pre></div>
</div>
</li>
<li><p class="first">Stop the compilation as soon as the compilation of a module fails:</p>
-<div class="highlight-default
notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="nb">compile</span> <span class="o"><</span><span class="n">product</span><span class="o">></span> <span class="o">--</span><span class="n">stop_first_fail</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="nb">compile</span> <span class="o"><</span><span class="n">product</span><span class="o">></span> <span class="o">--</span><span class="n">stop_first_fail</span>
</pre></div>
</div>
</li>
<li><p class="first">Do not compile, just show if products are installed or not, and where is the installation:</p>
-<div class="highlight-default
notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="nb">compile</span> <span class="o"><</span><span class="n">application</span><span class="o">></span> <span class="o">--</span><span class="n">show</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="nb">compile</span> <span class="o"><</span><span class="n">application</span><span class="o">></span> <span class="o">--</span><span class="n">show</span>
</pre></div>
</div>
</li>
<blockquote>
<div><ul class="simple">
<li><strong>build_source</strong> : the method used to build the product (cmake/autotools/script)</li>
-<li><strong>compil_script</strong> : the compilation script if build_source is equal to “script”</li>
+<li><strong>compil_script</strong> : the compilation script if build_source is equal to "script"</li>
<li><strong>cmake_options</strong> : additional options for cmake.</li>
<li><strong>nb_proc</strong> : number of jobs to use with make for this product.</li>
</ul>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
- <li><a href="../_sources/commands/compile.rst.txt"
+ <li><a href="../_sources/commands/compile.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" />
+ <div><input type="text" name="q" /></div>
+ <div><input type="submit" value="Go" /></div>
<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>
©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>
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.9</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
|
- <a href="../_sources/commands/compile.rst.txt"
+ <a href="../_sources/commands/compile.txt"
rel="nofollow">Page source</a>
</div>
-
<!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 config — salomeTools 5.0.0dev documentation</title>
+
<link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
- <script type="text/javascript" src="../_static/documentation_options.js"></script>
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
- <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/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="top" title="salomeTools 5.0.0dev documentation" href="../index.html" />
<link rel="next" title="Command prepare" href="prepare.html" />
<link rel="prev" title="Usage of SAlomeTools" href="../usage_of_sat.html" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
- </head><body>
+ </head>
+ <body role="document">
<div class="document">
<div class="section" id="usage">
<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
<ul>
-<li><p class="first">Edit the user personal configuration file <code class="docutils literal notranslate"><span class="pre">$HOME/.salomeTools/SAT.pyconf</span></code>. It is used to store the user personal choices, like the favorite editor, browser, pdf viewer:</p>
-<div class="highlight-default
notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">config</span> <span class="o">--</span><span class="n">edit</span>
+<li><p class="first">Edit the user personal configuration file <code class="docutils literal"><span class="pre">$HOME/.salomeTools/SAT.pyconf</span></code>. It is used to store the user personal choices, like the favorite editor, browser, pdf viewer:</p>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">config</span> <span class="o">--</span><span class="n">edit</span>
</pre></div>
</div>
</li>
-<li><p class="first">List the available applications (they come from the sat projects defined in <code class="docutils literal notranslate"><span class="pre">data/local.pyconf</span></code>:</p>
-<div class="highlight-default
notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">config</span> <span class="o">--</span><span class="nb">list</span>
+<li><p class="first">List the available applications (they come from the sat projects defined in <code class="docutils literal"><span class="pre">data/local.pyconf</span></code>:</p>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">config</span> <span class="o">--</span><span class="nb">list</span>
</pre></div>
</div>
</li>
<li><p class="first">Edit the configuration of an application:</p>
-<div class="highlight-default
notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">config</span> <span class="o"><</span><span class="n">application</span><span class="o">></span> <span class="o">--</span><span class="n">edit</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">config</span> <span class="o"><</span><span class="n">application</span><span class="o">></span> <span class="o">--</span><span class="n">edit</span>
</pre></div>
</div>
</li>
<li><p class="first">Copy an application configuration file into the user personal directory:</p>
-<div class="highlight-default
notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">config</span> <span class="o"><</span><span class="n">application</span><span class="o">></span> <span class="o">--</span><span class="n">copy</span> <span class="p">[</span><span class="n">new_name</span><span class="p">]</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">config</span> <span class="o"><</span><span class="n">application</span><span class="o">></span> <span class="o">--</span><span class="n">copy</span> <span class="p">[</span><span class="n">new_name</span><span class="p">]</span>
</pre></div>
</div>
</li>
<li><div class="first line-block">
<div class="line">Print the value of a configuration parameter.</div>
<div class="line">Use the automatic completion to get recursively the parameter names.</div>
-<div class="line">Use <em>–no_label</em> option to get <em>only</em> the value, <em>without</em> label (useful in automatic scripts).</div>
+<div class="line">Use <em>--no_label</em> option to get <em>only</em> the value, <em>without</em> label (useful in automatic scripts).</div>
<div class="line">Examples (with <em>SALOME-xx</em> as <em>SALOME-8.4.0</em> ):</div>
</div>
-<div class="highlight-bash
notranslate"><div class="highlight"><pre><span></span><span class="c1"># sat config --value <parameter_path></span>
+<div class="highlight-bash"><div class="highlight"><pre><span></span><span class="c1"># sat config --value <parameter_path></span>
sat config --value . <span class="c1"># all the configuration</span>
sat config --value LOCAL
sat config --value LOCAL.workdir
<div class="line">This is a debug mode, useful for developers.</div>
<div class="line">Prints the parameter path, the source expression if any, and the final value:</div>
</div>
-<div class="highlight-default
notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">config</span> <span class="n">SALOME</span><span class="o">-</span><span class="n">xx</span> <span class="o">-</span><span class="n">g</span> <span class="n">USER</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">config</span> <span class="n">SALOME</span><span class="o">-</span><span class="n">xx</span> <span class="o">-</span><span class="n">g</span> <span class="n">USER</span>
</pre></div>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p>And so, <em>not only for fun</em>, to get <strong>all expressions</strong> of configuration</p>
-<div class="last highlight-bash
notranslate"><div class="highlight"><pre><span></span>sat config SALOME-xx -g . <span class="p">|</span> grep -e <span class="s2">"-->"</span>
+<div class="last highlight-bash"><div class="highlight"><pre><span></span>sat config SALOME-xx -g . <span class="p">|</span> grep -e <span class="s2">"-->"</span>
</pre></div>
</div>
</div>
</li>
<li><p class="first">Print the patches that are applied:</p>
-<div class="highlight-default
notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">config</span> <span class="n">SALOME</span><span class="o">-</span><span class="n">xx</span> <span class="o">--</span><span class="n">show_patchs</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">config</span> <span class="n">SALOME</span><span class="o">-</span><span class="n">xx</span> <span class="o">--</span><span class="n">show_patchs</span>
</pre></div>
</div>
</li>
<li><p class="first">Get information on a product configuration:</p>
</li>
</ul>
-<div class="highlight-bash
notranslate"><div class="highlight"><pre><span></span><span class="c1"># sat config <application> --info <product></span>
+<div class="highlight-bash"><div class="highlight"><pre><span></span><span class="c1"># sat config <application> --info <product></span>
sat config SALOME-xx --info KERNEL
sat config SALOME-xx --info qt
</pre></div>
<li><strong>USER</strong>: To get user preferences (editor, pdf viewer, web browser, default working dir).</li>
</ul>
<p>sat commands:</p>
-<div class="highlight-default
notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">config</span> <span class="n">SALOME</span><span class="o">-</span><span class="n">xx</span> <span class="o">-</span><span class="n">v</span> <span class="n">PATHS</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">config</span> <span class="n">SALOME</span><span class="o">-</span><span class="n">xx</span> <span class="o">-</span><span class="n">v</span> <span class="n">PATHS</span>
<span class="n">sat</span> <span class="n">config</span> <span class="n">SALOME</span><span class="o">-</span><span class="n">xx</span> <span class="o">-</span><span class="n">v</span> <span class="n">USERS</span>
</pre></div>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
- <li><a href="../_sources/commands/config.rst.txt"
+ <li><a href="../_sources/commands/config.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" />
+ <div><input type="text" name="q" /></div>
+ <div><input type="submit" value="Go" /></div>
<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>
©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>
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.9</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
|
- <a href="../_sources/commands/config.rst.txt"
+ <a href="../_sources/commands/config.txt"
rel="nofollow">Page source</a>
</div>
-
<!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 environ — salomeTools 5.0.0dev documentation</title>
+
<link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
- <script type="text/javascript" src="../_static/documentation_options.js"></script>
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
- <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/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="top" title="salomeTools 5.0.0dev documentation" href="../index.html" />
<link rel="next" title="Command clean" href="clean.html" />
<link rel="prev" title="Command log" href="log.html" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
- </head><body>
+ </head>
+ <body role="document">
<div class="document">
<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
<ul>
<li><p class="first">Create the shell environment files of the application:</p>
-<div class="highlight-default
notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">environ</span> <span class="o"><</span><span class="n">application</span><span class="o">></span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">environ</span> <span class="o"><</span><span class="n">application</span><span class="o">></span>
</pre></div>
</div>
</li>
<li><p class="first">Create the environment files of the application for a given shell.
Options are bash, bat (for windows) and cfg (the configuration format used by <a class="reference external" href="http://www.salome-platform.org">SALOME</a>):</p>
-<div class="highlight-default
notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">environ</span> <span class="o"><</span><span class="n">application</span><span class="o">></span> <span class="o">--</span><span class="n">shell</span> <span class="p">[</span><span class="n">bash</span><span class="o">|</span><span class="n">cfg</span><span class="o">|</span><span class="nb">all</span><span class="p">]</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">environ</span> <span class="o"><</span><span class="n">application</span><span class="o">></span> <span class="o">--</span><span class="n">shell</span> <span class="p">[</span><span class="n">bash</span><span class="o">|</span><span class="n">cfg</span><span class="o">|</span><span class="nb">all</span><span class="p">]</span>
</pre></div>
</div>
</li>
-<li><p class="first">Use a different prefix for the files (default is ‘env’):</p>
-<div class="highlight-bash
notranslate"><div class="highlight"><pre><span></span><span class="c1"># This will create file <prefix>_launch.sh, <prefix>_build.sh</span>
+<li><p class="first">Use a different prefix for the files (default is 'env'):</p>
+<div class="highlight-bash"><div class="highlight"><pre><span></span><span class="c1"># This will create file <prefix>_launch.sh, <prefix>_build.sh</span>
sat environ <application> --prefix <prefix>
</pre></div>
</div>
</li>
<li><p class="first">Use a different target directory for the files:</p>
-<div class="highlight-bash
notranslate"><div class="highlight"><pre><span></span><span class="c1"># This will create file env_launch.sh, env_build.sh</span>
+<div class="highlight-bash"><div class="highlight"><pre><span></span><span class="c1"># This will create file env_launch.sh, env_build.sh</span>
<span class="c1"># in the directory corresponding to <path></span>
sat environ <application> --target <path>
</pre></div>
</div>
</li>
<li><p class="first">Generate the environment files only with the given products:</p>
-<div class="highlight-bash
notranslate"><div class="highlight"><pre><span></span><span class="c1"># This will create the environment files only for the given products</span>
+<div class="highlight-bash"><div class="highlight"><pre><span></span><span class="c1"># This will create the environment files only for the given products</span>
<span class="c1"># and their prerequisites.</span>
<span class="c1"># It is useful when you want to visualise which environment uses</span>
<span class="c1"># sat to compile a given product.</span>
<h2>Configuration<a class="headerlink" href="#configuration" title="Permalink to this headline">¶</a></h2>
<p>The specification of the environment can be done through several mechanisms.</p>
<ol class="arabic simple">
-<li>For salome products (the products with the property <code class="docutils literal
notranslate"><span class="pre">is_SALOME_module</span></code> as <code class="docutils literal notranslate"><span class="pre">yes</span></code>) the environment is set automatically by sat, in respect with <a class="reference external" href="http://www.salome-platform.org">SALOME</a> requirements.</li>
+<li>For salome products (the products with the property <code class="docutils literal
"><span class="pre">is_SALOME_module</span></code> as <code class="docutils literal"><span class="pre">yes</span></code>) the environment is set automatically by sat, in respect with <a class="reference external" href="http://www.salome-platform.org">SALOME</a> requirements.</li>
<li>For other products, the environment is set with the use of the environ section within the pyconf file of the product. The user has two possibilities, either set directly the environment within the section, or specify a python script which wil be used to set the environment programmatically.</li>
</ol>
<p>Within the section, the user can define environment variables. He can also modify PATH variables, by appending or prepending directories.
-In the following example, we prepend <em><install_dir>/lib</em> to <code class="docutils literal notranslate"><span class="pre">LD_LIBRARY_PATH</span></code> (note the <em>left first</em> underscore), append <em><install_dir>/lib</em> to <code class="docutils literal notranslate"><span class="pre">PYTHONPATH</span></code> (note the <em>right last</em> underscore), and set <code class="docutils literal notranslate"><span class="pre">LAPACK_ROOT_DIR</span></code> to <em><install_dir></em>:</p>
-<div class="highlight-bash
notranslate"><div class="highlight"><pre><span></span>environ :
+In the following example, we prepend <em><install_dir>/lib</em> to <code class="docutils literal"><span class="pre">LD_LIBRARY_PATH</span></code> (note the <em>left first</em> underscore), append <em><install_dir>/lib</em> to <code class="docutils literal"><span class="pre">PYTHONPATH</span></code> (note the <em>right last</em> underscore), and set <code class="docutils literal"><span class="pre">LAPACK_ROOT_DIR</span></code> to <em><install_dir></em>:</p>
+<div class="highlight-bash"><div class="highlight"><pre><span></span>environ :
<span class="o">{</span>
_LD_LIBRARY_PATH : <span class="nv">$install_dir</span> + <span class="nv">$VARS</span>.sep + <span class="s2">"lib"</span>
PYTHONPATH_ : <span class="nv">$install_dir</span> + <span class="nv">$VARS</span>.sep + <span class="s2">"lib"</span>
<span class="o">}</span>
</pre></div>
</div>
-<p>It is possible to distinguish the build environment from the launch environment: use a subsection called <em>build</em> or <em>launch</em>. In the example below, <code class="docutils literal notranslate"><span class="pre">LD_LIBRARY_PATH</span></code> and <code class="docutils literal notranslate"><span class="pre">PYTHONPATH</span></code> are only modified at run time, not at compile time:</p>
-<div class="highlight-bash
notranslate"><div class="highlight"><pre><span></span>environ :
+<p>It is possible to distinguish the build environment from the launch environment: use a subsection called <em>build</em> or <em>launch</em>. In the example below, <code class="docutils literal"><span class="pre">LD_LIBRARY_PATH</span></code> and <code class="docutils literal"><span class="pre">PYTHONPATH</span></code> are only modified at run time, not at compile time:</p>
+<div class="highlight-bash"><div class="highlight"><pre><span></span>environ :
<span class="o">{</span>
build :
<span class="o">{</span>
</pre></div>
</div>
<ol class="arabic simple" start="3">
-<li>The last possibility is to set the environment with a python script. The script should be provided in the <em>products/env_scripts</em> directory of the sat project, and its name is specified in the environment section with the key <code class="docutils literal notranslate"><span class="pre">environ.env_script</span></code>:</li>
+<li>The last possibility is to set the environment with a python script. The script should be provided in the <em>products/env_scripts</em> directory of the sat project, and its name is specified in the environment section with the key <code class="docutils literal"><span class="pre">environ.env_script</span></code>:</li>
</ol>
-<div class="highlight-python
notranslate"><div class="highlight"><pre><span></span><span class="n">environ</span> <span class="p">:</span>
+<div class="highlight-python"><div class="highlight"><pre><span></span><span class="n">environ</span> <span class="p">:</span>
<span class="p">{</span>
<span class="n">env_script</span> <span class="p">:</span> <span class="s1">'lapack.py'</span>
<span class="p">}</span>
The developer implements a handle (as a python method)
which is called by sat to set the environment.
Here is an example:</p>
-<div class="highlight-python
notranslate"><div class="highlight"><pre><span></span><span class="ch">#!/usr/bin/env python</span>
+<div class="highlight-python"><div class="highlight"><pre><span></span><span class="ch">#!/usr/bin/env python</span>
<span class="c1">#-*- coding:utf-8 -*-</span>
<span class="kn">import</span> <span class="nn">os.path</span>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
- <li><a href="../_sources/commands/environ.rst.txt"
+ <li><a href="../_sources/commands/environ.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" />
+ <div><input type="text" name="q" /></div>
+ <div><input type="submit" value="Go" /></div>
<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>
©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>
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.9</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
|
- <a href="../_sources/commands/environ.rst.txt"
+ <a href="../_sources/commands/environ.txt"
rel="nofollow">Page source</a>
</div>
-
<!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 generate — salomeTools 5.0.0dev documentation</title>
+
<link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
- <script type="text/javascript" src="../_static/documentation_options.js"></script>
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
- <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/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="top" title="salomeTools 5.0.0dev documentation" href="../index.html" />
<link rel="next" title="Add a user custom command" href="../write_command.html" />
<link rel="prev" title="Command package" href="package.html" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
- </head><body>
+ </head>
+ <body role="document">
<div class="document">
<p>The <strong>generate</strong> command generates and compile SALOME modules from cpp modules using YACSGEN.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
-<p class="last">This command uses YACSGEN to generate the module. It needs to be specified with <em>–yacsgen</em> option, or defined in the product or by the environment variable <code class="docutils literal notranslate"><span class="pre">$YACSGEN_ROOT_DIR</span></code>.</p>
+<p class="last">This command uses YACSGEN to generate the module. It needs to be specified with <em>--yacsgen</em> option, or defined in the product or by the environment variable <code class="docutils literal"><span class="pre">$YACSGEN_ROOT_DIR</span></code>.</p>
</div>
</div>
<div class="section" id="remarks">
<h2>Remarks<a class="headerlink" href="#remarks" title="Permalink to this headline">¶</a></h2>
<ul>
<li><p class="first">This command will only apply on the CPP modules of the application, those who have both properties:</p>
-<div class="highlight-default
notranslate"><div class="highlight"><pre><span></span><span class="n">cpp</span> <span class="p">:</span> <span class="s2">"yes"</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">cpp</span> <span class="p">:</span> <span class="s2">"yes"</span>
<span class="n">generate</span> <span class="p">:</span> <span class="s2">"yes"</span>
</pre></div>
</div>
<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
<ul>
<li><p class="first">Generate all the modules of a product:</p>
-<div class="highlight-default
notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">generate</span> <span class="o"><</span><span class="n">application</span><span class="o">></span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">generate</span> <span class="o"><</span><span class="n">application</span><span class="o">></span>
</pre></div>
</div>
</li>
<li><p class="first">Generate only specific modules:</p>
-<div class="highlight-default
notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">generate</span> <span class="o"><</span><span class="n">application</span><span class="o">></span> <span class="o">--</span><span class="n">products</span> <span class="o"><</span><span class="n">list_of_products</span><span class="o">></span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">generate</span> <span class="o"><</span><span class="n">application</span><span class="o">></span> <span class="o">--</span><span class="n">products</span> <span class="o"><</span><span class="n">list_of_products</span><span class="o">></span>
</pre></div>
</div>
-<p>Remark: modules which don’t have the <em>generate</em> property are ignored.</p>
+<p>Remark: modules which don't have the <em>generate</em> property are ignored.</p>
</li>
<li><p class="first">Use a specific version of YACSGEN:</p>
-<div class="highlight-default
notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">generate</span> <span class="o"><</span><span class="n">application</span><span class="o">></span> <span class="o">--</span><span class="n">yacsgen</span> <span class="o"><</span><span class="n">path_to_yacsgen</span><span class="o">></span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">generate</span> <span class="o"><</span><span class="n">application</span><span class="o">></span> <span class="o">--</span><span class="n">yacsgen</span> <span class="o"><</span><span class="n">path_to_yacsgen</span><span class="o">></span>
</pre></div>
</div>
</li>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
- <li><a href="../_sources/commands/generate.rst.txt"
+ <li><a href="../_sources/commands/generate.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" />
+ <div><input type="text" name="q" /></div>
+ <div><input type="submit" value="Go" /></div>
<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>
©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>
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.9</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
|
- <a href="../_sources/commands/generate.rst.txt"
+ <a href="../_sources/commands/generate.txt"
rel="nofollow">Page source</a>
</div>
-
<!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 launcher — salomeTools 5.0.0dev documentation</title>
+
<link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
- <script type="text/javascript" src="../_static/documentation_options.js"></script>
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
- <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/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="top" title="salomeTools 5.0.0dev documentation" href="../index.html" />
<link rel="next" title="Command application" href="application.html" />
<link rel="prev" title="Command compile" href="compile.html" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
- </head><body>
+ </head>
+ <body role="document">
<div class="document">
<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
<ul>
<li><p class="first">Create a launcher:</p>
-<div class="highlight-default
notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">launcher</span> <span class="o"><</span><span class="n">application</span><span class="o">></span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">launcher</span> <span class="o"><</span><span class="n">application</span><span class="o">></span>
</pre></div>
</div>
-<p>Generate a launcher in the application directory, i.e <code class="docutils literal notranslate"><span class="pre">$APPLICATION.workdir</span></code>.</p>
+<p>Generate a launcher in the application directory, i.e <code class="docutils literal"><span class="pre">$APPLICATION.workdir</span></code>.</p>
</li>
-<li><p class="first">Create a launcher with a given name (default name is <code class="docutils literal notranslate"><span class="pre">APPLICATION.profile.launcher_name</span></code>)</p>
-<div class="highlight-default
notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">launcher</span> <span class="o"><</span><span class="n">application</span><span class="o">></span> <span class="o">--</span><span class="n">name</span> <span class="n">ZeLauncher</span>
+<li><p class="first">Create a launcher with a given name (default name is <code class="docutils literal"><span class="pre">APPLICATION.profile.launcher_name</span></code>)</p>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">launcher</span> <span class="o"><</span><span class="n">application</span><span class="o">></span> <span class="o">--</span><span class="n">name</span> <span class="n">ZeLauncher</span>
</pre></div>
</div>
<p>The launcher will be called <em>ZeLauncher</em>.</p>
</li>
<li><p class="first">Set a specific resources catalog:</p>
-<div class="highlight-default
notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">launcher</span> <span class="o"><</span><span class="n">application</span><span class="o">></span> <span class="o">--</span><span class="n">catalog</span> <span class="o"><</span><span class="n">path</span> <span class="n">of</span> <span class="n">a</span> <span class="n">salome</span> <span class="n">resources</span> <span class="n">catalog</span><span class="o">></span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">launcher</span> <span class="o"><</span><span class="n">application</span><span class="o">></span> <span class="o">--</span><span class="n">catalog</span> <span class="o"><</span><span class="n">path</span> <span class="n">of</span> <span class="n">a</span> <span class="n">salome</span> <span class="n">resources</span> <span class="n">catalog</span><span class="o">></span>
</pre></div>
</div>
<p>Note that the catalog specified will be copied to the profile directory.</p>
</li>
<li><p class="first">Generate the catalog for a list of machines:</p>
-<div class="highlight-default
notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">launcher</span> <span class="o"><</span><span class="n">application</span><span class="o">></span> <span class="o">--</span><span class="n">gencat</span> <span class="o"><</span><span class="nb">list</span> <span class="n">of</span> <span class="n">machines</span><span class="o">></span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">launcher</span> <span class="o"><</span><span class="n">application</span><span class="o">></span> <span class="o">--</span><span class="n">gencat</span> <span class="o"><</span><span class="nb">list</span> <span class="n">of</span> <span class="n">machines</span><span class="o">></span>
</pre></div>
</div>
<p>This will create a catalog by querying each machine (memory, number of processor) with ssh.</p>
</li>
<li><p class="first">Generate a mesa launcher (if mesa and llvm are parts of the application). Use this option only if you have to use salome through ssh and have problems with ssh X forwarding of OpengGL modules (like Paravis):</p>
-<div class="highlight-default
notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">launcher</span> <span class="o"><</span><span class="n">application</span><span class="o">></span> <span class="o">--</span><span class="n">use_mesa</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">launcher</span> <span class="o"><</span><span class="n">application</span><span class="o">></span> <span class="o">--</span><span class="n">use_mesa</span>
</pre></div>
</div>
</li>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
- <li><a href="../_sources/commands/launcher.rst.txt"
+ <li><a href="../_sources/commands/launcher.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" />
+ <div><input type="text" name="q" /></div>
+ <div><input type="submit" value="Go" /></div>
<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>
©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>
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.9</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
|
- <a href="../_sources/commands/launcher.rst.txt"
+ <a href="../_sources/commands/launcher.txt"
rel="nofollow">Page source</a>
</div>
-
<!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 log — salomeTools 5.0.0dev documentation</title>
+
<link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
- <script type="text/javascript" src="../_static/documentation_options.js"></script>
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
- <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/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="top" title="salomeTools 5.0.0dev documentation" href="../index.html" />
<link rel="next" title="Command environ" href="environ.html" />
<link rel="prev" title="Command application" href="application.html" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
- </head><body>
+ </head>
+ <body role="document">
<div class="document">
<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
<ul>
<li><p class="first">Show (in a web browser) the log of the commands corresponding to an application:</p>
-<div class="highlight-default
notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">log</span> <span class="o"><</span><span class="n">application</span><span class="o">></span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">log</span> <span class="o"><</span><span class="n">application</span><span class="o">></span>
</pre></div>
</div>
</li>
<li><p class="first">Show the log for commands that do not use any application:</p>
-<div class="highlight-default
notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">log</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">log</span>
</pre></div>
</div>
</li>
-<li><p class="first">The
–terminal (or -t) display the log directly in the terminal, through a <a class="reference external" href="https://en.wikipedia.org/wiki/Command-line_interface">CLI</a> interactive menu:</p>
-<div class="highlight-default
notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">log</span> <span class="o"><</span><span class="n">application</span><span class="o">></span> <span class="o">--</span><span class="n">terminal</span>
+<li><p class="first">The
--terminal (or -t) display the log directly in the terminal, through a <a class="reference external" href="https://en.wikipedia.org/wiki/Command-line_interface">CLI</a> interactive menu:</p>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">log</span> <span class="o"><</span><span class="n">application</span><span class="o">></span> <span class="o">--</span><span class="n">terminal</span>
</pre></div>
</div>
</li>
-<li><p class="first">The –last option displays only the last command:</p>
-<div class="highlight-default
notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">log</span> <span class="o"><</span><span class="n">application</span><span class="o">></span> <span class="o">--</span><span class="n">last</span>
+<li><p class="first">The --last option displays only the last command:</p>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">log</span> <span class="o"><</span><span class="n">application</span><span class="o">></span> <span class="o">--</span><span class="n">last</span>
</pre></div>
</div>
</li>
-<li><p class="first">To access the last compilation log in terminal mode, use –last_terminal option:</p>
-<div class="highlight-default
notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">log</span> <span class="o"><</span><span class="n">application</span><span class="o">></span> <span class="o">--</span><span class="n">last_terminal</span>
+<li><p class="first">To access the last compilation log in terminal mode, use --last_terminal option:</p>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">log</span> <span class="o"><</span><span class="n">application</span><span class="o">></span> <span class="o">--</span><span class="n">last_terminal</span>
</pre></div>
</div>
</li>
-<li><p class="first">The –clean (int) option erases the n older log files and print the number of remaining log files:</p>
-<div class="highlight-default
notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">log</span> <span class="o"><</span><span class="n">application</span><span class="o">></span> <span class="o">--</span><span class="n">clean</span> <span class="mi">50</span>
+<li><p class="first">The --clean (int) option erases the n older log files and print the number of remaining log files:</p>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">log</span> <span class="o"><</span><span class="n">application</span><span class="o">></span> <span class="o">--</span><span class="n">clean</span> <span class="mi">50</span>
</pre></div>
</div>
</li>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
- <li><a href="../_sources/commands/log.rst.txt"
+ <li><a href="../_sources/commands/log.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" />
+ <div><input type="text" name="q" /></div>
+ <div><input type="submit" value="Go" /></div>
<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>
©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>
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.9</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
|
- <a href="../_sources/commands/log.rst.txt"
+ <a href="../_sources/commands/log.txt"
rel="nofollow">Page source</a>
</div>
-
<!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 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">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
- <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/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="top" title="salomeTools 5.0.0dev documentation" href="../index.html" />
<link rel="next" title="Command generate" href="generate.html" />
<link rel="prev" title="Command clean" href="clean.html" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
- </head><body>
+ </head>
+ <body role="document">
<div class="document">
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">By default the package includes the sources of prerequisites and products.
-To select a subset use the <em>–without_property</em> or <em>–with_vcs</em> options.</p>
+To select a subset use the <em>--without_property</em> or <em>--with_vcs</em> options.</p>
</div>
</div>
<div class="section" id="usage">
<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
<ul>
<li><p class="first">Create a package for a product (example as <em>SALOME_xx</em>):</p>
-<div class="highlight-default
notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">package</span> <span class="n">SALOME_xx</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">package</span> <span class="n">SALOME_xx</span>
</pre></div>
</div>
-<p>This command will create an archive named <code class="docutils literal notranslate"><span class="pre">SALOME_xx.tgz</span></code>
-in the working directory (<code class="docutils literal notranslate"><span class="pre">USER.workDir</span></code>).
+<p>This command will create an archive named <code class="docutils literal"><span class="pre">SALOME_xx.tgz</span></code>
+in the working directory (<code class="docutils literal"><span class="pre">USER.workDir</span></code>).
If the archive already exists, do nothing.</p>
</li>
<li><p class="first">Create a package with a specific name:</p>
-<div class="highlight-default
notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">package</span> <span class="n">SALOME_xx</span> <span class="o">--</span><span class="n">name</span> <span class="n">YourSpecificName</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">package</span> <span class="n">SALOME_xx</span> <span class="o">--</span><span class="n">name</span> <span class="n">YourSpecificName</span>
</pre></div>
</div>
</li>
</ul>
<div class="admonition note">
<p class="first admonition-title">Note</p>
-<p>By default, the archive is created in the working directory of the user (<code class="docutils literal notranslate"><span class="pre">USER.workDir</span></code>).</p>
-<p>If the option <em>–name</em> is used with a path (relative or absolute) it will be used.</p>
-<p>If the option <em>–name</em> is not used and binaries (prerequisites and products)
+<p>By default, the archive is created in the working directory of the user (<code class="docutils literal"><span class="pre">USER.workDir</span></code>).</p>
+<p>If the option <em>--name</em> is used with a path (relative or absolute) it will be used.</p>
+<p>If the option <em>--name</em> is not used and binaries (prerequisites and products)
are included in the package, the <a class="reference external" href="https://en.wikipedia.org/wiki/Operating_system">OS</a> architecture
-will be appended to the name (example: <code class="docutils literal notranslate"><span class="pre">SALOME_xx-CO7.tgz</span></code>).</p>
+will be appended to the name (example: <code class="docutils literal"><span class="pre">SALOME_xx-CO7.tgz</span></code>).</p>
<p>Examples:</p>
-<div class="last highlight-default
notranslate"><div class="highlight"><pre><span></span><span class="c1"># Creates SALOME_xx.tgz in $USER.workDir</span>
+<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="c1"># Creates SALOME_xx.tgz in $USER.workDir</span>
<span class="n">sat</span> <span class="n">package</span> <span class="n">SALOME_xx</span>
<span class="c1"># Creates SALOME_xx_<arch>.tgz in $USER.workDir</span>
</div>
<ul>
<li><p class="first">Force the creation of the archive (if it already exists):</p>
-<div class="highlight-default
notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">package</span> <span class="n">SALOME_xx</span> <span class="o">--</span><span class="n">force</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">package</span> <span class="n">SALOME_xx</span> <span class="o">--</span><span class="n">force</span>
</pre></div>
</div>
</li>
<li><p class="first">Include the binaries in the archive (products and prerequisites):</p>
-<div class="highlight-default
notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">package</span> <span class="n">SALOME_xx</span> <span class="o">--</span><span class="n">binaries</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">package</span> <span class="n">SALOME_xx</span> <span class="o">--</span><span class="n">binaries</span>
</pre></div>
</div>
-<p>This command will create an archive named <code class="docutils literal notranslate"><span class="pre">SALOME_xx</span> <span class="pre">_<arch>.tgz</span></code>
+<p>This command will create an archive named <code class="docutils literal"><span class="pre">SALOME_xx</span> <span class="pre">_<arch>.tgz</span></code>
where <arch> is the <a class="reference external" href="https://en.wikipedia.org/wiki/Operating_system">OS</a> architecture of the machine.</p>
</li>
<li><p class="first">Do not delete Version Control System (<a class="reference external" href="https://en.wikipedia.org/wiki/Version_control">VCS</a>) informations from the configurations files of the embedded salomeTools:</p>
-<div class="highlight-default
notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">package</span> <span class="n">SALOME_xx</span> <span class="o">--</span><span class="n">with_vcs</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">package</span> <span class="n">SALOME_xx</span> <span class="o">--</span><span class="n">with_vcs</span>
</pre></div>
</div>
<p>The version control systems known by this option are <a class="reference external" href="https://fr.wikipedia.org/wiki/Concurrent_versions_system">CVS</a>, <a class="reference external" href="https://en.wikipedia.org/wiki/Apache_Subversion">SVN</a> and <a class="reference external" href="https://git-scm.com">Git</a>.</p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
- <li><a href="../_sources/commands/package.rst.txt"
+ <li><a href="../_sources/commands/package.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" />
+ <div><input type="text" name="q" /></div>
+ <div><input type="submit" value="Go" /></div>
<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>
©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>
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.9</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
|
- <a href="../_sources/commands/package.rst.txt"
+ <a href="../_sources/commands/package.txt"
rel="nofollow">Page source</a>
</div>
-
<!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 prepare — salomeTools 5.0.0dev documentation</title>
+
<link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
- <script type="text/javascript" src="../_static/documentation_options.js"></script>
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
- <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/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="top" title="salomeTools 5.0.0dev documentation" href="../index.html" />
<link rel="next" title="Command compile" href="compile.html" />
<link rel="prev" title="Command config" href="config.html" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
- </head><body>
+ </head>
+ <body role="document">
<div class="document">
To perform a <em>checkout</em> (svn, cvs) or a <em>git clone</em> (git),
you need to declare the product in dev mode in your application configuration:
edit the application configuration file (pyconf) and modify the product declaration:</p>
-<div class="highlight-bash
notranslate"><div class="highlight"><pre><span></span>sat config <application> -e
+<div class="highlight-bash"><div class="highlight"><pre><span></span>sat config <application> -e
<span class="c1"># and edit the product section:</span>
<span class="c1"># <product> : {tag : "my_tag", dev : "yes", debug : "yes"}</span>
</pre></div>
<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
<ul>
<li><p class="first">Prepare the sources of a complete application in SOURCES directory (all products):</p>
-<div class="highlight-default
notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">prepare</span> <span class="o"><</span><span class="n">application</span><span class="o">></span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">prepare</span> <span class="o"><</span><span class="n">application</span><span class="o">></span>
</pre></div>
</div>
</li>
<li><p class="first">Prepare only some modules:</p>
-<div class="highlight-default
notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">prepare</span> <span class="o"><</span><span class="n">application</span><span class="o">></span> <span class="o">--</span><span class="n">products</span> <span class="o"><</span><span class="n">product1</span><span class="o">></span><span class="p">,</span><span class="o"><</span><span class="n">product2</span><span class="o">></span> <span class="o">...</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">prepare</span> <span class="o"><</span><span class="n">application</span><span class="o">></span> <span class="o">--</span><span class="n">products</span> <span class="o"><</span><span class="n">product1</span><span class="o">></span><span class="p">,</span><span class="o"><</span><span class="n">product2</span><span class="o">></span> <span class="o">...</span>
</pre></div>
</div>
</li>
-<li><p class="first">Use –force to force to prepare the products in development mode
+<li><p class="first">Use --force to force to prepare the products in development mode
(this will remove the sources and do a new clone/checkout):</p>
-<div class="highlight-default
notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">prepare</span> <span class="o"><</span><span class="n">application</span><span class="o">></span> <span class="o">--</span><span class="n">force</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">prepare</span> <span class="o"><</span><span class="n">application</span><span class="o">></span> <span class="o">--</span><span class="n">force</span>
</pre></div>
</div>
</li>
-<li><p class="first">Use –force_patch to force to apply patch to the products
+<li><p class="first">Use --force_patch to force to apply patch to the products
in development mode (otherwise they are not applied):</p>
-<div class="highlight-default
notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">prepare</span> <span class="o"><</span><span class="n">application</span><span class="o">></span> <span class="o">--</span><span class="n">force_patch</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">prepare</span> <span class="o"><</span><span class="n">application</span><span class="o">></span> <span class="o">--</span><span class="n">force_patch</span>
</pre></div>
</div>
</li>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p>to verify configuration of a product, and get name of this <em>pyconf files configuration</em></p>
-<div class="last highlight-bash
notranslate"><div class="highlight"><pre><span></span>sat config <application> --info <product>
+<div class="last highlight-bash"><div class="highlight"><pre><span></span>sat config <application> --info <product>
</pre></div>
</div>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
- <li><a href="../_sources/commands/prepare.rst.txt"
+ <li><a href="../_sources/commands/prepare.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" />
+ <div><input type="text" name="q" /></div>
+ <div><input type="submit" value="Go" /></div>
<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>
©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>
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.9</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
|
- <a href="../_sources/commands/prepare.rst.txt"
+ <a href="../_sources/commands/prepare.txt"
rel="nofollow">Page source</a>
</div>
-
<!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>Configuration — salomeTools 5.0.0dev documentation</title>
+
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
- <script type="text/javascript" src="_static/documentation_options.js"></script>
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: './',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
- <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/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="top" title="salomeTools 5.0.0dev documentation" href="index.html" />
<link rel="next" title="Usage of SAlomeTools" href="usage_of_sat.html" />
<link rel="prev" title="Installation" href="installation_of_sat.html" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
- </head><body>
+ </head>
+ <body role="document">
<div class="document">
<li><strong>{}</strong> define a dictionary,</li>
<li><strong>[]</strong> define a list,</li>
<li><strong>@</strong> can be used to include a file,</li>
-<li><strong>$prefix</strong> reference to another parameter (ex: <code class="docutils literal notranslate"><span class="pre">$PRODUCT.name</span></code>),</li>
+<li><strong>$prefix</strong> reference to another parameter (ex: <code class="docutils literal"><span class="pre">$PRODUCT.name</span></code>),</li>
<li><strong>#</strong> comments.</li>
</ul>
<div class="admonition note">
<p class="first admonition-title">Note</p>
-<p class="last">in this documentation a reference to a configuration parameter will be noted <code class="docutils literal notranslate"><span class="pre">XXX.YYY</span></code>.</p>
+<p class="last">in this documentation a reference to a configuration parameter will be noted <code class="docutils literal"><span class="pre">XXX.YYY</span></code>.</p>
</div>
</div>
<div class="section" id="description">
<div class="line">This section is dynamically created by salomeTools at run time.</div>
<div class="line">It contains information about the environment: date, time, OS, architecture etc.</div>
</div>
-<div class="highlight-default
notranslate"><div class="highlight"><pre><span></span><span class="c1"># to get the current setting</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="c1"># to get the current setting</span>
<span class="n">sat</span> <span class="n">config</span> <span class="o">--</span><span class="n">value</span> <span class="n">VARS</span>
</pre></div>
</div>
<div class="line">This section is defined in the product file.</div>
<div class="line">It contains instructions on how to build a version of SALOME (list of prerequisites-products and versions)</div>
</div>
-<div class="highlight-default
notranslate"><div class="highlight"><pre><span></span><span class="c1"># to get the current setting</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="c1"># to get the current setting</span>
<span class="n">sat</span> <span class="n">config</span> <span class="n">SALOME</span><span class="o">-</span><span class="n">xx</span> <span class="o">--</span><span class="n">value</span> <span class="n">PRODUCTS</span>
</pre></div>
</div>
<div class="line">This section is optional, it is also defined in the product file.</div>
<div class="line">It gives additional parameters to create an application based on SALOME, as versions of products to use.</div>
</div>
-<div class="highlight-default
notranslate"><div class="highlight"><pre><span></span><span class="c1"># to get the current setting</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="c1"># to get the current setting</span>
<span class="n">sat</span> <span class="n">config</span> <span class="n">SALOME</span><span class="o">-</span><span class="n">xx</span> <span class="o">--</span><span class="n">value</span> <span class="n">APPLICATION</span>
</pre></div>
</div>
<div class="section" id="user-section">
<span id="id2"></span><h3>USER section<a class="headerlink" href="#user-section" title="Permalink to this headline">¶</a></h3>
<p>This section is defined by the user configuration file,
-<code class="docutils literal notranslate"><span class="pre">~/.salomeTools/salomeTools.pyconf</span></code>.</p>
-<p>The <code class="docutils literal notranslate"><span class="pre">USER</span></code> section defines some parameters (not exhaustive):</p>
+<code class="docutils literal"><span class="pre">~/.salomeTools/salomeTools.pyconf</span></code>.</p>
+<p>The <code class="docutils literal"><span class="pre">USER</span></code> section defines some parameters (not exhaustive):</p>
<ul>
<li><p class="first"><strong>workDir</strong> :</p>
<blockquote>
<li><p class="first">and other user preferences.</p>
</li>
</ul>
-<div class="highlight-default
notranslate"><div class="highlight"><pre><span></span><span class="c1"># to get the current setting</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="c1"># to get the current setting</span>
<span class="n">sat</span> <span class="n">config</span> <span class="n">SALOME</span><span class="o">-</span><span class="n">xx</span> <span class="o">--</span><span class="n">value</span> <span class="n">USER</span>
</pre></div>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
- <li><a href="_sources/configuration.rst.txt"
+ <li><a href="_sources/configuration.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" />
+ <div><input type="text" name="q" /></div>
+ <div><input type="submit" value="Go" /></div>
<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>
©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>
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.9</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
|
- <a href="_sources/configuration.rst.txt"
+ <a href="_sources/configuration.txt"
rel="nofollow">Page source</a>
</div>
-
<!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>Index — salomeTools 5.0.0dev documentation</title>
+
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
- <script type="text/javascript" src="_static/documentation_options.js"></script>
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: './',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
- <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="index" title="Index" href="#" />
<link rel="search" title="Search" href="search.html" />
+ <link rel="top" title="salomeTools 5.0.0dev documentation" href="index.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
- </head><body>
+ </head>
+ <body role="document">
<div class="document">
| <a href="#G"><strong>G</strong></a>
| <a href="#H"><strong>H</strong></a>
| <a href="#I"><strong>I</strong></a>
+ | <a href="#J"><strong>J</strong></a>
| <a href="#K"><strong>K</strong></a>
| <a href="#L"><strong>L</strong></a>
| <a href="#M"><strong>M</strong></a>
</div>
<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>
- <li><a href="commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.add">add() (src.fileEnviron.LauncherFileEnviron method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.add_comment">add_comment() (src.environment.SalomeEnviron method)</a>
-
- <ul>
- <li><a href="commands/apidoc/src.html#src.fileEnviron.BatFileEnviron.add_comment">(src.fileEnviron.BatFileEnviron method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.fileEnviron.FileEnviron.add_comment">(src.fileEnviron.FileEnviron method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.add_comment">(src.fileEnviron.LauncherFileEnviron method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.fileEnviron.ScreenEnviron.add_comment">(src.fileEnviron.ScreenEnviron method)</a>
-</li>
- </ul></li>
- <li><a href="commands/apidoc/src.html#src.fileEnviron.ContextFileEnviron.add_echo">add_echo() (src.fileEnviron.ContextFileEnviron method)</a>
-
- <ul>
- <li><a href="commands/apidoc/src.html#src.fileEnviron.FileEnviron.add_echo">(src.fileEnviron.FileEnviron method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.add_echo">(src.fileEnviron.LauncherFileEnviron method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.fileEnviron.ScreenEnviron.add_echo">(src.fileEnviron.ScreenEnviron method)</a>
-</li>
- </ul></li>
- <li><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.add_line">add_line() (src.environment.SalomeEnviron method)</a>
-
- <ul>
- <li><a href="commands/apidoc/src.html#src.fileEnviron.FileEnviron.add_line">(src.fileEnviron.FileEnviron method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.add_line">(src.fileEnviron.LauncherFileEnviron method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.fileEnviron.ScreenEnviron.add_line">(src.fileEnviron.ScreenEnviron method)</a>
-</li>
- </ul></li>
- <li><a href="commands/apidoc/src.html#src.logger.Logger.add_link">add_link() (src.logger.Logger method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.options.Options.add_option">add_option() (src.options.Options method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.xmlManager.add_simple_node">add_simple_node() (in module src.xmlManager)</a>
-
- <ul>
- <li><a href="commands/apidoc/src.html#src.xmlManager.XmlLogFile.add_simple_node">(src.xmlManager.XmlLogFile method)</a>
-</li>
- </ul></li>
- <li><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.add_warning">add_warning() (src.environment.SalomeEnviron method)</a>
-
- <ul>
- <li><a href="commands/apidoc/src.html#src.fileEnviron.ContextFileEnviron.add_warning">(src.fileEnviron.ContextFileEnviron method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.fileEnviron.FileEnviron.add_warning">(src.fileEnviron.FileEnviron method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.add_warning">(src.fileEnviron.LauncherFileEnviron method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.fileEnviron.ScreenEnviron.add_warning">(src.fileEnviron.ScreenEnviron method)</a>
-</li>
- </ul></li>
- </ul></td>
- <td style="width: 33%; vertical-align: top;"><ul>
- <li><a href="commands/apidoc/src.html#src.pyconf.Reference.addElement">addElement() (src.pyconf.Reference method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.pyconf.Mapping.addMapping">addMapping() (src.pyconf.Mapping method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.pyconf.Config.addNamespace">addNamespace() (src.pyconf.Config method)</a>
-</li>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansitowin32.AnsiToWin32.ANSI_CSI_RE">ANSI_CSI_RE (src.colorama.ansitowin32.AnsiToWin32 attribute)</a>
-</li>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansitowin32.AnsiToWin32.ANSI_OSC_RE">ANSI_OSC_RE (src.colorama.ansitowin32.AnsiToWin32 attribute)</a>
-</li>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiBack">AnsiBack (class in src.colorama.ansi)</a>
-</li>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiCodes">AnsiCodes (class in src.colorama.ansi)</a>
-</li>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiCursor">AnsiCursor (class in src.colorama.ansi)</a>
-</li>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiFore">AnsiFore (class in src.colorama.ansi)</a>
-</li>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiStyle">AnsiStyle (class in src.colorama.ansi)</a>
-</li>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansitowin32.AnsiToWin32">AnsiToWin32 (class in src.colorama.ansitowin32)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.environment.Environ.append">append() (src.environment.Environ method)</a>
-
- <ul>
- <li><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.append">(src.environment.SalomeEnviron method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.fileEnviron.FileEnviron.append">(src.fileEnviron.FileEnviron method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.append">(src.fileEnviron.LauncherFileEnviron method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.fileEnviron.ScreenEnviron.append">(src.fileEnviron.ScreenEnviron method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.pyconf.Sequence.append">(src.pyconf.Sequence method)</a>
-</li>
- </ul></li>
- <li><a href="commands/apidoc/src.html#src.xmlManager.append_node_attrib">append_node_attrib() (in module src.xmlManager)</a>
-
- <ul>
- <li><a href="commands/apidoc/src.html#src.xmlManager.XmlLogFile.append_node_attrib">(src.xmlManager.XmlLogFile method)</a>
-</li>
- </ul></li>
- <li><a href="commands/apidoc/src.html#src.xmlManager.XmlLogFile.append_node_text">append_node_text() (src.xmlManager.XmlLogFile method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.environment.Environ.append_value">append_value() (src.environment.Environ method)</a>
-
- <ul>
- <li><a href="commands/apidoc/src.html#src.fileEnviron.ContextFileEnviron.append_value">(src.fileEnviron.ContextFileEnviron method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.fileEnviron.FileEnviron.append_value">(src.fileEnviron.FileEnviron method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.append_value">(src.fileEnviron.LauncherFileEnviron method)</a>
-</li>
- </ul></li>
- <li><a href="commands/apidoc/src.html#src.system.archive_extract">archive_extract() (in module src.system)</a>
-</li>
- </ul></td>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.add">add() (src.fileEnviron.LauncherFileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.add_comment">add_comment() (src.environment.SalomeEnviron method)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.BatFileEnviron.add_comment">(src.fileEnviron.BatFileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.FileEnviron.add_comment">(src.fileEnviron.FileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.add_comment">(src.fileEnviron.LauncherFileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.ScreenEnviron.add_comment">(src.fileEnviron.ScreenEnviron method)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.ContextFileEnviron.add_echo">add_echo() (src.fileEnviron.ContextFileEnviron method)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.FileEnviron.add_echo">(src.fileEnviron.FileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.add_echo">(src.fileEnviron.LauncherFileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.ScreenEnviron.add_echo">(src.fileEnviron.ScreenEnviron method)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.add_line">add_line() (src.environment.SalomeEnviron method)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.FileEnviron.add_line">(src.fileEnviron.FileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.add_line">(src.fileEnviron.LauncherFileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.ScreenEnviron.add_line">(src.fileEnviron.ScreenEnviron method)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.html#src.options.Options.add_option">add_option() (src.options.Options method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.xmlManager.add_simple_node">add_simple_node() (in module src.xmlManager)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.xmlManager.XmlLogFile.add_simple_node">(src.xmlManager.XmlLogFile method)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.add_warning">add_warning() (src.environment.SalomeEnviron method)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.ContextFileEnviron.add_warning">(src.fileEnviron.ContextFileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.FileEnviron.add_warning">(src.fileEnviron.FileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.add_warning">(src.fileEnviron.LauncherFileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.ScreenEnviron.add_warning">(src.fileEnviron.ScreenEnviron method)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.Reference.addElement">addElement() (src.pyconf.Reference method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.Mapping.addMapping">addMapping() (src.pyconf.Mapping method)</a>
+ </dt>
+
+ </dl></td>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.Config.addNamespace">addNamespace() (src.pyconf.Config method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansitowin32.AnsiToWin32.ANSI_CSI_RE">ANSI_CSI_RE (src.colorama.ansitowin32.AnsiToWin32 attribute)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansitowin32.AnsiToWin32.ANSI_OSC_RE">ANSI_OSC_RE (src.colorama.ansitowin32.AnsiToWin32 attribute)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiBack">AnsiBack (class in src.colorama.ansi)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiCodes">AnsiCodes (class in src.colorama.ansi)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiCursor">AnsiCursor (class in src.colorama.ansi)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiFore">AnsiFore (class in src.colorama.ansi)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiStyle">AnsiStyle (class in src.colorama.ansi)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansitowin32.AnsiToWin32">AnsiToWin32 (class in src.colorama.ansitowin32)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.environment.Environ.append">append() (src.environment.Environ method)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.append">(src.environment.SalomeEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.FileEnviron.append">(src.fileEnviron.FileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.append">(src.fileEnviron.LauncherFileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.ScreenEnviron.append">(src.fileEnviron.ScreenEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.Sequence.append">(src.pyconf.Sequence method)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.html#src.xmlManager.append_node_attrib">append_node_attrib() (in module src.xmlManager)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.xmlManager.XmlLogFile.append_node_attrib">(src.xmlManager.XmlLogFile method)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.html#src.xmlManager.XmlLogFile.append_node_text">append_node_text() (src.xmlManager.XmlLogFile method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.environment.Environ.append_value">append_value() (src.environment.Environ method)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.ContextFileEnviron.append_value">(src.fileEnviron.ContextFileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.FileEnviron.append_value">(src.fileEnviron.FileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.append_value">(src.fileEnviron.LauncherFileEnviron method)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.html#src.system.archive_extract">archive_extract() (in module src.system)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.salomeTools.assumeAsList">assumeAsList() (in module src.salomeTools)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.salomeTools.Sat.assumeAsList">(src.salomeTools.Sat method)</a>
+ </dt>
+
+ </dl></dd>
+ </dl></td>
</tr></table>
<h2 id="B">B</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
- <td style="width: 33%; vertical-align: top;"><ul>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiCursor.BACK">BACK() (src.colorama.ansi.AnsiCursor method)</a>
-</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>
- <li><a href="commands/apidoc/src.html#src.fileEnviron.BashFileEnviron">BashFileEnviron (class in src.fileEnviron)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.fork.batch">batch() (in module src.fork)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.fork.batch_salome">batch_salome() (in module src.fork)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.fileEnviron.BatFileEnviron">BatFileEnviron (class in src.fileEnviron)</a>
-</li>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiBack.BLACK">BLACK (src.colorama.ansi.AnsiBack attribute)</a>
-
- <ul>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiFore.BLACK">(src.colorama.ansi.AnsiFore attribute)</a>
-</li>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinColor.BLACK">(src.colorama.winterm.WinColor attribute)</a>
-</li>
- </ul></li>
- </ul></td>
- <td style="width: 33%; vertical-align: top;"><ul>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiBack.BLUE">BLUE (src.colorama.ansi.AnsiBack attribute)</a>
-
- <ul>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiFore.BLUE">(src.colorama.ansi.AnsiFore attribute)</a>
-</li>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinColor.BLUE">(src.colorama.winterm.WinColor attribute)</a>
-</li>
- </ul></li>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiStyle.BRIGHT">BRIGHT (src.colorama.ansi.AnsiStyle attribute)</a>
-
- <ul>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinStyle.BRIGHT">(src.colorama.winterm.WinStyle attribute)</a>
-</li>
- </ul></li>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinStyle.BRIGHT_BACKGROUND">BRIGHT_BACKGROUND (src.colorama.winterm.WinStyle attribute)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.compilation.Builder.build_configure">build_configure() (src.compilation.Builder method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.compilation.Builder">Builder (class in src.compilation)</a>
-</li>
- </ul></td>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiCursor.BACK">BACK() (src.colorama.ansi.AnsiCursor method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinTerm.back">back() (src.colorama.winterm.WinTerm method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.utilsSat.Path.base">base() (src.utilsSat.Path method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.BashFileEnviron">BashFileEnviron (class in src.fileEnviron)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fork.batch">batch() (in module src.fork)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fork.batch_salome">batch_salome() (in module src.fork)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.BatFileEnviron">BatFileEnviron (class in src.fileEnviron)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiBack.BLACK">BLACK (src.colorama.ansi.AnsiBack attribute)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiFore.BLACK">(src.colorama.ansi.AnsiFore attribute)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinColor.BLACK">(src.colorama.winterm.WinColor attribute)</a>
+ </dt>
+
+ </dl></dd>
+ </dl></td>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.utilsSat.black">black() (in module src.utilsSat)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiBack.BLUE">BLUE (src.colorama.ansi.AnsiBack attribute)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiFore.BLUE">(src.colorama.ansi.AnsiFore attribute)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinColor.BLUE">(src.colorama.winterm.WinColor attribute)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.html#src.utilsSat.blue">blue() (in module src.utilsSat)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiStyle.BRIGHT">BRIGHT (src.colorama.ansi.AnsiStyle attribute)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinStyle.BRIGHT">(src.colorama.winterm.WinStyle attribute)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinStyle.BRIGHT_BACKGROUND">BRIGHT_BACKGROUND (src.colorama.winterm.WinStyle attribute)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.compilation.Builder.build_configure">build_configure() (src.compilation.Builder method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.compilation.Builder">Builder (class in src.compilation)</a>
+ </dt>
+
+ </dl></td>
</tr></table>
<h2 id="C">C</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
- <td style="width: 33%; vertical-align: top;"><ul>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansitowin32.AnsiToWin32.call_win32">call_win32() (src.colorama.ansitowin32.AnsiToWin32 method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.change_to_launcher">change_to_launcher() (src.fileEnviron.LauncherFileEnviron method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.compilation.Builder.check">check() (src.compilation.Builder method)</a>
-</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>
- <li><a href="commands/apidoc/src.html#src.__init__.check_config_has_profile">check_config_has_profile() (in module src.__init__)</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>
- <li><a href="commands/apidoc/src.html#src.printcolors.cleancolor">cleancolor() (in module src.printcolors)</a>
-</li>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.clear_line">clear_line() (in module src.colorama.ansi)</a>
-</li>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.clear_screen">clear_screen() (in module src.colorama.ansi)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.debug.OutStream.close">close() (src.debug.OutStream method)</a>
-
- <ul>
- <li><a href="commands/apidoc/src.html#src.ElementTree.TreeBuilder.close">(src.ElementTree.TreeBuilder method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.ElementTree.XMLTreeBuilder.close">(src.ElementTree.XMLTreeBuilder method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.pyconf.ConfigInputStream.close">(src.pyconf.ConfigInputStream method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.pyconf.ConfigOutputStream.close">(src.pyconf.ConfigOutputStream method)</a>
-</li>
- </ul></li>
- <li><a href="commands/apidoc/src.html#src.compilation.Builder.cmake">cmake() (src.compilation.Builder method)</a>
-</li>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.code_to_chars">code_to_chars() (in module src.colorama.ansi)</a>
-</li>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.initialise.colorama_text">colorama_text() (in module src.colorama.initialise)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.environment.Environ.command_value">command_value() (src.environment.Environ method)</a>
-
- <ul>
- <li><a href="commands/apidoc/src.html#src.fileEnviron.BashFileEnviron.command_value">(src.fileEnviron.BashFileEnviron method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.fileEnviron.BatFileEnviron.command_value">(src.fileEnviron.BatFileEnviron method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.fileEnviron.ContextFileEnviron.command_value">(src.fileEnviron.ContextFileEnviron method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.fileEnviron.FileEnviron.command_value">(src.fileEnviron.FileEnviron method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.command_value">(src.fileEnviron.LauncherFileEnviron method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.fileEnviron.ScreenEnviron.command_value">(src.fileEnviron.ScreenEnviron method)</a>
-</li>
- </ul></li>
- </ul></td>
- <td style="width: 33%; vertical-align: top;"><ul>
- <li><a href="commands/apidoc/src.html#src.ElementTree.Comment">Comment() (in module src.ElementTree)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.compilation.Builder.complete_environment">complete_environment() (src.compilation.Builder method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.pyconf.Config">Config (class in src.pyconf)</a>
-</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>
- <li><a href="commands/apidoc/src.html#src.pyconf.ConfigError">ConfigError</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.pyconf.ConfigFormatError">ConfigFormatError</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.pyconf.ConfigInputStream">ConfigInputStream (class in src.pyconf)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.pyconf.ConfigList">ConfigList (class in src.pyconf)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.pyconf.ConfigMerger">ConfigMerger (class in src.pyconf)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.pyconf.ConfigOutputStream">ConfigOutputStream (class in src.pyconf)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.pyconf.ConfigReader">ConfigReader (class in src.pyconf)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.pyconf.ConfigResolutionError">ConfigResolutionError</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.compilation.Builder.configure">configure() (src.compilation.Builder method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.pyconf.Container">Container (class in src.pyconf)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.fileEnviron.ContextFileEnviron">ContextFileEnviron (class in src.fileEnviron)</a>
-</li>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansitowin32.AnsiToWin32.convert_ansi">convert_ansi() (src.colorama.ansitowin32.AnsiToWin32 method)</a>
-</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>
- <li><a href="commands/apidoc/src.html#src.__init__.Path.copydir">copydir() (src.__init__.Path method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.__init__.Path.copyfile">copyfile() (src.__init__.Path method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.__init__.Path.copylink">copylink() (src.__init__.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><a href="commands/apidoc/src.html#src.system.cvs_extract">cvs_extract() (in module src.system)</a>
-</li>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiBack.CYAN">CYAN (src.colorama.ansi.AnsiBack attribute)</a>
-
- <ul>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiFore.CYAN">(src.colorama.ansi.AnsiFore attribute)</a>
-</li>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinColor.CYAN">(src.colorama.winterm.WinColor attribute)</a>
-</li>
- </ul></li>
- </ul></td>
-</tr></table>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansitowin32.AnsiToWin32.call_win32">call_win32() (src.colorama.ansitowin32.AnsiToWin32 method)</a>
+ </dt>
-<h2 id="D">D</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.ElementTree.TreeBuilder.data">data() (src.ElementTree.TreeBuilder method)</a>
-</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>
- <li><a href="commands/apidoc/src.html#src.pyconf.deepCopyMapping">deepCopyMapping() (in module src.pyconf)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.pyconf.defaultMergeResolve">defaultMergeResolve() (in module src.pyconf)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.pyconf.defaultStreamOpener">defaultStreamOpener() (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>
- <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><a href="commands/apidoc/src.html#src.compilation.Builder.do_default_build">do_default_build() (src.compilation.Builder method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.compilation.Builder.do_python_script_build">do_python_script_build() (src.compilation.Builder method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.compilation.Builder.do_script_build">do_script_build() (src.compilation.Builder method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.ElementTree.XMLTreeBuilder.doctype">doctype() (src.ElementTree.XMLTreeBuilder method)</a>
-</li>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiCursor.DOWN">DOWN() (src.colorama.ansi.AnsiCursor method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.ElementTree.dump">dump() (in module src.ElementTree)</a>
-
- <ul>
- <li><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.dump">(src.environment.SalomeEnviron method)</a>
-</li>
- </ul></li>
- </ul></td>
-</tr></table>
+
+ <dt><a href="commands/apidoc/src.html#src.catchAll.CatchAll">CatchAll (class in src.catchAll)</a>
+ </dt>
-<h2 id="E">E</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.ElementTree.Element">Element() (in module src.ElementTree)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.ElementTree.ElementTree">ElementTree (class in src.ElementTree)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.ElementTree.TreeBuilder.end">end() (src.ElementTree.TreeBuilder method)</a>
-</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>
- <li><a href="commands/apidoc/src.html#src.environment.Environ">Environ (class in src.environment)</a>
-</li>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinTerm.erase_line">erase_line() (src.colorama.winterm.WinTerm method)</a>
-</li>
- </ul></td>
- <td style="width: 33%; vertical-align: top;"><ul>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinTerm.erase_screen">erase_screen() (src.colorama.winterm.WinTerm method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.logger.Logger.error">error() (src.logger.Logger method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.pyconf.Container.evaluate">evaluate() (src.pyconf.Container method)</a>
-
- <ul>
- <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>
- <li><a href="commands/apidoc/src.html#src.pyconf.Expression">Expression (class in src.pyconf)</a>
-</li>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansitowin32.AnsiToWin32.extract_params">extract_params() (src.colorama.ansitowin32.AnsiToWin32 method)</a>
-</li>
- </ul></td>
-</tr></table>
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.change_to_launcher">change_to_launcher() (src.fileEnviron.LauncherFileEnviron method)</a>
+ </dt>
-<h2 id="F">F</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.ElementTree.XMLTreeBuilder.feed">feed() (src.ElementTree.XMLTreeBuilder method)</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.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>
- <li><a href="commands/apidoc/src.html#src.xmlManager.find_node_by_attrib">find_node_by_attrib() (in module src.xmlManager)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.ElementTree.ElementTree.findall">findall() (src.ElementTree.ElementTree method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.pyconf.Reference.findConfig">findConfig() (src.pyconf.Reference method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.ElementTree.ElementTree.findtext">findtext() (src.ElementTree.ElementTree method)</a>
-</li>
- <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.BashFileEnviron.finish">(src.fileEnviron.BashFileEnviron method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.fileEnviron.BatFileEnviron.finish">(src.fileEnviron.BatFileEnviron method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.fileEnviron.ContextFileEnviron.finish">(src.fileEnviron.ContextFileEnviron method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.fileEnviron.FileEnviron.finish">(src.fileEnviron.FileEnviron method)</a>
-</li>
- <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><a href="commands/apidoc/src.html#src.pyconf.ConfigOutputStream.flush">(src.pyconf.ConfigOutputStream method)</a>
-</li>
- </ul></li>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinTerm.fore">fore() (src.colorama.winterm.WinTerm method)</a>
-</li>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiCursor.FORWARD">FORWARD() (src.colorama.ansi.AnsiCursor method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.ElementTree.fromstring">fromstring() (in module src.ElementTree)</a>
-</li>
- </ul></td>
-</tr></table>
+
+ <dt><a href="commands/apidoc/src.html#src.compilation.Builder.check">check() (src.compilation.Builder method)</a>
+ </dt>
-<h2 id="G">G</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.test_module.Test.generate_launching_commands">generate_launching_commands() (src.test_module.Test method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.test_module.Test.generate_script">generate_script() (src.test_module.Test method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.environment.Environ.get">get() (src.environment.Environ method)</a>
-
- <ul>
- <li><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.get">(src.environment.SalomeEnviron method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.fileEnviron.BatFileEnviron.get">(src.fileEnviron.BatFileEnviron method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.fileEnviron.ContextFileEnviron.get">(src.fileEnviron.ContextFileEnviron method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.fileEnviron.FileEnviron.get">(src.fileEnviron.FileEnviron method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.get">(src.fileEnviron.LauncherFileEnviron method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.fileEnviron.ScreenEnviron.get">(src.fileEnviron.ScreenEnviron method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.pyconf.Mapping.get">(src.pyconf.Mapping method)</a>
-</li>
- </ul></li>
- <li><a href="commands/apidoc/src.html#src.xmlManager.ReadXmlFile.get_attrib">get_attrib() (src.xmlManager.ReadXmlFile method)</a>
-</li>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinTerm.get_attrs">get_attrs() (src.colorama.winterm.WinTerm method)</a>
-</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>
- <li><a href="commands/apidoc/src.html#src.__init__.get_cfg_param">get_cfg_param() (in module src.__init__)</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.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>
- <li><a href="commands/apidoc/src.html#src.__init__.get_log_path">get_log_path() (in module src.__init__)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.get_names">get_names() (src.environment.SalomeEnviron method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.architecture.get_nb_proc">get_nb_proc() (in module src.architecture)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.xmlManager.ReadXmlFile.get_node_text">get_node_text() (src.xmlManager.ReadXmlFile method)</a>
-</li>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinTerm.get_position">get_position() (src.colorama.winterm.WinTerm method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.product.get_product_components">get_product_components() (in module src.product)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.product.get_product_config">get_product_config() (in module src.product)</a>
-</li>
- </ul></td>
- <td style="width: 33%; vertical-align: top;"><ul>
- <li><a href="commands/apidoc/src.html#src.product.get_product_dependencies">get_product_dependencies() (in module src.product)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.product.get_product_section">get_product_section() (in module src.product)</a>
-</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>
- <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>
- <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>
- <li><a href="commands/apidoc/src.html#src.architecture.get_user">get_user() (in module src.architecture)</a>
-</li>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansitowin32.AnsiToWin32.get_win32_calls">get_win32_calls() (src.colorama.ansitowin32.AnsiToWin32 method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.pyconf.Config.getByPath">getByPath() (src.pyconf.Config method)</a>
-
- <ul>
- <li><a href="commands/apidoc/src.html#src.pyconf.ConfigList.getByPath">(src.pyconf.ConfigList method)</a>
-</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.ElementTree.ElementTree.getiterator">getiterator() (src.ElementTree.ElementTree method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.debug.getLocalEnv">getLocalEnv() (in module src.debug)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.ElementTree.ElementTree.getroot">getroot() (src.ElementTree.ElementTree method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.xmlManager.ReadXmlFile.getRootAttrib">getRootAttrib() (src.xmlManager.ReadXmlFile method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.debug.getStrConfigDbg">getStrConfigDbg() (in module src.debug)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.debug.getStrConfigStd">getStrConfigStd() (in module src.debug)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.test_module.getTmpDirDEFAULT">getTmpDirDEFAULT() (in module src.test_module)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.pyconf.ConfigReader.getToken">getToken() (src.pyconf.ConfigReader method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.system.git_extract">git_extract() (in module src.system)</a>
-</li>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiBack.GREEN">GREEN (src.colorama.ansi.AnsiBack attribute)</a>
-
- <ul>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiFore.GREEN">(src.colorama.ansi.AnsiFore attribute)</a>
-</li>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinColor.GREEN">(src.colorama.winterm.WinColor attribute)</a>
-</li>
- </ul></li>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinColor.GREY">GREY (src.colorama.winterm.WinColor attribute)</a>
-</li>
- </ul></td>
-</tr></table>
+
+ <dt><a href="commands/apidoc/src.html#src.product.check_config_exists">check_config_exists() (in module src.product)</a>
+ </dt>
-<h2 id="H">H</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.compilation.Builder.hack_libtool">hack_libtool() (src.compilation.Builder method)</a>
-</li>
- </ul></td>
- <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>
- </ul></td>
-</tr></table>
+
+ <dt><a href="commands/apidoc/src.html#src.utilsSat.check_config_has_application">check_config_has_application() (in module src.utilsSat)</a>
+ </dt>
-<h2 id="I">I</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.debug.indent">indent() (in module src.debug)</a>
-</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.debug.InStream">InStream (class in src.debug)</a>
-</li>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansitowin32.is_a_tty">is_a_tty() (in module src.colorama.ansitowin32)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.environment.Environ.is_defined">is_defined() (src.environment.Environ method)</a>
-
- <ul>
- <li><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.is_defined">(src.environment.SalomeEnviron method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.fileEnviron.FileEnviron.is_defined">(src.fileEnviron.FileEnviron method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.is_defined">(src.fileEnviron.LauncherFileEnviron method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.fileEnviron.ScreenEnviron.is_defined">(src.fileEnviron.ScreenEnviron method)</a>
-</li>
- </ul></li>
- </ul></td>
- <td style="width: 33%; vertical-align: top;"><ul>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansitowin32.is_stream_closed">is_stream_closed() (in module src.colorama.ansitowin32)</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>
- <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>
- <li><a href="commands/apidoc/src.html#src.__init__.Path.islink">islink() (src.__init__.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.html#src.pyconf.Mapping.iteritems">iteritems() (src.pyconf.Mapping method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.pyconf.Mapping.iterkeys">iterkeys() (src.pyconf.Mapping method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.ElementTree.iterparse">iterparse (class in src.ElementTree)</a>
-</li>
- </ul></td>
-</tr></table>
+
+ <dt><a href="commands/apidoc/src.html#src.utilsSat.check_config_has_profile">check_config_has_profile() (in module src.utilsSat)</a>
+ </dt>
-<h2 id="K">K</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.pyconf.Mapping.keys">keys() (src.pyconf.Mapping method)</a>
-</li>
- </ul></td>
-</tr></table>
+
+ <dt><a href="commands/apidoc/src.html#src.product.check_installation">check_installation() (in module src.product)</a>
+ </dt>
-<h2 id="L">L</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.fork.launch_command">launch_command() (in module src.fork)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron">LauncherFileEnviron (class in src.fileEnviron)</a>
-</li>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiBack.LIGHTBLACK_EX">LIGHTBLACK_EX (src.colorama.ansi.AnsiBack attribute)</a>
-
- <ul>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiFore.LIGHTBLACK_EX">(src.colorama.ansi.AnsiFore attribute)</a>
-</li>
- </ul></li>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiBack.LIGHTBLUE_EX">LIGHTBLUE_EX (src.colorama.ansi.AnsiBack attribute)</a>
-
- <ul>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiFore.LIGHTBLUE_EX">(src.colorama.ansi.AnsiFore attribute)</a>
-</li>
- </ul></li>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiBack.LIGHTCYAN_EX">LIGHTCYAN_EX (src.colorama.ansi.AnsiBack attribute)</a>
-
- <ul>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiFore.LIGHTCYAN_EX">(src.colorama.ansi.AnsiFore attribute)</a>
-</li>
- </ul></li>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiBack.LIGHTGREEN_EX">LIGHTGREEN_EX (src.colorama.ansi.AnsiBack attribute)</a>
-
- <ul>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiFore.LIGHTGREEN_EX">(src.colorama.ansi.AnsiFore attribute)</a>
-</li>
- </ul></li>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiBack.LIGHTMAGENTA_EX">LIGHTMAGENTA_EX (src.colorama.ansi.AnsiBack attribute)</a>
-
- <ul>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiFore.LIGHTMAGENTA_EX">(src.colorama.ansi.AnsiFore attribute)</a>
-</li>
- </ul></li>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiBack.LIGHTRED_EX">LIGHTRED_EX (src.colorama.ansi.AnsiBack attribute)</a>
-
- <ul>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiFore.LIGHTRED_EX">(src.colorama.ansi.AnsiFore attribute)</a>
-</li>
- </ul></li>
- </ul></td>
- <td style="width: 33%; vertical-align: top;"><ul>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiBack.LIGHTWHITE_EX">LIGHTWHITE_EX (src.colorama.ansi.AnsiBack attribute)</a>
-
- <ul>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiFore.LIGHTWHITE_EX">(src.colorama.ansi.AnsiFore attribute)</a>
-</li>
- </ul></li>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiBack.LIGHTYELLOW_EX">LIGHTYELLOW_EX (src.colorama.ansi.AnsiBack attribute)</a>
-
- <ul>
- <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>
- <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.html#src.pyconf.Config.load">load() (src.pyconf.Config method)</a>
-
- <ul>
- <li><a href="commands/apidoc/src.html#src.pyconf.ConfigReader.load">(src.pyconf.ConfigReader method)</a>
-</li>
- </ul></li>
- <li><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.load_cfg_environment">load_cfg_environment() (src.environment.SalomeEnviron method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.environment.load_environment">load_environment() (in module src.environment)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.pyconf.ConfigReader.location">location() (src.pyconf.ConfigReader method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.compilation.Builder.log">log() (src.compilation.Builder method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.compilation.Builder.log_command">log_command() (src.compilation.Builder method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.logger.Logger">Logger (class in src.logger)</a>
-</li>
- </ul></td>
-</tr></table>
+
+ <dt><a href="commands/apidoc/src.html#src.configManager.check_path">check_path() (in module src.configManager)</a>
+ </dt>
-<h2 id="M">M</h2>
-<table style="width: 100%" class="indextable genindextable"><tr>
- <td style="width: 33%; vertical-align: top;"><ul>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiBack.MAGENTA">MAGENTA (src.colorama.ansi.AnsiBack attribute)</a>
-
- <ul>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiFore.MAGENTA">(src.colorama.ansi.AnsiFore attribute)</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>
-
- <ul>
- <li><a href="commands/apidoc/src.html#src.compilation.Builder.make">(src.compilation.Builder method)</a>
-</li>
- </ul></li>
- <li><a href="commands/apidoc/src.html#src.pyconf.makePath">makePath() (in module src.pyconf)</a>
-</li>
- </ul></td>
- <td style="width: 33%; vertical-align: top;"><ul>
- <li><a href="commands/apidoc/src.html#src.pyconf.Mapping">Mapping (class in src.pyconf)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.pyconf.ConfigReader.match">match() (src.pyconf.ConfigReader method)</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>
- <li><a href="commands/apidoc/src.html#src.pyconf.ConfigMerger.mergeMapping">mergeMapping() (src.pyconf.ConfigMerger method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.pyconf.ConfigMerger.mergeSequence">mergeSequence() (src.pyconf.ConfigMerger method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.template.MyTemplate">MyTemplate (class in src.template)</a>
-</li>
- </ul></td>
-</tr></table>
+
+ <dt><a href="commands/apidoc/src.html#src.utilsSat.Path.chmod">chmod() (src.utilsSat.Path method)</a>
+ </dt>
-<h2 id="N">N</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.ElementTree.iterparse.next">next() (src.ElementTree.iterparse method)</a>
-
- <ul>
- <li><a href="commands/apidoc/src.html#src.pyconf.Sequence.SeqIter.next">(src.pyconf.Sequence.SeqIter method)</a>
-</li>
- </ul></li>
- </ul></td>
- <td style="width: 33%; vertical-align: top;"><ul>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiStyle.NORMAL">NORMAL (src.colorama.ansi.AnsiStyle attribute)</a>
-
- <ul>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinStyle.NORMAL">(src.colorama.winterm.WinStyle attribute)</a>
-</li>
- </ul></li>
- </ul></td>
-</tr></table>
+
+ <dt><a href="commands/apidoc/src.html#src.coloringSat.cleanColors">cleanColors() (in module src.coloringSat)</a>
+ </dt>
-<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>
- <li><a href="commands/apidoc/src.html#src.options.Options">Options (class in src.options)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.options.OptResult">OptResult (class in src.options)</a>
-</li>
- </ul></td>
- <td style="width: 33%; vertical-align: top;"><ul>
- <li><a href="commands/apidoc/src.html#src.debug.OutStream">OutStream (class in src.debug)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.pyconf.ConfigMerger.overwriteKeys">overwriteKeys() (src.pyconf.ConfigMerger method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.pyconf.overwriteMergeResolve">overwriteMergeResolve() (in module src.pyconf)</a>
-</li>
- </ul></td>
-</tr></table>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.clear_line">clear_line() (in module src.colorama.ansi)</a>
+ </dt>
-<h2 id="P">P</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.ElementTree.parse">parse() (in module src.ElementTree)</a>
-
- <ul>
- <li><a href="commands/apidoc/src.html#src.ElementTree.ElementTree.parse">(src.ElementTree.ElementTree method)</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>
- <li><a href="commands/apidoc/src.html#src.pyconf.ConfigReader.parseFactor">parseFactor() (src.pyconf.ConfigReader method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.pyconf.ConfigReader.parseKeyValuePair">parseKeyValuePair() (src.pyconf.ConfigReader method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.pyconf.ConfigReader.parseMapping">parseMapping() (src.pyconf.ConfigReader method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.pyconf.ConfigReader.parseMappingBody">parseMappingBody() (src.pyconf.ConfigReader method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.pyconf.ConfigReader.parseReference">parseReference() (src.pyconf.ConfigReader method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.pyconf.ConfigReader.parseScalar">parseScalar() (src.pyconf.ConfigReader method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.pyconf.ConfigReader.parseSequence">parseSequence() (src.pyconf.ConfigReader method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.pyconf.ConfigReader.parseSuffix">parseSuffix() (src.pyconf.ConfigReader method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.pyconf.ConfigReader.parseTerm">parseTerm() (src.pyconf.ConfigReader method)</a>
-</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>
- <li><a href="commands/apidoc/src.html#src.template.MyTemplate.pattern">pattern (src.template.MyTemplate attribute)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.ElementTree.PI">PI() (in module src.ElementTree)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.debug.pop_debug">pop_debug() (in module src.debug)</a>
-</li>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiCursor.POS">POS() (src.colorama.ansi.AnsiCursor method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.compilation.Builder.prepare">prepare() (src.compilation.Builder method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.test_module.Test.prepare_testbase">prepare_testbase() (src.test_module.Test method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.test_module.Test.prepare_testbase_from_dir">prepare_testbase_from_dir() (src.test_module.Test method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.test_module.Test.prepare_testbase_from_git">prepare_testbase_from_git() (src.test_module.Test method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.test_module.Test.prepare_testbase_from_svn">prepare_testbase_from_svn() (src.test_module.Test method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.environment.Environ.prepend">prepend() (src.environment.Environ method)</a>
-
- <ul>
- <li><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.prepend">(src.environment.SalomeEnviron method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.fileEnviron.FileEnviron.prepend">(src.fileEnviron.FileEnviron method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.prepend">(src.fileEnviron.LauncherFileEnviron method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.fileEnviron.ScreenEnviron.prepend">(src.fileEnviron.ScreenEnviron method)</a>
-</li>
- </ul></li>
- <li><a href="commands/apidoc/src.html#src.environment.Environ.prepend_value">prepend_value() (src.environment.Environ method)</a>
-
- <ul>
- <li><a href="commands/apidoc/src.html#src.fileEnviron.ContextFileEnviron.prepend_value">(src.fileEnviron.ContextFileEnviron method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.fileEnviron.FileEnviron.prepend_value">(src.fileEnviron.FileEnviron method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.prepend_value">(src.fileEnviron.LauncherFileEnviron method)</a>
-</li>
- </ul></li>
- <li><a href="commands/apidoc/src.html#src.printcolors.print_color_map">print_color_map() (in module src.printcolors)</a>
-</li>
- </ul></td>
- <td style="width: 33%; vertical-align: top;"><ul>
- <li><a href="commands/apidoc/src.html#src.printcolors.print_color_range">print_color_range() (in module src.printcolors)</a>
-</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>
- <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.printcolors.printc">printc() (in module src.printcolors)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.printcolors.printcError">printcError() (in module src.printcolors)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.printcolors.printcHeader">printcHeader() (in module src.printcolors)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.printcolors.printcHighlight">printcHighlight() (in module src.printcolors)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.printcolors.printcInfo">printcInfo() (in module src.printcolors)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.printcolors.printcLabel">printcLabel() (in module src.printcolors)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.printcolors.printcSuccess">printcSuccess() (in module src.printcolors)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.printcolors.printcWarning">printcWarning() (in module src.printcolors)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.ElementTree.ProcessingInstruction">ProcessingInstruction() (in module src.ElementTree)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.product.product_compiles">product_compiles() (in module src.product)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.product.product_has_env_script">product_has_env_script() (in module src.product)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.product.product_has_logo">product_has_logo() (in module src.product)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.product.product_has_patches">product_has_patches() (in module src.product)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.product.product_has_salome_gui">product_has_salome_gui() (in module src.product)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.product.product_has_script">product_has_script() (in module src.product)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.product.product_is_autotools">product_is_autotools() (in module src.product)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.product.product_is_cmake">product_is_cmake() (in module src.product)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.product.product_is_cpp">product_is_cpp() (in module src.product)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.product.product_is_debug">product_is_debug() (in module src.product)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.product.product_is_dev">product_is_dev() (in module src.product)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.product.product_is_fixed">product_is_fixed() (in module src.product)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.product.product_is_generated">product_is_generated() (in module src.product)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.product.product_is_mpi">product_is_mpi() (in module src.product)</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.debug.push_debug">push_debug() (in module src.debug)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.logger.Logger.put_initial_xml_fields">put_initial_xml_fields() (src.logger.Logger method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.compilation.Builder.put_txt_log_in_appli_log_dir">put_txt_log_in_appli_log_dir() (src.compilation.Builder method)</a>
-</li>
- </ul></td>
-</tr></table>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.clear_screen">clear_screen() (in module src.colorama.ansi)</a>
+ </dt>
-<h2 id="Q">Q</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.ElementTree.QName">QName (class in src.ElementTree)</a>
-</li>
- </ul></td>
-</tr></table>
+
+ <dt><a href="commands/apidoc/src.html#src.debug.OutStream.close">close() (src.debug.OutStream method)</a>
+ </dt>
-<h2 id="R">R</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.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>
- <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>
- <li><a href="commands/apidoc/src.html#src.xmlManager.ReadXmlFile">ReadXmlFile (class in src.xmlManager)</a>
-</li>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiBack.RED">RED (src.colorama.ansi.AnsiBack attribute)</a>
-
- <ul>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiFore.RED">(src.colorama.ansi.AnsiFore attribute)</a>
-</li>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinColor.RED">(src.colorama.winterm.WinColor attribute)</a>
-</li>
- </ul></li>
- <li><a href="commands/apidoc/src.html#src.pyconf.Reference">Reference (class in src.pyconf)</a>
-</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>
- <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>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiBack.RESET">RESET (src.colorama.ansi.AnsiBack attribute)</a>
-
- <ul>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiFore.RESET">(src.colorama.ansi.AnsiFore attribute)</a>
-</li>
- </ul></li>
- </ul></td>
- <td style="width: 33%; vertical-align: top;"><ul>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiStyle.RESET_ALL">RESET_ALL (src.colorama.ansi.AnsiStyle attribute)</a>
-</li>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.initialise.reset_all">reset_all() (in module src.colorama.initialise)</a>
-
- <ul>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansitowin32.AnsiToWin32.reset_all">(src.colorama.ansitowin32.AnsiToWin32 method)</a>
-</li>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinTerm.reset_all">(src.colorama.winterm.WinTerm method)</a>
-</li>
- </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>
- <li><a href="commands/apidoc/src.html#src.test_module.Test.run_all_tests">run_all_tests() (src.test_module.Test method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.run_env_script">run_env_script() (src.environment.SalomeEnviron method)</a>
-
- <ul>
- <li><a href="commands/apidoc/src.html#src.fileEnviron.ScreenEnviron.run_env_script">(src.fileEnviron.ScreenEnviron method)</a>
-</li>
- </ul></li>
- <li><a href="commands/apidoc/src.html#src.test_module.Test.run_grid_tests">run_grid_tests() (src.test_module.Test method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.test_module.Test.run_script">run_script() (src.test_module.Test method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.test_module.Test.run_session_tests">run_session_tests() (src.test_module.Test method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.run_simple_env_script">run_simple_env_script() (src.environment.SalomeEnviron method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.test_module.Test.run_testbase_tests">run_testbase_tests() (src.test_module.Test method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.test_module.Test.run_tests">run_tests() (src.test_module.Test method)</a>
-</li>
- </ul></td>
-</tr></table>
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.ElementTree.TreeBuilder.close">(src.ElementTree.TreeBuilder method)</a>
+ </dt>
-<h2 id="S">S</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.environment.SalomeEnviron">SalomeEnviron (class in src.environment)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.__init__.SatException">SatException</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.debug.saveConfigDbg">saveConfigDbg() (in module src.debug)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.debug.saveConfigStd">saveConfigStd() (in module src.debug)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.fileEnviron.ScreenEnviron">ScreenEnviron (class in src.fileEnviron)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.test_module.Test.search_known_errors">search_known_errors() (src.test_module.Test method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.pyconf.Sequence">Sequence (class in src.pyconf)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.pyconf.Sequence.SeqIter">Sequence.SeqIter (class in src.pyconf)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.environment.Environ.set">set() (src.environment.Environ method)</a>
-
- <ul>
- <li><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.set">(src.environment.SalomeEnviron method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.fileEnviron.BashFileEnviron.set">(src.fileEnviron.BashFileEnviron method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.fileEnviron.BatFileEnviron.set">(src.fileEnviron.BatFileEnviron method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.fileEnviron.ContextFileEnviron.set">(src.fileEnviron.ContextFileEnviron method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.fileEnviron.FileEnviron.set">(src.fileEnviron.FileEnviron method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.set">(src.fileEnviron.LauncherFileEnviron method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.fileEnviron.ScreenEnviron.set">(src.fileEnviron.ScreenEnviron method)</a>
-</li>
- </ul></li>
- <li><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.set_a_product">set_a_product() (src.environment.SalomeEnviron method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.set_application_env">set_application_env() (src.environment.SalomeEnviron method)</a>
-</li>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinTerm.set_attrs">set_attrs() (src.colorama.winterm.WinTerm method)</a>
-</li>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinTerm.set_console">set_console() (src.colorama.winterm.WinTerm method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.set_cpp_env">set_cpp_env() (src.environment.SalomeEnviron method)</a>
-</li>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinTerm.set_cursor_position">set_cursor_position() (src.colorama.winterm.WinTerm method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.set_full_environ">set_full_environ() (src.environment.SalomeEnviron method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.set_products">set_products() (src.environment.SalomeEnviron method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.set_python_libdirs">set_python_libdirs() (src.environment.SalomeEnviron method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.set_salome_generic_product_env">set_salome_generic_product_env() (src.environment.SalomeEnviron method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.set_salome_minimal_product_env">set_salome_minimal_product_env() (src.environment.SalomeEnviron method)</a>
-</li>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.set_title">set_title() (in module src.colorama.ansi)</a>
-
- <ul>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinTerm.set_title">(src.colorama.winterm.WinTerm method)</a>
-</li>
- </ul></li>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.win32.SetConsoleTextAttribute">SetConsoleTextAttribute() (in module src.colorama.win32)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.pyconf.Container.setPath">setPath() (src.pyconf.Container method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.pyconf.ConfigReader.setStream">setStream() (src.pyconf.ConfigReader method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.environment.Shell">Shell (class in src.environment)</a>
-</li>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansitowin32.AnsiToWin32.should_wrap">should_wrap() (src.colorama.ansitowin32.AnsiToWin32 method)</a>
-</li>
- </ul></td>
- <td style="width: 33%; vertical-align: top;"><ul>
- <li><a href="commands/apidoc/src.html#src.logger.show_command_log">show_command_log() (in module src.logger)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.system.show_in_editor">show_in_editor() (in module src.system)</a>
-</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>
- <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>
- <li><a href="commands/apidoc/src.html#module-src.architecture">src.architecture (module)</a>
-</li>
- <li><a href="commands/apidoc/src.colorama.html#module-src.colorama">src.colorama (module)</a>
-</li>
- <li><a href="commands/apidoc/src.colorama.html#module-src.colorama.ansi">src.colorama.ansi (module)</a>
-</li>
- <li><a href="commands/apidoc/src.colorama.html#module-src.colorama.ansitowin32">src.colorama.ansitowin32 (module)</a>
-</li>
- <li><a href="commands/apidoc/src.colorama.html#module-src.colorama.initialise">src.colorama.initialise (module)</a>
-</li>
- <li><a href="commands/apidoc/src.colorama.html#module-src.colorama.win32">src.colorama.win32 (module)</a>
-</li>
- <li><a href="commands/apidoc/src.colorama.html#module-src.colorama.winterm">src.colorama.winterm (module)</a>
-</li>
- <li><a href="commands/apidoc/src.html#module-src.compilation">src.compilation (module)</a>
-</li>
- <li><a href="commands/apidoc/src.html#module-src.debug">src.debug (module)</a>
-</li>
- <li><a href="commands/apidoc/src.html#module-src.ElementTree">src.ElementTree (module)</a>
-</li>
- <li><a href="commands/apidoc/src.html#module-src.environment">src.environment (module)</a>
-</li>
- <li><a href="commands/apidoc/src.html#module-src.fileEnviron">src.fileEnviron (module)</a>
-</li>
- <li><a href="commands/apidoc/src.html#module-src.fork">src.fork (module)</a>
-</li>
- <li><a href="commands/apidoc/src.html#module-src.logger">src.logger (module)</a>
-</li>
- <li><a href="commands/apidoc/src.html#module-src.options">src.options (module)</a>
-</li>
- <li><a href="commands/apidoc/src.html#module-src.printcolors">src.printcolors (module)</a>
-</li>
- <li><a href="commands/apidoc/src.html#module-src.product">src.product (module)</a>
-</li>
- <li><a href="commands/apidoc/src.html#module-src.pyconf">src.pyconf (module)</a>
-</li>
- <li><a href="commands/apidoc/src.html#module-src.system">src.system (module)</a>
-</li>
- <li><a href="commands/apidoc/src.html#module-src.template">src.template (module)</a>
-</li>
- <li><a href="commands/apidoc/src.html#module-src.test_module">src.test_module (module)</a>
-</li>
- <li><a href="commands/apidoc/src.html#module-src.xmlManager">src.xmlManager (module)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.ElementTree.TreeBuilder.start">start() (src.ElementTree.TreeBuilder method)</a>
-</li>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansitowin32.StreamWrapper">StreamWrapper (class in src.colorama.ansitowin32)</a>
-</li>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinTerm.style">style() (src.colorama.winterm.WinTerm method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.ElementTree.SubElement">SubElement() (in module src.ElementTree)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.template.substitute">substitute() (in module src.template)</a>
-</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>
- </ul></td>
-</tr></table>
+
+ <dt><a href="commands/apidoc/src.html#src.ElementTree.XMLTreeBuilder.close">(src.ElementTree.XMLTreeBuilder method)</a>
+ </dt>
-<h2 id="T">T</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.test_module.Test">Test (class in src.test_module)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.logger.timedelta_total_seconds">timedelta_total_seconds() (in module src.logger)</a>
-</li>
- </ul></td>
- <td style="width: 33%; vertical-align: top;"><ul>
- <li><a href="commands/apidoc/src.html#src.debug.tofix">tofix() (in module src.debug)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.ElementTree.tostring">tostring() (in module src.ElementTree)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.ElementTree.TreeBuilder">TreeBuilder (class in src.ElementTree)</a>
-</li>
- </ul></td>
-</tr></table>
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigInputStream.close">(src.pyconf.ConfigInputStream method)</a>
+ </dt>
-<h2 id="U">U</h2>
-<table style="width: 100%" class="indextable genindextable"><tr>
- <td style="width: 33%; vertical-align: top;"><ul>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiCursor.UP">UP() (src.colorama.ansi.AnsiCursor method)</a>
-</li>
- </ul></td>
- <td style="width: 33%; vertical-align: top;"><ul>
- <li><a href="commands/apidoc/src.html#src.logger.update_hat_xml">update_hat_xml() (in module src.logger)</a>
-</li>
- </ul></td>
-</tr></table>
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigOutputStream.close">(src.pyconf.ConfigOutputStream method)</a>
+ </dt>
-<h2 id="W">W</h2>
-<table style="width: 100%" class="indextable genindextable"><tr>
- <td style="width: 33%; vertical-align: top;"><ul>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiBack.WHITE">WHITE (src.colorama.ansi.AnsiBack attribute)</a>
-
- <ul>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiFore.WHITE">(src.colorama.ansi.AnsiFore attribute)</a>
-</li>
- </ul></li>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.win32.winapi_test">winapi_test() (in module src.colorama.win32)</a>
-</li>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinColor">WinColor (class in src.colorama.winterm)</a>
-</li>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinStyle">WinStyle (class in src.colorama.winterm)</a>
-</li>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinTerm">WinTerm (class in src.colorama.winterm)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.compilation.Builder.wmake">wmake() (src.compilation.Builder method)</a>
-</li>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.initialise.wrap_stream">wrap_stream() (in module src.colorama.initialise)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.debug.write">write() (in module src.debug)</a>
-
- <ul>
- <li><a href="commands/apidoc/src.html#src.ElementTree.ElementTree.write">(src.ElementTree.ElementTree method)</a>
-</li>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansitowin32.AnsiToWin32.write">(src.colorama.ansitowin32.AnsiToWin32 method)</a>
-</li>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansitowin32.StreamWrapper.write">(src.colorama.ansitowin32.StreamWrapper method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.fileEnviron.ScreenEnviron.write">(src.fileEnviron.ScreenEnviron method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.logger.Logger.write">(src.logger.Logger method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.pyconf.ConfigOutputStream.write">(src.pyconf.ConfigOutputStream method)</a>
-</li>
- </ul></li>
- </ul></td>
- <td style="width: 33%; vertical-align: top;"><ul>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansitowin32.AnsiToWin32.write_and_convert">write_and_convert() (src.colorama.ansitowin32.AnsiToWin32 method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.fork.write_back">write_back() (in module src.fork)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.environment.FileEnvWriter.write_cfgForPy_file">write_cfgForPy_file() (src.environment.FileEnvWriter method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.environment.FileEnvWriter.write_env_file">write_env_file() (src.environment.FileEnvWriter method)</a>
-</li>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansitowin32.AnsiToWin32.write_plain_text">write_plain_text() (src.colorama.ansitowin32.AnsiToWin32 method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.xmlManager.write_report">write_report() (in module src.xmlManager)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.test_module.Test.write_test_margin">write_test_margin() (src.test_module.Test method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.xmlManager.XmlLogFile.write_tree">write_tree() (src.xmlManager.XmlLogFile method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.pyconf.Container.writeToStream">writeToStream() (src.pyconf.Container method)</a>
-
- <ul>
- <li><a href="commands/apidoc/src.html#src.pyconf.Mapping.writeToStream">(src.pyconf.Mapping method)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.pyconf.Sequence.writeToStream">(src.pyconf.Sequence method)</a>
-</li>
- </ul></li>
- <li><a href="commands/apidoc/src.html#src.pyconf.Container.writeValue">writeValue() (src.pyconf.Container method)</a>
-</li>
- </ul></td>
-</tr></table>
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.html#src.compilation.Builder.cmake">cmake() (src.compilation.Builder method)</a>
+ </dt>
-<h2 id="X">X</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.ElementTree.XML">XML() (in module src.ElementTree)</a>
-</li>
- </ul></td>
- <td style="width: 33%; vertical-align: top;"><ul>
- <li><a href="commands/apidoc/src.html#src.xmlManager.XmlLogFile">XmlLogFile (class in src.xmlManager)</a>
-</li>
- <li><a href="commands/apidoc/src.html#src.ElementTree.XMLTreeBuilder">XMLTreeBuilder (class in src.ElementTree)</a>
-</li>
- </ul></td>
-</tr></table>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.code_to_chars">code_to_chars() (in module src.colorama.ansi)</a>
+ </dt>
-<h2 id="Y">Y</h2>
-<table style="width: 100%" class="indextable genindextable"><tr>
- <td style="width: 33%; vertical-align: top;"><ul>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiBack.YELLOW">YELLOW (src.colorama.ansi.AnsiBack attribute)</a>
-
- <ul>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiFore.YELLOW">(src.colorama.ansi.AnsiFore attribute)</a>
-</li>
- <li><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinColor.YELLOW">(src.colorama.winterm.WinColor attribute)</a>
-</li>
- </ul></li>
- </ul></td>
-</tr></table>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.initialise.colorama_text">colorama_text() (in module src.colorama.initialise)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.coloringSat.ColoringStream">ColoringStream (class in src.coloringSat)</a>
+ </dt>
+
+ <dt><a href="commands/apidoc/src.html#src.environment.Environ.command_value">command_value() (src.environment.Environ method)</a>
+ </dt>
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.BashFileEnviron.command_value">(src.fileEnviron.BashFileEnviron method)</a>
+ </dt>
- </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>
- </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>
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.BatFileEnviron.command_value">(src.fileEnviron.BatFileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.ContextFileEnviron.command_value">(src.fileEnviron.ContextFileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.FileEnviron.command_value">(src.fileEnviron.FileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.command_value">(src.fileEnviron.LauncherFileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.ScreenEnviron.command_value">(src.fileEnviron.ScreenEnviron method)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.html#src.ElementTree.Comment">Comment() (in module src.ElementTree)</a>
+ </dt>
+
+ </dl></td>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.compilation.Builder.complete_environment">complete_environment() (src.compilation.Builder method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.Config">Config (class in src.pyconf)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.Config.Namespace">Config.Namespace (class in src.pyconf)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.utilsSat.config_has_application">config_has_application() (in module src.utilsSat)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigError">ConfigError</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigFormatError">ConfigFormatError</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigInputStream">ConfigInputStream (class in src.pyconf)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigList">ConfigList (class in src.pyconf)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.configManager.ConfigManager">ConfigManager (class in src.configManager)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigMerger">ConfigMerger (class in src.pyconf)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.configManager.ConfigOpener">ConfigOpener (class in src.configManager)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigOutputStream">ConfigOutputStream (class in src.pyconf)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigReader">ConfigReader (class in src.pyconf)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigResolutionError">ConfigResolutionError</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.compilation.Builder.configure">configure() (src.compilation.Builder method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.Container">Container (class in src.pyconf)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.ContextFileEnviron">ContextFileEnviron (class in src.fileEnviron)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansitowin32.AnsiToWin32.convert_ansi">convert_ansi() (src.colorama.ansitowin32.AnsiToWin32 method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansitowin32.AnsiToWin32.convert_osc">convert_osc() (src.colorama.ansitowin32.AnsiToWin32 method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.utilsSat.Path.copy">copy() (src.utilsSat.Path method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.utilsSat.Path.copydir">copydir() (src.utilsSat.Path method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.utilsSat.Path.copyfile">copyfile() (src.utilsSat.Path method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.utilsSat.Path.copylink">copylink() (src.utilsSat.Path method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.configManager.ConfigManager.create_config_file">create_config_file() (src.configManager.ConfigManager method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.utilsSat.critical">critical() (in module src.utilsSat)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinTerm.cursor_adjust">cursor_adjust() (src.colorama.winterm.WinTerm method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.system.cvs_extract">cvs_extract() (in module src.system)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiBack.CYAN">CYAN (src.colorama.ansi.AnsiBack attribute)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiFore.CYAN">(src.colorama.ansi.AnsiFore attribute)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinColor.CYAN">(src.colorama.winterm.WinColor attribute)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.html#src.utilsSat.cyan">cyan() (in module src.utilsSat)</a>
+ </dt>
+
+ </dl></td>
+</tr></table>
+
+<h2 id="D">D</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.ElementTree.TreeBuilder.data">data() (src.ElementTree.TreeBuilder method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.utilsSat.date_to_datetime">date_to_datetime() (in module src.utilsSat)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.options.Options.debug_write">debug_write() (src.options.Options method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.utilsSat.deepcopy_list">deepcopy_list() (in module src.utilsSat)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.deepCopyMapping">deepCopyMapping() (in module src.pyconf)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.loggingSat.DefaultFormatter">DefaultFormatter (class in src.loggingSat)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.defaultMergeResolve">defaultMergeResolve() (in module src.pyconf)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.defaultStreamOpener">defaultStreamOpener() (in module src.pyconf)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.initialise.deinit">deinit() (in module src.colorama.initialise)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.template.MyTemplate.delimiter">delimiter (src.template.MyTemplate attribute)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiStyle.DIM">DIM (src.colorama.ansi.AnsiStyle attribute)</a>
+ </dt>
+
+ </dl></td>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.utilsSat.Path.dir">dir() (src.utilsSat.Path method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.loggingSat.dirLogger">dirLogger() (in module src.loggingSat)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.compilation.Builder.do_batch_script_build">do_batch_script_build() (src.compilation.Builder method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.compilation.Builder.do_default_build">do_default_build() (src.compilation.Builder method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.compilation.Builder.do_python_script_build">do_python_script_build() (src.compilation.Builder method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.compilation.Builder.do_script_build">do_script_build() (src.compilation.Builder method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.ElementTree.XMLTreeBuilder.doctype">doctype() (src.ElementTree.XMLTreeBuilder method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiCursor.DOWN">DOWN() (src.colorama.ansi.AnsiCursor method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.ElementTree.dump">dump() (in module src.ElementTree)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.dump">(src.environment.SalomeEnviron method)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.html#src.catchAll.dumper">dumper() (in module src.catchAll)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.catchAll.dumperType">dumperType() (in module src.catchAll)</a>
+ </dt>
+
+ </dl></td>
+</tr></table>
+
+<h2 id="E">E</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.ElementTree.Element">Element() (in module src.ElementTree)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.ElementTree.ElementTree">ElementTree (class in src.ElementTree)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.ElementTree.TreeBuilder.end">end() (src.ElementTree.TreeBuilder method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.utilsSat.ensure_path_exists">ensure_path_exists() (in module src.utilsSat)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.environment.Environ">Environ (class in src.environment)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinTerm.erase_line">erase_line() (src.colorama.winterm.WinTerm method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinTerm.erase_screen">erase_screen() (src.colorama.winterm.WinTerm method)</a>
+ </dt>
+
+ </dl></td>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.utilsSat.error">error() (in module src.utilsSat)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.Container.evaluate">evaluate() (src.pyconf.Container method)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.Expression.evaluate">(src.pyconf.Expression method)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.html#src.exceptionSat.ExceptionSat">ExceptionSat</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.salomeTools.Sat.execute_cli">execute_cli() (src.salomeTools.Sat method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.utilsSat.Path.exists">exists() (src.utilsSat.Path method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.Expression">Expression (class in src.pyconf)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansitowin32.AnsiToWin32.extract_params">extract_params() (src.colorama.ansitowin32.AnsiToWin32 method)</a>
+ </dt>
+
+ </dl></td>
+</tr></table>
+
+<h2 id="F">F</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.ElementTree.XMLTreeBuilder.feed">feed() (src.ElementTree.XMLTreeBuilder method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.FileEnviron">FileEnviron (class in src.fileEnviron)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.environment.FileEnvWriter">FileEnvWriter (class in src.environment)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.ElementTree.ElementTree.find">find() (src.ElementTree.ElementTree method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.salomeTools.find_command_list">find_command_list() (in module src.salomeTools)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.utilsSat.find_file_in_lpath">find_file_in_lpath() (in module src.utilsSat)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.xmlManager.find_node_by_attrib">find_node_by_attrib() (in module src.xmlManager)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.ElementTree.ElementTree.findall">findall() (src.ElementTree.ElementTree method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.Reference.findConfig">findConfig() (src.pyconf.Reference method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.ElementTree.ElementTree.findtext">findtext() (src.ElementTree.ElementTree method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.finish">finish() (src.environment.SalomeEnviron method)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.BashFileEnviron.finish">(src.fileEnviron.BashFileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.BatFileEnviron.finish">(src.fileEnviron.BatFileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.ContextFileEnviron.finish">(src.fileEnviron.ContextFileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.FileEnviron.finish">(src.fileEnviron.FileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.finish">(src.fileEnviron.LauncherFileEnviron method)</a>
+ </dt>
+
+ </dl></dd>
+ </dl></td>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.coloringSat.ColoringStream.flush">flush() (src.coloringSat.ColoringStream method)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.loggingSat.UnittestStream.flush">(src.loggingSat.UnittestStream method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigOutputStream.flush">(src.pyconf.ConfigOutputStream method)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinTerm.fore">fore() (src.colorama.winterm.WinTerm method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.example.html#src.example.essai_logging_2.MyFormatter.format">format() (src.example.essai_logging_2.MyFormatter method)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.loggingSat.DefaultFormatter.format">(src.loggingSat.DefaultFormatter method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.loggingSat.UnittestFormatter.format">(src.loggingSat.UnittestFormatter method)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.html#src.utilsSat.formatTuples">formatTuples() (in module src.utilsSat)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.utilsSat.formatValue">formatValue() (in module src.utilsSat)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiCursor.FORWARD">FORWARD() (src.colorama.ansi.AnsiCursor method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.ElementTree.fromstring">fromstring() (in module src.ElementTree)</a>
+ </dt>
+
+ </dl></td>
+</tr></table>
+
+<h2 id="G">G</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.test_module.Test.generate_launching_commands">generate_launching_commands() (src.test_module.Test method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.test_module.Test.generate_script">generate_script() (src.test_module.Test method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.environment.Environ.get">get() (src.environment.Environ method)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.get">(src.environment.SalomeEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.BatFileEnviron.get">(src.fileEnviron.BatFileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.ContextFileEnviron.get">(src.fileEnviron.ContextFileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.FileEnviron.get">(src.fileEnviron.FileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.get">(src.fileEnviron.LauncherFileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.ScreenEnviron.get">(src.fileEnviron.ScreenEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.Mapping.get">(src.pyconf.Mapping method)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.html#src.xmlManager.ReadXmlFile.get_attrib">get_attrib() (src.xmlManager.ReadXmlFile method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinTerm.get_attrs">get_attrs() (src.colorama.winterm.WinTerm method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.product.get_base_install_dir">get_base_install_dir() (in module src.product)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.utilsSat.get_base_path">get_base_path() (in module src.utilsSat)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.utilsSat.get_cfg_param">get_cfg_param() (in module src.utilsSat)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.configManager.ConfigManager.get_command_line_overrides">get_command_line_overrides() (src.configManager.ConfigManager method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.configManager.ConfigManager.get_config">get_config() (src.configManager.ConfigManager method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.configManager.get_config_children">get_config_children() (in module src.configManager)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.architecture.get_distrib_version">get_distrib_version() (in module src.architecture)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.architecture.get_distribution">get_distribution() (in module src.architecture)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.get_file_environ">get_file_environ() (in module src.fileEnviron)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.options.Options.get_help">get_help() (src.options.Options method)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.salomeTools.Sat.get_help">(src.salomeTools.Sat method)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.html#src.product.get_install_dir">get_install_dir() (in module src.product)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.utilsSat.get_launcher_name">get_launcher_name() (in module src.utilsSat)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.utilsSat.get_log_path">get_log_path() (in module src.utilsSat)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.get_names">get_names() (src.environment.SalomeEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.architecture.get_nb_proc">get_nb_proc() (in module src.architecture)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.xmlManager.ReadXmlFile.get_node_text">get_node_text() (src.xmlManager.ReadXmlFile method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.configManager.ConfigOpener.get_path">get_path() (src.configManager.ConfigOpener method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinTerm.get_position">get_position() (src.colorama.winterm.WinTerm method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.product.get_product_components">get_product_components() (in module src.product)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.product.get_product_config">get_product_config() (in module src.product)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.product.get_product_dependencies">get_product_dependencies() (in module src.product)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.product.get_product_section">get_product_section() (in module src.product)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.product.get_products_infos">get_products_infos() (in module src.product)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.configManager.get_products_list">get_products_list() (in module src.configManager)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.utilsSat.get_property_in_product_cfg">get_property_in_product_cfg() (in module src.utilsSat)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.architecture.get_python_version">get_python_version() (in module src.architecture)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.utilsSat.get_salome_version">get_salome_version() (in module src.utilsSat)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.test_module.Test.get_test_timeout">get_test_timeout() (src.test_module.Test method)</a>
+ </dt>
+
+ </dl></td>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.test_module.Test.get_tmp_dir">get_tmp_dir() (src.test_module.Test method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.utilsSat.get_tmp_filename">get_tmp_filename() (in module src.utilsSat)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.architecture.get_user">get_user() (in module src.architecture)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.configManager.ConfigManager.get_user_config_file">get_user_config_file() (src.configManager.ConfigManager method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansitowin32.AnsiToWin32.get_win32_calls">get_win32_calls() (src.colorama.ansitowin32.AnsiToWin32 method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.Config.getByPath">getByPath() (src.pyconf.Config method)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigList.getByPath">(src.pyconf.ConfigList method)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigReader.getChar">getChar() (src.pyconf.ConfigReader method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.salomeTools.Sat.getColoredVersion">getColoredVersion() (src.salomeTools.Sat method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.salomeTools.Sat.getCommandAndAppli">getCommandAndAppli() (src.salomeTools.Sat method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.salomeTools.Sat.getCommandInstance">getCommandInstance() (src.salomeTools.Sat method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.salomeTools.getCommandsList">getCommandsList() (in module src.salomeTools)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.salomeTools.Sat.getConfig">getConfig() (src.salomeTools.Sat method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.configManager.getConfigColored">getConfigColored() (in module src.configManager)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.salomeTools.Sat.getConfigManager">getConfigManager() (src.salomeTools.Sat method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.loggingSat.getDefaultLogger">getDefaultLogger() (in module src.loggingSat)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.options.Options.getDetailOption">getDetailOption() (src.options.Options method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.ElementTree.ElementTree.getiterator">getiterator() (src.ElementTree.ElementTree method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.debug.getLocalEnv">getLocalEnv() (in module src.debug)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.salomeTools.Sat.getLogger">getLogger() (src.salomeTools.Sat method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.loggingSat.UnittestStream.getLogs">getLogs() (src.loggingSat.UnittestStream method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.loggingSat.UnittestStream.getLogsAndClear">getLogsAndClear() (src.loggingSat.UnittestStream method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.salomeTools.Sat.getModule">getModule() (src.salomeTools.Sat method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.example.html#src.example.essai_logging_1.getMyLogger">getMyLogger() (in module src.example.essai_logging_1)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.example.html#src.example.essai_logging_2.getMyLogger">(in module src.example.essai_logging_2)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.html#src.ElementTree.ElementTree.getroot">getroot() (src.ElementTree.ElementTree method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.xmlManager.ReadXmlFile.getRootAttrib">getRootAttrib() (src.xmlManager.ReadXmlFile method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.debug.getStrConfigDbg">getStrConfigDbg() (in module src.debug)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.debug.getStrConfigStd">getStrConfigStd() (in module src.debug)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.test_module.getTmpDirDEFAULT">getTmpDirDEFAULT() (in module src.test_module)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigReader.getToken">getToken() (src.pyconf.ConfigReader method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.loggingSat.getUnittestLogger">getUnittestLogger() (in module src.loggingSat)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.returnCode.ReturnCode.getValue">getValue() (src.returnCode.ReturnCode method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.salomeTools.getVersion">getVersion() (in module src.salomeTools)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.returnCode.ReturnCode.getWhy">getWhy() (src.returnCode.ReturnCode method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.system.git_extract">git_extract() (in module src.system)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiBack.GREEN">GREEN (src.colorama.ansi.AnsiBack attribute)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiFore.GREEN">(src.colorama.ansi.AnsiFore attribute)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinColor.GREEN">(src.colorama.winterm.WinColor attribute)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.html#src.utilsSat.green">green() (in module src.utilsSat)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinColor.GREY">GREY (src.colorama.winterm.WinColor attribute)</a>
+ </dt>
+
+ </dl></td>
+</tr></table>
+
+<h2 id="H">H</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.compilation.Builder.hack_libtool">hack_libtool() (src.compilation.Builder method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigMerger.handleMismatch">handleMismatch() (src.pyconf.ConfigMerger method)</a>
+ </dt>
+
+ </dl></td>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.utilsSat.handleRemoveReadonly">handleRemoveReadonly() (in module src.utilsSat)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.utilsSat.header">header() (in module src.utilsSat)</a>
+ </dt>
+
+ </dl></td>
+</tr></table>
+
+<h2 id="I">I</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.coloringSat.indent">indent() (in module src.coloringSat)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.debug.indent">(in module src.debug)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.loggingSat.indent">(in module src.loggingSat)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.options.Options.indent">(src.options.Options method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.returnCode.ReturnCode.indent">(src.returnCode.ReturnCode method)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.html#src.loggingSat.indentUnittest">indentUnittest() (in module src.loggingSat)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.utilsSat.info">info() (in module src.utilsSat)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.initialise.init">init() (in module src.colorama.initialise)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.loggingSat.initLoggerAsDefault">initLoggerAsDefault() (in module src.loggingSat)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.loggingSat.initLoggerAsUnittest">initLoggerAsUnittest() (in module src.loggingSat)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.example.html#src.example.essai_logging_1.initMyLogger">initMyLogger() (in module src.example.essai_logging_1)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.example.html#src.example.essai_logging_2.initMyLogger">(in module src.example.essai_logging_2)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.html#src.compilation.Builder.install">install() (src.compilation.Builder method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.debug.InStream">InStream (class in src.debug)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansitowin32.is_a_tty">is_a_tty() (in module src.colorama.ansitowin32)</a>
+ </dt>
+
+ </dl></td>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.environment.Environ.is_defined">is_defined() (src.environment.Environ method)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.is_defined">(src.environment.SalomeEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.FileEnviron.is_defined">(src.fileEnviron.FileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.is_defined">(src.fileEnviron.LauncherFileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.ScreenEnviron.is_defined">(src.fileEnviron.ScreenEnviron method)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansitowin32.is_stream_closed">is_stream_closed() (in module src.colorama.ansitowin32)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.architecture.is_windows">is_windows() (in module src.architecture)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.utilsSat.Path.isdir">isdir() (src.utilsSat.Path method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.ElementTree.iselement">iselement() (in module src.ElementTree)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.utilsSat.Path.isfile">isfile() (src.utilsSat.Path method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.utilsSat.Path.islink">islink() (src.utilsSat.Path method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.returnCode.ReturnCode.isOk">isOk() (src.returnCode.ReturnCode method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.isWord">isWord() (in module src.pyconf)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.Mapping.iteritems">iteritems() (src.pyconf.Mapping method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.Mapping.iterkeys">iterkeys() (src.pyconf.Mapping method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.ElementTree.iterparse">iterparse (class in src.ElementTree)</a>
+ </dt>
+
+ </dl></td>
+</tr></table>
+
+<h2 id="J">J</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.catchAll.jsonDumps">jsonDumps() (in module src.catchAll)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.catchAll.CatchAll.jsonDumps">(src.catchAll.CatchAll method)</a>
+ </dt>
+
+ </dl></dd>
+ </dl></td>
+</tr></table>
+
+<h2 id="K">K</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.Mapping.keys">keys() (src.pyconf.Mapping method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.returnCode.ReturnCode.KFSYS">KFSYS (src.returnCode.ReturnCode attribute)</a>
+ </dt>
+
+ </dl></td>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.returnCode.ReturnCode.KNOWNFAILURE_STATUS">KNOWNFAILURE_STATUS (src.returnCode.ReturnCode attribute)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.returnCode.ReturnCode.KO_STATUS">KO_STATUS (src.returnCode.ReturnCode attribute)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.returnCode.ReturnCode.KOSYS">KOSYS (src.returnCode.ReturnCode attribute)</a>
+ </dt>
+
+ </dl></td>
+</tr></table>
+
+<h2 id="L">L</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.utilsSat.label">label() (in module src.utilsSat)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fork.launch_command">launch_command() (in module src.fork)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron">LauncherFileEnviron (class in src.fileEnviron)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.salomeTools.launchSat">launchSat() (in module src.salomeTools)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiBack.LIGHTBLACK_EX">LIGHTBLACK_EX (src.colorama.ansi.AnsiBack attribute)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiFore.LIGHTBLACK_EX">(src.colorama.ansi.AnsiFore attribute)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiBack.LIGHTBLUE_EX">LIGHTBLUE_EX (src.colorama.ansi.AnsiBack attribute)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiFore.LIGHTBLUE_EX">(src.colorama.ansi.AnsiFore attribute)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiBack.LIGHTCYAN_EX">LIGHTCYAN_EX (src.colorama.ansi.AnsiBack attribute)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiFore.LIGHTCYAN_EX">(src.colorama.ansi.AnsiFore attribute)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiBack.LIGHTGREEN_EX">LIGHTGREEN_EX (src.colorama.ansi.AnsiBack attribute)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiFore.LIGHTGREEN_EX">(src.colorama.ansi.AnsiFore attribute)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiBack.LIGHTMAGENTA_EX">LIGHTMAGENTA_EX (src.colorama.ansi.AnsiBack attribute)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiFore.LIGHTMAGENTA_EX">(src.colorama.ansi.AnsiFore attribute)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiBack.LIGHTRED_EX">LIGHTRED_EX (src.colorama.ansi.AnsiBack attribute)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiFore.LIGHTRED_EX">(src.colorama.ansi.AnsiFore attribute)</a>
+ </dt>
+
+ </dl></dd>
+ </dl></td>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiBack.LIGHTWHITE_EX">LIGHTWHITE_EX (src.colorama.ansi.AnsiBack attribute)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiFore.LIGHTWHITE_EX">(src.colorama.ansi.AnsiFore attribute)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiBack.LIGHTYELLOW_EX">LIGHTYELLOW_EX (src.colorama.ansi.AnsiBack attribute)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiFore.LIGHTYELLOW_EX">(src.colorama.ansi.AnsiFore attribute)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.html#src.utilsSat.Path.list">list() (src.utilsSat.Path method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.utilsSat.list_log_file">list_log_file() (in module src.utilsSat)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.Config.load">load() (src.pyconf.Config method)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigReader.load">(src.pyconf.ConfigReader method)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.load_cfg_environment">load_cfg_environment() (src.environment.SalomeEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.environment.load_environment">load_environment() (in module src.environment)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigReader.location">location() (src.pyconf.ConfigReader method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.coloringSat.log">log() (in module src.coloringSat)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.loggingSat.log">(in module src.loggingSat)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.compilation.Builder.log">(src.compilation.Builder method)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.html#src.compilation.Builder.log_command">log_command() (src.compilation.Builder method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.utilsSat.logger_info_tuples">logger_info_tuples() (in module src.utilsSat)</a>
+ </dt>
+
+ </dl></td>
+</tr></table>
+
+<h2 id="M">M</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiBack.MAGENTA">MAGENTA (src.colorama.ansi.AnsiBack attribute)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiFore.MAGENTA">(src.colorama.ansi.AnsiFore attribute)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinColor.MAGENTA">(src.colorama.winterm.WinColor attribute)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.html#src.utilsSat.magenta">magenta() (in module src.utilsSat)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.compilation.Builder.make">make() (src.compilation.Builder method)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.utilsSat.Path.make">(src.utilsSat.Path method)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.makePath">makePath() (in module src.pyconf)</a>
+ </dt>
+
+ </dl></td>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.Mapping">Mapping (class in src.pyconf)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigReader.match">match() (src.pyconf.ConfigReader method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigMerger.merge">merge() (src.pyconf.ConfigMerger method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.utilsSat.merge_dicts">merge_dicts() (in module src.utilsSat)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigMerger.mergeMapping">mergeMapping() (src.pyconf.ConfigMerger method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigMerger.mergeSequence">mergeSequence() (src.pyconf.ConfigMerger method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.example.html#src.example.essai_logging_2.MyFormatter">MyFormatter (class in src.example.essai_logging_2)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.template.MyTemplate">MyTemplate (class in src.template)</a>
+ </dt>
+
+ </dl></td>
+</tr></table>
+
+<h2 id="N">N</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.returnCode.ReturnCode.NA_STATUS">NA_STATUS (src.returnCode.ReturnCode attribute)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.returnCode.ReturnCode.NASYS">NASYS (src.returnCode.ReturnCode attribute)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.returnCode.ReturnCode.NDSYS">NDSYS (src.returnCode.ReturnCode attribute)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.ElementTree.iterparse.next">next() (src.ElementTree.iterparse method)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.Sequence.SeqIter.next">(src.pyconf.Sequence.SeqIter method)</a>
+ </dt>
+
+ </dl></dd>
+ </dl></td>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiStyle.NORMAL">NORMAL (src.colorama.ansi.AnsiStyle attribute)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinStyle.NORMAL">(src.colorama.winterm.WinStyle attribute)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.html#src.utilsSat.normal">normal() (in module src.utilsSat)</a>
+ </dt>
+
+ </dl></td>
+</tr></table>
+
+<h2 id="O">O</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.returnCode.ReturnCode.OK_STATUS">OK_STATUS (src.returnCode.ReturnCode attribute)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.returnCode.ReturnCode.OKSYS">OKSYS (src.returnCode.ReturnCode attribute)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.utilsSat.only_numbers">only_numbers() (in module src.utilsSat)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.options.Options">Options (class in src.options)</a>
+ </dt>
+
+ </dl></td>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.options.OptResult">OptResult (class in src.options)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.debug.OutStream">OutStream (class in src.debug)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigMerger.overwriteKeys">overwriteKeys() (src.pyconf.ConfigMerger method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.overwriteMergeResolve">overwriteMergeResolve() (in module src.pyconf)</a>
+ </dt>
+
+ </dl></td>
+</tr></table>
+
+<h2 id="P">P</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.ElementTree.parse">parse() (in module src.ElementTree)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.ElementTree.ElementTree.parse">(src.ElementTree.ElementTree method)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.html#src.options.Options.parse_args">parse_args() (src.options.Options method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.utilsSat.parse_date">parse_date() (in module src.utilsSat)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.salomeTools.Sat.parseArguments">parseArguments() (src.salomeTools.Sat method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigReader.parseFactor">parseFactor() (src.pyconf.ConfigReader method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigReader.parseKeyValuePair">parseKeyValuePair() (src.pyconf.ConfigReader method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigReader.parseMapping">parseMapping() (src.pyconf.ConfigReader method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigReader.parseMappingBody">parseMappingBody() (src.pyconf.ConfigReader method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigReader.parseReference">parseReference() (src.pyconf.ConfigReader method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigReader.parseScalar">parseScalar() (src.pyconf.ConfigReader method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigReader.parseSequence">parseSequence() (src.pyconf.ConfigReader method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigReader.parseSuffix">parseSuffix() (src.pyconf.ConfigReader method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigReader.parseTerm">parseTerm() (src.pyconf.ConfigReader method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigReader.parseValue">parseValue() (src.pyconf.ConfigReader method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.utilsSat.Path">Path (class in src.utilsSat)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.template.MyTemplate.pattern">pattern (src.template.MyTemplate attribute)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.ElementTree.PI">PI() (in module src.ElementTree)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.debug.pop_debug">pop_debug() (in module src.debug)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiCursor.POS">POS() (src.colorama.ansi.AnsiCursor method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.compilation.Builder.prepare">prepare() (src.compilation.Builder method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.test_module.Test.prepare_testbase">prepare_testbase() (src.test_module.Test method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.test_module.Test.prepare_testbase_from_dir">prepare_testbase_from_dir() (src.test_module.Test method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.test_module.Test.prepare_testbase_from_git">prepare_testbase_from_git() (src.test_module.Test method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.test_module.Test.prepare_testbase_from_svn">prepare_testbase_from_svn() (src.test_module.Test method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.environment.Environ.prepend">prepend() (src.environment.Environ method)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.prepend">(src.environment.SalomeEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.FileEnviron.prepend">(src.fileEnviron.FileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.prepend">(src.fileEnviron.LauncherFileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.ScreenEnviron.prepend">(src.fileEnviron.ScreenEnviron method)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.html#src.environment.Environ.prepend_value">prepend_value() (src.environment.Environ method)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.ContextFileEnviron.prepend_value">(src.fileEnviron.ContextFileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.FileEnviron.prepend_value">(src.fileEnviron.FileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.prepend_value">(src.fileEnviron.LauncherFileEnviron method)</a>
+ </dt>
+
+ </dl></dd>
+ </dl></td>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.configManager.print_debug">print_debug() (in module src.configManager)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.environs.print_grep_environs">print_grep_environs() (in module src.environs)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.salomeTools.Sat.print_help">print_help() (src.salomeTools.Sat method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.environs.print_split_environs">print_split_environs() (in module src.environs)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.environs.print_split_pattern_environs">print_split_pattern_environs() (in module src.environs)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.configManager.print_value">print_value() (in module src.configManager)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.ElementTree.ProcessingInstruction">ProcessingInstruction() (in module src.ElementTree)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.product.product_compiles">product_compiles() (in module src.product)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.product.product_has_env_script">product_has_env_script() (in module src.product)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.product.product_has_logo">product_has_logo() (in module src.product)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.product.product_has_patches">product_has_patches() (in module src.product)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.product.product_has_salome_gui">product_has_salome_gui() (in module src.product)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.product.product_has_script">product_has_script() (in module src.product)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.product.product_is_autotools">product_is_autotools() (in module src.product)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.product.product_is_cmake">product_is_cmake() (in module src.product)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.product.product_is_cpp">product_is_cpp() (in module src.product)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.product.product_is_debug">product_is_debug() (in module src.product)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.product.product_is_dev">product_is_dev() (in module src.product)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.product.product_is_fixed">product_is_fixed() (in module src.product)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.product.product_is_generated">product_is_generated() (in module src.product)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.product.product_is_mpi">product_is_mpi() (in module src.product)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.product.product_is_native">product_is_native() (in module src.product)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.product.product_is_SALOME">product_is_SALOME() (in module src.product)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.product.product_is_salome">product_is_salome() (in module src.product)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.product.product_is_sample">product_is_sample() (in module src.product)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.product.product_is_smesh_plugin">product_is_smesh_plugin() (in module src.product)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.product.product_is_vcs">product_is_vcs() (in module src.product)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.debug.push_debug">push_debug() (in module src.debug)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.compilation.Builder.put_txt_log_in_appli_log_dir">put_txt_log_in_appli_log_dir() (src.compilation.Builder method)</a>
+ </dt>
+
+ </dl></td>
+</tr></table>
+
+<h2 id="Q">Q</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.ElementTree.QName">QName (class in src.ElementTree)</a>
+ </dt>
+
+ </dl></td>
+</tr></table>
+
+<h2 id="R">R</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigInputStream.read">read() (src.pyconf.ConfigInputStream method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.utilsSat.read_config_from_a_file">read_config_from_a_file() (in module src.utilsSat)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.test_module.Test.read_results">read_results() (src.test_module.Test method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigInputStream.readline">readline() (src.pyconf.ConfigInputStream method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.utilsSat.Path.readlink">readlink() (src.utilsSat.Path method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.xmlManager.ReadXmlFile">ReadXmlFile (class in src.xmlManager)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiBack.RED">RED (src.colorama.ansi.AnsiBack attribute)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiFore.RED">(src.colorama.ansi.AnsiFore attribute)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinColor.RED">(src.colorama.winterm.WinColor attribute)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.html#src.utilsSat.red">red() (in module src.utilsSat)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.Reference">Reference (class in src.pyconf)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.initialise.reinit">reinit() (in module src.colorama.initialise)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.utilsSat.remove_item_from_list">remove_item_from_list() (in module src.utilsSat)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.Config.removeNamespace">removeNamespace() (src.pyconf.Config method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.coloringSat.replace">replace() (in module src.coloringSat)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.utilsSat.replace_in_file">replace_in_file() (in module src.utilsSat)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiBack.RESET">RESET (src.colorama.ansi.AnsiBack attribute)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiFore.RESET">(src.colorama.ansi.AnsiFore attribute)</a>
+ </dt>
+
+ </dl></dd>
+ </dl></td>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.utilsSat.reset">reset() (in module src.utilsSat)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiStyle.RESET_ALL">RESET_ALL (src.colorama.ansi.AnsiStyle attribute)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.initialise.reset_all">reset_all() (in module src.colorama.initialise)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansitowin32.AnsiToWin32.reset_all">(src.colorama.ansitowin32.AnsiToWin32 method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinTerm.reset_all">(src.colorama.winterm.WinTerm method)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.Reference.resolve">resolve() (src.pyconf.Reference method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.returnCode.ReturnCode">ReturnCode (class in src.returnCode)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.utilsSat.Path.rm">rm() (src.utilsSat.Path method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.test_module.Test.run_all_tests">run_all_tests() (src.test_module.Test method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.run_env_script">run_env_script() (src.environment.SalomeEnviron method)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.ScreenEnviron.run_env_script">(src.fileEnviron.ScreenEnviron method)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.html#src.test_module.Test.run_grid_tests">run_grid_tests() (src.test_module.Test method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.test_module.Test.run_script">run_script() (src.test_module.Test method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.test_module.Test.run_session_tests">run_session_tests() (src.test_module.Test method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.run_simple_env_script">run_simple_env_script() (src.environment.SalomeEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.test_module.Test.run_testbase_tests">run_testbase_tests() (src.test_module.Test method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.test_module.Test.run_tests">run_tests() (src.test_module.Test method)</a>
+ </dt>
+
+ </dl></td>
+</tr></table>
+
+<h2 id="S">S</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.environment.SalomeEnviron">SalomeEnviron (class in src.environment)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.salomeTools.Sat">Sat (class in src.salomeTools)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.debug.saveConfigDbg">saveConfigDbg() (in module src.debug)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.debug.saveConfigStd">saveConfigStd() (in module src.debug)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.ScreenEnviron">ScreenEnviron (class in src.fileEnviron)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.test_module.Test.search_known_errors">search_known_errors() (src.test_module.Test method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.Sequence">Sequence (class in src.pyconf)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.Sequence.SeqIter">Sequence.SeqIter (class in src.pyconf)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.environment.Environ.set">set() (src.environment.Environ method)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.set">(src.environment.SalomeEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.BashFileEnviron.set">(src.fileEnviron.BashFileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.BatFileEnviron.set">(src.fileEnviron.BatFileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.ContextFileEnviron.set">(src.fileEnviron.ContextFileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.FileEnviron.set">(src.fileEnviron.FileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.LauncherFileEnviron.set">(src.fileEnviron.LauncherFileEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.ScreenEnviron.set">(src.fileEnviron.ScreenEnviron method)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.set_a_product">set_a_product() (src.environment.SalomeEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.set_application_env">set_application_env() (src.environment.SalomeEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinTerm.set_attrs">set_attrs() (src.colorama.winterm.WinTerm method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinTerm.set_console">set_console() (src.colorama.winterm.WinTerm method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.set_cpp_env">set_cpp_env() (src.environment.SalomeEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinTerm.set_cursor_position">set_cursor_position() (src.colorama.winterm.WinTerm method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.set_full_environ">set_full_environ() (src.environment.SalomeEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.set_products">set_products() (src.environment.SalomeEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.set_python_libdirs">set_python_libdirs() (src.environment.SalomeEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.set_salome_generic_product_env">set_salome_generic_product_env() (src.environment.SalomeEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.environment.SalomeEnviron.set_salome_minimal_product_env">set_salome_minimal_product_env() (src.environment.SalomeEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.set_title">set_title() (in module src.colorama.ansi)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinTerm.set_title">(src.colorama.winterm.WinTerm method)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.html#src.configManager.ConfigManager.set_user_config_file">set_user_config_file() (src.configManager.ConfigManager method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.loggingSat.DefaultFormatter.setColorLevelname">setColorLevelname() (src.loggingSat.DefaultFormatter method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.win32.SetConsoleTextAttribute">SetConsoleTextAttribute() (in module src.colorama.win32)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.salomeTools.setLocale">setLocale() (in module src.salomeTools)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.salomeTools.setNotLocale">setNotLocale() (in module src.salomeTools)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.Container.setPath">setPath() (src.pyconf.Container method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.returnCode.ReturnCode.setStatus">setStatus() (src.returnCode.ReturnCode method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigReader.setStream">setStream() (src.pyconf.ConfigReader method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.returnCode.ReturnCode.setValue">setValue() (src.returnCode.ReturnCode method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.returnCode.ReturnCode.setWhy">setWhy() (src.returnCode.ReturnCode method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.environment.Shell">Shell (class in src.environment)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansitowin32.AnsiToWin32.should_wrap">should_wrap() (src.colorama.ansitowin32.AnsiToWin32 method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.utilsSat.show_command_log">show_command_log() (in module src.utilsSat)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.system.show_in_editor">show_in_editor() (in module src.system)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.configManager.show_patchs">show_patchs() (in module src.configManager)</a>
+ </dt>
+
+ </dl></td>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.configManager.show_product_info">show_product_info() (in module src.configManager)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fork.show_progress">show_progress() (in module src.fork)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.utilsSat.Path.smartcopy">smartcopy() (src.utilsSat.Path method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.special_path_separator">special_path_separator() (in module src.fileEnviron)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#module-src">src (module)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#module-src.architecture">src.architecture (module)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#module-src.catchAll">src.catchAll (module)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#module-src.colorama">src.colorama (module)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#module-src.colorama.ansi">src.colorama.ansi (module)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#module-src.colorama.ansitowin32">src.colorama.ansitowin32 (module)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#module-src.colorama.initialise">src.colorama.initialise (module)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#module-src.colorama.win32">src.colorama.win32 (module)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#module-src.colorama.winterm">src.colorama.winterm (module)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#module-src.coloringSat">src.coloringSat (module)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#module-src.compilation">src.compilation (module)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#module-src.configManager">src.configManager (module)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#module-src.debug">src.debug (module)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#module-src.ElementTree">src.ElementTree (module)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#module-src.environment">src.environment (module)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#module-src.environs">src.environs (module)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.example.html#module-src.example">src.example (module)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.example.html#module-src.example.essai_logging_1">src.example.essai_logging_1 (module)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.example.html#module-src.example.essai_logging_2">src.example.essai_logging_2 (module)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#module-src.exceptionSat">src.exceptionSat (module)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#module-src.fileEnviron">src.fileEnviron (module)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#module-src.fork">src.fork (module)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#module-src.loggingSat">src.loggingSat (module)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#module-src.options">src.options (module)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#module-src.product">src.product (module)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#module-src.pyconf">src.pyconf (module)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#module-src.returnCode">src.returnCode (module)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#module-src.salomeTools">src.salomeTools (module)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#module-src.system">src.system (module)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#module-src.template">src.template (module)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#module-src.test_module">src.test_module (module)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#module-src.utilsSat">src.utilsSat (module)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#module-src.xmlManager">src.xmlManager (module)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.ElementTree.TreeBuilder.start">start() (src.ElementTree.TreeBuilder method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansitowin32.StreamWrapper">StreamWrapper (class in src.colorama.ansitowin32)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinTerm.style">style() (src.colorama.winterm.WinTerm method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.ElementTree.SubElement">SubElement() (in module src.ElementTree)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.template.substitute">substitute() (in module src.template)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.utilsSat.success">success() (in module src.utilsSat)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.system.svn_extract">svn_extract() (in module src.system)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.utilsSat.Path.symlink">symlink() (src.utilsSat.Path method)</a>
+ </dt>
+
+ </dl></td>
+</tr></table>
+
+<h2 id="T">T</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.test_module.Test">Test (class in src.test_module)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.example.html#src.example.essai_logging_1.testLogger1">testLogger1() (in module src.example.essai_logging_1)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.example.html#src.example.essai_logging_2.testLogger1">(in module src.example.essai_logging_2)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.html#src.loggingSat.testLogger_1">testLogger_1() (in module src.loggingSat)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.utilsSat.timedelta_total_seconds">timedelta_total_seconds() (in module src.utilsSat)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.returnCode.ReturnCode.TIMEOUT_STATUS">TIMEOUT_STATUS (src.returnCode.ReturnCode attribute)</a>
+ </dt>
+
+ </dl></td>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.coloringSat.toColor">toColor() (in module src.coloringSat)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.coloringSat.toColor_AnsiToWin32">toColor_AnsiToWin32() (in module src.coloringSat)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.debug.tofix">tofix() (in module src.debug)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.ElementTree.tostring">tostring() (in module src.ElementTree)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.returnCode.ReturnCode.TOSYS">TOSYS (src.returnCode.ReturnCode attribute)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.returnCode.ReturnCode.toSys">toSys() (src.returnCode.ReturnCode method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.ElementTree.TreeBuilder">TreeBuilder (class in src.ElementTree)</a>
+ </dt>
+
+ </dl></td>
+</tr></table>
+
+<h2 id="U">U</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.loggingSat.UnittestFormatter">UnittestFormatter (class in src.loggingSat)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.loggingSat.UnittestStream">UnittestStream (class in src.loggingSat)</a>
+ </dt>
+
+ </dl></td>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.returnCode.ReturnCode.UNKNOWN_STATUS">UNKNOWN_STATUS (src.returnCode.ReturnCode attribute)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiCursor.UP">UP() (src.colorama.ansi.AnsiCursor method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.utilsSat.update_hat_xml">update_hat_xml() (in module src.utilsSat)</a>
+ </dt>
+
+ </dl></td>
+</tr></table>
+
+<h2 id="W">W</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.utilsSat.warning">warning() (in module src.utilsSat)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiBack.WHITE">WHITE (src.colorama.ansi.AnsiBack attribute)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiFore.WHITE">(src.colorama.ansi.AnsiFore attribute)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.html#src.utilsSat.white">white() (in module src.utilsSat)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.win32.winapi_test">winapi_test() (in module src.colorama.win32)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinColor">WinColor (class in src.colorama.winterm)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinStyle">WinStyle (class in src.colorama.winterm)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinTerm">WinTerm (class in src.colorama.winterm)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.compilation.Builder.wmake">wmake() (src.compilation.Builder method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.initialise.wrap_stream">wrap_stream() (in module src.colorama.initialise)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.debug.write">write() (in module src.debug)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.ElementTree.ElementTree.write">(src.ElementTree.ElementTree method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansitowin32.AnsiToWin32.write">(src.colorama.ansitowin32.AnsiToWin32 method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansitowin32.StreamWrapper.write">(src.colorama.ansitowin32.StreamWrapper method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.coloringSat.ColoringStream.write">(src.coloringSat.ColoringStream method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fileEnviron.ScreenEnviron.write">(src.fileEnviron.ScreenEnviron method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.loggingSat.UnittestStream.write">(src.loggingSat.UnittestStream method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.ConfigOutputStream.write">(src.pyconf.ConfigOutputStream method)</a>
+ </dt>
+
+ </dl></dd>
+ </dl></td>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansitowin32.AnsiToWin32.write_and_convert">write_and_convert() (src.colorama.ansitowin32.AnsiToWin32 method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.fork.write_back">write_back() (in module src.fork)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.environment.FileEnvWriter.write_cfgForPy_file">write_cfgForPy_file() (src.environment.FileEnvWriter method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.environment.FileEnvWriter.write_env_file">write_env_file() (src.environment.FileEnvWriter method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansitowin32.AnsiToWin32.write_plain_text">write_plain_text() (src.colorama.ansitowin32.AnsiToWin32 method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.xmlManager.write_report">write_report() (in module src.xmlManager)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.test_module.Test.write_test_margin">write_test_margin() (src.test_module.Test method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.xmlManager.XmlLogFile.write_tree">write_tree() (src.xmlManager.XmlLogFile method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.Container.writeToStream">writeToStream() (src.pyconf.Container method)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.Mapping.writeToStream">(src.pyconf.Mapping method)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.Sequence.writeToStream">(src.pyconf.Sequence method)</a>
+ </dt>
+
+ </dl></dd>
+
+ <dt><a href="commands/apidoc/src.html#src.pyconf.Container.writeValue">writeValue() (src.pyconf.Container method)</a>
+ </dt>
+
+ </dl></td>
+</tr></table>
+
+<h2 id="X">X</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.ElementTree.XML">XML() (in module src.ElementTree)</a>
+ </dt>
+
+ </dl></td>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.xmlManager.XmlLogFile">XmlLogFile (class in src.xmlManager)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.html#src.ElementTree.XMLTreeBuilder">XMLTreeBuilder (class in src.ElementTree)</a>
+ </dt>
+
+ </dl></td>
+</tr></table>
+
+<h2 id="Y">Y</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiBack.YELLOW">YELLOW (src.colorama.ansi.AnsiBack attribute)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiFore.YELLOW">(src.colorama.ansi.AnsiFore attribute)</a>
+ </dt>
+
+
+ <dt><a href="commands/apidoc/src.colorama.html#src.colorama.winterm.WinColor.YELLOW">(src.colorama.winterm.WinColor attribute)</a>
+ </dt>
+
+ </dl></dd>
+ </dl></td>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="commands/apidoc/src.html#src.utilsSat.yellow">yellow() (in module src.utilsSat)</a>
+ </dt>
+
+ </dl></td>
+</tr></table>
+
+
+
+ </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>
+ </ul></li>
+</ul>
+</div>
+
+<div id="searchbox" style="display: none" role="search">
+ <h3>Quick search</h3>
+ <form class="search" action="search.html" method="get">
+ <div><input type="text" name="q" /></div>
+ <div><input type="submit" value="Go" /></div>
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
©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>
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.9</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
</div>
-
<!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>Salome Tools — salomeTools 5.0.0dev documentation</title>
+
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
- <script type="text/javascript" src="_static/documentation_options.js"></script>
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: './',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
- <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/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="top" title="salomeTools 5.0.0dev documentation" href="#" />
<link rel="next" title="Installation" href="installation_of_sat.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
- </head><body>
+ </head>
+ <body role="document">
<div class="document">
</div>
<p>The <strong>Sa</strong>lome<strong>T</strong>ools (sat) is a suite of commands
that can be used to perform operations on <a class="reference external" href="http://www.salome-platform.org">SALOME</a>.</p>
-<p>For example, sat allows you to compile SALOME’s codes
+<p>For example, sat allows you to compile SALOME's codes
(prerequisites, products)
create application, run tests, create package, etc.</p>
<p>This utility code is a set of <a class="reference external" href="https://docs.python.org/2.7">Python</a> scripts files.</p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
- <li><a href="_sources/index.rst.txt"
+ <li><a href="_sources/index.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" />
+ <div><input type="text" name="q" /></div>
+ <div><input type="submit" value="Go" /></div>
<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>
©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>
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.9</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
|
- <a href="_sources/index.rst.txt"
+ <a href="_sources/index.txt"
rel="nofollow">Page source</a>
</div>
-
<!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>Installation — salomeTools 5.0.0dev documentation</title>
+
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
- <script type="text/javascript" src="_static/documentation_options.js"></script>
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: './',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
- <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/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="top" title="salomeTools 5.0.0dev documentation" href="index.html" />
<link rel="next" title="Configuration" href="configuration.html" />
<link rel="prev" title="Salome Tools" href="index.html" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
- </head><body>
+ </head>
+ <body role="document">
<div class="document">
<div class="section" id="installation">
<h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h1>
-<p>Usually user could find (and use) command <strong>sat</strong> directly after a ‘detar’ installation of SALOME.</p>
-<div class="highlight-bash
notranslate"><div class="highlight"><pre><span></span>tar -xf .../SALOME_xx.tgz
+<p>Usually user could find (and use) command <strong>sat</strong> directly after a 'detar' installation of SALOME.</p>
+<div class="highlight-bash"><div class="highlight"><pre><span></span>tar -xf .../SALOME_xx.tgz
<span class="nb">cd</span> SALOME_xx
ls -l sat <span class="c1"># sat -> salomeTools/sat</span>
</pre></div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
- <li><a href="_sources/installation_of_sat.rst.txt"
+ <li><a href="_sources/installation_of_sat.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" />
+ <div><input type="text" name="q" /></div>
+ <div><input type="submit" value="Go" /></div>
<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>
©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>
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.9</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
|
- <a href="_sources/installation_of_sat.rst.txt"
+ <a href="_sources/installation_of_sat.txt"
rel="nofollow">Page source</a>
</div>
-
<!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>Python Module Index — salomeTools 5.0.0dev documentation</title>
+
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
- <script type="text/javascript" src="_static/documentation_options.js"></script>
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: './',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
- <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/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="top" title="salomeTools 5.0.0dev documentation" href="index.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
- </head><body>
+ </head>
+ <body role="document">
<div class="document">
<a href="#cap-s"><strong>s</strong></a>
</div>
- <table class="indextable modindextable">
+ <table class="indextable modindextable" cellspacing="0" cellpadding="2">
<tr class="pcap"><td></td><td> </td><td></td></tr>
<tr class="cap" id="cap-s"><td></td><td>
<strong>s</strong></td><td></td></tr>
<td><img src="_static/minus.png" class="toggler"
id="toggle-1" style="display: none" alt="-" /></td>
<td>
- <code class="xref">src</code></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>
<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.architecture"><code class="xref">src.architecture</code></a></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>   
- <a href="commands/apidoc/src.html#module-src.architecture"><code class="xref">src.architecture</code></a></td><td>
+ <a href="commands/apidoc/src.html#module-src.catchAll"><code class="xref">src.catchAll</code></a></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>   
<a href="commands/apidoc/src.colorama.html#module-src.colorama.winterm"><code class="xref">src.colorama.winterm</code></a></td><td>
<em></em></td></tr>
+ <tr class="cg-1">
+ <td></td>
+ <td>   
+ <a href="commands/apidoc/src.html#module-src.coloringSat"><code class="xref">src.coloringSat</code></a></td><td>
+ <em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>   
<a href="commands/apidoc/src.html#module-src.compilation"><code class="xref">src.compilation</code></a></td><td>
<em></em></td></tr>
+ <tr class="cg-1">
+ <td></td>
+ <td>   
+ <a href="commands/apidoc/src.html#module-src.configManager"><code class="xref">src.configManager</code></a></td><td>
+ <em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>   
<td>   
<a href="commands/apidoc/src.html#module-src.environment"><code class="xref">src.environment</code></a></td><td>
<em></em></td></tr>
+ <tr class="cg-1">
+ <td></td>
+ <td>   
+ <a href="commands/apidoc/src.html#module-src.environs"><code class="xref">src.environs</code></a></td><td>
+ <em></em></td></tr>
+ <tr class="cg-1">
+ <td></td>
+ <td>   
+ <a href="commands/apidoc/src.example.html#module-src.example"><code class="xref">src.example</code></a></td><td>
+ <em></em></td></tr>
+ <tr class="cg-1">
+ <td></td>
+ <td>   
+ <a href="commands/apidoc/src.example.html#module-src.example.essai_logging_1"><code class="xref">src.example.essai_logging_1</code></a></td><td>
+ <em></em></td></tr>
+ <tr class="cg-1">
+ <td></td>
+ <td>   
+ <a href="commands/apidoc/src.example.html#module-src.example.essai_logging_2"><code class="xref">src.example.essai_logging_2</code></a></td><td>
+ <em></em></td></tr>
+ <tr class="cg-1">
+ <td></td>
+ <td>   
+ <a href="commands/apidoc/src.html#module-src.exceptionSat"><code class="xref">src.exceptionSat</code></a></td><td>
+ <em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>   
<tr class="cg-1">
<td></td>
<td>   
- <a href="commands/apidoc/src.html#module-src.logger"><code class="xref">src.logger</code></a></td><td>
+ <a href="commands/apidoc/src.html#module-src.loggingSat"><code class="xref">src.loggingSat</code></a></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
<tr class="cg-1">
<td></td>
<td>   
- <a href="commands/apidoc/src.html#module-src.printcolors"><code class="xref">src.printcolors</code></a></td><td>
+ <a href="commands/apidoc/src.html#module-src.product"><code class="xref">src.product</code></a></td><td>
+ <em></em></td></tr>
+ <tr class="cg-1">
+ <td></td>
+ <td>   
+ <a href="commands/apidoc/src.html#module-src.pyconf"><code class="xref">src.pyconf</code></a></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>   
- <a href="commands/apidoc/src.html#module-src.product"><code class="xref">src.product</code></a></td><td>
+ <a href="commands/apidoc/src.html#module-src.returnCode"><code class="xref">src.returnCode</code></a></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>   
- <a href="commands/apidoc/src.html#module-src.pyconf"><code class="xref">src.pyconf</code></a></td><td>
+ <a href="commands/apidoc/src.html#module-src.salomeTools"><code class="xref">src.salomeTools</code></a></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>   
<a href="commands/apidoc/src.html#module-src.test_module"><code class="xref">src.test_module</code></a></td><td>
<em></em></td></tr>
+ <tr class="cg-1">
+ <td></td>
+ <td>   
+ <a href="commands/apidoc/src.html#module-src.utilsSat"><code class="xref">src.utilsSat</code></a></td><td>
+ <em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>   
</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" />
+ <div><input type="text" name="q" /></div>
+ <div><input type="submit" value="Go" /></div>
<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>
©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>
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.9</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
</div>
-
<!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>Release notes — salomeTools 5.0.0dev documentation</title>
+
<link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
- <script type="text/javascript" src="../_static/documentation_options.js"></script>
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
- <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/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="top" title="salomeTools 5.0.0dev documentation" href="../index.html" />
+ <link rel="prev" title="src.example package" href="../commands/apidoc/src.example.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>
+ </head>
+ <body role="document">
<div class="document">
<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.example.html" title="previous chapter">src.example package</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/release_notes/release_notes_5.0.0.rst.txt"
+ <li><a href="../_sources/release_notes/release_notes_5.0.0.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" />
+ <div><input type="text" name="q" /></div>
+ <div><input type="submit" value="Go" /></div>
<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>
©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>
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.9</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
|
- <a href="../_sources/release_notes/release_notes_5.0.0.rst.txt"
+ <a href="../_sources/release_notes/release_notes_5.0.0.txt"
rel="nofollow">Page source</a>
</div>
-
<!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>Search — salomeTools 5.0.0dev documentation</title>
+
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
- <script type="text/javascript" src="_static/documentation_options.js"></script>
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: './',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
- <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/javascript" src="_static/searchtools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="#" />
+ <link rel="top" title="salomeTools 5.0.0dev documentation" href="index.html" />
<script type="text/javascript">
jQuery(function() { Search.loadIndex("searchindex.js"); });
</script>
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
- </head><body>
+ </head>
+ <body role="document">
<div class="document">
©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>
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.9</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
</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({envversion:49,filenames:["commands/apidoc/modules","commands/apidoc/src","commands/apidoc/src.colorama","commands/apidoc/src.example","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"],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.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.catchAll":{CatchAll:[1,2,1,""],dumper:[1,1,1,""],dumperType:[1,1,1,""],jsonDumps:[1,1,1,""]},"src.catchAll.CatchAll":{jsonDumps:[1,3,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,4,1,""],BLUE:[2,4,1,""],CYAN:[2,4,1,""],GREEN:[2,4,1,""],LIGHTBLACK_EX:[2,4,1,""],LIGHTBLUE_EX:[2,4,1,""],LIGHTCYAN_EX:[2,4,1,""],LIGHTGREEN_EX:[2,4,1,""],LIGHTMAGENTA_EX:[2,4,1,""],LIGHTRED_EX:[2,4,1,""],LIGHTWHITE_EX:[2,4,1,""],LIGHTYELLOW_EX:[2,4,1,""],MAGENTA:[2,4,1,""],RED:[2,4,1,""],RESET:[2,4,1,""],WHITE:[2,4,1,""],YELLOW:[2,4,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,4,1,""],BLUE:[2,4,1,""],CYAN:[2,4,1,""],GREEN:[2,4,1,""],LIGHTBLACK_EX:[2,4,1,""],LIGHTBLUE_EX:[2,4,1,""],LIGHTCYAN_EX:[2,4,1,""],LIGHTGREEN_EX:[2,4,1,""],LIGHTMAGENTA_EX:[2,4,1,""],LIGHTRED_EX:[2,4,1,""],LIGHTWHITE_EX:[2,4,1,""],LIGHTYELLOW_EX:[2,4,1,""],MAGENTA:[2,4,1,""],RED:[2,4,1,""],RESET:[2,4,1,""],WHITE:[2,4,1,""],YELLOW:[2,4,1,""]},"src.colorama.ansi.AnsiStyle":{BRIGHT:[2,4,1,""],DIM:[2,4,1,""],NORMAL:[2,4,1,""],RESET_ALL:[2,4,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,4,1,""],ANSI_OSC_RE:[2,4,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,4,1,""],BLUE:[2,4,1,""],CYAN:[2,4,1,""],GREEN:[2,4,1,""],GREY:[2,4,1,""],MAGENTA:[2,4,1,""],RED:[2,4,1,""],YELLOW:[2,4,1,""]},"src.colorama.winterm.WinStyle":{BRIGHT:[2,4,1,""],BRIGHT_BACKGROUND:[2,4,1,""],NORMAL:[2,4,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.coloringSat":{ColoringStream:[1,2,1,""],cleanColors:[1,1,1,""],indent:[1,1,1,""],log:[1,1,1,""],replace:[1,1,1,""],toColor:[1,1,1,""],toColor_AnsiToWin32:[1,1,1,""]},"src.coloringSat.ColoringStream":{flush:[1,3,1,""],write:[1,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.configManager":{ConfigManager:[1,2,1,""],ConfigOpener:[1,2,1,""],check_path:[1,1,1,""],getConfigColored:[1,1,1,""],get_config_children:[1,1,1,""],get_products_list:[1,1,1,""],print_debug:[1,1,1,""],print_value:[1,1,1,""],show_patchs:[1,1,1,""],show_product_info:[1,1,1,""]},"src.configManager.ConfigManager":{create_config_file:[1,3,1,""],get_command_line_overrides:[1,3,1,""],get_config:[1,3,1,""],get_user_config_file:[1,3,1,""],set_user_config_file:[1,3,1,""]},"src.configManager.ConfigOpener":{get_path:[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.environs":{print_grep_environs:[1,1,1,""],print_split_environs:[1,1,1,""],print_split_pattern_environs:[1,1,1,""]},"src.example":{essai_logging_1:[3,0,0,"-"],essai_logging_2:[3,0,0,"-"]},"src.example.essai_logging_1":{getMyLogger:[3,1,1,""],initMyLogger:[3,1,1,""],testLogger1:[3,1,1,""]},"src.example.essai_logging_2":{MyFormatter:[3,2,1,""],getMyLogger:[3,1,1,""],initMyLogger:[3,1,1,""],testLogger1:[3,1,1,""]},"src.example.essai_logging_2.MyFormatter":{format:[3,3,1,""]},"src.exceptionSat":{ExceptionSat:[1,5,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.loggingSat":{DefaultFormatter:[1,2,1,""],UnittestFormatter:[1,2,1,""],UnittestStream:[1,2,1,""],dirLogger:[1,1,1,""],getDefaultLogger:[1,1,1,""],getUnittestLogger:[1,1,1,""],indent:[1,1,1,""],indentUnittest:[1,1,1,""],initLoggerAsDefault:[1,1,1,""],initLoggerAsUnittest:[1,1,1,""],log:[1,1,1,""],testLogger_1:[1,1,1,""]},"src.loggingSat.DefaultFormatter":{format:[1,3,1,""],setColorLevelname:[1,3,1,""]},"src.loggingSat.UnittestFormatter":{format:[1,3,1,""]},"src.loggingSat.UnittestStream":{flush:[1,3,1,""],getLogs:[1,3,1,""],getLogsAndClear:[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,""],getDetailOption:[1,3,1,""],get_help:[1,3,1,""],indent:[1,3,1,""],parse_args:[1,3,1,""]},"src.product":{check_config_exists:[1,1,1,""],check_installation:[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_SALOME:[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,5,1,""],ConfigFormatError:[1,5,1,""],ConfigInputStream:[1,2,1,""],ConfigList:[1,2,1,""],ConfigMerger:[1,2,1,""],ConfigOutputStream:[1,2,1,""],ConfigReader:[1,2,1,""],ConfigResolutionError:[1,5,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.returnCode":{ReturnCode:[1,2,1,""]},"src.returnCode.ReturnCode":{KFSYS:[1,4,1,""],KNOWNFAILURE_STATUS:[1,4,1,""],KOSYS:[1,4,1,""],KO_STATUS:[1,4,1,""],NASYS:[1,4,1,""],NA_STATUS:[1,4,1,""],NDSYS:[1,4,1,""],OKSYS:[1,4,1,""],OK_STATUS:[1,4,1,""],TIMEOUT_STATUS:[1,4,1,""],TOSYS:[1,4,1,""],UNKNOWN_STATUS:[1,4,1,""],getValue:[1,3,1,""],getWhy:[1,3,1,""],indent:[1,3,1,""],isOk:[1,3,1,""],setStatus:[1,3,1,""],setValue:[1,3,1,""],setWhy:[1,3,1,""],toSys:[1,3,1,""]},"src.salomeTools":{Sat:[1,2,1,""],assumeAsList:[1,1,1,""],find_command_list:[1,1,1,""],getCommandsList:[1,1,1,""],getVersion:[1,1,1,""],launchSat:[1,1,1,""],setLocale:[1,1,1,""],setNotLocale:[1,1,1,""]},"src.salomeTools.Sat":{assumeAsList:[1,3,1,""],execute_cli:[1,3,1,""],getColoredVersion:[1,3,1,""],getCommandAndAppli:[1,3,1,""],getCommandInstance:[1,3,1,""],getConfig:[1,3,1,""],getConfigManager:[1,3,1,""],getLogger:[1,3,1,""],getModule:[1,3,1,""],get_help:[1,3,1,""],parseArguments:[1,3,1,""],print_help:[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,4,1,""],pattern:[1,4,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.utilsSat":{Path:[1,2,1,""],black:[1,1,1,""],blue:[1,1,1,""],check_config_has_application:[1,1,1,""],check_config_has_profile:[1,1,1,""],config_has_application:[1,1,1,""],critical:[1,1,1,""],cyan:[1,1,1,""],date_to_datetime:[1,1,1,""],deepcopy_list:[1,1,1,""],ensure_path_exists:[1,1,1,""],error:[1,1,1,""],find_file_in_lpath:[1,1,1,""],formatTuples:[1,1,1,""],formatValue:[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,""],green:[1,1,1,""],handleRemoveReadonly:[1,1,1,""],header:[1,1,1,""],info:[1,1,1,""],label:[1,1,1,""],list_log_file:[1,1,1,""],logger_info_tuples:[1,1,1,""],magenta:[1,1,1,""],merge_dicts:[1,1,1,""],normal:[1,1,1,""],only_numbers:[1,1,1,""],parse_date:[1,1,1,""],read_config_from_a_file:[1,1,1,""],red:[1,1,1,""],remove_item_from_list:[1,1,1,""],replace_in_file:[1,1,1,""],reset:[1,1,1,""],show_command_log:[1,1,1,""],success:[1,1,1,""],timedelta_total_seconds:[1,1,1,""],update_hat_xml:[1,1,1,""],warning:[1,1,1,""],white:[1,1,1,""],yellow:[1,1,1,""]},"src.utilsSat.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.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,"-"],architecture:[1,0,0,"-"],catchAll:[1,0,0,"-"],colorama:[2,0,0,"-"],coloringSat:[1,0,0,"-"],compilation:[1,0,0,"-"],configManager:[1,0,0,"-"],debug:[1,0,0,"-"],environment:[1,0,0,"-"],environs:[1,0,0,"-"],example:[3,0,0,"-"],exceptionSat:[1,0,0,"-"],fileEnviron:[1,0,0,"-"],fork:[1,0,0,"-"],loggingSat:[1,0,0,"-"],options:[1,0,0,"-"],product:[1,0,0,"-"],pyconf:[1,0,0,"-"],returnCode:[1,0,0,"-"],salomeTools:[1,0,0,"-"],system:[1,0,0,"-"],template:[1,0,0,"-"],test_module:[1,0,0,"-"],utilsSat:[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","attribute","Python attribute"],"5":["py","exception","Python exception"]},objtypes:{"0":"py:module","1":"py:function","2":"py:class","3":"py:method","4":"py:attribute","5":"py:exception"},terms:{"16be":1,"16le":1,"9abc":1,"boolean":[1,19],"case":1,"char":1,"class":[1,2,3,19],"default":[1,4,6,7,8,10,11,12,13,18],"else":1,"export":13,"final":[1,7,13],"float":1,"function":[1,2,19],"import":[1,8,19],"int":[1,11],"long":[1,5],"new":[1,13,19],"return":[1,8,19],"short":1,"true":[1,2],"try":1,"var":1,__init__:[1,3],__main__:1,__repr__:1,__save__:1,__setattr__:1,__str__:1,_appli:4,_basecmd:1,_blank:1,_build:8,_debug:1,_launch:8,_ld_library_path:8,_sre:[1,2],_type:1,_verbos:1,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],actual:[1,2,16],add:[1,6,15],add_com:1,add_echo:1,add_lin:1,add_opt:[1,19],add_simple_nod:1,add_warn:1,addelement:1,addit:[1,6,14],additional_dir:1,additional_env:1,addmap:1,addnamespac:1,adequ:1,advanc:1,affect:2,afil:1,after:[6,16],again:1,agent:13,aim:1,algorithm:19,alia:1,all:[1,2,5,7,8,9,13,14,18,19],allow:[1,6,7,9,15,18],alphanumer:1,alreadi:[12,19],also:[1,8,13,14,19],alter:13,amount:1,ani:[1,2,7,11,13],anoth:[1,14],ansi:[0,1],ansi_csi_re:2,ansi_escape_cod:2,ansi_osc_re: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,7,9,13],applic:1,application:[1,4,7,10],application_nam:4,applilog:1,appropri:1,arch:12,architectur:0,archiv:[1,12,13],archive_extract:1,archive_info:13,arg:[1,2,19],arglist:1,argument:1,argv:1,ascii:1,asctim:3,ask:1,assign:1,assum:1,assumeaslist:1,astr:1,astream:1,atitl:1,attibut:1,attr:[1,2],attrib:1,attribut:[1,2],authent:13,author:1,automat:[1,7,8],autoreset:2,autotool:[1,6],avail:7,avalu:1,avari:1,avoid:13,award:1,back:2,backend:1,backtick:1,base:[1,2,3],basenam:1,bash:[1,8,13],bashfileenviron:1,basic:1,bat:[1,8],batch:1,batch_salom:1,batfileenviron:1,becaus:1,been:[1,2],befor:[1,6],begin:1,behavior:19,belong:1,below:8,between:1,bienvenu:1,big:6,bin:8,binari:12,black:[1,2],blogmatrix:1,blue:[1,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,7,11,14],buf:1,build:[1,5,6,8,14],build_conf_opt:1,build_configur:1,build_sourc:6,builder:1,built:1,caa:1,call:[1,2,8,10,19],call_win32:2,callabl:1,can:[1,4,8,13,14,15,19],cannot:1,car:1,care:5,carri:1,catalog:[4,10],catchall:0,cfg:[1,8,19],cfg_env:1,cfgforpi:1,chang:[1,4,18,19],change_to_launch:1,charact:[1,2],charg:10,check:[1,6,8],check_config_exist:1,check_config_has_appl:1,check_config_has_profil:1,check_instal:1,check_path:1,check_src:1,checkout:[1,13],children:1,chmod:1,choic:7,choosen:1,circumst:1,clash:1,classic:1,clean:1,clean_al:[6,18],clean_build_aft:6,clean_instal:6,cleancolor:1,clear_lin:2,clear_screen:2,clearpag:[4,5,6,7,8,9,10,11,12,13,15,18,19],cli:[1,11,18],cli_:19,cli_argu:1,client:1,clone:13,close:1,closest:1,cmake:[1,6],cmake_opt:6,cmd:1,cmd_list:1,co7:12,code:[1,2,8],code_to_char:2,color:[1,2],colorama:[0,1],colorama_text:2,coloringsat:0,coloringstream:1,column:1,com:[1,3],come:7,command:[1,2],command_opt:18,command_valu:1,comment:[1,14],commentari:1,commit:5,common:1,commonli:1,compat:1,compil:0,compil_script:6,complementari:8,complet:[1,6,7,13,14],complete_environ:1,compon:[1,4,9],componon:9,compress:12,comput:[1,9,12],concaten:1,concern:13,config:1,config_has_appl:1,configerror:1,configformaterror:1,configinputstream:1,configlist:1,configmanag:0,configmerg:1,configopen:1,configoutputstream:1,configread:1,configresolutionerror:1,configur:1,configure_opt:1,configut:4,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,4,7,10,18],copydir:1,copyfil:1,copylink:1,copyright:1,corba:9,correct:1,correl:1,correspond:[1,8,11,13],could:[1,5,8,16],cpp:[1,9],creat:[1,4,5,8,10,12,13,14,15],create_config_fil:1,creation:12,critic:[1,3,19],critical:3,current:[1,7,14,18,19],cursor_adjust:2,cvs:12,cvs_extract:1,cvs_info:13,cvspass:13,cwd:1,cyan:[1,2],dai:1,data:[1,7,19],datadir:1,date:[1,14],date_to_datetim:1,datefmt:[1,3],datetim:1,david:1,dbg:1,debug:0,debug_writ:1,decid:1,declar:13,deep:1,deepcopy_list:1,deepcopymap:1,def:[8,19],default_valu:1,defaultformatt:1,defaultmergeresolv:1,defaultstreamopen:1,defin:[1,5,6,7,8,9,14,19],definit:1,deinit:2,delai:1,delaiapp:1,deleg:2,delet:12,delimit:1,delta:1,depend:[1,6,12],deriv:1,describ:1,descript:1,design:1,destnam:1,detail:1,detar:16,detect:1,determin:1,dev:1,develop:[1,5,7,8,13],dict:1,dict_arg:1,dictionari:[1,14],differ:[3,8],dim:2,dir:[1,7,13],dir_info:13,direct:1,directli:[8,11,16],directori:[1,4,5,6,7,8,10,11,12,13,14,16,18,19],dirlogg:1,dirpath:1,displai:[1,6,7,11,19],distant:4,distinguish:8,distrib:1,distribut:[1,4,9],divis:1,dixt:1,do_batch_script_build:1,do_default_build:1,do_python_script_build:1,do_script_build:1,doc:[1,3],doctyp:1,document:[9,14],doe:[1,8,13],dog:1,dollar:1,don:9,done:[1,8,18],dosometh:1,dosomethingtoreturn:1,dot:1,dove:1,down:2,download:[1,13],dst:1,due:1,dump:1,dumper:1,dumpertyp:1,duplic:6,dure:13,dynam:[1,14],each:[1,4,10,13,14],earlier:1,earliest:1,echo:1,ecrir:[1,3],edit:[7,13],editor:[1,7,14],either:[1,8],eleg:1,elem:1,element:1,element_factori:1,elementari:1,elementtre:0,els:[1,19],embed:12,empti:1,enable_simple_env_script:1,enclos:1,encod:1,end:[1,2,8],english:1,ensure:1,ensure_path_exist:1,entir:1,entri:1,env:[1,8],env_build:8,env_info:1,env_launch:8,env_script:8,environ:0,equal:6,eras:11,erase_lin:2,erase_screen:2,error:[1,3,19],essai:3,essai_logging_1:[0,1],essai_logging_2:[0,1],etc:[1,14,15],etre:1,etree:1,eval:1,evalu:1,evaluat:1,event:1,everyth:6,exactli:1,exampl:[0,1],exc:1,except:[1,13,18],exception:1,exceptionsat:0,execut:[1,6,13,18],execute_cli:1,exept:1,exhaust:[14,18],exist:[1,12,13,18],exot:1,expect:1,explain:8,explan:1,explicitli:1,explor:1,explore:7,express:[1,7],expression:1,ext:1,extens:[1,19],extern:1,extra:1,extract:1,extract_param:2,fact:19,factor:1,factori:1,fail:[1,6],fals:[1,2],far:1,favorit:7,feed:1,field:1,file:[1,4,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:5,fin:1,find:[1,7,15,16],find_command_list:1,find_file_in_lpath:1,find_node_by_attrib:1,findal:1,findconfig:1,findtext:1,finish:1,firefox:[11,14],first:[1,8,13,19],fix:1,flag:6,flush:1,fmt:[1,3],follow:[1,8,19],for_packag:1,forbuild:1,forc:[1,12,13],force_patch:13,fore:2,fork:0,form:1,format:[1,3,8,14],formatt:[1,3],formattupl:1,formatvalu:1,forward:[2,4,10],found:1,four:8,french:19,from:[1,2,7,8,9,12,13,19],from_what:1,fromstr:1,full:1,fun:7,func:1,futur:1,gdb:8,gencat:[4,10],gener:[1,2,4,8],generate_launching_command:1,generate_script:1,generic_opt:18,geom:6,get:[1,7,13,14],get_attr:2,get_attrib:1,get_base_install_dir:1,get_base_path:1,get_cfg_param:1,get_command_line_overrid:1,get_config:1,get_config_children: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_path: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_products_list: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_user_config_fil:1,get_win32_cal:2,getbypath:1,getchar:1,getcoloredvers:1,getcommandandappli:1,getcommandinst:1,getcommandslist:1,getconfig:[1,19],getconfigcolor:1,getconfigmanag:1,getdefaultlogg:1,getdetailopt:1,getiter:1,getlocalenv:1,getlog:1,getlogg:1,getlogsandclear:1,getmodul:1,getmylogg:3,getroot:1,getrootattrib:1,getstrconfigdbg:1,getstrconfigstd:1,gettmpdir:1,gettmpdirdefault:1,gettoken:1,getunittestlogg:1,getvalu:1,getvers:1,getwhi:1,git:[1,12],git_extract:1,git_info:13,gitconfig:13,give:[1,4,14,19],given:[1,2,4,8,10],global:1,goe:1,green:[1,2],grep:[1,7],grey:2,grid:1,gui:1,hack_libtool:1,had:1,handl:[1,2,8],handlemismatch:1,handler:[1,3],handleremovereadonli:1,harri:1,has_salome_hui:1,has_timed_out:1,hat:1,have:[1,4,5,9,10,13],header:1,help:1,helpstr:1,here:[1,8,14,19],hierarchi:1,himself:8,hold:10,home:7,hour:1,how:[1,8,13,14],html:[1,3],http:[1,2,3],human:1,hxx2salom:9,i18n:1,ident:1,identifi:1,ignor:[1,9],ignorelist:1,imag:13,implement:[1,2,8],includ:[1,8,12,14],include:12,indent:1,indentunittest:1,index:1,indic:1,indirect:1,info:[1,3,7,13,19],inform:[1,7,12,13,14],inherit:1,init:[1,2,3],initi:1,initialis:[0,1],initloggerasdefault:1,initloggerasunittest:1,initmylogg:3,inmap:1,input:1,input_list:1,insid:13,instal:[1,5,6,14,16,18],install:[5,18],install_dir:8,installat:15,instanc:[1,2,19],instanti:1,instantiat:1,instead:1,instream:1,instruct:[1,14],intal:12,interact:11,interfac:[1,18],intern:1,internation:1,invalid:1,ioerror:1,iostream:1,is_a_tti:2,is_defin:1,is_salome_modul:[5,8],is_stream_clos:2,is_window:1,isdir:1,isel:1,isfil:1,islink:1,isok:1,issu:2,isword:1,item:1,iter:1,iteritem:1,iterkei:1,iterpars:1,ivar:1,jane:1,job:6,join:8,json:1,jsondump:1,just:6,keep:1,kei:[1,8,13],kernel:[7,18],kfsys:1,killsalom:1,know:[1,13],known:[1,12],knownfailure_status:1,ko_status:1,kosys:1,kwarg:2,kwd:2,label:[1,7],lang:1,lapack:8,lapack_root_dir:8,last:[1,8,11],last_termin:11,later:12,latter:1,launch:[1,8],launch_command:1,launched_cmd:1,launcher:[1,4,8],launcher_nam:10,launcherfileenviron:1,launchsat:1,layer:9,ld_library_path:8,left:8,less:1,level:[1,3,18],levelnam:[1,3],lib:[3,8],librari:[1,3],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,4,6,7,10,14],line:[1,7,18],link:[1,13],list:[1,4,5,7,10,14],list_log_fil:1,list_of_product:9,listtest:1,llvm:[4,10],load:[1,14],load_cfg_environ:1,load_environ:1,local:[1,7],locat:1,log:[1,3,6],log_command:1,log_dir:11,logdir:1,logfilepath:1,logger:[1,3],logger_info_tupl:1,loggingsat:0,login:13,logo:[1,10],logs:1,lome:15,longnam:1,lost:1,lpath:1,lproduct:1,machin:[1,4,9,10,12],machine1:4,machine2:4,machine3:4,magenta:[1,2],mai:13,main:[1,6],make:[1,6],make_flag:6,make_opt:1,makepath:1,manag:[1,7,13],manipul:[1,7],map1:1,map2:1,map:1,match:1,max:1,mechan:[1,8],med:6,memori:[1,4,10],menu:11,merg:1,merge:1,merge_dict:1,mergemap:1,mergesequ:1,mesa:[4,10],messag:[1,3,19],method:[1,2,6,8,13,19],milou:1,minim:1,minut:1,mismatch:1,miss:[4,6],mistak:13,mode:[1,2,5,7,8,11],model:19,modifi:[1,8,13],modul:0,moment:1,mon:1,mond:19,more:[1,18],most:[1,8],msg:1,multi:1,multilin:1,multipl:1,must:19,mutipl:1,my_application_directori:4,my_application_nam:4,my_tag:13,mycommand:19,myformatt:3,mylogg:3,myoption:19,myspecificnam:12,mytempl:1,na_status:1,name:[1,4,5,7,8,10,12,13,14,18,19],name_nod:1,namespac:1,nasys:1,nativ:[1,8],nb_line:1,nb_proc:[1,6],ndsys:1,necessari:1,need:[1,2,4,9,13],new_nam:7,next:1,nfirst:1,no_label:7,node:1,node_nam:1,non:2,none:[1,2,3],nor:2,normal:[1,2],note:[1,4,8,10,14],noth:[1,12],notimplementederror:1,notion:1,notshowncommand:1,number:[1,4,6,10,11],number_of_proc:1,obj1:1,obj2:1,obj:1,object:[1,2,14],obsolete:19,obtain:1,obvious:1,occur:1,ok_status:1,oksys:1,old:1,older:11,on_stderr:2,onc:13,one:1,onli:[1,4,5,6,7,8,9,10,11,13,18],only_numb:1,ool:15,open:1,openggl:[4,10],openmpi:1,oper:[1,7,15],operand:1,opt_nb_proc:1,option:0,optionali:1,optionn:1,optionnali:1,optiontyp:1,optresult:1,order:[1,13,14,19],org:[1,2,3],other:[1,3,8,12,14],otherwis:[1,13],our:2,out:1,out_dir:1,output:[1,2],outstream:1,overrid:[1,4],overwrit:1,overwritekei:1,overwritemergeresolv:1,overwritten:1,own:1,packag:0,page:8,pair:1,param:[1,2],param_nam:1,paramet:[1,7,14,19],parameter_path:7,paramstr:2,paravi:[4,10],parent: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,4,8,10],particular:1,pass:[1,14,19],passphras:13,password:13,pat:1,patch:[1,7,13],path:1,path_to_catalog:4,path_to_yacsgen:9,pathlist:1,paths:7,pattern:1,pdf:[7,15],pend:5,pendant:1,perform:[1,13,15],person:7,phase:1,platform:[2,8],pleas:[8,9],plugin:[1,6],pluma:14,plusieur:3,point:[1,19],pop_debug:1,popen:1,popul:1,pos:2,posit:2,possibl:[1,8,13,19],post:1,potenti:1,pprty:1,preced:1,predefin:1,prefer:[7,14],prefix:[1,8,14],prepar:1,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,present:1,pretti:1,previou:1,previous:5,print:[1,2,7,11],print_debug:1,print_grep_environ:1,print_help:1,print_split_environ:1,print_split_pattern_environ:1,print_valu:1,problem:[1,4,10],procedur:1,process:[1,13],processinginstruct:1,processor:[1,4,10],prod_dir:1,prod_info:1,produc:1,product1:[6,8,13],product2:[6,8,13],product:0,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_inform: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_salome:1,product_is_sampl:1,product_is_smesh_plugin:1,product_is_vc:1,product_nam:1,profil:[1,10],program:1,programmat:8,progress:1,project:[1,7,8],project_path:1,projects:1,properti:[1,5,8,9],protocol:[1,4],provid:[1,8,19],proxi:2,pubid:1,push:13,push_debug:1,put:1,put_txt_log_in_appli_log_dir:1,pv_plugin_path:1,pwd:1,pyc:3,pyconf:0,python2:3,python:[1,3,8,10,14,15,16,19],python_config:1,pythonpath:8,pythonpath_:8,qname:1,queri:[4,10],question:1,rais:[1,18],raw:1,rc1:1,rc2:1,rcfinal:1,rco:1,read:1,read_config_from_a_fil:1,read_result:1,readabl:1,reader:1,readi:13,readlin:1,readlink:1,readxmlfil:1,record:[1,3],recurs:[1,7],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],remark:4,remor:9,remot:[1,12],remov:[1,5,6,13],remove_item_from_list:1,removenamespac:1,renam:1,renint:1,replac:[1,4],replace_in_fil:1,report:1,repositori:[1,13],repr:1,repres:1,represent:1,request:2,requir:[1,2,8,9],reserv:1,reset:[1,2],reset_al:2,reset_all:2,resolut:1,resolv:1,resourc:[4,10],respect:8,restor:[1,5],result:1,retriev:1,returncod:0,right:[1,8],root:[1,19],root_nod:1,rootnam:1,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:4,runner:[1,19],ruud:1,sajip:1,salom:[1,4,8,10],salome:[1,4,5,6,7,8,9,10,12,14,15,16],salome_modules:1,salome_session_serv:1,salome_xx:[5,12,16,18],salome_xx_:12,salomecontext:1,salomeenviron:1,salometool:0,same:1,sametmax:[1,3],sampl:1,samples:18,sat:[1,4,5,6,7,8,9,10,11,12,13,14,15,16],save:8,saveconfigdbg:1,saveconfigstd:1,scalar:1,scratch:1,screenenviron:1,script:[1,6,7,8,10,14,15,16],script_nam:1,script_path:1,search:1,search_known_error:1,second:[1,8],section:[1,4,8,13],secur:13,see:[1,2,14,18],seen:1,select:[1,12],self:1,semant:1,sep:[1,8],separ:1,seq1:1,seq2:1,seq:1,seqiter:1,sequenc:[1,2],server:[1,13],servic:19,session:1,set:[1,4,5,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,set_user_config_fil:1,setcolorlevelnam:1,setconsoletextattribut:2,setlocal:1,setnotlocal:1,setpath:1,setstatu:1,setstream:1,setvalu:1,setwhi:1,sever:[8,14],shallow:1,shell:[1,8],shortcut:1,shortnam:1,should:[1,8,9],should_wrap:2,show:[1,6,11],show_command_log:1,show_desktop:1,show_full_path:1,show_in_editor:1,show_label:1,show_patch:[1,7],show_product_info:1,show_progress:1,show_warn:1,showinfo:1,shown:[1,6],sign:1,silent:1,similar:1,simpl:[1,18,19],sinc:1,size:1,small:1,smart:1,smartcopi:1,smesh:1,softwar:13,some:1,someon:8,sometim:5,sommeil:1,soon:6,sourc:[1,2,3,5,7,12,13],sources:[5,13,18],sources_without_dev:5,space:1,special_path_separ:1,specif:[1,4,5,8,9,10,12,14,18],specifi:[1,4,8,9,10,13],splashscreen:10,split:1,src_root:1,sre_pattern:[1,2],srsc:1,ssh:[4,10,13],stack:18,stackoverflow:1,start:[1,2,4,6,10],statu:1,stderr:1,stdout:[1,2],step:1,stop:6,stop_first_fail:6,store:[1,6,7,11,13,14],str:1,str_num:1,stream:[1,2],streamopen:1,streamorfil:1,streamwrapp:2,strftime:[1,3],strin:1,string:1,stringio:1,strip:2,strorlist:1,strout:1,structur:14,stuff:[1,10],style:[1,2],stylesheet:1,sub:[1,14],subclass:1,subelement:1,submodul:0,subpackag:0,subprocess:1,subsect:8,subset:12,subst_dic:1,substitut:1,substr:1,subtract:1,success:[1,6],successfulli:1,suffici:8,suffix:1,suit:15,suitabl:1,support:1,suppos:1,supposedli:1,suppress:5,sur:3,svn:[1,12],svn_extract:1,svn_info:13,symlink:1,syntax:[1,5],syss:1,system:0,tab:1,tabl:1,tabul:1,tag:[1,13],take:[1,5],taken:[1,8],tar:[12,16],target:[1,4,8],tcllibpath:1,templat:0,template_fil:1,term:1,termin:[1,2,6,11,19],test:[1,3,6,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,testlogger1:3,testlogger_1:1,text:[1,2,18],text_or_uri:1,tgz:[12,16],thank:1,thei:[5,7,8,13],them:[2,13],thi:[1,2,4,6,7,8,9,10,12,13,14,15,19],thing:19,those:9,through:[1,4,8,10,11],thrown:1,time:[1,3,5,8,13,14],timedelta:1,timedelta_total_second:1,timeout:1,timeout_status:1,tintin:1,tip:1,titl:[1,2],tklibpath:1,tmp:1,tmp_working_dir:1,tocolor:1,tocolor_ansitowin32:1,todo:1,tofix:1,token:1,token_typ:1,token_valu:1,too:1,top:1,tosi:1,tostr:1,tosys:1,total_second:1,tout:19,trace:[1,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:6,unittest:1,unittestformatt:1,unitteststream:1,unix:1,unknown_status:1,unless:[2,13],update:1,update_hat_xml:1,updatehatxml:1,urllib2:1,urlopen:1,usag:[1,18],use:[4,5,6,7,8,9,10,13],use_mesa:[4,10],used:1,useful:[1,18],user:[1,7,8,11,12],usernam:1,users:7,using:19,usr:[1,3,8],usual:[1,5,9,12,14,18],usualli:[12,16],utf:[1,8],util:[1,12,15],utilis:3,utiliti:1,utilssat:0,uts:1,valid:1,valu:[1,2,4,5,7,13,14],variabl:[1,8,9,19],vars:8,vcs:[5,12],verbos:1,verifi:[1,13],version:[1,8,9,12,14,15],via:1,viewer:7,vinai:1,virtual:[1,4],virtual_app:4,visualis:8,wai:[1,6,19],want:[1,5,8],warn:[1,3,6,19],warning:[1,3],web:[7,11,14],welcom:1,welkom:1,well:1,were:1,what:[1,5],when:[1,4,8,13,14,19],whenev:1,where:[1,4,6,7,12],which:[1,2,8,9,14,19],white:[1,2],who:9,why:1,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:6,with_commerci:1,with_fath:6,with_install_dir:1,with_vc:12,within:8,without:[1,7,13],without_properti:12,wmake:1,word:1,work:[1,7,12,13,14],workdir:[1,4,7,10,12,14,18,19],world:19,would:1,wrap:[1,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,xmlmgr:1,xmlroot:1,xmltreebuild:1,xxx:[1,5,14],xxx_root_dir:1,xxx_src_dir:1,yacsgen:[1,9],yacsgen_root_dir:9,year:1,yellow:[1,2],yet:[1,18],yield:1,you:[1,4,5,8,10,13,15,19],your:[1,8,13,18,19],yourspecificnam:12,yve:1,yyy:14,yyyy:1,yyyymmdd_hhmmss:1,yyyymmdd_hhmmss_namecmd:1,zelaunch:10,zero:1,zerodivideerror:1},titles:["src","src package","src.colorama package","src.example 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:{access:19,add:19,ansi:2,ansitowin32:2,applic:4,application:14,architectur:1,avail:18,availabl:5,base:13,basic:19,build:18,catchall:1,clean:5,code:15,colorama:2,coloringsat:1,command:[4,5,6,7,8,9,10,11,12,13,15,19],compil:[1,6,18],config:[7,19],configmanag:1,configur:[4,5,6,7,8,10,11,12,13,14],content:[1,2,3],custom:19,debug:[1,18],descript:[4,5,6,7,8,9,10,11,12,13,14],dev:13,develop:15,document:15,elementtre:1,environ:[1,8],essai_logging_1:3,essai_logging_2:3,exampl:[3,19],exceptionsat:1,fileenviron:1,fork:1,gener:9,get:18,git:13,hello:19,help:18,howto:19,initialis:2,installat:16,introduct:19,launcher:10,list:[15,18],log:11,logger:19,loggingsat:1,mode:13,modul:[1,2,3],note:[15,17],option:[1,5,18],other:19,packag:[1,2,3,12],path:[4,5,6,7,11,12,13],prepar:[13,18],product:[1,18],products:14,pyconf:1,quick:15,releas:[15,17],remark:[9,13],requir:19,returncod:1,salom:15,salome:18,salometool:[1,18,19],sat:18,section:14,some:[4,5,6,7,11,12,13],sourc:18,src:[0,1,2,3],start:15,submodul:[1,2,3],subpackag:1,svn:13,syntax:14,system:1,templat:1,test_modul:1,tool:15,usage:[4,5,6,7,8,9,10,11,12,13,18],user:[14,19],utilssat:1,vars:14,vcs:13,verbos:18,win32:2,winterm:2,xmlmanag:1}})
\ No newline at end of file
-
<!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>Usage of SAlomeTools — salomeTools 5.0.0dev documentation</title>
+
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
- <script type="text/javascript" src="_static/documentation_options.js"></script>
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: './',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
- <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/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="top" title="salomeTools 5.0.0dev documentation" href="index.html" />
<link rel="next" title="Command config" href="commands/config.html" />
<link rel="prev" title="Configuration" href="configuration.html" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
- </head><body>
+ </head>
+ <body role="document">
<div class="document">
<div class="section" id="usage">
<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
<p>sat usage is a Command Line Interface (<a class="reference external" href="https://en.wikipedia.org/wiki/Command-line_interface">CLI</a>).</p>
-<div class="highlight-bash
notranslate"><div class="highlight"><pre><span></span>sat <span class="o">[</span>generic_options<span class="o">]</span> <span class="o">[</span>command<span class="o">]</span> <span class="o">[</span>product<span class="o">]</span> <span class="o">[</span>command_options<span class="o">]</span>
+<div class="highlight-bash"><div class="highlight"><pre><span></span>sat <span class="o">[</span>generic_options<span class="o">]</span> <span class="o">[</span>command<span class="o">]</span> <span class="o">[</span>product<span class="o">]</span> <span class="o">[</span>command_options<span class="o">]</span>
</pre></div>
</div>
<div class="section" id="options-of-sat">
<h3>Options of sat<a class="headerlink" href="#options-of-sat" title="Permalink to this headline">¶</a></h3>
<p>Useful <em>not exhaustive</em> generic options of <em>sat</em> CLI.</p>
<div class="section" id="help-or-h">
-<h4><em>
–help or -h</em><a class="headerlink" href="#help-or-h" title="Permalink to this headline">¶</a></h4>
+<h4><em>
--help or -h</em><a class="headerlink" href="#help-or-h" title="Permalink to this headline">¶</a></h4>
<p>Get help as simple text.</p>
-<div class="highlight-bash
notranslate"><div class="highlight"><pre><span></span>sat --help <span class="c1"># get the list of existing commands</span>
+<div class="highlight-bash"><div class="highlight"><pre><span></span>sat --help <span class="c1"># get the list of existing commands</span>
sat --help compile <span class="c1"># get the help on a specific command 'compile'</span>
</pre></div>
</div>
</div>
<div class="section" id="debug-or-g">
-<h4><em>
–debug or -g</em><a class="headerlink" href="#debug-or-g" title="Permalink to this headline">¶</a></h4>
+<h4><em>
--debug or -g</em><a class="headerlink" href="#debug-or-g" title="Permalink to this headline">¶</a></h4>
<p>Execution in debug mode allows to see more trace and <em>stack</em> if an exception is raised.</p>
</div>
<div class="section" id="verbose-or-v">
-<h4><em>
–verbose or -v</em><a class="headerlink" href="#verbose-or-v" title="Permalink to this headline">¶</a></h4>
+<h4><em>
--verbose or -v</em><a class="headerlink" href="#verbose-or-v" title="Permalink to this headline">¶</a></h4>
<p>Change verbosity level (default is 3).</p>
-<div class="highlight-bash
notranslate"><div class="highlight"><pre><span></span><span class="c1"># for product 'SALOME_xx' for example</span>
+<div class="highlight-bash"><div class="highlight"><pre><span></span><span class="c1"># for product 'SALOME_xx' for example</span>
<span class="c1"># execute compile command in debug mode with trace level 4</span>
sat -g -v <span class="m">4</span> compile SALOME_xx
</pre></div>
<div class="section" id="get-the-list-of-available-products">
<h3>Get the list of available products<a class="headerlink" href="#get-the-list-of-available-products" title="Permalink to this headline">¶</a></h3>
<p>To get the list of the current available products in your context:</p>
-<div class="highlight-bash
notranslate"><div class="highlight"><pre><span></span>sat config --list
+<div class="highlight-bash"><div class="highlight"><pre><span></span>sat config --list
</pre></div>
</div>
</div>
<div class="section" id="prepare-sources-of-a-product">
<h3>Prepare sources of a product<a class="headerlink" href="#prepare-sources-of-a-product" title="Permalink to this headline">¶</a></h3>
<p>To prepare (get) <em>all</em> the sources of a product (<em>SALOME_xx</em> for example):</p>
-<div class="highlight-bash
notranslate"><div class="highlight"><pre><span></span>sat prepare SALOME_xx
+<div class="highlight-bash"><div class="highlight"><pre><span></span>sat prepare SALOME_xx
</pre></div>
</div>
<div class="line-block">
<div class="line">The sources are usually copied in directories</div>
-<div class="line"><em>$USER.workDir + SALOME_xx… + SOURCES + $PRODUCT.name</em></div>
+<div class="line"><em>$USER.workDir + SALOME_xx... + SOURCES + $PRODUCT.name</em></div>
</div>
</div>
<div class="section" id="compile-salome">
<h3>Compile SALOME<a class="headerlink" href="#compile-salome" title="Permalink to this headline">¶</a></h3>
<p>To compile products:</p>
-<div class="highlight-bash
notranslate"><div class="highlight"><pre><span></span><span class="c1"># compile all prerequisites/products</span>
+<div class="highlight-bash"><div class="highlight"><pre><span></span><span class="c1"># compile all prerequisites/products</span>
sat compile SALOME_xx
<span class="c1"># compile only 2 products (KERNEL and SAMPLES), if not done yet</span>
</div>
<div class="line-block">
<div class="line">The products are usually build in the directories</div>
-<div class="line"><em>$USER.workDir + SALOME_xx… + BUILD + $PRODUCT.name</em></div>
+<div class="line"><em>$USER.workDir + SALOME_xx... + BUILD + $PRODUCT.name</em></div>
<div class="line"><br /></div>
<div class="line">The products are usually installed in the directories</div>
-<div class="line"><em>$USER.workDir + SALOME_xx… + INSTALL + $PRODUCT.name</em></div>
+<div class="line"><em>$USER.workDir + SALOME_xx... + INSTALL + $PRODUCT.name</em></div>
</div>
</div>
</div>
<li><a class="reference internal" href="#">Usage of SAlomeTools</a><ul>
<li><a class="reference internal" href="#usage">Usage</a><ul>
<li><a class="reference internal" href="#options-of-sat">Options of sat</a><ul>
-<li><a class="reference internal" href="#help-or-h"><em>–help or -h</em></a></li>
-<li><a class="reference internal" href="#debug-or-g"><em>–debug or -g</em></a></li>
-<li><a class="reference internal" href="#verbose-or-v"><em>–verbose or -v</em></a></li>
+<li><a class="reference internal" href="#help-or-h"><em>--help or -h</em></a></li>
+<li><a class="reference internal" href="#debug-or-g"><em>--debug or -g</em></a></li>
+<li><a class="reference internal" href="#verbose-or-v"><em>--verbose or -v</em></a></li>
</ul>
</li>
</ul>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
- <li><a href="_sources/usage_of_sat.rst.txt"
+ <li><a href="_sources/usage_of_sat.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" />
+ <div><input type="text" name="q" /></div>
+ <div><input type="submit" value="Go" /></div>
<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>
©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>
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.9</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
|
- <a href="_sources/usage_of_sat.rst.txt"
+ <a href="_sources/usage_of_sat.txt"
rel="nofollow">Page source</a>
</div>
-
<!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>Add a user custom command — salomeTools 5.0.0dev documentation</title>
+
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
- <script type="text/javascript" src="_static/documentation_options.js"></script>
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: './',
+ VERSION: '5.0.0dev',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
- <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+ <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/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="top" title="salomeTools 5.0.0dev documentation" href="index.html" />
<link rel="next" title="src" href="commands/apidoc/modules.html" />
<link rel="prev" title="Command generate" href="commands/generate.html" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
- </head><body>
+ </head>
+ <body role="document">
<div class="document">
<p class="last">This documentation is for <a class="reference external" href="https://docs.python.org/2.7">Python</a> developers.</p>
</div>
<p>The salomeTools product provides a simple way to develop commands.
-The first thing to do is to add a file with <em>.py</em> extension in the <code class="docutils literal notranslate"><span class="pre">commands</span></code> directory of salomeTools.</p>
+The first thing to do is to add a file with <em>.py</em> extension in the <code class="docutils literal"><span class="pre">commands</span></code> directory of salomeTools.</p>
<p>Here are the basic requirements that must be followed in this file in order to add a command.</p>
</div>
<div class="section" id="basic-requirements">
<h2>Basic requirements<a class="headerlink" href="#basic-requirements" title="Permalink to this headline">¶</a></h2>
-<p>By adding a file <em>mycommand.py</em> in the <code class="docutils literal notranslate"><span class="pre">commands</span></code> directory, salomeTools will define a new command named <code class="docutils literal notranslate"><span class="pre">mycommand</span></code>.</p>
+<div class="admonition warning">
+<p class="first admonition-title">Warning</p>
+<p class="last">ALL THIS IS OBSOLETE FOR SAT 5.1</p>
+</div>
+<p>By adding a file <em>mycommand.py</em> in the <code class="docutils literal"><span class="pre">commands</span></code> directory, salomeTools will define a new command named <code class="docutils literal"><span class="pre">mycommand</span></code>.</p>
<p>In <em>mycommand.py</em>, there must be the following method:</p>
-<div class="highlight-default
notranslate"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">run</span><span class="p">(</span><span class="n">args</span><span class="p">,</span> <span class="n">runner</span><span class="p">,</span> <span class="n">logger</span><span class="p">):</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">run</span><span class="p">(</span><span class="n">args</span><span class="p">,</span> <span class="n">runner</span><span class="p">,</span> <span class="n">logger</span><span class="p">):</span>
<span class="c1"># your algorithm ...</span>
<span class="k">pass</span>
</pre></div>
<ul class="simple">
<li>You can give some options to your command:</li>
</ul>
-<div class="highlight-python
notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">src</span>
+<div class="highlight-python"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">src</span>
<span class="c1"># Define all possible option for mycommand command : 'sat mycommand <options>'</span>
<span class="n">parser</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">options</span><span class="o">.</span><span class="n">Options</span><span class="p">()</span>
<ul class="simple">
<li>You can add a <em>description</em> method that will display a message when the user will call the help:</li>
</ul>
-<div class="highlight-python
notranslate"><div class="highlight"><pre><span></span> <span class="kn">import</span> <span class="nn">src</span>
+<div class="highlight-python"><div class="highlight"><pre><span></span> <span class="kn">import</span> <span class="nn">src</span>
<span class="c1"># Define all possible option for mycommand command : 'sat mycommand <options>'</span>
<span class="n">parser</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">options</span><span class="o">.</span><span class="n">Options</span><span class="p">()</span>
<div class="section" id="howto-access-salometools-config-and-other-commands">
<h2>HowTo access salomeTools config and other commands<a class="headerlink" href="#howto-access-salometools-config-and-other-commands" title="Permalink to this headline">¶</a></h2>
<p>The <em>runner</em> variable is an python instance of <em>Sat</em> class.
-It gives access to <em>runner.cfg</em> which is the data model defined from all
+It gives access to <em>runner.getConfig()</em> which is the data model defined from all
<em>configuration pyconf files</em> of salomeTools
For example, <em>runner.cfg.APPLICATION.workdir</em>
contains the root directory of the current application.</p>
<p>The <em>runner</em> variable gives also access to other commands of salomeTools:</p>
-<div class="highlight-python
notranslate"><div class="highlight"><pre><span></span><span class="c1"># as CLI_ 'sat prepare ...'</span>
+<div class="highlight-python"><div class="highlight"><pre><span></span><span class="c1"># as CLI_ 'sat prepare ...'</span>
<span class="n">runner</span><span class="o">.</span><span class="n">prepare</span><span class="p">(</span><span class="n">runner</span><span class="o">.</span><span class="n">cfg</span><span class="o">.</span><span class="n">VARS</span><span class="o">.</span><span class="n">application</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="howto-logger">
<h2>HowTo logger<a class="headerlink" href="#howto-logger" title="Permalink to this headline">¶</a></h2>
-<p>The logger variable is an instance of the Logger class.
-It gives access to the write method.</p>
-<p>When this method is called, the message passed as parameter
+<p>The logger variable is an instance of the python <code class="docutils literal"><span class="pre">logging</span></code> package class.
+It gives access to <code class="docutils literal"><span class="pre">debug,</span> <span class="pre">info,</span> <span class="pre">warning,</span> <span class="pre">error,</span> <span class="pre">critical</span></code> methods.</p>
+<p>Using these methods, the message passed as parameter
will be displayed in the terminal and written in an xml log file.</p>
-<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">"My message"</span><span class="p">,</span> <span class="mi">3</span><span class="p">)</span> <span class="c1"># 3 as default</span>
+<div class="highlight-python"><div class="highlight"><pre><span></span><span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">"My message"</span><span class="p">)</span>
</pre></div>
</div>
-<p>The second argument defines the level of verbosity
-that is wanted for this message.
-It has to be between 1 and 5 (the most verbose level).</p>
</div>
<div class="section" id="hello-example">
<h2>HELLO example<a class="headerlink" href="#hello-example" title="Permalink to this headline">¶</a></h2>
<p>Here is a <em>hello</em> command, file <em>commands/hello.py</em>:</p>
-<div class="highlight-python
notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">src</span>
+<div class="highlight-python"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">src</span>
<span class="sd">"""</span>
<span class="sd">hello.py</span>
</pre></div>
</div>
<p>A first call of hello:</p>
-<div class="highlight-bash
notranslate"><div class="highlight"><pre><span></span><span class="c1"># Get the help of hello:</span>
+<div class="highlight-bash"><div class="highlight"><pre><span></span><span class="c1"># Get the help of hello:</span>
./sat --help hello
<span class="c1"># To get bonjour</span>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
- <li><a href="_sources/write_command.rst.txt"
+ <li><a href="_sources/write_command.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" />
+ <div><input type="text" name="q" /></div>
+ <div><input type="submit" value="Go" /></div>
<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>
©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>
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.9</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
|
- <a href="_sources/write_command.rst.txt"
+ <a href="_sources/write_command.txt"
rel="nofollow">Page source</a>
</div>
ALLDOCS = $(basename $(wildcard *.tex))
ALLPDF = $(addsuffix .pdf,$(ALLDOCS))
ALLDVI = $(addsuffix .dvi,$(ALLDOCS))
-ALLXDV =
-ALLPS = $(addsuffix .ps,$(ALLDOCS))
-ALLIMGS = $(wildcard *.png *.gif *.jpg *.jpeg)
# Prefix for archive names
-ARCHIVEPREFIX =
-# Additional LaTeX options (passed via variables in latexmkrc/latexmkjarc file)
-export LATEXOPTS =
-# Additional latexmk options
-LATEXMKOPTS =
-# format: pdf or dvi (used only by archive targets)
+ARCHIVEPRREFIX =
+# Additional LaTeX options
+LATEXOPTS =
+# format: pdf or dvi
FMT = pdf
-LATEX = latexmk -dvi
-PDFLATEX = latexmk -pdf -dvi- -ps-
-
-
-%.png %.gif %.jpg %.jpeg: FORCE_MAKE
- extractbb '$@'
-
-%.dvi: %.tex FORCE_MAKE
- $(LATEX) $(LATEXMKOPTS) '$<'
-
-%.ps: %.dvi
- dvips '$<'
-
-%.pdf: %.tex FORCE_MAKE
- $(PDFLATEX) $(LATEXMKOPTS) '$<'
+LATEX = latex
+PDFLATEX = pdflatex
+MAKEINDEX = makeindex
all: $(ALLPDF)
-
-all-dvi: $(ALLDVI)
-
-all-ps: $(ALLPS)
-
all-pdf: $(ALLPDF)
+all-dvi: $(ALLDVI)
+all-ps: all-dvi
+ for f in *.dvi; do dvips $$f; done
+
+all-pdf-ja:
+ for f in *.pdf *.png *.gif *.jpg *.jpeg; do extractbb $$f; done
+ for f in *.tex; do platex -kanji=utf8 $(LATEXOPTS) $$f; done
+ for f in *.tex; do platex -kanji=utf8 $(LATEXOPTS) $$f; done
+ for f in *.tex; do platex -kanji=utf8 $(LATEXOPTS) $$f; done
+ -for f in *.idx; do mendex -U -f -d "`basename $$f .idx`.dic" -s python.ist $$f; done
+ for f in *.tex; do platex -kanji=utf8 $(LATEXOPTS) $$f; done
+ for f in *.tex; do platex -kanji=utf8 $(LATEXOPTS) $$f; done
+ for f in *.dvi; do dvipdfmx $$f; done
zip: all-$(FMT)
mkdir $(ARCHIVEPREFIX)docs-$(FMT)
xz: tar
xz -9 -k $(ARCHIVEPREFIX)docs-$(FMT).tar
+# The number of LaTeX runs is quite conservative, but I don't expect it
+# to get run often, so the little extra time won't hurt.
+%.dvi: %.tex
+ $(LATEX) $(LATEXOPTS) '$<'
+ $(LATEX) $(LATEXOPTS) '$<'
+ $(LATEX) $(LATEXOPTS) '$<'
+ -$(MAKEINDEX) -s python.ist '$(basename $<).idx'
+ $(LATEX) $(LATEXOPTS) '$<'
+ $(LATEX) $(LATEXOPTS) '$<'
+
+%.pdf: %.tex
+ $(PDFLATEX) $(LATEXOPTS) '$<'
+ $(PDFLATEX) $(LATEXOPTS) '$<'
+ $(PDFLATEX) $(LATEXOPTS) '$<'
+ -$(MAKEINDEX) -s python.ist '$(basename $<).idx'
+ $(PDFLATEX) $(LATEXOPTS) '$<'
+ $(PDFLATEX) $(LATEXOPTS) '$<'
+
clean:
- rm -f *.log *.ind *.aux *.toc *.syn *.idx *.out *.ilg *.pla *.ps *.tar *.tar.gz *.tar.bz2 *.tar.xz $(ALLPDF) $(ALLDVI) $(ALLXDV) *.fls *.fdb_latexmk
+ rm -f *.log *.ind *.aux *.toc *.syn *.idx *.out *.ilg *.pla *.ps *.tar *.tar.gz *.tar.bz2 *.tar.xz $(ALLPDF) $(ALLDVI)
.PHONY: all all-pdf all-dvi all-ps clean zip tar gz bz2 xz
-.PHONY: FORCE_MAKE
\ No newline at end of file
+.PHONY: all-pdf-ja
+
+++ /dev/null
-\NeedsTeXFormat{LaTeX2e}
-\ProvidesPackage{footnotehyper-sphinx}%
- [2017/10/27 v1.7 hyperref aware footnote.sty for sphinx (JFB)]
-%%
-%% Package: footnotehyper-sphinx
-%% Version: based on footnotehyper.sty 2017/03/07 v1.0
-%% as available at http://www.ctan.org/pkg/footnotehyper
-%% License: the one applying to Sphinx
-%%
-%% Refer to the PDF documentation at http://www.ctan.org/pkg/footnotehyper for
-%% the code comments.
-%%
-%% Differences:
-%% 1. a partial tabulary compatibility layer added (enough for Sphinx mark-up),
-%% 2. use of \spx@opt@BeforeFootnote from sphinx.sty,
-%% 3. use of \sphinxunactivateextrasandspace from sphinx.sty,
-%% 4. macro definition \sphinxfootnotemark,
-%% 5. macro definition \sphinxlongtablepatch
-%% 6. replaced an \undefined by \@undefined
-\DeclareOption*{\PackageWarning{footnotehyper-sphinx}{Option `\CurrentOption' is unknown}}%
-\ProcessOptions\relax
-\newbox\FNH@notes
-\newdimen\FNH@width
-\let\FNH@colwidth\columnwidth
-\newif\ifFNH@savingnotes
-\AtBeginDocument {%
- \let\FNH@latex@footnote \footnote
- \let\FNH@latex@footnotetext\footnotetext
- \let\FNH@H@@footnotetext \@footnotetext
- \newenvironment{savenotes}
- {\FNH@savenotes\ignorespaces}{\FNH@spewnotes\ignorespacesafterend}%
- \let\spewnotes \FNH@spewnotes
- \let\footnote \FNH@footnote
- \let\footnotetext \FNH@footnotetext
- \let\endfootnote \FNH@endfntext
- \let\endfootnotetext\FNH@endfntext
- \@ifpackageloaded{hyperref}
- {\ifHy@hyperfootnotes
- \let\FNH@H@@footnotetext\H@@footnotetext
- \else
- \let\FNH@hyper@fntext\FNH@nohyp@fntext
- \fi}%
- {\let\FNH@hyper@fntext\FNH@nohyp@fntext}%
-}%
-\def\FNH@hyper@fntext{\FNH@fntext\FNH@hyper@fntext@i}%
-\def\FNH@nohyp@fntext{\FNH@fntext\FNH@nohyp@fntext@i}%
-\def\FNH@fntext #1{%
- \ifx\ifmeasuring@\@undefined
- \expandafter\@secondoftwo\else\expandafter\@firstofone\fi
-% these two lines modified for Sphinx (tabulary compatibility):
- {\ifmeasuring@\expandafter\@gobbletwo\else\expandafter\@firstofone\fi}%
- {\ifx\equation$\expandafter\@gobbletwo\fi #1}%$
-}%
-\long\def\FNH@hyper@fntext@i#1{%
- \global\setbox\FNH@notes\vbox
- {\unvbox\FNH@notes
- \FNH@startnote
- \@makefntext
- {\rule\z@\footnotesep\ignorespaces
- \ifHy@nesting\expandafter\ltx@firstoftwo
- \else\expandafter\ltx@secondoftwo
- \fi
- {\expandafter\hyper@@anchor\expandafter{\Hy@footnote@currentHref}{#1}}%
- {\Hy@raisedlink
- {\expandafter\hyper@@anchor\expandafter{\Hy@footnote@currentHref}%
- {\relax}}%
- \let\@currentHref\Hy@footnote@currentHref
- \let\@currentlabelname\@empty
- #1}%
- \@finalstrut\strutbox
- }%
- \FNH@endnote
- }%
-}%
-\long\def\FNH@nohyp@fntext@i#1{%
- \global\setbox\FNH@notes\vbox
- {\unvbox\FNH@notes
- \FNH@startnote
- \@makefntext{\rule\z@\footnotesep\ignorespaces#1\@finalstrut\strutbox}%
- \FNH@endnote
- }%
-}%
-\def\FNH@startnote{%
- \hsize\FNH@colwidth
- \interlinepenalty\interfootnotelinepenalty
- \reset@font\footnotesize
- \floatingpenalty\@MM
- \@parboxrestore
- \protected@edef\@currentlabel{\csname p@\@mpfn\endcsname\@thefnmark}%
- \color@begingroup
-}%
-\def\FNH@endnote{\color@endgroup}%
-\def\FNH@savenotes{%
- \begingroup
- \ifFNH@savingnotes\else
- \FNH@savingnotestrue
- \let\@footnotetext \FNH@hyper@fntext
- \let\@mpfootnotetext \FNH@hyper@fntext
- \let\H@@mpfootnotetext\FNH@nohyp@fntext
- \FNH@width\columnwidth
- \let\FNH@colwidth\FNH@width
- \global\setbox\FNH@notes\box\voidb@x
- \let\FNH@thempfn\thempfn
- \let\FNH@mpfn\@mpfn
- \ifx\@minipagerestore\relax\let\@minipagerestore\@empty\fi
- \expandafter\def\expandafter\@minipagerestore\expandafter{%
- \@minipagerestore
- \let\thempfn\FNH@thempfn
- \let\@mpfn\FNH@mpfn
- }%
- \fi
-}%
-\def\FNH@spewnotes {%
- \endgroup
- \ifFNH@savingnotes\else
- \ifvoid\FNH@notes\else
- \begingroup
- \let\@makefntext\@empty
- \let\@finalstrut\@gobble
- \let\rule\@gobbletwo
- \FNH@H@@footnotetext{\unvbox\FNH@notes}%
- \endgroup
- \fi
- \fi
-}%
-\def\FNH@footnote@envname {footnote}%
-\def\FNH@footnotetext@envname{footnotetext}%
-\def\FNH@footnote{%
-% this line added for Sphinx:
- \spx@opt@BeforeFootnote
- \ifx\@currenvir\FNH@footnote@envname
- \expandafter\FNH@footnoteenv
- \else
- \expandafter\FNH@latex@footnote
- \fi
-}%
-\def\FNH@footnoteenv{%
-% this line added for Sphinx (footnotes in parsed literal blocks):
- \catcode13=5 \sphinxunactivateextrasandspace
- \@ifnextchar[%
- \FNH@footnoteenv@i %]
- {\stepcounter\@mpfn
- \protected@xdef\@thefnmark{\thempfn}%
- \@footnotemark
- \def\FNH@endfntext@fntext{\@footnotetext}%
- \FNH@startfntext}%
-}%
-\def\FNH@footnoteenv@i[#1]{%
- \begingroup
- \csname c@\@mpfn\endcsname #1\relax
- \unrestored@protected@xdef\@thefnmark{\thempfn}%
- \endgroup
- \@footnotemark
- \def\FNH@endfntext@fntext{\@footnotetext}%
- \FNH@startfntext
-}%
-\def\FNH@footnotetext{%
- \ifx\@currenvir\FNH@footnotetext@envname
- \expandafter\FNH@footnotetextenv
- \else
- \expandafter\FNH@latex@footnotetext
- \fi
-}%
-\def\FNH@footnotetextenv{%
- \@ifnextchar[%
- \FNH@footnotetextenv@i %]
- {\protected@xdef\@thefnmark{\thempfn}%
- \def\FNH@endfntext@fntext{\@footnotetext}%
- \FNH@startfntext}%
-}%
-\def\FNH@footnotetextenv@i[#1]{%
- \begingroup
- \csname c@\@mpfn\endcsname #1\relax
- \unrestored@protected@xdef\@thefnmark{\thempfn}%
- \endgroup
- \ifFNH@savingnotes
- \def\FNH@endfntext@fntext{\FNH@nohyp@fntext}%
- \else
- \def\FNH@endfntext@fntext{\FNH@H@@footnotetext}%
- \fi
- \FNH@startfntext
-}%
-\def\FNH@startfntext{%
- \setbox\z@\vbox\bgroup
- \FNH@startnote
- \FNH@prefntext
- \rule\z@\footnotesep\ignorespaces
-}%
-\def\FNH@endfntext {%
- \@finalstrut\strutbox
- \FNH@postfntext
- \FNH@endnote
- \egroup
- \begingroup
- \let\@makefntext\@empty\let\@finalstrut\@gobble\let\rule\@gobbletwo
- \FNH@endfntext@fntext {\unvbox\z@}%
- \endgroup
-}%
-\AtBeginDocument{%
- \let\FNH@@makefntext\@makefntext
- \ifx\@makefntextFB\@undefined
- \expandafter\@gobble\else\expandafter\@firstofone\fi
- {\ifFBFrenchFootnotes \let\FNH@@makefntext\@makefntextFB \else
- \let\FNH@@makefntext\@makefntextORI\fi}%
- \expandafter\FNH@check@a\FNH@@makefntext{1.2!3?4,}%
- \FNH@@@1.2!3?4,\FNH@@@\relax
-}%
-\long\def\FNH@check@a #11.2!3?4,#2\FNH@@@#3{%
- \ifx\relax#3\expandafter\@firstoftwo\else\expandafter\@secondoftwo\fi
- \FNH@bad@makefntext@alert
- {\def\FNH@prefntext{#1}\def\FNH@postfntext{#2}\FNH@check@b}%
-}%
-\def\FNH@check@b #1\relax{%
- \expandafter\expandafter\expandafter\FNH@check@c
- \expandafter\meaning\expandafter\FNH@prefntext
- \meaning\FNH@postfntext1.2!3?4,\FNH@check@c\relax
-}%
-\def\FNH@check@c #11.2!3?4,#2#3\relax{%
- \ifx\FNH@check@c#2\expandafter\@gobble\fi\FNH@bad@makefntext@alert
-}%
-% slight reformulation for Sphinx
-\def\FNH@bad@makefntext@alert{%
- \PackageWarningNoLine{footnotehyper-sphinx}%
- {Footnotes will be sub-optimal, sorry. This is due to the document class or^^J
- some package modifying macro \string\@makefntext.^^J
- You can try to report this incompatibility at^^J
- https://github.com/sphinx-doc/sphinx with this info:}%
- \typeout{\meaning\@makefntext}%
- \let\FNH@prefntext\@empty\let\FNH@postfntext\@empty
-}%
-% this macro from original footnote.sty is not used anymore by Sphinx
-% but for simplicity sake let's just keep it as is
-\def\makesavenoteenv{\@ifnextchar[\FNH@msne@ii\FNH@msne@i}%]
-\def\FNH@msne@i #1{%
- \expandafter\let\csname FNH$#1\expandafter\endcsname %$
- \csname #1\endcsname
- \expandafter\let\csname endFNH$#1\expandafter\endcsname %$
- \csname end#1\endcsname
- \FNH@msne@ii[#1]{FNH$#1}%$
-}%
-\def\FNH@msne@ii[#1]#2{%
- \expandafter\edef\csname#1\endcsname{%
- \noexpand\savenotes
- \expandafter\noexpand\csname#2\endcsname
- }%
- \expandafter\edef\csname end#1\endcsname{%
- \expandafter\noexpand\csname end#2\endcsname
- \noexpand\expandafter
- \noexpand\spewnotes
- \noexpand\if@endpe\noexpand\@endpetrue\noexpand\fi
- }%
-}%
-% end of footnotehyper 2017/02/16 v0.99
-% some extras for Sphinx :
-% \sphinxfootnotemark: usable in section titles and silently removed from TOCs.
-\def\sphinxfootnotemark [#1]%
- {\ifx\thepage\relax\else\protect\spx@opt@BeforeFootnote
- \protect\footnotemark[#1]\fi}%
-\AtBeginDocument{%
- % let hyperref less complain
- \pdfstringdefDisableCommands{\def\sphinxfootnotemark [#1]{}}%
- % to obtain hyperlinked footnotes in longtable environment we must replace
- % hyperref's patch of longtable's patch of \@footnotetext by our own
- \let\LT@p@ftntext\FNH@hyper@fntext
- % this *requires* longtable to be used always wrapped in savenotes environment
-}%
-\endinput
-%%
-%% End of file `footnotehyper-sphinx.sty'.
+++ /dev/null
-$latex = 'platex ' . $ENV{'LATEXOPTS'} . ' -kanji=utf8 %O %S';
-$dvipdf = 'dvipdfmx %O -o %D %S';
-$makeindex = 'rm -f %D; mendex -U -f -d %B.dic -s python.ist %S || echo "mendex exited with error code $? (ignoring)" && : >> %D';
-add_cus_dep( "glo", "gls", 0, "makeglo" );
-sub makeglo {
- return system( "mendex -J -f -s gglo.ist -o '$_[0].gls' '$_[0].glo'" );
-}
+++ /dev/null
-$latex = 'latex ' . $ENV{'LATEXOPTS'} . ' %O %S';
-$pdflatex = 'pdflatex ' . $ENV{'LATEXOPTS'} . ' %O %S';
-$lualatex = 'lualatex ' . $ENV{'LATEXOPTS'} . ' %O %S';
-$xelatex = 'xelatex --no-pdf ' . $ENV{'LATEXOPTS'} . ' %O %S';
-$makeindex = 'makeindex -s python.ist %O -o %D %S';
-add_cus_dep( "glo", "gls", 0, "makeglo" );
-sub makeglo {
- return system( "makeindex -s gglo.ist -o '$_[0].gls' '$_[0].glo'" );
-}
\ No newline at end of file
headings_flag 1
heading_prefix " \\bigletter "
-preamble "\\begin{sphinxtheindex}
+preamble "\\begin{theindex}
\\def\\bigletter#1{{\\Large\\sffamily#1}\\nopagebreak\\vspace{1mm}}
"
-postamble "\n\n\\end{sphinxtheindex}\n"
-
symhead_positive "{Symbols}"
numhead_positive "{Numbers}"
+++ /dev/null
-\relax
-\providecommand\hyper@newdestlabel[2]{}
-\providecommand\HyperFirstAtBeginDocument{\AtBeginDocument}
-\HyperFirstAtBeginDocument{\ifx\hyper@anchor\@undefined
-\global\let\oldcontentsline\contentsline
-\gdef\contentsline#1#2#3#4{\oldcontentsline{#1}{#2}{#3}}
-\global\let\oldnewlabel\newlabel
-\gdef\newlabel#1#2{\newlabelxx{#1}#2}
-\gdef\newlabelxx#1#2#3#4#5#6{\oldnewlabel{#1}{{#2}{#3}}}
-\AtEndDocument{\ifx\hyper@anchor\@undefined
-\let\contentsline\oldcontentsline
-\let\newlabel\oldnewlabel
-\fi}
-\fi}
-\global\let\hyper@last\relax
-\gdef\HyperFirstAtBeginDocument#1{#1}
-\providecommand\HyField@AuxAddToFields[1]{}
-\providecommand\HyField@AuxAddToCoFields[2]{}
-\babel@aux{english}{}
-\newlabel{index::doc}{{}{1}{}{section*.2}{}}
-\@writefile{toc}{\contentsline {chapter}{\numberline {1}Quick start}{3}{chapter.1}}
-\@writefile{lof}{\addvspace {10\p@ }}
-\@writefile{lot}{\addvspace {10\p@ }}
-\newlabel{index:quick-start}{{1}{3}{Quick start}{chapter.1}{}}
-\newlabel{index:salome-tools}{{1}{3}{Quick start}{chapter.1}{}}
-\@writefile{toc}{\contentsline {section}{\numberline {1.1}Installation}{3}{section.1.1}}
-\newlabel{installation_of_sat:installation}{{1.1}{3}{Installation}{section.1.1}{}}
-\newlabel{installation_of_sat::doc}{{1.1}{3}{Installation}{section.1.1}{}}
-\@writefile{toc}{\contentsline {section}{\numberline {1.2}Configuration}{3}{section.1.2}}
-\newlabel{configuration:configuration}{{1.2}{3}{Configuration}{section.1.2}{}}
-\newlabel{configuration::doc}{{1.2}{3}{Configuration}{section.1.2}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {1.2.1}Syntax}{3}{subsection.1.2.1}}
-\newlabel{configuration:syntax}{{1.2.1}{3}{Syntax}{subsection.1.2.1}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {1.2.2}Description}{3}{subsection.1.2.2}}
-\newlabel{configuration:description}{{1.2.2}{3}{Description}{subsection.1.2.2}{}}
-\@writefile{toc}{\contentsline {subsubsection}{VARS section}{3}{subsubsection*.3}}
-\newlabel{configuration:vars-section}{{1.2.2}{3}{VARS section}{subsubsection*.3}{}}
-\newlabel{configuration:id1}{{1.2.2}{3}{VARS section}{subsubsection*.3}{}}
-\@writefile{toc}{\contentsline {subsubsection}{PRODUCTS section}{4}{subsubsection*.4}}
-\newlabel{configuration:products-section}{{1.2.2}{4}{PRODUCTS section}{subsubsection*.4}{}}
-\@writefile{toc}{\contentsline {subsubsection}{APPLICATION section}{4}{subsubsection*.5}}
-\newlabel{configuration:application-section}{{1.2.2}{4}{APPLICATION section}{subsubsection*.5}{}}
-\@writefile{toc}{\contentsline {subsubsection}{USER section}{4}{subsubsection*.6}}
-\newlabel{configuration:user-section}{{1.2.2}{4}{USER section}{subsubsection*.6}{}}
-\newlabel{configuration:id2}{{1.2.2}{4}{USER section}{subsubsection*.6}{}}
-\@writefile{toc}{\contentsline {section}{\numberline {1.3}Usage of SAlomeTools}{5}{section.1.3}}
-\newlabel{usage_of_sat:svn}{{1.3}{5}{Usage of SAlomeTools}{section.1.3}{}}
-\newlabel{usage_of_sat:usage-of-salometools}{{1.3}{5}{Usage of SAlomeTools}{section.1.3}{}}
-\newlabel{usage_of_sat::doc}{{1.3}{5}{Usage of SAlomeTools}{section.1.3}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {1.3.1}Usage}{5}{subsection.1.3.1}}
-\newlabel{usage_of_sat:usage}{{1.3.1}{5}{Usage}{subsection.1.3.1}{}}
-\@writefile{toc}{\contentsline {subsubsection}{Options of sat}{5}{subsubsection*.7}}
-\newlabel{usage_of_sat:options-of-sat}{{1.3.1}{5}{Options of sat}{subsubsection*.7}{}}
-\@writefile{toc}{\contentsline {paragraph}{\sphinxstyleemphasis {\textendash {}help or -h}}{5}{paragraph*.8}}
-\newlabel{usage_of_sat:help-or-h}{{1.3.1}{5}{\sphinxstyleemphasis {\textendash {}help or -h}}{paragraph*.8}{}}
-\@writefile{toc}{\contentsline {paragraph}{\sphinxstyleemphasis {\textendash {}debug or -g}}{5}{paragraph*.9}}
-\newlabel{usage_of_sat:debug-or-g}{{1.3.1}{5}{\sphinxstyleemphasis {\textendash {}debug or -g}}{paragraph*.9}{}}
-\@writefile{toc}{\contentsline {paragraph}{\sphinxstyleemphasis {\textendash {}verbose or -v}}{5}{paragraph*.10}}
-\newlabel{usage_of_sat:verbose-or-v}{{1.3.1}{5}{\sphinxstyleemphasis {\textendash {}verbose or -v}}{paragraph*.10}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {1.3.2}Build a SALOME product}{5}{subsection.1.3.2}}
-\newlabel{usage_of_sat:build-a-salome-product}{{1.3.2}{5}{Build a SALOME product}{subsection.1.3.2}{}}
-\@writefile{toc}{\contentsline {subsubsection}{Get the list of available products}{5}{subsubsection*.11}}
-\newlabel{usage_of_sat:get-the-list-of-available-products}{{1.3.2}{5}{Get the list of available products}{subsubsection*.11}{}}
-\@writefile{toc}{\contentsline {subsubsection}{Prepare sources of a product}{5}{subsubsection*.12}}
-\newlabel{usage_of_sat:prepare-sources-of-a-product}{{1.3.2}{5}{Prepare sources of a product}{subsubsection*.12}{}}
-\@writefile{toc}{\contentsline {subsubsection}{Compile SALOME}{6}{subsubsection*.13}}
-\newlabel{usage_of_sat:compile-salome}{{1.3.2}{6}{Compile SALOME}{subsubsection*.13}{}}
-\@writefile{toc}{\contentsline {chapter}{\numberline {2}List of Commands}{7}{chapter.2}}
-\@writefile{lof}{\addvspace {10\p@ }}
-\@writefile{lot}{\addvspace {10\p@ }}
-\newlabel{index:list-of-commands}{{2}{7}{List of Commands}{chapter.2}{}}
-\@writefile{toc}{\contentsline {section}{\numberline {2.1}Command config}{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 {subsection}{\numberline {2.1.1}Description}{8}{subsection.2.1.1}}
-\newlabel{commands/config: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}{}}
-\@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}{}}
-\@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}{}}
-\@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}{}}
-\@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}{}}
-\@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}{}}
-\@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}{}}
-\@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}{}}
-\@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}{}}
-\@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}{}}
-\@writefile{toc}{\contentsline {chapter}{\numberline {3}Developer documentation}{25}{chapter.3}}
-\@writefile{lof}{\addvspace {10\p@ }}
-\@writefile{lot}{\addvspace {10\p@ }}
-\newlabel{index:developer-documentation}{{3}{25}{Developer documentation}{chapter.3}{}}
-\@writefile{toc}{\contentsline {section}{\numberline {3.1}Add a user custom command}{26}{section.3.1}}
-\newlabel{write_command:svn}{{3.1}{26}{Add a user custom command}{section.3.1}{}}
-\newlabel{write_command:add-a-user-custom-command}{{3.1}{26}{Add a user custom command}{section.3.1}{}}
-\newlabel{write_command::doc}{{3.1}{26}{Add a user custom command}{section.3.1}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {3.1.1}Introduction}{26}{subsection.3.1.1}}
-\newlabel{write_command:introduction}{{3.1.1}{26}{Introduction}{subsection.3.1.1}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {3.1.2}Basic requirements}{26}{subsection.3.1.2}}
-\newlabel{write_command:basic-requirements}{{3.1.2}{26}{Basic requirements}{subsection.3.1.2}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {3.1.3}HowTo access salomeTools config and other commands}{27}{subsection.3.1.3}}
-\newlabel{write_command:howto-access-salometools-config-and-other-commands}{{3.1.3}{27}{HowTo access salomeTools config and other commands}{subsection.3.1.3}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {3.1.4}HowTo logger}{27}{subsection.3.1.4}}
-\newlabel{write_command:howto-logger}{{3.1.4}{27}{HowTo logger}{subsection.3.1.4}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {3.1.5}HELLO example}{27}{subsection.3.1.5}}
-\newlabel{write_command:hello-example}{{3.1.5}{27}{HELLO example}{subsection.3.1.5}{}}
-\@writefile{toc}{\contentsline {chapter}{\numberline {4}Code documentation}{29}{chapter.4}}
-\@writefile{lof}{\addvspace {10\p@ }}
-\@writefile{lot}{\addvspace {10\p@ }}
-\newlabel{index:code-documentation}{{4}{29}{Code documentation}{chapter.4}{}}
-\@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 {chapter}{\numberline {5}Release Notes}{69}{chapter.5}}
-\@writefile{lof}{\addvspace {10\p@ }}
-\@writefile{lot}{\addvspace {10\p@ }}
-\newlabel{index:release-notes}{{5}{69}{Release Notes}{chapter.5}{}}
-\@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}}
+++ /dev/null
-# Fdb version 3
-["makeindex salomeTools.idx"] 1524653369 "salomeTools.idx" "salomeTools.ind" "salomeTools" 1524653371
- "salomeTools.idx" 1524653371 37218 47758ed2f5c8639f0fe54efc5cfe25d0 ""
- (generated)
- "salomeTools.ind"
- "salomeTools.ilg"
-["pdflatex"] 1524653370 "salomeTools.tex" "salomeTools.pdf" "salomeTools" 1524653371
- "/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/fonts/tfm/adobe/courier/pcrb8r.tfm" 1480098688 1292 3059476c50a24578715759f22652f3d0 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrb8t.tfm" 1480098688 1384 87406e4336af44af883a035f17f319d9 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrr8c.tfm" 1480098688 1268 8bd405dc5751cfed76cb6fb2db78cb50 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrr8r.tfm" 1480098688 1292 bd42be2f344128bff6d35d98474adfe3 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrr8t.tfm" 1480098688 1384 4632f5e54900a7dadbb83f555bc61e56 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrro8c.tfm" 1480098688 1344 dab2eee300fafcab19064bcc62d66daa ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrro8r.tfm" 1480098688 1544 4fb84cf2931ec523c2c6a08d939088ba ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrro8t.tfm" 1480098688 1596 04a657f277f0401ba37d66e716627ac4 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvb8r.tfm" 1480098688 4484 b828043cbd581d289d955903c1339981 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvb8t.tfm" 1480098688 6628 34c39492c0adc454c1c199922bba8363 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvbo8r.tfm" 1480098688 4736 423eba67d4e9420ec9df4a8def143b08 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvbo8t.tfm" 1480098688 6880 fe6c7967f27585f6fa9876f3af14edd2 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvr8r.tfm" 1480098688 4712 9ef4d7d106579d4b136e1529e1a4533c ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvr8t.tfm" 1480098688 7040 b2bd27e2bfe6f6948cbc3239cae7444f ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmb8r.tfm" 1480098689 4524 6bce29db5bc272ba5f332261583fee9c ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmb8t.tfm" 1480098689 6880 f19b8995b61c334d78fc734065f6b4d4 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmr8c.tfm" 1480098689 1352 fa28a7e6d323c65ce7d13d5342ff6be2 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmr8r.tfm" 1480098689 4408 25b74d011a4c66b7f212c0cc3c90061b ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmr8t.tfm" 1480098689 6672 e3ab9e37e925f3045c9005e6d1473d56 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmri8r.tfm" 1480098689 4640 532ca3305aad10cc01d769f3f91f1029 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmri8t.tfm" 1480098689 6944 94c55ad86e6ea2826f78ba2240d50df9 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/jknappen/ec/ecrm1000.tfm" 1480098696 3584 adb004a0c8e7c46ee66cad73671f37b4 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/cmextra/cmex7.tfm" 1480098698 1004 54797486969f23fa377b128694d548df ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/cmextra/cmex8.tfm" 1480098698 988 bdf658c3bfc2d96d3c8b02cfc1c94c20 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/symbols/msam10.tfm" 1480098698 916 f87d7c45f9c908e672703b83b72241a3 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/symbols/msam5.tfm" 1480098698 924 9904cf1d39e9767e7a3622f2a125a565 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/symbols/msam7.tfm" 1480098698 928 2dc8d444221b7a635bb58038579b861a ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/symbols/msbm10.tfm" 1480098698 908 2921f8a10601f252058503cc6570e581 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/symbols/msbm5.tfm" 1480098698 940 75ac932a52f80982a9f8ea75d03a34cf ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/symbols/msbm7.tfm" 1480098698 940 228d6584342e91276bf566bcf9716b83 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmex10.tfm" 1480098701 992 662f679a0b3d2d53c1b94050fdaa3f50 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmmi12.tfm" 1480098701 1524 4414a8315f39513458b80dfc63bff03a ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmmi6.tfm" 1480098701 1512 f21f83efb36853c0b70002322c1ab3ad ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmmi8.tfm" 1480098701 1520 eccf95517727cb11801f4f1aee3a21b4 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmr12.tfm" 1480098701 1288 655e228510b4c2a1abe905c368440826 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmr17.tfm" 1480098701 1292 296a67155bdbfc32aa9c636f21e91433 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmr6.tfm" 1480098701 1300 b62933e007d01cfd073f79b963c01526 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmr8.tfm" 1480098701 1292 21c1c5bfeaebccffdb478fd231a0997d ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmsy10.tfm" 1480098701 1124 6c73e740cf17375f03eec0ee63599741 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmsy6.tfm" 1480098701 1116 933a60c408fc0a863a92debe84b2d294 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmsy8.tfm" 1480098701 1120 8b7d695260f3cff42e636090a8002094 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/public/amsfonts/cm/cmmi5.pfb" 1480098733 37912 77d683123f92148345f3fc36a38d9ab1 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/public/amsfonts/cm/cmsy5.pfb" 1480098733 32915 7bf7720c61a5b3a7ff25b0964421c9b6 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/urw/courier/ucrb8a.pfb" 1480098746 50493 4ed1f7e9eba8f1f3e1ec25195460190d ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/urw/courier/ucrr8a.pfb" 1480098746 45758 19968a0990191524e34e1994d4a31cb6 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/urw/courier/ucrro8a.pfb" 1480098746 44404 ea3d9c0311883914133975dd62a9185c ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/urw/helvetic/uhvb8a.pfb" 1480098746 35941 f27169cc74234d5bd5e4cca5abafaabb ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/urw/helvetic/uhvbo8a.pfb" 1480098746 39013 b244066151b1e3e718f9b8e88a5ff23b ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/urw/helvetic/uhvr8a.pfb" 1480098746 44648 23115b2a545ebfe2c526c3ca99db8b95 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/urw/times/utmb8a.pfb" 1480098746 44729 811d6c62865936705a31c797a1d5dada ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/urw/times/utmr8a.pfb" 1480098746 46026 6dab18b61c907687b520c72847215a68 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/urw/times/utmri8a.pfb" 1480098746 45458 a3faba884469519614ca56ba5f6b1de1 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/courier/pcrb8c.vf" 1480098757 3560 cb6af2c6d0b5f763f3aae03f60590c57 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/courier/pcrb8t.vf" 1480098757 2184 5d20c8b00cd914e50251116c274e2d0b ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/courier/pcrr8c.vf" 1480098757 3552 6a7911d0b338a7c32cbfc3a9e985ccca ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/courier/pcrr8t.vf" 1480098757 2184 8475af1b9cfa983db5f46f5ed4b8f9f7 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/courier/pcrro8c.vf" 1480098757 3560 a297982f0907d62e9886d9e2666bf30b ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/courier/pcrro8t.vf" 1480098757 2280 d7cd083c724c9449e1d12731253966f7 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/helvetic/phvb8t.vf" 1480098757 2340 0efed6a948c3c37d870e4e7ddb85c7c3 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/helvetic/phvbo8t.vf" 1480098757 2344 88834f8322177295b0266ecc4b0754c3 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/helvetic/phvr8t.vf" 1480098757 2344 44ff28c9ef2fc97180cd884f900fee71 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/times/ptmb8t.vf" 1480098758 2340 df9c920cc5688ebbf16a93f45ce7bdd3 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/times/ptmr8c.vf" 1480098758 3556 8a9a6dcbcd146ef985683f677f4758a6 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/times/ptmr8t.vf" 1480098758 2348 91706c542228501c410c266421fbe30c ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/times/ptmri8t.vf" 1480098758 2328 6cd7df782b09b29cfc4d93e55b6b9a59 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/context/base/mkii/supp-pdf.mkii" 1480098806 71627 94eb9990bed73c364d7f53f960cc8c5b ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/babel-english/english.ldf" 1496785618 7008 9ff5fdcc865b01beca2b0fe4a46231d4 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/babel/babel.def" 1518644053 67244 2dce3d67c354c8d92f638d0f8682fb73 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/babel/babel.sty" 1518644053 15861 065fe343082d0cd2428cf984d6b2ef66 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/babel/switch.def" 1518644053 12523 d80bc74bf5e02fe4304443a6de8d01be ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/babel/txtbabel.def" 1518644053 7434 1b3955075683beb1c883a0fcf92ed2d5 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/ifxetex/ifxetex.sty" 1480098815 1458 43ab4710dc82f3edeabecd0d099626b2 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/etexcmds.sty" 1480098815 7612 729a8cc22a1ee0029997c7f74717ae05 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/gettitlestring.sty" 1480098815 8237 3b62ef1f7e2c23a328c814b3893bc11f ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/hobsub-generic.sty" 1517006633 185082 6c11d4e30ed78e2a12957b7e77030856 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/hobsub-hyperref.sty" 1480098815 70864 bcd5b216757bd619ae692a151d90085d ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/ifluatex.sty" 1480098815 7324 2310d1247db0114eb4726807c8837a0e ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/ifpdf.sty" 1490564930 1251 d170e11a3246c3392bc7f59595af42cb ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/ifvtex.sty" 1480098815 6797 90b7f83b0ad46826bc16058b1e3d48df ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/infwarerr.sty" 1480098815 8253 473e0e41f9adadb1977e8631b8f72ea6 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/kvsetkeys.sty" 1480098815 14040 ac8866aac45982ac84021584b0abb252 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/ltxcmds.sty" 1480098815 18425 5b3c0c59d76fac78978b5558e83c1f36 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsfonts/amsfonts.sty" 1480098820 5949 3f3fd50a8cc94c3d4cbf4fc66cd3df1c ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsfonts/amssymb.sty" 1480098820 13829 94730e64147574077f8ecfea9bb69af4 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsfonts/umsa.fd" 1480098820 961 6518c6525a34feb5e8250ffa91731cff ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsfonts/umsb.fd" 1480098820 961 d02606146ba5601b5645f987c92e6193 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsmath/amsbsy.sty" 1480098820 2210 5c54ab129b848a5071554186d0168766 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsmath/amsgen.sty" 1480098820 4160 c115536cf8d4ff25aa8c1c9bc4ecb79a ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsmath/amsmath.sty" 1504905757 84352 897a476d96a0681047a5b0f91178a3d2 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsmath/amsopn.sty" 1480098820 4115 318a66090112f3aa3f415aeb6fe8540f ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsmath/amstext.sty" 1480098820 2431 fe3078ec12fc30287f568596f8e0b948 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/alltt.sty" 1480098821 3140 977eaf314c97ac67b8675753fb15f67f ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/fontenc.sty" 1492297155 4571 13977df0eda144b93597fc709035ad1f ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/inputenc.sty" 1480098821 4732 d63eda807ac82cca2ca8488efd31a966 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/makeidx.sty" 1480098821 1940 c559b92ca91f1b2a0e60d836d4973f41 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/omsenc.dfu" 1487721667 2004 ac51aeac484f08c01026120d62677eca ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/ot1enc.dfu" 1487721667 3181 1cb3e9ad01f4a01127b2ffd821bfeec7 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/report.cls" 1480098821 22880 e7be6f7dd8c05d5108bf3a7d8cabe59a ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/size10.clo" 1480098821 8292 e897c12e1e886ce77fe26afc5d470886 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/t1enc.def" 1492297155 10006 a90ba4035cf778f32f424e297d92e235 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/t1enc.dfu" 1487721667 11255 9d97362866549d3d3c994b5f28d1b9b5 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/textcomp.sty" 1492297155 16154 f2c73e20ca771d534a8516c62c6b0eae ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/ts1cmr.fd" 1480098821 2217 d274654bda1292013bdf48d5f720a495 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/ts1enc.def" 1480098821 7767 aa88823823f5e767d79ea1166ab1ae74 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/ts1enc.dfu" 1487721667 4919 76510afd60e8282294f944c2f9f5103b ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/utf8.def" 1487721667 7784 325a2a09984cb5c4ff230f9867145ad3 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/capt-of/capt-of.sty" 1480098823 1311 063f8536a047a2d9cb1803321f793f37 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/carlisle/remreset.sty" 1480098823 1096 6a75275ca00e32428c6f059d2f618ea7 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/cmap/cmap.sty" 1480098825 2883 427a7f7cb58418a0394dbd85c80668f6 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/cmap/ot1.cmap" 1480098825 1207 4e0d96772f0d338847cbfb4eca683c81 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/cmap/t1.cmap" 1480098825 1938 beaa4a8467aa0074076e0e19f2992e29 ""
- "/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/graphics-cfg/graphics.cfg" 1480098830 1224 978390e9c2234eab29404bc21b268d1e ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics-def/pdftex.def" 1515537368 17334 520b9b85ad8a2a48eda3f643e27a5179 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics/graphics.sty" 1498427532 15275 7d676729b1bedd3e7f3c6717affb366c ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics/graphicx.sty" 1498427532 9066 649f2ccf62888e3d8c3e57256b70b8e1 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics/keyval.sty" 1480098830 2594 d18d5e19aa8239cf867fa670c556d2e9 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics/trig.sty" 1480098830 3980 0a268fbfda01e381fa95821ab13b6aee ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/hyperref/hpdftex.def" 1518041854 51699 9069fc983fff0db91d59a15af144ad62 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/hyperref/hyperref.sty" 1518041854 234088 2c849389d62d41c593d9f5176c4116ab ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/hyperref/nameref.sty" 1480098831 12949 81e4e808884a8f0e276b69410e234656 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/hyperref/pd1enc.def" 1518041854 14098 4e70bf396c7c265bd8b0e5cab3fd3d4d ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/hyperref/puenc.def" 1518041854 122411 10b605a58a28bbe5d61db37da4a85beb ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/latexconfig/epstopdf-sys.cfg" 1480098833 678 4792914a8f45be57bb98413425e4c7af ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/latexconfig/hyperref.cfg" 1480098833 235 6031e5765137be07eed51a510b2b8fb7 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/mmap/oml.cmap" 1480098835 1866 c1c12138091b4a8edd4a24a940e6f792 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/mmap/oms.cmap" 1480098835 2370 3b1f71b14b974f07cef532db09ae9ee0 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/mmap/omx.cmap" 1480098835 3001 252c8ca42b06a22cb1a11c0e47790c6e ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/needspace/needspace.sty" 1480098835 852 0e34dbb72efc69fa07602405ad95585e ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/auxhook.sty" 1480098836 3834 4363110eb0ef1eb2b71c8fcbcdb6c357 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/epstopdf-base.sty" 1480098836 12095 5337833c991d80788a43d3ce26bd1c46 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/grfext.sty" 1480098836 7075 2fe3d848bba95f139de11ded085e74aa ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/hypcap.sty" 1480098836 3720 63669daeb0b67d5fbec899824e2f1491 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/kvoptions.sty" 1480098836 22417 1d9df1eb66848aa31b18a593099cf45c ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/rerunfilecheck.sty" 1480098836 9581 023642318cef9f4677efe364de1e2a27 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/parskip/parskip.sty" 1480098836 2763 02a40cc5a32805c41d919cfbdba7e99a ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/t1pcr.fd" 1480098837 798 d5895e9edc628f2be019beb2c0ec66df ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/t1phv.fd" 1480098837 1488 9a55ac1cde6b4798a7f56844bb75a553 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/t1ptm.fd" 1480098837 774 61d7da1e9f9e74989b196d147e623736 ""
- "/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-dist/tex/latex/upquote/upquote.sty" 1480098842 1048 517e01cde97c1c0baf72e69d43aa5a2e ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/url/url.sty" 1480098842 12796 8edb7d69a20b857904dd0ea757c14ec9 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/varwidth/varwidth.sty" 1480098842 10894 d359a13923460b2a73d4312d613554c8 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/wrapfig/wrapfig.sty" 1480098843 26220 3701aebf80ccdef248c0c20dd062fea9 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/xcolor/xcolor.sty" 1480098843 55589 34128738f682d033422ca125f82e5d62 ""
- "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/web2c/texmf.cnf" 1518824182 33095 db9a077a3f94a5d0b580d566a7906714 ""
- "/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 ""
- (generated)
- "salomeTools.aux"
- "salomeTools.out"
- "salomeTools.idx"
- "salomeTools.log"
- "salomeTools.toc"
- "salomeTools.pdf"
+++ /dev/null
-PWD /volatile/wambeke/SAT5/SAT5_S840_MATIX24/SAT/doc/build/latex
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf.cnf
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/web2c/texmf.cnf
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-var/web2c/pdftex/pdflatex.fmt
-INPUT salomeTools.tex
-OUTPUT salomeTools.log
-INPUT sphinxmanual.cls
-INPUT sphinxmanual.cls
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/report.cls
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/report.cls
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/size10.clo
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/size10.clo
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/inputenc.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/inputenc.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/utf8.def
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/utf8.def
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/t1enc.dfu
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/t1enc.dfu
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/ot1enc.dfu
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/ot1enc.dfu
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/omsenc.dfu
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/omsenc.dfu
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/cmap/cmap.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/cmap/cmap.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/fontenc.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/fontenc.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/t1enc.def
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/t1enc.def
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/map/fontname/texfonts.map
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/jknappen/ec/ecrm1000.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/cmap/t1.cmap
-OUTPUT salomeTools.pdf
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/cmap/t1.cmap
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsmath/amsmath.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsmath/amsmath.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsmath/amstext.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsmath/amstext.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsmath/amsgen.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsmath/amsgen.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsmath/amsbsy.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsmath/amsbsy.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsmath/amsopn.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsmath/amsopn.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsfonts/amssymb.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsfonts/amssymb.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsfonts/amsfonts.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsfonts/amsfonts.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/babel/babel.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/babel/babel.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/babel/switch.def
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/babel-english/english.ldf
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/babel-english/english.ldf
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/babel-english/english.ldf
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/babel/babel.def
-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 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/generic/oberdiek/ltxcmds.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics/graphicx.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics/graphicx.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics/keyval.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics/keyval.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics/graphics.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics/graphics.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics/trig.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics/trig.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics-cfg/graphics.cfg
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics-cfg/graphics.cfg
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics-def/pdftex.def
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics-def/pdftex.def
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/fancyhdr/fancyhdr.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/fancyhdr/fancyhdr.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/textcomp.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/textcomp.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/ts1enc.def
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/ts1enc.def
-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/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 /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
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/tools/longtable.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/varwidth/varwidth.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/varwidth/varwidth.sty
-INPUT sphinxmulticell.sty
-INPUT sphinxmulticell.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/makeidx.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/makeidx.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/framed/framed.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/framed/framed.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/xcolor/xcolor.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/xcolor/xcolor.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/xcolor/xcolor.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics-cfg/color.cfg
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics-cfg/color.cfg
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/fancyvrb/fancyvrb.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/fancyvrb/fancyvrb.sty
-INPUT footnotehyper-sphinx.sty
-INPUT footnotehyper-sphinx.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/float/float.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/float/float.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/wrapfig/wrapfig.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/wrapfig/wrapfig.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/parskip/parskip.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/parskip/parskip.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/alltt.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/alltt.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/upquote/upquote.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/upquote/upquote.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/capt-of/capt-of.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/capt-of/capt-of.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/needspace/needspace.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/needspace/needspace.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/carlisle/remreset.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/carlisle/remreset.sty
-INPUT sphinxhighlight.sty
-INPUT sphinxhighlight.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/kvoptions.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/kvoptions.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/kvsetkeys.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/kvsetkeys.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/infwarerr.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/infwarerr.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/etexcmds.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/etexcmds.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/ifluatex.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/ifluatex.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/geometry/geometry.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/geometry/geometry.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/ifpdf.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/ifpdf.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/ifvtex.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/ifvtex.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/ifxetex/ifxetex.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/ifxetex/ifxetex.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/hyperref/hyperref.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/hyperref/hyperref.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/hobsub-hyperref.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/hobsub-hyperref.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/hobsub-hyperref.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/hobsub-generic.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/hobsub-generic.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/auxhook.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/auxhook.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/hyperref/pd1enc.def
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/hyperref/pd1enc.def
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/latexconfig/hyperref.cfg
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/latexconfig/hyperref.cfg
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/hyperref/puenc.def
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/hyperref/puenc.def
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/url/url.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/url/url.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/hyperref/hpdftex.def
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/hyperref/hpdftex.def
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/rerunfilecheck.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/rerunfilecheck.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/hypcap.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/hypcap.sty
-OUTPUT salomeTools.idx
-INPUT salomeTools.aux
-INPUT salomeTools.aux
-OUTPUT salomeTools.aux
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/ts1cmr.fd
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/ts1cmr.fd
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/t1ptm.fd
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/t1ptm.fd
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmr8t.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/context/base/mkii/supp-pdf.mkii
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/context/base/mkii/supp-pdf.mkii
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/epstopdf-base.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/epstopdf-base.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/grfext.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/grfext.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/latexconfig/epstopdf-sys.cfg
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/latexconfig/epstopdf-sys.cfg
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/hyperref/nameref.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/hyperref/nameref.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/gettitlestring.sty
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/gettitlestring.sty
-INPUT salomeTools.out
-INPUT salomeTools.out
-INPUT salomeTools.out
-INPUT salomeTools.out
-INPUT ./salomeTools.out
-INPUT ./salomeTools.out
-OUTPUT salomeTools.out
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/t1phv.fd
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/t1phv.fd
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvr8t.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvb8t.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvb8t.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvbo8t.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvbo8t.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvb8t.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmr17.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/cmap/ot1.cmap
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/cmap/ot1.cmap
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmr12.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmmi12.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/mmap/oml.cmap
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/mmap/oml.cmap
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmmi12.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmsy10.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/mmap/oms.cmap
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/mmap/oms.cmap
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmsy10.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmex10.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/mmap/omx.cmap
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/mmap/omx.cmap
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmex10.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsfonts/umsa.fd
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsfonts/umsa.fd
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/symbols/msam10.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/symbols/msam10.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/symbols/msam10.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsfonts/umsb.fd
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsfonts/umsb.fd
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/symbols/msbm10.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/symbols/msbm10.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/symbols/msbm10.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvb8t.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/helvetic/phvb8t.vf
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvb8r.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-var/fonts/map/pdftex/updmap/pdftex.map
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/helvetic/phvbo8t.vf
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvbo8r.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/helvetic/phvb8t.vf
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvb8r.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/helvetic/phvb8t.vf
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvb8r.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmr8t.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvr8t.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvb8t.tfm
-INPUT salomeTools.toc
-INPUT salomeTools.toc
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmb8t.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/cmextra/cmex7.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/cmextra/cmex7.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/symbols/msam7.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/symbols/msam5.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/symbols/msbm7.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/symbols/msbm5.tfm
-OUTPUT salomeTools.toc
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/helvetic/phvb8t.vf
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvb8r.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/times/ptmb8t.vf
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmb8r.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/times/ptmr8t.vf
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmr8r.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/helvetic/phvb8t.vf
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvb8r.tfm
-INPUT sat_about.png
-INPUT ./sat_about.png
-INPUT ./sat_about.png
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/t1pcr.fd
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/t1pcr.fd
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrr8t.tfm
-INPUT sat_about.png
-INPUT ./sat_about.png
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmr8t.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmr8t.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmr8.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmr6.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmmi8.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmmi6.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmsy8.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmsy6.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/cmextra/cmex8.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/cmextra/cmex7.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/symbols/msam10.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/symbols/msam7.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/symbols/msbm10.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/symbols/msbm7.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmr8t.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/times/ptmr8t.vf
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmr8r.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/times/ptmr8t.vf
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmr8r.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/times/ptmr8t.vf
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmr8r.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmr8t.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrr8t.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrr8t.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrro8t.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmri8t.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmr8t.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvr8t.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/ts1ptm.fd
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/ts1ptm.fd
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmr8c.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/courier/pcrr8t.vf
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrr8r.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/courier/pcrro8t.vf
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrro8r.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/times/ptmri8t.vf
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmri8r.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/times/ptmr8c.vf
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/courier/pcrr8t.vf
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrr8r.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/ts1pcr.fd
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/ts1pcr.fd
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrro8c.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/helvetic/phvbo8t.vf
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvbo8r.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/courier/pcrro8c.vf
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrr8c.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrb8t.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/courier/pcrr8c.vf
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/courier/pcrb8t.vf
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrb8r.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrb8t.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrro8t.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/courier/pcrb8t.vf
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrb8r.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/courier/pcrro8t.vf
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrro8r.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrb8c.tfm
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/courier/pcrb8c.vf
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/helvetic/phvr8t.vf
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvr8r.tfm
-INPUT salomeTools.ind
-INPUT salomeTools.ind
-INPUT salomeTools.aux
-INPUT ./salomeTools.out
-INPUT ./salomeTools.out
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/enc/dvips/base/8r.enc
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/public/amsfonts/cm/cmmi5.pfb
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/public/amsfonts/cm/cmsy5.pfb
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/urw/courier/ucrb8a.pfb
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/urw/courier/ucrr8a.pfb
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/urw/courier/ucrro8a.pfb
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/urw/helvetic/uhvb8a.pfb
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/urw/helvetic/uhvbo8a.pfb
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/urw/helvetic/uhvr8a.pfb
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/urw/times/utmb8a.pfb
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/urw/times/utmr8a.pfb
-INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/urw/times/utmri8a.pfb
+++ /dev/null
-\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}
+++ /dev/null
-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).
-Output written in salomeTools.ind.
-Transcript written in salomeTools.ilg.
+++ /dev/null
-\begin{sphinxtheindex}
-\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}
-
- \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}
-
- \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}
-
- \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}
-
- \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}
-
- \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}
-
- \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}
-
- \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}
-
- \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}
-
- \indexspace
- \bigletter K
- \item keys() (src.pyconf.Mapping method), \hyperpage{58}
-
- \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}
-
- \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}
-
- \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}
-
- \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}
-
- \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}
-
- \indexspace
- \bigletter Q
- \item QName (class in src.ElementTree), \hyperpage{32}
-
- \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}
-
- \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}
-
- \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}
-
- \indexspace
- \bigletter U
- \item UP() (src.colorama.ansi.AnsiCursor method), \hyperpage{65}
- \item update\_hat\_xml() (in module src.logger), \hyperpage{46}
-
- \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}
-
- \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}
-
- \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}
-
-\end{sphinxtheindex}
+++ /dev/null
-\BOOKMARK [0][-]{chapter.1}{\376\377\000Q\000u\000i\000c\000k\000\040\000s\000t\000a\000r\000t}{}% 1
-\BOOKMARK [1][-]{section.1.1}{\376\377\000I\000n\000s\000t\000a\000l\000l\000a\000t\000i\000o\000n}{chapter.1}% 2
-\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
-%% Generated by Sphinx.
+% Generated by Sphinx.
\def\sphinxdocclass{report}
+\newif\ifsphinxKeepOldNames \sphinxKeepOldNamestrue
\documentclass[a4paper,10pt,english]{sphinxmanual}
-\ifdefined\pdfpxdimen
- \let\sphinxpxdimen\pdfpxdimen\else\newdimen\sphinxpxdimen
-\fi \sphinxpxdimen=.75bp\relax
+\usepackage{iftex}
-\PassOptionsToPackage{warn}{textcomp}
-\usepackage[utf8]{inputenc}
+\ifPDFTeX
+ \usepackage[utf8]{inputenc}
+\fi
\ifdefined\DeclareUnicodeCharacter
- \ifdefined\DeclareUnicodeCharacterAsOptional
- \DeclareUnicodeCharacter{"00A0}{\nobreakspace}
- \DeclareUnicodeCharacter{"2500}{\sphinxunichar{2500}}
- \DeclareUnicodeCharacter{"2502}{\sphinxunichar{2502}}
- \DeclareUnicodeCharacter{"2514}{\sphinxunichar{2514}}
- \DeclareUnicodeCharacter{"251C}{\sphinxunichar{251C}}
- \DeclareUnicodeCharacter{"2572}{\textbackslash}
- \else
\DeclareUnicodeCharacter{00A0}{\nobreakspace}
- \DeclareUnicodeCharacter{2500}{\sphinxunichar{2500}}
- \DeclareUnicodeCharacter{2502}{\sphinxunichar{2502}}
- \DeclareUnicodeCharacter{2514}{\sphinxunichar{2514}}
- \DeclareUnicodeCharacter{251C}{\sphinxunichar{251C}}
- \DeclareUnicodeCharacter{2572}{\textbackslash}
- \fi
\fi
\usepackage{cmap}
\usepackage[T1]{fontenc}
\usepackage{babel}
\usepackage{times}
\usepackage[Bjarne]{fncychap}
+\usepackage{longtable}
\usepackage{sphinx}
-\sphinxsetup{verbatimwithframe=false, VerbatimColor={rgb}{.98,.94,.94}}
-\usepackage{geometry}
-
-% Include hyperref last.
-\usepackage{hyperref}
-% Fix anchor placement for figures with captions.
-\usepackage{hypcap}% it must be loaded after hyperref.
-% Set up styles of URL: it should be placed after hyperref.
-\urlstyle{same}
+\usepackage{multirow}
+\usepackage{eqparbox}
-\addto\captionsenglish{\renewcommand{\figurename}{Fig.}}
-\addto\captionsenglish{\renewcommand{\tablename}{Table}}
-\addto\captionsenglish{\renewcommand{\literalblockname}{Listing}}
-\addto\captionsenglish{\renewcommand{\literalblockcontinuedname}{continued from previous page}}
-\addto\captionsenglish{\renewcommand{\literalblockcontinuesname}{continues on next page}}
+\addto\captionsenglish{\renewcommand{\figurename}{Fig.\@ }}
+\addto\captionsenglish{\renewcommand{\tablename}{Table }}
+\SetupFloatingEnvironment{literal-block}{name=Listing }
\addto\extrasenglish{\def\pageautorefname{page}}
\setcounter{tocdepth}{1}
-
\title{salomeTools Documentation}
-\date{Apr 25, 2018}
+\date{Apr 27, 2018}
\release{5.0.0dev}
\author{CEA DEN/DANS/DM2S/STMF/LGLS}
-\newcommand{\sphinxlogo}{\vbox{}}
+\newcommand{\sphinxlogo}{}
\renewcommand{\releasename}{Release}
\makeindex
+\makeatletter
+\def\PYG@reset{\let\PYG@it=\relax \let\PYG@bf=\relax%
+ \let\PYG@ul=\relax \let\PYG@tc=\relax%
+ \let\PYG@bc=\relax \let\PYG@ff=\relax}
+\def\PYG@tok#1{\csname PYG@tok@#1\endcsname}
+\def\PYG@toks#1+{\ifx\relax#1\empty\else%
+ \PYG@tok{#1}\expandafter\PYG@toks\fi}
+\def\PYG@do#1{\PYG@bc{\PYG@tc{\PYG@ul{%
+ \PYG@it{\PYG@bf{\PYG@ff{#1}}}}}}}
+\def\PYG#1#2{\PYG@reset\PYG@toks#1+\relax+\PYG@do{#2}}
+
+\expandafter\def\csname PYG@tok@gd\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.63,0.00,0.00}{##1}}}
+\expandafter\def\csname PYG@tok@gu\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.50,0.00,0.50}{##1}}}
+\expandafter\def\csname PYG@tok@gt\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.27,0.87}{##1}}}
+\expandafter\def\csname PYG@tok@gs\endcsname{\let\PYG@bf=\textbf}
+\expandafter\def\csname PYG@tok@gr\endcsname{\def\PYG@tc##1{\textcolor[rgb]{1.00,0.00,0.00}{##1}}}
+\expandafter\def\csname PYG@tok@cm\endcsname{\let\PYG@it=\textit\def\PYG@tc##1{\textcolor[rgb]{0.25,0.50,0.56}{##1}}}
+\expandafter\def\csname PYG@tok@vg\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.73,0.38,0.84}{##1}}}
+\expandafter\def\csname PYG@tok@vi\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.73,0.38,0.84}{##1}}}
+\expandafter\def\csname PYG@tok@vm\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.73,0.38,0.84}{##1}}}
+\expandafter\def\csname PYG@tok@mh\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}}
+\expandafter\def\csname PYG@tok@cs\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.50,0.56}{##1}}\def\PYG@bc##1{\setlength{\fboxsep}{0pt}\colorbox[rgb]{1.00,0.94,0.94}{\strut ##1}}}
+\expandafter\def\csname PYG@tok@ge\endcsname{\let\PYG@it=\textit}
+\expandafter\def\csname PYG@tok@vc\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.73,0.38,0.84}{##1}}}
+\expandafter\def\csname PYG@tok@il\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}}
+\expandafter\def\csname PYG@tok@go\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.20,0.20,0.20}{##1}}}
+\expandafter\def\csname PYG@tok@cp\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
+\expandafter\def\csname PYG@tok@gi\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.63,0.00}{##1}}}
+\expandafter\def\csname PYG@tok@gh\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.00,0.50}{##1}}}
+\expandafter\def\csname PYG@tok@ni\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.84,0.33,0.22}{##1}}}
+\expandafter\def\csname PYG@tok@nl\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.13,0.44}{##1}}}
+\expandafter\def\csname PYG@tok@nn\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.05,0.52,0.71}{##1}}}
+\expandafter\def\csname PYG@tok@no\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.38,0.68,0.84}{##1}}}
+\expandafter\def\csname PYG@tok@na\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}}
+\expandafter\def\csname PYG@tok@nb\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
+\expandafter\def\csname PYG@tok@nc\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.05,0.52,0.71}{##1}}}
+\expandafter\def\csname PYG@tok@nd\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.33,0.33,0.33}{##1}}}
+\expandafter\def\csname PYG@tok@ne\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
+\expandafter\def\csname PYG@tok@nf\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.02,0.16,0.49}{##1}}}
+\expandafter\def\csname PYG@tok@si\endcsname{\let\PYG@it=\textit\def\PYG@tc##1{\textcolor[rgb]{0.44,0.63,0.82}{##1}}}
+\expandafter\def\csname PYG@tok@s2\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}}
+\expandafter\def\csname PYG@tok@nt\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.02,0.16,0.45}{##1}}}
+\expandafter\def\csname PYG@tok@nv\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.73,0.38,0.84}{##1}}}
+\expandafter\def\csname PYG@tok@s1\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}}
+\expandafter\def\csname PYG@tok@dl\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}}
+\expandafter\def\csname PYG@tok@ch\endcsname{\let\PYG@it=\textit\def\PYG@tc##1{\textcolor[rgb]{0.25,0.50,0.56}{##1}}}
+\expandafter\def\csname PYG@tok@m\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}}
+\expandafter\def\csname PYG@tok@gp\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.78,0.36,0.04}{##1}}}
+\expandafter\def\csname PYG@tok@sh\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}}
+\expandafter\def\csname PYG@tok@ow\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
+\expandafter\def\csname PYG@tok@sx\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.78,0.36,0.04}{##1}}}
+\expandafter\def\csname PYG@tok@bp\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
+\expandafter\def\csname PYG@tok@c1\endcsname{\let\PYG@it=\textit\def\PYG@tc##1{\textcolor[rgb]{0.25,0.50,0.56}{##1}}}
+\expandafter\def\csname PYG@tok@fm\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.02,0.16,0.49}{##1}}}
+\expandafter\def\csname PYG@tok@o\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.40,0.40,0.40}{##1}}}
+\expandafter\def\csname PYG@tok@kc\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
+\expandafter\def\csname PYG@tok@c\endcsname{\let\PYG@it=\textit\def\PYG@tc##1{\textcolor[rgb]{0.25,0.50,0.56}{##1}}}
+\expandafter\def\csname PYG@tok@mf\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}}
+\expandafter\def\csname PYG@tok@err\endcsname{\def\PYG@bc##1{\setlength{\fboxsep}{0pt}\fcolorbox[rgb]{1.00,0.00,0.00}{1,1,1}{\strut ##1}}}
+\expandafter\def\csname PYG@tok@mb\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}}
+\expandafter\def\csname PYG@tok@ss\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.32,0.47,0.09}{##1}}}
+\expandafter\def\csname PYG@tok@sr\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.14,0.33,0.53}{##1}}}
+\expandafter\def\csname PYG@tok@mo\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}}
+\expandafter\def\csname PYG@tok@kd\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
+\expandafter\def\csname PYG@tok@mi\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}}
+\expandafter\def\csname PYG@tok@kn\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
+\expandafter\def\csname PYG@tok@cpf\endcsname{\let\PYG@it=\textit\def\PYG@tc##1{\textcolor[rgb]{0.25,0.50,0.56}{##1}}}
+\expandafter\def\csname PYG@tok@kr\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
+\expandafter\def\csname PYG@tok@s\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}}
+\expandafter\def\csname PYG@tok@kp\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
+\expandafter\def\csname PYG@tok@w\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.73,0.73,0.73}{##1}}}
+\expandafter\def\csname PYG@tok@kt\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.56,0.13,0.00}{##1}}}
+\expandafter\def\csname PYG@tok@sc\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}}
+\expandafter\def\csname PYG@tok@sb\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}}
+\expandafter\def\csname PYG@tok@sa\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}}
+\expandafter\def\csname PYG@tok@k\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
+\expandafter\def\csname PYG@tok@se\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}}
+\expandafter\def\csname PYG@tok@sd\endcsname{\let\PYG@it=\textit\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}}
+
+\def\PYGZbs{\char`\\}
+\def\PYGZus{\char`\_}
+\def\PYGZob{\char`\{}
+\def\PYGZcb{\char`\}}
+\def\PYGZca{\char`\^}
+\def\PYGZam{\char`\&}
+\def\PYGZlt{\char`\<}
+\def\PYGZgt{\char`\>}
+\def\PYGZsh{\char`\#}
+\def\PYGZpc{\char`\%}
+\def\PYGZdl{\char`\$}
+\def\PYGZhy{\char`\-}
+\def\PYGZsq{\char`\'}
+\def\PYGZdq{\char`\"}
+\def\PYGZti{\char`\~}
+% for compatibility with earlier versions
+\def\PYGZat{@}
+\def\PYGZlb{[}
+\def\PYGZrb{]}
+\makeatother
+
+\renewcommand\PYGZsq{\textquotesingle}
+
\begin{document}
\maketitle
-\sphinxtableofcontents
-\phantomsection\label{\detokenize{index::doc}}
-\clearpage
-
+\tableofcontents
+\phantomsection\label{index::doc}\clearpage
-\noindent{\hspace*{\fill}\sphinxincludegraphics[scale=1.0]{{sat_about}.png}\hspace*{\fill}}
+\noindent{\hspace*{\fill}\scalebox{1.000000}{\sphinxincludegraphics{{sat_about}.png}}\hspace*{\fill}}
-\begin{sphinxadmonition}{warning}{Warning:}
+\begin{notice}{warning}{Warning:}
This documentation is under construction.
-\end{sphinxadmonition}
+\end{notice}
-The \sphinxstylestrong{Sa}lome\sphinxstylestrong{T}ools (sat) is a suite of commands
-that can be used to perform operations on \sphinxhref{http://www.salome-platform.org}{SALOME}%
-\begin{footnote}[1]\sphinxAtStartFootnote
-\sphinxnolinkurl{http://www.salome-platform.org}
-%
-\end{footnote}.
+The \textbf{Sa}lome\textbf{T}ools (sat) is a suite of commands
+that can be used to perform operations on \href{http://www.salome-platform.org}{SALOME}\footnote[1]{\sphinxAtStartFootnote%
+\nolinkurl{http://www.salome-platform.org}
+}.
-For example, sat allows you to compile SALOME’s codes
+For example, sat allows you to compile SALOME's codes
(prerequisites, products)
create application, run tests, create package, etc.
-This utility code is a set of \sphinxhref{https://docs.python.org/2.7}{Python}%
-\begin{footnote}[2]\sphinxAtStartFootnote
-\sphinxnolinkurl{https://docs.python.org/2.7}
-%
-\end{footnote} scripts files.
+This utility code is a set of \href{https://docs.python.org/2.7}{Python}\footnote[2]{\sphinxAtStartFootnote%
+\nolinkurl{https://docs.python.org/2.7}
+} scripts files.
-Find a \sphinxhref{./../latex/salomeTools.pdf}{pdf version of this documentation}
+Find a pdf version of this documentation
\chapter{Quick start}
-\label{\detokenize{index:quick-start}}\label{\detokenize{index:salome-tools}}
+\label{index:quick-start}\label{index:salome-tools}
\section{Installation}
-\label{\detokenize{installation_of_sat:installation}}\label{\detokenize{installation_of_sat::doc}}
-Usually user could find (and use) command \sphinxstylestrong{sat} directly after a ‘detar’ installation of SALOME.
+\label{installation_of_sat:installation}\label{installation_of_sat::doc}
+Usually user could find (and use) command \textbf{sat} directly after a `detar' installation of SALOME.
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
tar \PYGZhy{}xf .../SALOME\PYGZus{}xx.tgz
\PYG{n+nb}{cd} SALOME\PYGZus{}xx
ls \PYGZhy{}l sat \PYG{c+c1}{\PYGZsh{} sat \PYGZhy{}\PYGZgt{} salomeTools/sat}
-\end{sphinxVerbatim}
+\end{Verbatim}
-Python package (scripts of salomeTools) actually remains in directory \sphinxstyleemphasis{salomeTools}.
+Python package (scripts of salomeTools) actually remains in directory \emph{salomeTools}.
\section{Configuration}
-\label{\detokenize{configuration:configuration}}\label{\detokenize{configuration::doc}}
-\sphinxstyleemphasis{salomeTools} uses files to store its configuration parameters.
+\label{configuration:configuration}\label{configuration::doc}
+\emph{salomeTools} uses files to store its configuration parameters.
There are several configuration files which are loaded by salomeTools in a specific order.
-When all the files are loaded a \sphinxstyleemphasis{config} object is created.
+When all the files are loaded a \emph{config} object is created.
Then, this object is passed to all command scripts.
\subsection{Syntax}
-\label{\detokenize{configuration:syntax}}
+\label{configuration:syntax}
The configuration files use a python-like structure format
-(see \sphinxhref{http://www.red-dove.com/config-doc/}{config module}%
-\begin{footnote}[3]\sphinxAtStartFootnote
-\sphinxnolinkurl{http://www.red-dove.com/config-doc/}
-%
-\end{footnote} for a complete description).
+(see \href{http://www.red-dove.com/config-doc/}{config module}\footnote[3]{\sphinxAtStartFootnote%
+\nolinkurl{http://www.red-dove.com/config-doc/}
+} for a complete description).
\begin{itemize}
\item {}
-\sphinxstylestrong{\{\}} define a dictionary,
+\textbf{\{\}} define a dictionary,
\item {}
-\sphinxstylestrong{{[}{]}} define a list,
+\textbf{{[}{]}} define a list,
\item {}
-\sphinxstylestrong{@} can be used to include a file,
+\textbf{@} can be used to include a file,
\item {}
-\sphinxstylestrong{\$prefix} reference to another parameter (ex: \sphinxcode{\sphinxupquote{\$PRODUCT.name}}),
+\textbf{\$prefix} reference to another parameter (ex: \sphinxcode{\$PRODUCT.name}),
\item {}
-\sphinxstylestrong{\#} comments.
+\textbf{\#} comments.
\end{itemize}
-\begin{sphinxadmonition}{note}{Note:}
-in this documentation a reference to a configuration parameter will be noted \sphinxcode{\sphinxupquote{XXX.YYY}}.
-\end{sphinxadmonition}
+\begin{notice}{note}{Note:}
+in this documentation a reference to a configuration parameter will be noted \sphinxcode{XXX.YYY}.
+\end{notice}
\subsection{Description}
-\label{\detokenize{configuration:description}}
+\label{configuration:description}
\subsubsection{VARS section}
-\label{\detokenize{configuration:vars-section}}\label{\detokenize{configuration:id1}}
+\label{configuration:vars-section}\label{configuration:id1}
\begin{DUlineblock}{0em}
\item[] This section is dynamically created by salomeTools at run time.
\item[] It contains information about the environment: date, time, OS, architecture etc.
\end{DUlineblock}
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{c+c1}{\PYGZsh{} to get the current setting}
\PYG{n}{sat} \PYG{n}{config} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{value} \PYG{n}{VARS}
-\end{sphinxVerbatim}
+\end{Verbatim}
\subsubsection{PRODUCTS section}
-\label{\detokenize{configuration:products-section}}
+\label{configuration:products-section}
\begin{DUlineblock}{0em}
\item[] This section is defined in the product file.
\item[] It contains instructions on how to build a version of SALOME (list of prerequisites-products and versions)
\end{DUlineblock}
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{c+c1}{\PYGZsh{} to get the current setting}
\PYG{n}{sat} \PYG{n}{config} \PYG{n}{SALOME}\PYG{o}{\PYGZhy{}}\PYG{n}{xx} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{value} \PYG{n}{PRODUCTS}
-\end{sphinxVerbatim}
+\end{Verbatim}
\subsubsection{APPLICATION section}
-\label{\detokenize{configuration:application-section}}
+\label{configuration:application-section}
\begin{DUlineblock}{0em}
\item[] This section is optional, it is also defined in the product file.
\item[] It gives additional parameters to create an application based on SALOME, as versions of products to use.
\end{DUlineblock}
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{c+c1}{\PYGZsh{} to get the current setting}
\PYG{n}{sat} \PYG{n}{config} \PYG{n}{SALOME}\PYG{o}{\PYGZhy{}}\PYG{n}{xx} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{value} \PYG{n}{APPLICATION}
-\end{sphinxVerbatim}
+\end{Verbatim}
\subsubsection{USER section}
-\label{\detokenize{configuration:user-section}}\label{\detokenize{configuration:id2}}
+\label{configuration:user-section}\label{configuration:id2}
This section is defined by the user configuration file,
-\sphinxcode{\sphinxupquote{\textasciitilde{}/.salomeTools/salomeTools.pyconf}}.
+\sphinxcode{\textasciitilde{}/.salomeTools/salomeTools.pyconf}.
-The \sphinxcode{\sphinxupquote{USER}} section defines some parameters (not exhaustive):
+The \sphinxcode{USER} section defines some parameters (not exhaustive):
\begin{itemize}
\item {}
-\sphinxstylestrong{workDir} :
+\textbf{workDir} :
\begin{quote}
\begin{DUlineblock}{0em}
\end{quote}
\item {}
-\sphinxstylestrong{browser} : The web browser to use (\sphinxstyleemphasis{firefox}).
+\textbf{browser} : The web browser to use (\emph{firefox}).
\item {}
-\sphinxstylestrong{editor} : The editor to use (\sphinxstyleemphasis{vi, pluma}).
+\textbf{editor} : The editor to use (\emph{vi, pluma}).
\item {}
and other user preferences.
\end{itemize}
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{c+c1}{\PYGZsh{} to get the current setting}
\PYG{n}{sat} \PYG{n}{config} \PYG{n}{SALOME}\PYG{o}{\PYGZhy{}}\PYG{n}{xx} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{value} \PYG{n}{USER}
-\end{sphinxVerbatim}
-
+\end{Verbatim}
\clearpage
-
\section{Usage of SAlomeTools}
-\label{\detokenize{usage_of_sat:svn}}\label{\detokenize{usage_of_sat:usage-of-salometools}}\label{\detokenize{usage_of_sat::doc}}
+\label{usage_of_sat:svn}\label{usage_of_sat:usage-of-salometools}\label{usage_of_sat::doc}
\subsection{Usage}
-\label{\detokenize{usage_of_sat:usage}}
-sat usage is a Command Line Interface (\sphinxhref{https://en.wikipedia.org/wiki/Command-line\_interface}{CLI}%
-\begin{footnote}[4]\sphinxAtStartFootnote
-\sphinxnolinkurl{https://en.wikipedia.org/wiki/Command-line\_interface}
-%
-\end{footnote}).
-
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\label{usage_of_sat:usage}
+sat usage is a Command Line Interface (\href{https://en.wikipedia.org/wiki/Command-line\_interface}{CLI}\footnote[4]{\sphinxAtStartFootnote%
+\nolinkurl{https://en.wikipedia.org/wiki/Command-line\_interface}
+}).
+
+\begin{Verbatim}[commandchars=\\\{\}]
sat \PYG{o}{[}generic\PYGZus{}options\PYG{o}{]} \PYG{o}{[}command\PYG{o}{]} \PYG{o}{[}product\PYG{o}{]} \PYG{o}{[}command\PYGZus{}options\PYG{o}{]}
-\end{sphinxVerbatim}
+\end{Verbatim}
\subsubsection{Options of sat}
-\label{\detokenize{usage_of_sat:options-of-sat}}
-Useful \sphinxstyleemphasis{not exhaustive} generic options of \sphinxstyleemphasis{sat} CLI.
+\label{usage_of_sat:options-of-sat}
+Useful \emph{not exhaustive} generic options of \emph{sat} CLI.
-\paragraph{\sphinxstyleemphasis{\textendash{}help or -h}}
-\label{\detokenize{usage_of_sat:help-or-h}}
+\paragraph{\emph{--help or -h}}
+\label{usage_of_sat:help-or-h}
Get help as simple text.
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
sat \PYGZhy{}\PYGZhy{}help \PYG{c+c1}{\PYGZsh{} get the list of existing commands}
sat \PYGZhy{}\PYGZhy{}help compile \PYG{c+c1}{\PYGZsh{} get the help on a specific command \PYGZsq{}compile\PYGZsq{}}
-\end{sphinxVerbatim}
+\end{Verbatim}
-\paragraph{\sphinxstyleemphasis{\textendash{}debug or -g}}
-\label{\detokenize{usage_of_sat:debug-or-g}}
-Execution in debug mode allows to see more trace and \sphinxstyleemphasis{stack} if an exception is raised.
+\paragraph{\emph{--debug or -g}}
+\label{usage_of_sat:debug-or-g}
+Execution in debug mode allows to see more trace and \emph{stack} if an exception is raised.
-\paragraph{\sphinxstyleemphasis{\textendash{}verbose or -v}}
-\label{\detokenize{usage_of_sat:verbose-or-v}}
+\paragraph{\emph{--verbose or -v}}
+\label{usage_of_sat:verbose-or-v}
Change verbosity level (default is 3).
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{c+c1}{\PYGZsh{} for product \PYGZsq{}SALOME\PYGZus{}xx\PYGZsq{} for example}
\PYG{c+c1}{\PYGZsh{} execute compile command in debug mode with trace level 4}
sat \PYGZhy{}g \PYGZhy{}v \PYG{l+m}{4} compile SALOME\PYGZus{}xx
-\end{sphinxVerbatim}
+\end{Verbatim}
\subsection{Build a SALOME product}
-\label{\detokenize{usage_of_sat:build-a-salome-product}}
+\label{usage_of_sat:build-a-salome-product}
\subsubsection{Get the list of available products}
-\label{\detokenize{usage_of_sat:get-the-list-of-available-products}}
+\label{usage_of_sat:get-the-list-of-available-products}
To get the list of the current available products in your context:
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
sat config \PYGZhy{}\PYGZhy{}list
-\end{sphinxVerbatim}
+\end{Verbatim}
\subsubsection{Prepare sources of a product}
-\label{\detokenize{usage_of_sat:prepare-sources-of-a-product}}
-To prepare (get) \sphinxstyleemphasis{all} the sources of a product (\sphinxstyleemphasis{SALOME\_xx} for example):
+\label{usage_of_sat:prepare-sources-of-a-product}
+To prepare (get) \emph{all} the sources of a product (\emph{SALOME\_xx} for example):
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
sat prepare SALOME\PYGZus{}xx
-\end{sphinxVerbatim}
+\end{Verbatim}
\begin{DUlineblock}{0em}
\item[] The sources are usually copied in directories
-\item[] \sphinxstyleemphasis{\$USER.workDir + SALOME\_xx… + SOURCES + \$PRODUCT.name}
+\item[] \emph{\$USER.workDir + SALOME\_xx... + SOURCES + \$PRODUCT.name}
\end{DUlineblock}
\subsubsection{Compile SALOME}
-\label{\detokenize{usage_of_sat:compile-salome}}
+\label{usage_of_sat:compile-salome}
To compile products:
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{c+c1}{\PYGZsh{} compile all prerequisites/products}
sat compile SALOME\PYGZus{}xx
\PYG{c+c1}{\PYGZsh{} compile only 2 products, unconditionaly}
sat compile SALOME\PYGZus{}xx \PYGZhy{}\PYGZhy{}\PYGZhy{}products SAMPLES \PYGZhy{}\PYGZhy{}clean\PYGZus{}all
-\end{sphinxVerbatim}
+\end{Verbatim}
\begin{DUlineblock}{0em}
\item[] The products are usually build in the directories
-\item[] \sphinxstyleemphasis{\$USER.workDir + SALOME\_xx… + BUILD + \$PRODUCT.name}
+\item[] \emph{\$USER.workDir + SALOME\_xx... + BUILD + \$PRODUCT.name}
\item[]
\item[] The products are usually installed in the directories
-\item[] \sphinxstyleemphasis{\$USER.workDir + SALOME\_xx… + INSTALL + \$PRODUCT.name}
+\item[] \emph{\$USER.workDir + SALOME\_xx... + INSTALL + \$PRODUCT.name}
\end{DUlineblock}
\chapter{List of Commands}
-\label{\detokenize{index:list-of-commands}}
-\clearpage
-
+\label{index:list-of-commands}\clearpage
\section{Command config}
-\label{\detokenize{commands/config:svn}}\label{\detokenize{commands/config:command-config}}\label{\detokenize{commands/config::doc}}
+\label{commands/config:svn}\label{commands/config:command-config}\label{commands/config::doc}
\subsection{Description}
-\label{\detokenize{commands/config:description}}
-The \sphinxstylestrong{config} command manages sat configuration.
+\label{commands/config:description}
+The \textbf{config} command manages sat configuration.
It allows display, manipulation and operation on configuration files
\subsection{Usage}
-\label{\detokenize{commands/config:usage}}\begin{itemize}
+\label{commands/config:usage}\begin{itemize}
\item {}
-Edit the user personal configuration file \sphinxcode{\sphinxupquote{\$HOME/.salomeTools/SAT.pyconf}}. It is used to store the user personal choices, like the favorite editor, browser, pdf viewer:
+Edit the user personal configuration file \sphinxcode{\$HOME/.salomeTools/SAT.pyconf}. It is used to store the user personal choices, like the favorite editor, browser, pdf viewer:
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{config} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{edit}
-\end{sphinxVerbatim}
+\end{Verbatim}
\item {}
-List the available applications (they come from the sat projects defined in \sphinxcode{\sphinxupquote{data/local.pyconf}}:
+List the available applications (they come from the sat projects defined in \sphinxcode{data/local.pyconf}:
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{config} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n+nb}{list}
-\end{sphinxVerbatim}
+\end{Verbatim}
\item {}
Edit the configuration of an application:
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{config} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{edit}
-\end{sphinxVerbatim}
+\end{Verbatim}
\item {}
Copy an application configuration file into the user personal directory:
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{config} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{copy} \PYG{p}{[}\PYG{n}{new\PYGZus{}name}\PYG{p}{]}
-\end{sphinxVerbatim}
+\end{Verbatim}
\item {}
\begin{DUlineblock}{0em}
\item[] Print the value of a configuration parameter.
\item[] Use the automatic completion to get recursively the parameter names.
-\item[] Use \sphinxstyleemphasis{\textendash{}no\_label} option to get \sphinxstyleemphasis{only} the value, \sphinxstyleemphasis{without} label (useful in automatic scripts).
-\item[] Examples (with \sphinxstyleemphasis{SALOME-xx} as \sphinxstyleemphasis{SALOME-8.4.0} ):
+\item[] Use \emph{--no\_label} option to get \emph{only} the value, \emph{without} label (useful in automatic scripts).
+\item[] Examples (with \emph{SALOME-xx} as \emph{SALOME-8.4.0} ):
\end{DUlineblock}
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{c+c1}{\PYGZsh{} sat config \PYGZhy{}\PYGZhy{}value \PYGZlt{}parameter\PYGZus{}path\PYGZgt{}}
sat config \PYGZhy{}\PYGZhy{}value . \PYG{c+c1}{\PYGZsh{} all the configuration}
sat config \PYGZhy{}\PYGZhy{}value LOCAL
\PYG{c+c1}{\PYGZsh{} sat config \PYGZlt{}application\PYGZgt{} \PYGZhy{}\PYGZhy{}value \PYGZlt{}parameter\PYGZus{}path\PYGZgt{}}
sat config SALOME\PYGZhy{}xx \PYGZhy{}\PYGZhy{}value APPLICATION.workdir
sat config SALOME\PYGZhy{}xx \PYGZhy{}\PYGZhy{}no\PYGZus{}label \PYGZhy{}\PYGZhy{}value APPLICATION.workdir
-\end{sphinxVerbatim}
+\end{Verbatim}
\item {}
\begin{DUlineblock}{0em}
\item[] Print in one-line-by-value mode the value of a configuration parameter,
-\item[] with its source \sphinxstyleemphasis{expression}, if any.
+\item[] with its source \emph{expression}, if any.
\item[] This is a debug mode, useful for developers.
\item[] Prints the parameter path, the source expression if any, and the final value:
\end{DUlineblock}
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{config} \PYG{n}{SALOME}\PYG{o}{\PYGZhy{}}\PYG{n}{xx} \PYG{o}{\PYGZhy{}}\PYG{n}{g} \PYG{n}{USER}
-\end{sphinxVerbatim}
+\end{Verbatim}
-\begin{sphinxadmonition}{note}{Note:}
-And so, \sphinxstyleemphasis{not only for fun}, to get \sphinxstylestrong{all expressions} of configuration
+\begin{notice}{note}{Note:}
+And so, \emph{not only for fun}, to get \textbf{all expressions} of configuration
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
sat config SALOME\PYGZhy{}xx \PYGZhy{}g . \PYG{p}{\textbar{}} grep \PYGZhy{}e \PYG{l+s+s2}{\PYGZdq{}\PYGZhy{}\PYGZhy{}\PYGZgt{}\PYGZdq{}}
-\end{sphinxVerbatim}
-\end{sphinxadmonition}
+\end{Verbatim}
+\end{notice}
\item {}
Print the patches that are applied:
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{config} \PYG{n}{SALOME}\PYG{o}{\PYGZhy{}}\PYG{n}{xx} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{show\PYGZus{}patchs}
-\end{sphinxVerbatim}
+\end{Verbatim}
\item {}
Get information on a product configuration:
\end{itemize}
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{c+c1}{\PYGZsh{} sat config \PYGZlt{}application\PYGZgt{} \PYGZhy{}\PYGZhy{}info \PYGZlt{}product\PYGZgt{}}
sat config SALOME\PYGZhy{}xx \PYGZhy{}\PYGZhy{}info KERNEL
sat config SALOME\PYGZhy{}xx \PYGZhy{}\PYGZhy{}info qt
-\end{sphinxVerbatim}
+\end{Verbatim}
\subsection{Some useful configuration pathes}
-\label{\detokenize{commands/config:some-useful-configuration-pathes}}
+\label{commands/config:some-useful-configuration-pathes}
Exploring a current configuration.
\begin{itemize}
\item {}
-\sphinxstylestrong{PATHS}: To get list of directories where to find files.
+\textbf{PATHS}: To get list of directories where to find files.
\item {}
-\sphinxstylestrong{USER}: To get user preferences (editor, pdf viewer, web browser, default working dir).
+\textbf{USER}: To get user preferences (editor, pdf viewer, web browser, default working dir).
\end{itemize}
sat commands:
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{config} \PYG{n}{SALOME}\PYG{o}{\PYGZhy{}}\PYG{n}{xx} \PYG{o}{\PYGZhy{}}\PYG{n}{v} \PYG{n}{PATHS}
\PYG{n}{sat} \PYG{n}{config} \PYG{n}{SALOME}\PYG{o}{\PYGZhy{}}\PYG{n}{xx} \PYG{o}{\PYGZhy{}}\PYG{n}{v} \PYG{n}{USERS}
-\end{sphinxVerbatim}
-
+\end{Verbatim}
\clearpage
-
\section{Command prepare}
-\label{\detokenize{commands/prepare:svn}}\label{\detokenize{commands/prepare:command-prepare}}\label{\detokenize{commands/prepare::doc}}
+\label{commands/prepare:svn}\label{commands/prepare:command-prepare}\label{commands/prepare::doc}
\subsection{Description}
-\label{\detokenize{commands/prepare:description}}
-The \sphinxstylestrong{prepare} command brings the sources of an application in the \sphinxstyleemphasis{sources
+\label{commands/prepare:description}
+The \textbf{prepare} command brings the sources of an application in the \emph{sources
application directory}, in order to compile them with the compile command.
-The sources can be prepared from VCS software (\sphinxstyleemphasis{cvs, svn, git}), an archive or a directory.
+The sources can be prepared from VCS software (\emph{cvs, svn, git}), an archive or a directory.
-\begin{sphinxadmonition}{warning}{Warning:}
+\begin{notice}{warning}{Warning:}
When sat prepares a product, it first removes the
existing directory, except if the development mode is activated.
When you are working on a product, you need to declare in
-the application configuration this product in \sphinxstylestrong{dev} mode.
-\end{sphinxadmonition}
+the application configuration this product in \textbf{dev} mode.
+\end{notice}
\subsection{Remarks}
-\label{\detokenize{commands/prepare:remarks}}
+\label{commands/prepare:remarks}
\subsubsection{VCS bases (git, svn, cvs)}
-\label{\detokenize{commands/prepare:vcs-bases-git-svn-cvs}}
-The \sphinxstyleemphasis{prepare} command does not manage authentication on the cvs server.
+\label{commands/prepare:vcs-bases-git-svn-cvs}
+The \emph{prepare} command does not manage authentication on the cvs server.
For example, to prepare modules from a cvs server, you first need to login once.
To avoid typing a password for each product,
\subsubsection{Dev mode}
-\label{\detokenize{commands/prepare:dev-mode}}
-By default \sphinxstyleemphasis{prepare} uses \sphinxstyleemphasis{export} mode: it creates an image
+\label{commands/prepare:dev-mode}
+By default \emph{prepare} uses \emph{export} mode: it creates an image
of the sources, corresponding to the tag or branch specified,
without any link to the VCS base.
-To perform a \sphinxstyleemphasis{checkout} (svn, cvs) or a \sphinxstyleemphasis{git clone} (git),
+To perform a \emph{checkout} (svn, cvs) or a \emph{git clone} (git),
you need to declare the product in dev mode in your application configuration:
edit the application configuration file (pyconf) and modify the product declaration:
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
sat config \PYGZlt{}application\PYGZgt{} \PYGZhy{}e
\PYG{c+c1}{\PYGZsh{} and edit the product section:}
\PYG{c+c1}{\PYGZsh{} \PYGZlt{}product\PYGZgt{} : \PYGZob{}tag : \PYGZdq{}my\PYGZus{}tag\PYGZdq{}, dev : \PYGZdq{}yes\PYGZdq{}, debug : \PYGZdq{}yes\PYGZdq{}\PYGZcb{}}
-\end{sphinxVerbatim}
+\end{Verbatim}
-The first time you will execute the \sphinxstyleemphasis{sat prepare} command,
-your module will be downloaded in \sphinxstyleemphasis{checkout} mode
+The first time you will execute the \emph{sat prepare} command,
+your module will be downloaded in \emph{checkout} mode
(inside the SOURCES directory of the application.
Then, you can develop in this repository, and finally push
them in the base when they are ready.
If you type during the development process by mistake
-a \sphinxstyleemphasis{sat prepare} command, the sources in dev mode will
+a \emph{sat prepare} command, the sources in dev mode will
not be altered/removed (Unless you use -f option)
\subsection{Usage}
-\label{\detokenize{commands/prepare:usage}}\begin{itemize}
+\label{commands/prepare:usage}\begin{itemize}
\item {}
Prepare the sources of a complete application in SOURCES directory (all products):
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{prepare} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}}
-\end{sphinxVerbatim}
+\end{Verbatim}
\item {}
Prepare only some modules:
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{prepare} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{products} \PYG{o}{\PYGZlt{}}\PYG{n}{product1}\PYG{o}{\PYGZgt{}}\PYG{p}{,}\PYG{o}{\PYGZlt{}}\PYG{n}{product2}\PYG{o}{\PYGZgt{}} \PYG{o}{.}\PYG{o}{.}\PYG{o}{.}
-\end{sphinxVerbatim}
+\end{Verbatim}
\item {}
-Use \textendash{}force to force to prepare the products in development mode
+Use --force to force to prepare the products in development mode
(this will remove the sources and do a new clone/checkout):
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{prepare} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{force}
-\end{sphinxVerbatim}
+\end{Verbatim}
\item {}
-Use \textendash{}force\_patch to force to apply patch to the products
+Use --force\_patch to force to apply patch to the products
in development mode (otherwise they are not applied):
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{prepare} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{force\PYGZus{}patch}
-\end{sphinxVerbatim}
+\end{Verbatim}
\end{itemize}
\subsection{Some useful configuration pathes}
-\label{\detokenize{commands/prepare:some-useful-configuration-pathes}}
-Command \sphinxstyleemphasis{sat prepare} uses the \sphinxstyleemphasis{pyconf file configuration} of each product to know how to get the sources.
+\label{commands/prepare:some-useful-configuration-pathes}
+Command \emph{sat prepare} uses the \emph{pyconf file configuration} of each product to know how to get the sources.
-\begin{sphinxadmonition}{note}{Note:}
-to verify configuration of a product, and get name of this \sphinxstyleemphasis{pyconf files configuration}
+\begin{notice}{note}{Note:}
+to verify configuration of a product, and get name of this \emph{pyconf files configuration}
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
sat config \PYGZlt{}application\PYGZgt{} \PYGZhy{}\PYGZhy{}info \PYGZlt{}product\PYGZgt{}
-\end{sphinxVerbatim}
-\end{sphinxadmonition}
+\end{Verbatim}
+\end{notice}
\begin{itemize}
\item {}
-\sphinxstylestrong{get\_method}: the method to use to prepare the module, possible values are cvs, git, archive, dir.
+\textbf{get\_method}: the method to use to prepare the module, possible values are cvs, git, archive, dir.
\item {}
-\sphinxstylestrong{git\_info} : (used if get\_method = git) information to prepare sources from git.
+\textbf{git\_info} : (used if get\_method = git) information to prepare sources from git.
\item {}
-\sphinxstylestrong{svn\_info} : (used if get\_method = svn) information to prepare sources from cvs.
+\textbf{svn\_info} : (used if get\_method = svn) information to prepare sources from cvs.
\item {}
-\sphinxstylestrong{cvs\_info} : (used if get\_method = cvs) information to prepare sources from cvs.
+\textbf{cvs\_info} : (used if get\_method = cvs) information to prepare sources from cvs.
\item {}
-\sphinxstylestrong{archive\_info} : (used if get\_method = archive) the path to the archive.
+\textbf{archive\_info} : (used if get\_method = archive) the path to the archive.
\item {}
-\sphinxstylestrong{dir\_info} : (used if get\_method = dir) the directory with the sources.
+\textbf{dir\_info} : (used if get\_method = dir) the directory with the sources.
\end{itemize}
-
\clearpage
-
\section{Command compile}
-\label{\detokenize{commands/compile:svn}}\label{\detokenize{commands/compile:command-compile}}\label{\detokenize{commands/compile::doc}}
+\label{commands/compile:svn}\label{commands/compile:command-compile}\label{commands/compile::doc}
\subsection{Description}
-\label{\detokenize{commands/compile:description}}
-The \sphinxstylestrong{compile} command allows compiling the products of a \sphinxhref{http://www.salome-platform.org}{SALOME}%
-\begin{footnote}[5]\sphinxAtStartFootnote
-\sphinxnolinkurl{http://www.salome-platform.org}
-%
-\end{footnote} application.
+\label{commands/compile:description}
+The \textbf{compile} command allows compiling the products of a \href{http://www.salome-platform.org}{SALOME}\footnote[5]{\sphinxAtStartFootnote%
+\nolinkurl{http://www.salome-platform.org}
+} application.
\subsection{Usage}
-\label{\detokenize{commands/compile:usage}}\begin{itemize}
+\label{commands/compile:usage}\begin{itemize}
\item {}
Compile a complete application:
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n+nb}{compile} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}}
-\end{sphinxVerbatim}
+\end{Verbatim}
\item {}
Compile only some products:
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n+nb}{compile} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{products} \PYG{o}{\PYGZlt{}}\PYG{n}{product1}\PYG{o}{\PYGZgt{}}\PYG{p}{,}\PYG{o}{\PYGZlt{}}\PYG{n}{product2}\PYG{o}{\PYGZgt{}} \PYG{o}{.}\PYG{o}{.}\PYG{o}{.}
-\end{sphinxVerbatim}
+\end{Verbatim}
\item {}
-Use \sphinxstyleemphasis{sat -t} to duplicate the logs in the terminal (by default the log are stored and displayed with \sphinxstyleemphasis{sat log} command):
+Use \emph{sat -t} to duplicate the logs in the terminal (by default the log are stored and displayed with \emph{sat log} command):
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{o}{\PYGZhy{}}\PYG{n}{t} \PYG{n+nb}{compile} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{products} \PYG{o}{\PYGZlt{}}\PYG{n}{product1}\PYG{o}{\PYGZgt{}}
-\end{sphinxVerbatim}
+\end{Verbatim}
\item {}
Compile a module and its dependencies:
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n+nb}{compile} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{products} \PYG{n}{med} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{with\PYGZus{}fathers}
-\end{sphinxVerbatim}
+\end{Verbatim}
\item {}
Compile a module and the modules depending on it (for example plugins):
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n+nb}{compile} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{products} \PYG{n}{med} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{with\PYGZus{}children}
-\end{sphinxVerbatim}
+\end{Verbatim}
\item {}
Clean the build and install directories before starting compilation:
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n+nb}{compile} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{products} \PYG{n}{GEOM} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{clean\PYGZus{}all}
-\end{sphinxVerbatim}
+\end{Verbatim}
-\begin{sphinxadmonition}{note}{Note:}
+\begin{notice}{note}{Note:}
\begin{DUlineblock}{0em}
-\item[] a warning will be shown if option \sphinxstyleemphasis{\textendash{}products} is missing
+\item[] a warning will be shown if option \emph{--products} is missing
\item[] (as it will clean everything)
\end{DUlineblock}
-\end{sphinxadmonition}
+\end{notice}
\item {}
Clean only the install directories before starting compilation:
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n+nb}{compile} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{clean\PYGZus{}install}
-\end{sphinxVerbatim}
+\end{Verbatim}
\item {}
Add options for make:
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n+nb}{compile} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{products} \PYG{o}{\PYGZlt{}}\PYG{n}{product}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{make\PYGZus{}flags} \PYG{o}{\PYGZlt{}}\PYG{n}{flags}\PYG{o}{\PYGZgt{}}
-\end{sphinxVerbatim}
+\end{Verbatim}
\item {}
-Use the \sphinxstyleemphasis{\textendash{}check} option to execute the unit tests after compilation:
+Use the \emph{--check} option to execute the unit tests after compilation:
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n+nb}{compile} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{check}
-\end{sphinxVerbatim}
+\end{Verbatim}
\item {}
Remove the build directory after successful compilation (some build directory like qt are big):
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n+nb}{compile} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{products} \PYG{n}{qt} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{clean\PYGZus{}build\PYGZus{}after}
-\end{sphinxVerbatim}
+\end{Verbatim}
\item {}
Stop the compilation as soon as the compilation of a module fails:
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n+nb}{compile} \PYG{o}{\PYGZlt{}}\PYG{n}{product}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{stop\PYGZus{}first\PYGZus{}fail}
-\end{sphinxVerbatim}
+\end{Verbatim}
\item {}
Do not compile, just show if products are installed or not, and where is the installation:
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n+nb}{compile} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{show}
-\end{sphinxVerbatim}
+\end{Verbatim}
\end{itemize}
\subsection{Some useful configuration pathes}
-\label{\detokenize{commands/compile:some-useful-configuration-pathes}}
-The way to compile a product is defined in the \sphinxstyleemphasis{pyconf file configuration}.
+\label{commands/compile:some-useful-configuration-pathes}
+The way to compile a product is defined in the \emph{pyconf file configuration}.
The main options are:
\begin{itemize}
\item {}
-\sphinxstylestrong{build\_source} : the method used to build the product (cmake/autotools/script)
+\textbf{build\_source} : the method used to build the product (cmake/autotools/script)
\item {}
-\sphinxstylestrong{compil\_script} : the compilation script if build\_source is equal to “script”
+\textbf{compil\_script} : the compilation script if build\_source is equal to ``script''
\item {}
-\sphinxstylestrong{cmake\_options} : additional options for cmake.
+\textbf{cmake\_options} : additional options for cmake.
\item {}
-\sphinxstylestrong{nb\_proc} : number of jobs to use with make for this product.
+\textbf{nb\_proc} : number of jobs to use with make for this product.
\end{itemize}
-
\clearpage
-
\section{Command launcher}
-\label{\detokenize{commands/launcher:svn}}\label{\detokenize{commands/launcher:command-launcher}}\label{\detokenize{commands/launcher::doc}}
+\label{commands/launcher:svn}\label{commands/launcher:command-launcher}\label{commands/launcher::doc}
\subsection{Description}
-\label{\detokenize{commands/launcher:description}}
-The \sphinxstylestrong{launcher} command creates a SALOME launcher, a python script file to start \sphinxhref{http://www.salome-platform.org}{SALOME}%
-\begin{footnote}[6]\sphinxAtStartFootnote
-\sphinxnolinkurl{http://www.salome-platform.org}
-%
-\end{footnote}.
+\label{commands/launcher:description}
+The \textbf{launcher} command creates a SALOME launcher, a python script file to start \href{http://www.salome-platform.org}{SALOME}\footnote[6]{\sphinxAtStartFootnote%
+\nolinkurl{http://www.salome-platform.org}
+}.
\subsection{Usage}
-\label{\detokenize{commands/launcher:usage}}\begin{itemize}
+\label{commands/launcher:usage}\begin{itemize}
\item {}
Create a launcher:
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{launcher} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}}
-\end{sphinxVerbatim}
+\end{Verbatim}
-Generate a launcher in the application directory, i.e \sphinxcode{\sphinxupquote{\$APPLICATION.workdir}}.
+Generate a launcher in the application directory, i.e \sphinxcode{\$APPLICATION.workdir}.
\item {}
-Create a launcher with a given name (default name is \sphinxcode{\sphinxupquote{APPLICATION.profile.launcher\_name}})
+Create a launcher with a given name (default name is \sphinxcode{APPLICATION.profile.launcher\_name})
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{launcher} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{name} \PYG{n}{ZeLauncher}
-\end{sphinxVerbatim}
+\end{Verbatim}
-The launcher will be called \sphinxstyleemphasis{ZeLauncher}.
+The launcher will be called \emph{ZeLauncher}.
\item {}
Set a specific resources catalog:
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{launcher} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{catalog} \PYG{o}{\PYGZlt{}}\PYG{n}{path} \PYG{n}{of} \PYG{n}{a} \PYG{n}{salome} \PYG{n}{resources} \PYG{n}{catalog}\PYG{o}{\PYGZgt{}}
-\end{sphinxVerbatim}
+\end{Verbatim}
Note that the catalog specified will be copied to the profile directory.
\item {}
Generate the catalog for a list of machines:
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{launcher} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{gencat} \PYG{o}{\PYGZlt{}}\PYG{n+nb}{list} \PYG{n}{of} \PYG{n}{machines}\PYG{o}{\PYGZgt{}}
-\end{sphinxVerbatim}
+\end{Verbatim}
This will create a catalog by querying each machine (memory, number of processor) with ssh.
\item {}
Generate a mesa launcher (if mesa and llvm are parts of the application). Use this option only if you have to use salome through ssh and have problems with ssh X forwarding of OpengGL modules (like Paravis):
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{launcher} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{use\PYGZus{}mesa}
-\end{sphinxVerbatim}
+\end{Verbatim}
\end{itemize}
\subsection{Configuration}
-\label{\detokenize{commands/launcher:configuration}}
+\label{commands/launcher:configuration}
Some useful configuration pathes:
\begin{itemize}
\item {}
-\sphinxstylestrong{APPLICATION.profile}
+\textbf{APPLICATION.profile}
\begin{itemize}
\item {}
-\sphinxstylestrong{product} : the name of the profile product (the product in charge of holding the application stuff, like logos, splashscreen)
+\textbf{product} : the name of the profile product (the product in charge of holding the application stuff, like logos, splashscreen)
\item {}
-\sphinxstylestrong{launcher\_name} : the name of the launcher.
+\textbf{launcher\_name} : the name of the launcher.
\end{itemize}
\end{itemize}
-
\clearpage
-
\section{Command application}
-\label{\detokenize{commands/application:svn}}\label{\detokenize{commands/application::doc}}\label{\detokenize{commands/application:command-application}}
+\label{commands/application:svn}\label{commands/application::doc}\label{commands/application:command-application}
\subsection{Description}
-\label{\detokenize{commands/application:description}}
-The \sphinxstylestrong{application} command creates a virtual \sphinxhref{http://www.salome-platform.org}{SALOME}%
-\begin{footnote}[7]\sphinxAtStartFootnote
-\sphinxnolinkurl{http://www.salome-platform.org}
-%
-\end{footnote} application.
+\label{commands/application:description}
+The \textbf{application} command creates a virtual \href{http://www.salome-platform.org}{SALOME}\footnote[7]{\sphinxAtStartFootnote%
+\nolinkurl{http://www.salome-platform.org}
+} application.
Virtual SALOME applications are used to start SALOME when distribution is needed.
\subsection{Usage}
-\label{\detokenize{commands/application:usage}}\begin{itemize}
+\label{commands/application:usage}\begin{itemize}
\item {}
Create an application:
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{application} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}}
-\end{sphinxVerbatim}
+\end{Verbatim}
-Create the virtual application directory in the salomeTool application directory \sphinxcode{\sphinxupquote{\$APPLICATION.workdir}}.
+Create the virtual application directory in the salomeTool application directory \sphinxcode{\$APPLICATION.workdir}.
\item {}
Give a name to the application:
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{application} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{name} \PYG{o}{\PYGZlt{}}\PYG{n}{my\PYGZus{}application\PYGZus{}name}\PYG{o}{\PYGZgt{}}
-\end{sphinxVerbatim}
+\end{Verbatim}
-\sphinxstyleemphasis{Remark}: this option overrides the name given in the virtual\_app section of the configuration file \sphinxcode{\sphinxupquote{\$APPLICATION.virtual\_app.name}}.
+\emph{Remark}: this option overrides the name given in the virtual\_app section of the configuration file \sphinxcode{\$APPLICATION.virtual\_app.name}.
\item {}
Change the directory where the application is created:
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{application} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{target} \PYG{o}{\PYGZlt{}}\PYG{n}{my\PYGZus{}application\PYGZus{}directory}\PYG{o}{\PYGZgt{}}
-\end{sphinxVerbatim}
+\end{Verbatim}
\item {}
-Set a specific \sphinxhref{http://www.salome-platform.org}{SALOME}%
-\begin{footnote}[8]\sphinxAtStartFootnote
-\sphinxnolinkurl{http://www.salome-platform.org}
-%
-\end{footnote} resources catalog (it will be used for the distribution of components on distant machines):
+Set a specific \href{http://www.salome-platform.org}{SALOME}\footnote[8]{\sphinxAtStartFootnote%
+\nolinkurl{http://www.salome-platform.org}
+} resources catalog (it will be used for the distribution of components on distant machines):
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{application} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{catalog} \PYG{o}{\PYGZlt{}}\PYG{n}{path\PYGZus{}to\PYGZus{}catalog}\PYG{o}{\PYGZgt{}}
-\end{sphinxVerbatim}
+\end{Verbatim}
Note that the catalog specified will be copied to the application directory.
\item {}
Generate the catalog for a list of machines:
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{application} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{gencat} \PYG{n}{machine1}\PYG{p}{,}\PYG{n}{machine2}\PYG{p}{,}\PYG{n}{machine3}
-\end{sphinxVerbatim}
+\end{Verbatim}
This will create a catalog by querying each machine through ssh protocol (memory, number of processor) with ssh.
\item {}
Generate a mesa application (if mesa and llvm are parts of the application). Use this option only if you have to use salome through ssh and have problems with ssh X forwarding of OpengGL modules (like Paravis):
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{launcher} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{use\PYGZus{}mesa}
-\end{sphinxVerbatim}
+\end{Verbatim}
\end{itemize}
\subsection{Some useful configuration pathes}
-\label{\detokenize{commands/application:some-useful-configuration-pathes}}
+\label{commands/application:some-useful-configuration-pathes}
The virtual application can be configured with the virtual\_app section of the configutation file.
\begin{itemize}
\item {}
-\sphinxstylestrong{APPLICATION.virtual\_app}
+\textbf{APPLICATION.virtual\_app}
\begin{itemize}
\item {}
-\sphinxstylestrong{name} : name of the launcher (to replace the default runAppli).
+\textbf{name} : name of the launcher (to replace the default runAppli).
\item {}
-\sphinxstylestrong{application\_name} : (optional) the name of the virtual application directory, if missing the default value is \sphinxcode{\sphinxupquote{\$name + \_appli}}.
+\textbf{application\_name} : (optional) the name of the virtual application directory, if missing the default value is \sphinxcode{\$name + \_appli}.
\end{itemize}
\end{itemize}
-
\clearpage
-
\section{Command log}
-\label{\detokenize{commands/log:svn}}\label{\detokenize{commands/log:command-log}}\label{\detokenize{commands/log::doc}}
+\label{commands/log:svn}\label{commands/log:command-log}\label{commands/log::doc}
\subsection{Description}
-\label{\detokenize{commands/log:description}}
-The \sphinxstylestrong{log} command displays sat log in a web browser or in a terminal.
+\label{commands/log:description}
+The \textbf{log} command displays sat log in a web browser or in a terminal.
\subsection{Usage}
-\label{\detokenize{commands/log:usage}}\begin{itemize}
+\label{commands/log:usage}\begin{itemize}
\item {}
Show (in a web browser) the log of the commands corresponding to an application:
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{log} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}}
-\end{sphinxVerbatim}
+\end{Verbatim}
\item {}
Show the log for commands that do not use any application:
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{log}
-\end{sphinxVerbatim}
+\end{Verbatim}
\item {}
-The \textendash{}terminal (or -t) display the log directly in the terminal, through a \sphinxhref{https://en.wikipedia.org/wiki/Command-line\_interface}{CLI}%
-\begin{footnote}[9]\sphinxAtStartFootnote
-\sphinxnolinkurl{https://en.wikipedia.org/wiki/Command-line\_interface}
-%
-\end{footnote} interactive menu:
+The --terminal (or -t) display the log directly in the terminal, through a \href{https://en.wikipedia.org/wiki/Command-line\_interface}{CLI}\footnote[9]{\sphinxAtStartFootnote%
+\nolinkurl{https://en.wikipedia.org/wiki/Command-line\_interface}
+} interactive menu:
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{log} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{terminal}
-\end{sphinxVerbatim}
+\end{Verbatim}
\item {}
-The \textendash{}last option displays only the last command:
+The --last option displays only the last command:
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{log} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{last}
-\end{sphinxVerbatim}
+\end{Verbatim}
\item {}
-To access the last compilation log in terminal mode, use \textendash{}last\_terminal option:
+To access the last compilation log in terminal mode, use --last\_terminal option:
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{log} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{last\PYGZus{}terminal}
-\end{sphinxVerbatim}
+\end{Verbatim}
\item {}
-The \textendash{}clean (int) option erases the n older log files and print the number of remaining log files:
+The --clean (int) option erases the n older log files and print the number of remaining log files:
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{log} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{clean} \PYG{l+m+mi}{50}
-\end{sphinxVerbatim}
+\end{Verbatim}
\end{itemize}
\subsection{Some useful configuration pathes}
-\label{\detokenize{commands/log:some-useful-configuration-pathes}}\begin{itemize}
+\label{commands/log:some-useful-configuration-pathes}\begin{itemize}
\item {}
-\sphinxstylestrong{USER}
+\textbf{USER}
\begin{itemize}
\item {}
-\sphinxstylestrong{browser} : The browser used to show the log (by default \sphinxstyleemphasis{firefox}).
+\textbf{browser} : The browser used to show the log (by default \emph{firefox}).
\item {}
-\sphinxstylestrong{log\_dir} : The directory used to store the log files.
+\textbf{log\_dir} : The directory used to store the log files.
\end{itemize}
\end{itemize}
-
\clearpage
-
\section{Command environ}
-\label{\detokenize{commands/environ:svn}}\label{\detokenize{commands/environ:command-environ}}\label{\detokenize{commands/environ::doc}}
+\label{commands/environ:svn}\label{commands/environ:command-environ}\label{commands/environ::doc}
\subsection{Description}
-\label{\detokenize{commands/environ:description}}
-The \sphinxstylestrong{environ} command generates the environment files used
-to run and compile your application (as \sphinxhref{http://www.salome-platform.org}{SALOME}%
-\begin{footnote}[10]\sphinxAtStartFootnote
-\sphinxnolinkurl{http://www.salome-platform.org}
-%
-\end{footnote} is an example).
-
-\begin{sphinxadmonition}{note}{Note:}
-these files are \sphinxstylestrong{not} required,
+\label{commands/environ:description}
+The \textbf{environ} command generates the environment files used
+to run and compile your application (as \href{http://www.salome-platform.org}{SALOME}\footnote[10]{\sphinxAtStartFootnote%
+\nolinkurl{http://www.salome-platform.org}
+} is an example).
+
+\begin{notice}{note}{Note:}
+these files are \textbf{not} required,
salomeTool set the environment himself, when compiling.
And so does the salome launcher.
These files are useful when someone wants to check the environment.
-They could be used in debug mode to set the environment for \sphinxstyleemphasis{gdb}.
-\end{sphinxadmonition}
+They could be used in debug mode to set the environment for \emph{gdb}.
+\end{notice}
The configuration part at the end of this page explains how
to specify the environment used by sat (at build or run time),
-and saved in some files by \sphinxstyleemphasis{sat environ} command.
+and saved in some files by \emph{sat environ} command.
\subsection{Usage}
-\label{\detokenize{commands/environ:usage}}\begin{itemize}
+\label{commands/environ:usage}\begin{itemize}
\item {}
Create the shell environment files of the application:
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{environ} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}}
-\end{sphinxVerbatim}
+\end{Verbatim}
\item {}
Create the environment files of the application for a given shell.
-Options are bash, bat (for windows) and cfg (the configuration format used by \sphinxhref{http://www.salome-platform.org}{SALOME}%
-\begin{footnote}[11]\sphinxAtStartFootnote
-\sphinxnolinkurl{http://www.salome-platform.org}
-%
-\end{footnote}):
-
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+Options are bash, bat (for windows) and cfg (the configuration format used by \href{http://www.salome-platform.org}{SALOME}\footnote[11]{\sphinxAtStartFootnote%
+\nolinkurl{http://www.salome-platform.org}
+}):
+
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{environ} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{shell} \PYG{p}{[}\PYG{n}{bash}\PYG{o}{\textbar{}}\PYG{n}{cfg}\PYG{o}{\textbar{}}\PYG{n+nb}{all}\PYG{p}{]}
-\end{sphinxVerbatim}
+\end{Verbatim}
\item {}
-Use a different prefix for the files (default is ‘env’):
+Use a different prefix for the files (default is `env'):
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{c+c1}{\PYGZsh{} This will create file \PYGZlt{}prefix\PYGZgt{}\PYGZus{}launch.sh, \PYGZlt{}prefix\PYGZgt{}\PYGZus{}build.sh}
sat environ \PYGZlt{}application\PYGZgt{} \PYGZhy{}\PYGZhy{}prefix \PYGZlt{}prefix\PYGZgt{}
-\end{sphinxVerbatim}
+\end{Verbatim}
\item {}
Use a different target directory for the files:
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{c+c1}{\PYGZsh{} This will create file env\PYGZus{}launch.sh, env\PYGZus{}build.sh}
\PYG{c+c1}{\PYGZsh{} in the directory corresponding to \PYGZlt{}path\PYGZgt{}}
sat environ \PYGZlt{}application\PYGZgt{} \PYGZhy{}\PYGZhy{}target \PYGZlt{}path\PYGZgt{}
-\end{sphinxVerbatim}
+\end{Verbatim}
\item {}
Generate the environment files only with the given products:
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{c+c1}{\PYGZsh{} This will create the environment files only for the given products}
\PYG{c+c1}{\PYGZsh{} and their prerequisites.}
\PYG{c+c1}{\PYGZsh{} It is useful when you want to visualise which environment uses}
\PYG{c+c1}{\PYGZsh{} sat to compile a given product.}
sat environ \PYGZlt{}application\PYGZgt{} \PYGZhy{}\PYGZhy{}product \PYGZlt{}product1\PYGZgt{},\PYGZlt{}product2\PYGZgt{}, ...
-\end{sphinxVerbatim}
+\end{Verbatim}
\end{itemize}
\subsection{Configuration}
-\label{\detokenize{commands/environ:configuration}}
+\label{commands/environ:configuration}
The specification of the environment can be done through several mechanisms.
\begin{enumerate}
\item {}
-For salome products (the products with the property \sphinxcode{\sphinxupquote{is\_SALOME\_module}} as \sphinxcode{\sphinxupquote{yes}}) the environment is set automatically by sat, in respect with \sphinxhref{http://www.salome-platform.org}{SALOME}%
-\begin{footnote}[12]\sphinxAtStartFootnote
-\sphinxnolinkurl{http://www.salome-platform.org}
-%
-\end{footnote} requirements.
+For salome products (the products with the property \sphinxcode{is\_SALOME\_module} as \sphinxcode{yes}) the environment is set automatically by sat, in respect with \href{http://www.salome-platform.org}{SALOME}\footnote[12]{\sphinxAtStartFootnote%
+\nolinkurl{http://www.salome-platform.org}
+} requirements.
\item {}
For other products, the environment is set with the use of the environ section within the pyconf file of the product. The user has two possibilities, either set directly the environment within the section, or specify a python script which wil be used to set the environment programmatically.
\end{enumerate}
Within the section, the user can define environment variables. He can also modify PATH variables, by appending or prepending directories.
-In the following example, we prepend \sphinxstyleemphasis{\textless{}install\_dir\textgreater{}/lib} to \sphinxcode{\sphinxupquote{LD\_LIBRARY\_PATH}} (note the \sphinxstyleemphasis{left first} underscore), append \sphinxstyleemphasis{\textless{}install\_dir\textgreater{}/lib} to \sphinxcode{\sphinxupquote{PYTHONPATH}} (note the \sphinxstyleemphasis{right last} underscore), and set \sphinxcode{\sphinxupquote{LAPACK\_ROOT\_DIR}} to \sphinxstyleemphasis{\textless{}install\_dir\textgreater{}}:
+In the following example, we prepend \emph{\textless{}install\_dir\textgreater{}/lib} to \sphinxcode{LD\_LIBRARY\_PATH} (note the \emph{left first} underscore), append \emph{\textless{}install\_dir\textgreater{}/lib} to \sphinxcode{PYTHONPATH} (note the \emph{right last} underscore), and set \sphinxcode{LAPACK\_ROOT\_DIR} to \emph{\textless{}install\_dir\textgreater{}}:
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
environ :
\PYG{o}{\PYGZob{}}
\PYGZus{}LD\PYGZus{}LIBRARY\PYGZus{}PATH : \PYG{n+nv}{\PYGZdl{}install\PYGZus{}dir} + \PYG{n+nv}{\PYGZdl{}VARS}.sep + \PYG{l+s+s2}{\PYGZdq{}lib\PYGZdq{}}
PYTHONPATH\PYGZus{} : \PYG{n+nv}{\PYGZdl{}install\PYGZus{}dir} + \PYG{n+nv}{\PYGZdl{}VARS}.sep + \PYG{l+s+s2}{\PYGZdq{}lib\PYGZdq{}}
LAPACK\PYGZus{}ROOT\PYGZus{}DIR : \PYG{n+nv}{\PYGZdl{}install\PYGZus{}dir}
\PYG{o}{\PYGZcb{}}
-\end{sphinxVerbatim}
+\end{Verbatim}
-It is possible to distinguish the build environment from the launch environment: use a subsection called \sphinxstyleemphasis{build} or \sphinxstyleemphasis{launch}. In the example below, \sphinxcode{\sphinxupquote{LD\_LIBRARY\_PATH}} and \sphinxcode{\sphinxupquote{PYTHONPATH}} are only modified at run time, not at compile time:
+It is possible to distinguish the build environment from the launch environment: use a subsection called \emph{build} or \emph{launch}. In the example below, \sphinxcode{LD\_LIBRARY\_PATH} and \sphinxcode{PYTHONPATH} are only modified at run time, not at compile time:
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
environ :
\PYG{o}{\PYGZob{}}
build :
PYTHONPATH\PYGZus{} : \PYG{n+nv}{\PYGZdl{}install\PYGZus{}dir} + \PYG{n+nv}{\PYGZdl{}VARS}.sep + \PYG{l+s+s2}{\PYGZdq{}lib\PYGZdq{}}
\PYG{o}{\PYGZcb{}}
\PYG{o}{\PYGZcb{}}
-\end{sphinxVerbatim}
+\end{Verbatim}
\begin{enumerate}
\setcounter{enumi}{2}
\item {}
-The last possibility is to set the environment with a python script. The script should be provided in the \sphinxstyleemphasis{products/env\_scripts} directory of the sat project, and its name is specified in the environment section with the key \sphinxcode{\sphinxupquote{environ.env\_script}}:
+The last possibility is to set the environment with a python script. The script should be provided in the \emph{products/env\_scripts} directory of the sat project, and its name is specified in the environment section with the key \sphinxcode{environ.env\_script}:
\end{enumerate}
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{n}{environ} \PYG{p}{:}
\PYG{p}{\PYGZob{}}
\PYG{n}{env\PYGZus{}script} \PYG{p}{:} \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{lapack.py}\PYG{l+s+s1}{\PYGZsq{}}
\PYG{p}{\PYGZcb{}}
-\end{sphinxVerbatim}
+\end{Verbatim}
Please note that the two modes are complementary and are both taken into account.
Most of the time, the first mode is sufficient.
which is called by sat to set the environment.
Here is an example:
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{c+ch}{\PYGZsh{}!/usr/bin/env python}
\PYG{c+c1}{\PYGZsh{}\PYGZhy{}*\PYGZhy{} coding:utf\PYGZhy{}8 \PYGZhy{}*\PYGZhy{}}
\PYG{n}{env}\PYG{o}{.}\PYG{n}{prepend}\PYG{p}{(}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{PATH}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{n}{os}\PYG{o}{.}\PYG{n}{path}\PYG{o}{.}\PYG{n}{join}\PYG{p}{(}\PYG{n}{prereq\PYGZus{}dir}\PYG{p}{,} \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{include}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{)}\PYG{p}{)}
\PYG{n}{env}\PYG{o}{.}\PYG{n}{prepend}\PYG{p}{(}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{LD\PYGZus{}LIBRARY\PYGZus{}PATH}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{n}{os}\PYG{o}{.}\PYG{n}{path}\PYG{o}{.}\PYG{n}{join}\PYG{p}{(}\PYG{n}{prereq\PYGZus{}dir}\PYG{p}{,} \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{lib}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{)}\PYG{p}{)}
\PYG{k}{return}
-\end{sphinxVerbatim}
+\end{Verbatim}
SalomeTools defines four handles:
\begin{itemize}
\item {}
-\sphinxstylestrong{set\_env(env, prereq\_dir, version)} : used at build and run time.
+\textbf{set\_env(env, prereq\_dir, version)} : used at build and run time.
\item {}
-\sphinxstylestrong{set\_env\_launch(env, prereq\_dir, version)} : used only at run time (if defined!)
+\textbf{set\_env\_launch(env, prereq\_dir, version)} : used only at run time (if defined!)
\item {}
-\sphinxstylestrong{set\_env\_build(env, prereq\_dir, version)} : used only at build time (if defined!)
+\textbf{set\_env\_build(env, prereq\_dir, version)} : used only at build time (if defined!)
\item {}
-\sphinxstylestrong{set\_native\_env(env)} : used only for native products, at build and run time.
+\textbf{set\_native\_env(env)} : used only for native products, at build and run time.
\end{itemize}
-
\clearpage
-
\section{Command clean}
-\label{\detokenize{commands/clean:svn}}\label{\detokenize{commands/clean:command-clean}}\label{\detokenize{commands/clean::doc}}
+\label{commands/clean:svn}\label{commands/clean:command-clean}\label{commands/clean::doc}
\subsection{Description}
-\label{\detokenize{commands/clean:description}}
-The \sphinxstylestrong{clean} command removes products in the \sphinxstyleemphasis{source, build, or install} directories of an application. Theses directories are usually named \sphinxcode{\sphinxupquote{SOURCES, BUILD, INSTALL}}.
+\label{commands/clean:description}
+The \textbf{clean} command removes products in the \emph{source, build, or install} directories of an application. Theses directories are usually named \sphinxcode{SOURCES, BUILD, INSTALL}.
Use the options to define what directories you want to suppress and to set the list of products
\subsection{Usage}
-\label{\detokenize{commands/clean:usage}}\begin{itemize}
+\label{commands/clean:usage}\begin{itemize}
\item {}
-Clean all previously created \sphinxstyleemphasis{build} and \sphinxstyleemphasis{install} directories (example application as \sphinxstyleemphasis{SALOME\_xx}):
+Clean all previously created \emph{build} and \emph{install} directories (example application as \emph{SALOME\_xx}):
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{c+c1}{\PYGZsh{} take care, is long time to restore, sometimes}
sat clean SALOME\PYGZhy{}xx \PYGZhy{}\PYGZhy{}build \PYGZhy{}\PYGZhy{}install
-\end{sphinxVerbatim}
+\end{Verbatim}
\item {}
-Clean previously created \sphinxstyleemphasis{build} and \sphinxstyleemphasis{install} directories, only for products with property \sphinxstyleemphasis{is\_salome\_module}:
+Clean previously created \emph{build} and \emph{install} directories, only for products with property \emph{is\_salome\_module}:
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
sat clean SALOME\PYGZhy{}xxx \PYGZhy{}\PYGZhy{}build \PYGZhy{}\PYGZhy{}install \PYG{l+s+se}{\PYGZbs{}}
\PYGZhy{}\PYGZhy{}properties is\PYGZus{}salome\PYGZus{}module:yes
-\end{sphinxVerbatim}
+\end{Verbatim}
\end{itemize}
\subsection{Availables options}
-\label{\detokenize{commands/clean:availables-options}}\begin{itemize}
+\label{commands/clean:availables-options}\begin{itemize}
\item {}
-\sphinxstylestrong{\textendash{}products} : Products to clean.
+\textbf{--products} : Products to clean.
\item {}
-\sphinxstylestrong{\textendash{}properties} :
+\textbf{--properties} :
\begin{DUlineblock}{0em}
\item[] Filter the products by their properties.
-\item[] Syntax: \sphinxstyleemphasis{\textendash{}properties \textless{}property\textgreater{}:\textless{}value\textgreater{}}
+\item[] Syntax: \emph{--properties \textless{}property\textgreater{}:\textless{}value\textgreater{}}
\end{DUlineblock}
\item {}
-\sphinxstylestrong{\textendash{}sources} : Clean the product source directories.
+\textbf{--sources} : Clean the product source directories.
\item {}
-\sphinxstylestrong{\textendash{}build} : Clean the product build directories.
+\textbf{--build} : Clean the product build directories.
\item {}
-\sphinxstylestrong{\textendash{}install} : Clean the product install directories.
+\textbf{--install} : Clean the product install directories.
\item {}
-\sphinxstylestrong{\textendash{}all} : Clean the product source, build and install directories.
+\textbf{--all} : Clean the product source, build and install directories.
\item {}
-\sphinxstylestrong{\textendash{}sources\_without\_dev} :
+\textbf{--sources\_without\_dev} :
\begin{DUlineblock}{0em}
\item[] Do not clean the products in development mode,
-\item[] (they could have \sphinxhref{https://en.wikipedia.org/wiki/Version\_control}{VCS}%
-\begin{footnote}[13]\sphinxAtStartFootnote
-\sphinxnolinkurl{https://en.wikipedia.org/wiki/Version\_control}
-%
-\end{footnote} commits pending).
+\item[] (they could have \href{https://en.wikipedia.org/wiki/Version\_control}{VCS}\footnote[13]{\sphinxAtStartFootnote%
+\nolinkurl{https://en.wikipedia.org/wiki/Version\_control}
+} commits pending).
\end{DUlineblock}
\end{itemize}
\subsection{Some useful configuration pathes}
-\label{\detokenize{commands/clean:some-useful-configuration-pathes}}
+\label{commands/clean:some-useful-configuration-pathes}
No specific configuration.
-
\clearpage
-
\section{Command package}
-\label{\detokenize{commands/package:svn}}\label{\detokenize{commands/package:command-package}}\label{\detokenize{commands/package::doc}}
+\label{commands/package:svn}\label{commands/package:command-package}\label{commands/package::doc}
\subsection{Description}
-\label{\detokenize{commands/package:description}}
-The \sphinxstylestrong{package} command creates a \sphinxhref{http://www.salome-platform.org}{SALOME}%
-\begin{footnote}[14]\sphinxAtStartFootnote
-\sphinxnolinkurl{http://www.salome-platform.org}
-%
-\end{footnote} archive (usually a compressed \sphinxhref{https://en.wikipedia.org/wiki/Tar\_(computing)}{Tar}%
-\begin{footnote}[15]\sphinxAtStartFootnote
-\sphinxnolinkurl{https://en.wikipedia.org/wiki/Tar\_(computing)}
-%
-\end{footnote} file .tgz).
+\label{commands/package:description}
+The \textbf{package} command creates a \href{http://www.salome-platform.org}{SALOME}\footnote[14]{\sphinxAtStartFootnote%
+\nolinkurl{http://www.salome-platform.org}
+} archive (usually a compressed \href{https://en.wikipedia.org/wiki/Tar\_(computing)}{Tar}\footnote[15]{\sphinxAtStartFootnote%
+\nolinkurl{https://en.wikipedia.org/wiki/Tar\_(computing)}
+} file .tgz).
This tar file is used later to intall SALOME on other remote computer.
Depending on the selected options, the archive includes sources and binaries
of SALOME products and prerequisites.
-Usually utility \sphinxstyleemphasis{salomeTools} is included in the archive.
+Usually utility \emph{salomeTools} is included in the archive.
-\begin{sphinxadmonition}{note}{Note:}
+\begin{notice}{note}{Note:}
By default the package includes the sources of prerequisites and products.
-To select a subset use the \sphinxstyleemphasis{\textendash{}without\_property} or \sphinxstyleemphasis{\textendash{}with\_vcs} options.
-\end{sphinxadmonition}
+To select a subset use the \emph{--without\_property} or \emph{--with\_vcs} options.
+\end{notice}
\subsection{Usage}
-\label{\detokenize{commands/package:usage}}\begin{itemize}
+\label{commands/package:usage}\begin{itemize}
\item {}
-Create a package for a product (example as \sphinxstyleemphasis{SALOME\_xx}):
+Create a package for a product (example as \emph{SALOME\_xx}):
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{package} \PYG{n}{SALOME\PYGZus{}xx}
-\end{sphinxVerbatim}
+\end{Verbatim}
-This command will create an archive named \sphinxcode{\sphinxupquote{SALOME\_xx.tgz}}
-in the working directory (\sphinxcode{\sphinxupquote{USER.workDir}}).
+This command will create an archive named \sphinxcode{SALOME\_xx.tgz}
+in the working directory (\sphinxcode{USER.workDir}).
If the archive already exists, do nothing.
\item {}
Create a package with a specific name:
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{package} \PYG{n}{SALOME\PYGZus{}xx} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{name} \PYG{n}{YourSpecificName}
-\end{sphinxVerbatim}
+\end{Verbatim}
\end{itemize}
-\begin{sphinxadmonition}{note}{Note:}
-By default, the archive is created in the working directory of the user (\sphinxcode{\sphinxupquote{USER.workDir}}).
+\begin{notice}{note}{Note:}
+By default, the archive is created in the working directory of the user (\sphinxcode{USER.workDir}).
-If the option \sphinxstyleemphasis{\textendash{}name} is used with a path (relative or absolute) it will be used.
+If the option \emph{--name} is used with a path (relative or absolute) it will be used.
-If the option \sphinxstyleemphasis{\textendash{}name} is not used and binaries (prerequisites and products)
-are included in the package, the \sphinxhref{https://en.wikipedia.org/wiki/Operating\_system}{OS}%
-\begin{footnote}[16]\sphinxAtStartFootnote
-\sphinxnolinkurl{https://en.wikipedia.org/wiki/Operating\_system}
-%
-\end{footnote} architecture
-will be appended to the name (example: \sphinxcode{\sphinxupquote{SALOME\_xx-CO7.tgz}}).
+If the option \emph{--name} is not used and binaries (prerequisites and products)
+are included in the package, the \href{https://en.wikipedia.org/wiki/Operating\_system}{OS}\footnote[16]{\sphinxAtStartFootnote%
+\nolinkurl{https://en.wikipedia.org/wiki/Operating\_system}
+} architecture
+will be appended to the name (example: \sphinxcode{SALOME\_xx-CO7.tgz}).
Examples:
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{c+c1}{\PYGZsh{} Creates SALOME\PYGZus{}xx.tgz in \PYGZdl{}USER.workDir}
\PYG{n}{sat} \PYG{n}{package} \PYG{n}{SALOME\PYGZus{}xx}
\PYG{c+c1}{\PYGZsh{} Creates MySpecificName.tgz in \PYGZdl{}USER.workDir}
\PYG{n}{sat} \PYG{n}{package} \PYG{n}{SALOME\PYGZus{}xx} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{name} \PYG{n}{MySpecificName}
-\end{sphinxVerbatim}
-\end{sphinxadmonition}
+\end{Verbatim}
+\end{notice}
\begin{itemize}
\item {}
Force the creation of the archive (if it already exists):
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{package} \PYG{n}{SALOME\PYGZus{}xx} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{force}
-\end{sphinxVerbatim}
+\end{Verbatim}
\item {}
Include the binaries in the archive (products and prerequisites):
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{package} \PYG{n}{SALOME\PYGZus{}xx} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{binaries}
-\end{sphinxVerbatim}
+\end{Verbatim}
-This command will create an archive named \sphinxcode{\sphinxupquote{SALOME\_xx \_\textless{}arch\textgreater{}.tgz}}
-where \textless{}arch\textgreater{} is the \sphinxhref{https://en.wikipedia.org/wiki/Operating\_system}{OS}%
-\begin{footnote}[17]\sphinxAtStartFootnote
-\sphinxnolinkurl{https://en.wikipedia.org/wiki/Operating\_system}
-%
-\end{footnote} architecture of the machine.
+This command will create an archive named \sphinxcode{SALOME\_xx \_\textless{}arch\textgreater{}.tgz}
+where \textless{}arch\textgreater{} is the \href{https://en.wikipedia.org/wiki/Operating\_system}{OS}\footnote[17]{\sphinxAtStartFootnote%
+\nolinkurl{https://en.wikipedia.org/wiki/Operating\_system}
+} architecture of the machine.
\item {}
-Do not delete Version Control System (\sphinxhref{https://en.wikipedia.org/wiki/Version\_control}{VCS}%
-\begin{footnote}[18]\sphinxAtStartFootnote
-\sphinxnolinkurl{https://en.wikipedia.org/wiki/Version\_control}
-%
-\end{footnote}) informations from the configurations files of the embedded salomeTools:
+Do not delete Version Control System (\href{https://en.wikipedia.org/wiki/Version\_control}{VCS}\footnote[18]{\sphinxAtStartFootnote%
+\nolinkurl{https://en.wikipedia.org/wiki/Version\_control}
+}) informations from the configurations files of the embedded salomeTools:
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{package} \PYG{n}{SALOME\PYGZus{}xx} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{with\PYGZus{}vcs}
-\end{sphinxVerbatim}
-
-The version control systems known by this option are \sphinxhref{https://fr.wikipedia.org/wiki/Concurrent\_versions\_system}{CVS}%
-\begin{footnote}[19]\sphinxAtStartFootnote
-\sphinxnolinkurl{https://fr.wikipedia.org/wiki/Concurrent\_versions\_system}
-%
-\end{footnote}, \sphinxhref{https://en.wikipedia.org/wiki/Apache\_Subversion}{SVN}%
-\begin{footnote}[20]\sphinxAtStartFootnote
-\sphinxnolinkurl{https://en.wikipedia.org/wiki/Apache\_Subversion}
-%
-\end{footnote} and \sphinxhref{https://git-scm.com}{Git}%
-\begin{footnote}[21]\sphinxAtStartFootnote
-\sphinxnolinkurl{https://git-scm.com}
-%
-\end{footnote}.
+\end{Verbatim}
+
+The version control systems known by this option are \href{https://fr.wikipedia.org/wiki/Concurrent\_versions\_system}{CVS}\footnote[19]{\sphinxAtStartFootnote%
+\nolinkurl{https://fr.wikipedia.org/wiki/Concurrent\_versions\_system}
+}, \href{https://en.wikipedia.org/wiki/Apache\_Subversion}{SVN}\footnote[20]{\sphinxAtStartFootnote%
+\nolinkurl{https://en.wikipedia.org/wiki/Apache\_Subversion}
+} and \href{https://git-scm.com}{Git}\footnote[21]{\sphinxAtStartFootnote%
+\nolinkurl{https://git-scm.com}
+}.
\end{itemize}
\subsection{Some useful configuration pathes}
-\label{\detokenize{commands/package:some-useful-configuration-pathes}}
+\label{commands/package:some-useful-configuration-pathes}
No specific configuration.
-
\clearpage
-
\section{Command generate}
-\label{\detokenize{commands/generate:svn}}\label{\detokenize{commands/generate:command-generate}}\label{\detokenize{commands/generate::doc}}
+\label{commands/generate:svn}\label{commands/generate:command-generate}\label{commands/generate::doc}
\subsection{Description}
-\label{\detokenize{commands/generate:description}}
-The \sphinxstylestrong{generate} command generates and compile SALOME modules from cpp modules using YACSGEN.
+\label{commands/generate:description}
+The \textbf{generate} command generates and compile SALOME modules from cpp modules using YACSGEN.
-\begin{sphinxadmonition}{note}{Note:}
-This command uses YACSGEN to generate the module. It needs to be specified with \sphinxstyleemphasis{\textendash{}yacsgen} option, or defined in the product or by the environment variable \sphinxcode{\sphinxupquote{\$YACSGEN\_ROOT\_DIR}}.
-\end{sphinxadmonition}
+\begin{notice}{note}{Note:}
+This command uses YACSGEN to generate the module. It needs to be specified with \emph{--yacsgen} option, or defined in the product or by the environment variable \sphinxcode{\$YACSGEN\_ROOT\_DIR}.
+\end{notice}
\subsection{Remarks}
-\label{\detokenize{commands/generate:remarks}}\begin{itemize}
+\label{commands/generate:remarks}\begin{itemize}
\item {}
This command will only apply on the CPP modules of the application, those who have both properties:
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{n}{cpp} \PYG{p}{:} \PYG{l+s+s2}{\PYGZdq{}}\PYG{l+s+s2}{yes}\PYG{l+s+s2}{\PYGZdq{}}
\PYG{n}{generate} \PYG{p}{:} \PYG{l+s+s2}{\PYGZdq{}}\PYG{l+s+s2}{yes}\PYG{l+s+s2}{\PYGZdq{}}
-\end{sphinxVerbatim}
+\end{Verbatim}
\item {}
The cpp module are usually computational components, and the generated module brings the CORBA layer which allows distributing the compononent on remore machines. cpp modules should conform to YACSGEN/hxx2salome requirements (please refer to YACSGEN documentation)
\subsection{Usage}
-\label{\detokenize{commands/generate:usage}}\begin{itemize}
+\label{commands/generate:usage}\begin{itemize}
\item {}
Generate all the modules of a product:
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{generate} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}}
-\end{sphinxVerbatim}
+\end{Verbatim}
\item {}
Generate only specific modules:
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{generate} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{products} \PYG{o}{\PYGZlt{}}\PYG{n}{list\PYGZus{}of\PYGZus{}products}\PYG{o}{\PYGZgt{}}
-\end{sphinxVerbatim}
+\end{Verbatim}
-Remark: modules which don’t have the \sphinxstyleemphasis{generate} property are ignored.
+Remark: modules which don't have the \emph{generate} property are ignored.
\item {}
Use a specific version of YACSGEN:
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{generate} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{yacsgen} \PYG{o}{\PYGZlt{}}\PYG{n}{path\PYGZus{}to\PYGZus{}yacsgen}\PYG{o}{\PYGZgt{}}
-\end{sphinxVerbatim}
+\end{Verbatim}
\end{itemize}
\chapter{Developer documentation}
-\label{\detokenize{index:developer-documentation}}
-\clearpage
-
+\label{index:developer-documentation}\clearpage
\section{Add a user custom command}
-\label{\detokenize{write_command:svn}}\label{\detokenize{write_command:add-a-user-custom-command}}\label{\detokenize{write_command::doc}}
+\label{write_command:svn}\label{write_command:add-a-user-custom-command}\label{write_command::doc}
\subsection{Introduction}
-\label{\detokenize{write_command:introduction}}
-\begin{sphinxadmonition}{note}{Note:}
-This documentation is for \sphinxhref{https://docs.python.org/2.7}{Python}%
-\begin{footnote}[22]\sphinxAtStartFootnote
-\sphinxnolinkurl{https://docs.python.org/2.7}
-%
-\end{footnote} developers.
-\end{sphinxadmonition}
+\label{write_command:introduction}
+\begin{notice}{note}{Note:}
+This documentation is for \href{https://docs.python.org/2.7}{Python}\footnote[22]{\sphinxAtStartFootnote%
+\nolinkurl{https://docs.python.org/2.7}
+} developers.
+\end{notice}
The salomeTools product provides a simple way to develop commands.
-The first thing to do is to add a file with \sphinxstyleemphasis{.py} extension in the \sphinxcode{\sphinxupquote{commands}} directory of salomeTools.
+The first thing to do is to add a file with \emph{.py} extension in the \sphinxcode{commands} directory of salomeTools.
Here are the basic requirements that must be followed in this file in order to add a command.
\subsection{Basic requirements}
-\label{\detokenize{write_command:basic-requirements}}
-By adding a file \sphinxstyleemphasis{mycommand.py} in the \sphinxcode{\sphinxupquote{commands}} directory, salomeTools will define a new command named \sphinxcode{\sphinxupquote{mycommand}}.
+\label{write_command:basic-requirements}
+\begin{notice}{warning}{Warning:}
+ALL THIS IS OBSOLETE FOR SAT 5.1
+\end{notice}
+
+By adding a file \emph{mycommand.py} in the \sphinxcode{commands} directory, salomeTools will define a new command named \sphinxcode{mycommand}.
-In \sphinxstyleemphasis{mycommand.py}, there must be the following method:
+In \emph{mycommand.py}, there must be the following method:
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{k}{def} \PYG{n+nf}{run}\PYG{p}{(}\PYG{n}{args}\PYG{p}{,} \PYG{n}{runner}\PYG{p}{,} \PYG{n}{logger}\PYG{p}{)}\PYG{p}{:}
\PYG{c+c1}{\PYGZsh{} your algorithm ...}
\PYG{k}{pass}
-\end{sphinxVerbatim}
+\end{Verbatim}
In fact, at this point, the command will already be functional.
But there are some useful services provided by salomeTools :
\end{itemize}
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{k+kn}{import} \PYG{n+nn}{src}
\PYG{c+c1}{\PYGZsh{} Define all possible option for mycommand command : \PYGZsq{}sat mycommand \PYGZlt{}options\PYGZgt{}\PYGZsq{}}
\PYG{c+c1}{\PYGZsh{} Parse the options}
\PYG{p}{(}\PYG{n}{options}\PYG{p}{,} \PYG{n}{args}\PYG{p}{)} \PYG{o}{=} \PYG{n}{parser}\PYG{o}{.}\PYG{n}{parse\PYGZus{}args}\PYG{p}{(}\PYG{n}{args}\PYG{p}{)}
\PYG{c+c1}{\PYGZsh{} algorithm}
-\end{sphinxVerbatim}
+\end{Verbatim}
\begin{itemize}
\item {}
-You can add a \sphinxstyleemphasis{description} method that will display a message when the user will call the help:
+You can add a \emph{description} method that will display a message when the user will call the help:
\end{itemize}
-\fvset{hllines={, 9, 10,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{k+kn}{import} \PYG{n+nn}{src}
\PYG{c+c1}{\PYGZsh{} Define all possible option for mycommand command : \PYGZsq{}sat mycommand \PYGZlt{}options\PYGZgt{}\PYGZsq{}}
\PYG{c+c1}{\PYGZsh{} Parse the options}
\PYG{p}{(}\PYG{n}{options}\PYG{p}{,} \PYG{n}{args}\PYG{p}{)} \PYG{o}{=} \PYG{n}{parser}\PYG{o}{.}\PYG{n}{parse\PYGZus{}args}\PYG{p}{(}\PYG{n}{args}\PYG{p}{)}
\PYG{c+c1}{\PYGZsh{} algorithm}
-\end{sphinxVerbatim}
+\end{Verbatim}
\subsection{HowTo access salomeTools config and other commands}
-\label{\detokenize{write_command:howto-access-salometools-config-and-other-commands}}
-The \sphinxstyleemphasis{runner} variable is an python instance of \sphinxstyleemphasis{Sat} class.
-It gives access to \sphinxstyleemphasis{runner.cfg} which is the data model defined from all
-\sphinxstyleemphasis{configuration pyconf files} of salomeTools
-For example, \sphinxstyleemphasis{runner.cfg.APPLICATION.workdir}
+\label{write_command:howto-access-salometools-config-and-other-commands}
+The \emph{runner} variable is an python instance of \emph{Sat} class.
+It gives access to \emph{runner.getConfig()} which is the data model defined from all
+\emph{configuration pyconf files} of salomeTools
+For example, \emph{runner.cfg.APPLICATION.workdir}
contains the root directory of the current application.
-The \sphinxstyleemphasis{runner} variable gives also access to other commands of salomeTools:
+The \emph{runner} variable gives also access to other commands of salomeTools:
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{c+c1}{\PYGZsh{} as CLI\PYGZus{} \PYGZsq{}sat prepare ...\PYGZsq{}}
\PYG{n}{runner}\PYG{o}{.}\PYG{n}{prepare}\PYG{p}{(}\PYG{n}{runner}\PYG{o}{.}\PYG{n}{cfg}\PYG{o}{.}\PYG{n}{VARS}\PYG{o}{.}\PYG{n}{application}\PYG{p}{)}
-\end{sphinxVerbatim}
+\end{Verbatim}
\subsection{HowTo logger}
-\label{\detokenize{write_command:howto-logger}}
-The logger variable is an instance of the Logger class.
-It gives access to the write method.
+\label{write_command:howto-logger}
+The logger variable is an instance of the python \sphinxcode{logging} package class.
+It gives access to \sphinxcode{debug, info, warning, error, critical} methods.
-When this method is called, the message passed as parameter
+Using these methods, the message passed as parameter
will be displayed in the terminal and written in an xml log file.
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
-\PYG{n}{logger}\PYG{o}{.}\PYG{n}{write}\PYG{p}{(}\PYG{l+s+s2}{\PYGZdq{}}\PYG{l+s+s2}{My message}\PYG{l+s+s2}{\PYGZdq{}}\PYG{p}{,} \PYG{l+m+mi}{3}\PYG{p}{)} \PYG{c+c1}{\PYGZsh{} 3 as default}
-\end{sphinxVerbatim}
-
-The second argument defines the level of verbosity
-that is wanted for this message.
-It has to be between 1 and 5 (the most verbose level).
+\begin{Verbatim}[commandchars=\\\{\}]
+\PYG{n}{logger}\PYG{o}{.}\PYG{n}{info}\PYG{p}{(}\PYG{l+s+s2}{\PYGZdq{}}\PYG{l+s+s2}{My message}\PYG{l+s+s2}{\PYGZdq{}}\PYG{p}{)}
+\end{Verbatim}
\subsection{HELLO example}
-\label{\detokenize{write_command:hello-example}}
-Here is a \sphinxstyleemphasis{hello} command, file \sphinxstyleemphasis{commands/hello.py}:
+\label{write_command:hello-example}
+Here is a \emph{hello} command, file \emph{commands/hello.py}:
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{k+kn}{import} \PYG{n+nn}{src}
\PYG{l+s+sd}{\PYGZdq{}\PYGZdq{}\PYGZdq{}}
\PYG{n}{logger}\PYG{o}{.}\PYG{n}{write}\PYG{p}{(}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{HELLO! WORLD!}\PYG{l+s+se}{\PYGZbs{}n}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{)}
\PYG{k}{else}\PYG{p}{:}
\PYG{n}{logger}\PYG{o}{.}\PYG{n}{write}\PYG{p}{(}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{Bonjour tout le monde!}\PYG{l+s+se}{\PYGZbs{}n}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{)}
-\end{sphinxVerbatim}
+\end{Verbatim}
A first call of hello:
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{c+c1}{\PYGZsh{} Get the help of hello:}
./sat \PYGZhy{}\PYGZhy{}help hello
\PYG{c+c1}{\PYGZsh{} To get the log}
./sat log
-\end{sphinxVerbatim}
+\end{Verbatim}
\chapter{Code documentation}
-\label{\detokenize{index:code-documentation}}
+\label{index:code-documentation}
\section{src}
-\label{\detokenize{commands/apidoc/modules:src}}\label{\detokenize{commands/apidoc/modules::doc}}
+\label{commands/apidoc/modules:src}\label{commands/apidoc/modules::doc}
+
+\subsection{src package}
+\label{commands/apidoc/src::doc}\label{commands/apidoc/src:src-package}
-\subsection{src Package}
-\label{\detokenize{commands/apidoc/src::doc}}\label{\detokenize{commands/apidoc/src:src-package}}
+\subsubsection{Subpackages}
+\label{commands/apidoc/src:subpackages}
+
+\paragraph{src.colorama package}
+\label{commands/apidoc/src.colorama:src-colorama-package}\label{commands/apidoc/src.colorama::doc}
-\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\_\_)}
+\subparagraph{Submodules}
+\label{commands/apidoc/src.colorama:submodules}
+
+\subparagraph{src.colorama.ansi module}
+\label{commands/apidoc/src.colorama:module-src.colorama.ansi}\label{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: \url{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{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack}\pysigline{\sphinxstrong{class }\sphinxcode{src.colorama.ansi.}\sphinxbfcode{AnsiBack}}
+Bases: {\hyperref[commands/apidoc/src.colorama:src.colorama.ansi.AnsiCodes]{\sphinxcrossref{\sphinxcode{src.colorama.ansi.AnsiCodes}}}} (\autopageref*{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{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.BLACK}\pysigline{\sphinxbfcode{BLACK}\sphinxstrong{ = 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{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.BLUE}\pysigline{\sphinxbfcode{BLUE}\sphinxstrong{ = 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{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.CYAN}\pysigline{\sphinxbfcode{CYAN}\sphinxstrong{ = 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{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.GREEN}\pysigline{\sphinxbfcode{GREEN}\sphinxstrong{ = 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{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTBLACK_EX}\pysigline{\sphinxbfcode{LIGHTBLACK\_EX}\sphinxstrong{ = 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{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTBLUE_EX}\pysigline{\sphinxbfcode{LIGHTBLUE\_EX}\sphinxstrong{ = 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{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTCYAN_EX}\pysigline{\sphinxbfcode{LIGHTCYAN\_EX}\sphinxstrong{ = 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{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTGREEN_EX}\pysigline{\sphinxbfcode{LIGHTGREEN\_EX}\sphinxstrong{ = 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{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTMAGENTA_EX}\pysigline{\sphinxbfcode{LIGHTMAGENTA\_EX}\sphinxstrong{ = 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{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTRED_EX}\pysigline{\sphinxbfcode{LIGHTRED\_EX}\sphinxstrong{ = 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{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTWHITE_EX}\pysigline{\sphinxbfcode{LIGHTWHITE\_EX}\sphinxstrong{ = 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{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTYELLOW_EX}\pysigline{\sphinxbfcode{LIGHTYELLOW\_EX}\sphinxstrong{ = 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{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.MAGENTA}\pysigline{\sphinxbfcode{MAGENTA}\sphinxstrong{ = 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{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.RED}\pysigline{\sphinxbfcode{RED}\sphinxstrong{ = 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{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.RESET}\pysigline{\sphinxbfcode{RESET}\sphinxstrong{ = 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{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.WHITE}\pysigline{\sphinxbfcode{WHITE}\sphinxstrong{ = 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{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.YELLOW}\pysigline{\sphinxbfcode{YELLOW}\sphinxstrong{ = 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{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCodes}\pysigline{\sphinxstrong{class }\sphinxcode{src.colorama.ansi.}\sphinxbfcode{AnsiCodes}}
+Bases: \sphinxcode{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!
-
-\end{description}\end{quote}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor}\pysigline{\sphinxstrong{class }\sphinxcode{src.colorama.ansi.}\sphinxbfcode{AnsiCursor}}
+Bases: \sphinxcode{object}
+\index{BACK() (src.colorama.ansi.AnsiCursor method)}
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.BACK}\pysiglinewithargsret{\sphinxbfcode{BACK}}{\emph{n=1}}{}
\end{fulllineitems}
-\index{check\_config\_has\_application() (in module src.\_\_init\_\_)}
+\index{DOWN() (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.
-
-\end{description}\end{quote}
-
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.DOWN}\pysiglinewithargsret{\sphinxbfcode{DOWN}}{\emph{n=1}}{}
\end{fulllineitems}
-\index{check\_config\_has\_profile() (in module src.\_\_init\_\_)}
+\index{FORWARD() (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.
-
-\end{description}\end{quote}
-
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.FORWARD}\pysiglinewithargsret{\sphinxbfcode{FORWARD}}{\emph{n=1}}{}
\end{fulllineitems}
-\index{config\_has\_application() (in module src.\_\_init\_\_)}
+\index{POS() (src.colorama.ansi.AnsiCursor method)}
\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{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.POS}\pysiglinewithargsret{\sphinxbfcode{POS}}{\emph{x=1}, \emph{y=1}}{}
\end{fulllineitems}
-\index{deepcopy\_list() (in module src.\_\_init\_\_)}
+\index{UP() (src.colorama.ansi.AnsiCursor method)}
\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
-
-\item[{Returns}] \leavevmode
-The copy of the list
-
-\item[{Return type}] \leavevmode
-List
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.UP}\pysiglinewithargsret{\sphinxbfcode{UP}}{\emph{n=1}}{}
+\end{fulllineitems}
-\end{description}\end{quote}
\end{fulllineitems}
-\index{ensure\_path\_exists() (in module src.\_\_init\_\_)}
+\index{AnsiFore (class in src.colorama.ansi)}
\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.
-
-\end{description}\end{quote}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore}\pysigline{\sphinxstrong{class }\sphinxcode{src.colorama.ansi.}\sphinxbfcode{AnsiFore}}
+Bases: {\hyperref[commands/apidoc/src.colorama:src.colorama.ansi.AnsiCodes]{\sphinxcrossref{\sphinxcode{src.colorama.ansi.AnsiCodes}}}} (\autopageref*{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCodes})
+\index{BLACK (src.colorama.ansi.AnsiFore attribute)}
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.BLACK}\pysigline{\sphinxbfcode{BLACK}\sphinxstrong{ = 30}}
\end{fulllineitems}
-\index{find\_file\_in\_lpath() (in module src.\_\_init\_\_)}
+\index{BLUE (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.
-
-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}
-
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.BLUE}\pysigline{\sphinxbfcode{BLUE}\sphinxstrong{ = 34}}
\end{fulllineitems}
-\index{get\_base\_path() (in module src.\_\_init\_\_)}
+\index{CYAN (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.
-
-\item[{Returns}] \leavevmode
-The path of the products base.
-
-\item[{Return type}] \leavevmode
-str
-
-\end{description}\end{quote}
-
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.CYAN}\pysigline{\sphinxbfcode{CYAN}\sphinxstrong{ = 36}}
\end{fulllineitems}
-\index{get\_cfg\_param() (in module src.\_\_init\_\_)}
+\index{GREEN (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
-
-\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}
-
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.GREEN}\pysigline{\sphinxbfcode{GREEN}\sphinxstrong{ = 32}}
\end{fulllineitems}
-\index{get\_launcher\_name() (in module src.\_\_init\_\_)}
+\index{LIGHTBLACK\_EX (src.colorama.ansi.AnsiFore attribute)}
\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
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTBLACK_EX}\pysigline{\sphinxbfcode{LIGHTBLACK\_EX}\sphinxstrong{ = 90}}
+\end{fulllineitems}
-\end{description}\end{quote}
+\index{LIGHTBLUE\_EX (src.colorama.ansi.AnsiFore attribute)}
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTBLUE_EX}\pysigline{\sphinxbfcode{LIGHTBLUE\_EX}\sphinxstrong{ = 94}}
\end{fulllineitems}
-\index{get\_log\_path() (in module src.\_\_init\_\_)}
+\index{LIGHTCYAN\_EX (src.colorama.ansi.AnsiFore 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.
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTCYAN_EX}\pysigline{\sphinxbfcode{LIGHTCYAN\_EX}\sphinxstrong{ = 96}}
+\end{fulllineitems}
-\item[{Returns}] \leavevmode
-The path of the logs.
+\index{LIGHTGREEN\_EX (src.colorama.ansi.AnsiFore attribute)}
-\item[{Return type}] \leavevmode
-str
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTGREEN_EX}\pysigline{\sphinxbfcode{LIGHTGREEN\_EX}\sphinxstrong{ = 92}}
+\end{fulllineitems}
-\end{description}\end{quote}
+\index{LIGHTMAGENTA\_EX (src.colorama.ansi.AnsiFore attribute)}
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTMAGENTA_EX}\pysigline{\sphinxbfcode{LIGHTMAGENTA\_EX}\sphinxstrong{ = 95}}
\end{fulllineitems}
-\index{get\_property\_in\_product\_cfg() (in module src.\_\_init\_\_)}
+\index{LIGHTRED\_EX (src.colorama.ansi.AnsiFore 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{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTRED_EX}\pysigline{\sphinxbfcode{LIGHTRED\_EX}\sphinxstrong{ = 91}}
\end{fulllineitems}
-\index{get\_salome\_version() (in module src.\_\_init\_\_)}
+\index{LIGHTWHITE\_EX (src.colorama.ansi.AnsiFore 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{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTWHITE_EX}\pysigline{\sphinxbfcode{LIGHTWHITE\_EX}\sphinxstrong{ = 97}}
\end{fulllineitems}
-\index{get\_tmp\_filename() (in module src.\_\_init\_\_)}
+\index{LIGHTYELLOW\_EX (src.colorama.ansi.AnsiFore attribute)}
\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}}{}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTYELLOW_EX}\pysigline{\sphinxbfcode{LIGHTYELLOW\_EX}\sphinxstrong{ = 93}}
\end{fulllineitems}
-\index{handleRemoveReadonly() (in module src.\_\_init\_\_)}
+\index{MAGENTA (src.colorama.ansi.AnsiFore attribute)}
\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{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.MAGENTA}\pysigline{\sphinxbfcode{MAGENTA}\sphinxstrong{ = 35}}
\end{fulllineitems}
-\index{merge\_dicts() (in module src.\_\_init\_\_)}
+\index{RED (src.colorama.ansi.AnsiFore attribute)}
\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{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.RED}\pysigline{\sphinxbfcode{RED}\sphinxstrong{ = 31}}
\end{fulllineitems}
-\index{only\_numbers() (in module src.\_\_init\_\_)}
+\index{RESET (src.colorama.ansi.AnsiFore attribute)}
\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{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.RESET}\pysigline{\sphinxbfcode{RESET}\sphinxstrong{ = 39}}
\end{fulllineitems}
-\index{parse\_date() (in module src.\_\_init\_\_)}
+\index{WHITE (src.colorama.ansi.AnsiFore attribute)}
\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
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.WHITE}\pysigline{\sphinxbfcode{WHITE}\sphinxstrong{ = 37}}
+\end{fulllineitems}
-\item[{Returns}] \leavevmode
-The date in the new format
+\index{YELLOW (src.colorama.ansi.AnsiFore attribute)}
-\item[{Return type}] \leavevmode
-str
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.YELLOW}\pysigline{\sphinxbfcode{YELLOW}\sphinxstrong{ = 33}}
+\end{fulllineitems}
-\end{description}\end{quote}
\end{fulllineitems}
-\index{print\_info() (in module src.\_\_init\_\_)}
+\index{AnsiStyle (class in src.colorama.ansi)}
\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
-
-\end{itemize}
-
-\end{description}\end{quote}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle}\pysigline{\sphinxstrong{class }\sphinxcode{src.colorama.ansi.}\sphinxbfcode{AnsiStyle}}
+Bases: {\hyperref[commands/apidoc/src.colorama:src.colorama.ansi.AnsiCodes]{\sphinxcrossref{\sphinxcode{src.colorama.ansi.AnsiCodes}}}} (\autopageref*{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCodes})
+\index{BRIGHT (src.colorama.ansi.AnsiStyle attribute)}
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle.BRIGHT}\pysigline{\sphinxbfcode{BRIGHT}\sphinxstrong{ = 1}}
\end{fulllineitems}
-\index{read\_config\_from\_a\_file() (in module src.\_\_init\_\_)}
+\index{DIM (src.colorama.ansi.AnsiStyle 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{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle.DIM}\pysigline{\sphinxbfcode{DIM}\sphinxstrong{ = 2}}
\end{fulllineitems}
-\index{remove\_item\_from\_list() (in module src.\_\_init\_\_)}
+\index{NORMAL (src.colorama.ansi.AnsiStyle attribute)}
\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
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle.NORMAL}\pysigline{\sphinxbfcode{NORMAL}\sphinxstrong{ = 22}}
+\end{fulllineitems}
-\item[{Returns}] \leavevmode
-The without any item
+\index{RESET\_ALL (src.colorama.ansi.AnsiStyle attribute)}
-\item[{Return type}] \leavevmode
-List
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle.RESET_ALL}\pysigline{\sphinxbfcode{RESET\_ALL}\sphinxstrong{ = 0}}
+\end{fulllineitems}
-\end{description}\end{quote}
\end{fulllineitems}
-\index{replace\_in\_file() (in module src.\_\_init\_\_)}
+\index{clear\_line() (in module src.colorama.ansi)}
\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{commands/apidoc/src.colorama:src.colorama.ansi.clear_line}\pysiglinewithargsret{\sphinxcode{src.colorama.ansi.}\sphinxbfcode{clear\_line}}{\emph{mode=2}}{}
\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{clear\_screen() (in module src.colorama.ansi)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.Comment}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{Comment}}}{\emph{text=None}}{}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.clear_screen}\pysiglinewithargsret{\sphinxcode{src.colorama.ansi.}\sphinxbfcode{clear\_screen}}{\emph{mode=2}}{}
\end{fulllineitems}
-\index{dump() (in module src.ElementTree)}
+\index{code\_to\_chars() (in module src.colorama.ansi)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.dump}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{dump}}}{\emph{elem}}{}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.code_to_chars}\pysiglinewithargsret{\sphinxcode{src.colorama.ansi.}\sphinxbfcode{code\_to\_chars}}{\emph{code}}{}
\end{fulllineitems}
-\index{Element() (in module src.ElementTree)}
+\index{set\_title() (in module src.colorama.ansi)}
\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{commands/apidoc/src.colorama:src.colorama.ansi.set_title}\pysiglinewithargsret{\sphinxcode{src.colorama.ansi.}\sphinxbfcode{set\_title}}{\emph{title}}{}
\end{fulllineitems}
-\index{ElementTree (class in src.ElementTree)}
-\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)}
+
+\subparagraph{src.colorama.ansitowin32 module}
+\label{commands/apidoc/src.colorama:module-src.colorama.ansitowin32}\label{commands/apidoc/src.colorama:src-colorama-ansitowin32-module}\index{src.colorama.ansitowin32 (module)}\index{AnsiToWin32 (class in src.colorama.ansitowin32)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.ElementTree.find}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{find}}}{\emph{path}}{}
-\end{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32}\pysiglinewithargsret{\sphinxstrong{class }\sphinxcode{src.colorama.ansitowin32.}\sphinxbfcode{AnsiToWin32}}{\emph{wrapped}, \emph{convert=None}, \emph{strip=None}, \emph{autoreset=False}}{}
+Bases: \sphinxcode{object}
-\index{findall() (src.ElementTree.ElementTree method)}
+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:src.ElementTree.ElementTree.findall}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{findall}}}{\emph{path}}{}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.ANSI_CSI_RE}\pysigline{\sphinxbfcode{ANSI\_CSI\_RE}\sphinxstrong{ = \textless{}\_sre.SRE\_Pattern object\textgreater{}}}
\end{fulllineitems}
-\index{findtext() (src.ElementTree.ElementTree method)}
+\index{ANSI\_OSC\_RE (src.colorama.ansitowin32.AnsiToWin32 attribute)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.ElementTree.findtext}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{findtext}}}{\emph{path}, \emph{default=None}}{}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.ANSI_OSC_RE}\pysigline{\sphinxbfcode{ANSI\_OSC\_RE}\sphinxstrong{ = \textless{}\_sre.SRE\_Pattern object\textgreater{}}}
\end{fulllineitems}
-\index{getiterator() (src.ElementTree.ElementTree method)}
+\index{call\_win32() (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{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.call_win32}\pysiglinewithargsret{\sphinxbfcode{call\_win32}}{\emph{command}, \emph{params}}{}
\end{fulllineitems}
-\index{getroot() (src.ElementTree.ElementTree method)}
+\index{convert\_ansi() (src.colorama.ansitowin32.AnsiToWin32 method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.ElementTree.getroot}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getroot}}}{}{}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.convert_ansi}\pysiglinewithargsret{\sphinxbfcode{convert\_ansi}}{\emph{paramstring}, \emph{command}}{}
\end{fulllineitems}
-\index{parse() (src.ElementTree.ElementTree method)}
+\index{convert\_osc() (src.colorama.ansitowin32.AnsiToWin32 method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.ElementTree.parse}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parse}}}{\emph{source}, \emph{parser=None}}{}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.convert_osc}\pysiglinewithargsret{\sphinxbfcode{convert\_osc}}{\emph{text}}{}
\end{fulllineitems}
-\index{write() (src.ElementTree.ElementTree method)}
+\index{extract\_params() (src.colorama.ansitowin32.AnsiToWin32 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{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.extract_params}\pysiglinewithargsret{\sphinxbfcode{extract\_params}}{\emph{command}, \emph{paramstring}}{}
\end{fulllineitems}
-
-\end{fulllineitems}
-
-\index{fromstring() (in module src.ElementTree)}
+\index{get\_win32\_calls() (src.colorama.ansitowin32.AnsiToWin32 method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.fromstring}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{fromstring}}}{\emph{text}}{}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.get_win32_calls}\pysiglinewithargsret{\sphinxbfcode{get\_win32\_calls}}{}{}
\end{fulllineitems}
-\index{iselement() (in module src.ElementTree)}
+\index{reset\_all() (src.colorama.ansitowin32.AnsiToWin32 method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.iselement}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{iselement}}}{\emph{element}}{}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.reset_all}\pysiglinewithargsret{\sphinxbfcode{reset\_all}}{}{}
\end{fulllineitems}
-\index{iterparse (class in src.ElementTree)}
+\index{should\_wrap() (src.colorama.ansitowin32.AnsiToWin32 method)}
\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)}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.should_wrap}\pysiglinewithargsret{\sphinxbfcode{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.iterparse.next}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{next}}}{}{}
\end{fulllineitems}
+\index{write() (src.colorama.ansitowin32.AnsiToWin32 method)}
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.write}\pysiglinewithargsret{\sphinxbfcode{write}}{\emph{text}}{}
\end{fulllineitems}
-\index{parse() (in module src.ElementTree)}
+\index{write\_and\_convert() (src.colorama.ansitowin32.AnsiToWin32 method)}
\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{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.write_and_convert}\pysiglinewithargsret{\sphinxbfcode{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{PI() (in module src.ElementTree)}
+\index{write\_plain\_text() (src.colorama.ansitowin32.AnsiToWin32 method)}
\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{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.write_plain_text}\pysiglinewithargsret{\sphinxbfcode{write\_plain\_text}}{\emph{text}, \emph{start}, \emph{end}}{}
\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{QName (class in src.ElementTree)}
+\index{StreamWrapper (class in src.colorama.ansitowin32)}
\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}}{}
-\end{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansitowin32.StreamWrapper}\pysiglinewithargsret{\sphinxstrong{class }\sphinxcode{src.colorama.ansitowin32.}\sphinxbfcode{StreamWrapper}}{\emph{wrapped}, \emph{converter}}{}
+Bases: \sphinxcode{object}
-\index{SubElement() (in module src.ElementTree)}
+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.SubElement}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{SubElement}}}{\emph{parent}, \emph{tag}, \emph{attrib=\{\}}, \emph{**extra}}{}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansitowin32.StreamWrapper.write}\pysiglinewithargsret{\sphinxbfcode{write}}{\emph{text}}{}
\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}
-\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)}
+\index{is\_a\_tty() (in module src.colorama.ansitowin32)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.TreeBuilder.close}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{close}}}{}{}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansitowin32.is_a_tty}\pysiglinewithargsret{\sphinxcode{src.colorama.ansitowin32.}\sphinxbfcode{is\_a\_tty}}{\emph{stream}}{}
\end{fulllineitems}
-\index{data() (src.ElementTree.TreeBuilder method)}
+\index{is\_stream\_closed() (in module src.colorama.ansitowin32)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.TreeBuilder.data}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{data}}}{\emph{data}}{}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansitowin32.is_stream_closed}\pysiglinewithargsret{\sphinxcode{src.colorama.ansitowin32.}\sphinxbfcode{is\_stream\_closed}}{\emph{stream}}{}
\end{fulllineitems}
-\index{end() (src.ElementTree.TreeBuilder method)}
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.TreeBuilder.end}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{end}}}{\emph{tag}}{}
-\end{fulllineitems}
-\index{start() (src.ElementTree.TreeBuilder method)}
+\subparagraph{src.colorama.initialise module}
+\label{commands/apidoc/src.colorama:src-colorama-initialise-module}\label{commands/apidoc/src.colorama:module-src.colorama.initialise}\index{src.colorama.initialise (module)}\index{colorama\_text() (in module src.colorama.initialise)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.TreeBuilder.start}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{start}}}{\emph{tag}, \emph{attrs}}{}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.initialise.colorama_text}\pysiglinewithargsret{\sphinxcode{src.colorama.initialise.}\sphinxbfcode{colorama\_text}}{\emph{*args}, \emph{**kwds}}{}
\end{fulllineitems}
+\index{deinit() (in module src.colorama.initialise)}
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.initialise.deinit}\pysiglinewithargsret{\sphinxcode{src.colorama.initialise.}\sphinxbfcode{deinit}}{}{}
\end{fulllineitems}
-\index{XML() (in module src.ElementTree)}
+\index{init() (in module src.colorama.initialise)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.XML}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{XML}}}{\emph{text}}{}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.initialise.init}\pysiglinewithargsret{\sphinxcode{src.colorama.initialise.}\sphinxbfcode{init}}{\emph{autoreset=False}, \emph{convert=None}, \emph{strip=None}, \emph{wrap=True}}{}
\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{reinit() (in module src.colorama.initialise)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.XMLTreeBuilder.close}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{close}}}{}{}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.initialise.reinit}\pysiglinewithargsret{\sphinxcode{src.colorama.initialise.}\sphinxbfcode{reinit}}{}{}
\end{fulllineitems}
-\index{doctype() (src.ElementTree.XMLTreeBuilder method)}
+\index{reset\_all() (in module src.colorama.initialise)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.XMLTreeBuilder.doctype}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{doctype}}}{\emph{name}, \emph{pubid}, \emph{system}}{}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.initialise.reset_all}\pysiglinewithargsret{\sphinxcode{src.colorama.initialise.}\sphinxbfcode{reset\_all}}{}{}
\end{fulllineitems}
-\index{feed() (src.ElementTree.XMLTreeBuilder method)}
+\index{wrap\_stream() (in module src.colorama.initialise)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.XMLTreeBuilder.feed}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{feed}}}{\emph{data}}{}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.initialise.wrap_stream}\pysiglinewithargsret{\sphinxcode{src.colorama.initialise.}\sphinxbfcode{wrap\_stream}}{\emph{stream}, \emph{convert}, \emph{strip}, \emph{autoreset}, \emph{wrap}}{}
\end{fulllineitems}
-\end{fulllineitems}
+\subparagraph{src.colorama.win32 module}
+\label{commands/apidoc/src.colorama:src-colorama-win32-module}\label{commands/apidoc/src.colorama:module-src.colorama.win32}\index{src.colorama.win32 (module)}\index{SetConsoleTextAttribute() (in module src.colorama.win32)}
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.win32.SetConsoleTextAttribute}\pysiglinewithargsret{\sphinxcode{src.colorama.win32.}\sphinxbfcode{SetConsoleTextAttribute}}{\emph{*\_}}{}
+\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{winapi\_test() (in module src.colorama.win32)}
\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.
-
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{L\{Mapping\}}} (\sphinxstyleliteralemphasis{\sphinxupquote{codes}}) \textendash{} The map containing distribution correlation table.
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.win32.winapi_test}\pysiglinewithargsret{\sphinxcode{src.colorama.win32.}\sphinxbfcode{winapi\_test}}{\emph{*\_}}{}
+\end{fulllineitems}
-\end{itemize}
-\item[{Returns}] \leavevmode
-The version of the distribution on which salomeTools is running,
-regarding the distribution correlation table contained in codes
-variable.
-\item[{Return type}] \leavevmode
-str
+\subparagraph{src.colorama.winterm module}
+\label{commands/apidoc/src.colorama:module-src.colorama.winterm}\label{commands/apidoc/src.colorama:src-colorama-winterm-module}\index{src.colorama.winterm (module)}\index{WinColor (class in src.colorama.winterm)}
-\end{description}\end{quote}
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinColor}\pysigline{\sphinxstrong{class }\sphinxcode{src.colorama.winterm.}\sphinxbfcode{WinColor}}
+Bases: \sphinxcode{object}
+\index{BLACK (src.colorama.winterm.WinColor attribute)}
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.BLACK}\pysigline{\sphinxbfcode{BLACK}\sphinxstrong{ = 0}}
\end{fulllineitems}
-\index{get\_distribution() (in module src.architecture)}
+\index{BLUE (src.colorama.winterm.WinColor attribute)}
\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.
-
-\item[{Returns}] \leavevmode
-The distribution on which salomeTools is running, regarding the
-distribution correlation table contained in codes variable.
-
-\item[{Return type}] \leavevmode
-str
-
-\end{description}\end{quote}
-
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.BLUE}\pysigline{\sphinxbfcode{BLUE}\sphinxstrong{ = 1}}
\end{fulllineitems}
-\index{get\_nb\_proc() (in module src.architecture)}
+\index{CYAN (src.colorama.winterm.WinColor attribute)}
\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.
-
-\end{description}
-\begin{quote}\begin{description}
-\item[{Returns}] \leavevmode
-the number of processors.
-
-\item[{Return type}] \leavevmode
-str
-
-\end{description}\end{quote}
-
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.CYAN}\pysigline{\sphinxbfcode{CYAN}\sphinxstrong{ = 3}}
\end{fulllineitems}
-\index{get\_python\_version() (in module src.architecture)}
+\index{GREEN (src.colorama.winterm.WinColor attribute)}
\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.
-
-\item[{Return type}] \leavevmode
-str
-
-\end{description}\end{quote}
-
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.GREEN}\pysigline{\sphinxbfcode{GREEN}\sphinxstrong{ = 2}}
\end{fulllineitems}
-\index{get\_user() (in module src.architecture)}
+\index{GREY (src.colorama.winterm.WinColor attribute)}
\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{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.GREY}\pysigline{\sphinxbfcode{GREY}\sphinxstrong{ = 7}}
+\end{fulllineitems}
-\end{description}\end{quote}
+\index{MAGENTA (src.colorama.winterm.WinColor attribute)}
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.MAGENTA}\pysigline{\sphinxbfcode{MAGENTA}\sphinxstrong{ = 5}}
\end{fulllineitems}
-\index{is\_windows() (in module src.architecture)}
+\index{RED (src.colorama.winterm.WinColor attribute)}
\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{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.RED}\pysigline{\sphinxbfcode{RED}\sphinxstrong{ = 4}}
+\end{fulllineitems}
-\end{description}\end{quote}
+\index{YELLOW (src.colorama.winterm.WinColor attribute)}
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.YELLOW}\pysigline{\sphinxbfcode{YELLOW}\sphinxstrong{ = 6}}
\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)}
+\index{WinStyle (class in src.colorama.winterm)}
\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)}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinStyle}\pysigline{\sphinxstrong{class }\sphinxcode{src.colorama.winterm.}\sphinxbfcode{WinStyle}}
+Bases: \sphinxcode{object}
+\index{BRIGHT (src.colorama.winterm.WinStyle attribute)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.build_configure}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{build\_configure}}}{\emph{options=''}}{}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinStyle.BRIGHT}\pysigline{\sphinxbfcode{BRIGHT}\sphinxstrong{ = 8}}
\end{fulllineitems}
-\index{check() (src.compilation.Builder method)}
+\index{BRIGHT\_BACKGROUND (src.colorama.winterm.WinStyle attribute)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.check}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{check}}}{\emph{command=''}}{}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinStyle.BRIGHT_BACKGROUND}\pysigline{\sphinxbfcode{BRIGHT\_BACKGROUND}\sphinxstrong{ = 128}}
\end{fulllineitems}
-\index{cmake() (src.compilation.Builder method)}
+\index{NORMAL (src.colorama.winterm.WinStyle attribute)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.cmake}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{cmake}}}{\emph{options=''}}{}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinStyle.NORMAL}\pysigline{\sphinxbfcode{NORMAL}\sphinxstrong{ = 0}}
\end{fulllineitems}
-\index{complete\_environment() (src.compilation.Builder method)}
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.complete_environment}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{complete\_environment}}}{\emph{make\_options}}{}
\end{fulllineitems}
-\index{configure() (src.compilation.Builder method)}
+\index{WinTerm (class in src.colorama.winterm)}
\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)}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm}\pysigline{\sphinxstrong{class }\sphinxcode{src.colorama.winterm.}\sphinxbfcode{WinTerm}}
+Bases: \sphinxcode{object}
+\index{back() (src.colorama.winterm.WinTerm 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{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.back}\pysiglinewithargsret{\sphinxbfcode{back}}{\emph{back=None}, \emph{light=False}, \emph{on\_stderr=False}}{}
\end{fulllineitems}
-\index{do\_default\_build() (src.compilation.Builder method)}
+\index{cursor\_adjust() (src.colorama.winterm.WinTerm 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{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.cursor_adjust}\pysiglinewithargsret{\sphinxbfcode{cursor\_adjust}}{\emph{x}, \emph{y}, \emph{on\_stderr=False}}{}
\end{fulllineitems}
-\index{do\_python\_script\_build() (src.compilation.Builder method)}
+\index{erase\_line() (src.colorama.winterm.WinTerm 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{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.erase_line}\pysiglinewithargsret{\sphinxbfcode{erase\_line}}{\emph{mode=0}, \emph{on\_stderr=False}}{}
\end{fulllineitems}
-\index{do\_script\_build() (src.compilation.Builder method)}
+\index{erase\_screen() (src.colorama.winterm.WinTerm 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{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.erase_screen}\pysiglinewithargsret{\sphinxbfcode{erase\_screen}}{\emph{mode=0}, \emph{on\_stderr=False}}{}
\end{fulllineitems}
-\index{hack\_libtool() (src.compilation.Builder method)}
+\index{fore() (src.colorama.winterm.WinTerm method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.hack_libtool}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{hack\_libtool}}}{}{}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.fore}\pysiglinewithargsret{\sphinxbfcode{fore}}{\emph{fore=None}, \emph{light=False}, \emph{on\_stderr=False}}{}
\end{fulllineitems}
-\index{install() (src.compilation.Builder method)}
+\index{get\_attrs() (src.colorama.winterm.WinTerm method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.install}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{install}}}{}{}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.get_attrs}\pysiglinewithargsret{\sphinxbfcode{get\_attrs}}{}{}
\end{fulllineitems}
-\index{log() (src.compilation.Builder method)}
+\index{get\_position() (src.colorama.winterm.WinTerm method)}
\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{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.get_position}\pysiglinewithargsret{\sphinxbfcode{get\_position}}{\emph{handle}}{}
\end{fulllineitems}
-\index{log\_command() (src.compilation.Builder method)}
+\index{reset\_all() (src.colorama.winterm.WinTerm method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.log_command}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{log\_command}}}{\emph{command}}{}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.reset_all}\pysiglinewithargsret{\sphinxbfcode{reset\_all}}{\emph{on\_stderr=None}}{}
\end{fulllineitems}
-\index{make() (src.compilation.Builder method)}
+\index{set\_attrs() (src.colorama.winterm.WinTerm method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.make}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{make}}}{\emph{nb\_proc}, \emph{make\_opt=''}}{}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.set_attrs}\pysiglinewithargsret{\sphinxbfcode{set\_attrs}}{\emph{value}}{}
\end{fulllineitems}
-\index{prepare() (src.compilation.Builder method)}
+\index{set\_console() (src.colorama.winterm.WinTerm method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.prepare}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepare}}}{}{}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.set_console}\pysiglinewithargsret{\sphinxbfcode{set\_console}}{\emph{attrs=None}, \emph{on\_stderr=False}}{}
\end{fulllineitems}
-\index{put\_txt\_log\_in\_appli\_log\_dir() (src.compilation.Builder method)}
+\index{set\_cursor\_position() (src.colorama.winterm.WinTerm method)}
\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{}/
-
-\end{description}
-\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{Str}} (\sphinxstyleliteralemphasis{\sphinxupquote{file\_name}}) \textendash{} the name of the file to write
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.set_cursor_position}\pysiglinewithargsret{\sphinxbfcode{set\_cursor\_position}}{\emph{position=None}, \emph{on\_stderr=False}}{}
+\end{fulllineitems}
-\end{description}\end{quote}
+\index{set\_title() (src.colorama.winterm.WinTerm method)}
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.set_title}\pysiglinewithargsret{\sphinxbfcode{set\_title}}{\emph{title}}{}
\end{fulllineitems}
-\index{wmake() (src.compilation.Builder method)}
+\index{style() (src.colorama.winterm.WinTerm method)}
\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{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.style}\pysiglinewithargsret{\sphinxbfcode{style}}{\emph{style=None}, \emph{on\_stderr=False}}{}
\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
+\subparagraph{Module contents}
+\label{commands/apidoc/src.colorama:module-src.colorama}\label{commands/apidoc/src.colorama:module-contents}\index{src.colorama (module)}
-\item {}
-show pretty print debug representation from instances of SAT classes
-(pretty print src.pyconf.Config), and python dict/list etc. (as ‘aVariable’)
+\paragraph{src.example package}
+\label{commands/apidoc/src.example:src-example-package}\label{commands/apidoc/src.example::doc}
-\end{itemize}
+\subparagraph{Submodules}
+\label{commands/apidoc/src.example:submodules}
-WARNING: obviously supposedly show messages in SAT development phase, not production
+\subparagraph{src.example.essai\_logging\_1 module}
+\label{commands/apidoc/src.example:module-src.example.essai_logging_1}\label{commands/apidoc/src.example:src-example-essai-logging-1-module}\index{src.example.essai\_logging\_1 (module)}
+\url{http://sametmax.com/ecrire-des-logs-en-python/}
+\url{https://docs.python.org/3/library/time.html\#time.strftime}
-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)
+essai utilisation logger plusieurs handler format different
+\begin{quote}
-to set show message as development phase:
-\textgreater{}\textgreater{} DBG.push\_debug(True)
+/usr/lib/python2.7/logging/\_\_init\_\_.pyc
-to set no show message as production phase:
-\textgreater{}\textgreater{} DBG.push\_debug(False)
+init MyLogger, fmt='\%(asctime)s :: \%(levelname)-8s :: \%(message)s', level=`20'
-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
+2018-03-11 18:51:21 :: INFO :: test logger info
+2018-03-11 18:51:21 :: WARNING :: test logger warning
+2018-03-11 18:51:21 :: ERROR :: test logger error
+2018-03-11 18:51:21 :: CRITICAL :: test logger critical
-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
+init MyLogger, fmt='None', level=`10'
-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)}
+2018-03-11 18:51:21 :: DEBUG :: test logger debug
+test logger debug
+2018-03-11 18:51:21 :: INFO :: test logger info
+test logger info
+2018-03-11 18:51:21 :: WARNING :: test logger warning
+test logger warning
+2018-03-11 18:51:21 :: ERROR :: test logger error
+test logger error
+2018-03-11 18:51:21 :: CRITICAL :: test logger critical
+test logger critical
+\end{quote}
+\index{getMyLogger() (in module src.example.essai\_logging\_1)}
\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}}
+\phantomsection\label{commands/apidoc/src.example:src.example.essai_logging_1.getMyLogger}\pysiglinewithargsret{\sphinxcode{src.example.essai\_logging\_1.}\sphinxbfcode{getMyLogger}}{}{}
+\end{fulllineitems}
-utility class for pyconf.Config input iostream
+\index{initMyLogger() (in module src.example.essai\_logging\_1)}
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.example:src.example.essai_logging_1.initMyLogger}\pysiglinewithargsret{\sphinxcode{src.example.essai\_logging\_1.}\sphinxbfcode{initMyLogger}}{\emph{fmt=None}, \emph{level=None}}{}
\end{fulllineitems}
-\index{OutStream (class in src.debug)}
+\index{testLogger1() (in module src.example.essai\_logging\_1)}
\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}}
+\phantomsection\label{commands/apidoc/src.example:src.example.essai_logging_1.testLogger1}\pysiglinewithargsret{\sphinxcode{src.example.essai\_logging\_1.}\sphinxbfcode{testLogger1}}{}{}
+\end{fulllineitems}
-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}
+\subparagraph{src.example.essai\_logging\_2 module}
+\label{commands/apidoc/src.example:module-src.example.essai_logging_2}\label{commands/apidoc/src.example:src-example-essai-logging-2-module}\index{src.example.essai\_logging\_2 (module)}
+\url{http://sametmax.com/ecrire-des-logs-en-python/}
+\url{https://docs.python.org/3/library/time.html\#time.strftime}
+essai utilisation logger un handler format different
+sur info() pas de format et su other format
+\begin{quote}
-\end{fulllineitems}
+/usr/lib/python2.7/logging/\_\_init\_\_.pyc
-\index{getLocalEnv() (in module src.debug)}
+init MyLogger, fmt='\%(asctime)s :: \%(levelname)-8s :: \%(message)s', level=`20'
+
+test logger info
+2018-03-11 18:51:51 :: WARNING :: test logger warning
+2018-03-11 18:51:51 :: ERROR :: test logger error
+2018-03-11 18:51:51 :: CRITICAL :: test logger critical
+\end{quote}
+\index{MyFormatter (class in src.example.essai\_logging\_2)}
\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{commands/apidoc/src.example:src.example.essai_logging_2.MyFormatter}\pysiglinewithargsret{\sphinxstrong{class }\sphinxcode{src.example.essai\_logging\_2.}\sphinxbfcode{MyFormatter}}{\emph{fmt=None}, \emph{datefmt=None}}{}
+Bases: \sphinxcode{logging.Formatter}
+\index{format() (src.example.essai\_logging\_2.MyFormatter method)}
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src.example:src.example.essai_logging_2.MyFormatter.format}\pysiglinewithargsret{\sphinxbfcode{format}}{\emph{record}}{}
\end{fulllineitems}
-\index{getStrConfigDbg() (in module src.debug)}
-
-\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)}
+\index{getMyLogger() (in module src.example.essai\_logging\_2)}
\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{commands/apidoc/src.example:src.example.essai_logging_2.getMyLogger}\pysiglinewithargsret{\sphinxcode{src.example.essai\_logging\_2.}\sphinxbfcode{getMyLogger}}{}{}
\end{fulllineitems}
-\index{indent() (in module src.debug)}
+\index{initMyLogger() (in module src.example.essai\_logging\_2)}
\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{commands/apidoc/src.example:src.example.essai_logging_2.initMyLogger}\pysiglinewithargsret{\sphinxcode{src.example.essai\_logging\_2.}\sphinxbfcode{initMyLogger}}{\emph{fmt=None}, \emph{level=None}}{}
\end{fulllineitems}
-\index{pop\_debug() (in module src.debug)}
+\index{testLogger1() (in module src.example.essai\_logging\_2)}
\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{commands/apidoc/src.example:src.example.essai_logging_2.testLogger1}\pysiglinewithargsret{\sphinxcode{src.example.essai\_logging\_2.}\sphinxbfcode{testLogger1}}{}{}
\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}
+\subparagraph{Module contents}
+\label{commands/apidoc/src.example:module-contents}\label{commands/apidoc/src.example:module-src.example}\index{src.example (module)}
-\index{saveConfigDbg() (in module src.debug)}
+\subsubsection{Submodules}
+\label{commands/apidoc/src:submodules}
-\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
+\subsubsection{src.ElementTree module}
+\label{commands/apidoc/src:src-elementtree-module}\label{commands/apidoc/src:module-src.ElementTree}\index{src.ElementTree (module)}\index{Comment() (in module src.ElementTree)}
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.ElementTree.Comment}\pysiglinewithargsret{\sphinxcode{src.ElementTree.}\sphinxbfcode{Comment}}{\emph{text=None}}{}
\end{fulllineitems}
-\index{saveConfigStd() (in module src.debug)}
+\index{dump() (in module src.ElementTree)}
\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
-
+\phantomsection\label{commands/apidoc/src:src.ElementTree.dump}\pysiglinewithargsret{\sphinxcode{src.ElementTree.}\sphinxbfcode{dump}}{\emph{elem}}{}
\end{fulllineitems}
-\index{tofix() (in module src.debug)}
+\index{Element() (in module src.ElementTree)}
\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)
-
+\phantomsection\label{commands/apidoc/src:src.ElementTree.Element}\pysiglinewithargsret{\sphinxcode{src.ElementTree.}\sphinxbfcode{Element}}{\emph{tag}, \emph{attrib=\{\}}, \emph{**extra}}{}
\end{fulllineitems}
-\index{write() (in module src.debug)}
+\index{ElementTree (class in src.ElementTree)}
\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
+\phantomsection\label{commands/apidoc/src:src.ElementTree.ElementTree}\pysiglinewithargsret{\sphinxstrong{class }\sphinxcode{src.ElementTree.}\sphinxbfcode{ElementTree}}{\emph{element=None}, \emph{file=None}}{}~\index{find() (src.ElementTree.ElementTree method)}
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.ElementTree.ElementTree.find}\pysiglinewithargsret{\sphinxbfcode{find}}{\emph{path}}{}
\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)}
+\index{findall() (src.ElementTree.ElementTree method)}
\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)}
+\phantomsection\label{commands/apidoc/src:src.ElementTree.ElementTree.findall}\pysiglinewithargsret{\sphinxbfcode{findall}}{\emph{path}}{}
+\end{fulllineitems}
-\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{sep}}) \textendash{} the environment variable to append
+\index{findtext() (src.ElementTree.ElementTree method)}
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}}\sphinxstyleliteralstrong{\sphinxupquote{ or }}\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the value(s) to append to key
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.ElementTree.ElementTree.findtext}\pysiglinewithargsret{\sphinxbfcode{findtext}}{\emph{path}, \emph{default=None}}{}
+\end{fulllineitems}
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
+\index{getiterator() (src.ElementTree.ElementTree method)}
-\end{itemize}
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.ElementTree.ElementTree.getiterator}\pysiglinewithargsret{\sphinxbfcode{getiterator}}{\emph{tag=None}}{}
+\end{fulllineitems}
-\end{description}\end{quote}
+\index{getroot() (src.ElementTree.ElementTree method)}
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.ElementTree.ElementTree.getroot}\pysiglinewithargsret{\sphinxbfcode{getroot}}{}{}
\end{fulllineitems}
-\index{append\_value() (src.environment.Environ method)}
+\index{parse() (src.ElementTree.ElementTree method)}
\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{commands/apidoc/src:src.ElementTree.ElementTree.parse}\pysiglinewithargsret{\sphinxbfcode{parse}}{\emph{source}, \emph{parser=None}}{}
+\end{fulllineitems}
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
+\index{write() (src.ElementTree.ElementTree method)}
-\end{itemize}
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.ElementTree.ElementTree.write}\pysiglinewithargsret{\sphinxbfcode{write}}{\emph{file}, \emph{encoding='us-ascii'}}{}
+\end{fulllineitems}
-\end{description}\end{quote}
\end{fulllineitems}
-\index{command\_value() (src.environment.Environ method)}
+\index{fromstring() (in module src.ElementTree)}
\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
-\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
-
-\end{itemize}
+\phantomsection\label{commands/apidoc/src:src.ElementTree.fromstring}\pysiglinewithargsret{\sphinxcode{src.ElementTree.}\sphinxbfcode{fromstring}}{\emph{text}}{}
+\end{fulllineitems}
-\end{description}\end{quote}
+\index{iselement() (in module src.ElementTree)}
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.ElementTree.iselement}\pysiglinewithargsret{\sphinxcode{src.ElementTree.}\sphinxbfcode{iselement}}{\emph{element}}{}
\end{fulllineitems}
-\index{get() (src.environment.Environ method)}
+\index{iterparse (class in src.ElementTree)}
\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”
-\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable
+\phantomsection\label{commands/apidoc/src:src.ElementTree.iterparse}\pysiglinewithargsret{\sphinxstrong{class }\sphinxcode{src.ElementTree.}\sphinxbfcode{iterparse}}{\emph{source}, \emph{events=None}}{}~\index{next() (src.ElementTree.iterparse method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.ElementTree.iterparse.next}\pysiglinewithargsret{\sphinxbfcode{next}}{}{}
+\end{fulllineitems}
-\end{description}\end{quote}
\end{fulllineitems}
-\index{is\_defined() (src.environment.Environ method)}
+\index{parse() (in module src.ElementTree)}
\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
-\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable to check
+\phantomsection\label{commands/apidoc/src:src.ElementTree.parse}\pysiglinewithargsret{\sphinxcode{src.ElementTree.}\sphinxbfcode{parse}}{\emph{source}, \emph{parser=None}}{}
+\end{fulllineitems}
-\end{description}\end{quote}
+\index{PI() (in module src.ElementTree)}
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.ElementTree.PI}\pysiglinewithargsret{\sphinxcode{src.ElementTree.}\sphinxbfcode{PI}}{\emph{target}, \emph{text=None}}{}
\end{fulllineitems}
-\index{prepend() (src.environment.Environ method)}
+\index{ProcessingInstruction() (in module src.ElementTree)}
\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
+\phantomsection\label{commands/apidoc/src:src.ElementTree.ProcessingInstruction}\pysiglinewithargsret{\sphinxcode{src.ElementTree.}\sphinxbfcode{ProcessingInstruction}}{\emph{target}, \emph{text=None}}{}
+\end{fulllineitems}
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
+\index{QName (class in src.ElementTree)}
-\end{itemize}
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.ElementTree.QName}\pysiglinewithargsret{\sphinxstrong{class }\sphinxcode{src.ElementTree.}\sphinxbfcode{QName}}{\emph{text\_or\_uri}, \emph{tag=None}}{}
+\end{fulllineitems}
-\end{description}\end{quote}
+\index{SubElement() (in module src.ElementTree)}
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.ElementTree.SubElement}\pysiglinewithargsret{\sphinxcode{src.ElementTree.}\sphinxbfcode{SubElement}}{\emph{parent}, \emph{tag}, \emph{attrib=\{\}}, \emph{**extra}}{}
\end{fulllineitems}
-\index{prepend\_value() (src.environment.Environ method)}
+\index{tostring() (in module src.ElementTree)}
\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{commands/apidoc/src:src.ElementTree.tostring}\pysiglinewithargsret{\sphinxcode{src.ElementTree.}\sphinxbfcode{tostring}}{\emph{element}, \emph{encoding=None}}{}
+\end{fulllineitems}
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to prepend to key
+\index{TreeBuilder (class in src.ElementTree)}
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.ElementTree.TreeBuilder}\pysiglinewithargsret{\sphinxstrong{class }\sphinxcode{src.ElementTree.}\sphinxbfcode{TreeBuilder}}{\emph{element\_factory=None}}{}~\index{close() (src.ElementTree.TreeBuilder method)}
-\end{itemize}
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.ElementTree.TreeBuilder.close}\pysiglinewithargsret{\sphinxbfcode{close}}{}{}
+\end{fulllineitems}
-\end{description}\end{quote}
+\index{data() (src.ElementTree.TreeBuilder method)}
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.ElementTree.TreeBuilder.data}\pysiglinewithargsret{\sphinxbfcode{data}}{\emph{data}}{}
\end{fulllineitems}
-\index{set() (src.environment.Environ method)}
+\index{end() (src.ElementTree.TreeBuilder 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
+\phantomsection\label{commands/apidoc/src:src.ElementTree.TreeBuilder.end}\pysiglinewithargsret{\sphinxbfcode{end}}{\emph{tag}}{}
+\end{fulllineitems}
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value
+\index{start() (src.ElementTree.TreeBuilder method)}
-\end{itemize}
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.ElementTree.TreeBuilder.start}\pysiglinewithargsret{\sphinxbfcode{start}}{\emph{tag}, \emph{attrs}}{}
+\end{fulllineitems}
-\end{description}\end{quote}
\end{fulllineitems}
+\index{XML() (in module src.ElementTree)}
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.ElementTree.XML}\pysiglinewithargsret{\sphinxcode{src.ElementTree.}\sphinxbfcode{XML}}{\emph{text}}{}
\end{fulllineitems}
-\index{FileEnvWriter (class in src.environment)}
+\index{XMLTreeBuilder (class in src.ElementTree)}
\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)}
+\phantomsection\label{commands/apidoc/src:src.ElementTree.XMLTreeBuilder}\pysiglinewithargsret{\sphinxstrong{class }\sphinxcode{src.ElementTree.}\sphinxbfcode{XMLTreeBuilder}}{\emph{html=0}, \emph{target=None}}{}~\index{close() (src.ElementTree.XMLTreeBuilder 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
+\phantomsection\label{commands/apidoc/src:src.ElementTree.XMLTreeBuilder.close}\pysiglinewithargsret{\sphinxbfcode{close}}{}{}
+\end{fulllineitems}
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{dict}} (\sphinxstyleliteralemphasis{\sphinxupquote{additional\_env}}) \textendash{} a dictionary of additional variables
-to add to the environment
+\index{doctype() (src.ElementTree.XMLTreeBuilder method)}
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} If not None, produce a relative environment
-designed for a package.
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.ElementTree.XMLTreeBuilder.doctype}\pysiglinewithargsret{\sphinxbfcode{doctype}}{\emph{name}, \emph{pubid}, \emph{system}}{}
+\end{fulllineitems}
-\end{itemize}
+\index{feed() (src.ElementTree.XMLTreeBuilder method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.ElementTree.XMLTreeBuilder.feed}\pysiglinewithargsret{\sphinxbfcode{feed}}{\emph{data}}{}
+\end{fulllineitems}
-\end{description}\end{quote}
\end{fulllineitems}
-\index{write\_env\_file() (src.environment.FileEnvWriter method)}
+
+
+\subsubsection{src.architecture module}
+\label{commands/apidoc/src:module-src.architecture}\label{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.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.
+\phantomsection\label{commands/apidoc/src:src.architecture.get_distrib_version}\pysiglinewithargsret{\sphinxcode{src.architecture.}\sphinxbfcode{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{shell}}) \textendash{} the file path
-
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{bool}} (\sphinxstyleliteralemphasis{\sphinxupquote{forBuild}}) \textendash{} if true, the build environment
+\textbf{\texttt{str}} (\emph{\texttt{distrib}}) -- The distribution on which the version will be found.
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the type of file wanted (.sh, .bat)
+\textbf{\texttt{L\{Mapping\}}} (\emph{\texttt{codes}}) -- The map containing distribution correlation table.
\end{itemize}
\item[{Returns}] \leavevmode
-The path to the generated file
+The version of the distribution on which salomeTools is running,
+regarding the distribution correlation table contained in codes
+variable.
\item[{Return type}] \leavevmode
str
\end{fulllineitems}
-
-\end{fulllineitems}
-
-\index{SalomeEnviron (class in src.environment)}
-
-\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)}
+\index{get\_distribution() (in module src.architecture)}
\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)
+\phantomsection\label{commands/apidoc/src:src.architecture.get_distribution}\pysiglinewithargsret{\sphinxcode{src.architecture.}\sphinxbfcode{get\_distribution}}{\emph{codes}}{}
+Gets the code for the distribution
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{comment}}) \textendash{} the commentary to add
-
-\end{description}\end{quote}
+\textbf{\texttt{L\{Mapping\}}} (\emph{\texttt{codes}}) -- The map containing distribution correlation table.
-\end{fulllineitems}
-
-\index{add\_line() (src.environment.SalomeEnviron 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: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
-\sphinxstyleliteralstrong{\sphinxupquote{int}} (\sphinxstyleliteralemphasis{\sphinxupquote{nb\_line}}) \textendash{} the number of empty lines to add
+\item[{Return type}] \leavevmode
+str
\end{description}\end{quote}
\end{fulllineitems}
-\index{add\_warning() (src.environment.SalomeEnviron method)}
+\index{get\_nb\_proc() (in module src.architecture)}
\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)
+\phantomsection\label{commands/apidoc/src:src.architecture.get_nb_proc}\pysiglinewithargsret{\sphinxcode{src.architecture.}\sphinxbfcode{get\_nb\_proc}}{}{}~\begin{description}
+\item[{Gets the number of processors of the machine }] \leavevmode
+on which salomeTools is running.
+
+\end{description}
\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{warning}}) \textendash{} the warning to add
+\item[{Returns}] \leavevmode
+the number of processors.
+
+\item[{Return type}] \leavevmode
+str
\end{description}\end{quote}
\end{fulllineitems}
-\index{append() (src.environment.SalomeEnviron method)}
+\index{get\_python\_version() (in module src.architecture)}
\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
+\phantomsection\label{commands/apidoc/src:src.architecture.get_python_version}\pysiglinewithargsret{\sphinxcode{src.architecture.}\sphinxbfcode{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{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
+\item[{Returns}] \leavevmode
+the version of the running python.
-\end{itemize}
+\item[{Return type}] \leavevmode
+str
\end{description}\end{quote}
\end{fulllineitems}
-\index{dump() (src.environment.SalomeEnviron method)}
+\index{get\_user() (in module src.architecture)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.dump}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{dump}}}{\emph{out}}{}
-Write the environment to out
+\phantomsection\label{commands/apidoc/src:src.architecture.get_user}\pysiglinewithargsret{\sphinxcode{src.architecture.}\sphinxbfcode{get\_user}}{}{}
+method that gets the username that launched sat
\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{file}} (\sphinxstyleliteralemphasis{\sphinxupquote{out}}) \textendash{} the stream where to write the environment
+\item[{Return type}] \leavevmode
+str
\end{description}\end{quote}
\end{fulllineitems}
-\index{finish() (src.environment.SalomeEnviron method)}
+\index{is\_windows() (in module src.architecture)}
\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)
+\phantomsection\label{commands/apidoc/src:src.architecture.is_windows}\pysiglinewithargsret{\sphinxcode{src.architecture.}\sphinxbfcode{is\_windows}}{}{}
+method that checks windows OS
\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{bool}} (\sphinxstyleliteralemphasis{\sphinxupquote{required}}) \textendash{} Do nothing if required is False
+\item[{Return type}] \leavevmode
+boolean
\end{description}\end{quote}
\end{fulllineitems}
-\index{get() (src.environment.SalomeEnviron method)}
+
+
+\subsubsection{src.catchAll module}
+\label{commands/apidoc/src:module-src.catchAll}\label{commands/apidoc/src:src-catchall-module}\index{src.catchAll (module)}
+define class as a simple dictionary with keys
+with pretty print \_\_str\_\_ and \_\_repr\_\_ (indented as recursive)
+and jsonDumps()
+\begin{description}
+\item[{usage:}] \leavevmode
+\textgreater{}\textgreater{} import catchAll as CAA
+\textgreater{}\textgreater{} a = CAA.CatchAll()
+\textgreater{}\textgreater{} a.tintin = ``reporter''
+\textgreater{}\textgreater{} a.milou = ``dog''
+\textgreater{}\textgreater{} print(``a=\%s'' \% a)
+\textgreater{}\textgreater{} print(``tintin: \%s'' \% a.tintin)
+
+\end{description}
+\index{CatchAll (class in src.catchAll)}
\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{commands/apidoc/src:src.catchAll.CatchAll}\pysigline{\sphinxstrong{class }\sphinxcode{src.catchAll.}\sphinxbfcode{CatchAll}}
+Bases: \sphinxcode{object}
-\end{description}\end{quote}
+class as simple dynamic dictionary
+with predefined keys as properties in
+inherited classes through \_\_init\_\_ method. Or NOT.
+with pretty print \_\_str\_\_ and \_\_repr\_\_ (indented as recursive)
+with jsonDumps()
-\end{fulllineitems}
+usage:
-\index{get\_names() (src.environment.SalomeEnviron method)}
+\textgreater{}\textgreater{} import catchAll as CAA
+\textgreater{}\textgreater{} a = CAA.CatchAll()
+\textgreater{}\textgreater{} a.tintin = ``reporter''
+\textgreater{}\textgreater{} a.milou = ``dog''
+\textgreater{}\textgreater{} print(``a=\%s'' \% a)
+\textgreater{}\textgreater{} print(``tintin: \%s'' \% a.tintin)
+
+as
+
+\textgreater{}\textgreater{} a = \{\}
+\textgreater{}\textgreater{} a{[}''tintin''{]} = ``reporter''
+\textgreater{}\textgreater{} a{[}''milou''{]} = ``dog''
+\textgreater{}\textgreater{} print(``tintin: \%s'' \% a{[}''tintin''{]}
+\index{jsonDumps() (src.catchAll.CatchAll 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
+\phantomsection\label{commands/apidoc/src:src.catchAll.CatchAll.jsonDumps}\pysiglinewithargsret{\sphinxbfcode{jsonDumps}}{}{}
+\end{fulllineitems}
-\end{description}\end{quote}
\end{fulllineitems}
-\index{is\_defined() (src.environment.SalomeEnviron method)}
+\index{dumper() (in module src.catchAll)}
\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{commands/apidoc/src:src.catchAll.dumper}\pysiglinewithargsret{\sphinxcode{src.catchAll.}\sphinxbfcode{dumper}}{\emph{obj}}{}
+to json explore subclass object as dict
\end{fulllineitems}
-\index{load\_cfg\_environment() (src.environment.SalomeEnviron method)}
+\index{dumperType() (in module src.catchAll)}
\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{commands/apidoc/src:src.catchAll.dumperType}\pysiglinewithargsret{\sphinxcode{src.catchAll.}\sphinxbfcode{dumperType}}{\emph{obj}}{}
+to get a ``\_type'' to trace json subclass object,
+but ignore all attributes begining with `\_'
\end{fulllineitems}
-\index{prepend() (src.environment.SalomeEnviron method)}
+\index{jsonDumps() (in module src.catchAll)}
\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
+\phantomsection\label{commands/apidoc/src:src.catchAll.jsonDumps}\pysiglinewithargsret{\sphinxcode{src.catchAll.}\sphinxbfcode{jsonDumps}}{\emph{obj}}{}
+to get direct default jsonDumps method
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to prepend to key
+\end{fulllineitems}
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
-\end{itemize}
-\end{description}\end{quote}
+\subsubsection{src.coloringSat module}
+\label{commands/apidoc/src:module-src.coloringSat}\label{commands/apidoc/src:src-coloringsat-module}\index{src.coloringSat (module)}
+simple tagging as `\textless{}color\textgreater{}' for simple coloring log messages on terminal(s)
+window or unix or ios using backend colorama
+
+using `\textless{}color\textgreater{}' because EZ human readable
+so `\textless{}color\textgreater{}' are not supposed existing in log message
+``\{\}''.format() is not choosen because ``\{\}'' are present
+in log messages of contents of python dict (as JSON) etc.
+
+example:
+\textgreater{}\textgreater{} log(``this is in \textless{}green\textgreater{}color green\textless{}reset\textgreater{}, OK is in blue: \textless{}blue\textgreater{}OK?'')
+\index{ColoringStream (class in src.coloringSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.coloringSat.ColoringStream}\pysigline{\sphinxstrong{class }\sphinxcode{src.coloringSat.}\sphinxbfcode{ColoringStream}}
+Bases: \sphinxcode{object}
+
+write my stream class
+only write and flush are used for the streaming
+\url{https://docs.python.org/2/library/logging.handlers.html}
+\url{https://stackoverflow.com/questions/31999627/storing-logger-messages-in-a-string}
+\index{flush() (src.coloringSat.ColoringStream method)}
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.coloringSat.ColoringStream.flush}\pysiglinewithargsret{\sphinxbfcode{flush}}{}{}
\end{fulllineitems}
-\index{run\_env\_script() (src.environment.SalomeEnviron method)}
+\index{write() (src.coloringSat.ColoringStream method)}
\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{commands/apidoc/src:src.coloringSat.ColoringStream.write}\pysiglinewithargsret{\sphinxbfcode{write}}{\emph{astr}}{}
+\end{fulllineitems}
-\item {}
-\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{fulllineitems}
-\end{itemize}
+\index{cleanColors() (in module src.coloringSat)}
-\end{description}\end{quote}
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.coloringSat.cleanColors}\pysiglinewithargsret{\sphinxcode{src.coloringSat.}\sphinxbfcode{cleanColors}}{\emph{msg}}{}
+clean the message of color tags `\textless{}red\textgreater{} ...
\end{fulllineitems}
-\index{run\_simple\_env\_script() (src.environment.SalomeEnviron method)}
+\index{indent() (in module src.coloringSat)}
\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.
-\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode\begin{itemize}
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{script\_path}}) \textendash{} a path to an environment script
+\phantomsection\label{commands/apidoc/src:src.coloringSat.indent}\pysiglinewithargsret{\sphinxcode{src.coloringSat.}\sphinxbfcode{indent}}{\emph{msg}, \emph{nb}, \emph{car=' `}}{}
+indent nb car (spaces) multi lines message except first one
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to display messages
+\end{fulllineitems}
-\end{itemize}
+\index{log() (in module src.coloringSat)}
-\end{description}\end{quote}
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.coloringSat.log}\pysiglinewithargsret{\sphinxcode{src.coloringSat.}\sphinxbfcode{log}}{\emph{msg}}{}
+elementary log stdout for debug if \_verbose
\end{fulllineitems}
-\index{set() (src.environment.SalomeEnviron method)}
+\index{replace() (in module src.coloringSat)}
\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”
-\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode\begin{itemize}
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the environment variable to set
+\phantomsection\label{commands/apidoc/src:src.coloringSat.replace}\pysiglinewithargsret{\sphinxcode{src.coloringSat.}\sphinxbfcode{replace}}{\emph{msg}, \emph{tags}}{}
+\end{fulllineitems}
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value
+\index{toColor() (in module src.coloringSat)}
-\end{itemize}
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.coloringSat.toColor}\pysiglinewithargsret{\sphinxcode{src.coloringSat.}\sphinxbfcode{toColor}}{\emph{msg}}{}
+automatically clean the message of color tags `\textless{}red\textgreater{} ...
+if the terminal output stdout is redirected by user
+if not, replace tags with ansi color codes
-\end{description}\end{quote}
+example:
+\textgreater{}\textgreater{} sat compile SALOME \textgreater{} log.txt
\end{fulllineitems}
-\index{set\_a\_product() (src.environment.SalomeEnviron method)}
+\index{toColor\_AnsiToWin32() (in module src.coloringSat)}
\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.
-\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode\begin{itemize}
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{product}}) \textendash{} The product name
+\phantomsection\label{commands/apidoc/src:src.coloringSat.toColor_AnsiToWin32}\pysiglinewithargsret{\sphinxcode{src.coloringSat.}\sphinxbfcode{toColor\_AnsiToWin32}}{\emph{msg}}{}
+for test debug no wrapping
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to display messages
+\end{fulllineitems}
-\end{itemize}
-\end{description}\end{quote}
+\subsubsection{src.compilation module}
+\label{commands/apidoc/src:module-src.compilation}\label{commands/apidoc/src:src-compilation-module}\index{src.compilation (module)}\index{Builder (class in src.compilation)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.compilation.Builder}\pysiglinewithargsret{\sphinxstrong{class }\sphinxcode{src.compilation.}\sphinxbfcode{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)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.compilation.Builder.build_configure}\pysiglinewithargsret{\sphinxbfcode{build\_configure}}{\emph{options='`}}{}
\end{fulllineitems}
-\index{set\_application\_env() (src.environment.SalomeEnviron method)}
+\index{check() (src.compilation.Builder 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.
-\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to display messages
+\phantomsection\label{commands/apidoc/src:src.compilation.Builder.check}\pysiglinewithargsret{\sphinxbfcode{check}}{\emph{command='`}}{}
+\end{fulllineitems}
-\end{description}\end{quote}
+\index{cmake() (src.compilation.Builder method)}
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.compilation.Builder.cmake}\pysiglinewithargsret{\sphinxbfcode{cmake}}{\emph{options='`}}{}
\end{fulllineitems}
-\index{set\_cpp\_env() (src.environment.SalomeEnviron method)}
+\index{complete\_environment() (src.compilation.Builder 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.
-\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The product description
+\phantomsection\label{commands/apidoc/src:src.compilation.Builder.complete_environment}\pysiglinewithargsret{\sphinxbfcode{complete\_environment}}{\emph{make\_options}}{}
+\end{fulllineitems}
-\end{description}\end{quote}
+\index{configure() (src.compilation.Builder method)}
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.compilation.Builder.configure}\pysiglinewithargsret{\sphinxbfcode{configure}}{\emph{options='`}}{}
\end{fulllineitems}
-\index{set\_full\_environ() (src.environment.SalomeEnviron method)}
+\index{do\_batch\_script\_build() (src.compilation.Builder 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.
-\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode\begin{itemize}
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to display messages
+\phantomsection\label{commands/apidoc/src:src.compilation.Builder.do_batch_script_build}\pysiglinewithargsret{\sphinxbfcode{do\_batch\_script\_build}}{\emph{script}, \emph{nb\_proc}}{}
+\end{fulllineitems}
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{env\_info}}) \textendash{} the list of products
+\index{do\_default\_build() (src.compilation.Builder method)}
-\end{itemize}
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.compilation.Builder.do_default_build}\pysiglinewithargsret{\sphinxbfcode{do\_default\_build}}{\emph{build\_conf\_options='`}, \emph{configure\_options='`}, \emph{show\_warning=True}}{}
+\end{fulllineitems}
-\end{description}\end{quote}
+\index{do\_python\_script\_build() (src.compilation.Builder method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.compilation.Builder.do_python_script_build}\pysiglinewithargsret{\sphinxbfcode{do\_python\_script\_build}}{\emph{script}, \emph{nb\_proc}}{}
+Performs a build with a script.
\end{fulllineitems}
-\index{set\_products() (src.environment.SalomeEnviron method)}
+\index{do\_script\_build() (src.compilation.Builder 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.
-\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode\begin{itemize}
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to display messages
+\phantomsection\label{commands/apidoc/src:src.compilation.Builder.do_script_build}\pysiglinewithargsret{\sphinxbfcode{do\_script\_build}}{\emph{script}, \emph{number\_of\_proc=0}}{}
+\end{fulllineitems}
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{src}} (\sphinxstyleliteralemphasis{\sphinxupquote{src\_root}}) \textendash{} the application working directory
+\index{hack\_libtool() (src.compilation.Builder method)}
-\end{itemize}
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.compilation.Builder.hack_libtool}\pysiglinewithargsret{\sphinxbfcode{hack\_libtool}}{}{}
+\end{fulllineitems}
-\end{description}\end{quote}
+\index{install() (src.compilation.Builder method)}
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.compilation.Builder.install}\pysiglinewithargsret{\sphinxbfcode{install}}{}{}
\end{fulllineitems}
-\index{set\_python\_libdirs() (src.environment.SalomeEnviron method)}
+\index{log() (src.compilation.Builder 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
+\phantomsection\label{commands/apidoc/src:src.compilation.Builder.log}\pysiglinewithargsret{\sphinxbfcode{log}}{\emph{text}, \emph{level}, \emph{showInfo=True}}{}
+Shortcut method to log in log file.
\end{fulllineitems}
-\index{set\_salome\_generic\_product\_env() (src.environment.SalomeEnviron method)}
+\index{log\_command() (src.compilation.Builder 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{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{pi}}) \textendash{} The product description
+\phantomsection\label{commands/apidoc/src:src.compilation.Builder.log_command}\pysiglinewithargsret{\sphinxbfcode{log\_command}}{\emph{command}}{}
+Shortcut method to log a command.
-\end{description}\end{quote}
+\end{fulllineitems}
+
+\index{make() (src.compilation.Builder method)}
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.compilation.Builder.make}\pysiglinewithargsret{\sphinxbfcode{make}}{\emph{nb\_proc}, \emph{make\_opt='`}}{}
\end{fulllineitems}
-\index{set\_salome\_minimal\_product\_env() (src.environment.SalomeEnviron method)}
+\index{prepare() (src.compilation.Builder 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
-\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode\begin{itemize}
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The product description
+\phantomsection\label{commands/apidoc/src:src.compilation.Builder.prepare}\pysiglinewithargsret{\sphinxbfcode{prepare}}{}{}
+Prepares the environment.
+Build two environment: one for building and one for testing (launch).
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to display messages
+\end{fulllineitems}
-\end{itemize}
+\index{put\_txt\_log\_in\_appli\_log\_dir() (src.compilation.Builder method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.compilation.Builder.put_txt_log_in_appli_log_dir}\pysiglinewithargsret{\sphinxbfcode{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
+\textbf{\texttt{Str}} (\emph{\texttt{file\_name}}) -- the name of the file to write
\end{description}\end{quote}
\end{fulllineitems}
+\index{wmake() (src.compilation.Builder method)}
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.compilation.Builder.wmake}\pysiglinewithargsret{\sphinxbfcode{wmake}}{\emph{nb\_proc}, \emph{opt\_nb\_proc=None}}{}
\end{fulllineitems}
-\index{Shell (class in src.environment)}
+
+\end{fulllineitems}
+
+
+
+\subsubsection{src.configManager module}
+\label{commands/apidoc/src:module-src.configManager}\label{commands/apidoc/src:src-configmanager-module}\index{src.configManager (module)}\index{ConfigManager (class in src.configManager)}
\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.
+\phantomsection\label{commands/apidoc/src:src.configManager.ConfigManager}\pysiglinewithargsret{\sphinxstrong{class }\sphinxcode{src.configManager.}\sphinxbfcode{ConfigManager}}{\emph{runner}}{}
+Class that manages the read of all the config .pyconf files of salomeTools
+\index{create\_config\_file() (src.configManager.ConfigManager method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.configManager.ConfigManager.create_config_file}\pysiglinewithargsret{\sphinxbfcode{create\_config\_file}}{\emph{config}}{}
+This method is called when there are no user config file.
+It build it from scratch.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{\texttt{class 'PYCONF.Config'}} (\emph{\texttt{config}}) -- The global config.
+
+\item[{Returns}] \leavevmode
+the config corresponding to the file created.
+
+\item[{Return type}] \leavevmode
+config class `PYCONF.Config'
+
+\end{description}\end{quote}
\end{fulllineitems}
-\index{load\_environment() (in module src.environment)}
+\index{get\_command\_line\_overrides() (src.configManager.ConfigManager 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{commands/apidoc/src:src.configManager.ConfigManager.get_command_line_overrides}\pysiglinewithargsret{\sphinxbfcode{get\_command\_line\_overrides}}{\emph{options}, \emph{sections}}{}
+get all the overwrites that are in the command line
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} the global config
-
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{bool}} (\sphinxstyleliteralemphasis{\sphinxupquote{build}}) \textendash{} build environement if True
+\textbf{\texttt{options}} -- the options from salomeTools class
+initialization (like -l5 or --overwrite)
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to display messages
+\textbf{\texttt{str}} (\emph{\texttt{sections}}) -- The config section to overwrite.
\end{itemize}
-\end{description}\end{quote}
-
-\end{fulllineitems}
-
+\item[{Returns}] \leavevmode
+The list of all the overwrites to apply.
+\item[{Return type}] \leavevmode
+{\hyperref[commands/apidoc/src:src.utilsSat.Path.list]{\sphinxcrossref{list}}} (\autopageref*{commands/apidoc/src:src.utilsSat.Path.list})
-\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)}
+\end{description}\end{quote}
-\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}})
+\end{fulllineitems}
-Class for bash shell.
-\index{command\_value() (src.fileEnviron.BashFileEnviron method)}
+\index{get\_config() (src.configManager.ConfigManager 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{commands/apidoc/src:src.configManager.ConfigManager.get_config}\pysiglinewithargsret{\sphinxbfcode{get\_config}}{\emph{application=None}, \emph{options=None}, \emph{command=None}, \emph{datadir=None}}{}
+get the config from all the configuration files.
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{command}}) \textendash{} the environment variable
+\textbf{\texttt{str}} (\emph{\texttt{datadir}}) -- The application for which salomeTools is called.
+
+\item {}
+\textbf{\texttt{class Options}} ({\hyperref[commands/apidoc/src:module\string-src.options]{\sphinxcrossref{\emph{\texttt{options}}}}} (\autopageref*{commands/apidoc/src:module-src.options})) -- The general salomeTools options (--overwrite or -v5, for example)
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the command to execute
+\textbf{\texttt{str}} -- The command that is called.
+
+\item {}
+\textbf{\texttt{str}} -- The repository that contain external data for salomeTools.
\end{itemize}
+\item[{Returns}] \leavevmode
+The final config.
+
+\item[{Return type}] \leavevmode
+class `PYCONF.Config'
+
\end{description}\end{quote}
\end{fulllineitems}
-\index{finish() (src.fileEnviron.BashFileEnviron method)}
+\index{get\_user\_config\_file() (src.configManager.ConfigManager method)}
\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{commands/apidoc/src:src.configManager.ConfigManager.get_user_config_file}\pysiglinewithargsret{\sphinxbfcode{get\_user\_config\_file}}{}{}
+Get the user config file
\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{bool}} (\sphinxstyleliteralemphasis{\sphinxupquote{required}}) \textendash{} Do nothing if required is False
+\item[{Returns}] \leavevmode
+path to the user config file.
+
+\item[{Return type}] \leavevmode
+str
\end{description}\end{quote}
\end{fulllineitems}
-\index{set() (src.fileEnviron.BashFileEnviron method)}
+\index{set\_user\_config\_file() (src.configManager.ConfigManager 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{commands/apidoc/src:src.configManager.ConfigManager.set_user_config_file}\pysiglinewithargsret{\sphinxbfcode{set\_user\_config\_file}}{\emph{config}}{}
+Set the user config file name and path.
+If necessary, build it from another one or create it from scratch.
\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
+\textbf{\texttt{class 'PYCONF.Config'}} (\emph{\texttt{config}}) -- The global config (containing all pyconf).
\end{description}\end{quote}
\end{fulllineitems}
-\index{BatFileEnviron (class in src.fileEnviron)}
+\index{ConfigOpener (class in src.configManager)}
\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)}
+\phantomsection\label{commands/apidoc/src:src.configManager.ConfigOpener}\pysiglinewithargsret{\sphinxstrong{class }\sphinxcode{src.configManager.}\sphinxbfcode{ConfigOpener}}{\emph{pathList}}{}
+Class that helps to find an application pyconf
+in all the possible directories (pathList)
+\index{get\_path() (src.configManager.ConfigOpener 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{comment}}) \textendash{} the comment to add
+\phantomsection\label{commands/apidoc/src:src.configManager.ConfigOpener.get_path}\pysiglinewithargsret{\sphinxbfcode{get\_path}}{\emph{name}}{}
+The method that returns the entire path of the pyconf searched
+:param name str: The name of the searched pyconf.
+
+\end{fulllineitems}
-\end{description}\end{quote}
\end{fulllineitems}
-\index{command\_value() (src.fileEnviron.BatFileEnviron method)}
+\index{check\_path() (in module src.configManager)}
\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{commands/apidoc/src:src.configManager.check_path}\pysiglinewithargsret{\sphinxcode{src.configManager.}\sphinxbfcode{check\_path}}{\emph{path}, \emph{ext={[}{]}}}{}
+Construct a text with the input path and ``not found'' if it does not exist.
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{command}}) \textendash{} the environment variable
+\textbf{\texttt{Str}} (\emph{\texttt{path}}) -- the path to check.
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the command to execute
+\textbf{\texttt{List}} (\emph{\texttt{ext}}) -- An extension. Verify that the path extension is in the list
\end{itemize}
+\item[{Returns}] \leavevmode
+The string of the path with information
+
+\item[{Return type}] \leavevmode
+Str
+
\end{description}\end{quote}
\end{fulllineitems}
-\index{finish() (src.fileEnviron.BatFileEnviron method)}
+\index{getConfigColored() (in module src.configManager)}
\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{commands/apidoc/src:src.configManager.getConfigColored}\pysiglinewithargsret{\sphinxcode{src.configManager.}\sphinxbfcode{getConfigColored}}{\emph{config}, \emph{path}, \emph{stream}, \emph{show\_label=False}, \emph{level=0}, \emph{show\_full\_path=False}}{}
+Get a colored representation value from a config pyconf instance.
+used recursively from the initial path.
\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{bool}} (\sphinxstyleliteralemphasis{\sphinxupquote{required}}) \textendash{} Do nothing if required is False
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{\texttt{class 'PYCONF.Config'}} (\emph{\texttt{config}}) -- The configuration from which the value is displayed.
+
+\item {}
+\textbf{\texttt{str}} (\emph{\texttt{path}}) -- the path in the configuration of the value to print.
+
+\item {}
+\textbf{\texttt{boolean}} (\emph{\texttt{show\_label}}) -- if True, do a basic display. (useful for bash completion)
+
+\item {}
+\textbf{\texttt{stream}} -- the output stream used
+
+\item {}
+\textbf{\texttt{int}} (\emph{\texttt{level}}) -- The number of spaces to add before display.
+
+\item {}
+\textbf{\texttt{show\_full\_path}} -- display full path, else relative
+
+\end{itemize}
\end{description}\end{quote}
\end{fulllineitems}
-\index{get() (src.fileEnviron.BatFileEnviron method)}
+\index{get\_config\_children() (in module src.configManager)}
\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{commands/apidoc/src:src.configManager.get_config_children}\pysiglinewithargsret{\sphinxcode{src.configManager.}\sphinxbfcode{get\_config\_children}}{\emph{config}, \emph{args}}{}
+Gets the names of the children of the given parameter.
+Useful only for completion mechanism
\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{\texttt{Config}} (\emph{\texttt{config}}) -- The configuration where to read the values
+
+\item {}
+\textbf{\texttt{args}} -- The path in the config from which get the keys
+
+\end{itemize}
\end{description}\end{quote}
\end{fulllineitems}
-\index{set() (src.fileEnviron.BatFileEnviron method)}
+\index{get\_products\_list() (in module src.configManager)}
\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{commands/apidoc/src:src.configManager.get_products_list}\pysiglinewithargsret{\sphinxcode{src.configManager.}\sphinxbfcode{get\_products\_list}}{\emph{self}, \emph{options}, \emph{cfg}, \emph{logger}}{}
+Gives the product list with their informations from
+configuration regarding the passed options.
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the environment variable to set
+\textbf{\texttt{Options}} ({\hyperref[commands/apidoc/src:module\string-src.options]{\sphinxcrossref{\emph{\texttt{options}}}}} (\autopageref*{commands/apidoc/src:module-src.options})) -- The Options instance that stores the commands arguments
+
+\item {}
+\textbf{\texttt{Config}} (\emph{\texttt{config}}) -- The global configuration
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value
+\textbf{\texttt{Logger}} (\emph{\texttt{logger}}) -- The logger instance to use for the display and logging
\end{itemize}
-\end{description}\end{quote}
+\item[{Returns}] \leavevmode
+The list of (product name, product\_informations).
-\end{fulllineitems}
+\item[{Return type}] \leavevmode
+List
+\end{description}\end{quote}
\end{fulllineitems}
-\index{ContextFileEnviron (class in src.fileEnviron)}
+\index{print\_debug() (in module src.configManager)}
\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}})
+\phantomsection\label{commands/apidoc/src:src.configManager.print_debug}\pysiglinewithargsret{\sphinxcode{src.configManager.}\sphinxbfcode{print\_debug}}{\emph{config}, \emph{aPath}, \emph{logger}, \emph{show\_label=False}, \emph{level=0}, \emph{show\_full\_path=False}}{}
+logger output for debugging a config/pyconf
+lines contains: path : expression --\textgreater{} `evaluation'
-Class for a salome context configuration file.
-\index{add\_echo() (src.fileEnviron.ContextFileEnviron method)}
-
-\begin{fulllineitems}
-\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{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{text}}) \textendash{} the comment to add
-
-\end{description}\end{quote}
+example:
+PROJECTS.projects.salome.project\_path : \$PWD --\textgreater{} `/tmp/SALOME'
\end{fulllineitems}
-\index{add\_warning() (src.fileEnviron.ContextFileEnviron method)}
+\index{print\_value() (in module src.configManager)}
\begin{fulllineitems}
-\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
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{text}}) \textendash{} the warning to add
+\phantomsection\label{commands/apidoc/src:src.configManager.print_value}\pysiglinewithargsret{\sphinxcode{src.configManager.}\sphinxbfcode{print\_value}}{\emph{config}, \emph{path}, \emph{logger}, \emph{show\_label=False}, \emph{level=0}, \emph{show\_full\_path=False}}{}
+print a colored representation value from a config pyconf instance.
+used recursively from the initial path.
-\end{description}\end{quote}
+:param see getConfigColored
\end{fulllineitems}
-\index{append\_value() (src.fileEnviron.ContextFileEnviron method)}
+\index{show\_patchs() (in module src.configManager)}
\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{commands/apidoc/src:src.configManager.show_patchs}\pysiglinewithargsret{\sphinxcode{src.configManager.}\sphinxbfcode{show\_patchs}}{\emph{config}, \emph{logger}}{}
+Prints all the used patchs in the application.
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to append
+\textbf{\texttt{Config}} (\emph{\texttt{config}}) -- the global configuration.
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to append to key
-
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
+\textbf{\texttt{Logger}} (\emph{\texttt{logger}}) -- The logger instance to use for the display
\end{itemize}
\end{fulllineitems}
-\index{command\_value() (src.fileEnviron.ContextFileEnviron method)}
+\index{show\_product\_info() (in module src.configManager)}
\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{commands/apidoc/src:src.configManager.show_product_info}\pysiglinewithargsret{\sphinxcode{src.configManager.}\sphinxbfcode{show\_product\_info}}{\emph{config}, \emph{name}, \emph{logger}}{}
+Display on the terminal and logger information about a product.
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{command}}) \textendash{} the environment variable
+\textbf{\texttt{Config}} (\emph{\texttt{config}}) -- the global configuration.
+
+\item {}
+\textbf{\texttt{Str}} (\emph{\texttt{name}}) -- The name of the product
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the command to execute
+\textbf{\texttt{Logger}} (\emph{\texttt{logger}}) -- The logger instance to use for the display
\end{itemize}
\end{fulllineitems}
-\index{finish() (src.fileEnviron.ContextFileEnviron 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)
-\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{bool}} (\sphinxstyleliteralemphasis{\sphinxupquote{required}}) \textendash{} Do nothing if required is False
-\end{description}\end{quote}
+\subsubsection{src.debug module}
+\label{commands/apidoc/src:module-src.debug}\label{commands/apidoc/src:src-debug-module}\index{src.debug (module)}
+This file assume DEBUG functionalities use
+Print salomeTools debug messages in sys.stderr.
+Show pretty print debug representation from instances of SAT classes
+(pretty print src.pyconf.Config)
-\end{fulllineitems}
+WARNING: supposedly show messages in SAT development phase, not production
-\index{get() (src.fileEnviron.ContextFileEnviron 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
+\index{InStream (class in src.debug)}
\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
+\phantomsection\label{commands/apidoc/src:src.debug.InStream}\pysiglinewithargsret{\sphinxstrong{class }\sphinxcode{src.debug.}\sphinxbfcode{InStream}}{\emph{buf='`}}{}
+Bases: \sphinxcode{StringIO.StringIO}
-\end{description}\end{quote}
+utility class for pyconf.Config input iostream
\end{fulllineitems}
-\index{prepend\_value() (src.fileEnviron.ContextFileEnviron method)}
+\index{OutStream (class in src.debug)}
\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
-\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode\begin{itemize}
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to prepend
+\phantomsection\label{commands/apidoc/src:src.debug.OutStream}\pysiglinewithargsret{\sphinxstrong{class }\sphinxcode{src.debug.}\sphinxbfcode{OutStream}}{\emph{buf='`}}{}
+Bases: \sphinxcode{StringIO.StringIO}
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to prepend to key
+utility class for pyconf.Config output iostream
+\index{close() (src.debug.OutStream method)}
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.debug.OutStream.close}\pysiglinewithargsret{\sphinxbfcode{close}}{}{}
+because Config.\_\_save\_\_ calls close() stream as file
+keep value before lost as self.value
-\end{itemize}
+\end{fulllineitems}
-\end{description}\end{quote}
\end{fulllineitems}
-\index{set() (src.fileEnviron.ContextFileEnviron method)}
+\index{getLocalEnv() (in module src.debug)}
\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”
-\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode\begin{itemize}
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the environment variable to set
+\phantomsection\label{commands/apidoc/src:src.debug.getLocalEnv}\pysiglinewithargsret{\sphinxcode{src.debug.}\sphinxbfcode{getLocalEnv}}{}{}
+get string for environment variables representation
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value
+\end{fulllineitems}
-\end{itemize}
+\index{getStrConfigDbg() (in module src.debug)}
-\end{description}\end{quote}
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.debug.getStrConfigDbg}\pysiglinewithargsret{\sphinxcode{src.debug.}\sphinxbfcode{getStrConfigDbg}}{\emph{config}}{}
+set string as saveConfigDbg,
+as (path expression evaluation) for debug
\end{fulllineitems}
+\index{getStrConfigStd() (in module src.debug)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.debug.getStrConfigStd}\pysiglinewithargsret{\sphinxcode{src.debug.}\sphinxbfcode{getStrConfigStd}}{\emph{config}}{}
+set string as saveConfigStd,
+as file .pyconf
\end{fulllineitems}
-\index{FileEnviron (class in src.fileEnviron)}
+\index{indent() (in module src.debug)}
\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}}
+\phantomsection\label{commands/apidoc/src:src.debug.indent}\pysiglinewithargsret{\sphinxcode{src.debug.}\sphinxbfcode{indent}}{\emph{text}, \emph{amount=2}, \emph{ch=' `}}{}
+indent multi lines message
-Base class for shell environment
-\index{add\_comment() (src.fileEnviron.FileEnviron method)}
+\end{fulllineitems}
-\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
-\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{comment}}) \textendash{} the comment to add
+\index{pop\_debug() (in module src.debug)}
-\end{description}\end{quote}
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.debug.pop_debug}\pysiglinewithargsret{\sphinxcode{src.debug.}\sphinxbfcode{pop\_debug}}{}{}
+restore previous debug outputs status
\end{fulllineitems}
-\index{add\_echo() (src.fileEnviron.FileEnviron method)}
+\index{push\_debug() (in module src.debug)}
\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
-\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{text}}) \textendash{} the text to echo
-
-\end{description}\end{quote}
+\phantomsection\label{commands/apidoc/src:src.debug.push_debug}\pysiglinewithargsret{\sphinxcode{src.debug.}\sphinxbfcode{push\_debug}}{\emph{aBool}}{}
+set debug outputs activated, or not
\end{fulllineitems}
-\index{add\_line() (src.fileEnviron.FileEnviron method)}
+\index{saveConfigDbg() (in module src.debug)}
\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
-\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{int}} (\sphinxstyleliteralemphasis{\sphinxupquote{number}}) \textendash{} the number of lines to add
+\phantomsection\label{commands/apidoc/src:src.debug.saveConfigDbg}\pysiglinewithargsret{\sphinxcode{src.debug.}\sphinxbfcode{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{commands/apidoc/src:src.debug.saveConfigStd}\pysiglinewithargsret{\sphinxcode{src.debug.}\sphinxbfcode{saveConfigStd}}{\emph{config}, \emph{aStream}}{}
+returns as file .pyconf
\end{fulllineitems}
-\index{add\_warning() (src.fileEnviron.FileEnviron method)}
+\index{tofix() (in module src.debug)}
\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
-\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{warning}}) \textendash{} the text to echo
+\phantomsection\label{commands/apidoc/src:src.debug.tofix}\pysiglinewithargsret{\sphinxcode{src.debug.}\sphinxbfcode{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)
-\end{description}\end{quote}
+\end{fulllineitems}
+
+\index{write() (in module src.debug)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.debug.write}\pysiglinewithargsret{\sphinxcode{src.debug.}\sphinxbfcode{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}
-\index{append() (src.fileEnviron.FileEnviron method)}
+
+
+\subsubsection{src.environment module}
+\label{commands/apidoc/src:src-environment-module}\label{commands/apidoc/src:module-src.environment}\index{src.environment (module)}\index{Environ (class in src.environment)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.environment.Environ}\pysiglinewithargsret{\sphinxstrong{class }\sphinxcode{src.environment.}\sphinxbfcode{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.fileEnviron.FileEnviron.append}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
+\phantomsection\label{commands/apidoc/src:src.environment.Environ.append}\pysiglinewithargsret{\sphinxbfcode{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
+\textbf{\texttt{str}} (\emph{\texttt{sep}}) -- 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
+\textbf{\texttt{str or list}} (\emph{\texttt{value}}) -- the value(s) to append to key
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
+\textbf{\texttt{str}} -- the separator string
\end{itemize}
\end{fulllineitems}
-\index{append\_value() (src.fileEnviron.FileEnviron method)}
+\index{append\_value() (src.environment.Environ method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.append_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append\_value}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
+\phantomsection\label{commands/apidoc/src:src.environment.Environ.append_value}\pysiglinewithargsret{\sphinxbfcode{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
+\textbf{\texttt{str}} (\emph{\texttt{sep}}) -- the environment variable to append
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to append to key
+\textbf{\texttt{str}} -- the value to append to key
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
+\textbf{\texttt{str}} -- the separator string
\end{itemize}
\end{fulllineitems}
-\index{command\_value() (src.fileEnviron.FileEnviron method)}
+\index{command\_value() (src.environment.Environ 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
-This can be seen as a virtual method
+\phantomsection\label{commands/apidoc/src:src.environment.Environ.command_value}\pysiglinewithargsret{\sphinxbfcode{command\_value}}{\emph{key}, \emph{command}}{}~\begin{description}
+\item[{Get the value given by the system command ``command'' }] \leavevmode
+and put it in the environment variable key
+
+\end{description}
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{command}}) \textendash{} the environment variable
+\textbf{\texttt{str}} (\emph{\texttt{command}}) -- the environment variable
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the command to execute
+\textbf{\texttt{str}} -- the command to execute
\end{itemize}
\end{fulllineitems}
-\index{finish() (src.fileEnviron.FileEnviron method)}
-
-\begin{fulllineitems}
-\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)}
+\index{get() (src.environment.Environ 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{commands/apidoc/src:src.environment.Environ.get}\pysiglinewithargsret{\sphinxbfcode{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
+\textbf{\texttt{str}} (\emph{\texttt{key}}) -- the environment variable
\end{description}\end{quote}
\end{fulllineitems}
-\index{is\_defined() (src.fileEnviron.FileEnviron method)}
+\index{is\_defined() (src.environment.Environ method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.is_defined}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{is\_defined}}}{\emph{key}}{}
+\phantomsection\label{commands/apidoc/src:src.environment.Environ.is_defined}\pysiglinewithargsret{\sphinxbfcode{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
+\textbf{\texttt{str}} (\emph{\texttt{key}}) -- the environment variable to check
\end{description}\end{quote}
\end{fulllineitems}
-\index{prepend() (src.fileEnviron.FileEnviron method)}
+\index{prepend() (src.environment.Environ method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.prepend}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepend}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
+\phantomsection\label{commands/apidoc/src:src.environment.Environ.prepend}\pysiglinewithargsret{\sphinxbfcode{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
+\textbf{\texttt{str}} (\emph{\texttt{sep}}) -- 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
+\textbf{\texttt{str or list}} (\emph{\texttt{value}}) -- the value(s) to prepend to key
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
+\textbf{\texttt{str}} -- the separator string
\end{itemize}
\end{fulllineitems}
-\index{prepend\_value() (src.fileEnviron.FileEnviron method)}
+\index{prepend\_value() (src.environment.Environ 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=':'}}{}
+\phantomsection\label{commands/apidoc/src:src.environment.Environ.prepend_value}\pysiglinewithargsret{\sphinxbfcode{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
+\textbf{\texttt{str}} (\emph{\texttt{sep}}) -- the environment variable to prepend
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to prepend to key
+\textbf{\texttt{str}} -- the value to prepend to key
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
+\textbf{\texttt{str}} -- the separator string
\end{itemize}
\end{fulllineitems}
-\index{set() (src.fileEnviron.FileEnviron method)}
+\index{set() (src.environment.Environ 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{commands/apidoc/src:src.environment.Environ.set}\pysiglinewithargsret{\sphinxbfcode{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
+\textbf{\texttt{str}} (\emph{\texttt{value}}) -- the environment variable to set
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value
+\textbf{\texttt{str}} -- the value
\end{itemize}
\end{fulllineitems}
-\index{LauncherFileEnviron (class in src.fileEnviron)}
+\index{FileEnvWriter (class in src.environment)}
\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)}
+\phantomsection\label{commands/apidoc/src:src.environment.FileEnvWriter}\pysiglinewithargsret{\sphinxstrong{class }\sphinxcode{src.environment.}\sphinxbfcode{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.fileEnviron.LauncherFileEnviron.add}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add}}}{\emph{key}, \emph{value}}{}
-prepend value to key using sep
+\phantomsection\label{commands/apidoc/src:src.environment.FileEnvWriter.write_cfgForPy_file}\pysiglinewithargsret{\sphinxbfcode{write\_cfgForPy\_file}}{\emph{filename}, \emph{additional\_env=\{\}}, \emph{for\_package=None}, \emph{with\_commercial=True}}{}~\begin{description}
+\item[{Append to current opened aFile a cfgForPy }] \leavevmode
+environment (SALOME python launcher).
+
+\end{description}
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the environment variable to prepend
+\textbf{\texttt{str}} (\emph{\texttt{for\_package}}) -- the file path
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to prepend to key
+\textbf{\texttt{dict}} (\emph{\texttt{additional\_env}}) -- a dictionary of additional variables
+to add to the environment
+
+\item {}
+\textbf{\texttt{str}} -- If not None, produce a relative environment
+designed for a package.
\end{itemize}
\end{fulllineitems}
-\index{add\_comment() (src.fileEnviron.LauncherFileEnviron method)}
+\index{write\_env\_file() (src.environment.FileEnvWriter method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add_comment}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_comment}}}{\emph{comment}}{}
-\end{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.environment.FileEnvWriter.write_env_file}\pysiglinewithargsret{\sphinxbfcode{write\_env\_file}}{\emph{filename}, \emph{forBuild}, \emph{shell}, \emph{for\_package=None}}{}
+Create an environment file.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{\texttt{str}} (\emph{\texttt{shell}}) -- the file path
-\index{add\_echo() (src.fileEnviron.LauncherFileEnviron method)}
+\item {}
+\textbf{\texttt{bool}} (\emph{\texttt{forBuild}}) -- if true, the build environment
-\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
+\item {}
+\textbf{\texttt{str}} -- the type of file wanted (.sh, .bat)
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+The path to the generated file
+
+\item[{Return type}] \leavevmode
+str
\end{description}\end{quote}
\end{fulllineitems}
-\index{add\_line() (src.fileEnviron.LauncherFileEnviron method)}
+
+\end{fulllineitems}
+
+\index{SalomeEnviron (class in src.environment)}
\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{commands/apidoc/src:src.environment.SalomeEnviron}\pysiglinewithargsret{\sphinxstrong{class }\sphinxcode{src.environment.}\sphinxbfcode{SalomeEnviron}}{\emph{cfg}, \emph{environ}, \emph{forBuild=False}, \emph{for\_package=None}, \emph{enable\_simple\_env\_script=True}}{}
+Class to manage the environment of SALOME.
+\index{add\_comment() (src.environment.SalomeEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron.add_comment}\pysiglinewithargsret{\sphinxbfcode{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{int}} (\sphinxstyleliteralemphasis{\sphinxupquote{number}}) \textendash{} the number of lines to add
+\textbf{\texttt{str}} (\emph{\texttt{comment}}) -- the commentary to add
\end{description}\end{quote}
\end{fulllineitems}
-\index{add\_warning() (src.fileEnviron.LauncherFileEnviron method)}
+\index{add\_line() (src.environment.SalomeEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add_warning}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_warning}}}{\emph{warning}}{}
-Add a warning
+\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron.add_line}\pysiglinewithargsret{\sphinxbfcode{add\_line}}{\emph{nb\_line}}{}
+Add empty lines to the out stream (in case of file generation)
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{text}}) \textendash{} the warning to add
+\textbf{\texttt{int}} (\emph{\texttt{nb\_line}}) -- the number of empty lines to add
\end{description}\end{quote}
\end{fulllineitems}
-\index{append() (src.fileEnviron.LauncherFileEnviron method)}
+\index{add\_warning() (src.environment.SalomeEnviron 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
+\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron.add_warning}\pysiglinewithargsret{\sphinxbfcode{add\_warning}}{\emph{warning}}{}
+Add a warning to the out stream (in case of file generation)
\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}
+\item[{Parameters}] \leavevmode
+\textbf{\texttt{str}} ({\hyperref[commands/apidoc/src:src.utilsSat.warning]{\sphinxcrossref{\emph{\texttt{warning}}}}} (\autopageref*{commands/apidoc/src:src.utilsSat.warning})) -- the warning to add
\end{description}\end{quote}
\end{fulllineitems}
-\index{append\_value() (src.fileEnviron.LauncherFileEnviron method)}
+\index{append() (src.environment.SalomeEnviron 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{commands/apidoc/src:src.environment.SalomeEnviron.append}\pysiglinewithargsret{\sphinxbfcode{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
+\textbf{\texttt{str}} (\emph{\texttt{sep}}) -- the environment variable to append
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to append to key
+\textbf{\texttt{str}} -- the value to append to key
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
+\textbf{\texttt{str}} -- the separator string
\end{itemize}
\end{fulllineitems}
-\index{change\_to\_launcher() (src.fileEnviron.LauncherFileEnviron method)}
+\index{dump() (src.environment.SalomeEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.change_to_launcher}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{change\_to\_launcher}}}{\emph{value}}{}
+\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron.dump}\pysiglinewithargsret{\sphinxbfcode{dump}}{\emph{out}}{}
+Write the environment to out
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{\texttt{file}} (\emph{\texttt{out}}) -- the stream where to write the environment
+
+\end{description}\end{quote}
+
\end{fulllineitems}
-\index{command\_value() (src.fileEnviron.LauncherFileEnviron method)}
+\index{finish() (src.environment.SalomeEnviron method)}
\begin{fulllineitems}
-\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.
+\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron.finish}\pysiglinewithargsret{\sphinxbfcode{finish}}{\emph{required}}{}
+Add a final instruction in the out file (in case of file generation)
\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
-
-\end{itemize}
+\item[{Parameters}] \leavevmode
+\textbf{\texttt{bool}} (\emph{\texttt{required}}) -- Do nothing if required is False
\end{description}\end{quote}
\end{fulllineitems}
-\index{finish() (src.fileEnviron.LauncherFileEnviron method)}
+\index{get() (src.environment.SalomeEnviron method)}
\begin{fulllineitems}
-\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
+\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron.get}\pysiglinewithargsret{\sphinxbfcode{get}}{\emph{key}}{}
+Get the value of the environment variable ``key''
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{bool}} (\sphinxstyleliteralemphasis{\sphinxupquote{required}}) \textendash{} Do nothing if required is False
+\textbf{\texttt{str}} (\emph{\texttt{key}}) -- the environment variable
\end{description}\end{quote}
\end{fulllineitems}
-\index{get() (src.fileEnviron.LauncherFileEnviron method)}
+\index{get\_names() (src.environment.SalomeEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.get}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get}}}{\emph{key}}{}
-Get the value of the environment variable “key”
+\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron.get_names}\pysiglinewithargsret{\sphinxbfcode{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{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable
+\textbf{\texttt{list}} (\emph{\texttt{lProducts}}) -- List of products to potentially add
\end{description}\end{quote}
\end{fulllineitems}
-\index{is\_defined() (src.fileEnviron.LauncherFileEnviron method)}
+\index{is\_defined() (src.environment.SalomeEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.is_defined}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{is\_defined}}}{\emph{key}}{}
+\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron.is_defined}\pysiglinewithargsret{\sphinxbfcode{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
+\textbf{\texttt{str}} (\emph{\texttt{key}}) -- the environment variable to check
\end{description}\end{quote}
\end{fulllineitems}
-\index{prepend() (src.fileEnviron.LauncherFileEnviron method)}
+\index{load\_cfg\_environment() (src.environment.SalomeEnviron 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{commands/apidoc/src:src.environment.SalomeEnviron.load_cfg_environment}\pysiglinewithargsret{\sphinxbfcode{load\_cfg\_environment}}{\emph{cfg\_env}}{}
+Loads environment defined in cfg\_env
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{\texttt{Config}} (\emph{\texttt{cfg\_env}}) -- A config containing an environment
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{prepend() (src.environment.SalomeEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron.prepend}\pysiglinewithargsret{\sphinxbfcode{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
+\textbf{\texttt{str}} (\emph{\texttt{sep}}) -- 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
+\textbf{\texttt{str}} -- the value to prepend to key
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
+\textbf{\texttt{str}} -- the separator string
\end{itemize}
\end{fulllineitems}
-\index{prepend\_value() (src.fileEnviron.LauncherFileEnviron method)}
+\index{run\_env\_script() (src.environment.SalomeEnviron 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{commands/apidoc/src:src.environment.SalomeEnviron.run_env_script}\pysiglinewithargsret{\sphinxbfcode{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{sep}}) \textendash{} the environment variable to prepend
+\textbf{\texttt{Config}} (\emph{\texttt{product\_info}}) -- The product description
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to prepend to key
+\textbf{\texttt{Logger}} (\emph{\texttt{logger}}) -- The logger instance to display messages
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
+\textbf{\texttt{Boolean}} (\emph{\texttt{native}}) -- if True load set\_native\_env instead of set\_env
\end{itemize}
\end{fulllineitems}
-\index{set() (src.fileEnviron.LauncherFileEnviron method)}
+\index{run\_simple\_env\_script() (src.environment.SalomeEnviron 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”
+\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron.run_simple_env_script}\pysiglinewithargsret{\sphinxbfcode{run\_simple\_env\_script}}{\emph{script\_path}, \emph{logger=None}}{}~\begin{description}
+\item[{Runs an environment script. Same as run\_env\_script, but with a }] \leavevmode
+script path as parameter.
+
+\end{description}
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the environment variable to set
+\textbf{\texttt{str}} (\emph{\texttt{script\_path}}) -- a path to an environment script
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value
+\textbf{\texttt{Logger}} (\emph{\texttt{logger}}) -- The logger instance to display messages
\end{itemize}
\end{fulllineitems}
-
-\end{fulllineitems}
-
-\index{ScreenEnviron (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)}
+\index{set() (src.environment.SalomeEnviron method)}
\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
+\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron.set}\pysiglinewithargsret{\sphinxbfcode{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{comment}}) \textendash{} the comment to add
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{\texttt{str}} (\emph{\texttt{value}}) -- the environment variable to set
+
+\item {}
+\textbf{\texttt{str}} -- the value
+
+\end{itemize}
\end{description}\end{quote}
\end{fulllineitems}
-\index{add\_echo() (src.fileEnviron.ScreenEnviron method)}
+\index{set\_a\_product() (src.environment.SalomeEnviron method)}
\begin{fulllineitems}
-\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
+\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron.set_a_product}\pysiglinewithargsret{\sphinxbfcode{set\_a\_product}}{\emph{product}, \emph{logger}}{}
+Sets the environment of a product.
\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{text}}) \textendash{} the text to echo
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{\texttt{str}} ({\hyperref[commands/apidoc/src:module\string-src.product]{\sphinxcrossref{\emph{\texttt{product}}}}} (\autopageref*{commands/apidoc/src:module-src.product})) -- The product name
+
+\item {}
+\textbf{\texttt{Logger}} (\emph{\texttt{logger}}) -- The logger instance to display messages
+
+\end{itemize}
\end{description}\end{quote}
\end{fulllineitems}
-\index{add\_line() (src.fileEnviron.ScreenEnviron method)}
+\index{set\_application\_env() (src.environment.SalomeEnviron method)}
\begin{fulllineitems}
-\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
+\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron.set_application_env}\pysiglinewithargsret{\sphinxbfcode{set\_application\_env}}{\emph{logger}}{}
+Sets the environment defined in the APPLICATION file.
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{int}} (\sphinxstyleliteralemphasis{\sphinxupquote{number}}) \textendash{} the number of lines to add
+\textbf{\texttt{Logger}} (\emph{\texttt{logger}}) -- The logger instance to display messages
\end{description}\end{quote}
\end{fulllineitems}
-\index{add\_warning() (src.fileEnviron.ScreenEnviron method)}
+\index{set\_cpp\_env() (src.environment.SalomeEnviron method)}
\begin{fulllineitems}
-\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
+\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron.set_cpp_env}\pysiglinewithargsret{\sphinxbfcode{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{warning}}) \textendash{} the text to echo
+\textbf{\texttt{Config}} (\emph{\texttt{product\_info}}) -- The product description
\end{description}\end{quote}
\end{fulllineitems}
-\index{append() (src.fileEnviron.ScreenEnviron method)}
+\index{set\_full\_environ() (src.environment.SalomeEnviron method)}
\begin{fulllineitems}
-\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
+\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron.set_full_environ}\pysiglinewithargsret{\sphinxbfcode{set\_full\_environ}}{\emph{logger}, \emph{env\_info}}{}~\begin{description}
+\item[{Sets the full environment for products }] \leavevmode
+specified in env\_info dictionary.
+
+\end{description}
\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
+\textbf{\texttt{Logger}} (\emph{\texttt{logger}}) -- The logger instance to display messages
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
+\textbf{\texttt{list}} (\emph{\texttt{env\_info}}) -- the list of products
\end{itemize}
\end{fulllineitems}
-\index{command\_value() (src.fileEnviron.ScreenEnviron method)}
+\index{set\_products() (src.environment.SalomeEnviron method)}
\begin{fulllineitems}
-\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
+\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron.set_products}\pysiglinewithargsret{\sphinxbfcode{set\_products}}{\emph{logger}, \emph{src\_root=None}}{}
+Sets the environment for all the products.
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{command}}) \textendash{} the environment variable
+\textbf{\texttt{Logger}} (\emph{\texttt{logger}}) -- The logger instance to display messages
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the command to execute
+\textbf{\texttt{src}} (\emph{\texttt{src\_root}}) -- the application working directory
\end{itemize}
\end{fulllineitems}
-\index{get() (src.fileEnviron.ScreenEnviron method)}
+\index{set\_python\_libdirs() (src.environment.SalomeEnviron method)}
\begin{fulllineitems}
-\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[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable
-
-\end{description}\end{quote}
+\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron.set_python_libdirs}\pysiglinewithargsret{\sphinxbfcode{set\_python\_libdirs}}{}{}
+Set some generic variables for python library paths
\end{fulllineitems}
-\index{is\_defined() (src.fileEnviron.ScreenEnviron method)}
+\index{set\_salome\_generic\_product\_env() (src.environment.SalomeEnviron method)}
\begin{fulllineitems}
-\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
+\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron.set_salome_generic_product_env}\pysiglinewithargsret{\sphinxbfcode{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{key}}) \textendash{} the environment variable to check
+\textbf{\texttt{Config}} (\emph{\texttt{pi}}) -- The product description
\end{description}\end{quote}
\end{fulllineitems}
-\index{prepend() (src.fileEnviron.ScreenEnviron method)}
+\index{set\_salome\_minimal\_product\_env() (src.environment.SalomeEnviron method)}
\begin{fulllineitems}
-\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
+\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron.set_salome_minimal_product_env}\pysiglinewithargsret{\sphinxbfcode{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 prepend
-
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}}\sphinxstyleliteralstrong{\sphinxupquote{ or }}\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the value(s) to prepend to key
+\textbf{\texttt{Config}} (\emph{\texttt{product\_info}}) -- The product description
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
+\textbf{\texttt{Logger}} (\emph{\texttt{logger}}) -- The logger instance to display messages
\end{itemize}
\end{fulllineitems}
-\index{run\_env\_script() (src.fileEnviron.ScreenEnviron method)}
+
+\end{fulllineitems}
+
+\index{Shell (class in src.environment)}
\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{commands/apidoc/src:src.environment.Shell}\pysiglinewithargsret{\sphinxstrong{class }\sphinxcode{src.environment.}\sphinxbfcode{Shell}}{\emph{name}, \emph{extension}}{}
+Definition of a Shell.
+
\end{fulllineitems}
-\index{set() (src.fileEnviron.ScreenEnviron method)}
+\index{load\_environment() (in module src.environment)}
\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’
+\phantomsection\label{commands/apidoc/src:src.environment.load_environment}\pysiglinewithargsret{\sphinxcode{src.environment.}\sphinxbfcode{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{value}}) \textendash{} the environment variable to set
+\textbf{\texttt{Config}} (\emph{\texttt{config}}) -- the global config
+
+\item {}
+\textbf{\texttt{bool}} (\emph{\texttt{build}}) -- build environement if True
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value
+\textbf{\texttt{Logger}} (\emph{\texttt{logger}}) -- The logger instance to display messages
\end{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}
-
-\end{fulllineitems}
-\index{get\_file\_environ() (in module src.fileEnviron)}
+\subsubsection{src.environs module}
+\label{commands/apidoc/src:module-src.environs}\label{commands/apidoc/src:src-environs-module}\index{src.environs (module)}
+Utility for print environment variables
+\begin{description}
+\item[{examples: }] \leavevmode\begin{itemize}
+\item {}
+split all or specific environment variables \$XXX(s)...
+\textgreater{}\textgreater{} environs.py -\textgreater{} all
+\textgreater{}\textgreater{} environs.py SHELL PATH -\textgreater{} specific \$SHELL \$PATH
-\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.
-\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode\begin{itemize}
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{file}} (\sphinxstyleliteralemphasis{\sphinxupquote{output}}) \textendash{} the output file stream.
+split all or specific environment variables on pattern \$*XXX*(s)...
+\textgreater{}\textgreater{} environs.py --pat ROOT -\textgreater{} specific \$*ROOT*
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{shell}}) \textendash{} the type of shell syntax to use.
+split search specific substrings in contents of environment variables \$XXX(s)...
+\textgreater{}\textgreater{} environs.py --grep usr -\textgreater{} all specific environment variables containing usr
+\end{itemize}
+
+\item[{tips:}] \leavevmode\begin{itemize}
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{dict}} (\sphinxstyleliteralemphasis{\sphinxupquote{environ}}) \textendash{} a potential additional environment.
+create unix alias as shortcut for bash console
+\textgreater{}\textgreater{} alias envs=''.../environs.py''
\end{itemize}
-\end{description}\end{quote}
+\end{description}
+\index{print\_grep\_environs() (in module src.environs)}
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.environs.print_grep_environs}\pysiglinewithargsret{\sphinxcode{src.environs.}\sphinxbfcode{print\_grep\_environs}}{\emph{args={[}{]}}}{}
\end{fulllineitems}
-\index{special\_path\_separator() (in module src.fileEnviron)}
+\index{print\_split\_environs() (in module src.environs)}
\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.
-\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{name}}) \textendash{} The name of the variable to find the separator
+\phantomsection\label{commands/apidoc/src:src.environs.print_split_environs}\pysiglinewithargsret{\sphinxcode{src.environs.}\sphinxbfcode{print\_split\_environs}}{\emph{args={[}{]}}}{}
+\end{fulllineitems}
-\end{description}\end{quote}
+\index{print\_split\_pattern\_environs() (in module src.environs)}
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.environs.print_split_pattern_environs}\pysiglinewithargsret{\sphinxcode{src.environs.}\sphinxbfcode{print\_split\_pattern\_environs}}{\emph{args={[}{]}}}{}
\end{fulllineitems}
-\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)}
+\subsubsection{src.exceptionSat module}
+\label{commands/apidoc/src:module-src.exceptionSat}\label{commands/apidoc/src:src-exceptionsat-module}\index{src.exceptionSat (module)}\index{ExceptionSat}
\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}
+\phantomsection\label{commands/apidoc/src:src.exceptionSat.ExceptionSat}\pysigline{\sphinxstrong{exception }\sphinxcode{src.exceptionSat.}\sphinxbfcode{ExceptionSat}}
+Bases: \sphinxcode{exceptions.Exception}
-\index{batch\_salome() (in module src.fork)}
+rename Exception Class for sat convenience (for future...)
-\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}
-\index{launch\_command() (in module src.fork)}
+
+
+\subsubsection{src.fileEnviron module}
+\label{commands/apidoc/src:src-fileenviron-module}\label{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.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}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.BashFileEnviron}\pysiglinewithargsret{\sphinxstrong{class }\sphinxcode{src.fileEnviron.}\sphinxbfcode{BashFileEnviron}}{\emph{output}, \emph{environ=None}}{}
+Bases: {\hyperref[commands/apidoc/src:src.fileEnviron.FileEnviron]{\sphinxcrossref{\sphinxcode{src.fileEnviron.FileEnviron}}}} (\autopageref*{commands/apidoc/src:src.fileEnviron.FileEnviron})
-\index{show\_progress() (in module src.fork)}
+Class for bash shell.
+\index{command\_value() (src.fileEnviron.BashFileEnviron 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{commands/apidoc/src:src.fileEnviron.BashFileEnviron.command_value}\pysiglinewithargsret{\sphinxbfcode{command\_value}}{\emph{key}, \emph{command}}{}~\begin{description}
+\item[{Get the value given by the system command ``command'' }] \leavevmode
+and put it in the environment variable key.
+Has to be overwritten in the derived classes
+This can be seen as a virtual method
+
+\end{description}
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logging instance
+\textbf{\texttt{str}} (\emph{\texttt{command}}) -- the environment variable
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{int}} (\sphinxstyleliteralemphasis{\sphinxupquote{delai}}) \textendash{} the number to display
+\textbf{\texttt{str}} -- the command to execute
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{int}} \textendash{} the number max
+\end{itemize}
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{ss}}) \textendash{} the string to display
+\end{description}\end{quote}
-\end{itemize}
+\end{fulllineitems}
+
+\index{finish() (src.fileEnviron.BashFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.BashFileEnviron.finish}\pysiglinewithargsret{\sphinxbfcode{finish}}{\emph{required=True}}{}
+Add a final instruction in the out file (in case of file generation)
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{\texttt{bool}} (\emph{\texttt{required}}) -- Do nothing if required is False
\end{description}\end{quote}
\end{fulllineitems}
-\index{write\_back() (in module src.fork)}
+\index{set() (src.fileEnviron.BashFileEnviron 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{commands/apidoc/src:src.fileEnviron.BashFileEnviron.set}\pysiglinewithargsret{\sphinxbfcode{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{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logging instance
-
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{message}}) \textendash{} the text to display
+\textbf{\texttt{str}} (\emph{\texttt{value}}) -- the environment variable to set
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{int}} (\sphinxstyleliteralemphasis{\sphinxupquote{level}}) \textendash{} the level of verbosity
+\textbf{\texttt{str}} -- the value
\end{itemize}
\end{fulllineitems}
+\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{BatFileEnviron (class in src.fileEnviron)}
\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{commands/apidoc/src:src.fileEnviron.BatFileEnviron}\pysiglinewithargsret{\sphinxstrong{class }\sphinxcode{src.fileEnviron.}\sphinxbfcode{BatFileEnviron}}{\emph{output}, \emph{environ=None}}{}
+Bases: {\hyperref[commands/apidoc/src:src.fileEnviron.FileEnviron]{\sphinxcrossref{\sphinxcode{src.fileEnviron.FileEnviron}}}} (\autopageref*{commands/apidoc/src:src.fileEnviron.FileEnviron})
-Class to handle log mechanism.
-\index{add\_link() (src.logger.Logger method)}
+for Windows batch shell.
+\index{add\_comment() (src.fileEnviron.BatFileEnviron 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{commands/apidoc/src:src.fileEnviron.BatFileEnviron.add_comment}\pysiglinewithargsret{\sphinxbfcode{add\_comment}}{\emph{comment}}{}
+Add a comment in the shell file
\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[{Parameters}] \leavevmode
+\textbf{\texttt{str}} (\emph{\texttt{comment}}) -- the comment to add
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{command\_value() (src.fileEnviron.BatFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.BatFileEnviron.command_value}\pysiglinewithargsret{\sphinxbfcode{command\_value}}{\emph{key}, \emph{command}}{}~\begin{description}
+\item[{Get the value given by the system command ``command'' }] \leavevmode
+and put it in the environment variable key.
+Has to be overwritten in the derived classes
+This can be seen as a virtual method
+\end{description}
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The name of the command linked.
+\textbf{\texttt{str}} (\emph{\texttt{command}}) -- the environment variable
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The result of the command linked. “0” or “1”
+\textbf{\texttt{str}} -- 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.BatFileEnviron 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{commands/apidoc/src:src.fileEnviron.BatFileEnviron.finish}\pysiglinewithargsret{\sphinxbfcode{finish}}{\emph{required=True}}{}~\begin{description}
+\item[{Add a final instruction in the out file (in case of file generation)}] \leavevmode
+In the particular windows case, do nothing
+
+\end{description}
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{dict}} (\sphinxstyleliteralemphasis{\sphinxupquote{attribute}}) \textendash{} the attribute to add to the node “Site”.
+\textbf{\texttt{bool}} (\emph{\texttt{required}}) -- Do nothing if required is False
\end{description}\end{quote}
\end{fulllineitems}
-\index{error() (src.logger.Logger method)}
+\index{get() (src.fileEnviron.BatFileEnviron method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.logger.Logger.error}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{error}}}{\emph{message}}{}
-Print an error.
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.BatFileEnviron.get}\pysiglinewithargsret{\sphinxbfcode{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.
+\textbf{\texttt{str}} (\emph{\texttt{key}}) -- the environment variable
\end{description}\end{quote}
\end{fulllineitems}
-\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}
-
-\index{write() (src.logger.Logger method)}
+\index{set() (src.fileEnviron.BatFileEnviron 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{commands/apidoc/src:src.fileEnviron.BatFileEnviron.set}\pysiglinewithargsret{\sphinxbfcode{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{message}}) \textendash{} The message to print.
-
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{int}} (\sphinxstyleliteralemphasis{\sphinxupquote{level}}) \textendash{} The output level corresponding
-to the message 0 \textless{} level \textless{} 6.
+\textbf{\texttt{str}} (\emph{\texttt{value}}) -- the environment variable to set
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{boolean}} (\sphinxstyleliteralemphasis{\sphinxupquote{screenOnly}}) \textendash{} if True, do not write in log file.
+\textbf{\texttt{str}} -- the value
\end{itemize}
\end{fulllineitems}
-\index{date\_to\_datetime() (in module src.logger)}
+\index{ContextFileEnviron (class in src.fileEnviron)}
\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{commands/apidoc/src:src.fileEnviron.ContextFileEnviron}\pysiglinewithargsret{\sphinxstrong{class }\sphinxcode{src.fileEnviron.}\sphinxbfcode{ContextFileEnviron}}{\emph{output}, \emph{environ=None}}{}
+Bases: {\hyperref[commands/apidoc/src:src.fileEnviron.FileEnviron]{\sphinxcrossref{\sphinxcode{src.fileEnviron.FileEnviron}}}} (\autopageref*{commands/apidoc/src:src.fileEnviron.FileEnviron})
+
+Class for a salome context configuration file.
+\index{add\_echo() (src.fileEnviron.ContextFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.add_echo}\pysiglinewithargsret{\sphinxbfcode{add\_echo}}{\emph{text}}{}
+Add a comment
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{date}}) \textendash{} The date in format YYYYMMDD\_HHMMSS
+\textbf{\texttt{str}} (\emph{\texttt{text}}) -- the comment to add
-\item[{Returns}] \leavevmode
-the same date and time in separate variables.
+\end{description}\end{quote}
-\item[{Return type}] \leavevmode
-(str,str,str,str,str,str)
+\end{fulllineitems}
+
+\index{add\_warning() (src.fileEnviron.ContextFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.add_warning}\pysiglinewithargsret{\sphinxbfcode{add\_warning}}{\emph{warning}}{}
+Add a warning
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{\texttt{str}} (\emph{\texttt{text}}) -- the warning to add
\end{description}\end{quote}
\end{fulllineitems}
-\index{list\_log\_file() (in module src.logger)}
+\index{append\_value() (src.fileEnviron.ContextFileEnviron 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{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.append_value}\pysiglinewithargsret{\sphinxbfcode{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{expression}}) \textendash{} the directory where to search the files
+\textbf{\texttt{str}} (\emph{\texttt{sep}}) -- the environment variable to append
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the regular expression of files to find
-
-\end{itemize}
+\textbf{\texttt{str}} -- the value to append to key
-\item[{Returns}] \leavevmode
-the list of files path and informations about it
+\item {}
+\textbf{\texttt{str}} -- the separator string
-\item[{Return type}] \leavevmode
-list
+\end{itemize}
\end{description}\end{quote}
\end{fulllineitems}
-\index{show\_command\_log() (in module src.logger)}
+\index{command\_value() (src.fileEnviron.ContextFileEnviron method)}
\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.
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.command_value}\pysiglinewithargsret{\sphinxbfcode{command\_value}}{\emph{key}, \emph{command}}{}~\begin{description}
+\item[{Get the value given by the system command ``command'' }] \leavevmode
+and put it in the environment variable key.
+Has to be overwritten in the derived classes
+This can be seen as a virtual method
+
+\end{description}
\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
+\textbf{\texttt{str}} (\emph{\texttt{command}}) -- the environment variable
\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
+\textbf{\texttt{str}} -- the command to execute
\end{itemize}
-\item[{Returns}] \leavevmode
-True if cmd is not in notShownCommands and the application
-in the log file corresponds to application
-
-\item[{Return type}] \leavevmode
-boolean
-
\end{description}\end{quote}
\end{fulllineitems}
-\index{timedelta\_total\_seconds() (in module src.logger)}
+\index{finish() (src.fileEnviron.ContextFileEnviron 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{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.finish}\pysiglinewithargsret{\sphinxbfcode{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{datetime.timedelta}} (\sphinxstyleliteralemphasis{\sphinxupquote{timedelta}}) \textendash{} The delta between two dates
+\textbf{\texttt{bool}} (\emph{\texttt{required}}) -- Do nothing if required is False
-\item[{Returns}] \leavevmode
-The number of seconds corresponding to timedelta.
+\end{description}\end{quote}
-\item[{Return type}] \leavevmode
-float
+\end{fulllineitems}
+
+\index{get() (src.fileEnviron.ContextFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.get}\pysiglinewithargsret{\sphinxbfcode{get}}{\emph{key}}{}
+Get the value of the environment variable ``key''
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{\texttt{str}} (\emph{\texttt{key}}) -- the environment variable
\end{description}\end{quote}
\end{fulllineitems}
-\index{update\_hat\_xml() (in module src.logger)}
+\index{prepend\_value() (src.fileEnviron.ContextFileEnviron 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{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.prepend_value}\pysiglinewithargsret{\sphinxbfcode{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{application}}) \textendash{} the directory to parse
+\textbf{\texttt{str}} (\emph{\texttt{sep}}) -- the environment variable to prepend
+
+\item {}
+\textbf{\texttt{str}} -- the value to prepend to key
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the name of the application if there is any
+\textbf{\texttt{str}} -- the separator string
\end{itemize}
\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)}
-
-\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}}
-
-An instance of this class will be the object manipulated
-in code of all salomeTools commands
-The aim of this class is to have an elegant syntax
-to manipulate the options.
-ex:
-print(options.level)
-5
-
-\end{fulllineitems}
-
-\index{Options (class in src.options)}
-
-\begin{fulllineitems}
-\phantomsection\label{\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{set() (src.fileEnviron.ContextFileEnviron 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{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.set}\pysiglinewithargsret{\sphinxbfcode{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{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”).
-
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The name that will be used in the code.
+\textbf{\texttt{str}} (\emph{\texttt{value}}) -- the environment variable to set
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The text to display
-when user ask for help on a command.
+\textbf{\texttt{str}} -- the value
\end{itemize}
-\item[{Returns}] \leavevmode
-Nothing.
+\end{description}\end{quote}
-\item[{Return type}] \leavevmode
-NA
+\end{fulllineitems}
-\end{description}\end{quote}
\end{fulllineitems}
-\index{parse\_args() (src.options.Options method)}
+\index{FileEnviron (class in src.fileEnviron)}
\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
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.FileEnviron}\pysiglinewithargsret{\sphinxstrong{class }\sphinxcode{src.fileEnviron.}\sphinxbfcode{FileEnviron}}{\emph{output}, \emph{environ=None}}{}
+Base class for shell environment
+\index{add\_comment() (src.fileEnviron.FileEnviron method)}
-\end{description}
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.FileEnviron.add_comment}\pysiglinewithargsret{\sphinxbfcode{add\_comment}}{\emph{comment}}{}
+Add a comment in the shell file
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{argList}}) \textendash{} the raw list of arguments that were passed
-
-\item[{Returns}] \leavevmode
-optResult, args : optResult is the option instance
-to manipulate in the code. args
-is the full raw list of passed options
-
-\item[{Return type}] \leavevmode
-(class ‘common.options.OptResult’,list)
+\textbf{\texttt{str}} (\emph{\texttt{comment}}) -- the comment to add
\end{description}\end{quote}
\end{fulllineitems}
-\index{print\_help() (src.options.Options method)}
+\index{add\_echo() (src.fileEnviron.FileEnviron 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{commands/apidoc/src:src.fileEnviron.FileEnviron.add_echo}\pysiglinewithargsret{\sphinxbfcode{add\_echo}}{\emph{text}}{}
+Add a ``echo'' in the shell file
\begin{quote}\begin{description}
-\item[{Returns}] \leavevmode
-Nothing.
-
-\item[{Return type}] \leavevmode
-NA
+\item[{Parameters}] \leavevmode
+\textbf{\texttt{str}} (\emph{\texttt{text}}) -- the text to echo
\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{add\_line() (src.fileEnviron.FileEnviron 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{commands/apidoc/src:src.fileEnviron.FileEnviron.add_line}\pysiglinewithargsret{\sphinxbfcode{add\_line}}{\emph{number}}{}
+Add some empty lines in the shell file
\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
+\textbf{\texttt{int}} (\emph{\texttt{number}}) -- the number of lines to add
\end{description}\end{quote}
\end{fulllineitems}
-\index{print\_color\_map() (in module src.printcolors)}
+\index{add\_warning() (src.fileEnviron.FileEnviron method)}
\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
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.FileEnviron.add_warning}\pysiglinewithargsret{\sphinxbfcode{add\_warning}}{\emph{warning}}{}
+Add a warning ``echo'' in the shell file
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{\texttt{str}} ({\hyperref[commands/apidoc/src:src.utilsSat.warning]{\sphinxcrossref{\emph{\texttt{warning}}}}} (\autopageref*{commands/apidoc/src:src.utilsSat.warning})) -- the text to echo
+
+\end{description}\end{quote}
\end{fulllineitems}
-\index{print\_color\_range() (in module src.printcolors)}
+\index{append() (src.fileEnviron.FileEnviron 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{commands/apidoc/src:src.fileEnviron.FileEnviron.append}\pysiglinewithargsret{\sphinxbfcode{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{int}} (\sphinxstyleliteralemphasis{\sphinxupquote{end}}) \textendash{} The smaller value.
+\textbf{\texttt{str}} (\emph{\texttt{sep}}) -- the environment variable to append
+
+\item {}
+\textbf{\texttt{str or list}} (\emph{\texttt{value}}) -- the value(s) to append to key
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{int}} \textendash{} The bigger value.
+\textbf{\texttt{str}} -- the separator string
\end{itemize}
\end{fulllineitems}
-\index{print\_value() (in module src.printcolors)}
+\index{append\_value() (src.fileEnviron.FileEnviron 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{commands/apidoc/src:src.fileEnviron.FileEnviron.append_value}\pysiglinewithargsret{\sphinxbfcode{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{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.
+\textbf{\texttt{str}} (\emph{\texttt{sep}}) -- the environment variable to append
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{int}} \textendash{} the level of verboseness.
+\textbf{\texttt{str}} -- the value to append to key
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the suffix to add at the end.
+\textbf{\texttt{str}} -- the separator string
\end{itemize}
\end{fulllineitems}
-\index{printc() (in module src.printcolors)}
+\index{command\_value() (src.fileEnviron.FileEnviron method)}
\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{commands/apidoc/src:src.fileEnviron.FileEnviron.command_value}\pysiglinewithargsret{\sphinxbfcode{command\_value}}{\emph{key}, \emph{command}}{}~\begin{description}
+\item[{Get the value given by the system command ``command'' }] \leavevmode
+and put it in the environment variable key.
+Has to be overwritten in the derived classes
+This can be seen as a virtual method
+
+\end{description}
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{code}}) \textendash{} The text to be printed.
+\textbf{\texttt{str}} (\emph{\texttt{command}}) -- the environment variable
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The color to use.
+\textbf{\texttt{str}} -- the command to execute
\end{itemize}
-\item[{Returns}] \leavevmode
-The colored text.
-
-\item[{Return type}] \leavevmode
-str
-
\end{description}\end{quote}
\end{fulllineitems}
-\index{printcError() (in module src.printcolors)}
+\index{finish() (src.fileEnviron.FileEnviron method)}
\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{commands/apidoc/src:src.fileEnviron.FileEnviron.finish}\pysiglinewithargsret{\sphinxbfcode{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{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{txt}}) \textendash{} The text to be printed.
-
-\item[{Returns}] \leavevmode
-The colored text.
-
-\item[{Return type}] \leavevmode
-str
+\textbf{\texttt{bool}} (\emph{\texttt{required}}) -- Do nothing if required is False
\end{description}\end{quote}
\end{fulllineitems}
-\index{printcHeader() (in module src.printcolors)}
+\index{get() (src.fileEnviron.FileEnviron method)}
\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
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.FileEnviron.get}\pysiglinewithargsret{\sphinxbfcode{get}}{\emph{key}}{}
+Get the value of the environment variable ``key''
\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
+\textbf{\texttt{str}} (\emph{\texttt{key}}) -- the environment variable
\end{description}\end{quote}
\end{fulllineitems}
-\index{printcHighlight() (in module src.printcolors)}
+\index{is\_defined() (src.fileEnviron.FileEnviron method)}
\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{commands/apidoc/src:src.fileEnviron.FileEnviron.is_defined}\pysiglinewithargsret{\sphinxbfcode{is\_defined}}{\emph{key}}{}
+Check if the key exists in the environment
\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
+\textbf{\texttt{str}} (\emph{\texttt{key}}) -- the environment variable to check
\end{description}\end{quote}
\end{fulllineitems}
-\index{printcInfo() (in module src.printcolors)}
+\index{prepend() (src.fileEnviron.FileEnviron method)}
\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{commands/apidoc/src:src.fileEnviron.FileEnviron.prepend}\pysiglinewithargsret{\sphinxbfcode{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
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{txt}}) \textendash{} The text to be printed.
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{\texttt{str}} (\emph{\texttt{sep}}) -- the environment variable to prepend
-\item[{Returns}] \leavevmode
-The colored text.
+\item {}
+\textbf{\texttt{str or list}} (\emph{\texttt{value}}) -- the value(s) to prepend to key
-\item[{Return type}] \leavevmode
-str
+\item {}
+\textbf{\texttt{str}} -- the separator string
+
+\end{itemize}
\end{description}\end{quote}
\end{fulllineitems}
-\index{printcLabel() (in module src.printcolors)}
+\index{prepend\_value() (src.fileEnviron.FileEnviron method)}
\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{commands/apidoc/src:src.fileEnviron.FileEnviron.prepend_value}\pysiglinewithargsret{\sphinxbfcode{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{txt}}) \textendash{} The text to be printed.
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{\texttt{str}} (\emph{\texttt{sep}}) -- the environment variable to prepend
-\item[{Returns}] \leavevmode
-The colored text.
+\item {}
+\textbf{\texttt{str}} -- the value to prepend to key
-\item[{Return type}] \leavevmode
-str
+\item {}
+\textbf{\texttt{str}} -- the separator string
+
+\end{itemize}
\end{description}\end{quote}
\end{fulllineitems}
-\index{printcSuccess() (in module src.printcolors)}
+\index{set() (src.fileEnviron.FileEnviron 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{commands/apidoc/src:src.fileEnviron.FileEnviron.set}\pysiglinewithargsret{\sphinxbfcode{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{txt}}) \textendash{} The text to be printed.
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{\texttt{str}} (\emph{\texttt{value}}) -- the environment variable to set
-\item[{Returns}] \leavevmode
-The colored text.
+\item {}
+\textbf{\texttt{str}} -- the value
-\item[{Return type}] \leavevmode
-str
+\end{itemize}
\end{description}\end{quote}
\end{fulllineitems}
-\index{printcWarning() (in module src.printcolors)}
-
-\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
-\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
-
-\end{description}\end{quote}
\end{fulllineitems}
+\index{LauncherFileEnviron (class in src.fileEnviron)}
-
-\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)}
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron}\pysiglinewithargsret{\sphinxstrong{class }\sphinxcode{src.fileEnviron.}\sphinxbfcode{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.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{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add}\pysiglinewithargsret{\sphinxbfcode{add}}{\emph{key}, \emph{value}}{}
+prepend value to key using sep
\begin{quote}\begin{description}
\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{})
+\textbf{\texttt{str}} (\emph{\texttt{value}}) -- the environment variable to prepend
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{Config}} \textendash{} The configuration specific to
-the product
+\textbf{\texttt{str}} -- the value to prepend to key
\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}
+\index{add\_comment() (src.fileEnviron.LauncherFileEnviron method)}
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add_comment}\pysiglinewithargsret{\sphinxbfcode{add\_comment}}{\emph{comment}}{}
\end{fulllineitems}
-\index{check\_installation() (in module src.product)}
+\index{add\_echo() (src.fileEnviron.LauncherFileEnviron method)}
\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{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add_echo}\pysiglinewithargsret{\sphinxbfcode{add\_echo}}{\emph{text}}{}
+Add a comment
\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
+\textbf{\texttt{str}} (\emph{\texttt{text}}) -- the comment to add
\end{description}\end{quote}
\end{fulllineitems}
-\index{check\_source() (in module src.product)}
+\index{add\_line() (src.fileEnviron.LauncherFileEnviron method)}
\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
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add_line}\pysiglinewithargsret{\sphinxbfcode{add\_line}}{\emph{number}}{}
+Add some empty lines in the launcher file
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
-the product
+\textbf{\texttt{int}} (\emph{\texttt{number}}) -- the number of lines to add
-\item[{Returns}] \leavevmode
-True if it is well installed
+\end{description}\end{quote}
-\item[{Return type}] \leavevmode
-boolean
+\end{fulllineitems}
+
+\index{add\_warning() (src.fileEnviron.LauncherFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add_warning}\pysiglinewithargsret{\sphinxbfcode{add\_warning}}{\emph{warning}}{}
+Add a warning
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{\texttt{str}} (\emph{\texttt{text}}) -- the warning to add
\end{description}\end{quote}
\end{fulllineitems}
-\index{get\_base\_install\_dir() (in module src.product)}
+\index{append() (src.fileEnviron.LauncherFileEnviron method)}
\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{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.append}\pysiglinewithargsret{\sphinxbfcode{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{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The global configuration
+\textbf{\texttt{str}} (\emph{\texttt{sep}}) -- the environment variable to append
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{Config}} \textendash{} The configuration specific to
-the product
+\textbf{\texttt{str or list}} (\emph{\texttt{value}}) -- the value(s) to append to key
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{version}}) \textendash{} The version of the product
+\textbf{\texttt{str}} -- the separator string
\end{itemize}
-\item[{Returns}] \leavevmode
-The path of the product installation
-
-\item[{Return type}] \leavevmode
-str
-
\end{description}\end{quote}
\end{fulllineitems}
-\index{get\_install\_dir() (in module src.product)}
+\index{append\_value() (src.fileEnviron.LauncherFileEnviron method)}
\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{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.append_value}\pysiglinewithargsret{\sphinxbfcode{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{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The global configuration
-
-\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
+\textbf{\texttt{str}} (\emph{\texttt{sep}}) -- the environment variable to append
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The version of the product
+\textbf{\texttt{str}} -- the value to append to key
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{Config}} \textendash{} The configuration specific to
-the product
+\textbf{\texttt{str}} -- the separator string
\end{itemize}
-\item[{Returns}] \leavevmode
-The path of the product installation
+\end{description}\end{quote}
-\item[{Return type}] \leavevmode
-str
+\end{fulllineitems}
-\end{description}\end{quote}
+\index{change\_to\_launcher() (src.fileEnviron.LauncherFileEnviron method)}
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.change_to_launcher}\pysiglinewithargsret{\sphinxbfcode{change\_to\_launcher}}{\emph{value}}{}
\end{fulllineitems}
-\index{get\_product\_components() (in module src.product)}
+\index{command\_value() (src.fileEnviron.LauncherFileEnviron method)}
\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{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.command_value}\pysiglinewithargsret{\sphinxbfcode{command\_value}}{\emph{key}, \emph{command}}{}~\begin{description}
+\item[{Get the value given by the system command ``command'' }] \leavevmode
+and put it in the environment variable key.
+
+\end{description}
\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 {}
+\textbf{\texttt{str}} (\emph{\texttt{command}}) -- the environment variable
-\item[{Returns}] \leavevmode
-The list of names of the components
+\item {}
+\textbf{\texttt{str}} -- the command to execute
-\item[{Return type}] \leavevmode
-List
+\end{itemize}
\end{description}\end{quote}
\end{fulllineitems}
-\index{get\_product\_config() (in module src.product)}
+\index{finish() (src.fileEnviron.LauncherFileEnviron method)}
\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{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.finish}\pysiglinewithargsret{\sphinxbfcode{finish}}{\emph{required=True}}{}~\begin{description}
+\item[{Add a final instruction in the out file (in case of file generation)}] \leavevmode
+In the particular launcher case, do nothing
+
+\end{description}
\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode\begin{itemize}
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} The global configuration
+\item[{Parameters}] \leavevmode
+\textbf{\texttt{bool}} (\emph{\texttt{required}}) -- Do nothing if required is False
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_name}}) \textendash{} The name of the product
+\end{description}\end{quote}
-\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)
+\end{fulllineitems}
-\end{itemize}
+\index{get() (src.fileEnviron.LauncherFileEnviron method)}
-\item[{Returns}] \leavevmode
-the specific configuration of the product
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.get}\pysiglinewithargsret{\sphinxbfcode{get}}{\emph{key}}{}
+Get the value of the environment variable ``key''
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{\texttt{str}} (\emph{\texttt{key}}) -- the environment variable
-\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{is\_defined() (src.fileEnviron.LauncherFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.is_defined}\pysiglinewithargsret{\sphinxbfcode{is\_defined}}{\emph{key}}{}
+Check if the key exists in the environment
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{\texttt{str}} (\emph{\texttt{key}}) -- the environment variable to check
\end{description}\end{quote}
\end{fulllineitems}
-\index{get\_product\_dependencies() (in module src.product)}
+\index{prepend() (src.fileEnviron.LauncherFileEnviron method)}
\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
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.prepend}\pysiglinewithargsret{\sphinxbfcode{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{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The global configuration
+\textbf{\texttt{str}} (\emph{\texttt{sep}}) -- the environment variable to prepend
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{Config}} \textendash{} The configuration specific to
-the product
+\textbf{\texttt{str or list}} (\emph{\texttt{value}}) -- the value(s) to prepend to key
-\end{itemize}
-
-\item[{Returns}] \leavevmode
-the list of products in dependence
+\item {}
+\textbf{\texttt{str}} -- the separator string
-\item[{Return type}] \leavevmode
-list
+\end{itemize}
\end{description}\end{quote}
\end{fulllineitems}
-\index{get\_product\_section() (in module src.product)}
+\index{prepend\_value() (src.fileEnviron.LauncherFileEnviron method)}
\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{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.prepend_value}\pysiglinewithargsret{\sphinxbfcode{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{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} The global configuration
-
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{section}}) \textendash{} The product name
+\textbf{\texttt{str}} (\emph{\texttt{sep}}) -- the environment variable to prepend
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The version of the product
+\textbf{\texttt{str}} -- the value to prepend to key
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The searched section (if not None, the section is
-explicitly given
+\textbf{\texttt{str}} -- the separator string
\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{get\_products\_infos() (in module src.product)}
+\index{set() (src.fileEnviron.LauncherFileEnviron 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
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.set}\pysiglinewithargsret{\sphinxbfcode{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{List}} (\sphinxstyleliteralemphasis{\sphinxupquote{lproducts}}) \textendash{} The list of product names
+\textbf{\texttt{str}} (\emph{\texttt{value}}) -- the environment variable to set
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} The global configuration
+\textbf{\texttt{str}} -- the value
\end{itemize}
-\item[{Returns}] \leavevmode
-the list of tuples
-(product name, specific configuration of the product)
-
-\item[{Return type}] \leavevmode
-{[}(str, {\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{product\_compiles() (in module src.product)}
-
-\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)
-\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
+\end{fulllineitems}
-\item[{Return type}] \leavevmode
-boolean
+\index{ScreenEnviron (class in src.fileEnviron)}
-\end{description}\end{quote}
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.ScreenEnviron}\pysiglinewithargsret{\sphinxstrong{class }\sphinxcode{src.fileEnviron.}\sphinxbfcode{ScreenEnviron}}{\emph{output}, \emph{environ=None}}{}
+Bases: {\hyperref[commands/apidoc/src:src.fileEnviron.FileEnviron]{\sphinxcrossref{\sphinxcode{src.fileEnviron.FileEnviron}}}} (\autopageref*{commands/apidoc/src:src.fileEnviron.FileEnviron})
+\index{add\_comment() (src.fileEnviron.ScreenEnviron method)}
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.ScreenEnviron.add_comment}\pysiglinewithargsret{\sphinxbfcode{add\_comment}}{\emph{comment}}{}
\end{fulllineitems}
-\index{product\_has\_env\_script() (in module src.product)}
+\index{add\_echo() (src.fileEnviron.ScreenEnviron 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
-\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
-the product
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.ScreenEnviron.add_echo}\pysiglinewithargsret{\sphinxbfcode{add\_echo}}{\emph{text}}{}
+\end{fulllineitems}
-\item[{Returns}] \leavevmode
-True if the product it has an environment script, else False
+\index{add\_line() (src.fileEnviron.ScreenEnviron method)}
-\item[{Return type}] \leavevmode
-boolean
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.ScreenEnviron.add_line}\pysiglinewithargsret{\sphinxbfcode{add\_line}}{\emph{number}}{}
+\end{fulllineitems}
-\end{description}\end{quote}
+\index{add\_warning() (src.fileEnviron.ScreenEnviron method)}
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.ScreenEnviron.add_warning}\pysiglinewithargsret{\sphinxbfcode{add\_warning}}{\emph{warning}}{}
\end{fulllineitems}
-\index{product\_has\_logo() (in module src.product)}
+\index{append() (src.fileEnviron.ScreenEnviron 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
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.ScreenEnviron.append}\pysiglinewithargsret{\sphinxbfcode{append}}{\emph{name}, \emph{value}, \emph{sep=':'}}{}
+\end{fulllineitems}
-\item[{Returns}] \leavevmode
-The path of the logo if the product has a logo, else False
+\index{command\_value() (src.fileEnviron.ScreenEnviron method)}
-\item[{Return type}] \leavevmode
-Str
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.ScreenEnviron.command_value}\pysiglinewithargsret{\sphinxbfcode{command\_value}}{\emph{key}, \emph{command}}{}
+\end{fulllineitems}
-\end{description}\end{quote}
+\index{get() (src.fileEnviron.ScreenEnviron method)}
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.ScreenEnviron.get}\pysiglinewithargsret{\sphinxbfcode{get}}{\emph{name}}{}
\end{fulllineitems}
-\index{product\_has\_patches() (in module src.product)}
+\index{is\_defined() (src.fileEnviron.ScreenEnviron 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
-\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
-the product
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.ScreenEnviron.is_defined}\pysiglinewithargsret{\sphinxbfcode{is\_defined}}{\emph{name}}{}
+\end{fulllineitems}
-\item[{Returns}] \leavevmode
-True if the product has one or more patches
+\index{prepend() (src.fileEnviron.ScreenEnviron method)}
-\item[{Return type}] \leavevmode
-boolean
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.ScreenEnviron.prepend}\pysiglinewithargsret{\sphinxbfcode{prepend}}{\emph{name}, \emph{value}, \emph{sep=':'}}{}
+\end{fulllineitems}
-\end{description}\end{quote}
+\index{run\_env\_script() (src.fileEnviron.ScreenEnviron method)}
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.ScreenEnviron.run_env_script}\pysiglinewithargsret{\sphinxbfcode{run\_env\_script}}{\emph{module}, \emph{script}}{}
\end{fulllineitems}
-\index{product\_has\_salome\_gui() (in module src.product)}
+\index{set() (src.fileEnviron.ScreenEnviron 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
-\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
-the product
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.ScreenEnviron.set}\pysiglinewithargsret{\sphinxbfcode{set}}{\emph{name}, \emph{value}}{}
+\end{fulllineitems}
-\item[{Returns}] \leavevmode
-True if the product has a SALOME gui, else False
+\index{write() (src.fileEnviron.ScreenEnviron method)}
-\item[{Return type}] \leavevmode
-Boolean
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fileEnviron.ScreenEnviron.write}\pysiglinewithargsret{\sphinxbfcode{write}}{\emph{command}, \emph{name}, \emph{value}, \emph{sign='='}}{}
+\end{fulllineitems}
-\end{description}\end{quote}
\end{fulllineitems}
-\index{product\_has\_script() (in module src.product)}
+\index{get\_file\_environ() (in module src.fileEnviron)}
\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{commands/apidoc/src:src.fileEnviron.get_file_environ}\pysiglinewithargsret{\sphinxcode{src.fileEnviron.}\sphinxbfcode{get\_file\_environ}}{\emph{output}, \emph{shell}, \emph{environ=None}}{}
+Instantiate correct FileEnvironment sub-class.
\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 {}
+\textbf{\texttt{file}} (\emph{\texttt{output}}) -- the output file stream.
-\item[{Returns}] \leavevmode
-True if the product it has a compilation script, else False
+\item {}
+\textbf{\texttt{str}} (\emph{\texttt{shell}}) -- the type of shell syntax to use.
-\item[{Return type}] \leavevmode
-boolean
+\item {}
+\textbf{\texttt{dict}} (\emph{\texttt{environ}}) -- a potential additional environment.
+
+\end{itemize}
\end{description}\end{quote}
\end{fulllineitems}
-\index{product\_is\_autotools() (in module src.product)}
+\index{special\_path\_separator() (in module src.fileEnviron)}
\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{commands/apidoc/src:src.fileEnviron.special_path_separator}\pysiglinewithargsret{\sphinxcode{src.fileEnviron.}\sphinxbfcode{special\_path\_separator}}{\emph{name}}{}~\begin{description}
+\item[{TCLLIBPATH, TKLIBPATH, PV\_PLUGIN\_PATH environments variables need}] \leavevmode
+some exotic path separator.
+This function gives the separator regarding the name of the variable
+to append or prepend.
+
+\end{description}
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
-the product
+\textbf{\texttt{str}} (\emph{\texttt{name}}) -- The name of the variable to find the separator
-\item[{Returns}] \leavevmode
-True if the product is autotools, else False
+\end{description}\end{quote}
-\item[{Return type}] \leavevmode
-boolean
+\end{fulllineitems}
-\end{description}\end{quote}
+
+
+\subsubsection{src.fork module}
+\label{commands/apidoc/src:module-src.fork}\label{commands/apidoc/src:src-fork-module}\index{src.fork (module)}\index{batch() (in module src.fork)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fork.batch}\pysiglinewithargsret{\sphinxcode{src.fork.}\sphinxbfcode{batch}}{\emph{cmd}, \emph{logger}, \emph{cwd}, \emph{args={[}{]}}, \emph{log=None}, \emph{delai=20}, \emph{sommeil=1}}{}
+Launch a batch
\end{fulllineitems}
-\index{product\_is\_cmake() (in module src.product)}
+\index{batch\_salome() (in module src.fork)}
\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
-\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
-the product
+\phantomsection\label{commands/apidoc/src:src.fork.batch_salome}\pysiglinewithargsret{\sphinxcode{src.fork.}\sphinxbfcode{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}}{}
+Launch a salome process
-\item[{Returns}] \leavevmode
-True if the product is cmake, else False
+\end{fulllineitems}
-\item[{Return type}] \leavevmode
-boolean
+\index{launch\_command() (in module src.fork)}
-\end{description}\end{quote}
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.fork.launch_command}\pysiglinewithargsret{\sphinxcode{src.fork.}\sphinxbfcode{launch\_command}}{\emph{cmd}, \emph{logger}, \emph{cwd}, \emph{args={[}{]}}, \emph{log=None}}{}
+Launch command
\end{fulllineitems}
-\index{product\_is\_cpp() (in module src.product)}
+\index{show\_progress() (in module src.fork)}
\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{commands/apidoc/src:src.fork.show_progress}\pysiglinewithargsret{\sphinxcode{src.fork.}\sphinxbfcode{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{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
-the product
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{\texttt{Logger}} (\emph{\texttt{logger}}) -- The logging instance
-\item[{Returns}] \leavevmode
-True if the product is a cpp, else False
+\item {}
+\textbf{\texttt{int}} (\emph{\texttt{delai}}) -- the number to display
-\item[{Return type}] \leavevmode
-boolean
+\item {}
+\textbf{\texttt{int}} -- the number max
+
+\item {}
+\textbf{\texttt{str}} (\emph{\texttt{ss}}) -- the string to display
+
+\end{itemize}
\end{description}\end{quote}
\end{fulllineitems}
-\index{product\_is\_debug() (in module src.product)}
+\index{write\_back() (in module src.fork)}
\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{commands/apidoc/src:src.fork.write_back}\pysiglinewithargsret{\sphinxcode{src.fork.}\sphinxbfcode{write\_back}}{\emph{logger}, \emph{message}}{}
+shortcut function to write at the begin of the line
\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 {}
+\textbf{\texttt{Logger}} (\emph{\texttt{logger}}) -- The logging instance
-\item[{Returns}] \leavevmode
-True if the product is in debug mode, else False
+\item {}
+\textbf{\texttt{str}} (\emph{\texttt{message}}) -- the text to display
-\item[{Return type}] \leavevmode
-boolean
+\item {}
+\textbf{\texttt{int}} (\emph{\texttt{level}}) -- the level of verbosity
+
+\end{itemize}
\end{description}\end{quote}
\end{fulllineitems}
-\index{product\_is\_dev() (in module src.product)}
-\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}}{}
+
+\subsubsection{src.loggingSat module}
+\label{commands/apidoc/src:module-src.loggingSat}\label{commands/apidoc/src:src-loggingsat-module}\index{src.loggingSat (module)}
+\url{http://sametmax.com/ecrire-des-logs-en-python/}
+\url{https://docs.python.org/3/library/time.html\#time.strftime}
+
+use logging package for salometools
+\begin{description}
+\item[{handler:}] \leavevmode
+on info() no format
+on other formatted indented on multi lines messages
+
+\end{description}
+\index{DefaultFormatter (class in src.loggingSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.loggingSat.DefaultFormatter}\pysiglinewithargsret{\sphinxstrong{class }\sphinxcode{src.loggingSat.}\sphinxbfcode{DefaultFormatter}}{\emph{fmt=None}, \emph{datefmt=None}}{}
+Bases: \sphinxcode{logging.Formatter}
+\index{format() (src.loggingSat.DefaultFormatter method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.loggingSat.DefaultFormatter.format}\pysiglinewithargsret{\sphinxbfcode{format}}{\emph{record}}{}
+\end{fulllineitems}
+
+\index{setColorLevelname() (src.loggingSat.DefaultFormatter method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.loggingSat.DefaultFormatter.setColorLevelname}\pysiglinewithargsret{\sphinxbfcode{setColorLevelname}}{\emph{levelname}}{}
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{UnittestFormatter (class in src.loggingSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.loggingSat.UnittestFormatter}\pysiglinewithargsret{\sphinxstrong{class }\sphinxcode{src.loggingSat.}\sphinxbfcode{UnittestFormatter}}{\emph{fmt=None}, \emph{datefmt=None}}{}
+Bases: \sphinxcode{logging.Formatter}
+\index{format() (src.loggingSat.UnittestFormatter method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.loggingSat.UnittestFormatter.format}\pysiglinewithargsret{\sphinxbfcode{format}}{\emph{record}}{}
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{UnittestStream (class in src.loggingSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.loggingSat.UnittestStream}\pysigline{\sphinxstrong{class }\sphinxcode{src.loggingSat.}\sphinxbfcode{UnittestStream}}
+Bases: \sphinxcode{object}
+
+write my stream class
+only write and flush are used for the streaming
+\url{https://docs.python.org/2/library/logging.handlers.html}
+\url{https://stackoverflow.com/questions/31999627/storing-logger-messages-in-a-string}
+\index{flush() (src.loggingSat.UnittestStream method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.loggingSat.UnittestStream.flush}\pysiglinewithargsret{\sphinxbfcode{flush}}{}{}
+\end{fulllineitems}
+
+\index{getLogs() (src.loggingSat.UnittestStream method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.loggingSat.UnittestStream.getLogs}\pysiglinewithargsret{\sphinxbfcode{getLogs}}{}{}
+\end{fulllineitems}
+
+\index{getLogsAndClear() (src.loggingSat.UnittestStream method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.loggingSat.UnittestStream.getLogsAndClear}\pysiglinewithargsret{\sphinxbfcode{getLogsAndClear}}{}{}
+\end{fulllineitems}
+
+\index{write() (src.loggingSat.UnittestStream method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.loggingSat.UnittestStream.write}\pysiglinewithargsret{\sphinxbfcode{write}}{\emph{astr}}{}
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{dirLogger() (in module src.loggingSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.loggingSat.dirLogger}\pysiglinewithargsret{\sphinxcode{src.loggingSat.}\sphinxbfcode{dirLogger}}{\emph{logger}}{}
+\end{fulllineitems}
+
+\index{getDefaultLogger() (in module src.loggingSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.loggingSat.getDefaultLogger}\pysiglinewithargsret{\sphinxcode{src.loggingSat.}\sphinxbfcode{getDefaultLogger}}{}{}
+\end{fulllineitems}
+
+\index{getUnittestLogger() (in module src.loggingSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.loggingSat.getUnittestLogger}\pysiglinewithargsret{\sphinxcode{src.loggingSat.}\sphinxbfcode{getUnittestLogger}}{}{}
+\end{fulllineitems}
+
+\index{indent() (in module src.loggingSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.loggingSat.indent}\pysiglinewithargsret{\sphinxcode{src.loggingSat.}\sphinxbfcode{indent}}{\emph{msg}, \emph{nb}, \emph{car=' `}}{}
+indent nb car (spaces) multi lines message except first one
+
+\end{fulllineitems}
+
+\index{indentUnittest() (in module src.loggingSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.loggingSat.indentUnittest}\pysiglinewithargsret{\sphinxcode{src.loggingSat.}\sphinxbfcode{indentUnittest}}{\emph{msg}, \emph{prefix=' \textbar{} `}}{}
+indent car multi lines message except first one
+car default is less spaces for size logs files
+keep human readable
+
+\end{fulllineitems}
+
+\index{initLoggerAsDefault() (in module src.loggingSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.loggingSat.initLoggerAsDefault}\pysiglinewithargsret{\sphinxcode{src.loggingSat.}\sphinxbfcode{initLoggerAsDefault}}{\emph{logger}, \emph{fmt=None}, \emph{level=None}}{}
+init logger as prefixed message and indented message if multi line
+exept info() outed `as it' without any format
+
+\end{fulllineitems}
+
+\index{initLoggerAsUnittest() (in module src.loggingSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.loggingSat.initLoggerAsUnittest}\pysiglinewithargsret{\sphinxcode{src.loggingSat.}\sphinxbfcode{initLoggerAsUnittest}}{\emph{logger}, \emph{fmt=None}, \emph{level=None}}{}
+init logger as silent on stdout/stderr
+used for retrieve messages in memory for post execution unittest
+\url{https://docs.python.org/2/library/logging.handlers.html}
+
+\end{fulllineitems}
+
+\index{log() (in module src.loggingSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.loggingSat.log}\pysiglinewithargsret{\sphinxcode{src.loggingSat.}\sphinxbfcode{log}}{\emph{msg}}{}
+elementary log when no logger yet
+
+\end{fulllineitems}
+
+\index{testLogger\_1() (in module src.loggingSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.loggingSat.testLogger_1}\pysiglinewithargsret{\sphinxcode{src.loggingSat.}\sphinxbfcode{testLogger\_1}}{\emph{logger}}{}
+small test
+
+\end{fulllineitems}
+
+
+
+\subsubsection{src.options module}
+\label{commands/apidoc/src:module-src.options}\label{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)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.options.OptResult}\pysigline{\sphinxstrong{class }\sphinxcode{src.options.}\sphinxbfcode{OptResult}}
+Bases: \sphinxcode{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.
+\begin{description}
+\item[{example: }] \leavevmode
+\textgreater{}\textgreater{} print(options.level)
+\textgreater{}\textgreater{} 5
+
+\end{description}
+
+\end{fulllineitems}
+
+\index{Options (class in src.options)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.options.Options}\pysigline{\sphinxstrong{class }\sphinxcode{src.options.}\sphinxbfcode{Options}}
+Bases: \sphinxcode{object}
+
+Class to manage all salomeTools options
+\index{add\_option() (src.options.Options method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.options.Options.add_option}\pysiglinewithargsret{\sphinxbfcode{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}
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{\texttt{str}} (\emph{\texttt{helpString}}) -- The short name of the option
+(ex ``l'' for level option).
+
+\item {}
+\textbf{\texttt{str}} -- The long name of the option
+(ex ``level'' for level option).
+
+\item {}
+\textbf{\texttt{str}} -- The type of the option (ex ``int'').
+
+\item {}
+\textbf{\texttt{str}} -- The name that will be used in the code.
+
+\item {}
+\textbf{\texttt{str}} -- The text to display
+when user ask for help on a command.
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+Nothing.
+
+\item[{Return type}] \leavevmode
+NA
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{debug\_write() (src.options.Options method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.options.Options.debug_write}\pysiglinewithargsret{\sphinxbfcode{debug\_write}}{}{}
+\end{fulllineitems}
+
+\index{getDetailOption() (src.options.Options method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.options.Options.getDetailOption}\pysiglinewithargsret{\sphinxbfcode{getDetailOption}}{\emph{option}}{}
+for convenience
+returns (shortName, longName, optionType, helpString')
+
+\end{fulllineitems}
+
+\index{get\_help() (src.options.Options method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.options.Options.get_help}\pysiglinewithargsret{\sphinxbfcode{get\_help}}{}{}
+Method that returns all options stored in self.options
+as help message colored string
+\begin{quote}\begin{description}
+\item[{Returns}] \leavevmode
+colored string
+
+\item[{Return type}] \leavevmode
+NA
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{indent() (src.options.Options method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.options.Options.indent}\pysiglinewithargsret{\sphinxbfcode{indent}}{\emph{text}, \emph{amount}, \emph{car=' `}}{}
+indent multi lines message
+
+\end{fulllineitems}
+
+\index{parse\_args() (src.options.Options method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.options.Options.parse_args}\pysiglinewithargsret{\sphinxbfcode{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}
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{\texttt{list}} (\emph{\texttt{argList}}) -- the raw list of arguments that were passed
+
+\item[{Returns}] \leavevmode
+optResult, args : optResult is the option instance
+to manipulate in the code. args
+is the full raw list of passed options
+
+\item[{Return type}] \leavevmode
+(class `common.options.OptResult',list)
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+
+
+\subsubsection{src.product module}
+\label{commands/apidoc/src:module-src.product}\label{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{commands/apidoc/src:src.product.check_config_exists}\pysiglinewithargsret{\sphinxcode{src.product.}\sphinxbfcode{check\_config\_exists}}{\emph{config}, \emph{prod\_dir}, \emph{prod\_info}}{}~\begin{description}
+\item[{Verify that the installation directory of a product in a base exists}] \leavevmode
+Check all the config-\textless{}i\textgreater{} directory and verify the sat-config.pyconf file
+that is in it
+
+\end{description}
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{\texttt{Config}} (\emph{\texttt{product\_info}}) -- The global configuration
+
+\item {}
+\textbf{\texttt{str}} (\emph{\texttt{prod\_dir}}) -- The product installation directory path
+(without config-\textless{}i\textgreater{})
+
+\item {}
+\textbf{\texttt{Config}} -- The configuration specific to
+the product
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+True or false is the installation is found or not
+and if it is found, the path of the found installation
+
+\item[{Return type}] \leavevmode
+(boolean, str)
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{check\_installation() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.product.check_installation}\pysiglinewithargsret{\sphinxcode{src.product.}\sphinxbfcode{check\_installation}}{\emph{product\_info}}{}~\begin{description}
+\item[{Verify if a product is well installed. Checks install directory presence}] \leavevmode
+and some additional files if it is defined in the config
+
+\end{description}
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{\texttt{Config}} (\emph{\texttt{product\_info}}) -- The configuration specific to
+the product
+
+\item[{Returns}] \leavevmode
+True if it is well installed
+
+\item[{Return type}] \leavevmode
+boolean
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_base\_install\_dir() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.product.get_base_install_dir}\pysiglinewithargsret{\sphinxcode{src.product.}\sphinxbfcode{get\_base\_install\_dir}}{\emph{config}, \emph{prod\_info}, \emph{version}}{}
+Compute the installation directory of a product in base
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{\texttt{Config}} (\emph{\texttt{product\_info}}) -- The global configuration
+
+\item {}
+\textbf{\texttt{Config}} -- The configuration specific to
+the product
+
+\item {}
+\textbf{\texttt{str}} (\emph{\texttt{version}}) -- The version of the product
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+The path of the product installation
+
+\item[{Return type}] \leavevmode
+str
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_install\_dir() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.product.get_install_dir}\pysiglinewithargsret{\sphinxcode{src.product.}\sphinxbfcode{get\_install\_dir}}{\emph{config}, \emph{base}, \emph{version}, \emph{prod\_info}}{}
+Compute the installation directory of a given product
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{\texttt{Config}} (\emph{\texttt{product\_info}}) -- The global configuration
+
+\item {}
+\textbf{\texttt{str}} (\emph{\texttt{version}}) -- This corresponds to the value given by user in its application.pyconf for the specific product. If ``yes'', the user wants the product to be in base. If ``no'', he wants the product to be in the application workdir
+
+\item {}
+\textbf{\texttt{str}} -- The version of the product
+
+\item {}
+\textbf{\texttt{Config}} -- The configuration specific to the product
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+The path of the product installation
+
+\item[{Return type}] \leavevmode
+str
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_product\_components() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.product.get_product_components}\pysiglinewithargsret{\sphinxcode{src.product.}\sphinxbfcode{get\_product\_components}}{\emph{product\_info}}{}
+Get the component list to generate with the product
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{\texttt{Config}} (\emph{\texttt{product\_info}}) -- The configuration specific to
+the product
+
+\item[{Returns}] \leavevmode
+The list of names of the components
+
+\item[{Return type}] \leavevmode
+List
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_product\_config() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.product.get_product_config}\pysiglinewithargsret{\sphinxcode{src.product.}\sphinxbfcode{get\_product\_config}}{\emph{config}, \emph{product\_name}, \emph{with\_install\_dir=True}}{}
+Get the specific configuration of a product from the global configuration
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{\texttt{Config}} (\emph{\texttt{config}}) -- The global configuration
+
+\item {}
+\textbf{\texttt{str}} (\emph{\texttt{product\_name}}) -- The name of the product
+
+\item {}
+\textbf{\texttt{boolean}} (\emph{\texttt{with\_install\_dir}}) -- If false, do not provide an install
+directory (at false only for internal use
+of the function check\_config\_exists)
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+the specific configuration of the product
+
+\item[{Return type}] \leavevmode
+{\hyperref[commands/apidoc/src:src.pyconf.Config]{\sphinxcrossref{Config}}} (\autopageref*{commands/apidoc/src:src.pyconf.Config})
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_product\_dependencies() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.product.get_product_dependencies}\pysiglinewithargsret{\sphinxcode{src.product.}\sphinxbfcode{get\_product\_dependencies}}{\emph{config}, \emph{product\_info}}{}~\begin{description}
+\item[{Get recursively the list of products that are }] \leavevmode
+in the product\_info dependencies
+
+\end{description}
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{\texttt{Config}} (\emph{\texttt{product\_info}}) -- The global configuration
+
+\item {}
+\textbf{\texttt{Config}} -- The configuration specific to
+the product
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+the list of products in dependence
+
+\item[{Return type}] \leavevmode
+{\hyperref[commands/apidoc/src:src.utilsSat.Path.list]{\sphinxcrossref{list}}} (\autopageref*{commands/apidoc/src:src.utilsSat.Path.list})
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_product\_section() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.product.get_product_section}\pysiglinewithargsret{\sphinxcode{src.product.}\sphinxbfcode{get\_product\_section}}{\emph{config}, \emph{product\_name}, \emph{version}, \emph{section=None}}{}
+Get the product description from the configuration
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{\texttt{Config}} (\emph{\texttt{config}}) -- The global configuration
+
+\item {}
+\textbf{\texttt{str}} (\emph{\texttt{section}}) -- The product name
+
+\item {}
+\textbf{\texttt{str}} -- The version of the product
+
+\item {}
+\textbf{\texttt{str}} -- The searched section (if not None, the section is
+explicitly given
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+The product description
+
+\item[{Return type}] \leavevmode
+{\hyperref[commands/apidoc/src:src.pyconf.Config]{\sphinxcrossref{Config}}} (\autopageref*{commands/apidoc/src:src.pyconf.Config})
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_products\_infos() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.product.get_products_infos}\pysiglinewithargsret{\sphinxcode{src.product.}\sphinxbfcode{get\_products\_infos}}{\emph{lproducts}, \emph{config}}{}
+Get the specific configuration of a list of products
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{\texttt{List}} (\emph{\texttt{lproducts}}) -- The list of product names
+
+\item {}
+\textbf{\texttt{Config}} (\emph{\texttt{config}}) -- The global configuration
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+the list of tuples
+(product name, specific configuration of the product)
+
+\item[{Return type}] \leavevmode
+{[}(str, Config){]}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{product\_compiles() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.product.product_compiles}\pysiglinewithargsret{\sphinxcode{src.product.}\sphinxbfcode{product\_compiles}}{\emph{product\_info}}{}~\begin{description}
+\item[{Know if a product compiles or not (some products do not have a }] \leavevmode
+compilation procedure)
+
+\end{description}
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{\texttt{Config}} (\emph{\texttt{product\_info}}) -- The configuration specific to
+the product
+
+\item[{Returns}] \leavevmode
+True if the product compiles, else False
+
+\item[{Return type}] \leavevmode
+boolean
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{product\_has\_env\_script() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.product.product_has_env_script}\pysiglinewithargsret{\sphinxcode{src.product.}\sphinxbfcode{product\_has\_env\_script}}{\emph{product\_info}}{}
+Know if a product has an environment script
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{\texttt{Config}} (\emph{\texttt{product\_info}}) -- The configuration specific to
+the product
+
+\item[{Returns}] \leavevmode
+True if the product it has an environment script, else False
+
+\item[{Return type}] \leavevmode
+boolean
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{product\_has\_logo() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.product.product_has_logo}\pysiglinewithargsret{\sphinxcode{src.product.}\sphinxbfcode{product\_has\_logo}}{\emph{product\_info}}{}
+Know if a product has a logo (YACSGEN generate)
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{\texttt{Config}} (\emph{\texttt{product\_info}}) -- The configuration specific to
+the product
+
+\item[{Returns}] \leavevmode
+The path of the logo if the product has a logo, else False
+
+\item[{Return type}] \leavevmode
+Str
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{product\_has\_patches() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.product.product_has_patches}\pysiglinewithargsret{\sphinxcode{src.product.}\sphinxbfcode{product\_has\_patches}}{\emph{product\_info}}{}
+Know if a product has one or more patches
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{\texttt{Config}} (\emph{\texttt{product\_info}}) -- The configuration specific to
+the product
+
+\item[{Returns}] \leavevmode
+True if the product has one or more patches
+
+\item[{Return type}] \leavevmode
+boolean
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{product\_has\_salome\_gui() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.product.product_has_salome_gui}\pysiglinewithargsret{\sphinxcode{src.product.}\sphinxbfcode{product\_has\_salome\_gui}}{\emph{product\_info}}{}
+Know if a product has a SALOME gui
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{\texttt{Config}} (\emph{\texttt{product\_info}}) -- The configuration specific to
+the product
+
+\item[{Returns}] \leavevmode
+True if the product has a SALOME gui, else False
+
+\item[{Return type}] \leavevmode
+Boolean
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{product\_has\_script() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.product.product_has_script}\pysiglinewithargsret{\sphinxcode{src.product.}\sphinxbfcode{product\_has\_script}}{\emph{product\_info}}{}
+Know if a product has a compilation script
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{\texttt{Config}} (\emph{\texttt{product\_info}}) -- The configuration specific to
+the product
+
+\item[{Returns}] \leavevmode
+True if the product it has a compilation script, else False
+
+\item[{Return type}] \leavevmode
+boolean
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{product\_is\_SALOME() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.product.product_is_SALOME}\pysiglinewithargsret{\sphinxcode{src.product.}\sphinxbfcode{product\_is\_SALOME}}{\emph{product\_info}}{}
+Know if a product is a SALOME module
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{\texttt{Config}} (\emph{\texttt{product\_info}}) -- The configuration specific to
+the product
+
+\item[{Returns}] \leavevmode
+True if the product is a SALOME module, else False
+
+\item[{Return type}] \leavevmode
+boolean
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{product\_is\_autotools() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.product.product_is_autotools}\pysiglinewithargsret{\sphinxcode{src.product.}\sphinxbfcode{product\_is\_autotools}}{\emph{product\_info}}{}
+Know if a product is compiled using the autotools
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{\texttt{Config}} (\emph{\texttt{product\_info}}) -- The configuration specific to
+the product
+
+\item[{Returns}] \leavevmode
+True if the product is autotools, else False
+
+\item[{Return type}] \leavevmode
+boolean
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{product\_is\_cmake() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.product.product_is_cmake}\pysiglinewithargsret{\sphinxcode{src.product.}\sphinxbfcode{product\_is\_cmake}}{\emph{product\_info}}{}
+Know if a product is compiled using the cmake
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{\texttt{Config}} (\emph{\texttt{product\_info}}) -- The configuration specific to
+the product
+
+\item[{Returns}] \leavevmode
+True if the product is cmake, else False
+
+\item[{Return type}] \leavevmode
+boolean
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{product\_is\_cpp() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.product.product_is_cpp}\pysiglinewithargsret{\sphinxcode{src.product.}\sphinxbfcode{product\_is\_cpp}}{\emph{product\_info}}{}
+Know if a product is cpp
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{\texttt{Config}} (\emph{\texttt{product\_info}}) -- The configuration specific to
+the product
+
+\item[{Returns}] \leavevmode
+True if the product is a cpp, else False
+
+\item[{Return type}] \leavevmode
+boolean
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{product\_is\_debug() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.product.product_is_debug}\pysiglinewithargsret{\sphinxcode{src.product.}\sphinxbfcode{product\_is\_debug}}{\emph{product\_info}}{}
+Know if a product is in debug mode
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{\texttt{Config}} (\emph{\texttt{product\_info}}) -- The configuration specific to
+the product
+
+\item[{Returns}] \leavevmode
+True if the product is in debug mode, else False
+
+\item[{Return type}] \leavevmode
+boolean
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{product\_is\_dev() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.product.product_is_dev}\pysiglinewithargsret{\sphinxcode{src.product.}\sphinxbfcode{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
+\textbf{\texttt{Config}} (\emph{\texttt{product\_info}}) -- The configuration specific to
the product
\item[{Returns}] \leavevmode
\index{product\_is\_fixed() (in module src.product)}
\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}}{}
+\phantomsection\label{commands/apidoc/src:src.product.product_is_fixed}\pysiglinewithargsret{\sphinxcode{src.product.}\sphinxbfcode{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
+\textbf{\texttt{Config}} (\emph{\texttt{product\_info}}) -- The configuration specific to
the product
\item[{Returns}] \leavevmode
\index{product\_is\_generated() (in module src.product)}
\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}}{}
+\phantomsection\label{commands/apidoc/src:src.product.product_is_generated}\pysiglinewithargsret{\sphinxcode{src.product.}\sphinxbfcode{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
+\textbf{\texttt{Config}} (\emph{\texttt{product\_info}}) -- The configuration specific to
the product
\item[{Returns}] \leavevmode
\index{product\_is\_mpi() (in module src.product)}
\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}}{}
+\phantomsection\label{commands/apidoc/src:src.product.product_is_mpi}\pysiglinewithargsret{\sphinxcode{src.product.}\sphinxbfcode{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
+\textbf{\texttt{Config}} (\emph{\texttt{product\_info}}) -- The configuration specific to
the product
\item[{Returns}] \leavevmode
\index{product\_is\_native() (in module src.product)}
\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}}{}
+\phantomsection\label{commands/apidoc/src:src.product.product_is_native}\pysiglinewithargsret{\sphinxcode{src.product.}\sphinxbfcode{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
+\textbf{\texttt{Config}} (\emph{\texttt{product\_info}}) -- The configuration specific to
the product
\item[{Returns}] \leavevmode
\index{product\_is\_salome() (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{commands/apidoc/src:src.product.product_is_salome}\pysiglinewithargsret{\sphinxcode{src.product.}\sphinxbfcode{product\_is\_salome}}{\emph{product\_info}}{}
+Know if a product is of type salome
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
+\textbf{\texttt{Config}} (\emph{\texttt{product\_info}}) -- The configuration specific to
the product
\item[{Returns}] \leavevmode
-True if the product is a SALOME module, else False
+True if the product is salome, else False
\item[{Return type}] \leavevmode
boolean
\index{product\_is\_sample() (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}}{}
+\phantomsection\label{commands/apidoc/src:src.product.product_is_sample}\pysiglinewithargsret{\sphinxcode{src.product.}\sphinxbfcode{product\_is\_sample}}{\emph{product\_info}}{}
Know if a product has the sample type
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
-\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
+\textbf{\texttt{Config}} (\emph{\texttt{product\_info}}) -- The configuration specific to
the product
\item[{Returns}] \leavevmode
\index{product\_is\_smesh\_plugin() (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}}{}
+\phantomsection\label{commands/apidoc/src:src.product.product_is_smesh_plugin}\pysiglinewithargsret{\sphinxcode{src.product.}\sphinxbfcode{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
+\textbf{\texttt{Config}} (\emph{\texttt{product\_info}}) -- The configuration specific to
the product
\item[{Returns}] \leavevmode
\index{product\_is\_vcs() (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}}{}
+\phantomsection\label{commands/apidoc/src:src.product.product_is_vcs}\pysiglinewithargsret{\sphinxcode{src.product.}\sphinxbfcode{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
+\textbf{\texttt{Config}} (\emph{\texttt{product\_info}}) -- The configuration specific to
the product
\item[{Returns}] \leavevmode
-\subsubsection{\sphinxstyleliteralintitle{\sphinxupquote{pyconf}} Module}
-\label{\detokenize{commands/apidoc/src:pyconf-module}}\label{\detokenize{commands/apidoc/src:module-src.pyconf}}\index{src.pyconf (module)}
+\subsubsection{src.pyconf module}
+\label{commands/apidoc/src:src-pyconf-module}\label{commands/apidoc/src:module-src.pyconf}\index{src.pyconf (module)}
This is a configuration module for Python.
This module should work under Python versions \textgreater{}= 2.2, and cannot be used with
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
+U\{distribution\textless{}\url{http://www.red-dove.com/python\_config}.html\textbar{}\_blank\textgreater{}\} (follow the
download link).
A simple example - with the example configuration file:
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
messages:
[
\PYGZob{}
name: Yves
\PYGZcb{}
]
-\end{sphinxVerbatim}
+\end{Verbatim}
a program to read the configuration would be:
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{k+kn}{from} \PYG{n+nn}{config} \PYG{k}{import} \PYG{n}{Config}
\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+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{Verbatim}
which, when run, would yield the console output:
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[commandchars=\\\{\}]
\PYG{n}{Welcome}\PYG{p}{,} \PYG{n}{Harry}
\PYG{n}{Welkom}\PYG{p}{,} \PYG{n}{Ruud}
\PYG{n}{Bienvenue}\PYG{p}{,} \PYG{n}{Yves}
-\end{sphinxVerbatim}
+\end{Verbatim}
-See U\{this tutorial\textless{}\sphinxurl{http://www.red-dove.com/python\_config}.html\textbar{}\_blank\textgreater{}\} for more
+See U\{this tutorial\textless{}\url{http://www.red-dove.com/python\_config}.html\textbar{}\_blank\textgreater{}\} for more
information.
\#modified for salomeTools
unable to open the stream, an IOError exception should be thrown.
The default value of this variable is L\{defaultStreamOpener\}. For an example
-of how it’s used, see test\_config.py (search for streamOpener).
+of how it's used, see test\_config.py (search for streamOpener).
\index{Config (class in src.pyconf)}
\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{commands/apidoc/src:src.pyconf.Config}\pysiglinewithargsret{\sphinxstrong{class }\sphinxcode{src.pyconf.}\sphinxbfcode{Config}}{\emph{streamOrFile=None}, \emph{parent=None}, \emph{PWD=None}}{}
+Bases: {\hyperref[commands/apidoc/src:src.pyconf.Mapping]{\sphinxcrossref{\sphinxcode{src.pyconf.Mapping}}}} (\autopageref*{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.Config.Namespace}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxbfcode{\sphinxupquote{Namespace}}}
-Bases: \sphinxcode{\sphinxupquote{object}}
+\phantomsection\label{commands/apidoc/src:src.pyconf.Config.Namespace}\pysigline{\sphinxstrong{class }\sphinxbfcode{Namespace}}
+Bases: \sphinxcode{object}
This internal class is used for implementing default namespaces.
\index{addNamespace() (src.pyconf.Config method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Config.addNamespace}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{addNamespace}}}{\emph{ns}, \emph{name=None}}{}
+\phantomsection\label{commands/apidoc/src:src.pyconf.Config.addNamespace}\pysiglinewithargsret{\sphinxcode{Config.}\sphinxbfcode{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.
\index{getByPath() (src.pyconf.Config method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Config.getByPath}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getByPath}}}{\emph{path}}{}
+\phantomsection\label{commands/apidoc/src:src.pyconf.Config.getByPath}\pysiglinewithargsret{\sphinxcode{Config.}\sphinxbfcode{getByPath}}{\emph{path}}{}
Obtain a value in the configuration via its path.
@param path: The path of the required value
@type path: str
\index{load() (src.pyconf.Config method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Config.load}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{load}}}{\emph{stream}}{}
+\phantomsection\label{commands/apidoc/src:src.pyconf.Config.load}\pysiglinewithargsret{\sphinxcode{Config.}\sphinxbfcode{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.
\index{removeNamespace() (src.pyconf.Config method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Config.removeNamespace}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{removeNamespace}}}{\emph{ns}, \emph{name=None}}{}
+\phantomsection\label{commands/apidoc/src:src.pyconf.Config.removeNamespace}\pysiglinewithargsret{\sphinxcode{Config.}\sphinxbfcode{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
\index{ConfigError}
\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{commands/apidoc/src:src.pyconf.ConfigError}\pysigline{\sphinxstrong{exception }\sphinxcode{src.pyconf.}\sphinxbfcode{ConfigError}}
+Bases: \sphinxcode{exceptions.Exception}
This is the base class of exceptions raised by this module.
\index{ConfigFormatError}
\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}})
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigFormatError}\pysigline{\sphinxstrong{exception }\sphinxcode{src.pyconf.}\sphinxbfcode{ConfigFormatError}}
+Bases: {\hyperref[commands/apidoc/src:src.pyconf.ConfigError]{\sphinxcrossref{\sphinxcode{src.pyconf.ConfigError}}}} (\autopageref*{commands/apidoc/src:src.pyconf.ConfigError})
This is the base class of exceptions raised due to syntax errors in
configurations.
\index{ConfigInputStream (class in src.pyconf)}
\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}}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigInputStream}\pysiglinewithargsret{\sphinxstrong{class }\sphinxcode{src.pyconf.}\sphinxbfcode{ConfigInputStream}}{\emph{stream}}{}
+Bases: \sphinxcode{object}
An input stream which can read either ANSI files with default encoding
or Unicode files with BOMs.
\index{close() (src.pyconf.ConfigInputStream method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigInputStream.close}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{close}}}{}{}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigInputStream.close}\pysiglinewithargsret{\sphinxbfcode{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}}{}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigInputStream.read}\pysiglinewithargsret{\sphinxbfcode{read}}{\emph{size}}{}
\end{fulllineitems}
\index{readline() (src.pyconf.ConfigInputStream method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigInputStream.readline}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{readline}}}{}{}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigInputStream.readline}\pysiglinewithargsret{\sphinxbfcode{readline}}{}{}
\end{fulllineitems}
\index{ConfigList (class in src.pyconf)}
\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}}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigList}\pysigline{\sphinxstrong{class }\sphinxcode{src.pyconf.}\sphinxbfcode{ConfigList}}
+Bases: \sphinxcode{list}
This class implements an ordered list of configurations and allows you
to try getting the configuration from each entry in turn, returning
\index{getByPath() (src.pyconf.ConfigList method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigList.getByPath}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getByPath}}}{\emph{path}}{}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigList.getByPath}\pysiglinewithargsret{\sphinxbfcode{getByPath}}{\emph{path}}{}
Obtain a value from the first configuration in the list which defines
it.
\index{ConfigMerger (class in src.pyconf)}
\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{commands/apidoc/src:src.pyconf.ConfigMerger}\pysiglinewithargsret{\sphinxstrong{class }\sphinxcode{src.pyconf.}\sphinxbfcode{ConfigMerger}}{\emph{resolver=\textless{}function defaultMergeResolve\textgreater{}}}{}
+Bases: \sphinxcode{object}
This class is used for merging two configurations. If a key exists in the
merge operand but not the merge target, then the entry is copied from the
\index{handleMismatch() (src.pyconf.ConfigMerger method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigMerger.handleMismatch}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{handleMismatch}}}{\emph{obj1}, \emph{obj2}}{}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigMerger.handleMismatch}\pysiglinewithargsret{\sphinxbfcode{handleMismatch}}{\emph{obj1}, \emph{obj2}}{}
Handle a mismatch between two objects.
@param obj1: The object to merge into.
\index{merge() (src.pyconf.ConfigMerger method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigMerger.merge}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{merge}}}{\emph{merged}, \emph{mergee}}{}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigMerger.merge}\pysiglinewithargsret{\sphinxbfcode{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.
\index{mergeMapping() (src.pyconf.ConfigMerger method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigMerger.mergeMapping}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{mergeMapping}}}{\emph{map1}, \emph{map2}}{}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigMerger.mergeMapping}\pysiglinewithargsret{\sphinxbfcode{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{mergeSequence() (src.pyconf.ConfigMerger method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigMerger.mergeSequence}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{mergeSequence}}}{\emph{seq1}, \emph{seq2}}{}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigMerger.mergeSequence}\pysiglinewithargsret{\sphinxbfcode{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.
\index{overwriteKeys() (src.pyconf.ConfigMerger method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigMerger.overwriteKeys}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{overwriteKeys}}}{\emph{map1}, \emph{seq2}}{}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigMerger.overwriteKeys}\pysiglinewithargsret{\sphinxbfcode{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.
\index{ConfigOutputStream (class in src.pyconf)}
\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{commands/apidoc/src:src.pyconf.ConfigOutputStream}\pysiglinewithargsret{\sphinxstrong{class }\sphinxcode{src.pyconf.}\sphinxbfcode{ConfigOutputStream}}{\emph{stream}, \emph{encoding=None}}{}
+Bases: \sphinxcode{object}
An output stream which can write either ANSI files with default encoding
or Unicode files with BOMs.
\index{close() (src.pyconf.ConfigOutputStream method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigOutputStream.close}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{close}}}{}{}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigOutputStream.close}\pysiglinewithargsret{\sphinxbfcode{close}}{}{}
\end{fulllineitems}
\index{flush() (src.pyconf.ConfigOutputStream method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigOutputStream.flush}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{flush}}}{}{}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigOutputStream.flush}\pysiglinewithargsret{\sphinxbfcode{flush}}{}{}
\end{fulllineitems}
\index{write() (src.pyconf.ConfigOutputStream method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigOutputStream.write}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write}}}{\emph{data}}{}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigOutputStream.write}\pysiglinewithargsret{\sphinxbfcode{write}}{\emph{data}}{}
\end{fulllineitems}
\index{ConfigReader (class in src.pyconf)}
\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{commands/apidoc/src:src.pyconf.ConfigReader}\pysiglinewithargsret{\sphinxstrong{class }\sphinxcode{src.pyconf.}\sphinxbfcode{ConfigReader}}{\emph{config}}{}
+Bases: \sphinxcode{object}
This internal class implements a parser for configurations.
\index{getChar() (src.pyconf.ConfigReader method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.getChar}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getChar}}}{}{}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigReader.getChar}\pysiglinewithargsret{\sphinxbfcode{getChar}}{}{}
Get the next char from the stream. Update line and column numbers
appropriately.
\index{getToken() (src.pyconf.ConfigReader method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.getToken}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getToken}}}{}{}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigReader.getToken}\pysiglinewithargsret{\sphinxbfcode{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).
\index{load() (src.pyconf.ConfigReader method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.load}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{load}}}{\emph{stream}, \emph{parent=None}, \emph{suffix=None}}{}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigReader.load}\pysiglinewithargsret{\sphinxbfcode{load}}{\emph{stream}, \emph{parent=None}, \emph{suffix=None}}{}
Load the configuration from the specified stream.
@param stream: A stream from which to load the configuration.
\index{location() (src.pyconf.ConfigReader method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.location}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{location}}}{}{}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigReader.location}\pysiglinewithargsret{\sphinxbfcode{location}}{}{}
Return the current location (filename, line, column) in the stream
as a string.
\index{match() (src.pyconf.ConfigReader method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.match}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{match}}}{\emph{t}}{}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigReader.match}\pysiglinewithargsret{\sphinxbfcode{match}}{\emph{t}}{}
Ensure that the current token type matches the specified value, and
advance to the next token.
@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.
+@raise ConfigFormatError: If the token does not match what's expected.
\end{fulllineitems}
\index{parseFactor() (src.pyconf.ConfigReader method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseFactor}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseFactor}}}{}{}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigReader.parseFactor}\pysiglinewithargsret{\sphinxbfcode{parseFactor}}{}{}
Parse a factor in an multiplicative expression (a * b, a / b, a \% b)
@return: the parsed factor
\index{parseKeyValuePair() (src.pyconf.ConfigReader method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseKeyValuePair}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseKeyValuePair}}}{\emph{parent}}{}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigReader.parseKeyValuePair}\pysiglinewithargsret{\sphinxbfcode{parseKeyValuePair}}{\emph{parent}}{}
Parse a key-value pair, and add it to the provided L\{Mapping\}.
@param parent: The mapping to add entries to.
\index{parseMapping() (src.pyconf.ConfigReader method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseMapping}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseMapping}}}{\emph{parent}, \emph{suffix}}{}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigReader.parseMapping}\pysiglinewithargsret{\sphinxbfcode{parseMapping}}{\emph{parent}, \emph{suffix}}{}
Parse a mapping.
@param parent: The container to which the mapping will be added.
\index{parseMappingBody() (src.pyconf.ConfigReader method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseMappingBody}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseMappingBody}}}{\emph{parent}}{}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigReader.parseMappingBody}\pysiglinewithargsret{\sphinxbfcode{parseMappingBody}}{\emph{parent}}{}
Parse the internals of a mapping, and add entries to the provided
L\{Mapping\}.
\index{parseReference() (src.pyconf.ConfigReader method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseReference}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseReference}}}{\emph{type}}{}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigReader.parseReference}\pysiglinewithargsret{\sphinxbfcode{parseReference}}{\emph{type}}{}
Parse a reference.
@return: the parsed reference
\index{parseScalar() (src.pyconf.ConfigReader method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseScalar}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseScalar}}}{}{}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigReader.parseScalar}\pysiglinewithargsret{\sphinxbfcode{parseScalar}}{}{}
Parse a scalar - a terminal value such as a string or number, or
an L\{Expression\} or L\{Reference\}.
\index{parseSequence() (src.pyconf.ConfigReader method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseSequence}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseSequence}}}{\emph{parent}, \emph{suffix}}{}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigReader.parseSequence}\pysiglinewithargsret{\sphinxbfcode{parseSequence}}{\emph{parent}, \emph{suffix}}{}
Parse a sequence.
@param parent: The container to which the sequence will be added.
\index{parseSuffix() (src.pyconf.ConfigReader method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseSuffix}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseSuffix}}}{\emph{ref}}{}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigReader.parseSuffix}\pysiglinewithargsret{\sphinxbfcode{parseSuffix}}{\emph{ref}}{}
Parse a reference suffix.
@param ref: The reference of which this suffix is a part.
\index{parseTerm() (src.pyconf.ConfigReader method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseTerm}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseTerm}}}{}{}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigReader.parseTerm}\pysiglinewithargsret{\sphinxbfcode{parseTerm}}{}{}
Parse a term in an additive expression (a + b, a - b)
@return: the parsed term
\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}}{}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigReader.parseValue}\pysiglinewithargsret{\sphinxbfcode{parseValue}}{\emph{parent}, \emph{suffix}}{}
Parse a value.
@param parent: The container to which the value will be added.
\index{setStream() (src.pyconf.ConfigReader method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.setStream}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{setStream}}}{\emph{stream}}{}
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigReader.setStream}\pysiglinewithargsret{\sphinxbfcode{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.
\index{ConfigResolutionError}
\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}})
+\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigResolutionError}\pysigline{\sphinxstrong{exception }\sphinxcode{src.pyconf.}\sphinxbfcode{ConfigResolutionError}}
+Bases: {\hyperref[commands/apidoc/src:src.pyconf.ConfigError]{\sphinxcrossref{\sphinxcode{src.pyconf.ConfigError}}}} (\autopageref*{commands/apidoc/src:src.pyconf.ConfigError})
This is the base class of exceptions raised due to semantic errors in
configurations.
\index{Container (class in src.pyconf)}
\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{commands/apidoc/src:src.pyconf.Container}\pysiglinewithargsret{\sphinxstrong{class }\sphinxcode{src.pyconf.}\sphinxbfcode{Container}}{\emph{parent}}{}
+Bases: \sphinxcode{object}
This internal class is the base class for mappings and sequences.
Example:
-\fvset{hllines={, ,}}%
-\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\begin{Verbatim}[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}
+\end{Verbatim}
\index{evaluate() (src.pyconf.Container method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Container.evaluate}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{evaluate}}}{\emph{item}}{}
+\phantomsection\label{commands/apidoc/src:src.pyconf.Container.evaluate}\pysiglinewithargsret{\sphinxbfcode{evaluate}}{\emph{item}}{}
Evaluate items which are instances of L\{Reference\} or L\{Expression\}.
L\{Reference\} instances are evaluated using L\{Reference.resolve\},
\index{setPath() (src.pyconf.Container method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Container.setPath}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{setPath}}}{\emph{path}}{}
+\phantomsection\label{commands/apidoc/src:src.pyconf.Container.setPath}\pysiglinewithargsret{\sphinxbfcode{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.
\index{writeToStream() (src.pyconf.Container method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Container.writeToStream}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{writeToStream}}}{\emph{stream}, \emph{indent}, \emph{container}}{}
+\phantomsection\label{commands/apidoc/src:src.pyconf.Container.writeToStream}\pysiglinewithargsret{\sphinxbfcode{writeToStream}}{\emph{stream}, \emph{indent}, \emph{container}}{}
Write this instance to a stream at the specified indentation level.
Should be redefined in subclasses.
\index{writeValue() (src.pyconf.Container 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{commands/apidoc/src:src.pyconf.Container.writeValue}\pysiglinewithargsret{\sphinxbfcode{writeValue}}{\emph{value}, \emph{stream}, \emph{indent}}{}
\end{fulllineitems}
\index{Expression (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{commands/apidoc/src:src.pyconf.Expression}\pysiglinewithargsret{\sphinxstrong{class }\sphinxcode{src.pyconf.}\sphinxbfcode{Expression}}{\emph{op}, \emph{lhs}, \emph{rhs}}{}
+Bases: \sphinxcode{object}
This internal class implements a value which is obtained by evaluating an expression.
\index{evaluate() (src.pyconf.Expression method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Expression.evaluate}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{evaluate}}}{\emph{container}}{}
+\phantomsection\label{commands/apidoc/src:src.pyconf.Expression.evaluate}\pysiglinewithargsret{\sphinxbfcode{evaluate}}{\emph{container}}{}
Evaluate this instance in the context of a container.
@param container: The container to evaluate in from.
\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}})
+\phantomsection\label{commands/apidoc/src:src.pyconf.Mapping}\pysiglinewithargsret{\sphinxstrong{class }\sphinxcode{src.pyconf.}\sphinxbfcode{Mapping}}{\emph{parent=None}}{}
+Bases: {\hyperref[commands/apidoc/src:src.pyconf.Container]{\sphinxcrossref{\sphinxcode{src.pyconf.Container}}}} (\autopageref*{commands/apidoc/src:src.pyconf.Container})
This internal class implements key-value mappings in configurations.
\index{addMapping() (src.pyconf.Mapping 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}}{}
+\phantomsection\label{commands/apidoc/src:src.pyconf.Mapping.addMapping}\pysiglinewithargsret{\sphinxbfcode{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.
\index{get() (src.pyconf.Mapping method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Mapping.get}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get}}}{\emph{key}, \emph{default=None}}{}
+\phantomsection\label{commands/apidoc/src:src.pyconf.Mapping.get}\pysiglinewithargsret{\sphinxbfcode{get}}{\emph{key}, \emph{default=None}}{}
Allows a dictionary-style get operation.
\end{fulllineitems}
\index{iteritems() (src.pyconf.Mapping method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Mapping.iteritems}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{iteritems}}}{}{}
+\phantomsection\label{commands/apidoc/src:src.pyconf.Mapping.iteritems}\pysiglinewithargsret{\sphinxbfcode{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}}}{}{}
+\phantomsection\label{commands/apidoc/src:src.pyconf.Mapping.iterkeys}\pysiglinewithargsret{\sphinxbfcode{iterkeys}}{}{}
\end{fulllineitems}
\index{keys() (src.pyconf.Mapping method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Mapping.keys}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{keys}}}{}{}
+\phantomsection\label{commands/apidoc/src:src.pyconf.Mapping.keys}\pysiglinewithargsret{\sphinxbfcode{keys}}{}{}
Return the keys in a similar way to a dictionary.
\end{fulllineitems}
\index{writeToStream() (src.pyconf.Mapping method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Mapping.writeToStream}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{writeToStream}}}{\emph{stream}, \emph{indent}, \emph{container}}{}
+\phantomsection\label{commands/apidoc/src:src.pyconf.Mapping.writeToStream}\pysiglinewithargsret{\sphinxbfcode{writeToStream}}{\emph{stream}, \emph{indent}, \emph{container}}{}
Write this instance to a stream at the specified indentation level.
Should be redefined in subclasses.
\index{Reference (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}}{}
-Bases: \sphinxcode{\sphinxupquote{object}}
+\phantomsection\label{commands/apidoc/src:src.pyconf.Reference}\pysiglinewithargsret{\sphinxstrong{class }\sphinxcode{src.pyconf.}\sphinxbfcode{Reference}}{\emph{config}, \emph{type}, \emph{ident}}{}
+Bases: \sphinxcode{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}}{}
+\phantomsection\label{commands/apidoc/src:src.pyconf.Reference.addElement}\pysiglinewithargsret{\sphinxbfcode{addElement}}{\emph{type}, \emph{ident}}{}
Add an element to the reference.
@param type: The type of reference.
\index{findConfig() (src.pyconf.Reference method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Reference.findConfig}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{findConfig}}}{\emph{container}}{}
+\phantomsection\label{commands/apidoc/src:src.pyconf.Reference.findConfig}\pysiglinewithargsret{\sphinxbfcode{findConfig}}{\emph{container}}{}
Find the closest enclosing configuration to the specified container.
@param container: The container to start from.
\index{resolve() (src.pyconf.Reference method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Reference.resolve}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{resolve}}}{\emph{container}}{}
+\phantomsection\label{commands/apidoc/src:src.pyconf.Reference.resolve}\pysiglinewithargsret{\sphinxbfcode{resolve}}{\emph{container}}{}
Resolve this instance in the context of a container.
@param container: The container to resolve from.
\index{Sequence (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{commands/apidoc/src:src.pyconf.Sequence}\pysiglinewithargsret{\sphinxstrong{class }\sphinxcode{src.pyconf.}\sphinxbfcode{Sequence}}{\emph{parent=None}}{}
+Bases: {\hyperref[commands/apidoc/src:src.pyconf.Container]{\sphinxcrossref{\sphinxcode{src.pyconf.Container}}}} (\autopageref*{commands/apidoc/src:src.pyconf.Container})
This internal class implements a value which is a sequence of other values.
\index{Sequence.SeqIter (class in src.pyconf)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Sequence.SeqIter}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxbfcode{\sphinxupquote{SeqIter}}}{\emph{seq}}{}
-Bases: \sphinxcode{\sphinxupquote{object}}
+\phantomsection\label{commands/apidoc/src:src.pyconf.Sequence.SeqIter}\pysiglinewithargsret{\sphinxstrong{class }\sphinxbfcode{SeqIter}}{\emph{seq}}{}
+Bases: \sphinxcode{object}
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.pyconf.Sequence.SeqIter.next}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{next}}}{}{}
+\phantomsection\label{commands/apidoc/src:src.pyconf.Sequence.SeqIter.next}\pysiglinewithargsret{\sphinxbfcode{next}}{}{}
\end{fulllineitems}
\index{append() (src.pyconf.Sequence method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Sequence.append}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append}}}{\emph{item}, \emph{comment}}{}
+\phantomsection\label{commands/apidoc/src:src.pyconf.Sequence.append}\pysiglinewithargsret{\sphinxcode{Sequence.}\sphinxbfcode{append}}{\emph{item}, \emph{comment}}{}
Add an item to the sequence.
@param item: The item to add.
\index{writeToStream() (src.pyconf.Sequence method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Sequence.writeToStream}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{writeToStream}}}{\emph{stream}, \emph{indent}, \emph{container}}{}
+\phantomsection\label{commands/apidoc/src:src.pyconf.Sequence.writeToStream}\pysiglinewithargsret{\sphinxcode{Sequence.}\sphinxbfcode{writeToStream}}{\emph{stream}, \emph{indent}, \emph{container}}{}
Write this instance to a stream at the specified indentation level.
Should be redefined in subclasses.
\index{deepCopyMapping() (in module src.pyconf)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.deepCopyMapping}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{deepCopyMapping}}}{\emph{inMapping}}{}
+\phantomsection\label{commands/apidoc/src:src.pyconf.deepCopyMapping}\pysiglinewithargsret{\sphinxcode{src.pyconf.}\sphinxbfcode{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}}{}
+\phantomsection\label{commands/apidoc/src:src.pyconf.defaultMergeResolve}\pysiglinewithargsret{\sphinxcode{src.pyconf.}\sphinxbfcode{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.
@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
+@return: One of ``merge'', ``append'', ``mismatch'' or ``overwrite''
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
+there is no point returning ``merge'' if the two objects
are instances of L\{Sequence\}.
+@rtype: str
+
+\end{fulllineitems}
+
+\index{defaultStreamOpener() (in module src.pyconf)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.defaultStreamOpener}\pysiglinewithargsret{\sphinxcode{src.pyconf.}\sphinxbfcode{defaultStreamOpener}}{\emph{name}}{}
+This function returns a read-only stream, given its name. The name passed
+in should correspond to an existing stream, otherwise an exception will be
+raised.
+
+This is the default value of L\{streamOpener\}; assign your own callable to
+streamOpener to return streams based on names. For example, you could use
+urllib2.urlopen().
+
+@param name: The name of a stream, most commonly a file name.
+@type name: str
+@return: A stream with the specified name.
+@rtype: A read-only stream (file-like object)
+
+\end{fulllineitems}
+
+\index{isWord() (in module src.pyconf)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.isWord}\pysiglinewithargsret{\sphinxcode{src.pyconf.}\sphinxbfcode{isWord}}{\emph{s}}{}
+See if a passed-in value is an identifier. If the value passed in is not a
+string, False is returned. An identifier consists of alphanumerics or
+underscore characters.
+
+Examples:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+\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{Verbatim}
+
+@note: isWord(`9abc') will return True - not exactly correct, but adequate
+for the way it's used here.
+
+@param s: The name to be tested
+@type s: any
+@return: True if a word, else False
+@rtype: bool
+
+\end{fulllineitems}
+
+\index{makePath() (in module src.pyconf)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.makePath}\pysiglinewithargsret{\sphinxcode{src.pyconf.}\sphinxbfcode{makePath}}{\emph{prefix}, \emph{suffix}}{}
+Make a path from a prefix and suffix.
+
+Examples::
+makePath(`', `suffix') -\textgreater{} `suffix'
+makePath(`prefix', `suffix') -\textgreater{} `prefix.suffix'
+makePath(`prefix', `{[}1{]}') -\textgreater{} `prefix{[}1{]}'
+
+@param prefix: The prefix to use. If it evaluates as false, the suffix is returned.
+@type prefix: str
+@param suffix: The suffix to use. It is either an identifier or an index in brackets.
+@type suffix: str
+@return: The path concatenation of prefix and suffix, with a dot if the suffix is not a bracketed index.
+@rtype: str
+
+\end{fulllineitems}
+
+\index{overwriteMergeResolve() (in module src.pyconf)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.pyconf.overwriteMergeResolve}\pysiglinewithargsret{\sphinxcode{src.pyconf.}\sphinxbfcode{overwriteMergeResolve}}{\emph{map1}, \emph{map2}, \emph{key}}{}
+An overwriting resolver for merge conflicts. Calls L\{defaultMergeResolve\},
+but where a ``mismatch'' is detected, returns ``overwrite'' instead.
+
+@param map1: The map being merged into.
+@type map1: L\{Mapping\}.
+@param map2: The map being used as the merge operand.
+@type map2: L\{Mapping\}.
+@param key: The key in map2 (which also exists in map1).
+@type key: str
+
+\end{fulllineitems}
+
+
+
+\subsubsection{src.returnCode module}
+\label{commands/apidoc/src:module-src.returnCode}\label{commands/apidoc/src:src-returncode-module}\index{src.returnCode (module)}
+This file contains ReturnCode class
+usage:
+\textgreater{}\textgreater{} import returnCode as RCO
+\index{ReturnCode (class in src.returnCode)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.returnCode.ReturnCode}\pysiglinewithargsret{\sphinxstrong{class }\sphinxcode{src.returnCode.}\sphinxbfcode{ReturnCode}}{\emph{status=None}, \emph{why=None}, \emph{value=None}}{}
+Bases: \sphinxcode{object}
+
+assume simple return code for methods, with explanation as `why'
+obviously why is why it is not OK,
+but also why is why it is OK (if you want).
+and optionnaly contains a return value as self.getValue()
+\begin{description}
+\item[{usage:}] \leavevmode
+\textgreater{}\textgreater{} import returnCode as RCO
+
+\textgreater{}\textgreater{} aValue = doSomethingToReturn()
+\textgreater{}\textgreater{} return RCO.ReturnCode(``KO'', ``there is no problem here'', aValue)
+\textgreater{}\textgreater{} return RCO.ReturnCode(``KO'', ``there is a problem here because etc'', None)
+\textgreater{}\textgreater{} return RCO.ReturnCode(``TIMEOUT\_STATUS'', ``too long here because etc'')
+\textgreater{}\textgreater{} return RCO.ReturnCode(``NA'', ``not applicable here because etc'')
+
+\textgreater{}\textgreater{} rc = doSomething()
+\textgreater{}\textgreater{} print(``short returnCode string'', str(rc))
+\textgreater{}\textgreater{} print(``long returnCode string with value'', repr(rc))
+
+\textgreater{}\textgreater{} rc1 = RCO.ReturnCode(``OK'', ...)
+\textgreater{}\textgreater{} rc2 = RCO.ReturnCode(``KO'', ...)
+\textgreater{}\textgreater{} rcFinal = rc1 + rc2
+\textgreater{}\textgreater{} print(``long returnCode string with value'', repr(rcFinal)) \# KO!
+
+\end{description}
+\index{KFSYS (src.returnCode.ReturnCode attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.returnCode.ReturnCode.KFSYS}\pysigline{\sphinxbfcode{KFSYS}\sphinxstrong{ = 4}}
+\end{fulllineitems}
+
+\index{KNOWNFAILURE\_STATUS (src.returnCode.ReturnCode attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.returnCode.ReturnCode.KNOWNFAILURE_STATUS}\pysigline{\sphinxbfcode{KNOWNFAILURE\_STATUS}\sphinxstrong{ = `KF'}}
+\end{fulllineitems}
+
+\index{KOSYS (src.returnCode.ReturnCode attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.returnCode.ReturnCode.KOSYS}\pysigline{\sphinxbfcode{KOSYS}\sphinxstrong{ = 1}}
+\end{fulllineitems}
+
+\index{KO\_STATUS (src.returnCode.ReturnCode attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.returnCode.ReturnCode.KO_STATUS}\pysigline{\sphinxbfcode{KO\_STATUS}\sphinxstrong{ = `KO'}}
+\end{fulllineitems}
+
+\index{NASYS (src.returnCode.ReturnCode attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.returnCode.ReturnCode.NASYS}\pysigline{\sphinxbfcode{NASYS}\sphinxstrong{ = 2}}
+\end{fulllineitems}
+
+\index{NA\_STATUS (src.returnCode.ReturnCode attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.returnCode.ReturnCode.NA_STATUS}\pysigline{\sphinxbfcode{NA\_STATUS}\sphinxstrong{ = `NA'}}
+\end{fulllineitems}
+
+\index{NDSYS (src.returnCode.ReturnCode attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.returnCode.ReturnCode.NDSYS}\pysigline{\sphinxbfcode{NDSYS}\sphinxstrong{ = 3}}
+\end{fulllineitems}
+
+\index{OKSYS (src.returnCode.ReturnCode attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.returnCode.ReturnCode.OKSYS}\pysigline{\sphinxbfcode{OKSYS}\sphinxstrong{ = 0}}
+\end{fulllineitems}
+
+\index{OK\_STATUS (src.returnCode.ReturnCode attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.returnCode.ReturnCode.OK_STATUS}\pysigline{\sphinxbfcode{OK\_STATUS}\sphinxstrong{ = `OK'}}
+\end{fulllineitems}
+
+\index{TIMEOUT\_STATUS (src.returnCode.ReturnCode attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.returnCode.ReturnCode.TIMEOUT_STATUS}\pysigline{\sphinxbfcode{TIMEOUT\_STATUS}\sphinxstrong{ = `TIMEOUT'}}
+\end{fulllineitems}
+
+\index{TOSYS (src.returnCode.ReturnCode attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.returnCode.ReturnCode.TOSYS}\pysigline{\sphinxbfcode{TOSYS}\sphinxstrong{ = 5}}
+\end{fulllineitems}
+
+\index{UNKNOWN\_STATUS (src.returnCode.ReturnCode attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.returnCode.ReturnCode.UNKNOWN_STATUS}\pysigline{\sphinxbfcode{UNKNOWN\_STATUS}\sphinxstrong{ = `ND'}}
+\end{fulllineitems}
+
+\index{getValue() (src.returnCode.ReturnCode method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.returnCode.ReturnCode.getValue}\pysiglinewithargsret{\sphinxbfcode{getValue}}{}{}
+\end{fulllineitems}
+
+\index{getWhy() (src.returnCode.ReturnCode method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.returnCode.ReturnCode.getWhy}\pysiglinewithargsret{\sphinxbfcode{getWhy}}{}{}
+\end{fulllineitems}
+
+\index{indent() (src.returnCode.ReturnCode method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.returnCode.ReturnCode.indent}\pysiglinewithargsret{\sphinxbfcode{indent}}{\emph{text}, \emph{amount=5}, \emph{ch=' `}}{}
+indent multi lines message
+
+\end{fulllineitems}
+
+\index{isOk() (src.returnCode.ReturnCode method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.returnCode.ReturnCode.isOk}\pysiglinewithargsret{\sphinxbfcode{isOk}}{}{}
+\end{fulllineitems}
+
+\index{setStatus() (src.returnCode.ReturnCode method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.returnCode.ReturnCode.setStatus}\pysiglinewithargsret{\sphinxbfcode{setStatus}}{\emph{status}, \emph{why=None}, \emph{value=None}}{}
+\end{fulllineitems}
+
+\index{setValue() (src.returnCode.ReturnCode method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.returnCode.ReturnCode.setValue}\pysiglinewithargsret{\sphinxbfcode{setValue}}{\emph{value}}{}
+\end{fulllineitems}
+
+\index{setWhy() (src.returnCode.ReturnCode method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.returnCode.ReturnCode.setWhy}\pysiglinewithargsret{\sphinxbfcode{setWhy}}{\emph{why}}{}
+\end{fulllineitems}
+
+\index{toSys() (src.returnCode.ReturnCode method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.returnCode.ReturnCode.toSys}\pysiglinewithargsret{\sphinxbfcode{toSys}}{}{}
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+
+
+\subsubsection{src.salomeTools module}
+\label{commands/apidoc/src:src-salometools-module}\label{commands/apidoc/src:module-src.salomeTools}\index{src.salomeTools (module)}
+This file is the main entry file to salomeTools
+NO \_\_main\_\_ entry allowed, use `sat' (in parent directory)
+\index{Sat (class in src.salomeTools)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.salomeTools.Sat}\pysiglinewithargsret{\sphinxstrong{class }\sphinxcode{src.salomeTools.}\sphinxbfcode{Sat}}{\emph{logger}}{}
+Bases: \sphinxcode{object}
+
+The main class that stores all the commands of salomeTools
+(usually known as `runner' argument in Command classes)
+\index{assumeAsList() (src.salomeTools.Sat method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.salomeTools.Sat.assumeAsList}\pysiglinewithargsret{\sphinxbfcode{assumeAsList}}{\emph{strOrList}}{}
+\end{fulllineitems}
+
+\index{execute\_cli() (src.salomeTools.Sat method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.salomeTools.Sat.execute_cli}\pysiglinewithargsret{\sphinxbfcode{execute\_cli}}{\emph{cli\_arguments}}{}
+select first argument as a command in directory `commands', and launch on arguments
+
+:param args str or list, The sat cli arguments (as sys.argv)
+
+\end{fulllineitems}
+
+\index{getColoredVersion() (src.salomeTools.Sat method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.salomeTools.Sat.getColoredVersion}\pysiglinewithargsret{\sphinxbfcode{getColoredVersion}}{}{}
+get colored salomeTools version message
+
+\end{fulllineitems}
+
+\index{getCommandAndAppli() (src.salomeTools.Sat method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.salomeTools.Sat.getCommandAndAppli}\pysiglinewithargsret{\sphinxbfcode{getCommandAndAppli}}{\emph{arguments}}{}
+\end{fulllineitems}
+
+\index{getCommandInstance() (src.salomeTools.Sat method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.salomeTools.Sat.getCommandInstance}\pysiglinewithargsret{\sphinxbfcode{getCommandInstance}}{\emph{name}}{}
+returns inherited instance of Command(\_BaseCmd) for command `name'
+if module not loaded yet, load it.
+
+\end{fulllineitems}
+
+\index{getConfig() (src.salomeTools.Sat method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.salomeTools.Sat.getConfig}\pysiglinewithargsret{\sphinxbfcode{getConfig}}{}{}
+\end{fulllineitems}
+
+\index{getConfigManager() (src.salomeTools.Sat method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.salomeTools.Sat.getConfigManager}\pysiglinewithargsret{\sphinxbfcode{getConfigManager}}{}{}
+\end{fulllineitems}
+
+\index{getLogger() (src.salomeTools.Sat method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.salomeTools.Sat.getLogger}\pysiglinewithargsret{\sphinxbfcode{getLogger}}{}{}
+\end{fulllineitems}
+
+\index{getModule() (src.salomeTools.Sat method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.salomeTools.Sat.getModule}\pysiglinewithargsret{\sphinxbfcode{getModule}}{\emph{name}}{}
+returns only-one-time loaded module Command `name'
+assume load if not done yet
+
+\end{fulllineitems}
+
+\index{get\_help() (src.salomeTools.Sat method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.salomeTools.Sat.get_help}\pysiglinewithargsret{\sphinxbfcode{get\_help}}{}{}
+get general help colored string
+
+\end{fulllineitems}
+
+\index{parseArguments() (src.salomeTools.Sat method)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.salomeTools.Sat.parseArguments}\pysiglinewithargsret{\sphinxbfcode{parseArguments}}{\emph{arguments}}{}
+\end{fulllineitems}
-\end{description}
+\index{print\_help() (src.salomeTools.Sat method)}
-@rtype: str
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.salomeTools.Sat.print_help}\pysiglinewithargsret{\sphinxbfcode{print\_help}}{}{}
+prints salomeTools general help
\end{fulllineitems}
-\index{defaultStreamOpener() (in module src.pyconf)}
-\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.
+\end{fulllineitems}
-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().
+\index{assumeAsList() (in module src.salomeTools)}
-@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)
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.salomeTools.assumeAsList}\pysiglinewithargsret{\sphinxcode{src.salomeTools.}\sphinxbfcode{assumeAsList}}{\emph{strOrList}}{}
+return a list as sys.argv if string
\end{fulllineitems}
-\index{isWord() (in module src.pyconf)}
+\index{find\_command\_list() (in module src.salomeTools)}
\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{commands/apidoc/src:src.salomeTools.find_command_list}\pysiglinewithargsret{\sphinxcode{src.salomeTools.}\sphinxbfcode{find\_command\_list}}{\emph{dirPath}}{}
+Parse files in dirPath that end with `.py' : it gives commands list
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{\texttt{str}} (\emph{\texttt{dirPath}}) -- The directory path where to search the commands
-Examples:
+\item[{Returns}] \leavevmode
+cmd\_list : the list containing the commands name
-\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}
+\item[{Return type}] \leavevmode
+{\hyperref[commands/apidoc/src:src.utilsSat.Path.list]{\sphinxcrossref{list}}} (\autopageref*{commands/apidoc/src:src.utilsSat.Path.list})
-@note: isWord(‘9abc’) will return True - not exactly correct, but adequate
-for the way it’s used here.
+\end{description}\end{quote}
-@param s: The name to be tested
-@type s: any
-@return: True if a word, else False
-@rtype: bool
+\end{fulllineitems}
+
+\index{getCommandsList() (in module src.salomeTools)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.salomeTools.getCommandsList}\pysiglinewithargsret{\sphinxcode{src.salomeTools.}\sphinxbfcode{getCommandsList}}{}{}
+Gives commands list (as basename of files .py in directory commands
\end{fulllineitems}
-\index{makePath() (in module src.pyconf)}
+\index{getVersion() (in module src.salomeTools)}
\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.
+\phantomsection\label{commands/apidoc/src:src.salomeTools.getVersion}\pysiglinewithargsret{\sphinxcode{src.salomeTools.}\sphinxbfcode{getVersion}}{}{}
+get version number as string
-Examples:
-makePath(‘’, ‘suffix’) -\textgreater{} ‘suffix’
-makePath(‘prefix’, ‘suffix’) -\textgreater{} ‘prefix.suffix’
-makePath(‘prefix’, ‘{[}1{]}’) -\textgreater{} ‘prefix{[}1{]}’
+\end{fulllineitems}
-@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
+\index{launchSat() (in module src.salomeTools)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.salomeTools.launchSat}\pysiglinewithargsret{\sphinxcode{src.salomeTools.}\sphinxbfcode{launchSat}}{\emph{command}}{}
+launch sat as subprocess popen
+command as string (`sat --help' for example)
+used for unittest, or else...
+returns tuple (stdout, stderr)
\end{fulllineitems}
-\index{overwriteMergeResolve() (in module src.pyconf)}
+\index{setLocale() (in module src.salomeTools)}
\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{commands/apidoc/src:src.salomeTools.setLocale}\pysiglinewithargsret{\sphinxcode{src.salomeTools.}\sphinxbfcode{setLocale}}{}{}
+reset initial locale at any moment
+`fr' or else (TODO) from initial environment var `\$LANG'
+`i18n' as `internationalization'
-@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{setNotLocale() (in module src.salomeTools)}
+
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.salomeTools.setNotLocale}\pysiglinewithargsret{\sphinxcode{src.salomeTools.}\sphinxbfcode{setNotLocale}}{}{}
+force english at any moment
\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,
+\subsubsection{src.system module}
+\label{commands/apidoc/src:src-system-module}\label{commands/apidoc/src:module-src.system}\index{src.system (module)}
+All utilities method doing a system call,
like open a browser or an editor, or call a git command
+\begin{description}
+\item[{usage:}] \leavevmode
+\textgreater{}\textgreater{} import src.system as SYSS
+
+\end{description}
\index{archive\_extract() (in module src.system)}
\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}}{}
+\phantomsection\label{commands/apidoc/src:src.system.archive_extract}\pysiglinewithargsret{\sphinxcode{src.system.}\sphinxbfcode{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.
+\textbf{\texttt{str}} (\emph{\texttt{where}}) -- The path to the archive.
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The path where to extract.
+\textbf{\texttt{str}} -- The path where to extract.
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to use.
+\textbf{\texttt{Logger}} (\emph{\texttt{logger}}) -- The logger instance to use.
\end{itemize}
\index{cvs\_extract() (in module src.system)}
\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}}{}
+\phantomsection\label{commands/apidoc/src:src.system.cvs_extract}\pysiglinewithargsret{\sphinxcode{src.system.}\sphinxbfcode{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.
+\textbf{\texttt{str}} (\emph{\texttt{where}}) -- The cvs protocol.
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The user to be used.
+\textbf{\texttt{str}} -- The user to be used.
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The remote cvs server.
+\textbf{\texttt{str}} -- The remote cvs server.
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{}
+\textbf{\texttt{str}} --
.
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The tag.
+\textbf{\texttt{str}} -- The tag.
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The product.
+\textbf{\texttt{str}} -- The product.
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The path where to extract.
+\textbf{\texttt{str}} -- The path where to extract.
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to use.
+\textbf{\texttt{Logger}} (\emph{\texttt{logger}}) -- The logger instance to use.
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{boolean}} (\sphinxstyleliteralemphasis{\sphinxupquote{checkout}}) \textendash{} If true use checkout cvs.
+\textbf{\texttt{boolean}} (\emph{\texttt{checkout}}) -- If true use checkout cvs.
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{src.environment.Environ}} (\sphinxstyleliteralemphasis{\sphinxupquote{environment}}) \textendash{} The environment to source when
+\textbf{\texttt{src.environment.Environ}} ({\hyperref[commands/apidoc/src:module\string-src.environment]{\sphinxcrossref{\emph{\texttt{environment}}}}} (\autopageref*{commands/apidoc/src:module-src.environment})) -- The environment to source when
extracting.
\end{itemize}
\index{git\_extract() (in module src.system)}
\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}}{}
+\phantomsection\label{commands/apidoc/src:src.system.git_extract}\pysiglinewithargsret{\sphinxcode{src.system.}\sphinxbfcode{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.
+\textbf{\texttt{str}} (\emph{\texttt{where}}) -- The remote git repository.
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The tag.
+\textbf{\texttt{str}} -- The tag.
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The path where to extract.
+\textbf{\texttt{str}} -- The path where to extract.
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to use.
+\textbf{\texttt{Logger}} (\emph{\texttt{logger}}) -- The logger instance to use.
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{src.environment.Environ}} (\sphinxstyleliteralemphasis{\sphinxupquote{environment}}) \textendash{} The environment to source when
+\textbf{\texttt{src.environment.Environ}} ({\hyperref[commands/apidoc/src:module\string-src.environment]{\sphinxcrossref{\emph{\texttt{environment}}}}} (\autopageref*{commands/apidoc/src:module-src.environment})) -- The environment to source when
extracting.
\end{itemize}
\index{show\_in\_editor() (in module src.system)}
\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}}{}
+\phantomsection\label{commands/apidoc/src:src.system.show_in_editor}\pysiglinewithargsret{\sphinxcode{src.system.}\sphinxbfcode{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.
+\textbf{\texttt{str}} (\emph{\texttt{filePath}}) -- The editor to use.
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The path to the file to open.
+\textbf{\texttt{str}} -- The path to the file to open.
\end{itemize}
\index{svn\_extract() (in module src.system)}
\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}}{}
+\phantomsection\label{commands/apidoc/src:src.system.svn_extract}\pysiglinewithargsret{\sphinxcode{src.system.}\sphinxbfcode{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.
+\textbf{\texttt{str}} (\emph{\texttt{where}}) -- The user to be used.
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The remote git repository.
+\textbf{\texttt{str}} -- The remote git repository.
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The tag.
+\textbf{\texttt{str}} -- The tag.
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The path where to extract.
+\textbf{\texttt{str}} -- The path where to extract.
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to use.
+\textbf{\texttt{Logger}} (\emph{\texttt{logger}}) -- The logger instance to use.
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{boolean}} (\sphinxstyleliteralemphasis{\sphinxupquote{checkout}}) \textendash{} If true use checkout svn.
+\textbf{\texttt{boolean}} (\emph{\texttt{checkout}}) -- If true use checkout svn.
\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{src.environment.Environ}} (\sphinxstyleliteralemphasis{\sphinxupquote{environment}}) \textendash{} The environment to source when
+\textbf{\texttt{src.environment.Environ}} ({\hyperref[commands/apidoc/src:module\string-src.environment]{\sphinxcrossref{\emph{\texttt{environment}}}}} (\autopageref*{commands/apidoc/src:module-src.environment})) -- The environment to source when
extracting.
\end{itemize}
-\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)}
+\subsubsection{src.template module}
+\label{commands/apidoc/src:module-src.template}\label{commands/apidoc/src:src-template-module}\index{src.template (module)}\index{MyTemplate (class in src.template)}
\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}}
+\phantomsection\label{commands/apidoc/src:src.template.MyTemplate}\pysiglinewithargsret{\sphinxstrong{class }\sphinxcode{src.template.}\sphinxbfcode{MyTemplate}}{\emph{template}}{}
+Bases: \sphinxcode{string.Template}
\index{delimiter (src.template.MyTemplate attribute)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.template.MyTemplate.delimiter}}\pysigline{\sphinxbfcode{\sphinxupquote{delimiter}}\sphinxbfcode{\sphinxupquote{ = '\textbackslash{}xc2\textbackslash{}xa4'}}}
+\phantomsection\label{commands/apidoc/src:src.template.MyTemplate.delimiter}\pysigline{\sphinxbfcode{delimiter}\sphinxstrong{ = `\textbackslash{}xc2\textbackslash{}xa4'}}
\end{fulllineitems}
\index{pattern (src.template.MyTemplate attribute)}
\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{}}}}
+\phantomsection\label{commands/apidoc/src:src.template.MyTemplate.pattern}\pysigline{\sphinxbfcode{pattern}\sphinxstrong{ = \textless{}\_sre.SRE\_Pattern object\textgreater{}}}
\end{fulllineitems}
\index{substitute() (in module src.template)}
\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{commands/apidoc/src:src.template.substitute}\pysiglinewithargsret{\sphinxcode{src.template.}\sphinxbfcode{substitute}}{\emph{template\_file}, \emph{subst\_dic}}{}
\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)}
+\subsubsection{src.test\_module module}
+\label{commands/apidoc/src:module-src.test_module}\label{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: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{commands/apidoc/src:src.test_module.Test}\pysiglinewithargsret{\sphinxstrong{class }\sphinxcode{src.test\_module.}\sphinxbfcode{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:src.test_module.Test.generate_launching_commands}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{generate\_launching\_commands}}}{}{}
+\phantomsection\label{commands/apidoc/src:src.test_module.Test.generate_launching_commands}\pysiglinewithargsret{\sphinxbfcode{generate\_launching\_commands}}{}{}
\end{fulllineitems}
\index{generate\_script() (src.test\_module.Test 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}}{}
+\phantomsection\label{commands/apidoc/src:src.test_module.Test.generate_script}\pysiglinewithargsret{\sphinxbfcode{generate\_script}}{\emph{listTest}, \emph{script\_path}, \emph{ignoreList}}{}
\end{fulllineitems}
\index{get\_test\_timeout() (src.test\_module.Test method)}
\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}}{}
+\phantomsection\label{commands/apidoc/src:src.test_module.Test.get_test_timeout}\pysiglinewithargsret{\sphinxbfcode{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}}}{}{}
+\phantomsection\label{commands/apidoc/src:src.test_module.Test.get_tmp_dir}\pysiglinewithargsret{\sphinxbfcode{get\_tmp\_dir}}{}{}
\end{fulllineitems}
\index{prepare\_testbase() (src.test\_module.Test method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.prepare_testbase}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepare\_testbase}}}{\emph{test\_base\_name}}{}
+\phantomsection\label{commands/apidoc/src:src.test_module.Test.prepare_testbase}\pysiglinewithargsret{\sphinxbfcode{prepare\_testbase}}{\emph{test\_base\_name}}{}
\end{fulllineitems}
\index{prepare\_testbase\_from\_dir() (src.test\_module.Test 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}}{}
+\phantomsection\label{commands/apidoc/src:src.test_module.Test.prepare_testbase_from_dir}\pysiglinewithargsret{\sphinxbfcode{prepare\_testbase\_from\_dir}}{\emph{testbase\_name}, \emph{testbase\_dir}}{}
\end{fulllineitems}
\index{prepare\_testbase\_from\_git() (src.test\_module.Test method)}
\begin{fulllineitems}
-\phantomsection\label{\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}}{}
+\phantomsection\label{commands/apidoc/src:src.test_module.Test.prepare_testbase_from_git}\pysiglinewithargsret{\sphinxbfcode{prepare\_testbase\_from\_git}}{\emph{testbase\_name}, \emph{testbase\_base}, \emph{testbase\_tag}}{}
\end{fulllineitems}
\index{prepare\_testbase\_from\_svn() (src.test\_module.Test method)}
\begin{fulllineitems}
-\phantomsection\label{\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{commands/apidoc/src:src.test_module.Test.prepare_testbase_from_svn}\pysiglinewithargsret{\sphinxbfcode{prepare\_testbase\_from\_svn}}{\emph{user}, \emph{testbase\_name}, \emph{testbase\_base}}{}
\end{fulllineitems}
\index{read\_results() (src.test\_module.Test method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.read_results}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{read\_results}}}{\emph{listTest}, \emph{has\_timed\_out}}{}
+\phantomsection\label{commands/apidoc/src:src.test_module.Test.read_results}\pysiglinewithargsret{\sphinxbfcode{read\_results}}{\emph{listTest}, \emph{has\_timed\_out}}{}
\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}}}{}{}
+\phantomsection\label{commands/apidoc/src:src.test_module.Test.run_all_tests}\pysiglinewithargsret{\sphinxbfcode{run\_all\_tests}}{}{}
\end{fulllineitems}
\index{run\_grid\_tests() (src.test\_module.Test method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.run_grid_tests}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run\_grid\_tests}}}{}{}
+\phantomsection\label{commands/apidoc/src:src.test_module.Test.run_grid_tests}\pysiglinewithargsret{\sphinxbfcode{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}}{}
+\phantomsection\label{commands/apidoc/src:src.test_module.Test.run_script}\pysiglinewithargsret{\sphinxbfcode{run\_script}}{\emph{script\_name}}{}
\end{fulllineitems}
\index{run\_session\_tests() (src.test\_module.Test method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.run_session_tests}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run\_session\_tests}}}{}{}
+\phantomsection\label{commands/apidoc/src:src.test_module.Test.run_session_tests}\pysiglinewithargsret{\sphinxbfcode{run\_session\_tests}}{}{}
\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}}}{}{}
+\phantomsection\label{commands/apidoc/src:src.test_module.Test.run_testbase_tests}\pysiglinewithargsret{\sphinxbfcode{run\_testbase\_tests}}{}{}
+Runs test testbase
+
\end{fulllineitems}
\index{run\_tests() (src.test\_module.Test method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.run_tests}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run\_tests}}}{\emph{listTest}, \emph{ignoreList}}{}
+\phantomsection\label{commands/apidoc/src:src.test_module.Test.run_tests}\pysiglinewithargsret{\sphinxbfcode{run\_tests}}{\emph{listTest}, \emph{ignoreList}}{}
\end{fulllineitems}
\index{search\_known\_errors() (src.test\_module.Test method)}
\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}}{}
+\phantomsection\label{commands/apidoc/src:src.test_module.Test.search_known_errors}\pysiglinewithargsret{\sphinxbfcode{search\_known\_errors}}{\emph{status}, \emph{test\_grid}, \emph{test\_session}, \emph{test}}{}
\end{fulllineitems}
\index{write\_test\_margin() (src.test\_module.Test method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.write_test_margin}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write\_test\_margin}}}{\emph{tab}}{}
+\phantomsection\label{commands/apidoc/src:src.test_module.Test.write_test_margin}\pysiglinewithargsret{\sphinxbfcode{write\_test\_margin}}{\emph{tab}}{}
+indent with `\textbar{} ... +' to show test results.
+
\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}}}{}{}
+\phantomsection\label{commands/apidoc/src:src.test_module.getTmpDirDEFAULT}\pysiglinewithargsret{\sphinxcode{src.test\_module.}\sphinxbfcode{getTmpDirDEFAULT}}{}{}
\end{fulllineitems}
-\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)}
+\subsubsection{src.utilsSat module}
+\label{commands/apidoc/src:src-utilssat-module}\label{commands/apidoc/src:module-src.utilsSat}\index{src.utilsSat (module)}
+utilities for sat
+general useful simple methods
+all-in-one import srs.utilsSat as UTS
-\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}}
-
-Class to manage reading of an xml log file
-\index{getRootAttrib() (src.xmlManager.ReadXmlFile method)}
-
-\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
-
-\item[{Return type}] \leavevmode
-dict
-
-\end{description}\end{quote}
-
-\end{fulllineitems}
-
-\index{get\_attrib() (src.xmlManager.ReadXmlFile method)}
+usage:
+\textgreater{}\textgreater{} import srsc.utilsSat as UTS
+\textgreater{}\textgreater{} UTS.ensure\_path\_exists(path)
+\index{Path (class in src.utilsSat)}
\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
-
-\item[{Returns}] \leavevmode
-the attibutes of the node node\_name in self.xmlroot
-
-\item[{Return type}] \leavevmode
-dict
-
-\end{description}\end{quote}
-
-\end{fulllineitems}
-
-\index{get\_node\_text() (src.xmlManager.ReadXmlFile method)}
+\phantomsection\label{commands/apidoc/src:src.utilsSat.Path}\pysiglinewithargsret{\sphinxstrong{class }\sphinxcode{src.utilsSat.}\sphinxbfcode{Path}}{\emph{path}}{}~\index{base() (src.utilsSat.Path method)}
\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
-
-\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
-
-\item[{Returns}] \leavevmode
-the text of the first node that has name
-that corresponds to the parameter node
-
-\item[{Return type}] \leavevmode
-str
-
-\end{description}\end{quote}
-
-\end{fulllineitems}
-
-
+\phantomsection\label{commands/apidoc/src:src.utilsSat.Path.base}\pysiglinewithargsret{\sphinxbfcode{base}}{}{}
\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)}
+\index{chmod() (src.utilsSat.Path method)}
\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.
-\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode\begin{itemize}
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{text}}) \textendash{} the name of the node to add
-
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the text of the node
-
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{dict}} (\sphinxstyleliteralemphasis{\sphinxupquote{attrib}}) \textendash{} the dictionary containing the
-attribute of the new node
-
-\end{itemize}
-
-\end{description}\end{quote}
-
+\phantomsection\label{commands/apidoc/src:src.utilsSat.Path.chmod}\pysiglinewithargsret{\sphinxbfcode{chmod}}{\emph{mode}}{}
\end{fulllineitems}
-\index{append\_node\_attrib() (src.xmlManager.XmlLogFile method)}
+\index{copy() (src.utilsSat.Path method)}
\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
-\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
-
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{dixt}} (\sphinxstyleliteralemphasis{\sphinxupquote{attrib}}) \textendash{} The attrib to append
-
-\end{itemize}
-
-\end{description}\end{quote}
-
+\phantomsection\label{commands/apidoc/src:src.utilsSat.Path.copy}\pysiglinewithargsret{\sphinxbfcode{copy}}{\emph{path}, \emph{smart=False}}{}
\end{fulllineitems}
-\index{append\_node\_text() (src.xmlManager.XmlLogFile method)}
+\index{copydir() (src.utilsSat.Path 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
-
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The text to append
-
-\end{itemize}
-
-\end{description}\end{quote}
-
+\phantomsection\label{commands/apidoc/src:src.utilsSat.Path.copydir}\pysiglinewithargsret{\sphinxbfcode{copydir}}{\emph{dst}, \emph{smart=False}}{}
\end{fulllineitems}
-\index{write\_tree() (src.xmlManager.XmlLogFile method)}
+\index{copyfile() (src.utilsSat.Path method)}
\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{description}\end{quote}
-
-\end{fulllineitems}
-
-
+\phantomsection\label{commands/apidoc/src:src.utilsSat.Path.copyfile}\pysiglinewithargsret{\sphinxbfcode{copyfile}}{\emph{path}}{}
\end{fulllineitems}
-\index{add\_simple\_node() (in module src.xmlManager)}
+\index{copylink() (src.utilsSat.Path method)}
\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.
-\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
-
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{text}}) \textendash{} the name of the node to add
-
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the text of the node
-
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{dict}} (\sphinxstyleliteralemphasis{\sphinxupquote{attrib}}) \textendash{} the dictionary containing the
-attribute of the new node
-
-\end{itemize}
-
-\end{description}\end{quote}
-
+\phantomsection\label{commands/apidoc/src:src.utilsSat.Path.copylink}\pysiglinewithargsret{\sphinxbfcode{copylink}}{\emph{path}}{}
\end{fulllineitems}
-\index{append\_node\_attrib() (in module src.xmlManager)}
+\index{dir() (src.utilsSat.Path method)}
\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
-
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{dixt}} (\sphinxstyleliteralemphasis{\sphinxupquote{attrib}}) \textendash{} The attrib to append
-
-\end{itemize}
-
-\end{description}\end{quote}
-
+\phantomsection\label{commands/apidoc/src:src.utilsSat.Path.dir}\pysiglinewithargsret{\sphinxbfcode{dir}}{}{}
\end{fulllineitems}
-\index{find\_node\_by\_attrib() (in module src.xmlManager)}
+\index{exists() (src.utilsSat.Path method)}
\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}
-\begin{quote}\begin{description}
-\item[{Parameters}] \leavevmode\begin{itemize}
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{etree.Element}} (\sphinxstyleliteralemphasis{\sphinxupquote{xmlroot}}) \textendash{} the Etree element where to search
-
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the name of node to search
-
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the key to search
-
-\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}
-
+\phantomsection\label{commands/apidoc/src:src.utilsSat.Path.exists}\pysiglinewithargsret{\sphinxbfcode{exists}}{}{}
\end{fulllineitems}
-\index{write\_report() (in module src.xmlManager)}
+\index{isdir() (src.utilsSat.Path method)}
\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
-
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{etree.Element}} (\sphinxstyleliteralemphasis{\sphinxupquote{xmlroot}}) \textendash{} the Etree element to write to the file
-
-\item {}
-\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The stylesheet to add to the begin of the file
-
-\end{itemize}
-
-\end{description}\end{quote}
-
+\phantomsection\label{commands/apidoc/src:src.utilsSat.Path.isdir}\pysiglinewithargsret{\sphinxbfcode{isdir}}{}{}
\end{fulllineitems}
-
-
-\subsubsection{Subpackages}
-\label{\detokenize{commands/apidoc/src:subpackages}}
-
-\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)}
-
-\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)}
+\index{isfile() (src.utilsSat.Path method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.BLACK}}\pysigline{\sphinxbfcode{\sphinxupquote{BLACK}}\sphinxbfcode{\sphinxupquote{ = 40}}}
+\phantomsection\label{commands/apidoc/src:src.utilsSat.Path.isfile}\pysiglinewithargsret{\sphinxbfcode{isfile}}{}{}
\end{fulllineitems}
-\index{BLUE (src.colorama.ansi.AnsiBack attribute)}
+\index{islink() (src.utilsSat.Path method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.BLUE}}\pysigline{\sphinxbfcode{\sphinxupquote{BLUE}}\sphinxbfcode{\sphinxupquote{ = 44}}}
+\phantomsection\label{commands/apidoc/src:src.utilsSat.Path.islink}\pysiglinewithargsret{\sphinxbfcode{islink}}{}{}
\end{fulllineitems}
-\index{CYAN (src.colorama.ansi.AnsiBack attribute)}
+\index{list() (src.utilsSat.Path method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.CYAN}}\pysigline{\sphinxbfcode{\sphinxupquote{CYAN}}\sphinxbfcode{\sphinxupquote{ = 46}}}
+\phantomsection\label{commands/apidoc/src:src.utilsSat.Path.list}\pysiglinewithargsret{\sphinxbfcode{list}}{}{}
\end{fulllineitems}
-\index{GREEN (src.colorama.ansi.AnsiBack attribute)}
+\index{make() (src.utilsSat.Path method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.GREEN}}\pysigline{\sphinxbfcode{\sphinxupquote{GREEN}}\sphinxbfcode{\sphinxupquote{ = 42}}}
+\phantomsection\label{commands/apidoc/src:src.utilsSat.Path.make}\pysiglinewithargsret{\sphinxbfcode{make}}{\emph{mode=None}}{}
\end{fulllineitems}
-\index{LIGHTBLACK\_EX (src.colorama.ansi.AnsiBack attribute)}
+\index{readlink() (src.utilsSat.Path method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTBLACK_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTBLACK\_EX}}\sphinxbfcode{\sphinxupquote{ = 100}}}
+\phantomsection\label{commands/apidoc/src:src.utilsSat.Path.readlink}\pysiglinewithargsret{\sphinxbfcode{readlink}}{}{}
\end{fulllineitems}
-\index{LIGHTBLUE\_EX (src.colorama.ansi.AnsiBack attribute)}
+\index{rm() (src.utilsSat.Path method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTBLUE_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTBLUE\_EX}}\sphinxbfcode{\sphinxupquote{ = 104}}}
+\phantomsection\label{commands/apidoc/src:src.utilsSat.Path.rm}\pysiglinewithargsret{\sphinxbfcode{rm}}{}{}
\end{fulllineitems}
-\index{LIGHTCYAN\_EX (src.colorama.ansi.AnsiBack attribute)}
+\index{smartcopy() (src.utilsSat.Path 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{commands/apidoc/src:src.utilsSat.Path.smartcopy}\pysiglinewithargsret{\sphinxbfcode{smartcopy}}{\emph{path}}{}
\end{fulllineitems}
-\index{LIGHTGREEN\_EX (src.colorama.ansi.AnsiBack attribute)}
+\index{symlink() (src.utilsSat.Path 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{commands/apidoc/src:src.utilsSat.Path.symlink}\pysiglinewithargsret{\sphinxbfcode{symlink}}{\emph{path}}{}
\end{fulllineitems}
-\index{LIGHTMAGENTA\_EX (src.colorama.ansi.AnsiBack attribute)}
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTMAGENTA_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTMAGENTA\_EX}}\sphinxbfcode{\sphinxupquote{ = 105}}}
\end{fulllineitems}
-\index{LIGHTRED\_EX (src.colorama.ansi.AnsiBack attribute)}
+\index{black() (in module src.utilsSat)}
\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{commands/apidoc/src:src.utilsSat.black}\pysiglinewithargsret{\sphinxcode{src.utilsSat.}\sphinxbfcode{black}}{\emph{msg}}{}
\end{fulllineitems}
-\index{LIGHTWHITE\_EX (src.colorama.ansi.AnsiBack attribute)}
+\index{blue() (in module src.utilsSat)}
\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{commands/apidoc/src:src.utilsSat.blue}\pysiglinewithargsret{\sphinxcode{src.utilsSat.}\sphinxbfcode{blue}}{\emph{msg}}{}
\end{fulllineitems}
-\index{LIGHTYELLOW\_EX (src.colorama.ansi.AnsiBack attribute)}
+\index{check\_config\_has\_application() (in module src.utilsSat)}
\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{commands/apidoc/src:src.utilsSat.check_config_has_application}\pysiglinewithargsret{\sphinxcode{src.utilsSat.}\sphinxbfcode{check\_config\_has\_application}}{\emph{config}, \emph{details=None}}{}
+check that the config has the key APPLICATION. Else raise an exception.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{\texttt{class 'common.pyconf.Config'}} (\emph{\texttt{config}}) -- The config.
+
+\end{description}\end{quote}
+
\end{fulllineitems}
-\index{MAGENTA (src.colorama.ansi.AnsiBack attribute)}
+\index{check\_config\_has\_profile() (in module src.utilsSat)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.MAGENTA}}\pysigline{\sphinxbfcode{\sphinxupquote{MAGENTA}}\sphinxbfcode{\sphinxupquote{ = 45}}}
+\phantomsection\label{commands/apidoc/src:src.utilsSat.check_config_has_profile}\pysiglinewithargsret{\sphinxcode{src.utilsSat.}\sphinxbfcode{check\_config\_has\_profile}}{\emph{config}, \emph{details=None}}{}~\begin{description}
+\item[{check that the config has the key APPLICATION.profile.}] \leavevmode
+Else, raise an exception.
+
+\end{description}
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{\texttt{class 'common.pyconf.Config'}} (\emph{\texttt{config}}) -- The config.
+
+\end{description}\end{quote}
+
\end{fulllineitems}
-\index{RED (src.colorama.ansi.AnsiBack attribute)}
+\index{config\_has\_application() (in module src.utilsSat)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.RED}}\pysigline{\sphinxbfcode{\sphinxupquote{RED}}\sphinxbfcode{\sphinxupquote{ = 41}}}
+\phantomsection\label{commands/apidoc/src:src.utilsSat.config_has_application}\pysiglinewithargsret{\sphinxcode{src.utilsSat.}\sphinxbfcode{config\_has\_application}}{\emph{config}}{}
\end{fulllineitems}
-\index{RESET (src.colorama.ansi.AnsiBack attribute)}
+\index{critical() (in module src.utilsSat)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.RESET}}\pysigline{\sphinxbfcode{\sphinxupquote{RESET}}\sphinxbfcode{\sphinxupquote{ = 49}}}
+\phantomsection\label{commands/apidoc/src:src.utilsSat.critical}\pysiglinewithargsret{\sphinxcode{src.utilsSat.}\sphinxbfcode{critical}}{\emph{msg}}{}
\end{fulllineitems}
-\index{WHITE (src.colorama.ansi.AnsiBack attribute)}
+\index{cyan() (in module src.utilsSat)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.WHITE}}\pysigline{\sphinxbfcode{\sphinxupquote{WHITE}}\sphinxbfcode{\sphinxupquote{ = 47}}}
+\phantomsection\label{commands/apidoc/src:src.utilsSat.cyan}\pysiglinewithargsret{\sphinxcode{src.utilsSat.}\sphinxbfcode{cyan}}{\emph{msg}}{}
\end{fulllineitems}
-\index{YELLOW (src.colorama.ansi.AnsiBack attribute)}
+\index{date\_to\_datetime() (in module src.utilsSat)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.YELLOW}}\pysigline{\sphinxbfcode{\sphinxupquote{YELLOW}}\sphinxbfcode{\sphinxupquote{ = 43}}}
-\end{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.utilsSat.date_to_datetime}\pysiglinewithargsret{\sphinxcode{src.utilsSat.}\sphinxbfcode{date\_to\_datetime}}{\emph{date}}{}
+From a string date in format YYYYMMDD\_HHMMSS
+returns list year, mon, day, hour, minutes, seconds
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{\texttt{str}} (\emph{\texttt{date}}) -- The date in format YYYYMMDD\_HHMMSS
+
+\item[{Returns}] \leavevmode
+the same date and time in separate variables.
+
+\item[{Return type}] \leavevmode
+(str,str,str,str,str,str)
+\end{description}\end{quote}
\end{fulllineitems}
-\index{AnsiCodes (class in src.colorama.ansi)}
+\index{deepcopy\_list() (in module src.utilsSat)}
\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{commands/apidoc/src:src.utilsSat.deepcopy_list}\pysiglinewithargsret{\sphinxcode{src.utilsSat.}\sphinxbfcode{deepcopy\_list}}{\emph{input\_list}}{}
+Do a deep copy of a list
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{\texttt{List}} (\emph{\texttt{input\_list}}) -- The list to copy
-\end{fulllineitems}
+\item[{Returns}] \leavevmode
+The copy of the list
-\index{AnsiCursor (class in src.colorama.ansi)}
+\item[{Return type}] \leavevmode
+List
-\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)}
+\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)}
+\index{ensure\_path\_exists() (in module src.utilsSat)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.DOWN}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{DOWN}}}{\emph{n=1}}{}
-\end{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.utilsSat.ensure_path_exists}\pysiglinewithargsret{\sphinxcode{src.utilsSat.}\sphinxbfcode{ensure\_path\_exists}}{\emph{p}}{}
+Create a path if not existing
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{\texttt{str}} (\emph{\texttt{p}}) -- The path.
-\index{FORWARD() (src.colorama.ansi.AnsiCursor method)}
+\end{description}\end{quote}
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.FORWARD}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{FORWARD}}}{\emph{n=1}}{}
\end{fulllineitems}
-\index{POS() (src.colorama.ansi.AnsiCursor method)}
+\index{error() (in module src.utilsSat)}
\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{commands/apidoc/src:src.utilsSat.error}\pysiglinewithargsret{\sphinxcode{src.utilsSat.}\sphinxbfcode{error}}{\emph{msg}}{}
\end{fulllineitems}
-\index{UP() (src.colorama.ansi.AnsiCursor method)}
+\index{find\_file\_in\_lpath() (in module src.utilsSat)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.UP}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{UP}}}{\emph{n=1}}{}
-\end{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.utilsSat.find_file_in_lpath}\pysiglinewithargsret{\sphinxcode{src.utilsSat.}\sphinxbfcode{find\_file\_in\_lpath}}{\emph{file\_name}, \emph{lpath}, \emph{additional\_dir='`}}{}~\begin{description}
+\item[{Find in all the directories in lpath list the file that has the same name}] \leavevmode
+as file\_name. If it is found, 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.
+\end{description}
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{\texttt{str}} (\emph{\texttt{additional\_dir}}) -- The file name to search
-\end{fulllineitems}
+\item {}
+\textbf{\texttt{List}} (\emph{\texttt{lpath}}) -- The list of directories where to search
-\index{AnsiFore (class in src.colorama.ansi)}
+\item {}
+\textbf{\texttt{str}} -- The name of the additional directory
-\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)}
+\end{itemize}
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.BLACK}}\pysigline{\sphinxbfcode{\sphinxupquote{BLACK}}\sphinxbfcode{\sphinxupquote{ = 30}}}
-\end{fulllineitems}
+\item[{Returns}] \leavevmode
+the full path of the file or False if not found
-\index{BLUE (src.colorama.ansi.AnsiFore attribute)}
+\item[{Return type}] \leavevmode
+str
+
+\end{description}\end{quote}
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.BLUE}}\pysigline{\sphinxbfcode{\sphinxupquote{BLUE}}\sphinxbfcode{\sphinxupquote{ = 34}}}
\end{fulllineitems}
-\index{CYAN (src.colorama.ansi.AnsiFore attribute)}
+\index{formatTuples() (in module src.utilsSat)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.CYAN}}\pysigline{\sphinxbfcode{\sphinxupquote{CYAN}}\sphinxbfcode{\sphinxupquote{ = 36}}}
+\phantomsection\label{commands/apidoc/src:src.utilsSat.formatTuples}\pysiglinewithargsret{\sphinxcode{src.utilsSat.}\sphinxbfcode{formatTuples}}{\emph{tuples}}{}
+format `label = value' the tuples in a tabulated way.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{\texttt{list}} (\emph{\texttt{tuples}}) -- The list of tuples to format
+
+\item[{Returns}] \leavevmode
+The tabulated text. (mutiples lines)
+
+\end{description}\end{quote}
+
\end{fulllineitems}
-\index{GREEN (src.colorama.ansi.AnsiFore attribute)}
+\index{formatValue() (in module src.utilsSat)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.GREEN}}\pysigline{\sphinxbfcode{\sphinxupquote{GREEN}}\sphinxbfcode{\sphinxupquote{ = 32}}}
+\phantomsection\label{commands/apidoc/src:src.utilsSat.formatValue}\pysiglinewithargsret{\sphinxcode{src.utilsSat.}\sphinxbfcode{formatValue}}{\emph{label}, \emph{value}, \emph{suffix='`}}{}
+format `label = value' with the info color
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{\texttt{int}} ({\hyperref[commands/apidoc/src:src.utilsSat.label]{\sphinxcrossref{\emph{\texttt{label}}}}} (\autopageref*{commands/apidoc/src:src.utilsSat.label})) -- the label to print.
+
+\item {}
+\textbf{\texttt{str}} (\emph{\texttt{suffix}}) -- the value to print.
+
+\item {}
+\textbf{\texttt{str}} -- the optionnal suffix to add at the end.
+
+\end{itemize}
+
+\end{description}\end{quote}
+
\end{fulllineitems}
-\index{LIGHTBLACK\_EX (src.colorama.ansi.AnsiFore attribute)}
+\index{get\_base\_path() (in module src.utilsSat)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTBLACK_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTBLACK\_EX}}\sphinxbfcode{\sphinxupquote{ = 90}}}
+\phantomsection\label{commands/apidoc/src:src.utilsSat.get_base_path}\pysiglinewithargsret{\sphinxcode{src.utilsSat.}\sphinxbfcode{get\_base\_path}}{\emph{config}}{}
+Returns the path of the products base.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{\texttt{Config}} (\emph{\texttt{config}}) -- The global Config instance.
+
+\item[{Returns}] \leavevmode
+The path of the products base.
+
+\item[{Return type}] \leavevmode
+str
+
+\end{description}\end{quote}
+
\end{fulllineitems}
-\index{LIGHTBLUE\_EX (src.colorama.ansi.AnsiFore attribute)}
+\index{get\_cfg\_param() (in module src.utilsSat)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTBLUE_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTBLUE\_EX}}\sphinxbfcode{\sphinxupquote{ = 94}}}
+\phantomsection\label{commands/apidoc/src:src.utilsSat.get_cfg_param}\pysiglinewithargsret{\sphinxcode{src.utilsSat.}\sphinxbfcode{get\_cfg\_param}}{\emph{config}, \emph{param\_name}, \emph{default}}{}~\begin{description}
+\item[{Search for param\_name value in config.}] \leavevmode
+If param\_name is not in config, then return default,
+else, return the found value
+
+\end{description}
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{\texttt{class 'common.pyconf.Config'}} (\emph{\texttt{config}}) -- The config.
+
+\item {}
+\textbf{\texttt{str}} (\emph{\texttt{default}}) -- the name of the parameter to get the value
+
+\item {}
+\textbf{\texttt{str}} -- The value to return if param\_name is not in config
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+see initial description of the function
+
+\item[{Return type}] \leavevmode
+str
+
+\end{description}\end{quote}
+
\end{fulllineitems}
-\index{LIGHTCYAN\_EX (src.colorama.ansi.AnsiFore attribute)}
+\index{get\_launcher\_name() (in module src.utilsSat)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTCYAN_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTCYAN\_EX}}\sphinxbfcode{\sphinxupquote{ = 96}}}
+\phantomsection\label{commands/apidoc/src:src.utilsSat.get_launcher_name}\pysiglinewithargsret{\sphinxcode{src.utilsSat.}\sphinxbfcode{get\_launcher\_name}}{\emph{config}}{}
+Returns the name of salome launcher.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{\texttt{Config}} (\emph{\texttt{config}}) -- The global Config instance.
+
+\item[{Returns}] \leavevmode
+The name of salome launcher.
+
+\item[{Return type}] \leavevmode
+str
+
+\end{description}\end{quote}
+
\end{fulllineitems}
-\index{LIGHTGREEN\_EX (src.colorama.ansi.AnsiFore attribute)}
+\index{get\_log\_path() (in module src.utilsSat)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTGREEN_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTGREEN\_EX}}\sphinxbfcode{\sphinxupquote{ = 92}}}
+\phantomsection\label{commands/apidoc/src:src.utilsSat.get_log_path}\pysiglinewithargsret{\sphinxcode{src.utilsSat.}\sphinxbfcode{get\_log\_path}}{\emph{config}}{}
+Returns the path of the logs.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{\texttt{Config}} (\emph{\texttt{config}}) -- The global Config instance.
+
+\item[{Returns}] \leavevmode
+The path of the logs.
+
+\item[{Return type}] \leavevmode
+str
+
+\end{description}\end{quote}
+
\end{fulllineitems}
-\index{LIGHTMAGENTA\_EX (src.colorama.ansi.AnsiFore attribute)}
+\index{get\_property\_in\_product\_cfg() (in module src.utilsSat)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTMAGENTA_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTMAGENTA\_EX}}\sphinxbfcode{\sphinxupquote{ = 95}}}
+\phantomsection\label{commands/apidoc/src:src.utilsSat.get_property_in_product_cfg}\pysiglinewithargsret{\sphinxcode{src.utilsSat.}\sphinxbfcode{get\_property\_in\_product\_cfg}}{\emph{product\_cfg}, \emph{pprty}}{}
\end{fulllineitems}
-\index{LIGHTRED\_EX (src.colorama.ansi.AnsiFore attribute)}
+\index{get\_salome\_version() (in module src.utilsSat)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTRED_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTRED\_EX}}\sphinxbfcode{\sphinxupquote{ = 91}}}
+\phantomsection\label{commands/apidoc/src:src.utilsSat.get_salome_version}\pysiglinewithargsret{\sphinxcode{src.utilsSat.}\sphinxbfcode{get\_salome\_version}}{\emph{config}}{}
\end{fulllineitems}
-\index{LIGHTWHITE\_EX (src.colorama.ansi.AnsiFore attribute)}
+\index{get\_tmp\_filename() (in module src.utilsSat)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTWHITE_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTWHITE\_EX}}\sphinxbfcode{\sphinxupquote{ = 97}}}
+\phantomsection\label{commands/apidoc/src:src.utilsSat.get_tmp_filename}\pysiglinewithargsret{\sphinxcode{src.utilsSat.}\sphinxbfcode{get\_tmp\_filename}}{\emph{config}, \emph{name}}{}
\end{fulllineitems}
-\index{LIGHTYELLOW\_EX (src.colorama.ansi.AnsiFore attribute)}
+\index{green() (in module src.utilsSat)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTYELLOW_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTYELLOW\_EX}}\sphinxbfcode{\sphinxupquote{ = 93}}}
+\phantomsection\label{commands/apidoc/src:src.utilsSat.green}\pysiglinewithargsret{\sphinxcode{src.utilsSat.}\sphinxbfcode{green}}{\emph{msg}}{}
\end{fulllineitems}
-\index{MAGENTA (src.colorama.ansi.AnsiFore attribute)}
+\index{handleRemoveReadonly() (in module src.utilsSat)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.MAGENTA}}\pysigline{\sphinxbfcode{\sphinxupquote{MAGENTA}}\sphinxbfcode{\sphinxupquote{ = 35}}}
+\phantomsection\label{commands/apidoc/src:src.utilsSat.handleRemoveReadonly}\pysiglinewithargsret{\sphinxcode{src.utilsSat.}\sphinxbfcode{handleRemoveReadonly}}{\emph{func}, \emph{path}, \emph{exc}}{}
\end{fulllineitems}
-\index{RED (src.colorama.ansi.AnsiFore attribute)}
+\index{header() (in module src.utilsSat)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.RED}}\pysigline{\sphinxbfcode{\sphinxupquote{RED}}\sphinxbfcode{\sphinxupquote{ = 31}}}
+\phantomsection\label{commands/apidoc/src:src.utilsSat.header}\pysiglinewithargsret{\sphinxcode{src.utilsSat.}\sphinxbfcode{header}}{\emph{msg}}{}
\end{fulllineitems}
-\index{RESET (src.colorama.ansi.AnsiFore attribute)}
+\index{info() (in module src.utilsSat)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.RESET}}\pysigline{\sphinxbfcode{\sphinxupquote{RESET}}\sphinxbfcode{\sphinxupquote{ = 39}}}
+\phantomsection\label{commands/apidoc/src:src.utilsSat.info}\pysiglinewithargsret{\sphinxcode{src.utilsSat.}\sphinxbfcode{info}}{\emph{msg}}{}
\end{fulllineitems}
-\index{WHITE (src.colorama.ansi.AnsiFore attribute)}
+\index{label() (in module src.utilsSat)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.WHITE}}\pysigline{\sphinxbfcode{\sphinxupquote{WHITE}}\sphinxbfcode{\sphinxupquote{ = 37}}}
+\phantomsection\label{commands/apidoc/src:src.utilsSat.label}\pysiglinewithargsret{\sphinxcode{src.utilsSat.}\sphinxbfcode{label}}{\emph{msg}}{}
\end{fulllineitems}
-\index{YELLOW (src.colorama.ansi.AnsiFore attribute)}
+\index{list\_log\_file() (in module src.utilsSat)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.YELLOW}}\pysigline{\sphinxbfcode{\sphinxupquote{YELLOW}}\sphinxbfcode{\sphinxupquote{ = 33}}}
-\end{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.utilsSat.list_log_file}\pysiglinewithargsret{\sphinxcode{src.utilsSat.}\sphinxbfcode{list\_log\_file}}{\emph{dirPath}, \emph{expression}}{}
+Find all files corresponding to expression in dirPath
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{\texttt{str}} (\emph{\texttt{expression}}) -- the directory where to search the files
+
+\item {}
+\textbf{\texttt{str}} -- the regular expression of files to find
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+the list of files path and informations about it
+\item[{Return type}] \leavevmode
+{\hyperref[commands/apidoc/src:src.utilsSat.Path.list]{\sphinxcrossref{list}}} (\autopageref*{commands/apidoc/src:src.utilsSat.Path.list})
+
+\end{description}\end{quote}
\end{fulllineitems}
-\index{AnsiStyle (class in src.colorama.ansi)}
+\index{logger\_info\_tuples() (in module src.utilsSat)}
\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{commands/apidoc/src:src.utilsSat.logger_info_tuples}\pysiglinewithargsret{\sphinxcode{src.utilsSat.}\sphinxbfcode{logger\_info\_tuples}}{\emph{logger}, \emph{tuples}}{}
+for convenience
+format as formatTuples() and call logger.info()
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle.BRIGHT}}\pysigline{\sphinxbfcode{\sphinxupquote{BRIGHT}}\sphinxbfcode{\sphinxupquote{ = 1}}}
\end{fulllineitems}
-\index{DIM (src.colorama.ansi.AnsiStyle attribute)}
+\index{magenta() (in module src.utilsSat)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle.DIM}}\pysigline{\sphinxbfcode{\sphinxupquote{DIM}}\sphinxbfcode{\sphinxupquote{ = 2}}}
+\phantomsection\label{commands/apidoc/src:src.utilsSat.magenta}\pysiglinewithargsret{\sphinxcode{src.utilsSat.}\sphinxbfcode{magenta}}{\emph{msg}}{}
\end{fulllineitems}
-\index{NORMAL (src.colorama.ansi.AnsiStyle attribute)}
+\index{merge\_dicts() (in module src.utilsSat)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle.NORMAL}}\pysigline{\sphinxbfcode{\sphinxupquote{NORMAL}}\sphinxbfcode{\sphinxupquote{ = 22}}}
+\phantomsection\label{commands/apidoc/src:src.utilsSat.merge_dicts}\pysiglinewithargsret{\sphinxcode{src.utilsSat.}\sphinxbfcode{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{RESET\_ALL (src.colorama.ansi.AnsiStyle attribute)}
+\index{normal() (in module src.utilsSat)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle.RESET_ALL}}\pysigline{\sphinxbfcode{\sphinxupquote{RESET\_ALL}}\sphinxbfcode{\sphinxupquote{ = 0}}}
+\phantomsection\label{commands/apidoc/src:src.utilsSat.normal}\pysiglinewithargsret{\sphinxcode{src.utilsSat.}\sphinxbfcode{normal}}{\emph{msg}}{}
\end{fulllineitems}
+\index{only\_numbers() (in module src.utilsSat)}
+\begin{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.utilsSat.only_numbers}\pysiglinewithargsret{\sphinxcode{src.utilsSat.}\sphinxbfcode{only\_numbers}}{\emph{str\_num}}{}
\end{fulllineitems}
-\index{clear\_line() (in module src.colorama.ansi)}
+\index{parse\_date() (in module src.utilsSat)}
\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}}{}
+\phantomsection\label{commands/apidoc/src:src.utilsSat.parse_date}\pysiglinewithargsret{\sphinxcode{src.utilsSat.}\sphinxbfcode{parse\_date}}{\emph{date}}{}
+Transform YYYYMMDD\_hhmmss into YYYY-MM-DD hh:mm:ss.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{\texttt{str}} (\emph{\texttt{date}}) -- The date to transform
+
+\item[{Returns}] \leavevmode
+The date in the new format
+
+\item[{Return type}] \leavevmode
+str
+
+\end{description}\end{quote}
+
\end{fulllineitems}
-\index{clear\_screen() (in module src.colorama.ansi)}
+\index{read\_config\_from\_a\_file() (in module src.utilsSat)}
\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}}{}
+\phantomsection\label{commands/apidoc/src:src.utilsSat.read_config_from_a_file}\pysiglinewithargsret{\sphinxcode{src.utilsSat.}\sphinxbfcode{read\_config\_from\_a\_file}}{\emph{filePath}}{}
\end{fulllineitems}
-\index{code\_to\_chars() (in module src.colorama.ansi)}
+\index{red() (in module src.utilsSat)}
\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}}{}
+\phantomsection\label{commands/apidoc/src:src.utilsSat.red}\pysiglinewithargsret{\sphinxcode{src.utilsSat.}\sphinxbfcode{red}}{\emph{msg}}{}
\end{fulllineitems}
-\index{set\_title() (in module src.colorama.ansi)}
+\index{remove\_item\_from\_list() (in module src.utilsSat)}
\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}
+\phantomsection\label{commands/apidoc/src:src.utilsSat.remove_item_from_list}\pysiglinewithargsret{\sphinxcode{src.utilsSat.}\sphinxbfcode{remove\_item\_from\_list}}{\emph{input\_list}, \emph{item}}{}
+Remove all occurences of item from input\_list
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{\texttt{List}} (\emph{\texttt{input\_list}}) -- The list to modify
+
+\item[{Returns}] \leavevmode
+The without any item
+\item[{Return type}] \leavevmode
+List
+
+\end{description}\end{quote}
+\end{fulllineitems}
-\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)}
+\index{replace\_in\_file() (in module src.utilsSat)}
\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}}
+\phantomsection\label{commands/apidoc/src:src.utilsSat.replace_in_file}\pysiglinewithargsret{\sphinxcode{src.utilsSat.}\sphinxbfcode{replace\_in\_file}}{\emph{filein}, \emph{strin}, \emph{strout}}{}
+Replace \textless{}strin\textgreater{} by \textless{}strout\textgreater{} in file \textless{}filein\textgreater{}
-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{fulllineitems}
+
+\index{reset() (in module src.utilsSat)}
\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{}}}}
+\phantomsection\label{commands/apidoc/src:src.utilsSat.reset}\pysiglinewithargsret{\sphinxcode{src.utilsSat.}\sphinxbfcode{reset}}{\emph{msg}}{}
\end{fulllineitems}
-\index{ANSI\_OSC\_RE (src.colorama.ansitowin32.AnsiToWin32 attribute)}
+\index{show\_command\_log() (in module src.utilsSat)}
\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{commands/apidoc/src:src.utilsSat.show_command_log}\pysiglinewithargsret{\sphinxcode{src.utilsSat.}\sphinxbfcode{show\_command\_log}}{\emph{logFilePath}, \emph{cmd}, \emph{application}, \emph{notShownCommands}}{}
+Used in updateHatXml.
+Determine if the log xml file logFilePath
+has to be shown or not in the hat log.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{\texttt{str}} (\emph{\texttt{application}}) -- the path to the command xml log file
+
+\item {}
+\textbf{\texttt{str}} -- the command of the log file
+
+\item {}
+\textbf{\texttt{str}} -- the application passed as parameter
+to the salomeTools command
+
+\item {}
+\textbf{\texttt{list}} (\emph{\texttt{notShownCommands}}) -- the list of commands
+that are not shown by default
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+RCO.ReturnCode(``OK'') if cmd is not in notShownCommands and the application
+in the log file corresponds to application
+ReturnCode value is tuple (appliLog, launched\_cmd)
-\index{call\_win32() (src.colorama.ansitowin32.AnsiToWin32 method)}
+\end{description}\end{quote}
-\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}
-\index{convert\_ansi() (src.colorama.ansitowin32.AnsiToWin32 method)}
+\index{success() (in module src.utilsSat)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.convert_ansi}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{convert\_ansi}}}{\emph{paramstring}, \emph{command}}{}
+\phantomsection\label{commands/apidoc/src:src.utilsSat.success}\pysiglinewithargsret{\sphinxcode{src.utilsSat.}\sphinxbfcode{success}}{\emph{msg}}{}
\end{fulllineitems}
-\index{convert\_osc() (src.colorama.ansitowin32.AnsiToWin32 method)}
+\index{timedelta\_total\_seconds() (in module src.utilsSat)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.convert_osc}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{convert\_osc}}}{\emph{text}}{}
-\end{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.utilsSat.timedelta_total_seconds}\pysiglinewithargsret{\sphinxcode{src.utilsSat.}\sphinxbfcode{timedelta\_total\_seconds}}{\emph{timedelta}}{}
+Replace total\_seconds from datetime module
+in order to be compatible with old python versions
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{\texttt{datetime.timedelta}} (\emph{\texttt{timedelta}}) -- The delta between two dates
-\index{extract\_params() (src.colorama.ansitowin32.AnsiToWin32 method)}
+\item[{Returns}] \leavevmode
+The number of seconds corresponding to timedelta.
-\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}
+\item[{Return type}] \leavevmode
+float
-\index{get\_win32\_calls() (src.colorama.ansitowin32.AnsiToWin32 method)}
+\end{description}\end{quote}
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.get_win32_calls}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_win32\_calls}}}{}{}
\end{fulllineitems}
-\index{reset\_all() (src.colorama.ansitowin32.AnsiToWin32 method)}
+\index{update\_hat\_xml() (in module src.utilsSat)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.reset_all}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{reset\_all}}}{}{}
-\end{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.utilsSat.update_hat_xml}\pysiglinewithargsret{\sphinxcode{src.utilsSat.}\sphinxbfcode{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 {}
+\textbf{\texttt{str}} (\emph{\texttt{application}}) -- the directory to parse
-\index{should\_wrap() (src.colorama.ansitowin32.AnsiToWin32 method)}
+\item {}
+\textbf{\texttt{str}} -- the name of the application if there is any
-\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{itemize}
+
+\end{description}\end{quote}
\end{fulllineitems}
-\index{write() (src.colorama.ansitowin32.AnsiToWin32 method)}
+\index{warning() (in module src.utilsSat)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.write}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write}}}{\emph{text}}{}
+\phantomsection\label{commands/apidoc/src:src.utilsSat.warning}\pysiglinewithargsret{\sphinxcode{src.utilsSat.}\sphinxbfcode{warning}}{\emph{msg}}{}
\end{fulllineitems}
-\index{write\_and\_convert() (src.colorama.ansitowin32.AnsiToWin32 method)}
+\index{white() (in module src.utilsSat)}
\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{commands/apidoc/src:src.utilsSat.white}\pysiglinewithargsret{\sphinxcode{src.utilsSat.}\sphinxbfcode{white}}{\emph{msg}}{}
\end{fulllineitems}
-\index{write\_plain\_text() (src.colorama.ansitowin32.AnsiToWin32 method)}
+\index{yellow() (in module src.utilsSat)}
\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{commands/apidoc/src:src.utilsSat.yellow}\pysiglinewithargsret{\sphinxcode{src.utilsSat.}\sphinxbfcode{yellow}}{\emph{msg}}{}
\end{fulllineitems}
-\end{fulllineitems}
-\index{StreamWrapper (class in src.colorama.ansitowin32)}
+\subsubsection{src.xmlManager module}
+\label{commands/apidoc/src:src-xmlmanager-module}\label{commands/apidoc/src:module-src.xmlManager}\index{src.xmlManager (module)}
+Utilities to read xml logging files
+\begin{description}
+\item[{usage:}] \leavevmode
+\textgreater{}\textgreater{} import src.xmlManager as XMLMGR
+
+\end{description}
+\index{ReadXmlFile (class in src.xmlManager)}
\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{commands/apidoc/src:src.xmlManager.ReadXmlFile}\pysiglinewithargsret{\sphinxstrong{class }\sphinxcode{src.xmlManager.}\sphinxbfcode{ReadXmlFile}}{\emph{filePath}}{}
+Bases: \sphinxcode{object}
-Wraps a stream (such as stdout), acting as a transparent proxy for all
-attribute access apart from method ‘write()’, which is delegated to our
-Converter instance.
-\index{write() (src.colorama.ansitowin32.StreamWrapper method)}
+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.ansitowin32.StreamWrapper.write}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write}}}{\emph{text}}{}
-\end{fulllineitems}
-
+\phantomsection\label{commands/apidoc/src:src.xmlManager.ReadXmlFile.getRootAttrib}\pysiglinewithargsret{\sphinxbfcode{getRootAttrib}}{}{}
+Get the attibutes of the self.xmlroot
+\begin{quote}\begin{description}
+\item[{Returns}] \leavevmode
+The attributes of the root node
-\end{fulllineitems}
+\item[{Return type}] \leavevmode
+dict
-\index{is\_a\_tty() (in module src.colorama.ansitowin32)}
+\end{description}\end{quote}
-\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}}{}
\end{fulllineitems}
-\index{is\_stream\_closed() (in module src.colorama.ansitowin32)}
+\index{get\_attrib() (src.xmlManager.ReadXmlFile 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}}{}
-\end{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.xmlManager.ReadXmlFile.get_attrib}\pysiglinewithargsret{\sphinxbfcode{get\_attrib}}{\emph{node\_name}}{}
+Get the attibutes of the node node\_name in self.xmlroot
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{\texttt{str}} (\emph{\texttt{node\_name}}) -- the name of the node
+\item[{Returns}] \leavevmode
+the attibutes of the node node\_name in self.xmlroot
+\item[{Return type}] \leavevmode
+dict
-\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)}
+\end{description}\end{quote}
-\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}}{}
\end{fulllineitems}
-\index{deinit() (in module src.colorama.initialise)}
+\index{get\_node\_text() (src.xmlManager.ReadXmlFile method)}
\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{init() (in module src.colorama.initialise)}
+\phantomsection\label{commands/apidoc/src:src.xmlManager.ReadXmlFile.get_node_text}\pysiglinewithargsret{\sphinxbfcode{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.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}
+\end{description}
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{\texttt{str}} (\emph{\texttt{node}}) -- the name of the node from which get the text
-\index{reinit() (in module src.colorama.initialise)}
+\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.initialise.reinit}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.initialise.}}\sphinxbfcode{\sphinxupquote{reinit}}}{}{}
-\end{fulllineitems}
+\item[{Return type}] \leavevmode
+str
-\index{reset\_all() (in module src.colorama.initialise)}
+\end{description}\end{quote}
-\begin{fulllineitems}
-\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{wrap\_stream() (in module src.colorama.initialise)}
-\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}}{}
\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{XmlLogFile (class in src.xmlManager)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.win32.SetConsoleTextAttribute}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.win32.}}\sphinxbfcode{\sphinxupquote{SetConsoleTextAttribute}}}{\emph{*\_}}{}
-\end{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.xmlManager.XmlLogFile}\pysiglinewithargsret{\sphinxstrong{class }\sphinxcode{src.xmlManager.}\sphinxbfcode{XmlLogFile}}{\emph{filePath}, \emph{rootname}, \emph{attrib=\{\}}}{}
+Bases: \sphinxcode{object}
-\index{winapi\_test() (in module src.colorama.win32)}
+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.win32.winapi_test}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.win32.}}\sphinxbfcode{\sphinxupquote{winapi\_test}}}{\emph{*\_}}{}
-\end{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.xmlManager.XmlLogFile.add_simple_node}\pysiglinewithargsret{\sphinxbfcode{add\_simple\_node}}{\emph{node\_name}, \emph{text=None}, \emph{attrib=\{\}}}{}
+Add a node with some attibutes and text to the root node.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{\texttt{str}} (\emph{\texttt{text}}) -- the name of the node to add
+\item {}
+\textbf{\texttt{str}} -- the text of the node
+\item {}
+\textbf{\texttt{dict}} (\emph{\texttt{attrib}}) -- the dictionary containing the
+attribute of the new node
-\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)}
+\end{itemize}
-\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)}
+\end{description}\end{quote}
-\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{append\_node\_attrib() (src.xmlManager.XmlLogFile method)}
\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{commands/apidoc/src:src.xmlManager.XmlLogFile.append_node_attrib}\pysiglinewithargsret{\sphinxbfcode{append\_node\_attrib}}{\emph{node\_name}, \emph{attrib}}{}
+Append a new attributes to the node that has node\_name as name
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{\texttt{str}} (\emph{\texttt{node\_name}}) -- The name of the node on which append text
-\index{CYAN (src.colorama.winterm.WinColor attribute)}
+\item {}
+\textbf{\texttt{dixt}} (\emph{\texttt{attrib}}) -- The attrib to append
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.CYAN}}\pysigline{\sphinxbfcode{\sphinxupquote{CYAN}}\sphinxbfcode{\sphinxupquote{ = 3}}}
-\end{fulllineitems}
+\end{itemize}
-\index{GREEN (src.colorama.winterm.WinColor attribute)}
+\end{description}\end{quote}
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.GREEN}}\pysigline{\sphinxbfcode{\sphinxupquote{GREEN}}\sphinxbfcode{\sphinxupquote{ = 2}}}
\end{fulllineitems}
-\index{GREY (src.colorama.winterm.WinColor attribute)}
+\index{append\_node\_text() (src.xmlManager.XmlLogFile method)}
\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.GREY}}\pysigline{\sphinxbfcode{\sphinxupquote{GREY}}\sphinxbfcode{\sphinxupquote{ = 7}}}
-\end{fulllineitems}
+\phantomsection\label{commands/apidoc/src:src.xmlManager.XmlLogFile.append_node_text}\pysiglinewithargsret{\sphinxbfcode{append\_node\_text}}{\emph{node\_name}, \emph{text}}{}
+Append a new text to the node that has node\_name as name
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{\texttt{str}} (\emph{\texttt{text}}) -- The name of the node on which append text
-\index{MAGENTA (src.colorama.winterm.WinColor attribute)}
+\item {}
+\textbf{\texttt{str}} -- The text to append
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.MAGENTA}}\pysigline{\sphinxbfcode{\sphinxupquote{MAGENTA}}\sphinxbfcode{\sphinxupquote{ = 5}}}
-\end{fulllineitems}
+\end{itemize}
-\index{RED (src.colorama.winterm.WinColor attribute)}
+\end{description}\end{quote}
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.RED}}\pysigline{\sphinxbfcode{\sphinxupquote{RED}}\sphinxbfcode{\sphinxupquote{ = 4}}}
\end{fulllineitems}
-\index{YELLOW (src.colorama.winterm.WinColor attribute)}
+\index{write\_tree() (src.xmlManager.XmlLogFile method)}
\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{commands/apidoc/src:src.xmlManager.XmlLogFile.write_tree}\pysiglinewithargsret{\sphinxbfcode{write\_tree}}{\emph{stylesheet=None}, \emph{file\_path=None}}{}
+Write the xml tree in the log file path. Add the stylesheet if asked.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\textbf{\texttt{str}} (\emph{\texttt{stylesheet}}) -- The stylesheet to apply to the xml file
+\end{description}\end{quote}
\end{fulllineitems}
-\index{WinStyle (class in src.colorama.winterm)}
-
-\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)}
-\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{add\_simple\_node() (in module src.xmlManager)}
\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}
-
-\index{NORMAL (src.colorama.winterm.WinStyle attribute)}
+\phantomsection\label{commands/apidoc/src:src.xmlManager.add_simple_node}\pysiglinewithargsret{\sphinxcode{src.xmlManager.}\sphinxbfcode{add\_simple\_node}}{\emph{root\_node}, \emph{node\_name}, \emph{text=None}, \emph{attrib=\{\}}}{}
+Add a node with some attibutes and text to the root node.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{\texttt{etree.Element}} (\emph{\texttt{root\_node}}) -- the Etree element where to add the new node
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinStyle.NORMAL}}\pysigline{\sphinxbfcode{\sphinxupquote{NORMAL}}\sphinxbfcode{\sphinxupquote{ = 0}}}
-\end{fulllineitems}
+\item {}
+\textbf{\texttt{str}} (\emph{\texttt{text}}) -- the name of the node to add
+\item {}
+\textbf{\texttt{str}} -- the text of the node
-\end{fulllineitems}
+\item {}
+\textbf{\texttt{dict}} (\emph{\texttt{attrib}}) -- the dictionary containing the
+attribute of the new node
-\index{WinTerm (class in src.colorama.winterm)}
+\end{itemize}
-\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)}
+\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{append\_node\_attrib() (in module src.xmlManager)}
\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}
+\phantomsection\label{commands/apidoc/src:src.xmlManager.append_node_attrib}\pysiglinewithargsret{\sphinxcode{src.xmlManager.}\sphinxbfcode{append\_node\_attrib}}{\emph{root\_node}, \emph{attrib}}{}
+Append a new attributes to the node that has node\_name as name
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{\texttt{etree.Element}} (\emph{\texttt{root\_node}}) -- the Etree element
+where to append the new attibutes
-\index{erase\_line() (src.colorama.winterm.WinTerm method)}
+\item {}
+\textbf{\texttt{dixt}} (\emph{\texttt{attrib}}) -- The attrib to append
-\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}
+\end{itemize}
-\index{erase\_screen() (src.colorama.winterm.WinTerm method)}
+\end{description}\end{quote}
-\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}}{}
\end{fulllineitems}
-\index{fore() (src.colorama.winterm.WinTerm method)}
+\index{find\_node\_by\_attrib() (in module src.xmlManager)}
\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}
-
-\index{get\_attrs() (src.colorama.winterm.WinTerm method)}
+\phantomsection\label{commands/apidoc/src:src.xmlManager.find_node_by_attrib}\pysiglinewithargsret{\sphinxcode{src.xmlManager.}\sphinxbfcode{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
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.get_attrs}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_attrs}}}{}{}
-\end{fulllineitems}
+\end{description}
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{\texttt{etree.Element}} (\emph{\texttt{xmlroot}}) -- the Etree element where to search
-\index{get\_position() (src.colorama.winterm.WinTerm method)}
+\item {}
+\textbf{\texttt{str}} (\emph{\texttt{value}}) -- the name of node to search
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.get_position}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_position}}}{\emph{handle}}{}
-\end{fulllineitems}
+\item {}
+\textbf{\texttt{str}} -- the key to search
-\index{reset\_all() (src.colorama.winterm.WinTerm method)}
+\item {}
+\textbf{\texttt{str}} -- the value to search
-\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}
+\end{itemize}
-\index{set\_attrs() (src.colorama.winterm.WinTerm method)}
+\item[{Returns}] \leavevmode
+the found node
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.set_attrs}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_attrs}}}{\emph{value}}{}
-\end{fulllineitems}
+\item[{Return type}] \leavevmode
+xmlroot etree.Element
-\index{set\_console() (src.colorama.winterm.WinTerm method)}
+\end{description}\end{quote}
-\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}}{}
\end{fulllineitems}
-\index{set\_cursor\_position() (src.colorama.winterm.WinTerm method)}
+\index{write\_report() (in module src.xmlManager)}
\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{set\_title() (src.colorama.winterm.WinTerm method)}
+\phantomsection\label{commands/apidoc/src:src.xmlManager.write_report}\pysiglinewithargsret{\sphinxcode{src.xmlManager.}\sphinxbfcode{write\_report}}{\emph{filename}, \emph{xmlroot}, \emph{stylesheet}}{}
+Writes a report file from a XML tree.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {}
+\textbf{\texttt{str}} (\emph{\texttt{stylesheet}}) -- The path to the file to create
-\begin{fulllineitems}
-\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.set_title}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_title}}}{\emph{title}}{}
-\end{fulllineitems}
+\item {}
+\textbf{\texttt{etree.Element}} (\emph{\texttt{xmlroot}}) -- the Etree element to write to the file
-\index{style() (src.colorama.winterm.WinTerm method)}
+\item {}
+\textbf{\texttt{str}} -- The stylesheet to add to the begin of the file
-\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{itemize}
+\end{description}\end{quote}
\end{fulllineitems}
+\subsubsection{Module contents}
+\label{commands/apidoc/src:module-src}\label{commands/apidoc/src:module-contents}\index{src (module)}
+
\chapter{Release Notes}
-\label{\detokenize{index:release-notes}}
+\label{index:release-notes}
\section{Release notes}
-\label{\detokenize{release_notes/release_notes_5.0.0:release-notes}}\label{\detokenize{release_notes/release_notes_5.0.0::doc}}
+\label{release_notes/release_notes_5.0.0:release-notes}\label{release_notes/release_notes_5.0.0::doc}
In construction.
\renewcommand{\indexname}{Python Module Index}
-\begin{sphinxtheindex}
+\begin{theindex}
\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.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}}
-\item {\sphinxstyleindexentry{src.colorama.ansitowin32}}\sphinxstyleindexpageref{commands/apidoc/src.colorama:\detokenize{module-src.colorama.ansitowin32}}
-\item {\sphinxstyleindexentry{src.colorama.initialise}}\sphinxstyleindexpageref{commands/apidoc/src.colorama:\detokenize{module-src.colorama.initialise}}
-\item {\sphinxstyleindexentry{src.colorama.win32}}\sphinxstyleindexpageref{commands/apidoc/src.colorama:\detokenize{module-src.colorama.win32}}
-\item {\sphinxstyleindexentry{src.colorama.winterm}}\sphinxstyleindexpageref{commands/apidoc/src.colorama:\detokenize{module-src.colorama.winterm}}
-\item {\sphinxstyleindexentry{src.compilation}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.compilation}}
-\item {\sphinxstyleindexentry{src.debug}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.debug}}
-\item {\sphinxstyleindexentry{src.ElementTree}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.ElementTree}}
-\item {\sphinxstyleindexentry{src.environment}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.environment}}
-\item {\sphinxstyleindexentry{src.fileEnviron}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.fileEnviron}}
-\item {\sphinxstyleindexentry{src.fork}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.fork}}
-\item {\sphinxstyleindexentry{src.logger}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.logger}}
-\item {\sphinxstyleindexentry{src.options}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.options}}
-\item {\sphinxstyleindexentry{src.printcolors}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.printcolors}}
-\item {\sphinxstyleindexentry{src.product}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.product}}
-\item {\sphinxstyleindexentry{src.pyconf}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.pyconf}}
-\item {\sphinxstyleindexentry{src.system}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.system}}
-\item {\sphinxstyleindexentry{src.template}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.template}}
-\item {\sphinxstyleindexentry{src.test\_module}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.test_module}}
-\item {\sphinxstyleindexentry{src.xmlManager}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.xmlManager}}
-\end{sphinxtheindex}
+\item {\texttt{src}}, \pageref{commands/apidoc/src:module-src}
+\item {\texttt{src.architecture}}, \pageref{commands/apidoc/src:module-src.architecture}
+\item {\texttt{src.catchAll}}, \pageref{commands/apidoc/src:module-src.catchAll}
+\item {\texttt{src.colorama}}, \pageref{commands/apidoc/src.colorama:module-src.colorama}
+\item {\texttt{src.colorama.ansi}}, \pageref{commands/apidoc/src.colorama:module-src.colorama.ansi}
+\item {\texttt{src.colorama.ansitowin32}}, \pageref{commands/apidoc/src.colorama:module-src.colorama.ansitowin32}
+\item {\texttt{src.colorama.initialise}}, \pageref{commands/apidoc/src.colorama:module-src.colorama.initialise}
+\item {\texttt{src.colorama.win32}}, \pageref{commands/apidoc/src.colorama:module-src.colorama.win32}
+\item {\texttt{src.colorama.winterm}}, \pageref{commands/apidoc/src.colorama:module-src.colorama.winterm}
+\item {\texttt{src.coloringSat}}, \pageref{commands/apidoc/src:module-src.coloringSat}
+\item {\texttt{src.compilation}}, \pageref{commands/apidoc/src:module-src.compilation}
+\item {\texttt{src.configManager}}, \pageref{commands/apidoc/src:module-src.configManager}
+\item {\texttt{src.debug}}, \pageref{commands/apidoc/src:module-src.debug}
+\item {\texttt{src.ElementTree}}, \pageref{commands/apidoc/src:module-src.ElementTree}
+\item {\texttt{src.environment}}, \pageref{commands/apidoc/src:module-src.environment}
+\item {\texttt{src.environs}}, \pageref{commands/apidoc/src:module-src.environs}
+\item {\texttt{src.example}}, \pageref{commands/apidoc/src.example:module-src.example}
+\item {\texttt{src.example.essai\_logging\_1}}, \pageref{commands/apidoc/src.example:module-src.example.essai_logging_1}
+\item {\texttt{src.example.essai\_logging\_2}}, \pageref{commands/apidoc/src.example:module-src.example.essai_logging_2}
+\item {\texttt{src.exceptionSat}}, \pageref{commands/apidoc/src:module-src.exceptionSat}
+\item {\texttt{src.fileEnviron}}, \pageref{commands/apidoc/src:module-src.fileEnviron}
+\item {\texttt{src.fork}}, \pageref{commands/apidoc/src:module-src.fork}
+\item {\texttt{src.loggingSat}}, \pageref{commands/apidoc/src:module-src.loggingSat}
+\item {\texttt{src.options}}, \pageref{commands/apidoc/src:module-src.options}
+\item {\texttt{src.product}}, \pageref{commands/apidoc/src:module-src.product}
+\item {\texttt{src.pyconf}}, \pageref{commands/apidoc/src:module-src.pyconf}
+\item {\texttt{src.returnCode}}, \pageref{commands/apidoc/src:module-src.returnCode}
+\item {\texttt{src.salomeTools}}, \pageref{commands/apidoc/src:module-src.salomeTools}
+\item {\texttt{src.system}}, \pageref{commands/apidoc/src:module-src.system}
+\item {\texttt{src.template}}, \pageref{commands/apidoc/src:module-src.template}
+\item {\texttt{src.test\_module}}, \pageref{commands/apidoc/src:module-src.test_module}
+\item {\texttt{src.utilsSat}}, \pageref{commands/apidoc/src:module-src.utilsSat}
+\item {\texttt{src.xmlManager}}, \pageref{commands/apidoc/src:module-src.xmlManager}
+\end{theindex}
\renewcommand{\indexname}{Index}
\printindex
-\end{document}
\ No newline at end of file
+\end{document}
+++ /dev/null
-\babel@toc {english}{}
-\contentsline {chapter}{\numberline {1}Quick start}{3}{chapter.1}
-\contentsline {section}{\numberline {1.1}Installation}{3}{section.1.1}
-\contentsline {section}{\numberline {1.2}Configuration}{3}{section.1.2}
-\contentsline {subsection}{\numberline {1.2.1}Syntax}{3}{subsection.1.2.1}
-\contentsline {subsection}{\numberline {1.2.2}Description}{3}{subsection.1.2.2}
-\contentsline {subsubsection}{VARS section}{3}{subsubsection*.3}
-\contentsline {subsubsection}{PRODUCTS section}{4}{subsubsection*.4}
-\contentsline {subsubsection}{APPLICATION section}{4}{subsubsection*.5}
-\contentsline {subsubsection}{USER section}{4}{subsubsection*.6}
-\contentsline {section}{\numberline {1.3}Usage of SAlomeTools}{5}{section.1.3}
-\contentsline {subsection}{\numberline {1.3.1}Usage}{5}{subsection.1.3.1}
-\contentsline {subsubsection}{Options of sat}{5}{subsubsection*.7}
-\contentsline {paragraph}{\sphinxstyleemphasis {\textendash {}help or -h}}{5}{paragraph*.8}
-\contentsline {paragraph}{\sphinxstyleemphasis {\textendash {}debug or -g}}{5}{paragraph*.9}
-\contentsline {paragraph}{\sphinxstyleemphasis {\textendash {}verbose or -v}}{5}{paragraph*.10}
-\contentsline {subsection}{\numberline {1.3.2}Build a SALOME product}{5}{subsection.1.3.2}
-\contentsline {subsubsection}{Get the list of available products}{5}{subsubsection*.11}
-\contentsline {subsubsection}{Prepare sources of a product}{5}{subsubsection*.12}
-\contentsline {subsubsection}{Compile SALOME}{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 {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.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.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 {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.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 {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.2}Basic requirements}{26}{subsection.3.1.2}
-\contentsline {subsection}{\numberline {3.1.3}HowTo access salomeTools config and other commands}{27}{subsection.3.1.3}
-\contentsline {subsection}{\numberline {3.1.4}HowTo logger}{27}{subsection.3.1.4}
-\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 {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}
%
\NeedsTeXFormat{LaTeX2e}[1995/12/01]
-\ProvidesPackage{sphinx}[2018/03/11 v1.7.2 LaTeX package (Sphinx markup)]
-
-% provides \ltx@ifundefined
-% (many packages load ltxcmds: graphicx does for pdftex and lualatex but
-% not xelatex, and anyhow kvoptions does, but it may be needed in future to
-% use \sphinxdeprecationwarning earlier, and it needs \ltx@ifundefined)
-\RequirePackage{ltxcmds}
-
-%% for deprecation warnings
-\newcommand\sphinxdeprecationwarning[4]{% #1 the deprecated macro or name,
-% #2 = when deprecated, #3 = when removed, #4 = additional info
- \edef\spx@tempa{\detokenize{#1}}%
- \ltx@ifundefined{sphinx_depr_\spx@tempa}{%
- \global\expandafter\let\csname sphinx_depr_\spx@tempa\endcsname\spx@tempa
- \expandafter\AtEndDocument\expandafter{\expandafter\let\expandafter
- \sphinxdeprecatedmacro\csname sphinx_depr_\spx@tempa\endcsname
- \PackageWarningNoLine{sphinx}{^^J**** SPHINX DEPRECATION WARNING:^^J
- \sphinxdeprecatedmacro^^J
- \@spaces- is deprecated at Sphinx #2^^J
- \@spaces- and removed at Sphinx #3.^^J
- #4^^J****}}%
- }{% warning already emitted (at end of latex log), don't repeat
- }}
-
-
-%% PACKAGES
-%
-% we delay handling of options to after having loaded packages, because
-% of the need to use \definecolor.
-\RequirePackage{graphicx}
+\ProvidesPackage{sphinx}[2010/01/15 LaTeX package (Sphinx markup)]
+
+% this is the \ltx@ifundefined of ltxcmds.sty, which is loaded by
+% hyperref.sty, but we need it before, and initial ltxcmds.sty
+% as in TL2009/Debian had wrong definition.
+\newcommand{\spx@ifundefined}[1]{%
+ \ifcsname #1\endcsname
+ \expandafter\ifx\csname #1\endcsname\relax
+ \expandafter\expandafter\expandafter\@firstoftwo
+ \else
+ \expandafter\expandafter\expandafter\@secondoftwo
+ \fi
+ \else
+ \expandafter\@firstoftwo
+ \fi
+}
+
\@ifclassloaded{memoir}{}{\RequirePackage{fancyhdr}}
+
% for \text macro and \iffirstchoice@ conditional even if amsmath not loaded
\RequirePackage{amstext}
-\RequirePackage{textcomp}% "warn" option issued from template
+\RequirePackage{textcomp}
+% fancybox not used anymore and will be removed at Sphinx-1.5
+\RequirePackage{fancybox}
\RequirePackage{titlesec}
-\@ifpackagelater{titlesec}{2016/03/15}%
- {\@ifpackagelater{titlesec}{2016/03/21}%
- {}%
- {\newif\ifsphinx@ttlpatch@ok
- \IfFileExists{etoolbox.sty}{%
- \RequirePackage{etoolbox}%
- \patchcmd{\ttlh@hang}{\parindent\z@}{\parindent\z@\leavevmode}%
- {\sphinx@ttlpatch@oktrue}{}%
- \ifsphinx@ttlpatch@ok
- \patchcmd{\ttlh@hang}{\noindent}{}{}{\sphinx@ttlpatch@okfalse}%
- \fi
- }{}%
- \ifsphinx@ttlpatch@ok
- \typeout{^^J Package Sphinx Info: ^^J
- **** titlesec 2.10.1 successfully patched for bugfix ****^^J}%
- \else
- \AtEndDocument{\PackageWarningNoLine{sphinx}{^^J%
-******** titlesec 2.10.1 has a bug, (section numbers disappear) ......|^^J%
-******** and Sphinx could not patch it, perhaps because your local ...|^^J%
-******** copy is already fixed without a changed release date. .......|^^J%
-******** If not, you must update titlesec! ...........................|}}%
- \fi
- }%
- }{}
\RequirePackage{tabulary}
-% tabulary has a bug with its re-definition of \multicolumn in its first pass
-% which is not \long. But now Sphinx does not use LaTeX's \multicolumn but its
-% own macro. Hence we don't even need to patch tabulary. See sphinxmulticell.sty
-% X or S (Sphinx) may have meanings if some table package is loaded hence
-% \X was chosen to avoid possibility of conflict
-\newcolumntype{\X}[2]{p{\dimexpr
- (\linewidth-\arrayrulewidth)*#1/#2-\tw@\tabcolsep-\arrayrulewidth\relax}}
-\newcolumntype{\Y}[1]{p{\dimexpr
- #1\dimexpr\linewidth-\arrayrulewidth\relax-\tw@\tabcolsep-\arrayrulewidth\relax}}
-% using here T (for Tabulary) feels less of a problem than the X could be
-\newcolumntype{T}{J}%
-% For tables allowing pagebreaks
-\RequirePackage{longtable}
-% User interface to set-up whitespace before and after tables:
-\newcommand*\sphinxtablepre {0pt}%
-\newcommand*\sphinxtablepost{\medskipamount}%
-\newcommand*\sphinxbelowcaptionspace{.5\sphinxbaselineskip}%
-% as one can not use \baselineskip from inside longtable (it is zero there)
-% we need \sphinxbaselineskip, which defaults to \baselineskip
-\def\sphinxbaselineskip{\baselineskip}%
-% These commands are inserted by the table templates
-\def\sphinxatlongtablestart
- {\par
- \vskip\parskip
- \vskip\dimexpr\sphinxtablepre\relax % adjust vertical position
- \vbox{}% get correct baseline from above
- \LTpre\z@skip\LTpost\z@skip % set to zero longtable's own skips
- \edef\sphinxbaselineskip{\dimexpr\the\dimexpr\baselineskip\relax\relax}%
- }%
-\def\sphinxatlongtableend{\prevdepth\z@\vskip\sphinxtablepost\relax}%
-\def\sphinxlongtablecapskipadjust
- {\dimexpr-\dp\strutbox-\sphinxbaselineskip+\sphinxbelowcaptionspace\relax}%
-% Now for tables not using longtable
-\def\sphinxattablestart
- {\par
- \vskip\dimexpr\sphinxtablepre\relax
- }%
-\let\sphinxattableend\sphinxatlongtableend
-% longtable's wraps captions to a maximal width of \LTcapwidth
-% so we do the same for all tables
-\newcommand*\sphinxcapstartof[1]{%
- \vskip\parskip
- \vbox{}% force baselineskip for good positioning by capstart of hyperanchor
- \def\@captype{#1}%
- \capstart
-% move back vertically to compensate space inserted by next paragraph
- \vskip-\baselineskip\vskip-\parskip
-}%
-% use \LTcapwidth (default is 4in) to wrap caption (if line width is bigger)
-\newcommand\sphinxcaption[2][\LTcapwidth]{%
- \noindent\hb@xt@\linewidth{\hss
- \vtop{\@tempdima\dimexpr#1\relax
-% don't exceed linewidth for the caption width
- \ifdim\@tempdima>\linewidth\hsize\linewidth\else\hsize\@tempdima\fi
-% longtable ignores \abovecaptionskip/\belowcaptionskip, so add hooks here
-% to uniformize control of caption distance to tables
- \abovecaptionskip\sphinxabovecaptionskip
- \belowcaptionskip\sphinxbelowcaptionskip
- \caption[{#2}]%
- {\strut\ignorespaces#2\ifhmode\unskip\@finalstrut\strutbox\fi}%
- }\hss}%
- \par\prevdepth\dp\strutbox
-}%
-\def\spx@abovecaptionskip{\abovecaptionskip}
-\newcommand*\sphinxabovecaptionskip{\z@skip}
-\newcommand*\sphinxbelowcaptionskip{\z@skip}
-
-\newcommand\sphinxaftercaption
-{% this default definition serves with a caption *above* a table, to make sure
- % its last baseline is \sphinxbelowcaptionspace above table top
- \nobreak
- \vskip\dimexpr\sphinxbelowcaptionspace\relax
- \vskip-\baselineskip\vskip-\parskip
-}%
-% varwidth is crucial for our handling of general contents in merged cells
-\RequirePackage{varwidth}
-% but addition of a compatibility patch with hyperref is needed
-% (tested with varwidth v 0.92 Mar 2009)
-\AtBeginDocument {%
- \let\@@vwid@Hy@raisedlink\Hy@raisedlink
- \long\def\@vwid@Hy@raisedlink#1{\@vwid@wrap{\@@vwid@Hy@raisedlink{#1}}}%
- \edef\@vwid@setup{%
- \let\noexpand\Hy@raisedlink\noexpand\@vwid@Hy@raisedlink % HYPERREF !
- \unexpanded\expandafter{\@vwid@setup}}%
-}%
-% Homemade package to handle merged cells
-\RequirePackage{sphinxmulticell}
\RequirePackage{makeidx}
% For framing code-blocks and warning type notices, and shadowing topics
\RequirePackage{framed}
+\newif\ifspx@inframed % flag set if we are in a framed environment
+% ifthen not used anymore and will be removed at Sphinx-1.5
+\RequirePackage{ifthen}
% The xcolor package draws better fcolorboxes around verbatim code
\IfFileExists{xcolor.sty}{
\RequirePackage{xcolor}
}
% For highlighted code.
\RequirePackage{fancyvrb}
-\fvset{fontsize=\small}
-\define@key{FV}{hllines}{\def\sphinx@verbatim@checkifhl##1{\in@{, ##1,}{#1}}}
-% For hyperlinked footnotes in tables; also for gathering footnotes from
-% topic and warning blocks. Also to allow code-blocks in footnotes.
-\RequirePackage{footnotehyper-sphinx}
-% For the H specifier. Do not \restylefloat{figure}, it breaks Sphinx code
-% for allowing figures in tables.
-\RequirePackage{float}
-% For floating figures in the text. Better to load after float.
+% For table captions.
+\RequirePackage{threeparttable}
+% Handle footnotes in tables.
+\RequirePackage{footnote}
+\makesavenoteenv{tabulary}
+% For floating figures in the text.
\RequirePackage{wrapfig}
% Separate paragraphs by space by default.
\RequirePackage{parskip}
\RequirePackage{alltt}
% Display "real" single quotes in literal blocks.
\RequirePackage{upquote}
-% control caption around literal-block
-\RequirePackage{capt-of}
-\RequirePackage{needspace}
-\RequirePackage{remreset}% provides \@removefromreset
-% to make pdf with correct encoded bookmarks in Japanese
-% this should precede the hyperref package
-\ifx\kanjiskip\@undefined
-% for non-Japanese: make sure bookmarks are ok also with lualatex
- \PassOptionsToPackage{pdfencoding=unicode}{hyperref}
-\else
- \RequirePackage{atbegshi}
- \ifx\ucs\@undefined
- \ifnum 42146=\euc"A4A2
- \AtBeginShipoutFirst{\special{pdf:tounicode EUC-UCS2}}
- \else
- \AtBeginShipoutFirst{\special{pdf:tounicode 90ms-RKSJ-UCS2}}
- \fi
- \else
- \AtBeginShipoutFirst{\special{pdf:tounicode UTF8-UCS2}}
- \fi
-\fi
+% For the H specifier. Do not \restylefloat{figure}, it breaks Sphinx code
+% for allowing figures in tables.
+\RequirePackage{float}
-\ifx\@jsc@uplatextrue\@undefined\else
- \PassOptionsToPackage{setpagesize=false}{hyperref}
+% Redefine these colors to your liking in the preamble.
+\definecolor{TitleColor}{rgb}{0.126,0.263,0.361}
+\definecolor{InnerLinkColor}{rgb}{0.208,0.374,0.486}
+\definecolor{OuterLinkColor}{rgb}{0.216,0.439,0.388}
+% Redefine these colors to something if you want to have colored
+% background and border for code examples.
+\definecolor{VerbatimColor}{rgb}{1,1,1}
+\definecolor{VerbatimBorderColor}{rgb}{0,0,0}
+
+% Uncomment these two lines to ignore the paper size and make the page
+% size more like a typical published manual.
+%\renewcommand{\paperheight}{9in}
+%\renewcommand{\paperwidth}{8.5in} % typical squarish manual
+%\renewcommand{\paperwidth}{7in} % O'Reilly ``Programmming Python''
+
+% use pdfoutput for pTeX and dvipdfmx
+% when pTeX (\kanjiskip is defined), set pdfoutput to evade \include{pdfcolor}
+\ifx\kanjiskip\undefined\else
+ \newcount\pdfoutput\pdfoutput=0
\fi
-% These options can be overriden inside 'hyperref' key
-% or by later use of \hypersetup.
-\PassOptionsToPackage{colorlinks,breaklinks,%
- linkcolor=InnerLinkColor,filecolor=OuterLinkColor,%
- menucolor=OuterLinkColor,urlcolor=OuterLinkColor,%
- citecolor=InnerLinkColor}{hyperref}
-
-% stylesheet for highlighting with pygments
-\RequirePackage{sphinxhighlight}
-% fix baseline increase from Pygments latex formatter in case of error tokens
-% and keep \fboxsep's scope local via added braces
-\def\PYG@tok@err{%
- \def\PYG@bc##1{{\setlength{\fboxsep}{-\fboxrule}%
- \fcolorbox[rgb]{1.00,0.00,0.00}{1,1,1}{\strut ##1}}}%
-}
-\def\PYG@tok@cs{%
- \def\PYG@tc##1{\textcolor[rgb]{0.25,0.50,0.56}{##1}}%
- \def\PYG@bc##1{{\setlength{\fboxsep}{0pt}%
- \colorbox[rgb]{1.00,0.94,0.94}{\strut ##1}}}%
-}%
+\RequirePackage{graphicx}
+% for PDF output, use colors and maximal compression
+\newif\ifsphinxpdfoutput % used in \maketitle
+\ifx\pdfoutput\undefined\else
+ \ifnum\pdfoutput=\z@
+ \let\py@NormalColor\relax
+ \let\py@TitleColor\relax
+ \else
+ \sphinxpdfoutputtrue
+ \input{pdfcolor}
+ \def\py@NormalColor{\color[rgb]{0.0,0.0,0.0}}
+ \def\py@TitleColor{\color{TitleColor}}
+ \pdfcompresslevel=9
+ \fi
+\fi
-%% OPTIONS
-%
-% Handle options via "kvoptions" (later loaded by hyperref anyhow)
-\RequirePackage{kvoptions}
-\SetupKeyvalOptions{prefix=spx@opt@} % use \spx@opt@ prefix
-
-% Sphinx legacy text layout: 1in margins on all four sides
-\ifx\@jsc@uplatextrue\@undefined
-\DeclareStringOption[1in]{hmargin}
-\DeclareStringOption[1in]{vmargin}
-\DeclareStringOption[.5in]{marginpar}
-\else
-% Japanese standard document classes handle \mag in a special way
-\DeclareStringOption[\inv@mag in]{hmargin}
-\DeclareStringOption[\inv@mag in]{vmargin}
-\DeclareStringOption[.5\dimexpr\inv@mag in\relax]{marginpar}
+% XeLaTeX can do colors, too
+\ifx\XeTeXrevision\undefined\else
+ \def\py@NormalColor{\color[rgb]{0.0,0.0,0.0}}
+ \def\py@TitleColor{\color{TitleColor}}
\fi
-\DeclareStringOption[0]{maxlistdepth}% \newcommand*\spx@opt@maxlistdepth{0}
-\DeclareStringOption[-1]{numfigreset}
-\DeclareBoolOption[false]{nonumfigreset}
-\DeclareBoolOption[false]{mathnumfig}
-% \DeclareBoolOption[false]{usespart}% not used
-% dimensions, we declare the \dimen registers here.
-\newdimen\sphinxverbatimsep
-\newdimen\sphinxverbatimborder
-\newdimen\sphinxshadowsep
-\newdimen\sphinxshadowsize
-\newdimen\sphinxshadowrule
-% \DeclareStringOption is not convenient for the handling of these dimensions
-% because we want to assign the values to the corresponding registers. Even if
-% we added the code to the key handler it would be too late for the initial
-% set-up and we would need to do initial assignments explicitely. We end up
-% using \define@key directly.
-% verbatim
-\sphinxverbatimsep=\fboxsep
- \define@key{sphinx}{verbatimsep}{\sphinxverbatimsep\dimexpr #1\relax}
-\sphinxverbatimborder=\fboxrule
- \define@key{sphinx}{verbatimborder}{\sphinxverbatimborder\dimexpr #1\relax}
-% topic boxes
-\sphinxshadowsep =5pt
- \define@key{sphinx}{shadowsep}{\sphinxshadowsep\dimexpr #1\relax}
-\sphinxshadowsize=4pt
- \define@key{sphinx}{shadowsize}{\sphinxshadowsize\dimexpr #1\relax}
-\sphinxshadowrule=\fboxrule
- \define@key{sphinx}{shadowrule}{\sphinxshadowrule\dimexpr #1\relax}
-% verbatim
-\DeclareBoolOption[true]{verbatimwithframe}
-\DeclareBoolOption[true]{verbatimwrapslines}
-\DeclareBoolOption[true]{verbatimhintsturnover}
-\DeclareBoolOption[true]{inlineliteralwraps}
-\DeclareStringOption[t]{literalblockcappos}
-\DeclareStringOption[r]{verbatimcontinuedalign}
-\DeclareStringOption[r]{verbatimcontinuesalign}
-% parsed literal
-\DeclareBoolOption[true]{parsedliteralwraps}
-% \textvisiblespace for compatibility with fontspec+XeTeX/LuaTeX
-\DeclareStringOption[\textcolor{red}{\textvisiblespace}]{verbatimvisiblespace}
-\DeclareStringOption % must use braces to hide the brackets
- [{\makebox[2\fontcharwd\font`\x][r]{\textcolor{red}{\tiny$\m@th\hookrightarrow$}}}]%
- {verbatimcontinued}
-% notices/admonitions
-% the dimensions for notices/admonitions are kept as macros and assigned to
-% \spx@notice@border at time of use, hence \DeclareStringOption is ok for this
-\newdimen\spx@notice@border
-\DeclareStringOption[0.5pt]{noteborder}
-\DeclareStringOption[0.5pt]{hintborder}
-\DeclareStringOption[0.5pt]{importantborder}
-\DeclareStringOption[0.5pt]{tipborder}
-\DeclareStringOption[1pt]{warningborder}
-\DeclareStringOption[1pt]{cautionborder}
-\DeclareStringOption[1pt]{attentionborder}
-\DeclareStringOption[1pt]{dangerborder}
-\DeclareStringOption[1pt]{errorborder}
-% footnotes
-\DeclareStringOption[\mbox{ }]{AtStartFootnote}
-% we need a public macro name for direct use in latex file
-\newcommand*{\sphinxAtStartFootnote}{\spx@opt@AtStartFootnote}
-% no such need for this one, as it is used inside other macros
-\DeclareStringOption[\leavevmode\unskip]{BeforeFootnote}
-% some font styling.
-\DeclareStringOption[\sffamily\bfseries]{HeaderFamily}
-% colours
-% same problems as for dimensions: we want the key handler to use \definecolor.
-% first, some colours with no prefix, for backwards compatibility
-\newcommand*{\sphinxDeclareColorOption}[2]{%
- \definecolor{#1}#2%
- \define@key{sphinx}{#1}{\definecolor{#1}##1}%
-}%
-\sphinxDeclareColorOption{TitleColor}{{rgb}{0.126,0.263,0.361}}
-\sphinxDeclareColorOption{InnerLinkColor}{{rgb}{0.208,0.374,0.486}}
-\sphinxDeclareColorOption{OuterLinkColor}{{rgb}{0.216,0.439,0.388}}
-\sphinxDeclareColorOption{VerbatimColor}{{rgb}{1,1,1}}
-\sphinxDeclareColorOption{VerbatimBorderColor}{{rgb}{0,0,0}}
-% now the colours defined with "sphinx" prefix in their names
-\newcommand*{\sphinxDeclareSphinxColorOption}[2]{%
- % set the initial default
- \definecolor{sphinx#1}#2%
- % set the key handler. The "value" ##1 must be acceptable by \definecolor.
- \define@key{sphinx}{#1}{\definecolor{sphinx#1}##1}%
-}%
-% Default color chosen to be as in minted.sty LaTeX package!
-\sphinxDeclareSphinxColorOption{VerbatimHighlightColor}{{rgb}{0.878,1,1}}
-% admonition boxes, "light" style
-\sphinxDeclareSphinxColorOption{noteBorderColor}{{rgb}{0,0,0}}
-\sphinxDeclareSphinxColorOption{hintBorderColor}{{rgb}{0,0,0}}
-\sphinxDeclareSphinxColorOption{importantBorderColor}{{rgb}{0,0,0}}
-\sphinxDeclareSphinxColorOption{tipBorderColor}{{rgb}{0,0,0}}
-% admonition boxes, "heavy" style
-\sphinxDeclareSphinxColorOption{warningBorderColor}{{rgb}{0,0,0}}
-\sphinxDeclareSphinxColorOption{cautionBorderColor}{{rgb}{0,0,0}}
-\sphinxDeclareSphinxColorOption{attentionBorderColor}{{rgb}{0,0,0}}
-\sphinxDeclareSphinxColorOption{dangerBorderColor}{{rgb}{0,0,0}}
-\sphinxDeclareSphinxColorOption{errorBorderColor}{{rgb}{0,0,0}}
-\sphinxDeclareSphinxColorOption{warningBgColor}{{rgb}{1,1,1}}
-\sphinxDeclareSphinxColorOption{cautionBgColor}{{rgb}{1,1,1}}
-\sphinxDeclareSphinxColorOption{attentionBgColor}{{rgb}{1,1,1}}
-\sphinxDeclareSphinxColorOption{dangerBgColor}{{rgb}{1,1,1}}
-\sphinxDeclareSphinxColorOption{errorBgColor}{{rgb}{1,1,1}}
-
-\DeclareDefaultOption{\@unknownoptionerror}
-\ProcessKeyvalOptions*
-% don't allow use of maxlistdepth via \sphinxsetup.
-\DisableKeyvalOption{sphinx}{maxlistdepth}
-\DisableKeyvalOption{sphinx}{numfigreset}
-\DisableKeyvalOption{sphinx}{nonumfigreset}
-\DisableKeyvalOption{sphinx}{mathnumfig}
-% user interface: options can be changed midway in a document!
-\newcommand\sphinxsetup[1]{\setkeys{sphinx}{#1}}
-
-
-%% MAXLISTDEPTH
-%
-% remove LaTeX's cap on nesting depth if 'maxlistdepth' key used.
-% This is a hack, which works with the standard classes: it assumes \@toodeep
-% is always used in "true" branches: "\if ... \@toodeep \else .. \fi."
-
-% will force use the "false" branch (if there is one)
-\def\spx@toodeep@hack{\fi\iffalse}
-
-% do nothing if 'maxlistdepth' key not used or if package enumitem loaded.
-\ifnum\spx@opt@maxlistdepth=\z@\expandafter\@gobbletwo\fi
-\AtBeginDocument{%
-\@ifpackageloaded{enumitem}{\remove@to@nnil}{}%
- \let\spx@toodeepORI\@toodeep
- \def\@toodeep{%
- \ifnum\@listdepth<\spx@opt@maxlistdepth\relax
- \expandafter\spx@toodeep@hack
- \else
- \expandafter\spx@toodeepORI
- \fi}%
-% define all missing \@list... macros
- \count@\@ne
- \loop
- \ltx@ifundefined{@list\romannumeral\the\count@}
- {\iffalse}{\iftrue\advance\count@\@ne}%
- \repeat
- \loop
- \ifnum\count@>\spx@opt@maxlistdepth\relax\else
- \expandafter\let
- \csname @list\romannumeral\the\count@\expandafter\endcsname
- \csname @list\romannumeral\the\numexpr\count@-\@ne\endcsname
- % workaround 2.6--3.2d babel-french issue (fixed in 3.2e; no change needed)
- \ltx@ifundefined{leftmargin\romannumeral\the\count@}
- {\expandafter\let
- \csname leftmargin\romannumeral\the\count@\expandafter\endcsname
- \csname leftmargin\romannumeral\the\numexpr\count@-\@ne\endcsname}{}%
- \advance\count@\@ne
- \repeat
-% define all missing enum... counters and \labelenum... macros and \p@enum..
- \count@\@ne
- \loop
- \ltx@ifundefined{c@enum\romannumeral\the\count@}
- {\iffalse}{\iftrue\advance\count@\@ne}%
- \repeat
- \loop
- \ifnum\count@>\spx@opt@maxlistdepth\relax\else
- \newcounter{enum\romannumeral\the\count@}%
- \expandafter\def
- \csname labelenum\romannumeral\the\count@\expandafter\endcsname
- \expandafter
- {\csname theenum\romannumeral\the\numexpr\count@\endcsname.}%
- \expandafter\def
- \csname p@enum\romannumeral\the\count@\expandafter\endcsname
- \expandafter
- {\csname p@enum\romannumeral\the\numexpr\count@-\@ne\expandafter
- \endcsname\csname theenum\romannumeral\the\numexpr\count@-\@ne\endcsname.}%
- \advance\count@\@ne
- \repeat
-% define all missing labelitem... macros
- \count@\@ne
- \loop
- \ltx@ifundefined{labelitem\romannumeral\the\count@}
- {\iffalse}{\iftrue\advance\count@\@ne}%
- \repeat
- \loop
- \ifnum\count@>\spx@opt@maxlistdepth\relax\else
- \expandafter\let
- \csname labelitem\romannumeral\the\count@\expandafter\endcsname
- \csname labelitem\romannumeral\the\numexpr\count@-\@ne\endcsname
- \advance\count@\@ne
- \repeat
- \PackageInfo{sphinx}{maximal list depth extended to \spx@opt@maxlistdepth}%
-\@gobble\@nnil
-}
+% Increase printable page size (copied from fullpage.sty)
+\topmargin 0pt
+\advance \topmargin by -\headheight
+\advance \topmargin by -\headsep
+% attempt to work a little better for A4 users
+\textheight \paperheight
+\advance\textheight by -2in
-%% INDEX, BIBLIOGRAPHY, APPENDIX, TABLE OF CONTENTS
-%
-% fix the double index and bibliography on the table of contents
-% in jsclasses (Japanese standard document classes)
-\ifx\@jsc@uplatextrue\@undefined\else
- \renewenvironment{sphinxtheindex}
- {\cleardoublepage\phantomsection
- \begin{theindex}}
- {\end{theindex}}
-
- \renewenvironment{sphinxthebibliography}[1]
- {\cleardoublepage% \phantomsection % not needed here since TeXLive 2010's hyperref
- \begin{thebibliography}{1}}
- {\end{thebibliography}}
-\fi
+\oddsidemargin 0pt
+\evensidemargin 0pt
+%\evensidemargin -.25in % for ``manual size'' documents
+\marginparwidth 0.5in
-% disable \@chappos in Appendix in pTeX
-\ifx\kanjiskip\@undefined\else
- \let\py@OldAppendix=\appendix
- \renewcommand{\appendix}{
- \py@OldAppendix
- \gdef\@chappos{}
- }
-\fi
-
-% make commands known to non-Sphinx document classes
-\providecommand*{\sphinxtableofcontents}{\tableofcontents}
-\ltx@ifundefined{sphinxthebibliography}
- {\newenvironment
- {sphinxthebibliography}{\begin{thebibliography}}{\end{thebibliography}}%
- }
- {}% else clause of \ltx@ifundefined
-\ltx@ifundefined{sphinxtheindex}
- {\newenvironment{sphinxtheindex}{\begin{theindex}}{\end{theindex}}}%
- {}% else clause of \ltx@ifundefined
+\textwidth \paperwidth
+\advance\textwidth by -2in
-%% COLOR (general)
-%
-% FIXME: \normalcolor should probably be used in place of \py@NormalColor
-% elsewhere, and \py@NormalColor should never be defined. \normalcolor
-% switches to the colour from last \color call in preamble.
-\def\py@NormalColor{\color{black}}
-% FIXME: it is probably better to use \color{TitleColor}, as TitleColor
-% can be customized from 'sphinxsetup', and drop usage of \py@TitleColor
-\def\py@TitleColor{\color{TitleColor}}
-% FIXME: this line should be dropped, as "9" is default anyhow.
-\ifdefined\pdfcompresslevel\pdfcompresslevel = 9 \fi
-
-
-%% PAGE STYLING
-%
% Style parameters and macros used by most documents here
\raggedbottom
\sloppy
\pagestyle{empty} % start this way
+% Use this to set the font family for headers and other decor:
+\newcommand{\py@HeaderFamily}{\sffamily\bfseries}
+\newcommand{\sphinxSetHeaderFamily}[1]{\renewcommand{\py@HeaderFamily}{#1}}
+
% Redefine the 'normal' header/footer style when using "fancyhdr" package:
-% Note: this presupposes "twoside". If "oneside" class option, there will be warnings.
-\ltx@ifundefined{fancyhf}{}{
+\spx@ifundefined{fancyhf}{}{
% Use \pagestyle{normal} as the primary pagestyle for text.
\fancypagestyle{normal}{
\fancyhf{}
-% (for \py@HeaderFamily cf "TITLES")
\fancyfoot[LE,RO]{{\py@HeaderFamily\thepage}}
\fancyfoot[LO]{{\py@HeaderFamily\nouppercase{\rightmark}}}
\fancyfoot[RE]{{\py@HeaderFamily\nouppercase{\leftmark}}}
- \fancyhead[LE,RO]{{\py@HeaderFamily \@title\sphinxheadercomma\py@release}}
+ \fancyhead[LE,RO]{{\py@HeaderFamily \@title, \py@release}}
\renewcommand{\headrulewidth}{0.4pt}
\renewcommand{\footrulewidth}{0.4pt}
% define chaptermark with \@chappos when \@chappos is available for Japanese
- \ltx@ifundefined{@chappos}{}
+ \spx@ifundefined{@chappos}{}
{\def\chaptermark##1{\markboth{\@chapapp\space\thechapter\space\@chappos\space ##1}{}}}
}
% Update the plain style so we get the page number & footer line,
}
}
-% geometry
-\ifx\kanjiskip\@undefined
- \PassOptionsToPackage{%
- hmargin={\unexpanded{\spx@opt@hmargin}},%
- vmargin={\unexpanded{\spx@opt@vmargin}},%
- marginpar=\unexpanded{\spx@opt@marginpar}}
- {geometry}
-\else
- % set text width for Japanese documents to be integer multiple of 1zw
- % and text height to be integer multiple of \baselineskip
- % the execution is delayed to \sphinxsetup then geometry.sty
- \normalsize\normalfont
- \newcommand*\sphinxtextwidthja[1]{%
- \if@twocolumn\tw@\fi
- \dimexpr
- \numexpr\dimexpr\paperwidth-\tw@\dimexpr#1\relax\relax/
- \dimexpr\if@twocolumn\tw@\else\@ne\fi zw\relax
- zw\relax}%
- \newcommand*\sphinxmarginparwidthja[1]{%
- \dimexpr\numexpr\dimexpr#1\relax/\dimexpr1zw\relax zw\relax}%
- \newcommand*\sphinxtextlinesja[1]{%
- \numexpr\@ne+\dimexpr\paperheight-\topskip-\tw@\dimexpr#1\relax\relax/
- \baselineskip\relax}%
- \ifx\@jsc@uplatextrue\@undefined\else
- % the way we found in order for the papersize special written by
- % geometry in the dvi file to be correct in case of jsbook class
- \ifnum\mag=\@m\else % do nothing special if nomag class option or 10pt
- \PassOptionsToPackage{truedimen}{geometry}%
- \fi
- \fi
- \PassOptionsToPackage{%
- hmarginratio={1:1},%
- textwidth=\unexpanded{\sphinxtextwidthja{\spx@opt@hmargin}},%
- vmarginratio={1:1},%
- lines=\unexpanded{\sphinxtextlinesja{\spx@opt@vmargin}},%
- marginpar=\unexpanded{\sphinxmarginparwidthja{\spx@opt@marginpar}},%
- footskip=2\baselineskip,%
- }{geometry}%
- \AtBeginDocument
- {% update a dimension used by the jsclasses
- \ifx\@jsc@uplatextrue\@undefined\else\fullwidth\textwidth\fi
- % for some reason, jreport normalizes all dimensions with \@settopoint
- \@ifclassloaded{jreport}
- {\@settopoint\textwidth\@settopoint\textheight\@settopoint\marginparwidth}
- {}% <-- "false" clause of \@ifclassloaded
- }%
-\fi
-
-% fix fncychap's bug which uses prematurely the \textwidth value
-\@ifpackagewith{fncychap}{Bjornstrup}
- {\AtBeginDocument{\mylen\textwidth\advance\mylen-2\myhi}}%
- {}% <-- "false" clause of \@ifpackagewith
-
-
-%% TITLES
-%
-% Since Sphinx 1.5, users should use HeaderFamily key to 'sphinxsetup' rather
-% than defining their own \py@HeaderFamily command (which is still possible).
-% Memo: \py@HeaderFamily is also used by \maketitle as defined in
-% sphinxmanual.cls/sphinxhowto.cls
-\newcommand{\py@HeaderFamily}{\spx@opt@HeaderFamily}
-
-% This sets up the fancy chapter headings that make the documents look
-% at least a little better than the usual LaTeX output.
-\@ifpackagewith{fncychap}{Bjarne}{
- \ChNameVar {\raggedleft\normalsize \py@HeaderFamily}
- \ChNumVar {\raggedleft\Large \py@HeaderFamily}
- \ChTitleVar{\raggedleft\Large \py@HeaderFamily}
- % This creates (numbered) chapter heads without the leading \vspace*{}:
- \def\@makechapterhead#1{%
- {\parindent \z@ \raggedright \normalfont
- \ifnum \c@secnumdepth >\m@ne
- \if@mainmatter
- \DOCH
- \fi
- \fi
- \interlinepenalty\@M
- \if@mainmatter
- \DOTI{#1}%
- \else%
- \DOTIS{#1}%
- \fi
- }}
-}{}% <-- "false" clause of \@ifpackagewith
-
-% Augment the sectioning commands used to get our own font family in place,
-% and reset some internal data items (\titleformat from titlesec package)
-\titleformat{\section}{\Large\py@HeaderFamily}%
- {\py@TitleColor\thesection}{0.5em}{\py@TitleColor}{\py@NormalColor}
-\titleformat{\subsection}{\large\py@HeaderFamily}%
- {\py@TitleColor\thesubsection}{0.5em}{\py@TitleColor}{\py@NormalColor}
-\titleformat{\subsubsection}{\py@HeaderFamily}%
- {\py@TitleColor\thesubsubsection}{0.5em}{\py@TitleColor}{\py@NormalColor}
-% By default paragraphs (and subsubsections) will not be numbered because
-% sphinxmanual.cls and sphinxhowto.cls set secnumdepth to 2
-\titleformat{\paragraph}{\py@HeaderFamily}%
- {\py@TitleColor\theparagraph}{0.5em}{\py@TitleColor}{\py@NormalColor}
-\titleformat{\subparagraph}{\py@HeaderFamily}%
- {\py@TitleColor\thesubparagraph}{0.5em}{\py@TitleColor}{\py@NormalColor}
-
-
-%% GRAPHICS
-%
-% \sphinxincludegraphics defined to resize images larger than the line width,
-% except if height or width option present.
-%
-% If scale is present, rescale before fitting to line width. (since 1.5)
-\newbox\spx@image@box
-\newcommand*{\sphinxincludegraphics}[2][]{%
- \in@{height}{#1}\ifin@\else\in@{width}{#1}\fi
- \ifin@ % height or width present
- \includegraphics[#1]{#2}%
- \else % no height nor width (but #1 may be "scale=...")
- \setbox\spx@image@box\hbox{\includegraphics[#1,draft]{#2}}%
- \ifdim \wd\spx@image@box>\linewidth
- \setbox\spx@image@box\box\voidb@x % clear memory
- \includegraphics[#1,width=\linewidth]{#2}%
- \else
- \includegraphics[#1]{#2}%
- \fi
- \fi
-}
-
-
-%% FIGURE IN TABLE
-%
-\newenvironment{sphinxfigure-in-table}[1][\linewidth]{%
- \def\@captype{figure}%
- \sphinxsetvskipsforfigintablecaption
- \begin{minipage}{#1}%
-}{\end{minipage}}
-% store original \caption macro for use with figures in longtable and tabulary
-\AtBeginDocument{\let\spx@originalcaption\caption}
-\newcommand*\sphinxfigcaption
- {\ifx\equation$%$% this is trick to identify tabulary first pass
- \firstchoice@false\else\firstchoice@true\fi
- \spx@originalcaption }
-\newcommand*\sphinxsetvskipsforfigintablecaption
- {\abovecaptionskip\smallskipamount
- \belowcaptionskip\smallskipamount}
-
-
-%% FOOTNOTES
-%
-% Support large numbered footnotes in minipage
-% But now obsolete due to systematic use of \savenotes/\spewnotes
-% when minipages are in use in the various macro definitions next.
+% Some custom font markup commands.
+% *** the macros without \sphinx prefix are still defined at bottom of file ***
+\newcommand{\sphinxstrong}[1]{{\textbf{#1}}}
+% let \sphinxcode and \sphinxbfcode use straight quotes. \@noligs patched by upquote,
+% but needs protection in "moving arguments" such as for captions.
+% Use \scantokens to handle e.g. \item[{\sphinxcode{'fontenc'}}]
+\DeclareRobustCommand{\sphinxcode}[1]{{\@noligs\scantokens{\texttt{#1}\relax}}}
+\newcommand{\sphinxbfcode}[1]{\sphinxcode{\bfseries#1}}
+\newcommand{\sphinxemail}[1]{\textsf{#1}}
+\newcommand{\sphinxtablecontinued}[1]{\textsf{#1}}
+\newcommand{\sphinxtitleref}[1]{\emph{#1}}
+\newcommand{\sphinxmenuselection}[1]{\emph{#1}}
+\newcommand{\sphinxaccelerator}[1]{\underline{#1}}
+\newcommand{\sphinxcrossref}[1]{\emph{#1}}
+\newcommand{\sphinxtermref}[1]{\emph{#1}}
+
+% miscellaneous related to footnotes
+\newcommand*{\sphinxAtStartFootnote}{\mbox{ }}
+% Support large numbered footnotes in minipage (cf. admonitions)
\def\thempfootnote{\arabic{mpfootnote}}
+% Redefine the Verbatim environment to allow border and background colors
+% and to handle the top caption in a non separable by pagebreak way.
+% The original environment is still used for verbatims within tables.
+\let\OriginalVerbatim=\Verbatim
+\let\endOriginalVerbatim=\endVerbatim
-%% NUMBERING OF FIGURES, TABLES, AND LITERAL BLOCKS
-\ltx@ifundefined{c@chapter}
- {\newcounter{literalblock}}%
- {\newcounter{literalblock}[chapter]%
- \def\theliteralblock{\ifnum\c@chapter>\z@\arabic{chapter}.\fi
- \arabic{literalblock}}%
- }%
-\ifspx@opt@nonumfigreset
- \ltx@ifundefined{c@chapter}{}{%
- \@removefromreset{figure}{chapter}%
- \@removefromreset{table}{chapter}%
- \@removefromreset{literalblock}{chapter}%
- \ifspx@opt@mathnumfig
- \@removefromreset{equation}{chapter}%
- \fi
- }%
- \def\thefigure{\arabic{figure}}%
- \def\thetable {\arabic{table}}%
- \def\theliteralblock{\arabic{literalblock}}%
- \ifspx@opt@mathnumfig
- \def\theequation{\arabic{equation}}%
- \fi
-\else
-\let\spx@preAthefigure\@empty
-\let\spx@preBthefigure\@empty
-% \ifspx@opt@usespart % <-- LaTeX writer could pass such a 'usespart' boolean
-% % as sphinx.sty package option
-% If document uses \part, (triggered in Sphinx by latex_toplevel_sectioning)
-% LaTeX core per default does not reset chapter or section
-% counters at each part.
-% But if we modify this, we need to redefine \thechapter, \thesection to
-% include the part number and this will cause problems in table of contents
-% because of too wide numbering. Simplest is to do nothing.
-% \fi
-\ifnum\spx@opt@numfigreset>0
- \ltx@ifundefined{c@chapter}
- {}
- {\g@addto@macro\spx@preAthefigure{\ifnum\c@chapter>\z@\arabic{chapter}.}%
- \g@addto@macro\spx@preBthefigure{\fi}}%
-\fi
-\ifnum\spx@opt@numfigreset>1
- \@addtoreset{figure}{section}%
- \@addtoreset{table}{section}%
- \@addtoreset{literalblock}{section}%
- \ifspx@opt@mathnumfig
- \@addtoreset{equation}{section}%
- \fi
- \g@addto@macro\spx@preAthefigure{\ifnum\c@section>\z@\arabic{section}.}%
- \g@addto@macro\spx@preBthefigure{\fi}%
-\fi
-\ifnum\spx@opt@numfigreset>2
- \@addtoreset{figure}{subsection}%
- \@addtoreset{table}{subsection}%
- \@addtoreset{literalblock}{subsection}%
- \ifspx@opt@mathnumfig
- \@addtoreset{equation}{subsection}%
- \fi
- \g@addto@macro\spx@preAthefigure{\ifnum\c@subsection>\z@\arabic{subsection}.}%
- \g@addto@macro\spx@preBthefigure{\fi}%
-\fi
-\ifnum\spx@opt@numfigreset>3
- \@addtoreset{figure}{subsubsection}%
- \@addtoreset{table}{subsubsection}%
- \@addtoreset{literalblock}{subsubsection}%
- \ifspx@opt@mathnumfig
- \@addtoreset{equation}{subsubsection}%
- \fi
- \g@addto@macro\spx@preAthefigure{\ifnum\c@subsubsection>\z@\arabic{subsubsection}.}%
- \g@addto@macro\spx@preBthefigure{\fi}%
-\fi
-\ifnum\spx@opt@numfigreset>4
- \@addtoreset{figure}{paragraph}%
- \@addtoreset{table}{paragraph}%
- \@addtoreset{literalblock}{paragraph}%
- \ifspx@opt@mathnumfig
- \@addtoreset{equation}{paragraph}%
- \fi
- \g@addto@macro\spx@preAthefigure{\ifnum\c@subparagraph>\z@\arabic{subparagraph}.}%
- \g@addto@macro\spx@preBthefigure{\fi}%
-\fi
-\ifnum\spx@opt@numfigreset>5
- \@addtoreset{figure}{subparagraph}%
- \@addtoreset{table}{subparagraph}%
- \@addtoreset{literalblock}{subparagraph}%
- \ifspx@opt@mathnumfig
- \@addtoreset{equation}{subparagraph}%
- \fi
- \g@addto@macro\spx@preAthefigure{\ifnum\c@subsubparagraph>\z@\arabic{subsubparagraph}.}%
- \g@addto@macro\spx@preBthefigure{\fi}%
-\fi
-\expandafter\g@addto@macro
-\expandafter\spx@preAthefigure\expandafter{\spx@preBthefigure}%
-\let\thefigure\spx@preAthefigure
-\let\thetable\spx@preAthefigure
-\let\theliteralblock\spx@preAthefigure
-\g@addto@macro\thefigure{\arabic{figure}}%
-\g@addto@macro\thetable{\arabic{table}}%
-\g@addto@macro\theliteralblock{\arabic{literalblock}}%
- \ifspx@opt@mathnumfig
- \let\theequation\spx@preAthefigure
- \g@addto@macro\theequation{\arabic{equation}}%
- \fi
-\fi
-
-
-%% LITERAL BLOCKS
-%
-% Based on use of "fancyvrb.sty"'s Verbatim.
-% - with framing allowing page breaks ("framed.sty")
-% - with breaking of long lines (exploits Pygments mark-up),
-% - with possibly of a top caption, non-separable by pagebreak.
-% - and usable inside tables or footnotes ("footnotehyper-sphinx").
-
-% For extensions which use \OriginalVerbatim and compatibility with Sphinx <
-% 1.5, we define and use these when (unmodified) Verbatim will be needed. But
-% Sphinx >= 1.5 does not modify the \Verbatim macro anymore.
-\let\OriginalVerbatim \Verbatim
-\let\endOriginalVerbatim\endVerbatim
-
-% for captions of literal blocks
-% at start of caption title
-\newcommand*{\fnum@literalblock}{\literalblockname\nobreakspace\theliteralblock}
-% this will be overwritten in document preamble by Babel translation
-\newcommand*{\literalblockname}{Listing }
-% file extension needed for \caption's good functioning, the file is created
-% only if a \listof{literalblock}{foo} command is encountered, which is
-% analogous to \listoffigures, but for the code listings (foo = chosen title.)
-\newcommand*{\ext@literalblock}{lol}
-
-\newif\ifspx@inframed % flag set if we are already in a framed environment
-% if forced use of minipage encapsulation is needed (e.g. table cells)
-\newif\ifsphinxverbatimwithminipage \sphinxverbatimwithminipagefalse
-
-% Framing macro for use with framed.sty's \FrameCommand
-% - it obeys current indentation,
-% - frame is \fboxsep separated from the contents,
-% - the contents use the full available text width,
-% - #1 = color of frame, #2 = color of background,
-% - #3 = above frame, #4 = below frame, #5 = within frame,
-% - #3 and #4 must be already typeset boxes; they must issue \normalcolor
-% or similar, else, they are under scope of color #1
-\long\def\spx@fcolorbox #1#2#3#4#5{%
+\newcommand\spx@colorbox [2]{%
+% #1 will be \fcolorbox or, for first part of frame: \spx@fcolorbox
+% let the framing obey the current indentation (adapted from framed.sty's code).
\hskip\@totalleftmargin
\hskip-\fboxsep\hskip-\fboxrule
- % use of \color@b@x here is compatible with both xcolor.sty and color.sty
- \color@b@x {\color{#1}\spx@CustomFBox{#3}{#4}}{\color{#2}}{#5}%
+ #1{VerbatimBorderColor}{VerbatimColor}{#2}%
\hskip-\fboxsep\hskip-\fboxrule
\hskip-\linewidth \hskip-\@totalleftmargin \hskip\columnwidth
-}%
-% #1 = for material above frame, such as a caption or a "continued" hint
-% #2 = for material below frame, such as a caption or "continues on next page"
-% #3 = actual contents, which will be typeset with a background color
-\long\def\spx@CustomFBox#1#2#3{%
+}
+% use of \color@b@x here is compatible with both xcolor.sty and color.sty
+\def\spx@fcolorbox #1#2%
+ {\color@b@x {\fboxsep\z@\color{#1}\spx@VerbatimFBox}{\color{#2}}}%
+
+% The title is specified from outside as macro \sphinxVerbatimTitle.
+% \sphinxVerbatimTitle is reset to empty after each use of Verbatim.
+\newcommand*\sphinxVerbatimTitle {}
+% Holder macro for labels of literal blocks. Set-up by LaTeX writer.
+\newcommand*\sphinxLiteralBlockLabel {}
+\newcommand*\sphinxSetupCaptionForVerbatim [2]
+{%
+ \needspace{\sphinxliteralblockneedspace}%
+% insert a \label via \sphinxLiteralBlockLabel
+% reset to normal the color for the literal block caption
+% the caption inserts \abovecaptionskip whitespace above itself (usually 10pt)
+% there is also \belowcaptionskip but it is usually zero, hence the \smallskip
+ \def\sphinxVerbatimTitle
+ {\py@NormalColor\captionof{#1}{\sphinxLiteralBlockLabel #2}\smallskip }%
+}
+
+% Inspired and adapted from framed.sty's \CustomFBox with extra handling
+% of a non separable by pagebreak caption, and controlled counter stepping.
+\newif\ifspx@myfirstframedpass
+\long\def\spx@VerbatimFBox#1{%
+ \leavevmode
\begingroup
- \setbox\@tempboxa\hbox{{#3}}% inner braces to avoid color leaks
- \vbox{#1% above frame
+ % framed.sty does some measuring but this macro adds possibly a caption
+ % use amsmath conditional to inhibit the caption counter stepping after
+ % first pass
+ \ifspx@myfirstframedpass\else\firstchoice@false\fi
+ \setbox\@tempboxa\hbox{\kern\fboxsep{#1}\kern\fboxsep}%
+ \hbox
+ {\lower\dimexpr\fboxrule+\fboxsep+\dp\@tempboxa
+ \hbox{%
+ \vbox{\ifx\sphinxVerbatimTitle\empty\else
+ % add the caption in a centered way above possibly indented frame
+ % hide its width from framed.sty's measuring step
+ % note that the caption brings \abovecaptionskip top vertical space
+ \moveright\dimexpr\fboxrule+.5\wd\@tempboxa
+ \hb@xt@\z@{\hss\begin{minipage}{\wd\@tempboxa}%
+ \sphinxVerbatimTitle
+ \end{minipage}\hss}\fi
% draw frame border _latest_ to avoid pdf viewer issue
\kern\fboxrule
\hbox{\kern\fboxrule
- \copy\@tempboxa
+ \vbox{\vskip\fboxsep\copy\@tempboxa\vskip\fboxsep}%
\kern-\wd\@tempboxa\kern-\fboxrule
\vrule\@width\fboxrule
\kern\wd\@tempboxa
\vrule\@width\fboxrule}%
- \kern-\dimexpr\ht\@tempboxa+\dp\@tempboxa+\fboxrule\relax
- \hrule\@height\fboxrule
- \kern\dimexpr\ht\@tempboxa+\dp\@tempboxa\relax
+ \kern-\dimexpr\fboxsep+\ht\@tempboxa+\dp\@tempboxa
+ +\fboxsep+\fboxrule\relax
\hrule\@height\fboxrule
- #2% below frame
- }%
+ \kern\dimexpr\fboxsep+\ht\@tempboxa+\dp\@tempboxa+\fboxsep\relax
+ \hrule\@height\fboxrule}%
+ }}%
\endgroup
-}%
-\def\spx@fcolorbox@put@c#1{% hide width from framed.sty measuring
- \moveright\dimexpr\fboxrule+.5\wd\@tempboxa\hb@xt@\z@{\hss#1\hss}%
-}%
-\def\spx@fcolorbox@put@r#1{% right align with contents, width hidden
- \moveright\dimexpr\fboxrule+\wd\@tempboxa-\fboxsep\hb@xt@\z@{\hss#1}%
-}%
-\def\spx@fcolorbox@put@l#1{% left align with contents, width hidden
- \moveright\dimexpr\fboxrule+\fboxsep\hb@xt@\z@{#1\hss}%
-}%
-%
-\def\sphinxVerbatim@Continued
- {\csname spx@fcolorbox@put@\spx@opt@verbatimcontinuedalign\endcsname
- {\normalcolor\sphinxstylecodecontinued\literalblockcontinuedname}}%
-\def\sphinxVerbatim@Continues
- {\csname spx@fcolorbox@put@\spx@opt@verbatimcontinuesalign\endcsname
- {\normalcolor\sphinxstylecodecontinues\literalblockcontinuesname}}%
-\def\sphinxVerbatim@Title
- {\spx@fcolorbox@put@c{\unhcopy\sphinxVerbatim@TitleBox}}%
-\let\sphinxVerbatim@Before\@empty
-\let\sphinxVerbatim@After\@empty
-% Defaults are redefined in document preamble according to language
-\newcommand*\literalblockcontinuedname{continued from previous page}%
-\newcommand*\literalblockcontinuesname{continues on next page}%
-%
-\def\spx@verbatimfcolorbox{\spx@fcolorbox{VerbatimBorderColor}{VerbatimColor}}%
-\def\sphinxVerbatim@FrameCommand
- {\spx@verbatimfcolorbox\sphinxVerbatim@Before\sphinxVerbatim@After}%
-\def\sphinxVerbatim@FirstFrameCommand
- {\spx@verbatimfcolorbox\sphinxVerbatim@Before\sphinxVerbatim@Continues}%
-\def\sphinxVerbatim@MidFrameCommand
- {\spx@verbatimfcolorbox\sphinxVerbatim@Continued\sphinxVerbatim@Continues}%
-\def\sphinxVerbatim@LastFrameCommand
- {\spx@verbatimfcolorbox\sphinxVerbatim@Continued\sphinxVerbatim@After}%
+ \global\spx@myfirstframedpassfalse
+}
% For linebreaks inside Verbatim environment from package fancyvrb.
\newbox\sphinxcontinuationbox
\newbox\sphinxvisiblespacebox
-\newcommand*\sphinxafterbreak {\copy\sphinxcontinuationbox}
+% These are user customizable e.g. from latex_elements's preamble key.
+% Use of \textvisiblespace for compatibility with XeTeX/LuaTeX/fontspec.
+\newcommand*\sphinxvisiblespace {\textcolor{red}{\textvisiblespace}}
+\newcommand*\sphinxcontinuationsymbol {\textcolor{red}{\llap{\tiny$\m@th\hookrightarrow$}}}
+\newcommand*\sphinxcontinuationindent {3ex }
+\newcommand*\sphinxafterbreak {\kern\sphinxcontinuationindent\copy\sphinxcontinuationbox}
% Take advantage of the already applied Pygments mark-up to insert
% potential linebreaks for TeX processing.
% {, <, #, %, $, ' and ": go to next line.
% _, }, ^, &, >, - and ~: stay at end of broken line.
% Use of \textquotesingle for straight quote.
-% FIXME: convert this to package options ?
-\newcommand*\sphinxbreaksbeforelist {%
- \do\PYGZob\{\do\PYGZlt\<\do\PYGZsh\#\do\PYGZpc\%% {, <, #, %,
- \do\PYGZdl\$\do\PYGZdq\"% $, "
- \def\PYGZsq
- {\discretionary{}{\sphinxafterbreak\textquotesingle}{\textquotesingle}}% '
-}
-\newcommand*\sphinxbreaksafterlist {%
- \do\PYGZus\_\do\PYGZcb\}\do\PYGZca\^\do\PYGZam\&% _, }, ^, &,
- \do\PYGZgt\>\do\PYGZhy\-\do\PYGZti\~% >, -, ~
-}
\newcommand*\sphinxbreaksatspecials {%
- \def\do##1##2%
- {\def##1{\discretionary{}{\sphinxafterbreak\char`##2}{\char`##2}}}%
- \sphinxbreaksbeforelist
- \def\do##1##2%
- {\def##1{\discretionary{\char`##2}{\sphinxafterbreak}{\char`##2}}}%
- \sphinxbreaksafterlist
+ \def\PYGZus{\discretionary{\char`\_}{\sphinxafterbreak}{\char`\_}}%
+ \def\PYGZob{\discretionary{}{\sphinxafterbreak\char`\{}{\char`\{}}%
+ \def\PYGZcb{\discretionary{\char`\}}{\sphinxafterbreak}{\char`\}}}%
+ \def\PYGZca{\discretionary{\char`\^}{\sphinxafterbreak}{\char`\^}}%
+ \def\PYGZam{\discretionary{\char`\&}{\sphinxafterbreak}{\char`\&}}%
+ \def\PYGZlt{\discretionary{}{\sphinxafterbreak\char`\<}{\char`\<}}%
+ \def\PYGZgt{\discretionary{\char`\>}{\sphinxafterbreak}{\char`\>}}%
+ \def\PYGZsh{\discretionary{}{\sphinxafterbreak\char`\#}{\char`\#}}%
+ \def\PYGZpc{\discretionary{}{\sphinxafterbreak\char`\%}{\char`\%}}%
+ \def\PYGZdl{\discretionary{}{\sphinxafterbreak\char`\$}{\char`\$}}%
+ \def\PYGZhy{\discretionary{\char`\-}{\sphinxafterbreak}{\char`\-}}%
+ \def\PYGZsq{\discretionary{}{\sphinxafterbreak\textquotesingle}{\textquotesingle}}%
+ \def\PYGZdq{\discretionary{}{\sphinxafterbreak\char`\"}{\char`\"}}%
+ \def\PYGZti{\discretionary{\char`\~}{\sphinxafterbreak}{\char`\~}}%
}
\def\sphinx@verbatim@nolig@list {\do \`}%
% Some characters . , ; ? ! / are not pygmentized.
-% This macro makes them "active" and they will insert potential linebreaks.
-% Not compatible with math mode (cf \sphinxunactivateextras).
-\newcommand*\sphinxbreaksbeforeactivelist {}% none
-\newcommand*\sphinxbreaksafteractivelist {\do\.\do\,\do\;\do\?\do\!\do\/}
-\newcommand*\sphinxbreaksviaactive {%
- \def\do##1{\lccode`\~`##1%
- \lowercase{\def~}{\discretionary{}{\sphinxafterbreak\char`##1}{\char`##1}}%
- \catcode`##1\active}%
- \sphinxbreaksbeforeactivelist
- \def\do##1{\lccode`\~`##1%
- \lowercase{\def~}{\discretionary{\char`##1}{\sphinxafterbreak}{\char`##1}}%
- \catcode`##1\active}%
- \sphinxbreaksafteractivelist
+% This macro makes them "active" and they will insert potential linebreaks
+\newcommand*\sphinxbreaksatpunct {%
+ \lccode`\~`\.\lowercase{\def~}{\discretionary{\char`\.}{\sphinxafterbreak}{\char`\.}}%
+ \lccode`\~`\,\lowercase{\def~}{\discretionary{\char`\,}{\sphinxafterbreak}{\char`\,}}%
+ \lccode`\~`\;\lowercase{\def~}{\discretionary{\char`\;}{\sphinxafterbreak}{\char`\;}}%
+ \lccode`\~`\:\lowercase{\def~}{\discretionary{\char`\:}{\sphinxafterbreak}{\char`\:}}%
+ \lccode`\~`\?\lowercase{\def~}{\discretionary{\char`\?}{\sphinxafterbreak}{\char`\?}}%
+ \lccode`\~`\!\lowercase{\def~}{\discretionary{\char`\!}{\sphinxafterbreak}{\char`\!}}%
+ \lccode`\~`\/\lowercase{\def~}{\discretionary{\char`\/}{\sphinxafterbreak}{\char`\/}}%
+ \catcode`\.\active
+ \catcode`\,\active
+ \catcode`\;\active
+ \catcode`\:\active
+ \catcode`\?\active
+ \catcode`\!\active
+ \catcode`\/\active
\lccode`\~`\~
}
-% If the linebreak is at a space, the latter will be displayed as visible
-% space at end of first line, and a continuation symbol starts next line.
-\def\spx@verbatim@space {%
- \nobreak\hskip\z@skip
- \discretionary{\copy\sphinxvisiblespacebox}{\sphinxafterbreak}
- {\kern\fontdimen2\font}%
-}%
-
-% if the available space on page is less than \literalblockneedspace, insert pagebreak
-\newcommand{\sphinxliteralblockneedspace}{5\baselineskip}
-\newcommand{\sphinxliteralblockwithoutcaptionneedspace}{1.5\baselineskip}
-% The title (caption) is specified from outside as macro \sphinxVerbatimTitle.
-% \sphinxVerbatimTitle is reset to empty after each use of Verbatim.
-\newcommand*\sphinxVerbatimTitle {}
-% This box to typeset the caption before framed.sty multiple passes for framing.
-\newbox\sphinxVerbatim@TitleBox
-% This is a workaround to a "feature" of French lists, when literal block
-% follows immediately; usable generally (does only \par then), a priori...
-\newcommand*\sphinxvspacefixafterfrenchlists{%
- \ifvmode\ifdim\lastskip<\z@ \vskip\parskip\fi\else\par\fi
-}
-% Holder macro for labels of literal blocks. Set-up by LaTeX writer.
-\newcommand*\sphinxLiteralBlockLabel {}
-\newcommand*\sphinxSetupCaptionForVerbatim [1]
-{%
- \sphinxvspacefixafterfrenchlists
- \needspace{\sphinxliteralblockneedspace}%
-% insert a \label via \sphinxLiteralBlockLabel
-% reset to normal the color for the literal block caption
- \def\sphinxVerbatimTitle
- {\py@NormalColor\sphinxcaption{\sphinxLiteralBlockLabel #1}}%
-}
-\newcommand*\sphinxSetupCodeBlockInFootnote {%
- \fvset{fontsize=\footnotesize}\let\caption\sphinxfigcaption
- \sphinxverbatimwithminipagetrue % reduces vertical spaces
- % we counteract (this is in a group) the \@normalsize from \caption
- \let\normalsize\footnotesize\let\@parboxrestore\relax
- \def\spx@abovecaptionskip{\sphinxverbatimsmallskipamount}%
-}
-% needed to create wrapper environments of fancyvrb's Verbatim
-\newcommand*{\sphinxVerbatimEnvironment}{\gdef\FV@EnvironName{sphinxVerbatim}}
-\newcommand*{\sphinxverbatimsmallskipamount}{\smallskipamount}
-% serves to implement line highlighting and line wrapping
-\newcommand\sphinxFancyVerbFormatLine[1]{%
- \expandafter\sphinx@verbatim@checkifhl\expandafter{\the\FV@CodeLineNo}%
- \ifin@
- \sphinxVerbatimHighlightLine{#1}%
- \else
- \sphinxVerbatimFormatLine{#1}%
- \fi
-}%
-\newcommand\sphinxVerbatimHighlightLine[1]{%
- \edef\sphinxrestorefboxsep{\fboxsep\the\fboxsep\relax}%
- \fboxsep0pt\relax % cf LaTeX bug graphics/4524
- \colorbox{sphinxVerbatimHighlightColor}%
- {\sphinxrestorefboxsep\sphinxVerbatimFormatLine{#1}}%
- % no need to restore \fboxsep here, as this ends up in a \hbox from fancyvrb
-}%
-% \sphinxVerbatimFormatLine will be set locally to one of those two:
-\newcommand\sphinxVerbatimFormatLineWrap[1]{%
- \hsize\linewidth
- \vtop{\raggedright\hyphenpenalty\z@\exhyphenpenalty\z@
- \doublehyphendemerits\z@\finalhyphendemerits\z@
- \strut #1\strut}%
-}%
-\newcommand\sphinxVerbatimFormatLineNoWrap[1]{\hb@xt@\linewidth{\strut #1\hss}}%
-\g@addto@macro\FV@SetupFont{%
- \sbox\sphinxcontinuationbox {\spx@opt@verbatimcontinued}%
- \sbox\sphinxvisiblespacebox {\spx@opt@verbatimvisiblespace}%
-}%
-\newenvironment{sphinxVerbatim}{%
+\renewcommand{\Verbatim}[1][1]{%
+ % quit horizontal mode if we are still in a paragraph
+ \par
+ % list starts new par, but we don't want it to be set apart vertically
+ \parskip\z@skip
% first, let's check if there is a caption
\ifx\sphinxVerbatimTitle\empty
- \sphinxvspacefixafterfrenchlists
- \parskip\z@skip
- \vskip\sphinxverbatimsmallskipamount
+ \addvspace\z@% counteract possible previous negative skip (French lists!)
+ \smallskip
% there was no caption. Check if nevertheless a label was set.
\ifx\sphinxLiteralBlockLabel\empty\else
% we require some space to be sure hyperlink target from \phantomsection
\needspace{\sphinxliteralblockwithoutcaptionneedspace}%
\phantomsection\sphinxLiteralBlockLabel
\fi
- \else
- \parskip\z@skip
- \if t\spx@opt@literalblockcappos
- \vskip\spx@abovecaptionskip
- \def\sphinxVerbatim@Before
- {\sphinxVerbatim@Title\nointerlineskip
- \kern\dimexpr-\dp\strutbox+\sphinxbelowcaptionspace\relax}%
- \else
- \vskip\sphinxverbatimsmallskipamount
- \def\sphinxVerbatim@After
- {\nointerlineskip\kern\dp\strutbox\sphinxVerbatim@Title}%
- \fi
- \def\@captype{literalblock}%
- \capstart
- % \sphinxVerbatimTitle must reset color
- \setbox\sphinxVerbatim@TitleBox
- \hbox{\begin{minipage}{\linewidth}%
- \sphinxVerbatimTitle
- \end{minipage}}%
\fi
- \global\let\sphinxLiteralBlockLabel\empty
- \global\let\sphinxVerbatimTitle\empty
- \fboxsep\sphinxverbatimsep \fboxrule\sphinxverbatimborder
- \ifspx@opt@verbatimwithframe\else\fboxrule\z@\fi
- \let\FrameCommand \sphinxVerbatim@FrameCommand
- \let\FirstFrameCommand\sphinxVerbatim@FirstFrameCommand
- \let\MidFrameCommand \sphinxVerbatim@MidFrameCommand
- \let\LastFrameCommand \sphinxVerbatim@LastFrameCommand
- \ifspx@opt@verbatimhintsturnover\else
- \let\sphinxVerbatim@Continued\@empty
- \let\sphinxVerbatim@Continues\@empty
- \fi
- \ifspx@opt@verbatimwrapslines
+ % non-empty \sphinxVerbatimTitle has label inside it (in case there is one)
+ % Customize framed.sty \MakeFramed to glue caption to literal block
+ \global\spx@myfirstframedpasstrue
+ % via \spx@fcolorbox, will use \spx@VerbatimFBox which inserts title
+ \def\FrameCommand {\spx@colorbox\spx@fcolorbox }%
+ \let\FirstFrameCommand\FrameCommand
+ % for mid pages and last page portion of (long) split frame:
+ \def\MidFrameCommand{\spx@colorbox\fcolorbox }%
+ \let\LastFrameCommand\MidFrameCommand
% fancyvrb's Verbatim puts each input line in (unbreakable) horizontal boxes.
% This customization wraps each line from the input in a \vtop, thus
% allowing it to wrap and display on two or more lines in the latex output.
% to achieve this without extensive rewrite of fancyvrb.
% - The (not used in sphinx) obeytabs option to Verbatim is
% broken by this change (showtabs and tabspace work).
- \let\sphinxVerbatimFormatLine\sphinxVerbatimFormatLineWrap
- \let\FV@Space\spx@verbatim@space
- % Allow breaks at special characters using \PYG... macros.
- \sphinxbreaksatspecials
- % Breaks at punctuation characters . , ; ? ! and / (needs catcode activation)
- \fvset{codes*=\sphinxbreaksviaactive}%
- \else % end of conditional code for wrapping long code lines
- \let\sphinxVerbatimFormatLine\sphinxVerbatimFormatLineNoWrap
- \fi
- \let\FancyVerbFormatLine\sphinxFancyVerbFormatLine
- % workaround to fancyvrb's check of \@currenvir
- \let\VerbatimEnvironment\sphinxVerbatimEnvironment
- % workaround to fancyvrb's check of current list depth
+ \sbox\sphinxcontinuationbox {\sphinxcontinuationsymbol}%
+ \sbox\sphinxvisiblespacebox {\FV@SetupFont\sphinxvisiblespace}%
+ \def\FancyVerbFormatLine ##1{\hsize\linewidth
+ \vtop{\raggedright\hyphenpenalty\z@\exhyphenpenalty\z@
+ \doublehyphendemerits\z@\finalhyphendemerits\z@
+ \strut ##1\strut}%
+ }%
+ % If the linebreak is at a space, the latter will be displayed as visible
+ % space at end of first line, and a continuation symbol starts next line.
+ % Stretch/shrink are however usually zero for typewriter font.
+ \def\FV@Space {%
+ \nobreak\hskip\z@ plus\fontdimen3\font minus\fontdimen4\font
+ \discretionary{\copy\sphinxvisiblespacebox}{\sphinxafterbreak}
+ {\kern\fontdimen2\font}%
+ }%
+ % go around fancyvrb's check of @currenvir (for case of minipage below)
+ \renewcommand*{\VerbatimEnvironment}{\gdef\FV@EnvironName{Verbatim}}%
+ % go around fancyvrb's check of current list depth
\def\@toodeep {\advance\@listdepth\@ne}%
+ % Allow breaks at special characters using \PYG... macros.
+ \sphinxbreaksatspecials
% The list environment is needed to control perfectly the vertical space.
% Note: \OuterFrameSep used by framed.sty is later set to \topsep hence 0pt.
- % - if caption: distance from last text baseline to caption baseline is
- % A+(B-F)+\ht\strutbox, A = \abovecaptionskip (default 10pt), B =
- % \baselineskip, F is the framed.sty \FrameHeightAdjust macro, default 6pt.
- % Formula valid for F < 10pt.
- % - distance of baseline of caption to top of frame is like for tables:
- % \sphinxbelowcaptionspace (=0.5\baselineskip)
- % - if no caption: distance of last text baseline to code frame is S+(B-F),
- % with S = \sphinxverbatimtopskip (=\smallskip)
- % - and distance from bottom of frame to next text baseline is
- % \baselineskip+\parskip.
- % The \trivlist is used to avoid possible "too deeply nested" error.
+ % - if caption: vertical space above caption = (\abovecaptionskip + D) with
+ % D = \baselineskip-\FrameHeightAdjust, and then \smallskip above frame.
+ % - if no caption: (\smallskip + D) above frame. By default D=6pt.
+ % Use trivlist rather than list to avoid possible "too deeply nested" error.
\itemsep \z@skip
\topsep \z@skip
- \partopsep \z@skip
- % trivlist will set \parsep to \parskip = zero
+ \partopsep \z@skip% trivlist will set \parsep to \parskip = zero (see above)
% \leftmargin will be set to zero by trivlist
\rightmargin\z@
\parindent \z@% becomes \itemindent. Default zero, but perhaps overwritten.
\trivlist\item\relax
- \ifsphinxverbatimwithminipage\spx@inframedtrue\fi
- % use a minipage if we are already inside a framed environment
+ % use a minipage if we are already inside a framed environment
\ifspx@inframed\noindent\begin{minipage}{\linewidth}\fi
\MakeFramed {% adapted over from framed.sty's snugshade environment
- \advance\hsize-\width\@totalleftmargin\z@\linewidth\hsize\@setminipage
- }%
+ \advance\hsize-\width\@totalleftmargin\z@\linewidth\hsize
+ \@setminipage }%
+ \small
% For grid placement from \strut's in \FancyVerbFormatLine
\lineskip\z@skip
- % active comma should not be overwritten by \@noligs
- \ifspx@opt@verbatimwrapslines
- \let\verbatim@nolig@list \sphinx@verbatim@nolig@list
- \fi
- % will fetch its optional arguments if any
- \OriginalVerbatim
+ % Breaks at punctuation characters . , ; ? ! and / need catcode=\active
+ % and the active comma should not be overwritten by \@noligs
+ \let\verbatim@nolig@list \sphinx@verbatim@nolig@list
+ \OriginalVerbatim[#1,codes*=\sphinxbreaksatpunct]%
}
-{%
+\renewcommand{\endVerbatim}{%
\endOriginalVerbatim
- \par\unskip\@minipagefalse\endMakeFramed % from framed.sty snugshade
+ \par\unskip\@minipagefalse\endMakeFramed
\ifspx@inframed\end{minipage}\fi
\endtrivlist
}
-\newenvironment {sphinxVerbatimNoFrame}
- {\spx@opt@verbatimwithframefalse
- % needed for fancyvrb as literal code will end in \end{sphinxVerbatimNoFrame}
- \def\sphinxVerbatimEnvironment{\gdef\FV@EnvironName{sphinxVerbatimNoFrame}}%
- \begin{sphinxVerbatim}}
- {\end{sphinxVerbatim}}
-\newenvironment {sphinxVerbatimintable}
- {% don't use a frame if in a table cell
- \spx@opt@verbatimwithframefalse
- \sphinxverbatimwithminipagetrue
- % the literal block caption uses \sphinxcaption which is wrapper of \caption,
- % but \caption must be modified because longtable redefines it to work only
- % for the own table caption, and tabulary has multiple passes
- \let\caption\sphinxfigcaption
- % reduce above caption skip
- \def\spx@abovecaptionskip{\sphinxverbatimsmallskipamount}%
- \def\sphinxVerbatimEnvironment{\gdef\FV@EnvironName{sphinxVerbatimintable}}%
- \begin{sphinxVerbatim}}
- {\end{sphinxVerbatim}}
-
-
-%% PARSED LITERALS
-% allow long lines to wrap like they do in code-blocks
-
-% this should be kept in sync with definitions in sphinx.util.texescape
-\newcommand*\sphinxbreaksattexescapedchars{%
- \def\do##1##2% put potential break point before character
- {\def##1{\discretionary{}{\sphinxafterbreak\char`##2}{\char`##2}}}%
- \do\{\{\do\textless\<\do\#\#\do\%\%\do\$\$% {, <, #, %, $
- \def\do##1##2% put potential break point after character
- {\def##1{\discretionary{\char`##2}{\sphinxafterbreak}{\char`##2}}}%
- \do\_\_\do\}\}\do\textasciicircum\^\do\&\&% _, }, ^, &,
- \do\textgreater\>\do\textasciitilde\~% >, ~
-}
-\newcommand*\sphinxbreaksviaactiveinparsedliteral{%
- \sphinxbreaksviaactive % by default handles . , ; ? ! /
- \do\-% we need also the hyphen character (ends up "as is" in parsed-literal)
- \lccode`\~`\~ %
- % update \dospecials as it is used by \url
- % but deactivation will already have been done hence this is unneeded:
- % \expandafter\def\expandafter\dospecials\expandafter{\dospecials
- % \sphinxbreaksbeforeactivelist\sphinxbreaksafteractivelist\do\-}%
-}
-\newcommand*\sphinxbreaksatspaceinparsedliteral{%
- \lccode`~32 \lowercase{\let~}\spx@verbatim@space\lccode`\~`\~
-}
-\newcommand*{\sphinxunactivateextras}{\let\do\@makeother
- \sphinxbreaksbeforeactivelist\sphinxbreaksafteractivelist\do\-}%
-% the \catcode13=5\relax (deactivate end of input lines) is left to callers
-\newcommand*{\sphinxunactivateextrasandspace}{\catcode32=10\relax
- \sphinxunactivateextras}%
-% now for the modified alltt environment
-\newenvironment{sphinxalltt}
-{% at start of next line to workaround Emacs/AUCTeX issue with this file
-\begin{alltt}%
- \ifspx@opt@parsedliteralwraps
- \sbox\sphinxcontinuationbox {\spx@opt@verbatimcontinued}%
- \sbox\sphinxvisiblespacebox {\spx@opt@verbatimvisiblespace}%
- \sphinxbreaksattexescapedchars
- \sphinxbreaksviaactiveinparsedliteral
- \sphinxbreaksatspaceinparsedliteral
-% alltt takes care of the ' as derivative ("prime") in math mode
- \everymath\expandafter{\the\everymath\sphinxunactivateextrasandspace
- \catcode`\<=12\catcode`\>=12\catcode`\^=7\catcode`\_=8 }%
-% not sure if displayed math (align,...) can end up in parsed-literal, anyway
- \everydisplay\expandafter{\the\everydisplay
- \catcode13=5 \sphinxunactivateextrasandspace
- \catcode`\<=12\catcode`\>=12\catcode`\^=7\catcode`\_=8 }%
- \fi }
-{\end{alltt}}
-
-% Protect \href's first argument in contexts such as sphinxalltt (or
-% \sphinxcode). Sphinx uses \#, \%, \& ... always inside \sphinxhref.
-\protected\def\sphinxhref#1#2{{%
- \sphinxunactivateextrasandspace % never do \scantokens with active space!
- \endlinechar\m@ne\everyeof{{#2}}% keep catcode regime for #2
- \scantokens{\href{#1}}% normalise it for #1 during \href expansion
-}}
-% Same for \url. And also \nolinkurl for coherence.
-\protected\def\sphinxurl#1{{%
- \sphinxunactivateextrasandspace\everyeof{}% (<- precaution for \scantokens)
- \endlinechar\m@ne\scantokens{\url{#1}}%
-}}
-\protected\def\sphinxnolinkurl#1{{%
- \sphinxunactivateextrasandspace\everyeof{}%
- \endlinechar\m@ne\scantokens{\nolinkurl{#1}}%
-}}
-
-
-%% TOPIC AND CONTENTS BOXES
-%
-% Again based on use of "framed.sty", this allows breakable framed boxes.
+
+% define macro to frame contents and add shadow on right and bottom
+% use public names for customizable lengths
+\newlength\sphinxshadowsep \setlength\sphinxshadowsep {5pt}
+\newlength\sphinxshadowsize \setlength\sphinxshadowsize {4pt}
+\newlength\sphinxshadowrule
+% this uses \fboxrule value at loading time of sphinx.sty (0.4pt normally)
+\setlength\sphinxshadowrule {\fboxrule}
+
\long\def\spx@ShadowFBox#1{%
\leavevmode\begingroup
% first we frame the box #1
\newenvironment{sphinxShadowBox}
{\def\FrameCommand {\spx@ShadowFBox }%
% configure framed.sty not to add extra vertical spacing
- \ltx@ifundefined{OuterFrameSep}{}{\OuterFrameSep\z@skip}%
+ \spx@ifundefined{OuterFrameSep}{}{\OuterFrameSep\z@skip}%
% the \trivlist will add the vertical spacing on top and bottom which is
% typical of center environment as used in Sphinx <= 1.4.1
% the \noindent has the effet of an extra blank line on top, to
% imitate closely the layout from Sphinx <= 1.4.1; the \FrameHeightAdjust
% will put top part of frame on this baseline.
\def\FrameHeightAdjust {\baselineskip}%
- % use package footnote to handle footnotes
- \savenotes
\trivlist\item\noindent
% use a minipage if we are already inside a framed environment
\ifspx@inframed\begin{minipage}{\linewidth}\fi
% itemize/enumerate are therein typeset more tightly, we want to keep
% that). We copy-paste from LaTeX source code but don't do a real minipage.
\@pboxswfalse
+ % for footnotes, but Sphinx inactivates footnotes in topics
+ \def\@mpfn{mpfootnote}\def\thempfn{\thempfootnote}\c@mpfootnote\z@
+ \let\@footnotetext\@mpfootnotetext
\let\@listdepth\@mplistdepth \@mplistdepth\z@
\@minipagerestore
\@setminipage
}%
{% insert the "endminipage" code
\par\unskip
+ % handle (currently non existing) minipage style footnotes
+ \ifvoid\@mpfootins\else
+ \vskip\skip\@mpfootins\normalcolor\footnoterule\unvbox\@mpfootins
+ \fi
\@minipagefalse
\endMakeFramed
\ifspx@inframed\end{minipage}\fi
\endtrivlist
- % output the stored footnotes
- \spewnotes
}
-%% NOTICES AND ADMONITIONS
+% \moduleauthor{name}{email}
+\newcommand{\moduleauthor}[2]{}
+
+% \sectionauthor{name}{email}
+\newcommand{\sectionauthor}[2]{}
+
+% Augment the sectioning commands used to get our own font family in place,
+% and reset some internal data items:
+\titleformat{\section}{\Large\py@HeaderFamily}%
+ {\py@TitleColor\thesection}{0.5em}{\py@TitleColor}{\py@NormalColor}
+\titleformat{\subsection}{\large\py@HeaderFamily}%
+ {\py@TitleColor\thesubsection}{0.5em}{\py@TitleColor}{\py@NormalColor}
+\titleformat{\subsubsection}{\py@HeaderFamily}%
+ {\py@TitleColor\thesubsubsection}{0.5em}{\py@TitleColor}{\py@NormalColor}
+% By default paragraphs (and subsubsections) will not be numbered because
+% sphinxmanual.cls and sphinxhowto.cls set secnumdepth to 2
+\titleformat{\paragraph}{\py@HeaderFamily}%
+ {\py@TitleColor\theparagraph}{0.5em}{\py@TitleColor}{\py@NormalColor}
+\titleformat{\subparagraph}{\py@HeaderFamily}%
+ {\py@TitleColor\thesubparagraph}{0.5em}{\py@TitleColor}{\py@NormalColor}
+
+% {fulllineitems} is the main environment for object descriptions.
%
-% Some are quite plain
-% the spx@notice@bordercolor etc are set in the sphinxadmonition environment
-\newenvironment{sphinxlightbox}{%
- \par\allowbreak
- \noindent{\color{spx@notice@bordercolor}%
- \rule{\linewidth}{\spx@notice@border}}\par\nobreak
- {\parskip\z@skip\noindent}%
- }
- {%
- % counteract previous possible negative skip (French lists!):
- % (we can't cancel that any earlier \vskip introduced a potential pagebreak)
- \sphinxvspacefixafterfrenchlists
- \nobreak\vbox{\noindent\kern\@totalleftmargin
- {\color{spx@notice@bordercolor}%
- \rule[\dimexpr.4\baselineskip-\spx@notice@border\relax]
- {\linewidth}{\spx@notice@border}}\hss}\allowbreak
- }% end of sphinxlightbox environment definition
-% may be renewenvironment'd by user for complete customization
-\newenvironment{sphinxnote}[1]
- {\begin{sphinxlightbox}\sphinxstrong{#1} }{\end{sphinxlightbox}}
-\newenvironment{sphinxhint}[1]
- {\begin{sphinxlightbox}\sphinxstrong{#1} }{\end{sphinxlightbox}}
-\newenvironment{sphinximportant}[1]
- {\begin{sphinxlightbox}\sphinxstrong{#1} }{\end{sphinxlightbox}}
-\newenvironment{sphinxtip}[1]
- {\begin{sphinxlightbox}\sphinxstrong{#1} }{\end{sphinxlightbox}}
-% or just use the package options
-% these are needed for common handling by notice environment of lightbox
-% and heavybox but they are currently not used by lightbox environment
-% and there is consequently no corresponding package option
-\definecolor{sphinxnoteBgColor}{rgb}{1,1,1}
-\definecolor{sphinxhintBgColor}{rgb}{1,1,1}
-\definecolor{sphinximportantBgColor}{rgb}{1,1,1}
-\definecolor{sphinxtipBgColor}{rgb}{1,1,1}
-
-% Others get more distinction
+\newcommand{\py@itemnewline}[1]{%
+ \@tempdima\linewidth%
+ \advance\@tempdima \leftmargin\makebox[\@tempdima][l]{#1}%
+}
+
+\newenvironment{fulllineitems}{
+ \begin{list}{}{\labelwidth \leftmargin \labelsep 0pt
+ \rightmargin 0pt \topsep -\parskip \partopsep \parskip
+ \itemsep -\parsep
+ \let\makelabel=\py@itemnewline}
+}{\end{list}}
+
+% \optional is used for ``[, arg]``, i.e. desc_optional nodes.
+\newcommand{\sphinxoptional}[1]{%
+ {\textnormal{\Large[}}{#1}\hspace{0.5mm}{\textnormal{\Large]}}}
+
+\newlength{\py@argswidth}
+\newcommand{\py@sigparams}[2]{%
+ \parbox[t]{\py@argswidth}{#1\sphinxcode{)}#2}}
+\newcommand{\pysigline}[1]{\item[#1]\nopagebreak}
+\newcommand{\pysiglinewithargsret}[3]{%
+ \settowidth{\py@argswidth}{#1\sphinxcode{(}}%
+ \addtolength{\py@argswidth}{-2\py@argswidth}%
+ \addtolength{\py@argswidth}{\linewidth}%
+ \item[#1\sphinxcode{(}\py@sigparams{#2}{#3}]}
+
+% Production lists
+%
+\newenvironment{productionlist}{
+% \def\sphinxoptional##1{{\Large[}##1{\Large]}}
+ \def\production##1##2{\\\sphinxcode{##1}&::=&\sphinxcode{##2}}
+ \def\productioncont##1{\\& &\sphinxcode{##1}}
+ \parindent=2em
+ \indent
+ \setlength{\LTpre}{0pt}
+ \setlength{\LTpost}{0pt}
+ \begin{longtable}[l]{lcl}
+}{%
+ \end{longtable}
+}
+
+% Notices / Admonitions
+%
+
% Code adapted from framed.sty's "snugshade" environment.
% Nesting works (inner frames do not allow page breaks).
-\newenvironment{sphinxheavybox}{\par
- \setlength{\FrameRule}{\spx@notice@border}%
+\newcommand{\py@heavybox}{\par
+ \setlength{\FrameRule}{\p@}% 1pt
\setlength{\FrameSep}{\dimexpr.6\baselineskip-\FrameRule\relax}
% configure framed.sty's parameters to obtain same vertical spacing
% as for "light" boxes. We need for this to manually insert parskip glue and
% revert a skip done by framed before the frame.
- \ltx@ifundefined{OuterFrameSep}{}{\OuterFrameSep\z@skip}%
+ \spx@ifundefined{OuterFrameSep}{}{\OuterFrameSep\z@skip}%
\vspace{\FrameHeightAdjust}
% copied/adapted from framed.sty's snugshade
\def\FrameCommand##1{\hskip\@totalleftmargin
- \fboxsep\FrameSep \fboxrule\FrameRule
- \fcolorbox{spx@notice@bordercolor}{spx@notice@bgcolor}{##1}%
+ \fboxsep\FrameSep \fboxrule\FrameRule\fbox{##1}%
\hskip-\linewidth \hskip-\@totalleftmargin \hskip\columnwidth}%
- \savenotes
% use a minipage if we are already inside a framed environment
\ifspx@inframed
\noindent\begin{minipage}{\linewidth}
\advance\hsize-\width \@totalleftmargin\z@ \linewidth\hsize
% minipage initialization copied from LaTeX source code.
\@pboxswfalse
+ % for footnotes
+ \def\@mpfn{mpfootnote}\def\thempfn{\thempfootnote}\c@mpfootnote\z@
+ \let\@footnotetext\@mpfootnotetext
\let\@listdepth\@mplistdepth \@mplistdepth\z@
\@minipagerestore
\@setminipage }%
}
- {%
+\newcommand{\py@endheavybox}{%
\par\unskip
+ % handles footnotes
+ \ifvoid\@mpfootins\else
+ \vskip\skip\@mpfootins\normalcolor\footnoterule\unvbox\@mpfootins
+ \fi
\@minipagefalse
\endMakeFramed
\ifspx@inframed\end{minipage}\fi
- % set footnotes at bottom of page
- \spewnotes
% arrange for similar spacing below frame as for "light" boxes.
\vskip .4\baselineskip
- }% end of sphinxheavybox environment definition
-% may be renewenvironment'd by user for complete customization
-\newenvironment{sphinxwarning}[1]
- {\begin{sphinxheavybox}\sphinxstrong{#1} }{\end{sphinxheavybox}}
-\newenvironment{sphinxcaution}[1]
- {\begin{sphinxheavybox}\sphinxstrong{#1} }{\end{sphinxheavybox}}
-\newenvironment{sphinxattention}[1]
- {\begin{sphinxheavybox}\sphinxstrong{#1} }{\end{sphinxheavybox}}
-\newenvironment{sphinxdanger}[1]
- {\begin{sphinxheavybox}\sphinxstrong{#1} }{\end{sphinxheavybox}}
-\newenvironment{sphinxerror}[1]
- {\begin{sphinxheavybox}\sphinxstrong{#1} }{\end{sphinxheavybox}}
-% or just use package options
-
-% the \colorlet of xcolor (if at all loaded) is overkill for our use case
-\newcommand{\sphinxcolorlet}[2]
- {\expandafter\let\csname\@backslashchar color@#1\expandafter\endcsname
- \csname\@backslashchar color@#2\endcsname }
-
-% the main dispatch for all types of notices
-\newenvironment{sphinxadmonition}[2]{% #1=type, #2=heading
- % can't use #1 directly in definition of end part
- \def\spx@noticetype {#1}%
- % set parameters of heavybox/lightbox
- \sphinxcolorlet{spx@notice@bordercolor}{sphinx#1BorderColor}%
- \sphinxcolorlet{spx@notice@bgcolor}{sphinx#1BgColor}%
- \spx@notice@border \dimexpr\csname spx@opt@#1border\endcsname\relax
- % start specific environment, passing the heading as argument
- \begin{sphinx#1}{#2}}
- % workaround some LaTeX "feature" of \end command
- {\edef\spx@temp{\noexpand\end{sphinx\spx@noticetype}}\spx@temp}
-
-
-%% PYTHON DOCS MACROS AND ENVIRONMENTS
-% (some macros here used by \maketitle in sphinxmanual.cls and sphinxhowto.cls)
+ }
-% \moduleauthor{name}{email}
-\newcommand{\moduleauthor}[2]{}
+\newcommand{\py@lightbox}{%
+ \par\allowbreak
+ \noindent\rule{\linewidth}{0.5pt}\par\nobreak
+ {\parskip\z@skip\noindent}%
+ }
+\newcommand{\py@endlightbox}{%
+ \par
+ % counteract previous possible negative skip (French lists!):
+ % (we can't cancel that any earlier \vskip introduced a potential pagebreak)
+ \ifdim\lastskip<\z@\vskip-\lastskip\fi
+ \nobreak\vbox{\noindent\kern\@totalleftmargin
+ \rule[.4\baselineskip]{\linewidth}{0.5pt}\hss}\allowbreak
+ }
-% \sectionauthor{name}{email}
-\newcommand{\sectionauthor}[2]{}
+% Some are quite plain:
+\newcommand{\py@noticestart@note}{\py@lightbox}
+\newcommand{\py@noticeend@note}{\py@endlightbox}
+\newcommand{\py@noticestart@hint}{\py@lightbox}
+\newcommand{\py@noticeend@hint}{\py@endlightbox}
+\newcommand{\py@noticestart@important}{\py@lightbox}
+\newcommand{\py@noticeend@important}{\py@endlightbox}
+\newcommand{\py@noticestart@tip}{\py@lightbox}
+\newcommand{\py@noticeend@tip}{\py@endlightbox}
+
+% Others gets more visible distinction:
+\newcommand{\py@noticestart@warning}{\py@heavybox}
+\newcommand{\py@noticeend@warning}{\py@endheavybox}
+\newcommand{\py@noticestart@caution}{\py@heavybox}
+\newcommand{\py@noticeend@caution}{\py@endheavybox}
+\newcommand{\py@noticestart@attention}{\py@heavybox}
+\newcommand{\py@noticeend@attention}{\py@endheavybox}
+\newcommand{\py@noticestart@danger}{\py@heavybox}
+\newcommand{\py@noticeend@danger}{\py@endheavybox}
+\newcommand{\py@noticestart@error}{\py@heavybox}
+\newcommand{\py@noticeend@error}{\py@endheavybox}
+
+\newenvironment{notice}[2]{
+ \def\py@noticetype{#1}
+ \csname py@noticestart@#1\endcsname
+ \sphinxstrong{#2} % <- legacy code creates a space after {#2}
+}{\csname py@noticeend@\py@noticetype\endcsname}
% Allow the release number to be specified independently of the
% \date{}. This allows the date to reflect the document's date and
% release to specify the release that is documented.
%
-\newcommand{\py@release}{\releasename\space\version}
-\newcommand{\version}{}% part of \py@release, used by title page and headers
-% \releaseinfo is used on titlepage (sphinxmanual.cls, sphinxhowto.cls)
+\newcommand{\py@release}{}
+\newcommand{\version}{}
+\newcommand{\shortversion}{}
\newcommand{\releaseinfo}{}
-\newcommand{\setreleaseinfo}[1]{\renewcommand{\releaseinfo}{#1}}
-% this is inserted via template and #1=release config variable
-\newcommand{\release}[1]{\renewcommand{\version}{#1}}
-% this is defined by template to 'releasename' latex_elements key
-\newcommand{\releasename}{}
-% Fix issue in case release and releasename deliberately left blank
-\newcommand{\sphinxheadercomma}{, }% used in fancyhdr header definition
-\newcommand{\sphinxifemptyorblank}[1]{%
-% test after one expansion of macro #1 if contents is empty or spaces
- \if&\expandafter\@firstofone\detokenize\expandafter{#1}&%
- \expandafter\@firstoftwo\else\expandafter\@secondoftwo\fi}%
-\AtBeginDocument {%
- \sphinxifemptyorblank{\releasename}
- {\sphinxifemptyorblank{\version}{\let\sphinxheadercomma\empty}{}}
- {}%
-}%
+\newcommand{\releasename}{Release}
+\newcommand{\release}[1]{%
+ \renewcommand{\py@release}{\releasename\space\version}%
+ \renewcommand{\version}{#1}}
+\newcommand{\setshortversion}[1]{%
+ \renewcommand{\shortversion}{#1}}
+\newcommand{\setreleaseinfo}[1]{%
+ \renewcommand{\releaseinfo}{#1}}
% Allow specification of the author's address separately from the
% author's name. This can be used to format them differently, which
\newcommand{\py@authoraddress}{}
\newcommand{\authoraddress}[1]{\renewcommand{\py@authoraddress}{#1}}
-% {fulllineitems} is the main environment for object descriptions.
-%
-\newcommand{\py@itemnewline}[1]{%
- \kern\labelsep
- \@tempdima\linewidth
- \advance\@tempdima \labelwidth\makebox[\@tempdima][l]{#1}%
- \kern-\labelsep
-}
-
-\newenvironment{fulllineitems}{%
- \begin{list}{}{\labelwidth \leftmargin
- \rightmargin \z@ \topsep -\parskip \partopsep \parskip
- \itemsep -\parsep
- \let\makelabel=\py@itemnewline}%
-}{\end{list}}
-
-% Signatures, possibly multi-line
+% This sets up the fancy chapter headings that make the documents look
+% at least a little better than the usual LaTeX output.
%
-\newlength{\py@argswidth}
-\newcommand{\py@sigparams}[2]{%
- \parbox[t]{\py@argswidth}{#1\sphinxcode{)}#2}}
-\newcommand{\pysigline}[1]{\item[{#1}]}
-\newcommand{\pysiglinewithargsret}[3]{%
- \settowidth{\py@argswidth}{#1\sphinxcode{(}}%
- \addtolength{\py@argswidth}{-2\py@argswidth}%
- \addtolength{\py@argswidth}{\linewidth}%
- \item[{#1\sphinxcode{(}\py@sigparams{#2}{#3}}]}
-\newcommand{\pysigstartmultiline}{%
- \def\pysigstartmultiline{\vskip\smallskipamount\parskip\z@skip\itemsep\z@skip}%
- \edef\pysigstopmultiline
- {\noexpand\leavevmode\parskip\the\parskip\relax\itemsep\the\itemsep\relax}%
- \parskip\z@skip\itemsep\z@skip
+\spx@ifundefined{ChTitleVar}{}{
+ \ChNameVar{\raggedleft\normalsize\py@HeaderFamily}
+ \ChNumVar{\raggedleft \bfseries\Large\py@HeaderFamily}
+ \ChTitleVar{\raggedleft \textrm{\Huge\py@HeaderFamily}}
+ % This creates chapter heads without the leading \vspace*{}:
+ \def\@makechapterhead#1{%
+ {\parindent \z@ \raggedright \normalfont
+ \ifnum \c@secnumdepth >\m@ne
+ \DOCH
+ \fi
+ \interlinepenalty\@M
+ \DOTI{#1}
+ }
+ }
}
-% Production lists
+% Redefine description environment so that it is usable inside fulllineitems.
%
-\newenvironment{productionlist}{%
-% \def\sphinxoptional##1{{\Large[}##1{\Large]}}
- \def\production##1##2{\\\sphinxcode{\sphinxupquote{##1}}&::=&\sphinxcode{\sphinxupquote{##2}}}%
- \def\productioncont##1{\\& &\sphinxcode{\sphinxupquote{##1}}}%
- \parindent=2em
- \indent
- \setlength{\LTpre}{0pt}%
- \setlength{\LTpost}{0pt}%
- \begin{longtable}[l]{lcl}
-}{%
- \end{longtable}
-}
+\renewcommand{\description}{%
+ \list{}{\labelwidth\z@%
+ \itemindent-\leftmargin%
+ \labelsep5pt%
+ \let\makelabel=\descriptionlabel}}
% Definition lists; requested by AMK for HOWTO documents. Probably useful
% elsewhere as well, so keep in in the general style support.
%
\newenvironment{definitions}{%
\begin{description}%
- \def\term##1{\item[{##1}]\mbox{}\\*[0mm]}%
+ \def\term##1{\item[##1]\mbox{}\\*[0mm]}
}{%
\end{description}%
}
-%% FROM DOCTUTILS LATEX WRITER
-%
+% Tell TeX about pathological hyphenation cases:
+\hyphenation{Base-HTTP-Re-quest-Hand-ler}
+
+
% The following is stuff copied from docutils' latex writer.
%
\newcommand{\optionlistlabel}[1]{\normalfont\bfseries #1 \hfill}% \bf deprecated
{\setlength{\partopsep}{\parskip}
\addtolength{\partopsep}{\baselineskip}
\topsep0pt\itemsep0.15\baselineskip\parsep0pt
- \leftmargin#1\relax}
+ \leftmargin#1}
\raggedright}
{\end{list}}
+% Re-define \includegraphics to resize images larger than the line width
+% if the size is not specified.
+% Warning: future version of Sphinx will not modify original \includegraphics,
+% Below custom code will be direct definition of \sphinxincludegraphics, with
+% \py@Oldincludegraphics replaced by direct use of original \includegraphics.
+\let\py@Oldincludegraphics\includegraphics
+\newbox\spx@image@box
+\renewcommand*{\includegraphics}[2][\@empty]{%
+ \ifx\@empty #1% attention, #1 could be bb.., bad if first after \ifx
+ \setbox\spx@image@box=\hbox{\py@Oldincludegraphics{#2}}%
+ \ifdim \wd\spx@image@box>\linewidth
+ \py@Oldincludegraphics[width=\linewidth]{#2}%
+ \else
+ \leavevmode\box\spx@image@box
+ \fi
+ \else
+ \py@Oldincludegraphics[#1]{#2}%
+ \fi
+}
+% Writer will put \sphinxincludegraphics in LaTeX source, and with this,
+% documents which used their own modified \includegraphics will compile
+% as before. But see warning above.
+\newcommand*{\sphinxincludegraphics}{\includegraphics}
+
+% to make pdf with correct encoded bookmarks in Japanese
+% this should precede the hyperref package
+\ifx\kanjiskip\undefined
+% for non-Japanese: make sure bookmarks are ok also with lualatex
+ \PassOptionsToPackage{pdfencoding=unicode}{hyperref}
+\else
+ \usepackage{atbegshi}
+ \ifx\ucs\undefined
+ \ifnum 42146=\euc"A4A2
+ \AtBeginShipoutFirst{\special{pdf:tounicode EUC-UCS2}}
+ \else
+ \AtBeginShipoutFirst{\special{pdf:tounicode 90ms-RKSJ-UCS2}}
+ \fi
+ \else
+ \AtBeginShipoutFirst{\special{pdf:tounicode UTF8-UCS2}}
+ \fi
+\fi
+
+% Include hyperref last.
+\RequirePackage[colorlinks,breaklinks,
+ linkcolor=InnerLinkColor,filecolor=OuterLinkColor,
+ menucolor=OuterLinkColor,urlcolor=OuterLinkColor,
+ citecolor=InnerLinkColor]{hyperref}
+% Fix anchor placement for figures with captions.
+% (Note: we don't use a package option here; instead, we give an explicit
+% \capstart for figures that actually have a caption.)
+\RequirePackage{hypcap}
+
+% Set up styles of URL: it should be placed after hyperref
+\urlstyle{same}
+
% From docutils.writers.latex2e
% inline markup (custom roles)
% \DUrole{#1}{#2} tries \DUrole#1{#2}
\providecommand*{\DUrole}[2]{%
- \ifcsname DUrole\detokenize{#1}\endcsname
- \csname DUrole\detokenize{#1}\endcsname{#2}%
+ \ifcsname DUrole#1\endcsname%
+ \csname DUrole#1\endcsname{#2}%
\else% backwards compatibility: try \docutilsrole#1{#2}
- \ifcsname docutilsrole\detokenize{#1}\endcsname
- \csname docutilsrole\detokenize{#1}\endcsname{#2}%
- \else
+ \ifcsname docutilsrole#1\endcsname%
+ \csname docutilsrole#1\endcsname{#2}%
+ \else%
#2%
- \fi
- \fi
+ \fi%
+ \fi%
}
\providecommand*{\DUprovidelength}[2]{%
{\endlist}
\fi
-%% TEXT STYLING
-%
-% to obtain straight quotes we execute \@noligs as patched by upquote, and
-% \scantokens is needed in cases where it would be too late for the macro to
-% first set catcodes and then fetch its argument. We also make the contents
-% breakable at non-escaped . , ; ? ! / using \sphinxbreaksviaactive.
-% the macro must be protected if it ends up used in moving arguments,
-% in 'alltt' \@noligs is done already, and the \scantokens must be avoided.
-\protected\def\sphinxupquote#1{{\def\@tempa{alltt}%
- \ifx\@tempa\@currenvir\else
- \ifspx@opt@inlineliteralwraps
- \sphinxbreaksviaactive\let\sphinxafterbreak\empty
- % do not overwrite the comma set-up
- \let\verbatim@nolig@list\sphinx@literal@nolig@list
- \fi
- % fix a space-gobbling issue due to LaTeX's original \do@noligs
- \let\do@noligs\sphinx@do@noligs
- \@noligs\endlinechar\m@ne\everyeof{}% (<- in case inside \sphinxhref)
- \expandafter\scantokens
- \fi {{#1}}}}% extra brace pair to fix end-space gobbling issue...
-\def\sphinx@do@noligs #1{\catcode`#1\active\begingroup\lccode`\~`#1\relax
- \lowercase{\endgroup\def~{\leavevmode\kern\z@\char`#1 }}}
-\def\sphinx@literal@nolig@list {\do\`\do\<\do\>\do\'\do\-}%
+% From footmisc.sty: allows footnotes in titles
+\let\FN@sf@@footnote\footnote
+\def\footnote{\ifx\protect\@typeset@protect
+ \expandafter\FN@sf@@footnote
+ \else
+ \expandafter\FN@sf@gobble@opt
+ \fi
+}
+\edef\FN@sf@gobble@opt{\noexpand\protect
+ \expandafter\noexpand\csname FN@sf@gobble@opt \endcsname}
+\expandafter\def\csname FN@sf@gobble@opt \endcsname{%
+ \@ifnextchar[%]
+ \FN@sf@gobble@twobracket
+ \@gobble
+}
+\def\FN@sf@gobble@twobracket[#1]#2{}
+
+% adjust the margins for footer,
+% this works with the jsclasses only (Japanese standard document classes)
+\ifx\@jsc@uplatextrue\undefined\else
+ \hypersetup{setpagesize=false}
+ \setlength\footskip{2\baselineskip}
+ \addtolength{\textheight}{-2\baselineskip}
+\fi
-% Some custom font markup commands.
-\protected\def\sphinxstrong#1{\textbf{#1}}
-\protected\def\sphinxcode#1{\texttt{#1}}
-\protected\def\sphinxbfcode#1{\textbf{\sphinxcode{#1}}}
-\protected\def\sphinxemail#1{\textsf{#1}}
-\protected\def\sphinxtablecontinued#1{\textsf{#1}}
-\protected\def\sphinxtitleref#1{\emph{#1}}
-\protected\def\sphinxmenuselection#1{\emph{#1}}
-\protected\def\sphinxaccelerator#1{\underline{#1}}
-\protected\def\sphinxcrossref#1{\emph{#1}}
-\protected\def\sphinxtermref#1{\emph{#1}}
-% \optional is used for ``[, arg]``, i.e. desc_optional nodes.
-\long\protected\def\sphinxoptional#1{%
- {\textnormal{\Large[}}{#1}\hspace{0.5mm}{\textnormal{\Large]}}}
+% fix the double index and bibliography on the table of contents
+% in jsclasses (Japanese standard document classes)
+\ifx\@jsc@uplatextrue\undefined\else
+ \renewcommand{\theindex}{
+ \cleardoublepage
+ \phantomsection
+ \py@OldTheindex
+ }
+ \renewcommand{\thebibliography}[1]{
+ \cleardoublepage
+ \phantomsection
+ \py@OldThebibliography{1}
+ }
+\fi
-% additional customizable styling
-% FIXME: convert this to package options ?
-\protected\def\sphinxstyleindexentry #1{\texttt{#1}}
-\protected\def\sphinxstyleindexextra #1{ \emph{(#1)}}
-\protected\def\sphinxstyleindexpageref #1{, \pageref{#1}}
-\protected\def\sphinxstyletopictitle #1{\textbf{#1}\par\medskip}
-\let\sphinxstylesidebartitle\sphinxstyletopictitle
-\protected\def\sphinxstyleothertitle #1{\textbf{#1}}
-\protected\def\sphinxstylesidebarsubtitle #1{~\\\textbf{#1} \smallskip}
-% \text.. commands do not allow multiple paragraphs
-\protected\def\sphinxstyletheadfamily {\sffamily}
-\protected\def\sphinxstyleemphasis #1{\emph{#1}}
-\protected\def\sphinxstyleliteralemphasis#1{\emph{\sphinxcode{#1}}}
-\protected\def\sphinxstylestrong #1{\textbf{#1}}
-\protected\def\sphinxstyleliteralstrong#1{\sphinxbfcode{#1}}
-\protected\def\sphinxstyleabbreviation #1{\textsc{#1}}
-\protected\def\sphinxstyleliteralintitle#1{\sphinxcode{#1}}
-\newcommand*\sphinxstylecodecontinued[1]{\footnotesize(#1)}%
-\newcommand*\sphinxstylecodecontinues[1]{\footnotesize(#1)}%
-% figure legend comes after caption and may contain arbitrary body elements
-\newenvironment{sphinxlegend}{\par\small}{\par}
-
-% Declare Unicode characters used by linux tree command to pdflatex utf8/utf8x
-\def\spx@bd#1#2{%
- \leavevmode
- \begingroup
- \ifx\spx@bd@height \@undefined\def\spx@bd@height{\baselineskip}\fi
- \ifx\spx@bd@width \@undefined\setbox0\hbox{0}\def\spx@bd@width{\wd0 }\fi
- \ifx\spx@bd@thickness\@undefined\def\spx@bd@thickness{.6\p@}\fi
- \ifx\spx@bd@lower \@undefined\def\spx@bd@lower{\dp\strutbox}\fi
- \lower\spx@bd@lower#1{#2}%
- \endgroup
-}%
-\@namedef{sphinx@u2500}% BOX DRAWINGS LIGHT HORIZONTAL
- {\spx@bd{\vbox to\spx@bd@height}
- {\vss\hrule\@height\spx@bd@thickness
- \@width\spx@bd@width\vss}}%
-\@namedef{sphinx@u2502}% BOX DRAWINGS LIGHT VERTICAL
- {\spx@bd{\hb@xt@\spx@bd@width}
- {\hss\vrule\@height\spx@bd@height
- \@width \spx@bd@thickness\hss}}%
-\@namedef{sphinx@u2514}% BOX DRAWINGS LIGHT UP AND RIGHT
- {\spx@bd{\hb@xt@\spx@bd@width}
- {\hss\raise.5\spx@bd@height
- \hb@xt@\z@{\hss\vrule\@height.5\spx@bd@height
- \@width \spx@bd@thickness\hss}%
- \vbox to\spx@bd@height{\vss\hrule\@height\spx@bd@thickness
- \@width.5\spx@bd@width\vss}}}%
-\@namedef{sphinx@u251C}% BOX DRAWINGS LIGHT VERTICAL AND RIGHT
- {\spx@bd{\hb@xt@\spx@bd@width}
- {\hss
- \hb@xt@\z@{\hss\vrule\@height\spx@bd@height
- \@width \spx@bd@thickness\hss}%
- \vbox to\spx@bd@height{\vss\hrule\@height\spx@bd@thickness
- \@width.5\spx@bd@width\vss}}}%
-\protected\def\sphinxunichar#1{\@nameuse{sphinx@u#1}}%
+% disable \@chappos in Appendix in pTeX
+\ifx\kanjiskip\undefined\else
+ \let\py@OldAppendix=\appendix
+ \renewcommand{\appendix}{
+ \py@OldAppendix
+ \gdef\@chappos{}
+ }
+\fi
-% Tell TeX about pathological hyphenation cases:
-\hyphenation{Base-HTTP-Re-quest-Hand-ler}
-\endinput
+% Define literal-block environment
+\RequirePackage{newfloat}
+\DeclareFloatingEnvironment{literal-block}
+\spx@ifundefined{c@chapter}
+ {\SetupFloatingEnvironment{literal-block}{within=section,placement=h}}
+ {\SetupFloatingEnvironment{literal-block}{within=chapter,placement=h}}
+\SetupFloatingEnvironment{literal-block}{name=List}
+% control caption around literal-block
+\RequirePackage{capt-of}
+\RequirePackage{needspace}
+% if the left page space is less than \literalblockneedspace, insert page-break
+\newcommand{\sphinxliteralblockneedspace}{5\baselineskip}
+\newcommand{\sphinxliteralblockwithoutcaptionneedspace}{1.5\baselineskip}
+
+% figure in table
+\newenvironment{sphinxfigure-in-table}[1][\linewidth]{%
+ \def\@captype{figure}%
+ \begin{minipage}{#1}%
+}{\end{minipage}}
+% store original \caption macro for use with figures in longtable and tabulary
+\AtBeginDocument{\let\spx@originalcaption\caption}
+\newcommand*\sphinxfigcaption
+ {\ifx\equation$%$% this is trick to identify tabulary first pass
+ \firstchoice@false\else\firstchoice@true\fi
+ \spx@originalcaption }
+
+% by default, also define macros with the no-prefix names
+\ifsphinxKeepOldNames
+ \typeout{** (sphinx) defining (legacy) text style macros without \string\sphinx\space prefix}
+ \typeout{** if clashes with packages, set latex_keep_old_macro_names=False in conf.py}
+ \@for\@tempa:=strong,bfcode,email,tablecontinued,titleref,%
+ menuselection,accelerator,crossref,termref,optional\do
+{% first, check if command with no prefix already exists
+ \expandafter\newcommand\csname\@tempa\endcsname{}%
+ % if no error give it the meaning defined so far with \sphinx prefix
+ \expandafter\let\csname\@tempa\expandafter\endcsname
+ \csname sphinx\@tempa\endcsname
+ % redefine the \sphinx prefixed macro to expand to non-prefixed one
+ \expandafter\def\csname sphinx\@tempa\expandafter\endcsname
+ \expandafter{\csname\@tempa\endcsname}%
+}
+ % robustified case needs special treatment
+ \newcommand\code{}\let\code\relax
+ \DeclareRobustCommand{\code}[1]{{\@noligs\scantokens{\texttt{#1}\relax}}}
+ \def\sphinxcode{\code}%
+\fi
+++ /dev/null
-\NeedsTeXFormat{LaTeX2e}[1995/12/01]
-\ProvidesPackage{sphinxhighlight}[2016/05/29 stylesheet for highlighting with pygments]
-
-
-\makeatletter
-\def\PYG@reset{\let\PYG@it=\relax \let\PYG@bf=\relax%
- \let\PYG@ul=\relax \let\PYG@tc=\relax%
- \let\PYG@bc=\relax \let\PYG@ff=\relax}
-\def\PYG@tok#1{\csname PYG@tok@#1\endcsname}
-\def\PYG@toks#1+{\ifx\relax#1\empty\else%
- \PYG@tok{#1}\expandafter\PYG@toks\fi}
-\def\PYG@do#1{\PYG@bc{\PYG@tc{\PYG@ul{%
- \PYG@it{\PYG@bf{\PYG@ff{#1}}}}}}}
-\def\PYG#1#2{\PYG@reset\PYG@toks#1+\relax+\PYG@do{#2}}
-
-\expandafter\def\csname PYG@tok@gd\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.63,0.00,0.00}{##1}}}
-\expandafter\def\csname PYG@tok@gu\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.50,0.00,0.50}{##1}}}
-\expandafter\def\csname PYG@tok@gt\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.27,0.87}{##1}}}
-\expandafter\def\csname PYG@tok@gs\endcsname{\let\PYG@bf=\textbf}
-\expandafter\def\csname PYG@tok@gr\endcsname{\def\PYG@tc##1{\textcolor[rgb]{1.00,0.00,0.00}{##1}}}
-\expandafter\def\csname PYG@tok@cm\endcsname{\let\PYG@it=\textit\def\PYG@tc##1{\textcolor[rgb]{0.25,0.50,0.56}{##1}}}
-\expandafter\def\csname PYG@tok@vg\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.73,0.38,0.84}{##1}}}
-\expandafter\def\csname PYG@tok@vi\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.73,0.38,0.84}{##1}}}
-\expandafter\def\csname PYG@tok@vm\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.73,0.38,0.84}{##1}}}
-\expandafter\def\csname PYG@tok@mh\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}}
-\expandafter\def\csname PYG@tok@cs\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.50,0.56}{##1}}\def\PYG@bc##1{\setlength{\fboxsep}{0pt}\colorbox[rgb]{1.00,0.94,0.94}{\strut ##1}}}
-\expandafter\def\csname PYG@tok@ge\endcsname{\let\PYG@it=\textit}
-\expandafter\def\csname PYG@tok@vc\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.73,0.38,0.84}{##1}}}
-\expandafter\def\csname PYG@tok@il\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}}
-\expandafter\def\csname PYG@tok@go\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.20,0.20,0.20}{##1}}}
-\expandafter\def\csname PYG@tok@cp\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
-\expandafter\def\csname PYG@tok@gi\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.63,0.00}{##1}}}
-\expandafter\def\csname PYG@tok@gh\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.00,0.50}{##1}}}
-\expandafter\def\csname PYG@tok@ni\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.84,0.33,0.22}{##1}}}
-\expandafter\def\csname PYG@tok@nl\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.13,0.44}{##1}}}
-\expandafter\def\csname PYG@tok@nn\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.05,0.52,0.71}{##1}}}
-\expandafter\def\csname PYG@tok@no\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.38,0.68,0.84}{##1}}}
-\expandafter\def\csname PYG@tok@na\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}}
-\expandafter\def\csname PYG@tok@nb\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
-\expandafter\def\csname PYG@tok@nc\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.05,0.52,0.71}{##1}}}
-\expandafter\def\csname PYG@tok@nd\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.33,0.33,0.33}{##1}}}
-\expandafter\def\csname PYG@tok@ne\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
-\expandafter\def\csname PYG@tok@nf\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.02,0.16,0.49}{##1}}}
-\expandafter\def\csname PYG@tok@si\endcsname{\let\PYG@it=\textit\def\PYG@tc##1{\textcolor[rgb]{0.44,0.63,0.82}{##1}}}
-\expandafter\def\csname PYG@tok@s2\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}}
-\expandafter\def\csname PYG@tok@nt\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.02,0.16,0.45}{##1}}}
-\expandafter\def\csname PYG@tok@nv\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.73,0.38,0.84}{##1}}}
-\expandafter\def\csname PYG@tok@s1\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}}
-\expandafter\def\csname PYG@tok@dl\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}}
-\expandafter\def\csname PYG@tok@ch\endcsname{\let\PYG@it=\textit\def\PYG@tc##1{\textcolor[rgb]{0.25,0.50,0.56}{##1}}}
-\expandafter\def\csname PYG@tok@m\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}}
-\expandafter\def\csname PYG@tok@gp\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.78,0.36,0.04}{##1}}}
-\expandafter\def\csname PYG@tok@sh\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}}
-\expandafter\def\csname PYG@tok@ow\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
-\expandafter\def\csname PYG@tok@sx\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.78,0.36,0.04}{##1}}}
-\expandafter\def\csname PYG@tok@bp\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
-\expandafter\def\csname PYG@tok@c1\endcsname{\let\PYG@it=\textit\def\PYG@tc##1{\textcolor[rgb]{0.25,0.50,0.56}{##1}}}
-\expandafter\def\csname PYG@tok@fm\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.02,0.16,0.49}{##1}}}
-\expandafter\def\csname PYG@tok@o\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.40,0.40,0.40}{##1}}}
-\expandafter\def\csname PYG@tok@kc\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
-\expandafter\def\csname PYG@tok@c\endcsname{\let\PYG@it=\textit\def\PYG@tc##1{\textcolor[rgb]{0.25,0.50,0.56}{##1}}}
-\expandafter\def\csname PYG@tok@mf\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}}
-\expandafter\def\csname PYG@tok@err\endcsname{\def\PYG@bc##1{\setlength{\fboxsep}{0pt}\fcolorbox[rgb]{1.00,0.00,0.00}{1,1,1}{\strut ##1}}}
-\expandafter\def\csname PYG@tok@mb\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}}
-\expandafter\def\csname PYG@tok@ss\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.32,0.47,0.09}{##1}}}
-\expandafter\def\csname PYG@tok@sr\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.14,0.33,0.53}{##1}}}
-\expandafter\def\csname PYG@tok@mo\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}}
-\expandafter\def\csname PYG@tok@kd\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
-\expandafter\def\csname PYG@tok@mi\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}}
-\expandafter\def\csname PYG@tok@kn\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
-\expandafter\def\csname PYG@tok@cpf\endcsname{\let\PYG@it=\textit\def\PYG@tc##1{\textcolor[rgb]{0.25,0.50,0.56}{##1}}}
-\expandafter\def\csname PYG@tok@kr\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
-\expandafter\def\csname PYG@tok@s\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}}
-\expandafter\def\csname PYG@tok@kp\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
-\expandafter\def\csname PYG@tok@w\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.73,0.73,0.73}{##1}}}
-\expandafter\def\csname PYG@tok@kt\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.56,0.13,0.00}{##1}}}
-\expandafter\def\csname PYG@tok@sc\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}}
-\expandafter\def\csname PYG@tok@sb\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}}
-\expandafter\def\csname PYG@tok@sa\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}}
-\expandafter\def\csname PYG@tok@k\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
-\expandafter\def\csname PYG@tok@se\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}}
-\expandafter\def\csname PYG@tok@sd\endcsname{\let\PYG@it=\textit\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}}
-
-\def\PYGZbs{\char`\\}
-\def\PYGZus{\char`\_}
-\def\PYGZob{\char`\{}
-\def\PYGZcb{\char`\}}
-\def\PYGZca{\char`\^}
-\def\PYGZam{\char`\&}
-\def\PYGZlt{\char`\<}
-\def\PYGZgt{\char`\>}
-\def\PYGZsh{\char`\#}
-\def\PYGZpc{\char`\%}
-\def\PYGZdl{\char`\$}
-\def\PYGZhy{\char`\-}
-\def\PYGZsq{\char`\'}
-\def\PYGZdq{\char`\"}
-\def\PYGZti{\char`\~}
-% for compatibility with earlier versions
-\def\PYGZat{@}
-\def\PYGZlb{[}
-\def\PYGZrb{]}
-\makeatother
-
-\renewcommand\PYGZsq{\textquotesingle}
%
\NeedsTeXFormat{LaTeX2e}[1995/12/01]
-\ProvidesClass{sphinxhowto}[2017/03/26 v1.6 Document class (Sphinx HOWTO)]
+\ProvidesClass{sphinxhowto}[2009/06/02 Document class (Sphinx HOWTO)]
+
+\ifx\directlua\undefined\else
+% if compiling with lualatex 0.85 or later load compatibility patch issued by
+% the LaTeX team for older packages relying on \pdf<name> named primitives.
+ \IfFileExists{luatex85.sty}{\RequirePackage{luatex85}}{}
+\fi
% 'oneside' option overriding the 'twoside' default
\newif\if@oneside
% reset these counters in your preamble.
%
\setcounter{secnumdepth}{2}
-\setcounter{tocdepth}{2}% i.e. section and subsection
% Change the title page to look a bit better, and fit in with the fncychap
% ``Bjarne'' style a bit better.
%
\renewcommand{\maketitle}{%
- \noindent\rule{\textwidth}{1pt}\par
- \begingroup % for PDF information dictionary
- \def\endgraf{ }\def\and{\& }%
- \pdfstringdefDisableCommands{\def\\{, }}% overwrite hyperref setup
- \hypersetup{pdfauthor={\@author}, pdftitle={\@title}}%
+ \noindent\rule{\textwidth}{1pt}\ifsphinxpdfoutput\newline\null\fi\par
+ \ifsphinxpdfoutput
+ \begingroup
+ % These \defs are required to deal with multi-line authors; it
+ % changes \\ to ', ' (comma-space), making it pass muster for
+ % generating document info in the PDF file.
+ \def\\{, }%
+ \def\and{and }%
+ \pdfinfo{
+ /Author (\@author)
+ /Title (\@title)
+ }%
\endgroup
+ \fi
\begin{flushright}
\sphinxlogo
\py@HeaderFamily
%\gdef\@thanks{}\gdef\@author{}\gdef\@title{}
}
-\newcommand{\sphinxtableofcontents}{
+\let\py@OldTableofcontents=\tableofcontents
+\renewcommand{\tableofcontents}{
\begingroup
\parskip = 0mm
- \tableofcontents
+ \py@OldTableofcontents
\endgroup
\rule{\textwidth}{1pt}
\vspace{12pt}
% Contents.
% For an article document class this environment is a section,
% so no page break before it.
-%
-\newenvironment{sphinxthebibliography}[1]{%
- % \phantomsection % not needed here since TeXLive 2010's hyperref
- \begin{thebibliography}{1}%
- \addcontentsline{toc}{section}{\ifdefined\refname\refname\else\ifdefined\bibname\bibname\fi\fi}}{\end{thebibliography}}
-
+\let\py@OldThebibliography=\thebibliography
+\renewcommand{\thebibliography}[1]{
+ \phantomsection
+ \py@OldThebibliography{1}
+ \addcontentsline{toc}{section}{\bibname}
+}
% Same for the indices.
% The memoir class already does this, so we don't duplicate it in that case.
%
-\@ifclassloaded{memoir}
- {\newenvironment{sphinxtheindex}{\begin{theindex}}{\end{theindex}}}
- {\newenvironment{sphinxtheindex}{%
- \phantomsection % needed because no chapter, section, ... is created by theindex
- \begin{theindex}%
- \addcontentsline{toc}{section}{\indexname}}{\end{theindex}}}
+\@ifclassloaded{memoir}{}{
+ \let\py@OldTheindex=\theindex
+ \renewcommand{\theindex}{
+ \phantomsection
+ \py@OldTheindex
+ \addcontentsline{toc}{section}{\indexname}
+ }
+}
%
\NeedsTeXFormat{LaTeX2e}[1995/12/01]
-\ProvidesClass{sphinxmanual}[2017/03/26 v1.6 Document class (Sphinx manual)]
+\ProvidesClass{sphinxmanual}[2009/06/02 Document class (Sphinx manual)]
+
+\ifx\directlua\undefined\else
+% if compiling with lualatex 0.85 or later load compatibility patch issued by
+% the LaTeX team for older packages relying on \pdf<name> named primitives.
+ \IfFileExists{luatex85.sty}{\RequirePackage{luatex85}}{}
+\fi
% chapters starting at odd pages (overridden by 'openany' document option)
\PassOptionsToClass{openright}{\sphinxdocclass}
% ``Bjarne'' style a bit better.
%
\renewcommand{\maketitle}{%
- \let\spx@tempa\relax
- \ifHy@pageanchor\def\spx@tempa{\Hy@pageanchortrue}\fi
- \hypersetup{pageanchor=false}% avoid duplicate destination warnings
\begin{titlepage}%
\let\footnotesize\small
\let\footnoterule\relax
- \noindent\rule{\textwidth}{1pt}\par
- \begingroup % for PDF information dictionary
- \def\endgraf{ }\def\and{\& }%
- \pdfstringdefDisableCommands{\def\\{, }}% overwrite hyperref setup
- \hypersetup{pdfauthor={\@author}, pdftitle={\@title}}%
+ \noindent\rule{\textwidth}{1pt}\ifsphinxpdfoutput\newline\null\fi\par
+ \ifsphinxpdfoutput
+ \begingroup
+ % These \defs are required to deal with multi-line authors; it
+ % changes \\ to ', ' (comma-space), making it pass muster for
+ % generating document info in the PDF file.
+ \def\\{, }%
+ \def\and{and }%
+ \pdfinfo{
+ /Author (\@author)
+ /Title (\@title)
+ }%
\endgroup
+ \fi
\begin{flushright}%
\sphinxlogo
\py@HeaderFamily
\setcounter{footnote}{0}%
\let\thanks\relax\let\maketitle\relax
%\gdef\@thanks{}\gdef\@author{}\gdef\@title{}
- \if@openright\cleardoublepage\else\clearpage\fi
- \spx@tempa
}
-\newcommand{\sphinxtableofcontents}{%
+\let\py@OldTableofcontents=\tableofcontents
+\renewcommand{\tableofcontents}{%
+ % before resetting page counter, let's do the right thing.
+ \if@openright\cleardoublepage\else\clearpage\fi
\pagenumbering{roman}%
\pagestyle{plain}%
\begingroup
\parskip \z@skip
- \tableofcontents
+ \py@OldTableofcontents
\endgroup
% before resetting page counter, let's do the right thing.
\if@openright\cleardoublepage\else\clearpage\fi
\pagenumbering{arabic}%
\ifdefined\fancyhf\pagestyle{normal}\fi
}
+\pagenumbering{alph}% avoid hyperref "duplicate destination" warnings
% This is needed to get the width of the section # area wide enough in the
% library reference. Doing it here keeps it the same for all the manuals.
% Fix the bibliography environment to add an entry to the Table of
% Contents.
% For a report document class this environment is a chapter.
-%
-\newenvironment{sphinxthebibliography}[1]{%
+\let\py@OldThebibliography=\thebibliography
+\renewcommand{\thebibliography}[1]{
\if@openright\cleardoublepage\else\clearpage\fi
- % \phantomsection % not needed here since TeXLive 2010's hyperref
- \begin{thebibliography}{1}%
- \addcontentsline{toc}{chapter}{\bibname}}{\end{thebibliography}}
+ \phantomsection
+ \py@OldThebibliography{1}
+ \addcontentsline{toc}{chapter}{\bibname}
+}
% Same for the indices.
% The memoir class already does this, so we don't duplicate it in that case.
%
-\@ifclassloaded{memoir}
- {\newenvironment{sphinxtheindex}{\begin{theindex}}{\end{theindex}}}
- {\newenvironment{sphinxtheindex}{%
+\@ifclassloaded{memoir}{}{
+ \let\py@OldTheindex=\theindex
+ \renewcommand{\theindex}{
\if@openright\cleardoublepage\else\clearpage\fi
- \phantomsection % needed as no chapter, section, ... created
- \begin{theindex}%
- \addcontentsline{toc}{chapter}{\indexname}}{\end{theindex}}}
+ \phantomsection
+ \py@OldTheindex
+ \addcontentsline{toc}{chapter}{\indexname}
+ }
+}
+++ /dev/null
-\NeedsTeXFormat{LaTeX2e}
-\ProvidesPackage{sphinxmulticell}%
- [2017/02/23 v1.6 better span rows and columns of a table (Sphinx team)]%
-\DeclareOption*{\PackageWarning{sphinxmulticell}{Option `\CurrentOption' is unknown}}%
-\ProcessOptions\relax
-%
-% --- MULTICOLUMN ---
-% standard LaTeX's \multicolumn
-% 1. does not allow verbatim contents,
-% 2. interacts very poorly with tabulary.
-%
-% It is needed to write own macros for Sphinx: to allow code-blocks in merged
-% cells rendered by tabular/longtable, and to allow multi-column cells with
-% paragraphs to be taken into account sanely by tabulary algorithm for column
-% widths.
-%
-% This requires quite a bit of hacking. First, in Sphinx, the multi-column
-% contents will *always* be wrapped in a varwidth environment. The issue
-% becomes to pass it the correct target width. We must trick tabulary into
-% believing the multicolumn is simply separate columns, else tabulary does not
-% incorporate the contents in its algorithm. But then we must clear the
-% vertical rules...
-%
-% configuration of tabulary
-\setlength{\tymin}{3\fontcharwd\font`0 }% minimal width of "squeezed" columns
-\setlength{\tymax}{10000pt}% allow enough room for paragraphs to "compete"
-% we need access to tabulary's final computed width. \@tempdima is too volatile
-% to hope it has kept tabulary's value when \sphinxcolwidth needs it.
-\newdimen\sphinx@TY@tablewidth
-\def\tabulary{%
- \def\TY@final{\sphinx@TY@tablewidth\@tempdima\tabular}%
- \let\endTY@final\endtabular
- \TY@tabular}%
-% next hack is needed only if user has set latex_use_latex_multicolumn to True:
-% it fixes tabulary's bug with \multicolumn defined "short" in first pass. (if
-% upstream tabulary adds a \long, our extra one causes no harm)
-\def\sphinx@tempa #1\def\multicolumn#2#3#4#5#6#7#8#9\sphinx@tempa
- {\def\TY@tab{#1\long\def\multicolumn####1####2####3{\multispan####1\relax}#9}}%
-\expandafter\sphinx@tempa\TY@tab\sphinx@tempa
-%
-% TN. 1: as \omit is never executed, Sphinx multicolumn does not need to worry
-% like standard multicolumn about |l| vs l|. On the other hand it assumes
-% columns are separated by a | ... (if not it will add extraneous
-% \arrayrulewidth space for each column separation in its estimate of available
-% width).
-%
-% TN. 1b: as Sphinx multicolumn uses neither \omit nor \span, it can not
-% (easily) get rid of extra macros from >{...} or <{...} between columns. At
-% least, it has been made compatible with colortbl's \columncolor.
-%
-% TN. 2: tabulary's second pass is handled like tabular/longtable's single
-% pass, with the difference that we hacked \TY@final to set in
-% \sphinx@TY@tablewidth the final target width as computed by tabulary. This is
-% needed only to handle columns with a "horizontal" specifier: "p" type columns
-% (inclusive of tabulary's LJRC) holds the target column width in the
-% \linewidth dimension.
-%
-% TN. 3: use of \begin{sphinxmulticolumn}...\end{sphinxmulticolumn} mark-up
-% would need some hacking around the fact that groups can not span across table
-% cells (the code does inserts & tokens, see TN1b). It was decided to keep it
-% simple with \sphinxstartmulticolumn...\sphinxstopmulticolumn.
-%
-% MEMO about nesting: if sphinxmulticolumn is encountered in a nested tabular
-% inside a tabulary it will think to be at top level in the tabulary. But
-% Sphinx generates no nested tables, and if some LaTeX macro uses internally a
-% tabular this will not have a \sphinxstartmulticolumn within it!
-%
-\def\sphinxstartmulticolumn{%
- \ifx\equation$% $ tabulary's first pass
- \expandafter\sphinx@TYI@start@multicolumn
- \else % either not tabulary or tabulary's second pass
- \expandafter\sphinx@start@multicolumn
- \fi
-}%
-\def\sphinxstopmulticolumn{%
- \ifx\equation$% $ tabulary's first pass
- \expandafter\sphinx@TYI@stop@multicolumn
- \else % either not tabulary or tabulary's second pass
- \ignorespaces
- \fi
-}%
-\def\sphinx@TYI@start@multicolumn#1{%
- % use \gdef always to avoid stack space build up
- \gdef\sphinx@tempa{#1}\begingroup\setbox\z@\hbox\bgroup
-}%
-\def\sphinx@TYI@stop@multicolumn{\egroup % varwidth was used with \tymax
- \xdef\sphinx@tempb{\the\dimexpr\wd\z@/\sphinx@tempa}% per column width
- \endgroup
- \expandafter\sphinx@TYI@multispan\expandafter{\sphinx@tempa}%
-}%
-\def\sphinx@TYI@multispan #1{%
- \kern\sphinx@tempb\ignorespaces % the per column occupied width
- \ifnum#1>\@ne % repeat, taking into account subtleties of TeX's & ...
- \expandafter\sphinx@TYI@multispan@next\expandafter{\the\numexpr#1-\@ne\expandafter}%
- \fi
-}%
-\def\sphinx@TYI@multispan@next{&\relax\sphinx@TYI@multispan}%
-%
-% Now the branch handling either the second pass of tabulary or the single pass
-% of tabular/longtable. This is the delicate part where we gather the
-% dimensions from the p columns either set-up by tabulary or by user p column
-% or Sphinx \X, \Y columns. The difficulty is that to get the said width, the
-% template must be inserted (other hacks would be horribly complicated except
-% if we rewrote crucial parts of LaTeX's \@array !) and we can not do
-% \omit\span like standard \multicolumn's easy approach. Thus we must cancel
-% the \vrule separators. Also, perhaps the column specifier is of the l, c, r
-% type, then we attempt an ad hoc rescue to give varwidth a reasonable target
-% width.
-\def\sphinx@start@multicolumn#1{%
- \gdef\sphinx@multiwidth{0pt}\gdef\sphinx@tempa{#1}\sphinx@multispan{#1}%
-}%
-\def\sphinx@multispan #1{%
- \ifnum#1=\@ne\expandafter\sphinx@multispan@end
- \else\expandafter\sphinx@multispan@next
- \fi {#1}%
-}%
-\def\sphinx@multispan@next #1{%
- % trick to recognize L, C, R, J or p, m, b type columns
- \ifdim\baselineskip>\z@
- \gdef\sphinx@tempb{\linewidth}%
- \else
- % if in an l, r, c type column, try and hope for the best
- \xdef\sphinx@tempb{\the\dimexpr(\ifx\TY@final\@undefined\linewidth\else
- \sphinx@TY@tablewidth\fi-\arrayrulewidth)/\sphinx@tempa
- -\tw@\tabcolsep-\arrayrulewidth\relax}%
- \fi
- \noindent\kern\sphinx@tempb\relax
- \xdef\sphinx@multiwidth
- {\the\dimexpr\sphinx@multiwidth+\sphinx@tempb+\tw@\tabcolsep+\arrayrulewidth}%
- % hack the \vline and the colortbl macros
- \sphinx@hack@vline\sphinx@hack@CT&\relax
- % repeat
- \expandafter\sphinx@multispan\expandafter{\the\numexpr#1-\@ne}%
-}%
-% packages like colortbl add group levels, we need to "climb back up" to be
-% able to hack the \vline and also the colortbl inserted tokens. This creates
-% empty space whether or not the columns were | separated:
-\def\sphinx@hack@vline{\ifnum\currentgrouptype=6\relax
- \kern\arrayrulewidth\arrayrulewidth\z@\else\aftergroup\sphinx@hack@vline\fi}%
-\def\sphinx@hack@CT{\ifnum\currentgrouptype=6\relax
- \let\CT@setup\sphinx@CT@setup\else\aftergroup\sphinx@hack@CT\fi}%
-% It turns out \CT@row@color is not expanded contrarily to \CT@column@color
-% during LaTeX+colortbl preamble preparation, hence it would be possible for
-% \sphinx@CT@setup to discard only the column color and choose to obey or not
-% row color and cell color. It would even be possible to propagate cell color
-% to row color for the duration of the Sphinx multicolumn... the (provisional?)
-% choice has been made to cancel the colortbl colours for the multicolumn
-% duration.
-\def\sphinx@CT@setup #1\endgroup{\endgroup}% hack to remove colour commands
-\def\sphinx@multispan@end#1{%
- % first, trace back our steps horizontally
- \noindent\kern-\dimexpr\sphinx@multiwidth\relax
- % and now we set the final computed width for the varwidth environment
- \ifdim\baselineskip>\z@
- \xdef\sphinx@multiwidth{\the\dimexpr\sphinx@multiwidth+\linewidth}%
- \else
- \xdef\sphinx@multiwidth{\the\dimexpr\sphinx@multiwidth+
- (\ifx\TY@final\@undefined\linewidth\else
- \sphinx@TY@tablewidth\fi-\arrayrulewidth)/\sphinx@tempa
- -\tw@\tabcolsep-\arrayrulewidth\relax}%
- \fi
- % we need to remove colour set-up also for last cell of the multi-column
- \aftergroup\sphinx@hack@CT
-}%
-\newcommand*\sphinxcolwidth[2]{%
- % this dimension will always be used for varwidth, and serves as maximum
- % width when cells are merged either via multirow or multicolumn or both,
- % as always their contents is wrapped in varwidth environment.
- \ifnum#1>\@ne % multi-column (and possibly also multi-row)
- % we wrote our own multicolumn code especially to handle that (and allow
- % verbatim contents)
- \ifx\equation$%$
- \tymax % first pass of tabulary (cf MEMO above regarding nesting)
- \else % the \@gobble thing is for compatibility with standard \multicolumn
- \sphinx@multiwidth\@gobble{#1/#2}%
- \fi
- \else % single column multirow
- \ifx\TY@final\@undefined % not a tabulary.
- \ifdim\baselineskip>\z@
- % in a p{..} type column, \linewidth is the target box width
- \linewidth
- \else
- % l, c, r columns. Do our best.
- \dimexpr(\linewidth-\arrayrulewidth)/#2-
- \tw@\tabcolsep-\arrayrulewidth\relax
- \fi
- \else % in tabulary
- \ifx\equation$%$% first pass
- \tymax % it is set to a big value so that paragraphs can express themselves
- \else
- % second pass.
- \ifdim\baselineskip>\z@
- \linewidth % in a L, R, C, J column or a p, \X, \Y ...
- \else
- % we have hacked \TY@final to put in \sphinx@TY@tablewidth the table width
- \dimexpr(\sphinx@TY@tablewidth-\arrayrulewidth)/#2-
- \tw@\tabcolsep-\arrayrulewidth\relax
- \fi
- \fi
- \fi
- \fi
-}%
-% fallback default in case user has set latex_use_latex_multicolumn to True:
-% \sphinxcolwidth will use this only inside LaTeX's standard \multicolumn
-\def\sphinx@multiwidth #1#2{\dimexpr % #1 to gobble the \@gobble (!)
- (\ifx\TY@final\@undefined\linewidth\else\sphinx@TY@tablewidth\fi
- -\arrayrulewidth)*#2-\tw@\tabcolsep-\arrayrulewidth\relax}%
-%
-% --- MULTIROW ---
-% standard \multirow
-% 1. does not allow verbatim contents,
-% 2. does not allow blank lines in its argument,
-% 3. its * specifier means to typeset "horizontally" which is very
-% bad for paragraph content. 2016 version has = specifier but it
-% must be used with p type columns only, else results are bad,
-% 4. it requires manual intervention if the contents is too long to fit
-% in the asked-for number of rows.
-% 5. colour panels (either from \rowcolor or \columncolor) will hide
-% the bottom part of multirow text, hence manual tuning is needed
-% to put the multirow insertion at the _bottom_.
-%
-% The Sphinx solution consists in always having contents wrapped
-% in a varwidth environment so that it makes sense to estimate how many
-% lines it will occupy, and then ensure by insertion of suitable struts
-% that the table rows have the needed height. The needed mark-up is done
-% by LaTeX writer, which has its own id for the merged cells.
-%
-% The colour issue is solved by clearing colour panels in all cells,
-% whether or not the multirow is single-column or multi-column.
-%
-% In passing we obtain baseline alignements across rows (only if
-% \arraylinestretch is 1, as LaTeX's does not obey \arraylinestretch in "p"
-% multi-line contents, only first and last line...)
-%
-% TODO: examine the situation with \arraylinestretch > 1. The \extrarowheight
-% is hopeless for multirow anyhow, it makes baseline alignment strictly
-% impossible.
-\newcommand\sphinxmultirow[2]{\begingroup
- % #1 = nb of spanned rows, #2 = Sphinx id of "cell", #3 = contents
- % but let's fetch #3 in a way allowing verbatim contents !
- \def\sphinx@nbofrows{#1}\def\sphinx@cellid{#2}%
- \afterassignment\sphinx@multirow\let\next=
-}%
-\def\sphinx@multirow {%
- \setbox\z@\hbox\bgroup\aftergroup\sphinx@@multirow\strut
-}%
-\def\sphinx@@multirow {%
- % The contents, which is a varwidth environment, has been captured in
- % \box0 (a \hbox).
- % We have with \sphinx@cellid an assigned unique id. The goal is to give
- % about the same height to all the involved rows.
- % For this Sphinx will insert a \sphinxtablestrut{cell_id} mark-up
- % in LaTeX file and the expansion of the latter will do the suitable thing.
- \dimen@\dp\z@
- \dimen\tw@\ht\@arstrutbox
- \advance\dimen@\dimen\tw@
- \advance\dimen\tw@\dp\@arstrutbox
- \count@=\dimen@ % type conversion dim -> int
- \count\tw@=\dimen\tw@
- \divide\count@\count\tw@ % TeX division truncates
- \advance\dimen@-\count@\dimen\tw@
- % 1300sp is about 0.02pt. For comparison a rule default width is 0.4pt.
- % (note that if \count@ holds 0, surely \dimen@>1300sp)
- \ifdim\dimen@>1300sp \advance\count@\@ne \fi
- % now \count@ holds the count L of needed "lines"
- % and \sphinx@nbofrows holds the number N of rows
- % we have L >= 1 and N >= 1
- % if L is a multiple of N, ... clear what to do !
- % else write L = qN + r, 1 <= r < N and we will
- % arrange for each row to have enough space for:
- % q+1 "lines" in each of the first r rows
- % q "lines" in each of the (N-r) bottom rows
- % for a total of (q+1) * r + q * (N-r) = q * N + r = L
- % It is possible that q == 0.
- \count\tw@\count@
- % the TeX division truncates
- \divide\count\tw@\sphinx@nbofrows\relax
- \count4\count\tw@ % q
- \multiply\count\tw@\sphinx@nbofrows\relax
- \advance\count@-\count\tw@ % r
- \expandafter\xdef\csname sphinx@tablestrut_\sphinx@cellid\endcsname
- {\noexpand\sphinx@tablestrut{\the\count4}{\the\count@}{\sphinx@cellid}}%
- \dp\z@\z@
- % this will use the real height if it is >\ht\@arstrutbox
- \sphinxtablestrut{\sphinx@cellid}\box\z@
- \endgroup % group was opened in \sphinxmultirow
-}%
-\newcommand*\sphinxtablestrut[1]{%
- % #1 is a "cell_id", i.e. the id of a merged group of table cells
- \csname sphinx@tablestrut_#1\endcsname
-}%
-% LaTeX typesets the table row by row, hence each execution can do
-% an update for the next row.
-\newcommand*\sphinx@tablestrut[3]{\begingroup
- % #1 = q, #2 = (initially) r, #3 = cell_id, q+1 lines in first r rows
- % if #2 = 0, create space for max(q,1) table lines
- % if #2 > 0, create space for q+1 lines and decrement #2
- \leavevmode
- \count@#1\relax
- \ifnum#2=\z@
- \ifnum\count@=\z@\count@\@ne\fi
- \else
- % next row will be with a #2 decremented by one
- \expandafter\xdef\csname sphinx@tablestrut_#3\endcsname
- {\noexpand\sphinx@tablestrut{#1}{\the\numexpr#2-\@ne}{#3}}%
- \advance\count@\@ne
- \fi
- \vrule\@height\ht\@arstrutbox
- \@depth\dimexpr\count@\ht\@arstrutbox+\count@\dp\@arstrutbox-\ht\@arstrutbox\relax
- \@width\z@
- \endgroup
- % we need this to avoid colour panels hiding bottom parts of multirow text
- \sphinx@hack@CT
-}%
-\endinput
-%%
-%% End of file `sphinxmulticell.sty'.
--- /dev/null
+%%
+%% This is file `tabulary.sty',
+%% generated with the docstrip utility.
+%%
+%% The original source files were:
+%%
+%% tabulary.dtx (with options: `package')
+%% DRAFT VERSION
+%%
+%% File `tabulary.dtx'.
+%% Copyright (C) 1995 1996 2003 2008 David Carlisle
+%% This file may be distributed under the terms of the LPPL.
+%% See 00readme.txt for details.
+%%
+\NeedsTeXFormat{LaTeX2e}
+\ProvidesPackage{tabulary}
+ [2008/12/01 v0.9 tabulary package (DPC)]
+\RequirePackage{array}
+\catcode`\Z=14
+\DeclareOption{debugshow}{\catcode`\Z=9\relax}
+\ProcessOptions
+\def\arraybackslash{\let\\=\@arraycr}
+\def\@finalstrut#1{%
+ \unskip\ifhmode\nobreak\fi\vrule\@width\z@\@height\z@\@depth\dp#1}
+\newcount\TY@count
+\def\tabulary{%
+ \let\TY@final\tabular
+ \let\endTY@final\endtabular
+ \TY@tabular}
+\def\TY@tabular#1{%
+ \edef\TY@{\@currenvir}%
+ {\ifnum0=`}\fi
+ \@ovxx\TY@linewidth
+ \@ovyy\TY@tablewidth
+ \count@\z@
+ \@tempswatrue
+ \@whilesw\if@tempswa\fi{%
+ \advance\count@\@ne
+ \expandafter\ifx\csname TY@F\the\count@\endcsname\relax
+ \@tempswafalse
+ \else
+ \expandafter\let\csname TY@SF\the\count@\expandafter\endcsname
+ \csname TY@F\the\count@\endcsname
+ \global\expandafter\let\csname TY@F\the\count@\endcsname\relax
+ \expandafter\let\csname TY@S\the\count@\expandafter\endcsname
+ \csname TY@\the\count@\endcsname
+ \fi}%
+ \global\TY@count\@ne
+ \TY@width\xdef{0pt}%
+ \global\TY@tablewidth\z@
+ \global\TY@linewidth#1\relax
+Z\message{^^J^^JTable^^J%
+Z Target Width: \the\TY@linewidth^^J%
+Z \string\tabcolsep: \the\tabcolsep\space
+Z \string\arrayrulewidth: \the\arrayrulewidth\space
+Z \string\doublerulesep: \the\doublerulesep^^J%
+Z \string\tymin: \the\tymin\space
+Z \string\tymax: \the\tymax^^J}%
+ \let\@classz\TY@classz
+ \let\verb\TX@verb
+ \toks@{}\TY@get@body}
+\let\TY@@mkpream\@mkpream
+\def\TY@mkpream{%
+ \def\@addamp{%
+ \if@firstamp \@firstampfalse \else
+ \global\advance\TY@count\@ne
+ \edef\@preamble{\@preamble &}\fi
+ \TY@width\xdef{0pt}}%
+ \def\@acol{%
+ \TY@subwidth\col@sep
+ \@addtopreamble{\hskip\col@sep}}%
+ \let\@arrayrule\TY@arrayrule
+ \let\@classvi\TY@classvi
+ \def\@classv{\save@decl
+ \expandafter\NC@ecs\@nextchar\extracolsep{}\extracolsep\@@@
+ \sbox\z@{\d@llarbegin\@nextchar\d@llarend}%
+ \TY@subwidth{\wd\z@}%
+ \@addtopreamble{\d@llarbegin\the@toks\the\count@\relax\d@llarend}%
+ \prepnext@tok}%
+ \global\let\@mkpream\TY@@mkpream
+ \TY@@mkpream}
+\def\TY@arrayrule{%
+ \TY@subwidth\arrayrulewidth
+ \@addtopreamble \vline}
+\def\TY@classvi{\ifcase \@lastchclass
+ \@acol \or
+ \TY@subwidth\doublerulesep
+ \@addtopreamble{\hskip \doublerulesep}\or
+ \@acol \or
+ \@classvii
+ \fi}
+\def\TY@tab{%
+ \setbox\z@\hbox\bgroup
+ \let\[$\let\]$%
+ \let\equation$\let\endequation$%
+ \col@sep\tabcolsep
+ \let\d@llarbegin\begingroup\let\d@llarend\endgroup
+ \let\@mkpream\TY@mkpream
+ \def\multicolumn##1##2##3{\multispan##1\relax}%
+ \CT@start\TY@tabarray}
+\def\TY@tabarray{\@ifnextchar[{\TY@array}{\@array[t]}}
+\def\TY@array[#1]{\@array[t]}
+\def\TY@width#1{%
+ \expandafter#1\csname TY@\the\TY@count\endcsname}
+\def\TY@subwidth#1{%
+ \TY@width\dimen@
+ \advance\dimen@-#1\relax
+ \TY@width\xdef{\the\dimen@}%
+ \global\advance\TY@linewidth-#1\relax}
+\def\endtabulary{%
+ \gdef\@halignto{}%
+ \let\TY@footnote\footnote%
+ \def\footnote{}% prevent footnotes from doing anything
+ \expandafter\TY@tab\the\toks@
+ \crcr\omit
+ {\xdef\TY@save@row{}%
+ \loop
+ \advance\TY@count\m@ne
+ \ifnum\TY@count>\z@
+ \xdef\TY@save@row{\TY@save@row&\omit}%
+ \repeat}\TY@save@row
+ \endarray\global\setbox1=\lastbox\setbox0=\vbox{\unvbox1
+ \unskip\global\setbox1=\lastbox}\egroup
+ \dimen@\TY@linewidth
+ \divide\dimen@\TY@count
+ \ifdim\dimen@<\tymin
+ \TY@warn{tymin too large (\the\tymin), resetting to \the\dimen@}%
+ \tymin\dimen@
+ \fi
+ \setbox\tw@=\hbox{\unhbox\@ne
+ \loop
+\@tempdima=\lastskip
+\ifdim\@tempdima>\z@
+Z \message{ecs=\the\@tempdima^^J}%
+ \global\advance\TY@linewidth-\@tempdima
+\fi
+ \unskip
+ \setbox\tw@=\lastbox
+ \ifhbox\tw@
+Z \message{Col \the\TY@count: Initial=\the\wd\tw@\space}%
+ \ifdim\wd\tw@>\tymax
+ \wd\tw@\tymax
+Z \message{> max\space}%
+Z \else
+Z \message{ \@spaces\space}%
+ \fi
+ \TY@width\dimen@
+Z \message{\the\dimen@\space}%
+ \advance\dimen@\wd\tw@
+Z \message{Final=\the\dimen@\space}%
+ \TY@width\xdef{\the\dimen@}%
+ \ifdim\dimen@<\tymin
+Z \message{< tymin}%
+ \global\advance\TY@linewidth-\dimen@
+ \expandafter\xdef\csname TY@F\the\TY@count\endcsname
+ {\the\dimen@}%
+ \else
+ \expandafter\ifx\csname TY@F\the\TY@count\endcsname\z@
+Z \message{***}%
+ \global\advance\TY@linewidth-\dimen@
+ \expandafter\xdef\csname TY@F\the\TY@count\endcsname
+ {\the\dimen@}%
+ \else
+Z \message{> tymin}%
+ \global\advance\TY@tablewidth\dimen@
+ \global\expandafter\let\csname TY@F\the\TY@count\endcsname
+ \maxdimen
+ \fi\fi
+ \advance\TY@count\m@ne
+ \repeat}%
+ \TY@checkmin
+ \TY@checkmin
+ \TY@checkmin
+ \TY@checkmin
+ \TY@count\z@
+ \let\TY@box\TY@box@v
+ \let\footnote\TY@footnote % restore footnotes
+ {\expandafter\TY@final\the\toks@\endTY@final}%
+ \count@\z@
+ \@tempswatrue
+ \@whilesw\if@tempswa\fi{%
+ \advance\count@\@ne
+ \expandafter\ifx\csname TY@SF\the\count@\endcsname\relax
+ \@tempswafalse
+ \else
+ \global\expandafter\let\csname TY@F\the\count@\expandafter\endcsname
+ \csname TY@SF\the\count@\endcsname
+ \global\expandafter\let\csname TY@\the\count@\expandafter\endcsname
+ \csname TY@S\the\count@\endcsname
+ \fi}%
+ \TY@linewidth\@ovxx
+ \TY@tablewidth\@ovyy
+ \ifnum0=`{\fi}}
+\def\TY@checkmin{%
+ \let\TY@checkmin\relax
+\ifdim\TY@tablewidth>\z@
+ \Gscale@div\TY@ratio\TY@linewidth\TY@tablewidth
+ \ifdim\TY@tablewidth <\TY@linewidth
+ \def\TY@ratio{1}%
+ \fi
+\else
+ \TY@warn{No suitable columns!}%
+ \def\TY@ratio{1}%
+\fi
+\count@\z@
+Z \message{^^JLine Width: \the\TY@linewidth,
+Z Natural Width: \the\TY@tablewidth,
+Z Ratio: \TY@ratio^^J}%
+\@tempdima\z@
+\loop
+\ifnum\count@<\TY@count
+\advance\count@\@ne
+ \ifdim\csname TY@F\the\count@\endcsname>\tymin
+ \dimen@\csname TY@\the\count@\endcsname
+ \dimen@\TY@ratio\dimen@
+ \ifdim\dimen@<\tymin
+Z \message{Column \the\count@\space ->}%
+ \global\expandafter\let\csname TY@F\the\count@\endcsname\tymin
+ \global\advance\TY@linewidth-\tymin
+ \global\advance\TY@tablewidth-\csname TY@\the\count@\endcsname
+ \let\TY@checkmin\TY@@checkmin
+ \else
+ \expandafter\xdef\csname TY@F\the\count@\endcsname{\the\dimen@}%
+ \advance\@tempdima\csname TY@F\the\count@\endcsname
+ \fi
+ \fi
+Z \dimen@\csname TY@F\the\count@\endcsname\message{\the\dimen@, }%
+\repeat
+Z \message{^^JTotal:\the\@tempdima^^J}%
+}
+\let\TY@@checkmin\TY@checkmin
+\newdimen\TY@linewidth
+\def\tyformat{\everypar{{\nobreak\hskip\z@skip}}}
+\newdimen\tymin
+\tymin=10pt
+\newdimen\tymax
+\tymax=2\textwidth
+\def\@testpach{\@chclass
+ \ifnum \@lastchclass=6 \@ne \@chnum \@ne \else
+ \ifnum \@lastchclass=7 5 \else
+ \ifnum \@lastchclass=8 \tw@ \else
+ \ifnum \@lastchclass=9 \thr@@
+ \else \z@
+ \ifnum \@lastchclass = 10 \else
+ \edef\@nextchar{\expandafter\string\@nextchar}%
+ \@chnum
+ \if \@nextchar c\z@ \else
+ \if \@nextchar l\@ne \else
+ \if \@nextchar r\tw@ \else
+ \if \@nextchar C7 \else
+ \if \@nextchar L8 \else
+ \if \@nextchar R9 \else
+ \if \@nextchar J10 \else
+ \z@ \@chclass
+ \if\@nextchar |\@ne \else
+ \if \@nextchar !6 \else
+ \if \@nextchar @7 \else
+ \if \@nextchar <8 \else
+ \if \@nextchar >9 \else
+ 10
+ \@chnum
+ \if \@nextchar m\thr@@\else
+ \if \@nextchar p4 \else
+ \if \@nextchar b5 \else
+ \z@ \@chclass \z@ \@preamerr \z@ \fi \fi \fi \fi\fi \fi \fi\fi \fi
+ \fi \fi \fi \fi \fi \fi \fi \fi \fi \fi \fi}
+\def\TY@classz{%
+ \@classx
+ \@tempcnta\count@
+ \ifx\TY@box\TY@box@v
+ \global\advance\TY@count\@ne
+ \fi
+ \let\centering c%
+ \let\raggedright\noindent
+ \let\raggedleft\indent
+ \let\arraybackslash\relax
+ \prepnext@tok
+ \ifnum\@chnum<4
+ \global\expandafter\let\csname TY@F\the\TY@count\endcsname\z@
+ \fi
+ \ifnum\@chnum=6
+ \global\expandafter\let\csname TY@F\the\TY@count\endcsname\z@
+ \fi
+ \@addtopreamble{%
+ \ifcase\@chnum
+ \hfil \d@llarbegin\insert@column\d@llarend \hfil \or
+ \kern\z@
+ \d@llarbegin \insert@column \d@llarend \hfil \or
+ \hfil\kern\z@ \d@llarbegin \insert@column \d@llarend \or
+ $\vcenter\@startpbox{\@nextchar}\insert@column \@endpbox $\or
+ \vtop \@startpbox{\@nextchar}\insert@column \@endpbox \or
+ \vbox \@startpbox{\@nextchar}\insert@column \@endpbox \or
+ \d@llarbegin \insert@column \d@llarend \or% dubious "s" case
+ \TY@box\centering\or
+ \TY@box\raggedright\or
+ \TY@box\raggedleft\or
+ \TY@box\relax
+ \fi}\prepnext@tok}
+\def\TY@box#1{%
+ \ifx\centering#1%
+ \hfil \d@llarbegin\insert@column\d@llarend \hfil \else
+ \ifx\raggedright#1%
+ \kern\z@%<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
+ \d@llarbegin \insert@column \d@llarend \hfil \else
+ \ifx\raggedleft#1%
+ \hfil\kern\z@ \d@llarbegin \insert@column \d@llarend \else
+ \ifx\relax#1%
+ \d@llarbegin \insert@column \d@llarend
+ \fi \fi \fi \fi}
+\def\TY@box@v#1{%
+ \vtop \@startpbox{\csname TY@F\the\TY@count\endcsname}%
+ #1\arraybackslash\tyformat
+ \insert@column\@endpbox}
+\newdimen\TY@tablewidth
+\def\Gscale@div#1#2#3{%
+ \setlength\dimen@{#3}%
+ \ifdim\dimen@=\z@
+ \PackageError{graphics}{Division by 0}\@eha
+ \dimen@#2%
+ \fi
+ \edef\@tempd{\the\dimen@}%
+ \setlength\dimen@{#2}%
+ \count@65536\relax
+ \ifdim\dimen@<\z@
+ \dimen@-\dimen@
+ \count@-\count@
+ \fi
+ \loop
+ \ifdim\dimen@<8192\p@
+ \dimen@\tw@\dimen@
+ \divide\count@\tw@
+ \repeat
+ \dimen@ii=\@tempd\relax
+ \divide\dimen@ii\count@
+ \divide\dimen@\dimen@ii
+ \edef#1{\strip@pt\dimen@}}
+\long\def\TY@get@body#1\end
+ {\toks@\expandafter{\the\toks@#1}\TY@find@end}
+\def\TY@find@end#1{%
+ \def\@tempa{#1}%
+ \ifx\@tempa\TY@\def\@tempa{\end{#1}}\expandafter\@tempa
+ \else\toks@\expandafter
+ {\the\toks@\end{#1}}\expandafter\TY@get@body\fi}
+\def\TY@warn{%
+ \PackageWarning{tabulary}}
+\catcode`\Z=11
+\AtBeginDocument{
+\@ifpackageloaded{colortbl}{%
+\expandafter\def\expandafter\@mkpream\expandafter#\expandafter1%
+ \expandafter{%
+ \expandafter\let\expandafter\CT@setup\expandafter\relax
+ \expandafter\let\expandafter\CT@color\expandafter\relax
+ \expandafter\let\expandafter\CT@do@color\expandafter\relax
+ \expandafter\let\expandafter\color\expandafter\relax
+ \expandafter\let\expandafter\CT@column@color\expandafter\relax
+ \expandafter\let\expandafter\CT@row@color\expandafter\relax
+ \@mkpream{#1}}
+\let\TY@@mkpream\@mkpream
+\def\TY@classz{%
+ \@classx
+ \@tempcnta\count@
+ \ifx\TY@box\TY@box@v
+ \global\advance\TY@count\@ne
+ \fi
+ \let\centering c%
+ \let\raggedright\noindent
+ \let\raggedleft\indent
+ \let\arraybackslash\relax
+ \prepnext@tok
+\expandafter\CT@extract\the\toks\@tempcnta\columncolor!\@nil
+ \ifnum\@chnum<4
+ \global\expandafter\let\csname TY@F\the\TY@count\endcsname\z@
+ \fi
+ \ifnum\@chnum=6
+ \global\expandafter\let\csname TY@F\the\TY@count\endcsname\z@
+ \fi
+ \@addtopreamble{%
+ \setbox\z@\hbox\bgroup\bgroup
+ \ifcase\@chnum
+ \hskip\stretch{.5}\kern\z@
+ \d@llarbegin\insert@column\d@llarend\hskip\stretch{.5}\or
+ \kern\z@%<<<<<<<<<<<<<<<<<<<<<<<<<<<
+ \d@llarbegin \insert@column \d@llarend \hfill \or
+ \hfill\kern\z@ \d@llarbegin \insert@column \d@llarend \or
+ $\vcenter\@startpbox{\@nextchar}\insert@column \@endpbox $\or
+ \vtop \@startpbox{\@nextchar}\insert@column \@endpbox \or
+ \vbox \@startpbox{\@nextchar}\insert@column \@endpbox \or
+ \d@llarbegin \insert@column \d@llarend \or% dubious s case
+ \TY@box\centering\or
+ \TY@box\raggedright\or
+ \TY@box\raggedleft\or
+ \TY@box\relax
+ \fi
+ \egroup\egroup
+\begingroup
+ \CT@setup
+ \CT@column@color
+ \CT@row@color
+ \CT@do@color
+\endgroup
+ \@tempdima\ht\z@
+ \advance\@tempdima\minrowclearance
+ \vrule\@height\@tempdima\@width\z@
+\unhbox\z@
+}\prepnext@tok}%
+ \def\TY@arrayrule{%
+ \TY@subwidth\arrayrulewidth
+ \@addtopreamble{{\CT@arc@\vline}}}%
+ \def\TY@classvi{\ifcase \@lastchclass
+ \@acol \or
+ \TY@subwidth\doublerulesep
+ \ifx\CT@drsc@\relax
+ \@addtopreamble{\hskip\doublerulesep}%
+ \else
+ \@addtopreamble{{\CT@drsc@\vrule\@width\doublerulesep}}%
+ \fi\or
+ \@acol \or
+ \@classvii
+ \fi}%
+}{%
+\let\CT@start\relax
+}
+}
+{\uccode`\*=`\ %
+\uppercase{\gdef\TX@verb{%
+ \leavevmode\null\TX@vwarn
+ {\ifnum0=`}\fi\ttfamily\let\\\ignorespaces
+ \@ifstar{\let~*\TX@vb}{\TX@vb}}}}
+\def\TX@vb#1{\def\@tempa##1#1{\toks@{##1}\edef\@tempa{\the\toks@}%
+ \expandafter\TX@v\meaning\@tempa\\ \\\ifnum0=`{\fi}}\@tempa!}
+\def\TX@v#1!{\afterassignment\TX@vfirst\let\@tempa= }
+\begingroup
+\catcode`\*=\catcode`\#
+\catcode`\#=12
+\gdef\TX@vfirst{%
+ \if\@tempa#%
+ \def\@tempb{\TX@v@#}%
+ \else
+ \let\@tempb\TX@v@
+ \if\@tempa\space~\else\@tempa\fi
+ \fi
+ \@tempb}
+\gdef\TX@v@*1 *2{%
+ \TX@v@hash*1##\relax\if*2\\\else~\expandafter\TX@v@\fi*2}
+\gdef\TX@v@hash*1##*2{*1\ifx*2\relax\else#\expandafter\TX@v@hash\fi*2}
+\endgroup
+\def\TX@vwarn{%
+ \@warning{\noexpand\verb may be unreliable inside tabularx/y}%
+ \global\let\TX@vwarn\@empty}
+\endinput
+%%
+%% End of file `tabulary.sty'.
automatically clean the message of color tags '<red> ...
if the terminal output stdout is redirected by user
if not, replace tags with ansi color codes
+
example:
- >> sat compile SALOME > log.txt
+ >> sat compile SALOME > log.txt
"""
if not ('isatty' in dir(sys.stdout) and sys.stdout.isatty()):
# clean the message color (if the terminal is redirected by user)
"""Performs a build with a script."""
# script found
self.logger.info(_("Compile %s using script %s\n") % \
- (self.product_info.name, UTS.label(script) )
+ (self.product_info.name, UTS.label(script)) )
try:
import imp
product = self.product_info.name
self.datadir = None
def _create_vars(self, application=None, command=None, datadir=None):
- """Create a dictionary that stores all information about machine,
- user, date, repositories, etc...
+ """\
+ Create a dictionary that stores all information about machine,
+ user, date, repositories, etc...
:param application str: The application for which salomeTools is called.
:param command str: The command that is called.
- :param datadir str: The repository that contain external data
- for salomeTools.
+ :param datadir str: The repository that contain external data for salomeTools.
:return: The dictionary that stores all information.
:rtype: dict
"""
def get_config(self, application=None, options=None, command=None,
datadir=None):
- '''get the config from all the configuration files.
+ """\
+ get the config from all the configuration files.
:param application str: The application for which salomeTools is called.
- :param options class Options: The general salomeTools
- options (--overwrite or -v5, for example)
+ :param options class Options: The general salomeTools options (--overwrite or -v5, for example)
:param command str: The command that is called.
- :param datadir str: The repository that contain
- external data for salomeTools.
+ :param datadir str: The repository that contain external data for salomeTools.
:return: The final config.
:rtype: class 'PYCONF.Config'
- '''
-
+ """
+ msgPb = _("Problem in configuration file: <red>%s\n<yellow>%s<reset>\n") # % (filename, exception)
# create a ConfigMerger to handle merge
merger = PYCONF.ConfigMerger() #MergeHandler())
# =====================================================================
# Load INTERNAL config
# read src/internal_config/salomeTools.pyconf
- PYCONF.streamOpener = ConfigOpener([
- os.path.join(cfg.VARS.srcDir, 'internal_config')])
+ intDir = os.path.join(cfg.VARS.srcDir, 'internal_config')
+ PYCONF.streamOpener = ConfigOpener([intDir])
try:
- internal_cfg = PYCONF.Config(open(os.path.join(cfg.VARS.srcDir,
- 'internal_config', 'salomeTools.pyconf')))
- except PYCONF.ConfigError as e:
- raise Exception(_("Error in configuration file:"
- " salomeTools.pyconf\n %(error)s") % \
- {'error': str(e) })
+ afile = os.path.join(intDir, 'salomeTools.pyconf')
+ with open(afile) as f:
+ internal_cfg = PYCONF.Config(f)
+ except Exception as e:
+ raise Exception(msgPb % (afile, str(e)))
merger.merge(cfg, internal_cfg)
# search only in the data directory
PYCONF.streamOpener = ConfigOpener([cfg.VARS.datadir])
try:
- local_cfg = PYCONF.Config(open(os.path.join(cfg.VARS.datadir,
- 'local.pyconf')),
- PWD = ('LOCAL', cfg.VARS.datadir) )
- except PYCONF.ConfigError as e:
- raise Exception(_("Error in configuration file: "
- "local.pyconf\n %(error)s") % \
- {'error': str(e) })
- except IOError as error:
- e = str(error)
- raise Exception( e );
+ aFile = os.path.join(cfg.VARS.datadir, 'local.pyconf')
+ with open(aFile) as f:
+ local_cfg = PYCONF.Config(f, PWD = ('LOCAL', cfg.VARS.datadir) )
+ except Exception as e:
+ raise Exception(msgPb % (aFile, str(e)))
+
merger.merge(cfg, local_cfg)
# When the key is "default", put the default value
+ sWay = cfg.VARS.salometoolsway
if cfg.LOCAL.base == "default":
- cfg.LOCAL.base = os.path.abspath(
- os.path.join(cfg.VARS.salometoolsway,
- "..",
- "BASE"))
+ cfg.LOCAL.base = os.path.abspath(os.path.join(sWay, "..", "BASE"))
if cfg.LOCAL.workdir == "default":
- cfg.LOCAL.workdir = os.path.abspath(
- os.path.join(cfg.VARS.salometoolsway,
- ".."))
+ cfg.LOCAL.workdir = os.path.abspath(os.path.join(sWay, ".."))
if cfg.LOCAL.log_dir == "default":
- cfg.LOCAL.log_dir = os.path.abspath(
- os.path.join(cfg.VARS.salometoolsway,
- "..",
- "LOGS"))
-
+ cfg.LOCAL.log_dir = os.path.abspath(os.path.join(sWay, "..", "LOGS"))
if cfg.LOCAL.archive_dir == "default":
- cfg.LOCAL.archive_dir = os.path.abspath(
- os.path.join(cfg.VARS.salometoolsway,
- "..",
- "ARCHIVES"))
+ cfg.LOCAL.archive_dir = os.path.abspath(os.path.join(sWay, "..", "ARCHIVES"))
# apply overwrite from command line if needed
for rule in self.get_command_line_overrides(options, ["LOCAL"]):
# =====================================================================
# Load the PROJECTS
projects_cfg = PYCONF.Config()
- projects_cfg.addMapping("PROJECTS",
- PYCONF.Mapping(projects_cfg),
- "The projects\n")
- projects_cfg.PROJECTS.addMapping("projects",
- PYCONF.Mapping(cfg.PROJECTS),
- "The projects definition\n")
+ projects_cfg.addMapping("PROJECTS", PYCONF.Mapping(projects_cfg), "The projects\n")
+ projects_cfg.PROJECTS.addMapping("projects", PYCONF.Mapping(cfg.PROJECTS), "The projects definition\n")
for project_pyconf_path in cfg.PROJECTS.project_file_paths:
if not os.path.exists(project_pyconf_path):
- msg = _("Cannot find project file <red>%s<reset>, Ignored.") % project_pyconf_path
+ msg = _("Cannot find project file %s, Ignored.") % UTS.red(project_pyconf_path)
self.logger.warning(msg)
continue
project_name = os.path.basename(project_pyconf_path)[:-len(".pyconf")]
try:
- project_pyconf_dir = os.path.dirname(project_pyconf_path)
- project_cfg = PYCONF.Config(open(project_pyconf_path),
- PWD=("", project_pyconf_dir))
+ project_pyconf_dir = os.path.dirname(project_pyconf_path)
+ with open(project_pyconf_path) as f:
+ project_cfg = PYCONF.Config(f, PWD=("", project_pyconf_dir))
except Exception as e:
- msg = _("ERROR: Error in configuration file: %(file_path)s\n %(error)s\n") % \
- {'file_path' : project_pyconf_path, 'error': str(e) }
- sys.stdout.write(msg)
- continue
- projects_cfg.PROJECTS.projects.addMapping(project_name,
- PYCONF.Mapping(projects_cfg.PROJECTS.projects),
- "The %s project\n" % project_name)
- projects_cfg.PROJECTS.projects[project_name]=project_cfg
- projects_cfg.PROJECTS.projects[project_name]["file_path"] = \
- project_pyconf_path
+ self.logger.warning(msgPb % (project_pyconf_path, str(e)))
+ continue
+ PROJECTS = projects_cfg.PROJECTS
+ PROJECTS.projects.addMapping(project_name,
+ PYCONF.Mapping(PROJECTS.projects),
+ "The %s project\n" % project_name)
+ PROJECTS.projects[project_name] = project_cfg
+ PROJECTS.projects[project_name]["file_path"] = project_pyconf_path
merger.merge(cfg, projects_cfg)
cp = cfg.PATHS.APPLICATIONPATH
PYCONF.streamOpener = ConfigOpener(cp)
do_merge = True
+ aFile = application + '.pyconf'
try:
- application_cfg = PYCONF.Config(application + '.pyconf')
+ application_cfg = PYCONF.Config(aFile)
except IOError as e:
- raise Exception(_("%s\n(use 'config --list' to get the"
- " list of available applications)") % e)
+ msg = msgPb % (aFile, str(e))
+ msg += "\n" + _("(use 'sat config --list' to get the list of available applications)")
+ raise Exception(msg)
except PYCONF.ConfigError as e:
- if (not ('-e' in parser.parse_args()[1])
- or ('--edit' in parser.parse_args()[1])
- and command == 'config'):
- raise Exception(
- _("Error in configuration file: (1)s.pyconf\n %(2)s") % \
- { 'application': application, 'error': str(e) } )
- else:
- sys.stdout.write(UTS.red(
- "There is an error in the file %s.pyconf.\n" % \
- cfg.VARS.application))
- do_merge = False
+ msg = msgPb % (aFile, str(e))
+ if (not ('-e' in parser.parse_args()[1])
+ or ('--edit' in parser.parse_args()[1])
+ and command == 'config'):
+ raise Exception(msg)
+ else:
+ self.warning(msg)
+ do_merge = False
except Exception as e:
- if ( not('-e' in parser.parse_args()[1]) or
- ('--edit' in parser.parse_args()[1]) and
- command == 'config' ):
- sys.stdout.write(UTS.red("%s\n" % str(e)))
- raise Exception(
- _("Error in configuration file: %s.pyconf\n") % application )
- else:
- sys.stdout.write(UTS.red(
- "ERROR: in file %s.pyconf. Opening the file with the default viewer\n" % \
- cfg.VARS.application))
- sys.stdout.write("\n%s\n" % UTS.red(str(e)))
- do_merge = False
+ msg = msgPb % (aFile, str(e))
+ if (not('-e' in parser.parse_args()[1])
+ or ('--edit' in parser.parse_args()[1])
+ and command == 'config' ):
+ self.warning(msg)
+ raise Exception(msg)
+ else:
+ self.warning("Opening the file %s with the default viewer" % aFile)
+ do_merge = False
else:
cfg['open_application'] = 'yes'
# =====================================================================
# Load product config files in PRODUCTS section
products_cfg = PYCONF.Config()
- products_cfg.addMapping("PRODUCTS",
- PYCONF.Mapping(products_cfg),
- "The products\n")
+ products_cfg.addMapping("PRODUCTS", PYCONF.Mapping(products_cfg), "The products\n")
if application is not None:
PYCONF.streamOpener = ConfigOpener(cfg.PATHS.PRODUCTPATH)
for product_name in application_cfg.APPLICATION.products.keys():
if product_file_path:
products_dir = os.path.dirname(product_file_path)
try:
- prod_cfg = PYCONF.Config(open(product_file_path),
- PWD=("", products_dir))
+ prod_cfg = PYCONF.Config(open(product_file_path), PWD=("", products_dir))
prod_cfg.from_file = product_file_path
products_cfg.PRODUCTS[product_name] = prod_cfg
except Exception as e:
- msg = _(
- "WARNING: Error in configuration file: %(prod)s\n %(error)s" % \
- {'prod' : product_name, 'error': str(e) })
- sys.stdout.write(msg)
+ msg = msgPb % (product_name, str(e))
+ self.logger.warning(msg)
merger.merge(cfg, products_cfg)
return cfg
def set_user_config_file(self, config):
- '''Set the user config file name and path.
+ """\
+ Set the user config file name and path.
If necessary, build it from another one or create it from scratch.
- :param config class 'PYCONF.Config': The global config
- (containing all pyconf).
- '''
+ :param config class 'PYCONF.Config': The global config (containing all pyconf).
+ """
# get the expected name and path of the file
self.config_file_name = 'SAT.pyconf'
self.user_config_file_path = os.path.join(config.VARS.personalDir,
self.create_config_file(config)
def create_config_file(self, config):
- '''This method is called when there are no user config file.
- It build it from scratch.
+ """\
+ This method is called when there are no user config file.
+ It build it from scratch.
:param config class 'PYCONF.Config': The global config.
:return: the config corresponding to the file created.
:rtype: config class 'PYCONF.Config'
- '''
+ """
cfg_name = self.get_user_config_file()
-
- user_cfg = PYCONF.Config()
- #
- user_cfg.addMapping('USER', PYCONF.Mapping(user_cfg), "")
-
- user_cfg.USER.addMapping('cvs_user', config.VARS.user,
- "This is the user name used to access salome cvs base.\n")
- user_cfg.USER.addMapping('svn_user', config.VARS.user,
- "This is the user name used to access salome svn base.\n")
- user_cfg.USER.addMapping('output_verbose_level', 3,
- "This is the default output_verbose_level you want."
- " 0=>no output, 5=>debug.\n")
- user_cfg.USER.addMapping('publish_dir',
- os.path.join(os.path.expanduser('~'),
- 'websupport',
- 'satreport'),
- "")
- user_cfg.USER.addMapping('editor',
- 'vi',
- "This is the editor used to "
- "modify configuration files\n")
- user_cfg.USER.addMapping('browser',
- 'firefox',
- "This is the browser used to "
- "read html documentation\n")
- user_cfg.USER.addMapping('pdf_viewer',
- 'evince',
- "This is the pdf_viewer used "
- "to read pdf documentation\n")
-# CNC 25/10/17 : plus nécessaire a priori
-# user_cfg.USER.addMapping("base",
-# PYCONF.Reference(
-# user_cfg,
-# PYCONF.DOLLAR,
-# 'workdir + $VARS.sep + "BASE"'),
-# "The products installation base (could be "
-# "ignored if this key exists in the local.pyconf"
-# " file of salomTools).\n")
+ cfg = PYCONF.Config()
+ cfg.addMapping('USER', PYCONF.Mapping(user_cfg), "")
+ USER = cfg.USER
+
+ USER.addMapping('cvs_user', config.VARS.user,
+ "This is the user name used to access salome cvs base.\n")
+ USER.addMapping('svn_user', config.VARS.user,
+ "This is the user name used to access salome svn base.\n")
+ USER.addMapping('output_verbose_level', 3,
+ "This is the default output_verbose_level you want. 0=>no output, 5=>debug.\n")
+ USER.addMapping('publish_dir', os.path.join(os.path.expanduser('~'), 'websupport', 'satreport'),
+ "")
+ USER.addMapping('editor', 'vi', "This is the editor used to modify configuration files\n")
+ USER.addMapping('browser', 'firefox', "This is the browser used to read html documentation\n")
+ USER.addMapping('pdf_viewer', 'evince', "This is the pdf_viewer used to read pdf documentation\n")
- #
UTS.ensure_path_exists(config.VARS.personalDir)
- UTS.ensure_path_exists(os.path.join(config.VARS.personalDir,
- 'Applications'))
+ UTS.ensure_path_exists(os.path.join(config.VARS.personalDir, 'Applications'))
- f = open(cfg_name, 'w')
- user_cfg.__save__(f)
- f.close()
-
- return user_cfg
+ with open(cfg_name, 'w') as f:
+ cfg.__save__(f)
+ return cfg
def get_user_config_file(self):
- '''Get the user config file
+ """Get the user config file
+
:return: path to the user config file.
:rtype: str
- '''
+ """
if not self.user_config_file_path:
- raise Exception(
- _("Error in get_user_config_file: missing user config file path") )
+ raise Exception(_("get_user_config_file: missing user config file path"))
return self.user_config_file_path
def check_path(path, ext=[]):
- '''Construct a text with the input path and "not found" if it does not
- exist.
+ """Construct a text with the input path and "not found" if it does not exist.
:param path Str: the path to check.
- :param ext List: An extension. Verify that the path extension
- is in the list
+ :param ext List: An extension. Verify that the path extension is in the list
:return: The string of the path with information
:rtype: Str
- '''
+ """
# check if file exists
if not os.path.exists(path):
return "path '%s' ** not found" % path
return path
def show_product_info(config, name, logger):
- '''Display on the terminal and logger information about a product.
+ """Display on the terminal and logger information about a product.
:param config Config: the global configuration.
:param name Str: The name of the product
:param logger Logger: The logger instance to use for the display
- '''
+ """
def msgAdd(label, value):
"""
return
def show_patchs(config, logger):
- """
- Prints all the used patchs in the application.
+ """Prints all the used patchs in the application.
:param config Config: the global configuration.
:param logger Logger: The logger instance to use for the display
return
def getConfigColored(config, path, stream, show_label=False, level=0, show_full_path=False):
- """
- get a colored representation value from a config pyconf instance.
+ """\
+ Get a colored representation value from a config pyconf instance.
used recursively from the initial path.
- :param config class 'PYCONF.Config': The configuration
- from which the value is displayed.
- :param path str : the path in the configuration of the value to print.
- :param show_label boolean: if True, do a basic display.
- (useful for bash completion)
+ :param config class 'PYCONF.Config': The configuration from which the value is displayed.
+ :param path str: the path in the configuration of the value to print.
+ :param show_label boolean: if True, do a basic display. (useful for bash completion)
:param stream: the output stream used
:param level int: The number of spaces to add before display.
:param show_full_path: display full path, else relative
stream.write("%s\n" % val)
def print_value(config, path, logger, show_label=False, level=0, show_full_path=False):
- """
+ """\
print a colored representation value from a config pyconf instance.
used recursively from the initial path.
return
-def print_debug(config, path, logger, show_label=False, level=0, show_full_path=False):
- """
+def print_debug(config, aPath, logger, show_label=False, level=0, show_full_path=False):
+ """\
logger output for debugging a config/pyconf
- lines contains:
- path : expression --> 'evaluation'
+ lines contains: path : expression --> 'evaluation'
+
example:
- .PROJECTS.projects.salome.project_path : $PWD --> '/tmp/SALOME'
+ PROJECTS.projects.salome.project_path : $PWD --> '/tmp/SALOME'
"""
path = str(aPath)
if path == "." :
def get_config_children(config, args):
- """
+ """\
Gets the names of the children of the given parameter.
Useful only for completion mechanism
def _getConfig(self, appliToLoad):
- '''The function that will load the configuration (all pyconf)
+ """\
+ Load the configuration (all pyconf)
and returns the config from some files .pyconf
- '''
+ """
if self.runner.config is not None:
raise Exception("config existing yet in '%s' instance" % self.runner.getClassName())
micro_command = False
if logger_add_link:
micro_command = True
- logger_command = src.logger.Logger(config,
+ logger_command = UTS.getNewLogger(config,
silent_sysstd=silent,
all_in_terminal=self.runner.options.all_in_terminal,
micro_command=micro_command)
file_test = open(self.options.logs_paths_in_file, "w")
file_test.close()
except Exception as e:
- msg = _("WARNING: the logs_paths_in_file option will "
- "not be taken into account.\nHere is the error:")
- logger_command.write("%s\n%s\n\n" % (
- UTS.red(msg),
- str(e)))
+ msg = _("""\
+The logs_paths_in_file option will not be taken into account.
+Here is the error:""")
+ logger_command.warning("%s\n%s" % (msg, str(e)))
self.options.logs_paths_in_file = None
return config
def get_products_list(self, options, cfg, logger):
- '''method that gives the product list with their informations from
- configuration regarding the passed options.
+ """\
+ Gives the product list with their informations from
+ configuration regarding the passed options.
- :param options Options: The Options instance that stores the commands
- arguments
+ :param options Options: The Options instance that stores the commands arguments
:param config Config: The global configuration
:param logger Logger: The logger instance to use for the display and logging
:return: The list of (product name, product_informations).
:rtype: List
- '''
+ """
# Get the products to be prepared, regarding the options
if options.products is None:
# No options, get all products sources
"""
This file assume DEBUG functionalities use
-- print salomeTools debug messages in sys.stderr
-- show pretty print debug representation from instances of SAT classes
- (pretty print src.pyconf.Config)
+Print salomeTools debug messages in sys.stderr.
+Show pretty print debug representation from instances of SAT classes
+(pretty print src.pyconf.Config)
WARNING: supposedly show messages in SAT development phase, not production
###############################################
class OutStream(SIO.StringIO):
- """utility class for pyconf.Config output iostream"""
+ """\
+ utility class for pyconf.Config output iostream
+ """
def close(self):
- """because Config.__save__ calls close() stream as file
+ """\
+ because Config.__save__ calls close() stream as file
keep value before lost as self.value
"""
self.value = self.getvalue()
order = object.__getattribute__(config, 'order')
data = object.__getattribute__(config, 'data')
except:
- aStream.write("%s%s : '%s'\n" % (indstr, path, str(config)))
+ aStream.write("<blue>%s%s<reset> : '%s'\n" % (indstr, path, str(config)))
return
for key in sorted(order):
value = data[key]
if "Expression" in strType:
try:
evaluate = value.evaluate(config)
- aStream.write("%s%s.%s : %s --> '%s'\n" % (indstr, path, key, str(value), evaluate))
+ aStream.write("<blue>%s%s.%s<reset> : %s <yellow>--> '%s'<reset>\n" % (indstr, path, key, str(value), evaluate))
except Exception as e:
- aStream.write("%s%s.%s : !!! ERROR: %s !!!\n" % (indstr, path, key, e.message))
+ aStream.write("<blue>%s%s.%s<reset> : <red>!!! ERROR: %s !!!<reset>\n" % (indstr, path, key, e.message))
continue
if "Reference" in strType:
try:
evaluate = value.resolve(config)
- aStream.write("%s%s.%s : %s --> '%s'\n" % (indstr, path, key, str(value), evaluate))
+ aStream.write("<blue>%s%s.%s<reset> : %s <yellow>--> '%s'<reset>\n" % (indstr, path, key, str(value), evaluate))
except Exception as e:
- aStream.write("%s%s.%s : !!! ERROR: %s !!!\n" % (indstr, path, key, e.message))
+ aStream.write("<blue>%s%s.%s<reset> : <red>!!! ERROR: %s !!!<reset>\n" % (indstr, path, key, e.message))
continue
if type(value) in [str, bool, int, type(None), unicode]:
- aStream.write("%s%s.%s : '%s'\n" % (indstr, path, key, str(value)))
+ aStream.write("<blue>%s%s.%s<reset> : '%s'\n" % (indstr, path, key, str(value)))
continue
try:
aStream.write("!!! TODO fix that %s %s%s.%s : %s\n" % (type(value), indstr, path, key, str(value)))
except Exception as e:
- aStream.write("%s%s.%s : !!! %s\n" % (indstr, path, key, e.message))
+ aStream.write("<blue>%s%s.%s<reset> : <red>!!! %s<reset>\n" % (indstr, path, key, e.message))
VERSION_DELIMITER = "_to_"
def get_product_config(config, product_name, with_install_dir=True):
- '''Get the specific configuration of a product from the global configuration
+ """\
+ Get the specific configuration of a product from the global configuration
:param config Config: The global configuration
:param product_name str: The name of the product
of the function check_config_exists)
:return: the specific configuration of the product
:rtype: Config
- '''
+ """
# Get the version of the product from the application definition
version = config.APPLICATION.products[product_name]
if version == "native":
prod_info.get_source = "native"
elif prod_info.get_source == "native":
- msg = _("The product %(prod)s has version %(ver)s but is "
- "declared as native in its definition") % \
- {'prod': prod_info.name, 'ver': version}
+ msg = _("The product %s has version %s but is declared as native in its definition") % \
+ (prod_info.name, version)
raise Exception(msg)
# If there is no definition but the product is declared as native,
return None
def get_install_dir(config, base, version, prod_info):
- '''Compute the installation directory of a given product
+ """\
+ Compute the installation directory of a given product
:param config Config: The global configuration
- :param base str: 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
+ :param base str: 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
:param version str: The version of the product
- :param product_info Config: The configuration specific to
- the product
-
+ :param product_info Config: The configuration specific to the product
:return: The path of the product installation
:rtype: str
- '''
+ """
install_dir = ""
in_base = False
if (("install_dir" in prod_info and prod_info.install_dir == "base")
Make a path from a prefix and suffix.
Examples::
+ makePath('', 'suffix') -> 'suffix'
+ makePath('prefix', 'suffix') -> 'prefix.suffix'
+ makePath('prefix', '[1]') -> 'prefix[1]'
- makePath('', 'suffix') -> 'suffix'
- makePath('prefix', 'suffix') -> 'prefix.suffix'
- makePath('prefix', '[1]') -> 'prefix[1]'
-
- @param prefix: The prefix to use. If it evaluates as false, the suffix
- is returned.
+ @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.
+ @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 a
- dot if the suffix is not a bracketed index.
+ @return: The path concatenation of prefix and suffix, with a dot if the suffix is not a bracketed index.
@rtype: str
-
"""
if not prefix:
rv = suffix
def defaultMergeResolve(map1, map2, key):
"""
- A default resolver for merge conflicts. Returns a string
- indicating what action to take to resolve the conflict.
+ 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}.
@type map2: L{Mapping}.
@param key: The key in map2 (which also exists in map1).
@type key: str
- @return: One of "merge", "append", "mismatch" or "overwrite"
- 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}.
+ @return: One of "merge", "append", "mismatch" or "overwrite"
+ 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}.
@rtype: str
"""
obj1 = map1[key]
# License along with this library; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
-'''This file is the main entry file to salomeTools
+"""\
+This file is the main entry file to salomeTools
NO __main__ entry allowed, use 'sat' (in parent directory)
-'''
+"""
########################################################################
# NO __main__ entry allowed, use sat
_COMMANDS_NAMES = find_command_list(cmdsdir)
def getCommandsList():
- """Gives commands list (as basename of files cmdsdir/*.py)"""
+ """Gives commands list (as basename of files .py in directory commands"""
return _COMMANDS_NAMES
def launchSat(command):
- """
+ """\
launch sat as subprocess popen
command as string ('sat --help' for example)
used for unittest, or else...
DBG.write("setNotLocale", os.environ["LANG"])
def setLocale():
- """reset initial locale at any moment
+ """\
+ reset initial locale at any moment
'fr' or else (TODO) from initial environment var '$LANG'
'i18n' as 'internationalization'
"""
return self._getModule(name)
def getCommandInstance(self, name):
- """
+ """\
returns inherited instance of Command(_BaseCmd) for command 'name'
if module not loaded yet, load it.
"""
sp = "." * (35 - len(script_info.name))
self.logger.info(self.write_test_margin(3))
self.logger.info("script %s %s %s %s\n" % \
- (UTS.label(script_info.name),sp,script_info.res,exectime)
+ (UTS.label(script_info.name), sp, script_info.res, exectime))
if script_info and len(callback) > 0:
- self.logger.error("Exception in %s\n%s\n" % \
+ self.logger.error("Exception in %s\n%s" % \
(script_info.name, UTS.red(callback)))
if script_info.res == src.OK_STATUS:
for session_ in sessions:
if not os.path.exists(os.path.join(grid_path, session_)):
self.logger.info(self.write_test_margin(2))
- self.logger.warning("Session %s not found" % session_))
+ self.logger.warning("Session %s not found" % session_)
else:
self.currentsession = session_
self.run_session_tests()
DBG.tofix("fix what the hell is the pythonpath ?", os.environ['PYTHONPATH'], True)
os.environ['TT_BASE_RESSOURCES'] = res_dir
- logger.debug(" %s = %s\n" % ("TT_BASE_RESSOURCES", res_dir)
+ logger.debug(" %s = %s\n" % ("TT_BASE_RESSOURCES", res_dir))
self.logger.info(self.write_test_margin(0))
testbase_label = "Test base = %s\n" % UTS.label(self.currentTestBase)
for grid in grids:
if not os.path.exists(os.path.join(self.currentDir, grid)):
self.logger.info(self.write_test_margin(1))
- self.logger.error("grid %s does not exist" % grid))
+ self.logger.error("grid %s does not exist" % grid)
else:
self.currentgrid = grid
self.run_grid_tests()
if not os.path.exists(script):
self.logger.warning("script not found: %s" % script)
else:
- self.logger.info("----------- start %s\n" % script_name))
+ self.logger.info("----------- start %s\n" % script_name)
self.logger.info("Run script: %s\n" % script)
subprocess.Popen(script, shell=True).wait()
- self.logger.info("----------- end %s\n" % script_name))
+ self.logger.info("----------- end %s\n" % script_name)
def run_all_tests(self):
initTime = datetime.datetime.now()
# License along with this library; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
-echo "TODO: OBSOLETE: to set as python script, may be"
+echo "TODO: SAT5.1 OBSOLETE: to set as python script, may be"
echo "Begin date:"
date
echo
