%% Generated by Sphinx.
\def\sphinxdocclass{report}
\documentclass[a4paper,10pt,english]{sphinxmanual}
\ifdefined\pdfpxdimen
   \let\sphinxpxdimen\pdfpxdimen\else\newdimen\sphinxpxdimen
\fi \sphinxpxdimen=.75bp\relax

\PassOptionsToPackage{warn}{textcomp}
\usepackage[utf8]{inputenc}
\ifdefined\DeclareUnicodeCharacter
 \ifdefined\DeclareUnicodeCharacterAsOptional
  \DeclareUnicodeCharacter{"00A0}{\nobreakspace}
  \DeclareUnicodeCharacter{"2500}{\sphinxunichar{2500}}
  \DeclareUnicodeCharacter{"2502}{\sphinxunichar{2502}}
  \DeclareUnicodeCharacter{"2514}{\sphinxunichar{2514}}
  \DeclareUnicodeCharacter{"251C}{\sphinxunichar{251C}}
  \DeclareUnicodeCharacter{"2572}{\textbackslash}
 \else
  \DeclareUnicodeCharacter{00A0}{\nobreakspace}
  \DeclareUnicodeCharacter{2500}{\sphinxunichar{2500}}
  \DeclareUnicodeCharacter{2502}{\sphinxunichar{2502}}
  \DeclareUnicodeCharacter{2514}{\sphinxunichar{2514}}
  \DeclareUnicodeCharacter{251C}{\sphinxunichar{251C}}
  \DeclareUnicodeCharacter{2572}{\textbackslash}
 \fi
\fi
\usepackage{cmap}
\usepackage[T1]{fontenc}
\usepackage{amsmath,amssymb,amstext}
\usepackage{babel}
\usepackage{times}
\usepackage[Bjarne]{fncychap}
\usepackage{sphinx}
\sphinxsetup{verbatimwithframe=false, VerbatimColor={rgb}{.98,.94,.94}}
\usepackage{geometry}

% Include hyperref last.
\usepackage{hyperref}
% Fix anchor placement for figures with captions.
\usepackage{hypcap}% it must be loaded after hyperref.
% Set up styles of URL: it should be placed after hyperref.
\urlstyle{same}

\addto\captionsenglish{\renewcommand{\figurename}{Fig.}}
\addto\captionsenglish{\renewcommand{\tablename}{Table}}
\addto\captionsenglish{\renewcommand{\literalblockname}{Listing}}

\addto\captionsenglish{\renewcommand{\literalblockcontinuedname}{continued from previous page}}
\addto\captionsenglish{\renewcommand{\literalblockcontinuesname}{continues on next page}}

\addto\extrasenglish{\def\pageautorefname{page}}

\setcounter{tocdepth}{1}



\title{salomeTools Documentation}
\date{Jun 26, 2018}
\release{5.0.0dev}
\author{CEA DEN/DANS/DM2S/STMF/LGLS}
\newcommand{\sphinxlogo}{\vbox{}}
\renewcommand{\releasename}{Release}
\makeindex

\begin{document}

\maketitle
\sphinxtableofcontents
\phantomsection\label{\detokenize{index::doc}}
\clearpage



\noindent{\hspace*{\fill}\sphinxincludegraphics[scale=1.0]{{sat_about}.png}\hspace*{\fill}}

\begin{sphinxadmonition}{warning}{Warning:}
This documentation is under construction.
\end{sphinxadmonition}

The \sphinxstylestrong{Sa}lome\sphinxstylestrong{T}ools (sat) is a suite of commands
that can be used to perform operations on \sphinxhref{http://www.salome-platform.org}{SALOME}%
\begin{footnote}[1]\sphinxAtStartFootnote
\sphinxnolinkurl{http://www.salome-platform.org}
%
\end{footnote}.

For example, sat allows you to compile SALOME’s codes
(prerequisites, products)
create application, run tests, create package, etc.

This utility code is a set of \sphinxhref{https://docs.python.org/2.7}{Python}%
\begin{footnote}[2]\sphinxAtStartFootnote
\sphinxnolinkurl{https://docs.python.org/2.7}
%
\end{footnote} scripts files.

Find a \sphinxhref{./../latex/salomeTools.pdf}{pdf version of this documentation}


\chapter{Quick start}
\label{\detokenize{index:quick-start}}\label{\detokenize{index:salome-tools}}

\section{Installation}
\label{\detokenize{installation_of_sat:installation}}\label{\detokenize{installation_of_sat::doc}}
Usually user could find (and use) command \sphinxstylestrong{sat} directly after a ‘detar’ installation of SALOME.

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
tar \PYGZhy{}xf .../SALOME\PYGZus{}xx.tgz
\PYG{n+nb}{cd} SALOME\PYGZus{}xx
ls \PYGZhy{}l sat      \PYG{c+c1}{\PYGZsh{} sat \PYGZhy{}\PYGZgt{} salomeTools/sat}
\end{sphinxVerbatim}

Python package (scripts of salomeTools) actually remains in directory \sphinxstyleemphasis{salomeTools}.


\section{Configuration}
\label{\detokenize{configuration:configuration}}\label{\detokenize{configuration::doc}}
\sphinxstyleemphasis{salomeTools} uses files to store its configuration parameters.

There are several configuration files which are loaded by salomeTools in a specific order.
When all the files are loaded a \sphinxstyleemphasis{config} object is created.
Then, this object is passed to all command scripts.


\subsection{Syntax}
\label{\detokenize{configuration:syntax}}
The configuration files use a python-like structure format
(see \sphinxhref{http://www.red-dove.com/config-doc/}{config module}%
\begin{footnote}[3]\sphinxAtStartFootnote
\sphinxnolinkurl{http://www.red-dove.com/config-doc/}
%
\end{footnote} for a complete description).
\begin{itemize}
\item {} 
\sphinxstylestrong{\{\}} define a dictionary,

\item {} 
\sphinxstylestrong{{[}{]}} define a list,

\item {} 
\sphinxstylestrong{@} can be used to include a file,

\item {} 
\sphinxstylestrong{\$prefix} reference to another parameter (ex: \sphinxcode{\sphinxupquote{\$PRODUCT.name}}),

\item {} 
\sphinxstylestrong{\#} comments.

\end{itemize}

\begin{sphinxadmonition}{note}{Note:}
in this documentation a reference to a configuration parameter will be noted \sphinxcode{\sphinxupquote{XXX.YYY}}.
\end{sphinxadmonition}


\subsection{Description}
\label{\detokenize{configuration:description}}

\subsubsection{VARS section}
\label{\detokenize{configuration:vars-section}}\label{\detokenize{configuration:id1}}
\begin{DUlineblock}{0em}
\item[] This section is dynamically created by salomeTools at run time.
\item[] It contains information about the environment: date, time, OS, architecture etc.
\end{DUlineblock}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{c+c1}{\PYGZsh{} to get the current setting}
\PYG{n}{sat} \PYG{n}{config} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{value} \PYG{n}{VARS}
\end{sphinxVerbatim}


\subsubsection{PRODUCTS section}
\label{\detokenize{configuration:products-section}}
\begin{DUlineblock}{0em}
\item[] This section is defined in the product file.
\item[] It contains instructions on how to build a version of SALOME (list of prerequisites-products and versions)
\end{DUlineblock}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{c+c1}{\PYGZsh{} to get the current setting}
\PYG{n}{sat} \PYG{n}{config} \PYG{n}{SALOME}\PYG{o}{\PYGZhy{}}\PYG{n}{xx} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{value} \PYG{n}{PRODUCTS}
\end{sphinxVerbatim}


\subsubsection{APPLICATION section}
\label{\detokenize{configuration:application-section}}
\begin{DUlineblock}{0em}
\item[] This section is optional, it is also defined in the product file.
\item[] It gives additional parameters to create an application based on SALOME, as versions of products to use.
\end{DUlineblock}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{c+c1}{\PYGZsh{} to get the current setting}
\PYG{n}{sat} \PYG{n}{config} \PYG{n}{SALOME}\PYG{o}{\PYGZhy{}}\PYG{n}{xx} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{value} \PYG{n}{APPLICATION}
\end{sphinxVerbatim}


\subsubsection{USER section}
\label{\detokenize{configuration:user-section}}\label{\detokenize{configuration:id2}}
This section is defined by the user configuration file,
\sphinxcode{\sphinxupquote{\textasciitilde{}/.salomeTools/salomeTools.pyconf}}.

The \sphinxcode{\sphinxupquote{USER}} section defines some parameters (not exhaustive):
\begin{itemize}
\item {} 
\sphinxstylestrong{workDir} :
\begin{quote}

\begin{DUlineblock}{0em}
\item[] The working directory.
\item[] Each product will be usually installed here (in sub-directories).
\end{DUlineblock}
\end{quote}

\item {} 
\sphinxstylestrong{browser} : The web browser to use (\sphinxstyleemphasis{firefox}).

\item {} 
\sphinxstylestrong{editor} : The editor to use (\sphinxstyleemphasis{vi, pluma}).

\item {} 
and other user preferences.

\end{itemize}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{c+c1}{\PYGZsh{} to get the current setting}
\PYG{n}{sat} \PYG{n}{config} \PYG{n}{SALOME}\PYG{o}{\PYGZhy{}}\PYG{n}{xx} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{value} \PYG{n}{USER}
\end{sphinxVerbatim}

\clearpage


\section{Usage of SAlomeTools}
\label{\detokenize{usage_of_sat:svn}}\label{\detokenize{usage_of_sat:usage-of-salometools}}\label{\detokenize{usage_of_sat::doc}}

\subsection{Usage}
\label{\detokenize{usage_of_sat:usage}}
sat usage is a Command Line Interface (\sphinxhref{https://en.wikipedia.org/wiki/Command-line\_interface}{CLI}%
\begin{footnote}[4]\sphinxAtStartFootnote
\sphinxnolinkurl{https://en.wikipedia.org/wiki/Command-line\_interface}
%
\end{footnote}).

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
sat \PYG{o}{[}generic\PYGZus{}options\PYG{o}{]} \PYG{o}{[}command\PYG{o}{]} \PYG{o}{[}product\PYG{o}{]} \PYG{o}{[}command\PYGZus{}options\PYG{o}{]}
\end{sphinxVerbatim}


\subsubsection{Options of sat}
\label{\detokenize{usage_of_sat:options-of-sat}}
Useful \sphinxstyleemphasis{not exhaustive} generic options of \sphinxstyleemphasis{sat} CLI.


\paragraph{\sphinxstyleemphasis{\textendash{}help or -h}}
\label{\detokenize{usage_of_sat:help-or-h}}
Get help as simple text.

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
sat \PYGZhy{}\PYGZhy{}help          \PYG{c+c1}{\PYGZsh{} get the list of existing commands}
sat \PYGZhy{}\PYGZhy{}help compile  \PYG{c+c1}{\PYGZsh{} get the help on a specific command \PYGZsq{}compile\PYGZsq{}}
\end{sphinxVerbatim}


\paragraph{\sphinxstyleemphasis{\textendash{}debug or -g}}
\label{\detokenize{usage_of_sat:debug-or-g}}
Execution in debug mode allows to see more trace and \sphinxstyleemphasis{stack} if an exception is raised.


\paragraph{\sphinxstyleemphasis{\textendash{}verbose or -v}}
\label{\detokenize{usage_of_sat:verbose-or-v}}
Change verbosity level (default is 3).

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{c+c1}{\PYGZsh{} for product \PYGZsq{}SALOME\PYGZus{}xx\PYGZsq{} for example}
\PYG{c+c1}{\PYGZsh{} execute compile command in debug mode with trace level 4}
sat \PYGZhy{}g \PYGZhy{}v \PYG{l+m}{4} compile SALOME\PYGZus{}xx
\end{sphinxVerbatim}


\subsection{Build a SALOME product}
\label{\detokenize{usage_of_sat:build-a-salome-product}}

\subsubsection{Get the list of available products}
\label{\detokenize{usage_of_sat:get-the-list-of-available-products}}
To get the list of the current available products in your context:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
sat config \PYGZhy{}\PYGZhy{}list
\end{sphinxVerbatim}


\subsubsection{Prepare sources of a product}
\label{\detokenize{usage_of_sat:prepare-sources-of-a-product}}
To prepare (get) \sphinxstyleemphasis{all} the sources of a product (\sphinxstyleemphasis{SALOME\_xx} for example):

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
sat prepare SALOME\PYGZus{}xx
\end{sphinxVerbatim}

\begin{DUlineblock}{0em}
\item[] The sources are usually copied in directories
\item[] \sphinxstyleemphasis{\$USER.workDir + SALOME\_xx… + SOURCES + \$PRODUCT.name}
\end{DUlineblock}


\subsubsection{Compile SALOME}
\label{\detokenize{usage_of_sat:compile-salome}}
To compile products:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{c+c1}{\PYGZsh{} compile all prerequisites/products}
sat compile SALOME\PYGZus{}xx

\PYG{c+c1}{\PYGZsh{} compile only 2 products (KERNEL and SAMPLES), if not done yet}
sat compile SALOME\PYGZus{}xx \PYGZhy{}\PYGZhy{}products KERNEL,SAMPLES

\PYG{c+c1}{\PYGZsh{} compile only 2 products, unconditionaly}
sat compile SALOME\PYGZus{}xx \PYGZhy{}\PYGZhy{}\PYGZhy{}products SAMPLES \PYGZhy{}\PYGZhy{}clean\PYGZus{}all
\end{sphinxVerbatim}

\begin{DUlineblock}{0em}
\item[] The products are usually build in the directories
\item[] \sphinxstyleemphasis{\$USER.workDir + SALOME\_xx… + BUILD + \$PRODUCT.name}
\item[] 
\item[] The products are usually installed in the directories
\item[] \sphinxstyleemphasis{\$USER.workDir + SALOME\_xx… + INSTALL + \$PRODUCT.name}
\end{DUlineblock}


\chapter{List of Commands}
\label{\detokenize{index:list-of-commands}}
\clearpage


\section{Command doc}
\label{\detokenize{commands/doc:svn}}\label{\detokenize{commands/doc::doc}}\label{\detokenize{commands/doc:command-doc}}

\subsection{Description}
\label{\detokenize{commands/doc:description}}
The \sphinxstylestrong{doc} command displays sat documentation.


\subsection{Usage}
\label{\detokenize{commands/doc:usage}}\begin{itemize}
\item {} 
Show (in a web browser) the sat documentation in format xml/html:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{doc} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{xml}
\end{sphinxVerbatim}

\item {} 
Show (in evince, for example) the (same) sat documentation in format pdf:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{doc} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{pdf}
\end{sphinxVerbatim}

\item {} 
Edit and modify in your preference user editor the sources files (rst) of sat documentation:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{doc} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{edit}
\end{sphinxVerbatim}

\item {} 
get information how to compile locally sat documentation (from the sources files):

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{doc} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n+nb}{compile}
\end{sphinxVerbatim}

\end{itemize}


\subsection{Some useful configuration pathes}
\label{\detokenize{commands/doc:some-useful-configuration-pathes}}\begin{itemize}
\item {} 
\sphinxstylestrong{USER}
\begin{itemize}
\item {} 
\sphinxstylestrong{browser} : The browser used to show the html files (\sphinxstyleemphasis{firefox} for example).

\item {} 
\sphinxstylestrong{pdf\_viewer} : The viewer used to show the pdf files (\sphinxstyleemphasis{evince} for example).

\item {} 
\sphinxstylestrong{editor} : The editor used to edit ascii text files (\sphinxstyleemphasis{pluma or gedit} for example).

\end{itemize}

\end{itemize}

\clearpage


\section{Command config}
\label{\detokenize{commands/config:svn}}\label{\detokenize{commands/config:command-config}}\label{\detokenize{commands/config::doc}}

\subsection{Description}
\label{\detokenize{commands/config:description}}
The \sphinxstylestrong{config} command manages sat configuration.
It allows display, manipulation and operation on configuration files


\subsection{Usage}
\label{\detokenize{commands/config:usage}}\begin{itemize}
\item {} 
Edit the user personal configuration file \sphinxcode{\sphinxupquote{\$HOME/.salomeTools/SAT.pyconf}}. It is used to store the user personal choices, like the favorite editor, browser, pdf viewer:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{config} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{edit}
\end{sphinxVerbatim}

\item {} 
List the available applications (they come from the sat projects defined in \sphinxcode{\sphinxupquote{data/local.pyconf}}:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{config} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n+nb}{list}
\end{sphinxVerbatim}

\item {} 
Edit the configuration of an application:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{config} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{edit}
\end{sphinxVerbatim}

\item {} 
Copy an application configuration file into the user personal directory:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{config} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{copy} \PYG{p}{[}\PYG{n}{new\PYGZus{}name}\PYG{p}{]}
\end{sphinxVerbatim}

\item {} 
\begin{DUlineblock}{0em}
\item[] Print the value of a configuration parameter.
\item[] Use the automatic completion to get recursively the parameter names.
\item[] Use \sphinxstyleemphasis{\textendash{}no\_label} option to get \sphinxstyleemphasis{only} the value, \sphinxstyleemphasis{without} label (useful in automatic scripts).
\item[] Examples (with \sphinxstyleemphasis{SALOME-xx} as \sphinxstyleemphasis{SALOME-8.4.0} ):
\end{DUlineblock}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{c+c1}{\PYGZsh{} sat config \PYGZhy{}\PYGZhy{}value \PYGZlt{}parameter\PYGZus{}path\PYGZgt{}}
sat config \PYGZhy{}\PYGZhy{}value .         \PYG{c+c1}{\PYGZsh{} all the configuration}
sat config \PYGZhy{}\PYGZhy{}value LOCAL
sat config \PYGZhy{}\PYGZhy{}value LOCAL.workdir

\PYG{c+c1}{\PYGZsh{} sat config \PYGZlt{}application\PYGZgt{} \PYGZhy{}\PYGZhy{}value \PYGZlt{}parameter\PYGZus{}path\PYGZgt{}}
sat config SALOME\PYGZhy{}xx \PYGZhy{}\PYGZhy{}value APPLICATION.workdir
sat config SALOME\PYGZhy{}xx \PYGZhy{}\PYGZhy{}no\PYGZus{}label \PYGZhy{}\PYGZhy{}value APPLICATION.workdir
\end{sphinxVerbatim}

\item {} 
\begin{DUlineblock}{0em}
\item[] Print in one-line-by-value mode the value of a configuration parameter,
\item[] with its source \sphinxstyleemphasis{expression}, if any.
\item[] This is a debug mode, useful for developers.
\item[] Prints the parameter path, the source expression if any, and the final value:
\end{DUlineblock}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{config} \PYG{n}{SALOME}\PYG{o}{\PYGZhy{}}\PYG{n}{xx} \PYG{o}{\PYGZhy{}}\PYG{n}{g} \PYG{n}{USER}
\end{sphinxVerbatim}

\begin{sphinxadmonition}{note}{Note:}
And so, \sphinxstyleemphasis{not only for fun}, to get \sphinxstylestrong{all expressions} of configuration

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
sat config SALOME\PYGZhy{}xx \PYGZhy{}g . \PYG{p}{\textbar{}} grep \PYGZhy{}e \PYG{l+s+s2}{\PYGZdq{}\PYGZhy{}\PYGZhy{}\PYGZgt{}\PYGZdq{}}
\end{sphinxVerbatim}
\end{sphinxadmonition}

\item {} 
Print the patches that are applied:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{config} \PYG{n}{SALOME}\PYG{o}{\PYGZhy{}}\PYG{n}{xx} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{show\PYGZus{}patchs}
\end{sphinxVerbatim}

\item {} 
Get information on a product configuration:

\end{itemize}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{c+c1}{\PYGZsh{} sat config \PYGZlt{}application\PYGZgt{} \PYGZhy{}\PYGZhy{}info \PYGZlt{}product\PYGZgt{}}
sat config SALOME\PYGZhy{}xx \PYGZhy{}\PYGZhy{}info KERNEL
sat config SALOME\PYGZhy{}xx \PYGZhy{}\PYGZhy{}info qt
\end{sphinxVerbatim}


\subsection{Some useful configuration pathes}
\label{\detokenize{commands/config:some-useful-configuration-pathes}}
Exploring a current configuration.
\begin{itemize}
\item {} 
\sphinxstylestrong{PATHS}: To get list of directories where to find files.

\item {} 
\sphinxstylestrong{USER}: To get user preferences (editor, pdf viewer, web browser, default working dir).

\end{itemize}

sat commands:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{config} \PYG{n}{SALOME}\PYG{o}{\PYGZhy{}}\PYG{n}{xx} \PYG{o}{\PYGZhy{}}\PYG{n}{v} \PYG{n}{PATHS}
\PYG{n}{sat} \PYG{n}{config} \PYG{n}{SALOME}\PYG{o}{\PYGZhy{}}\PYG{n}{xx} \PYG{o}{\PYGZhy{}}\PYG{n}{v} \PYG{n}{USERS}
\end{sphinxVerbatim}

\clearpage


\section{Command prepare}
\label{\detokenize{commands/prepare:svn}}\label{\detokenize{commands/prepare:command-prepare}}\label{\detokenize{commands/prepare::doc}}

\subsection{Description}
\label{\detokenize{commands/prepare:description}}
The \sphinxstylestrong{prepare} command brings the sources of an application in the \sphinxstyleemphasis{sources
application directory}, in order to compile them with the compile command.

The sources can be prepared from VCS software (\sphinxstyleemphasis{cvs, svn, git}), an archive or a directory.

\begin{sphinxadmonition}{warning}{Warning:}
When sat prepares a product, it first removes the
existing directory, except if the development mode is activated.
When you are working on a product, you need to declare in
the application configuration this product in \sphinxstylestrong{dev} mode.
\end{sphinxadmonition}


\subsection{Remarks}
\label{\detokenize{commands/prepare:remarks}}

\subsubsection{VCS bases (git, svn, cvs)}
\label{\detokenize{commands/prepare:vcs-bases-git-svn-cvs}}
The \sphinxstyleemphasis{prepare} command does not manage authentication on the cvs server.
For example, to prepare modules from a cvs server, you first need to login once.

To avoid typing a password for each product,
you may use a ssh key with passphrase, or store your password
(in .cvspass or .gitconfig files).
If you have security concerns, it is also possible to use
a bash agent and type your password only once.


\subsubsection{Dev mode}
\label{\detokenize{commands/prepare:dev-mode}}
By default \sphinxstyleemphasis{prepare} uses \sphinxstyleemphasis{export} mode: it creates an image
of the sources, corresponding to the tag or branch specified,
without any link to the VCS base.
To perform a \sphinxstyleemphasis{checkout} (svn, cvs) or a \sphinxstyleemphasis{git clone} (git),
you need to declare the product in dev mode in your application configuration:
edit the application configuration file (pyconf) and modify the product declaration:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
sat config \PYGZlt{}application\PYGZgt{} \PYGZhy{}e
\PYG{c+c1}{\PYGZsh{} and edit the product section:}
\PYG{c+c1}{\PYGZsh{}   \PYGZlt{}product\PYGZgt{} : \PYGZob{}tag : \PYGZdq{}my\PYGZus{}tag\PYGZdq{}, dev : \PYGZdq{}yes\PYGZdq{}, debug : \PYGZdq{}yes\PYGZdq{}\PYGZcb{}}
\end{sphinxVerbatim}

The first time you will execute the \sphinxstyleemphasis{sat prepare} command,
your module will be downloaded in \sphinxstyleemphasis{checkout} mode
(inside the SOURCES directory of the application.
Then, you can develop in this repository, and finally push
them in the base when they are ready.
If you type during the development process by mistake
a \sphinxstyleemphasis{sat prepare} command, the sources in dev mode will
not be altered/removed (Unless you use -f option)


\subsection{Usage}
\label{\detokenize{commands/prepare:usage}}\begin{itemize}
\item {} 
Prepare the sources of a complete application in SOURCES directory (all products):

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{prepare} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}}
\end{sphinxVerbatim}

\item {} 
Prepare only some modules:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{prepare} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}}  \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{products} \PYG{o}{\PYGZlt{}}\PYG{n}{product1}\PYG{o}{\PYGZgt{}}\PYG{p}{,}\PYG{o}{\PYGZlt{}}\PYG{n}{product2}\PYG{o}{\PYGZgt{}} \PYG{o}{.}\PYG{o}{.}\PYG{o}{.}
\end{sphinxVerbatim}

\item {} 
Use \textendash{}force to force to prepare the products in development mode
(this will remove the sources and do a new clone/checkout):

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{prepare} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{force}
\end{sphinxVerbatim}

\item {} 
Use \textendash{}force\_patch to force to apply patch to the products
in development mode (otherwise they are not applied):

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{prepare} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{force\PYGZus{}patch}
\end{sphinxVerbatim}

\end{itemize}


\subsection{Some useful configuration pathes}
\label{\detokenize{commands/prepare:some-useful-configuration-pathes}}
Command \sphinxstyleemphasis{sat prepare} uses the \sphinxstyleemphasis{pyconf file configuration} of each product to know how to get the sources.

\begin{sphinxadmonition}{note}{Note:}
to verify configuration of a product, and get name of this \sphinxstyleemphasis{pyconf files configuration}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
sat config \PYGZlt{}application\PYGZgt{} \PYGZhy{}\PYGZhy{}info \PYGZlt{}product\PYGZgt{}
\end{sphinxVerbatim}
\end{sphinxadmonition}
\begin{itemize}
\item {} 
\sphinxstylestrong{get\_method}: the method to use to prepare the module, possible values are cvs, git, archive, dir.

\item {} 
\sphinxstylestrong{git\_info} : (used if get\_method = git) information to prepare sources from git.

\item {} 
\sphinxstylestrong{svn\_info} : (used if get\_method = svn) information to prepare sources from cvs.

\item {} 
\sphinxstylestrong{cvs\_info} : (used if get\_method = cvs) information to prepare sources from cvs.

\item {} 
\sphinxstylestrong{archive\_info} : (used if get\_method = archive) the path to the archive.

\item {} 
\sphinxstylestrong{dir\_info} : (used if get\_method = dir) the directory with the sources.

\end{itemize}

\clearpage


\section{Command compile}
\label{\detokenize{commands/compile:svn}}\label{\detokenize{commands/compile:command-compile}}\label{\detokenize{commands/compile::doc}}

\subsection{Description}
\label{\detokenize{commands/compile:description}}
The \sphinxstylestrong{compile} command allows compiling the products of a \sphinxhref{http://www.salome-platform.org}{SALOME}%
\begin{footnote}[5]\sphinxAtStartFootnote
\sphinxnolinkurl{http://www.salome-platform.org}
%
\end{footnote} application.


\subsection{Usage}
\label{\detokenize{commands/compile:usage}}\begin{itemize}
\item {} 
Compile a complete application:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n+nb}{compile} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}}
\end{sphinxVerbatim}

\item {} 
Compile only some products:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n+nb}{compile} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{products} \PYG{o}{\PYGZlt{}}\PYG{n}{product1}\PYG{o}{\PYGZgt{}}\PYG{p}{,}\PYG{o}{\PYGZlt{}}\PYG{n}{product2}\PYG{o}{\PYGZgt{}} \PYG{o}{.}\PYG{o}{.}\PYG{o}{.}
\end{sphinxVerbatim}

\item {} 
Use \sphinxstyleemphasis{sat -t} to duplicate the logs in the terminal (by default the log are stored and displayed with \sphinxstyleemphasis{sat log} command):

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{o}{\PYGZhy{}}\PYG{n}{t} \PYG{n+nb}{compile} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{products} \PYG{o}{\PYGZlt{}}\PYG{n}{product1}\PYG{o}{\PYGZgt{}}
\end{sphinxVerbatim}

\item {} 
Compile a module and its dependencies:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n+nb}{compile} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{products} \PYG{n}{med} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{with\PYGZus{}fathers}
\end{sphinxVerbatim}

\item {} 
Compile a module and the modules depending on it (for example plugins):

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n+nb}{compile} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{products} \PYG{n}{med} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{with\PYGZus{}children}
\end{sphinxVerbatim}

\item {} 
Clean the build and install directories before starting compilation:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n+nb}{compile} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{products} \PYG{n}{GEOM}  \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{clean\PYGZus{}all}
\end{sphinxVerbatim}

\begin{sphinxadmonition}{note}{Note:}
\begin{DUlineblock}{0em}
\item[] a warning will be shown if option \sphinxstyleemphasis{\textendash{}products} is missing
\item[] (as it will clean everything)
\end{DUlineblock}
\end{sphinxadmonition}

\item {} 
Clean only the install directories before starting compilation:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n+nb}{compile} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{clean\PYGZus{}install}
\end{sphinxVerbatim}

\item {} 
Add options for make:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n+nb}{compile} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{products} \PYG{o}{\PYGZlt{}}\PYG{n}{product}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{make\PYGZus{}flags} \PYG{o}{\PYGZlt{}}\PYG{n}{flags}\PYG{o}{\PYGZgt{}}
\end{sphinxVerbatim}

\item {} 
Use the \sphinxstyleemphasis{\textendash{}check} option to execute the unit tests after compilation:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n+nb}{compile} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{check}
\end{sphinxVerbatim}

\item {} 
Remove the build directory after successful compilation (some build directory like qt are big):

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n+nb}{compile} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{products} \PYG{n}{qt} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{clean\PYGZus{}build\PYGZus{}after}
\end{sphinxVerbatim}

\item {} 
Stop the compilation as soon as the compilation of a module fails:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n+nb}{compile} \PYG{o}{\PYGZlt{}}\PYG{n}{product}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{stop\PYGZus{}first\PYGZus{}fail}
\end{sphinxVerbatim}

\item {} 
Do not compile, just show if products are installed or not, and where is the installation:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n+nb}{compile} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{show}
\end{sphinxVerbatim}

\end{itemize}


