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 26, 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 in format xml/html:
 359
 360 \fvset{hllines={, ,}}%
 361 \begin{sphinxVerbatim}[commandchars=\\\{\}]
 362 \PYG{n}{sat} \PYG{n}{doc} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{xml}
 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 Print salomeTools debug messages in sys.stderr.
2855 Show pretty print debug representation from instances of SAT classes
2856 (pretty print src.pyconf.Config)
2857
2858 \begin{DUlineblock}{0em}
2859 \item[] Warning: supposedly show messages in SAT development phase, not production
2860 \item[]
2861 \item[] Usage:
2862 \item[] \textgreater{}\textgreater{} import debug as DBG
2863 \item[] \textgreater{}\textgreater{} DBG.write(“aTitle”, aVariable)        \# not shown in production
2864 \item[] \textgreater{}\textgreater{} DBG.write(“aTitle”, aVariable, True)  \# unconditionaly shown (as show=True)
2865 \item[]
2866 \item[] to set show message as development phase:
2867 \item[] \textgreater{}\textgreater{} DBG.push\_debug(True)
2868 \item[]
2869 \item[] to set no show message as production phase:
2870 \item[] \textgreater{}\textgreater{} DBG.push\_debug(False)
2871 \item[]
2872 \item[] to set show message temporary as development phase, only in a method:
2873 \item[] \textgreater{}\textgreater{} def aMethodToDebug(…):
2874 \item[] \textgreater{}\textgreater{}   DBG.push\_debug(True)              \#force show as appended status
2875 \item[] \textgreater{}\textgreater{}   etc. method code with some DBG.write()
2876 \item[] \textgreater{}\textgreater{}   DBG.pop\_debug()                   \#restore previous status (show or not show)
2877 \item[] \textgreater{}\textgreater{}   return
2878 \item[]
2879 \item[] to set a message for future fix, as temporary problem to not forget:
2880 \item[] DBG.tofix(“aTitle”, aVariable, True/False) \#True/False in production shown, or not
2881 \item[]
2882 \item[] in command line interface you could redirect stderr to file ‘myDebug.log’:
2883 \item[] \textgreater{}\textgreater{} sat compile … 2\textgreater{} myDebug.log   \# only stderr
2884 \item[] \textgreater{}\textgreater{} sat compile … \&\textgreater{} myDebug.log   \# stdout and stderr
2885 \end{DUlineblock}
2886 \index{InStream (class in src.debug)}
2887
2888 \begin{fulllineitems}
2889 \phantomsection\label{\detokenize{commands/apidoc/src:src.debug.InStream}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{InStream}}}{\emph{buf=''}}{}
2890 Bases: \sphinxcode{\sphinxupquote{StringIO.StringIO}}
2891
2892 utility class for pyconf.Config input iostream
2893
2894 \end{fulllineitems}
2895
2896 \index{OutStream (class in src.debug)}
2897
2898 \begin{fulllineitems}
2899 \phantomsection\label{\detokenize{commands/apidoc/src:src.debug.OutStream}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{OutStream}}}{\emph{buf=''}}{}
2900 Bases: \sphinxcode{\sphinxupquote{StringIO.StringIO}}
2901
2902 utility class for pyconf.Config output iostream
2903 \index{close() (src.debug.OutStream method)}
2904
2905 \begin{fulllineitems}
2906 \phantomsection\label{\detokenize{commands/apidoc/src:src.debug.OutStream.close}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{close}}}{}{}
2907 because Config.\_\_save\_\_ calls close() stream as file
2908 keep value before lost as self.value
2909
2910 \end{fulllineitems}
2911
2912
2913 \end{fulllineitems}
2914
2915 \index{format\_color\_exception() (in module src.debug)}
2916
2917 \begin{fulllineitems}
2918 \phantomsection\label{\detokenize{commands/apidoc/src:src.debug.format_color_exception}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{format\_color\_exception}}}{\emph{msg}, \emph{limit=None}, \emph{trace=None}}{}
2919 Format a stack trace and the exception information.
2920 as traceback.format\_exception(), with color
2921 with traceback only if (\_debug) or (DBG.\_user in DBG.\_developpers)
2922
2923 \end{fulllineitems}
2924
2925 \index{format\_exception() (in module src.debug)}
2926
2927 \begin{fulllineitems}
2928 \phantomsection\label{\detokenize{commands/apidoc/src:src.debug.format_exception}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{format\_exception}}}{\emph{msg}, \emph{limit=None}, \emph{trace=None}}{}
2929 Format a stack trace and the exception information.
2930 as traceback.format\_exception(), without color
2931 with traceback only if (\_debug) or (DBG.\_user in DBG.\_developpers)
2932
2933 \end{fulllineitems}
2934
2935 \index{getLocalEnv() (in module src.debug)}
2936
2937 \begin{fulllineitems}
2938 \phantomsection\label{\detokenize{commands/apidoc/src:src.debug.getLocalEnv}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{getLocalEnv}}}{}{}
2939 get string for environment variables representation
2940
2941 \end{fulllineitems}
2942
2943 \index{getStrConfigDbg() (in module src.debug)}
2944
2945 \begin{fulllineitems}
2946 \phantomsection\label{\detokenize{commands/apidoc/src:src.debug.getStrConfigDbg}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{getStrConfigDbg}}}{\emph{config}}{}
2947 set string as saveConfigDbg,
2948 as (path expression evaluation) for debug
2949
2950 \end{fulllineitems}
2951
2952 \index{getStrConfigStd() (in module src.debug)}
2953
2954 \begin{fulllineitems}
2955 \phantomsection\label{\detokenize{commands/apidoc/src:src.debug.getStrConfigStd}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{getStrConfigStd}}}{\emph{config}}{}
2956 set string as saveConfigStd, as file .pyconf
2957
2958 \end{fulllineitems}
2959
2960 \index{indent() (in module src.debug)}
2961
2962 \begin{fulllineitems}
2963 \phantomsection\label{\detokenize{commands/apidoc/src:src.debug.indent}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{indent}}}{\emph{text}, \emph{amount=2}, \emph{ch=' '}}{}
2964 indent multi lines message
2965
2966 \end{fulllineitems}
2967
2968 \index{isTypeConfig() (in module src.debug)}
2969
2970 \begin{fulllineitems}
2971 \phantomsection\label{\detokenize{commands/apidoc/src:src.debug.isTypeConfig}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{isTypeConfig}}}{\emph{var}}{}
2972 To know if var is instance from Config/pyconf
2973
2974 \end{fulllineitems}
2975
2976 \index{pop\_debug() (in module src.debug)}
2977
2978 \begin{fulllineitems}
2979 \phantomsection\label{\detokenize{commands/apidoc/src:src.debug.pop_debug}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{pop\_debug}}}{}{}
2980 restore previous debug outputs status
2981
2982 \end{fulllineitems}
2983
2984 \index{push\_debug() (in module src.debug)}
2985
2986 \begin{fulllineitems}
2987 \phantomsection\label{\detokenize{commands/apidoc/src:src.debug.push_debug}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{push\_debug}}}{\emph{aBool}}{}
2988 set debug outputs activated, or not
2989
2990 \end{fulllineitems}
2991
2992 \index{saveConfigDbg() (in module src.debug)}
2993
2994 \begin{fulllineitems}
2995 \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=''}}{}
2996 pyconf returns multilines (path expression evaluation) for debug
2997
2998 \end{fulllineitems}
2999
3000 \index{saveConfigStd() (in module src.debug)}
3001
3002 \begin{fulllineitems}
3003 \phantomsection\label{\detokenize{commands/apidoc/src:src.debug.saveConfigStd}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{saveConfigStd}}}{\emph{config}, \emph{aStream}}{}
3004 returns as file .pyconf
3005
3006 \end{fulllineitems}
3007
3008 \index{tofix() (in module src.debug)}
3009
3010 \begin{fulllineitems}
3011 \phantomsection\label{\detokenize{commands/apidoc/src:src.debug.tofix}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{tofix}}}{\emph{title}, \emph{var=''}, \emph{force=None}}{}
3012 write sys.stderr a message if \_debug{[}-1{]}==True or optionaly force=True
3013 use this only if no logger accessible for classic logger.warning(message)
3014
3015 \end{fulllineitems}
3016
3017 \index{write() (in module src.debug)}
3018
3019 \begin{fulllineitems}
3020 \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'}}{}
3021 write sys.stderr a message if \_debug{[}-1{]}==True or optionaly force=True
3022
3023 \end{fulllineitems}
3024
3025
3026
3027 \subsubsection{src.environment module}
3028 \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)}
3029
3030 \begin{fulllineitems}
3031 \phantomsection\label{\detokenize{commands/apidoc/src:src.environment.Environ}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.environment.}}\sphinxbfcode{\sphinxupquote{Environ}}}{\emph{environ=None}}{}
3032 Class to manage the environment context
3033 \index{append() (src.environment.Environ method)}
3034
3035 \begin{fulllineitems}
3036 \phantomsection\label{\detokenize{commands/apidoc/src:src.environment.Environ.append}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
3037 Same as append\_value but the value argument can be a list
3038 \begin{quote}\begin{description}
3039 \item[{Parameters}] \leavevmode\begin{itemize}
3040 \item {}
3041 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to append
3042
3043 \item {}
3044 \sphinxstyleliteralstrong{\sphinxupquote{str}}\sphinxstyleliteralstrong{\sphinxupquote{ or }}\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the value(s) to append to key
3045
3046 \item {}
3047 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
3048
3049 \end{itemize}
3050
3051 \end{description}\end{quote}
3052
3053 \end{fulllineitems}
3054
3055 \index{append\_value() (src.environment.Environ method)}
3056
3057 \begin{fulllineitems}
3058 \phantomsection\label{\detokenize{commands/apidoc/src:src.environment.Environ.append_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append\_value}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
3059 append value to key using sep
3060 \begin{quote}\begin{description}
3061 \item[{Parameters}] \leavevmode\begin{itemize}
3062 \item {}
3063 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to append
3064
3065 \item {}
3066 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to append to key
3067
3068 \item {}
3069 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
3070
3071 \end{itemize}
3072
3073 \end{description}\end{quote}
3074
3075 \end{fulllineitems}
3076
3077 \index{command\_value() (src.environment.Environ method)}
3078
3079 \begin{fulllineitems}
3080 \phantomsection\label{\detokenize{commands/apidoc/src:src.environment.Environ.command_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{command\_value}}}{\emph{key}, \emph{command}}{}
3081 Get the value given by the system command “command”
3082 and put it in the environment variable key
3083 \begin{quote}\begin{description}
3084 \item[{Parameters}] \leavevmode\begin{itemize}
3085 \item {}
3086 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{command}}) \textendash{} the environment variable
3087
3088 \item {}
3089 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the command to execute
3090
3091 \end{itemize}
3092
3093 \end{description}\end{quote}
3094
3095 \end{fulllineitems}
3096
3097 \index{get() (src.environment.Environ method)}
3098
3099 \begin{fulllineitems}
3100 \phantomsection\label{\detokenize{commands/apidoc/src:src.environment.Environ.get}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get}}}{\emph{key}}{}
3101 Get the value of the environment variable “key”
3102 \begin{quote}\begin{description}
3103 \item[{Parameters}] \leavevmode
3104 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable
3105
3106 \end{description}\end{quote}
3107
3108 \end{fulllineitems}
3109
3110 \index{is\_defined() (src.environment.Environ method)}
3111
3112 \begin{fulllineitems}
3113 \phantomsection\label{\detokenize{commands/apidoc/src:src.environment.Environ.is_defined}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{is\_defined}}}{\emph{key}}{}
3114 Check if the key exists in the environment
3115 \begin{quote}\begin{description}
3116 \item[{Parameters}] \leavevmode
3117 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable to check
3118
3119 \end{description}\end{quote}
3120
3121 \end{fulllineitems}
3122
3123 \index{prepend() (src.environment.Environ method)}
3124
3125 \begin{fulllineitems}
3126 \phantomsection\label{\detokenize{commands/apidoc/src:src.environment.Environ.prepend}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepend}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
3127 Same as prepend\_value but the value argument can be a list
3128 \begin{quote}\begin{description}
3129 \item[{Parameters}] \leavevmode\begin{itemize}
3130 \item {}
3131 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to prepend
3132
3133 \item {}
3134 \sphinxstyleliteralstrong{\sphinxupquote{str}}\sphinxstyleliteralstrong{\sphinxupquote{ or }}\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the value(s) to prepend to key
3135
3136 \item {}
3137 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
3138
3139 \end{itemize}
3140
3141 \end{description}\end{quote}
3142
3143 \end{fulllineitems}
3144
3145 \index{prepend\_value() (src.environment.Environ method)}
3146
3147 \begin{fulllineitems}
3148 \phantomsection\label{\detokenize{commands/apidoc/src:src.environment.Environ.prepend_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepend\_value}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
3149 prepend value to key using sep
3150 \begin{quote}\begin{description}
3151 \item[{Parameters}] \leavevmode\begin{itemize}
3152 \item {}
3153 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to prepend
3154
3155 \item {}
3156 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to prepend to key
3157
3158 \item {}
3159 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
3160
3161 \end{itemize}
3162
3163 \end{description}\end{quote}
3164
3165 \end{fulllineitems}
3166
3167 \index{set() (src.environment.Environ method)}
3168
3169 \begin{fulllineitems}
3170 \phantomsection\label{\detokenize{commands/apidoc/src:src.environment.Environ.set}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set}}}{\emph{key}, \emph{value}}{}
3171 Set the environment variable “key” to value “value”
3172 \begin{quote}\begin{description}
3173 \item[{Parameters}] \leavevmode\begin{itemize}
3174 \item {}
3175 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the environment variable to set
3176
3177 \item {}
3178 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value
3179
3180 \end{itemize}
3181
3182 \end{description}\end{quote}
3183
3184 \end{fulllineitems}
3185
3186
3187 \end{fulllineitems}
3188
3189 \index{FileEnvWriter (class in src.environment)}
3190
3191 \begin{fulllineitems}
3192 \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}}{}
3193 Class to dump the environment to a file.
3194 \index{write\_cfgForPy\_file() (src.environment.FileEnvWriter method)}
3195
3196 \begin{fulllineitems}
3197 \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}}{}
3198 Append to current opened aFile a cfgForPy
3199 environment (SALOME python launcher).
3200 \begin{quote}\begin{description}
3201 \item[{Parameters}] \leavevmode\begin{itemize}
3202 \item {}
3203 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{for\_package}}) \textendash{} the file path
3204
3205 \item {}
3206 \sphinxstyleliteralstrong{\sphinxupquote{dict}} (\sphinxstyleliteralemphasis{\sphinxupquote{additional\_env}}) \textendash{} a dictionary of additional variables
3207 to add to the environment
3208
3209 \item {}
3210 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} If not None, produce a relative environment
3211 designed for a package.
3212
3213 \end{itemize}
3214
3215 \end{description}\end{quote}
3216
3217 \end{fulllineitems}
3218
3219 \index{write\_env\_file() (src.environment.FileEnvWriter method)}
3220
3221 \begin{fulllineitems}
3222 \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}}{}
3223 Create an environment file.
3224 \begin{quote}\begin{description}
3225 \item[{Parameters}] \leavevmode\begin{itemize}
3226 \item {}
3227 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{shell}}) \textendash{} the file path
3228
3229 \item {}
3230 \sphinxstyleliteralstrong{\sphinxupquote{bool}} (\sphinxstyleliteralemphasis{\sphinxupquote{forBuild}}) \textendash{} if true, the build environment
3231
3232 \item {}
3233 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the type of file wanted (.sh, .bat)
3234
3235 \end{itemize}
3236
3237 \item[{Returns}] \leavevmode
3238 The path to the generated file
3239
3240 \item[{Return type}] \leavevmode
3241 str
3242
3243 \end{description}\end{quote}
3244
3245 \end{fulllineitems}
3246
3247
3248 \end{fulllineitems}
3249
3250 \index{SalomeEnviron (class in src.environment)}
3251
3252 \begin{fulllineitems}
3253 \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}}{}
3254 Class to manage the environment of SALOME.
3255 \index{add\_comment() (src.environment.SalomeEnviron method)}
3256
3257 \begin{fulllineitems}
3258 \phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.add_comment}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_comment}}}{\emph{comment}}{}
3259 Add a commentary to the out stream (in case of file generation)
3260 \begin{quote}\begin{description}
3261 \item[{Parameters}] \leavevmode
3262 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{comment}}) \textendash{} the commentary to add
3263
3264 \end{description}\end{quote}
3265
3266 \end{fulllineitems}
3267
3268 \index{add\_line() (src.environment.SalomeEnviron method)}
3269
3270 \begin{fulllineitems}
3271 \phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.add_line}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_line}}}{\emph{nb\_line}}{}
3272 Add empty lines to the out stream (in case of file generation)
3273 \begin{quote}\begin{description}
3274 \item[{Parameters}] \leavevmode
3275 \sphinxstyleliteralstrong{\sphinxupquote{int}} (\sphinxstyleliteralemphasis{\sphinxupquote{nb\_line}}) \textendash{} the number of empty lines to add
3276
3277 \end{description}\end{quote}
3278
3279 \end{fulllineitems}
3280
3281 \index{add\_warning() (src.environment.SalomeEnviron method)}
3282
3283 \begin{fulllineitems}
3284 \phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.add_warning}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_warning}}}{\emph{warning}}{}
3285 Add a warning to the out stream (in case of file generation)
3286 \begin{quote}\begin{description}
3287 \item[{Parameters}] \leavevmode
3288 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{warning}}) \textendash{} the warning to add
3289
3290 \end{description}\end{quote}
3291
3292 \end{fulllineitems}
3293
3294 \index{append() (src.environment.SalomeEnviron method)}
3295
3296 \begin{fulllineitems}
3297 \phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.append}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
3298 append value to key using sep
3299 \begin{quote}\begin{description}
3300 \item[{Parameters}] \leavevmode\begin{itemize}
3301 \item {}
3302 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to append
3303
3304 \item {}
3305 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to append to key
3306
3307 \item {}
3308 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
3309
3310 \end{itemize}
3311
3312 \end{description}\end{quote}
3313
3314 \end{fulllineitems}
3315
3316 \index{dump() (src.environment.SalomeEnviron method)}
3317
3318 \begin{fulllineitems}
3319 \phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.dump}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{dump}}}{\emph{out}}{}
3320 Write the environment to out
3321 \begin{quote}\begin{description}
3322 \item[{Parameters}] \leavevmode
3323 \sphinxstyleliteralstrong{\sphinxupquote{file}} (\sphinxstyleliteralemphasis{\sphinxupquote{out}}) \textendash{} the stream where to write the environment
3324
3325 \end{description}\end{quote}
3326
3327 \end{fulllineitems}
3328
3329 \index{finish() (src.environment.SalomeEnviron method)}
3330
3331 \begin{fulllineitems}
3332 \phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.finish}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{finish}}}{\emph{required}}{}
3333 Add a final instruction in the out file (in case of file generation)
3334 \begin{quote}\begin{description}
3335 \item[{Parameters}] \leavevmode
3336 \sphinxstyleliteralstrong{\sphinxupquote{bool}} (\sphinxstyleliteralemphasis{\sphinxupquote{required}}) \textendash{} Do nothing if required is False
3337
3338 \end{description}\end{quote}
3339
3340 \end{fulllineitems}
3341
3342 \index{get() (src.environment.SalomeEnviron method)}
3343
3344 \begin{fulllineitems}
3345 \phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.get}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get}}}{\emph{key}}{}
3346 Get the value of the environment variable “key”
3347 \begin{quote}\begin{description}
3348 \item[{Parameters}] \leavevmode
3349 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable
3350
3351 \end{description}\end{quote}
3352
3353 \end{fulllineitems}
3354
3355 \index{get\_names() (src.environment.SalomeEnviron method)}
3356
3357 \begin{fulllineitems}
3358 \phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.get_names}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_names}}}{\emph{lProducts}}{}
3359 Get the products name to add in SALOME\_MODULES environment variable
3360 It is the name of the product, except in the case where the is a
3361 component name. And it has to be in SALOME\_MODULES variable only
3362 if the product has the property has\_salome\_hui = “yes”
3363 \begin{quote}\begin{description}
3364 \item[{Parameters}] \leavevmode
3365 \sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{lProducts}}) \textendash{} List of products to potentially add
3366
3367 \end{description}\end{quote}
3368
3369 \end{fulllineitems}
3370
3371 \index{is\_defined() (src.environment.SalomeEnviron method)}
3372
3373 \begin{fulllineitems}
3374 \phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.is_defined}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{is\_defined}}}{\emph{key}}{}
3375 Check if the key exists in the environment
3376 \begin{quote}\begin{description}
3377 \item[{Parameters}] \leavevmode
3378 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable to check
3379
3380 \end{description}\end{quote}
3381
3382 \end{fulllineitems}
3383
3384 \index{load\_cfg\_environment() (src.environment.SalomeEnviron method)}
3385
3386 \begin{fulllineitems}
3387 \phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.load_cfg_environment}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{load\_cfg\_environment}}}{\emph{cfg\_env}}{}
3388 Loads environment defined in cfg\_env
3389 \begin{quote}\begin{description}
3390 \item[{Parameters}] \leavevmode
3391 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{cfg\_env}}) \textendash{} A config containing an environment
3392
3393 \end{description}\end{quote}
3394
3395 \end{fulllineitems}
3396
3397 \index{prepend() (src.environment.SalomeEnviron method)}
3398
3399 \begin{fulllineitems}
3400 \phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.prepend}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepend}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
3401 prepend value to key using sep
3402 \begin{quote}\begin{description}
3403 \item[{Parameters}] \leavevmode\begin{itemize}
3404 \item {}
3405 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to prepend
3406
3407 \item {}
3408 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to prepend to key
3409
3410 \item {}
3411 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
3412
3413 \end{itemize}
3414
3415 \end{description}\end{quote}
3416
3417 \end{fulllineitems}
3418
3419 \index{run\_env\_script() (src.environment.SalomeEnviron method)}
3420
3421 \begin{fulllineitems}
3422 \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}}{}
3423 Runs an environment script.
3424 \begin{quote}\begin{description}
3425 \item[{Parameters}] \leavevmode\begin{itemize}
3426 \item {}
3427 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The product description
3428
3429 \item {}
3430 \sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to display messages
3431
3432 \item {}
3433 \sphinxstyleliteralstrong{\sphinxupquote{Boolean}} (\sphinxstyleliteralemphasis{\sphinxupquote{native}}) \textendash{} if True load set\_native\_env instead of set\_env
3434
3435 \end{itemize}
3436
3437 \end{description}\end{quote}
3438
3439 \end{fulllineitems}
3440
3441 \index{run\_simple\_env\_script() (src.environment.SalomeEnviron method)}
3442
3443 \begin{fulllineitems}
3444 \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}}{}
3445 Runs an environment script. Same as run\_env\_script, but with a
3446 script path as parameter.
3447 \begin{quote}\begin{description}
3448 \item[{Parameters}] \leavevmode\begin{itemize}
3449 \item {}
3450 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{script\_path}}) \textendash{} a path to an environment script
3451
3452 \item {}
3453 \sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to display messages
3454
3455 \end{itemize}
3456
3457 \end{description}\end{quote}
3458
3459 \end{fulllineitems}
3460
3461 \index{set() (src.environment.SalomeEnviron method)}
3462
3463 \begin{fulllineitems}
3464 \phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.set}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set}}}{\emph{key}, \emph{value}}{}
3465 Set the environment variable “key” to value “value”
3466 \begin{quote}\begin{description}
3467 \item[{Parameters}] \leavevmode\begin{itemize}
3468 \item {}
3469 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the environment variable to set
3470
3471 \item {}
3472 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value
3473
3474 \end{itemize}
3475
3476 \end{description}\end{quote}
3477
3478 \end{fulllineitems}
3479
3480 \index{set\_a\_product() (src.environment.SalomeEnviron method)}
3481
3482 \begin{fulllineitems}
3483 \phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.set_a_product}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_a\_product}}}{\emph{product}, \emph{logger}}{}
3484 Sets the environment of a product.
3485 \begin{quote}\begin{description}
3486 \item[{Parameters}] \leavevmode\begin{itemize}
3487 \item {}
3488 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{product}}) \textendash{} The product name
3489
3490 \item {}
3491 \sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to display messages
3492
3493 \end{itemize}
3494
3495 \end{description}\end{quote}
3496
3497 \end{fulllineitems}
3498
3499 \index{set\_application\_env() (src.environment.SalomeEnviron method)}
3500
3501 \begin{fulllineitems}
3502 \phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.set_application_env}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_application\_env}}}{\emph{logger}}{}
3503 Sets the environment defined in the APPLICATION file.
3504 \begin{quote}\begin{description}
3505 \item[{Parameters}] \leavevmode
3506 \sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to display messages
3507
3508 \end{description}\end{quote}
3509
3510 \end{fulllineitems}
3511
3512 \index{set\_cpp\_env() (src.environment.SalomeEnviron method)}
3513
3514 \begin{fulllineitems}
3515 \phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.set_cpp_env}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_cpp\_env}}}{\emph{product\_info}}{}
3516 Sets the generic environment for a SALOME cpp product.
3517 \begin{quote}\begin{description}
3518 \item[{Parameters}] \leavevmode
3519 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The product description
3520
3521 \end{description}\end{quote}
3522
3523 \end{fulllineitems}
3524
3525 \index{set\_full\_environ() (src.environment.SalomeEnviron method)}
3526
3527 \begin{fulllineitems}
3528 \phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.set_full_environ}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_full\_environ}}}{\emph{logger}, \emph{env\_info}}{}
3529 Sets the full environment for products
3530 specified in env\_info dictionary.
3531 \begin{quote}\begin{description}
3532 \item[{Parameters}] \leavevmode\begin{itemize}
3533 \item {}
3534 \sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to display messages
3535
3536 \item {}
3537 \sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{env\_info}}) \textendash{} the list of products
3538
3539 \end{itemize}
3540
3541 \end{description}\end{quote}
3542
3543 \end{fulllineitems}
3544
3545 \index{set\_products() (src.environment.SalomeEnviron method)}
3546
3547 \begin{fulllineitems}
3548 \phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.set_products}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_products}}}{\emph{logger}, \emph{src\_root=None}}{}
3549 Sets the environment for all the products.
3550 \begin{quote}\begin{description}
3551 \item[{Parameters}] \leavevmode\begin{itemize}
3552 \item {}
3553 \sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to display messages
3554
3555 \item {}
3556 \sphinxstyleliteralstrong{\sphinxupquote{src}} (\sphinxstyleliteralemphasis{\sphinxupquote{src\_root}}) \textendash{} the application working directory
3557
3558 \end{itemize}
3559
3560 \end{description}\end{quote}
3561
3562 \end{fulllineitems}
3563
3564 \index{set\_python\_libdirs() (src.environment.SalomeEnviron method)}
3565
3566 \begin{fulllineitems}
3567 \phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.set_python_libdirs}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_python\_libdirs}}}{}{}
3568 Set some generic variables for python library paths
3569
3570 \end{fulllineitems}
3571
3572 \index{set\_salome\_generic\_product\_env() (src.environment.SalomeEnviron method)}
3573
3574 \begin{fulllineitems}
3575 \phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.set_salome_generic_product_env}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_salome\_generic\_product\_env}}}{\emph{pi}}{}
3576 Sets the generic environment for a SALOME product.
3577 \begin{quote}\begin{description}
3578 \item[{Parameters}] \leavevmode
3579 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{pi}}) \textendash{} The product description
3580
3581 \end{description}\end{quote}
3582
3583 \end{fulllineitems}
3584
3585 \index{set\_salome\_minimal\_product\_env() (src.environment.SalomeEnviron method)}
3586
3587 \begin{fulllineitems}
3588 \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}}{}
3589 Sets the minimal environment for a SALOME product.
3590 xxx\_ROOT\_DIR and xxx\_SRC\_DIR
3591 \begin{quote}\begin{description}
3592 \item[{Parameters}] \leavevmode\begin{itemize}
3593 \item {}
3594 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The product description
3595
3596 \item {}
3597 \sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to display messages
3598
3599 \end{itemize}
3600
3601 \end{description}\end{quote}
3602
3603 \end{fulllineitems}
3604
3605
3606 \end{fulllineitems}
3607
3608 \index{Shell (class in src.environment)}
3609
3610 \begin{fulllineitems}
3611 \phantomsection\label{\detokenize{commands/apidoc/src:src.environment.Shell}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.environment.}}\sphinxbfcode{\sphinxupquote{Shell}}}{\emph{name}, \emph{extension}}{}
3612 Definition of a Shell.
3613
3614 \end{fulllineitems}
3615
3616 \index{load\_environment() (in module src.environment)}
3617
3618 \begin{fulllineitems}
3619 \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}}{}
3620 Loads the environment (used to run the tests, for example).
3621 \begin{quote}\begin{description}
3622 \item[{Parameters}] \leavevmode\begin{itemize}
3623 \item {}
3624 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} the global config
3625
3626 \item {}
3627 \sphinxstyleliteralstrong{\sphinxupquote{bool}} (\sphinxstyleliteralemphasis{\sphinxupquote{build}}) \textendash{} build environement if True
3628
3629 \item {}
3630 \sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to display messages
3631
3632 \end{itemize}
3633
3634 \end{description}\end{quote}
3635
3636 \end{fulllineitems}
3637
3638
3639
3640 \subsubsection{src.fileEnviron module}
3641 \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)}
3642
3643 \begin{fulllineitems}
3644 \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}}{}
3645 Bases: {\hyperref[\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.fileEnviron.FileEnviron}}}}} (\autopageref*{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron}})
3646
3647 Class for bash shell.
3648 \index{command\_value() (src.fileEnviron.BashFileEnviron method)}
3649
3650 \begin{fulllineitems}
3651 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.BashFileEnviron.command_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{command\_value}}}{\emph{key}, \emph{command}}{}
3652 Get the value given by the system command “command”
3653 and put it in the environment variable key.
3654 Has to be overwritten in the derived classes
3655 This can be seen as a virtual method
3656 \begin{quote}\begin{description}
3657 \item[{Parameters}] \leavevmode\begin{itemize}
3658 \item {}
3659 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{command}}) \textendash{} the environment variable
3660
3661 \item {}
3662 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the command to execute
3663
3664 \end{itemize}
3665
3666 \end{description}\end{quote}
3667
3668 \end{fulllineitems}
3669
3670 \index{finish() (src.fileEnviron.BashFileEnviron method)}
3671
3672 \begin{fulllineitems}
3673 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.BashFileEnviron.finish}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{finish}}}{\emph{required=True}}{}
3674 Add a final instruction in the out file (in case of file generation)
3675 \begin{quote}\begin{description}
3676 \item[{Parameters}] \leavevmode
3677 \sphinxstyleliteralstrong{\sphinxupquote{bool}} (\sphinxstyleliteralemphasis{\sphinxupquote{required}}) \textendash{} Do nothing if required is False
3678
3679 \end{description}\end{quote}
3680
3681 \end{fulllineitems}
3682
3683 \index{set() (src.fileEnviron.BashFileEnviron method)}
3684
3685 \begin{fulllineitems}
3686 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.BashFileEnviron.set}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set}}}{\emph{key}, \emph{value}}{}
3687 Set the environment variable “key” to value “value”
3688 \begin{quote}\begin{description}
3689 \item[{Parameters}] \leavevmode\begin{itemize}
3690 \item {}
3691 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the environment variable to set
3692
3693 \item {}
3694 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value
3695
3696 \end{itemize}
3697
3698 \end{description}\end{quote}
3699
3700 \end{fulllineitems}
3701
3702
3703 \end{fulllineitems}
3704
3705 \index{BatFileEnviron (class in src.fileEnviron)}
3706
3707 \begin{fulllineitems}
3708 \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}}{}
3709 Bases: {\hyperref[\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.fileEnviron.FileEnviron}}}}} (\autopageref*{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron}})
3710
3711 for Windows batch shell.
3712 \index{add\_comment() (src.fileEnviron.BatFileEnviron method)}
3713
3714 \begin{fulllineitems}
3715 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.BatFileEnviron.add_comment}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_comment}}}{\emph{comment}}{}
3716 Add a comment in the shell file
3717 \begin{quote}\begin{description}
3718 \item[{Parameters}] \leavevmode
3719 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{comment}}) \textendash{} the comment to add
3720
3721 \end{description}\end{quote}
3722
3723 \end{fulllineitems}
3724
3725 \index{command\_value() (src.fileEnviron.BatFileEnviron method)}
3726
3727 \begin{fulllineitems}
3728 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.BatFileEnviron.command_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{command\_value}}}{\emph{key}, \emph{command}}{}
3729 Get the value given by the system command “command”
3730 and put it in the environment variable key.
3731 Has to be overwritten in the derived classes
3732 This can be seen as a virtual method
3733 \begin{quote}\begin{description}
3734 \item[{Parameters}] \leavevmode\begin{itemize}
3735 \item {}
3736 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{command}}) \textendash{} the environment variable
3737
3738 \item {}
3739 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the command to execute
3740
3741 \end{itemize}
3742
3743 \end{description}\end{quote}
3744
3745 \end{fulllineitems}
3746
3747 \index{finish() (src.fileEnviron.BatFileEnviron method)}
3748
3749 \begin{fulllineitems}
3750 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.BatFileEnviron.finish}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{finish}}}{\emph{required=True}}{}
3751 Add a final instruction in the out file (in case of file generation)
3752 In the particular windows case, do nothing
3753 \begin{quote}\begin{description}
3754 \item[{Parameters}] \leavevmode
3755 \sphinxstyleliteralstrong{\sphinxupquote{bool}} (\sphinxstyleliteralemphasis{\sphinxupquote{required}}) \textendash{} Do nothing if required is False
3756
3757 \end{description}\end{quote}
3758
3759 \end{fulllineitems}
3760
3761 \index{get() (src.fileEnviron.BatFileEnviron method)}
3762
3763 \begin{fulllineitems}
3764 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.BatFileEnviron.get}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get}}}{\emph{key}}{}
3765 Get the value of the environment variable “key”
3766 \begin{quote}\begin{description}
3767 \item[{Parameters}] \leavevmode
3768 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable
3769
3770 \end{description}\end{quote}
3771
3772 \end{fulllineitems}
3773
3774 \index{set() (src.fileEnviron.BatFileEnviron method)}
3775
3776 \begin{fulllineitems}
3777 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.BatFileEnviron.set}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set}}}{\emph{key}, \emph{value}}{}
3778 Set the environment variable “key” to value “value”
3779 \begin{quote}\begin{description}
3780 \item[{Parameters}] \leavevmode\begin{itemize}
3781 \item {}
3782 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the environment variable to set
3783
3784 \item {}
3785 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value
3786
3787 \end{itemize}
3788
3789 \end{description}\end{quote}
3790
3791 \end{fulllineitems}
3792
3793
3794 \end{fulllineitems}
3795
3796 \index{ContextFileEnviron (class in src.fileEnviron)}
3797
3798 \begin{fulllineitems}
3799 \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}}{}
3800 Bases: {\hyperref[\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.fileEnviron.FileEnviron}}}}} (\autopageref*{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron}})
3801
3802 Class for a salome context configuration file.
3803 \index{add\_echo() (src.fileEnviron.ContextFileEnviron method)}
3804
3805 \begin{fulllineitems}
3806 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.add_echo}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_echo}}}{\emph{text}}{}
3807 Add a comment
3808 \begin{quote}\begin{description}
3809 \item[{Parameters}] \leavevmode
3810 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{text}}) \textendash{} the comment to add
3811
3812 \end{description}\end{quote}
3813
3814 \end{fulllineitems}
3815
3816 \index{add\_warning() (src.fileEnviron.ContextFileEnviron method)}
3817
3818 \begin{fulllineitems}
3819 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.add_warning}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_warning}}}{\emph{warning}}{}
3820 Add a warning
3821 \begin{quote}\begin{description}
3822 \item[{Parameters}] \leavevmode
3823 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{text}}) \textendash{} the warning to add
3824
3825 \end{description}\end{quote}
3826
3827 \end{fulllineitems}
3828
3829 \index{append\_value() (src.fileEnviron.ContextFileEnviron method)}
3830
3831 \begin{fulllineitems}
3832 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.append_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append\_value}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
3833 append value to key using sep
3834 \begin{quote}\begin{description}
3835 \item[{Parameters}] \leavevmode\begin{itemize}
3836 \item {}
3837 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to append
3838
3839 \item {}
3840 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to append to key
3841
3842 \item {}
3843 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
3844
3845 \end{itemize}
3846
3847 \end{description}\end{quote}
3848
3849 \end{fulllineitems}
3850
3851 \index{command\_value() (src.fileEnviron.ContextFileEnviron method)}
3852
3853 \begin{fulllineitems}
3854 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.command_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{command\_value}}}{\emph{key}, \emph{command}}{}
3855 Get the value given by the system command “command”
3856 and put it in the environment variable key.
3857 Has to be overwritten in the derived classes
3858 This can be seen as a virtual method
3859 \begin{quote}\begin{description}
3860 \item[{Parameters}] \leavevmode\begin{itemize}
3861 \item {}
3862 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{command}}) \textendash{} the environment variable
3863
3864 \item {}
3865 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the command to execute
3866
3867 \end{itemize}
3868
3869 \end{description}\end{quote}
3870
3871 \end{fulllineitems}
3872
3873 \index{finish() (src.fileEnviron.ContextFileEnviron method)}
3874
3875 \begin{fulllineitems}
3876 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.finish}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{finish}}}{\emph{required=True}}{}
3877 Add a final instruction in the out file (in case of file generation)
3878 \begin{quote}\begin{description}
3879 \item[{Parameters}] \leavevmode
3880 \sphinxstyleliteralstrong{\sphinxupquote{bool}} (\sphinxstyleliteralemphasis{\sphinxupquote{required}}) \textendash{} Do nothing if required is False
3881
3882 \end{description}\end{quote}
3883
3884 \end{fulllineitems}
3885
3886 \index{get() (src.fileEnviron.ContextFileEnviron method)}
3887
3888 \begin{fulllineitems}
3889 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.get}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get}}}{\emph{key}}{}
3890 Get the value of the environment variable “key”
3891 \begin{quote}\begin{description}
3892 \item[{Parameters}] \leavevmode
3893 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable
3894
3895 \end{description}\end{quote}
3896
3897 \end{fulllineitems}
3898
3899 \index{prepend\_value() (src.fileEnviron.ContextFileEnviron method)}
3900
3901 \begin{fulllineitems}
3902 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.prepend_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepend\_value}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
3903 prepend value to key using sep
3904 \begin{quote}\begin{description}
3905 \item[{Parameters}] \leavevmode\begin{itemize}
3906 \item {}
3907 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to prepend
3908
3909 \item {}
3910 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to prepend to key
3911
3912 \item {}
3913 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
3914
3915 \end{itemize}
3916
3917 \end{description}\end{quote}
3918
3919 \end{fulllineitems}
3920
3921 \index{set() (src.fileEnviron.ContextFileEnviron method)}
3922
3923 \begin{fulllineitems}
3924 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.set}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set}}}{\emph{key}, \emph{value}}{}
3925 Set the environment variable “key” to value “value”
3926 \begin{quote}\begin{description}
3927 \item[{Parameters}] \leavevmode\begin{itemize}
3928 \item {}
3929 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the environment variable to set
3930
3931 \item {}
3932 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value
3933
3934 \end{itemize}
3935
3936 \end{description}\end{quote}
3937
3938 \end{fulllineitems}
3939
3940
3941 \end{fulllineitems}
3942
3943 \index{FileEnviron (class in src.fileEnviron)}
3944
3945 \begin{fulllineitems}
3946 \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}}{}
3947 Bases: \sphinxcode{\sphinxupquote{object}}
3948
3949 Base class for shell environment
3950 \index{add\_comment() (src.fileEnviron.FileEnviron method)}
3951
3952 \begin{fulllineitems}
3953 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.add_comment}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_comment}}}{\emph{comment}}{}
3954 Add a comment in the shell file
3955 \begin{quote}\begin{description}
3956 \item[{Parameters}] \leavevmode
3957 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{comment}}) \textendash{} the comment to add
3958
3959 \end{description}\end{quote}
3960
3961 \end{fulllineitems}
3962
3963 \index{add\_echo() (src.fileEnviron.FileEnviron method)}
3964
3965 \begin{fulllineitems}
3966 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.add_echo}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_echo}}}{\emph{text}}{}
3967 Add a “echo” in the shell file
3968 \begin{quote}\begin{description}
3969 \item[{Parameters}] \leavevmode
3970 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{text}}) \textendash{} the text to echo
3971
3972 \end{description}\end{quote}
3973
3974 \end{fulllineitems}
3975
3976 \index{add\_line() (src.fileEnviron.FileEnviron method)}
3977
3978 \begin{fulllineitems}
3979 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.add_line}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_line}}}{\emph{number}}{}
3980 Add some empty lines in the shell file
3981 \begin{quote}\begin{description}
3982 \item[{Parameters}] \leavevmode
3983 \sphinxstyleliteralstrong{\sphinxupquote{int}} (\sphinxstyleliteralemphasis{\sphinxupquote{number}}) \textendash{} the number of lines to add
3984
3985 \end{description}\end{quote}
3986
3987 \end{fulllineitems}
3988
3989 \index{add\_warning() (src.fileEnviron.FileEnviron method)}
3990
3991 \begin{fulllineitems}
3992 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.add_warning}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_warning}}}{\emph{warning}}{}
3993 Add a warning “echo” in the shell file
3994 \begin{quote}\begin{description}
3995 \item[{Parameters}] \leavevmode
3996 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{warning}}) \textendash{} the text to echo
3997
3998 \end{description}\end{quote}
3999
4000 \end{fulllineitems}
4001
4002 \index{append() (src.fileEnviron.FileEnviron method)}
4003
4004 \begin{fulllineitems}
4005 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.append}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
4006 Same as append\_value but the value argument can be a list
4007 \begin{quote}\begin{description}
4008 \item[{Parameters}] \leavevmode\begin{itemize}
4009 \item {}
4010 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to append
4011
4012 \item {}
4013 \sphinxstyleliteralstrong{\sphinxupquote{str}}\sphinxstyleliteralstrong{\sphinxupquote{ or }}\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the value(s) to append to key
4014
4015 \item {}
4016 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
4017
4018 \end{itemize}
4019
4020 \end{description}\end{quote}
4021
4022 \end{fulllineitems}
4023
4024 \index{append\_value() (src.fileEnviron.FileEnviron method)}
4025
4026 \begin{fulllineitems}
4027 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.append_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append\_value}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
4028 append value to key using sep
4029 \begin{quote}\begin{description}
4030 \item[{Parameters}] \leavevmode\begin{itemize}
4031 \item {}
4032 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to append
4033
4034 \item {}
4035 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to append to key
4036
4037 \item {}
4038 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
4039
4040 \end{itemize}
4041
4042 \end{description}\end{quote}
4043
4044 \end{fulllineitems}
4045
4046 \index{command\_value() (src.fileEnviron.FileEnviron method)}
4047
4048 \begin{fulllineitems}
4049 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.command_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{command\_value}}}{\emph{key}, \emph{command}}{}
4050 Get the value given by the system command “command”
4051 and put it in the environment variable key.
4052 Has to be overwritten in the derived classes
4053 This can be seen as a virtual method
4054 \begin{quote}\begin{description}
4055 \item[{Parameters}] \leavevmode\begin{itemize}
4056 \item {}
4057 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{command}}) \textendash{} the environment variable
4058
4059 \item {}
4060 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the command to execute
4061
4062 \end{itemize}
4063
4064 \end{description}\end{quote}
4065
4066 \end{fulllineitems}
4067
4068 \index{finish() (src.fileEnviron.FileEnviron method)}
4069
4070 \begin{fulllineitems}
4071 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.finish}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{finish}}}{\emph{required=True}}{}
4072 Add a final instruction in the out file (in case of file generation)
4073 \begin{quote}\begin{description}
4074 \item[{Parameters}] \leavevmode
4075 \sphinxstyleliteralstrong{\sphinxupquote{bool}} (\sphinxstyleliteralemphasis{\sphinxupquote{required}}) \textendash{} Do nothing if required is False
4076
4077 \end{description}\end{quote}
4078
4079 \end{fulllineitems}
4080
4081 \index{get() (src.fileEnviron.FileEnviron method)}
4082
4083 \begin{fulllineitems}
4084 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.get}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get}}}{\emph{key}}{}
4085 Get the value of the environment variable “key”
4086 \begin{quote}\begin{description}
4087 \item[{Parameters}] \leavevmode
4088 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable
4089
4090 \end{description}\end{quote}
4091
4092 \end{fulllineitems}
4093
4094 \index{is\_defined() (src.fileEnviron.FileEnviron method)}
4095
4096 \begin{fulllineitems}
4097 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.is_defined}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{is\_defined}}}{\emph{key}}{}
4098 Check if the key exists in the environment
4099 \begin{quote}\begin{description}
4100 \item[{Parameters}] \leavevmode
4101 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable to check
4102
4103 \end{description}\end{quote}
4104
4105 \end{fulllineitems}
4106
4107 \index{prepend() (src.fileEnviron.FileEnviron method)}
4108
4109 \begin{fulllineitems}
4110 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.prepend}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepend}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
4111 Same as prepend\_value but the value argument can be a list
4112 \begin{quote}\begin{description}
4113 \item[{Parameters}] \leavevmode\begin{itemize}
4114 \item {}
4115 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to prepend
4116
4117 \item {}
4118 \sphinxstyleliteralstrong{\sphinxupquote{str}}\sphinxstyleliteralstrong{\sphinxupquote{ or }}\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the value(s) to prepend to key
4119
4120 \item {}
4121 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
4122
4123 \end{itemize}
4124
4125 \end{description}\end{quote}
4126
4127 \end{fulllineitems}
4128
4129 \index{prepend\_value() (src.fileEnviron.FileEnviron method)}
4130
4131 \begin{fulllineitems}
4132 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.prepend_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepend\_value}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
4133 prepend value to key using sep
4134 \begin{quote}\begin{description}
4135 \item[{Parameters}] \leavevmode\begin{itemize}
4136 \item {}
4137 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to prepend
4138
4139 \item {}
4140 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to prepend to key
4141
4142 \item {}
4143 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
4144
4145 \end{itemize}
4146
4147 \end{description}\end{quote}
4148
4149 \end{fulllineitems}
4150
4151 \index{set() (src.fileEnviron.FileEnviron method)}
4152
4153 \begin{fulllineitems}
4154 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.set}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set}}}{\emph{key}, \emph{value}}{}
4155 Set the environment variable ‘key’ to value ‘value’
4156 \begin{quote}\begin{description}
4157 \item[{Parameters}] \leavevmode\begin{itemize}
4158 \item {}
4159 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the environment variable to set
4160
4161 \item {}
4162 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value
4163
4164 \end{itemize}
4165
4166 \end{description}\end{quote}
4167
4168 \end{fulllineitems}
4169
4170
4171 \end{fulllineitems}
4172
4173 \index{LauncherFileEnviron (class in src.fileEnviron)}
4174
4175 \begin{fulllineitems}
4176 \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}}{}
4177 Class to generate a launcher file script
4178 (in python syntax) SalomeContext API
4179 \index{add() (src.fileEnviron.LauncherFileEnviron method)}
4180
4181 \begin{fulllineitems}
4182 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add}}}{\emph{key}, \emph{value}}{}
4183 prepend value to key using sep
4184 \begin{quote}\begin{description}
4185 \item[{Parameters}] \leavevmode\begin{itemize}
4186 \item {}
4187 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the environment variable to prepend
4188
4189 \item {}
4190 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to prepend to key
4191
4192 \end{itemize}
4193
4194 \end{description}\end{quote}
4195
4196 \end{fulllineitems}
4197
4198 \index{add\_comment() (src.fileEnviron.LauncherFileEnviron method)}
4199
4200 \begin{fulllineitems}
4201 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add_comment}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_comment}}}{\emph{comment}}{}
4202 \end{fulllineitems}
4203
4204 \index{add\_echo() (src.fileEnviron.LauncherFileEnviron method)}
4205
4206 \begin{fulllineitems}
4207 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add_echo}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_echo}}}{\emph{text}}{}
4208 Add a comment
4209 \begin{quote}\begin{description}
4210 \item[{Parameters}] \leavevmode
4211 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{text}}) \textendash{} the comment to add
4212
4213 \end{description}\end{quote}
4214
4215 \end{fulllineitems}
4216
4217 \index{add\_line() (src.fileEnviron.LauncherFileEnviron method)}
4218
4219 \begin{fulllineitems}
4220 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add_line}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_line}}}{\emph{number}}{}
4221 Add some empty lines in the launcher file
4222 \begin{quote}\begin{description}
4223 \item[{Parameters}] \leavevmode
4224 \sphinxstyleliteralstrong{\sphinxupquote{int}} (\sphinxstyleliteralemphasis{\sphinxupquote{number}}) \textendash{} the number of lines to add
4225
4226 \end{description}\end{quote}
4227
4228 \end{fulllineitems}
4229
4230 \index{add\_warning() (src.fileEnviron.LauncherFileEnviron method)}
4231
4232 \begin{fulllineitems}
4233 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add_warning}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_warning}}}{\emph{warning}}{}
4234 Add a warning
4235 \begin{quote}\begin{description}
4236 \item[{Parameters}] \leavevmode
4237 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{text}}) \textendash{} the warning to add
4238
4239 \end{description}\end{quote}
4240
4241 \end{fulllineitems}
4242
4243 \index{append() (src.fileEnviron.LauncherFileEnviron method)}
4244
4245 \begin{fulllineitems}
4246 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.append}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
4247 Same as append\_value but the value argument can be a list
4248 \begin{quote}\begin{description}
4249 \item[{Parameters}] \leavevmode\begin{itemize}
4250 \item {}
4251 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to append
4252
4253 \item {}
4254 \sphinxstyleliteralstrong{\sphinxupquote{str}}\sphinxstyleliteralstrong{\sphinxupquote{ or }}\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the value(s) to append to key
4255
4256 \item {}
4257 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
4258
4259 \end{itemize}
4260
4261 \end{description}\end{quote}
4262
4263 \end{fulllineitems}
4264
4265 \index{append\_value() (src.fileEnviron.LauncherFileEnviron method)}
4266
4267 \begin{fulllineitems}
4268 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.append_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append\_value}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
4269 append value to key using sep
4270 \begin{quote}\begin{description}
4271 \item[{Parameters}] \leavevmode\begin{itemize}
4272 \item {}
4273 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to append
4274
4275 \item {}
4276 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to append to key
4277
4278 \item {}
4279 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
4280
4281 \end{itemize}
4282
4283 \end{description}\end{quote}
4284
4285 \end{fulllineitems}
4286
4287 \index{change\_to\_launcher() (src.fileEnviron.LauncherFileEnviron method)}
4288
4289 \begin{fulllineitems}
4290 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.change_to_launcher}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{change\_to\_launcher}}}{\emph{value}}{}
4291 \end{fulllineitems}
4292
4293 \index{command\_value() (src.fileEnviron.LauncherFileEnviron method)}
4294
4295 \begin{fulllineitems}
4296 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.command_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{command\_value}}}{\emph{key}, \emph{command}}{}
4297 Get the value given by the system command “command”
4298 and put it in the environment variable key.
4299 \begin{quote}\begin{description}
4300 \item[{Parameters}] \leavevmode\begin{itemize}
4301 \item {}
4302 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{command}}) \textendash{} the environment variable
4303
4304 \item {}
4305 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the command to execute
4306
4307 \end{itemize}
4308
4309 \end{description}\end{quote}
4310
4311 \end{fulllineitems}
4312
4313 \index{finish() (src.fileEnviron.LauncherFileEnviron method)}
4314
4315 \begin{fulllineitems}
4316 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.finish}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{finish}}}{\emph{required=True}}{}
4317 Add a final instruction in the out file (in case of file generation)
4318 In the particular launcher case, do nothing
4319 \begin{quote}\begin{description}
4320 \item[{Parameters}] \leavevmode
4321 \sphinxstyleliteralstrong{\sphinxupquote{bool}} (\sphinxstyleliteralemphasis{\sphinxupquote{required}}) \textendash{} Do nothing if required is False
4322
4323 \end{description}\end{quote}
4324
4325 \end{fulllineitems}
4326
4327 \index{get() (src.fileEnviron.LauncherFileEnviron method)}
4328
4329 \begin{fulllineitems}
4330 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.get}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get}}}{\emph{key}}{}
4331 Get the value of the environment variable “key”
4332 \begin{quote}\begin{description}
4333 \item[{Parameters}] \leavevmode
4334 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable
4335
4336 \end{description}\end{quote}
4337
4338 \end{fulllineitems}
4339
4340 \index{is\_defined() (src.fileEnviron.LauncherFileEnviron method)}
4341
4342 \begin{fulllineitems}
4343 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.is_defined}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{is\_defined}}}{\emph{key}}{}
4344 Check if the key exists in the environment
4345 \begin{quote}\begin{description}
4346 \item[{Parameters}] \leavevmode
4347 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable to check
4348
4349 \end{description}\end{quote}
4350
4351 \end{fulllineitems}
4352
4353 \index{prepend() (src.fileEnviron.LauncherFileEnviron method)}
4354
4355 \begin{fulllineitems}
4356 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.prepend}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepend}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
4357 Same as prepend\_value but the value argument can be a list
4358 \begin{quote}\begin{description}
4359 \item[{Parameters}] \leavevmode\begin{itemize}
4360 \item {}
4361 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to prepend
4362
4363 \item {}
4364 \sphinxstyleliteralstrong{\sphinxupquote{str}}\sphinxstyleliteralstrong{\sphinxupquote{ or }}\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the value(s) to prepend to key
4365
4366 \item {}
4367 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
4368
4369 \end{itemize}
4370
4371 \end{description}\end{quote}
4372
4373 \end{fulllineitems}
4374
4375 \index{prepend\_value() (src.fileEnviron.LauncherFileEnviron method)}
4376
4377 \begin{fulllineitems}
4378 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.prepend_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepend\_value}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
4379 prepend value to key using sep
4380 \begin{quote}\begin{description}
4381 \item[{Parameters}] \leavevmode\begin{itemize}
4382 \item {}
4383 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to prepend
4384
4385 \item {}
4386 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to prepend to key
4387
4388 \item {}
4389 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
4390
4391 \end{itemize}
4392
4393 \end{description}\end{quote}
4394
4395 \end{fulllineitems}
4396
4397 \index{set() (src.fileEnviron.LauncherFileEnviron method)}
4398
4399 \begin{fulllineitems}
4400 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.set}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set}}}{\emph{key}, \emph{value}}{}
4401 Set the environment variable “key” to value “value”
4402 \begin{quote}\begin{description}
4403 \item[{Parameters}] \leavevmode\begin{itemize}
4404 \item {}
4405 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the environment variable to set
4406
4407 \item {}
4408 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value
4409
4410 \end{itemize}
4411
4412 \end{description}\end{quote}
4413
4414 \end{fulllineitems}
4415
4416
4417 \end{fulllineitems}
4418
4419 \index{ScreenEnviron (class in src.fileEnviron)}
4420
4421 \begin{fulllineitems}
4422 \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}}{}
4423 Bases: {\hyperref[\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.fileEnviron.FileEnviron}}}}} (\autopageref*{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron}})
4424 \index{add\_comment() (src.fileEnviron.ScreenEnviron method)}
4425
4426 \begin{fulllineitems}
4427 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.add_comment}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_comment}}}{\emph{comment}}{}
4428 Add a comment in the shell file
4429 \begin{quote}\begin{description}
4430 \item[{Parameters}] \leavevmode
4431 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{comment}}) \textendash{} the comment to add
4432
4433 \end{description}\end{quote}
4434
4435 \end{fulllineitems}
4436
4437 \index{add\_echo() (src.fileEnviron.ScreenEnviron method)}
4438
4439 \begin{fulllineitems}
4440 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.add_echo}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_echo}}}{\emph{text}}{}
4441 Add a “echo” in the shell file
4442 \begin{quote}\begin{description}
4443 \item[{Parameters}] \leavevmode
4444 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{text}}) \textendash{} the text to echo
4445
4446 \end{description}\end{quote}
4447
4448 \end{fulllineitems}
4449
4450 \index{add\_line() (src.fileEnviron.ScreenEnviron method)}
4451
4452 \begin{fulllineitems}
4453 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.add_line}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_line}}}{\emph{number}}{}
4454 Add some empty lines in the shell file
4455 \begin{quote}\begin{description}
4456 \item[{Parameters}] \leavevmode
4457 \sphinxstyleliteralstrong{\sphinxupquote{int}} (\sphinxstyleliteralemphasis{\sphinxupquote{number}}) \textendash{} the number of lines to add
4458
4459 \end{description}\end{quote}
4460
4461 \end{fulllineitems}
4462
4463 \index{add\_warning() (src.fileEnviron.ScreenEnviron method)}
4464
4465 \begin{fulllineitems}
4466 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.add_warning}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_warning}}}{\emph{warning}}{}
4467 Add a warning “echo” in the shell file
4468 \begin{quote}\begin{description}
4469 \item[{Parameters}] \leavevmode
4470 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{warning}}) \textendash{} the text to echo
4471
4472 \end{description}\end{quote}
4473
4474 \end{fulllineitems}
4475
4476 \index{append() (src.fileEnviron.ScreenEnviron method)}
4477
4478 \begin{fulllineitems}
4479 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.append}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append}}}{\emph{name}, \emph{value}, \emph{sep=':'}}{}
4480 Same as append\_value but the value argument can be a list
4481 \begin{quote}\begin{description}
4482 \item[{Parameters}] \leavevmode\begin{itemize}
4483 \item {}
4484 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to append
4485
4486 \item {}
4487 \sphinxstyleliteralstrong{\sphinxupquote{str}}\sphinxstyleliteralstrong{\sphinxupquote{ or }}\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the value(s) to append to key
4488
4489 \item {}
4490 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
4491
4492 \end{itemize}
4493
4494 \end{description}\end{quote}
4495
4496 \end{fulllineitems}
4497
4498 \index{command\_value() (src.fileEnviron.ScreenEnviron method)}
4499
4500 \begin{fulllineitems}
4501 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.command_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{command\_value}}}{\emph{key}, \emph{command}}{}
4502 Get the value given by the system command “command”
4503 and put it in the environment variable key.
4504 Has to be overwritten in the derived classes
4505 This can be seen as a virtual method
4506 \begin{quote}\begin{description}
4507 \item[{Parameters}] \leavevmode\begin{itemize}
4508 \item {}
4509 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{command}}) \textendash{} the environment variable
4510
4511 \item {}
4512 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the command to execute
4513
4514 \end{itemize}
4515
4516 \end{description}\end{quote}
4517
4518 \end{fulllineitems}
4519
4520 \index{get() (src.fileEnviron.ScreenEnviron method)}
4521
4522 \begin{fulllineitems}
4523 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.get}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get}}}{\emph{name}}{}
4524 Get the value of the environment variable “key”
4525 \begin{quote}\begin{description}
4526 \item[{Parameters}] \leavevmode
4527 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable
4528
4529 \end{description}\end{quote}
4530
4531 \end{fulllineitems}
4532
4533 \index{is\_defined() (src.fileEnviron.ScreenEnviron method)}
4534
4535 \begin{fulllineitems}
4536 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.is_defined}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{is\_defined}}}{\emph{name}}{}
4537 Check if the key exists in the environment
4538 \begin{quote}\begin{description}
4539 \item[{Parameters}] \leavevmode
4540 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable to check
4541
4542 \end{description}\end{quote}
4543
4544 \end{fulllineitems}
4545
4546 \index{prepend() (src.fileEnviron.ScreenEnviron method)}
4547
4548 \begin{fulllineitems}
4549 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.prepend}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepend}}}{\emph{name}, \emph{value}, \emph{sep=':'}}{}
4550 Same as prepend\_value but the value argument can be a list
4551 \begin{quote}\begin{description}
4552 \item[{Parameters}] \leavevmode\begin{itemize}
4553 \item {}
4554 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to prepend
4555
4556 \item {}
4557 \sphinxstyleliteralstrong{\sphinxupquote{str}}\sphinxstyleliteralstrong{\sphinxupquote{ or }}\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the value(s) to prepend to key
4558
4559 \item {}
4560 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string
4561
4562 \end{itemize}
4563
4564 \end{description}\end{quote}
4565
4566 \end{fulllineitems}
4567
4568 \index{run\_env\_script() (src.fileEnviron.ScreenEnviron method)}
4569
4570 \begin{fulllineitems}
4571 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.run_env_script}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run\_env\_script}}}{\emph{module}, \emph{script}}{}
4572 \end{fulllineitems}
4573
4574 \index{set() (src.fileEnviron.ScreenEnviron method)}
4575
4576 \begin{fulllineitems}
4577 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.set}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set}}}{\emph{name}, \emph{value}}{}
4578 Set the environment variable ‘key’ to value ‘value’
4579 \begin{quote}\begin{description}
4580 \item[{Parameters}] \leavevmode\begin{itemize}
4581 \item {}
4582 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the environment variable to set
4583
4584 \item {}
4585 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value
4586
4587 \end{itemize}
4588
4589 \end{description}\end{quote}
4590
4591 \end{fulllineitems}
4592
4593 \index{write() (src.fileEnviron.ScreenEnviron method)}
4594
4595 \begin{fulllineitems}
4596 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.write}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write}}}{\emph{command}, \emph{name}, \emph{value}, \emph{sign='='}}{}
4597 \end{fulllineitems}
4598
4599
4600 \end{fulllineitems}
4601
4602 \index{get\_file\_environ() (in module src.fileEnviron)}
4603
4604 \begin{fulllineitems}
4605 \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}}{}
4606 Instantiate correct FileEnvironment sub-class.
4607 \begin{quote}\begin{description}
4608 \item[{Parameters}] \leavevmode\begin{itemize}
4609 \item {}
4610 \sphinxstyleliteralstrong{\sphinxupquote{file}} (\sphinxstyleliteralemphasis{\sphinxupquote{output}}) \textendash{} the output file stream.
4611
4612 \item {}
4613 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{shell}}) \textendash{} the type of shell syntax to use.
4614
4615 \item {}
4616 \sphinxstyleliteralstrong{\sphinxupquote{dict}} (\sphinxstyleliteralemphasis{\sphinxupquote{environ}}) \textendash{} a potential additional environment.
4617
4618 \end{itemize}
4619
4620 \end{description}\end{quote}
4621
4622 \end{fulllineitems}
4623
4624 \index{special\_path\_separator() (in module src.fileEnviron)}
4625
4626 \begin{fulllineitems}
4627 \phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.special_path_separator}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.fileEnviron.}}\sphinxbfcode{\sphinxupquote{special\_path\_separator}}}{\emph{name}}{}
4628 TCLLIBPATH, TKLIBPATH, PV\_PLUGIN\_PATH environments variables need
4629 some exotic path separator.
4630 This function gives the separator regarding the name of the variable
4631 to append or prepend.
4632 \begin{quote}\begin{description}
4633 \item[{Parameters}] \leavevmode
4634 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{name}}) \textendash{} The name of the variable to find the separator
4635
4636 \end{description}\end{quote}
4637
4638 \end{fulllineitems}
4639
4640
4641
4642 \subsubsection{src.fork module}
4643 \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)}
4644
4645 \begin{fulllineitems}
4646 \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}}{}
4647 \end{fulllineitems}
4648
4649 \index{batch\_salome() (in module src.fork)}
4650
4651 \begin{fulllineitems}
4652 \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}}{}
4653 \end{fulllineitems}
4654
4655 \index{launch\_command() (in module src.fork)}
4656
4657 \begin{fulllineitems}
4658 \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}}{}
4659 \end{fulllineitems}
4660
4661 \index{show\_progress() (in module src.fork)}
4662
4663 \begin{fulllineitems}
4664 \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=''}}{}
4665 shortcut function to display the progression
4666 \begin{quote}\begin{description}
4667 \item[{Parameters}] \leavevmode\begin{itemize}
4668 \item {}
4669 \sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logging instance
4670
4671 \item {}
4672 \sphinxstyleliteralstrong{\sphinxupquote{int}} (\sphinxstyleliteralemphasis{\sphinxupquote{delai}}) \textendash{} the number to display
4673
4674 \item {}
4675 \sphinxstyleliteralstrong{\sphinxupquote{int}} \textendash{} the number max
4676
4677 \item {}
4678 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{ss}}) \textendash{} the string to display
4679
4680 \end{itemize}
4681
4682 \end{description}\end{quote}
4683
4684 \end{fulllineitems}
4685
4686 \index{write\_back() (in module src.fork)}
4687
4688 \begin{fulllineitems}
4689 \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}}{}
4690 shortcut function to write at the begin of the line
4691 \begin{quote}\begin{description}
4692 \item[{Parameters}] \leavevmode\begin{itemize}
4693 \item {}
4694 \sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logging instance
4695
4696 \item {}
4697 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{message}}) \textendash{} the text to display
4698
4699 \item {}
4700 \sphinxstyleliteralstrong{\sphinxupquote{int}} (\sphinxstyleliteralemphasis{\sphinxupquote{level}}) \textendash{} the level of verbosity
4701
4702 \end{itemize}
4703
4704 \end{description}\end{quote}
4705
4706 \end{fulllineitems}
4707
4708
4709
4710 \subsubsection{src.logger module}
4711 \label{\detokenize{commands/apidoc/src:module-src.logger}}\label{\detokenize{commands/apidoc/src:src-logger-module}}\index{src.logger (module)}
4712 Implements the classes and method relative to the logging
4713 \index{Logger (class in src.logger)}
4714
4715 \begin{fulllineitems}
4716 \phantomsection\label{\detokenize{commands/apidoc/src:src.logger.Logger}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.logger.}}\sphinxbfcode{\sphinxupquote{Logger}}}{\emph{config=None}, \emph{silent\_sysstd=False}, \emph{all\_in\_terminal=False}, \emph{micro\_command=False}}{}
4717 Bases: \sphinxcode{\sphinxupquote{object}}
4718
4719 Class to handle log mechanism.
4720 \index{add\_link() (src.logger.Logger method)}
4721
4722 \begin{fulllineitems}
4723 \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}}{}
4724 Add a link to another log file.
4725 \begin{quote}\begin{description}
4726 \item[{Parameters}] \leavevmode\begin{itemize}
4727 \item {}
4728 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{command\_res}}) \textendash{} The file name of the link.
4729
4730 \item {}
4731 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The name of the command linked.
4732
4733 \item {}
4734 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The result of the command linked. “0” or “1”
4735
4736 \end{itemize}
4737
4738 \item[{Parma full\_launched\_command str}] \leavevmode
4739 The full lanch command
4740 (“sat command …”)
4741
4742 \end{description}\end{quote}
4743
4744 \end{fulllineitems}
4745
4746 \index{end\_write() (src.logger.Logger method)}
4747
4748 \begin{fulllineitems}
4749 \phantomsection\label{\detokenize{commands/apidoc/src:src.logger.Logger.end_write}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{end\_write}}}{\emph{attribute}}{}
4750 Called just after command end: Put all fields
4751 corresponding to the command end context (time).
4752 Write the log xml file on the hard drive.
4753 And display the command to launch to get the log
4754 \begin{quote}\begin{description}
4755 \item[{Parameters}] \leavevmode
4756 \sphinxstyleliteralstrong{\sphinxupquote{dict}} (\sphinxstyleliteralemphasis{\sphinxupquote{attribute}}) \textendash{} the attribute to add to the node “Site”.
4757
4758 \end{description}\end{quote}
4759
4760 \end{fulllineitems}
4761
4762 \index{error() (src.logger.Logger method)}
4763
4764 \begin{fulllineitems}
4765 \phantomsection\label{\detokenize{commands/apidoc/src:src.logger.Logger.error}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{error}}}{\emph{message}}{}
4766 Print an error.
4767 \begin{quote}\begin{description}
4768 \item[{Parameters}] \leavevmode
4769 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{message}}) \textendash{} The message to print.
4770
4771 \end{description}\end{quote}
4772
4773 \end{fulllineitems}
4774
4775 \index{flush() (src.logger.Logger method)}
4776
4777 \begin{fulllineitems}
4778 \phantomsection\label{\detokenize{commands/apidoc/src:src.logger.Logger.flush}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{flush}}}{}{}
4779 Flush terminal
4780
4781 \end{fulllineitems}
4782
4783 \index{put\_initial\_xml\_fields() (src.logger.Logger method)}
4784
4785 \begin{fulllineitems}
4786 \phantomsection\label{\detokenize{commands/apidoc/src:src.logger.Logger.put_initial_xml_fields}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{put\_initial\_xml\_fields}}}{}{}
4787 Called at class initialization: Put all fields
4788 corresponding to the command context (user, time, …)
4789
4790 \end{fulllineitems}
4791
4792 \index{write() (src.logger.Logger method)}
4793
4794 \begin{fulllineitems}
4795 \phantomsection\label{\detokenize{commands/apidoc/src:src.logger.Logger.write}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write}}}{\emph{message}, \emph{level=None}, \emph{screenOnly=False}}{}
4796 function used in the commands
4797 to print in the terminal and the log file.
4798 \begin{quote}\begin{description}
4799 \item[{Parameters}] \leavevmode\begin{itemize}
4800 \item {}
4801 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{message}}) \textendash{} The message to print.
4802
4803 \item {}
4804 \sphinxstyleliteralstrong{\sphinxupquote{int}} (\sphinxstyleliteralemphasis{\sphinxupquote{level}}) \textendash{} The output level corresponding
4805 to the message 0 \textless{} level \textless{} 6.
4806
4807 \item {}
4808 \sphinxstyleliteralstrong{\sphinxupquote{boolean}} (\sphinxstyleliteralemphasis{\sphinxupquote{screenOnly}}) \textendash{} if True, do not write in log file.
4809
4810 \end{itemize}
4811
4812 \end{description}\end{quote}
4813
4814 \end{fulllineitems}
4815
4816
4817 \end{fulllineitems}
4818
4819 \index{date\_to\_datetime() (in module src.logger)}
4820
4821 \begin{fulllineitems}
4822 \phantomsection\label{\detokenize{commands/apidoc/src:src.logger.date_to_datetime}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.logger.}}\sphinxbfcode{\sphinxupquote{date\_to\_datetime}}}{\emph{date}}{}
4823 From a string date in format YYYYMMDD\_HHMMSS
4824 returns list year, mon, day, hour, minutes, seconds
4825 \begin{quote}\begin{description}
4826 \item[{Parameters}] \leavevmode
4827 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{date}}) \textendash{} The date in format YYYYMMDD\_HHMMSS
4828
4829 \item[{Returns}] \leavevmode
4830 the same date and time in separate variables.
4831
4832 \item[{Return type}] \leavevmode
4833 (str,str,str,str,str,str)
4834
4835 \end{description}\end{quote}
4836
4837 \end{fulllineitems}
4838
4839 \index{getCurrentLogger() (in module src.logger)}
4840
4841 \begin{fulllineitems}
4842 \phantomsection\label{\detokenize{commands/apidoc/src:src.logger.getCurrentLogger}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.logger.}}\sphinxbfcode{\sphinxupquote{getCurrentLogger}}}{}{}
4843 get current logging logger, set as DefaultLogger if not set yet
4844
4845 \end{fulllineitems}
4846
4847 \index{getDefaultLogger() (in module src.logger)}
4848
4849 \begin{fulllineitems}
4850 \phantomsection\label{\detokenize{commands/apidoc/src:src.logger.getDefaultLogger}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.logger.}}\sphinxbfcode{\sphinxupquote{getDefaultLogger}}}{}{}
4851 get simple logging logger DefaultLogger, set it as current
4852
4853 \end{fulllineitems}
4854
4855 \index{getUnittestLogger() (in module src.logger)}
4856
4857 \begin{fulllineitems}
4858 \phantomsection\label{\detokenize{commands/apidoc/src:src.logger.getUnittestLogger}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.logger.}}\sphinxbfcode{\sphinxupquote{getUnittestLogger}}}{}{}
4859 get simple logging logger UnittestLogger, set it as current
4860
4861 \end{fulllineitems}
4862
4863 \index{isCurrentLoggerUnittest() (in module src.logger)}
4864
4865 \begin{fulllineitems}
4866 \phantomsection\label{\detokenize{commands/apidoc/src:src.logger.isCurrentLoggerUnittest}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.logger.}}\sphinxbfcode{\sphinxupquote{isCurrentLoggerUnittest}}}{}{}
4867 \end{fulllineitems}
4868
4869 \index{list\_log\_file() (in module src.logger)}
4870
4871 \begin{fulllineitems}
4872 \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}}{}
4873 Find all files corresponding to expression in dirPath
4874 \begin{quote}\begin{description}
4875 \item[{Parameters}] \leavevmode\begin{itemize}
4876 \item {}
4877 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{expression}}) \textendash{} the directory where to search the files
4878
4879 \item {}
4880 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the regular expression of files to find
4881
4882 \end{itemize}
4883
4884 \item[{Returns}] \leavevmode
4885 the list of files path and informations about it
4886
4887 \item[{Return type}] \leavevmode
4888 list
4889
4890 \end{description}\end{quote}
4891
4892 \end{fulllineitems}
4893
4894 \index{sendMessageToCurrentLogger() (in module src.logger)}
4895
4896 \begin{fulllineitems}
4897 \phantomsection\label{\detokenize{commands/apidoc/src:src.logger.sendMessageToCurrentLogger}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.logger.}}\sphinxbfcode{\sphinxupquote{sendMessageToCurrentLogger}}}{\emph{message}, \emph{level}}{}
4898 assume relay from obsolescent
4899 logger.write(msg, 1/2/3…) to future
4900 logging.critical/warning/info…(msg) (as logging package tips)
4901
4902 \end{fulllineitems}
4903
4904 \index{setCurrentLogger() (in module src.logger)}
4905
4906 \begin{fulllineitems}
4907 \phantomsection\label{\detokenize{commands/apidoc/src:src.logger.setCurrentLogger}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.logger.}}\sphinxbfcode{\sphinxupquote{setCurrentLogger}}}{\emph{logger}}{}
4908 temporary send all in stdout as simple logging logger
4909
4910 \end{fulllineitems}
4911
4912 \index{show\_command\_log() (in module src.logger)}
4913
4914 \begin{fulllineitems}
4915 \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}}{}
4916 Used in updateHatXml.
4917 Determine if the log xml file logFilePath
4918 has to be shown or not in the hat log.
4919 \begin{quote}\begin{description}
4920 \item[{Parameters}] \leavevmode\begin{itemize}
4921 \item {}
4922 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{application}}) \textendash{} the path to the command xml log file
4923
4924 \item {}
4925 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the command of the log file
4926
4927 \item {}
4928 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the application passed as parameter
4929 to the salomeTools command
4930
4931 \item {}
4932 \sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{notShownCommands}}) \textendash{} the list of commands
4933 that are not shown by default
4934
4935 \end{itemize}
4936
4937 \item[{Returns}] \leavevmode
4938 True if cmd is not in notShownCommands and the application
4939 in the log file corresponds to application
4940
4941 \item[{Return type}] \leavevmode
4942 boolean
4943
4944 \end{description}\end{quote}
4945
4946 \end{fulllineitems}
4947
4948 \index{timedelta\_total\_seconds() (in module src.logger)}
4949
4950 \begin{fulllineitems}
4951 \phantomsection\label{\detokenize{commands/apidoc/src:src.logger.timedelta_total_seconds}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.logger.}}\sphinxbfcode{\sphinxupquote{timedelta\_total\_seconds}}}{\emph{timedelta}}{}
4952 Replace total\_seconds from datetime module
4953 in order to be compatible with old python versions
4954 \begin{quote}\begin{description}
4955 \item[{Parameters}] \leavevmode
4956 \sphinxstyleliteralstrong{\sphinxupquote{datetime.timedelta}} (\sphinxstyleliteralemphasis{\sphinxupquote{timedelta}}) \textendash{} The delta between two dates
4957
4958 \item[{Returns}] \leavevmode
4959 The number of seconds corresponding to timedelta.
4960
4961 \item[{Return type}] \leavevmode
4962 float
4963
4964 \end{description}\end{quote}
4965
4966 \end{fulllineitems}
4967
4968 \index{update\_hat\_xml() (in module src.logger)}
4969
4970 \begin{fulllineitems}
4971 \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={[}{]}}}{}
4972 Create the xml file in logDir that contain all the xml file
4973 and have a name like YYYYMMDD\_HHMMSS\_namecmd.xml
4974 \begin{quote}\begin{description}
4975 \item[{Parameters}] \leavevmode\begin{itemize}
4976 \item {}
4977 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{application}}) \textendash{} the directory to parse
4978
4979 \item {}
4980 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the name of the application if there is any
4981
4982 \end{itemize}
4983
4984 \end{description}\end{quote}
4985
4986 \end{fulllineitems}
4987
4988
4989
4990 \subsubsection{src.options module}
4991 \label{\detokenize{commands/apidoc/src:module-src.options}}\label{\detokenize{commands/apidoc/src:src-options-module}}\index{src.options (module)}
4992 The Options class that manages the access to all options passed as
4993 parameters in salomeTools command lines
4994 \index{OptResult (class in src.options)}
4995
4996 \begin{fulllineitems}
4997 \phantomsection\label{\detokenize{commands/apidoc/src:src.options.OptResult}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.options.}}\sphinxbfcode{\sphinxupquote{OptResult}}}
4998 Bases: \sphinxcode{\sphinxupquote{object}}
4999
5000 An instance of this class will be the object manipulated
5001 in code of all salomeTools commands
5002 The aim of this class is to have an elegant syntax to manipulate the options.
5003
5004 \begin{DUlineblock}{0em}
5005 \item[] Example:
5006 \item[] \textgreater{}\textgreater{} options, remainderArgs = command.parseArguments(args)
5007 \item[] \textgreater{}\textgreater{} print(options.output\_verbose\_level)
5008 \item[] \textgreater{}\textgreater{} ‘INFO’
5009 \end{DUlineblock}
5010
5011 \end{fulllineitems}
5012
5013 \index{Options (class in src.options)}
5014
5015 \begin{fulllineitems}
5016 \phantomsection\label{\detokenize{commands/apidoc/src:src.options.Options}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.options.}}\sphinxbfcode{\sphinxupquote{Options}}}
5017 Bases: \sphinxcode{\sphinxupquote{object}}
5018
5019 Class to manage all salomeTools options
5020 \index{add\_option() (src.options.Options method)}
5021
5022 \begin{fulllineitems}
5023 \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}}{}
5024 Add an option to a command. It gets all attributes
5025 of an option and append it in the options field
5026 \begin{quote}\begin{description}
5027 \item[{Parameters}] \leavevmode\begin{itemize}
5028 \item {}
5029 \sphinxstyleliteralstrong{\sphinxupquote{shortName}} \textendash{} (str)
5030 The short name of the option (as ‘-l’ for level option).
5031
5032 \item {}
5033 \sphinxstyleliteralstrong{\sphinxupquote{longName}} \textendash{} (str)
5034 The long name of the option (as ‘\textendash{}level’ for level option).
5035
5036 \item {}
5037 \sphinxstyleliteralstrong{\sphinxupquote{optionType}} \textendash{} (str) The type of the option (ex “int”).
5038
5039 \item {}
5040 \sphinxstyleliteralstrong{\sphinxupquote{destName}} \textendash{} (str) The name that will be used in the code.
5041
5042 \item {}
5043 \sphinxstyleliteralstrong{\sphinxupquote{helpString}} \textendash{} (str)
5044 The text to display when user ask for help on a command.
5045
5046 \end{itemize}
5047
5048 \item[{Returns}] \leavevmode
5049 None
5050
5051 \end{description}\end{quote}
5052
5053 \end{fulllineitems}
5054
5055 \index{debug\_write() (src.options.Options method)}
5056
5057 \begin{fulllineitems}
5058 \phantomsection\label{\detokenize{commands/apidoc/src:src.options.Options.debug_write}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{debug\_write}}}{}{}
5059 \end{fulllineitems}
5060
5061 \index{filterLevel() (src.options.Options method)}
5062
5063 \begin{fulllineitems}
5064 \phantomsection\label{\detokenize{commands/apidoc/src:src.options.Options.filterLevel}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{filterLevel}}}{\emph{aLevel}}{}
5065 filter level logging values
5066
5067 \end{fulllineitems}
5068
5069 \index{filterList2() (src.options.Options method)}
5070
5071 \begin{fulllineitems}
5072 \phantomsection\label{\detokenize{commands/apidoc/src:src.options.Options.filterList2}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{filterList2}}}{\emph{aStr}}{}
5073 filter a list as ‘KERNEL,YACS,etc.’
5074
5075 \end{fulllineitems}
5076
5077 \index{getDetailOption() (src.options.Options method)}
5078
5079 \begin{fulllineitems}
5080 \phantomsection\label{\detokenize{commands/apidoc/src:src.options.Options.getDetailOption}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getDetailOption}}}{\emph{option}}{}
5081 for convenience
5082 \begin{quote}\begin{description}
5083 \item[{Returns}] \leavevmode
5084 (tuple) 4-elements (shortName, longName, optionType, helpString)
5085
5086 \end{description}\end{quote}
5087
5088 \end{fulllineitems}
5089
5090 \index{get\_help() (src.options.Options method)}
5091
5092 \begin{fulllineitems}
5093 \phantomsection\label{\detokenize{commands/apidoc/src:src.options.Options.get_help}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_help}}}{}{}
5094 Returns all options stored in self.options
5095 as help message colored string
5096 \begin{quote}\begin{description}
5097 \item[{Returns}] \leavevmode
5098 (str) colored string
5099
5100 \end{description}\end{quote}
5101
5102 \end{fulllineitems}
5103
5104 \index{indent() (src.options.Options method)}
5105
5106 \begin{fulllineitems}
5107 \phantomsection\label{\detokenize{commands/apidoc/src:src.options.Options.indent}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{indent}}}{\emph{text}, \emph{amount}, \emph{car=' '}}{}
5108 indent multi lines message
5109
5110 \end{fulllineitems}
5111
5112 \index{parse\_args() (src.options.Options method)}
5113
5114 \begin{fulllineitems}
5115 \phantomsection\label{\detokenize{commands/apidoc/src:src.options.Options.parse_args}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parse\_args}}}{\emph{argList=None}}{}
5116 Instantiates the class OptResult
5117 that gives access to all options in the code
5118 \begin{quote}\begin{description}
5119 \item[{Parameters}] \leavevmode
5120 \sphinxstyleliteralstrong{\sphinxupquote{argList}} \textendash{} (list) the raw list of arguments that were passed
5121
5122 \item[{Returns}] \leavevmode
5123 (OptResult, list) as (optResult, args)
5124 optResult is the option instance to manipulate in the code.
5125 args is the full raw list of passed options
5126
5127 \end{description}\end{quote}
5128
5129 \end{fulllineitems}
5130
5131
5132 \end{fulllineitems}
5133
5134
5135
5136 \subsubsection{src.printcolors module}
5137 \label{\detokenize{commands/apidoc/src:module-src.printcolors}}\label{\detokenize{commands/apidoc/src:src-printcolors-module}}\index{src.printcolors (module)}
5138 In this file is stored the mechanism that manage color prints in the terminal
5139 \index{cleancolor() (in module src.printcolors)}
5140
5141 \begin{fulllineitems}
5142 \phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.cleancolor}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{cleancolor}}}{\emph{message}}{}
5143 remove color from a colored text.
5144 \begin{quote}\begin{description}
5145 \item[{Parameters}] \leavevmode
5146 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{message}}) \textendash{} The text to be cleaned.
5147
5148 \item[{Returns}] \leavevmode
5149 The cleaned text.
5150
5151 \item[{Return type}] \leavevmode
5152 str
5153
5154 \end{description}\end{quote}
5155
5156 \end{fulllineitems}
5157
5158 \index{print\_color\_map() (in module src.printcolors)}
5159
5160 \begin{fulllineitems}
5161 \phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.print_color_map}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{print\_color\_map}}}{}{}
5162 This method prints the color map
5163
5164 \end{fulllineitems}
5165
5166 \index{print\_color\_range() (in module src.printcolors)}
5167
5168 \begin{fulllineitems}
5169 \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}}{}
5170 print possible range values for colors
5171 \begin{quote}\begin{description}
5172 \item[{Parameters}] \leavevmode\begin{itemize}
5173 \item {}
5174 \sphinxstyleliteralstrong{\sphinxupquote{int}} (\sphinxstyleliteralemphasis{\sphinxupquote{end}}) \textendash{} The smaller value.
5175
5176 \item {}
5177 \sphinxstyleliteralstrong{\sphinxupquote{int}} \textendash{} The bigger value.
5178
5179 \end{itemize}
5180
5181 \end{description}\end{quote}
5182
5183 \end{fulllineitems}
5184
5185 \index{print\_value() (in module src.printcolors)}
5186
5187 \begin{fulllineitems}
5188 \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=''}}{}
5189 shortcut method to print a label and a value with the info color
5190 \begin{quote}\begin{description}
5191 \item[{Parameters}] \leavevmode\begin{itemize}
5192 \item {}
5193 \sphinxstyleliteralstrong{\sphinxupquote{class logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} the logger instance.
5194
5195 \item {}
5196 \sphinxstyleliteralstrong{\sphinxupquote{int}} (\sphinxstyleliteralemphasis{\sphinxupquote{level}}) \textendash{} the label to print.
5197
5198 \item {}
5199 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{suffix}}) \textendash{} the value to print.
5200
5201 \item {}
5202 \sphinxstyleliteralstrong{\sphinxupquote{int}} \textendash{} the level of verboseness.
5203
5204 \item {}
5205 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the suffix to add at the end.
5206
5207 \end{itemize}
5208
5209 \end{description}\end{quote}
5210
5211 \end{fulllineitems}
5212
5213 \index{printc() (in module src.printcolors)}
5214
5215 \begin{fulllineitems}
5216 \phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.printc}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{printc}}}{\emph{txt}, \emph{code=''}}{}
5217 print a text with colors
5218 \begin{quote}\begin{description}
5219 \item[{Parameters}] \leavevmode\begin{itemize}
5220 \item {}
5221 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{code}}) \textendash{} The text to be printed.
5222
5223 \item {}
5224 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The color to use.
5225
5226 \end{itemize}
5227
5228 \item[{Returns}] \leavevmode
5229 The colored text.
5230
5231 \item[{Return type}] \leavevmode
5232 str
5233
5234 \end{description}\end{quote}
5235
5236 \end{fulllineitems}
5237
5238 \index{printcError() (in module src.printcolors)}
5239
5240 \begin{fulllineitems}
5241 \phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.printcError}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{printcError}}}{\emph{txt}}{}
5242 print a text error color
5243 \begin{quote}\begin{description}
5244 \item[{Parameters}] \leavevmode
5245 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{txt}}) \textendash{} The text to be printed.
5246
5247 \item[{Returns}] \leavevmode
5248 The colored text.
5249
5250 \item[{Return type}] \leavevmode
5251 str
5252
5253 \end{description}\end{quote}
5254
5255 \end{fulllineitems}
5256
5257 \index{printcHeader() (in module src.printcolors)}
5258
5259 \begin{fulllineitems}
5260 \phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.printcHeader}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{printcHeader}}}{\emph{txt}}{}
5261 print a text header color
5262 \begin{quote}\begin{description}
5263 \item[{Parameters}] \leavevmode
5264 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{txt}}) \textendash{} The text to be printed.
5265
5266 \item[{Returns}] \leavevmode
5267 The colored text.
5268
5269 \item[{Return type}] \leavevmode
5270 str
5271
5272 \end{description}\end{quote}
5273
5274 \end{fulllineitems}
5275
5276 \index{printcHighlight() (in module src.printcolors)}
5277
5278 \begin{fulllineitems}
5279 \phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.printcHighlight}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{printcHighlight}}}{\emph{txt}}{}
5280 print a text highlight color
5281 \begin{quote}\begin{description}
5282 \item[{Parameters}] \leavevmode
5283 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{txt}}) \textendash{} The text to be printed.
5284
5285 \item[{Returns}] \leavevmode
5286 The colored text.
5287
5288 \item[{Return type}] \leavevmode
5289 str
5290
5291 \end{description}\end{quote}
5292
5293 \end{fulllineitems}
5294
5295 \index{printcInfo() (in module src.printcolors)}
5296
5297 \begin{fulllineitems}
5298 \phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.printcInfo}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{printcInfo}}}{\emph{txt}}{}
5299 print a text info color
5300 \begin{quote}\begin{description}
5301 \item[{Parameters}] \leavevmode
5302 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{txt}}) \textendash{} The text to be printed.
5303
5304 \item[{Returns}] \leavevmode
5305 The colored text.
5306
5307 \item[{Return type}] \leavevmode
5308 str
5309
5310 \end{description}\end{quote}
5311
5312 \end{fulllineitems}
5313
5314 \index{printcLabel() (in module src.printcolors)}
5315
5316 \begin{fulllineitems}
5317 \phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.printcLabel}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{printcLabel}}}{\emph{txt}}{}
5318 print a text label color
5319 \begin{quote}\begin{description}
5320 \item[{Parameters}] \leavevmode
5321 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{txt}}) \textendash{} The text to be printed.
5322
5323 \item[{Returns}] \leavevmode
5324 The colored text.
5325
5326 \item[{Return type}] \leavevmode
5327 str
5328
5329 \end{description}\end{quote}
5330
5331 \end{fulllineitems}
5332
5333 \index{printcSuccess() (in module src.printcolors)}
5334
5335 \begin{fulllineitems}
5336 \phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.printcSuccess}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{printcSuccess}}}{\emph{txt}}{}
5337 print a text success color
5338 \begin{quote}\begin{description}
5339 \item[{Parameters}] \leavevmode
5340 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{txt}}) \textendash{} The text to be printed.
5341
5342 \item[{Returns}] \leavevmode
5343 The colored text.
5344
5345 \item[{Return type}] \leavevmode
5346 str
5347
5348 \end{description}\end{quote}
5349
5350 \end{fulllineitems}
5351
5352 \index{printcWarning() (in module src.printcolors)}
5353
5354 \begin{fulllineitems}
5355 \phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.printcWarning}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{printcWarning}}}{\emph{txt}}{}
5356 print a text warning color
5357 \begin{quote}\begin{description}
5358 \item[{Parameters}] \leavevmode
5359 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{txt}}) \textendash{} The text to be printed.
5360
5361 \item[{Returns}] \leavevmode
5362 The colored text.
5363
5364 \item[{Return type}] \leavevmode
5365 str
5366
5367 \end{description}\end{quote}
5368
5369 \end{fulllineitems}
5370
5371
5372
5373 \subsubsection{src.product module}
5374 \label{\detokenize{commands/apidoc/src:module-src.product}}\label{\detokenize{commands/apidoc/src:src-product-module}}\index{src.product (module)}
5375 In this file are implemented the methods
5376 relative to the product notion of salomeTools
5377 \index{check\_config\_exists() (in module src.product)}
5378
5379 \begin{fulllineitems}
5380 \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}}{}
5381 Verify that the installation directory of a product in a base exists
5382 Check all the config-\textless{}i\textgreater{} directory and verify the sat-config.pyconf file
5383 that is in it
5384 \begin{quote}\begin{description}
5385 \item[{Parameters}] \leavevmode\begin{itemize}
5386 \item {}
5387 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The global configuration
5388
5389 \item {}
5390 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{prod\_dir}}) \textendash{} The product installation directory path
5391 (without config-\textless{}i\textgreater{})
5392
5393 \item {}
5394 \sphinxstyleliteralstrong{\sphinxupquote{Config}} \textendash{} The configuration specific to
5395 the product
5396
5397 \end{itemize}
5398
5399 \item[{Returns}] \leavevmode
5400 True or false is the installation is found or not
5401 and if it is found, the path of the found installation
5402
5403 \item[{Return type}] \leavevmode
5404 (boolean, str)
5405
5406 \end{description}\end{quote}
5407
5408 \end{fulllineitems}
5409
5410 \index{check\_installation() (in module src.product)}
5411
5412 \begin{fulllineitems}
5413 \phantomsection\label{\detokenize{commands/apidoc/src:src.product.check_installation}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{check\_installation}}}{\emph{product\_info}}{}
5414 Verify if a product is well installed. Checks install directory presence
5415 and some additional files if it is defined in the config
5416 \begin{quote}\begin{description}
5417 \item[{Parameters}] \leavevmode
5418 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
5419 the product
5420
5421 \item[{Returns}] \leavevmode
5422 True if it is well installed
5423
5424 \item[{Return type}] \leavevmode
5425 boolean
5426
5427 \end{description}\end{quote}
5428
5429 \end{fulllineitems}
5430
5431 \index{check\_source() (in module src.product)}
5432
5433 \begin{fulllineitems}
5434 \phantomsection\label{\detokenize{commands/apidoc/src:src.product.check_source}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{check\_source}}}{\emph{product\_info}}{}
5435 Verify if a sources of product is preset. Checks source directory presence
5436 \begin{quote}\begin{description}
5437 \item[{Parameters}] \leavevmode
5438 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
5439 the product
5440
5441 \item[{Returns}] \leavevmode
5442 True if it is well installed
5443
5444 \item[{Return type}] \leavevmode
5445 boolean
5446
5447 \end{description}\end{quote}
5448
5449 \end{fulllineitems}
5450
5451 \index{get\_base\_install\_dir() (in module src.product)}
5452
5453 \begin{fulllineitems}
5454 \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}}{}
5455 Compute the installation directory of a product in base
5456 \begin{quote}\begin{description}
5457 \item[{Parameters}] \leavevmode\begin{itemize}
5458 \item {}
5459 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The global configuration
5460
5461 \item {}
5462 \sphinxstyleliteralstrong{\sphinxupquote{Config}} \textendash{} The configuration specific to
5463 the product
5464
5465 \item {}
5466 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{version}}) \textendash{} The version of the product
5467
5468 \end{itemize}
5469
5470 \item[{Returns}] \leavevmode
5471 The path of the product installation
5472
5473 \item[{Return type}] \leavevmode
5474 str
5475
5476 \end{description}\end{quote}
5477
5478 \end{fulllineitems}
5479
5480 \index{get\_install\_dir() (in module src.product)}
5481
5482 \begin{fulllineitems}
5483 \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}}{}
5484 Compute the installation directory of a given product
5485 \begin{quote}\begin{description}
5486 \item[{Parameters}] \leavevmode\begin{itemize}
5487 \item {}
5488 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The global configuration
5489
5490 \item {}
5491 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{version}}) \textendash{} This corresponds to the value given by user in its
5492 application.pyconf for the specific product. If “yes”, the
5493 user wants the product to be in base. If “no”, he wants the
5494 product to be in the application workdir
5495
5496 \item {}
5497 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The version of the product
5498
5499 \item {}
5500 \sphinxstyleliteralstrong{\sphinxupquote{Config}} \textendash{} The configuration specific to
5501 the product
5502
5503 \end{itemize}
5504
5505 \item[{Returns}] \leavevmode
5506 The path of the product installation
5507
5508 \item[{Return type}] \leavevmode
5509 str
5510
5511 \end{description}\end{quote}
5512
5513 \end{fulllineitems}
5514
5515 \index{get\_product\_components() (in module src.product)}
5516
5517 \begin{fulllineitems}
5518 \phantomsection\label{\detokenize{commands/apidoc/src:src.product.get_product_components}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{get\_product\_components}}}{\emph{product\_info}}{}
5519 Get the component list to generate with the product
5520 \begin{quote}\begin{description}
5521 \item[{Parameters}] \leavevmode
5522 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
5523 the product
5524
5525 \item[{Returns}] \leavevmode
5526 The list of names of the components
5527
5528 \item[{Return type}] \leavevmode
5529 List
5530
5531 \end{description}\end{quote}
5532
5533 \end{fulllineitems}
5534
5535 \index{get\_product\_config() (in module src.product)}
5536
5537 \begin{fulllineitems}
5538 \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}}{}
5539 Get the specific configuration of a product from the global configuration
5540 \begin{quote}\begin{description}
5541 \item[{Parameters}] \leavevmode\begin{itemize}
5542 \item {}
5543 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} The global configuration
5544
5545 \item {}
5546 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_name}}) \textendash{} The name of the product
5547
5548 \item {}
5549 \sphinxstyleliteralstrong{\sphinxupquote{boolean}} (\sphinxstyleliteralemphasis{\sphinxupquote{with\_install\_dir}}) \textendash{} If false, do not provide an install
5550 directory (at false only for internal use
5551 of the function check\_config\_exists)
5552
5553 \end{itemize}
5554
5555 \item[{Returns}] \leavevmode
5556 the specific configuration of the product
5557
5558 \item[{Return type}] \leavevmode
5559 {\hyperref[\detokenize{commands/apidoc/src:src.pyconf.Config}]{\sphinxcrossref{Config}}} (\autopageref*{\detokenize{commands/apidoc/src:src.pyconf.Config}})
5560
5561 \end{description}\end{quote}
5562
5563 \end{fulllineitems}
5564
5565 \index{get\_product\_dependencies() (in module src.product)}
5566
5567 \begin{fulllineitems}
5568 \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}}{}
5569 Get recursively the list of products that are
5570 in the product\_info dependencies
5571 \begin{quote}\begin{description}
5572 \item[{Parameters}] \leavevmode\begin{itemize}
5573 \item {}
5574 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The global configuration
5575
5576 \item {}
5577 \sphinxstyleliteralstrong{\sphinxupquote{Config}} \textendash{} The configuration specific to
5578 the product
5579
5580 \end{itemize}
5581
5582 \item[{Returns}] \leavevmode
5583 the list of products in dependence
5584
5585 \item[{Return type}] \leavevmode
5586 list
5587
5588 \end{description}\end{quote}
5589
5590 \end{fulllineitems}
5591
5592 \index{get\_product\_section() (in module src.product)}
5593
5594 \begin{fulllineitems}
5595 \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}}{}
5596 Get the product description from the configuration
5597 \begin{quote}\begin{description}
5598 \item[{Parameters}] \leavevmode\begin{itemize}
5599 \item {}
5600 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} The global configuration
5601
5602 \item {}
5603 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{section}}) \textendash{} The product name
5604
5605 \item {}
5606 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The version of the product
5607
5608 \item {}
5609 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The searched section (if not None, the section is
5610 explicitly given
5611
5612 \end{itemize}
5613
5614 \item[{Returns}] \leavevmode
5615 The product description
5616
5617 \item[{Return type}] \leavevmode
5618 {\hyperref[\detokenize{commands/apidoc/src:src.pyconf.Config}]{\sphinxcrossref{Config}}} (\autopageref*{\detokenize{commands/apidoc/src:src.pyconf.Config}})
5619
5620 \end{description}\end{quote}
5621
5622 \end{fulllineitems}
5623
5624 \index{get\_products\_infos() (in module src.product)}
5625
5626 \begin{fulllineitems}
5627 \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}}{}
5628 Get the specific configuration of a list of products
5629 \begin{quote}\begin{description}
5630 \item[{Parameters}] \leavevmode\begin{itemize}
5631 \item {}
5632 \sphinxstyleliteralstrong{\sphinxupquote{List}} (\sphinxstyleliteralemphasis{\sphinxupquote{lproducts}}) \textendash{} The list of product names
5633
5634 \item {}
5635 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} The global configuration
5636
5637 \end{itemize}
5638
5639 \item[{Returns}] \leavevmode
5640 the list of tuples
5641 (product name, specific configuration of the product)
5642
5643 \item[{Return type}] \leavevmode
5644 {[}(str, {\hyperref[\detokenize{commands/apidoc/src:src.pyconf.Config}]{\sphinxcrossref{Config}}} (\autopageref*{\detokenize{commands/apidoc/src:src.pyconf.Config}})){]}
5645
5646 \end{description}\end{quote}
5647
5648 \end{fulllineitems}
5649
5650 \index{product\_compiles() (in module src.product)}
5651
5652 \begin{fulllineitems}
5653 \phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_compiles}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_compiles}}}{\emph{product\_info}}{}
5654 Know if a product compiles or not
5655 (some products do not have a compilation procedure)
5656 \begin{quote}\begin{description}
5657 \item[{Parameters}] \leavevmode
5658 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
5659 the product
5660
5661 \item[{Returns}] \leavevmode
5662 True if the product compiles, else False
5663
5664 \item[{Return type}] \leavevmode
5665 boolean
5666
5667 \end{description}\end{quote}
5668
5669 \end{fulllineitems}
5670
5671 \index{product\_has\_env\_script() (in module src.product)}
5672
5673 \begin{fulllineitems}
5674 \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}}{}
5675 Know if a product has an environment script
5676 \begin{quote}\begin{description}
5677 \item[{Parameters}] \leavevmode
5678 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
5679 the product
5680
5681 \item[{Returns}] \leavevmode
5682 True if the product it has an environment script, else False
5683
5684 \item[{Return type}] \leavevmode
5685 boolean
5686
5687 \end{description}\end{quote}
5688
5689 \end{fulllineitems}
5690
5691 \index{product\_has\_logo() (in module src.product)}
5692
5693 \begin{fulllineitems}
5694 \phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_has_logo}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_has\_logo}}}{\emph{product\_info}}{}
5695 Know if a product has a logo (YACSGEN generate)
5696 \begin{quote}\begin{description}
5697 \item[{Parameters}] \leavevmode
5698 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
5699 the product
5700
5701 \item[{Returns}] \leavevmode
5702 The path of the logo if the product has a logo, else False
5703
5704 \item[{Return type}] \leavevmode
5705 Str
5706
5707 \end{description}\end{quote}
5708
5709 \end{fulllineitems}
5710
5711 \index{product\_has\_patches() (in module src.product)}
5712
5713 \begin{fulllineitems}
5714 \phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_has_patches}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_has\_patches}}}{\emph{product\_info}}{}
5715 Know if a product has one or more patches
5716 \begin{quote}\begin{description}
5717 \item[{Parameters}] \leavevmode
5718 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
5719 the product
5720
5721 \item[{Returns}] \leavevmode
5722 True if the product has one or more patches
5723
5724 \item[{Return type}] \leavevmode
5725 boolean
5726
5727 \end{description}\end{quote}
5728
5729 \end{fulllineitems}
5730
5731 \index{product\_has\_salome\_gui() (in module src.product)}
5732
5733 \begin{fulllineitems}
5734 \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}}{}
5735 Know if a product has a SALOME gui
5736 \begin{quote}\begin{description}
5737 \item[{Parameters}] \leavevmode
5738 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
5739 the product
5740
5741 \item[{Returns}] \leavevmode
5742 True if the product has a SALOME gui, else False
5743
5744 \item[{Return type}] \leavevmode
5745 Boolean
5746
5747 \end{description}\end{quote}
5748
5749 \end{fulllineitems}
5750
5751 \index{product\_has\_script() (in module src.product)}
5752
5753 \begin{fulllineitems}
5754 \phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_has_script}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_has\_script}}}{\emph{product\_info}}{}
5755 Know if a product has a compilation script
5756 \begin{quote}\begin{description}
5757 \item[{Parameters}] \leavevmode
5758 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
5759 the product
5760
5761 \item[{Returns}] \leavevmode
5762 True if the product it has a compilation script, else False
5763
5764 \item[{Return type}] \leavevmode
5765 boolean
5766
5767 \end{description}\end{quote}
5768
5769 \end{fulllineitems}
5770
5771 \index{product\_is\_autotools() (in module src.product)}
5772
5773 \begin{fulllineitems}
5774 \phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_autotools}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_autotools}}}{\emph{product\_info}}{}
5775 Know if a product is compiled using the autotools
5776 \begin{quote}\begin{description}
5777 \item[{Parameters}] \leavevmode
5778 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
5779 the product
5780
5781 \item[{Returns}] \leavevmode
5782 True if the product is autotools, else False
5783
5784 \item[{Return type}] \leavevmode
5785 boolean
5786
5787 \end{description}\end{quote}
5788
5789 \end{fulllineitems}
5790
5791 \index{product\_is\_cmake() (in module src.product)}
5792
5793 \begin{fulllineitems}
5794 \phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_cmake}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_cmake}}}{\emph{product\_info}}{}
5795 Know if a product is compiled using the cmake
5796 \begin{quote}\begin{description}
5797 \item[{Parameters}] \leavevmode
5798 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
5799 the product
5800
5801 \item[{Returns}] \leavevmode
5802 True if the product is cmake, else False
5803
5804 \item[{Return type}] \leavevmode
5805 boolean
5806
5807 \end{description}\end{quote}
5808
5809 \end{fulllineitems}
5810
5811 \index{product\_is\_cpp() (in module src.product)}
5812
5813 \begin{fulllineitems}
5814 \phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_cpp}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_cpp}}}{\emph{product\_info}}{}
5815 Know if a product is cpp
5816 \begin{quote}\begin{description}
5817 \item[{Parameters}] \leavevmode
5818 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
5819 the product
5820
5821 \item[{Returns}] \leavevmode
5822 True if the product is a cpp, else False
5823
5824 \item[{Return type}] \leavevmode
5825 boolean
5826
5827 \end{description}\end{quote}
5828
5829 \end{fulllineitems}
5830
5831 \index{product\_is\_debug() (in module src.product)}
5832
5833 \begin{fulllineitems}
5834 \phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_debug}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_debug}}}{\emph{product\_info}}{}
5835 Know if a product is in debug mode
5836 \begin{quote}\begin{description}
5837 \item[{Parameters}] \leavevmode
5838 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
5839 the product
5840
5841 \item[{Returns}] \leavevmode
5842 True if the product is in debug mode, else False
5843
5844 \item[{Return type}] \leavevmode
5845 boolean
5846
5847 \end{description}\end{quote}
5848
5849 \end{fulllineitems}
5850
5851 \index{product\_is\_dev() (in module src.product)}
5852
5853 \begin{fulllineitems}
5854 \phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_dev}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_dev}}}{\emph{product\_info}}{}
5855 Know if a product is in dev mode
5856 \begin{quote}\begin{description}
5857 \item[{Parameters}] \leavevmode
5858 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
5859 the product
5860
5861 \item[{Returns}] \leavevmode
5862 True if the product is in dev mode, else False
5863
5864 \item[{Return type}] \leavevmode
5865 boolean
5866
5867 \end{description}\end{quote}
5868
5869 \end{fulllineitems}
5870
5871 \index{product\_is\_fixed() (in module src.product)}
5872
5873 \begin{fulllineitems}
5874 \phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_fixed}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_fixed}}}{\emph{product\_info}}{}
5875 Know if a product is fixed
5876 \begin{quote}\begin{description}
5877 \item[{Parameters}] \leavevmode
5878 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
5879 the product
5880
5881 \item[{Returns}] \leavevmode
5882 True if the product is fixed, else False
5883
5884 \item[{Return type}] \leavevmode
5885 boolean
5886
5887 \end{description}\end{quote}
5888
5889 \end{fulllineitems}
5890
5891 \index{product\_is\_generated() (in module src.product)}
5892
5893 \begin{fulllineitems}
5894 \phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_generated}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_generated}}}{\emph{product\_info}}{}
5895 Know if a product is generated (YACSGEN)
5896 \begin{quote}\begin{description}
5897 \item[{Parameters}] \leavevmode
5898 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
5899 the product
5900
5901 \item[{Returns}] \leavevmode
5902 True if the product is generated
5903
5904 \item[{Return type}] \leavevmode
5905 boolean
5906
5907 \end{description}\end{quote}
5908
5909 \end{fulllineitems}
5910
5911 \index{product\_is\_mpi() (in module src.product)}
5912
5913 \begin{fulllineitems}
5914 \phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_mpi}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_mpi}}}{\emph{product\_info}}{}
5915 Know if a product has openmpi in its dependencies
5916 \begin{quote}\begin{description}
5917 \item[{Parameters}] \leavevmode
5918 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
5919 the product
5920
5921 \item[{Returns}] \leavevmode
5922 True if the product has openmpi inits dependencies
5923
5924 \item[{Return type}] \leavevmode
5925 boolean
5926
5927 \end{description}\end{quote}
5928
5929 \end{fulllineitems}
5930
5931 \index{product\_is\_native() (in module src.product)}
5932
5933 \begin{fulllineitems}
5934 \phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_native}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_native}}}{\emph{product\_info}}{}
5935 Know if a product is native
5936 \begin{quote}\begin{description}
5937 \item[{Parameters}] \leavevmode
5938 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
5939 the product
5940
5941 \item[{Returns}] \leavevmode
5942 True if the product is native, else False
5943
5944 \item[{Return type}] \leavevmode
5945 boolean
5946
5947 \end{description}\end{quote}
5948
5949 \end{fulllineitems}
5950
5951 \index{product\_is\_salome() (in module src.product)}
5952
5953 \begin{fulllineitems}
5954 \phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_salome}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_salome}}}{\emph{product\_info}}{}
5955 Know if a product is a SALOME module
5956 \begin{quote}\begin{description}
5957 \item[{Parameters}] \leavevmode
5958 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
5959 the product
5960
5961 \item[{Returns}] \leavevmode
5962 True if the product is a SALOME module, else False
5963
5964 \item[{Return type}] \leavevmode
5965 boolean
5966
5967 \end{description}\end{quote}
5968
5969 \end{fulllineitems}
5970
5971 \index{product\_is\_smesh\_plugin() (in module src.product)}
5972
5973 \begin{fulllineitems}
5974 \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}}{}
5975 Know if a product is a SMESH plugin
5976 \begin{quote}\begin{description}
5977 \item[{Parameters}] \leavevmode
5978 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
5979 the product
5980
5981 \item[{Returns}] \leavevmode
5982 True if the product is a SMESH plugin, else False
5983
5984 \item[{Return type}] \leavevmode
5985 boolean
5986
5987 \end{description}\end{quote}
5988
5989 \end{fulllineitems}
5990
5991 \index{product\_is\_vcs() (in module src.product)}
5992
5993 \begin{fulllineitems}
5994 \phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_vcs}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_vcs}}}{\emph{product\_info}}{}
5995 Know if a product is download using git, svn or cvs (not archive)
5996 \begin{quote}\begin{description}
5997 \item[{Parameters}] \leavevmode
5998 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
5999 the product
6000
6001 \item[{Returns}] \leavevmode
6002 True if the product is vcs, else False
6003
6004 \item[{Return type}] \leavevmode
6005 boolean
6006
6007 \end{description}\end{quote}
6008
6009 \end{fulllineitems}
6010
6011 \index{product\_is\_verbose() (in module src.product)}
6012
6013 \begin{fulllineitems}
6014 \phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_verbose}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_verbose}}}{\emph{product\_info}}{}
6015 Know if a product is in verbose mode
6016 \begin{quote}\begin{description}
6017 \item[{Parameters}] \leavevmode
6018 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to
6019 the product
6020
6021 \item[{Returns}] \leavevmode
6022 True if the product is in verbose mode, else False
6023
6024 \item[{Return type}] \leavevmode
6025 boolean
6026
6027 \end{description}\end{quote}
6028
6029 \end{fulllineitems}
6030
6031
6032
6033 \subsubsection{src.pyconf module}
6034 \label{\detokenize{commands/apidoc/src:src-pyconf-module}}\label{\detokenize{commands/apidoc/src:module-src.pyconf}}\index{src.pyconf (module)}
6035 This is a configuration module for Python.
6036
6037 This module should work under Python versions \textgreater{}= 2.2, and cannot be used with
6038 earlier versions since it uses new-style classes.
6039
6040 Development and testing has only been carried out (so far) on Python 2.3.4 and
6041 Python 2.4.2. See the test module (test\_config.py) included in the
6042 U\{distribution\textless{}\sphinxurl{http://www.red-dove.com/python\_config}.html\textbar{}\_blank\textgreater{}\} (follow the
6043 download link).
6044
6045 A simple example - with the example configuration file:
6046
6047 \fvset{hllines={, ,}}%
6048 \begin{sphinxVerbatim}[commandchars=\\\{\}]
6049 messages:
6050 [
6051   \PYGZob{}
6052     stream : {}`sys.stderr{}`
6053     message: \PYGZsq{}Welcome\PYGZsq{}
6054     name: \PYGZsq{}Harry\PYGZsq{}
6055   \PYGZcb{}
6056   \PYGZob{}
6057     stream : {}`sys.stdout{}`
6058     message: \PYGZsq{}Welkom\PYGZsq{}
6059     name: \PYGZsq{}Ruud\PYGZsq{}
6060   \PYGZcb{}
6061   \PYGZob{}
6062     stream : \PYGZdl{}messages[0].stream
6063     message: \PYGZsq{}Bienvenue\PYGZsq{}
6064     name: Yves
6065   \PYGZcb{}
6066 ]
6067 \end{sphinxVerbatim}
6068
6069 a program to read the configuration would be:
6070
6071 \fvset{hllines={, ,}}%
6072 \begin{sphinxVerbatim}[commandchars=\\\{\}]
6073 \PYG{k+kn}{from} \PYG{n+nn}{config} \PYG{k}{import} \PYG{n}{Config}
6074
6075 \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}{)}
6076 \PYG{n}{cfg} \PYG{o}{=} \PYG{n}{Config}\PYG{p}{(}\PYG{n}{f}\PYG{p}{)}
6077 \PYG{k}{for} \PYG{n}{m} \PYG{o+ow}{in} \PYG{n}{cfg}\PYG{o}{.}\PYG{n}{messages}\PYG{p}{:}
6078     \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}{)}
6079     \PYG{k}{try}\PYG{p}{:}
6080         \PYG{n+nb}{print} \PYG{o}{\PYGZgt{}\PYGZgt{}} \PYG{n}{m}\PYG{o}{.}\PYG{n}{stream}\PYG{p}{,} \PYG{n}{s}
6081     \PYG{k}{except} \PYG{n+ne}{IOError}\PYG{p}{,} \PYG{n}{e}\PYG{p}{:}
6082         \PYG{n+nb}{print} \PYG{n}{e}
6083 \end{sphinxVerbatim}
6084
6085 which, when run, would yield the console output:
6086
6087 \fvset{hllines={, ,}}%
6088 \begin{sphinxVerbatim}[commandchars=\\\{\}]
6089 \PYG{n}{Welcome}\PYG{p}{,} \PYG{n}{Harry}
6090 \PYG{n}{Welkom}\PYG{p}{,} \PYG{n}{Ruud}
6091 \PYG{n}{Bienvenue}\PYG{p}{,} \PYG{n}{Yves}
6092 \end{sphinxVerbatim}
6093
6094 See U\{this tutorial\textless{}\sphinxurl{http://www.red-dove.com/python\_config}.html\textbar{}\_blank\textgreater{}\} for more
6095 information.
6096
6097 \#modified for salomeTools
6098 @version: 0.3.7.1
6099
6100 @author: Vinay Sajip
6101
6102 @copyright: Copyright (C) 2004-2007 Vinay Sajip. All Rights Reserved.
6103
6104 @var streamOpener: The default stream opener. This is a factory function which
6105 takes a string (e.g. filename) and returns a stream suitable for reading. If
6106 unable to open the stream, an IOError exception should be thrown.
6107
6108 The default value of this variable is L\{defaultStreamOpener\}. For an example
6109 of how it’s used, see test\_config.py (search for streamOpener).
6110 \index{Config (class in src.pyconf)}
6111
6112 \begin{fulllineitems}
6113 \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}}{}
6114 Bases: {\hyperref[\detokenize{commands/apidoc/src:src.pyconf.Mapping}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.pyconf.Mapping}}}}} (\autopageref*{\detokenize{commands/apidoc/src:src.pyconf.Mapping}})
6115
6116 This class represents a configuration, and is the only one which clients
6117 need to interface to, under normal circumstances.
6118 \index{Config.Namespace (class in src.pyconf)}
6119
6120 \begin{fulllineitems}
6121 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Config.Namespace}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxbfcode{\sphinxupquote{Namespace}}}
6122 Bases: \sphinxcode{\sphinxupquote{object}}
6123
6124 This internal class is used for implementing default namespaces.
6125
6126 An instance acts as a namespace.
6127
6128 \end{fulllineitems}
6129
6130 \index{addNamespace() (src.pyconf.Config method)}
6131
6132 \begin{fulllineitems}
6133 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Config.addNamespace}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{addNamespace}}}{\emph{ns}, \emph{name=None}}{}
6134 Add a namespace to this configuration which can be used to evaluate
6135 (resolve) dotted-identifier expressions.
6136 @param ns: The namespace to be added.
6137 @type ns: A module or other namespace suitable for passing as an
6138 argument to vars().
6139 @param name: A name for the namespace, which, if specified, provides
6140 an additional level of indirection.
6141 @type name: str
6142
6143 \end{fulllineitems}
6144
6145 \index{getByPath() (src.pyconf.Config method)}
6146
6147 \begin{fulllineitems}
6148 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Config.getByPath}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getByPath}}}{\emph{path}}{}
6149 Obtain a value in the configuration via its path.
6150 @param path: The path of the required value
6151 @type path: str
6152 @return the value at the specified path.
6153 @rtype: any
6154 @raise ConfigError: If the path is invalid
6155
6156 \end{fulllineitems}
6157
6158 \index{load() (src.pyconf.Config method)}
6159
6160 \begin{fulllineitems}
6161 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Config.load}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{load}}}{\emph{stream}}{}
6162 Load the configuration from the specified stream. Multiple streams can
6163 be used to populate the same instance, as long as there are no
6164 clashing keys. The stream is closed.
6165 @param stream: A stream from which the configuration is read.
6166 @type stream: A read-only stream (file-like object).
6167 @raise ConfigError: if keys in the loaded configuration clash with
6168 existing keys.
6169 @raise ConfigFormatError: if there is a syntax error in the stream.
6170
6171 \end{fulllineitems}
6172
6173 \index{removeNamespace() (src.pyconf.Config method)}
6174
6175 \begin{fulllineitems}
6176 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Config.removeNamespace}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{removeNamespace}}}{\emph{ns}, \emph{name=None}}{}
6177 Remove a namespace added with L\{addNamespace\}.
6178 @param ns: The namespace to be removed.
6179 @param name: The name which was specified when L\{addNamespace\} was
6180 called.
6181 @type name: str
6182
6183 \end{fulllineitems}
6184
6185
6186 \end{fulllineitems}
6187
6188 \index{ConfigError}
6189
6190 \begin{fulllineitems}
6191 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigError}}\pysigline{\sphinxbfcode{\sphinxupquote{exception }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{ConfigError}}}
6192 Bases: \sphinxcode{\sphinxupquote{exceptions.Exception}}
6193
6194 This is the base class of exceptions raised by this module.
6195
6196 \end{fulllineitems}
6197
6198 \index{ConfigFormatError}
6199
6200 \begin{fulllineitems}
6201 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigFormatError}}\pysigline{\sphinxbfcode{\sphinxupquote{exception }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{ConfigFormatError}}}
6202 Bases: {\hyperref[\detokenize{commands/apidoc/src:src.pyconf.ConfigError}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.pyconf.ConfigError}}}}} (\autopageref*{\detokenize{commands/apidoc/src:src.pyconf.ConfigError}})
6203
6204 This is the base class of exceptions raised due to syntax errors in
6205 configurations.
6206
6207 \end{fulllineitems}
6208
6209 \index{ConfigInputStream (class in src.pyconf)}
6210
6211 \begin{fulllineitems}
6212 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigInputStream}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{ConfigInputStream}}}{\emph{stream}}{}
6213 Bases: \sphinxcode{\sphinxupquote{object}}
6214
6215 An input stream which can read either ANSI files with default encoding
6216 or Unicode files with BOMs.
6217
6218 Handles UTF-8, UTF-16LE, UTF-16BE. Could handle UTF-32 if Python had
6219 built-in support.
6220 \index{close() (src.pyconf.ConfigInputStream method)}
6221
6222 \begin{fulllineitems}
6223 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigInputStream.close}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{close}}}{}{}
6224 \end{fulllineitems}
6225
6226 \index{read() (src.pyconf.ConfigInputStream method)}
6227
6228 \begin{fulllineitems}
6229 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigInputStream.read}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{read}}}{\emph{size}}{}
6230 \end{fulllineitems}
6231
6232 \index{readline() (src.pyconf.ConfigInputStream method)}
6233
6234 \begin{fulllineitems}
6235 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigInputStream.readline}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{readline}}}{}{}
6236 \end{fulllineitems}
6237
6238
6239 \end{fulllineitems}
6240
6241 \index{ConfigList (class in src.pyconf)}
6242
6243 \begin{fulllineitems}
6244 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigList}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{ConfigList}}}
6245 Bases: \sphinxcode{\sphinxupquote{list}}
6246
6247 This class implements an ordered list of configurations and allows you
6248 to try getting the configuration from each entry in turn, returning
6249 the first successfully obtained value.
6250 \index{getByPath() (src.pyconf.ConfigList method)}
6251
6252 \begin{fulllineitems}
6253 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigList.getByPath}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getByPath}}}{\emph{path}}{}
6254 Obtain a value from the first configuration in the list which defines
6255 it.
6256
6257 @param path: The path of the value to retrieve.
6258 @type path: str
6259 @return: The value from the earliest configuration in the list which
6260 defines it.
6261 @rtype: any
6262 @raise ConfigError: If no configuration in the list has an entry with
6263 the specified path.
6264
6265 \end{fulllineitems}
6266
6267
6268 \end{fulllineitems}
6269
6270 \index{ConfigMerger (class in src.pyconf)}
6271
6272 \begin{fulllineitems}
6273 \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{}}}{}
6274 Bases: \sphinxcode{\sphinxupquote{object}}
6275
6276 This class is used for merging two configurations. If a key exists in the
6277 merge operand but not the merge target, then the entry is copied from the
6278 merge operand to the merge target. If a key exists in both configurations,
6279 then a resolver (a callable) is called to decide how to handle the
6280 conflict.
6281 \index{handleMismatch() (src.pyconf.ConfigMerger method)}
6282
6283 \begin{fulllineitems}
6284 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigMerger.handleMismatch}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{handleMismatch}}}{\emph{obj1}, \emph{obj2}}{}
6285 Handle a mismatch between two objects.
6286
6287 @param obj1: The object to merge into.
6288 @type obj1: any
6289 @param obj2: The object to merge.
6290 @type obj2: any
6291
6292 \end{fulllineitems}
6293
6294 \index{merge() (src.pyconf.ConfigMerger method)}
6295
6296 \begin{fulllineitems}
6297 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigMerger.merge}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{merge}}}{\emph{merged}, \emph{mergee}}{}
6298 Merge two configurations. The second configuration is unchanged,
6299 and the first is changed to reflect the results of the merge.
6300
6301 @param merged: The configuration to merge into.
6302 @type merged: L\{Config\}.
6303 @param mergee: The configuration to merge.
6304 @type mergee: L\{Config\}.
6305
6306 \end{fulllineitems}
6307
6308 \index{mergeMapping() (src.pyconf.ConfigMerger method)}
6309
6310 \begin{fulllineitems}
6311 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigMerger.mergeMapping}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{mergeMapping}}}{\emph{map1}, \emph{map2}}{}
6312 Merge two mappings recursively. The second mapping is unchanged,
6313 and the first is changed to reflect the results of the merge.
6314
6315 @param map1: The mapping to merge into.
6316 @type map1: L\{Mapping\}.
6317 @param map2: The mapping to merge.
6318 @type map2: L\{Mapping\}.
6319
6320 \end{fulllineitems}
6321
6322 \index{mergeSequence() (src.pyconf.ConfigMerger method)}
6323
6324 \begin{fulllineitems}
6325 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigMerger.mergeSequence}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{mergeSequence}}}{\emph{seq1}, \emph{seq2}}{}
6326 Merge two sequences. The second sequence is unchanged,
6327 and the first is changed to have the elements of the second
6328 appended to it.
6329
6330 @param seq1: The sequence to merge into.
6331 @type seq1: L\{Sequence\}.
6332 @param seq2: The sequence to merge.
6333 @type seq2: L\{Sequence\}.
6334
6335 \end{fulllineitems}
6336
6337 \index{overwriteKeys() (src.pyconf.ConfigMerger method)}
6338
6339 \begin{fulllineitems}
6340 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigMerger.overwriteKeys}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{overwriteKeys}}}{\emph{map1}, \emph{seq2}}{}
6341 Renint variables. The second mapping is unchanged,
6342 and the first is changed depending the keys of the second mapping.
6343 @param map1: The mapping to reinit keys into.
6344 @type map1: L\{Mapping\}.
6345 @param map2: The mapping container reinit information.
6346 @type map2: L\{Mapping\}.
6347
6348 \end{fulllineitems}
6349
6350
6351 \end{fulllineitems}
6352
6353 \index{ConfigOutputStream (class in src.pyconf)}
6354
6355 \begin{fulllineitems}
6356 \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}}{}
6357 Bases: \sphinxcode{\sphinxupquote{object}}
6358
6359 An output stream which can write either ANSI files with default encoding
6360 or Unicode files with BOMs.
6361
6362 Handles UTF-8, UTF-16LE, UTF-16BE. Could handle UTF-32 if Python had
6363 built-in support.
6364 \index{close() (src.pyconf.ConfigOutputStream method)}
6365
6366 \begin{fulllineitems}
6367 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigOutputStream.close}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{close}}}{}{}
6368 \end{fulllineitems}
6369
6370 \index{flush() (src.pyconf.ConfigOutputStream method)}
6371
6372 \begin{fulllineitems}
6373 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigOutputStream.flush}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{flush}}}{}{}
6374 \end{fulllineitems}
6375
6376 \index{write() (src.pyconf.ConfigOutputStream method)}
6377
6378 \begin{fulllineitems}
6379 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigOutputStream.write}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write}}}{\emph{data}}{}
6380 \end{fulllineitems}
6381
6382
6383 \end{fulllineitems}
6384
6385 \index{ConfigReader (class in src.pyconf)}
6386
6387 \begin{fulllineitems}
6388 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{ConfigReader}}}{\emph{config}}{}
6389 Bases: \sphinxcode{\sphinxupquote{object}}
6390
6391 This internal class implements a parser for configurations.
6392 \index{getChar() (src.pyconf.ConfigReader method)}
6393
6394 \begin{fulllineitems}
6395 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.getChar}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getChar}}}{}{}
6396 Get the next char from the stream. Update line and column numbers
6397 appropriately.
6398
6399 @return: The next character from the stream.
6400 @rtype: str
6401
6402 \end{fulllineitems}
6403
6404 \index{getToken() (src.pyconf.ConfigReader method)}
6405
6406 \begin{fulllineitems}
6407 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.getToken}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getToken}}}{}{}
6408 Get a token from the stream. String values are returned in a form
6409 where you need to eval() the returned value to get the actual
6410 string. The return value is (token\_type, token\_value).
6411
6412 Multiline string tokenizing is thanks to David Janes (BlogMatrix)
6413
6414 @return: The next token.
6415 @rtype: A token tuple.
6416
6417 \end{fulllineitems}
6418
6419 \index{load() (src.pyconf.ConfigReader method)}
6420
6421 \begin{fulllineitems}
6422 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.load}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{load}}}{\emph{stream}, \emph{parent=None}, \emph{suffix=None}}{}
6423 Load the configuration from the specified stream.
6424
6425 @param stream: A stream from which to load the configuration.
6426 @type stream: A stream (file-like object).
6427 @param parent: The parent of the configuration (to which this reader
6428 belongs) in the hierarchy. Specified when the configuration is
6429 included in another one.
6430 @type parent: A L\{Container\} instance.
6431 @param suffix: The suffix of this configuration in the parent
6432 configuration. Should be specified whenever the parent is not None.
6433 @raise ConfigError: If parent is specified but suffix is not.
6434 @raise ConfigFormatError: If there are syntax errors in the stream.
6435
6436 \end{fulllineitems}
6437
6438 \index{location() (src.pyconf.ConfigReader method)}
6439
6440 \begin{fulllineitems}
6441 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.location}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{location}}}{}{}
6442 Return the current location (filename, line, column) in the stream
6443 as a string.
6444
6445 Used when printing error messages,
6446
6447 @return: A string representing a location in the stream being read.
6448 @rtype: str
6449
6450 \end{fulllineitems}
6451
6452 \index{match() (src.pyconf.ConfigReader method)}
6453
6454 \begin{fulllineitems}
6455 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.match}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{match}}}{\emph{t}}{}
6456 Ensure that the current token type matches the specified value, and
6457 advance to the next token.
6458
6459 @param t: The token type to match.
6460 @type t: A valid token type.
6461 @return: The token which was last read from the stream before this
6462 function is called.
6463 @rtype: a token tuple - see L\{getToken\}.
6464 @raise ConfigFormatError: If the token does not match what’s expected.
6465
6466 \end{fulllineitems}
6467
6468 \index{parseFactor() (src.pyconf.ConfigReader method)}
6469
6470 \begin{fulllineitems}
6471 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseFactor}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseFactor}}}{}{}
6472 Parse a factor in an multiplicative expression (a * b, a / b, a \% b)
6473
6474 @return: the parsed factor
6475 @rtype: any scalar
6476 @raise ConfigFormatError: if a syntax error is found.
6477
6478 \end{fulllineitems}
6479
6480 \index{parseKeyValuePair() (src.pyconf.ConfigReader method)}
6481
6482 \begin{fulllineitems}
6483 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseKeyValuePair}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseKeyValuePair}}}{\emph{parent}}{}
6484 Parse a key-value pair, and add it to the provided L\{Mapping\}.
6485
6486 @param parent: The mapping to add entries to.
6487 @type parent: A L\{Mapping\} instance.
6488 @raise ConfigFormatError: if a syntax error is found.
6489
6490 \end{fulllineitems}
6491
6492 \index{parseMapping() (src.pyconf.ConfigReader method)}
6493
6494 \begin{fulllineitems}
6495 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseMapping}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseMapping}}}{\emph{parent}, \emph{suffix}}{}
6496 Parse a mapping.
6497
6498 @param parent: The container to which the mapping will be added.
6499 @type parent: A L\{Container\} instance.
6500 @param suffix: The suffix for the value.
6501 @type suffix: str
6502 @return: a L\{Mapping\} instance representing the mapping.
6503 @rtype: L\{Mapping\}
6504 @raise ConfigFormatError: if a syntax error is found.
6505
6506 \end{fulllineitems}
6507
6508 \index{parseMappingBody() (src.pyconf.ConfigReader method)}
6509
6510 \begin{fulllineitems}
6511 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseMappingBody}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseMappingBody}}}{\emph{parent}}{}
6512 Parse the internals of a mapping, and add entries to the provided
6513 L\{Mapping\}.
6514
6515 @param parent: The mapping to add entries to.
6516 @type parent: A L\{Mapping\} instance.
6517
6518 \end{fulllineitems}
6519
6520 \index{parseReference() (src.pyconf.ConfigReader method)}
6521
6522 \begin{fulllineitems}
6523 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseReference}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseReference}}}{\emph{type}}{}
6524 Parse a reference.
6525
6526 @return: the parsed reference
6527 @rtype: L\{Reference\}
6528 @raise ConfigFormatError: if a syntax error is found.
6529
6530 \end{fulllineitems}
6531
6532 \index{parseScalar() (src.pyconf.ConfigReader method)}
6533
6534 \begin{fulllineitems}
6535 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseScalar}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseScalar}}}{}{}
6536 Parse a scalar - a terminal value such as a string or number, or
6537 an L\{Expression\} or L\{Reference\}.
6538
6539 @return: the parsed scalar
6540 @rtype: any scalar
6541 @raise ConfigFormatError: if a syntax error is found.
6542
6543 \end{fulllineitems}
6544
6545 \index{parseSequence() (src.pyconf.ConfigReader method)}
6546
6547 \begin{fulllineitems}
6548 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseSequence}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseSequence}}}{\emph{parent}, \emph{suffix}}{}
6549 Parse a sequence.
6550
6551 @param parent: The container to which the sequence will be added.
6552 @type parent: A L\{Container\} instance.
6553 @param suffix: The suffix for the value.
6554 @type suffix: str
6555 @return: a L\{Sequence\} instance representing the sequence.
6556 @rtype: L\{Sequence\}
6557 @raise ConfigFormatError: if a syntax error is found.
6558
6559 \end{fulllineitems}
6560
6561 \index{parseSuffix() (src.pyconf.ConfigReader method)}
6562
6563 \begin{fulllineitems}
6564 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseSuffix}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseSuffix}}}{\emph{ref}}{}
6565 Parse a reference suffix.
6566
6567 @param ref: The reference of which this suffix is a part.
6568 @type ref: L\{Reference\}.
6569 @raise ConfigFormatError: if a syntax error is found.
6570
6571 \end{fulllineitems}
6572
6573 \index{parseTerm() (src.pyconf.ConfigReader method)}
6574
6575 \begin{fulllineitems}
6576 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseTerm}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseTerm}}}{}{}
6577 Parse a term in an additive expression (a + b, a - b)
6578
6579 @return: the parsed term
6580 @rtype: any scalar
6581 @raise ConfigFormatError: if a syntax error is found.
6582
6583 \end{fulllineitems}
6584
6585 \index{parseValue() (src.pyconf.ConfigReader method)}
6586
6587 \begin{fulllineitems}
6588 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseValue}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseValue}}}{\emph{parent}, \emph{suffix}}{}
6589 Parse a value.
6590
6591 @param parent: The container to which the value will be added.
6592 @type parent: A L\{Container\} instance.
6593 @param suffix: The suffix for the value.
6594 @type suffix: str
6595 @return: The value
6596 @rtype: any
6597 @raise ConfigFormatError: if a syntax error is found.
6598
6599 \end{fulllineitems}
6600
6601 \index{setStream() (src.pyconf.ConfigReader method)}
6602
6603 \begin{fulllineitems}
6604 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.setStream}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{setStream}}}{\emph{stream}}{}
6605 Set the stream to the specified value, and prepare to read from it.
6606
6607 @param stream: A stream from which to load the configuration.
6608 @type stream: A stream (file-like object).
6609
6610 \end{fulllineitems}
6611
6612
6613 \end{fulllineitems}
6614
6615 \index{ConfigResolutionError}
6616
6617 \begin{fulllineitems}
6618 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigResolutionError}}\pysigline{\sphinxbfcode{\sphinxupquote{exception }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{ConfigResolutionError}}}
6619 Bases: {\hyperref[\detokenize{commands/apidoc/src:src.pyconf.ConfigError}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.pyconf.ConfigError}}}}} (\autopageref*{\detokenize{commands/apidoc/src:src.pyconf.ConfigError}})
6620
6621 This is the base class of exceptions raised due to semantic errors in
6622 configurations.
6623
6624 \end{fulllineitems}
6625
6626 \index{Container (class in src.pyconf)}
6627
6628 \begin{fulllineitems}
6629 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Container}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{Container}}}{\emph{parent}}{}
6630 Bases: \sphinxcode{\sphinxupquote{object}}
6631
6632 This internal class is the base class for mappings and sequences.
6633
6634 @ivar path: A string which describes how to get
6635 to this instance from the root of the hierarchy.
6636
6637 Example:
6638
6639 \fvset{hllines={, ,}}%
6640 \begin{sphinxVerbatim}[commandchars=\\\{\}]
6641 \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}
6642 \end{sphinxVerbatim}
6643 \index{evaluate() (src.pyconf.Container method)}
6644
6645 \begin{fulllineitems}
6646 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Container.evaluate}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{evaluate}}}{\emph{item}}{}
6647 Evaluate items which are instances of L\{Reference\} or L\{Expression\}.
6648
6649 L\{Reference\} instances are evaluated using L\{Reference.resolve\},
6650 and L\{Expression\} instances are evaluated using
6651 L\{Expression.evaluate\}.
6652
6653 @param item: The item to be evaluated.
6654 @type item: any
6655 @return: If the item is an instance of L\{Reference\} or L\{Expression\},
6656 the evaluated value is returned, otherwise the item is returned
6657 unchanged.
6658
6659 \end{fulllineitems}
6660
6661 \index{setPath() (src.pyconf.Container method)}
6662
6663 \begin{fulllineitems}
6664 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Container.setPath}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{setPath}}}{\emph{path}}{}
6665 Set the path for this instance.
6666 @param path: The path - a string which describes how to get
6667 to this instance from the root of the hierarchy.
6668 @type path: str
6669
6670 \end{fulllineitems}
6671
6672 \index{writeToStream() (src.pyconf.Container method)}
6673
6674 \begin{fulllineitems}
6675 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Container.writeToStream}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{writeToStream}}}{\emph{stream}, \emph{indent}, \emph{container}}{}
6676 Write this instance to a stream at the specified indentation level.
6677
6678 Should be redefined in subclasses.
6679
6680 @param stream: The stream to write to
6681 @type stream: A writable stream (file-like object)
6682 @param indent: The indentation level
6683 @type indent: int
6684 @param container: The container of this instance
6685 @type container: L\{Container\}
6686 @raise NotImplementedError: If a subclass does not override this
6687
6688 \end{fulllineitems}
6689
6690 \index{writeValue() (src.pyconf.Container method)}
6691
6692 \begin{fulllineitems}
6693 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Container.writeValue}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{writeValue}}}{\emph{value}, \emph{stream}, \emph{indent}}{}
6694 \end{fulllineitems}
6695
6696
6697 \end{fulllineitems}
6698
6699 \index{Expression (class in src.pyconf)}
6700
6701 \begin{fulllineitems}
6702 \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}}{}
6703 Bases: \sphinxcode{\sphinxupquote{object}}
6704
6705 This internal class implements a value which is obtained by evaluating an expression.
6706 \index{evaluate() (src.pyconf.Expression method)}
6707
6708 \begin{fulllineitems}
6709 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Expression.evaluate}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{evaluate}}}{\emph{container}}{}
6710 Evaluate this instance in the context of a container.
6711
6712 @param container: The container to evaluate in from.
6713 @type container: L\{Container\}
6714 @return: The evaluated value.
6715 @rtype: any
6716 @raise ConfigResolutionError: If evaluation fails.
6717 @raise ZeroDivideError: If division by zero occurs.
6718 @raise TypeError: If the operation is invalid, e.g.
6719 subtracting one string from another.
6720
6721 \end{fulllineitems}
6722
6723
6724 \end{fulllineitems}
6725
6726 \index{Mapping (class in src.pyconf)}
6727
6728 \begin{fulllineitems}
6729 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Mapping}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{Mapping}}}{\emph{parent=None}}{}
6730 Bases: {\hyperref[\detokenize{commands/apidoc/src:src.pyconf.Container}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.pyconf.Container}}}}} (\autopageref*{\detokenize{commands/apidoc/src:src.pyconf.Container}})
6731
6732 This internal class implements key-value mappings in configurations.
6733 \index{addMapping() (src.pyconf.Mapping method)}
6734
6735 \begin{fulllineitems}
6736 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Mapping.addMapping}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{addMapping}}}{\emph{key}, \emph{value}, \emph{comment}, \emph{setting=False}}{}
6737 Add a key-value mapping with a comment.
6738
6739 @param key: The key for the mapping.
6740 @type key: str
6741 @param value: The value for the mapping.
6742 @type value: any
6743 @param comment: The comment for the key (can be None).
6744 @type comment: str
6745 @param setting: If True, ignore clashes. This is set
6746 to true when called from L\{\_\_setattr\_\_\}.
6747 @raise ConfigFormatError: If an existing key is seen
6748 again and setting is False.
6749
6750 \end{fulllineitems}
6751
6752 \index{get() (src.pyconf.Mapping method)}
6753
6754 \begin{fulllineitems}
6755 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Mapping.get}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get}}}{\emph{key}, \emph{default=None}}{}
6756 Allows a dictionary-style get operation.
6757
6758 \end{fulllineitems}
6759
6760 \index{iteritems() (src.pyconf.Mapping method)}
6761
6762 \begin{fulllineitems}
6763 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Mapping.iteritems}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{iteritems}}}{}{}
6764 \end{fulllineitems}
6765
6766 \index{iterkeys() (src.pyconf.Mapping method)}
6767
6768 \begin{fulllineitems}
6769 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Mapping.iterkeys}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{iterkeys}}}{}{}
6770 \end{fulllineitems}
6771
6772 \index{keys() (src.pyconf.Mapping method)}
6773
6774 \begin{fulllineitems}
6775 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Mapping.keys}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{keys}}}{}{}
6776 Return the keys in a similar way to a dictionary.
6777
6778 \end{fulllineitems}
6779
6780 \index{writeToStream() (src.pyconf.Mapping method)}
6781
6782 \begin{fulllineitems}
6783 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Mapping.writeToStream}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{writeToStream}}}{\emph{stream}, \emph{indent}, \emph{container}}{}
6784 Write this instance to a stream at the specified indentation level.
6785
6786 Should be redefined in subclasses.
6787
6788 @param stream: The stream to write to
6789 @type stream: A writable stream (file-like object)
6790 @param indent: The indentation level
6791 @type indent: int
6792 @param container: The container of this instance
6793 @type container: L\{Container\}
6794
6795 \end{fulllineitems}
6796
6797
6798 \end{fulllineitems}
6799
6800 \index{Reference (class in src.pyconf)}
6801
6802 \begin{fulllineitems}
6803 \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}}{}
6804 Bases: \sphinxcode{\sphinxupquote{object}}
6805
6806 This internal class implements a value which is a reference to another value.
6807 \index{addElement() (src.pyconf.Reference method)}
6808
6809 \begin{fulllineitems}
6810 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Reference.addElement}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{addElement}}}{\emph{type}, \emph{ident}}{}
6811 Add an element to the reference.
6812
6813 @param type: The type of reference.
6814 @type type: BACKTICK or DOLLAR
6815 @param ident: The identifier which continues the reference.
6816 @type ident: str
6817
6818 \end{fulllineitems}
6819
6820 \index{findConfig() (src.pyconf.Reference method)}
6821
6822 \begin{fulllineitems}
6823 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Reference.findConfig}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{findConfig}}}{\emph{container}}{}
6824 Find the closest enclosing configuration to the specified container.
6825
6826 @param container: The container to start from.
6827 @type container: L\{Container\}
6828 @return: The closest enclosing configuration, or None.
6829 @rtype: L\{Config\}
6830
6831 \end{fulllineitems}
6832
6833 \index{resolve() (src.pyconf.Reference method)}
6834
6835 \begin{fulllineitems}
6836 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Reference.resolve}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{resolve}}}{\emph{container}}{}
6837 Resolve this instance in the context of a container.
6838
6839 @param container: The container to resolve from.
6840 @type container: L\{Container\}
6841 @return: The resolved value.
6842 @rtype: any
6843 @raise ConfigResolutionError: If resolution fails.
6844
6845 \end{fulllineitems}
6846
6847
6848 \end{fulllineitems}
6849
6850 \index{Sequence (class in src.pyconf)}
6851
6852 \begin{fulllineitems}
6853 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Sequence}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{Sequence}}}{\emph{parent=None}}{}
6854 Bases: {\hyperref[\detokenize{commands/apidoc/src:src.pyconf.Container}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.pyconf.Container}}}}} (\autopageref*{\detokenize{commands/apidoc/src:src.pyconf.Container}})
6855
6856 This internal class implements a value which is a sequence of other values.
6857 \index{Sequence.SeqIter (class in src.pyconf)}
6858
6859 \begin{fulllineitems}
6860 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Sequence.SeqIter}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxbfcode{\sphinxupquote{SeqIter}}}{\emph{seq}}{}
6861 Bases: \sphinxcode{\sphinxupquote{object}}
6862
6863 This internal class implements an iterator for a L\{Sequence\} instance.
6864 \index{next() (src.pyconf.Sequence.SeqIter method)}
6865
6866 \begin{fulllineitems}
6867 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Sequence.SeqIter.next}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{next}}}{}{}
6868 \end{fulllineitems}
6869
6870
6871 \end{fulllineitems}
6872
6873 \index{append() (src.pyconf.Sequence method)}
6874
6875 \begin{fulllineitems}
6876 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Sequence.append}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append}}}{\emph{item}, \emph{comment}}{}
6877 Add an item to the sequence.
6878
6879 @param item: The item to add.
6880 @type item: any
6881 @param comment: A comment for the item.
6882 @type comment: str
6883
6884 \end{fulllineitems}
6885
6886 \index{writeToStream() (src.pyconf.Sequence method)}
6887
6888 \begin{fulllineitems}
6889 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Sequence.writeToStream}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{writeToStream}}}{\emph{stream}, \emph{indent}, \emph{container}}{}
6890 Write this instance to a stream at the specified indentation level.
6891
6892 Should be redefined in subclasses.
6893
6894 @param stream: The stream to write to
6895 @type stream: A writable stream (file-like object)
6896 @param indent: The indentation level
6897 @type indent: int
6898 @param container: The container of this instance
6899 @type container: L\{Container\}
6900
6901 \end{fulllineitems}
6902
6903
6904 \end{fulllineitems}
6905
6906 \index{deepCopyMapping() (in module src.pyconf)}
6907
6908 \begin{fulllineitems}
6909 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.deepCopyMapping}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{deepCopyMapping}}}{\emph{inMapping}}{}
6910 \end{fulllineitems}
6911
6912 \index{defaultMergeResolve() (in module src.pyconf)}
6913
6914 \begin{fulllineitems}
6915 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.defaultMergeResolve}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{defaultMergeResolve}}}{\emph{map1}, \emph{map2}, \emph{key}}{}
6916 A default resolver for merge conflicts.
6917 Returns a string indicating what action to take to resolve the conflict.
6918
6919 @param map1: The map being merged into.
6920 @type map1: L\{Mapping\}.
6921 @param map2: The map being used as the merge operand.
6922 @type map2: L\{Mapping\}.
6923 @param key: The key in map2 (which also exists in map1).
6924 @type key: str
6925 \begin{description}
6926 \item[{@return: One of “merge”, “append”, “mismatch” or “overwrite”}] \leavevmode
6927 indicating what action should be taken. This should
6928 be appropriate to the objects being merged - e.g.
6929 there is no point returning “merge” if the two objects
6930 are instances of L\{Sequence\}.
6931
6932 \end{description}
6933
6934 @rtype: str
6935
6936 \end{fulllineitems}
6937
6938 \index{defaultStreamOpener() (in module src.pyconf)}
6939
6940 \begin{fulllineitems}
6941 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.defaultStreamOpener}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{defaultStreamOpener}}}{\emph{name}}{}
6942 This function returns a read-only stream, given its name. The name passed
6943 in should correspond to an existing stream, otherwise an exception will be
6944 raised.
6945
6946 This is the default value of L\{streamOpener\}; assign your own callable to
6947 streamOpener to return streams based on names. For example, you could use
6948 urllib2.urlopen().
6949
6950 @param name: The name of a stream, most commonly a file name.
6951 @type name: str
6952 @return: A stream with the specified name.
6953 @rtype: A read-only stream (file-like object)
6954
6955 \end{fulllineitems}
6956
6957 \index{isWord() (in module src.pyconf)}
6958
6959 \begin{fulllineitems}
6960 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.isWord}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{isWord}}}{\emph{s}}{}
6961 See if a passed-in value is an identifier. If the value passed in is not a
6962 string, False is returned. An identifier consists of alphanumerics or
6963 underscore characters.
6964
6965 Examples:
6966
6967 \fvset{hllines={, ,}}%
6968 \begin{sphinxVerbatim}[commandchars=\\\{\}]
6969 \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}
6970 \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}
6971 \PYG{n}{isWord}\PYG{p}{(}\PYG{l+m+mi}{9}\PYG{p}{)} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZgt{}} \PYG{k+kc}{False}
6972 \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}
6973 \end{sphinxVerbatim}
6974
6975 @note: isWord(‘9abc’) will return True - not exactly correct, but adequate
6976 for the way it’s used here.
6977
6978 @param s: The name to be tested
6979 @type s: any
6980 @return: True if a word, else False
6981 @rtype: bool
6982
6983 \end{fulllineitems}
6984
6985 \index{makePath() (in module src.pyconf)}
6986
6987 \begin{fulllineitems}
6988 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.makePath}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{makePath}}}{\emph{prefix}, \emph{suffix}}{}
6989 Make a path from a prefix and suffix.
6990
6991 Examples:
6992 makePath(‘’, ‘suffix’) -\textgreater{} ‘suffix’
6993 makePath(‘prefix’, ‘suffix’) -\textgreater{} ‘prefix.suffix’
6994 makePath(‘prefix’, ‘{[}1{]}’) -\textgreater{} ‘prefix{[}1{]}’
6995
6996 @param prefix: The prefix to use. If it evaluates as false, the suffix is returned.
6997 @type prefix: str
6998 @param suffix: The suffix to use. It is either an identifier or an index in brackets.
6999 @type suffix: str
7000 @return: The path concatenation of prefix and suffix, with adot if the suffix is not a bracketed index.
7001 @rtype: str
7002
7003 \end{fulllineitems}
7004
7005 \index{overwriteMergeResolve() (in module src.pyconf)}
7006
7007 \begin{fulllineitems}
7008 \phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.overwriteMergeResolve}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{overwriteMergeResolve}}}{\emph{map1}, \emph{map2}, \emph{key}}{}
7009 An overwriting resolver for merge conflicts. Calls L\{defaultMergeResolve\},
7010 but where a “mismatch” is detected, returns “overwrite” instead.
7011
7012 @param map1: The map being merged into.
7013 @type map1: L\{Mapping\}.
7014 @param map2: The map being used as the merge operand.
7015 @type map2: L\{Mapping\}.
7016 @param key: The key in map2 (which also exists in map1).
7017 @type key: str
7018
7019 \end{fulllineitems}
7020
7021
7022
7023 \subsubsection{src.system module}
7024 \label{\detokenize{commands/apidoc/src:src-system-module}}\label{\detokenize{commands/apidoc/src:module-src.system}}\index{src.system (module)}
7025 In this file : all functions that do a system call,
7026 like open a browser or an editor, or call a git command
7027 \index{archive\_extract() (in module src.system)}
7028
7029 \begin{fulllineitems}
7030 \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}}{}
7031 Extracts sources from an archive.
7032 \begin{quote}\begin{description}
7033 \item[{Parameters}] \leavevmode\begin{itemize}
7034 \item {}
7035 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{where}}) \textendash{} The path to the archive.
7036
7037 \item {}
7038 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The path where to extract.
7039
7040 \item {}
7041 \sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to use.
7042
7043 \end{itemize}
7044
7045 \item[{Returns}] \leavevmode
7046 True if the extraction is successful
7047
7048 \item[{Return type}] \leavevmode
7049 boolean
7050
7051 \end{description}\end{quote}
7052
7053 \end{fulllineitems}
7054
7055 \index{cvs\_extract() (in module src.system)}
7056
7057 \begin{fulllineitems}
7058 \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}}{}
7059 Extracts sources from a cvs repository.
7060 \begin{quote}\begin{description}
7061 \item[{Parameters}] \leavevmode\begin{itemize}
7062 \item {}
7063 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{where}}) \textendash{} The cvs protocol.
7064
7065 \item {}
7066 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The user to be used.
7067
7068 \item {}
7069 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The remote cvs server.
7070
7071 \item {}
7072 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{}
7073 .
7074
7075
7076 \item {}
7077 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The tag.
7078
7079 \item {}
7080 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The product.
7081
7082 \item {}
7083 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The path where to extract.
7084
7085 \item {}
7086 \sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to use.
7087
7088 \item {}
7089 \sphinxstyleliteralstrong{\sphinxupquote{boolean}} (\sphinxstyleliteralemphasis{\sphinxupquote{checkout}}) \textendash{} If true use checkout cvs.
7090
7091 \item {}
7092 \sphinxstyleliteralstrong{\sphinxupquote{src.environment.Environ}} (\sphinxstyleliteralemphasis{\sphinxupquote{environment}}) \textendash{} The environment to source when
7093 extracting.
7094
7095 \end{itemize}
7096
7097 \item[{Returns}] \leavevmode
7098 True if the extraction is successful
7099
7100 \item[{Return type}] \leavevmode
7101 boolean
7102
7103 \end{description}\end{quote}
7104
7105 \end{fulllineitems}
7106
7107 \index{git\_extract() (in module src.system)}
7108
7109 \begin{fulllineitems}
7110 \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}}{}
7111 Extracts sources from a git repository.
7112 \begin{quote}\begin{description}
7113 \item[{Parameters}] \leavevmode\begin{itemize}
7114 \item {}
7115 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{where}}) \textendash{} The remote git repository.
7116
7117 \item {}
7118 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The tag.
7119
7120 \item {}
7121 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The path where to extract.
7122
7123 \item {}
7124 \sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to use.
7125
7126 \item {}
7127 \sphinxstyleliteralstrong{\sphinxupquote{src.environment.Environ}} (\sphinxstyleliteralemphasis{\sphinxupquote{environment}}) \textendash{} The environment to source when
7128 extracting.
7129
7130 \end{itemize}
7131
7132 \item[{Returns}] \leavevmode
7133 True if the extraction is successful
7134
7135 \item[{Return type}] \leavevmode
7136 boolean
7137
7138 \end{description}\end{quote}
7139
7140 \end{fulllineitems}
7141
7142 \index{show\_in\_editor() (in module src.system)}
7143
7144 \begin{fulllineitems}
7145 \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}}{}
7146 open filePath using editor.
7147 \begin{quote}\begin{description}
7148 \item[{Parameters}] \leavevmode\begin{itemize}
7149 \item {}
7150 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{filePath}}) \textendash{} The editor to use.
7151
7152 \item {}
7153 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The path to the file to open.
7154
7155 \end{itemize}
7156
7157 \end{description}\end{quote}
7158
7159 \end{fulllineitems}
7160
7161 \index{svn\_extract() (in module src.system)}
7162
7163 \begin{fulllineitems}
7164 \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}}{}
7165 Extracts sources from a svn repository.
7166 \begin{quote}\begin{description}
7167 \item[{Parameters}] \leavevmode\begin{itemize}
7168 \item {}
7169 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{where}}) \textendash{} The user to be used.
7170
7171 \item {}
7172 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The remote git repository.
7173
7174 \item {}
7175 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The tag.
7176
7177 \item {}
7178 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The path where to extract.
7179
7180 \item {}
7181 \sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to use.
7182
7183 \item {}
7184 \sphinxstyleliteralstrong{\sphinxupquote{boolean}} (\sphinxstyleliteralemphasis{\sphinxupquote{checkout}}) \textendash{} If true use checkout svn.
7185
7186 \item {}
7187 \sphinxstyleliteralstrong{\sphinxupquote{src.environment.Environ}} (\sphinxstyleliteralemphasis{\sphinxupquote{environment}}) \textendash{} The environment to source when
7188 extracting.
7189
7190 \end{itemize}
7191
7192 \item[{Returns}] \leavevmode
7193 True if the extraction is successful
7194
7195 \item[{Return type}] \leavevmode
7196 boolean
7197
7198 \end{description}\end{quote}
7199
7200 \end{fulllineitems}
7201
7202
7203
7204 \subsubsection{src.template module}
7205 \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)}
7206
7207 \begin{fulllineitems}
7208 \phantomsection\label{\detokenize{commands/apidoc/src:src.template.MyTemplate}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.template.}}\sphinxbfcode{\sphinxupquote{MyTemplate}}}{\emph{template}}{}
7209 Bases: \sphinxcode{\sphinxupquote{string.Template}}
7210 \index{delimiter (src.template.MyTemplate attribute)}
7211
7212 \begin{fulllineitems}
7213 \phantomsection\label{\detokenize{commands/apidoc/src:src.template.MyTemplate.delimiter}}\pysigline{\sphinxbfcode{\sphinxupquote{delimiter}}\sphinxbfcode{\sphinxupquote{ = '\textbackslash{}xc2\textbackslash{}xa4'}}}
7214 \end{fulllineitems}
7215
7216 \index{pattern (src.template.MyTemplate attribute)}
7217
7218 \begin{fulllineitems}
7219 \phantomsection\label{\detokenize{commands/apidoc/src:src.template.MyTemplate.pattern}}\pysigline{\sphinxbfcode{\sphinxupquote{pattern}}\sphinxbfcode{\sphinxupquote{ = \textless{}\_sre.SRE\_Pattern object\textgreater{}}}}
7220 \end{fulllineitems}
7221
7222
7223 \end{fulllineitems}
7224
7225 \index{substitute() (in module src.template)}
7226
7227 \begin{fulllineitems}
7228 \phantomsection\label{\detokenize{commands/apidoc/src:src.template.substitute}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.template.}}\sphinxbfcode{\sphinxupquote{substitute}}}{\emph{template\_file}, \emph{subst\_dic}}{}
7229 \end{fulllineitems}
7230
7231
7232
7233 \subsubsection{src.test\_module module}
7234 \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)}
7235
7236 \begin{fulllineitems}
7237 \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)}
7238
7239 \begin{fulllineitems}
7240 \phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.generate_launching_commands}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{generate\_launching\_commands}}}{}{}
7241 \end{fulllineitems}
7242
7243 \index{generate\_script() (src.test\_module.Test method)}
7244
7245 \begin{fulllineitems}
7246 \phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.generate_script}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{generate\_script}}}{\emph{listTest}, \emph{script\_path}, \emph{ignoreList}}{}
7247 \end{fulllineitems}
7248
7249 \index{get\_test\_timeout() (src.test\_module.Test method)}
7250
7251 \begin{fulllineitems}
7252 \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}}{}
7253 \end{fulllineitems}
7254
7255 \index{get\_tmp\_dir() (src.test\_module.Test method)}
7256
7257 \begin{fulllineitems}
7258 \phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.get_tmp_dir}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_tmp\_dir}}}{}{}
7259 \end{fulllineitems}
7260
7261 \index{prepare\_testbase() (src.test\_module.Test method)}
7262
7263 \begin{fulllineitems}
7264 \phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.prepare_testbase}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepare\_testbase}}}{\emph{test\_base\_name}}{}
7265 \end{fulllineitems}
7266
7267 \index{prepare\_testbase\_from\_dir() (src.test\_module.Test method)}
7268
7269 \begin{fulllineitems}
7270 \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}}{}
7271 \end{fulllineitems}
7272
7273 \index{prepare\_testbase\_from\_git() (src.test\_module.Test method)}
7274
7275 \begin{fulllineitems}
7276 \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}}{}
7277 \end{fulllineitems}
7278
7279 \index{prepare\_testbase\_from\_svn() (src.test\_module.Test method)}
7280
7281 \begin{fulllineitems}
7282 \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}}{}
7283 \end{fulllineitems}
7284
7285 \index{read\_results() (src.test\_module.Test method)}
7286
7287 \begin{fulllineitems}
7288 \phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.read_results}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{read\_results}}}{\emph{listTest}, \emph{has\_timed\_out}}{}
7289 \end{fulllineitems}
7290
7291 \index{run\_all\_tests() (src.test\_module.Test method)}
7292
7293 \begin{fulllineitems}
7294 \phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.run_all_tests}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run\_all\_tests}}}{}{}
7295 \end{fulllineitems}
7296
7297 \index{run\_grid\_tests() (src.test\_module.Test method)}
7298
7299 \begin{fulllineitems}
7300 \phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.run_grid_tests}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run\_grid\_tests}}}{}{}
7301 \end{fulllineitems}
7302
7303 \index{run\_script() (src.test\_module.Test method)}
7304
7305 \begin{fulllineitems}
7306 \phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.run_script}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run\_script}}}{\emph{script\_name}}{}
7307 \end{fulllineitems}
7308
7309 \index{run\_session\_tests() (src.test\_module.Test method)}
7310
7311 \begin{fulllineitems}
7312 \phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.run_session_tests}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run\_session\_tests}}}{}{}
7313 \end{fulllineitems}
7314
7315 \index{run\_testbase\_tests() (src.test\_module.Test method)}
7316
7317 \begin{fulllineitems}
7318 \phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.run_testbase_tests}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run\_testbase\_tests}}}{}{}
7319 \end{fulllineitems}
7320
7321 \index{run\_tests() (src.test\_module.Test method)}
7322
7323 \begin{fulllineitems}
7324 \phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.run_tests}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run\_tests}}}{\emph{listTest}, \emph{ignoreList}}{}
7325 \end{fulllineitems}
7326
7327 \index{search\_known\_errors() (src.test\_module.Test method)}
7328
7329 \begin{fulllineitems}
7330 \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}}{}
7331 \end{fulllineitems}
7332
7333 \index{write\_test\_margin() (src.test\_module.Test method)}
7334
7335 \begin{fulllineitems}
7336 \phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.write_test_margin}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write\_test\_margin}}}{\emph{tab}}{}
7337 \end{fulllineitems}
7338
7339
7340 \end{fulllineitems}
7341
7342 \index{getTmpDirDEFAULT() (in module src.test\_module)}
7343
7344 \begin{fulllineitems}
7345 \phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.getTmpDirDEFAULT}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.test\_module.}}\sphinxbfcode{\sphinxupquote{getTmpDirDEFAULT}}}{}{}
7346 \end{fulllineitems}
7347
7348
7349
7350 \subsubsection{src.xmlManager module}
7351 \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)}
7352
7353 \begin{fulllineitems}
7354 \phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.ReadXmlFile}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.xmlManager.}}\sphinxbfcode{\sphinxupquote{ReadXmlFile}}}{\emph{filePath}}{}
7355 Bases: \sphinxcode{\sphinxupquote{object}}
7356
7357 Class to manage reading of an xml log file
7358 \index{getRootAttrib() (src.xmlManager.ReadXmlFile method)}
7359
7360 \begin{fulllineitems}
7361 \phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.ReadXmlFile.getRootAttrib}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getRootAttrib}}}{}{}
7362 Get the attibutes of the self.xmlroot
7363 \begin{quote}\begin{description}
7364 \item[{Returns}] \leavevmode
7365 The attributes of the root node
7366
7367 \item[{Return type}] \leavevmode
7368 dict
7369
7370 \end{description}\end{quote}
7371
7372 \end{fulllineitems}
7373
7374 \index{get\_attrib() (src.xmlManager.ReadXmlFile method)}
7375
7376 \begin{fulllineitems}
7377 \phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.ReadXmlFile.get_attrib}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_attrib}}}{\emph{node\_name}}{}
7378 Get the attibutes of the node node\_name in self.xmlroot
7379 \begin{quote}\begin{description}
7380 \item[{Parameters}] \leavevmode
7381 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{node\_name}}) \textendash{} the name of the node
7382
7383 \item[{Returns}] \leavevmode
7384 the attibutes of the node node\_name in self.xmlroot
7385
7386 \item[{Return type}] \leavevmode
7387 dict
7388
7389 \end{description}\end{quote}
7390
7391 \end{fulllineitems}
7392
7393 \index{get\_node\_text() (src.xmlManager.ReadXmlFile method)}
7394
7395 \begin{fulllineitems}
7396 \phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.ReadXmlFile.get_node_text}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_node\_text}}}{\emph{node}}{}~\begin{description}
7397 \item[{Get the text of the first node that has name }] \leavevmode
7398 that corresponds to the parameter node
7399
7400 \end{description}
7401 \begin{quote}\begin{description}
7402 \item[{Parameters}] \leavevmode
7403 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{node}}) \textendash{} the name of the node from which get the text
7404
7405 \item[{Returns}] \leavevmode
7406 the text of the first node that has name
7407 that corresponds to the parameter node
7408
7409 \item[{Return type}] \leavevmode
7410 str
7411
7412 \end{description}\end{quote}
7413
7414 \end{fulllineitems}
7415
7416
7417 \end{fulllineitems}
7418
7419 \index{XmlLogFile (class in src.xmlManager)}
7420
7421 \begin{fulllineitems}
7422 \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=\{\}}}{}
7423 Bases: \sphinxcode{\sphinxupquote{object}}
7424
7425 Class to manage writing in salomeTools xml log file
7426 \index{add\_simple\_node() (src.xmlManager.XmlLogFile method)}
7427
7428 \begin{fulllineitems}
7429 \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=\{\}}}{}
7430 Add a node with some attibutes and text to the root node.
7431 \begin{quote}\begin{description}
7432 \item[{Parameters}] \leavevmode\begin{itemize}
7433 \item {}
7434 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{text}}) \textendash{} the name of the node to add
7435
7436 \item {}
7437 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the text of the node
7438
7439 \item {}
7440 \sphinxstyleliteralstrong{\sphinxupquote{dict}} (\sphinxstyleliteralemphasis{\sphinxupquote{attrib}}) \textendash{} the dictionary containing the
7441 attribute of the new node
7442
7443 \end{itemize}
7444
7445 \end{description}\end{quote}
7446
7447 \end{fulllineitems}
7448
7449 \index{append\_node\_attrib() (src.xmlManager.XmlLogFile method)}
7450
7451 \begin{fulllineitems}
7452 \phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.XmlLogFile.append_node_attrib}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append\_node\_attrib}}}{\emph{node\_name}, \emph{attrib}}{}
7453 Append a new attributes to the node that has node\_name as name
7454 \begin{quote}\begin{description}
7455 \item[{Parameters}] \leavevmode\begin{itemize}
7456 \item {}
7457 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{node\_name}}) \textendash{} The name of the node on which append text
7458
7459 \item {}
7460 \sphinxstyleliteralstrong{\sphinxupquote{dixt}} (\sphinxstyleliteralemphasis{\sphinxupquote{attrib}}) \textendash{} The attrib to append
7461
7462 \end{itemize}
7463
7464 \end{description}\end{quote}
7465
7466 \end{fulllineitems}
7467
7468 \index{append\_node\_text() (src.xmlManager.XmlLogFile method)}
7469
7470 \begin{fulllineitems}
7471 \phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.XmlLogFile.append_node_text}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append\_node\_text}}}{\emph{node\_name}, \emph{text}}{}
7472 Append a new text to the node that has node\_name as name
7473 \begin{quote}\begin{description}
7474 \item[{Parameters}] \leavevmode\begin{itemize}
7475 \item {}
7476 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{text}}) \textendash{} The name of the node on which append text
7477
7478 \item {}
7479 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The text to append
7480
7481 \end{itemize}
7482
7483 \end{description}\end{quote}
7484
7485 \end{fulllineitems}
7486
7487 \index{write\_tree() (src.xmlManager.XmlLogFile method)}
7488
7489 \begin{fulllineitems}
7490 \phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.XmlLogFile.write_tree}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write\_tree}}}{\emph{stylesheet=None}, \emph{file\_path=None}}{}
7491 Write the xml tree in the log file path. Add the stylesheet if asked.
7492 \begin{quote}\begin{description}
7493 \item[{Parameters}] \leavevmode
7494 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{stylesheet}}) \textendash{} The stylesheet to apply to the xml file
7495
7496 \end{description}\end{quote}
7497
7498 \end{fulllineitems}
7499
7500
7501 \end{fulllineitems}
7502
7503 \index{add\_simple\_node() (in module src.xmlManager)}
7504
7505 \begin{fulllineitems}
7506 \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=\{\}}}{}
7507 Add a node with some attibutes and text to the root node.
7508 \begin{quote}\begin{description}
7509 \item[{Parameters}] \leavevmode\begin{itemize}
7510 \item {}
7511 \sphinxstyleliteralstrong{\sphinxupquote{etree.Element}} (\sphinxstyleliteralemphasis{\sphinxupquote{root\_node}}) \textendash{} the Etree element where to add the new node
7512
7513 \item {}
7514 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{text}}) \textendash{} the name of the node to add
7515
7516 \item {}
7517 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the text of the node
7518
7519 \item {}
7520 \sphinxstyleliteralstrong{\sphinxupquote{dict}} (\sphinxstyleliteralemphasis{\sphinxupquote{attrib}}) \textendash{} the dictionary containing the
7521 attribute of the new node
7522
7523 \end{itemize}
7524
7525 \end{description}\end{quote}
7526
7527 \end{fulllineitems}
7528
7529 \index{append\_node\_attrib() (in module src.xmlManager)}
7530
7531 \begin{fulllineitems}
7532 \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}}{}
7533 Append a new attributes to the node that has node\_name as name
7534 \begin{quote}\begin{description}
7535 \item[{Parameters}] \leavevmode\begin{itemize}
7536 \item {}
7537 \sphinxstyleliteralstrong{\sphinxupquote{etree.Element}} (\sphinxstyleliteralemphasis{\sphinxupquote{root\_node}}) \textendash{} the Etree element
7538 where to append the new attibutes
7539
7540 \item {}
7541 \sphinxstyleliteralstrong{\sphinxupquote{dixt}} (\sphinxstyleliteralemphasis{\sphinxupquote{attrib}}) \textendash{} The attrib to append
7542
7543 \end{itemize}
7544
7545 \end{description}\end{quote}
7546
7547 \end{fulllineitems}
7548
7549 \index{find\_node\_by\_attrib() (in module src.xmlManager)}
7550
7551 \begin{fulllineitems}
7552 \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}
7553 \item[{Find the nfirst ode from xmlroot that has name name\_node and that has in }] \leavevmode
7554 its attributes \{key : value\}. Return the node
7555
7556 \end{description}
7557 \begin{quote}\begin{description}
7558 \item[{Parameters}] \leavevmode\begin{itemize}
7559 \item {}
7560 \sphinxstyleliteralstrong{\sphinxupquote{etree.Element}} (\sphinxstyleliteralemphasis{\sphinxupquote{xmlroot}}) \textendash{} the Etree element where to search
7561
7562 \item {}
7563 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the name of node to search
7564
7565 \item {}
7566 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the key to search
7567
7568 \item {}
7569 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to search
7570
7571 \end{itemize}
7572
7573 \item[{Returns}] \leavevmode
7574 the found node
7575
7576 \item[{Return type}] \leavevmode
7577 xmlroot etree.Element
7578
7579 \end{description}\end{quote}
7580
7581 \end{fulllineitems}
7582
7583 \index{write\_report() (in module src.xmlManager)}
7584
7585 \begin{fulllineitems}
7586 \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}}{}
7587 Writes a report file from a XML tree.
7588 \begin{quote}\begin{description}
7589 \item[{Parameters}] \leavevmode\begin{itemize}
7590 \item {}
7591 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{stylesheet}}) \textendash{} The path to the file to create
7592
7593 \item {}
7594 \sphinxstyleliteralstrong{\sphinxupquote{etree.Element}} (\sphinxstyleliteralemphasis{\sphinxupquote{xmlroot}}) \textendash{} the Etree element to write to the file
7595
7596 \item {}
7597 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The stylesheet to add to the begin of the file
7598
7599 \end{itemize}
7600
7601 \end{description}\end{quote}
7602
7603 \end{fulllineitems}
7604
7605
7606
7607 \subsubsection{Module contents}
7608 \label{\detokenize{commands/apidoc/src:module-src}}\label{\detokenize{commands/apidoc/src:module-contents}}\index{src (module)}
7609 initial imports and utilities methods for salomeTools
7610 \index{Path (class in src)}
7611
7612 \begin{fulllineitems}
7613 \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)}
7614
7615 \begin{fulllineitems}
7616 \phantomsection\label{\detokenize{commands/apidoc/src:src.Path.base}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{base}}}{}{}
7617 \end{fulllineitems}
7618
7619 \index{chmod() (src.Path method)}
7620
7621 \begin{fulllineitems}
7622 \phantomsection\label{\detokenize{commands/apidoc/src:src.Path.chmod}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{chmod}}}{\emph{mode}}{}
7623 \end{fulllineitems}
7624
7625 \index{copy() (src.Path method)}
7626
7627 \begin{fulllineitems}
7628 \phantomsection\label{\detokenize{commands/apidoc/src:src.Path.copy}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{copy}}}{\emph{path}, \emph{smart=False}}{}
7629 \end{fulllineitems}
7630
7631 \index{copydir() (src.Path method)}
7632
7633 \begin{fulllineitems}
7634 \phantomsection\label{\detokenize{commands/apidoc/src:src.Path.copydir}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{copydir}}}{\emph{dst}, \emph{smart=False}}{}
7635 \end{fulllineitems}
7636
7637 \index{copyfile() (src.Path method)}
7638
7639 \begin{fulllineitems}
7640 \phantomsection\label{\detokenize{commands/apidoc/src:src.Path.copyfile}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{copyfile}}}{\emph{path}}{}
7641 \end{fulllineitems}
7642
7643 \index{copylink() (src.Path method)}
7644
7645 \begin{fulllineitems}
7646 \phantomsection\label{\detokenize{commands/apidoc/src:src.Path.copylink}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{copylink}}}{\emph{path}}{}
7647 \end{fulllineitems}
7648
7649 \index{dir() (src.Path method)}
7650
7651 \begin{fulllineitems}
7652 \phantomsection\label{\detokenize{commands/apidoc/src:src.Path.dir}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{dir}}}{}{}
7653 \end{fulllineitems}
7654
7655 \index{exists() (src.Path method)}
7656
7657 \begin{fulllineitems}
7658 \phantomsection\label{\detokenize{commands/apidoc/src:src.Path.exists}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{exists}}}{}{}
7659 \end{fulllineitems}
7660
7661 \index{isdir() (src.Path method)}
7662
7663 \begin{fulllineitems}
7664 \phantomsection\label{\detokenize{commands/apidoc/src:src.Path.isdir}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{isdir}}}{}{}
7665 \end{fulllineitems}
7666
7667 \index{isfile() (src.Path method)}
7668
7669 \begin{fulllineitems}
7670 \phantomsection\label{\detokenize{commands/apidoc/src:src.Path.isfile}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{isfile}}}{}{}
7671 \end{fulllineitems}
7672
7673 \index{islink() (src.Path method)}
7674
7675 \begin{fulllineitems}
7676 \phantomsection\label{\detokenize{commands/apidoc/src:src.Path.islink}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{islink}}}{}{}
7677 \end{fulllineitems}
7678
7679 \index{list() (src.Path method)}
7680
7681 \begin{fulllineitems}
7682 \phantomsection\label{\detokenize{commands/apidoc/src:src.Path.list}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{list}}}{}{}
7683 \end{fulllineitems}
7684
7685 \index{make() (src.Path method)}
7686
7687 \begin{fulllineitems}
7688 \phantomsection\label{\detokenize{commands/apidoc/src:src.Path.make}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{make}}}{\emph{mode=None}}{}
7689 \end{fulllineitems}
7690
7691 \index{readlink() (src.Path method)}
7692
7693 \begin{fulllineitems}
7694 \phantomsection\label{\detokenize{commands/apidoc/src:src.Path.readlink}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{readlink}}}{}{}
7695 \end{fulllineitems}
7696
7697 \index{rm() (src.Path method)}
7698
7699 \begin{fulllineitems}
7700 \phantomsection\label{\detokenize{commands/apidoc/src:src.Path.rm}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{rm}}}{}{}
7701 \end{fulllineitems}
7702
7703 \index{smartcopy() (src.Path method)}
7704
7705 \begin{fulllineitems}
7706 \phantomsection\label{\detokenize{commands/apidoc/src:src.Path.smartcopy}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{smartcopy}}}{\emph{path}}{}
7707 \end{fulllineitems}
7708
7709 \index{symlink() (src.Path method)}
7710
7711 \begin{fulllineitems}
7712 \phantomsection\label{\detokenize{commands/apidoc/src:src.Path.symlink}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{symlink}}}{\emph{path}}{}
7713 \end{fulllineitems}
7714
7715
7716 \end{fulllineitems}
7717
7718 \index{SatException}
7719
7720 \begin{fulllineitems}
7721 \phantomsection\label{\detokenize{commands/apidoc/src:src.SatException}}\pysigline{\sphinxbfcode{\sphinxupquote{exception }}\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{SatException}}}
7722 Bases: \sphinxcode{\sphinxupquote{exceptions.Exception}}
7723
7724 rename Exception Class
7725
7726 \end{fulllineitems}
7727
7728 \index{activate\_mesa\_property() (in module src)}
7729
7730 \begin{fulllineitems}
7731 \phantomsection\label{\detokenize{commands/apidoc/src:src.activate_mesa_property}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{activate\_mesa\_property}}}{\emph{config}}{}
7732 Add mesa property into application properties
7733 \begin{quote}\begin{description}
7734 \item[{Parameters}] \leavevmode
7735 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} The global configuration. It must have an application!
7736
7737 \end{description}\end{quote}
7738
7739 \end{fulllineitems}
7740
7741 \index{check\_config\_has\_application() (in module src)}
7742
7743 \begin{fulllineitems}
7744 \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}}{}
7745 check that the config has the key APPLICATION. Else raise an exception.
7746 \begin{quote}\begin{description}
7747 \item[{Parameters}] \leavevmode
7748 \sphinxstyleliteralstrong{\sphinxupquote{class 'common.pyconf.Config'}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} The config.
7749
7750 \end{description}\end{quote}
7751
7752 \end{fulllineitems}
7753
7754 \index{check\_config\_has\_profile() (in module src)}
7755
7756 \begin{fulllineitems}
7757 \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}}{}
7758 check that the config has the key APPLICATION.profile.
7759 else, raise an exception.
7760 \begin{quote}\begin{description}
7761 \item[{Parameters}] \leavevmode
7762 \sphinxstyleliteralstrong{\sphinxupquote{class 'common.pyconf.Config'}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} The config.
7763
7764 \end{description}\end{quote}
7765
7766 \end{fulllineitems}
7767
7768 \index{config\_has\_application() (in module src)}
7769
7770 \begin{fulllineitems}
7771 \phantomsection\label{\detokenize{commands/apidoc/src:src.config_has_application}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{config\_has\_application}}}{\emph{config}}{}
7772 \end{fulllineitems}
7773
7774 \index{deepcopy\_list() (in module src)}
7775
7776 \begin{fulllineitems}
7777 \phantomsection\label{\detokenize{commands/apidoc/src:src.deepcopy_list}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{deepcopy\_list}}}{\emph{input\_list}}{}
7778 Do a deep copy of a list
7779 \begin{quote}\begin{description}
7780 \item[{Parameters}] \leavevmode
7781 \sphinxstyleliteralstrong{\sphinxupquote{List}} (\sphinxstyleliteralemphasis{\sphinxupquote{input\_list}}) \textendash{} The list to copy
7782
7783 \item[{Returns}] \leavevmode
7784 The copy of the list
7785
7786 \item[{Return type}] \leavevmode
7787 List
7788
7789 \end{description}\end{quote}
7790
7791 \end{fulllineitems}
7792
7793 \index{ensure\_path\_exists() (in module src)}
7794
7795 \begin{fulllineitems}
7796 \phantomsection\label{\detokenize{commands/apidoc/src:src.ensure_path_exists}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{ensure\_path\_exists}}}{\emph{p}}{}
7797 Create a path if not existing
7798 \begin{quote}\begin{description}
7799 \item[{Parameters}] \leavevmode
7800 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{p}}) \textendash{} The path.
7801
7802 \end{description}\end{quote}
7803
7804 \end{fulllineitems}
7805
7806 \index{find\_file\_in\_lpath() (in module src)}
7807
7808 \begin{fulllineitems}
7809 \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=''}}{}
7810 Find in all the directories in lpath list the file that has the same name
7811 as file\_name.
7812 If it is found
7813 then return the full path of the file
7814 else return False.
7815
7816 The additional\_dir (optional) is the name of the directory to add to all
7817 paths in lpath.
7818 \begin{quote}\begin{description}
7819 \item[{Parameters}] \leavevmode\begin{itemize}
7820 \item {}
7821 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{additional\_dir}}) \textendash{} The file name to search
7822
7823 \item {}
7824 \sphinxstyleliteralstrong{\sphinxupquote{List}} (\sphinxstyleliteralemphasis{\sphinxupquote{lpath}}) \textendash{} The list of directories where to search
7825
7826 \item {}
7827 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The name of the additional directory
7828
7829 \end{itemize}
7830
7831 \item[{Returns}] \leavevmode
7832 the full path of the file or False if not found
7833
7834 \item[{Return type}] \leavevmode
7835 str
7836
7837 \end{description}\end{quote}
7838
7839 \end{fulllineitems}
7840
7841 \index{get\_base\_path() (in module src)}
7842
7843 \begin{fulllineitems}
7844 \phantomsection\label{\detokenize{commands/apidoc/src:src.get_base_path}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{get\_base\_path}}}{\emph{config}}{}
7845 Returns the path of the products base.
7846 \begin{quote}\begin{description}
7847 \item[{Parameters}] \leavevmode
7848 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} The global Config instance.
7849
7850 \item[{Returns}] \leavevmode
7851 The path of the products base.
7852
7853 \item[{Return type}] \leavevmode
7854 str
7855
7856 \end{description}\end{quote}
7857
7858 \end{fulllineitems}
7859
7860 \index{get\_cfg\_param() (in module src)}
7861
7862 \begin{fulllineitems}
7863 \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}}{}
7864 eearch for param\_name value in config.
7865 if param\_name is not in config
7866 then return default,
7867 else return the found value
7868 \begin{quote}\begin{description}
7869 \item[{Parameters}] \leavevmode\begin{itemize}
7870 \item {}
7871 \sphinxstyleliteralstrong{\sphinxupquote{class 'common.pyconf.Config'}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} The config.
7872
7873 \item {}
7874 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{default}}) \textendash{} the name of the parameter to get the value
7875
7876 \item {}
7877 \sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The value to return if param\_name is not in config
7878
7879 \end{itemize}
7880
7881 \item[{Returns}] \leavevmode
7882 see initial description of the function
7883
7884 \item[{Return type}] \leavevmode
7885 str
7886
7887 \end{description}\end{quote}
7888
7889 \end{fulllineitems}
7890
7891 \index{get\_launcher\_name() (in module src)}
7892
7893 \begin{fulllineitems}
7894 \phantomsection\label{\detokenize{commands/apidoc/src:src.get_launcher_name}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{get\_launcher\_name}}}{\emph{config}}{}
7895 Returns the name of salome launcher.
7896 \begin{quote}\begin{description}
7897 \item[{Parameters}] \leavevmode
7898 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} The global Config instance.
7899
7900 \item[{Returns}] \leavevmode
7901 The name of salome launcher.
7902
7903 \item[{Return type}] \leavevmode
7904 str
7905
7906 \end{description}\end{quote}
7907
7908 \end{fulllineitems}
7909
7910 \index{get\_log\_path() (in module src)}
7911
7912 \begin{fulllineitems}
7913 \phantomsection\label{\detokenize{commands/apidoc/src:src.get_log_path}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{get\_log\_path}}}{\emph{config}}{}
7914 Returns the path of the logs.
7915 \begin{quote}\begin{description}
7916 \item[{Parameters}] \leavevmode
7917 \sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} The global Config instance.
7918
7919 \item[{Returns}] \leavevmode
7920 The path of the logs.
7921
7922 \item[{Return type}] \leavevmode
7923 str
7924
7925 \end{description}\end{quote}
7926
7927 \end{fulllineitems}
7928
7929 \index{get\_property\_in\_product\_cfg() (in module src)}
7930
7931 \begin{fulllineitems}
7932 \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}}{}
7933 \end{fulllineitems}
7934
7935 \index{get\_salome\_version() (in module src)}
7936
7937 \begin{fulllineitems}
7938 \phantomsection\label{\detokenize{commands/apidoc/src:src.get_salome_version}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{get\_salome\_version}}}{\emph{config}}{}
7939 \end{fulllineitems}
7940
7941 \index{get\_tmp\_filename() (in module src)}
7942
7943 \begin{fulllineitems}
7944 \phantomsection\label{\detokenize{commands/apidoc/src:src.get_tmp_filename}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{get\_tmp\_filename}}}{\emph{cfg}, \emph{name}}{}
7945 \end{fulllineitems}
7946
7947 \index{handleRemoveReadonly() (in module src)}
7948
7949 \begin{fulllineitems}
7950 \phantomsection\label{\detokenize{commands/apidoc/src:src.handleRemoveReadonly}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{handleRemoveReadonly}}}{\emph{func}, \emph{path}, \emph{exc}}{}
7951 \end{fulllineitems}
7952
7953 \index{merge\_dicts() (in module src)}
7954
7955 \begin{fulllineitems}
7956 \phantomsection\label{\detokenize{commands/apidoc/src:src.merge_dicts}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{merge\_dicts}}}{\emph{*dict\_args}}{}
7957 Given any number of dicts, shallow copy and merge into a new dict,
7958 precedence goes to key value pairs in latter dicts.
7959
7960 \end{fulllineitems}
7961
7962 \index{only\_numbers() (in module src)}
7963
7964 \begin{fulllineitems}
7965 \phantomsection\label{\detokenize{commands/apidoc/src:src.only_numbers}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{only\_numbers}}}{\emph{str\_num}}{}
7966 \end{fulllineitems}
7967
7968 \index{parse\_date() (in module src)}
7969
7970 \begin{fulllineitems}
7971 \phantomsection\label{\detokenize{commands/apidoc/src:src.parse_date}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{parse\_date}}}{\emph{date}}{}
7972 Transform YYYYMMDD\_hhmmss into YYYY-MM-DD hh:mm:ss.
7973 \begin{quote}\begin{description}
7974 \item[{Parameters}] \leavevmode
7975 \sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{date}}) \textendash{} The date to transform
7976
7977 \item[{Returns}] \leavevmode
7978 The date in the new format
7979
7980 \item[{Return type}] \leavevmode
7981 str
7982
7983 \end{description}\end{quote}
7984
7985 \end{fulllineitems}
7986
7987 \index{print\_info() (in module src)}
7988
7989 \begin{fulllineitems}
7990 \phantomsection\label{\detokenize{commands/apidoc/src:src.print_info}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.}}\sphinxbfcode{\sphinxupquote{print\_info}}}{\emph{logger}, \emph{info}}{}
7991 Prints the tuples that are in info variable in a formatted way.
7992 \begin{quote}\begin{description}
7993 \item[{Parameters}] \leavevmode\begin{itemize}
7994 \item {}
7995 \sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logging instance to use for the prints.
7996
7997 \item {}
7998 \sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{info}}) \textendash{} The list of tuples to display
7999
8000 \end{itemize}
8001
8002 \end{description}\end{quote}
8003
8004 \end{fulllineitems}
8005
8006 \index{read\_config\_from\_a\_file() (in module src)}
8007
8008 \begin{fulllineitems}
8009 \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}}{}
8010 \end{fulllineitems}
8011
8012 \index{remove\_item\_from\_list() (in module src)}
8013
8014 \begin{fulllineitems}
8015 \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}}{}
8016 Remove all occurences of item from input\_list
8017 \begin{quote}\begin{description}
8018 \item[{Parameters}] \leavevmode
8019 \sphinxstyleliteralstrong{\sphinxupquote{List}} (\sphinxstyleliteralemphasis{\sphinxupquote{input\_list}}) \textendash{} The list to modify
8020
8021 \item[{Returns}] \leavevmode
8022 The without any item
8023
8024 \item[{Return type}] \leavevmode
8025 List
8026
8027 \end{description}\end{quote}
8028
8029 \end{fulllineitems}
8030
8031 \index{replace\_in\_file() (in module src)}
8032
8033 \begin{fulllineitems}
8034 \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}}{}
8035 Replace \textless{}strin\textgreater{} by \textless{}strout\textgreater{} in file \textless{}filein\textgreater{}
8036
8037 \end{fulllineitems}
8038
8039
8040
8041 \chapter{Release Notes}
8042 \label{\detokenize{index:release-notes}}
8043
8044 \section{Release notes}
8045 \label{\detokenize{release_notes/release_notes_5.0.0:release-notes}}\label{\detokenize{release_notes/release_notes_5.0.0::doc}}
8046 In construction.
8047
8048
8049 \renewcommand{\indexname}{Python Module Index}
8050 \begin{sphinxtheindex}
8051 \def\bigletter#1{{\Large\sffamily#1}\nopagebreak\vspace{1mm}}
8052 \bigletter{s}
8053 \item {\sphinxstyleindexentry{src}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src}}
8054 \item {\sphinxstyleindexentry{src.architecture}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.architecture}}
8055 \item {\sphinxstyleindexentry{src.colorama}}\sphinxstyleindexpageref{commands/apidoc/src.colorama:\detokenize{module-src.colorama}}
8056 \item {\sphinxstyleindexentry{src.colorama.ansi}}\sphinxstyleindexpageref{commands/apidoc/src.colorama:\detokenize{module-src.colorama.ansi}}
8057 \item {\sphinxstyleindexentry{src.colorama.ansitowin32}}\sphinxstyleindexpageref{commands/apidoc/src.colorama:\detokenize{module-src.colorama.ansitowin32}}
8058 \item {\sphinxstyleindexentry{src.colorama.initialise}}\sphinxstyleindexpageref{commands/apidoc/src.colorama:\detokenize{module-src.colorama.initialise}}
8059 \item {\sphinxstyleindexentry{src.colorama.win32}}\sphinxstyleindexpageref{commands/apidoc/src.colorama:\detokenize{module-src.colorama.win32}}
8060 \item {\sphinxstyleindexentry{src.colorama.winterm}}\sphinxstyleindexpageref{commands/apidoc/src.colorama:\detokenize{module-src.colorama.winterm}}
8061 \item {\sphinxstyleindexentry{src.compilation}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.compilation}}
8062 \item {\sphinxstyleindexentry{src.debug}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.debug}}
8063 \item {\sphinxstyleindexentry{src.ElementTree}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.ElementTree}}
8064 \item {\sphinxstyleindexentry{src.environment}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.environment}}
8065 \item {\sphinxstyleindexentry{src.fileEnviron}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.fileEnviron}}
8066 \item {\sphinxstyleindexentry{src.fork}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.fork}}
8067 \item {\sphinxstyleindexentry{src.logger}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.logger}}
8068 \item {\sphinxstyleindexentry{src.options}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.options}}
8069 \item {\sphinxstyleindexentry{src.printcolors}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.printcolors}}
8070 \item {\sphinxstyleindexentry{src.product}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.product}}
8071 \item {\sphinxstyleindexentry{src.pyconf}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.pyconf}}
8072 \item {\sphinxstyleindexentry{src.system}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.system}}
8073 \item {\sphinxstyleindexentry{src.template}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.template}}
8074 \item {\sphinxstyleindexentry{src.test\_module}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.test_module}}
8075 \item {\sphinxstyleindexentry{src.xmlManager}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.xmlManager}}
8076 \end{sphinxtheindex}
8077
8078 \renewcommand{\indexname}{Index}
8079 \printindex
8080 \end{document}