From: Christian Van Wambeke Date: Tue, 1 May 2018 16:07:21 +0000 (+0200) Subject: fix commands apidoc, src.check.. yet X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=88556d3f1524318b920a62ef01ed8245e98e0ebb;p=tools%2Fsat.git fix commands apidoc, src.check.. yet --- diff --git a/commands/application.py b/commands/application.py index 720b342..186a178 100644 --- a/commands/application.py +++ b/commands/application.py @@ -52,21 +52,26 @@ class Command(_BaseCommand): def getParser(self): """Define all options for command 'sat application '""" parser = self.getParserWithHelp() - parser.add_option('n', 'name', 'string', 'name', + parser.add_option( + 'n', 'name', 'string', 'name', _("""\ Optional: The name of the application (default is APPLICATION.virtual_app.name or runAppli)""") ) - parser.add_option('c', 'catalog', 'string', 'catalog', + parser.add_option( + 'c', 'catalog', 'string', 'catalog', _('Optional: The resources catalog to use') ) - parser.add_option('t', 'target', 'string', 'target', + parser.add_option( + 't', 'target', 'string', 'target', _("""\ Optional: The directory where to create the application (default is APPLICATION.workdir)""") ) - parser.add_option('', 'gencat', 'string', 'gencat', + parser.add_option( + '', 'gencat', 'string', 'gencat', _("""\ Optional: Create a resources catalog for the specified machines (separated with ',') -NOTICE: this command will ssh to retrieve information to each machine in the list""") ) - parser.add_option('m', 'module', 'list2', 'modules', +Note: this command will ssh to retrieve information to each machine in the list""") ) + parser.add_option( + 'm', 'module', 'list2', 'modules', _("Optional: the restricted list of module(s) to include in the application") ) return parser @@ -92,7 +97,7 @@ NOTICE: this command will ssh to retrieve information to each machine in the l options = self.getOptions() # check for product - src.check_config_has_application( config ) + UTS.check_config_has_application( config ) application = config.VARS.application logger.info(_("Building application for
%s\n") % application) diff --git a/commands/check.py b/commands/check.py index 0ec831b..3910f88 100644 --- a/commands/check.py +++ b/commands/check.py @@ -33,8 +33,8 @@ class Command(_BaseCommand): It is possible to reduce the list of products to check by using the --products option - examples: - >> sat check SALOME --products KERNEL,GUI,GEOM + | examples: + | >> sat check SALOME --products KERNEL,GUI,GEOM """ name = "check" diff --git a/commands/clean.py b/commands/clean.py index 13a209b..155fa0c 100644 --- a/commands/clean.py +++ b/commands/clean.py @@ -42,8 +42,8 @@ class Command(_BaseCommand): Use the options to define what directories you want to suppress and to reduce the list of products - examples: - >> sat clean SALOME --build --install --properties is_salome_module:yes + | examples: + | >> sat clean SALOME --build --install --properties is_salome_module:yes """ name = "clean" diff --git a/commands/compile.py b/commands/compile.py index 74919c8..bd58844 100644 --- a/commands/compile.py +++ b/commands/compile.py @@ -35,11 +35,11 @@ except NameError: # Command class ######################################################################## class Command(_BaseCommand): - """\ + """ The compile command constructs the products of the application - examples: - >> sat compile SALOME --products KERNEL,GUI,MEDCOUPLING --clean_all + | examples: + | >> sat compile SALOME --products KERNEL,GUI,MEDCOUPLING --clean_all """ name = "compile" diff --git a/commands/config.py b/commands/config.py index b66203d..38b58a1 100644 --- a/commands/config.py +++ b/commands/config.py @@ -30,6 +30,7 @@ import src.system as SYSS # Command class ######################################################################## class Command(_BaseCommand): + # ' | ' is used in sphinx apidoc interpretation """ The config command allows manipulation and operation on config '.pyconf' files. @@ -76,7 +77,7 @@ If a name is given the new config file takes the given name.""")) def run(self, cmd_arguments): """method called for command 'sat config '""" argList = self.assumeAsList(cmd_arguments) - + # print general help and returns if len(argList) == 0: self.print_help() diff --git a/commands/configure.py b/commands/configure.py index 0e87ddf..e26d0a8 100644 --- a/commands/configure.py +++ b/commands/configure.py @@ -31,13 +31,13 @@ class Command(_BaseCommand): corresponding to the compilation mode of the application products. The possible compilation modes are 'cmake', 'autotools', or 'script'. - Here are the commands to be run: - autotools: >> build_configure and configure - cmake: >> cmake - script: (do nothing) - - examples: - >> sat configure SALOME --products KERNEL,GUI,PARAVIS + | Here are the commands to be run: + | autotools: >> build_configure and configure + | cmake: >> cmake + | script: (do nothing) + | + | examples: + | >> sat configure SALOME --products KERNEL,GUI,PARAVIS """ name = "configure" diff --git a/commands/environ.py b/commands/environ.py index 8e8467c..04f288c 100644 --- a/commands/environ.py +++ b/commands/environ.py @@ -35,8 +35,8 @@ class Command(_BaseCommand): """ The environ command generates the environment files of your application. - examples: - >> sat environ SALOME + | examples: + | >> sat environ SALOME """ name = "environ" diff --git a/commands/find_duplicates.py b/commands/find_duplicates.py index 58eed40..e5b7e9f 100644 --- a/commands/find_duplicates.py +++ b/commands/find_duplicates.py @@ -37,13 +37,13 @@ default_directories_ignored = [] # Command class ######################################################################## class Command(_BaseCommand): - """\ + """ The find_duplicates command search recursively for all duplicates files in INSTALL directory (or the optionally given directory) and prints the found files to the terminal. - examples: - >> sat find_duplicates --path /tmp + | examples: + | >> sat find_duplicates --path /tmp """ name = "find_duplicates" diff --git a/commands/generate.py b/commands/generate.py index 86404db..c63ce25 100644 --- a/commands/generate.py +++ b/commands/generate.py @@ -28,12 +28,13 @@ import src.pyconf as PYCONF # Command class ######################################################################## class Command(_BaseCommand): - """\ + """ The generate command generates SALOME modules from 'pure cpp' products. - WARNING: this command NEEDS YACSGEN to run. - - examples: - >> sat generate SALOME --products FLICACPP + + | warning: this command NEEDS YACSGEN to run. + | + | examples: + | >> sat generate SALOME --products FLICACPP """ name = "generate" diff --git a/commands/init.py b/commands/init.py index 15154ad..7aec83b 100644 --- a/commands/init.py +++ b/commands/init.py @@ -28,7 +28,7 @@ import src.pyconf as PYCONF # Command class ######################################################################## class Command(_BaseCommand): - """\ + """ The init command Changes the local settings of SAT """ diff --git a/commands/job.py b/commands/job.py index f5817a3..e40bbdf 100644 --- a/commands/job.py +++ b/commands/job.py @@ -26,12 +26,12 @@ from src.salomeTools import _BaseCommand # Command class ######################################################################## class Command(_BaseCommand): - """\ + """ The job command executes the commands of the job defined in the jobs configuration file\ - examples: - >> sat job --jobs_config my_jobs --name my_job" + | examples: + | >> sat job --jobs_config my_jobs --name my_job" """ name = "job" diff --git a/commands/jobs.py b/commands/jobs.py index ce0fc93..3b67ca9 100644 --- a/commands/jobs.py +++ b/commands/jobs.py @@ -68,8 +68,8 @@ class Command(_BaseCommand): The jobs command command launches maintenances that are described in the dedicated jobs configuration file. - examples: - >> sat jobs --name my_jobs --publish + | examples: + | >> sat jobs --name my_jobs --publish """ name = "jobs" diff --git a/commands/launcher.py b/commands/launcher.py index d9d0eda..e19b987 100644 --- a/commands/launcher.py +++ b/commands/launcher.py @@ -34,8 +34,8 @@ class Command(_BaseCommand): """ The launcher command generates a SALOME launcher. - examples: - >> sat launcher SALOME + | examples: + | >> sat launcher SALOME """ name = "launcher" diff --git a/commands/log.py b/commands/log.py index c32aca2..bca0a9a 100644 --- a/commands/log.py +++ b/commands/log.py @@ -46,8 +46,8 @@ class Command(_BaseCommand): """ The log command gives access to the logs produced by the salomeTools commands. - examples: - >> sat log + | examples: + | >> sat log """ name = "log" diff --git a/commands/make.py b/commands/make.py index 502f5fe..3c2f2db 100644 --- a/commands/make.py +++ b/commands/make.py @@ -32,8 +32,8 @@ class Command(_BaseCommand): """ The make command executes the 'make' command in the build directory. - examples: - >> sat make SALOME --products Python,KERNEL,GUI + | examples: + | >> sat make SALOME --products Python,KERNEL,GUI """ name = "make" diff --git a/commands/makeinstall.py b/commands/makeinstall.py index f445579..ad3344d 100644 --- a/commands/makeinstall.py +++ b/commands/makeinstall.py @@ -31,8 +31,8 @@ class Command(_BaseCommand): In case of product constructed using a script (build_source : 'script'), then the makeinstall command do nothing. - examples: - >> sat makeinstall SALOME --products KERNEL,GUI + | examples: + | >> sat makeinstall SALOME --products KERNEL,GUI """ name = "makeinstall" diff --git a/commands/package.py b/commands/package.py index 1c3beb5..7c8ddb6 100644 --- a/commands/package.py +++ b/commands/package.py @@ -95,14 +95,15 @@ project_file_paths : [$VARS.salometoolsway + $VARS.sep + \"..\" + $VARS.sep""" class Command(_BaseCommand): """ The package command creates an archive. - There are 4 kinds of archive, which can be mixed: - 1- The binary archive. It contains all the product installation directories and a launcher. - 2- The sources archive. It contains the products archives, a project corresponding to the application and salomeTools. - 3- The project archive. It contains a project (give the project file path as argument). - 4- The salomeTools archive. It contains salomeTools. - examples: - >> sat package SALOME --binaries --sources + | There are 4 kinds of archive, which can be mixed: + | 1- The binary archive. It contains all the product installation directories and a launcher. + | 2- The sources archive. It contains the products archives, a project corresponding to the application and salomeTools. + | 3- The project archive. It contains a project (give the project file path as argument). + | 4- The salomeTools archive. It contains salomeTools. + | + | examples: + | >> sat package SALOME --binaries --sources """ name = "package" diff --git a/commands/patch.py b/commands/patch.py index 8c5dc1c..d99a3e5 100644 --- a/commands/patch.py +++ b/commands/patch.py @@ -34,8 +34,8 @@ class Command(_BaseCommand): The patch command apply the patches on the sources of the application products if there is any. - examples: - >> sat patch SALOME --products qt,boost + | examples: + | >> sat patch SALOME --products qt,boost """ name = "patch" diff --git a/commands/prepare.py b/commands/prepare.py index 240a250..e6eca54 100644 --- a/commands/prepare.py +++ b/commands/prepare.py @@ -32,8 +32,8 @@ class Command(_BaseCommand): The prepare command gets the sources of the application products and apply the patches if there is any. - examples: - >> sat prepare SALOME --products KERNEL,GUI + | examples: + | >> sat prepare SALOME --products KERNEL,GUI """ name = "prepare" diff --git a/commands/profile.py b/commands/profile.py index 599efb9..cd0988e 100644 --- a/commands/profile.py +++ b/commands/profile.py @@ -32,13 +32,13 @@ class Command(_BaseCommand): """\ The profile command creates default profile. - examples: - >> sat profile [PRODUCT] - >> sat profile --prefix (string) - >> sat profile --name (string) - >> sat profile --force - >> sat profile --version (string) - >> sat profile --slogan (string) + | examples: + | >> sat profile [PRODUCT] + | >> sat profile --prefix (string) + | >> sat profile --name (string) + | >> sat profile --force + | >> sat profile --version (string) + | >> sat profile --slogan (string) """ name = "profile" diff --git a/commands/run.py b/commands/run.py index 55087d9..3565ca5 100644 --- a/commands/run.py +++ b/commands/run.py @@ -32,8 +32,8 @@ class Command(_BaseCommand): """\ The run command runs the application launcher with the given arguments. - examples: - >> sat run SALOME + | examples: + | >> sat run SALOME """ name = "run" diff --git a/commands/script.py b/commands/script.py index dd3da47..1cd12ab 100644 --- a/commands/script.py +++ b/commands/script.py @@ -31,8 +31,8 @@ class Command(_BaseCommand): This is done only for the products that are constructed using a script (build_source : 'script'). Otherwise, nothing is done. - examples: - >> sat script SALOME --products Python,numpy + | examples: + | >> sat script SALOME --products Python,numpy """ name = "script" diff --git a/commands/shell.py b/commands/shell.py index 666b65b..ccfeafe 100644 --- a/commands/shell.py +++ b/commands/shell.py @@ -31,8 +31,8 @@ class Command(_BaseCommand): """\ The shell command executes the shell command passed as argument. - examples: - >> sat shell --command 'ls -lt /tmp' + | examples: + | >> sat shell --command 'ls -lt /tmp' """ name = "shell" diff --git a/commands/source.py b/commands/source.py index d83b447..e547b59 100644 --- a/commands/source.py +++ b/commands/source.py @@ -34,8 +34,8 @@ class Command(_BaseCommand): The source command gets the sources of the application products from cvs, git or an archive. - examples: - >> sat source SALOME --products KERNEL,GUI + | examples: + | >> sat source SALOME --products KERNEL,GUI """ name = "source" diff --git a/commands/template.py b/commands/template.py index 16d0e8c..beebf44 100644 --- a/commands/template.py +++ b/commands/template.py @@ -44,8 +44,8 @@ class Command(_BaseCommand): """ The template command creates the sources for a SALOME module from a template. - examples: - >> sat template --name my_product_name --template PythonComponent --target /tmp + | examples: + | >> sat template --name my_product_name --template PythonComponent --target /tmp """ name = "template" diff --git a/commands/test.py b/commands/test.py index c981016..a44091e 100644 --- a/commands/test.py +++ b/commands/test.py @@ -41,11 +41,11 @@ except ImportError: # Command class ######################################################################## class Command(_BaseCommand): - """\ + """ The test command runs a test base on a SALOME installation. - examples: - >> sat test SALOME --grid GEOM --session light + | examples: + | >> sat test SALOME --grid GEOM --session light """ name = "test" diff --git a/doc/build/doctrees/apidoc_commands/commands.doctree b/doc/build/doctrees/apidoc_commands/commands.doctree index 1b1f5f4..3d55679 100644 Binary files a/doc/build/doctrees/apidoc_commands/commands.doctree and b/doc/build/doctrees/apidoc_commands/commands.doctree differ diff --git a/doc/build/doctrees/apidoc_src/src.doctree b/doc/build/doctrees/apidoc_src/src.doctree index c17d100..05020b4 100644 Binary files a/doc/build/doctrees/apidoc_src/src.doctree and b/doc/build/doctrees/apidoc_src/src.doctree differ diff --git a/doc/build/doctrees/environment.pickle b/doc/build/doctrees/environment.pickle index 2ad2b55..4959cb6 100644 Binary files a/doc/build/doctrees/environment.pickle and b/doc/build/doctrees/environment.pickle differ diff --git a/doc/build/html/_modules/commands.html b/doc/build/html/_modules/commands.html new file mode 100644 index 0000000..fc8ec8d --- /dev/null +++ b/doc/build/html/_modules/commands.html @@ -0,0 +1,182 @@ + + + + + + + + commands — salomeTools 5.0.0dev documentation + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+ +

Source code for commands

+"""Execute shell commands via os.popen() and return status, output.
+
+Interface summary:
+
+       import commands
+
+       outtext = commands.getoutput(cmd)
+       (exitstatus, outtext) = commands.getstatusoutput(cmd)
+       outtext = commands.getstatus(file)  # returns output of "ls -ld file"
+
+A trailing newline is removed from the output string.
+
+Encapsulates the basic operation:
+
+      pipe = os.popen('{ ' + cmd + '; } 2>&1', 'r')
+      text = pipe.read()
+      sts = pipe.close()
+
+ [Note:  it would be nice to add functions to interpret the exit status.]
+"""
+from warnings import warnpy3k
+warnpy3k("the commands module has been removed in Python 3.0; "
+         "use the subprocess module instead", stacklevel=2)
+del warnpy3k
+
+__all__ = ["getstatusoutput","getoutput","getstatus"]
+
+# Module 'commands'
+#
+# Various tools for executing commands and looking at their output and status.
+#
+# NB This only works (and is only relevant) for UNIX.
+
+
+# Get 'ls -l' status for an object into a string
+#
+
[docs]def getstatus(file):
+    """Return output of "ls -ld <file>" in a string."""
+    import warnings
+    warnings.warn("commands.getstatus() is deprecated", DeprecationWarning, 2)
+    return getoutput('ls -ld' + mkarg(file))

+
+
+# Get the output from a shell command into a string.
+# The exit status is ignored; a trailing newline is stripped.
+# Assume the command will work with '{ ... ; } 2>&1' around it..
+#
+
[docs]def getoutput(cmd):
+    """Return output (stdout or stderr) of executing cmd in a shell."""
+    return getstatusoutput(cmd)[1]

+
+
+# Ditto but preserving the exit status.
+# Returns a pair (sts, output)
+#
+
[docs]def getstatusoutput(cmd):
+    """Return (status, output) of executing cmd in a shell."""
+    import os
+    pipe = os.popen('{ ' + cmd + '; } 2>&1', 'r')
+    text = pipe.read()
+    sts = pipe.close()
+    if sts is None: sts = 0
+    if text[-1:] == '\n': text = text[:-1]
+    return sts, text

+
+
+# Make command argument from directory and pathname (prefix space, add quotes).
+#
+def mk2arg(head, x):
+    import os
+    return mkarg(os.path.join(head, x))
+
+
+# Make a shell command argument from a string.
+# Return a string beginning with a space followed by a shell-quoted
+# version of the argument.
+# Two strategies: enclose in single quotes if it contains none;
+# otherwise, enclose in double quotes and prefix quotable characters
+# with backslash.
+#
+def mkarg(x):
+    if '\'' not in x:
+        return ' \'' + x + '\''
+    s = ' "'
+    for c in x:
+        if c in '\\$"`':
+            s = s + '\\'
+        s = s + c
+    s = s + '"'
+    return s
+
+ +
+
+
+ +
+
+
+ ©2018, CEA. + + | + Powered by Sphinx 1.4.9 + & Alabaster 0.7.8 + +
+ + + + + + \ No newline at end of file diff --git a/doc/build/html/_modules/commands/application.html b/doc/build/html/_modules/commands/application.html index d882b9b..e30d8d4 100644 --- a/doc/build/html/_modules/commands/application.html +++ b/doc/build/html/_modules/commands/application.html @@ -27,7 +27,7 @@ - + @@ -563,6 +563,8 @@ diff --git a/doc/build/html/_modules/commands/check.html b/doc/build/html/_modules/commands/check.html index 8bc6e5e..80be4f5 100644 --- a/doc/build/html/_modules/commands/check.html +++ b/doc/build/html/_modules/commands/check.html @@ -27,7 +27,7 @@ - + @@ -79,8 +79,8 @@ It is possible to reduce the list of products to check by using the --products option - examples: - >> sat check SALOME --products KERNEL,GUI,GEOM + | examples: + | >> sat check SALOME --products KERNEL,GUI,GEOM """ name = "check" @@ -310,6 +310,8 @@ diff --git a/doc/build/html/_modules/commands/clean.html b/doc/build/html/_modules/commands/clean.html index 7ccaae4..5f5470e 100644 --- a/doc/build/html/_modules/commands/clean.html +++ b/doc/build/html/_modules/commands/clean.html @@ -27,7 +27,7 @@ - + @@ -88,8 +88,8 @@ Use the options to define what directories you want to suppress and to reduce the list of products - examples: - >> sat clean SALOME --build --install --properties is_salome_module:yes + | examples: + | >> sat clean SALOME --build --install --properties is_salome_module:yes """ name = "clean" @@ -292,6 +292,8 @@ diff --git a/doc/build/html/_modules/commands/compile.html b/doc/build/html/_modules/commands/compile.html index b689ce6..49f1452 100644 --- a/doc/build/html/_modules/commands/compile.html +++ b/doc/build/html/_modules/commands/compile.html @@ -27,7 +27,7 @@ - + @@ -81,11 +81,11 @@ # Command class ########################################################################
[docs]class Command(_BaseCommand): - """\ + """ The compile command constructs the products of the application - examples: - >> sat compile SALOME --products KERNEL,GUI,MEDCOUPLING --clean_all + | examples: + | >> sat compile SALOME --products KERNEL,GUI,MEDCOUPLING --clean_all """ name = "compile" @@ -783,6 +783,8 @@ diff --git a/doc/build/html/_modules/commands/config.html b/doc/build/html/_modules/commands/config.html index d8d7e15..051bfd6 100644 --- a/doc/build/html/_modules/commands/config.html +++ b/doc/build/html/_modules/commands/config.html @@ -27,7 +27,7 @@ - + @@ -76,6 +76,7 @@ # Command class ########################################################################
[docs]class Command(_BaseCommand): + # ' | ' is used in sphinx apidoc interpretation """ The config command allows manipulation and operation on config '.pyconf' files. @@ -122,7 +123,7 @@
[docs] def run(self, cmd_arguments): """method called for command 'sat config <options>'""" argList = self.assumeAsList(cmd_arguments) - + # print general help and returns if len(argList) == 0: self.print_help() @@ -290,6 +291,8 @@ diff --git a/doc/build/html/_modules/commands/configure.html b/doc/build/html/_modules/commands/configure.html index 4d3ddeb..f12afc7 100644 --- a/doc/build/html/_modules/commands/configure.html +++ b/doc/build/html/_modules/commands/configure.html @@ -27,7 +27,7 @@ - + @@ -77,13 +77,13 @@ corresponding to the compilation mode of the application products. The possible compilation modes are 'cmake', 'autotools', or 'script'. - Here are the commands to be run: - autotools: >> build_configure and configure - cmake: >> cmake - script: (do nothing) - - examples: - >> sat configure SALOME --products KERNEL,GUI,PARAVIS + | Here are the commands to be run: + | autotools: >> build_configure and configure + | cmake: >> cmake + | script: (do nothing) + | + | examples: + | >> sat configure SALOME --products KERNEL,GUI,PARAVIS """ name = "configure" @@ -303,6 +303,8 @@ diff --git a/doc/build/html/_modules/commands/environ.html b/doc/build/html/_modules/commands/environ.html index ea14d16..33c8a08 100644 --- a/doc/build/html/_modules/commands/environ.html +++ b/doc/build/html/_modules/commands/environ.html @@ -27,7 +27,7 @@ - + @@ -81,8 +81,8 @@ """ The environ command generates the environment files of your application. - examples: - >> sat environ SALOME + | examples: + | >> sat environ SALOME """ name = "environ" @@ -234,6 +234,8 @@ diff --git a/doc/build/html/_modules/commands/find_duplicates.html b/doc/build/html/_modules/commands/find_duplicates.html index afb83f6..d9c8ace 100644 --- a/doc/build/html/_modules/commands/find_duplicates.html +++ b/doc/build/html/_modules/commands/find_duplicates.html @@ -27,7 +27,7 @@ - + @@ -83,13 +83,13 @@ # Command class ########################################################################
[docs]class Command(_BaseCommand): - """\ + """ The find_duplicates command search recursively for all duplicates files in INSTALL directory (or the optionally given directory) and prints the found files to the terminal. - examples: - >> sat find_duplicates --path /tmp + | examples: + | >> sat find_duplicates --path /tmp """ name = "find_duplicates" @@ -357,6 +357,8 @@ diff --git a/doc/build/html/_modules/commands/generate.html b/doc/build/html/_modules/commands/generate.html index f110cfb..5c3a06d 100644 --- a/doc/build/html/_modules/commands/generate.html +++ b/doc/build/html/_modules/commands/generate.html @@ -27,7 +27,7 @@ - + @@ -74,12 +74,13 @@ # Command class ########################################################################
[docs]class Command(_BaseCommand): - """\ + """ The generate command generates SALOME modules from 'pure cpp' products. - WARNING: this command NEEDS YACSGEN to run. - - examples: - >> sat generate SALOME --products FLICACPP + + | warning: this command NEEDS YACSGEN to run. + | + | examples: + | >> sat generate SALOME --products FLICACPP """ name = "generate" @@ -459,6 +460,8 @@ diff --git a/doc/build/html/_modules/commands/init.html b/doc/build/html/_modules/commands/init.html index 68a6106..9169006 100644 --- a/doc/build/html/_modules/commands/init.html +++ b/doc/build/html/_modules/commands/init.html @@ -27,7 +27,7 @@ - + @@ -74,7 +74,7 @@ # Command class ########################################################################
[docs]class Command(_BaseCommand): - """\ + """ The init command Changes the local settings of SAT """ @@ -240,6 +240,8 @@ diff --git a/doc/build/html/_modules/commands/job.html b/doc/build/html/_modules/commands/job.html index 5edc609..2f1d01f 100644 --- a/doc/build/html/_modules/commands/job.html +++ b/doc/build/html/_modules/commands/job.html @@ -27,7 +27,7 @@ - + @@ -72,12 +72,12 @@ # Command class ########################################################################
[docs]class Command(_BaseCommand): - """\ + """ The job command executes the commands of the job defined in the jobs configuration file\ - examples: - >> sat job --jobs_config my_jobs --name my_job" + | examples: + | >> sat job --jobs_config my_jobs --name my_job" """ name = "job" @@ -242,6 +242,8 @@ diff --git a/doc/build/html/_modules/commands/jobs.html b/doc/build/html/_modules/commands/jobs.html index 9deb005..c973c17 100644 --- a/doc/build/html/_modules/commands/jobs.html +++ b/doc/build/html/_modules/commands/jobs.html @@ -27,7 +27,7 @@ - + @@ -114,8 +114,8 @@ The jobs command command launches maintenances that are described in the dedicated jobs configuration file. - examples: - >> sat jobs --name my_jobs --publish + | examples: + | >> sat jobs --name my_jobs --publish """ name = "jobs" @@ -1887,6 +1887,8 @@ diff --git a/doc/build/html/_modules/commands/launcher.html b/doc/build/html/_modules/commands/launcher.html index 6d6ad7d..606f015 100644 --- a/doc/build/html/_modules/commands/launcher.html +++ b/doc/build/html/_modules/commands/launcher.html @@ -27,7 +27,7 @@ - + @@ -80,8 +80,8 @@ """ The launcher command generates a SALOME launcher. - examples: - >> sat launcher SALOME + | examples: + | >> sat launcher SALOME """ name = "launcher" @@ -331,6 +331,8 @@ diff --git a/doc/build/html/_modules/commands/log.html b/doc/build/html/_modules/commands/log.html index e658aff..e3bf54c 100644 --- a/doc/build/html/_modules/commands/log.html +++ b/doc/build/html/_modules/commands/log.html @@ -27,7 +27,7 @@ - + @@ -92,8 +92,8 @@ """ The log command gives access to the logs produced by the salomeTools commands. - examples: - >> sat log + | examples: + | >> sat log """ name = "log" @@ -449,6 +449,8 @@ diff --git a/doc/build/html/_modules/commands/make.html b/doc/build/html/_modules/commands/make.html index 3134317..19d6658 100644 --- a/doc/build/html/_modules/commands/make.html +++ b/doc/build/html/_modules/commands/make.html @@ -27,7 +27,7 @@ - + @@ -78,8 +78,8 @@ """ The make command executes the 'make' command in the build directory. - examples: - >> sat make SALOME --products Python,KERNEL,GUI + | examples: + | >> sat make SALOME --products Python,KERNEL,GUI """ name = "make" @@ -317,6 +317,8 @@ diff --git a/doc/build/html/_modules/commands/makeinstall.html b/doc/build/html/_modules/commands/makeinstall.html index 3af8980..97ef899 100644 --- a/doc/build/html/_modules/commands/makeinstall.html +++ b/doc/build/html/_modules/commands/makeinstall.html @@ -27,7 +27,7 @@ - + @@ -77,8 +77,8 @@ In case of product constructed using a script (build_source : 'script'), then the makeinstall command do nothing. - examples: - >> sat makeinstall SALOME --products KERNEL,GUI + | examples: + | >> sat makeinstall SALOME --products KERNEL,GUI """ name = "makeinstall" @@ -278,6 +278,8 @@ diff --git a/doc/build/html/_modules/commands/package.html b/doc/build/html/_modules/commands/package.html index cfdd9e0..20e5969 100644 --- a/doc/build/html/_modules/commands/package.html +++ b/doc/build/html/_modules/commands/package.html @@ -27,7 +27,7 @@ - + @@ -141,14 +141,15 @@ project_file_paths : [$VARS.salometoolsway + $VARS.sep + \"..\" + $VAR
[docs]class Command(_BaseCommand): """ The package command creates an archive. - There are 4 kinds of archive, which can be mixed: - 1- The binary archive. It contains all the product installation directories and a launcher. - 2- The sources archive. It contains the products archives, a project corresponding to the application and salomeTools. - 3- The project archive. It contains a project (give the project file path as argument). - 4- The salomeTools archive. It contains salomeTools. - examples: - >> sat package SALOME --binaries --sources + | There are 4 kinds of archive, which can be mixed: + | 1- The binary archive. It contains all the product installation directories and a launcher. + | 2- The sources archive. It contains the products archives, a project corresponding to the application and salomeTools. + | 3- The project archive. It contains a project (give the project file path as argument). + | 4- The salomeTools archive. It contains salomeTools. + | + | examples: + | >> sat package SALOME --binaries --sources """ name = "package" @@ -1422,6 +1423,8 @@ The procedure to do it is: diff --git a/doc/build/html/_modules/commands/patch.html b/doc/build/html/_modules/commands/patch.html index c265a07..a27fdaf 100644 --- a/doc/build/html/_modules/commands/patch.html +++ b/doc/build/html/_modules/commands/patch.html @@ -27,7 +27,7 @@ - + @@ -80,8 +80,8 @@ The patch command apply the patches on the sources of the application products if there is any. - examples: - >> sat patch SALOME --products qt,boost + | examples: + | >> sat patch SALOME --products qt,boost """ name = "patch" @@ -266,6 +266,8 @@ diff --git a/doc/build/html/_modules/commands/prepare.html b/doc/build/html/_modules/commands/prepare.html index 0a65cd5..d3818a8 100644 --- a/doc/build/html/_modules/commands/prepare.html +++ b/doc/build/html/_modules/commands/prepare.html @@ -27,7 +27,7 @@ - + @@ -78,8 +78,8 @@ The prepare command gets the sources of the application products and apply the patches if there is any. - examples: - >> sat prepare SALOME --products KERNEL,GUI + | examples: + | >> sat prepare SALOME --products KERNEL,GUI """ name = "prepare" @@ -265,6 +265,8 @@ diff --git a/doc/build/html/_modules/commands/profile.html b/doc/build/html/_modules/commands/profile.html index 9ff5faa..e1dc3d3 100644 --- a/doc/build/html/_modules/commands/profile.html +++ b/doc/build/html/_modules/commands/profile.html @@ -27,7 +27,7 @@ - + @@ -78,13 +78,13 @@ """\ The profile command creates default profile. - examples: - >> sat profile [PRODUCT] - >> sat profile --prefix (string) - >> sat profile --name (string) - >> sat profile --force - >> sat profile --version (string) - >> sat profile --slogan (string) + | examples: + | >> sat profile [PRODUCT] + | >> sat profile --prefix (string) + | >> sat profile --name (string) + | >> sat profile --force + | >> sat profile --version (string) + | >> sat profile --slogan (string) """ name = "profile" @@ -329,6 +329,8 @@ diff --git a/doc/build/html/_modules/commands/run.html b/doc/build/html/_modules/commands/run.html index 6104bf3..5b136e1 100644 --- a/doc/build/html/_modules/commands/run.html +++ b/doc/build/html/_modules/commands/run.html @@ -27,7 +27,7 @@ - + @@ -78,8 +78,8 @@ """\ The run command runs the application launcher with the given arguments. - examples: - >> sat run SALOME + | examples: + | >> sat run SALOME """ name = "run" @@ -165,6 +165,8 @@ diff --git a/doc/build/html/_modules/commands/script.html b/doc/build/html/_modules/commands/script.html index 8cc0183..7bfbc82 100644 --- a/doc/build/html/_modules/commands/script.html +++ b/doc/build/html/_modules/commands/script.html @@ -27,7 +27,7 @@ - + @@ -77,8 +77,8 @@ This is done only for the products that are constructed using a script (build_source : 'script'). Otherwise, nothing is done. - examples: - >> sat script SALOME --products Python,numpy + | examples: + | >> sat script SALOME --products Python,numpy """ name = "script" @@ -294,6 +294,8 @@ diff --git a/doc/build/html/_modules/commands/shell.html b/doc/build/html/_modules/commands/shell.html index a9007c8..9a57f59 100644 --- a/doc/build/html/_modules/commands/shell.html +++ b/doc/build/html/_modules/commands/shell.html @@ -27,7 +27,7 @@ - + @@ -77,8 +77,8 @@ """\ The shell command executes the shell command passed as argument. - examples: - >> sat shell --command 'ls -lt /tmp' + | examples: + | >> sat shell --command 'ls -lt /tmp' """ name = "shell" @@ -149,6 +149,8 @@ diff --git a/doc/build/html/_modules/commands/source.html b/doc/build/html/_modules/commands/source.html index 064a397..f2027bd 100644 --- a/doc/build/html/_modules/commands/source.html +++ b/doc/build/html/_modules/commands/source.html @@ -27,7 +27,7 @@ - + @@ -80,8 +80,8 @@ The source command gets the sources of the application products from cvs, git or an archive. - examples: - >> sat source SALOME --products KERNEL,GUI + | examples: + | >> sat source SALOME --products KERNEL,GUI """ name = "source" @@ -596,6 +596,8 @@ diff --git a/doc/build/html/_modules/commands/template.html b/doc/build/html/_modules/commands/template.html index 9ff6542..c5b3010 100644 --- a/doc/build/html/_modules/commands/template.html +++ b/doc/build/html/_modules/commands/template.html @@ -27,7 +27,7 @@ - + @@ -90,8 +90,8 @@ """ The template command creates the sources for a SALOME module from a template. - examples: - >> sat template --name my_product_name --template PythonComponent --target /tmp + | examples: + | >> sat template --name my_product_name --template PythonComponent --target /tmp """ name = "template" @@ -581,6 +581,8 @@ diff --git a/doc/build/html/_modules/commands/test.html b/doc/build/html/_modules/commands/test.html index eae4ada..1bbdb42 100644 --- a/doc/build/html/_modules/commands/test.html +++ b/doc/build/html/_modules/commands/test.html @@ -27,7 +27,7 @@ - + @@ -87,11 +87,11 @@ # Command class ########################################################################
[docs]class Command(_BaseCommand): - """\ + """ The test command runs a test base on a SALOME installation. - examples: - >> sat test SALOME --grid GEOM --session light + | examples: + | >> sat test SALOME --grid GEOM --session light """ name = "test" @@ -797,6 +797,8 @@ diff --git a/doc/build/html/_modules/index.html b/doc/build/html/_modules/index.html index 2f61f88..49f8ec2 100644 --- a/doc/build/html/_modules/index.html +++ b/doc/build/html/_modules/index.html @@ -43,6 +43,7 @@

All modules for which code is available

+
+
[docs]def format_color_exception(msg, limit=None, trace=None): + """ + Format a stack trace and the exception information. + as traceback.format_exception(), with color + with traceback only if (_debug) or (DBG._user in DBG._developpers) + """ + etype, value, tb = sys.exc_info() + if (_debug[-1]) or (_user in _developpers): + res = "<red>" + msg + if tb: + res += "\n<yellow>Traceback (most recent call last):\n" + res += "".join(traceback.format_tb(tb, limit)) #[:-1]) + res += "\n<red>" + res += "\n".join(traceback.format_exception_only(etype, value)) + return res+ "<reset>" + else: + res = "<red>" + msg # + "<bright>" + res += "".join(traceback.format_exception_only(etype, value)) + return res+ "<reset>"
+ + ############################################### # utilitaires divers pour debug ###############################################
[docs]class OutStream(SIO.StringIO): - """\ + """ utility class for pyconf.Config output iostream """
[docs] def close(self): - """\ + """ because Config.__save__ calls close() stream as file keep value before lost as self.value """ diff --git a/doc/build/html/_modules/src/options.html b/doc/build/html/_modules/src/options.html index 9fadb68..9a2a783 100644 --- a/doc/build/html/_modules/src/options.html +++ b/doc/build/html/_modules/src/options.html @@ -131,7 +131,7 @@ # in a list that contains dicts self.options = [] # The list of available option type - self.availableOptions = "boolean string int float long list list2, level".split() + self.availableOptions = "boolean string int float long list list2 level".split() self.default = None self.results = {} @@ -142,11 +142,9 @@ of an option and append it in the options field :param shortName: (str) - The short name of the option - (as '-l' for level option). + The short name of the option (as '-l' for level option). :param longName: (str) - The long name of the option - (as '--level' for level option). + The long name of the option (as '--level' for level option). :param optionType: (str) The type of the option (ex "int"). :param destName: (str) The name that will be used in the code. :param helpString: (str) @@ -165,8 +163,7 @@ option['longName'] = longName if optionType not in self.availableOptions: - print("error optionType", optionType, "not available.") - sys.exit(src.KOSYS) + raise Exception("error optionType '%s' not available." % optionType) option['optionType'] = optionType option['destName'] = destName diff --git a/doc/build/html/_modules/src/returnCode.html b/doc/build/html/_modules/src/returnCode.html index 356653b..977bbc8 100644 --- a/doc/build/html/_modules/src/returnCode.html +++ b/doc/build/html/_modules/src/returnCode.html @@ -65,6 +65,7 @@ """ This file contains ReturnCode class + usage: >> import returnCode as RCO """ @@ -73,30 +74,29 @@ #####################################################
[docs]class ReturnCode(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() usage: - >> import returnCode as RCO - - >> 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") - - >> rc = doSomething() - >> print("short returnCode string", str(rc)) - >> print("long returnCode string with value", repr(rc)) - - >> rc1 = RCO.ReturnCode("OK", ...) - >> rc2 = RCO.ReturnCode("KO", ...) - >> rcFinal = rc1 + rc2 - >> print("long returnCode string with value", repr(rcFinal)) # KO! + >> import returnCode as RCO + + >> 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") + + >> rc = doSomething() + >> print("short returnCode string", str(rc)) + >> print("long returnCode string with value", repr(rc)) + + >> rc1 = RCO.ReturnCode("OK", ...) + >> rc2 = RCO.ReturnCode("KO", ...) + >> rcFinal = rc1 + rc2 + >> print("long returnCode string with value", repr(rcFinal)) # KO! """ OK_STATUS = "OK" @@ -168,12 +168,14 @@ return strOrList
[docs] def toSys(self): + """return system return code as bash or bat""" try: return self._TOSYS[self._status] except: return self._TOSYS[self.NA_STATUS]
[docs] def getWhy(self): + """return why as str or list if sum or some ReturnCode""" return self._why
[docs] def setWhy(self, why): @@ -204,7 +206,13 @@ self._value = self._DEFAULT_VALUE
[docs] def isOk(self): - return (self._status == self.OK_STATUS)
+ """return True if ok""" + return (self._status == self.OK_STATUS)
+ +
[docs] def raiseIfKo(self): + """raise an exception with message why if not ok""" + if self.isOk(): return + raise Exception(self.getWhy())
diff --git a/doc/build/html/_modules/src/salomeTools.html b/doc/build/html/_modules/src/salomeTools.html index 4ea1fb5..8b71b82 100644 --- a/doc/build/html/_modules/src/salomeTools.html +++ b/doc/build/html/_modules/src/salomeTools.html @@ -63,7 +63,7 @@ # 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 NO __main__ entry allowed, use 'sat' (in parent directory) """ @@ -116,9 +116,8 @@ """ Parse files in dirPath that end with '.py' : it gives commands list - :param dirPath str: The directory path where to search the commands - :return: cmd_list : the list containing the commands name - :rtype: list + :param dirPath: (str) The directory path where to search the commands + :return: (list) the list containing the commands name """ cmd_list = [] for item in os.listdir(dirPath): @@ -137,11 +136,12 @@ return _COMMANDS_NAMES
[docs]def launchSat(command): - """\ - launch sat as subprocess popen + """ + launch sat as subprocess.Popen command as string ('sat --help' for example) used for unittest, or else... - returns tuple (stdout, stderr) + + :return: (stdout, stderr) tuple of subprocess.Popen output """ if "sat" not in command.split()[0]: raise Exception(_("Not a valid command for launchSat: '%s'") % command) @@ -295,13 +295,15 @@ method called when salomeTools have '--help' argument. returns The text to display for the command description which is current Command class docstring 'self.__doc__', - with traduction + with traduction, if done. + replace supposedly sphinx apidoc format ' | ' if present """ - return _(self.__doc__) + return _(self.__doc__.replace(" | ", " ")) # replace sphinx apidoc format def run(self, cmd_arguments): """ - method called when salomeTools processes command(s) parameters""" + method called when salomeTools processes command(s) parameters + """ raise Exception("_BaseCmd class have not to be instancied, useful only for inheritage") def print_help(self): @@ -330,13 +332,14 @@ # Sat class ########################################################################
[docs]class Sat(object): - """The main class that stores all the commands of salomeTools + """ + The main class that stores all the commands of salomeTools (usually known as 'runner' argument in Command classes) """ def __init__(self, logger): """Initialization - :param logger: The logger to use + :param logger: (Logger) The logger to use """ # Read the salomeTools prefixes options before the 'commands' tag @@ -450,7 +453,7 @@ return self._getModule(name)
[docs] def getCommandInstance(self, name): - """\ + """ returns inherited instance of Command(_BaseCmd) for command 'name' if module not loaded yet, load it. """ @@ -465,7 +468,7 @@
[docs] def execute_cli(self, 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) + :param cli_arguments: (str or list) The sat cli arguments (as sys.argv) """ args = self.assumeAsList(cli_arguments) diff --git a/doc/build/html/_modules/src/utilsSat.html b/doc/build/html/_modules/src/utilsSat.html index 403d5dd..b3f2222 100644 --- a/doc/build/html/_modules/src/utilsSat.html +++ b/doc/build/html/_modules/src/utilsSat.html @@ -84,6 +84,7 @@ import src.returnCode as RCO + ############################################################################## # file system utilities ############################################################################## @@ -397,7 +398,7 @@ ##############################################################################
[docs]def formatTuples(tuples): """ - format 'label = value' the tuples in a tabulated way. + Format 'label = value' the tuples in a tabulated way. :param tuples: (list) The list of tuples to format :return: (str) The tabulated text. (as mutiples lines) diff --git a/doc/build/html/apidoc_commands/commands.html b/doc/build/html/apidoc_commands/commands.html index 98993df..97414d0 100644 --- a/doc/build/html/apidoc_commands/commands.html +++ b/doc/build/html/apidoc_commands/commands.html @@ -156,8 +156,10 @@ avoid colors '<color>' for now in message

all the products of the application. It is possible to reduce the list of products to check by using the --products option

-

examples: ->> sat check SALOME --products KERNEL,GUI,GEOM

+
+
examples:
+
>> sat check SALOME --products KERNEL,GUI,GEOM
+
getParser()[source]¶
@@ -273,8 +275,10 @@ for the display and logging of the application products. Use the options to define what directories you want to suppress and to reduce the list of products

-

examples: ->> sat clean SALOME --build --install --properties is_salome_module:yes

+
+
examples:
+
>> sat clean SALOME --build --install --properties is_salome_module:yes
+
getParser()[source]¶
@@ -401,10 +405,10 @@ The logger instance to use for the display and logging class commands.compile.Command(runner)[source]¶

Bases: src.salomeTools._BaseCommand

The compile command constructs the products of the application

-
-
examples:
-
>> sat compile SALOME --products KERNEL,GUI,MEDCOUPLING --clean_all
-
+
+
examples:
+
>> sat compile SALOME --products KERNEL,GUI,MEDCOUPLING --clean_all
+
getParser()[source]¶
@@ -716,12 +720,17 @@ List of (str, Config) => (product_name, product_info)

The configure command executes in the build directory commands corresponding to the compilation mode of the application products. The possible compilation modes are 'cmake', 'autotools', or 'script'.

-

Here are the commands to be run: -autotools: >> build_configure and configure -cmake: >> cmake -script: (do nothing)

-

examples: ->> sat configure SALOME --products KERNEL,GUI,PARAVIS

+
+
Here are the commands to be run:
+
+
autotools: >> build_configure and configure
+
cmake: >> cmake
+
script: (do nothing)
+

+
+
examples:
+
>> sat configure SALOME --products KERNEL,GUI,PARAVIS
+
getParser()[source]¶
@@ -835,8 +844,10 @@ The logger instance to use for the display and logging class commands.environ.Command(runner)[source]¶

Bases: src.salomeTools._BaseCommand

The environ command generates the environment files of your application.

-

examples: ->> sat environ SALOME

+
+
examples:
+
>> sat environ SALOME
+
getParser()[source]¶
@@ -897,10 +908,10 @@ If True, do not print anything in the terminal

The find_duplicates command search recursively for all duplicates files in INSTALL directory (or the optionally given directory) and prints the found files to the terminal.

-
-
examples:
-
>> sat find_duplicates --path /tmp
-
+
+
examples:
+
>> sat find_duplicates --path /tmp
+
getParser()[source]¶
@@ -990,12 +1001,13 @@ and files_out is is the list of files

class commands.generate.Command(runner)[source]¶

Bases: src.salomeTools._BaseCommand

-

The generate command generates SALOME modules from 'pure cpp' products. -WARNING: this command NEEDS YACSGEN to run.

-
-
examples:
-
>> sat generate SALOME --products FLICACPP
-
+

The generate command generates SALOME modules from 'pure cpp' products.

+
+
warning: this command NEEDS YACSGEN to run.
+

+
examples:
+
>> sat generate SALOME --products FLICACPP
+
getParser()[source]¶
@@ -1166,8 +1178,8 @@ with value The path to yacsgen directory if ok

Bases: src.salomeTools._BaseCommand

The job command executes the commands of the job defined in the jobs configuration file -examples: ->> sat job --jobs_config my_jobs --name my_job"

+| examples: +| >> sat job --jobs_config my_jobs --name my_job"

getParser()[source]¶
@@ -1196,10 +1208,10 @@ examples:

Bases: src.salomeTools._BaseCommand

The jobs command command launches maintenances that are described in the dedicated jobs configuration file.

-
-
examples:
-
>> sat jobs --name my_jobs --publish
-
+
+
examples:
+
>> sat jobs --name my_jobs --publish
+
getParser()[source]¶
@@ -1921,8 +1933,10 @@ the config corresponding to the jos description class commands.launcher.Command(runner)[source]¶

Bases: src.salomeTools._BaseCommand

The launcher command generates a SALOME launcher.

-

examples: ->> sat launcher SALOME

+
+
examples:
+
>> sat launcher SALOME
+
getParser()[source]¶
@@ -2022,8 +2036,10 @@ The dict giving additional environment variables class commands.log.Command(runner)[source]¶

Bases: src.salomeTools._BaseCommand

The log command gives access to the logs produced by the salomeTools commands.

-

examples: ->> sat log

+
+
examples:
+
>> sat log
+
getParser()[source]¶
@@ -2144,8 +2160,10 @@ Get the last log command file path.

class commands.make.Command(runner)[source]¶

Bases: src.salomeTools._BaseCommand

The make command executes the 'make' command in the build directory.

-

examples: ->> sat make SALOME --products Python,KERNEL,GUI

+
+
examples:
+
>> sat make SALOME --products Python,KERNEL,GUI
+
getParser()[source]¶
@@ -2266,8 +2284,10 @@ The logger instance to use for the display and logging

The makeinstall command executes the 'make install' command in the build directory. In case of product constructed using a script (build_source : 'script'), then the makeinstall command do nothing.

-

examples: ->> sat makeinstall SALOME --products KERNEL,GUI

+
+
examples:
+
>> sat makeinstall SALOME --products KERNEL,GUI
+
getParser()[source]¶
@@ -2379,14 +2399,17 @@ The logger instance to use for the display and logging
class commands.package.Command(runner)[source]¶

Bases: src.salomeTools._BaseCommand

-

The package command creates an archive. -There are 4 kinds of archive, which can be mixed: -1- The binary archive. It contains all the product installation directories and a launcher. -2- The sources archive. It contains the products archives, a project corresponding to the application and salomeTools. -3- The project archive. It contains a project (give the project file path as argument). -4- The salomeTools archive. It contains salomeTools.

-

examples: ->> sat package SALOME --binaries --sources

+

The package command creates an archive.

+
+
There are 4 kinds of archive, which can be mixed:
+
1- The binary archive. It contains all the product installation directories and a launcher.
+
2- The sources archive. It contains the products archives, a project corresponding to the application and salomeTools.
+
3- The project archive. It contains a project (give the project file path as argument).
+
4- The salomeTools archive. It contains salomeTools.
+

+
examples:
+
>> sat package SALOME --binaries --sources
+
getParser()[source]¶
@@ -2874,8 +2897,10 @@ that have the property given as input.

Bases: src.salomeTools._BaseCommand

The patch command apply the patches on the sources of the application products if there is any.

-

examples: ->> sat patch SALOME --products qt,boost

+
+
examples:
+
>> sat patch SALOME --products qt,boost
+
getParser()[source]¶
@@ -2928,8 +2953,10 @@ The logger instance to use for the display and logging

Bases: src.salomeTools._BaseCommand

The prepare command gets the sources of the application products and apply the patches if there is any.

-

examples: ->> sat prepare SALOME --products KERNEL,GUI

+
+
examples:
+
>> sat prepare SALOME --products KERNEL,GUI
+
getParser()[source]¶
@@ -3017,13 +3044,15 @@ The logger instance to use for the display and logging class commands.profile.Command(runner)[source]¶

Bases: src.salomeTools._BaseCommand

The profile command creates default profile.

-

examples: ->> sat profile [PRODUCT] ->> sat profile --prefix (string) ->> sat profile --name (string) ->> sat profile --force ->> sat profile --version (string) ->> sat profile --slogan (string)

+
+
examples:
+
>> sat profile [PRODUCT]
+
>> sat profile --prefix (string)
+
>> sat profile --name (string)
+
>> sat profile --force
+
>> sat profile --version (string)
+
>> sat profile --slogan (string)
+
getParser()[source]¶
@@ -3085,10 +3114,10 @@ The logger instance to use for the display and logging class commands.run.Command(runner)[source]¶

Bases: src.salomeTools._BaseCommand

The run command runs the application launcher with the given arguments.

-
-
examples:
-
>> sat run SALOME
-
+
+
examples:
+
>> sat run SALOME
+
getParser()[source]¶
@@ -3118,10 +3147,12 @@ The logger instance to use for the display and logging

The script command executes the script(s) of the the given products in the build directory. This is done only for the products that are constructed using a script (build_source : 'script'). Otherwise, nothing is done.

-
-
examples:
-
>> sat script SALOME --products Python,numpy
-
+
+
examples:
+
+
>> sat script SALOME --products Python,numpy
+
+
getParser()[source]¶
@@ -3235,10 +3266,10 @@ The logger instance to use for the display and logging class commands.shell.Command(runner)[source]¶

Bases: src.salomeTools._BaseCommand

The shell command executes the shell command passed as argument.

-
-
examples:
-
>> sat shell --command 'ls -lt /tmp'
-
+
+
examples:
+
>> sat shell --command 'ls -lt /tmp'
+
getParser()[source]¶
@@ -3267,8 +3298,10 @@ The logger instance to use for the display and logging

Bases: src.salomeTools._BaseCommand

The source command gets the sources of the application products from cvs, git or an archive.

-

examples: ->> sat source SALOME --products KERNEL,GUI

+
+
examples:
+
>> sat source SALOME --products KERNEL,GUI
+
getParser()[source]¶
@@ -3527,8 +3560,10 @@ The environment to source when extracting. class commands.template.Command(runner)[source]¶

Bases: src.salomeTools._BaseCommand

The template command creates the sources for a SALOME module from a template.

-

examples: ->> sat template --name my_product_name --template PythonComponent --target /tmp

+
+
examples:
+
>> sat template --name my_product_name --template PythonComponent --target /tmp
+
getParser()[source]¶
@@ -3617,10 +3652,10 @@ The environment to source when extracting. class commands.test.Command(runner)[source]¶

Bases: src.salomeTools._BaseCommand

The test command runs a test base on a SALOME installation.

-
-
examples:
-
>> sat test SALOME --grid GEOM --session light
-
+
+
examples:
+
>> sat test SALOME --grid GEOM --session light
+
check_option(options)[source]¶
diff --git a/doc/build/html/apidoc_src/src.html b/doc/build/html/apidoc_src/src.html index 0f6c690..5df5c30 100644 --- a/doc/build/html/apidoc_src/src.html +++ b/doc/build/html/apidoc_src/src.html @@ -892,6 +892,14 @@ keep value before lost as self.value

+
+
+src.debug.format_color_exception(msg, limit=None, trace=None)[source]¶
+

Format a stack trace and the exception information. +as traceback.format_exception(), with color +with traceback only if (_debug) or (DBG._user in DBG._developpers)

+
+
src.debug.getLocalEnv()[source]¶
@@ -2646,11 +2654,9 @@ of an option and append it in the options field

Parameters:
  • shortName -- (str) -The short name of the option -(as '-l' for level option).
    • +The short name of the option (as '-l' for level option).
  • longName -- (str) -The long name of the option -(as '--level' for level option).
    • +The long name of the option (as '--level' for level option).
  • optionType -- (str) The type of the option (ex "int").
  • destName -- (str) The name that will be used in the code.
  • helpString -- (str) @@ -4071,8 +4077,8 @@ but where a "mismatch" is detected, returns "overwrite" inst

src.returnCode module¶

-

This file contains ReturnCode class -usage: +

This file contains ReturnCode class

+

usage: >> import returnCode as RCO

@@ -4082,9 +4088,8 @@ usage: 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()

-
-
usage:
-

>> import returnCode as RCO

+

usage: +>> import returnCode as RCO

>> aValue = doSomethingToReturn() >> return RCO.ReturnCode("KO", "there is no problem here", aValue) >> return RCO.ReturnCode("KO", "there is a problem here because etc", None) @@ -4093,12 +4098,10 @@ and optionnaly contains a return value as self.getValue()

>> rc = doSomething() >> print("short returnCode string", str(rc)) >> print("long returnCode string with value", repr(rc))

-

>> rc1 = RCO.ReturnCode("OK", ...) +

>> rc1 = RCO.ReturnCode("OK", ...) >> rc2 = RCO.ReturnCode("KO", ...) >> rcFinal = rc1 + rc2 >> print("long returnCode string with value", repr(rcFinal)) # KO!

-
-
KFSYS = 4¶
@@ -4167,7 +4170,8 @@ and optionnaly contains a return value as self.getValue()

getWhy()[source]¶
-
+

return why as str or list if sum or some ReturnCode

+
@@ -4178,7 +4182,14 @@ and optionnaly contains a return value as self.getValue()

isOk()[source]¶
-
+

return True if ok

+
+ +
+
+raiseIfKo()[source]¶
+

raise an exception with message why if not ok

+
@@ -4198,7 +4209,8 @@ and optionnaly contains a return value as self.getValue()

toSys()[source]¶
-
+

return system return code as bash or bat

+
@@ -4222,7 +4234,14 @@ NO __main__ entry allowed, use 'sat' (in parent directory)

execute_cli(cli_arguments)[source]¶

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)

+ +++ + + + +
Parameters:cli_arguments -- (str or list) The sat cli arguments (as sys.argv)
@@ -4298,11 +4317,9 @@ assume load if not done yet

-Parameters:str (dirPath) -- The directory path where to search the commands +Parameters:dirPath -- (str) The directory path where to search the commands -Returns:cmd_list : the list containing the commands name - -Return type:list +Returns:(list) the list containing the commands name @@ -4323,10 +4340,17 @@ assume load if not done yet

src.salomeTools.launchSat(command)[source]¶
-

launch sat as subprocess popen +

launch sat as subprocess.Popen command as string ('sat --help' for example) -used for unittest, or else... -returns tuple (stdout, stderr)

+used for unittest, or else...

+ +++ + + + +
Returns:(stdout, stderr) tuple of subprocess.Popen output
@@ -4834,7 +4858,7 @@ to add to all paths in lpath.

src.utilsSat.formatTuples(tuples)[source]¶
-

format 'label = value' the tuples in a tabulated way.

+

Format 'label = value' the tuples in a tabulated way.

diff --git a/doc/build/html/genindex.html b/doc/build/html/genindex.html index 1961aa9..d709893 100644 --- a/doc/build/html/genindex.html +++ b/doc/build/html/genindex.html @@ -1312,8 +1312,6 @@
findtext() (src.ElementTree.ElementTree method)
- - +
finish() (src.environment.SalomeEnviron method)
@@ -1340,6 +1338,8 @@
+
flush() (src.coloringSat.ColoringStream method)
@@ -1373,6 +1373,10 @@
+
format_color_exception() (in module src.debug) +
+ +
format_list_of_str() (in module commands.find_duplicates)
@@ -3155,6 +3159,10 @@
+
raiseIfKo() (src.returnCode.ReturnCode method) +
+ +
read() (src.pyconf.ConfigInputStream method)
diff --git a/doc/build/html/objects.inv b/doc/build/html/objects.inv index 1452326..3972db0 100644 Binary files a/doc/build/html/objects.inv and b/doc/build/html/objects.inv differ diff --git a/doc/build/html/searchindex.js b/doc/build/html/searchindex.js index 04bafc0..d54811a 100644 --- a/doc/build/html/searchindex.js +++ b/doc/build/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({envversion:49,filenames:["apidoc_commands/commands","apidoc_commands/modules","apidoc_src/modules","apidoc_src/src","apidoc_src/src.colorama","apidoc_src/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:{"":{commands:[0,0,0,"-"],src:[3,0,0,"-"]},"commands.application":{Command:[0,1,1,""],add_module_to_appli:[0,4,1,""],create_application:[0,4,1,""],create_config_file:[0,4,1,""],customize_app:[0,4,1,""],generate_application:[0,4,1,""],generate_catalog:[0,4,1,""],generate_launch_file:[0,4,1,""],get_SALOME_modules:[0,4,1,""],get_step:[0,4,1,""],make_alias:[0,4,1,""]},"commands.application.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.check":{Command:[0,1,1,""],check_all_products:[0,4,1,""],check_product:[0,4,1,""],get_products_list:[0,4,1,""],log_res_step:[0,4,1,""],log_step:[0,4,1,""]},"commands.check.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.clean":{Command:[0,1,1,""],get_build_directories:[0,4,1,""],get_install_directories:[0,4,1,""],get_source_directories:[0,4,1,""],product_has_dir:[0,4,1,""],suppress_directories:[0,4,1,""]},"commands.clean.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.compile":{Command:[0,1,1,""],add_compile_config_file:[0,4,1,""],check_dependencies:[0,4,1,""],compile_all_products:[0,4,1,""],compile_product:[0,4,1,""],compile_product_cmake_autotools:[0,4,1,""],compile_product_script:[0,4,1,""],extend_with_children:[0,4,1,""],extend_with_fathers:[0,4,1,""],get_children:[0,4,1,""],get_products_list:[0,4,1,""],get_recursive_children:[0,4,1,""],get_recursive_fathers:[0,4,1,""],log_res_step:[0,4,1,""],log_step:[0,4,1,""],sort_products:[0,4,1,""]},"commands.compile.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.config":{Command:[0,1,1,""]},"commands.config.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.configure":{Command:[0,1,1,""],configure_all_products:[0,4,1,""],configure_product:[0,4,1,""],get_products_list:[0,4,1,""],log_res_step:[0,4,1,""],log_step:[0,4,1,""]},"commands.configure.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.environ":{Command:[0,1,1,""],write_all_source_files:[0,4,1,""]},"commands.environ.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.find_duplicates":{Command:[0,1,1,""],Progress_bar:[0,1,1,""],format_list_of_str:[0,4,1,""],list_directory:[0,4,1,""]},"commands.find_duplicates.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.find_duplicates.Progress_bar":{display_value_progression:[0,2,1,""]},"commands.generate":{Command:[0,1,1,""],build_context:[0,4,1,""],check_module_generator:[0,4,1,""],check_yacsgen:[0,4,1,""],generate_component:[0,4,1,""],generate_component_list:[0,4,1,""]},"commands.generate.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.init":{Command:[0,1,1,""],check_path:[0,4,1,""],display_local_values:[0,4,1,""],set_local_value:[0,4,1,""]},"commands.init.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.job":{Command:[0,1,1,""]},"commands.job.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.jobs":{Command:[0,1,1,""],Gui:[0,1,1,""],Job:[0,1,1,""],Jobs:[0,1,1,""],Machine:[0,1,1,""],develop_factorized_jobs:[0,4,1,""],getParamiko:[0,4,1,""],get_config_file_path:[0,4,1,""]},"commands.jobs.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.jobs.Gui":{add_xml_board:[0,2,1,""],find_history:[0,2,1,""],find_test_log:[0,2,1,""],initialize_boards:[0,2,1,""],last_update:[0,2,1,""],parse_csv_boards:[0,2,1,""],put_jobs_not_today:[0,2,1,""],update_xml_file:[0,2,1,""],update_xml_files:[0,2,1,""],write_xml_file:[0,2,1,""],write_xml_files:[0,2,1,""]},"commands.jobs.Job":{cancel:[0,2,1,""],check_time:[0,2,1,""],get_log_files:[0,2,1,""],get_pids:[0,2,1,""],get_status:[0,2,1,""],has_begun:[0,2,1,""],has_failed:[0,2,1,""],has_finished:[0,2,1,""],is_running:[0,2,1,""],is_timeout:[0,2,1,""],kill_remote_process:[0,2,1,""],run:[0,2,1,""],time_elapsed:[0,2,1,""],total_duration:[0,2,1,""],write_results:[0,2,1,""]},"commands.jobs.Jobs":{cancel_dependencies_of_failing_jobs:[0,2,1,""],define_job:[0,2,1,""],determine_jobs_and_machines:[0,2,1,""],display_status:[0,2,1,""],find_job_that_has_name:[0,2,1,""],is_occupied:[0,2,1,""],run_jobs:[0,2,1,""],ssh_connection_all_machines:[0,2,1,""],str_of_length:[0,2,1,""],update_jobs_states_list:[0,2,1,""],write_all_results:[0,2,1,""]},"commands.jobs.Machine":{close:[0,2,1,""],connect:[0,2,1,""],copy_sat:[0,2,1,""],exec_command:[0,2,1,""],mkdir:[0,2,1,""],put_dir:[0,2,1,""],successfully_connected:[0,2,1,""],write_info:[0,2,1,""]},"commands.launcher":{Command:[0,1,1,""],copy_catalog:[0,4,1,""],generate_catalog:[0,4,1,""],generate_launch_file:[0,4,1,""]},"commands.launcher.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.log":{Command:[0,1,1,""],ask_value:[0,4,1,""],getMaxFormat:[0,4,1,""],get_last_log_file:[0,4,1,""],print_log_command_in_terminal:[0,4,1,""],remove_log_file:[0,4,1,""],show_last_logs:[0,4,1,""],show_product_last_logs:[0,4,1,""]},"commands.log.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.make":{Command:[0,1,1,""],get_nb_proc:[0,4,1,""],get_products_list:[0,4,1,""],log_res_step:[0,4,1,""],log_step:[0,4,1,""],make_all_products:[0,4,1,""],make_product:[0,4,1,""]},"commands.make.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.makeinstall":{Command:[0,1,1,""],get_products_list:[0,4,1,""],log_res_step:[0,4,1,""],log_step:[0,4,1,""],makeinstall_all_products:[0,4,1,""],makeinstall_product:[0,4,1,""]},"commands.makeinstall.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.package":{Command:[0,1,1,""],add_files:[0,4,1,""],add_readme:[0,4,1,""],add_salomeTools:[0,4,1,""],binary_package:[0,4,1,""],create_project_for_src_package:[0,4,1,""],exclude_VCS_and_extensions:[0,4,1,""],find_application_pyconf:[0,4,1,""],find_product_scripts_and_pyconf:[0,4,1,""],get_archives:[0,4,1,""],get_archives_vcs:[0,4,1,""],hack_for_distene_licence:[0,4,1,""],make_archive:[0,4,1,""],produce_install_bin_file:[0,4,1,""],produce_relative_env_files:[0,4,1,""],produce_relative_launcher:[0,4,1,""],product_appli_creation_script:[0,4,1,""],project_package:[0,4,1,""],source_package:[0,4,1,""],update_config:[0,4,1,""]},"commands.package.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.patch":{Command:[0,1,1,""],apply_patch:[0,4,1,""]},"commands.patch.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.prepare":{Command:[0,1,1,""],find_products_already_getted:[0,4,1,""],find_products_with_patchs:[0,4,1,""],remove_products:[0,4,1,""]},"commands.prepare.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.profile":{Command:[0,1,1,""],generate_profile_sources:[0,4,1,""],get_profile_name:[0,4,1,""],profileConfigReader:[0,1,1,""],profileReference:[0,1,1,""],update_pyconf:[0,4,1,""]},"commands.profile.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.profile.profileConfigReader":{parseMapping:[0,2,1,""]},"commands.run":{Command:[0,1,1,""]},"commands.run.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.script":{Command:[0,1,1,""],get_products_list:[0,4,1,""],log_res_step:[0,4,1,""],log_step:[0,4,1,""],run_script_all_products:[0,4,1,""],run_script_of_product:[0,4,1,""]},"commands.script.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.shell":{Command:[0,1,1,""]},"commands.shell.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.source":{Command:[0,1,1,""],check_sources:[0,4,1,""],get_all_product_sources:[0,4,1,""],get_product_sources:[0,4,1,""],get_source_for_dev:[0,4,1,""],get_source_from_archive:[0,4,1,""],get_source_from_cvs:[0,4,1,""],get_source_from_dir:[0,4,1,""],get_source_from_git:[0,4,1,""],get_source_from_svn:[0,4,1,""]},"commands.source.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.template":{Command:[0,1,1,""],TParam:[0,1,1,""],TemplateSettings:[0,1,1,""],get_dico_param:[0,4,1,""],get_template_info:[0,4,1,""],prepare_from_template:[0,4,1,""],search_template:[0,4,1,""]},"commands.template.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.template.TParam":{check_value:[0,2,1,""]},"commands.template.TemplateSettings":{check_file_for_substitution:[0,2,1,""],check_user_values:[0,2,1,""],get_parameters:[0,2,1,""],get_pyconf_parameters:[0,2,1,""],has_pyconf:[0,2,1,""]},"commands.test":{Command:[0,1,1,""],ask_a_path:[0,4,1,""],check_remote_machine:[0,4,1,""],create_test_report:[0,4,1,""],generate_history_xml_path:[0,4,1,""],move_test_results:[0,4,1,""],save_file:[0,4,1,""]},"commands.test.Command":{check_option:[0,2,1,""],getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"src.ElementTree":{Comment:[3,4,1,""],Element:[3,4,1,""],ElementTree:[3,1,1,""],PI:[3,4,1,""],ProcessingInstruction:[3,4,1,""],QName:[3,1,1,""],SubElement:[3,4,1,""],TreeBuilder:[3,1,1,""],XML:[3,4,1,""],XMLTreeBuilder:[3,1,1,""],dump:[3,4,1,""],fromstring:[3,4,1,""],iselement:[3,4,1,""],iterparse:[3,1,1,""],parse:[3,4,1,""],tostring:[3,4,1,""]},"src.ElementTree.ElementTree":{find:[3,2,1,""],findall:[3,2,1,""],findtext:[3,2,1,""],getiterator:[3,2,1,""],getroot:[3,2,1,""],parse:[3,2,1,""],write:[3,2,1,""]},"src.ElementTree.TreeBuilder":{close:[3,2,1,""],data:[3,2,1,""],end:[3,2,1,""],start:[3,2,1,""]},"src.ElementTree.XMLTreeBuilder":{close:[3,2,1,""],doctype:[3,2,1,""],feed:[3,2,1,""]},"src.ElementTree.iterparse":{next:[3,2,1,""]},"src.architecture":{get_distrib_version:[3,4,1,""],get_distribution:[3,4,1,""],get_nb_proc:[3,4,1,""],get_python_version:[3,4,1,""],get_user:[3,4,1,""],is_windows:[3,4,1,""]},"src.catchAll":{CatchAll:[3,1,1,""],dumper:[3,4,1,""],dumperType:[3,4,1,""],jsonDumps:[3,4,1,""]},"src.catchAll.CatchAll":{jsonDumps:[3,2,1,""]},"src.colorama":{ansi:[4,0,0,"-"],ansitowin32:[4,0,0,"-"],initialise:[4,0,0,"-"],win32:[4,0,0,"-"],winterm:[4,0,0,"-"]},"src.colorama.ansi":{AnsiBack:[4,1,1,""],AnsiCodes:[4,1,1,""],AnsiCursor:[4,1,1,""],AnsiFore:[4,1,1,""],AnsiStyle:[4,1,1,""],clear_line:[4,4,1,""],clear_screen:[4,4,1,""],code_to_chars:[4,4,1,""],set_title:[4,4,1,""]},"src.colorama.ansi.AnsiBack":{BLACK:[4,3,1,""],BLUE:[4,3,1,""],CYAN:[4,3,1,""],GREEN:[4,3,1,""],LIGHTBLACK_EX:[4,3,1,""],LIGHTBLUE_EX:[4,3,1,""],LIGHTCYAN_EX:[4,3,1,""],LIGHTGREEN_EX:[4,3,1,""],LIGHTMAGENTA_EX:[4,3,1,""],LIGHTRED_EX:[4,3,1,""],LIGHTWHITE_EX:[4,3,1,""],LIGHTYELLOW_EX:[4,3,1,""],MAGENTA:[4,3,1,""],RED:[4,3,1,""],RESET:[4,3,1,""],WHITE:[4,3,1,""],YELLOW:[4,3,1,""]},"src.colorama.ansi.AnsiCursor":{BACK:[4,2,1,""],DOWN:[4,2,1,""],FORWARD:[4,2,1,""],POS:[4,2,1,""],UP:[4,2,1,""]},"src.colorama.ansi.AnsiFore":{BLACK:[4,3,1,""],BLUE:[4,3,1,""],CYAN:[4,3,1,""],GREEN:[4,3,1,""],LIGHTBLACK_EX:[4,3,1,""],LIGHTBLUE_EX:[4,3,1,""],LIGHTCYAN_EX:[4,3,1,""],LIGHTGREEN_EX:[4,3,1,""],LIGHTMAGENTA_EX:[4,3,1,""],LIGHTRED_EX:[4,3,1,""],LIGHTWHITE_EX:[4,3,1,""],LIGHTYELLOW_EX:[4,3,1,""],MAGENTA:[4,3,1,""],RED:[4,3,1,""],RESET:[4,3,1,""],WHITE:[4,3,1,""],YELLOW:[4,3,1,""]},"src.colorama.ansi.AnsiStyle":{BRIGHT:[4,3,1,""],DIM:[4,3,1,""],NORMAL:[4,3,1,""],RESET_ALL:[4,3,1,""]},"src.colorama.ansitowin32":{AnsiToWin32:[4,1,1,""],StreamWrapper:[4,1,1,""],is_a_tty:[4,4,1,""],is_stream_closed:[4,4,1,""]},"src.colorama.ansitowin32.AnsiToWin32":{ANSI_CSI_RE:[4,3,1,""],ANSI_OSC_RE:[4,3,1,""],call_win32:[4,2,1,""],convert_ansi:[4,2,1,""],convert_osc:[4,2,1,""],extract_params:[4,2,1,""],get_win32_calls:[4,2,1,""],reset_all:[4,2,1,""],should_wrap:[4,2,1,""],write:[4,2,1,""],write_and_convert:[4,2,1,""],write_plain_text:[4,2,1,""]},"src.colorama.ansitowin32.StreamWrapper":{write:[4,2,1,""]},"src.colorama.initialise":{colorama_text:[4,4,1,""],deinit:[4,4,1,""],init:[4,4,1,""],reinit:[4,4,1,""],reset_all:[4,4,1,""],wrap_stream:[4,4,1,""]},"src.colorama.win32":{SetConsoleTextAttribute:[4,4,1,""],winapi_test:[4,4,1,""]},"src.colorama.winterm":{WinColor:[4,1,1,""],WinStyle:[4,1,1,""],WinTerm:[4,1,1,""]},"src.colorama.winterm.WinColor":{BLACK:[4,3,1,""],BLUE:[4,3,1,""],CYAN:[4,3,1,""],GREEN:[4,3,1,""],GREY:[4,3,1,""],MAGENTA:[4,3,1,""],RED:[4,3,1,""],YELLOW:[4,3,1,""]},"src.colorama.winterm.WinStyle":{BRIGHT:[4,3,1,""],BRIGHT_BACKGROUND:[4,3,1,""],NORMAL:[4,3,1,""]},"src.colorama.winterm.WinTerm":{back:[4,2,1,""],cursor_adjust:[4,2,1,""],erase_line:[4,2,1,""],erase_screen:[4,2,1,""],fore:[4,2,1,""],get_attrs:[4,2,1,""],get_position:[4,2,1,""],reset_all:[4,2,1,""],set_attrs:[4,2,1,""],set_console:[4,2,1,""],set_cursor_position:[4,2,1,""],set_title:[4,2,1,""],style:[4,2,1,""]},"src.coloringSat":{ColoringStream:[3,1,1,""],cleanColors:[3,4,1,""],indent:[3,4,1,""],log:[3,4,1,""],replace:[3,4,1,""],toColor:[3,4,1,""],toColor_AnsiToWin32:[3,4,1,""]},"src.coloringSat.ColoringStream":{flush:[3,2,1,""],write:[3,2,1,""]},"src.compilation":{Builder:[3,1,1,""]},"src.compilation.Builder":{build_configure:[3,2,1,""],check:[3,2,1,""],cmake:[3,2,1,""],complete_environment:[3,2,1,""],configure:[3,2,1,""],do_batch_script_build:[3,2,1,""],do_default_build:[3,2,1,""],do_python_script_build:[3,2,1,""],do_script_build:[3,2,1,""],hack_libtool:[3,2,1,""],install:[3,2,1,""],log:[3,2,1,""],log_command:[3,2,1,""],make:[3,2,1,""],prepare:[3,2,1,""],put_txt_log_in_appli_log_dir:[3,2,1,""],wmake:[3,2,1,""]},"src.configManager":{ConfigManager:[3,1,1,""],ConfigOpener:[3,1,1,""],check_path:[3,4,1,""],getConfigColored:[3,4,1,""],get_config_children:[3,4,1,""],get_products_list:[3,4,1,""],print_debug:[3,4,1,""],print_value:[3,4,1,""],show_patchs:[3,4,1,""],show_product_info:[3,4,1,""]},"src.configManager.ConfigManager":{create_config_file:[3,2,1,""],get_command_line_overrides:[3,2,1,""],get_config:[3,2,1,""],get_user_config_file:[3,2,1,""],set_user_config_file:[3,2,1,""]},"src.configManager.ConfigOpener":{get_path:[3,2,1,""]},"src.debug":{InStream:[3,1,1,""],OutStream:[3,1,1,""],getLocalEnv:[3,4,1,""],getStrConfigDbg:[3,4,1,""],getStrConfigStd:[3,4,1,""],indent:[3,4,1,""],pop_debug:[3,4,1,""],push_debug:[3,4,1,""],saveConfigDbg:[3,4,1,""],saveConfigStd:[3,4,1,""],tofix:[3,4,1,""],write:[3,4,1,""]},"src.debug.OutStream":{close:[3,2,1,""]},"src.environment":{Environ:[3,1,1,""],FileEnvWriter:[3,1,1,""],SalomeEnviron:[3,1,1,""],Shell:[3,1,1,""],load_environment:[3,4,1,""]},"src.environment.Environ":{append:[3,2,1,""],append_value:[3,2,1,""],command_value:[3,2,1,""],get:[3,2,1,""],is_defined:[3,2,1,""],prepend:[3,2,1,""],prepend_value:[3,2,1,""],set:[3,2,1,""]},"src.environment.FileEnvWriter":{write_cfgForPy_file:[3,2,1,""],write_env_file:[3,2,1,""]},"src.environment.SalomeEnviron":{add_comment:[3,2,1,""],add_line:[3,2,1,""],add_warning:[3,2,1,""],append:[3,2,1,""],dump:[3,2,1,""],finish:[3,2,1,""],get:[3,2,1,""],get_names:[3,2,1,""],is_defined:[3,2,1,""],load_cfg_environment:[3,2,1,""],prepend:[3,2,1,""],run_env_script:[3,2,1,""],run_simple_env_script:[3,2,1,""],set:[3,2,1,""],set_a_product:[3,2,1,""],set_application_env:[3,2,1,""],set_cpp_env:[3,2,1,""],set_full_environ:[3,2,1,""],set_products:[3,2,1,""],set_python_libdirs:[3,2,1,""],set_salome_generic_product_env:[3,2,1,""],set_salome_minimal_product_env:[3,2,1,""]},"src.environs":{print_grep_environs:[3,4,1,""],print_split_environs:[3,4,1,""],print_split_pattern_environs:[3,4,1,""]},"src.example":{essai_logging_1:[5,0,0,"-"],essai_logging_2:[5,0,0,"-"]},"src.example.essai_logging_1":{getMyLogger:[5,4,1,""],initMyLogger:[5,4,1,""],testLogger1:[5,4,1,""]},"src.example.essai_logging_2":{MyFormatter:[5,1,1,""],getMyLogger:[5,4,1,""],initMyLogger:[5,4,1,""],testLogger1:[5,4,1,""]},"src.example.essai_logging_2.MyFormatter":{format:[5,2,1,""]},"src.exceptionSat":{ExceptionSat:[3,5,1,""]},"src.fileEnviron":{BashFileEnviron:[3,1,1,""],BatFileEnviron:[3,1,1,""],ContextFileEnviron:[3,1,1,""],FileEnviron:[3,1,1,""],LauncherFileEnviron:[3,1,1,""],ScreenEnviron:[3,1,1,""],get_file_environ:[3,4,1,""],special_path_separator:[3,4,1,""]},"src.fileEnviron.BashFileEnviron":{command_value:[3,2,1,""],finish:[3,2,1,""],set:[3,2,1,""]},"src.fileEnviron.BatFileEnviron":{add_comment:[3,2,1,""],command_value:[3,2,1,""],finish:[3,2,1,""],get:[3,2,1,""],set:[3,2,1,""]},"src.fileEnviron.ContextFileEnviron":{add_echo:[3,2,1,""],add_warning:[3,2,1,""],append_value:[3,2,1,""],command_value:[3,2,1,""],finish:[3,2,1,""],get:[3,2,1,""],prepend_value:[3,2,1,""],set:[3,2,1,""]},"src.fileEnviron.FileEnviron":{add_comment:[3,2,1,""],add_echo:[3,2,1,""],add_line:[3,2,1,""],add_warning:[3,2,1,""],append:[3,2,1,""],append_value:[3,2,1,""],command_value:[3,2,1,""],finish:[3,2,1,""],get:[3,2,1,""],is_defined:[3,2,1,""],prepend:[3,2,1,""],prepend_value:[3,2,1,""],set:[3,2,1,""]},"src.fileEnviron.LauncherFileEnviron":{add:[3,2,1,""],add_comment:[3,2,1,""],add_echo:[3,2,1,""],add_line:[3,2,1,""],add_warning:[3,2,1,""],append:[3,2,1,""],append_value:[3,2,1,""],change_to_launcher:[3,2,1,""],command_value:[3,2,1,""],finish:[3,2,1,""],get:[3,2,1,""],is_defined:[3,2,1,""],prepend:[3,2,1,""],prepend_value:[3,2,1,""],set:[3,2,1,""]},"src.fileEnviron.ScreenEnviron":{add_comment:[3,2,1,""],add_echo:[3,2,1,""],add_line:[3,2,1,""],add_warning:[3,2,1,""],append:[3,2,1,""],command_value:[3,2,1,""],get:[3,2,1,""],is_defined:[3,2,1,""],prepend:[3,2,1,""],run_env_script:[3,2,1,""],set:[3,2,1,""],write:[3,2,1,""]},"src.fork":{batch:[3,4,1,""],batch_salome:[3,4,1,""],launch_command:[3,4,1,""],show_progress:[3,4,1,""],write_back:[3,4,1,""]},"src.loggingSat":{DefaultFormatter:[3,1,1,""],UnittestFormatter:[3,1,1,""],UnittestStream:[3,1,1,""],dirLogger:[3,4,1,""],getDefaultLogger:[3,4,1,""],getUnittestLogger:[3,4,1,""],indent:[3,4,1,""],indentUnittest:[3,4,1,""],initLoggerAsDefault:[3,4,1,""],initLoggerAsUnittest:[3,4,1,""],log:[3,4,1,""],testLogger_1:[3,4,1,""]},"src.loggingSat.DefaultFormatter":{format:[3,2,1,""],setColorLevelname:[3,2,1,""]},"src.loggingSat.UnittestFormatter":{format:[3,2,1,""]},"src.loggingSat.UnittestStream":{flush:[3,2,1,""],getLogs:[3,2,1,""],getLogsAndClear:[3,2,1,""],write:[3,2,1,""]},"src.options":{OptResult:[3,1,1,""],Options:[3,1,1,""]},"src.options.Options":{add_option:[3,2,1,""],debug_write:[3,2,1,""],getDetailOption:[3,2,1,""],get_help:[3,2,1,""],indent:[3,2,1,""],parse_args:[3,2,1,""]},"src.product":{check_config_exists:[3,4,1,""],check_installation:[3,4,1,""],get_base_install_dir:[3,4,1,""],get_install_dir:[3,4,1,""],get_product_components:[3,4,1,""],get_product_config:[3,4,1,""],get_product_dependencies:[3,4,1,""],get_product_section:[3,4,1,""],get_products_infos:[3,4,1,""],product_compiles:[3,4,1,""],product_has_env_script:[3,4,1,""],product_has_logo:[3,4,1,""],product_has_patches:[3,4,1,""],product_has_salome_gui:[3,4,1,""],product_has_script:[3,4,1,""],product_is_SALOME:[3,4,1,""],product_is_autotools:[3,4,1,""],product_is_cmake:[3,4,1,""],product_is_cpp:[3,4,1,""],product_is_debug:[3,4,1,""],product_is_dev:[3,4,1,""],product_is_fixed:[3,4,1,""],product_is_generated:[3,4,1,""],product_is_mpi:[3,4,1,""],product_is_native:[3,4,1,""],product_is_salome:[3,4,1,""],product_is_sample:[3,4,1,""],product_is_smesh_plugin:[3,4,1,""],product_is_vcs:[3,4,1,""]},"src.pyconf":{Config:[3,1,1,""],ConfigError:[3,5,1,""],ConfigFormatError:[3,5,1,""],ConfigInputStream:[3,1,1,""],ConfigList:[3,1,1,""],ConfigMerger:[3,1,1,""],ConfigOutputStream:[3,1,1,""],ConfigReader:[3,1,1,""],ConfigResolutionError:[3,5,1,""],Container:[3,1,1,""],Expression:[3,1,1,""],Mapping:[3,1,1,""],Reference:[3,1,1,""],Sequence:[3,1,1,""],deepCopyMapping:[3,4,1,""],defaultMergeResolve:[3,4,1,""],defaultStreamOpener:[3,4,1,""],isWord:[3,4,1,""],makePath:[3,4,1,""],overwriteMergeResolve:[3,4,1,""]},"src.pyconf.Config":{Namespace:[3,1,1,""],addNamespace:[3,2,1,""],getByPath:[3,2,1,""],load:[3,2,1,""],removeNamespace:[3,2,1,""]},"src.pyconf.ConfigInputStream":{close:[3,2,1,""],read:[3,2,1,""],readline:[3,2,1,""]},"src.pyconf.ConfigList":{getByPath:[3,2,1,""]},"src.pyconf.ConfigMerger":{handleMismatch:[3,2,1,""],merge:[3,2,1,""],mergeMapping:[3,2,1,""],mergeSequence:[3,2,1,""],overwriteKeys:[3,2,1,""]},"src.pyconf.ConfigOutputStream":{close:[3,2,1,""],flush:[3,2,1,""],write:[3,2,1,""]},"src.pyconf.ConfigReader":{getChar:[3,2,1,""],getToken:[3,2,1,""],load:[3,2,1,""],location:[3,2,1,""],match:[3,2,1,""],parseFactor:[3,2,1,""],parseKeyValuePair:[3,2,1,""],parseMapping:[3,2,1,""],parseMappingBody:[3,2,1,""],parseReference:[3,2,1,""],parseScalar:[3,2,1,""],parseSequence:[3,2,1,""],parseSuffix:[3,2,1,""],parseTerm:[3,2,1,""],parseValue:[3,2,1,""],setStream:[3,2,1,""]},"src.pyconf.Container":{evaluate:[3,2,1,""],setPath:[3,2,1,""],writeToStream:[3,2,1,""],writeValue:[3,2,1,""]},"src.pyconf.Expression":{evaluate:[3,2,1,""]},"src.pyconf.Mapping":{addMapping:[3,2,1,""],get:[3,2,1,""],iteritems:[3,2,1,""],iterkeys:[3,2,1,""],keys:[3,2,1,""],writeToStream:[3,2,1,""]},"src.pyconf.Reference":{addElement:[3,2,1,""],findConfig:[3,2,1,""],resolve:[3,2,1,""]},"src.pyconf.Sequence":{SeqIter:[3,1,1,""],append:[3,2,1,""],writeToStream:[3,2,1,""]},"src.pyconf.Sequence.SeqIter":{next:[3,2,1,""]},"src.returnCode":{ReturnCode:[3,1,1,""]},"src.returnCode.ReturnCode":{KFSYS:[3,3,1,""],KNOWNFAILURE_STATUS:[3,3,1,""],KOSYS:[3,3,1,""],KO_STATUS:[3,3,1,""],NASYS:[3,3,1,""],NA_STATUS:[3,3,1,""],NDSYS:[3,3,1,""],OKSYS:[3,3,1,""],OK_STATUS:[3,3,1,""],TIMEOUT_STATUS:[3,3,1,""],TOSYS:[3,3,1,""],UNKNOWN_STATUS:[3,3,1,""],getValue:[3,2,1,""],getWhy:[3,2,1,""],indent:[3,2,1,""],isOk:[3,2,1,""],setStatus:[3,2,1,""],setValue:[3,2,1,""],setWhy:[3,2,1,""],toSys:[3,2,1,""]},"src.salomeTools":{Sat:[3,1,1,""],assumeAsList:[3,4,1,""],find_command_list:[3,4,1,""],getCommandsList:[3,4,1,""],getVersion:[3,4,1,""],launchSat:[3,4,1,""],setLocale:[3,4,1,""],setNotLocale:[3,4,1,""]},"src.salomeTools.Sat":{assumeAsList:[3,2,1,""],execute_cli:[3,2,1,""],getColoredVersion:[3,2,1,""],getCommandAndAppli:[3,2,1,""],getCommandInstance:[3,2,1,""],getConfig:[3,2,1,""],getConfigManager:[3,2,1,""],getLogger:[3,2,1,""],getModule:[3,2,1,""],get_help:[3,2,1,""],parseArguments:[3,2,1,""],print_help:[3,2,1,""]},"src.system":{archive_extract:[3,4,1,""],cvs_extract:[3,4,1,""],git_extract:[3,4,1,""],show_in_editor:[3,4,1,""],svn_extract:[3,4,1,""]},"src.template":{MyTemplate:[3,1,1,""],substitute:[3,4,1,""]},"src.template.MyTemplate":{delimiter:[3,3,1,""],pattern:[3,3,1,""]},"src.test_module":{Test:[3,1,1,""],getTmpDirDEFAULT:[3,4,1,""]},"src.test_module.Test":{generate_launching_commands:[3,2,1,""],generate_script:[3,2,1,""],get_test_timeout:[3,2,1,""],get_tmp_dir:[3,2,1,""],prepare_testbase:[3,2,1,""],prepare_testbase_from_dir:[3,2,1,""],prepare_testbase_from_git:[3,2,1,""],prepare_testbase_from_svn:[3,2,1,""],read_results:[3,2,1,""],run_all_tests:[3,2,1,""],run_grid_tests:[3,2,1,""],run_script:[3,2,1,""],run_session_tests:[3,2,1,""],run_testbase_tests:[3,2,1,""],run_tests:[3,2,1,""],search_known_errors:[3,2,1,""],write_test_margin:[3,2,1,""]},"src.utilsSat":{Path:[3,1,1,""],black:[3,4,1,""],blue:[3,4,1,""],check_config_has_application:[3,4,1,""],check_config_has_profile:[3,4,1,""],config_has_application:[3,4,1,""],critical:[3,4,1,""],cyan:[3,4,1,""],date_to_datetime:[3,4,1,""],deepcopy_list:[3,4,1,""],ensure_path_exists:[3,4,1,""],error:[3,4,1,""],find_file_in_lpath:[3,4,1,""],formatTuples:[3,4,1,""],formatValue:[3,4,1,""],get_base_path:[3,4,1,""],get_cfg_param:[3,4,1,""],get_launcher_name:[3,4,1,""],get_log_path:[3,4,1,""],get_property_in_product_cfg:[3,4,1,""],get_salome_version:[3,4,1,""],get_tmp_filename:[3,4,1,""],green:[3,4,1,""],handleRemoveReadonly:[3,4,1,""],header:[3,4,1,""],info:[3,4,1,""],label:[3,4,1,""],list_log_file:[3,4,1,""],logger_info_tuples:[3,4,1,""],magenta:[3,4,1,""],merge_dicts:[3,4,1,""],normal:[3,4,1,""],only_numbers:[3,4,1,""],parse_date:[3,4,1,""],read_config_from_a_file:[3,4,1,""],red:[3,4,1,""],remove_item_from_list:[3,4,1,""],replace_in_file:[3,4,1,""],reset:[3,4,1,""],show_command_log:[3,4,1,""],success:[3,4,1,""],timedelta_total_seconds:[3,4,1,""],update_hat_xml:[3,4,1,""],warning:[3,4,1,""],white:[3,4,1,""],yellow:[3,4,1,""]},"src.utilsSat.Path":{base:[3,2,1,""],chmod:[3,2,1,""],copy:[3,2,1,""],copydir:[3,2,1,""],copyfile:[3,2,1,""],copylink:[3,2,1,""],dir:[3,2,1,""],exists:[3,2,1,""],isdir:[3,2,1,""],isfile:[3,2,1,""],islink:[3,2,1,""],list:[3,2,1,""],make:[3,2,1,""],readlink:[3,2,1,""],rm:[3,2,1,""],smartcopy:[3,2,1,""],symlink:[3,2,1,""]},"src.xmlManager":{ReadXmlFile:[3,1,1,""],XmlLogFile:[3,1,1,""],add_simple_node:[3,4,1,""],append_node_attrib:[3,4,1,""],find_node_by_attrib:[3,4,1,""],write_report:[3,4,1,""]},"src.xmlManager.ReadXmlFile":{getRootAttrib:[3,2,1,""],get_attrib:[3,2,1,""],get_node_text:[3,2,1,""]},"src.xmlManager.XmlLogFile":{add_simple_node:[3,2,1,""],append_node_attrib:[3,2,1,""],append_node_text:[3,2,1,""],write_tree:[3,2,1,""]},commands:{"package":[0,0,0,"-"],application:[0,0,0,"-"],check:[0,0,0,"-"],clean:[0,0,0,"-"],compile:[0,0,0,"-"],config:[0,0,0,"-"],configure:[0,0,0,"-"],environ:[0,0,0,"-"],find_duplicates:[0,0,0,"-"],generate:[0,0,0,"-"],init:[0,0,0,"-"],job:[0,0,0,"-"],jobs:[0,0,0,"-"],launcher:[0,0,0,"-"],log:[0,0,0,"-"],make:[0,0,0,"-"],makeinstall:[0,0,0,"-"],patch:[0,0,0,"-"],prepare:[0,0,0,"-"],profile:[0,0,0,"-"],run:[0,0,0,"-"],script:[0,0,0,"-"],shell:[0,0,0,"-"],source:[0,0,0,"-"],template:[0,0,0,"-"],test:[0,0,0,"-"]},src:{ElementTree:[3,0,0,"-"],architecture:[3,0,0,"-"],catchAll:[3,0,0,"-"],colorama:[4,0,0,"-"],coloringSat:[3,0,0,"-"],compilation:[3,0,0,"-"],configManager:[3,0,0,"-"],debug:[3,0,0,"-"],environment:[3,0,0,"-"],environs:[3,0,0,"-"],example:[5,0,0,"-"],exceptionSat:[3,0,0,"-"],fileEnviron:[3,0,0,"-"],fork:[3,0,0,"-"],loggingSat:[3,0,0,"-"],options:[3,0,0,"-"],product:[3,0,0,"-"],pyconf:[3,0,0,"-"],returnCode:[3,0,0,"-"],salomeTools:[3,0,0,"-"],system:[3,0,0,"-"],template:[3,0,0,"-"],test_module:[3,0,0,"-"],utilsSat:[3,0,0,"-"],xmlManager:[3,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","attribute","Python attribute"],"4":["py","function","Python function"],"5":["py","exception","Python exception"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:attribute","4":"py:function","5":"py:exception"},terms:{"16be":3,"16le":3,"9abc":3,"boolean":[0,3,21],"case":[0,3],"char":3,"class":[0,3,4,5,21],"default":[0,3,6,8,9,10,12,13,14,15,20],"else":3,"export":15,"final":[3,9,15],"float":[0,3],"function":[0,3,4,21],"import":[3,10,21],"int":[0,3,13],"long":[3,7],"new":[0,3,15,21],"return":[0,3,10,21],"short":3,"true":[0,3,4],"try":3,"var":3,__init__:[3,5],__main__:3,__repr__:3,__save__:3,__setattr__:3,__str__:3,_appli:6,_basecmd:3,_basecommand:0,_blank:3,_build:10,_debug:3,_launch:10,_ld_library_path:10,_sre:[3,4],_type:3,_verbos:3,a_b_c_:3,abool:3,about:[0,3,16],absolut:14,access:[3,4,13],account:10,act:[3,4],action:3,activ:[3,15],actual:[3,4,18],add:[3,8],add_com:3,add_compile_config_fil:0,add_echo:3,add_fil:0,add_lin:3,add_module_to_appli:0,add_opt:[3,21],add_readm:0,add_salometool:0,add_simple_nod:3,add_warn:3,add_xml_board:0,addelement:3,addit:[0,3,8,16],additional_dir:3,additional_env:[0,3],addmap:3,addnamespac:3,adequ:3,advanc:3,affect:4,afil:3,after:[0,8,18],again:3,agent:15,aim:3,algorithm:21,alia:3,alias_path:0,alistofstr:0,all:[0,3,4,7,9,10,11,15,16,20,21],allow:[0,3,8,9,11,17,20],alphanumer:3,alreadi:[0,14,21],also:[0,3,10,15,16,21],alter:15,amount:3,ani:[0,3,4,9,13,15],anoth:[3,16],ansi:[2,3],ansi_csi_re:4,ansi_escape_cod:4,ansi_osc_re:4,ansiback:4,ansicod:4,ansicursor:4,ansifor:4,ansistyl:4,ansitowin32:[2,3],anyth:0,apart:4,apath:3,api:3,append:[3,10,14],append_node_attrib:3,append_node_text:3,append_valu:3,appli:[0,3,9,11,15],appli_dir:0,appli_gen:0,appli_path:0,application:[3,6,9,12],application_nam:6,application_tmp_dir:0,applilog:3,apply_patch:0,appropri:3,arch:14,architectur:2,archiv:[0,3,14,15],archive_extract:3,archive_info:15,arg:[3,4,21],arglist:3,argument:[0,3],argv:3,arrai:0,ascii:3,asctim:5,ask:[0,3],ask_a_path:0,ask_valu:0,assign:3,assum:3,assumeaslist:3,astr:3,astream:3,atitl:3,attibut:3,attr:[3,4],attrib:3,attribut:[3,4],authent:15,author:3,automat:[3,9,10],autoreset:4,autotool:[0,3,8],avail:9,avalu:3,avari:3,avoid:[0,15],award:3,back:4,backend:3,backtick:3,bar:0,base:[3,4,5],basenam:3,bash:[0,3,10,15],bashfileenviron:3,basic:3,bat:[3,10],batch:3,batch_salom:3,batfileenviron:3,becaus:3,been:[0,3,4],befor:[0,3,8],begin:3,begun:0,behavior:21,belong:3,below:10,between:[0,3],bienvenu:3,big:8,bin:10,binari:[0,14],binaries_dir_nam:0,binary_packag:0,biraries:0,black:[3,4],block:[],blogmatrix:3,blue:[3,4],board:0,bom:3,bonjour:21,bool:[0,3],boost:0,both:[3,10,11],bracket:3,branch:15,bright:4,bright_background:4,bring:[11,15],browser:[0,3,9,13,16],buf:3,build:[3,7,8,10,16],build_conf_opt:3,build_configur:[0,3],build_context:0,build_sourc:[0,8],builder:3,built:3,caa:3,call:[0,3,4,10,12,21],call_win32:4,callabl:3,can:[0,3,6,10,15,16,17,21],cancel:0,cancel_dependencies_of_failing_job:0,cannot:3,car:3,care:7,carri:3,catalog:[0,6,12],catalog_path:0,catchall:2,cfg:[0,3,10,21],cfg_env:3,cfgforpi:3,chang:[0,3,6,20,21],change_to_launch:3,channel:0,channelfil:0,charact:[3,4],charg:12,check_all_product:0,check_config_exist:3,check_config_has_appl:3,check_config_has_profil:3,check_depend:0,check_file_for_substitut:0,check_instal:3,check_module_gener:0,check_opt:0,check_path:[0,3],check_product:0,check_remote_machin:0,check_sourc:0,check_src:3,check_tim:0,check_user_valu:0,check_valu:0,check_yacsgen:0,checkout:[0,3,15],children:3,chmod:3,choic:9,choosen:3,circumst:3,clash:3,classic:3,clean_al:[0,8,20],clean_build_aft:8,clean_instal:8,cleancolor:3,clear_lin:4,clear_screen:4,clearpag:[6,7,8,9,10,11,12,13,14,15,17,20,21],cli:[3,13,20],cli_:21,cli_argu:3,client:3,clone:15,close:[0,3],closest:3,cmake:[0,3,8],cmake_opt:8,cmd:3,cmd_argument:0,cmd_list:3,co7:14,code:[3,4,10],code_to_char:4,color:[0,3,4],colorama:[2,3],colorama_text:4,coloringsat:2,coloringstream:3,column:[0,3],com:[3,5],come:9,command_opt:20,command_valu:3,comment:[3,16],commentari:3,commit:7,commonli:3,compat:3,compil_script:8,compil_scripts_tmp_dir:0,compile_all_product:0,compile_product:0,compile_product_cmake_autotool:0,compile_product_script:0,complementari:10,complet:[3,8,9,15,16],complete_environ:3,compo:0,compo_nam:0,compon:[3,6,11],componon:11,compress:14,comput:[3,11,14],concaten:3,concern:15,conf_opt:0,conf_valu:0,config_fil:0,config_has_appl:3,config_job:0,configerror:3,configformaterror:3,configinputstream:3,configlist:3,configmanag:2,configmerg:3,configopen:3,configoutputstream:3,configread:[0,3],configresolutionerror:3,configure_all_product:0,configure_opt:3,configure_product:0,configut:6,conflict:3,conform:11,connect:0,consid:0,consist:3,consol:3,construct:[0,3,17,19],contain:[0,3,16,21],context:[0,3,20],contextfileenviron:3,continu:3,control:14,conveni:3,convert:4,convert_ansi:4,convert_osc:4,copi:[0,3,6,9,12,20],copy_catalog:0,copy_sat:0,copydir:3,copyfil:3,copylink:3,copyright:3,corba:11,correct:3,correctli:0,correl:3,correspond:[0,3,10,13,15],could:[0,3,7,10,18],cpp:[0,3,11],creat:[0,3,6,7,10,12,14,15,16,17],create_appl:0,create_config_fil:[0,3],create_project_for_src_packag:0,create_test_report:0,creation:14,critic:[3,5,21],critical:5,csv:0,current:[0,3,9,16,20,21],cursor_adjust:4,custom:[],customize_app:0,cvs:14,cvs_extract:3,cvs_info:15,cvspass:15,cwd:3,cyan:[3,4],d_content:0,d_input_board:0,d_sub:0,dai:[0,3],data:[0,3,9,21],datadir:3,date:[0,3,16],date_to_datetim:3,datefmt:[3,5],datetim:3,david:3,dbg:3,debug:2,debug_writ:3,decid:3,declar:15,dedic:0,deep:3,deepcopy_list:3,deepcopymap:3,def:[10,21],default_valu:3,defaultformatt:3,defaultmergeresolv:3,defaultstreamopen:3,defin:[0,3,7,8,9,10,11,16,21],define_job:0,definit:[0,3],deinit:4,delai:3,delaiapp:3,deleg:4,delet:[0,14],delimit:3,delta:3,depend:[0,3,8,14],deriv:3,describ:[0,3],descript:3,design:3,dest_path:0,destnam:3,detail:3,detar:18,detect:3,determin:3,determine_jobs_and_machin:0,dev:3,develop:[3,7,9,10,15],develop_factorized_job:0,dico:0,dict:[0,3],dict_arg:3,dictionari:[0,3,16],dictionnari:0,differ:[5,10],dim:4,dir:[0,3,9,15],dir_info:15,direct:3,directli:[10,13,18],directori:[0,3,6,7,8,9,10,12,13,14,15,16,18,20,21],directories_ignor:0,dirlogg:3,dirpath:3,displai:[0,3,8,9,13,21],display_local_valu:0,display_statu:0,display_value_progress:0,distant:6,disten:0,distinguish:10,distrib:3,distribut:[3,6,11],divis:3,do_batch_script_build:3,do_default_build:3,do_python_script_build:3,do_script_build:3,doc:[3,5],docstr:0,doctyp:3,document:[11,16],doe:[3,10,15],dog:3,dollar:3,don:11,done:[0,3,10,20],dosometh:3,dosomethingtoreturn:3,dot:3,dove:3,down:4,download:[3,15],dst:3,due:3,dump:3,dumper:3,dumpertyp:3,duplic:[0,8],durat:0,dure:15,dynam:[3,16],each:[0,3,6,12,15,16],earlier:3,earliest:3,echo:3,ecrir:[3,5],edf:0,edit:[0,9,15],editor:[3,9,16],either:[3,10],elaps:0,eleg:3,elem:3,element:[0,3],element_factori:3,elementari:3,elementtre:2,els:[0,3,21],embed:14,empti:3,enable_simple_env_script:3,enclos:3,encod:3,end:[0,3,4,10],english:3,ensure:3,ensure_path_exist:3,enter:0,entir:3,entri:3,env:[0,3,10],env_build:10,env_fil:0,env_info:[0,3],env_launch:10,env_script:10,env_scripts_tmp_dir:0,equal:8,eras:13,erase_lin:4,erase_screen:4,err:0,error:[0,3,5,21],essai:5,essai_logging_1:[2,3],essai_logging_2:[2,3],etc:[0,3,16,17],etre:[0,3],etree:3,eval:3,evalu:3,evaluat:3,event:3,everi:0,everyth:8,exactli:3,exampl:[2,3],exc:3,exceed:0,except:[3,15,20],exception:3,exceptionsat:2,exclud:0,exclude_vcs_and_extens:0,exec_command:0,execut:[0,3,8,15,20],execute_cli:3,exept:3,exhaust:[16,20],exist:[0,3,14,15,20],exot:3,expect:[0,3],explain:10,explan:3,explicitli:3,explor:3,explore:9,express:[3,9],expression:3,ext:3,extend_with_children:0,extend_with_fath:0,extens:[0,3,21],extension_ignor:0,extern:3,extra:[0,3],extract:[0,3],extract_param:4,f_exclud:0,fact:21,factor:3,factori:3,fail:[0,3,8],fals:[0,3,4],far:3,favorit:9,feed:3,field:[0,3],file:[0,3,6,8,9,10,12,13,14,15,16,17,21],file_:0,file_board:0,file_dir:0,file_in:3,file_nam:[0,3],file_path:3,fileenviron:2,fileenvwrit:3,filenam:[0,3],filepath:[0,3],files_arb_out:0,files_ignor:0,files_out:0,fill:0,filnam:0,filter:[0,7],fin:3,find:[0,3,9,17,18],find_application_pyconf:0,find_command_list:3,find_file_in_lpath:3,find_histori:0,find_job_that_has_nam:0,find_node_by_attrib:3,find_product_scripts_and_pyconf:0,find_products_already_get:0,find_products_with_patch:0,find_test_log:0,findal:3,findconfig:3,findtext:3,finish:[0,3],finish_statu:0,firefox:[13,16],first:[0,3,10,15,21],fix:[0,3],flag:8,flaglin:0,flicacpp:0,flush:3,fmt:[3,5],folder:0,follow:[3,10,21],for_packag:3,forbuild:3,forc:[0,3,14,15],force_patch:15,fore:4,fork:2,form:3,format:[0,3,5,10,16],format_list_of_str:0,formatt:[3,5],formattupl:3,formatvalu:3,forward:[4,6,12],found:[0,3],four:10,french:21,from:[0,3,4,9,10,11,14,15,21],from_what:3,fromstr:3,full:[0,3],fun:9,func:3,futur:3,gap:0,gdb:10,gencat:[6,12],generate_appl:0,generate_catalog:0,generate_compon:0,generate_component_list:0,generate_history_xml_path:0,generate_launch_fil:0,generate_launching_command:3,generate_profile_sourc:0,generate_script:3,generic_opt:20,geom:[0,8],get:[3,9,15,16],get_all_product_sourc:0,get_arch:0,get_archives_vc:0,get_attr:4,get_attrib:3,get_base_install_dir:3,get_base_path:3,get_build_directori:0,get_cfg_param:3,get_children:0,get_command_line_overrid:3,get_config:3,get_config_children:3,get_config_file_path:0,get_dico_param:0,get_distrib_vers:3,get_distribut:3,get_file_environ:3,get_help:3,get_install_dir:3,get_install_directori:0,get_last_log_fil:0,get_launcher_nam:3,get_log_fil:0,get_log_path:3,get_method:15,get_nam:3,get_nb_proc:[0,3],get_node_text:3,get_paramet:0,get_path:3,get_pid:0,get_posit:4,get_product_compon:3,get_product_config:3,get_product_depend:3,get_product_sect:3,get_product_sourc:0,get_products_info:3,get_products_list:[0,3],get_profile_nam:0,get_property_in_product_cfg:3,get_pyconf_paramet:0,get_python_vers:3,get_recursive_children:0,get_recursive_fath:0,get_salome_modul:0,get_salome_vers:3,get_source_directori:0,get_source_for_dev:0,get_source_from_arch:0,get_source_from_cv:0,get_source_from_dir:0,get_source_from_git:0,get_source_from_svn:0,get_statu:0,get_step:0,get_template_info:0,get_test_timeout:3,get_tmp_dir:3,get_tmp_filenam:3,get_us:3,get_user_config_fil:3,get_win32_cal:4,getbypath:3,getchar:3,getcoloredvers:3,getcommandandappli:3,getcommandinst:3,getcommandslist:3,getconfig:[3,21],getconfigcolor:3,getconfigmanag:3,getdefaultlogg:3,getdetailopt:3,getiter:3,getlocalenv:3,getlog:3,getlogg:3,getlogsandclear:3,getmaxformat:0,getmodul:3,getmylogg:5,getparamiko:0,getpars:0,getroot:3,getrootattrib:3,getstrconfigdbg:3,getstrconfigstd:3,gettmpdir:3,gettmpdirdefault:3,gettoken:3,getunittestlogg:3,getvalu:3,getvers:3,getwhi:3,git:[3,14],git_extract:3,git_info:15,gitconfig:15,give:[0,3,6,16,21],given:[0,3,4,6,10,12],global:[0,3],goe:3,green:[3,4],grep:[3,9],grey:4,grid:[0,3],gui:[0,3],hack_for_distene_lic:0,hack_libtool:3,had:3,handl:[3,4,10],handlemismatch:3,handler:[3,5],handleremovereadonli:3,harri:3,has_begun:0,has_fail:0,has_finish:0,has_gui:0,has_pyconf:0,has_salome_hui:3,has_timed_out:3,hat:3,have:[0,3,6,7,11,12,15],header:[0,3],help:3,helpstr:3,here:[0,3,10,16,21],hierarchi:3,himself:10,histori:0,hold:12,home:9,host:0,hostnam:0,hour:3,how:[3,10,15,16],html:[3,5],http:[3,4,5],human:3,hxx2salom:11,i18n:3,ident:[0,3],identifi:3,ignor:[0,3,11],ignore_exist:0,ignorelist:3,imag:15,implement:[3,4,10],in_dir:0,includ:[0,3,10,14,16],include:14,indent:3,indentunittest:3,index:3,indic:3,indirect:3,info:[0,3,5,9,15,21],inform:[0,3,9,14,15,16],inherit:3,initi:3,initialis:[2,3],initialize_board:0,initiat:0,initloggerasdefault:3,initloggerasunittest:3,initmylogg:5,inmap:3,input:[0,3],input_list:3,insid:15,instal:[0,3,7,8,16,18,20],install:[0,7,20],install_dir:10,installat:[],instanc:[0,3,4,21],instanti:0,instantiat:3,instead:3,instream:3,instruct:[3,16],intal:14,integ:0,interact:[0,13],interfac:[3,20],intern:3,internation:3,invalid:3,ioerror:3,iostream:3,is_a_tti:4,is_defin:3,is_dev:0,is_occupi:0,is_run:0,is_salome_modul:[0,7,10],is_stream_clos:4,is_timeout:0,is_window:3,isdir:3,isel:3,isfil:3,islink:3,isok:3,issu:4,isword:3,item:3,iter:3,iteritem:3,iterkei:3,iterpars:3,ivar:3,jane:3,job_config_nam:0,job_def:0,job_fil:0,job_file_path:0,jobs_config:0,join:10,json:3,jsondump:3,just:8,keep:3,kei:[0,3,10,15],kernel:[0,9,20],kfsys:3,kill:0,kill_remote_process:0,killsalom:3,kind:0,know:[3,15],known:[3,14],knownfailure_status:3,ko_status:3,kosys:3,kwarg:4,kwd:4,l_cfg_dir:0,l_job:0,l_jobs_not_todai:0,l_path:0,l_pinfo_vc:0,l_product:0,l_products_info:0,l_remote_log_fil:0,l_salome_modul:0,l_str:0,label:[0,3,9],lang:3,lapack:10,lapack_root_dir:10,last:[0,3,10,13],last_termin:13,last_upd:0,later:14,latter:3,launch:[0,3,10],launch_command:3,launched_cmd:3,launcher_nam:[0,12],launcherfileenviron:3,launchsat:3,layer:11,ld_library_path:10,left:10,len_col:0,len_end:0,lenght:0,lenght_column:0,length:0,less:3,level:[3,5,20],levelnam:[3,5],lib:[5,10],librari:[3,5],licenc:0,light:[0,4],lightblack_ex:4,lightblue_ex:4,lightcyan_ex:4,lightgreen_ex:4,lightmagenta_ex:4,lightred_ex:4,lightwhite_ex:4,lightyellow_ex:4,like:[0,3,4,6,8,9,12,16],line:[0,3,9,20],link:[0,3,15],list:[3,6,7,9,12,16],list_directori:0,list_log_fil:3,list_of_product:11,listtest:3,llvm:[6,12],load:[3,16],load_cfg_environ:3,load_environ:3,local:[0,3,9],locat:[0,3],log_command:3,log_dir:[0,13],log_res_step:0,log_step:0,logdir:[0,3],logfilepath:3,logger:[3,5],logger_info_tupl:3,loggingsat:2,login:15,logo:[3,12],logs:3,lome:17,longnam:3,lost:3,lpath:[0,3],lproduct:3,machin:[0,3,6,11,12,14],machine1:6,machine2:6,machine3:6,machine_nam:0,magenta:[3,4],mai:15,main:[0,3,8],mainten:0,make_alia:0,make_all_product:0,make_arch:0,make_flag:8,make_opt:[0,3],make_product:0,makeinstall_all_product:0,makeinstall_product:0,makepath:3,manag:[0,3,9,15],manipul:[0,3,9],map1:3,map2:3,map:[0,3],match:3,max:3,max_product_name_len:0,maximum:0,mechan:[3,10],med:8,medcoupling:0,memori:[3,6,12],menu:13,merg:3,merge:3,merge_dict:3,mergemap:3,mergesequ:3,mesa:[6,12],messag:[0,3,5,21],method:[0,3,4,8,10,15,21],milou:3,minim:3,minut:3,mismatch:3,miss:[6,8],mistak:15,mix:0,mkdir:0,mode:[3,4,7,9,10,13],model:21,modifi:[0,3,10,15],module_gener:0,module_path:0,moment:3,mon:3,mond:21,more:[0,3,20],most:[0,3,10],move_test_result:0,msg:3,multi:3,multilin:3,multipl:3,must:[0,21],mutipl:3,my_application_directori:6,my_application_nam:6,my_job:0,my_product_nam:0,my_tag:15,mycommand:21,myformatt:5,mylogg:5,myoption:21,myspecificnam:14,mytempl:3,na_status:3,name:[0,3,6,7,9,10,12,14,15,16,20,21],name_arch:0,name_job:0,name_nod:3,name_product:0,namespac:3,nasys:3,nativ:[0,3,10],nb_line:3,nb_proc:[0,3,8],ndsys:3,necessari:3,need:[0,3,4,6,11,15],needs:0,new_nam:9,newer:0,next:3,no_label:9,node:[0,3],node_nam:3,non:4,none:[0,3,4,5],nor:4,normal:[3,4],note:[3,6,10,12,16],noth:[0,3,14],notimplementederror:3,notion:3,notshowncommand:[0,3],now:0,number:[0,3,6,8,12,13],number_of_proc:3,numpi:0,obj1:3,obj2:3,obj:3,object:[0,3,4,16],obsolesc:0,obsolet:3,obsolete:21,obtain:3,obvious:3,occur:3,offset:0,ok_status:3,oksys:3,old:3,older:13,on_stderr:4,onc:15,one:3,onli:[0,3,6,7,8,9,10,11,12,13,15,20],only_numb:3,ool:17,open:3,openggl:[6,12],openmpi:3,oper:[0,3,9,17],operand:3,opt_nb_proc:3,option:2,optionali:3,optionn:3,optionnali:3,optiontyp:3,optresult:[0,3],order:[0,3,15,16,21],org:[3,4,5],other:[3,5,10,14,16],otherwis:[0,3,15],our:4,out:[0,3],out_dir:[0,3],output:[0,3,4],outstream:3,overrid:[3,6],overwrit:3,overwritekei:3,overwritemergeresolv:3,overwritten:3,own:3,p_info:0,p_name:0,p_name_info:0,p_name_p_info:0,pad:0,page:10,pair:[0,3],param:[3,4],param_def:0,param_nam:3,paramet:[0,3,9,16,21],parameter_path:9,paramiko:0,paramstr:4,paravi:[6,12],paraview:0,paravis:0,parent:[0,3],pars:[0,3,21],parse_arg:[3,21],parse_csv_board:0,parse_d:3,parseargu:3,parsefactor:3,parsekeyvaluepair:3,parsemap:[0,3],parsemappingbodi:3,parser:[3,21],parserefer:3,parsescalar:3,parsesequ:3,parsesuffix:3,parseterm:3,parsevalu:3,part:[3,6,10,12],particular:3,pass:[0,3,16,21],passphras:15,passwd:0,password:15,pat:3,patches_tmp_dir:0,path:3,path_in_arch:0,path_on_local_machin:0,path_to_catalog:6,path_to_check:0,path_to_yacsgen:11,pathlaunch:0,pathlist:3,paths:9,pattern:3,pdf:[9,17],pend:7,pendant:3,perform:[3,15,17],person:9,phase:3,pid:0,platform:[4,10],pleas:[10,11],plugin:[3,8],pluma:16,plusieur:5,point:[3,21],pop_debug:3,popen:3,popul:3,port:0,pos:4,posit:4,possibl:[0,3,10,15,21],post:3,potenti:3,pprty:3,preced:3,predefin:3,prefer:[9,16],prefix:[0,3,10,16],prepare_from_templ:0,prepare_testbas:3,prepare_testbase_from_dir:3,prepare_testbase_from_git:3,prepare_testbase_from_svn:3,prepend:[3,10],prepend_valu:3,prereq_dir:10,prerequisit:[10,14,16,17,20],presenc:3,present:3,pretti:3,previou:[0,3],previous:7,print:[0,3,4,9,13],print_debug:3,print_grep_environ:3,print_help:3,print_log_command_in_termin:0,print_split_environ:3,print_split_pattern_environ:3,print_valu:3,problem:[3,6,12],procedur:[0,3],process:[0,3,15],processinginstruct:3,processor:[0,3,6,12],prod_dir:3,prod_info:[0,3],prod_nam:0,produc:[0,3],produce_install_bin_fil:0,produce_relative_env_fil:0,produce_relative_launch:0,product1:[8,10,15],product2:[8,10,15],product:2,product_appli_creation_script:0,product_cfg:3,product_compil:3,product_has_dir:0,product_has_env_script:3,product_has_logo:3,product_has_patch:3,product_has_salome_gui:3,product_has_script:3,product_info:[0,3],product_inform:[0,3],product_is_autotool:3,product_is_cmak:3,product_is_cpp:3,product_is_debug:3,product_is_dev:3,product_is_fix:3,product_is_gener:3,product_is_mpi:3,product_is_n:3,product_is_salom:3,product_is_salome:3,product_is_sampl:3,product_is_smesh_plugin:3,product_is_vc:3,product_log_dir:0,product_nam:[0,3],products_info:0,products_pyconf_tmp_dir:0,profileconfigread:0,profilerefer:0,program:3,programmat:10,progress:[0,3],progress_bar:0,project:[0,3,9,10],project_file_path:0,project_packag:0,project_path:3,projects:3,prop:0,proper:0,properti:[0,3,7,10,11],protocol:[3,6],provid:[0,3,10,21],proxi:4,pubid:3,publish:0,pure:0,push:15,push_debug:3,put:[0,3],put_dir:0,put_jobs_not_todai:0,put_txt_log_in_appli_log_dir:3,pv_plugin_path:3,pwd:3,pyc:5,pyconf:2,python2:5,python:[0,3,5,10,12,16,17,18,21],python_config:3,pythoncompon:0,pythonpath:10,pythonpath_:10,qname:3,queri:[6,12],question:3,rais:[3,20],raw:3,raw_input:0,rc1:3,rc2:3,rcfinal:3,rco:[0,3],reach:0,read:[0,3],read_config_from_a_fil:3,read_result:3,readabl:3,reader:3,readi:15,readlin:3,readlink:3,readxmlfil:3,record:[3,5],recurs:[0,3,9],red:[3,4],redefin:3,redirect:3,reduc:0,ref:3,refer:[0,3,11,16],reflect:3,regard:[0,3],regular:3,reinit:[3,4],rel:[0,3,14],remain:[13,18],remark:6,remor:11,remot:[0,3,14],remov:[0,3,7,8,15],remove_item_from_list:3,remove_log_fil:0,remove_product:0,removenamespac:3,renam:3,renint:3,replac:[0,3,6],replace_in_fil:3,report:[0,3],repositori:[0,3,15],repr:3,repres:3,represent:3,request:4,requir:[3,4,10,11],reserv:3,reset:[3,4],reset_al:4,reset_all:4,resolut:3,resolv:3,resourc:[6,12],respect:10,restor:[3,7],result:[0,3],retcod:0,retriev:3,returncod:2,right:[0,3,10],root:[3,21],root_nod:3,rootnam:3,rtype:3,run_all_test:3,run_env_script:3,run_grid_test:3,run_job:0,run_script:3,run_script_all_product:0,run_script_of_product:0,run_session_test:3,run_simple_env_script:3,run_test:3,run_testbase_test:3,runappli:6,runner:[0,3,21],ruud:3,sajip:3,salom:[3,6,10,12],salome:[3,6,7,8,9,10,11,12,14,16,18],salome_modules:3,salome_session_serv:3,salome_xx:[7,14,18,20],salome_xx_:14,salomeapp:0,salomecontext:3,salomeenviron:3,salometool:2,same:[0,3],sametmax:[3,5],sampl:3,samples:20,sat:[3,6,7,8,9,10,11,12,13,14,15,16,18],sat_local_path:0,sat_path:0,save:10,save_fil:0,saveconfigdbg:3,saveconfigstd:3,scalar:3,scratch:3,screenenviron:3,script_nam:3,script_path:3,search:[0,3],search_known_error:3,search_templ:0,second:[0,3,10],section:[3,6,10,15],secur:15,see:[0,3,4,16,20],seen:3,select:[3,14],self:[0,3],semant:3,sep:[3,10],separ:3,seq1:3,seq2:3,seq:3,seqiter:3,sequenc:[3,4],server:[3,15],servic:21,session:[0,3],set:[0,3,6,7,10,12,16,17,21],set_a_product:3,set_application_env:3,set_attr:4,set_consol:4,set_cpp_env:3,set_cursor_posit:4,set_env:[3,10],set_env_build:10,set_env_launch:10,set_full_environ:3,set_local_valu:0,set_native_env:[3,10],set_product:3,set_python_libdir:3,set_salome_generic_product_env:3,set_salome_minimal_product_env:3,set_titl:4,set_user_config_fil:3,setcolorlevelnam:3,setconsoletextattribut:4,setlocal:3,setnotlocal:3,setpath:3,setstatu:3,setstream:3,settings_fil:0,setvalu:3,setwhi:3,sever:[0,10,16],shallow:3,shortcut:3,shortnam:3,should:[3,10,11],should_wrap:4,show:[0,3,8,13],show_command_log:3,show_desktop:3,show_full_path:3,show_in_editor:3,show_label:3,show_last_log:0,show_patch:[0,3,9],show_product_info:3,show_product_last_log:0,show_progress:3,show_warn:3,showinfo:3,shown:[3,8],sign:3,silent:[0,3],similar:3,simpl:[3,20,21],sinc:[0,3],site:0,size:[0,3],slogan:0,small:3,smart:3,smartcopi:3,smesh:3,softwar:15,some:3,someon:10,sometim:7,sommeil:3,soon:8,sort:0,sort_product:0,source_dir:0,source_packag:0,sourcepackag:0,sources:[7,15,20],sources_without_dev:7,space:3,special_path_separ:3,specif:[0,3,6,7,10,11,12,14,16,20],specifi:[3,6,10,11,12,15],splashscreen:12,split:3,src:[],src_root:[0,3],sre_pattern:[3,4],srsc:3,ssh:[0,6,12,15],ssh_connection_all_machin:0,stack:20,stackoverflow:3,start:[3,4,6,8,12],state:0,statu:[0,3],stderr:[0,3],stdin:0,stdout:[0,3,4],step:[0,3],stop:[0,8],stop_first_fail:8,store:[0,3,8,9,13,15,16],str:[0,3],str_in:3,str_num:3,str_of_length:0,str_out:3,stream:[0,3,4],streamopen:3,streamorfil:3,streamwrapp:4,strftime:[3,5],string:[0,3],stringio:3,strip:4,strorlist:3,structur:16,stuff:[3,12],style:[0,3,4],stylesheet:[0,3],sub:[0,3,16],subclass:3,subelement:3,subpackag:2,subprocess:3,subsect:10,subset:14,subst_dic:3,substitut:[0,3],substr:3,subtract:3,succe:0,success:[0,3,8],success_fail:0,successfulli:3,successfully_connect:0,suffici:10,suffix:[0,3],suit:17,suitabl:3,support:3,suppos:3,supposedli:3,suppress:[0,7],suppress_directori:0,sur:5,svn:[3,14],svn_extract:3,svn_info:15,symlink:3,syntax:[3,7],syss:3,system:2,tab:3,tabl:3,tabul:3,tag:[3,15],take:[0,3,7],taken:[3,10],tar:[0,14,18],tarfil:0,target:[0,3,6,10],target_dir:0,tcllibpath:3,template_fil:3,template_nam:0,templateset:0,temporari:0,term:3,termin:[0,3,4,8,13,21],test_bas:0,test_base_nam:3,test_config:3,test_grid:3,test_modul:2,test_nam:3,test_sess:3,testbas:3,testbase_bas:3,testbase_dir:3,testbase_nam:3,testbase_tag:3,testlogger1:5,testlogger_1:3,text:[0,3,4,20],text_or_uri:3,tgz:[14,18],thank:3,thei:[0,7,9,10,15],them:[4,15],thi:[0,3,4,6,8,9,10,11,12,14,15,16,17,21],thing:21,those:11,through:[3,6,10,12,13],thrown:3,time:[0,3,5,7,10,15,16],time_elaps:0,timedelta:3,timedelta_total_second:3,timeout:[0,3],timeout_status:3,tintin:3,tip:3,titl:[3,4],tklibpath:3,tmp:[0,3],tmp_working_dir:[0,3],tocolor:3,tocolor_ansitowin32:3,todai:0,todo:3,tofix:3,token:3,token_typ:3,token_valu:3,too:3,top:3,tosi:3,tostr:3,tosys:3,total:0,total_dur:0,total_second:3,tout:21,tparam:0,trace:[0,3,20],transform:[0,3],transpar:4,tree:3,treebuild:3,trust_root_dir:10,tty:4,tupl:[0,3],turn:3,tutori:3,two:[3,10],txt:3,type:[0,3,15],typeerror:3,unabl:3,unchang:3,unconditionali:[3,20],under:[0,3,17],underscor:[3,10],unicod:3,unit:8,unittest:3,unittestformatt:3,unitteststream:3,unix:3,unknown_status:3,unless:[4,15],updat:0,update:[0,3],update_config:0,update_hat_xml:3,update_jobs_states_list:0,update_pyconf:0,update_xml_fil:0,updatehatxml:3,upload:0,urllib2:3,urlopen:3,usag:[3,20],use:[0,6,7,8,9,10,11,12,15],use_mesa:[6,12],used:[0,3],useful:[3,20],user:[3,9,10,13,14],usernam:3,username:3,users:9,using:21,usr:[3,5,10],usual:[3,7,11,14,16,20],usualli:[14,18],utf:[3,10],util:[3,14,17],utilis:5,utiliti:3,utilssat:2,uts:3,val:0,valid:3,valmax:0,valmin:0,valu:[0,3,4,6,7,9,15,16],variabl:[0,3,10,11,21],vars:10,vcs:[7,14],verbos:3,verifi:[0,3,15],version:[0,3,10,11,14,16,17],via:3,viewer:9,vinai:3,virtual:[3,6],virtual_app:6,visualis:10,wai:[0,3,8,21],wait:0,want:[0,3,7,10],warn:[0,3,5,8,21],warning:[0,3,5],web:[9,13,16],week:0,welcom:3,welkom:3,well:3,were:3,what:[0,3,7],when:[0,3,6,10,15,16,21],whenev:3,where:[0,3,6,8,9,14],which:[0,3,4,10,11,16,21],white:[3,4],who:11,why:3,width:0,wiki:4,wikipedia:4,wil:10,win32:[2,3],winapi_test:4,wincolor:4,window:[3,4,10],winstyl:4,winterm:[2,3],with_children:8,with_commerci:[0,3],with_fath:8,with_install_dir:3,with_vc:[0,14],within:10,without:[3,9,15],without_dev:0,without_native_fix:0,without_properti:14,wmake:3,word:3,work:[0,3,9,14,15,16],workdir:[3,6,9,12,14,16,20,21],world:21,would:3,wrap:[3,4],wrap_stream:4,writabl:3,write:[0,3,4,21],write_all_result:0,write_all_source_fil:0,write_and_convert:4,write_back:3,write_cfgforpy_fil:3,write_env_fil:3,write_info:0,write_plain_text:4,write_report:3,write_result:0,write_test_margin:3,write_tre:3,write_xml_fil:0,writetostream:3,writevalu:3,written:21,www:3,xa4:3,xc2:3,xml:[0,3,21],xml_dir_path:0,xml_file:0,xml_history_path:0,xml_node_job:0,xmllogfil:[0,3],xmlmanag:2,xmlmgr:3,xmlname:0,xmlroot:3,xmltreebuild:3,xxx:[3,7,16],xxx_root_dir:3,xxx_src_dir:3,yacsgen:[0,3,11],yacsgen_root_dir:11,year:3,yellow:[3,4],yet:[3,20],yield:3,you:[0,3,6,7,10,12,15,17,21],your:[0,3,10,15,20,21],yourspecificnam:14,yve:3,yyy:16,yyyy:3,yyyymmdd_hhmmss:3,yyyymmdd_hhmmss_namecmd:3,zelaunch:12,zero:3,zerodivideerror:3},titles:["commands package","commands","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:21,add:21,ansi:4,ansitowin32:4,applic:[0,6],application:16,architectur:3,avail:20,availabl:7,base:15,basic:21,build:20,catchall:3,check:0,clean:[0,7],code:17,colorama:4,coloringsat:3,command:[0,1,6,7,8,9,10,11,12,13,14,15,17,21],compil:[0,3,8,20],config:[0,9,21],configmanag:3,configur:[0,6,7,8,9,10,12,13,14,15,16],content:[0,3,4,5],custom:21,debug:[3,20],descript:[6,7,8,9,10,11,12,13,14,15,16],dev:15,develop:17,document:17,elementtre:3,environ:[0,3,10],essai_logging_1:5,essai_logging_2:5,exampl:[5,21],exceptionsat:3,fileenviron:3,find_dupl:0,fork:3,gener:[0,11],get:20,git:15,hello:21,help:20,howto:21,init:0,initialis:4,installat:18,introduct:21,job:0,launcher:[0,12],list:[17,20],log:[0,13],logger:21,loggingsat:3,make:0,makeinstal:0,mode:15,modul:[0,3,4,5],note:[17,19],option:[3,7,20],other:21,packag:[0,3,4,5,14],patch:0,path:[6,7,8,9,13,14,15],prepar:[0,15,20],product:[3,20],products:16,profil:0,pyconf:3,quick:17,releas:[17,19],remark:[11,15],requir:21,returncod:3,run:0,salom:17,salome:20,salometool:[3,20,21],sat:20,script:0,section:16,shell:0,some:[6,7,8,9,13,14,15],sourc:[0,20],src:[2,3,4,5],start:17,submodul:[0,3,4,5],subpackag:3,svn:15,syntax:16,system:3,templat:[0,3],test:0,test_modul:3,tool:17,usage:[6,7,8,9,10,11,12,13,14,15,20],user:[16,21],utilssat:3,vars:16,vcs:15,verbos:20,win32:4,winterm:4,xmlmanag:3}}) \ No newline at end of file +Search.setIndex({envversion:49,filenames:["apidoc_commands/commands","apidoc_commands/modules","apidoc_src/modules","apidoc_src/src","apidoc_src/src.colorama","apidoc_src/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:{"":{commands:[0,0,0,"-"],src:[3,0,0,"-"]},"commands.application":{Command:[0,1,1,""],add_module_to_appli:[0,4,1,""],create_application:[0,4,1,""],create_config_file:[0,4,1,""],customize_app:[0,4,1,""],generate_application:[0,4,1,""],generate_catalog:[0,4,1,""],generate_launch_file:[0,4,1,""],get_SALOME_modules:[0,4,1,""],get_step:[0,4,1,""],make_alias:[0,4,1,""]},"commands.application.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.check":{Command:[0,1,1,""],check_all_products:[0,4,1,""],check_product:[0,4,1,""],get_products_list:[0,4,1,""],log_res_step:[0,4,1,""],log_step:[0,4,1,""]},"commands.check.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.clean":{Command:[0,1,1,""],get_build_directories:[0,4,1,""],get_install_directories:[0,4,1,""],get_source_directories:[0,4,1,""],product_has_dir:[0,4,1,""],suppress_directories:[0,4,1,""]},"commands.clean.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.compile":{Command:[0,1,1,""],add_compile_config_file:[0,4,1,""],check_dependencies:[0,4,1,""],compile_all_products:[0,4,1,""],compile_product:[0,4,1,""],compile_product_cmake_autotools:[0,4,1,""],compile_product_script:[0,4,1,""],extend_with_children:[0,4,1,""],extend_with_fathers:[0,4,1,""],get_children:[0,4,1,""],get_products_list:[0,4,1,""],get_recursive_children:[0,4,1,""],get_recursive_fathers:[0,4,1,""],log_res_step:[0,4,1,""],log_step:[0,4,1,""],sort_products:[0,4,1,""]},"commands.compile.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.config":{Command:[0,1,1,""]},"commands.config.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.configure":{Command:[0,1,1,""],configure_all_products:[0,4,1,""],configure_product:[0,4,1,""],get_products_list:[0,4,1,""],log_res_step:[0,4,1,""],log_step:[0,4,1,""]},"commands.configure.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.environ":{Command:[0,1,1,""],write_all_source_files:[0,4,1,""]},"commands.environ.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.find_duplicates":{Command:[0,1,1,""],Progress_bar:[0,1,1,""],format_list_of_str:[0,4,1,""],list_directory:[0,4,1,""]},"commands.find_duplicates.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.find_duplicates.Progress_bar":{display_value_progression:[0,2,1,""]},"commands.generate":{Command:[0,1,1,""],build_context:[0,4,1,""],check_module_generator:[0,4,1,""],check_yacsgen:[0,4,1,""],generate_component:[0,4,1,""],generate_component_list:[0,4,1,""]},"commands.generate.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.init":{Command:[0,1,1,""],check_path:[0,4,1,""],display_local_values:[0,4,1,""],set_local_value:[0,4,1,""]},"commands.init.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.job":{Command:[0,1,1,""]},"commands.job.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.jobs":{Command:[0,1,1,""],Gui:[0,1,1,""],Job:[0,1,1,""],Jobs:[0,1,1,""],Machine:[0,1,1,""],develop_factorized_jobs:[0,4,1,""],getParamiko:[0,4,1,""],get_config_file_path:[0,4,1,""]},"commands.jobs.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.jobs.Gui":{add_xml_board:[0,2,1,""],find_history:[0,2,1,""],find_test_log:[0,2,1,""],initialize_boards:[0,2,1,""],last_update:[0,2,1,""],parse_csv_boards:[0,2,1,""],put_jobs_not_today:[0,2,1,""],update_xml_file:[0,2,1,""],update_xml_files:[0,2,1,""],write_xml_file:[0,2,1,""],write_xml_files:[0,2,1,""]},"commands.jobs.Job":{cancel:[0,2,1,""],check_time:[0,2,1,""],get_log_files:[0,2,1,""],get_pids:[0,2,1,""],get_status:[0,2,1,""],has_begun:[0,2,1,""],has_failed:[0,2,1,""],has_finished:[0,2,1,""],is_running:[0,2,1,""],is_timeout:[0,2,1,""],kill_remote_process:[0,2,1,""],run:[0,2,1,""],time_elapsed:[0,2,1,""],total_duration:[0,2,1,""],write_results:[0,2,1,""]},"commands.jobs.Jobs":{cancel_dependencies_of_failing_jobs:[0,2,1,""],define_job:[0,2,1,""],determine_jobs_and_machines:[0,2,1,""],display_status:[0,2,1,""],find_job_that_has_name:[0,2,1,""],is_occupied:[0,2,1,""],run_jobs:[0,2,1,""],ssh_connection_all_machines:[0,2,1,""],str_of_length:[0,2,1,""],update_jobs_states_list:[0,2,1,""],write_all_results:[0,2,1,""]},"commands.jobs.Machine":{close:[0,2,1,""],connect:[0,2,1,""],copy_sat:[0,2,1,""],exec_command:[0,2,1,""],mkdir:[0,2,1,""],put_dir:[0,2,1,""],successfully_connected:[0,2,1,""],write_info:[0,2,1,""]},"commands.launcher":{Command:[0,1,1,""],copy_catalog:[0,4,1,""],generate_catalog:[0,4,1,""],generate_launch_file:[0,4,1,""]},"commands.launcher.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.log":{Command:[0,1,1,""],ask_value:[0,4,1,""],getMaxFormat:[0,4,1,""],get_last_log_file:[0,4,1,""],print_log_command_in_terminal:[0,4,1,""],remove_log_file:[0,4,1,""],show_last_logs:[0,4,1,""],show_product_last_logs:[0,4,1,""]},"commands.log.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.make":{Command:[0,1,1,""],get_nb_proc:[0,4,1,""],get_products_list:[0,4,1,""],log_res_step:[0,4,1,""],log_step:[0,4,1,""],make_all_products:[0,4,1,""],make_product:[0,4,1,""]},"commands.make.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.makeinstall":{Command:[0,1,1,""],get_products_list:[0,4,1,""],log_res_step:[0,4,1,""],log_step:[0,4,1,""],makeinstall_all_products:[0,4,1,""],makeinstall_product:[0,4,1,""]},"commands.makeinstall.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.package":{Command:[0,1,1,""],add_files:[0,4,1,""],add_readme:[0,4,1,""],add_salomeTools:[0,4,1,""],binary_package:[0,4,1,""],create_project_for_src_package:[0,4,1,""],exclude_VCS_and_extensions:[0,4,1,""],find_application_pyconf:[0,4,1,""],find_product_scripts_and_pyconf:[0,4,1,""],get_archives:[0,4,1,""],get_archives_vcs:[0,4,1,""],hack_for_distene_licence:[0,4,1,""],make_archive:[0,4,1,""],produce_install_bin_file:[0,4,1,""],produce_relative_env_files:[0,4,1,""],produce_relative_launcher:[0,4,1,""],product_appli_creation_script:[0,4,1,""],project_package:[0,4,1,""],source_package:[0,4,1,""],update_config:[0,4,1,""]},"commands.package.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.patch":{Command:[0,1,1,""],apply_patch:[0,4,1,""]},"commands.patch.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.prepare":{Command:[0,1,1,""],find_products_already_getted:[0,4,1,""],find_products_with_patchs:[0,4,1,""],remove_products:[0,4,1,""]},"commands.prepare.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.profile":{Command:[0,1,1,""],generate_profile_sources:[0,4,1,""],get_profile_name:[0,4,1,""],profileConfigReader:[0,1,1,""],profileReference:[0,1,1,""],update_pyconf:[0,4,1,""]},"commands.profile.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.profile.profileConfigReader":{parseMapping:[0,2,1,""]},"commands.run":{Command:[0,1,1,""]},"commands.run.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.script":{Command:[0,1,1,""],get_products_list:[0,4,1,""],log_res_step:[0,4,1,""],log_step:[0,4,1,""],run_script_all_products:[0,4,1,""],run_script_of_product:[0,4,1,""]},"commands.script.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.shell":{Command:[0,1,1,""]},"commands.shell.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.source":{Command:[0,1,1,""],check_sources:[0,4,1,""],get_all_product_sources:[0,4,1,""],get_product_sources:[0,4,1,""],get_source_for_dev:[0,4,1,""],get_source_from_archive:[0,4,1,""],get_source_from_cvs:[0,4,1,""],get_source_from_dir:[0,4,1,""],get_source_from_git:[0,4,1,""],get_source_from_svn:[0,4,1,""]},"commands.source.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.template":{Command:[0,1,1,""],TParam:[0,1,1,""],TemplateSettings:[0,1,1,""],get_dico_param:[0,4,1,""],get_template_info:[0,4,1,""],prepare_from_template:[0,4,1,""],search_template:[0,4,1,""]},"commands.template.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.template.TParam":{check_value:[0,2,1,""]},"commands.template.TemplateSettings":{check_file_for_substitution:[0,2,1,""],check_user_values:[0,2,1,""],get_parameters:[0,2,1,""],get_pyconf_parameters:[0,2,1,""],has_pyconf:[0,2,1,""]},"commands.test":{Command:[0,1,1,""],ask_a_path:[0,4,1,""],check_remote_machine:[0,4,1,""],create_test_report:[0,4,1,""],generate_history_xml_path:[0,4,1,""],move_test_results:[0,4,1,""],save_file:[0,4,1,""]},"commands.test.Command":{check_option:[0,2,1,""],getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"src.ElementTree":{Comment:[3,4,1,""],Element:[3,4,1,""],ElementTree:[3,1,1,""],PI:[3,4,1,""],ProcessingInstruction:[3,4,1,""],QName:[3,1,1,""],SubElement:[3,4,1,""],TreeBuilder:[3,1,1,""],XML:[3,4,1,""],XMLTreeBuilder:[3,1,1,""],dump:[3,4,1,""],fromstring:[3,4,1,""],iselement:[3,4,1,""],iterparse:[3,1,1,""],parse:[3,4,1,""],tostring:[3,4,1,""]},"src.ElementTree.ElementTree":{find:[3,2,1,""],findall:[3,2,1,""],findtext:[3,2,1,""],getiterator:[3,2,1,""],getroot:[3,2,1,""],parse:[3,2,1,""],write:[3,2,1,""]},"src.ElementTree.TreeBuilder":{close:[3,2,1,""],data:[3,2,1,""],end:[3,2,1,""],start:[3,2,1,""]},"src.ElementTree.XMLTreeBuilder":{close:[3,2,1,""],doctype:[3,2,1,""],feed:[3,2,1,""]},"src.ElementTree.iterparse":{next:[3,2,1,""]},"src.architecture":{get_distrib_version:[3,4,1,""],get_distribution:[3,4,1,""],get_nb_proc:[3,4,1,""],get_python_version:[3,4,1,""],get_user:[3,4,1,""],is_windows:[3,4,1,""]},"src.catchAll":{CatchAll:[3,1,1,""],dumper:[3,4,1,""],dumperType:[3,4,1,""],jsonDumps:[3,4,1,""]},"src.catchAll.CatchAll":{jsonDumps:[3,2,1,""]},"src.colorama":{ansi:[4,0,0,"-"],ansitowin32:[4,0,0,"-"],initialise:[4,0,0,"-"],win32:[4,0,0,"-"],winterm:[4,0,0,"-"]},"src.colorama.ansi":{AnsiBack:[4,1,1,""],AnsiCodes:[4,1,1,""],AnsiCursor:[4,1,1,""],AnsiFore:[4,1,1,""],AnsiStyle:[4,1,1,""],clear_line:[4,4,1,""],clear_screen:[4,4,1,""],code_to_chars:[4,4,1,""],set_title:[4,4,1,""]},"src.colorama.ansi.AnsiBack":{BLACK:[4,3,1,""],BLUE:[4,3,1,""],CYAN:[4,3,1,""],GREEN:[4,3,1,""],LIGHTBLACK_EX:[4,3,1,""],LIGHTBLUE_EX:[4,3,1,""],LIGHTCYAN_EX:[4,3,1,""],LIGHTGREEN_EX:[4,3,1,""],LIGHTMAGENTA_EX:[4,3,1,""],LIGHTRED_EX:[4,3,1,""],LIGHTWHITE_EX:[4,3,1,""],LIGHTYELLOW_EX:[4,3,1,""],MAGENTA:[4,3,1,""],RED:[4,3,1,""],RESET:[4,3,1,""],WHITE:[4,3,1,""],YELLOW:[4,3,1,""]},"src.colorama.ansi.AnsiCursor":{BACK:[4,2,1,""],DOWN:[4,2,1,""],FORWARD:[4,2,1,""],POS:[4,2,1,""],UP:[4,2,1,""]},"src.colorama.ansi.AnsiFore":{BLACK:[4,3,1,""],BLUE:[4,3,1,""],CYAN:[4,3,1,""],GREEN:[4,3,1,""],LIGHTBLACK_EX:[4,3,1,""],LIGHTBLUE_EX:[4,3,1,""],LIGHTCYAN_EX:[4,3,1,""],LIGHTGREEN_EX:[4,3,1,""],LIGHTMAGENTA_EX:[4,3,1,""],LIGHTRED_EX:[4,3,1,""],LIGHTWHITE_EX:[4,3,1,""],LIGHTYELLOW_EX:[4,3,1,""],MAGENTA:[4,3,1,""],RED:[4,3,1,""],RESET:[4,3,1,""],WHITE:[4,3,1,""],YELLOW:[4,3,1,""]},"src.colorama.ansi.AnsiStyle":{BRIGHT:[4,3,1,""],DIM:[4,3,1,""],NORMAL:[4,3,1,""],RESET_ALL:[4,3,1,""]},"src.colorama.ansitowin32":{AnsiToWin32:[4,1,1,""],StreamWrapper:[4,1,1,""],is_a_tty:[4,4,1,""],is_stream_closed:[4,4,1,""]},"src.colorama.ansitowin32.AnsiToWin32":{ANSI_CSI_RE:[4,3,1,""],ANSI_OSC_RE:[4,3,1,""],call_win32:[4,2,1,""],convert_ansi:[4,2,1,""],convert_osc:[4,2,1,""],extract_params:[4,2,1,""],get_win32_calls:[4,2,1,""],reset_all:[4,2,1,""],should_wrap:[4,2,1,""],write:[4,2,1,""],write_and_convert:[4,2,1,""],write_plain_text:[4,2,1,""]},"src.colorama.ansitowin32.StreamWrapper":{write:[4,2,1,""]},"src.colorama.initialise":{colorama_text:[4,4,1,""],deinit:[4,4,1,""],init:[4,4,1,""],reinit:[4,4,1,""],reset_all:[4,4,1,""],wrap_stream:[4,4,1,""]},"src.colorama.win32":{SetConsoleTextAttribute:[4,4,1,""],winapi_test:[4,4,1,""]},"src.colorama.winterm":{WinColor:[4,1,1,""],WinStyle:[4,1,1,""],WinTerm:[4,1,1,""]},"src.colorama.winterm.WinColor":{BLACK:[4,3,1,""],BLUE:[4,3,1,""],CYAN:[4,3,1,""],GREEN:[4,3,1,""],GREY:[4,3,1,""],MAGENTA:[4,3,1,""],RED:[4,3,1,""],YELLOW:[4,3,1,""]},"src.colorama.winterm.WinStyle":{BRIGHT:[4,3,1,""],BRIGHT_BACKGROUND:[4,3,1,""],NORMAL:[4,3,1,""]},"src.colorama.winterm.WinTerm":{back:[4,2,1,""],cursor_adjust:[4,2,1,""],erase_line:[4,2,1,""],erase_screen:[4,2,1,""],fore:[4,2,1,""],get_attrs:[4,2,1,""],get_position:[4,2,1,""],reset_all:[4,2,1,""],set_attrs:[4,2,1,""],set_console:[4,2,1,""],set_cursor_position:[4,2,1,""],set_title:[4,2,1,""],style:[4,2,1,""]},"src.coloringSat":{ColoringStream:[3,1,1,""],cleanColors:[3,4,1,""],indent:[3,4,1,""],log:[3,4,1,""],replace:[3,4,1,""],toColor:[3,4,1,""],toColor_AnsiToWin32:[3,4,1,""]},"src.coloringSat.ColoringStream":{flush:[3,2,1,""],write:[3,2,1,""]},"src.compilation":{Builder:[3,1,1,""]},"src.compilation.Builder":{build_configure:[3,2,1,""],check:[3,2,1,""],cmake:[3,2,1,""],complete_environment:[3,2,1,""],configure:[3,2,1,""],do_batch_script_build:[3,2,1,""],do_default_build:[3,2,1,""],do_python_script_build:[3,2,1,""],do_script_build:[3,2,1,""],hack_libtool:[3,2,1,""],install:[3,2,1,""],log:[3,2,1,""],log_command:[3,2,1,""],make:[3,2,1,""],prepare:[3,2,1,""],put_txt_log_in_appli_log_dir:[3,2,1,""],wmake:[3,2,1,""]},"src.configManager":{ConfigManager:[3,1,1,""],ConfigOpener:[3,1,1,""],check_path:[3,4,1,""],getConfigColored:[3,4,1,""],get_config_children:[3,4,1,""],get_products_list:[3,4,1,""],print_debug:[3,4,1,""],print_value:[3,4,1,""],show_patchs:[3,4,1,""],show_product_info:[3,4,1,""]},"src.configManager.ConfigManager":{create_config_file:[3,2,1,""],get_command_line_overrides:[3,2,1,""],get_config:[3,2,1,""],get_user_config_file:[3,2,1,""],set_user_config_file:[3,2,1,""]},"src.configManager.ConfigOpener":{get_path:[3,2,1,""]},"src.debug":{InStream:[3,1,1,""],OutStream:[3,1,1,""],format_color_exception:[3,4,1,""],getLocalEnv:[3,4,1,""],getStrConfigDbg:[3,4,1,""],getStrConfigStd:[3,4,1,""],indent:[3,4,1,""],pop_debug:[3,4,1,""],push_debug:[3,4,1,""],saveConfigDbg:[3,4,1,""],saveConfigStd:[3,4,1,""],tofix:[3,4,1,""],write:[3,4,1,""]},"src.debug.OutStream":{close:[3,2,1,""]},"src.environment":{Environ:[3,1,1,""],FileEnvWriter:[3,1,1,""],SalomeEnviron:[3,1,1,""],Shell:[3,1,1,""],load_environment:[3,4,1,""]},"src.environment.Environ":{append:[3,2,1,""],append_value:[3,2,1,""],command_value:[3,2,1,""],get:[3,2,1,""],is_defined:[3,2,1,""],prepend:[3,2,1,""],prepend_value:[3,2,1,""],set:[3,2,1,""]},"src.environment.FileEnvWriter":{write_cfgForPy_file:[3,2,1,""],write_env_file:[3,2,1,""]},"src.environment.SalomeEnviron":{add_comment:[3,2,1,""],add_line:[3,2,1,""],add_warning:[3,2,1,""],append:[3,2,1,""],dump:[3,2,1,""],finish:[3,2,1,""],get:[3,2,1,""],get_names:[3,2,1,""],is_defined:[3,2,1,""],load_cfg_environment:[3,2,1,""],prepend:[3,2,1,""],run_env_script:[3,2,1,""],run_simple_env_script:[3,2,1,""],set:[3,2,1,""],set_a_product:[3,2,1,""],set_application_env:[3,2,1,""],set_cpp_env:[3,2,1,""],set_full_environ:[3,2,1,""],set_products:[3,2,1,""],set_python_libdirs:[3,2,1,""],set_salome_generic_product_env:[3,2,1,""],set_salome_minimal_product_env:[3,2,1,""]},"src.environs":{print_grep_environs:[3,4,1,""],print_split_environs:[3,4,1,""],print_split_pattern_environs:[3,4,1,""]},"src.example":{essai_logging_1:[5,0,0,"-"],essai_logging_2:[5,0,0,"-"]},"src.example.essai_logging_1":{getMyLogger:[5,4,1,""],initMyLogger:[5,4,1,""],testLogger1:[5,4,1,""]},"src.example.essai_logging_2":{MyFormatter:[5,1,1,""],getMyLogger:[5,4,1,""],initMyLogger:[5,4,1,""],testLogger1:[5,4,1,""]},"src.example.essai_logging_2.MyFormatter":{format:[5,2,1,""]},"src.exceptionSat":{ExceptionSat:[3,5,1,""]},"src.fileEnviron":{BashFileEnviron:[3,1,1,""],BatFileEnviron:[3,1,1,""],ContextFileEnviron:[3,1,1,""],FileEnviron:[3,1,1,""],LauncherFileEnviron:[3,1,1,""],ScreenEnviron:[3,1,1,""],get_file_environ:[3,4,1,""],special_path_separator:[3,4,1,""]},"src.fileEnviron.BashFileEnviron":{command_value:[3,2,1,""],finish:[3,2,1,""],set:[3,2,1,""]},"src.fileEnviron.BatFileEnviron":{add_comment:[3,2,1,""],command_value:[3,2,1,""],finish:[3,2,1,""],get:[3,2,1,""],set:[3,2,1,""]},"src.fileEnviron.ContextFileEnviron":{add_echo:[3,2,1,""],add_warning:[3,2,1,""],append_value:[3,2,1,""],command_value:[3,2,1,""],finish:[3,2,1,""],get:[3,2,1,""],prepend_value:[3,2,1,""],set:[3,2,1,""]},"src.fileEnviron.FileEnviron":{add_comment:[3,2,1,""],add_echo:[3,2,1,""],add_line:[3,2,1,""],add_warning:[3,2,1,""],append:[3,2,1,""],append_value:[3,2,1,""],command_value:[3,2,1,""],finish:[3,2,1,""],get:[3,2,1,""],is_defined:[3,2,1,""],prepend:[3,2,1,""],prepend_value:[3,2,1,""],set:[3,2,1,""]},"src.fileEnviron.LauncherFileEnviron":{add:[3,2,1,""],add_comment:[3,2,1,""],add_echo:[3,2,1,""],add_line:[3,2,1,""],add_warning:[3,2,1,""],append:[3,2,1,""],append_value:[3,2,1,""],change_to_launcher:[3,2,1,""],command_value:[3,2,1,""],finish:[3,2,1,""],get:[3,2,1,""],is_defined:[3,2,1,""],prepend:[3,2,1,""],prepend_value:[3,2,1,""],set:[3,2,1,""]},"src.fileEnviron.ScreenEnviron":{add_comment:[3,2,1,""],add_echo:[3,2,1,""],add_line:[3,2,1,""],add_warning:[3,2,1,""],append:[3,2,1,""],command_value:[3,2,1,""],get:[3,2,1,""],is_defined:[3,2,1,""],prepend:[3,2,1,""],run_env_script:[3,2,1,""],set:[3,2,1,""],write:[3,2,1,""]},"src.fork":{batch:[3,4,1,""],batch_salome:[3,4,1,""],launch_command:[3,4,1,""],show_progress:[3,4,1,""],write_back:[3,4,1,""]},"src.loggingSat":{DefaultFormatter:[3,1,1,""],UnittestFormatter:[3,1,1,""],UnittestStream:[3,1,1,""],dirLogger:[3,4,1,""],getDefaultLogger:[3,4,1,""],getUnittestLogger:[3,4,1,""],indent:[3,4,1,""],indentUnittest:[3,4,1,""],initLoggerAsDefault:[3,4,1,""],initLoggerAsUnittest:[3,4,1,""],log:[3,4,1,""],testLogger_1:[3,4,1,""]},"src.loggingSat.DefaultFormatter":{format:[3,2,1,""],setColorLevelname:[3,2,1,""]},"src.loggingSat.UnittestFormatter":{format:[3,2,1,""]},"src.loggingSat.UnittestStream":{flush:[3,2,1,""],getLogs:[3,2,1,""],getLogsAndClear:[3,2,1,""],write:[3,2,1,""]},"src.options":{OptResult:[3,1,1,""],Options:[3,1,1,""]},"src.options.Options":{add_option:[3,2,1,""],debug_write:[3,2,1,""],getDetailOption:[3,2,1,""],get_help:[3,2,1,""],indent:[3,2,1,""],parse_args:[3,2,1,""]},"src.product":{check_config_exists:[3,4,1,""],check_installation:[3,4,1,""],get_base_install_dir:[3,4,1,""],get_install_dir:[3,4,1,""],get_product_components:[3,4,1,""],get_product_config:[3,4,1,""],get_product_dependencies:[3,4,1,""],get_product_section:[3,4,1,""],get_products_infos:[3,4,1,""],product_compiles:[3,4,1,""],product_has_env_script:[3,4,1,""],product_has_logo:[3,4,1,""],product_has_patches:[3,4,1,""],product_has_salome_gui:[3,4,1,""],product_has_script:[3,4,1,""],product_is_SALOME:[3,4,1,""],product_is_autotools:[3,4,1,""],product_is_cmake:[3,4,1,""],product_is_cpp:[3,4,1,""],product_is_debug:[3,4,1,""],product_is_dev:[3,4,1,""],product_is_fixed:[3,4,1,""],product_is_generated:[3,4,1,""],product_is_mpi:[3,4,1,""],product_is_native:[3,4,1,""],product_is_salome:[3,4,1,""],product_is_sample:[3,4,1,""],product_is_smesh_plugin:[3,4,1,""],product_is_vcs:[3,4,1,""]},"src.pyconf":{Config:[3,1,1,""],ConfigError:[3,5,1,""],ConfigFormatError:[3,5,1,""],ConfigInputStream:[3,1,1,""],ConfigList:[3,1,1,""],ConfigMerger:[3,1,1,""],ConfigOutputStream:[3,1,1,""],ConfigReader:[3,1,1,""],ConfigResolutionError:[3,5,1,""],Container:[3,1,1,""],Expression:[3,1,1,""],Mapping:[3,1,1,""],Reference:[3,1,1,""],Sequence:[3,1,1,""],deepCopyMapping:[3,4,1,""],defaultMergeResolve:[3,4,1,""],defaultStreamOpener:[3,4,1,""],isWord:[3,4,1,""],makePath:[3,4,1,""],overwriteMergeResolve:[3,4,1,""]},"src.pyconf.Config":{Namespace:[3,1,1,""],addNamespace:[3,2,1,""],getByPath:[3,2,1,""],load:[3,2,1,""],removeNamespace:[3,2,1,""]},"src.pyconf.ConfigInputStream":{close:[3,2,1,""],read:[3,2,1,""],readline:[3,2,1,""]},"src.pyconf.ConfigList":{getByPath:[3,2,1,""]},"src.pyconf.ConfigMerger":{handleMismatch:[3,2,1,""],merge:[3,2,1,""],mergeMapping:[3,2,1,""],mergeSequence:[3,2,1,""],overwriteKeys:[3,2,1,""]},"src.pyconf.ConfigOutputStream":{close:[3,2,1,""],flush:[3,2,1,""],write:[3,2,1,""]},"src.pyconf.ConfigReader":{getChar:[3,2,1,""],getToken:[3,2,1,""],load:[3,2,1,""],location:[3,2,1,""],match:[3,2,1,""],parseFactor:[3,2,1,""],parseKeyValuePair:[3,2,1,""],parseMapping:[3,2,1,""],parseMappingBody:[3,2,1,""],parseReference:[3,2,1,""],parseScalar:[3,2,1,""],parseSequence:[3,2,1,""],parseSuffix:[3,2,1,""],parseTerm:[3,2,1,""],parseValue:[3,2,1,""],setStream:[3,2,1,""]},"src.pyconf.Container":{evaluate:[3,2,1,""],setPath:[3,2,1,""],writeToStream:[3,2,1,""],writeValue:[3,2,1,""]},"src.pyconf.Expression":{evaluate:[3,2,1,""]},"src.pyconf.Mapping":{addMapping:[3,2,1,""],get:[3,2,1,""],iteritems:[3,2,1,""],iterkeys:[3,2,1,""],keys:[3,2,1,""],writeToStream:[3,2,1,""]},"src.pyconf.Reference":{addElement:[3,2,1,""],findConfig:[3,2,1,""],resolve:[3,2,1,""]},"src.pyconf.Sequence":{SeqIter:[3,1,1,""],append:[3,2,1,""],writeToStream:[3,2,1,""]},"src.pyconf.Sequence.SeqIter":{next:[3,2,1,""]},"src.returnCode":{ReturnCode:[3,1,1,""]},"src.returnCode.ReturnCode":{KFSYS:[3,3,1,""],KNOWNFAILURE_STATUS:[3,3,1,""],KOSYS:[3,3,1,""],KO_STATUS:[3,3,1,""],NASYS:[3,3,1,""],NA_STATUS:[3,3,1,""],NDSYS:[3,3,1,""],OKSYS:[3,3,1,""],OK_STATUS:[3,3,1,""],TIMEOUT_STATUS:[3,3,1,""],TOSYS:[3,3,1,""],UNKNOWN_STATUS:[3,3,1,""],getValue:[3,2,1,""],getWhy:[3,2,1,""],indent:[3,2,1,""],isOk:[3,2,1,""],raiseIfKo:[3,2,1,""],setStatus:[3,2,1,""],setValue:[3,2,1,""],setWhy:[3,2,1,""],toSys:[3,2,1,""]},"src.salomeTools":{Sat:[3,1,1,""],assumeAsList:[3,4,1,""],find_command_list:[3,4,1,""],getCommandsList:[3,4,1,""],getVersion:[3,4,1,""],launchSat:[3,4,1,""],setLocale:[3,4,1,""],setNotLocale:[3,4,1,""]},"src.salomeTools.Sat":{assumeAsList:[3,2,1,""],execute_cli:[3,2,1,""],getColoredVersion:[3,2,1,""],getCommandAndAppli:[3,2,1,""],getCommandInstance:[3,2,1,""],getConfig:[3,2,1,""],getConfigManager:[3,2,1,""],getLogger:[3,2,1,""],getModule:[3,2,1,""],get_help:[3,2,1,""],parseArguments:[3,2,1,""],print_help:[3,2,1,""]},"src.system":{archive_extract:[3,4,1,""],cvs_extract:[3,4,1,""],git_extract:[3,4,1,""],show_in_editor:[3,4,1,""],svn_extract:[3,4,1,""]},"src.template":{MyTemplate:[3,1,1,""],substitute:[3,4,1,""]},"src.template.MyTemplate":{delimiter:[3,3,1,""],pattern:[3,3,1,""]},"src.test_module":{Test:[3,1,1,""],getTmpDirDEFAULT:[3,4,1,""]},"src.test_module.Test":{generate_launching_commands:[3,2,1,""],generate_script:[3,2,1,""],get_test_timeout:[3,2,1,""],get_tmp_dir:[3,2,1,""],prepare_testbase:[3,2,1,""],prepare_testbase_from_dir:[3,2,1,""],prepare_testbase_from_git:[3,2,1,""],prepare_testbase_from_svn:[3,2,1,""],read_results:[3,2,1,""],run_all_tests:[3,2,1,""],run_grid_tests:[3,2,1,""],run_script:[3,2,1,""],run_session_tests:[3,2,1,""],run_testbase_tests:[3,2,1,""],run_tests:[3,2,1,""],search_known_errors:[3,2,1,""],write_test_margin:[3,2,1,""]},"src.utilsSat":{Path:[3,1,1,""],black:[3,4,1,""],blue:[3,4,1,""],check_config_has_application:[3,4,1,""],check_config_has_profile:[3,4,1,""],config_has_application:[3,4,1,""],critical:[3,4,1,""],cyan:[3,4,1,""],date_to_datetime:[3,4,1,""],deepcopy_list:[3,4,1,""],ensure_path_exists:[3,4,1,""],error:[3,4,1,""],find_file_in_lpath:[3,4,1,""],formatTuples:[3,4,1,""],formatValue:[3,4,1,""],get_base_path:[3,4,1,""],get_cfg_param:[3,4,1,""],get_launcher_name:[3,4,1,""],get_log_path:[3,4,1,""],get_property_in_product_cfg:[3,4,1,""],get_salome_version:[3,4,1,""],get_tmp_filename:[3,4,1,""],green:[3,4,1,""],handleRemoveReadonly:[3,4,1,""],header:[3,4,1,""],info:[3,4,1,""],label:[3,4,1,""],list_log_file:[3,4,1,""],logger_info_tuples:[3,4,1,""],magenta:[3,4,1,""],merge_dicts:[3,4,1,""],normal:[3,4,1,""],only_numbers:[3,4,1,""],parse_date:[3,4,1,""],read_config_from_a_file:[3,4,1,""],red:[3,4,1,""],remove_item_from_list:[3,4,1,""],replace_in_file:[3,4,1,""],reset:[3,4,1,""],show_command_log:[3,4,1,""],success:[3,4,1,""],timedelta_total_seconds:[3,4,1,""],update_hat_xml:[3,4,1,""],warning:[3,4,1,""],white:[3,4,1,""],yellow:[3,4,1,""]},"src.utilsSat.Path":{base:[3,2,1,""],chmod:[3,2,1,""],copy:[3,2,1,""],copydir:[3,2,1,""],copyfile:[3,2,1,""],copylink:[3,2,1,""],dir:[3,2,1,""],exists:[3,2,1,""],isdir:[3,2,1,""],isfile:[3,2,1,""],islink:[3,2,1,""],list:[3,2,1,""],make:[3,2,1,""],readlink:[3,2,1,""],rm:[3,2,1,""],smartcopy:[3,2,1,""],symlink:[3,2,1,""]},"src.xmlManager":{ReadXmlFile:[3,1,1,""],XmlLogFile:[3,1,1,""],add_simple_node:[3,4,1,""],append_node_attrib:[3,4,1,""],find_node_by_attrib:[3,4,1,""],write_report:[3,4,1,""]},"src.xmlManager.ReadXmlFile":{getRootAttrib:[3,2,1,""],get_attrib:[3,2,1,""],get_node_text:[3,2,1,""]},"src.xmlManager.XmlLogFile":{add_simple_node:[3,2,1,""],append_node_attrib:[3,2,1,""],append_node_text:[3,2,1,""],write_tree:[3,2,1,""]},commands:{"package":[0,0,0,"-"],application:[0,0,0,"-"],check:[0,0,0,"-"],clean:[0,0,0,"-"],compile:[0,0,0,"-"],config:[0,0,0,"-"],configure:[0,0,0,"-"],environ:[0,0,0,"-"],find_duplicates:[0,0,0,"-"],generate:[0,0,0,"-"],init:[0,0,0,"-"],job:[0,0,0,"-"],jobs:[0,0,0,"-"],launcher:[0,0,0,"-"],log:[0,0,0,"-"],make:[0,0,0,"-"],makeinstall:[0,0,0,"-"],patch:[0,0,0,"-"],prepare:[0,0,0,"-"],profile:[0,0,0,"-"],run:[0,0,0,"-"],script:[0,0,0,"-"],shell:[0,0,0,"-"],source:[0,0,0,"-"],template:[0,0,0,"-"],test:[0,0,0,"-"]},src:{ElementTree:[3,0,0,"-"],architecture:[3,0,0,"-"],catchAll:[3,0,0,"-"],colorama:[4,0,0,"-"],coloringSat:[3,0,0,"-"],compilation:[3,0,0,"-"],configManager:[3,0,0,"-"],debug:[3,0,0,"-"],environment:[3,0,0,"-"],environs:[3,0,0,"-"],example:[5,0,0,"-"],exceptionSat:[3,0,0,"-"],fileEnviron:[3,0,0,"-"],fork:[3,0,0,"-"],loggingSat:[3,0,0,"-"],options:[3,0,0,"-"],product:[3,0,0,"-"],pyconf:[3,0,0,"-"],returnCode:[3,0,0,"-"],salomeTools:[3,0,0,"-"],system:[3,0,0,"-"],template:[3,0,0,"-"],test_module:[3,0,0,"-"],utilsSat:[3,0,0,"-"],xmlManager:[3,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","attribute","Python attribute"],"4":["py","function","Python function"],"5":["py","exception","Python exception"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:attribute","4":"py:function","5":"py:exception"},terms:{"16be":3,"16le":3,"9abc":3,"boolean":[0,3,21],"case":[0,3],"char":3,"class":[0,3,4,5,21],"default":[0,3,6,8,9,10,12,13,14,15,20],"else":3,"export":15,"final":[3,9,15],"float":[0,3],"function":[0,3,4,21],"import":[3,10,21],"int":[0,3,13],"long":[3,7],"new":[0,3,15,21],"return":[0,3,10,21],"short":3,"true":[0,3,4],"try":3,"var":3,__init__:[3,5],__main__:3,__repr__:3,__save__:3,__setattr__:3,__str__:3,_appli:6,_basecmd:3,_basecommand:0,_blank:3,_build:10,_debug:3,_developp:3,_launch:10,_ld_library_path:10,_sre:[3,4],_type:3,_user:3,_verbos:3,a_b_c_:3,abool:3,about:[0,3,16],absolut:14,access:[4,13],account:10,act:[3,4],action:3,activ:[3,15],actual:[3,4,18],add:8,add_com:3,add_compile_config_fil:0,add_echo:3,add_fil:0,add_lin:3,add_module_to_appli:0,add_opt:[3,21],add_readm:0,add_salometool:0,add_simple_nod:3,add_warn:3,add_xml_board:0,addelement:3,addit:[0,3,8,16],additional_dir:3,additional_env:[0,3],addmap:3,addnamespac:3,adequ:3,advanc:3,affect:4,afil:3,after:[0,8,18],again:3,agent:15,aim:3,algorithm:21,alia:3,alias_path:0,alistofstr:0,all:[0,3,4,7,9,10,11,15,16,20,21],allow:[0,3,8,9,11,17,20],alphanumer:3,alreadi:[0,14,21],also:[0,3,10,15,16,21],alter:15,amount:3,ani:[0,3,4,9,13,15],anoth:[3,16],ansi:[],ansi_csi_re:4,ansi_escape_cod:4,ansi_osc_re:4,ansiback:4,ansicod:4,ansicursor:4,ansifor:4,ansistyl:4,ansitowin32:[],anyth:0,apart:4,apath:3,api:3,append:[3,10,14],append_node_attrib:3,append_node_text:3,append_valu:3,appli:[0,3,9,11,15],appli_dir:0,appli_gen:0,appli_path:0,application:[6,9,12],application_nam:6,application_tmp_dir:0,applilog:3,apply_patch:0,appropri:3,arch:14,architectur:[],archiv:[0,3,14,15],archive_extract:3,archive_info:15,arg:[3,4,21],arglist:3,argument:[0,3],argv:3,arrai:0,ascii:3,asctim:5,ask:[0,3],ask_a_path:0,ask_valu:0,assign:3,assum:3,assumeaslist:3,astr:3,astream:3,atitl:3,attibut:3,attr:[3,4],attrib:3,attribut:[3,4],authent:15,author:3,automat:[3,9,10],autoreset:4,autotool:[0,3,8],avail:9,avalu:3,avari:3,avoid:[0,15],award:3,back:4,backend:3,backtick:3,bar:0,base:[4,5],basenam:3,bash:[0,3,10,15],bashfileenviron:3,basic:[],bat:[3,10],batch:3,batch_salom:3,batfileenviron:3,becaus:3,been:[0,3,4],befor:[0,3,8],begin:3,begun:0,behavior:21,belong:3,below:10,between:[0,3],bienvenu:3,big:8,bin:10,binari:[0,14],binaries_dir_nam:0,binary_packag:0,biraries:0,black:[3,4],block:[],blogmatrix:3,blue:[3,4],board:0,bom:3,bonjour:21,bool:[0,3],boost:0,both:[3,10,11],bracket:3,branch:15,bright:4,bright_background:4,bring:[11,15],browser:[0,3,9,13,16],buf:3,build:[7,8,10,16],build_conf_opt:3,build_configur:[0,3],build_context:0,build_sourc:[0,8],builder:3,built:3,caa:3,call:[0,3,4,10,12,21],call_win32:4,callabl:3,can:[0,3,6,10,15,16,17,21],cancel:0,cancel_dependencies_of_failing_job:0,cannot:3,car:3,care:7,carri:3,catalog:[0,6,12],catalog_path:0,catchall:[],cfg:[0,3,10,21],cfg_env:3,cfgforpi:3,chang:[0,3,6,20,21],change_to_launch:3,channel:0,channelfil:0,charact:[3,4],charg:12,check_all_product:0,check_config_exist:3,check_config_has_appl:3,check_config_has_profil:3,check_depend:0,check_file_for_substitut:0,check_instal:3,check_module_gener:0,check_opt:0,check_path:[0,3],check_product:0,check_remote_machin:0,check_sourc:0,check_src:3,check_tim:0,check_user_valu:0,check_valu:0,check_yacsgen:0,checkout:[0,3,15],children:3,chmod:3,choic:9,choosen:3,circumst:3,clash:3,classic:3,clean_al:[0,8,20],clean_build_aft:8,clean_instal:8,cleancolor:3,clear_lin:4,clear_screen:4,clearpag:[6,7,8,9,10,11,12,13,14,15,17,20,21],cli:[3,13,20],cli_:21,cli_argu:3,client:3,clone:15,close:[0,3],closest:3,cmake:[0,3,8],cmake_opt:8,cmd:3,cmd_argument:0,cmd_list:[],co7:14,code:[4,10],code_to_char:4,color:[0,3,4],colorama:[],colorama_text:4,coloringsat:[],coloringstream:3,column:[0,3],com:[3,5],come:9,command_opt:20,command_valu:3,comment:[3,16],commentari:3,commit:7,commonli:3,compat:3,compil_script:8,compil_scripts_tmp_dir:0,compile_all_product:0,compile_product:0,compile_product_cmake_autotool:0,compile_product_script:0,complementari:10,complet:[3,8,9,15,16],complete_environ:3,compo:0,compo_nam:0,compon:[3,6,11],componon:11,compress:14,comput:[3,11,14],concaten:3,concern:15,conf_opt:0,conf_valu:0,config_fil:0,config_has_appl:3,config_job:0,configerror:3,configformaterror:3,configinputstream:3,configlist:3,configmanag:[],configmerg:3,configopen:3,configoutputstream:3,configread:[0,3],configresolutionerror:3,configure_all_product:0,configure_opt:3,configure_product:0,configut:6,conflict:3,conform:11,connect:0,consid:0,consist:3,consol:3,construct:[0,3,17,19],contain:[0,3,16,21],context:[0,3,20],contextfileenviron:3,continu:3,control:14,conveni:3,convert:4,convert_ansi:4,convert_osc:4,copi:[0,3,6,9,12,20],copy_catalog:0,copy_sat:0,copydir:3,copyfil:3,copylink:3,copyright:3,corba:11,correct:3,correctli:0,correl:3,correspond:[0,3,10,13,15],could:[0,3,7,10,18],cpp:[0,3,11],creat:[0,3,6,7,10,12,14,15,16,17],create_appl:0,create_config_fil:[0,3],create_project_for_src_packag:0,create_test_report:0,creation:14,critic:[3,5,21],critical:5,csv:0,current:[0,3,9,16,20,21],cursor_adjust:4,custom:[],customize_app:0,cvs:14,cvs_extract:3,cvs_info:15,cvspass:15,cwd:3,cyan:[3,4],d_content:0,d_input_board:0,d_sub:0,dai:[0,3],data:[0,3,9,21],datadir:3,date:[0,3,16],date_to_datetim:3,datefmt:[3,5],datetim:3,david:3,dbg:3,debug:[],debug_writ:3,decid:3,declar:15,dedic:0,deep:3,deepcopy_list:3,deepcopymap:3,def:[10,21],default_valu:3,defaultformatt:3,defaultmergeresolv:3,defaultstreamopen:3,defin:[0,3,7,8,9,10,11,16,21],define_job:0,definit:[0,3],deinit:4,delai:3,delaiapp:3,deleg:4,delet:[0,14],delimit:3,delta:3,depend:[0,3,8,14],deriv:3,describ:[0,3],descript:[],design:3,dest_path:0,destnam:3,detail:3,detar:18,detect:3,determin:3,determine_jobs_and_machin:0,dev:[],develop:[7,9,10,15],develop_factorized_job:0,dico:0,dict:[0,3],dict_arg:3,dictionari:[0,3,16],dictionnari:0,differ:[5,10],dim:4,dir:[0,3,9,15],dir_info:15,direct:3,directli:[10,13,18],directori:[0,3,6,7,8,9,10,12,13,14,15,16,18,20,21],directories_ignor:0,dirlogg:3,dirpath:3,displai:[0,3,8,9,13,21],display_local_valu:0,display_statu:0,display_value_progress:0,distant:6,disten:0,distinguish:10,distrib:3,distribut:[3,6,11],divis:3,do_batch_script_build:3,do_default_build:3,do_python_script_build:3,do_script_build:3,doc:[3,5],docstr:0,doctyp:3,document:[11,16],doe:[3,10,15],dog:3,dollar:3,don:11,done:[0,3,10,20],dosometh:3,dosomethingtoreturn:3,dot:3,dove:3,down:4,download:[3,15],dst:3,due:3,dump:3,dumper:3,dumpertyp:3,duplic:[0,8],durat:0,dure:15,dynam:[3,16],each:[0,3,6,12,15,16],earlier:3,earliest:3,echo:3,ecrir:[3,5],edf:0,edit:[0,9,15],editor:[3,9,16],either:[3,10],elaps:0,eleg:3,elem:3,element:[0,3],element_factori:3,elementari:3,elementtre:[],els:[0,3,21],embed:14,empti:3,enable_simple_env_script:3,encapsul:[],enclos:3,encod:3,end:[0,3,4,10],english:3,ensure:3,ensure_path_exist:3,enter:0,entir:3,entri:3,env:[0,3,10],env_build:10,env_fil:0,env_info:[0,3],env_launch:10,env_script:10,env_scripts_tmp_dir:0,equal:8,eras:13,erase_lin:4,erase_screen:4,err:0,error:[0,3,5,21],essai:5,essai_logging_1:[],essai_logging_2:[],etc:[0,3,16,17],etre:[0,3],etree:3,eval:3,evalu:3,evaluat:3,event:3,everi:0,everyth:8,exactli:3,exampl:[],exc:3,exceed:0,except:[3,15,20],exception:3,exceptionsat:[],exclud:0,exclude_vcs_and_extens:0,exec_command:0,execut:[0,3,8,15,20],execute_cli:3,exept:3,exhaust:[16,20],exist:[0,3,14,15,20],exit:[],exitstatu:[],exot:3,expect:[0,3],explain:10,explan:3,explicitli:3,explor:3,explore:9,express:[3,9],expression:3,ext:3,extend_with_children:0,extend_with_fath:0,extens:[0,3,21],extension_ignor:0,extern:3,extra:[0,3],extract:[0,3],extract_param:4,f_exclud:0,fact:21,factor:3,factori:3,fail:[0,3,8],fals:[0,3,4],far:3,favorit:9,feed:3,field:[0,3],file:[0,3,6,8,9,10,12,13,14,15,16,17,21],file_:0,file_board:0,file_dir:0,file_in:3,file_nam:[0,3],file_path:3,fileenviron:[],fileenvwrit:3,filenam:[0,3],filepath:[0,3],files_arb_out:0,files_ignor:0,files_out:0,fill:0,filnam:0,filter:[0,7],fin:3,find:[0,3,9,17,18],find_application_pyconf:0,find_command_list:3,find_file_in_lpath:3,find_histori:0,find_job_that_has_nam:0,find_node_by_attrib:3,find_product_scripts_and_pyconf:0,find_products_already_get:0,find_products_with_patch:0,find_test_log:0,findal:3,findconfig:3,findtext:3,finish:[0,3],finish_statu:0,firefox:[13,16],first:[0,3,10,15,21],fix:[0,3],flag:8,flaglin:0,flicacpp:0,flush:3,fmt:[3,5],folder:0,follow:[3,10,21],for_packag:3,forbuild:3,forc:[0,3,14,15],force_patch:15,fore:4,fork:[],form:3,format:[0,3,5,10,16],format_color_except:3,format_except:3,format_list_of_str:0,formatt:[3,5],formattupl:3,formatvalu:3,forward:[4,6,12],found:[0,3],four:10,french:21,from:[0,3,4,9,10,11,14,15,21],from_what:3,fromstr:3,full:[0,3],fun:9,func:3,futur:3,gap:0,gdb:10,gencat:[6,12],generate_appl:0,generate_catalog:0,generate_compon:0,generate_component_list:0,generate_history_xml_path:0,generate_launch_fil:0,generate_launching_command:3,generate_profile_sourc:0,generate_script:3,generic_opt:20,geom:[0,8],get:[9,15,16],get_all_product_sourc:0,get_arch:0,get_archives_vc:0,get_attr:4,get_attrib:3,get_base_install_dir:3,get_base_path:3,get_build_directori:0,get_cfg_param:3,get_children:0,get_command_line_overrid:3,get_config:3,get_config_children:3,get_config_file_path:0,get_dico_param:0,get_distrib_vers:3,get_distribut:3,get_file_environ:3,get_help:3,get_install_dir:3,get_install_directori:0,get_last_log_fil:0,get_launcher_nam:3,get_log_fil:0,get_log_path:3,get_method:15,get_nam:3,get_nb_proc:[0,3],get_node_text:3,get_paramet:0,get_path:3,get_pid:0,get_posit:4,get_product_compon:3,get_product_config:3,get_product_depend:3,get_product_sect:3,get_product_sourc:0,get_products_info:3,get_products_list:[0,3],get_profile_nam:0,get_property_in_product_cfg:3,get_pyconf_paramet:0,get_python_vers:3,get_recursive_children:0,get_recursive_fath:0,get_salome_modul:0,get_salome_vers:3,get_source_directori:0,get_source_for_dev:0,get_source_from_arch:0,get_source_from_cv:0,get_source_from_dir:0,get_source_from_git:0,get_source_from_svn:0,get_statu:0,get_step:0,get_template_info:0,get_test_timeout:3,get_tmp_dir:3,get_tmp_filenam:3,get_us:3,get_user_config_fil:3,get_win32_cal:4,getbypath:3,getchar:3,getcoloredvers:3,getcommandandappli:3,getcommandinst:3,getcommandslist:3,getconfig:[3,21],getconfigcolor:3,getconfigmanag:3,getdefaultlogg:3,getdetailopt:3,getiter:3,getlocalenv:3,getlog:3,getlogg:3,getlogsandclear:3,getmaxformat:0,getmodul:3,getmylogg:5,getoutput:[],getparamiko:0,getpars:0,getroot:3,getrootattrib:3,getstatu:[],getstatusoutput:[],getstrconfigdbg:3,getstrconfigstd:3,gettmpdir:3,gettmpdirdefault:3,gettoken:3,getunittestlogg:3,getvalu:3,getvers:3,getwhi:3,git:14,git_extract:3,git_info:15,gitconfig:15,give:[0,3,6,16,21],given:[0,3,4,6,10,12],global:[0,3],goe:3,green:[3,4],grep:[3,9],grey:4,grid:[0,3],gui:[0,3],hack_for_distene_lic:0,hack_libtool:3,had:3,handl:[3,4,10],handlemismatch:3,handler:[3,5],handleremovereadonli:3,harri:3,has_begun:0,has_fail:0,has_finish:0,has_gui:0,has_pyconf:0,has_salome_hui:3,has_timed_out:3,hat:3,have:[0,3,6,7,11,12,15],header:[0,3],help:[],helpstr:3,here:[0,3,10,16,21],hierarchi:3,himself:10,histori:0,hold:12,home:9,host:0,hostnam:0,hour:3,how:[3,10,15,16],html:[3,5],http:[3,4,5],human:3,hxx2salom:11,i18n:3,ident:[0,3],identifi:3,ignor:[0,3,11],ignore_exist:0,ignorelist:3,imag:15,implement:[3,4,10],in_dir:0,includ:[0,3,10,14,16],include:14,indent:3,indentunittest:3,index:3,indic:3,indirect:3,info:[0,3,5,9,15,21],inform:[0,3,9,14,15,16],inherit:3,initi:3,initialis:[],initialize_board:0,initiat:0,initloggerasdefault:3,initloggerasunittest:3,initmylogg:5,inmap:3,input:[0,3],input_list:3,insid:15,instal:[0,3,7,8,16,18,20],install:[0,7,20],install_dir:10,installat:[],instanc:[0,3,4,21],instanti:0,instantiat:3,instead:3,instream:3,instruct:[3,16],intal:14,integ:0,interact:[0,13],interfac:[3,20],intern:3,internation:3,interpret:[],invalid:3,ioerror:3,iostream:3,is_a_tti:4,is_defin:3,is_dev:0,is_occupi:0,is_run:0,is_salome_modul:[0,7,10],is_stream_clos:4,is_timeout:0,is_window:3,isdir:3,isel:3,isfil:3,islink:3,isok:3,issu:4,isword:3,item:3,iter:3,iteritem:3,iterkei:3,iterpars:3,ivar:3,jane:3,job_config_nam:0,job_def:0,job_fil:0,job_file_path:0,jobs_config:0,join:10,json:3,jsondump:3,just:8,keep:3,kei:[0,3,10,15],kernel:[0,9,20],kfsys:3,kill:0,kill_remote_process:0,killsalom:3,kind:0,know:[3,15],known:[3,14],knownfailure_status:3,ko_status:3,kosys:3,kwarg:4,kwd:4,l_cfg_dir:0,l_job:0,l_jobs_not_todai:0,l_path:0,l_pinfo_vc:0,l_product:0,l_products_info:0,l_remote_log_fil:0,l_salome_modul:0,l_str:0,label:[0,3,9],lang:3,lapack:10,lapack_root_dir:10,last:[0,3,10,13],last_termin:13,last_upd:0,later:14,latter:3,launch:[0,3,10],launch_command:3,launched_cmd:3,launcher_nam:[0,12],launcherfileenviron:3,launchsat:3,layer:11,ld_library_path:10,left:10,len_col:0,len_end:0,lenght:0,lenght_column:0,length:0,less:3,level:[3,5,20],levelnam:[3,5],lib:[5,10],librari:[3,5],licenc:0,light:[0,4],lightblack_ex:4,lightblue_ex:4,lightcyan_ex:4,lightgreen_ex:4,lightmagenta_ex:4,lightred_ex:4,lightwhite_ex:4,lightyellow_ex:4,like:[0,3,4,6,8,9,12,16],limit:3,line:[0,3,9,20],link:[0,3,15],list:[6,7,9,12,16],list_directori:0,list_log_fil:3,list_of_product:11,listtest:3,llvm:[6,12],load:[3,16],load_cfg_environ:3,load_environ:3,local:[0,3,9],locat:[0,3],log_command:3,log_dir:[0,13],log_res_step:0,log_step:0,logdir:[0,3],logfilepath:3,logger:5,logger_info_tupl:3,loggingsat:[],login:15,logo:[3,12],logs:3,lome:17,longnam:3,lost:3,lpath:[0,3],lproduct:3,machin:[0,3,6,11,12,14],machine1:6,machine2:6,machine3:6,machine_nam:0,magenta:[3,4],mai:15,main:[0,3,8],mainten:0,make_alia:0,make_all_product:0,make_arch:0,make_flag:8,make_opt:[0,3],make_product:0,makeinstall_all_product:0,makeinstall_product:0,makepath:3,manag:[0,3,9,15],manipul:[0,3,9],map1:3,map2:3,map:[0,3],match:3,max:3,max_product_name_len:0,maximum:0,mechan:[3,10],med:8,medcoupling:0,memori:[3,6,12],menu:13,merg:3,merge:3,merge_dict:3,mergemap:3,mergesequ:3,mesa:[6,12],messag:[0,3,5,21],method:[0,3,4,8,10,15,21],milou:3,minim:3,minut:3,mismatch:3,miss:[6,8],mistak:15,mix:0,mkdir:0,mode:[4,7,9,10,13],model:21,modifi:[0,3,10,15],module_gener:0,module_path:0,moment:3,mon:3,mond:21,more:[0,3,20],most:[0,3,10],move_test_result:0,msg:3,multi:3,multilin:3,multipl:3,must:[0,21],mutipl:3,my_application_directori:6,my_application_nam:6,my_job:0,my_product_nam:0,my_tag:15,mycommand:21,myformatt:5,mylogg:5,myoption:21,myspecificnam:14,mytempl:3,na_status:3,name:[0,3,6,7,9,10,12,14,15,16,20,21],name_arch:0,name_job:0,name_nod:3,name_product:0,namespac:3,nasys:3,nativ:[0,3,10],nb_line:3,nb_proc:[0,3,8],ndsys:3,necessari:3,need:[0,3,4,6,11,15],needs:0,new_nam:9,newer:0,newlin:[],next:3,nice:[],no_label:9,node:[0,3],node_nam:3,non:4,none:[0,3,4,5],nor:4,normal:[3,4],note:[6,10,12,16],noth:[0,3,14],notimplementederror:3,notion:3,notshowncommand:[0,3],now:0,number:[0,3,6,8,12,13],number_of_proc:3,numpi:0,obj1:3,obj2:3,obj:3,object:[0,3,4,16],obsolesc:0,obsolet:3,obsolete:21,obtain:3,obvious:3,occur:3,offset:0,ok_status:3,oksys:3,old:3,older:13,on_stderr:4,onc:15,one:3,onli:[0,3,6,7,8,9,10,11,12,13,15,20],only_numb:3,ool:17,open:3,openggl:[6,12],openmpi:3,oper:[0,3,9,17],operand:3,opt_nb_proc:3,option:[],optionali:3,optionn:3,optionnali:3,optiontyp:3,optresult:[0,3],order:[0,3,15,16,21],org:[3,4,5],other:[5,10,14,16],otherwis:[0,3,15],our:4,out:[0,3],out_dir:[0,3],output:[0,3,4],outstream:3,outtext:[],overrid:[3,6],overwrit:3,overwritekei:3,overwritemergeresolv:3,overwritten:3,own:3,p_info:0,p_name:0,p_name_info:0,p_name_p_info:0,pad:0,page:10,pair:[0,3],param:[3,4],param_def:0,param_nam:3,paramet:[0,3,9,16,21],parameter_path:9,paramiko:0,paramstr:4,paravi:[6,12],paraview:0,paravis:0,parent:[0,3],pars:[0,3,21],parse_arg:[3,21],parse_csv_board:0,parse_d:3,parseargu:3,parsefactor:3,parsekeyvaluepair:3,parsemap:[0,3],parsemappingbodi:3,parser:[3,21],parserefer:3,parsescalar:3,parsesequ:3,parsesuffix:3,parseterm:3,parsevalu:3,part:[3,6,10,12],particular:3,pass:[0,3,16,21],passphras:15,passwd:0,password:15,pat:3,patches_tmp_dir:0,path:[],path_in_arch:0,path_on_local_machin:0,path_to_catalog:6,path_to_check:0,path_to_yacsgen:11,pathlaunch:0,pathlist:3,paths:9,pattern:3,pdf:[9,17],pend:7,pendant:3,perform:[3,15,17],person:9,phase:3,pid:0,pipe:[],platform:[4,10],pleas:[10,11],plugin:[3,8],pluma:16,plusieur:5,point:[3,21],pop_debug:3,popen:3,popul:3,port:0,pos:4,posit:4,possibl:[0,3,10,15,21],post:3,potenti:3,pprty:3,preced:3,predefin:3,prefer:[9,16],prefix:[0,3,10,16],prepare_from_templ:0,prepare_testbas:3,prepare_testbase_from_dir:3,prepare_testbase_from_git:3,prepare_testbase_from_svn:3,prepend:[3,10],prepend_valu:3,prereq_dir:10,prerequisit:[10,14,16,17,20],presenc:3,present:3,pretti:3,previou:[0,3],previous:7,print:[0,3,4,9,13],print_debug:3,print_grep_environ:3,print_help:3,print_log_command_in_termin:0,print_split_environ:3,print_split_pattern_environ:3,print_valu:3,problem:[3,6,12],procedur:[0,3],process:[0,3,15],processinginstruct:3,processor:[0,3,6,12],prod_dir:3,prod_info:[0,3],prod_nam:0,produc:[0,3],produce_install_bin_fil:0,produce_relative_env_fil:0,produce_relative_launch:0,product1:[8,10,15],product2:[8,10,15],product:[],product_appli_creation_script:0,product_cfg:3,product_compil:3,product_has_dir:0,product_has_env_script:3,product_has_logo:3,product_has_patch:3,product_has_salome_gui:3,product_has_script:3,product_info:[0,3],product_inform:[0,3],product_is_autotool:3,product_is_cmak:3,product_is_cpp:3,product_is_debug:3,product_is_dev:3,product_is_fix:3,product_is_gener:3,product_is_mpi:3,product_is_n:3,product_is_salom:3,product_is_salome:3,product_is_sampl:3,product_is_smesh_plugin:3,product_is_vc:3,product_log_dir:0,product_nam:[0,3],products_info:0,products_pyconf_tmp_dir:0,profileconfigread:0,profilerefer:0,program:3,programmat:10,progress:[0,3],progress_bar:0,project:[0,3,9,10],project_file_path:0,project_packag:0,project_path:3,projects:3,prop:0,proper:0,properti:[0,3,7,10,11],protocol:[3,6],provid:[0,3,10,21],proxi:4,pubid:3,publish:0,pure:0,push:15,push_debug:3,put:[0,3],put_dir:0,put_jobs_not_todai:0,put_txt_log_in_appli_log_dir:3,pv_plugin_path:3,pwd:3,pyc:5,pyconf:[],python2:5,python:[0,3,5,10,12,16,17,18,21],python_config:3,pythoncompon:0,pythonpath:10,pythonpath_:10,qname:3,queri:[6,12],question:3,rais:[3,20],raiseifko:3,raw:3,raw_input:0,rc1:3,rc2:3,rcfinal:3,rco:[0,3],reach:0,read:[0,3],read_config_from_a_fil:3,read_result:3,readabl:3,reader:3,readi:15,readlin:3,readlink:3,readxmlfil:3,record:[3,5],recurs:[0,3,9],red:[3,4],redefin:3,redirect:3,reduc:0,ref:3,refer:[0,3,11,16],reflect:3,regard:[0,3],regular:3,reinit:[3,4],rel:[0,3,14],remain:[13,18],remark:6,remor:11,remot:[0,3,14],remov:[0,3,7,8,15],remove_item_from_list:3,remove_log_fil:0,remove_product:0,removenamespac:3,renam:3,renint:3,replac:[0,3,6],replace_in_fil:3,report:[0,3],repositori:[0,3,15],repr:3,repres:3,represent:3,request:4,requir:[4,10,11],reserv:3,reset:[3,4],reset_al:4,reset_all:4,resolut:3,resolv:3,resourc:[6,12],respect:10,restor:[3,7],result:[0,3],retcod:0,retriev:3,returncod:[],right:[0,3,10],root:[3,21],root_nod:3,rootnam:3,rtype:3,run_all_test:3,run_env_script:3,run_grid_test:3,run_job:0,run_script:3,run_script_all_product:0,run_script_of_product:0,run_session_test:3,run_simple_env_script:3,run_test:3,run_testbase_test:3,runappli:6,runner:[0,3,21],ruud:3,sajip:3,salom:[6,10,12],salome:[6,7,8,9,10,11,12,14,16,18],salome_modules:3,salome_session_serv:3,salome_xx:[7,14,18,20],salome_xx_:14,salomeapp:0,salomecontext:3,salomeenviron:3,salometool:[],same:[0,3],sametmax:[3,5],sampl:3,samples:20,sat:[6,7,8,9,10,11,12,13,14,15,16,18],sat_local_path:0,sat_path:0,save:10,save_fil:0,saveconfigdbg:3,saveconfigstd:3,scalar:3,scratch:3,screenenviron:3,script_nam:3,script_path:3,search:[0,3],search_known_error:3,search_templ:0,second:[0,3,10],section:[6,10,15],secur:15,see:[0,3,4,16,20],seen:3,select:[3,14],self:[0,3],semant:3,sep:[3,10],separ:3,seq1:3,seq2:3,seq:3,seqiter:3,sequenc:[3,4],server:[3,15],servic:21,session:[0,3],set:[0,3,6,7,10,12,16,17,21],set_a_product:3,set_application_env:3,set_attr:4,set_consol:4,set_cpp_env:3,set_cursor_posit:4,set_env:[3,10],set_env_build:10,set_env_launch:10,set_full_environ:3,set_local_valu:0,set_native_env:[3,10],set_product:3,set_python_libdir:3,set_salome_generic_product_env:3,set_salome_minimal_product_env:3,set_titl:4,set_user_config_fil:3,setcolorlevelnam:3,setconsoletextattribut:4,setlocal:3,setnotlocal:3,setpath:3,setstatu:3,setstream:3,settings_fil:0,setvalu:3,setwhi:3,sever:[0,10,16],shallow:3,shortcut:3,shortnam:3,should:[3,10,11],should_wrap:4,show:[0,3,8,13],show_command_log:3,show_desktop:3,show_full_path:3,show_in_editor:3,show_label:3,show_last_log:0,show_patch:[0,3,9],show_product_info:3,show_product_last_log:0,show_progress:3,show_warn:3,showinfo:3,shown:[3,8],sign:3,silent:[0,3],similar:3,simpl:[3,20,21],sinc:[0,3],site:0,size:[0,3],slogan:0,small:3,smart:3,smartcopi:3,smesh:3,softwar:15,some:[],someon:10,sometim:7,sommeil:3,soon:8,sort:0,sort_product:0,source_dir:0,source_packag:0,sourcepackag:0,sources:[7,15,20],sources_without_dev:7,space:3,special_path_separ:3,specif:[0,3,6,7,10,11,12,14,16,20],specifi:[3,6,10,11,12,15],splashscreen:12,split:3,src:[],src_root:[0,3],sre_pattern:[3,4],srsc:3,ssh:[0,6,12,15],ssh_connection_all_machin:0,stack:[3,20],stackoverflow:3,start:[4,6,8,12],state:0,statu:[0,3],stderr:[0,3],stdin:0,stdout:[0,3,4],step:[0,3],stop:[0,8],stop_first_fail:8,store:[0,3,8,9,13,15,16],str:[0,3],str_in:3,str_num:3,str_of_length:0,str_out:3,stream:[0,3,4],streamopen:3,streamorfil:3,streamwrapp:4,strftime:[3,5],string:[0,3],stringio:3,strip:4,strorlist:3,structur:16,stuff:[3,12],style:[0,3,4],stylesheet:[0,3],sub:[0,3,16],subclass:3,subelement:3,subpackag:[],subprocess:3,subsect:10,subset:14,subst_dic:3,substitut:[0,3],substr:3,subtract:3,succe:0,success:[0,3,8],success_fail:0,successfulli:3,successfully_connect:0,suffici:10,suffix:[0,3],suit:17,suitabl:3,sum:3,summari:[],support:3,suppos:3,supposedli:3,suppress:[0,7],suppress_directori:0,sur:5,svn:14,svn_extract:3,svn_info:15,symlink:3,syntax:7,syss:3,system:[],tab:3,tabl:3,tabul:3,tag:[3,15],take:[0,3,7],taken:[3,10],tar:[0,14,18],tarfil:0,target:[0,3,6,10],target_dir:0,tcllibpath:3,template_fil:3,template_nam:0,templateset:0,temporari:0,term:3,termin:[0,3,4,8,13,21],test_bas:0,test_base_nam:3,test_config:3,test_grid:3,test_modul:[],test_nam:3,test_sess:3,testbas:3,testbase_bas:3,testbase_dir:3,testbase_nam:3,testbase_tag:3,testlogger1:5,testlogger_1:3,text:[0,3,4,20],text_or_uri:3,tgz:[14,18],thank:3,thei:[0,7,9,10,15],them:[4,15],thi:[0,3,4,6,8,9,10,11,12,14,15,16,17,21],thing:21,those:11,through:[3,6,10,12,13],thrown:3,time:[0,3,5,7,10,15,16],time_elaps:0,timedelta:3,timedelta_total_second:3,timeout:[0,3],timeout_status:3,tintin:3,tip:3,titl:[3,4],tklibpath:3,tmp:[0,3],tmp_working_dir:[0,3],tocolor:3,tocolor_ansitowin32:3,todai:0,todo:3,tofix:3,token:3,token_typ:3,token_valu:3,too:3,top:3,tosi:3,tostr:3,tosys:3,total:0,total_dur:0,total_second:3,tout:21,tparam:0,trace:[0,3,20],traceback:3,trail:[],transform:[0,3],transpar:4,tree:3,treebuild:3,trust_root_dir:10,tty:4,tupl:[0,3],turn:3,tutori:3,two:[3,10],txt:3,type:[0,3,15],typeerror:3,unabl:3,unchang:3,unconditionali:[3,20],under:[0,3,17],underscor:[3,10],unicod:3,unit:8,unittest:3,unittestformatt:3,unitteststream:3,unix:3,unknown_status:3,unless:[4,15],updat:0,update:[0,3],update_config:0,update_hat_xml:3,update_jobs_states_list:0,update_pyconf:0,update_xml_fil:0,updatehatxml:3,upload:0,urllib2:3,urlopen:3,usag:[3,20],use:[0,6,7,8,9,10,11,12,15],use_mesa:[6,12],used:[0,3],useful:[3,20],user:[9,10,13,14],usernam:3,username:3,users:9,using:21,usr:[3,5,10],usual:[3,7,11,14,16,20],usualli:[14,18],utf:[3,10],util:[3,14,17],utilis:5,utiliti:3,utilssat:[],uts:3,val:0,valid:3,valmax:0,valmin:0,valu:[0,3,4,6,7,9,15,16],variabl:[0,3,10,11,21],vars:10,vcs:[7,14],verbos:[],verifi:[0,3,15],version:[0,3,10,11,14,16,17],via:3,viewer:9,vinai:3,virtual:[3,6],virtual_app:6,visualis:10,wai:[0,3,8,21],wait:0,want:[0,3,7,10],warn:[0,3,5,8,21],warning:[3,5],web:[9,13,16],week:0,welcom:3,welkom:3,well:3,were:3,what:[0,3,7],when:[0,3,6,10,15,16,21],whenev:3,where:[0,3,6,8,9,14],which:[0,3,4,10,11,16,21],white:[3,4],who:11,why:3,width:0,wiki:4,wikipedia:4,wil:10,win32:[],winapi_test:4,wincolor:4,window:[3,4,10],winstyl:4,winterm:[],with_children:8,with_commerci:[0,3],with_fath:8,with_install_dir:3,with_vc:[0,14],within:10,without:[3,9,15],without_dev:0,without_native_fix:0,without_properti:14,wmake:3,word:3,work:[0,3,9,14,15,16],workdir:[3,6,9,12,14,16,20,21],world:21,would:3,wrap:[3,4],wrap_stream:4,writabl:3,write:[0,3,4,21],write_all_result:0,write_all_source_fil:0,write_and_convert:4,write_back:3,write_cfgforpy_fil:3,write_env_fil:3,write_info:0,write_plain_text:4,write_report:3,write_result:0,write_test_margin:3,write_tre:3,write_xml_fil:0,writetostream:3,writevalu:3,written:21,www:3,xa4:3,xc2:3,xml:[0,3,21],xml_dir_path:0,xml_file:0,xml_history_path:0,xml_node_job:0,xmllogfil:[0,3],xmlmanag:[],xmlmgr:3,xmlname:0,xmlroot:3,xmltreebuild:3,xxx:[3,7,16],xxx_root_dir:3,xxx_src_dir:3,yacsgen:[0,3,11],yacsgen_root_dir:11,year:3,yellow:[3,4],yet:[3,20],yield:3,you:[0,3,6,7,10,12,15,17,21],your:[0,3,10,15,20,21],yourspecificnam:14,yve:3,yyy:16,yyyy:3,yyyymmdd_hhmmss:3,yyyymmdd_hhmmss_namecmd:3,zelaunch:12,zero:3,zerodivideerror:3},titles:["commands package","commands","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:21,add:21,ansi:4,ansitowin32:4,applic:[0,6],application:16,architectur:3,avail:20,availabl:7,base:15,basic:21,build:20,catchall:3,check:0,clean:[0,7],code:17,colorama:4,coloringsat:3,command:[0,1,6,7,8,9,10,11,12,13,14,15,17,21],compil:[0,3,8,20],config:[0,9,21],configmanag:3,configur:[0,6,7,8,9,10,12,13,14,15,16],content:[0,3,4,5],custom:21,debug:[3,20],descript:[6,7,8,9,10,11,12,13,14,15,16],dev:15,develop:17,document:17,elementtre:3,environ:[0,3,10],essai_logging_1:5,essai_logging_2:5,exampl:[5,21],exceptionsat:3,fileenviron:3,find_dupl:0,fork:3,gener:[0,11],get:20,git:15,hello:21,help:20,howto:21,init:0,initialis:4,installat:18,introduct:21,job:0,launcher:[0,12],list:[17,20],log:[0,13],logger:21,loggingsat:3,make:0,makeinstal:0,mode:15,modul:[0,3,4,5],note:[17,19],option:[3,7,20],other:21,packag:[0,3,4,5,14],patch:0,path:[6,7,8,9,13,14,15],prepar:[0,15,20],product:[3,20],products:16,profil:0,pyconf:3,quick:17,releas:[17,19],remark:[11,15],requir:21,returncod:3,run:0,salom:17,salome:20,salometool:[3,20,21],sat:20,script:0,section:16,shell:0,some:[6,7,8,9,13,14,15],sourc:[0,20],src:[2,3,4,5],start:17,submodul:[0,3,4,5],subpackag:3,svn:15,syntax:16,system:3,templat:[0,3],test:0,test_modul:3,tool:17,usage:[6,7,8,9,10,11,12,13,14,15,20],user:[16,21],utilssat:3,vars:16,vcs:15,verbos:20,win32:4,winterm:4,xmlmanag:3}}) \ No newline at end of file diff --git a/sat b/sat index 96f2736..6b5b52c 100755 --- a/sat +++ b/sat @@ -40,7 +40,21 @@ import src.debug as DBG # Easy print stderr (for DEBUG only) logger = LOG.getDefaultLogger() +import traceback +def format_color_exception(msg, etype, value, tb, limit = None): + """Format a stack trace and the exception information. + as traceback.format_exception(), with color + """ + res = "" + msg + "" + if tb: + res += "Traceback (most recent call last):\n" + # print "tb" + res += "".join(traceback.format_tb(tb, limit)) #[:-1]) + res += "\n" + res += "\n".join(traceback.format_exception_only(etype, value)) + return res+ "" + ################################# # MAIN ################################# @@ -62,18 +76,15 @@ if __name__ == "__main__": sys.exit(returnCode.toSys()) except Exception as e: - if (_debug) or (DBG._user in DBG._developpers): - # verbose debug message with traceback - msg = "Exception raised for execute_cli(%s):\n\n%s" - import traceback - logger.critical( msg % (args, traceback.format_exc()) ) - else: - # short production message - msg = "Exception raised for execute_cli(%s):\n\n%s\n" - logger.critical( msg % (args, e) ) + # verbose debug message with traceback if developers + msg = "Exception raised for execute_cli(%s):\n" % args + logger.critical(DBG.format_color_exception(msg)) sys.exit(KOSYS) else: logger.critical("forbidden/unexpected mode for __name__ '%s'" % __name__) sys.exit(KOSYS) + + + \ No newline at end of file diff --git a/src/debug.py b/src/debug.py index 531405b..4542134 100644 --- a/src/debug.py +++ b/src/debug.py @@ -33,6 +33,7 @@ usage: import os import sys +import traceback import StringIO as SIO import pprint as PP @@ -81,16 +82,37 @@ def pop_debug(): sys.stderr.write("\nERROR: pop_debug: too much pop.") return None +def format_color_exception(msg, limit=None, trace=None): + """ + Format a stack trace and the exception information. + as traceback.format_exception(), with color + with traceback only if (_debug) or (DBG._user in DBG._developpers) + """ + etype, value, tb = sys.exc_info() + if (_debug[-1]) or (_user in _developpers): + res = "" + msg + if tb: + res += "\nTraceback (most recent call last):\n" + res += "".join(traceback.format_tb(tb, limit)) #[:-1]) + res += "\n" + res += "\n".join(traceback.format_exception_only(etype, value)) + return res+ "" + else: + res = "" + msg # + "" + res += "".join(traceback.format_exception_only(etype, value)) + return res+ "" + + ############################################### # utilitaires divers pour debug ############################################### class OutStream(SIO.StringIO): - """\ + """ utility class for pyconf.Config output iostream """ def close(self): - """\ + """ because Config.__save__ calls close() stream as file keep value before lost as self.value """ diff --git a/src/options.py b/src/options.py index ea4bb0f..f75ca67 100644 --- a/src/options.py +++ b/src/options.py @@ -85,7 +85,7 @@ class Options(object): # in a list that contains dicts self.options = [] # The list of available option type - self.availableOptions = "boolean string int float long list list2, level".split() + self.availableOptions = "boolean string int float long list list2 level".split() self.default = None self.results = {} @@ -96,11 +96,9 @@ class Options(object): of an option and append it in the options field :param shortName: (str) - The short name of the option - (as '-l' for level option). + The short name of the option (as '-l' for level option). :param longName: (str) - The long name of the option - (as '--level' for level option). + The long name of the option (as '--level' for level option). :param optionType: (str) The type of the option (ex "int"). :param destName: (str) The name that will be used in the code. :param helpString: (str) @@ -119,8 +117,7 @@ class Options(object): option['longName'] = longName if optionType not in self.availableOptions: - print("error optionType", optionType, "not available.") - sys.exit(src.KOSYS) + raise Exception("error optionType '%s' not available." % optionType) option['optionType'] = optionType option['destName'] = destName diff --git a/src/returnCode.py b/src/returnCode.py index ec5c5a5..cff6af6 100644 --- a/src/returnCode.py +++ b/src/returnCode.py @@ -19,6 +19,7 @@ """ This file contains ReturnCode class + usage: >> import returnCode as RCO """ @@ -27,30 +28,29 @@ import pprint as PP ##################################################### class ReturnCode(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() usage: - >> import returnCode as RCO - - >> 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") - - >> rc = doSomething() - >> print("short returnCode string", str(rc)) - >> print("long returnCode string with value", repr(rc)) - - >> rc1 = RCO.ReturnCode("OK", ...) - >> rc2 = RCO.ReturnCode("KO", ...) - >> rcFinal = rc1 + rc2 - >> print("long returnCode string with value", repr(rcFinal)) # KO! + >> import returnCode as RCO + + >> 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") + + >> rc = doSomething() + >> print("short returnCode string", str(rc)) + >> print("long returnCode string with value", repr(rc)) + + >> rc1 = RCO.ReturnCode("OK", ...) + >> rc2 = RCO.ReturnCode("KO", ...) + >> rcFinal = rc1 + rc2 + >> print("long returnCode string with value", repr(rcFinal)) # KO! """ OK_STATUS = "OK" @@ -122,12 +122,14 @@ class ReturnCode(object): return strOrList def toSys(self): + """return system return code as bash or bat""" try: return self._TOSYS[self._status] except: return self._TOSYS[self.NA_STATUS] def getWhy(self): + """return why as str or list if sum or some ReturnCode""" return self._why def setWhy(self, why): @@ -158,4 +160,10 @@ class ReturnCode(object): self._value = self._DEFAULT_VALUE def isOk(self): + """return True if ok""" return (self._status == self.OK_STATUS) + + def raiseIfKo(self): + """raise an exception with message why if not ok""" + if self.isOk(): return + raise Exception(self.getWhy()) diff --git a/src/salomeTools.py b/src/salomeTools.py index ed4ba5b..ed7a2f2 100755 --- a/src/salomeTools.py +++ b/src/salomeTools.py @@ -17,7 +17,7 @@ # 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 NO __main__ entry allowed, use 'sat' (in parent directory) """ @@ -70,9 +70,8 @@ def find_command_list(dirPath): """ Parse files in dirPath that end with '.py' : it gives commands list - :param dirPath str: The directory path where to search the commands - :return: cmd_list : the list containing the commands name - :rtype: list + :param dirPath: (str) The directory path where to search the commands + :return: (list) the list containing the commands name """ cmd_list = [] for item in os.listdir(dirPath): @@ -91,11 +90,12 @@ def getCommandsList(): return _COMMANDS_NAMES def launchSat(command): - """\ - launch sat as subprocess popen + """ + launch sat as subprocess.Popen command as string ('sat --help' for example) used for unittest, or else... - returns tuple (stdout, stderr) + + :return: (stdout, stderr) tuple of subprocess.Popen output """ if "sat" not in command.split()[0]: raise Exception(_("Not a valid command for launchSat: '%s'") % command) @@ -249,13 +249,15 @@ class _BaseCommand(object): method called when salomeTools have '--help' argument. returns The text to display for the command description which is current Command class docstring 'self.__doc__', - with traduction + with traduction, if done. + replace supposedly sphinx apidoc format ' | ' if present """ - return _(self.__doc__) + return _(self.__doc__.replace(" | ", " ")) # replace sphinx apidoc format def run(self, cmd_arguments): """ - method called when salomeTools processes command(s) parameters""" + method called when salomeTools processes command(s) parameters + """ raise Exception("_BaseCmd class have not to be instancied, useful only for inheritage") def print_help(self): @@ -284,13 +286,14 @@ class _BaseCommand(object): # Sat class ######################################################################## class Sat(object): - """The main class that stores all the commands of salomeTools + """ + The main class that stores all the commands of salomeTools (usually known as 'runner' argument in Command classes) """ def __init__(self, logger): """Initialization - :param logger: The logger to use + :param logger: (Logger) The logger to use """ # Read the salomeTools prefixes options before the 'commands' tag @@ -404,7 +407,7 @@ class Sat(object): return self._getModule(name) def getCommandInstance(self, name): - """\ + """ returns inherited instance of Command(_BaseCmd) for command 'name' if module not loaded yet, load it. """ @@ -419,7 +422,7 @@ class Sat(object): def execute_cli(self, 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) + :param cli_arguments: (str or list) The sat cli arguments (as sys.argv) """ args = self.assumeAsList(cli_arguments) diff --git a/src/utilsSat.py b/src/utilsSat.py index e368f3a..e52df60 100644 --- a/src/utilsSat.py +++ b/src/utilsSat.py @@ -38,6 +38,7 @@ import tempfile import src.returnCode as RCO + ############################################################################## # file system utilities ############################################################################## @@ -219,11 +220,12 @@ def check_config_has_application( config, details = None ): :param config: (Config) The config. """ if 'APPLICATION' not in config: - message = _("An APPLICATION is required. Use 'config --list' to get" - " the list of available applications.\n") + msg = _("An is required.") + msg += "\n" + _("(as 'sat prepare ')") + msg += "\n" + _("Use 'sat config --list' to get the list of available applications.") if details : - details.append(message) - raise Exception( message ) + details.append(msg) + raise Exception(msg) def check_config_has_profile( config, details = None ): """ @@ -351,7 +353,7 @@ def get_property_in_product_cfg(product_cfg, pprty): ############################################################################## def formatTuples(tuples): """ - format 'label = value' the tuples in a tabulated way. + Format 'label = value' the tuples in a tabulated way. :param tuples: (list) The list of tuples to format :return: (str) The tabulated text. (as mutiples lines) @@ -560,13 +562,13 @@ def show_command_log(logFilePath, cmd, application, notShownCommands): import src.xmlManager as XMLMGR # avoid import cross utilsSat if cmd in notShownCommands: - return RCO.ReturnCode("KO", "in notShownCommands", None) + return RCO.ReturnCode("KO", "command '%s' in notShownCommands" % cmd, None) # Get the application of the log file - if True: #try: + try: logFileXml = XMLMGR.ReadXmlFile(logFilePath) - else: #except Exception as e: - msg = _("The log file '%s' cannot be read:" % logFilePath) + except Exception as e: + msg = _("The log file '%s' cannot be read" % logFilePath) return RCO.ReturnCode("KO", msg, None) if 'application' in logFileXml.xmlroot.keys(): @@ -574,9 +576,9 @@ def show_command_log(logFilePath, cmd, application, notShownCommands): launched_cmd = logFileXml.xmlroot.find('Site').attrib['launchedCommand'] # if it corresponds, then the log has to be shown if appliLog == application: - return RCO.ReturnCode("OK", "appliLog == application", (appliLog, launched_cmd)) + return RCO.ReturnCode("OK", "appliLog is application", (appliLog, launched_cmd)) elif application != 'None': - return RCO.ReturnCode("KO", "application != 'None'", (appliLog, launched_cmd)) + return RCO.ReturnCode("KO", "application is not 'None'", (appliLog, launched_cmd)) return RCO.ReturnCode("OK", "", (appliLog, launched_cmd))