\subsection{Some useful configuration pathes}
\label{\detokenize{commands/compile:some-useful-configuration-pathes}}
The way to compile a product is defined in the \sphinxstyleemphasis{pyconf file configuration}.
The main options are:
\begin{itemize}
\item {} 
\sphinxstylestrong{build\_source} : the method used to build the product (cmake/autotools/script)

\item {} 
\sphinxstylestrong{compil\_script} : the compilation script if build\_source is equal to “script”

\item {} 
\sphinxstylestrong{cmake\_options} : additional options for cmake.

\item {} 
\sphinxstylestrong{nb\_proc} : number of jobs to use with make for this product.

\end{itemize}

\clearpage


\section{Command launcher}
\label{\detokenize{commands/launcher:svn}}\label{\detokenize{commands/launcher:command-launcher}}\label{\detokenize{commands/launcher::doc}}

\subsection{Description}
\label{\detokenize{commands/launcher:description}}
The \sphinxstylestrong{launcher} command creates a SALOME launcher, a python script file to start \sphinxhref{http://www.salome-platform.org}{SALOME}%
\begin{footnote}[6]\sphinxAtStartFootnote
\sphinxnolinkurl{http://www.salome-platform.org}
%
\end{footnote}.


\subsection{Usage}
\label{\detokenize{commands/launcher:usage}}\begin{itemize}
\item {} 
Create a launcher:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{launcher} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}}
\end{sphinxVerbatim}

Generate a launcher in the application directory, i.e \sphinxcode{\sphinxupquote{\$APPLICATION.workdir}}.

\item {} 
Create a launcher with a given name (default name is \sphinxcode{\sphinxupquote{APPLICATION.profile.launcher\_name}})

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{launcher} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{name} \PYG{n}{ZeLauncher}
\end{sphinxVerbatim}

The launcher will be called \sphinxstyleemphasis{ZeLauncher}.

\item {} 
Set a specific resources catalog:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{launcher} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}}  \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{catalog}  \PYG{o}{\PYGZlt{}}\PYG{n}{path} \PYG{n}{of} \PYG{n}{a} \PYG{n}{salome} \PYG{n}{resources} \PYG{n}{catalog}\PYG{o}{\PYGZgt{}}
\end{sphinxVerbatim}

Note that the catalog specified will be copied to the profile directory.

\item {} 
Generate the catalog for a list of machines:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{launcher} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{gencat} \PYG{o}{\PYGZlt{}}\PYG{n+nb}{list} \PYG{n}{of} \PYG{n}{machines}\PYG{o}{\PYGZgt{}}
\end{sphinxVerbatim}

This will create a catalog by querying each machine (memory, number of processor) with ssh.

\item {} 
Generate a mesa launcher (if mesa and llvm are parts of the application). Use this option only if you have to use salome through ssh and have problems with ssh X forwarding of OpengGL modules (like Paravis):

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{launcher} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{use\PYGZus{}mesa}
\end{sphinxVerbatim}

\end{itemize}


\subsection{Configuration}
\label{\detokenize{commands/launcher:configuration}}
Some useful configuration pathes:
\begin{itemize}
\item {} 
\sphinxstylestrong{APPLICATION.profile}
\begin{itemize}
\item {} 
\sphinxstylestrong{product} : the name of the profile product (the product in charge of holding the application stuff, like logos, splashscreen)

\item {} 
\sphinxstylestrong{launcher\_name} : the name of the launcher.

\end{itemize}

\end{itemize}

\clearpage


\section{Command application}
\label{\detokenize{commands/application:svn}}\label{\detokenize{commands/application::doc}}\label{\detokenize{commands/application:command-application}}

\subsection{Description}
\label{\detokenize{commands/application:description}}
The \sphinxstylestrong{application} command creates a virtual \sphinxhref{http://www.salome-platform.org}{SALOME}%
\begin{footnote}[7]\sphinxAtStartFootnote
\sphinxnolinkurl{http://www.salome-platform.org}
%
\end{footnote} application.
Virtual SALOME applications are used to start SALOME when distribution is needed.


\subsection{Usage}
\label{\detokenize{commands/application:usage}}\begin{itemize}
\item {} 
Create an application:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{application} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}}
\end{sphinxVerbatim}

Create the virtual application directory in the salomeTool application directory \sphinxcode{\sphinxupquote{\$APPLICATION.workdir}}.

\item {} 
Give a name to the application:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{application} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{name} \PYG{o}{\PYGZlt{}}\PYG{n}{my\PYGZus{}application\PYGZus{}name}\PYG{o}{\PYGZgt{}}
\end{sphinxVerbatim}

\sphinxstyleemphasis{Remark}: this option overrides the name given in the virtual\_app section of the configuration file \sphinxcode{\sphinxupquote{\$APPLICATION.virtual\_app.name}}.

\item {} 
Change the directory where the application is created:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{application} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{target} \PYG{o}{\PYGZlt{}}\PYG{n}{my\PYGZus{}application\PYGZus{}directory}\PYG{o}{\PYGZgt{}}
\end{sphinxVerbatim}

\item {} 
Set a specific \sphinxhref{http://www.salome-platform.org}{SALOME}%
\begin{footnote}[8]\sphinxAtStartFootnote
\sphinxnolinkurl{http://www.salome-platform.org}
%
\end{footnote} resources catalog (it will be used for the distribution of components on distant machines):

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{application} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{catalog} \PYG{o}{\PYGZlt{}}\PYG{n}{path\PYGZus{}to\PYGZus{}catalog}\PYG{o}{\PYGZgt{}}
\end{sphinxVerbatim}

Note that the catalog specified will be copied to the application directory.

\item {} 
Generate the catalog for a list of machines:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{application} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{gencat} \PYG{n}{machine1}\PYG{p}{,}\PYG{n}{machine2}\PYG{p}{,}\PYG{n}{machine3}
\end{sphinxVerbatim}

This will create a catalog by querying each machine through ssh protocol (memory, number of processor) with ssh.

\item {} 
Generate a mesa application (if mesa and llvm are parts of the application). Use this option only if you have to use salome through ssh and have problems with ssh X forwarding of OpengGL modules (like Paravis):

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{launcher} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{use\PYGZus{}mesa}
\end{sphinxVerbatim}

\end{itemize}


\subsection{Some useful configuration pathes}
\label{\detokenize{commands/application:some-useful-configuration-pathes}}
The virtual application can be configured with the virtual\_app section of the configutation file.
\begin{itemize}
\item {} 
\sphinxstylestrong{APPLICATION.virtual\_app}
\begin{itemize}
\item {} 
\sphinxstylestrong{name} : name of the launcher (to replace the default runAppli).

\item {} 
\sphinxstylestrong{application\_name} : (optional) the name of the virtual application directory, if missing the default value is \sphinxcode{\sphinxupquote{\$name + \_appli}}.

\end{itemize}

\end{itemize}

\clearpage


\section{Command log}
\label{\detokenize{commands/log:svn}}\label{\detokenize{commands/log:command-log}}\label{\detokenize{commands/log::doc}}

\subsection{Description}
\label{\detokenize{commands/log:description}}
The \sphinxstylestrong{log} command displays sat log in a web browser or in a terminal.


\subsection{Usage}
\label{\detokenize{commands/log:usage}}\begin{itemize}
\item {} 
Show (in a web browser) the log of the commands corresponding to an application:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{log} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}}
\end{sphinxVerbatim}

\item {} 
Show the log for commands that do not use any application:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{log}
\end{sphinxVerbatim}

\item {} 
The \textendash{}terminal (or -t) display the log directly in the terminal, through a \sphinxhref{https://en.wikipedia.org/wiki/Command-line\_interface}{CLI}%
\begin{footnote}[9]\sphinxAtStartFootnote
\sphinxnolinkurl{https://en.wikipedia.org/wiki/Command-line\_interface}
%
\end{footnote} interactive menu:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{log} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{terminal}
\end{sphinxVerbatim}

\item {} 
The \textendash{}last option displays only the last command:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{log} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{last}
\end{sphinxVerbatim}

\item {} 
To access the last compilation log in terminal mode, use \textendash{}last\_terminal option:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{log} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{last\PYGZus{}terminal}
\end{sphinxVerbatim}

\item {} 
The \textendash{}clean (int) option erases the n older log files and print the number of remaining log files:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{log} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{clean} \PYG{l+m+mi}{50}
\end{sphinxVerbatim}

\end{itemize}


\subsection{Some useful configuration pathes}
\label{\detokenize{commands/log:some-useful-configuration-pathes}}\begin{itemize}
\item {} 
\sphinxstylestrong{USER}
\begin{itemize}
\item {} 
\sphinxstylestrong{browser} : The browser used to show the log (by default \sphinxstyleemphasis{firefox}).

\item {} 
\sphinxstylestrong{log\_dir} : The directory used to store the log files.

\end{itemize}

\end{itemize}

\clearpage


\section{Command environ}
\label{\detokenize{commands/environ:svn}}\label{\detokenize{commands/environ:command-environ}}\label{\detokenize{commands/environ::doc}}

\subsection{Description}
\label{\detokenize{commands/environ:description}}
The \sphinxstylestrong{environ} command generates the environment files used
to run and compile your application (as \sphinxhref{http://www.salome-platform.org}{SALOME}%
\begin{footnote}[10]\sphinxAtStartFootnote
\sphinxnolinkurl{http://www.salome-platform.org}
%
\end{footnote} is an example).

\begin{sphinxadmonition}{note}{Note:}
these files are \sphinxstylestrong{not} required,
salomeTool set the environment himself, when compiling.
And so does the salome launcher.

These files are useful when someone wants to check the environment.
They could be used in debug mode to set the environment for \sphinxstyleemphasis{gdb}.
\end{sphinxadmonition}

The configuration part at the end of this page explains how
to specify the environment used by sat (at build or run time),
and saved in some files by \sphinxstyleemphasis{sat environ} command.


\subsection{Usage}
\label{\detokenize{commands/environ:usage}}\begin{itemize}
\item {} 
Create the shell environment files of the application:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{environ} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}}
\end{sphinxVerbatim}

\item {} 
Create the environment files of the application for a given shell.
Options are bash, bat (for windows) and cfg (the configuration format used by \sphinxhref{http://www.salome-platform.org}{SALOME}%
\begin{footnote}[11]\sphinxAtStartFootnote
\sphinxnolinkurl{http://www.salome-platform.org}
%
\end{footnote}):

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{environ} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{shell} \PYG{p}{[}\PYG{n}{bash}\PYG{o}{\textbar{}}\PYG{n}{cfg}\PYG{o}{\textbar{}}\PYG{n+nb}{all}\PYG{p}{]}
\end{sphinxVerbatim}

\item {} 
Use a different prefix for the files (default is ‘env’):

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{c+c1}{\PYGZsh{} This will create file \PYGZlt{}prefix\PYGZgt{}\PYGZus{}launch.sh, \PYGZlt{}prefix\PYGZgt{}\PYGZus{}build.sh}
sat environ \PYGZlt{}application\PYGZgt{} \PYGZhy{}\PYGZhy{}prefix \PYGZlt{}prefix\PYGZgt{}
\end{sphinxVerbatim}

\item {} 
Use a different target directory for the files:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{c+c1}{\PYGZsh{} This will create file env\PYGZus{}launch.sh, env\PYGZus{}build.sh}
\PYG{c+c1}{\PYGZsh{} in the directory corresponding to \PYGZlt{}path\PYGZgt{}}
sat environ \PYGZlt{}application\PYGZgt{} \PYGZhy{}\PYGZhy{}target \PYGZlt{}path\PYGZgt{}
\end{sphinxVerbatim}

\item {} 
Generate the environment files only with the given products:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{c+c1}{\PYGZsh{} This will create the environment files only for the given products}
\PYG{c+c1}{\PYGZsh{} and their prerequisites.}
\PYG{c+c1}{\PYGZsh{} It is useful when you want to visualise which environment uses}
\PYG{c+c1}{\PYGZsh{} sat to compile a given product.}
sat environ \PYGZlt{}application\PYGZgt{} \PYGZhy{}\PYGZhy{}product \PYGZlt{}product1\PYGZgt{},\PYGZlt{}product2\PYGZgt{}, ...
\end{sphinxVerbatim}

\end{itemize}


\subsection{Configuration}
\label{\detokenize{commands/environ:configuration}}
The specification of the environment can be done through several mechanisms.
\begin{enumerate}
\item {} 
For salome products (the products with the property \sphinxcode{\sphinxupquote{is\_SALOME\_module}} as \sphinxcode{\sphinxupquote{yes}}) the environment is set automatically by sat, in respect with \sphinxhref{http://www.salome-platform.org}{SALOME}%
\begin{footnote}[12]\sphinxAtStartFootnote
\sphinxnolinkurl{http://www.salome-platform.org}
%
\end{footnote} requirements.

\item {} 
For other products, the environment is set with the use of the environ section within the pyconf file of the product. The user has two possibilities, either set directly the environment within the section, or specify a python script which wil be used to set the environment programmatically.

\end{enumerate}

Within the section, the user can define environment variables. He can also modify PATH variables, by appending or prepending directories.
In the following example, we prepend \sphinxstyleemphasis{\textless{}install\_dir\textgreater{}/lib} to \sphinxcode{\sphinxupquote{LD\_LIBRARY\_PATH}} (note the \sphinxstyleemphasis{left first} underscore), append \sphinxstyleemphasis{\textless{}install\_dir\textgreater{}/lib} to \sphinxcode{\sphinxupquote{PYTHONPATH}} (note the \sphinxstyleemphasis{right last} underscore), and set \sphinxcode{\sphinxupquote{LAPACK\_ROOT\_DIR}} to \sphinxstyleemphasis{\textless{}install\_dir\textgreater{}}:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
environ :
\PYG{o}{\PYGZob{}}
  \PYGZus{}LD\PYGZus{}LIBRARY\PYGZus{}PATH : \PYG{n+nv}{\PYGZdl{}install\PYGZus{}dir} + \PYG{n+nv}{\PYGZdl{}VARS}.sep + \PYG{l+s+s2}{\PYGZdq{}lib\PYGZdq{}}
  PYTHONPATH\PYGZus{} : \PYG{n+nv}{\PYGZdl{}install\PYGZus{}dir} + \PYG{n+nv}{\PYGZdl{}VARS}.sep + \PYG{l+s+s2}{\PYGZdq{}lib\PYGZdq{}}
  LAPACK\PYGZus{}ROOT\PYGZus{}DIR : \PYG{n+nv}{\PYGZdl{}install\PYGZus{}dir}
\PYG{o}{\PYGZcb{}}
\end{sphinxVerbatim}

It is possible to distinguish the build environment from the launch environment: use a subsection called \sphinxstyleemphasis{build} or \sphinxstyleemphasis{launch}. In the example below, \sphinxcode{\sphinxupquote{LD\_LIBRARY\_PATH}} and \sphinxcode{\sphinxupquote{PYTHONPATH}} are only modified at run time, not at compile time:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
environ :
\PYG{o}{\PYGZob{}}
  build :
  \PYG{o}{\PYGZob{}}
    LAPACK\PYGZus{}ROOT\PYGZus{}DIR : \PYG{n+nv}{\PYGZdl{}install\PYGZus{}dir}
  \PYG{o}{\PYGZcb{}}
  launch :
  \PYG{o}{\PYGZob{}}
    LAPACK\PYGZus{}ROOT\PYGZus{}DIR : \PYG{n+nv}{\PYGZdl{}install\PYGZus{}dir}
    \PYGZus{}LD\PYGZus{}LIBRARY\PYGZus{}PATH : \PYG{n+nv}{\PYGZdl{}install\PYGZus{}dir} + \PYG{n+nv}{\PYGZdl{}VARS}.sep + \PYG{l+s+s2}{\PYGZdq{}lib\PYGZdq{}}
    PYTHONPATH\PYGZus{} : \PYG{n+nv}{\PYGZdl{}install\PYGZus{}dir} + \PYG{n+nv}{\PYGZdl{}VARS}.sep + \PYG{l+s+s2}{\PYGZdq{}lib\PYGZdq{}}
  \PYG{o}{\PYGZcb{}}
\PYG{o}{\PYGZcb{}}
\end{sphinxVerbatim}
\begin{enumerate}
\setcounter{enumi}{2}
\item {} 
The last possibility is to set the environment with a python script. The script should be provided in the \sphinxstyleemphasis{products/env\_scripts} directory of the sat project, and its name is specified in the environment section with the key \sphinxcode{\sphinxupquote{environ.env\_script}}:

\end{enumerate}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{environ} \PYG{p}{:}
\PYG{p}{\PYGZob{}}
  \PYG{n}{env\PYGZus{}script} \PYG{p}{:} \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{lapack.py}\PYG{l+s+s1}{\PYGZsq{}}
\PYG{p}{\PYGZcb{}}
\end{sphinxVerbatim}

Please note that the two modes are complementary and are both taken into account.
Most of the time, the first mode is sufficient.

The second mode can be used when the environment has to be set programmatically.
The developer implements a handle (as a python method)
which is called by sat to set the environment.
Here is an example:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{c+ch}{\PYGZsh{}!/usr/bin/env python}
\PYG{c+c1}{\PYGZsh{}\PYGZhy{}*\PYGZhy{} coding:utf\PYGZhy{}8 \PYGZhy{}*\PYGZhy{}}

\PYG{k+kn}{import} \PYG{n+nn}{os.path}
\PYG{k+kn}{import} \PYG{n+nn}{platform}

\PYG{k}{def} \PYG{n+nf}{set\PYGZus{}env}\PYG{p}{(}\PYG{n}{env}\PYG{p}{,} \PYG{n}{prereq\PYGZus{}dir}\PYG{p}{,} \PYG{n}{version}\PYG{p}{)}\PYG{p}{:}
    \PYG{n}{env}\PYG{o}{.}\PYG{n}{set}\PYG{p}{(}\PYG{l+s+s2}{\PYGZdq{}}\PYG{l+s+s2}{TRUST\PYGZus{}ROOT\PYGZus{}DIR}\PYG{l+s+s2}{\PYGZdq{}}\PYG{p}{,}\PYG{n}{prereq\PYGZus{}dir}\PYG{p}{)}
    \PYG{n}{env}\PYG{o}{.}\PYG{n}{prepend}\PYG{p}{(}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{PATH}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{n}{os}\PYG{o}{.}\PYG{n}{path}\PYG{o}{.}\PYG{n}{join}\PYG{p}{(}\PYG{n}{prereq\PYGZus{}dir}\PYG{p}{,} \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{bin}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{)}\PYG{p}{)}
    \PYG{n}{env}\PYG{o}{.}\PYG{n}{prepend}\PYG{p}{(}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{PATH}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{n}{os}\PYG{o}{.}\PYG{n}{path}\PYG{o}{.}\PYG{n}{join}\PYG{p}{(}\PYG{n}{prereq\PYGZus{}dir}\PYG{p}{,} \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{include}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{)}\PYG{p}{)}
    \PYG{n}{env}\PYG{o}{.}\PYG{n}{prepend}\PYG{p}{(}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{LD\PYGZus{}LIBRARY\PYGZus{}PATH}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{n}{os}\PYG{o}{.}\PYG{n}{path}\PYG{o}{.}\PYG{n}{join}\PYG{p}{(}\PYG{n}{prereq\PYGZus{}dir}\PYG{p}{,} \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{lib}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{)}\PYG{p}{)}
    \PYG{k}{return}
\end{sphinxVerbatim}

SalomeTools defines four handles:
\begin{itemize}
\item {} 
\sphinxstylestrong{set\_env(env, prereq\_dir, version)} : used at build and run time.

\item {} 
\sphinxstylestrong{set\_env\_launch(env, prereq\_dir, version)} : used only at run time (if defined!)

\item {} 
\sphinxstylestrong{set\_env\_build(env, prereq\_dir, version)} : used only at build time (if defined!)

\item {} 
\sphinxstylestrong{set\_native\_env(env)} : used only for native products, at build and run time.

\end{itemize}

\clearpage


\section{Command clean}
\label{\detokenize{commands/clean:svn}}\label{\detokenize{commands/clean:command-clean}}\label{\detokenize{commands/clean::doc}}

\subsection{Description}
\label{\detokenize{commands/clean:description}}
The \sphinxstylestrong{clean} command removes products in the \sphinxstyleemphasis{source, build, or install} directories of an application. Theses directories are usually named \sphinxcode{\sphinxupquote{SOURCES, BUILD, INSTALL}}.

Use the options to define what directories you want to suppress and to set the list of products


\subsection{Usage}
\label{\detokenize{commands/clean:usage}}\begin{itemize}
\item {} 
Clean all previously created \sphinxstyleemphasis{build} and \sphinxstyleemphasis{install} directories (example application as \sphinxstyleemphasis{SALOME\_xx}):

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{c+c1}{\PYGZsh{} take care, is long time to restore, sometimes}
sat clean SALOME\PYGZhy{}xx \PYGZhy{}\PYGZhy{}build \PYGZhy{}\PYGZhy{}install
\end{sphinxVerbatim}

\item {} 
Clean previously created \sphinxstyleemphasis{build} and \sphinxstyleemphasis{install} directories, only for products with property \sphinxstyleemphasis{is\_salome\_module}:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
sat clean SALOME\PYGZhy{}xxx \PYGZhy{}\PYGZhy{}build \PYGZhy{}\PYGZhy{}install \PYG{l+s+se}{\PYGZbs{}}
                     \PYGZhy{}\PYGZhy{}properties is\PYGZus{}salome\PYGZus{}module:yes
\end{sphinxVerbatim}

\end{itemize}


\subsection{Availables options}
\label{\detokenize{commands/clean:availables-options}}\begin{itemize}
\item {} 
\sphinxstylestrong{\textendash{}products} : Products to clean.

\item {} 
\sphinxstylestrong{\textendash{}properties} :

\begin{DUlineblock}{0em}
\item[] Filter the products by their properties.
\item[] Syntax: \sphinxstyleemphasis{\textendash{}properties \textless{}property\textgreater{}:\textless{}value\textgreater{}}
\end{DUlineblock}

\item {} 
\sphinxstylestrong{\textendash{}sources} : Clean the product source directories.

\item {} 
\sphinxstylestrong{\textendash{}build} : Clean the product build directories.

\item {} 
\sphinxstylestrong{\textendash{}install} : Clean the product install directories.

\item {} 
\sphinxstylestrong{\textendash{}all} : Clean the product source, build and install directories.

\item {} 
\sphinxstylestrong{\textendash{}sources\_without\_dev} :

\begin{DUlineblock}{0em}
\item[] Do not clean the products in development mode,
\item[] (they could have \sphinxhref{https://en.wikipedia.org/wiki/Version\_control}{VCS}%
\begin{footnote}[13]\sphinxAtStartFootnote
\sphinxnolinkurl{https://en.wikipedia.org/wiki/Version\_control}
%
\end{footnote} commits pending).
\end{DUlineblock}

\end{itemize}


\subsection{Some useful configuration pathes}
\label{\detokenize{commands/clean:some-useful-configuration-pathes}}
No specific configuration.

\clearpage


\section{Command package}
\label{\detokenize{commands/package:svn}}\label{\detokenize{commands/package:command-package}}\label{\detokenize{commands/package::doc}}

\subsection{Description}
\label{\detokenize{commands/package:description}}
The \sphinxstylestrong{package} command creates a \sphinxhref{http://www.salome-platform.org}{SALOME}%
\begin{footnote}[14]\sphinxAtStartFootnote
\sphinxnolinkurl{http://www.salome-platform.org}
%
\end{footnote} archive (usually a compressed \sphinxhref{https://en.wikipedia.org/wiki/Tar\_(computing)}{Tar}%
\begin{footnote}[15]\sphinxAtStartFootnote
\sphinxnolinkurl{https://en.wikipedia.org/wiki/Tar\_(computing)}
%
\end{footnote} file .tgz).
This tar file is used later to intall SALOME on other remote computer.

Depending on the selected options, the archive includes sources and binaries
of SALOME products and prerequisites.

Usually utility \sphinxstyleemphasis{salomeTools} is included in the archive.

\begin{sphinxadmonition}{note}{Note:}
By default the package includes the sources of prerequisites and products.
To select a subset use the \sphinxstyleemphasis{\textendash{}without\_property} or \sphinxstyleemphasis{\textendash{}with\_vcs} options.
\end{sphinxadmonition}


\subsection{Usage}
\label{\detokenize{commands/package:usage}}\begin{itemize}
\item {} 
Create a package for a product (example as \sphinxstyleemphasis{SALOME\_xx}):

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{package} \PYG{n}{SALOME\PYGZus{}xx}
\end{sphinxVerbatim}

This command will create an archive named \sphinxcode{\sphinxupquote{SALOME\_xx.tgz}}
in the working directory (\sphinxcode{\sphinxupquote{USER.workDir}}).
If the archive already exists, do nothing.

\item {} 
Create a package with a specific name:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{package} \PYG{n}{SALOME\PYGZus{}xx} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{name} \PYG{n}{YourSpecificName}
\end{sphinxVerbatim}

\end{itemize}

\begin{sphinxadmonition}{note}{Note:}
By default, the archive is created in the working directory of the user (\sphinxcode{\sphinxupquote{USER.workDir}}).

If the option \sphinxstyleemphasis{\textendash{}name} is used with a path (relative or absolute) it will be used.

If the option \sphinxstyleemphasis{\textendash{}name} is not used and binaries (prerequisites and products)
are included in the package, the \sphinxhref{https://en.wikipedia.org/wiki/Operating\_system}{OS}%
\begin{footnote}[16]\sphinxAtStartFootnote
\sphinxnolinkurl{https://en.wikipedia.org/wiki/Operating\_system}
%
\end{footnote} architecture
will be appended to the name (example: \sphinxcode{\sphinxupquote{SALOME\_xx-CO7.tgz}}).

Examples:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{c+c1}{\PYGZsh{} Creates SALOME\PYGZus{}xx.tgz in \PYGZdl{}USER.workDir}
\PYG{n}{sat} \PYG{n}{package} \PYG{n}{SALOME\PYGZus{}xx}

\PYG{c+c1}{\PYGZsh{} Creates SALOME\PYGZus{}xx\PYGZus{}\PYGZlt{}arch\PYGZgt{}.tgz in \PYGZdl{}USER.workDir}
\PYG{n}{sat} \PYG{n}{package} \PYG{n}{SALOME\PYGZus{}xx} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{binaries}

\PYG{c+c1}{\PYGZsh{} Creates MySpecificName.tgz in \PYGZdl{}USER.workDir}
\PYG{n}{sat} \PYG{n}{package} \PYG{n}{SALOME\PYGZus{}xx} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{name} \PYG{n}{MySpecificName}
\end{sphinxVerbatim}
\end{sphinxadmonition}
\begin{itemize}
\item {} 
Force the creation of the archive (if it already exists):

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{package} \PYG{n}{SALOME\PYGZus{}xx} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{force}
\end{sphinxVerbatim}

\item {} 
Include the binaries in the archive (products and prerequisites):

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{package} \PYG{n}{SALOME\PYGZus{}xx} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{binaries}
\end{sphinxVerbatim}

This command will create an archive named \sphinxcode{\sphinxupquote{SALOME\_xx \_\textless{}arch\textgreater{}.tgz}}
where \textless{}arch\textgreater{} is the \sphinxhref{https://en.wikipedia.org/wiki/Operating\_system}{OS}%
\begin{footnote}[17]\sphinxAtStartFootnote
\sphinxnolinkurl{https://en.wikipedia.org/wiki/Operating\_system}
%
\end{footnote} architecture of the machine.

\item {} 
Do not delete Version Control System (\sphinxhref{https://en.wikipedia.org/wiki/Version\_control}{VCS}%
\begin{footnote}[18]\sphinxAtStartFootnote
\sphinxnolinkurl{https://en.wikipedia.org/wiki/Version\_control}
%
\end{footnote}) informations from the configurations files of the embedded salomeTools:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{package} \PYG{n}{SALOME\PYGZus{}xx} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{with\PYGZus{}vcs}
\end{sphinxVerbatim}

The version control systems known by this option are \sphinxhref{https://fr.wikipedia.org/wiki/Concurrent\_versions\_system}{CVS}%
\begin{footnote}[19]\sphinxAtStartFootnote
\sphinxnolinkurl{https://fr.wikipedia.org/wiki/Concurrent\_versions\_system}
%
\end{footnote}, \sphinxhref{https://en.wikipedia.org/wiki/Apache\_Subversion}{SVN}%
\begin{footnote}[20]\sphinxAtStartFootnote
\sphinxnolinkurl{https://en.wikipedia.org/wiki/Apache\_Subversion}
%
\end{footnote} and \sphinxhref{https://git-scm.com}{Git}%
\begin{footnote}[21]\sphinxAtStartFootnote
\sphinxnolinkurl{https://git-scm.com}
%
\end{footnote}.

\end{itemize}


\subsection{Some useful configuration pathes}
\label{\detokenize{commands/package:some-useful-configuration-pathes}}
No specific configuration.

\clearpage


\section{Command generate}
\label{\detokenize{commands/generate:svn}}\label{\detokenize{commands/generate:command-generate}}\label{\detokenize{commands/generate::doc}}

\subsection{Description}
\label{\detokenize{commands/generate:description}}
The \sphinxstylestrong{generate} command generates and compile SALOME modules from cpp modules using YACSGEN.

\begin{sphinxadmonition}{note}{Note:}
This command uses YACSGEN to generate the module. It needs to be specified with \sphinxstyleemphasis{\textendash{}yacsgen} option, or defined in the product or by the environment variable \sphinxcode{\sphinxupquote{\$YACSGEN\_ROOT\_DIR}}.
\end{sphinxadmonition}


\subsection{Remarks}
\label{\detokenize{commands/generate:remarks}}\begin{itemize}
\item {} 
This command will only apply on the CPP modules of the application, those who have both properties:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{cpp} \PYG{p}{:} \PYG{l+s+s2}{\PYGZdq{}}\PYG{l+s+s2}{yes}\PYG{l+s+s2}{\PYGZdq{}}
\PYG{n}{generate} \PYG{p}{:} \PYG{l+s+s2}{\PYGZdq{}}\PYG{l+s+s2}{yes}\PYG{l+s+s2}{\PYGZdq{}}
\end{sphinxVerbatim}

\item {} 
The cpp module are usually computational components, and the generated module brings the CORBA layer which allows distributing the compononent on remore machines. cpp modules should conform to YACSGEN/hxx2salome requirements (please refer to YACSGEN documentation)

\end{itemize}


\subsection{Usage}
\label{\detokenize{commands/generate:usage}}\begin{itemize}
\item {} 
Generate all the modules of a product:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{generate} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}}
\end{sphinxVerbatim}

\item {} 
Generate only specific modules:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{generate} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{products} \PYG{o}{\PYGZlt{}}\PYG{n}{list\PYGZus{}of\PYGZus{}products}\PYG{o}{\PYGZgt{}}
\end{sphinxVerbatim}

Remark: modules which don’t have the \sphinxstyleemphasis{generate} property are ignored.

\item {} 
Use a specific version of YACSGEN:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{sat} \PYG{n}{generate} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{yacsgen} \PYG{o}{\PYGZlt{}}\PYG{n}{path\PYGZus{}to\PYGZus{}yacsgen}\PYG{o}{\PYGZgt{}}
\end{sphinxVerbatim}

\end{itemize}


\chapter{Developer documentation}
\label{\detokenize{index:developer-documentation}}
\clearpage


\section{Add a user custom command}
\label{\detokenize{write_command:svn}}\label{\detokenize{write_command:add-a-user-custom-command}}\label{\detokenize{write_command::doc}}

\subsection{Introduction}
\label{\detokenize{write_command:introduction}}
\begin{sphinxadmonition}{note}{Note:}
This documentation is for \sphinxhref{https://docs.python.org/2.7}{Python}%
\begin{footnote}[22]\sphinxAtStartFootnote
\sphinxnolinkurl{https://docs.python.org/2.7}
%
\end{footnote} developers.
\end{sphinxadmonition}

The salomeTools product provides a simple way to develop commands.
The first thing to do is to add a file with \sphinxstyleemphasis{.py} extension in the \sphinxcode{\sphinxupquote{commands}} directory of salomeTools.

Here are the basic requirements that must be followed in this file in order to add a command.


\subsection{Basic requirements}
\label{\detokenize{write_command:basic-requirements}}
By adding a file \sphinxstyleemphasis{mycommand.py} in the \sphinxcode{\sphinxupquote{commands}} directory, salomeTools will define a new command named \sphinxcode{\sphinxupquote{mycommand}}.

In \sphinxstyleemphasis{mycommand.py}, there must be the following method:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{k}{def} \PYG{n+nf}{run}\PYG{p}{(}\PYG{n}{args}\PYG{p}{,} \PYG{n}{runner}\PYG{p}{,} \PYG{n}{logger}\PYG{p}{)}\PYG{p}{:}
    \PYG{c+c1}{\PYGZsh{} your algorithm ...}
    \PYG{k}{pass}
\end{sphinxVerbatim}

In fact, at this point, the command will already be functional.
But there are some useful services provided by salomeTools :
\begin{itemize}
\item {} 
You can give some options to your command:

\end{itemize}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{k+kn}{import} \PYG{n+nn}{src}

\PYG{c+c1}{\PYGZsh{} Define all possible option for mycommand command :  \PYGZsq{}sat mycommand \PYGZlt{}options\PYGZgt{}\PYGZsq{}}
\PYG{n}{parser} \PYG{o}{=} \PYG{n}{src}\PYG{o}{.}\PYG{n}{options}\PYG{o}{.}\PYG{n}{Options}\PYG{p}{(}\PYG{p}{)}
\PYG{n}{parser}\PYG{o}{.}\PYG{n}{add\PYGZus{}option}\PYG{p}{(}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{m}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{myoption}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYGZbs{}
                  \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{boolean}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{myoption}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYGZbs{}
                  \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{My option changes the behavior of my command.}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{)}

\PYG{k}{def} \PYG{n+nf}{run}\PYG{p}{(}\PYG{n}{args}\PYG{p}{,} \PYG{n}{runner}\PYG{p}{,} \PYG{n}{logger}\PYG{p}{)}\PYG{p}{:}
    \PYG{c+c1}{\PYGZsh{} Parse the options}
    \PYG{p}{(}\PYG{n}{options}\PYG{p}{,} \PYG{n}{args}\PYG{p}{)} \PYG{o}{=} \PYG{n}{parser}\PYG{o}{.}\PYG{n}{parse\PYGZus{}args}\PYG{p}{(}\PYG{n}{args}\PYG{p}{)}
    \PYG{c+c1}{\PYGZsh{} algorithm}
\end{sphinxVerbatim}
\begin{itemize}
\item {} 
You can add a \sphinxstyleemphasis{description} method that will display a message when the user will call the help:

\end{itemize}

\fvset{hllines={, 9, 10,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
 \PYG{k+kn}{import} \PYG{n+nn}{src}

 \PYG{c+c1}{\PYGZsh{} Define all possible option for mycommand command : \PYGZsq{}sat mycommand \PYGZlt{}options\PYGZgt{}\PYGZsq{}}
 \PYG{n}{parser} \PYG{o}{=} \PYG{n}{src}\PYG{o}{.}\PYG{n}{options}\PYG{o}{.}\PYG{n}{Options}\PYG{p}{(}\PYG{p}{)}
 \PYG{n}{parser}\PYG{o}{.}\PYG{n}{add\PYGZus{}option}\PYG{p}{(}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{m}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{myoption}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYGZbs{}
                   \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{boolean}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{myoption}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYGZbs{}
                   \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{My option changes the behavior of my command.}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{)}

 \PYG{k}{def} \PYG{n+nf}{description}\PYG{p}{(}\PYG{p}{)}\PYG{p}{:}
     \PYG{k}{return} \PYG{n}{\PYGZus{}}\PYG{p}{(}\PYG{l+s+s2}{\PYGZdq{}}\PYG{l+s+s2}{The help of mycommand.}\PYG{l+s+s2}{\PYGZdq{}}\PYG{p}{)}

 \PYG{k}{def} \PYG{n+nf}{run}\PYG{p}{(}\PYG{n}{args}\PYG{p}{,} \PYG{n}{runner}\PYG{p}{,} \PYG{n}{logger}\PYG{p}{)}\PYG{p}{:}
     \PYG{c+c1}{\PYGZsh{} Parse the options}
     \PYG{p}{(}\PYG{n}{options}\PYG{p}{,} \PYG{n}{args}\PYG{p}{)} \PYG{o}{=} \PYG{n}{parser}\PYG{o}{.}\PYG{n}{parse\PYGZus{}args}\PYG{p}{(}\PYG{n}{args}\PYG{p}{)}
     \PYG{c+c1}{\PYGZsh{} algorithm}
\end{sphinxVerbatim}


\subsection{HowTo access salomeTools config and other commands}
\label{\detokenize{write_command:howto-access-salometools-config-and-other-commands}}
The \sphinxstyleemphasis{runner} variable is an python instance of \sphinxstyleemphasis{Sat} class.
It gives access to \sphinxstyleemphasis{runner.cfg} which is the data model defined from all
\sphinxstyleemphasis{configuration pyconf files} of salomeTools
For example, \sphinxstyleemphasis{runner.cfg.APPLICATION.workdir}
contains the root directory of the current application.

The \sphinxstyleemphasis{runner} variable gives also access to other commands of salomeTools:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{c+c1}{\PYGZsh{} as CLI\PYGZus{} \PYGZsq{}sat prepare ...\PYGZsq{}}
\PYG{n}{runner}\PYG{o}{.}\PYG{n}{prepare}\PYG{p}{(}\PYG{n}{runner}\PYG{o}{.}\PYG{n}{cfg}\PYG{o}{.}\PYG{n}{VARS}\PYG{o}{.}\PYG{n}{application}\PYG{p}{)}
\end{sphinxVerbatim}


\subsection{HowTo logger}
\label{\detokenize{write_command:howto-logger}}
The logger variable is an instance of the Logger class.
It gives access to the write method.

When this method is called, the message passed as parameter
will be displayed in the terminal and written in an xml log file.

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{logger}\PYG{o}{.}\PYG{n}{write}\PYG{p}{(}\PYG{l+s+s2}{\PYGZdq{}}\PYG{l+s+s2}{My message}\PYG{l+s+s2}{\PYGZdq{}}\PYG{p}{,} \PYG{l+m+mi}{3}\PYG{p}{)} \PYG{c+c1}{\PYGZsh{} 3 as default}
\end{sphinxVerbatim}

The second argument defines the level of verbosity
that is wanted for this message.
It has to be between 1 and 5 (the most verbose level).


\subsection{HELLO example}
\label{\detokenize{write_command:hello-example}}
Here is a \sphinxstyleemphasis{hello} command, file \sphinxstyleemphasis{commands/hello.py}:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{k+kn}{import} \PYG{n+nn}{src}

\PYG{l+s+sd}{\PYGZdq{}\PYGZdq{}\PYGZdq{}}
\PYG{l+s+sd}{hello.py}
\PYG{l+s+sd}{Define all possible options for hello command:}
\PYG{l+s+sd}{sat hello \PYGZlt{}options\PYGZgt{}}
\PYG{l+s+sd}{\PYGZdq{}\PYGZdq{}\PYGZdq{}}

\PYG{n}{parser} \PYG{o}{=} \PYG{n}{src}\PYG{o}{.}\PYG{n}{options}\PYG{o}{.}\PYG{n}{Options}\PYG{p}{(}\PYG{p}{)}
\PYG{n}{parser}\PYG{o}{.}\PYG{n}{add\PYGZus{}option}\PYG{p}{(}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{f}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{french}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{boolean}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{french}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{l+s+s2}{\PYGZdq{}}\PYG{l+s+s2}{french set hello message in french.}\PYG{l+s+s2}{\PYGZdq{}}\PYG{p}{)}

\PYG{k}{def} \PYG{n+nf}{description}\PYG{p}{(}\PYG{p}{)}\PYG{p}{:}
    \PYG{k}{return} \PYG{n}{\PYGZus{}}\PYG{p}{(}\PYG{l+s+s2}{\PYGZdq{}}\PYG{l+s+s2}{The help of hello.}\PYG{l+s+s2}{\PYGZdq{}}\PYG{p}{)}

\PYG{k}{def} \PYG{n+nf}{run}\PYG{p}{(}\PYG{n}{args}\PYG{p}{,} \PYG{n}{runner}\PYG{p}{,} \PYG{n}{logger}\PYG{p}{)}\PYG{p}{:}
    \PYG{c+c1}{\PYGZsh{} Parse the options}
    \PYG{p}{(}\PYG{n}{options}\PYG{p}{,} \PYG{n}{args}\PYG{p}{)} \PYG{o}{=} \PYG{n}{parser}\PYG{o}{.}\PYG{n}{parse\PYGZus{}args}\PYG{p}{(}\PYG{n}{args}\PYG{p}{)}
    \PYG{c+c1}{\PYGZsh{} algorithm}
    \PYG{k}{if} \PYG{o+ow}{not} \PYG{n}{options}\PYG{o}{.}\PYG{n}{french}\PYG{p}{:}
        \PYG{n}{logger}\PYG{o}{.}\PYG{n}{write}\PYG{p}{(}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{HELLO! WORLD!}\PYG{l+s+se}{\PYGZbs{}n}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{)}
    \PYG{k}{else}\PYG{p}{:}
        \PYG{n}{logger}\PYG{o}{.}\PYG{n}{write}\PYG{p}{(}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{Bonjour tout le monde!}\PYG{l+s+se}{\PYGZbs{}n}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{)}
\end{sphinxVerbatim}

A first call of hello:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{c+c1}{\PYGZsh{} Get the help of hello:}
./sat \PYGZhy{}\PYGZhy{}help hello

\PYG{c+c1}{\PYGZsh{} To get bonjour}
./sat hello \PYGZhy{}\PYGZhy{}french
Bonjour tout le monde!

\PYG{c+c1}{\PYGZsh{} To get hello}
./sat hello
HELLO! WORLD!

\PYG{c+c1}{\PYGZsh{} To get the log}
./sat log
\end{sphinxVerbatim}


\chapter{Code documentation}
\label{\detokenize{index:code-documentation}}

\section{src}
\label{\detokenize{commands/apidoc/modules:src}}\label{\detokenize{commands/apidoc/modules::doc}}

\subsection{src package}
\label{\detokenize{commands/apidoc/src::doc}}\label{\detokenize{commands/apidoc/src:src-package}}

\subsubsection{Subpackages}
\label{\detokenize{commands/apidoc/src:subpackages}}

\paragraph{src.colorama package}
\label{\detokenize{commands/apidoc/src.colorama:src-colorama-package}}\label{\detokenize{commands/apidoc/src.colorama::doc}}

\subparagraph{Submodules}
\label{\detokenize{commands/apidoc/src.colorama:submodules}}

\subparagraph{src.colorama.ansi module}
\label{\detokenize{commands/apidoc/src.colorama:module-src.colorama.ansi}}\label{\detokenize{commands/apidoc/src.colorama:src-colorama-ansi-module}}\index{src.colorama.ansi (module)}
This module generates ANSI character codes to printing colors to terminals.
See: \sphinxurl{http://en.wikipedia.org/wiki/ANSI\_escape\_code}
\index{AnsiBack (class in src.colorama.ansi)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.colorama.ansi.}}\sphinxbfcode{\sphinxupquote{AnsiBack}}}
Bases: {\hyperref[\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCodes}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.colorama.ansi.AnsiCodes}}}}} (\autopageref*{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCodes}})
\index{BLACK (src.colorama.ansi.AnsiBack attribute)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.BLACK}}\pysigline{\sphinxbfcode{\sphinxupquote{BLACK}}\sphinxbfcode{\sphinxupquote{ = 40}}}
\end{fulllineitems}

\index{BLUE (src.colorama.ansi.AnsiBack attribute)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.BLUE}}\pysigline{\sphinxbfcode{\sphinxupquote{BLUE}}\sphinxbfcode{\sphinxupquote{ = 44}}}
\end{fulllineitems}

\index{CYAN (src.colorama.ansi.AnsiBack attribute)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.CYAN}}\pysigline{\sphinxbfcode{\sphinxupquote{CYAN}}\sphinxbfcode{\sphinxupquote{ = 46}}}
\end{fulllineitems}

\index{GREEN (src.colorama.ansi.AnsiBack attribute)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.GREEN}}\pysigline{\sphinxbfcode{\sphinxupquote{GREEN}}\sphinxbfcode{\sphinxupquote{ = 42}}}
\end{fulllineitems}

\index{LIGHTBLACK\_EX (src.colorama.ansi.AnsiBack attribute)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTBLACK_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTBLACK\_EX}}\sphinxbfcode{\sphinxupquote{ = 100}}}
\end{fulllineitems}

\index{LIGHTBLUE\_EX (src.colorama.ansi.AnsiBack attribute)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTBLUE_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTBLUE\_EX}}\sphinxbfcode{\sphinxupquote{ = 104}}}
\end{fulllineitems}

\index{LIGHTCYAN\_EX (src.colorama.ansi.AnsiBack attribute)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTCYAN_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTCYAN\_EX}}\sphinxbfcode{\sphinxupquote{ = 106}}}
\end{fulllineitems}

\index{LIGHTGREEN\_EX (src.colorama.ansi.AnsiBack attribute)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTGREEN_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTGREEN\_EX}}\sphinxbfcode{\sphinxupquote{ = 102}}}
\end{fulllineitems}

\index{LIGHTMAGENTA\_EX (src.colorama.ansi.AnsiBack attribute)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTMAGENTA_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTMAGENTA\_EX}}\sphinxbfcode{\sphinxupquote{ = 105}}}
\end{fulllineitems}

\index{LIGHTRED\_EX (src.colorama.ansi.AnsiBack attribute)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTRED_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTRED\_EX}}\sphinxbfcode{\sphinxupquote{ = 101}}}
\end{fulllineitems}

\index{LIGHTWHITE\_EX (src.colorama.ansi.AnsiBack attribute)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTWHITE_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTWHITE\_EX}}\sphinxbfcode{\sphinxupquote{ = 107}}}
\end{fulllineitems}

\index{LIGHTYELLOW\_EX (src.colorama.ansi.AnsiBack attribute)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTYELLOW_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTYELLOW\_EX}}\sphinxbfcode{\sphinxupquote{ = 103}}}
\end{fulllineitems}

