doc/build/latex/salomeTools.tex

   1 %% Generated by Sphinx.
   2 \def\sphinxdocclass{report}
   3 \documentclass[a4paper,10pt,english]{sphinxmanual}
   4 \ifdefined\pdfpxdimen
   5    \let\sphinxpxdimen\pdfpxdimen\else\newdimen\sphinxpxdimen
   6 \fi \sphinxpxdimen=.75bp\relax
   7
   8 \PassOptionsToPackage{warn}{textcomp}
   9 \usepackage[utf8]{inputenc}
  10 \ifdefined\DeclareUnicodeCharacter
  11  \ifdefined\DeclareUnicodeCharacterAsOptional
  12   \DeclareUnicodeCharacter{"00A0}{\nobreakspace}
  13   \DeclareUnicodeCharacter{"2500}{\sphinxunichar{2500}}
  14   \DeclareUnicodeCharacter{"2502}{\sphinxunichar{2502}}
  15   \DeclareUnicodeCharacter{"2514}{\sphinxunichar{2514}}
  16   \DeclareUnicodeCharacter{"251C}{\sphinxunichar{251C}}
  17   \DeclareUnicodeCharacter{"2572}{\textbackslash}
  18  \else
  19   \DeclareUnicodeCharacter{00A0}{\nobreakspace}
  20   \DeclareUnicodeCharacter{2500}{\sphinxunichar{2500}}
  21   \DeclareUnicodeCharacter{2502}{\sphinxunichar{2502}}
  22   \DeclareUnicodeCharacter{2514}{\sphinxunichar{2514}}
  23   \DeclareUnicodeCharacter{251C}{\sphinxunichar{251C}}
  24   \DeclareUnicodeCharacter{2572}{\textbackslash}
  25  \fi
  26 \fi
  27 \usepackage{cmap}
  28 \usepackage[T1]{fontenc}
  29 \usepackage{amsmath,amssymb,amstext}
  30 \usepackage{babel}
  31 \usepackage{times}
  32 \usepackage[Bjarne]{fncychap}
  33 \usepackage{sphinx}
  34 \sphinxsetup{verbatimwithframe=false, VerbatimColor={rgb}{.98,.94,.94}}
  35 \usepackage{geometry}
  36
  37 % Include hyperref last.
  38 \usepackage{hyperref}
  39 % Fix anchor placement for figures with captions.
  40 \usepackage{hypcap}% it must be loaded after hyperref.
  41 % Set up styles of URL: it should be placed after hyperref.
  42 \urlstyle{same}
  43
  44 \addto\captionsenglish{\renewcommand{\figurename}{Fig.}}
  45 \addto\captionsenglish{\renewcommand{\tablename}{Table}}
  46 \addto\captionsenglish{\renewcommand{\literalblockname}{Listing}}
  47
  48 \addto\captionsenglish{\renewcommand{\literalblockcontinuedname}{continued from previous page}}
  49 \addto\captionsenglish{\renewcommand{\literalblockcontinuesname}{continues on next page}}
  50
  51 \addto\extrasenglish{\def\pageautorefname{page}}
  52
  53 \setcounter{tocdepth}{1}
  54
  55
  56
  57 \title{salomeTools Documentation}
  58 \date{Jun 19, 2018}
  59 \release{5.0.0dev}
  60 \author{CEA DEN/DANS/DM2S/STMF/LGLS}
  61 \newcommand{\sphinxlogo}{\vbox{}}
  62 \renewcommand{\releasename}{Release}
  63 \makeindex
  64
  65 \begin{document}
  66
  67 \maketitle
  68 \sphinxtableofcontents
  69 \phantomsection\label{\detokenize{index::doc}}
  70 \clearpage
  71
  72
  73
  74 \noindent{\hspace*{\fill}\sphinxincludegraphics[scale=1.0]{{sat_about}.png}\hspace*{\fill}}
  75
  76 \begin{sphinxadmonition}{warning}{Warning:}
  77 This documentation is under construction.
  78 \end{sphinxadmonition}
  79
  80 The \sphinxstylestrong{Sa}lome\sphinxstylestrong{T}ools (sat) is a suite of commands
  81 that can be used to perform operations on \sphinxhref{http://www.salome-platform.org}{SALOME}%
  82 \begin{footnote}[1]\sphinxAtStartFootnote
  83 \sphinxnolinkurl{http://www.salome-platform.org}
  84 %
  85 \end{footnote}.
  86
  87 For example, sat allows you to compile SALOME’s codes
  88 (prerequisites, products)
  89 create application, run tests, create package, etc.
  90
  91 This utility code is a set of \sphinxhref{https://docs.python.org/2.7}{Python}%
  92 \begin{footnote}[2]\sphinxAtStartFootnote
  93 \sphinxnolinkurl{https://docs.python.org/2.7}
  94 %
  95 \end{footnote} scripts files.
  96
  97 Find a \sphinxhref{./../latex/salomeTools.pdf}{pdf version of this documentation}
  98
  99
 100 \chapter{Quick start}
 101 \label{\detokenize{index:quick-start}}\label{\detokenize{index:salome-tools}}
 102
 103 \section{Installation}
 104 \label{\detokenize{installation_of_sat:installation}}\label{\detokenize{installation_of_sat::doc}}
 105 Usually user could find (and use) command \sphinxstylestrong{sat} directly after a ‘detar’ installation of SALOME.
 106
 107 \fvset{hllines={, ,}}%
 108 \begin{sphinxVerbatim}[commandchars=\\\{\}]
 109 tar \PYGZhy{}xf .../SALOME\PYGZus{}xx.tgz
 110 \PYG{n+nb}{cd} SALOME\PYGZus{}xx
 111 ls \PYGZhy{}l sat      \PYG{c+c1}{\PYGZsh{} sat \PYGZhy{}\PYGZgt{} salomeTools/sat}
 112 \end{sphinxVerbatim}
 113
 114 Python package (scripts of salomeTools) actually remains in directory \sphinxstyleemphasis{salomeTools}.
 115
 116
 117 \section{Configuration}
 118 \label{\detokenize{configuration:configuration}}\label{\detokenize{configuration::doc}}
 119 \sphinxstyleemphasis{salomeTools} uses files to store its configuration parameters.
 120
 121 There are several configuration files which are loaded by salomeTools in a specific order.
 122 When all the files are loaded a \sphinxstyleemphasis{config} object is created.
 123 Then, this object is passed to all command scripts.
 124
 125
 126 \subsection{Syntax}
 127 \label{\detokenize{configuration:syntax}}
 128 The configuration files use a python-like structure format
 129 (see \sphinxhref{http://www.red-dove.com/config-doc/}{config module}%
 130 \begin{footnote}[3]\sphinxAtStartFootnote
 131 \sphinxnolinkurl{http://www.red-dove.com/config-doc/}
 132 %
 133 \end{footnote} for a complete description).
 134 \begin{itemize}
 135 \item {}
 136 \sphinxstylestrong{\{\}} define a dictionary,
 137
 138 \item {}
 139 \sphinxstylestrong{{[}{]}} define a list,
 140
 141 \item {}
 142 \sphinxstylestrong{@} can be used to include a file,
 143
 144 \item {}
 145 \sphinxstylestrong{\$prefix} reference to another parameter (ex: \sphinxcode{\sphinxupquote{\$PRODUCT.name}}),
 146
 147 \item {}
 148 \sphinxstylestrong{\#} comments.
 149
 150 \end{itemize}
 151
 152 \begin{sphinxadmonition}{note}{Note:}
 153 in this documentation a reference to a configuration parameter will be noted \sphinxcode{\sphinxupquote{XXX.YYY}}.
 154 \end{sphinxadmonition}
 155
 156
 157 \subsection{Description}
 158 \label{\detokenize{configuration:description}}
 159
 160 \subsubsection{VARS section}
 161 \label{\detokenize{configuration:vars-section}}\label{\detokenize{configuration:id1}}
 162 \begin{DUlineblock}{0em}
 163 \item[] This section is dynamically created by salomeTools at run time.
 164 \item[] It contains information about the environment: date, time, OS, architecture etc.
 165 \end{DUlineblock}
 166
 167 \fvset{hllines={, ,}}%
 168 \begin{sphinxVerbatim}[commandchars=\\\{\}]
 169 \PYG{c+c1}{\PYGZsh{} to get the current setting}
 170 \PYG{n}{sat} \PYG{n}{config} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{value} \PYG{n}{VARS}
 171 \end{sphinxVerbatim}
 172
 173
 174 \subsubsection{PRODUCTS section}
 175 \label{\detokenize{configuration:products-section}}
 176 \begin{DUlineblock}{0em}
 177 \item[] This section is defined in the product file.
 178 \item[] It contains instructions on how to build a version of SALOME (list of prerequisites-products and versions)
 179 \end{DUlineblock}
 180
 181 \fvset{hllines={, ,}}%
 182 \begin{sphinxVerbatim}[commandchars=\\\{\}]
 183 \PYG{c+c1}{\PYGZsh{} to get the current setting}
 184 \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}
 185 \end{sphinxVerbatim}
 186
 187
 188 \subsubsection{APPLICATION section}
 189 \label{\detokenize{configuration:application-section}}
 190 \begin{DUlineblock}{0em}
 191 \item[] This section is optional, it is also defined in the product file.
 192 \item[] It gives additional parameters to create an application based on SALOME, as versions of products to use.
 193 \end{DUlineblock}
 194
 195 \fvset{hllines={, ,}}%
 196 \begin{sphinxVerbatim}[commandchars=\\\{\}]
 197 \PYG{c+c1}{\PYGZsh{} to get the current setting}
 198 \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}
 199 \end{sphinxVerbatim}
 200
 201
 202 \subsubsection{USER section}
 203 \label{\detokenize{configuration:user-section}}\label{\detokenize{configuration:id2}}
 204 This section is defined by the user configuration file,
 205 \sphinxcode{\sphinxupquote{\textasciitilde{}/.salomeTools/salomeTools.pyconf}}.
 206
 207 The \sphinxcode{\sphinxupquote{USER}} section defines some parameters (not exhaustive):
 208 \begin{itemize}
 209 \item {}
 210 \sphinxstylestrong{workDir} :
 211 \begin{quote}
 212
 213 \begin{DUlineblock}{0em}
 214 \item[] The working directory.
 215 \item[] Each product will be usually installed here (in sub-directories).
 216 \end{DUlineblock}
 217 \end{quote}
 218
 219 \item {}
 220 \sphinxstylestrong{browser} : The web browser to use (\sphinxstyleemphasis{firefox}).
 221
 222 \item {}
 223 \sphinxstylestrong{editor} : The editor to use (\sphinxstyleemphasis{vi, pluma}).
 224
 225 \item {}
 226 and other user preferences.
 227
 228 \end{itemize}
 229
 230 \fvset{hllines={, ,}}%
 231 \begin{sphinxVerbatim}[commandchars=\\\{\}]
 232 \PYG{c+c1}{\PYGZsh{} to get the current setting}
 233 \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}
 234 \end{sphinxVerbatim}
 235
 236 \clearpage
 237
 238
 239 \section{Usage of SAlomeTools}
 240 \label{\detokenize{usage_of_sat:svn}}\label{\detokenize{usage_of_sat:usage-of-salometools}}\label{\detokenize{usage_of_sat::doc}}
 241
 242 \subsection{Usage}
 243 \label{\detokenize{usage_of_sat:usage}}
 244 sat usage is a Command Line Interface (\sphinxhref{https://en.wikipedia.org/wiki/Command-line\_interface}{CLI}%
 245 \begin{footnote}[4]\sphinxAtStartFootnote
 246 \sphinxnolinkurl{https://en.wikipedia.org/wiki/Command-line\_interface}
 247 %
 248 \end{footnote}).
 249
 250 \fvset{hllines={, ,}}%
 251 \begin{sphinxVerbatim}[commandchars=\\\{\}]
 252 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}{]}
 253 \end{sphinxVerbatim}
 254
 255
 256 \subsubsection{Options of sat}
 257 \label{\detokenize{usage_of_sat:options-of-sat}}
 258 Useful \sphinxstyleemphasis{not exhaustive} generic options of \sphinxstyleemphasis{sat} CLI.
 259
 260
 261 \paragraph{\sphinxstyleemphasis{\textendash{}help or -h}}
 262 \label{\detokenize{usage_of_sat:help-or-h}}
 263 Get help as simple text.
 264
 265 \fvset{hllines={, ,}}%
 266 \begin{sphinxVerbatim}[commandchars=\\\{\}]
 267 sat \PYGZhy{}\PYGZhy{}help          \PYG{c+c1}{\PYGZsh{} get the list of existing commands}
 268 sat \PYGZhy{}\PYGZhy{}help compile  \PYG{c+c1}{\PYGZsh{} get the help on a specific command \PYGZsq{}compile\PYGZsq{}}
 269 \end{sphinxVerbatim}
 270
 271
 272 \paragraph{\sphinxstyleemphasis{\textendash{}debug or -g}}
 273 \label{\detokenize{usage_of_sat:debug-or-g}}
 274 Execution in debug mode allows to see more trace and \sphinxstyleemphasis{stack} if an exception is raised.
 275
 276
 277 \paragraph{\sphinxstyleemphasis{\textendash{}verbose or -v}}
 278 \label{\detokenize{usage_of_sat:verbose-or-v}}
 279 Change verbosity level (default is 3).
 280
 281 \fvset{hllines={, ,}}%
 282 \begin{sphinxVerbatim}[commandchars=\\\{\}]
 283 \PYG{c+c1}{\PYGZsh{} for product \PYGZsq{}SALOME\PYGZus{}xx\PYGZsq{} for example}
 284 \PYG{c+c1}{\PYGZsh{} execute compile command in debug mode with trace level 4}
 285 sat \PYGZhy{}g \PYGZhy{}v \PYG{l+m}{4} compile SALOME\PYGZus{}xx
 286 \end{sphinxVerbatim}
 287
 288
 289 \subsection{Build a SALOME product}
 290 \label{\detokenize{usage_of_sat:build-a-salome-product}}
 291
 292 \subsubsection{Get the list of available products}
 293 \label{\detokenize{usage_of_sat:get-the-list-of-available-products}}
 294 To get the list of the current available products in your context:
 295
 296 \fvset{hllines={, ,}}%
 297 \begin{sphinxVerbatim}[commandchars=\\\{\}]
 298 sat config \PYGZhy{}\PYGZhy{}list
 299 \end{sphinxVerbatim}
 300
 301
 302 \subsubsection{Prepare sources of a product}
 303 \label{\detokenize{usage_of_sat:prepare-sources-of-a-product}}
 304 To prepare (get) \sphinxstyleemphasis{all} the sources of a product (\sphinxstyleemphasis{SALOME\_xx} for example):
 305
 306 \fvset{hllines={, ,}}%
 307 \begin{sphinxVerbatim}[commandchars=\\\{\}]
 308 sat prepare SALOME\PYGZus{}xx
 309 \end{sphinxVerbatim}
 310
 311 \begin{DUlineblock}{0em}
 312 \item[] The sources are usually copied in directories
 313 \item[] \sphinxstyleemphasis{\$USER.workDir + SALOME\_xx… + SOURCES + \$PRODUCT.name}
 314 \end{DUlineblock}
 315
 316
 317 \subsubsection{Compile SALOME}
 318 \label{\detokenize{usage_of_sat:compile-salome}}
 319 To compile products:
 320
 321 \fvset{hllines={, ,}}%
 322 \begin{sphinxVerbatim}[commandchars=\\\{\}]
 323 \PYG{c+c1}{\PYGZsh{} compile all prerequisites/products}
 324 sat compile SALOME\PYGZus{}xx
 325
 326 \PYG{c+c1}{\PYGZsh{} compile only 2 products (KERNEL and SAMPLES), if not done yet}
 327 sat compile SALOME\PYGZus{}xx \PYGZhy{}\PYGZhy{}products KERNEL,SAMPLES
 328
 329 \PYG{c+c1}{\PYGZsh{} compile only 2 products, unconditionaly}
 330 sat compile SALOME\PYGZus{}xx \PYGZhy{}\PYGZhy{}\PYGZhy{}products SAMPLES \PYGZhy{}\PYGZhy{}clean\PYGZus{}all
 331 \end{sphinxVerbatim}
 332
 333 \begin{DUlineblock}{0em}
 334 \item[] The products are usually build in the directories
 335 \item[] \sphinxstyleemphasis{\$USER.workDir + SALOME\_xx… + BUILD + \$PRODUCT.name}
 336 \item[]
 337 \item[] The products are usually installed in the directories
 338 \item[] \sphinxstyleemphasis{\$USER.workDir + SALOME\_xx… + INSTALL + \$PRODUCT.name}
 339 \end{DUlineblock}
 340
 341
 342 \chapter{List of Commands}
 343 \label{\detokenize{index:list-of-commands}}
 344 \clearpage
 345
 346
 347 \section{Command doc}
 348 \label{\detokenize{commands/doc:svn}}\label{\detokenize{commands/doc::doc}}\label{\detokenize{commands/doc:command-doc}}
 349
 350 \subsection{Description}
 351 \label{\detokenize{commands/doc:description}}
 352 The \sphinxstylestrong{doc} command displays sat documentation.
 353
 354
 355 \subsection{Usage}
 356 \label{\detokenize{commands/doc:usage}}\begin{itemize}
 357 \item {}
 358 Show (in a web browser) the sat documentation:
 359
 360 \fvset{hllines={, ,}}%
 361 \begin{sphinxVerbatim}[commandchars=\\\{\}]
 362 \PYG{n}{sat} \PYG{n}{doc} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{html}
 363 \end{sphinxVerbatim}
 364
 365 \item {}
 366 Show (in evince, for example) the (same) sat documentation in format pdf:
 367
 368 \fvset{hllines={, ,}}%
 369 \begin{sphinxVerbatim}[commandchars=\\\{\}]
 370 \PYG{n}{sat} \PYG{n}{doc} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{pdf}
 371 \end{sphinxVerbatim}
 372
 373 \item {}
 374 Edit and modify in your preference user editor the sources files (rst) of sat documentation:
 375
 376 \fvset{hllines={, ,}}%
 377 \begin{sphinxVerbatim}[commandchars=\\\{\}]
 378 \PYG{n}{sat} \PYG{n}{doc} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{edit}
 379 \end{sphinxVerbatim}
 380
 381 \item {}
 382 get information how to compile locally sat documentation (from the sources files):
 383
 384 \fvset{hllines={, ,}}%
 385 \begin{sphinxVerbatim}[commandchars=\\\{\}]
 386 \PYG{n}{sat} \PYG{n}{doc} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n+nb}{compile}
 387 \end{sphinxVerbatim}
 388
 389 \end{itemize}
 390
 391
 392 \subsection{Some useful configuration pathes}
 393 \label{\detokenize{commands/doc:some-useful-configuration-pathes}}\begin{itemize}
 394 \item {}
 395 \sphinxstylestrong{USER}
 396 \begin{itemize}
 397 \item {}
 398 \sphinxstylestrong{browser} : The browser used to show the html files (\sphinxstyleemphasis{firefox} for example).
 399
 400 \item {}
 401 \sphinxstylestrong{pdf\_viewer} : The viewer used to show the pdf files (\sphinxstyleemphasis{evince} for example).
 402
 403 \item {}
 404 \sphinxstylestrong{editor} : The editor used to edit ascii text files (\sphinxstyleemphasis{pluma or gedit} for example).
 405
 406 \end{itemize}
 407
 408 \end{itemize}
 409
 410 \clearpage
 411
 412
 413 \section{Command config}
 414 \label{\detokenize{commands/config:svn}}\label{\detokenize{commands/config:command-config}}\label{\detokenize{commands/config::doc}}
 415
 416 \subsection{Description}
 417 \label{\detokenize{commands/config:description}}
 418 The \sphinxstylestrong{config} command manages sat configuration.
 419 It allows display, manipulation and operation on configuration files
 420
 421
 422 \subsection{Usage}
 423 \label{\detokenize{commands/config:usage}}\begin{itemize}
 424 \item {}
 425 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:
 426
 427 \fvset{hllines={, ,}}%
 428 \begin{sphinxVerbatim}[commandchars=\\\{\}]
 429 \PYG{n}{sat} \PYG{n}{config} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{edit}
 430 \end{sphinxVerbatim}
 431
 432 \item {}
 433 List the available applications (they come from the sat projects defined in \sphinxcode{\sphinxupquote{data/local.pyconf}}:
 434
 435 \fvset{hllines={, ,}}%
 436 \begin{sphinxVerbatim}[commandchars=\\\{\}]
 437 \PYG{n}{sat} \PYG{n}{config} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n+nb}{list}
 438 \end{sphinxVerbatim}
 439
 440 \item {}
 441 Edit the configuration of an application:
 442
 443 \fvset{hllines={, ,}}%
 444 \begin{sphinxVerbatim}[commandchars=\\\{\}]
 445 \PYG{n}{sat} \PYG{n}{config} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{edit}
 446 \end{sphinxVerbatim}
 447
 448 \item {}
 449 Copy an application configuration file into the user personal directory:
 450
 451 \fvset{hllines={, ,}}%
 452 \begin{sphinxVerbatim}[commandchars=\\\{\}]
 453 \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}{]}
 454 \end{sphinxVerbatim}
 455
 456 \item {}
 457 \begin{DUlineblock}{0em}
 458 \item[] Print the value of a configuration parameter.
 459 \item[] Use the automatic completion to get recursively the parameter names.
 460 \item[] Use \sphinxstyleemphasis{\textendash{}no\_label} option to get \sphinxstyleemphasis{only} the value, \sphinxstyleemphasis{without} label (useful in automatic scripts).
 461 \item[] Examples (with \sphinxstyleemphasis{SALOME-xx} as \sphinxstyleemphasis{SALOME-8.4.0} ):
 462 \end{DUlineblock}
 463
 464 \fvset{hllines={, ,}}%
 465 \begin{sphinxVerbatim}[commandchars=\\\{\}]
 466 \PYG{c+c1}{\PYGZsh{} sat config \PYGZhy{}\PYGZhy{}value \PYGZlt{}parameter\PYGZus{}path\PYGZgt{}}
 467 sat config \PYGZhy{}\PYGZhy{}value .         \PYG{c+c1}{\PYGZsh{} all the configuration}
 468 sat config \PYGZhy{}\PYGZhy{}value LOCAL
 469 sat config \PYGZhy{}\PYGZhy{}value LOCAL.workdir
 470
 471 \PYG{c+c1}{\PYGZsh{} sat config \PYGZlt{}application\PYGZgt{} \PYGZhy{}\PYGZhy{}value \PYGZlt{}parameter\PYGZus{}path\PYGZgt{}}
 472 sat config SALOME\PYGZhy{}xx \PYGZhy{}\PYGZhy{}value APPLICATION.workdir
 473 sat config SALOME\PYGZhy{}xx \PYGZhy{}\PYGZhy{}no\PYGZus{}label \PYGZhy{}\PYGZhy{}value APPLICATION.workdir
 474 \end{sphinxVerbatim}
 475
 476 \item {}
 477 \begin{DUlineblock}{0em}
 478 \item[] Print in one-line-by-value mode the value of a configuration parameter,
 479 \item[] with its source \sphinxstyleemphasis{expression}, if any.
 480 \item[] This is a debug mode, useful for developers.
 481 \item[] Prints the parameter path, the source expression if any, and the final value:
 482 \end{DUlineblock}
 483
 484 \fvset{hllines={, ,}}%
 485 \begin{sphinxVerbatim}[commandchars=\\\{\}]
 486 \PYG{n}{sat} \PYG{n}{config} \PYG{n}{SALOME}\PYG{o}{\PYGZhy{}}\PYG{n}{xx} \PYG{o}{\PYGZhy{}}\PYG{n}{g} \PYG{n}{USER}
 487 \end{sphinxVerbatim}
 488
 489 \begin{sphinxadmonition}{note}{Note:}
 490 And so, \sphinxstyleemphasis{not only for fun}, to get \sphinxstylestrong{all expressions} of configuration
 491
 492 \fvset{hllines={, ,}}%
 493 \begin{sphinxVerbatim}[commandchars=\\\{\}]
 494 sat config SALOME\PYGZhy{}xx \PYGZhy{}g . \PYG{p}{\textbar{}} grep \PYGZhy{}e \PYG{l+s+s2}{\PYGZdq{}\PYGZhy{}\PYGZhy{}\PYGZgt{}\PYGZdq{}}
 495 \end{sphinxVerbatim}
 496 \end{sphinxadmonition}
 497
 498 \item {}
 499 Print the patches that are applied:
 500
 501 \fvset{hllines={, ,}}%
 502 \begin{sphinxVerbatim}[commandchars=\\\{\}]
 503 \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}
 504 \end{sphinxVerbatim}
 505
 506 \item {}
 507 Get information on a product configuration:
 508
 509 \end{itemize}
 510
 511 \fvset{hllines={, ,}}%
 512 \begin{sphinxVerbatim}[commandchars=\\\{\}]
 513 \PYG{c+c1}{\PYGZsh{} sat config \PYGZlt{}application\PYGZgt{} \PYGZhy{}\PYGZhy{}info \PYGZlt{}product\PYGZgt{}}
 514 sat config SALOME\PYGZhy{}xx \PYGZhy{}\PYGZhy{}info KERNEL
 515 sat config SALOME\PYGZhy{}xx \PYGZhy{}\PYGZhy{}info qt
 516 \end{sphinxVerbatim}
 517
 518
 519 \subsection{Some useful configuration pathes}
 520 \label{\detokenize{commands/config:some-useful-configuration-pathes}}
 521 Exploring a current configuration.
 522 \begin{itemize}
 523 \item {}
 524 \sphinxstylestrong{PATHS}: To get list of directories where to find files.
 525
 526 \item {}
 527 \sphinxstylestrong{USER}: To get user preferences (editor, pdf viewer, web browser, default working dir).
 528
 529 \end{itemize}
 530
 531 sat commands:
 532
 533 \fvset{hllines={, ,}}%
 534 \begin{sphinxVerbatim}[commandchars=\\\{\}]
 535 \PYG{n}{sat} \PYG{n}{config} \PYG{n}{SALOME}\PYG{o}{\PYGZhy{}}\PYG{n}{xx} \PYG{o}{\PYGZhy{}}\PYG{n}{v} \PYG{n}{PATHS}
 536 \PYG{n}{sat} \PYG{n}{config} \PYG{n}{SALOME}\PYG{o}{\PYGZhy{}}\PYG{n}{xx} \PYG{o}{\PYGZhy{}}\PYG{n}{v} \PYG{n}{USERS}
 537 \end{sphinxVerbatim}
 538
 539 \clearpage
 540
 541
 542 \section{Command prepare}
 543 \label{\detokenize{commands/prepare:svn}}\label{\detokenize{commands/prepare:command-prepare}}\label{\detokenize{commands/prepare::doc}}
 544
 545 \subsection{Description}
 546 \label{\detokenize{commands/prepare:description}}
 547 The \sphinxstylestrong{prepare} command brings the sources of an application in the \sphinxstyleemphasis{sources
 548 application directory}, in order to compile them with the compile command.
 549
 550 The sources can be prepared from VCS software (\sphinxstyleemphasis{cvs, svn, git}), an archive or a directory.
 551
 552 \begin{sphinxadmonition}{warning}{Warning:}
 553 When sat prepares a product, it first removes the
 554 existing directory, except if the development mode is activated.
 555 When you are working on a product, you need to declare in
 556 the application configuration this product in \sphinxstylestrong{dev} mode.
 557 \end{sphinxadmonition}
 558
 559
 560 \subsection{Remarks}
 561 \label{\detokenize{commands/prepare:remarks}}
 562
 563 \subsubsection{VCS bases (git, svn, cvs)}
 564 \label{\detokenize{commands/prepare:vcs-bases-git-svn-cvs}}
 565 The \sphinxstyleemphasis{prepare} command does not manage authentication on the cvs server.
 566 For example, to prepare modules from a cvs server, you first need to login once.
 567
 568 To avoid typing a password for each product,
 569 you may use a ssh key with passphrase, or store your password
 570 (in .cvspass or .gitconfig files).
 571 If you have security concerns, it is also possible to use
 572 a bash agent and type your password only once.
 573
 574
 575 \subsubsection{Dev mode}
 576 \label{\detokenize{commands/prepare:dev-mode}}
 577 By default \sphinxstyleemphasis{prepare} uses \sphinxstyleemphasis{export} mode: it creates an image
 578 of the sources, corresponding to the tag or branch specified,
 579 without any link to the VCS base.
 580 To perform a \sphinxstyleemphasis{checkout} (svn, cvs) or a \sphinxstyleemphasis{git clone} (git),
 581 you need to declare the product in dev mode in your application configuration:
 582 edit the application configuration file (pyconf) and modify the product declaration:
 583
 584 \fvset{hllines={, ,}}%
 585 \begin{sphinxVerbatim}[commandchars=\\\{\}]
 586 sat config \PYGZlt{}application\PYGZgt{} \PYGZhy{}e
 587 \PYG{c+c1}{\PYGZsh{} and edit the product section:}
 588 \PYG{c+c1}{\PYGZsh{}   \PYGZlt{}product\PYGZgt{} : \PYGZob{}tag : \PYGZdq{}my\PYGZus{}tag\PYGZdq{}, dev : \PYGZdq{}yes\PYGZdq{}, debug : \PYGZdq{}yes\PYGZdq{}\PYGZcb{}}
 589 \end{sphinxVerbatim}
 590
 591 The first time you will execute the \sphinxstyleemphasis{sat prepare} command,
 592 your module will be downloaded in \sphinxstyleemphasis{checkout} mode
 593 (inside the SOURCES directory of the application.
 594 Then, you can develop in this repository, and finally push
 595 them in the base when they are ready.
 596 If you type during the development process by mistake
 597 a \sphinxstyleemphasis{sat prepare} command, the sources in dev mode will
 598 not be altered/removed (Unless you use -f option)
 599
 600
 601 \subsection{Usage}
 602 \label{\detokenize{commands/prepare:usage}}\begin{itemize}
 603 \item {}
 604 Prepare the sources of a complete application in SOURCES directory (all products):
 605
 606 \fvset{hllines={, ,}}%
 607 \begin{sphinxVerbatim}[commandchars=\\\{\}]
 608 \PYG{n}{sat} \PYG{n}{prepare} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}}
 609 \end{sphinxVerbatim}
 610
 611 \item {}
 612 Prepare only some modules:
 613
 614 \fvset{hllines={, ,}}%
 615 \begin{sphinxVerbatim}[commandchars=\\\{\}]
 616 \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}{.}
 617 \end{sphinxVerbatim}
 618
 619 \item {}
 620 Use \textendash{}force to force to prepare the products in development mode
 621 (this will remove the sources and do a new clone/checkout):
 622
 623 \fvset{hllines={, ,}}%
 624 \begin{sphinxVerbatim}[commandchars=\\\{\}]
 625 \PYG{n}{sat} \PYG{n}{prepare} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{force}
 626 \end{sphinxVerbatim}
 627
 628 \item {}
 629 Use \textendash{}force\_patch to force to apply patch to the products
 630 in development mode (otherwise they are not applied):
 631
 632 \fvset{hllines={, ,}}%
 633 \begin{sphinxVerbatim}[commandchars=\\\{\}]
 634 \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}
 635 \end{sphinxVerbatim}
 636
 637 \end{itemize}
 638
 639
 640 \subsection{Some useful configuration pathes}
 641 \label{\detokenize{commands/prepare:some-useful-configuration-pathes}}
 642 Command \sphinxstyleemphasis{sat prepare} uses the \sphinxstyleemphasis{pyconf file configuration} of each product to know how to get the sources.
 643
 644 \begin{sphinxadmonition}{note}{Note:}
 645 to verify configuration of a product, and get name of this \sphinxstyleemphasis{pyconf files configuration}
 646
 647 \fvset{hllines={, ,}}%
 648 \begin{sphinxVerbatim}[commandchars=\\\{\}]
 649 sat config \PYGZlt{}application\PYGZgt{} \PYGZhy{}\PYGZhy{}info \PYGZlt{}product\PYGZgt{}
 650 \end{sphinxVerbatim}
 651 \end{sphinxadmonition}
 652 \begin{itemize}
 653 \item {}
 654 \sphinxstylestrong{get\_method}: the method to use to prepare the module, possible values are cvs, git, archive, dir.
 655
 656 \item {}
 657 \sphinxstylestrong{git\_info} : (used if get\_method = git) information to prepare sources from git.
 658
 659 \item {}
 660 \sphinxstylestrong{svn\_info} : (used if get\_method = svn) information to prepare sources from cvs.
 661
 662 \item {}
 663 \sphinxstylestrong{cvs\_info} : (used if get\_method = cvs) information to prepare sources from cvs.
 664
 665 \item {}
 666 \sphinxstylestrong{archive\_info} : (used if get\_method = archive) the path to the archive.
 667
 668 \item {}
 669 \sphinxstylestrong{dir\_info} : (used if get\_method = dir) the directory with the sources.
 670
 671 \end{itemize}
 672
 673 \clearpage
 674
 675
 676 \section{Command compile}
 677 \label{\detokenize{commands/compile:svn}}\label{\detokenize{commands/compile:command-compile}}\label{\detokenize{commands/compile::doc}}
 678
 679 \subsection{Description}
 680 \label{\detokenize{commands/compile:description}}
 681 The \sphinxstylestrong{compile} command allows compiling the products of a \sphinxhref{http://www.salome-platform.org}{SALOME}%
 682 \begin{footnote}[5]\sphinxAtStartFootnote
 683 \sphinxnolinkurl{http://www.salome-platform.org}
 684 %
 685 \end{footnote} application.
 686
 687
 688 \subsection{Usage}
 689 \label{\detokenize{commands/compile:usage}}\begin{itemize}
 690 \item {}
 691 Compile a complete application:
 692
 693 \fvset{hllines={, ,}}%
 694 \begin{sphinxVerbatim}[commandchars=\\\{\}]
 695 \PYG{n}{sat} \PYG{n+nb}{compile} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}}
 696 \end{sphinxVerbatim}
 697
 698 \item {}
 699 Compile only some products:
 700
 701 \fvset{hllines={, ,}}%
 702 \begin{sphinxVerbatim}[commandchars=\\\{\}]
 703 \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}{.}
 704 \end{sphinxVerbatim}
 705
 706 \item {}
 707 Use \sphinxstyleemphasis{sat -t} to duplicate the logs in the terminal (by default the log are stored and displayed with \sphinxstyleemphasis{sat log} command):
 708
 709 \fvset{hllines={, ,}}%
 710 \begin{sphinxVerbatim}[commandchars=\\\{\}]
 711 \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{}}
 712 \end{sphinxVerbatim}
 713
 714 \item {}
 715 Compile a module and its dependencies:
 716
 717 \fvset{hllines={, ,}}%
 718 \begin{sphinxVerbatim}[commandchars=\\\{\}]
 719 \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}
 720 \end{sphinxVerbatim}
 721
 722 \item {}
 723 Compile a module and the modules depending on it (for example plugins):
 724
 725 \fvset{hllines={, ,}}%
 726 \begin{sphinxVerbatim}[commandchars=\\\{\}]
 727 \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}
 728 \end{sphinxVerbatim}
 729
 730 \item {}
 731 Clean the build and install directories before starting compilation:
 732
 733 \fvset{hllines={, ,}}%
 734 \begin{sphinxVerbatim}[commandchars=\\\{\}]
 735 \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}
 736 \end{sphinxVerbatim}
 737
 738 \begin{sphinxadmonition}{note}{Note:}
 739 \begin{DUlineblock}{0em}
 740 \item[] a warning will be shown if option \sphinxstyleemphasis{\textendash{}products} is missing
 741 \item[] (as it will clean everything)
 742 \end{DUlineblock}
 743 \end{sphinxadmonition}
 744
 745 \item {}
 746 Clean only the install directories before starting compilation:
 747
 748 \fvset{hllines={, ,}}%
 749 \begin{sphinxVerbatim}[commandchars=\\\{\}]
 750 \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}
 751 \end{sphinxVerbatim}
 752
 753 \item {}
 754 Add options for make:
 755
 756 \fvset{hllines={, ,}}%
 757 \begin{sphinxVerbatim}[commandchars=\\\{\}]
 758 \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{}}
 759 \end{sphinxVerbatim}
 760
 761 \item {}
 762 Use the \sphinxstyleemphasis{\textendash{}check} option to execute the unit tests after compilation:
 763
 764 \fvset{hllines={, ,}}%
 765 \begin{sphinxVerbatim}[commandchars=\\\{\}]
 766 \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}
 767 \end{sphinxVerbatim}
 768
 769 \item {}
 770 Remove the build directory after successful compilation (some build directory like qt are big):
 771
 772 \fvset{hllines={, ,}}%
 773 \begin{sphinxVerbatim}[commandchars=\\\{\}]
 774 \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}
 775 \end{sphinxVerbatim}
 776
 777 \item {}
 778 Stop the compilation as soon as the compilation of a module fails:
 779
 780 \fvset{hllines={, ,}}%
 781 \begin{sphinxVerbatim}[commandchars=\\\{\}]
 782 \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}
 783 \end{sphinxVerbatim}
 784
 785 \item {}
 786 Do not compile, just show if products are installed or not, and where is the installation:
 787
 788 \fvset{hllines={, ,}}%
 789 \begin{sphinxVerbatim}[commandchars=\\\{\}]
 790 \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}
 791 \end{sphinxVerbatim}
 792
 793 \end{itemize}
 794
 795
 796 \subsection{Some useful configuration pathes}
 797 \label{\detokenize{commands/compile:some-useful-configuration-pathes}}
 798 The way to compile a product is defined in the \sphinxstyleemphasis{pyconf file configuration}.
 799 The main options are:
 800 \begin{itemize}
 801 \item {}
 802 \sphinxstylestrong{build\_source} : the method used to build the product (cmake/autotools/script)
 803
 804 \item {}
 805 \sphinxstylestrong{compil\_script} : the compilation script if build\_source is equal to “script”
 806
 807 \item {}
 808 \sphinxstylestrong{cmake\_options} : additional options for cmake.
 809
 810 \item {}
 811 \sphinxstylestrong{nb\_proc} : number of jobs to use with make for this product.
 812
 813 \end{itemize}
 814
 815 \clearpage
 816
 817
 818 \section{Command launcher}
 819 \label{\detokenize{commands/launcher:svn}}\label{\detokenize{commands/launcher:command-launcher}}\label{\detokenize{commands/launcher::doc}}
 820
 821 \subsection{Description}
 822 \label{\detokenize{commands/launcher:description}}
 823 The \sphinxstylestrong{launcher} command creates a SALOME launcher, a python script file to start \sphinxhref{http://www.salome-platform.org}{SALOME}%
 824 \begin{footnote}[6]\sphinxAtStartFootnote
 825 \sphinxnolinkurl{http://www.salome-platform.org}
 826 %
 827 \end{footnote}.
 828
 829
 830 \subsection{Usage}
 831 \label{\detokenize{commands/launcher:usage}}\begin{itemize}
 832 \item {}
 833 Create a launcher:
 834
 835 \fvset{hllines={, ,}}%
 836 \begin{sphinxVerbatim}[commandchars=\\\{\}]
 837 \PYG{n}{sat} \PYG{n}{launcher} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}}
 838 \end{sphinxVerbatim}
 839
 840 Generate a launcher in the application directory, i.e \sphinxcode{\sphinxupquote{\$APPLICATION.workdir}}.
 841
 842 \item {}
 843 Create a launcher with a given name (default name is \sphinxcode{\sphinxupquote{APPLICATION.profile.launcher\_name}})
 844
 845 \fvset{hllines={, ,}}%
 846 \begin{sphinxVerbatim}[commandchars=\\\{\}]
 847 \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}
 848 \end{sphinxVerbatim}
 849
 850 The launcher will be called \sphinxstyleemphasis{ZeLauncher}.
 851
 852 \item {}
 853 Set a specific resources catalog:
 854
 855 \fvset{hllines={, ,}}%
 856 \begin{sphinxVerbatim}[commandchars=\\\{\}]
 857 \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{}}
 858 \end{sphinxVerbatim}
 859
 860 Note that the catalog specified will be copied to the profile directory.
 861
 862 \item {}
 863 Generate the catalog for a list of machines:
 864
 865 \fvset{hllines={, ,}}%
 866 \begin{sphinxVerbatim}[commandchars=\\\{\}]
 867 \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{}}
 868 \end{sphinxVerbatim}
 869
 870 This will create a catalog by querying each machine (memory, number of processor) with ssh.
 871
 872 \item {}
 873 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):
 874
 875 \fvset{hllines={, ,}}%
 876 \begin{sphinxVerbatim}[commandchars=\\\{\}]
 877 \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}
 878 \end{sphinxVerbatim}
 879
 880 \end{itemize}
 881
 882
 883 \subsection{Configuration}
 884 \label{\detokenize{commands/launcher:configuration}}
 885 Some useful configuration pathes:
 886 \begin{itemize}
 887 \item {}
 888 \sphinxstylestrong{APPLICATION.profile}
 889 \begin{itemize}
 890 \item {}
 891 \sphinxstylestrong{product} : the name of the profile product (the product in charge of holding the application stuff, like logos, splashscreen)
 892
 893 \item {}
 894 \sphinxstylestrong{launcher\_name} : the name of the launcher.
 895
 896 \end{itemize}
 897
 898 \end{itemize}
 899
 900 \clearpage
 901
 902
 903 \section{Command application}
 904 \label{\detokenize{commands/application:svn}}\label{\detokenize{commands/application::doc}}\label{\detokenize{commands/application:command-application}}
 905
 906 \subsection{Description}
 907 \label{\detokenize{commands/application:description}}
 908 The \sphinxstylestrong{application} command creates a virtual \sphinxhref{http://www.salome-platform.org}{SALOME}%
 909 \begin{footnote}[7]\sphinxAtStartFootnote
 910 \sphinxnolinkurl{http://www.salome-platform.org}
 911 %
 912 \end{footnote} application.
 913 Virtual SALOME applications are used to start SALOME when distribution is needed.
 914
 915
 916 \subsection{Usage}
 917 \label{\detokenize{commands/application:usage}}\begin{itemize}
 918 \item {}
 919 Create an application:
 920
 921 \fvset{hllines={, ,}}%
 922 \begin{sphinxVerbatim}[commandchars=\\\{\}]
 923 \PYG{n}{sat} \PYG{n}{application} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}}
 924 \end{sphinxVerbatim}
 925
 926 Create the virtual application directory in the salomeTool application directory \sphinxcode{\sphinxupquote{\$APPLICATION.workdir}}.
 927
 928 \item {}
 929 Give a name to the application:
 930
 931 \fvset{hllines={, ,}}%
 932 \begin{sphinxVerbatim}[commandchars=\\\{\}]
 933 \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{}}
 934 \end{sphinxVerbatim}
 935
 936 \sphinxstyleemphasis{Remark}: this option overrides the name given in the virtual\_app section of the configuration file \sphinxcode{\sphinxupquote{\$APPLICATION.virtual\_app.name}}.
 937
 938 \item {}
 939 Change the directory where the application is created:
 940
 941 \fvset{hllines={, ,}}%
 942 \begin{sphinxVerbatim}[commandchars=\\\{\}]
 943 \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{}}
 944 \end{sphinxVerbatim}
 945
 946 \item {}
 947 Set a specific \sphinxhref{http://www.salome-platform.org}{SALOME}%
 948 \begin{footnote}[8]\sphinxAtStartFootnote
 949 \sphinxnolinkurl{http://www.salome-platform.org}
 950 %
 951 \end{footnote} resources catalog (it will be used for the distribution of components on distant machines):
 952
 953 \fvset{hllines={, ,}}%
 954 \begin{sphinxVerbatim}[commandchars=\\\{\}]
 955 \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{}}
 956 \end{sphinxVerbatim}
 957
 958 Note that the catalog specified will be copied to the application directory.
 959
 960 \item {}
 961 Generate the catalog for a list of machines:
 962
 963 \fvset{hllines={, ,}}%
 964 \begin{sphinxVerbatim}[commandchars=\\\{\}]
 965 \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}
 966 \end{sphinxVerbatim}
 967
 968 This will create a catalog by querying each machine through ssh protocol (memory, number of processor) with ssh.
 969
 970 \item {}
 971 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):
 972
 973 \fvset{hllines={, ,}}%
 974 \begin{sphinxVerbatim}[commandchars=\\\{\}]
 975 \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}
 976 \end{sphinxVerbatim}
 977
 978 \end{itemize}
 979
 980
 981 \subsection{Some useful configuration pathes}
 982 \label{\detokenize{commands/application:some-useful-configuration-pathes}}
 983 The virtual application can be configured with the virtual\_app section of the configutation file.
 984 \begin{itemize}
 985 \item {}
 986 \sphinxstylestrong{APPLICATION.virtual\_app}
 987 \begin{itemize}
 988 \item {}
 989 \sphinxstylestrong{name} : name of the launcher (to replace the default runAppli).
 990
 991 \item {}
 992 \sphinxstylestrong{application\_name} : (optional) the name of the virtual application directory, if missing the default value is \sphinxcode{\sphinxupquote{\$name + \_appli}}.
 993
 994 \end{itemize}
 995
 996 \end{itemize}
 997
 998 \clearpage
 999