\index{MAGENTA (src.colorama.ansi.AnsiBack attribute)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.MAGENTA}}\pysigline{\sphinxbfcode{\sphinxupquote{MAGENTA}}\sphinxbfcode{\sphinxupquote{ = 45}}}
\end{fulllineitems}

\index{RED (src.colorama.ansi.AnsiBack attribute)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.RED}}\pysigline{\sphinxbfcode{\sphinxupquote{RED}}\sphinxbfcode{\sphinxupquote{ = 41}}}
\end{fulllineitems}

\index{RESET (src.colorama.ansi.AnsiBack attribute)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.RESET}}\pysigline{\sphinxbfcode{\sphinxupquote{RESET}}\sphinxbfcode{\sphinxupquote{ = 49}}}
\end{fulllineitems}

\index{WHITE (src.colorama.ansi.AnsiBack attribute)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.WHITE}}\pysigline{\sphinxbfcode{\sphinxupquote{WHITE}}\sphinxbfcode{\sphinxupquote{ = 47}}}
\end{fulllineitems}

\index{YELLOW (src.colorama.ansi.AnsiBack attribute)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.YELLOW}}\pysigline{\sphinxbfcode{\sphinxupquote{YELLOW}}\sphinxbfcode{\sphinxupquote{ = 43}}}
\end{fulllineitems}


\end{fulllineitems}

\index{AnsiCodes (class in src.colorama.ansi)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCodes}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.colorama.ansi.}}\sphinxbfcode{\sphinxupquote{AnsiCodes}}}
Bases: \sphinxcode{\sphinxupquote{object}}

\end{fulllineitems}

\index{AnsiCursor (class in src.colorama.ansi)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.colorama.ansi.}}\sphinxbfcode{\sphinxupquote{AnsiCursor}}}
Bases: \sphinxcode{\sphinxupquote{object}}
\index{BACK() (src.colorama.ansi.AnsiCursor method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.BACK}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{BACK}}}{\emph{n=1}}{}
\end{fulllineitems}

\index{DOWN() (src.colorama.ansi.AnsiCursor method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.DOWN}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{DOWN}}}{\emph{n=1}}{}
\end{fulllineitems}

\index{FORWARD() (src.colorama.ansi.AnsiCursor method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.FORWARD}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{FORWARD}}}{\emph{n=1}}{}
\end{fulllineitems}

\index{POS() (src.colorama.ansi.AnsiCursor method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.POS}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{POS}}}{\emph{x=1}, \emph{y=1}}{}
\end{fulllineitems}

\index{UP() (src.colorama.ansi.AnsiCursor method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.UP}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{UP}}}{\emph{n=1}}{}
\end{fulllineitems}


\end{fulllineitems}

\index{AnsiFore (class in src.colorama.ansi)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.colorama.ansi.}}\sphinxbfcode{\sphinxupquote{AnsiFore}}}
Bases: {\hyperref[\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCodes}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.colorama.ansi.AnsiCodes}}}}} (\autopageref*{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCodes}})
\index{BLACK (src.colorama.ansi.AnsiFore attribute)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.BLACK}}\pysigline{\sphinxbfcode{\sphinxupquote{BLACK}}\sphinxbfcode{\sphinxupquote{ = 30}}}
\end{fulllineitems}

\index{BLUE (src.colorama.ansi.AnsiFore attribute)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.BLUE}}\pysigline{\sphinxbfcode{\sphinxupquote{BLUE}}\sphinxbfcode{\sphinxupquote{ = 34}}}
\end{fulllineitems}

\index{CYAN (src.colorama.ansi.AnsiFore attribute)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.CYAN}}\pysigline{\sphinxbfcode{\sphinxupquote{CYAN}}\sphinxbfcode{\sphinxupquote{ = 36}}}
\end{fulllineitems}

\index{GREEN (src.colorama.ansi.AnsiFore attribute)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.GREEN}}\pysigline{\sphinxbfcode{\sphinxupquote{GREEN}}\sphinxbfcode{\sphinxupquote{ = 32}}}
\end{fulllineitems}

\index{LIGHTBLACK\_EX (src.colorama.ansi.AnsiFore attribute)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTBLACK_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTBLACK\_EX}}\sphinxbfcode{\sphinxupquote{ = 90}}}
\end{fulllineitems}

\index{LIGHTBLUE\_EX (src.colorama.ansi.AnsiFore attribute)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTBLUE_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTBLUE\_EX}}\sphinxbfcode{\sphinxupquote{ = 94}}}
\end{fulllineitems}

\index{LIGHTCYAN\_EX (src.colorama.ansi.AnsiFore attribute)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTCYAN_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTCYAN\_EX}}\sphinxbfcode{\sphinxupquote{ = 96}}}
\end{fulllineitems}

\index{LIGHTGREEN\_EX (src.colorama.ansi.AnsiFore attribute)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTGREEN_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTGREEN\_EX}}\sphinxbfcode{\sphinxupquote{ = 92}}}
\end{fulllineitems}

\index{LIGHTMAGENTA\_EX (src.colorama.ansi.AnsiFore attribute)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTMAGENTA_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTMAGENTA\_EX}}\sphinxbfcode{\sphinxupquote{ = 95}}}
\end{fulllineitems}

\index{LIGHTRED\_EX (src.colorama.ansi.AnsiFore attribute)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTRED_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTRED\_EX}}\sphinxbfcode{\sphinxupquote{ = 91}}}
\end{fulllineitems}

\index{LIGHTWHITE\_EX (src.colorama.ansi.AnsiFore attribute)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTWHITE_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTWHITE\_EX}}\sphinxbfcode{\sphinxupquote{ = 97}}}
\end{fulllineitems}

\index{LIGHTYELLOW\_EX (src.colorama.ansi.AnsiFore attribute)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTYELLOW_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTYELLOW\_EX}}\sphinxbfcode{\sphinxupquote{ = 93}}}
\end{fulllineitems}

\index{MAGENTA (src.colorama.ansi.AnsiFore attribute)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.MAGENTA}}\pysigline{\sphinxbfcode{\sphinxupquote{MAGENTA}}\sphinxbfcode{\sphinxupquote{ = 35}}}
\end{fulllineitems}

\index{RED (src.colorama.ansi.AnsiFore attribute)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.RED}}\pysigline{\sphinxbfcode{\sphinxupquote{RED}}\sphinxbfcode{\sphinxupquote{ = 31}}}
\end{fulllineitems}

\index{RESET (src.colorama.ansi.AnsiFore attribute)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.RESET}}\pysigline{\sphinxbfcode{\sphinxupquote{RESET}}\sphinxbfcode{\sphinxupquote{ = 39}}}
\end{fulllineitems}

\index{WHITE (src.colorama.ansi.AnsiFore attribute)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.WHITE}}\pysigline{\sphinxbfcode{\sphinxupquote{WHITE}}\sphinxbfcode{\sphinxupquote{ = 37}}}
\end{fulllineitems}

\index{YELLOW (src.colorama.ansi.AnsiFore attribute)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.YELLOW}}\pysigline{\sphinxbfcode{\sphinxupquote{YELLOW}}\sphinxbfcode{\sphinxupquote{ = 33}}}
\end{fulllineitems}


\end{fulllineitems}

\index{AnsiStyle (class in src.colorama.ansi)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.colorama.ansi.}}\sphinxbfcode{\sphinxupquote{AnsiStyle}}}
Bases: {\hyperref[\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCodes}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.colorama.ansi.AnsiCodes}}}}} (\autopageref*{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCodes}})
\index{BRIGHT (src.colorama.ansi.AnsiStyle attribute)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle.BRIGHT}}\pysigline{\sphinxbfcode{\sphinxupquote{BRIGHT}}\sphinxbfcode{\sphinxupquote{ = 1}}}
\end{fulllineitems}

\index{DIM (src.colorama.ansi.AnsiStyle attribute)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle.DIM}}\pysigline{\sphinxbfcode{\sphinxupquote{DIM}}\sphinxbfcode{\sphinxupquote{ = 2}}}
\end{fulllineitems}

\index{NORMAL (src.colorama.ansi.AnsiStyle attribute)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle.NORMAL}}\pysigline{\sphinxbfcode{\sphinxupquote{NORMAL}}\sphinxbfcode{\sphinxupquote{ = 22}}}
\end{fulllineitems}

\index{RESET\_ALL (src.colorama.ansi.AnsiStyle attribute)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle.RESET_ALL}}\pysigline{\sphinxbfcode{\sphinxupquote{RESET\_ALL}}\sphinxbfcode{\sphinxupquote{ = 0}}}
\end{fulllineitems}


\end{fulllineitems}

\index{clear\_line() (in module src.colorama.ansi)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.clear_line}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.ansi.}}\sphinxbfcode{\sphinxupquote{clear\_line}}}{\emph{mode=2}}{}
\end{fulllineitems}

\index{clear\_screen() (in module src.colorama.ansi)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.clear_screen}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.ansi.}}\sphinxbfcode{\sphinxupquote{clear\_screen}}}{\emph{mode=2}}{}
\end{fulllineitems}

\index{code\_to\_chars() (in module src.colorama.ansi)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.code_to_chars}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.ansi.}}\sphinxbfcode{\sphinxupquote{code\_to\_chars}}}{\emph{code}}{}
\end{fulllineitems}

\index{set\_title() (in module src.colorama.ansi)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.set_title}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.ansi.}}\sphinxbfcode{\sphinxupquote{set\_title}}}{\emph{title}}{}
\end{fulllineitems}



\subparagraph{src.colorama.ansitowin32 module}
\label{\detokenize{commands/apidoc/src.colorama:module-src.colorama.ansitowin32}}\label{\detokenize{commands/apidoc/src.colorama:src-colorama-ansitowin32-module}}\index{src.colorama.ansitowin32 (module)}\index{AnsiToWin32 (class in src.colorama.ansitowin32)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.colorama.ansitowin32.}}\sphinxbfcode{\sphinxupquote{AnsiToWin32}}}{\emph{wrapped}, \emph{convert=None}, \emph{strip=None}, \emph{autoreset=False}}{}
Bases: \sphinxcode{\sphinxupquote{object}}

Implements a ‘write()’ method which, on Windows, will strip ANSI character
sequences from the text, and if outputting to a tty, will convert them into
win32 function calls.
\index{ANSI\_CSI\_RE (src.colorama.ansitowin32.AnsiToWin32 attribute)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.ANSI_CSI_RE}}\pysigline{\sphinxbfcode{\sphinxupquote{ANSI\_CSI\_RE}}\sphinxbfcode{\sphinxupquote{ = \textless{}\_sre.SRE\_Pattern object\textgreater{}}}}
\end{fulllineitems}

\index{ANSI\_OSC\_RE (src.colorama.ansitowin32.AnsiToWin32 attribute)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.ANSI_OSC_RE}}\pysigline{\sphinxbfcode{\sphinxupquote{ANSI\_OSC\_RE}}\sphinxbfcode{\sphinxupquote{ = \textless{}\_sre.SRE\_Pattern object\textgreater{}}}}
\end{fulllineitems}

\index{call\_win32() (src.colorama.ansitowin32.AnsiToWin32 method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.call_win32}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{call\_win32}}}{\emph{command}, \emph{params}}{}
\end{fulllineitems}

\index{convert\_ansi() (src.colorama.ansitowin32.AnsiToWin32 method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.convert_ansi}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{convert\_ansi}}}{\emph{paramstring}, \emph{command}}{}
\end{fulllineitems}

\index{convert\_osc() (src.colorama.ansitowin32.AnsiToWin32 method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.convert_osc}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{convert\_osc}}}{\emph{text}}{}
\end{fulllineitems}

\index{extract\_params() (src.colorama.ansitowin32.AnsiToWin32 method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.extract_params}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{extract\_params}}}{\emph{command}, \emph{paramstring}}{}
\end{fulllineitems}

\index{get\_win32\_calls() (src.colorama.ansitowin32.AnsiToWin32 method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.get_win32_calls}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_win32\_calls}}}{}{}
\end{fulllineitems}

\index{reset\_all() (src.colorama.ansitowin32.AnsiToWin32 method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.reset_all}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{reset\_all}}}{}{}
\end{fulllineitems}

\index{should\_wrap() (src.colorama.ansitowin32.AnsiToWin32 method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.should_wrap}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{should\_wrap}}}{}{}
True if this class is actually needed. If false, then the output
stream will not be affected, nor will win32 calls be issued, so
wrapping stdout is not actually required. This will generally be
False on non-Windows platforms, unless optional functionality like
autoreset has been requested using kwargs to init()

\end{fulllineitems}

\index{write() (src.colorama.ansitowin32.AnsiToWin32 method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.write}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write}}}{\emph{text}}{}
\end{fulllineitems}

\index{write\_and\_convert() (src.colorama.ansitowin32.AnsiToWin32 method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.write_and_convert}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write\_and\_convert}}}{\emph{text}}{}
Write the given text to our wrapped stream, stripping any ANSI
sequences from the text, and optionally converting them into win32
calls.

\end{fulllineitems}

\index{write\_plain\_text() (src.colorama.ansitowin32.AnsiToWin32 method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.write_plain_text}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write\_plain\_text}}}{\emph{text}, \emph{start}, \emph{end}}{}
\end{fulllineitems}


\end{fulllineitems}

\index{StreamWrapper (class in src.colorama.ansitowin32)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.StreamWrapper}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.colorama.ansitowin32.}}\sphinxbfcode{\sphinxupquote{StreamWrapper}}}{\emph{wrapped}, \emph{converter}}{}
Bases: \sphinxcode{\sphinxupquote{object}}

Wraps a stream (such as stdout), acting as a transparent proxy for all
attribute access apart from method ‘write()’, which is delegated to our
Converter instance.
\index{write() (src.colorama.ansitowin32.StreamWrapper method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.StreamWrapper.write}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write}}}{\emph{text}}{}
\end{fulllineitems}


\end{fulllineitems}

\index{is\_a\_tty() (in module src.colorama.ansitowin32)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.is_a_tty}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.ansitowin32.}}\sphinxbfcode{\sphinxupquote{is\_a\_tty}}}{\emph{stream}}{}
\end{fulllineitems}

\index{is\_stream\_closed() (in module src.colorama.ansitowin32)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.is_stream_closed}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.ansitowin32.}}\sphinxbfcode{\sphinxupquote{is\_stream\_closed}}}{\emph{stream}}{}
\end{fulllineitems}



\subparagraph{src.colorama.initialise module}
\label{\detokenize{commands/apidoc/src.colorama:src-colorama-initialise-module}}\label{\detokenize{commands/apidoc/src.colorama:module-src.colorama.initialise}}\index{src.colorama.initialise (module)}\index{colorama\_text() (in module src.colorama.initialise)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.initialise.colorama_text}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.initialise.}}\sphinxbfcode{\sphinxupquote{colorama\_text}}}{\emph{*args}, \emph{**kwds}}{}
\end{fulllineitems}

\index{deinit() (in module src.colorama.initialise)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.initialise.deinit}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.initialise.}}\sphinxbfcode{\sphinxupquote{deinit}}}{}{}
\end{fulllineitems}

\index{init() (in module src.colorama.initialise)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.initialise.init}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.initialise.}}\sphinxbfcode{\sphinxupquote{init}}}{\emph{autoreset=False}, \emph{convert=None}, \emph{strip=None}, \emph{wrap=True}}{}
\end{fulllineitems}

\index{reinit() (in module src.colorama.initialise)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.initialise.reinit}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.initialise.}}\sphinxbfcode{\sphinxupquote{reinit}}}{}{}
\end{fulllineitems}

\index{reset\_all() (in module src.colorama.initialise)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.initialise.reset_all}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.initialise.}}\sphinxbfcode{\sphinxupquote{reset\_all}}}{}{}
\end{fulllineitems}

\index{wrap\_stream() (in module src.colorama.initialise)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.initialise.wrap_stream}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.initialise.}}\sphinxbfcode{\sphinxupquote{wrap\_stream}}}{\emph{stream}, \emph{convert}, \emph{strip}, \emph{autoreset}, \emph{wrap}}{}
\end{fulllineitems}



\subparagraph{src.colorama.win32 module}
\label{\detokenize{commands/apidoc/src.colorama:src-colorama-win32-module}}\label{\detokenize{commands/apidoc/src.colorama:module-src.colorama.win32}}\index{src.colorama.win32 (module)}\index{SetConsoleTextAttribute() (in module src.colorama.win32)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.win32.SetConsoleTextAttribute}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.win32.}}\sphinxbfcode{\sphinxupquote{SetConsoleTextAttribute}}}{\emph{*\_}}{}
\end{fulllineitems}

\index{winapi\_test() (in module src.colorama.win32)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.win32.winapi_test}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.win32.}}\sphinxbfcode{\sphinxupquote{winapi\_test}}}{\emph{*\_}}{}
\end{fulllineitems}



\subparagraph{src.colorama.winterm module}
\label{\detokenize{commands/apidoc/src.colorama:module-src.colorama.winterm}}\label{\detokenize{commands/apidoc/src.colorama:src-colorama-winterm-module}}\index{src.colorama.winterm (module)}\index{WinColor (class in src.colorama.winterm)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinColor}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.colorama.winterm.}}\sphinxbfcode{\sphinxupquote{WinColor}}}
Bases: \sphinxcode{\sphinxupquote{object}}
\index{BLACK (src.colorama.winterm.WinColor attribute)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.BLACK}}\pysigline{\sphinxbfcode{\sphinxupquote{BLACK}}\sphinxbfcode{\sphinxupquote{ = 0}}}
\end{fulllineitems}

\index{BLUE (src.colorama.winterm.WinColor attribute)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.BLUE}}\pysigline{\sphinxbfcode{\sphinxupquote{BLUE}}\sphinxbfcode{\sphinxupquote{ = 1}}}
\end{fulllineitems}

\index{CYAN (src.colorama.winterm.WinColor attribute)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.CYAN}}\pysigline{\sphinxbfcode{\sphinxupquote{CYAN}}\sphinxbfcode{\sphinxupquote{ = 3}}}
\end{fulllineitems}

\index{GREEN (src.colorama.winterm.WinColor attribute)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.GREEN}}\pysigline{\sphinxbfcode{\sphinxupquote{GREEN}}\sphinxbfcode{\sphinxupquote{ = 2}}}
\end{fulllineitems}

\index{GREY (src.colorama.winterm.WinColor attribute)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.GREY}}\pysigline{\sphinxbfcode{\sphinxupquote{GREY}}\sphinxbfcode{\sphinxupquote{ = 7}}}
\end{fulllineitems}

\index{MAGENTA (src.colorama.winterm.WinColor attribute)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.MAGENTA}}\pysigline{\sphinxbfcode{\sphinxupquote{MAGENTA}}\sphinxbfcode{\sphinxupquote{ = 5}}}
\end{fulllineitems}

\index{RED (src.colorama.winterm.WinColor attribute)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.RED}}\pysigline{\sphinxbfcode{\sphinxupquote{RED}}\sphinxbfcode{\sphinxupquote{ = 4}}}
\end{fulllineitems}

\index{YELLOW (src.colorama.winterm.WinColor attribute)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.YELLOW}}\pysigline{\sphinxbfcode{\sphinxupquote{YELLOW}}\sphinxbfcode{\sphinxupquote{ = 6}}}
\end{fulllineitems}


\end{fulllineitems}

\index{WinStyle (class in src.colorama.winterm)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinStyle}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.colorama.winterm.}}\sphinxbfcode{\sphinxupquote{WinStyle}}}
Bases: \sphinxcode{\sphinxupquote{object}}
\index{BRIGHT (src.colorama.winterm.WinStyle attribute)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinStyle.BRIGHT}}\pysigline{\sphinxbfcode{\sphinxupquote{BRIGHT}}\sphinxbfcode{\sphinxupquote{ = 8}}}
\end{fulllineitems}

\index{BRIGHT\_BACKGROUND (src.colorama.winterm.WinStyle attribute)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinStyle.BRIGHT_BACKGROUND}}\pysigline{\sphinxbfcode{\sphinxupquote{BRIGHT\_BACKGROUND}}\sphinxbfcode{\sphinxupquote{ = 128}}}
\end{fulllineitems}

\index{NORMAL (src.colorama.winterm.WinStyle attribute)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinStyle.NORMAL}}\pysigline{\sphinxbfcode{\sphinxupquote{NORMAL}}\sphinxbfcode{\sphinxupquote{ = 0}}}
\end{fulllineitems}


\end{fulllineitems}

\index{WinTerm (class in src.colorama.winterm)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.colorama.winterm.}}\sphinxbfcode{\sphinxupquote{WinTerm}}}
Bases: \sphinxcode{\sphinxupquote{object}}
\index{back() (src.colorama.winterm.WinTerm method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.back}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{back}}}{\emph{back=None}, \emph{light=False}, \emph{on\_stderr=False}}{}
\end{fulllineitems}

\index{cursor\_adjust() (src.colorama.winterm.WinTerm method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.cursor_adjust}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{cursor\_adjust}}}{\emph{x}, \emph{y}, \emph{on\_stderr=False}}{}
\end{fulllineitems}

\index{erase\_line() (src.colorama.winterm.WinTerm method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.erase_line}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{erase\_line}}}{\emph{mode=0}, \emph{on\_stderr=False}}{}
\end{fulllineitems}

\index{erase\_screen() (src.colorama.winterm.WinTerm method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.erase_screen}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{erase\_screen}}}{\emph{mode=0}, \emph{on\_stderr=False}}{}
\end{fulllineitems}

\index{fore() (src.colorama.winterm.WinTerm method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.fore}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{fore}}}{\emph{fore=None}, \emph{light=False}, \emph{on\_stderr=False}}{}
\end{fulllineitems}

\index{get\_attrs() (src.colorama.winterm.WinTerm method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.get_attrs}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_attrs}}}{}{}
\end{fulllineitems}

\index{get\_position() (src.colorama.winterm.WinTerm method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.get_position}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_position}}}{\emph{handle}}{}
\end{fulllineitems}

\index{reset\_all() (src.colorama.winterm.WinTerm method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.reset_all}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{reset\_all}}}{\emph{on\_stderr=None}}{}
\end{fulllineitems}

\index{set\_attrs() (src.colorama.winterm.WinTerm method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.set_attrs}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_attrs}}}{\emph{value}}{}
\end{fulllineitems}

\index{set\_console() (src.colorama.winterm.WinTerm method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.set_console}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_console}}}{\emph{attrs=None}, \emph{on\_stderr=False}}{}
\end{fulllineitems}

\index{set\_cursor\_position() (src.colorama.winterm.WinTerm method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.set_cursor_position}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_cursor\_position}}}{\emph{position=None}, \emph{on\_stderr=False}}{}
\end{fulllineitems}

\index{set\_title() (src.colorama.winterm.WinTerm method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.set_title}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_title}}}{\emph{title}}{}
\end{fulllineitems}

\index{style() (src.colorama.winterm.WinTerm method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.style}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{style}}}{\emph{style=None}, \emph{on\_stderr=False}}{}
\end{fulllineitems}


\end{fulllineitems}



\subparagraph{Module contents}
\label{\detokenize{commands/apidoc/src.colorama:module-src.colorama}}\label{\detokenize{commands/apidoc/src.colorama:module-contents}}\index{src.colorama (module)}

\subsubsection{Submodules}
\label{\detokenize{commands/apidoc/src:submodules}}

\subsubsection{src.ElementTree module}
\label{\detokenize{commands/apidoc/src:src-elementtree-module}}\label{\detokenize{commands/apidoc/src:module-src.ElementTree}}\index{src.ElementTree (module)}\index{Comment() (in module src.ElementTree)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.Comment}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{Comment}}}{\emph{text=None}}{}
\end{fulllineitems}

\index{dump() (in module src.ElementTree)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.dump}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{dump}}}{\emph{elem}}{}
\end{fulllineitems}

\index{Element() (in module src.ElementTree)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.Element}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{Element}}}{\emph{tag}, \emph{attrib=\{\}}, \emph{**extra}}{}
\end{fulllineitems}

\index{ElementTree (class in src.ElementTree)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.ElementTree}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{ElementTree}}}{\emph{element=None}, \emph{file=None}}{}~\index{find() (src.ElementTree.ElementTree method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.ElementTree.find}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{find}}}{\emph{path}}{}
\end{fulllineitems}

\index{findall() (src.ElementTree.ElementTree method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.ElementTree.findall}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{findall}}}{\emph{path}}{}
\end{fulllineitems}

\index{findtext() (src.ElementTree.ElementTree method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.ElementTree.findtext}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{findtext}}}{\emph{path}, \emph{default=None}}{}
\end{fulllineitems}

\index{getiterator() (src.ElementTree.ElementTree method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.ElementTree.getiterator}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getiterator}}}{\emph{tag=None}}{}
\end{fulllineitems}

\index{getroot() (src.ElementTree.ElementTree method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.ElementTree.getroot}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getroot}}}{}{}
\end{fulllineitems}

\index{parse() (src.ElementTree.ElementTree method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.ElementTree.parse}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parse}}}{\emph{source}, \emph{parser=None}}{}
\end{fulllineitems}

\index{write() (src.ElementTree.ElementTree method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.ElementTree.write}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write}}}{\emph{file}, \emph{encoding='us-ascii'}}{}
\end{fulllineitems}


\end{fulllineitems}

\index{fromstring() (in module src.ElementTree)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.fromstring}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{fromstring}}}{\emph{text}}{}
\end{fulllineitems}

\index{iselement() (in module src.ElementTree)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.iselement}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{iselement}}}{\emph{element}}{}
\end{fulllineitems}

\index{iterparse (class in src.ElementTree)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.iterparse}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{iterparse}}}{\emph{source}, \emph{events=None}}{}~\index{next() (src.ElementTree.iterparse method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.iterparse.next}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{next}}}{}{}
\end{fulllineitems}


\end{fulllineitems}

\index{parse() (in module src.ElementTree)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.parse}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{parse}}}{\emph{source}, \emph{parser=None}}{}
\end{fulllineitems}

\index{PI() (in module src.ElementTree)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.PI}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{PI}}}{\emph{target}, \emph{text=None}}{}
\end{fulllineitems}

\index{ProcessingInstruction() (in module src.ElementTree)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.ProcessingInstruction}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{ProcessingInstruction}}}{\emph{target}, \emph{text=None}}{}
\end{fulllineitems}

\index{QName (class in src.ElementTree)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.QName}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{QName}}}{\emph{text\_or\_uri}, \emph{tag=None}}{}
\end{fulllineitems}

\index{SubElement() (in module src.ElementTree)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.SubElement}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{SubElement}}}{\emph{parent}, \emph{tag}, \emph{attrib=\{\}}, \emph{**extra}}{}
\end{fulllineitems}

\index{tostring() (in module src.ElementTree)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.tostring}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{tostring}}}{\emph{element}, \emph{encoding=None}}{}
\end{fulllineitems}

\index{TreeBuilder (class in src.ElementTree)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.TreeBuilder}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{TreeBuilder}}}{\emph{element\_factory=None}}{}~\index{close() (src.ElementTree.TreeBuilder method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.TreeBuilder.close}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{close}}}{}{}
\end{fulllineitems}

\index{data() (src.ElementTree.TreeBuilder method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.TreeBuilder.data}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{data}}}{\emph{data}}{}
\end{fulllineitems}

\index{end() (src.ElementTree.TreeBuilder method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.TreeBuilder.end}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{end}}}{\emph{tag}}{}
\end{fulllineitems}

\index{start() (src.ElementTree.TreeBuilder method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.TreeBuilder.start}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{start}}}{\emph{tag}, \emph{attrs}}{}
\end{fulllineitems}


\end{fulllineitems}

\index{XML() (in module src.ElementTree)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.XML}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{XML}}}{\emph{text}}{}
\end{fulllineitems}

\index{XMLTreeBuilder (class in src.ElementTree)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.XMLTreeBuilder}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{XMLTreeBuilder}}}{\emph{html=0}, \emph{target=None}}{}~\index{close() (src.ElementTree.XMLTreeBuilder method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.XMLTreeBuilder.close}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{close}}}{}{}
\end{fulllineitems}

\index{doctype() (src.ElementTree.XMLTreeBuilder method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.XMLTreeBuilder.doctype}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{doctype}}}{\emph{name}, \emph{pubid}, \emph{system}}{}
\end{fulllineitems}

\index{feed() (src.ElementTree.XMLTreeBuilder method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.XMLTreeBuilder.feed}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{feed}}}{\emph{data}}{}
\end{fulllineitems}


\end{fulllineitems}



\subsubsection{src.architecture module}
\label{\detokenize{commands/apidoc/src:module-src.architecture}}\label{\detokenize{commands/apidoc/src:src-architecture-module}}\index{src.architecture (module)}
In this file : all the stuff that can change with the architecture 
on which SAT is running
\index{get\_distrib\_version() (in module src.architecture)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.architecture.get_distrib_version}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.architecture.}}\sphinxbfcode{\sphinxupquote{get\_distrib\_version}}}{\emph{distrib}, \emph{codes}}{}
Gets the version of the distribution
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{distrib}}) \textendash{} The distribution on which the version will be found.

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{L\{Mapping\}}} (\sphinxstyleliteralemphasis{\sphinxupquote{codes}}) \textendash{} The map containing distribution correlation table.

\end{itemize}

\item[{Returns}] \leavevmode
The version of the distribution on which salomeTools is running, 
regarding the distribution correlation table contained in codes 
variable.

\item[{Return type}] \leavevmode
str

\end{description}\end{quote}

\end{fulllineitems}

\index{get\_distribution() (in module src.architecture)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.architecture.get_distribution}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.architecture.}}\sphinxbfcode{\sphinxupquote{get\_distribution}}}{\emph{codes}}{}
Gets the code for the distribution
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{L\{Mapping\}}} (\sphinxstyleliteralemphasis{\sphinxupquote{codes}}) \textendash{} The map containing distribution correlation table.

\item[{Returns}] \leavevmode
The distribution on which salomeTools is running, regarding the 
distribution correlation table contained in codes variable.

\item[{Return type}] \leavevmode
str

\end{description}\end{quote}

\end{fulllineitems}

\index{get\_nb\_proc() (in module src.architecture)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.architecture.get_nb_proc}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.architecture.}}\sphinxbfcode{\sphinxupquote{get\_nb\_proc}}}{}{}~\begin{description}
\item[{Gets the number of processors of the machine }] \leavevmode
on which salomeTools is running.

\end{description}
\begin{quote}\begin{description}
\item[{Returns}] \leavevmode
the number of processors.

\item[{Return type}] \leavevmode
str

\end{description}\end{quote}

\end{fulllineitems}

\index{get\_python\_version() (in module src.architecture)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.architecture.get_python_version}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.architecture.}}\sphinxbfcode{\sphinxupquote{get\_python\_version}}}{}{}
Gets the version of the running python.
\begin{quote}\begin{description}
\item[{Returns}] \leavevmode
the version of the running python.

\item[{Return type}] \leavevmode
str

\end{description}\end{quote}

\end{fulllineitems}

\index{get\_user() (in module src.architecture)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.architecture.get_user}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.architecture.}}\sphinxbfcode{\sphinxupquote{get\_user}}}{}{}
method that gets the username that launched sat
\begin{quote}\begin{description}
\item[{Return type}] \leavevmode
str

\end{description}\end{quote}

\end{fulllineitems}

\index{is\_windows() (in module src.architecture)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.architecture.is_windows}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.architecture.}}\sphinxbfcode{\sphinxupquote{is\_windows}}}{}{}
method that checks windows OS
\begin{quote}\begin{description}
\item[{Return type}] \leavevmode
boolean

\end{description}\end{quote}

\end{fulllineitems}



\subsubsection{src.compilation module}
\label{\detokenize{commands/apidoc/src:module-src.compilation}}\label{\detokenize{commands/apidoc/src:src-compilation-module}}\index{src.compilation (module)}\index{Builder (class in src.compilation)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.compilation.}}\sphinxbfcode{\sphinxupquote{Builder}}}{\emph{config}, \emph{logger}, \emph{product\_info}, \emph{options=OptResult(   )}, \emph{check\_src=True}}{}
Class to handle all construction steps, like cmake, configure, make, …
\index{build\_configure() (src.compilation.Builder method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.build_configure}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{build\_configure}}}{\emph{options=''}}{}
\end{fulllineitems}

\index{check() (src.compilation.Builder method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.check}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{check}}}{\emph{command=''}}{}
\end{fulllineitems}

\index{cmake() (src.compilation.Builder method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.cmake}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{cmake}}}{\emph{options=''}}{}
\end{fulllineitems}

\index{complete\_environment() (src.compilation.Builder method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.complete_environment}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{complete\_environment}}}{\emph{make\_options}}{}
\end{fulllineitems}

\index{configure() (src.compilation.Builder method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.configure}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{configure}}}{\emph{options=''}}{}
\end{fulllineitems}

\index{do\_batch\_script\_build() (src.compilation.Builder method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.do_batch_script_build}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{do\_batch\_script\_build}}}{\emph{script}, \emph{nb\_proc}}{}
\end{fulllineitems}

\index{do\_default\_build() (src.compilation.Builder method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.do_default_build}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{do\_default\_build}}}{\emph{build\_conf\_options=''}, \emph{configure\_options=''}, \emph{show\_warning=True}}{}
\end{fulllineitems}

\index{do\_python\_script\_build() (src.compilation.Builder method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.do_python_script_build}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{do\_python\_script\_build}}}{\emph{script}, \emph{nb\_proc}}{}
\end{fulllineitems}

\index{do\_script\_build() (src.compilation.Builder method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.do_script_build}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{do\_script\_build}}}{\emph{script}, \emph{number\_of\_proc=0}}{}
\end{fulllineitems}

\index{hack\_libtool() (src.compilation.Builder method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.hack_libtool}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{hack\_libtool}}}{}{}
\end{fulllineitems}

\index{install() (src.compilation.Builder method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.install}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{install}}}{}{}
\end{fulllineitems}

\index{log() (src.compilation.Builder method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.log}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{log}}}{\emph{text}, \emph{level}, \emph{showInfo=True}}{}
\end{fulllineitems}

\index{log\_command() (src.compilation.Builder method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.log_command}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{log\_command}}}{\emph{command}}{}
\end{fulllineitems}

\index{make() (src.compilation.Builder method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.make}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{make}}}{\emph{nb\_proc}, \emph{make\_opt=''}}{}
\end{fulllineitems}

\index{prepare() (src.compilation.Builder method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.prepare}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepare}}}{}{}
\end{fulllineitems}

\index{put\_txt\_log\_in\_appli\_log\_dir() (src.compilation.Builder method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.put_txt_log_in_appli_log_dir}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{put\_txt\_log\_in\_appli\_log\_dir}}}{\emph{file\_name}}{}~\begin{description}
\item[{Put the txt log (that contain the system logs, like make command}] \leavevmode
output) in the directory \textless{}APPLICATION DIR\textgreater{}/LOGS/\textless{}product\_name\textgreater{}/

\end{description}
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{Str}} (\sphinxstyleliteralemphasis{\sphinxupquote{file\_name}}) \textendash{} the name of the file to write

\end{description}\end{quote}

\end{fulllineitems}

\index{wmake() (src.compilation.Builder method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.wmake}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{wmake}}}{\emph{nb\_proc}, \emph{opt\_nb\_proc=None}}{}
\end{fulllineitems}


\end{fulllineitems}



\subsubsection{src.debug module}
\label{\detokenize{commands/apidoc/src:module-src.debug}}\label{\detokenize{commands/apidoc/src:src-debug-module}}\index{src.debug (module)}
This file assume DEBUG functionalities use.
Print salomeTools debug messages in sys.stderr.
Show pretty print debug representation from instances of SAT classes 
(pretty print src.pyconf.Config)

\begin{DUlineblock}{0em}
\item[] Warning: supposedly show messages in SAT development phase, not production
\item[] 
\item[] Usage:
\item[] \textgreater{}\textgreater{} import debug as DBG
\item[] \textgreater{}\textgreater{} DBG.write(“aTitle”, aVariable)        \# not shown in production 
\item[] \textgreater{}\textgreater{} DBG.write(“aTitle”, aVariable, True)  \# unconditionaly shown (as show=True)
\item[] 
\item[] to set show message as development phase:
\item[] \textgreater{}\textgreater{} DBG.push\_debug(True)
\item[] 
\item[] to set no show message as production phase:
\item[] \textgreater{}\textgreater{} DBG.push\_debug(False)
\item[] 
\item[] to set show message temporary as development phase, only in a method:
\item[] \textgreater{}\textgreater{} def aMethodToDebug(…):
\item[] \textgreater{}\textgreater{}   DBG.push\_debug(True)              \#force show as appended status
\item[] \textgreater{}\textgreater{}   etc. method code with some DBG.write()
\item[] \textgreater{}\textgreater{}   DBG.pop\_debug()                   \#restore previous status (show or not show)
\item[] \textgreater{}\textgreater{}   return
\item[] 
\item[] to set a message for future fix, as temporary problem to not forget:
\item[] DBG.tofix(“aTitle”, aVariable, True/False) \#True/False in production shown, or not
\item[] 
\item[] in command line interface you could redirect stderr to file ‘myDebug.log’:
\item[] \textgreater{}\textgreater{} sat compile … 2\textgreater{} myDebug.log   \# only stderr
\item[] \textgreater{}\textgreater{} sat compile … \&\textgreater{} myDebug.log   \# stdout and stderr
\end{DUlineblock}
\index{InStream (class in src.debug)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.debug.InStream}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{InStream}}}{\emph{buf=''}}{}
Bases: \sphinxcode{\sphinxupquote{StringIO.StringIO}}

utility class for pyconf.Config input iostream

\end{fulllineitems}

\index{OutStream (class in src.debug)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.debug.OutStream}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{OutStream}}}{\emph{buf=''}}{}
Bases: \sphinxcode{\sphinxupquote{StringIO.StringIO}}

utility class for pyconf.Config output iostream
\index{close() (src.debug.OutStream method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.debug.OutStream.close}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{close}}}{}{}
because Config.\_\_save\_\_ calls close() stream as file
keep value before lost as self.value

\end{fulllineitems}


\end{fulllineitems}

\index{format\_color\_exception() (in module src.debug)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.debug.format_color_exception}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{format\_color\_exception}}}{\emph{msg}, \emph{limit=None}, \emph{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)

\end{fulllineitems}

\index{format\_exception() (in module src.debug)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.debug.format_exception}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{format\_exception}}}{\emph{msg}, \emph{limit=None}, \emph{trace=None}}{}
Format a stack trace and the exception information.
as traceback.format\_exception(), without color
with traceback only if (\_debug) or (DBG.\_user in DBG.\_developpers)

\end{fulllineitems}

\index{getLocalEnv() (in module src.debug)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.debug.getLocalEnv}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{getLocalEnv}}}{}{}
get string for environment variables representation

\end{fulllineitems}

\index{getStrConfigDbg() (in module src.debug)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.debug.getStrConfigDbg}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{getStrConfigDbg}}}{\emph{config}}{}
set string as saveConfigDbg, 
as (path expression evaluation) for debug

\end{fulllineitems}

\index{getStrConfigStd() (in module src.debug)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.debug.getStrConfigStd}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{getStrConfigStd}}}{\emph{config}}{}
set string as saveConfigStd, as file .pyconf

\end{fulllineitems}

\index{indent() (in module src.debug)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.debug.indent}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{indent}}}{\emph{text}, \emph{amount=2}, \emph{ch=' '}}{}
indent multi lines message

\end{fulllineitems}

\index{isTypeConfig() (in module src.debug)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.debug.isTypeConfig}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{isTypeConfig}}}{\emph{var}}{}
To know if var is instance from Config/pyconf

\end{fulllineitems}

\index{pop\_debug() (in module src.debug)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.debug.pop_debug}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{pop\_debug}}}{}{}
restore previous debug outputs status

\end{fulllineitems}

\index{push\_debug() (in module src.debug)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.debug.push_debug}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{push\_debug}}}{\emph{aBool}}{}
set debug outputs activated, or not

\end{fulllineitems}

\index{saveConfigDbg() (in module src.debug)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.debug.saveConfigDbg}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{saveConfigDbg}}}{\emph{config}, \emph{aStream}, \emph{indent=0}, \emph{path=''}}{}
pyconf returns multilines (path expression evaluation) for debug

\end{fulllineitems}

\index{saveConfigStd() (in module src.debug)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.debug.saveConfigStd}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{saveConfigStd}}}{\emph{config}, \emph{aStream}}{}
returns as file .pyconf

\end{fulllineitems}

\index{tofix() (in module src.debug)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.debug.tofix}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{tofix}}}{\emph{title}, \emph{var=''}, \emph{force=None}}{}
write sys.stderr a message if \_debug{[}-1{]}==True or optionaly force=True
use this only if no logger accessible for classic logger.warning(message)

\end{fulllineitems}

\index{write() (in module src.debug)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.debug.write}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{write}}}{\emph{title}, \emph{var=''}, \emph{force=None}, \emph{fmt='\textbackslash{}n\#\#\#\# DEBUG: \%s:\textbackslash{}n\%s\textbackslash{}n'}}{}
write sys.stderr a message if \_debug{[}-1{]}==True or optionaly force=True

\end{fulllineitems}



\subsubsection{src.environment module}
\label{\detokenize{commands/apidoc/src:src-environment-module}}\label{\detokenize{commands/apidoc/src:module-src.environment}}\index{src.environment (module)}\index{Environ (class in src.environment)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.Environ}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.environment.}}\sphinxbfcode{\sphinxupquote{Environ}}}{\emph{environ=None}}{}
Class to manage the environment context
\index{append() (src.environment.Environ method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.Environ.append}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
Same as append\_value but the value argument can be a list
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to append

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}}\sphinxstyleliteralstrong{\sphinxupquote{ or }}\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the value(s) to append to key

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string

\end{itemize}

\end{description}\end{quote}

\end{fulllineitems}

\index{append\_value() (src.environment.Environ method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.Environ.append_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append\_value}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
append value to key using sep
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to append

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to append to key

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string

\end{itemize}

\end{description}\end{quote}

\end{fulllineitems}

\index{command\_value() (src.environment.Environ method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.Environ.command_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{command\_value}}}{\emph{key}, \emph{command}}{}
Get the value given by the system command “command” 
and put it in the environment variable key
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{command}}) \textendash{} the environment variable

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the command to execute

\end{itemize}

\end{description}\end{quote}

\end{fulllineitems}

\index{get() (src.environment.Environ method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.Environ.get}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get}}}{\emph{key}}{}
Get the value of the environment variable “key”
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable

\end{description}\end{quote}

\end{fulllineitems}

\index{is\_defined() (src.environment.Environ method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.Environ.is_defined}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{is\_defined}}}{\emph{key}}{}
Check if the key exists in the environment
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable to check

\end{description}\end{quote}

\end{fulllineitems}

\index{prepend() (src.environment.Environ method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.Environ.prepend}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepend}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
Same as prepend\_value but the value argument can be a list
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to prepend

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}}\sphinxstyleliteralstrong{\sphinxupquote{ or }}\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the value(s) to prepend to key

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string