1000
1001 \section{Command log}
1002 \label{\detokenize{commands/log:svn}}\label{\detokenize{commands/log:command-log}}\label{\detokenize{commands/log::doc}}
1003
1004 \subsection{Description}
1005 \label{\detokenize{commands/log:description}}
1006 The \sphinxstylestrong{log} command displays sat log in a web browser or in a terminal.
1007
1008
1009 \subsection{Usage}
1010 \label{\detokenize{commands/log:usage}}\begin{itemize}
1011 \item {}
1012 Show (in a web browser) the log of the commands corresponding to an application:
1013
1014 \fvset{hllines={, ,}}%
1015 \begin{sphinxVerbatim}[commandchars=\\\{\}]
1016 \PYG{n}{sat} \PYG{n}{log} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}}
1017 \end{sphinxVerbatim}
1018
1019 \item {}
1020 Show the log for commands that do not use any application:
1021
1022 \fvset{hllines={, ,}}%
1023 \begin{sphinxVerbatim}[commandchars=\\\{\}]
1024 \PYG{n}{sat} \PYG{n}{log}
1025 \end{sphinxVerbatim}
1026
1027 \item {}
1028 The \textendash{}terminal (or -t) display the log directly in the terminal, through a \sphinxhref{https://en.wikipedia.org/wiki/Command-line\_interface}{CLI}%
1029 \begin{footnote}[9]\sphinxAtStartFootnote
1030 \sphinxnolinkurl{https://en.wikipedia.org/wiki/Command-line\_interface}
1031 %
1032 \end{footnote} interactive menu:
1033
1034 \fvset{hllines={, ,}}%
1035 \begin{sphinxVerbatim}[commandchars=\\\{\}]
1036 \PYG{n}{sat} \PYG{n}{log} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{terminal}
1037 \end{sphinxVerbatim}
1038
1039 \item {}
1040 The \textendash{}last option displays only the last command:
1041
1042 \fvset{hllines={, ,}}%
1043 \begin{sphinxVerbatim}[commandchars=\\\{\}]
1044 \PYG{n}{sat} \PYG{n}{log} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{last}
1045 \end{sphinxVerbatim}
1046
1047 \item {}
1048 To access the last compilation log in terminal mode, use \textendash{}last\_terminal option:
1049
1050 \fvset{hllines={, ,}}%
1051 \begin{sphinxVerbatim}[commandchars=\\\{\}]
1052 \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}
1053 \end{sphinxVerbatim}
1054
1055 \item {}
1056 The \textendash{}clean (int) option erases the n older log files and print the number of remaining log files:
1057
1058 \fvset{hllines={, ,}}%
1059 \begin{sphinxVerbatim}[commandchars=\\\{\}]
1060 \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}
1061 \end{sphinxVerbatim}
1062
1063 \end{itemize}
1064
1065
1066 \subsection{Some useful configuration pathes}
1067 \label{\detokenize{commands/log:some-useful-configuration-pathes}}\begin{itemize}
1068 \item {}
1069 \sphinxstylestrong{USER}
1070 \begin{itemize}
1071 \item {}
1072 \sphinxstylestrong{browser} : The browser used to show the log (by default \sphinxstyleemphasis{firefox}).
1073
1074 \item {}
1075 \sphinxstylestrong{log\_dir} : The directory used to store the log files.
1076
1077 \end{itemize}
1078
1079 \end{itemize}
1080
1081 \clearpage
1082
1083
1084 \section{Command environ}
1085 \label{\detokenize{commands/environ:svn}}\label{\detokenize{commands/environ:command-environ}}\label{\detokenize{commands/environ::doc}}
1086
1087 \subsection{Description}
1088 \label{\detokenize{commands/environ:description}}
1089 The \sphinxstylestrong{environ} command generates the environment files used
1090 to run and compile your application (as \sphinxhref{http://www.salome-platform.org}{SALOME}%
1091 \begin{footnote}[10]\sphinxAtStartFootnote
1092 \sphinxnolinkurl{http://www.salome-platform.org}
1093 %
1094 \end{footnote} is an example).
1095
1096 \begin{sphinxadmonition}{note}{Note:}
1097 these files are \sphinxstylestrong{not} required,
1098 salomeTool set the environment himself, when compiling.
1099 And so does the salome launcher.
1100
1101 These files are useful when someone wants to check the environment.
1102 They could be used in debug mode to set the environment for \sphinxstyleemphasis{gdb}.
1103 \end{sphinxadmonition}
1104
1105 The configuration part at the end of this page explains how
1106 to specify the environment used by sat (at build or run time),
1107 and saved in some files by \sphinxstyleemphasis{sat environ} command.
1108
1109
1110 \subsection{Usage}
1111 \label{\detokenize{commands/environ:usage}}\begin{itemize}
1112 \item {}
1113 Create the shell environment files of the application:
1114
1115 \fvset{hllines={, ,}}%
1116 \begin{sphinxVerbatim}[commandchars=\\\{\}]
1117 \PYG{n}{sat} \PYG{n}{environ} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}}
1118 \end{sphinxVerbatim}
1119
1120 \item {}
1121 Create the environment files of the application for a given shell.
1122 Options are bash, bat (for windows) and cfg (the configuration format used by \sphinxhref{http://www.salome-platform.org}{SALOME}%
1123 \begin{footnote}[11]\sphinxAtStartFootnote
1124 \sphinxnolinkurl{http://www.salome-platform.org}
1125 %
1126 \end{footnote}):
1127
1128 \fvset{hllines={, ,}}%
1129 \begin{sphinxVerbatim}[commandchars=\\\{\}]
1130 \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}{]}
1131 \end{sphinxVerbatim}
1132
1133 \item {}
1134 Use a different prefix for the files (default is ‘env’):
1135
1136 \fvset{hllines={, ,}}%
1137 \begin{sphinxVerbatim}[commandchars=\\\{\}]
1138 \PYG{c+c1}{\PYGZsh{} This will create file \PYGZlt{}prefix\PYGZgt{}\PYGZus{}launch.sh, \PYGZlt{}prefix\PYGZgt{}\PYGZus{}build.sh}
1139 sat environ \PYGZlt{}application\PYGZgt{} \PYGZhy{}\PYGZhy{}prefix \PYGZlt{}prefix\PYGZgt{}
1140 \end{sphinxVerbatim}
1141
1142 \item {}
1143 Use a different target directory for the files:
1144
1145 \fvset{hllines={, ,}}%
1146 \begin{sphinxVerbatim}[commandchars=\\\{\}]
1147 \PYG{c+c1}{\PYGZsh{} This will create file env\PYGZus{}launch.sh, env\PYGZus{}build.sh}
1148 \PYG{c+c1}{\PYGZsh{} in the directory corresponding to \PYGZlt{}path\PYGZgt{}}
1149 sat environ \PYGZlt{}application\PYGZgt{} \PYGZhy{}\PYGZhy{}target \PYGZlt{}path\PYGZgt{}
1150 \end{sphinxVerbatim}
1151
1152 \item {}
1153 Generate the environment files only with the given products:
1154
1155 \fvset{hllines={, ,}}%
1156 \begin{sphinxVerbatim}[commandchars=\\\{\}]
1157 \PYG{c+c1}{\PYGZsh{} This will create the environment files only for the given products}
1158 \PYG{c+c1}{\PYGZsh{} and their prerequisites.}
1159 \PYG{c+c1}{\PYGZsh{} It is useful when you want to visualise which environment uses}
1160 \PYG{c+c1}{\PYGZsh{} sat to compile a given product.}
1161 sat environ \PYGZlt{}application\PYGZgt{} \PYGZhy{}\PYGZhy{}product \PYGZlt{}product1\PYGZgt{},\PYGZlt{}product2\PYGZgt{}, ...
1162 \end{sphinxVerbatim}
1163
1164 \end{itemize}
1165
1166
1167 \subsection{Configuration}
1168 \label{\detokenize{commands/environ:configuration}}
1169 The specification of the environment can be done through several mechanisms.
1170 \begin{enumerate}
1171 \item {}
1172 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}%
1173 \begin{footnote}[12]\sphinxAtStartFootnote
1174 \sphinxnolinkurl{http://www.salome-platform.org}
1175 %
1176 \end{footnote} requirements.
1177
1178 \item {}
1179 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.
1180
1181 \end{enumerate}
1182
1183 Within the section, the user can define environment variables. He can also modify PATH variables, by appending or prepending directories.
1184 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{}}:
1185
1186 \fvset{hllines={, ,}}%
1187 \begin{sphinxVerbatim}[commandchars=\\\{\}]
1188 environ :
1189 \PYG{o}{\PYGZob{}}
1190   \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{}}
1191   PYTHONPATH\PYGZus{} : \PYG{n+nv}{\PYGZdl{}install\PYGZus{}dir} + \PYG{n+nv}{\PYGZdl{}VARS}.sep + \PYG{l+s+s2}{\PYGZdq{}lib\PYGZdq{}}
1192   LAPACK\PYGZus{}ROOT\PYGZus{}DIR : \PYG{n+nv}{\PYGZdl{}install\PYGZus{}dir}
1193 \PYG{o}{\PYGZcb{}}
1194 \end{sphinxVerbatim}
1195
1196 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:
1197
1198 \fvset{hllines={, ,}}%
1199 \begin{sphinxVerbatim}[commandchars=\\\{\}]
1200 environ :
1201 \PYG{o}{\PYGZob{}}
1202   build :
1203   \PYG{o}{\PYGZob{}}
1204     LAPACK\PYGZus{}ROOT\PYGZus{}DIR : \PYG{n+nv}{\PYGZdl{}install\PYGZus{}dir}
1205   \PYG{o}{\PYGZcb{}}
1206   launch :
1207   \PYG{o}{\PYGZob{}}
1208     LAPACK\PYGZus{}ROOT\PYGZus{}DIR : \PYG{n+nv}{\PYGZdl{}install\PYGZus{}dir}
1209     \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{}}
1210     PYTHONPATH\PYGZus{} : \PYG{n+nv}{\PYGZdl{}install\PYGZus{}dir} + \PYG{n+nv}{\PYGZdl{}VARS}.sep + \PYG{l+s+s2}{\PYGZdq{}lib\PYGZdq{}}
1211   \PYG{o}{\PYGZcb{}}
1212 \PYG{o}{\PYGZcb{}}
1213 \end{sphinxVerbatim}
1214 \begin{enumerate}
1215 \setcounter{enumi}{2}
1216 \item {}
1217 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}}:
1218
1219 \end{enumerate}
1220
1221 \fvset{hllines={, ,}}%
1222 \begin{sphinxVerbatim}[commandchars=\\\{\}]
1223 \PYG{n}{environ} \PYG{p}{:}
1224 \PYG{p}{\PYGZob{}}
1225   \PYG{n}{env\PYGZus{}script} \PYG{p}{:} \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{lapack.py}\PYG{l+s+s1}{\PYGZsq{}}
1226 \PYG{p}{\PYGZcb{}}
1227 \end{sphinxVerbatim}
1228
1229 Please note that the two modes are complementary and are both taken into account.
1230 Most of the time, the first mode is sufficient.
1231
1232 The second mode can be used when the environment has to be set programmatically.
1233 The developer implements a handle (as a python method)
1234 which is called by sat to set the environment.
1235 Here is an example:
1236
1237 \fvset{hllines={, ,}}%
1238 \begin{sphinxVerbatim}[commandchars=\\\{\}]
1239 \PYG{c+ch}{\PYGZsh{}!/usr/bin/env python}
1240 \PYG{c+c1}{\PYGZsh{}\PYGZhy{}*\PYGZhy{} coding:utf\PYGZhy{}8 \PYGZhy{}*\PYGZhy{}}
1241
1242 \PYG{k+kn}{import} \PYG{n+nn}{os.path}
1243 \PYG{k+kn}{import} \PYG{n+nn}{platform}
1244
1245 \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}{:}
1246     \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}{)}
1247     \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}{)}
1248     \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}{)}
1249     \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}{)}
1250     \PYG{k}{return}
1251 \end{sphinxVerbatim}
1252
1253 SalomeTools defines four handles:
1254 \begin{itemize}
1255 \item {}
1256 \sphinxstylestrong{set\_env(env, prereq\_dir, version)} : used at build and run time.
1257
1258 \item {}
1259 \sphinxstylestrong{set\_env\_launch(env, prereq\_dir, version)} : used only at run time (if defined!)
1260
1261 \item {}
1262 \sphinxstylestrong{set\_env\_build(env, prereq\_dir, version)} : used only at build time (if defined!)
1263
1264 \item {}
1265 \sphinxstylestrong{set\_native\_env(env)} : used only for native products, at build and run time.
1266
1267 \end{itemize}
1268
1269 \clearpage
1270
1271
1272 \section{Command clean}
1273 \label{\detokenize{commands/clean:svn}}\label{\detokenize{commands/clean:command-clean}}\label{\detokenize{commands/clean::doc}}
1274
1275 \subsection{Description}
1276 \label{\detokenize{commands/clean:description}}
1277 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}}.
1278
1279 Use the options to define what directories you want to suppress and to set the list of products
1280
1281
1282 \subsection{Usage}
1283 \label{\detokenize{commands/clean:usage}}\begin{itemize}
1284 \item {}
1285 Clean all previously created \sphinxstyleemphasis{build} and \sphinxstyleemphasis{install} directories (example application as \sphinxstyleemphasis{SALOME\_xx}):
1286
1287 \fvset{hllines={, ,}}%
1288 \begin{sphinxVerbatim}[commandchars=\\\{\}]
1289 \PYG{c+c1}{\PYGZsh{} take care, is long time to restore, sometimes}
1290 sat clean SALOME\PYGZhy{}xx \PYGZhy{}\PYGZhy{}build \PYGZhy{}\PYGZhy{}install
1291 \end{sphinxVerbatim}
1292
1293 \item {}
1294 Clean previously created \sphinxstyleemphasis{build} and \sphinxstyleemphasis{install} directories, only for products with property \sphinxstyleemphasis{is\_salome\_module}:
1295
1296 \fvset{hllines={, ,}}%
1297 \begin{sphinxVerbatim}[commandchars=\\\{\}]
1298 sat clean SALOME\PYGZhy{}xxx \PYGZhy{}\PYGZhy{}build \PYGZhy{}\PYGZhy{}install \PYG{l+s+se}{\PYGZbs{}}
1299                      \PYGZhy{}\PYGZhy{}properties is\PYGZus{}salome\PYGZus{}module:yes
1300 \end{sphinxVerbatim}
1301
1302 \end{itemize}
1303
1304
1305 \subsection{Availables options}
1306 \label{\detokenize{commands/clean:availables-options}}\begin{itemize}
1307 \item {}
1308 \sphinxstylestrong{\textendash{}products} : Products to clean.
1309
1310 \item {}
1311 \sphinxstylestrong{\textendash{}properties} :
1312
1313 \begin{DUlineblock}{0em}
1314 \item[] Filter the products by their properties.
1315 \item[] Syntax: \sphinxstyleemphasis{\textendash{}properties \textless{}property\textgreater{}:\textless{}value\textgreater{}}
1316 \end{DUlineblock}
1317
1318 \item {}
1319 \sphinxstylestrong{\textendash{}sources} : Clean the product source directories.
1320
1321 \item {}
1322 \sphinxstylestrong{\textendash{}build} : Clean the product build directories.
1323
1324 \item {}
1325 \sphinxstylestrong{\textendash{}install} : Clean the product install directories.
1326
1327 \item {}
1328 \sphinxstylestrong{\textendash{}all} : Clean the product source, build and install directories.
1329
1330 \item {}
1331 \sphinxstylestrong{\textendash{}sources\_without\_dev} :
1332
1333 \begin{DUlineblock}{0em}
1334 \item[] Do not clean the products in development mode,
1335 \item[] (they could have \sphinxhref{https://en.wikipedia.org/wiki/Version\_control}{VCS}%
1336 \begin{footnote}[13]\sphinxAtStartFootnote
1337 \sphinxnolinkurl{https://en.wikipedia.org/wiki/Version\_control}
1338 %
1339 \end{footnote} commits pending).
1340 \end{DUlineblock}
1341
1342 \end{itemize}
1343
1344
1345 \subsection{Some useful configuration pathes}
1346 \label{\detokenize{commands/clean:some-useful-configuration-pathes}}
1347 No specific configuration.
1348
1349 \clearpage
1350
1351
1352 \section{Command package}
1353 \label{\detokenize{commands/package:svn}}\label{\detokenize{commands/package:command-package}}\label{\detokenize{commands/package::doc}}
1354
1355 \subsection{Description}
1356 \label{\detokenize{commands/package:description}}
1357 The \sphinxstylestrong{package} command creates a \sphinxhref{http://www.salome-platform.org}{SALOME}%
1358 \begin{footnote}[14]\sphinxAtStartFootnote
1359 \sphinxnolinkurl{http://www.salome-platform.org}
1360 %
1361 \end{footnote} archive (usually a compressed \sphinxhref{https://en.wikipedia.org/wiki/Tar\_(computing)}{Tar}%
1362 \begin{footnote}[15]\sphinxAtStartFootnote
1363 \sphinxnolinkurl{https://en.wikipedia.org/wiki/Tar\_(computing)}
1364 %
1365 \end{footnote} file .tgz).
1366 This tar file is used later to intall SALOME on other remote computer.
1367
1368 Depending on the selected options, the archive includes sources and binaries
1369 of SALOME products and prerequisites.
1370
1371 Usually utility \sphinxstyleemphasis{salomeTools} is included in the archive.
1372
1373 \begin{sphinxadmonition}{note}{Note:}
1374 By default the package includes the sources of prerequisites and products.
1375 To select a subset use the \sphinxstyleemphasis{\textendash{}without\_property} or \sphinxstyleemphasis{\textendash{}with\_vcs} options.
1376 \end{sphinxadmonition}
1377
1378
1379 \subsection{Usage}
1380 \label{\detokenize{commands/package:usage}}\begin{itemize}
1381 \item {}
1382 Create a package for a product (example as \sphinxstyleemphasis{SALOME\_xx}):
1383
1384 \fvset{hllines={, ,}}%
1385 \begin{sphinxVerbatim}[commandchars=\\\{\}]
1386 \PYG{n}{sat} \PYG{n}{package} \PYG{n}{SALOME\PYGZus{}xx}
1387 \end{sphinxVerbatim}
1388
1389 This command will create an archive named \sphinxcode{\sphinxupquote{SALOME\_xx.tgz}}
1390 in the working directory (\sphinxcode{\sphinxupquote{USER.workDir}}).
1391 If the archive already exists, do nothing.
1392
1393 \item {}
1394 Create a package with a specific name:
1395
1396 \fvset{hllines={, ,}}%
1397 \begin{sphinxVerbatim}[commandchars=\\\{\}]
1398 \PYG{n}{sat} \PYG{n}{package} \PYG{n}{SALOME\PYGZus{}xx} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{name} \PYG{n}{YourSpecificName}
1399 \end{sphinxVerbatim}
1400
1401 \end{itemize}
1402
1403 \begin{sphinxadmonition}{note}{Note:}
1404 By default, the archive is created in the working directory of the user (\sphinxcode{\sphinxupquote{USER.workDir}}).
1405
1406 If the option \sphinxstyleemphasis{\textendash{}name} is used with a path (relative or absolute) it will be used.
1407
1408 If the option \sphinxstyleemphasis{\textendash{}name} is not used and binaries (prerequisites and products)
1409 are included in the package, the \sphinxhref{https://en.wikipedia.org/wiki/Operating\_system}{OS}%
1410 \begin{footnote}[16]\sphinxAtStartFootnote
1411 \sphinxnolinkurl{https://en.wikipedia.org/wiki/Operating\_system}
1412 %
1413 \end{footnote} architecture
1414 will be appended to the name (example: \sphinxcode{\sphinxupquote{SALOME\_xx-CO7.tgz}}).
1415
1416 Examples:
1417
1418 \fvset{hllines={, ,}}%
1419 \begin{sphinxVerbatim}[commandchars=\\\{\}]
1420 \PYG{c+c1}{\PYGZsh{} Creates SALOME\PYGZus{}xx.tgz in \PYGZdl{}USER.workDir}
1421 \PYG{n}{sat} \PYG{n}{package} \PYG{n}{SALOME\PYGZus{}xx}
1422
1423 \PYG{c+c1}{\PYGZsh{} Creates SALOME\PYGZus{}xx\PYGZus{}\PYGZlt{}arch\PYGZgt{}.tgz in \PYGZdl{}USER.workDir}
1424 \PYG{n}{sat} \PYG{n}{package} \PYG{n}{SALOME\PYGZus{}xx} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{binaries}
1425
1426 \PYG{c+c1}{\PYGZsh{} Creates MySpecificName.tgz in \PYGZdl{}USER.workDir}
1427 \PYG{n}{sat} \PYG{n}{package} \PYG{n}{SALOME\PYGZus{}xx} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{name} \PYG{n}{MySpecificName}
1428 \end{sphinxVerbatim}
1429 \end{sphinxadmonition}
1430 \begin{itemize}
1431 \item {}
1432 Force the creation of the archive (if it already exists):
1433
1434 \fvset{hllines={, ,}}%
1435 \begin{sphinxVerbatim}[commandchars=\\\{\}]
1436 \PYG{n}{sat} \PYG{n}{package} \PYG{n}{SALOME\PYGZus{}xx} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{force}
1437 \end{sphinxVerbatim}
1438
1439 \item {}
1440 Include the binaries in the archive (products and prerequisites):
1441
1442 \fvset{hllines={, ,}}%
1443 \begin{sphinxVerbatim}[commandchars=\\\{\}]
1444 \PYG{n}{sat} \PYG{n}{package} \PYG{n}{SALOME\PYGZus{}xx} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{binaries}
1445 \end{sphinxVerbatim}
1446
1447 This command will create an archive named \sphinxcode{\sphinxupquote{SALOME\_xx \_\textless{}arch\textgreater{}.tgz}}
1448 where \textless{}arch\textgreater{} is the \sphinxhref{https://en.wikipedia.org/wiki/Operating\_system}{OS}%
1449 \begin{footnote}[17]\sphinxAtStartFootnote
1450 \sphinxnolinkurl{https://en.wikipedia.org/wiki/Operating\_system}
1451 %
1452 \end{footnote} architecture of the machine.
1453
1454 \item {}
1455 Do not delete Version Control System (\sphinxhref{https://en.wikipedia.org/wiki/Version\_control}{VCS}%
1456 \begin{footnote}[18]\sphinxAtStartFootnote
1457 \sphinxnolinkurl{https://en.wikipedia.org/wiki/Version\_control}
1458 %
1459 \end{footnote}) informations from the configurations files of the embedded salomeTools:
1460
1461 \fvset{hllines={, ,}}%
1462 \begin{sphinxVerbatim}[commandchars=\\\{\}]
1463 \PYG{n}{sat} \PYG{n}{package} \PYG{n}{SALOME\PYGZus{}xx} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{with\PYGZus{}vcs}
1464 \end{sphinxVerbatim}
1465
1466 The version control systems known by this option are \sphinxhref{https://fr.wikipedia.org/wiki/Concurrent\_versions\_system}{CVS}%
1467 \begin{footnote}[19]\sphinxAtStartFootnote
1468 \sphinxnolinkurl{https://fr.wikipedia.org/wiki/Concurrent\_versions\_system}
1469 %
1470 \end{footnote}, \sphinxhref{https://en.wikipedia.org/wiki/Apache\_Subversion}{SVN}%
1471 \begin{footnote}[20]\sphinxAtStartFootnote
1472 \sphinxnolinkurl{https://en.wikipedia.org/wiki/Apache\_Subversion}
1473 %
1474 \end{footnote} and \sphinxhref{https://git-scm.com}{Git}%
1475 \begin{footnote}[21]\sphinxAtStartFootnote
1476 \sphinxnolinkurl{https://git-scm.com}
1477 %
1478 \end{footnote}.
1479
1480 \end{itemize}
1481
1482
1483 \subsection{Some useful configuration pathes}
1484 \label{\detokenize{commands/package:some-useful-configuration-pathes}}
1485 No specific configuration.
1486
1487 \clearpage
1488
1489
1490 \section{Command generate}
1491 \label{\detokenize{commands/generate:svn}}\label{\detokenize{commands/generate:command-generate}}\label{\detokenize{commands/generate::doc}}
1492
1493 \subsection{Description}
1494 \label{\detokenize{commands/generate:description}}
1495 The \sphinxstylestrong{generate} command generates and compile SALOME modules from cpp modules using YACSGEN.
1496
1497 \begin{sphinxadmonition}{note}{Note:}
1498 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}}.
1499 \end{sphinxadmonition}
1500
1501
1502 \subsection{Remarks}
1503 \label{\detokenize{commands/generate:remarks}}\begin{itemize}
1504 \item {}
1505 This command will only apply on the CPP modules of the application, those who have both properties:
1506
1507 \fvset{hllines={, ,}}%
1508 \begin{sphinxVerbatim}[commandchars=\\\{\}]
1509 \PYG{n}{cpp} \PYG{p}{:} \PYG{l+s+s2}{\PYGZdq{}}\PYG{l+s+s2}{yes}\PYG{l+s+s2}{\PYGZdq{}}
1510 \PYG{n}{generate} \PYG{p}{:} \PYG{l+s+s2}{\PYGZdq{}}\PYG{l+s+s2}{yes}\PYG{l+s+s2}{\PYGZdq{}}
1511 \end{sphinxVerbatim}
1512
1513 \item {}
1514 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)
1515
1516 \end{itemize}
1517
1518
1519 \subsection{Usage}
1520 \label{\detokenize{commands/generate:usage}}\begin{itemize}
1521 \item {}
1522 Generate all the modules of a product:
1523
1524 \fvset{hllines={, ,}}%
1525 \begin{sphinxVerbatim}[commandchars=\\\{\}]
1526 \PYG{n}{sat} \PYG{n}{generate} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}}
1527 \end{sphinxVerbatim}
1528
1529 \item {}
1530 Generate only specific modules:
1531
1532 \fvset{hllines={, ,}}%
1533 \begin{sphinxVerbatim}[commandchars=\\\{\}]
1534 \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{}}
1535 \end{sphinxVerbatim}
1536
1537 Remark: modules which don’t have the \sphinxstyleemphasis{generate} property are ignored.
1538
1539 \item {}
1540 Use a specific version of YACSGEN:
1541
1542 \fvset{hllines={, ,}}%
1543 \begin{sphinxVerbatim}[commandchars=\\\{\}]
1544 \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{}}
1545 \end{sphinxVerbatim}
1546
1547 \end{itemize}
1548
1549
1550 \chapter{Developer documentation}
1551 \label{\detokenize{index:developer-documentation}}
1552 \clearpage
1553
1554
1555 \section{Add a user custom command}
1556 \label{\detokenize{write_command:svn}}\label{\detokenize{write_command:add-a-user-custom-command}}\label{\detokenize{write_command::doc}}
1557
1558 \subsection{Introduction}
1559 \label{\detokenize{write_command:introduction}}
1560 \begin{sphinxadmonition}{note}{Note:}
1561 This documentation is for \sphinxhref{https://docs.python.org/2.7}{Python}%
1562 \begin{footnote}[22]\sphinxAtStartFootnote
1563 \sphinxnolinkurl{https://docs.python.org/2.7}
1564 %
1565 \end{footnote} developers.
1566 \end{sphinxadmonition}
1567
1568 The salomeTools product provides a simple way to develop commands.
1569 The first thing to do is to add a file with \sphinxstyleemphasis{.py} extension in the \sphinxcode{\sphinxupquote{commands}} directory of salomeTools.
1570
1571 Here are the basic requirements that must be followed in this file in order to add a command.
1572
1573
1574 \subsection{Basic requirements}
1575 \label{\detokenize{write_command:basic-requirements}}
1576 By adding a file \sphinxstyleemphasis{mycommand.py} in the \sphinxcode{\sphinxupquote{commands}} directory, salomeTools will define a new command named \sphinxcode{\sphinxupquote{mycommand}}.
1577
1578 In \sphinxstyleemphasis{mycommand.py}, there must be the following method:
1579
1580 \fvset{hllines={, ,}}%
1581 \begin{sphinxVerbatim}[commandchars=\\\{\}]
1582 \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}{:}
1583     \PYG{c+c1}{\PYGZsh{} your algorithm ...}
1584     \PYG{k}{pass}
1585 \end{sphinxVerbatim}
1586
1587 In fact, at this point, the command will already be functional.
1588 But there are some useful services provided by salomeTools :
1589 \begin{itemize}
1590 \item {}
1591 You can give some options to your command:
1592
1593 \end{itemize}
1594
1595 \fvset{hllines={, ,}}%
1596 \begin{sphinxVerbatim}[commandchars=\\\{\}]
1597 \PYG{k+kn}{import} \PYG{n+nn}{src}
1598
1599 \PYG{c+c1}{\PYGZsh{} Define all possible option for mycommand command :  \PYGZsq{}sat mycommand \PYGZlt{}options\PYGZgt{}\PYGZsq{}}
1600 \PYG{n}{parser} \PYG{o}{=} \PYG{n}{src}\PYG{o}{.}\PYG{n}{options}\PYG{o}{.}\PYG{n}{Options}\PYG{p}{(}\PYG{p}{)}
1601 \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{}
1602                   \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{}
1603                   \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{My option changes the behavior of my command.}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{)}
1604
1605 \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}{:}
1606     \PYG{c+c1}{\PYGZsh{} Parse the options}
1607     \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}{)}
1608     \PYG{c+c1}{\PYGZsh{} algorithm}
1609 \end{sphinxVerbatim}
1610 \begin{itemize}
1611 \item {}
1612 You can add a \sphinxstyleemphasis{description} method that will display a message when the user will call the help:
1613
1614 \end{itemize}
1615
1616 \fvset{hllines={, 9, 10,}}%
1617 \begin{sphinxVerbatim}[commandchars=\\\{\}]
1618  \PYG{k+kn}{import} \PYG{n+nn}{src}
1619
1620  \PYG{c+c1}{\PYGZsh{} Define all possible option for mycommand command : \PYGZsq{}sat mycommand \PYGZlt{}options\PYGZgt{}\PYGZsq{}}
1621  \PYG{n}{parser} \PYG{o}{=} \PYG{n}{src}\PYG{o}{.}\PYG{n}{options}\PYG{o}{.}\PYG{n}{Options}\PYG{p}{(}\PYG{p}{)}
1622  \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{}
1623                    \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{}
1624                    \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{My option changes the behavior of my command.}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{)}
1625
1626  \PYG{k}{def} \PYG{n+nf}{description}\PYG{p}{(}\PYG{p}{)}\PYG{p}{:}
1627      \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}{)}
1628
1629  \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}{:}
1630      \PYG{c+c1}{\PYGZsh{} Parse the options}
1631      \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}{)}
1632      \PYG{c+c1}{\PYGZsh{} algorithm}
1633 \end{sphinxVerbatim}
1634
1635
1636 \subsection{HowTo access salomeTools config and other commands}
1637 \label{\detokenize{write_command:howto-access-salometools-config-and-other-commands}}
1638 The \sphinxstyleemphasis{runner} variable is an python instance of \sphinxstyleemphasis{Sat} class.
1639 It gives access to \sphinxstyleemphasis{runner.cfg} which is the data model defined from all
1640 \sphinxstyleemphasis{configuration pyconf files} of salomeTools
1641 For example, \sphinxstyleemphasis{runner.cfg.APPLICATION.workdir}
1642 contains the root directory of the current application.
1643
1644 The \sphinxstyleemphasis{runner} variable gives also access to other commands of salomeTools:
1645
1646 \fvset{hllines={, ,}}%
1647 \begin{sphinxVerbatim}[commandchars=\\\{\}]
1648 \PYG{c+c1}{\PYGZsh{} as CLI\PYGZus{} \PYGZsq{}sat prepare ...\PYGZsq{}}
1649 \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}{)}
1650 \end{sphinxVerbatim}
1651
1652
1653 \subsection{HowTo logger}
1654 \label{\detokenize{write_command:howto-logger}}
1655 The logger variable is an instance of the Logger class.
1656 It gives access to the write method.
1657
1658 When this method is called, the message passed as parameter
1659 will be displayed in the terminal and written in an xml log file.
1660
1661 \fvset{hllines={, ,}}%
1662 \begin{sphinxVerbatim}[commandchars=\\\{\}]
1663 \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}
1664 \end{sphinxVerbatim}
1665
1666 The second argument defines the level of verbosity
1667 that is wanted for this message.
1668 It has to be between 1 and 5 (the most verbose level).
1669
1670
1671 \subsection{HELLO example}
1672 \label{\detokenize{write_command:hello-example}}
1673 Here is a \sphinxstyleemphasis{hello} command, file \sphinxstyleemphasis{commands/hello.py}:
1674
1675 \fvset{hllines={, ,}}%
1676 \begin{sphinxVerbatim}[commandchars=\\\{\}]
1677 \PYG{k+kn}{import} \PYG{n+nn}{src}
1678
1679 \PYG{l+s+sd}{\PYGZdq{}\PYGZdq{}\PYGZdq{}}
1680 \PYG{l+s+sd}{hello.py}
1681 \PYG{l+s+sd}{Define all possible options for hello command:}
1682 \PYG{l+s+sd}{sat hello \PYGZlt{}options\PYGZgt{}}
1683 \PYG{l+s+sd}{\PYGZdq{}\PYGZdq{}\PYGZdq{}}
1684
1685 \PYG{n}{parser} \PYG{o}{=} \PYG{n}{src}\PYG{o}{.}\PYG{n}{options}\PYG{o}{.}\PYG{n}{Options}\PYG{p}{(}\PYG{p}{)}
1686 \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}{)}
1687
1688 \PYG{k}{def} \PYG{n+nf}{description}\PYG{p}{(}\PYG{p}{)}\PYG{p}{:}
1689     \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}{)}
1690
1691 \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}{:}
1692     \PYG{c+c1}{\PYGZsh{} Parse the options}
1693     \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}{)}
1694     \PYG{c+c1}{\PYGZsh{} algorithm}
1695     \PYG{k}{if} \PYG{o+ow}{not} \PYG{n}{options}\PYG{o}{.}\PYG{n}{french}\PYG{p}{:}
1696         \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}{)}
1697     \PYG{k}{else}\PYG{p}{:}
1698         \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}{)}
1699 \end{sphinxVerbatim}
1700
1701 A first call of hello:
1702
1703 \fvset{hllines={, ,}}%
1704 \begin{sphinxVerbatim}[commandchars=\\\{\}]
1705 \PYG{c+c1}{\PYGZsh{} Get the help of hello:}
1706 ./sat \PYGZhy{}\PYGZhy{}help hello
1707
1708 \PYG{c+c1}{\PYGZsh{} To get bonjour}
1709 ./sat hello \PYGZhy{}\PYGZhy{}french
1710 Bonjour tout le monde!
1711
1712 \PYG{c+c1}{\PYGZsh{} To get hello}
1713 ./sat hello
1714 HELLO! WORLD!
1715
1716 \PYG{c+c1}{\PYGZsh{} To get the log}
1717 ./sat log
1718 \end{sphinxVerbatim}
1719
1720
1721 \chapter{Code documentation}
1722 \label{\detokenize{index:code-documentation}}
1723
1724 \section{src}
1725 \label{\detokenize{commands/apidoc/modules:src}}\label{\detokenize{commands/apidoc/modules::doc}}
1726
1727 \subsection{src package}
1728 \label{\detokenize{commands/apidoc/src::doc}}\label{\detokenize{commands/apidoc/src:src-package}}
1729
1730 \subsubsection{Subpackages}
1731 \label{\detokenize{commands/apidoc/src:subpackages}}
1732
1733 \paragraph{src.colorama package}
1734 \label{\detokenize{commands/apidoc/src.colorama:src-colorama-package}}\label{\detokenize{commands/apidoc/src.colorama::doc}}
1735
1736 \subparagraph{Submodules}
1737 \label{\detokenize{commands/apidoc/src.colorama:submodules}}
1738
1739 \subparagraph{src.colorama.ansi module}
1740 \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)}
1741 This module generates ANSI character codes to printing colors to terminals.
1742 See: \sphinxurl{http://en.wikipedia.org/wiki/ANSI\_escape\_code}
1743 \index{AnsiBack (class in src.colorama.ansi)}
1744
1745 \begin{fulllineitems}
1746 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.colorama.ansi.}}\sphinxbfcode{\sphinxupquote{AnsiBack}}}
1747 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}})
1748 \index{BLACK (src.colorama.ansi.AnsiBack attribute)}
1749
1750 \begin{fulllineitems}
1751 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.BLACK}}\pysigline{\sphinxbfcode{\sphinxupquote{BLACK}}\sphinxbfcode{\sphinxupquote{ = 40}}}
1752 \end{fulllineitems}
1753
1754 \index{BLUE (src.colorama.ansi.AnsiBack attribute)}
1755
1756 \begin{fulllineitems}
1757 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.BLUE}}\pysigline{\sphinxbfcode{\sphinxupquote{BLUE}}\sphinxbfcode{\sphinxupquote{ = 44}}}
1758 \end{fulllineitems}
1759
1760 \index{CYAN (src.colorama.ansi.AnsiBack attribute)}
1761
1762 \begin{fulllineitems}
1763 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.CYAN}}\pysigline{\sphinxbfcode{\sphinxupquote{CYAN}}\sphinxbfcode{\sphinxupquote{ = 46}}}
1764 \end{fulllineitems}
1765
1766 \index{GREEN (src.colorama.ansi.AnsiBack attribute)}
1767
1768 \begin{fulllineitems}
1769 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.GREEN}}\pysigline{\sphinxbfcode{\sphinxupquote{GREEN}}\sphinxbfcode{\sphinxupquote{ = 42}}}
1770 \end{fulllineitems}
1771
1772 \index{LIGHTBLACK\_EX (src.colorama.ansi.AnsiBack attribute)}
1773
1774 \begin{fulllineitems}
1775 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTBLACK_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTBLACK\_EX}}\sphinxbfcode{\sphinxupquote{ = 100}}}
1776 \end{fulllineitems}
1777
1778 \index{LIGHTBLUE\_EX (src.colorama.ansi.AnsiBack attribute)}
1779
1780 \begin{fulllineitems}
1781 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTBLUE_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTBLUE\_EX}}\sphinxbfcode{\sphinxupquote{ = 104}}}
1782 \end{fulllineitems}
1783
1784 \index{LIGHTCYAN\_EX (src.colorama.ansi.AnsiBack attribute)}
1785
1786 \begin{fulllineitems}
1787 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTCYAN_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTCYAN\_EX}}\sphinxbfcode{\sphinxupquote{ = 106}}}
1788 \end{fulllineitems}
1789
1790 \index{LIGHTGREEN\_EX (src.colorama.ansi.AnsiBack attribute)}
1791
1792 \begin{fulllineitems}
1793 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTGREEN_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTGREEN\_EX}}\sphinxbfcode{\sphinxupquote{ = 102}}}
1794 \end{fulllineitems}
1795
1796 \index{LIGHTMAGENTA\_EX (src.colorama.ansi.AnsiBack attribute)}
1797
1798 \begin{fulllineitems}
1799 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTMAGENTA_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTMAGENTA\_EX}}\sphinxbfcode{\sphinxupquote{ = 105}}}
1800 \end{fulllineitems}
1801
1802 \index{LIGHTRED\_EX (src.colorama.ansi.AnsiBack attribute)}
1803
1804 \begin{fulllineitems}
1805 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTRED_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTRED\_EX}}\sphinxbfcode{\sphinxupquote{ = 101}}}
1806 \end{fulllineitems}
1807
1808 \index{LIGHTWHITE\_EX (src.colorama.ansi.AnsiBack attribute)}
1809
1810 \begin{fulllineitems}
1811 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTWHITE_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTWHITE\_EX}}\sphinxbfcode{\sphinxupquote{ = 107}}}
1812 \end{fulllineitems}
1813
1814 \index{LIGHTYELLOW\_EX (src.colorama.ansi.AnsiBack attribute)}
1815
1816 \begin{fulllineitems}
1817 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTYELLOW_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTYELLOW\_EX}}\sphinxbfcode{\sphinxupquote{ = 103}}}
1818 \end{fulllineitems}
1819
1820 \index{MAGENTA (src.colorama.ansi.AnsiBack attribute)}
1821
1822 \begin{fulllineitems}
1823 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.MAGENTA}}\pysigline{\sphinxbfcode{\sphinxupquote{MAGENTA}}\sphinxbfcode{\sphinxupquote{ = 45}}}
1824 \end{fulllineitems}
1825
1826 \index{RED (src.colorama.ansi.AnsiBack attribute)}
1827
1828 \begin{fulllineitems}
1829 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.RED}}\pysigline{\sphinxbfcode{\sphinxupquote{RED}}\sphinxbfcode{\sphinxupquote{ = 41}}}
1830 \end{fulllineitems}
1831
1832 \index{RESET (src.colorama.ansi.AnsiBack attribute)}
1833
1834 \begin{fulllineitems}
1835 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.RESET}}\pysigline{\sphinxbfcode{\sphinxupquote{RESET}}\sphinxbfcode{\sphinxupquote{ = 49}}}
1836 \end{fulllineitems}
1837
1838 \index{WHITE (src.colorama.ansi.AnsiBack attribute)}
1839
1840 \begin{fulllineitems}
1841 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.WHITE}}\pysigline{\sphinxbfcode{\sphinxupquote{WHITE}}\sphinxbfcode{\sphinxupquote{ = 47}}}
1842 \end{fulllineitems}
1843
1844 \index{YELLOW (src.colorama.ansi.AnsiBack attribute)}
1845
1846 \begin{fulllineitems}
1847 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.YELLOW}}\pysigline{\sphinxbfcode{\sphinxupquote{YELLOW}}\sphinxbfcode{\sphinxupquote{ = 43}}}
1848 \end{fulllineitems}
1849
1850
1851 \end{fulllineitems}
1852
1853 \index{AnsiCodes (class in src.colorama.ansi)}
1854
1855 \begin{fulllineitems}
1856 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCodes}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.colorama.ansi.}}\sphinxbfcode{\sphinxupquote{AnsiCodes}}}
1857 Bases: \sphinxcode{\sphinxupquote{object}}
1858
1859 \end{fulllineitems}
1860
1861 \index{AnsiCursor (class in src.colorama.ansi)}
1862
1863 \begin{fulllineitems}
1864 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.colorama.ansi.}}\sphinxbfcode{\sphinxupquote{AnsiCursor}}}
1865 Bases: \sphinxcode{\sphinxupquote{object}}
1866 \index{BACK() (src.colorama.ansi.AnsiCursor method)}
1867
1868 \begin{fulllineitems}
1869 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.BACK}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{BACK}}}{\emph{n=1}}{}
1870 \end{fulllineitems}
1871
1872 \index{DOWN() (src.colorama.ansi.AnsiCursor method)}
1873
1874 \begin{fulllineitems}
1875 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.DOWN}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{DOWN}}}{\emph{n=1}}{}
1876 \end{fulllineitems}
1877
1878 \index{FORWARD() (src.colorama.ansi.AnsiCursor method)}
1879
1880 \begin{fulllineitems}
1881 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.FORWARD}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{FORWARD}}}{\emph{n=1}}{}
1882 \end{fulllineitems}
1883
1884 \index{POS() (src.colorama.ansi.AnsiCursor method)}
1885
1886 \begin{fulllineitems}
1887 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.POS}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{POS}}}{\emph{x=1}, \emph{y=1}}{}
1888 \end{fulllineitems}
1889
1890 \index{UP() (src.colorama.ansi.AnsiCursor method)}
1891
1892 \begin{fulllineitems}
1893 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.UP}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{UP}}}{\emph{n=1}}{}
1894 \end{fulllineitems}
1895
1896
1897 \end{fulllineitems}
1898
1899 \index{AnsiFore (class in src.colorama.ansi)}
1900
1901 \begin{fulllineitems}
1902 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.colorama.ansi.}}\sphinxbfcode{\sphinxupquote{AnsiFore}}}
1903 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}})
1904 \index{BLACK (src.colorama.ansi.AnsiFore attribute)}
1905
1906 \begin{fulllineitems}
1907 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.BLACK}}\pysigline{\sphinxbfcode{\sphinxupquote{BLACK}}\sphinxbfcode{\sphinxupquote{ = 30}}}
1908 \end{fulllineitems}
1909
1910 \index{BLUE (src.colorama.ansi.AnsiFore attribute)}
1911
1912 \begin{fulllineitems}
1913 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.BLUE}}\pysigline{\sphinxbfcode{\sphinxupquote{BLUE}}\sphinxbfcode{\sphinxupquote{ = 34}}}
1914 \end{fulllineitems}
1915
1916 \index{CYAN (src.colorama.ansi.AnsiFore attribute)}
1917
1918 \begin{fulllineitems}
1919 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.CYAN}}\pysigline{\sphinxbfcode{\sphinxupquote{CYAN}}\sphinxbfcode{\sphinxupquote{ = 36}}}
1920 \end{fulllineitems}
1921
1922 \index{GREEN (src.colorama.ansi.AnsiFore attribute)}
1923
1924 \begin{fulllineitems}
1925 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.GREEN}}\pysigline{\sphinxbfcode{\sphinxupquote{GREEN}}\sphinxbfcode{\sphinxupquote{ = 32}}}
1926 \end{fulllineitems}
1927
1928 \index{LIGHTBLACK\_EX (src.colorama.ansi.AnsiFore attribute)}
1929
1930 \begin{fulllineitems}
1931 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTBLACK_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTBLACK\_EX}}\sphinxbfcode{\sphinxupquote{ = 90}}}
1932 \end{fulllineitems}
1933
1934 \index{LIGHTBLUE\_EX (src.colorama.ansi.AnsiFore attribute)}
1935
1936 \begin{fulllineitems}
1937 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTBLUE_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTBLUE\_EX}}\sphinxbfcode{\sphinxupquote{ = 94}}}
1938 \end{fulllineitems}
1939
1940 \index{LIGHTCYAN\_EX (src.colorama.ansi.AnsiFore attribute)}
1941
1942 \begin{fulllineitems}
1943 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTCYAN_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTCYAN\_EX}}\sphinxbfcode{\sphinxupquote{ = 96}}}
1944 \end{fulllineitems}
1945
1946 \index{LIGHTGREEN\_EX (src.colorama.ansi.AnsiFore attribute)}
1947
1948 \begin{fulllineitems}
1949 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTGREEN_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTGREEN\_EX}}\sphinxbfcode{\sphinxupquote{ = 92}}}
1950 \end{fulllineitems}
1951
1952 \index{LIGHTMAGENTA\_EX (src.colorama.ansi.AnsiFore attribute)}
1953
1954 \begin{fulllineitems}
1955 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTMAGENTA_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTMAGENTA\_EX}}\sphinxbfcode{\sphinxupquote{ = 95}}}
1956 \end{fulllineitems}
1957
1958 \index{LIGHTRED\_EX (src.colorama.ansi.AnsiFore attribute)}
1959
1960 \begin{fulllineitems}
1961 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTRED_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTRED\_EX}}\sphinxbfcode{\sphinxupquote{ = 91}}}
1962 \end{fulllineitems}
1963
1964 \index{LIGHTWHITE\_EX (src.colorama.ansi.AnsiFore attribute)}
1965
1966 \begin{fulllineitems}
1967 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTWHITE_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTWHITE\_EX}}\sphinxbfcode{\sphinxupquote{ = 97}}}
1968 \end{fulllineitems}
1969
1970 \index{LIGHTYELLOW\_EX (src.colorama.ansi.AnsiFore attribute)}
1971
1972 \begin{fulllineitems}
1973 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTYELLOW_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTYELLOW\_EX}}\sphinxbfcode{\sphinxupquote{ = 93}}}
1974 \end{fulllineitems}
1975
1976 \index{MAGENTA (src.colorama.ansi.AnsiFore attribute)}
1977
1978 \begin{fulllineitems}
1979 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.MAGENTA}}\pysigline{\sphinxbfcode{\sphinxupquote{MAGENTA}}\sphinxbfcode{\sphinxupquote{ = 35}}}
1980 \end{fulllineitems}
1981
1982 \index{RED (src.colorama.ansi.AnsiFore attribute)}
1983
1984 \begin{fulllineitems}
1985 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.RED}}\pysigline{\sphinxbfcode{\sphinxupquote{RED}}\sphinxbfcode{\sphinxupquote{ = 31}}}
1986 \end{fulllineitems}
1987
1988 \index{RESET (src.colorama.ansi.AnsiFore attribute)}
1989
1990 \begin{fulllineitems}
1991 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.RESET}}\pysigline{\sphinxbfcode{\sphinxupquote{RESET}}\sphinxbfcode{\sphinxupquote{ = 39}}}
1992 \end{fulllineitems}
1993
1994 \index{WHITE (src.colorama.ansi.AnsiFore attribute)}
1995
1996 \begin{fulllineitems}
1997 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.WHITE}}\pysigline{\sphinxbfcode{\sphinxupquote{WHITE}}\sphinxbfcode{\sphinxupquote{ = 37}}}
1998 \end{fulllineitems}
1999
2000 \index{YELLOW (src.colorama.ansi.AnsiFore attribute)}
2001
2002 \begin{fulllineitems}
2003 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.YELLOW}}\pysigline{\sphinxbfcode{\sphinxupquote{YELLOW}}\sphinxbfcode{\sphinxupquote{ = 33}}}
2004 \end{fulllineitems}
2005
2006
2007 \end{fulllineitems}
2008
2009 \index{AnsiStyle (class in src.colorama.ansi)}
2010
2011 \begin{fulllineitems}
2012 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.colorama.ansi.}}\sphinxbfcode{\sphinxupquote{AnsiStyle}}}
2013 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}})
2014 \index{BRIGHT (src.colorama.ansi.AnsiStyle attribute)}
2015
2016 \begin{fulllineitems}
2017 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle.BRIGHT}}\pysigline{\sphinxbfcode{\sphinxupquote{BRIGHT}}\sphinxbfcode{\sphinxupquote{ = 1}}}
2018 \end{fulllineitems}
2019
2020 \index{DIM (src.colorama.ansi.AnsiStyle attribute)}
2021
2022 \begin{fulllineitems}
2023 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle.DIM}}\pysigline{\sphinxbfcode{\sphinxupquote{DIM}}\sphinxbfcode{\sphinxupquote{ = 2}}}
2024 \end{fulllineitems}
2025
2026 \index{NORMAL (src.colorama.ansi.AnsiStyle attribute)}
2027
2028 \begin{fulllineitems}
2029 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle.NORMAL}}\pysigline{\sphinxbfcode{\sphinxupquote{NORMAL}}\sphinxbfcode{\sphinxupquote{ = 22}}}
2030 \end{fulllineitems}
2031
2032 \index{RESET\_ALL (src.colorama.ansi.AnsiStyle attribute)}
2033
2034 \begin{fulllineitems}
2035 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle.RESET_ALL}}\pysigline{\sphinxbfcode{\sphinxupquote{RESET\_ALL}}\sphinxbfcode{\sphinxupquote{ = 0}}}
2036 \end{fulllineitems}
2037
2038
2039 \end{fulllineitems}
2040
2041 \index{clear\_line() (in module src.colorama.ansi)}
2042
2043 \begin{fulllineitems}
2044 \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}}{}
2045 \end{fulllineitems}
2046
2047 \index{clear\_screen() (in module src.colorama.ansi)}
2048
2049 \begin{fulllineitems}
2050 \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}}{}
2051 \end{fulllineitems}
2052
2053 \index{code\_to\_chars() (in module src.colorama.ansi)}
2054
2055 \begin{fulllineitems}
2056 \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}}{}
2057 \end{fulllineitems}
2058
2059 \index{set\_title() (in module src.colorama.ansi)}
2060
2061 \begin{fulllineitems}
2062 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.set_title}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.ansi.}}\sphinxbfcode{\sphinxupquote{set\_title}}}{\emph{title}}{}
2063 \end{fulllineitems}
2064
2065
2066
2067 \subparagraph{src.colorama.ansitowin32 module}
2068 \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)}
2069
2070 \begin{fulllineitems}
2071 \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}}{}
2072 Bases: \sphinxcode{\sphinxupquote{object}}
2073
2074 Implements a ‘write()’ method which, on Windows, will strip ANSI character
2075 sequences from the text, and if outputting to a tty, will convert them into
2076 win32 function calls.
2077 \index{ANSI\_CSI\_RE (src.colorama.ansitowin32.AnsiToWin32 attribute)}
2078
2079 \begin{fulllineitems}
2080 \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{}}}}
2081 \end{fulllineitems}
2082
2083 \index{ANSI\_OSC\_RE (src.colorama.ansitowin32.AnsiToWin32 attribute)}
2084
2085 \begin{fulllineitems}
2086 \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{}}}}
2087 \end{fulllineitems}
2088
2089 \index{call\_win32() (src.colorama.ansitowin32.AnsiToWin32 method)}
2090
2091 \begin{fulllineitems}
2092 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.call_win32}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{call\_win32}}}{\emph{command}, \emph{params}}{}
2093 \end{fulllineitems}
2094
2095 \index{convert\_ansi() (src.colorama.ansitowin32.AnsiToWin32 method)}
2096
2097 \begin{fulllineitems}
2098 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.convert_ansi}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{convert\_ansi}}}{\emph{paramstring}, \emph{command}}{}
2099 \end{fulllineitems}
2100
2101 \index{convert\_osc() (src.colorama.ansitowin32.AnsiToWin32 method)}
2102
2103 \begin{fulllineitems}
2104 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.convert_osc}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{convert\_osc}}}{\emph{text}}{}
2105 \end{fulllineitems}
2106
2107 \index{extract\_params() (src.colorama.ansitowin32.AnsiToWin32 method)}
2108
2109 \begin{fulllineitems}
2110 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.extract_params}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{extract\_params}}}{\emph{command}, \emph{paramstring}}{}
2111 \end{fulllineitems}
2112
2113 \index{get\_win32\_calls() (src.colorama.ansitowin32.AnsiToWin32 method)}
2114
2115 \begin{fulllineitems}
2116 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.get_win32_calls}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_win32\_calls}}}{}{}
2117 \end{fulllineitems}
2118
2119 \index{reset\_all() (src.colorama.ansitowin32.AnsiToWin32 method)}
2120
2121 \begin{fulllineitems}
2122 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.reset_all}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{reset\_all}}}{}{}
2123 \end{fulllineitems}
2124
2125 \index{should\_wrap() (src.colorama.ansitowin32.AnsiToWin32 method)}
2126
2127 \begin{fulllineitems}
2128 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.should_wrap}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{should\_wrap}}}{}{}
2129 True if this class is actually needed. If false, then the output
2130 stream will not be affected, nor will win32 calls be issued, so
2131 wrapping stdout is not actually required. This will generally be
2132 False on non-Windows platforms, unless optional functionality like
2133 autoreset has been requested using kwargs to init()
2134
2135 \end{fulllineitems}
2136
2137 \index{write() (src.colorama.ansitowin32.AnsiToWin32 method)}
2138
2139 \begin{fulllineitems}
2140 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.write}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write}}}{\emph{text}}{}
2141 \end{fulllineitems}
2142
2143 \index{write\_and\_convert() (src.colorama.ansitowin32.AnsiToWin32 method)}
2144
2145 \begin{fulllineitems}
2146 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.write_and_convert}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write\_and\_convert}}}{\emph{text}}{}
2147 Write the given text to our wrapped stream, stripping any ANSI
2148 sequences from the text, and optionally converting them into win32
2149 calls.
2150
2151 \end{fulllineitems}
2152
2153 \index{write\_plain\_text() (src.colorama.ansitowin32.AnsiToWin32 method)}
2154
2155 \begin{fulllineitems}
2156 \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}}{}
2157 \end{fulllineitems}
2158
2159
2160 \end{fulllineitems}
2161
2162 \index{StreamWrapper (class in src.colorama.ansitowin32)}
2163
2164 \begin{fulllineitems}
2165 \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}}{}
2166 Bases: \sphinxcode{\sphinxupquote{object}}
2167
2168 Wraps a stream (such as stdout), acting as a transparent proxy for all
2169 attribute access apart from method ‘write()’, which is delegated to our
2170 Converter instance.
2171 \index{write() (src.colorama.ansitowin32.StreamWrapper method)}
2172
2173 \begin{fulllineitems}
2174 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.StreamWrapper.write}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write}}}{\emph{text}}{}
2175 \end{fulllineitems}
2176
2177
2178 \end{fulllineitems}
2179
2180 \index{is\_a\_tty() (in module src.colorama.ansitowin32)}
2181
2182 \begin{fulllineitems}
2183 \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}}{}
2184 \end{fulllineitems}
2185
2186 \index{is\_stream\_closed() (in module src.colorama.ansitowin32)}
2187
2188 \begin{fulllineitems}
2189 \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}}{}
2190 \end{fulllineitems}
2191
2192
2193
2194 \subparagraph{src.colorama.initialise module}
2195 \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)}
2196
2197 \begin{fulllineitems}
2198 \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}}{}
2199 \end{fulllineitems}
2200
2201 \index{deinit() (in module src.colorama.initialise)}
2202
2203 \begin{fulllineitems}
2204 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.initialise.deinit}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.initialise.}}\sphinxbfcode{\sphinxupquote{deinit}}}{}{}
2205 \end{fulllineitems}
2206
2207 \index{init() (in module src.colorama.initialise)}
2208
2209 \begin{fulllineitems}
2210 \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}}{}
2211 \end{fulllineitems}
2212
2213 \index{reinit() (in module src.colorama.initialise)}
2214
2215 \begin{fulllineitems}
2216 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.initialise.reinit}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.initialise.}}\sphinxbfcode{\sphinxupquote{reinit}}}{}{}
2217 \end{fulllineitems}
2218
2219 \index{reset\_all() (in module src.colorama.initialise)}
2220
2221 \begin{fulllineitems}
2222 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.initialise.reset_all}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.initialise.}}\sphinxbfcode{\sphinxupquote{reset\_all}}}{}{}
2223 \end{fulllineitems}
2224
2225 \index{wrap\_stream() (in module src.colorama.initialise)}
2226
2227 \begin{fulllineitems}
2228 \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}}{}
2229 \end{fulllineitems}
2230
2231
2232
2233 \subparagraph{src.colorama.win32 module}
2234 \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)}
2235
2236 \begin{fulllineitems}
2237 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.win32.SetConsoleTextAttribute}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.win32.}}\sphinxbfcode{\sphinxupquote{SetConsoleTextAttribute}}}{\emph{*\_}}{}
2238 \end{fulllineitems}
2239
2240 \index{winapi\_test() (in module src.colorama.win32)}
2241
2242 \begin{fulllineitems}
2243 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.win32.winapi_test}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.win32.}}\sphinxbfcode{\sphinxupquote{winapi\_test}}}{\emph{*\_}}{}
2244 \end{fulllineitems}
2245
2246
2247
2248 \subparagraph{src.colorama.winterm module}
2249 \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)}
2250
2251 \begin{fulllineitems}
2252 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinColor}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.colorama.winterm.}}\sphinxbfcode{\sphinxupquote{WinColor}}}
2253 Bases: \sphinxcode{\sphinxupquote{object}}
2254 \index{BLACK (src.colorama.winterm.WinColor attribute)}
2255
2256 \begin{fulllineitems}
2257 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.BLACK}}\pysigline{\sphinxbfcode{\sphinxupquote{BLACK}}\sphinxbfcode{\sphinxupquote{ = 0}}}
2258 \end{fulllineitems}
2259
2260 \index{BLUE (src.colorama.winterm.WinColor attribute)}
2261
2262 \begin{fulllineitems}
2263 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.BLUE}}\pysigline{\sphinxbfcode{\sphinxupquote{BLUE}}\sphinxbfcode{\sphinxupquote{ = 1}}}
2264 \end{fulllineitems}
2265
2266 \index{CYAN (src.colorama.winterm.WinColor attribute)}
2267
2268 \begin{fulllineitems}
2269 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.CYAN}}\pysigline{\sphinxbfcode{\sphinxupquote{CYAN}}\sphinxbfcode{\sphinxupquote{ = 3}}}
2270 \end{fulllineitems}
2271
2272 \index{GREEN (src.colorama.winterm.WinColor attribute)}
2273
2274 \begin{fulllineitems}
2275 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.GREEN}}\pysigline{\sphinxbfcode{\sphinxupquote{GREEN}}\sphinxbfcode{\sphinxupquote{ = 2}}}
2276 \end{fulllineitems}
2277
2278 \index{GREY (src.colorama.winterm.WinColor attribute)}
2279
2280 \begin{fulllineitems}
2281 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.GREY}}\pysigline{\sphinxbfcode{\sphinxupquote{GREY}}\sphinxbfcode{\sphinxupquote{ = 7}}}
2282 \end{fulllineitems}
2283
2284 \index{MAGENTA (src.colorama.winterm.WinColor attribute)}
2285
2286 \begin{fulllineitems}
2287 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.MAGENTA}}\pysigline{\sphinxbfcode{\sphinxupquote{MAGENTA}}\sphinxbfcode{\sphinxupquote{ = 5}}}
2288 \end{fulllineitems}
2289
2290 \index{RED (src.colorama.winterm.WinColor attribute)}
2291
2292 \begin{fulllineitems}
2293 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.RED}}\pysigline{\sphinxbfcode{\sphinxupquote{RED}}\sphinxbfcode{\sphinxupquote{ = 4}}}
2294 \end{fulllineitems}
2295
2296 \index{YELLOW (src.colorama.winterm.WinColor attribute)}
2297
2298 \begin{fulllineitems}
2299 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.YELLOW}}\pysigline{\sphinxbfcode{\sphinxupquote{YELLOW}}\sphinxbfcode{\sphinxupquote{ = 6}}}
2300 \end{fulllineitems}
2301
2302
2303 \end{fulllineitems}
2304
2305 \index{WinStyle (class in src.colorama.winterm)}
2306
2307 \begin{fulllineitems}
2308 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinStyle}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.colorama.winterm.}}\sphinxbfcode{\sphinxupquote{WinStyle}}}
2309 Bases: \sphinxcode{\sphinxupquote{object}}
2310 \index{BRIGHT (src.colorama.winterm.WinStyle attribute)}
2311
2312 \begin{fulllineitems}
2313 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinStyle.BRIGHT}}\pysigline{\sphinxbfcode{\sphinxupquote{BRIGHT}}\sphinxbfcode{\sphinxupquote{ = 8}}}
2314 \end{fulllineitems}
2315
2316 \index{BRIGHT\_BACKGROUND (src.colorama.winterm.WinStyle attribute)}
2317
2318 \begin{fulllineitems}
2319 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinStyle.BRIGHT_BACKGROUND}}\pysigline{\sphinxbfcode{\sphinxupquote{BRIGHT\_BACKGROUND}}\sphinxbfcode{\sphinxupquote{ = 128}}}
2320 \end{fulllineitems}
2321
2322 \index{NORMAL (src.colorama.winterm.WinStyle attribute)}
2323
2324 \begin{fulllineitems}
2325 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinStyle.NORMAL}}\pysigline{\sphinxbfcode{\sphinxupquote{NORMAL}}\sphinxbfcode{\sphinxupquote{ = 0}}}
2326 \end{fulllineitems}
2327
2328
2329 \end{fulllineitems}
2330
2331 \index{WinTerm (class in src.colorama.winterm)}
2332
2333 \begin{fulllineitems}
2334 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.colorama.winterm.}}\sphinxbfcode{\sphinxupquote{WinTerm}}}
2335 Bases: \sphinxcode{\sphinxupquote{object}}
2336 \index{back() (src.colorama.winterm.WinTerm method)}
2337
2338 \begin{fulllineitems}
2339 \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}}{}
2340 \end{fulllineitems}
2341
2342 \index{cursor\_adjust() (src.colorama.winterm.WinTerm method)}
2343
2344 \begin{fulllineitems}
2345 \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}}{}
2346 \end{fulllineitems}
2347
2348 \index{erase\_line() (src.colorama.winterm.WinTerm method)}
2349
2350 \begin{fulllineitems}
2351 \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}}{}
2352 \end{fulllineitems}
2353
2354 \index{erase\_screen() (src.colorama.winterm.WinTerm method)}
2355
2356 \begin{fulllineitems}
2357 \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}}{}
2358 \end{fulllineitems}
2359
2360 \index{fore() (src.colorama.winterm.WinTerm method)}
2361
2362 \begin{fulllineitems}
2363 \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}}{}
2364 \end{fulllineitems}
2365
2366 \index{get\_attrs() (src.colorama.winterm.WinTerm method)}
2367
2368 \begin{fulllineitems}
2369 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.get_attrs}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_attrs}}}{}{}
2370 \end{fulllineitems}
2371
2372 \index{get\_position() (src.colorama.winterm.WinTerm method)}
2373
2374 \begin{fulllineitems}
2375 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.get_position}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_position}}}{\emph{handle}}{}
2376 \end{fulllineitems}
2377
2378 \index{reset\_all() (src.colorama.winterm.WinTerm method)}
2379
2380 \begin{fulllineitems}
2381 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.reset_all}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{reset\_all}}}{\emph{on\_stderr=None}}{}
2382 \end{fulllineitems}
2383
2384 \index{set\_attrs() (src.colorama.winterm.WinTerm method)}
2385
2386 \begin{fulllineitems}
2387 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.set_attrs}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_attrs}}}{\emph{value}}{}
2388 \end{fulllineitems}
2389
2390 \index{set\_console() (src.colorama.winterm.WinTerm method)}
2391
2392 \begin{fulllineitems}
2393 \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}}{}
2394 \end{fulllineitems}
2395
2396 \index{set\_cursor\_position() (src.colorama.winterm.WinTerm method)}
2397
2398 \begin{fulllineitems}
2399 \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}}{}
2400 \end{fulllineitems}
2401
2402 \index{set\_title() (src.colorama.winterm.WinTerm method)}
2403
2404 \begin{fulllineitems}
2405 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.set_title}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_title}}}{\emph{title}}{}
2406 \end{fulllineitems}
2407
2408 \index{style() (src.colorama.winterm.WinTerm method)}
2409
2410 \begin{fulllineitems}
2411 \phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.style}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{style}}}{\emph{style=None}, \emph{on\_stderr=False}}{}
2412 \end{fulllineitems}
2413
2414
2415 \end{fulllineitems}
2416
2417
2418
2419 \subparagraph{Module contents}
2420 \label{\detokenize{commands/apidoc/src.colorama:module-src.colorama}}\label{\detokenize{commands/apidoc/src.colorama:module-contents}}\index{src.colorama (module)}
2421
2422 \subsubsection{Submodules}
2423 \label{\detokenize{commands/apidoc/src:submodules}}
2424
2425 \subsubsection{src.ElementTree module}
2426 \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)}
2427
2428 \begin{fulllineitems}
2429 \phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.Comment}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{Comment}}}{\emph{text=None}}{}
2430 \end{fulllineitems}
2431
2432 \index{dump() (in module src.ElementTree)}
2433
2434 \begin{fulllineitems}
2435 \phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.dump}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{dump}}}{\emph{elem}}{}
2436 \end{fulllineitems}
2437
2438 \index{Element() (in module src.ElementTree)}
2439
2440 \begin{fulllineitems}
2441 \phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.Element}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{Element}}}{\emph{tag}, \emph{attrib=\{\}}, \emph{**extra}}{}
2442 \end{fulllineitems}
2443
2444 \index{ElementTree (class in src.ElementTree)}
2445
2446 \begin{fulllineitems}
2447 \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)}
2448
2449 \begin{fulllineitems}
2450 \phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.ElementTree.find}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{find}}}{\emph{path}}{}
2451 \end{fulllineitems}
2452
2453 \index{findall() (src.ElementTree.ElementTree method)}
2454
2455 \begin{fulllineitems}
2456 \phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.ElementTree.findall}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{findall}}}{\emph{path}}{}
2457 \end{fulllineitems}
2458
2459 \index{findtext() (src.ElementTree.ElementTree method)}
2460
2461 \begin{fulllineitems}
2462 \phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.ElementTree.findtext}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{findtext}}}{\emph{path}, \emph{default=None}}{}
2463 \end{fulllineitems}
2464
2465 \index{getiterator() (src.ElementTree.ElementTree method)}
2466
2467 \begin{fulllineitems}
2468 \phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.ElementTree.getiterator}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getiterator}}}{\emph{tag=None}}{}
2469 \end{fulllineitems}
2470
2471 \index{getroot() (src.ElementTree.ElementTree method)}
2472
2473 \begin{fulllineitems}
2474 \phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.ElementTree.getroot}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getroot}}}{}{}
2475 \end{fulllineitems}
2476
2477 \index{parse() (src.ElementTree.ElementTree method)}
2478
2479 \begin{fulllineitems}
2480 \phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.ElementTree.parse}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parse}}}{\emph{source}, \emph{parser=None}}{}
2481 \end{fulllineitems}
2482
2483 \index{write() (src.ElementTree.ElementTree method)}
2484
2485 \begin{fulllineitems}
2486 \phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.ElementTree.write}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write}}}{\emph{file}, \emph{encoding='us-ascii'}}{}
2487 \end{fulllineitems}
2488
2489
2490 \end{fulllineitems}
2491
2492 \index{fromstring() (in module src.ElementTree)}
2493
2494 \begin{fulllineitems}
2495 \phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.fromstring}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{fromstring}}}{\emph{text}}{}
2496 \end{fulllineitems}
2497
2498 \index{iselement() (in module src.ElementTree)}
2499
2500 \begin{fulllineitems}
2501 \phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.iselement}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{iselement}}}{\emph{element}}{}
2502 \end{fulllineitems}
2503
2504 \index{iterparse (class in src.ElementTree)}
2505
2506 \begin{fulllineitems}
2507 \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)}
2508
2509 \begin{fulllineitems}
2510 \phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.iterparse.next}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{next}}}{}{}
2511 \end{fulllineitems}
2512
2513
2514 \end{fulllineitems}
2515
2516 \index{parse() (in module src.ElementTree)}
2517
2518 \begin{fulllineitems}
2519 \phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.parse}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{parse}}}{\emph{source}, \emph{parser=None}}{}
2520 \end{fulllineitems}
2521
2522 \index{PI() (in module src.ElementTree)}
2523
2524 \begin{fulllineitems}
2525 \phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.PI}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{PI}}}{\emph{target}, \emph{text=None}}{}
2526 \end{fulllineitems}
2527
2528 \index{ProcessingInstruction() (in module src.ElementTree)}
2529
2530 \begin{fulllineitems}
2531 \phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.ProcessingInstruction}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{ProcessingInstruction}}}{\emph{target}, \emph{text=None}}{}
2532 \end{fulllineitems}
2533
2534 \index{QName (class in src.ElementTree)}
2535
2536 \begin{fulllineitems}
2537 \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}}{}
2538 \end{fulllineitems}
2539
2540 \index{SubElement() (in module src.ElementTree)}
2541
2542 \begin{fulllineitems}
2543 \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}}{}
2544 \end{fulllineitems}
2545
2546 \index{tostring() (in module src.ElementTree)}
2547
2548 \begin{fulllineitems}
2549 \phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.tostring}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{tostring}}}{\emph{element}, \emph{encoding=None}}{}
2550 \end{fulllineitems}
2551
2552 \index{TreeBuilder (class in src.ElementTree)}
2553
2554 \begin{fulllineitems}
2555 \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)}
2556
2557 \begin{fulllineitems}
2558 \phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.TreeBuilder.close}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{close}}}{}{}
2559 \end{fulllineitems}
2560
2561 \index{data() (src.ElementTree.TreeBuilder method)}
2562
2563 \begin{fulllineitems}
2564 \phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.TreeBuilder.data}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{data}}}{\emph{data}}{}
2565 \end{fulllineitems}
2566
2567 \index{end() (src.ElementTree.TreeBuilder method)}
2568
2569 \begin{fulllineitems}
2570 \phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.TreeBuilder.end}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{end}}}{\emph{tag}}{}
2571 \end{fulllineitems}
2572
2573 \index{start() (src.ElementTree.TreeBuilder method)}
2574
2575 \begin{fulllineitems}
2576 \phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.TreeBuilder.start}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{start}}}{\emph{tag}, \emph{attrs}}{}
2577 \end{fulllineitems}
2578
2579
2580 \end{fulllineitems}
2581
2582 \index{XML() (in module src.ElementTree)}
2583
2584 \begin{fulllineitems}
2585 \phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.XML}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{XML}}}{\emph{text}}{}
2586 \end{fulllineitems}
2587
2588 \index{XMLTreeBuilder (class in src.ElementTree)}
2589
2590 \begin{fulllineitems}
2591 \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)}
2592
2593 \begin{fulllineitems}
2594 \phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.XMLTreeBuilder.close}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{close}}}{}{}
2595 \end{fulllineitems}
2596
2597 \index{doctype() (src.ElementTree.XMLTreeBuilder method)}
2598
2599 \begin{fulllineitems}
2600 \phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.XMLTreeBuilder.doctype}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{doctype}}}{\emph{name}, \emph{pubid}, \emph{system}}{}
2601 \end{fulllineitems}
2602
2603 \index{feed() (src.ElementTree.XMLTreeBuilder method)}
2604
2605 \begin{fulllineitems}
2606 \phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.XMLTreeBuilder.feed}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{feed}}}{\emph{data}}{}
2607 \end{fulllineitems}
2608
2609
2610 \end{fulllineitems}
2611
2612
2613
2614 \subsubsection{src.architecture module}
2615 \label{\detokenize{commands/apidoc/src:module-src.architecture}}\label{\detokenize{commands/apidoc/src:src-architecture-module}}\index{src.architecture (module)}
2616 In this file : all the stuff that can change with the architecture
2617 on which SAT is running
2618 \index{get\_distrib\_version() (in module src.architecture)}
2619
2620 \begin{fulllineitems}
2621 \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}}{}
2622 Gets the version of the distribution
2623 \begin{quote}\begin{description}
2624 \item[{Parameters}] \leavevmode\begin{itemize}
2625 \item {}
2626 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{distrib}}) \textendash{} The distribution on which the version will be found.
2627
2628 \item {}
2629 \sphinxstyleliteralstrong{\sphinxupquote{L\{Mapping\}}} (\sphinxstyleliteralemphasis{\sphinxupquote{codes}}) \textendash{} The map containing distribution correlation table.
2630
2631 \end{itemize}
2632
2633 \item[{Returns}] \leavevmode
2634 The version of the distribution on which salomeTools is running,
2635 regarding the distribution correlation table contained in codes
2636 variable.
2637
2638 \item[{Return type}] \leavevmode
2639 str
2640
2641 \end{description}\end{quote}
2642
2643 \end{fulllineitems}
2644
2645 \index{get\_distribution() (in module src.architecture)}
2646
2647 \begin{fulllineitems}
2648 \phantomsection\label{\detokenize{commands/apidoc/src:src.architecture.get_distribution}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.architecture.}}\sphinxbfcode{\sphinxupquote{get\_distribution}}}{\emph{codes}}{}
2649 Gets the code for the distribution
2650 \begin{quote}\begin{description}
2651 \item[{Parameters}] \leavevmode
2652 \sphinxstyleliteralstrong{\sphinxupquote{L\{Mapping\}}} (\sphinxstyleliteralemphasis{\sphinxupquote{codes}}) \textendash{} The map containing distribution correlation table.
2653
2654 \item[{Returns}] \leavevmode
2655 The distribution on which salomeTools is running, regarding the
2656 distribution correlation table contained in codes variable.
2657
2658 \item[{Return type}] \leavevmode
2659 str
2660
2661 \end{description}\end{quote}
2662
2663 \end{fulllineitems}
2664
2665 \index{get\_nb\_proc() (in module src.architecture)}
2666
2667 \begin{fulllineitems}
2668 \phantomsection\label{\detokenize{commands/apidoc/src:src.architecture.get_nb_proc}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.architecture.}}\sphinxbfcode{\sphinxupquote{get\_nb\_proc}}}{}{}~\begin{description}
2669 \item[{Gets the number of processors of the machine }] \leavevmode
2670 on which salomeTools is running.
2671
2672 \end{description}
2673 \begin{quote}\begin{description}
2674 \item[{Returns}] \leavevmode
2675 the number of processors.
2676
2677 \item[{Return type}] \leavevmode
2678 str
2679
2680 \end{description}\end{quote}
2681
2682 \end{fulllineitems}
2683
2684 \index{get\_python\_version() (in module src.architecture)}
2685
2686 \begin{fulllineitems}
2687 \phantomsection\label{\detokenize{commands/apidoc/src:src.architecture.get_python_version}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.architecture.}}\sphinxbfcode{\sphinxupquote{get\_python\_version}}}{}{}
2688 Gets the version of the running python.
2689 \begin{quote}\begin{description}
2690 \item[{Returns}] \leavevmode
2691 the version of the running python.
2692
2693 \item[{Return type}] \leavevmode
2694 str
2695
2696 \end{description}\end{quote}
2697
2698 \end{fulllineitems}
2699
2700 \index{get\_user() (in module src.architecture)}
2701
2702 \begin{fulllineitems}
2703 \phantomsection\label{\detokenize{commands/apidoc/src:src.architecture.get_user}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.architecture.}}\sphinxbfcode{\sphinxupquote{get\_user}}}{}{}
2704 method that gets the username that launched sat
2705 \begin{quote}\begin{description}
2706 \item[{Return type}] \leavevmode
2707 str
2708
2709 \end{description}\end{quote}
2710
2711 \end{fulllineitems}
2712
2713 \index{is\_windows() (in module src.architecture)}
2714
2715 \begin{fulllineitems}
2716 \phantomsection\label{\detokenize{commands/apidoc/src:src.architecture.is_windows}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.architecture.}}\sphinxbfcode{\sphinxupquote{is\_windows}}}{}{}
2717 method that checks windows OS
2718 \begin{quote}\begin{description}
2719 \item[{Return type}] \leavevmode
2720 boolean
2721
2722 \end{description}\end{quote}
2723
2724 \end{fulllineitems}
2725
2726
2727
2728 \subsubsection{src.compilation module}
2729 \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)}
2730
2731 \begin{fulllineitems}
2732 \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}}{}
2733 Class to handle all construction steps, like cmake, configure, make, …
2734 \index{build\_configure() (src.compilation.Builder method)}
2735
2736 \begin{fulllineitems}
2737 \phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.build_configure}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{build\_configure}}}{\emph{options=''}}{}
2738 \end{fulllineitems}
2739
2740 \index{check() (src.compilation.Builder method)}
2741
2742 \begin{fulllineitems}
2743 \phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.check}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{check}}}{\emph{command=''}}{}
2744 \end{fulllineitems}
2745
2746 \index{cmake() (src.compilation.Builder method)}
2747
2748 \begin{fulllineitems}
2749 \phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.cmake}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{cmake}}}{\emph{options=''}}{}
2750 \end{fulllineitems}
2751
2752 \index{complete\_environment() (src.compilation.Builder method)}
2753
2754 \begin{fulllineitems}
2755 \phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.complete_environment}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{complete\_environment}}}{\emph{make\_options}}{}
2756 \end{fulllineitems}
2757
2758 \index{configure() (src.compilation.Builder method)}
2759
2760 \begin{fulllineitems}
2761 \phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.configure}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{configure}}}{\emph{options=''}}{}
2762 \end{fulllineitems}
2763
2764 \index{do\_batch\_script\_build() (src.compilation.Builder method)}
2765
2766 \begin{fulllineitems}
2767 \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}}{}
2768 \end{fulllineitems}
2769
2770 \index{do\_default\_build() (src.compilation.Builder method)}
2771
2772 \begin{fulllineitems}
2773 \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}}{}
2774 \end{fulllineitems}
2775
2776 \index{do\_python\_script\_build() (src.compilation.Builder method)}
2777
2778 \begin{fulllineitems}
2779 \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}}{}
2780 \end{fulllineitems}
2781
2782 \index{do\_script\_build() (src.compilation.Builder method)}
2783
2784 \begin{fulllineitems}
2785 \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}}{}
2786 \end{fulllineitems}
2787
2788 \index{hack\_libtool() (src.compilation.Builder method)}
2789
2790 \begin{fulllineitems}
2791 \phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.hack_libtool}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{hack\_libtool}}}{}{}
2792 \end{fulllineitems}
2793
2794 \index{install() (src.compilation.Builder method)}
2795
2796 \begin{fulllineitems}
2797 \phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.install}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{install}}}{}{}
2798 \end{fulllineitems}
2799
2800 \index{log() (src.compilation.Builder method)}
2801
2802 \begin{fulllineitems}
2803 \phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.log}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{log}}}{\emph{text}, \emph{level}, \emph{showInfo=True}}{}
2804 \end{fulllineitems}
2805
2806 \index{log\_command() (src.compilation.Builder method)}
2807
2808 \begin{fulllineitems}
2809 \phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.log_command}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{log\_command}}}{\emph{command}}{}
2810 \end{fulllineitems}
2811
2812 \index{make() (src.compilation.Builder method)}
2813
2814 \begin{fulllineitems}
2815 \phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.make}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{make}}}{\emph{nb\_proc}, \emph{make\_opt=''}}{}
2816 \end{fulllineitems}
2817
2818 \index{prepare() (src.compilation.Builder method)}
2819
2820 \begin{fulllineitems}
2821 \phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.prepare}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepare}}}{}{}
2822 \end{fulllineitems}
2823
2824 \index{put\_txt\_log\_in\_appli\_log\_dir() (src.compilation.Builder method)}
2825
2826 \begin{fulllineitems}
2827 \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}
2828 \item[{Put the txt log (that contain the system logs, like make command}] \leavevmode
2829 output) in the directory \textless{}APPLICATION DIR\textgreater{}/LOGS/\textless{}product\_name\textgreater{}/
2830
2831 \end{description}
2832 \begin{quote}\begin{description}
2833 \item[{Parameters}] \leavevmode
2834 \sphinxstyleliteralstrong{\sphinxupquote{Str}} (\sphinxstyleliteralemphasis{\sphinxupquote{file\_name}}) \textendash{} the name of the file to write
2835
2836 \end{description}\end{quote}
2837
2838 \end{fulllineitems}
2839
2840 \index{wmake() (src.compilation.Builder method)}
2841
2842 \begin{fulllineitems}
2843 \phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.wmake}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{wmake}}}{\emph{nb\_proc}, \emph{opt\_nb\_proc=None}}{}
2844 \end{fulllineitems}
2845
2846
2847 \end{fulllineitems}
2848
2849
2850
2851 \subsubsection{src.debug module}
2852 \label{\detokenize{commands/apidoc/src:module-src.debug}}\label{\detokenize{commands/apidoc/src:src-debug-module}}\index{src.debug (module)}
2853 This file assume DEBUG functionalities use
2854 \begin{itemize}
2855 \item {}
2856 print debug messages in sys.stderr for salomeTools
2857
2858 \item {}
2859 show pretty print debug representation from instances of SAT classes
2860 (pretty print src.pyconf.Config), and python dict/list etc. (as ‘aVariable’)
2861
2862 \end{itemize}
2863
2864 WARNING: obviously supposedly show messages in SAT development phase, not production
2865
2866 usage:
2867 \textgreater{}\textgreater{} import debug as DBG
2868 \textgreater{}\textgreater{} DBG.write(“aTitle”, aVariable)        \# not shown in production
2869 \textgreater{}\textgreater{} DBG.write(“aTitle”, aVariable, True)  \# unconditionaly shown (as show=True)
2870
2871 to set show message as development phase:
2872 \textgreater{}\textgreater{} DBG.push\_debug(True)
2873
2874 to set no show message as production phase:
2875 \textgreater{}\textgreater{} DBG.push\_debug(False)
2876
2877 to set show message temporary as development phase, only in a method:
2878 \textgreater{}\textgreater{} def aMethodToDebug(…):
2879 \textgreater{}\textgreater{}   DBG.push\_debug(True)              \#force show as appended status
2880 \textgreater{}\textgreater{}   etc. method code with some DBG.write()
2881 \textgreater{}\textgreater{}   DBG.pop\_debug()                   \#restore previous status (show or not show)
2882 \textgreater{}\textgreater{}   return
2883
2884 to set a message for future fix, as temporary problem to not forget:
2885 DBG.tofix(“aTitle”, aVariable, True/False) \#True/False in production shown, or not
2886
2887 in command line interface you could redirect stderr to file ‘myDebug.log’:
2888 \textgreater{}\textgreater{} sat compile … 2\textgreater{} myDebug.log   \# only stderr
2889 \textgreater{}\textgreater{} sat compile … \&\textgreater{} myDebug.log   \# stdout and stderr
2890 \index{InStream (class in src.debug)}
2891
2892 \begin{fulllineitems}
2893 \phantomsection\label{\detokenize{commands/apidoc/src:src.debug.InStream}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{InStream}}}{\emph{buf=''}}{}
2894 Bases: \sphinxcode{\sphinxupquote{StringIO.StringIO}}
2895
2896 utility class for pyconf.Config input iostream
2897
2898 \end{fulllineitems}
2899
2900 \index{OutStream (class in src.debug)}
2901
2902 \begin{fulllineitems}
2903 \phantomsection\label{\detokenize{commands/apidoc/src:src.debug.OutStream}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{OutStream}}}{\emph{buf=''}}{}
2904 Bases: \sphinxcode{\sphinxupquote{StringIO.StringIO}}
2905
2906 utility class for pyconf.Config output iostream
2907 \index{close() (src.debug.OutStream method)}
2908
2909 \begin{fulllineitems}
2910 \phantomsection\label{\detokenize{commands/apidoc/src:src.debug.OutStream.close}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{close}}}{}{}
2911 because Config.\_\_save\_\_ calls close() stream as file
2912 keep value before lost as self.value
2913
2914 \end{fulllineitems}
2915
2916
2917 \end{fulllineitems}
2918
2919 \index{getLocalEnv() (in module src.debug)}
2920
2921 \begin{fulllineitems}
2922 \phantomsection\label{\detokenize{commands/apidoc/src:src.debug.getLocalEnv}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{getLocalEnv}}}{}{}
2923 get string for environment variables representation
2924
2925 \end{fulllineitems}
2926
2927 \index{getStrConfigDbg() (in module src.debug)}
2928
2929 \begin{fulllineitems}
2930 \phantomsection\label{\detokenize{commands/apidoc/src:src.debug.getStrConfigDbg}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{getStrConfigDbg}}}{\emph{config}}{}
2931 set string as saveConfigDbg,
2932 as (path expression evaluation) for debug
2933
2934 \end{fulllineitems}
2935
2936 \index{getStrConfigStd() (in module src.debug)}
2937
2938 \begin{fulllineitems}
2939 \phantomsection\label{\detokenize{commands/apidoc/src:src.debug.getStrConfigStd}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{getStrConfigStd}}}{\emph{config}}{}
2940 set string as saveConfigStd, as file .pyconf
2941
2942 \end{fulllineitems}
2943
2944 \index{indent() (in module src.debug)}
2945
2946 \begin{fulllineitems}
2947 \phantomsection\label{\detokenize{commands/apidoc/src:src.debug.indent}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{indent}}}{\emph{text}, \emph{amount=2}, \emph{ch=' '}}{}
2948 indent multi lines message
2949
2950 \end{fulllineitems}
2951
2952 \index{pop\_debug() (in module src.debug)}
2953
2954 \begin{fulllineitems}
2955 \phantomsection\label{\detokenize{commands/apidoc/src:src.debug.pop_debug}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{pop\_debug}}}{}{}
2956 restore previous debug outputs status
2957
2958 \end{fulllineitems}
2959
2960 \index{push\_debug() (in module src.debug)}
2961
2962 \begin{fulllineitems}
2963 \phantomsection\label{\detokenize{commands/apidoc/src:src.debug.push_debug}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{push\_debug}}}{\emph{aBool}}{}
2964 set debug outputs activated, or not
2965
2966 \end{fulllineitems}
2967
2968 \index{saveConfigDbg() (in module src.debug)}
2969
2970 \begin{fulllineitems}
2971 \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=''}}{}
2972 pyconf returns multilines (path expression evaluation) for debug
2973
2974 \end{fulllineitems}
2975
2976 \index{saveConfigStd() (in module src.debug)}
2977
2978 \begin{fulllineitems}
2979 \phantomsection\label{\detokenize{commands/apidoc/src:src.debug.saveConfigStd}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{saveConfigStd}}}{\emph{config}, \emph{aStream}}{}
2980 returns as file .pyconf
2981
2982 \end{fulllineitems}
2983
2984 \index{tofix() (in module src.debug)}
2985
2986 \begin{fulllineitems}
2987 \phantomsection\label{\detokenize{commands/apidoc/src:src.debug.tofix}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{tofix}}}{\emph{title}, \emph{var=''}, \emph{force=None}}{}
2988 write sys.stderr a message if \_debug{[}-1{]}==True or optionaly force=True
2989 use this only if no logger accessible for classic
2990 logger.warning(message) or logger.debug(message)
2991
2992 \end{fulllineitems}
2993
2994 \index{write() (in module src.debug)}
2995
2996 \begin{fulllineitems}
2997 \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'}}{}
2998 write sys.stderr a message if \_debug{[}-1{]}==True or optionaly force=True
2999
3000 \end{fulllineitems}
3001
3002
3003
3004 \subsubsection{src.environment module}
3005 \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)}
3006
3007 \begin{fulllineitems}
3008 \phantomsection\label{\detokenize{commands/apidoc/src:src.environment.Environ}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.environment.}}\sphinxbfcode{\sphinxupquote{Environ}}}{\emph{environ=None}}{}
3009 Class to manage the environment context
3010 \index{append() (src.environment.Environ method)}
3011
3012 \begin{fulllineitems}
3013 \phantomsection\label{\detokenize{commands/apidoc/src:src.environment.Environ.append}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
3014 Same as append\_value but the value argument can be a list
3015 \begin{quote}\begin{description}
3016 \item[{Parameters}] \leavevmode\begin{itemize}
3017 \item {}
3018 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to append
3019
3020 \item {}
3021 \sphinxstyleliteralstrong{\sphinxupquote{str}}\sphinxstyleliteralstrong{\sphinxupquote{ or }}\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the value(s) to append to key
3022
3023 \item {}
3024 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
3025
3026 \end{itemize}
3027
3028 \end{description}\end{quote}
3029
3030 \end{fulllineitems}
3031
3032 \index{append\_value() (src.environment.Environ method)}
3033
3034 \begin{fulllineitems}
3035 \phantomsection\label{\detokenize{commands/apidoc/src:src.environment.Environ.append_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append\_value}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
3036 append value to key using sep
3037 \begin{quote}\begin{description}
3038 \item[{Parameters}] \leavevmode\begin{itemize}
3039 \item {}
3040 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to append
3041
3042 \item {}
3043 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to append to key
3044
3045 \item {}
3046 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
3047
3048 \end{itemize}
3049
3050 \end{description}\end{quote}
3051
3052 \end{fulllineitems}
3053
3054 \index{command\_value() (src.environment.Environ method)}
3055
3056 \begin{fulllineitems}
3057 \phantomsection\label{\detokenize{commands/apidoc/src:src.environment.Environ.command_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{command\_value}}}{\emph{key}, \emph{command}}{}
3058 Get the value given by the system command “command”
3059 and put it in the environment variable key
3060 \begin{quote}\begin{description}
3061 \item[{Parameters}] \leavevmode\begin{itemize}
3062 \item {}
3063 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{command}}) \textendash{} the environment variable
3064
3065 \item {}
3066 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the command to execute
3067
3068 \end{itemize}
3069
3070 \end{description}\end{quote}
3071
3072 \end{fulllineitems}
3073
3074 \index{get() (src.environment.Environ method)}
3075
3076 \begin{fulllineitems}
3077 \phantomsection\label{\detokenize{commands/apidoc/src:src.environment.Environ.get}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get}}}{\emph{key}}{}
3078 Get the value of the environment variable “key”
3079 \begin{quote}\begin{description}
3080 \item[{Parameters}] \leavevmode
3081 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable
3082
3083 \end{description}\end{quote}
3084
3085 \end{fulllineitems}
3086
3087 \index{is\_defined() (src.environment.Environ method)}
3088
3089 \begin{fulllineitems}
3090 \phantomsection\label{\detokenize{commands/apidoc/src:src.environment.Environ.is_defined}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{is\_defined}}}{\emph{key}}{}
3091 Check if the key exists in the environment
3092 \begin{quote}\begin{description}
3093 \item[{Parameters}] \leavevmode
3094 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable to check
3095
3096 \end{description}\end{quote}
3097
3098 \end{fulllineitems}
3099
3100 \index{prepend() (src.environment.Environ method)}
3101
3102 \begin{fulllineitems}
3103 \phantomsection\label{\detokenize{commands/apidoc/src:src.environment.Environ.prepend}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepend}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
3104 Same as prepend\_value but the value argument can be a list
3105 \begin{quote}\begin{description}
3106 \item[{Parameters}] \leavevmode\begin{itemize}
3107 \item {}
3108 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to prepend
3109
3110 \item {}
3111 \sphinxstyleliteralstrong{\sphinxupquote{str}}\sphinxstyleliteralstrong{\sphinxupquote{ or }}\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the value(s) to prepend to key
3112
3113 \item {}
3114 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
3115
3116 \end{itemize}
3117
3118 \end{description}\end{quote}
3119
3120 \end{fulllineitems}
3121
3122 \index{prepend\_value() (src.environment.Environ method)}
3123
3124 \begin{fulllineitems}
3125 \phantomsection\label{\detokenize{commands/apidoc/src:src.environment.Environ.prepend_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepend\_value}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
3126 prepend value to key using sep
3127 \begin{quote}\begin{description}
3128 \item[{Parameters}] \leavevmode\begin{itemize}
3129 \item {}
3130 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to prepend
3131
3132 \item {}
3133 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to prepend to key
3134
3135 \item {}
3136 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
3137
3138 \end{itemize}
3139
3140 \end{description}\end{quote}
3141
3142 \end{fulllineitems}
3143
3144 \index{set() (src.environment.Environ method)}
3145
3146 \begin{fulllineitems}
3147 \phantomsection\label{\detokenize{commands/apidoc/src:src.environment.Environ.set}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set}}}{\emph{key}, \emph{value}}{}
3148 Set the environment variable “key” to value “value”
3149 \begin{quote}\begin{description}
3150 \item[{Parameters}] \leavevmode\begin{itemize}
3151 \item {}
3152 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the environment variable to set
3153
3154 \item {}
3155 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value
3156
3157 \end{itemize}
3158
3159 \end{description}\end{quote}
3160
3161 \end{fulllineitems}
3162
3163
3164 \end{fulllineitems}
3165
3166 \index{FileEnvWriter (class in src.environment)}
3167
3168 \begin{fulllineitems}
3169 \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}}{}
3170 Class to dump the environment to a file.
3171 \index{write\_cfgForPy\_file() (src.environment.FileEnvWriter method)}
3172
3173 \begin{fulllineitems}
3174 \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}}{}
3175 Append to current opened aFile a cfgForPy
3176 environment (SALOME python launcher).
3177 \begin{quote}\begin{description}
3178 \item[{Parameters}] \leavevmode\begin{itemize}
3179 \item {}
3180 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{for\_package}}) \textendash{} the file path
3181
3182 \item {}
3183 \sphinxstyleliteralstrong{\sphinxupquote{dict}} (\sphinxstyleliteralemphasis{\sphinxupquote{additional\_env}}) \textendash{} a dictionary of additional variables
3184 to add to the environment
3185
3186 \item {}
3187 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} If not None, produce a relative environment
3188 designed for a package.
3189
3190 \end{itemize}
3191
3192 \end{description}\end{quote}
3193
3194 \end{fulllineitems}
3195
3196 \index{write\_env\_file() (src.environment.FileEnvWriter method)}
3197
3198 \begin{fulllineitems}
3199 \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}}{}
3200 Create an environment file.
3201 \begin{quote}\begin{description}
3202 \item[{Parameters}] \leavevmode\begin{itemize}
3203 \item {}
3204 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{shell}}) \textendash{} the file path
3205
3206 \item {}
3207 \sphinxstyleliteralstrong{\sphinxupquote{bool}} (\sphinxstyleliteralemphasis{\sphinxupquote{forBuild}}) \textendash{} if true, the build environment
3208
3209 \item {}
3210 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the type of file wanted (.sh, .bat)
3211
3212 \end{itemize}
3213
3214 \item[{Returns}] \leavevmode
3215 The path to the generated file
3216
3217 \item[{Return type}] \leavevmode
3218 str
3219
3220 \end{description}\end{quote}
3221
3222 \end{fulllineitems}
3223
3224
3225 \end{fulllineitems}
3226
3227 \index{SalomeEnviron (class in src.environment)}
3228
3229 \begin{fulllineitems}
3230 \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}}{}
3231 Class to manage the environment of SALOME.
3232 \index{add\_comment() (src.environment.SalomeEnviron method)}
3233
3234 \begin{fulllineitems}
3235 \phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.add_comment}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_comment}}}{\emph{comment}}{}
3236 Add a commentary to the out stream (in case of file generation)
3237 \begin{quote}\begin{description}
3238 \item[{Parameters}] \leavevmode
3239 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{comment}}) \textendash{} the commentary to add
3240
3241 \end{description}\end{quote}
3242
3243 \end{fulllineitems}
3244
3245 \index{add\_line() (src.environment.SalomeEnviron method)}
3246
3247 \begin{fulllineitems}
3248 \phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.add_line}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_line}}}{\emph{nb\_line}}{}
3249 Add empty lines to the out stream (in case of file generation)
3250 \begin{quote}\begin{description}
3251 \item[{Parameters}] \leavevmode
3252 \sphinxstyleliteralstrong{\sphinxupquote{int}} (\sphinxstyleliteralemphasis{\sphinxupquote{nb\_line}}) \textendash{} the number of empty lines to add
3253
3254 \end{description}\end{quote}
3255
3256 \end{fulllineitems}
3257
3258 \index{add\_warning() (src.environment.SalomeEnviron method)}
3259
3260 \begin{fulllineitems}
3261 \phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.add_warning}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_warning}}}{\emph{warning}}{}
3262 Add a warning to the out stream (in case of file generation)
3263 \begin{quote}\begin{description}
3264 \item[{Parameters}] \leavevmode
3265 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{warning}}) \textendash{} the warning to add
3266
3267 \end{description}\end{quote}
3268
3269 \end{fulllineitems}
3270
3271 \index{append() (src.environment.SalomeEnviron method)}
3272
3273 \begin{fulllineitems}
3274 \phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.append}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
3275 append value to key using sep
3276 \begin{quote}\begin{description}
3277 \item[{Parameters}] \leavevmode\begin{itemize}
3278 \item {}
3279 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to append
3280
3281 \item {}
3282 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to append to key
3283
3284 \item {}
3285 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
3286
3287 \end{itemize}
3288
3289 \end{description}\end{quote}
3290
3291 \end{fulllineitems}
3292
3293 \index{dump() (src.environment.SalomeEnviron method)}
3294
3295 \begin{fulllineitems}
3296 \phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.dump}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{dump}}}{\emph{out}}{}
3297 Write the environment to out
3298 \begin{quote}\begin{description}
3299 \item[{Parameters}] \leavevmode
3300 \sphinxstyleliteralstrong{\sphinxupquote{file}} (\sphinxstyleliteralemphasis{\sphinxupquote{out}}) \textendash{} the stream where to write the environment
3301
3302 \end{description}\end{quote}
3303
3304 \end{fulllineitems}
3305
3306 \index{finish() (src.environment.SalomeEnviron method)}
3307
3308 \begin{fulllineitems}
3309 \phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.finish}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{finish}}}{\emph{required}}{}
3310 Add a final instruction in the out file (in case of file generation)
3311 \begin{quote}\begin{description}
3312 \item[{Parameters}] \leavevmode
3313 \sphinxstyleliteralstrong{\sphinxupquote{bool}} (\sphinxstyleliteralemphasis{\sphinxupquote{required}}) \textendash{} Do nothing if required is False
3314
3315 \end{description}\end{quote}
3316
3317 \end{fulllineitems}
3318
3319 \index{get() (src.environment.SalomeEnviron method)}
3320
3321 \begin{fulllineitems}
3322 \phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.get}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get}}}{\emph{key}}{}
3323 Get the value of the environment variable “key”
3324 \begin{quote}\begin{description}
3325 \item[{Parameters}] \leavevmode
3326 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable
3327
3328 \end{description}\end{quote}
3329
3330 \end{fulllineitems}
3331
3332 \index{get\_names() (src.environment.SalomeEnviron method)}
3333
3334 \begin{fulllineitems}
3335 \phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.get_names}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_names}}}{\emph{lProducts}}{}
3336 Get the products name to add in SALOME\_MODULES environment variable
3337 It is the name of the product, except in the case where the is a
3338 component name. And it has to be in SALOME\_MODULES variable only
3339 if the product has the property has\_salome\_hui = “yes”
3340 \begin{quote}\begin{description}
3341 \item[{Parameters}] \leavevmode
3342 \sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{lProducts}}) \textendash{} List of products to potentially add
3343
3344 \end{description}\end{quote}
3345
3346 \end{fulllineitems}
3347
3348 \index{is\_defined() (src.environment.SalomeEnviron method)}
3349
3350 \begin{fulllineitems}
3351 \phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.is_defined}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{is\_defined}}}{\emph{key}}{}
3352 Check if the key exists in the environment
3353 \begin{quote}\begin{description}
3354 \item[{Parameters}] \leavevmode
3355 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable to check
3356
3357 \end{description}\end{quote}
3358
3359 \end{fulllineitems}
3360
3361 \index{load\_cfg\_environment() (src.environment.SalomeEnviron method)}
3362
3363 \begin{fulllineitems}
3364 \phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.load_cfg_environment}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{load\_cfg\_environment}}}{\emph{cfg\_env}}{}
3365 Loads environment defined in cfg\_env
3366 \begin{quote}\begin{description}
3367 \item[{Parameters}] \leavevmode
3368 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{cfg\_env}}) \textendash{} A config containing an environment
3369
3370 \end{description}\end{quote}
3371
3372 \end{fulllineitems}
3373
3374 \index{prepend() (src.environment.SalomeEnviron method)}
3375
3376 \begin{fulllineitems}
3377 \phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.prepend}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepend}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
3378 prepend value to key using sep
3379 \begin{quote}\begin{description}
3380 \item[{Parameters}] \leavevmode\begin{itemize}
3381 \item {}
3382 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to prepend
3383
3384 \item {}
3385 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to prepend to key
3386
3387 \item {}
3388 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
3389
3390 \end{itemize}
3391
3392 \end{description}\end{quote}
3393
3394 \end{fulllineitems}
3395
3396 \index{run\_env\_script() (src.environment.SalomeEnviron method)}
3397
3398 \begin{fulllineitems}
3399 \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}}{}
3400 Runs an environment script.
3401 \begin{quote}\begin{description}
3402 \item[{Parameters}] \leavevmode\begin{itemize}
3403 \item {}
3404 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The product description
3405
3406 \item {}
3407 \sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to display messages
3408
3409 \item {}
3410 \sphinxstyleliteralstrong{\sphinxupquote{Boolean}} (\sphinxstyleliteralemphasis{\sphinxupquote{native}}) \textendash{} if True load set\_native\_env instead of set\_env
3411
3412 \end{itemize}
3413
3414 \end{description}\end{quote}
3415
3416 \end{fulllineitems}
3417
3418 \index{run\_simple\_env\_script() (src.environment.SalomeEnviron method)}
3419
3420 \begin{fulllineitems}
3421 \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}}{}
3422 Runs an environment script. Same as run\_env\_script, but with a
3423 script path as parameter.
3424 \begin{quote}\begin{description}
3425 \item[{Parameters}] \leavevmode\begin{itemize}
3426 \item {}
3427 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{script\_path}}) \textendash{} a path to an environment script
3428
3429 \item {}
3430 \sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to display messages
3431
3432 \end{itemize}
3433
3434 \end{description}\end{quote}
3435
3436 \end{fulllineitems}
3437
3438 \index{set() (src.environment.SalomeEnviron method)}
3439
3440 \begin{fulllineitems}
3441 \phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.set}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set}}}{\emph{key}, \emph{value}}{}
3442 Set the environment variable “key” to value “value”
3443 \begin{quote}\begin{description}
3444 \item[{Parameters}] \leavevmode\begin{itemize}
3445 \item {}
3446 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the environment variable to set
3447
3448 \item {}
3449 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value
3450
3451 \end{itemize}
3452
3453 \end{description}\end{quote}
3454
3455 \end{fulllineitems}
3456
3457 \index{set\_a\_product() (src.environment.SalomeEnviron method)}
3458
3459 \begin{fulllineitems}
3460 \phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.set_a_product}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_a\_product}}}{\emph{product}, \emph{logger}}{}
3461 Sets the environment of a product.
3462 \begin{quote}\begin{description}
3463 \item[{Parameters}] \leavevmode\begin{itemize}
3464 \item {}
3465 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{product}}) \textendash{} The product name
3466
3467 \item {}
3468 \sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to display messages
3469
3470 \end{itemize}
3471
3472 \end{description}\end{quote}
3473
3474 \end{fulllineitems}
3475
3476 \index{set\_application\_env() (src.environment.SalomeEnviron method)}
3477
3478 \begin{fulllineitems}
3479 \phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.set_application_env}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_application\_env}}}{\emph{logger}}{}
3480 Sets the environment defined in the APPLICATION file.
3481 \begin{quote}\begin{description}
3482 \item[{Parameters}] \leavevmode
3483 \sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to display messages
3484
3485 \end{description}\end{quote}
3486
3487 \end{fulllineitems}
3488
3489 \index{set\_cpp\_env() (src.environment.SalomeEnviron method)}
3490
3491 \begin{fulllineitems}
3492 \phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.set_cpp_env}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_cpp\_env}}}{\emph{product\_info}}{}
3493 Sets the generic environment for a SALOME cpp product.
3494 \begin{quote}\begin{description}
3495 \item[{Parameters}] \leavevmode
3496 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The product description
3497
3498 \end{description}\end{quote}
3499
3500 \end{fulllineitems}
3501
3502 \index{set\_full\_environ() (src.environment.SalomeEnviron method)}
3503
3504 \begin{fulllineitems}
3505 \phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.set_full_environ}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_full\_environ}}}{\emph{logger}, \emph{env\_info}}{}
3506 Sets the full environment for products
3507 specified in env\_info dictionary.
3508 \begin{quote}\begin{description}
3509 \item[{Parameters}] \leavevmode\begin{itemize}
3510 \item {}
3511 \sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to display messages
3512
3513 \item {}
3514 \sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{env\_info}}) \textendash{} the list of products
3515
3516 \end{itemize}
3517
3518 \end{description}\end{quote}
3519
3520 \end{fulllineitems}
3521
3522 \index{set\_products() (src.environment.SalomeEnviron method)}
3523
3524 \begin{fulllineitems}
3525 \phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.set_products}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_products}}}{\emph{logger}, \emph{src\_root=None}}{}
3526 Sets the environment for all the products.
3527 \begin{quote}\begin{description}
3528 \item[{Parameters}] \leavevmode\begin{itemize}
3529 \item {}
3530 \sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to display messages
3531
3532 \item {}
3533 \sphinxstyleliteralstrong{\sphinxupquote{src}} (\sphinxstyleliteralemphasis{\sphinxupquote{src\_root}}) \textendash{} the application working directory
3534
3535 \end{itemize}
3536
3537 \end{description}\end{quote}
3538
3539 \end{fulllineitems}
3540
3541 \index{set\_python\_libdirs() (src.environment.SalomeEnviron method)}
3542
3543 \begin{fulllineitems}
3544 \phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.set_python_libdirs}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_python\_libdirs}}}{}{}
3545 Set some generic variables for python library paths
3546
3547 \end{fulllineitems}
3548
3549 \index{set\_salome\_generic\_product\_env() (src.environment.SalomeEnviron method)}
3550
3551 \begin{fulllineitems}
3552 \phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.set_salome_generic_product_env}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_salome\_generic\_product\_env}}}{\emph{pi}}{}
3553 Sets the generic environment for a SALOME product.
3554 \begin{quote}\begin{description}
3555 \item[{Parameters}] \leavevmode
3556 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{pi}}) \textendash{} The product description
3557
3558 \end{description}\end{quote}
3559
3560 \end{fulllineitems}
3561
3562 \index{set\_salome\_minimal\_product\_env() (src.environment.SalomeEnviron method)}
3563
3564 \begin{fulllineitems}
3565 \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}}{}
3566 Sets the minimal environment for a SALOME product.
3567 xxx\_ROOT\_DIR and xxx\_SRC\_DIR
3568 \begin{quote}\begin{description}
3569 \item[{Parameters}] \leavevmode\begin{itemize}
3570 \item {}
3571 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The product description
3572
3573 \item {}
3574 \sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to display messages
3575
3576 \end{itemize}
3577
3578 \end{description}\end{quote}
3579
3580 \end{fulllineitems}
3581
3582
3583 \end{fulllineitems}
3584
3585 \index{Shell (class in src.environment)}
3586
3587 \begin{fulllineitems}
3588 \phantomsection\label{\detokenize{commands/apidoc/src:src.environment.Shell}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.environment.}}\sphinxbfcode{\sphinxupquote{Shell}}}{\emph{name}, \emph{extension}}{}
3589 Definition of a Shell.
3590
3591 \end{fulllineitems}
3592
3593 \index{load\_environment() (in module src.environment)}
3594
3595 \begin{fulllineitems}
3596 \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}}{}
3597 Loads the environment (used to run the tests, for example).
3598 \begin{quote}\begin{description}
3599 \item[{Parameters}] \leavevmode\begin{itemize}
3600 \item {}
3601 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} the global config
3602
3603 \item {}
3604 \sphinxstyleliteralstrong{\sphinxupquote{bool}} (\sphinxstyleliteralemphasis{\sphinxupquote{build}}) \textendash{} build environement if True
3605
3606 \item {}
3607 \sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to display messages
3608
3609 \end{itemize}
3610
3611 \end{description}\end{quote}
3612
3613 \end{fulllineitems}
3614
3615
3616
3617 \subsubsection{src.fileEnviron module}
3618 \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)}
3619
3620 \begin{fulllineitems}
3621 \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}}{}
3622 Bases: {\hyperref[\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.fileEnviron.FileEnviron}}}}} (\autopageref*{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron}})
3623
3624 Class for bash shell.
3625 \index{command\_value() (src.fileEnviron.BashFileEnviron method)}
3626
3627 \begin{fulllineitems}
3628 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.BashFileEnviron.command_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{command\_value}}}{\emph{key}, \emph{command}}{}
3629 Get the value given by the system command “command”
3630 and put it in the environment variable key.
3631 Has to be overwritten in the derived classes
3632 This can be seen as a virtual method
3633 \begin{quote}\begin{description}
3634 \item[{Parameters}] \leavevmode\begin{itemize}
3635 \item {}
3636 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{command}}) \textendash{} the environment variable
3637
3638 \item {}
3639 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the command to execute
3640
3641 \end{itemize}
3642
3643 \end{description}\end{quote}
3644
3645 \end{fulllineitems}
3646
3647 \index{finish() (src.fileEnviron.BashFileEnviron method)}
3648
3649 \begin{fulllineitems}
3650 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.BashFileEnviron.finish}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{finish}}}{\emph{required=True}}{}
3651 Add a final instruction in the out file (in case of file generation)
3652 \begin{quote}\begin{description}
3653 \item[{Parameters}] \leavevmode
3654 \sphinxstyleliteralstrong{\sphinxupquote{bool}} (\sphinxstyleliteralemphasis{\sphinxupquote{required}}) \textendash{} Do nothing if required is False
3655
3656 \end{description}\end{quote}
3657
3658 \end{fulllineitems}
3659
3660 \index{set() (src.fileEnviron.BashFileEnviron method)}
3661
3662 \begin{fulllineitems}
3663 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.BashFileEnviron.set}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set}}}{\emph{key}, \emph{value}}{}
3664 Set the environment variable “key” to value “value”
3665 \begin{quote}\begin{description}
3666 \item[{Parameters}] \leavevmode\begin{itemize}
3667 \item {}
3668 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the environment variable to set
3669
3670 \item {}
3671 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value
3672
3673 \end{itemize}
3674
3675 \end{description}\end{quote}
3676
3677 \end{fulllineitems}
3678
3679
3680 \end{fulllineitems}
3681
3682 \index{BatFileEnviron (class in src.fileEnviron)}
3683
3684 \begin{fulllineitems}
3685 \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}}{}
3686 Bases: {\hyperref[\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.fileEnviron.FileEnviron}}}}} (\autopageref*{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron}})
3687
3688 for Windows batch shell.
3689 \index{add\_comment() (src.fileEnviron.BatFileEnviron method)}
3690
3691 \begin{fulllineitems}
3692 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.BatFileEnviron.add_comment}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_comment}}}{\emph{comment}}{}
3693 Add a comment in the shell file
3694 \begin{quote}\begin{description}
3695 \item[{Parameters}] \leavevmode
3696 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{comment}}) \textendash{} the comment to add
3697
3698 \end{description}\end{quote}
3699
3700 \end{fulllineitems}
3701
3702 \index{command\_value() (src.fileEnviron.BatFileEnviron method)}
3703
3704 \begin{fulllineitems}
3705 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.BatFileEnviron.command_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{command\_value}}}{\emph{key}, \emph{command}}{}
3706 Get the value given by the system command “command”
3707 and put it in the environment variable key.
3708 Has to be overwritten in the derived classes
3709 This can be seen as a virtual method
3710 \begin{quote}\begin{description}
3711 \item[{Parameters}] \leavevmode\begin{itemize}
3712 \item {}
3713 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{command}}) \textendash{} the environment variable
3714
3715 \item {}
3716 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the command to execute
3717
3718 \end{itemize}
3719
3720 \end{description}\end{quote}
3721
3722 \end{fulllineitems}
3723
3724 \index{finish() (src.fileEnviron.BatFileEnviron method)}
3725
3726 \begin{fulllineitems}
3727 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.BatFileEnviron.finish}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{finish}}}{\emph{required=True}}{}
3728 Add a final instruction in the out file (in case of file generation)
3729 In the particular windows case, do nothing
3730 \begin{quote}\begin{description}
3731 \item[{Parameters}] \leavevmode
3732 \sphinxstyleliteralstrong{\sphinxupquote{bool}} (\sphinxstyleliteralemphasis{\sphinxupquote{required}}) \textendash{} Do nothing if required is False
3733
3734 \end{description}\end{quote}
3735
3736 \end{fulllineitems}
3737
3738 \index{get() (src.fileEnviron.BatFileEnviron method)}
3739
3740 \begin{fulllineitems}
3741 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.BatFileEnviron.get}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get}}}{\emph{key}}{}
3742 Get the value of the environment variable “key”
3743 \begin{quote}\begin{description}
3744 \item[{Parameters}] \leavevmode
3745 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable
3746
3747 \end{description}\end{quote}
3748
3749 \end{fulllineitems}
3750
3751 \index{set() (src.fileEnviron.BatFileEnviron method)}
3752
3753 \begin{fulllineitems}
3754 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.BatFileEnviron.set}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set}}}{\emph{key}, \emph{value}}{}
3755 Set the environment variable “key” to value “value”
3756 \begin{quote}\begin{description}
3757 \item[{Parameters}] \leavevmode\begin{itemize}
3758 \item {}
3759 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the environment variable to set
3760
3761 \item {}
3762 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value
3763
3764 \end{itemize}
3765
3766 \end{description}\end{quote}
3767
3768 \end{fulllineitems}
3769
3770
3771 \end{fulllineitems}
3772
3773 \index{ContextFileEnviron (class in src.fileEnviron)}
3774
3775 \begin{fulllineitems}
3776 \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}}{}
3777 Bases: {\hyperref[\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.fileEnviron.FileEnviron}}}}} (\autopageref*{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron}})
3778
3779 Class for a salome context configuration file.
3780 \index{add\_echo() (src.fileEnviron.ContextFileEnviron method)}
3781
3782 \begin{fulllineitems}
3783 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.add_echo}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_echo}}}{\emph{text}}{}
3784 Add a comment
3785 \begin{quote}\begin{description}
3786 \item[{Parameters}] \leavevmode
3787 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{text}}) \textendash{} the comment to add
3788
3789 \end{description}\end{quote}
3790
3791 \end{fulllineitems}
3792
3793 \index{add\_warning() (src.fileEnviron.ContextFileEnviron method)}
3794
3795 \begin{fulllineitems}
3796 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.add_warning}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_warning}}}{\emph{warning}}{}
3797 Add a warning
3798 \begin{quote}\begin{description}
3799 \item[{Parameters}] \leavevmode
3800 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{text}}) \textendash{} the warning to add
3801
3802 \end{description}\end{quote}
3803
3804 \end{fulllineitems}
3805
3806 \index{append\_value() (src.fileEnviron.ContextFileEnviron method)}
3807
3808 \begin{fulllineitems}
3809 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.append_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append\_value}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
3810 append value to key using sep
3811 \begin{quote}\begin{description}
3812 \item[{Parameters}] \leavevmode\begin{itemize}
3813 \item {}
3814 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to append
3815
3816 \item {}
3817 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to append to key
3818
3819 \item {}
3820 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
3821
3822 \end{itemize}
3823
3824 \end{description}\end{quote}
3825
3826 \end{fulllineitems}
3827
3828 \index{command\_value() (src.fileEnviron.ContextFileEnviron method)}
3829
3830 \begin{fulllineitems}
3831 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.command_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{command\_value}}}{\emph{key}, \emph{command}}{}
3832 Get the value given by the system command “command”
3833 and put it in the environment variable key.
3834 Has to be overwritten in the derived classes
3835 This can be seen as a virtual method
3836 \begin{quote}\begin{description}
3837 \item[{Parameters}] \leavevmode\begin{itemize}
3838 \item {}
3839 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{command}}) \textendash{} the environment variable
3840
3841 \item {}
3842 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the command to execute
3843
3844 \end{itemize}
3845
3846 \end{description}\end{quote}
3847
3848 \end{fulllineitems}
3849
3850 \index{finish() (src.fileEnviron.ContextFileEnviron method)}
3851
3852 \begin{fulllineitems}
3853 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.finish}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{finish}}}{\emph{required=True}}{}
3854 Add a final instruction in the out file (in case of file generation)
3855 \begin{quote}\begin{description}
3856 \item[{Parameters}] \leavevmode
3857 \sphinxstyleliteralstrong{\sphinxupquote{bool}} (\sphinxstyleliteralemphasis{\sphinxupquote{required}}) \textendash{} Do nothing if required is False
3858
3859 \end{description}\end{quote}
3860
3861 \end{fulllineitems}
3862
3863 \index{get() (src.fileEnviron.ContextFileEnviron method)}
3864
3865 \begin{fulllineitems}
3866 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.get}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get}}}{\emph{key}}{}
3867 Get the value of the environment variable “key”
3868 \begin{quote}\begin{description}
3869 \item[{Parameters}] \leavevmode
3870 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable
3871
3872 \end{description}\end{quote}
3873
3874 \end{fulllineitems}
3875
3876 \index{prepend\_value() (src.fileEnviron.ContextFileEnviron method)}
3877
3878 \begin{fulllineitems}
3879 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.prepend_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepend\_value}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
3880 prepend value to key using sep
3881 \begin{quote}\begin{description}
3882 \item[{Parameters}] \leavevmode\begin{itemize}
3883 \item {}
3884 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to prepend
3885
3886 \item {}
3887 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to prepend to key
3888
3889 \item {}
3890 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
3891
3892 \end{itemize}
3893
3894 \end{description}\end{quote}
3895
3896 \end{fulllineitems}
3897
3898 \index{set() (src.fileEnviron.ContextFileEnviron method)}
3899
3900 \begin{fulllineitems}
3901 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.set}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set}}}{\emph{key}, \emph{value}}{}
3902 Set the environment variable “key” to value “value”
3903 \begin{quote}\begin{description}
3904 \item[{Parameters}] \leavevmode\begin{itemize}
3905 \item {}
3906 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the environment variable to set
3907
3908 \item {}
3909 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value
3910
3911 \end{itemize}
3912
3913 \end{description}\end{quote}
3914
3915 \end{fulllineitems}
3916
3917
3918 \end{fulllineitems}
3919
3920 \index{FileEnviron (class in src.fileEnviron)}
3921
3922 \begin{fulllineitems}
3923 \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}}{}
3924 Bases: \sphinxcode{\sphinxupquote{object}}
3925
3926 Base class for shell environment
3927 \index{add\_comment() (src.fileEnviron.FileEnviron method)}
3928
3929 \begin{fulllineitems}
3930 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.add_comment}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_comment}}}{\emph{comment}}{}
3931 Add a comment in the shell file
3932 \begin{quote}\begin{description}
3933 \item[{Parameters}] \leavevmode
3934 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{comment}}) \textendash{} the comment to add
3935
3936 \end{description}\end{quote}
3937
3938 \end{fulllineitems}
3939
3940 \index{add\_echo() (src.fileEnviron.FileEnviron method)}
3941
3942 \begin{fulllineitems}
3943 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.add_echo}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_echo}}}{\emph{text}}{}
3944 Add a “echo” in the shell file
3945 \begin{quote}\begin{description}
3946 \item[{Parameters}] \leavevmode
3947 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{text}}) \textendash{} the text to echo
3948
3949 \end{description}\end{quote}
3950
3951 \end{fulllineitems}
3952
3953 \index{add\_line() (src.fileEnviron.FileEnviron method)}
3954
3955 \begin{fulllineitems}
3956 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.add_line}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_line}}}{\emph{number}}{}
3957 Add some empty lines in the shell file
3958 \begin{quote}\begin{description}
3959 \item[{Parameters}] \leavevmode
3960 \sphinxstyleliteralstrong{\sphinxupquote{int}} (\sphinxstyleliteralemphasis{\sphinxupquote{number}}) \textendash{} the number of lines to add
3961
3962 \end{description}\end{quote}
3963
3964 \end{fulllineitems}
3965
3966 \index{add\_warning() (src.fileEnviron.FileEnviron method)}
3967
3968 \begin{fulllineitems}
3969 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.add_warning}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_warning}}}{\emph{warning}}{}
3970 Add a warning “echo” in the shell file
3971 \begin{quote}\begin{description}
3972 \item[{Parameters}] \leavevmode
3973 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{warning}}) \textendash{} the text to echo
3974
3975 \end{description}\end{quote}
3976
3977 \end{fulllineitems}
3978
3979 \index{append() (src.fileEnviron.FileEnviron method)}
3980
3981 \begin{fulllineitems}
3982 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.append}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
3983 Same as append\_value but the value argument can be a list
3984 \begin{quote}\begin{description}
3985 \item[{Parameters}] \leavevmode\begin{itemize}
3986 \item {}
3987 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to append
3988
3989 \item {}
3990 \sphinxstyleliteralstrong{\sphinxupquote{str}}\sphinxstyleliteralstrong{\sphinxupquote{ or }}\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the value(s) to append to key
3991
3992 \item {}
3993 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
3994
3995 \end{itemize}
3996
3997 \end{description}\end{quote}
3998
3999 \end{fulllineitems}
4000
4001 \index{append\_value() (src.fileEnviron.FileEnviron method)}
4002
4003 \begin{fulllineitems}
4004 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.append_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append\_value}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
4005 append value to key using sep
4006 \begin{quote}\begin{description}
4007 \item[{Parameters}] \leavevmode\begin{itemize}
4008 \item {}
4009 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to append
4010
4011 \item {}
4012 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to append to key
4013
4014 \item {}
4015 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
4016
4017 \end{itemize}
4018
4019 \end{description}\end{quote}
4020
4021 \end{fulllineitems}
4022
4023 \index{command\_value() (src.fileEnviron.FileEnviron method)}
4024
4025 \begin{fulllineitems}
4026 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.command_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{command\_value}}}{\emph{key}, \emph{command}}{}
4027 Get the value given by the system command “command”
4028 and put it in the environment variable key.
4029 Has to be overwritten in the derived classes
4030 This can be seen as a virtual method
4031 \begin{quote}\begin{description}
4032 \item[{Parameters}] \leavevmode\begin{itemize}
4033 \item {}
4034 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{command}}) \textendash{} the environment variable
4035
4036 \item {}
4037 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the command to execute
4038
4039 \end{itemize}
4040
4041 \end{description}\end{quote}
4042
4043 \end{fulllineitems}
4044
4045 \index{finish() (src.fileEnviron.FileEnviron method)}
4046
4047 \begin{fulllineitems}
4048 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.finish}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{finish}}}{\emph{required=True}}{}
4049 Add a final instruction in the out file (in case of file generation)
4050 \begin{quote}\begin{description}
4051 \item[{Parameters}] \leavevmode
4052 \sphinxstyleliteralstrong{\sphinxupquote{bool}} (\sphinxstyleliteralemphasis{\sphinxupquote{required}}) \textendash{} Do nothing if required is False
4053
4054 \end{description}\end{quote}
4055
4056 \end{fulllineitems}
4057
4058 \index{get() (src.fileEnviron.FileEnviron method)}
4059
4060 \begin{fulllineitems}
4061 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.get}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get}}}{\emph{key}}{}
4062 Get the value of the environment variable “key”
4063 \begin{quote}\begin{description}
4064 \item[{Parameters}] \leavevmode
4065 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable
4066
4067 \end{description}\end{quote}
4068
4069 \end{fulllineitems}
4070
4071 \index{is\_defined() (src.fileEnviron.FileEnviron method)}
4072
4073 \begin{fulllineitems}
4074 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.is_defined}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{is\_defined}}}{\emph{key}}{}
4075 Check if the key exists in the environment
4076 \begin{quote}\begin{description}
4077 \item[{Parameters}] \leavevmode
4078 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable to check
4079
4080 \end{description}\end{quote}
4081
4082 \end{fulllineitems}
4083
4084 \index{prepend() (src.fileEnviron.FileEnviron method)}
4085
4086 \begin{fulllineitems}
4087 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.prepend}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepend}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
4088 Same as prepend\_value but the value argument can be a list
4089 \begin{quote}\begin{description}
4090 \item[{Parameters}] \leavevmode\begin{itemize}
4091 \item {}
4092 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to prepend
4093
4094 \item {}
4095 \sphinxstyleliteralstrong{\sphinxupquote{str}}\sphinxstyleliteralstrong{\sphinxupquote{ or }}\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the value(s) to prepend to key
4096
4097 \item {}
4098 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
4099
4100 \end{itemize}
4101
4102 \end{description}\end{quote}
4103
4104 \end{fulllineitems}
4105
4106 \index{prepend\_value() (src.fileEnviron.FileEnviron method)}
4107
4108 \begin{fulllineitems}
4109 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.prepend_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepend\_value}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
4110 prepend value to key using sep
4111 \begin{quote}\begin{description}
4112 \item[{Parameters}] \leavevmode\begin{itemize}
4113 \item {}
4114 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to prepend
4115
4116 \item {}
4117 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to prepend to key
4118
4119 \item {}
4120 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
4121
4122 \end{itemize}
4123
4124 \end{description}\end{quote}
4125
4126 \end{fulllineitems}
4127
4128 \index{set() (src.fileEnviron.FileEnviron method)}
4129
4130 \begin{fulllineitems}
4131 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.set}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set}}}{\emph{key}, \emph{value}}{}
4132 Set the environment variable ‘key’ to value ‘value’
4133 \begin{quote}\begin{description}
4134 \item[{Parameters}] \leavevmode\begin{itemize}
4135 \item {}
4136 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the environment variable to set
4137
4138 \item {}
4139 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value
4140
4141 \end{itemize}
4142
4143 \end{description}\end{quote}
4144
4145 \end{fulllineitems}
4146
4147
4148 \end{fulllineitems}
4149
4150 \index{LauncherFileEnviron (class in src.fileEnviron)}
4151
4152 \begin{fulllineitems}
4153 \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}}{}
4154 Class to generate a launcher file script
4155 (in python syntax) SalomeContext API
4156 \index{add() (src.fileEnviron.LauncherFileEnviron method)}
4157
4158 \begin{fulllineitems}
4159 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add}}}{\emph{key}, \emph{value}}{}
4160 prepend value to key using sep
4161 \begin{quote}\begin{description}
4162 \item[{Parameters}] \leavevmode\begin{itemize}
4163 \item {}
4164 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the environment variable to prepend
4165
4166 \item {}
4167 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to prepend to key
4168
4169 \end{itemize}
4170
4171 \end{description}\end{quote}
4172
4173 \end{fulllineitems}
4174
4175 \index{add\_comment() (src.fileEnviron.LauncherFileEnviron method)}
4176
4177 \begin{fulllineitems}
4178 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add_comment}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_comment}}}{\emph{comment}}{}
4179 \end{fulllineitems}
4180
4181 \index{add\_echo() (src.fileEnviron.LauncherFileEnviron method)}
4182
4183 \begin{fulllineitems}
4184 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add_echo}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_echo}}}{\emph{text}}{}
4185 Add a comment
4186 \begin{quote}\begin{description}
4187 \item[{Parameters}] \leavevmode
4188 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{text}}) \textendash{} the comment to add
4189
4190 \end{description}\end{quote}
4191
4192 \end{fulllineitems}
4193
4194 \index{add\_line() (src.fileEnviron.LauncherFileEnviron method)}
4195
4196 \begin{fulllineitems}
4197 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add_line}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_line}}}{\emph{number}}{}
4198 Add some empty lines in the launcher file
4199 \begin{quote}\begin{description}
4200 \item[{Parameters}] \leavevmode
4201 \sphinxstyleliteralstrong{\sphinxupquote{int}} (\sphinxstyleliteralemphasis{\sphinxupquote{number}}) \textendash{} the number of lines to add
4202
4203 \end{description}\end{quote}
4204
4205 \end{fulllineitems}
4206
4207 \index{add\_warning() (src.fileEnviron.LauncherFileEnviron method)}
4208
4209 \begin{fulllineitems}
4210 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add_warning}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_warning}}}{\emph{warning}}{}
4211 Add a warning
4212 \begin{quote}\begin{description}
4213 \item[{Parameters}] \leavevmode
4214 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{text}}) \textendash{} the warning to add
4215
4216 \end{description}\end{quote}
4217
4218 \end{fulllineitems}
4219
4220 \index{append() (src.fileEnviron.LauncherFileEnviron method)}
4221
4222 \begin{fulllineitems}
4223 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.append}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
4224 Same as append\_value but the value argument can be a list
4225 \begin{quote}\begin{description}
4226 \item[{Parameters}] \leavevmode\begin{itemize}
4227 \item {}
4228 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to append
4229
4230 \item {}
4231 \sphinxstyleliteralstrong{\sphinxupquote{str}}\sphinxstyleliteralstrong{\sphinxupquote{ or }}\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the value(s) to append to key
4232
4233 \item {}
4234 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
4235
4236 \end{itemize}
4237
4238 \end{description}\end{quote}
4239
4240 \end{fulllineitems}
4241
4242 \index{append\_value() (src.fileEnviron.LauncherFileEnviron method)}
4243
4244 \begin{fulllineitems}
4245 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.append_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append\_value}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
4246 append value to key using sep
4247 \begin{quote}\begin{description}
4248 \item[{Parameters}] \leavevmode\begin{itemize}
4249 \item {}
4250 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to append
4251
4252 \item {}
4253 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to append to key
4254
4255 \item {}
4256 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
4257
4258 \end{itemize}
4259
4260 \end{description}\end{quote}
4261
4262 \end{fulllineitems}
4263
4264 \index{change\_to\_launcher() (src.fileEnviron.LauncherFileEnviron method)}
4265
4266 \begin{fulllineitems}
4267 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.change_to_launcher}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{change\_to\_launcher}}}{\emph{value}}{}
4268 \end{fulllineitems}
4269
4270 \index{command\_value() (src.fileEnviron.LauncherFileEnviron method)}
4271
4272 \begin{fulllineitems}
4273 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.command_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{command\_value}}}{\emph{key}, \emph{command}}{}
4274 Get the value given by the system command “command”
4275 and put it in the environment variable key.
4276 \begin{quote}\begin{description}
4277 \item[{Parameters}] \leavevmode\begin{itemize}
4278 \item {}
4279 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{command}}) \textendash{} the environment variable
4280
4281 \item {}
4282 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the command to execute
4283
4284 \end{itemize}
4285
4286 \end{description}\end{quote}
4287
4288 \end{fulllineitems}
4289
4290 \index{finish() (src.fileEnviron.LauncherFileEnviron method)}
4291
4292 \begin{fulllineitems}
4293 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.finish}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{finish}}}{\emph{required=True}}{}
4294 Add a final instruction in the out file (in case of file generation)
4295 In the particular launcher case, do nothing
4296 \begin{quote}\begin{description}
4297 \item[{Parameters}] \leavevmode
4298 \sphinxstyleliteralstrong{\sphinxupquote{bool}} (\sphinxstyleliteralemphasis{\sphinxupquote{required}}) \textendash{} Do nothing if required is False
4299
4300 \end{description}\end{quote}
4301
4302 \end{fulllineitems}
4303
4304 \index{get() (src.fileEnviron.LauncherFileEnviron method)}
4305
4306 \begin{fulllineitems}
4307 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.get}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get}}}{\emph{key}}{}
4308 Get the value of the environment variable “key”
4309 \begin{quote}\begin{description}
4310 \item[{Parameters}] \leavevmode
4311 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable
4312
4313 \end{description}\end{quote}
4314
4315 \end{fulllineitems}
4316
4317 \index{is\_defined() (src.fileEnviron.LauncherFileEnviron method)}
4318
4319 \begin{fulllineitems}
4320 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.is_defined}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{is\_defined}}}{\emph{key}}{}
4321 Check if the key exists in the environment
4322 \begin{quote}\begin{description}
4323 \item[{Parameters}] \leavevmode
4324 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable to check
4325
4326 \end{description}\end{quote}
4327
4328 \end{fulllineitems}
4329
4330 \index{prepend() (src.fileEnviron.LauncherFileEnviron method)}
4331
4332 \begin{fulllineitems}
4333 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.prepend}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepend}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
4334 Same as prepend\_value but the value argument can be a list
4335 \begin{quote}\begin{description}
4336 \item[{Parameters}] \leavevmode\begin{itemize}
4337 \item {}
4338 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to prepend
4339
4340 \item {}
4341 \sphinxstyleliteralstrong{\sphinxupquote{str}}\sphinxstyleliteralstrong{\sphinxupquote{ or }}\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the value(s) to prepend to key
4342
4343 \item {}
4344 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
4345
4346 \end{itemize}
4347
4348 \end{description}\end{quote}
4349
4350 \end{fulllineitems}
4351
4352 \index{prepend\_value() (src.fileEnviron.LauncherFileEnviron method)}
4353
4354 \begin{fulllineitems}
4355 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.prepend_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepend\_value}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
4356 prepend value to key using sep
4357 \begin{quote}\begin{description}
4358 \item[{Parameters}] \leavevmode\begin{itemize}
4359 \item {}
4360 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to prepend
4361
4362 \item {}
4363 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to prepend to key
4364
4365 \item {}
4366 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
4367
4368 \end{itemize}
4369
4370 \end{description}\end{quote}
4371
4372 \end{fulllineitems}
4373
4374 \index{set() (src.fileEnviron.LauncherFileEnviron method)}
4375
4376 \begin{fulllineitems}
4377 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.set}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set}}}{\emph{key}, \emph{value}}{}
4378 Set the environment variable “key” to value “value”
4379 \begin{quote}\begin{description}
4380 \item[{Parameters}] \leavevmode\begin{itemize}
4381 \item {}
4382 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the environment variable to set
4383
4384 \item {}
4385 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value
4386
4387 \end{itemize}
4388
4389 \end{description}\end{quote}
4390
4391 \end{fulllineitems}
4392
4393
4394 \end{fulllineitems}
4395
4396 \index{ScreenEnviron (class in src.fileEnviron)}
4397
4398 \begin{fulllineitems}
4399 \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}}{}
4400 Bases: {\hyperref[\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.fileEnviron.FileEnviron}}}}} (\autopageref*{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron}})
4401 \index{add\_comment() (src.fileEnviron.ScreenEnviron method)}
4402
4403 \begin{fulllineitems}
4404 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.add_comment}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_comment}}}{\emph{comment}}{}
4405 Add a comment in the shell file
4406 \begin{quote}\begin{description}
4407 \item[{Parameters}] \leavevmode
4408 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{comment}}) \textendash{} the comment to add
4409
4410 \end{description}\end{quote}
4411
4412 \end{fulllineitems}
4413
4414 \index{add\_echo() (src.fileEnviron.ScreenEnviron method)}
4415
4416 \begin{fulllineitems}
4417 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.add_echo}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_echo}}}{\emph{text}}{}
4418 Add a “echo” in the shell file
4419 \begin{quote}\begin{description}
4420 \item[{Parameters}] \leavevmode
4421 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{text}}) \textendash{} the text to echo
4422
4423 \end{description}\end{quote}
4424
4425 \end{fulllineitems}
4426
4427 \index{add\_line() (src.fileEnviron.ScreenEnviron method)}
4428
4429 \begin{fulllineitems}
4430 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.add_line}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_line}}}{\emph{number}}{}
4431 Add some empty lines in the shell file
4432 \begin{quote}\begin{description}
4433 \item[{Parameters}] \leavevmode
4434 \sphinxstyleliteralstrong{\sphinxupquote{int}} (\sphinxstyleliteralemphasis{\sphinxupquote{number}}) \textendash{} the number of lines to add
4435
4436 \end{description}\end{quote}
4437
4438 \end{fulllineitems}
4439
4440 \index{add\_warning() (src.fileEnviron.ScreenEnviron method)}
4441
4442 \begin{fulllineitems}
4443 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.add_warning}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_warning}}}{\emph{warning}}{}
4444 Add a warning “echo” in the shell file
4445 \begin{quote}\begin{description}
4446 \item[{Parameters}] \leavevmode
4447 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{warning}}) \textendash{} the text to echo
4448
4449 \end{description}\end{quote}
4450
4451 \end{fulllineitems}
4452
4453 \index{append() (src.fileEnviron.ScreenEnviron method)}
4454
4455 \begin{fulllineitems}
4456 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.append}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append}}}{\emph{name}, \emph{value}, \emph{sep=':'}}{}
4457 Same as append\_value but the value argument can be a list
4458 \begin{quote}\begin{description}
4459 \item[{Parameters}] \leavevmode\begin{itemize}
4460 \item {}
4461 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to append
4462
4463 \item {}
4464 \sphinxstyleliteralstrong{\sphinxupquote{str}}\sphinxstyleliteralstrong{\sphinxupquote{ or }}\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the value(s) to append to key
4465
4466 \item {}
4467 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
4468
4469 \end{itemize}
4470
4471 \end{description}\end{quote}
4472
4473 \end{fulllineitems}
4474
4475 \index{command\_value() (src.fileEnviron.ScreenEnviron method)}
4476
4477 \begin{fulllineitems}
4478 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.command_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{command\_value}}}{\emph{key}, \emph{command}}{}
4479 Get the value given by the system command “command”
4480 and put it in the environment variable key.
4481 Has to be overwritten in the derived classes
4482 This can be seen as a virtual method
4483 \begin{quote}\begin{description}
4484 \item[{Parameters}] \leavevmode\begin{itemize}
4485 \item {}
4486 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{command}}) \textendash{} the environment variable
4487
4488 \item {}
4489 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the command to execute
4490
4491 \end{itemize}
4492
4493 \end{description}\end{quote}
4494
4495 \end{fulllineitems}
4496
4497 \index{get() (src.fileEnviron.ScreenEnviron method)}
4498
4499 \begin{fulllineitems}
4500 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.get}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get}}}{\emph{name}}{}
4501 Get the value of the environment variable “key”
4502 \begin{quote}\begin{description}
4503 \item[{Parameters}] \leavevmode
4504 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable
4505
4506 \end{description}\end{quote}
4507
4508 \end{fulllineitems}
4509
4510 \index{is\_defined() (src.fileEnviron.ScreenEnviron method)}
4511
4512 \begin{fulllineitems}
4513 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.is_defined}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{is\_defined}}}{\emph{name}}{}
4514 Check if the key exists in the environment
4515 \begin{quote}\begin{description}
4516 \item[{Parameters}] \leavevmode
4517 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable to check
4518
4519 \end{description}\end{quote}
4520
4521 \end{fulllineitems}
4522
4523 \index{prepend() (src.fileEnviron.ScreenEnviron method)}
4524
4525 \begin{fulllineitems}
4526 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.prepend}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepend}}}{\emph{name}, \emph{value}, \emph{sep=':'}}{}
4527 Same as prepend\_value but the value argument can be a list
4528 \begin{quote}\begin{description}
4529 \item[{Parameters}] \leavevmode\begin{itemize}
4530 \item {}
4531 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to prepend
4532
4533 \item {}
4534 \sphinxstyleliteralstrong{\sphinxupquote{str}}\sphinxstyleliteralstrong{\sphinxupquote{ or }}\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the value(s) to prepend to key
4535
4536 \item {}
4537 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
4538
4539 \end{itemize}
4540
4541 \end{description}\end{quote}
4542
4543 \end{fulllineitems}
4544
4545 \index{run\_env\_script() (src.fileEnviron.ScreenEnviron method)}
4546
4547 \begin{fulllineitems}
4548 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.run_env_script}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run\_env\_script}}}{\emph{module}, \emph{script}}{}
4549 \end{fulllineitems}
4550
4551 \index{set() (src.fileEnviron.ScreenEnviron method)}
4552
4553 \begin{fulllineitems}
4554 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.set}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set}}}{\emph{name}, \emph{value}}{}
4555 Set the environment variable ‘key’ to value ‘value’
4556 \begin{quote}\begin{description}
4557 \item[{Parameters}] \leavevmode\begin{itemize}
4558 \item {}
4559 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the environment variable to set
4560
4561 \item {}
4562 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value
4563
4564 \end{itemize}
4565
4566 \end{description}\end{quote}
4567
4568 \end{fulllineitems}
4569
4570 \index{write() (src.fileEnviron.ScreenEnviron method)}
4571
4572 \begin{fulllineitems}
4573 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.write}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write}}}{\emph{command}, \emph{name}, \emph{value}, \emph{sign='='}}{}
4574 \end{fulllineitems}
4575
4576
4577 \end{fulllineitems}
4578
4579 \index{get\_file\_environ() (in module src.fileEnviron)}
4580
4581 \begin{fulllineitems}
4582 \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}}{}
4583 Instantiate correct FileEnvironment sub-class.
4584 \begin{quote}\begin{description}
4585 \item[{Parameters}] \leavevmode\begin{itemize}
4586 \item {}
4587 \sphinxstyleliteralstrong{\sphinxupquote{file}} (\sphinxstyleliteralemphasis{\sphinxupquote{output}}) \textendash{} the output file stream.
4588
4589 \item {}
4590 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{shell}}) \textendash{} the type of shell syntax to use.
4591
4592 \item {}
4593 \sphinxstyleliteralstrong{\sphinxupquote{dict}} (\sphinxstyleliteralemphasis{\sphinxupquote{environ}}) \textendash{} a potential additional environment.
4594
4595 \end{itemize}
4596
4597 \end{description}\end{quote}
4598
4599 \end{fulllineitems}
4600
4601 \index{special\_path\_separator() (in module src.fileEnviron)}
4602
4603 \begin{fulllineitems}
4604 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.special_path_separator}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.fileEnviron.}}\sphinxbfcode{\sphinxupquote{special\_path\_separator}}}{\emph{name}}{}
4605 TCLLIBPATH, TKLIBPATH, PV\_PLUGIN\_PATH environments variables need
4606 some exotic path separator.
4607 This function gives the separator regarding the name of the variable
4608 to append or prepend.
4609 \begin{quote}\begin{description}
4610 \item[{Parameters}] \leavevmode
4611 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{name}}) \textendash{} The name of the variable to find the separator
4612
4613 \end{description}\end{quote}
4614
4615 \end{fulllineitems}
4616
4617
4618
4619 \subsubsection{src.fork module}
4620 \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)}
4621
4622 \begin{fulllineitems}
4623 \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}}{}
4624 \end{fulllineitems}
4625
4626 \index{batch\_salome() (in module src.fork)}
4627
4628 \begin{fulllineitems}
4629 \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}}{}
4630 \end{fulllineitems}
4631
4632 \index{launch\_command() (in module src.fork)}
4633
4634 \begin{fulllineitems}
4635 \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}}{}
4636 \end{fulllineitems}
4637
4638 \index{show\_progress() (in module src.fork)}
4639
4640 \begin{fulllineitems}
4641 \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=''}}{}
4642 shortcut function to display the progression
4643 \begin{quote}\begin{description}
4644 \item[{Parameters}] \leavevmode\begin{itemize}
4645 \item {}
4646 \sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logging instance
4647
4648 \item {}
4649 \sphinxstyleliteralstrong{\sphinxupquote{int}} (\sphinxstyleliteralemphasis{\sphinxupquote{delai}}) \textendash{} the number to display
4650
4651 \item {}
4652 \sphinxstyleliteralstrong{\sphinxupquote{int}} \textendash{} the number max
4653
4654 \item {}
4655 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{ss}}) \textendash{} the string to display
4656
4657 \end{itemize}
4658
4659 \end{description}\end{quote}
4660
4661 \end{fulllineitems}
4662
4663 \index{write\_back() (in module src.fork)}
4664
4665 \begin{fulllineitems}
4666 \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}}{}
4667 shortcut function to write at the begin of the line
4668 \begin{quote}\begin{description}
4669 \item[{Parameters}] \leavevmode\begin{itemize}
4670 \item {}
4671 \sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logging instance
4672
4673 \item {}
4674 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{message}}) \textendash{} the text to display
4675
4676 \item {}
4677 \sphinxstyleliteralstrong{\sphinxupquote{int}} (\sphinxstyleliteralemphasis{\sphinxupquote{level}}) \textendash{} the level of verbosity
4678
4679 \end{itemize}
4680
4681 \end{description}\end{quote}
4682
4683 \end{fulllineitems}
4684
4685
4686
4687 \subsubsection{src.logger module}
4688 \label{\detokenize{commands/apidoc/src:module-src.logger}}\label{\detokenize{commands/apidoc/src:src-logger-module}}\index{src.logger (module)}
4689 Implements the classes and method relative to the logging
4690 \index{Logger (class in src.logger)}
4691
4692 \begin{fulllineitems}
4693 \phantomsection\label{\detokenize{commands/apidoc/src:src.logger.Logger}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.logger.}}\sphinxbfcode{\sphinxupquote{Logger}}}{\emph{config}, \emph{silent\_sysstd=False}, \emph{all\_in\_terminal=False}, \emph{micro\_command=False}}{}
4694 Bases: \sphinxcode{\sphinxupquote{object}}
4695
4696 Class to handle log mechanism.
4697 \index{add\_link() (src.logger.Logger method)}
4698
4699 \begin{fulllineitems}
4700 \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}}{}
4701 Add a link to another log file.
4702 \begin{quote}\begin{description}
4703 \item[{Parameters}] \leavevmode\begin{itemize}
4704 \item {}
4705 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{command\_res}}) \textendash{} The file name of the link.
4706
4707 \item {}
4708 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The name of the command linked.
4709
4710 \item {}
4711 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The result of the command linked. “0” or “1”
4712
4713 \end{itemize}
4714
4715 \item[{Parma full\_launched\_command str}] \leavevmode
4716 The full lanch command
4717 (“sat command …”)
4718
4719 \end{description}\end{quote}
4720
4721 \end{fulllineitems}
4722
4723 \index{end\_write() (src.logger.Logger method)}
4724
4725 \begin{fulllineitems}
4726 \phantomsection\label{\detokenize{commands/apidoc/src:src.logger.Logger.end_write}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{end\_write}}}{\emph{attribute}}{}
4727 Called just after command end: Put all fields
4728 corresponding to the command end context (time).
4729 Write the log xml file on the hard drive.
4730 And display the command to launch to get the log
4731 \begin{quote}\begin{description}
4732 \item[{Parameters}] \leavevmode
4733 \sphinxstyleliteralstrong{\sphinxupquote{dict}} (\sphinxstyleliteralemphasis{\sphinxupquote{attribute}}) \textendash{} the attribute to add to the node “Site”.
4734
4735 \end{description}\end{quote}
4736
4737 \end{fulllineitems}
4738
4739 \index{error() (src.logger.Logger method)}
4740
4741 \begin{fulllineitems}
4742 \phantomsection\label{\detokenize{commands/apidoc/src:src.logger.Logger.error}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{error}}}{\emph{message}}{}
4743 Print an error.
4744 \begin{quote}\begin{description}
4745 \item[{Parameters}] \leavevmode
4746 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{message}}) \textendash{} The message to print.
4747
4748 \end{description}\end{quote}
4749
4750 \end{fulllineitems}
4751
4752 \index{flush() (src.logger.Logger method)}
4753
4754 \begin{fulllineitems}
4755 \phantomsection\label{\detokenize{commands/apidoc/src:src.logger.Logger.flush}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{flush}}}{}{}
4756 Flush terminal
4757
4758 \end{fulllineitems}
4759
4760 \index{put\_initial\_xml\_fields() (src.logger.Logger method)}
4761
4762 \begin{fulllineitems}
4763 \phantomsection\label{\detokenize{commands/apidoc/src:src.logger.Logger.put_initial_xml_fields}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{put\_initial\_xml\_fields}}}{}{}
4764 Called at class initialization: Put all fields
4765 corresponding to the command context (user, time, …)
4766
4767 \end{fulllineitems}
4768
4769 \index{write() (src.logger.Logger method)}
4770
4771 \begin{fulllineitems}
4772 \phantomsection\label{\detokenize{commands/apidoc/src:src.logger.Logger.write}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write}}}{\emph{message}, \emph{level=None}, \emph{screenOnly=False}}{}
4773 function used in the commands
4774 to print in the terminal and the log file.
4775 \begin{quote}\begin{description}
4776 \item[{Parameters}] \leavevmode\begin{itemize}
4777 \item {}
4778 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{message}}) \textendash{} The message to print.
4779
4780 \item {}
4781 \sphinxstyleliteralstrong{\sphinxupquote{int}} (\sphinxstyleliteralemphasis{\sphinxupquote{level}}) \textendash{} The output level corresponding
4782 to the message 0 \textless{} level \textless{} 6.
4783
4784 \item {}
4785 \sphinxstyleliteralstrong{\sphinxupquote{boolean}} (\sphinxstyleliteralemphasis{\sphinxupquote{screenOnly}}) \textendash{} if True, do not write in log file.
4786
4787 \end{itemize}
4788
4789 \end{description}\end{quote}
4790
4791 \end{fulllineitems}
4792
4793
4794 \end{fulllineitems}
4795
4796 \index{date\_to\_datetime() (in module src.logger)}
4797
4798 \begin{fulllineitems}
4799 \phantomsection\label{\detokenize{commands/apidoc/src:src.logger.date_to_datetime}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.logger.}}\sphinxbfcode{\sphinxupquote{date\_to\_datetime}}}{\emph{date}}{}
4800 From a string date in format YYYYMMDD\_HHMMSS
4801 returns list year, mon, day, hour, minutes, seconds
4802 \begin{quote}\begin{description}
4803 \item[{Parameters}] \leavevmode
4804 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{date}}) \textendash{} The date in format YYYYMMDD\_HHMMSS
4805
4806 \item[{Returns}] \leavevmode
4807 the same date and time in separate variables.
4808
4809 \item[{Return type}] \leavevmode
4810 (str,str,str,str,str,str)
4811
4812 \end{description}\end{quote}
4813
4814 \end{fulllineitems}
4815
4816 \index{list\_log\_file() (in module src.logger)}
4817
4818 \begin{fulllineitems}
4819 \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}}{}
4820 Find all files corresponding to expression in dirPath
4821 \begin{quote}\begin{description}
4822 \item[{Parameters}] \leavevmode\begin{itemize}
4823 \item {}
4824 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{expression}}) \textendash{} the directory where to search the files
4825
4826 \item {}
4827 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the regular expression of files to find
4828
4829 \end{itemize}
4830
4831 \item[{Returns}] \leavevmode
4832 the list of files path and informations about it
4833
4834 \item[{Return type}] \leavevmode
4835 list
4836
4837 \end{description}\end{quote}
4838
4839 \end{fulllineitems}
4840
4841 \index{show\_command\_log() (in module src.logger)}
4842
4843 \begin{fulllineitems}
4844 \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}}{}
4845 Used in updateHatXml.
4846 Determine if the log xml file logFilePath
4847 has to be shown or not in the hat log.
4848 \begin{quote}\begin{description}
4849 \item[{Parameters}] \leavevmode\begin{itemize}
4850 \item {}
4851 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{application}}) \textendash{} the path to the command xml log file
4852
4853 \item {}
4854 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the command of the log file
4855
4856 \item {}
4857 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the application passed as parameter
4858 to the salomeTools command
4859
4860 \item {}
4861 \sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{notShownCommands}}) \textendash{} the list of commands
4862 that are not shown by default
4863
4864 \end{itemize}
4865
4866 \item[{Returns}] \leavevmode
4867 True if cmd is not in notShownCommands and the application
4868 in the log file corresponds to application
4869
4870 \item[{Return type}] \leavevmode
4871 boolean
4872
4873 \end{description}\end{quote}
4874
4875 \end{fulllineitems}
4876
4877 \index{timedelta\_total\_seconds() (in module src.logger)}
4878
4879 \begin{fulllineitems}
4880 \phantomsection\label{\detokenize{commands/apidoc/src:src.logger.timedelta_total_seconds}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.logger.}}\sphinxbfcode{\sphinxupquote{timedelta\_total\_seconds}}}{\emph{timedelta}}{}
4881 Replace total\_seconds from datetime module
4882 in order to be compatible with old python versions
4883 \begin{quote}\begin{description}
4884 \item[{Parameters}] \leavevmode
4885 \sphinxstyleliteralstrong{\sphinxupquote{datetime.timedelta}} (\sphinxstyleliteralemphasis{\sphinxupquote{timedelta}}) \textendash{} The delta between two dates
4886
4887 \item[{Returns}] \leavevmode
4888 The number of seconds corresponding to timedelta.
4889
4890 \item[{Return type}] \leavevmode
4891 float
4892
4893 \end{description}\end{quote}
4894
4895 \end{fulllineitems}
4896
4897 \index{update\_hat\_xml() (in module src.logger)}
4898
4899 \begin{fulllineitems}
4900 \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={[}{]}}}{}
4901 Create the xml file in logDir that contain all the xml file
4902 and have a name like YYYYMMDD\_HHMMSS\_namecmd.xml
4903 \begin{quote}\begin{description}
4904 \item[{Parameters}] \leavevmode\begin{itemize}
4905 \item {}
4906 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{application}}) \textendash{} the directory to parse
4907
4908 \item {}
4909 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the name of the application if there is any
4910
4911 \end{itemize}
4912
4913 \end{description}\end{quote}
4914
4915 \end{fulllineitems}
4916
4917
4918
4919 \subsubsection{src.options module}
4920 \label{\detokenize{commands/apidoc/src:module-src.options}}\label{\detokenize{commands/apidoc/src:src-options-module}}\index{src.options (module)}
4921 The Options class that manages the access to all options passed as
4922 parameters in salomeTools command lines
4923 \index{OptResult (class in src.options)}
4924
4925 \begin{fulllineitems}
4926 \phantomsection\label{\detokenize{commands/apidoc/src:src.options.OptResult}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.options.}}\sphinxbfcode{\sphinxupquote{OptResult}}}
4927 Bases: \sphinxcode{\sphinxupquote{object}}
4928
4929 An instance of this class will be the object manipulated
4930 in code of all salomeTools commands
4931 The aim of this class is to have an elegant syntax to manipulate the options.
4932
4933 \begin{DUlineblock}{0em}
4934 \item[] Example:
4935 \item[] \textgreater{}\textgreater{} options, remainderArgs = command.parseArguments(args)
4936 \item[] \textgreater{}\textgreater{} print(options.output\_verbose\_level)
4937 \item[] \textgreater{}\textgreater{} ‘INFO’
4938 \end{DUlineblock}
4939
4940 \end{fulllineitems}
4941
4942 \index{Options (class in src.options)}
4943
4944 \begin{fulllineitems}
4945 \phantomsection\label{\detokenize{commands/apidoc/src:src.options.Options}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.options.}}\sphinxbfcode{\sphinxupquote{Options}}}
4946 Bases: \sphinxcode{\sphinxupquote{object}}
4947
4948 Class to manage all salomeTools options
4949 \index{add\_option() (src.options.Options method)}
4950
4951 \begin{fulllineitems}
4952 \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}}{}
4953 Add an option to a command. It gets all attributes
4954 of an option and append it in the options field
4955 \begin{quote}\begin{description}
4956 \item[{Parameters}] \leavevmode\begin{itemize}
4957 \item {}
4958 \sphinxstyleliteralstrong{\sphinxupquote{shortName}} \textendash{} (str)
4959 The short name of the option (as ‘-l’ for level option).
4960
4961 \item {}
4962 \sphinxstyleliteralstrong{\sphinxupquote{longName}} \textendash{} (str)
4963 The long name of the option (as ‘\textendash{}level’ for level option).
4964
4965 \item {}
4966 \sphinxstyleliteralstrong{\sphinxupquote{optionType}} \textendash{} (str) The type of the option (ex “int”).
4967
4968 \item {}
4969 \sphinxstyleliteralstrong{\sphinxupquote{destName}} \textendash{} (str) The name that will be used in the code.
4970
4971 \item {}
4972 \sphinxstyleliteralstrong{\sphinxupquote{helpString}} \textendash{} (str)
4973 The text to display when user ask for help on a command.
4974
4975 \end{itemize}
4976
4977 \item[{Returns}] \leavevmode
4978 None
4979
4980 \end{description}\end{quote}
4981
4982 \end{fulllineitems}
4983
4984 \index{debug\_write() (src.options.Options method)}
4985
4986 \begin{fulllineitems}
4987 \phantomsection\label{\detokenize{commands/apidoc/src:src.options.Options.debug_write}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{debug\_write}}}{}{}
4988 \end{fulllineitems}
4989
4990 \index{filterLevel() (src.options.Options method)}
4991
4992 \begin{fulllineitems}
4993 \phantomsection\label{\detokenize{commands/apidoc/src:src.options.Options.filterLevel}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{filterLevel}}}{\emph{aLevel}}{}
4994 filter level logging values
4995
4996 \end{fulllineitems}
4997
4998 \index{filterList2() (src.options.Options method)}
4999
5000 \begin{fulllineitems}
5001 \phantomsection\label{\detokenize{commands/apidoc/src:src.options.Options.filterList2}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{filterList2}}}{\emph{aStr}}{}
5002 filter a list as ‘KERNEL,YACS,etc.’
5003
5004 \end{fulllineitems}
5005
5006 \index{getDetailOption() (src.options.Options method)}
5007
5008 \begin{fulllineitems}
5009 \phantomsection\label{\detokenize{commands/apidoc/src:src.options.Options.getDetailOption}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getDetailOption}}}{\emph{option}}{}
5010 for convenience
5011 \begin{quote}\begin{description}
5012 \item[{Returns}] \leavevmode
5013 (tuple) 4-elements (shortName, longName, optionType, helpString)
5014
5015 \end{description}\end{quote}
5016
5017 \end{fulllineitems}
5018
5019 \index{get\_help() (src.options.Options method)}
5020
5021 \begin{fulllineitems}
5022 \phantomsection\label{\detokenize{commands/apidoc/src:src.options.Options.get_help}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_help}}}{}{}
5023 Returns all options stored in self.options
5024 as help message colored string
5025 \begin{quote}\begin{description}
5026 \item[{Returns}] \leavevmode
5027 (str) colored string
5028
5029 \end{description}\end{quote}
5030
5031 \end{fulllineitems}
5032
5033 \index{indent() (src.options.Options method)}
5034
5035 \begin{fulllineitems}
5036 \phantomsection\label{\detokenize{commands/apidoc/src:src.options.Options.indent}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{indent}}}{\emph{text}, \emph{amount}, \emph{car=' '}}{}
5037 indent multi lines message
5038
5039 \end{fulllineitems}
5040
5041 \index{parse\_args() (src.options.Options method)}
5042
5043 \begin{fulllineitems}
5044 \phantomsection\label{\detokenize{commands/apidoc/src:src.options.Options.parse_args}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parse\_args}}}{\emph{argList=None}}{}
5045 Instantiates the class OptResult
5046 that gives access to all options in the code
5047 \begin{quote}\begin{description}
5048 \item[{Parameters}] \leavevmode
5049 \sphinxstyleliteralstrong{\sphinxupquote{argList}} \textendash{} (list) the raw list of arguments that were passed
5050
5051 \item[{Returns}] \leavevmode
5052 (OptResult, list) as (optResult, args)
5053 optResult is the option instance to manipulate in the code.
5054 args is the full raw list of passed options
5055
5056 \end{description}\end{quote}
5057
5058 \end{fulllineitems}
5059
5060 \index{print\_help() (src.options.Options method)}
5061
5062 \begin{fulllineitems}
5063 \phantomsection\label{\detokenize{commands/apidoc/src:src.options.Options.print_help}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{print\_help}}}{}{}
5064 Method that display all options stored in self.options and there help
5065 \begin{quote}\begin{description}
5066 \item[{Returns}] \leavevmode
5067 None
5068
5069 \end{description}\end{quote}
5070
5071 \end{fulllineitems}
5072
5073
5074 \end{fulllineitems}
5075
5076
5077
5078 \subsubsection{src.printcolors module}
5079 \label{\detokenize{commands/apidoc/src:module-src.printcolors}}\label{\detokenize{commands/apidoc/src:src-printcolors-module}}\index{src.printcolors (module)}
5080 In this file is stored the mechanism that manage color prints in the terminal
5081 \index{cleancolor() (in module src.printcolors)}
5082
5083 \begin{fulllineitems}
5084 \phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.cleancolor}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{cleancolor}}}{\emph{message}}{}
5085 remove color from a colored text.
5086 \begin{quote}\begin{description}
5087 \item[{Parameters}] \leavevmode
5088 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{message}}) \textendash{} The text to be cleaned.
5089
5090 \item[{Returns}] \leavevmode
5091 The cleaned text.
5092
5093 \item[{Return type}] \leavevmode
5094 str
5095
5096 \end{description}\end{quote}
5097
5098 \end{fulllineitems}
5099
5100 \index{print\_color\_map() (in module src.printcolors)}
5101
5102 \begin{fulllineitems}
5103 \phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.print_color_map}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{print\_color\_map}}}{}{}
5104 This method prints the color map
5105
5106 \end{fulllineitems}
5107
5108 \index{print\_color\_range() (in module src.printcolors)}
5109
5110 \begin{fulllineitems}
5111 \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}}{}
5112 print possible range values for colors
5113 \begin{quote}\begin{description}
5114 \item[{Parameters}] \leavevmode\begin{itemize}
5115 \item {}
5116 \sphinxstyleliteralstrong{\sphinxupquote{int}} (\sphinxstyleliteralemphasis{\sphinxupquote{end}}) \textendash{} The smaller value.
5117
5118 \item {}
5119 \sphinxstyleliteralstrong{\sphinxupquote{int}} \textendash{} The bigger value.
5120
5121 \end{itemize}
5122
5123 \end{description}\end{quote}
5124
5125 \end{fulllineitems}
5126
5127 \index{print\_value() (in module src.printcolors)}
5128
5129 \begin{fulllineitems}
5130 \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=''}}{}
5131 shortcut method to print a label and a value with the info color
5132 \begin{quote}\begin{description}
5133 \item[{Parameters}] \leavevmode\begin{itemize}
5134 \item {}
5135 \sphinxstyleliteralstrong{\sphinxupquote{class logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} the logger instance.
5136
5137 \item {}
5138 \sphinxstyleliteralstrong{\sphinxupquote{int}} (\sphinxstyleliteralemphasis{\sphinxupquote{level}}) \textendash{} the label to print.
5139
5140 \item {}
5141 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{suffix}}) \textendash{} the value to print.
5142
5143 \item {}
5144 \sphinxstyleliteralstrong{\sphinxupquote{int}} \textendash{} the level of verboseness.
5145
5146 \item {}
5147 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the suffix to add at the end.
5148
5149 \end{itemize}
5150
5151 \end{description}\end{quote}
5152
5153 \end{fulllineitems}
5154
5155 \index{printc() (in module src.printcolors)}
5156
5157 \begin{fulllineitems}
5158 \phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.printc}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{printc}}}{\emph{txt}, \emph{code=''}}{}
5159 print a text with colors
5160 \begin{quote}\begin{description}
5161 \item[{Parameters}] \leavevmode\begin{itemize}
5162 \item {}
5163 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{code}}) \textendash{} The text to be printed.
5164
5165 \item {}
5166 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The color to use.
5167
5168 \end{itemize}
5169
5170 \item[{Returns}] \leavevmode
5171 The colored text.
5172
5173 \item[{Return type}] \leavevmode
5174 str
5175
5176 \end{description}\end{quote}
5177
5178 \end{fulllineitems}
5179
5180 \index{printcError() (in module src.printcolors)}
5181
5182 \begin{fulllineitems}
5183 \phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.printcError}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{printcError}}}{\emph{txt}}{}
5184 print a text error color
5185 \begin{quote}\begin{description}
5186 \item[{Parameters}] \leavevmode
5187 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{txt}}) \textendash{} The text to be printed.
5188
5189 \item[{Returns}] \leavevmode
5190 The colored text.
5191
5192 \item[{Return type}] \leavevmode
5193 str
5194
5195 \end{description}\end{quote}
5196
5197 \end{fulllineitems}
5198
5199 \index{printcHeader() (in module src.printcolors)}
5200
5201 \begin{fulllineitems}
5202 \phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.printcHeader}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{printcHeader}}}{\emph{txt}}{}
5203 print a text header color
5204 \begin{quote}\begin{description}
5205 \item[{Parameters}] \leavevmode
5206 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{txt}}) \textendash{} The text to be printed.
5207
5208 \item[{Returns}] \leavevmode
5209 The colored text.
5210
5211 \item[{Return type}] \leavevmode
5212 str
5213
5214 \end{description}\end{quote}
5215
5216 \end{fulllineitems}
5217
5218 \index{printcHighlight() (in module src.printcolors)}
5219
5220 \begin{fulllineitems}
5221 \phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.printcHighlight}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{printcHighlight}}}{\emph{txt}}{}
5222 print a text highlight color
5223 \begin{quote}\begin{description}
5224 \item[{Parameters}] \leavevmode
5225 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{txt}}) \textendash{} The text to be printed.
5226
5227 \item[{Returns}] \leavevmode
5228 The colored text.
5229
5230 \item[{Return type}] \leavevmode
5231 str
5232
5233 \end{description}\end{quote}
5234
5235 \end{fulllineitems}
5236
5237 \index{printcInfo() (in module src.printcolors)}
5238
5239 \begin{fulllineitems}
5240 \phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.printcInfo}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{printcInfo}}}{\emph{txt}}{}
5241 print a text info color
5242 \begin{quote}\begin{description}
5243 \item[{Parameters}] \leavevmode
5244 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{txt}}) \textendash{} The text to be printed.
5245
5246 \item[{Returns}] \leavevmode
5247 The colored text.
5248
5249 \item[{Return type}] \leavevmode
5250 str
5251
5252 \end{description}\end{quote}
5253
5254 \end{fulllineitems}
5255
5256 \index{printcLabel() (in module src.printcolors)}
5257
5258 \begin{fulllineitems}
5259 \phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.printcLabel}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{printcLabel}}}{\emph{txt}}{}
5260 print a text label color
5261 \begin{quote}\begin{description}
5262 \item[{Parameters}] \leavevmode
5263 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{txt}}) \textendash{} The text to be printed.
5264
5265 \item[{Returns}] \leavevmode
5266 The colored text.
5267
5268 \item[{Return type}] \leavevmode
5269 str
5270
5271 \end{description}\end{quote}
5272
5273 \end{fulllineitems}
5274
5275 \index{printcSuccess() (in module src.printcolors)}
5276
5277 \begin{fulllineitems}
5278 \phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.printcSuccess}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{printcSuccess}}}{\emph{txt}}{}
5279 print a text success color
5280 \begin{quote}\begin{description}
5281 \item[{Parameters}] \leavevmode
5282 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{txt}}) \textendash{} The text to be printed.
5283
5284 \item[{Returns}] \leavevmode
5285 The colored text.
5286
5287 \item[{Return type}] \leavevmode
5288 str
5289
5290 \end{description}\end{quote}
5291
5292 \end{fulllineitems}
5293
5294 \index{printcWarning() (in module src.printcolors)}
5295
5296 \begin{fulllineitems}
5297 \phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.printcWarning}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{printcWarning}}}{\emph{txt}}{}
5298 print a text warning color
5299 \begin{quote}\begin{description}
5300 \item[{Parameters}] \leavevmode
5301 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{txt}}) \textendash{} The text to be printed.
5302
5303 \item[{Returns}] \leavevmode
5304 The colored text.
5305
5306 \item[{Return type}] \leavevmode
5307 str
5308
5309 \end{description}\end{quote}
5310
5311 \end{fulllineitems}
5312
5313
5314
5315 \subsubsection{src.product module}
5316 \label{\detokenize{commands/apidoc/src:module-src.product}}\label{\detokenize{commands/apidoc/src:src-product-module}}\index{src.product (module)}
5317 In this file are implemented the methods
5318 relative to the product notion of salomeTools
5319 \index{check\_config\_exists() (in module src.product)}
5320
5321 \begin{fulllineitems}
5322 \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}}{}
5323 Verify that the installation directory of a product in a base exists
5324 Check all the config-\textless{}i\textgreater{} directory and verify the sat-config.pyconf file
5325 that is in it
5326 \begin{quote}\begin{description}
5327 \item[{Parameters}] \leavevmode\begin{itemize}
5328 \item {}
5329 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The global configuration
5330
5331 \item {}
5332 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{prod\_dir}}) \textendash{} The product installation directory path
5333 (without config-\textless{}i\textgreater{})
5334
5335 \item {}
5336 \sphinxstyleliteralstrong{\sphinxupquote{Config}} \textendash{} The configuration specific to
5337 the product
5338
5339 \end{itemize}
5340
5341 \item[{Returns}] \leavevmode
5342 True or false is the installation is found or not
5343 and if it is found, the path of the found installation
5344
5345 \item[{Return type}] \leavevmode
5346 (boolean, str)
5347
5348 \end{description}\end{quote}
5349
5350 \end{fulllineitems}
5351
5352 \index{check\_installation() (in module src.product)}
5353
5354 \begin{fulllineitems}
5355 \phantomsection\label{\detokenize{commands/apidoc/src:src.product.check_installation}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{check\_installation}}}{\emph{product\_info}}{}
5356 Verify if a product is well installed. Checks install directory presence
5357 and some additional files if it is defined in the config
5358 \begin{quote}\begin{description}
5359 \item[{Parameters}] \leavevmode
5360 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
5361 the product
5362
5363 \item[{Returns}] \leavevmode
5364 True if it is well installed
5365
5366 \item[{Return type}] \leavevmode
5367 boolean
5368
5369 \end{description}\end{quote}
5370
5371 \end{fulllineitems}
5372
5373 \index{check\_source() (in module src.product)}
5374
5375 \begin{fulllineitems}
5376 \phantomsection\label{\detokenize{commands/apidoc/src:src.product.check_source}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{check\_source}}}{\emph{product\_info}}{}
5377 Verify if a sources of product is preset. Checks source directory presence
5378 \begin{quote}\begin{description}
5379 \item[{Parameters}] \leavevmode
5380 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
5381 the product
5382
5383 \item[{Returns}] \leavevmode
5384 True if it is well installed
5385
5386 \item[{Return type}] \leavevmode
5387 boolean
5388
5389 \end{description}\end{quote}
5390
5391 \end{fulllineitems}
5392
5393 \index{get\_base\_install\_dir() (in module src.product)}
5394
5395 \begin{fulllineitems}
5396 \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}}{}
5397 Compute the installation directory of a product in base
5398 \begin{quote}\begin{description}
5399 \item[{Parameters}] \leavevmode\begin{itemize}
5400 \item {}
5401 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The global configuration
5402
5403 \item {}
5404 \sphinxstyleliteralstrong{\sphinxupquote{Config}} \textendash{} The configuration specific to
5405 the product
5406
5407 \item {}
5408 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{version}}) \textendash{} The version of the product
5409
5410 \end{itemize}
5411
5412 \item[{Returns}] \leavevmode
5413 The path of the product installation
5414
5415 \item[{Return type}] \leavevmode
5416 str
5417
5418 \end{description}\end{quote}
5419
5420 \end{fulllineitems}
5421
5422 \index{get\_install\_dir() (in module src.product)}
5423
5424 \begin{fulllineitems}
5425 \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}}{}
5426 Compute the installation directory of a given product
5427 \begin{quote}\begin{description}
5428 \item[{Parameters}] \leavevmode\begin{itemize}
5429 \item {}
5430 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The global configuration
5431
5432 \item {}
5433 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{version}}) \textendash{} This corresponds to the value given by user in its
5434 application.pyconf for the specific product. If “yes”, the
5435 user wants the product to be in base. If “no”, he wants the
5436 product to be in the application workdir
5437
5438 \item {}
5439 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The version of the product
5440
5441 \item {}
5442 \sphinxstyleliteralstrong{\sphinxupquote{Config}} \textendash{} The configuration specific to
5443 the product
5444
5445 \end{itemize}
5446
5447 \item[{Returns}] \leavevmode
5448 The path of the product installation
5449
5450 \item[{Return type}] \leavevmode
5451 str
5452
5453 \end{description}\end{quote}
5454
5455 \end{fulllineitems}
5456
5457 \index{get\_product\_components() (in module src.product)}
5458
5459 \begin{fulllineitems}
5460 \phantomsection\label{\detokenize{commands/apidoc/src:src.product.get_product_components}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{get\_product\_components}}}{\emph{product\_info}}{}
5461 Get the component list to generate with the product
5462 \begin{quote}\begin{description}
5463 \item[{Parameters}] \leavevmode
5464 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
5465 the product
5466
5467 \item[{Returns}] \leavevmode
5468 The list of names of the components
5469
5470 \item[{Return type}] \leavevmode
5471 List
5472
5473 \end{description}\end{quote}
5474
5475 \end{fulllineitems}
5476
5477 \index{get\_product\_config() (in module src.product)}
5478
5479 \begin{fulllineitems}
5480 \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}}{}
5481 Get the specific configuration of a product from the global configuration
5482 \begin{quote}\begin{description}
5483 \item[{Parameters}] \leavevmode\begin{itemize}
5484 \item {}
5485 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} The global configuration
5486
5487 \item {}
5488 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_name}}) \textendash{} The name of the product
5489
5490 \item {}
5491 \sphinxstyleliteralstrong{\sphinxupquote{boolean}} (\sphinxstyleliteralemphasis{\sphinxupquote{with\_install\_dir}}) \textendash{} If false, do not provide an install
5492 directory (at false only for internal use
5493 of the function check\_config\_exists)
5494
5495 \end{itemize}
5496
5497 \item[{Returns}] \leavevmode
5498 the specific configuration of the product
5499
5500 \item[{Return type}] \leavevmode
5501 {\hyperref[\detokenize{commands/apidoc/src:src.pyconf.Config}]{\sphinxcrossref{Config}}} (\autopageref*{\detokenize{commands/apidoc/src:src.pyconf.Config}})
5502
5503 \end{description}\end{quote}
5504
5505 \end{fulllineitems}
5506
5507 \index{get\_product\_dependencies() (in module src.product)}
5508
5509 \begin{fulllineitems}
5510 \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}}{}
5511 Get recursively the list of products that are
5512 in the product\_info dependencies
5513 \begin{quote}\begin{description}
5514 \item[{Parameters}] \leavevmode\begin{itemize}
5515 \item {}
5516 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The global configuration
5517
5518 \item {}
5519 \sphinxstyleliteralstrong{\sphinxupquote{Config}} \textendash{} The configuration specific to
5520 the product
5521
5522 \end{itemize}
5523
5524 \item[{Returns}] \leavevmode
5525 the list of products in dependence
5526
5527 \item[{Return type}] \leavevmode
5528 list
5529
5530 \end{description}\end{quote}
5531
5532 \end{fulllineitems}
5533
5534 \index{get\_product\_section() (in module src.product)}
5535
5536 \begin{fulllineitems}
5537 \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}}{}
5538 Get the product description from the configuration
5539 \begin{quote}\begin{description}
5540 \item[{Parameters}] \leavevmode\begin{itemize}
5541 \item {}
5542 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} The global configuration
5543
5544 \item {}
5545 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{section}}) \textendash{} The product name
5546
5547 \item {}
5548 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The version of the product
5549
5550 \item {}
5551 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The searched section (if not None, the section is
5552 explicitly given
5553
5554 \end{itemize}
5555
5556 \item[{Returns}] \leavevmode
5557 The product description
5558
5559 \item[{Return type}] \leavevmode
5560 {\hyperref[\detokenize{commands/apidoc/src:src.pyconf.Config}]{\sphinxcrossref{Config}}} (\autopageref*{\detokenize{commands/apidoc/src:src.pyconf.Config}})
5561
5562 \end{description}\end{quote}
5563
5564 \end{fulllineitems}
5565
5566 \index{get\_products\_infos() (in module src.product)}
5567
5568 \begin{fulllineitems}
5569 \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}}{}
5570 Get the specific configuration of a list of products
5571 \begin{quote}\begin{description}
5572 \item[{Parameters}] \leavevmode\begin{itemize}
5573 \item {}
5574 \sphinxstyleliteralstrong{\sphinxupquote{List}} (\sphinxstyleliteralemphasis{\sphinxupquote{lproducts}}) \textendash{} The list of product names
5575
5576 \item {}
5577 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} The global configuration
5578
5579 \end{itemize}
5580
5581 \item[{Returns}] \leavevmode
5582 the list of tuples
5583 (product name, specific configuration of the product)
5584
5585 \item[{Return type}] \leavevmode
5586 {[}(str, {\hyperref[\detokenize{commands/apidoc/src:src.pyconf.Config}]{\sphinxcrossref{Config}}} (\autopageref*{\detokenize{commands/apidoc/src:src.pyconf.Config}})){]}
5587
5588 \end{description}\end{quote}
5589
5590 \end{fulllineitems}
5591
5592 \index{product\_compiles() (in module src.product)}
5593
5594 \begin{fulllineitems}
5595 \phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_compiles}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_compiles}}}{\emph{product\_info}}{}
5596 Know if a product compiles or not
5597 (some products do not have a compilation procedure)
5598 \begin{quote}\begin{description}
5599 \item[{Parameters}] \leavevmode
5600 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
5601 the product
5602
5603 \item[{Returns}] \leavevmode
5604 True if the product compiles, else False
5605
5606 \item[{Return type}] \leavevmode
5607 boolean
5608
5609 \end{description}\end{quote}
5610
5611 \end{fulllineitems}
5612
5613 \index{product\_has\_env\_script() (in module src.product)}
5614
5615 \begin{fulllineitems}
5616 \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}}{}
5617 Know if a product has an environment script
5618 \begin{quote}\begin{description}
5619 \item[{Parameters}] \leavevmode
5620 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
5621 the product
5622
5623 \item[{Returns}] \leavevmode
5624 True if the product it has an environment script, else False
5625
5626 \item[{Return type}] \leavevmode
5627 boolean
5628
5629 \end{description}\end{quote}
5630
5631 \end{fulllineitems}
5632
5633 \index{product\_has\_logo() (in module src.product)}
5634
5635 \begin{fulllineitems}
5636 \phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_has_logo}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_has\_logo}}}{\emph{product\_info}}{}
5637 Know if a product has a logo (YACSGEN generate)
5638 \begin{quote}\begin{description}
5639 \item[{Parameters}] \leavevmode
5640 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
5641 the product
5642
5643 \item[{Returns}] \leavevmode
5644 The path of the logo if the product has a logo, else False
5645
5646 \item[{Return type}] \leavevmode
5647 Str
5648
5649 \end{description}\end{quote}
5650
5651 \end{fulllineitems}
5652
5653 \index{product\_has\_patches() (in module src.product)}
5654
5655 \begin{fulllineitems}
5656 \phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_has_patches}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_has\_patches}}}{\emph{product\_info}}{}
5657 Know if a product has one or more patches
5658 \begin{quote}\begin{description}
5659 \item[{Parameters}] \leavevmode
5660 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
5661 the product
5662
5663 \item[{Returns}] \leavevmode
5664 True if the product has one or more patches
5665
5666 \item[{Return type}] \leavevmode
5667 boolean
5668
5669 \end{description}\end{quote}
5670
5671 \end{fulllineitems}
5672
5673 \index{product\_has\_salome\_gui() (in module src.product)}
5674
5675 \begin{fulllineitems}
5676 \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}}{}
5677 Know if a product has a SALOME gui
5678 \begin{quote}\begin{description}
5679 \item[{Parameters}] \leavevmode
5680 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
5681 the product
5682
5683 \item[{Returns}] \leavevmode
5684 True if the product has a SALOME gui, else False
5685
5686 \item[{Return type}] \leavevmode
5687 Boolean
5688
5689 \end{description}\end{quote}
5690
5691 \end{fulllineitems}
5692
5693 \index{product\_has\_script() (in module src.product)}
5694
5695 \begin{fulllineitems}
5696 \phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_has_script}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_has\_script}}}{\emph{product\_info}}{}
5697 Know if a product has a compilation script
5698 \begin{quote}\begin{description}
5699 \item[{Parameters}] \leavevmode
5700 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
5701 the product
5702
5703 \item[{Returns}] \leavevmode
5704 True if the product it has a compilation script, else False
5705
5706 \item[{Return type}] \leavevmode
5707 boolean
5708
5709 \end{description}\end{quote}
5710
5711 \end{fulllineitems}
5712
5713 \index{product\_is\_autotools() (in module src.product)}
5714
5715 \begin{fulllineitems}
5716 \phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_autotools}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_autotools}}}{\emph{product\_info}}{}
5717 Know if a product is compiled using the autotools
5718 \begin{quote}\begin{description}
5719 \item[{Parameters}] \leavevmode
5720 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
5721 the product
5722
5723 \item[{Returns}] \leavevmode
5724 True if the product is autotools, else False
5725
5726 \item[{Return type}] \leavevmode
5727 boolean
5728
5729 \end{description}\end{quote}
5730
5731 \end{fulllineitems}
5732
5733 \index{product\_is\_cmake() (in module src.product)}
5734
5735 \begin{fulllineitems}
5736 \phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_cmake}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_cmake}}}{\emph{product\_info}}{}
5737 Know if a product is compiled using the cmake
5738 \begin{quote}\begin{description}
5739 \item[{Parameters}] \leavevmode
5740 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
5741 the product
5742
5743 \item[{Returns}] \leavevmode
5744 True if the product is cmake, else False
5745
5746 \item[{Return type}] \leavevmode
5747 boolean
5748
5749 \end{description}\end{quote}
5750
5751 \end{fulllineitems}
5752
5753 \index{product\_is\_cpp() (in module src.product)}
5754
5755 \begin{fulllineitems}
5756 \phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_cpp}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_cpp}}}{\emph{product\_info}}{}
5757 Know if a product is cpp
5758 \begin{quote}\begin{description}
5759 \item[{Parameters}] \leavevmode
5760 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
5761 the product
5762
5763 \item[{Returns}] \leavevmode
5764 True if the product is a cpp, else False
5765
5766 \item[{Return type}] \leavevmode
5767 boolean
5768
5769 \end{description}\end{quote}
5770
5771 \end{fulllineitems}
5772
5773 \index{product\_is\_debug() (in module src.product)}
5774
5775 \begin{fulllineitems}
5776 \phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_debug}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_debug}}}{\emph{product\_info}}{}
5777 Know if a product is in debug mode
5778 \begin{quote}\begin{description}
5779 \item[{Parameters}] \leavevmode
5780 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
5781 the product
5782
5783 \item[{Returns}] \leavevmode
5784 True if the product is in debug mode, else False
5785
5786 \item[{Return type}] \leavevmode
5787 boolean
5788
5789 \end{description}\end{quote}
5790
5791 \end{fulllineitems}
5792
5793 \index{product\_is\_dev() (in module src.product)}
5794
5795 \begin{fulllineitems}
5796 \phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_dev}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_dev}}}{\emph{product\_info}}{}
5797 Know if a product is in dev mode
5798 \begin{quote}\begin{description}
5799 \item[{Parameters}] \leavevmode
5800 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
5801 the product
5802
5803 \item[{Returns}] \leavevmode
5804 True if the product is in dev mode, else False
5805
5806 \item[{Return type}] \leavevmode
5807 boolean
5808
5809 \end{description}\end{quote}
5810
5811 \end{fulllineitems}
5812
5813 \index{product\_is\_fixed() (in module src.product)}
5814
5815 \begin{fulllineitems}
5816 \phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_fixed}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_fixed}}}{\emph{product\_info}}{}
5817 Know if a product is fixed
5818 \begin{quote}\begin{description}
5819 \item[{Parameters}] \leavevmode
5820 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
5821 the product
5822
5823 \item[{Returns}] \leavevmode
5824 True if the product is fixed, else False
5825
5826 \item[{Return type}] \leavevmode
5827 boolean
5828
5829 \end{description}\end{quote}
5830
5831 \end{fulllineitems}
5832
5833 \index{product\_is\_generated() (in module src.product)}
5834
5835 \begin{fulllineitems}
5836 \phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_generated}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_generated}}}{\emph{product\_info}}{}
5837 Know if a product is generated (YACSGEN)
5838 \begin{quote}\begin{description}
5839 \item[{Parameters}] \leavevmode
5840 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
5841 the product
5842
5843 \item[{Returns}] \leavevmode
5844 True if the product is generated
5845
5846 \item[{Return type}] \leavevmode
5847 boolean
5848
5849 \end{description}\end{quote}
5850
5851 \end{fulllineitems}
5852
5853 \index{product\_is\_mpi() (in module src.product)}
5854
5855 \begin{fulllineitems}
5856 \phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_mpi}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_mpi}}}{\emph{product\_info}}{}
5857 Know if a product has openmpi in its dependencies
5858 \begin{quote}\begin{description}
5859 \item[{Parameters}] \leavevmode
5860 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
5861 the product
5862
5863 \item[{Returns}] \leavevmode
5864 True if the product has openmpi inits dependencies
5865
5866 \item[{Return type}] \leavevmode
5867 boolean
5868
5869 \end{description}\end{quote}
5870
5871 \end{fulllineitems}
5872
5873 \index{product\_is\_native() (in module src.product)}
5874
5875 \begin{fulllineitems}
5876 \phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_native}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_native}}}{\emph{product\_info}}{}
5877 Know if a product is native
5878 \begin{quote}\begin{description}
5879 \item[{Parameters}] \leavevmode
5880 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
5881 the product
5882
5883 \item[{Returns}] \leavevmode
5884 True if the product is native, else False
5885
5886 \item[{Return type}] \leavevmode
5887 boolean
5888
5889 \end{description}\end{quote}
5890
5891 \end{fulllineitems}
5892
5893 \index{product\_is\_salome() (in module src.product)}
5894
5895 \begin{fulllineitems}
5896 \phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_salome}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_salome}}}{\emph{product\_info}}{}
5897 Know if a product is a SALOME module
5898 \begin{quote}\begin{description}
5899 \item[{Parameters}] \leavevmode
5900 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
5901 the product
5902
5903 \item[{Returns}] \leavevmode
5904 True if the product is a SALOME module, else False
5905
5906 \item[{Return type}] \leavevmode
5907 boolean
5908
5909 \end{description}\end{quote}
5910
5911 \end{fulllineitems}
5912
5913 \index{product\_is\_smesh\_plugin() (in module src.product)}
5914
5915 \begin{fulllineitems}
5916 \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}}{}
5917 Know if a product is a SMESH plugin
5918 \begin{quote}\begin{description}
5919 \item[{Parameters}] \leavevmode
5920 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
5921 the product
5922
5923 \item[{Returns}] \leavevmode
5924 True if the product is a SMESH plugin, else False
5925
5926 \item[{Return type}] \leavevmode
5927 boolean
5928
5929 \end{description}\end{quote}
5930
5931 \end{fulllineitems}
5932
5933 \index{product\_is\_vcs() (in module src.product)}
5934
5935 \begin{fulllineitems}
5936 \phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_vcs}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_vcs}}}{\emph{product\_info}}{}
5937 Know if a product is download using git, svn or cvs (not archive)
5938 \begin{quote}\begin{description}
5939 \item[{Parameters}] \leavevmode
5940 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
5941 the product
5942
5943 \item[{Returns}] \leavevmode
5944 True if the product is vcs, else False
5945
5946 \item[{Return type}] \leavevmode
5947 boolean
5948
5949 \end{description}\end{quote}
5950
5951 \end{fulllineitems}
5952
5953 \index{product\_is\_verbose() (in module src.product)}
5954
5955 \begin{fulllineitems}
5956 \phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_verbose}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_verbose}}}{\emph{product\_info}}{}
5957 Know if a product is in verbose mode
5958 \begin{quote}\begin{description}
5959 \item[{Parameters}] \leavevmode
5960 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
5961 the product
5962
5963 \item[{Returns}] \leavevmode
5964 True if the product is in verbose mode, else False
5965
5966 \item[{Return type}] \leavevmode
5967 boolean
5968
5969 \end{description}\end{quote}
5970
5971 \end{fulllineitems}
5972
5973
5974
5975 \subsubsection{src.pyconf module}
5976 \label{\detokenize{commands/apidoc/src:src-pyconf-module}}\label{\detokenize{commands/apidoc/src:module-src.pyconf}}\index{src.pyconf (module)}
5977 This is a configuration module for Python.
5978
5979 This module should work under Python versions \textgreater{}= 2.2, and cannot be used with
5980 earlier versions since it uses new-style classes.
5981
5982 Development and testing has only been carried out (so far) on Python 2.3.4 and
5983 Python 2.4.2. See the test module (test\_config.py) included in the
5984 U\{distribution\textless{}\sphinxurl{http://www.red-dove.com/python\_config}.html\textbar{}\_blank\textgreater{}\} (follow the
5985 download link).
5986
5987 A simple example - with the example configuration file:
5988
5989 \fvset{hllines={, ,}}%
5990 \begin{sphinxVerbatim}[commandchars=\\\{\}]
5991 messages:
5992 [
5993   \PYGZob{}
5994     stream : {}`sys.stderr{}`
5995     message: \PYGZsq{}Welcome\PYGZsq{}
5996     name: \PYGZsq{}Harry\PYGZsq{}
5997   \PYGZcb{}
5998   \PYGZob{}
5999     stream : {}`sys.stdout{}`
6000     message: \PYGZsq{}Welkom\PYGZsq{}
6001     name: \PYGZsq{}Ruud\PYGZsq{}
6002   \PYGZcb{}
6003   \PYGZob{}
6004     stream : \PYGZdl{}messages[0].stream
6005     message: \PYGZsq{}Bienvenue\PYGZsq{}
6006     name: Yves
6007   \PYGZcb{}
6008 ]
6009 \end{sphinxVerbatim}
6010
6011 a program to read the configuration would be:
6012
6013 \fvset{hllines={, ,}}%
6014 \begin{sphinxVerbatim}[commandchars=\\\{\}]
6015 \PYG{k+kn}{from} \PYG{n+nn}{config} \PYG{k}{import} \PYG{n}{Config}
6016
6017 \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}{)}
6018 \PYG{n}{cfg} \PYG{o}{=} \PYG{n}{Config}\PYG{p}{(}\PYG{n}{f}\PYG{p}{)}
6019 \PYG{k}{for} \PYG{n}{m} \PYG{o+ow}{in} \PYG{n}{cfg}\PYG{o}{.}\PYG{n}{messages}\PYG{p}{:}
6020     \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}{)}
6021     \PYG{k}{try}\PYG{p}{:}
6022         \PYG{n+nb}{print} \PYG{o}{\PYGZgt{}\PYGZgt{}} \PYG{n}{m}\PYG{o}{.}\PYG{n}{stream}\PYG{p}{,} \PYG{n}{s}
6023     \PYG{k}{except} \PYG{n+ne}{IOError}\PYG{p}{,} \PYG{n}{e}\PYG{p}{:}
6024         \PYG{n+nb}{print} \PYG{n}{e}
6025 \end{sphinxVerbatim}
6026
6027 which, when run, would yield the console output:
6028
6029 \fvset{hllines={, ,}}%
6030 \begin{sphinxVerbatim}[commandchars=\\\{\}]
6031 \PYG{n}{Welcome}\PYG{p}{,} \PYG{n}{Harry}
6032 \PYG{n}{Welkom}\PYG{p}{,} \PYG{n}{Ruud}
6033 \PYG{n}{Bienvenue}\PYG{p}{,} \PYG{n}{Yves}
6034 \end{sphinxVerbatim}
6035
6036 See U\{this tutorial\textless{}\sphinxurl{http://www.red-dove.com/python\_config}.html\textbar{}\_blank\textgreater{}\} for more
6037 information.
6038
6039 \#modified for salomeTools
6040 @version: 0.3.7.1
6041
6042 @author: Vinay Sajip
6043
6044 @copyright: Copyright (C) 2004-2007 Vinay Sajip. All Rights Reserved.
6045
6046 @var streamOpener: The default stream opener. This is a factory function which
6047 takes a string (e.g. filename) and returns a stream suitable for reading. If
6048 unable to open the stream, an IOError exception should be thrown.
6049
6050 The default value of this variable is L\{defaultStreamOpener\}. For an example
6051 of how it’s used, see test\_config.py (search for streamOpener).
6052 \index{Config (class in src.pyconf)}
6053
6054 \begin{fulllineitems}
6055 \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}}{}
6056 Bases: {\hyperref[\detokenize{commands/apidoc/src:src.pyconf.Mapping}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.pyconf.Mapping}}}}} (\autopageref*{\detokenize{commands/apidoc/src:src.pyconf.Mapping}})
6057
6058 This class represents a configuration, and is the only one which clients
6059 need to interface to, under normal circumstances.
6060 \index{Config.Namespace (class in src.pyconf)}
6061
6062 \begin{fulllineitems}
6063 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Config.Namespace}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxbfcode{\sphinxupquote{Namespace}}}
6064 Bases: \sphinxcode{\sphinxupquote{object}}
6065
6066 This internal class is used for implementing default namespaces.
6067
6068 An instance acts as a namespace.
6069
6070 \end{fulllineitems}
6071
6072 \index{addNamespace() (src.pyconf.Config method)}
6073
6074 \begin{fulllineitems}
6075 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Config.addNamespace}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{addNamespace}}}{\emph{ns}, \emph{name=None}}{}
6076 Add a namespace to this configuration which can be used to evaluate
6077 (resolve) dotted-identifier expressions.
6078 @param ns: The namespace to be added.
6079 @type ns: A module or other namespace suitable for passing as an
6080 argument to vars().
6081 @param name: A name for the namespace, which, if specified, provides
6082 an additional level of indirection.
6083 @type name: str
6084
6085 \end{fulllineitems}
6086
6087 \index{getByPath() (src.pyconf.Config method)}
6088
6089 \begin{fulllineitems}
6090 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Config.getByPath}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getByPath}}}{\emph{path}}{}
6091 Obtain a value in the configuration via its path.
6092 @param path: The path of the required value
6093 @type path: str
6094 @return the value at the specified path.
6095 @rtype: any
6096 @raise ConfigError: If the path is invalid
6097
6098 \end{fulllineitems}
6099
6100 \index{load() (src.pyconf.Config method)}
6101
6102 \begin{fulllineitems}
6103 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Config.load}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{load}}}{\emph{stream}}{}
6104 Load the configuration from the specified stream. Multiple streams can
6105 be used to populate the same instance, as long as there are no
6106 clashing keys. The stream is closed.
6107 @param stream: A stream from which the configuration is read.
6108 @type stream: A read-only stream (file-like object).
6109 @raise ConfigError: if keys in the loaded configuration clash with
6110 existing keys.
6111 @raise ConfigFormatError: if there is a syntax error in the stream.
6112
6113 \end{fulllineitems}
6114
6115 \index{removeNamespace() (src.pyconf.Config method)}
6116
6117 \begin{fulllineitems}
6118 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Config.removeNamespace}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{removeNamespace}}}{\emph{ns}, \emph{name=None}}{}
6119 Remove a namespace added with L\{addNamespace\}.
6120 @param ns: The namespace to be removed.
6121 @param name: The name which was specified when L\{addNamespace\} was
6122 called.
6123 @type name: str
6124
6125 \end{fulllineitems}
6126
6127
6128 \end{fulllineitems}
6129
6130 \index{ConfigError}
6131
6132 \begin{fulllineitems}
6133 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigError}}\pysigline{\sphinxbfcode{\sphinxupquote{exception }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{ConfigError}}}
6134 Bases: \sphinxcode{\sphinxupquote{exceptions.Exception}}
6135
6136 This is the base class of exceptions raised by this module.
6137
6138 \end{fulllineitems}
6139
6140 \index{ConfigFormatError}
6141
6142 \begin{fulllineitems}
6143 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigFormatError}}\pysigline{\sphinxbfcode{\sphinxupquote{exception }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{ConfigFormatError}}}
6144 Bases: {\hyperref[\detokenize{commands/apidoc/src:src.pyconf.ConfigError}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.pyconf.ConfigError}}}}} (\autopageref*{\detokenize{commands/apidoc/src:src.pyconf.ConfigError}})
6145
6146 This is the base class of exceptions raised due to syntax errors in
6147 configurations.
6148
6149 \end{fulllineitems}
6150
6151 \index{ConfigInputStream (class in src.pyconf)}
6152
6153 \begin{fulllineitems}
6154 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigInputStream}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{ConfigInputStream}}}{\emph{stream}}{}
6155 Bases: \sphinxcode{\sphinxupquote{object}}
6156
6157 An input stream which can read either ANSI files with default encoding
6158 or Unicode files with BOMs.
6159
6160 Handles UTF-8, UTF-16LE, UTF-16BE. Could handle UTF-32 if Python had
6161 built-in support.
6162 \index{close() (src.pyconf.ConfigInputStream method)}
6163
6164 \begin{fulllineitems}
6165 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigInputStream.close}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{close}}}{}{}
6166 \end{fulllineitems}
6167
6168 \index{read() (src.pyconf.ConfigInputStream method)}
6169
6170 \begin{fulllineitems}
6171 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigInputStream.read}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{read}}}{\emph{size}}{}
6172 \end{fulllineitems}
6173
6174 \index{readline() (src.pyconf.ConfigInputStream method)}
6175
6176 \begin{fulllineitems}
6177 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigInputStream.readline}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{readline}}}{}{}
6178 \end{fulllineitems}
6179
6180
6181 \end{fulllineitems}
6182
6183 \index{ConfigList (class in src.pyconf)}
6184
6185 \begin{fulllineitems}
6186 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigList}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{ConfigList}}}
6187 Bases: \sphinxcode{\sphinxupquote{list}}
6188
6189 This class implements an ordered list of configurations and allows you
6190 to try getting the configuration from each entry in turn, returning
6191 the first successfully obtained value.
6192 \index{getByPath() (src.pyconf.ConfigList method)}
6193
6194 \begin{fulllineitems}
6195 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigList.getByPath}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getByPath}}}{\emph{path}}{}
6196 Obtain a value from the first configuration in the list which defines
6197 it.
6198
6199 @param path: The path of the value to retrieve.
6200 @type path: str
6201 @return: The value from the earliest configuration in the list which
6202 defines it.
6203 @rtype: any
6204 @raise ConfigError: If no configuration in the list has an entry with
6205 the specified path.
6206
6207 \end{fulllineitems}
6208
6209
6210 \end{fulllineitems}
6211
6212 \index{ConfigMerger (class in src.pyconf)}
6213
6214 \begin{fulllineitems}
6215 \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{}}}{}
6216 Bases: \sphinxcode{\sphinxupquote{object}}
6217
6218 This class is used for merging two configurations. If a key exists in the
6219 merge operand but not the merge target, then the entry is copied from the
6220 merge operand to the merge target. If a key exists in both configurations,
6221 then a resolver (a callable) is called to decide how to handle the
6222 conflict.
6223 \index{handleMismatch() (src.pyconf.ConfigMerger method)}
6224
6225 \begin{fulllineitems}
6226 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigMerger.handleMismatch}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{handleMismatch}}}{\emph{obj1}, \emph{obj2}}{}
6227 Handle a mismatch between two objects.
6228
6229 @param obj1: The object to merge into.
6230 @type obj1: any
6231 @param obj2: The object to merge.
6232 @type obj2: any
6233
6234 \end{fulllineitems}
6235
6236 \index{merge() (src.pyconf.ConfigMerger method)}
6237
6238 \begin{fulllineitems}
6239 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigMerger.merge}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{merge}}}{\emph{merged}, \emph{mergee}}{}
6240 Merge two configurations. The second configuration is unchanged,
6241 and the first is changed to reflect the results of the merge.
6242
6243 @param merged: The configuration to merge into.
6244 @type merged: L\{Config\}.
6245 @param mergee: The configuration to merge.
6246 @type mergee: L\{Config\}.
6247
6248 \end{fulllineitems}
6249
6250 \index{mergeMapping() (src.pyconf.ConfigMerger method)}
6251
6252 \begin{fulllineitems}
6253 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigMerger.mergeMapping}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{mergeMapping}}}{\emph{map1}, \emph{map2}}{}
6254 Merge two mappings recursively. The second mapping is unchanged,
6255 and the first is changed to reflect the results of the merge.
6256
6257 @param map1: The mapping to merge into.
6258 @type map1: L\{Mapping\}.
6259 @param map2: The mapping to merge.
6260 @type map2: L\{Mapping\}.
6261
6262 \end{fulllineitems}
6263
6264 \index{mergeSequence() (src.pyconf.ConfigMerger method)}
6265
6266 \begin{fulllineitems}
6267 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigMerger.mergeSequence}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{mergeSequence}}}{\emph{seq1}, \emph{seq2}}{}
6268 Merge two sequences. The second sequence is unchanged,
6269 and the first is changed to have the elements of the second
6270 appended to it.
6271
6272 @param seq1: The sequence to merge into.
6273 @type seq1: L\{Sequence\}.
6274 @param seq2: The sequence to merge.
6275 @type seq2: L\{Sequence\}.
6276
6277 \end{fulllineitems}
6278
6279 \index{overwriteKeys() (src.pyconf.ConfigMerger method)}
6280
6281 \begin{fulllineitems}
6282 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigMerger.overwriteKeys}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{overwriteKeys}}}{\emph{map1}, \emph{seq2}}{}
6283 Renint variables. The second mapping is unchanged,
6284 and the first is changed depending the keys of the second mapping.
6285 @param map1: The mapping to reinit keys into.
6286 @type map1: L\{Mapping\}.
6287 @param map2: The mapping container reinit information.
6288 @type map2: L\{Mapping\}.
6289
6290 \end{fulllineitems}
6291
6292
6293 \end{fulllineitems}
6294
6295 \index{ConfigOutputStream (class in src.pyconf)}
6296
6297 \begin{fulllineitems}
6298 \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}}{}
6299 Bases: \sphinxcode{\sphinxupquote{object}}
6300
6301 An output stream which can write either ANSI files with default encoding
6302 or Unicode files with BOMs.
6303
6304 Handles UTF-8, UTF-16LE, UTF-16BE. Could handle UTF-32 if Python had
6305 built-in support.
6306 \index{close() (src.pyconf.ConfigOutputStream method)}
6307
6308 \begin{fulllineitems}
6309 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigOutputStream.close}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{close}}}{}{}
6310 \end{fulllineitems}
6311
6312 \index{flush() (src.pyconf.ConfigOutputStream method)}
6313
6314 \begin{fulllineitems}
6315 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigOutputStream.flush}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{flush}}}{}{}
6316 \end{fulllineitems}
6317
6318 \index{write() (src.pyconf.ConfigOutputStream method)}
6319
6320 \begin{fulllineitems}
6321 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigOutputStream.write}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write}}}{\emph{data}}{}
6322 \end{fulllineitems}
6323
6324
6325 \end{fulllineitems}
6326
6327 \index{ConfigReader (class in src.pyconf)}
6328
6329 \begin{fulllineitems}
6330 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{ConfigReader}}}{\emph{config}}{}
6331 Bases: \sphinxcode{\sphinxupquote{object}}
6332
6333 This internal class implements a parser for configurations.
6334 \index{getChar() (src.pyconf.ConfigReader method)}
6335
6336 \begin{fulllineitems}
6337 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.getChar}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getChar}}}{}{}
6338 Get the next char from the stream. Update line and column numbers
6339 appropriately.
6340
6341 @return: The next character from the stream.
6342 @rtype: str
6343
6344 \end{fulllineitems}
6345
6346 \index{getToken() (src.pyconf.ConfigReader method)}
6347
6348 \begin{fulllineitems}
6349 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.getToken}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getToken}}}{}{}
6350 Get a token from the stream. String values are returned in a form
6351 where you need to eval() the returned value to get the actual
6352 string. The return value is (token\_type, token\_value).
6353
6354 Multiline string tokenizing is thanks to David Janes (BlogMatrix)
6355
6356 @return: The next token.
6357 @rtype: A token tuple.
6358
6359 \end{fulllineitems}
6360
6361 \index{load() (src.pyconf.ConfigReader method)}
6362
6363 \begin{fulllineitems}
6364 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.load}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{load}}}{\emph{stream}, \emph{parent=None}, \emph{suffix=None}}{}
6365 Load the configuration from the specified stream.
6366
6367 @param stream: A stream from which to load the configuration.
6368 @type stream: A stream (file-like object).
6369 @param parent: The parent of the configuration (to which this reader
6370 belongs) in the hierarchy. Specified when the configuration is
6371 included in another one.
6372 @type parent: A L\{Container\} instance.
6373 @param suffix: The suffix of this configuration in the parent
6374 configuration. Should be specified whenever the parent is not None.
6375 @raise ConfigError: If parent is specified but suffix is not.
6376 @raise ConfigFormatError: If there are syntax errors in the stream.
6377
6378 \end{fulllineitems}
6379
6380 \index{location() (src.pyconf.ConfigReader method)}
6381
6382 \begin{fulllineitems}
6383 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.location}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{location}}}{}{}
6384 Return the current location (filename, line, column) in the stream
6385 as a string.
6386
6387 Used when printing error messages,
6388
6389 @return: A string representing a location in the stream being read.
6390 @rtype: str
6391
6392 \end{fulllineitems}
6393
6394 \index{match() (src.pyconf.ConfigReader method)}
6395
6396 \begin{fulllineitems}
6397 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.match}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{match}}}{\emph{t}}{}
6398 Ensure that the current token type matches the specified value, and
6399 advance to the next token.
6400
6401 @param t: The token type to match.
6402 @type t: A valid token type.
6403 @return: The token which was last read from the stream before this
6404 function is called.
6405 @rtype: a token tuple - see L\{getToken\}.
6406 @raise ConfigFormatError: If the token does not match what’s expected.
6407
6408 \end{fulllineitems}
6409
6410 \index{parseFactor() (src.pyconf.ConfigReader method)}
6411
6412 \begin{fulllineitems}
6413 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseFactor}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseFactor}}}{}{}
6414 Parse a factor in an multiplicative expression (a * b, a / b, a \% b)
6415
6416 @return: the parsed factor
6417 @rtype: any scalar
6418 @raise ConfigFormatError: if a syntax error is found.
6419
6420 \end{fulllineitems}
6421
6422 \index{parseKeyValuePair() (src.pyconf.ConfigReader method)}
6423
6424 \begin{fulllineitems}
6425 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseKeyValuePair}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseKeyValuePair}}}{\emph{parent}}{}
6426 Parse a key-value pair, and add it to the provided L\{Mapping\}.
6427
6428 @param parent: The mapping to add entries to.
6429 @type parent: A L\{Mapping\} instance.
6430 @raise ConfigFormatError: if a syntax error is found.
6431
6432 \end{fulllineitems}
6433
6434 \index{parseMapping() (src.pyconf.ConfigReader method)}
6435
6436 \begin{fulllineitems}
6437 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseMapping}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseMapping}}}{\emph{parent}, \emph{suffix}}{}
6438 Parse a mapping.
6439
6440 @param parent: The container to which the mapping will be added.
6441 @type parent: A L\{Container\} instance.
6442 @param suffix: The suffix for the value.
6443 @type suffix: str
6444 @return: a L\{Mapping\} instance representing the mapping.
6445 @rtype: L\{Mapping\}
6446 @raise ConfigFormatError: if a syntax error is found.
6447
6448 \end{fulllineitems}
6449
6450 \index{parseMappingBody() (src.pyconf.ConfigReader method)}
6451
6452 \begin{fulllineitems}
6453 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseMappingBody}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseMappingBody}}}{\emph{parent}}{}
6454 Parse the internals of a mapping, and add entries to the provided
6455 L\{Mapping\}.
6456
6457 @param parent: The mapping to add entries to.
6458 @type parent: A L\{Mapping\} instance.
6459
6460 \end{fulllineitems}
6461
6462 \index{parseReference() (src.pyconf.ConfigReader method)}
6463
6464 \begin{fulllineitems}
6465 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseReference}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseReference}}}{\emph{type}}{}
6466 Parse a reference.
6467
6468 @return: the parsed reference
6469 @rtype: L\{Reference\}
6470 @raise ConfigFormatError: if a syntax error is found.
6471
6472 \end{fulllineitems}
6473
6474 \index{parseScalar() (src.pyconf.ConfigReader method)}
6475
6476 \begin{fulllineitems}
6477 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseScalar}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseScalar}}}{}{}
6478 Parse a scalar - a terminal value such as a string or number, or
6479 an L\{Expression\} or L\{Reference\}.
6480
6481 @return: the parsed scalar
6482 @rtype: any scalar
6483 @raise ConfigFormatError: if a syntax error is found.
6484
6485 \end{fulllineitems}
6486
6487 \index{parseSequence() (src.pyconf.ConfigReader method)}
6488
6489 \begin{fulllineitems}
6490 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseSequence}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseSequence}}}{\emph{parent}, \emph{suffix}}{}
6491 Parse a sequence.
6492
6493 @param parent: The container to which the sequence will be added.
6494 @type parent: A L\{Container\} instance.
6495 @param suffix: The suffix for the value.
6496 @type suffix: str
6497 @return: a L\{Sequence\} instance representing the sequence.
6498 @rtype: L\{Sequence\}
6499 @raise ConfigFormatError: if a syntax error is found.
6500
6501 \end{fulllineitems}
6502
6503 \index{parseSuffix() (src.pyconf.ConfigReader method)}
6504
6505 \begin{fulllineitems}
6506 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseSuffix}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseSuffix}}}{\emph{ref}}{}
6507 Parse a reference suffix.
6508
6509 @param ref: The reference of which this suffix is a part.
6510 @type ref: L\{Reference\}.
6511 @raise ConfigFormatError: if a syntax error is found.
6512
6513 \end{fulllineitems}
6514
6515 \index{parseTerm() (src.pyconf.ConfigReader method)}
6516
6517 \begin{fulllineitems}
6518 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseTerm}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseTerm}}}{}{}
6519 Parse a term in an additive expression (a + b, a - b)
6520
6521 @return: the parsed term
6522 @rtype: any scalar
6523 @raise ConfigFormatError: if a syntax error is found.
6524
6525 \end{fulllineitems}
6526
6527 \index{parseValue() (src.pyconf.ConfigReader method)}
6528
6529 \begin{fulllineitems}
6530 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseValue}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseValue}}}{\emph{parent}, \emph{suffix}}{}
6531 Parse a value.
6532
6533 @param parent: The container to which the value will be added.
6534 @type parent: A L\{Container\} instance.
6535 @param suffix: The suffix for the value.
6536 @type suffix: str
6537 @return: The value
6538 @rtype: any
6539 @raise ConfigFormatError: if a syntax error is found.
6540
6541 \end{fulllineitems}
6542
6543 \index{setStream() (src.pyconf.ConfigReader method)}
6544
6545 \begin{fulllineitems}
6546 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.setStream}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{setStream}}}{\emph{stream}}{}
6547 Set the stream to the specified value, and prepare to read from it.
6548
6549 @param stream: A stream from which to load the configuration.
6550 @type stream: A stream (file-like object).
6551
6552 \end{fulllineitems}
6553
6554
6555 \end{fulllineitems}
6556
6557 \index{ConfigResolutionError}
6558
6559 \begin{fulllineitems}
6560 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigResolutionError}}\pysigline{\sphinxbfcode{\sphinxupquote{exception }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{ConfigResolutionError}}}
6561 Bases: {\hyperref[\detokenize{commands/apidoc/src:src.pyconf.ConfigError}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.pyconf.ConfigError}}}}} (\autopageref*{\detokenize{commands/apidoc/src:src.pyconf.ConfigError}})
6562
6563 This is the base class of exceptions raised due to semantic errors in
6564 configurations.
6565
6566 \end{fulllineitems}
6567
6568 \index{Container (class in src.pyconf)}
6569
6570 \begin{fulllineitems}
6571 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Container}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{Container}}}{\emph{parent}}{}
6572 Bases: \sphinxcode{\sphinxupquote{object}}
6573
6574 This internal class is the base class for mappings and sequences.
6575
6576 @ivar path: A string which describes how to get
6577 to this instance from the root of the hierarchy.
6578
6579 Example:
6580
6581 \fvset{hllines={, ,}}%
6582 \begin{sphinxVerbatim}[commandchars=\\\{\}]
6583 \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}
6584 \end{sphinxVerbatim}
6585 \index{evaluate() (src.pyconf.Container method)}
6586
6587 \begin{fulllineitems}
6588 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Container.evaluate}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{evaluate}}}{\emph{item}}{}
6589 Evaluate items which are instances of L\{Reference\} or L\{Expression\}.
6590
6591 L\{Reference\} instances are evaluated using L\{Reference.resolve\},
6592 and L\{Expression\} instances are evaluated using
6593 L\{Expression.evaluate\}.
6594
6595 @param item: The item to be evaluated.
6596 @type item: any
6597 @return: If the item is an instance of L\{Reference\} or L\{Expression\},
6598 the evaluated value is returned, otherwise the item is returned
6599 unchanged.
6600
6601 \end{fulllineitems}
6602
6603 \index{setPath() (src.pyconf.Container method)}
6604
6605 \begin{fulllineitems}
6606 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Container.setPath}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{setPath}}}{\emph{path}}{}
6607 Set the path for this instance.
6608 @param path: The path - a string which describes how to get
6609 to this instance from the root of the hierarchy.
6610 @type path: str
6611
6612 \end{fulllineitems}
6613
6614 \index{writeToStream() (src.pyconf.Container method)}
6615
6616 \begin{fulllineitems}
6617 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Container.writeToStream}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{writeToStream}}}{\emph{stream}, \emph{indent}, \emph{container}}{}
6618 Write this instance to a stream at the specified indentation level.
6619
6620 Should be redefined in subclasses.
6621
6622 @param stream: The stream to write to
6623 @type stream: A writable stream (file-like object)
6624 @param indent: The indentation level
6625 @type indent: int
6626 @param container: The container of this instance
6627 @type container: L\{Container\}
6628 @raise NotImplementedError: If a subclass does not override this
6629
6630 \end{fulllineitems}
6631
6632 \index{writeValue() (src.pyconf.Container method)}
6633
6634 \begin{fulllineitems}
6635 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Container.writeValue}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{writeValue}}}{\emph{value}, \emph{stream}, \emph{indent}}{}
6636 \end{fulllineitems}
6637
6638
6639 \end{fulllineitems}
6640
6641 \index{Expression (class in src.pyconf)}
6642
6643 \begin{fulllineitems}
6644 \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}}{}
6645 Bases: \sphinxcode{\sphinxupquote{object}}
6646
6647 This internal class implements a value which is obtained by evaluating an expression.
6648 \index{evaluate() (src.pyconf.Expression method)}
6649
6650 \begin{fulllineitems}
6651 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Expression.evaluate}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{evaluate}}}{\emph{container}}{}
6652 Evaluate this instance in the context of a container.
6653
6654 @param container: The container to evaluate in from.
6655 @type container: L\{Container\}
6656 @return: The evaluated value.
6657 @rtype: any
6658 @raise ConfigResolutionError: If evaluation fails.
6659 @raise ZeroDivideError: If division by zero occurs.
6660 @raise TypeError: If the operation is invalid, e.g.
6661 subtracting one string from another.
6662
6663 \end{fulllineitems}
6664
6665
6666 \end{fulllineitems}
6667
6668 \index{Mapping (class in src.pyconf)}
6669
6670 \begin{fulllineitems}
6671 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Mapping}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{Mapping}}}{\emph{parent=None}}{}
6672 Bases: {\hyperref[\detokenize{commands/apidoc/src:src.pyconf.Container}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.pyconf.Container}}}}} (\autopageref*{\detokenize{commands/apidoc/src:src.pyconf.Container}})
6673
6674 This internal class implements key-value mappings in configurations.
6675 \index{addMapping() (src.pyconf.Mapping method)}
6676
6677 \begin{fulllineitems}
6678 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Mapping.addMapping}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{addMapping}}}{\emph{key}, \emph{value}, \emph{comment}, \emph{setting=False}}{}
6679 Add a key-value mapping with a comment.
6680
6681 @param key: The key for the mapping.
6682 @type key: str
6683 @param value: The value for the mapping.
6684 @type value: any
6685 @param comment: The comment for the key (can be None).
6686 @type comment: str
6687 @param setting: If True, ignore clashes. This is set
6688 to true when called from L\{\_\_setattr\_\_\}.
6689 @raise ConfigFormatError: If an existing key is seen
6690 again and setting is False.
6691
6692 \end{fulllineitems}
6693
6694 \index{get() (src.pyconf.Mapping method)}
6695
6696 \begin{fulllineitems}
6697 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Mapping.get}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get}}}{\emph{key}, \emph{default=None}}{}
6698 Allows a dictionary-style get operation.
6699
6700 \end{fulllineitems}
6701
6702 \index{iteritems() (src.pyconf.Mapping method)}
6703
6704 \begin{fulllineitems}
6705 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Mapping.iteritems}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{iteritems}}}{}{}
6706 \end{fulllineitems}
6707
6708 \index{iterkeys() (src.pyconf.Mapping method)}
6709
6710 \begin{fulllineitems}
6711 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Mapping.iterkeys}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{iterkeys}}}{}{}
6712 \end{fulllineitems}
6713
6714 \index{keys() (src.pyconf.Mapping method)}
6715
6716 \begin{fulllineitems}
6717 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Mapping.keys}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{keys}}}{}{}
6718 Return the keys in a similar way to a dictionary.
6719
6720 \end{fulllineitems}
6721
6722 \index{writeToStream() (src.pyconf.Mapping method)}
6723
6724 \begin{fulllineitems}
6725 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Mapping.writeToStream}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{writeToStream}}}{\emph{stream}, \emph{indent}, \emph{container}}{}
6726 Write this instance to a stream at the specified indentation level.
6727
6728 Should be redefined in subclasses.
6729
6730 @param stream: The stream to write to
6731 @type stream: A writable stream (file-like object)
6732 @param indent: The indentation level
6733 @type indent: int
6734 @param container: The container of this instance
6735 @type container: L\{Container\}
6736
6737 \end{fulllineitems}
6738
6739
6740 \end{fulllineitems}
6741
6742 \index{Reference (class in src.pyconf)}
6743
6744 \begin{fulllineitems}
6745 \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}}{}
6746 Bases: \sphinxcode{\sphinxupquote{object}}
6747
6748 This internal class implements a value which is a reference to another value.
6749 \index{addElement() (src.pyconf.Reference method)}
6750
6751 \begin{fulllineitems}
6752 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Reference.addElement}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{addElement}}}{\emph{type}, \emph{ident}}{}
6753 Add an element to the reference.
6754
6755 @param type: The type of reference.
6756 @type type: BACKTICK or DOLLAR
6757 @param ident: The identifier which continues the reference.
6758 @type ident: str
6759
6760 \end{fulllineitems}
6761
6762 \index{findConfig() (src.pyconf.Reference method)}
6763
6764 \begin{fulllineitems}
6765 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Reference.findConfig}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{findConfig}}}{\emph{container}}{}
6766 Find the closest enclosing configuration to the specified container.
6767
6768 @param container: The container to start from.
6769 @type container: L\{Container\}
6770 @return: The closest enclosing configuration, or None.
6771 @rtype: L\{Config\}
6772
6773 \end{fulllineitems}
6774
6775 \index{resolve() (src.pyconf.Reference method)}
6776
6777 \begin{fulllineitems}
6778 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Reference.resolve}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{resolve}}}{\emph{container}}{}
6779 Resolve this instance in the context of a container.
6780
6781 @param container: The container to resolve from.
6782 @type container: L\{Container\}
6783 @return: The resolved value.
6784 @rtype: any
6785 @raise ConfigResolutionError: If resolution fails.
6786
6787 \end{fulllineitems}
6788
6789
6790 \end{fulllineitems}
6791
6792 \index{Sequence (class in src.pyconf)}
6793
6794 \begin{fulllineitems}
6795 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Sequence}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{Sequence}}}{\emph{parent=None}}{}
6796 Bases: {\hyperref[\detokenize{commands/apidoc/src:src.pyconf.Container}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.pyconf.Container}}}}} (\autopageref*{\detokenize{commands/apidoc/src:src.pyconf.Container}})
6797
6798 This internal class implements a value which is a sequence of other values.
6799 \index{Sequence.SeqIter (class in src.pyconf)}
6800
6801 \begin{fulllineitems}
6802 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Sequence.SeqIter}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxbfcode{\sphinxupquote{SeqIter}}}{\emph{seq}}{}
6803 Bases: \sphinxcode{\sphinxupquote{object}}
6804
6805 This internal class implements an iterator for a L\{Sequence\} instance.
6806 \index{next() (src.pyconf.Sequence.SeqIter method)}
6807
6808 \begin{fulllineitems}
6809 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Sequence.SeqIter.next}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{next}}}{}{}
6810 \end{fulllineitems}
6811
6812
6813 \end{fulllineitems}
6814
6815 \index{append() (src.pyconf.Sequence method)}
6816
6817 \begin{fulllineitems}
6818 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Sequence.append}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append}}}{\emph{item}, \emph{comment}}{}
6819 Add an item to the sequence.
6820
6821 @param item: The item to add.
6822 @type item: any
6823 @param comment: A comment for the item.
6824 @type comment: str
6825
6826 \end{fulllineitems}
6827
6828 \index{writeToStream() (src.pyconf.Sequence method)}
6829
6830 \begin{fulllineitems}
6831 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Sequence.writeToStream}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{writeToStream}}}{\emph{stream}, \emph{indent}, \emph{container}}{}
6832 Write this instance to a stream at the specified indentation level.
6833
6834 Should be redefined in subclasses.
6835
6836 @param stream: The stream to write to
6837 @type stream: A writable stream (file-like object)
6838 @param indent: The indentation level
6839 @type indent: int
6840 @param container: The container of this instance
6841 @type container: L\{Container\}
6842
6843 \end{fulllineitems}
6844
6845
6846 \end{fulllineitems}
6847
6848 \index{deepCopyMapping() (in module src.pyconf)}
6849
6850 \begin{fulllineitems}
6851 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.deepCopyMapping}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{deepCopyMapping}}}{\emph{inMapping}}{}
6852 \end{fulllineitems}
6853
6854 \index{defaultMergeResolve() (in module src.pyconf)}
6855
6856 \begin{fulllineitems}
6857 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.defaultMergeResolve}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{defaultMergeResolve}}}{\emph{map1}, \emph{map2}, \emph{key}}{}
6858 A default resolver for merge conflicts.
6859 Returns a string indicating what action to take to resolve the conflict.
6860
6861 @param map1: The map being merged into.
6862 @type map1: L\{Mapping\}.
6863 @param map2: The map being used as the merge operand.
6864 @type map2: L\{Mapping\}.
6865 @param key: The key in map2 (which also exists in map1).
6866 @type key: str
6867 \begin{description}
6868 \item[{@return: One of “merge”, “append”, “mismatch” or “overwrite”}] \leavevmode
6869 indicating what action should be taken. This should
6870 be appropriate to the objects being merged - e.g.
6871 there is no point returning “merge” if the two objects
6872 are instances of L\{Sequence\}.
6873
6874 \end{description}
6875
6876 @rtype: str
6877
6878 \end{fulllineitems}
6879
6880 \index{defaultStreamOpener() (in module src.pyconf)}
6881
6882 \begin{fulllineitems}
6883 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.defaultStreamOpener}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{defaultStreamOpener}}}{\emph{name}}{}
6884 This function returns a read-only stream, given its name. The name passed
6885 in should correspond to an existing stream, otherwise an exception will be
6886 raised.
6887
6888 This is the default value of L\{streamOpener\}; assign your own callable to
6889 streamOpener to return streams based on names. For example, you could use
6890 urllib2.urlopen().
6891
6892 @param name: The name of a stream, most commonly a file name.
6893 @type name: str
6894 @return: A stream with the specified name.
6895 @rtype: A read-only stream (file-like object)
6896
6897 \end{fulllineitems}
6898
6899 \index{isWord() (in module src.pyconf)}
6900
6901 \begin{fulllineitems}
6902 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.isWord}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{isWord}}}{\emph{s}}{}
6903 See if a passed-in value is an identifier. If the value passed in is not a
6904 string, False is returned. An identifier consists of alphanumerics or
6905 underscore characters.
6906
6907 Examples:
6908
6909 \fvset{hllines={, ,}}%
6910 \begin{sphinxVerbatim}[commandchars=\\\{\}]
6911 \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}
6912 \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}
6913 \PYG{n}{isWord}\PYG{p}{(}\PYG{l+m+mi}{9}\PYG{p}{)} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZgt{}} \PYG{k+kc}{False}
6914 \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}
6915 \end{sphinxVerbatim}
6916
6917 @note: isWord(‘9abc’) will return True - not exactly correct, but adequate
6918 for the way it’s used here.
6919
6920 @param s: The name to be tested
6921 @type s: any
6922 @return: True if a word, else False
6923 @rtype: bool
6924
6925 \end{fulllineitems}
6926
6927 \index{makePath() (in module src.pyconf)}
6928
6929 \begin{fulllineitems}
6930 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.makePath}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{makePath}}}{\emph{prefix}, \emph{suffix}}{}
6931 Make a path from a prefix and suffix.
6932
6933 Examples:
6934 makePath(‘’, ‘suffix’) -\textgreater{} ‘suffix’
6935 makePath(‘prefix’, ‘suffix’) -\textgreater{} ‘prefix.suffix’
6936 makePath(‘prefix’, ‘{[}1{]}’) -\textgreater{} ‘prefix{[}1{]}’
6937
6938 @param prefix: The prefix to use. If it evaluates as false, the suffix is returned.
6939 @type prefix: str
6940 @param suffix: The suffix to use. It is either an identifier or an index in brackets.
6941 @type suffix: str
6942 @return: The path concatenation of prefix and suffix, with adot if the suffix is not a bracketed index.
6943 @rtype: str
6944
6945 \end{fulllineitems}
6946
6947 \index{overwriteMergeResolve() (in module src.pyconf)}
6948
6949 \begin{fulllineitems}
6950 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.overwriteMergeResolve}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{overwriteMergeResolve}}}{\emph{map1}, \emph{map2}, \emph{key}}{}
6951 An overwriting resolver for merge conflicts. Calls L\{defaultMergeResolve\},
6952 but where a “mismatch” is detected, returns “overwrite” instead.
6953
6954 @param map1: The map being merged into.
6955 @type map1: L\{Mapping\}.
6956 @param map2: The map being used as the merge operand.
6957 @type map2: L\{Mapping\}.
6958 @param key: The key in map2 (which also exists in map1).
6959 @type key: str
6960
6961 \end{fulllineitems}
6962
6963
6964
6965 \subsubsection{src.system module}
6966 \label{\detokenize{commands/apidoc/src:src-system-module}}\label{\detokenize{commands/apidoc/src:module-src.system}}\index{src.system (module)}
6967 In this file : all functions that do a system call,
6968 like open a browser or an editor, or call a git command
6969 \index{archive\_extract() (in module src.system)}
6970
6971 \begin{fulllineitems}
6972 \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}}{}
6973 Extracts sources from an archive.
6974 \begin{quote}\begin{description}
6975 \item[{Parameters}] \leavevmode\begin{itemize}
6976 \item {}
6977 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{where}}) \textendash{} The path to the archive.
6978
6979 \item {}
6980 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The path where to extract.
6981
6982 \item {}
6983 \sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to use.
6984
6985 \end{itemize}
6986
6987 \item[{Returns}] \leavevmode
6988 True if the extraction is successful
6989
6990 \item[{Return type}] \leavevmode
6991 boolean
6992
6993 \end{description}\end{quote}
6994
6995 \end{fulllineitems}
6996
6997 \index{cvs\_extract() (in module src.system)}
6998
6999 \begin{fulllineitems}
7000 \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}}{}
7001 Extracts sources from a cvs repository.
7002 \begin{quote}\begin{description}
7003 \item[{Parameters}] \leavevmode\begin{itemize}
7004 \item {}
7005 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{where}}) \textendash{} The cvs protocol.
7006
7007 \item {}
7008 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The user to be used.
7009
7010 \item {}
7011 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The remote cvs server.
7012
7013 \item {}
7014 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{}
7015 .
7016
7017
7018 \item {}
7019 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The tag.
7020
7021 \item {}
7022 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The product.
7023
7024 \item {}
7025 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The path where to extract.
7026
7027 \item {}
7028 \sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to use.
7029
7030 \item {}
7031 \sphinxstyleliteralstrong{\sphinxupquote{boolean}} (\sphinxstyleliteralemphasis{\sphinxupquote{checkout}}) \textendash{} If true use checkout cvs.
7032
7033 \item {}
7034 \sphinxstyleliteralstrong{\sphinxupquote{src.environment.Environ}} (\sphinxstyleliteralemphasis{\sphinxupquote{environment}}) \textendash{} The environment to source when
7035 extracting.
7036
7037 \end{itemize}
7038
7039 \item[{Returns}] \leavevmode
7040 True if the extraction is successful
7041
7042 \item[{Return type}] \leavevmode
7043 boolean
7044
7045 \end{description}\end{quote}
7046
7047 \end{fulllineitems}
7048
7049 \index{git\_extract() (in module src.system)}
7050
7051 \begin{fulllineitems}
7052 \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}}{}
7053 Extracts sources from a git repository.
7054 \begin{quote}\begin{description}
7055 \item[{Parameters}] \leavevmode\begin{itemize}
7056 \item {}
7057 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{where}}) \textendash{} The remote git repository.
7058
7059 \item {}
7060 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The tag.
7061
7062 \item {}
7063 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The path where to extract.
7064
7065 \item {}
7066 \sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to use.
7067
7068 \item {}
7069 \sphinxstyleliteralstrong{\sphinxupquote{src.environment.Environ}} (\sphinxstyleliteralemphasis{\sphinxupquote{environment}}) \textendash{} The environment to source when
7070 extracting.
7071
7072 \end{itemize}
7073
7074 \item[{Returns}] \leavevmode
7075 True if the extraction is successful
7076
7077 \item[{Return type}] \leavevmode
7078 boolean
7079
7080 \end{description}\end{quote}
7081
7082 \end{fulllineitems}
7083
7084 \index{show\_in\_editor() (in module src.system)}
7085
7086 \begin{fulllineitems}
7087 \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}}{}
7088 open filePath using editor.
7089 \begin{quote}\begin{description}
7090 \item[{Parameters}] \leavevmode\begin{itemize}
7091 \item {}
7092 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{filePath}}) \textendash{} The editor to use.
7093
7094 \item {}
7095 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The path to the file to open.
7096
7097 \end{itemize}
7098
7099 \end{description}\end{quote}
7100
7101 \end{fulllineitems}
7102
7103 \index{svn\_extract() (in module src.system)}
7104
7105 \begin{fulllineitems}
7106 \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}}{}
7107 Extracts sources from a svn repository.
7108 \begin{quote}\begin{description}
7109 \item[{Parameters}] \leavevmode\begin{itemize}
7110 \item {}
7111 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{where}}) \textendash{} The user to be used.
7112
7113 \item {}
7114 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The remote git repository.
7115
7116 \item {}
7117 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The tag.
7118
7119 \item {}
7120 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The path where to extract.
7121
7122 \item {}
7123 \sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to use.
7124
7125 \item {}
7126 \sphinxstyleliteralstrong{\sphinxupquote{boolean}} (\sphinxstyleliteralemphasis{\sphinxupquote{checkout}}) \textendash{} If true use checkout svn.
7127
7128 \item {}
7129 \sphinxstyleliteralstrong{\sphinxupquote{src.environment.Environ}} (\sphinxstyleliteralemphasis{\sphinxupquote{environment}}) \textendash{} The environment to source when
7130 extracting.
7131
7132 \end{itemize}
7133
7134 \item[{Returns}] \leavevmode
7135 True if the extraction is successful
7136
7137 \item[{Return type}] \leavevmode
7138 boolean
7139
7140 \end{description}\end{quote}
7141
7142 \end{fulllineitems}
7143
7144
7145
7146 \subsubsection{src.template module}
7147 \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)}
7148
7149 \begin{fulllineitems}
7150 \phantomsection\label{\detokenize{commands/apidoc/src:src.template.MyTemplate}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.template.}}\sphinxbfcode{\sphinxupquote{MyTemplate}}}{\emph{template}}{}
7151 Bases: \sphinxcode{\sphinxupquote{string.Template}}
7152 \index{delimiter (src.template.MyTemplate attribute)}
7153
7154 \begin{fulllineitems}
7155 \phantomsection\label{\detokenize{commands/apidoc/src:src.template.MyTemplate.delimiter}}\pysigline{\sphinxbfcode{\sphinxupquote{delimiter}}\sphinxbfcode{\sphinxupquote{ = '\textbackslash{}xc2\textbackslash{}xa4'}}}
7156 \end{fulllineitems}
7157
7158 \index{pattern (src.template.MyTemplate attribute)}
7159
7160 \begin{fulllineitems}
7161 \phantomsection\label{\detokenize{commands/apidoc/src:src.template.MyTemplate.pattern}}\pysigline{\sphinxbfcode{\sphinxupquote{pattern}}\sphinxbfcode{\sphinxupquote{ = \textless{}\_sre.SRE\_Pattern object\textgreater{}}}}
7162 \end{fulllineitems}
7163
7164
7165 \end{fulllineitems}
7166
7167 \index{substitute() (in module src.template)}
7168
7169 \begin{fulllineitems}
7170 \phantomsection\label{\detokenize{commands/apidoc/src:src.template.substitute}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.template.}}\sphinxbfcode{\sphinxupquote{substitute}}}{\emph{template\_file}, \emph{subst\_dic}}{}
7171 \end{fulllineitems}
7172
7173
7174
7175 \subsubsection{src.test\_module module}
7176 \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)}
7177
7178 \begin{fulllineitems}
7179 \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)}
7180
7181 \begin{fulllineitems}
7182 \phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.generate_launching_commands}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{generate\_launching\_commands}}}{}{}
7183 \end{fulllineitems}
7184
7185 \index{generate\_script() (src.test\_module.Test method)}
7186
7187 \begin{fulllineitems}
7188 \phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.generate_script}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{generate\_script}}}{\emph{listTest}, \emph{script\_path}, \emph{ignoreList}}{}
7189 \end{fulllineitems}
7190
7191 \index{get\_test\_timeout() (src.test\_module.Test method)}
7192
7193 \begin{fulllineitems}
7194 \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}}{}
7195 \end{fulllineitems}
7196
7197 \index{get\_tmp\_dir() (src.test\_module.Test method)}
7198
7199 \begin{fulllineitems}
7200 \phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.get_tmp_dir}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_tmp\_dir}}}{}{}
7201 \end{fulllineitems}
7202
7203 \index{prepare\_testbase() (src.test\_module.Test method)}
7204
7205 \begin{fulllineitems}
7206 \phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.prepare_testbase}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepare\_testbase}}}{\emph{test\_base\_name}}{}
7207 \end{fulllineitems}
7208
7209 \index{prepare\_testbase\_from\_dir() (src.test\_module.Test method)}
7210
7211 \begin{fulllineitems}
7212 \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}}{}
7213 \end{fulllineitems}
7214
7215 \index{prepare\_testbase\_from\_git() (src.test\_module.Test method)}
7216
7217 \begin{fulllineitems}
7218 \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}}{}
7219 \end{fulllineitems}
7220
7221 \index{prepare\_testbase\_from\_svn() (src.test\_module.Test method)}
7222
7223 \begin{fulllineitems}
7224 \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}}{}
7225 \end{fulllineitems}
7226
7227 \index{read\_results() (src.test\_module.Test method)}
7228
7229 \begin{fulllineitems}
7230 \phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.read_results}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{read\_results}}}{\emph{listTest}, \emph{has\_timed\_out}}{}
7231 \end{fulllineitems}
7232
7233 \index{run\_all\_tests() (src.test\_module.Test method)}
7234
7235 \begin{fulllineitems}
7236 \phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.run_all_tests}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run\_all\_tests}}}{}{}
7237 \end{fulllineitems}
7238
7239 \index{run\_grid\_tests() (src.test\_module.Test method)}
7240
7241 \begin{fulllineitems}
7242 \phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.run_grid_tests}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run\_grid\_tests}}}{}{}
7243 \end{fulllineitems}
7244
7245 \index{run\_script() (src.test\_module.Test method)}
7246
7247 \begin{fulllineitems}
7248 \phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.run_script}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run\_script}}}{\emph{script\_name}}{}
7249 \end{fulllineitems}
7250
7251 \index{run\_session\_tests() (src.test\_module.Test method)}
7252
7253 \begin{fulllineitems}
7254 \phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.run_session_tests}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run\_session\_tests}}}{}{}
7255 \end{fulllineitems}
7256
7257 \index{run\_testbase\_tests() (src.test\_module.Test method)}
7258
7259 \begin{fulllineitems}
7260 \phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.run_testbase_tests}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run\_testbase\_tests}}}{}{}
7261 \end{fulllineitems}
7262
7263 \index{run\_tests() (src.test\_module.Test method)}
7264
7265 \begin{fulllineitems}
7266 \phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.run_tests}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run\_tests}}}{\emph{listTest}, \emph{ignoreList}}{}
7267 \end{fulllineitems}
7268
7269 \index{search\_known\_errors() (src.test\_module.Test method)}
7270
7271 \begin{fulllineitems}
7272 \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}}{}
7273 \end{fulllineitems}
7274
7275 \index{write\_test\_margin() (src.test\_module.Test method)}
7276
7277 \begin{fulllineitems}
7278 \phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.write_test_margin}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write\_test\_margin}}}{\emph{tab}}{}
7279 \end{fulllineitems}
7280
7281
7282 \end{fulllineitems}
7283
7284 \index{getTmpDirDEFAULT() (in module src.test\_module)}
7285
7286 \begin{fulllineitems}
7287 \phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.getTmpDirDEFAULT}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.test\_module.}}\sphinxbfcode{\sphinxupquote{getTmpDirDEFAULT}}}{}{}
7288 \end{fulllineitems}
7289
7290
7291
7292 \subsubsection{src.xmlManager module}
7293 \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)}
7294
7295 \begin{fulllineitems}
7296 \phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.ReadXmlFile}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.xmlManager.}}\sphinxbfcode{\sphinxupquote{ReadXmlFile}}}{\emph{filePath}}{}
7297 Bases: \sphinxcode{\sphinxupquote{object}}
7298
7299 Class to manage reading of an xml log file
7300 \index{getRootAttrib() (src.xmlManager.ReadXmlFile method)}
7301
7302 \begin{fulllineitems}
7303 \phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.ReadXmlFile.getRootAttrib}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getRootAttrib}}}{}{}
7304 Get the attibutes of the self.xmlroot
7305 \begin{quote}\begin{description}
7306 \item[{Returns}] \leavevmode
7307 The attributes of the root node
7308
7309 \item[{Return type}] \leavevmode
7310 dict
7311
7312 \end{description}\end{quote}
7313
7314 \end{fulllineitems}
7315
7316 \index{get\_attrib() (src.xmlManager.ReadXmlFile method)}
7317
7318 \begin{fulllineitems}
7319 \phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.ReadXmlFile.get_attrib}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_attrib}}}{\emph{node\_name}}{}
7320 Get the attibutes of the node node\_name in self.xmlroot
7321 \begin{quote}\begin{description}
7322 \item[{Parameters}] \leavevmode
7323 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{node\_name}}) \textendash{} the name of the node
7324
7325 \item[{Returns}] \leavevmode
7326 the attibutes of the node node\_name in self.xmlroot
7327
7328 \item[{Return type}] \leavevmode
7329 dict
7330
7331 \end{description}\end{quote}
7332
7333 \end{fulllineitems}
7334
7335 \index{get\_node\_text() (src.xmlManager.ReadXmlFile method)}
7336
7337 \begin{fulllineitems}
7338 \phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.ReadXmlFile.get_node_text}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_node\_text}}}{\emph{node}}{}~\begin{description}
7339 \item[{Get the text of the first node that has name }] \leavevmode
7340 that corresponds to the parameter node
7341
7342 \end{description}
7343 \begin{quote}\begin{description}
7344 \item[{Parameters}] \leavevmode
7345 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{node}}) \textendash{} the name of the node from which get the text
7346
7347 \item[{Returns}] \leavevmode
7348 the text of the first node that has name
7349 that corresponds to the parameter node
7350
7351 \item[{Return type}] \leavevmode
7352 str
7353
7354 \end{description}\end{quote}
7355
7356 \end{fulllineitems}
7357
7358
7359 \end{fulllineitems}
7360
7361 \index{XmlLogFile (class in src.xmlManager)}
7362
7363 \begin{fulllineitems}
7364 \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=\{\}}}{}
7365 Bases: \sphinxcode{\sphinxupquote{object}}
7366
7367 Class to manage writing in salomeTools xml log file
7368 \index{add\_simple\_node() (src.xmlManager.XmlLogFile method)}
7369
7370 \begin{fulllineitems}
7371 \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=\{\}}}{}
7372 Add a node with some attibutes and text to the root node.
7373 \begin{quote}\begin{description}
7374 \item[{Parameters}] \leavevmode\begin{itemize}
7375 \item {}
7376 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{text}}) \textendash{} the name of the node to add
7377
7378 \item {}
7379 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the text of the node
7380
7381 \item {}
7382 \sphinxstyleliteralstrong{\sphinxupquote{dict}} (\sphinxstyleliteralemphasis{\sphinxupquote{attrib}}) \textendash{} the dictionary containing the
7383 attribute of the new node
7384
7385 \end{itemize}
7386
7387 \end{description}\end{quote}
7388
7389 \end{fulllineitems}
7390
7391 \index{append\_node\_attrib() (src.xmlManager.XmlLogFile method)}
7392
7393 \begin{fulllineitems}
7394 \phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.XmlLogFile.append_node_attrib}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append\_node\_attrib}}}{\emph{node\_name}, \emph{attrib}}{}
7395 Append a new attributes to the node that has node\_name as name
7396 \begin{quote}\begin{description}
7397 \item[{Parameters}] \leavevmode\begin{itemize}
7398 \item {}
7399 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{node\_name}}) \textendash{} The name of the node on which append text
7400
7401 \item {}
7402 \sphinxstyleliteralstrong{\sphinxupquote{dixt}} (\sphinxstyleliteralemphasis{\sphinxupquote{attrib}}) \textendash{} The attrib to append
7403
7404 \end{itemize}
7405
7406 \end{description}\end{quote}
7407
7408 \end{fulllineitems}
7409
7410 \index{append\_node\_text() (src.xmlManager.XmlLogFile method)}
7411
7412 \begin{fulllineitems}
7413 \phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.XmlLogFile.append_node_text}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append\_node\_text}}}{\emph{node\_name}, \emph{text}}{}
7414 Append a new text to the node that has node\_name as name
7415 \begin{quote}\begin{description}
7416 \item[{Parameters}] \leavevmode\begin{itemize}
7417 \item {}
7418 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{text}}) \textendash{} The name of the node on which append text
7419
7420 \item {}
7421 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The text to append
7422
7423 \end{itemize}
7424
7425 \end{description}\end{quote}
7426
7427 \end{fulllineitems}
7428
7429 \index{write\_tree() (src.xmlManager.XmlLogFile method)}
7430
7431 \begin{fulllineitems}
7432 \phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.XmlLogFile.write_tree}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write\_tree}}}{\emph{stylesheet=None}, \emph{file\_path=None}}{}
7433 Write the xml tree in the log file path. Add the stylesheet if asked.
7434 \begin{quote}\begin{description}
7435 \item[{Parameters}] \leavevmode
7436 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{stylesheet}}) \textendash{} The stylesheet to apply to the xml file
7437
7438 \end{description}\end{quote}
7439
7440 \end{fulllineitems}
7441
7442
7443 \end{fulllineitems}
7444
7445 \index{add\_simple\_node() (in module src.xmlManager)}
7446
7447 \begin{fulllineitems}
7448 \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=\{\}}}{}
7449 Add a node with some attibutes and text to the root node.
7450 \begin{quote}\begin{description}
7451 \item[{Parameters}] \leavevmode\begin{itemize}
7452 \item {}
7453 \sphinxstyleliteralstrong{\sphinxupquote{etree.Element}} (\sphinxstyleliteralemphasis{\sphinxupquote{root\_node}}) \textendash{} the Etree element where to add the new node
7454
7455 \item {}
7456 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{text}}) \textendash{} the name of the node to add
7457
7458 \item {}
7459 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the text of the node
7460
7461 \item {}
7462 \sphinxstyleliteralstrong{\sphinxupquote{dict}} (\sphinxstyleliteralemphasis{\sphinxupquote{attrib}}) \textendash{} the dictionary containing the
7463 attribute of the new node
7464
7465 \end{itemize}
7466
7467 \end{description}\end{quote}
7468
7469 \end{fulllineitems}
7470
7471 \index{append\_node\_attrib() (in module src.xmlManager)}
7472
7473 \begin{fulllineitems}
7474 \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}}{}
7475 Append a new attributes to the node that has node\_name as name
7476 \begin{quote}\begin{description}
7477 \item[{Parameters}] \leavevmode\begin{itemize}
7478 \item {}
7479 \sphinxstyleliteralstrong{\sphinxupquote{etree.Element}} (\sphinxstyleliteralemphasis{\sphinxupquote{root\_node}}) \textendash{} the Etree element
7480 where to append the new attibutes
7481
7482 \item {}
7483 \sphinxstyleliteralstrong{\sphinxupquote{dixt}} (\sphinxstyleliteralemphasis{\sphinxupquote{attrib}}) \textendash{} The attrib to append
7484
7485 \end{itemize}
7486
7487 \end{description}\end{quote}
7488
7489 \end{fulllineitems}
7490
7491 \index{find\_node\_by\_attrib() (in module src.xmlManager)}
7492
7493 \begin{fulllineitems}
7494 \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}
7495 \item[{Find the nfirst ode from xmlroot that has name name\_node and that has in }] \leavevmode
7496 its attributes \{key : value\}. Return the node
7497
7498 \end{description}
7499 \begin{quote}\begin{description}
7500 \item[{Parameters}] \leavevmode\begin{itemize}
7501 \item {}
7502 \sphinxstyleliteralstrong{\sphinxupquote{etree.Element}} (\sphinxstyleliteralemphasis{\sphinxupquote{xmlroot}}) \textendash{} the Etree element where to search
7503
7504 \item {}
7505 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the name of node to search
7506
7507 \item {}
7508 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the key to search
7509
7510 \item {}
7511 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to search
7512
7513 \end{itemize}
7514
7515 \item[{Returns}] \leavevmode
7516 the found node
7517
7518 \item[{Return type}] \leavevmode
7519 xmlroot etree.Element
7520
7521 \end{description}\end{quote}
7522
7523 \end{fulllineitems}
7524
7525 \index{write\_report() (in module src.xmlManager)}
7526
7527 \begin{fulllineitems}
7528 \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}}{}
7529 Writes a report file from a XML tree.
7530 \begin{quote}\begin{description}
7531 \item[{Parameters}] \leavevmode\begin{itemize}
7532 \item {}
7533 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{stylesheet}}) \textendash{} The path to the file to create
7534
7535 \item {}
7536 \sphinxstyleliteralstrong{\sphinxupquote{etree.Element}} (\sphinxstyleliteralemphasis{\sphinxupquote{xmlroot}}) \textendash{} the Etree element to write to the file
7537
7538 \item {}
7539 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The stylesheet to add to the begin of the file
7540
7541 \end{itemize}
7542
7543 \end{description}\end{quote}
7544
7545 \end{fulllineitems}
7546
7547
7548
7549 \subsubsection{Module contents}
7550 \label{\detokenize{commands/apidoc/src:module-src}}\label{\detokenize{commands/apidoc/src:module-contents}}\index{src (module)}
7551 initial imports and utilities methods for salomeTools
7552 \index{Path (class in src)}
7553
7554 \begin{fulllineitems}
7555 \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)}
7556
7557 \begin{fulllineitems}
7558 \phantomsection\label{\detokenize{commands/apidoc/src:src.Path.base}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{base}}}{}{}
7559 \end{fulllineitems}
7560
7561 \index{chmod() (src.Path method)}
7562
7563 \begin{fulllineitems}
7564 \phantomsection\label{\detokenize{commands/apidoc/src:src.Path.chmod}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{chmod}}}{\emph{mode}}{}
7565 \end{fulllineitems}
7566
7567 \index{copy() (src.Path method)}
7568
7569 \begin{fulllineitems}
7570 \phantomsection\label{\detokenize{commands/apidoc/src:src.Path.copy}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{copy}}}{\emph{path}, \emph{smart=False}}{}
7571 \end{fulllineitems}
7572
7573 \index{copydir() (src.Path method)}
7574
7575 \begin{fulllineitems}
7576 \phantomsection\label{\detokenize{commands/apidoc/src:src.Path.copydir}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{copydir}}}{\emph{dst}, \emph{smart=False}}{}
7577 \end{fulllineitems}
7578
7579 \index{copyfile() (src.Path method)}
7580
7581 \begin{fulllineitems}
7582 \phantomsection\label{\detokenize{commands/apidoc/src:src.Path.copyfile}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{copyfile}}}{\emph{path}}{}
7583 \end{fulllineitems}
7584
7585 \index{copylink() (src.Path method)}
7586
7587 \begin{fulllineitems}
7588 \phantomsection\label{\detokenize{commands/apidoc/src:src.Path.copylink}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{copylink}}}{\emph{path}}{}
7589 \end{fulllineitems}
7590
7591 \index{dir() (src.Path method)}
7592
7593 \begin{fulllineitems}
7594 \phantomsection\label{\detokenize{commands/apidoc/src:src.Path.dir}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{dir}}}{}{}
7595 \end{fulllineitems}
7596
7597 \index{exists() (src.Path method)}
7598
7599 \begin{fulllineitems}
7600 \phantomsection\label{\detokenize{commands/apidoc/src:src.Path.exists}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{exists}}}{}{}
7601 \end{fulllineitems}
7602
7603 \index{isdir() (src.Path method)}
7604
7605 \begin{fulllineitems}
7606 \phantomsection\label{\detokenize{commands/apidoc/src:src.Path.isdir}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{isdir}}}{}{}
7607 \end{fulllineitems}
7608
7609 \index{isfile() (src.Path method)}
7610
7611 \begin{fulllineitems}
7612 \phantomsection\label{\detokenize{commands/apidoc/src:src.Path.isfile}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{isfile}}}{}{}
7613 \end{fulllineitems}
7614
7615 \index{islink() (src.Path method)}
7616
7617 \begin{fulllineitems}
7618 \phantomsection\label{\detokenize{commands/apidoc/src:src.Path.islink}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{islink}}}{}{}
7619 \end{fulllineitems}
7620
7621 \index{list() (src.Path method)}
7622
7623 \begin{fulllineitems}
7624 \phantomsection\label{\detokenize{commands/apidoc/src:src.Path.list}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{list}}}{}{}
7625 \end{fulllineitems}
7626
7627 \index{make() (src.Path method)}
7628
7629 \begin{fulllineitems}
7630 \phantomsection\label{\detokenize{commands/apidoc/src:src.Path.make}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{make}}}{\emph{mode=None}}{}
7631 \end{fulllineitems}
7632
7633 \index{readlink() (src.Path method)}
7634
7635 \begin{fulllineitems}
7636 \phantomsection\label{\detokenize{commands/apidoc/src:src.Path.readlink}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{readlink}}}{}{}
7637 \end{fulllineitems}
7638
7639 \index{rm() (src.Path method)}
7640
7641 \begin{fulllineitems}
7642 \phantomsection\label{\detokenize{commands/apidoc/src:src.Path.rm}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{rm}}}{}{}
7643 \end{fulllineitems}
7644
7645 \index{smartcopy() (src.Path method)}
7646
7647 \begin{fulllineitems}
7648 \phantomsection\label{\detokenize{commands/apidoc/src:src.Path.smartcopy}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{smartcopy}}}{\emph{path}}{}
7649 \end{fulllineitems}
7650
7651 \index{symlink() (src.Path method)}
7652
7653 \begin{fulllineitems}
7654 \phantomsection\label{\detokenize{commands/apidoc/src:src.Path.symlink}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{symlink}}}{\emph{path}}{}
7655 \end{fulllineitems}
7656
7657
7658 \end{fulllineitems}
7659
7660 \index{SatException}
7661
7662 \begin{fulllineitems}
7663 \phantomsection\label{\detokenize{commands/apidoc/src:src.SatException}}\pysigline{\sphinxbfcode{\sphinxupquote{exception }}\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{SatException}}}
7664 Bases: \sphinxcode{\sphinxupquote{exceptions.Exception}}
7665
7666 rename Exception Class
7667
7668 \end{fulllineitems}
7669
7670 \index{activate\_mesa\_property() (in module src)}
7671
7672 \begin{fulllineitems}
7673 \phantomsection\label{\detokenize{commands/apidoc/src:src.activate_mesa_property}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{activate\_mesa\_property}}}{\emph{config}}{}
7674 Add mesa property into application properties
7675 \begin{quote}\begin{description}
7676 \item[{Parameters}] \leavevmode
7677 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} The global configuration. It must have an application!
7678
7679 \end{description}\end{quote}
7680
7681 \end{fulllineitems}
7682
7683 \index{check\_config\_has\_application() (in module src)}
7684
7685 \begin{fulllineitems}
7686 \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}}{}
7687 check that the config has the key APPLICATION. Else raise an exception.
7688 \begin{quote}\begin{description}
7689 \item[{Parameters}] \leavevmode
7690 \sphinxstyleliteralstrong{\sphinxupquote{class 'common.pyconf.Config'}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} The config.
7691
7692 \end{description}\end{quote}
7693
7694 \end{fulllineitems}
7695
7696 \index{check\_config\_has\_profile() (in module src)}
7697
7698 \begin{fulllineitems}
7699 \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}}{}
7700 check that the config has the key APPLICATION.profile.
7701 else, raise an exception.
7702 \begin{quote}\begin{description}
7703 \item[{Parameters}] \leavevmode
7704 \sphinxstyleliteralstrong{\sphinxupquote{class 'common.pyconf.Config'}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} The config.
7705
7706 \end{description}\end{quote}
7707
7708 \end{fulllineitems}
7709
7710 \index{config\_has\_application() (in module src)}
7711
7712 \begin{fulllineitems}
7713 \phantomsection\label{\detokenize{commands/apidoc/src:src.config_has_application}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{config\_has\_application}}}{\emph{config}}{}
7714 \end{fulllineitems}
7715
7716 \index{deepcopy\_list() (in module src)}
7717
7718 \begin{fulllineitems}
7719 \phantomsection\label{\detokenize{commands/apidoc/src:src.deepcopy_list}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{deepcopy\_list}}}{\emph{input\_list}}{}
7720 Do a deep copy of a list
7721 \begin{quote}\begin{description}
7722 \item[{Parameters}] \leavevmode
7723 \sphinxstyleliteralstrong{\sphinxupquote{List}} (\sphinxstyleliteralemphasis{\sphinxupquote{input\_list}}) \textendash{} The list to copy
7724
7725 \item[{Returns}] \leavevmode
7726 The copy of the list
7727
7728 \item[{Return type}] \leavevmode
7729 List
7730
7731 \end{description}\end{quote}
7732
7733 \end{fulllineitems}
7734
7735 \index{ensure\_path\_exists() (in module src)}
7736
7737 \begin{fulllineitems}
7738 \phantomsection\label{\detokenize{commands/apidoc/src:src.ensure_path_exists}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{ensure\_path\_exists}}}{\emph{p}}{}
7739 Create a path if not existing
7740 \begin{quote}\begin{description}
7741 \item[{Parameters}] \leavevmode
7742 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{p}}) \textendash{} The path.
7743
7744 \end{description}\end{quote}
7745
7746 \end{fulllineitems}
7747
7748 \index{find\_file\_in\_lpath() (in module src)}
7749
7750 \begin{fulllineitems}
7751 \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=''}}{}
7752 Find in all the directories in lpath list the file that has the same name
7753 as file\_name.
7754 If it is found
7755 then return the full path of the file
7756 else return False.
7757
7758 The additional\_dir (optional) is the name of the directory to add to all
7759 paths in lpath.
7760 \begin{quote}\begin{description}
7761 \item[{Parameters}] \leavevmode\begin{itemize}
7762 \item {}
7763 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{additional\_dir}}) \textendash{} The file name to search
7764
7765 \item {}
7766 \sphinxstyleliteralstrong{\sphinxupquote{List}} (\sphinxstyleliteralemphasis{\sphinxupquote{lpath}}) \textendash{} The list of directories where to search
7767
7768 \item {}
7769 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The name of the additional directory
7770
7771 \end{itemize}
7772
7773 \item[{Returns}] \leavevmode
7774 the full path of the file or False if not found
7775
7776 \item[{Return type}] \leavevmode
7777 str
7778
7779 \end{description}\end{quote}
7780
7781 \end{fulllineitems}
7782
7783 \index{get\_base\_path() (in module src)}
7784
7785 \begin{fulllineitems}
7786 \phantomsection\label{\detokenize{commands/apidoc/src:src.get_base_path}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{get\_base\_path}}}{\emph{config}}{}
7787 Returns the path of the products base.
7788 \begin{quote}\begin{description}
7789 \item[{Parameters}] \leavevmode
7790 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} The global Config instance.
7791
7792 \item[{Returns}] \leavevmode
7793 The path of the products base.
7794
7795 \item[{Return type}] \leavevmode
7796 str
7797
7798 \end{description}\end{quote}
7799
7800 \end{fulllineitems}
7801
7802 \index{get\_cfg\_param() (in module src)}
7803
7804 \begin{fulllineitems}
7805 \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}}{}
7806 eearch for param\_name value in config.
7807 if param\_name is not in config
7808 then return default,
7809 else return the found value
7810 \begin{quote}\begin{description}
7811 \item[{Parameters}] \leavevmode\begin{itemize}
7812 \item {}
7813 \sphinxstyleliteralstrong{\sphinxupquote{class 'common.pyconf.Config'}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} The config.
7814
7815 \item {}
7816 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{default}}) \textendash{} the name of the parameter to get the value
7817
7818 \item {}
7819 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The value to return if param\_name is not in config
7820
7821 \end{itemize}
7822
7823 \item[{Returns}] \leavevmode
7824 see initial description of the function
7825
7826 \item[{Return type}] \leavevmode
7827 str
7828
7829 \end{description}\end{quote}
7830
7831 \end{fulllineitems}
7832
7833 \index{get\_launcher\_name() (in module src)}
7834
7835 \begin{fulllineitems}
7836 \phantomsection\label{\detokenize{commands/apidoc/src:src.get_launcher_name}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{get\_launcher\_name}}}{\emph{config}}{}
7837 Returns the name of salome launcher.
7838 \begin{quote}\begin{description}
7839 \item[{Parameters}] \leavevmode
7840 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} The global Config instance.
7841
7842 \item[{Returns}] \leavevmode
7843 The name of salome launcher.
7844
7845 \item[{Return type}] \leavevmode
7846 str
7847
7848 \end{description}\end{quote}
7849
7850 \end{fulllineitems}
7851
7852 \index{get\_log\_path() (in module src)}
7853
7854 \begin{fulllineitems}
7855 \phantomsection\label{\detokenize{commands/apidoc/src:src.get_log_path}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{get\_log\_path}}}{\emph{config}}{}
7856 Returns the path of the logs.
7857 \begin{quote}\begin{description}
7858 \item[{Parameters}] \leavevmode
7859 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} The global Config instance.
7860
7861 \item[{Returns}] \leavevmode
7862 The path of the logs.
7863
7864 \item[{Return type}] \leavevmode
7865 str
7866
7867 \end{description}\end{quote}
7868
7869 \end{fulllineitems}
7870
7871 \index{get\_property\_in\_product\_cfg() (in module src)}
7872
7873 \begin{fulllineitems}
7874 \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}}{}
7875 \end{fulllineitems}
7876
7877 \index{get\_salome\_version() (in module src)}
7878
7879 \begin{fulllineitems}
7880 \phantomsection\label{\detokenize{commands/apidoc/src:src.get_salome_version}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{get\_salome\_version}}}{\emph{config}}{}
7881 \end{fulllineitems}
7882
7883 \index{get\_tmp\_filename() (in module src)}
7884
7885 \begin{fulllineitems}
7886 \phantomsection\label{\detokenize{commands/apidoc/src:src.get_tmp_filename}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{get\_tmp\_filename}}}{\emph{cfg}, \emph{name}}{}
7887 \end{fulllineitems}
7888
7889 \index{handleRemoveReadonly() (in module src)}
7890
7891 \begin{fulllineitems}
7892 \phantomsection\label{\detokenize{commands/apidoc/src:src.handleRemoveReadonly}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{handleRemoveReadonly}}}{\emph{func}, \emph{path}, \emph{exc}}{}
7893 \end{fulllineitems}
7894
7895 \index{merge\_dicts() (in module src)}
7896
7897 \begin{fulllineitems}
7898 \phantomsection\label{\detokenize{commands/apidoc/src:src.merge_dicts}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{merge\_dicts}}}{\emph{*dict\_args}}{}
7899 Given any number of dicts, shallow copy and merge into a new dict,
7900 precedence goes to key value pairs in latter dicts.
7901
7902 \end{fulllineitems}
7903
7904 \index{only\_numbers() (in module src)}
7905
7906 \begin{fulllineitems}
7907 \phantomsection\label{\detokenize{commands/apidoc/src:src.only_numbers}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{only\_numbers}}}{\emph{str\_num}}{}
7908 \end{fulllineitems}
7909
7910 \index{parse\_date() (in module src)}
7911
7912 \begin{fulllineitems}
7913 \phantomsection\label{\detokenize{commands/apidoc/src:src.parse_date}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{parse\_date}}}{\emph{date}}{}
7914 Transform YYYYMMDD\_hhmmss into YYYY-MM-DD hh:mm:ss.
7915 \begin{quote}\begin{description}
7916 \item[{Parameters}] \leavevmode
7917 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{date}}) \textendash{} The date to transform
7918
7919 \item[{Returns}] \leavevmode
7920 The date in the new format
7921
7922 \item[{Return type}] \leavevmode
7923 str
7924
7925 \end{description}\end{quote}
7926
7927 \end{fulllineitems}
7928
7929 \index{print\_info() (in module src)}
7930
7931 \begin{fulllineitems}
7932 \phantomsection\label{\detokenize{commands/apidoc/src:src.print_info}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{print\_info}}}{\emph{logger}, \emph{info}}{}
7933 Prints the tuples that are in info variable in a formatted way.
7934 \begin{quote}\begin{description}
7935 \item[{Parameters}] \leavevmode\begin{itemize}
7936 \item {}
7937 \sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logging instance to use for the prints.
7938
7939 \item {}
7940 \sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{info}}) \textendash{} The list of tuples to display
7941
7942 \end{itemize}
7943
7944 \end{description}\end{quote}
7945
7946 \end{fulllineitems}
7947
7948 \index{read\_config\_from\_a\_file() (in module src)}
7949
7950 \begin{fulllineitems}
7951 \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}}{}
7952 \end{fulllineitems}
7953
7954 \index{remove\_item\_from\_list() (in module src)}
7955
7956 \begin{fulllineitems}
7957 \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}}{}
7958 Remove all occurences of item from input\_list
7959 \begin{quote}\begin{description}
7960 \item[{Parameters}] \leavevmode
7961 \sphinxstyleliteralstrong{\sphinxupquote{List}} (\sphinxstyleliteralemphasis{\sphinxupquote{input\_list}}) \textendash{} The list to modify
7962
7963 \item[{Returns}] \leavevmode
7964 The without any item
7965
7966 \item[{Return type}] \leavevmode
7967 List
7968
7969 \end{description}\end{quote}
7970
7971 \end{fulllineitems}
7972
7973 \index{replace\_in\_file() (in module src)}
7974
7975 \begin{fulllineitems}
7976 \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}}{}
7977 Replace \textless{}strin\textgreater{} by \textless{}strout\textgreater{} in file \textless{}filein\textgreater{}
7978
7979 \end{fulllineitems}
7980
7981
7982
7983 \chapter{Release Notes}
7984 \label{\detokenize{index:release-notes}}
7985
7986 \section{Release notes}
7987 \label{\detokenize{release_notes/release_notes_5.0.0:release-notes}}\label{\detokenize{release_notes/release_notes_5.0.0::doc}}
7988 In construction.
7989
7990
7991 \renewcommand{\indexname}{Python Module Index}
7992 \begin{sphinxtheindex}
7993 \def\bigletter#1{{\Large\sffamily#1}\nopagebreak\vspace{1mm}}
7994 \bigletter{s}
7995 \item {\sphinxstyleindexentry{src}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src}}
7996 \item {\sphinxstyleindexentry{src.architecture}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.architecture}}
7997 \item {\sphinxstyleindexentry{src.colorama}}\sphinxstyleindexpageref{commands/apidoc/src.colorama:\detokenize{module-src.colorama}}
7998 \item {\sphinxstyleindexentry{src.colorama.ansi}}\sphinxstyleindexpageref{commands/apidoc/src.colorama:\detokenize{module-src.colorama.ansi}}
7999 \item {\sphinxstyleindexentry{src.colorama.ansitowin32}}\sphinxstyleindexpageref{commands/apidoc/src.colorama:\detokenize{module-src.colorama.ansitowin32}}
8000 \item {\sphinxstyleindexentry{src.colorama.initialise}}\sphinxstyleindexpageref{commands/apidoc/src.colorama:\detokenize{module-src.colorama.initialise}}
8001 \item {\sphinxstyleindexentry{src.colorama.win32}}\sphinxstyleindexpageref{commands/apidoc/src.colorama:\detokenize{module-src.colorama.win32}}
8002 \item {\sphinxstyleindexentry{src.colorama.winterm}}\sphinxstyleindexpageref{commands/apidoc/src.colorama:\detokenize{module-src.colorama.winterm}}
8003 \item {\sphinxstyleindexentry{src.compilation}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.compilation}}
8004 \item {\sphinxstyleindexentry{src.debug}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.debug}}
8005 \item {\sphinxstyleindexentry{src.ElementTree}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.ElementTree}}
8006 \item {\sphinxstyleindexentry{src.environment}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.environment}}
8007 \item {\sphinxstyleindexentry{src.fileEnviron}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.fileEnviron}}
8008 \item {\sphinxstyleindexentry{src.fork}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.fork}}
8009 \item {\sphinxstyleindexentry{src.logger}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.logger}}
8010 \item {\sphinxstyleindexentry{src.options}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.options}}
8011 \item {\sphinxstyleindexentry{src.printcolors}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.printcolors}}
8012 \item {\sphinxstyleindexentry{src.product}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.product}}
8013 \item {\sphinxstyleindexentry{src.pyconf}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.pyconf}}
8014 \item {\sphinxstyleindexentry{src.system}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.system}}
8015 \item {\sphinxstyleindexentry{src.template}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.template}}
8016 \item {\sphinxstyleindexentry{src.test\_module}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.test_module}}
8017 \item {\sphinxstyleindexentry{src.xmlManager}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.xmlManager}}
8018 \end{sphinxtheindex}
8019
8020 \renewcommand{\indexname}{Index}
8021 \printindex
8022 \end{document}