\end{itemize}

\end{description}\end{quote}

\end{fulllineitems}

\index{prepend\_value() (src.environment.Environ method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.Environ.prepend_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepend\_value}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
prepend value to key using sep
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to prepend

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to prepend to key

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string

\end{itemize}

\end{description}\end{quote}

\end{fulllineitems}

\index{set() (src.environment.Environ method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.Environ.set}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set}}}{\emph{key}, \emph{value}}{}
Set the environment variable “key” to value “value”
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the environment variable to set

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value

\end{itemize}

\end{description}\end{quote}

\end{fulllineitems}


\end{fulllineitems}

\index{FileEnvWriter (class in src.environment)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.FileEnvWriter}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.environment.}}\sphinxbfcode{\sphinxupquote{FileEnvWriter}}}{\emph{config}, \emph{logger}, \emph{out\_dir}, \emph{src\_root}, \emph{env\_info=None}}{}
Class to dump the environment to a file.
\index{write\_cfgForPy\_file() (src.environment.FileEnvWriter method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.FileEnvWriter.write_cfgForPy_file}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write\_cfgForPy\_file}}}{\emph{filename}, \emph{additional\_env=\{\}}, \emph{for\_package=None}, \emph{with\_commercial=True}}{}
Append to current opened aFile a cfgForPy 
environment (SALOME python launcher).
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{for\_package}}) \textendash{} the file path

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{dict}} (\sphinxstyleliteralemphasis{\sphinxupquote{additional\_env}}) \textendash{} a dictionary of additional variables 
to add to the environment

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} If not None, produce a relative environment 
designed for a package.

\end{itemize}

\end{description}\end{quote}

\end{fulllineitems}

\index{write\_env\_file() (src.environment.FileEnvWriter method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.FileEnvWriter.write_env_file}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write\_env\_file}}}{\emph{filename}, \emph{forBuild}, \emph{shell}, \emph{for\_package=None}}{}
Create an environment file.
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{shell}}) \textendash{} the file path

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{bool}} (\sphinxstyleliteralemphasis{\sphinxupquote{forBuild}}) \textendash{} if true, the build environment

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the type of file wanted (.sh, .bat)

\end{itemize}

\item[{Returns}] \leavevmode
The path to the generated file

\item[{Return type}] \leavevmode
str

\end{description}\end{quote}

\end{fulllineitems}


\end{fulllineitems}

\index{SalomeEnviron (class in src.environment)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.environment.}}\sphinxbfcode{\sphinxupquote{SalomeEnviron}}}{\emph{cfg}, \emph{environ}, \emph{forBuild=False}, \emph{for\_package=None}, \emph{enable\_simple\_env\_script=True}}{}
Class to manage the environment of SALOME.
\index{add\_comment() (src.environment.SalomeEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.add_comment}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_comment}}}{\emph{comment}}{}
Add a commentary to the out stream (in case of file generation)
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{comment}}) \textendash{} the commentary to add

\end{description}\end{quote}

\end{fulllineitems}

\index{add\_line() (src.environment.SalomeEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.add_line}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_line}}}{\emph{nb\_line}}{}
Add empty lines to the out stream (in case of file generation)
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{int}} (\sphinxstyleliteralemphasis{\sphinxupquote{nb\_line}}) \textendash{} the number of empty lines to add

\end{description}\end{quote}

\end{fulllineitems}

\index{add\_warning() (src.environment.SalomeEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.add_warning}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_warning}}}{\emph{warning}}{}
Add a warning to the out stream (in case of file generation)
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{warning}}) \textendash{} the warning to add

\end{description}\end{quote}

\end{fulllineitems}

\index{append() (src.environment.SalomeEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.append}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
append value to key using sep
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to append

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to append to key

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string

\end{itemize}

\end{description}\end{quote}

\end{fulllineitems}

\index{dump() (src.environment.SalomeEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.dump}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{dump}}}{\emph{out}}{}
Write the environment to out
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{file}} (\sphinxstyleliteralemphasis{\sphinxupquote{out}}) \textendash{} the stream where to write the environment

\end{description}\end{quote}

\end{fulllineitems}

\index{finish() (src.environment.SalomeEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.finish}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{finish}}}{\emph{required}}{}
Add a final instruction in the out file (in case of file generation)
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{bool}} (\sphinxstyleliteralemphasis{\sphinxupquote{required}}) \textendash{} Do nothing if required is False

\end{description}\end{quote}

\end{fulllineitems}

\index{get() (src.environment.SalomeEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.get}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get}}}{\emph{key}}{}
Get the value of the environment variable “key”
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable

\end{description}\end{quote}

\end{fulllineitems}

\index{get\_names() (src.environment.SalomeEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.get_names}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_names}}}{\emph{lProducts}}{}
Get the products name to add in SALOME\_MODULES environment variable
It is the name of the product, except in the case where the is a 
component name. And it has to be in SALOME\_MODULES variable only 
if the product has the property has\_salome\_hui = “yes”
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{lProducts}}) \textendash{} List of products to potentially add

\end{description}\end{quote}

\end{fulllineitems}

\index{is\_defined() (src.environment.SalomeEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.is_defined}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{is\_defined}}}{\emph{key}}{}
Check if the key exists in the environment
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable to check

\end{description}\end{quote}

\end{fulllineitems}

\index{load\_cfg\_environment() (src.environment.SalomeEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.load_cfg_environment}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{load\_cfg\_environment}}}{\emph{cfg\_env}}{}
Loads environment defined in cfg\_env
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{cfg\_env}}) \textendash{} A config containing an environment

\end{description}\end{quote}

\end{fulllineitems}

\index{prepend() (src.environment.SalomeEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.prepend}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepend}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
prepend value to key using sep
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to prepend

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to prepend to key

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string

\end{itemize}

\end{description}\end{quote}

\end{fulllineitems}

\index{run\_env\_script() (src.environment.SalomeEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.run_env_script}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run\_env\_script}}}{\emph{product\_info}, \emph{logger=None}, \emph{native=False}}{}
Runs an environment script.
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The product description

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to display messages

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{Boolean}} (\sphinxstyleliteralemphasis{\sphinxupquote{native}}) \textendash{} if True load set\_native\_env instead of set\_env

\end{itemize}

\end{description}\end{quote}

\end{fulllineitems}

\index{run\_simple\_env\_script() (src.environment.SalomeEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.run_simple_env_script}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run\_simple\_env\_script}}}{\emph{script\_path}, \emph{logger=None}}{}
Runs an environment script. Same as run\_env\_script, but with a 
script path as parameter.
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{script\_path}}) \textendash{} a path to an environment script

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to display messages

\end{itemize}

\end{description}\end{quote}

\end{fulllineitems}

\index{set() (src.environment.SalomeEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.set}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set}}}{\emph{key}, \emph{value}}{}
Set the environment variable “key” to value “value”
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the environment variable to set

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value

\end{itemize}

\end{description}\end{quote}

\end{fulllineitems}

\index{set\_a\_product() (src.environment.SalomeEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.set_a_product}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_a\_product}}}{\emph{product}, \emph{logger}}{}
Sets the environment of a product.
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{product}}) \textendash{} The product name

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to display messages

\end{itemize}

\end{description}\end{quote}

\end{fulllineitems}

\index{set\_application\_env() (src.environment.SalomeEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.set_application_env}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_application\_env}}}{\emph{logger}}{}
Sets the environment defined in the APPLICATION file.
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to display messages

\end{description}\end{quote}

\end{fulllineitems}

\index{set\_cpp\_env() (src.environment.SalomeEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.set_cpp_env}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_cpp\_env}}}{\emph{product\_info}}{}
Sets the generic environment for a SALOME cpp product.
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The product description

\end{description}\end{quote}

\end{fulllineitems}

\index{set\_full\_environ() (src.environment.SalomeEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.set_full_environ}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_full\_environ}}}{\emph{logger}, \emph{env\_info}}{}
Sets the full environment for products 
specified in env\_info dictionary.
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to display messages

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{env\_info}}) \textendash{} the list of products

\end{itemize}

\end{description}\end{quote}

\end{fulllineitems}

\index{set\_products() (src.environment.SalomeEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.set_products}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_products}}}{\emph{logger}, \emph{src\_root=None}}{}
Sets the environment for all the products.
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to display messages

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{src}} (\sphinxstyleliteralemphasis{\sphinxupquote{src\_root}}) \textendash{} the application working directory

\end{itemize}

\end{description}\end{quote}

\end{fulllineitems}

\index{set\_python\_libdirs() (src.environment.SalomeEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.set_python_libdirs}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_python\_libdirs}}}{}{}
Set some generic variables for python library paths

\end{fulllineitems}

\index{set\_salome\_generic\_product\_env() (src.environment.SalomeEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.set_salome_generic_product_env}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_salome\_generic\_product\_env}}}{\emph{pi}}{}
Sets the generic environment for a SALOME product.
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{pi}}) \textendash{} The product description

\end{description}\end{quote}

\end{fulllineitems}

\index{set\_salome\_minimal\_product\_env() (src.environment.SalomeEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.set_salome_minimal_product_env}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_salome\_minimal\_product\_env}}}{\emph{product\_info}, \emph{logger}}{}
Sets the minimal environment for a SALOME product.
xxx\_ROOT\_DIR and xxx\_SRC\_DIR
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The product description

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to display messages

\end{itemize}

\end{description}\end{quote}

\end{fulllineitems}


\end{fulllineitems}

\index{Shell (class in src.environment)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.Shell}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.environment.}}\sphinxbfcode{\sphinxupquote{Shell}}}{\emph{name}, \emph{extension}}{}
Definition of a Shell.

\end{fulllineitems}

\index{load\_environment() (in module src.environment)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.load_environment}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.environment.}}\sphinxbfcode{\sphinxupquote{load\_environment}}}{\emph{config}, \emph{build}, \emph{logger}}{}
Loads the environment (used to run the tests, for example).
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} the global config

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{bool}} (\sphinxstyleliteralemphasis{\sphinxupquote{build}}) \textendash{} build environement if True

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to display messages

\end{itemize}

\end{description}\end{quote}

\end{fulllineitems}



\subsubsection{src.fileEnviron module}
\label{\detokenize{commands/apidoc/src:src-fileenviron-module}}\label{\detokenize{commands/apidoc/src:module-src.fileEnviron}}\index{src.fileEnviron (module)}\index{BashFileEnviron (class in src.fileEnviron)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.BashFileEnviron}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.fileEnviron.}}\sphinxbfcode{\sphinxupquote{BashFileEnviron}}}{\emph{output}, \emph{environ=None}}{}
Bases: {\hyperref[\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.fileEnviron.FileEnviron}}}}} (\autopageref*{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron}})

Class for bash shell.
\index{command\_value() (src.fileEnviron.BashFileEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.BashFileEnviron.command_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{command\_value}}}{\emph{key}, \emph{command}}{}
Get the value given by the system command “command” 
and put it in the environment variable key.
Has to be overwritten in the derived classes
This can be seen as a virtual method
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{command}}) \textendash{} the environment variable

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the command to execute

\end{itemize}

\end{description}\end{quote}

\end{fulllineitems}

\index{finish() (src.fileEnviron.BashFileEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.BashFileEnviron.finish}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{finish}}}{\emph{required=True}}{}
Add a final instruction in the out file (in case of file generation)
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{bool}} (\sphinxstyleliteralemphasis{\sphinxupquote{required}}) \textendash{} Do nothing if required is False

\end{description}\end{quote}

\end{fulllineitems}

\index{set() (src.fileEnviron.BashFileEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.BashFileEnviron.set}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set}}}{\emph{key}, \emph{value}}{}
Set the environment variable “key” to value “value”
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the environment variable to set

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value

\end{itemize}

\end{description}\end{quote}

\end{fulllineitems}


\end{fulllineitems}

\index{BatFileEnviron (class in src.fileEnviron)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.BatFileEnviron}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.fileEnviron.}}\sphinxbfcode{\sphinxupquote{BatFileEnviron}}}{\emph{output}, \emph{environ=None}}{}
Bases: {\hyperref[\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.fileEnviron.FileEnviron}}}}} (\autopageref*{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron}})

for Windows batch shell.
\index{add\_comment() (src.fileEnviron.BatFileEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.BatFileEnviron.add_comment}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_comment}}}{\emph{comment}}{}
Add a comment in the shell file
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{comment}}) \textendash{} the comment to add

\end{description}\end{quote}

\end{fulllineitems}

\index{command\_value() (src.fileEnviron.BatFileEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.BatFileEnviron.command_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{command\_value}}}{\emph{key}, \emph{command}}{}
Get the value given by the system command “command” 
and put it in the environment variable key.
Has to be overwritten in the derived classes
This can be seen as a virtual method
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{command}}) \textendash{} the environment variable

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the command to execute

\end{itemize}

\end{description}\end{quote}

\end{fulllineitems}

\index{finish() (src.fileEnviron.BatFileEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.BatFileEnviron.finish}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{finish}}}{\emph{required=True}}{}
Add a final instruction in the out file (in case of file generation)
In the particular windows case, do nothing
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{bool}} (\sphinxstyleliteralemphasis{\sphinxupquote{required}}) \textendash{} Do nothing if required is False

\end{description}\end{quote}

\end{fulllineitems}

\index{get() (src.fileEnviron.BatFileEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.BatFileEnviron.get}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get}}}{\emph{key}}{}
Get the value of the environment variable “key”
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable

\end{description}\end{quote}

\end{fulllineitems}

\index{set() (src.fileEnviron.BatFileEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.BatFileEnviron.set}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set}}}{\emph{key}, \emph{value}}{}
Set the environment variable “key” to value “value”
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the environment variable to set

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value

\end{itemize}

\end{description}\end{quote}

\end{fulllineitems}


\end{fulllineitems}

\index{ContextFileEnviron (class in src.fileEnviron)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ContextFileEnviron}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.fileEnviron.}}\sphinxbfcode{\sphinxupquote{ContextFileEnviron}}}{\emph{output}, \emph{environ=None}}{}
Bases: {\hyperref[\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.fileEnviron.FileEnviron}}}}} (\autopageref*{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron}})

Class for a salome context configuration file.
\index{add\_echo() (src.fileEnviron.ContextFileEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.add_echo}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_echo}}}{\emph{text}}{}
Add a comment
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{text}}) \textendash{} the comment to add

\end{description}\end{quote}

\end{fulllineitems}

\index{add\_warning() (src.fileEnviron.ContextFileEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.add_warning}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_warning}}}{\emph{warning}}{}
Add a warning
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{text}}) \textendash{} the warning to add

\end{description}\end{quote}

\end{fulllineitems}

\index{append\_value() (src.fileEnviron.ContextFileEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.append_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append\_value}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
append value to key using sep
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to append

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to append to key

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string

\end{itemize}

\end{description}\end{quote}

\end{fulllineitems}

\index{command\_value() (src.fileEnviron.ContextFileEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.command_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{command\_value}}}{\emph{key}, \emph{command}}{}
Get the value given by the system command “command” 
and put it in the environment variable key.
Has to be overwritten in the derived classes
This can be seen as a virtual method
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{command}}) \textendash{} the environment variable

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the command to execute

\end{itemize}

\end{description}\end{quote}

\end{fulllineitems}

\index{finish() (src.fileEnviron.ContextFileEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.finish}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{finish}}}{\emph{required=True}}{}
Add a final instruction in the out file (in case of file generation)
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{bool}} (\sphinxstyleliteralemphasis{\sphinxupquote{required}}) \textendash{} Do nothing if required is False

\end{description}\end{quote}

\end{fulllineitems}

\index{get() (src.fileEnviron.ContextFileEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.get}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get}}}{\emph{key}}{}
Get the value of the environment variable “key”
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable

\end{description}\end{quote}

\end{fulllineitems}

\index{prepend\_value() (src.fileEnviron.ContextFileEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.prepend_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepend\_value}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
prepend value to key using sep
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to prepend

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to prepend to key

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string

\end{itemize}

\end{description}\end{quote}

\end{fulllineitems}

\index{set() (src.fileEnviron.ContextFileEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.set}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set}}}{\emph{key}, \emph{value}}{}
Set the environment variable “key” to value “value”
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the environment variable to set

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value

\end{itemize}

\end{description}\end{quote}

\end{fulllineitems}


\end{fulllineitems}

\index{FileEnviron (class in src.fileEnviron)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.fileEnviron.}}\sphinxbfcode{\sphinxupquote{FileEnviron}}}{\emph{output}, \emph{environ=None}}{}
Bases: \sphinxcode{\sphinxupquote{object}}

Base class for shell environment
\index{add\_comment() (src.fileEnviron.FileEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.add_comment}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_comment}}}{\emph{comment}}{}
Add a comment in the shell file
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{comment}}) \textendash{} the comment to add

\end{description}\end{quote}

\end{fulllineitems}

\index{add\_echo() (src.fileEnviron.FileEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.add_echo}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_echo}}}{\emph{text}}{}
Add a “echo” in the shell file
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{text}}) \textendash{} the text to echo

\end{description}\end{quote}

\end{fulllineitems}

\index{add\_line() (src.fileEnviron.FileEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.add_line}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_line}}}{\emph{number}}{}
Add some empty lines in the shell file
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{int}} (\sphinxstyleliteralemphasis{\sphinxupquote{number}}) \textendash{} the number of lines to add

\end{description}\end{quote}

\end{fulllineitems}

\index{add\_warning() (src.fileEnviron.FileEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.add_warning}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_warning}}}{\emph{warning}}{}
Add a warning “echo” in the shell file
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{warning}}) \textendash{} the text to echo

\end{description}\end{quote}

\end{fulllineitems}

\index{append() (src.fileEnviron.FileEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.append}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
Same as append\_value but the value argument can be a list
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to append

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}}\sphinxstyleliteralstrong{\sphinxupquote{ or }}\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the value(s) to append to key

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string

\end{itemize}

\end{description}\end{quote}

\end{fulllineitems}

\index{append\_value() (src.fileEnviron.FileEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.append_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append\_value}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
append value to key using sep
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to append

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to append to key

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string

\end{itemize}

\end{description}\end{quote}

\end{fulllineitems}

\index{command\_value() (src.fileEnviron.FileEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.command_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{command\_value}}}{\emph{key}, \emph{command}}{}
Get the value given by the system command “command” 
and put it in the environment variable key.
Has to be overwritten in the derived classes
This can be seen as a virtual method
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{command}}) \textendash{} the environment variable

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the command to execute

\end{itemize}

\end{description}\end{quote}

\end{fulllineitems}

\index{finish() (src.fileEnviron.FileEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.finish}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{finish}}}{\emph{required=True}}{}
Add a final instruction in the out file (in case of file generation)
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{bool}} (\sphinxstyleliteralemphasis{\sphinxupquote{required}}) \textendash{} Do nothing if required is False

\end{description}\end{quote}

\end{fulllineitems}

\index{get() (src.fileEnviron.FileEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.get}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get}}}{\emph{key}}{}
Get the value of the environment variable “key”
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable

\end{description}\end{quote}

\end{fulllineitems}

\index{is\_defined() (src.fileEnviron.FileEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.is_defined}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{is\_defined}}}{\emph{key}}{}
Check if the key exists in the environment
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable to check

\end{description}\end{quote}

\end{fulllineitems}

\index{prepend() (src.fileEnviron.FileEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.prepend}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepend}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
Same as prepend\_value but the value argument can be a list
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to prepend

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}}\sphinxstyleliteralstrong{\sphinxupquote{ or }}\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the value(s) to prepend to key

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string

\end{itemize}

\end{description}\end{quote}

\end{fulllineitems}

\index{prepend\_value() (src.fileEnviron.FileEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.prepend_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepend\_value}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
prepend value to key using sep
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to prepend

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to prepend to key

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string

\end{itemize}

\end{description}\end{quote}

\end{fulllineitems}

\index{set() (src.fileEnviron.FileEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.set}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set}}}{\emph{key}, \emph{value}}{}
Set the environment variable ‘key’ to value ‘value’
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the environment variable to set

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value

\end{itemize}

\end{description}\end{quote}

\end{fulllineitems}


\end{fulllineitems}

\index{LauncherFileEnviron (class in src.fileEnviron)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.fileEnviron.}}\sphinxbfcode{\sphinxupquote{LauncherFileEnviron}}}{\emph{output}, \emph{environ=None}}{}
Class to generate a launcher file script 
(in python syntax) SalomeContext API
\index{add() (src.fileEnviron.LauncherFileEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add}}}{\emph{key}, \emph{value}}{}
prepend value to key using sep
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the environment variable to prepend

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to prepend to key

\end{itemize}

\end{description}\end{quote}

\end{fulllineitems}

\index{add\_comment() (src.fileEnviron.LauncherFileEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add_comment}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_comment}}}{\emph{comment}}{}
\end{fulllineitems}

\index{add\_echo() (src.fileEnviron.LauncherFileEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add_echo}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_echo}}}{\emph{text}}{}
Add a comment
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{text}}) \textendash{} the comment to add

\end{description}\end{quote}

\end{fulllineitems}

\index{add\_line() (src.fileEnviron.LauncherFileEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add_line}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_line}}}{\emph{number}}{}
Add some empty lines in the launcher file
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{int}} (\sphinxstyleliteralemphasis{\sphinxupquote{number}}) \textendash{} the number of lines to add

\end{description}\end{quote}

\end{fulllineitems}

\index{add\_warning() (src.fileEnviron.LauncherFileEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add_warning}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_warning}}}{\emph{warning}}{}
Add a warning
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{text}}) \textendash{} the warning to add

\end{description}\end{quote}

\end{fulllineitems}

\index{append() (src.fileEnviron.LauncherFileEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.append}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
Same as append\_value but the value argument can be a list
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to append

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}}\sphinxstyleliteralstrong{\sphinxupquote{ or }}\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the value(s) to append to key

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string

\end{itemize}

\end{description}\end{quote}

\end{fulllineitems}

\index{append\_value() (src.fileEnviron.LauncherFileEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.append_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append\_value}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
append value to key using sep
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to append

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to append to key

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string

\end{itemize}

\end{description}\end{quote}

\end{fulllineitems}

\index{change\_to\_launcher() (src.fileEnviron.LauncherFileEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.change_to_launcher}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{change\_to\_launcher}}}{\emph{value}}{}
\end{fulllineitems}

\index{command\_value() (src.fileEnviron.LauncherFileEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.command_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{command\_value}}}{\emph{key}, \emph{command}}{}
Get the value given by the system command “command” 
and put it in the environment variable key.
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{command}}) \textendash{} the environment variable

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the command to execute

\end{itemize}

\end{description}\end{quote}

\end{fulllineitems}

\index{finish() (src.fileEnviron.LauncherFileEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.finish}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{finish}}}{\emph{required=True}}{}
Add a final instruction in the out file (in case of file generation)
In the particular launcher case, do nothing
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{bool}} (\sphinxstyleliteralemphasis{\sphinxupquote{required}}) \textendash{} Do nothing if required is False

\end{description}\end{quote}

\end{fulllineitems}

\index{get() (src.fileEnviron.LauncherFileEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.get}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get}}}{\emph{key}}{}
Get the value of the environment variable “key”
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable

\end{description}\end{quote}

\end{fulllineitems}

\index{is\_defined() (src.fileEnviron.LauncherFileEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.is_defined}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{is\_defined}}}{\emph{key}}{}
Check if the key exists in the environment
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable to check

\end{description}\end{quote}

\end{fulllineitems}

\index{prepend() (src.fileEnviron.LauncherFileEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.prepend}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepend}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
Same as prepend\_value but the value argument can be a list
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to prepend

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}}\sphinxstyleliteralstrong{\sphinxupquote{ or }}\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the value(s) to prepend to key

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string

\end{itemize}

\end{description}\end{quote}

\end{fulllineitems}

\index{prepend\_value() (src.fileEnviron.LauncherFileEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.prepend_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepend\_value}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
prepend value to key using sep
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to prepend

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to prepend to key

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string

\end{itemize}

\end{description}\end{quote}

\end{fulllineitems}

\index{set() (src.fileEnviron.LauncherFileEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.set}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set}}}{\emph{key}, \emph{value}}{}
Set the environment variable “key” to value “value”
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the environment variable to set

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value

\end{itemize}

\end{description}\end{quote}

\end{fulllineitems}


\end{fulllineitems}

\index{ScreenEnviron (class in src.fileEnviron)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.fileEnviron.}}\sphinxbfcode{\sphinxupquote{ScreenEnviron}}}{\emph{output}, \emph{environ=None}}{}
Bases: {\hyperref[\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.fileEnviron.FileEnviron}}}}} (\autopageref*{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron}})
\index{add\_comment() (src.fileEnviron.ScreenEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.add_comment}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_comment}}}{\emph{comment}}{}
Add a comment in the shell file
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{comment}}) \textendash{} the comment to add

\end{description}\end{quote}

\end{fulllineitems}

\index{add\_echo() (src.fileEnviron.ScreenEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.add_echo}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_echo}}}{\emph{text}}{}
Add a “echo” in the shell file
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{text}}) \textendash{} the text to echo

\end{description}\end{quote}

\end{fulllineitems}

\index{add\_line() (src.fileEnviron.ScreenEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.add_line}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_line}}}{\emph{number}}{}
Add some empty lines in the shell file
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{int}} (\sphinxstyleliteralemphasis{\sphinxupquote{number}}) \textendash{} the number of lines to add

\end{description}\end{quote}

\end{fulllineitems}

\index{add\_warning() (src.fileEnviron.ScreenEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.add_warning}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_warning}}}{\emph{warning}}{}
Add a warning “echo” in the shell file
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{warning}}) \textendash{} the text to echo

\end{description}\end{quote}

\end{fulllineitems}

\index{append() (src.fileEnviron.ScreenEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.append}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append}}}{\emph{name}, \emph{value}, \emph{sep=':'}}{}
Same as append\_value but the value argument can be a list
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to append

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}}\sphinxstyleliteralstrong{\sphinxupquote{ or }}\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the value(s) to append to key

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string

\end{itemize}

\end{description}\end{quote}

\end{fulllineitems}

\index{command\_value() (src.fileEnviron.ScreenEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.command_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{command\_value}}}{\emph{key}, \emph{command}}{}
Get the value given by the system command “command” 
and put it in the environment variable key.
Has to be overwritten in the derived classes
This can be seen as a virtual method
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{command}}) \textendash{} the environment variable

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the command to execute

\end{itemize}

\end{description}\end{quote}

\end{fulllineitems}

\index{get() (src.fileEnviron.ScreenEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.get}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get}}}{\emph{name}}{}
Get the value of the environment variable “key”
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable

\end{description}\end{quote}

\end{fulllineitems}

\index{is\_defined() (src.fileEnviron.ScreenEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.is_defined}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{is\_defined}}}{\emph{name}}{}
Check if the key exists in the environment
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable to check

\end{description}\end{quote}

\end{fulllineitems}

\index{prepend() (src.fileEnviron.ScreenEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.prepend}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepend}}}{\emph{name}, \emph{value}, \emph{sep=':'}}{}
Same as prepend\_value but the value argument can be a list
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to prepend

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}}\sphinxstyleliteralstrong{\sphinxupquote{ or }}\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the value(s) to prepend to key

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string

\end{itemize}

\end{description}\end{quote}

\end{fulllineitems}

\index{run\_env\_script() (src.fileEnviron.ScreenEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.run_env_script}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run\_env\_script}}}{\emph{module}, \emph{script}}{}
\end{fulllineitems}

\index{set() (src.fileEnviron.ScreenEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.set}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set}}}{\emph{name}, \emph{value}}{}
Set the environment variable ‘key’ to value ‘value’
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the environment variable to set

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value

\end{itemize}

\end{description}\end{quote}

\end{fulllineitems}

\index{write() (src.fileEnviron.ScreenEnviron method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.write}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write}}}{\emph{command}, \emph{name}, \emph{value}, \emph{sign='='}}{}
\end{fulllineitems}


\end{fulllineitems}

\index{get\_file\_environ() (in module src.fileEnviron)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.get_file_environ}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.fileEnviron.}}\sphinxbfcode{\sphinxupquote{get\_file\_environ}}}{\emph{output}, \emph{shell}, \emph{environ=None}}{}
Instantiate correct FileEnvironment sub-class.
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{file}} (\sphinxstyleliteralemphasis{\sphinxupquote{output}}) \textendash{} the output file stream.

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{shell}}) \textendash{} the type of shell syntax to use.

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{dict}} (\sphinxstyleliteralemphasis{\sphinxupquote{environ}}) \textendash{} a potential additional environment.

\end{itemize}

\end{description}\end{quote}

\end{fulllineitems}

\index{special\_path\_separator() (in module src.fileEnviron)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.special_path_separator}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.fileEnviron.}}\sphinxbfcode{\sphinxupquote{special\_path\_separator}}}{\emph{name}}{}
TCLLIBPATH, TKLIBPATH, PV\_PLUGIN\_PATH environments variables need
some exotic path separator.
This function gives the separator regarding the name of the variable
to append or prepend.
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{name}}) \textendash{} The name of the variable to find the separator

\end{description}\end{quote}

\end{fulllineitems}



\subsubsection{src.fork module}
\label{\detokenize{commands/apidoc/src:module-src.fork}}\label{\detokenize{commands/apidoc/src:src-fork-module}}\index{src.fork (module)}\index{batch() (in module src.fork)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fork.batch}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.fork.}}\sphinxbfcode{\sphinxupquote{batch}}}{\emph{cmd}, \emph{logger}, \emph{cwd}, \emph{args={[}{]}}, \emph{log=None}, \emph{delai=20}, \emph{sommeil=1}}{}
\end{fulllineitems}

\index{batch\_salome() (in module src.fork)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fork.batch_salome}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.fork.}}\sphinxbfcode{\sphinxupquote{batch\_salome}}}{\emph{cmd}, \emph{logger}, \emph{cwd}, \emph{args}, \emph{getTmpDir}, \emph{pendant='SALOME\_Session\_Server'}, \emph{fin='killSalome.py'}, \emph{log=None}, \emph{delai=20}, \emph{sommeil=1}, \emph{delaiapp=0}}{}
\end{fulllineitems}

\index{launch\_command() (in module src.fork)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fork.launch_command}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.fork.}}\sphinxbfcode{\sphinxupquote{launch\_command}}}{\emph{cmd}, \emph{logger}, \emph{cwd}, \emph{args={[}{]}}, \emph{log=None}}{}
\end{fulllineitems}

\index{show\_progress() (in module src.fork)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fork.show_progress}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.fork.}}\sphinxbfcode{\sphinxupquote{show\_progress}}}{\emph{logger}, \emph{top}, \emph{delai}, \emph{ss=''}}{}
shortcut function to display the progression
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logging instance

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{int}} (\sphinxstyleliteralemphasis{\sphinxupquote{delai}}) \textendash{} the number to display

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{int}} \textendash{} the number max

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{ss}}) \textendash{} the string to display

\end{itemize}

\end{description}\end{quote}

\end{fulllineitems}

\index{write\_back() (in module src.fork)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.fork.write_back}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.fork.}}\sphinxbfcode{\sphinxupquote{write\_back}}}{\emph{logger}, \emph{message}, \emph{level}}{}
shortcut function to write at the begin of the line
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logging instance

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{message}}) \textendash{} the text to display

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{int}} (\sphinxstyleliteralemphasis{\sphinxupquote{level}}) \textendash{} the level of verbosity

\end{itemize}

\end{description}\end{quote}

\end{fulllineitems}



\subsubsection{src.logger module}
\label{\detokenize{commands/apidoc/src:module-src.logger}}\label{\detokenize{commands/apidoc/src:src-logger-module}}\index{src.logger (module)}
Implements the classes and method relative to the logging
\index{Logger (class in src.logger)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.logger.Logger}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.logger.}}\sphinxbfcode{\sphinxupquote{Logger}}}{\emph{config=None}, \emph{silent\_sysstd=False}, \emph{all\_in\_terminal=False}, \emph{micro\_command=False}}{}
Bases: \sphinxcode{\sphinxupquote{object}}

Class to handle log mechanism.
\index{add\_link() (src.logger.Logger method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.logger.Logger.add_link}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_link}}}{\emph{log\_file\_name}, \emph{command\_name}, \emph{command\_res}, \emph{full\_launched\_command}}{}
Add a link to another log file.
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{command\_res}}) \textendash{} The file name of the link.

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The name of the command linked.

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The result of the command linked. “0” or “1”

\end{itemize}

\item[{Parma full\_launched\_command str}] \leavevmode
The full lanch command 
(“sat command …”)

\end{description}\end{quote}

\end{fulllineitems}

\index{end\_write() (src.logger.Logger method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.logger.Logger.end_write}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{end\_write}}}{\emph{attribute}}{}
Called just after command end: Put all fields 
corresponding to the command end context (time).
Write the log xml file on the hard drive.
And display the command to launch to get the log
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{dict}} (\sphinxstyleliteralemphasis{\sphinxupquote{attribute}}) \textendash{} the attribute to add to the node “Site”.

\end{description}\end{quote}

\end{fulllineitems}

\index{error() (src.logger.Logger method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.logger.Logger.error}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{error}}}{\emph{message}}{}
Print an error.
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{message}}) \textendash{} The message to print.

\end{description}\end{quote}

\end{fulllineitems}

\index{flush() (src.logger.Logger method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.logger.Logger.flush}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{flush}}}{}{}
Flush terminal

\end{fulllineitems}

\index{put\_initial\_xml\_fields() (src.logger.Logger method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.logger.Logger.put_initial_xml_fields}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{put\_initial\_xml\_fields}}}{}{}
Called at class initialization: Put all fields 
corresponding to the command context (user, time, …)

\end{fulllineitems}

\index{write() (src.logger.Logger method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.logger.Logger.write}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write}}}{\emph{message}, \emph{level=None}, \emph{screenOnly=False}}{}
function used in the commands 
to print in the terminal and the log file.
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{message}}) \textendash{} The message to print.

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{int}} (\sphinxstyleliteralemphasis{\sphinxupquote{level}}) \textendash{} The output level corresponding 
to the message 0 \textless{} level \textless{} 6.

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{boolean}} (\sphinxstyleliteralemphasis{\sphinxupquote{screenOnly}}) \textendash{} if True, do not write in log file.

\end{itemize}

\end{description}\end{quote}

\end{fulllineitems}


\end{fulllineitems}

\index{date\_to\_datetime() (in module src.logger)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.logger.date_to_datetime}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.logger.}}\sphinxbfcode{\sphinxupquote{date\_to\_datetime}}}{\emph{date}}{}
From a string date in format YYYYMMDD\_HHMMSS
returns list year, mon, day, hour, minutes, seconds
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{date}}) \textendash{} The date in format YYYYMMDD\_HHMMSS

\item[{Returns}] \leavevmode
the same date and time in separate variables.

\item[{Return type}] \leavevmode
(str,str,str,str,str,str)

\end{description}\end{quote}

\end{fulllineitems}

\index{getCurrentLogger() (in module src.logger)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.logger.getCurrentLogger}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.logger.}}\sphinxbfcode{\sphinxupquote{getCurrentLogger}}}{}{}
get current logging logger, set as DefaultLogger if not set yet

\end{fulllineitems}

\index{getDefaultLogger() (in module src.logger)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.logger.getDefaultLogger}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.logger.}}\sphinxbfcode{\sphinxupquote{getDefaultLogger}}}{}{}
get simple logging logger DefaultLogger, set it as current

\end{fulllineitems}

\index{getUnittestLogger() (in module src.logger)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.logger.getUnittestLogger}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.logger.}}\sphinxbfcode{\sphinxupquote{getUnittestLogger}}}{}{}
get simple logging logger UnittestLogger, set it as current

\end{fulllineitems}

\index{isCurrentLoggerUnittest() (in module src.logger)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.logger.isCurrentLoggerUnittest}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.logger.}}\sphinxbfcode{\sphinxupquote{isCurrentLoggerUnittest}}}{}{}
\end{fulllineitems}

\index{list\_log\_file() (in module src.logger)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.logger.list_log_file}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.logger.}}\sphinxbfcode{\sphinxupquote{list\_log\_file}}}{\emph{dirPath}, \emph{expression}}{}
Find all files corresponding to expression in dirPath
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{expression}}) \textendash{} the directory where to search the files

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the regular expression of files to find

\end{itemize}

\item[{Returns}] \leavevmode
the list of files path and informations about it

\item[{Return type}] \leavevmode
list

\end{description}\end{quote}

\end{fulllineitems}

\index{sendMessageToCurrentLogger() (in module src.logger)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.logger.sendMessageToCurrentLogger}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.logger.}}\sphinxbfcode{\sphinxupquote{sendMessageToCurrentLogger}}}{\emph{message}, \emph{level}}{}
assume relay from obsolescent
logger.write(msg, 1/2/3…) to future
logging.critical/warning/info…(msg) (as logging package tips)

\end{fulllineitems}

\index{setCurrentLogger() (in module src.logger)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.logger.setCurrentLogger}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.logger.}}\sphinxbfcode{\sphinxupquote{setCurrentLogger}}}{\emph{logger}}{}
temporary send all in stdout as simple logging logger

\end{fulllineitems}

\index{show\_command\_log() (in module src.logger)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.logger.show_command_log}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.logger.}}\sphinxbfcode{\sphinxupquote{show\_command\_log}}}{\emph{logFilePath}, \emph{cmd}, \emph{application}, \emph{notShownCommands}}{}
Used in updateHatXml. 
Determine if the log xml file logFilePath 
has to be shown or not in the hat log.
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{application}}) \textendash{} the path to the command xml log file

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the command of the log file

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the application passed as parameter 
to the salomeTools command

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{notShownCommands}}) \textendash{} the list of commands 
that are not shown by default

\end{itemize}

\item[{Returns}] \leavevmode
True if cmd is not in notShownCommands and the application 
in the log file corresponds to application

\item[{Return type}] \leavevmode
boolean

\end{description}\end{quote}

\end{fulllineitems}

\index{timedelta\_total\_seconds() (in module src.logger)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.logger.timedelta_total_seconds}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.logger.}}\sphinxbfcode{\sphinxupquote{timedelta\_total\_seconds}}}{\emph{timedelta}}{}
Replace total\_seconds from datetime module 
in order to be compatible with old python versions
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{datetime.timedelta}} (\sphinxstyleliteralemphasis{\sphinxupquote{timedelta}}) \textendash{} The delta between two dates

\item[{Returns}] \leavevmode
The number of seconds corresponding to timedelta.

\item[{Return type}] \leavevmode
float

\end{description}\end{quote}

\end{fulllineitems}

\index{update\_hat\_xml() (in module src.logger)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.logger.update_hat_xml}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.logger.}}\sphinxbfcode{\sphinxupquote{update\_hat\_xml}}}{\emph{logDir}, \emph{application=None}, \emph{notShownCommands={[}{]}}}{}
Create the xml file in logDir that contain all the xml file 
and have a name like YYYYMMDD\_HHMMSS\_namecmd.xml
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{application}}) \textendash{} the directory to parse

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the name of the application if there is any

\end{itemize}

\end{description}\end{quote}

\end{fulllineitems}



\subsubsection{src.options module}
\label{\detokenize{commands/apidoc/src:module-src.options}}\label{\detokenize{commands/apidoc/src:src-options-module}}\index{src.options (module)}
The Options class that manages the access to all options passed as 
parameters in salomeTools command lines
\index{OptResult (class in src.options)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.options.OptResult}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.options.}}\sphinxbfcode{\sphinxupquote{OptResult}}}
Bases: \sphinxcode{\sphinxupquote{object}}

An instance of this class will be the object manipulated
in code of all salomeTools commands
The aim of this class is to have an elegant syntax to manipulate the options.

\begin{DUlineblock}{0em}
\item[] Example:        
\item[] \textgreater{}\textgreater{} options, remainderArgs = command.parseArguments(args)
\item[] \textgreater{}\textgreater{} print(options.output\_verbose\_level)
\item[] \textgreater{}\textgreater{} ‘INFO’
\end{DUlineblock}

\end{fulllineitems}

\index{Options (class in src.options)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.options.Options}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.options.}}\sphinxbfcode{\sphinxupquote{Options}}}
Bases: \sphinxcode{\sphinxupquote{object}}

Class to manage all salomeTools options
\index{add\_option() (src.options.Options method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.options.Options.add_option}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_option}}}{\emph{shortName}, \emph{longName}, \emph{optionType}, \emph{destName}, \emph{helpString=''}, \emph{default=None}}{}
Add an option to a command. It gets all attributes
of an option and append it in the options field
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{shortName}} \textendash{} (str) 
The short name of the option (as ‘-l’ for level option).

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{longName}} \textendash{} (str) 
The long name of the option (as ‘\textendash{}level’ for level option).

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{optionType}} \textendash{} (str) The type of the option (ex “int”).

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{destName}} \textendash{} (str) The name that will be used in the code.

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{helpString}} \textendash{} (str) 
The text to display when user ask for help on a command.

\end{itemize}

\item[{Returns}] \leavevmode
None

\end{description}\end{quote}

\end{fulllineitems}

\index{debug\_write() (src.options.Options method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.options.Options.debug_write}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{debug\_write}}}{}{}
\end{fulllineitems}

\index{filterLevel() (src.options.Options method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.options.Options.filterLevel}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{filterLevel}}}{\emph{aLevel}}{}
filter level logging values

\end{fulllineitems}

\index{filterList2() (src.options.Options method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.options.Options.filterList2}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{filterList2}}}{\emph{aStr}}{}
filter a list as ‘KERNEL,YACS,etc.’

\end{fulllineitems}

\index{getDetailOption() (src.options.Options method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.options.Options.getDetailOption}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getDetailOption}}}{\emph{option}}{}
for convenience
\begin{quote}\begin{description}
\item[{Returns}] \leavevmode
(tuple) 4-elements (shortName, longName, optionType, helpString)

\end{description}\end{quote}

\end{fulllineitems}

\index{get\_help() (src.options.Options method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.options.Options.get_help}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_help}}}{}{}
Returns all options stored in self.options 
as help message colored string
\begin{quote}\begin{description}
\item[{Returns}] \leavevmode
(str) colored string

\end{description}\end{quote}

\end{fulllineitems}

\index{indent() (src.options.Options method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.options.Options.indent}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{indent}}}{\emph{text}, \emph{amount}, \emph{car=' '}}{}
indent multi lines message

\end{fulllineitems}

\index{parse\_args() (src.options.Options method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.options.Options.parse_args}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parse\_args}}}{\emph{argList=None}}{}
Instantiates the class OptResult 
that gives access to all options in the code
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{argList}} \textendash{} (list) the raw list of arguments that were passed

\item[{Returns}] \leavevmode
(OptResult, list) as (optResult, args) 
optResult is the option instance to manipulate in the code. 
args is the full raw list of passed options

\end{description}\end{quote}

\end{fulllineitems}


\end{fulllineitems}



\subsubsection{src.printcolors module}
\label{\detokenize{commands/apidoc/src:module-src.printcolors}}\label{\detokenize{commands/apidoc/src:src-printcolors-module}}\index{src.printcolors (module)}
In this file is stored the mechanism that manage color prints in the terminal
\index{cleancolor() (in module src.printcolors)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.cleancolor}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{cleancolor}}}{\emph{message}}{}
remove color from a colored text.
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{message}}) \textendash{} The text to be cleaned.

\item[{Returns}] \leavevmode
The cleaned text.

\item[{Return type}] \leavevmode
str

\end{description}\end{quote}

\end{fulllineitems}

\index{print\_color\_map() (in module src.printcolors)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.print_color_map}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{print\_color\_map}}}{}{}
This method prints the color map

\end{fulllineitems}

\index{print\_color\_range() (in module src.printcolors)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.print_color_range}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{print\_color\_range}}}{\emph{start}, \emph{end}}{}
print possible range values for colors
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{int}} (\sphinxstyleliteralemphasis{\sphinxupquote{end}}) \textendash{} The smaller value.

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{int}} \textendash{} The bigger value.

\end{itemize}

\end{description}\end{quote}

\end{fulllineitems}

\index{print\_value() (in module src.printcolors)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.print_value}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{print\_value}}}{\emph{logger}, \emph{label}, \emph{value}, \emph{level=1}, \emph{suffix=''}}{}
shortcut method to print a label and a value with the info color
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{class logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} the logger instance.

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{int}} (\sphinxstyleliteralemphasis{\sphinxupquote{level}}) \textendash{} the label to print.

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{suffix}}) \textendash{} the value to print.

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{int}} \textendash{} the level of verboseness.

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the suffix to add at the end.

\end{itemize}

\end{description}\end{quote}

\end{fulllineitems}

\index{printc() (in module src.printcolors)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.printc}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{printc}}}{\emph{txt}, \emph{code=''}}{}
print a text with colors
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{code}}) \textendash{} The text to be printed.

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The color to use.

\end{itemize}

\item[{Returns}] \leavevmode
The colored text.

\item[{Return type}] \leavevmode
str

\end{description}\end{quote}

\end{fulllineitems}

\index{printcError() (in module src.printcolors)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.printcError}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{printcError}}}{\emph{txt}}{}
print a text error color
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{txt}}) \textendash{} The text to be printed.

\item[{Returns}] \leavevmode
The colored text.

\item[{Return type}] \leavevmode
str

\end{description}\end{quote}

\end{fulllineitems}

\index{printcHeader() (in module src.printcolors)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.printcHeader}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{printcHeader}}}{\emph{txt}}{}
print a text header color
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{txt}}) \textendash{} The text to be printed.

\item[{Returns}] \leavevmode
The colored text.

\item[{Return type}] \leavevmode
str

\end{description}\end{quote}

\end{fulllineitems}

\index{printcHighlight() (in module src.printcolors)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.printcHighlight}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{printcHighlight}}}{\emph{txt}}{}
print a text highlight color
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{txt}}) \textendash{} The text to be printed.

\item[{Returns}] \leavevmode
The colored text.

\item[{Return type}] \leavevmode
str

\end{description}\end{quote}

\end{fulllineitems}

\index{printcInfo() (in module src.printcolors)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.printcInfo}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{printcInfo}}}{\emph{txt}}{}
print a text info color
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{txt}}) \textendash{} The text to be printed.

\item[{Returns}] \leavevmode
The colored text.

\item[{Return type}] \leavevmode
str

\end{description}\end{quote}

\end{fulllineitems}

\index{printcLabel() (in module src.printcolors)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.printcLabel}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{printcLabel}}}{\emph{txt}}{}
print a text label color
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{txt}}) \textendash{} The text to be printed.

\item[{Returns}] \leavevmode
The colored text.

\item[{Return type}] \leavevmode
str

\end{description}\end{quote}

\end{fulllineitems}

\index{printcSuccess() (in module src.printcolors)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.printcSuccess}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{printcSuccess}}}{\emph{txt}}{}
print a text success color
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{txt}}) \textendash{} The text to be printed.

\item[{Returns}] \leavevmode
The colored text.

\item[{Return type}] \leavevmode
str

\end{description}\end{quote}

\end{fulllineitems}

\index{printcWarning() (in module src.printcolors)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.printcWarning}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{printcWarning}}}{\emph{txt}}{}
print a text warning color
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{txt}}) \textendash{} The text to be printed.

\item[{Returns}] \leavevmode
The colored text.

\item[{Return type}] \leavevmode
str

\end{description}\end{quote}

\end{fulllineitems}



\subsubsection{src.product module}
\label{\detokenize{commands/apidoc/src:module-src.product}}\label{\detokenize{commands/apidoc/src:src-product-module}}\index{src.product (module)}
In this file are implemented the methods 
relative to the product notion of salomeTools
\index{check\_config\_exists() (in module src.product)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.product.check_config_exists}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{check\_config\_exists}}}{\emph{config}, \emph{prod\_dir}, \emph{prod\_info}}{}
Verify that the installation directory of a product in a base exists
Check all the config-\textless{}i\textgreater{} directory and verify the sat-config.pyconf file
that is in it
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The global configuration

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{prod\_dir}}) \textendash{} The product installation directory path 
(without config-\textless{}i\textgreater{})

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{Config}} \textendash{} The configuration specific to 
the product

\end{itemize}

\item[{Returns}] \leavevmode
True or false is the installation is found or not 
and if it is found, the path of the found installation

\item[{Return type}] \leavevmode
(boolean, str)

\end{description}\end{quote}

\end{fulllineitems}

\index{check\_installation() (in module src.product)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.product.check_installation}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{check\_installation}}}{\emph{product\_info}}{}
Verify if a product is well installed. Checks install directory presence
and some additional files if it is defined in the config
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to 
the product

\item[{Returns}] \leavevmode
True if it is well installed

\item[{Return type}] \leavevmode
boolean

\end{description}\end{quote}

\end{fulllineitems}

\index{check\_source() (in module src.product)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.product.check_source}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{check\_source}}}{\emph{product\_info}}{}
Verify if a sources of product is preset. Checks source directory presence
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to 
the product

\item[{Returns}] \leavevmode
True if it is well installed

\item[{Return type}] \leavevmode
boolean

\end{description}\end{quote}

\end{fulllineitems}

\index{get\_base\_install\_dir() (in module src.product)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.product.get_base_install_dir}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{get\_base\_install\_dir}}}{\emph{config}, \emph{prod\_info}, \emph{version}}{}
Compute the installation directory of a product in base
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The global configuration

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{Config}} \textendash{} The configuration specific to 
the product

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{version}}) \textendash{} The version of the product

\end{itemize}

\item[{Returns}] \leavevmode
The path of the product installation

\item[{Return type}] \leavevmode
str

\end{description}\end{quote}

\end{fulllineitems}

\index{get\_install\_dir() (in module src.product)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.product.get_install_dir}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{get\_install\_dir}}}{\emph{config}, \emph{base}, \emph{version}, \emph{prod\_info}}{}
Compute the installation directory of a given product
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The global configuration

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{version}}) \textendash{} This corresponds to the value given by user in its 
application.pyconf for the specific product. If “yes”, the
user wants the product to be in base. If “no”, he wants the
product to be in the application workdir

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The version of the product

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{Config}} \textendash{} The configuration specific to 
the product

\end{itemize}

\item[{Returns}] \leavevmode
The path of the product installation

\item[{Return type}] \leavevmode
str

\end{description}\end{quote}

\end{fulllineitems}

\index{get\_product\_components() (in module src.product)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.product.get_product_components}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{get\_product\_components}}}{\emph{product\_info}}{}
Get the component list to generate with the product
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to 
the product

\item[{Returns}] \leavevmode
The list of names of the components

\item[{Return type}] \leavevmode
List

\end{description}\end{quote}

\end{fulllineitems}

\index{get\_product\_config() (in module src.product)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.product.get_product_config}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{get\_product\_config}}}{\emph{config}, \emph{product\_name}, \emph{with\_install\_dir=True}}{}
Get the specific configuration of a product from the global configuration
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} The global configuration

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_name}}) \textendash{} The name of the product

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{boolean}} (\sphinxstyleliteralemphasis{\sphinxupquote{with\_install\_dir}}) \textendash{} If false, do not provide an install 
directory (at false only for internal use 
of the function check\_config\_exists)

\end{itemize}

\item[{Returns}] \leavevmode
the specific configuration of the product

\item[{Return type}] \leavevmode
{\hyperref[\detokenize{commands/apidoc/src:src.pyconf.Config}]{\sphinxcrossref{Config}}} (\autopageref*{\detokenize{commands/apidoc/src:src.pyconf.Config}})

\end{description}\end{quote}

\end{fulllineitems}

\index{get\_product\_dependencies() (in module src.product)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.product.get_product_dependencies}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{get\_product\_dependencies}}}{\emph{config}, \emph{product\_info}}{}
Get recursively the list of products that are 
in the product\_info dependencies
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The global configuration

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{Config}} \textendash{} The configuration specific to 
the product

\end{itemize}

\item[{Returns}] \leavevmode
the list of products in dependence

\item[{Return type}] \leavevmode
list

\end{description}\end{quote}

\end{fulllineitems}

\index{get\_product\_section() (in module src.product)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.product.get_product_section}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{get\_product\_section}}}{\emph{config}, \emph{product\_name}, \emph{version}, \emph{section=None}}{}
Get the product description from the configuration
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} The global configuration

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{section}}) \textendash{} The product name

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The version of the product

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The searched section (if not None, the section is 
explicitly given

\end{itemize}

\item[{Returns}] \leavevmode
The product description

\item[{Return type}] \leavevmode
{\hyperref[\detokenize{commands/apidoc/src:src.pyconf.Config}]{\sphinxcrossref{Config}}} (\autopageref*{\detokenize{commands/apidoc/src:src.pyconf.Config}})

\end{description}\end{quote}

\end{fulllineitems}

\index{get\_products\_infos() (in module src.product)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.product.get_products_infos}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{get\_products\_infos}}}{\emph{lproducts}, \emph{config}}{}
Get the specific configuration of a list of products
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{List}} (\sphinxstyleliteralemphasis{\sphinxupquote{lproducts}}) \textendash{} The list of product names

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} The global configuration

\end{itemize}

\item[{Returns}] \leavevmode
the list of tuples 
(product name, specific configuration of the product)

\item[{Return type}] \leavevmode
{[}(str, {\hyperref[\detokenize{commands/apidoc/src:src.pyconf.Config}]{\sphinxcrossref{Config}}} (\autopageref*{\detokenize{commands/apidoc/src:src.pyconf.Config}})){]}

\end{description}\end{quote}

\end{fulllineitems}

\index{product\_compiles() (in module src.product)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_compiles}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_compiles}}}{\emph{product\_info}}{}
Know if a product compiles or not 
(some products do not have a compilation procedure)
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to 
the product

\item[{Returns}] \leavevmode
True if the product compiles, else False

\item[{Return type}] \leavevmode
boolean

\end{description}\end{quote}

\end{fulllineitems}

\index{product\_has\_env\_script() (in module src.product)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_has_env_script}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_has\_env\_script}}}{\emph{product\_info}}{}
Know if a product has an environment script
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to 
the product

\item[{Returns}] \leavevmode
True if the product it has an environment script, else False

\item[{Return type}] \leavevmode
boolean

\end{description}\end{quote}

\end{fulllineitems}

\index{product\_has\_logo() (in module src.product)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_has_logo}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_has\_logo}}}{\emph{product\_info}}{}
Know if a product has a logo (YACSGEN generate)
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to 
the product

\item[{Returns}] \leavevmode
The path of the logo if the product has a logo, else False

\item[{Return type}] \leavevmode
Str

\end{description}\end{quote}

\end{fulllineitems}

\index{product\_has\_patches() (in module src.product)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_has_patches}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_has\_patches}}}{\emph{product\_info}}{}
Know if a product has one or more patches
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to 
the product

\item[{Returns}] \leavevmode
True if the product has one or more patches

\item[{Return type}] \leavevmode
boolean

\end{description}\end{quote}

\end{fulllineitems}

\index{product\_has\_salome\_gui() (in module src.product)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_has_salome_gui}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_has\_salome\_gui}}}{\emph{product\_info}}{}
Know if a product has a SALOME gui
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to 
the product

\item[{Returns}] \leavevmode
True if the product has a SALOME gui, else False

\item[{Return type}] \leavevmode
Boolean

\end{description}\end{quote}

\end{fulllineitems}

\index{product\_has\_script() (in module src.product)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_has_script}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_has\_script}}}{\emph{product\_info}}{}
Know if a product has a compilation script
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to 
the product

\item[{Returns}] \leavevmode
True if the product it has a compilation script, else False

\item[{Return type}] \leavevmode
boolean

\end{description}\end{quote}

\end{fulllineitems}

\index{product\_is\_autotools() (in module src.product)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_autotools}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_autotools}}}{\emph{product\_info}}{}
Know if a product is compiled using the autotools
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to 
the product

\item[{Returns}] \leavevmode
True if the product is autotools, else False

\item[{Return type}] \leavevmode
boolean

\end{description}\end{quote}

\end{fulllineitems}

\index{product\_is\_cmake() (in module src.product)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_cmake}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_cmake}}}{\emph{product\_info}}{}
Know if a product is compiled using the cmake
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to 
the product

\item[{Returns}] \leavevmode
True if the product is cmake, else False

\item[{Return type}] \leavevmode
boolean

\end{description}\end{quote}

\end{fulllineitems}

\index{product\_is\_cpp() (in module src.product)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_cpp}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_cpp}}}{\emph{product\_info}}{}
Know if a product is cpp
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to 
the product

\item[{Returns}] \leavevmode
True if the product is a cpp, else False

\item[{Return type}] \leavevmode
boolean

\end{description}\end{quote}

\end{fulllineitems}

\index{product\_is\_debug() (in module src.product)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_debug}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_debug}}}{\emph{product\_info}}{}
Know if a product is in debug mode
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to 
the product

\item[{Returns}] \leavevmode
True if the product is in debug mode, else False

\item[{Return type}] \leavevmode
boolean

\end{description}\end{quote}

\end{fulllineitems}

\index{product\_is\_dev() (in module src.product)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_dev}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_dev}}}{\emph{product\_info}}{}
Know if a product is in dev mode
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to 
the product

\item[{Returns}] \leavevmode
True if the product is in dev mode, else False

\item[{Return type}] \leavevmode
boolean

\end{description}\end{quote}

\end{fulllineitems}

\index{product\_is\_fixed() (in module src.product)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_fixed}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_fixed}}}{\emph{product\_info}}{}
Know if a product is fixed
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to 
the product

\item[{Returns}] \leavevmode
True if the product is fixed, else False

\item[{Return type}] \leavevmode
boolean

\end{description}\end{quote}

\end{fulllineitems}

\index{product\_is\_generated() (in module src.product)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_generated}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_generated}}}{\emph{product\_info}}{}
Know if a product is generated (YACSGEN)
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to 
the product

\item[{Returns}] \leavevmode
True if the product is generated

\item[{Return type}] \leavevmode
boolean

\end{description}\end{quote}

\end{fulllineitems}

\index{product\_is\_mpi() (in module src.product)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_mpi}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_mpi}}}{\emph{product\_info}}{}
Know if a product has openmpi in its dependencies
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to 
the product

\item[{Returns}] \leavevmode
True if the product has openmpi inits dependencies

\item[{Return type}] \leavevmode
boolean

\end{description}\end{quote}

\end{fulllineitems}

\index{product\_is\_native() (in module src.product)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_native}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_native}}}{\emph{product\_info}}{}
Know if a product is native
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to 
the product

\item[{Returns}] \leavevmode
True if the product is native, else False

\item[{Return type}] \leavevmode
boolean

\end{description}\end{quote}

\end{fulllineitems}

\index{product\_is\_salome() (in module src.product)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_salome}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_salome}}}{\emph{product\_info}}{}
Know if a product is a SALOME module
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to 
the product

\item[{Returns}] \leavevmode
True if the product is a SALOME module, else False

\item[{Return type}] \leavevmode
boolean

\end{description}\end{quote}

\end{fulllineitems}

\index{product\_is\_smesh\_plugin() (in module src.product)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_smesh_plugin}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_smesh\_plugin}}}{\emph{product\_info}}{}
Know if a product is a SMESH plugin
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to 
the product

\item[{Returns}] \leavevmode
True if the product is a SMESH plugin, else False

\item[{Return type}] \leavevmode
boolean

\end{description}\end{quote}

\end{fulllineitems}

\index{product\_is\_vcs() (in module src.product)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_vcs}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_vcs}}}{\emph{product\_info}}{}
Know if a product is download using git, svn or cvs (not archive)
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to 
the product

\item[{Returns}] \leavevmode
True if the product is vcs, else False

\item[{Return type}] \leavevmode
boolean

\end{description}\end{quote}

\end{fulllineitems}

\index{product\_is\_verbose() (in module src.product)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_verbose}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_verbose}}}{\emph{product\_info}}{}
Know if a product is in verbose mode
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to 
the product

\item[{Returns}] \leavevmode
True if the product is in verbose mode, else False

\item[{Return type}] \leavevmode
boolean

\end{description}\end{quote}

\end{fulllineitems}



\subsubsection{src.pyconf module}
\label{\detokenize{commands/apidoc/src:src-pyconf-module}}\label{\detokenize{commands/apidoc/src:module-src.pyconf}}\index{src.pyconf (module)}
This is a configuration module for Python.

This module should work under Python versions \textgreater{}= 2.2, and cannot be used with
earlier versions since it uses new-style classes.

Development and testing has only been carried out (so far) on Python 2.3.4 and
Python 2.4.2. See the test module (test\_config.py) included in the
U\{distribution\textless{}\sphinxurl{http://www.red-dove.com/python\_config}.html\textbar{}\_blank\textgreater{}\} (follow the
download link).

A simple example - with the example configuration file:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
messages:
[
  \PYGZob{}
    stream : {}`sys.stderr{}`
    message: \PYGZsq{}Welcome\PYGZsq{}
    name: \PYGZsq{}Harry\PYGZsq{}
  \PYGZcb{}
  \PYGZob{}
    stream : {}`sys.stdout{}`
    message: \PYGZsq{}Welkom\PYGZsq{}
    name: \PYGZsq{}Ruud\PYGZsq{}
  \PYGZcb{}
  \PYGZob{}
    stream : \PYGZdl{}messages[0].stream
    message: \PYGZsq{}Bienvenue\PYGZsq{}
    name: Yves
  \PYGZcb{}
]
\end{sphinxVerbatim}

a program to read the configuration would be:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{k+kn}{from} \PYG{n+nn}{config} \PYG{k}{import} \PYG{n}{Config}

\PYG{n}{f} \PYG{o}{=} \PYG{n}{file}\PYG{p}{(}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{simple.cfg}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{)}
\PYG{n}{cfg} \PYG{o}{=} \PYG{n}{Config}\PYG{p}{(}\PYG{n}{f}\PYG{p}{)}
\PYG{k}{for} \PYG{n}{m} \PYG{o+ow}{in} \PYG{n}{cfg}\PYG{o}{.}\PYG{n}{messages}\PYG{p}{:}
    \PYG{n}{s} \PYG{o}{=} \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+si}{\PYGZpc{}s}\PYG{l+s+s1}{, }\PYG{l+s+si}{\PYGZpc{}s}\PYG{l+s+s1}{\PYGZsq{}} \PYG{o}{\PYGZpc{}} \PYG{p}{(}\PYG{n}{m}\PYG{o}{.}\PYG{n}{message}\PYG{p}{,} \PYG{n}{m}\PYG{o}{.}\PYG{n}{name}\PYG{p}{)}
    \PYG{k}{try}\PYG{p}{:}
        \PYG{n+nb}{print} \PYG{o}{\PYGZgt{}\PYGZgt{}} \PYG{n}{m}\PYG{o}{.}\PYG{n}{stream}\PYG{p}{,} \PYG{n}{s}
    \PYG{k}{except} \PYG{n+ne}{IOError}\PYG{p}{,} \PYG{n}{e}\PYG{p}{:}
        \PYG{n+nb}{print} \PYG{n}{e}
\end{sphinxVerbatim}

which, when run, would yield the console output:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{Welcome}\PYG{p}{,} \PYG{n}{Harry}
\PYG{n}{Welkom}\PYG{p}{,} \PYG{n}{Ruud}
\PYG{n}{Bienvenue}\PYG{p}{,} \PYG{n}{Yves}
\end{sphinxVerbatim}

See U\{this tutorial\textless{}\sphinxurl{http://www.red-dove.com/python\_config}.html\textbar{}\_blank\textgreater{}\} for more
information.

\#modified for salomeTools
@version: 0.3.7.1

@author: Vinay Sajip

@copyright: Copyright (C) 2004-2007 Vinay Sajip. All Rights Reserved.

@var streamOpener: The default stream opener. This is a factory function which
takes a string (e.g. filename) and returns a stream suitable for reading. If
unable to open the stream, an IOError exception should be thrown.

The default value of this variable is L\{defaultStreamOpener\}. For an example
of how it’s used, see test\_config.py (search for streamOpener).
\index{Config (class in src.pyconf)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Config}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{Config}}}{\emph{streamOrFile=None}, \emph{parent=None}, \emph{PWD=None}}{}
Bases: {\hyperref[\detokenize{commands/apidoc/src:src.pyconf.Mapping}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.pyconf.Mapping}}}}} (\autopageref*{\detokenize{commands/apidoc/src:src.pyconf.Mapping}})

This class represents a configuration, and is the only one which clients
need to interface to, under normal circumstances.
\index{Config.Namespace (class in src.pyconf)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Config.Namespace}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxbfcode{\sphinxupquote{Namespace}}}
Bases: \sphinxcode{\sphinxupquote{object}}

This internal class is used for implementing default namespaces.

An instance acts as a namespace.

\end{fulllineitems}

\index{addNamespace() (src.pyconf.Config method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Config.addNamespace}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{addNamespace}}}{\emph{ns}, \emph{name=None}}{}
Add a namespace to this configuration which can be used to evaluate
(resolve) dotted-identifier expressions.
@param ns: The namespace to be added.
@type ns: A module or other namespace suitable for passing as an
argument to vars().
@param name: A name for the namespace, which, if specified, provides
an additional level of indirection.
@type name: str

\end{fulllineitems}

\index{getByPath() (src.pyconf.Config method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Config.getByPath}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getByPath}}}{\emph{path}}{}
Obtain a value in the configuration via its path.
@param path: The path of the required value
@type path: str
@return the value at the specified path.
@rtype: any
@raise ConfigError: If the path is invalid

\end{fulllineitems}

\index{load() (src.pyconf.Config method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Config.load}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{load}}}{\emph{stream}}{}
Load the configuration from the specified stream. Multiple streams can
be used to populate the same instance, as long as there are no
clashing keys. The stream is closed.
@param stream: A stream from which the configuration is read.
@type stream: A read-only stream (file-like object).
@raise ConfigError: if keys in the loaded configuration clash with
existing keys.
@raise ConfigFormatError: if there is a syntax error in the stream.

\end{fulllineitems}

\index{removeNamespace() (src.pyconf.Config method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Config.removeNamespace}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{removeNamespace}}}{\emph{ns}, \emph{name=None}}{}
Remove a namespace added with L\{addNamespace\}.
@param ns: The namespace to be removed.
@param name: The name which was specified when L\{addNamespace\} was
called.
@type name: str

\end{fulllineitems}


\end{fulllineitems}

\index{ConfigError}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigError}}\pysigline{\sphinxbfcode{\sphinxupquote{exception }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{ConfigError}}}
Bases: \sphinxcode{\sphinxupquote{exceptions.Exception}}

This is the base class of exceptions raised by this module.

\end{fulllineitems}

\index{ConfigFormatError}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigFormatError}}\pysigline{\sphinxbfcode{\sphinxupquote{exception }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{ConfigFormatError}}}
Bases: {\hyperref[\detokenize{commands/apidoc/src:src.pyconf.ConfigError}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.pyconf.ConfigError}}}}} (\autopageref*{\detokenize{commands/apidoc/src:src.pyconf.ConfigError}})

This is the base class of exceptions raised due to syntax errors in
configurations.

\end{fulllineitems}

\index{ConfigInputStream (class in src.pyconf)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigInputStream}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{ConfigInputStream}}}{\emph{stream}}{}
Bases: \sphinxcode{\sphinxupquote{object}}

An input stream which can read either ANSI files with default encoding
or Unicode files with BOMs.

Handles UTF-8, UTF-16LE, UTF-16BE. Could handle UTF-32 if Python had
built-in support.
\index{close() (src.pyconf.ConfigInputStream method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigInputStream.close}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{close}}}{}{}
\end{fulllineitems}

\index{read() (src.pyconf.ConfigInputStream method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigInputStream.read}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{read}}}{\emph{size}}{}
\end{fulllineitems}

\index{readline() (src.pyconf.ConfigInputStream method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigInputStream.readline}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{readline}}}{}{}
\end{fulllineitems}


\end{fulllineitems}

\index{ConfigList (class in src.pyconf)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigList}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{ConfigList}}}
Bases: \sphinxcode{\sphinxupquote{list}}

This class implements an ordered list of configurations and allows you
to try getting the configuration from each entry in turn, returning
the first successfully obtained value.
\index{getByPath() (src.pyconf.ConfigList method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigList.getByPath}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getByPath}}}{\emph{path}}{}
Obtain a value from the first configuration in the list which defines
it.

@param path: The path of the value to retrieve.
@type path: str
@return: The value from the earliest configuration in the list which
defines it.
@rtype: any
@raise ConfigError: If no configuration in the list has an entry with
the specified path.

\end{fulllineitems}


\end{fulllineitems}

\index{ConfigMerger (class in src.pyconf)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigMerger}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{ConfigMerger}}}{\emph{resolver=\textless{}function defaultMergeResolve\textgreater{}}}{}
Bases: \sphinxcode{\sphinxupquote{object}}

This class is used for merging two configurations. If a key exists in the
merge operand but not the merge target, then the entry is copied from the
merge operand to the merge target. If a key exists in both configurations,
then a resolver (a callable) is called to decide how to handle the
conflict.
\index{handleMismatch() (src.pyconf.ConfigMerger method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigMerger.handleMismatch}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{handleMismatch}}}{\emph{obj1}, \emph{obj2}}{}
Handle a mismatch between two objects.

@param obj1: The object to merge into.
@type obj1: any
@param obj2: The object to merge.
@type obj2: any

\end{fulllineitems}

\index{merge() (src.pyconf.ConfigMerger method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigMerger.merge}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{merge}}}{\emph{merged}, \emph{mergee}}{}
Merge two configurations. The second configuration is unchanged,
and the first is changed to reflect the results of the merge.

@param merged: The configuration to merge into.
@type merged: L\{Config\}.
@param mergee: The configuration to merge.
@type mergee: L\{Config\}.

\end{fulllineitems}

\index{mergeMapping() (src.pyconf.ConfigMerger method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigMerger.mergeMapping}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{mergeMapping}}}{\emph{map1}, \emph{map2}}{}
Merge two mappings recursively. The second mapping is unchanged,
and the first is changed to reflect the results of the merge.

@param map1: The mapping to merge into.
@type map1: L\{Mapping\}.
@param map2: The mapping to merge.
@type map2: L\{Mapping\}.

\end{fulllineitems}

\index{mergeSequence() (src.pyconf.ConfigMerger method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigMerger.mergeSequence}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{mergeSequence}}}{\emph{seq1}, \emph{seq2}}{}
Merge two sequences. The second sequence is unchanged,
and the first is changed to have the elements of the second
appended to it.

@param seq1: The sequence to merge into.
@type seq1: L\{Sequence\}.
@param seq2: The sequence to merge.
@type seq2: L\{Sequence\}.

\end{fulllineitems}

\index{overwriteKeys() (src.pyconf.ConfigMerger method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigMerger.overwriteKeys}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{overwriteKeys}}}{\emph{map1}, \emph{seq2}}{}
Renint variables. The second mapping is unchanged,
and the first is changed depending the keys of the second mapping.
@param map1: The mapping to reinit keys into.
@type map1: L\{Mapping\}.
@param map2: The mapping container reinit information.
@type map2: L\{Mapping\}.

\end{fulllineitems}


\end{fulllineitems}

\index{ConfigOutputStream (class in src.pyconf)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigOutputStream}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{ConfigOutputStream}}}{\emph{stream}, \emph{encoding=None}}{}
Bases: \sphinxcode{\sphinxupquote{object}}

An output stream which can write either ANSI files with default encoding
or Unicode files with BOMs.

Handles UTF-8, UTF-16LE, UTF-16BE. Could handle UTF-32 if Python had
built-in support.
\index{close() (src.pyconf.ConfigOutputStream method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigOutputStream.close}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{close}}}{}{}
\end{fulllineitems}

\index{flush() (src.pyconf.ConfigOutputStream method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigOutputStream.flush}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{flush}}}{}{}
\end{fulllineitems}

\index{write() (src.pyconf.ConfigOutputStream method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigOutputStream.write}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write}}}{\emph{data}}{}
\end{fulllineitems}


\end{fulllineitems}

\index{ConfigReader (class in src.pyconf)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{ConfigReader}}}{\emph{config}}{}
Bases: \sphinxcode{\sphinxupquote{object}}

This internal class implements a parser for configurations.
\index{getChar() (src.pyconf.ConfigReader method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.getChar}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getChar}}}{}{}
Get the next char from the stream. Update line and column numbers
appropriately.

@return: The next character from the stream.
@rtype: str

\end{fulllineitems}

\index{getToken() (src.pyconf.ConfigReader method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.getToken}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getToken}}}{}{}
Get a token from the stream. String values are returned in a form
where you need to eval() the returned value to get the actual
string. The return value is (token\_type, token\_value).

Multiline string tokenizing is thanks to David Janes (BlogMatrix)

@return: The next token.
@rtype: A token tuple.

\end{fulllineitems}

\index{load() (src.pyconf.ConfigReader method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.load}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{load}}}{\emph{stream}, \emph{parent=None}, \emph{suffix=None}}{}
Load the configuration from the specified stream.

@param stream: A stream from which to load the configuration.
@type stream: A stream (file-like object).
@param parent: The parent of the configuration (to which this reader
belongs) in the hierarchy. Specified when the configuration is
included in another one.
@type parent: A L\{Container\} instance.
@param suffix: The suffix of this configuration in the parent
configuration. Should be specified whenever the parent is not None.
@raise ConfigError: If parent is specified but suffix is not.
@raise ConfigFormatError: If there are syntax errors in the stream.

\end{fulllineitems}

\index{location() (src.pyconf.ConfigReader method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.location}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{location}}}{}{}
Return the current location (filename, line, column) in the stream
as a string.

Used when printing error messages,

@return: A string representing a location in the stream being read.
@rtype: str

\end{fulllineitems}

\index{match() (src.pyconf.ConfigReader method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.match}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{match}}}{\emph{t}}{}
Ensure that the current token type matches the specified value, and
advance to the next token.

@param t: The token type to match.
@type t: A valid token type.
@return: The token which was last read from the stream before this
function is called.
@rtype: a token tuple - see L\{getToken\}.
@raise ConfigFormatError: If the token does not match what’s expected.

\end{fulllineitems}

\index{parseFactor() (src.pyconf.ConfigReader method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseFactor}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseFactor}}}{}{}
Parse a factor in an multiplicative expression (a * b, a / b, a \% b)

@return: the parsed factor
@rtype: any scalar
@raise ConfigFormatError: if a syntax error is found.

\end{fulllineitems}

\index{parseKeyValuePair() (src.pyconf.ConfigReader method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseKeyValuePair}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseKeyValuePair}}}{\emph{parent}}{}
Parse a key-value pair, and add it to the provided L\{Mapping\}.

@param parent: The mapping to add entries to.
@type parent: A L\{Mapping\} instance.
@raise ConfigFormatError: if a syntax error is found.

\end{fulllineitems}

\index{parseMapping() (src.pyconf.ConfigReader method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseMapping}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseMapping}}}{\emph{parent}, \emph{suffix}}{}
Parse a mapping.

@param parent: The container to which the mapping will be added.
@type parent: A L\{Container\} instance.
@param suffix: The suffix for the value.
@type suffix: str
@return: a L\{Mapping\} instance representing the mapping.
@rtype: L\{Mapping\}
@raise ConfigFormatError: if a syntax error is found.

\end{fulllineitems}

\index{parseMappingBody() (src.pyconf.ConfigReader method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseMappingBody}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseMappingBody}}}{\emph{parent}}{}
Parse the internals of a mapping, and add entries to the provided
L\{Mapping\}.

@param parent: The mapping to add entries to.
@type parent: A L\{Mapping\} instance.

\end{fulllineitems}

\index{parseReference() (src.pyconf.ConfigReader method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseReference}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseReference}}}{\emph{type}}{}
Parse a reference.

@return: the parsed reference
@rtype: L\{Reference\}
@raise ConfigFormatError: if a syntax error is found.

\end{fulllineitems}

\index{parseScalar() (src.pyconf.ConfigReader method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseScalar}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseScalar}}}{}{}
Parse a scalar - a terminal value such as a string or number, or
an L\{Expression\} or L\{Reference\}.

@return: the parsed scalar
@rtype: any scalar
@raise ConfigFormatError: if a syntax error is found.

\end{fulllineitems}

\index{parseSequence() (src.pyconf.ConfigReader method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseSequence}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseSequence}}}{\emph{parent}, \emph{suffix}}{}
Parse a sequence.

@param parent: The container to which the sequence will be added.
@type parent: A L\{Container\} instance.
@param suffix: The suffix for the value.
@type suffix: str
@return: a L\{Sequence\} instance representing the sequence.
@rtype: L\{Sequence\}
@raise ConfigFormatError: if a syntax error is found.

\end{fulllineitems}

\index{parseSuffix() (src.pyconf.ConfigReader method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseSuffix}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseSuffix}}}{\emph{ref}}{}
Parse a reference suffix.

@param ref: The reference of which this suffix is a part.
@type ref: L\{Reference\}.
@raise ConfigFormatError: if a syntax error is found.

\end{fulllineitems}

\index{parseTerm() (src.pyconf.ConfigReader method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseTerm}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseTerm}}}{}{}
Parse a term in an additive expression (a + b, a - b)

@return: the parsed term
@rtype: any scalar
@raise ConfigFormatError: if a syntax error is found.

\end{fulllineitems}

\index{parseValue() (src.pyconf.ConfigReader method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseValue}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseValue}}}{\emph{parent}, \emph{suffix}}{}
Parse a value.

@param parent: The container to which the value will be added.
@type parent: A L\{Container\} instance.
@param suffix: The suffix for the value.
@type suffix: str
@return: The value
@rtype: any
@raise ConfigFormatError: if a syntax error is found.

\end{fulllineitems}

\index{setStream() (src.pyconf.ConfigReader method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.setStream}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{setStream}}}{\emph{stream}}{}
Set the stream to the specified value, and prepare to read from it.

@param stream: A stream from which to load the configuration.
@type stream: A stream (file-like object).

\end{fulllineitems}


\end{fulllineitems}

\index{ConfigResolutionError}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigResolutionError}}\pysigline{\sphinxbfcode{\sphinxupquote{exception }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{ConfigResolutionError}}}
Bases: {\hyperref[\detokenize{commands/apidoc/src:src.pyconf.ConfigError}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.pyconf.ConfigError}}}}} (\autopageref*{\detokenize{commands/apidoc/src:src.pyconf.ConfigError}})

This is the base class of exceptions raised due to semantic errors in
configurations.

\end{fulllineitems}

\index{Container (class in src.pyconf)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Container}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{Container}}}{\emph{parent}}{}
Bases: \sphinxcode{\sphinxupquote{object}}

This internal class is the base class for mappings and sequences.

@ivar path: A string which describes how to get
to this instance from the root of the hierarchy.

Example:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{a}\PYG{o}{.}\PYG{n}{list}\PYG{o}{.}\PYG{n}{of}\PYG{p}{[}\PYG{l+m+mi}{1}\PYG{p}{]}\PYG{o}{.}\PYG{o+ow}{or}\PYG{p}{[}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{more}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{]}\PYG{o}{.}\PYG{n}{elements}
\end{sphinxVerbatim}
\index{evaluate() (src.pyconf.Container method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Container.evaluate}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{evaluate}}}{\emph{item}}{}
Evaluate items which are instances of L\{Reference\} or L\{Expression\}.

L\{Reference\} instances are evaluated using L\{Reference.resolve\},
and L\{Expression\} instances are evaluated using
L\{Expression.evaluate\}.

@param item: The item to be evaluated.
@type item: any
@return: If the item is an instance of L\{Reference\} or L\{Expression\},
the evaluated value is returned, otherwise the item is returned
unchanged.

\end{fulllineitems}

\index{setPath() (src.pyconf.Container method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Container.setPath}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{setPath}}}{\emph{path}}{}
Set the path for this instance.
@param path: The path - a string which describes how to get
to this instance from the root of the hierarchy.
@type path: str

\end{fulllineitems}

\index{writeToStream() (src.pyconf.Container method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Container.writeToStream}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{writeToStream}}}{\emph{stream}, \emph{indent}, \emph{container}}{}
Write this instance to a stream at the specified indentation level.

Should be redefined in subclasses.

@param stream: The stream to write to
@type stream: A writable stream (file-like object)
@param indent: The indentation level
@type indent: int
@param container: The container of this instance
@type container: L\{Container\}
@raise NotImplementedError: If a subclass does not override this

\end{fulllineitems}

\index{writeValue() (src.pyconf.Container method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Container.writeValue}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{writeValue}}}{\emph{value}, \emph{stream}, \emph{indent}}{}
\end{fulllineitems}


\end{fulllineitems}

\index{Expression (class in src.pyconf)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Expression}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{Expression}}}{\emph{op}, \emph{lhs}, \emph{rhs}}{}
Bases: \sphinxcode{\sphinxupquote{object}}

This internal class implements a value which is obtained by evaluating an expression.
\index{evaluate() (src.pyconf.Expression method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Expression.evaluate}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{evaluate}}}{\emph{container}}{}
Evaluate this instance in the context of a container.

@param container: The container to evaluate in from.
@type container: L\{Container\}
@return: The evaluated value.
@rtype: any
@raise ConfigResolutionError: If evaluation fails.
@raise ZeroDivideError: If division by zero occurs.
@raise TypeError: If the operation is invalid, e.g.
subtracting one string from another.

\end{fulllineitems}


\end{fulllineitems}

\index{Mapping (class in src.pyconf)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Mapping}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{Mapping}}}{\emph{parent=None}}{}
Bases: {\hyperref[\detokenize{commands/apidoc/src:src.pyconf.Container}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.pyconf.Container}}}}} (\autopageref*{\detokenize{commands/apidoc/src:src.pyconf.Container}})

This internal class implements key-value mappings in configurations.
\index{addMapping() (src.pyconf.Mapping method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Mapping.addMapping}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{addMapping}}}{\emph{key}, \emph{value}, \emph{comment}, \emph{setting=False}}{}
Add a key-value mapping with a comment.

@param key: The key for the mapping.
@type key: str
@param value: The value for the mapping.
@type value: any
@param comment: The comment for the key (can be None).
@type comment: str
@param setting: If True, ignore clashes. This is set
to true when called from L\{\_\_setattr\_\_\}.
@raise ConfigFormatError: If an existing key is seen
again and setting is False.

\end{fulllineitems}

\index{get() (src.pyconf.Mapping method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Mapping.get}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get}}}{\emph{key}, \emph{default=None}}{}
Allows a dictionary-style get operation.

\end{fulllineitems}

\index{iteritems() (src.pyconf.Mapping method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Mapping.iteritems}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{iteritems}}}{}{}
\end{fulllineitems}

\index{iterkeys() (src.pyconf.Mapping method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Mapping.iterkeys}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{iterkeys}}}{}{}
\end{fulllineitems}

\index{keys() (src.pyconf.Mapping method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Mapping.keys}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{keys}}}{}{}
Return the keys in a similar way to a dictionary.

\end{fulllineitems}

\index{writeToStream() (src.pyconf.Mapping method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Mapping.writeToStream}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{writeToStream}}}{\emph{stream}, \emph{indent}, \emph{container}}{}
Write this instance to a stream at the specified indentation level.

Should be redefined in subclasses.

@param stream: The stream to write to
@type stream: A writable stream (file-like object)
@param indent: The indentation level
@type indent: int
@param container: The container of this instance
@type container: L\{Container\}

\end{fulllineitems}


\end{fulllineitems}

\index{Reference (class in src.pyconf)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Reference}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{Reference}}}{\emph{config}, \emph{type}, \emph{ident}}{}
Bases: \sphinxcode{\sphinxupquote{object}}

This internal class implements a value which is a reference to another value.
\index{addElement() (src.pyconf.Reference method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Reference.addElement}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{addElement}}}{\emph{type}, \emph{ident}}{}
Add an element to the reference.

@param type: The type of reference.
@type type: BACKTICK or DOLLAR
@param ident: The identifier which continues the reference.
@type ident: str

\end{fulllineitems}

\index{findConfig() (src.pyconf.Reference method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Reference.findConfig}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{findConfig}}}{\emph{container}}{}
Find the closest enclosing configuration to the specified container.

@param container: The container to start from.
@type container: L\{Container\}
@return: The closest enclosing configuration, or None.
@rtype: L\{Config\}

\end{fulllineitems}

\index{resolve() (src.pyconf.Reference method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Reference.resolve}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{resolve}}}{\emph{container}}{}
Resolve this instance in the context of a container.

@param container: The container to resolve from.
@type container: L\{Container\}
@return: The resolved value.
@rtype: any
@raise ConfigResolutionError: If resolution fails.

\end{fulllineitems}


\end{fulllineitems}

\index{Sequence (class in src.pyconf)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Sequence}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{Sequence}}}{\emph{parent=None}}{}
Bases: {\hyperref[\detokenize{commands/apidoc/src:src.pyconf.Container}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.pyconf.Container}}}}} (\autopageref*{\detokenize{commands/apidoc/src:src.pyconf.Container}})

This internal class implements a value which is a sequence of other values.
\index{Sequence.SeqIter (class in src.pyconf)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Sequence.SeqIter}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxbfcode{\sphinxupquote{SeqIter}}}{\emph{seq}}{}
Bases: \sphinxcode{\sphinxupquote{object}}

This internal class implements an iterator for a L\{Sequence\} instance.
\index{next() (src.pyconf.Sequence.SeqIter method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Sequence.SeqIter.next}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{next}}}{}{}
\end{fulllineitems}


\end{fulllineitems}

\index{append() (src.pyconf.Sequence method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Sequence.append}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append}}}{\emph{item}, \emph{comment}}{}
Add an item to the sequence.

@param item: The item to add.
@type item: any
@param comment: A comment for the item.
@type comment: str

\end{fulllineitems}

\index{writeToStream() (src.pyconf.Sequence method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Sequence.writeToStream}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{writeToStream}}}{\emph{stream}, \emph{indent}, \emph{container}}{}
Write this instance to a stream at the specified indentation level.

Should be redefined in subclasses.

@param stream: The stream to write to
@type stream: A writable stream (file-like object)
@param indent: The indentation level
@type indent: int
@param container: The container of this instance
@type container: L\{Container\}

\end{fulllineitems}


\end{fulllineitems}

\index{deepCopyMapping() (in module src.pyconf)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.deepCopyMapping}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{deepCopyMapping}}}{\emph{inMapping}}{}
\end{fulllineitems}

\index{defaultMergeResolve() (in module src.pyconf)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.defaultMergeResolve}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{defaultMergeResolve}}}{\emph{map1}, \emph{map2}, \emph{key}}{}
A default resolver for merge conflicts. 
Returns a string indicating what action to take to resolve the conflict.

@param map1: The map being merged into.
@type map1: L\{Mapping\}.
@param map2: The map being used as the merge operand.
@type map2: L\{Mapping\}.
@param key: The key in map2 (which also exists in map1).
@type key: str
\begin{description}
\item[{@return: One of “merge”, “append”, “mismatch” or “overwrite”}] \leavevmode
indicating what action should be taken. This should
be appropriate to the objects being merged - e.g.
there is no point returning “merge” if the two objects
are instances of L\{Sequence\}.

\end{description}

@rtype: str

\end{fulllineitems}

\index{defaultStreamOpener() (in module src.pyconf)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.defaultStreamOpener}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{defaultStreamOpener}}}{\emph{name}}{}
This function returns a read-only stream, given its name. The name passed
in should correspond to an existing stream, otherwise an exception will be
raised.

This is the default value of L\{streamOpener\}; assign your own callable to
streamOpener to return streams based on names. For example, you could use
urllib2.urlopen().

@param name: The name of a stream, most commonly a file name.
@type name: str
@return: A stream with the specified name.
@rtype: A read-only stream (file-like object)

\end{fulllineitems}

\index{isWord() (in module src.pyconf)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.isWord}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{isWord}}}{\emph{s}}{}
See if a passed-in value is an identifier. If the value passed in is not a
string, False is returned. An identifier consists of alphanumerics or
underscore characters.

Examples:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{isWord}\PYG{p}{(}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{a word}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{)} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZgt{}}\PYG{k+kc}{False}
\PYG{n}{isWord}\PYG{p}{(}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{award}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{)} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZgt{}} \PYG{k+kc}{True}
\PYG{n}{isWord}\PYG{p}{(}\PYG{l+m+mi}{9}\PYG{p}{)} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZgt{}} \PYG{k+kc}{False}
\PYG{n}{isWord}\PYG{p}{(}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{a\PYGZus{}b\PYGZus{}c\PYGZus{}}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{)} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZgt{}}\PYG{k+kc}{True}
\end{sphinxVerbatim}

@note: isWord(‘9abc’) will return True - not exactly correct, but adequate
for the way it’s used here.

@param s: The name to be tested
@type s: any
@return: True if a word, else False
@rtype: bool

\end{fulllineitems}

\index{makePath() (in module src.pyconf)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.makePath}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{makePath}}}{\emph{prefix}, \emph{suffix}}{}
Make a path from a prefix and suffix.

Examples:
makePath(‘’, ‘suffix’) -\textgreater{} ‘suffix’
makePath(‘prefix’, ‘suffix’) -\textgreater{} ‘prefix.suffix’
makePath(‘prefix’, ‘{[}1{]}’) -\textgreater{} ‘prefix{[}1{]}’

@param prefix: The prefix to use. If it evaluates as false, the suffix is returned.
@type prefix: str
@param suffix: The suffix to use. It is either an identifier or an index in brackets.
@type suffix: str
@return: The path concatenation of prefix and suffix, with adot if the suffix is not a bracketed index.
@rtype: str

\end{fulllineitems}

\index{overwriteMergeResolve() (in module src.pyconf)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.overwriteMergeResolve}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{overwriteMergeResolve}}}{\emph{map1}, \emph{map2}, \emph{key}}{}
An overwriting resolver for merge conflicts. Calls L\{defaultMergeResolve\},
but where a “mismatch” is detected, returns “overwrite” instead.

@param map1: The map being merged into.
@type map1: L\{Mapping\}.
@param map2: The map being used as the merge operand.
@type map2: L\{Mapping\}.
@param key: The key in map2 (which also exists in map1).
@type key: str

\end{fulllineitems}



\subsubsection{src.system module}
\label{\detokenize{commands/apidoc/src:src-system-module}}\label{\detokenize{commands/apidoc/src:module-src.system}}\index{src.system (module)}
In this file : all functions that do a system call, 
like open a browser or an editor, or call a git command
\index{archive\_extract() (in module src.system)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.system.archive_extract}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.system.}}\sphinxbfcode{\sphinxupquote{archive\_extract}}}{\emph{from\_what}, \emph{where}, \emph{logger}}{}
Extracts sources from an archive.
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{where}}) \textendash{} The path to the archive.

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The path where to extract.

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to use.

\end{itemize}

\item[{Returns}] \leavevmode
True if the extraction is successful

\item[{Return type}] \leavevmode
boolean

\end{description}\end{quote}

\end{fulllineitems}

\index{cvs\_extract() (in module src.system)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.system.cvs_extract}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.system.}}\sphinxbfcode{\sphinxupquote{cvs\_extract}}}{\emph{protocol}, \emph{user}, \emph{server}, \emph{base}, \emph{tag}, \emph{product}, \emph{where}, \emph{logger}, \emph{checkout=False}, \emph{environment=None}}{}
Extracts sources from a cvs repository.
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{where}}) \textendash{} The cvs protocol.

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The user to be used.

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The remote cvs server.

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} 
.


\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The tag.

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The product.

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The path where to extract.

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to use.

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{boolean}} (\sphinxstyleliteralemphasis{\sphinxupquote{checkout}}) \textendash{} If true use checkout cvs.

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{src.environment.Environ}} (\sphinxstyleliteralemphasis{\sphinxupquote{environment}}) \textendash{} The environment to source when
extracting.

\end{itemize}

\item[{Returns}] \leavevmode
True if the extraction is successful

\item[{Return type}] \leavevmode
boolean

\end{description}\end{quote}

\end{fulllineitems}

\index{git\_extract() (in module src.system)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.system.git_extract}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.system.}}\sphinxbfcode{\sphinxupquote{git\_extract}}}{\emph{from\_what}, \emph{tag}, \emph{where}, \emph{logger}, \emph{environment=None}}{}
Extracts sources from a git repository.
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{where}}) \textendash{} The remote git repository.

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The tag.

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The path where to extract.

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to use.

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{src.environment.Environ}} (\sphinxstyleliteralemphasis{\sphinxupquote{environment}}) \textendash{} The environment to source when
extracting.

\end{itemize}

\item[{Returns}] \leavevmode
True if the extraction is successful

\item[{Return type}] \leavevmode
boolean

\end{description}\end{quote}

\end{fulllineitems}

\index{show\_in\_editor() (in module src.system)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.system.show_in_editor}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.system.}}\sphinxbfcode{\sphinxupquote{show\_in\_editor}}}{\emph{editor}, \emph{filePath}, \emph{logger}}{}
open filePath using editor.
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{filePath}}) \textendash{} The editor to use.

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The path to the file to open.

\end{itemize}

\end{description}\end{quote}

\end{fulllineitems}

\index{svn\_extract() (in module src.system)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.system.svn_extract}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.system.}}\sphinxbfcode{\sphinxupquote{svn\_extract}}}{\emph{user}, \emph{from\_what}, \emph{tag}, \emph{where}, \emph{logger}, \emph{checkout=False}, \emph{environment=None}}{}
Extracts sources from a svn repository.
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{where}}) \textendash{} The user to be used.

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The remote git repository.

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The tag.

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The path where to extract.

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to use.

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{boolean}} (\sphinxstyleliteralemphasis{\sphinxupquote{checkout}}) \textendash{} If true use checkout svn.

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{src.environment.Environ}} (\sphinxstyleliteralemphasis{\sphinxupquote{environment}}) \textendash{} The environment to source when
extracting.

\end{itemize}

\item[{Returns}] \leavevmode
True if the extraction is successful

\item[{Return type}] \leavevmode
boolean

\end{description}\end{quote}

\end{fulllineitems}



\subsubsection{src.template module}
\label{\detokenize{commands/apidoc/src:module-src.template}}\label{\detokenize{commands/apidoc/src:src-template-module}}\index{src.template (module)}\index{MyTemplate (class in src.template)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.template.MyTemplate}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.template.}}\sphinxbfcode{\sphinxupquote{MyTemplate}}}{\emph{template}}{}
Bases: \sphinxcode{\sphinxupquote{string.Template}}
\index{delimiter (src.template.MyTemplate attribute)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.template.MyTemplate.delimiter}}\pysigline{\sphinxbfcode{\sphinxupquote{delimiter}}\sphinxbfcode{\sphinxupquote{ = '\textbackslash{}xc2\textbackslash{}xa4'}}}
\end{fulllineitems}

\index{pattern (src.template.MyTemplate attribute)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.template.MyTemplate.pattern}}\pysigline{\sphinxbfcode{\sphinxupquote{pattern}}\sphinxbfcode{\sphinxupquote{ = \textless{}\_sre.SRE\_Pattern object\textgreater{}}}}
\end{fulllineitems}


\end{fulllineitems}

\index{substitute() (in module src.template)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.template.substitute}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.template.}}\sphinxbfcode{\sphinxupquote{substitute}}}{\emph{template\_file}, \emph{subst\_dic}}{}
\end{fulllineitems}



\subsubsection{src.test\_module module}
\label{\detokenize{commands/apidoc/src:module-src.test_module}}\label{\detokenize{commands/apidoc/src:src-test-module-module}}\index{src.test\_module (module)}\index{Test (class in src.test\_module)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.test\_module.}}\sphinxbfcode{\sphinxupquote{Test}}}{\emph{config}, \emph{logger}, \emph{tmp\_working\_dir}, \emph{testbase=''}, \emph{grids=None}, \emph{sessions=None}, \emph{launcher=''}, \emph{show\_desktop=True}}{}~\index{generate\_launching\_commands() (src.test\_module.Test method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.generate_launching_commands}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{generate\_launching\_commands}}}{}{}
\end{fulllineitems}

\index{generate\_script() (src.test\_module.Test method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.generate_script}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{generate\_script}}}{\emph{listTest}, \emph{script\_path}, \emph{ignoreList}}{}
\end{fulllineitems}

\index{get\_test\_timeout() (src.test\_module.Test method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.get_test_timeout}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_test\_timeout}}}{\emph{test\_name}, \emph{default\_value}}{}
\end{fulllineitems}

\index{get\_tmp\_dir() (src.test\_module.Test method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.get_tmp_dir}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_tmp\_dir}}}{}{}
\end{fulllineitems}

\index{prepare\_testbase() (src.test\_module.Test method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.prepare_testbase}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepare\_testbase}}}{\emph{test\_base\_name}}{}
\end{fulllineitems}

\index{prepare\_testbase\_from\_dir() (src.test\_module.Test method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.prepare_testbase_from_dir}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepare\_testbase\_from\_dir}}}{\emph{testbase\_name}, \emph{testbase\_dir}}{}
\end{fulllineitems}

\index{prepare\_testbase\_from\_git() (src.test\_module.Test method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.prepare_testbase_from_git}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepare\_testbase\_from\_git}}}{\emph{testbase\_name}, \emph{testbase\_base}, \emph{testbase\_tag}}{}
\end{fulllineitems}

\index{prepare\_testbase\_from\_svn() (src.test\_module.Test method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.prepare_testbase_from_svn}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepare\_testbase\_from\_svn}}}{\emph{user}, \emph{testbase\_name}, \emph{testbase\_base}}{}
\end{fulllineitems}

\index{read\_results() (src.test\_module.Test method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.read_results}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{read\_results}}}{\emph{listTest}, \emph{has\_timed\_out}}{}
\end{fulllineitems}

\index{run\_all\_tests() (src.test\_module.Test method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.run_all_tests}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run\_all\_tests}}}{}{}
\end{fulllineitems}

\index{run\_grid\_tests() (src.test\_module.Test method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.run_grid_tests}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run\_grid\_tests}}}{}{}
\end{fulllineitems}

\index{run\_script() (src.test\_module.Test method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.run_script}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run\_script}}}{\emph{script\_name}}{}
\end{fulllineitems}

\index{run\_session\_tests() (src.test\_module.Test method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.run_session_tests}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run\_session\_tests}}}{}{}
\end{fulllineitems}

\index{run\_testbase\_tests() (src.test\_module.Test method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.run_testbase_tests}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run\_testbase\_tests}}}{}{}
\end{fulllineitems}

\index{run\_tests() (src.test\_module.Test method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.run_tests}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run\_tests}}}{\emph{listTest}, \emph{ignoreList}}{}
\end{fulllineitems}

\index{search\_known\_errors() (src.test\_module.Test method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.search_known_errors}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{search\_known\_errors}}}{\emph{status}, \emph{test\_grid}, \emph{test\_session}, \emph{test}}{}
\end{fulllineitems}

\index{write\_test\_margin() (src.test\_module.Test method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.write_test_margin}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write\_test\_margin}}}{\emph{tab}}{}
\end{fulllineitems}


\end{fulllineitems}

\index{getTmpDirDEFAULT() (in module src.test\_module)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.getTmpDirDEFAULT}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.test\_module.}}\sphinxbfcode{\sphinxupquote{getTmpDirDEFAULT}}}{}{}
\end{fulllineitems}



\subsubsection{src.xmlManager module}
\label{\detokenize{commands/apidoc/src:src-xmlmanager-module}}\label{\detokenize{commands/apidoc/src:module-src.xmlManager}}\index{src.xmlManager (module)}\index{ReadXmlFile (class in src.xmlManager)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.ReadXmlFile}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.xmlManager.}}\sphinxbfcode{\sphinxupquote{ReadXmlFile}}}{\emph{filePath}}{}
Bases: \sphinxcode{\sphinxupquote{object}}

Class to manage reading of an xml log file
\index{getRootAttrib() (src.xmlManager.ReadXmlFile method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.ReadXmlFile.getRootAttrib}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getRootAttrib}}}{}{}
Get the attibutes of the self.xmlroot
\begin{quote}\begin{description}
\item[{Returns}] \leavevmode
The attributes of the root node

\item[{Return type}] \leavevmode
dict

\end{description}\end{quote}

\end{fulllineitems}

\index{get\_attrib() (src.xmlManager.ReadXmlFile method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.ReadXmlFile.get_attrib}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_attrib}}}{\emph{node\_name}}{}
Get the attibutes of the node node\_name in self.xmlroot
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{node\_name}}) \textendash{} the name of the node

\item[{Returns}] \leavevmode
the attibutes of the node node\_name in self.xmlroot

\item[{Return type}] \leavevmode
dict

\end{description}\end{quote}

\end{fulllineitems}

\index{get\_node\_text() (src.xmlManager.ReadXmlFile method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.ReadXmlFile.get_node_text}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_node\_text}}}{\emph{node}}{}~\begin{description}
\item[{Get the text of the first node that has name }] \leavevmode
that corresponds to the parameter node

\end{description}
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{node}}) \textendash{} the name of the node from which get the text

\item[{Returns}] \leavevmode
the text of the first node that has name 
that corresponds to the parameter node

\item[{Return type}] \leavevmode
str

\end{description}\end{quote}

\end{fulllineitems}


\end{fulllineitems}

\index{XmlLogFile (class in src.xmlManager)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.XmlLogFile}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.xmlManager.}}\sphinxbfcode{\sphinxupquote{XmlLogFile}}}{\emph{filePath}, \emph{rootname}, \emph{attrib=\{\}}}{}
Bases: \sphinxcode{\sphinxupquote{object}}

Class to manage writing in salomeTools xml log file
\index{add\_simple\_node() (src.xmlManager.XmlLogFile method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.XmlLogFile.add_simple_node}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_simple\_node}}}{\emph{node\_name}, \emph{text=None}, \emph{attrib=\{\}}}{}
Add a node with some attibutes and text to the root node.
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{text}}) \textendash{} the name of the node to add

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the text of the node

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{dict}} (\sphinxstyleliteralemphasis{\sphinxupquote{attrib}}) \textendash{} the dictionary containing the 
attribute of the new node

\end{itemize}

\end{description}\end{quote}

\end{fulllineitems}

\index{append\_node\_attrib() (src.xmlManager.XmlLogFile method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.XmlLogFile.append_node_attrib}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append\_node\_attrib}}}{\emph{node\_name}, \emph{attrib}}{}
Append a new attributes to the node that has node\_name as name
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{node\_name}}) \textendash{} The name of the node on which append text

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{dixt}} (\sphinxstyleliteralemphasis{\sphinxupquote{attrib}}) \textendash{} The attrib to append

\end{itemize}

\end{description}\end{quote}

\end{fulllineitems}

\index{append\_node\_text() (src.xmlManager.XmlLogFile method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.XmlLogFile.append_node_text}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append\_node\_text}}}{\emph{node\_name}, \emph{text}}{}
Append a new text to the node that has node\_name as name
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{text}}) \textendash{} The name of the node on which append text

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The text to append

\end{itemize}

\end{description}\end{quote}

\end{fulllineitems}

\index{write\_tree() (src.xmlManager.XmlLogFile method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.XmlLogFile.write_tree}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write\_tree}}}{\emph{stylesheet=None}, \emph{file\_path=None}}{}
Write the xml tree in the log file path. Add the stylesheet if asked.
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{stylesheet}}) \textendash{} The stylesheet to apply to the xml file

\end{description}\end{quote}

\end{fulllineitems}


\end{fulllineitems}

\index{add\_simple\_node() (in module src.xmlManager)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.add_simple_node}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.xmlManager.}}\sphinxbfcode{\sphinxupquote{add\_simple\_node}}}{\emph{root\_node}, \emph{node\_name}, \emph{text=None}, \emph{attrib=\{\}}}{}
Add a node with some attibutes and text to the root node.
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{etree.Element}} (\sphinxstyleliteralemphasis{\sphinxupquote{root\_node}}) \textendash{} the Etree element where to add the new node

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{text}}) \textendash{} the name of the node to add

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the text of the node

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{dict}} (\sphinxstyleliteralemphasis{\sphinxupquote{attrib}}) \textendash{} the dictionary containing the 
attribute of the new node

\end{itemize}

\end{description}\end{quote}

\end{fulllineitems}

\index{append\_node\_attrib() (in module src.xmlManager)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.append_node_attrib}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.xmlManager.}}\sphinxbfcode{\sphinxupquote{append\_node\_attrib}}}{\emph{root\_node}, \emph{attrib}}{}
Append a new attributes to the node that has node\_name as name
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{etree.Element}} (\sphinxstyleliteralemphasis{\sphinxupquote{root\_node}}) \textendash{} the Etree element 
where to append the new attibutes

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{dixt}} (\sphinxstyleliteralemphasis{\sphinxupquote{attrib}}) \textendash{} The attrib to append

\end{itemize}

\end{description}\end{quote}

\end{fulllineitems}

\index{find\_node\_by\_attrib() (in module src.xmlManager)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.find_node_by_attrib}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.xmlManager.}}\sphinxbfcode{\sphinxupquote{find\_node\_by\_attrib}}}{\emph{xmlroot}, \emph{name\_node}, \emph{key}, \emph{value}}{}~\begin{description}
\item[{Find the nfirst ode from xmlroot that has name name\_node and that has in }] \leavevmode
its attributes \{key : value\}. Return the node

\end{description}
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{etree.Element}} (\sphinxstyleliteralemphasis{\sphinxupquote{xmlroot}}) \textendash{} the Etree element where to search

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the name of node to search

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the key to search

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to search

\end{itemize}

\item[{Returns}] \leavevmode
the found node

\item[{Return type}] \leavevmode
xmlroot etree.Element

\end{description}\end{quote}

\end{fulllineitems}

\index{write\_report() (in module src.xmlManager)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.write_report}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.xmlManager.}}\sphinxbfcode{\sphinxupquote{write\_report}}}{\emph{filename}, \emph{xmlroot}, \emph{stylesheet}}{}
Writes a report file from a XML tree.
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{stylesheet}}) \textendash{} The path to the file to create

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{etree.Element}} (\sphinxstyleliteralemphasis{\sphinxupquote{xmlroot}}) \textendash{} the Etree element to write to the file

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The stylesheet to add to the begin of the file

\end{itemize}

\end{description}\end{quote}

\end{fulllineitems}



\subsubsection{Module contents}
\label{\detokenize{commands/apidoc/src:module-src}}\label{\detokenize{commands/apidoc/src:module-contents}}\index{src (module)}
initial imports and utilities methods for salomeTools
\index{Path (class in src)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.Path}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{Path}}}{\emph{path}}{}~\index{base() (src.Path method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.Path.base}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{base}}}{}{}
\end{fulllineitems}

\index{chmod() (src.Path method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.Path.chmod}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{chmod}}}{\emph{mode}}{}
\end{fulllineitems}

\index{copy() (src.Path method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.Path.copy}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{copy}}}{\emph{path}, \emph{smart=False}}{}
\end{fulllineitems}

\index{copydir() (src.Path method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.Path.copydir}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{copydir}}}{\emph{dst}, \emph{smart=False}}{}
\end{fulllineitems}

\index{copyfile() (src.Path method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.Path.copyfile}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{copyfile}}}{\emph{path}}{}
\end{fulllineitems}

\index{copylink() (src.Path method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.Path.copylink}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{copylink}}}{\emph{path}}{}
\end{fulllineitems}

\index{dir() (src.Path method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.Path.dir}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{dir}}}{}{}
\end{fulllineitems}

\index{exists() (src.Path method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.Path.exists}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{exists}}}{}{}
\end{fulllineitems}

\index{isdir() (src.Path method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.Path.isdir}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{isdir}}}{}{}
\end{fulllineitems}

\index{isfile() (src.Path method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.Path.isfile}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{isfile}}}{}{}
\end{fulllineitems}

\index{islink() (src.Path method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.Path.islink}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{islink}}}{}{}
\end{fulllineitems}

\index{list() (src.Path method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.Path.list}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{list}}}{}{}
\end{fulllineitems}

\index{make() (src.Path method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.Path.make}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{make}}}{\emph{mode=None}}{}
\end{fulllineitems}

\index{readlink() (src.Path method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.Path.readlink}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{readlink}}}{}{}
\end{fulllineitems}

\index{rm() (src.Path method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.Path.rm}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{rm}}}{}{}
\end{fulllineitems}

\index{smartcopy() (src.Path method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.Path.smartcopy}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{smartcopy}}}{\emph{path}}{}
\end{fulllineitems}

\index{symlink() (src.Path method)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.Path.symlink}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{symlink}}}{\emph{path}}{}
\end{fulllineitems}


\end{fulllineitems}

\index{SatException}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.SatException}}\pysigline{\sphinxbfcode{\sphinxupquote{exception }}\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{SatException}}}
Bases: \sphinxcode{\sphinxupquote{exceptions.Exception}}

rename Exception Class

\end{fulllineitems}

\index{activate\_mesa\_property() (in module src)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.activate_mesa_property}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{activate\_mesa\_property}}}{\emph{config}}{}
Add mesa property into application properties
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} The global configuration. It must have an application!

\end{description}\end{quote}

\end{fulllineitems}

\index{check\_config\_has\_application() (in module src)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.check_config_has_application}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{check\_config\_has\_application}}}{\emph{config}, \emph{details=None}}{}
check that the config has the key APPLICATION. Else raise an exception.
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{class 'common.pyconf.Config'}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} The config.

\end{description}\end{quote}

\end{fulllineitems}

\index{check\_config\_has\_profile() (in module src)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.check_config_has_profile}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{check\_config\_has\_profile}}}{\emph{config}, \emph{details=None}}{}
check that the config has the key APPLICATION.profile.
else, raise an exception.
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{class 'common.pyconf.Config'}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} The config.

\end{description}\end{quote}

\end{fulllineitems}

\index{config\_has\_application() (in module src)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.config_has_application}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{config\_has\_application}}}{\emph{config}}{}
\end{fulllineitems}

\index{deepcopy\_list() (in module src)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.deepcopy_list}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{deepcopy\_list}}}{\emph{input\_list}}{}
Do a deep copy of a list
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{List}} (\sphinxstyleliteralemphasis{\sphinxupquote{input\_list}}) \textendash{} The list to copy

\item[{Returns}] \leavevmode
The copy of the list

\item[{Return type}] \leavevmode
List

\end{description}\end{quote}

\end{fulllineitems}

\index{ensure\_path\_exists() (in module src)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.ensure_path_exists}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{ensure\_path\_exists}}}{\emph{p}}{}
Create a path if not existing
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{p}}) \textendash{} The path.

\end{description}\end{quote}

\end{fulllineitems}

\index{find\_file\_in\_lpath() (in module src)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.find_file_in_lpath}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{find\_file\_in\_lpath}}}{\emph{file\_name}, \emph{lpath}, \emph{additional\_dir=''}}{}
Find in all the directories in lpath list the file that has the same name
as file\_name. 
If it is found 
then return the full path of the file
else return False.

The additional\_dir (optional) is the name of the directory to add to all 
paths in lpath.
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{additional\_dir}}) \textendash{} The file name to search

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{List}} (\sphinxstyleliteralemphasis{\sphinxupquote{lpath}}) \textendash{} The list of directories where to search

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The name of the additional directory

\end{itemize}

\item[{Returns}] \leavevmode
the full path of the file or False if not found

\item[{Return type}] \leavevmode
str

\end{description}\end{quote}

\end{fulllineitems}

\index{get\_base\_path() (in module src)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.get_base_path}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{get\_base\_path}}}{\emph{config}}{}
Returns the path of the products base.
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} The global Config instance.

\item[{Returns}] \leavevmode
The path of the products base.

\item[{Return type}] \leavevmode
str

\end{description}\end{quote}

\end{fulllineitems}

\index{get\_cfg\_param() (in module src)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.get_cfg_param}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{get\_cfg\_param}}}{\emph{config}, \emph{param\_name}, \emph{default}}{}
eearch for param\_name value in config.
if param\_name is not in config 
then return default,
else return the found value
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{class 'common.pyconf.Config'}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} The config.

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{default}}) \textendash{} the name of the parameter to get the value

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The value to return if param\_name is not in config

\end{itemize}

\item[{Returns}] \leavevmode
see initial description of the function

\item[{Return type}] \leavevmode
str

\end{description}\end{quote}

\end{fulllineitems}

\index{get\_launcher\_name() (in module src)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.get_launcher_name}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{get\_launcher\_name}}}{\emph{config}}{}
Returns the name of salome launcher.
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} The global Config instance.

\item[{Returns}] \leavevmode
The name of salome launcher.

\item[{Return type}] \leavevmode
str

\end{description}\end{quote}

\end{fulllineitems}

\index{get\_log\_path() (in module src)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.get_log_path}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{get\_log\_path}}}{\emph{config}}{}
Returns the path of the logs.
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} The global Config instance.

\item[{Returns}] \leavevmode
The path of the logs.

\item[{Return type}] \leavevmode
str

\end{description}\end{quote}

\end{fulllineitems}

\index{get\_property\_in\_product\_cfg() (in module src)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.get_property_in_product_cfg}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{get\_property\_in\_product\_cfg}}}{\emph{product\_cfg}, \emph{pprty}}{}
\end{fulllineitems}

\index{get\_salome\_version() (in module src)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.get_salome_version}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{get\_salome\_version}}}{\emph{config}}{}
\end{fulllineitems}

\index{get\_tmp\_filename() (in module src)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.get_tmp_filename}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{get\_tmp\_filename}}}{\emph{cfg}, \emph{name}}{}
\end{fulllineitems}

\index{handleRemoveReadonly() (in module src)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.handleRemoveReadonly}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{handleRemoveReadonly}}}{\emph{func}, \emph{path}, \emph{exc}}{}
\end{fulllineitems}

\index{merge\_dicts() (in module src)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.merge_dicts}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{merge\_dicts}}}{\emph{*dict\_args}}{}
Given any number of dicts, shallow copy and merge into a new dict,
precedence goes to key value pairs in latter dicts.

\end{fulllineitems}

\index{only\_numbers() (in module src)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.only_numbers}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{only\_numbers}}}{\emph{str\_num}}{}
\end{fulllineitems}

\index{parse\_date() (in module src)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.parse_date}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{parse\_date}}}{\emph{date}}{}
Transform YYYYMMDD\_hhmmss into YYYY-MM-DD hh:mm:ss.
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{date}}) \textendash{} The date to transform

\item[{Returns}] \leavevmode
The date in the new format

\item[{Return type}] \leavevmode
str

\end{description}\end{quote}

\end{fulllineitems}

\index{print\_info() (in module src)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.print_info}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{print\_info}}}{\emph{logger}, \emph{info}}{}
Prints the tuples that are in info variable in a formatted way.
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode\begin{itemize}
\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logging instance to use for the prints.

\item {} 
\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{info}}) \textendash{} The list of tuples to display

\end{itemize}

\end{description}\end{quote}

\end{fulllineitems}

\index{read\_config\_from\_a\_file() (in module src)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.read_config_from_a_file}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{read\_config\_from\_a\_file}}}{\emph{filePath}}{}
\end{fulllineitems}

\index{remove\_item\_from\_list() (in module src)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.remove_item_from_list}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{remove\_item\_from\_list}}}{\emph{input\_list}, \emph{item}}{}
Remove all occurences of item from input\_list
\begin{quote}\begin{description}
\item[{Parameters}] \leavevmode
\sphinxstyleliteralstrong{\sphinxupquote{List}} (\sphinxstyleliteralemphasis{\sphinxupquote{input\_list}}) \textendash{} The list to modify

\item[{Returns}] \leavevmode
The without any item

\item[{Return type}] \leavevmode
List

\end{description}\end{quote}

\end{fulllineitems}

\index{replace\_in\_file() (in module src)}

\begin{fulllineitems}
\phantomsection\label{\detokenize{commands/apidoc/src:src.replace_in_file}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{replace\_in\_file}}}{\emph{filein}, \emph{strin}, \emph{strout}}{}
Replace \textless{}strin\textgreater{} by \textless{}strout\textgreater{} in file \textless{}filein\textgreater{}

\end{fulllineitems}



\chapter{Release Notes}
\label{\detokenize{index:release-notes}}

\section{Release notes}
\label{\detokenize{release_notes/release_notes_5.0.0:release-notes}}\label{\detokenize{release_notes/release_notes_5.0.0::doc}}
In construction.


\renewcommand{\indexname}{Python Module Index}
\begin{sphinxtheindex}
\def\bigletter#1{{\Large\sffamily#1}\nopagebreak\vspace{1mm}}
\bigletter{s}
\item {\sphinxstyleindexentry{src}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src}}
\item {\sphinxstyleindexentry{src.architecture}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.architecture}}
\item {\sphinxstyleindexentry{src.colorama}}\sphinxstyleindexpageref{commands/apidoc/src.colorama:\detokenize{module-src.colorama}}
\item {\sphinxstyleindexentry{src.colorama.ansi}}\sphinxstyleindexpageref{commands/apidoc/src.colorama:\detokenize{module-src.colorama.ansi}}
\item {\sphinxstyleindexentry{src.colorama.ansitowin32}}\sphinxstyleindexpageref{commands/apidoc/src.colorama:\detokenize{module-src.colorama.ansitowin32}}
\item {\sphinxstyleindexentry{src.colorama.initialise}}\sphinxstyleindexpageref{commands/apidoc/src.colorama:\detokenize{module-src.colorama.initialise}}
\item {\sphinxstyleindexentry{src.colorama.win32}}\sphinxstyleindexpageref{commands/apidoc/src.colorama:\detokenize{module-src.colorama.win32}}
\item {\sphinxstyleindexentry{src.colorama.winterm}}\sphinxstyleindexpageref{commands/apidoc/src.colorama:\detokenize{module-src.colorama.winterm}}
\item {\sphinxstyleindexentry{src.compilation}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.compilation}}
\item {\sphinxstyleindexentry{src.debug}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.debug}}
\item {\sphinxstyleindexentry{src.ElementTree}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.ElementTree}}
\item {\sphinxstyleindexentry{src.environment}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.environment}}
\item {\sphinxstyleindexentry{src.fileEnviron}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.fileEnviron}}
\item {\sphinxstyleindexentry{src.fork}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.fork}}
\item {\sphinxstyleindexentry{src.logger}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.logger}}
\item {\sphinxstyleindexentry{src.options}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.options}}
\item {\sphinxstyleindexentry{src.printcolors}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.printcolors}}
\item {\sphinxstyleindexentry{src.product}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.product}}
\item {\sphinxstyleindexentry{src.pyconf}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.pyconf}}
\item {\sphinxstyleindexentry{src.system}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.system}}
\item {\sphinxstyleindexentry{src.template}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.template}}
\item {\sphinxstyleindexentry{src.test\_module}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.test_module}}
\item {\sphinxstyleindexentry{src.xmlManager}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.xmlManager}}
\end{sphinxtheindex}

\renewcommand{\indexname}{Index}
\printindex
\end{document}