From: Christian Van Wambeke Date: Tue, 24 Apr 2018 11:31:06 +0000 (+0200) Subject: add doc/build for EZ direct html or pdf X-Git-Tag: 5.1.0~35 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=a99a6f7bf7be23bb64bdd090ab709d14498449f4;p=tools%2Fsat.git add doc/build for EZ direct html or pdf --- diff --git a/.gitignore b/.gitignore index 86431c4..2337686 100644 --- a/.gitignore +++ b/.gitignore @@ -7,7 +7,8 @@ sat-py3 .pydevproject .project .settings -doc/build +# doc/build +doc/build/latex/salomeTools.log .coverage test/htmlcov test/test_res.html diff --git a/doc/build/doctrees/commands/apidoc/modules.doctree b/doc/build/doctrees/commands/apidoc/modules.doctree new file mode 100644 index 0000000..253388e Binary files /dev/null and b/doc/build/doctrees/commands/apidoc/modules.doctree differ diff --git a/doc/build/doctrees/commands/apidoc/src.colorama.doctree b/doc/build/doctrees/commands/apidoc/src.colorama.doctree new file mode 100644 index 0000000..a675d20 Binary files /dev/null and b/doc/build/doctrees/commands/apidoc/src.colorama.doctree differ diff --git a/doc/build/doctrees/commands/apidoc/src.doctree b/doc/build/doctrees/commands/apidoc/src.doctree new file mode 100644 index 0000000..635ba6e Binary files /dev/null and b/doc/build/doctrees/commands/apidoc/src.doctree differ diff --git a/doc/build/doctrees/commands/application.doctree b/doc/build/doctrees/commands/application.doctree new file mode 100644 index 0000000..90f3f1b Binary files /dev/null and b/doc/build/doctrees/commands/application.doctree differ diff --git a/doc/build/doctrees/commands/clean.doctree b/doc/build/doctrees/commands/clean.doctree new file mode 100644 index 0000000..3fb9817 Binary files /dev/null and b/doc/build/doctrees/commands/clean.doctree differ diff --git a/doc/build/doctrees/commands/compile.doctree b/doc/build/doctrees/commands/compile.doctree new file mode 100644 index 0000000..a595a1e Binary files /dev/null and b/doc/build/doctrees/commands/compile.doctree differ diff --git a/doc/build/doctrees/commands/config.doctree b/doc/build/doctrees/commands/config.doctree new file mode 100644 index 0000000..52f56f6 Binary files /dev/null and b/doc/build/doctrees/commands/config.doctree differ diff --git a/doc/build/doctrees/commands/environ.doctree b/doc/build/doctrees/commands/environ.doctree new file mode 100644 index 0000000..6266339 Binary files /dev/null and b/doc/build/doctrees/commands/environ.doctree differ diff --git a/doc/build/doctrees/commands/generate.doctree b/doc/build/doctrees/commands/generate.doctree new file mode 100644 index 0000000..ec0b4ff Binary files /dev/null and b/doc/build/doctrees/commands/generate.doctree differ diff --git a/doc/build/doctrees/commands/launcher.doctree b/doc/build/doctrees/commands/launcher.doctree new file mode 100644 index 0000000..b0c39c2 Binary files /dev/null and b/doc/build/doctrees/commands/launcher.doctree differ diff --git a/doc/build/doctrees/commands/log.doctree b/doc/build/doctrees/commands/log.doctree new file mode 100644 index 0000000..9cc7f15 Binary files /dev/null and b/doc/build/doctrees/commands/log.doctree differ diff --git a/doc/build/doctrees/commands/package.doctree b/doc/build/doctrees/commands/package.doctree new file mode 100644 index 0000000..4ca44f4 Binary files /dev/null and b/doc/build/doctrees/commands/package.doctree differ diff --git a/doc/build/doctrees/commands/prepare.doctree b/doc/build/doctrees/commands/prepare.doctree new file mode 100644 index 0000000..abc1a31 Binary files /dev/null and b/doc/build/doctrees/commands/prepare.doctree differ diff --git a/doc/build/doctrees/configuration.doctree b/doc/build/doctrees/configuration.doctree new file mode 100644 index 0000000..c6d9f05 Binary files /dev/null and b/doc/build/doctrees/configuration.doctree differ diff --git a/doc/build/doctrees/environment.pickle b/doc/build/doctrees/environment.pickle new file mode 100644 index 0000000..8b1f6c4 Binary files /dev/null and b/doc/build/doctrees/environment.pickle differ diff --git a/doc/build/doctrees/index.doctree b/doc/build/doctrees/index.doctree new file mode 100644 index 0000000..42a530f Binary files /dev/null and b/doc/build/doctrees/index.doctree differ diff --git a/doc/build/doctrees/installation_of_sat.doctree b/doc/build/doctrees/installation_of_sat.doctree new file mode 100644 index 0000000..62e5233 Binary files /dev/null and b/doc/build/doctrees/installation_of_sat.doctree differ diff --git a/doc/build/doctrees/release_notes/release_notes_5.0.0.doctree b/doc/build/doctrees/release_notes/release_notes_5.0.0.doctree new file mode 100644 index 0000000..109e83a Binary files /dev/null and b/doc/build/doctrees/release_notes/release_notes_5.0.0.doctree differ diff --git a/doc/build/doctrees/usage_of_sat.doctree b/doc/build/doctrees/usage_of_sat.doctree new file mode 100644 index 0000000..155a84a Binary files /dev/null and b/doc/build/doctrees/usage_of_sat.doctree differ diff --git a/doc/build/doctrees/write_command.doctree b/doc/build/doctrees/write_command.doctree new file mode 100644 index 0000000..3e7d2af Binary files /dev/null and b/doc/build/doctrees/write_command.doctree differ diff --git a/doc/build/html/.buildinfo b/doc/build/html/.buildinfo new file mode 100644 index 0000000..1d98c1d --- /dev/null +++ b/doc/build/html/.buildinfo @@ -0,0 +1,4 @@ +# Sphinx build info version 1 +# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. +config: 2c4d344051e59f2c4840e68130e38438 +tags: fbb0d17656682115ca4d033fb2f83ba1 diff --git a/doc/build/html/_images/sat_about.png b/doc/build/html/_images/sat_about.png new file mode 100644 index 0000000..600d3d8 Binary files /dev/null and b/doc/build/html/_images/sat_about.png differ diff --git a/doc/build/html/_modules/index.html b/doc/build/html/_modules/index.html new file mode 100644 index 0000000..29da883 --- /dev/null +++ b/doc/build/html/_modules/index.html @@ -0,0 +1,114 @@ + + + + + + + + + Overview: module code — salomeTools 5.0.0dev documentation + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+ +

All modules for which code is available

+ + +
+
+
+
+
+
+

Related Topics

+ +
+ + +
+
+
+
+
+ ©2018, CEA. + + | + Powered by Sphinx 1.1.3 + & Alabaster + +
+ + + + + + \ No newline at end of file diff --git a/doc/build/html/_modules/src/ElementTree.html b/doc/build/html/_modules/src/ElementTree.html new file mode 100644 index 0000000..a9af586 --- /dev/null +++ b/doc/build/html/_modules/src/ElementTree.html @@ -0,0 +1,1393 @@ + + + + + + + + + src.ElementTree — salomeTools 5.0.0dev documentation + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+ +

Source code for src.ElementTree

+#
+# ElementTree
+# $Id: ElementTree.py 2326 2005-03-17 07:45:21Z fredrik $
+#
+# light-weight XML support for Python 1.5.2 and later.
+#
+# history:
+# 2001-10-20 fl   created (from various sources)
+# 2001-11-01 fl   return root from parse method
+# 2002-02-16 fl   sort attributes in lexical order
+# 2002-04-06 fl   TreeBuilder refactoring, added PythonDoc markup
+# 2002-05-01 fl   finished TreeBuilder refactoring
+# 2002-07-14 fl   added basic namespace support to ElementTree.write
+# 2002-07-25 fl   added QName attribute support
+# 2002-10-20 fl   fixed encoding in write
+# 2002-11-24 fl   changed default encoding to ascii; fixed attribute encoding
+# 2002-11-27 fl   accept file objects or file names for parse/write
+# 2002-12-04 fl   moved XMLTreeBuilder back to this module
+# 2003-01-11 fl   fixed entity encoding glitch for us-ascii
+# 2003-02-13 fl   added XML literal factory
+# 2003-02-21 fl   added ProcessingInstruction/PI factory
+# 2003-05-11 fl   added tostring/fromstring helpers
+# 2003-05-26 fl   added ElementPath support
+# 2003-07-05 fl   added makeelement factory method
+# 2003-07-28 fl   added more well-known namespace prefixes
+# 2003-08-15 fl   fixed typo in ElementTree.findtext (Thomas Dartsch)
+# 2003-09-04 fl   fall back on emulator if ElementPath is not installed
+# 2003-10-31 fl   markup updates
+# 2003-11-15 fl   fixed nested namespace bug
+# 2004-03-28 fl   added XMLID helper
+# 2004-06-02 fl   added default support to findtext
+# 2004-06-08 fl   fixed encoding of non-ascii element/attribute names
+# 2004-08-23 fl   take advantage of post-2.1 expat features
+# 2005-02-01 fl   added iterparse implementation
+# 2005-03-02 fl   fixed iterparse support for pre-2.2 versions
+#
+# Copyright (c) 1999-2005 by Fredrik Lundh.  All rights reserved.
+#
+# fredrik@pythonware.com
+# http://www.pythonware.com
+#
+# --------------------------------------------------------------------
+# The ElementTree toolkit is
+#
+# Copyright (c) 1999-2005 by Fredrik Lundh
+#
+# By obtaining, using, and/or copying this software and/or its
+# associated documentation, you agree that you have read, understood,
+# and will comply with the following terms and conditions:
+#
+# Permission to use, copy, modify, and distribute this software and
+# its associated documentation for any purpose and without fee is
+# hereby granted, provided that the above copyright notice appears in
+# all copies, and that both that copyright notice and this permission
+# notice appear in supporting documentation, and that the name of
+# Secret Labs AB or the author not be used in advertising or publicity
+# pertaining to distribution of the software without specific, written
+# prior permission.
+#
+# SECRET LABS AB AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD
+# TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANT-
+# ABILITY AND FITNESS.  IN NO EVENT SHALL SECRET LABS AB OR THE AUTHOR
+# BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY
+# DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
+# WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
+# ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
+# OF THIS SOFTWARE.
+# --------------------------------------------------------------------
+
+__all__ = [
+    # public symbols
+    "Comment",
+    "dump",
+    "Element", "ElementTree",
+    "fromstring",
+    "iselement", "iterparse",
+    "parse",
+    "PI", "ProcessingInstruction",
+    "QName",
+    "SubElement",
+    "tostring",
+    "TreeBuilder",
+    "VERSION", "XML",
+    "XMLTreeBuilder",
+    ]
+
+##
+# The <b>Element</b> type is a flexible container object, designed to
+# store hierarchical data structures in memory. The type can be
+# described as a cross between a list and a dictionary.
+# <p>
+# Each element has a number of properties associated with it:
+# <ul>
+# <li>a <i>tag</i>. This is a string identifying what kind of data
+# this element represents (the element type, in other words).</li>
+# <li>a number of <i>attributes</i>, stored in a Python dictionary.</li>
+# <li>a <i>text</i> string.</li>
+# <li>an optional <i>tail</i> string.</li>
+# <li>a number of <i>child elements</i>, stored in a Python sequence</li>
+# </ul>
+#
+# To create an element instance, use the {@link #Element} or {@link
+# #SubElement} factory functions.
+# <p>
+# The {@link #ElementTree} class can be used to wrap an element
+# structure, and convert it from and to XML.
+##
+
+import string, sys, re, platform
+
+class _SimpleElementPath:
+    # emulate pre-1.2 find/findtext/findall behaviour
+    def find(self, element, tag):
+        for elem in element:
+            if elem.tag == tag:
+                return elem
+        return None
+    def findtext(self, element, tag, default=None):
+        for elem in element:
+            if elem.tag == tag:
+                return elem.text or ""
+        return default
+    def findall(self, element, tag):
+        if tag[:3] == ".//":
+            return element.getiterator(tag[3:])
+        result = []
+        for elem in element:
+            if elem.tag == tag:
+                result.append(elem)
+        return result
+
+try:
+    import ElementPath
+except ImportError:
+    # FIXME: issue warning in this case?
+    ElementPath = _SimpleElementPath()
+
+# TODO: add support for custom namespace resolvers/default namespaces
+# TODO: add improved support for incremental parsing
+
+VERSION = "1.2.6"
+
+##
+# Internal element class.  This class defines the Element interface,
+# and provides a reference implementation of this interface.
+# <p>
+# You should not create instances of this class directly.  Use the
+# appropriate factory functions instead, such as {@link #Element}
+# and {@link #SubElement}.
+#
+# @see Element
+# @see SubElement
+# @see Comment
+# @see ProcessingInstruction
+
+class _ElementInterface:
+    # <tag attrib>text<child/>...</tag>tail
+
+    ##
+    # (Attribute) Element tag.
+
+    tag = None
+
+    ##
+    # (Attribute) Element attribute dictionary.  Where possible, use
+    # {@link #_ElementInterface.get},
+    # {@link #_ElementInterface.set},
+    # {@link #_ElementInterface.keys}, and
+    # {@link #_ElementInterface.items} to access
+    # element attributes.
+
+    attrib = None
+
+    ##
+    # (Attribute) Text before first subelement.  This is either a
+    # string or the value None, if there was no text.
+
+    text = None
+
+    ##
+    # (Attribute) Text after this element's end tag, but before the
+    # next sibling element's start tag.  This is either a string or
+    # the value None, if there was no text.
+
+    tail = None # text after end tag, if any
+
+    def __init__(self, tag, attrib):
+        self.tag = tag
+        self.attrib = attrib
+        self._children = []
+
+    def __repr__(self):
+        return "<Element %s at %x>" % (self.tag, id(self))
+
+    ##
+    # Creates a new element object of the same type as this element.
+    #
+    # @param tag Element tag.
+    # @param attrib Element attributes, given as a dictionary.
+    # @return A new element instance.
+
+    def makeelement(self, tag, attrib):
+        return Element(tag, attrib)
+
+    ##
+    # Returns the number of subelements.
+    #
+    # @return The number of subelements.
+
+    def __len__(self):
+        return len(self._children)
+
+    ##
+    # Returns the given subelement.
+    #
+    # @param index What subelement to return.
+    # @return The given subelement.
+    # @exception IndexError If the given element does not exist.
+
+    def __getitem__(self, index):
+        return self._children[index]
+
+    ##
+    # Replaces the given subelement.
+    #
+    # @param index What subelement to replace.
+    # @param element The new element value.
+    # @exception IndexError If the given element does not exist.
+    # @exception AssertionError If element is not a valid object.
+
+    def __setitem__(self, index, element):
+        assert iselement(element)
+        self._children[index] = element
+
+    ##
+    # Deletes the given subelement.
+    #
+    # @param index What subelement to delete.
+    # @exception IndexError If the given element does not exist.
+
+    def __delitem__(self, index):
+        del self._children[index]
+
+    ##
+    # Returns a list containing subelements in the given range.
+    #
+    # @param start The first subelement to return.
+    # @param stop The first subelement that shouldn't be returned.
+    # @return A sequence object containing subelements.
+
+    def __getslice__(self, start, stop):
+        return self._children[start:stop]
+
+    ##
+    # Replaces a number of subelements with elements from a sequence.
+    #
+    # @param start The first subelement to replace.
+    # @param stop The first subelement that shouldn't be replaced.
+    # @param elements A sequence object with zero or more elements.
+    # @exception AssertionError If a sequence member is not a valid object.
+
+    def __setslice__(self, start, stop, elements):
+        for element in elements:
+            assert iselement(element)
+        self._children[start:stop] = list(elements)
+
+    ##
+    # Deletes a number of subelements.
+    #
+    # @param start The first subelement to delete.
+    # @param stop The first subelement to leave in there.
+
+    def __delslice__(self, start, stop):
+        del self._children[start:stop]
+
+    ##
+    # Adds a subelement to the end of this element.
+    #
+    # @param element The element to add.
+    # @exception AssertionError If a sequence member is not a valid object.
+
+    def append(self, element):
+        assert iselement(element)
+        self._children.append(element)
+
+    ##
+    # Inserts a subelement at the given position in this element.
+    #
+    # @param index Where to insert the new subelement.
+    # @exception AssertionError If the element is not a valid object.
+
+    def insert(self, index, element):
+        assert iselement(element)
+        self._children.insert(index, element)
+
+    ##
+    # Removes a matching subelement.  Unlike the <b>find</b> methods,
+    # this method compares elements based on identity, not on tag
+    # value or contents.
+    #
+    # @param element What element to remove.
+    # @exception ValueError If a matching element could not be found.
+    # @exception AssertionError If the element is not a valid object.
+
+    def remove(self, element):
+        assert iselement(element)
+        self._children.remove(element)
+
+    ##
+    # Returns all subelements.  The elements are returned in document
+    # order.
+    #
+    # @return A list of subelements.
+    # @defreturn list of Element instances
+
+    def getchildren(self):
+        return self._children
+
+    ##
+    # Finds the first matching subelement, by tag name or path.
+    #
+    # @param path What element to look for.
+    # @return The first matching element, or None if no element was found.
+    # @defreturn Element or None
+
+    def find(self, path):
+        if ElementPath.find(self, path) == None:
+            return ElementPath.find(self, path.encode())
+        return ElementPath.find(self, path)
+
+    ##
+    # Finds text for the first matching subelement, by tag name or path.
+    #
+    # @param path What element to look for.
+    # @param default What to return if the element was not found.
+    # @return The text content of the first matching element, or the
+    #     default value no element was found.  Note that if the element
+    #     has is found, but has no text content, this method returns an
+    #     empty string.
+    # @defreturn string
+
+    def findtext(self, path, default=None):
+        return ElementPath.findtext(self, path, default)
+
+    ##
+    # Finds all matching subelements, by tag name or path.
+    #
+    # @param path What element to look for.
+    # @return A list or iterator containing all matching elements,
+    #    in document order.
+    # @defreturn list of Element instances
+
+    def findall(self, path):
+        return ElementPath.findall(self, path)
+
+    ##
+    # Resets an element.  This function removes all subelements, clears
+    # all attributes, and sets the text and tail attributes to None.
+
+    def clear(self):
+        self.attrib.clear()
+        self._children = []
+        self.text = self.tail = None
+
+    ##
+    # Gets an element attribute.
+    #
+    # @param key What attribute to look for.
+    # @param default What to return if the attribute was not found.
+    # @return The attribute value, or the default value, if the
+    #     attribute was not found.
+    # @defreturn string or None
+
+    def get(self, key, default=None):
+        res = self.attrib.get(key, default)
+        if not res:
+            res = self.attrib.get(key.encode(), default)
+        if isinstance(res, bytes):
+            return res.decode()
+        else:
+            return res
+
+    ##
+    # Sets an element attribute.
+    #
+    # @param key What attribute to set.
+    # @param value The attribute value.
+
+    def set(self, key, value):
+        self.attrib[key] = value
+
+    ##
+    # Gets a list of attribute names.  The names are returned in an
+    # arbitrary order (just like for an ordinary Python dictionary).
+    #
+    # @return A list of element attribute names.
+    # @defreturn list of strings
+
+    def keys(self):
+        res = []
+        for key in self.attrib.keys():
+            if isinstance(key, bytes):
+                res.append(key.decode())
+            else:
+                res.append(key)
+        return res
+                
+    ##
+    # Gets element attributes, as a sequence.  The attributes are
+    # returned in an arbitrary order.
+    #
+    # @return A list of (name, value) tuples for all attributes.
+    # @defreturn list of (string, string) tuples
+
+    def items(self):
+        return self.attrib.items()
+
+    ##
+    # Creates a tree iterator.  The iterator loops over this element
+    # and all subelements, in document order, and returns all elements
+    # with a matching tag.
+    # <p>
+    # If the tree structure is modified during iteration, the result
+    # is undefined.
+    #
+    # @param tag What tags to look for (default is to return all elements).
+    # @return A list or iterator containing all the matching elements.
+    # @defreturn list or iterator
+
+    def getiterator(self, tag=None):
+        nodes = []
+        if tag == "*":
+            tag = None
+        if tag is None or self.tag == tag:
+            nodes.append(self)
+        for node in self._children:
+            nodes.extend(node.getiterator(tag))
+        return nodes
+
+# compatibility
+_Element = _ElementInterface
+
+##
+# Element factory.  This function returns an object implementing the
+# standard Element interface.  The exact class or type of that object
+# is implementation dependent, but it will always be compatible with
+# the {@link #_ElementInterface} class in this module.
+# <p>
+# The element name, attribute names, and attribute values can be
+# either 8-bit ASCII strings or Unicode strings.
+#
+# @param tag The element name.
+# @param attrib An optional dictionary, containing element attributes.
+# @param **extra Additional attributes, given as keyword arguments.
+# @return An element instance.
+# @defreturn Element
+
+
[docs]def Element(tag, attrib={}, **extra):
+    attrib = attrib.copy()
+    attrib.update(extra)
+    return _ElementInterface(tag, attrib)
+
+##
+# Subelement factory.  This function creates an element instance, and
+# appends it to an existing element.
+# <p>
+# The element name, attribute names, and attribute values can be
+# either 8-bit ASCII strings or Unicode strings.
+#
+# @param parent The parent element.
+# @param tag The subelement name.
+# @param attrib An optional dictionary, containing element attributes.
+# @param **extra Additional attributes, given as keyword arguments.
+# @return An element instance.
+# @defreturn Element
+

+
[docs]def SubElement(parent, tag, attrib={}, **extra):
+    attrib = attrib.copy()
+    attrib.update(extra)
+    element = parent.makeelement(tag, attrib)
+    parent.append(element)
+    return element
+
+##
+# Comment element factory.  This factory function creates a special
+# element that will be serialized as an XML comment.
+# <p>
+# The comment string can be either an 8-bit ASCII string or a Unicode
+# string.
+#
+# @param text A string containing the comment string.
+# @return An element instance, representing a comment.
+# @defreturn Element
+

+
[docs]def Comment(text=None):
+    element = Element(Comment)
+    element.text = text
+    return element
+
+##
+# PI element factory.  This factory function creates a special element
+# that will be serialized as an XML processing instruction.
+#
+# @param target A string containing the PI target.
+# @param text A string containing the PI contents, if any.
+# @return An element instance, representing a PI.
+# @defreturn Element
+

+
[docs]def ProcessingInstruction(target, text=None):
+    element = Element(ProcessingInstruction)
+    element.text = target
+    if text:
+        element.text = element.text + " " + text
+    return element
+

+PI = ProcessingInstruction
+
+##
+# QName wrapper.  This can be used to wrap a QName attribute value, in
+# order to get proper namespace handling on output.
+#
+# @param text A string containing the QName value, in the form {uri}local,
+#     or, if the tag argument is given, the URI part of a QName.
+# @param tag Optional tag.  If given, the first argument is interpreted as
+#     an URI, and this argument is interpreted as a local name.
+# @return An opaque object, representing the QName.
+
+
[docs]class QName:
+    def __init__(self, text_or_uri, tag=None):
+        if tag:
+            text_or_uri = "{%s}%s" % (text_or_uri, tag)
+        self.text = text_or_uri
+    def __str__(self):
+        return self.text
+    def __hash__(self):
+        return hash(self.text)
+    def __cmp__(self, other):
+        if isinstance(other, QName):
+            return cmp(self.text, other.text)
+        return cmp(self.text, other)
+
+##
+# ElementTree wrapper class.  This class represents an entire element
+# hierarchy, and adds some extra support for serialization to and from
+# standard XML.
+#
+# @param element Optional root element.
+# @keyparam file Optional file handle or name.  If given, the
+#     tree is initialized with the contents of this XML file.
+

+
[docs]class ElementTree:
+
+    def __init__(self, element=None, file=None):
+        assert element is None or iselement(element)
+        self._root = element # first node
+        if file:
+            self.parse(file)
+
+    ##
+    # Gets the root element for this tree.
+    #
+    # @return An element instance.
+    # @defreturn Element
+
+
[docs]    def getroot(self):
+        return self._root
+
+    ##
+    # Replaces the root element for this tree.  This discards the
+    # current contents of the tree, and replaces it with the given
+    # element.  Use with care.
+    #
+    # @param element An element instance.
+

+    def _setroot(self, element):
+        assert iselement(element)
+        self._root = element
+
+    ##
+    # Loads an external XML document into this element tree.
+    #
+    # @param source A file name or file object.
+    # @param parser An optional parser instance.  If not given, the
+    #     standard {@link XMLTreeBuilder} parser is used.
+    # @return The document root element.
+    # @defreturn Element
+
+
[docs]    def parse(self, source, parser=None):
+        if not hasattr(source, "read"):
+            # OP 14/11/2017 Ajout de traces pour essayer de decouvrir le pb
+            #               de remontee de log des tests
+            #print "TRACES OP - ElementTree.py/ElementTree.parse() source = '#%s#'" %source
+            source = open(source, "rb")
+        if not parser:
+            parser = XMLTreeBuilder()
+        while 1:
+            data = source.read(32768)
+            if not data:
+                break
+            parser.feed(data)
+        self._root = parser.close()
+        return self._root
+
+    ##
+    # Creates a tree iterator for the root element.  The iterator loops
+    # over all elements in this tree, in document order.
+    #
+    # @param tag What tags to look for (default is to return all elements)
+    # @return An iterator.
+    # @defreturn iterator
+

+
[docs]    def getiterator(self, tag=None):
+        assert self._root is not None
+        return self._root.getiterator(tag)
+
+    ##
+    # Finds the first toplevel element with given tag.
+    # Same as getroot().find(path).
+    #
+    # @param path What element to look for.
+    # @return The first matching element, or None if no element was found.
+    # @defreturn Element or None
+

+
[docs]    def find(self, path):
+        assert self._root is not None
+        if path[:1] == "/":
+            path = "." + path
+        return self._root.find(path)
+
+    ##
+    # Finds the element text for the first toplevel element with given
+    # tag.  Same as getroot().findtext(path).
+    #
+    # @param path What toplevel element to look for.
+    # @param default What to return if the element was not found.
+    # @return The text content of the first matching element, or the
+    #     default value no element was found.  Note that if the element
+    #     has is found, but has no text content, this method returns an
+    #     empty string.
+    # @defreturn string
+

+
[docs]    def findtext(self, path, default=None):
+        assert self._root is not None
+        if path[:1] == "/":
+            path = "." + path
+        return self._root.findtext(path, default)
+
+    ##
+    # Finds all toplevel elements with the given tag.
+    # Same as getroot().findall(path).
+    #
+    # @param path What element to look for.
+    # @return A list or iterator containing all matching elements,
+    #    in document order.
+    # @defreturn list of Element instances
+

+
[docs]    def findall(self, path):
+        assert self._root is not None
+        if path[:1] == "/":
+            path = "." + path
+        return self._root.findall(path)
+
+    ##
+    # Writes the element tree to a file, as XML.
+    #
+    # @param file A file name, or a file object opened for writing.
+    # @param encoding Optional output encoding (default is US-ASCII).
+

+
[docs]    def write(self, file, encoding="us-ascii"):
+        assert self._root is not None
+        if not hasattr(file, "write"):
+            file = open(file, "wb")
+        if not encoding:
+            encoding = "us-ascii"
+        elif encoding != "utf-8" and encoding != "us-ascii":
+            file.write("<?xml version='1.0' encoding='%s'?>\n" % encoding)
+        self._write(file, self._root, encoding, {})
+

+    def _write(self, file, node, encoding, namespaces, margin=0):
+        # write XML to file
+        tag = node.tag
+        if tag is Comment:
+            file.write("<!-- %s -->\n" % _escape_cdata(node.text, encoding))
+        elif tag is ProcessingInstruction:
+            file.write("<?%s?>\n" % _escape_cdata(node.text, encoding))
+        else:
+            items = node.items()
+            xmlns_items = [] # new namespaces in this scope
+            try:
+                if isinstance(tag, QName) or tag[:1] == "{":
+                    tag, xmlns = fixtag(tag, namespaces)
+                    if xmlns: xmlns_items.append(xmlns)
+            except TypeError:
+                _raise_serialization_error(tag)
+            file.write(' ' * margin)
+            file.write(_encode("<", encoding) + _encode(tag, encoding))
+            if items or xmlns_items:
+                items = sorted(items) # lexical order
+                for k, v in items:
+                    try:
+                        if isinstance(k, QName) or k[:1] == "{":
+                            k, xmlns = fixtag(k, namespaces)
+                            if xmlns: xmlns_items.append(xmlns)
+                    except TypeError:
+                        _raise_serialization_error(k)
+                    try:
+                        if isinstance(v, QName):
+                            v, xmlns = fixtag(v, namespaces)
+                            if xmlns: xmlns_items.append(xmlns)
+                    except TypeError:
+                        _raise_serialization_error(v)
+                    file.write(" %s=\"%s\"" % (k,v))
+                for k, v in xmlns_items:
+                    file.write(" %s=\"%s\"" % (k,v))
+            if node.text or len(node):
+                file.write(">")
+                if node.text:
+                    file.write(_escape_cdata(node.text, encoding))
+                if len(node) > 0: file.write("\n")
+                for n in node:
+                    self._write(file, n, encoding, namespaces, margin + 2)
+                if len(node) > 0: file.write(' ' * margin)
+                file.write(_encode("</", encoding) + _encode(tag, encoding) + _encode(">\n", encoding))
+            else:
+                file.write("/>\n")
+            for k, v in xmlns_items:
+                del namespaces[v]
+        if node.tail:
+            file.write(_escape_cdata(node.tail, encoding))
+
+# --------------------------------------------------------------------
+# helpers
+
+##
+# Checks if an object appears to be a valid element object.
+#
+# @param An element instance.
+# @return A true value if this is an element object.
+# @defreturn flag
+

+
[docs]def iselement(element):
+    # FIXME: not sure about this; might be a better idea to look
+    # for tag/attrib/text attributes
+    return isinstance(element, _ElementInterface) or hasattr(element, "tag")
+
+##
+# Writes an element tree or element structure to sys.stdout.  This
+# function should be used for debugging only.
+# <p>
+# The exact output format is implementation dependent.  In this
+# version, it's written as an ordinary XML file.
+#
+# @param elem An element tree or an individual element.
+

+
[docs]def dump(elem):
+    # debugging
+    if not isinstance(elem, ElementTree):
+        elem = ElementTree(elem)
+    elem.write(sys.stdout)
+    tail = elem.getroot().tail
+    if not tail or tail[-1] != "\n":
+        sys.stdout.write("\n")
+

+def _encode(s, encoding):
+    try:
+        return s.encode(encoding)
+    except AttributeError:
+        return s # 1.5.2: assume the string uses the right encoding
+
+if sys.version[:3] == "1.5":
+    _escape = re.compile(r"[&<>\"\x80-\xff]+") # 1.5.2
+else:
+    _escape = re.compile(eval(r'u"[&<>\"\u0080-\uffff]+"'))
+
+_escape_map = {
+    "&": "&amp;",
+    "<": "&lt;",
+    ">": "&gt;",
+    '"': "&quot;",
+}
+
+_namespace_map = {
+    # "well-known" namespace prefixes
+    "http://www.w3.org/XML/1998/namespace": "xml",
+    "http://www.w3.org/1999/xhtml": "html",
+    "http://www.w3.org/1999/02/22-rdf-syntax-ns#": "rdf",
+    "http://schemas.xmlsoap.org/wsdl/": "wsdl",
+}
+
+def _raise_serialization_error(text):
+    raise TypeError(
+        "cannot serialize %r (type %s)" % (text, type(text).__name__)
+        )
+
+def _encode_entity(text, pattern=_escape):
+    # map reserved and non-ascii characters to numerical entities
+    def escape_entities(m, map=_escape_map):
+        out = []
+        append = out.append
+        for char in m.group():
+            text = map.get(char)
+            if text is None:
+                text = "&#%d;" % ord(char)
+            append(text)
+        return string.join(out, "")
+    try:
+        return _encode(pattern.sub(escape_entities, text), "ascii")
+    except TypeError:
+        _raise_serialization_error(text)
+
+#
+# the following functions assume an ascii-compatible encoding
+# (or "utf-16")
+
+def _escape_cdata(text, encoding=None, replace=str.replace):
+    # escape character data
+    try:
+        if platform.python_version()[0] == '2': # python 2.x.y
+            if encoding:
+                try:
+                    text = _encode(text, encoding)
+                except UnicodeError:
+                    return _encode_entity(text)
+            
+        text = replace(text, "&", "&amp;")
+        text = replace(text, "<", "&lt;")
+        text = replace(text, ">", "&gt;")
+        text = replace(text, "####newLine####", "<br \>")
+        if encoding:
+            try:
+                text = _encode(text, encoding)
+            except UnicodeError:
+                return _encode_entity(text)
+        return text
+    except (TypeError, AttributeError):
+        _raise_serialization_error(text)
+
+def _escape_attrib(text, encoding=None, replace=str.replace):
+    # escape attribute value
+    try:
+        text = replace(text, "&", "&amp;")
+        text = replace(text, "'", "&apos;") # FIXME: overkill
+        text = replace(text, "\"", "&quot;")
+        text = replace(text, "<", "&lt;")
+        text = replace(text, ">", "&gt;")
+        if encoding:
+            try:
+                text = _encode(text, encoding)
+            except UnicodeError:
+                return _encode_entity(text)
+        return text
+    except (TypeError, AttributeError):
+        _raise_serialization_error(text)
+
+def fixtag(tag, namespaces):
+    # given a decorated tag (of the form {uri}tag), return prefixed
+    # tag and namespace declaration, if any
+    if isinstance(tag, QName):
+        tag = tag.text
+    namespace_uri, tag = string.split(tag[1:], "}", 1)
+    prefix = namespaces.get(namespace_uri)
+    if prefix is None:
+        prefix = _namespace_map.get(namespace_uri)
+        if prefix is None:
+            prefix = "ns%d" % len(namespaces)
+        namespaces[namespace_uri] = prefix
+        if prefix == "xml":
+            xmlns = None
+        else:
+            xmlns = ("xmlns:%s" % prefix, namespace_uri)
+    else:
+        xmlns = None
+    return "%s:%s" % (prefix, tag), xmlns
+
+##
+# Parses an XML document into an element tree.
+#
+# @param source A filename or file object containing XML data.
+# @param parser An optional parser instance.  If not given, the
+#     standard {@link XMLTreeBuilder} parser is used.
+# @return An ElementTree instance
+
+
[docs]def parse(source, parser=None):
+    # OP 14/11/2017 Ajout de traces pour essayer de decouvrir le pb
+    #               de remontee de log des tests
+    #print "TRACES OP - ElementTree.py/parse() source = '#%s#'" %source
+    tree = ElementTree()
+    tree.parse(source, parser)
+    return tree
+
+##
+# Parses an XML document into an element tree incrementally, and reports
+# what's going on to the user.
+#
+# @param source A filename or file object containing XML data.
+# @param events A list of events to report back.  If omitted, only "end"
+#     events are reported.
+# @return A (event, elem) iterator.
+

+
[docs]class iterparse:
+
+    def __init__(self, source, events=None):
+        if not hasattr(source, "read"):
+            # OP TEST
+            print "iterparse.__init__ source = %s" %source
+            source = open(source, "rb")
+        self._file = source
+        self._events = []
+        self._index = 0
+        self.root = self._root = None
+        self._parser = XMLTreeBuilder()
+        # wire up the parser for event reporting
+        parser = self._parser._parser
+        append = self._events.append
+        if events is None:
+            events = ["end"]
+        for event in events:
+            if event == "start":
+                try:
+                    parser.ordered_attributes = 1
+                    parser.specified_attributes = 1
+                    def handler(tag, attrib_in, event=event, append=append,
+                                start=self._parser._start_list):
+                        append((event, start(tag, attrib_in)))
+                    parser.StartElementHandler = handler
+                except AttributeError:
+                    def handler(tag, attrib_in, event=event, append=append,
+                                start=self._parser._start):
+                        append((event, start(tag, attrib_in)))
+                    parser.StartElementHandler = handler
+            elif event == "end":
+                def handler(tag, event=event, append=append,
+                            end=self._parser._end):
+                    append((event, end(tag)))
+                parser.EndElementHandler = handler
+            elif event == "start-ns":
+                def handler(prefix, uri, event=event, append=append):
+                    try:
+                        uri = _encode(uri, "ascii")
+                    except UnicodeError:
+                        pass
+                    append((event, (prefix or "", uri)))
+                parser.StartNamespaceDeclHandler = handler
+            elif event == "end-ns":
+                def handler(prefix, event=event, append=append):
+                    append((event, None))
+                parser.EndNamespaceDeclHandler = handler
+
+
[docs]    def next(self):
+        while 1:
+            try:
+                item = self._events[self._index]
+            except IndexError:
+                if self._parser is None:
+                    self.root = self._root
+                    try:
+                        raise StopIteration
+                    except NameError:
+                        raise IndexError
+                # load event buffer
+                del self._events[:]
+                self._index = 0
+                data = self._file.read(16384)
+                if data:
+                    self._parser.feed(data)
+                else:
+                    self._root = self._parser.close()
+                    self._parser = None
+            else:
+                self._index = self._index + 1
+                return item
+

+    try:
+        iter
+        def __iter__(self):
+            return self
+    except NameError:
+        def __getitem__(self, index):
+            return self.next()
+
+##
+# Parses an XML document from a string constant.  This function can
+# be used to embed "XML literals" in Python code.
+#
+# @param source A string containing XML data.
+# @return An Element instance.
+# @defreturn Element
+

+
[docs]def XML(text):
+    parser = XMLTreeBuilder()
+    parser.feed(text)
+    return parser.close()
+
+##
+# Parses an XML document from a string constant, and also returns
+# a dictionary which maps from element id:s to elements.
+#
+# @param source A string containing XML data.
+# @return A tuple containing an Element instance and a dictionary.
+# @defreturn (Element, dictionary)
+

+def XMLID(text):
+    parser = XMLTreeBuilder()
+    parser.feed(text)
+    tree = parser.close()
+    ids = {}
+    for elem in tree.getiterator():
+        id = elem.get("id")
+        if id:
+            ids[id] = elem
+    return tree, ids
+
+##
+# Parses an XML document from a string constant.  Same as {@link #XML}.
+#
+# @def fromstring(text)
+# @param source A string containing XML data.
+# @return An Element instance.
+# @defreturn Element
+
+fromstring = XML
+
+##
+# Generates a string representation of an XML element, including all
+# subelements.
+#
+# @param element An Element instance.
+# @return An encoded string containing the XML data.
+# @defreturn string
+
+
[docs]def tostring(element, encoding=None):
+    class dummy:
+        pass
+    data = []
+    file = dummy()
+    file.write = data.append
+    ElementTree(element).write(file, encoding)
+    data2 = []
+    for item in data:
+        if isinstance(item, bytes):
+            item = item.decode()
+        data2.append(item)
+    return "".join(data2)
+
+##
+# Generic element structure builder.  This builder converts a sequence
+# of {@link #TreeBuilder.start}, {@link #TreeBuilder.data}, and {@link
+# #TreeBuilder.end} method calls to a well-formed element structure.
+# <p>
+# You can use this class to build an element structure using a custom XML
+# parser, or a parser for some other XML-like format.
+#
+# @param element_factory Optional element factory.  This factory
+#    is called to create new Element instances, as necessary.
+

+
[docs]class TreeBuilder:
+
+    def __init__(self, element_factory=None):
+        self._data = [] # data collector
+        self._elem = [] # element stack
+        self._last = None # last element
+        self._tail = None # true if we're after an end tag
+        if element_factory is None:
+            element_factory = _ElementInterface
+        self._factory = element_factory
+
+    ##
+    # Flushes the parser buffers, and returns the toplevel documen
+    # element.
+    #
+    # @return An Element instance.
+    # @defreturn Element
+
+
[docs]    def close(self):
+        assert len(self._elem) == 0, "missing end tags"
+        assert self._last != None, "missing toplevel element"
+        return self._last
+

+    def _flush(self):
+        if self._data:
+            if self._last is not None:
+                text = ""
+                for item in self._data:
+                    try:
+                        text += item
+                    except:
+                        text += item.decode()
+                if self._tail:
+                    assert self._last.tail is None, "internal error (tail)"
+                    self._last.tail = text
+                else:
+                    assert self._last.text is None, "internal error (text)"
+                    self._last.text = text
+            self._data = []
+
+    ##
+    # Adds text to the current element.
+    #
+    # @param data A string.  This should be either an 8-bit string
+    #    containing ASCII text, or a Unicode string.
+
+
[docs]    def data(self, data):
+        self._data.append(data)
+
+    ##
+    # Opens a new element.
+    #
+    # @param tag The element name.
+    # @param attrib A dictionary containing element attributes.
+    # @return The opened element.
+    # @defreturn Element
+

+
[docs]    def start(self, tag, attrs):
+        self._flush()
+        self._last = elem = self._factory(tag, attrs)
+        if self._elem:
+            self._elem[-1].append(elem)
+        self._elem.append(elem)
+        self._tail = 0
+        return elem
+
+    ##
+    # Closes the current element.
+    #
+    # @param tag The element name.
+    # @return The closed element.
+    # @defreturn Element
+

+
[docs]    def end(self, tag):
+        self._flush()
+        self._last = self._elem.pop()
+        assert self._last.tag == tag,\
+               "end tag mismatch (expected %s, got %s)" % (
+                   self._last.tag, tag)
+        self._tail = 1
+        return self._last
+
+##
+# Element structure builder for XML source data, based on the
+# <b>expat</b> parser.
+#
+# @keyparam target Target object.  If omitted, the builder uses an
+#     instance of the standard {@link #TreeBuilder} class.
+# @keyparam html Predefine HTML entities.  This flag is not supported
+#     by the current implementation.
+# @see #ElementTree
+# @see #TreeBuilder
+

+
[docs]class XMLTreeBuilder:
+
+    def __init__(self, html=0, target=None):
+        try:
+            from xml.parsers import expat
+        except ImportError:
+            raise ImportError(
+                "No module named expat; use SimpleXMLTreeBuilder instead"
+                )
+        self._parser = parser = expat.ParserCreate(None, "}")
+        if target is None:
+            target = TreeBuilder()
+        self._target = target
+        self._names = {} # name memo cache
+        # callbacks
+        parser.DefaultHandlerExpand = self._default
+        parser.StartElementHandler = self._start
+        parser.EndElementHandler = self._end
+        parser.CharacterDataHandler = self._data
+        # let expat do the buffering, if supported
+        try:
+            self._parser.buffer_text = 1
+        except AttributeError:
+            pass
+        # use new-style attribute handling, if supported
+        try:
+            self._parser.ordered_attributes = 1
+            self._parser.specified_attributes = 1
+            parser.StartElementHandler = self._start_list
+        except AttributeError:
+            pass
+        #encoding = None
+        #if not parser.returns_unicode:
+        #    encoding = "utf-8"
+        # target.xml(encoding, None)
+        self._doctype = None
+        self.entity = {}
+
+    def _fixtext(self, text):
+        # convert text string to ascii, if possible
+        try:
+            return _encode(text, "ascii")
+        except UnicodeError:
+            return text
+
+    def _fixname(self, key):
+        # expand qname, and convert name string to ascii, if possible
+        try:
+            name = self._names[key]
+        except KeyError:
+            name = key
+            if "}" in name:
+                name = "{" + name
+            self._names[key] = name = self._fixtext(name)
+        return name
+
+    def _start(self, tag, attrib_in):
+        fixname = self._fixname
+        tag = fixname(tag)
+        attrib = {}
+        for key, value in attrib_in.items():
+            attrib[fixname(key)] = self._fixtext(value)
+        return self._target.start(tag, attrib)
+
+    def _start_list(self, tag, attrib_in):
+        fixname = self._fixname
+        tag = fixname(tag)
+        attrib = {}
+        if attrib_in:
+            for i in range(0, len(attrib_in), 2):
+                attrib[fixname(attrib_in[i])] = self._fixtext(attrib_in[i+1])
+        return self._target.start(tag, attrib)
+
+    def _data(self, text):
+        return self._target.data(self._fixtext(text))
+
+    def _end(self, tag):
+        return self._target.end(self._fixname(tag))
+
+    def _default(self, text):
+        prefix = text[:1]
+        if prefix == "&":
+            # deal with undefined entities
+            try:
+                self._target.data(self.entity[text[1:-1]])
+            except KeyError:
+                from xml.parsers import expat
+                raise expat.error(
+                    "undefined entity %s: line %d, column %d" %
+                    (text, self._parser.ErrorLineNumber,
+                    self._parser.ErrorColumnNumber)
+                    )
+        elif prefix == "<" and text[:9] == "<!DOCTYPE":
+            self._doctype = [] # inside a doctype declaration
+        elif self._doctype is not None:
+            # parse doctype contents
+            if prefix == ">":
+                self._doctype = None
+                return
+            text = string.strip(text)
+            if not text:
+                return
+            self._doctype.append(text)
+            n = len(self._doctype)
+            if n > 2:
+                type = self._doctype[1]
+                if type == "PUBLIC" and n == 4:
+                    name, type, pubid, system = self._doctype
+                elif type == "SYSTEM" and n == 3:
+                    name, type, system = self._doctype
+                    pubid = None
+                else:
+                    return
+                if pubid:
+                    pubid = pubid[1:-1]
+                self.doctype(name, pubid, system[1:-1])
+                self._doctype = None
+
+    ##
+    # Handles a doctype declaration.
+    #
+    # @param name Doctype name.
+    # @param pubid Public identifier.
+    # @param system System identifier.
+
+
[docs]    def doctype(self, name, pubid, system):
+        pass
+
+    ##
+    # Feeds data to the parser.
+    #
+    # @param data Encoded data.
+

+
[docs]    def feed(self, data):
+        # OP 14/11/2017 Ajout de traces pour essayer de decouvrir le pb
+        #               de remontee de log des tests
+        #print "TRACES OP - ElementTree.py/XMLTreeBuilder.feed() data = '#%s#'" %data
+        self._parser.Parse(data, 0)
+
+    ##
+    # Finishes feeding data to the parser.
+    #
+    # @return An element structure.
+    # @defreturn Element
+

+
[docs]    def close(self):
+        self._parser.Parse("", 1) # end of data
+        tree = self._target.close()
+        del self._target, self._parser # get rid of circular references
+        return tree

+
+ +
+
+
+
+
+
+

Related Topics

+ +
+ + +
+
+
+
+
+ ©2018, CEA. + + | + Powered by Sphinx 1.1.3 + & Alabaster + +
+ + + + + + \ No newline at end of file diff --git a/doc/build/html/_modules/src/__init__.html b/doc/build/html/_modules/src/__init__.html new file mode 100644 index 0000000..0415399 --- /dev/null +++ b/doc/build/html/_modules/src/__init__.html @@ -0,0 +1,544 @@ + + + + + + + + + src.__init__ — salomeTools 5.0.0dev documentation + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+ +

Source code for src.__init__

+#!/usr/bin/env python
+#-*- coding:utf-8 -*-
+#  Copyright (C) 2010-2013  CEA/DEN
+#
+#  This library is free software; you can redistribute it and/or
+#  modify it under the terms of the GNU Lesser General Public
+#  License as published by the Free Software Foundation; either
+#  version 2.1 of the License.
+#
+#  This library is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#  Lesser General Public License for more details.
+#
+#  You should have received a copy of the GNU Lesser General Public
+#  License along with this library; if not, write to the Free Software
+#  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+
+
+"""\
+initial imports and utilities methods for salomeTools
+"""
+
+import os
+import shutil
+import errno
+import stat
+
+from . import pyconf
+from . import architecture
+from . import printcolors
+from . import options
+from . import system
+from . import ElementTree
+from . import logger
+from . import product
+from . import environment
+from . import fileEnviron
+from . import compilation
+from . import test_module
+from . import template
+
+import platform
+if platform.system() == "Windows" :
+    import colorama
+    colorama.init()
+
+OK_STATUS = "OK"
+KO_STATUS = "KO"
+NA_STATUS = "NA"
+KNOWNFAILURE_STATUS = "KF"
+TIMEOUT_STATUS = "TIMEOUT"
+
+CONFIG_FILENAME = "sat-config.pyconf"
+
+
[docs]class SatException(Exception):
+    """rename Exception Class"""
+    pass
+

+
[docs]def ensure_path_exists(p):
+    """Create a path if not existing
+    
+    :param p str: The path.
+    """
+    if not os.path.exists(p):
+        os.makedirs(p)
+        

+
[docs]def check_config_has_application( config, details = None ):
+    """check that the config has the key APPLICATION. Else raise an exception.
+    
+    :param config class 'common.pyconf.Config': The config.
+    """
+    if 'APPLICATION' not in config:
+        message = _("An APPLICATION is required. Use 'config --list' to get"
+                    " the list of available applications.\n")
+        if details :
+            details.append(message)
+        raise SatException( message )
+

+
[docs]def check_config_has_profile( config, details = None ):
+    """\
+    check that the config has the key APPLICATION.profile.
+    else, raise an exception.
+    
+    :param config class 'common.pyconf.Config': The config.
+    """
+    check_config_has_application(config)
+    if 'profile' not in config.APPLICATION:
+        message = _("A profile section is required in your application.\n")
+        if details :
+            details.append(message)
+        raise SatException( message )
+

+
[docs]def config_has_application( config ):
+    return 'APPLICATION' in config
+

+
[docs]def get_cfg_param(config, param_name, default):
+    """\
+    eearch for param_name value in config.
+    if param_name is not in config 
+    then return default,
+    else return the found value
+       
+    :param config class 'common.pyconf.Config': The config.
+    :param param_name str: the name of the parameter to get the value
+    :param default str: The value to return if param_name is not in config
+    :return: see initial description of the function
+    :rtype: str
+    """
+    if param_name in config:
+        return config[param_name]
+    return default
+

+
+
[docs]def get_base_path(config):
+    """\
+    Returns the path of the products base.
+    
+    :param config Config: The global Config instance.
+    :return: The path of the products base.
+    :rtype: str
+    """
+    if "base" not in config.LOCAL:
+        local_file_path = os.path.join(config.VARS.salometoolsway,
+                                      "data",
+                                      "local.pyconf")
+        msg = _("Please define a base path in the file %s" % local_file_path)
+        raise SatException(msg)
+        
+    base_path = os.path.abspath(config.LOCAL.base)
+    
+    return base_path
+

+
[docs]def get_launcher_name(config):
+    """\
+    Returns the name of salome launcher.
+    
+    :param config Config: The global Config instance.
+    :return: The name of salome launcher.
+    :rtype: str
+    """
+    check_config_has_application(config)
+    if 'profile' in config.APPLICATION and 'launcher_name' in config.APPLICATION.profile:
+        launcher_name = config.APPLICATION.profile.launcher_name
+    else:
+        launcher_name = 'salome'
+
+    return launcher_name
+

+
[docs]def get_log_path(config):
+    """\
+    Returns the path of the logs.
+    
+    :param config Config: The global Config instance.
+    :return: The path of the logs.
+    :rtype: str
+    """
+    if "log_dir" not in config.LOCAL:
+        local_file_path = os.path.join(config.VARS.salometoolsway,
+                                      "data",
+                                      "local.pyconf")
+        msg = _("Please define a log_dir in the file %s" % local_file_path)
+        raise SatException(msg)
+      
+    log_dir_path = os.path.abspath(config.LOCAL.log_dir)
+    
+    return log_dir_path
+

+
[docs]def get_salome_version(config):
+    if hasattr(config.APPLICATION, 'version_salome'):
+        Version = config.APPLICATION.version_salome
+    else:
+        KERNEL_info = product.get_product_config(config, "KERNEL")
+        VERSION = os.path.join(
+                            KERNEL_info.install_dir,
+                            "bin",
+                            "salome",
+                            "VERSION")
+        if not os.path.isfile(VERSION):
+            return None
+            
+        fVERSION = open(VERSION)
+        Version = fVERSION.readline()
+        fVERSION.close()
+        
+    VersionSalome = int(only_numbers(Version))    
+    return VersionSalome
+

+
[docs]def only_numbers(str_num):
+    return ''.join([nb for nb in str_num if nb in '0123456789'] or '0')
+

+
[docs]def read_config_from_a_file(filePath):
+        try:
+            cfg_file = pyconf.Config(filePath)
+        except pyconf.ConfigError as e:
+            raise SatException(_("Error in configuration file: %(file)s\n  %(error)s") % \
+                { 'file': filePath, 'error': str(e) })
+        return cfg_file
+

+
[docs]def get_tmp_filename(cfg, name):
+    if not os.path.exists(cfg.VARS.tmp_root):
+        os.makedirs(cfg.VARS.tmp_root)
+
+    return os.path.join(cfg.VARS.tmp_root, name)
+
+##
+# Utils class to simplify path manipulations.

+
[docs]class Path:
+    def __init__(self, path):
+        self.path = str(path)
+
+    def __add__(self, other):
+        return Path(os.path.join(self.path, str(other)))
+
+    def __abs__(self):
+        return Path(os.path.abspath(self.path))
+
+    def __str__(self):
+        return self.path
+
+    def __eq__(self, other):
+        return self.path == other.path
+
+
[docs]    def exists(self):
+        return self.islink() or os.path.exists(self.path)
+

+
+
[docs]    def isdir(self):
+        return os.path.isdir(self.path)
+

+
[docs]    def isfile(self):
+        return os.path.isfile(self.path)
+

+
[docs]    def list(self):
+        return [Path(p) for p in os.listdir(self.path)]
+

+
[docs]    def dir(self):
+        return Path(os.path.dirname(self.path))
+

+
[docs]    def base(self):
+        return Path(os.path.basename(self.path))
+

+
[docs]    def make(self, mode=None):
+        os.makedirs(self.path)        
+        if mode:
+            os.chmod(self.path, mode)
+        

+
[docs]    def chmod(self, mode):
+        os.chmod(self.path, mode)
+

+
[docs]    def rm(self):    
+        if self.islink():
+            os.remove(self.path)
+        else:
+            shutil.rmtree( self.path, onerror = handleRemoveReadonly )
+

+
[docs]    def copy(self, path, smart=False):
+        if not isinstance(path, Path):
+            path = Path(path)
+
+        if os.path.islink(self.path):
+            return self.copylink(path)
+        elif os.path.isdir(self.path):
+            return self.copydir(path, smart)
+        else:
+            return self.copyfile(path)
+

+
[docs]    def smartcopy(self, path):
+        return self.copy(path, True)
+

+
+
+
+
[docs]    def copydir(self, dst, smart=False):
+        try:
+            names = self.list()
+
+            if not dst.exists():
+                dst.make()
+
+            for name in names:
+                if name == dst:
+                    continue
+                if smart and (str(name) in [".git", "CVS", ".svn"]):
+                    continue
+                srcname = self + name
+                dstname = dst + name
+                srcname.copy(dstname, smart)
+            return True
+        except:
+            return False
+

+
[docs]    def copyfile(self, path):
+        try:
+            shutil.copy2(self.path, str(path))
+            return True
+        except:
+            return False
+

+
[docs]def find_file_in_lpath(file_name, lpath, additional_dir = ""):
+    """\
+    Find in all the directories in lpath list the file that has the same name
+    as file_name. 
+    If it is found 
+    then return the full path of the file
+    else return False.
+ 
+    The additional_dir (optional) is the name of the directory to add to all 
+    paths in lpath.
+    
+    :param file_name str: The file name to search
+    :param lpath List: The list of directories where to search
+    :param additional_dir str: The name of the additional directory
+    :return: the full path of the file or False if not found
+    :rtype: str
+    """
+    for directory in lpath:
+        dir_complete = os.path.join(directory, additional_dir)
+        if not os.path.isdir(directory) or not os.path.isdir(dir_complete):
+            continue
+        l_files = os.listdir(dir_complete)
+        for file_n in l_files:
+            if file_n == file_name:
+                return os.path.join(dir_complete, file_name)
+    return False
+

+
[docs]def handleRemoveReadonly(func, path, exc):
+    excvalue = exc[1]
+    if func in (os.rmdir, os.remove) and excvalue.errno == errno.EACCES:
+        os.chmod(path, stat.S_IRWXU| stat.S_IRWXG| stat.S_IRWXO) # 0777
+        func(path)
+    else:
+        raise
+

+
[docs]def deepcopy_list(input_list):
+    """\
+    Do a deep copy of a list
+    
+    :param input_list List: The list to copy
+    :return: The copy of the list
+    :rtype: List
+    """
+    res = []
+    for elem in input_list:
+        res.append(elem)
+    return res
+

+
[docs]def remove_item_from_list(input_list, item):
+    """\
+    Remove all occurences of item from input_list
+    
+    :param input_list List: The list to modify
+    :return: The without any item
+    :rtype: List
+    """
+    res = []
+    for elem in input_list:
+        if elem == item:
+            continue
+        res.append(elem)
+    return res
+

+
[docs]def parse_date(date):
+    """\
+    Transform YYYYMMDD_hhmmss into YYYY-MM-DD hh:mm:ss.
+    
+    :param date str: The date to transform
+    :return: The date in the new format
+    :rtype: str
+    """
+    if len(date) != 15:
+        return date
+    res = "%s-%s-%s %s:%s:%s" % (date[0:4],
+                                 date[4:6],
+                                 date[6:8],
+                                 date[9:11],
+                                 date[11:13],
+                                 date[13:])
+    return res
+

+
[docs]def merge_dicts(*dict_args):
+    """\
+    Given any number of dicts, shallow copy and merge into a new dict,
+    precedence goes to key value pairs in latter dicts.
+    """
+    result = {}
+    for dictionary in dict_args:
+        result.update(dictionary)
+    return result
+

+
[docs]def replace_in_file(filein, strin, strout):
+    """Replace <strin> by <strout> in file <filein>"""
+    shutil.move(filein, filein + "_old")
+    fileout= filein
+    filein = filein + "_old"
+    fin = open(filein, "r")
+    fout = open(fileout, "w")
+    for line in fin:
+        fout.write(line.replace(strin, strout))
+

+
[docs]def get_property_in_product_cfg(product_cfg, pprty):
+    if not "properties" in product_cfg:
+        return None
+    if not pprty in product_cfg.properties:
+        return None
+    return product_cfg.properties[pprty]
+

+
[docs]def activate_mesa_property(config):
+    """Add mesa property into application properties
+    
+    :param config Config: The global configuration. It must have an application!
+    """
+    # Verify the existence of the file
+    if not 'properties' in config.APPLICATION:
+        config.APPLICATION.addMapping( 'properties', src.pyconf.Mapping(), None )
+    config.APPLICATION.properties.use_mesa="yes"
+
+ +
+
+
+
+
+
+

Related Topics

+ +
+ + +
+
+
+ +
+ ©2018, CEA. + + | + Powered by Sphinx 1.1.3 + & Alabaster + +
+ + + + + + \ No newline at end of file diff --git a/doc/build/html/_modules/src/architecture.html b/doc/build/html/_modules/src/architecture.html new file mode 100644 index 0000000..e47e0d0 --- /dev/null +++ b/doc/build/html/_modules/src/architecture.html @@ -0,0 +1,239 @@ + + + + + + + + + src.architecture — salomeTools 5.0.0dev documentation + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+ +

Source code for src.architecture

+#!/usr/bin/env python
+#-*- coding:utf-8 -*-
+#  Copyright (C) 2010-2013  CEA/DEN
+#
+#  This library is free software; you can redistribute it and/or
+#  modify it under the terms of the GNU Lesser General Public
+#  License as published by the Free Software Foundation; either
+#  version 2.1 of the License.
+#
+#  This library is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#  Lesser General Public License for more details.
+#
+#  You should have received a copy of the GNU Lesser General Public
+#  License along with this library; if not, write to the Free Software
+#  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+
+'''
+In this file : all the stuff that can change with the architecture 
+on which SAT is running
+'''
+
+import os, sys, platform
+
+
[docs]def is_windows():
+    '''method that checks windows OS
+      
+    :rtype: boolean
+    '''
+    return platform.system() == 'Windows'
+

+
[docs]def get_user():
+    '''method that gets the username that launched sat  
+    
+    :rtype: str
+    '''
+    # In windows case, the USERNAME environment variable has to be set
+    if is_windows():
+        if not os.environ.has_key('USERNAME'):
+            raise Exception('USERNAME environment variable not set')
+        return os.environ['USERNAME']
+    else: # linux
+        import pwd
+        return pwd.getpwuid(os.getuid())[0]
+

+def _lsb_release(args):
+    '''Get system information with lsb_release.
+    
+    :param args str: The arguments to give to lsb_release.
+    :return: The distribution.
+    :rtype: str
+    '''
+    try:
+        path = '/usr/local/bin:/usr/bin:/bin'
+        lsb_path = os.getenv("LSB_PATH")
+        if lsb_path is not None:
+            path = lsb_path + ":" + path
+        
+        from subprocess import Popen, PIPE
+        res = Popen(['lsb_release', args], env={'PATH': path},
+                     stdout=PIPE).communicate()[0][:-1]
+        # in case of python3, convert byte to str
+        if isinstance(res, bytes):
+            res = res.decode()
+        return res
+    except OSError:
+        sys.stderr.write(_(u"lsb_release not installed\n"))
+        sys.stderr.write(_(u"You can define $LSB_PATH to give"
+                           " the path to lsb_release\n"))
+        sys.exit(-1)
+
+
[docs]def get_distribution(codes):
+    '''Gets the code for the distribution
+    
+    :param codes L{Mapping}: The map containing distribution correlation table.
+    :return: The distribution on which salomeTools is running, regarding the 
+             distribution correlation table contained in codes variable.
+    :rtype: str
+    '''
+    if is_windows():
+        return "Win"
+
+    # Call to lsb_release
+    distrib = _lsb_release('-si')
+    if codes is not None and distrib in codes:
+        distrib = codes[distrib]
+    else:
+        sys.stderr.write(_(u"Unknown distribution: '%s'\n") % distrib)
+        sys.stderr.write(_(u"Please add your distribution to"
+                           " src/internal_config/distrib.pyconf\n"))
+        sys.exit(-1)
+
+    return distrib
+
+

+
[docs]def get_distrib_version(distrib, codes):
+    '''Gets the version of the distribution
+    
+    :param distrib str: The distribution on which the version will be found.
+    :param codes L{Mapping}: The map containing distribution correlation table.
+    :return: The version of the distribution on which salomeTools is running, 
+             regarding the distribution correlation table contained in codes 
+             variable.
+    :rtype: str
+    '''
+
+    if is_windows():
+        return platform.release()
+
+    # Call to lsb_release
+    version = _lsb_release('-sr')
+    if distrib in codes:
+        if version in codes[distrib]:
+            version = codes[distrib][version]
+
+    if distrib == "CO":
+        version=version[0]  #for centos, we only care for major version
+    return version
+

+
[docs]def get_python_version():
+    '''Gets the version of the running python.
+    
+    :return: the version of the running python.
+    :rtype: str
+    '''
+    
+    # The platform python module gives the answer
+    return platform.python_version()
+

+
[docs]def get_nb_proc():
+    '''Gets the number of processors of the machine 
+       on which salomeTools is running.
+    
+    :return: the number of processors.
+    :rtype: str
+    '''
+    
+    try :
+        import multiprocessing
+        nb_proc=multiprocessing.cpu_count()
+    except :
+        nb_proc=int(os.sysconf('SC_NPROCESSORS_ONLN'))
+    return nb_proc

+
+ +
+
+
+
+
+
+

Related Topics

+ +
+ + +
+
+
+
+
+ ©2018, CEA. + + | + Powered by Sphinx 1.1.3 + & Alabaster + +
+ + + + + + \ No newline at end of file diff --git a/doc/build/html/_modules/src/colorama/ansi.html b/doc/build/html/_modules/src/colorama/ansi.html new file mode 100644 index 0000000..3f13ba4 --- /dev/null +++ b/doc/build/html/_modules/src/colorama/ansi.html @@ -0,0 +1,197 @@ + + + + + + + + + src.colorama.ansi — salomeTools 5.0.0dev documentation + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+ +

Source code for src.colorama.ansi

+# Copyright Jonathan Hartley 2013. BSD 3-Clause license, see LICENSE file.
+'''
+This module generates ANSI character codes to printing colors to terminals.
+See: http://en.wikipedia.org/wiki/ANSI_escape_code
+'''
+
+CSI = '\033['
+OSC = '\033]'
+BEL = '\007'
+
+
+
[docs]def code_to_chars(code):
+    return CSI + str(code) + 'm'
+

+
[docs]def set_title(title):
+    return OSC + '2;' + title + BEL
+

+
[docs]def clear_screen(mode=2):
+    return CSI + str(mode) + 'J'
+

+
[docs]def clear_line(mode=2):
+    return CSI + str(mode) + 'K'
+
+

+
[docs]class AnsiCodes(object):
+    def __init__(self):
+        # the subclasses declare class attributes which are numbers.
+        # Upon instantiation we define instance attributes, which are the same
+        # as the class attributes but wrapped with the ANSI escape sequence
+        for name in dir(self):
+            if not name.startswith('_'):
+                value = getattr(self, name)
+                setattr(self, name, code_to_chars(value))
+
+

+
[docs]class AnsiCursor(object):
+
[docs]    def UP(self, n=1):
+        return CSI + str(n) + 'A'

+
[docs]    def DOWN(self, n=1):
+        return CSI + str(n) + 'B'

+
[docs]    def FORWARD(self, n=1):
+        return CSI + str(n) + 'C'

+
[docs]    def BACK(self, n=1):
+        return CSI + str(n) + 'D'

+
[docs]    def POS(self, x=1, y=1):
+        return CSI + str(y) + ';' + str(x) + 'H'
+
+

+
[docs]class AnsiFore(AnsiCodes):
+    BLACK           = 30
+    RED             = 31
+    GREEN           = 32
+    YELLOW          = 33
+    BLUE            = 34
+    MAGENTA         = 35
+    CYAN            = 36
+    WHITE           = 37
+    RESET           = 39
+
+    # These are fairly well supported, but not part of the standard.
+    LIGHTBLACK_EX   = 90
+    LIGHTRED_EX     = 91
+    LIGHTGREEN_EX   = 92
+    LIGHTYELLOW_EX  = 93
+    LIGHTBLUE_EX    = 94
+    LIGHTMAGENTA_EX = 95
+    LIGHTCYAN_EX    = 96
+    LIGHTWHITE_EX   = 97
+
+

+
[docs]class AnsiBack(AnsiCodes):
+    BLACK           = 40
+    RED             = 41
+    GREEN           = 42
+    YELLOW          = 43
+    BLUE            = 44
+    MAGENTA         = 45
+    CYAN            = 46
+    WHITE           = 47
+    RESET           = 49
+
+    # These are fairly well supported, but not part of the standard.
+    LIGHTBLACK_EX   = 100
+    LIGHTRED_EX     = 101
+    LIGHTGREEN_EX   = 102
+    LIGHTYELLOW_EX  = 103
+    LIGHTBLUE_EX    = 104
+    LIGHTMAGENTA_EX = 105
+    LIGHTCYAN_EX    = 106
+    LIGHTWHITE_EX   = 107
+
+

+
[docs]class AnsiStyle(AnsiCodes):
+    BRIGHT    = 1
+    DIM       = 2
+    NORMAL    = 22
+    RESET_ALL = 0
+

+Fore   = AnsiFore()
+Back   = AnsiBack()
+Style  = AnsiStyle()
+Cursor = AnsiCursor()
+
+ +
+
+
+
+
+
+

Related Topics

+ +
+ + +
+
+
+
+
+ ©2018, CEA. + + | + Powered by Sphinx 1.1.3 + & Alabaster + +
+ + + + + + \ No newline at end of file diff --git a/doc/build/html/_modules/src/colorama/ansitowin32.html b/doc/build/html/_modules/src/colorama/ansitowin32.html new file mode 100644 index 0000000..e750280 --- /dev/null +++ b/doc/build/html/_modules/src/colorama/ansitowin32.html @@ -0,0 +1,331 @@ + + + + + + + + + src.colorama.ansitowin32 — salomeTools 5.0.0dev documentation + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+ +

Source code for src.colorama.ansitowin32

+# Copyright Jonathan Hartley 2013. BSD 3-Clause license, see LICENSE file.
+import re
+import sys
+import os
+
+from .ansi import AnsiFore, AnsiBack, AnsiStyle, Style
+from .winterm import WinTerm, WinColor, WinStyle
+from .win32 import windll, winapi_test
+
+
+winterm = None
+if windll is not None:
+    winterm = WinTerm()
+
+
+
[docs]def is_stream_closed(stream):
+    return not hasattr(stream, 'closed') or stream.closed
+
+

+
[docs]def is_a_tty(stream):
+    return hasattr(stream, 'isatty') and stream.isatty()
+
+

+
[docs]class StreamWrapper(object):
+    '''
+    Wraps a stream (such as stdout), acting as a transparent proxy for all
+    attribute access apart from method 'write()', which is delegated to our
+    Converter instance.
+    '''
+    def __init__(self, wrapped, converter):
+        # double-underscore everything to prevent clashes with names of
+        # attributes on the wrapped stream object.
+        self.__wrapped = wrapped
+        self.__convertor = converter
+
+    def __getattr__(self, name):
+        return getattr(self.__wrapped, name)
+
+
[docs]    def write(self, text):
+        self.__convertor.write(text)
+
+

+
[docs]class AnsiToWin32(object):
+    '''
+    Implements a 'write()' method which, on Windows, will strip ANSI character
+    sequences from the text, and if outputting to a tty, will convert them into
+    win32 function calls.
+    '''
+    ANSI_CSI_RE = re.compile('\001?\033\[((?:\d|;)*)([a-zA-Z])\002?')     # Control Sequence Introducer
+    ANSI_OSC_RE = re.compile('\001?\033\]((?:.|;)*?)(\x07)\002?')         # Operating System Command
+
+    def __init__(self, wrapped, convert=None, strip=None, autoreset=False):
+        # The wrapped stream (normally sys.stdout or sys.stderr)
+        self.wrapped = wrapped
+
+        # should we reset colors to defaults after every .write()
+        self.autoreset = autoreset
+
+        # create the proxy wrapping our output stream
+        self.stream = StreamWrapper(wrapped, self)
+
+        on_windows = os.name == 'nt'
+        # We test if the WinAPI works, because even if we are on Windows
+        # we may be using a terminal that doesn't support the WinAPI
+        # (e.g. Cygwin Terminal). In this case it's up to the terminal
+        # to support the ANSI codes.
+        conversion_supported = on_windows and winapi_test()
+
+        # should we strip ANSI sequences from our output?
+        if strip is None:
+            strip = conversion_supported or (not is_stream_closed(wrapped) and not is_a_tty(wrapped))
+        self.strip = strip
+
+        # should we should convert ANSI sequences into win32 calls?
+        if convert is None:
+            convert = conversion_supported and not is_stream_closed(wrapped) and is_a_tty(wrapped)
+        self.convert = convert
+
+        # dict of ansi codes to win32 functions and parameters
+        self.win32_calls = self.get_win32_calls()
+
+        # are we wrapping stderr?
+        self.on_stderr = self.wrapped is sys.stderr
+
+
[docs]    def should_wrap(self):
+        '''
+        True if this class is actually needed. If false, then the output
+        stream will not be affected, nor will win32 calls be issued, so
+        wrapping stdout is not actually required. This will generally be
+        False on non-Windows platforms, unless optional functionality like
+        autoreset has been requested using kwargs to init()
+        '''
+        return self.convert or self.strip or self.autoreset
+

+
[docs]    def get_win32_calls(self):
+        if self.convert and winterm:
+            return {
+                AnsiStyle.RESET_ALL: (winterm.reset_all, ),
+                AnsiStyle.BRIGHT: (winterm.style, WinStyle.BRIGHT),
+                AnsiStyle.DIM: (winterm.style, WinStyle.NORMAL),
+                AnsiStyle.NORMAL: (winterm.style, WinStyle.NORMAL),
+                AnsiFore.BLACK: (winterm.fore, WinColor.BLACK),
+                AnsiFore.RED: (winterm.fore, WinColor.RED),
+                AnsiFore.GREEN: (winterm.fore, WinColor.GREEN),
+                AnsiFore.YELLOW: (winterm.fore, WinColor.YELLOW),
+                AnsiFore.BLUE: (winterm.fore, WinColor.BLUE),
+                AnsiFore.MAGENTA: (winterm.fore, WinColor.MAGENTA),
+                AnsiFore.CYAN: (winterm.fore, WinColor.CYAN),
+                AnsiFore.WHITE: (winterm.fore, WinColor.GREY),
+                AnsiFore.RESET: (winterm.fore, ),
+                AnsiFore.LIGHTBLACK_EX: (winterm.fore, WinColor.BLACK, True),
+                AnsiFore.LIGHTRED_EX: (winterm.fore, WinColor.RED, True),
+                AnsiFore.LIGHTGREEN_EX: (winterm.fore, WinColor.GREEN, True),
+                AnsiFore.LIGHTYELLOW_EX: (winterm.fore, WinColor.YELLOW, True),
+                AnsiFore.LIGHTBLUE_EX: (winterm.fore, WinColor.BLUE, True),
+                AnsiFore.LIGHTMAGENTA_EX: (winterm.fore, WinColor.MAGENTA, True),
+                AnsiFore.LIGHTCYAN_EX: (winterm.fore, WinColor.CYAN, True),
+                AnsiFore.LIGHTWHITE_EX: (winterm.fore, WinColor.GREY, True),
+                AnsiBack.BLACK: (winterm.back, WinColor.BLACK),
+                AnsiBack.RED: (winterm.back, WinColor.RED),
+                AnsiBack.GREEN: (winterm.back, WinColor.GREEN),
+                AnsiBack.YELLOW: (winterm.back, WinColor.YELLOW),
+                AnsiBack.BLUE: (winterm.back, WinColor.BLUE),
+                AnsiBack.MAGENTA: (winterm.back, WinColor.MAGENTA),
+                AnsiBack.CYAN: (winterm.back, WinColor.CYAN),
+                AnsiBack.WHITE: (winterm.back, WinColor.GREY),
+                AnsiBack.RESET: (winterm.back, ),
+                AnsiBack.LIGHTBLACK_EX: (winterm.back, WinColor.BLACK, True),
+                AnsiBack.LIGHTRED_EX: (winterm.back, WinColor.RED, True),
+                AnsiBack.LIGHTGREEN_EX: (winterm.back, WinColor.GREEN, True),
+                AnsiBack.LIGHTYELLOW_EX: (winterm.back, WinColor.YELLOW, True),
+                AnsiBack.LIGHTBLUE_EX: (winterm.back, WinColor.BLUE, True),
+                AnsiBack.LIGHTMAGENTA_EX: (winterm.back, WinColor.MAGENTA, True),
+                AnsiBack.LIGHTCYAN_EX: (winterm.back, WinColor.CYAN, True),
+                AnsiBack.LIGHTWHITE_EX: (winterm.back, WinColor.GREY, True),
+            }
+        return dict()
+

+
[docs]    def write(self, text):
+        if self.strip or self.convert:
+            self.write_and_convert(text)
+        else:
+            self.wrapped.write(text)
+            self.wrapped.flush()
+        if self.autoreset:
+            self.reset_all()
+
+

+
[docs]    def reset_all(self):
+        if self.convert:
+            self.call_win32('m', (0,))
+        elif not self.strip and not is_stream_closed(self.wrapped):
+            self.wrapped.write(Style.RESET_ALL)
+
+

+
[docs]    def write_and_convert(self, text):
+        '''
+        Write the given text to our wrapped stream, stripping any ANSI
+        sequences from the text, and optionally converting them into win32
+        calls.
+        '''
+        cursor = 0
+        text = self.convert_osc(text)
+        for match in self.ANSI_CSI_RE.finditer(text):
+            start, end = match.span()
+            self.write_plain_text(text, cursor, start)
+            self.convert_ansi(*match.groups())
+            cursor = end
+        self.write_plain_text(text, cursor, len(text))
+
+

+
[docs]    def write_plain_text(self, text, start, end):
+        if start < end:
+            self.wrapped.write(text[start:end])
+            self.wrapped.flush()
+
+

+
[docs]    def convert_ansi(self, paramstring, command):
+        if self.convert:
+            params = self.extract_params(command, paramstring)
+            self.call_win32(command, params)
+
+

+
[docs]    def extract_params(self, command, paramstring):
+        if command in 'Hf':
+            params = tuple(int(p) if len(p) != 0 else 1 for p in paramstring.split(';'))
+            while len(params) < 2:
+                # defaults:
+                params = params + (1,)
+        else:
+            params = tuple(int(p) for p in paramstring.split(';') if len(p) != 0)
+            if len(params) == 0:
+                # defaults:
+                if command in 'JKm':
+                    params = (0,)
+                elif command in 'ABCD':
+                    params = (1,)
+
+        return params
+
+

+
[docs]    def call_win32(self, command, params):
+        if command == 'm':
+            for param in params:
+                if param in self.win32_calls:
+                    func_args = self.win32_calls[param]
+                    func = func_args[0]
+                    args = func_args[1:]
+                    kwargs = dict(on_stderr=self.on_stderr)
+                    func(*args, **kwargs)
+        elif command in 'J':
+            winterm.erase_screen(params[0], on_stderr=self.on_stderr)
+        elif command in 'K':
+            winterm.erase_line(params[0], on_stderr=self.on_stderr)
+        elif command in 'Hf':     # cursor position - absolute
+            winterm.set_cursor_position(params, on_stderr=self.on_stderr)
+        elif command in 'ABCD':   # cursor position - relative
+            n = params[0]
+            # A - up, B - down, C - forward, D - back
+            x, y = {'A': (0, -n), 'B': (0, n), 'C': (n, 0), 'D': (-n, 0)}[command]
+            winterm.cursor_adjust(x, y, on_stderr=self.on_stderr)
+
+

+
[docs]    def convert_osc(self, text):
+        for match in self.ANSI_OSC_RE.finditer(text):
+            start, end = match.span()
+            text = text[:start] + text[end:]
+            paramstring, command = match.groups()
+            if command in '\x07':       # \x07 = BEL
+                params = paramstring.split(";")
+                # 0 - change title and icon (we will only change title)
+                # 1 - change icon (we don't support this)
+                # 2 - change title
+                if params[0] in '02':
+                    winterm.set_title(params[1])
+        return text

+
+ +
+
+
+
+
+
+

Related Topics

+ +
+ + +
+
+
+
+
+ ©2018, CEA. + + | + Powered by Sphinx 1.1.3 + & Alabaster + +
+ + + + + + \ No newline at end of file diff --git a/doc/build/html/_modules/src/colorama/initialise.html b/doc/build/html/_modules/src/colorama/initialise.html new file mode 100644 index 0000000..10d509f --- /dev/null +++ b/doc/build/html/_modules/src/colorama/initialise.html @@ -0,0 +1,175 @@ + + + + + + + + + src.colorama.initialise — salomeTools 5.0.0dev documentation + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+ +

Source code for src.colorama.initialise

+# Copyright Jonathan Hartley 2013. BSD 3-Clause license, see LICENSE file.
+import atexit
+import contextlib
+import sys
+
+from .ansitowin32 import AnsiToWin32
+
+
+orig_stdout = None
+orig_stderr = None
+
+wrapped_stdout = None
+wrapped_stderr = None
+
+atexit_done = False
+
+
+
[docs]def reset_all():
+    if AnsiToWin32 is not None:    # Issue #74: objects might become None at exit
+        AnsiToWin32(orig_stdout).reset_all()
+
+

+
[docs]def init(autoreset=False, convert=None, strip=None, wrap=True):
+
+    if not wrap and any([autoreset, convert, strip]):
+        raise ValueError('wrap=False conflicts with any other arg=True')
+
+    global wrapped_stdout, wrapped_stderr
+    global orig_stdout, orig_stderr
+
+    orig_stdout = sys.stdout
+    orig_stderr = sys.stderr
+
+    if sys.stdout is None:
+        wrapped_stdout = None
+    else:
+        sys.stdout = wrapped_stdout = \
+            wrap_stream(orig_stdout, convert, strip, autoreset, wrap)
+    if sys.stderr is None:
+        wrapped_stderr = None
+    else:
+        sys.stderr = wrapped_stderr = \
+            wrap_stream(orig_stderr, convert, strip, autoreset, wrap)
+
+    global atexit_done
+    if not atexit_done:
+        atexit.register(reset_all)
+        atexit_done = True
+
+

+
[docs]def deinit():
+    if orig_stdout is not None:
+        sys.stdout = orig_stdout
+    if orig_stderr is not None:
+        sys.stderr = orig_stderr
+
+

+@contextlib.contextmanager
+
[docs]def colorama_text(*args, **kwargs):
+    init(*args, **kwargs)
+    try:
+        yield
+    finally:
+        deinit()
+
+

+
[docs]def reinit():
+    if wrapped_stdout is not None:
+        sys.stdout = wrapped_stdout
+    if wrapped_stderr is not None:
+        sys.stderr = wrapped_stderr
+
+

+
[docs]def wrap_stream(stream, convert, strip, autoreset, wrap):
+    if wrap:
+        wrapper = AnsiToWin32(stream,
+            convert=convert, strip=strip, autoreset=autoreset)
+        if wrapper.should_wrap():
+            stream = wrapper.stream
+    return stream
+
+ +
+
+
+
+
+
+

Related Topics

+ +
+ + +
+
+
+ +
+ ©2018, CEA. + + | + Powered by Sphinx 1.1.3 + & Alabaster + +
+ + + + + + \ No newline at end of file diff --git a/doc/build/html/_modules/src/colorama/win32.html b/doc/build/html/_modules/src/colorama/win32.html new file mode 100644 index 0000000..49bd541 --- /dev/null +++ b/doc/build/html/_modules/src/colorama/win32.html @@ -0,0 +1,249 @@ + + + + + + + + + src.colorama.win32 — salomeTools 5.0.0dev documentation + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+ +

Source code for src.colorama.win32

+# Copyright Jonathan Hartley 2013. BSD 3-Clause license, see LICENSE file.
+
+# from winbase.h
+STDOUT = -11
+STDERR = -12
+
+try:
+    import ctypes
+    from ctypes import LibraryLoader
+    windll = LibraryLoader(ctypes.WinDLL)
+    from ctypes import wintypes
+except (AttributeError, ImportError):
+    windll = None
+    SetConsoleTextAttribute = lambda *_: None
+    winapi_test = lambda *_: None
+else:
+    from ctypes import byref, Structure, c_char, POINTER
+
+    COORD = wintypes._COORD
+
+    class CONSOLE_SCREEN_BUFFER_INFO(Structure):
+        """struct in wincon.h."""
+        _fields_ = [
+            ("dwSize", COORD),
+            ("dwCursorPosition", COORD),
+            ("wAttributes", wintypes.WORD),
+            ("srWindow", wintypes.SMALL_RECT),
+            ("dwMaximumWindowSize", COORD),
+        ]
+        def __str__(self):
+            return '(%d,%d,%d,%d,%d,%d,%d,%d,%d,%d,%d)' % (
+                self.dwSize.Y, self.dwSize.X
+                , self.dwCursorPosition.Y, self.dwCursorPosition.X
+                , self.wAttributes
+                , self.srWindow.Top, self.srWindow.Left, self.srWindow.Bottom, self.srWindow.Right
+                , self.dwMaximumWindowSize.Y, self.dwMaximumWindowSize.X
+            )
+
+    _GetStdHandle = windll.kernel32.GetStdHandle
+    _GetStdHandle.argtypes = [
+        wintypes.DWORD,
+    ]
+    _GetStdHandle.restype = wintypes.HANDLE
+
+    _GetConsoleScreenBufferInfo = windll.kernel32.GetConsoleScreenBufferInfo
+    _GetConsoleScreenBufferInfo.argtypes = [
+        wintypes.HANDLE,
+        POINTER(CONSOLE_SCREEN_BUFFER_INFO),
+    ]
+    _GetConsoleScreenBufferInfo.restype = wintypes.BOOL
+
+    _SetConsoleTextAttribute = windll.kernel32.SetConsoleTextAttribute
+    _SetConsoleTextAttribute.argtypes = [
+        wintypes.HANDLE,
+        wintypes.WORD,
+    ]
+    _SetConsoleTextAttribute.restype = wintypes.BOOL
+
+    _SetConsoleCursorPosition = windll.kernel32.SetConsoleCursorPosition
+    _SetConsoleCursorPosition.argtypes = [
+        wintypes.HANDLE,
+        COORD,
+    ]
+    _SetConsoleCursorPosition.restype = wintypes.BOOL
+
+    _FillConsoleOutputCharacterA = windll.kernel32.FillConsoleOutputCharacterA
+    _FillConsoleOutputCharacterA.argtypes = [
+        wintypes.HANDLE,
+        c_char,
+        wintypes.DWORD,
+        COORD,
+        POINTER(wintypes.DWORD),
+    ]
+    _FillConsoleOutputCharacterA.restype = wintypes.BOOL
+
+    _FillConsoleOutputAttribute = windll.kernel32.FillConsoleOutputAttribute
+    _FillConsoleOutputAttribute.argtypes = [
+        wintypes.HANDLE,
+        wintypes.WORD,
+        wintypes.DWORD,
+        COORD,
+        POINTER(wintypes.DWORD),
+    ]
+    _FillConsoleOutputAttribute.restype = wintypes.BOOL
+
+    _SetConsoleTitleW = windll.kernel32.SetConsoleTitleA
+    _SetConsoleTitleW.argtypes = [
+        wintypes.LPCSTR
+    ]
+    _SetConsoleTitleW.restype = wintypes.BOOL
+
+    handles = {
+        STDOUT: _GetStdHandle(STDOUT),
+        STDERR: _GetStdHandle(STDERR),
+    }
+
+
[docs]    def winapi_test():
+        handle = handles[STDOUT]
+        csbi = CONSOLE_SCREEN_BUFFER_INFO()
+        success = _GetConsoleScreenBufferInfo(
+            handle, byref(csbi))
+        return bool(success)
+

+    def GetConsoleScreenBufferInfo(stream_id=STDOUT):
+        handle = handles[stream_id]
+        csbi = CONSOLE_SCREEN_BUFFER_INFO()
+        success = _GetConsoleScreenBufferInfo(
+            handle, byref(csbi))
+        return csbi
+
+
[docs]    def SetConsoleTextAttribute(stream_id, attrs):
+        handle = handles[stream_id]
+        return _SetConsoleTextAttribute(handle, attrs)
+

+    def SetConsoleCursorPosition(stream_id, position, adjust=True):
+        position = COORD(*position)
+        # If the position is out of range, do nothing.
+        if position.Y <= 0 or position.X <= 0:
+            return
+        # Adjust for Windows' SetConsoleCursorPosition:
+        #    1. being 0-based, while ANSI is 1-based.
+        #    2. expecting (x,y), while ANSI uses (y,x).
+        adjusted_position = COORD(position.Y - 1, position.X - 1)
+        if adjust:
+            # Adjust for viewport's scroll position
+            sr = GetConsoleScreenBufferInfo(STDOUT).srWindow
+            adjusted_position.Y += sr.Top
+            adjusted_position.X += sr.Left
+        # Resume normal processing
+        handle = handles[stream_id]
+        return _SetConsoleCursorPosition(handle, adjusted_position)
+
+    def FillConsoleOutputCharacter(stream_id, char, length, start):
+        handle = handles[stream_id]
+        char = c_char(char.encode())
+        length = wintypes.DWORD(length)
+        num_written = wintypes.DWORD(0)
+        # Note that this is hard-coded for ANSI (vs wide) bytes.
+        success = _FillConsoleOutputCharacterA(
+            handle, char, length, start, byref(num_written))
+        return num_written.value
+
+    def FillConsoleOutputAttribute(stream_id, attr, length, start):
+        ''' FillConsoleOutputAttribute( hConsole, csbi.wAttributes, dwConSize, coordScreen, &cCharsWritten )'''
+        handle = handles[stream_id]
+        attribute = wintypes.WORD(attr)
+        length = wintypes.DWORD(length)
+        num_written = wintypes.DWORD(0)
+        # Note that this is hard-coded for ANSI (vs wide) bytes.
+        return _FillConsoleOutputAttribute(
+            handle, attribute, length, start, byref(num_written))
+
+    def SetConsoleTitle(title):
+        return _SetConsoleTitleW(title)
+
+ +
+
+
+
+
+
+

Related Topics

+ +
+ + +
+
+
+
+
+ ©2018, CEA. + + | + Powered by Sphinx 1.1.3 + & Alabaster + +
+ + + + + + \ No newline at end of file diff --git a/doc/build/html/_modules/src/colorama/winterm.html b/doc/build/html/_modules/src/colorama/winterm.html new file mode 100644 index 0000000..8f2045e --- /dev/null +++ b/doc/build/html/_modules/src/colorama/winterm.html @@ -0,0 +1,257 @@ + + + + + + + + + src.colorama.winterm — salomeTools 5.0.0dev documentation + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+ +

Source code for src.colorama.winterm

+# Copyright Jonathan Hartley 2013. BSD 3-Clause license, see LICENSE file.
+from . import win32
+
+
+# from wincon.h
+
[docs]class WinColor(object):
+    BLACK   = 0
+    BLUE    = 1
+    GREEN   = 2
+    CYAN    = 3
+    RED     = 4
+    MAGENTA = 5
+    YELLOW  = 6
+    GREY    = 7
+
+# from wincon.h

+
[docs]class WinStyle(object):
+    NORMAL              = 0x00 # dim text, dim background
+    BRIGHT              = 0x08 # bright text, dim background
+    BRIGHT_BACKGROUND   = 0x80 # dim text, bright background
+

+
[docs]class WinTerm(object):
+
+    def __init__(self):
+        self._default = win32.GetConsoleScreenBufferInfo(win32.STDOUT).wAttributes
+        self.set_attrs(self._default)
+        self._default_fore = self._fore
+        self._default_back = self._back
+        self._default_style = self._style
+        # In order to emulate LIGHT_EX in windows, we borrow the BRIGHT style.
+        # So that LIGHT_EX colors and BRIGHT style do not clobber each other,
+        # we track them separately, since LIGHT_EX is overwritten by Fore/Back
+        # and BRIGHT is overwritten by Style codes.
+        self._light = 0
+
+
[docs]    def get_attrs(self):
+        return self._fore + self._back * 16 + (self._style | self._light)
+

+
[docs]    def set_attrs(self, value):
+        self._fore = value & 7
+        self._back = (value >> 4) & 7
+        self._style = value & (WinStyle.BRIGHT | WinStyle.BRIGHT_BACKGROUND)
+

+
[docs]    def reset_all(self, on_stderr=None):
+        self.set_attrs(self._default)
+        self.set_console(attrs=self._default)
+

+
[docs]    def fore(self, fore=None, light=False, on_stderr=False):
+        if fore is None:
+            fore = self._default_fore
+        self._fore = fore
+        # Emulate LIGHT_EX with BRIGHT Style
+        if light:
+            self._light |= WinStyle.BRIGHT
+        else:
+            self._light &= ~WinStyle.BRIGHT
+        self.set_console(on_stderr=on_stderr)
+

+
[docs]    def back(self, back=None, light=False, on_stderr=False):
+        if back is None:
+            back = self._default_back
+        self._back = back
+        # Emulate LIGHT_EX with BRIGHT_BACKGROUND Style
+        if light:
+            self._light |= WinStyle.BRIGHT_BACKGROUND
+        else:
+            self._light &= ~WinStyle.BRIGHT_BACKGROUND
+        self.set_console(on_stderr=on_stderr)
+

+
[docs]    def style(self, style=None, on_stderr=False):
+        if style is None:
+            style = self._default_style
+        self._style = style
+        self.set_console(on_stderr=on_stderr)
+

+
[docs]    def set_console(self, attrs=None, on_stderr=False):
+        if attrs is None:
+            attrs = self.get_attrs()
+        handle = win32.STDOUT
+        if on_stderr:
+            handle = win32.STDERR
+        win32.SetConsoleTextAttribute(handle, attrs)
+

+
[docs]    def get_position(self, handle):
+        position = win32.GetConsoleScreenBufferInfo(handle).dwCursorPosition
+        # Because Windows coordinates are 0-based,
+        # and win32.SetConsoleCursorPosition expects 1-based.
+        position.X += 1
+        position.Y += 1
+        return position
+

+
[docs]    def set_cursor_position(self, position=None, on_stderr=False):
+        if position is None:
+            # I'm not currently tracking the position, so there is no default.
+            # position = self.get_position()
+            return
+        handle = win32.STDOUT
+        if on_stderr:
+            handle = win32.STDERR
+        win32.SetConsoleCursorPosition(handle, position)
+

+
[docs]    def cursor_adjust(self, x, y, on_stderr=False):
+        handle = win32.STDOUT
+        if on_stderr:
+            handle = win32.STDERR
+        position = self.get_position(handle)
+        adjusted_position = (position.Y + y, position.X + x)
+        win32.SetConsoleCursorPosition(handle, adjusted_position, adjust=False)
+

+
[docs]    def erase_screen(self, mode=0, on_stderr=False):
+        # 0 should clear from the cursor to the end of the screen.
+        # 1 should clear from the cursor to the beginning of the screen.
+        # 2 should clear the entire screen, and move cursor to (1,1)
+        handle = win32.STDOUT
+        if on_stderr:
+            handle = win32.STDERR
+        csbi = win32.GetConsoleScreenBufferInfo(handle)
+        # get the number of character cells in the current buffer
+        cells_in_screen = csbi.dwSize.X * csbi.dwSize.Y
+        # get number of character cells before current cursor position
+        cells_before_cursor = csbi.dwSize.X * csbi.dwCursorPosition.Y + csbi.dwCursorPosition.X
+        if mode == 0:
+            from_coord = csbi.dwCursorPosition
+            cells_to_erase = cells_in_screen - cells_before_cursor
+        if mode == 1:
+            from_coord = win32.COORD(0, 0)
+            cells_to_erase = cells_before_cursor
+        elif mode == 2:
+            from_coord = win32.COORD(0, 0)
+            cells_to_erase = cells_in_screen
+        # fill the entire screen with blanks
+        win32.FillConsoleOutputCharacter(handle, ' ', cells_to_erase, from_coord)
+        # now set the buffer's attributes accordingly
+        win32.FillConsoleOutputAttribute(handle, self.get_attrs(), cells_to_erase, from_coord)
+        if mode == 2:
+            # put the cursor where needed
+            win32.SetConsoleCursorPosition(handle, (1, 1))
+

+
[docs]    def erase_line(self, mode=0, on_stderr=False):
+        # 0 should clear from the cursor to the end of the line.
+        # 1 should clear from the cursor to the beginning of the line.
+        # 2 should clear the entire line.
+        handle = win32.STDOUT
+        if on_stderr:
+            handle = win32.STDERR
+        csbi = win32.GetConsoleScreenBufferInfo(handle)
+        if mode == 0:
+            from_coord = csbi.dwCursorPosition
+            cells_to_erase = csbi.dwSize.X - csbi.dwCursorPosition.X
+        if mode == 1:
+            from_coord = win32.COORD(0, csbi.dwCursorPosition.Y)
+            cells_to_erase = csbi.dwCursorPosition.X
+        elif mode == 2:
+            from_coord = win32.COORD(0, csbi.dwCursorPosition.Y)
+            cells_to_erase = csbi.dwSize.X
+        # fill the entire screen with blanks
+        win32.FillConsoleOutputCharacter(handle, ' ', cells_to_erase, from_coord)
+        # now set the buffer's attributes accordingly
+        win32.FillConsoleOutputAttribute(handle, self.get_attrs(), cells_to_erase, from_coord)
+

+
[docs]    def set_title(self, title):
+        win32.SetConsoleTitle(title)

+
+ +
+
+
+
+
+
+

Related Topics

+ +
+ + +
+
+
+
+
+ ©2018, CEA. + + | + Powered by Sphinx 1.1.3 + & Alabaster + +
+ + + + + + \ No newline at end of file diff --git a/doc/build/html/_modules/src/compilation.html b/doc/build/html/_modules/src/compilation.html new file mode 100644 index 0000000..2de70b5 --- /dev/null +++ b/doc/build/html/_modules/src/compilation.html @@ -0,0 +1,588 @@ + + + + + + + + + src.compilation — salomeTools 5.0.0dev documentation + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+ +

Source code for src.compilation

+#!/usr/bin/env python
+#-*- coding:utf-8 -*-
+#  Copyright (C) 2010-2013  CEA/DEN
+#
+#  This library is free software; you can redistribute it and/or
+#  modify it under the terms of the GNU Lesser General Public
+#  License as published by the Free Software Foundation; either
+#  version 2.1 of the License.
+#
+#  This library is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#  Lesser General Public License for more details.
+#
+#  You should have received a copy of the GNU Lesser General Public
+#  License along with this library; if not, write to the Free Software
+#  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+
+import os
+import subprocess
+import sys
+import shutil
+
+import src
+
+C_COMPILE_ENV_LIST = ["CC",
+                      "CXX",
+                      "F77",
+                      "CFLAGS",
+                      "CXXFLAGS",
+                      "LIBS",
+                      "LDFLAGS"]
+
+
[docs]class Builder:
+    """Class to handle all construction steps, like cmake, configure, make, ...
+    """
+    def __init__(self,
+                 config,
+                 logger,
+                 product_info,
+                 options = src.options.OptResult(),
+                 check_src=True):
+        self.config = config
+        self.logger = logger
+        self.options = options
+        self.product_info = product_info
+        self.build_dir = src.Path(self.product_info.build_dir)
+        self.source_dir = src.Path(self.product_info.source_dir)
+        self.install_dir = src.Path(self.product_info.install_dir)
+        self.header = ""
+        self.debug_mode = False
+        if "debug" in self.product_info and self.product_info.debug == "yes":
+            self.debug_mode = True
+
+    ##
+    # Shortcut method to log in log file.
+
[docs]    def log(self, text, level, showInfo=True):
+        self.logger.write(text, level, showInfo)
+        self.logger.logTxtFile.write(src.printcolors.cleancolor(text))
+        self.logger.flush()
+
+    ##
+    # Shortcut method to log a command.

+
[docs]    def log_command(self, command):
+        self.log("> %s\n" % command, 5)
+
+    ##
+    # Prepares the environment.
+    # Build two environment: one for building and one for testing (launch).

+
[docs]    def prepare(self):
+
+        if not self.build_dir.exists():
+            # create build dir
+            self.build_dir.make()
+
+        self.log('  build_dir   = %s\n' % str(self.build_dir), 4)
+        self.log('  install_dir = %s\n' % str(self.install_dir), 4)
+        self.log('\n', 4)
+
+        # add products in depend and opt_depend list recursively
+        environ_info = src.product.get_product_dependencies(self.config,
+                                                            self.product_info)
+        #environ_info.append(self.product_info.name)
+
+        # create build environment
+        self.build_environ = src.environment.SalomeEnviron(self.config,
+                                      src.environment.Environ(dict(os.environ)),
+                                      True)
+        self.build_environ.silent = (self.config.USER.output_verbose_level < 5)
+        self.build_environ.set_full_environ(self.logger, environ_info)
+        
+        # create runtime environment
+        self.launch_environ = src.environment.SalomeEnviron(self.config,
+                                      src.environment.Environ(dict(os.environ)),
+                                      False)
+        self.launch_environ.silent = True # no need to show here
+        self.launch_environ.set_full_environ(self.logger, environ_info)
+
+        for ee in C_COMPILE_ENV_LIST:
+            vv = self.build_environ.get(ee)
+            if len(vv) > 0:
+                self.log("  %s = %s\n" % (ee, vv), 4, False)
+
+        return 0
+
+    ##
+    # Runs cmake with the given options.

+
[docs]    def cmake(self, options=""):
+
+        cmake_option = options
+        # cmake_option +=' -DCMAKE_VERBOSE_MAKEFILE=ON -DSALOME_CMAKE_DEBUG=ON'
+        if 'cmake_options' in self.product_info:
+            cmake_option += " %s " % " ".join(
+                                        self.product_info.cmake_options.split())
+
+        # add debug option
+        if self.debug_mode:
+            cmake_option += " -DCMAKE_BUILD_TYPE=Debug"
+        else :
+            cmake_option += " -DCMAKE_BUILD_TYPE=Release"
+        
+        # In case CMAKE_GENERATOR is defined in environment, 
+        # use it in spite of automatically detect it
+        if 'cmake_generator' in self.config.APPLICATION:
+            cmake_option += " -DCMAKE_GENERATOR=%s" \
+                                       % self.config.APPLICATION.cmake_generator
+        
+        command = ("cmake %s -DCMAKE_INSTALL_PREFIX=%s %s" %
+                            (cmake_option, self.install_dir, self.source_dir))
+
+        self.log_command(command)
+        # for key in sorted(self.build_environ.environ.environ.keys()):
+            # print key, "  ", self.build_environ.environ.environ[key]
+        res = subprocess.call(command,
+                              shell=True,
+                              cwd=str(self.build_dir),
+                              env=self.build_environ.environ.environ,
+                              stdout=self.logger.logTxtFile,
+                              stderr=subprocess.STDOUT)
+
+        self.put_txt_log_in_appli_log_dir("cmake")
+        if res == 0:
+            return res
+        else:
+            return 1
+
+    ##
+    # Runs build_configure with the given options.

+
[docs]    def build_configure(self, options=""):
+
+        if 'buildconfigure_options' in self.product_info:
+            options += " %s " % self.product_info.buildconfigure_options
+
+        command = str('%s/build_configure') % (self.source_dir)
+        command = command + " " + options
+        self.log_command(command)
+
+        res = subprocess.call(command,
+                              shell=True,
+                              cwd=str(self.build_dir),
+                              env=self.build_environ.environ.environ,
+                              stdout=self.logger.logTxtFile,
+                              stderr=subprocess.STDOUT)
+        self.put_txt_log_in_appli_log_dir("build_configure")
+        if res == 0:
+            return res
+        else:
+            return 1
+
+    ##
+    # Runs configure with the given options.

+
[docs]    def configure(self, options=""):
+
+        if 'configure_options' in self.product_info:
+            options += " %s " % self.product_info.configure_options
+
+        command = "%s/configure --prefix=%s" % (self.source_dir,
+                                                str(self.install_dir))
+
+        command = command + " " + options
+        self.log_command(command)
+
+        res = subprocess.call(command,
+                              shell=True,
+                              cwd=str(self.build_dir),
+                              env=self.build_environ.environ.environ,
+                              stdout=self.logger.logTxtFile,
+                              stderr=subprocess.STDOUT)
+        
+        self.put_txt_log_in_appli_log_dir("configure")
+        if res == 0:
+            return res
+        else:
+            return 1
+

+
[docs]    def hack_libtool(self):
+        if not os.path.exists(str(self.build_dir + 'libtool')):
+            return
+
+        lf = open(os.path.join(str(self.build_dir), "libtool"), 'r')
+        for line in lf.readlines():
+            if 'hack_libtool' in line:
+                return
+
+        # fix libtool by replacing CC="<compil>" with hack_libtool function
+        hack_command='''sed -i "s%^CC=\\"\(.*\)\\"%hack_libtool() { \\n\\
+if test \\"\$(echo \$@ | grep -E '\\\\\\-L/usr/lib(/../lib)?(64)? ')\\" == \\\"\\\" \\n\\
+  then\\n\\
+    cmd=\\"\\1 \$@\\"\\n\\
+  else\\n\\
+    cmd=\\"\\1 \\"\`echo \$@ | sed -r -e 's|(.*)-L/usr/lib(/../lib)?(64)? (.*)|\\\\\\1\\\\\\4 -L/usr/lib\\\\\\3|g'\`\\n\\
+  fi\\n\\
+  \$cmd\\n\\
+}\\n\\
+CC=\\"hack_libtool\\"%g" libtool'''
+
+        self.log_command(hack_command)
+        subprocess.call(hack_command,
+                        shell=True,
+                        cwd=str(self.build_dir),
+                        env=self.build_environ.environ.environ,
+                        stdout=self.logger.logTxtFile,
+                        stderr=subprocess.STDOUT)
+
+
+    ##
+    # Runs make to build the module.

+
[docs]    def make(self, nb_proc, make_opt=""):
+
+        # make
+        command = 'make'
+        command = command + " -j" + str(nb_proc)
+        command = command + " " + make_opt
+        self.log_command(command)
+        res = subprocess.call(command,
+                              shell=True,
+                              cwd=str(self.build_dir),
+                              env=self.build_environ.environ.environ,
+                              stdout=self.logger.logTxtFile,
+                              stderr=subprocess.STDOUT)
+        self.put_txt_log_in_appli_log_dir("make")
+        if res == 0:
+            return res
+        else:
+            return 1
+    
+    ##
+    # Runs msbuild to build the module.

+
[docs]    def wmake(self,nb_proc, opt_nb_proc = None):
+
+        hh = 'MSBUILD /m:%s' % str(nb_proc)
+        if self.debug_mode:
+            hh += " " + src.printcolors.printcWarning("DEBUG")
+        # make
+        command = 'msbuild'
+        command = command + " /maxcpucount:" + str(nb_proc)
+        if self.debug_mode:
+            command = command + " /p:Configuration=Debug"
+        else:
+            command = command + " /p:Configuration=Release"
+        command = command + " ALL_BUILD.vcxproj"
+
+        self.log_command(command)
+        res = subprocess.call(command,
+                              shell=True,
+                              cwd=str(self.build_dir),
+                              env=self.build_environ.environ.environ,
+                              stdout=self.logger.logTxtFile,
+                              stderr=subprocess.STDOUT)
+        
+        self.put_txt_log_in_appli_log_dir("make")
+        if res == 0:
+            return res
+        else:
+            return 1
+
+    ##
+    # Runs 'make install'.

+
[docs]    def install(self):
+        if self.config.VARS.dist_name=="Win":
+            command = 'msbuild INSTALL.vcxproj'
+            if self.debug_mode:
+                command = command + " /p:Configuration=Debug"
+            else:
+                command = command + " /p:Configuration=Release"
+        else :
+            command = 'make install'
+
+        self.log_command(command)
+
+        res = subprocess.call(command,
+                              shell=True,
+                              cwd=str(self.build_dir),
+                              env=self.build_environ.environ.environ,
+                              stdout=self.logger.logTxtFile,
+                              stderr=subprocess.STDOUT)
+        
+        self.put_txt_log_in_appli_log_dir("makeinstall")
+        if res == 0:
+            return res
+        else:
+            return 1
+
+    ##
+    # Runs 'make_check'.

+
[docs]    def check(self, command=""):
+        if src.architecture.is_windows():
+            cmd = 'msbuild RUN_TESTS.vcxproj'
+        else :
+            if self.product_info.build_source=="autotools" :
+                cmd = 'make check'
+            else:
+                cmd = 'make test'
+        
+        if command:
+            cmd = command
+        
+        self.log_command(cmd)
+
+        res = subprocess.call(cmd,
+                              shell=True,
+                              cwd=str(self.build_dir),
+                              env=self.launch_environ.environ.environ,
+                              stdout=self.logger.logTxtFile,
+                              stderr=subprocess.STDOUT)
+
+        if res == 0:
+            return res
+        else:
+            return 1
+      
+    ##
+    # Performs a default build for this module.

+
[docs]    def do_default_build(self,
+                         build_conf_options="",
+                         configure_options="",
+                         show_warning=True):
+        use_autotools = False
+        if 'use_autotools' in self.product_info:
+            uc = self.product_info.use_autotools
+            if uc in ['always', 'yes']: 
+                use_autotools = True
+            elif uc == 'option': 
+                use_autotools = self.options.autotools
+
+
+        self.use_autotools = use_autotools
+
+        use_ctest = False
+        if 'use_ctest' in self.product_info:
+            uc = self.product_info.use_ctest
+            if uc in ['always', 'yes']: 
+                use_ctest = True
+            elif uc == 'option': 
+                use_ctest = self.options.ctest
+
+        self.use_ctest = use_ctest
+
+        if show_warning:
+            cmd = ""
+            if use_autotools: cmd = "(autotools)"
+            if use_ctest: cmd = "(ctest)"
+            
+            self.log("\n", 4, False)
+            self.log("%(module)s: Run default compilation method %(cmd)s\n" % \
+                { "module": self.module, "cmd": cmd }, 4)
+
+        if use_autotools:
+            if not self.prepare(): return self.get_result()
+            if not self.build_configure(
+                                   build_conf_options): return self.get_result()
+            if not self.configure(configure_options): return self.get_result()
+            if not self.make(): return self.get_result()
+            if not self.install(): return self.get_result()
+            if not self.clean(): return self.get_result()
+           
+        else: # CMake
+            if self.config.VARS.dist_name=='Win':
+                if not self.wprepare(): return self.get_result()
+                if not self.cmake(): return self.get_result()
+                if not self.wmake(): return self.get_result()
+                if not self.install(): return self.get_result()
+                if not self.clean(): return self.get_result()
+            else :
+                if not self.prepare(): return self.get_result()
+                if not self.cmake(): return self.get_result()
+                if not self.make(): return self.get_result()
+                if not self.install(): return self.get_result()
+                if not self.clean(): return self.get_result()
+
+        return self.get_result()
+
+    ##
+    # Performs a build with a script.

+
[docs]    def do_python_script_build(self, script, nb_proc):
+        # script found
+        self.logger.write(_("Compile %(product)s using script %(script)s\n") % \
+            { 'product': self.product_info.name,
+             'script': src.printcolors.printcLabel(script) }, 4)
+        try:
+            import imp
+            product = self.product_info.name
+            pymodule = imp.load_source(product + "_compile_script", script)
+            self.nb_proc = nb_proc
+            retcode = pymodule.compil(self.config, self, self.logger)
+        except:
+            __, exceptionValue, exceptionTraceback = sys.exc_info()
+            self.logger.write(str(exceptionValue), 1)
+            import traceback
+            traceback.print_tb(exceptionTraceback)
+            traceback.print_exc()
+            retcode = 1
+        finally:
+            self.put_txt_log_in_appli_log_dir("script")
+
+        return retcode
+

+
[docs]    def complete_environment(self, make_options):
+        assert self.build_environ is not None
+        # pass additional variables to environment 
+        # (may be used by the build script)
+        self.build_environ.set("SOURCE_DIR", str(self.source_dir))
+        self.build_environ.set("INSTALL_DIR", str(self.install_dir))
+        self.build_environ.set("PRODUCT_INSTALL", str(self.install_dir))
+        self.build_environ.set("BUILD_DIR", str(self.build_dir))
+        self.build_environ.set("PRODUCT_BUILD", str(self.build_dir))
+        self.build_environ.set("MAKE_OPTIONS", make_options)
+        self.build_environ.set("DIST_NAME", self.config.VARS.dist_name)
+        self.build_environ.set("DIST_VERSION", self.config.VARS.dist_version)
+        self.build_environ.set("DIST", self.config.VARS.dist)
+        self.build_environ.set("VERSION", self.product_info.version)
+

+
[docs]    def do_batch_script_build(self, script, nb_proc):
+
+        if src.architecture.is_windows():
+            make_options = "/maxcpucount:%s" % nb_proc
+        else :
+            make_options = "-j%s" % nb_proc
+
+        self.log_command("  " + _("Run build script %s\n") % script)
+        self.complete_environment(make_options)
+        
+        res = subprocess.call(script, 
+                              shell=True,
+                              stdout=self.logger.logTxtFile,
+                              stderr=subprocess.STDOUT,
+                              cwd=str(self.build_dir),
+                              env=self.build_environ.environ.environ)
+
+        self.put_txt_log_in_appli_log_dir("script")
+        if res == 0:
+            return res
+        else:
+            return 1
+    

+
[docs]    def do_script_build(self, script, number_of_proc=0):
+        # define make options (may not be used by the script)
+        if number_of_proc==0:
+            nb_proc = src.get_cfg_param(self.product_info,"nb_proc", 0)
+            if nb_proc == 0: 
+                nb_proc = self.config.VARS.nb_proc
+        else:
+            nb_proc = min(number_of_proc, self.config.VARS.nb_proc)
+            
+        extension = script.split('.')[-1]
+        if extension in ["bat","sh"]:
+            return self.do_batch_script_build(script, nb_proc)
+        if extension == "py":
+            return self.do_python_script_build(script, nb_proc)
+        
+        msg = _("The script %s must have .sh, .bat or .py extension." % script)
+        raise src.SatException(msg)
+    

+
[docs]    def put_txt_log_in_appli_log_dir(self, file_name):
+        '''Put the txt log (that contain the system logs, like make command
+           output) in the directory <APPLICATION DIR>/LOGS/<product_name>/
+    
+        :param file_name Str: the name of the file to write
+        '''
+        if self.logger.logTxtFile == sys.__stdout__:
+            return
+        dir_where_to_put = os.path.join(self.config.APPLICATION.workdir,
+                                        "LOGS",
+                                        self.product_info.name)
+        file_path = os.path.join(dir_where_to_put, file_name)
+        src.ensure_path_exists(dir_where_to_put)
+        # write the logTxtFile copy it to the destination, and then recreate 
+        # it as it was
+        self.logger.logTxtFile.close()
+        shutil.move(self.logger.txtFilePath, file_path)
+        self.logger.logTxtFile = open(str(self.logger.txtFilePath), 'w')
+        self.logger.logTxtFile.write(open(file_path, "r").read())
+        

+
+ +
+
+
+
+
+
+

Related Topics

+ +
+ + +
+
+
+
+
+ ©2018, CEA. + + | + Powered by Sphinx 1.1.3 + & Alabaster + +
+ + + + + + \ No newline at end of file diff --git a/doc/build/html/_modules/src/debug.html b/doc/build/html/_modules/src/debug.html new file mode 100644 index 0000000..8be6b29 --- /dev/null +++ b/doc/build/html/_modules/src/debug.html @@ -0,0 +1,297 @@ + + + + + + + + + src.debug — salomeTools 5.0.0dev documentation + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+ +

Source code for src.debug

+#!/usr/bin/env python
+#-*- coding:utf-8 -*-
+
+#  Copyright (C) 2010-2018  CEA/DEN
+#
+#  This library is free software; you can redistribute it and/or
+#  modify it under the terms of the GNU Lesser General Public
+#  License as published by the Free Software Foundation; either
+#  version 2.1 of the License.
+#
+#  This library is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#  Lesser General Public License for more details.
+#
+#  You should have received a copy of the GNU Lesser General Public
+#  License along with this library; if not, write to the Free Software
+#  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+
+"""\
+This file assume DEBUG functionalities use
+
+- print debug messages in sys.stderr for salomeTools
+- show pretty print debug representation from instances of SAT classes
+  (pretty print src.pyconf.Config), and python dict/list etc. (as 'aVariable')
+
+WARNING: obviously supposedly show messages in SAT development phase, not production
+
+usage:
+>> import debug as DBG
+>> DBG.write("aTitle", aVariable)        # not shown in production 
+>> DBG.write("aTitle", aVariable, True)  # unconditionaly shown (as show=True)
+
+to set show message as development phase:
+>> DBG.push_debug(True)
+
+to set no show message as production phase:
+>> DBG.push_debug(False)
+
+to set show message temporary as development phase, only in a method:
+>> def aMethodToDebug(...):
+>>   DBG.push_debug(True)              #force show as appended status
+>>   etc. method code with some DBG.write()
+>>   DBG.pop_debug()                   #restore previous status (show or not show)
+>>   return
+
+to set a message for future fix, as temporary problem to not forget:
+DBG.tofix("aTitle", aVariable, True/False) #True/False in production shown, or not
+
+in command line interface you could redirect stderr to file 'myDebug.log':
+>> sat compile ... 2> myDebug.log   # only stderr
+>> sat compile ... &> myDebug.log   # stdout and stderr
+"""
+
+import os
+import sys
+import StringIO as SIO
+import pprint as PP
+
+_debug = [False] #support push/pop for temporary activate debug outputs
+
+
[docs]def indent(text, amount=2, ch=' '):
+    """indent multi lines message"""
+    padding = amount * ch
+    return ''.join(padding + line for line in text.splitlines(True))
+

+
[docs]def write(title, var="", force=None, fmt="\n#### DEBUG: %s:\n%s\n"):
+    """write sys.stderr a message if _debug[-1]==True or optionaly force=True"""
+    if _debug[-1] or force:
+        if 'src.pyconf.' in str(type(var)): 
+            sys.stderr.write(fmt % (title, indent(getStrConfigDbg(var))))
+        elif type(var) is not str:
+            sys.stderr.write(fmt % (title, indent(PP.pformat(var))))
+        else:
+            sys.stderr.write(fmt % (title, indent(var)))
+    return
+

+
[docs]def tofix(title, var="", force=None):
+    """\
+    write sys.stderr a message if _debug[-1]==True or optionaly force=True
+    use this only if no logger accessible for classic 
+    logger.warning(message) or logger.debug(message)
+    """
+    fmt = "\n#### TOFIX: %s:\n%s\n"
+    write(title, var, force, fmt)
+

+
[docs]def push_debug(aBool):
+    """set debug outputs activated, or not"""
+    _debug.append(aBool)
+

+
[docs]def pop_debug():
+    """restore previous debug outputs status"""
+    if len(_debug) > 1:
+        return _debug.pop()
+    else:
+        sys.stderr.write("\nERROR: pop_debug: too much pop.")
+        return None
+
+###############################################
+# utilitaires divers pour debug
+###############################################
+

+
[docs]class OutStream(SIO.StringIO):
+    """utility class for pyconf.Config output iostream"""
+
[docs]    def close(self):
+      """because Config.__save__ calls close() stream as file
+      keep value before lost as self.value
+      """
+      self.value = self.getvalue()
+      SIO.StringIO.close(self)
+    

+
[docs]class InStream(SIO.StringIO):
+    """utility class for pyconf.Config input iostream"""
+    pass
+

+
[docs]def getLocalEnv():
+    """get string for environment variables representation"""
+    res = ""
+    for i in sorted(os.environ):
+        res += "%s : %s\n" % (i, os.environ[i])
+    return res
+
+# save as initial Config.save() moved as Config.__save__() 

+
[docs]def saveConfigStd(config, aStream):
+    """returns as file .pyconf"""
+    indent =  0
+    config.__save__(aStream, indent) 
+

+
[docs]def getStrConfigStd(config):
+    """set string as saveConfigStd, as file .pyconf"""
+    outStream = OutStream()
+    saveConfigStd(config, outStream)
+    return outStream.value
+

+
[docs]def getStrConfigDbg(config):
+    """\
+    set string as saveConfigDbg, 
+    as (path expression evaluation) for debug
+    """
+    outStream = OutStream()
+    saveConfigDbg(config, outStream)
+    return outStream.value
+

+
[docs]def saveConfigDbg(config, aStream, indent=0, path=""):
+    """pyconf returns multilines (path expression evaluation) for debug"""
+    _saveConfigRecursiveDbg(config, aStream, indent, path)
+    aStream.close() # as config.__save__()
+

+def _saveConfigRecursiveDbg(config, aStream, indent, path):
+    """pyconf inspired from Mapping.__save__"""
+    debug = False
+    if indent <= 0: 
+      indentp = 0
+    else:
+      indentp = indentp + 2
+    indstr = indent * ' ' # '':no indent, ' ':indent
+    strType = str(type(config))
+    if "Sequence" in strType:
+      for i in range(len(config)):
+        _saveConfigRecursiveDbg(config[i], aStream, indentp, path+"[%i]" % i)
+      return
+    try: 
+      order = object.__getattribute__(config, 'order')
+      data = object.__getattribute__(config, 'data')
+    except:
+      aStream.write("%s%s : '%s'\n" % (indstr, path, str(config)))
+      return     
+    for key in sorted(order):
+      value = data[key]
+      strType = str(type(value))
+      if debug: print indstr + 'strType = %s' % strType, key
+      if "Config" in strType:
+        _saveConfigRecursiveDbg(value, aStream, indentp, path+"."+key)
+        continue
+      if "Mapping" in strType:
+        _saveConfigRecursiveDbg(value, aStream, indentp, path+"."+key)
+        continue
+      if "Sequence" in strType:
+        for i in range(len(value)):
+          _saveConfigRecursiveDbg(value[i], aStream, indentp, path+"."+key+"[%i]" % i)
+        continue
+      if "Expression" in strType:
+        try:
+          evaluate = value.evaluate(config)
+          aStream.write("%s%s.%s : %s --> '%s'\n" % (indstr, path, key, str(value), evaluate))
+        except Exception as e:      
+          aStream.write("%s%s.%s : !!! ERROR: %s !!!\n" % (indstr, path, key, e.message))     
+        continue
+      if "Reference" in strType:
+        try:
+          evaluate = value.resolve(config)
+          aStream.write("%s%s.%s : %s --> '%s'\n" % (indstr, path, key, str(value), evaluate))
+        except Exception as e:  
+          aStream.write("%s%s.%s : !!! ERROR: %s !!!\n" % (indstr, path, key, e.message))     
+        continue
+      if type(value) in [str, bool, int, type(None), unicode]:
+        aStream.write("%s%s.%s : '%s'\n" % (indstr, path, key, str(value)))
+        continue
+      try:
+        aStream.write("!!! TODO fix that %s %s%s.%s : %s\n" % (type(value), indstr, path, key, str(value)))
+      except Exception as e:      
+        aStream.write("%s%s.%s : !!! %s\n" % (indstr, path, key, e.message))
+
+ +
+
+
+
+
+
+

Related Topics

+ +
+ + +
+
+
+
+
+ ©2018, CEA. + + | + Powered by Sphinx 1.1.3 + & Alabaster + +
+ + + + + + \ No newline at end of file diff --git a/doc/build/html/_modules/src/environment.html b/doc/build/html/_modules/src/environment.html new file mode 100644 index 0000000..94ebac1 --- /dev/null +++ b/doc/build/html/_modules/src/environment.html @@ -0,0 +1,982 @@ + + + + + + + + + src.environment — salomeTools 5.0.0dev documentation + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+ +

Source code for src.environment

+#!/usr/bin/env python
+#-*- coding:utf-8 -*-
+#  Copyright (C) 2010-2013  CEA/DEN
+#
+#  This library is free software; you can redistribute it and/or
+#  modify it under the terms of the GNU Lesser General Public
+#  License as published by the Free Software Foundation; either
+#  version 2.1 of the License.
+#
+#  This library is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#  Lesser General Public License for more details.
+#
+#  You should have received a copy of the GNU Lesser General Public
+#  License along with this library; if not, write to the Free Software
+#  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+
+import os
+import subprocess
+import string
+import sys
+
+import src
+import src.debug as DBG
+import pprint as PP
+
+
[docs]class Environ:
+    """\
+    Class to manage the environment context
+    """
+    def __init__(self, environ=None):
+        """Initialization. If the environ argument is passed, the environment
+           will be add to it, else it is the external environment.
+           
+        :param environ dict:  
+        """
+        if environ is not None:
+            self.environ = environ
+        else:
+            self.environ = os.environ
+
+    def __repr__(self):
+        """easy non exhaustive quick resume for debug print"""
+        return "%s(\n%s\n)" % (self.__class__.__name__, PP.pformat(self.environ))
+
+    def _expandvars(self, value):
+        """\
+        replace some $VARIABLE into its actual value in the environment
+        
+        :param value str: the string to be replaced
+        :return: the replaced variable
+        :rtype: str
+        """
+        if "$" in value:
+            # The string.Template class is a string class 
+            # for supporting $-substitutions
+            zt = string.Template(value)
+            try:
+                value = zt.substitute(self.environ)
+            except KeyError as exc:
+                raise src.SatException(_("Missing definition "
+                                         "in environment: %s") % str(exc))
+        return value
+
+
[docs]    def append_value(self, key, value, sep=os.pathsep):
+        """\
+        append value to key using sep
+        
+        :param key str: the environment variable to append
+        :param value str: the value to append to key
+        :param sep str: the separator string
+        """
+        # check if the key is already in the environment
+        if key in self.environ:
+            value_list = self.environ[key].split(sep)
+            # Check if the value is already in the key value or not
+            if not value in value_list:
+                value_list.append(value)
+            else:
+                value_list.append(value_list.pop(value_list.index(value)))
+            self.set(key, sep.join(value_list))
+        else:
+            self.set(key, value)
+

+
[docs]    def append(self, key, value, sep=os.pathsep):
+        """\
+        Same as append_value but the value argument can be a list
+        
+        :param key str: the environment variable to append
+        :param value str or list: the value(s) to append to key
+        :param sep str: the separator string
+        """
+        if isinstance(value, list):
+            for v in value:
+                self.append_value(key, v, sep)
+        else:
+            self.append_value(key, value, sep)
+

+
[docs]    def prepend_value(self, key, value, sep=os.pathsep):
+        """\
+        prepend value to key using sep
+        
+        :param key str: the environment variable to prepend
+        :param value str: the value to prepend to key
+        :param sep str: the separator string
+        """
+        if key in self.environ:
+            value_list = self.environ[key].split(sep)
+            if not value in value_list:
+                value_list.insert(0, value)
+            else:
+                value_list.insert(0, value_list.pop(value_list.index(value)))
+            self.set(key, sep.join(value_list))
+        else:
+            self.set(key, value)
+

+
[docs]    def prepend(self, key, value, sep=os.pathsep):
+        """\
+        Same as prepend_value but the value argument can be a list
+        
+        :param key str: the environment variable to prepend
+        :param value str or list: the value(s) to prepend to key
+        :param sep str: the separator string
+        """
+        if isinstance(value, list):
+            for v in value:
+                self.prepend_value(key, v, sep)
+        else:
+            self.prepend_value(key, value, sep)
+

+
[docs]    def is_defined(self, key):
+        """\
+        Check if the key exists in the environment
+        
+        :param key str: the environment variable to check
+        """
+        return key in self.environ.keys()
+

+
[docs]    def set(self, key, value):
+        """\
+        Set the environment variable "key" to value "value"
+        
+        :param key str: the environment variable to set
+        :param value str: the value
+        """
+        self.environ[key] = self._expandvars(value)
+

+
[docs]    def get(self, key):
+        """\
+        Get the value of the environment variable "key"
+        
+        :param key str: the environment variable
+        """
+        if key in self.environ:
+            return self.environ[key]
+        else:
+            return ""
+

+
[docs]    def command_value(self, key, command):
+        """\
+        Get the value given by the system command "command" 
+        and put it in the environment variable key
+        
+        :param key str: the environment variable
+        :param command str: the command to execute
+        """
+        value = subprocess.Popen(command,
+                                 shell=True,
+                                 stdout=subprocess.PIPE,
+                                 env=self.environ).communicate()[0]
+        self.environ[key] = value
+
+

+
[docs]class SalomeEnviron:
+    """\
+    Class to manage the environment of SALOME.
+    """
+    def __init__(self,
+                 cfg,
+                 environ,
+                 forBuild=False,
+                 for_package=None,
+                 enable_simple_env_script = True):
+        """\
+        Initialization.
+
+        :param cfg Config: the global config
+        :param environ Environ: the Environ instance where 
+                                to store the environment variables
+        :param forBuild bool: If true, it is a launch environment, 
+                              else a build one
+        :param for_package str: If not None, produce a relative environment 
+                                designed for a package. 
+        """
+        self.environ = environ
+        self.cfg = cfg
+        self.forBuild = forBuild
+        self.for_package = for_package
+        self.enable_simple_env_script = enable_simple_env_script
+        self.silent = False
+
+    def __repr__(self):
+        """easy almost exhaustive quick resume for debug print"""
+        res = {
+          "environ" : self.environ,
+          "forBuild" : self.forBuild,
+          "for_package" : self.for_package,
+        }
+        return "%s(\n%s\n)" % (self.__class__.__name__, PP.pformat(res))
+
+
[docs]    def append(self, key, value, sep=os.pathsep):
+        """\
+        append value to key using sep
+        
+        :param key str: the environment variable to append
+        :param value str: the value to append to key
+        :param sep str: the separator string
+        """
+        return self.environ.append(key, value, sep)
+

+
[docs]    def prepend(self, key, value, sep=os.pathsep):
+        """\
+        prepend value to key using sep
+        
+        :param key str: the environment variable to prepend
+        :param value str: the value to prepend to key
+        :param sep str: the separator string
+        """
+        return self.environ.prepend(key, value, sep)
+

+
[docs]    def is_defined(self, key):
+        """\
+        Check if the key exists in the environment
+        
+        :param key str: the environment variable to check
+        """
+        return self.environ.is_defined(key)
+

+
[docs]    def get(self, key):
+        """\
+        Get the value of the environment variable "key"
+        
+        :param key str: the environment variable
+        """
+        return self.environ.get(key)
+

+
[docs]    def set(self, key, value):
+        """\
+        Set the environment variable "key" to value "value"
+        
+        :param key str: the environment variable to set
+        :param value str: the value
+        """
+        # check if value needs to be evaluated
+        if value is not None and value.startswith("`") and value.endswith("`"):
+            res = subprocess.Popen("echo %s" % value,
+                                   shell=True,
+                                   stdout=subprocess.PIPE).communicate()
+            value = res[0].strip()
+
+        return self.environ.set(key, value)
+

+
[docs]    def dump(self, out):
+        """\
+        Write the environment to out
+        
+        :param out file: the stream where to write the environment
+        """
+        for k in self.environ.environ.keys():
+            try:
+                value = self.get(k)
+            except:
+                value = "?"
+            out.write("%s=%s\n" % (k, value))
+

+
[docs]    def add_line(self, nb_line):
+        """\
+        Add empty lines to the out stream (in case of file generation)
+        
+        :param nb_line int: the number of empty lines to add
+        """
+        if 'add_line' in dir(self.environ):
+            self.environ.add_line(nb_line)
+

+
[docs]    def add_comment(self, comment):
+        """\
+        Add a commentary to the out stream (in case of file generation)
+        
+        :param comment str: the commentary to add
+        """
+        if 'add_comment' in dir(self.environ):
+            self.environ.add_comment(comment)
+

+
[docs]    def add_warning(self, warning):
+        """\
+        Add a warning to the out stream (in case of file generation)
+        
+        :param warning str: the warning to add
+        """
+        if 'add_warning' in dir(self.environ):
+            self.environ.add_warning(warning)
+

+
[docs]    def finish(self, required):
+        """\
+        Add a final instruction in the out file (in case of file generation)
+        
+        :param required bool: Do nothing if required is False
+        """
+        if 'finish' in dir(self.environ):
+            self.environ.add_line(1)
+            self.environ.add_comment("clean all the path")
+            self.environ.finish(required)
+

+
[docs]    def set_python_libdirs(self):
+        """Set some generic variables for python library paths"""
+        ver = self.get('PYTHON_VERSION')
+        self.set('PYTHON_LIBDIR0', os.path.join('lib',
+                                                'python' + ver,
+                                                'site-packages'))
+        self.set('PYTHON_LIBDIR1', os.path.join('lib64',
+                                                'python' + ver,
+                                                'site-packages'))
+          
+        self.python_lib0 = self.get('PYTHON_LIBDIR0')
+        self.python_lib1 = self.get('PYTHON_LIBDIR1')
+

+
[docs]    def get_names(self, lProducts):
+        """\
+        Get the products name to add in SALOME_MODULES environment variable
+        It is the name of the product, except in the case where the is a 
+        component name. And it has to be in SALOME_MODULES variable only 
+        if the product has the property has_salome_hui = "yes"
+        
+        :param lProducts list: List of products to potentially add
+        """
+        lProdHasGui = [p for p in lProducts if 'properties' in 
+            src.product.get_product_config(self.cfg, p) and
+            'has_salome_gui' in 
+            src.product.get_product_config(self.cfg, p).properties and
+            src.product.get_product_config(self.cfg,
+                                           p).properties.has_salome_gui=='yes']
+        lProdName = []
+        for ProdName in lProdHasGui:
+            pi = src.product.get_product_config(self.cfg, ProdName)
+            if 'component_name' in pi:
+                lProdName.append(pi.component_name)
+            else:
+                lProdName.append(ProdName)
+        return lProdName
+

+
[docs]    def set_application_env(self, logger):
+        """\
+        Sets the environment defined in the APPLICATION file.
+        
+        :param logger Logger: The logger instance to display messages
+        """
+        
+        # add variable PRODUCT_ROOT_DIR as $workdir in APPLICATION.environ section if not present
+        try: 
+          tmp = self.cfg.APPLICATION.environ.PRODUCT_ROOT_DIR
+        except:
+          self.cfg.APPLICATION.environ.PRODUCT_ROOT_DIR = src.pyconf.Reference(self.cfg, src.pyconf.DOLLAR, "workdir")
+          DBG.write("set_application_env add default Config.APPLICATION.environ.PRODUCT_ROOT_DIR", self.cfg.APPLICATION.environ)
+          
+        # Set the variables defined in the "environ" section
+        if 'environ' in self.cfg.APPLICATION:
+            # we write PRODUCT environment it in order to conform to 
+            # parseConfigFile.py
+            self.add_comment("PRODUCT environment") 
+            self.load_cfg_environment(self.cfg.APPLICATION.environ)
+            if self.forBuild and "build" in self.cfg.APPLICATION.environ:
+                self.load_cfg_environment(self.cfg.APPLICATION.environ.build)
+            if not self.forBuild and "launch" in self.cfg.APPLICATION.environ:
+                self.load_cfg_environment(self.cfg.APPLICATION.environ.launch)
+            self.add_line(1)
+
+        # If there is an "environ_script" section, load the scripts
+        if 'environ_script' in self.cfg.APPLICATION:
+            for pscript in self.cfg.APPLICATION.environ_script:
+                self.add_comment("script %s" % pscript)
+                sname = pscript.replace(" ", "_")
+                self.run_env_script("APPLICATION_%s" % sname,
+                                self.cfg.APPLICATION.environ_script[pscript],
+                                logger)
+                self.add_line(1)       
+

+
[docs]    def set_salome_minimal_product_env(self, product_info, logger):
+        """\
+        Sets the minimal environment for a SALOME product.
+        xxx_ROOT_DIR and xxx_SRC_DIR
+        
+        :param product_info Config: The product description
+        :param logger Logger: The logger instance to display messages        
+        """
+        # set root dir
+        DBG.write("set_salome_minimal_product_env", product_info)
+        root_dir = product_info.name + "_ROOT_DIR"
+        if not self.is_defined(root_dir):
+            if 'install_dir' in product_info and product_info.install_dir:
+                self.set(root_dir, product_info.install_dir)
+            elif not self.silent:
+                logger.write("  " + _("No install_dir for product %s\n") %
+                              product_info.name, 5)
+        
+        source_in_package = src.get_property_in_product_cfg(product_info,
+                                                           "sources_in_package")
+        if not self.for_package or source_in_package == "yes":
+            # set source dir, unless no source dir
+            if not src.product.product_is_fixed(product_info):
+                src_dir = product_info.name + "_SRC_DIR"
+                if not self.is_defined(src_dir):
+                    if not self.for_package:
+                        self.set(src_dir, product_info.source_dir)
+                    else:
+                        self.set(src_dir, os.path.join("out_dir_Path",
+                                                       "SOURCES",
+                                                       product_info.name))
+

+
[docs]    def set_salome_generic_product_env(self, pi):
+        """\
+        Sets the generic environment for a SALOME product.
+        
+        :param pi Config: The product description
+        """
+        # Construct XXX_ROOT_DIR
+        env_root_dir = self.get(pi.name + "_ROOT_DIR")
+        l_binpath_libpath = []
+
+        # create additional ROOT_DIR for CPP components
+        if 'component_name' in pi:
+            compo_name = pi.component_name
+            if compo_name + "CPP" == pi.name:
+                compo_root_dir = compo_name + "_ROOT_DIR"
+                envcompo_root_dir = os.path.join(
+                            self.cfg.TOOLS.common.install_root, compo_name )
+                self.set(compo_root_dir ,  envcompo_root_dir)
+                bin_path = os.path.join(envcompo_root_dir, 'bin', 'salome')
+                lib_path = os.path.join(envcompo_root_dir, 'lib', 'salome')
+                l_binpath_libpath.append( (bin_path, lib_path) )
+
+        if src.get_property_in_product_cfg(pi, "fhs"):
+            lib_path = os.path.join(env_root_dir, 'lib')
+            pylib1_path = os.path.join(env_root_dir, self.python_lib0)
+            pylib2_path = os.path.join(env_root_dir, self.python_lib1)
+            bin_path = os.path.join(env_root_dir, 'bin')
+        else:
+            lib_path = os.path.join(env_root_dir, 'lib', 'salome')
+            pylib1_path = os.path.join(env_root_dir, self.python_lib0, 'salome')
+            pylib2_path = os.path.join(env_root_dir, self.python_lib1, 'salome')
+            bin_path = os.path.join(env_root_dir, 'bin', 'salome')
+
+        # Construct the paths to prepend to PATH and LD_LIBRARY_PATH and 
+        # PYTHONPATH
+        l_binpath_libpath.append( (bin_path, lib_path) )
+
+        for bin_path, lib_path in l_binpath_libpath:
+            if not self.forBuild:
+                self.prepend('PATH', bin_path)
+                if src.architecture.is_windows():
+                    self.prepend('PATH', lib_path)
+                else :
+                    self.prepend('LD_LIBRARY_PATH', lib_path)
+
+            l = [ bin_path, lib_path, pylib1_path, pylib2_path ]
+            self.prepend('PYTHONPATH', l)
+

+
[docs]    def set_cpp_env(self, product_info):
+        """\
+        Sets the generic environment for a SALOME cpp product.
+        
+        :param product_info Config: The product description
+        """
+        # Construct XXX_ROOT_DIR
+        env_root_dir = self.get(product_info.name + "_ROOT_DIR")
+        l_binpath_libpath = []
+
+        # Construct the paths to prepend to PATH and LD_LIBRARY_PATH and 
+        # PYTHONPATH
+        bin_path = os.path.join(env_root_dir, 'bin')
+        lib_path = os.path.join(env_root_dir, 'lib')
+        l_binpath_libpath.append( (bin_path, lib_path) )
+
+        for bin_path, lib_path in l_binpath_libpath:
+            if not self.forBuild:
+                self.prepend('PATH', bin_path)
+                if src.architecture.is_windows():
+                    self.prepend('PATH', lib_path)
+                else :
+                    self.prepend('LD_LIBRARY_PATH', lib_path)
+
+            l = [ bin_path, lib_path,
+                  os.path.join(env_root_dir, self.python_lib0),
+                  os.path.join(env_root_dir, self.python_lib1)
+                ]
+            self.prepend('PYTHONPATH', l)
+

+
[docs]    def load_cfg_environment(self, cfg_env):
+        """\
+        Loads environment defined in cfg_env 
+        
+        :param cfg_env Config: A config containing an environment    
+        """
+        # Loop on cfg_env values
+        for env_def in cfg_env:
+            val = cfg_env[env_def]
+            
+            # if it is env_script, do not do anything (reserved keyword)
+            if env_def == "env_script":
+                continue
+            
+            # if it is a dict, do not do anything
+            if isinstance(val, src.pyconf.Mapping):
+                continue
+
+            # if it is a list, loop on its values
+            if isinstance(val, src.pyconf.Sequence):
+                # transform into list of strings
+                l_val = []
+                for item in val:
+                    l_val.append(item)
+                val = l_val
+
+            # "_" means that the value must be prepended
+            if env_def.startswith("_"):
+                # separator exception for PV_PLUGIN_PATH
+                if env_def[1:] == 'PV_PLUGIN_PATH':
+                    self.prepend(env_def[1:], val, ';')
+                else:
+                    self.prepend(env_def[1:], val)
+            elif env_def.endswith("_"):
+                # separator exception for PV_PLUGIN_PATH
+                if env_def[:-1] == 'PV_PLUGIN_PATH':
+                    self.append(env_def[:-1], val, ';')
+                else:
+                    self.append(env_def[:-1], val)
+            else:
+                self.set(env_def, val)
+

+
[docs]    def set_a_product(self, product, logger):
+        """\
+        Sets the environment of a product. 
+        
+        :param product str: The product name
+        :param logger Logger: The logger instance to display messages
+        """
+
+        # Get the informations corresponding to the product
+        pi = src.product.get_product_config(self.cfg, product)
+
+        # skip mesa products (if any) at run time, 
+        # unless use_mesa property was activated
+        if not self.forBuild:
+            if not ("APPLICATION" in self.cfg  and
+                    "properties" in self.cfg.APPLICATION  and
+                    "use_mesa" in self.cfg.APPLICATION.properties  and
+                    self.cfg.APPLICATION.properties.use_mesa == "yes") :
+                if ("properties" in pi and
+                    "is_mesa" in pi.properties  and
+                    pi.properties.is_mesa == "yes") :
+                    logger.write(_("Skip mesa product %s\n") % pi.name, 4)
+                    return
+               
+        
+        if self.for_package:
+            pi.install_dir = os.path.join("out_dir_Path",
+                                          self.for_package,
+                                          pi.name)
+
+        if not self.silent:
+            logger.write(_("Setting environment for %s\n") % product, 4)
+
+        self.add_line(1)
+        self.add_comment('setting environ for ' + product)
+            
+        # Do not define environment if the product is native
+        if src.product.product_is_native(pi):
+            if src.product.product_has_env_script(pi):
+                self.run_env_script(pi, native=True)
+            return
+               
+        # Set an additional environment for SALOME products
+        if src.product.product_is_salome(pi):
+            # set environment using definition of the product
+            self.set_salome_minimal_product_env(pi, logger)
+            self.set_salome_generic_product_env(pi)
+        
+        if src.product.product_is_cpp(pi):
+            # set a specific environment for cpp modules
+            self.set_salome_minimal_product_env(pi, logger)
+            self.set_cpp_env(pi)
+            
+            if src.product.product_is_generated(pi):
+                if "component_name" in pi:
+                    # hack the source and install directories in order to point  
+                    # on the generated product source install directories
+                    install_dir_save = pi.install_dir
+                    source_dir_save = pi.source_dir
+                    name_save = pi.name
+                    pi.install_dir = os.path.join(self.cfg.APPLICATION.workdir,
+                                                  "INSTALL",
+                                                  pi.component_name)
+                    if self.for_package:
+                        pi.install_dir = os.path.join("out_dir_Path",
+                                                      self.for_package,
+                                                      pi.component_name)
+                    pi.source_dir = os.path.join(self.cfg.APPLICATION.workdir,
+                                                  "GENERATED",
+                                                  pi.component_name)
+                    pi.name = pi.component_name
+                    self.set_salome_minimal_product_env(pi, logger)
+                    self.set_salome_generic_product_env(pi)
+                    
+                    # Put original values
+                    pi.install_dir = install_dir_save
+                    pi.source_dir = source_dir_save
+                    pi.name = name_save
+        
+        # Put the environment define in the configuration of the product
+        if "environ" in pi:
+            self.load_cfg_environment(pi.environ)
+            if self.forBuild and "build" in pi.environ:
+                self.load_cfg_environment(pi.environ.build)
+            if not self.forBuild and "launch" in pi.environ:
+                self.load_cfg_environment(pi.environ.launch)
+            # if product_info defines a env_scripts, load it
+            if 'env_script' in pi.environ:
+                self.run_env_script(pi, logger)
+
+        
+            
+

+
[docs]    def run_env_script(self, product_info, logger=None, native=False):
+        """\
+        Runs an environment script. 
+        
+        :param product_info Config: The product description
+        :param logger Logger: The logger instance to display messages
+        :param native Boolean: if True load set_native_env instead of set_env
+        """
+        env_script = product_info.environ.env_script
+        # Check that the script exists
+        if not os.path.exists(env_script):
+            raise src.SatException(_("Environment script not found: %s") % 
+                                   env_script)
+
+        if not self.silent and logger is not None:
+            logger.write("  ** load %s\n" % env_script, 4)
+
+        # import the script and run the set_env function
+        try:
+            import imp
+            pyproduct = imp.load_source(product_info.name + "_env_script",
+                                        env_script)
+            if not native:
+                pyproduct.set_env(self,
+                                  product_info.install_dir,
+                                  product_info.version)
+            else:
+                if "set_nativ_env" in dir(pyproduct):
+                    pyproduct.set_nativ_env(self)
+        except:
+            __, exceptionValue, exceptionTraceback = sys.exc_info()
+            print(exceptionValue)
+            import traceback
+            traceback.print_tb(exceptionTraceback)
+            traceback.print_exc()
+

+
[docs]    def run_simple_env_script(self, script_path, logger=None):
+        """\
+        Runs an environment script. Same as run_env_script, but with a 
+        script path as parameter.
+        
+        :param script_path str: a path to an environment script
+        :param logger Logger: The logger instance to display messages
+        """
+        if not self.enable_simple_env_script:
+            return
+        # Check that the script exists
+        if not os.path.exists(script_path):
+            raise src.SatException(_("Environment script not found: %s") % 
+                                   script_path)
+
+        if not self.silent and logger is not None:
+            logger.write("  ** load %s\n" % script_path, 4)
+
+        script_basename = os.path.basename(script_path)
+        if script_basename.endswith(".py"):
+            script_basename = script_basename[:-len(".py")]
+
+        # import the script and run the set_env function
+        try:
+            import imp
+            pyproduct = imp.load_source(script_basename + "_env_script",
+                                        script_path)
+            pyproduct.load_env(self)
+        except:
+            __, exceptionValue, exceptionTraceback = sys.exc_info()
+            print(exceptionValue)
+            import traceback
+            traceback.print_tb(exceptionTraceback)
+            traceback.print_exc()
+

+
[docs]    def set_products(self, logger, src_root=None):
+        """\
+        Sets the environment for all the products. 
+        
+        :param logger Logger: The logger instance to display messages
+        :param src_root src: the application working directory
+        """
+        self.add_line(1)
+        self.add_comment('setting environ for all products')
+
+        # Make sure that the python lib dirs are set after python
+        if "Python" in self.cfg.APPLICATION.products:
+            self.set_a_product("Python", logger)
+            self.set_python_libdirs()
+
+        # The loop on the products
+        for product in self.cfg.APPLICATION.products.keys():
+            if product == "Python":
+                continue
+            self.set_a_product(product, logger)
+            self.finish(False)
+ 

+
[docs]    def set_full_environ(self, logger, env_info):
+        """\
+        Sets the full environment for products 
+        specified in env_info dictionary. 
+        
+        :param logger Logger: The logger instance to display messages
+        :param env_info list: the list of products
+        """
+        DBG.write("set_full_environ for", env_info)
+        # DBG.write("set_full_environ config", self.cfg.APPLICATION.environ, True)
+        # set product environ
+        self.set_application_env(logger)
+
+        self.set_python_libdirs()
+
+        # set products
+        for product in env_info:
+            self.set_a_product(product, logger)
+

+
[docs]class FileEnvWriter:
+    """\
+    Class to dump the environment to a file.
+    """
+    def __init__(self, config, logger, out_dir, src_root, env_info=None):
+        """\
+        Initialization.
+
+        :param cfg Config: the global config
+        :param logger Logger: The logger instance to display messages
+        :param out_dir str: The directory path where t put the output files
+        :param src_root str: The application working directory
+        :param env_info str: The list of products to add in the files.
+        """
+        self.config = config
+        self.logger = logger
+        self.out_dir = out_dir
+        self.src_root= src_root
+        self.silent = True
+        self.env_info = env_info
+
+
[docs]    def write_env_file(self, filename, forBuild, shell, for_package = None):
+        """\
+        Create an environment file.
+        
+        :param filename str: the file path
+        :param forBuild bool: if true, the build environment
+        :param shell str: the type of file wanted (.sh, .bat)
+        :return: The path to the generated file
+        :rtype: str
+        """
+        if not self.silent:
+            self.logger.write(_("Create environment file %s\n") % 
+                              src.printcolors.printcLabel(filename), 3)
+
+        # create then env object
+        env_file = open(os.path.join(self.out_dir, filename), "w")
+        tmp = src.fileEnviron.get_file_environ(env_file,
+                                               shell,
+                                               {})
+        env = SalomeEnviron(self.config, tmp, forBuild, for_package=for_package)
+        env.silent = self.silent
+
+        # Set the environment
+        if self.env_info is not None:
+            env.set_full_environ(self.logger, self.env_info)
+        else:
+            # set env from the APPLICATION
+            env.set_application_env(self.logger)
+            
+            # The list of products to launch
+            lProductsName = env.get_names(self.config.APPLICATION.products.keys())
+            env.set( "SALOME_MODULES",    ','.join(lProductsName))
+            
+            # set the products
+            env.set_products(self.logger,
+                            src_root=self.src_root)
+
+        # add cleanup and close
+        env.finish(True)
+        env_file.close()
+
+        return env_file.name
+   

+
[docs]    def write_cfgForPy_file(self,
+                            filename,
+                            additional_env = {},
+                            for_package = None,
+                            with_commercial = True):
+        """\
+        Append to current opened aFile a cfgForPy 
+        environment (SALOME python launcher).
+           
+        :param filename str: the file path
+        :param additional_env dict: a dictionary of additional variables 
+                                    to add to the environment
+        :param for_package str: If not None, produce a relative environment 
+                                designed for a package. 
+        """
+        if not self.silent:
+            self.logger.write(_("Create configuration file %s\n") % 
+                              src.printcolors.printcLabel(filename.name), 3)
+
+        # create then env object
+        tmp = src.fileEnviron.get_file_environ(filename, 
+                                               "cfgForPy", 
+                                               {})
+        # environment for launch
+        env = SalomeEnviron(self.config,
+                            tmp,
+                            forBuild=False,
+                            for_package=for_package,
+                            enable_simple_env_script = with_commercial)
+        env.silent = self.silent
+
+        if self.env_info is not None:
+            env.set_full_environ(self.logger, self.env_info)
+        else:
+            # set env from PRODUCT
+            env.set_application_env(self.logger)
+
+            # The list of products to launch
+            lProductsName = env.get_names(self.config.APPLICATION.products.keys())
+            env.set( "SALOME_MODULES",    ','.join(lProductsName))
+
+            # set the products
+            env.set_products(self.logger,
+                            src_root=self.src_root)
+
+        # Add the additional environment if it is not empty
+        if len(additional_env) != 0:
+            for variable in additional_env:
+                env.set(variable, additional_env[variable])
+
+        # add cleanup and close
+        env.finish(True)
+

+
[docs]class Shell:
+    """\
+    Definition of a Shell.
+    """
+    def __init__(self, name, extension):
+        """\
+        Initialization.
+
+        :param name str: the shell name
+        :param extension str: the shell extension
+        """
+        self.name = name
+        self.extension = extension
+

+
[docs]def load_environment(config, build, logger):
+    """\
+    Loads the environment (used to run the tests, for example).
+    
+    :param config Config: the global config
+    :param build bool: build environement if True
+    :param logger Logger: The logger instance to display messages
+    """
+    environ = SalomeEnviron(config, Environ(os.environ), build)
+    environ.set_application_env(logger)
+    environ.set_products(logger)
+    environ.finish(True)

+
+ +
+
+
+
+
+
+

Related Topics

+ +
+ + +
+
+
+
+
+ ©2018, CEA. + + | + Powered by Sphinx 1.1.3 + & Alabaster + +
+ + + + + + \ No newline at end of file diff --git a/doc/build/html/_modules/src/fileEnviron.html b/doc/build/html/_modules/src/fileEnviron.html new file mode 100644 index 0000000..9a087bb --- /dev/null +++ b/doc/build/html/_modules/src/fileEnviron.html @@ -0,0 +1,964 @@ + + + + + + + + + src.fileEnviron — salomeTools 5.0.0dev documentation + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+ +

Source code for src.fileEnviron

+#!/usr/bin/env python
+#-*- coding:utf-8 -*-
+#  Copyright (C) 2010-2013  CEA/DEN
+#
+#  This library is free software; you can redistribute it and/or
+#  modify it under the terms of the GNU Lesser General Public
+#  License as published by the Free Software Foundation; either
+#  version 2.1 of the License.
+#
+#  This library is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#  Lesser General Public License for more details.
+#
+#  You should have received a copy of the GNU Lesser General Public
+#  License along with this library; if not, write to the Free Software
+#  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+
+import os
+import pprint as PP
+import src.debug as DBG
+
+bat_header="""\
+@echo off
+
+rem The following variables are used only in case of a sat package
+set out_dir_Path=%~dp0
+set PRODUCT_OUT_DIR=%out_dir_Path%
+set prereq_install_Path=%out_dir_Path%\PREREQUISITES\INSTALL
+set prereq_build_Path=%out_dir_Path%\PREREQUISITES\BUILD
+"""
+
+
+bash_header="""\
+#!/bin/bash
+##########################################################################
+#
+#### cleandup ###
+# cleanup a path (first parameter) from duplicated entries;
+# second parameter is the separator
+cleandup() {
+out_var=`echo $1 | awk -v sep=$2 '{                      \\
+     na = split($1,a,sep);                               \\
+     k=0;                                                \\
+     for(i=0;i<=na;i++) {                                \\
+       found=0;                                          \\
+       for(j=0;j<k;j++) {                                \\
+         if(a[i]==aa[j])                                 \\
+         {                                               \\
+           found=1;                                      \\
+           break;                                        \\
+         };                                              \\
+       };                                                \\
+       if(found==0) {                                    \\
+         aa[k++]=a[i];                                   \\
+       };                                                \\
+     };                                                  \\
+     ORS=sep;                                            \\
+     for(i=0;i<k;i++) {                                  \\
+       print aa[i];                                      \\
+     }                                                   \\
+   }' | sed -e 's|\\(.*\\)$1|\\1|g' -e 's|^[:;]||' -e 's|[:;]$||'`
+echo $out_var
+}
+### clean ###
+clean ()
+{
+xenv=`printenv $1`
+out_var=`cleandup $xenv $2`
+export $1=$out_var
+}
+
+# The 3 following variables are used only in case of a sat package
+export out_dir_Path=$(cd $(dirname ${BASH_SOURCE[0]});pwd)
+export PRODUCT_OUT_DIR=${out_dir_Path}
+export PRODUCT_ROOT_DIR=${PRODUCT_OUT_DIR}
+
+###########################################################################
+"""
+
+cfg_header="""\
+[SALOME Configuration]
+"""
+
+Launcher_header="""\
+# a generated SALOME Configuration file using python syntax
+"""
+
+
[docs]def get_file_environ(output, shell, environ=None):
+    """Instantiate correct FileEnvironment sub-class.
+    
+    :param output file: the output file stream.
+    :param shell str: the type of shell syntax to use.
+    :param environ dict: a potential additional environment.
+    """
+    if shell == "bash":
+        return BashFileEnviron(output, environ)
+    if shell == "bat":
+        return BatFileEnviron(output, environ)
+    if shell == "cfgForPy":
+        return LauncherFileEnviron(output, environ)
+    if shell == "cfg":
+        return ContextFileEnviron(output, environ)
+    raise Exception("FileEnviron: Unknown shell = %s" % shell)
+

+
[docs]class FileEnviron(object):
+    """\
+    Base class for shell environment
+    """
+    def __init__(self, output, environ=None):
+        """\
+        Initialization
+        
+        :param output file: the output file stream.
+        :param environ dict: a potential additional environment.
+        """
+        self._do_init(output, environ)
+
+    def __repr__(self):
+        """\
+        easy non exhaustive quick resume for debug print"""
+        res = {
+          "output" : self.output,
+          "environ" : self.environ,
+        }
+        return "%s(\n%s\n)" % (self.__class__.__name__, PP.pformat(res))
+        
+
+    def _do_init(self, output, environ=None):
+        """\
+        Initialization
+        
+        :param output file: the output file stream.
+        :param environ dict: a potential additional environment.
+        """
+        self.output = output
+        self.toclean = []
+        if environ is not None:
+            #if str(type(environ)) == "<type 'instance'>":
+            if id(environ) == id(os.environ):
+               DBG.tofix("set %s environ as python os.environ, are you sure it is safe ?" % self.__class__.__name__, True)
+            self.environ = environ
+        else:
+            DBG.tofix("set %s environ as COPY of python os.environ, are you sure it is safe ?" % self.__class__.__name__, True)
+            self.environ = dict(os.environ) #make a copy cvw 180320
+
+
[docs]    def add_line(self, number):
+        """\
+        Add some empty lines in the shell file
+        
+        :param number int: the number of lines to add
+        """
+        self.output.write("\n" * number)
+

+
[docs]    def add_comment(self, comment):
+        """\
+        Add a comment in the shell file
+        
+        :param comment str: the comment to add
+        """
+        self.output.write("# %s\n" % comment)
+

+
[docs]    def add_echo(self, text):
+        """\
+        Add a "echo" in the shell file
+        
+        :param text str: the text to echo
+        """
+        self.output.write('echo %s"\n' % text)
+

+
[docs]    def add_warning(self, warning):
+        """\
+        Add a warning "echo" in the shell file
+        
+        :param warning str: the text to echo
+        """
+        self.output.write('echo "WARNING %s"\n' % warning)
+

+
[docs]    def append_value(self, key, value, sep=os.pathsep):
+        """\
+        append value to key using sep
+        
+        :param key str: the environment variable to append
+        :param value str: the value to append to key
+        :param sep str: the separator string
+        """
+        self.set(key, self.get(key) + sep + value)
+        if (key, sep) not in self.toclean:
+            self.toclean.append((key, sep))
+

+
[docs]    def append(self, key, value, sep=os.pathsep):
+        """\
+        Same as append_value but the value argument can be a list
+        
+        :param key str: the environment variable to append
+        :param value str or list: the value(s) to append to key
+        :param sep str: the separator string
+        """
+        if isinstance(value, list):
+            self.append_value(key, sep.join(value), sep)
+        else:
+            self.append_value(key, value, sep)
+

+
[docs]    def prepend_value(self, key, value, sep=os.pathsep):
+        """\
+        prepend value to key using sep
+        
+        :param key str: the environment variable to prepend
+        :param value str: the value to prepend to key
+        :param sep str: the separator string
+        """
+        self.set(key, value + sep + self.get(key))
+        if (key, sep) not in self.toclean:
+            self.toclean.append((key, sep))
+

+
[docs]    def prepend(self, key, value, sep=os.pathsep):
+        """\
+        Same as prepend_value but the value argument can be a list
+        
+        :param key str: the environment variable to prepend
+        :param value str or list: the value(s) to prepend to key
+        :param sep str: the separator string
+        """
+        if isinstance(value, list):
+            self.prepend_value(key, sep.join(value), sep)
+        else:
+            self.prepend_value(key, value, sep)
+

+
[docs]    def is_defined(self, key):
+        """\
+        Check if the key exists in the environment
+        
+        :param key str: the environment variable to check
+        """
+        return (key in self.environ)
+

+
[docs]    def set(self, key, value):
+        """\
+        Set the environment variable 'key' to value 'value'
+        
+        :param key str: the environment variable to set
+        :param value str: the value
+        """
+        raise NotImplementedError("set is not implement for this shell!")
+

+
[docs]    def get(self, key):
+        """\
+        Get the value of the environment variable "key"
+        
+        :param key str: the environment variable
+        """
+        return '${%s}' % key
+

+
[docs]    def command_value(self, key, command):
+        """\
+        Get the value given by the system command "command" 
+        and put it in the environment variable key.
+        Has to be overwritten in the derived classes
+        This can be seen as a virtual method
+        
+        :param key str: the environment variable
+        :param command str: the command to execute
+        """
+        raise NotImplementedError("command_value is not implement "
+                                  "for this shell!")
+

+
[docs]    def finish(self, required=True):
+        """Add a final instruction in the out file (in case of file generation)
+        
+        :param required bool: Do nothing if required is False
+        """
+        for (key, sep) in self.toclean:
+            if sep != ' ':
+                self.output.write('clean %s "%s"\n' % (key, sep))
+

+
[docs]class BashFileEnviron(FileEnviron):
+    """\
+    Class for bash shell.
+    """
+    def __init__(self, output, environ=None):
+        """Initialization
+        
+        :param output file: the output file stream.
+        :param environ dict: a potential additional environment.
+        """
+        self._do_init(output, environ)
+        self.output.write(bash_header)
+
+
[docs]    def set(self, key, value):
+        """Set the environment variable "key" to value "value"
+        
+        :param key str: the environment variable to set
+        :param value str: the value
+        """
+        self.output.write('export %s="%s"\n' % (key, value))
+        self.environ[key] = value
+

+
[docs]    def command_value(self, key, command):
+        """\
+        Get the value given by the system command "command" 
+        and put it in the environment variable key.
+        Has to be overwritten in the derived classes
+        This can be seen as a virtual method
+        
+        :param key str: the environment variable
+        :param command str: the command to execute
+        """
+        self.output.write('export %s=$(%s)\n' % (key, command))
+

+
[docs]    def finish(self, required=True):
+        """Add a final instruction in the out file (in case of file generation)
+        
+        :param required bool: Do nothing if required is False
+        """
+        if not required:
+            return
+        FileEnviron.finish(self, required)
+        

+
[docs]class BatFileEnviron(FileEnviron):
+    """\
+    for Windows batch shell.
+    """
+    def __init__(self, output, environ=None):
+        """Initialization
+        
+        :param output file: the output file stream.
+        :param environ dict: a potential additional environment.
+        """
+        self._do_init(output, environ)
+        self.output.write(bat_header)
+
+
[docs]    def add_comment(self, comment):
+        """Add a comment in the shell file
+        
+        :param comment str: the comment to add
+        """
+        self.output.write("rem %s\n" % comment)
+    

+
[docs]    def get(self, key):
+        """Get the value of the environment variable "key"
+        
+        :param key str: the environment variable
+        """
+        return '%%%s%%' % key
+    

+
[docs]    def set(self, key, value):
+        """Set the environment variable "key" to value "value"
+        
+        :param key str: the environment variable to set
+        :param value str: the value
+        """
+        self.output.write('set %s=%s\n' % (key, value))
+        self.environ[key] = value
+

+
[docs]    def command_value(self, key, command):
+        """\
+        Get the value given by the system command "command" 
+        and put it in the environment variable key.
+        Has to be overwritten in the derived classes
+        This can be seen as a virtual method
+        
+        :param key str: the environment variable
+        :param command str: the command to execute
+        """
+        self.output.write('%s > tmp.txt\n' % (command))
+        self.output.write('set /p %s =< tmp.txt\n' % (key))
+

+
[docs]    def finish(self, required=True):
+        """\
+        Add a final instruction in the out file (in case of file generation)
+        In the particular windows case, do nothing
+        
+        :param required bool: Do nothing if required is False
+        """
+        return
+

+
[docs]class ContextFileEnviron(FileEnviron):
+    """Class for a salome context configuration file.
+    """
+    def __init__(self, output, environ=None):
+        """Initialization
+        
+        :param output file: the output file stream.
+        :param environ dict: a potential additional environment.
+        """
+        self._do_init(output, environ)
+        self.output.write(cfg_header)
+
+
[docs]    def set(self, key, value):
+        """Set the environment variable "key" to value "value"
+        
+        :param key str: the environment variable to set
+        :param value str: the value
+        """
+        self.output.write('%s="%s"\n' % (key, value))
+        self.environ[key] = value
+

+
[docs]    def get(self, key):
+        """Get the value of the environment variable "key"
+        
+        :param key str: the environment variable
+        """
+        return '%({0})s'.format(key)
+

+
[docs]    def command_value(self, key, command):
+        """\
+        Get the value given by the system command "command" 
+        and put it in the environment variable key.
+        Has to be overwritten in the derived classes
+        This can be seen as a virtual method
+        
+        :param key str: the environment variable
+        :param command str: the command to execute
+        """
+        raise NotImplementedError("command_value is not implement "
+                                  "for salome context files!")
+

+
[docs]    def add_echo(self, text):
+        """Add a comment
+        
+        :param text str: the comment to add
+        """
+        self.add_comment(text)
+

+
[docs]    def add_warning(self, warning):
+        """Add a warning
+        
+        :param text str: the warning to add
+        """
+        self.add_comment("WARNING %s"  % warning)
+

+
[docs]    def prepend_value(self, key, value, sep=os.pathsep):
+        """prepend value to key using sep
+        
+        :param key str: the environment variable to prepend
+        :param value str: the value to prepend to key
+        :param sep str: the separator string
+        """
+        self.output.write('ADD_TO_%s: %s\n' % (key, value))
+

+
[docs]    def append_value(self, key, value, sep=os.pathsep):
+        """append value to key using sep
+        
+        :param key str: the environment variable to append
+        :param value str: the value to append to key
+        :param sep str: the separator string
+        """
+        self.prepend_value(key, value)
+

+
[docs]    def finish(self, required=True):
+        """Add a final instruction in the out file (in case of file generation)
+        
+        :param required bool: Do nothing if required is False
+        """
+        return
+

+
[docs]def special_path_separator(name):
+    """\
+    TCLLIBPATH, TKLIBPATH, PV_PLUGIN_PATH environments variables need
+    some exotic path separator.
+    This function gives the separator regarding the name of the variable
+    to append or prepend.
+       
+    :param name str: The name of the variable to find the separator
+    """
+    special_blanks_keys=["TCLLIBPATH", "TKLIBPATH"]
+    special_semicolon_keys=["PV_PLUGIN_PATH"]
+    res=os.pathsep
+    if name in special_blanks_keys: res=" "
+    if name in special_semicolon_keys: res=";"
+    return res
+

+
[docs]class LauncherFileEnviron:
+    """\
+    Class to generate a launcher file script 
+    (in python syntax) SalomeContext API
+    """
+    def __init__(self, output, environ=None):
+        """Initialization
+        
+        :param output file: the output file stream.
+        :param environ dict: a potential additional environment.
+        """
+        self.output = output
+        self.toclean = []
+        if environ is not None:
+            self.environ = environ
+        else:
+            self.environ = os.environ
+        # Initialize some variables
+        if not "PATH" in self.environ.keys():
+            self.environ["PATH"]=""
+        if not "LD_LIBRARY_PATH" in self.environ.keys():
+            self.environ["LD_LIBRARY_PATH"]=""
+        if not "PYTHONPATH" in self.environ.keys():
+            self.environ["PYTHONPATH"]=""
+        if not "TCLLIBPATH" in self.environ.keys():
+            self.environ["TCLLIBPATH"]=""
+        if not "TKLIBPATH" in self.environ.keys():
+            self.environ["TKLIBPATH"]=""
+
+        # four whitespaces for first indentation in a python script
+        self.indent="    "
+        self.prefix="context."
+        self.setVarEnv="setVariable"
+        
+        self.begin=self.indent+self.prefix
+        self.output.write(Launcher_header)
+        self.specialKeys={"PATH": "Path",
+                          "LD_LIBRARY_PATH": "LdLibraryPath",
+                          "PYTHONPATH": "PythonPath"}
+
+
[docs]    def change_to_launcher(self, value):
+        res=value
+        return res
+

+
[docs]    def add_line(self, number):
+        """Add some empty lines in the launcher file
+        
+        :param number int: the number of lines to add
+        """
+        self.output.write("\n" * number)
+

+
[docs]    def add_echo(self, text):
+        """Add a comment
+        
+        :param text str: the comment to add
+        """
+        self.output.write('# %s"\n' % text)
+

+
[docs]    def add_warning(self, warning):
+        """Add a warning
+        
+        :param text str: the warning to add
+        """
+        self.output.write('# "WARNING %s"\n' % warning)
+

+
[docs]    def append_value(self, key, value, sep=":"):
+        """append value to key using sep
+        
+        :param key str: the environment variable to append
+        :param value str: the value to append to key
+        :param sep str: the separator string
+        """
+        if self.is_defined(key) :
+            self.add(key, value)
+        else :
+            self.set(key, value)
+

+
[docs]    def append(self, key, value, sep=":"):
+        """Same as append_value but the value argument can be a list
+        
+        :param key str: the environment variable to append
+        :param value str or list: the value(s) to append to key
+        :param sep str: the separator string
+        """
+        if isinstance(value, list):
+            self.append_value(key, sep.join(value), sep)
+        else:
+            self.append_value(key, value, sep)
+

+
[docs]    def prepend_value(self, key, value, sep=":"):
+        """prepend value to key using sep
+        
+        :param key str: the environment variable to prepend
+        :param value str: the value to prepend to key
+        :param sep str: the separator string
+        """
+        if self.is_defined(key) :
+            self.add(key, value)
+        else :
+            self.set(key, value)
+

+
[docs]    def prepend(self, key, value, sep=":"):
+        """Same as prepend_value but the value argument can be a list
+        
+        :param key str: the environment variable to prepend
+        :param value str or list: the value(s) to prepend to key
+        :param sep str: the separator string
+        """
+        if isinstance(value, list):
+            self.prepend_value(key, sep.join(value), sep)
+        else:
+            self.prepend_value(key, value, sep)
+

+
[docs]    def is_defined(self, key):
+        """Check if the key exists in the environment
+        
+        :param key str: the environment variable to check
+        """
+        return key in self.environ.keys()
+

+
[docs]    def get(self, key):
+        """Get the value of the environment variable "key"
+        
+        :param key str: the environment variable
+        """
+        return '${%s}' % key
+

+
[docs]    def set(self, key, value):
+        """Set the environment variable "key" to value "value"
+        
+        :param key str: the environment variable to set
+        :param value str: the value
+        """
+        self.output.write(self.begin+self.setVarEnv+
+                          '(r"%s", r"%s", overwrite=True)\n' % 
+                          (key, self.change_to_launcher(value)))
+        self.environ[key] = value
+    

+
[docs]    def add(self, key, value):
+        """prepend value to key using sep
+        
+        :param key str: the environment variable to prepend
+        :param value str: the value to prepend to key
+        """     
+        if key in self.specialKeys.keys():
+            self.output.write(self.begin+'addTo%s(r"%s")\n' % 
+                              (self.specialKeys[key],
+                               self.change_to_launcher(value)))
+            self.environ[key]+=":"+value
+            return
+        sep=special_path_separator(key)
+        self.output.write(self.indent+
+                          '#temporary solution!!! have to be defined in API a '
+                          '?dangerous? addToSpecial(r"%s", r"%s")\n' % 
+                          (key, value))
+        #pathsep not precised because do not know future os launch?
+        self.output.write(self.begin+'addToSpecial(r"%s", r"%s")\n' 
+                          % (key, self.change_to_launcher(value)))
+        self.environ[key]+=sep+value #here yes we know os for current execution
+

+
[docs]    def command_value(self, key, command):
+        """\
+        Get the value given by the system command "command" 
+        and put it in the environment variable key.
+        
+        :param key str: the environment variable
+        :param command str: the command to execute
+        """
+        self.output.write(self.indent+'#`%s`\n' % command)
+
+        import shlex, subprocess
+        args = shlex.split(command)
+        res=subprocess.Popen(args, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+        out, __ = res.communicate()
+        self.output.write(self.begin+
+                          self.setVarEnv+
+                          '(r"%s", r"%s", overwrite=True)\n' % (key, out))
+

+
[docs]    def add_comment(self, comment):
+        # Special comment in case of the distène licence
+        if comment=="DISTENE license":
+            self.output.write(self.indent+
+                              "#"+
+                              self.prefix+
+                              self.setVarEnv+
+                              '(r"%s", r"%s", overwrite=True)\n' % 
+                              ('DISTENE_LICENSE_FILE', 
+                               self.change_to_launcher(
+                                            'Use global envvar: DLIM8VAR')))
+            self.output.write(self.indent+
+                              "#"+
+                              self.prefix+
+                              self.setVarEnv+
+                              '(r"%s", r"%s", overwrite=True)\n' % 
+                              ('DLIM8VAR', 
+                               self.change_to_launcher(
+                                                '<your licence>')))
+            return
+        if "setting environ for" in comment:
+            self.output.write(self.indent+"#[%s]\n" % 
+                              comment.split("setting environ for ")[1])
+            return
+
+        self.output.write(self.indent+"# %s\n" % comment)
+

+
[docs]    def finish(self, required=True):
+        """\
+        Add a final instruction in the out file (in case of file generation)
+        In the particular launcher case, do nothing
+        
+        :param required bool: Do nothing if required is False
+        """
+        return
+

+
[docs]class ScreenEnviron(FileEnviron):
+    def __init__(self, output, environ=None):
+        self._do_init(output, environ)
+        self.defined = {}
+
+
[docs]    def add_line(self, number):
+        pass
+

+
[docs]    def add_comment(self, comment):
+        pass
+

+
[docs]    def add_echo(self, text):
+        pass
+

+
[docs]    def add_warning(self, warning):
+        pass
+

+
[docs]    def write(self, command, name, value, sign="="):
+        import src
+        self.output.write("  %s%s %s %s %s\n" % \
+            (src.printcolors.printcLabel(command),
+             " " * (12 - len(command)),
+             src.printcolors.printcInfo(name), sign, value))
+

+
[docs]    def is_defined(self, name):
+        return self.defined.has_key(name)
+

+
[docs]    def get(self, name):
+        return "${%s}" % name
+

+
[docs]    def set(self, name, value):
+        self.write("set", name, value)
+        self.defined[name] = value
+

+
[docs]    def prepend(self, name, value, sep=":"):
+        if isinstance(value, list):
+            value = sep.join(value)
+        value = value + sep + self.get(name)
+        self.write("prepend", name, value)
+

+
[docs]    def append(self, name, value, sep=":"):
+        if isinstance(value, list):
+            value = sep.join(value)
+        value = self.get(name) + sep + value
+        self.write("append", name, value)
+

+
[docs]    def command_value(self, key, command):
+        pass
+

+
[docs]    def run_env_script(self, module, script):
+        self.write("load", script, "", sign="")
+
+# The SALOME launcher template 

+withProfile =  """\
+ #! /usr/bin/env python
+
+################################################################
+# WARNING: this file is automatically generated by SalomeTools #
+# WARNING: and so could be overwritten at any time.            #
+################################################################
+
+import os
+import sys
+import subprocess
+
+
+# Add the pwdPath to able to run the launcher after unpacking a package
+# Used only in case of a salomeTools package
+out_dir_Path=os.path.abspath(os.path.dirname(__file__))
+
+# Preliminary work to initialize path to SALOME Python modules
+def __initialize():
+
+  sys.path[:0] = [ 'BIN_KERNEL_INSTALL_DIR' ]
+  os.environ['ABSOLUTE_APPLI_PATH'] = 'KERNEL_INSTALL_DIR'
+  
+  # define folder to store omniorb config (initially in virtual application folder)
+  try:
+    from salomeContextUtils import setOmniOrbUserPath
+    setOmniOrbUserPath()
+  except Exception, e:
+    print e
+    sys.exit(1)
+# End of preliminary work
+
+# salome doc only works for virtual applications. Therefore we overwrite it with this function
+def _showDoc(modules):
+    for module in modules:
+      modulePath = os.getenv(module+"_ROOT_DIR")
+      if modulePath != None:
+        baseDir = os.path.join(modulePath, "share", "doc", "salome")
+        docfile = os.path.join(baseDir, "gui", module.upper(), "index.html")
+        if not os.path.isfile(docfile):
+          docfile = os.path.join(baseDir, "tui", module.upper(), "index.html")
+        if not os.path.isfile(docfile):
+          docfile = os.path.join(baseDir, "dev", module.upper(), "index.html")
+        if os.path.isfile(docfile):
+          out, err = subprocess.Popen(["xdg-open", docfile]).communicate()
+        else:
+          print "Online documentation is not accessible for module:", module
+      else:
+        print module+"_ROOT_DIR not found!"
+
+def main(args):
+  # Identify application path then locate configuration files
+  __initialize()
+
+  if args == ['--help']:
+    from salomeContext import usage
+    usage()
+    sys.exit(0)
+
+  #from salomeContextUtils import getConfigFileNames
+  #configFileNames, args, unexisting = getConfigFileNames( args, checkExistence=True )
+  #if len(unexisting) > 0:
+  #  print "ERROR: unexisting configuration file(s): " + ', '.join(unexisting)
+  #  sys.exit(1)
+
+  # Create a SalomeContext which parses configFileNames to initialize environment
+  try:
+    from salomeContext import SalomeContext, SalomeContextException
+    SalomeContext.addToSpecial=addToSpecial
+    context = SalomeContext(None)
+    
+    # Here set specific variables, if needed
+    # context.addToPath('mypath')
+    # context.addToLdLibraryPath('myldlibrarypath')
+    # context.addToPythonPath('mypythonpath')
+    # context.setVariable('myvarname', 'value')
+
+    # Logger level error
+    context.getLogger().setLevel(40)
+
+    context.setVariable(r"PRODUCT_ROOT_DIR", out_dir_Path, overwrite=True)
+    # here your local standalone environment
+
+    if len(args) >1 and args[0]=='doc':
+        _showDoc(args[1:])
+        return
+
+    # Start SALOME, parsing command line arguments
+    context.runSalome(args)
+    #print 'Thank you for using SALOME!'
+
+    # Logger level info
+    context.getLogger().setLevel(20)
+
+  except SalomeContextException, e:
+    import logging
+    logging.getLogger("salome").error(e)
+    sys.exit(1)
+#
+def addToSpecial(self, name, value, pathSep=None):
+  # add special dangerous cases: TCLLIBPATH PV_PLUGIN_PATH etc...
+  # http://computer-programming-forum.com/57-tcl/1dfddc136afccb94.htm
+  # TCLLIBPATH: Tcl treats the contents of that variable as a list. Be happy, for you can now use drive letters on windows.
+  if value == '':
+    return
+  
+  specialBlanksKeys=["TCLLIBPATH", "TKLIBPATH"]
+  specialSemicolonKeys=["PV_PLUGIN_PATH"]
+  res=os.pathsep
+  if name in specialBlanksKeys: res=" "
+  if name in specialSemicolonKeys: res=";"
+  
+  if pathSep==None:
+    sep=res
+  else:
+    sep=pathSep
+  value = os.path.expandvars(value) # expand environment variables
+  self.getLogger().debug("Add to %s: %s", name, value)
+  env = os.getenv(name, None)
+  if env is None:
+    os.environ[name] = value
+  else:
+    os.environ[name] = value + sep + env #explicitely or not special path separator ?whitespace, semicolon?
+
+if __name__ == "__main__":
+  args = sys.argv[1:]
+  main(args)
+#
+"""
+    
+
+ +
+
+
+
+
+
+

Related Topics

+ +
+ + +
+
+
+
+
+ ©2018, CEA. + + | + Powered by Sphinx 1.1.3 + & Alabaster + +
+ + + + + + \ No newline at end of file diff --git a/doc/build/html/_modules/src/fork.html b/doc/build/html/_modules/src/fork.html new file mode 100644 index 0000000..890c570 --- /dev/null +++ b/doc/build/html/_modules/src/fork.html @@ -0,0 +1,256 @@ + + + + + + + + + src.fork — salomeTools 5.0.0dev documentation + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+ +

Source code for src.fork

+#!/usr/bin/env python
+#-*- coding:utf-8 -*-
+#  Copyright (C) 2010-2013  CEA/DEN
+#
+#  This library is free software; you can redistribute it and/or
+#  modify it under the terms of the GNU Lesser General Public
+#  License as published by the Free Software Foundation; either
+#  version 2.1 of the License.
+#
+#  This library is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#  Lesser General Public License for more details.
+#
+#  You should have received a copy of the GNU Lesser General Public
+#  License along with this library; if not, write to the Free Software
+#  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+
+import os
+import sys
+import time
+import pickle
+import subprocess
+
+
[docs]def show_progress(logger, top, delai, ss=""):
+    """shortcut function to display the progression
+    
+    :param logger Logger: The logging instance
+    :param top int: the number to display
+    :param delai int: the number max
+    :param ss str: the string to display
+    """
+    logger.write("\r%s\r%s %s / %s " % ((" " * 30), ss, top, (delai - top)), 4,
+                 False)
+    logger.flush()
+

+
[docs]def write_back(logger, message, level):
+    """shortcut function to write at the begin of the line
+    
+    :param logger Logger: The logging instance
+    :param message str: the text to display
+    :param level int: the level of verbosity
+    """
+    logger.write("\r%s\r%s" % ((" " * 40), message), level)
+
+# Launch command
+# --------------

+
[docs]def launch_command(cmd, logger, cwd, args=[], log=None):
+    if log:
+        log = file(log, "a")
+    logger.write("launch: %s\n" % cmd, 5, screenOnly=True)
+    for arg in args:
+        cmd += " " + arg
+    prs = subprocess.Popen(cmd,
+                           shell=True,
+                           stdout=log,
+                           stderr=subprocess.STDOUT,
+                           cwd=cwd,
+                           executable='/bin/bash')
+    return prs
+
+# Launch a batch
+# --------------

+
[docs]def batch(cmd, logger, cwd, args=[], log=None, delai=20, sommeil=1):
+    proc = launch_command(cmd, logger, cwd, args, log)
+    top = 0
+    sys.stdout.softspace = True
+    begin = time.time()
+    while proc.poll() is None:
+        if time.time() - begin >= 1:
+            show_progress(logger, top, delai, "batch:")
+            if top == delai:
+                logger.write("batch: time out KILL\n", 3)
+                import signal
+                os.kill(proc.pid, signal.SIGTERM)
+                break
+            else:
+                begin = time.time()
+                time.sleep(sommeil)
+                top += 1
+        sys.stdout.flush()
+    else:
+        write_back(logger, "batch: exit (%s)\n" % str(proc.returncode), 5)
+    return (proc.returncode == 0), top
+
+# Launch a salome process
+# -----------------------

+
[docs]def batch_salome(cmd, logger, cwd, args, getTmpDir,
+    pendant="SALOME_Session_Server", fin="killSalome.py",
+    log=None, delai=20, sommeil=1, delaiapp=0):
+
+    beginTime = time.time()
+    launch_command(cmd, logger, cwd, args, log)
+
+    if delaiapp == 0:
+        delaiapp = delai
+
+    # first launch salome (looking for .pidict file)
+    top = 0
+    found = False
+    tmp_dir = getTmpDir()
+    while (not found and top < delaiapp):
+        if os.path.exists(tmp_dir):
+            listFile = os.listdir(tmp_dir)
+        else:
+            listFile = []
+
+        for file_name in listFile:
+            if file_name.endswith("pidict"):
+                # sometime we get a old file that will be removed by runSalome.
+                # So we test that we can read it.
+                currentTime = None
+                try:
+                    statinfo = os.stat(os.path.join(tmp_dir, file_name))
+                    currentTime = statinfo.st_mtime
+                except: pass
+
+                if currentTime and currentTime > beginTime:
+                    try:
+                        file_ = open(os.path.join(tmp_dir, file_name), "r")
+                        process_ids = pickle.load(file_)
+                        file_.close()
+                        for process_id in process_ids:
+                            for __, cmd in process_id.items():
+                                if cmd == [pendant]:
+                                    found = True
+                                    pidictFile = file_name
+                    except:
+                        file_.close()
+
+        time.sleep(sommeil)
+        top += 1
+        show_progress(logger, top, delaiapp, "launching salome or appli:")
+
+    # continue or not
+    if found:
+        write_back(logger, "batch_salome: started\n", 5)
+    else:
+        logger.write("batch_salome: FAILED to launch salome or appli\n", 3)
+        return False, -1
+
+    # salome launched run the script
+    top = 0
+    code = None
+    while code is None:
+        show_progress(logger, top, delai, "running salome or appli:")
+
+        if not os.access(os.path.join(tmp_dir, pidictFile), os.F_OK):
+            write_back(logger, "batch_salome: exit\n", 5)
+            code = True
+        elif top >= delai:
+            # timeout kill the test
+            os.system(fin)
+            logger.write("batch_salome: time out KILL\n", 3)
+            code = False
+        else:
+            # still waiting
+            time.sleep(sommeil)
+            top = top + 1
+
+    return code, top

+
+ +
+
+
+
+
+
+

Related Topics

+ +
+ + +
+
+
+
+
+ ©2018, CEA. + + | + Powered by Sphinx 1.1.3 + & Alabaster + +
+ + + + + + \ No newline at end of file diff --git a/doc/build/html/_modules/src/logger.html b/doc/build/html/_modules/src/logger.html new file mode 100644 index 0000000..3521621 --- /dev/null +++ b/doc/build/html/_modules/src/logger.html @@ -0,0 +1,506 @@ + + + + + + + + + src.logger — salomeTools 5.0.0dev documentation + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+ +

Source code for src.logger

+#!/usr/bin/env python
+#-*- coding:utf-8 -*-
+#  Copyright (C) 2010-2012  CEA/DEN
+#
+#  This library is free software; you can redistribute it and/or
+#  modify it under the terms of the GNU Lesser General Public
+#  License as published by the Free Software Foundation; either
+#  version 2.1 of the License.
+#
+#  This library is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#  Lesser General Public License for more details.
+#
+#  You should have received a copy of the GNU Lesser General Public
+#  License along with this library; if not, write to the Free Software
+#  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+
+"""\
+Implements the classes and method relative to the logging
+"""
+
+import sys
+import os
+import datetime
+import re
+import tempfile
+
+import src
+from . import printcolors
+from . import xmlManager
+
+log_macro_command_file_expression = "^[0-9]{8}_+[0-9]{6}_+.*\.xml$"
+log_all_command_file_expression = "^.*[0-9]{8}_+[0-9]{6}_+.*\.xml$"
+
+
[docs]class Logger(object):
+    """\
+    Class to handle log mechanism.
+    """
+    def __init__(self,
+                 config,
+                 silent_sysstd=False,
+                 all_in_terminal=False,
+                 micro_command = False):
+        """Initialization
+        
+        :param config pyconf.Config: The global configuration.
+        :param silent_sysstd boolean: if True, do not write anything
+                                      in terminal.
+        """
+        self.config = config
+        self.default_level = 3
+        self.silentSysStd = silent_sysstd
+        
+        # Construct xml log file location for sat prints.
+        prefix = ""
+        if micro_command:
+            prefix = "micro_"
+        hour_command_host = (config.VARS.datehour + "_" + 
+                             config.VARS.command + "_" + 
+                             config.VARS.hostname)
+        logFileName = prefix + hour_command_host + ".xml"
+        log_dir = src.get_log_path(config)
+        logFilePath = os.path.join(log_dir, logFileName)
+        # Construct txt file location in order to log 
+        # the external commands calls (cmake, make, git clone, etc...)
+        txtFileName = prefix + hour_command_host + ".txt"
+        txtFilePath = os.path.join(log_dir, "OUT", txtFileName)
+        
+        src.ensure_path_exists(os.path.dirname(logFilePath))
+        src.ensure_path_exists(os.path.dirname(txtFilePath))
+        
+        # The path of the log files (one for sat traces, and the other for 
+        # the system commands traces)
+        self.logFileName = logFileName
+        self.logFilePath = logFilePath
+        self.txtFileName = txtFileName
+        self.txtFilePath = txtFilePath
+        
+        # The list of all log files corresponding to the current command and
+        # the commands called by the current command
+        self.l_logFiles = [logFilePath, txtFilePath]
+        
+        # Initialize xml instance and put first fields 
+        # like beginTime, user, command, etc... 
+        self.xmlFile = xmlManager.XmlLogFile(logFilePath, "SATcommand", 
+                            attrib = {"application" : config.VARS.application})
+        self.put_initial_xml_fields()
+        # Initialize the txt file for reading
+        try:
+            self.logTxtFile = open(str(self.txtFilePath), 'w')
+        except IOError:
+            #msg1 = _("WARNING! Trying to write to a file that"
+            #         " is not accessible:")
+            #msg2 = _("The logs won't be written.")
+            #print("%s\n%s\n%s\n" % (src.printcolors.printcWarning(msg1),
+            #                        src.printcolors.printcLabel(str(self.txtFilePath)),
+            #                        src.printcolors.printcWarning(msg2) ))
+            self.logTxtFile = tempfile.TemporaryFile()
+            
+        # If the option all_in_terminal was called, all the system commands
+        # are redirected to the terminal
+        if all_in_terminal:
+            self.logTxtFile = sys.__stdout__
+        
+
[docs]    def put_initial_xml_fields(self):
+        """\
+        Called at class initialization: Put all fields 
+        corresponding to the command context (user, time, ...)
+        """
+        # command name
+        self.xmlFile.add_simple_node("Site", attrib={"command" : 
+                                                     self.config.VARS.command})
+        # version of salomeTools
+        self.xmlFile.append_node_attrib("Site", attrib={"satversion" : 
+                                            self.config.INTERNAL.sat_version})
+        # machine name on which the command has been launched
+        self.xmlFile.append_node_attrib("Site", attrib={"hostname" : 
+                                                    self.config.VARS.hostname})
+        # Distribution of the machine
+        self.xmlFile.append_node_attrib("Site", attrib={"OS" : 
+                                                        self.config.VARS.dist})
+        # The user that have launched the command
+        self.xmlFile.append_node_attrib("Site", attrib={"user" : 
+                                                        self.config.VARS.user})
+        # The time when command was launched
+        Y, m, dd, H, M, S = date_to_datetime(self.config.VARS.datehour)
+        date_hour = "%2s/%2s/%4s %2sh%2sm%2ss" % (dd, m, Y, H, M, S)
+        self.xmlFile.append_node_attrib("Site", attrib={"beginTime" : 
+                                                        date_hour})
+        # The application if any
+        if "APPLICATION" in self.config:
+            self.xmlFile.append_node_attrib("Site", 
+                        attrib={"application" : self.config.VARS.application})
+        # The initialization of the trace node
+        self.xmlFile.add_simple_node("Log",text="")
+        # The system commands logs
+        self.xmlFile.add_simple_node("OutLog",
+                                    text=os.path.join("OUT", self.txtFileName))
+        # The initialization of the node where 
+        # to put the links to the other sat commands that can be called by any
+        # command 
+        self.xmlFile.add_simple_node("Links")
+

+
+
[docs]    def write(self, message, level=None, screenOnly=False):
+        """\
+        function used in the commands 
+        to print in the terminal and the log file.
+        
+        :param message str: The message to print.
+        :param level int: The output level corresponding 
+                          to the message 0 < level < 6.
+        :param screenOnly boolean: if True, do not write in log file.
+        """
+        # do not write message starting with \r to log file
+        if not message.startswith("\r") and not screenOnly:
+            self.xmlFile.append_node_text("Log", 
+                                          printcolors.cleancolor(message))
+
+        # get user or option output level
+        current_output_verbose_level = self.config.USER.output_verbose_level
+        if not ('isatty' in dir(sys.stdout) and sys.stdout.isatty()):
+            # clean the message color if the terminal is redirected by user
+            # ex: sat compile appli > log.txt
+            message = printcolors.cleancolor(message)
+        
+        # Print message regarding the output level value
+        if level:
+            if level <= current_output_verbose_level and not self.silentSysStd:
+                sys.stdout.write(message)
+        else:
+            if self.default_level <= current_output_verbose_level and not self.silentSysStd:
+                sys.stdout.write(message)
+        self.flush()
+

+
[docs]    def error(self, message):
+        """Print an error.
+        
+        :param message str: The message to print.
+        """
+        # Print in the log file
+        self.xmlFile.append_node_text("traces", _('ERROR:') + message)
+
+        # Print in the terminal and clean colors if the terminal 
+        # is redirected by user
+        if not ('isatty' in dir(sys.stderr) and sys.stderr.isatty()):
+            sys.stderr.write(printcolors.printcError(_('ERROR:') + message))
+        else:
+            sys.stderr.write(_('ERROR:') + message)
+

+
[docs]    def flush(self):
+        """Flush terminal"""
+        sys.stdout.flush()
+        self.logTxtFile.flush()
+        

+
[docs]    def end_write(self, attribute):
+        """\
+        Called just after command end: Put all fields 
+        corresponding to the command end context (time).
+        Write the log xml file on the hard drive.
+        And display the command to launch to get the log
+        
+        :param attribute dict: the attribute to add to the node "Site".
+        """       
+        # Get current time (end of command) and format it
+        dt = datetime.datetime.now()
+        Y, m, dd, H, M, S = date_to_datetime(self.config.VARS.datehour)
+        t0 = datetime.datetime(int(Y), int(m), int(dd), int(H), int(M), int(S))
+        tf = dt
+        delta = tf - t0
+        total_time = timedelta_total_seconds(delta)
+        hours = int(total_time / 3600)
+        minutes = int((total_time - hours*3600) / 60)
+        seconds = total_time - hours*3600 - minutes*60
+        # Add the fields corresponding to the end time
+        # and the total time of command
+        endtime = dt.strftime('%Y/%m/%d %Hh%Mm%Ss')
+        self.xmlFile.append_node_attrib("Site", attrib={"endTime" : endtime})
+        self.xmlFile.append_node_attrib("Site", 
+                attrib={"TotalTime" : "%ih%im%is" % (hours, minutes, seconds)})
+        
+        # Add the attribute passed to the method
+        self.xmlFile.append_node_attrib("Site", attrib=attribute)
+        
+        # Call the method to write the xml file on the hard drive
+        self.xmlFile.write_tree(stylesheet = "command.xsl")
+        
+        # Dump the config in a pyconf file in the log directory
+        logDir = src.get_log_path(self.config)
+        dumpedPyconfFileName = (self.config.VARS.datehour 
+                                + "_" 
+                                + self.config.VARS.command 
+                                + ".pyconf")
+        dumpedPyconfFilePath = os.path.join(logDir, 'OUT', dumpedPyconfFileName)
+        try:
+            f = open(dumpedPyconfFilePath, 'w')
+            self.config.__save__(f)
+            f.close()
+        except IOError:
+            pass
+

+
[docs]def date_to_datetime(date):
+    """\
+    From a string date in format YYYYMMDD_HHMMSS
+    returns list year, mon, day, hour, minutes, seconds 
+    
+    :param date str: The date in format YYYYMMDD_HHMMSS
+    :return: the same date and time in separate variables.
+    :rtype: (str,str,str,str,str,str)
+    """
+    Y = date[:4]
+    m = date[4:6]
+    dd = date[6:8]
+    H = date[9:11]
+    M = date[11:13]
+    S = date[13:15]
+    return Y, m, dd, H, M, S
+

+
[docs]def timedelta_total_seconds(timedelta):
+    """\
+    Replace total_seconds from datetime module 
+    in order to be compatible with old python versions
+    
+    :param timedelta datetime.timedelta: The delta between two dates
+    :return: The number of seconds corresponding to timedelta.
+    :rtype: float
+    """
+    return (
+        timedelta.microseconds + 0.0 +
+        (timedelta.seconds + timedelta.days * 24 * 3600) * 10 ** 6) / 10 ** 6
+        

+
[docs]def show_command_log(logFilePath, cmd, application, notShownCommands):
+    """\
+    Used in updateHatXml. 
+    Determine if the log xml file logFilePath 
+    has to be shown or not in the hat log.
+    
+    :param logFilePath str: the path to the command xml log file
+    :param cmd str: the command of the log file
+    :param application str: the application passed as parameter 
+                            to the salomeTools command
+    :param notShownCommands list: the list of commands 
+                                  that are not shown by default
+    
+    :return: True if cmd is not in notShownCommands and the application 
+             in the log file corresponds to application
+    :rtype: boolean
+    """
+    # When the command is not in notShownCommands, no need to go further :
+    # Do not show
+    if cmd in notShownCommands:
+        return False, None, None
+ 
+    # Get the application of the log file
+    try:
+        logFileXml = src.xmlManager.ReadXmlFile(logFilePath)
+    except Exception as e:
+        msg = _("WARNING: the log file %s cannot be read:" % logFilePath)
+        sys.stdout.write(printcolors.printcWarning("%s\n%s\n" % (msg, e)))
+        return False, None, None
+
+    if 'application' in logFileXml.xmlroot.keys():
+        appliLog = logFileXml.xmlroot.get('application')
+        launched_cmd = logFileXml.xmlroot.find('Site').attrib['launchedCommand']
+        # if it corresponds, then the log has to be shown
+        if appliLog == application:
+            return True, appliLog, launched_cmd
+        elif application != 'None':
+            return False, appliLog, launched_cmd
+        
+        return True, appliLog, launched_cmd
+    
+    if application == 'None':
+            return True, None, None
+        
+    return False, None, None
+

+
[docs]def list_log_file(dirPath, expression):
+    """Find all files corresponding to expression in dirPath
+    
+    :param dirPath str: the directory where to search the files
+    :param expression str: the regular expression of files to find
+    :return: the list of files path and informations about it
+    :rtype: list
+    """
+    lRes = []
+    for fileName in os.listdir(dirPath):
+        # YYYYMMDD_HHMMSS_namecmd.xml
+        sExpr = expression
+        oExpr = re.compile(sExpr)
+        if oExpr.search(fileName):
+            file_name = fileName
+            if fileName.startswith("micro_"):
+                file_name = fileName[len("micro_"):]
+            # get date and hour and format it
+            date_hour_cmd_host = file_name.split('_')
+            date_not_formated = date_hour_cmd_host[0]
+            date = "%s/%s/%s" % (date_not_formated[6:8], 
+                                 date_not_formated[4:6], 
+                                 date_not_formated[0:4])
+            hour_not_formated = date_hour_cmd_host[1]
+            hour = "%s:%s:%s" % (hour_not_formated[0:2], 
+                                 hour_not_formated[2:4], 
+                                 hour_not_formated[4:6])
+            if len(date_hour_cmd_host) < 4:
+                cmd = date_hour_cmd_host[2][:-len('.xml')]
+                host = ""
+            else:
+                cmd = date_hour_cmd_host[2]
+                host = date_hour_cmd_host[3][:-len('.xml')]
+            lRes.append((os.path.join(dirPath, fileName), 
+                         date_not_formated,
+                         date,
+                         hour_not_formated,
+                         hour,
+                         cmd,
+                         host))
+    return lRes
+

+
[docs]def update_hat_xml(logDir, application=None, notShownCommands = []):
+    """\
+    Create the xml file in logDir that contain all the xml file 
+    and have a name like YYYYMMDD_HHMMSS_namecmd.xml
+    
+    :param logDir str: the directory to parse
+    :param application str: the name of the application if there is any
+    """
+    # Create an instance of XmlLogFile class to create hat.xml file
+    xmlHatFilePath = os.path.join(logDir, 'hat.xml')
+    xmlHat = src.xmlManager.XmlLogFile(xmlHatFilePath,
+                                    "LOGlist", {"application" : application})
+    # parse the log directory to find all the command logs, 
+    # then add it to the xml file
+    lLogFile = list_log_file(logDir, log_macro_command_file_expression)
+    for filePath, __, date, __, hour, cmd, __ in lLogFile:
+        showLog, cmdAppli, full_cmd = show_command_log(filePath, cmd,
+                                              application, notShownCommands)
+        #if cmd not in notShownCommands:
+        if showLog:
+            # add a node to the hat.xml file
+            xmlHat.add_simple_node("LogCommand", 
+                                   text=os.path.basename(filePath), 
+                                   attrib = {"date" : date, 
+                                             "hour" : hour, 
+                                             "cmd" : cmd, 
+                                             "application" : cmdAppli,
+                                             "full_command" : full_cmd})
+    
+    # Write the file on the hard drive
+    xmlHat.write_tree('hat.xsl')

+
+ +
+
+
+
+
+
+

Related Topics

+ +
+ + +
+
+
+
+
+ ©2018, CEA. + + | + Powered by Sphinx 1.1.3 + & Alabaster + +
+ + + + + + \ No newline at end of file diff --git a/doc/build/html/_modules/src/options.html b/doc/build/html/_modules/src/options.html new file mode 100644 index 0000000..3b43764 --- /dev/null +++ b/doc/build/html/_modules/src/options.html @@ -0,0 +1,290 @@ + + + + + + + + + src.options — salomeTools 5.0.0dev documentation + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+ +

Source code for src.options

+#!/usr/bin/env python
+#-*- coding:utf-8 -*-
+#  Copyright (C) 2010-2013  CEA/DEN
+#
+#  This library is free software; you can redistribute it and/or
+#  modify it under the terms of the GNU Lesser General Public
+#  License as published by the Free Software Foundation; either
+#  version 2.1 of the License.
+#
+#  This library is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#  Lesser General Public License for more details.
+#
+#  You should have received a copy of the GNU Lesser General Public
+#  License along with this library; if not, write to the Free Software
+#  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+'''The Options class that manages the access to all options passed as 
+   parameters in salomeTools command lines
+'''
+import getopt
+import sys
+from . import printcolors
+
+
[docs]class OptResult(object):
+    '''An instance of this class will be the object manipulated
+       in code of all salomeTools commands
+       The aim of this class is to have an elegant syntax 
+       to manipulate the options. 
+       ex: 
+       print(options.level)
+       5
+    '''
+    def __init__(self):
+        '''Initialization
+        '''
+        self.__dict__ = dict()
+
+    def __getattr__(self, name):
+        '''Overwrite of the __getattr__ function 
+           to customize it for option usage
+        
+        :param name str: The attribute to get the value.
+        :return: the value corresponding to the attribute.
+        :rtype: str,int,list,boolean
+        '''
+        if name in self.__dict__:
+            return self.__dict__[name]
+        else:
+            raise AttributeError(name + _(u" is not a valid option"))
+
+    def __setattr__(self, name, value):
+        '''Overwrite of the __setattr__ function 
+           to customize it for option usage
+        
+        :param name str: The attribute to set.
+        :param value str: The value  corresponding to the attribute.
+        :return: Nothing.
+        :rtype: N\A
+        '''
+        object.__setattr__(self,name,value)
+

+
[docs]class Options:
+    '''Class to manage all salomeTools options
+    '''
+    def __init__(self):
+        '''Initialization
+        '''
+        # The options field stocks all options of a command 
+        # in a list that contains dicts
+        self.options = []
+        # The list of available option type
+        self.availableOptions = ["boolean", "string", "int", "float",
+                                  "long", "list", "list2"]
+        self.default = None
+
+
[docs]    def add_option(self, shortName, longName,
+                    optionType, destName, helpString="", default = None):
+        '''Method to add an option to a command. It gets all attributes
+           of an option and append it in the options field
+        
+        :param shortName str: The short name of the option
+                              (ex "l" for level option).
+        :param longName str: The long name of the option 
+                             (ex "level" for level option).
+        :param optionType str: The type of the option (ex "int").
+        :param destName str: The name that will be used in the code.
+        :param helpString str: The text to display 
+                               when user ask for help on a command.     
+        :return: Nothing.
+        :rtype: N\A
+        '''
+        option = dict()
+        option['shortName'] = shortName
+        option['longName'] = longName
+
+        if optionType not in self.availableOptions:
+            print("error optionType", optionType, "not available.")
+            sys.exit(-1)
+
+        option['optionType'] = optionType
+        option['destName'] = destName
+        option['helpString'] = helpString
+        option['result'] = default
+        self.options.append(option)
+

+
[docs]    def print_help(self):
+        '''Method that display all options stored in self.options and there help
+        
+        :return: Nothing.
+        :rtype: N\A
+        '''
+        # Do nothing if there are no options
+        if len(self.options) == 0:
+            return
+
+        # for all options, print its values. 
+        # "shortname" is an optional field of the options 
+        print(printcolors.printcHeader(_("Available options are:")))
+        for option in self.options:
+            if 'shortName' in option and len(option['shortName']) > 0:
+                print(" -%(shortName)1s, --%(longName)s"
+                      " (%(optionType)s)\n\t%(helpString)s\n" % option)
+            else:
+                print(" --%(longName)s (%(optionType)s)\n\t%(helpString)s\n"
+                       % option)
+

+
[docs]    def parse_args(self, argList=None):
+        '''Method that instantiates the class OptResult 
+           that gives access to all options in the code
+        
+        :param argList list: the raw list of arguments that were passed
+        :return: optResult, args : optResult is the option instance 
+                                   to manipulate in the code. args 
+                                   is the full raw list of passed options 
+        :rtype: (class 'common.options.OptResult',list)
+        '''
+        if argList is None:
+            argList = sys.argv[1:]
+        
+        # format shortNameOption and longNameOption 
+        # to make right arguments to getopt.getopt function
+        shortNameOption = ""
+        longNameOption = []
+        for option in self.options:
+            shortNameOption = shortNameOption + option['shortName']
+            if option['shortName'] != "" and option['optionType'] != "boolean":
+                shortNameOption = shortNameOption + ":"
+
+            if option['longName'] != "":
+                if option['optionType'] != "boolean":
+                    longNameOption.append(option['longName'] + "=")
+                else:
+                    longNameOption.append(option['longName'])
+
+        # call to getopt.getopt function to get the option 
+        # passed in the command regarding the available options
+        optlist, args = getopt.getopt(argList, shortNameOption, longNameOption)
+        
+        # instantiate and completing the optResult that will be returned
+        optResult = OptResult()
+        for option in self.options:
+            shortOption = "-" + option['shortName']
+            longOption = "--" + option['longName']
+            optionType = option['optionType']
+            for opt in optlist:
+                if opt[0] in [shortOption, longOption]:
+                    if optionType == "string":
+                        option['result'] = opt[1]
+                    elif optionType == "boolean":
+                        option['result'] = True
+                    elif optionType == "int":
+                        option['result'] = int(opt[1])
+                    elif optionType == "float":
+                        option['result'] = float(opt[1])
+                    elif optionType == "long":
+                        option['result'] = long(opt[1])
+                    elif optionType == "list":
+                        if option['result'] is None:
+                            option['result'] = list()
+                        option['result'].append(opt[1])
+                    elif optionType == "list2":
+                        if option['result'] is None:
+                            option['result'] = list()
+                        if opt[1].find(",") == -1:
+                            option['result'].append(opt[1])
+                        else:
+                            elts = filter(lambda l: len(l) > 0, opt[1].split(","))
+                            option['result'].extend(elts)
+
+            optResult.__setattr__(option['destName'], option['result'])
+            # free the option in order to be able to make 
+            # a new free call of options (API case)
+            option['result'] = None
+        return optResult, args
+
+ +
+
+ +
+
+
+

Related Topics

+ +
+ + +
+
+
+ +
+ ©2018, CEA. + + | + Powered by Sphinx 1.1.3 + & Alabaster + +
+ + + + + + \ No newline at end of file diff --git a/doc/build/html/_modules/src/printcolors.html b/doc/build/html/_modules/src/printcolors.html new file mode 100644 index 0000000..1e82e1d --- /dev/null +++ b/doc/build/html/_modules/src/printcolors.html @@ -0,0 +1,278 @@ + + + + + + + + + src.printcolors — salomeTools 5.0.0dev documentation + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+ +

Source code for src.printcolors

+#!/usr/bin/env python
+#-*- coding:utf-8 -*-
+#  Copyright (C) 2010-2013  CEA/DEN
+#
+#  This library is free software; you can redistribute it and/or
+#  modify it under the terms of the GNU Lesser General Public
+#  License as published by the Free Software Foundation; either
+#  version 2.1 of the License.
+#
+#  This library is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#  Lesser General Public License for more details.
+#
+#  You should have received a copy of the GNU Lesser General Public
+#  License along with this library; if not, write to the Free Software
+#  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+'''In this file is stored the mechanism that manage color prints in the terminal
+'''
+
+# define constant to use in scripts
+COLOR_ERROR = 'ERROR'
+COLOR_WARNING = 'WARNING'
+COLOR_SUCCESS = 'SUCCESS'
+COLOR_LABEL = 'LABEL'
+COLOR_HEADER = 'HEADER'
+COLOR_INFO = 'INFO'
+COLOR_HIGLIGHT = 'HIGHLIGHT'
+
+# the color map to use to print the colors
+__colormap__ = {
+    COLOR_ERROR: '\033[1m\033[31m',
+    COLOR_SUCCESS: '\033[1m\033[32m',
+    COLOR_WARNING: '\033[33m',
+    COLOR_HEADER: '\033[34m',
+    COLOR_INFO: '\033[35m',
+    COLOR_LABEL: '\033[36m',
+    COLOR_HIGLIGHT: '\033[97m\033[43m'
+}
+
+# list of available codes
+__code_range__ = ([1, 4] + list(range(30, 38)) + list(range(40, 48))
+                + list(range(90, 98)) + list(range(100, 108)))
+
+
[docs]def printc(txt, code=''):
+    '''print a text with colors
+    
+    :param txt str: The text to be printed.
+    :param code str: The color to use.
+    :return: The colored text.
+    :rtype: str
+    '''
+    # no code means 'auto mode' (works only for OK, KO, NO and ERR*)
+    if code == '':
+        striptxt = txt.strip().upper()
+        if striptxt == "OK":
+            code = COLOR_SUCCESS
+        elif striptxt in ["KO", "NO"] or striptxt.startswith("ERR"):
+            code = COLOR_ERROR
+        else:
+            return txt
+
+    # no code => output the originial text
+    if code not in __colormap__.keys() or __colormap__[code] == '':
+        return txt
+
+    return __colormap__[code] + txt + '\033[0m'
+

+
[docs]def printcInfo(txt):
+    '''print a text info color
+    
+    :param txt str: The text to be printed.
+    :return: The colored text.
+    :rtype: str
+    '''
+    return printc(txt, COLOR_INFO)
+

+
[docs]def printcError(txt):
+    '''print a text error color
+    
+    :param txt str: The text to be printed.
+    :return: The colored text.
+    :rtype: str
+    '''
+    return printc(txt, COLOR_ERROR)
+

+
[docs]def printcWarning(txt):
+    '''print a text warning color
+    
+    :param txt str: The text to be printed.
+    :return: The colored text.
+    :rtype: str
+    '''
+    return printc(txt, COLOR_WARNING)
+

+
[docs]def printcHeader(txt):
+    '''print a text header color
+    
+    :param txt str: The text to be printed.
+    :return: The colored text.
+    :rtype: str
+    '''
+    return printc(txt, COLOR_HEADER)
+

+
[docs]def printcLabel(txt):
+    '''print a text label color
+    
+    :param txt str: The text to be printed.
+    :return: The colored text.
+    :rtype: str
+    '''
+    return printc(txt, COLOR_LABEL)
+

+
[docs]def printcSuccess(txt):
+    '''print a text success color
+    
+    :param txt str: The text to be printed.
+    :return: The colored text.
+    :rtype: str
+    '''
+    return printc(txt, COLOR_SUCCESS)
+

+
[docs]def printcHighlight(txt):
+    '''print a text highlight color
+    
+    :param txt str: The text to be printed.
+    :return: The colored text.
+    :rtype: str
+    '''
+    return printc(txt, COLOR_HIGLIGHT)
+

+
[docs]def cleancolor(message):
+    '''remove color from a colored text.
+    
+    :param message str: The text to be cleaned.
+    :return: The cleaned text.
+    :rtype: str
+    '''
+    if message == None:
+        return message
+    
+    message = message.replace('\033[0m', '')
+    for i in __code_range__:
+        message = message.replace('\033[%dm' % i, '')
+    return message
+

+
+
+
+ +
+
+
+
+
+
+

Related Topics

+ +
+ + +
+
+
+ +
+ ©2018, CEA. + + | + Powered by Sphinx 1.1.3 + & Alabaster + +
+ + + + + + \ No newline at end of file diff --git a/doc/build/html/_modules/src/product.html b/doc/build/html/_modules/src/product.html new file mode 100644 index 0000000..91fe3a2 --- /dev/null +++ b/doc/build/html/_modules/src/product.html @@ -0,0 +1,917 @@ + + + + + + + + + src.product — salomeTools 5.0.0dev documentation + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+ +

Source code for src.product

+#!/usr/bin/env python
+#-*- coding:utf-8 -*-
+#  Copyright (C) 2010-2012  CEA/DEN
+#
+#  This library is free software; you can redistribute it and/or
+#  modify it under the terms of the GNU Lesser General Public
+#  License as published by the Free Software Foundation; either
+#  version 2.1 of the License.
+#
+#  This library is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#  Lesser General Public License for more details.
+#
+#  You should have received a copy of the GNU Lesser General Public
+#  License along with this library; if not, write to the Free Software
+#  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+
+"""\
+In this file are implemented the methods 
+relative to the product notion of salomeTools
+"""
+
+import os
+import re
+
+import src
+import src.debug as DBG
+
+AVAILABLE_VCS = ['git', 'svn', 'cvs']
+config_expression = "^config-\d+$"
+VERSION_DELIMITER = "_to_"
+
+
[docs]def get_product_config(config, product_name, with_install_dir=True):
+    """Get the specific configuration of a product from the global configuration
+    
+    :param config Config: The global configuration
+    :param product_name str: The name of the product
+    :param with_install_dir boolean: If false, do not provide an install 
+                                     directory (at false only for internal use 
+                                     of the function check_config_exists)
+    :return: the specific configuration of the product
+    :rtype: Config
+    """
+    
+    # Get the version of the product from the application definition
+    version = config.APPLICATION.products[product_name]
+    # if no version, then take the default one defined in the application
+    if isinstance(version, bool): 
+        version = config.APPLICATION.tag      
+    
+    # Define debug and dev modes
+    # Get the tag if a dictionary is given in APPLICATION.products for the
+    # current product 
+    debug = 'no'
+    dev = 'no'
+    base = 'maybe'
+    section = None
+    if isinstance(version, src.pyconf.Mapping):
+        dic_version = version
+        # Get the version/tag
+        if not 'tag' in dic_version:
+            version = config.APPLICATION.tag
+        else:
+            version = dic_version.tag
+        
+        # Get the debug if any
+        if 'debug' in dic_version:
+            debug = dic_version.debug
+        
+        # Get the dev if any
+        if 'dev' in dic_version:
+            dev = dic_version.dev
+        
+        # Get the base if any
+        if 'base' in dic_version:
+            base = dic_version.base
+
+        # Get the section if any
+        if 'section' in dic_version:
+            section = dic_version.section
+    
+    vv = version
+    # substitute some character with _ in order to get the correct definition
+    # in config.PRODUCTS. This is done because the pyconf tool does not handle
+    # the . and - characters 
+    for c in ".-": vv = vv.replace(c, "_")
+    
+    prod_info = None
+    if product_name in config.PRODUCTS:
+        # Search for the product description in the configuration
+        prod_info = get_product_section(config, product_name, vv, section)
+        
+        # merge opt_depend in depend
+        if prod_info is not None and 'opt_depend' in prod_info:
+            for depend in prod_info.opt_depend:
+                if depend in config.APPLICATION.products:
+                    prod_info.depend.append(depend,'')
+        
+        # In case of a product get with a vcs, 
+        # put the tag (equal to the version)
+        if prod_info is not None and prod_info.get_source in AVAILABLE_VCS:
+            
+            if prod_info.get_source == 'git':
+                prod_info.git_info.tag = version
+            
+            if prod_info.get_source == 'svn':
+                prod_info.svn_info.tag = version
+            
+            if prod_info.get_source == 'cvs':
+                prod_info.cvs_info.tag = version
+        
+        # In case of a fixed product, 
+        # define the install_dir (equal to the version)
+        if prod_info is not None and os.path.isdir(version):
+            prod_info.install_dir = version
+            prod_info.get_source = "fixed"
+        
+        # Check if the product is defined as native in the application
+        if prod_info is not None:
+            if version == "native":
+                prod_info.get_source = "native"
+            elif prod_info.get_source == "native":
+                msg = _("The product %(prod)s has version %(ver)s but is "
+                        "declared as native in its definition" %
+                        { 'prod': prod_info.name, 'ver': version})
+                raise src.SatException(msg)
+
+    # If there is no definition but the product is declared as native,
+    # construct a new definition containing only the get_source key
+    if prod_info is None and version == "native":
+        prod_info = src.pyconf.Config()
+        prod_info.name = product_name
+        prod_info.get_source = "native"
+
+    # If there is no definition but the product is fixed,
+    # construct a new definition containing only the product name
+    if prod_info is None and os.path.isdir(version):
+        prod_info = src.pyconf.Config()
+        prod_info.name = product_name
+        prod_info.get_source = "fixed"
+        prod_info.addMapping("environ", src.pyconf.Mapping(prod_info), "")
+
+
+    # If prod_info is still None, it means that there is no product definition
+    # in the config. The user has to provide it.
+    if prod_info is None:
+        prod_pyconf_path = src.find_file_in_lpath(product_name + ".pyconf",
+                                                  config.PATHS.PRODUCTPATH)
+        if not prod_pyconf_path:
+            msg = _("""\
+No definition found for the product %(1)s.
+Please create a %(2)s.pyconf file somewhere in:
+%(3)s""") % {
+  "1": product_name, 
+  "2": product_name,
+  "3": config.PATHS.PRODUCTPATH }
+        else:
+            msg = _("""\
+No definition corresponding to the version %(1)s was found in the file:
+  %(2)s.
+Please add a section in it.""") % {"1" : vv, "2" : prod_pyconf_path}
+        raise src.SatException(msg)
+    
+    # Set the debug, dev and version keys
+    prod_info.debug = debug
+    prod_info.dev = dev
+    prod_info.version = version
+    
+    # Set the archive_info if the product is get in archive mode
+    if prod_info.get_source == "archive":
+        if not "archive_info" in prod_info:
+            prod_info.addMapping("archive_info",
+                                 src.pyconf.Mapping(prod_info),
+                                 "")
+        if "archive_name" not in prod_info.archive_info: 
+            arch_name = product_name + "-" + version + ".tar.gz"
+            arch_path = src.find_file_in_lpath(arch_name,
+                                               config.PATHS.ARCHIVEPATH)
+            if not arch_path:
+                msg = _("Archive %(1)s for %(2)s not found in config.PATHS.ARCHIVEPATH") % \
+                       {"1" : arch_name, "2" : prod_info.name}
+                DBG.tofix(msg, config.PATHS.ARCHIVEPATH)
+                prod_info.archive_info.archive_name = arch_name #without path
+                # raise src.SatException(msg) #may be a warning, continue #8646
+            else:
+                prod_info.archive_info.archive_name = arch_path
+        else:
+            if (os.path.basename(prod_info.archive_info.archive_name) == 
+                                        prod_info.archive_info.archive_name):
+                arch_name = prod_info.archive_info.archive_name
+                arch_path = src.find_file_in_lpath(
+                                            arch_name,
+                                            config.PATHS.ARCHIVEPATH)
+                if not arch_path:
+                    msg = _("Archive %(1)s for %(2)s not found in config.PATHS.ARCHIVEPATH") % \
+                           {"1" : arch_name, "2" : prod_info.name}
+                    DBG.tofix(msg, config.PATHS.ARCHIVEPATH) #avoid 2 messages in compile
+                    prod_info.archive_info.archive_name = arch_name #without path
+                    # raise src.SatException(msg) #may be a warning, continue #8646
+                prod_info.archive_info.archive_name = arch_path
+        
+    # If the product compiles with a script, check the script existence
+    # and if it is executable
+    if product_has_script(prod_info):
+        # Check the compil_script key existence
+        if "compil_script" not in prod_info:
+            msg = _("""\
+No compilation script found for the product %s.
+Please provide a 'compil_script' key in its definition.""") % product_name
+            raise src.SatException(msg)
+        
+        # Get the path of the script
+        script = prod_info.compil_script
+        script_name = os.path.basename(script)
+        if script == script_name:
+            # Only a name is given. Search in the default directory
+            script_path = src.find_file_in_lpath(script_name,
+                                                 config.PATHS.PRODUCTPATH,
+                                                 "compil_scripts")
+            if not script_path:
+                raise src.SatException(
+                    _("Compilation script not found: %s") % script_name)
+            prod_info.compil_script = script_path
+            if src.architecture.is_windows():
+                prod_info.compil_script = prod_info.compil_script[:-len(".sh")] + ".bat"
+       
+        # Check that the script is executable
+        if not os.access(prod_info.compil_script, os.X_OK):
+            #raise src.SatException(
+            #        _("Compilation script cannot be executed: %s") % 
+            #        prod_info.compil_script)
+            DBG.tofix("Compilation script cannot be executed:", prod_info.compil_script)
+    
+    # Get the full paths of all the patches
+    if product_has_patches(prod_info):
+        patches = []
+        try:
+          for patch in prod_info.patches:
+              patch_path = patch
+              # If only a filename, then search for the patch in the PRODUCTPATH
+              if os.path.basename(patch_path) == patch_path:
+                  # Search in the PRODUCTPATH/patches
+                  patch_path = src.find_file_in_lpath(patch,
+                                                      config.PATHS.PRODUCTPATH,
+                                                      "patches")
+                  if not patch_path:
+                      msg = _("Patch %(patch_name)s for %(prod_name)s not found:"
+                              "\n" % {"patch_name" : patch,
+                                       "prod_name" : prod_info.name}) 
+                      raise src.SatException(msg)
+              patches.append(patch_path)
+        except:
+          DBG.tofix("problem in prod_info.patches", prod_info)
+        prod_info.patches = patches
+
+    # Get the full paths of the environment scripts
+    if product_has_env_script(prod_info):
+        env_script_path = prod_info.environ.env_script
+        # If only a filename, then search for the environment script 
+        # in the PRODUCTPATH/env_scripts
+        if os.path.basename(env_script_path) == env_script_path:
+            # Search in the PRODUCTPATH/env_scripts
+            env_script_path = src.find_file_in_lpath(
+                                            prod_info.environ.env_script,
+                                            config.PATHS.PRODUCTPATH,
+                                            "env_scripts")
+            if not env_script_path:
+                msg = _("Environment script %(env_name)s for %(prod_name)s not "
+                        "found.\n" % {"env_name" : env_script_path,
+                                       "prod_name" : prod_info.name}) 
+                raise src.SatException(msg)
+
+        prod_info.environ.env_script = env_script_path
+    
+    if with_install_dir: 
+        # The variable with_install_dir is at false only for internal use 
+        # of the function get_install_dir
+        
+        # Save the install_dir key if there is any
+        if "install_dir" in prod_info and not "install_dir_save" in prod_info:
+            prod_info.install_dir_save = prod_info.install_dir
+        
+        # if it is not the first time the install_dir is computed, it means
+        # that install_dir_save exists and it has to be taken into account.
+        if "install_dir_save" in prod_info:
+            prod_info.install_dir = prod_info.install_dir_save
+        
+        # Set the install_dir key
+        prod_info.install_dir = get_install_dir(config, base, version, prod_info)
+                
+    return prod_info
+

+
[docs]def get_product_section(config, product_name, version, section=None):
+    """Get the product description from the configuration
+    
+    :param config Config: The global configuration
+    :param product_name str: The product name
+    :param version str: The version of the product
+    :param section str: The searched section (if not None, the section is 
+                        explicitly given
+    :return: The product description
+    :rtype: Config
+    """
+
+    # if section is not None, try to get the corresponding section
+    if section:
+        if section not in config.PRODUCTS[product_name]:
+            return None
+        # returns specific information for the given version
+        prod_info = config.PRODUCTS[product_name][section]
+        prod_info.section = section
+        prod_info.from_file = config.PRODUCTS[product_name].from_file
+        return prod_info
+
+    # If it exists, get the information of the product_version
+    if "version_" + version in config.PRODUCTS[product_name]:
+        # returns specific information for the given version
+        prod_info = config.PRODUCTS[product_name]["version_" + version]
+        prod_info.section = "version_" + version
+        prod_info.from_file = config.PRODUCTS[product_name].from_file
+        return prod_info
+    
+    # Else, check if there is a description for multiple versions
+    l_section_name = config.PRODUCTS[product_name].keys()
+    l_section_ranges = [section_name for section_name in l_section_name 
+                        if VERSION_DELIMITER in section_name]
+    for section_range in l_section_ranges:
+        minimum, maximum = section_range.split(VERSION_DELIMITER)
+        if (src.only_numbers(version) >= src.only_numbers(minimum)
+                    and src.only_numbers(version) <= src.only_numbers(maximum)):
+            # returns specific information for the versions
+            prod_info = config.PRODUCTS[product_name][section_range]
+            prod_info.section = section_range
+            prod_info.from_file = config.PRODUCTS[product_name].from_file
+            return prod_info
+    
+    # Else, get the standard informations
+    if "default" in config.PRODUCTS[product_name]:
+        # returns the generic information (given version not found)
+        prod_info = config.PRODUCTS[product_name].default
+        prod_info.section = "default"
+        prod_info.from_file = config.PRODUCTS[product_name].from_file
+        return prod_info
+    
+    # if noting was found, return None
+    return None
+    

+
[docs]def get_install_dir(config, base, version, prod_info):
+    """Compute the installation directory of a given product 
+    
+    :param config Config: The global configuration
+    :param base str: This corresponds to the value given by user in its 
+                     application.pyconf for the specific product. If "yes", the
+                     user wants the product to be in base. If "no", he wants the
+                     product to be in the application workdir
+    :param version str: The version of the product
+    :param product_info Config: The configuration specific to 
+                               the product
+    
+    :return: The path of the product installation
+    :rtype: str
+    """
+    install_dir = ""
+    in_base = False
+    if (("install_dir" in prod_info and prod_info.install_dir == "base") 
+                                                            or base == "yes"):
+        in_base = True
+    if (base == "no" or ("no_base" in config.APPLICATION 
+                         and config.APPLICATION.no_base == "yes")):
+        in_base = False
+    
+    if in_base:
+        install_dir = get_base_install_dir(config, prod_info, version)
+    else:
+        if "install_dir" not in prod_info or prod_info.install_dir == "base":
+            # Set it to the default value (in application directory)
+            install_dir = os.path.join(config.APPLICATION.workdir,
+                                                "INSTALL",
+                                                prod_info.name)
+        else:
+            install_dir = prod_info.install_dir
+
+    return install_dir
+

+
[docs]def get_base_install_dir(config, prod_info, version):
+    """Compute the installation directory of a product in base 
+    
+    :param config Config: The global configuration
+    :param product_info Config: The configuration specific to 
+                               the product
+    :param version str: The version of the product    
+    :return: The path of the product installation
+    :rtype: str
+    """    
+    base_path = src.get_base_path(config) 
+    prod_dir = os.path.join(base_path, prod_info.name + "-" + version)
+    if not os.path.exists(prod_dir):
+        return os.path.join(prod_dir, "config-1")
+    
+    exists, install_dir = check_config_exists(config, prod_dir, prod_info)
+    if exists:
+        return install_dir
+    
+    # Find the first config-<i> directory that is available in the product
+    # directory
+    found = False 
+    label = 1
+    while not found:
+        install_dir = os.path.join(prod_dir, "config-%i" % label)
+        if os.path.exists(install_dir):
+            label+=1
+        else:
+            found = True
+            
+    return install_dir
+

+
[docs]def check_config_exists(config, prod_dir, prod_info):
+    """\
+    Verify that the installation directory of a product in a base exists
+    Check all the config-<i> directory and verify the sat-config.pyconf file
+    that is in it 
+    
+    :param config Config: The global configuration
+    :param prod_dir str: The product installation directory path 
+                         (without config-<i>)
+    :param product_info Config: The configuration specific to 
+                               the product
+    :return: True or false is the installation is found or not 
+             and if it is found, the path of the found installation
+    :rtype: (boolean, str)
+    """   
+    # check if the directories or files of the directory corresponds to the 
+    # directory installation of the product
+    l_dir_and_files = os.listdir(prod_dir)
+    for dir_or_file in l_dir_and_files:
+        oExpr = re.compile(config_expression)
+        if not(oExpr.search(dir_or_file)):
+            # not config-<i>, not interesting
+            continue
+        # check if there is the file sat-config.pyconf file in the installation
+        # directory    
+        config_file = os.path.join(prod_dir, dir_or_file, src.CONFIG_FILENAME)
+        if not os.path.exists(config_file):
+            continue
+        
+        # If there is no dependency, it is the right path
+        if len(prod_info.depend)==0:
+            compile_cfg = src.pyconf.Config(config_file)
+            if len(compile_cfg) == 0:
+                return True, os.path.join(prod_dir, dir_or_file)
+            continue
+        
+        # check if there is the config described in the file corresponds the 
+        # dependencies of the product
+        config_corresponds = True    
+        compile_cfg = src.pyconf.Config(config_file)
+        for prod_dep in prod_info.depend:
+            # if the dependency is not in the config, 
+            # the config does not correspond
+            if prod_dep not in compile_cfg:
+                config_corresponds = False
+                break
+            else:
+                prod_dep_info = get_product_config(config, prod_dep, False)
+                # If the version of the dependency does not correspond, 
+                # the config does not correspond
+                if prod_dep_info.version != compile_cfg[prod_dep]:
+                    config_corresponds = False
+                    break
+        
+        for prod_name in compile_cfg:
+            if prod_name not in prod_info.depend:
+                config_corresponds = False
+                break
+        
+        if config_corresponds:
+            return True, os.path.join(prod_dir, dir_or_file)
+    
+    return False, None
+            
+            
+    

+
[docs]def get_products_infos(lproducts, config):
+    """Get the specific configuration of a list of products
+    
+    :param lproducts List: The list of product names
+    :param config Config: The global configuration
+    :return: the list of tuples 
+             (product name, specific configuration of the product)
+    :rtype: [(str, Config)]
+    """
+    products_infos = []
+    # Loop on product names
+    for prod in lproducts:       
+        # Get the specific configuration of the product
+        prod_info = get_product_config(config, prod)
+        if prod_info is not None:
+            products_infos.append((prod, prod_info))
+        else:
+            msg = _("The %s product has no definition "
+                    "in the configuration.") % prod
+            raise src.SatException(msg)
+    return products_infos
+

+
[docs]def get_product_dependencies(config, product_info):
+    """\
+    Get recursively the list of products that are 
+    in the product_info dependencies
+    
+    :param config Config: The global configuration
+    :param product_info Config: The configuration specific to 
+                               the product
+    :return: the list of products in dependence
+    :rtype: list
+    """
+    if "depend" not in product_info or product_info.depend == []:
+        return []
+    res = []
+    for prod in product_info.depend:
+        if prod == product_info.name:
+            continue
+        if prod not in res:
+            res.append(prod)
+        prod_info = get_product_config(config, prod)
+        dep_prod = get_product_dependencies(config, prod_info)
+        for prod_in_dep in dep_prod:
+            if prod_in_dep not in res:
+                res.append(prod_in_dep)
+    return res
+

+
[docs]def check_installation(product_info):
+    """\
+    Verify if a product is well installed. Checks install directory presence
+    and some additional files if it is defined in the config 
+    
+    :param product_info Config: The configuration specific to 
+                               the product
+    :return: True if it is well installed
+    :rtype: boolean
+    """
+    if not product_compiles(product_info):
+        return True
+    install_dir = product_info.install_dir
+    if not os.path.exists(install_dir):
+        return False
+    if ("present_files" in product_info and 
+        "install" in product_info.present_files):
+        for file_relative_path in product_info.present_files.install:
+            file_path = os.path.join(install_dir, file_relative_path)
+            if not os.path.exists(file_path):
+                return False
+    return True
+

+
[docs]def check_source(product_info):
+    """Verify if a sources of product is preset. Checks source directory presence
+    
+    :param product_info Config: The configuration specific to 
+                               the product
+    :return: True if it is well installed
+    :rtype: boolean
+    """
+    DBG.write("check_source product_info", product_info)
+    source_dir = product_info.source_dir
+    if not os.path.exists(source_dir):
+        return False
+    if ("present_files" in product_info and 
+        "source" in product_info.present_files):
+        for file_relative_path in product_info.present_files.source:
+            file_path = os.path.join(source_dir, file_relative_path)
+            if not os.path.exists(file_path):
+                return False
+    return True
+

+
[docs]def product_is_sample(product_info):
+    """Know if a product has the sample type
+    
+    :param product_info Config: The configuration specific to 
+                               the product
+    :return: True if the product has the sample type, else False
+    :rtype: boolean
+    """
+    if 'type' in product_info:
+        ptype = product_info.type
+        return ptype.lower() == 'sample'
+    else:
+        return False
+

+
[docs]def product_is_salome(product_info):
+    """Know if a product is a SALOME module
+    
+    :param product_info Config: The configuration specific to 
+                               the product
+    :return: True if the product is a SALOME module, else False
+    :rtype: boolean
+    """
+    return ("properties" in product_info and
+            "is_SALOME_module" in product_info.properties and
+            product_info.properties.is_SALOME_module == "yes")
+

+
[docs]def product_is_fixed(product_info):
+    """Know if a product is fixed
+    
+    :param product_info Config: The configuration specific to 
+                               the product
+    :return: True if the product is fixed, else False
+    :rtype: boolean
+    """
+    get_src = product_info.get_source
+    return get_src.lower() == 'fixed'
+

+
[docs]def product_is_native(product_info):
+    """Know if a product is native
+    
+    :param product_info Config: The configuration specific to 
+                               the product
+    :return: True if the product is native, else False
+    :rtype: boolean
+    """
+    get_src = product_info.get_source
+    return get_src.lower() == 'native'
+

+
[docs]def product_is_dev(product_info):
+    """Know if a product is in dev mode
+    
+    :param product_info Config: The configuration specific to 
+                               the product
+    :return: True if the product is in dev mode, else False
+    :rtype: boolean
+    """
+    dev = product_info.dev
+    res = (dev.lower() == 'yes')
+    DBG.write('product_is_dev %s' % product_info.name, res)
+    # if product_info.name == "XDATA": return True #test #10569
+    return res
+

+
[docs]def product_is_debug(product_info):
+    """Know if a product is in debug mode
+    
+    :param product_info Config: The configuration specific to 
+                               the product
+    :return: True if the product is in debug mode, else False
+    :rtype: boolean
+    """
+    debug = product_info.debug
+    return debug.lower() == 'yes'
+

+
[docs]def product_is_autotools(product_info):
+    """Know if a product is compiled using the autotools
+    
+    :param product_info Config: The configuration specific to 
+                               the product
+    :return: True if the product is autotools, else False
+    :rtype: boolean
+    """
+    build_src = product_info.build_source
+    return build_src.lower() == 'autotools'
+

+
[docs]def product_is_cmake(product_info):
+    """Know if a product is compiled using the cmake
+    
+    :param product_info Config: The configuration specific to 
+                               the product
+    :return: True if the product is cmake, else False
+    :rtype: boolean
+    """
+    build_src = product_info.build_source
+    return build_src.lower() == 'cmake'
+

+
[docs]def product_is_vcs(product_info):
+    """Know if a product is download using git, svn or cvs (not archive)
+    
+    :param product_info Config: The configuration specific to 
+                               the product
+    :return: True if the product is vcs, else False
+    :rtype: boolean
+    """
+    return product_info.get_source in AVAILABLE_VCS
+

+
[docs]def product_is_smesh_plugin(product_info):
+    """Know if a product is a SMESH plugin
+    
+    :param product_info Config: The configuration specific to 
+                               the product
+    :return: True if the product is a SMESH plugin, else False
+    :rtype: boolean
+    """
+    return ("properties" in product_info and
+            "smesh_plugin" in product_info.properties and
+            product_info.properties.smesh_plugin == "yes")
+

+
[docs]def product_is_cpp(product_info):
+    """Know if a product is cpp
+    
+    :param product_info Config: The configuration specific to 
+                               the product
+    :return: True if the product is a cpp, else False
+    :rtype: boolean
+    """
+    return ("properties" in product_info and
+            "cpp" in product_info.properties and
+            product_info.properties.cpp == "yes")
+

+
[docs]def product_compiles(product_info):
+    """\
+    Know if a product compiles or not 
+    (some products do not have a compilation procedure)
+    
+    :param product_info Config: The configuration specific to 
+                               the product
+    :return: True if the product compiles, else False
+    :rtype: boolean
+    """
+    return not("properties" in product_info and
+            "compilation" in product_info.properties and
+            product_info.properties.compilation == "no")
+

+
[docs]def product_has_script(product_info):
+    """Know if a product has a compilation script
+    
+    :param product_info Config: The configuration specific to 
+                               the product
+    :return: True if the product it has a compilation script, else False
+    :rtype: boolean
+    """
+    if "build_source" not in product_info:
+        # Native case
+        return False
+    build_src = product_info.build_source
+    return build_src.lower() == 'script'
+

+
[docs]def product_has_env_script(product_info):
+    """Know if a product has an environment script
+    
+    :param product_info Config: The configuration specific to 
+                               the product
+    :return: True if the product it has an environment script, else False
+    :rtype: boolean
+    """
+    return "environ" in product_info and "env_script" in product_info.environ
+

+
[docs]def product_has_patches(product_info):
+    """Know if a product has one or more patches
+    
+    :param product_info Config: The configuration specific to 
+                               the product
+    :return: True if the product has one or more patches
+    :rtype: boolean
+    """   
+    res = ( "patches" in product_info and len(product_info.patches) > 0 )
+    DBG.write('product_has_patches %s' % product_info.name, res)
+    # if product_info.name == "XDATA": return True #test #10569
+    return res
+

+
+
[docs]def product_has_salome_gui(product_info):
+    """Know if a product has a SALOME gui
+    
+    :param product_info Config: The configuration specific to 
+                               the product
+    :return: True if the product has a SALOME gui, else False
+    :rtype: Boolean
+    """
+    return ("properties" in product_info and
+            "has_salome_gui" in product_info.properties and
+            product_info.properties.has_salome_gui == "yes")
+

+
[docs]def product_is_mpi(product_info):
+    """Know if a product has openmpi in its dependencies
+    
+    :param product_info Config: The configuration specific to 
+                               the product
+    :return: True if the product has openmpi inits dependencies
+    :rtype: boolean
+    """
+    return "openmpi" in product_info.depend
+

+
[docs]def product_is_generated(product_info):
+    """Know if a product is generated (YACSGEN)
+    
+    :param product_info Config: The configuration specific to 
+                               the product
+    :return: True if the product is generated
+    :rtype: boolean
+    """
+    return ("properties" in product_info and
+            "generate" in product_info.properties and
+            product_info.properties.generate == "yes")
+

+
[docs]def get_product_components(product_info):
+    """Get the component list to generate with the product
+    
+    :param product_info Config: The configuration specific to 
+                               the product
+    :return: The list of names of the components
+    :rtype: List
+    
+    """
+    if not product_is_generated(product_info):
+        return []
+    
+    compo_list = []
+    if "component_name" in product_info:
+        compo_list = product_info.component_name
+    
+        if isinstance(compo_list, str):
+            compo_list = [ compo_list ]
+
+    return compo_list

+
+ +
+
+
+
+
+
+

Related Topics

+ +
+ + +
+
+
+
+
+ ©2018, CEA. + + | + Powered by Sphinx 1.1.3 + & Alabaster + +
+ + + + + + \ No newline at end of file diff --git a/doc/build/html/_modules/src/pyconf.html b/doc/build/html/_modules/src/pyconf.html new file mode 100644 index 0000000..fd3372e --- /dev/null +++ b/doc/build/html/_modules/src/pyconf.html @@ -0,0 +1,1836 @@ + + + + + + + + + src.pyconf — salomeTools 5.0.0dev documentation + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+ +

Source code for src.pyconf

+#!/usr/bin/env python
+#-*- coding:utf-8 -*-
+
+# Copyright 2004-2007 by Vinay Sajip. All Rights Reserved.
+#
+# Permission to use, copy, modify, and distribute this software and its
+# documentation for any purpose and without fee is hereby granted,
+# provided that the above copyright notice appear in all copies and that
+# both that copyright notice and this permission notice appear in
+# supporting documentation, and that the name of Vinay Sajip
+# not be used in advertising or publicity pertaining to distribution
+# of the software without specific, written prior permission.
+# VINAY SAJIP DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
+# ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL
+# VINAY SAJIP BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
+# ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER
+# IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
+# OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+#  Copyright (C) 2010-2013  CEA/DEN
+#
+#  This library is free software; you can redistribute it and/or
+#  modify it under the terms of the GNU Lesser General Public
+#  License as published by the Free Software Foundation; either
+#  version 2.1 of the License.
+#
+#  This library is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#  Lesser General Public License for more details.
+#
+#  You should have received a copy of the GNU Lesser General Public
+#  License along with this library; if not, write to the Free Software
+#  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+
+# CEA adds : 
+# Possibility to overwrites value in a pyconf file
+# Python 3 porting
+
+
+"""
+This is a configuration module for Python.
+
+This module should work under Python versions >= 2.2, and cannot be used with
+earlier versions since it uses new-style classes.
+
+Development and testing has only been carried out (so far) on Python 2.3.4 and
+Python 2.4.2. See the test module (test_config.py) included in the
+U{distribution<http://www.red-dove.com/python_config.html|_blank>} (follow the
+download link).
+
+A simple example - with the example configuration file::
+
+    messages:
+    [
+      {
+        stream : `sys.stderr`
+        message: 'Welcome'
+        name: 'Harry'
+      }
+      {
+        stream : `sys.stdout`
+        message: 'Welkom'
+        name: 'Ruud'
+      }
+      {
+        stream : $messages[0].stream
+        message: 'Bienvenue'
+        name: Yves
+      }
+    ]
+
+a program to read the configuration would be::
+
+    from config import Config
+
+    f = file('simple.cfg')
+    cfg = Config(f)
+    for m in cfg.messages:
+        s = '%s, %s' % (m.message, m.name)
+        try:
+            print >> m.stream, s
+        except IOError, e:
+            print e
+
+which, when run, would yield the console output::
+
+    Welcome, Harry
+    Welkom, Ruud
+    Bienvenue, Yves
+
+See U{this tutorial<http://www.red-dove.com/python_config.html|_blank>} for more
+information.
+
+#modified for salomeTools
+@version: 0.3.7.1
+
+@author: Vinay Sajip
+
+@copyright: Copyright (C) 2004-2007 Vinay Sajip. All Rights Reserved.
+
+
+@var streamOpener: The default stream opener. This is a factory function which
+takes a string (e.g. filename) and returns a stream suitable for reading. If
+unable to open the stream, an IOError exception should be thrown.
+
+The default value of this variable is L{defaultStreamOpener}. For an example
+of how it's used, see test_config.py (search for streamOpener).
+"""
+
+__author__  = "Vinay Sajip <vinay_sajip@red-dove.com>"
+__status__  = "alpha"
+__version__ = "0.3.7.1" #modified for salomeTools
+__date__    = "05 October 2007"
+
+import codecs
+import os
+import sys
+
+WORD = 'a'
+NUMBER = '9'
+STRING = '"'
+EOF = ''
+LCURLY = '{'
+RCURLY = '}'
+LBRACK = '['
+LBRACK2 = 'a['
+RBRACK = ']'
+LPAREN = '('
+LPAREN2 = '(('
+RPAREN = ')'
+DOT = '.'
+COMMA = ','
+COLON = ':'
+AT = '@'
+PLUS = '+'
+MINUS = '-'
+STAR = '*'
+SLASH = '/'
+MOD = '%'
+BACKTICK = '`'
+DOLLAR = '$'
+TRUE = 'True'
+FALSE = 'False'
+NONE = 'None'
+
+WORDCHARS = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz_"
+
+if sys.platform == 'win32':
+    NEWLINE = '\r\n'
+elif os.name == 'mac':
+    NEWLINE = '\r'
+else:
+    NEWLINE = '\n'
+
+try:
+    has_utf32 = True
+except:
+    has_utf32 = False
+
+
[docs]class ConfigInputStream(object):
+    """
+    An input stream which can read either ANSI files with default encoding
+    or Unicode files with BOMs.
+
+    Handles UTF-8, UTF-16LE, UTF-16BE. Could handle UTF-32 if Python had
+    built-in support.
+    """
+    def __init__(self, stream):
+        """
+        Initialize an instance.
+
+        @param stream: The underlying stream to be read. Should be seekable.
+        @type stream: A stream (file-like object).
+        """
+        encoding = None
+        signature = stream.read(4)
+        used = -1
+        if has_utf32:
+            if signature == codecs.BOM_UTF32_LE:
+                encoding = 'utf-32le'
+            elif signature == codecs.BOM_UTF32_BE:
+                encoding = 'utf-32be'
+        if encoding is None:
+            if signature[:3] == codecs.BOM_UTF8:
+                used = 3
+                encoding = 'utf-8'
+            elif signature[:2] == codecs.BOM_UTF16_LE:
+                used = 2
+                encoding = 'utf-16le'
+            elif signature[:2] == codecs.BOM_UTF16_BE:
+                used = 2
+                encoding = 'utf-16be'
+            else:
+                used = 0
+        if used >= 0:
+            stream.seek(used)
+        if encoding:
+            reader = codecs.getreader(encoding)
+            stream = reader(stream)
+        self.stream = stream
+        self.encoding = encoding
+
+
[docs]    def read(self, size):
+        if (size == 0) or (self.encoding is None):
+            rv = self.stream.read(size)
+        else:
+            rv = u''
+            while size > 0:
+                rv += self.stream.read(1)
+                size -= 1
+        return rv
+

+
[docs]    def close(self):
+        self.stream.close()
+

+
[docs]    def readline(self):
+        if self.encoding is None:
+            line = ''
+        else:
+            line = u''
+        while True:
+            c = self.stream.read(1)
+            if isinstance(c, bytes):
+                c = c.decode()
+            if c:
+                line += c
+            if c == '\n':
+                break
+        return line
+

+
[docs]class ConfigOutputStream(object):
+    """
+    An output stream which can write either ANSI files with default encoding
+    or Unicode files with BOMs.
+
+    Handles UTF-8, UTF-16LE, UTF-16BE. Could handle UTF-32 if Python had
+    built-in support.
+    """
+
+    def __init__(self, stream, encoding=None):
+        """
+        Initialize an instance.
+
+        @param stream: The underlying stream to be written.
+        @type stream: A stream (file-like object).
+        @param encoding: The desired encoding.
+        @type encoding: str
+        """
+        if encoding is not None:
+            encoding = str(encoding).lower()
+        self.encoding = encoding
+        if encoding == "utf-8":
+            stream.write(codecs.BOM_UTF8)
+        elif encoding == "utf-16be":
+            stream.write(codecs.BOM_UTF16_BE)
+        elif encoding == "utf-16le":
+            stream.write(codecs.BOM_UTF16_LE)
+        elif encoding == "utf-32be":
+            stream.write(codecs.BOM_UTF32_BE)
+        elif encoding == "utf-32le":
+            stream.write(codecs.BOM_UTF32_LE)
+
+        if encoding is not None:
+            writer = codecs.getwriter(encoding)
+            stream = writer(stream)
+        self.stream = stream
+
+
[docs]    def write(self, data):
+        self.stream.write(data)
+

+
[docs]    def flush(self):
+        self.stream.flush()
+

+
[docs]    def close(self):
+        self.stream.close()
+

+
[docs]def defaultStreamOpener(name):
+    """\
+    This function returns a read-only stream, given its name. The name passed
+    in should correspond to an existing stream, otherwise an exception will be
+    raised.
+
+    This is the default value of L{streamOpener}; assign your own callable to
+    streamOpener to return streams based on names. For example, you could use
+    urllib2.urlopen().
+
+    @param name: The name of a stream, most commonly a file name.
+    @type name: str
+    @return: A stream with the specified name.
+    @rtype: A read-only stream (file-like object)
+    """
+    return ConfigInputStream(open(name, 'rb'))
+

+streamOpener = None
+
+__resolveOverwrite__ = True
+
+
[docs]class ConfigError(Exception):
+    """
+    This is the base class of exceptions raised by this module.
+    """
+    pass
+

+
[docs]class ConfigFormatError(ConfigError):
+    """
+    This is the base class of exceptions raised due to syntax errors in
+    configurations.
+    """
+    pass
+

+
[docs]class ConfigResolutionError(ConfigError):
+    """
+    This is the base class of exceptions raised due to semantic errors in
+    configurations.
+    """
+    pass
+

+
[docs]def isWord(s):
+    """
+    See if a passed-in value is an identifier. If the value passed in is not a
+    string, False is returned. An identifier consists of alphanumerics or
+    underscore characters.
+
+    Examples::
+
+        isWord('a word') ->False
+        isWord('award') -> True
+        isWord(9) -> False
+        isWord('a_b_c_') ->True
+
+    @note: isWord('9abc') will return True - not exactly correct, but adequate
+    for the way it's used here.
+
+    @param s: The name to be tested
+    @type s: any
+    @return: True if a word, else False
+    @rtype: bool
+    """
+    if type(s) != type(''):
+        return False
+    s = s.replace('_', '')
+    return s.isalnum()
+

+
[docs]def makePath(prefix, suffix):
+    """\
+    Make a path from a prefix and suffix.
+
+    Examples:
+    makePath('', 'suffix') -> 'suffix'
+    makePath('prefix', 'suffix') -> 'prefix.suffix'
+    makePath('prefix', '[1]') -> 'prefix[1]'
+
+    @param prefix: The prefix to use. If it evaluates as false, the suffix is returned.
+    @type prefix: str
+    @param suffix: The suffix to use. It is either an identifier or an index in brackets.
+    @type suffix: str
+    @return: The path concatenation of prefix and suffix, with adot if the suffix is not a bracketed index.
+    @rtype: str
+    """
+    if not prefix:
+        rv = suffix
+    elif suffix[0] == '[':
+        rv = prefix + suffix
+    else:
+        rv = prefix + '.' + suffix
+    return rv
+
+

+
[docs]class Container(object):
+    """
+    This internal class is the base class for mappings and sequences.
+
+    @ivar path: A string which describes how to get
+    to this instance from the root of the hierarchy.
+
+    Example::
+
+        a.list.of[1].or['more'].elements
+    """
+    def __init__(self, parent):
+        """
+        Initialize an instance.
+
+        @param parent: The parent of this instance in the hierarchy.
+        @type parent: A L{Container} instance.
+        """
+        object.__setattr__(self, 'parent', parent)
+
+
[docs]    def setPath(self, path):
+        """
+        Set the path for this instance.
+        @param path: The path - a string which describes how to get
+        to this instance from the root of the hierarchy.
+        @type path: str
+        """
+        object.__setattr__(self, 'path', path)
+

+
[docs]    def evaluate(self, item):
+        """
+        Evaluate items which are instances of L{Reference} or L{Expression}.
+
+        L{Reference} instances are evaluated using L{Reference.resolve},
+        and L{Expression} instances are evaluated using
+        L{Expression.evaluate}.
+
+        @param item: The item to be evaluated.
+        @type item: any
+        @return: If the item is an instance of L{Reference} or L{Expression},
+        the evaluated value is returned, otherwise the item is returned
+        unchanged.
+        """
+        if isinstance(item, Reference):
+            item = item.resolve(self)
+        elif isinstance(item, Expression):
+            item = item.evaluate(self)
+        return item
+

+
[docs]    def writeToStream(self, stream, indent, container):
+        """
+        Write this instance to a stream at the specified indentation level.
+
+        Should be redefined in subclasses.
+
+        @param stream: The stream to write to
+        @type stream: A writable stream (file-like object)
+        @param indent: The indentation level
+        @type indent: int
+        @param container: The container of this instance
+        @type container: L{Container}
+        @raise NotImplementedError: If a subclass does not override this
+        """
+        raise NotImplementedError
+

+
[docs]    def writeValue(self, value, stream, indent):
+        if isinstance(self, Mapping):
+            indstr = ' '
+        else:
+            indstr = indent * '  '
+        if isinstance(value, Reference) or isinstance(value, Expression):
+            stream.write('%s%r%s' % (indstr, value, NEWLINE))
+        else:
+            if isinstance(value, str): # and not isWord(value):
+                value = repr(value)
+            stream.write('%s%s%s' % (indstr, value, NEWLINE))
+

+
[docs]class Mapping(Container):
+    """
+    This internal class implements key-value mappings in configurations.
+    """
+
+    def __init__(self, parent=None):
+        """
+        Initialize an instance.
+
+        @param parent: The parent of this instance in the hierarchy.
+        @type parent: A L{Container} instance.
+        """
+        Container.__init__(self, parent)
+        object.__setattr__(self, 'path', '')
+        object.__setattr__(self, 'data', {})
+        object.__setattr__(self, 'order', [])   # to preserve ordering
+        object.__setattr__(self, 'comments', {})
+
+    def __delitem__(self, key):
+        """
+        Remove an item
+        """
+        data = object.__getattribute__(self, 'data')
+        if key not in data:
+            raise AttributeError(key)
+        order = object.__getattribute__(self, 'order')
+        comments = object.__getattribute__(self, 'comments')
+        del data[key]
+        order.remove(key)
+        del comments[key]
+
+    def __getitem__(self, key):
+        data = object.__getattribute__(self, 'data')
+        if key not in data:
+            raise AttributeError(key)
+        rv = data[key]
+        return self.evaluate(rv)
+
+    __getattr__ = __getitem__
+    
+    '''
+    def __getattribute__(self, name):
+        if name == "__dict__":
+            return {}
+        if name in ["__methods__", "__members__"]:
+            return []
+        #if name == "__class__":
+        #    return ''
+        data = object.__getattribute__(self, "data")
+        useData = data.has_key(name)
+        if useData:
+            rv = getattr(data, name)
+        else:
+            rv = object.__getattribute__(self, name)
+            if rv is None:
+                raise AttributeError(name)
+        return rv
+    '''
+
+
[docs]    def iteritems(self):
+        for key in self.keys():
+            yield(key, self[key])
+        raise StopIteration
+

+    def __contains__(self, item):
+        order = object.__getattribute__(self, 'order')
+        return item in order
+
+
[docs]    def addMapping(self, key, value, comment, setting=False):
+        """
+        Add a key-value mapping with a comment.
+
+        @param key: The key for the mapping.
+        @type key: str
+        @param value: The value for the mapping.
+        @type value: any
+        @param comment: The comment for the key (can be None).
+        @type comment: str
+        @param setting: If True, ignore clashes. This is set
+        to true when called from L{__setattr__}.
+        @raise ConfigFormatError: If an existing key is seen
+        again and setting is False.
+        """
+        data = object.__getattribute__(self, 'data')
+        order = object.__getattribute__(self, 'order')
+        comments = object.__getattribute__(self, 'comments')
+
+        data[key] = value
+        if key not in order:
+            order.append(key)
+        elif not setting:
+            raise ConfigFormatError("repeated key: %s" % key)
+        comments[key] = comment
+

+    def __setattr__(self, name, value):
+        self.addMapping(name, value, None, True)
+
+    __setitem__ = __setattr__
+
+
[docs]    def keys(self):
+        """
+        Return the keys in a similar way to a dictionary.
+        """
+        return object.__getattribute__(self, 'order')
+

+
[docs]    def get(self, key, default=None):
+        """
+        Allows a dictionary-style get operation.
+        """
+        if key in self:
+            return self[key]
+        return default
+

+    def __str__(self):
+        return str(object.__getattribute__(self, 'data'))
+
+    def __repr__(self):
+        return repr(object.__getattribute__(self, 'data'))
+
+    def __len__(self):
+        return len(object.__getattribute__(self, 'order'))
+
+    def __iter__(self):
+        return self.iterkeys()
+
+
[docs]    def iterkeys(self):
+        order = object.__getattribute__(self, 'order')
+        return order.__iter__()
+

+
[docs]    def writeToStream(self, stream, indent, container):
+        """
+        Write this instance to a stream at the specified indentation level.
+
+        Should be redefined in subclasses.
+
+        @param stream: The stream to write to
+        @type stream: A writable stream (file-like object)
+        @param indent: The indentation level
+        @type indent: int
+        @param container: The container of this instance
+        @type container: L{Container}
+        """
+        indstr = indent * '  '
+        if len(self) == 0:
+            stream.write(' { }%s' % NEWLINE)
+        else:
+            if isinstance(container, Mapping):
+                stream.write(NEWLINE)
+            stream.write('%s{%s' % (indstr, NEWLINE))
+            self.__save__(stream, indent + 1)
+            stream.write('%s}%s' % (indstr, NEWLINE))
+

+    def __save__(self, stream, indent=0):
+        """
+        Save this configuration to the specified stream.
+        @param stream: A stream to which the configuration is written.
+        @type stream: A write-only stream (file-like object).
+        @param indent: The indentation level for the output.
+        @type indent: int
+        """
+        indstr = indent * '  '
+        order = object.__getattribute__(self, 'order')
+        data = object.__getattribute__(self, 'data')
+        maxlen = 0 # max(map(lambda x: len(x), order))
+        for key in order:
+            comment = self.comments[key]
+            if isWord(key):
+                skey = key
+            else:
+                skey = repr(key)
+            if comment:
+                stream.write('%s#%s' % (indstr, comment))
+            if skey.startswith("u'"):
+                skey = skey[1:]
+            stream.write('%s%-*s :' % (indstr, maxlen, skey))
+            value = data[key]
+            if isinstance(value, Container):
+                value.writeToStream(stream, indent, self)
+            else:
+                self.writeValue(value, stream, indent)
+

+
[docs]class Config(Mapping):
+    """
+    This class represents a configuration, and is the only one which clients
+    need to interface to, under normal circumstances.
+    """
+
+
[docs]    class Namespace(object):
+        """
+        This internal class is used for implementing default namespaces.
+
+        An instance acts as a namespace.
+        """
+        def __init__(self):
+            self.sys = sys
+            self.os = os
+

+    def __init__(self, streamOrFile=None, parent=None, PWD = None):
+        """
+        Initializes an instance.
+
+        @param streamOrFile: If specified, causes this instance to be loaded
+        from the stream (by calling L{load}). If a string is provided, it is
+        passed to L{streamOpener} to open a stream. Otherwise, the passed
+        value is assumed to be a stream and used as is.
+        @type streamOrFile: A readable stream (file-like object) or a name.
+        @param parent: If specified, this becomes the parent of this instance
+        in the configuration hierarchy.
+        @type parent: a L{Container} instance.
+        """
+        try: # Python 3 compatibility
+            if isinstance(streamOrFile, unicode):
+                streamOrFile = streamOrFile.encode()
+        except NameError:
+            pass
+        Mapping.__init__(self, parent)
+        object.__setattr__(self, 'reader', ConfigReader(self))
+        object.__setattr__(self, 'namespaces', [Config.Namespace()])
+        if streamOrFile is not None:
+            if isinstance(streamOrFile, str) or isinstance(streamOrFile, bytes):
+                global streamOpener
+                if streamOpener is None:
+                    streamOpener = defaultStreamOpener
+                streamOrFile = streamOpener(streamOrFile)
+            load = object.__getattribute__(self, "load")
+            load(streamOrFile)
+            # Specific add for salomeTools : PWD
+            if PWD:
+                key, pwd = PWD
+                if key == "":
+                    self.PWD = pwd
+                else:
+                    self[key].PWD = pwd
+
+
[docs]    def load(self, stream):
+        """
+        Load the configuration from the specified stream. Multiple streams can
+        be used to populate the same instance, as long as there are no
+        clashing keys. The stream is closed.
+        @param stream: A stream from which the configuration is read.
+        @type stream: A read-only stream (file-like object).
+        @raise ConfigError: if keys in the loaded configuration clash with
+        existing keys.
+        @raise ConfigFormatError: if there is a syntax error in the stream.
+        """
+        reader = object.__getattribute__(self, 'reader')
+        reader.load(stream)
+        stream.close()
+

+
[docs]    def addNamespace(self, ns, name=None):
+        """
+        Add a namespace to this configuration which can be used to evaluate
+        (resolve) dotted-identifier expressions.
+        @param ns: The namespace to be added.
+        @type ns: A module or other namespace suitable for passing as an
+        argument to vars().
+        @param name: A name for the namespace, which, if specified, provides
+        an additional level of indirection.
+        @type name: str
+        """
+        namespaces = object.__getattribute__(self, 'namespaces')
+        if name is None:
+            namespaces.append(ns)
+        else:
+            setattr(namespaces[0], name, ns)
+

+
[docs]    def removeNamespace(self, ns, name=None):
+        """
+        Remove a namespace added with L{addNamespace}.
+        @param ns: The namespace to be removed.
+        @param name: The name which was specified when L{addNamespace} was
+        called.
+        @type name: str
+        """
+        namespaces = object.__getattribute__(self, 'namespaces')
+        if name is None:
+            namespaces.remove(ns)
+        else:
+            delattr(namespaces[0], name)
+

+    def __save__(self, stream, indent=0, no_close=False):
+        """
+        Save this configuration to the specified stream. The stream is
+        closed if this is the top-level configuration in the hierarchy.
+        L{Mapping.__save__} is called to do all the work.
+        @param stream: A stream to which the configuration is written.
+        @type stream: A write-only stream (file-like object).
+        @param indent: The indentation level for the output.
+        @type indent: int
+        """
+        Mapping.__save__(self, stream, indent)
+        if indent == 0 and not no_close:
+            stream.close()
+
+
[docs]    def getByPath(self, path):
+        """
+        Obtain a value in the configuration via its path.
+        @param path: The path of the required value
+        @type path: str
+        @return the value at the specified path.
+        @rtype: any
+        @raise ConfigError: If the path is invalid
+        """
+        s = 'self.' + path
+        try:
+            return eval(s)
+        except Exception as e:
+            raise ConfigError(str(e))
+

+
[docs]class Sequence(Container):
+    """
+    This internal class implements a value which is a sequence of other values.
+    """
+
[docs]    class SeqIter(object):
+        """
+        This internal class implements an iterator for a L{Sequence} instance.
+        """
+        def __init__(self, seq):
+            self.seq = seq
+            self.limit = len(object.__getattribute__(seq, 'data'))
+            self.index = 0
+
+        def __iter__(self):
+            return self
+
+
[docs]        def next(self):
+            if self.index >= self.limit:
+                raise StopIteration
+            rv = self.seq[self.index]
+            self.index += 1
+            return rv
+        
+        # This method is for python3 compatibility

+        def __next__(self): 
+            if self.index >= self.limit:
+                raise StopIteration
+            rv = self.seq[self.index]
+            self.index += 1
+            return rv
+

+    def __init__(self, parent=None):
+        """
+        Initialize an instance.
+
+        @param parent: The parent of this instance in the hierarchy.
+        @type parent: A L{Container} instance.
+        """
+        Container.__init__(self, parent)
+        object.__setattr__(self, 'data', [])
+        object.__setattr__(self, 'comments', [])
+
+
[docs]    def append(self, item, comment):
+        """
+        Add an item to the sequence.
+
+        @param item: The item to add.
+        @type item: any
+        @param comment: A comment for the item.
+        @type comment: str
+        """
+        data = object.__getattribute__(self, 'data')
+        comments = object.__getattribute__(self, 'comments')
+        data.append(item)
+        comments.append(comment)
+

+    def __getitem__(self, index):
+        data = object.__getattribute__(self, 'data')
+        try:
+            rv = data[index]
+        except (IndexError, KeyError, TypeError):
+            raise ConfigResolutionError('%r is not a valid index for %r' % (index, object.__getattribute__(self, 'path')))
+        if not isinstance(rv, list):
+            rv = self.evaluate(rv)
+        else:
+            # deal with a slice
+            result = []
+            for a in rv:
+                result.append(self.evaluate(a))
+            rv = result
+        return rv
+
+    def __iter__(self):
+        return Sequence.SeqIter(self)
+
+    def __repr__(self):
+        return repr(object.__getattribute__(self, 'data'))
+
+    def __str__(self):
+        return str(self[:]) # using the slice evaluates the contents
+
+    def __len__(self):
+        return len(object.__getattribute__(self, 'data'))
+
+
[docs]    def writeToStream(self, stream, indent, container):
+        """
+        Write this instance to a stream at the specified indentation level.
+
+        Should be redefined in subclasses.
+
+        @param stream: The stream to write to
+        @type stream: A writable stream (file-like object)
+        @param indent: The indentation level
+        @type indent: int
+        @param container: The container of this instance
+        @type container: L{Container}
+        """
+        indstr = indent * '  '
+        if len(self) == 0:
+            stream.write(' [ ]%s' % NEWLINE)
+        else:
+            if isinstance(container, Mapping):
+                stream.write(NEWLINE)
+            stream.write('%s[%s' % (indstr, NEWLINE))
+            self.__save__(stream, indent + 1)
+            stream.write('%s]%s' % (indstr, NEWLINE))
+

+    def __save__(self, stream, indent):
+        """
+        Save this instance to the specified stream.
+        @param stream: A stream to which the configuration is written.
+        @type stream: A write-only stream (file-like object).
+        @param indent: The indentation level for the output, > 0
+        @type indent: int
+        """
+        if indent == 0:
+            raise ConfigError("sequence cannot be saved as a top-level item")
+        data = object.__getattribute__(self, 'data')
+        comments = object.__getattribute__(self, 'comments')
+        indstr = indent * '  '
+        for i in range(0, len(data)):
+            value = data[i]
+            comment = comments[i]
+            if comment:
+                stream.write('%s#%s' % (indstr, comment))
+            if isinstance(value, Container):
+                value.writeToStream(stream, indent, self)
+            else:
+                self.writeValue(value, stream, indent)
+

+
[docs]class Reference(object):
+    """
+    This internal class implements a value which is a reference to another value.
+    """
+    def __init__(self, config, type, ident):
+        """
+        Initialize an instance.
+
+        @param config: The configuration which contains this reference.
+        @type config: A L{Config} instance.
+        @param type: The type of reference.
+        @type type: BACKTICK or DOLLAR
+        @param ident: The identifier which starts the reference.
+        @type ident: str
+        """
+        self.config = config
+        self.type = type
+        self.elements = [ident]
+
+
[docs]    def addElement(self, type, ident):
+        """
+        Add an element to the reference.
+
+        @param type: The type of reference.
+        @type type: BACKTICK or DOLLAR
+        @param ident: The identifier which continues the reference.
+        @type ident: str
+        """
+        self.elements.append((type, ident))
+

+
[docs]    def findConfig(self, container):
+        """
+        Find the closest enclosing configuration to the specified container.
+
+        @param container: The container to start from.
+        @type container: L{Container}
+        @return: The closest enclosing configuration, or None.
+        @rtype: L{Config}
+        """
+        while (container is not None) and not isinstance(container, Config):
+            container = object.__getattribute__(container, 'parent')
+        return container
+

+
[docs]    def resolve(self, container):
+        """
+        Resolve this instance in the context of a container.
+
+        @param container: The container to resolve from.
+        @type container: L{Container}
+        @return: The resolved value.
+        @rtype: any
+        @raise ConfigResolutionError: If resolution fails.
+        """
+        rv = None
+        path = object.__getattribute__(container, 'path')
+        current = container
+        while current is not None:
+            if self.type == BACKTICK:
+                namespaces = object.__getattribute__(current, 'namespaces')
+                found = False
+                for ns in namespaces:
+                    try:
+                        rv = eval(str(self)[1:-1], vars(ns))
+                        found = True
+                        break
+                    except:
+                        pass
+                if found:
+                    break
+            else:
+                key = self.elements[0]
+                try:
+                    rv = current[key]
+                    for item in self.elements[1:]:
+                        key = item[1]
+                        rv = rv[key]
+                    break
+                except:
+                    rv = None
+                    pass
+            current = object.__getattribute__(current, 'parent')
+        if current is None:
+            raise ConfigResolutionError("unable to evaluate %r in the configuration %s" % (self, path))
+        return rv
+

+    def __str__(self):
+        s = self.elements[0]
+        for tt, tv in self.elements[1:]:
+            if tt == DOT:
+                s += '.%s' % tv
+            else:
+                s += '[%r]' % tv
+        if self.type == BACKTICK:
+            return BACKTICK + s + BACKTICK
+        else:
+            return DOLLAR + s
+
+    def __repr__(self):
+        return self.__str__()
+

+
[docs]class Expression(object):
+    """
+    This internal class implements a value which is obtained by evaluating an expression.
+    """
+    def __init__(self, op, lhs, rhs):
+        """
+        Initialize an instance.
+
+        @param op: the operation expressed in the expression.
+        @type op: PLUS, MINUS, STAR, SLASH, MOD
+        @param lhs: the left-hand-side operand of the expression.
+        @type lhs: any Expression or primary value.
+        @param rhs: the right-hand-side operand of the expression.
+        @type rhs: any Expression or primary value.
+        """
+        self.op = op
+        self.lhs = lhs
+        self.rhs = rhs
+
+    def __str__(self):
+        return '%r %s %r' % (self.lhs, self.op, self.rhs)
+
+    def __repr__(self):
+        return self.__str__()
+
+
[docs]    def evaluate(self, container):
+        """
+        Evaluate this instance in the context of a container.
+
+        @param container: The container to evaluate in from.
+        @type container: L{Container}
+        @return: The evaluated value.
+        @rtype: any
+        @raise ConfigResolutionError: If evaluation fails.
+        @raise ZeroDivideError: If division by zero occurs.
+        @raise TypeError: If the operation is invalid, e.g.
+        subtracting one string from another.
+        """
+        lhs = self.lhs
+        if isinstance(lhs, Reference):
+            lhs = lhs.resolve(container)
+        elif isinstance(lhs, Expression):
+            lhs = lhs.evaluate(container)
+        rhs = self.rhs
+        if isinstance(rhs, Reference):
+            rhs = rhs.resolve(container)
+        elif isinstance(rhs, Expression):
+            rhs = rhs.evaluate(container)
+        op = self.op
+        if op == PLUS:
+            rv = lhs + rhs
+        elif op == MINUS:
+            rv = lhs - rhs
+        elif op == STAR:
+            rv = lhs * rhs
+        elif op == SLASH:
+            rv = lhs / rhs
+        else:
+            rv = lhs % rhs
+        return rv
+

+
[docs]class ConfigReader(object):
+    """
+    This internal class implements a parser for configurations.
+    """
+
+    def __init__(self, config):
+        self.filename = None
+        self.config = config
+        self.lineno = 0
+        self.colno = 0
+        self.lastc = None
+        self.last_token = None
+        self.commentchars = '#'
+        self.whitespace = ' \t\r\n'
+        self.quotes = '\'"'
+        self.punct = ':-+*/%,.{}[]()@`$'
+        self.digits = '0123456789'
+        self.wordchars = '%s' % WORDCHARS # make a copy
+        self.identchars = self.wordchars + self.digits
+        self.pbchars = []
+        self.pbtokens = []
+        self.comment = None
+
+
[docs]    def location(self):
+        """
+        Return the current location (filename, line, column) in the stream
+        as a string.
+
+        Used when printing error messages,
+
+        @return: A string representing a location in the stream being read.
+        @rtype: str
+        """
+        return "%s(%d,%d)" % (self.filename, self.lineno, self.colno)
+

+
[docs]    def getChar(self):
+        """
+        Get the next char from the stream. Update line and column numbers
+        appropriately.
+
+        @return: The next character from the stream.
+        @rtype: str
+        """
+        if self.pbchars:
+            c = self.pbchars.pop()
+            if isinstance(c,bytes):
+                c = c.decode()
+        else:
+            c = self.stream.read(1)
+            if isinstance(c,bytes):
+                c = c.decode()
+            self.colno += 1
+            if c == '\n':
+                self.lineno += 1
+                self.colno = 1
+        return c
+

+    def __repr__(self):
+        return "<ConfigReader at 0x%08x>" % id(self)
+
+    __str__ = __repr__
+
+
[docs]    def getToken(self):
+        """
+        Get a token from the stream. String values are returned in a form
+        where you need to eval() the returned value to get the actual
+        string. The return value is (token_type, token_value).
+
+        Multiline string tokenizing is thanks to David Janes (BlogMatrix)
+
+        @return: The next token.
+        @rtype: A token tuple.
+        """
+        if self.pbtokens:
+            return self.pbtokens.pop()
+        stream = self.stream
+        self.comment = None
+        token = ''
+        tt = EOF
+        while True:
+            c = self.getChar()
+            if not c:
+                break
+            elif c == '#':
+                if self.comment :
+                    self.comment += '#' + stream.readline()
+                else :
+                    self.comment = stream.readline()
+                self.lineno += 1
+                continue
+            if c in self.quotes:
+                token = c
+                quote = c
+                tt = STRING
+                escaped = False
+                multiline = False
+                c1 = self.getChar()
+                if c1 == quote:
+                    c2 = self.getChar()
+                    if c2 == quote:
+                        multiline = True
+                        token += quote
+                        token += quote
+                    else:
+                        self.pbchars.append(c2)
+                        self.pbchars.append(c1)
+                else:
+                    self.pbchars.append(c1)
+                while True:
+                    c = self.getChar()
+                    if not c:
+                        break
+                    token += c
+                    if (c == quote) and not escaped:
+                        if not multiline or (len(token) >= 6 and token.endswith(token[:3]) and token[-4] != '\\'):
+                            break
+                    if c == '\\':
+                        escaped = not escaped
+                    else:
+                        escaped = False
+                if not c:
+                    raise ConfigFormatError('%s: Unterminated quoted string: %r, %r' % (self.location(), token, c))
+                break
+            if c in self.whitespace:
+                self.lastc = c
+                continue
+            elif c in self.punct:
+                token = c
+                tt = c
+                if (self.lastc == ']') or (self.lastc in self.identchars):
+                    if c == '[':
+                        tt = LBRACK2
+                    elif c == '(':
+                        tt = LPAREN2
+                break
+            elif c in self.digits:
+                token = c
+                tt = NUMBER
+                while True:
+                    c = self.getChar()
+                    if not c:
+                        break
+                    if c in self.digits:
+                        token += c
+                    elif (c == '.') and token.find('.') < 0:
+                        token += c
+                    else:
+                        if c and (c not in self.whitespace):
+                            self.pbchars.append(c)
+                        break
+                break
+            elif c in self.wordchars:
+                token = c
+                tt = WORD
+                c = self.getChar()
+                while c and (c in self.identchars):
+                    token += c
+                    c = self.getChar()
+                if c: # and c not in self.whitespace:
+                    self.pbchars.append(c)
+                if token == "True":
+                    tt = TRUE
+                elif token == "False":
+                    tt = FALSE
+                elif token == "None":
+                    tt = NONE
+                break
+            else:
+                raise ConfigFormatError('%s: Unexpected character: %r' % (self.location(), c))
+        if token:
+            self.lastc = token[-1]
+        else:
+            self.lastc = None
+        self.last_token = tt
+        
+        # Python 2.x specific unicode conversion
+        if sys.version_info[0] == 2 and tt == WORD and isinstance(token, unicode):
+            token = token.encode('ascii')
+        return (tt, token)
+

+
[docs]    def load(self, stream, parent=None, suffix=None):
+        """
+        Load the configuration from the specified stream.
+
+        @param stream: A stream from which to load the configuration.
+        @type stream: A stream (file-like object).
+        @param parent: The parent of the configuration (to which this reader
+        belongs) in the hierarchy. Specified when the configuration is
+        included in another one.
+        @type parent: A L{Container} instance.
+        @param suffix: The suffix of this configuration in the parent
+        configuration. Should be specified whenever the parent is not None.
+        @raise ConfigError: If parent is specified but suffix is not.
+        @raise ConfigFormatError: If there are syntax errors in the stream.
+        """
+        if parent is not None:
+            if suffix is None:
+                raise ConfigError("internal error: load called with parent but no suffix")
+            self.config.setPath(makePath(object.__getattribute__(parent, 'path'), suffix))
+        self.setStream(stream)
+        self.token = self.getToken()
+        self.parseMappingBody(self.config)
+        if self.token[0] != EOF:
+            raise ConfigFormatError('%s: expecting EOF, found %r' % (self.location(), self.token[1]))
+

+
[docs]    def setStream(self, stream):
+        """
+        Set the stream to the specified value, and prepare to read from it.
+
+        @param stream: A stream from which to load the configuration.
+        @type stream: A stream (file-like object).
+        """
+        self.stream = stream
+        if hasattr(stream, 'name'):
+            filename = stream.name
+        else:
+            filename = '?'
+        self.filename = filename
+        self.lineno = 1
+        self.colno = 1
+

+
[docs]    def match(self, t):
+        """
+        Ensure that the current token type matches the specified value, and
+        advance to the next token.
+
+        @param t: The token type to match.
+        @type t: A valid token type.
+        @return: The token which was last read from the stream before this
+        function is called.
+        @rtype: a token tuple - see L{getToken}.
+        @raise ConfigFormatError: If the token does not match what's expected.
+        """
+        if self.token[0] != t:
+            raise ConfigFormatError("%s: expecting %s, found %r" % (self.location(), t, self.token[1]))
+        rv = self.token
+        self.token = self.getToken()
+        return rv
+

+
[docs]    def parseMappingBody(self, parent):
+        """
+        Parse the internals of a mapping, and add entries to the provided
+        L{Mapping}.
+
+        @param parent: The mapping to add entries to.
+        @type parent: A L{Mapping} instance.
+        """
+        while self.token[0] in [WORD, STRING]:
+            self.parseKeyValuePair(parent)
+

+
[docs]    def parseKeyValuePair(self, parent):
+        """
+        Parse a key-value pair, and add it to the provided L{Mapping}.
+
+        @param parent: The mapping to add entries to.
+        @type parent: A L{Mapping} instance.
+        @raise ConfigFormatError: if a syntax error is found.
+        """
+        comment = self.comment
+        tt, tv = self.token
+        if tt == WORD:
+            key = tv
+            suffix = tv
+        elif tt == STRING:
+            key = eval(tv)
+            suffix = '[%s]' % tv
+        else:
+            msg = "%s: expecting word or string, found %r"
+            raise ConfigFormatError(msg % (self.location(), tv))
+        self.token = self.getToken()
+        # for now, we allow key on its own as a short form of key : True
+        if self.token[0] == COLON:
+            self.token = self.getToken()
+            value = self.parseValue(parent, suffix)
+        else:
+            value = True
+        try:
+            parent.addMapping(key, value, comment)
+        except Exception as e:
+            raise ConfigFormatError("%s: %s, %r" % (self.location(), e,
+                                    self.token[1]))
+        tt = self.token[0]
+        if tt not in [EOF, WORD, STRING, RCURLY, COMMA]:
+            msg = "%s: expecting one of EOF, WORD, STRING, \
+RCURLY, COMMA, found %r"
+            raise ConfigFormatError(msg  % (self.location(), self.token[1]))
+        if tt == COMMA:
+            self.token = self.getToken()
+

+
[docs]    def parseValue(self, parent, suffix):
+        """
+        Parse a value.
+
+        @param parent: The container to which the value will be added.
+        @type parent: A L{Container} instance.
+        @param suffix: The suffix for the value.
+        @type suffix: str
+        @return: The value
+        @rtype: any
+        @raise ConfigFormatError: if a syntax error is found.
+        """
+        tt = self.token[0]
+        if tt in [STRING, WORD, NUMBER, LPAREN, DOLLAR,
+                  TRUE, FALSE, NONE, BACKTICK, MINUS]:
+            rv = self.parseScalar()
+        elif tt == LBRACK:
+            rv = self.parseSequence(parent, suffix)
+        elif tt in [LCURLY, AT]:
+            rv = self.parseMapping(parent, suffix)
+        else:
+            raise ConfigFormatError("%s: unexpected input: %r" %
+               (self.location(), self.token[1]))
+        return rv
+

+
[docs]    def parseSequence(self, parent, suffix):
+        """
+        Parse a sequence.
+
+        @param parent: The container to which the sequence will be added.
+        @type parent: A L{Container} instance.
+        @param suffix: The suffix for the value.
+        @type suffix: str
+        @return: a L{Sequence} instance representing the sequence.
+        @rtype: L{Sequence}
+        @raise ConfigFormatError: if a syntax error is found.
+        """
+        rv = Sequence(parent)
+        rv.setPath(makePath(object.__getattribute__(parent, 'path'), suffix))
+        self.match(LBRACK)
+        comment = self.comment
+        tt = self.token[0]
+        while tt in [STRING, WORD, NUMBER, LCURLY, LBRACK, LPAREN, DOLLAR,
+                     TRUE, FALSE, NONE, BACKTICK]:
+            suffix = '[%d]' % len(rv)
+            value = self.parseValue(parent, suffix)
+            rv.append(value, comment)
+            tt = self.token[0]
+            comment = self.comment
+            if tt == COMMA:
+                self.match(COMMA)
+                tt = self.token[0]
+                comment = self.comment
+                continue
+        self.match(RBRACK)
+        return rv
+

+
[docs]    def parseMapping(self, parent, suffix):
+        """
+        Parse a mapping.
+
+        @param parent: The container to which the mapping will be added.
+        @type parent: A L{Container} instance.
+        @param suffix: The suffix for the value.
+        @type suffix: str
+        @return: a L{Mapping} instance representing the mapping.
+        @rtype: L{Mapping}
+        @raise ConfigFormatError: if a syntax error is found.
+        """
+        if self.token[0] == LCURLY:
+            self.match(LCURLY)
+            rv = Mapping(parent)
+            rv.setPath(
+               makePath(object.__getattribute__(parent, 'path'), suffix))
+            self.parseMappingBody(rv)
+            self.match(RCURLY)
+        else:
+            self.match(AT)
+            _, fn = self.match(STRING)
+            rv = Config(eval(fn), parent)
+        return rv
+

+
[docs]    def parseScalar(self):
+        """
+        Parse a scalar - a terminal value such as a string or number, or
+        an L{Expression} or L{Reference}.
+
+        @return: the parsed scalar
+        @rtype: any scalar
+        @raise ConfigFormatError: if a syntax error is found.
+        """
+        lhs = self.parseTerm()
+        tt = self.token[0]
+        while tt in [PLUS, MINUS]:
+            self.match(tt)
+            rhs = self.parseTerm()
+            lhs = Expression(tt, lhs, rhs)
+            tt = self.token[0]
+        return lhs
+

+
[docs]    def parseTerm(self):
+        """
+        Parse a term in an additive expression (a + b, a - b)
+
+        @return: the parsed term
+        @rtype: any scalar
+        @raise ConfigFormatError: if a syntax error is found.
+        """
+        lhs = self.parseFactor()
+        tt = self.token[0]
+        while tt in [STAR, SLASH, MOD]:
+            self.match(tt)
+            rhs = self.parseFactor()
+            lhs = Expression(tt, lhs, rhs)
+            tt = self.token[0]
+        return lhs
+

+
[docs]    def parseFactor(self):
+        """
+        Parse a factor in an multiplicative expression (a * b, a / b, a % b)
+
+        @return: the parsed factor
+        @rtype: any scalar
+        @raise ConfigFormatError: if a syntax error is found.
+        """
+        tt = self.token[0]
+        if tt in [NUMBER, WORD, STRING, TRUE, FALSE, NONE]:
+            rv = self.token[1]
+            if tt != WORD:
+                rv = eval(rv)
+            self.match(tt)
+        elif tt == LPAREN:
+            self.match(LPAREN)
+            rv = self.parseScalar()
+            self.match(RPAREN)
+        elif tt == DOLLAR:
+            self.match(DOLLAR)
+            rv = self.parseReference(DOLLAR)
+        elif tt == BACKTICK:
+            self.match(BACKTICK)
+            rv = self.parseReference(BACKTICK)
+            self.match(BACKTICK)
+        elif tt == MINUS:
+            self.match(MINUS)
+            rv = -self.parseScalar()
+        else:
+            raise ConfigFormatError("%s: unexpected input: %r" %
+               (self.location(), self.token[1]))
+        return rv
+

+
[docs]    def parseReference(self, type):
+        """
+        Parse a reference.
+
+        @return: the parsed reference
+        @rtype: L{Reference}
+        @raise ConfigFormatError: if a syntax error is found.
+        """
+        word = self.match(WORD)
+        rv = Reference(self.config, type, word[1])
+        while self.token[0] in [DOT, LBRACK2]:
+            self.parseSuffix(rv)
+        return rv
+

+
[docs]    def parseSuffix(self, ref):
+        """
+        Parse a reference suffix.
+
+        @param ref: The reference of which this suffix is a part.
+        @type ref: L{Reference}.
+        @raise ConfigFormatError: if a syntax error is found.
+        """
+        tt = self.token[0]
+        if tt == DOT:
+            self.match(DOT)
+            word = self.match(WORD)
+            ref.addElement(DOT, word[1])
+        else:
+            self.match(LBRACK2)
+            tt, tv = self.token
+            if tt not in [NUMBER, STRING]:
+                raise ConfigFormatError("%s: expected number or string, found %r" % (self.location(), tv))
+            self.token = self.getToken()
+            tv = eval(tv)
+            self.match(RBRACK)
+            ref.addElement(LBRACK, tv)
+

+
[docs]def defaultMergeResolve(map1, map2, key):
+    """\
+    A default resolver for merge conflicts. 
+    Returns a string indicating what action to take to resolve the conflict.
+
+    @param map1: The map being merged into.
+    @type map1: L{Mapping}.
+    @param map2: The map being used as the merge operand.
+    @type map2: L{Mapping}.
+    @param key: The key in map2 (which also exists in map1).
+    @type key: str
+
+    @return: One of "merge", "append", "mismatch" or "overwrite"
+             indicating what action should be taken. This should
+             be appropriate to the objects being merged - e.g.
+             there is no point returning "merge" if the two objects
+             are instances of L{Sequence}.
+
+    @rtype: str
+    """
+    obj1 = map1[key]
+    obj2 = map2[key]
+    if isinstance(obj1, Mapping) and isinstance(obj2, Mapping):
+        rv = "merge"
+    elif isinstance(obj1, Sequence) and isinstance(obj2, Sequence):
+        rv = "append"
+    else:
+        rv = "mismatch"
+    return rv
+

+
[docs]def overwriteMergeResolve(map1, map2, key):
+    """
+    An overwriting resolver for merge conflicts. Calls L{defaultMergeResolve},
+    but where a "mismatch" is detected, returns "overwrite" instead.
+
+    @param map1: The map being merged into.
+    @type map1: L{Mapping}.
+    @param map2: The map being used as the merge operand.
+    @type map2: L{Mapping}.
+    @param key: The key in map2 (which also exists in map1).
+    @type key: str
+    """
+    rv = defaultMergeResolve(map1, map2, key)
+    if rv == "mismatch":
+        rv = "overwrite"
+    return rv
+

+
[docs]def deepCopyMapping(inMapping):
+    res = Mapping()
+    for element in inMapping:
+        res[element] = inMapping[element]
+    return res
+

+
[docs]class ConfigMerger(object):
+    """
+    This class is used for merging two configurations. If a key exists in the
+    merge operand but not the merge target, then the entry is copied from the
+    merge operand to the merge target. If a key exists in both configurations,
+    then a resolver (a callable) is called to decide how to handle the
+    conflict.
+    """
+
+    def __init__(self, resolver=defaultMergeResolve):
+        """
+        Initialise an instance.
+
+        @param resolver:
+        @type resolver: A callable which takes the argument list
+        (map1, map2, key) where map1 is the mapping being merged into,
+        map2 is the merge operand and key is the clashing key. The callable
+        should return a string indicating how the conflict should be resolved.
+        For possible return values, see L{defaultMergeResolve}. The default
+        value preserves the old behaviour
+        """
+        self.resolver = resolver
+
+
[docs]    def merge(self, merged, mergee):
+        """
+        Merge two configurations. The second configuration is unchanged,
+        and the first is changed to reflect the results of the merge.
+
+        @param merged: The configuration to merge into.
+        @type merged: L{Config}.
+        @param mergee: The configuration to merge.
+        @type mergee: L{Config}.
+        """
+        self.mergeMapping(merged, mergee)
+

+
[docs]    def overwriteKeys(self, map1, seq2):
+        """
+        Renint variables. The second mapping is unchanged,
+        and the first is changed depending the keys of the second mapping.
+        @param map1: The mapping to reinit keys into.
+        @type map1: L{Mapping}.
+        @param map2: The mapping container reinit information.
+        @type map2: L{Mapping}.
+        """
+
+        overwrite_list = object.__getattribute__(seq2, 'data')
+        for overwrite_instruction in overwrite_list:
+            object.__setattr__(overwrite_instruction, 'parent', map1)
+            if "__condition__" in overwrite_instruction.keys():
+                overwrite_condition = overwrite_instruction["__condition__"]
+                if eval(overwrite_condition, globals(), map1):
+                    for key in overwrite_instruction.keys():
+                        if key == "__condition__":
+                            continue
+                        try:
+                            exec( 'map1.' + key + " = " + repr(overwrite_instruction[key]))
+                        except:
+                            exec('map1.' + key + " = " + str(overwrite_instruction[key]))
+            else:
+                for key in overwrite_instruction.keys():
+                    try:
+                        exec('map1.' + key + " = " + repr(overwrite_instruction[key]))
+                    except:
+                        exec('map1.' + key + " = " + str(overwrite_instruction[key]))
+

+
[docs]    def mergeMapping(self, map1, map2):
+        """
+        Merge two mappings recursively. The second mapping is unchanged,
+        and the first is changed to reflect the results of the merge.
+
+        @param map1: The mapping to merge into.
+        @type map1: L{Mapping}.
+        @param map2: The mapping to merge.
+        @type map2: L{Mapping}.
+        """
+        keys = map1.keys()
+        global __resolveOverwrite__
+        for key in map2.keys():
+            if __resolveOverwrite__ and key == "__overwrite__":
+                self.overwriteKeys(map1,map2[key])
+
+            elif key not in keys:
+                map1[key] = map2[key]
+                if isinstance(map1[key], Container) :
+                    object.__setattr__(map1[key], 'parent', map1)
+            else:
+                obj1 = map1[key]
+                obj2 = map2[key]
+                decision = self.resolver(map1, map2, key)
+                if decision == "merge":
+                    self.mergeMapping(obj1, obj2)
+                elif decision == "append":
+                    self.mergeSequence(obj1, obj2)
+                elif decision == "overwrite":
+                    map1[key] = obj2
+                    if isinstance(map1[key], Container):
+                        object.__setattr__(map1[key], 'parent', map1)
+                elif decision == "mismatch":
+                    self.handleMismatch(obj1, obj2)
+                else:
+                    msg = "unable to merge: don't know how to implement %r"
+                    raise ValueError(msg % decision)
+

+
[docs]    def mergeSequence(self, seq1, seq2):
+        """
+        Merge two sequences. The second sequence is unchanged,
+        and the first is changed to have the elements of the second
+        appended to it.
+
+        @param seq1: The sequence to merge into.
+        @type seq1: L{Sequence}.
+        @param seq2: The sequence to merge.
+        @type seq2: L{Sequence}.
+        """
+        data1 = object.__getattribute__(seq1, 'data')
+        data2 = object.__getattribute__(seq2, 'data')
+        for obj in data2:
+            data1.append(obj)
+        comment1 = object.__getattribute__(seq1, 'comments')
+        comment2 = object.__getattribute__(seq2, 'comments')
+        for obj in comment2:
+            comment1.append(obj)
+

+
[docs]    def handleMismatch(self, obj1, obj2):
+        """
+        Handle a mismatch between two objects.
+
+        @param obj1: The object to merge into.
+        @type obj1: any
+        @param obj2: The object to merge.
+        @type obj2: any
+        """
+        raise ConfigError("unable to merge %r with %r" % (obj1, obj2))
+

+
[docs]class ConfigList(list):
+    """
+    This class implements an ordered list of configurations and allows you
+    to try getting the configuration from each entry in turn, returning
+    the first successfully obtained value.
+    """
+
+
[docs]    def getByPath(self, path):
+        """
+        Obtain a value from the first configuration in the list which defines
+        it.
+
+        @param path: The path of the value to retrieve.
+        @type path: str
+        @return: The value from the earliest configuration in the list which
+        defines it.
+        @rtype: any
+        @raise ConfigError: If no configuration in the list has an entry with
+        the specified path.
+        """
+        found = False
+        rv = None
+        for entry in self:
+            try:
+                rv = entry.getByPath(path)
+                found = True
+                break
+            except ConfigError:
+                pass
+        if not found:
+            raise ConfigError("unable to resolve %r" % path)
+        return rv

+
+ +
+
+
+
+
+
+

Related Topics

+ +
+ + +
+
+
+
+
+ ©2018, CEA. + + | + Powered by Sphinx 1.1.3 + & Alabaster + +
+ + + + + + \ No newline at end of file diff --git a/doc/build/html/_modules/src/system.html b/doc/build/html/_modules/src/system.html new file mode 100644 index 0000000..e500c7a --- /dev/null +++ b/doc/build/html/_modules/src/system.html @@ -0,0 +1,311 @@ + + + + + + + + + src.system — salomeTools 5.0.0dev documentation + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+ +

Source code for src.system

+#!/usr/bin/env python
+#-*- coding:utf-8 -*-
+#  Copyright (C) 2010-2013  CEA/DEN
+#
+#  This library is free software; you can redistribute it and/or
+#  modify it under the terms of the GNU Lesser General Public
+#  License as published by the Free Software Foundation; either
+#  version 2.1 of the License.
+#
+#  This library is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#  Lesser General Public License for more details.
+#
+#  You should have received a copy of the GNU Lesser General Public
+#  License along with this library; if not, write to the Free Software
+#  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+
+'''
+In this file : all functions that do a system call, 
+like open a browser or an editor, or call a git command
+'''
+
+import subprocess
+import os
+import tarfile
+
+from . import printcolors
+
+
[docs]def show_in_editor(editor, filePath, logger):
+    '''open filePath using editor.
+    
+    :param editor str: The editor to use.
+    :param filePath str: The path to the file to open.
+    '''
+    # default editor is vi
+    if editor is None or len(editor) == 0:
+        editor = 'vi'
+    
+    if '%s' not in editor:
+        editor += ' %s'
+
+    try:
+        # launch cmd using subprocess.Popen
+        cmd = editor % filePath
+        logger.write('Launched command:\n' + cmd + '\n', 5)
+        p = subprocess.Popen(cmd, shell=True)
+        p.communicate()
+    except:
+        logger.write(printcolors.printcError(_("Unable to edit file %s\n") 
+                                             % filePath), 1)
+
+

+
[docs]def git_extract(from_what, tag, where, logger, environment=None):
+    '''Extracts sources from a git repository.
+    
+    :param from_what str: The remote git repository.
+    :param tag str: The tag.
+    :param where str: The path where to extract.
+    :param logger Logger: The logger instance to use.
+    :param environment src.environment.Environ: The environment to source when
+                                                extracting.
+    :return: True if the extraction is successful
+    :rtype: boolean
+    '''
+    if not where.exists():
+        where.make()
+    if tag == "master" or tag == "HEAD":
+        command = "git clone %(remote)s %(where)s" % \
+                    { 'remote': from_what, 'tag': tag, 'where': str(where) }
+    else:
+        # NOTICE: this command only works with recent version of git
+        #         because --work-tree does not work with an absolute path
+        where_git = os.path.join( str(where), ".git" )
+        command = "rmdir %(where)s && git clone %(remote)s %(where)s && " + \
+                  "git --git-dir=%(where_git)s --work-tree=%(where)s checkout %(tag)s"
+        command = command % {'remote': from_what, 
+                             'tag': tag, 
+                             'where': str(where), 
+                             'where_git': where_git }
+
+    logger.write(command + "\n", 5)
+
+    logger.logTxtFile.write("\n" + command + "\n")
+    logger.logTxtFile.flush()
+    res = subprocess.call(command,
+                          cwd=str(where.dir()),
+                          env=environment.environ.environ,
+                          shell=True,
+                          stdout=logger.logTxtFile,
+                          stderr=subprocess.STDOUT)
+    return (res == 0)
+

+
[docs]def archive_extract(from_what, where, logger):
+    '''Extracts sources from an archive.
+    
+    :param from_what str: The path to the archive.
+    :param where str: The path where to extract.
+    :param logger Logger: The logger instance to use.
+    :return: True if the extraction is successful
+    :rtype: boolean
+    '''
+    try:
+        archive = tarfile.open(from_what)
+        for i in archive.getmembers():
+            archive.extract(i, path=str(where))
+        return True, os.path.commonprefix(archive.getnames())
+    except Exception as exc:
+        logger.write("archive_extract: %s\n" % exc)
+        return False, None
+

+
[docs]def cvs_extract(protocol, user, server, base, tag, product, where,
+                logger, checkout=False, environment=None):
+    '''Extracts sources from a cvs repository.
+    
+    :param protocol str: The cvs protocol.
+    :param user str: The user to be used.
+    :param server str: The remote cvs server.
+    :param base str: .
+    :param tag str: The tag.
+    :param product str: The product.
+    :param where str: The path where to extract.
+    :param logger Logger: The logger instance to use.
+    :param checkout boolean: If true use checkout cvs.
+    :param environment src.environment.Environ: The environment to source when
+                                                extracting.
+    :return: True if the extraction is successful
+    :rtype: boolean
+    '''
+
+    opttag = ''
+    if tag is not None and len(tag) > 0:
+        opttag = '-r ' + tag
+
+    cmd = 'export'
+    if checkout:
+        cmd = 'checkout'
+    elif len(opttag) == 0:
+        opttag = '-DNOW'
+    
+    if len(protocol) > 0:
+        root = "%s@%s:%s" % (user, server, base)
+        command = "cvs -d :%(protocol)s:%(root)s %(command)s -d %(where)s %(tag)s %(product)s" % \
+            { 'protocol': protocol, 'root': root, 'where': str(where.base()),
+              'tag': opttag, 'product': product, 'command': cmd }
+    else:
+        command = "cvs -d %(root)s %(command)s -d %(where)s %(tag)s %(base)s/%(product)s" % \
+            { 'root': server, 'base': base, 'where': str(where.base()),
+              'tag': opttag, 'product': product, 'command': cmd }
+
+    logger.write(command + "\n", 5)
+
+    if not where.dir().exists():
+        where.dir().make()
+
+    logger.logTxtFile.write("\n" + command + "\n")
+    logger.logTxtFile.flush()        
+    res = subprocess.call(command,
+                          cwd=str(where.dir()),
+                          env=environment.environ.environ,
+                          shell=True,
+                          stdout=logger.logTxtFile,
+                          stderr=subprocess.STDOUT)
+    return (res == 0)
+

+
[docs]def svn_extract(user,
+                from_what,
+                tag,
+                where,
+                logger,
+                checkout=False,
+                environment=None):
+    '''Extracts sources from a svn repository.
+    
+    :param user str: The user to be used.
+    :param from_what str: The remote git repository.
+    :param tag str: The tag.
+    :param where str: The path where to extract.
+    :param logger Logger: The logger instance to use.
+    :param checkout boolean: If true use checkout svn.
+    :param environment src.environment.Environ: The environment to source when
+                                                extracting.
+    :return: True if the extraction is successful
+    :rtype: boolean
+    '''
+    if not where.exists():
+        where.make()
+
+    if checkout:
+        command = "svn checkout --username %(user)s %(remote)s %(where)s" % \
+            { 'remote': from_what, 'user' : user, 'where': str(where) }
+    else:
+        command = ""
+        if os.path.exists(str(where)):
+            command = "/bin/rm -rf %(where)s && " % \
+                { 'remote': from_what, 'where': str(where) }
+        
+        if tag == "master":
+            command += "svn export --username %(user)s %(remote)s %(where)s" % \
+                { 'remote': from_what, 'user' : user, 'where': str(where) }       
+        else:
+            command += "svn export -r %(tag)s --username %(user)s %(remote)s %(where)s" % \
+                { 'tag' : tag, 'remote': from_what, 'user' : user, 'where': str(where) }
+    
+    logger.logTxtFile.write(command + "\n")
+    
+    logger.write(command + "\n", 5)
+    logger.logTxtFile.write("\n" + command + "\n")
+    logger.logTxtFile.flush()
+    res = subprocess.call(command,
+                          cwd=str(where.dir()),
+                          env=environment.environ.environ,
+                          shell=True,
+                          stdout=logger.logTxtFile,
+                          stderr=subprocess.STDOUT)
+    return (res == 0)

+
+ +
+
+
+
+
+
+

Related Topics

+ +
+ + +
+
+
+
+
+ ©2018, CEA. + + | + Powered by Sphinx 1.1.3 + & Alabaster + +
+ + + + + + \ No newline at end of file diff --git a/doc/build/html/_modules/src/template.html b/doc/build/html/_modules/src/template.html new file mode 100644 index 0000000..48ccb8e --- /dev/null +++ b/doc/build/html/_modules/src/template.html @@ -0,0 +1,123 @@ + + + + + + + + + src.template — salomeTools 5.0.0dev documentation + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+ +

Source code for src.template

+#!/usr/bin/env python
+#-*- coding:utf-8 -*-
+#  Copyright (C) 2010-2013  CEA/DEN
+#
+#  This library is free software; you can redistribute it and/or
+#  modify it under the terms of the GNU Lesser General Public
+#  License as published by the Free Software Foundation; either
+#  version 2.1 of the License.
+#
+#  This library is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#  Lesser General Public License for more details.
+#
+#  You should have received a copy of the GNU Lesser General Public
+#  License along with this library; if not, write to the Free Software
+#  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+
+import string
+
+
[docs]class MyTemplate(string.Template):
+    delimiter = '¤'
+

+
[docs]def substitute(template_file, subst_dic):
+    template = open(template_file, 'r')
+    template = MyTemplate(template.read())
+
+    return template.safe_substitute(subst_dic)
+
+ +
+
+
+
+
+
+

Related Topics

+ +
+ + +
+
+
+ +
+ ©2018, CEA. + + | + Powered by Sphinx 1.1.3 + & Alabaster + +
+ + + + + + \ No newline at end of file diff --git a/doc/build/html/_modules/src/test_module.html b/doc/build/html/_modules/src/test_module.html new file mode 100644 index 0000000..ea3f4f3 --- /dev/null +++ b/doc/build/html/_modules/src/test_module.html @@ -0,0 +1,995 @@ + + + + + + + + + src.test_module — salomeTools 5.0.0dev documentation + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+ +

Source code for src.test_module

+#!/usr/bin/env python
+#-*- coding:utf-8 -*-
+#  Copyright (C) 2010-2013  CEA/DEN
+#
+#  This library is free software; you can redistribute it and/or
+#  modify it under the terms of the GNU Lesser General Public
+#  License as published by the Free Software Foundation; either
+#  version 2.1 of the License.
+#
+#  This library is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#  Lesser General Public License for more details.
+#
+#  You should have received a copy of the GNU Lesser General Public
+#  License along with this library; if not, write to the Free Software
+#  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+
+# Python 2/3 compatibility for execfile function
+try:
+    execfile
+except:
+    def execfile(somefile, global_vars, local_vars):
+        with open(somefile) as f:
+            code = compile(f.read(), somefile, 'exec')
+            exec(code, global_vars, local_vars)
+
+
+import os
+import sys
+import datetime
+import shutil
+import string
+import imp
+import subprocess
+
+from . import fork
+import src
+
+# directories not considered as test grids
+C_IGNORE_GRIDS = ['.git', '.svn', 'RESSOURCES']
+
+DEFAULT_TIMEOUT = 150
+
+# Get directory to be used for the temporary files.
+#
+
[docs]def getTmpDirDEFAULT():
+    if src.architecture.is_windows():
+        directory = os.getenv("TEMP")
+    else:
+        # for Linux: use /tmp/logs/{user} folder
+        directory = os.path.join( '/tmp', 'logs', os.getenv("USER", "unknown"))
+    return directory
+

+
[docs]class Test:
+    def __init__(self,
+                 config,
+                 logger,
+                 tmp_working_dir,
+                 testbase="",
+                 grids=None,
+                 sessions=None,
+                 launcher="",
+                 show_desktop=True):
+        self.grids = grids
+        self.config = config
+        self.logger = logger
+        self.tmp_working_dir = tmp_working_dir
+        self.sessions = sessions
+        self.launcher = launcher
+        self.show_desktop = show_desktop
+
+        res = self.prepare_testbase(testbase)
+        self.test_base_found = True
+        if res == 1:
+            # Fail
+            self.test_base_found = False
+        
+        self.settings = {}
+        self.known_errors = None
+
+        # create section for results
+        self.config.TESTS = src.pyconf.Sequence(self.config)
+
+        self.nb_run = 0
+        self.nb_succeed = 0
+        self.nb_timeout = 0
+        self.nb_not_run = 0
+        self.nb_acknoledge = 0
+
+    def _copy_dir(self, source, target):
+        if self.config.VARS.python >= "2.6":
+            shutil.copytree(source, target,
+                            symlinks=True,
+                            ignore=shutil.ignore_patterns('.git*','.svn*'))
+        else:
+            shutil.copytree(source, target,
+                            symlinks=True)
+
+
[docs]    def prepare_testbase_from_dir(self, testbase_name, testbase_dir):
+        self.logger.write(_("get test base from dir: %s\n") % \
+                          src.printcolors.printcLabel(testbase_dir), 3)
+        if not os.access(testbase_dir, os.X_OK):
+            raise src.SatException(_("testbase %(name)s (%(dir)s) does not "
+                                     "exist ...\n") % { 'name': testbase_name,
+                                                       'dir': testbase_dir })
+
+        self._copy_dir(testbase_dir,
+                       os.path.join(self.tmp_working_dir, 'BASES', testbase_name))
+

+
[docs]    def prepare_testbase_from_git(self,
+                                  testbase_name,
+                                  testbase_base,
+                                  testbase_tag):
+        self.logger.write(
+            _("get test base '%(testbase)s' with '%(tag)s' tag from git\n") % {
+                        "testbase" : src.printcolors.printcLabel(testbase_name),
+                        "tag" : src.printcolors.printcLabel(testbase_tag)},
+                          3)
+        try:
+            def set_signal(): # pragma: no cover
+                """see http://bugs.python.org/issue1652"""
+                import signal
+                signal.signal(signal.SIGPIPE, signal.SIG_DFL)
+
+            cmd = "git clone --depth 1 %(base)s %(dir)s"
+            cmd += " && cd %(dir)s"
+            if testbase_tag=='master':
+                cmd += " && git fetch origin %(branch)s"
+            else:
+                cmd += " && git fetch origin %(branch)s:%(branch)s"
+            cmd += " && git checkout %(branch)s"
+            cmd = cmd % { 'branch': testbase_tag,
+                         'base': testbase_base,
+                         'dir': testbase_name }
+
+            self.logger.write("> %s\n" % cmd, 5)
+            if src.architecture.is_windows():
+                # preexec_fn not supported on windows platform
+                res = subprocess.call(cmd,
+                                cwd=os.path.join(self.tmp_working_dir, 'BASES'),
+                                shell=True,
+                                stdout=self.logger.logTxtFile,
+                                stderr=subprocess.PIPE)
+            else:
+                res = subprocess.call(cmd,
+                                cwd=os.path.join(self.tmp_working_dir, 'BASES'),
+                                shell=True,
+                                preexec_fn=set_signal,
+                                stdout=self.logger.logTxtFile,
+                                stderr=subprocess.PIPE)
+            if res != 0:
+                raise src.SatException(_("Error: unable to get test base "
+                                         "'%(name)s' from git '%(repo)s'.") % \
+                                       { 'name': testbase_name,
+                                        'repo': testbase_base })
+
+        except OSError:
+            self.logger.error(_("git is not installed. exiting...\n"))
+            sys.exit(0)
+

+
[docs]    def prepare_testbase_from_svn(self, user, testbase_name, testbase_base):
+        self.logger.write(_("get test base '%s' from svn\n") % \
+                          src.printcolors.printcLabel(testbase_name), 3)
+        try:
+            def set_signal(): # pragma: no cover
+                """see http://bugs.python.org/issue1652"""
+                import signal
+                signal.signal(signal.SIGPIPE, signal.SIG_DFL)
+
+            cmd = "svn checkout --username %(user)s %(base)s %(dir)s"
+            cmd = cmd % { 'user': user,
+                         'base': testbase_base,
+                         'dir': testbase_name }
+            
+            # Get the application environment
+            self.logger.write(_("Set the application environment\n"), 5)
+            env_appli = src.environment.SalomeEnviron(self.config,
+                                      src.environment.Environ(dict(os.environ)))
+            env_appli.set_application_env(self.logger)
+            
+            self.logger.write("> %s\n" % cmd, 5)
+            if src.architecture.is_windows():
+                # preexec_fn not supported on windows platform
+                res = subprocess.call(cmd,
+                                cwd=os.path.join(self.tmp_working_dir, 'BASES'),
+                                shell=True,
+                                stdout=self.logger.logTxtFile,
+                                stderr=subprocess.PIPE)
+            else:
+                res = subprocess.call(cmd,
+                                cwd=os.path.join(self.tmp_working_dir, 'BASES'),
+                                shell=True,
+                                preexec_fn=set_signal,
+                                stdout=self.logger.logTxtFile,
+                                stderr=subprocess.PIPE,
+                                env=env_appli.environ.environ,)
+
+            if res != 0:
+                raise src.SatException(_("Error: unable to get test base '%(nam"
+                                         "e)s' from svn '%(repo)s'.") % \
+                                       { 'name': testbase_name,
+                                        'repo': testbase_base })
+
+        except OSError:
+            self.logger.error(_("svn is not installed. exiting...\n"))
+            sys.exit(0)
+
+    ##
+    # Configure tests base.

+
[docs]    def prepare_testbase(self, test_base_name):
+        src.printcolors.print_value(self.logger,
+                                    _("Test base"),
+                                    test_base_name,
+                                    3)
+        self.logger.write("\n", 3, False)
+
+        # search for the test base
+        test_base_info = None
+        for project_name in self.config.PROJECTS.projects:
+            project_info = self.config.PROJECTS.projects[project_name]
+            if "test_bases" not in project_info:
+                continue
+            for t_b_info in project_info.test_bases:
+                if t_b_info.name == test_base_name:
+                    test_base_info = t_b_info
+        
+        if not test_base_info:
+            if os.path.exists(test_base_name):
+                self.prepare_testbase_from_dir("DIR", test_base_name)
+                self.currentTestBase = "DIR"
+                return 0
+        
+        if not test_base_info:
+            message = (_("########## ERROR: test base '%s' not found\n") % 
+                       test_base_name)
+            self.logger.write("%s\n" % src.printcolors.printcError(message))
+            return 1
+
+        if test_base_info.get_sources == "dir":
+            self.prepare_testbase_from_dir(test_base_name,
+                                           test_base_info.info.dir)
+        elif test_base_info.get_sources == "git":
+            self.prepare_testbase_from_git(test_base_name,
+                                       test_base_info.info.base,
+                                       self.config.APPLICATION.test_base.tag)
+        elif test_base_info.get_sources == "svn":
+            svn_user = src.get_cfg_param(test_base_info.info,
+                                         "svn_user",
+                                         self.config.USER.svn_user)
+            self.prepare_testbase_from_svn(svn_user,
+                                       test_base_name,
+                                       test_base_info.info.base)
+        else:
+            raise src.SatException(_("unknown source type '%(type)s' for test b"
+                                     "ase '%(base)s' ...\n") % {
+                                        'type': test_base_info.get_sources,
+                                        'base': test_base_name })
+
+        self.currentTestBase = test_base_name
+
+    ##
+    # Searches if the script is declared in known errors pyconf.
+    # Update the status if needed.

+
[docs]    def search_known_errors(self, status, test_grid, test_session, test):
+        test_path = os.path.join(test_grid, test_session, test)
+        if not src.config_has_application(self.config):
+            return status, []
+
+        if self.known_errors is None:
+            return status, []
+
+        platform = self.config.VARS.arch
+        application = self.config.VARS.application
+        error = self.known_errors.get_error(test_path, application, platform)
+        if error is None:
+            return status, []
+        
+        if status == src.OK_STATUS:
+            if not error.fixed:
+                # the error is fixed
+                self.known_errors.fix_error(error)
+                #import testerror
+                #testerror.write_test_failures(
+                #                        self.config.TOOLS.testerror.file_path,
+                #                        self.known_errors.errors)
+            return status, [ error.date,
+                            error.expected,
+                            error.comment,
+                            error.fixed ]
+
+        if error.fixed:
+            self.known_errors.unfix_error(error)
+            #import testerror
+            #testerror.write_test_failures(self.config.TOOLS.testerror.file_path,
+            #                              self.known_errors.errors)
+
+        delta = self.known_errors.get_expecting_days(error)
+        kfres = [ error.date, error.expected, error.comment, error.fixed ]
+        if delta < 0:
+            return src.KO_STATUS, kfres
+        return src.KNOWNFAILURE_STATUS, kfres
+
+    ##
+    # Read the *.result.py files.

+
[docs]    def read_results(self, listTest, has_timed_out):
+        results = {}
+        for test in listTest:
+            resfile = os.path.join(self.currentDir,
+                                   self.currentgrid,
+                                   self.currentsession,
+                                   test[:-3] + ".result.py")
+
+            # check if <test>.result.py file exists
+            if not os.path.exists(resfile):
+                results[test] = ["?", -1, "", []]
+            else:
+                gdic, ldic = {}, {}
+                execfile(resfile, gdic, ldic)
+
+                status = src.TIMEOUT_STATUS
+                if not has_timed_out:
+                    status = src.KO_STATUS
+
+                if ldic.has_key('status'):
+                    status = ldic['status']
+
+                expected = []
+                if status == src.KO_STATUS or status == src.OK_STATUS:
+                    status, expected = self.search_known_errors(status,
+                                                            self.currentgrid,
+                                                            self.currentsession,
+                                                            test)
+
+                callback = ""
+                if ldic.has_key('callback'):
+                    callback = ldic['callback']
+                elif status == src.KO_STATUS:
+                    callback = "CRASH"
+
+                exec_time = -1
+                if ldic.has_key('time'):
+                    try:
+                        exec_time = float(ldic['time'])
+                    except:
+                        pass
+
+                results[test] = [status, exec_time, callback, expected]
+            
+            # check if <test>.py file exists
+            testfile = os.path.join(self.currentDir,
+                                   self.currentgrid,
+                                   self.currentsession,
+                                   test)
+            
+            if not os.path.exists(testfile):
+                results[test].append('')
+            else:
+                text = open(testfile, "r").read()
+                results[test].append(text)
+
+            # check if <test>.out.py file exists
+            outfile = os.path.join(self.currentDir,
+                                   self.currentgrid,
+                                   self.currentsession,
+                                   test[:-3] + ".out.py")
+            
+            if not os.path.exists(outfile):
+                results[test].append('')
+            else:
+                text = open(outfile, "r").read()
+                results[test].append(text)
+
+        return results
+
+    ##
+    # Generates the script to be run by Salome.
+    # This python script includes init and close statements and a loop
+    # calling all the scripts of a single directory.

+
[docs]    def generate_script(self, listTest, script_path, ignoreList):
+        # open template file
+        template_file = open(os.path.join(self.config.VARS.srcDir,
+                                          "test",
+                                          "scriptTemplate.py"), 'r')
+        template = string.Template(template_file.read())
+        
+        # create substitution dictionary
+        d = dict()
+        d['resourcesWay'] = os.path.join(self.currentDir, 'RESSOURCES')
+        d['tmpDir'] = os.path.join(self.tmp_working_dir, 'WORK')
+        d['toolsWay'] = os.path.join(self.config.VARS.srcDir, "test")
+        d['sessionDir'] = os.path.join(self.currentDir,
+                                    self.currentgrid,
+                                    self.currentsession)
+        d['resultFile'] = os.path.join(self.tmp_working_dir,
+                                       'WORK',
+                                       'exec_result')
+        d['listTest'] = listTest
+        d['sessionName'] = self.currentsession
+        d['ignore'] = ignoreList
+
+        # create script with template
+        script = open(script_path, 'w')
+        script.write(template.safe_substitute(d))
+        script.close()
+
+    # Find the getTmpDir function that gives access to *pidict file directory.
+    # (the *pidict file exists when SALOME is launched) 

+
[docs]    def get_tmp_dir(self):
+        # Rare case where there is no KERNEL in grid list 
+        # (for example MED_STANDALONE)
+        if ('APPLICATION' in self.config 
+                and 'KERNEL' not in self.config.APPLICATION.products 
+                and 'KERNEL_ROOT_DIR' not in os.environ):
+            return getTmpDirDEFAULT
+        
+        # Case where "sat test" is launched in an existing SALOME environment
+        if 'KERNEL_ROOT_DIR' in os.environ:
+            root_dir =  os.environ['KERNEL_ROOT_DIR']
+        
+        if ('APPLICATION' in self.config 
+                and 'KERNEL' in self.config.APPLICATION.products):
+            root_dir = src.product.get_product_config(self.config,
+                                                      "KERNEL").install_dir
+
+        # Case where there the appli option is called (with path to launcher)
+        if len(self.launcher) > 0:
+            # There are two cases : The old application (runAppli) 
+            # and the new one
+            launcherName = os.path.basename(self.launcher)
+            launcherDir = os.path.dirname(self.launcher)
+            if launcherName == 'runAppli':
+                # Old application
+                cmd = ("for i in " + launcherDir + "/env.d/*.sh; do source ${i};"
+                       " done ; echo $KERNEL_ROOT_DIR")
+            else:
+                # New application
+                cmd = ("echo -e 'import os\nprint os.environ[\"KERNEL_" + 
+                       "ROOT_DIR\"]' > tmpscript.py; %s shell" + 
+                       " tmpscript.py") % self.launcher
+
+            # OP 14/11/2017 Ajout de traces pour essayer de decouvrir le pb
+            #               de remontee de log des tests
+            #root_dir = subprocess.Popen(cmd,
+            #                stdout=subprocess.PIPE,
+            #                shell=True,
+            #                executable='/bin/bash').communicate()[0].split()[-1]
+            subproc_res = subprocess.Popen(cmd,
+                            stdout=subprocess.PIPE,
+                            shell=True,
+                            executable='/bin/bash').communicate()
+            #print "TRACES OP - test_module.py/Test.get_tmp_dir() subproc_res = "
+            for resLine in subproc_res:
+                print "- '#%s#'" %resLine
+            
+            root_dir = subproc_res[0].split()[-1]
+
+        # OP 14/11/2017 Ajout de traces pour essayer de decouvrir le pb
+        #               de remontee de log des tests
+        #print "TRACES OP - test_module.py/Test.get_tmp_dir() root_dir = '#%s#'" %root_dir
+        
+        # import grid salome_utils from KERNEL that gives 
+        # the right getTmpDir function
+        (file_, pathname, description) = imp.find_module("salome_utils",
+                                                         [os.path.join(root_dir,
+                                                                    'bin',
+                                                                    'salome')])
+        try:
+            grid = imp.load_module("salome_utils",
+                                     file_,
+                                     pathname,
+                                     description)
+            return grid.getLogDir
+        except:
+            grid = imp.load_module("salome_utils",
+                                     file_,
+                                     pathname,
+                                     description)
+            return grid.getTmpDir
+        finally:
+            if file_:
+                file_.close()
+
+

+
[docs]    def get_test_timeout(self, test_name, default_value):
+        if ("timeout" in self.settings and 
+                test_name in self.settings["timeout"]):
+            return self.settings["timeout"][test_name]
+
+        return default_value
+

+
[docs]    def generate_launching_commands(self):
+        # Case where "sat test" is launched in an existing SALOME environment
+        if 'KERNEL_ROOT_DIR' in os.environ:
+            binSalome = "runSalome"
+            binPython = "python"
+            killSalome = "killSalome.py"
+        
+        # Rare case where there is no KERNEL in grid list 
+        # (for example MED_STANDALONE)
+        if ('APPLICATION' in self.config and 
+                'KERNEL' not in self.config.APPLICATION.products):
+            binSalome = "runSalome"
+            binPython = "python" 
+            killSalome = "killSalome.py"   
+            src.environment.load_environment(self.config, False, self.logger)         
+            return binSalome, binPython, killSalome
+        
+        # Case where there the appli option is called (with path to launcher)
+        if len(self.launcher) > 0:
+            # There are two cases : The old application (runAppli) 
+            # and the new one
+            launcherName = os.path.basename(self.launcher)
+            launcherDir = os.path.dirname(self.launcher)
+            if launcherName == 'runAppli':
+                # Old application
+                binSalome = self.launcher
+                binPython = ("for i in " +
+                             launcherDir +
+                             "/env.d/*.sh; do source ${i}; done ; python")
+                killSalome = ("for i in " +
+                        launcherDir +
+                        "/env.d/*.sh; do source ${i}; done ; killSalome.py'")
+                return binSalome, binPython, killSalome
+            else:
+                # New application
+                binSalome = self.launcher
+                binPython = self.launcher + ' shell'
+                killSalome = self.launcher + ' killall'
+                return binSalome, binPython, killSalome
+
+        # SALOME version detection and APPLI repository detection
+        VersionSalome = src.get_salome_version(self.config)
+        appdir = 'APPLI'
+        if "APPLI" in self.config and "application_name" in self.config.APPLI:
+            appdir = self.config.APPLI.application_name
+        
+        # Case where SALOME has NOT the launcher that uses the SalomeContext API
+        if VersionSalome < 730:
+            binSalome = os.path.join(self.config.APPLICATION.workdir,
+                                     appdir,
+                                     "runAppli")
+            binPython = "python"
+            killSalome = "killSalome.py"
+            src.environment.load_environment(self.config, False, self.logger)           
+            return binSalome, binPython, killSalome
+        
+        # Case where SALOME has the launcher that uses the SalomeContext API
+        else:            
+            launcher_name = src.get_launcher_name(self.config)
+            binSalome = os.path.join(self.config.APPLICATION.workdir,
+                                     launcher_name)
+            
+            binPython = binSalome + ' shell'
+            killSalome = binSalome + ' killall'
+            return binSalome, binPython, killSalome
+                
+        return binSalome, binPython, killSalome
+        
+
+    ##
+    # Runs tests of a session (using a single instance of Salome).

+
[docs]    def run_tests(self, listTest, ignoreList):
+        out_path = os.path.join(self.currentDir,
+                                self.currentgrid,
+                                self.currentsession)
+        sessionname = "%s/%s" % (self.currentgrid, self.currentsession)
+        time_out = self.get_test_timeout(sessionname,
+                                         DEFAULT_TIMEOUT)
+
+        time_out_salome = DEFAULT_TIMEOUT
+
+        # generate wrapper script
+        script_path = os.path.join(out_path, 'wrapperScript.py')
+        self.generate_script(listTest, script_path, ignoreList)
+
+        tmpDir = self.get_tmp_dir()
+
+        binSalome, binPython, killSalome = self.generate_launching_commands()
+        if self.settings.has_key("run_with_grids") \
+           and self.settings["run_with_grids"].has_key(sessionname):
+            binSalome = (binSalome +
+                         " -m %s" % self.settings["run_with_grids"][sessionname])
+
+        logWay = os.path.join(self.tmp_working_dir, "WORK", "log_cxx")
+
+        status = False
+        elapsed = -1
+        if self.currentsession.startswith("NOGUI_"):
+            # runSalome -t (bash)
+            status, elapsed = fork.batch(binSalome, self.logger,
+                                        os.path.join(self.tmp_working_dir,
+                                                     "WORK"),
+                                        [ "-t",
+                                         "--shutdown-server=1",
+                                         script_path ],
+                                        delai=time_out,
+                                        log=logWay)
+
+        elif self.currentsession.startswith("PY_"):
+            # python script.py
+            status, elapsed = fork.batch(binPython, self.logger,
+                                          os.path.join(self.tmp_working_dir,
+                                                       "WORK"),
+                                          [script_path],
+                                          delai=time_out, log=logWay)
+
+        else:
+            opt = "-z 0"
+            if self.show_desktop: opt = "--show-desktop=0"
+            status, elapsed = fork.batch_salome(binSalome,
+                                                 self.logger,
+                                                 os.path.join(
+                                                        self.tmp_working_dir,
+                                                        "WORK"),
+                                                 [ opt,
+                                                  "--shutdown-server=1",
+                                                  script_path ],
+                                                 getTmpDir=tmpDir,
+                                                 fin=killSalome,
+                                                 delai=time_out,
+                                                 log=logWay,
+                                                 delaiapp=time_out_salome)
+
+        self.logger.write("status = %s, elapsed = %s\n" % (status, elapsed),
+                          5)
+
+        # create the test result to add in the config object
+        test_info = src.pyconf.Mapping(self.config)
+        test_info.testbase = self.currentTestBase
+        test_info.grid = self.currentgrid
+        test_info.session = self.currentsession
+        test_info.script = src.pyconf.Sequence(self.config)
+
+        script_results = self.read_results(listTest, elapsed == time_out)
+        for sr in sorted(script_results.keys()):
+            self.nb_run += 1
+
+            # create script result
+            script_info = src.pyconf.Mapping(self.config)
+            script_info.name = sr
+            script_info.res = script_results[sr][0]
+            script_info.time = script_results[sr][1]
+            if script_info.res == src.TIMEOUT_STATUS:
+                script_info.time = time_out
+            if script_info.time < 1e-3: script_info.time = 0
+
+            callback = script_results[sr][2]
+            if script_info.res != src.OK_STATUS and len(callback) > 0:
+                script_info.callback = callback
+
+            kfres = script_results[sr][3]
+            if len(kfres) > 0:
+                script_info.known_error = src.pyconf.Mapping(self.config)
+                script_info.known_error.date = kfres[0]
+                script_info.known_error.expected = kfres[1]
+                script_info.known_error.comment = kfres[2]
+                script_info.known_error.fixed = kfres[3]
+            
+            script_info.content = script_results[sr][4]
+            script_info.out = script_results[sr][5]
+            
+            # add it to the list of results
+            test_info.script.append(script_info, '')
+
+            # display the results
+            if script_info.time > 0:
+                exectime = "(%7.3f s)" % script_info.time
+            else:
+                exectime = ""
+
+            sp = "." * (35 - len(script_info.name))
+            self.logger.write(self.write_test_margin(3), 3)
+            self.logger.write("script %s %s %s %s\n" % (
+                                src.printcolors.printcLabel(script_info.name),
+                                sp,
+                                src.printcolors.printc(script_info.res),
+                                exectime), 3, False)
+            if script_info and len(callback) > 0:
+                self.logger.write("Exception in %s\n%s\n" % \
+                    (script_info.name,
+                     src.printcolors.printcWarning(callback)), 2, False)
+
+            if script_info.res == src.OK_STATUS:
+                self.nb_succeed += 1
+            elif script_info.res == src.KNOWNFAILURE_STATUS:
+                self.nb_acknoledge += 1
+            elif script_info.res == src.TIMEOUT_STATUS:
+                self.nb_timeout += 1
+            elif script_info.res == src.NA_STATUS:
+                self.nb_run -= 1
+            elif script_info.res == "?":
+                self.nb_not_run += 1
+
+        self.config.TESTS.append(test_info, '')
+
+    ##
+    # Runs all tests of a session.

+
[docs]    def run_session_tests(self):
+       
+        self.logger.write(self.write_test_margin(2), 3)
+        self.logger.write("Session = %s\n" % src.printcolors.printcLabel(
+                                                    self.currentsession), 3, False)
+
+        # prepare list of tests to run
+        tests = os.listdir(os.path.join(self.currentDir,
+                                        self.currentgrid,
+                                        self.currentsession))
+        tests = filter(lambda l: l.endswith(".py"), tests)
+        tests = sorted(tests, key=str.lower)
+
+        # build list of known failures
+        cat = "%s/%s/" % (self.currentgrid, self.currentsession)
+        ignoreDict = {}
+        for k in self.ignore_tests.keys():
+            if k.startswith(cat):
+                ignoreDict[k[len(cat):]] = self.ignore_tests[k]
+
+        self.run_tests(tests, ignoreDict)
+
+    ##
+    # Runs all tests of a grid.

+
[docs]    def run_grid_tests(self):
+        self.logger.write(self.write_test_margin(1), 3)
+        self.logger.write("grid = %s\n" % src.printcolors.printcLabel(
+                                                self.currentgrid), 3, False)
+
+        grid_path = os.path.join(self.currentDir, self.currentgrid)
+
+        sessions = []
+        if self.sessions is not None:
+            sessions = self.sessions # user choice
+        else:
+            # use all scripts in grid
+            sessions = filter(lambda l: l not in C_IGNORE_GRIDS,
+                           os.listdir(grid_path))
+            sessions = filter(lambda l: os.path.isdir(os.path.join(grid_path,
+                                                                l)), sessions)
+
+        sessions = sorted(sessions, key=str.lower)
+        for session_ in sessions:
+            if not os.path.exists(os.path.join(grid_path, session_)):
+                self.logger.write(self.write_test_margin(2), 3)
+                self.logger.write(src.printcolors.printcWarning("Session %s not"
+                                        " found" % session_) + "\n", 3, False)
+            else:
+                self.currentsession = session_
+                self.run_session_tests()
+
+    ##
+    # Runs test testbase.

+
[docs]    def run_testbase_tests(self):
+        res_dir = os.path.join(self.currentDir, "RESSOURCES")
+        os.environ['PYTHONPATH'] =  (res_dir + 
+                                     os.pathsep + 
+                                     os.environ['PYTHONPATH'])
+        os.environ['TT_BASE_RESSOURCES'] = res_dir
+        src.printcolors.print_value(self.logger,
+                                    "TT_BASE_RESSOURCES",
+                                    res_dir,
+                                    4)
+        self.logger.write("\n", 4, False)
+
+        self.logger.write(self.write_test_margin(0), 3)
+        testbase_label = "Test base = %s\n" % src.printcolors.printcLabel(
+                                                        self.currentTestBase)
+        self.logger.write(testbase_label, 3, False)
+        self.logger.write("-" * len(src.printcolors.cleancolor(testbase_label)),
+                          3)
+        self.logger.write("\n", 3, False)
+
+        # load settings
+        settings_file = os.path.join(res_dir, "test_settings.py")
+        if os.path.exists(settings_file):
+            gdic, ldic = {}, {}
+            execfile(settings_file, gdic, ldic)
+            self.logger.write(_("Load test settings\n"), 3)
+            self.settings = ldic['settings_dic']
+            self.ignore_tests = ldic['known_failures_list']
+            if isinstance(self.ignore_tests, list):
+                self.ignore_tests = {}
+                self.logger.write(src.printcolors.printcWarning("known_failur"
+                  "es_list must be a dictionary (not a list)") + "\n", 1, False)
+        else:
+            self.ignore_tests = {}
+            self.settings.clear()
+
+        # read known failures pyconf
+        if "testerror" in self.config.LOCAL:
+            #import testerror
+            #self.known_errors = testerror.read_test_failures(
+            #                            self.config.TOOLS.testerror.file_path,
+            #                            do_error=False)
+            pass
+        else:
+            self.known_errors = None
+
+        if self.grids is not None:
+            grids = self.grids # given by user
+        else:
+            # select all the grids (i.e. directories) in the directory
+            grids = filter(lambda l: l not in C_IGNORE_GRIDS,
+                             os.listdir(self.currentDir))
+            grids = filter(lambda l: os.path.isdir(
+                                        os.path.join(self.currentDir, l)),
+                             grids)
+
+        grids = sorted(grids, key=str.lower)
+        for grid in grids:
+            if not os.path.exists(os.path.join(self.currentDir, grid)):
+                self.logger.write(self.write_test_margin(1), 3)
+                self.logger.write(src.printcolors.printcWarning(
+                            "grid %s does not exist\n" % grid), 3, False)
+            else:
+                self.currentgrid = grid
+                self.run_grid_tests()
+

+
[docs]    def run_script(self, script_name):
+        if ('APPLICATION' in self.config and 
+                script_name in self.config.APPLICATION):
+            script = self.config.APPLICATION[script_name]
+            if len(script) == 0:
+                return
+
+            self.logger.write("\n", 2, False)
+            if not os.path.exists(script):
+                self.logger.write(src.printcolors.printcWarning("WARNING: scrip"
+                                        "t not found: %s" % script) + "\n", 2)
+            else:
+                self.logger.write(src.printcolors.printcHeader("----------- sta"
+                                            "rt %s" % script_name) + "\n", 2)
+                self.logger.write("Run script: %s\n" % script, 2)
+                subprocess.Popen(script, shell=True).wait()
+                self.logger.write(src.printcolors.printcHeader("----------- end"
+                                                " %s" % script_name) + "\n", 2)
+

+
[docs]    def run_all_tests(self):
+        initTime = datetime.datetime.now()
+
+        self.run_script('test_setup')
+        self.logger.write("\n", 2, False)
+
+        self.logger.write(src.printcolors.printcHeader(
+                                            _("=== STARTING TESTS")) + "\n", 2)
+        self.logger.write("\n", 2, False)
+        self.currentDir = os.path.join(self.tmp_working_dir,
+                                       'BASES',
+                                       self.currentTestBase)
+        self.run_testbase_tests()
+
+        # calculate total execution time
+        totalTime = datetime.datetime.now() - initTime
+        totalTime -= datetime.timedelta(microseconds=totalTime.microseconds)
+        self.logger.write("\n", 2, False)
+        self.logger.write(src.printcolors.printcHeader(_("=== END TESTS")), 2)
+        self.logger.write(" %s\n" % src.printcolors.printcInfo(str(totalTime)),
+                          2,
+                          False)
+
+        #
+        # Start the tests
+        #
+        self.run_script('test_cleanup')
+        self.logger.write("\n", 2, False)
+
+        # evaluate results
+        res_count = "%d / %d" % (self.nb_succeed,
+                                 self.nb_run - self.nb_acknoledge)
+
+        res_out = _("Tests Results: %(succeed)d / %(total)d\n") % \
+            { 'succeed': self.nb_succeed, 'total': self.nb_run }
+        if self.nb_succeed == self.nb_run:
+            res_out = src.printcolors.printcSuccess(res_out)
+        else:
+            res_out = src.printcolors.printcError(res_out)
+        self.logger.write(res_out, 1)
+
+        if self.nb_timeout > 0:
+            self.logger.write(_("%d tests TIMEOUT\n") % self.nb_timeout, 1)
+            res_count += " TO: %d" % self.nb_timeout
+        if self.nb_not_run > 0:
+            self.logger.write(_("%d tests not executed\n") % self.nb_not_run, 1)
+            res_count += " NR: %d" % self.nb_not_run
+
+        status = src.OK_STATUS
+        if self.nb_run - self.nb_succeed - self.nb_acknoledge > 0:
+            status = src.KO_STATUS
+        elif self.nb_acknoledge:
+            status = src.KNOWNFAILURE_STATUS
+        
+        self.logger.write(_("Status: %s\n" % status), 3)
+
+        return self.nb_run - self.nb_succeed - self.nb_acknoledge
+
+    ##
+    # Write margin to show test results.

+
[docs]    def write_test_margin(self, tab):
+        if tab == 0:
+            return ""
+        return "|   " * (tab - 1) + "+ "
+
+ +
+
+ +
+
+
+

Related Topics

+ +
+ + +
+
+
+ +
+ ©2018, CEA. + + | + Powered by Sphinx 1.1.3 + & Alabaster + +
+ + + + + + \ No newline at end of file diff --git a/doc/build/html/_modules/src/xmlManager.html b/doc/build/html/_modules/src/xmlManager.html new file mode 100644 index 0000000..1656e12 --- /dev/null +++ b/doc/build/html/_modules/src/xmlManager.html @@ -0,0 +1,307 @@ + + + + + + + + + src.xmlManager — salomeTools 5.0.0dev documentation + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+ +

Source code for src.xmlManager

+#!/usr/bin/env python
+#-*- coding:utf-8 -*-
+#  Copyright (C) 2010-2013  CEA/DEN
+#
+#  This library is free software; you can redistribute it and/or
+#  modify it under the terms of the GNU Lesser General Public
+#  License as published by the Free Software Foundation; either
+#  version 2.1 of the License.
+#
+#  This library is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#  Lesser General Public License for more details.
+#
+#  You should have received a copy of the GNU Lesser General Public
+#  License along with this library; if not, write to the Free Software
+#  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+
+import os
+try: # For python2
+    import sys
+    reload(sys)  
+    sys.setdefaultencoding('utf8')
+except:
+    pass
+
+import src
+from . import ElementTree as etree
+
+
[docs]class XmlLogFile(object):
+    '''Class to manage writing in salomeTools xml log file
+    '''
+    def __init__(self, filePath, rootname, attrib = {}):
+        '''Initialization
+        
+        :param filePath str: The path to the file where to write the log file
+        :param rootname str: The name of the root node of the xml file
+        :param attrib dict: the dictionary that contains the attributes 
+                            and value of the root node
+        '''
+        # Initialize the filePath and ensure that the directory 
+        # that contain the file exists (make it if necessary)
+        self.logFile = filePath
+        src.ensure_path_exists(os.path.dirname(filePath))
+        # Initialize the field that contain the xml in memory
+        self.xmlroot = etree.Element(rootname, attrib = attrib)
+    
+
[docs]    def write_tree(self, stylesheet=None, file_path = None):
+        '''Write the xml tree in the log file path. Add the stylesheet if asked.
+        
+        :param stylesheet str: The stylesheet to apply to the xml file
+        '''
+        log_file_path = self.logFile
+        if file_path:
+            log_file_path = file_path
+        try:
+            f = open(log_file_path, 'w')
+            f.write("<?xml version='1.0' encoding='utf-8'?>\n")
+            if stylesheet:
+                f.write("<?xml-stylesheet type='text/xsl' href='%s'?>\n" % 
+                        stylesheet)    
+            f.write(etree.tostring(self.xmlroot, encoding='utf-8'))
+            f.close()
+        except IOError:
+            pass  
+        

+
[docs]    def add_simple_node(self, node_name, text=None, attrib={}):
+        '''Add a node with some attibutes and text to the root node.
+        
+        :param node_name str: the name of the node to add
+        :param text str: the text of the node
+        :param attrib dict: the dictionary containing the 
+                            attribute of the new node
+        '''
+        n = etree.Element(node_name, attrib=attrib)
+        n.text = text
+        self.xmlroot.append(n)
+        return n
+    

+
[docs]    def append_node_text(self, node_name, text):
+        '''Append a new text to the node that has node_name as name
+        
+        :param node_name str: The name of the node on which append text
+        :param text str: The text to append
+        '''
+        # find the corresponding node
+        for field in self.xmlroot:
+            if field.tag == node_name:
+                # append the text
+                field.text += text
+

+
[docs]    def append_node_attrib(self, node_name, attrib):
+        '''Append a new attributes to the node that has node_name as name
+        
+        :param node_name str: The name of the node on which append text
+        :param attrib dixt: The attrib to append
+        '''
+        self.xmlroot.find(node_name).attrib.update(attrib)
+

+
[docs]class ReadXmlFile(object):
+    '''Class to manage reading of an xml log file
+    '''
+    def __init__(self, filePath):
+        '''Initialization
+        
+        :param filePath str: The xml file to be read
+        '''
+        self.filePath = filePath
+        etree_inst = etree.parse(filePath)
+        self.xmlroot = etree_inst.parse(filePath)
+
+
[docs]    def getRootAttrib(self):
+        '''Get the attibutes of the self.xmlroot
+        
+        :return: The attributes of the root node
+        :rtype: dict
+        '''
+        return self.xmlroot.attrib
+    

+
[docs]    def get_attrib(self, node_name):
+        '''Get the attibutes of the node node_name in self.xmlroot
+        
+        :param node_name str: the name of the node
+        :return: the attibutes of the node node_name in self.xmlroot
+        :rtype: dict
+        '''
+        attrib = self.xmlroot.find(node_name).attrib
+        # To be python 3 compatible, convert bytes to str if there are any
+        fixedAttrib = {}
+        for k in attrib.keys():
+            if isinstance(k, bytes):
+                key = k.decode()
+            else:
+                key = k
+            if isinstance(attrib[k], bytes):
+                value = attrib[k].decode()
+            else:
+                value = attrib[k]
+            fixedAttrib[key] = value
+        return fixedAttrib
+    

+
[docs]    def get_node_text(self, node):
+        '''Get the text of the first node that has name 
+           that corresponds to the parameter node
+        
+        :param node str: the name of the node from which get the text
+        :return: the text of the first node that has name 
+                 that corresponds to the parameter node
+        :rtype: str
+        '''
+        return self.xmlroot.find(node).text
+    

+
[docs]def add_simple_node(root_node, node_name, text=None, attrib={}):
+    '''Add a node with some attibutes and text to the root node.
+
+    :param root_node etree.Element: the Etree element where to add the new node    
+    :param node_name str: the name of the node to add
+    :param text str: the text of the node
+    :param attrib dict: the dictionary containing the 
+                        attribute of the new node
+    '''
+    n = etree.Element(node_name, attrib=attrib)
+    n.text = text
+    root_node.append(n)
+    return n
+

+
[docs]def append_node_attrib(root_node, attrib):
+    '''Append a new attributes to the node that has node_name as name
+    
+    :param root_node etree.Element: the Etree element 
+                                    where to append the new attibutes
+    :param attrib dixt: The attrib to append
+    '''
+    root_node.attrib.update(attrib)
+

+
[docs]def find_node_by_attrib(xmlroot, name_node, key, value):
+    '''Find the nfirst ode from xmlroot that has name name_node and that has in 
+       its attributes {key : value}. Return the node
+    
+    :param xmlroot etree.Element: the Etree element where to search
+    :param name_node str: the name of node to search
+    :param key str: the key to search
+    :param value str: the value to search
+    :return: the found node
+    :rtype: xmlroot etree.Element
+    '''
+    l_nodes =  xmlroot.findall(name_node)
+    for node in l_nodes:
+        if key not in node.attrib.keys():
+            continue
+        if node.attrib[key] == value:
+            return node
+    return None
+    
+

+
[docs]def write_report(filename, xmlroot, stylesheet):
+    """Writes a report file from a XML tree.
+    
+    :param filename str: The path to the file to create
+    :param xmlroot etree.Element: the Etree element to write to the file
+    :param stylesheet str: The stylesheet to add to the begin of the file
+    """
+    if not os.path.exists(os.path.dirname(filename)):
+        os.makedirs(os.path.dirname(filename))
+
+    f = open(filename, "w")
+    f.write("<?xml version='1.0' encoding='utf-8'?>\n")
+    if len(stylesheet) > 0:
+        f.write("<?xml-stylesheet type='text/xsl' href='%s'?>\n" % stylesheet)
+    f.write(etree.tostring(xmlroot, encoding='utf-8'))
+    f.close()   
+    

+
+ +
+
+
+
+
+
+

Related Topics

+ +
+ + +
+
+
+
+
+ ©2018, CEA. + + | + Powered by Sphinx 1.1.3 + & Alabaster + +
+ + + + + + \ No newline at end of file diff --git a/doc/build/html/_sources/commands/apidoc/modules.txt b/doc/build/html/_sources/commands/apidoc/modules.txt new file mode 100644 index 0000000..e9ff8ac --- /dev/null +++ b/doc/build/html/_sources/commands/apidoc/modules.txt @@ -0,0 +1,7 @@ +src +=== + +.. toctree:: + :maxdepth: 4 + + src diff --git a/doc/build/html/_sources/commands/apidoc/src.colorama.txt b/doc/build/html/_sources/commands/apidoc/src.colorama.txt new file mode 100644 index 0000000..ba8c5f6 --- /dev/null +++ b/doc/build/html/_sources/commands/apidoc/src.colorama.txt @@ -0,0 +1,51 @@ +colorama Package +================ + +:mod:`colorama` Package +----------------------- + +.. automodule:: src.colorama + :members: + :undoc-members: + :show-inheritance: + +:mod:`ansi` Module +------------------ + +.. automodule:: src.colorama.ansi + :members: + :undoc-members: + :show-inheritance: + +:mod:`ansitowin32` Module +------------------------- + +.. automodule:: src.colorama.ansitowin32 + :members: + :undoc-members: + :show-inheritance: + +:mod:`initialise` Module +------------------------ + +.. automodule:: src.colorama.initialise + :members: + :undoc-members: + :show-inheritance: + +:mod:`win32` Module +------------------- + +.. automodule:: src.colorama.win32 + :members: + :undoc-members: + :show-inheritance: + +:mod:`winterm` Module +--------------------- + +.. automodule:: src.colorama.winterm + :members: + :undoc-members: + :show-inheritance: + diff --git a/doc/build/html/_sources/commands/apidoc/src.txt b/doc/build/html/_sources/commands/apidoc/src.txt new file mode 100644 index 0000000..ac8627e --- /dev/null +++ b/doc/build/html/_sources/commands/apidoc/src.txt @@ -0,0 +1,146 @@ +src Package +=========== + +:mod:`src` Package +------------------ + +.. automodule:: src.__init__ + :members: + :undoc-members: + :show-inheritance: + +:mod:`ElementTree` Module +------------------------- + +.. automodule:: src.ElementTree + :members: + :undoc-members: + :show-inheritance: + +:mod:`architecture` Module +-------------------------- + +.. automodule:: src.architecture + :members: + :undoc-members: + :show-inheritance: + +:mod:`compilation` Module +------------------------- + +.. automodule:: src.compilation + :members: + :undoc-members: + :show-inheritance: + +:mod:`debug` Module +------------------- + +.. automodule:: src.debug + :members: + :undoc-members: + :show-inheritance: + +:mod:`environment` Module +------------------------- + +.. automodule:: src.environment + :members: + :undoc-members: + :show-inheritance: + +:mod:`fileEnviron` Module +------------------------- + +.. automodule:: src.fileEnviron + :members: + :undoc-members: + :show-inheritance: + +:mod:`fork` Module +------------------ + +.. automodule:: src.fork + :members: + :undoc-members: + :show-inheritance: + +:mod:`logger` Module +-------------------- + +.. automodule:: src.logger + :members: + :undoc-members: + :show-inheritance: + +:mod:`options` Module +--------------------- + +.. automodule:: src.options + :members: + :undoc-members: + :show-inheritance: + +:mod:`printcolors` Module +------------------------- + +.. automodule:: src.printcolors + :members: + :undoc-members: + :show-inheritance: + +:mod:`product` Module +--------------------- + +.. automodule:: src.product + :members: + :undoc-members: + :show-inheritance: + +:mod:`pyconf` Module +-------------------- + +.. automodule:: src.pyconf + :members: + :undoc-members: + :show-inheritance: + +:mod:`system` Module +-------------------- + +.. automodule:: src.system + :members: + :undoc-members: + :show-inheritance: + +:mod:`template` Module +---------------------- + +.. automodule:: src.template + :members: + :undoc-members: + :show-inheritance: + +:mod:`test_module` Module +------------------------- + +.. automodule:: src.test_module + :members: + :undoc-members: + :show-inheritance: + +:mod:`xmlManager` Module +------------------------ + +.. automodule:: src.xmlManager + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + + src.colorama + diff --git a/doc/build/html/_sources/commands/application.txt b/doc/build/html/_sources/commands/application.txt new file mode 100644 index 0000000..2052da0 --- /dev/null +++ b/doc/build/html/_sources/commands/application.txt @@ -0,0 +1,55 @@ + +.. include:: ../../rst_prolog.rst + +Command application +********************* + +Description +=========== +The **application** command creates a virtual SALOME_ application. +Virtual SALOME applications are used to start SALOME when distribution is needed. + +Usage +===== +* Create an application: :: + + sat application + + Create the virtual application directory in the salomeTool application directory ``$APPLICATION.workdir``. + +* Give a name to the application: :: + + sat application --name + + *Remark*: this option overrides the name given in the virtual_app section of the configuration file ``$APPLICATION.virtual_app.name``. + +* Change the directory where the application is created: :: + + sat application --target + +* Set a specific SALOME_ resources catalog (it will be used for the distribution of components on distant machines): :: + + sat application --catalog + + Note that the catalog specified will be copied to the application directory. + +* Generate the catalog for a list of machines: :: + + sat application --gencat machine1,machine2,machine3 + + This will create a catalog by querying each machine through ssh protocol (memory, number of processor) with ssh. + +* Generate a mesa application (if mesa and llvm are parts of the application). Use this option only if you have to use salome through ssh and have problems with ssh X forwarding of OpengGL modules (like Paravis): :: + + sat launcher --use_mesa + +Some useful configuration pathes +================================= + +The virtual application can be configured with the virtual_app section of the configutation file. + +* **APPLICATION.virtual_app** + + * **name** : name of the launcher (to replace the default runAppli). + * **application_name** : (optional) the name of the virtual application directory, if missing the default value is ``$name + _appli``. + diff --git a/doc/build/html/_sources/commands/clean.txt b/doc/build/html/_sources/commands/clean.txt new file mode 100644 index 0000000..e5d2f38 --- /dev/null +++ b/doc/build/html/_sources/commands/clean.txt @@ -0,0 +1,61 @@ + +.. include:: ../../rst_prolog.rst + +Command clean +**************** + +Description +============ + +The **clean** command removes products in the *source, build, or install* directories of an application. Theses directories are usually named ``SOURCES, BUILD, INSTALL``. + +Use the options to define what directories you want to suppress and to set the list of products + + +Usage +======= + +* Clean all previously created *build* and *install* directories (example application as *SALOME_xx*): + + .. code-block:: bash + + # take care, is long time to restore, sometimes + sat clean SALOME-xx --build --install + +* Clean previously created *build* and *install* directories, only for products with property *is_salome_module*: + + .. code-block:: bash + + sat clean SALOME-xxx --build --install \ + --properties is_salome_module:yes + + +Availables options +====================== + + * **--products** : Products to clean. + + * **--properties** : + + | Filter the products by their properties. + | Syntax: *--properties :* + + * **--sources** : Clean the product source directories. + + * **--build** : Clean the product build directories. + + * **--install** : Clean the product install directories. + + * **--all** : Clean the product source, build and install directories. + + * **--sources_without_dev** : + + | Do not clean the products in development mode, + | (they could have VCS_ commits pending). + + + +Some useful configuration pathes +================================= + +No specific configuration. diff --git a/doc/build/html/_sources/commands/compile.txt b/doc/build/html/_sources/commands/compile.txt new file mode 100644 index 0000000..915705e --- /dev/null +++ b/doc/build/html/_sources/commands/compile.txt @@ -0,0 +1,75 @@ + +.. include:: ../../rst_prolog.rst + +Command compile +**************** + +Description +=========== +The **compile** command allows compiling the products of a SALOME_ application. + + +Usage +===== +* Compile a complete application: :: + + sat compile + +* Compile only some products: :: + + sat compile --products , ... + +* Use *sat -t* to duplicate the logs in the terminal (by default the log are stored and displayed with *sat log* command): :: + + sat -t compile --products + +* Compile a module and its dependencies: :: + + sat compile --products med --with_fathers + +* Compile a module and the modules depending on it (for example plugins): :: + + sat compile --products med --with_children + +* Clean the build and install directories before starting compilation: :: + + sat compile --products GEOM --clean_all + + .. note:: | a warning will be shown if option *--products* is missing + | (as it will clean everything) + +* Clean only the install directories before starting compilation: :: + + sat compile --clean_install + +* Add options for make: :: + + sat compile --products --make_flags + +* Use the *--check* option to execute the unit tests after compilation: :: + + sat compile --check + +* Remove the build directory after successful compilation (some build directory like qt are big): :: + + sat compile --products qt --clean_build_after + +* Stop the compilation as soon as the compilation of a module fails: :: + + sat compile --stop_first_fail + +* Do not compile, just show if products are installed or not, and where is the installation: :: + + sat compile --show + + +Some useful configuration pathes +================================= + +The way to compile a product is defined in the *pyconf file configuration*. +The main options are: + + * **build_source** : the method used to build the product (cmake/autotools/script) + * **compil_script** : the compilation script if build_source is equal to "script" + * **cmake_options** : additional options for cmake. + * **nb_proc** : number of jobs to use with make for this product. diff --git a/doc/build/html/_sources/commands/config.txt b/doc/build/html/_sources/commands/config.txt new file mode 100644 index 0000000..79a4a46 --- /dev/null +++ b/doc/build/html/_sources/commands/config.txt @@ -0,0 +1,89 @@ + +.. include:: ../../rst_prolog.rst + +Command config +****************** + +Description +=========== +The **config** command manages sat configuration. +It allows display, manipulation and operation on configuration files + +Usage +===== +* Edit the user personal configuration file ``$HOME/.salomeTools/SAT.pyconf``. It is used to store the user personal choices, like the favorite editor, browser, pdf viewer: :: + + sat config --edit + +* List the available applications (they come from the sat projects defined in ``data/local.pyconf``: :: + + sat config --list + +* Edit the configuration of an application: :: + + sat config --edit + +* Copy an application configuration file into the user personal directory: :: + + sat config --copy [new_name] + +* | Print the value of a configuration parameter. + | Use the automatic completion to get recursively the parameter names. + | Use *--no_label* option to get *only* the value, *without* label (useful in automatic scripts). + | Examples (with *SALOME-xx* as *SALOME-8.4.0* ): + + .. code-block:: bash + + # sat config --value + sat config --value . # all the configuration + sat config --value LOCAL + sat config --value LOCAL.workdir + + # sat config --value + sat config SALOME-xx --value APPLICATION.workdir + sat config SALOME-xx --no_label --value APPLICATION.workdir + +* | Print in one-line-by-value mode the value of a configuration parameter, + | with its source *expression*, if any. + | This is a debug mode, useful for developers. + | Prints the parameter path, the source expression if any, and the final value: + + :: + + sat config SALOME-xx -g USER + + .. note:: And so, *not only for fun*, to get **all expressions** of configuration + + .. code-block:: bash + + sat config SALOME-xx -g . | grep -e "-->" + + +* Print the patches that are applied: :: + + sat config SALOME-xx --show_patchs + +* Get information on a product configuration: + + .. code-block:: bash + + # sat config --info + sat config SALOME-xx --info KERNEL + sat config SALOME-xx --info qt + +Some useful configuration pathes +================================= + +Exploring a current configuration. + +* **PATHS**: To get list of directories where to find files. + +* **USER**: To get user preferences (editor, pdf viewer, web browser, default working dir). + +sat commands: :: + + sat config SALOME-xx -v PATHS + sat config SALOME-xx -v USERS + + + diff --git a/doc/build/html/_sources/commands/environ.txt b/doc/build/html/_sources/commands/environ.txt new file mode 100644 index 0000000..13b9508 --- /dev/null +++ b/doc/build/html/_sources/commands/environ.txt @@ -0,0 +1,139 @@ + +.. include:: ../../rst_prolog.rst + +Command environ +**************** + +Description +=========== +The **environ** command generates the environment files used +to run and compile your application (as SALOME_ is an example). + +.. note :: + these files are **not** required, + salomeTool set the environment himself, when compiling. + And so does the salome launcher. + + These files are useful when someone wants to check the environment. + They could be used in debug mode to set the environment for *gdb*. + +The configuration part at the end of this page explains how +to specify the environment used by sat (at build or run time), +and saved in some files by *sat environ* command. + +Usage +===== +* Create the shell environment files of the application: :: + + sat environ + +* Create the environment files of the application for a given shell. + Options are bash, bat (for windows) and cfg (the configuration format used by SALOME_): :: + + sat environ --shell [bash|cfg|all] + +* Use a different prefix for the files (default is 'env'): + + .. code-block:: bash + + # This will create file _launch.sh, _build.sh + sat environ --prefix + +* Use a different target directory for the files: + + .. code-block:: bash + + # This will create file env_launch.sh, env_build.sh + # in the directory corresponding to + sat environ --target + +* Generate the environment files only with the given products: + + .. code-block:: bash + + # This will create the environment files only for the given products + # and their prerequisites. + # It is useful when you want to visualise which environment uses + # sat to compile a given product. + sat environ --product ,, ... + + +Configuration +============= + +The specification of the environment can be done through several mechanisms. + +1. For salome products (the products with the property ``is_SALOME_module`` as ``yes``) the environment is set automatically by sat, in respect with SALOME_ requirements. + +2. For other products, the environment is set with the use of the environ section within the pyconf file of the product. The user has two possibilities, either set directly the environment within the section, or specify a python script which wil be used to set the environment programmatically. + +Within the section, the user can define environment variables. He can also modify PATH variables, by appending or prepending directories. +In the following example, we prepend */lib* to ``LD_LIBRARY_PATH`` (note the *left first* underscore), append */lib* to ``PYTHONPATH`` (note the *right last* underscore), and set ``LAPACK_ROOT_DIR`` to **: + +.. code-block:: python + + environ : + { + _LD_LIBRARY_PATH : $install_dir + $VARS.sep + "lib" + PYTHONPATH_ : $install_dir + $VARS.sep + "lib" + LAPACK_ROOT_DIR : $install_dir + } + +It is possible to distinguish the build environment from the launch environment: use a subsection called *build* or *launch*. In the example below, ``LD_LIBRARY_PATH`` and ``PYTHONPATH`` are only modified at run time, not at compile time: + +.. code-block:: python + + environ : + { + build : + { + LAPACK_ROOT_DIR : $install_dir + } + launch : + { + LAPACK_ROOT_DIR : $install_dir + _LD_LIBRARY_PATH : $install_dir + $VARS.sep + "lib" + PYTHONPATH_ : $install_dir + $VARS.sep + "lib" + } + } + +3. The last possibility is to set the environment with a python script. The script should be provided in the *products/env_scripts* directory of the sat project, and its name is specified in the environment section with the key ``environ.env_script``: + +.. code-block:: python + + environ : + { + env_script : 'lapack.py' + } + +Please note that the two modes are complementary and are both taken into account. +Most of the time, the first mode is sufficient. + +The second mode can be used when the environment has to be set programmatically. +The developer implements a handle (as a python method) +which is called by sat to set the environment. +Here is an example: + +.. code-block:: python + + + #!/usr/bin/env python + #-*- coding:utf-8 -*- + + import os.path + import platform + + def set_env(env, prereq_dir, version): + env.set("TRUST_ROOT_DIR",prereq_dir) + env.prepend('PATH', os.path.join(prereq_dir, 'bin')) + env.prepend('PATH', os.path.join(prereq_dir, 'include')) + env.prepend('LD_LIBRARY_PATH', os.path.join(prereq_dir, 'lib')) + return + +SalomeTools defines four handles: + +* **set_env(env, prereq_dir, version)** : used at build and run time. +* **set_env_launch(env, prereq_dir, version)** : used only at run time (if defined!) +* **set_env_build(env, prereq_dir, version)** : used only at build time (if defined!) +* **set_native_env(env)** : used only for native products, at build and run time. + diff --git a/doc/build/html/_sources/commands/generate.txt b/doc/build/html/_sources/commands/generate.txt new file mode 100644 index 0000000..f753261 --- /dev/null +++ b/doc/build/html/_sources/commands/generate.txt @@ -0,0 +1,39 @@ + +.. include:: ../../rst_prolog.rst + +Command generate +**************** + +Description +=========== +The **generate** command generates and compile SALOME modules from cpp modules using YACSGEN. + +.. note:: This command uses YACSGEN to generate the module. It needs to be specified with *--yacsgen* option, or defined in the product or by the environment variable ``$YACSGEN_ROOT_DIR``. + + +Remarks +======= +* This command will only apply on the CPP modules of the application, those who have both properties: :: + + cpp : "yes" + generate : "yes" + +* The cpp module are usually computational components, and the generated module brings the CORBA layer which allows distributing the compononent on remore machines. cpp modules should conform to YACSGEN/hxx2salome requirements (please refer to YACSGEN documentation) + + +Usage +===== +* Generate all the modules of a product: :: + + sat generate + +* Generate only specific modules: :: + + sat generate --products + + Remark: modules which don't have the *generate* property are ignored. + +* Use a specific version of YACSGEN: :: + + sat generate --yacsgen + diff --git a/doc/build/html/_sources/commands/launcher.txt b/doc/build/html/_sources/commands/launcher.txt new file mode 100644 index 0000000..864a31a --- /dev/null +++ b/doc/build/html/_sources/commands/launcher.txt @@ -0,0 +1,52 @@ + +.. include:: ../../rst_prolog.rst + +Command launcher +****************** + +Description +=========== +The **launcher** command creates a SALOME launcher, a python script file to start SALOME_. + + +Usage +===== +* Create a launcher: :: + + sat launcher + + Generate a launcher in the application directory, i.e ``$APPLICATION.workdir``. + +* Create a launcher with a given name (default name is ``APPLICATION.profile.launcher_name``) :: + + sat launcher --name ZeLauncher + + The launcher will be called *ZeLauncher*. + +* Set a specific resources catalog: :: + + sat launcher --catalog + + Note that the catalog specified will be copied to the profile directory. + +* Generate the catalog for a list of machines: :: + + sat launcher --gencat + + This will create a catalog by querying each machine (memory, number of processor) with ssh. + +* Generate a mesa launcher (if mesa and llvm are parts of the application). Use this option only if you have to use salome through ssh and have problems with ssh X forwarding of OpengGL modules (like Paravis): :: + + sat launcher --use_mesa + + +Configuration +============= + +Some useful configuration pathes: + +* **APPLICATION.profile** + + * **product** : the name of the profile product (the product in charge of holding the application stuff, like logos, splashscreen) + * **launcher_name** : the name of the launcher. + diff --git a/doc/build/html/_sources/commands/log.txt b/doc/build/html/_sources/commands/log.txt new file mode 100644 index 0000000..9908f4b --- /dev/null +++ b/doc/build/html/_sources/commands/log.txt @@ -0,0 +1,46 @@ + +.. include:: ../../rst_prolog.rst + +Command log +**************** + +Description +=========== +The **log** command displays sat log in a web browser or in a terminal. + +Usage +===== +* Show (in a web browser) the log of the commands corresponding to an application: :: + + sat log + +* Show the log for commands that do not use any application: :: + + sat log + +* The --terminal (or -t) display the log directly in the terminal, through a CLI_ interactive menu: :: + + sat log --terminal + +* The --last option displays only the last command: :: + + sat log --last + +* To access the last compilation log in terminal mode, use --last_terminal option: :: + + sat log --last_terminal + +* The --clean (int) option erases the n older log files and print the number of remaining log files: :: + + sat log --clean 50 + + + +Some useful configuration pathes +================================= + +* **USER** + + * **browser** : The browser used to show the log (by default *firefox*). + * **log_dir** : The directory used to store the log files. + diff --git a/doc/build/html/_sources/commands/package.txt b/doc/build/html/_sources/commands/package.txt new file mode 100644 index 0000000..6d6648a --- /dev/null +++ b/doc/build/html/_sources/commands/package.txt @@ -0,0 +1,81 @@ + +.. include:: ../../rst_prolog.rst + +Command package +**************** + +Description +============ +The **package** command creates a SALOME_ archive (usually a compressed Tar_ file .tgz). +This tar file is used later to intall SALOME on other remote computer. + +Depending on the selected options, the archive includes sources and binaries +of SALOME products and prerequisites. + +Usually utility *salomeTools* is included in the archive. + +.. note:: + By default the package includes the sources of prerequisites and products. + To select a subset use the *--without_property* or *--with_vcs* options. + + +Usage +===== +* Create a package for a product (example as *SALOME_xx*): :: + + sat package SALOME_xx + + This command will create an archive named ``SALOME_xx.tgz`` + in the working directory (``USER.workDir``). + If the archive already exists, do nothing. + + +* Create a package with a specific name: :: + + sat package SALOME_xx --name YourSpecificName + +.. note:: + By default, the archive is created in the working directory of the user (``USER.workDir``). + + If the option *--name* is used with a path (relative or absolute) it will be used. + + If the option *--name* is not used and binaries (prerequisites and products) + are included in the package, the OS_ architecture + will be appended to the name (example: ``SALOME_xx-CO7.tgz``). + + Examples: :: + + # Creates SALOME_xx.tgz in $USER.workDir + sat package SALOME_xx + + # Creates SALOME_xx_.tgz in $USER.workDir + sat package SALOME_xx --binaries + + # Creates MySpecificName.tgz in $USER.workDir + sat package SALOME_xx --name MySpecificName + + +* Force the creation of the archive (if it already exists): :: + + sat package SALOME_xx --force + + +* Include the binaries in the archive (products and prerequisites): :: + + sat package SALOME_xx --binaries + + This command will create an archive named ``SALOME_xx _.tgz`` + where is the OS_ architecture of the machine. + + +* Do not delete Version Control System (VCS_) informations from the configurations files of the embedded salomeTools: :: + + sat package SALOME_xx --with_vcs + + The version control systems known by this option are CVS_, SVN_ and Git_. + + +Some useful configuration pathes +================================= + +No specific configuration. diff --git a/doc/build/html/_sources/commands/prepare.txt b/doc/build/html/_sources/commands/prepare.txt new file mode 100644 index 0000000..a28fdae --- /dev/null +++ b/doc/build/html/_sources/commands/prepare.txt @@ -0,0 +1,100 @@ + +.. include:: ../../rst_prolog.rst + +Command prepare +**************** + +Description +=========== +The **prepare** command brings the sources of an application in the *sources +application directory*, in order to compile them with the compile command. + +The sources can be prepared from VCS software (*cvs, svn, git*), an archive or a directory. + +.. warning:: When sat prepares a product, it first removes the + existing directory, except if the development mode is activated. + When you are working on a product, you need to declare in + the application configuration this product in **dev** mode. + +Remarks +======= + +VCS bases (git, svn, cvs) +------------------------- + +The *prepare* command does not manage authentication on the cvs server. +For example, to prepare modules from a cvs server, you first need to login once. + +To avoid typing a password for each product, +you may use a ssh key with passphrase, or store your password +(in .cvspass or .gitconfig files). +If you have security concerns, it is also possible to use +a bash agent and type your password only once. + + + +Dev mode +-------- + +By default *prepare* uses *export* mode: it creates an image +of the sources, corresponding to the tag or branch specified, +without any link to the VCS base. +To perform a *checkout* (svn, cvs) or a *git clone* (git), +you need to declare the product in dev mode in your application configuration: +edit the application configuration file (pyconf) and modify the product declaration: + +.. code-block:: bash + + sat config -e + # and edit the product section: + # : {tag : "my_tag", dev : "yes", debug : "yes"} + +The first time you will execute the *sat prepare* command, +your module will be downloaded in *checkout* mode +(inside the SOURCES directory of the application. +Then, you can develop in this repository, and finally push +them in the base when they are ready. +If you type during the development process by mistake +a *sat prepare* command, the sources in dev mode will +not be altered/removed (Unless you use -f option) + + +Usage +===== +* Prepare the sources of a complete application in SOURCES directory (all products): :: + + sat prepare + +* Prepare only some modules: :: + + sat prepare --products , ... + +* Use --force to force to prepare the products in development mode + (this will remove the sources and do a new clone/checkout): :: + + sat prepare --force + +* Use --force_patch to force to apply patch to the products + in development mode (otherwise they are not applied): :: + + sat prepare --force_patch + + +Some useful configuration pathes +================================= + +Command *sat prepare* uses the *pyconf file configuration* of each product to know how to get the sources. + +.. note:: to verify configuration of a product, and get name of this *pyconf files configuration* + + .. code-block :: bash + + sat config --info + + +* **get_method**: the method to use to prepare the module, possible values are cvs, git, archive, dir. +* **git_info** : (used if get_method = git) information to prepare sources from git. +* **svn_info** : (used if get_method = svn) information to prepare sources from cvs. +* **cvs_info** : (used if get_method = cvs) information to prepare sources from cvs. +* **archive_info** : (used if get_method = archive) the path to the archive. +* **dir_info** : (used if get_method = dir) the directory with the sources. diff --git a/doc/build/html/_sources/configuration.txt b/doc/build/html/_sources/configuration.txt new file mode 100644 index 0000000..7f415a3 --- /dev/null +++ b/doc/build/html/_sources/configuration.txt @@ -0,0 +1,88 @@ +************* +Configuration +************* + +*salomeTools* uses files to store its configuration parameters. + +There are several configuration files which are loaded by salomeTools in a specific order. +When all the files are loaded a *config* object is created. +Then, this object is passed to all command scripts. + + +Syntax +====== +The configuration files use a python-like structure format +(see `config module `_ for a complete description). + +* **{}** define a dictionary, +* **[]** define a list, +* **@** can be used to include a file, +* **$prefix** reference to another parameter (ex: ``$PRODUCT.name``), +* **#** comments. + +.. note:: in this documentation a reference to a configuration parameter will be noted ``XXX.YYY``. + +Description +=========== + +.. _VARS-Section: + +VARS section +------------- +| This section is dynamically created by salomeTools at run time. +| It contains information about the environment: date, time, OS, architecture etc. + +:: + + # to get the current setting + sat config --value VARS + +PRODUCTS section +------------------ +| This section is defined in the product file. +| It contains instructions on how to build a version of SALOME (list of prerequisites-products and versions) + +:: + + # to get the current setting + sat config SALOME-xx --value PRODUCTS + +APPLICATION section +--------------------- +| This section is optional, it is also defined in the product file. +| It gives additional parameters to create an application based on SALOME, as versions of products to use. + +:: + + # to get the current setting + sat config SALOME-xx --value APPLICATION + + +.. _USER-Section: + +USER section +-------------- +This section is defined by the user configuration file, +``~/.salomeTools/salomeTools.pyconf``. + +The ``USER`` section defines some parameters (not exhaustive): + +* **workDir** : + + | The working directory. + | Each product will be usually installed here (in sub-directories). + +* **browser** : The web browser to use (*firefox*). + +* **editor** : The editor to use (*vi, pluma*). + +* and other user preferences. + +:: + + # to get the current setting + sat config SALOME-xx --value USER + + + + diff --git a/doc/build/html/_sources/index.txt b/doc/build/html/_sources/index.txt new file mode 100644 index 0000000..2cfb090 --- /dev/null +++ b/doc/build/html/_sources/index.txt @@ -0,0 +1,76 @@ + +.. include:: ../rst_prolog.rst + +************ +Salome Tools +************ + +.. image:: images/sat_about.png + :scale: 100 % + :align: center + +.. warning:: This documentation is under construction. + +The **Sa**\ lome\ **T**\ ools (sat) is a suite of commands +that can be used to perform operations on SALOME_. + +For example, sat allows you to compile SALOME's codes +(prerequisites, products) +create application, run tests, create package, etc. + +This utility code is a set of Python_ scripts files. + + +Quick start +=========== + +.. toctree:: + :maxdepth: 1 + + Installation of salomeTools + Configuration + Usage of salomeTools + +List of Commands +================ + +.. toctree:: + :maxdepth: 1 + + config + prepare + compile + launcher + application + log + environ + clean + package + generate + +Developer documentation +======================= + +.. toctree:: + :maxdepth: 1 + + Add a command + + +Code documentation +================== + +.. toctree:: + :maxdepth: 1 + + SAT modules + + +Release Notes +============= + +.. toctree:: + :maxdepth: 1 + + Release Notes 5.0.0 + diff --git a/doc/build/html/_sources/installation_of_sat.txt b/doc/build/html/_sources/installation_of_sat.txt new file mode 100644 index 0000000..da661be --- /dev/null +++ b/doc/build/html/_sources/installation_of_sat.txt @@ -0,0 +1,15 @@ +************ +Installation +************ + +Usually user could find (and use) command **sat** directly after a 'detar' installation of SALOME. + +.. code-block:: bash + + tar -xf .../SALOME_xx.tgz + cd SALOME_xx + ls -l sat # sat -> salomeTools/sat + + +Python package (scripts of salomeTools) actually remains in directory *salomeTools*. + diff --git a/doc/build/html/_sources/release_notes/release_notes_5.0.0.txt b/doc/build/html/_sources/release_notes/release_notes_5.0.0.txt new file mode 100644 index 0000000..55b6aad --- /dev/null +++ b/doc/build/html/_sources/release_notes/release_notes_5.0.0.txt @@ -0,0 +1,5 @@ +*************** +Release notes +*************** + +In construction. diff --git a/doc/build/html/_sources/usage_of_sat.txt b/doc/build/html/_sources/usage_of_sat.txt new file mode 100644 index 0000000..80c7b46 --- /dev/null +++ b/doc/build/html/_sources/usage_of_sat.txt @@ -0,0 +1,97 @@ + +.. include:: ../rst_prolog.rst + +******************** +Usage of SAlomeTools +******************** + +Usage +===== +sat usage is a Command Line Interface (CLI_). + +.. code-block:: bash + + sat [generic_options] [command] [product] [command_options] + +Options of sat +-------------- + +Useful *not exhaustive* generic options of *sat* CLI. + +*--help or -h* +............... + +Get help as simple text. + +.. code-block:: bash + + sat --help # get the list of existing commands + sat --help compile # get the help on a specific command 'compile' + + +*--debug or -g* +................ + +Execution in debug mode allows to see more trace and *stack* if an exception is raised. + +*--verbose or -v* +.................. + +Change verbosity level (default is 3). + +.. code-block:: bash + + # for product 'SALOME_xx' for example + # execute compile command in debug mode with trace level 4 + sat -g -v 4 compile SALOME_xx + + +Build a SALOME product +====================== + +Get the list of available products +---------------------------------- + +To get the list of the current available products in your context: + +.. code-block:: bash + + sat config --list + +Prepare sources of a product +---------------------------- + +To prepare (get) *all* the sources of a product (*SALOME_xx* for example): + +.. code-block:: bash + + sat prepare SALOME_xx + +| The sources are usually copied in directories +| *$USER.workDir + SALOME_xx... + SOURCES + $PRODUCT.name* + + +Compile SALOME +---------------- + +To compile products: + +.. code-block:: bash + + # compile all prerequisites/products + sat compile SALOME_xx + + # compile only 2 products (KERNEL and SAMPLES), if not done yet + sat compile SALOME_xx --products KERNEL,SAMPLES + + # compile only 2 products, unconditionaly + sat compile SALOME_xx ---products SAMPLES --clean_all + + +| The products are usually build in the directories +| *$USER.workDir + SALOME_xx... + BUILD + $PRODUCT.name* +| +| The products are usually installed in the directories +| *$USER.workDir + SALOME_xx... + INSTALL + $PRODUCT.name* + + diff --git a/doc/build/html/_sources/write_command.txt b/doc/build/html/_sources/write_command.txt new file mode 100644 index 0000000..9a68de8 --- /dev/null +++ b/doc/build/html/_sources/write_command.txt @@ -0,0 +1,157 @@ + +.. include:: ../rst_prolog.rst + + +Add a user custom command +*************************** + +Introduction +============ + +.. note:: This documentation is for Python_ developers. + + +The salomeTools product provides a simple way to develop commands. +The first thing to do is to add a file with *.py* extension in the ``commands`` directory of salomeTools. + +Here are the basic requirements that must be followed in this file in order to add a command. + +Basic requirements +================== + +By adding a file *mycommand.py* in the ``commands`` directory, salomeTools will define a new command named ``mycommand``. + +In *mycommand.py*, there must be the following method: :: + + def run(args, runner, logger): + # your algorithm ... + pass + +In fact, at this point, the command will already be functional. +But there are some useful services provided by salomeTools : + +* You can give some options to your command: + +.. code-block:: python + + import src + + # Define all possible option for mycommand command : 'sat mycommand ' + parser = src.options.Options() + parser.add_option('m', 'myoption', \ + 'boolean', 'myoption', \ + 'My option changes the behavior of my command.') + + def run(args, runner, logger): + # Parse the options + (options, args) = parser.parse_args(args) + # algorithm + + +* You can add a *description* method that will display a message when the user will call the help: + + +.. code-block:: python + :emphasize-lines: 9,10 + + import src + + # Define all possible option for mycommand command : 'sat mycommand ' + parser = src.options.Options() + parser.add_option('m', 'myoption', \ + 'boolean', 'myoption', \ + 'My option changes the behavior of my command.') + + def description(): + return _("The help of mycommand.") + + def run(args, runner, logger): + # Parse the options + (options, args) = parser.parse_args(args) + # algorithm + +HowTo access salomeTools config and other commands +======================================================== + +The *runner* variable is an python instance of *Sat* class. +It gives access to *runner.cfg* which is the data model defined from all +*configuration pyconf files* of salomeTools +For example, *runner.cfg.APPLICATION.workdir* +contains the root directory of the current application. + +The *runner* variable gives also access to other commands of salomeTools: + +.. code-block:: python + + # as CLI_ 'sat prepare ...' + runner.prepare(runner.cfg.VARS.application) + +HowTo logger +============== + +The logger variable is an instance of the Logger class. +It gives access to the write method. + +When this method is called, the message passed as parameter +will be displayed in the terminal and written in an xml log file. + +.. code-block:: python + + logger.write("My message", 3) # 3 as default + +The second argument defines the level of verbosity +that is wanted for this message. +It has to be between 1 and 5 (the most verbose level). + +HELLO example +============== + +Here is a *hello* command, file *commands/hello.py*: + +.. code-block:: python + + import src + + """ + hello.py + Define all possible options for hello command: + sat hello + """ + + parser = src.options.Options() + parser.add_option('f', 'french', 'boolean', 'french', "french set hello message in french.") + + def description(): + return _("The help of hello.") + + def run(args, runner, logger): + # Parse the options + (options, args) = parser.parse_args(args) + # algorithm + if not options.french: + logger.write('HELLO! WORLD!\n') + else: + logger.write('Bonjour tout le monde!\n') + +A first call of hello: + +.. code-block:: bash + + # Get the help of hello: + ./sat --help hello + + # To get bonjour + ./sat hello --french + Bonjour tout le monde! + + # To get hello + ./sat hello + HELLO! WORLD! + + # To get the log + ./sat log + + + + + diff --git a/doc/build/html/_static/ajax-loader.gif b/doc/build/html/_static/ajax-loader.gif new file mode 100644 index 0000000..61faf8c Binary files /dev/null and b/doc/build/html/_static/ajax-loader.gif differ diff --git a/doc/build/html/_static/alabaster.css b/doc/build/html/_static/alabaster.css new file mode 100644 index 0000000..1d88b3e --- /dev/null +++ b/doc/build/html/_static/alabaster.css @@ -0,0 +1,689 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@import url("basic.css"); + +/* -- page layout ----------------------------------------------------------- */ + +body { + font-family: 'goudy old style', 'minion pro', 'bell mt', Georgia, 'Hiragino Mincho Pro', serif; + font-size: 0.9em; + background-color: #fff; + color: #000; + margin: 0; + padding: 0; +} + + +div.document { + width: 1000px; + margin: 30px auto 0 auto; +} + +div.documentwrapper { + float: left; + width: 100%; +} + +div.bodywrapper { + margin: 0 0 0 250px; +} + +div.sphinxsidebar { + width: 250px; + font-size: 14px; + line-height: 1.5; +} + +hr { + border: 1px solid #B1B4B6; +} + +div.body { + background-color: #fff; + color: #3E4349; + padding: 0 30px 0 30px; +} + +div.body > .section { + text-align: left; +} + +div.footer { + width: 1000px; + margin: 20px auto 30px auto; + font-size: 14px; + color: #888; + text-align: right; +} + +div.footer a { + color: #888; +} + +p.caption { + font-family: inherit; + font-size: inherit; +} + + + +div.sphinxsidebar a { + color: #444; + text-decoration: none; + border-bottom: 1px dotted #999; +} + +div.sphinxsidebar a:hover { + border-bottom: 1px solid #999; +} + +div.sphinxsidebarwrapper { + padding: 18px 10px; +} + +div.sphinxsidebarwrapper p.logo { + padding: 0; + margin: -10px 0 0 0px; + text-align: center; +} + +div.sphinxsidebarwrapper h1.logo { + margin-top: -10px; + text-align: center; + margin-bottom: 5px; + text-align: left; +} + +div.sphinxsidebarwrapper h1.logo-name { + margin-top: 0px; +} + +div.sphinxsidebarwrapper p.blurb { + margin-top: 0; + font-style: normal; +} + +div.sphinxsidebar h3, +div.sphinxsidebar h4 { + font-family: 'Garamond', 'Georgia', serif; + color: #444; + font-size: 24px; + font-weight: normal; + margin: 0 0 5px 0; + padding: 0; +} + +div.sphinxsidebar h4 { + font-size: 20px; +} + +div.sphinxsidebar h3 a { + color: #444; +} + +div.sphinxsidebar p.logo a, +div.sphinxsidebar h3 a, +div.sphinxsidebar p.logo a:hover, +div.sphinxsidebar h3 a:hover { + border: none; +} + +div.sphinxsidebar p { + color: #555; + margin: 10px 0; +} + +div.sphinxsidebar ul { + margin: 10px 0; + padding: 0; + color: #000; +} + +div.sphinxsidebar ul li.toctree-l1 > a { + font-size: 120%; +} + +div.sphinxsidebar ul li.toctree-l2 > a { + font-size: 110%; +} + +div.sphinxsidebar input { + border: 1px solid #CCC; + font-family: 'goudy old style', 'minion pro', 'bell mt', Georgia, 'Hiragino Mincho Pro', serif; + font-size: 1em; +} + +div.sphinxsidebar hr { + border: none; + height: 1px; + color: #AAA; + background: #AAA; + + text-align: left; + margin-left: 0; + width: 50%; +} + +/* -- body styles ----------------------------------------------------------- */ + +a { + color: #004B6B; + text-decoration: underline; +} + +a:hover { + color: #6D4100; + text-decoration: underline; +} + +div.body h1, +div.body h2, +div.body h3, +div.body h4, +div.body h5, +div.body h6 { + font-family: 'Garamond', 'Georgia', serif; + font-weight: normal; + margin: 30px 0px 10px 0px; + padding: 0; +} + +div.body h1 { margin-top: 0; padding-top: 0; font-size: 240%; } +div.body h2 { font-size: 180%; } +div.body h3 { font-size: 150%; } +div.body h4 { font-size: 130%; } +div.body h5 { font-size: 100%; } +div.body h6 { font-size: 100%; } + +a.headerlink { + color: #DDD; + padding: 0 4px; + text-decoration: none; +} + +a.headerlink:hover { + color: #444; + background: #EAEAEA; +} + +div.body p, div.body dd, div.body li { + line-height: 1.4em; +} + +div.admonition { + margin: 20px 0px; + padding: 10px 30px; + background-color: #EEE; + border: 1px solid #CCC; +} + +div.admonition tt.xref, div.admonition code.xref, div.admonition a tt { + background-color: #FBFBFB; + border-bottom: 1px solid #fafafa; +} + +div.admonition p.admonition-title { + font-family: 'Garamond', 'Georgia', serif; + font-weight: normal; + font-size: 24px; + margin: 0 0 10px 0; + padding: 0; + line-height: 1; +} + +div.admonition p.last { + margin-bottom: 0; +} + +div.highlight { + background-color: #fff; +} + +dt:target, .highlight { + background: #FAF3E8; +} + +div.warning { + background-color: #FCC; + border: 1px solid #FAA; +} + +div.danger { + background-color: #FCC; + border: 1px solid #FAA; + -moz-box-shadow: 2px 2px 4px #D52C2C; + -webkit-box-shadow: 2px 2px 4px #D52C2C; + box-shadow: 2px 2px 4px #D52C2C; +} + +div.error { + background-color: #FCC; + border: 1px solid #FAA; + -moz-box-shadow: 2px 2px 4px #D52C2C; + -webkit-box-shadow: 2px 2px 4px #D52C2C; + box-shadow: 2px 2px 4px #D52C2C; +} + +div.caution { + background-color: #FCC; + border: 1px solid #FAA; +} + +div.attention { + background-color: #FCC; + border: 1px solid #FAA; +} + +div.important { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.note { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.tip { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.hint { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.seealso { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.topic { + background-color: #EEE; +} + +p.admonition-title { + display: inline; +} + +p.admonition-title:after { + content: ":"; +} + +pre, tt, code { + font-family: 'Consolas', 'Menlo', 'Deja Vu Sans Mono', 'Bitstream Vera Sans Mono', monospace; + font-size: 0.8em; +} + +.hll { + background-color: #FFC; + margin: 0 -12px; + padding: 0 12px; + display: block; +} + +img.screenshot { +} + +tt.descname, tt.descclassname, code.descname, code.descclassname { + font-size: 0.95em; +} + +tt.descname, code.descname { + padding-right: 0.08em; +} + +img.screenshot { + -moz-box-shadow: 2px 2px 4px #EEE; + -webkit-box-shadow: 2px 2px 4px #EEE; + box-shadow: 2px 2px 4px #EEE; +} + +table.docutils { + border: 1px solid #888; + -moz-box-shadow: 2px 2px 4px #EEE; + -webkit-box-shadow: 2px 2px 4px #EEE; + box-shadow: 2px 2px 4px #EEE; +} + +table.docutils td, table.docutils th { + border: 1px solid #888; + padding: 0.25em 0.7em; +} + +table.field-list, table.footnote { + border: none; + -moz-box-shadow: none; + -webkit-box-shadow: none; + box-shadow: none; +} + +table.footnote { + margin: 15px 0; + width: 100%; + border: 1px solid #EEE; + background: #FDFDFD; + font-size: 0.9em; +} + +table.footnote + table.footnote { + margin-top: -15px; + border-top: none; +} + +table.field-list th { + padding: 0 0.8em 0 0; +} + +table.field-list td { + padding: 0; +} + +table.field-list p { + margin-bottom: 0.8em; +} + +/* Cloned from + * https://github.com/sphinx-doc/sphinx/commit/ef60dbfce09286b20b7385333d63a60321784e68 + */ +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +table.footnote td.label { + width: .1px; + padding: 0.3em 0 0.3em 0.5em; +} + +table.footnote td { + padding: 0.3em 0.5em; +} + +dl { + margin: 0; + padding: 0; +} + +dl dd { + margin-left: 30px; +} + +blockquote { + margin: 0 0 0 30px; + padding: 0; +} + +ul, ol { + /* Matches the 30px from the narrow-screen "li > ul" selector below */ + margin: 10px 0 10px 30px; + padding: 0; +} + +pre { + background: #fee; + padding: 7px 30px; + margin: 15px 0px; + line-height: 1.3em; +} + +div.viewcode-block:target { + background: #ffd; +} + +dl pre, blockquote pre, li pre { + margin-left: 0; + padding-left: 30px; +} + +tt, code { + background-color: #ecf0f3; + color: #222; + /* padding: 1px 2px; */ +} + +tt.xref, code.xref, a tt { + background-color: #FBFBFB; + border-bottom: 1px solid #fff; +} + +a.reference { + text-decoration: none; + border-bottom: 1px dotted #004B6B; +} + +/* Don't put an underline on images */ +a.image-reference, a.image-reference:hover { + border-bottom: none; +} + +a.reference:hover { + border-bottom: 1px solid #6D4100; +} + +a.footnote-reference { + text-decoration: none; + font-size: 0.7em; + vertical-align: top; + border-bottom: 1px dotted #004B6B; +} + +a.footnote-reference:hover { + border-bottom: 1px solid #6D4100; +} + +a:hover tt, a:hover code { + background: #EEE; +} + + +@media screen and (max-width: 870px) { + + div.sphinxsidebar { + display: none; + } + + div.document { + width: 100%; + + } + + div.documentwrapper { + margin-left: 0; + margin-top: 0; + margin-right: 0; + margin-bottom: 0; + } + + div.bodywrapper { + margin-top: 0; + margin-right: 0; + margin-bottom: 0; + margin-left: 0; + } + + ul { + margin-left: 0; + } + + li > ul { + /* Matches the 30px from the "ul, ol" selector above */ + margin-left: 30px; + } + + .document { + width: auto; + } + + .footer { + width: auto; + } + + .bodywrapper { + margin: 0; + } + + .footer { + width: auto; + } + + .github { + display: none; + } + + + +} + + + +@media screen and (max-width: 875px) { + + body { + margin: 0; + padding: 20px 30px; + } + + div.documentwrapper { + float: none; + background: #fff; + } + + div.sphinxsidebar { + display: block; + float: none; + width: 102.5%; + margin: 50px -30px -20px -30px; + padding: 10px 20px; + background: #333; + color: #FFF; + } + + div.sphinxsidebar h3, div.sphinxsidebar h4, div.sphinxsidebar p, + div.sphinxsidebar h3 a { + color: #fff; + } + + div.sphinxsidebar a { + color: #AAA; + } + + div.sphinxsidebar p.logo { + display: none; + } + + div.document { + width: 100%; + margin: 0; + } + + div.footer { + display: none; + } + + div.bodywrapper { + margin: 0; + } + + div.body { + min-height: 0; + padding: 0; + } + + .rtd_doc_footer { + display: none; + } + + .document { + width: auto; + } + + .footer { + width: auto; + } + + .footer { + width: auto; + } + + .github { + display: none; + } +} + + +/* misc. */ + +.revsys-inline { + display: none!important; +} + +/* Make nested-list/multi-paragraph items look better in Releases changelog + * pages. Without this, docutils' magical list fuckery causes inconsistent + * formatting between different release sub-lists. + */ +div#changelog > div.section > ul > li > p:only-child { + margin-bottom: 0; +} + +/* Hide fugly table cell borders in ..bibliography:: directive output */ +table.docutils.citation, table.docutils.citation td, table.docutils.citation th { + border: none; + /* Below needed in some edge cases; if not applied, bottom shadows appear */ + -moz-box-shadow: none; + -webkit-box-shadow: none; + box-shadow: none; +} \ No newline at end of file diff --git a/doc/build/html/_static/basic.css b/doc/build/html/_static/basic.css new file mode 100644 index 0000000..43e8baf --- /dev/null +++ b/doc/build/html/_static/basic.css @@ -0,0 +1,540 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox input[type="text"] { + width: 170px; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + width: 30px; +} + +img { + border: 0; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li div.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable dl, table.indextable dd { + margin-top: 0; + margin-bottom: 0; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- general body styles --------------------------------------------------- */ + +a.headerlink { + visibility: hidden; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.field-list ul { + padding-left: 1em; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px 7px 0 7px; + background-color: #ffe; + width: 40%; + float: right; +} + +p.sidebar-title { + font-weight: bold; +} + +/* -- topics ---------------------------------------------------------------- */ + +div.topic { + border: 1px solid #ccc; + padding: 7px 7px 0 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +div.admonition dl { + margin-bottom: 0; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + border: 0; + border-collapse: collapse; +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +table.field-list td, table.field-list th { + border: 0 !important; +} + +table.footnote td, table.footnote th { + border: 0 !important; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +dl { + margin-bottom: 15px; +} + +dd p { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +dt:target, .highlighted { + background-color: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.refcount { + color: #060; +} + +.optional { + font-size: 1.3em; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +td.linenos pre { + padding: 5px 0px; + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + margin-left: 0.5em; +} + +table.highlighttable td { + padding: 0 0.5em 0 0.5em; +} + +tt.descname { + background-color: transparent; + font-weight: bold; + font-size: 1.2em; +} + +tt.descclassname { + background-color: transparent; +} + +tt.xref, a tt { + background-color: transparent; + font-weight: bold; +} + +h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/doc/build/html/_static/comment-bright.png b/doc/build/html/_static/comment-bright.png new file mode 100644 index 0000000..551517b Binary files /dev/null and b/doc/build/html/_static/comment-bright.png differ diff --git a/doc/build/html/_static/comment-close.png b/doc/build/html/_static/comment-close.png new file mode 100644 index 0000000..09b54be Binary files /dev/null and b/doc/build/html/_static/comment-close.png differ diff --git a/doc/build/html/_static/comment.png b/doc/build/html/_static/comment.png new file mode 100644 index 0000000..92feb52 Binary files /dev/null and b/doc/build/html/_static/comment.png differ diff --git a/doc/build/html/_static/custom.css b/doc/build/html/_static/custom.css new file mode 100644 index 0000000..3ddd34d --- /dev/null +++ b/doc/build/html/_static/custom.css @@ -0,0 +1,2 @@ +/* This file intentionally left blank. */ + diff --git a/doc/build/html/_static/doctools.js b/doc/build/html/_static/doctools.js new file mode 100644 index 0000000..d4619fd --- /dev/null +++ b/doc/build/html/_static/doctools.js @@ -0,0 +1,247 @@ +/* + * doctools.js + * ~~~~~~~~~~~ + * + * Sphinx JavaScript utilities for all documentation. + * + * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/** + * select a different prefix for underscore + */ +$u = _.noConflict(); + +/** + * make the code below compatible with browsers without + * an installed firebug like debugger +if (!window.console || !console.firebug) { + var names = ["log", "debug", "info", "warn", "error", "assert", "dir", + "dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace", + "profile", "profileEnd"]; + window.console = {}; + for (var i = 0; i < names.length; ++i) + window.console[names[i]] = function() {}; +} + */ + +/** + * small helper function to urldecode strings + */ +jQuery.urldecode = function(x) { + return decodeURIComponent(x).replace(/\+/g, ' '); +} + +/** + * small helper function to urlencode strings + */ +jQuery.urlencode = encodeURIComponent; + +/** + * This function returns the parsed url parameters of the + * current request. Multiple values per key are supported, + * it will always return arrays of strings for the value parts. + */ +jQuery.getQueryParameters = function(s) { + if (typeof s == 'undefined') + s = document.location.search; + var parts = s.substr(s.indexOf('?') + 1).split('&'); + var result = {}; + for (var i = 0; i < parts.length; i++) { + var tmp = parts[i].split('=', 2); + var key = jQuery.urldecode(tmp[0]); + var value = jQuery.urldecode(tmp[1]); + if (key in result) + result[key].push(value); + else + result[key] = [value]; + } + return result; +}; + +/** + * small function to check if an array contains + * a given item. + */ +jQuery.contains = function(arr, item) { + for (var i = 0; i < arr.length; i++) { + if (arr[i] == item) + return true; + } + return false; +}; + +/** + * highlight a given string on a jquery object by wrapping it in + * span elements with the given class name. + */ +jQuery.fn.highlightText = function(text, className) { + function highlight(node) { + if (node.nodeType == 3) { + var val = node.nodeValue; + var pos = val.toLowerCase().indexOf(text); + if (pos >= 0 && !jQuery(node.parentNode).hasClass(className)) { + var span = document.createElement("span"); + span.className = className; + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + node.parentNode.insertBefore(span, node.parentNode.insertBefore( + document.createTextNode(val.substr(pos + text.length)), + node.nextSibling)); + node.nodeValue = val.substr(0, pos); + } + } + else if (!jQuery(node).is("button, select, textarea")) { + jQuery.each(node.childNodes, function() { + highlight(this); + }); + } + } + return this.each(function() { + highlight(this); + }); +}; + +/** + * Small JavaScript module for the documentation. + */ +var Documentation = { + + init : function() { + this.fixFirefoxAnchorBug(); + this.highlightSearchWords(); + this.initIndexTable(); + }, + + /** + * i18n support + */ + TRANSLATIONS : {}, + PLURAL_EXPR : function(n) { return n == 1 ? 0 : 1; }, + LOCALE : 'unknown', + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext : function(string) { + var translated = Documentation.TRANSLATIONS[string]; + if (typeof translated == 'undefined') + return string; + return (typeof translated == 'string') ? translated : translated[0]; + }, + + ngettext : function(singular, plural, n) { + var translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated == 'undefined') + return (n == 1) ? singular : plural; + return translated[Documentation.PLURALEXPR(n)]; + }, + + addTranslations : function(catalog) { + for (var key in catalog.messages) + this.TRANSLATIONS[key] = catalog.messages[key]; + this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')'); + this.LOCALE = catalog.locale; + }, + + /** + * add context elements like header anchor links + */ + addContextElements : function() { + $('div[id] > :header:first').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this headline')). + appendTo(this); + }); + $('dt[id]').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this definition')). + appendTo(this); + }); + }, + + /** + * workaround a firefox stupidity + */ + fixFirefoxAnchorBug : function() { + if (document.location.hash && $.browser.mozilla) + window.setTimeout(function() { + document.location.href += ''; + }, 10); + }, + + /** + * highlight the search words provided in the url in the text + */ + highlightSearchWords : function() { + var params = $.getQueryParameters(); + var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : []; + if (terms.length) { + var body = $('div.body'); + window.setTimeout(function() { + $.each(terms, function() { + body.highlightText(this.toLowerCase(), 'highlighted'); + }); + }, 10); + $('

' + _('Hide Search Matches') + '

') + .appendTo($('#searchbox')); + } + }, + + /** + * init the domain index toggle buttons + */ + initIndexTable : function() { + var togglers = $('img.toggler').click(function() { + var src = $(this).attr('src'); + var idnum = $(this).attr('id').substr(7); + $('tr.cg-' + idnum).toggle(); + if (src.substr(-9) == 'minus.png') + $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); + else + $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); + }).css('display', ''); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) { + togglers.click(); + } + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords : function() { + $('#searchbox .highlight-link').fadeOut(300); + $('span.highlighted').removeClass('highlighted'); + }, + + /** + * make the url absolute + */ + makeURL : function(relativeURL) { + return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; + }, + + /** + * get the current relative url + */ + getCurrentURL : function() { + var path = document.location.pathname; + var parts = path.split(/\//); + $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { + if (this == '..') + parts.pop(); + }); + var url = parts.join('/'); + return path.substring(url.lastIndexOf('/') + 1, path.length - 1); + } +}; + +// quick alias for translations +_ = Documentation.gettext; + +$(document).ready(function() { + Documentation.init(); +}); diff --git a/doc/build/html/_static/down-pressed.png b/doc/build/html/_static/down-pressed.png new file mode 100644 index 0000000..6f7ad78 Binary files /dev/null and b/doc/build/html/_static/down-pressed.png differ diff --git a/doc/build/html/_static/down.png b/doc/build/html/_static/down.png new file mode 100644 index 0000000..3003a88 Binary files /dev/null and b/doc/build/html/_static/down.png differ diff --git a/doc/build/html/_static/file.png b/doc/build/html/_static/file.png new file mode 100644 index 0000000..d18082e Binary files /dev/null and b/doc/build/html/_static/file.png differ diff --git a/doc/build/html/_static/jquery.js b/doc/build/html/_static/jquery.js new file mode 100644 index 0000000..7c24308 --- /dev/null +++ b/doc/build/html/_static/jquery.js @@ -0,0 +1,154 @@ +/*! + * jQuery JavaScript Library v1.4.2 + * http://jquery.com/ + * + * Copyright 2010, John Resig + * Dual licensed under the MIT or GPL Version 2 licenses. + * http://jquery.org/license + * + * Includes Sizzle.js + * http://sizzlejs.com/ + * Copyright 2010, The Dojo Foundation + * Released under the MIT, BSD, and GPL Licenses. + * + * Date: Sat Feb 13 22:33:48 2010 -0500 + */ +(function(A,w){function ma(){if(!c.isReady){try{s.documentElement.doScroll("left")}catch(a){setTimeout(ma,1);return}c.ready()}}function Qa(a,b){b.src?c.ajax({url:b.src,async:false,dataType:"script"}):c.globalEval(b.text||b.textContent||b.innerHTML||"");b.parentNode&&b.parentNode.removeChild(b)}function X(a,b,d,f,e,j){var i=a.length;if(typeof b==="object"){for(var o in b)X(a,o,b[o],f,e,d);return a}if(d!==w){f=!j&&f&&c.isFunction(d);for(o=0;o)[^>]*$|^#([\w-]+)$/,Ua=/^.[^:#\[\.,]*$/,Va=/\S/, +Wa=/^(\s|\u00A0)+|(\s|\u00A0)+$/g,Xa=/^<(\w+)\s*\/?>(?:<\/\1>)?$/,P=navigator.userAgent,xa=false,Q=[],L,$=Object.prototype.toString,aa=Object.prototype.hasOwnProperty,ba=Array.prototype.push,R=Array.prototype.slice,ya=Array.prototype.indexOf;c.fn=c.prototype={init:function(a,b){var d,f;if(!a)return this;if(a.nodeType){this.context=this[0]=a;this.length=1;return this}if(a==="body"&&!b){this.context=s;this[0]=s.body;this.selector="body";this.length=1;return this}if(typeof a==="string")if((d=Ta.exec(a))&& +(d[1]||!b))if(d[1]){f=b?b.ownerDocument||b:s;if(a=Xa.exec(a))if(c.isPlainObject(b)){a=[s.createElement(a[1])];c.fn.attr.call(a,b,true)}else a=[f.createElement(a[1])];else{a=sa([d[1]],[f]);a=(a.cacheable?a.fragment.cloneNode(true):a.fragment).childNodes}return c.merge(this,a)}else{if(b=s.getElementById(d[2])){if(b.id!==d[2])return T.find(a);this.length=1;this[0]=b}this.context=s;this.selector=a;return this}else if(!b&&/^\w+$/.test(a)){this.selector=a;this.context=s;a=s.getElementsByTagName(a);return c.merge(this, +a)}else return!b||b.jquery?(b||T).find(a):c(b).find(a);else if(c.isFunction(a))return T.ready(a);if(a.selector!==w){this.selector=a.selector;this.context=a.context}return c.makeArray(a,this)},selector:"",jquery:"1.4.2",length:0,size:function(){return this.length},toArray:function(){return R.call(this,0)},get:function(a){return a==null?this.toArray():a<0?this.slice(a)[0]:this[a]},pushStack:function(a,b,d){var f=c();c.isArray(a)?ba.apply(f,a):c.merge(f,a);f.prevObject=this;f.context=this.context;if(b=== +"find")f.selector=this.selector+(this.selector?" ":"")+d;else if(b)f.selector=this.selector+"."+b+"("+d+")";return f},each:function(a,b){return c.each(this,a,b)},ready:function(a){c.bindReady();if(c.isReady)a.call(s,c);else Q&&Q.push(a);return this},eq:function(a){return a===-1?this.slice(a):this.slice(a,+a+1)},first:function(){return this.eq(0)},last:function(){return this.eq(-1)},slice:function(){return this.pushStack(R.apply(this,arguments),"slice",R.call(arguments).join(","))},map:function(a){return this.pushStack(c.map(this, +function(b,d){return a.call(b,d,b)}))},end:function(){return this.prevObject||c(null)},push:ba,sort:[].sort,splice:[].splice};c.fn.init.prototype=c.fn;c.extend=c.fn.extend=function(){var a=arguments[0]||{},b=1,d=arguments.length,f=false,e,j,i,o;if(typeof a==="boolean"){f=a;a=arguments[1]||{};b=2}if(typeof a!=="object"&&!c.isFunction(a))a={};if(d===b){a=this;--b}for(;b
a"; +var e=d.getElementsByTagName("*"),j=d.getElementsByTagName("a")[0];if(!(!e||!e.length||!j)){c.support={leadingWhitespace:d.firstChild.nodeType===3,tbody:!d.getElementsByTagName("tbody").length,htmlSerialize:!!d.getElementsByTagName("link").length,style:/red/.test(j.getAttribute("style")),hrefNormalized:j.getAttribute("href")==="/a",opacity:/^0.55$/.test(j.style.opacity),cssFloat:!!j.style.cssFloat,checkOn:d.getElementsByTagName("input")[0].value==="on",optSelected:s.createElement("select").appendChild(s.createElement("option")).selected, +parentNode:d.removeChild(d.appendChild(s.createElement("div"))).parentNode===null,deleteExpando:true,checkClone:false,scriptEval:false,noCloneEvent:true,boxModel:null};b.type="text/javascript";try{b.appendChild(s.createTextNode("window."+f+"=1;"))}catch(i){}a.insertBefore(b,a.firstChild);if(A[f]){c.support.scriptEval=true;delete A[f]}try{delete b.test}catch(o){c.support.deleteExpando=false}a.removeChild(b);if(d.attachEvent&&d.fireEvent){d.attachEvent("onclick",function k(){c.support.noCloneEvent= +false;d.detachEvent("onclick",k)});d.cloneNode(true).fireEvent("onclick")}d=s.createElement("div");d.innerHTML="";a=s.createDocumentFragment();a.appendChild(d.firstChild);c.support.checkClone=a.cloneNode(true).cloneNode(true).lastChild.checked;c(function(){var k=s.createElement("div");k.style.width=k.style.paddingLeft="1px";s.body.appendChild(k);c.boxModel=c.support.boxModel=k.offsetWidth===2;s.body.removeChild(k).style.display="none"});a=function(k){var n= +s.createElement("div");k="on"+k;var r=k in n;if(!r){n.setAttribute(k,"return;");r=typeof n[k]==="function"}return r};c.support.submitBubbles=a("submit");c.support.changeBubbles=a("change");a=b=d=e=j=null}})();c.props={"for":"htmlFor","class":"className",readonly:"readOnly",maxlength:"maxLength",cellspacing:"cellSpacing",rowspan:"rowSpan",colspan:"colSpan",tabindex:"tabIndex",usemap:"useMap",frameborder:"frameBorder"};var G="jQuery"+J(),Ya=0,za={};c.extend({cache:{},expando:G,noData:{embed:true,object:true, +applet:true},data:function(a,b,d){if(!(a.nodeName&&c.noData[a.nodeName.toLowerCase()])){a=a==A?za:a;var f=a[G],e=c.cache;if(!f&&typeof b==="string"&&d===w)return null;f||(f=++Ya);if(typeof b==="object"){a[G]=f;e[f]=c.extend(true,{},b)}else if(!e[f]){a[G]=f;e[f]={}}a=e[f];if(d!==w)a[b]=d;return typeof b==="string"?a[b]:a}},removeData:function(a,b){if(!(a.nodeName&&c.noData[a.nodeName.toLowerCase()])){a=a==A?za:a;var d=a[G],f=c.cache,e=f[d];if(b){if(e){delete e[b];c.isEmptyObject(e)&&c.removeData(a)}}else{if(c.support.deleteExpando)delete a[c.expando]; +else a.removeAttribute&&a.removeAttribute(c.expando);delete f[d]}}}});c.fn.extend({data:function(a,b){if(typeof a==="undefined"&&this.length)return c.data(this[0]);else if(typeof a==="object")return this.each(function(){c.data(this,a)});var d=a.split(".");d[1]=d[1]?"."+d[1]:"";if(b===w){var f=this.triggerHandler("getData"+d[1]+"!",[d[0]]);if(f===w&&this.length)f=c.data(this[0],a);return f===w&&d[1]?this.data(d[0]):f}else return this.trigger("setData"+d[1]+"!",[d[0],b]).each(function(){c.data(this, +a,b)})},removeData:function(a){return this.each(function(){c.removeData(this,a)})}});c.extend({queue:function(a,b,d){if(a){b=(b||"fx")+"queue";var f=c.data(a,b);if(!d)return f||[];if(!f||c.isArray(d))f=c.data(a,b,c.makeArray(d));else f.push(d);return f}},dequeue:function(a,b){b=b||"fx";var d=c.queue(a,b),f=d.shift();if(f==="inprogress")f=d.shift();if(f){b==="fx"&&d.unshift("inprogress");f.call(a,function(){c.dequeue(a,b)})}}});c.fn.extend({queue:function(a,b){if(typeof a!=="string"){b=a;a="fx"}if(b=== +w)return c.queue(this[0],a);return this.each(function(){var d=c.queue(this,a,b);a==="fx"&&d[0]!=="inprogress"&&c.dequeue(this,a)})},dequeue:function(a){return this.each(function(){c.dequeue(this,a)})},delay:function(a,b){a=c.fx?c.fx.speeds[a]||a:a;b=b||"fx";return this.queue(b,function(){var d=this;setTimeout(function(){c.dequeue(d,b)},a)})},clearQueue:function(a){return this.queue(a||"fx",[])}});var Aa=/[\n\t]/g,ca=/\s+/,Za=/\r/g,$a=/href|src|style/,ab=/(button|input)/i,bb=/(button|input|object|select|textarea)/i, +cb=/^(a|area)$/i,Ba=/radio|checkbox/;c.fn.extend({attr:function(a,b){return X(this,a,b,true,c.attr)},removeAttr:function(a){return this.each(function(){c.attr(this,a,"");this.nodeType===1&&this.removeAttribute(a)})},addClass:function(a){if(c.isFunction(a))return this.each(function(n){var r=c(this);r.addClass(a.call(this,n,r.attr("class")))});if(a&&typeof a==="string")for(var b=(a||"").split(ca),d=0,f=this.length;d-1)return true;return false},val:function(a){if(a===w){var b=this[0];if(b){if(c.nodeName(b,"option"))return(b.attributes.value||{}).specified?b.value:b.text;if(c.nodeName(b,"select")){var d=b.selectedIndex,f=[],e=b.options;b=b.type==="select-one";if(d<0)return null;var j=b?d:0;for(d=b?d+1:e.length;j=0;else if(c.nodeName(this,"select")){var u=c.makeArray(r);c("option",this).each(function(){this.selected= +c.inArray(c(this).val(),u)>=0});if(!u.length)this.selectedIndex=-1}else this.value=r}})}});c.extend({attrFn:{val:true,css:true,html:true,text:true,data:true,width:true,height:true,offset:true},attr:function(a,b,d,f){if(!a||a.nodeType===3||a.nodeType===8)return w;if(f&&b in c.attrFn)return c(a)[b](d);f=a.nodeType!==1||!c.isXMLDoc(a);var e=d!==w;b=f&&c.props[b]||b;if(a.nodeType===1){var j=$a.test(b);if(b in a&&f&&!j){if(e){b==="type"&&ab.test(a.nodeName)&&a.parentNode&&c.error("type property can't be changed"); +a[b]=d}if(c.nodeName(a,"form")&&a.getAttributeNode(b))return a.getAttributeNode(b).nodeValue;if(b==="tabIndex")return(b=a.getAttributeNode("tabIndex"))&&b.specified?b.value:bb.test(a.nodeName)||cb.test(a.nodeName)&&a.href?0:w;return a[b]}if(!c.support.style&&f&&b==="style"){if(e)a.style.cssText=""+d;return a.style.cssText}e&&a.setAttribute(b,""+d);a=!c.support.hrefNormalized&&f&&j?a.getAttribute(b,2):a.getAttribute(b);return a===null?w:a}return c.style(a,b,d)}});var O=/\.(.*)$/,db=function(a){return a.replace(/[^\w\s\.\|`]/g, +function(b){return"\\"+b})};c.event={add:function(a,b,d,f){if(!(a.nodeType===3||a.nodeType===8)){if(a.setInterval&&a!==A&&!a.frameElement)a=A;var e,j;if(d.handler){e=d;d=e.handler}if(!d.guid)d.guid=c.guid++;if(j=c.data(a)){var i=j.events=j.events||{},o=j.handle;if(!o)j.handle=o=function(){return typeof c!=="undefined"&&!c.event.triggered?c.event.handle.apply(o.elem,arguments):w};o.elem=a;b=b.split(" ");for(var k,n=0,r;k=b[n++];){j=e?c.extend({},e):{handler:d,data:f};if(k.indexOf(".")>-1){r=k.split("."); +k=r.shift();j.namespace=r.slice(0).sort().join(".")}else{r=[];j.namespace=""}j.type=k;j.guid=d.guid;var u=i[k],z=c.event.special[k]||{};if(!u){u=i[k]=[];if(!z.setup||z.setup.call(a,f,r,o)===false)if(a.addEventListener)a.addEventListener(k,o,false);else a.attachEvent&&a.attachEvent("on"+k,o)}if(z.add){z.add.call(a,j);if(!j.handler.guid)j.handler.guid=d.guid}u.push(j);c.event.global[k]=true}a=null}}},global:{},remove:function(a,b,d,f){if(!(a.nodeType===3||a.nodeType===8)){var e,j=0,i,o,k,n,r,u,z=c.data(a), +C=z&&z.events;if(z&&C){if(b&&b.type){d=b.handler;b=b.type}if(!b||typeof b==="string"&&b.charAt(0)==="."){b=b||"";for(e in C)c.event.remove(a,e+b)}else{for(b=b.split(" ");e=b[j++];){n=e;i=e.indexOf(".")<0;o=[];if(!i){o=e.split(".");e=o.shift();k=new RegExp("(^|\\.)"+c.map(o.slice(0).sort(),db).join("\\.(?:.*\\.)?")+"(\\.|$)")}if(r=C[e])if(d){n=c.event.special[e]||{};for(B=f||0;B=0){a.type= +e=e.slice(0,-1);a.exclusive=true}if(!d){a.stopPropagation();c.event.global[e]&&c.each(c.cache,function(){this.events&&this.events[e]&&c.event.trigger(a,b,this.handle.elem)})}if(!d||d.nodeType===3||d.nodeType===8)return w;a.result=w;a.target=d;b=c.makeArray(b);b.unshift(a)}a.currentTarget=d;(f=c.data(d,"handle"))&&f.apply(d,b);f=d.parentNode||d.ownerDocument;try{if(!(d&&d.nodeName&&c.noData[d.nodeName.toLowerCase()]))if(d["on"+e]&&d["on"+e].apply(d,b)===false)a.result=false}catch(j){}if(!a.isPropagationStopped()&& +f)c.event.trigger(a,b,f,true);else if(!a.isDefaultPrevented()){f=a.target;var i,o=c.nodeName(f,"a")&&e==="click",k=c.event.special[e]||{};if((!k._default||k._default.call(d,a)===false)&&!o&&!(f&&f.nodeName&&c.noData[f.nodeName.toLowerCase()])){try{if(f[e]){if(i=f["on"+e])f["on"+e]=null;c.event.triggered=true;f[e]()}}catch(n){}if(i)f["on"+e]=i;c.event.triggered=false}}},handle:function(a){var b,d,f,e;a=arguments[0]=c.event.fix(a||A.event);a.currentTarget=this;b=a.type.indexOf(".")<0&&!a.exclusive; +if(!b){d=a.type.split(".");a.type=d.shift();f=new RegExp("(^|\\.)"+d.slice(0).sort().join("\\.(?:.*\\.)?")+"(\\.|$)")}e=c.data(this,"events");d=e[a.type];if(e&&d){d=d.slice(0);e=0;for(var j=d.length;e-1?c.map(a.options,function(f){return f.selected}).join("-"):"";else if(a.nodeName.toLowerCase()==="select")d=a.selectedIndex;return d},fa=function(a,b){var d=a.target,f,e;if(!(!da.test(d.nodeName)||d.readOnly)){f=c.data(d,"_change_data");e=Fa(d);if(a.type!=="focusout"||d.type!=="radio")c.data(d,"_change_data", +e);if(!(f===w||e===f))if(f!=null||e){a.type="change";return c.event.trigger(a,b,d)}}};c.event.special.change={filters:{focusout:fa,click:function(a){var b=a.target,d=b.type;if(d==="radio"||d==="checkbox"||b.nodeName.toLowerCase()==="select")return fa.call(this,a)},keydown:function(a){var b=a.target,d=b.type;if(a.keyCode===13&&b.nodeName.toLowerCase()!=="textarea"||a.keyCode===32&&(d==="checkbox"||d==="radio")||d==="select-multiple")return fa.call(this,a)},beforeactivate:function(a){a=a.target;c.data(a, +"_change_data",Fa(a))}},setup:function(){if(this.type==="file")return false;for(var a in ea)c.event.add(this,a+".specialChange",ea[a]);return da.test(this.nodeName)},teardown:function(){c.event.remove(this,".specialChange");return da.test(this.nodeName)}};ea=c.event.special.change.filters}s.addEventListener&&c.each({focus:"focusin",blur:"focusout"},function(a,b){function d(f){f=c.event.fix(f);f.type=b;return c.event.handle.call(this,f)}c.event.special[b]={setup:function(){this.addEventListener(a, +d,true)},teardown:function(){this.removeEventListener(a,d,true)}}});c.each(["bind","one"],function(a,b){c.fn[b]=function(d,f,e){if(typeof d==="object"){for(var j in d)this[b](j,f,d[j],e);return this}if(c.isFunction(f)){e=f;f=w}var i=b==="one"?c.proxy(e,function(k){c(this).unbind(k,i);return e.apply(this,arguments)}):e;if(d==="unload"&&b!=="one")this.one(d,f,e);else{j=0;for(var o=this.length;j0){y=t;break}}t=t[g]}m[q]=y}}}var f=/((?:\((?:\([^()]+\)|[^()]+)+\)|\[(?:\[[^[\]]*\]|['"][^'"]*['"]|[^[\]'"]+)+\]|\\.|[^ >+~,(\[\\]+)+|[>+~])(\s*,\s*)?((?:.|\r|\n)*)/g, +e=0,j=Object.prototype.toString,i=false,o=true;[0,0].sort(function(){o=false;return 0});var k=function(g,h,l,m){l=l||[];var q=h=h||s;if(h.nodeType!==1&&h.nodeType!==9)return[];if(!g||typeof g!=="string")return l;for(var p=[],v,t,y,S,H=true,M=x(h),I=g;(f.exec(""),v=f.exec(I))!==null;){I=v[3];p.push(v[1]);if(v[2]){S=v[3];break}}if(p.length>1&&r.exec(g))if(p.length===2&&n.relative[p[0]])t=ga(p[0]+p[1],h);else for(t=n.relative[p[0]]?[h]:k(p.shift(),h);p.length;){g=p.shift();if(n.relative[g])g+=p.shift(); +t=ga(g,t)}else{if(!m&&p.length>1&&h.nodeType===9&&!M&&n.match.ID.test(p[0])&&!n.match.ID.test(p[p.length-1])){v=k.find(p.shift(),h,M);h=v.expr?k.filter(v.expr,v.set)[0]:v.set[0]}if(h){v=m?{expr:p.pop(),set:z(m)}:k.find(p.pop(),p.length===1&&(p[0]==="~"||p[0]==="+")&&h.parentNode?h.parentNode:h,M);t=v.expr?k.filter(v.expr,v.set):v.set;if(p.length>0)y=z(t);else H=false;for(;p.length;){var D=p.pop();v=D;if(n.relative[D])v=p.pop();else D="";if(v==null)v=h;n.relative[D](y,v,M)}}else y=[]}y||(y=t);y||k.error(D|| +g);if(j.call(y)==="[object Array]")if(H)if(h&&h.nodeType===1)for(g=0;y[g]!=null;g++){if(y[g]&&(y[g]===true||y[g].nodeType===1&&E(h,y[g])))l.push(t[g])}else for(g=0;y[g]!=null;g++)y[g]&&y[g].nodeType===1&&l.push(t[g]);else l.push.apply(l,y);else z(y,l);if(S){k(S,q,l,m);k.uniqueSort(l)}return l};k.uniqueSort=function(g){if(B){i=o;g.sort(B);if(i)for(var h=1;h":function(g,h){var l=typeof h==="string";if(l&&!/\W/.test(h)){h=h.toLowerCase();for(var m=0,q=g.length;m=0))l||m.push(v);else if(l)h[p]=false;return false},ID:function(g){return g[1].replace(/\\/g,"")},TAG:function(g){return g[1].toLowerCase()}, +CHILD:function(g){if(g[1]==="nth"){var h=/(-?)(\d*)n((?:\+|-)?\d*)/.exec(g[2]==="even"&&"2n"||g[2]==="odd"&&"2n+1"||!/\D/.test(g[2])&&"0n+"+g[2]||g[2]);g[2]=h[1]+(h[2]||1)-0;g[3]=h[3]-0}g[0]=e++;return g},ATTR:function(g,h,l,m,q,p){h=g[1].replace(/\\/g,"");if(!p&&n.attrMap[h])g[1]=n.attrMap[h];if(g[2]==="~=")g[4]=" "+g[4]+" ";return g},PSEUDO:function(g,h,l,m,q){if(g[1]==="not")if((f.exec(g[3])||"").length>1||/^\w/.test(g[3]))g[3]=k(g[3],null,null,h);else{g=k.filter(g[3],h,l,true^q);l||m.push.apply(m, +g);return false}else if(n.match.POS.test(g[0])||n.match.CHILD.test(g[0]))return true;return g},POS:function(g){g.unshift(true);return g}},filters:{enabled:function(g){return g.disabled===false&&g.type!=="hidden"},disabled:function(g){return g.disabled===true},checked:function(g){return g.checked===true},selected:function(g){return g.selected===true},parent:function(g){return!!g.firstChild},empty:function(g){return!g.firstChild},has:function(g,h,l){return!!k(l[3],g).length},header:function(g){return/h\d/i.test(g.nodeName)}, +text:function(g){return"text"===g.type},radio:function(g){return"radio"===g.type},checkbox:function(g){return"checkbox"===g.type},file:function(g){return"file"===g.type},password:function(g){return"password"===g.type},submit:function(g){return"submit"===g.type},image:function(g){return"image"===g.type},reset:function(g){return"reset"===g.type},button:function(g){return"button"===g.type||g.nodeName.toLowerCase()==="button"},input:function(g){return/input|select|textarea|button/i.test(g.nodeName)}}, +setFilters:{first:function(g,h){return h===0},last:function(g,h,l,m){return h===m.length-1},even:function(g,h){return h%2===0},odd:function(g,h){return h%2===1},lt:function(g,h,l){return hl[3]-0},nth:function(g,h,l){return l[3]-0===h},eq:function(g,h,l){return l[3]-0===h}},filter:{PSEUDO:function(g,h,l,m){var q=h[1],p=n.filters[q];if(p)return p(g,l,h,m);else if(q==="contains")return(g.textContent||g.innerText||a([g])||"").indexOf(h[3])>=0;else if(q==="not"){h= +h[3];l=0;for(m=h.length;l=0}},ID:function(g,h){return g.nodeType===1&&g.getAttribute("id")===h},TAG:function(g,h){return h==="*"&&g.nodeType===1||g.nodeName.toLowerCase()===h},CLASS:function(g,h){return(" "+(g.className||g.getAttribute("class"))+" ").indexOf(h)>-1},ATTR:function(g,h){var l=h[1];g=n.attrHandle[l]?n.attrHandle[l](g):g[l]!=null?g[l]:g.getAttribute(l);l=g+"";var m=h[2];h=h[4];return g==null?m==="!=":m=== +"="?l===h:m==="*="?l.indexOf(h)>=0:m==="~="?(" "+l+" ").indexOf(h)>=0:!h?l&&g!==false:m==="!="?l!==h:m==="^="?l.indexOf(h)===0:m==="$="?l.substr(l.length-h.length)===h:m==="|="?l===h||l.substr(0,h.length+1)===h+"-":false},POS:function(g,h,l,m){var q=n.setFilters[h[2]];if(q)return q(g,l,h,m)}}},r=n.match.POS;for(var u in n.match){n.match[u]=new RegExp(n.match[u].source+/(?![^\[]*\])(?![^\(]*\))/.source);n.leftMatch[u]=new RegExp(/(^(?:.|\r|\n)*?)/.source+n.match[u].source.replace(/\\(\d+)/g,function(g, +h){return"\\"+(h-0+1)}))}var z=function(g,h){g=Array.prototype.slice.call(g,0);if(h){h.push.apply(h,g);return h}return g};try{Array.prototype.slice.call(s.documentElement.childNodes,0)}catch(C){z=function(g,h){h=h||[];if(j.call(g)==="[object Array]")Array.prototype.push.apply(h,g);else if(typeof g.length==="number")for(var l=0,m=g.length;l";var l=s.documentElement;l.insertBefore(g,l.firstChild);if(s.getElementById(h)){n.find.ID=function(m,q,p){if(typeof q.getElementById!=="undefined"&&!p)return(q=q.getElementById(m[1]))?q.id===m[1]||typeof q.getAttributeNode!=="undefined"&& +q.getAttributeNode("id").nodeValue===m[1]?[q]:w:[]};n.filter.ID=function(m,q){var p=typeof m.getAttributeNode!=="undefined"&&m.getAttributeNode("id");return m.nodeType===1&&p&&p.nodeValue===q}}l.removeChild(g);l=g=null})();(function(){var g=s.createElement("div");g.appendChild(s.createComment(""));if(g.getElementsByTagName("*").length>0)n.find.TAG=function(h,l){l=l.getElementsByTagName(h[1]);if(h[1]==="*"){h=[];for(var m=0;l[m];m++)l[m].nodeType===1&&h.push(l[m]);l=h}return l};g.innerHTML=""; +if(g.firstChild&&typeof g.firstChild.getAttribute!=="undefined"&&g.firstChild.getAttribute("href")!=="#")n.attrHandle.href=function(h){return h.getAttribute("href",2)};g=null})();s.querySelectorAll&&function(){var g=k,h=s.createElement("div");h.innerHTML="

";if(!(h.querySelectorAll&&h.querySelectorAll(".TEST").length===0)){k=function(m,q,p,v){q=q||s;if(!v&&q.nodeType===9&&!x(q))try{return z(q.querySelectorAll(m),p)}catch(t){}return g(m,q,p,v)};for(var l in g)k[l]=g[l];h=null}}(); +(function(){var g=s.createElement("div");g.innerHTML="
";if(!(!g.getElementsByClassName||g.getElementsByClassName("e").length===0)){g.lastChild.className="e";if(g.getElementsByClassName("e").length!==1){n.order.splice(1,0,"CLASS");n.find.CLASS=function(h,l,m){if(typeof l.getElementsByClassName!=="undefined"&&!m)return l.getElementsByClassName(h[1])};g=null}}})();var E=s.compareDocumentPosition?function(g,h){return!!(g.compareDocumentPosition(h)&16)}: +function(g,h){return g!==h&&(g.contains?g.contains(h):true)},x=function(g){return(g=(g?g.ownerDocument||g:0).documentElement)?g.nodeName!=="HTML":false},ga=function(g,h){var l=[],m="",q;for(h=h.nodeType?[h]:h;q=n.match.PSEUDO.exec(g);){m+=q[0];g=g.replace(n.match.PSEUDO,"")}g=n.relative[g]?g+"*":g;q=0;for(var p=h.length;q=0===d})};c.fn.extend({find:function(a){for(var b=this.pushStack("","find",a),d=0,f=0,e=this.length;f0)for(var j=d;j0},closest:function(a,b){if(c.isArray(a)){var d=[],f=this[0],e,j= +{},i;if(f&&a.length){e=0;for(var o=a.length;e-1:c(f).is(e)){d.push({selector:i,elem:f});delete j[i]}}f=f.parentNode}}return d}var k=c.expr.match.POS.test(a)?c(a,b||this.context):null;return this.map(function(n,r){for(;r&&r.ownerDocument&&r!==b;){if(k?k.index(r)>-1:c(r).is(a))return r;r=r.parentNode}return null})},index:function(a){if(!a||typeof a=== +"string")return c.inArray(this[0],a?c(a):this.parent().children());return c.inArray(a.jquery?a[0]:a,this)},add:function(a,b){a=typeof a==="string"?c(a,b||this.context):c.makeArray(a);b=c.merge(this.get(),a);return this.pushStack(qa(a[0])||qa(b[0])?b:c.unique(b))},andSelf:function(){return this.add(this.prevObject)}});c.each({parent:function(a){return(a=a.parentNode)&&a.nodeType!==11?a:null},parents:function(a){return c.dir(a,"parentNode")},parentsUntil:function(a,b,d){return c.dir(a,"parentNode", +d)},next:function(a){return c.nth(a,2,"nextSibling")},prev:function(a){return c.nth(a,2,"previousSibling")},nextAll:function(a){return c.dir(a,"nextSibling")},prevAll:function(a){return c.dir(a,"previousSibling")},nextUntil:function(a,b,d){return c.dir(a,"nextSibling",d)},prevUntil:function(a,b,d){return c.dir(a,"previousSibling",d)},siblings:function(a){return c.sibling(a.parentNode.firstChild,a)},children:function(a){return c.sibling(a.firstChild)},contents:function(a){return c.nodeName(a,"iframe")? +a.contentDocument||a.contentWindow.document:c.makeArray(a.childNodes)}},function(a,b){c.fn[a]=function(d,f){var e=c.map(this,b,d);eb.test(a)||(f=d);if(f&&typeof f==="string")e=c.filter(f,e);e=this.length>1?c.unique(e):e;if((this.length>1||gb.test(f))&&fb.test(a))e=e.reverse();return this.pushStack(e,a,R.call(arguments).join(","))}});c.extend({filter:function(a,b,d){if(d)a=":not("+a+")";return c.find.matches(a,b)},dir:function(a,b,d){var f=[];for(a=a[b];a&&a.nodeType!==9&&(d===w||a.nodeType!==1||!c(a).is(d));){a.nodeType=== +1&&f.push(a);a=a[b]}return f},nth:function(a,b,d){b=b||1;for(var f=0;a;a=a[d])if(a.nodeType===1&&++f===b)break;return a},sibling:function(a,b){for(var d=[];a;a=a.nextSibling)a.nodeType===1&&a!==b&&d.push(a);return d}});var Ja=/ jQuery\d+="(?:\d+|null)"/g,V=/^\s+/,Ka=/(<([\w:]+)[^>]*?)\/>/g,hb=/^(?:area|br|col|embed|hr|img|input|link|meta|param)$/i,La=/<([\w:]+)/,ib=/"},F={option:[1,""],legend:[1,"
","
"],thead:[1,"","
"],tr:[2,"","
"],td:[3,"","
"],col:[2,"","
"],area:[1,"",""],_default:[0,"",""]};F.optgroup=F.option;F.tbody=F.tfoot=F.colgroup=F.caption=F.thead;F.th=F.td;if(!c.support.htmlSerialize)F._default=[1,"div
","
"];c.fn.extend({text:function(a){if(c.isFunction(a))return this.each(function(b){var d= +c(this);d.text(a.call(this,b,d.text()))});if(typeof a!=="object"&&a!==w)return this.empty().append((this[0]&&this[0].ownerDocument||s).createTextNode(a));return c.text(this)},wrapAll:function(a){if(c.isFunction(a))return this.each(function(d){c(this).wrapAll(a.call(this,d))});if(this[0]){var b=c(a,this[0].ownerDocument).eq(0).clone(true);this[0].parentNode&&b.insertBefore(this[0]);b.map(function(){for(var d=this;d.firstChild&&d.firstChild.nodeType===1;)d=d.firstChild;return d}).append(this)}return this}, +wrapInner:function(a){if(c.isFunction(a))return this.each(function(b){c(this).wrapInner(a.call(this,b))});return this.each(function(){var b=c(this),d=b.contents();d.length?d.wrapAll(a):b.append(a)})},wrap:function(a){return this.each(function(){c(this).wrapAll(a)})},unwrap:function(){return this.parent().each(function(){c.nodeName(this,"body")||c(this).replaceWith(this.childNodes)}).end()},append:function(){return this.domManip(arguments,true,function(a){this.nodeType===1&&this.appendChild(a)})}, +prepend:function(){return this.domManip(arguments,true,function(a){this.nodeType===1&&this.insertBefore(a,this.firstChild)})},before:function(){if(this[0]&&this[0].parentNode)return this.domManip(arguments,false,function(b){this.parentNode.insertBefore(b,this)});else if(arguments.length){var a=c(arguments[0]);a.push.apply(a,this.toArray());return this.pushStack(a,"before",arguments)}},after:function(){if(this[0]&&this[0].parentNode)return this.domManip(arguments,false,function(b){this.parentNode.insertBefore(b, +this.nextSibling)});else if(arguments.length){var a=this.pushStack(this,"after",arguments);a.push.apply(a,c(arguments[0]).toArray());return a}},remove:function(a,b){for(var d=0,f;(f=this[d])!=null;d++)if(!a||c.filter(a,[f]).length){if(!b&&f.nodeType===1){c.cleanData(f.getElementsByTagName("*"));c.cleanData([f])}f.parentNode&&f.parentNode.removeChild(f)}return this},empty:function(){for(var a=0,b;(b=this[a])!=null;a++)for(b.nodeType===1&&c.cleanData(b.getElementsByTagName("*"));b.firstChild;)b.removeChild(b.firstChild); +return this},clone:function(a){var b=this.map(function(){if(!c.support.noCloneEvent&&!c.isXMLDoc(this)){var d=this.outerHTML,f=this.ownerDocument;if(!d){d=f.createElement("div");d.appendChild(this.cloneNode(true));d=d.innerHTML}return c.clean([d.replace(Ja,"").replace(/=([^="'>\s]+\/)>/g,'="$1">').replace(V,"")],f)[0]}else return this.cloneNode(true)});if(a===true){ra(this,b);ra(this.find("*"),b.find("*"))}return b},html:function(a){if(a===w)return this[0]&&this[0].nodeType===1?this[0].innerHTML.replace(Ja, +""):null;else if(typeof a==="string"&&!ta.test(a)&&(c.support.leadingWhitespace||!V.test(a))&&!F[(La.exec(a)||["",""])[1].toLowerCase()]){a=a.replace(Ka,Ma);try{for(var b=0,d=this.length;b0||e.cacheable||this.length>1?k.cloneNode(true):k)}o.length&&c.each(o,Qa)}return this}});c.fragments={};c.each({appendTo:"append",prependTo:"prepend",insertBefore:"before",insertAfter:"after",replaceAll:"replaceWith"},function(a,b){c.fn[a]=function(d){var f=[];d=c(d);var e=this.length===1&&this[0].parentNode;if(e&&e.nodeType===11&&e.childNodes.length===1&&d.length===1){d[b](this[0]); +return this}else{e=0;for(var j=d.length;e0?this.clone(true):this).get();c.fn[b].apply(c(d[e]),i);f=f.concat(i)}return this.pushStack(f,a,d.selector)}}});c.extend({clean:function(a,b,d,f){b=b||s;if(typeof b.createElement==="undefined")b=b.ownerDocument||b[0]&&b[0].ownerDocument||s;for(var e=[],j=0,i;(i=a[j])!=null;j++){if(typeof i==="number")i+="";if(i){if(typeof i==="string"&&!jb.test(i))i=b.createTextNode(i);else if(typeof i==="string"){i=i.replace(Ka,Ma);var o=(La.exec(i)||["", +""])[1].toLowerCase(),k=F[o]||F._default,n=k[0],r=b.createElement("div");for(r.innerHTML=k[1]+i+k[2];n--;)r=r.lastChild;if(!c.support.tbody){n=ib.test(i);o=o==="table"&&!n?r.firstChild&&r.firstChild.childNodes:k[1]===""&&!n?r.childNodes:[];for(k=o.length-1;k>=0;--k)c.nodeName(o[k],"tbody")&&!o[k].childNodes.length&&o[k].parentNode.removeChild(o[k])}!c.support.leadingWhitespace&&V.test(i)&&r.insertBefore(b.createTextNode(V.exec(i)[0]),r.firstChild);i=r.childNodes}if(i.nodeType)e.push(i);else e= +c.merge(e,i)}}if(d)for(j=0;e[j];j++)if(f&&c.nodeName(e[j],"script")&&(!e[j].type||e[j].type.toLowerCase()==="text/javascript"))f.push(e[j].parentNode?e[j].parentNode.removeChild(e[j]):e[j]);else{e[j].nodeType===1&&e.splice.apply(e,[j+1,0].concat(c.makeArray(e[j].getElementsByTagName("script"))));d.appendChild(e[j])}return e},cleanData:function(a){for(var b,d,f=c.cache,e=c.event.special,j=c.support.deleteExpando,i=0,o;(o=a[i])!=null;i++)if(d=o[c.expando]){b=f[d];if(b.events)for(var k in b.events)e[k]? +c.event.remove(o,k):Ca(o,k,b.handle);if(j)delete o[c.expando];else o.removeAttribute&&o.removeAttribute(c.expando);delete f[d]}}});var kb=/z-?index|font-?weight|opacity|zoom|line-?height/i,Na=/alpha\([^)]*\)/,Oa=/opacity=([^)]*)/,ha=/float/i,ia=/-([a-z])/ig,lb=/([A-Z])/g,mb=/^-?\d+(?:px)?$/i,nb=/^-?\d/,ob={position:"absolute",visibility:"hidden",display:"block"},pb=["Left","Right"],qb=["Top","Bottom"],rb=s.defaultView&&s.defaultView.getComputedStyle,Pa=c.support.cssFloat?"cssFloat":"styleFloat",ja= +function(a,b){return b.toUpperCase()};c.fn.css=function(a,b){return X(this,a,b,true,function(d,f,e){if(e===w)return c.curCSS(d,f);if(typeof e==="number"&&!kb.test(f))e+="px";c.style(d,f,e)})};c.extend({style:function(a,b,d){if(!a||a.nodeType===3||a.nodeType===8)return w;if((b==="width"||b==="height")&&parseFloat(d)<0)d=w;var f=a.style||a,e=d!==w;if(!c.support.opacity&&b==="opacity"){if(e){f.zoom=1;b=parseInt(d,10)+""==="NaN"?"":"alpha(opacity="+d*100+")";a=f.filter||c.curCSS(a,"filter")||"";f.filter= +Na.test(a)?a.replace(Na,b):b}return f.filter&&f.filter.indexOf("opacity=")>=0?parseFloat(Oa.exec(f.filter)[1])/100+"":""}if(ha.test(b))b=Pa;b=b.replace(ia,ja);if(e)f[b]=d;return f[b]},css:function(a,b,d,f){if(b==="width"||b==="height"){var e,j=b==="width"?pb:qb;function i(){e=b==="width"?a.offsetWidth:a.offsetHeight;f!=="border"&&c.each(j,function(){f||(e-=parseFloat(c.curCSS(a,"padding"+this,true))||0);if(f==="margin")e+=parseFloat(c.curCSS(a,"margin"+this,true))||0;else e-=parseFloat(c.curCSS(a, +"border"+this+"Width",true))||0})}a.offsetWidth!==0?i():c.swap(a,ob,i);return Math.max(0,Math.round(e))}return c.curCSS(a,b,d)},curCSS:function(a,b,d){var f,e=a.style;if(!c.support.opacity&&b==="opacity"&&a.currentStyle){f=Oa.test(a.currentStyle.filter||"")?parseFloat(RegExp.$1)/100+"":"";return f===""?"1":f}if(ha.test(b))b=Pa;if(!d&&e&&e[b])f=e[b];else if(rb){if(ha.test(b))b="float";b=b.replace(lb,"-$1").toLowerCase();e=a.ownerDocument.defaultView;if(!e)return null;if(a=e.getComputedStyle(a,null))f= +a.getPropertyValue(b);if(b==="opacity"&&f==="")f="1"}else if(a.currentStyle){d=b.replace(ia,ja);f=a.currentStyle[b]||a.currentStyle[d];if(!mb.test(f)&&nb.test(f)){b=e.left;var j=a.runtimeStyle.left;a.runtimeStyle.left=a.currentStyle.left;e.left=d==="fontSize"?"1em":f||0;f=e.pixelLeft+"px";e.left=b;a.runtimeStyle.left=j}}return f},swap:function(a,b,d){var f={};for(var e in b){f[e]=a.style[e];a.style[e]=b[e]}d.call(a);for(e in b)a.style[e]=f[e]}});if(c.expr&&c.expr.filters){c.expr.filters.hidden=function(a){var b= +a.offsetWidth,d=a.offsetHeight,f=a.nodeName.toLowerCase()==="tr";return b===0&&d===0&&!f?true:b>0&&d>0&&!f?false:c.curCSS(a,"display")==="none"};c.expr.filters.visible=function(a){return!c.expr.filters.hidden(a)}}var sb=J(),tb=//gi,ub=/select|textarea/i,vb=/color|date|datetime|email|hidden|month|number|password|range|search|tel|text|time|url|week/i,N=/=\?(&|$)/,ka=/\?/,wb=/(\?|&)_=.*?(&|$)/,xb=/^(\w+:)?\/\/([^\/?#]+)/,yb=/%20/g,zb=c.fn.load;c.fn.extend({load:function(a,b,d){if(typeof a!== +"string")return zb.call(this,a);else if(!this.length)return this;var f=a.indexOf(" ");if(f>=0){var e=a.slice(f,a.length);a=a.slice(0,f)}f="GET";if(b)if(c.isFunction(b)){d=b;b=null}else if(typeof b==="object"){b=c.param(b,c.ajaxSettings.traditional);f="POST"}var j=this;c.ajax({url:a,type:f,dataType:"html",data:b,complete:function(i,o){if(o==="success"||o==="notmodified")j.html(e?c("
").append(i.responseText.replace(tb,"")).find(e):i.responseText);d&&j.each(d,[i.responseText,o,i])}});return this}, +serialize:function(){return c.param(this.serializeArray())},serializeArray:function(){return this.map(function(){return this.elements?c.makeArray(this.elements):this}).filter(function(){return this.name&&!this.disabled&&(this.checked||ub.test(this.nodeName)||vb.test(this.type))}).map(function(a,b){a=c(this).val();return a==null?null:c.isArray(a)?c.map(a,function(d){return{name:b.name,value:d}}):{name:b.name,value:a}}).get()}});c.each("ajaxStart ajaxStop ajaxComplete ajaxError ajaxSuccess ajaxSend".split(" "), +function(a,b){c.fn[b]=function(d){return this.bind(b,d)}});c.extend({get:function(a,b,d,f){if(c.isFunction(b)){f=f||d;d=b;b=null}return c.ajax({type:"GET",url:a,data:b,success:d,dataType:f})},getScript:function(a,b){return c.get(a,null,b,"script")},getJSON:function(a,b,d){return c.get(a,b,d,"json")},post:function(a,b,d,f){if(c.isFunction(b)){f=f||d;d=b;b={}}return c.ajax({type:"POST",url:a,data:b,success:d,dataType:f})},ajaxSetup:function(a){c.extend(c.ajaxSettings,a)},ajaxSettings:{url:location.href, +global:true,type:"GET",contentType:"application/x-www-form-urlencoded",processData:true,async:true,xhr:A.XMLHttpRequest&&(A.location.protocol!=="file:"||!A.ActiveXObject)?function(){return new A.XMLHttpRequest}:function(){try{return new A.ActiveXObject("Microsoft.XMLHTTP")}catch(a){}},accepts:{xml:"application/xml, text/xml",html:"text/html",script:"text/javascript, application/javascript",json:"application/json, text/javascript",text:"text/plain",_default:"*/*"}},lastModified:{},etag:{},ajax:function(a){function b(){e.success&& +e.success.call(k,o,i,x);e.global&&f("ajaxSuccess",[x,e])}function d(){e.complete&&e.complete.call(k,x,i);e.global&&f("ajaxComplete",[x,e]);e.global&&!--c.active&&c.event.trigger("ajaxStop")}function f(q,p){(e.context?c(e.context):c.event).trigger(q,p)}var e=c.extend(true,{},c.ajaxSettings,a),j,i,o,k=a&&a.context||e,n=e.type.toUpperCase();if(e.data&&e.processData&&typeof e.data!=="string")e.data=c.param(e.data,e.traditional);if(e.dataType==="jsonp"){if(n==="GET")N.test(e.url)||(e.url+=(ka.test(e.url)? +"&":"?")+(e.jsonp||"callback")+"=?");else if(!e.data||!N.test(e.data))e.data=(e.data?e.data+"&":"")+(e.jsonp||"callback")+"=?";e.dataType="json"}if(e.dataType==="json"&&(e.data&&N.test(e.data)||N.test(e.url))){j=e.jsonpCallback||"jsonp"+sb++;if(e.data)e.data=(e.data+"").replace(N,"="+j+"$1");e.url=e.url.replace(N,"="+j+"$1");e.dataType="script";A[j]=A[j]||function(q){o=q;b();d();A[j]=w;try{delete A[j]}catch(p){}z&&z.removeChild(C)}}if(e.dataType==="script"&&e.cache===null)e.cache=false;if(e.cache=== +false&&n==="GET"){var r=J(),u=e.url.replace(wb,"$1_="+r+"$2");e.url=u+(u===e.url?(ka.test(e.url)?"&":"?")+"_="+r:"")}if(e.data&&n==="GET")e.url+=(ka.test(e.url)?"&":"?")+e.data;e.global&&!c.active++&&c.event.trigger("ajaxStart");r=(r=xb.exec(e.url))&&(r[1]&&r[1]!==location.protocol||r[2]!==location.host);if(e.dataType==="script"&&n==="GET"&&r){var z=s.getElementsByTagName("head")[0]||s.documentElement,C=s.createElement("script");C.src=e.url;if(e.scriptCharset)C.charset=e.scriptCharset;if(!j){var B= +false;C.onload=C.onreadystatechange=function(){if(!B&&(!this.readyState||this.readyState==="loaded"||this.readyState==="complete")){B=true;b();d();C.onload=C.onreadystatechange=null;z&&C.parentNode&&z.removeChild(C)}}}z.insertBefore(C,z.firstChild);return w}var E=false,x=e.xhr();if(x){e.username?x.open(n,e.url,e.async,e.username,e.password):x.open(n,e.url,e.async);try{if(e.data||a&&a.contentType)x.setRequestHeader("Content-Type",e.contentType);if(e.ifModified){c.lastModified[e.url]&&x.setRequestHeader("If-Modified-Since", +c.lastModified[e.url]);c.etag[e.url]&&x.setRequestHeader("If-None-Match",c.etag[e.url])}r||x.setRequestHeader("X-Requested-With","XMLHttpRequest");x.setRequestHeader("Accept",e.dataType&&e.accepts[e.dataType]?e.accepts[e.dataType]+", */*":e.accepts._default)}catch(ga){}if(e.beforeSend&&e.beforeSend.call(k,x,e)===false){e.global&&!--c.active&&c.event.trigger("ajaxStop");x.abort();return false}e.global&&f("ajaxSend",[x,e]);var g=x.onreadystatechange=function(q){if(!x||x.readyState===0||q==="abort"){E|| +d();E=true;if(x)x.onreadystatechange=c.noop}else if(!E&&x&&(x.readyState===4||q==="timeout")){E=true;x.onreadystatechange=c.noop;i=q==="timeout"?"timeout":!c.httpSuccess(x)?"error":e.ifModified&&c.httpNotModified(x,e.url)?"notmodified":"success";var p;if(i==="success")try{o=c.httpData(x,e.dataType,e)}catch(v){i="parsererror";p=v}if(i==="success"||i==="notmodified")j||b();else c.handleError(e,x,i,p);d();q==="timeout"&&x.abort();if(e.async)x=null}};try{var h=x.abort;x.abort=function(){x&&h.call(x); +g("abort")}}catch(l){}e.async&&e.timeout>0&&setTimeout(function(){x&&!E&&g("timeout")},e.timeout);try{x.send(n==="POST"||n==="PUT"||n==="DELETE"?e.data:null)}catch(m){c.handleError(e,x,null,m);d()}e.async||g();return x}},handleError:function(a,b,d,f){if(a.error)a.error.call(a.context||a,b,d,f);if(a.global)(a.context?c(a.context):c.event).trigger("ajaxError",[b,a,f])},active:0,httpSuccess:function(a){try{return!a.status&&location.protocol==="file:"||a.status>=200&&a.status<300||a.status===304||a.status=== +1223||a.status===0}catch(b){}return false},httpNotModified:function(a,b){var d=a.getResponseHeader("Last-Modified"),f=a.getResponseHeader("Etag");if(d)c.lastModified[b]=d;if(f)c.etag[b]=f;return a.status===304||a.status===0},httpData:function(a,b,d){var f=a.getResponseHeader("content-type")||"",e=b==="xml"||!b&&f.indexOf("xml")>=0;a=e?a.responseXML:a.responseText;e&&a.documentElement.nodeName==="parsererror"&&c.error("parsererror");if(d&&d.dataFilter)a=d.dataFilter(a,b);if(typeof a==="string")if(b=== +"json"||!b&&f.indexOf("json")>=0)a=c.parseJSON(a);else if(b==="script"||!b&&f.indexOf("javascript")>=0)c.globalEval(a);return a},param:function(a,b){function d(i,o){if(c.isArray(o))c.each(o,function(k,n){b||/\[\]$/.test(i)?f(i,n):d(i+"["+(typeof n==="object"||c.isArray(n)?k:"")+"]",n)});else!b&&o!=null&&typeof o==="object"?c.each(o,function(k,n){d(i+"["+k+"]",n)}):f(i,o)}function f(i,o){o=c.isFunction(o)?o():o;e[e.length]=encodeURIComponent(i)+"="+encodeURIComponent(o)}var e=[];if(b===w)b=c.ajaxSettings.traditional; +if(c.isArray(a)||a.jquery)c.each(a,function(){f(this.name,this.value)});else for(var j in a)d(j,a[j]);return e.join("&").replace(yb,"+")}});var la={},Ab=/toggle|show|hide/,Bb=/^([+-]=)?([\d+-.]+)(.*)$/,W,va=[["height","marginTop","marginBottom","paddingTop","paddingBottom"],["width","marginLeft","marginRight","paddingLeft","paddingRight"],["opacity"]];c.fn.extend({show:function(a,b){if(a||a===0)return this.animate(K("show",3),a,b);else{a=0;for(b=this.length;a").appendTo("body");f=e.css("display");if(f==="none")f="block";e.remove();la[d]=f}c.data(this[a],"olddisplay",f)}}a=0;for(b=this.length;a=0;f--)if(d[f].elem===this){b&&d[f](true);d.splice(f,1)}});b||this.dequeue();return this}});c.each({slideDown:K("show",1),slideUp:K("hide",1),slideToggle:K("toggle",1),fadeIn:{opacity:"show"},fadeOut:{opacity:"hide"}},function(a,b){c.fn[a]=function(d,f){return this.animate(b,d,f)}});c.extend({speed:function(a,b,d){var f=a&&typeof a==="object"?a:{complete:d||!d&&b||c.isFunction(a)&&a,duration:a,easing:d&&b||b&&!c.isFunction(b)&&b};f.duration=c.fx.off?0:typeof f.duration=== +"number"?f.duration:c.fx.speeds[f.duration]||c.fx.speeds._default;f.old=f.complete;f.complete=function(){f.queue!==false&&c(this).dequeue();c.isFunction(f.old)&&f.old.call(this)};return f},easing:{linear:function(a,b,d,f){return d+f*a},swing:function(a,b,d,f){return(-Math.cos(a*Math.PI)/2+0.5)*f+d}},timers:[],fx:function(a,b,d){this.options=b;this.elem=a;this.prop=d;if(!b.orig)b.orig={}}});c.fx.prototype={update:function(){this.options.step&&this.options.step.call(this.elem,this.now,this);(c.fx.step[this.prop]|| +c.fx.step._default)(this);if((this.prop==="height"||this.prop==="width")&&this.elem.style)this.elem.style.display="block"},cur:function(a){if(this.elem[this.prop]!=null&&(!this.elem.style||this.elem.style[this.prop]==null))return this.elem[this.prop];return(a=parseFloat(c.css(this.elem,this.prop,a)))&&a>-10000?a:parseFloat(c.curCSS(this.elem,this.prop))||0},custom:function(a,b,d){function f(j){return e.step(j)}this.startTime=J();this.start=a;this.end=b;this.unit=d||this.unit||"px";this.now=this.start; +this.pos=this.state=0;var e=this;f.elem=this.elem;if(f()&&c.timers.push(f)&&!W)W=setInterval(c.fx.tick,13)},show:function(){this.options.orig[this.prop]=c.style(this.elem,this.prop);this.options.show=true;this.custom(this.prop==="width"||this.prop==="height"?1:0,this.cur());c(this.elem).show()},hide:function(){this.options.orig[this.prop]=c.style(this.elem,this.prop);this.options.hide=true;this.custom(this.cur(),0)},step:function(a){var b=J(),d=true;if(a||b>=this.options.duration+this.startTime){this.now= +this.end;this.pos=this.state=1;this.update();this.options.curAnim[this.prop]=true;for(var f in this.options.curAnim)if(this.options.curAnim[f]!==true)d=false;if(d){if(this.options.display!=null){this.elem.style.overflow=this.options.overflow;a=c.data(this.elem,"olddisplay");this.elem.style.display=a?a:this.options.display;if(c.css(this.elem,"display")==="none")this.elem.style.display="block"}this.options.hide&&c(this.elem).hide();if(this.options.hide||this.options.show)for(var e in this.options.curAnim)c.style(this.elem, +e,this.options.orig[e]);this.options.complete.call(this.elem)}return false}else{e=b-this.startTime;this.state=e/this.options.duration;a=this.options.easing||(c.easing.swing?"swing":"linear");this.pos=c.easing[this.options.specialEasing&&this.options.specialEasing[this.prop]||a](this.state,e,0,1,this.options.duration);this.now=this.start+(this.end-this.start)*this.pos;this.update()}return true}};c.extend(c.fx,{tick:function(){for(var a=c.timers,b=0;b
"; +a.insertBefore(b,a.firstChild);d=b.firstChild;f=d.firstChild;e=d.nextSibling.firstChild.firstChild;this.doesNotAddBorder=f.offsetTop!==5;this.doesAddBorderForTableAndCells=e.offsetTop===5;f.style.position="fixed";f.style.top="20px";this.supportsFixedPosition=f.offsetTop===20||f.offsetTop===15;f.style.position=f.style.top="";d.style.overflow="hidden";d.style.position="relative";this.subtractsBorderForOverflowNotVisible=f.offsetTop===-5;this.doesNotIncludeMarginInBodyOffset=a.offsetTop!==j;a.removeChild(b); +c.offset.initialize=c.noop},bodyOffset:function(a){var b=a.offsetTop,d=a.offsetLeft;c.offset.initialize();if(c.offset.doesNotIncludeMarginInBodyOffset){b+=parseFloat(c.curCSS(a,"marginTop",true))||0;d+=parseFloat(c.curCSS(a,"marginLeft",true))||0}return{top:b,left:d}},setOffset:function(a,b,d){if(/static/.test(c.curCSS(a,"position")))a.style.position="relative";var f=c(a),e=f.offset(),j=parseInt(c.curCSS(a,"top",true),10)||0,i=parseInt(c.curCSS(a,"left",true),10)||0;if(c.isFunction(b))b=b.call(a, +d,e);d={top:b.top-e.top+j,left:b.left-e.left+i};"using"in b?b.using.call(a,d):f.css(d)}};c.fn.extend({position:function(){if(!this[0])return null;var a=this[0],b=this.offsetParent(),d=this.offset(),f=/^body|html$/i.test(b[0].nodeName)?{top:0,left:0}:b.offset();d.top-=parseFloat(c.curCSS(a,"marginTop",true))||0;d.left-=parseFloat(c.curCSS(a,"marginLeft",true))||0;f.top+=parseFloat(c.curCSS(b[0],"borderTopWidth",true))||0;f.left+=parseFloat(c.curCSS(b[0],"borderLeftWidth",true))||0;return{top:d.top- +f.top,left:d.left-f.left}},offsetParent:function(){return this.map(function(){for(var a=this.offsetParent||s.body;a&&!/^body|html$/i.test(a.nodeName)&&c.css(a,"position")==="static";)a=a.offsetParent;return a})}});c.each(["Left","Top"],function(a,b){var d="scroll"+b;c.fn[d]=function(f){var e=this[0],j;if(!e)return null;if(f!==w)return this.each(function(){if(j=wa(this))j.scrollTo(!a?f:c(j).scrollLeft(),a?f:c(j).scrollTop());else this[d]=f});else return(j=wa(e))?"pageXOffset"in j?j[a?"pageYOffset": +"pageXOffset"]:c.support.boxModel&&j.document.documentElement[d]||j.document.body[d]:e[d]}});c.each(["Height","Width"],function(a,b){var d=b.toLowerCase();c.fn["inner"+b]=function(){return this[0]?c.css(this[0],d,false,"padding"):null};c.fn["outer"+b]=function(f){return this[0]?c.css(this[0],d,false,f?"margin":"border"):null};c.fn[d]=function(f){var e=this[0];if(!e)return f==null?null:this;if(c.isFunction(f))return this.each(function(j){var i=c(this);i[d](f.call(this,j,i[d]()))});return"scrollTo"in +e&&e.document?e.document.compatMode==="CSS1Compat"&&e.document.documentElement["client"+b]||e.document.body["client"+b]:e.nodeType===9?Math.max(e.documentElement["client"+b],e.body["scroll"+b],e.documentElement["scroll"+b],e.body["offset"+b],e.documentElement["offset"+b]):f===w?c.css(e,d):this.css(d,typeof f==="string"?f:f+"px")}});A.jQuery=A.$=c})(window); diff --git a/doc/build/html/_static/minus.png b/doc/build/html/_static/minus.png new file mode 100644 index 0000000..da1c562 Binary files /dev/null and b/doc/build/html/_static/minus.png differ diff --git a/doc/build/html/_static/plus.png b/doc/build/html/_static/plus.png new file mode 100644 index 0000000..b3cb374 Binary files /dev/null and b/doc/build/html/_static/plus.png differ diff --git a/doc/build/html/_static/pygments.css b/doc/build/html/_static/pygments.css new file mode 100644 index 0000000..1a14f2a --- /dev/null +++ b/doc/build/html/_static/pygments.css @@ -0,0 +1,62 @@ +.highlight .hll { background-color: #ffffcc } +.highlight { background: #eeffcc; } +.highlight .c { color: #408090; font-style: italic } /* Comment */ +.highlight .err { border: 1px solid #FF0000 } /* Error */ +.highlight .k { color: #007020; font-weight: bold } /* Keyword */ +.highlight .o { color: #666666 } /* Operator */ +.highlight .cm { color: #408090; font-style: italic } /* Comment.Multiline */ +.highlight .cp { color: #007020 } /* Comment.Preproc */ +.highlight .c1 { color: #408090; font-style: italic } /* Comment.Single */ +.highlight .cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */ +.highlight .gd { color: #A00000 } /* Generic.Deleted */ +.highlight .ge { font-style: italic } /* Generic.Emph */ +.highlight .gr { color: #FF0000 } /* Generic.Error */ +.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ +.highlight .gi { color: #00A000 } /* Generic.Inserted */ +.highlight .go { color: #303030 } /* Generic.Output */ +.highlight .gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */ +.highlight .gs { font-weight: bold } /* Generic.Strong */ +.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ +.highlight .gt { color: #0040D0 } /* Generic.Traceback */ +.highlight .kc { color: #007020; font-weight: bold } /* Keyword.Constant */ +.highlight .kd { color: #007020; font-weight: bold } /* Keyword.Declaration */ +.highlight .kn { color: #007020; font-weight: bold } /* Keyword.Namespace */ +.highlight .kp { color: #007020 } /* Keyword.Pseudo */ +.highlight .kr { color: #007020; font-weight: bold } /* Keyword.Reserved */ +.highlight .kt { color: #902000 } /* Keyword.Type */ +.highlight .m { color: #208050 } /* Literal.Number */ +.highlight .s { color: #4070a0 } /* Literal.String */ +.highlight .na { color: #4070a0 } /* Name.Attribute */ +.highlight .nb { color: #007020 } /* Name.Builtin */ +.highlight .nc { color: #0e84b5; font-weight: bold } /* Name.Class */ +.highlight .no { color: #60add5 } /* Name.Constant */ +.highlight .nd { color: #555555; font-weight: bold } /* Name.Decorator */ +.highlight .ni { color: #d55537; font-weight: bold } /* Name.Entity */ +.highlight .ne { color: #007020 } /* Name.Exception */ +.highlight .nf { color: #06287e } /* Name.Function */ +.highlight .nl { color: #002070; font-weight: bold } /* Name.Label */ +.highlight .nn { color: #0e84b5; font-weight: bold } /* Name.Namespace */ +.highlight .nt { color: #062873; font-weight: bold } /* Name.Tag */ +.highlight .nv { color: #bb60d5 } /* Name.Variable */ +.highlight .ow { color: #007020; font-weight: bold } /* Operator.Word */ +.highlight .w { color: #bbbbbb } /* Text.Whitespace */ +.highlight .mf { color: #208050 } /* Literal.Number.Float */ +.highlight .mh { color: #208050 } /* Literal.Number.Hex */ +.highlight .mi { color: #208050 } /* Literal.Number.Integer */ +.highlight .mo { color: #208050 } /* Literal.Number.Oct */ +.highlight .sb { color: #4070a0 } /* Literal.String.Backtick */ +.highlight .sc { color: #4070a0 } /* Literal.String.Char */ +.highlight .sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */ +.highlight .s2 { color: #4070a0 } /* Literal.String.Double */ +.highlight .se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */ +.highlight .sh { color: #4070a0 } /* Literal.String.Heredoc */ +.highlight .si { color: #70a0d0; font-style: italic } /* Literal.String.Interpol */ +.highlight .sx { color: #c65d09 } /* Literal.String.Other */ +.highlight .sr { color: #235388 } /* Literal.String.Regex */ +.highlight .s1 { color: #4070a0 } /* Literal.String.Single */ +.highlight .ss { color: #517918 } /* Literal.String.Symbol */ +.highlight .bp { color: #007020 } /* Name.Builtin.Pseudo */ +.highlight .vc { color: #bb60d5 } /* Name.Variable.Class */ +.highlight .vg { color: #bb60d5 } /* Name.Variable.Global */ +.highlight .vi { color: #bb60d5 } /* Name.Variable.Instance */ +.highlight .il { color: #208050 } /* Literal.Number.Integer.Long */ \ No newline at end of file diff --git a/doc/build/html/_static/sat_v5.0.png b/doc/build/html/_static/sat_v5.0.png new file mode 100644 index 0000000..1057f5b Binary files /dev/null and b/doc/build/html/_static/sat_v5.0.png differ diff --git a/doc/build/html/_static/searchtools.js b/doc/build/html/_static/searchtools.js new file mode 100644 index 0000000..663be4c --- /dev/null +++ b/doc/build/html/_static/searchtools.js @@ -0,0 +1,560 @@ +/* + * searchtools.js_t + * ~~~~~~~~~~~~~~~~ + * + * Sphinx JavaScript utilties for the full-text search. + * + * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/** + * helper function to return a node containing the + * search summary for a given text. keywords is a list + * of stemmed words, hlwords is the list of normal, unstemmed + * words. the first one is used to find the occurance, the + * latter for highlighting it. + */ + +jQuery.makeSearchSummary = function(text, keywords, hlwords) { + var textLower = text.toLowerCase(); + var start = 0; + $.each(keywords, function() { + var i = textLower.indexOf(this.toLowerCase()); + if (i > -1) + start = i; + }); + start = Math.max(start - 120, 0); + var excerpt = ((start > 0) ? '...' : '') + + $.trim(text.substr(start, 240)) + + ((start + 240 - text.length) ? '...' : ''); + var rv = $('
').text(excerpt); + $.each(hlwords, function() { + rv = rv.highlightText(this, 'highlighted'); + }); + return rv; +} + + +/** + * Porter Stemmer + */ +var Stemmer = function() { + + var step2list = { + ational: 'ate', + tional: 'tion', + enci: 'ence', + anci: 'ance', + izer: 'ize', + bli: 'ble', + alli: 'al', + entli: 'ent', + eli: 'e', + ousli: 'ous', + ization: 'ize', + ation: 'ate', + ator: 'ate', + alism: 'al', + iveness: 'ive', + fulness: 'ful', + ousness: 'ous', + aliti: 'al', + iviti: 'ive', + biliti: 'ble', + logi: 'log' + }; + + var step3list = { + icate: 'ic', + ative: '', + alize: 'al', + iciti: 'ic', + ical: 'ic', + ful: '', + ness: '' + }; + + var c = "[^aeiou]"; // consonant + var v = "[aeiouy]"; // vowel + var C = c + "[^aeiouy]*"; // consonant sequence + var V = v + "[aeiou]*"; // vowel sequence + + var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0 + var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1 + var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1 + var s_v = "^(" + C + ")?" + v; // vowel in stem + + this.stemWord = function (w) { + var stem; + var suffix; + var firstch; + var origword = w; + + if (w.length < 3) + return w; + + var re; + var re2; + var re3; + var re4; + + firstch = w.substr(0,1); + if (firstch == "y") + w = firstch.toUpperCase() + w.substr(1); + + // Step 1a + re = /^(.+?)(ss|i)es$/; + re2 = /^(.+?)([^s])s$/; + + if (re.test(w)) + w = w.replace(re,"$1$2"); + else if (re2.test(w)) + w = w.replace(re2,"$1$2"); + + // Step 1b + re = /^(.+?)eed$/; + re2 = /^(.+?)(ed|ing)$/; + if (re.test(w)) { + var fp = re.exec(w); + re = new RegExp(mgr0); + if (re.test(fp[1])) { + re = /.$/; + w = w.replace(re,""); + } + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1]; + re2 = new RegExp(s_v); + if (re2.test(stem)) { + w = stem; + re2 = /(at|bl|iz)$/; + re3 = new RegExp("([^aeiouylsz])\\1$"); + re4 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re2.test(w)) + w = w + "e"; + else if (re3.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + else if (re4.test(w)) + w = w + "e"; + } + } + + // Step 1c + re = /^(.+?)y$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(s_v); + if (re.test(stem)) + w = stem + "i"; + } + + // Step 2 + re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step2list[suffix]; + } + + // Step 3 + re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step3list[suffix]; + } + + // Step 4 + re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/; + re2 = /^(.+?)(s|t)(ion)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + if (re.test(stem)) + w = stem; + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1] + fp[2]; + re2 = new RegExp(mgr1); + if (re2.test(stem)) + w = stem; + } + + // Step 5 + re = /^(.+?)e$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + re2 = new RegExp(meq1); + re3 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) + w = stem; + } + re = /ll$/; + re2 = new RegExp(mgr1); + if (re.test(w) && re2.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + + // and turn initial Y back to y + if (firstch == "y") + w = firstch.toLowerCase() + w.substr(1); + return w; + } +} + + +/** + * Search Module + */ +var Search = { + + _index : null, + _queued_query : null, + _pulse_status : -1, + + init : function() { + var params = $.getQueryParameters(); + if (params.q) { + var query = params.q[0]; + $('input[name="q"]')[0].value = query; + this.performSearch(query); + } + }, + + loadIndex : function(url) { + $.ajax({type: "GET", url: url, data: null, success: null, + dataType: "script", cache: true}); + }, + + setIndex : function(index) { + var q; + this._index = index; + if ((q = this._queued_query) !== null) { + this._queued_query = null; + Search.query(q); + } + }, + + hasIndex : function() { + return this._index !== null; + }, + + deferQuery : function(query) { + this._queued_query = query; + }, + + stopPulse : function() { + this._pulse_status = 0; + }, + + startPulse : function() { + if (this._pulse_status >= 0) + return; + function pulse() { + Search._pulse_status = (Search._pulse_status + 1) % 4; + var dotString = ''; + for (var i = 0; i < Search._pulse_status; i++) + dotString += '.'; + Search.dots.text(dotString); + if (Search._pulse_status > -1) + window.setTimeout(pulse, 500); + }; + pulse(); + }, + + /** + * perform a search for something + */ + performSearch : function(query) { + // create the required interface elements + this.out = $('#search-results'); + this.title = $('

' + _('Searching') + '

').appendTo(this.out); + this.dots = $('').appendTo(this.title); + this.status = $('

').appendTo(this.out); + this.output = $('
    ').appendTo(this.out); + + $('#search-progress').text(_('Preparing search...')); + this.startPulse(); + + // index already loaded, the browser was quick! + if (this.hasIndex()) + this.query(query); + else + this.deferQuery(query); + }, + + query : function(query) { + var stopwords = ["and","then","into","it","as","are","in","if","for","no","there","their","was","is","be","to","that","but","they","not","such","with","by","a","on","these","of","will","this","near","the","or","at"]; + + // Stem the searchterms and add them to the correct list + var stemmer = new Stemmer(); + var searchterms = []; + var excluded = []; + var hlterms = []; + var tmp = query.split(/\s+/); + var objectterms = []; + for (var i = 0; i < tmp.length; i++) { + if (tmp[i] != "") { + objectterms.push(tmp[i].toLowerCase()); + } + + if ($u.indexOf(stopwords, tmp[i]) != -1 || tmp[i].match(/^\d+$/) || + tmp[i] == "") { + // skip this "word" + continue; + } + // stem the word + var word = stemmer.stemWord(tmp[i]).toLowerCase(); + // select the correct list + if (word[0] == '-') { + var toAppend = excluded; + word = word.substr(1); + } + else { + var toAppend = searchterms; + hlterms.push(tmp[i].toLowerCase()); + } + // only add if not already in the list + if (!$.contains(toAppend, word)) + toAppend.push(word); + }; + var highlightstring = '?highlight=' + $.urlencode(hlterms.join(" ")); + + // console.debug('SEARCH: searching for:'); + // console.info('required: ', searchterms); + // console.info('excluded: ', excluded); + + // prepare search + var filenames = this._index.filenames; + var titles = this._index.titles; + var terms = this._index.terms; + var fileMap = {}; + var files = null; + // different result priorities + var importantResults = []; + var objectResults = []; + var regularResults = []; + var unimportantResults = []; + $('#search-progress').empty(); + + // lookup as object + for (var i = 0; i < objectterms.length; i++) { + var others = [].concat(objectterms.slice(0,i), + objectterms.slice(i+1, objectterms.length)) + var results = this.performObjectSearch(objectterms[i], others); + // Assume first word is most likely to be the object, + // other words more likely to be in description. + // Therefore put matches for earlier words first. + // (Results are eventually used in reverse order). + objectResults = results[0].concat(objectResults); + importantResults = results[1].concat(importantResults); + unimportantResults = results[2].concat(unimportantResults); + } + + // perform the search on the required terms + for (var i = 0; i < searchterms.length; i++) { + var word = searchterms[i]; + // no match but word was a required one + if ((files = terms[word]) == null) + break; + if (files.length == undefined) { + files = [files]; + } + // create the mapping + for (var j = 0; j < files.length; j++) { + var file = files[j]; + if (file in fileMap) + fileMap[file].push(word); + else + fileMap[file] = [word]; + } + } + + // now check if the files don't contain excluded terms + for (var file in fileMap) { + var valid = true; + + // check if all requirements are matched + if (fileMap[file].length != searchterms.length) + continue; + + // ensure that none of the excluded terms is in the + // search result. + for (var i = 0; i < excluded.length; i++) { + if (terms[excluded[i]] == file || + $.contains(terms[excluded[i]] || [], file)) { + valid = false; + break; + } + } + + // if we have still a valid result we can add it + // to the result list + if (valid) + regularResults.push([filenames[file], titles[file], '', null]); + } + + // delete unused variables in order to not waste + // memory until list is retrieved completely + delete filenames, titles, terms; + + // now sort the regular results descending by title + regularResults.sort(function(a, b) { + var left = a[1].toLowerCase(); + var right = b[1].toLowerCase(); + return (left > right) ? -1 : ((left < right) ? 1 : 0); + }); + + // combine all results + var results = unimportantResults.concat(regularResults) + .concat(objectResults).concat(importantResults); + + // print the results + var resultCount = results.length; + function displayNextItem() { + // results left, load the summary and display it + if (results.length) { + var item = results.pop(); + var listItem = $('
  • '); + if (DOCUMENTATION_OPTIONS.FILE_SUFFIX == '') { + // dirhtml builder + var dirname = item[0] + '/'; + if (dirname.match(/\/index\/$/)) { + dirname = dirname.substring(0, dirname.length-6); + } else if (dirname == 'index/') { + dirname = ''; + } + listItem.append($('').attr('href', + DOCUMENTATION_OPTIONS.URL_ROOT + dirname + + highlightstring + item[2]).html(item[1])); + } else { + // normal html builders + listItem.append($('').attr('href', + item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX + + highlightstring + item[2]).html(item[1])); + } + if (item[3]) { + listItem.append($(' (' + item[3] + ')')); + Search.output.append(listItem); + listItem.slideDown(5, function() { + displayNextItem(); + }); + } else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) { + $.get(DOCUMENTATION_OPTIONS.URL_ROOT + '_sources/' + + item[0] + '.txt', function(data) { + if (data != '') { + listItem.append($.makeSearchSummary(data, searchterms, hlterms)); + Search.output.append(listItem); + } + listItem.slideDown(5, function() { + displayNextItem(); + }); + }, "text"); + } else { + // no source available, just display title + Search.output.append(listItem); + listItem.slideDown(5, function() { + displayNextItem(); + }); + } + } + // search finished, update title and status message + else { + Search.stopPulse(); + Search.title.text(_('Search Results')); + if (!resultCount) + Search.status.text(_('Your search did not match any documents. Please make sure that all words are spelled correctly and that you\'ve selected enough categories.')); + else + Search.status.text(_('Search finished, found %s page(s) matching the search query.').replace('%s', resultCount)); + Search.status.fadeIn(500); + } + } + displayNextItem(); + }, + + performObjectSearch : function(object, otherterms) { + var filenames = this._index.filenames; + var objects = this._index.objects; + var objnames = this._index.objnames; + var titles = this._index.titles; + + var importantResults = []; + var objectResults = []; + var unimportantResults = []; + + for (var prefix in objects) { + for (var name in objects[prefix]) { + var fullname = (prefix ? prefix + '.' : '') + name; + if (fullname.toLowerCase().indexOf(object) > -1) { + var match = objects[prefix][name]; + var objname = objnames[match[1]][2]; + var title = titles[match[0]]; + // If more than one term searched for, we require other words to be + // found in the name/title/description + if (otherterms.length > 0) { + var haystack = (prefix + ' ' + name + ' ' + + objname + ' ' + title).toLowerCase(); + var allfound = true; + for (var i = 0; i < otherterms.length; i++) { + if (haystack.indexOf(otherterms[i]) == -1) { + allfound = false; + break; + } + } + if (!allfound) { + continue; + } + } + var descr = objname + _(', in ') + title; + anchor = match[3]; + if (anchor == '') + anchor = fullname; + else if (anchor == '-') + anchor = objnames[match[1]][1] + '-' + fullname; + result = [filenames[match[0]], fullname, '#'+anchor, descr]; + switch (match[2]) { + case 1: objectResults.push(result); break; + case 0: importantResults.push(result); break; + case 2: unimportantResults.push(result); break; + } + } + } + } + + // sort results descending + objectResults.sort(function(a, b) { + return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0); + }); + + importantResults.sort(function(a, b) { + return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0); + }); + + unimportantResults.sort(function(a, b) { + return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0); + }); + + return [importantResults, objectResults, unimportantResults] + } +} + +$(document).ready(function() { + Search.init(); +}); \ No newline at end of file diff --git a/doc/build/html/_static/underscore.js b/doc/build/html/_static/underscore.js new file mode 100644 index 0000000..5d89914 --- /dev/null +++ b/doc/build/html/_static/underscore.js @@ -0,0 +1,23 @@ +// Underscore.js 0.5.5 +// (c) 2009 Jeremy Ashkenas, DocumentCloud Inc. +// Underscore is freely distributable under the terms of the MIT license. +// Portions of Underscore are inspired by or borrowed from Prototype.js, +// Oliver Steele's Functional, and John Resig's Micro-Templating. +// For all details and documentation: +// http://documentcloud.github.com/underscore/ +(function(){var j=this,n=j._,i=function(a){this._wrapped=a},m=typeof StopIteration!=="undefined"?StopIteration:"__break__",b=j._=function(a){return new i(a)};if(typeof exports!=="undefined")exports._=b;var k=Array.prototype.slice,o=Array.prototype.unshift,p=Object.prototype.toString,q=Object.prototype.hasOwnProperty,r=Object.prototype.propertyIsEnumerable;b.VERSION="0.5.5";b.each=function(a,c,d){try{if(a.forEach)a.forEach(c,d);else if(b.isArray(a)||b.isArguments(a))for(var e=0,f=a.length;e=e.computed&&(e={value:f,computed:g})});return e.value};b.min=function(a,c,d){if(!c&&b.isArray(a))return Math.min.apply(Math,a);var e={computed:Infinity};b.each(a,function(f,g,h){g=c?c.call(d,f,g,h):f;gf?1:0}),"value")};b.sortedIndex=function(a,c,d){d=d||b.identity;for(var e=0,f=a.length;e>1;d(a[g])=0})})};b.zip=function(){for(var a=b.toArray(arguments),c=b.max(b.pluck(a,"length")),d=new Array(c),e=0;e0?f-c:c-f)>=0)return e;e[g++]=f}};b.bind=function(a,c){var d=b.rest(arguments,2);return function(){return a.apply(c||j,d.concat(b.toArray(arguments)))}};b.bindAll=function(a){var c=b.rest(arguments);if(c.length==0)c=b.functions(a);b.each(c,function(d){a[d]=b.bind(a[d],a)}); +return a};b.delay=function(a,c){var d=b.rest(arguments,2);return setTimeout(function(){return a.apply(a,d)},c)};b.defer=function(a){return b.delay.apply(b,[a,1].concat(b.rest(arguments)))};b.wrap=function(a,c){return function(){var d=[a].concat(b.toArray(arguments));return c.apply(c,d)}};b.compose=function(){var a=b.toArray(arguments);return function(){for(var c=b.toArray(arguments),d=a.length-1;d>=0;d--)c=[a[d].apply(this,c)];return c[0]}};b.keys=function(a){if(b.isArray(a))return b.range(0,a.length); +var c=[];for(var d in a)q.call(a,d)&&c.push(d);return c};b.values=function(a){return b.map(a,b.identity)};b.functions=function(a){return b.select(b.keys(a),function(c){return b.isFunction(a[c])}).sort()};b.extend=function(a,c){for(var d in c)a[d]=c[d];return a};b.clone=function(a){if(b.isArray(a))return a.slice(0);return b.extend({},a)};b.tap=function(a,c){c(a);return a};b.isEqual=function(a,c){if(a===c)return true;var d=typeof a;if(d!=typeof c)return false;if(a==c)return true;if(!a&&c||a&&!c)return false; +if(a.isEqual)return a.isEqual(c);if(b.isDate(a)&&b.isDate(c))return a.getTime()===c.getTime();if(b.isNaN(a)&&b.isNaN(c))return true;if(b.isRegExp(a)&&b.isRegExp(c))return a.source===c.source&&a.global===c.global&&a.ignoreCase===c.ignoreCase&&a.multiline===c.multiline;if(d!=="object")return false;if(a.length&&a.length!==c.length)return false;d=b.keys(a);var e=b.keys(c);if(d.length!=e.length)return false;for(var f in a)if(!b.isEqual(a[f],c[f]))return false;return true};b.isEmpty=function(a){return b.keys(a).length== +0};b.isElement=function(a){return!!(a&&a.nodeType==1)};b.isArray=function(a){return!!(a&&a.concat&&a.unshift)};b.isArguments=function(a){return a&&b.isNumber(a.length)&&!b.isArray(a)&&!r.call(a,"length")};b.isFunction=function(a){return!!(a&&a.constructor&&a.call&&a.apply)};b.isString=function(a){return!!(a===""||a&&a.charCodeAt&&a.substr)};b.isNumber=function(a){return p.call(a)==="[object Number]"};b.isDate=function(a){return!!(a&&a.getTimezoneOffset&&a.setUTCFullYear)};b.isRegExp=function(a){return!!(a&& +a.test&&a.exec&&(a.ignoreCase||a.ignoreCase===false))};b.isNaN=function(a){return b.isNumber(a)&&isNaN(a)};b.isNull=function(a){return a===null};b.isUndefined=function(a){return typeof a=="undefined"};b.noConflict=function(){j._=n;return this};b.identity=function(a){return a};b.breakLoop=function(){throw m;};var s=0;b.uniqueId=function(a){var c=s++;return a?a+c:c};b.template=function(a,c){a=new Function("obj","var p=[],print=function(){p.push.apply(p,arguments);};with(obj){p.push('"+a.replace(/[\r\t\n]/g, +" ").replace(/'(?=[^%]*%>)/g,"\t").split("'").join("\\'").split("\t").join("'").replace(/<%=(.+?)%>/g,"',$1,'").split("<%").join("');").split("%>").join("p.push('")+"');}return p.join('');");return c?a(c):a};b.forEach=b.each;b.foldl=b.inject=b.reduce;b.foldr=b.reduceRight;b.filter=b.select;b.every=b.all;b.some=b.any;b.head=b.first;b.tail=b.rest;b.methods=b.functions;var l=function(a,c){return c?b(a).chain():a};b.each(b.functions(b),function(a){var c=b[a];i.prototype[a]=function(){var d=b.toArray(arguments); +o.call(d,this._wrapped);return l(c.apply(b,d),this._chain)}});b.each(["pop","push","reverse","shift","sort","splice","unshift"],function(a){var c=Array.prototype[a];i.prototype[a]=function(){c.apply(this._wrapped,arguments);return l(this._wrapped,this._chain)}});b.each(["concat","join","slice"],function(a){var c=Array.prototype[a];i.prototype[a]=function(){return l(c.apply(this._wrapped,arguments),this._chain)}});i.prototype.chain=function(){this._chain=true;return this};i.prototype.value=function(){return this._wrapped}})(); diff --git a/doc/build/html/_static/up-pressed.png b/doc/build/html/_static/up-pressed.png new file mode 100644 index 0000000..8bd587a Binary files /dev/null and b/doc/build/html/_static/up-pressed.png differ diff --git a/doc/build/html/_static/up.png b/doc/build/html/_static/up.png new file mode 100644 index 0000000..b946256 Binary files /dev/null and b/doc/build/html/_static/up.png differ diff --git a/doc/build/html/_static/websupport.js b/doc/build/html/_static/websupport.js new file mode 100644 index 0000000..e9bd1b8 --- /dev/null +++ b/doc/build/html/_static/websupport.js @@ -0,0 +1,808 @@ +/* + * websupport.js + * ~~~~~~~~~~~~~ + * + * sphinx.websupport utilties for all documentation. + * + * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +(function($) { + $.fn.autogrow = function() { + return this.each(function() { + var textarea = this; + + $.fn.autogrow.resize(textarea); + + $(textarea) + .focus(function() { + textarea.interval = setInterval(function() { + $.fn.autogrow.resize(textarea); + }, 500); + }) + .blur(function() { + clearInterval(textarea.interval); + }); + }); + }; + + $.fn.autogrow.resize = function(textarea) { + var lineHeight = parseInt($(textarea).css('line-height'), 10); + var lines = textarea.value.split('\n'); + var columns = textarea.cols; + var lineCount = 0; + $.each(lines, function() { + lineCount += Math.ceil(this.length / columns) || 1; + }); + var height = lineHeight * (lineCount + 1); + $(textarea).css('height', height); + }; +})(jQuery); + +(function($) { + var comp, by; + + function init() { + initEvents(); + initComparator(); + } + + function initEvents() { + $('a.comment-close').live("click", function(event) { + event.preventDefault(); + hide($(this).attr('id').substring(2)); + }); + $('a.vote').live("click", function(event) { + event.preventDefault(); + handleVote($(this)); + }); + $('a.reply').live("click", function(event) { + event.preventDefault(); + openReply($(this).attr('id').substring(2)); + }); + $('a.close-reply').live("click", function(event) { + event.preventDefault(); + closeReply($(this).attr('id').substring(2)); + }); + $('a.sort-option').live("click", function(event) { + event.preventDefault(); + handleReSort($(this)); + }); + $('a.show-proposal').live("click", function(event) { + event.preventDefault(); + showProposal($(this).attr('id').substring(2)); + }); + $('a.hide-proposal').live("click", function(event) { + event.preventDefault(); + hideProposal($(this).attr('id').substring(2)); + }); + $('a.show-propose-change').live("click", function(event) { + event.preventDefault(); + showProposeChange($(this).attr('id').substring(2)); + }); + $('a.hide-propose-change').live("click", function(event) { + event.preventDefault(); + hideProposeChange($(this).attr('id').substring(2)); + }); + $('a.accept-comment').live("click", function(event) { + event.preventDefault(); + acceptComment($(this).attr('id').substring(2)); + }); + $('a.delete-comment').live("click", function(event) { + event.preventDefault(); + deleteComment($(this).attr('id').substring(2)); + }); + $('a.comment-markup').live("click", function(event) { + event.preventDefault(); + toggleCommentMarkupBox($(this).attr('id').substring(2)); + }); + } + + /** + * Set comp, which is a comparator function used for sorting and + * inserting comments into the list. + */ + function setComparator() { + // If the first three letters are "asc", sort in ascending order + // and remove the prefix. + if (by.substring(0,3) == 'asc') { + var i = by.substring(3); + comp = function(a, b) { return a[i] - b[i]; }; + } else { + // Otherwise sort in descending order. + comp = function(a, b) { return b[by] - a[by]; }; + } + + // Reset link styles and format the selected sort option. + $('a.sel').attr('href', '#').removeClass('sel'); + $('a.by' + by).removeAttr('href').addClass('sel'); + } + + /** + * Create a comp function. If the user has preferences stored in + * the sortBy cookie, use those, otherwise use the default. + */ + function initComparator() { + by = 'rating'; // Default to sort by rating. + // If the sortBy cookie is set, use that instead. + if (document.cookie.length > 0) { + var start = document.cookie.indexOf('sortBy='); + if (start != -1) { + start = start + 7; + var end = document.cookie.indexOf(";", start); + if (end == -1) { + end = document.cookie.length; + by = unescape(document.cookie.substring(start, end)); + } + } + } + setComparator(); + } + + /** + * Show a comment div. + */ + function show(id) { + $('#ao' + id).hide(); + $('#ah' + id).show(); + var context = $.extend({id: id}, opts); + var popup = $(renderTemplate(popupTemplate, context)).hide(); + popup.find('textarea[name="proposal"]').hide(); + popup.find('a.by' + by).addClass('sel'); + var form = popup.find('#cf' + id); + form.submit(function(event) { + event.preventDefault(); + addComment(form); + }); + $('#s' + id).after(popup); + popup.slideDown('fast', function() { + getComments(id); + }); + } + + /** + * Hide a comment div. + */ + function hide(id) { + $('#ah' + id).hide(); + $('#ao' + id).show(); + var div = $('#sc' + id); + div.slideUp('fast', function() { + div.remove(); + }); + } + + /** + * Perform an ajax request to get comments for a node + * and insert the comments into the comments tree. + */ + function getComments(id) { + $.ajax({ + type: 'GET', + url: opts.getCommentsURL, + data: {node: id}, + success: function(data, textStatus, request) { + var ul = $('#cl' + id); + var speed = 100; + $('#cf' + id) + .find('textarea[name="proposal"]') + .data('source', data.source); + + if (data.comments.length === 0) { + ul.html('
  • No comments yet.
    • '); + ul.data('empty', true); + } else { + // If there are comments, sort them and put them in the list. + var comments = sortComments(data.comments); + speed = data.comments.length * 100; + appendComments(comments, ul); + ul.data('empty', false); + } + $('#cn' + id).slideUp(speed + 200); + ul.slideDown(speed); + }, + error: function(request, textStatus, error) { + showError('Oops, there was a problem retrieving the comments.'); + }, + dataType: 'json' + }); + } + + /** + * Add a comment via ajax and insert the comment into the comment tree. + */ + function addComment(form) { + var node_id = form.find('input[name="node"]').val(); + var parent_id = form.find('input[name="parent"]').val(); + var text = form.find('textarea[name="comment"]').val(); + var proposal = form.find('textarea[name="proposal"]').val(); + + if (text == '') { + showError('Please enter a comment.'); + return; + } + + // Disable the form that is being submitted. + form.find('textarea,input').attr('disabled', 'disabled'); + + // Send the comment to the server. + $.ajax({ + type: "POST", + url: opts.addCommentURL, + dataType: 'json', + data: { + node: node_id, + parent: parent_id, + text: text, + proposal: proposal + }, + success: function(data, textStatus, error) { + // Reset the form. + if (node_id) { + hideProposeChange(node_id); + } + form.find('textarea') + .val('') + .add(form.find('input')) + .removeAttr('disabled'); + var ul = $('#cl' + (node_id || parent_id)); + if (ul.data('empty')) { + $(ul).empty(); + ul.data('empty', false); + } + insertComment(data.comment); + var ao = $('#ao' + node_id); + ao.find('img').attr({'src': opts.commentBrightImage}); + if (node_id) { + // if this was a "root" comment, remove the commenting box + // (the user can get it back by reopening the comment popup) + $('#ca' + node_id).slideUp(); + } + }, + error: function(request, textStatus, error) { + form.find('textarea,input').removeAttr('disabled'); + showError('Oops, there was a problem adding the comment.'); + } + }); + } + + /** + * Recursively append comments to the main comment list and children + * lists, creating the comment tree. + */ + function appendComments(comments, ul) { + $.each(comments, function() { + var div = createCommentDiv(this); + ul.append($(document.createElement('li')).html(div)); + appendComments(this.children, div.find('ul.comment-children')); + // To avoid stagnating data, don't store the comments children in data. + this.children = null; + div.data('comment', this); + }); + } + + /** + * After adding a new comment, it must be inserted in the correct + * location in the comment tree. + */ + function insertComment(comment) { + var div = createCommentDiv(comment); + + // To avoid stagnating data, don't store the comments children in data. + comment.children = null; + div.data('comment', comment); + + var ul = $('#cl' + (comment.node || comment.parent)); + var siblings = getChildren(ul); + + var li = $(document.createElement('li')); + li.hide(); + + // Determine where in the parents children list to insert this comment. + for(i=0; i < siblings.length; i++) { + if (comp(comment, siblings[i]) <= 0) { + $('#cd' + siblings[i].id) + .parent() + .before(li.html(div)); + li.slideDown('fast'); + return; + } + } + + // If we get here, this comment rates lower than all the others, + // or it is the only comment in the list. + ul.append(li.html(div)); + li.slideDown('fast'); + } + + function acceptComment(id) { + $.ajax({ + type: 'POST', + url: opts.acceptCommentURL, + data: {id: id}, + success: function(data, textStatus, request) { + $('#cm' + id).fadeOut('fast'); + $('#cd' + id).removeClass('moderate'); + }, + error: function(request, textStatus, error) { + showError('Oops, there was a problem accepting the comment.'); + } + }); + } + + function deleteComment(id) { + $.ajax({ + type: 'POST', + url: opts.deleteCommentURL, + data: {id: id}, + success: function(data, textStatus, request) { + var div = $('#cd' + id); + if (data == 'delete') { + // Moderator mode: remove the comment and all children immediately + div.slideUp('fast', function() { + div.remove(); + }); + return; + } + // User mode: only mark the comment as deleted + div + .find('span.user-id:first') + .text('[deleted]').end() + .find('div.comment-text:first') + .text('[deleted]').end() + .find('#cm' + id + ', #dc' + id + ', #ac' + id + ', #rc' + id + + ', #sp' + id + ', #hp' + id + ', #cr' + id + ', #rl' + id) + .remove(); + var comment = div.data('comment'); + comment.username = '[deleted]'; + comment.text = '[deleted]'; + div.data('comment', comment); + }, + error: function(request, textStatus, error) { + showError('Oops, there was a problem deleting the comment.'); + } + }); + } + + function showProposal(id) { + $('#sp' + id).hide(); + $('#hp' + id).show(); + $('#pr' + id).slideDown('fast'); + } + + function hideProposal(id) { + $('#hp' + id).hide(); + $('#sp' + id).show(); + $('#pr' + id).slideUp('fast'); + } + + function showProposeChange(id) { + $('#pc' + id).hide(); + $('#hc' + id).show(); + var textarea = $('#pt' + id); + textarea.val(textarea.data('source')); + $.fn.autogrow.resize(textarea[0]); + textarea.slideDown('fast'); + } + + function hideProposeChange(id) { + $('#hc' + id).hide(); + $('#pc' + id).show(); + var textarea = $('#pt' + id); + textarea.val('').removeAttr('disabled'); + textarea.slideUp('fast'); + } + + function toggleCommentMarkupBox(id) { + $('#mb' + id).toggle(); + } + + /** Handle when the user clicks on a sort by link. */ + function handleReSort(link) { + var classes = link.attr('class').split(/\s+/); + for (var i=0; iThank you! Your comment will show up ' + + 'once it is has been approved by a moderator.'); + } + // Prettify the comment rating. + comment.pretty_rating = comment.rating + ' point' + + (comment.rating == 1 ? '' : 's'); + // Make a class (for displaying not yet moderated comments differently) + comment.css_class = comment.displayed ? '' : ' moderate'; + // Create a div for this comment. + var context = $.extend({}, opts, comment); + var div = $(renderTemplate(commentTemplate, context)); + + // If the user has voted on this comment, highlight the correct arrow. + if (comment.vote) { + var direction = (comment.vote == 1) ? 'u' : 'd'; + div.find('#' + direction + 'v' + comment.id).hide(); + div.find('#' + direction + 'u' + comment.id).show(); + } + + if (opts.moderator || comment.text != '[deleted]') { + div.find('a.reply').show(); + if (comment.proposal_diff) + div.find('#sp' + comment.id).show(); + if (opts.moderator && !comment.displayed) + div.find('#cm' + comment.id).show(); + if (opts.moderator || (opts.username == comment.username)) + div.find('#dc' + comment.id).show(); + } + return div; + } + + /** + * A simple template renderer. Placeholders such as <%id%> are replaced + * by context['id'] with items being escaped. Placeholders such as <#id#> + * are not escaped. + */ + function renderTemplate(template, context) { + var esc = $(document.createElement('div')); + + function handle(ph, escape) { + var cur = context; + $.each(ph.split('.'), function() { + cur = cur[this]; + }); + return escape ? esc.text(cur || "").html() : cur; + } + + return template.replace(/<([%#])([\w\.]*)\1>/g, function() { + return handle(arguments[2], arguments[1] == '%' ? true : false); + }); + } + + /** Flash an error message briefly. */ + function showError(message) { + $(document.createElement('div')).attr({'class': 'popup-error'}) + .append($(document.createElement('div')) + .attr({'class': 'error-message'}).text(message)) + .appendTo('body') + .fadeIn("slow") + .delay(2000) + .fadeOut("slow"); + } + + /** Add a link the user uses to open the comments popup. */ + $.fn.comment = function() { + return this.each(function() { + var id = $(this).attr('id').substring(1); + var count = COMMENT_METADATA[id]; + var title = count + ' comment' + (count == 1 ? '' : 's'); + var image = count > 0 ? opts.commentBrightImage : opts.commentImage; + var addcls = count == 0 ? ' nocomment' : ''; + $(this) + .append( + $(document.createElement('a')).attr({ + href: '#', + 'class': 'sphinx-comment-open' + addcls, + id: 'ao' + id + }) + .append($(document.createElement('img')).attr({ + src: image, + alt: 'comment', + title: title + })) + .click(function(event) { + event.preventDefault(); + show($(this).attr('id').substring(2)); + }) + ) + .append( + $(document.createElement('a')).attr({ + href: '#', + 'class': 'sphinx-comment-close hidden', + id: 'ah' + id + }) + .append($(document.createElement('img')).attr({ + src: opts.closeCommentImage, + alt: 'close', + title: 'close' + })) + .click(function(event) { + event.preventDefault(); + hide($(this).attr('id').substring(2)); + }) + ); + }); + }; + + var opts = { + processVoteURL: '/_process_vote', + addCommentURL: '/_add_comment', + getCommentsURL: '/_get_comments', + acceptCommentURL: '/_accept_comment', + deleteCommentURL: '/_delete_comment', + commentImage: '/static/_static/comment.png', + closeCommentImage: '/static/_static/comment-close.png', + loadingImage: '/static/_static/ajax-loader.gif', + commentBrightImage: '/static/_static/comment-bright.png', + upArrow: '/static/_static/up.png', + downArrow: '/static/_static/down.png', + upArrowPressed: '/static/_static/up-pressed.png', + downArrowPressed: '/static/_static/down-pressed.png', + voting: false, + moderator: false + }; + + if (typeof COMMENT_OPTIONS != "undefined") { + opts = jQuery.extend(opts, COMMENT_OPTIONS); + } + + var popupTemplate = '\ +
    \ +

    \ + Sort by:\ + best rated\ + newest\ + oldest\ +

    \ +
    Comments
    \ +
    \ + loading comments...
    \ +
      \ +
      \ +

      Add a comment\ + (markup):

      \ +
      \ + reStructured text markup: *emph*, **strong**, \ + ``code``, \ + code blocks: :: and an indented block after blank line
      \ +
      \ + \ +

      \ + \ + Propose a change ▹\ + \ + \ + Propose a change ▿\ + \ +

      \ + \ + \ + \ + \ +
      \ +
      \ +
      '; + + var commentTemplate = '\ +
      \ +
      \ +
      \ + \ + \ + \ + \ + \ + \ +
      \ +
      \ + \ + \ + \ + \ + \ + \ +
      \ +
      \ +
      \ +

      \ + <%username%>\ + <%pretty_rating%>\ + <%time.delta%>\ +

      \ +
      <#text#>
      \ +

      \ + \ + reply ▿\ + proposal ▹\ + proposal ▿\ + \ + \ +

      \ + 
      \
+<#proposal_diff#>\
+
      \ +
        \ +
        \ +
        \ +
        \ + '; + + var replyTemplate = '\ +
      • \ +
        \ +
        \ + \ + \ + \ + \ + \ +
        \ +
        \ +
        • '; + + $(document).ready(function() { + init(); + }); +})(jQuery); + +$(document).ready(function() { + // add comment anchors for all paragraphs that are commentable + $('.sphinx-has-comment').comment(); + + // highlight search words in search results + $("div.context").each(function() { + var params = $.getQueryParameters(); + var terms = (params.q) ? params.q[0].split(/\s+/) : []; + var result = $(this); + $.each(terms, function() { + result.highlightText(this.toLowerCase(), 'highlighted'); + }); + }); + + // directly open comment window if requested + var anchor = document.location.hash; + if (anchor.substring(0, 9) == '#comment-') { + $('#ao' + anchor.substring(9)).click(); + document.location.hash = '#s' + anchor.substring(9); + } +}); diff --git a/doc/build/html/commands/apidoc/modules.html b/doc/build/html/commands/apidoc/modules.html new file mode 100644 index 0000000..07df6f4 --- /dev/null +++ b/doc/build/html/commands/apidoc/modules.html @@ -0,0 +1,142 @@ + + + + + + + + + src — salomeTools 5.0.0dev documentation + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +
        +
        + + + + +
        +
        +
        +
        +
        +
        +

        Related Topics

        + +
        +

        This Page

        + + + +
        +
        +
        +
        +
        + ©2018, CEA. + + | + Powered by Sphinx 1.1.3 + & Alabaster + + | + Page source +
        + + + + + + \ No newline at end of file diff --git a/doc/build/html/commands/apidoc/src.colorama.html b/doc/build/html/commands/apidoc/src.colorama.html new file mode 100644 index 0000000..5680a4a --- /dev/null +++ b/doc/build/html/commands/apidoc/src.colorama.html @@ -0,0 +1,688 @@ + + + + + + + + + colorama Package — salomeTools 5.0.0dev documentation + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +
        +
        + +
        +

        colorama Package¶

        +
        +

        colorama Package¶

        +
        +
        +

        ansi Module¶

        +

        This module generates ANSI character codes to printing colors to terminals. +See: http://en.wikipedia.org/wiki/ANSI_escape_code

        +
        +
        +class src.colorama.ansi.AnsiBack[source]¶
        +

        Bases: src.colorama.ansi.AnsiCodes

        +
        +
        +BLACK = 40¶
        +
        + +
        +
        +BLUE = 44¶
        +
        + +
        +
        +CYAN = 46¶
        +
        + +
        +
        +GREEN = 42¶
        +
        + +
        +
        +LIGHTBLACK_EX = 100¶
        +
        + +
        +
        +LIGHTBLUE_EX = 104¶
        +
        + +
        +
        +LIGHTCYAN_EX = 106¶
        +
        + +
        +
        +LIGHTGREEN_EX = 102¶
        +
        + +
        +
        +LIGHTMAGENTA_EX = 105¶
        +
        + +
        +
        +LIGHTRED_EX = 101¶
        +
        + +
        +
        +LIGHTWHITE_EX = 107¶
        +
        + +
        +
        +LIGHTYELLOW_EX = 103¶
        +
        + +
        +
        +MAGENTA = 45¶
        +
        + +
        +
        +RED = 41¶
        +
        + +
        +
        +RESET = 49¶
        +
        + +
        +
        +WHITE = 47¶
        +
        + +
        +
        +YELLOW = 43¶
        +
        + +
        + +
        +
        +class src.colorama.ansi.AnsiCodes[source]¶
        +

        Bases: object

        +
        + +
        +
        +class src.colorama.ansi.AnsiCursor[source]¶
        +

        Bases: object

        +
        +
        +BACK(n=1)[source]¶
        +
        + +
        +
        +DOWN(n=1)[source]¶
        +
        + +
        +
        +FORWARD(n=1)[source]¶
        +
        + +
        +
        +POS(x=1, y=1)[source]¶
        +
        + +
        +
        +UP(n=1)[source]¶
        +
        + +
        + +
        +
        +class src.colorama.ansi.AnsiFore[source]¶
        +

        Bases: src.colorama.ansi.AnsiCodes

        +
        +
        +BLACK = 30¶
        +
        + +
        +
        +BLUE = 34¶
        +
        + +
        +
        +CYAN = 36¶
        +
        + +
        +
        +GREEN = 32¶
        +
        + +
        +
        +LIGHTBLACK_EX = 90¶
        +
        + +
        +
        +LIGHTBLUE_EX = 94¶
        +
        + +
        +
        +LIGHTCYAN_EX = 96¶
        +
        + +
        +
        +LIGHTGREEN_EX = 92¶
        +
        + +
        +
        +LIGHTMAGENTA_EX = 95¶
        +
        + +
        +
        +LIGHTRED_EX = 91¶
        +
        + +
        +
        +LIGHTWHITE_EX = 97¶
        +
        + +
        +
        +LIGHTYELLOW_EX = 93¶
        +
        + +
        +
        +MAGENTA = 35¶
        +
        + +
        +
        +RED = 31¶
        +
        + +
        +
        +RESET = 39¶
        +
        + +
        +
        +WHITE = 37¶
        +
        + +
        +
        +YELLOW = 33¶
        +
        + +
        + +
        +
        +class src.colorama.ansi.AnsiStyle[source]¶
        +

        Bases: src.colorama.ansi.AnsiCodes

        +
        +
        +BRIGHT = 1¶
        +
        + +
        +
        +DIM = 2¶
        +
        + +
        +
        +NORMAL = 22¶
        +
        + +
        +
        +RESET_ALL = 0¶
        +
        + +
        + +
        +
        +src.colorama.ansi.clear_line(mode=2)[source]¶
        +
        + +
        +
        +src.colorama.ansi.clear_screen(mode=2)[source]¶
        +
        + +
        +
        +src.colorama.ansi.code_to_chars(code)[source]¶
        +
        + +
        +
        +src.colorama.ansi.set_title(title)[source]¶
        +
        + +
        +
        +

        ansitowin32 Module¶

        +
        +
        +class src.colorama.ansitowin32.AnsiToWin32(wrapped, convert=None, strip=None, autoreset=False)[source]¶
        +

        Bases: object

        +

        Implements a 'write()' method which, on Windows, will strip ANSI character +sequences from the text, and if outputting to a tty, will convert them into +win32 function calls.

        +
        +
        +ANSI_CSI_RE = <_sre.SRE_Pattern object at 0x3ff4610>¶
        +
        + +
        +
        +ANSI_OSC_RE = <_sre.SRE_Pattern object at 0x42d2cf0>¶
        +
        + +
        +
        +call_win32(command, params)[source]¶
        +
        + +
        +
        +convert_ansi(paramstring, command)[source]¶
        +
        + +
        +
        +convert_osc(text)[source]¶
        +
        + +
        +
        +extract_params(command, paramstring)[source]¶
        +
        + +
        +
        +get_win32_calls()[source]¶
        +
        + +
        +
        +reset_all()[source]¶
        +
        + +
        +
        +should_wrap()[source]¶
        +

        True if this class is actually needed. If false, then the output +stream will not be affected, nor will win32 calls be issued, so +wrapping stdout is not actually required. This will generally be +False on non-Windows platforms, unless optional functionality like +autoreset has been requested using kwargs to init()

        +
        + +
        +
        +write(text)[source]¶
        +
        + +
        +
        +write_and_convert(text)[source]¶
        +

        Write the given text to our wrapped stream, stripping any ANSI +sequences from the text, and optionally converting them into win32 +calls.

        +
        + +
        +
        +write_plain_text(text, start, end)[source]¶
        +
        + +
        + +
        +
        +class src.colorama.ansitowin32.StreamWrapper(wrapped, converter)[source]¶
        +

        Bases: object

        +

        Wraps a stream (such as stdout), acting as a transparent proxy for all +attribute access apart from method 'write()', which is delegated to our +Converter instance.

        +
        +
        +write(text)[source]¶
        +
        + +
        + +
        +
        +src.colorama.ansitowin32.is_a_tty(stream)[source]¶
        +
        + +
        +
        +src.colorama.ansitowin32.is_stream_closed(stream)[source]¶
        +
        + +
        +
        +

        initialise Module¶

        +
        +
        +src.colorama.initialise.colorama_text(*args, **kwds)[source]¶
        +
        + +
        +
        +src.colorama.initialise.deinit()[source]¶
        +
        + +
        +
        +src.colorama.initialise.init(autoreset=False, convert=None, strip=None, wrap=True)[source]¶
        +
        + +
        +
        +src.colorama.initialise.reinit()[source]¶
        +
        + +
        +
        +src.colorama.initialise.reset_all()[source]¶
        +
        + +
        +
        +src.colorama.initialise.wrap_stream(stream, convert, strip, autoreset, wrap)[source]¶
        +
        + +
        +
        +

        win32 Module¶

        +
        +
        +src.colorama.win32.SetConsoleTextAttribute(*_)[source]¶
        +
        + +
        +
        +src.colorama.win32.winapi_test(*_)[source]¶
        +
        + +
        +
        +

        winterm Module¶

        +
        +
        +class src.colorama.winterm.WinColor[source]¶
        +

        Bases: object

        +
        +
        +BLACK = 0¶
        +
        + +
        +
        +BLUE = 1¶
        +
        + +
        +
        +CYAN = 3¶
        +
        + +
        +
        +GREEN = 2¶
        +
        + +
        +
        +GREY = 7¶
        +
        + +
        +
        +MAGENTA = 5¶
        +
        + +
        +
        +RED = 4¶
        +
        + +
        +
        +YELLOW = 6¶
        +
        + +
        + +
        +
        +class src.colorama.winterm.WinStyle[source]¶
        +

        Bases: object

        +
        +
        +BRIGHT = 8¶
        +
        + +
        +
        +BRIGHT_BACKGROUND = 128¶
        +
        + +
        +
        +NORMAL = 0¶
        +
        + +
        + +
        +
        +class src.colorama.winterm.WinTerm[source]¶
        +

        Bases: object

        +
        +
        +back(back=None, light=False, on_stderr=False)[source]¶
        +
        + +
        +
        +cursor_adjust(x, y, on_stderr=False)[source]¶
        +
        + +
        +
        +erase_line(mode=0, on_stderr=False)[source]¶
        +
        + +
        +
        +erase_screen(mode=0, on_stderr=False)[source]¶
        +
        + +
        +
        +fore(fore=None, light=False, on_stderr=False)[source]¶
        +
        + +
        +
        +get_attrs()[source]¶
        +
        + +
        +
        +get_position(handle)[source]¶
        +
        + +
        +
        +reset_all(on_stderr=None)[source]¶
        +
        + +
        +
        +set_attrs(value)[source]¶
        +
        + +
        +
        +set_console(attrs=None, on_stderr=False)[source]¶
        +
        + +
        +
        +set_cursor_position(position=None, on_stderr=False)[source]¶
        +
        + +
        +
        +set_title(title)[source]¶
        +
        + +
        +
        +style(style=None, on_stderr=False)[source]¶
        +
        + +
        + +
        +
        + + +
        +
        +
        +
        +
        + +

        Table Of Contents

        + +
        +

        Related Topics

        + +
        +

        This Page

        + + + +
        +
        +
        +
        +
        + ©2018, CEA. + + | + Powered by Sphinx 1.1.3 + & Alabaster + + | + Page source +
        + + + + + + \ No newline at end of file diff --git a/doc/build/html/commands/apidoc/src.html b/doc/build/html/commands/apidoc/src.html new file mode 100644 index 0000000..59b6bf5 --- /dev/null +++ b/doc/build/html/commands/apidoc/src.html @@ -0,0 +1,4903 @@ + + + + + + + + + src Package — salomeTools 5.0.0dev documentation + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +
        +
        + +
        +

        src Package¶

        +
        +

        src Package¶

        +

        initial imports and utilities methods for salomeTools

        +
        +
        +class src.__init__.Path(path)[source]¶
        +
        +
        +base()[source]¶
        +
        + +
        +
        +chmod(mode)[source]¶
        +
        + +
        +
        +copy(path, smart=False)[source]¶
        +
        + +
        +
        +copydir(dst, smart=False)[source]¶
        +
        + +
        +
        +copyfile(path)[source]¶
        +
        + +
        +
        +copylink(path)[source]¶
        +
        + +
        +
        +dir()[source]¶
        +
        + +
        +
        +exists()[source]¶
        +
        + +
        +
        +isdir()[source]¶
        +
        + +
        +
        +isfile()[source]¶
        +
        + +
        +
        +islink()[source]¶
        +
        + +
        +
        +list()[source]¶
        +
        + +
        +
        +make(mode=None)[source]¶
        +
        + +
        +
        +readlink()[source]¶
        +
        + +
        +
        +rm()[source]¶
        +
        + +
        +
        +smartcopy(path)[source]¶
        +
        + +
        +
        +symlink(path)[source]¶
        +
        + +
        + +
        +
        +exception src.__init__.SatException[source]¶
        +

        Bases: exceptions.Exception

        +

        rename Exception Class

        +
        + +
        +
        +src.__init__.activate_mesa_property(config)[source]¶
        +

        Add mesa property into application properties

        + +++ + + + +
        Parameters:Config (config) -- The global configuration. It must have an application!
        +
        + +
        +
        +src.__init__.check_config_has_application(config, details=None)[source]¶
        +

        check that the config has the key APPLICATION. Else raise an exception.

        + +++ + + + +
        Parameters:class 'common.pyconf.Config' (config) -- The config.
        +
        + +
        +
        +src.__init__.check_config_has_profile(config, details=None)[source]¶
        +

        check that the config has the key APPLICATION.profile. +else, raise an exception.

        + +++ + + + +
        Parameters:class 'common.pyconf.Config' (config) -- The config.
        +
        + +
        +
        +src.__init__.config_has_application(config)[source]¶
        +
        + +
        +
        +src.__init__.deepcopy_list(input_list)[source]¶
        +

        Do a deep copy of a list

        + +++ + + + + + + + +
        Parameters:List (input_list) -- The list to copy
        Returns:The copy of the list
        Return type:List
        +
        + +
        +
        +src.__init__.ensure_path_exists(p)[source]¶
        +

        Create a path if not existing

        + +++ + + + +
        Parameters:str (p) -- The path.
        +
        + +
        +
        +src.__init__.find_file_in_lpath(file_name, lpath, additional_dir='')[source]¶
        +

        Find in all the directories in lpath list the file that has the same name +as file_name. +If it is found +then return the full path of the file +else return False.

        +

        The additional_dir (optional) is the name of the directory to add to all +paths in lpath.

        + +++ + + + + + + + +
        Parameters:
          +
        • str (additional_dir) -- The file name to search
          • +
        • List (lpath) -- The list of directories where to search
          • +
        • str -- The name of the additional directory
          • +
        +
        Returns:

        the full path of the file or False if not found

        +
        Return type:

        str

        +
        +
        + +
        +
        +src.__init__.get_base_path(config)[source]¶
        +

        Returns the path of the products base.

        + +++ + + + + + + + +
        Parameters:Config (config) -- The global Config instance.
        Returns:The path of the products base.
        Return type:str
        +
        + +
        +
        +src.__init__.get_cfg_param(config, param_name, default)[source]¶
        +

        eearch for param_name value in config. +if param_name is not in config +then return default, +else return the found value

        + +++ + + + + + + + +
        Parameters:
          +
        • class 'common.pyconf.Config' (config) -- The config.
          • +
        • str (default) -- the name of the parameter to get the value
          • +
        • str -- The value to return if param_name is not in config
          • +
        +
        Returns:

        see initial description of the function

        +
        Return type:

        str

        +
        +
        + +
        +
        +src.__init__.get_launcher_name(config)[source]¶
        +

        Returns the name of salome launcher.

        + +++ + + + + + + + +
        Parameters:Config (config) -- The global Config instance.
        Returns:The name of salome launcher.
        Return type:str
        +
        + +
        +
        +src.__init__.get_log_path(config)[source]¶
        +

        Returns the path of the logs.

        + +++ + + + + + + + +
        Parameters:Config (config) -- The global Config instance.
        Returns:The path of the logs.
        Return type:str
        +
        + +
        +
        +src.__init__.get_property_in_product_cfg(product_cfg, pprty)[source]¶
        +
        + +
        +
        +src.__init__.get_salome_version(config)[source]¶
        +
        + +
        +
        +src.__init__.get_tmp_filename(cfg, name)[source]¶
        +
        + +
        +
        +src.__init__.handleRemoveReadonly(func, path, exc)[source]¶
        +
        + +
        +
        +src.__init__.merge_dicts(*dict_args)[source]¶
        +

        Given any number of dicts, shallow copy and merge into a new dict, +precedence goes to key value pairs in latter dicts.

        +
        + +
        +
        +src.__init__.only_numbers(str_num)[source]¶
        +
        + +
        +
        +src.__init__.parse_date(date)[source]¶
        +

        Transform YYYYMMDD_hhmmss into YYYY-MM-DD hh:mm:ss.

        + +++ + + + + + + + +
        Parameters:str (date) -- The date to transform
        Returns:The date in the new format
        Return type:str
        +
        + +
        +
        +src.__init__.print_info(logger, info)[source]¶
        +

        Prints the tuples that are in info variable in a formatted way.

        + +++ + + + +
        Parameters:
          +
        • Logger (logger) -- The logging instance to use for the prints.
          • +
        • list (info) -- The list of tuples to display
          • +
        +
        +
        + +
        +
        +src.__init__.read_config_from_a_file(filePath)[source]¶
        +
        + +
        +
        +src.__init__.remove_item_from_list(input_list, item)[source]¶
        +

        Remove all occurences of item from input_list

        + +++ + + + + + + + +
        Parameters:List (input_list) -- The list to modify
        Returns:The without any item
        Return type:List
        +
        + +
        +
        +src.__init__.replace_in_file(filein, strin, strout)[source]¶
        +

        Replace <strin> by <strout> in file <filein>

        +
        + +
        +
        +

        ElementTree Module¶

        +
        +
        +src.ElementTree.Comment(text=None)[source]¶
        +
        + +
        +
        +src.ElementTree.dump(elem)[source]¶
        +
        + +
        +
        +src.ElementTree.Element(tag, attrib={}, **extra)[source]¶
        +
        + +
        +
        +class src.ElementTree.ElementTree(element=None, file=None)[source]¶
        +
        +
        +find(path)[source]¶
        +
        + +
        +
        +findall(path)[source]¶
        +
        + +
        +
        +findtext(path, default=None)[source]¶
        +
        + +
        +
        +getiterator(tag=None)[source]¶
        +
        + +
        +
        +getroot()[source]¶
        +
        + +
        +
        +parse(source, parser=None)[source]¶
        +
        + +
        +
        +write(file, encoding='us-ascii')[source]¶
        +
        + +
        + +
        +
        +src.ElementTree.fromstring(text)¶
        +
        + +
        +
        +src.ElementTree.iselement(element)[source]¶
        +
        + +
        +
        +class src.ElementTree.iterparse(source, events=None)[source]¶
        +
        +
        +next()[source]¶
        +
        + +
        + +
        +
        +src.ElementTree.parse(source, parser=None)[source]¶
        +
        + +
        +
        +src.ElementTree.PI(target, text=None)¶
        +
        + +
        +
        +src.ElementTree.ProcessingInstruction(target, text=None)[source]¶
        +
        + +
        +
        +class src.ElementTree.QName(text_or_uri, tag=None)[source]¶
        +
        + +
        +
        +src.ElementTree.SubElement(parent, tag, attrib={}, **extra)[source]¶
        +
        + +
        +
        +src.ElementTree.tostring(element, encoding=None)[source]¶
        +
        + +
        +
        +class src.ElementTree.TreeBuilder(element_factory=None)[source]¶
        +
        +
        +close()[source]¶
        +
        + +
        +
        +data(data)[source]¶
        +
        + +
        +
        +end(tag)[source]¶
        +
        + +
        +
        +start(tag, attrs)[source]¶
        +
        + +
        + +
        +
        +src.ElementTree.XML(text)[source]¶
        +
        + +
        +
        +class src.ElementTree.XMLTreeBuilder(html=0, target=None)[source]¶
        +
        +
        +close()[source]¶
        +
        + +
        +
        +doctype(name, pubid, system)[source]¶
        +
        + +
        +
        +feed(data)[source]¶
        +
        + +
        + +
        +
        +

        architecture Module¶

        +

        In this file : all the stuff that can change with the architecture +on which SAT is running

        +
        +
        +src.architecture.get_distrib_version(distrib, codes)[source]¶
        +

        Gets the version of the distribution

        + +++ + + + + + + + +
        Parameters:
          +
        • str (distrib) -- The distribution on which the version will be found.
          • +
        • L{Mapping} (codes) -- The map containing distribution correlation table.
          • +
        +
        Returns:

        The version of the distribution on which salomeTools is running, +regarding the distribution correlation table contained in codes +variable.

        +
        Return type:

        str

        +
        +
        + +
        +
        +src.architecture.get_distribution(codes)[source]¶
        +

        Gets the code for the distribution

        + +++ + + + + + + + +
        Parameters:L{Mapping} (codes) -- The map containing distribution correlation table.
        Returns:The distribution on which salomeTools is running, regarding the +distribution correlation table contained in codes variable.
        Return type:str
        +
        + +
        +
        +src.architecture.get_nb_proc()[source]¶
        +

        Gets the number of processors of the machine +on which salomeTools is running.

        + +++ + + + + + +
        Returns:the number of processors.
        Return type:str
        +
        + +
        +
        +src.architecture.get_python_version()[source]¶
        +

        Gets the version of the running python.

        + +++ + + + + + +
        Returns:the version of the running python.
        Return type:str
        +
        + +
        +
        +src.architecture.get_user()[source]¶
        +

        method that gets the username that launched sat

        + +++ + + + +
        Return type:str
        +
        + +
        +
        +src.architecture.is_windows()[source]¶
        +

        method that checks windows OS

        + +++ + + + +
        Return type:boolean
        +
        + +
        +
        +

        compilation Module¶

        +
        +
        +class src.compilation.Builder(config, logger, product_info, options=<src.options.OptResult object at 0x245afd0>, check_src=True)[source]¶
        +

        Class to handle all construction steps, like cmake, configure, make, ...

        +
        +
        +build_configure(options='')[source]¶
        +
        + +
        +
        +check(command='')[source]¶
        +
        + +
        +
        +cmake(options='')[source]¶
        +
        + +
        +
        +complete_environment(make_options)[source]¶
        +
        + +
        +
        +configure(options='')[source]¶
        +
        + +
        +
        +do_batch_script_build(script, nb_proc)[source]¶
        +
        + +
        +
        +do_default_build(build_conf_options='', configure_options='', show_warning=True)[source]¶
        +
        + +
        +
        +do_python_script_build(script, nb_proc)[source]¶
        +
        + +
        +
        +do_script_build(script, number_of_proc=0)[source]¶
        +
        + +
        +
        +hack_libtool()[source]¶
        +
        + +
        +
        +install()[source]¶
        +
        + +
        +
        +log(text, level, showInfo=True)[source]¶
        +
        + +
        +
        +log_command(command)[source]¶
        +
        + +
        +
        +make(nb_proc, make_opt='')[source]¶
        +
        + +
        +
        +prepare()[source]¶
        +
        + +
        +
        +put_txt_log_in_appli_log_dir(file_name)[source]¶
        +

        Put the txt log (that contain the system logs, like make command +output) in the directory <APPLICATION DIR>/LOGS/<product_name>/

        + +++ + + + +
        Parameters:Str (file_name) -- the name of the file to write
        +
        + +
        +
        +wmake(nb_proc, opt_nb_proc=None)[source]¶
        +
        + +
        + +
        +
        +

        debug Module¶

        +

        This file assume DEBUG functionalities use

        +
          +
        • print debug messages in sys.stderr for salomeTools
          • +
        • show pretty print debug representation from instances of SAT classes +(pretty print src.pyconf.Config), and python dict/list etc. (as 'aVariable')
          • +
        +

        WARNING: obviously supposedly show messages in SAT development phase, not production

        +

        usage: +>> import debug as DBG +>> DBG.write("aTitle", aVariable) # not shown in production +>> DBG.write("aTitle", aVariable, True) # unconditionaly shown (as show=True)

        +

        to set show message as development phase: +>> DBG.push_debug(True)

        +

        to set no show message as production phase: +>> DBG.push_debug(False)

        +

        to set show message temporary as development phase, only in a method: +>> def aMethodToDebug(...): +>> DBG.push_debug(True) #force show as appended status +>> etc. method code with some DBG.write() +>> DBG.pop_debug() #restore previous status (show or not show) +>> return

        +

        to set a message for future fix, as temporary problem to not forget: +DBG.tofix("aTitle", aVariable, True/False) #True/False in production shown, or not

        +

        in command line interface you could redirect stderr to file 'myDebug.log': +>> sat compile ... 2> myDebug.log # only stderr +>> sat compile ... &> myDebug.log # stdout and stderr

        +
        +
        +class src.debug.InStream(buf='')[source]¶
        +

        Bases: StringIO.StringIO

        +

        utility class for pyconf.Config input iostream

        +
        + +
        +
        +class src.debug.OutStream(buf='')[source]¶
        +

        Bases: StringIO.StringIO

        +

        utility class for pyconf.Config output iostream

        +
        +
        +close()[source]¶
        +

        because Config.__save__ calls close() stream as file +keep value before lost as self.value

        +
        + +
        + +
        +
        +src.debug.getLocalEnv()[source]¶
        +

        get string for environment variables representation

        +
        + +
        +
        +src.debug.getStrConfigDbg(config)[source]¶
        +

        set string as saveConfigDbg, +as (path expression evaluation) for debug

        +
        + +
        +
        +src.debug.getStrConfigStd(config)[source]¶
        +

        set string as saveConfigStd, as file .pyconf

        +
        + +
        +
        +src.debug.indent(text, amount=2, ch=' ')[source]¶
        +

        indent multi lines message

        +
        + +
        +
        +src.debug.pop_debug()[source]¶
        +

        restore previous debug outputs status

        +
        + +
        +
        +src.debug.push_debug(aBool)[source]¶
        +

        set debug outputs activated, or not

        +
        + +
        +
        +src.debug.saveConfigDbg(config, aStream, indent=0, path='')[source]¶
        +

        pyconf returns multilines (path expression evaluation) for debug

        +
        + +
        +
        +src.debug.saveConfigStd(config, aStream)[source]¶
        +

        returns as file .pyconf

        +
        + +
        +
        +src.debug.tofix(title, var='', force=None)[source]¶
        +

        write sys.stderr a message if _debug[-1]==True or optionaly force=True +use this only if no logger accessible for classic +logger.warning(message) or logger.debug(message)

        +
        + +
        +
        +src.debug.write(title, var='', force=None, fmt='\n#### DEBUG: %s:\n%s\n')[source]¶
        +

        write sys.stderr a message if _debug[-1]==True or optionaly force=True

        +
        + +
        +
        +

        environment Module¶

        +
        +
        +class src.environment.Environ(environ=None)[source]¶
        +

        Class to manage the environment context

        +
        +
        +append(key, value, sep=':')[source]¶
        +

        Same as append_value but the value argument can be a list

        + +++ + + + +
        Parameters:
          +
        • str (sep) -- the environment variable to append
          • +
        • str or list (value) -- the value(s) to append to key
          • +
        • str -- the separator string
          • +
        +
        +
        + +
        +
        +append_value(key, value, sep=':')[source]¶
        +

        append value to key using sep

        + +++ + + + +
        Parameters:
          +
        • str (sep) -- the environment variable to append
          • +
        • str -- the value to append to key
          • +
        • str -- the separator string
          • +
        +
        +
        + +
        +
        +command_value(key, command)[source]¶
        +

        Get the value given by the system command "command" +and put it in the environment variable key

        + +++ + + + +
        Parameters:
          +
        • str (command) -- the environment variable
          • +
        • str -- the command to execute
          • +
        +
        +
        + +
        +
        +get(key)[source]¶
        +

        Get the value of the environment variable "key"

        + +++ + + + +
        Parameters:str (key) -- the environment variable
        +
        + +
        +
        +is_defined(key)[source]¶
        +

        Check if the key exists in the environment

        + +++ + + + +
        Parameters:str (key) -- the environment variable to check
        +
        + +
        +
        +prepend(key, value, sep=':')[source]¶
        +

        Same as prepend_value but the value argument can be a list

        + +++ + + + +
        Parameters:
          +
        • str (sep) -- the environment variable to prepend
          • +
        • str or list (value) -- the value(s) to prepend to key
          • +
        • str -- the separator string
          • +
        +
        +
        + +
        +
        +prepend_value(key, value, sep=':')[source]¶
        +

        prepend value to key using sep

        + +++ + + + +
        Parameters:
          +
        • str (sep) -- the environment variable to prepend
          • +
        • str -- the value to prepend to key
          • +
        • str -- the separator string
          • +
        +
        +
        + +
        +
        +set(key, value)[source]¶
        +

        Set the environment variable "key" to value "value"

        + +++ + + + +
        Parameters:
          +
        • str (value) -- the environment variable to set
          • +
        • str -- the value
          • +
        +
        +
        + +
        + +
        +
        +class src.environment.FileEnvWriter(config, logger, out_dir, src_root, env_info=None)[source]¶
        +

        Class to dump the environment to a file.

        +
        +
        +write_cfgForPy_file(filename, additional_env={}, for_package=None, with_commercial=True)[source]¶
        +

        Append to current opened aFile a cfgForPy +environment (SALOME python launcher).

        + +++ + + + +
        Parameters:
          +
        • str (for_package) -- the file path
          • +
        • dict (additional_env) -- a dictionary of additional variables +to add to the environment
          • +
        • str -- If not None, produce a relative environment +designed for a package.
          • +
        +
        +
        + +
        +
        +write_env_file(filename, forBuild, shell, for_package=None)[source]¶
        +

        Create an environment file.

        + +++ + + + + + + + +
        Parameters:
          +
        • str (shell) -- the file path
          • +
        • bool (forBuild) -- if true, the build environment
          • +
        • str -- the type of file wanted (.sh, .bat)
          • +
        +
        Returns:

        The path to the generated file

        +
        Return type:

        str

        +
        +
        + +
        + +
        +
        +class src.environment.SalomeEnviron(cfg, environ, forBuild=False, for_package=None, enable_simple_env_script=True)[source]¶
        +

        Class to manage the environment of SALOME.

        +
        +
        +add_comment(comment)[source]¶
        +

        Add a commentary to the out stream (in case of file generation)

        + +++ + + + +
        Parameters:str (comment) -- the commentary to add
        +
        + +
        +
        +add_line(nb_line)[source]¶
        +

        Add empty lines to the out stream (in case of file generation)

        + +++ + + + +
        Parameters:int (nb_line) -- the number of empty lines to add
        +
        + +
        +
        +add_warning(warning)[source]¶
        +

        Add a warning to the out stream (in case of file generation)

        + +++ + + + +
        Parameters:str (warning) -- the warning to add
        +
        + +
        +
        +append(key, value, sep=':')[source]¶
        +

        append value to key using sep

        + +++ + + + +
        Parameters:
          +
        • str (sep) -- the environment variable to append
          • +
        • str -- the value to append to key
          • +
        • str -- the separator string
          • +
        +
        +
        + +
        +
        +dump(out)[source]¶
        +

        Write the environment to out

        + +++ + + + +
        Parameters:file (out) -- the stream where to write the environment
        +
        + +
        +
        +finish(required)[source]¶
        +

        Add a final instruction in the out file (in case of file generation)

        + +++ + + + +
        Parameters:bool (required) -- Do nothing if required is False
        +
        + +
        +
        +get(key)[source]¶
        +

        Get the value of the environment variable "key"

        + +++ + + + +
        Parameters:str (key) -- the environment variable
        +
        + +
        +
        +get_names(lProducts)[source]¶
        +

        Get the products name to add in SALOME_MODULES environment variable +It is the name of the product, except in the case where the is a +component name. And it has to be in SALOME_MODULES variable only +if the product has the property has_salome_hui = "yes"

        + +++ + + + +
        Parameters:list (lProducts) -- List of products to potentially add
        +
        + +
        +
        +is_defined(key)[source]¶
        +

        Check if the key exists in the environment

        + +++ + + + +
        Parameters:str (key) -- the environment variable to check
        +
        + +
        +
        +load_cfg_environment(cfg_env)[source]¶
        +

        Loads environment defined in cfg_env

        + +++ + + + +
        Parameters:Config (cfg_env) -- A config containing an environment
        +
        + +
        +
        +prepend(key, value, sep=':')[source]¶
        +

        prepend value to key using sep

        + +++ + + + +
        Parameters:
          +
        • str (sep) -- the environment variable to prepend
          • +
        • str -- the value to prepend to key
          • +
        • str -- the separator string
          • +
        +
        +
        + +
        +
        +run_env_script(product_info, logger=None, native=False)[source]¶
        +

        Runs an environment script.

        + +++ + + + +
        Parameters:
          +
        • Config (product_info) -- The product description
          • +
        • Logger (logger) -- The logger instance to display messages
          • +
        • Boolean (native) -- if True load set_native_env instead of set_env
          • +
        +
        +
        + +
        +
        +run_simple_env_script(script_path, logger=None)[source]¶
        +

        Runs an environment script. Same as run_env_script, but with a +script path as parameter.

        + +++ + + + +
        Parameters:
          +
        • str (script_path) -- a path to an environment script
          • +
        • Logger (logger) -- The logger instance to display messages
          • +
        +
        +
        + +
        +
        +set(key, value)[source]¶
        +

        Set the environment variable "key" to value "value"

        + +++ + + + +
        Parameters:
          +
        • str (value) -- the environment variable to set
          • +
        • str -- the value
          • +
        +
        +
        + +
        +
        +set_a_product(product, logger)[source]¶
        +

        Sets the environment of a product.

        + +++ + + + +
        Parameters:
          +
        • str (product) -- The product name
          • +
        • Logger (logger) -- The logger instance to display messages
          • +
        +
        +
        + +
        +
        +set_application_env(logger)[source]¶
        +

        Sets the environment defined in the APPLICATION file.

        + +++ + + + +
        Parameters:Logger (logger) -- The logger instance to display messages
        +
        + +
        +
        +set_cpp_env(product_info)[source]¶
        +

        Sets the generic environment for a SALOME cpp product.

        + +++ + + + +
        Parameters:Config (product_info) -- The product description
        +
        + +
        +
        +set_full_environ(logger, env_info)[source]¶
        +

        Sets the full environment for products +specified in env_info dictionary.

        + +++ + + + +
        Parameters:
          +
        • Logger (logger) -- The logger instance to display messages
          • +
        • list (env_info) -- the list of products
          • +
        +
        +
        + +
        +
        +set_products(logger, src_root=None)[source]¶
        +

        Sets the environment for all the products.

        + +++ + + + +
        Parameters:
          +
        • Logger (logger) -- The logger instance to display messages
          • +
        • src (src_root) -- the application working directory
          • +
        +
        +
        + +
        +
        +set_python_libdirs()[source]¶
        +

        Set some generic variables for python library paths

        +
        + +
        +
        +set_salome_generic_product_env(pi)[source]¶
        +

        Sets the generic environment for a SALOME product.

        + +++ + + + +
        Parameters:Config (pi) -- The product description
        +
        + +
        +
        +set_salome_minimal_product_env(product_info, logger)[source]¶
        +

        Sets the minimal environment for a SALOME product. +xxx_ROOT_DIR and xxx_SRC_DIR

        + +++ + + + +
        Parameters:
          +
        • Config (product_info) -- The product description
          • +
        • Logger (logger) -- The logger instance to display messages
          • +
        +
        +
        + +
        + +
        +
        +class src.environment.Shell(name, extension)[source]¶
        +

        Definition of a Shell.

        +
        + +
        +
        +src.environment.load_environment(config, build, logger)[source]¶
        +

        Loads the environment (used to run the tests, for example).

        + +++ + + + +
        Parameters:
          +
        • Config (config) -- the global config
          • +
        • bool (build) -- build environement if True
          • +
        • Logger (logger) -- The logger instance to display messages
          • +
        +
        +
        + +
        +
        +

        fileEnviron Module¶

        +
        +
        +class src.fileEnviron.BashFileEnviron(output, environ=None)[source]¶
        +

        Bases: src.fileEnviron.FileEnviron

        +

        Class for bash shell.

        +
        +
        +command_value(key, command)[source]¶
        +

        Get the value given by the system command "command" +and put it in the environment variable key. +Has to be overwritten in the derived classes +This can be seen as a virtual method

        + +++ + + + +
        Parameters:
          +
        • str (command) -- the environment variable
          • +
        • str -- the command to execute
          • +
        +
        +
        + +
        +
        +finish(required=True)[source]¶
        +

        Add a final instruction in the out file (in case of file generation)

        + +++ + + + +
        Parameters:bool (required) -- Do nothing if required is False
        +
        + +
        +
        +set(key, value)[source]¶
        +

        Set the environment variable "key" to value "value"

        + +++ + + + +
        Parameters:
          +
        • str (value) -- the environment variable to set
          • +
        • str -- the value
          • +
        +
        +
        + +
        + +
        +
        +class src.fileEnviron.BatFileEnviron(output, environ=None)[source]¶
        +

        Bases: src.fileEnviron.FileEnviron

        +

        for Windows batch shell.

        +
        +
        +add_comment(comment)[source]¶
        +

        Add a comment in the shell file

        + +++ + + + +
        Parameters:str (comment) -- the comment to add
        +
        + +
        +
        +command_value(key, command)[source]¶
        +

        Get the value given by the system command "command" +and put it in the environment variable key. +Has to be overwritten in the derived classes +This can be seen as a virtual method

        + +++ + + + +
        Parameters:
          +
        • str (command) -- the environment variable
          • +
        • str -- the command to execute
          • +
        +
        +
        + +
        +
        +finish(required=True)[source]¶
        +

        Add a final instruction in the out file (in case of file generation) +In the particular windows case, do nothing

        + +++ + + + +
        Parameters:bool (required) -- Do nothing if required is False
        +
        + +
        +
        +get(key)[source]¶
        +

        Get the value of the environment variable "key"

        + +++ + + + +
        Parameters:str (key) -- the environment variable
        +
        + +
        +
        +set(key, value)[source]¶
        +

        Set the environment variable "key" to value "value"

        + +++ + + + +
        Parameters:
          +
        • str (value) -- the environment variable to set
          • +
        • str -- the value
          • +
        +
        +
        + +
        + +
        +
        +class src.fileEnviron.ContextFileEnviron(output, environ=None)[source]¶
        +

        Bases: src.fileEnviron.FileEnviron

        +

        Class for a salome context configuration file.

        +
        +
        +add_echo(text)[source]¶
        +

        Add a comment

        + +++ + + + +
        Parameters:str (text) -- the comment to add
        +
        + +
        +
        +add_warning(warning)[source]¶
        +

        Add a warning

        + +++ + + + +
        Parameters:str (text) -- the warning to add
        +
        + +
        +
        +append_value(key, value, sep=':')[source]¶
        +

        append value to key using sep

        + +++ + + + +
        Parameters:
          +
        • str (sep) -- the environment variable to append
          • +
        • str -- the value to append to key
          • +
        • str -- the separator string
          • +
        +
        +
        + +
        +
        +command_value(key, command)[source]¶
        +

        Get the value given by the system command "command" +and put it in the environment variable key. +Has to be overwritten in the derived classes +This can be seen as a virtual method

        + +++ + + + +
        Parameters:
          +
        • str (command) -- the environment variable
          • +
        • str -- the command to execute
          • +
        +
        +
        + +
        +
        +finish(required=True)[source]¶
        +

        Add a final instruction in the out file (in case of file generation)

        + +++ + + + +
        Parameters:bool (required) -- Do nothing if required is False
        +
        + +
        +
        +get(key)[source]¶
        +

        Get the value of the environment variable "key"

        + +++ + + + +
        Parameters:str (key) -- the environment variable
        +
        + +
        +
        +prepend_value(key, value, sep=':')[source]¶
        +

        prepend value to key using sep

        + +++ + + + +
        Parameters:
          +
        • str (sep) -- the environment variable to prepend
          • +
        • str -- the value to prepend to key
          • +
        • str -- the separator string
          • +
        +
        +
        + +
        +
        +set(key, value)[source]¶
        +

        Set the environment variable "key" to value "value"

        + +++ + + + +
        Parameters:
          +
        • str (value) -- the environment variable to set
          • +
        • str -- the value
          • +
        +
        +
        + +
        + +
        +
        +class src.fileEnviron.FileEnviron(output, environ=None)[source]¶
        +

        Bases: object

        +

        Base class for shell environment

        +
        +
        +add_comment(comment)[source]¶
        +

        Add a comment in the shell file

        + +++ + + + +
        Parameters:str (comment) -- the comment to add
        +
        + +
        +
        +add_echo(text)[source]¶
        +

        Add a "echo" in the shell file

        + +++ + + + +
        Parameters:str (text) -- the text to echo
        +
        + +
        +
        +add_line(number)[source]¶
        +

        Add some empty lines in the shell file

        + +++ + + + +
        Parameters:int (number) -- the number of lines to add
        +
        + +
        +
        +add_warning(warning)[source]¶
        +

        Add a warning "echo" in the shell file

        + +++ + + + +
        Parameters:str (warning) -- the text to echo
        +
        + +
        +
        +append(key, value, sep=':')[source]¶
        +

        Same as append_value but the value argument can be a list

        + +++ + + + +
        Parameters:
          +
        • str (sep) -- the environment variable to append
          • +
        • str or list (value) -- the value(s) to append to key
          • +
        • str -- the separator string
          • +
        +
        +
        + +
        +
        +append_value(key, value, sep=':')[source]¶
        +

        append value to key using sep

        + +++ + + + +
        Parameters:
          +
        • str (sep) -- the environment variable to append
          • +
        • str -- the value to append to key
          • +
        • str -- the separator string
          • +
        +
        +
        + +
        +
        +command_value(key, command)[source]¶
        +

        Get the value given by the system command "command" +and put it in the environment variable key. +Has to be overwritten in the derived classes +This can be seen as a virtual method

        + +++ + + + +
        Parameters:
          +
        • str (command) -- the environment variable
          • +
        • str -- the command to execute
          • +
        +
        +
        + +
        +
        +finish(required=True)[source]¶
        +

        Add a final instruction in the out file (in case of file generation)

        + +++ + + + +
        Parameters:bool (required) -- Do nothing if required is False
        +
        + +
        +
        +get(key)[source]¶
        +

        Get the value of the environment variable "key"

        + +++ + + + +
        Parameters:str (key) -- the environment variable
        +
        + +
        +
        +is_defined(key)[source]¶
        +

        Check if the key exists in the environment

        + +++ + + + +
        Parameters:str (key) -- the environment variable to check
        +
        + +
        +
        +prepend(key, value, sep=':')[source]¶
        +

        Same as prepend_value but the value argument can be a list

        + +++ + + + +
        Parameters:
          +
        • str (sep) -- the environment variable to prepend
          • +
        • str or list (value) -- the value(s) to prepend to key
          • +
        • str -- the separator string
          • +
        +
        +
        + +
        +
        +prepend_value(key, value, sep=':')[source]¶
        +

        prepend value to key using sep

        + +++ + + + +
        Parameters:
          +
        • str (sep) -- the environment variable to prepend
          • +
        • str -- the value to prepend to key
          • +
        • str -- the separator string
          • +
        +
        +
        + +
        +
        +set(key, value)[source]¶
        +

        Set the environment variable 'key' to value 'value'

        + +++ + + + +
        Parameters:
          +
        • str (value) -- the environment variable to set
          • +
        • str -- the value
          • +
        +
        +
        + +
        + +
        +
        +class src.fileEnviron.LauncherFileEnviron(output, environ=None)[source]¶
        +

        Class to generate a launcher file script +(in python syntax) SalomeContext API

        +
        +
        +add(key, value)[source]¶
        +

        prepend value to key using sep

        + +++ + + + +
        Parameters:
          +
        • str (value) -- the environment variable to prepend
          • +
        • str -- the value to prepend to key
          • +
        +
        +
        + +
        +
        +add_comment(comment)[source]¶
        +
        + +
        +
        +add_echo(text)[source]¶
        +

        Add a comment

        + +++ + + + +
        Parameters:str (text) -- the comment to add
        +
        + +
        +
        +add_line(number)[source]¶
        +

        Add some empty lines in the launcher file

        + +++ + + + +
        Parameters:int (number) -- the number of lines to add
        +
        + +
        +
        +add_warning(warning)[source]¶
        +

        Add a warning

        + +++ + + + +
        Parameters:str (text) -- the warning to add
        +
        + +
        +
        +append(key, value, sep=':')[source]¶
        +

        Same as append_value but the value argument can be a list

        + +++ + + + +
        Parameters:
          +
        • str (sep) -- the environment variable to append
          • +
        • str or list (value) -- the value(s) to append to key
          • +
        • str -- the separator string
          • +
        +
        +
        + +
        +
        +append_value(key, value, sep=':')[source]¶
        +

        append value to key using sep

        + +++ + + + +
        Parameters:
          +
        • str (sep) -- the environment variable to append
          • +
        • str -- the value to append to key
          • +
        • str -- the separator string
          • +
        +
        +
        + +
        +
        +change_to_launcher(value)[source]¶
        +
        + +
        +
        +command_value(key, command)[source]¶
        +

        Get the value given by the system command "command" +and put it in the environment variable key.

        + +++ + + + +
        Parameters:
          +
        • str (command) -- the environment variable
          • +
        • str -- the command to execute
          • +
        +
        +
        + +
        +
        +finish(required=True)[source]¶
        +

        Add a final instruction in the out file (in case of file generation) +In the particular launcher case, do nothing

        + +++ + + + +
        Parameters:bool (required) -- Do nothing if required is False
        +
        + +
        +
        +get(key)[source]¶
        +

        Get the value of the environment variable "key"

        + +++ + + + +
        Parameters:str (key) -- the environment variable
        +
        + +
        +
        +is_defined(key)[source]¶
        +

        Check if the key exists in the environment

        + +++ + + + +
        Parameters:str (key) -- the environment variable to check
        +
        + +
        +
        +prepend(key, value, sep=':')[source]¶
        +

        Same as prepend_value but the value argument can be a list

        + +++ + + + +
        Parameters:
          +
        • str (sep) -- the environment variable to prepend
          • +
        • str or list (value) -- the value(s) to prepend to key
          • +
        • str -- the separator string
          • +
        +
        +
        + +
        +
        +prepend_value(key, value, sep=':')[source]¶
        +

        prepend value to key using sep

        + +++ + + + +
        Parameters:
          +
        • str (sep) -- the environment variable to prepend
          • +
        • str -- the value to prepend to key
          • +
        • str -- the separator string
          • +
        +
        +
        + +
        +
        +set(key, value)[source]¶
        +

        Set the environment variable "key" to value "value"

        + +++ + + + +
        Parameters:
          +
        • str (value) -- the environment variable to set
          • +
        • str -- the value
          • +
        +
        +
        + +
        + +
        +
        +class src.fileEnviron.ScreenEnviron(output, environ=None)[source]¶
        +

        Bases: src.fileEnviron.FileEnviron

        +
        +
        +add_comment(comment)[source]¶
        +
        + +
        +
        +add_echo(text)[source]¶
        +
        + +
        +
        +add_line(number)[source]¶
        +
        + +
        +
        +add_warning(warning)[source]¶
        +
        + +
        +
        +append(name, value, sep=':')[source]¶
        +
        + +
        +
        +command_value(key, command)[source]¶
        +
        + +
        +
        +get(name)[source]¶
        +
        + +
        +
        +is_defined(name)[source]¶
        +
        + +
        +
        +prepend(name, value, sep=':')[source]¶
        +
        + +
        +
        +run_env_script(module, script)[source]¶
        +
        + +
        +
        +set(name, value)[source]¶
        +
        + +
        +
        +write(command, name, value, sign='=')[source]¶
        +
        + +
        + +
        +
        +src.fileEnviron.get_file_environ(output, shell, environ=None)[source]¶
        +

        Instantiate correct FileEnvironment sub-class.

        + +++ + + + +
        Parameters:
          +
        • file (output) -- the output file stream.
          • +
        • str (shell) -- the type of shell syntax to use.
          • +
        • dict (environ) -- a potential additional environment.
          • +
        +
        +
        + +
        +
        +src.fileEnviron.special_path_separator(name)[source]¶
        +

        TCLLIBPATH, TKLIBPATH, PV_PLUGIN_PATH environments variables need +some exotic path separator. +This function gives the separator regarding the name of the variable +to append or prepend.

        + +++ + + + +
        Parameters:str (name) -- The name of the variable to find the separator
        +
        + +
        +
        +

        fork Module¶

        +
        +
        +src.fork.batch(cmd, logger, cwd, args=[], log=None, delai=20, sommeil=1)[source]¶
        +
        + +
        +
        +src.fork.batch_salome(cmd, logger, cwd, args, getTmpDir, pendant='SALOME_Session_Server', fin='killSalome.py', log=None, delai=20, sommeil=1, delaiapp=0)[source]¶
        +
        + +
        +
        +src.fork.launch_command(cmd, logger, cwd, args=[], log=None)[source]¶
        +
        + +
        +
        +src.fork.show_progress(logger, top, delai, ss='')[source]¶
        +

        shortcut function to display the progression

        + +++ + + + +
        Parameters:
          +
        • Logger (logger) -- The logging instance
          • +
        • int (delai) -- the number to display
          • +
        • int -- the number max
          • +
        • str (ss) -- the string to display
          • +
        +
        +
        + +
        +
        +src.fork.write_back(logger, message, level)[source]¶
        +

        shortcut function to write at the begin of the line

        + +++ + + + +
        Parameters:
          +
        • Logger (logger) -- The logging instance
          • +
        • str (message) -- the text to display
          • +
        • int (level) -- the level of verbosity
          • +
        +
        +
        + +
        +
        +

        logger Module¶

        +

        Implements the classes and method relative to the logging

        +
        +
        +class src.logger.Logger(config, silent_sysstd=False, all_in_terminal=False, micro_command=False)[source]¶
        +

        Bases: object

        +

        Class to handle log mechanism.

        +
        + +

        Add a link to another log file.

        + +++ + + + + + + +
        Parameters:
          +
        • str (command_res) -- The file name of the link.
          • +
        • str -- The name of the command linked.
          • +
        • str -- The result of the command linked. "0" or "1"
          • +
        +
        Parma full_launched_command str:
         

        The full lanch command +("sat command ...")

        +
        +
        + +
        +
        +end_write(attribute)[source]¶
        +

        Called just after command end: Put all fields +corresponding to the command end context (time). +Write the log xml file on the hard drive. +And display the command to launch to get the log

        + +++ + + + +
        Parameters:dict (attribute) -- the attribute to add to the node "Site".
        +
        + +
        +
        +error(message)[source]¶
        +

        Print an error.

        + +++ + + + +
        Parameters:str (message) -- The message to print.
        +
        + +
        +
        +flush()[source]¶
        +

        Flush terminal

        +
        + +
        +
        +put_initial_xml_fields()[source]¶
        +

        Called at class initialization: Put all fields +corresponding to the command context (user, time, ...)

        +
        + +
        +
        +write(message, level=None, screenOnly=False)[source]¶
        +

        function used in the commands +to print in the terminal and the log file.

        + +++ + + + +
        Parameters:
          +
        • str (message) -- The message to print.
          • +
        • int (level) -- The output level corresponding +to the message 0 < level < 6.
          • +
        • boolean (screenOnly) -- if True, do not write in log file.
          • +
        +
        +
        + +
        + +
        +
        +src.logger.date_to_datetime(date)[source]¶
        +

        From a string date in format YYYYMMDD_HHMMSS +returns list year, mon, day, hour, minutes, seconds

        + +++ + + + + + + + +
        Parameters:str (date) -- The date in format YYYYMMDD_HHMMSS
        Returns:the same date and time in separate variables.
        Return type:(str,str,str,str,str,str)
        +
        + +
        +
        +src.logger.list_log_file(dirPath, expression)[source]¶
        +

        Find all files corresponding to expression in dirPath

        + +++ + + + + + + + +
        Parameters:
          +
        • str (expression) -- the directory where to search the files
          • +
        • str -- the regular expression of files to find
          • +
        +
        Returns:

        the list of files path and informations about it

        +
        Return type:

        list

        +
        +
        + +
        +
        +src.logger.show_command_log(logFilePath, cmd, application, notShownCommands)[source]¶
        +

        Used in updateHatXml. +Determine if the log xml file logFilePath +has to be shown or not in the hat log.

        + +++ + + + + + + + +
        Parameters:
          +
        • str (application) -- the path to the command xml log file
          • +
        • str -- the command of the log file
          • +
        • str -- the application passed as parameter +to the salomeTools command
          • +
        • list (notShownCommands) -- the list of commands +that are not shown by default
          • +
        +
        Returns:

        True if cmd is not in notShownCommands and the application +in the log file corresponds to application

        +
        Return type:

        boolean

        +
        +
        + +
        +
        +src.logger.timedelta_total_seconds(timedelta)[source]¶
        +

        Replace total_seconds from datetime module +in order to be compatible with old python versions

        + +++ + + + + + + + +
        Parameters:datetime.timedelta (timedelta) -- The delta between two dates
        Returns:The number of seconds corresponding to timedelta.
        Return type:float
        +
        + +
        +
        +src.logger.update_hat_xml(logDir, application=None, notShownCommands=[])[source]¶
        +

        Create the xml file in logDir that contain all the xml file +and have a name like YYYYMMDD_HHMMSS_namecmd.xml

        + +++ + + + +
        Parameters:
          +
        • str (application) -- the directory to parse
          • +
        • str -- the name of the application if there is any
          • +
        +
        +
        + +
        +
        +

        options Module¶

        +

        The Options class that manages the access to all options passed as +parameters in salomeTools command lines

        +
        +
        +class src.options.OptResult[source]¶
        +

        Bases: object

        +

        An instance of this class will be the object manipulated +in code of all salomeTools commands +The aim of this class is to have an elegant syntax +to manipulate the options. +ex: +print(options.level) +5

        +
        + +
        +
        +class src.options.Options[source]¶
        +

        Class to manage all salomeTools options

        +
        +
        +add_option(shortName, longName, optionType, destName, helpString='', default=None)[source]¶
        +

        Method to add an option to a command. It gets all attributes +of an option and append it in the options field

        + +++ + + + + + + + +
        Parameters:
          +
        • str (helpString) -- The short name of the option +(ex "l" for level option).
          • +
        • str -- The long name of the option +(ex "level" for level option).
          • +
        • str -- The type of the option (ex "int").
          • +
        • str -- The name that will be used in the code.
          • +
        • str -- The text to display +when user ask for help on a command.
          • +
        +
        Returns:

        Nothing.

        +
        Return type:

        NA

        +
        +
        + +
        +
        +parse_args(argList=None)[source]¶
        +

        Method that instantiates the class OptResult +that gives access to all options in the code

        + +++ + + + + + + + +
        Parameters:list (argList) -- the raw list of arguments that were passed
        Returns:optResult, args : optResult is the option instance +to manipulate in the code. args +is the full raw list of passed options
        Return type:(class 'common.options.OptResult',list)
        +
        + +
        +
        +print_help()[source]¶
        +

        Method that display all options stored in self.options and there help

        + +++ + + + + + +
        Returns:Nothing.
        Return type:NA
        +
        + +
        + +
        +
        +

        printcolors Module¶

        +

        In this file is stored the mechanism that manage color prints in the terminal

        +
        +
        +src.printcolors.cleancolor(message)[source]¶
        +

        remove color from a colored text.

        + +++ + + + + + + + +
        Parameters:str (message) -- The text to be cleaned.
        Returns:The cleaned text.
        Return type:str
        +
        + +
        +
        +src.printcolors.print_color_map()[source]¶
        +

        This method prints the color map

        +
        + +
        +
        +src.printcolors.print_color_range(start, end)[source]¶
        +

        print possible range values for colors

        + +++ + + + +
        Parameters:
          +
        • int (end) -- The smaller value.
          • +
        • int -- The bigger value.
          • +
        +
        +
        + +
        +
        +src.printcolors.print_value(logger, label, value, level=1, suffix='')[source]¶
        +

        shortcut method to print a label and a value with the info color

        + +++ + + + +
        Parameters:
          +
        • class logger (logger) -- the logger instance.
          • +
        • int (level) -- the label to print.
          • +
        • str (suffix) -- the value to print.
          • +
        • int -- the level of verboseness.
          • +
        • str -- the suffix to add at the end.
          • +
        +
        +
        + +
        +
        +src.printcolors.printc(txt, code='')[source]¶
        +

        print a text with colors

        + +++ + + + + + + + +
        Parameters:
          +
        • str (code) -- The text to be printed.
          • +
        • str -- The color to use.
          • +
        +
        Returns:

        The colored text.

        +
        Return type:

        str

        +
        +
        + +
        +
        +src.printcolors.printcError(txt)[source]¶
        +

        print a text error color

        + +++ + + + + + + + +
        Parameters:str (txt) -- The text to be printed.
        Returns:The colored text.
        Return type:str
        +
        + +
        +
        +src.printcolors.printcHeader(txt)[source]¶
        +

        print a text header color

        + +++ + + + + + + + +
        Parameters:str (txt) -- The text to be printed.
        Returns:The colored text.
        Return type:str
        +
        + +
        +
        +src.printcolors.printcHighlight(txt)[source]¶
        +

        print a text highlight color

        + +++ + + + + + + + +
        Parameters:str (txt) -- The text to be printed.
        Returns:The colored text.
        Return type:str
        +
        + +
        +
        +src.printcolors.printcInfo(txt)[source]¶
        +

        print a text info color

        + +++ + + + + + + + +
        Parameters:str (txt) -- The text to be printed.
        Returns:The colored text.
        Return type:str
        +
        + +
        +
        +src.printcolors.printcLabel(txt)[source]¶
        +

        print a text label color

        + +++ + + + + + + + +
        Parameters:str (txt) -- The text to be printed.
        Returns:The colored text.
        Return type:str
        +
        + +
        +
        +src.printcolors.printcSuccess(txt)[source]¶
        +

        print a text success color

        + +++ + + + + + + + +
        Parameters:str (txt) -- The text to be printed.
        Returns:The colored text.
        Return type:str
        +
        + +
        +
        +src.printcolors.printcWarning(txt)[source]¶
        +

        print a text warning color

        + +++ + + + + + + + +
        Parameters:str (txt) -- The text to be printed.
        Returns:The colored text.
        Return type:str
        +
        + +
        +
        +

        product Module¶

        +

        In this file are implemented the methods +relative to the product notion of salomeTools

        +
        +
        +src.product.check_config_exists(config, prod_dir, prod_info)[source]¶
        +

        Verify that the installation directory of a product in a base exists +Check all the config-<i> directory and verify the sat-config.pyconf file +that is in it

        + +++ + + + + + + + +
        Parameters:
          +
        • Config (product_info) -- The global configuration
          • +
        • str (prod_dir) -- The product installation directory path +(without config-<i>)
          • +
        • Config -- The configuration specific to +the product
          • +
        +
        Returns:

        True or false is the installation is found or not +and if it is found, the path of the found installation

        +
        Return type:

        (boolean, str)

        +
        +
        + +
        +
        +src.product.check_installation(product_info)[source]¶
        +

        Verify if a product is well installed. Checks install directory presence +and some additional files if it is defined in the config

        + +++ + + + + + + + +
        Parameters:Config (product_info) -- The configuration specific to +the product
        Returns:True if it is well installed
        Return type:boolean
        +
        + +
        +
        +src.product.check_source(product_info)[source]¶
        +

        Verify if a sources of product is preset. Checks source directory presence

        + +++ + + + + + + + +
        Parameters:Config (product_info) -- The configuration specific to +the product
        Returns:True if it is well installed
        Return type:boolean
        +
        + +
        +
        +src.product.get_base_install_dir(config, prod_info, version)[source]¶
        +

        Compute the installation directory of a product in base

        + +++ + + + + + + + +
        Parameters:
          +
        • Config (product_info) -- The global configuration
          • +
        • Config -- The configuration specific to +the product
          • +
        • str (version) -- The version of the product
          • +
        +
        Returns:

        The path of the product installation

        +
        Return type:

        str

        +
        +
        + +
        +
        +src.product.get_install_dir(config, base, version, prod_info)[source]¶
        +

        Compute the installation directory of a given product

        + +++ + + + + + + + +
        Parameters:
          +
        • Config (product_info) -- The global configuration
          • +
        • str (version) -- This corresponds to the value given by user in its +application.pyconf for the specific product. If "yes", the +user wants the product to be in base. If "no", he wants the +product to be in the application workdir
          • +
        • str -- The version of the product
          • +
        • Config -- The configuration specific to +the product
          • +
        +
        Returns:

        The path of the product installation

        +
        Return type:

        str

        +
        +
        + +
        +
        +src.product.get_product_components(product_info)[source]¶
        +

        Get the component list to generate with the product

        + +++ + + + + + + + +
        Parameters:Config (product_info) -- The configuration specific to +the product
        Returns:The list of names of the components
        Return type:List
        +
        + +
        +
        +src.product.get_product_config(config, product_name, with_install_dir=True)[source]¶
        +

        Get the specific configuration of a product from the global configuration

        + +++ + + + + + + + +
        Parameters:
          +
        • Config (config) -- The global configuration
          • +
        • str (product_name) -- The name of the product
          • +
        • boolean (with_install_dir) -- If false, do not provide an install +directory (at false only for internal use +of the function check_config_exists)
          • +
        +
        Returns:

        the specific configuration of the product

        +
        Return type:

        Config

        +
        +
        + +
        +
        +src.product.get_product_dependencies(config, product_info)[source]¶
        +

        Get recursively the list of products that are +in the product_info dependencies

        + +++ + + + + + + + +
        Parameters:
          +
        • Config (product_info) -- The global configuration
          • +
        • Config -- The configuration specific to +the product
          • +
        +
        Returns:

        the list of products in dependence

        +
        Return type:

        list

        +
        +
        + +
        +
        +src.product.get_product_section(config, product_name, version, section=None)[source]¶
        +

        Get the product description from the configuration

        + +++ + + + + + + + +
        Parameters:
          +
        • Config (config) -- The global configuration
          • +
        • str (section) -- The product name
          • +
        • str -- The version of the product
          • +
        • str -- The searched section (if not None, the section is +explicitly given
          • +
        +
        Returns:

        The product description

        +
        Return type:

        Config

        +
        +
        + +
        +
        +src.product.get_products_infos(lproducts, config)[source]¶
        +

        Get the specific configuration of a list of products

        + +++ + + + + + + + +
        Parameters:
          +
        • List (lproducts) -- The list of product names
          • +
        • Config (config) -- The global configuration
          • +
        +
        Returns:

        the list of tuples +(product name, specific configuration of the product)

        +
        Return type:

        [(str, Config)]

        +
        +
        + +
        +
        +src.product.product_compiles(product_info)[source]¶
        +

        Know if a product compiles or not +(some products do not have a compilation procedure)

        + +++ + + + + + + + +
        Parameters:Config (product_info) -- The configuration specific to +the product
        Returns:True if the product compiles, else False
        Return type:boolean
        +
        + +
        +
        +src.product.product_has_env_script(product_info)[source]¶
        +

        Know if a product has an environment script

        + +++ + + + + + + + +
        Parameters:Config (product_info) -- The configuration specific to +the product
        Returns:True if the product it has an environment script, else False
        Return type:boolean
        +
        + +
        + +

        Know if a product has a logo (YACSGEN generate)

        + +++ + + + + + + + +
        Parameters:Config (product_info) -- The configuration specific to +the product
        Returns:The path of the logo if the product has a logo, else False
        Return type:Str
        +
        + +
        +
        +src.product.product_has_patches(product_info)[source]¶
        +

        Know if a product has one or more patches

        + +++ + + + + + + + +
        Parameters:Config (product_info) -- The configuration specific to +the product
        Returns:True if the product has one or more patches
        Return type:boolean
        +
        + +
        +
        +src.product.product_has_salome_gui(product_info)[source]¶
        +

        Know if a product has a SALOME gui

        + +++ + + + + + + + +
        Parameters:Config (product_info) -- The configuration specific to +the product
        Returns:True if the product has a SALOME gui, else False
        Return type:Boolean
        +
        + +
        +
        +src.product.product_has_script(product_info)[source]¶
        +

        Know if a product has a compilation script

        + +++ + + + + + + + +
        Parameters:Config (product_info) -- The configuration specific to +the product
        Returns:True if the product it has a compilation script, else False
        Return type:boolean
        +
        + +
        +
        +src.product.product_is_autotools(product_info)[source]¶
        +

        Know if a product is compiled using the autotools

        + +++ + + + + + + + +
        Parameters:Config (product_info) -- The configuration specific to +the product
        Returns:True if the product is autotools, else False
        Return type:boolean
        +
        + +
        +
        +src.product.product_is_cmake(product_info)[source]¶
        +

        Know if a product is compiled using the cmake

        + +++ + + + + + + + +
        Parameters:Config (product_info) -- The configuration specific to +the product
        Returns:True if the product is cmake, else False
        Return type:boolean
        +
        + +
        +
        +src.product.product_is_cpp(product_info)[source]¶
        +

        Know if a product is cpp

        + +++ + + + + + + + +
        Parameters:Config (product_info) -- The configuration specific to +the product
        Returns:True if the product is a cpp, else False
        Return type:boolean
        +
        + +
        +
        +src.product.product_is_debug(product_info)[source]¶
        +

        Know if a product is in debug mode

        + +++ + + + + + + + +
        Parameters:Config (product_info) -- The configuration specific to +the product
        Returns:True if the product is in debug mode, else False
        Return type:boolean
        +
        + +
        +
        +src.product.product_is_dev(product_info)[source]¶
        +

        Know if a product is in dev mode

        + +++ + + + + + + + +
        Parameters:Config (product_info) -- The configuration specific to +the product
        Returns:True if the product is in dev mode, else False
        Return type:boolean
        +
        + +
        +
        +src.product.product_is_fixed(product_info)[source]¶
        +

        Know if a product is fixed

        + +++ + + + + + + + +
        Parameters:Config (product_info) -- The configuration specific to +the product
        Returns:True if the product is fixed, else False
        Return type:boolean
        +
        + +
        +
        +src.product.product_is_generated(product_info)[source]¶
        +

        Know if a product is generated (YACSGEN)

        + +++ + + + + + + + +
        Parameters:Config (product_info) -- The configuration specific to +the product
        Returns:True if the product is generated
        Return type:boolean
        +
        + +
        +
        +src.product.product_is_mpi(product_info)[source]¶
        +

        Know if a product has openmpi in its dependencies

        + +++ + + + + + + + +
        Parameters:Config (product_info) -- The configuration specific to +the product
        Returns:True if the product has openmpi inits dependencies
        Return type:boolean
        +
        + +
        +
        +src.product.product_is_native(product_info)[source]¶
        +

        Know if a product is native

        + +++ + + + + + + + +
        Parameters:Config (product_info) -- The configuration specific to +the product
        Returns:True if the product is native, else False
        Return type:boolean
        +
        + +
        +
        +src.product.product_is_salome(product_info)[source]¶
        +

        Know if a product is a SALOME module

        + +++ + + + + + + + +
        Parameters:Config (product_info) -- The configuration specific to +the product
        Returns:True if the product is a SALOME module, else False
        Return type:boolean
        +
        + +
        +
        +src.product.product_is_sample(product_info)[source]¶
        +

        Know if a product has the sample type

        + +++ + + + + + + + +
        Parameters:Config (product_info) -- The configuration specific to +the product
        Returns:True if the product has the sample type, else False
        Return type:boolean
        +
        + +
        +
        +src.product.product_is_smesh_plugin(product_info)[source]¶
        +

        Know if a product is a SMESH plugin

        + +++ + + + + + + + +
        Parameters:Config (product_info) -- The configuration specific to +the product
        Returns:True if the product is a SMESH plugin, else False
        Return type:boolean
        +
        + +
        +
        +src.product.product_is_vcs(product_info)[source]¶
        +

        Know if a product is download using git, svn or cvs (not archive)

        + +++ + + + + + + + +
        Parameters:Config (product_info) -- The configuration specific to +the product
        Returns:True if the product is vcs, else False
        Return type:boolean
        +
        + +
        +
        +

        pyconf Module¶

        +

        This is a configuration module for Python.

        +

        This module should work under Python versions >= 2.2, and cannot be used with +earlier versions since it uses new-style classes.

        +

        Development and testing has only been carried out (so far) on Python 2.3.4 and +Python 2.4.2. See the test module (test_config.py) included in the +U{distribution<http://www.red-dove.com/python_config.html|_blank>} (follow the +download link).

        +

        A simple example - with the example configuration file:

        +
        messages:
+[
+  {
+    stream : `sys.stderr`
+    message: 'Welcome'
+    name: 'Harry'
+  }
+  {
+    stream : `sys.stdout`
+    message: 'Welkom'
+    name: 'Ruud'
+  }
+  {
+    stream : $messages[0].stream
+    message: 'Bienvenue'
+    name: Yves
+  }
+]
        +
        +

        a program to read the configuration would be:

        +
        from config import Config
+
+f = file('simple.cfg')
+cfg = Config(f)
+for m in cfg.messages:
+    s = '%s, %s' % (m.message, m.name)
+    try:
+        print >> m.stream, s
+    except IOError, e:
+        print e
+
        +
        +

        which, when run, would yield the console output:

        +
        Welcome, Harry
+Welkom, Ruud
+Bienvenue, Yves
+
        +
        +

        See U{this tutorial<http://www.red-dove.com/python_config.html|_blank>} for more +information.

        +

        #modified for salomeTools +@version: 0.3.7.1

        +

        @author: Vinay Sajip

        +

        @copyright: Copyright (C) 2004-2007 Vinay Sajip. All Rights Reserved.

        +

        @var streamOpener: The default stream opener. This is a factory function which +takes a string (e.g. filename) and returns a stream suitable for reading. If +unable to open the stream, an IOError exception should be thrown.

        +

        The default value of this variable is L{defaultStreamOpener}. For an example +of how it's used, see test_config.py (search for streamOpener).

        +
        +
        +class src.pyconf.Config(streamOrFile=None, parent=None, PWD=None)[source]¶
        +

        Bases: src.pyconf.Mapping

        +

        This class represents a configuration, and is the only one which clients +need to interface to, under normal circumstances.

        +
        +
        +class Namespace[source]¶
        +

        Bases: object

        +

        This internal class is used for implementing default namespaces.

        +

        An instance acts as a namespace.

        +
        + +
        +
        +Config.addNamespace(ns, name=None)[source]¶
        +

        Add a namespace to this configuration which can be used to evaluate +(resolve) dotted-identifier expressions. +@param ns: The namespace to be added. +@type ns: A module or other namespace suitable for passing as an +argument to vars(). +@param name: A name for the namespace, which, if specified, provides +an additional level of indirection. +@type name: str

        +
        + +
        +
        +Config.getByPath(path)[source]¶
        +

        Obtain a value in the configuration via its path. +@param path: The path of the required value +@type path: str +@return the value at the specified path. +@rtype: any +@raise ConfigError: If the path is invalid

        +
        + +
        +
        +Config.load(stream)[source]¶
        +

        Load the configuration from the specified stream. Multiple streams can +be used to populate the same instance, as long as there are no +clashing keys. The stream is closed. +@param stream: A stream from which the configuration is read. +@type stream: A read-only stream (file-like object). +@raise ConfigError: if keys in the loaded configuration clash with +existing keys. +@raise ConfigFormatError: if there is a syntax error in the stream.

        +
        + +
        +
        +Config.removeNamespace(ns, name=None)[source]¶
        +

        Remove a namespace added with L{addNamespace}. +@param ns: The namespace to be removed. +@param name: The name which was specified when L{addNamespace} was +called. +@type name: str

        +
        + +
        + +
        +
        +exception src.pyconf.ConfigError[source]¶
        +

        Bases: exceptions.Exception

        +

        This is the base class of exceptions raised by this module.

        +
        + +
        +
        +exception src.pyconf.ConfigFormatError[source]¶
        +

        Bases: src.pyconf.ConfigError

        +

        This is the base class of exceptions raised due to syntax errors in +configurations.

        +
        + +
        +
        +class src.pyconf.ConfigInputStream(stream)[source]¶
        +

        Bases: object

        +

        An input stream which can read either ANSI files with default encoding +or Unicode files with BOMs.

        +

        Handles UTF-8, UTF-16LE, UTF-16BE. Could handle UTF-32 if Python had +built-in support.

        +
        +
        +close()[source]¶
        +
        + +
        +
        +read(size)[source]¶
        +
        + +
        +
        +readline()[source]¶
        +
        + +
        + +
        +
        +class src.pyconf.ConfigList[source]¶
        +

        Bases: list

        +

        This class implements an ordered list of configurations and allows you +to try getting the configuration from each entry in turn, returning +the first successfully obtained value.

        +
        +
        +getByPath(path)[source]¶
        +

        Obtain a value from the first configuration in the list which defines +it.

        +

        @param path: The path of the value to retrieve. +@type path: str +@return: The value from the earliest configuration in the list which +defines it. +@rtype: any +@raise ConfigError: If no configuration in the list has an entry with +the specified path.

        +
        + +
        + +
        +
        +class src.pyconf.ConfigMerger(resolver=<function defaultMergeResolve at 0x2379de8>)[source]¶
        +

        Bases: object

        +

        This class is used for merging two configurations. If a key exists in the +merge operand but not the merge target, then the entry is copied from the +merge operand to the merge target. If a key exists in both configurations, +then a resolver (a callable) is called to decide how to handle the +conflict.

        +
        +
        +handleMismatch(obj1, obj2)[source]¶
        +

        Handle a mismatch between two objects.

        +

        @param obj1: The object to merge into. +@type obj1: any +@param obj2: The object to merge. +@type obj2: any

        +
        + +
        +
        +merge(merged, mergee)[source]¶
        +

        Merge two configurations. The second configuration is unchanged, +and the first is changed to reflect the results of the merge.

        +

        @param merged: The configuration to merge into. +@type merged: L{Config}. +@param mergee: The configuration to merge. +@type mergee: L{Config}.

        +
        + +
        +
        +mergeMapping(map1, map2)[source]¶
        +

        Merge two mappings recursively. The second mapping is unchanged, +and the first is changed to reflect the results of the merge.

        +

        @param map1: The mapping to merge into. +@type map1: L{Mapping}. +@param map2: The mapping to merge. +@type map2: L{Mapping}.

        +
        + +
        +
        +mergeSequence(seq1, seq2)[source]¶
        +

        Merge two sequences. The second sequence is unchanged, +and the first is changed to have the elements of the second +appended to it.

        +

        @param seq1: The sequence to merge into. +@type seq1: L{Sequence}. +@param seq2: The sequence to merge. +@type seq2: L{Sequence}.

        +
        + +
        +
        +overwriteKeys(map1, seq2)[source]¶
        +

        Renint variables. The second mapping is unchanged, +and the first is changed depending the keys of the second mapping. +@param map1: The mapping to reinit keys into. +@type map1: L{Mapping}. +@param map2: The mapping container reinit information. +@type map2: L{Mapping}.

        +
        + +
        + +
        +
        +class src.pyconf.ConfigOutputStream(stream, encoding=None)[source]¶
        +

        Bases: object

        +

        An output stream which can write either ANSI files with default encoding +or Unicode files with BOMs.

        +

        Handles UTF-8, UTF-16LE, UTF-16BE. Could handle UTF-32 if Python had +built-in support.

        +
        +
        +close()[source]¶
        +
        + +
        +
        +flush()[source]¶
        +
        + +
        +
        +write(data)[source]¶
        +
        + +
        + +
        +
        +class src.pyconf.ConfigReader(config)[source]¶
        +

        Bases: object

        +

        This internal class implements a parser for configurations.

        +
        +
        +getChar()[source]¶
        +

        Get the next char from the stream. Update line and column numbers +appropriately.

        +

        @return: The next character from the stream. +@rtype: str

        +
        + +
        +
        +getToken()[source]¶
        +

        Get a token from the stream. String values are returned in a form +where you need to eval() the returned value to get the actual +string. The return value is (token_type, token_value).

        +

        Multiline string tokenizing is thanks to David Janes (BlogMatrix)

        +

        @return: The next token. +@rtype: A token tuple.

        +
        + +
        +
        +load(stream, parent=None, suffix=None)[source]¶
        +

        Load the configuration from the specified stream.

        +

        @param stream: A stream from which to load the configuration. +@type stream: A stream (file-like object). +@param parent: The parent of the configuration (to which this reader +belongs) in the hierarchy. Specified when the configuration is +included in another one. +@type parent: A L{Container} instance. +@param suffix: The suffix of this configuration in the parent +configuration. Should be specified whenever the parent is not None. +@raise ConfigError: If parent is specified but suffix is not. +@raise ConfigFormatError: If there are syntax errors in the stream.

        +
        + +
        +
        +location()[source]¶
        +

        Return the current location (filename, line, column) in the stream +as a string.

        +

        Used when printing error messages,

        +

        @return: A string representing a location in the stream being read. +@rtype: str

        +
        + +
        +
        +match(t)[source]¶
        +

        Ensure that the current token type matches the specified value, and +advance to the next token.

        +

        @param t: The token type to match. +@type t: A valid token type. +@return: The token which was last read from the stream before this +function is called. +@rtype: a token tuple - see L{getToken}. +@raise ConfigFormatError: If the token does not match what's expected.

        +
        + +
        +
        +parseFactor()[source]¶
        +

        Parse a factor in an multiplicative expression (a * b, a / b, a % b)

        +

        @return: the parsed factor +@rtype: any scalar +@raise ConfigFormatError: if a syntax error is found.

        +
        + +
        +
        +parseKeyValuePair(parent)[source]¶
        +

        Parse a key-value pair, and add it to the provided L{Mapping}.

        +

        @param parent: The mapping to add entries to. +@type parent: A L{Mapping} instance. +@raise ConfigFormatError: if a syntax error is found.

        +
        + +
        +
        +parseMapping(parent, suffix)[source]¶
        +

        Parse a mapping.

        +

        @param parent: The container to which the mapping will be added. +@type parent: A L{Container} instance. +@param suffix: The suffix for the value. +@type suffix: str +@return: a L{Mapping} instance representing the mapping. +@rtype: L{Mapping} +@raise ConfigFormatError: if a syntax error is found.

        +
        + +
        +
        +parseMappingBody(parent)[source]¶
        +

        Parse the internals of a mapping, and add entries to the provided +L{Mapping}.

        +

        @param parent: The mapping to add entries to. +@type parent: A L{Mapping} instance.

        +
        + +
        +
        +parseReference(type)[source]¶
        +

        Parse a reference.

        +

        @return: the parsed reference +@rtype: L{Reference} +@raise ConfigFormatError: if a syntax error is found.

        +
        + +
        +
        +parseScalar()[source]¶
        +

        Parse a scalar - a terminal value such as a string or number, or +an L{Expression} or L{Reference}.

        +

        @return: the parsed scalar +@rtype: any scalar +@raise ConfigFormatError: if a syntax error is found.

        +
        + +
        +
        +parseSequence(parent, suffix)[source]¶
        +

        Parse a sequence.

        +

        @param parent: The container to which the sequence will be added. +@type parent: A L{Container} instance. +@param suffix: The suffix for the value. +@type suffix: str +@return: a L{Sequence} instance representing the sequence. +@rtype: L{Sequence} +@raise ConfigFormatError: if a syntax error is found.

        +
        + +
        +
        +parseSuffix(ref)[source]¶
        +

        Parse a reference suffix.

        +

        @param ref: The reference of which this suffix is a part. +@type ref: L{Reference}. +@raise ConfigFormatError: if a syntax error is found.

        +
        + +
        +
        +parseTerm()[source]¶
        +

        Parse a term in an additive expression (a + b, a - b)

        +

        @return: the parsed term +@rtype: any scalar +@raise ConfigFormatError: if a syntax error is found.

        +
        + +
        +
        +parseValue(parent, suffix)[source]¶
        +

        Parse a value.

        +

        @param parent: The container to which the value will be added. +@type parent: A L{Container} instance. +@param suffix: The suffix for the value. +@type suffix: str +@return: The value +@rtype: any +@raise ConfigFormatError: if a syntax error is found.

        +
        + +
        +
        +setStream(stream)[source]¶
        +

        Set the stream to the specified value, and prepare to read from it.

        +

        @param stream: A stream from which to load the configuration. +@type stream: A stream (file-like object).

        +
        + +
        + +
        +
        +exception src.pyconf.ConfigResolutionError[source]¶
        +

        Bases: src.pyconf.ConfigError

        +

        This is the base class of exceptions raised due to semantic errors in +configurations.

        +
        + +
        +
        +class src.pyconf.Container(parent)[source]¶
        +

        Bases: object

        +

        This internal class is the base class for mappings and sequences.

        +

        @ivar path: A string which describes how to get +to this instance from the root of the hierarchy.

        +

        Example:

        +
        a.list.of[1].or['more'].elements
        +
        +
        +
        +evaluate(item)[source]¶
        +

        Evaluate items which are instances of L{Reference} or L{Expression}.

        +

        L{Reference} instances are evaluated using L{Reference.resolve}, +and L{Expression} instances are evaluated using +L{Expression.evaluate}.

        +

        @param item: The item to be evaluated. +@type item: any +@return: If the item is an instance of L{Reference} or L{Expression}, +the evaluated value is returned, otherwise the item is returned +unchanged.

        +
        + +
        +
        +setPath(path)[source]¶
        +

        Set the path for this instance. +@param path: The path - a string which describes how to get +to this instance from the root of the hierarchy. +@type path: str

        +
        + +
        +
        +writeToStream(stream, indent, container)[source]¶
        +

        Write this instance to a stream at the specified indentation level.

        +

        Should be redefined in subclasses.

        +

        @param stream: The stream to write to +@type stream: A writable stream (file-like object) +@param indent: The indentation level +@type indent: int +@param container: The container of this instance +@type container: L{Container} +@raise NotImplementedError: If a subclass does not override this

        +
        + +
        +
        +writeValue(value, stream, indent)[source]¶
        +
        + +
        + +
        +
        +class src.pyconf.Expression(op, lhs, rhs)[source]¶
        +

        Bases: object

        +

        This internal class implements a value which is obtained by evaluating an expression.

        +
        +
        +evaluate(container)[source]¶
        +

        Evaluate this instance in the context of a container.

        +

        @param container: The container to evaluate in from. +@type container: L{Container} +@return: The evaluated value. +@rtype: any +@raise ConfigResolutionError: If evaluation fails. +@raise ZeroDivideError: If division by zero occurs. +@raise TypeError: If the operation is invalid, e.g. +subtracting one string from another.

        +
        + +
        + +
        +
        +class src.pyconf.Mapping(parent=None)[source]¶
        +

        Bases: src.pyconf.Container

        +

        This internal class implements key-value mappings in configurations.

        +
        +
        +addMapping(key, value, comment, setting=False)[source]¶
        +

        Add a key-value mapping with a comment.

        +

        @param key: The key for the mapping. +@type key: str +@param value: The value for the mapping. +@type value: any +@param comment: The comment for the key (can be None). +@type comment: str +@param setting: If True, ignore clashes. This is set +to true when called from L{__setattr__}. +@raise ConfigFormatError: If an existing key is seen +again and setting is False.

        +
        + +
        +
        +get(key, default=None)[source]¶
        +

        Allows a dictionary-style get operation.

        +
        + +
        +
        +iteritems()[source]¶
        +
        + +
        +
        +iterkeys()[source]¶
        +
        + +
        +
        +keys()[source]¶
        +

        Return the keys in a similar way to a dictionary.

        +
        + +
        +
        +writeToStream(stream, indent, container)[source]¶
        +

        Write this instance to a stream at the specified indentation level.

        +

        Should be redefined in subclasses.

        +

        @param stream: The stream to write to +@type stream: A writable stream (file-like object) +@param indent: The indentation level +@type indent: int +@param container: The container of this instance +@type container: L{Container}

        +
        + +
        + +
        +
        +class src.pyconf.Reference(config, type, ident)[source]¶
        +

        Bases: object

        +

        This internal class implements a value which is a reference to another value.

        +
        +
        +addElement(type, ident)[source]¶
        +

        Add an element to the reference.

        +

        @param type: The type of reference. +@type type: BACKTICK or DOLLAR +@param ident: The identifier which continues the reference. +@type ident: str

        +
        + +
        +
        +findConfig(container)[source]¶
        +

        Find the closest enclosing configuration to the specified container.

        +

        @param container: The container to start from. +@type container: L{Container} +@return: The closest enclosing configuration, or None. +@rtype: L{Config}

        +
        + +
        +
        +resolve(container)[source]¶
        +

        Resolve this instance in the context of a container.

        +

        @param container: The container to resolve from. +@type container: L{Container} +@return: The resolved value. +@rtype: any +@raise ConfigResolutionError: If resolution fails.

        +
        + +
        + +
        +
        +class src.pyconf.Sequence(parent=None)[source]¶
        +

        Bases: src.pyconf.Container

        +

        This internal class implements a value which is a sequence of other values.

        +
        +
        +class SeqIter(seq)[source]¶
        +

        Bases: object

        +

        This internal class implements an iterator for a L{Sequence} instance.

        +
        +
        +next()[source]¶
        +
        + +
        + +
        +
        +Sequence.append(item, comment)[source]¶
        +

        Add an item to the sequence.

        +

        @param item: The item to add. +@type item: any +@param comment: A comment for the item. +@type comment: str

        +
        + +
        +
        +Sequence.writeToStream(stream, indent, container)[source]¶
        +

        Write this instance to a stream at the specified indentation level.

        +

        Should be redefined in subclasses.

        +

        @param stream: The stream to write to +@type stream: A writable stream (file-like object) +@param indent: The indentation level +@type indent: int +@param container: The container of this instance +@type container: L{Container}

        +
        + +
        + +
        +
        +src.pyconf.deepCopyMapping(inMapping)[source]¶
        +
        + +
        +
        +src.pyconf.defaultMergeResolve(map1, map2, key)[source]¶
        +

        A default resolver for merge conflicts. +Returns a string indicating what action to take to resolve the conflict.

        +

        @param map1: The map being merged into. +@type map1: L{Mapping}. +@param map2: The map being used as the merge operand. +@type map2: L{Mapping}. +@param key: The key in map2 (which also exists in map1). +@type key: str

        +
        +
        @return: One of "merge", "append", "mismatch" or "overwrite"
        +
        indicating what action should be taken. This should +be appropriate to the objects being merged - e.g. +there is no point returning "merge" if the two objects +are instances of L{Sequence}.
        +
        +

        @rtype: str

        +
        + +
        +
        +src.pyconf.defaultStreamOpener(name)[source]¶
        +

        This function returns a read-only stream, given its name. The name passed +in should correspond to an existing stream, otherwise an exception will be +raised.

        +

        This is the default value of L{streamOpener}; assign your own callable to +streamOpener to return streams based on names. For example, you could use +urllib2.urlopen().

        +

        @param name: The name of a stream, most commonly a file name. +@type name: str +@return: A stream with the specified name. +@rtype: A read-only stream (file-like object)

        +
        + +
        +
        +src.pyconf.isWord(s)[source]¶
        +

        See if a passed-in value is an identifier. If the value passed in is not a +string, False is returned. An identifier consists of alphanumerics or +underscore characters.

        +

        Examples:

        +
        isWord('a word') ->False
+isWord('award') -> True
+isWord(9) -> False
+isWord('a_b_c_') ->True
        +
        +

        @note: isWord('9abc') will return True - not exactly correct, but adequate +for the way it's used here.

        +

        @param s: The name to be tested +@type s: any +@return: True if a word, else False +@rtype: bool

        +
        + +
        +
        +src.pyconf.makePath(prefix, suffix)[source]¶
        +

        Make a path from a prefix and suffix.

        +

        Examples: +makePath('', 'suffix') -> 'suffix' +makePath('prefix', 'suffix') -> 'prefix.suffix' +makePath('prefix', '[1]') -> 'prefix[1]'

        +

        @param prefix: The prefix to use. If it evaluates as false, the suffix is returned. +@type prefix: str +@param suffix: The suffix to use. It is either an identifier or an index in brackets. +@type suffix: str +@return: The path concatenation of prefix and suffix, with adot if the suffix is not a bracketed index. +@rtype: str

        +
        + +
        +
        +src.pyconf.overwriteMergeResolve(map1, map2, key)[source]¶
        +

        An overwriting resolver for merge conflicts. Calls L{defaultMergeResolve}, +but where a "mismatch" is detected, returns "overwrite" instead.

        +

        @param map1: The map being merged into. +@type map1: L{Mapping}. +@param map2: The map being used as the merge operand. +@type map2: L{Mapping}. +@param key: The key in map2 (which also exists in map1). +@type key: str

        +
        + +
        +
        +

        system Module¶

        +

        In this file : all functions that do a system call, +like open a browser or an editor, or call a git command

        +
        +
        +src.system.archive_extract(from_what, where, logger)[source]¶
        +

        Extracts sources from an archive.

        + +++ + + + + + + + +
        Parameters:
          +
        • str (where) -- The path to the archive.
          • +
        • str -- The path where to extract.
          • +
        • Logger (logger) -- The logger instance to use.
          • +
        +
        Returns:

        True if the extraction is successful

        +
        Return type:

        boolean

        +
        +
        + +
        +
        +src.system.cvs_extract(protocol, user, server, base, tag, product, where, logger, checkout=False, environment=None)[source]¶
        +

        Extracts sources from a cvs repository.

        + +++ + + + + + + + +
        Parameters:
          +
        • str (where) -- The cvs protocol.
          • +
        • str -- The user to be used.
          • +
        • str -- The remote cvs server.
          • +
        • str --

          .

          +
          • +
        • str -- The tag.
          • +
        • str -- The product.
          • +
        • str -- The path where to extract.
          • +
        • Logger (logger) -- The logger instance to use.
          • +
        • boolean (checkout) -- If true use checkout cvs.
          • +
        • src.environment.Environ (environment) -- The environment to source when +extracting.
          • +
        +
        Returns:

        True if the extraction is successful

        +
        Return type:

        boolean

        +
        +
        + +
        +
        +src.system.git_extract(from_what, tag, where, logger, environment=None)[source]¶
        +

        Extracts sources from a git repository.

        + +++ + + + + + + + +
        Parameters:
          +
        • str (where) -- The remote git repository.
          • +
        • str -- The tag.
          • +
        • str -- The path where to extract.
          • +
        • Logger (logger) -- The logger instance to use.
          • +
        • src.environment.Environ (environment) -- The environment to source when +extracting.
          • +
        +
        Returns:

        True if the extraction is successful

        +
        Return type:

        boolean

        +
        +
        + +
        +
        +src.system.show_in_editor(editor, filePath, logger)[source]¶
        +

        open filePath using editor.

        + +++ + + + +
        Parameters:
          +
        • str (filePath) -- The editor to use.
          • +
        • str -- The path to the file to open.
          • +
        +
        +
        + +
        +
        +src.system.svn_extract(user, from_what, tag, where, logger, checkout=False, environment=None)[source]¶
        +

        Extracts sources from a svn repository.

        + +++ + + + + + + + +
        Parameters:
          +
        • str (where) -- The user to be used.
          • +
        • str -- The remote git repository.
          • +
        • str -- The tag.
          • +
        • str -- The path where to extract.
          • +
        • Logger (logger) -- The logger instance to use.
          • +
        • boolean (checkout) -- If true use checkout svn.
          • +
        • src.environment.Environ (environment) -- The environment to source when +extracting.
          • +
        +
        Returns:

        True if the extraction is successful

        +
        Return type:

        boolean

        +
        +
        + +
        +
        +

        template Module¶

        +
        +
        +class src.template.MyTemplate(template)[source]¶
        +

        Bases: string.Template

        +
        +
        +delimiter = '\xc2\xa4'¶
        +
        + +
        +
        +pattern = <_sre.SRE_Pattern object at 0x24c9d70>¶
        +
        + +
        + +
        +
        +src.template.substitute(template_file, subst_dic)[source]¶
        +
        + +
        +
        +

        test_module Module¶

        +
        +
        +class src.test_module.Test(config, logger, tmp_working_dir, testbase='', grids=None, sessions=None, launcher='', show_desktop=True)[source]¶
        +
        +
        +generate_launching_commands()[source]¶
        +
        + +
        +
        +generate_script(listTest, script_path, ignoreList)[source]¶
        +
        + +
        +
        +get_test_timeout(test_name, default_value)[source]¶
        +
        + +
        +
        +get_tmp_dir()[source]¶
        +
        + +
        +
        +prepare_testbase(test_base_name)[source]¶
        +
        + +
        +
        +prepare_testbase_from_dir(testbase_name, testbase_dir)[source]¶
        +
        + +
        +
        +prepare_testbase_from_git(testbase_name, testbase_base, testbase_tag)[source]¶
        +
        + +
        +
        +prepare_testbase_from_svn(user, testbase_name, testbase_base)[source]¶
        +
        + +
        +
        +read_results(listTest, has_timed_out)[source]¶
        +
        + +
        +
        +run_all_tests()[source]¶
        +
        + +
        +
        +run_grid_tests()[source]¶
        +
        + +
        +
        +run_script(script_name)[source]¶
        +
        + +
        +
        +run_session_tests()[source]¶
        +
        + +
        +
        +run_testbase_tests()[source]¶
        +
        + +
        +
        +run_tests(listTest, ignoreList)[source]¶
        +
        + +
        +
        +search_known_errors(status, test_grid, test_session, test)[source]¶
        +
        + +
        +
        +write_test_margin(tab)[source]¶
        +
        + +
        + +
        +
        +src.test_module.getTmpDirDEFAULT()[source]¶
        +
        + +
        +
        +

        xmlManager Module¶

        +
        +
        +class src.xmlManager.ReadXmlFile(filePath)[source]¶
        +

        Bases: object

        +

        Class to manage reading of an xml log file

        +
        +
        +getRootAttrib()[source]¶
        +

        Get the attibutes of the self.xmlroot

        + +++ + + + + + +
        Returns:The attributes of the root node
        Return type:dict
        +
        + +
        +
        +get_attrib(node_name)[source]¶
        +

        Get the attibutes of the node node_name in self.xmlroot

        + +++ + + + + + + + +
        Parameters:str (node_name) -- the name of the node
        Returns:the attibutes of the node node_name in self.xmlroot
        Return type:dict
        +
        + +
        +
        +get_node_text(node)[source]¶
        +

        Get the text of the first node that has name +that corresponds to the parameter node

        + +++ + + + + + + + +
        Parameters:str (node) -- the name of the node from which get the text
        Returns:the text of the first node that has name +that corresponds to the parameter node
        Return type:str
        +
        + +
        + +
        +
        +class src.xmlManager.XmlLogFile(filePath, rootname, attrib={})[source]¶
        +

        Bases: object

        +

        Class to manage writing in salomeTools xml log file

        +
        +
        +add_simple_node(node_name, text=None, attrib={})[source]¶
        +

        Add a node with some attibutes and text to the root node.

        + +++ + + + +
        Parameters:
          +
        • str (text) -- the name of the node to add
          • +
        • str -- the text of the node
          • +
        • dict (attrib) -- the dictionary containing the +attribute of the new node
          • +
        +
        +
        + +
        +
        +append_node_attrib(node_name, attrib)[source]¶
        +

        Append a new attributes to the node that has node_name as name

        + +++ + + + +
        Parameters:
          +
        • str (node_name) -- The name of the node on which append text
          • +
        • dixt (attrib) -- The attrib to append
          • +
        +
        +
        + +
        +
        +append_node_text(node_name, text)[source]¶
        +

        Append a new text to the node that has node_name as name

        + +++ + + + +
        Parameters:
          +
        • str (text) -- The name of the node on which append text
          • +
        • str -- The text to append
          • +
        +
        +
        + +
        +
        +write_tree(stylesheet=None, file_path=None)[source]¶
        +

        Write the xml tree in the log file path. Add the stylesheet if asked.

        + +++ + + + +
        Parameters:str (stylesheet) -- The stylesheet to apply to the xml file
        +
        + +
        + +
        +
        +src.xmlManager.add_simple_node(root_node, node_name, text=None, attrib={})[source]¶
        +

        Add a node with some attibutes and text to the root node.

        + +++ + + + +
        Parameters:
          +
        • etree.Element (root_node) -- the Etree element where to add the new node
          • +
        • str (text) -- the name of the node to add
          • +
        • str -- the text of the node
          • +
        • dict (attrib) -- the dictionary containing the +attribute of the new node
          • +
        +
        +
        + +
        +
        +src.xmlManager.append_node_attrib(root_node, attrib)[source]¶
        +

        Append a new attributes to the node that has node_name as name

        + +++ + + + +
        Parameters:
          +
        • etree.Element (root_node) -- the Etree element +where to append the new attibutes
          • +
        • dixt (attrib) -- The attrib to append
          • +
        +
        +
        + +
        +
        +src.xmlManager.find_node_by_attrib(xmlroot, name_node, key, value)[source]¶
        +

        Find the nfirst ode from xmlroot that has name name_node and that has in +its attributes {key : value}. Return the node

        + +++ + + + + + + + +
        Parameters:
          +
        • etree.Element (xmlroot) -- the Etree element where to search
          • +
        • str (value) -- the name of node to search
          • +
        • str -- the key to search
          • +
        • str -- the value to search
          • +
        +
        Returns:

        the found node

        +
        Return type:

        xmlroot etree.Element

        +
        +
        + +
        +
        +src.xmlManager.write_report(filename, xmlroot, stylesheet)[source]¶
        +

        Writes a report file from a XML tree.

        + +++ + + + +
        Parameters:
          +
        • str (stylesheet) -- The path to the file to create
          • +
        • etree.Element (xmlroot) -- the Etree element to write to the file
          • +
        • str -- The stylesheet to add to the begin of the file
          • +
        +
        +
        + +
        + +
        + + +
        +
        +
        +
        +
        + +

        Table Of Contents

        + +
        +

        Related Topics

        + +
        +

        This Page

        + + + +
        +
        +
        +
        +
        + ©2018, CEA. + + | + Powered by Sphinx 1.1.3 + & Alabaster + + | + Page source +
        + + + + + + \ No newline at end of file diff --git a/doc/build/html/commands/application.html b/doc/build/html/commands/application.html new file mode 100644 index 0000000..5342946 --- /dev/null +++ b/doc/build/html/commands/application.html @@ -0,0 +1,165 @@ + + + + + + + + + Command application — salomeTools 5.0.0dev documentation + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +
        +
        + +
        +

        Command application¶

        +
        +

        Description¶

        +

        The application command creates a virtual SALOME application. +Virtual SALOME applications are used to start SALOME when distribution is needed.

        +
        +
        +

        Usage¶

        +
          +

        • Create an application:

          +
          sat application <application>
          +
          +

          Create the virtual application directory in the salomeTool application directory $APPLICATION.workdir.

          +
          • +

        • Give a name to the application:

          +
          sat application <application> --name <my_application_name>
          +
          +

          Remark: this option overrides the name given in the virtual_app section of the configuration file $APPLICATION.virtual_app.name.

          +
          • +

        • Change the directory where the application is created:

          +
          sat application <application> --target <my_application_directory>
          +
          +
          • +

        • Set a specific SALOME resources catalog (it will be used for the distribution of components on distant machines):

          +
          sat application <application> --catalog <path_to_catalog>
          +
          +

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

          +
          • +

        • Generate the catalog for a list of machines:

          +
          sat application <application> --gencat machine1,machine2,machine3
          +
          +

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

          +
          • +

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

          +
          sat launcher <application> --use_mesa
          +
          +
          • +
        +
        +
        +

        Some useful configuration pathes¶

        +

        The virtual application can be configured with the virtual_app section of the configutation file.

        +
          +
        • APPLICATION.virtual_app
            +
          • name : name of the launcher (to replace the default runAppli).
            • +
          • application_name : (optional) the name of the virtual application directory, if missing the default value is $name + _appli.
            • +
          +
          • +
        +
        +
        + + +
        +
        +
        +
        +
        + +

        Table Of Contents

        + +
        +

        Related Topics

        + +
        +

        This Page

        + + + +
        +
        +
        +
        +
        + ©2018, CEA. + + | + Powered by Sphinx 1.1.3 + & Alabaster + + | + Page source +
        + + + + + + \ No newline at end of file diff --git a/doc/build/html/commands/clean.html b/doc/build/html/commands/clean.html new file mode 100644 index 0000000..2ae7f7b --- /dev/null +++ b/doc/build/html/commands/clean.html @@ -0,0 +1,172 @@ + + + + + + + + + Command clean — salomeTools 5.0.0dev documentation + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +
        +
        + +
        +

        Command clean¶

        +
        +

        Description¶

        +

        The clean command removes products in the source, build, or install directories of an application. Theses directories are usually named SOURCES, BUILD, INSTALL.

        +

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

        +
        +
        +

        Usage¶

        +
          +

        • Clean all previously created build and install directories (example application as SALOME_xx):

          +
          # take care, is long time to restore, sometimes
+sat clean SALOME-xx --build --install
+
          +
          +
          • +

        • Clean previously created build and install directories, only for products with property is_salome_module:

          +
          sat clean SALOME-xxx --build --install \
+                     --properties is_salome_module:yes
+
          +
          +
          • +
        +
        +
        +

        Availables options¶

        +
        +
          +

        • --products : Products to clean.

          +
          • +

        • --properties :

          +
          +
          Filter the products by their properties.
          +
          Syntax: --properties <property>:<value>
          +
          +
          • +

        • --sources : Clean the product source directories.

          +
          • +

        • --build : Clean the product build directories.

          +
          • +

        • --install : Clean the product install directories.

          +
          • +

        • --all : Clean the product source, build and install directories.

          +
          • +

        • --sources_without_dev :

          +
          +
          Do not clean the products in development mode,
          +
          (they could have VCS commits pending).
          +
          +
          • +
        +
        +
        +
        +

        Some useful configuration pathes¶

        +

        No specific configuration.

        +
        +
        + + +
        +
        +
        +
        +
        + +

        Table Of Contents

        + +
        +

        Related Topics

        + +
        +

        This Page

        + + + +
        +
        +
        +
        +
        + ©2018, CEA. + + | + Powered by Sphinx 1.1.3 + & Alabaster + + | + Page source +
        + + + + + + \ No newline at end of file diff --git a/doc/build/html/commands/compile.html b/doc/build/html/commands/compile.html new file mode 100644 index 0000000..c88398b --- /dev/null +++ b/doc/build/html/commands/compile.html @@ -0,0 +1,193 @@ + + + + + + + + + Command compile — salomeTools 5.0.0dev documentation + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +
        +
        + +
        +

        Command compile¶

        +
        +

        Description¶

        +

        The compile command allows compiling the products of a SALOME application.

        +
        +
        +

        Usage¶

        +
          +

        • Compile a complete application:

          +
          sat compile <application>
          +
          +
          • +

        • Compile only some products:

          +
          sat compile <application> --products <product1>,<product2> ...
          +
          +
          • +

        • Use sat -t to duplicate the logs in the terminal (by default the log are stored and displayed with sat log command):

          +
          sat -t compile <application> --products <product1>
          +
          +
          • +

        • Compile a module and its dependencies:

          +
          sat compile <application> --products med --with_fathers
          +
          +
          • +

        • Compile a module and the modules depending on it (for example plugins):

          +
          sat compile <application> --products med --with_children
          +
          +
          • +

        • Clean the build and install directories before starting compilation:

          +
          sat compile <application> --products GEOM  --clean_all
          +
          +
          +

          Note

          +
          +
          a warning will be shown if option --products is missing
          +
          (as it will clean everything)
          +
          +
          +
          • +

        • Clean only the install directories before starting compilation:

          +
          sat compile <application> --clean_install
          +
          +
          • +

        • Add options for make:

          +
          sat compile <application> --products <product> --make_flags <flags>
          +
          +
          • +

        • Use the --check option to execute the unit tests after compilation:

          +
          sat compile <application> --check
          +
          +
          • +

        • Remove the build directory after successful compilation (some build directory like qt are big):

          +
          sat compile <application> --products qt --clean_build_after
          +
          +
          • +

        • Stop the compilation as soon as the compilation of a module fails:

          +
          sat compile <product> --stop_first_fail
          +
          +
          • +

        • Do not compile, just show if products are installed or not, and where is the installation:

          +
          sat compile <application> --show
          +
          +
          • +
        +
        +
        +

        Some useful configuration pathes¶

        +

        The way to compile a product is defined in the pyconf file configuration. +The main options are:

        +
        +
          +
        • build_source : the method used to build the product (cmake/autotools/script)
          • +
        • compil_script : the compilation script if build_source is equal to "script"
          • +
        • cmake_options : additional options for cmake.
          • +
        • nb_proc : number of jobs to use with make for this product.
          • +
        +
        +
        +
        + + +
        +
        +
        +
        +
        + +

        Table Of Contents

        + +
        +

        Related Topics

        + +
        +

        This Page

        + + + +
        +
        +
        +
        +
        + ©2018, CEA. + + | + Powered by Sphinx 1.1.3 + & Alabaster + + | + Page source +
        + + + + + + \ No newline at end of file diff --git a/doc/build/html/commands/config.html b/doc/build/html/commands/config.html new file mode 100644 index 0000000..42848d4 --- /dev/null +++ b/doc/build/html/commands/config.html @@ -0,0 +1,198 @@ + + + + + + + + + Command config — salomeTools 5.0.0dev documentation + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +
        +
        + +
        +

        Command config¶

        +
        +

        Description¶

        +

        The config command manages sat configuration. +It allows display, manipulation and operation on configuration files

        +
        +
        +

        Usage¶

        +
          +

        • Edit the user personal configuration file $HOME/.salomeTools/SAT.pyconf. It is used to store the user personal choices, like the favorite editor, browser, pdf viewer:

          +
          sat config --edit
          +
          +
          • +

        • List the available applications (they come from the sat projects defined in data/local.pyconf:

          +
          sat config --list
          +
          +
          • +

        • Edit the configuration of an application:

          +
          sat config <application> --edit
          +
          +
          • +

        • Copy an application configuration file into the user personal directory:

          +
          sat config <application> --copy [new_name]
          +
          +
          • +
        • +
          Print the value of a configuration parameter.
          +
          Use the automatic completion to get recursively the parameter names.
          +
          Use --no_label option to get only the value, without label (useful in automatic scripts).
          +
          Examples (with SALOME-xx as SALOME-8.4.0 ):
          +
          +
          # sat config --value <parameter_path>
+sat config --value .         # all the configuration
+sat config --value LOCAL
+sat config --value LOCAL.workdir
+
+# sat config <application> --value <parameter_path>
+sat config SALOME-xx --value APPLICATION.workdir
+sat config SALOME-xx --no_label --value APPLICATION.workdir
+
          +
          +
          • +
        • +
          Print in one-line-by-value mode the value of a configuration parameter,
          +
          with its source expression, if any.
          +
          This is a debug mode, useful for developers.
          +
          Prints the parameter path, the source expression if any, and the final value:
          +
          +
          sat config SALOME-xx -g USER
          +
          +
          +

          Note

          +

          And so, not only for fun, to get all expressions of configuration

          +
          sat config SALOME-xx -g . | grep -e "-->"
+
          +
          +
          +
          • +

        • Print the patches that are applied:

          +
          sat config SALOME-xx --show_patchs
          +
          +
          • +

        • Get information on a product configuration:

          +
          # sat config <application> --info <product>
+sat config SALOME-xx --info KERNEL
+sat config SALOME-xx --info qt
+
          +
          +
          • +
        +
        +
        +

        Some useful configuration pathes¶

        +

        Exploring a current configuration.

        +
          +
        • PATHS: To get list of directories where to find files.
          • +
        • USER: To get user preferences (editor, pdf viewer, web browser, default working dir).
          • +
        +

        sat commands:

        +
        sat config SALOME-xx -v PATHS
+sat config SALOME-xx -v USERS
        +
        +
        +
        + + +
        +
        +
        +
        +
        + +

        Table Of Contents

        + +
        +

        Related Topics

        + +
        +

        This Page

        + + + +
        +
        +
        +
        +
        + ©2018, CEA. + + | + Powered by Sphinx 1.1.3 + & Alabaster + + | + Page source +
        + + + + + + \ No newline at end of file diff --git a/doc/build/html/commands/environ.html b/doc/build/html/commands/environ.html new file mode 100644 index 0000000..0c6d971 --- /dev/null +++ b/doc/build/html/commands/environ.html @@ -0,0 +1,236 @@ + + + + + + + + + Command environ — salomeTools 5.0.0dev documentation + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +
        +
        + +
        +

        Command environ¶

        +
        +

        Description¶

        +

        The environ command generates the environment files used +to run and compile your application (as SALOME is an example).

        +
        +

        Note

        +

        these files are not required, +salomeTool set the environment himself, when compiling. +And so does the salome launcher.

        +

        These files are useful when someone wants to check the environment. +They could be used in debug mode to set the environment for gdb.

        +
        +

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

        +
        +
        +

        Usage¶

        +
          +

        • Create the shell environment files of the application:

          +
          sat environ <application>
          +
          +
          • +

        • Create the environment files of the application for a given shell. +Options are bash, bat (for windows) and cfg (the configuration format used by SALOME):

          +
          sat environ <application> --shell [bash|cfg|all]
          +
          +
          • +

        • Use a different prefix for the files (default is 'env'):

          +
          # This will create file <prefix>_launch.sh, <prefix>_build.sh
+sat environ <application> --prefix <prefix>
+
          +
          +
          • +

        • Use a different target directory for the files:

          +
          # This will create file env_launch.sh, env_build.sh
+# in the directory corresponding to <path>
+sat environ <application> --target <path>
+
          +
          +
          • +

        • Generate the environment files only with the given products:

          +
          # This will create the environment files only for the given products
+# and their prerequisites.
+# It is useful when you want to visualise which environment uses
+# sat to compile a given product.
+sat environ <application> --product <product1>,<product2>, ...
+
          +
          +
          • +
        +
        +
        +

        Configuration¶

        +

        The specification of the environment can be done through several mechanisms.

        +
          +
        1. For salome products (the products with the property is_SALOME_module as yes) the environment is set automatically by sat, in respect with SALOME requirements.
          2. +
        2. For other products, the environment is set with the use of the environ section within the pyconf file of the product. The user has two possibilities, either set directly the environment within the section, or specify a python script which wil be used to set the environment programmatically.
          3. +
        +

        Within the section, the user can define environment variables. He can also modify PATH variables, by appending or prepending directories. +In the following example, we prepend <install_dir>/lib to LD_LIBRARY_PATH (note the left first underscore), append <install_dir>/lib to PYTHONPATH (note the right last underscore), and set LAPACK_ROOT_DIR to <install_dir>:

        +
        environ :
+{
+  _LD_LIBRARY_PATH : $install_dir + $VARS.sep + "lib"
+  PYTHONPATH_ : $install_dir + $VARS.sep + "lib"
+  LAPACK_ROOT_DIR : $install_dir
+}
        +
        +

        It is possible to distinguish the build environment from the launch environment: use a subsection called build or launch. In the example below, LD_LIBRARY_PATH and PYTHONPATH are only modified at run time, not at compile time:

        +
        environ :
+{
+  build :
+  {
+    LAPACK_ROOT_DIR : $install_dir
+  }
+  launch :
+  {
+    LAPACK_ROOT_DIR : $install_dir
+    _LD_LIBRARY_PATH : $install_dir + $VARS.sep + "lib"
+    PYTHONPATH_ : $install_dir + $VARS.sep + "lib"
+  }
+}
        +
        +
          +
        1. The last possibility is to set the environment with a python script. The script should be provided in the products/env_scripts directory of the sat project, and its name is specified in the environment section with the key environ.env_script:
          2. +
        +
        environ :
+{
+  env_script : 'lapack.py'
+}
+
        +
        +

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

        +

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

        +
        #!/usr/bin/env python
+#-*- coding:utf-8 -*-
+
+import os.path
+import platform
+
+def set_env(env, prereq_dir, version):
+    env.set("TRUST_ROOT_DIR",prereq_dir)
+    env.prepend('PATH', os.path.join(prereq_dir, 'bin'))
+    env.prepend('PATH', os.path.join(prereq_dir, 'include'))
+    env.prepend('LD_LIBRARY_PATH', os.path.join(prereq_dir, 'lib'))
+    return
+
        +
        +

        SalomeTools defines four handles:

        +
          +
        • set_env(env, prereq_dir, version) : used at build and run time.
          • +
        • set_env_launch(env, prereq_dir, version) : used only at run time (if defined!)
          • +
        • set_env_build(env, prereq_dir, version) : used only at build time (if defined!)
          • +
        • set_native_env(env) : used only for native products, at build and run time.
          • +
        +
        +
        + + +
        +
        +
        +
        +
        + +

        Table Of Contents

        + +
        +

        Related Topics

        + +
        +

        This Page

        + + + +
        +
        +
        +
        +
        + ©2018, CEA. + + | + Powered by Sphinx 1.1.3 + & Alabaster + + | + Page source +
        + + + + + + \ No newline at end of file diff --git a/doc/build/html/commands/generate.html b/doc/build/html/commands/generate.html new file mode 100644 index 0000000..542829a --- /dev/null +++ b/doc/build/html/commands/generate.html @@ -0,0 +1,154 @@ + + + + + + + + + Command generate — salomeTools 5.0.0dev documentation + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +
        +
        + +
        +

        Command generate¶

        +
        +

        Description¶

        +

        The generate command generates and compile SALOME modules from cpp modules using YACSGEN.

        +
        +

        Note

        +

        This command uses YACSGEN to generate the module. It needs to be specified with --yacsgen option, or defined in the product or by the environment variable $YACSGEN_ROOT_DIR.

        +
        +
        +
        +

        Remarks¶

        +
          +

        • This command will only apply on the CPP modules of the application, those who have both properties:

          +
          cpp : "yes"
+generate : "yes"
          +
          +
          • +

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

          +
          • +
        +
        +
        +

        Usage¶

        +
          +

        • Generate all the modules of a product:

          +
          sat generate <application>
          +
          +
          • +

        • Generate only specific modules:

          +
          sat generate <application> --products <list_of_products>
          +
          +

          Remark: modules which don't have the generate property are ignored.

          +
          • +

        • Use a specific version of YACSGEN:

          +
          sat generate <application> --yacsgen <path_to_yacsgen>
          +
          +
          • +
        +
        +
        + + +
        +
        +
        +
        +
        + +

        Table Of Contents

        + +
        +

        Related Topics

        + +
        +

        This Page

        + + + +
        +
        +
        +
        +
        + ©2018, CEA. + + | + Powered by Sphinx 1.1.3 + & Alabaster + + | + Page source +
        + + + + + + \ No newline at end of file diff --git a/doc/build/html/commands/launcher.html b/doc/build/html/commands/launcher.html new file mode 100644 index 0000000..97e7112 --- /dev/null +++ b/doc/build/html/commands/launcher.html @@ -0,0 +1,160 @@ + + + + + + + + + Command launcher — salomeTools 5.0.0dev documentation + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +
        +
        + +
        +

        Command launcher¶

        +
        +

        Description¶

        +

        The launcher command creates a SALOME launcher, a python script file to start SALOME.

        +
        +
        +

        Usage¶

        +
          +

        • Create a launcher:

          +
          sat launcher <application>
          +
          +

          Generate a launcher in the application directory, i.e $APPLICATION.workdir.

          +
          • +

        • Create a launcher with a given name (default name is APPLICATION.profile.launcher_name)

          +
          sat launcher <application> --name ZeLauncher
          +
          +

          The launcher will be called ZeLauncher.

          +
          • +

        • Set a specific resources catalog:

          +
          sat launcher <application>  --catalog  <path of a salome resources catalog>
          +
          +

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

          +
          • +

        • Generate the catalog for a list of machines:

          +
          sat launcher <application> --gencat <list of machines>
          +
          +

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

          +
          • +

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

          +
          sat launcher <application> --use_mesa
          +
          +
          • +
        +
        +
        +

        Configuration¶

        +

        Some useful configuration pathes:

        +
          +
        • APPLICATION.profile
            +
          • product : the name of the profile product (the product in charge of holding the application stuff, like logos, splashscreen)
            • +
          • launcher_name : the name of the launcher.
            • +
          +
          • +
        +
        +
        + + +
        +
        +
        +
        +
        + +

        Table Of Contents

        + +
        +

        Related Topics

        + +
        +

        This Page

        + + + +
        +
        +
        +
        +
        + ©2018, CEA. + + | + Powered by Sphinx 1.1.3 + & Alabaster + + | + Page source +
        + + + + + + \ No newline at end of file diff --git a/doc/build/html/commands/log.html b/doc/build/html/commands/log.html new file mode 100644 index 0000000..72886cd --- /dev/null +++ b/doc/build/html/commands/log.html @@ -0,0 +1,159 @@ + + + + + + + + + Command log — salomeTools 5.0.0dev documentation + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +
        +
        + +
        +

        Command log¶

        +
        +

        Description¶

        +

        The log command displays sat log in a web browser or in a terminal.

        +
        +
        +

        Usage¶

        +
          +

        • Show (in a web browser) the log of the commands corresponding to an application:

          +
          sat log <application>
          +
          +
          • +

        • Show the log for commands that do not use any application:

          +
          sat log
          +
          +
          • +

        • The --terminal (or -t) display the log directly in the terminal, through a CLI interactive menu:

          +
          sat log <application> --terminal
          +
          +
          • +

        • The --last option displays only the last command:

          +
          sat log <application> --last
          +
          +
          • +

        • To access the last compilation log in terminal mode, use --last_terminal option:

          +
          sat log <application> --last_terminal
          +
          +
          • +

        • The --clean (int) option erases the n older log files and print the number of remaining log files:

          +
          sat log <application> --clean 50
          +
          +
          • +
        +
        +
        +

        Some useful configuration pathes¶

        +
          +
        • USER
            +
          • browser : The browser used to show the log (by default firefox).
            • +
          • log_dir : The directory used to store the log files.
            • +
          +
          • +
        +
        +
        + + +
        +
        +
        +
        +
        + +

        Table Of Contents

        + +
        +

        Related Topics

        + +
        +

        This Page

        + + + +
        +
        +
        +
        +
        + ©2018, CEA. + + | + Powered by Sphinx 1.1.3 + & Alabaster + + | + Page source +
        + + + + + + \ No newline at end of file diff --git a/doc/build/html/commands/package.html b/doc/build/html/commands/package.html new file mode 100644 index 0000000..ec998da --- /dev/null +++ b/doc/build/html/commands/package.html @@ -0,0 +1,184 @@ + + + + + + + + + Command package — salomeTools 5.0.0dev documentation + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +
        +
        + +
        +

        Command package¶

        +
        +

        Description¶

        +

        The package command creates a SALOME archive (usually a compressed Tar file .tgz). +This tar file is used later to intall SALOME on other remote computer.

        +

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

        +

        Usually utility salomeTools is included in the archive.

        +
        +

        Note

        +

        By default the package includes the sources of prerequisites and products. +To select a subset use the --without_property or --with_vcs options.

        +
        +
        +
        +

        Usage¶

        +
          +

        • Create a package for a product (example as SALOME_xx):

          +
          sat package SALOME_xx
          +
          +

          This command will create an archive named SALOME_xx.tgz +in the working directory (USER.workDir). +If the archive already exists, do nothing.

          +
          • +

        • Create a package with a specific name:

          +
          sat package SALOME_xx --name YourSpecificName
          +
          +
          • +
        +
        +

        Note

        +

        By default, the archive is created in the working directory of the user (USER.workDir).

        +

        If the option --name is used with a path (relative or absolute) it will be used.

        +

        If the option --name is not used and binaries (prerequisites and products) +are included in the package, the OS architecture +will be appended to the name (example: SALOME_xx-CO7.tgz).

        +

        Examples:

        +
        # Creates SALOME_xx.tgz in $USER.workDir
+sat package SALOME_xx
+
+# Creates SALOME_xx_<arch>.tgz in $USER.workDir
+sat package SALOME_xx --binaries
+
+# Creates MySpecificName.tgz in $USER.workDir
+sat package SALOME_xx --name MySpecificName
        +
        +
        +
          +

        • Force the creation of the archive (if it already exists):

          +
          sat package SALOME_xx --force
          +
          +
          • +

        • Include the binaries in the archive (products and prerequisites):

          +
          sat package SALOME_xx --binaries
          +
          +

          This command will create an archive named SALOME_xx _<arch>.tgz +where <arch> is the OS architecture of the machine.

          +
          • +

        • Do not delete Version Control System (VCS) informations from the configurations files of the embedded salomeTools:

          +
          sat package SALOME_xx --with_vcs
          +
          +

          The version control systems known by this option are CVS, SVN and Git.

          +
          • +
        +
        +
        +

        Some useful configuration pathes¶

        +

        No specific configuration.

        +
        +
        + + +
        +
        +
        +
        +
        + +

        Table Of Contents

        + +
        +

        Related Topics

        + +
        +

        This Page

        + + + +
        +
        +
        +
        +
        + ©2018, CEA. + + | + Powered by Sphinx 1.1.3 + & Alabaster + + | + Page source +
        + + + + + + \ No newline at end of file diff --git a/doc/build/html/commands/prepare.html b/doc/build/html/commands/prepare.html new file mode 100644 index 0000000..e879ca6 --- /dev/null +++ b/doc/build/html/commands/prepare.html @@ -0,0 +1,211 @@ + + + + + + + + + Command prepare — salomeTools 5.0.0dev documentation + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +
        +
        + +
        +

        Command prepare¶

        +
        +

        Description¶

        +

        The prepare command brings the sources of an application in the sources +application directory, in order to compile them with the compile command.

        +

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

        +
        +

        Warning

        +

        When sat prepares a product, it first removes the +existing directory, except if the development mode is activated. +When you are working on a product, you need to declare in +the application configuration this product in dev mode.

        +
        +
        +
        +

        Remarks¶

        +
        +

        VCS bases (git, svn, cvs)¶

        +

        The prepare command does not manage authentication on the cvs server. +For example, to prepare modules from a cvs server, you first need to login once.

        +

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

        +
        +
        +

        Dev mode¶

        +

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

        +
        sat config <application> -e
+# and edit the product section:
+#   <product> : {tag : "my_tag", dev : "yes", debug : "yes"}
+
        +
        +

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

        +
        +
        +
        +

        Usage¶

        +
          +

        • Prepare the sources of a complete application in SOURCES directory (all products):

          +
          sat prepare <application>
          +
          +
          • +

        • Prepare only some modules:

          +
          sat prepare <application>  --products <product1>,<product2> ...
          +
          +
          • +

        • Use --force to force to prepare the products in development mode +(this will remove the sources and do a new clone/checkout):

          +
          sat prepare <application> --force
          +
          +
          • +

        • Use --force_patch to force to apply patch to the products +in development mode (otherwise they are not applied):

          +
          sat prepare <application> --force_patch
          +
          +
          • +
        +
        +
        +

        Some useful configuration pathes¶

        +

        Command sat prepare uses the pyconf file configuration of each product to know how to get the sources.

        +
        +

        Note

        +

        to verify configuration of a product, and get name of this pyconf files configuration

        +
        sat config <application> --info <product>
+
        +
        +
        +
          +
        • get_method: the method to use to prepare the module, possible values are cvs, git, archive, dir.
          • +
        • git_info : (used if get_method = git) information to prepare sources from git.
          • +
        • svn_info : (used if get_method = svn) information to prepare sources from cvs.
          • +
        • cvs_info : (used if get_method = cvs) information to prepare sources from cvs.
          • +
        • archive_info : (used if get_method = archive) the path to the archive.
          • +
        • dir_info : (used if get_method = dir) the directory with the sources.
          • +
        +
        +
        + + +
        +
        +
        +
        +
        + +

        Table Of Contents

        + +
        +

        Related Topics

        + +
        +

        This Page

        + + + +
        +
        +
        +
        +
        + ©2018, CEA. + + | + Powered by Sphinx 1.1.3 + & Alabaster + + | + Page source +
        + + + + + + \ No newline at end of file diff --git a/doc/build/html/configuration.html b/doc/build/html/configuration.html new file mode 100644 index 0000000..4ab2d24 --- /dev/null +++ b/doc/build/html/configuration.html @@ -0,0 +1,199 @@ + + + + + + + + + Configuration — salomeTools 5.0.0dev documentation + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +
        +
        + +
        +

        Configuration¶

        +

        salomeTools uses files to store its configuration parameters.

        +

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

        +
        +

        Syntax¶

        +

        The configuration files use a python-like structure format +(see config module for a complete description).

        +
          +
        • {} define a dictionary,
          • +
        • [] define a list,
          • +
        • @ can be used to include a file,
          • +
        • $prefix reference to another parameter (ex: $PRODUCT.name),
          • +
        • # comments.
          • +
        +
        +

        Note

        +

        in this documentation a reference to a configuration parameter will be noted XXX.YYY.

        +
        +
        +
        +

        Description¶

        +
        +

        VARS section¶

        +
        +
        This section is dynamically created by salomeTools at run time.
        +
        It contains information about the environment: date, time, OS, architecture etc.
        +
        +
        # to get the current setting
+sat config --value VARS
        +
        +
        +
        +

        PRODUCTS section¶

        +
        +
        This section is defined in the product file.
        +
        It contains instructions on how to build a version of SALOME (list of prerequisites-products and versions)
        +
        +
        # to get the current setting
+sat config SALOME-xx --value PRODUCTS
        +
        +
        +
        +

        APPLICATION section¶

        +
        +
        This section is optional, it is also defined in the product file.
        +
        It gives additional parameters to create an application based on SALOME, as versions of products to use.
        +
        +
        # to get the current setting
+sat config SALOME-xx --value APPLICATION
        +
        +
        +
        +

        USER section¶

        +

        This section is defined by the user configuration file, +~/.salomeTools/salomeTools.pyconf.

        +

        The USER section defines some parameters (not exhaustive):

        +
          +

        • workDir :

          +
          +
          +
          The working directory.
          +
          Each product will be usually installed here (in sub-directories).
          +
          +
          +
          • +

        • browser : The web browser to use (firefox).

          +
          • +

        • editor : The editor to use (vi, pluma).

          +
          • +

        • and other user preferences.

          +
          • +
        +
        # to get the current setting
+sat config SALOME-xx --value USER
        +
        +
        +
        +
        + + +
        +
        +
        +
        +
        + +

        Table Of Contents

        + +
        +

        Related Topics

        + +
        +

        This Page

        + + + +
        +
        +
        +
        +
        + ©2018, CEA. + + | + Powered by Sphinx 1.1.3 + & Alabaster + + | + Page source +
        + + + + + + \ No newline at end of file diff --git a/doc/build/html/genindex.html b/doc/build/html/genindex.html new file mode 100644 index 0000000..727ce5a --- /dev/null +++ b/doc/build/html/genindex.html @@ -0,0 +1,2447 @@ + + + + + + + + + + + Index — salomeTools 5.0.0dev documentation + + + + + + + + + + + + + + + + + + + + + +
        +
        +
        +
        + + +

        Index

        + +
        + A + | B + | C + | D + | E + | F + | G + | H + | I + | K + | L + | M + | N + | O + | P + | Q + | R + | S + | T + | U + | W + | X + | Y + +
        +

        A

        + + + +
        + +
        activate_mesa_property() (in module src.__init__) +
        + + +
        add() (src.fileEnviron.LauncherFileEnviron method) +
        + + +
        add_comment() (src.environment.SalomeEnviron method) +
        + +
        + +
        (src.fileEnviron.BatFileEnviron method) +
        + + +
        (src.fileEnviron.FileEnviron method) +
        + + +
        (src.fileEnviron.LauncherFileEnviron method) +
        + + +
        (src.fileEnviron.ScreenEnviron method) +
        + +
        + +
        add_echo() (src.fileEnviron.ContextFileEnviron method) +
        + +
        + +
        (src.fileEnviron.FileEnviron method) +
        + + +
        (src.fileEnviron.LauncherFileEnviron method) +
        + + +
        (src.fileEnviron.ScreenEnviron method) +
        + +
        + +
        add_line() (src.environment.SalomeEnviron method) +
        + +
        + +
        (src.fileEnviron.FileEnviron method) +
        + + +
        (src.fileEnviron.LauncherFileEnviron method) +
        + + +
        (src.fileEnviron.ScreenEnviron method) +
        + +
        + +
        add_link() (src.logger.Logger method) +
        + + +
        add_option() (src.options.Options method) +
        + + +
        add_simple_node() (in module src.xmlManager) +
        + +
        + +
        (src.xmlManager.XmlLogFile method) +
        + +
        + +
        add_warning() (src.environment.SalomeEnviron method) +
        + +
        + +
        (src.fileEnviron.ContextFileEnviron method) +
        + + +
        (src.fileEnviron.FileEnviron method) +
        + + +
        (src.fileEnviron.LauncherFileEnviron method) +
        + + +
        (src.fileEnviron.ScreenEnviron method) +
        + +
        + +
        addElement() (src.pyconf.Reference method) +
        + + +
        addMapping() (src.pyconf.Mapping method) +
        + + +
        addNamespace() (src.pyconf.Config method) +
        + + +
        ANSI_CSI_RE (src.colorama.ansitowin32.AnsiToWin32 attribute) +
        + +
        + +
        ANSI_OSC_RE (src.colorama.ansitowin32.AnsiToWin32 attribute) +
        + + +
        AnsiBack (class in src.colorama.ansi) +
        + + +
        AnsiCodes (class in src.colorama.ansi) +
        + + +
        AnsiCursor (class in src.colorama.ansi) +
        + + +
        AnsiFore (class in src.colorama.ansi) +
        + + +
        AnsiStyle (class in src.colorama.ansi) +
        + + +
        AnsiToWin32 (class in src.colorama.ansitowin32) +
        + + +
        append() (src.environment.Environ method) +
        + +
        + +
        (src.environment.SalomeEnviron method) +
        + + +
        (src.fileEnviron.FileEnviron method) +
        + + +
        (src.fileEnviron.LauncherFileEnviron method) +
        + + +
        (src.fileEnviron.ScreenEnviron method) +
        + + +
        (src.pyconf.Sequence method) +
        + +
        + +
        append_node_attrib() (in module src.xmlManager) +
        + +
        + +
        (src.xmlManager.XmlLogFile method) +
        + +
        + +
        append_node_text() (src.xmlManager.XmlLogFile method) +
        + + +
        append_value() (src.environment.Environ method) +
        + +
        + +
        (src.fileEnviron.ContextFileEnviron method) +
        + + +
        (src.fileEnviron.FileEnviron method) +
        + + +
        (src.fileEnviron.LauncherFileEnviron method) +
        + +
        + +
        archive_extract() (in module src.system) +
        + +
        + +

        B

        + + + +
        + +
        BACK() (src.colorama.ansi.AnsiCursor method) +
        + + +
        back() (src.colorama.winterm.WinTerm method) +
        + + +
        base() (src.__init__.Path method) +
        + + +
        BashFileEnviron (class in src.fileEnviron) +
        + + +
        batch() (in module src.fork) +
        + + +
        batch_salome() (in module src.fork) +
        + + +
        BatFileEnviron (class in src.fileEnviron) +
        + +
        + +
        BLACK (src.colorama.ansi.AnsiBack attribute) +
        + +
        + +
        (src.colorama.ansi.AnsiFore attribute) +
        + + +
        (src.colorama.winterm.WinColor attribute) +
        + +
        + +
        BLUE (src.colorama.ansi.AnsiBack attribute) +
        + +
        + +
        (src.colorama.ansi.AnsiFore attribute) +
        + + +
        (src.colorama.winterm.WinColor attribute) +
        + +
        + +
        BRIGHT (src.colorama.ansi.AnsiStyle attribute) +
        + +
        + +
        (src.colorama.winterm.WinStyle attribute) +
        + +
        + +
        BRIGHT_BACKGROUND (src.colorama.winterm.WinStyle attribute) +
        + + +
        build_configure() (src.compilation.Builder method) +
        + + +
        Builder (class in src.compilation) +
        + +
        + +

        C

        + + + +
        + +
        call_win32() (src.colorama.ansitowin32.AnsiToWin32 method) +
        + + +
        change_to_launcher() (src.fileEnviron.LauncherFileEnviron method) +
        + + +
        check() (src.compilation.Builder method) +
        + + +
        check_config_exists() (in module src.product) +
        + + +
        check_config_has_application() (in module src.__init__) +
        + + +
        check_config_has_profile() (in module src.__init__) +
        + + +
        check_installation() (in module src.product) +
        + + +
        check_source() (in module src.product) +
        + + +
        chmod() (src.__init__.Path method) +
        + + +
        cleancolor() (in module src.printcolors) +
        + + +
        clear_line() (in module src.colorama.ansi) +
        + + +
        clear_screen() (in module src.colorama.ansi) +
        + + +
        close() (src.debug.OutStream method) +
        + +
        + +
        (src.ElementTree.TreeBuilder method) +
        + + +
        (src.ElementTree.XMLTreeBuilder method) +
        + + +
        (src.pyconf.ConfigInputStream method) +
        + + +
        (src.pyconf.ConfigOutputStream method) +
        + +
        + +
        cmake() (src.compilation.Builder method) +
        + + +
        code_to_chars() (in module src.colorama.ansi) +
        + + +
        colorama_text() (in module src.colorama.initialise) +
        + + +
        command_value() (src.environment.Environ method) +
        + +
        + +
        (src.fileEnviron.BashFileEnviron method) +
        + + +
        (src.fileEnviron.BatFileEnviron method) +
        + + +
        (src.fileEnviron.ContextFileEnviron method) +
        + + +
        (src.fileEnviron.FileEnviron method) +
        + + +
        (src.fileEnviron.LauncherFileEnviron method) +
        + + +
        (src.fileEnviron.ScreenEnviron method) +
        + +
        + +
        Comment() (in module src.ElementTree) +
        + + +
        complete_environment() (src.compilation.Builder method) +
        + + +
        Config (class in src.pyconf) +
        + + +
        Config.Namespace (class in src.pyconf) +
        + +
        + +
        config_has_application() (in module src.__init__) +
        + + +
        ConfigError +
        + + +
        ConfigFormatError +
        + + +
        ConfigInputStream (class in src.pyconf) +
        + + +
        ConfigList (class in src.pyconf) +
        + + +
        ConfigMerger (class in src.pyconf) +
        + + +
        ConfigOutputStream (class in src.pyconf) +
        + + +
        ConfigReader (class in src.pyconf) +
        + + +
        ConfigResolutionError +
        + + +
        configure() (src.compilation.Builder method) +
        + + +
        Container (class in src.pyconf) +
        + + +
        ContextFileEnviron (class in src.fileEnviron) +
        + + +
        convert_ansi() (src.colorama.ansitowin32.AnsiToWin32 method) +
        + + +
        convert_osc() (src.colorama.ansitowin32.AnsiToWin32 method) +
        + + +
        copy() (src.__init__.Path method) +
        + + +
        copydir() (src.__init__.Path method) +
        + + +
        copyfile() (src.__init__.Path method) +
        + + +
        copylink() (src.__init__.Path method) +
        + + +
        cursor_adjust() (src.colorama.winterm.WinTerm method) +
        + + +
        cvs_extract() (in module src.system) +
        + + +
        CYAN (src.colorama.ansi.AnsiBack attribute) +
        + +
        + +
        (src.colorama.ansi.AnsiFore attribute) +
        + + +
        (src.colorama.winterm.WinColor attribute) +
        + +
        +
        + +

        D

        + + + +
        + +
        data() (src.ElementTree.TreeBuilder method) +
        + + +
        date_to_datetime() (in module src.logger) +
        + + +
        deepcopy_list() (in module src.__init__) +
        + + +
        deepCopyMapping() (in module src.pyconf) +
        + + +
        defaultMergeResolve() (in module src.pyconf) +
        + + +
        defaultStreamOpener() (in module src.pyconf) +
        + + +
        deinit() (in module src.colorama.initialise) +
        + + +
        delimiter (src.template.MyTemplate attribute) +
        + + +
        DIM (src.colorama.ansi.AnsiStyle attribute) +
        + +
        + +
        dir() (src.__init__.Path method) +
        + + +
        do_batch_script_build() (src.compilation.Builder method) +
        + + +
        do_default_build() (src.compilation.Builder method) +
        + + +
        do_python_script_build() (src.compilation.Builder method) +
        + + +
        do_script_build() (src.compilation.Builder method) +
        + + +
        doctype() (src.ElementTree.XMLTreeBuilder method) +
        + + +
        DOWN() (src.colorama.ansi.AnsiCursor method) +
        + + +
        dump() (in module src.ElementTree) +
        + +
        + +
        (src.environment.SalomeEnviron method) +
        + +
        +
        + +

        E

        + + + +
        + +
        Element() (in module src.ElementTree) +
        + + +
        ElementTree (class in src.ElementTree) +
        + + +
        end() (src.ElementTree.TreeBuilder method) +
        + + +
        end_write() (src.logger.Logger method) +
        + + +
        ensure_path_exists() (in module src.__init__) +
        + + +
        Environ (class in src.environment) +
        + + +
        erase_line() (src.colorama.winterm.WinTerm method) +
        + +
        + +
        erase_screen() (src.colorama.winterm.WinTerm method) +
        + + +
        error() (src.logger.Logger method) +
        + + +
        evaluate() (src.pyconf.Container method) +
        + +
        + +
        (src.pyconf.Expression method) +
        + +
        + +
        exists() (src.__init__.Path method) +
        + + +
        Expression (class in src.pyconf) +
        + + +
        extract_params() (src.colorama.ansitowin32.AnsiToWin32 method) +
        + +
        + +

        F

        + + + +
        + +
        feed() (src.ElementTree.XMLTreeBuilder method) +
        + + +
        FileEnviron (class in src.fileEnviron) +
        + + +
        FileEnvWriter (class in src.environment) +
        + + +
        find() (src.ElementTree.ElementTree method) +
        + + +
        find_file_in_lpath() (in module src.__init__) +
        + + +
        find_node_by_attrib() (in module src.xmlManager) +
        + + +
        findall() (src.ElementTree.ElementTree method) +
        + +
        + +
        findConfig() (src.pyconf.Reference method) +
        + + +
        findtext() (src.ElementTree.ElementTree method) +
        + + +
        finish() (src.environment.SalomeEnviron method) +
        + +
        + +
        (src.fileEnviron.BashFileEnviron method) +
        + + +
        (src.fileEnviron.BatFileEnviron method) +
        + + +
        (src.fileEnviron.ContextFileEnviron method) +
        + + +
        (src.fileEnviron.FileEnviron method) +
        + + +
        (src.fileEnviron.LauncherFileEnviron method) +
        + +
        + +
        flush() (src.logger.Logger method) +
        + +
        + +
        (src.pyconf.ConfigOutputStream method) +
        + +
        + +
        fore() (src.colorama.winterm.WinTerm method) +
        + + +
        FORWARD() (src.colorama.ansi.AnsiCursor method) +
        + + +
        fromstring() (in module src.ElementTree) +
        + +
        + +

        G

        + + + +
        + +
        generate_launching_commands() (src.test_module.Test method) +
        + + +
        generate_script() (src.test_module.Test method) +
        + + +
        get() (src.environment.Environ method) +
        + +
        + +
        (src.environment.SalomeEnviron method) +
        + + +
        (src.fileEnviron.BatFileEnviron method) +
        + + +
        (src.fileEnviron.ContextFileEnviron method) +
        + + +
        (src.fileEnviron.FileEnviron method) +
        + + +
        (src.fileEnviron.LauncherFileEnviron method) +
        + + +
        (src.fileEnviron.ScreenEnviron method) +
        + + +
        (src.pyconf.Mapping method) +
        + +
        + +
        get_attrib() (src.xmlManager.ReadXmlFile method) +
        + + +
        get_attrs() (src.colorama.winterm.WinTerm method) +
        + + +
        get_base_install_dir() (in module src.product) +
        + + +
        get_base_path() (in module src.__init__) +
        + + +
        get_cfg_param() (in module src.__init__) +
        + + +
        get_distrib_version() (in module src.architecture) +
        + + +
        get_distribution() (in module src.architecture) +
        + + +
        get_file_environ() (in module src.fileEnviron) +
        + + +
        get_install_dir() (in module src.product) +
        + + +
        get_launcher_name() (in module src.__init__) +
        + + +
        get_log_path() (in module src.__init__) +
        + + +
        get_names() (src.environment.SalomeEnviron method) +
        + + +
        get_nb_proc() (in module src.architecture) +
        + + +
        get_node_text() (src.xmlManager.ReadXmlFile method) +
        + + +
        get_position() (src.colorama.winterm.WinTerm method) +
        + + +
        get_product_components() (in module src.product) +
        + + +
        get_product_config() (in module src.product) +
        + + +
        get_product_dependencies() (in module src.product) +
        + + +
        get_product_section() (in module src.product) +
        + +
        + +
        get_products_infos() (in module src.product) +
        + + +
        get_property_in_product_cfg() (in module src.__init__) +
        + + +
        get_python_version() (in module src.architecture) +
        + + +
        get_salome_version() (in module src.__init__) +
        + + +
        get_test_timeout() (src.test_module.Test method) +
        + + +
        get_tmp_dir() (src.test_module.Test method) +
        + + +
        get_tmp_filename() (in module src.__init__) +
        + + +
        get_user() (in module src.architecture) +
        + + +
        get_win32_calls() (src.colorama.ansitowin32.AnsiToWin32 method) +
        + + +
        getByPath() (src.pyconf.Config method) +
        + +
        + +
        (src.pyconf.ConfigList method) +
        + +
        + +
        getChar() (src.pyconf.ConfigReader method) +
        + + +
        getiterator() (src.ElementTree.ElementTree method) +
        + + +
        getLocalEnv() (in module src.debug) +
        + + +
        getroot() (src.ElementTree.ElementTree method) +
        + + +
        getRootAttrib() (src.xmlManager.ReadXmlFile method) +
        + + +
        getStrConfigDbg() (in module src.debug) +
        + + +
        getStrConfigStd() (in module src.debug) +
        + + +
        getTmpDirDEFAULT() (in module src.test_module) +
        + + +
        getToken() (src.pyconf.ConfigReader method) +
        + + +
        git_extract() (in module src.system) +
        + + +
        GREEN (src.colorama.ansi.AnsiBack attribute) +
        + +
        + +
        (src.colorama.ansi.AnsiFore attribute) +
        + + +
        (src.colorama.winterm.WinColor attribute) +
        + +
        + +
        GREY (src.colorama.winterm.WinColor attribute) +
        + +
        + +

        H

        + + + +
        + +
        hack_libtool() (src.compilation.Builder method) +
        + + +
        handleMismatch() (src.pyconf.ConfigMerger method) +
        + +
        + +
        handleRemoveReadonly() (in module src.__init__) +
        + +
        + +

        I

        + + + +
        + +
        indent() (in module src.debug) +
        + + +
        init() (in module src.colorama.initialise) +
        + + +
        install() (src.compilation.Builder method) +
        + + +
        InStream (class in src.debug) +
        + + +
        is_a_tty() (in module src.colorama.ansitowin32) +
        + + +
        is_defined() (src.environment.Environ method) +
        + +
        + +
        (src.environment.SalomeEnviron method) +
        + + +
        (src.fileEnviron.FileEnviron method) +
        + + +
        (src.fileEnviron.LauncherFileEnviron method) +
        + + +
        (src.fileEnviron.ScreenEnviron method) +
        + +
        + +
        is_stream_closed() (in module src.colorama.ansitowin32) +
        + + +
        is_windows() (in module src.architecture) +
        + +
        + +
        isdir() (src.__init__.Path method) +
        + + +
        iselement() (in module src.ElementTree) +
        + + +
        isfile() (src.__init__.Path method) +
        + + +
        islink() (src.__init__.Path method) +
        + + +
        isWord() (in module src.pyconf) +
        + + +
        iteritems() (src.pyconf.Mapping method) +
        + + +
        iterkeys() (src.pyconf.Mapping method) +
        + + +
        iterparse (class in src.ElementTree) +
        + +
        + +

        K

        + + +
        + +
        keys() (src.pyconf.Mapping method) +
        + +
        + +

        L

        + + + +
        + +
        launch_command() (in module src.fork) +
        + + +
        LauncherFileEnviron (class in src.fileEnviron) +
        + + +
        LIGHTBLACK_EX (src.colorama.ansi.AnsiBack attribute) +
        + +
        + +
        (src.colorama.ansi.AnsiFore attribute) +
        + +
        + +
        LIGHTBLUE_EX (src.colorama.ansi.AnsiBack attribute) +
        + +
        + +
        (src.colorama.ansi.AnsiFore attribute) +
        + +
        + +
        LIGHTCYAN_EX (src.colorama.ansi.AnsiBack attribute) +
        + +
        + +
        (src.colorama.ansi.AnsiFore attribute) +
        + +
        + +
        LIGHTGREEN_EX (src.colorama.ansi.AnsiBack attribute) +
        + +
        + +
        (src.colorama.ansi.AnsiFore attribute) +
        + +
        + +
        LIGHTMAGENTA_EX (src.colorama.ansi.AnsiBack attribute) +
        + +
        + +
        (src.colorama.ansi.AnsiFore attribute) +
        + +
        + +
        LIGHTRED_EX (src.colorama.ansi.AnsiBack attribute) +
        + +
        + +
        (src.colorama.ansi.AnsiFore attribute) +
        + +
        + +
        LIGHTWHITE_EX (src.colorama.ansi.AnsiBack attribute) +
        + +
        + +
        (src.colorama.ansi.AnsiFore attribute) +
        + +
        + +
        LIGHTYELLOW_EX (src.colorama.ansi.AnsiBack attribute) +
        + +
        + +
        (src.colorama.ansi.AnsiFore attribute) +
        + +
        +
        + +
        list() (src.__init__.Path method) +
        + + +
        list_log_file() (in module src.logger) +
        + + +
        load() (src.pyconf.Config method) +
        + +
        + +
        (src.pyconf.ConfigReader method) +
        + +
        + +
        load_cfg_environment() (src.environment.SalomeEnviron method) +
        + + +
        load_environment() (in module src.environment) +
        + + +
        location() (src.pyconf.ConfigReader method) +
        + + +
        log() (src.compilation.Builder method) +
        + + +
        log_command() (src.compilation.Builder method) +
        + + +
        Logger (class in src.logger) +
        + +
        + +

        M

        + + + +
        + +
        MAGENTA (src.colorama.ansi.AnsiBack attribute) +
        + +
        + +
        (src.colorama.ansi.AnsiFore attribute) +
        + + +
        (src.colorama.winterm.WinColor attribute) +
        + +
        + +
        make() (src.__init__.Path method) +
        + +
        + +
        (src.compilation.Builder method) +
        + +
        + +
        makePath() (in module src.pyconf) +
        + + +
        Mapping (class in src.pyconf) +
        + + +
        match() (src.pyconf.ConfigReader method) +
        + +
        + +
        merge() (src.pyconf.ConfigMerger method) +
        + + +
        merge_dicts() (in module src.__init__) +
        + + +
        mergeMapping() (src.pyconf.ConfigMerger method) +
        + + +
        mergeSequence() (src.pyconf.ConfigMerger method) +
        + + +
        MyTemplate (class in src.template) +
        + +
        + +

        N

        + + + +
        + +
        next() (src.ElementTree.iterparse method) +
        + +
        + +
        (src.pyconf.Sequence.SeqIter method) +
        + +
        +
        + +
        NORMAL (src.colorama.ansi.AnsiStyle attribute) +
        + +
        + +
        (src.colorama.winterm.WinStyle attribute) +
        + +
        +
        + +

        O

        + + + +
        + +
        only_numbers() (in module src.__init__) +
        + + +
        Options (class in src.options) +
        + + +
        OptResult (class in src.options) +
        + +
        + +
        OutStream (class in src.debug) +
        + + +
        overwriteKeys() (src.pyconf.ConfigMerger method) +
        + + +
        overwriteMergeResolve() (in module src.pyconf) +
        + +
        + +

        P

        + + + +
        + +
        parse() (in module src.ElementTree) +
        + +
        + +
        (src.ElementTree.ElementTree method) +
        + +
        + +
        parse_args() (src.options.Options method) +
        + + +
        parse_date() (in module src.__init__) +
        + + +
        parseFactor() (src.pyconf.ConfigReader method) +
        + + +
        parseKeyValuePair() (src.pyconf.ConfigReader method) +
        + + +
        parseMapping() (src.pyconf.ConfigReader method) +
        + + +
        parseMappingBody() (src.pyconf.ConfigReader method) +
        + + +
        parseReference() (src.pyconf.ConfigReader method) +
        + + +
        parseScalar() (src.pyconf.ConfigReader method) +
        + + +
        parseSequence() (src.pyconf.ConfigReader method) +
        + + +
        parseSuffix() (src.pyconf.ConfigReader method) +
        + + +
        parseTerm() (src.pyconf.ConfigReader method) +
        + + +
        parseValue() (src.pyconf.ConfigReader method) +
        + + +
        Path (class in src.__init__) +
        + + +
        pattern (src.template.MyTemplate attribute) +
        + + +
        PI() (in module src.ElementTree) +
        + + +
        pop_debug() (in module src.debug) +
        + + +
        POS() (src.colorama.ansi.AnsiCursor method) +
        + + +
        prepare() (src.compilation.Builder method) +
        + + +
        prepare_testbase() (src.test_module.Test method) +
        + + +
        prepare_testbase_from_dir() (src.test_module.Test method) +
        + + +
        prepare_testbase_from_git() (src.test_module.Test method) +
        + + +
        prepare_testbase_from_svn() (src.test_module.Test method) +
        + + +
        prepend() (src.environment.Environ method) +
        + +
        + +
        (src.environment.SalomeEnviron method) +
        + + +
        (src.fileEnviron.FileEnviron method) +
        + + +
        (src.fileEnviron.LauncherFileEnviron method) +
        + + +
        (src.fileEnviron.ScreenEnviron method) +
        + +
        + +
        prepend_value() (src.environment.Environ method) +
        + +
        + +
        (src.fileEnviron.ContextFileEnviron method) +
        + + +
        (src.fileEnviron.FileEnviron method) +
        + + +
        (src.fileEnviron.LauncherFileEnviron method) +
        + +
        + +
        print_color_map() (in module src.printcolors) +
        + + +
        print_color_range() (in module src.printcolors) +
        + + +
        print_help() (src.options.Options method) +
        + + +
        print_info() (in module src.__init__) +
        + + +
        print_value() (in module src.printcolors) +
        + + +
        printc() (in module src.printcolors) +
        + +
        + +
        printcError() (in module src.printcolors) +
        + + +
        printcHeader() (in module src.printcolors) +
        + + +
        printcHighlight() (in module src.printcolors) +
        + + +
        printcInfo() (in module src.printcolors) +
        + + +
        printcLabel() (in module src.printcolors) +
        + + +
        printcSuccess() (in module src.printcolors) +
        + + +
        printcWarning() (in module src.printcolors) +
        + + +
        ProcessingInstruction() (in module src.ElementTree) +
        + + +
        product_compiles() (in module src.product) +
        + + +
        product_has_env_script() (in module src.product) +
        + + +
        product_has_logo() (in module src.product) +
        + + +
        product_has_patches() (in module src.product) +
        + + +
        product_has_salome_gui() (in module src.product) +
        + + +
        product_has_script() (in module src.product) +
        + + +
        product_is_autotools() (in module src.product) +
        + + +
        product_is_cmake() (in module src.product) +
        + + +
        product_is_cpp() (in module src.product) +
        + + +
        product_is_debug() (in module src.product) +
        + + +
        product_is_dev() (in module src.product) +
        + + +
        product_is_fixed() (in module src.product) +
        + + +
        product_is_generated() (in module src.product) +
        + + +
        product_is_mpi() (in module src.product) +
        + + +
        product_is_native() (in module src.product) +
        + + +
        product_is_salome() (in module src.product) +
        + + +
        product_is_sample() (in module src.product) +
        + + +
        product_is_smesh_plugin() (in module src.product) +
        + + +
        product_is_vcs() (in module src.product) +
        + + +
        push_debug() (in module src.debug) +
        + + +
        put_initial_xml_fields() (src.logger.Logger method) +
        + + +
        put_txt_log_in_appli_log_dir() (src.compilation.Builder method) +
        + +
        + +

        Q

        + + +
        + +
        QName (class in src.ElementTree) +
        + +
        + +

        R

        + + + +
        + +
        read() (src.pyconf.ConfigInputStream method) +
        + + +
        read_config_from_a_file() (in module src.__init__) +
        + + +
        read_results() (src.test_module.Test method) +
        + + +
        readline() (src.pyconf.ConfigInputStream method) +
        + + +
        readlink() (src.__init__.Path method) +
        + + +
        ReadXmlFile (class in src.xmlManager) +
        + + +
        RED (src.colorama.ansi.AnsiBack attribute) +
        + +
        + +
        (src.colorama.ansi.AnsiFore attribute) +
        + + +
        (src.colorama.winterm.WinColor attribute) +
        + +
        + +
        Reference (class in src.pyconf) +
        + + +
        reinit() (in module src.colorama.initialise) +
        + + +
        remove_item_from_list() (in module src.__init__) +
        + + +
        removeNamespace() (src.pyconf.Config method) +
        + + +
        replace_in_file() (in module src.__init__) +
        + + +
        RESET (src.colorama.ansi.AnsiBack attribute) +
        + +
        + +
        (src.colorama.ansi.AnsiFore attribute) +
        + +
        +
        + +
        RESET_ALL (src.colorama.ansi.AnsiStyle attribute) +
        + + +
        reset_all() (in module src.colorama.initialise) +
        + +
        + +
        (src.colorama.ansitowin32.AnsiToWin32 method) +
        + + +
        (src.colorama.winterm.WinTerm method) +
        + +
        + +
        resolve() (src.pyconf.Reference method) +
        + + +
        rm() (src.__init__.Path method) +
        + + +
        run_all_tests() (src.test_module.Test method) +
        + + +
        run_env_script() (src.environment.SalomeEnviron method) +
        + +
        + +
        (src.fileEnviron.ScreenEnviron method) +
        + +
        + +
        run_grid_tests() (src.test_module.Test method) +
        + + +
        run_script() (src.test_module.Test method) +
        + + +
        run_session_tests() (src.test_module.Test method) +
        + + +
        run_simple_env_script() (src.environment.SalomeEnviron method) +
        + + +
        run_testbase_tests() (src.test_module.Test method) +
        + + +
        run_tests() (src.test_module.Test method) +
        + +
        + +

        S

        + + + +
        + +
        SalomeEnviron (class in src.environment) +
        + + +
        SatException +
        + + +
        saveConfigDbg() (in module src.debug) +
        + + +
        saveConfigStd() (in module src.debug) +
        + + +
        ScreenEnviron (class in src.fileEnviron) +
        + + +
        search_known_errors() (src.test_module.Test method) +
        + + +
        Sequence (class in src.pyconf) +
        + + +
        Sequence.SeqIter (class in src.pyconf) +
        + + +
        set() (src.environment.Environ method) +
        + +
        + +
        (src.environment.SalomeEnviron method) +
        + + +
        (src.fileEnviron.BashFileEnviron method) +
        + + +
        (src.fileEnviron.BatFileEnviron method) +
        + + +
        (src.fileEnviron.ContextFileEnviron method) +
        + + +
        (src.fileEnviron.FileEnviron method) +
        + + +
        (src.fileEnviron.LauncherFileEnviron method) +
        + + +
        (src.fileEnviron.ScreenEnviron method) +
        + +
        + +
        set_a_product() (src.environment.SalomeEnviron method) +
        + + +
        set_application_env() (src.environment.SalomeEnviron method) +
        + + +
        set_attrs() (src.colorama.winterm.WinTerm method) +
        + + +
        set_console() (src.colorama.winterm.WinTerm method) +
        + + +
        set_cpp_env() (src.environment.SalomeEnviron method) +
        + + +
        set_cursor_position() (src.colorama.winterm.WinTerm method) +
        + + +
        set_full_environ() (src.environment.SalomeEnviron method) +
        + + +
        set_products() (src.environment.SalomeEnviron method) +
        + + +
        set_python_libdirs() (src.environment.SalomeEnviron method) +
        + + +
        set_salome_generic_product_env() (src.environment.SalomeEnviron method) +
        + + +
        set_salome_minimal_product_env() (src.environment.SalomeEnviron method) +
        + + +
        set_title() (in module src.colorama.ansi) +
        + +
        + +
        (src.colorama.winterm.WinTerm method) +
        + +
        + +
        SetConsoleTextAttribute() (in module src.colorama.win32) +
        + + +
        setPath() (src.pyconf.Container method) +
        + + +
        setStream() (src.pyconf.ConfigReader method) +
        + + +
        Shell (class in src.environment) +
        + + +
        should_wrap() (src.colorama.ansitowin32.AnsiToWin32 method) +
        + + +
        show_command_log() (in module src.logger) +
        + + +
        show_in_editor() (in module src.system) +
        + + +
        show_progress() (in module src.fork) +
        + + +
        smartcopy() (src.__init__.Path method) +
        + + +
        special_path_separator() (in module src.fileEnviron) +
        + +
        + +
        src.__init__ (module) +
        + + +
        src.architecture (module) +
        + + +
        src.colorama (module) +
        + + +
        src.colorama.ansi (module) +
        + + +
        src.colorama.ansitowin32 (module) +
        + + +
        src.colorama.initialise (module) +
        + + +
        src.colorama.win32 (module) +
        + + +
        src.colorama.winterm (module) +
        + + +
        src.compilation (module) +
        + + +
        src.debug (module) +
        + + +
        src.ElementTree (module) +
        + + +
        src.environment (module) +
        + + +
        src.fileEnviron (module) +
        + + +
        src.fork (module) +
        + + +
        src.logger (module) +
        + + +
        src.options (module) +
        + + +
        src.printcolors (module) +
        + + +
        src.product (module) +
        + + +
        src.pyconf (module) +
        + + +
        src.system (module) +
        + + +
        src.template (module) +
        + + +
        src.test_module (module) +
        + + +
        src.xmlManager (module) +
        + + +
        start() (src.ElementTree.TreeBuilder method) +
        + + +
        StreamWrapper (class in src.colorama.ansitowin32) +
        + + +
        style() (src.colorama.winterm.WinTerm method) +
        + + +
        SubElement() (in module src.ElementTree) +
        + + +
        substitute() (in module src.template) +
        + + +
        svn_extract() (in module src.system) +
        + + +
        symlink() (src.__init__.Path method) +
        + +
        + +

        T

        + + + +
        + +
        Test (class in src.test_module) +
        + + +
        timedelta_total_seconds() (in module src.logger) +
        + + +
        tofix() (in module src.debug) +
        + +
        + +
        tostring() (in module src.ElementTree) +
        + + +
        TreeBuilder (class in src.ElementTree) +
        + +
        + +

        U

        + + + +
        + +
        UP() (src.colorama.ansi.AnsiCursor method) +
        + +
        + +
        update_hat_xml() (in module src.logger) +
        + +
        + +

        W

        + + + +
        + +
        WHITE (src.colorama.ansi.AnsiBack attribute) +
        + +
        + +
        (src.colorama.ansi.AnsiFore attribute) +
        + +
        + +
        winapi_test() (in module src.colorama.win32) +
        + + +
        WinColor (class in src.colorama.winterm) +
        + + +
        WinStyle (class in src.colorama.winterm) +
        + + +
        WinTerm (class in src.colorama.winterm) +
        + + +
        wmake() (src.compilation.Builder method) +
        + + +
        wrap_stream() (in module src.colorama.initialise) +
        + + +
        write() (in module src.debug) +
        + +
        + +
        (src.ElementTree.ElementTree method) +
        + + +
        (src.colorama.ansitowin32.AnsiToWin32 method) +
        + + +
        (src.colorama.ansitowin32.StreamWrapper method) +
        + + +
        (src.fileEnviron.ScreenEnviron method) +
        + + +
        (src.logger.Logger method) +
        + + +
        (src.pyconf.ConfigOutputStream method) +
        + +
        + +
        write_and_convert() (src.colorama.ansitowin32.AnsiToWin32 method) +
        + +
        + +
        write_back() (in module src.fork) +
        + + +
        write_cfgForPy_file() (src.environment.FileEnvWriter method) +
        + + +
        write_env_file() (src.environment.FileEnvWriter method) +
        + + +
        write_plain_text() (src.colorama.ansitowin32.AnsiToWin32 method) +
        + + +
        write_report() (in module src.xmlManager) +
        + + +
        write_test_margin() (src.test_module.Test method) +
        + + +
        write_tree() (src.xmlManager.XmlLogFile method) +
        + + +
        writeToStream() (src.pyconf.Container method) +
        + +
        + +
        (src.pyconf.Mapping method) +
        + + +
        (src.pyconf.Sequence method) +
        + +
        + +
        writeValue() (src.pyconf.Container method) +
        + +
        + +

        X

        + + + +
        + +
        XML() (in module src.ElementTree) +
        + + +
        XmlLogFile (class in src.xmlManager) +
        + +
        + +
        XMLTreeBuilder (class in src.ElementTree) +
        + +
        + +

        Y

        + + +
        + +
        YELLOW (src.colorama.ansi.AnsiBack attribute) +
        + +
        + +
        (src.colorama.ansi.AnsiFore attribute) +
        + + +
        (src.colorama.winterm.WinColor attribute) +
        + +
        +
        + + + +
        +
        +
        +
        +
        + + +
        +

        Related Topics

        + +
        + + + +
        +
        +
        +
        +
        + ©2018, CEA. + + | + Powered by Sphinx 1.1.3 + & Alabaster + +
        + + + + + + \ No newline at end of file diff --git a/doc/build/html/index.html b/doc/build/html/index.html new file mode 100644 index 0000000..dd5ff1b --- /dev/null +++ b/doc/build/html/index.html @@ -0,0 +1,188 @@ + + + + + + + + + Salome Tools — salomeTools 5.0.0dev documentation + + + + + + + + + + + + + + + + + + + + + + +
        +
        +
        +
        + +
        +

        Salome Tools¶

        +_images/sat_about.png +
        +

        Warning

        +

        This documentation is under construction.

        +
        +

        The SalomeTools (sat) is a suite of commands +that can be used to perform operations on SALOME.

        +

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

        +

        This utility code is a set of Python scripts files.

        + + +
        +

        Developer documentation¶

        +
        + +
        +
        +
        +

        Code documentation¶

        +
        + +
        +
        +
        +

        Release Notes¶

        +
        + +
        +
        +
        + + +
        +
        +
        +
        +
        + +

        Table Of Contents

        + +
        +

        Related Topics

        + +
        +

        This Page

        + + + +
        +
        +
        +
        +
        + ©2018, CEA. + + | + Powered by Sphinx 1.1.3 + & Alabaster + + | + Page source +
        + + + + + + \ No newline at end of file diff --git a/doc/build/html/installation_of_sat.html b/doc/build/html/installation_of_sat.html new file mode 100644 index 0000000..8623c02 --- /dev/null +++ b/doc/build/html/installation_of_sat.html @@ -0,0 +1,113 @@ + + + + + + + + + Installation — salomeTools 5.0.0dev documentation + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +
        +
        + +
        +

        Installation¶

        +

        Usually user could find (and use) command sat directly after a 'detar' installation of SALOME.

        +
        tar -xf .../SALOME_xx.tgz
+cd SALOME_xx
+ls -l sat      # sat -> salomeTools/sat
+
        +
        +

        Python package (scripts of salomeTools) actually remains in directory salomeTools.

        +
        + + +
        +
        +
        +
        +
        +
        +

        Related Topics

        + +
        +

        This Page

        + + + +
        +
        +
        +
        +
        + ©2018, CEA. + + | + Powered by Sphinx 1.1.3 + & Alabaster + + | + Page source +
        + + + + + + \ No newline at end of file diff --git a/doc/build/html/objects.inv b/doc/build/html/objects.inv new file mode 100644 index 0000000..87ed04b Binary files /dev/null and b/doc/build/html/objects.inv differ diff --git a/doc/build/html/py-modindex.html b/doc/build/html/py-modindex.html new file mode 100644 index 0000000..372be51 --- /dev/null +++ b/doc/build/html/py-modindex.html @@ -0,0 +1,227 @@ + + + + + + + + + Python Module Index — salomeTools 5.0.0dev documentation + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +
        +
        + + +

        Python Module Index

        + +
        + s +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
         
        + s
        + src +
            + src.__init__ +
            + src.architecture +
            + src.colorama +
            + src.colorama.ansi +
            + src.colorama.ansitowin32 +
            + src.colorama.initialise +
            + src.colorama.win32 +
            + src.colorama.winterm +
            + src.compilation +
            + src.debug +
            + src.ElementTree +
            + src.environment +
            + src.fileEnviron +
            + src.fork +
            + src.logger +
            + src.options +
            + src.printcolors +
            + src.product +
            + src.pyconf +
            + src.system +
            + src.template +
            + src.test_module +
            + src.xmlManager +
        + + +
        +
        +
        +
        +
        +
        +

        Related Topics

        + +
        + + +
        +
        +
        +
        +
        + ©2018, CEA. + + | + Powered by Sphinx 1.1.3 + & Alabaster + +
        + + + + + + \ No newline at end of file diff --git a/doc/build/html/release_notes/release_notes_5.0.0.html b/doc/build/html/release_notes/release_notes_5.0.0.html new file mode 100644 index 0000000..84067f2 --- /dev/null +++ b/doc/build/html/release_notes/release_notes_5.0.0.html @@ -0,0 +1,105 @@ + + + + + + + + + Release notes — salomeTools 5.0.0dev documentation + + + + + + + + + + + + + + + + + + + + + + +
        +
        +
        +
        + +
        +

        Release notes¶

        +

        In construction.

        +
        + + +
        +
        +
        +
        +
        +
        +

        Related Topics

        + +
        +

        This Page

        + + + +
        +
        +
        +
        +
        + ©2018, CEA. + + | + Powered by Sphinx 1.1.3 + & Alabaster + + | + Page source +
        + + + + + + \ No newline at end of file diff --git a/doc/build/html/search.html b/doc/build/html/search.html new file mode 100644 index 0000000..6b69ca2 --- /dev/null +++ b/doc/build/html/search.html @@ -0,0 +1,106 @@ + + + + + + + + + Search — salomeTools 5.0.0dev documentation + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +
        +
        + +

        Search

        +
        + +

        + Please activate JavaScript to enable the search + functionality. +

        +
        +

        + From here you can search these documents. Enter your search + words into the box below and click "search". Note that the search + function will automatically search for all of the words. Pages + containing fewer words won't appear in the result list. +

        +
        + + + +
        + +
        + +
        + +
        +
        +
        +
        +
        +
        +

        Related Topics

        + +
        +
        +
        +
        +
        +
        + ©2018, CEA. + + | + Powered by Sphinx 1.1.3 + & Alabaster + +
        + + + + + + \ No newline at end of file diff --git a/doc/build/html/searchindex.js b/doc/build/html/searchindex.js new file mode 100644 index 0000000..55f8823 --- /dev/null +++ b/doc/build/html/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({objects:{"src.fork":{launch_command:[10,1,1,""],show_progress:[10,1,1,""],write_back:[10,1,1,""],batch:[10,1,1,""],batch_salome:[10,1,1,""]},"src.pyconf.ConfigInputStream":{read:[10,2,1,""],close:[10,2,1,""],readline:[10,2,1,""]},"src.colorama":{win32:[3,0,1,""],initialise:[3,0,1,""],winterm:[3,0,1,""],ansitowin32:[3,0,1,""],ansi:[3,0,1,""]},"src.fileEnviron.ScreenEnviron":{add_comment:[10,2,1,""],set:[10,2,1,""],get:[10,2,1,""],prepend:[10,2,1,""],write:[10,2,1,""],add_warning:[10,2,1,""],command_value:[10,2,1,""],run_env_script:[10,2,1,""],add_line:[10,2,1,""],is_defined:[10,2,1,""],append:[10,2,1,""],add_echo:[10,2,1,""]},"src.colorama.ansi.AnsiStyle":{RESET_ALL:[3,4,1,""],DIM:[3,4,1,""],BRIGHT:[3,4,1,""],NORMAL:[3,4,1,""]},"src.pyconf.ConfigReader":{load:[10,2,1,""],getChar:[10,2,1,""],location:[10,2,1,""],setStream:[10,2,1,""],parseReference:[10,2,1,""],parseFactor:[10,2,1,""],parseKeyValuePair:[10,2,1,""],parseMapping:[10,2,1,""],parseTerm:[10,2,1,""],parseSuffix:[10,2,1,""],parseValue:[10,2,1,""],parseMappingBody:[10,2,1,""],getToken:[10,2,1,""],parseScalar:[10,2,1,""],match:[10,2,1,""],parseSequence:[10,2,1,""]},"src.fileEnviron.ContextFileEnviron":{append_value:[10,2,1,""],finish:[10,2,1,""],set:[10,2,1,""],get:[10,2,1,""],add_warning:[10,2,1,""],command_value:[10,2,1,""],prepend_value:[10,2,1,""],add_echo:[10,2,1,""]},"src.pyconf.Sequence":{SeqIter:[10,3,1,""],writeToStream:[10,2,1,""],append:[10,2,1,""]},"src.pyconf.Mapping":{get:[10,2,1,""],keys:[10,2,1,""],writeToStream:[10,2,1,""],addMapping:[10,2,1,""],iteritems:[10,2,1,""],iterkeys:[10,2,1,""]},"src.colorama.winterm":{WinStyle:[3,3,1,""],WinTerm:[3,3,1,""],WinColor:[3,3,1,""]},"src.fileEnviron.BatFileEnviron":{add_comment:[10,2,1,""],set:[10,2,1,""],finish:[10,2,1,""],command_value:[10,2,1,""],get:[10,2,1,""]},"src.fileEnviron.LauncherFileEnviron":{add_comment:[10,2,1,""],append_value:[10,2,1,""],set:[10,2,1,""],get:[10,2,1,""],finish:[10,2,1,""],change_to_launcher:[10,2,1,""],add:[10,2,1,""],add_warning:[10,2,1,""],command_value:[10,2,1,""],add_line:[10,2,1,""],prepend:[10,2,1,""],is_defined:[10,2,1,""],prepend_value:[10,2,1,""],append:[10,2,1,""],add_echo:[10,2,1,""]},"src.options":{OptResult:[10,3,1,""],Options:[10,3,1,""]},"src.colorama.winterm.WinStyle":{BRIGHT_BACKGROUND:[3,4,1,""],BRIGHT:[3,4,1,""],NORMAL:[3,4,1,""]},"src.ElementTree.ElementTree":{write:[10,2,1,""],getroot:[10,2,1,""],getiterator:[10,2,1,""],findtext:[10,2,1,""],findall:[10,2,1,""],parse:[10,2,1,""],find:[10,2,1,""]},"src.fileEnviron.BashFileEnviron":{set:[10,2,1,""],command_value:[10,2,1,""],finish:[10,2,1,""]},"src.environment.FileEnvWriter":{write_cfgForPy_file:[10,2,1,""],write_env_file:[10,2,1,""]},"src.logger.Logger":{end_write:[10,2,1,""],flush:[10,2,1,""],write:[10,2,1,""],add_link:[10,2,1,""],error:[10,2,1,""],put_initial_xml_fields:[10,2,1,""]},"src.fileEnviron":{get_file_environ:[10,1,1,""],ContextFileEnviron:[10,3,1,""],LauncherFileEnviron:[10,3,1,""],BatFileEnviron:[10,3,1,""],ScreenEnviron:[10,3,1,""],BashFileEnviron:[10,3,1,""],special_path_separator:[10,1,1,""],FileEnviron:[10,3,1,""]},"src.colorama.ansitowin32.StreamWrapper":{write:[3,2,1,""]},"src.debug.OutStream":{close:[10,2,1,""]},"src.compilation":{Builder:[10,3,1,""]},"src.colorama.winterm.WinTerm":{style:[3,2,1,""],erase_screen:[3,2,1,""],get_position:[3,2,1,""],get_attrs:[3,2,1,""],back:[3,2,1,""],fore:[3,2,1,""],set_console:[3,2,1,""],set_attrs:[3,2,1,""],set_title:[3,2,1,""],cursor_adjust:[3,2,1,""],reset_all:[3,2,1,""],set_cursor_position:[3,2,1,""],erase_line:[3,2,1,""]},"src.colorama.win32":{winapi_test:[3,1,1,""],SetConsoleTextAttribute:[3,1,1,""]},"src.printcolors":{printcHighlight:[10,1,1,""],printcLabel:[10,1,1,""],print_color_range:[10,1,1,""],printcWarning:[10,1,1,""],print_color_map:[10,1,1,""],printcSuccess:[10,1,1,""],printc:[10,1,1,""],printcError:[10,1,1,""],print_value:[10,1,1,""],printcInfo:[10,1,1,""],cleancolor:[10,1,1,""],printcHeader:[10,1,1,""]},"src.test_module":{Test:[10,3,1,""],getTmpDirDEFAULT:[10,1,1,""]},"src.ElementTree":{XML:[10,1,1,""],Comment:[10,1,1,""],XMLTreeBuilder:[10,3,1,""],PI:[10,1,1,""],ProcessingInstruction:[10,1,1,""],dump:[10,1,1,""],fromstring:[10,1,1,""],QName:[10,3,1,""],TreeBuilder:[10,3,1,""],Element:[10,1,1,""],parse:[10,1,1,""],iterparse:[10,3,1,""],tostring:[10,1,1,""],SubElement:[10,1,1,""],iselement:[10,1,1,""],ElementTree:[10,3,1,""]},"src.environment.SalomeEnviron":{set:[10,2,1,""],dump:[10,2,1,""],set_products:[10,2,1,""],add_warning:[10,2,1,""],run_env_script:[10,2,1,""],add_line:[10,2,1,""],is_defined:[10,2,1,""],append:[10,2,1,""],add_comment:[10,2,1,""],prepend:[10,2,1,""],set_python_libdirs:[10,2,1,""],set_application_env:[10,2,1,""],finish:[10,2,1,""],get:[10,2,1,""],get_names:[10,2,1,""],set_a_product:[10,2,1,""],run_simple_env_script:[10,2,1,""],set_cpp_env:[10,2,1,""],set_full_environ:[10,2,1,""],set_salome_minimal_product_env:[10,2,1,""],set_salome_generic_product_env:[10,2,1,""],load_cfg_environment:[10,2,1,""]},"src.xmlManager.XmlLogFile":{write_tree:[10,2,1,""],append_node_attrib:[10,2,1,""],add_simple_node:[10,2,1,""],append_node_text:[10,2,1,""]},"src.pyconf.ConfigOutputStream":{write:[10,2,1,""],close:[10,2,1,""],flush:[10,2,1,""]},"src.template.MyTemplate":{pattern:[10,4,1,""],delimiter:[10,4,1,""]},"src.pyconf.Expression":{evaluate:[10,2,1,""]},"src.__init__":{handleRemoveReadonly:[10,1,1,""],find_file_in_lpath:[10,1,1,""],get_property_in_product_cfg:[10,1,1,""],ensure_path_exists:[10,1,1,""],get_cfg_param:[10,1,1,""],merge_dicts:[10,1,1,""],get_salome_version:[10,1,1,""],activate_mesa_property:[10,1,1,""],read_config_from_a_file:[10,1,1,""],deepcopy_list:[10,1,1,""],SatException:[10,5,1,""],parse_date:[10,1,1,""],get_log_path:[10,1,1,""],get_base_path:[10,1,1,""],Path:[10,3,1,""],replace_in_file:[10,1,1,""],check_config_has_application:[10,1,1,""],remove_item_from_list:[10,1,1,""],config_has_application:[10,1,1,""],check_config_has_profile:[10,1,1,""],get_launcher_name:[10,1,1,""],print_info:[10,1,1,""],only_numbers:[10,1,1,""],get_tmp_filename:[10,1,1,""]},"src.pyconf.ConfigList":{getByPath:[10,2,1,""]},"src.fileEnviron.FileEnviron":{add_comment:[10,2,1,""],append_value:[10,2,1,""],set:[10,2,1,""],get:[10,2,1,""],add_warning:[10,2,1,""],finish:[10,2,1,""],prepend:[10,2,1,""],prepend_value:[10,2,1,""],command_value:[10,2,1,""],add_line:[10,2,1,""],is_defined:[10,2,1,""],append:[10,2,1,""],add_echo:[10,2,1,""]},"src.product":{get_product_components:[10,1,1,""],product_is_dev:[10,1,1,""],check_config_exists:[10,1,1,""],get_products_infos:[10,1,1,""],get_base_install_dir:[10,1,1,""],get_product_section:[10,1,1,""],product_is_vcs:[10,1,1,""],product_is_cmake:[10,1,1,""],product_is_smesh_plugin:[10,1,1,""],product_is_fixed:[10,1,1,""],get_install_dir:[10,1,1,""],product_has_salome_gui:[10,1,1,""],check_installation:[10,1,1,""],get_product_dependencies:[10,1,1,""],product_has_script:[10,1,1,""],product_is_native:[10,1,1,""],product_is_salome:[10,1,1,""],product_is_cpp:[10,1,1,""],check_source:[10,1,1,""],product_is_mpi:[10,1,1,""],product_is_generated:[10,1,1,""],product_has_patches:[10,1,1,""],product_has_env_script:[10,1,1,""],get_product_config:[10,1,1,""],product_compiles:[10,1,1,""],product_is_autotools:[10,1,1,""],product_is_debug:[10,1,1,""],product_is_sample:[10,1,1,""],product_has_logo:[10,1,1,""]},"src.__init__.Path":{isdir:[10,2,1,""],smartcopy:[10,2,1,""],copylink:[10,2,1,""],exists:[10,2,1,""],copyfile:[10,2,1,""],make:[10,2,1,""],list:[10,2,1,""],symlink:[10,2,1,""],chmod:[10,2,1,""],copydir:[10,2,1,""],readlink:[10,2,1,""],islink:[10,2,1,""],base:[10,2,1,""],rm:[10,2,1,""],copy:[10,2,1,""],isfile:[10,2,1,""],dir:[10,2,1,""]},"src.colorama.initialise":{deinit:[3,1,1,""],reinit:[3,1,1,""],reset_all:[3,1,1,""],init:[3,1,1,""],wrap_stream:[3,1,1,""],colorama_text:[3,1,1,""]},"src.template":{substitute:[10,1,1,""],MyTemplate:[10,3,1,""]},"src.xmlManager":{append_node_attrib:[10,1,1,""],add_simple_node:[10,1,1,""],write_report:[10,1,1,""],find_node_by_attrib:[10,1,1,""],ReadXmlFile:[10,3,1,""],XmlLogFile:[10,3,1,""]},"src.pyconf.Container":{evaluate:[10,2,1,""],setPath:[10,2,1,""],writeToStream:[10,2,1,""],writeValue:[10,2,1,""]},"src.architecture":{get_distribution:[10,1,1,""],get_distrib_version:[10,1,1,""],get_python_version:[10,1,1,""],is_windows:[10,1,1,""],get_user:[10,1,1,""],get_nb_proc:[10,1,1,""]},"src.colorama.ansi.AnsiBack":{BLUE:[3,4,1,""],RESET:[3,4,1,""],LIGHTBLACK_EX:[3,4,1,""],LIGHTBLUE_EX:[3,4,1,""],LIGHTCYAN_EX:[3,4,1,""],LIGHTWHITE_EX:[3,4,1,""],LIGHTYELLOW_EX:[3,4,1,""],YELLOW:[3,4,1,""],LIGHTRED_EX:[3,4,1,""],BLACK:[3,4,1,""],WHITE:[3,4,1,""],CYAN:[3,4,1,""],GREEN:[3,4,1,""],MAGENTA:[3,4,1,""],LIGHTMAGENTA_EX:[3,4,1,""],LIGHTGREEN_EX:[3,4,1,""],RED:[3,4,1,""]},"src.system":{git_extract:[10,1,1,""],show_in_editor:[10,1,1,""],cvs_extract:[10,1,1,""],svn_extract:[10,1,1,""],archive_extract:[10,1,1,""]},"src.pyconf.Config":{load:[10,2,1,""],removeNamespace:[10,2,1,""],Namespace:[10,3,1,""],addNamespace:[10,2,1,""],getByPath:[10,2,1,""]},"src.colorama.ansi.AnsiFore":{RESET:[3,4,1,""],GREEN:[3,4,1,""],LIGHTBLACK_EX:[3,4,1,""],BLUE:[3,4,1,""],LIGHTCYAN_EX:[3,4,1,""],LIGHTWHITE_EX:[3,4,1,""],LIGHTYELLOW_EX:[3,4,1,""],LIGHTGREEN_EX:[3,4,1,""],YELLOW:[3,4,1,""],LIGHTRED_EX:[3,4,1,""],LIGHTBLUE_EX:[3,4,1,""],BLACK:[3,4,1,""],CYAN:[3,4,1,""],MAGENTA:[3,4,1,""],LIGHTMAGENTA_EX:[3,4,1,""],WHITE:[3,4,1,""],RED:[3,4,1,""]},"src.environment":{load_environment:[10,1,1,""],Shell:[10,3,1,""],Environ:[10,3,1,""],SalomeEnviron:[10,3,1,""],FileEnvWriter:[10,3,1,""]},"src.ElementTree.TreeBuilder":{close:[10,2,1,""],end:[10,2,1,""],start:[10,2,1,""],data:[10,2,1,""]},"src.colorama.ansitowin32.AnsiToWin32":{convert_osc:[3,2,1,""],should_wrap:[3,2,1,""],ANSI_OSC_RE:[3,4,1,""],extract_params:[3,2,1,""],convert_ansi:[3,2,1,""],write_and_convert:[3,2,1,""],get_win32_calls:[3,2,1,""],write:[3,2,1,""],write_plain_text:[3,2,1,""],reset_all:[3,2,1,""],ANSI_CSI_RE:[3,4,1,""],call_win32:[3,2,1,""]},src:{fork:[10,0,1,""],product:[10,0,1,""],template:[10,0,1,""],test_module:[10,0,1,""],compilation:[10,0,1,""],xmlManager:[10,0,1,""],system:[10,0,1,""],environment:[10,0,1,""],pyconf:[10,0,1,""],colorama:[3,0,1,""],"__init__":[10,0,1,""],fileEnviron:[10,0,1,""],debug:[10,0,1,""],logger:[10,0,1,""],ElementTree:[10,0,1,""],options:[10,0,1,""],printcolors:[10,0,1,""],architecture:[10,0,1,""]},"src.xmlManager.ReadXmlFile":{get_attrib:[10,2,1,""],get_node_text:[10,2,1,""],getRootAttrib:[10,2,1,""]},"src.ElementTree.XMLTreeBuilder":{feed:[10,2,1,""],close:[10,2,1,""],doctype:[10,2,1,""]},"src.pyconf":{ConfigMerger:[10,3,1,""],deepCopyMapping:[10,1,1,""],ConfigResolutionError:[10,5,1,""],Container:[10,3,1,""],Reference:[10,3,1,""],ConfigReader:[10,3,1,""],Config:[10,3,1,""],makePath:[10,1,1,""],defaultStreamOpener:[10,1,1,""],overwriteMergeResolve:[10,1,1,""],Mapping:[10,3,1,""],defaultMergeResolve:[10,1,1,""],ConfigFormatError:[10,5,1,""],ConfigError:[10,5,1,""],Sequence:[10,3,1,""],ConfigList:[10,3,1,""],ConfigInputStream:[10,3,1,""],Expression:[10,3,1,""],isWord:[10,1,1,""],ConfigOutputStream:[10,3,1,""]},"src.pyconf.Sequence.SeqIter":{next:[10,2,1,""]},"src.options.Options":{print_help:[10,2,1,""],add_option:[10,2,1,""],parse_args:[10,2,1,""]},"src.ElementTree.iterparse":{next:[10,2,1,""]},"src.pyconf.ConfigMerger":{handleMismatch:[10,2,1,""],merge:[10,2,1,""],mergeMapping:[10,2,1,""],overwriteKeys:[10,2,1,""],mergeSequence:[10,2,1,""]},"src.colorama.winterm.WinColor":{BLUE:[3,4,1,""],GREEN:[3,4,1,""],GREY:[3,4,1,""],YELLOW:[3,4,1,""],BLACK:[3,4,1,""],CYAN:[3,4,1,""],MAGENTA:[3,4,1,""],RED:[3,4,1,""]},"src.logger":{timedelta_total_seconds:[10,1,1,""],show_command_log:[10,1,1,""],update_hat_xml:[10,1,1,""],date_to_datetime:[10,1,1,""],list_log_file:[10,1,1,""],Logger:[10,3,1,""]},"src.pyconf.Reference":{findConfig:[10,2,1,""],resolve:[10,2,1,""],addElement:[10,2,1,""]},"src.colorama.ansitowin32":{is_a_tty:[3,1,1,""],AnsiToWin32:[3,3,1,""],StreamWrapper:[3,3,1,""],is_stream_closed:[3,1,1,""]},"src.colorama.ansi.AnsiCursor":{DOWN:[3,2,1,""],FORWARD:[3,2,1,""],UP:[3,2,1,""],BACK:[3,2,1,""],POS:[3,2,1,""]},"src.environment.Environ":{append_value:[10,2,1,""],set:[10,2,1,""],get:[10,2,1,""],prepend:[10,2,1,""],prepend_value:[10,2,1,""],command_value:[10,2,1,""],is_defined:[10,2,1,""],append:[10,2,1,""]},"src.test_module.Test":{run_all_tests:[10,2,1,""],search_known_errors:[10,2,1,""],run_script:[10,2,1,""],generate_launching_commands:[10,2,1,""],prepare_testbase:[10,2,1,""],run_tests:[10,2,1,""],generate_script:[10,2,1,""],run_session_tests:[10,2,1,""],prepare_testbase_from_svn:[10,2,1,""],run_grid_tests:[10,2,1,""],prepare_testbase_from_dir:[10,2,1,""],write_test_margin:[10,2,1,""],run_testbase_tests:[10,2,1,""],get_test_timeout:[10,2,1,""],get_tmp_dir:[10,2,1,""],prepare_testbase_from_git:[10,2,1,""],read_results:[10,2,1,""]},"src.debug":{tofix:[10,1,1,""],saveConfigDbg:[10,1,1,""],indent:[10,1,1,""],getStrConfigStd:[10,1,1,""],getStrConfigDbg:[10,1,1,""],saveConfigStd:[10,1,1,""],pop_debug:[10,1,1,""],OutStream:[10,3,1,""],push_debug:[10,1,1,""],write:[10,1,1,""],InStream:[10,3,1,""],getLocalEnv:[10,1,1,""]},"src.colorama.ansi":{AnsiBack:[3,3,1,""],AnsiStyle:[3,3,1,""],set_title:[3,1,1,""],code_to_chars:[3,1,1,""],clear_screen:[3,1,1,""],AnsiCodes:[3,3,1,""],AnsiCursor:[3,3,1,""],AnsiFore:[3,3,1,""],clear_line:[3,1,1,""]},"src.compilation.Builder":{wmake:[10,2,1,""],do_script_build:[10,2,1,""],do_python_script_build:[10,2,1,""],cmake:[10,2,1,""],configure:[10,2,1,""],prepare:[10,2,1,""],make:[10,2,1,""],put_txt_log_in_appli_log_dir:[10,2,1,""],hack_libtool:[10,2,1,""],build_configure:[10,2,1,""],do_default_build:[10,2,1,""],complete_environment:[10,2,1,""],install:[10,2,1,""],log_command:[10,2,1,""],do_batch_script_build:[10,2,1,""],check:[10,2,1,""],log:[10,2,1,""]}},terms:{represent:10,all:[1,2,3,7,10,11,13,9,15,18],code:[9,0,10,3],node:10,forget:10,xxx_src_dir:10,is_defin:10,global:10,dollar:10,install_dir:9,yellow:3,printcsuccess:10,known:6,scalar:10,printchighlight:10,product_compil:10,get_tmp_filenam:10,append_node_text:10,follow:[9,10,18],mon:10,colorama_text:3,get_nb_proc:10,getlocalenv:10,decid:10,typeerror:10,depend:[8,6,10],system:[5,6,10],"_debug":10,mergesequ:10,parsesequ:10,show:[8,10,17],gencat:[14,12],dict_arg:10,yve:10,supposedli:10,openmpi:10,adot:10,tofix:10,get_products_info:10,"0x35b8810":[],xxx_root_dir:10,suitabl:10,ignorelist:10,sourc:[1,3,6,7,10,11,13],string:10,without:[1,10,11],fals:[10,3],winstyl:3,welkom:10,util:[0,6,10],print:[10,11,17,3],mechan:[9,10],get_attrib:10,word:10,run_test:10,syntax:[10,15,13],strout:10,get_method:1,isdir:10,dim:3,set_full_environ:10,interact:17,contextfileenviron:10,hour:10,harri:10,yyyymmdd_hhmmss_namecmd:10,gui:10,cmd:10,list:[0,7,10,11,12,13,14,15],prefix:[9,10,15],iter:10,correct:10,"try":10,item:10,printcwarn:10,has_salome_hui:10,stderr:10,tostr:10,sajip:10,initialis:[5,10,3],dir:[1,10,11],ansistyl:3,pleas:[9,2],smaller:10,eearch:10,cfg:[9,10,18],my_tag:1,pubid:10,transform:10,sign:10,second:[9,10,18],atitl:10,design:10,list_log_fil:10,download:[1,10],iostream:10,setconsoletextattribut:3,salometool:[0,4,6,7,10,11,12,9,15,18],append:[9,6,10],yacsgen:[10,2],compat:10,index:10,what:[10,13],copyfil:10,salomecontext:10,sub:[10,15],section:[9,1,10,12,15],access:[10,18,3,17],delet:6,version:[9,15,6,2,10],product2:[8,9,1],product1:[8,9,1],parsefactor:10,"new":[1,10,18],defaultstreamopen:10,method:[1,3,8,10,9,18],get_test_timeout:10,optresult:10,xml:[10,18],full:10,deriv:10,iteritem:10,vinai:10,usag:[0,1,2,6,7,8,9,10,11,12,13,14,17],gener:[0,2,3,7,9,10,12,14],set_a_product:10,here:[9,10,15,18],ansicod:3,product_is_autotool:10,ansitowin32:[5,10,3],path:[1,6,8,9,10,11,12,13,14,17],modifi:[9,1,10],sinc:10,valu:[1,3,10,11,12,13,15],machine2:12,handleremovereadonli:10,search:10,lome:0,is_stream_clos:3,launcher_nam:14,env_launch:9,mergemap:10,set_salome_minimal_product_env:10,datetim:10,amount:10,get_product_depend:10,bom:10,load_environ:10,action:10,timedelta_total_second:10,chang:[10,7,18,12],script_nam:10,commonli:10,control:6,show_progress:10,configur:[0,1,6,8,9,10,11,12,13,14,15,17,18],test_sess:10,do_python_script_build:10,extra:10,wai:[8,10,18],"_sre":[10,3],modul:[0,1,2,3,5,8,10,12,14,15],wil:9,prefer:[15,11],getrootattrib:10,activate_mesa_properti:10,filenam:10,printc:10,"boolean":[10,18],product_is_vc:10,home:11,instal:[0,7,8,10,13,15,4],text_or_uri:10,unit:8,getchar:10,do_default_build:10,test_nam:10,parma:10,from:[1,2,3,6,10,11,9,18],tar:[6,4],would:10,memori:[14,12],subtract:10,stdout:[10,3],show_command_log:10,next:10,lightred_ex:3,process:1,product_is_smesh_plugin:10,program:10,call:[14,9,10,18,3],addnamespac:10,handl:[9,10,3],taken:[9,10],tcllibpath:10,isel:10,type:[1,10],lost:10,varsto:[],componon:2,get_nam:10,ool:0,under:[0,10],mismatch:10,award:10,author:10,warn:[8,0,1,10],flag:8,load_cfg_environ:10,particular:10,mydebug:10,lpath:10,check_src:10,hold:14,futur:10,must:[10,18],command_nam:10,none:[10,3],join:9,get_property_in_product_cfg:10,restor:[10,13],abool:10,prepar:[0,1,10,7,18],work:[1,6,11,15,10],subel:10,dev:[1,10],product_is_cmak:10,remain:[17,4],archiv:[1,6,10],obvious:10,can:[0,1,10,12,9,15,18],print_info:10,sommeil:10,nb_line:10,configresolutionerror:10,root:[10,18],could:[9,10,4,13],def:[9,10,18],appropri:10,overrid:[10,12],overwritten:10,write_back:10,want:[9,10,13,18],stream:[10,3],give:[15,10,12,18],add_warn:10,prepare_testbas:10,hxx2salom:2,templat:[5,10],path_to_yacsgen:2,smartcopi:10,bienvenu:10,tag:[1,10],explor:11,search_known_error:10,magenta:3,keep:10,occur:10,cleancolor:10,delai:10,end:[9,10,3],directori:[1,4,6,7,8,9,10,11,12,13,14,15,17,18],secur:1,programmat:9,anoth:[10,15],add_simple_nod:10,env_script:9,gettmpdir:10,divis:10,how:[9,1,10,15],remove_item_from_list:10,"__init__":10,env:9,deepcopy_list:10,token_valu:10,config:[0,1,7,10,11,15,18],parsemap:10,virtual_app:12,updat:10,processinginstruct:10,product:[0,1,2,5,6,7,8,9,10,11,13,14,15,18],get_log_path:10,configlist:10,timedelta:10,max:10,clone:1,after:[8,10,4],defaultmergeresolv:10,befor:[8,10],catalog:[14,12],date:[10,15],multipl:10,mesa:[14,10,12],getbypath:10,data:[10,11,18],get_python_vers:10,wmake:10,test_modul:[5,10],circumst:10,"short":10,four:9,get_us:10,ensure_path_exist:10,filepath:10,favorit:11,correspond:[9,1,10,17],cvspass:1,element:10,map2:10,inform:[1,6,11,15,10],wincolor:3,green:3,block:[],allow:[0,2,7,8,10,11],prod_dir:10,callabl:10,set_attr:3,generate_launching_command:10,order:[1,10,15,18],configoutputstream:10,salom:[0,2,6,7,8,9,10,11,12,13,14,15,4],tty:3,merge_dict:10,softwar:1,lanch:10,str_num:10,hack_libtool:10,seqit:10,through:[14,9,12,17],same:10,cyan:3,hierarchi:10,afil:10,pretti:10,dynam:15,paramet:[10,11,15,18],raw:10,write:[10,18,3],style:[10,3],cli:[17,7],clean_instal:8,amethodtodebug:10,fix:10,test_base_nam:10,platform:[9,3],window:[9,10,3],pend:13,find_node_by_attrib:10,requir:[18,9,10,2,3],strin:10,wrap_stream:3,main:8,fin:10,alter:1,add_echo:10,cvs_info:1,them:[1,3],within:9,"return":[9,10,18],thei:[9,1,11,13],python:[0,9,10,4,14,15,18],obtain:10,"export":1,dai:10,initi:10,with_install_dir:10,more:[10,7],configformaterror:10,instead:10,nor:3,introduct:18,choic:11,term:10,document:[0,15,2,18],init:[10,3],name:[1,6,7,9,10,11,12,13,14,15,18],edit:[1,11],getiter:10,parsescalar:10,makepath:10,yyyymmdd_hhmmss:10,authent:1,win32:[5,10,3],merge:10,token:10,inmap:10,mode:[1,3,7,10,11,13,9,17],each:[14,1,10,12,15],debug:[1,5,7,10,11,9],found:10,unicod:10,clean_build_aft:8,splashscreen:14,checkout:[1,10],compil:[0,1,2,5,7,8,10,9,17],seq1:10,git:[1,6,10],prepend_valu:10,stop_first_fail:8,replac:[10,12],read_config_from_a_fil:10,hard:10,continu:10,procedur:10,handlemismatch:10,wrap:3,show_patch:11,workdir:[6,7,10,11,12,14,15,18],expect:10,satexcept:10,year:10,distrib:10,resourc:[14,12],extract:10,event:10,check_config_exist:10,out:10,variabl:[9,10,2,18],shown:[8,10],"_ld_library_path":9,get_node_text:10,pyconf:[1,5,8,10,11,9,15,18],goe:10,optionali:10,dst:10,salomeenviron:10,findtext:10,profil:[14,10],geom:8,log_dir:17,rel:[6,10],reader:10,configread:10,ref:10,factori:10,red:[10,3],file_nam:10,multilin:10,model:18,earlier:10,get_salome_vers:10,proxi:3,run_all_test:10,advanc:10,update_hat_xml:10,manipul:[10,11],updatehatxml:10,env_info:10,command_opt:7,printchead:10,quick:0,bright_background:3,base:[1,10,15,3],pendant:10,dictionari:[10,15],usual:[2,6,7,13,15,4],put:10,longnam:10,earliest:10,copylink:10,bash:[9,1,10],care:13,thrown:10,additional_dir:10,indent:10,"_blank":10,launch:[9,10],argument:[10,18],zerodivideerror:10,ask:10,david:10,filter:13,thing:18,"int":[10,17],rais:[10,7],unabl:10,temporari:10,screenenviron:10,file_path:10,assign:10,first:[9,1,10,18],feed:10,"0x3620700":[],rang:10,read_result:10,suffix:10,directli:[9,17,4],kernel:[11,7],carri:10,onc:1,number:[8,14,10,12,17],"0x24c9d70":10,echo:10,get_tmp_dir:10,instruct:[10,15],alreadi:[6,18],done:[9,7],messag:[10,18],visualis:9,miss:[8,12],underscor:[9,10],size:10,date_to_datetim:10,differ:9,"long":[10,13],ansi_osc_r:3,printclabel:10,script:[0,8,9,10,11,14,15,4],overwritekei:10,arch:6,top:10,sometim:13,construct:[0,10,16],archive_extract:10,setstream:10,termin:[8,10,18,3,17],white:3,put_txt_log_in_appli_log_dir:10,get_launcher_nam:10,"final":[1,10,11],store:[1,8,10,11,15,17],myspecificnam:6,my_appli_directori:[],shell:[9,10],consol:10,option:[1,2,3,5,6,7,8,9,10,11,12,13,14,15,17,18],root_nod:10,product_is_sampl:10,tool:0,shallow:10,product_has_script:10,print_color_map:10,specifi:[1,2,9,10,12,14],micro_command:10,jane:10,gitconfig:1,pars:[10,18],printcerror:10,git_info:1,exactli:10,grep:11,target:[9,10,12],whenev:10,provid:[9,10,18],remov:[8,1,10,13],eleg:10,nb_proc:[8,10],zero:10,structur:15,charact:[10,3],project:[9,11],prepare_testbase_from_svn:10,info:[1,10,11],includ:[9,6,15,10],str:10,set_product:10,posit:3,findconfig:10,minut:10,other:[9,15,6,10,18],make_opt:10,grei:3,browser:[10,11,17,15],do_script_build:10,comput:[6,2,10],additional_env:10,runner:18,check_config_has_profil:10,pass:[10,15,18],ani:[1,10,11,17,3],elem:10,silent_sysstd:10,config_has_appl:10,himself:9,openggl:[14,12],have:[1,2,10,12,13,14],tabl:10,need:[1,10,2,3,12],seen:10,notimplementederror:10,turn:10,pythonpath_:9,erase_screen:3,implement:[9,10,3],issu:3,build_configur:10,get_file_environ:10,is_window:10,lib:9,cli_:18,latter:10,set_consol:3,out_dir:10,force_patch:1,note:[0,1,2,6,8,9,10,11,12,14,15,16,18],also:[9,1,10,15,18],preced:10,filein:10,indic:10,environ:[0,2,5,10,9,15],lightmagenta_ex:3,noth:[6,10],blue:3,begin:10,winterm:[5,10,3],unless:[1,3],distribut:[10,2,12],clash:10,testbase_dir:10,usernam:10,end_writ:10,previou:10,compress:6,deleg:3,successfulli:10,streamorfil:10,has_timed_out:10,most:[9,10,18],param_nam:10,colorama:[5,10,3],all_in_termin:10,phase:10,logfilepath:10,paramstr:3,"class":[10,18,3],charg:14,"_build":9,put_initial_xml_field:10,"0x2379de8":10,product_is_cpp:10,exc:10,ansi_csi_r:3,alphanumer:10,full_launched_command:10,request:3,drive:10,push_debug:10,doe:[9,1,10],tklibpath:10,product_cfg:10,set_salome_generic_product_env:10,declar:1,ruud:10,cursor_adjust:3,determin:10,sources_without_dev:13,enclos:10,shortnam:10,unchang:10,notion:10,dot:10,forbuild:10,getstrconfigstd:10,use_mesa:[14,12],set:[0,9,10,12,13,14,15,18],set_cursor_posit:3,"16be":10,last_termin:17,batfileenviron:10,text:[10,7,3],autoreset:3,convert_osc:3,dbg:10,name_nod:10,bring:[1,2],bright:3,optiontyp:10,input_list:10,"0x34bc7d0":[],dirpath:10,identifi:10,token_typ:10,find:[10,11,4],help:[10,7,18],redirect:10,current:[15,10,11,7,18],onli:[1,2,7,8,9,10,11,12,13,14,17],explicitli:10,locat:10,execut:[8,1,10,7],copyright:10,menu:17,explain:9,complete_environ:10,releas:[0,16],configut:12,pluma:15,should:[9,10,2],reinit:[10,3],run_grid_test:10,far:10,extract_param:3,logdir:10,factor:10,virtual:[10,12],local:11,obj1:10,reset:3,obj2:10,append_node_attrib:10,a_b_c_:10,get:[1,7,10,11,15,18],lightwhite_ex:3,convert:3,express:[10,11],stop:8,account:9,configmerg:10,nativ:[9,10],cannot:10,yourspecificnam:6,ssh:[14,1,12],write_plain_text:3,destnam:10,report:10,parsemappingbodi:10,set_python_libdir:10,path_to_catalog:12,product_is_salom:10,log_file_nam:10,env_build:9,bat:[9,10],"16le":10,non:3,specif:[2,6,7,9,10,12,13,14,15],instanti:10,multi:10,yield:10,patch:[1,10,11],runappli:12,stuff:[14,10],bashfileenviron:10,common:10,contain:[10,15,18],avari:10,script_path:10,llvm:[14,12],where:[8,6,11,12,10],instream:10,product_has_logo:10,black:3,wiki:3,conform:2,python_config:10,saveconfigdbg:10,seq:10,sep:[9,10],listtest:10,xc2:10,change_to_launch:10,namespac:10,see:[15,10,7,3],"9abc":10,remor:2,arg:[10,18,3],fail:[8,10],close:10,stack:7,arglist:10,becaus:10,servic:18,isword:10,concern:1,statu:10,detect:10,parent:10,co7:6,deinit:3,pattern:10,wikipedia:3,label:[10,11],write_cfgforpy_fil:10,urlopen:10,written:18,zelaunch:14,between:[10,18],progress:10,parsevalu:10,"0x3ff4610":3,with_vc:6,attribut:[10,3],attibut:10,verifi:[1,10],kei:[9,1,10],node_nam:10,exampl:[0,1,6,7,8,10,11,13,9,18],on_stderr:3,popul:10,extens:[10,18],job:8,parameter_path:11,french:18,printcolor:[5,10],complementari:9,distinguish:9,writevalu:10,come:11,problem:[14,10,12],regular:10,addit:[8,10,15],verbos:[10,7,18],both:[9,10,2],mond:18,last:[9,10,17],delimit:10,rtype:10,list_of_product:2,equal:8,cfgforpi:10,build_conf_opt:10,etc:[0,10,15],no_label:11,instanc:[10,18,3],tout:18,context:[10,7],pdf:11,login:1,sre_pattern:[10,3],ld_library_path:9,comment:[10,15],find_file_in_lpath:10,getroot:10,lightblue_ex:3,test_grid:10,point:[10,18],tgz:[6,4],git_extract:10,chmod:10,map1:10,svn_info:1,header:10,streamopen:10,product_is_gener:10,add_link:10,shortcut:10,print_color_rang:10,ioerror:10,get_product_sect:10,mistak:1,configure_opt:10,assum:10,src_root:10,cmake_opt:8,product_has_env_script:10,set_env_build:9,light:3,check_sourc:10,creat:[0,1,6,9,10,12,13,14,15],deep:10,machine1:12,classic:10,due:10,empti:10,otherwis:[1,10],compon:[10,2,12],viewer:11,machine3:12,basic:18,buf:10,product_is_mpi:10,cwd:10,lightgreen_ex:3,show_warn:10,salome_session_serv:10,parser:[10,18],launcherfileenviron:10,presenc:10,imag:1,xxx:[15,13],remark:[1,2,12],dict:10,clear_lin:3,findal:10,dixt:10,func:10,els:[10,18],print_valu:10,testbase_bas:10,bonjour:18,logger:[5,10,18],those:2,prereq_dir:9,"case":10,get_cfg_param:10,set_titl:3,ident:10,lapack_root_dir:9,packag:[0,3,5,6,10,4],launcher:[14,0,10,12,9],intal:6,set_env:[9,10],properti:[9,10,2,13],pop_debug:10,qname:10,aim:10,defin:[2,8,10,11,13,9,15,18],smart:10,behavior:18,error:10,fun:11,exist:[1,6,10,7],gettoken:10,exot:10,fileenviron:[5,10],subsect:9,element_factori:10,layer:2,only_numb:10,add_com:10,my_application_nam:12,lightcyan_ex:3,readi:1,affect:3,trust_root_dir:9,site:10,generate_script:10,activ:[1,10],"default":[1,6,7,8,9,10,11,12,14,17,18],kwarg:3,default_valu:10,eras:17,myapp:[],product_nam:10,get_product_config:10,ascii:10,sever:[9,15],result:10,complet:[8,1,15,11],xa4:10,develop:[0,1,10,11,13,9,18],welcom:10,open:10,minim:10,perform:[0,1],make:[8,10],belong:10,notshowncommand:10,delaiapp:10,write_env_fil:10,binari:6,tutori:10,from_what:10,xmllogfil:10,batch_salom:10,pprty:10,sat:[0,1,2,4,6,7,8,9,10,11,12,13,14,15,17,18],setpath:10,check_config_has_appl:10,conflict:10,yacsgen_root_dir:2,exhaust:[15,7],"__save__":10,http:[10,3],svn_extract:10,closest:10,getstrconfigdbg:10,oper:[0,10,11],someon:9,salome_xx:[6,13,7,4],remot:[6,10],mycommand:18,write_test_margin:10,user:[6,7,10,11,4,9,15,17,18],applic:[0,1,2,8,9,10,11,12,13,14,15,17,18],seq2:10,readlink:10,set_cpp_env:10,preset:10,built:10,subpackag:[5,10],lproduct:10,redefin:10,code_block:[],older:17,com:10,builder:10,cpp:[10,2],well:10,for_packag:10,given:[14,9,10,12,3],erase_lin:3,person:11,append_valu:10,client:10,launch_command:10,ansicursor:3,thi:[0,1,2,3,6,8,9,10,11,12,14,15,18],convert_ansi:3,everyth:8,"0x245afd0":10,self:10,left:9,load:[10,15],with_children:8,protocol:[10,12],entri:10,just:[8,10],object:[10,15,3],template_fil:10,deepcopymap:10,semant:10,reserv:10,detail:10,insid:1,gdb:9,via:10,distant:12,parsesuffix:10,world:18,firefox:[15,17],passphras:1,prepend:[9,10],opt_nb_proc:10,yet:7,lightyellow_ex:3,screenonli:10,web:[15,11,17],like:[3,8,10,11,12,14,15],run_testbase_test:10,smesh:10,removenamespac:10,addmap:10,lapack:9,tmp_working_dir:10,number_of_proc:10,prod_info:10,had:10,outstream:10,param:[10,3],streamwrapp:3,etre:10,add:[8,0,10,18],detar:4,astream:10,nfirst:10,appli:[1,10,11,2],input:10,get_attr:3,save:9,hat:10,match:10,build:[7,8,10,13,9,15],bin:9,show_in_editor:10,which:[2,3,10,9,15,18],fileenvwrit:10,format:[9,10,15],read:10,big:8,write_and_convert:3,get_install_dir:10,howto:18,blogmatrix:10,regard:10,copydir:10,get_win32_cal:3,enable_simple_env_script:10,were:10,grid:10,backtick:10,dir_info:1,part:[14,9,10,12],password:1,recurs:[10,11],color:[10,3],apart:3,application_nam:12,xmlmanag:[5,10],xmltreebuild:10,med:8,ivar:10,write_tre:10,success:[8,10],testbase_tag:10,special_path_separ:10,get_distribut:10,html:10,dove:10,showinfo:10,api:10,either:[9,10],readxmlfil:10,parserefer:10,plugin:[8,10],output:[10,3],page:9,two:[9,10],yyyi:10,run_session_test:10,iterpars:10,right:[9,10],old:10,who:2,overwritemergeresolv:10,copi:[14,10,11,12,7],creation:6,simpl:[10,7,18],back:3,resolv:10,isfil:10,intern:10,adequ:10,sampl:[10,7],respect:9,ansifor:3,indirect:10,server:[1,10],bigger:10,killsalom:10,librari:10,replace_in_fil:10,separ:10,"__setattr__":10,txt:10,trace:7,except:[1,10,7],"function":[10,18,3],test_config:10,normal:[10,3],definit:10,thank:10,subclass:10,testbas:10,when:[1,10,12,9,15,18],substitut:10,select:6,product_info:10,add_lin:10,duplic:8,product_has_salome_gui:10,islink:10,refer:[10,2,15],machin:[14,6,2,10,12],reflect:10,lightblack_ex:3,print_help:10,run:[9,0,10,15,18],run_script:10,tree:10,my_application_directori:12,reset_al:3,xmlroot:10,symlink:10,"_launch":9,step:10,get_base_path:10,ansiback:3,repositori:[1,10],log_command:10,code_to_char:3,don:2,prepare_testbase_from_git:10,describ:10,session:10,src:[5,10,18,3],about:[10,15],actual:[10,4,3],cfg_env:10,get_posit:3,column:10,writetostream:10,parsekeyvaluepair:10,manag:[1,10,11],total_second:10,map:10,rootnam:10,winapi_test:3,act:[10,3],commit:13,attrib:10,mytempl:10,without_properti:6,produc:10,corba:2,paravi:[14,12],subset:6,own:10,absolut:6,logo:[14,10],pythonpath:9,product_is_dev:10,"float":10,encod:10,www:10,automat:[9,11],subst_dic:10,down:3,pair:10,make_flag:8,parse_d:10,run_env_script:10,product_is_fix:10,strip:3,command_valu:10,"import":[9,10,18],batch:10,soon:8,your:[9,1,10,7,18],transpar:3,merg:10,set_native_env:[9,10],processor:[14,10,12],get_base_install_dir:10,log:[8,0,10,17,18],suffici:9,support:10,get_distrib_vers:10,stylesheet:10,overwrit:10,custom:18,avail:[11,13,7],start:[0,3,8,10,12,14],again:10,been:[10,3],interfac:[10,7],editor:[10,11,15],suit:0,"var":[9,10,15,18],printcinfo:10,parse_arg:[10,18],run_simple_env_script:10,usr:9,fork:[5,10],autotool:[8,10],doctyp:10,agent:1,ansi_escape_cod:3,form:10,forc:[1,6,10],tupl:10,fmt:10,prerequisit:[9,0,6,15,7],fore:3,forward:[14,12,3],pwd:10,commentari:10,testbase_nam:10,delta:10,renam:10,line:[10,11,7],level:[10,7,18],"true":[10,3],dump:10,iterkei:10,concaten:10,utf:[9,10],attr:[10,3],consist:10,possibl:[9,1,10,18],new_nam:11,saveconfigstd:10,take:[10,13],displai:[8,10,11,17,18],previous:13,archive_info:1,below:9,get_product_compon:10,ensur:10,mai:1,do_batch_script_build:10,product_is_debug:10,highlight:10,readlin:10,gettmpdirdefault:10,similar:10,unconditionali:[10,7],later:6,evalu:10,product_is_n:10,pv_plugin_path:10,retriev:10,dure:1,flush:10,build_sourc:8,command:[0,1,2,3,4,6,7,8,9,10,11,12,13,14,15,17,18],kwd:3,repres:10,"char":10,operand:10,fromstr:10,"0x42d2cf0":3,set_application_env:10,file:[0,1,6,8,9,10,11,12,14,15,17,18],our:3,some:[1,6,8,9,10,11,12,13,14,15,17,18],salome_xx_:6,show_desktop:10,cvs_extract:10,check:[8,9,10],link:[1,10],bracket:10,tab:10,should_wrap:3,cmake:[8,10],know:[1,10],with_commerci:10,is_a_tti:3,titl:[10,3],renint:10,elementtre:[5,10],invalid:10,configinputstream:10,field:10,finish:10,valid:10,bool:10,parseterm:10,branch:1,suppress:13,writabl:10,you:[0,1,9,10,12,13,14,18],product_has_patch:10,clean_al:[8,7],test:[8,0,10],architectur:[5,6,15,10],correl:10,treebuild:10,configerror:10,resolut:10,command_r:10,clean:[8,0,10,17,13],yyi:15,stringio:10,sequenc:[10,3],org:3,urllib2:10,ansi:[5,10,3],prepare_testbase_from_dir:10,queri:[14,12],embed:6,eval:10,set_env_launch:9,helpstr:10,write_report:10,call_win32:3,salome_modul:10,svn:[1,6,10],addel:10,with_fath:8,algorithm:18,"_appli":12,add_opt:[10,18],descript:[1,2,6,8,9,10,11,12,13,14,15,17,18],compil_script:8,hello:18,is_salome_modul:[9,13],check_instal:10,clear_screen:3,ignor:[10,2],fact:18,potenti:10,time:[9,1,10,15,13],push:1,generic_opt:7,avoid:1,myoption:18},objtypes:{"0":"py:module","1":"py:function","2":"py:method","3":"py:class","4":"py:attribute","5":"py:exception"},titles:["Salome Tools","Command prepare","Command generate","colorama Package","Installation","src","Command package","Usage of SAlomeTools","Command compile","Command environ","src Package","Command config","Command application","Command clean","Command launcher","Configuration","Release notes","Command log","Add a user custom command"],objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","method","Python method"],"3":["py","class","Python class"],"4":["py","attribute","Python attribute"],"5":["py","exception","Python exception"]},filenames:["index","commands/prepare","commands/generate","commands/apidoc/src.colorama","installation_of_sat","commands/apidoc/modules","commands/package","usage_of_sat","commands/compile","commands/environ","commands/apidoc/src","commands/config","commands/application","commands/clean","commands/launcher","configuration","release_notes/release_notes_5.0.0","commands/log","write_command"]}) \ No newline at end of file diff --git a/doc/build/html/usage_of_sat.html b/doc/build/html/usage_of_sat.html new file mode 100644 index 0000000..a2e902a --- /dev/null +++ b/doc/build/html/usage_of_sat.html @@ -0,0 +1,202 @@ + + + + + + + + + Usage of SAlomeTools — salomeTools 5.0.0dev documentation + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +
        +
        + +
        +

        Usage of SAlomeTools¶

        +
        +

        Usage¶

        +

        sat usage is a Command Line Interface (CLI).

        +
        sat [generic_options] [command] [product] [command_options]
+
        +
        +
        +

        Options of sat¶

        +

        Useful not exhaustive generic options of sat CLI.

        +
        +

        --help or -h¶

        +

        Get help as simple text.

        +
        sat --help          # get the list of existing commands
+sat --help compile  # get the help on a specific command 'compile'
+
        +
        +
        +
        +

        --debug or -g¶

        +

        Execution in debug mode allows to see more trace and stack if an exception is raised.

        +
        +
        +

        --verbose or -v¶

        +

        Change verbosity level (default is 3).

        +
        # for product 'SALOME_xx' for example
+# execute compile command in debug mode with trace level 4
+sat -g -v 4 compile SALOME_xx
+
        +
        +
        +
        +
        +
        +

        Build a SALOME product¶

        +
        +

        Get the list of available products¶

        +

        To get the list of the current available products in your context:

        +
        sat config --list
+
        +
        +
        +
        +

        Prepare sources of a product¶

        +

        To prepare (get) all the sources of a product (SALOME_xx for example):

        +
        sat prepare SALOME_xx
+
        +
        +
        +
        The sources are usually copied in directories
        +
        $USER.workDir + SALOME_xx... + SOURCES + $PRODUCT.name
        +
        +
        +
        +

        Compile SALOME¶

        +

        To compile products:

        +
        # compile all prerequisites/products
+sat compile SALOME_xx
+
+# compile only 2 products (KERNEL and SAMPLES), if not done yet
+sat compile SALOME_xx --products KERNEL,SAMPLES
+
+# compile only 2 products, unconditionaly
+sat compile SALOME_xx ---products SAMPLES --clean_all
+
        +
        +
        +
        The products are usually build in the directories
        +
        $USER.workDir + SALOME_xx... + BUILD + $PRODUCT.name
        +

        +
        The products are usually installed in the directories
        +
        $USER.workDir + SALOME_xx... + INSTALL + $PRODUCT.name
        +
        +
        +
        +
        + + +
        +
        +
        +
        +
        + +

        Table Of Contents

        + +
        +

        Related Topics

        + +
        +

        This Page

        + + + +
        +
        +
        +
        +
        + ©2018, CEA. + + | + Powered by Sphinx 1.1.3 + & Alabaster + + | + Page source +
        + + + + + + \ No newline at end of file diff --git a/doc/build/html/write_command.html b/doc/build/html/write_command.html new file mode 100644 index 0000000..d5f0c6e --- /dev/null +++ b/doc/build/html/write_command.html @@ -0,0 +1,247 @@ + + + + + + + + + Add a user custom command — salomeTools 5.0.0dev documentation + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +
        +
        + +
        +

        Add a user custom command¶

        +
        +

        Introduction¶

        +
        +

        Note

        +

        This documentation is for Python developers.

        +
        +

        The salomeTools product provides a simple way to develop commands. +The first thing to do is to add a file with .py extension in the commands directory of salomeTools.

        +

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

        +
        +
        +

        Basic requirements¶

        +

        By adding a file mycommand.py in the commands directory, salomeTools will define a new command named mycommand.

        +

        In mycommand.py, there must be the following method:

        +
        def run(args, runner, logger):
+    # your algorithm ...
+    pass
+
        +
        +

        In fact, at this point, the command will already be functional. +But there are some useful services provided by salomeTools :

        +
          +
        • You can give some options to your command:
          • +
        +
        import src
+
+# Define all possible option for mycommand command :  'sat mycommand <options>'
+parser = src.options.Options()
+parser.add_option('m', 'myoption', \
+                  'boolean', 'myoption', \
+                  'My option changes the behavior of my command.')
+
+def run(args, runner, logger):
+    # Parse the options
+    (options, args) = parser.parse_args(args)
+    # algorithm
+
        +
        +
          +
        • You can add a description method that will display a message when the user will call the help:
          • +
        +
         import src
+
+ # Define all possible option for mycommand command : 'sat mycommand <options>'
+ parser = src.options.Options()
+ parser.add_option('m', 'myoption', \
+                   'boolean', 'myoption', \
+                   'My option changes the behavior of my command.')
+
+ def description():
+     return _("The help of mycommand.")
+
+ def run(args, runner, logger):
+     # Parse the options
+     (options, args) = parser.parse_args(args)
+     # algorithm
+
        +
        +
        +
        +

        HowTo access salomeTools config and other commands¶

        +

        The runner variable is an python instance of Sat class. +It gives access to runner.cfg which is the data model defined from all +configuration pyconf files of salomeTools +For example, runner.cfg.APPLICATION.workdir +contains the root directory of the current application.

        +

        The runner variable gives also access to other commands of salomeTools:

        +
        # as CLI_ 'sat prepare ...'
+runner.prepare(runner.cfg.VARS.application)
+
        +
        +
        +
        +

        HowTo logger¶

        +

        The logger variable is an instance of the Logger class. +It gives access to the write method.

        +

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

        +
        logger.write("My message", 3) # 3 as default
+
        +
        +

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

        +
        +
        +

        HELLO example¶

        +

        Here is a hello command, file commands/hello.py:

        +
        import src
+
+"""
+hello.py
+Define all possible options for hello command:
+sat hello <options>
+"""
+
+parser = src.options.Options()
+parser.add_option('f', 'french', 'boolean', 'french', "french set hello message in french.")
+
+def description():
+    return _("The help of hello.")
+
+def run(args, runner, logger):
+    # Parse the options
+    (options, args) = parser.parse_args(args)
+    # algorithm
+    if not options.french:
+        logger.write('HELLO! WORLD!\n')
+    else:
+        logger.write('Bonjour tout le monde!\n')
+
        +
        +

        A first call of hello:

        +
        # Get the help of hello:
+./sat --help hello
+
+# To get bonjour
+./sat hello --french
+Bonjour tout le monde!
+
+# To get hello
+./sat hello
+HELLO! WORLD!
+
+# To get the log
+./sat log
+
        +
        +
        +
        + + +
        +
        +
        +
        +
        + +

        Table Of Contents

        + +
        +

        Related Topics

        + +
        +

        This Page

        + + + +
        +
        +
        +
        +
        + ©2018, CEA. + + | + Powered by Sphinx 1.1.3 + & Alabaster + + | + Page source +
        + + + + + + \ No newline at end of file diff --git a/doc/build/latex/Makefile b/doc/build/latex/Makefile new file mode 100644 index 0000000..76e7c3e --- /dev/null +++ b/doc/build/latex/Makefile @@ -0,0 +1,66 @@ +# Makefile for Sphinx LaTeX output + +ALLDOCS = $(basename $(wildcard *.tex)) +ALLPDF = $(addsuffix .pdf,$(ALLDOCS)) +ALLDVI = $(addsuffix .dvi,$(ALLDOCS)) + +# Prefix for archive names +ARCHIVEPRREFIX = +# Additional LaTeX options +LATEXOPTS = + +all: $(ALLPDF) +all-pdf: $(ALLPDF) +all-dvi: $(ALLDVI) +all-ps: all-dvi + for f in *.dvi; do dvips $$f; done + +all-pdf-ja: + for f in *.pdf *.png *.gif *.jpg *.jpeg; do ebb $$f; done + for f in *.tex; do platex -kanji=utf8 $(LATEXOPTS) $$f; done + for f in *.tex; do platex -kanji=utf8 $(LATEXOPTS) $$f; done + for f in *.tex; do platex -kanji=utf8 $(LATEXOPTS) $$f; done + for f in *.idx; do mendex -U -f -d "`basename $$f .idx`.dic" -s python.ist $$f; done + for f in *.tex; do platex -kanji=utf8 $(LATEXOPTS) $$f; done + for f in *.tex; do platex -kanji=utf8 $(LATEXOPTS) $$f; done + for f in *.dvi; do dvipdfmx $$f; done + +zip: all-$(FMT) + mkdir $(ARCHIVEPREFIX)docs-$(FMT) + cp $(ALLPDF) $(ARCHIVEPREFIX)docs-$(FMT) + zip -q -r -9 $(ARCHIVEPREFIX)docs-$(FMT).zip $(ARCHIVEPREFIX)docs-$(FMT) + rm -r $(ARCHIVEPREFIX)docs-$(FMT) + +tar: all-$(FMT) + mkdir $(ARCHIVEPREFIX)docs-$(FMT) + cp $(ALLPDF) $(ARCHIVEPREFIX)docs-$(FMT) + tar cf $(ARCHIVEPREFIX)docs-$(FMT).tar $(ARCHIVEPREFIX)docs-$(FMT) + rm -r $(ARCHIVEPREFIX)docs-$(FMT) + +bz2: tar + bzip2 -9 -k $(ARCHIVEPREFIX)docs-$(FMT).tar + +# The number of LaTeX runs is quite conservative, but I don't expect it +# to get run often, so the little extra time won't hurt. +%.dvi: %.tex + latex $(LATEXOPTS) '$<' + latex $(LATEXOPTS) '$<' + latex $(LATEXOPTS) '$<' + -makeindex -s python.ist '$(basename $<).idx' + latex $(LATEXOPTS) '$<' + latex $(LATEXOPTS) '$<' + +%.pdf: %.tex + pdflatex $(LATEXOPTS) '$<' + pdflatex $(LATEXOPTS) '$<' + pdflatex $(LATEXOPTS) '$<' + -makeindex -s python.ist '$(basename $<).idx' + pdflatex $(LATEXOPTS) '$<' + pdflatex $(LATEXOPTS) '$<' + +clean: + rm -f *.dvi *.log *.ind *.aux *.toc *.syn *.idx *.out *.ilg *.pla + +.PHONY: all all-pdf all-dvi all-ps clean +.PHONY: all-pdf-ja + diff --git a/doc/build/latex/fncychap.sty b/doc/build/latex/fncychap.sty new file mode 100644 index 0000000..9a56c04 --- /dev/null +++ b/doc/build/latex/fncychap.sty @@ -0,0 +1,683 @@ +%%% Copyright Ulf A. Lindgren +%%% +%%% Note Premission is granted to modify this file under +%%% the condition that it is saved using another +%%% file and package name. +%%% +%%% Revision 1.1 (1997) +%%% +%%% Jan. 8th Modified package name base date option +%%% Jan. 22th Modified FmN and FmTi for error in book.cls +%%% \MakeUppercase{#}->{\MakeUppercase#} +%%% Apr. 6th Modified Lenny option to prevent undesired +%%% skip of line. +%%% Nov. 8th Fixed \@chapapp for AMS +%%% +%%% Revision 1.2 (1998) +%%% +%%% Feb. 11th Fixed appendix problem related to Bjarne +%%% Aug. 11th Fixed problem related to 11pt and 12pt +%%% suggested by Tomas Lundberg. THANKS! +%%% +%%% Revision 1.3 (2004) +%%% Sep. 20th problem with frontmatter, mainmatter and +%%% backmatter, pointed out by Lapo Mori +%%% +%%% Revision 1.31 (2004) +%%% Sep. 21th problem with the Rejne definition streched text +%%% caused ugly gaps in the vrule aligned with the title +%%% text. Kindly pointed out to me by Hendri Adriaens +%%% +%%% Revision 1.32 (2005) +%%% Jun. 23th compatibility problem with the KOMA class 'scrbook.cls' +%%% a remedy is a redefinition of '\@schapter' in +%%% line with that used in KOMA. The problem was pointed +%%% out to me by Mikkel Holm Olsen +%%% +%%% Revision 1.33 (2005) +%%% Aug. 9th misspelled ``TWELV'' corrected, the error was pointed +%%% out to me by George Pearson +%%% +%%% Revision 1.34 (2007) +%%% Added an alternative to Lenny provided by Peter +%%% Osborne (2005-11-28) +%%% Corrected front, main and back matter, based on input +%%% from Bas van Gils (2006-04-24) +%%% Jul. 30th Added Bjornstrup option provided by Jean-Marc +%%% Francois (2007-01-05). +%%% Reverted to \MakeUppercase{#} see rev 1.1, solved +%%% problem with MakeUppercase and MakeLowercase pointed +%%% out by Marco Feuerstein (2007-06-06) + + +%%% Last modified Jul. 2007 + +\NeedsTeXFormat{LaTeX2e}[1995/12/01] +\ProvidesPackage{fncychap} + [2007/07/30 v1.34 + LaTeX package (Revised chapters)] + +%%%% For conditional inclusion of color +\newif\ifusecolor +\usecolorfalse + + + +%%%% DEFINITION OF Chapapp variables +\newcommand{\CNV}{\huge\bfseries} +\newcommand{\ChNameVar}[1]{\renewcommand{\CNV}{#1}} + + +%%%% DEFINITION OF TheChapter variables +\newcommand{\CNoV}{\huge\bfseries} +\newcommand{\ChNumVar}[1]{\renewcommand{\CNoV}{#1}} + +\newif\ifUCN +\UCNfalse +\newif\ifLCN +\LCNfalse +\def\ChNameLowerCase{\LCNtrue\UCNfalse} +\def\ChNameUpperCase{\UCNtrue\LCNfalse} +\def\ChNameAsIs{\UCNfalse\LCNfalse} + +%%%%% Fix for AMSBook 971008 + +\@ifundefined{@chapapp}{\let\@chapapp\chaptername}{} + + +%%%%% Fix for Bjarne and appendix 980211 + +\newif\ifinapp +\inappfalse +\renewcommand\appendix{\par + \setcounter{chapter}{0}% + \setcounter{section}{0}% + \inapptrue% + \renewcommand\@chapapp{\appendixname}% + \renewcommand\thechapter{\@Alph\c@chapter}} + +%%%%% Fix for frontmatter, mainmatter, and backmatter 040920 + +\@ifundefined{@mainmatter}{\newif\if@mainmatter \@mainmattertrue}{} + +%%%%% + + + +\newcommand{\FmN}[1]{% +\ifUCN + {\MakeUppercase{#1}}\LCNfalse +\else + \ifLCN + {\MakeLowercase{#1}}\UCNfalse + \else #1 + \fi +\fi} + + +%%%% DEFINITION OF Title variables +\newcommand{\CTV}{\Huge\bfseries} +\newcommand{\ChTitleVar}[1]{\renewcommand{\CTV}{#1}} + +%%%% DEFINITION OF the basic rule width +\newlength{\RW} +\setlength{\RW}{1pt} +\newcommand{\ChRuleWidth}[1]{\setlength{\RW}{#1}} + +\newif\ifUCT +\UCTfalse +\newif\ifLCT +\LCTfalse +\def\ChTitleLowerCase{\LCTtrue\UCTfalse} +\def\ChTitleUpperCase{\UCTtrue\LCTfalse} +\def\ChTitleAsIs{\UCTfalse\LCTfalse} +\newcommand{\FmTi}[1]{% +\ifUCT + {\MakeUppercase{#1}}\LCTfalse +\else + \ifLCT + {\MakeLowercase{#1}}\UCTfalse + \else {#1} + \fi +\fi} + + + +\newlength{\mylen} +\newlength{\myhi} +\newlength{\px} +\newlength{\py} +\newlength{\pyy} +\newlength{\pxx} + + +\def\mghrulefill#1{\leavevmode\leaders\hrule\@height #1\hfill\kern\z@} + +\newcommand{\DOCH}{% + \CNV\FmN{\@chapapp}\space \CNoV\thechapter + \par\nobreak + \vskip 20\p@ + } +\newcommand{\DOTI}[1]{% + \CTV\FmTi{#1}\par\nobreak + \vskip 40\p@ + } +\newcommand{\DOTIS}[1]{% + \CTV\FmTi{#1}\par\nobreak + \vskip 40\p@ + } + +%%%%%% SONNY DEF + +\DeclareOption{Sonny}{% + \ChNameVar{\Large\sf} + \ChNumVar{\Huge} + \ChTitleVar{\Large\sf} + \ChRuleWidth{0.5pt} + \ChNameUpperCase + \renewcommand{\DOCH}{% + \raggedleft + \CNV\FmN{\@chapapp}\space \CNoV\thechapter + \par\nobreak + \vskip 40\p@} + \renewcommand{\DOTI}[1]{% + \CTV\raggedleft\mghrulefill{\RW}\par\nobreak + \vskip 5\p@ + \CTV\FmTi{#1}\par\nobreak + \mghrulefill{\RW}\par\nobreak + \vskip 40\p@} + \renewcommand{\DOTIS}[1]{% + \CTV\raggedleft\mghrulefill{\RW}\par\nobreak + \vskip 5\p@ + \CTV\FmTi{#1}\par\nobreak + \mghrulefill{\RW}\par\nobreak + \vskip 40\p@} +} + +%%%%%% LENNY DEF + +\DeclareOption{Lenny}{% + + \ChNameVar{\fontsize{14}{16}\usefont{OT1}{phv}{m}{n}\selectfont} + \ChNumVar{\fontsize{60}{62}\usefont{OT1}{ptm}{m}{n}\selectfont} + \ChTitleVar{\Huge\bfseries\rm} + \ChRuleWidth{1pt} + \renewcommand{\DOCH}{% + \settowidth{\px}{\CNV\FmN{\@chapapp}} + \addtolength{\px}{2pt} + \settoheight{\py}{\CNV\FmN{\@chapapp}} + \addtolength{\py}{1pt} + + \settowidth{\mylen}{\CNV\FmN{\@chapapp}\space\CNoV\thechapter} + \addtolength{\mylen}{1pt} + \settowidth{\pxx}{\CNoV\thechapter} + \addtolength{\pxx}{-1pt} + + \settoheight{\pyy}{\CNoV\thechapter} + \addtolength{\pyy}{-2pt} + \setlength{\myhi}{\pyy} + \addtolength{\myhi}{-1\py} + \par + \parbox[b]{\textwidth}{% + \rule[\py]{\RW}{\myhi}% + \hskip -\RW% + \rule[\pyy]{\px}{\RW}% + \hskip -\px% + \raggedright% + \CNV\FmN{\@chapapp}\space\CNoV\thechapter% + \hskip1pt% + \mghrulefill{\RW}% + \rule{\RW}{\pyy}\par\nobreak% + \vskip -\baselineskip% + \vskip -\pyy% + \hskip \mylen% + \mghrulefill{\RW}\par\nobreak% + \vskip \pyy}% + \vskip 20\p@} + + + \renewcommand{\DOTI}[1]{% + \raggedright + \CTV\FmTi{#1}\par\nobreak + \vskip 40\p@} + + \renewcommand{\DOTIS}[1]{% + \raggedright + \CTV\FmTi{#1}\par\nobreak + \vskip 40\p@} + } + +%%%%%% Peter Osbornes' version of LENNY DEF + +\DeclareOption{PetersLenny}{% + +% five new lengths +\newlength{\bl} % bottom left : orig \space +\setlength{\bl}{6pt} +\newcommand{\BL}[1]{\setlength{\bl}{#1}} +\newlength{\br} % bottom right : orig 1pt +\setlength{\br}{1pt} +\newcommand{\BR}[1]{\setlength{\br}{#1}} +\newlength{\tl} % top left : orig 2pt +\setlength{\tl}{2pt} +\newcommand{\TL}[1]{\setlength{\tl}{#1}} +\newlength{\trr} % top right :orig 1pt +\setlength{\trr}{1pt} +\newcommand{\TR}[1]{\setlength{\trr}{#1}} +\newlength{\blrule} % top right :orig 1pt +\setlength{\trr}{0pt} +\newcommand{\BLrule}[1]{\setlength{\blrule}{#1}} + + + \ChNameVar{\fontsize{14}{16}\usefont{OT1}{phv}{m}{n}\selectfont} + \ChNumVar{\fontsize{60}{62}\usefont{OT1}{ptm}{m}{n}\selectfont} + \ChTitleVar{\Huge\bfseries\rm} + \ChRuleWidth{1pt} +\renewcommand{\DOCH}{% + + +%%%%%%% tweaks for 1--9 and A--Z +\ifcase\c@chapter\relax% +\or\BL{-3pt}\TL{-4pt}\BR{0pt}\TR{-6pt}%1 +\or\BL{0pt}\TL{-4pt}\BR{2pt}\TR{-4pt}%2 +\or\BL{0pt}\TL{-4pt}\BR{2pt}\TR{-4pt}%3 +\or\BL{0pt}\TL{5pt}\BR{2pt}\TR{-4pt}%4 +\or\BL{0pt}\TL{3pt}\BR{2pt}\TR{-4pt}%5 +\or\BL{-1pt}\TL{0pt}\BR{2pt}\TR{-2pt}%6 +\or\BL{0pt}\TL{-3pt}\BR{2pt}\TR{-2pt}%7 +\or\BL{0pt}\TL{-3pt}\BR{2pt}\TR{-2pt}%8 +\or\BL{0pt}\TL{-3pt}\BR{-4pt}\TR{-2pt}%9 +\or\BL{-3pt}\TL{-3pt}\BR{2pt}\TR{-7pt}%10 +\or\BL{-6pt}\TL{-6pt}\BR{0pt}\TR{-9pt}%11 +\or\BL{-6pt}\TL{-6pt}\BR{2pt}\TR{-7pt}%12 +\or\BL{-5pt}\TL{-5pt}\BR{0pt}\TR{-9pt}%13 +\or\BL{-6pt}\TL{-6pt}\BR{0pt}\TR{-9pt}%14 +\or\BL{-3pt}\TL{-3pt}\BR{3pt}\TR{-6pt}%15 +\or\BL{-3pt}\TL{-3pt}\BR{3pt}\TR{-6pt}%16 +\or\BL{-5pt}\TL{-3pt}\BR{-8pt}\TR{-6pt}%17 +\or\BL{-5pt}\TL{-5pt}\BR{0pt}\TR{-9pt}%18 +\or\BL{-3pt}\TL{-3pt}\BR{-6pt}\TR{-9pt}%19 +\or\BL{0pt}\TL{0pt}\BR{0pt}\TR{-5pt}%20 +\fi + +\ifinapp\ifcase\c@chapter\relax% +\or\BL{0pt}\TL{14pt}\BR{5pt}\TR{-19pt}%A +\or\BL{0pt}\TL{-5pt}\BR{-3pt}\TR{-8pt}%B +\or\BL{-3pt}\TL{-2pt}\BR{1pt}\TR{-6pt}\BLrule{0pt}%C +\or\BL{0pt}\TL{-5pt}\BR{-3pt}\TR{-8pt}\BLrule{0pt}%D +\or\BL{0pt}\TL{-5pt}\BR{2pt}\TR{-3pt}%E +\or\BL{0pt}\TL{-5pt}\BR{-10pt}\TR{-1pt}%F +\or\BL{-3pt}\TL{0pt}\BR{0pt}\TR{-7pt}%G +\or\BL{0pt}\TL{-5pt}\BR{3pt}\TR{-1pt}%H +\or\BL{0pt}\TL{-5pt}\BR{3pt}\TR{-1pt}%I +\or\BL{2pt}\TL{0pt}\BR{-3pt}\TR{1pt}%J +\or\BL{0pt}\TL{-5pt}\BR{3pt}\TR{-1pt}%K +\or\BL{0pt}\TL{-5pt}\BR{2pt}\TR{-19pt}%L +\or\BL{0pt}\TL{-5pt}\BR{3pt}\TR{-1pt}%M +\or\BL{0pt}\TL{-5pt}\BR{-2pt}\TR{-1pt}%N +\or\BL{-3pt}\TL{-2pt}\BR{-3pt}\TR{-11pt}%O +\or\BL{0pt}\TL{-5pt}\BR{-9pt}\TR{-3pt}%P +\or\BL{-3pt}\TL{-2pt}\BR{-3pt}\TR{-11pt}%Q +\or\BL{0pt}\TL{-5pt}\BR{4pt}\TR{-8pt}%R +\or\BL{-2pt}\TL{-2pt}\BR{-2pt}\TR{-7pt}%S +\or\BL{-3pt}\TL{0pt}\BR{-5pt}\TR{4pt}\BLrule{8pt}%T +\or\BL{-7pt}\TL{-11pt}\BR{-5pt}\TR{-7pt}\BLrule{0pt}%U +\or\BL{-14pt}\TL{-5pt}\BR{-14pt}\TR{-1pt}\BLrule{14pt}%V +\or\BL{-10pt}\TL{-9pt}\BR{-13pt}\TR{-3pt}\BLrule{7pt}%W +\or\BL{0pt}\TL{-5pt}\BR{3pt}\TR{-1pt}\BLrule{0pt}%X +\or\BL{-6pt}\TL{-4pt}\BR{-7pt}\TR{1pt}\BLrule{7pt}%Y +\or\BL{0pt}\TL{-5pt}\BR{3pt}\TR{-1pt}\BLrule{0pt}%Z +\fi\fi +%%%%%%% + \settowidth{\px}{\CNV\FmN{\@chapapp}} + \addtolength{\px}{\tl} %MOD change 2pt to \tl + \settoheight{\py}{\CNV\FmN{\@chapapp}} + \addtolength{\py}{1pt} + + \settowidth{\mylen}{\CNV\FmN{\@chapapp}\space\CNoV\thechapter} + \addtolength{\mylen}{\trr}% MOD change 1pt to \tr + \settowidth{\pxx}{\CNoV\thechapter} + \addtolength{\pxx}{-1pt} + + \settoheight{\pyy}{\CNoV\thechapter} + \addtolength{\pyy}{-2pt} + \setlength{\myhi}{\pyy} + \addtolength{\myhi}{-1\py} + \par + \parbox[b]{\textwidth}{% + \rule[\py]{\RW}{\myhi}% + \hskip -\RW% + \rule[\pyy]{\px}{\RW}% + \hskip -\px% + \raggedright% + \CNV\FmN{\@chapapp}\rule{\blrule}{\RW}\hskip\bl\CNoV\thechapter%MOD +% \CNV\FmN{\@chapapp}\space\CNoV\thechapter %ORIGINAL + \hskip\br% %MOD 1pt to \br + \mghrulefill{\RW}% + \rule{\RW}{\pyy}\par\nobreak% + \vskip -\baselineskip% + \vskip -\pyy% + \hskip \mylen% + \mghrulefill{\RW}\par\nobreak% + \vskip \pyy}% + \vskip 20\p@} + + + \renewcommand{\DOTI}[1]{% + \raggedright + \CTV\FmTi{#1}\par\nobreak + \vskip 40\p@} + + \renewcommand{\DOTIS}[1]{% + \raggedright + \CTV\FmTi{#1}\par\nobreak + \vskip 40\p@} + } + + +% + + +%%%%%% BJORNSTRUP DEF + +\DeclareOption{Bjornstrup}{% + \usecolortrue + % pzc (Zapf Chancelery) is nice. ppl (Palatino) is cool too. + \ChNumVar{\fontsize{76}{80}\usefont{OT1}{pzc}{m}{n}\selectfont} + \ChTitleVar{\raggedleft\Large\sffamily\bfseries} + + \setlength{\myhi}{10pt} % Space between grey box border and text + \setlength{\mylen}{\textwidth} + \addtolength{\mylen}{-2\myhi} + \renewcommand{\DOCH}{% + \settowidth{\py}{\CNoV\thechapter} + \addtolength{\py}{-10pt} % Amount of space by which the +% % number is shifted right + \fboxsep=0pt% + \colorbox[gray]{.85}{\rule{0pt}{40pt}\parbox[b]{\textwidth}{\hfill}}% + \kern-\py\raise20pt% + \hbox{\color[gray]{.5}\CNoV\thechapter}\\% + } + + \renewcommand{\DOTI}[1]{% + \nointerlineskip\raggedright% + \fboxsep=\myhi% + \vskip-1ex% + \colorbox[gray]{.85}{\parbox[t]{\mylen}{\CTV\FmTi{#1}}}\par\nobreak% + \vskip 40\p@% + } + + \renewcommand{\DOTIS}[1]{% + \fboxsep=0pt + \colorbox[gray]{.85}{\rule{0pt}{40pt}\parbox[b]{\textwidth}{\hfill}}\\% + \nointerlineskip\raggedright% + \fboxsep=\myhi% + \colorbox[gray]{.85}{\parbox[t]{\mylen}{\CTV\FmTi{#1}}}\par\nobreak% + \vskip 40\p@% + } +} + + +%%%%%%% GLENN DEF + + +\DeclareOption{Glenn}{% + \ChNameVar{\bfseries\Large\sf} + \ChNumVar{\Huge} + \ChTitleVar{\bfseries\Large\rm} + \ChRuleWidth{1pt} + \ChNameUpperCase + \ChTitleUpperCase + \renewcommand{\DOCH}{% + \settoheight{\myhi}{\CTV\FmTi{Test}} + \setlength{\py}{\baselineskip} + \addtolength{\py}{\RW} + \addtolength{\py}{\myhi} + \setlength{\pyy}{\py} + \addtolength{\pyy}{-1\RW} + + \raggedright + \CNV\FmN{\@chapapp}\space\CNoV\thechapter + \hskip 3pt\mghrulefill{\RW}\rule[-1\pyy]{2\RW}{\py}\par\nobreak} + + \renewcommand{\DOTI}[1]{% + \addtolength{\pyy}{-4pt} + \settoheight{\myhi}{\CTV\FmTi{#1}} + \addtolength{\myhi}{\py} + \addtolength{\myhi}{-1\RW} + \vskip -1\pyy + \rule{2\RW}{\myhi}\mghrulefill{\RW}\hskip 2pt + \raggedleft\CTV\FmTi{#1}\par\nobreak + \vskip 80\p@} + +\newlength{\backskip} + \renewcommand{\DOTIS}[1]{% +% \setlength{\py}{10pt} +% \setlength{\pyy}{\py} +% \addtolength{\pyy}{\RW} +% \setlength{\myhi}{\baselineskip} +% \addtolength{\myhi}{\pyy} +% \mghrulefill{\RW}\rule[-1\py]{2\RW}{\pyy}\par\nobreak +% \addtolength{}{} +%\vskip -1\baselineskip +% \rule{2\RW}{\myhi}\mghrulefill{\RW}\hskip 2pt +% \raggedleft\CTV\FmTi{#1}\par\nobreak +% \vskip 60\p@} +%% Fix suggested by Tomas Lundberg + \setlength{\py}{25pt} % eller vad man vill + \setlength{\pyy}{\py} + \setlength{\backskip}{\py} + \addtolength{\backskip}{2pt} + \addtolength{\pyy}{\RW} + \setlength{\myhi}{\baselineskip} + \addtolength{\myhi}{\pyy} + \mghrulefill{\RW}\rule[-1\py]{2\RW}{\pyy}\par\nobreak + \vskip -1\backskip + \rule{2\RW}{\myhi}\mghrulefill{\RW}\hskip 3pt % + \raggedleft\CTV\FmTi{#1}\par\nobreak + \vskip 40\p@} + } + +%%%%%%% CONNY DEF + +\DeclareOption{Conny}{% + \ChNameUpperCase + \ChTitleUpperCase + \ChNameVar{\centering\Huge\rm\bfseries} + \ChNumVar{\Huge} + \ChTitleVar{\centering\Huge\rm} + \ChRuleWidth{2pt} + + \renewcommand{\DOCH}{% + \mghrulefill{3\RW}\par\nobreak + \vskip -0.5\baselineskip + \mghrulefill{\RW}\par\nobreak + \CNV\FmN{\@chapapp}\space \CNoV\thechapter + \par\nobreak + \vskip -0.5\baselineskip + } + \renewcommand{\DOTI}[1]{% + \mghrulefill{\RW}\par\nobreak + \CTV\FmTi{#1}\par\nobreak + \vskip 60\p@ + } + \renewcommand{\DOTIS}[1]{% + \mghrulefill{\RW}\par\nobreak + \CTV\FmTi{#1}\par\nobreak + \vskip 60\p@ + } + } + +%%%%%%% REJNE DEF + +\DeclareOption{Rejne}{% + + \ChNameUpperCase + \ChTitleUpperCase + \ChNameVar{\centering\Large\rm} + \ChNumVar{\Huge} + \ChTitleVar{\centering\Huge\rm} + \ChRuleWidth{1pt} + \renewcommand{\DOCH}{% + \settoheight{\py}{\CNoV\thechapter} + \parskip=0pt plus 1pt % Set parskip to default, just in case v1.31 + \addtolength{\py}{-1pt} + \CNV\FmN{\@chapapp}\par\nobreak + \vskip 20\p@ + \setlength{\myhi}{2\baselineskip} + \setlength{\px}{\myhi} + \addtolength{\px}{-1\RW} + \rule[-1\px]{\RW}{\myhi}\mghrulefill{\RW}\hskip + 10pt\raisebox{-0.5\py}{\CNoV\thechapter}\hskip 10pt\mghrulefill{\RW}\rule[-1\px]{\RW}{\myhi}\par\nobreak + \vskip -3\p@% Added -2pt vskip to correct for streched text v1.31 + } + \renewcommand{\DOTI}[1]{% + \setlength{\mylen}{\textwidth} + \parskip=0pt plus 1pt % Set parskip to default, just in case v1.31 + \addtolength{\mylen}{-2\RW} + {\vrule width\RW}\parbox{\mylen}{\CTV\FmTi{#1}}{\vrule width\RW}\par\nobreak% + \vskip -3pt\rule{\RW}{2\baselineskip}\mghrulefill{\RW}\rule{\RW}{2\baselineskip}% + \vskip 60\p@% Added -2pt in vskip to correct for streched text v1.31 + } + \renewcommand{\DOTIS}[1]{% + \setlength{\py}{\fboxrule} + \setlength{\fboxrule}{\RW} + \setlength{\mylen}{\textwidth} + \addtolength{\mylen}{-2\RW} + \fbox{\parbox{\mylen}{\vskip 2\baselineskip\CTV\FmTi{#1}\par\nobreak\vskip \baselineskip}} + \setlength{\fboxrule}{\py} + \vskip 60\p@ + } + } + + +%%%%%%% BJARNE DEF + +\DeclareOption{Bjarne}{% + \ChNameUpperCase + \ChTitleUpperCase + \ChNameVar{\raggedleft\normalsize\rm} + \ChNumVar{\raggedleft \bfseries\Large} + \ChTitleVar{\raggedleft \Large\rm} + \ChRuleWidth{1pt} + + +%% Note thechapter -> c@chapter fix appendix bug +%% Fixed misspelled 12 + + \newcounter{AlphaCnt} + \newcounter{AlphaDecCnt} + \newcommand{\AlphaNo}{% + \ifcase\number\theAlphaCnt + \ifnum\c@chapter=0 + ZERO\else{}\fi + \or ONE\or TWO\or THREE\or FOUR\or FIVE + \or SIX\or SEVEN\or EIGHT\or NINE\or TEN + \or ELEVEN\or TWELVE\or THIRTEEN\or FOURTEEN\or FIFTEEN + \or SIXTEEN\or SEVENTEEN\or EIGHTEEN\or NINETEEN\fi +} + + \newcommand{\AlphaDecNo}{% + \setcounter{AlphaDecCnt}{0} + \@whilenum\number\theAlphaCnt>0\do + {\addtocounter{AlphaCnt}{-10} + \addtocounter{AlphaDecCnt}{1}} + \ifnum\number\theAlphaCnt=0 + \else + \addtocounter{AlphaDecCnt}{-1} + \addtocounter{AlphaCnt}{10} + \fi + + + \ifcase\number\theAlphaDecCnt\or TEN\or TWENTY\or THIRTY\or + FORTY\or FIFTY\or SIXTY\or SEVENTY\or EIGHTY\or NINETY\fi + } + \newcommand{\TheAlphaChapter}{% + + \ifinapp + \thechapter + \else + \setcounter{AlphaCnt}{\c@chapter} + \ifnum\c@chapter<20 + \AlphaNo + \else + \AlphaDecNo\AlphaNo + \fi + \fi + } + \renewcommand{\DOCH}{% + \mghrulefill{\RW}\par\nobreak + \CNV\FmN{\@chapapp}\par\nobreak + \CNoV\TheAlphaChapter\par\nobreak + \vskip -1\baselineskip\vskip 5pt\mghrulefill{\RW}\par\nobreak + \vskip 20\p@ + } + \renewcommand{\DOTI}[1]{% + \CTV\FmTi{#1}\par\nobreak + \vskip 40\p@ + } + \renewcommand{\DOTIS}[1]{% + \CTV\FmTi{#1}\par\nobreak + \vskip 40\p@ + } +} + +\DeclareOption*{% + \PackageWarning{fancychapter}{unknown style option} + } + +\ProcessOptions* \relax + +\ifusecolor + \RequirePackage{color} +\fi +\def\@makechapterhead#1{% + \vspace*{50\p@}% + {\parindent \z@ \raggedright \normalfont + \ifnum \c@secnumdepth >\m@ne + \if@mainmatter%%%%% Fix for frontmatter, mainmatter, and backmatter 040920 + \DOCH + \fi + \fi + \interlinepenalty\@M + \if@mainmatter%%%%% Fix for frontmatter, mainmatter, and backmatter 060424 + \DOTI{#1}% + \else% + \DOTIS{#1}% + \fi + }} + + +%%% Begin: To avoid problem with scrbook.cls (fncychap version 1.32) + +%%OUT: +%\def\@schapter#1{\if@twocolumn +% \@topnewpage[\@makeschapterhead{#1}]% +% \else +% \@makeschapterhead{#1}% +% \@afterheading +% \fi} + +%%IN: +\def\@schapter#1{% +\if@twocolumn% + \@makeschapterhead{#1}% +\else% + \@makeschapterhead{#1}% + \@afterheading% +\fi} + +%%% End: To avoid problem with scrbook.cls (fncychap version 1.32) + +\def\@makeschapterhead#1{% + \vspace*{50\p@}% + {\parindent \z@ \raggedright + \normalfont + \interlinepenalty\@M + \DOTIS{#1} + \vskip 40\p@ + }} + +\endinput + + diff --git a/doc/build/latex/python.ist b/doc/build/latex/python.ist new file mode 100644 index 0000000..9ffa0f9 --- /dev/null +++ b/doc/build/latex/python.ist @@ -0,0 +1,11 @@ +line_max 100 +headings_flag 1 +heading_prefix " \\bigletter " + +preamble "\\begin{theindex} +\\def\\bigletter#1{{\\Large\\sffamily#1}\\nopagebreak\\vspace{1mm}} + +" + +symhead_positive "{Symbols}" +numhead_positive "{Numbers}" diff --git a/doc/build/latex/salomeTools.aux b/doc/build/latex/salomeTools.aux new file mode 100644 index 0000000..bb11ddd --- /dev/null +++ b/doc/build/latex/salomeTools.aux @@ -0,0 +1,780 @@ +\relax +\providecommand\hyper@newdestlabel[2]{} +\providecommand\HyperFirstAtBeginDocument{\AtBeginDocument} +\HyperFirstAtBeginDocument{\ifx\hyper@anchor\@undefined +\global\let\oldcontentsline\contentsline +\gdef\contentsline#1#2#3#4{\oldcontentsline{#1}{#2}{#3}} +\global\let\oldnewlabel\newlabel +\gdef\newlabel#1#2{\newlabelxx{#1}#2} +\gdef\newlabelxx#1#2#3#4#5#6{\oldnewlabel{#1}{{#2}{#3}}} +\AtEndDocument{\ifx\hyper@anchor\@undefined +\let\contentsline\oldcontentsline +\let\newlabel\oldnewlabel +\fi} +\fi} +\global\let\hyper@last\relax +\gdef\HyperFirstAtBeginDocument#1{#1} +\providecommand\HyField@AuxAddToFields[1]{} +\providecommand\HyField@AuxAddToCoFields[2]{} +\babel@aux{english}{} +\newlabel{index::doc}{{}{1}{}{section*.2}{}} +\@writefile{toc}{\contentsline {chapter}{\numberline {1}Quick start}{3}{chapter.1}} +\@writefile{lof}{\addvspace {10\p@ }} +\@writefile{lot}{\addvspace {10\p@ }} +\newlabel{index:svn}{{1}{3}{Quick start}{chapter.1}{}} +\newlabel{index:quick-start}{{1}{3}{Quick start}{chapter.1}{}} +\newlabel{index:salome-tools}{{1}{3}{Quick start}{chapter.1}{}} +\@writefile{toc}{\contentsline {section}{\numberline {1.1}Installation}{3}{section.1.1}} +\newlabel{installation_of_sat:installation}{{1.1}{3}{Installation}{section.1.1}{}} +\newlabel{installation_of_sat::doc}{{1.1}{3}{Installation}{section.1.1}{}} +\@writefile{toc}{\contentsline {section}{\numberline {1.2}Configuration}{3}{section.1.2}} +\newlabel{configuration:configuration}{{1.2}{3}{Configuration}{section.1.2}{}} +\newlabel{configuration::doc}{{1.2}{3}{Configuration}{section.1.2}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {1.2.1}Syntax}{3}{subsection.1.2.1}} +\newlabel{configuration:syntax}{{1.2.1}{3}{Syntax}{subsection.1.2.1}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {1.2.2}Description}{3}{subsection.1.2.2}} +\newlabel{configuration:description}{{1.2.2}{3}{Description}{subsection.1.2.2}{}} +\@writefile{toc}{\contentsline {subsubsection}{VARS section}{3}{subsubsection*.3}} +\newlabel{configuration:vars-section}{{1.2.2}{3}{VARS section}{subsubsection*.3}{}} +\newlabel{configuration:id1}{{1.2.2}{3}{VARS section}{subsubsection*.3}{}} +\@writefile{toc}{\contentsline {subsubsection}{PRODUCTS section}{4}{subsubsection*.4}} +\newlabel{configuration:products-section}{{1.2.2}{4}{PRODUCTS section}{subsubsection*.4}{}} +\@writefile{toc}{\contentsline {subsubsection}{APPLICATION section}{4}{subsubsection*.5}} +\newlabel{configuration:application-section}{{1.2.2}{4}{APPLICATION section}{subsubsection*.5}{}} +\@writefile{toc}{\contentsline {subsubsection}{USER section}{4}{subsubsection*.6}} +\newlabel{configuration:user-section}{{1.2.2}{4}{USER section}{subsubsection*.6}{}} +\newlabel{configuration:id2}{{1.2.2}{4}{USER section}{subsubsection*.6}{}} +\@writefile{toc}{\contentsline {section}{\numberline {1.3}Usage of SAlomeTools}{4}{section.1.3}} +\newlabel{usage_of_sat:svn}{{1.3}{4}{Usage of SAlomeTools}{section.1.3}{}} +\newlabel{usage_of_sat:usage-of-salometools}{{1.3}{4}{Usage of SAlomeTools}{section.1.3}{}} +\newlabel{usage_of_sat::doc}{{1.3}{4}{Usage of SAlomeTools}{section.1.3}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {1.3.1}Usage}{4}{subsection.1.3.1}} +\newlabel{usage_of_sat:usage}{{1.3.1}{4}{Usage}{subsection.1.3.1}{}} +\@writefile{toc}{\contentsline {subsubsection}{Options of sat}{4}{subsubsection*.7}} +\newlabel{usage_of_sat:options-of-sat}{{1.3.1}{4}{Options of sat}{subsubsection*.7}{}} +\@writefile{toc}{\contentsline {paragraph}{\emph {--help or -h}}{5}{paragraph*.8}} +\newlabel{usage_of_sat:help-or-h}{{1.3.1}{5}{\emph {--help or -h}}{paragraph*.8}{}} +\@writefile{toc}{\contentsline {paragraph}{\emph {--debug or -g}}{5}{paragraph*.9}} +\newlabel{usage_of_sat:debug-or-g}{{1.3.1}{5}{\emph {--debug or -g}}{paragraph*.9}{}} +\@writefile{toc}{\contentsline {paragraph}{\emph {--verbose or -v}}{5}{paragraph*.10}} +\newlabel{usage_of_sat:verbose-or-v}{{1.3.1}{5}{\emph {--verbose or -v}}{paragraph*.10}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {1.3.2}Build a SALOME product}{5}{subsection.1.3.2}} +\newlabel{usage_of_sat:build-a-salome-product}{{1.3.2}{5}{Build a SALOME product}{subsection.1.3.2}{}} +\@writefile{toc}{\contentsline {subsubsection}{Get the list of available products}{5}{subsubsection*.11}} +\newlabel{usage_of_sat:get-the-list-of-available-products}{{1.3.2}{5}{Get the list of available products}{subsubsection*.11}{}} +\@writefile{toc}{\contentsline {subsubsection}{Prepare sources of a product}{5}{subsubsection*.12}} +\newlabel{usage_of_sat:prepare-sources-of-a-product}{{1.3.2}{5}{Prepare sources of a product}{subsubsection*.12}{}} +\@writefile{toc}{\contentsline {subsubsection}{Compile SALOME}{5}{subsubsection*.13}} +\newlabel{usage_of_sat:compile-salome}{{1.3.2}{5}{Compile SALOME}{subsubsection*.13}{}} +\@writefile{toc}{\contentsline {chapter}{\numberline {2}List of Commands}{7}{chapter.2}} +\@writefile{lof}{\addvspace {10\p@ }} +\@writefile{lot}{\addvspace {10\p@ }} +\newlabel{index:list-of-commands}{{2}{7}{List of Commands}{chapter.2}{}} +\@writefile{toc}{\contentsline {section}{\numberline {2.1}Command config}{7}{section.2.1}} +\newlabel{commands/config:svn}{{2.1}{7}{Command config}{section.2.1}{}} +\newlabel{commands/config:command-config}{{2.1}{7}{Command config}{section.2.1}{}} +\newlabel{commands/config::doc}{{2.1}{7}{Command config}{section.2.1}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.1.1}Description}{7}{subsection.2.1.1}} +\newlabel{commands/config:description}{{2.1.1}{7}{Description}{subsection.2.1.1}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.1.2}Usage}{7}{subsection.2.1.2}} +\newlabel{commands/config:usage}{{2.1.2}{7}{Usage}{subsection.2.1.2}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.1.3}Some useful configuration pathes}{8}{subsection.2.1.3}} +\newlabel{commands/config:some-useful-configuration-pathes}{{2.1.3}{8}{Some useful configuration pathes}{subsection.2.1.3}{}} +\@writefile{toc}{\contentsline {section}{\numberline {2.2}Command prepare}{8}{section.2.2}} +\newlabel{commands/prepare:svn}{{2.2}{8}{Command prepare}{section.2.2}{}} +\newlabel{commands/prepare:command-prepare}{{2.2}{8}{Command prepare}{section.2.2}{}} +\newlabel{commands/prepare::doc}{{2.2}{8}{Command prepare}{section.2.2}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.2.1}Description}{8}{subsection.2.2.1}} +\newlabel{commands/prepare:description}{{2.2.1}{8}{Description}{subsection.2.2.1}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.2.2}Remarks}{8}{subsection.2.2.2}} +\newlabel{commands/prepare:remarks}{{2.2.2}{8}{Remarks}{subsection.2.2.2}{}} +\@writefile{toc}{\contentsline {subsubsection}{VCS bases (git, svn, cvs)}{8}{subsubsection*.14}} +\newlabel{commands/prepare:vcs-bases-git-svn-cvs}{{2.2.2}{8}{VCS bases (git, svn, cvs)}{subsubsection*.14}{}} +\@writefile{toc}{\contentsline {subsubsection}{Dev mode}{9}{subsubsection*.15}} +\newlabel{commands/prepare:dev-mode}{{2.2.2}{9}{Dev mode}{subsubsection*.15}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.2.3}Usage}{9}{subsection.2.2.3}} +\newlabel{commands/prepare:usage}{{2.2.3}{9}{Usage}{subsection.2.2.3}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.2.4}Some useful configuration pathes}{9}{subsection.2.2.4}} +\newlabel{commands/prepare:some-useful-configuration-pathes}{{2.2.4}{9}{Some useful configuration pathes}{subsection.2.2.4}{}} +\@writefile{toc}{\contentsline {section}{\numberline {2.3}Command compile}{10}{section.2.3}} +\newlabel{commands/compile:svn}{{2.3}{10}{Command compile}{section.2.3}{}} +\newlabel{commands/compile:command-compile}{{2.3}{10}{Command compile}{section.2.3}{}} +\newlabel{commands/compile::doc}{{2.3}{10}{Command compile}{section.2.3}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.3.1}Description}{10}{subsection.2.3.1}} +\newlabel{commands/compile:description}{{2.3.1}{10}{Description}{subsection.2.3.1}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.3.2}Usage}{10}{subsection.2.3.2}} +\newlabel{commands/compile:usage}{{2.3.2}{10}{Usage}{subsection.2.3.2}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.3.3}Some useful configuration pathes}{11}{subsection.2.3.3}} +\newlabel{commands/compile:some-useful-configuration-pathes}{{2.3.3}{11}{Some useful configuration pathes}{subsection.2.3.3}{}} +\@writefile{toc}{\contentsline {section}{\numberline {2.4}Command launcher}{11}{section.2.4}} +\newlabel{commands/launcher:svn}{{2.4}{11}{Command launcher}{section.2.4}{}} +\newlabel{commands/launcher:command-launcher}{{2.4}{11}{Command launcher}{section.2.4}{}} +\newlabel{commands/launcher::doc}{{2.4}{11}{Command launcher}{section.2.4}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.4.1}Description}{11}{subsection.2.4.1}} +\newlabel{commands/launcher:description}{{2.4.1}{11}{Description}{subsection.2.4.1}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.4.2}Usage}{11}{subsection.2.4.2}} +\newlabel{commands/launcher:usage}{{2.4.2}{11}{Usage}{subsection.2.4.2}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.4.3}Configuration}{11}{subsection.2.4.3}} +\newlabel{commands/launcher:configuration}{{2.4.3}{11}{Configuration}{subsection.2.4.3}{}} +\@writefile{toc}{\contentsline {section}{\numberline {2.5}Command application}{12}{section.2.5}} +\newlabel{commands/application:svn}{{2.5}{12}{Command application}{section.2.5}{}} +\newlabel{commands/application::doc}{{2.5}{12}{Command application}{section.2.5}{}} +\newlabel{commands/application:command-application}{{2.5}{12}{Command application}{section.2.5}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.5.1}Description}{12}{subsection.2.5.1}} +\newlabel{commands/application:description}{{2.5.1}{12}{Description}{subsection.2.5.1}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.5.2}Usage}{12}{subsection.2.5.2}} +\newlabel{commands/application:usage}{{2.5.2}{12}{Usage}{subsection.2.5.2}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.5.3}Some useful configuration pathes}{12}{subsection.2.5.3}} +\newlabel{commands/application:some-useful-configuration-pathes}{{2.5.3}{12}{Some useful configuration pathes}{subsection.2.5.3}{}} +\@writefile{toc}{\contentsline {section}{\numberline {2.6}Command log}{13}{section.2.6}} +\newlabel{commands/log:svn}{{2.6}{13}{Command log}{section.2.6}{}} +\newlabel{commands/log:command-log}{{2.6}{13}{Command log}{section.2.6}{}} +\newlabel{commands/log::doc}{{2.6}{13}{Command log}{section.2.6}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.6.1}Description}{13}{subsection.2.6.1}} +\newlabel{commands/log:description}{{2.6.1}{13}{Description}{subsection.2.6.1}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.6.2}Usage}{13}{subsection.2.6.2}} +\newlabel{commands/log:usage}{{2.6.2}{13}{Usage}{subsection.2.6.2}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.6.3}Some useful configuration pathes}{13}{subsection.2.6.3}} +\newlabel{commands/log:some-useful-configuration-pathes}{{2.6.3}{13}{Some useful configuration pathes}{subsection.2.6.3}{}} +\@writefile{toc}{\contentsline {section}{\numberline {2.7}Command environ}{13}{section.2.7}} +\newlabel{commands/environ:svn}{{2.7}{13}{Command environ}{section.2.7}{}} +\newlabel{commands/environ:command-environ}{{2.7}{13}{Command environ}{section.2.7}{}} +\newlabel{commands/environ::doc}{{2.7}{13}{Command environ}{section.2.7}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.7.1}Description}{13}{subsection.2.7.1}} +\newlabel{commands/environ:description}{{2.7.1}{13}{Description}{subsection.2.7.1}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.7.2}Usage}{14}{subsection.2.7.2}} +\newlabel{commands/environ:usage}{{2.7.2}{14}{Usage}{subsection.2.7.2}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.7.3}Configuration}{14}{subsection.2.7.3}} +\newlabel{commands/environ:configuration}{{2.7.3}{14}{Configuration}{subsection.2.7.3}{}} +\@writefile{toc}{\contentsline {section}{\numberline {2.8}Command clean}{15}{section.2.8}} +\newlabel{commands/clean:svn}{{2.8}{15}{Command clean}{section.2.8}{}} +\newlabel{commands/clean:command-clean}{{2.8}{15}{Command clean}{section.2.8}{}} +\newlabel{commands/clean::doc}{{2.8}{15}{Command clean}{section.2.8}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.8.1}Description}{15}{subsection.2.8.1}} +\newlabel{commands/clean:description}{{2.8.1}{15}{Description}{subsection.2.8.1}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.8.2}Usage}{15}{subsection.2.8.2}} +\newlabel{commands/clean:usage}{{2.8.2}{15}{Usage}{subsection.2.8.2}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.8.3}Availables options}{16}{subsection.2.8.3}} +\newlabel{commands/clean:availables-options}{{2.8.3}{16}{Availables options}{subsection.2.8.3}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.8.4}Some useful configuration pathes}{16}{subsection.2.8.4}} +\newlabel{commands/clean:some-useful-configuration-pathes}{{2.8.4}{16}{Some useful configuration pathes}{subsection.2.8.4}{}} +\@writefile{toc}{\contentsline {section}{\numberline {2.9}Command package}{16}{section.2.9}} +\newlabel{commands/package:svn}{{2.9}{16}{Command package}{section.2.9}{}} +\newlabel{commands/package:command-package}{{2.9}{16}{Command package}{section.2.9}{}} +\newlabel{commands/package::doc}{{2.9}{16}{Command package}{section.2.9}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.9.1}Description}{16}{subsection.2.9.1}} +\newlabel{commands/package:description}{{2.9.1}{16}{Description}{subsection.2.9.1}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.9.2}Usage}{16}{subsection.2.9.2}} +\newlabel{commands/package:usage}{{2.9.2}{16}{Usage}{subsection.2.9.2}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.9.3}Some useful configuration pathes}{17}{subsection.2.9.3}} +\newlabel{commands/package:some-useful-configuration-pathes}{{2.9.3}{17}{Some useful configuration pathes}{subsection.2.9.3}{}} +\@writefile{toc}{\contentsline {section}{\numberline {2.10}Command generate}{17}{section.2.10}} +\newlabel{commands/generate:svn}{{2.10}{17}{Command generate}{section.2.10}{}} +\newlabel{commands/generate:command-generate}{{2.10}{17}{Command generate}{section.2.10}{}} +\newlabel{commands/generate::doc}{{2.10}{17}{Command generate}{section.2.10}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.10.1}Description}{17}{subsection.2.10.1}} +\newlabel{commands/generate:description}{{2.10.1}{17}{Description}{subsection.2.10.1}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.10.2}Remarks}{18}{subsection.2.10.2}} +\newlabel{commands/generate:remarks}{{2.10.2}{18}{Remarks}{subsection.2.10.2}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.10.3}Usage}{18}{subsection.2.10.3}} +\newlabel{commands/generate:usage}{{2.10.3}{18}{Usage}{subsection.2.10.3}{}} +\@writefile{toc}{\contentsline {chapter}{\numberline {3}Developer documentation}{19}{chapter.3}} +\@writefile{lof}{\addvspace {10\p@ }} +\@writefile{lot}{\addvspace {10\p@ }} +\newlabel{index:developer-documentation}{{3}{19}{Developer documentation}{chapter.3}{}} +\@writefile{toc}{\contentsline {section}{\numberline {3.1}Add a user custom command}{19}{section.3.1}} +\newlabel{write_command:svn}{{3.1}{19}{Add a user custom command}{section.3.1}{}} +\newlabel{write_command:add-a-user-custom-command}{{3.1}{19}{Add a user custom command}{section.3.1}{}} +\newlabel{write_command::doc}{{3.1}{19}{Add a user custom command}{section.3.1}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {3.1.1}Introduction}{19}{subsection.3.1.1}} +\newlabel{write_command:introduction}{{3.1.1}{19}{Introduction}{subsection.3.1.1}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {3.1.2}Basic requirements}{19}{subsection.3.1.2}} +\newlabel{write_command:basic-requirements}{{3.1.2}{19}{Basic requirements}{subsection.3.1.2}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {3.1.3}HowTo access salomeTools config and other commands}{20}{subsection.3.1.3}} +\newlabel{write_command:howto-access-salometools-config-and-other-commands}{{3.1.3}{20}{HowTo access salomeTools config and other commands}{subsection.3.1.3}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {3.1.4}HowTo logger}{20}{subsection.3.1.4}} +\newlabel{write_command:howto-logger}{{3.1.4}{20}{HowTo logger}{subsection.3.1.4}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {3.1.5}HELLO example}{20}{subsection.3.1.5}} +\newlabel{write_command:hello-example}{{3.1.5}{20}{HELLO example}{subsection.3.1.5}{}} +\@writefile{toc}{\contentsline {chapter}{\numberline {4}Code documentation}{23}{chapter.4}} +\@writefile{lof}{\addvspace {10\p@ }} +\@writefile{lot}{\addvspace {10\p@ }} +\newlabel{index:code-documentation}{{4}{23}{Code documentation}{chapter.4}{}} +\@writefile{toc}{\contentsline {section}{\numberline {4.1}src}{23}{section.4.1}} +\newlabel{commands/apidoc/modules:src}{{4.1}{23}{src}{section.4.1}{}} +\newlabel{commands/apidoc/modules::doc}{{4.1}{23}{src}{section.4.1}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {4.1.1}src Package}{23}{subsection.4.1.1}} +\newlabel{commands/apidoc/src::doc}{{4.1.1}{23}{src Package}{subsection.4.1.1}{}} +\newlabel{commands/apidoc/src:src-package}{{4.1.1}{23}{src Package}{subsection.4.1.1}{}} +\@writefile{toc}{\contentsline {subsubsection}{\texttt {src} Package}{23}{subsubsection*.16}} +\newlabel{commands/apidoc/src:id1}{{4.1.1}{23}{\texttt {src} Package}{subsubsection*.16}{}} +\newlabel{commands/apidoc/src:module-src.__init__}{{4.1.1}{23}{\texttt {src} Package}{section*.17}{}} +\newlabel{commands/apidoc/src:src.__init__.Path}{{4.1.1}{23}{\texttt {src} Package}{section*.18}{}} +\newlabel{commands/apidoc/src:src.__init__.Path.base}{{4.1.1}{23}{\texttt {src} Package}{section*.19}{}} +\newlabel{commands/apidoc/src:src.__init__.Path.chmod}{{4.1.1}{23}{\texttt {src} Package}{section*.20}{}} +\newlabel{commands/apidoc/src:src.__init__.Path.copy}{{4.1.1}{23}{\texttt {src} Package}{section*.21}{}} +\newlabel{commands/apidoc/src:src.__init__.Path.copydir}{{4.1.1}{23}{\texttt {src} Package}{section*.22}{}} +\newlabel{commands/apidoc/src:src.__init__.Path.copyfile}{{4.1.1}{23}{\texttt {src} Package}{section*.23}{}} +\newlabel{commands/apidoc/src:src.__init__.Path.copylink}{{4.1.1}{23}{\texttt {src} Package}{section*.24}{}} +\newlabel{commands/apidoc/src:src.__init__.Path.dir}{{4.1.1}{23}{\texttt {src} Package}{section*.25}{}} +\newlabel{commands/apidoc/src:src.__init__.Path.exists}{{4.1.1}{23}{\texttt {src} Package}{section*.26}{}} +\newlabel{commands/apidoc/src:src.__init__.Path.isdir}{{4.1.1}{23}{\texttt {src} Package}{section*.27}{}} +\newlabel{commands/apidoc/src:src.__init__.Path.isfile}{{4.1.1}{23}{\texttt {src} Package}{section*.28}{}} +\newlabel{commands/apidoc/src:src.__init__.Path.islink}{{4.1.1}{23}{\texttt {src} Package}{section*.29}{}} +\newlabel{commands/apidoc/src:src.__init__.Path.list}{{4.1.1}{23}{\texttt {src} Package}{section*.30}{}} +\newlabel{commands/apidoc/src:src.__init__.Path.make}{{4.1.1}{23}{\texttt {src} Package}{section*.31}{}} +\newlabel{commands/apidoc/src:src.__init__.Path.readlink}{{4.1.1}{23}{\texttt {src} Package}{section*.32}{}} +\newlabel{commands/apidoc/src:src.__init__.Path.rm}{{4.1.1}{23}{\texttt {src} Package}{section*.33}{}} +\newlabel{commands/apidoc/src:src.__init__.Path.smartcopy}{{4.1.1}{23}{\texttt {src} Package}{section*.34}{}} +\newlabel{commands/apidoc/src:src.__init__.Path.symlink}{{4.1.1}{23}{\texttt {src} Package}{section*.35}{}} +\newlabel{commands/apidoc/src:src.__init__.SatException}{{4.1.1}{23}{\texttt {src} Package}{section*.36}{}} +\newlabel{commands/apidoc/src:src.__init__.activate_mesa_property}{{4.1.1}{23}{\texttt {src} Package}{section*.37}{}} +\newlabel{commands/apidoc/src:src.__init__.check_config_has_application}{{4.1.1}{23}{\texttt {src} Package}{section*.38}{}} +\newlabel{commands/apidoc/src:src.__init__.check_config_has_profile}{{4.1.1}{24}{\texttt {src} Package}{section*.39}{}} +\newlabel{commands/apidoc/src:src.__init__.config_has_application}{{4.1.1}{24}{\texttt {src} Package}{section*.40}{}} +\newlabel{commands/apidoc/src:src.__init__.deepcopy_list}{{4.1.1}{24}{\texttt {src} Package}{section*.41}{}} +\newlabel{commands/apidoc/src:src.__init__.ensure_path_exists}{{4.1.1}{24}{\texttt {src} Package}{section*.42}{}} +\newlabel{commands/apidoc/src:src.__init__.find_file_in_lpath}{{4.1.1}{24}{\texttt {src} Package}{section*.43}{}} +\newlabel{commands/apidoc/src:src.__init__.get_base_path}{{4.1.1}{24}{\texttt {src} Package}{section*.44}{}} +\newlabel{commands/apidoc/src:src.__init__.get_cfg_param}{{4.1.1}{24}{\texttt {src} Package}{section*.45}{}} +\newlabel{commands/apidoc/src:src.__init__.get_launcher_name}{{4.1.1}{24}{\texttt {src} Package}{section*.46}{}} +\newlabel{commands/apidoc/src:src.__init__.get_log_path}{{4.1.1}{25}{\texttt {src} Package}{section*.47}{}} +\newlabel{commands/apidoc/src:src.__init__.get_property_in_product_cfg}{{4.1.1}{25}{\texttt {src} Package}{section*.48}{}} +\newlabel{commands/apidoc/src:src.__init__.get_salome_version}{{4.1.1}{25}{\texttt {src} Package}{section*.49}{}} +\newlabel{commands/apidoc/src:src.__init__.get_tmp_filename}{{4.1.1}{25}{\texttt {src} Package}{section*.50}{}} +\newlabel{commands/apidoc/src:src.__init__.handleRemoveReadonly}{{4.1.1}{25}{\texttt {src} Package}{section*.51}{}} +\newlabel{commands/apidoc/src:src.__init__.merge_dicts}{{4.1.1}{25}{\texttt {src} Package}{section*.52}{}} +\newlabel{commands/apidoc/src:src.__init__.only_numbers}{{4.1.1}{25}{\texttt {src} Package}{section*.53}{}} +\newlabel{commands/apidoc/src:src.__init__.parse_date}{{4.1.1}{25}{\texttt {src} Package}{section*.54}{}} +\newlabel{commands/apidoc/src:src.__init__.print_info}{{4.1.1}{25}{\texttt {src} Package}{section*.55}{}} +\newlabel{commands/apidoc/src:src.__init__.read_config_from_a_file}{{4.1.1}{25}{\texttt {src} Package}{section*.56}{}} +\newlabel{commands/apidoc/src:src.__init__.remove_item_from_list}{{4.1.1}{25}{\texttt {src} Package}{section*.57}{}} +\newlabel{commands/apidoc/src:src.__init__.replace_in_file}{{4.1.1}{25}{\texttt {src} Package}{section*.58}{}} +\@writefile{toc}{\contentsline {subsubsection}{\texttt {ElementTree} Module}{25}{subsubsection*.59}} +\newlabel{commands/apidoc/src:elementtree-module}{{4.1.1}{25}{\texttt {ElementTree} Module}{subsubsection*.59}{}} +\newlabel{commands/apidoc/src:module-src.ElementTree}{{4.1.1}{25}{\texttt {ElementTree} Module}{subsubsection*.59}{}} +\newlabel{commands/apidoc/src:src.ElementTree.Comment}{{4.1.1}{25}{\texttt {ElementTree} Module}{section*.60}{}} +\newlabel{commands/apidoc/src:src.ElementTree.dump}{{4.1.1}{25}{\texttt {ElementTree} Module}{section*.61}{}} +\newlabel{commands/apidoc/src:src.ElementTree.Element}{{4.1.1}{25}{\texttt {ElementTree} Module}{section*.62}{}} +\newlabel{commands/apidoc/src:src.ElementTree.ElementTree}{{4.1.1}{25}{\texttt {ElementTree} Module}{section*.63}{}} +\newlabel{commands/apidoc/src:src.ElementTree.ElementTree.find}{{4.1.1}{25}{\texttt {ElementTree} Module}{section*.64}{}} +\newlabel{commands/apidoc/src:src.ElementTree.ElementTree.findall}{{4.1.1}{25}{\texttt {ElementTree} Module}{section*.65}{}} +\newlabel{commands/apidoc/src:src.ElementTree.ElementTree.findtext}{{4.1.1}{26}{\texttt {ElementTree} Module}{section*.66}{}} +\newlabel{commands/apidoc/src:src.ElementTree.ElementTree.getiterator}{{4.1.1}{26}{\texttt {ElementTree} Module}{section*.67}{}} +\newlabel{commands/apidoc/src:src.ElementTree.ElementTree.getroot}{{4.1.1}{26}{\texttt {ElementTree} Module}{section*.68}{}} +\newlabel{commands/apidoc/src:src.ElementTree.ElementTree.parse}{{4.1.1}{26}{\texttt {ElementTree} Module}{section*.69}{}} +\newlabel{commands/apidoc/src:src.ElementTree.ElementTree.write}{{4.1.1}{26}{\texttt {ElementTree} Module}{section*.70}{}} +\newlabel{commands/apidoc/src:src.ElementTree.fromstring}{{4.1.1}{26}{\texttt {ElementTree} Module}{section*.71}{}} +\newlabel{commands/apidoc/src:src.ElementTree.iselement}{{4.1.1}{26}{\texttt {ElementTree} Module}{section*.72}{}} +\newlabel{commands/apidoc/src:src.ElementTree.iterparse}{{4.1.1}{26}{\texttt {ElementTree} Module}{section*.73}{}} +\newlabel{commands/apidoc/src:src.ElementTree.iterparse.next}{{4.1.1}{26}{\texttt {ElementTree} Module}{section*.74}{}} +\newlabel{commands/apidoc/src:src.ElementTree.parse}{{4.1.1}{26}{\texttt {ElementTree} Module}{section*.75}{}} +\newlabel{commands/apidoc/src:src.ElementTree.PI}{{4.1.1}{26}{\texttt {ElementTree} Module}{section*.76}{}} +\newlabel{commands/apidoc/src:src.ElementTree.ProcessingInstruction}{{4.1.1}{26}{\texttt {ElementTree} Module}{section*.77}{}} +\newlabel{commands/apidoc/src:src.ElementTree.QName}{{4.1.1}{26}{\texttt {ElementTree} Module}{section*.78}{}} +\newlabel{commands/apidoc/src:src.ElementTree.SubElement}{{4.1.1}{26}{\texttt {ElementTree} Module}{section*.79}{}} +\newlabel{commands/apidoc/src:src.ElementTree.tostring}{{4.1.1}{26}{\texttt {ElementTree} Module}{section*.80}{}} +\newlabel{commands/apidoc/src:src.ElementTree.TreeBuilder}{{4.1.1}{26}{\texttt {ElementTree} Module}{section*.81}{}} +\newlabel{commands/apidoc/src:src.ElementTree.TreeBuilder.close}{{4.1.1}{26}{\texttt {ElementTree} Module}{section*.82}{}} +\newlabel{commands/apidoc/src:src.ElementTree.TreeBuilder.data}{{4.1.1}{26}{\texttt {ElementTree} Module}{section*.83}{}} +\newlabel{commands/apidoc/src:src.ElementTree.TreeBuilder.end}{{4.1.1}{26}{\texttt {ElementTree} Module}{section*.84}{}} +\newlabel{commands/apidoc/src:src.ElementTree.TreeBuilder.start}{{4.1.1}{26}{\texttt {ElementTree} Module}{section*.85}{}} +\newlabel{commands/apidoc/src:src.ElementTree.XML}{{4.1.1}{26}{\texttt {ElementTree} Module}{section*.86}{}} +\newlabel{commands/apidoc/src:src.ElementTree.XMLTreeBuilder}{{4.1.1}{26}{\texttt {ElementTree} Module}{section*.87}{}} +\newlabel{commands/apidoc/src:src.ElementTree.XMLTreeBuilder.close}{{4.1.1}{26}{\texttt {ElementTree} Module}{section*.88}{}} +\newlabel{commands/apidoc/src:src.ElementTree.XMLTreeBuilder.doctype}{{4.1.1}{26}{\texttt {ElementTree} Module}{section*.89}{}} +\newlabel{commands/apidoc/src:src.ElementTree.XMLTreeBuilder.feed}{{4.1.1}{26}{\texttt {ElementTree} Module}{section*.90}{}} +\@writefile{toc}{\contentsline {subsubsection}{\texttt {architecture} Module}{26}{subsubsection*.91}} +\newlabel{commands/apidoc/src:architecture-module}{{4.1.1}{26}{\texttt {architecture} Module}{subsubsection*.91}{}} +\newlabel{commands/apidoc/src:module-src.architecture}{{4.1.1}{26}{\texttt {architecture} Module}{subsubsection*.91}{}} +\newlabel{commands/apidoc/src:src.architecture.get_distrib_version}{{4.1.1}{26}{\texttt {architecture} Module}{section*.92}{}} +\newlabel{commands/apidoc/src:src.architecture.get_distribution}{{4.1.1}{26}{\texttt {architecture} Module}{section*.93}{}} +\newlabel{commands/apidoc/src:src.architecture.get_nb_proc}{{4.1.1}{27}{\texttt {architecture} Module}{section*.94}{}} +\newlabel{commands/apidoc/src:src.architecture.get_python_version}{{4.1.1}{27}{\texttt {architecture} Module}{section*.95}{}} +\newlabel{commands/apidoc/src:src.architecture.get_user}{{4.1.1}{27}{\texttt {architecture} Module}{section*.96}{}} +\newlabel{commands/apidoc/src:src.architecture.is_windows}{{4.1.1}{27}{\texttt {architecture} Module}{section*.97}{}} +\@writefile{toc}{\contentsline {subsubsection}{\texttt {compilation} Module}{27}{subsubsection*.98}} +\newlabel{commands/apidoc/src:module-src.compilation}{{4.1.1}{27}{\texttt {compilation} Module}{subsubsection*.98}{}} +\newlabel{commands/apidoc/src:compilation-module}{{4.1.1}{27}{\texttt {compilation} Module}{subsubsection*.98}{}} +\newlabel{commands/apidoc/src:src.compilation.Builder}{{4.1.1}{27}{\texttt {compilation} Module}{section*.99}{}} +\newlabel{commands/apidoc/src:src.compilation.Builder.build_configure}{{4.1.1}{27}{\texttt {compilation} Module}{section*.100}{}} +\newlabel{commands/apidoc/src:src.compilation.Builder.check}{{4.1.1}{27}{\texttt {compilation} Module}{section*.101}{}} +\newlabel{commands/apidoc/src:src.compilation.Builder.cmake}{{4.1.1}{27}{\texttt {compilation} Module}{section*.102}{}} +\newlabel{commands/apidoc/src:src.compilation.Builder.complete_environment}{{4.1.1}{27}{\texttt {compilation} Module}{section*.103}{}} +\newlabel{commands/apidoc/src:src.compilation.Builder.configure}{{4.1.1}{27}{\texttt {compilation} Module}{section*.104}{}} +\newlabel{commands/apidoc/src:src.compilation.Builder.do_batch_script_build}{{4.1.1}{27}{\texttt {compilation} Module}{section*.105}{}} +\newlabel{commands/apidoc/src:src.compilation.Builder.do_default_build}{{4.1.1}{27}{\texttt {compilation} Module}{section*.106}{}} +\newlabel{commands/apidoc/src:src.compilation.Builder.do_python_script_build}{{4.1.1}{27}{\texttt {compilation} Module}{section*.107}{}} +\newlabel{commands/apidoc/src:src.compilation.Builder.do_script_build}{{4.1.1}{27}{\texttt {compilation} Module}{section*.108}{}} +\newlabel{commands/apidoc/src:src.compilation.Builder.hack_libtool}{{4.1.1}{27}{\texttt {compilation} Module}{section*.109}{}} +\newlabel{commands/apidoc/src:src.compilation.Builder.install}{{4.1.1}{27}{\texttt {compilation} Module}{section*.110}{}} +\newlabel{commands/apidoc/src:src.compilation.Builder.log}{{4.1.1}{27}{\texttt {compilation} Module}{section*.111}{}} +\newlabel{commands/apidoc/src:src.compilation.Builder.log_command}{{4.1.1}{27}{\texttt {compilation} Module}{section*.112}{}} +\newlabel{commands/apidoc/src:src.compilation.Builder.make}{{4.1.1}{27}{\texttt {compilation} Module}{section*.113}{}} +\newlabel{commands/apidoc/src:src.compilation.Builder.prepare}{{4.1.1}{27}{\texttt {compilation} Module}{section*.114}{}} +\newlabel{commands/apidoc/src:src.compilation.Builder.put_txt_log_in_appli_log_dir}{{4.1.1}{27}{\texttt {compilation} Module}{section*.115}{}} +\newlabel{commands/apidoc/src:src.compilation.Builder.wmake}{{4.1.1}{28}{\texttt {compilation} Module}{section*.116}{}} +\@writefile{toc}{\contentsline {subsubsection}{\texttt {debug} Module}{28}{subsubsection*.117}} +\newlabel{commands/apidoc/src:module-src.debug}{{4.1.1}{28}{\texttt {debug} Module}{subsubsection*.117}{}} +\newlabel{commands/apidoc/src:debug-module}{{4.1.1}{28}{\texttt {debug} Module}{subsubsection*.117}{}} +\newlabel{commands/apidoc/src:src.debug.InStream}{{4.1.1}{28}{\texttt {debug} Module}{section*.118}{}} +\newlabel{commands/apidoc/src:src.debug.OutStream}{{4.1.1}{28}{\texttt {debug} Module}{section*.119}{}} +\newlabel{commands/apidoc/src:src.debug.OutStream.close}{{4.1.1}{28}{\texttt {debug} Module}{section*.120}{}} +\newlabel{commands/apidoc/src:src.debug.getLocalEnv}{{4.1.1}{28}{\texttt {debug} Module}{section*.121}{}} +\newlabel{commands/apidoc/src:src.debug.getStrConfigDbg}{{4.1.1}{28}{\texttt {debug} Module}{section*.122}{}} +\newlabel{commands/apidoc/src:src.debug.getStrConfigStd}{{4.1.1}{28}{\texttt {debug} Module}{section*.123}{}} +\newlabel{commands/apidoc/src:src.debug.indent}{{4.1.1}{28}{\texttt {debug} Module}{section*.124}{}} +\newlabel{commands/apidoc/src:src.debug.pop_debug}{{4.1.1}{28}{\texttt {debug} Module}{section*.125}{}} +\newlabel{commands/apidoc/src:src.debug.push_debug}{{4.1.1}{28}{\texttt {debug} Module}{section*.126}{}} +\newlabel{commands/apidoc/src:src.debug.saveConfigDbg}{{4.1.1}{28}{\texttt {debug} Module}{section*.127}{}} +\newlabel{commands/apidoc/src:src.debug.saveConfigStd}{{4.1.1}{28}{\texttt {debug} Module}{section*.128}{}} +\newlabel{commands/apidoc/src:src.debug.tofix}{{4.1.1}{29}{\texttt {debug} Module}{section*.129}{}} +\newlabel{commands/apidoc/src:src.debug.write}{{4.1.1}{29}{\texttt {debug} Module}{section*.130}{}} +\@writefile{toc}{\contentsline {subsubsection}{\texttt {environment} Module}{29}{subsubsection*.131}} +\newlabel{commands/apidoc/src:environment-module}{{4.1.1}{29}{\texttt {environment} Module}{subsubsection*.131}{}} +\newlabel{commands/apidoc/src:module-src.environment}{{4.1.1}{29}{\texttt {environment} Module}{subsubsection*.131}{}} +\newlabel{commands/apidoc/src:src.environment.Environ}{{4.1.1}{29}{\texttt {environment} Module}{section*.132}{}} +\newlabel{commands/apidoc/src:src.environment.Environ.append}{{4.1.1}{29}{\texttt {environment} Module}{section*.133}{}} +\newlabel{commands/apidoc/src:src.environment.Environ.append_value}{{4.1.1}{29}{\texttt {environment} Module}{section*.134}{}} +\newlabel{commands/apidoc/src:src.environment.Environ.command_value}{{4.1.1}{29}{\texttt {environment} Module}{section*.135}{}} +\newlabel{commands/apidoc/src:src.environment.Environ.get}{{4.1.1}{29}{\texttt {environment} Module}{section*.136}{}} +\newlabel{commands/apidoc/src:src.environment.Environ.is_defined}{{4.1.1}{29}{\texttt {environment} Module}{section*.137}{}} +\newlabel{commands/apidoc/src:src.environment.Environ.prepend}{{4.1.1}{29}{\texttt {environment} Module}{section*.138}{}} +\newlabel{commands/apidoc/src:src.environment.Environ.prepend_value}{{4.1.1}{29}{\texttt {environment} Module}{section*.139}{}} +\newlabel{commands/apidoc/src:src.environment.Environ.set}{{4.1.1}{30}{\texttt {environment} Module}{section*.140}{}} +\newlabel{commands/apidoc/src:src.environment.FileEnvWriter}{{4.1.1}{30}{\texttt {environment} Module}{section*.141}{}} +\newlabel{commands/apidoc/src:src.environment.FileEnvWriter.write_cfgForPy_file}{{4.1.1}{30}{\texttt {environment} Module}{section*.142}{}} +\newlabel{commands/apidoc/src:src.environment.FileEnvWriter.write_env_file}{{4.1.1}{30}{\texttt {environment} Module}{section*.143}{}} +\newlabel{commands/apidoc/src:src.environment.SalomeEnviron}{{4.1.1}{30}{\texttt {environment} Module}{section*.144}{}} +\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.add_comment}{{4.1.1}{30}{\texttt {environment} Module}{section*.145}{}} +\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.add_line}{{4.1.1}{30}{\texttt {environment} Module}{section*.146}{}} +\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.add_warning}{{4.1.1}{30}{\texttt {environment} Module}{section*.147}{}} +\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.append}{{4.1.1}{30}{\texttt {environment} Module}{section*.148}{}} +\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.dump}{{4.1.1}{30}{\texttt {environment} Module}{section*.149}{}} +\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.finish}{{4.1.1}{31}{\texttt {environment} Module}{section*.150}{}} +\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.get}{{4.1.1}{31}{\texttt {environment} Module}{section*.151}{}} +\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.get_names}{{4.1.1}{31}{\texttt {environment} Module}{section*.152}{}} +\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.is_defined}{{4.1.1}{31}{\texttt {environment} Module}{section*.153}{}} +\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.load_cfg_environment}{{4.1.1}{31}{\texttt {environment} Module}{section*.154}{}} +\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.prepend}{{4.1.1}{31}{\texttt {environment} Module}{section*.155}{}} +\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.run_env_script}{{4.1.1}{31}{\texttt {environment} Module}{section*.156}{}} +\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.run_simple_env_script}{{4.1.1}{31}{\texttt {environment} Module}{section*.157}{}} +\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.set}{{4.1.1}{31}{\texttt {environment} Module}{section*.158}{}} +\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.set_a_product}{{4.1.1}{31}{\texttt {environment} Module}{section*.159}{}} +\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.set_application_env}{{4.1.1}{32}{\texttt {environment} Module}{section*.160}{}} +\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.set_cpp_env}{{4.1.1}{32}{\texttt {environment} Module}{section*.161}{}} +\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.set_full_environ}{{4.1.1}{32}{\texttt {environment} Module}{section*.162}{}} +\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.set_products}{{4.1.1}{32}{\texttt {environment} Module}{section*.163}{}} +\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.set_python_libdirs}{{4.1.1}{32}{\texttt {environment} Module}{section*.164}{}} +\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.set_salome_generic_product_env}{{4.1.1}{32}{\texttt {environment} Module}{section*.165}{}} +\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.set_salome_minimal_product_env}{{4.1.1}{32}{\texttt {environment} Module}{section*.166}{}} +\newlabel{commands/apidoc/src:src.environment.Shell}{{4.1.1}{32}{\texttt {environment} Module}{section*.167}{}} +\newlabel{commands/apidoc/src:src.environment.load_environment}{{4.1.1}{32}{\texttt {environment} Module}{section*.168}{}} +\@writefile{toc}{\contentsline {subsubsection}{\texttt {fileEnviron} Module}{33}{subsubsection*.169}} +\newlabel{commands/apidoc/src:fileenviron-module}{{4.1.1}{33}{\texttt {fileEnviron} Module}{subsubsection*.169}{}} +\newlabel{commands/apidoc/src:module-src.fileEnviron}{{4.1.1}{33}{\texttt {fileEnviron} Module}{subsubsection*.169}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.BashFileEnviron}{{4.1.1}{33}{\texttt {fileEnviron} Module}{section*.170}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.BashFileEnviron.command_value}{{4.1.1}{33}{\texttt {fileEnviron} Module}{section*.171}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.BashFileEnviron.finish}{{4.1.1}{33}{\texttt {fileEnviron} Module}{section*.172}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.BashFileEnviron.set}{{4.1.1}{33}{\texttt {fileEnviron} Module}{section*.173}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.BatFileEnviron}{{4.1.1}{33}{\texttt {fileEnviron} Module}{section*.174}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.BatFileEnviron.add_comment}{{4.1.1}{33}{\texttt {fileEnviron} Module}{section*.175}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.BatFileEnviron.command_value}{{4.1.1}{33}{\texttt {fileEnviron} Module}{section*.176}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.BatFileEnviron.finish}{{4.1.1}{33}{\texttt {fileEnviron} Module}{section*.177}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.BatFileEnviron.get}{{4.1.1}{33}{\texttt {fileEnviron} Module}{section*.178}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.BatFileEnviron.set}{{4.1.1}{33}{\texttt {fileEnviron} Module}{section*.179}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.ContextFileEnviron}{{4.1.1}{33}{\texttt {fileEnviron} Module}{section*.180}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.add_echo}{{4.1.1}{34}{\texttt {fileEnviron} Module}{section*.181}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.add_warning}{{4.1.1}{34}{\texttt {fileEnviron} Module}{section*.182}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.append_value}{{4.1.1}{34}{\texttt {fileEnviron} Module}{section*.183}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.command_value}{{4.1.1}{34}{\texttt {fileEnviron} Module}{section*.184}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.finish}{{4.1.1}{34}{\texttt {fileEnviron} Module}{section*.185}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.get}{{4.1.1}{34}{\texttt {fileEnviron} Module}{section*.186}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.prepend_value}{{4.1.1}{34}{\texttt {fileEnviron} Module}{section*.187}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.set}{{4.1.1}{34}{\texttt {fileEnviron} Module}{section*.188}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron}{{4.1.1}{34}{\texttt {fileEnviron} Module}{section*.189}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.add_comment}{{4.1.1}{34}{\texttt {fileEnviron} Module}{section*.190}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.add_echo}{{4.1.1}{35}{\texttt {fileEnviron} Module}{section*.191}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.add_line}{{4.1.1}{35}{\texttt {fileEnviron} Module}{section*.192}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.add_warning}{{4.1.1}{35}{\texttt {fileEnviron} Module}{section*.193}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.append}{{4.1.1}{35}{\texttt {fileEnviron} Module}{section*.194}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.append_value}{{4.1.1}{35}{\texttt {fileEnviron} Module}{section*.195}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.command_value}{{4.1.1}{35}{\texttt {fileEnviron} Module}{section*.196}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.finish}{{4.1.1}{35}{\texttt {fileEnviron} Module}{section*.197}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.get}{{4.1.1}{35}{\texttt {fileEnviron} Module}{section*.198}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.is_defined}{{4.1.1}{35}{\texttt {fileEnviron} Module}{section*.199}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.prepend}{{4.1.1}{35}{\texttt {fileEnviron} Module}{section*.200}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.prepend_value}{{4.1.1}{36}{\texttt {fileEnviron} Module}{section*.201}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.set}{{4.1.1}{36}{\texttt {fileEnviron} Module}{section*.202}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron}{{4.1.1}{36}{\texttt {fileEnviron} Module}{section*.203}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add}{{4.1.1}{36}{\texttt {fileEnviron} Module}{section*.204}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add_comment}{{4.1.1}{36}{\texttt {fileEnviron} Module}{section*.205}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add_echo}{{4.1.1}{36}{\texttt {fileEnviron} Module}{section*.206}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add_line}{{4.1.1}{36}{\texttt {fileEnviron} Module}{section*.207}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add_warning}{{4.1.1}{36}{\texttt {fileEnviron} Module}{section*.208}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.append}{{4.1.1}{36}{\texttt {fileEnviron} Module}{section*.209}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.append_value}{{4.1.1}{36}{\texttt {fileEnviron} Module}{section*.210}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.change_to_launcher}{{4.1.1}{36}{\texttt {fileEnviron} Module}{section*.211}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.command_value}{{4.1.1}{36}{\texttt {fileEnviron} Module}{section*.212}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.finish}{{4.1.1}{37}{\texttt {fileEnviron} Module}{section*.213}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.get}{{4.1.1}{37}{\texttt {fileEnviron} Module}{section*.214}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.is_defined}{{4.1.1}{37}{\texttt {fileEnviron} Module}{section*.215}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.prepend}{{4.1.1}{37}{\texttt {fileEnviron} Module}{section*.216}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.prepend_value}{{4.1.1}{37}{\texttt {fileEnviron} Module}{section*.217}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.set}{{4.1.1}{37}{\texttt {fileEnviron} Module}{section*.218}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron}{{4.1.1}{37}{\texttt {fileEnviron} Module}{section*.219}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron.add_comment}{{4.1.1}{37}{\texttt {fileEnviron} Module}{section*.220}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron.add_echo}{{4.1.1}{37}{\texttt {fileEnviron} Module}{section*.221}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron.add_line}{{4.1.1}{37}{\texttt {fileEnviron} Module}{section*.222}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron.add_warning}{{4.1.1}{37}{\texttt {fileEnviron} Module}{section*.223}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron.append}{{4.1.1}{37}{\texttt {fileEnviron} Module}{section*.224}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron.command_value}{{4.1.1}{37}{\texttt {fileEnviron} Module}{section*.225}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron.get}{{4.1.1}{37}{\texttt {fileEnviron} Module}{section*.226}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron.is_defined}{{4.1.1}{37}{\texttt {fileEnviron} Module}{section*.227}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron.prepend}{{4.1.1}{37}{\texttt {fileEnviron} Module}{section*.228}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron.run_env_script}{{4.1.1}{38}{\texttt {fileEnviron} Module}{section*.229}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron.set}{{4.1.1}{38}{\texttt {fileEnviron} Module}{section*.230}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron.write}{{4.1.1}{38}{\texttt {fileEnviron} Module}{section*.231}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.get_file_environ}{{4.1.1}{38}{\texttt {fileEnviron} Module}{section*.232}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.special_path_separator}{{4.1.1}{38}{\texttt {fileEnviron} Module}{section*.233}{}} +\@writefile{toc}{\contentsline {subsubsection}{\texttt {fork} Module}{38}{subsubsection*.234}} +\newlabel{commands/apidoc/src:fork-module}{{4.1.1}{38}{\texttt {fork} Module}{subsubsection*.234}{}} +\newlabel{commands/apidoc/src:module-src.fork}{{4.1.1}{38}{\texttt {fork} Module}{subsubsection*.234}{}} +\newlabel{commands/apidoc/src:src.fork.batch}{{4.1.1}{38}{\texttt {fork} Module}{section*.235}{}} +\newlabel{commands/apidoc/src:src.fork.batch_salome}{{4.1.1}{38}{\texttt {fork} Module}{section*.236}{}} +\newlabel{commands/apidoc/src:src.fork.launch_command}{{4.1.1}{38}{\texttt {fork} Module}{section*.237}{}} +\newlabel{commands/apidoc/src:src.fork.show_progress}{{4.1.1}{38}{\texttt {fork} Module}{section*.238}{}} +\newlabel{commands/apidoc/src:src.fork.write_back}{{4.1.1}{38}{\texttt {fork} Module}{section*.239}{}} +\@writefile{toc}{\contentsline {subsubsection}{\texttt {logger} Module}{38}{subsubsection*.240}} +\newlabel{commands/apidoc/src:logger-module}{{4.1.1}{38}{\texttt {logger} Module}{subsubsection*.240}{}} +\newlabel{commands/apidoc/src:module-src.logger}{{4.1.1}{38}{\texttt {logger} Module}{subsubsection*.240}{}} +\newlabel{commands/apidoc/src:src.logger.Logger}{{4.1.1}{38}{\texttt {logger} Module}{section*.241}{}} +\newlabel{commands/apidoc/src:src.logger.Logger.add_link}{{4.1.1}{38}{\texttt {logger} Module}{section*.242}{}} +\newlabel{commands/apidoc/src:src.logger.Logger.end_write}{{4.1.1}{39}{\texttt {logger} Module}{section*.243}{}} +\newlabel{commands/apidoc/src:src.logger.Logger.error}{{4.1.1}{39}{\texttt {logger} Module}{section*.244}{}} +\newlabel{commands/apidoc/src:src.logger.Logger.flush}{{4.1.1}{39}{\texttt {logger} Module}{section*.245}{}} +\newlabel{commands/apidoc/src:src.logger.Logger.put_initial_xml_fields}{{4.1.1}{39}{\texttt {logger} Module}{section*.246}{}} +\newlabel{commands/apidoc/src:src.logger.Logger.write}{{4.1.1}{39}{\texttt {logger} Module}{section*.247}{}} +\newlabel{commands/apidoc/src:src.logger.date_to_datetime}{{4.1.1}{39}{\texttt {logger} Module}{section*.248}{}} +\newlabel{commands/apidoc/src:src.logger.list_log_file}{{4.1.1}{39}{\texttt {logger} Module}{section*.249}{}} +\newlabel{commands/apidoc/src:src.logger.show_command_log}{{4.1.1}{39}{\texttt {logger} Module}{section*.250}{}} +\newlabel{commands/apidoc/src:src.logger.timedelta_total_seconds}{{4.1.1}{40}{\texttt {logger} Module}{section*.251}{}} +\newlabel{commands/apidoc/src:src.logger.update_hat_xml}{{4.1.1}{40}{\texttt {logger} Module}{section*.252}{}} +\@writefile{toc}{\contentsline {subsubsection}{\texttt {options} Module}{40}{subsubsection*.253}} +\newlabel{commands/apidoc/src:module-src.options}{{4.1.1}{40}{\texttt {options} Module}{subsubsection*.253}{}} +\newlabel{commands/apidoc/src:options-module}{{4.1.1}{40}{\texttt {options} Module}{subsubsection*.253}{}} +\newlabel{commands/apidoc/src:src.options.OptResult}{{4.1.1}{40}{\texttt {options} Module}{section*.254}{}} +\newlabel{commands/apidoc/src:src.options.Options}{{4.1.1}{40}{\texttt {options} Module}{section*.255}{}} +\newlabel{commands/apidoc/src:src.options.Options.add_option}{{4.1.1}{40}{\texttt {options} Module}{section*.256}{}} +\newlabel{commands/apidoc/src:src.options.Options.parse_args}{{4.1.1}{40}{\texttt {options} Module}{section*.257}{}} +\newlabel{commands/apidoc/src:src.options.Options.print_help}{{4.1.1}{40}{\texttt {options} Module}{section*.258}{}} +\@writefile{toc}{\contentsline {subsubsection}{\texttt {printcolors} Module}{41}{subsubsection*.259}} +\newlabel{commands/apidoc/src:printcolors-module}{{4.1.1}{41}{\texttt {printcolors} Module}{subsubsection*.259}{}} +\newlabel{commands/apidoc/src:module-src.printcolors}{{4.1.1}{41}{\texttt {printcolors} Module}{subsubsection*.259}{}} +\newlabel{commands/apidoc/src:src.printcolors.cleancolor}{{4.1.1}{41}{\texttt {printcolors} Module}{section*.260}{}} +\newlabel{commands/apidoc/src:src.printcolors.print_color_map}{{4.1.1}{41}{\texttt {printcolors} Module}{section*.261}{}} +\newlabel{commands/apidoc/src:src.printcolors.print_color_range}{{4.1.1}{41}{\texttt {printcolors} Module}{section*.262}{}} +\newlabel{commands/apidoc/src:src.printcolors.print_value}{{4.1.1}{41}{\texttt {printcolors} Module}{section*.263}{}} +\newlabel{commands/apidoc/src:src.printcolors.printc}{{4.1.1}{41}{\texttt {printcolors} Module}{section*.264}{}} +\newlabel{commands/apidoc/src:src.printcolors.printcError}{{4.1.1}{41}{\texttt {printcolors} Module}{section*.265}{}} +\newlabel{commands/apidoc/src:src.printcolors.printcHeader}{{4.1.1}{41}{\texttt {printcolors} Module}{section*.266}{}} +\newlabel{commands/apidoc/src:src.printcolors.printcHighlight}{{4.1.1}{41}{\texttt {printcolors} Module}{section*.267}{}} +\newlabel{commands/apidoc/src:src.printcolors.printcInfo}{{4.1.1}{42}{\texttt {printcolors} Module}{section*.268}{}} +\newlabel{commands/apidoc/src:src.printcolors.printcLabel}{{4.1.1}{42}{\texttt {printcolors} Module}{section*.269}{}} +\newlabel{commands/apidoc/src:src.printcolors.printcSuccess}{{4.1.1}{42}{\texttt {printcolors} Module}{section*.270}{}} +\newlabel{commands/apidoc/src:src.printcolors.printcWarning}{{4.1.1}{42}{\texttt {printcolors} Module}{section*.271}{}} +\@writefile{toc}{\contentsline {subsubsection}{\texttt {product} Module}{42}{subsubsection*.272}} +\newlabel{commands/apidoc/src:module-src.product}{{4.1.1}{42}{\texttt {product} Module}{subsubsection*.272}{}} +\newlabel{commands/apidoc/src:product-module}{{4.1.1}{42}{\texttt {product} Module}{subsubsection*.272}{}} +\newlabel{commands/apidoc/src:src.product.check_config_exists}{{4.1.1}{42}{\texttt {product} Module}{section*.273}{}} +\newlabel{commands/apidoc/src:src.product.check_installation}{{4.1.1}{42}{\texttt {product} Module}{section*.274}{}} +\newlabel{commands/apidoc/src:src.product.check_source}{{4.1.1}{43}{\texttt {product} Module}{section*.275}{}} +\newlabel{commands/apidoc/src:src.product.get_base_install_dir}{{4.1.1}{43}{\texttt {product} Module}{section*.276}{}} +\newlabel{commands/apidoc/src:src.product.get_install_dir}{{4.1.1}{43}{\texttt {product} Module}{section*.277}{}} +\newlabel{commands/apidoc/src:src.product.get_product_components}{{4.1.1}{43}{\texttt {product} Module}{section*.278}{}} +\newlabel{commands/apidoc/src:src.product.get_product_config}{{4.1.1}{43}{\texttt {product} Module}{section*.279}{}} +\newlabel{commands/apidoc/src:src.product.get_product_dependencies}{{4.1.1}{43}{\texttt {product} Module}{section*.280}{}} +\newlabel{commands/apidoc/src:src.product.get_product_section}{{4.1.1}{44}{\texttt {product} Module}{section*.281}{}} +\newlabel{commands/apidoc/src:src.product.get_products_infos}{{4.1.1}{44}{\texttt {product} Module}{section*.282}{}} +\newlabel{commands/apidoc/src:src.product.product_compiles}{{4.1.1}{44}{\texttt {product} Module}{section*.283}{}} +\newlabel{commands/apidoc/src:src.product.product_has_env_script}{{4.1.1}{44}{\texttt {product} Module}{section*.284}{}} +\newlabel{commands/apidoc/src:src.product.product_has_logo}{{4.1.1}{44}{\texttt {product} Module}{section*.285}{}} +\newlabel{commands/apidoc/src:src.product.product_has_patches}{{4.1.1}{44}{\texttt {product} Module}{section*.286}{}} +\newlabel{commands/apidoc/src:src.product.product_has_salome_gui}{{4.1.1}{44}{\texttt {product} Module}{section*.287}{}} +\newlabel{commands/apidoc/src:src.product.product_has_script}{{4.1.1}{45}{\texttt {product} Module}{section*.288}{}} +\newlabel{commands/apidoc/src:src.product.product_is_autotools}{{4.1.1}{45}{\texttt {product} Module}{section*.289}{}} +\newlabel{commands/apidoc/src:src.product.product_is_cmake}{{4.1.1}{45}{\texttt {product} Module}{section*.290}{}} +\newlabel{commands/apidoc/src:src.product.product_is_cpp}{{4.1.1}{45}{\texttt {product} Module}{section*.291}{}} +\newlabel{commands/apidoc/src:src.product.product_is_debug}{{4.1.1}{45}{\texttt {product} Module}{section*.292}{}} +\newlabel{commands/apidoc/src:src.product.product_is_dev}{{4.1.1}{45}{\texttt {product} Module}{section*.293}{}} +\newlabel{commands/apidoc/src:src.product.product_is_fixed}{{4.1.1}{45}{\texttt {product} Module}{section*.294}{}} +\newlabel{commands/apidoc/src:src.product.product_is_generated}{{4.1.1}{45}{\texttt {product} Module}{section*.295}{}} +\newlabel{commands/apidoc/src:src.product.product_is_mpi}{{4.1.1}{46}{\texttt {product} Module}{section*.296}{}} +\newlabel{commands/apidoc/src:src.product.product_is_native}{{4.1.1}{46}{\texttt {product} Module}{section*.297}{}} +\newlabel{commands/apidoc/src:src.product.product_is_salome}{{4.1.1}{46}{\texttt {product} Module}{section*.298}{}} +\newlabel{commands/apidoc/src:src.product.product_is_sample}{{4.1.1}{46}{\texttt {product} Module}{section*.299}{}} +\newlabel{commands/apidoc/src:src.product.product_is_smesh_plugin}{{4.1.1}{46}{\texttt {product} Module}{section*.300}{}} +\newlabel{commands/apidoc/src:src.product.product_is_vcs}{{4.1.1}{46}{\texttt {product} Module}{section*.301}{}} +\@writefile{toc}{\contentsline {subsubsection}{\texttt {pyconf} Module}{46}{subsubsection*.302}} +\newlabel{commands/apidoc/src:pyconf-module}{{4.1.1}{46}{\texttt {pyconf} Module}{subsubsection*.302}{}} +\newlabel{commands/apidoc/src:module-src.pyconf}{{4.1.1}{46}{\texttt {pyconf} Module}{subsubsection*.302}{}} +\newlabel{commands/apidoc/src:src.pyconf.Config}{{4.1.1}{47}{\texttt {pyconf} Module}{section*.303}{}} +\newlabel{commands/apidoc/src:src.pyconf.Config.Namespace}{{4.1.1}{47}{\texttt {pyconf} Module}{section*.304}{}} +\newlabel{commands/apidoc/src:src.pyconf.Config.addNamespace}{{4.1.1}{47}{\texttt {pyconf} Module}{section*.305}{}} +\newlabel{commands/apidoc/src:src.pyconf.Config.getByPath}{{4.1.1}{48}{\texttt {pyconf} Module}{section*.306}{}} +\newlabel{commands/apidoc/src:src.pyconf.Config.load}{{4.1.1}{48}{\texttt {pyconf} Module}{section*.307}{}} +\newlabel{commands/apidoc/src:src.pyconf.Config.removeNamespace}{{4.1.1}{48}{\texttt {pyconf} Module}{section*.308}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigError}{{4.1.1}{48}{\texttt {pyconf} Module}{section*.309}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigFormatError}{{4.1.1}{48}{\texttt {pyconf} Module}{section*.310}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigInputStream}{{4.1.1}{48}{\texttt {pyconf} Module}{section*.311}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigInputStream.close}{{4.1.1}{48}{\texttt {pyconf} Module}{section*.312}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigInputStream.read}{{4.1.1}{48}{\texttt {pyconf} Module}{section*.313}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigInputStream.readline}{{4.1.1}{48}{\texttt {pyconf} Module}{section*.314}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigList}{{4.1.1}{48}{\texttt {pyconf} Module}{section*.315}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigList.getByPath}{{4.1.1}{48}{\texttt {pyconf} Module}{section*.316}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigMerger}{{4.1.1}{48}{\texttt {pyconf} Module}{section*.317}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigMerger.handleMismatch}{{4.1.1}{48}{\texttt {pyconf} Module}{section*.318}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigMerger.merge}{{4.1.1}{48}{\texttt {pyconf} Module}{section*.319}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigMerger.mergeMapping}{{4.1.1}{49}{\texttt {pyconf} Module}{section*.320}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigMerger.mergeSequence}{{4.1.1}{49}{\texttt {pyconf} Module}{section*.321}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigMerger.overwriteKeys}{{4.1.1}{49}{\texttt {pyconf} Module}{section*.322}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigOutputStream}{{4.1.1}{49}{\texttt {pyconf} Module}{section*.323}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigOutputStream.close}{{4.1.1}{49}{\texttt {pyconf} Module}{section*.324}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigOutputStream.flush}{{4.1.1}{49}{\texttt {pyconf} Module}{section*.325}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigOutputStream.write}{{4.1.1}{49}{\texttt {pyconf} Module}{section*.326}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigReader}{{4.1.1}{49}{\texttt {pyconf} Module}{section*.327}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.getChar}{{4.1.1}{49}{\texttt {pyconf} Module}{section*.328}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.getToken}{{4.1.1}{49}{\texttt {pyconf} Module}{section*.329}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.load}{{4.1.1}{49}{\texttt {pyconf} Module}{section*.330}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.location}{{4.1.1}{49}{\texttt {pyconf} Module}{section*.331}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.match}{{4.1.1}{50}{\texttt {pyconf} Module}{section*.332}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.parseFactor}{{4.1.1}{50}{\texttt {pyconf} Module}{section*.333}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.parseKeyValuePair}{{4.1.1}{50}{\texttt {pyconf} Module}{section*.334}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.parseMapping}{{4.1.1}{50}{\texttt {pyconf} Module}{section*.335}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.parseMappingBody}{{4.1.1}{50}{\texttt {pyconf} Module}{section*.336}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.parseReference}{{4.1.1}{50}{\texttt {pyconf} Module}{section*.337}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.parseScalar}{{4.1.1}{50}{\texttt {pyconf} Module}{section*.338}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.parseSequence}{{4.1.1}{50}{\texttt {pyconf} Module}{section*.339}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.parseSuffix}{{4.1.1}{50}{\texttt {pyconf} Module}{section*.340}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.parseTerm}{{4.1.1}{50}{\texttt {pyconf} Module}{section*.341}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.parseValue}{{4.1.1}{50}{\texttt {pyconf} Module}{section*.342}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.setStream}{{4.1.1}{51}{\texttt {pyconf} Module}{section*.343}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigResolutionError}{{4.1.1}{51}{\texttt {pyconf} Module}{section*.344}{}} +\newlabel{commands/apidoc/src:src.pyconf.Container}{{4.1.1}{51}{\texttt {pyconf} Module}{section*.345}{}} +\newlabel{commands/apidoc/src:src.pyconf.Container.evaluate}{{4.1.1}{51}{\texttt {pyconf} Module}{section*.346}{}} +\newlabel{commands/apidoc/src:src.pyconf.Container.setPath}{{4.1.1}{51}{\texttt {pyconf} Module}{section*.347}{}} +\newlabel{commands/apidoc/src:src.pyconf.Container.writeToStream}{{4.1.1}{51}{\texttt {pyconf} Module}{section*.348}{}} +\newlabel{commands/apidoc/src:src.pyconf.Container.writeValue}{{4.1.1}{51}{\texttt {pyconf} Module}{section*.349}{}} +\newlabel{commands/apidoc/src:src.pyconf.Expression}{{4.1.1}{51}{\texttt {pyconf} Module}{section*.350}{}} +\newlabel{commands/apidoc/src:src.pyconf.Expression.evaluate}{{4.1.1}{51}{\texttt {pyconf} Module}{section*.351}{}} +\newlabel{commands/apidoc/src:src.pyconf.Mapping}{{4.1.1}{51}{\texttt {pyconf} Module}{section*.352}{}} +\newlabel{commands/apidoc/src:src.pyconf.Mapping.addMapping}{{4.1.1}{51}{\texttt {pyconf} Module}{section*.353}{}} +\newlabel{commands/apidoc/src:src.pyconf.Mapping.get}{{4.1.1}{52}{\texttt {pyconf} Module}{section*.354}{}} +\newlabel{commands/apidoc/src:src.pyconf.Mapping.iteritems}{{4.1.1}{52}{\texttt {pyconf} Module}{section*.355}{}} +\newlabel{commands/apidoc/src:src.pyconf.Mapping.iterkeys}{{4.1.1}{52}{\texttt {pyconf} Module}{section*.356}{}} +\newlabel{commands/apidoc/src:src.pyconf.Mapping.keys}{{4.1.1}{52}{\texttt {pyconf} Module}{section*.357}{}} +\newlabel{commands/apidoc/src:src.pyconf.Mapping.writeToStream}{{4.1.1}{52}{\texttt {pyconf} Module}{section*.358}{}} +\newlabel{commands/apidoc/src:src.pyconf.Reference}{{4.1.1}{52}{\texttt {pyconf} Module}{section*.359}{}} +\newlabel{commands/apidoc/src:src.pyconf.Reference.addElement}{{4.1.1}{52}{\texttt {pyconf} Module}{section*.360}{}} +\newlabel{commands/apidoc/src:src.pyconf.Reference.findConfig}{{4.1.1}{52}{\texttt {pyconf} Module}{section*.361}{}} +\newlabel{commands/apidoc/src:src.pyconf.Reference.resolve}{{4.1.1}{52}{\texttt {pyconf} Module}{section*.362}{}} +\newlabel{commands/apidoc/src:src.pyconf.Sequence}{{4.1.1}{52}{\texttt {pyconf} Module}{section*.363}{}} +\newlabel{commands/apidoc/src:src.pyconf.Sequence.SeqIter}{{4.1.1}{52}{\texttt {pyconf} Module}{section*.364}{}} +\newlabel{commands/apidoc/src:src.pyconf.Sequence.SeqIter.next}{{4.1.1}{52}{\texttt {pyconf} Module}{section*.365}{}} +\newlabel{commands/apidoc/src:src.pyconf.Sequence.append}{{4.1.1}{52}{\texttt {pyconf} Module}{section*.366}{}} +\newlabel{commands/apidoc/src:src.pyconf.Sequence.writeToStream}{{4.1.1}{52}{\texttt {pyconf} Module}{section*.367}{}} +\newlabel{commands/apidoc/src:src.pyconf.deepCopyMapping}{{4.1.1}{53}{\texttt {pyconf} Module}{section*.368}{}} +\newlabel{commands/apidoc/src:src.pyconf.defaultMergeResolve}{{4.1.1}{53}{\texttt {pyconf} Module}{section*.369}{}} +\newlabel{commands/apidoc/src:src.pyconf.defaultStreamOpener}{{4.1.1}{53}{\texttt {pyconf} Module}{section*.370}{}} +\newlabel{commands/apidoc/src:src.pyconf.isWord}{{4.1.1}{53}{\texttt {pyconf} Module}{section*.371}{}} +\newlabel{commands/apidoc/src:src.pyconf.makePath}{{4.1.1}{53}{\texttt {pyconf} Module}{section*.372}{}} +\newlabel{commands/apidoc/src:src.pyconf.overwriteMergeResolve}{{4.1.1}{53}{\texttt {pyconf} Module}{section*.373}{}} +\@writefile{toc}{\contentsline {subsubsection}{\texttt {system} Module}{53}{subsubsection*.374}} +\newlabel{commands/apidoc/src:system-module}{{4.1.1}{53}{\texttt {system} Module}{subsubsection*.374}{}} +\newlabel{commands/apidoc/src:module-src.system}{{4.1.1}{53}{\texttt {system} Module}{subsubsection*.374}{}} +\newlabel{commands/apidoc/src:src.system.archive_extract}{{4.1.1}{53}{\texttt {system} Module}{section*.375}{}} +\newlabel{commands/apidoc/src:src.system.cvs_extract}{{4.1.1}{54}{\texttt {system} Module}{section*.376}{}} +\newlabel{commands/apidoc/src:src.system.git_extract}{{4.1.1}{54}{\texttt {system} Module}{section*.377}{}} +\newlabel{commands/apidoc/src:src.system.show_in_editor}{{4.1.1}{54}{\texttt {system} Module}{section*.378}{}} +\newlabel{commands/apidoc/src:src.system.svn_extract}{{4.1.1}{54}{\texttt {system} Module}{section*.379}{}} +\@writefile{toc}{\contentsline {subsubsection}{\texttt {template} Module}{55}{subsubsection*.380}} +\newlabel{commands/apidoc/src:template-module}{{4.1.1}{55}{\texttt {template} Module}{subsubsection*.380}{}} +\newlabel{commands/apidoc/src:module-src.template}{{4.1.1}{55}{\texttt {template} Module}{subsubsection*.380}{}} +\newlabel{commands/apidoc/src:src.template.MyTemplate}{{4.1.1}{55}{\texttt {template} Module}{section*.381}{}} +\newlabel{commands/apidoc/src:src.template.MyTemplate.delimiter}{{4.1.1}{55}{\texttt {template} Module}{section*.382}{}} +\newlabel{commands/apidoc/src:src.template.MyTemplate.pattern}{{4.1.1}{55}{\texttt {template} Module}{section*.383}{}} +\newlabel{commands/apidoc/src:src.template.substitute}{{4.1.1}{55}{\texttt {template} Module}{section*.384}{}} +\@writefile{toc}{\contentsline {subsubsection}{\texttt {test\_module} Module}{55}{subsubsection*.385}} +\newlabel{commands/apidoc/src:module-src.test_module}{{4.1.1}{55}{\texttt {test\_module} Module}{subsubsection*.385}{}} +\newlabel{commands/apidoc/src:test-module-module}{{4.1.1}{55}{\texttt {test\_module} Module}{subsubsection*.385}{}} +\newlabel{commands/apidoc/src:src.test_module.Test}{{4.1.1}{55}{\texttt {test\_module} Module}{section*.386}{}} +\newlabel{commands/apidoc/src:src.test_module.Test.generate_launching_commands}{{4.1.1}{55}{\texttt {test\_module} Module}{section*.387}{}} +\newlabel{commands/apidoc/src:src.test_module.Test.generate_script}{{4.1.1}{55}{\texttt {test\_module} Module}{section*.388}{}} +\newlabel{commands/apidoc/src:src.test_module.Test.get_test_timeout}{{4.1.1}{55}{\texttt {test\_module} Module}{section*.389}{}} +\newlabel{commands/apidoc/src:src.test_module.Test.get_tmp_dir}{{4.1.1}{55}{\texttt {test\_module} Module}{section*.390}{}} +\newlabel{commands/apidoc/src:src.test_module.Test.prepare_testbase}{{4.1.1}{55}{\texttt {test\_module} Module}{section*.391}{}} +\newlabel{commands/apidoc/src:src.test_module.Test.prepare_testbase_from_dir}{{4.1.1}{55}{\texttt {test\_module} Module}{section*.392}{}} +\newlabel{commands/apidoc/src:src.test_module.Test.prepare_testbase_from_git}{{4.1.1}{55}{\texttt {test\_module} Module}{section*.393}{}} +\newlabel{commands/apidoc/src:src.test_module.Test.prepare_testbase_from_svn}{{4.1.1}{55}{\texttt {test\_module} Module}{section*.394}{}} +\newlabel{commands/apidoc/src:src.test_module.Test.read_results}{{4.1.1}{55}{\texttt {test\_module} Module}{section*.395}{}} +\newlabel{commands/apidoc/src:src.test_module.Test.run_all_tests}{{4.1.1}{55}{\texttt {test\_module} Module}{section*.396}{}} +\newlabel{commands/apidoc/src:src.test_module.Test.run_grid_tests}{{4.1.1}{55}{\texttt {test\_module} Module}{section*.397}{}} +\newlabel{commands/apidoc/src:src.test_module.Test.run_script}{{4.1.1}{55}{\texttt {test\_module} Module}{section*.398}{}} +\newlabel{commands/apidoc/src:src.test_module.Test.run_session_tests}{{4.1.1}{55}{\texttt {test\_module} Module}{section*.399}{}} +\newlabel{commands/apidoc/src:src.test_module.Test.run_testbase_tests}{{4.1.1}{55}{\texttt {test\_module} Module}{section*.400}{}} +\newlabel{commands/apidoc/src:src.test_module.Test.run_tests}{{4.1.1}{55}{\texttt {test\_module} Module}{section*.401}{}} +\newlabel{commands/apidoc/src:src.test_module.Test.search_known_errors}{{4.1.1}{55}{\texttt {test\_module} Module}{section*.402}{}} +\newlabel{commands/apidoc/src:src.test_module.Test.write_test_margin}{{4.1.1}{55}{\texttt {test\_module} Module}{section*.403}{}} +\newlabel{commands/apidoc/src:src.test_module.getTmpDirDEFAULT}{{4.1.1}{55}{\texttt {test\_module} Module}{section*.404}{}} +\@writefile{toc}{\contentsline {subsubsection}{\texttt {xmlManager} Module}{56}{subsubsection*.405}} +\newlabel{commands/apidoc/src:xmlmanager-module}{{4.1.1}{56}{\texttt {xmlManager} Module}{subsubsection*.405}{}} +\newlabel{commands/apidoc/src:module-src.xmlManager}{{4.1.1}{56}{\texttt {xmlManager} Module}{subsubsection*.405}{}} +\newlabel{commands/apidoc/src:src.xmlManager.ReadXmlFile}{{4.1.1}{56}{\texttt {xmlManager} Module}{section*.406}{}} +\newlabel{commands/apidoc/src:src.xmlManager.ReadXmlFile.getRootAttrib}{{4.1.1}{56}{\texttt {xmlManager} Module}{section*.407}{}} +\newlabel{commands/apidoc/src:src.xmlManager.ReadXmlFile.get_attrib}{{4.1.1}{56}{\texttt {xmlManager} Module}{section*.408}{}} +\newlabel{commands/apidoc/src:src.xmlManager.ReadXmlFile.get_node_text}{{4.1.1}{56}{\texttt {xmlManager} Module}{section*.409}{}} +\newlabel{commands/apidoc/src:src.xmlManager.XmlLogFile}{{4.1.1}{56}{\texttt {xmlManager} Module}{section*.410}{}} +\newlabel{commands/apidoc/src:src.xmlManager.XmlLogFile.add_simple_node}{{4.1.1}{56}{\texttt {xmlManager} Module}{section*.411}{}} +\newlabel{commands/apidoc/src:src.xmlManager.XmlLogFile.append_node_attrib}{{4.1.1}{56}{\texttt {xmlManager} Module}{section*.412}{}} +\newlabel{commands/apidoc/src:src.xmlManager.XmlLogFile.append_node_text}{{4.1.1}{56}{\texttt {xmlManager} Module}{section*.413}{}} +\newlabel{commands/apidoc/src:src.xmlManager.XmlLogFile.write_tree}{{4.1.1}{56}{\texttt {xmlManager} Module}{section*.414}{}} +\newlabel{commands/apidoc/src:src.xmlManager.add_simple_node}{{4.1.1}{56}{\texttt {xmlManager} Module}{section*.415}{}} +\newlabel{commands/apidoc/src:src.xmlManager.append_node_attrib}{{4.1.1}{57}{\texttt {xmlManager} Module}{section*.416}{}} +\newlabel{commands/apidoc/src:src.xmlManager.find_node_by_attrib}{{4.1.1}{57}{\texttt {xmlManager} Module}{section*.417}{}} +\newlabel{commands/apidoc/src:src.xmlManager.write_report}{{4.1.1}{57}{\texttt {xmlManager} Module}{section*.418}{}} +\@writefile{toc}{\contentsline {subsubsection}{Subpackages}{57}{subsubsection*.419}} +\newlabel{commands/apidoc/src:subpackages}{{4.1.1}{57}{Subpackages}{subsubsection*.419}{}} +\@writefile{toc}{\contentsline {paragraph}{colorama Package}{57}{paragraph*.420}} +\newlabel{commands/apidoc/src.colorama:colorama-package}{{4.1.1}{57}{colorama Package}{paragraph*.420}{}} +\newlabel{commands/apidoc/src.colorama::doc}{{4.1.1}{57}{colorama Package}{paragraph*.420}{}} +\@writefile{toc}{\contentsline {subparagraph}{\texttt {colorama} Package}{57}{subparagraph*.421}} +\newlabel{commands/apidoc/src.colorama:id1}{{4.1.1}{57}{\texttt {colorama} Package}{subparagraph*.421}{}} +\newlabel{commands/apidoc/src.colorama:module-src.colorama}{{4.1.1}{57}{\texttt {colorama} Package}{section*.422}{}} +\@writefile{toc}{\contentsline {subparagraph}{\texttt {ansi} Module}{57}{subparagraph*.423}} +\newlabel{commands/apidoc/src.colorama:module-src.colorama.ansi}{{4.1.1}{57}{\texttt {ansi} Module}{subparagraph*.423}{}} +\newlabel{commands/apidoc/src.colorama:ansi-module}{{4.1.1}{57}{\texttt {ansi} Module}{subparagraph*.423}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack}{{4.1.1}{57}{\texttt {ansi} Module}{section*.424}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.BLACK}{{4.1.1}{57}{\texttt {ansi} Module}{section*.425}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.BLUE}{{4.1.1}{57}{\texttt {ansi} Module}{section*.426}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.CYAN}{{4.1.1}{57}{\texttt {ansi} Module}{section*.427}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.GREEN}{{4.1.1}{57}{\texttt {ansi} Module}{section*.428}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTBLACK_EX}{{4.1.1}{57}{\texttt {ansi} Module}{section*.429}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTBLUE_EX}{{4.1.1}{57}{\texttt {ansi} Module}{section*.430}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTCYAN_EX}{{4.1.1}{58}{\texttt {ansi} Module}{section*.431}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTGREEN_EX}{{4.1.1}{58}{\texttt {ansi} Module}{section*.432}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTMAGENTA_EX}{{4.1.1}{58}{\texttt {ansi} Module}{section*.433}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTRED_EX}{{4.1.1}{58}{\texttt {ansi} Module}{section*.434}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTWHITE_EX}{{4.1.1}{58}{\texttt {ansi} Module}{section*.435}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTYELLOW_EX}{{4.1.1}{58}{\texttt {ansi} Module}{section*.436}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.MAGENTA}{{4.1.1}{58}{\texttt {ansi} Module}{section*.437}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.RED}{{4.1.1}{58}{\texttt {ansi} Module}{section*.438}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.RESET}{{4.1.1}{58}{\texttt {ansi} Module}{section*.439}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.WHITE}{{4.1.1}{58}{\texttt {ansi} Module}{section*.440}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.YELLOW}{{4.1.1}{58}{\texttt {ansi} Module}{section*.441}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCodes}{{4.1.1}{58}{\texttt {ansi} Module}{section*.442}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor}{{4.1.1}{58}{\texttt {ansi} Module}{section*.443}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.BACK}{{4.1.1}{58}{\texttt {ansi} Module}{section*.444}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.DOWN}{{4.1.1}{58}{\texttt {ansi} Module}{section*.445}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.FORWARD}{{4.1.1}{58}{\texttt {ansi} Module}{section*.446}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.POS}{{4.1.1}{58}{\texttt {ansi} Module}{section*.447}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.UP}{{4.1.1}{58}{\texttt {ansi} Module}{section*.448}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore}{{4.1.1}{58}{\texttt {ansi} Module}{section*.449}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.BLACK}{{4.1.1}{58}{\texttt {ansi} Module}{section*.450}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.BLUE}{{4.1.1}{58}{\texttt {ansi} Module}{section*.451}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.CYAN}{{4.1.1}{58}{\texttt {ansi} Module}{section*.452}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.GREEN}{{4.1.1}{58}{\texttt {ansi} Module}{section*.453}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTBLACK_EX}{{4.1.1}{58}{\texttt {ansi} Module}{section*.454}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTBLUE_EX}{{4.1.1}{58}{\texttt {ansi} Module}{section*.455}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTCYAN_EX}{{4.1.1}{58}{\texttt {ansi} Module}{section*.456}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTGREEN_EX}{{4.1.1}{58}{\texttt {ansi} Module}{section*.457}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTMAGENTA_EX}{{4.1.1}{58}{\texttt {ansi} Module}{section*.458}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTRED_EX}{{4.1.1}{58}{\texttt {ansi} Module}{section*.459}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTWHITE_EX}{{4.1.1}{58}{\texttt {ansi} Module}{section*.460}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTYELLOW_EX}{{4.1.1}{58}{\texttt {ansi} Module}{section*.461}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.MAGENTA}{{4.1.1}{58}{\texttt {ansi} Module}{section*.462}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.RED}{{4.1.1}{58}{\texttt {ansi} Module}{section*.463}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.RESET}{{4.1.1}{58}{\texttt {ansi} Module}{section*.464}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.WHITE}{{4.1.1}{58}{\texttt {ansi} Module}{section*.465}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.YELLOW}{{4.1.1}{58}{\texttt {ansi} Module}{section*.466}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle}{{4.1.1}{58}{\texttt {ansi} Module}{section*.467}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle.BRIGHT}{{4.1.1}{59}{\texttt {ansi} Module}{section*.468}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle.DIM}{{4.1.1}{59}{\texttt {ansi} Module}{section*.469}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle.NORMAL}{{4.1.1}{59}{\texttt {ansi} Module}{section*.470}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle.RESET_ALL}{{4.1.1}{59}{\texttt {ansi} Module}{section*.471}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.clear_line}{{4.1.1}{59}{\texttt {ansi} Module}{section*.472}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.clear_screen}{{4.1.1}{59}{\texttt {ansi} Module}{section*.473}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.code_to_chars}{{4.1.1}{59}{\texttt {ansi} Module}{section*.474}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.set_title}{{4.1.1}{59}{\texttt {ansi} Module}{section*.475}{}} +\@writefile{toc}{\contentsline {subparagraph}{\texttt {ansitowin32} Module}{59}{subparagraph*.476}} +\newlabel{commands/apidoc/src.colorama:ansitowin32-module}{{4.1.1}{59}{\texttt {ansitowin32} Module}{subparagraph*.476}{}} +\newlabel{commands/apidoc/src.colorama:module-src.colorama.ansitowin32}{{4.1.1}{59}{\texttt {ansitowin32} Module}{subparagraph*.476}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32}{{4.1.1}{59}{\texttt {ansitowin32} Module}{section*.477}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.ANSI_CSI_RE}{{4.1.1}{59}{\texttt {ansitowin32} Module}{section*.478}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.ANSI_OSC_RE}{{4.1.1}{59}{\texttt {ansitowin32} Module}{section*.479}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.call_win32}{{4.1.1}{59}{\texttt {ansitowin32} Module}{section*.480}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.convert_ansi}{{4.1.1}{59}{\texttt {ansitowin32} Module}{section*.481}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.convert_osc}{{4.1.1}{59}{\texttt {ansitowin32} Module}{section*.482}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.extract_params}{{4.1.1}{59}{\texttt {ansitowin32} Module}{section*.483}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.get_win32_calls}{{4.1.1}{59}{\texttt {ansitowin32} Module}{section*.484}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.reset_all}{{4.1.1}{59}{\texttt {ansitowin32} Module}{section*.485}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.should_wrap}{{4.1.1}{59}{\texttt {ansitowin32} Module}{section*.486}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.write}{{4.1.1}{59}{\texttt {ansitowin32} Module}{section*.487}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.write_and_convert}{{4.1.1}{59}{\texttt {ansitowin32} Module}{section*.488}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.write_plain_text}{{4.1.1}{59}{\texttt {ansitowin32} Module}{section*.489}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.StreamWrapper}{{4.1.1}{59}{\texttt {ansitowin32} Module}{section*.490}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.StreamWrapper.write}{{4.1.1}{59}{\texttt {ansitowin32} Module}{section*.491}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.is_a_tty}{{4.1.1}{59}{\texttt {ansitowin32} Module}{section*.492}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.is_stream_closed}{{4.1.1}{59}{\texttt {ansitowin32} Module}{section*.493}{}} +\@writefile{toc}{\contentsline {subparagraph}{\texttt {initialise} Module}{60}{subparagraph*.494}} +\newlabel{commands/apidoc/src.colorama:initialise-module}{{4.1.1}{60}{\texttt {initialise} Module}{subparagraph*.494}{}} +\newlabel{commands/apidoc/src.colorama:module-src.colorama.initialise}{{4.1.1}{60}{\texttt {initialise} Module}{subparagraph*.494}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.initialise.colorama_text}{{4.1.1}{60}{\texttt {initialise} Module}{section*.495}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.initialise.deinit}{{4.1.1}{60}{\texttt {initialise} Module}{section*.496}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.initialise.init}{{4.1.1}{60}{\texttt {initialise} Module}{section*.497}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.initialise.reinit}{{4.1.1}{60}{\texttt {initialise} Module}{section*.498}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.initialise.reset_all}{{4.1.1}{60}{\texttt {initialise} Module}{section*.499}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.initialise.wrap_stream}{{4.1.1}{60}{\texttt {initialise} Module}{section*.500}{}} +\@writefile{toc}{\contentsline {subparagraph}{\texttt {win32} Module}{60}{subparagraph*.501}} +\newlabel{commands/apidoc/src.colorama:win32-module}{{4.1.1}{60}{\texttt {win32} Module}{subparagraph*.501}{}} +\newlabel{commands/apidoc/src.colorama:module-src.colorama.win32}{{4.1.1}{60}{\texttt {win32} Module}{subparagraph*.501}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.win32.SetConsoleTextAttribute}{{4.1.1}{60}{\texttt {win32} Module}{section*.502}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.win32.winapi_test}{{4.1.1}{60}{\texttt {win32} Module}{section*.503}{}} +\@writefile{toc}{\contentsline {subparagraph}{\texttt {winterm} Module}{60}{subparagraph*.504}} +\newlabel{commands/apidoc/src.colorama:winterm-module}{{4.1.1}{60}{\texttt {winterm} Module}{subparagraph*.504}{}} +\newlabel{commands/apidoc/src.colorama:module-src.colorama.winterm}{{4.1.1}{60}{\texttt {winterm} Module}{subparagraph*.504}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinColor}{{4.1.1}{60}{\texttt {winterm} Module}{section*.505}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.BLACK}{{4.1.1}{60}{\texttt {winterm} Module}{section*.506}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.BLUE}{{4.1.1}{60}{\texttt {winterm} Module}{section*.507}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.CYAN}{{4.1.1}{60}{\texttt {winterm} Module}{section*.508}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.GREEN}{{4.1.1}{60}{\texttt {winterm} Module}{section*.509}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.GREY}{{4.1.1}{60}{\texttt {winterm} Module}{section*.510}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.MAGENTA}{{4.1.1}{60}{\texttt {winterm} Module}{section*.511}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.RED}{{4.1.1}{60}{\texttt {winterm} Module}{section*.512}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.YELLOW}{{4.1.1}{60}{\texttt {winterm} Module}{section*.513}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinStyle}{{4.1.1}{60}{\texttt {winterm} Module}{section*.514}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinStyle.BRIGHT}{{4.1.1}{60}{\texttt {winterm} Module}{section*.515}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinStyle.BRIGHT_BACKGROUND}{{4.1.1}{60}{\texttt {winterm} Module}{section*.516}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinStyle.NORMAL}{{4.1.1}{60}{\texttt {winterm} Module}{section*.517}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm}{{4.1.1}{60}{\texttt {winterm} Module}{section*.518}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.back}{{4.1.1}{60}{\texttt {winterm} Module}{section*.519}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.cursor_adjust}{{4.1.1}{60}{\texttt {winterm} Module}{section*.520}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.erase_line}{{4.1.1}{60}{\texttt {winterm} Module}{section*.521}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.erase_screen}{{4.1.1}{60}{\texttt {winterm} Module}{section*.522}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.fore}{{4.1.1}{60}{\texttt {winterm} Module}{section*.523}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.get_attrs}{{4.1.1}{60}{\texttt {winterm} Module}{section*.524}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.get_position}{{4.1.1}{60}{\texttt {winterm} Module}{section*.525}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.reset_all}{{4.1.1}{60}{\texttt {winterm} Module}{section*.526}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.set_attrs}{{4.1.1}{60}{\texttt {winterm} Module}{section*.527}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.set_console}{{4.1.1}{60}{\texttt {winterm} Module}{section*.528}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.set_cursor_position}{{4.1.1}{60}{\texttt {winterm} Module}{section*.529}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.set_title}{{4.1.1}{60}{\texttt {winterm} Module}{section*.530}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.style}{{4.1.1}{60}{\texttt {winterm} Module}{section*.531}{}} +\@writefile{toc}{\contentsline {chapter}{\numberline {5}Release Notes}{63}{chapter.5}} +\@writefile{lof}{\addvspace {10\p@ }} +\@writefile{lot}{\addvspace {10\p@ }} +\newlabel{index:release-notes}{{5}{63}{Release Notes}{chapter.5}{}} +\@writefile{toc}{\contentsline {section}{\numberline {5.1}Release notes}{63}{section.5.1}} +\newlabel{release_notes/release_notes_5.0.0:release-notes}{{5.1}{63}{Release notes}{section.5.1}{}} +\newlabel{release_notes/release_notes_5.0.0::doc}{{5.1}{63}{Release notes}{section.5.1}{}} +\@writefile{toc}{\contentsline {chapter}{Python Module Index}{65}{section*.532}} +\@writefile{toc}{\contentsline {chapter}{Index}{67}{section*.533}} diff --git a/doc/build/latex/salomeTools.idx b/doc/build/latex/salomeTools.idx new file mode 100644 index 0000000..a9a01f1 --- /dev/null +++ b/doc/build/latex/salomeTools.idx @@ -0,0 +1,512 @@ +\indexentry{src.\_\_init\_\_ (module)|hyperpage}{23} +\indexentry{Path (class in src.\_\_init\_\_)|hyperpage}{23} +\indexentry{base() (src.\_\_init\_\_.Path method)|hyperpage}{23} +\indexentry{chmod() (src.\_\_init\_\_.Path method)|hyperpage}{23} +\indexentry{copy() (src.\_\_init\_\_.Path method)|hyperpage}{23} +\indexentry{copydir() (src.\_\_init\_\_.Path method)|hyperpage}{23} +\indexentry{copyfile() (src.\_\_init\_\_.Path method)|hyperpage}{23} +\indexentry{copylink() (src.\_\_init\_\_.Path method)|hyperpage}{23} +\indexentry{dir() (src.\_\_init\_\_.Path method)|hyperpage}{23} +\indexentry{exists() (src.\_\_init\_\_.Path method)|hyperpage}{23} +\indexentry{isdir() (src.\_\_init\_\_.Path method)|hyperpage}{23} +\indexentry{isfile() (src.\_\_init\_\_.Path method)|hyperpage}{23} +\indexentry{islink() (src.\_\_init\_\_.Path method)|hyperpage}{23} +\indexentry{list() (src.\_\_init\_\_.Path method)|hyperpage}{23} +\indexentry{make() (src.\_\_init\_\_.Path method)|hyperpage}{23} +\indexentry{readlink() (src.\_\_init\_\_.Path method)|hyperpage}{23} +\indexentry{rm() (src.\_\_init\_\_.Path method)|hyperpage}{23} +\indexentry{smartcopy() (src.\_\_init\_\_.Path method)|hyperpage}{23} +\indexentry{symlink() (src.\_\_init\_\_.Path method)|hyperpage}{23} +\indexentry{SatException|hyperpage}{23} +\indexentry{activate\_mesa\_property() (in module src.\_\_init\_\_)|hyperpage}{23} +\indexentry{check\_config\_has\_application() (in module src.\_\_init\_\_)|hyperpage}{23} +\indexentry{check\_config\_has\_profile() (in module src.\_\_init\_\_)|hyperpage}{24} +\indexentry{config\_has\_application() (in module src.\_\_init\_\_)|hyperpage}{24} +\indexentry{deepcopy\_list() (in module src.\_\_init\_\_)|hyperpage}{24} +\indexentry{ensure\_path\_exists() (in module src.\_\_init\_\_)|hyperpage}{24} +\indexentry{find\_file\_in\_lpath() (in module src.\_\_init\_\_)|hyperpage}{24} +\indexentry{get\_base\_path() (in module src.\_\_init\_\_)|hyperpage}{24} +\indexentry{get\_cfg\_param() (in module src.\_\_init\_\_)|hyperpage}{24} +\indexentry{get\_launcher\_name() (in module src.\_\_init\_\_)|hyperpage}{24} +\indexentry{get\_log\_path() (in module src.\_\_init\_\_)|hyperpage}{25} +\indexentry{get\_property\_in\_product\_cfg() (in module src.\_\_init\_\_)|hyperpage}{25} +\indexentry{get\_salome\_version() (in module src.\_\_init\_\_)|hyperpage}{25} +\indexentry{get\_tmp\_filename() (in module src.\_\_init\_\_)|hyperpage}{25} +\indexentry{handleRemoveReadonly() (in module src.\_\_init\_\_)|hyperpage}{25} +\indexentry{merge\_dicts() (in module src.\_\_init\_\_)|hyperpage}{25} +\indexentry{only\_numbers() (in module src.\_\_init\_\_)|hyperpage}{25} +\indexentry{parse\_date() (in module src.\_\_init\_\_)|hyperpage}{25} +\indexentry{print\_info() (in module src.\_\_init\_\_)|hyperpage}{25} +\indexentry{read\_config\_from\_a\_file() (in module src.\_\_init\_\_)|hyperpage}{25} +\indexentry{remove\_item\_from\_list() (in module src.\_\_init\_\_)|hyperpage}{25} +\indexentry{replace\_in\_file() (in module src.\_\_init\_\_)|hyperpage}{25} +\indexentry{src.ElementTree (module)|hyperpage}{25} +\indexentry{Comment() (in module src.ElementTree)|hyperpage}{25} +\indexentry{dump() (in module src.ElementTree)|hyperpage}{25} +\indexentry{Element() (in module src.ElementTree)|hyperpage}{25} +\indexentry{ElementTree (class in src.ElementTree)|hyperpage}{25} +\indexentry{find() (src.ElementTree.ElementTree method)|hyperpage}{25} +\indexentry{findall() (src.ElementTree.ElementTree method)|hyperpage}{25} +\indexentry{findtext() (src.ElementTree.ElementTree method)|hyperpage}{26} +\indexentry{getiterator() (src.ElementTree.ElementTree method)|hyperpage}{26} +\indexentry{getroot() (src.ElementTree.ElementTree method)|hyperpage}{26} +\indexentry{parse() (src.ElementTree.ElementTree method)|hyperpage}{26} +\indexentry{write() (src.ElementTree.ElementTree method)|hyperpage}{26} +\indexentry{fromstring() (in module src.ElementTree)|hyperpage}{26} +\indexentry{iselement() (in module src.ElementTree)|hyperpage}{26} +\indexentry{iterparse (class in src.ElementTree)|hyperpage}{26} +\indexentry{next() (src.ElementTree.iterparse method)|hyperpage}{26} +\indexentry{parse() (in module src.ElementTree)|hyperpage}{26} +\indexentry{PI() (in module src.ElementTree)|hyperpage}{26} +\indexentry{ProcessingInstruction() (in module src.ElementTree)|hyperpage}{26} +\indexentry{QName (class in src.ElementTree)|hyperpage}{26} +\indexentry{SubElement() (in module src.ElementTree)|hyperpage}{26} +\indexentry{tostring() (in module src.ElementTree)|hyperpage}{26} +\indexentry{TreeBuilder (class in src.ElementTree)|hyperpage}{26} +\indexentry{close() (src.ElementTree.TreeBuilder method)|hyperpage}{26} +\indexentry{data() (src.ElementTree.TreeBuilder method)|hyperpage}{26} +\indexentry{end() (src.ElementTree.TreeBuilder method)|hyperpage}{26} +\indexentry{start() (src.ElementTree.TreeBuilder method)|hyperpage}{26} +\indexentry{XML() (in module src.ElementTree)|hyperpage}{26} +\indexentry{XMLTreeBuilder (class in src.ElementTree)|hyperpage}{26} +\indexentry{close() (src.ElementTree.XMLTreeBuilder method)|hyperpage}{26} +\indexentry{doctype() (src.ElementTree.XMLTreeBuilder method)|hyperpage}{26} +\indexentry{feed() (src.ElementTree.XMLTreeBuilder method)|hyperpage}{26} +\indexentry{src.architecture (module)|hyperpage}{26} +\indexentry{get\_distrib\_version() (in module src.architecture)|hyperpage}{26} +\indexentry{get\_distribution() (in module src.architecture)|hyperpage}{26} +\indexentry{get\_nb\_proc() (in module src.architecture)|hyperpage}{27} +\indexentry{get\_python\_version() (in module src.architecture)|hyperpage}{27} +\indexentry{get\_user() (in module src.architecture)|hyperpage}{27} +\indexentry{is\_windows() (in module src.architecture)|hyperpage}{27} +\indexentry{src.compilation (module)|hyperpage}{27} +\indexentry{Builder (class in src.compilation)|hyperpage}{27} +\indexentry{build\_configure() (src.compilation.Builder method)|hyperpage}{27} +\indexentry{check() (src.compilation.Builder method)|hyperpage}{27} +\indexentry{cmake() (src.compilation.Builder method)|hyperpage}{27} +\indexentry{complete\_environment() (src.compilation.Builder method)|hyperpage}{27} +\indexentry{configure() (src.compilation.Builder method)|hyperpage}{27} +\indexentry{do\_batch\_script\_build() (src.compilation.Builder method)|hyperpage}{27} +\indexentry{do\_default\_build() (src.compilation.Builder method)|hyperpage}{27} +\indexentry{do\_python\_script\_build() (src.compilation.Builder method)|hyperpage}{27} +\indexentry{do\_script\_build() (src.compilation.Builder method)|hyperpage}{27} +\indexentry{hack\_libtool() (src.compilation.Builder method)|hyperpage}{27} +\indexentry{install() (src.compilation.Builder method)|hyperpage}{27} +\indexentry{log() (src.compilation.Builder method)|hyperpage}{27} +\indexentry{log\_command() (src.compilation.Builder method)|hyperpage}{27} +\indexentry{make() (src.compilation.Builder method)|hyperpage}{27} +\indexentry{prepare() (src.compilation.Builder method)|hyperpage}{27} +\indexentry{put\_txt\_log\_in\_appli\_log\_dir() (src.compilation.Builder method)|hyperpage}{27} +\indexentry{wmake() (src.compilation.Builder method)|hyperpage}{28} +\indexentry{src.debug (module)|hyperpage}{28} +\indexentry{InStream (class in src.debug)|hyperpage}{28} +\indexentry{OutStream (class in src.debug)|hyperpage}{28} +\indexentry{close() (src.debug.OutStream method)|hyperpage}{28} +\indexentry{getLocalEnv() (in module src.debug)|hyperpage}{28} +\indexentry{getStrConfigDbg() (in module src.debug)|hyperpage}{28} +\indexentry{getStrConfigStd() (in module src.debug)|hyperpage}{28} +\indexentry{indent() (in module src.debug)|hyperpage}{28} +\indexentry{pop\_debug() (in module src.debug)|hyperpage}{28} +\indexentry{push\_debug() (in module src.debug)|hyperpage}{28} +\indexentry{saveConfigDbg() (in module src.debug)|hyperpage}{28} +\indexentry{saveConfigStd() (in module src.debug)|hyperpage}{28} +\indexentry{tofix() (in module src.debug)|hyperpage}{29} +\indexentry{write() (in module src.debug)|hyperpage}{29} +\indexentry{src.environment (module)|hyperpage}{29} +\indexentry{Environ (class in src.environment)|hyperpage}{29} +\indexentry{append() (src.environment.Environ method)|hyperpage}{29} +\indexentry{append\_value() (src.environment.Environ method)|hyperpage}{29} +\indexentry{command\_value() (src.environment.Environ method)|hyperpage}{29} +\indexentry{get() (src.environment.Environ method)|hyperpage}{29} +\indexentry{is\_defined() (src.environment.Environ method)|hyperpage}{29} +\indexentry{prepend() (src.environment.Environ method)|hyperpage}{29} +\indexentry{prepend\_value() (src.environment.Environ method)|hyperpage}{29} +\indexentry{set() (src.environment.Environ method)|hyperpage}{30} +\indexentry{FileEnvWriter (class in src.environment)|hyperpage}{30} +\indexentry{write\_cfgForPy\_file() (src.environment.FileEnvWriter method)|hyperpage}{30} +\indexentry{write\_env\_file() (src.environment.FileEnvWriter method)|hyperpage}{30} +\indexentry{SalomeEnviron (class in src.environment)|hyperpage}{30} +\indexentry{add\_comment() (src.environment.SalomeEnviron method)|hyperpage}{30} +\indexentry{add\_line() (src.environment.SalomeEnviron method)|hyperpage}{30} +\indexentry{add\_warning() (src.environment.SalomeEnviron method)|hyperpage}{30} +\indexentry{append() (src.environment.SalomeEnviron method)|hyperpage}{30} +\indexentry{dump() (src.environment.SalomeEnviron method)|hyperpage}{30} +\indexentry{finish() (src.environment.SalomeEnviron method)|hyperpage}{31} +\indexentry{get() (src.environment.SalomeEnviron method)|hyperpage}{31} +\indexentry{get\_names() (src.environment.SalomeEnviron method)|hyperpage}{31} +\indexentry{is\_defined() (src.environment.SalomeEnviron method)|hyperpage}{31} +\indexentry{load\_cfg\_environment() (src.environment.SalomeEnviron method)|hyperpage}{31} +\indexentry{prepend() (src.environment.SalomeEnviron method)|hyperpage}{31} +\indexentry{run\_env\_script() (src.environment.SalomeEnviron method)|hyperpage}{31} +\indexentry{run\_simple\_env\_script() (src.environment.SalomeEnviron method)|hyperpage}{31} +\indexentry{set() (src.environment.SalomeEnviron method)|hyperpage}{31} +\indexentry{set\_a\_product() (src.environment.SalomeEnviron method)|hyperpage}{31} +\indexentry{set\_application\_env() (src.environment.SalomeEnviron method)|hyperpage}{32} +\indexentry{set\_cpp\_env() (src.environment.SalomeEnviron method)|hyperpage}{32} +\indexentry{set\_full\_environ() (src.environment.SalomeEnviron method)|hyperpage}{32} +\indexentry{set\_products() (src.environment.SalomeEnviron method)|hyperpage}{32} +\indexentry{set\_python\_libdirs() (src.environment.SalomeEnviron method)|hyperpage}{32} +\indexentry{set\_salome\_generic\_product\_env() (src.environment.SalomeEnviron method)|hyperpage}{32} +\indexentry{set\_salome\_minimal\_product\_env() (src.environment.SalomeEnviron method)|hyperpage}{32} +\indexentry{Shell (class in src.environment)|hyperpage}{32} +\indexentry{load\_environment() (in module src.environment)|hyperpage}{32} +\indexentry{src.fileEnviron (module)|hyperpage}{33} +\indexentry{BashFileEnviron (class in src.fileEnviron)|hyperpage}{33} +\indexentry{command\_value() (src.fileEnviron.BashFileEnviron method)|hyperpage}{33} +\indexentry{finish() (src.fileEnviron.BashFileEnviron method)|hyperpage}{33} +\indexentry{set() (src.fileEnviron.BashFileEnviron method)|hyperpage}{33} +\indexentry{BatFileEnviron (class in src.fileEnviron)|hyperpage}{33} +\indexentry{add\_comment() (src.fileEnviron.BatFileEnviron method)|hyperpage}{33} +\indexentry{command\_value() (src.fileEnviron.BatFileEnviron method)|hyperpage}{33} +\indexentry{finish() (src.fileEnviron.BatFileEnviron method)|hyperpage}{33} +\indexentry{get() (src.fileEnviron.BatFileEnviron method)|hyperpage}{33} +\indexentry{set() (src.fileEnviron.BatFileEnviron method)|hyperpage}{33} +\indexentry{ContextFileEnviron (class in src.fileEnviron)|hyperpage}{33} +\indexentry{add\_echo() (src.fileEnviron.ContextFileEnviron method)|hyperpage}{34} +\indexentry{add\_warning() (src.fileEnviron.ContextFileEnviron method)|hyperpage}{34} +\indexentry{append\_value() (src.fileEnviron.ContextFileEnviron method)|hyperpage}{34} +\indexentry{command\_value() (src.fileEnviron.ContextFileEnviron method)|hyperpage}{34} +\indexentry{finish() (src.fileEnviron.ContextFileEnviron method)|hyperpage}{34} +\indexentry{get() (src.fileEnviron.ContextFileEnviron method)|hyperpage}{34} +\indexentry{prepend\_value() (src.fileEnviron.ContextFileEnviron method)|hyperpage}{34} +\indexentry{set() (src.fileEnviron.ContextFileEnviron method)|hyperpage}{34} +\indexentry{FileEnviron (class in src.fileEnviron)|hyperpage}{34} +\indexentry{add\_comment() (src.fileEnviron.FileEnviron method)|hyperpage}{34} +\indexentry{add\_echo() (src.fileEnviron.FileEnviron method)|hyperpage}{35} +\indexentry{add\_line() (src.fileEnviron.FileEnviron method)|hyperpage}{35} +\indexentry{add\_warning() (src.fileEnviron.FileEnviron method)|hyperpage}{35} +\indexentry{append() (src.fileEnviron.FileEnviron method)|hyperpage}{35} +\indexentry{append\_value() (src.fileEnviron.FileEnviron method)|hyperpage}{35} +\indexentry{command\_value() (src.fileEnviron.FileEnviron method)|hyperpage}{35} +\indexentry{finish() (src.fileEnviron.FileEnviron method)|hyperpage}{35} +\indexentry{get() (src.fileEnviron.FileEnviron method)|hyperpage}{35} +\indexentry{is\_defined() (src.fileEnviron.FileEnviron method)|hyperpage}{35} +\indexentry{prepend() (src.fileEnviron.FileEnviron method)|hyperpage}{35} +\indexentry{prepend\_value() (src.fileEnviron.FileEnviron method)|hyperpage}{36} +\indexentry{set() (src.fileEnviron.FileEnviron method)|hyperpage}{36} +\indexentry{LauncherFileEnviron (class in src.fileEnviron)|hyperpage}{36} +\indexentry{add() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{36} +\indexentry{add\_comment() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{36} +\indexentry{add\_echo() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{36} +\indexentry{add\_line() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{36} +\indexentry{add\_warning() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{36} +\indexentry{append() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{36} +\indexentry{append\_value() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{36} +\indexentry{change\_to\_launcher() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{36} +\indexentry{command\_value() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{36} +\indexentry{finish() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{37} +\indexentry{get() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{37} +\indexentry{is\_defined() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{37} +\indexentry{prepend() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{37} +\indexentry{prepend\_value() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{37} +\indexentry{set() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{37} +\indexentry{ScreenEnviron (class in src.fileEnviron)|hyperpage}{37} +\indexentry{add\_comment() (src.fileEnviron.ScreenEnviron method)|hyperpage}{37} +\indexentry{add\_echo() (src.fileEnviron.ScreenEnviron method)|hyperpage}{37} +\indexentry{add\_line() (src.fileEnviron.ScreenEnviron method)|hyperpage}{37} +\indexentry{add\_warning() (src.fileEnviron.ScreenEnviron method)|hyperpage}{37} +\indexentry{append() (src.fileEnviron.ScreenEnviron method)|hyperpage}{37} +\indexentry{command\_value() (src.fileEnviron.ScreenEnviron method)|hyperpage}{37} +\indexentry{get() (src.fileEnviron.ScreenEnviron method)|hyperpage}{37} +\indexentry{is\_defined() (src.fileEnviron.ScreenEnviron method)|hyperpage}{37} +\indexentry{prepend() (src.fileEnviron.ScreenEnviron method)|hyperpage}{37} +\indexentry{run\_env\_script() (src.fileEnviron.ScreenEnviron method)|hyperpage}{38} +\indexentry{set() (src.fileEnviron.ScreenEnviron method)|hyperpage}{38} +\indexentry{write() (src.fileEnviron.ScreenEnviron method)|hyperpage}{38} +\indexentry{get\_file\_environ() (in module src.fileEnviron)|hyperpage}{38} +\indexentry{special\_path\_separator() (in module src.fileEnviron)|hyperpage}{38} +\indexentry{src.fork (module)|hyperpage}{38} +\indexentry{batch() (in module src.fork)|hyperpage}{38} +\indexentry{batch\_salome() (in module src.fork)|hyperpage}{38} +\indexentry{launch\_command() (in module src.fork)|hyperpage}{38} +\indexentry{show\_progress() (in module src.fork)|hyperpage}{38} +\indexentry{write\_back() (in module src.fork)|hyperpage}{38} +\indexentry{src.logger (module)|hyperpage}{38} +\indexentry{Logger (class in src.logger)|hyperpage}{38} +\indexentry{add\_link() (src.logger.Logger method)|hyperpage}{38} +\indexentry{end\_write() (src.logger.Logger method)|hyperpage}{39} +\indexentry{error() (src.logger.Logger method)|hyperpage}{39} +\indexentry{flush() (src.logger.Logger method)|hyperpage}{39} +\indexentry{put\_initial\_xml\_fields() (src.logger.Logger method)|hyperpage}{39} +\indexentry{write() (src.logger.Logger method)|hyperpage}{39} +\indexentry{date\_to\_datetime() (in module src.logger)|hyperpage}{39} +\indexentry{list\_log\_file() (in module src.logger)|hyperpage}{39} +\indexentry{show\_command\_log() (in module src.logger)|hyperpage}{39} +\indexentry{timedelta\_total\_seconds() (in module src.logger)|hyperpage}{40} +\indexentry{update\_hat\_xml() (in module src.logger)|hyperpage}{40} +\indexentry{src.options (module)|hyperpage}{40} +\indexentry{OptResult (class in src.options)|hyperpage}{40} +\indexentry{Options (class in src.options)|hyperpage}{40} +\indexentry{add\_option() (src.options.Options method)|hyperpage}{40} +\indexentry{parse\_args() (src.options.Options method)|hyperpage}{40} +\indexentry{print\_help() (src.options.Options method)|hyperpage}{40} +\indexentry{src.printcolors (module)|hyperpage}{41} +\indexentry{cleancolor() (in module src.printcolors)|hyperpage}{41} +\indexentry{print\_color\_map() (in module src.printcolors)|hyperpage}{41} +\indexentry{print\_color\_range() (in module src.printcolors)|hyperpage}{41} +\indexentry{print\_value() (in module src.printcolors)|hyperpage}{41} +\indexentry{printc() (in module src.printcolors)|hyperpage}{41} +\indexentry{printcError() (in module src.printcolors)|hyperpage}{41} +\indexentry{printcHeader() (in module src.printcolors)|hyperpage}{41} +\indexentry{printcHighlight() (in module src.printcolors)|hyperpage}{41} +\indexentry{printcInfo() (in module src.printcolors)|hyperpage}{42} +\indexentry{printcLabel() (in module src.printcolors)|hyperpage}{42} +\indexentry{printcSuccess() (in module src.printcolors)|hyperpage}{42} +\indexentry{printcWarning() (in module src.printcolors)|hyperpage}{42} +\indexentry{src.product (module)|hyperpage}{42} +\indexentry{check\_config\_exists() (in module src.product)|hyperpage}{42} +\indexentry{check\_installation() (in module src.product)|hyperpage}{42} +\indexentry{check\_source() (in module src.product)|hyperpage}{43} +\indexentry{get\_base\_install\_dir() (in module src.product)|hyperpage}{43} +\indexentry{get\_install\_dir() (in module src.product)|hyperpage}{43} +\indexentry{get\_product\_components() (in module src.product)|hyperpage}{43} +\indexentry{get\_product\_config() (in module src.product)|hyperpage}{43} +\indexentry{get\_product\_dependencies() (in module src.product)|hyperpage}{43} +\indexentry{get\_product\_section() (in module src.product)|hyperpage}{44} +\indexentry{get\_products\_infos() (in module src.product)|hyperpage}{44} +\indexentry{product\_compiles() (in module src.product)|hyperpage}{44} +\indexentry{product\_has\_env\_script() (in module src.product)|hyperpage}{44} +\indexentry{product\_has\_logo() (in module src.product)|hyperpage}{44} +\indexentry{product\_has\_patches() (in module src.product)|hyperpage}{44} +\indexentry{product\_has\_salome\_gui() (in module src.product)|hyperpage}{44} +\indexentry{product\_has\_script() (in module src.product)|hyperpage}{45} +\indexentry{product\_is\_autotools() (in module src.product)|hyperpage}{45} +\indexentry{product\_is\_cmake() (in module src.product)|hyperpage}{45} +\indexentry{product\_is\_cpp() (in module src.product)|hyperpage}{45} +\indexentry{product\_is\_debug() (in module src.product)|hyperpage}{45} +\indexentry{product\_is\_dev() (in module src.product)|hyperpage}{45} +\indexentry{product\_is\_fixed() (in module src.product)|hyperpage}{45} +\indexentry{product\_is\_generated() (in module src.product)|hyperpage}{45} +\indexentry{product\_is\_mpi() (in module src.product)|hyperpage}{46} +\indexentry{product\_is\_native() (in module src.product)|hyperpage}{46} +\indexentry{product\_is\_salome() (in module src.product)|hyperpage}{46} +\indexentry{product\_is\_sample() (in module src.product)|hyperpage}{46} +\indexentry{product\_is\_smesh\_plugin() (in module src.product)|hyperpage}{46} +\indexentry{product\_is\_vcs() (in module src.product)|hyperpage}{46} +\indexentry{src.pyconf (module)|hyperpage}{46} +\indexentry{Config (class in src.pyconf)|hyperpage}{47} +\indexentry{Config.Namespace (class in src.pyconf)|hyperpage}{47} +\indexentry{addNamespace() (src.pyconf.Config method)|hyperpage}{47} +\indexentry{getByPath() (src.pyconf.Config method)|hyperpage}{48} +\indexentry{load() (src.pyconf.Config method)|hyperpage}{48} +\indexentry{removeNamespace() (src.pyconf.Config method)|hyperpage}{48} +\indexentry{ConfigError|hyperpage}{48} +\indexentry{ConfigFormatError|hyperpage}{48} +\indexentry{ConfigInputStream (class in src.pyconf)|hyperpage}{48} +\indexentry{close() (src.pyconf.ConfigInputStream method)|hyperpage}{48} +\indexentry{read() (src.pyconf.ConfigInputStream method)|hyperpage}{48} +\indexentry{readline() (src.pyconf.ConfigInputStream method)|hyperpage}{48} +\indexentry{ConfigList (class in src.pyconf)|hyperpage}{48} +\indexentry{getByPath() (src.pyconf.ConfigList method)|hyperpage}{48} +\indexentry{ConfigMerger (class in src.pyconf)|hyperpage}{48} +\indexentry{handleMismatch() (src.pyconf.ConfigMerger method)|hyperpage}{48} +\indexentry{merge() (src.pyconf.ConfigMerger method)|hyperpage}{48} +\indexentry{mergeMapping() (src.pyconf.ConfigMerger method)|hyperpage}{49} +\indexentry{mergeSequence() (src.pyconf.ConfigMerger method)|hyperpage}{49} +\indexentry{overwriteKeys() (src.pyconf.ConfigMerger method)|hyperpage}{49} +\indexentry{ConfigOutputStream (class in src.pyconf)|hyperpage}{49} +\indexentry{close() (src.pyconf.ConfigOutputStream method)|hyperpage}{49} +\indexentry{flush() (src.pyconf.ConfigOutputStream method)|hyperpage}{49} +\indexentry{write() (src.pyconf.ConfigOutputStream method)|hyperpage}{49} +\indexentry{ConfigReader (class in src.pyconf)|hyperpage}{49} +\indexentry{getChar() (src.pyconf.ConfigReader method)|hyperpage}{49} +\indexentry{getToken() (src.pyconf.ConfigReader method)|hyperpage}{49} +\indexentry{load() (src.pyconf.ConfigReader method)|hyperpage}{49} +\indexentry{location() (src.pyconf.ConfigReader method)|hyperpage}{49} +\indexentry{match() (src.pyconf.ConfigReader method)|hyperpage}{50} +\indexentry{parseFactor() (src.pyconf.ConfigReader method)|hyperpage}{50} +\indexentry{parseKeyValuePair() (src.pyconf.ConfigReader method)|hyperpage}{50} +\indexentry{parseMapping() (src.pyconf.ConfigReader method)|hyperpage}{50} +\indexentry{parseMappingBody() (src.pyconf.ConfigReader method)|hyperpage}{50} +\indexentry{parseReference() (src.pyconf.ConfigReader method)|hyperpage}{50} +\indexentry{parseScalar() (src.pyconf.ConfigReader method)|hyperpage}{50} +\indexentry{parseSequence() (src.pyconf.ConfigReader method)|hyperpage}{50} +\indexentry{parseSuffix() (src.pyconf.ConfigReader method)|hyperpage}{50} +\indexentry{parseTerm() (src.pyconf.ConfigReader method)|hyperpage}{50} +\indexentry{parseValue() (src.pyconf.ConfigReader method)|hyperpage}{50} +\indexentry{setStream() (src.pyconf.ConfigReader method)|hyperpage}{51} +\indexentry{ConfigResolutionError|hyperpage}{51} +\indexentry{Container (class in src.pyconf)|hyperpage}{51} +\indexentry{evaluate() (src.pyconf.Container method)|hyperpage}{51} +\indexentry{setPath() (src.pyconf.Container method)|hyperpage}{51} +\indexentry{writeToStream() (src.pyconf.Container method)|hyperpage}{51} +\indexentry{writeValue() (src.pyconf.Container method)|hyperpage}{51} +\indexentry{Expression (class in src.pyconf)|hyperpage}{51} +\indexentry{evaluate() (src.pyconf.Expression method)|hyperpage}{51} +\indexentry{Mapping (class in src.pyconf)|hyperpage}{51} +\indexentry{addMapping() (src.pyconf.Mapping method)|hyperpage}{51} +\indexentry{get() (src.pyconf.Mapping method)|hyperpage}{52} +\indexentry{iteritems() (src.pyconf.Mapping method)|hyperpage}{52} +\indexentry{iterkeys() (src.pyconf.Mapping method)|hyperpage}{52} +\indexentry{keys() (src.pyconf.Mapping method)|hyperpage}{52} +\indexentry{writeToStream() (src.pyconf.Mapping method)|hyperpage}{52} +\indexentry{Reference (class in src.pyconf)|hyperpage}{52} +\indexentry{addElement() (src.pyconf.Reference method)|hyperpage}{52} +\indexentry{findConfig() (src.pyconf.Reference method)|hyperpage}{52} +\indexentry{resolve() (src.pyconf.Reference method)|hyperpage}{52} +\indexentry{Sequence (class in src.pyconf)|hyperpage}{52} +\indexentry{Sequence.SeqIter (class in src.pyconf)|hyperpage}{52} +\indexentry{next() (src.pyconf.Sequence.SeqIter method)|hyperpage}{52} +\indexentry{append() (src.pyconf.Sequence method)|hyperpage}{52} +\indexentry{writeToStream() (src.pyconf.Sequence method)|hyperpage}{52} +\indexentry{deepCopyMapping() (in module src.pyconf)|hyperpage}{53} +\indexentry{defaultMergeResolve() (in module src.pyconf)|hyperpage}{53} +\indexentry{defaultStreamOpener() (in module src.pyconf)|hyperpage}{53} +\indexentry{isWord() (in module src.pyconf)|hyperpage}{53} +\indexentry{makePath() (in module src.pyconf)|hyperpage}{53} +\indexentry{overwriteMergeResolve() (in module src.pyconf)|hyperpage}{53} +\indexentry{src.system (module)|hyperpage}{53} +\indexentry{archive\_extract() (in module src.system)|hyperpage}{53} +\indexentry{cvs\_extract() (in module src.system)|hyperpage}{54} +\indexentry{git\_extract() (in module src.system)|hyperpage}{54} +\indexentry{show\_in\_editor() (in module src.system)|hyperpage}{54} +\indexentry{svn\_extract() (in module src.system)|hyperpage}{54} +\indexentry{src.template (module)|hyperpage}{55} +\indexentry{MyTemplate (class in src.template)|hyperpage}{55} +\indexentry{delimiter (src.template.MyTemplate attribute)|hyperpage}{55} +\indexentry{pattern (src.template.MyTemplate attribute)|hyperpage}{55} +\indexentry{substitute() (in module src.template)|hyperpage}{55} +\indexentry{src.test\_module (module)|hyperpage}{55} +\indexentry{Test (class in src.test\_module)|hyperpage}{55} +\indexentry{generate\_launching\_commands() (src.test\_module.Test method)|hyperpage}{55} +\indexentry{generate\_script() (src.test\_module.Test method)|hyperpage}{55} +\indexentry{get\_test\_timeout() (src.test\_module.Test method)|hyperpage}{55} +\indexentry{get\_tmp\_dir() (src.test\_module.Test method)|hyperpage}{55} +\indexentry{prepare\_testbase() (src.test\_module.Test method)|hyperpage}{55} +\indexentry{prepare\_testbase\_from\_dir() (src.test\_module.Test method)|hyperpage}{55} +\indexentry{prepare\_testbase\_from\_git() (src.test\_module.Test method)|hyperpage}{55} +\indexentry{prepare\_testbase\_from\_svn() (src.test\_module.Test method)|hyperpage}{55} +\indexentry{read\_results() (src.test\_module.Test method)|hyperpage}{55} +\indexentry{run\_all\_tests() (src.test\_module.Test method)|hyperpage}{55} +\indexentry{run\_grid\_tests() (src.test\_module.Test method)|hyperpage}{55} +\indexentry{run\_script() (src.test\_module.Test method)|hyperpage}{55} +\indexentry{run\_session\_tests() (src.test\_module.Test method)|hyperpage}{55} +\indexentry{run\_testbase\_tests() (src.test\_module.Test method)|hyperpage}{55} +\indexentry{run\_tests() (src.test\_module.Test method)|hyperpage}{55} +\indexentry{search\_known\_errors() (src.test\_module.Test method)|hyperpage}{55} +\indexentry{write\_test\_margin() (src.test\_module.Test method)|hyperpage}{55} +\indexentry{getTmpDirDEFAULT() (in module src.test\_module)|hyperpage}{55} +\indexentry{src.xmlManager (module)|hyperpage}{56} +\indexentry{ReadXmlFile (class in src.xmlManager)|hyperpage}{56} +\indexentry{getRootAttrib() (src.xmlManager.ReadXmlFile method)|hyperpage}{56} +\indexentry{get\_attrib() (src.xmlManager.ReadXmlFile method)|hyperpage}{56} +\indexentry{get\_node\_text() (src.xmlManager.ReadXmlFile method)|hyperpage}{56} +\indexentry{XmlLogFile (class in src.xmlManager)|hyperpage}{56} +\indexentry{add\_simple\_node() (src.xmlManager.XmlLogFile method)|hyperpage}{56} +\indexentry{append\_node\_attrib() (src.xmlManager.XmlLogFile method)|hyperpage}{56} +\indexentry{append\_node\_text() (src.xmlManager.XmlLogFile method)|hyperpage}{56} +\indexentry{write\_tree() (src.xmlManager.XmlLogFile method)|hyperpage}{56} +\indexentry{add\_simple\_node() (in module src.xmlManager)|hyperpage}{56} +\indexentry{append\_node\_attrib() (in module src.xmlManager)|hyperpage}{57} +\indexentry{find\_node\_by\_attrib() (in module src.xmlManager)|hyperpage}{57} +\indexentry{write\_report() (in module src.xmlManager)|hyperpage}{57} +\indexentry{src.colorama (module)|hyperpage}{57} +\indexentry{src.colorama.ansi (module)|hyperpage}{57} +\indexentry{AnsiBack (class in src.colorama.ansi)|hyperpage}{57} +\indexentry{BLACK (src.colorama.ansi.AnsiBack attribute)|hyperpage}{57} +\indexentry{BLUE (src.colorama.ansi.AnsiBack attribute)|hyperpage}{57} +\indexentry{CYAN (src.colorama.ansi.AnsiBack attribute)|hyperpage}{57} +\indexentry{GREEN (src.colorama.ansi.AnsiBack attribute)|hyperpage}{57} +\indexentry{LIGHTBLACK\_EX (src.colorama.ansi.AnsiBack attribute)|hyperpage}{57} +\indexentry{LIGHTBLUE\_EX (src.colorama.ansi.AnsiBack attribute)|hyperpage}{57} +\indexentry{LIGHTCYAN\_EX (src.colorama.ansi.AnsiBack attribute)|hyperpage}{58} +\indexentry{LIGHTGREEN\_EX (src.colorama.ansi.AnsiBack attribute)|hyperpage}{58} +\indexentry{LIGHTMAGENTA\_EX (src.colorama.ansi.AnsiBack attribute)|hyperpage}{58} +\indexentry{LIGHTRED\_EX (src.colorama.ansi.AnsiBack attribute)|hyperpage}{58} +\indexentry{LIGHTWHITE\_EX (src.colorama.ansi.AnsiBack attribute)|hyperpage}{58} +\indexentry{LIGHTYELLOW\_EX (src.colorama.ansi.AnsiBack attribute)|hyperpage}{58} +\indexentry{MAGENTA (src.colorama.ansi.AnsiBack attribute)|hyperpage}{58} +\indexentry{RED (src.colorama.ansi.AnsiBack attribute)|hyperpage}{58} +\indexentry{RESET (src.colorama.ansi.AnsiBack attribute)|hyperpage}{58} +\indexentry{WHITE (src.colorama.ansi.AnsiBack attribute)|hyperpage}{58} +\indexentry{YELLOW (src.colorama.ansi.AnsiBack attribute)|hyperpage}{58} +\indexentry{AnsiCodes (class in src.colorama.ansi)|hyperpage}{58} +\indexentry{AnsiCursor (class in src.colorama.ansi)|hyperpage}{58} +\indexentry{BACK() (src.colorama.ansi.AnsiCursor method)|hyperpage}{58} +\indexentry{DOWN() (src.colorama.ansi.AnsiCursor method)|hyperpage}{58} +\indexentry{FORWARD() (src.colorama.ansi.AnsiCursor method)|hyperpage}{58} +\indexentry{POS() (src.colorama.ansi.AnsiCursor method)|hyperpage}{58} +\indexentry{UP() (src.colorama.ansi.AnsiCursor method)|hyperpage}{58} +\indexentry{AnsiFore (class in src.colorama.ansi)|hyperpage}{58} +\indexentry{BLACK (src.colorama.ansi.AnsiFore attribute)|hyperpage}{58} +\indexentry{BLUE (src.colorama.ansi.AnsiFore attribute)|hyperpage}{58} +\indexentry{CYAN (src.colorama.ansi.AnsiFore attribute)|hyperpage}{58} +\indexentry{GREEN (src.colorama.ansi.AnsiFore attribute)|hyperpage}{58} +\indexentry{LIGHTBLACK\_EX (src.colorama.ansi.AnsiFore attribute)|hyperpage}{58} +\indexentry{LIGHTBLUE\_EX (src.colorama.ansi.AnsiFore attribute)|hyperpage}{58} +\indexentry{LIGHTCYAN\_EX (src.colorama.ansi.AnsiFore attribute)|hyperpage}{58} +\indexentry{LIGHTGREEN\_EX (src.colorama.ansi.AnsiFore attribute)|hyperpage}{58} +\indexentry{LIGHTMAGENTA\_EX (src.colorama.ansi.AnsiFore attribute)|hyperpage}{58} +\indexentry{LIGHTRED\_EX (src.colorama.ansi.AnsiFore attribute)|hyperpage}{58} +\indexentry{LIGHTWHITE\_EX (src.colorama.ansi.AnsiFore attribute)|hyperpage}{58} +\indexentry{LIGHTYELLOW\_EX (src.colorama.ansi.AnsiFore attribute)|hyperpage}{58} +\indexentry{MAGENTA (src.colorama.ansi.AnsiFore attribute)|hyperpage}{58} +\indexentry{RED (src.colorama.ansi.AnsiFore attribute)|hyperpage}{58} +\indexentry{RESET (src.colorama.ansi.AnsiFore attribute)|hyperpage}{58} +\indexentry{WHITE (src.colorama.ansi.AnsiFore attribute)|hyperpage}{58} +\indexentry{YELLOW (src.colorama.ansi.AnsiFore attribute)|hyperpage}{58} +\indexentry{AnsiStyle (class in src.colorama.ansi)|hyperpage}{58} +\indexentry{BRIGHT (src.colorama.ansi.AnsiStyle attribute)|hyperpage}{59} +\indexentry{DIM (src.colorama.ansi.AnsiStyle attribute)|hyperpage}{59} +\indexentry{NORMAL (src.colorama.ansi.AnsiStyle attribute)|hyperpage}{59} +\indexentry{RESET\_ALL (src.colorama.ansi.AnsiStyle attribute)|hyperpage}{59} +\indexentry{clear\_line() (in module src.colorama.ansi)|hyperpage}{59} +\indexentry{clear\_screen() (in module src.colorama.ansi)|hyperpage}{59} +\indexentry{code\_to\_chars() (in module src.colorama.ansi)|hyperpage}{59} +\indexentry{set\_title() (in module src.colorama.ansi)|hyperpage}{59} +\indexentry{src.colorama.ansitowin32 (module)|hyperpage}{59} +\indexentry{AnsiToWin32 (class in src.colorama.ansitowin32)|hyperpage}{59} +\indexentry{ANSI\_CSI\_RE (src.colorama.ansitowin32.AnsiToWin32 attribute)|hyperpage}{59} +\indexentry{ANSI\_OSC\_RE (src.colorama.ansitowin32.AnsiToWin32 attribute)|hyperpage}{59} +\indexentry{call\_win32() (src.colorama.ansitowin32.AnsiToWin32 method)|hyperpage}{59} +\indexentry{convert\_ansi() (src.colorama.ansitowin32.AnsiToWin32 method)|hyperpage}{59} +\indexentry{convert\_osc() (src.colorama.ansitowin32.AnsiToWin32 method)|hyperpage}{59} +\indexentry{extract\_params() (src.colorama.ansitowin32.AnsiToWin32 method)|hyperpage}{59} +\indexentry{get\_win32\_calls() (src.colorama.ansitowin32.AnsiToWin32 method)|hyperpage}{59} +\indexentry{reset\_all() (src.colorama.ansitowin32.AnsiToWin32 method)|hyperpage}{59} +\indexentry{should\_wrap() (src.colorama.ansitowin32.AnsiToWin32 method)|hyperpage}{59} +\indexentry{write() (src.colorama.ansitowin32.AnsiToWin32 method)|hyperpage}{59} +\indexentry{write\_and\_convert() (src.colorama.ansitowin32.AnsiToWin32 method)|hyperpage}{59} +\indexentry{write\_plain\_text() (src.colorama.ansitowin32.AnsiToWin32 method)|hyperpage}{59} +\indexentry{StreamWrapper (class in src.colorama.ansitowin32)|hyperpage}{59} +\indexentry{write() (src.colorama.ansitowin32.StreamWrapper method)|hyperpage}{59} +\indexentry{is\_a\_tty() (in module src.colorama.ansitowin32)|hyperpage}{59} +\indexentry{is\_stream\_closed() (in module src.colorama.ansitowin32)|hyperpage}{59} +\indexentry{src.colorama.initialise (module)|hyperpage}{60} +\indexentry{colorama\_text() (in module src.colorama.initialise)|hyperpage}{60} +\indexentry{deinit() (in module src.colorama.initialise)|hyperpage}{60} +\indexentry{init() (in module src.colorama.initialise)|hyperpage}{60} +\indexentry{reinit() (in module src.colorama.initialise)|hyperpage}{60} +\indexentry{reset\_all() (in module src.colorama.initialise)|hyperpage}{60} +\indexentry{wrap\_stream() (in module src.colorama.initialise)|hyperpage}{60} +\indexentry{src.colorama.win32 (module)|hyperpage}{60} +\indexentry{SetConsoleTextAttribute() (in module src.colorama.win32)|hyperpage}{60} +\indexentry{winapi\_test() (in module src.colorama.win32)|hyperpage}{60} +\indexentry{src.colorama.winterm (module)|hyperpage}{60} +\indexentry{WinColor (class in src.colorama.winterm)|hyperpage}{60} +\indexentry{BLACK (src.colorama.winterm.WinColor attribute)|hyperpage}{60} +\indexentry{BLUE (src.colorama.winterm.WinColor attribute)|hyperpage}{60} +\indexentry{CYAN (src.colorama.winterm.WinColor attribute)|hyperpage}{60} +\indexentry{GREEN (src.colorama.winterm.WinColor attribute)|hyperpage}{60} +\indexentry{GREY (src.colorama.winterm.WinColor attribute)|hyperpage}{60} +\indexentry{MAGENTA (src.colorama.winterm.WinColor attribute)|hyperpage}{60} +\indexentry{RED (src.colorama.winterm.WinColor attribute)|hyperpage}{60} +\indexentry{YELLOW (src.colorama.winterm.WinColor attribute)|hyperpage}{60} +\indexentry{WinStyle (class in src.colorama.winterm)|hyperpage}{60} +\indexentry{BRIGHT (src.colorama.winterm.WinStyle attribute)|hyperpage}{60} +\indexentry{BRIGHT\_BACKGROUND (src.colorama.winterm.WinStyle attribute)|hyperpage}{60} +\indexentry{NORMAL (src.colorama.winterm.WinStyle attribute)|hyperpage}{60} +\indexentry{WinTerm (class in src.colorama.winterm)|hyperpage}{60} +\indexentry{back() (src.colorama.winterm.WinTerm method)|hyperpage}{60} +\indexentry{cursor\_adjust() (src.colorama.winterm.WinTerm method)|hyperpage}{60} +\indexentry{erase\_line() (src.colorama.winterm.WinTerm method)|hyperpage}{60} +\indexentry{erase\_screen() (src.colorama.winterm.WinTerm method)|hyperpage}{60} +\indexentry{fore() (src.colorama.winterm.WinTerm method)|hyperpage}{60} +\indexentry{get\_attrs() (src.colorama.winterm.WinTerm method)|hyperpage}{60} +\indexentry{get\_position() (src.colorama.winterm.WinTerm method)|hyperpage}{60} +\indexentry{reset\_all() (src.colorama.winterm.WinTerm method)|hyperpage}{60} +\indexentry{set\_attrs() (src.colorama.winterm.WinTerm method)|hyperpage}{60} +\indexentry{set\_console() (src.colorama.winterm.WinTerm method)|hyperpage}{60} +\indexentry{set\_cursor\_position() (src.colorama.winterm.WinTerm method)|hyperpage}{60} +\indexentry{set\_title() (src.colorama.winterm.WinTerm method)|hyperpage}{60} +\indexentry{style() (src.colorama.winterm.WinTerm method)|hyperpage}{60} diff --git a/doc/build/latex/salomeTools.ilg b/doc/build/latex/salomeTools.ilg new file mode 100644 index 0000000..733ac21 --- /dev/null +++ b/doc/build/latex/salomeTools.ilg @@ -0,0 +1,7 @@ +This is makeindex, version 2.15 [TeX Live 2017] (kpathsea + Thai support). +Scanning style file ./python.ist......done (6 attributes redefined, 0 ignored). +Scanning input file salomeTools.idx....done (512 entries accepted, 0 rejected). +Sorting entries.......done (5039 comparisons). +Generating output file salomeTools.ind....done (584 lines written, 0 warnings). +Output written in salomeTools.ind. +Transcript written in salomeTools.ilg. diff --git a/doc/build/latex/salomeTools.ind b/doc/build/latex/salomeTools.ind new file mode 100644 index 0000000..b7f927c --- /dev/null +++ b/doc/build/latex/salomeTools.ind @@ -0,0 +1,584 @@ +\begin{theindex} +\def\bigletter#1{{\Large\sffamily#1}\nopagebreak\vspace{1mm}} + + \bigletter A + \item activate\_mesa\_property() (in module src.\_\_init\_\_), \hyperpage{23} + \item add() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{36} + \item add\_comment() (src.environment.SalomeEnviron method), \hyperpage{30} + \item add\_comment() (src.fileEnviron.BatFileEnviron method), \hyperpage{33} + \item add\_comment() (src.fileEnviron.FileEnviron method), \hyperpage{34} + \item add\_comment() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{36} + \item add\_comment() (src.fileEnviron.ScreenEnviron method), \hyperpage{37} + \item add\_echo() (src.fileEnviron.ContextFileEnviron method), \hyperpage{34} + \item add\_echo() (src.fileEnviron.FileEnviron method), \hyperpage{35} + \item add\_echo() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{36} + \item add\_echo() (src.fileEnviron.ScreenEnviron method), \hyperpage{37} + \item add\_line() (src.environment.SalomeEnviron method), \hyperpage{30} + \item add\_line() (src.fileEnviron.FileEnviron method), \hyperpage{35} + \item add\_line() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{36} + \item add\_line() (src.fileEnviron.ScreenEnviron method), \hyperpage{37} + \item add\_link() (src.logger.Logger method), \hyperpage{38} + \item add\_option() (src.options.Options method), \hyperpage{40} + \item add\_simple\_node() (in module src.xmlManager), \hyperpage{56} + \item add\_simple\_node() (src.xmlManager.XmlLogFile method), \hyperpage{56} + \item add\_warning() (src.environment.SalomeEnviron method), \hyperpage{30} + \item add\_warning() (src.fileEnviron.ContextFileEnviron method), \hyperpage{34} + \item add\_warning() (src.fileEnviron.FileEnviron method), \hyperpage{35} + \item add\_warning() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{36} + \item add\_warning() (src.fileEnviron.ScreenEnviron method), \hyperpage{37} + \item addElement() (src.pyconf.Reference method), \hyperpage{52} + \item addMapping() (src.pyconf.Mapping method), \hyperpage{51} + \item addNamespace() (src.pyconf.Config method), \hyperpage{47} + \item ANSI\_CSI\_RE (src.colorama.ansitowin32.AnsiToWin32 attribute), \hyperpage{59} + \item ANSI\_OSC\_RE (src.colorama.ansitowin32.AnsiToWin32 attribute), \hyperpage{59} + \item AnsiBack (class in src.colorama.ansi), \hyperpage{57} + \item AnsiCodes (class in src.colorama.ansi), \hyperpage{58} + \item AnsiCursor (class in src.colorama.ansi), \hyperpage{58} + \item AnsiFore (class in src.colorama.ansi), \hyperpage{58} + \item AnsiStyle (class in src.colorama.ansi), \hyperpage{58} + \item AnsiToWin32 (class in src.colorama.ansitowin32), \hyperpage{59} + \item append() (src.environment.Environ method), \hyperpage{29} + \item append() (src.environment.SalomeEnviron method), \hyperpage{30} + \item append() (src.fileEnviron.FileEnviron method), \hyperpage{35} + \item append() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{36} + \item append() (src.fileEnviron.ScreenEnviron method), \hyperpage{37} + \item append() (src.pyconf.Sequence method), \hyperpage{52} + \item append\_node\_attrib() (in module src.xmlManager), \hyperpage{57} + \item append\_node\_attrib() (src.xmlManager.XmlLogFile method), \hyperpage{56} + \item append\_node\_text() (src.xmlManager.XmlLogFile method), \hyperpage{56} + \item append\_value() (src.environment.Environ method), \hyperpage{29} + \item append\_value() (src.fileEnviron.ContextFileEnviron method), \hyperpage{34} + \item append\_value() (src.fileEnviron.FileEnviron method), \hyperpage{35} + \item append\_value() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{36} + \item archive\_extract() (in module src.system), \hyperpage{53} + + \indexspace + \bigletter B + \item BACK() (src.colorama.ansi.AnsiCursor method), \hyperpage{58} + \item back() (src.colorama.winterm.WinTerm method), \hyperpage{60} + \item base() (src.\_\_init\_\_.Path method), \hyperpage{23} + \item BashFileEnviron (class in src.fileEnviron), \hyperpage{33} + \item batch() (in module src.fork), \hyperpage{38} + \item batch\_salome() (in module src.fork), \hyperpage{38} + \item BatFileEnviron (class in src.fileEnviron), \hyperpage{33} + \item BLACK (src.colorama.ansi.AnsiBack attribute), \hyperpage{57} + \item BLACK (src.colorama.ansi.AnsiFore attribute), \hyperpage{58} + \item BLACK (src.colorama.winterm.WinColor attribute), \hyperpage{60} + \item BLUE (src.colorama.ansi.AnsiBack attribute), \hyperpage{57} + \item BLUE (src.colorama.ansi.AnsiFore attribute), \hyperpage{58} + \item BLUE (src.colorama.winterm.WinColor attribute), \hyperpage{60} + \item BRIGHT (src.colorama.ansi.AnsiStyle attribute), \hyperpage{59} + \item BRIGHT (src.colorama.winterm.WinStyle attribute), \hyperpage{60} + \item BRIGHT\_BACKGROUND (src.colorama.winterm.WinStyle attribute), \hyperpage{60} + \item build\_configure() (src.compilation.Builder method), \hyperpage{27} + \item Builder (class in src.compilation), \hyperpage{27} + + \indexspace + \bigletter C + \item call\_win32() (src.colorama.ansitowin32.AnsiToWin32 method), \hyperpage{59} + \item change\_to\_launcher() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{36} + \item check() (src.compilation.Builder method), \hyperpage{27} + \item check\_config\_exists() (in module src.product), \hyperpage{42} + \item check\_config\_has\_application() (in module src.\_\_init\_\_), \hyperpage{23} + \item check\_config\_has\_profile() (in module src.\_\_init\_\_), \hyperpage{24} + \item check\_installation() (in module src.product), \hyperpage{42} + \item check\_source() (in module src.product), \hyperpage{43} + \item chmod() (src.\_\_init\_\_.Path method), \hyperpage{23} + \item cleancolor() (in module src.printcolors), \hyperpage{41} + \item clear\_line() (in module src.colorama.ansi), \hyperpage{59} + \item clear\_screen() (in module src.colorama.ansi), \hyperpage{59} + \item close() (src.debug.OutStream method), \hyperpage{28} + \item close() (src.ElementTree.TreeBuilder method), \hyperpage{26} + \item close() (src.ElementTree.XMLTreeBuilder method), \hyperpage{26} + \item close() (src.pyconf.ConfigInputStream method), \hyperpage{48} + \item close() (src.pyconf.ConfigOutputStream method), \hyperpage{49} + \item cmake() (src.compilation.Builder method), \hyperpage{27} + \item code\_to\_chars() (in module src.colorama.ansi), \hyperpage{59} + \item colorama\_text() (in module src.colorama.initialise), \hyperpage{60} + \item command\_value() (src.environment.Environ method), \hyperpage{29} + \item command\_value() (src.fileEnviron.BashFileEnviron method), \hyperpage{33} + \item command\_value() (src.fileEnviron.BatFileEnviron method), \hyperpage{33} + \item command\_value() (src.fileEnviron.ContextFileEnviron method), \hyperpage{34} + \item command\_value() (src.fileEnviron.FileEnviron method), \hyperpage{35} + \item command\_value() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{36} + \item command\_value() (src.fileEnviron.ScreenEnviron method), \hyperpage{37} + \item Comment() (in module src.ElementTree), \hyperpage{25} + \item complete\_environment() (src.compilation.Builder method), \hyperpage{27} + \item Config (class in src.pyconf), \hyperpage{47} + \item Config.Namespace (class in src.pyconf), \hyperpage{47} + \item config\_has\_application() (in module src.\_\_init\_\_), \hyperpage{24} + \item ConfigError, \hyperpage{48} + \item ConfigFormatError, \hyperpage{48} + \item ConfigInputStream (class in src.pyconf), \hyperpage{48} + \item ConfigList (class in src.pyconf), \hyperpage{48} + \item ConfigMerger (class in src.pyconf), \hyperpage{48} + \item ConfigOutputStream (class in src.pyconf), \hyperpage{49} + \item ConfigReader (class in src.pyconf), \hyperpage{49} + \item ConfigResolutionError, \hyperpage{51} + \item configure() (src.compilation.Builder method), \hyperpage{27} + \item Container (class in src.pyconf), \hyperpage{51} + \item ContextFileEnviron (class in src.fileEnviron), \hyperpage{33} + \item convert\_ansi() (src.colorama.ansitowin32.AnsiToWin32 method), \hyperpage{59} + \item convert\_osc() (src.colorama.ansitowin32.AnsiToWin32 method), \hyperpage{59} + \item copy() (src.\_\_init\_\_.Path method), \hyperpage{23} + \item copydir() (src.\_\_init\_\_.Path method), \hyperpage{23} + \item copyfile() (src.\_\_init\_\_.Path method), \hyperpage{23} + \item copylink() (src.\_\_init\_\_.Path method), \hyperpage{23} + \item cursor\_adjust() (src.colorama.winterm.WinTerm method), \hyperpage{60} + \item cvs\_extract() (in module src.system), \hyperpage{54} + \item CYAN (src.colorama.ansi.AnsiBack attribute), \hyperpage{57} + \item CYAN (src.colorama.ansi.AnsiFore attribute), \hyperpage{58} + \item CYAN (src.colorama.winterm.WinColor attribute), \hyperpage{60} + + \indexspace + \bigletter D + \item data() (src.ElementTree.TreeBuilder method), \hyperpage{26} + \item date\_to\_datetime() (in module src.logger), \hyperpage{39} + \item deepcopy\_list() (in module src.\_\_init\_\_), \hyperpage{24} + \item deepCopyMapping() (in module src.pyconf), \hyperpage{53} + \item defaultMergeResolve() (in module src.pyconf), \hyperpage{53} + \item defaultStreamOpener() (in module src.pyconf), \hyperpage{53} + \item deinit() (in module src.colorama.initialise), \hyperpage{60} + \item delimiter (src.template.MyTemplate attribute), \hyperpage{55} + \item DIM (src.colorama.ansi.AnsiStyle attribute), \hyperpage{59} + \item dir() (src.\_\_init\_\_.Path method), \hyperpage{23} + \item do\_batch\_script\_build() (src.compilation.Builder method), \hyperpage{27} + \item do\_default\_build() (src.compilation.Builder method), \hyperpage{27} + \item do\_python\_script\_build() (src.compilation.Builder method), \hyperpage{27} + \item do\_script\_build() (src.compilation.Builder method), \hyperpage{27} + \item doctype() (src.ElementTree.XMLTreeBuilder method), \hyperpage{26} + \item DOWN() (src.colorama.ansi.AnsiCursor method), \hyperpage{58} + \item dump() (in module src.ElementTree), \hyperpage{25} + \item dump() (src.environment.SalomeEnviron method), \hyperpage{30} + + \indexspace + \bigletter E + \item Element() (in module src.ElementTree), \hyperpage{25} + \item ElementTree (class in src.ElementTree), \hyperpage{25} + \item end() (src.ElementTree.TreeBuilder method), \hyperpage{26} + \item end\_write() (src.logger.Logger method), \hyperpage{39} + \item ensure\_path\_exists() (in module src.\_\_init\_\_), \hyperpage{24} + \item Environ (class in src.environment), \hyperpage{29} + \item erase\_line() (src.colorama.winterm.WinTerm method), \hyperpage{60} + \item erase\_screen() (src.colorama.winterm.WinTerm method), \hyperpage{60} + \item error() (src.logger.Logger method), \hyperpage{39} + \item evaluate() (src.pyconf.Container method), \hyperpage{51} + \item evaluate() (src.pyconf.Expression method), \hyperpage{51} + \item exists() (src.\_\_init\_\_.Path method), \hyperpage{23} + \item Expression (class in src.pyconf), \hyperpage{51} + \item extract\_params() (src.colorama.ansitowin32.AnsiToWin32 method), \hyperpage{59} + + \indexspace + \bigletter F + \item feed() (src.ElementTree.XMLTreeBuilder method), \hyperpage{26} + \item FileEnviron (class in src.fileEnviron), \hyperpage{34} + \item FileEnvWriter (class in src.environment), \hyperpage{30} + \item find() (src.ElementTree.ElementTree method), \hyperpage{25} + \item find\_file\_in\_lpath() (in module src.\_\_init\_\_), \hyperpage{24} + \item find\_node\_by\_attrib() (in module src.xmlManager), \hyperpage{57} + \item findall() (src.ElementTree.ElementTree method), \hyperpage{25} + \item findConfig() (src.pyconf.Reference method), \hyperpage{52} + \item findtext() (src.ElementTree.ElementTree method), \hyperpage{26} + \item finish() (src.environment.SalomeEnviron method), \hyperpage{31} + \item finish() (src.fileEnviron.BashFileEnviron method), \hyperpage{33} + \item finish() (src.fileEnviron.BatFileEnviron method), \hyperpage{33} + \item finish() (src.fileEnviron.ContextFileEnviron method), \hyperpage{34} + \item finish() (src.fileEnviron.FileEnviron method), \hyperpage{35} + \item finish() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{37} + \item flush() (src.logger.Logger method), \hyperpage{39} + \item flush() (src.pyconf.ConfigOutputStream method), \hyperpage{49} + \item fore() (src.colorama.winterm.WinTerm method), \hyperpage{60} + \item FORWARD() (src.colorama.ansi.AnsiCursor method), \hyperpage{58} + \item fromstring() (in module src.ElementTree), \hyperpage{26} + + \indexspace + \bigletter G + \item generate\_launching\_commands() (src.test\_module.Test method), \hyperpage{55} + \item generate\_script() (src.test\_module.Test method), \hyperpage{55} + \item get() (src.environment.Environ method), \hyperpage{29} + \item get() (src.environment.SalomeEnviron method), \hyperpage{31} + \item get() (src.fileEnviron.BatFileEnviron method), \hyperpage{33} + \item get() (src.fileEnviron.ContextFileEnviron method), \hyperpage{34} + \item get() (src.fileEnviron.FileEnviron method), \hyperpage{35} + \item get() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{37} + \item get() (src.fileEnviron.ScreenEnviron method), \hyperpage{37} + \item get() (src.pyconf.Mapping method), \hyperpage{52} + \item get\_attrib() (src.xmlManager.ReadXmlFile method), \hyperpage{56} + \item get\_attrs() (src.colorama.winterm.WinTerm method), \hyperpage{60} + \item get\_base\_install\_dir() (in module src.product), \hyperpage{43} + \item get\_base\_path() (in module src.\_\_init\_\_), \hyperpage{24} + \item get\_cfg\_param() (in module src.\_\_init\_\_), \hyperpage{24} + \item get\_distrib\_version() (in module src.architecture), \hyperpage{26} + \item get\_distribution() (in module src.architecture), \hyperpage{26} + \item get\_file\_environ() (in module src.fileEnviron), \hyperpage{38} + \item get\_install\_dir() (in module src.product), \hyperpage{43} + \item get\_launcher\_name() (in module src.\_\_init\_\_), \hyperpage{24} + \item get\_log\_path() (in module src.\_\_init\_\_), \hyperpage{25} + \item get\_names() (src.environment.SalomeEnviron method), \hyperpage{31} + \item get\_nb\_proc() (in module src.architecture), \hyperpage{27} + \item get\_node\_text() (src.xmlManager.ReadXmlFile method), \hyperpage{56} + \item get\_position() (src.colorama.winterm.WinTerm method), \hyperpage{60} + \item get\_product\_components() (in module src.product), \hyperpage{43} + \item get\_product\_config() (in module src.product), \hyperpage{43} + \item get\_product\_dependencies() (in module src.product), \hyperpage{43} + \item get\_product\_section() (in module src.product), \hyperpage{44} + \item get\_products\_infos() (in module src.product), \hyperpage{44} + \item get\_property\_in\_product\_cfg() (in module src.\_\_init\_\_), \hyperpage{25} + \item get\_python\_version() (in module src.architecture), \hyperpage{27} + \item get\_salome\_version() (in module src.\_\_init\_\_), \hyperpage{25} + \item get\_test\_timeout() (src.test\_module.Test method), \hyperpage{55} + \item get\_tmp\_dir() (src.test\_module.Test method), \hyperpage{55} + \item get\_tmp\_filename() (in module src.\_\_init\_\_), \hyperpage{25} + \item get\_user() (in module src.architecture), \hyperpage{27} + \item get\_win32\_calls() (src.colorama.ansitowin32.AnsiToWin32 method), \hyperpage{59} + \item getByPath() (src.pyconf.Config method), \hyperpage{48} + \item getByPath() (src.pyconf.ConfigList method), \hyperpage{48} + \item getChar() (src.pyconf.ConfigReader method), \hyperpage{49} + \item getiterator() (src.ElementTree.ElementTree method), \hyperpage{26} + \item getLocalEnv() (in module src.debug), \hyperpage{28} + \item getroot() (src.ElementTree.ElementTree method), \hyperpage{26} + \item getRootAttrib() (src.xmlManager.ReadXmlFile method), \hyperpage{56} + \item getStrConfigDbg() (in module src.debug), \hyperpage{28} + \item getStrConfigStd() (in module src.debug), \hyperpage{28} + \item getTmpDirDEFAULT() (in module src.test\_module), \hyperpage{55} + \item getToken() (src.pyconf.ConfigReader method), \hyperpage{49} + \item git\_extract() (in module src.system), \hyperpage{54} + \item GREEN (src.colorama.ansi.AnsiBack attribute), \hyperpage{57} + \item GREEN (src.colorama.ansi.AnsiFore attribute), \hyperpage{58} + \item GREEN (src.colorama.winterm.WinColor attribute), \hyperpage{60} + \item GREY (src.colorama.winterm.WinColor attribute), \hyperpage{60} + + \indexspace + \bigletter H + \item hack\_libtool() (src.compilation.Builder method), \hyperpage{27} + \item handleMismatch() (src.pyconf.ConfigMerger method), \hyperpage{48} + \item handleRemoveReadonly() (in module src.\_\_init\_\_), \hyperpage{25} + + \indexspace + \bigletter I + \item indent() (in module src.debug), \hyperpage{28} + \item init() (in module src.colorama.initialise), \hyperpage{60} + \item install() (src.compilation.Builder method), \hyperpage{27} + \item InStream (class in src.debug), \hyperpage{28} + \item is\_a\_tty() (in module src.colorama.ansitowin32), \hyperpage{59} + \item is\_defined() (src.environment.Environ method), \hyperpage{29} + \item is\_defined() (src.environment.SalomeEnviron method), \hyperpage{31} + \item is\_defined() (src.fileEnviron.FileEnviron method), \hyperpage{35} + \item is\_defined() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{37} + \item is\_defined() (src.fileEnviron.ScreenEnviron method), \hyperpage{37} + \item is\_stream\_closed() (in module src.colorama.ansitowin32), \hyperpage{59} + \item is\_windows() (in module src.architecture), \hyperpage{27} + \item isdir() (src.\_\_init\_\_.Path method), \hyperpage{23} + \item iselement() (in module src.ElementTree), \hyperpage{26} + \item isfile() (src.\_\_init\_\_.Path method), \hyperpage{23} + \item islink() (src.\_\_init\_\_.Path method), \hyperpage{23} + \item isWord() (in module src.pyconf), \hyperpage{53} + \item iteritems() (src.pyconf.Mapping method), \hyperpage{52} + \item iterkeys() (src.pyconf.Mapping method), \hyperpage{52} + \item iterparse (class in src.ElementTree), \hyperpage{26} + + \indexspace + \bigletter K + \item keys() (src.pyconf.Mapping method), \hyperpage{52} + + \indexspace + \bigletter L + \item launch\_command() (in module src.fork), \hyperpage{38} + \item LauncherFileEnviron (class in src.fileEnviron), \hyperpage{36} + \item LIGHTBLACK\_EX (src.colorama.ansi.AnsiBack attribute), \hyperpage{57} + \item LIGHTBLACK\_EX (src.colorama.ansi.AnsiFore attribute), \hyperpage{58} + \item LIGHTBLUE\_EX (src.colorama.ansi.AnsiBack attribute), \hyperpage{57} + \item LIGHTBLUE\_EX (src.colorama.ansi.AnsiFore attribute), \hyperpage{58} + \item LIGHTCYAN\_EX (src.colorama.ansi.AnsiBack attribute), \hyperpage{58} + \item LIGHTCYAN\_EX (src.colorama.ansi.AnsiFore attribute), \hyperpage{58} + \item LIGHTGREEN\_EX (src.colorama.ansi.AnsiBack attribute), \hyperpage{58} + \item LIGHTGREEN\_EX (src.colorama.ansi.AnsiFore attribute), \hyperpage{58} + \item LIGHTMAGENTA\_EX (src.colorama.ansi.AnsiBack attribute), \hyperpage{58} + \item LIGHTMAGENTA\_EX (src.colorama.ansi.AnsiFore attribute), \hyperpage{58} + \item LIGHTRED\_EX (src.colorama.ansi.AnsiBack attribute), \hyperpage{58} + \item LIGHTRED\_EX (src.colorama.ansi.AnsiFore attribute), \hyperpage{58} + \item LIGHTWHITE\_EX (src.colorama.ansi.AnsiBack attribute), \hyperpage{58} + \item LIGHTWHITE\_EX (src.colorama.ansi.AnsiFore attribute), \hyperpage{58} + \item LIGHTYELLOW\_EX (src.colorama.ansi.AnsiBack attribute), \hyperpage{58} + \item LIGHTYELLOW\_EX (src.colorama.ansi.AnsiFore attribute), \hyperpage{58} + \item list() (src.\_\_init\_\_.Path method), \hyperpage{23} + \item list\_log\_file() (in module src.logger), \hyperpage{39} + \item load() (src.pyconf.Config method), \hyperpage{48} + \item load() (src.pyconf.ConfigReader method), \hyperpage{49} + \item load\_cfg\_environment() (src.environment.SalomeEnviron method), \hyperpage{31} + \item load\_environment() (in module src.environment), \hyperpage{32} + \item location() (src.pyconf.ConfigReader method), \hyperpage{49} + \item log() (src.compilation.Builder method), \hyperpage{27} + \item log\_command() (src.compilation.Builder method), \hyperpage{27} + \item Logger (class in src.logger), \hyperpage{38} + + \indexspace + \bigletter M + \item MAGENTA (src.colorama.ansi.AnsiBack attribute), \hyperpage{58} + \item MAGENTA (src.colorama.ansi.AnsiFore attribute), \hyperpage{58} + \item MAGENTA (src.colorama.winterm.WinColor attribute), \hyperpage{60} + \item make() (src.\_\_init\_\_.Path method), \hyperpage{23} + \item make() (src.compilation.Builder method), \hyperpage{27} + \item makePath() (in module src.pyconf), \hyperpage{53} + \item Mapping (class in src.pyconf), \hyperpage{51} + \item match() (src.pyconf.ConfigReader method), \hyperpage{50} + \item merge() (src.pyconf.ConfigMerger method), \hyperpage{48} + \item merge\_dicts() (in module src.\_\_init\_\_), \hyperpage{25} + \item mergeMapping() (src.pyconf.ConfigMerger method), \hyperpage{49} + \item mergeSequence() (src.pyconf.ConfigMerger method), \hyperpage{49} + \item MyTemplate (class in src.template), \hyperpage{55} + + \indexspace + \bigletter N + \item next() (src.ElementTree.iterparse method), \hyperpage{26} + \item next() (src.pyconf.Sequence.SeqIter method), \hyperpage{52} + \item NORMAL (src.colorama.ansi.AnsiStyle attribute), \hyperpage{59} + \item NORMAL (src.colorama.winterm.WinStyle attribute), \hyperpage{60} + + \indexspace + \bigletter O + \item only\_numbers() (in module src.\_\_init\_\_), \hyperpage{25} + \item Options (class in src.options), \hyperpage{40} + \item OptResult (class in src.options), \hyperpage{40} + \item OutStream (class in src.debug), \hyperpage{28} + \item overwriteKeys() (src.pyconf.ConfigMerger method), \hyperpage{49} + \item overwriteMergeResolve() (in module src.pyconf), \hyperpage{53} + + \indexspace + \bigletter P + \item parse() (in module src.ElementTree), \hyperpage{26} + \item parse() (src.ElementTree.ElementTree method), \hyperpage{26} + \item parse\_args() (src.options.Options method), \hyperpage{40} + \item parse\_date() (in module src.\_\_init\_\_), \hyperpage{25} + \item parseFactor() (src.pyconf.ConfigReader method), \hyperpage{50} + \item parseKeyValuePair() (src.pyconf.ConfigReader method), \hyperpage{50} + \item parseMapping() (src.pyconf.ConfigReader method), \hyperpage{50} + \item parseMappingBody() (src.pyconf.ConfigReader method), \hyperpage{50} + \item parseReference() (src.pyconf.ConfigReader method), \hyperpage{50} + \item parseScalar() (src.pyconf.ConfigReader method), \hyperpage{50} + \item parseSequence() (src.pyconf.ConfigReader method), \hyperpage{50} + \item parseSuffix() (src.pyconf.ConfigReader method), \hyperpage{50} + \item parseTerm() (src.pyconf.ConfigReader method), \hyperpage{50} + \item parseValue() (src.pyconf.ConfigReader method), \hyperpage{50} + \item Path (class in src.\_\_init\_\_), \hyperpage{23} + \item pattern (src.template.MyTemplate attribute), \hyperpage{55} + \item PI() (in module src.ElementTree), \hyperpage{26} + \item pop\_debug() (in module src.debug), \hyperpage{28} + \item POS() (src.colorama.ansi.AnsiCursor method), \hyperpage{58} + \item prepare() (src.compilation.Builder method), \hyperpage{27} + \item prepare\_testbase() (src.test\_module.Test method), \hyperpage{55} + \item prepare\_testbase\_from\_dir() (src.test\_module.Test method), \hyperpage{55} + \item prepare\_testbase\_from\_git() (src.test\_module.Test method), \hyperpage{55} + \item prepare\_testbase\_from\_svn() (src.test\_module.Test method), \hyperpage{55} + \item prepend() (src.environment.Environ method), \hyperpage{29} + \item prepend() (src.environment.SalomeEnviron method), \hyperpage{31} + \item prepend() (src.fileEnviron.FileEnviron method), \hyperpage{35} + \item prepend() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{37} + \item prepend() (src.fileEnviron.ScreenEnviron method), \hyperpage{37} + \item prepend\_value() (src.environment.Environ method), \hyperpage{29} + \item prepend\_value() (src.fileEnviron.ContextFileEnviron method), \hyperpage{34} + \item prepend\_value() (src.fileEnviron.FileEnviron method), \hyperpage{36} + \item prepend\_value() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{37} + \item print\_color\_map() (in module src.printcolors), \hyperpage{41} + \item print\_color\_range() (in module src.printcolors), \hyperpage{41} + \item print\_help() (src.options.Options method), \hyperpage{40} + \item print\_info() (in module src.\_\_init\_\_), \hyperpage{25} + \item print\_value() (in module src.printcolors), \hyperpage{41} + \item printc() (in module src.printcolors), \hyperpage{41} + \item printcError() (in module src.printcolors), \hyperpage{41} + \item printcHeader() (in module src.printcolors), \hyperpage{41} + \item printcHighlight() (in module src.printcolors), \hyperpage{41} + \item printcInfo() (in module src.printcolors), \hyperpage{42} + \item printcLabel() (in module src.printcolors), \hyperpage{42} + \item printcSuccess() (in module src.printcolors), \hyperpage{42} + \item printcWarning() (in module src.printcolors), \hyperpage{42} + \item ProcessingInstruction() (in module src.ElementTree), \hyperpage{26} + \item product\_compiles() (in module src.product), \hyperpage{44} + \item product\_has\_env\_script() (in module src.product), \hyperpage{44} + \item product\_has\_logo() (in module src.product), \hyperpage{44} + \item product\_has\_patches() (in module src.product), \hyperpage{44} + \item product\_has\_salome\_gui() (in module src.product), \hyperpage{44} + \item product\_has\_script() (in module src.product), \hyperpage{45} + \item product\_is\_autotools() (in module src.product), \hyperpage{45} + \item product\_is\_cmake() (in module src.product), \hyperpage{45} + \item product\_is\_cpp() (in module src.product), \hyperpage{45} + \item product\_is\_debug() (in module src.product), \hyperpage{45} + \item product\_is\_dev() (in module src.product), \hyperpage{45} + \item product\_is\_fixed() (in module src.product), \hyperpage{45} + \item product\_is\_generated() (in module src.product), \hyperpage{45} + \item product\_is\_mpi() (in module src.product), \hyperpage{46} + \item product\_is\_native() (in module src.product), \hyperpage{46} + \item product\_is\_salome() (in module src.product), \hyperpage{46} + \item product\_is\_sample() (in module src.product), \hyperpage{46} + \item product\_is\_smesh\_plugin() (in module src.product), \hyperpage{46} + \item product\_is\_vcs() (in module src.product), \hyperpage{46} + \item push\_debug() (in module src.debug), \hyperpage{28} + \item put\_initial\_xml\_fields() (src.logger.Logger method), \hyperpage{39} + \item put\_txt\_log\_in\_appli\_log\_dir() (src.compilation.Builder method), \hyperpage{27} + + \indexspace + \bigletter Q + \item QName (class in src.ElementTree), \hyperpage{26} + + \indexspace + \bigletter R + \item read() (src.pyconf.ConfigInputStream method), \hyperpage{48} + \item read\_config\_from\_a\_file() (in module src.\_\_init\_\_), \hyperpage{25} + \item read\_results() (src.test\_module.Test method), \hyperpage{55} + \item readline() (src.pyconf.ConfigInputStream method), \hyperpage{48} + \item readlink() (src.\_\_init\_\_.Path method), \hyperpage{23} + \item ReadXmlFile (class in src.xmlManager), \hyperpage{56} + \item RED (src.colorama.ansi.AnsiBack attribute), \hyperpage{58} + \item RED (src.colorama.ansi.AnsiFore attribute), \hyperpage{58} + \item RED (src.colorama.winterm.WinColor attribute), \hyperpage{60} + \item Reference (class in src.pyconf), \hyperpage{52} + \item reinit() (in module src.colorama.initialise), \hyperpage{60} + \item remove\_item\_from\_list() (in module src.\_\_init\_\_), \hyperpage{25} + \item removeNamespace() (src.pyconf.Config method), \hyperpage{48} + \item replace\_in\_file() (in module src.\_\_init\_\_), \hyperpage{25} + \item RESET (src.colorama.ansi.AnsiBack attribute), \hyperpage{58} + \item RESET (src.colorama.ansi.AnsiFore attribute), \hyperpage{58} + \item RESET\_ALL (src.colorama.ansi.AnsiStyle attribute), \hyperpage{59} + \item reset\_all() (in module src.colorama.initialise), \hyperpage{60} + \item reset\_all() (src.colorama.ansitowin32.AnsiToWin32 method), \hyperpage{59} + \item reset\_all() (src.colorama.winterm.WinTerm method), \hyperpage{60} + \item resolve() (src.pyconf.Reference method), \hyperpage{52} + \item rm() (src.\_\_init\_\_.Path method), \hyperpage{23} + \item run\_all\_tests() (src.test\_module.Test method), \hyperpage{55} + \item run\_env\_script() (src.environment.SalomeEnviron method), \hyperpage{31} + \item run\_env\_script() (src.fileEnviron.ScreenEnviron method), \hyperpage{38} + \item run\_grid\_tests() (src.test\_module.Test method), \hyperpage{55} + \item run\_script() (src.test\_module.Test method), \hyperpage{55} + \item run\_session\_tests() (src.test\_module.Test method), \hyperpage{55} + \item run\_simple\_env\_script() (src.environment.SalomeEnviron method), \hyperpage{31} + \item run\_testbase\_tests() (src.test\_module.Test method), \hyperpage{55} + \item run\_tests() (src.test\_module.Test method), \hyperpage{55} + + \indexspace + \bigletter S + \item SalomeEnviron (class in src.environment), \hyperpage{30} + \item SatException, \hyperpage{23} + \item saveConfigDbg() (in module src.debug), \hyperpage{28} + \item saveConfigStd() (in module src.debug), \hyperpage{28} + \item ScreenEnviron (class in src.fileEnviron), \hyperpage{37} + \item search\_known\_errors() (src.test\_module.Test method), \hyperpage{55} + \item Sequence (class in src.pyconf), \hyperpage{52} + \item Sequence.SeqIter (class in src.pyconf), \hyperpage{52} + \item set() (src.environment.Environ method), \hyperpage{30} + \item set() (src.environment.SalomeEnviron method), \hyperpage{31} + \item set() (src.fileEnviron.BashFileEnviron method), \hyperpage{33} + \item set() (src.fileEnviron.BatFileEnviron method), \hyperpage{33} + \item set() (src.fileEnviron.ContextFileEnviron method), \hyperpage{34} + \item set() (src.fileEnviron.FileEnviron method), \hyperpage{36} + \item set() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{37} + \item set() (src.fileEnviron.ScreenEnviron method), \hyperpage{38} + \item set\_a\_product() (src.environment.SalomeEnviron method), \hyperpage{31} + \item set\_application\_env() (src.environment.SalomeEnviron method), \hyperpage{32} + \item set\_attrs() (src.colorama.winterm.WinTerm method), \hyperpage{60} + \item set\_console() (src.colorama.winterm.WinTerm method), \hyperpage{60} + \item set\_cpp\_env() (src.environment.SalomeEnviron method), \hyperpage{32} + \item set\_cursor\_position() (src.colorama.winterm.WinTerm method), \hyperpage{60} + \item set\_full\_environ() (src.environment.SalomeEnviron method), \hyperpage{32} + \item set\_products() (src.environment.SalomeEnviron method), \hyperpage{32} + \item set\_python\_libdirs() (src.environment.SalomeEnviron method), \hyperpage{32} + \item set\_salome\_generic\_product\_env() (src.environment.SalomeEnviron method), \hyperpage{32} + \item set\_salome\_minimal\_product\_env() (src.environment.SalomeEnviron method), \hyperpage{32} + \item set\_title() (in module src.colorama.ansi), \hyperpage{59} + \item set\_title() (src.colorama.winterm.WinTerm method), \hyperpage{60} + \item SetConsoleTextAttribute() (in module src.colorama.win32), \hyperpage{60} + \item setPath() (src.pyconf.Container method), \hyperpage{51} + \item setStream() (src.pyconf.ConfigReader method), \hyperpage{51} + \item Shell (class in src.environment), \hyperpage{32} + \item should\_wrap() (src.colorama.ansitowin32.AnsiToWin32 method), \hyperpage{59} + \item show\_command\_log() (in module src.logger), \hyperpage{39} + \item show\_in\_editor() (in module src.system), \hyperpage{54} + \item show\_progress() (in module src.fork), \hyperpage{38} + \item smartcopy() (src.\_\_init\_\_.Path method), \hyperpage{23} + \item special\_path\_separator() (in module src.fileEnviron), \hyperpage{38} + \item src.\_\_init\_\_ (module), \hyperpage{23} + \item src.architecture (module), \hyperpage{26} + \item src.colorama (module), \hyperpage{57} + \item src.colorama.ansi (module), \hyperpage{57} + \item src.colorama.ansitowin32 (module), \hyperpage{59} + \item src.colorama.initialise (module), \hyperpage{60} + \item src.colorama.win32 (module), \hyperpage{60} + \item src.colorama.winterm (module), \hyperpage{60} + \item src.compilation (module), \hyperpage{27} + \item src.debug (module), \hyperpage{28} + \item src.ElementTree (module), \hyperpage{25} + \item src.environment (module), \hyperpage{29} + \item src.fileEnviron (module), \hyperpage{33} + \item src.fork (module), \hyperpage{38} + \item src.logger (module), \hyperpage{38} + \item src.options (module), \hyperpage{40} + \item src.printcolors (module), \hyperpage{41} + \item src.product (module), \hyperpage{42} + \item src.pyconf (module), \hyperpage{46} + \item src.system (module), \hyperpage{53} + \item src.template (module), \hyperpage{55} + \item src.test\_module (module), \hyperpage{55} + \item src.xmlManager (module), \hyperpage{56} + \item start() (src.ElementTree.TreeBuilder method), \hyperpage{26} + \item StreamWrapper (class in src.colorama.ansitowin32), \hyperpage{59} + \item style() (src.colorama.winterm.WinTerm method), \hyperpage{60} + \item SubElement() (in module src.ElementTree), \hyperpage{26} + \item substitute() (in module src.template), \hyperpage{55} + \item svn\_extract() (in module src.system), \hyperpage{54} + \item symlink() (src.\_\_init\_\_.Path method), \hyperpage{23} + + \indexspace + \bigletter T + \item Test (class in src.test\_module), \hyperpage{55} + \item timedelta\_total\_seconds() (in module src.logger), \hyperpage{40} + \item tofix() (in module src.debug), \hyperpage{29} + \item tostring() (in module src.ElementTree), \hyperpage{26} + \item TreeBuilder (class in src.ElementTree), \hyperpage{26} + + \indexspace + \bigletter U + \item UP() (src.colorama.ansi.AnsiCursor method), \hyperpage{58} + \item update\_hat\_xml() (in module src.logger), \hyperpage{40} + + \indexspace + \bigletter W + \item WHITE (src.colorama.ansi.AnsiBack attribute), \hyperpage{58} + \item WHITE (src.colorama.ansi.AnsiFore attribute), \hyperpage{58} + \item winapi\_test() (in module src.colorama.win32), \hyperpage{60} + \item WinColor (class in src.colorama.winterm), \hyperpage{60} + \item WinStyle (class in src.colorama.winterm), \hyperpage{60} + \item WinTerm (class in src.colorama.winterm), \hyperpage{60} + \item wmake() (src.compilation.Builder method), \hyperpage{28} + \item wrap\_stream() (in module src.colorama.initialise), \hyperpage{60} + \item write() (in module src.debug), \hyperpage{29} + \item write() (src.colorama.ansitowin32.AnsiToWin32 method), \hyperpage{59} + \item write() (src.colorama.ansitowin32.StreamWrapper method), \hyperpage{59} + \item write() (src.ElementTree.ElementTree method), \hyperpage{26} + \item write() (src.fileEnviron.ScreenEnviron method), \hyperpage{38} + \item write() (src.logger.Logger method), \hyperpage{39} + \item write() (src.pyconf.ConfigOutputStream method), \hyperpage{49} + \item write\_and\_convert() (src.colorama.ansitowin32.AnsiToWin32 method), \hyperpage{59} + \item write\_back() (in module src.fork), \hyperpage{38} + \item write\_cfgForPy\_file() (src.environment.FileEnvWriter method), \hyperpage{30} + \item write\_env\_file() (src.environment.FileEnvWriter method), \hyperpage{30} + \item write\_plain\_text() (src.colorama.ansitowin32.AnsiToWin32 method), \hyperpage{59} + \item write\_report() (in module src.xmlManager), \hyperpage{57} + \item write\_test\_margin() (src.test\_module.Test method), \hyperpage{55} + \item write\_tree() (src.xmlManager.XmlLogFile method), \hyperpage{56} + \item writeToStream() (src.pyconf.Container method), \hyperpage{51} + \item writeToStream() (src.pyconf.Mapping method), \hyperpage{52} + \item writeToStream() (src.pyconf.Sequence method), \hyperpage{52} + \item writeValue() (src.pyconf.Container method), \hyperpage{51} + + \indexspace + \bigletter X + \item XML() (in module src.ElementTree), \hyperpage{26} + \item XmlLogFile (class in src.xmlManager), \hyperpage{56} + \item XMLTreeBuilder (class in src.ElementTree), \hyperpage{26} + + \indexspace + \bigletter Y + \item YELLOW (src.colorama.ansi.AnsiBack attribute), \hyperpage{58} + \item YELLOW (src.colorama.ansi.AnsiFore attribute), \hyperpage{58} + \item YELLOW (src.colorama.winterm.WinColor attribute), \hyperpage{60} + +\end{theindex} diff --git a/doc/build/latex/salomeTools.log b/doc/build/latex/salomeTools.log new file mode 100644 index 0000000..38fb999 --- /dev/null +++ b/doc/build/latex/salomeTools.log @@ -0,0 +1,1664 @@ +This is pdfTeX, Version 3.14159265-2.6-1.40.18 (TeX Live 2017) (preloaded format=pdflatex 2018.4.13) 24 APR 2018 13:23 +entering extended mode + restricted \write18 enabled. + %&-line parsing enabled. +**salomeTools.tex +(./salomeTools.tex +LaTeX2e <2017-04-15> +Babel <3.18> and hyphenation patterns for 84 language(s) loaded. +(./sphinxmanual.cls +Document Class: sphinxmanual 2009/06/02 Document class (Sphinx manual) +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/report.cls +Document Class: report 2014/09/29 v1.4h Standard LaTeX document class +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/size10.clo +File: size10.clo 2014/09/29 v1.4h Standard LaTeX file (size option) +) +\c@part=\count79 +\c@chapter=\count80 +\c@section=\count81 +\c@subsection=\count82 +\c@subsubsection=\count83 +\c@paragraph=\count84 +\c@subparagraph=\count85 +\c@figure=\count86 +\c@table=\count87 +\abovecaptionskip=\skip41 +\belowcaptionskip=\skip42 +\bibindent=\dimen102 +)) +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/inputenc.st +y +Package: inputenc 2015/03/17 v1.2c Input encoding file +\inpenc@prehook=\toks14 +\inpenc@posthook=\toks15 + (/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/utf8.def +File: utf8.def 2017/01/28 v1.1t UTF-8 support for inputenc +Now handling font encoding OML ... +... no UTF-8 mapping file for font encoding OML +Now handling font encoding T1 ... +... processing UTF-8 mapping file for font encoding T1 + +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/t1enc.dfu +File: t1enc.dfu 2017/01/28 v1.1t UTF-8 support for inputenc + defining Unicode char U+00A0 (decimal 160) + defining Unicode char U+00A1 (decimal 161) + defining Unicode char U+00A3 (decimal 163) + defining Unicode char U+00AB (decimal 171) + defining Unicode char U+00AD (decimal 173) + defining Unicode char U+00BB (decimal 187) + defining Unicode char U+00BF (decimal 191) + defining Unicode char U+00C0 (decimal 192) + defining Unicode char U+00C1 (decimal 193) + defining Unicode char U+00C2 (decimal 194) + defining Unicode char U+00C3 (decimal 195) + defining Unicode char U+00C4 (decimal 196) + defining Unicode char U+00C5 (decimal 197) + defining Unicode char U+00C6 (decimal 198) + defining Unicode char U+00C7 (decimal 199) + defining Unicode char U+00C8 (decimal 200) + defining Unicode char U+00C9 (decimal 201) + defining Unicode char U+00CA (decimal 202) + defining Unicode char U+00CB (decimal 203) + defining Unicode char U+00CC (decimal 204) + defining Unicode char U+00CD (decimal 205) + defining Unicode char U+00CE (decimal 206) + defining Unicode char U+00CF (decimal 207) + defining Unicode char U+00D0 (decimal 208) + defining Unicode char U+00D1 (decimal 209) + defining Unicode char U+00D2 (decimal 210) + defining Unicode char U+00D3 (decimal 211) + defining Unicode char U+00D4 (decimal 212) + defining Unicode char U+00D5 (decimal 213) + defining Unicode char U+00D6 (decimal 214) + defining Unicode char U+00D8 (decimal 216) + defining Unicode char U+00D9 (decimal 217) + defining Unicode char U+00DA (decimal 218) + defining Unicode char U+00DB (decimal 219) + defining Unicode char U+00DC (decimal 220) + defining Unicode char U+00DD (decimal 221) + defining Unicode char U+00DE (decimal 222) + defining Unicode char U+00DF (decimal 223) + defining Unicode char U+00E0 (decimal 224) + defining Unicode char U+00E1 (decimal 225) + defining Unicode char U+00E2 (decimal 226) + defining Unicode char U+00E3 (decimal 227) + defining Unicode char U+00E4 (decimal 228) + defining Unicode char U+00E5 (decimal 229) + defining Unicode char U+00E6 (decimal 230) + defining Unicode char U+00E7 (decimal 231) + defining Unicode char U+00E8 (decimal 232) + defining Unicode char U+00E9 (decimal 233) + defining Unicode char U+00EA (decimal 234) + defining Unicode char U+00EB (decimal 235) + defining Unicode char U+00EC (decimal 236) + defining Unicode char U+00ED (decimal 237) + defining Unicode char U+00EE (decimal 238) + defining Unicode char U+00EF (decimal 239) + defining Unicode char U+00F0 (decimal 240) + defining Unicode char U+00F1 (decimal 241) + defining Unicode char U+00F2 (decimal 242) + defining Unicode char U+00F3 (decimal 243) + defining Unicode char U+00F4 (decimal 244) + defining Unicode char U+00F5 (decimal 245) + defining Unicode char U+00F6 (decimal 246) + defining Unicode char U+00F8 (decimal 248) + defining Unicode char U+00F9 (decimal 249) + defining Unicode char U+00FA (decimal 250) + defining Unicode char U+00FB (decimal 251) + defining Unicode char U+00FC (decimal 252) + defining Unicode char U+00FD (decimal 253) + defining Unicode char U+00FE (decimal 254) + defining Unicode char U+00FF (decimal 255) + defining Unicode char U+0100 (decimal 256) + defining Unicode char U+0101 (decimal 257) + defining Unicode char U+0102 (decimal 258) + defining Unicode char U+0103 (decimal 259) + defining Unicode char U+0104 (decimal 260) + defining Unicode char U+0105 (decimal 261) + defining Unicode char U+0106 (decimal 262) + defining Unicode char U+0107 (decimal 263) + defining Unicode char U+0108 (decimal 264) + defining Unicode char U+0109 (decimal 265) + defining Unicode char U+010A (decimal 266) + defining Unicode char U+010B (decimal 267) + defining Unicode char U+010C (decimal 268) + defining Unicode char U+010D (decimal 269) + defining Unicode char U+010E (decimal 270) + defining Unicode char U+010F (decimal 271) + defining Unicode char U+0110 (decimal 272) + defining Unicode char U+0111 (decimal 273) + defining Unicode char U+0112 (decimal 274) + defining Unicode char U+0113 (decimal 275) + defining Unicode char U+0114 (decimal 276) + defining Unicode char U+0115 (decimal 277) + defining Unicode char U+0116 (decimal 278) + defining Unicode char U+0117 (decimal 279) + defining Unicode char U+0118 (decimal 280) + defining Unicode char U+0119 (decimal 281) + defining Unicode char U+011A (decimal 282) + defining Unicode char U+011B (decimal 283) + defining Unicode char U+011C (decimal 284) + defining Unicode char U+011D (decimal 285) + defining Unicode char U+011E (decimal 286) + defining Unicode char U+011F (decimal 287) + defining Unicode char U+0120 (decimal 288) + defining Unicode char U+0121 (decimal 289) + defining Unicode char U+0122 (decimal 290) + defining Unicode char U+0123 (decimal 291) + defining Unicode char U+0124 (decimal 292) + defining Unicode char U+0125 (decimal 293) + defining Unicode char U+0128 (decimal 296) + defining Unicode char U+0129 (decimal 297) + defining Unicode char U+012A (decimal 298) + defining Unicode char U+012B (decimal 299) + defining Unicode char U+012C (decimal 300) + defining Unicode char U+012D (decimal 301) + defining Unicode char U+012E (decimal 302) + defining Unicode char U+012F (decimal 303) + defining Unicode char U+0130 (decimal 304) + defining Unicode char U+0131 (decimal 305) + defining Unicode char U+0132 (decimal 306) + defining Unicode char U+0133 (decimal 307) + defining Unicode char U+0134 (decimal 308) + defining Unicode char U+0135 (decimal 309) + defining Unicode char U+0136 (decimal 310) + defining Unicode char U+0137 (decimal 311) + defining Unicode char U+0139 (decimal 313) + defining Unicode char U+013A (decimal 314) + defining Unicode char U+013B (decimal 315) + defining Unicode char U+013C (decimal 316) + defining Unicode char U+013D (decimal 317) + defining Unicode char U+013E (decimal 318) + defining Unicode char U+0141 (decimal 321) + defining Unicode char U+0142 (decimal 322) + defining Unicode char U+0143 (decimal 323) + defining Unicode char U+0144 (decimal 324) + defining Unicode char U+0145 (decimal 325) + defining Unicode char U+0146 (decimal 326) + defining Unicode char U+0147 (decimal 327) + defining Unicode char U+0148 (decimal 328) + defining Unicode char U+014A (decimal 330) + defining Unicode char U+014B (decimal 331) + defining Unicode char U+014C (decimal 332) + defining Unicode char U+014D (decimal 333) + defining Unicode char U+014E (decimal 334) + defining Unicode char U+014F (decimal 335) + defining Unicode char U+0150 (decimal 336) + defining Unicode char U+0151 (decimal 337) + defining Unicode char U+0152 (decimal 338) + defining Unicode char U+0153 (decimal 339) + defining Unicode char U+0154 (decimal 340) + defining Unicode char U+0155 (decimal 341) + defining Unicode char U+0156 (decimal 342) + defining Unicode char U+0157 (decimal 343) + defining Unicode char U+0158 (decimal 344) + defining Unicode char U+0159 (decimal 345) + defining Unicode char U+015A (decimal 346) + defining Unicode char U+015B (decimal 347) + defining Unicode char U+015C (decimal 348) + defining Unicode char U+015D (decimal 349) + defining Unicode char U+015E (decimal 350) + defining Unicode char U+015F (decimal 351) + defining Unicode char U+0160 (decimal 352) + defining Unicode char U+0161 (decimal 353) + defining Unicode char U+0162 (decimal 354) + defining Unicode char U+0163 (decimal 355) + defining Unicode char U+0164 (decimal 356) + defining Unicode char U+0165 (decimal 357) + defining Unicode char U+0168 (decimal 360) + defining Unicode char U+0169 (decimal 361) + defining Unicode char U+016A (decimal 362) + defining Unicode char U+016B (decimal 363) + defining Unicode char U+016C (decimal 364) + defining Unicode char U+016D (decimal 365) + defining Unicode char U+016E (decimal 366) + defining Unicode char U+016F (decimal 367) + defining Unicode char U+0170 (decimal 368) + defining Unicode char U+0171 (decimal 369) + defining Unicode char U+0172 (decimal 370) + defining Unicode char U+0173 (decimal 371) + defining Unicode char U+0174 (decimal 372) + defining Unicode char U+0175 (decimal 373) + defining Unicode char U+0176 (decimal 374) + defining Unicode char U+0177 (decimal 375) + defining Unicode char U+0178 (decimal 376) + defining Unicode char U+0179 (decimal 377) + defining Unicode char U+017A (decimal 378) + defining Unicode char U+017B (decimal 379) + defining Unicode char U+017C (decimal 380) + defining Unicode char U+017D (decimal 381) + defining Unicode char U+017E (decimal 382) + defining Unicode char U+01CD (decimal 461) + defining Unicode char U+01CE (decimal 462) + defining Unicode char U+01CF (decimal 463) + defining Unicode char U+01D0 (decimal 464) + defining Unicode char U+01D1 (decimal 465) + defining Unicode char U+01D2 (decimal 466) + defining Unicode char U+01D3 (decimal 467) + defining Unicode char U+01D4 (decimal 468) + defining Unicode char U+01E2 (decimal 482) + defining Unicode char U+01E3 (decimal 483) + defining Unicode char U+01E6 (decimal 486) + defining Unicode char U+01E7 (decimal 487) + defining Unicode char U+01E8 (decimal 488) + defining Unicode char U+01E9 (decimal 489) + defining Unicode char U+01EA (decimal 490) + defining Unicode char U+01EB (decimal 491) + defining Unicode char U+01F0 (decimal 496) + defining Unicode char U+01F4 (decimal 500) + defining Unicode char U+01F5 (decimal 501) + defining Unicode char U+0218 (decimal 536) + defining Unicode char U+0219 (decimal 537) + defining Unicode char U+021A (decimal 538) + defining Unicode char U+021B (decimal 539) + defining Unicode char U+0232 (decimal 562) + defining Unicode char U+0233 (decimal 563) + defining Unicode char U+1E02 (decimal 7682) + defining Unicode char U+1E03 (decimal 7683) + defining Unicode char U+200C (decimal 8204) + defining Unicode char U+2010 (decimal 8208) + defining Unicode char U+2011 (decimal 8209) + defining Unicode char U+2012 (decimal 8210) + defining Unicode char U+2013 (decimal 8211) + defining Unicode char U+2014 (decimal 8212) + defining Unicode char U+2015 (decimal 8213) + defining Unicode char U+2018 (decimal 8216) + defining Unicode char U+2019 (decimal 8217) + defining Unicode char U+201A (decimal 8218) + defining Unicode char U+201C (decimal 8220) + defining Unicode char U+201D (decimal 8221) + defining Unicode char U+201E (decimal 8222) + defining Unicode char U+2030 (decimal 8240) + defining Unicode char U+2031 (decimal 8241) + defining Unicode char U+2039 (decimal 8249) + defining Unicode char U+203A (decimal 8250) + defining Unicode char U+2423 (decimal 9251) + defining Unicode char U+1E20 (decimal 7712) + defining Unicode char U+1E21 (decimal 7713) +) +Now handling font encoding OT1 ... +... processing UTF-8 mapping file for font encoding OT1 + +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/ot1enc.dfu +File: ot1enc.dfu 2017/01/28 v1.1t UTF-8 support for inputenc + defining Unicode char U+00A0 (decimal 160) + defining Unicode char U+00A1 (decimal 161) + defining Unicode char U+00A3 (decimal 163) + defining Unicode char U+00AD (decimal 173) + defining Unicode char U+00B8 (decimal 184) + defining Unicode char U+00BF (decimal 191) + defining Unicode char U+00C5 (decimal 197) + defining Unicode char U+00C6 (decimal 198) + defining Unicode char U+00D8 (decimal 216) + defining Unicode char U+00DF (decimal 223) + defining Unicode char U+00E6 (decimal 230) + defining Unicode char U+00EC (decimal 236) + defining Unicode char U+00ED (decimal 237) + defining Unicode char U+00EE (decimal 238) + defining Unicode char U+00EF (decimal 239) + defining Unicode char U+00F8 (decimal 248) + defining Unicode char U+0131 (decimal 305) + defining Unicode char U+0141 (decimal 321) + defining Unicode char U+0142 (decimal 322) + defining Unicode char U+0152 (decimal 338) + defining Unicode char U+0153 (decimal 339) + defining Unicode char U+0174 (decimal 372) + defining Unicode char U+0175 (decimal 373) + defining Unicode char U+0176 (decimal 374) + defining Unicode char U+0177 (decimal 375) + defining Unicode char U+0218 (decimal 536) + defining Unicode char U+0219 (decimal 537) + defining Unicode char U+021A (decimal 538) + defining Unicode char U+021B (decimal 539) + defining Unicode char U+2013 (decimal 8211) + defining Unicode char U+2014 (decimal 8212) + defining Unicode char U+2018 (decimal 8216) + defining Unicode char U+2019 (decimal 8217) + defining Unicode char U+201C (decimal 8220) + defining Unicode char U+201D (decimal 8221) +) +Now handling font encoding OMS ... +... processing UTF-8 mapping file for font encoding OMS +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/omsenc.dfu +File: omsenc.dfu 2017/01/28 v1.1t UTF-8 support for inputenc + defining Unicode char U+00A7 (decimal 167) + defining Unicode char U+00B6 (decimal 182) + defining Unicode char U+00B7 (decimal 183) + defining Unicode char U+2020 (decimal 8224) + defining Unicode char U+2021 (decimal 8225) + defining Unicode char U+2022 (decimal 8226) +) +Now handling font encoding OMX ... +... no UTF-8 mapping file for font encoding OMX +Now handling font encoding U ... +... no UTF-8 mapping file for font encoding U + defining Unicode char U+00A9 (decimal 169) + defining Unicode char U+00AA (decimal 170) + defining Unicode char U+00AE (decimal 174) + defining Unicode char U+00BA (decimal 186) + defining Unicode char U+02C6 (decimal 710) + defining Unicode char U+02DC (decimal 732) + defining Unicode char U+200C (decimal 8204) + defining Unicode char U+2026 (decimal 8230) + defining Unicode char U+2122 (decimal 8482) + defining Unicode char U+2423 (decimal 9251) +)) + defining Unicode char U+00A0 (decimal 160) + +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/fontenc.sty +Package: fontenc 2017/04/05 v2.0i Standard LaTeX package +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/t1enc.def +File: t1enc.def 2017/04/05 v2.0i Standard LaTeX file +LaTeX Font Info: Redeclaring font encoding T1 on input line 48. +)) +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/babel/babel.st +y +Package: babel 2018/02/14 3.18 The Babel package + +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/babel/switch.d +ef +File: switch.def 2018/02/14 3.18 Babel switching mechanism +) +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/babel-english/ +english.ldf +Language: english 2017/06/06 v3.3r English support from the babel system + +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/babel/babel.de +f +File: babel.def 2018/02/14 3.18 Babel common definitions +\babel@savecnt=\count88 +\U@D=\dimen103 + +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/babel/txtbabel +.def) +\bbl@dirlevel=\count89 +) +\l@canadian = a dialect from \language\l@american +\l@australian = a dialect from \language\l@british +\l@newzealand = a dialect from \language\l@british +)) +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/times.sty +Package: times 2005/04/12 PSNFSS-v9.2a (SPQR) +) (./fncychap.sty +Package: fncychap 2007/07/30 v1.34 LaTeX package (Revised chapters) +\RW=\skip43 +\mylen=\skip44 +\myhi=\skip45 +\px=\skip46 +\py=\skip47 +\pyy=\skip48 +\pxx=\skip49 +\c@AlphaCnt=\count90 +\c@AlphaDecCnt=\count91 +) +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/tools/longtable. +sty +Package: longtable 2014/10/28 v4.11 Multi-page Table package (DPC) +\LTleft=\skip50 +\LTright=\skip51 +\LTpre=\skip52 +\LTpost=\skip53 +\LTchunksize=\count92 +\LTcapwidth=\dimen104 +\LT@head=\box26 +\LT@firsthead=\box27 +\LT@foot=\box28 +\LT@lastfoot=\box29 +\LT@cols=\count93 +\LT@rows=\count94 +\c@LT@tables=\count95 +\c@LT@chunks=\count96 +\LT@p@ftn=\toks16 +) (./sphinx.sty +Package: sphinx 2010/01/15 LaTeX package (Sphinx markup) + +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/textcomp.st +y +Package: textcomp 2017/04/05 v2.0i Standard LaTeX package +Package textcomp Info: Sub-encoding information: +(textcomp) 5 = only ISO-Adobe without \textcurrency +(textcomp) 4 = 5 + \texteuro +(textcomp) 3 = 4 + \textohm +(textcomp) 2 = 3 + \textestimated + \textcurrency +(textcomp) 1 = TS1 - \textcircled - \t +(textcomp) 0 = TS1 (full) +(textcomp) Font families with sub-encoding setting implement +(textcomp) only a restricted character set as indicated. +(textcomp) Family '?' is the default used for unknown fonts. +(textcomp) See the documentation for details. +Package textcomp Info: Setting ? sub-encoding to TS1/1 on input line 79. + +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/ts1enc.def +File: ts1enc.def 2001/06/05 v3.0e (jk/car/fm) Standard LaTeX file +Now handling font encoding TS1 ... +... processing UTF-8 mapping file for font encoding TS1 + +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/ts1enc.dfu +File: ts1enc.dfu 2017/01/28 v1.1t UTF-8 support for inputenc + defining Unicode char U+00A2 (decimal 162) + defining Unicode char U+00A3 (decimal 163) + defining Unicode char U+00A4 (decimal 164) + defining Unicode char U+00A5 (decimal 165) + defining Unicode char U+00A6 (decimal 166) + defining Unicode char U+00A7 (decimal 167) + defining Unicode char U+00A8 (decimal 168) + defining Unicode char U+00A9 (decimal 169) + defining Unicode char U+00AA (decimal 170) + defining Unicode char U+00AC (decimal 172) + defining Unicode char U+00AE (decimal 174) + defining Unicode char U+00AF (decimal 175) + defining Unicode char U+00B0 (decimal 176) + defining Unicode char U+00B1 (decimal 177) + defining Unicode char U+00B2 (decimal 178) + defining Unicode char U+00B3 (decimal 179) + defining Unicode char U+00B4 (decimal 180) + defining Unicode char U+00B5 (decimal 181) + defining Unicode char U+00B6 (decimal 182) + defining Unicode char U+00B7 (decimal 183) + defining Unicode char U+00B9 (decimal 185) + defining Unicode char U+00BA (decimal 186) + defining Unicode char U+00BC (decimal 188) + defining Unicode char U+00BD (decimal 189) + defining Unicode char U+00BE (decimal 190) + defining Unicode char U+00D7 (decimal 215) + defining Unicode char U+00F7 (decimal 247) + defining Unicode char U+0192 (decimal 402) + defining Unicode char U+02C7 (decimal 711) + defining Unicode char U+02D8 (decimal 728) + defining Unicode char U+02DD (decimal 733) + defining Unicode char U+0E3F (decimal 3647) + defining Unicode char U+2016 (decimal 8214) + defining Unicode char U+2020 (decimal 8224) + defining Unicode char U+2021 (decimal 8225) + defining Unicode char U+2022 (decimal 8226) + defining Unicode char U+2030 (decimal 8240) + defining Unicode char U+2031 (decimal 8241) + defining Unicode char U+203B (decimal 8251) + defining Unicode char U+203D (decimal 8253) + defining Unicode char U+2044 (decimal 8260) + defining Unicode char U+204E (decimal 8270) + defining Unicode char U+2052 (decimal 8274) + defining Unicode char U+20A1 (decimal 8353) + defining Unicode char U+20A4 (decimal 8356) + defining Unicode char U+20A6 (decimal 8358) + defining Unicode char U+20A9 (decimal 8361) + defining Unicode char U+20AB (decimal 8363) + defining Unicode char U+20AC (decimal 8364) + defining Unicode char U+20B1 (decimal 8369) + defining Unicode char U+2103 (decimal 8451) + defining Unicode char U+2116 (decimal 8470) + defining Unicode char U+2117 (decimal 8471) + defining Unicode char U+211E (decimal 8478) + defining Unicode char U+2120 (decimal 8480) + defining Unicode char U+2122 (decimal 8482) + defining Unicode char U+2126 (decimal 8486) + defining Unicode char U+2127 (decimal 8487) + defining Unicode char U+212E (decimal 8494) + defining Unicode char U+2190 (decimal 8592) + defining Unicode char U+2191 (decimal 8593) + defining Unicode char U+2192 (decimal 8594) + defining Unicode char U+2193 (decimal 8595) + defining Unicode char U+2329 (decimal 9001) + defining Unicode char U+232A (decimal 9002) + defining Unicode char U+2422 (decimal 9250) + defining Unicode char U+25E6 (decimal 9702) + defining Unicode char U+25EF (decimal 9711) + defining Unicode char U+266A (decimal 9834) +)) +LaTeX Info: Redefining \oldstylenums on input line 334. +Package textcomp Info: Setting cmr sub-encoding to TS1/0 on input line 349. +Package textcomp Info: Setting cmss sub-encoding to TS1/0 on input line 350. +Package textcomp Info: Setting cmtt sub-encoding to TS1/0 on input line 351. +Package textcomp Info: Setting cmvtt sub-encoding to TS1/0 on input line 352. +Package textcomp Info: Setting cmbr sub-encoding to TS1/0 on input line 353. +Package textcomp Info: Setting cmtl sub-encoding to TS1/0 on input line 354. +Package textcomp Info: Setting ccr sub-encoding to TS1/0 on input line 355. +Package textcomp Info: Setting ptm sub-encoding to TS1/4 on input line 356. +Package textcomp Info: Setting pcr sub-encoding to TS1/4 on input line 357. +Package textcomp Info: Setting phv sub-encoding to TS1/4 on input line 358. +Package textcomp Info: Setting ppl sub-encoding to TS1/3 on input line 359. +Package textcomp Info: Setting pag sub-encoding to TS1/4 on input line 360. +Package textcomp Info: Setting pbk sub-encoding to TS1/4 on input line 361. +Package textcomp Info: Setting pnc sub-encoding to TS1/4 on input line 362. +Package textcomp Info: Setting pzc sub-encoding to TS1/4 on input line 363. +Package textcomp Info: Setting bch sub-encoding to TS1/4 on input line 364. +Package textcomp Info: Setting put sub-encoding to TS1/5 on input line 365. +Package textcomp Info: Setting uag sub-encoding to TS1/5 on input line 366. +Package textcomp Info: Setting ugq sub-encoding to TS1/5 on input line 367. +Package textcomp Info: Setting ul8 sub-encoding to TS1/4 on input line 368. +Package textcomp Info: Setting ul9 sub-encoding to TS1/4 on input line 369. +Package textcomp Info: Setting augie sub-encoding to TS1/5 on input line 370. +Package textcomp Info: Setting dayrom sub-encoding to TS1/3 on input line 371. +Package textcomp Info: Setting dayroms sub-encoding to TS1/3 on input line 372. + +Package textcomp Info: Setting pxr sub-encoding to TS1/0 on input line 373. +Package textcomp Info: Setting pxss sub-encoding to TS1/0 on input line 374. +Package textcomp Info: Setting pxtt sub-encoding to TS1/0 on input line 375. +Package textcomp Info: Setting txr sub-encoding to TS1/0 on input line 376. +Package textcomp Info: Setting txss sub-encoding to TS1/0 on input line 377. +Package textcomp Info: Setting txtt sub-encoding to TS1/0 on input line 378. +Package textcomp Info: Setting lmr sub-encoding to TS1/0 on input line 379. +Package textcomp Info: Setting lmdh sub-encoding to TS1/0 on input line 380. +Package textcomp Info: Setting lmss sub-encoding to TS1/0 on input line 381. +Package textcomp Info: Setting lmssq sub-encoding to TS1/0 on input line 382. +Package textcomp Info: Setting lmvtt sub-encoding to TS1/0 on input line 383. +Package textcomp Info: Setting lmtt sub-encoding to TS1/0 on input line 384. +Package textcomp Info: Setting qhv sub-encoding to TS1/0 on input line 385. +Package textcomp Info: Setting qag sub-encoding to TS1/0 on input line 386. +Package textcomp Info: Setting qbk sub-encoding to TS1/0 on input line 387. +Package textcomp Info: Setting qcr sub-encoding to TS1/0 on input line 388. +Package textcomp Info: Setting qcs sub-encoding to TS1/0 on input line 389. +Package textcomp Info: Setting qpl sub-encoding to TS1/0 on input line 390. +Package textcomp Info: Setting qtm sub-encoding to TS1/0 on input line 391. +Package textcomp Info: Setting qzc sub-encoding to TS1/0 on input line 392. +Package textcomp Info: Setting qhvc sub-encoding to TS1/0 on input line 393. +Package textcomp Info: Setting futs sub-encoding to TS1/4 on input line 394. +Package textcomp Info: Setting futx sub-encoding to TS1/4 on input line 395. +Package textcomp Info: Setting futj sub-encoding to TS1/4 on input line 396. +Package textcomp Info: Setting hlh sub-encoding to TS1/3 on input line 397. +Package textcomp Info: Setting hls sub-encoding to TS1/3 on input line 398. +Package textcomp Info: Setting hlst sub-encoding to TS1/3 on input line 399. +Package textcomp Info: Setting hlct sub-encoding to TS1/5 on input line 400. +Package textcomp Info: Setting hlx sub-encoding to TS1/5 on input line 401. +Package textcomp Info: Setting hlce sub-encoding to TS1/5 on input line 402. +Package textcomp Info: Setting hlcn sub-encoding to TS1/5 on input line 403. +Package textcomp Info: Setting hlcw sub-encoding to TS1/5 on input line 404. +Package textcomp Info: Setting hlcf sub-encoding to TS1/5 on input line 405. +Package textcomp Info: Setting pplx sub-encoding to TS1/3 on input line 406. +Package textcomp Info: Setting pplj sub-encoding to TS1/3 on input line 407. +Package textcomp Info: Setting ptmx sub-encoding to TS1/4 on input line 408. +Package textcomp Info: Setting ptmj sub-encoding to TS1/4 on input line 409. +) +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/fancyhdr/fancyhd +r.sty +Package: fancyhdr 2017/06/30 v3.9a Extensive control of page headers and footer +s +\f@nch@headwidth=\skip54 +\f@nch@O@elh=\skip55 +\f@nch@O@erh=\skip56 +\f@nch@O@olh=\skip57 +\f@nch@O@orh=\skip58 +\f@nch@O@elf=\skip59 +\f@nch@O@erf=\skip60 +\f@nch@O@olf=\skip61 +\f@nch@O@orf=\skip62 +) +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/fancybox/fancybo +x.sty +Package: fancybox 2010/05/15 1.4 + +Style option: `fancybox' v1.4 <2010/05/15> (tvz) +\@fancybox=\box30 +\shadowsize=\dimen105 +\@Sbox=\box31 +\do@VerbBox=\toks17 +\the@fancyput=\toks18 +\this@fancyput=\toks19 +\EndVerbatimTokens=\toks20 +\Verbatim@Outfile=\write3 +\Verbatim@Infile=\read1 +) +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/titlesec/titlese +c.sty +Package: titlesec 2016/03/21 v2.10.2 Sectioning titles +\ttl@box=\box32 +\beforetitleunit=\skip63 +\aftertitleunit=\skip64 +\ttl@plus=\dimen106 +\ttl@minus=\dimen107 +\ttl@toksa=\toks21 +\titlewidth=\dimen108 +\titlewidthlast=\dimen109 +\titlewidthfirst=\dimen110 +) (./tabulary.sty +Package: tabulary 2007/10/02 v0.9 tabulary package (DPC) + +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/tools/array.sty +Package: array 2016/10/06 v2.4d Tabular extension package (FMi) +\col@sep=\dimen111 +\extrarowheight=\dimen112 +\NC@list=\toks22 +\extratabsurround=\skip65 +\backup@length=\skip66 +) +\TY@count=\count97 +\TY@linewidth=\dimen113 +\tymin=\dimen114 +\tymax=\dimen115 +\TY@tablewidth=\dimen116 +) +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsmath/amsmath. +sty +Package: amsmath 2017/09/02 v2.17a AMS math features +\@mathmargin=\skip67 + +For additional information on amsmath, use the `?' option. + +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsmath/amstext. +sty +Package: amstext 2000/06/29 v2.01 AMS text + +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsmath/amsgen.s +ty +File: amsgen.sty 1999/11/30 v2.0 generic functions +\@emptytoks=\toks23 +\ex@=\dimen117 +)) +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsmath/amsbsy.s +ty +Package: amsbsy 1999/11/29 v1.2d Bold Symbols +\pmbraise@=\dimen118 +) +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsmath/amsopn.s +ty +Package: amsopn 2016/03/08 v2.02 operator names +) +\inf@bad=\count98 +LaTeX Info: Redefining \frac on input line 213. +\uproot@=\count99 +\leftroot@=\count100 +LaTeX Info: Redefining \overline on input line 375. +\classnum@=\count101 +\DOTSCASE@=\count102 +LaTeX Info: Redefining \ldots on input line 472. +LaTeX Info: Redefining \dots on input line 475. +LaTeX Info: Redefining \cdots on input line 596. +\Mathstrutbox@=\box33 +\strutbox@=\box34 +\big@size=\dimen119 +LaTeX Font Info: Redeclaring font encoding OML on input line 712. +LaTeX Font Info: Redeclaring font encoding OMS on input line 713. +\macc@depth=\count103 +\c@MaxMatrixCols=\count104 +\dotsspace@=\muskip10 +\c@parentequation=\count105 +\dspbrk@lvl=\count106 +\tag@help=\toks24 +\row@=\count107 +\column@=\count108 +\maxfields@=\count109 +\andhelp@=\toks25 +\eqnshift@=\dimen120 +\alignsep@=\dimen121 +\tagshift@=\dimen122 +\tagwidth@=\dimen123 +\totwidth@=\dimen124 +\lineht@=\dimen125 +\@envbody=\toks26 +\multlinegap=\skip68 +\multlinetaggap=\skip69 +\mathdisplay@stack=\toks27 +LaTeX Info: Redefining \[ on input line 2817. +LaTeX Info: Redefining \] on input line 2818. +) +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/makeidx.sty +Package: makeidx 2014/09/29 v1.0m Standard LaTeX package +) +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/framed/framed.st +y +Package: framed 2011/10/22 v 0.96: framed or shaded text with page breaks +\OuterFrameSep=\skip70 +\fb@frw=\dimen126 +\fb@frh=\dimen127 +\FrameRule=\dimen128 +\FrameSep=\dimen129 +) +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/ifthen.sty +Package: ifthen 2014/09/29 v1.1c Standard LaTeX ifthen package (DPC) +) +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics/color.s +ty +Package: color 2016/07/10 v1.1e Standard LaTeX Color (DPC) + +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics-cfg/col +or.cfg +File: color.cfg 2016/01/02 v1.6 sample color configuration +) +Package color Info: Driver file: pdftex.def on input line 147. + +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics-def/pdf +tex.def +File: pdftex.def 2018/01/08 v1.0l Graphics/color driver for pdftex +)) +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/fancyvrb/fancyvr +b.sty +Package: fancyvrb 2008/02/07 + +Style option: `fancyvrb' v2.7a, with DG/SPQR fixes, and firstline=lastline fix +<2008/02/07> (tvz) +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics/keyval. +sty +Package: keyval 2014/10/28 v1.15 key=value parser (DPC) +\KV@toks@=\toks28 +) +\FV@CodeLineNo=\count110 +\FV@InFile=\read2 +\FV@TabBox=\box35 +\c@FancyVerbLine=\count111 +\FV@StepNumber=\count112 +\FV@OutFile=\write4 +) +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/threeparttable/t +hreeparttable.sty +Package: threeparttable 2003/06/13 v 3.0 +\@tempboxb=\box36 +) +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/mdwtools/footnot +e.sty +Package: footnote 1997/01/28 1.13 Save footnotes around boxes +\fn@notes=\box37 +\fn@width=\dimen130 +) +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/wrapfig/wrapfig. +sty +\wrapoverhang=\dimen131 +\WF@size=\dimen132 +\c@WF@wrappedlines=\count113 +\WF@box=\box38 +\WF@everypar=\toks29 +Package: wrapfig 2003/01/31 v 3.6 +) +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/parskip/parskip. +sty +Package: parskip 2001/04/09 non-zero parskip adjustments +) +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics/graphic +x.sty +Package: graphicx 2017/06/01 v1.1a Enhanced LaTeX Graphics (DPC,SPQR) + +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics/graphic +s.sty +Package: graphics 2017/06/25 v1.2c Standard LaTeX Graphics (DPC,SPQR) + +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics/trig.st +y +Package: trig 2016/01/03 v1.10 sin cos tan (DPC) +) +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics-cfg/gra +phics.cfg +File: graphics.cfg 2016/06/04 v1.11 sample graphics configuration +) +Package graphics Info: Driver file: pdftex.def on input line 99. +) +\Gin@req@height=\dimen133 +\Gin@req@width=\dimen134 +) +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/pdftex/pdfcolo +r.tex) +\distancetoright=\skip71 +\py@argswidth=\skip72 +\py@noticelength=\skip73 +\lineblockindentation=\skip74 +\image@box=\box39 +\image@width=\dimen135 + +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/hyperref/hyperre +f.sty +Package: hyperref 2018/02/06 v6.86b Hypertext links for LaTeX + +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/hobsu +b-hyperref.sty +Package: hobsub-hyperref 2016/05/16 v1.14 Bundle oberdiek, subset hyperref (HO) + + +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/hobsu +b-generic.sty +Package: hobsub-generic 2016/05/16 v1.14 Bundle oberdiek, subset generic (HO) +Package: hobsub 2016/05/16 v1.14 Construct package bundles (HO) +Package: infwarerr 2016/05/16 v1.4 Providing info/warning/error messages (HO) +Package: ltxcmds 2016/05/16 v1.23 LaTeX kernel commands for general use (HO) +Package: ifluatex 2016/05/16 v1.4 Provides the ifluatex switch (HO) +Package ifluatex Info: LuaTeX not detected. +Package: ifvtex 2016/05/16 v1.6 Detect VTeX and its facilities (HO) +Package ifvtex Info: VTeX not detected. +Package: intcalc 2016/05/16 v1.2 Expandable calculations with integers (HO) +Package: ifpdf 2017/03/15 v3.2 Provides the ifpdf switch +Package: etexcmds 2016/05/16 v1.6 Avoid name clashes with e-TeX commands (HO) +Package etexcmds Info: Could not find \expanded. +(etexcmds) That can mean that you are not using pdfTeX 1.50 or +(etexcmds) that some package has redefined \expanded. +(etexcmds) In the latter case, load this package earlier. +Package: kvsetkeys 2016/05/16 v1.17 Key value parser (HO) +Package: kvdefinekeys 2016/05/16 v1.4 Define keys (HO) +Package: pdftexcmds 2018/01/21 v0.26 Utility functions of pdfTeX for LuaTeX (HO +) +Package pdftexcmds Info: LuaTeX not detected. +Package pdftexcmds Info: \pdf@primitive is available. +Package pdftexcmds Info: \pdf@ifprimitive is available. +Package pdftexcmds Info: \pdfdraftmode found. +Package: pdfescape 2016/05/16 v1.14 Implements pdfTeX's escape features (HO) +Package: bigintcalc 2016/05/16 v1.4 Expandable calculations on big integers (HO +) +Package: bitset 2016/05/16 v1.2 Handle bit-vector datatype (HO) +Package: uniquecounter 2016/05/16 v1.3 Provide unlimited unique counter (HO) +) +Package hobsub Info: Skipping package `hobsub' (already loaded). +Package: letltxmacro 2016/05/16 v1.5 Let assignment for LaTeX macros (HO) +Package: hopatch 2016/05/16 v1.3 Wrapper for package hooks (HO) +Package: xcolor-patch 2016/05/16 xcolor patch +Package: atveryend 2016/05/16 v1.9 Hooks at the very end of document (HO) +Package atveryend Info: \enddocument detected (standard20110627). +Package: atbegshi 2016/06/09 v1.18 At begin shipout hook (HO) +Package: refcount 2016/05/16 v3.5 Data extraction from label references (HO) +Package: hycolor 2016/05/16 v1.8 Color options for hyperref/bookmark (HO) +) +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/ifxetex/ifxete +x.sty +Package: ifxetex 2010/09/12 v0.6 Provides ifxetex conditional +) +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/auxhook +.sty +Package: auxhook 2016/05/16 v1.4 Hooks for auxiliary files (HO) +) +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/kvoptio +ns.sty +Package: kvoptions 2016/05/16 v3.12 Key value format for package options (HO) +) +\@linkdim=\dimen136 +\Hy@linkcounter=\count114 +\Hy@pagecounter=\count115 + +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/hyperref/pd1enc. +def +File: pd1enc.def 2018/02/06 v6.86b Hyperref: PDFDocEncoding definition (HO) +Now handling font encoding PD1 ... +... no UTF-8 mapping file for font encoding PD1 +) +\Hy@SavedSpaceFactor=\count116 + +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/latexconfig/hype +rref.cfg +File: hyperref.cfg 2002/06/06 v1.2 hyperref configuration of TeXLive +) +Package hyperref Info: Option `colorlinks' set `true' on input line 4383. +Package hyperref Info: Option `breaklinks' set `true' on input line 4383. +Package hyperref Info: Hyper figures OFF on input line 4509. +Package hyperref Info: Link nesting OFF on input line 4514. +Package hyperref Info: Hyper index ON on input line 4517. +Package hyperref Info: Plain pages OFF on input line 4524. +Package hyperref Info: Backreferencing OFF on input line 4529. +Package hyperref Info: Implicit mode ON; LaTeX internals redefined. +Package hyperref Info: Bookmarks ON on input line 4762. +\c@Hy@tempcnt=\count117 + +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/url/url.sty +\Urlmuskip=\muskip11 +Package: url 2013/09/16 ver 3.4 Verb mode for urls, etc. +) +LaTeX Info: Redefining \url on input line 5115. +\XeTeXLinkMargin=\dimen137 +\Fld@menulength=\count118 +\Field@Width=\dimen138 +\Fld@charsize=\dimen139 +Package hyperref Info: Hyper figures OFF on input line 6369. +Package hyperref Info: Link nesting OFF on input line 6374. +Package hyperref Info: Hyper index ON on input line 6377. +Package hyperref Info: backreferencing OFF on input line 6384. +Package hyperref Info: Link coloring ON on input line 6387. +Package hyperref Info: Link coloring with OCG OFF on input line 6394. +Package hyperref Info: PDF/A mode OFF on input line 6399. +LaTeX Info: Redefining \ref on input line 6439. +LaTeX Info: Redefining \pageref on input line 6443. +\Hy@abspage=\count119 +\c@Item=\count120 +\c@Hfootnote=\count121 +) +Package hyperref Info: Driver (autodetected): hpdftex. + +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/hyperref/hpdftex +.def +File: hpdftex.def 2018/02/06 v6.86b Hyperref driver for pdfTeX +\Fld@listcount=\count122 +\c@bookmark@seq@number=\count123 + +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/rerunfi +lecheck.sty +Package: rerunfilecheck 2016/05/16 v1.8 Rerun checks for auxiliary files (HO) +Package uniquecounter Info: New unique counter `rerunfilecheck' on input line 2 +82. +) +\Hy@SectionHShift=\skip75 +) +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/hypcap. +sty +Package: hypcap 2016/05/16 v1.12 Adjusting the anchors of captions (HO) +) +\DUlineblockindent=\skip76 +) +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/multirow/multiro +w.sty +Package: multirow 2016/11/25 v2.2 Span multiple rows of a table +\multirow@colwidth=\skip77 +\multirow@cntb=\count124 +\multirow@dima=\skip78 +\bigstrutjot=\dimen140 +) +\@indexfile=\write5 +\openout5 = `salomeTools.idx'. + + +Writing index file salomeTools.idx +(./salomeTools.aux) +\openout1 = `salomeTools.aux'. + +LaTeX Font Info: Checking defaults for OML/cmm/m/it on input line 110. +LaTeX Font Info: ... okay on input line 110. +LaTeX Font Info: Checking defaults for T1/cmr/m/n on input line 110. +LaTeX Font Info: ... okay on input line 110. +LaTeX Font Info: Checking defaults for OT1/cmr/m/n on input line 110. +LaTeX Font Info: ... okay on input line 110. +LaTeX Font Info: Checking defaults for OMS/cmsy/m/n on input line 110. +LaTeX Font Info: ... okay on input line 110. +LaTeX Font Info: Checking defaults for OMX/cmex/m/n on input line 110. +LaTeX Font Info: ... okay on input line 110. +LaTeX Font Info: Checking defaults for U/cmr/m/n on input line 110. +LaTeX Font Info: ... okay on input line 110. +LaTeX Font Info: Checking defaults for TS1/cmr/m/n on input line 110. +LaTeX Font Info: Try loading font information for TS1+cmr on input line 110. + + +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/ts1cmr.fd +File: ts1cmr.fd 2014/09/29 v2.5h Standard LaTeX font definitions +) +LaTeX Font Info: ... okay on input line 110. +LaTeX Font Info: Checking defaults for PD1/pdf/m/n on input line 110. +LaTeX Font Info: ... okay on input line 110. +LaTeX Font Info: Try loading font information for T1+ptm on input line 110. + +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/t1ptm.fd +File: t1ptm.fd 2001/06/04 font definitions for T1/ptm. +) +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/context/base/mkii/supp +-pdf.mkii +[Loading MPS to PDF converter (version 2006.09.02).] +\scratchcounter=\count125 +\scratchdimen=\dimen141 +\scratchbox=\box40 +\nofMPsegments=\count126 +\nofMParguments=\count127 +\everyMPshowfont=\toks30 +\MPscratchCnt=\count128 +\MPscratchDim=\dimen142 +\MPnumerator=\count129 +\makeMPintoPDFobject=\count130 +\everyMPtoPDFconversion=\toks31 +) +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/epstopd +f-base.sty +Package: epstopdf-base 2016/05/15 v2.6 Base part for package epstopdf + +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/grfext. +sty +Package: grfext 2016/05/16 v1.2 Manage graphics extensions (HO) +) +Package epstopdf-base Info: Redefining graphics rule for `.eps' on input line 4 +38. +Package grfext Info: Graphics extension search list: +(grfext) [.pdf,.png,.jpg,.mps,.jpeg,.jbig2,.jb2,.PDF,.PNG,.JPG,.JPE +G,.JBIG2,.JB2,.eps] +(grfext) \AppendGraphicsExtensions on input line 456. + +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/latexconfig/epst +opdf-sys.cfg +File: epstopdf-sys.cfg 2010/07/13 v1.3 Configuration of (r)epstopdf for TeX Liv +e +)) +\AtBeginShipoutBox=\box41 +Package hyperref Info: Link coloring ON on input line 110. + +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/hyperref/nameref +.sty +Package: nameref 2016/05/21 v2.44 Cross-referencing by name of section + +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/getti +tlestring.sty +Package: gettitlestring 2016/05/16 v1.5 Cleanup title references (HO) +) +\c@section@level=\count131 +) +LaTeX Info: Redefining \ref on input line 110. +LaTeX Info: Redefining \pageref on input line 110. +LaTeX Info: Redefining \nameref on input line 110. + (./salomeTools.out) (./salomeTools.out) +\@outlinefile=\write6 +\openout6 = `salomeTools.out'. + + +Underfull \hbox (badness 10000) in paragraph at lines 113--113 + + [] + +LaTeX Font Info: Try loading font information for T1+phv on input line 113. +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/t1phv.fd +File: t1phv.fd 2001/06/04 scalable font definitions for T1/phv. +) +LaTeX Font Info: Font shape `T1/phv/bx/n' in size <24.88> not available +(Font) Font shape `T1/phv/b/n' tried instead on input line 113. +LaTeX Font Info: Font shape `T1/phv/m/it' in size <17.28> not available +(Font) Font shape `T1/phv/m/sl' tried instead on input line 113. +LaTeX Font Info: Font shape `T1/phv/bx/it' in size <17.28> not available +(Font) Font shape `T1/phv/b/it' tried instead on input line 113. +LaTeX Font Info: Font shape `T1/phv/b/it' in size <17.28> not available +(Font) Font shape `T1/phv/b/sl' tried instead on input line 113. +LaTeX Font Info: Font shape `T1/phv/bx/n' in size <17.28> not available +(Font) Font shape `T1/phv/b/n' tried instead on input line 113. +[1 + +{/data/tmplgls/wambeke/share/texlive/2017/texmf-var/fonts/map/pdftex/updmap/pdf +tex.map}] [2 + +] (./salomeTools.toc +LaTeX Font Info: Font shape `T1/ptm/bx/n' in size <10> not available +(Font) Font shape `T1/ptm/b/n' tried instead on input line 2. +) +\tf@toc=\write7 +\openout7 = `salomeTools.toc'. + + +Adding blank page after the table of contents. +LaTeX Font Info: Font shape `T1/phv/bx/n' in size <10> not available +(Font) Font shape `T1/phv/b/n' tried instead on input line 113. +pdfTeX warning (ext4): destination with the same identifier (name{page.i}) has +been already used, duplicate ignored + + \relax +l.113 \tableofcontents + [1 + +]pdfTeX warning (ext4): destination with the same identifier (name{page.ii}) ha +s been already used, duplicate ignored + + \relax +l.113 \tableofcontents + [2] + +File: sat_about.png Graphic file (type png) + +Package pdftex.def Info: sat_about.png used on input line 117. +(pdftex.def) Requested size: 602.24852pt x 301.12425pt. +File: sat_about.png Graphic file (type png) + +Package pdftex.def Info: sat_about.png used on input line 117. +(pdftex.def) Requested size: 452.96788pt x 226.49104pt. + +Underfull \hbox (badness 10000) in paragraph at lines 121--122 + + [] + +[1 + + <./sat_about.png>] [2 + +] +Chapter 1. +LaTeX Font Info: Font shape `T1/phv/bx/n' in size <14.4> not available +(Font) Font shape `T1/phv/b/n' tried instead on input line 133. +LaTeX Font Info: Try loading font information for T1+pcr on input line 140. +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/t1pcr.fd +File: t1pcr.fd 2001/06/04 font definitions for T1/pcr. +) +LaTeX Font Info: Font shape `T1/pcr/m/it' in size <9> not available +(Font) Font shape `T1/pcr/m/sl' tried instead on input line 143. +LaTeX Font Info: Font shape `T1/phv/bx/n' in size <12> not available +(Font) Font shape `T1/phv/b/n' tried instead on input line 158. +LaTeX Font Info: Try loading font information for TS1+ptm on input line 163. + + +(/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/ts1ptm.fd +File: ts1ptm.fd 2001/06/04 font definitions for TS1/ptm. +) [3] +LaTeX Font Info: Font shape `T1/phv/bx/n' in size <9> not available +(Font) Font shape `T1/phv/b/n' tried instead on input line 278. +LaTeX Font Info: Font shape `T1/phv/bx/it' in size <9> not available +(Font) Font shape `T1/phv/b/it' tried instead on input line 278. +LaTeX Font Info: Font shape `T1/phv/b/it' in size <9> not available +(Font) Font shape `T1/phv/b/sl' tried instead on input line 278. + [4] [5] [6] +Chapter 2. +[7 + +] +Underfull \hbox (badness 10000) in paragraph at lines 489--490 + + [] + +[8] [9] [10] [11] +Underfull \hbox (badness 10000) in paragraph at lines 816--817 +[]\T1/ptm/m/n/10 Create the vir-tual ap-pli-ca-tion di-rec-tory in the sa-lome- +Tool ap-pli-ca-tion di-rec-tory + [] + +[12] +Underfull \hbox (badness 10000) in paragraph at lines 905--906 +[]\T1/ptm/m/n/10 The --terminal (or -t) dis-play the log di-rectly in the ter-m +i-nal, through a [][]CLI[][] + [] + +[13] [14] +LaTeX Font Info: Font shape `T1/pcr/bx/n' in size <9> not available +(Font) Font shape `T1/pcr/b/n' tried instead on input line 1088. + [15] +Underfull \hbox (badness 8075) in paragraph at lines 1216--1219 +[]\T1/ptm/m/n/10 This com-mand will cre-ate an archive named \T1/pcr/m/n/10 SAL +OME_xx.tgz \T1/ptm/m/n/10 in the work-ing di-rec-tory + [] + +[16] +Overfull \hbox (44.44682pt too wide) in paragraph at lines 1276--1277 +[]\T1/ptm/m/n/10 The ver-sion con-trol sys-tems known by this op-tion are [][]C +VS[][] (https://fr.wikipedia.org/wiki/Concurrent_versions_system), + [] + +[17] [18] +Chapter 3. +[19 + +] [20] [21] [22 + +] +Chapter 4. +LaTeX Font Info: Font shape `T1/pcr/bx/n' in size <10> not available +(Font) Font shape `T1/pcr/b/n' tried instead on input line 1509. +[23] [24] [25] [26] [27] [28] [29] +Underfull \hbox (badness 10000) in paragraph at lines 2688--2688 +[]\T1/ptm/m/it/10 filename\T1/ptm/m/n/10 , \T1/ptm/m/it/10 ad-di-tional_env={}\ +T1/ptm/m/n/10 , \T1/ptm/m/it/10 for_package=None\T1/ptm/m/n/10 , + [] + +[30] [31] [32] [33] [34] [35] [36] [37] +Underfull \hbox (badness 10000) in paragraph at lines 4104--4104 +[]\T1/ptm/m/it/10 config\T1/ptm/m/n/10 , \T1/ptm/m/it/10 silent_sysstd=False\T1 +/ptm/m/n/10 , \T1/ptm/m/it/10 all_in_terminal=False\T1/ptm/m/n/10 , \T1/ptm/m/i +t/10 mi- + [] + +[38] [39] [40] [41] [42] [43] [44] [45] [46] [47] [48] [49] [50] [51] [52] +Underfull \hbox (badness 10000) in paragraph at lines 6286--6290 +[]\T1/ptm/m/n/10 Examples: makePath(`', `suf-fix') -> `suf-fix' makePath(`prefi +x', `suf-fix') -> `pre-fix.suffix' + [] + +[53] [54] [55] [56] [57] [58] [59] [60] [61] [62 + +] +Chapter 5. +[63] [64 + +] [65 + + +] (./salomeTools.ind [66 + + +] +Underfull \hbox (badness 10000) in paragraph at lines 7--8 +[]\T1/ptm/m/n/10 add_comment() (src.environment.SalomeEnviron + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 8--9 +[]\T1/ptm/m/n/10 add_comment() (src.fileEnviron.BatFileEnviron + [] + + +Underfull \hbox (badness 6188) in paragraph at lines 10--11 +[]\T1/ptm/m/n/10 add_comment() (src.fileEnviron.LauncherFileEnviron + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 11--12 +[]\T1/ptm/m/n/10 add_comment() (src.fileEnviron.ScreenEnviron + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 12--13 +[]\T1/ptm/m/n/10 add_echo() (src.fileEnviron.ContextFileEnviron + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 14--15 +[]\T1/ptm/m/n/10 add_echo() (src.fileEnviron.LauncherFileEnviron + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 18--19 +[]\T1/ptm/m/n/10 add_line() (src.fileEnviron.LauncherFileEnviron + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 23--24 +[]\T1/ptm/m/n/10 add_simple_node() (src.xmlManager.XmlLogFile + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 24--25 +[]\T1/ptm/m/n/10 add_warning() (src.environment.SalomeEnviron + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 25--26 +[]\T1/ptm/m/n/10 add_warning() (src.fileEnviron.ContextFileEnviron + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 27--28 +[]\T1/ptm/m/n/10 add_warning() (src.fileEnviron.LauncherFileEnviron + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 28--29 +[]\T1/ptm/m/n/10 add_warning() (src.fileEnviron.ScreenEnviron + [] + + +Overfull \hbox (6.44356pt too wide) in paragraph at lines 32--33 +[]\T1/ptm/m/n/10 ANSI_CSI_RE (src.colorama.ansitowin32.AnsiToWin32 + [] + + +Overfull \hbox (10.33357pt too wide) in paragraph at lines 33--34 +[]\T1/ptm/m/n/10 ANSI_OSC_RE (src.colorama.ansitowin32.AnsiToWin32 + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 43--44 +[]\T1/ptm/m/n/10 append() (src.fileEnviron.LauncherFileEnviron + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 47--48 +[]\T1/ptm/m/n/10 append_node_attrib() (src.xmlManager.XmlLogFile + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 48--49 +[]\T1/ptm/m/n/10 append_node_text() (src.xmlManager.XmlLogFile + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 50--51 +[]\T1/ptm/m/n/10 append_value() (src.fileEnviron.ContextFileEnviron + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 52--53 +[]\T1/ptm/m/n/10 append_value() (src.fileEnviron.LauncherFileEnviron + [] + +[67 + +] +Underfull \hbox (badness 10000) in paragraph at lines 72--73 +[]\T1/ptm/m/n/10 BRIGHT_BACKGROUND + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 72--73 +\T1/ptm/m/n/10 (src.colorama.winterm.WinStyle at-tribute), + [] + + +Overfull \hbox (17.33417pt too wide) in paragraph at lines 79--80 +[]\T1/ptm/m/n/10 change_to_launcher() (src.fileEnviron.LauncherFileEnviron + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 82--83 +[]\T1/ptm/m/n/10 check_config_has_application() (in mod-ule + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 99--100 +[]\T1/ptm/m/n/10 command_value() (src.fileEnviron.BashFileEnviron + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 100--101 +[]\T1/ptm/m/n/10 command_value() (src.fileEnviron.BatFileEnviron + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 102--103 +[]\T1/ptm/m/n/10 command_value() (src.fileEnviron.FileEnviron + [] + + +Overfull \hbox (2.65422pt too wide) in paragraph at lines 103--104 +[]\T1/ptm/m/n/10 command_value() (src.fileEnviron.LauncherFileEnviron + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 104--105 +[]\T1/ptm/m/n/10 command_value() (src.fileEnviron.ScreenEnviron + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 106--107 +[]\T1/ptm/m/n/10 complete_environment() (src.compilation.Builder + [] + + +Overfull \hbox (1.98415pt too wide) in paragraph at lines 121--122 +[]\T1/ptm/m/n/10 convert_ansi() (src.colorama.ansitowin32.AnsiToWin32 + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 127--128 +[]\T1/ptm/m/n/10 cursor_adjust() (src.colorama.winterm.WinTerm + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 145--146 +[]\T1/ptm/m/n/10 do_batch_script_build() (src.compilation.Builder + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 147--148 +[]\T1/ptm/m/n/10 do_python_script_build() (src.compilation.Builder + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 163--164 +[]\T1/ptm/m/n/10 erase_screen() (src.colorama.winterm.WinTerm + [] + +[68] +Overfull \hbox (12.3738pt too wide) in paragraph at lines 169--170 +[]\T1/ptm/m/n/10 extract_params() (src.colorama.ansitowin32.AnsiToWin32 + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 219--220 +[]\T1/ptm/m/n/10 get_node_text() (src.xmlManager.ReadXmlFile + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 220--221 +[]\T1/ptm/m/n/10 get_position() (src.colorama.winterm.WinTerm + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 226--227 +[]\T1/ptm/m/n/10 get_property_in_product_cfg() (in mod-ule + [] + + +Overfull \hbox (16.98376pt too wide) in paragraph at lines 233--234 +[]\T1/ptm/m/n/10 get_win32_calls() (src.colorama.ansitowin32.AnsiToWin32 + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 240--241 +[]\T1/ptm/m/n/10 getRootAttrib() (src.xmlManager.ReadXmlFile + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 267--268 +[]\T1/ptm/m/n/10 is_defined() (src.fileEnviron.LauncherFileEnviron + [] + +[69] +Underfull \hbox (badness 10000) in paragraph at lines 269--270 +[]\T1/ptm/m/n/10 is_stream_closed() (in mod-ule + [] + + +Underfull \hbox (badness 5260) in paragraph at lines 289--290 +[]\T1/ptm/m/n/10 LIGHTBLACK_EX (src.colorama.ansi.AnsiFore at- + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 290--291 +[]\T1/ptm/m/n/10 LIGHTBLUE_EX (src.colorama.ansi.AnsiBack at- + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 291--292 +[]\T1/ptm/m/n/10 LIGHTBLUE_EX (src.colorama.ansi.AnsiFore at- + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 292--293 +[]\T1/ptm/m/n/10 LIGHTCYAN_EX (src.colorama.ansi.AnsiBack + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 293--294 +[]\T1/ptm/m/n/10 LIGHTCYAN_EX (src.colorama.ansi.AnsiFore at- + [] + + +Underfull \hbox (badness 5490) in paragraph at lines 295--296 +[]\T1/ptm/m/n/10 LIGHTGREEN_EX (src.colorama.ansi.AnsiFore at- + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 296--297 +[]\T1/ptm/m/n/10 LIGHTMAGENTA_EX (src.colorama.ansi.AnsiBack + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 297--298 +[]\T1/ptm/m/n/10 LIGHTMAGENTA_EX (src.colorama.ansi.AnsiFore + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 298--299 +[]\T1/ptm/m/n/10 LIGHTRED_EX (src.colorama.ansi.AnsiBack at- + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 299--300 +[]\T1/ptm/m/n/10 LIGHTRED_EX (src.colorama.ansi.AnsiFore at- + [] + + +Underfull \hbox (badness 7273) in paragraph at lines 301--302 +[]\T1/ptm/m/n/10 LIGHTWHITE_EX (src.colorama.ansi.AnsiFore at- + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 308--309 +[]\T1/ptm/m/n/10 load_cfg_environment() + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 308--309 +\T1/ptm/m/n/10 (src.environment.SalomeEnviron method), + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 319--320 +[]\T1/ptm/m/n/10 MAGENTA (src.colorama.winterm.WinColor at- + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 354--355 +[]\T1/ptm/m/n/10 parseKeyValuePair() (src.pyconf.ConfigReader + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 356--357 +[]\T1/ptm/m/n/10 parseMappingBody() (src.pyconf.ConfigReader + [] + +[70] +Underfull \hbox (badness 10000) in paragraph at lines 370--371 +[]\T1/ptm/m/n/10 prepare_testbase_from_dir() (src.test_module.Test + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 371--372 +[]\T1/ptm/m/n/10 prepare_testbase_from_git() (src.test_module.Test + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 372--373 +[]\T1/ptm/m/n/10 prepare_testbase_from_svn() (src.test_module.Test + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 376--377 +[]\T1/ptm/m/n/10 prepend() (src.fileEnviron.LauncherFileEnviron + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 379--380 +[]\T1/ptm/m/n/10 prepend_value() (src.fileEnviron.ContextFileEnviron + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 417--418 +[]\T1/ptm/m/n/10 put_txt_log_in_appli_log_dir() + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 443--444 +[]\T1/ptm/m/n/10 reset_all() (src.colorama.ansitowin32.AnsiToWin32 + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 448--449 +[]\T1/ptm/m/n/10 run_env_script() (src.environment.SalomeEnviron + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 449--450 +[]\T1/ptm/m/n/10 run_env_script() (src.fileEnviron.ScreenEnviron + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 453--454 +[]\T1/ptm/m/n/10 run_simple_env_script() + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 453--454 +\T1/ptm/m/n/10 (src.environment.SalomeEnviron method), + [] + +[71] +Underfull \hbox (badness 10000) in paragraph at lines 475--476 +[]\T1/ptm/m/n/10 set_a_product() (src.environment.SalomeEnviron + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 478--479 +[]\T1/ptm/m/n/10 set_console() (src.colorama.winterm.WinTerm + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 479--480 +[]\T1/ptm/m/n/10 set_cpp_env() (src.environment.SalomeEnviron + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 481--482 +[]\T1/ptm/m/n/10 set_full_environ() (src.environment.SalomeEnviron + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 482--483 +[]\T1/ptm/m/n/10 set_products() (src.environment.SalomeEnviron + [] + + +Underfull \hbox (badness 6445) in paragraph at lines 483--484 +[]\T1/ptm/m/n/10 set_python_libdirs() (src.environment.SalomeEnviron + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 484--485 +[]\T1/ptm/m/n/10 set_salome_generic_product_env() + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 484--485 +\T1/ptm/m/n/10 (src.environment.SalomeEnviron method), + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 485--486 +[]\T1/ptm/m/n/10 set_salome_minimal_product_env() + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 485--486 +\T1/ptm/m/n/10 (src.environment.SalomeEnviron method), + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 488--489 +[]\T1/ptm/m/n/10 SetConsoleTextAttribute() (in mod-ule + [] + + +Overfull \hbox (3.09416pt too wide) in paragraph at lines 492--493 +[]\T1/ptm/m/n/10 should_wrap() (src.colorama.ansitowin32.AnsiToWin32 + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 553--554 +[]\T1/ptm/m/n/10 write() (src.colorama.ansitowin32.AnsiToWin32 + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 554--555 +[]\T1/ptm/m/n/10 write() (src.colorama.ansitowin32.StreamWrapper + [] + + +Overfull \hbox (25.86401pt too wide) in paragraph at lines 559--560 +[]\T1/ptm/m/n/10 write_and_convert() (src.colorama.ansitowin32.AnsiToWin32 + [] + + +Underfull \hbox (badness 10000) in paragraph at lines 562--563 +[]\T1/ptm/m/n/10 write_env_file() (src.environment.FileEnvWriter + [] + +[72] +Overfull \hbox (16.83371pt too wide) in paragraph at lines 563--564 +[]\T1/ptm/m/n/10 write_plain_text() (src.colorama.ansitowin32.AnsiToWin32 + [] + +[73 + +]) +Package atveryend Info: Empty hook `BeforeClearDocument' on input line 7626. +Package atveryend Info: Empty hook `AfterLastShipout' on input line 7626. + (./salomeTools.aux) +Package atveryend Info: Executing hook `AtVeryEndDocument' on input line 7626. +Package atveryend Info: Executing hook `AtEndAfterFileList' on input line 7626. + +Package rerunfilecheck Info: File `salomeTools.out' has not changed. +(rerunfilecheck) Checksum: 30BE2611C6B1D9A21CC43B549476BD3F;1342. +Package atveryend Info: Empty hook `AtVeryVeryEnd' on input line 7626. + ) +Here is how much of TeX's memory you used: + 10560 strings out of 492982 + 172028 string characters out of 6124607 + 264120 words of memory out of 5000000 + 13256 multiletter control sequences out of 15000+600000 + 66589 words of font info for 74 fonts, out of 8000000 for 9000 + 1142 hyphenation exceptions out of 8191 + 35i,12n,45p,411b,627s stack positions out of 5000i,500n,10000p,200000b,80000s +{/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/enc/dvips/base/8r. +enc} +Output written on salomeTools.pdf (77 pages, 667449 bytes). +PDF statistics: + 1787 PDF objects out of 2073 (max. 8388607) + 1680 compressed objects within 17 object streams + 675 named destinations out of 1000 (max. 500000) + 190 words of extra memory for PDF output out of 10000 (max. 10000000) + diff --git a/doc/build/latex/salomeTools.out b/doc/build/latex/salomeTools.out new file mode 100644 index 0000000..01f62c6 --- /dev/null +++ b/doc/build/latex/salomeTools.out @@ -0,0 +1,23 @@ +\BOOKMARK [0][-]{chapter.1}{Quick start}{}% 1 +\BOOKMARK [1][-]{section.1.1}{Installation}{chapter.1}% 2 +\BOOKMARK [1][-]{section.1.2}{Configuration}{chapter.1}% 3 +\BOOKMARK [1][-]{section.1.3}{Usage of SAlomeTools}{chapter.1}% 4 +\BOOKMARK [0][-]{chapter.2}{List of Commands}{}% 5 +\BOOKMARK [1][-]{section.2.1}{Command config}{chapter.2}% 6 +\BOOKMARK [1][-]{section.2.2}{Command prepare}{chapter.2}% 7 +\BOOKMARK [1][-]{section.2.3}{Command compile}{chapter.2}% 8 +\BOOKMARK [1][-]{section.2.4}{Command launcher}{chapter.2}% 9 +\BOOKMARK [1][-]{section.2.5}{Command application}{chapter.2}% 10 +\BOOKMARK [1][-]{section.2.6}{Command log}{chapter.2}% 11 +\BOOKMARK [1][-]{section.2.7}{Command environ}{chapter.2}% 12 +\BOOKMARK [1][-]{section.2.8}{Command clean}{chapter.2}% 13 +\BOOKMARK [1][-]{section.2.9}{Command package}{chapter.2}% 14 +\BOOKMARK [1][-]{section.2.10}{Command generate}{chapter.2}% 15 +\BOOKMARK [0][-]{chapter.3}{Developer documentation}{}% 16 +\BOOKMARK [1][-]{section.3.1}{Add a user custom command}{chapter.3}% 17 +\BOOKMARK [0][-]{chapter.4}{Code documentation}{}% 18 +\BOOKMARK [1][-]{section.4.1}{src}{chapter.4}% 19 +\BOOKMARK [0][-]{chapter.5}{Release Notes}{}% 20 +\BOOKMARK [1][-]{section.5.1}{Release notes}{chapter.5}% 21 +\BOOKMARK [0][-]{section*.532}{Python Module Index}{}% 22 +\BOOKMARK [0][-]{section*.533}{Index}{}% 23 diff --git a/doc/build/latex/salomeTools.pdf b/doc/build/latex/salomeTools.pdf new file mode 100644 index 0000000..7ef1514 Binary files /dev/null and b/doc/build/latex/salomeTools.pdf differ diff --git a/doc/build/latex/salomeTools.tex b/doc/build/latex/salomeTools.tex new file mode 100644 index 0000000..6c82c69 --- /dev/null +++ b/doc/build/latex/salomeTools.tex @@ -0,0 +1,7626 @@ +% Generated by Sphinx. +\def\sphinxdocclass{report} +\documentclass[a4paper,10pt,english]{sphinxmanual} +\usepackage[utf8]{inputenc} +\DeclareUnicodeCharacter{00A0}{\nobreakspace} +\usepackage[T1]{fontenc} +\usepackage{babel} +\usepackage{times} +\usepackage[Bjarne]{fncychap} +\usepackage{longtable} +\usepackage{sphinx} +\usepackage{multirow} + + +\title{salomeTools Documentation} +\date{April 24, 2018} +\release{5.0.0dev} +\author{CEA DEN/DANS/DM2S/STMF/LGLS} +\newcommand{\sphinxlogo}{} +\renewcommand{\releasename}{Release} +\makeindex + +\makeatletter +\def\PYG@reset{\let\PYG@it=\relax \let\PYG@bf=\relax% + \let\PYG@ul=\relax \let\PYG@tc=\relax% + \let\PYG@bc=\relax \let\PYG@ff=\relax} +\def\PYG@tok#1{\csname PYG@tok@#1\endcsname} +\def\PYG@toks#1+{\ifx\relax#1\empty\else% + \PYG@tok{#1}\expandafter\PYG@toks\fi} +\def\PYG@do#1{\PYG@bc{\PYG@tc{\PYG@ul{% + \PYG@it{\PYG@bf{\PYG@ff{#1}}}}}}} +\def\PYG#1#2{\PYG@reset\PYG@toks#1+\relax+\PYG@do{#2}} + +\def\PYG@tok@gd{\def\PYG@tc##1{\textcolor[rgb]{0.63,0.00,0.00}{##1}}} +\def\PYG@tok@gu{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.50,0.00,0.50}{##1}}} +\def\PYG@tok@gt{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.25,0.82}{##1}}} +\def\PYG@tok@gs{\let\PYG@bf=\textbf} +\def\PYG@tok@gr{\def\PYG@tc##1{\textcolor[rgb]{1.00,0.00,0.00}{##1}}} +\def\PYG@tok@cm{\let\PYG@it=\textit\def\PYG@tc##1{\textcolor[rgb]{0.25,0.50,0.56}{##1}}} +\def\PYG@tok@vg{\def\PYG@tc##1{\textcolor[rgb]{0.73,0.38,0.84}{##1}}} +\def\PYG@tok@m{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}} +\def\PYG@tok@mh{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}} +\def\PYG@tok@cs{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.50,0.56}{##1}}\def\PYG@bc##1{\colorbox[rgb]{1.00,0.94,0.94}{##1}}} +\def\PYG@tok@ge{\let\PYG@it=\textit} +\def\PYG@tok@vc{\def\PYG@tc##1{\textcolor[rgb]{0.73,0.38,0.84}{##1}}} +\def\PYG@tok@il{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}} +\def\PYG@tok@go{\def\PYG@tc##1{\textcolor[rgb]{0.19,0.19,0.19}{##1}}} +\def\PYG@tok@cp{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}} +\def\PYG@tok@gi{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.63,0.00}{##1}}} +\def\PYG@tok@gh{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.00,0.50}{##1}}} +\def\PYG@tok@ni{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.84,0.33,0.22}{##1}}} +\def\PYG@tok@nl{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.13,0.44}{##1}}} +\def\PYG@tok@nn{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.05,0.52,0.71}{##1}}} +\def\PYG@tok@no{\def\PYG@tc##1{\textcolor[rgb]{0.38,0.68,0.84}{##1}}} +\def\PYG@tok@na{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}} +\def\PYG@tok@nb{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}} +\def\PYG@tok@nc{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.05,0.52,0.71}{##1}}} +\def\PYG@tok@nd{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.33,0.33,0.33}{##1}}} +\def\PYG@tok@ne{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}} +\def\PYG@tok@nf{\def\PYG@tc##1{\textcolor[rgb]{0.02,0.16,0.49}{##1}}} +\def\PYG@tok@si{\let\PYG@it=\textit\def\PYG@tc##1{\textcolor[rgb]{0.44,0.63,0.82}{##1}}} +\def\PYG@tok@s2{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}} +\def\PYG@tok@vi{\def\PYG@tc##1{\textcolor[rgb]{0.73,0.38,0.84}{##1}}} +\def\PYG@tok@nt{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.02,0.16,0.45}{##1}}} +\def\PYG@tok@nv{\def\PYG@tc##1{\textcolor[rgb]{0.73,0.38,0.84}{##1}}} +\def\PYG@tok@s1{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}} +\def\PYG@tok@gp{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.78,0.36,0.04}{##1}}} +\def\PYG@tok@sh{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}} +\def\PYG@tok@ow{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}} +\def\PYG@tok@sx{\def\PYG@tc##1{\textcolor[rgb]{0.78,0.36,0.04}{##1}}} +\def\PYG@tok@bp{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}} +\def\PYG@tok@c1{\let\PYG@it=\textit\def\PYG@tc##1{\textcolor[rgb]{0.25,0.50,0.56}{##1}}} +\def\PYG@tok@kc{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}} +\def\PYG@tok@c{\let\PYG@it=\textit\def\PYG@tc##1{\textcolor[rgb]{0.25,0.50,0.56}{##1}}} +\def\PYG@tok@mf{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}} +\def\PYG@tok@err{\def\PYG@bc##1{\fcolorbox[rgb]{1.00,0.00,0.00}{1,1,1}{##1}}} +\def\PYG@tok@kd{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}} +\def\PYG@tok@ss{\def\PYG@tc##1{\textcolor[rgb]{0.32,0.47,0.09}{##1}}} +\def\PYG@tok@sr{\def\PYG@tc##1{\textcolor[rgb]{0.14,0.33,0.53}{##1}}} +\def\PYG@tok@mo{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}} +\def\PYG@tok@mi{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}} +\def\PYG@tok@kn{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}} +\def\PYG@tok@o{\def\PYG@tc##1{\textcolor[rgb]{0.40,0.40,0.40}{##1}}} +\def\PYG@tok@kr{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}} +\def\PYG@tok@s{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}} +\def\PYG@tok@kp{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}} +\def\PYG@tok@w{\def\PYG@tc##1{\textcolor[rgb]{0.73,0.73,0.73}{##1}}} +\def\PYG@tok@kt{\def\PYG@tc##1{\textcolor[rgb]{0.56,0.13,0.00}{##1}}} +\def\PYG@tok@sc{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}} +\def\PYG@tok@sb{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}} +\def\PYG@tok@k{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}} +\def\PYG@tok@se{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}} +\def\PYG@tok@sd{\let\PYG@it=\textit\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}} + +\def\PYGZbs{\char`\\} +\def\PYGZus{\char`\_} +\def\PYGZob{\char`\{} +\def\PYGZcb{\char`\}} +\def\PYGZca{\char`\^} +\def\PYGZsh{\char`\#} +\def\PYGZpc{\char`\%} +\def\PYGZdl{\char`\$} +\def\PYGZti{\char`\~} +% for compatibility with earlier versions +\def\PYGZat{@} +\def\PYGZlb{[} +\def\PYGZrb{]} +\makeatother + +\begin{document} + +\maketitle +\tableofcontents +\phantomsection\label{index::doc} + + +{\hfill\scalebox{1.000000}{\includegraphics{sat_about.png}}\hfill} + +\begin{notice}{warning}{Warning:} +This documentation is under construction. +\end{notice} + +The \textbf{Sa}lome\textbf{T}ools (sat) is a suite of commands +that can be used to perform operations on \href{http://www.salome-platform.org}{SALOME} (http://www.salome-platform.org). + +For example, sat allows you to compile SALOME's codes +(prerequisites, products) +create application, run tests, create package, etc. + +This utility code is a set of \href{https://docs.python.org/2.7}{Python} (https://docs.python.org/2.7) scripts files. + + +\chapter{Quick start} +\label{index:svn}\label{index:quick-start}\label{index:salome-tools} + +\section{Installation} +\label{installation_of_sat:installation}\label{installation_of_sat::doc} +Usually user could find (and use) command \textbf{sat} directly after a `detar' installation of SALOME. + +\begin{Verbatim}[commandchars=\\\{\}] +tar -xf .../SALOME\PYGZus{}xx.tgz +\PYG{n+nb}{cd }SALOME\PYGZus{}xx +ls -l sat \PYG{c}{\PYGZsh{} sat -\textgreater{} salomeTools/sat} +\end{Verbatim} + +Python package (scripts of salomeTools) actually remains in directory \emph{salomeTools}. + + +\section{Configuration} +\label{configuration:configuration}\label{configuration::doc} +\emph{salomeTools} uses files to store its configuration parameters. + +There are several configuration files which are loaded by salomeTools in a specific order. +When all the files are loaded a \emph{config} object is created. +Then, this object is passed to all command scripts. + + +\subsection{Syntax} +\label{configuration:syntax} +The configuration files use a python-like structure format +(see \href{http://www.red-dove.com/config-doc/}{config module} (http://www.red-dove.com/config-doc/) for a complete description). +\begin{itemize} +\item {} +\textbf{\{\}} define a dictionary, + +\item {} +\textbf{{[}{]}} define a list, + +\item {} +\textbf{@} can be used to include a file, + +\item {} +\textbf{\$prefix} reference to another parameter (ex: \code{\$PRODUCT.name}), + +\item {} +\textbf{\#} comments. + +\end{itemize} + +\begin{notice}{note}{Note:} +in this documentation a reference to a configuration parameter will be noted \code{XXX.YYY}. +\end{notice} + + +\subsection{Description} +\label{configuration:description} + +\subsubsection{VARS section} +\label{configuration:vars-section}\label{configuration:id1} +\begin{DUlineblock}{0em} +\item[] This section is dynamically created by salomeTools at run time. +\item[] It contains information about the environment: date, time, OS, architecture etc. +\end{DUlineblock} + +\begin{Verbatim}[commandchars=\\\{\}] +\# to get the current setting +sat config --value VARS +\end{Verbatim} + + +\subsubsection{PRODUCTS section} +\label{configuration:products-section} +\begin{DUlineblock}{0em} +\item[] This section is defined in the product file. +\item[] It contains instructions on how to build a version of SALOME (list of prerequisites-products and versions) +\end{DUlineblock} + +\begin{Verbatim}[commandchars=\\\{\}] +\# to get the current setting +sat config SALOME-xx --value PRODUCTS +\end{Verbatim} + + +\subsubsection{APPLICATION section} +\label{configuration:application-section} +\begin{DUlineblock}{0em} +\item[] This section is optional, it is also defined in the product file. +\item[] It gives additional parameters to create an application based on SALOME, as versions of products to use. +\end{DUlineblock} + +\begin{Verbatim}[commandchars=\\\{\}] +\# to get the current setting +sat config SALOME-xx --value APPLICATION +\end{Verbatim} + + +\subsubsection{USER section} +\label{configuration:user-section}\label{configuration:id2} +This section is defined by the user configuration file, +\code{\textasciitilde{}/.salomeTools/salomeTools.pyconf}. + +The \code{USER} section defines some parameters (not exhaustive): +\begin{itemize} +\item {} +\textbf{workDir} : +\begin{quote} + +\begin{DUlineblock}{0em} +\item[] The working directory. +\item[] Each product will be usually installed here (in sub-directories). +\end{DUlineblock} +\end{quote} + +\item {} +\textbf{browser} : The web browser to use (\emph{firefox}). + +\item {} +\textbf{editor} : The editor to use (\emph{vi, pluma}). + +\item {} +and other user preferences. + +\end{itemize} + +\begin{Verbatim}[commandchars=\\\{\}] +\# to get the current setting +sat config SALOME-xx --value USER +\end{Verbatim} + + +\section{Usage of SAlomeTools} +\label{usage_of_sat:svn}\label{usage_of_sat:usage-of-salometools}\label{usage_of_sat::doc} + +\subsection{Usage} +\label{usage_of_sat:usage} +sat usage is a Command Line Interface (\href{https://en.wikipedia.org/wiki/Command-line\_interface}{CLI} (https://en.wikipedia.org/wiki/Command-line\_interface)). + +\begin{Verbatim}[commandchars=\\\{\}] +sat \PYG{o}{[}generic\PYGZus{}options\PYG{o}{]} \PYG{o}{[}\PYG{n+nb}{command}\PYG{o}{]} \PYG{o}{[}product\PYG{o}{]} \PYG{o}{[}command\PYGZus{}options\PYG{o}{]} +\end{Verbatim} + + +\subsubsection{Options of sat} +\label{usage_of_sat:options-of-sat} +Useful \emph{not exhaustive} generic options of \emph{sat} CLI. + + +\paragraph{\emph{--help or -h}} +\label{usage_of_sat:help-or-h} +Get help as simple text. + +\begin{Verbatim}[commandchars=\\\{\}] +sat --help \PYG{c}{\PYGZsh{} get the list of existing commands} +sat --help compile \PYG{c}{\PYGZsh{} get the help on a specific command 'compile'} +\end{Verbatim} + + +\paragraph{\emph{--debug or -g}} +\label{usage_of_sat:debug-or-g} +Execution in debug mode allows to see more trace and \emph{stack} if an exception is raised. + + +\paragraph{\emph{--verbose or -v}} +\label{usage_of_sat:verbose-or-v} +Change verbosity level (default is 3). + +\begin{Verbatim}[commandchars=\\\{\}] +\PYG{c}{\PYGZsh{} for product 'SALOME\PYGZus{}xx' for example} +\PYG{c}{\PYGZsh{} execute compile command in debug mode with trace level 4} +sat -g -v 4 compile SALOME\PYGZus{}xx +\end{Verbatim} + + +\subsection{Build a SALOME product} +\label{usage_of_sat:build-a-salome-product} + +\subsubsection{Get the list of available products} +\label{usage_of_sat:get-the-list-of-available-products} +To get the list of the current available products in your context: + +\begin{Verbatim}[commandchars=\\\{\}] +sat config --list +\end{Verbatim} + + +\subsubsection{Prepare sources of a product} +\label{usage_of_sat:prepare-sources-of-a-product} +To prepare (get) \emph{all} the sources of a product (\emph{SALOME\_xx} for example): + +\begin{Verbatim}[commandchars=\\\{\}] +sat prepare SALOME\PYGZus{}xx +\end{Verbatim} + +\begin{DUlineblock}{0em} +\item[] The sources are usually copied in directories +\item[] \emph{\$USER.workDir + SALOME\_xx... + SOURCES + \$PRODUCT.name} +\end{DUlineblock} + + +\subsubsection{Compile SALOME} +\label{usage_of_sat:compile-salome} +To compile products: + +\begin{Verbatim}[commandchars=\\\{\}] +\PYG{c}{\PYGZsh{} compile all prerequisites/products} +sat compile SALOME\PYGZus{}xx + +\PYG{c}{\PYGZsh{} compile only 2 products (KERNEL and SAMPLES), if not done yet} +sat compile SALOME\PYGZus{}xx --products KERNEL,SAMPLES + +\PYG{c}{\PYGZsh{} compile only 2 products, unconditionaly} +sat compile SALOME\PYGZus{}xx ---products SAMPLES --clean\PYGZus{}all +\end{Verbatim} + +\begin{DUlineblock}{0em} +\item[] The products are usually build in the directories +\item[] \emph{\$USER.workDir + SALOME\_xx... + BUILD + \$PRODUCT.name} +\item[] +\item[] The products are usually installed in the directories +\item[] \emph{\$USER.workDir + SALOME\_xx... + INSTALL + \$PRODUCT.name} +\end{DUlineblock} + + +\chapter{List of Commands} +\label{index:list-of-commands} + +\section{Command config} +\label{commands/config:svn}\label{commands/config:command-config}\label{commands/config::doc} + +\subsection{Description} +\label{commands/config:description} +The \textbf{config} command manages sat configuration. +It allows display, manipulation and operation on configuration files + + +\subsection{Usage} +\label{commands/config:usage}\begin{itemize} +\item {} +Edit the user personal configuration file \code{\$HOME/.salomeTools/SAT.pyconf}. It is used to store the user personal choices, like the favorite editor, browser, pdf viewer: + +\begin{Verbatim}[commandchars=\\\{\}] +sat config --edit +\end{Verbatim} + +\item {} +List the available applications (they come from the sat projects defined in \code{data/local.pyconf}: + +\begin{Verbatim}[commandchars=\\\{\}] +sat config --list +\end{Verbatim} + +\item {} +Edit the configuration of an application: + +\begin{Verbatim}[commandchars=\\\{\}] +sat config \textless{}application\textgreater{} --edit +\end{Verbatim} + +\item {} +Copy an application configuration file into the user personal directory: + +\begin{Verbatim}[commandchars=\\\{\}] +sat config \textless{}application\textgreater{} --copy [new\_name] +\end{Verbatim} + +\item {} +\begin{DUlineblock}{0em} +\item[] Print the value of a configuration parameter. +\item[] Use the automatic completion to get recursively the parameter names. +\item[] Use \emph{--no\_label} option to get \emph{only} the value, \emph{without} label (useful in automatic scripts). +\item[] Examples (with \emph{SALOME-xx} as \emph{SALOME-8.4.0} ): +\end{DUlineblock} + +\begin{Verbatim}[commandchars=\\\{\}] +\PYG{c}{\PYGZsh{} sat config --value \textless{}parameter\PYGZus{}path\textgreater{}} +sat config --value . \PYG{c}{\PYGZsh{} all the configuration} +sat config --value LOCAL +sat config --value LOCAL.workdir + +\PYG{c}{\PYGZsh{} sat config \textless{}application\textgreater{} --value \textless{}parameter\PYGZus{}path\textgreater{}} +sat config SALOME-xx --value APPLICATION.workdir +sat config SALOME-xx --no\PYGZus{}label --value APPLICATION.workdir +\end{Verbatim} + +\item {} +\begin{DUlineblock}{0em} +\item[] Print in one-line-by-value mode the value of a configuration parameter, +\item[] with its source \emph{expression}, if any. +\item[] This is a debug mode, useful for developers. +\item[] Prints the parameter path, the source expression if any, and the final value: +\end{DUlineblock} + +\begin{Verbatim}[commandchars=\\\{\}] +sat config SALOME-xx -g USER +\end{Verbatim} + +\begin{notice}{note}{Note:} +And so, \emph{not only for fun}, to get \textbf{all expressions} of configuration + +\begin{Verbatim}[commandchars=\\\{\}] +sat config SALOME-xx -g . \textbar{} grep -e \PYG{l+s+s2}{"--\textgreater{}"} +\end{Verbatim} +\end{notice} + +\item {} +Print the patches that are applied: + +\begin{Verbatim}[commandchars=\\\{\}] +sat config SALOME-xx --show\_patchs +\end{Verbatim} + +\item {} +Get information on a product configuration: + +\begin{Verbatim}[commandchars=\\\{\}] +\PYG{c}{\PYGZsh{} sat config \textless{}application\textgreater{} --info \textless{}product\textgreater{}} +sat config SALOME-xx --info KERNEL +sat config SALOME-xx --info qt +\end{Verbatim} + +\end{itemize} + + +\subsection{Some useful configuration pathes} +\label{commands/config:some-useful-configuration-pathes} +Exploring a current configuration. +\begin{itemize} +\item {} +\textbf{PATHS}: To get list of directories where to find files. + +\item {} +\textbf{USER}: To get user preferences (editor, pdf viewer, web browser, default working dir). + +\end{itemize} + +sat commands: + +\begin{Verbatim}[commandchars=\\\{\}] +sat config SALOME-xx -v PATHS +sat config SALOME-xx -v USERS +\end{Verbatim} + + +\section{Command prepare} +\label{commands/prepare:svn}\label{commands/prepare:command-prepare}\label{commands/prepare::doc} + +\subsection{Description} +\label{commands/prepare:description} +The \textbf{prepare} command brings the sources of an application in the \emph{sources +application directory}, in order to compile them with the compile command. + +The sources can be prepared from VCS software (\emph{cvs, svn, git}), an archive or a directory. + +\begin{notice}{warning}{Warning:} +When sat prepares a product, it first removes the +existing directory, except if the development mode is activated. +When you are working on a product, you need to declare in +the application configuration this product in \textbf{dev} mode. +\end{notice} + + +\subsection{Remarks} +\label{commands/prepare:remarks} + +\subsubsection{VCS bases (git, svn, cvs)} +\label{commands/prepare:vcs-bases-git-svn-cvs} +The \emph{prepare} command does not manage authentication on the cvs server. +For example, to prepare modules from a cvs server, you first need to login once. + +To avoid typing a password for each product, +you may use a ssh key with passphrase, or store your password +(in .cvspass or .gitconfig files). +If you have security concerns, it is also possible to use +a bash agent and type your password only once. + + +\subsubsection{Dev mode} +\label{commands/prepare:dev-mode} +By default \emph{prepare} uses \emph{export} mode: it creates an image +of the sources, corresponding to the tag or branch specified, +without any link to the VCS base. +To perform a \emph{checkout} (svn, cvs) or a \emph{git clone} (git), +you need to declare the product in dev mode in your application configuration: +edit the application configuration file (pyconf) and modify the product declaration: + +\begin{Verbatim}[commandchars=\\\{\}] +sat config \textless{}application\textgreater{} -e +\PYG{c}{\PYGZsh{} and edit the product section:} +\PYG{c}{\PYGZsh{} \textless{}product\textgreater{} : \PYGZob{}tag : "my\PYGZus{}tag", dev : "yes", debug : "yes"\PYGZcb{}} +\end{Verbatim} + +The first time you will execute the \emph{sat prepare} command, +your module will be downloaded in \emph{checkout} mode +(inside the SOURCES directory of the application. +Then, you can develop in this repository, and finally push +them in the base when they are ready. +If you type during the development process by mistake +a \emph{sat prepare} command, the sources in dev mode will +not be altered/removed (Unless you use -f option) + + +\subsection{Usage} +\label{commands/prepare:usage}\begin{itemize} +\item {} +Prepare the sources of a complete application in SOURCES directory (all products): + +\begin{Verbatim}[commandchars=\\\{\}] +sat prepare \textless{}application\textgreater{} +\end{Verbatim} + +\item {} +Prepare only some modules: + +\begin{Verbatim}[commandchars=\\\{\}] +sat prepare \textless{}application\textgreater{} --products \textless{}product1\textgreater{},\textless{}product2\textgreater{} ... +\end{Verbatim} + +\item {} +Use --force to force to prepare the products in development mode +(this will remove the sources and do a new clone/checkout): + +\begin{Verbatim}[commandchars=\\\{\}] +sat prepare \textless{}application\textgreater{} --force +\end{Verbatim} + +\item {} +Use --force\_patch to force to apply patch to the products +in development mode (otherwise they are not applied): + +\begin{Verbatim}[commandchars=\\\{\}] +sat prepare \textless{}application\textgreater{} --force\_patch +\end{Verbatim} + +\end{itemize} + + +\subsection{Some useful configuration pathes} +\label{commands/prepare:some-useful-configuration-pathes} +Command \emph{sat prepare} uses the \emph{pyconf file configuration} of each product to know how to get the sources. + +\begin{notice}{note}{Note:} +to verify configuration of a product, and get name of this \emph{pyconf files configuration} + +\begin{Verbatim}[commandchars=\\\{\}] +sat config \textless{}application\textgreater{} --info \textless{}product\textgreater{} +\end{Verbatim} +\end{notice} +\begin{itemize} +\item {} +\textbf{get\_method}: the method to use to prepare the module, possible values are cvs, git, archive, dir. + +\item {} +\textbf{git\_info} : (used if get\_method = git) information to prepare sources from git. + +\item {} +\textbf{svn\_info} : (used if get\_method = svn) information to prepare sources from cvs. + +\item {} +\textbf{cvs\_info} : (used if get\_method = cvs) information to prepare sources from cvs. + +\item {} +\textbf{archive\_info} : (used if get\_method = archive) the path to the archive. + +\item {} +\textbf{dir\_info} : (used if get\_method = dir) the directory with the sources. + +\end{itemize} + + +\section{Command compile} +\label{commands/compile:svn}\label{commands/compile:command-compile}\label{commands/compile::doc} + +\subsection{Description} +\label{commands/compile:description} +The \textbf{compile} command allows compiling the products of a \href{http://www.salome-platform.org}{SALOME} (http://www.salome-platform.org) application. + + +\subsection{Usage} +\label{commands/compile:usage}\begin{itemize} +\item {} +Compile a complete application: + +\begin{Verbatim}[commandchars=\\\{\}] +sat compile \textless{}application\textgreater{} +\end{Verbatim} + +\item {} +Compile only some products: + +\begin{Verbatim}[commandchars=\\\{\}] +sat compile \textless{}application\textgreater{} --products \textless{}product1\textgreater{},\textless{}product2\textgreater{} ... +\end{Verbatim} + +\item {} +Use \emph{sat -t} to duplicate the logs in the terminal (by default the log are stored and displayed with \emph{sat log} command): + +\begin{Verbatim}[commandchars=\\\{\}] +sat -t compile \textless{}application\textgreater{} --products \textless{}product1\textgreater{} +\end{Verbatim} + +\item {} +Compile a module and its dependencies: + +\begin{Verbatim}[commandchars=\\\{\}] +sat compile \textless{}application\textgreater{} --products med --with\_fathers +\end{Verbatim} + +\item {} +Compile a module and the modules depending on it (for example plugins): + +\begin{Verbatim}[commandchars=\\\{\}] +sat compile \textless{}application\textgreater{} --products med --with\_children +\end{Verbatim} + +\item {} +Clean the build and install directories before starting compilation: + +\begin{Verbatim}[commandchars=\\\{\}] +sat compile \textless{}application\textgreater{} --products GEOM --clean\_all +\end{Verbatim} + +\begin{notice}{note}{Note:} +\begin{DUlineblock}{0em} +\item[] a warning will be shown if option \emph{--products} is missing +\item[] (as it will clean everything) +\end{DUlineblock} +\end{notice} + +\item {} +Clean only the install directories before starting compilation: + +\begin{Verbatim}[commandchars=\\\{\}] +sat compile \textless{}application\textgreater{} --clean\_install +\end{Verbatim} + +\item {} +Add options for make: + +\begin{Verbatim}[commandchars=\\\{\}] +sat compile \textless{}application\textgreater{} --products \textless{}product\textgreater{} --make\_flags \textless{}flags\textgreater{} +\end{Verbatim} + +\item {} +Use the \emph{--check} option to execute the unit tests after compilation: + +\begin{Verbatim}[commandchars=\\\{\}] +sat compile \textless{}application\textgreater{} --check +\end{Verbatim} + +\item {} +Remove the build directory after successful compilation (some build directory like qt are big): + +\begin{Verbatim}[commandchars=\\\{\}] +sat compile \textless{}application\textgreater{} --products qt --clean\_build\_after +\end{Verbatim} + +\item {} +Stop the compilation as soon as the compilation of a module fails: + +\begin{Verbatim}[commandchars=\\\{\}] +sat compile \textless{}product\textgreater{} --stop\_first\_fail +\end{Verbatim} + +\item {} +Do not compile, just show if products are installed or not, and where is the installation: + +\begin{Verbatim}[commandchars=\\\{\}] +sat compile \textless{}application\textgreater{} --show +\end{Verbatim} + +\end{itemize} + + +\subsection{Some useful configuration pathes} +\label{commands/compile:some-useful-configuration-pathes} +The way to compile a product is defined in the \emph{pyconf file configuration}. +The main options are: +\begin{itemize} +\item {} +\textbf{build\_source} : the method used to build the product (cmake/autotools/script) + +\item {} +\textbf{compil\_script} : the compilation script if build\_source is equal to ``script'' + +\item {} +\textbf{cmake\_options} : additional options for cmake. + +\item {} +\textbf{nb\_proc} : number of jobs to use with make for this product. + +\end{itemize} + + +\section{Command launcher} +\label{commands/launcher:svn}\label{commands/launcher:command-launcher}\label{commands/launcher::doc} + +\subsection{Description} +\label{commands/launcher:description} +The \textbf{launcher} command creates a SALOME launcher, a python script file to start \href{http://www.salome-platform.org}{SALOME} (http://www.salome-platform.org). + + +\subsection{Usage} +\label{commands/launcher:usage}\begin{itemize} +\item {} +Create a launcher: + +\begin{Verbatim}[commandchars=\\\{\}] +sat launcher \textless{}application\textgreater{} +\end{Verbatim} + +Generate a launcher in the application directory, i.e \code{\$APPLICATION.workdir}. + +\item {} +Create a launcher with a given name (default name is \code{APPLICATION.profile.launcher\_name}) + +\begin{Verbatim}[commandchars=\\\{\}] +sat launcher \textless{}application\textgreater{} --name ZeLauncher +\end{Verbatim} + +The launcher will be called \emph{ZeLauncher}. + +\item {} +Set a specific resources catalog: + +\begin{Verbatim}[commandchars=\\\{\}] +sat launcher \textless{}application\textgreater{} --catalog \textless{}path of a salome resources catalog\textgreater{} +\end{Verbatim} + +Note that the catalog specified will be copied to the profile directory. + +\item {} +Generate the catalog for a list of machines: + +\begin{Verbatim}[commandchars=\\\{\}] +sat launcher \textless{}application\textgreater{} --gencat \textless{}list of machines\textgreater{} +\end{Verbatim} + +This will create a catalog by querying each machine (memory, number of processor) with ssh. + +\item {} +Generate a mesa launcher (if mesa and llvm are parts of the application). Use this option only if you have to use salome through ssh and have problems with ssh X forwarding of OpengGL modules (like Paravis): + +\begin{Verbatim}[commandchars=\\\{\}] +sat launcher \textless{}application\textgreater{} --use\_mesa +\end{Verbatim} + +\end{itemize} + + +\subsection{Configuration} +\label{commands/launcher:configuration} +Some useful configuration pathes: +\begin{itemize} +\item {} +\textbf{APPLICATION.profile} +\begin{itemize} +\item {} +\textbf{product} : the name of the profile product (the product in charge of holding the application stuff, like logos, splashscreen) + +\item {} +\textbf{launcher\_name} : the name of the launcher. + +\end{itemize} + +\end{itemize} + + +\section{Command application} +\label{commands/application:svn}\label{commands/application::doc}\label{commands/application:command-application} + +\subsection{Description} +\label{commands/application:description} +The \textbf{application} command creates a virtual \href{http://www.salome-platform.org}{SALOME} (http://www.salome-platform.org) application. +Virtual SALOME applications are used to start SALOME when distribution is needed. + + +\subsection{Usage} +\label{commands/application:usage}\begin{itemize} +\item {} +Create an application: + +\begin{Verbatim}[commandchars=\\\{\}] +sat application \textless{}application\textgreater{} +\end{Verbatim} + +Create the virtual application directory in the salomeTool application directory \code{\$APPLICATION.workdir}. + +\item {} +Give a name to the application: + +\begin{Verbatim}[commandchars=\\\{\}] +sat application \textless{}application\textgreater{} --name \textless{}my\_application\_name\textgreater{} +\end{Verbatim} + +\emph{Remark}: this option overrides the name given in the virtual\_app section of the configuration file \code{\$APPLICATION.virtual\_app.name}. + +\item {} +Change the directory where the application is created: + +\begin{Verbatim}[commandchars=\\\{\}] +sat application \textless{}application\textgreater{} --target \textless{}my\_application\_directory\textgreater{} +\end{Verbatim} + +\item {} +Set a specific \href{http://www.salome-platform.org}{SALOME} (http://www.salome-platform.org) resources catalog (it will be used for the distribution of components on distant machines): + +\begin{Verbatim}[commandchars=\\\{\}] +sat application \textless{}application\textgreater{} --catalog \textless{}path\_to\_catalog\textgreater{} +\end{Verbatim} + +Note that the catalog specified will be copied to the application directory. + +\item {} +Generate the catalog for a list of machines: + +\begin{Verbatim}[commandchars=\\\{\}] +sat application \textless{}application\textgreater{} --gencat machine1,machine2,machine3 +\end{Verbatim} + +This will create a catalog by querying each machine through ssh protocol (memory, number of processor) with ssh. + +\item {} +Generate a mesa application (if mesa and llvm are parts of the application). Use this option only if you have to use salome through ssh and have problems with ssh X forwarding of OpengGL modules (like Paravis): + +\begin{Verbatim}[commandchars=\\\{\}] +sat launcher \textless{}application\textgreater{} --use\_mesa +\end{Verbatim} + +\end{itemize} + + +\subsection{Some useful configuration pathes} +\label{commands/application:some-useful-configuration-pathes} +The virtual application can be configured with the virtual\_app section of the configutation file. +\begin{itemize} +\item {} +\textbf{APPLICATION.virtual\_app} +\begin{itemize} +\item {} +\textbf{name} : name of the launcher (to replace the default runAppli). + +\item {} +\textbf{application\_name} : (optional) the name of the virtual application directory, if missing the default value is \code{\$name + \_appli}. + +\end{itemize} + +\end{itemize} + + +\section{Command log} +\label{commands/log:svn}\label{commands/log:command-log}\label{commands/log::doc} + +\subsection{Description} +\label{commands/log:description} +The \textbf{log} command displays sat log in a web browser or in a terminal. + + +\subsection{Usage} +\label{commands/log:usage}\begin{itemize} +\item {} +Show (in a web browser) the log of the commands corresponding to an application: + +\begin{Verbatim}[commandchars=\\\{\}] +sat log \textless{}application\textgreater{} +\end{Verbatim} + +\item {} +Show the log for commands that do not use any application: + +\begin{Verbatim}[commandchars=\\\{\}] +sat log +\end{Verbatim} + +\item {} +The --terminal (or -t) display the log directly in the terminal, through a \href{https://en.wikipedia.org/wiki/Command-line\_interface}{CLI} (https://en.wikipedia.org/wiki/Command-line\_interface) interactive menu: + +\begin{Verbatim}[commandchars=\\\{\}] +sat log \textless{}application\textgreater{} --terminal +\end{Verbatim} + +\item {} +The --last option displays only the last command: + +\begin{Verbatim}[commandchars=\\\{\}] +sat log \textless{}application\textgreater{} --last +\end{Verbatim} + +\item {} +To access the last compilation log in terminal mode, use --last\_terminal option: + +\begin{Verbatim}[commandchars=\\\{\}] +sat log \textless{}application\textgreater{} --last\_terminal +\end{Verbatim} + +\item {} +The --clean (int) option erases the n older log files and print the number of remaining log files: + +\begin{Verbatim}[commandchars=\\\{\}] +sat log \textless{}application\textgreater{} --clean 50 +\end{Verbatim} + +\end{itemize} + + +\subsection{Some useful configuration pathes} +\label{commands/log:some-useful-configuration-pathes}\begin{itemize} +\item {} +\textbf{USER} +\begin{itemize} +\item {} +\textbf{browser} : The browser used to show the log (by default \emph{firefox}). + +\item {} +\textbf{log\_dir} : The directory used to store the log files. + +\end{itemize} + +\end{itemize} + + +\section{Command environ} +\label{commands/environ:svn}\label{commands/environ:command-environ}\label{commands/environ::doc} + +\subsection{Description} +\label{commands/environ:description} +The \textbf{environ} command generates the environment files used +to run and compile your application (as \href{http://www.salome-platform.org}{SALOME} (http://www.salome-platform.org) is an example). + +\begin{notice}{note}{Note:} +these files are \textbf{not} required, +salomeTool set the environment himself, when compiling. +And so does the salome launcher. + +These files are useful when someone wants to check the environment. +They could be used in debug mode to set the environment for \emph{gdb}. +\end{notice} + +The configuration part at the end of this page explains how +to specify the environment used by sat (at build or run time), +and saved in some files by \emph{sat environ} command. + + +\subsection{Usage} +\label{commands/environ:usage}\begin{itemize} +\item {} +Create the shell environment files of the application: + +\begin{Verbatim}[commandchars=\\\{\}] +sat environ \textless{}application\textgreater{} +\end{Verbatim} + +\item {} +Create the environment files of the application for a given shell. +Options are bash, bat (for windows) and cfg (the configuration format used by \href{http://www.salome-platform.org}{SALOME} (http://www.salome-platform.org)): + +\begin{Verbatim}[commandchars=\\\{\}] +sat environ \textless{}application\textgreater{} --shell [bash\textbar{}cfg\textbar{}all] +\end{Verbatim} + +\item {} +Use a different prefix for the files (default is `env'): + +\begin{Verbatim}[commandchars=\\\{\}] +\PYG{c}{\PYGZsh{} This will create file \textless{}prefix\textgreater{}\PYGZus{}launch.sh, \textless{}prefix\textgreater{}\PYGZus{}build.sh} +sat environ \textless{}application\textgreater{} --prefix \textless{}prefix\textgreater{} +\end{Verbatim} + +\item {} +Use a different target directory for the files: + +\begin{Verbatim}[commandchars=\\\{\}] +\PYG{c}{\PYGZsh{} This will create file env\PYGZus{}launch.sh, env\PYGZus{}build.sh} +\PYG{c}{\PYGZsh{} in the directory corresponding to \textless{}path\textgreater{}} +sat environ \textless{}application\textgreater{} --target \textless{}path\textgreater{} +\end{Verbatim} + +\item {} +Generate the environment files only with the given products: + +\begin{Verbatim}[commandchars=\\\{\}] +\PYG{c}{\PYGZsh{} This will create the environment files only for the given products} +\PYG{c}{\PYGZsh{} and their prerequisites.} +\PYG{c}{\PYGZsh{} It is useful when you want to visualise which environment uses} +\PYG{c}{\PYGZsh{} sat to compile a given product.} +sat environ \textless{}application\textgreater{} --product \textless{}product1\textgreater{},\textless{}product2\textgreater{}, ... +\end{Verbatim} + +\end{itemize} + + +\subsection{Configuration} +\label{commands/environ:configuration} +The specification of the environment can be done through several mechanisms. +\begin{enumerate} +\item {} +For salome products (the products with the property \code{is\_SALOME\_module} as \code{yes}) the environment is set automatically by sat, in respect with \href{http://www.salome-platform.org}{SALOME} (http://www.salome-platform.org) requirements. + +\item {} +For other products, the environment is set with the use of the environ section within the pyconf file of the product. The user has two possibilities, either set directly the environment within the section, or specify a python script which wil be used to set the environment programmatically. + +\end{enumerate} + +Within the section, the user can define environment variables. He can also modify PATH variables, by appending or prepending directories. +In the following example, we prepend \emph{\textless{}install\_dir\textgreater{}/lib} to \code{LD\_LIBRARY\_PATH} (note the \emph{left first} underscore), append \emph{\textless{}install\_dir\textgreater{}/lib} to \code{PYTHONPATH} (note the \emph{right last} underscore), and set \code{LAPACK\_ROOT\_DIR} to \emph{\textless{}install\_dir\textgreater{}}: + +\begin{Verbatim}[commandchars=\\\{\}] +environ : +\PYGZob{} + \_LD\_LIBRARY\_PATH : \$install\_dir + \$VARS.sep + "lib" + PYTHONPATH\_ : \$install\_dir + \$VARS.sep + "lib" + LAPACK\_ROOT\_DIR : \$install\_dir +\PYGZcb{} +\end{Verbatim} + +It is possible to distinguish the build environment from the launch environment: use a subsection called \emph{build} or \emph{launch}. In the example below, \code{LD\_LIBRARY\_PATH} and \code{PYTHONPATH} are only modified at run time, not at compile time: + +\begin{Verbatim}[commandchars=\\\{\}] +environ : +\PYGZob{} + build : + \PYGZob{} + LAPACK\_ROOT\_DIR : \$install\_dir + \PYGZcb{} + launch : + \PYGZob{} + LAPACK\_ROOT\_DIR : \$install\_dir + \_LD\_LIBRARY\_PATH : \$install\_dir + \$VARS.sep + "lib" + PYTHONPATH\_ : \$install\_dir + \$VARS.sep + "lib" + \PYGZcb{} +\PYGZcb{} +\end{Verbatim} +\begin{enumerate} +\setcounter{enumi}{2} +\item {} +The last possibility is to set the environment with a python script. The script should be provided in the \emph{products/env\_scripts} directory of the sat project, and its name is specified in the environment section with the key \code{environ.env\_script}: + +\end{enumerate} + +\begin{Verbatim}[commandchars=\\\{\}] +\PYG{n}{environ} \PYG{p}{:} +\PYG{p}{\PYGZob{}} + \PYG{n}{env\PYGZus{}script} \PYG{p}{:} \PYG{l+s}{'}\PYG{l+s}{lapack.py}\PYG{l+s}{'} +\PYG{p}{\PYGZcb{}} +\end{Verbatim} + +Please note that the two modes are complementary and are both taken into account. +Most of the time, the first mode is sufficient. + +The second mode can be used when the environment has to be set programmatically. +The developer implements a handle (as a python method) +which is called by sat to set the environment. +Here is an example: + +\begin{Verbatim}[commandchars=\\\{\}] +\PYG{c}{\PYGZsh{}!/usr/bin/env python} +\PYG{c}{\PYGZsh{}-*- coding:utf-8 -*-} + +\PYG{k+kn}{import} \PYG{n+nn}{os.path} +\PYG{k+kn}{import} \PYG{n+nn}{platform} + +\PYG{k}{def} \PYG{n+nf}{set\PYGZus{}env}\PYG{p}{(}\PYG{n}{env}\PYG{p}{,} \PYG{n}{prereq\PYGZus{}dir}\PYG{p}{,} \PYG{n}{version}\PYG{p}{)}\PYG{p}{:} + \PYG{n}{env}\PYG{o}{.}\PYG{n}{set}\PYG{p}{(}\PYG{l+s}{"}\PYG{l+s}{TRUST\PYGZus{}ROOT\PYGZus{}DIR}\PYG{l+s}{"}\PYG{p}{,}\PYG{n}{prereq\PYGZus{}dir}\PYG{p}{)} + \PYG{n}{env}\PYG{o}{.}\PYG{n}{prepend}\PYG{p}{(}\PYG{l+s}{'}\PYG{l+s}{PATH}\PYG{l+s}{'}\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}{'}\PYG{l+s}{bin}\PYG{l+s}{'}\PYG{p}{)}\PYG{p}{)} + \PYG{n}{env}\PYG{o}{.}\PYG{n}{prepend}\PYG{p}{(}\PYG{l+s}{'}\PYG{l+s}{PATH}\PYG{l+s}{'}\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}{'}\PYG{l+s}{include}\PYG{l+s}{'}\PYG{p}{)}\PYG{p}{)} + \PYG{n}{env}\PYG{o}{.}\PYG{n}{prepend}\PYG{p}{(}\PYG{l+s}{'}\PYG{l+s}{LD\PYGZus{}LIBRARY\PYGZus{}PATH}\PYG{l+s}{'}\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}{'}\PYG{l+s}{lib}\PYG{l+s}{'}\PYG{p}{)}\PYG{p}{)} + \PYG{k}{return} +\end{Verbatim} + +SalomeTools defines four handles: +\begin{itemize} +\item {} +\textbf{set\_env(env, prereq\_dir, version)} : used at build and run time. + +\item {} +\textbf{set\_env\_launch(env, prereq\_dir, version)} : used only at run time (if defined!) + +\item {} +\textbf{set\_env\_build(env, prereq\_dir, version)} : used only at build time (if defined!) + +\item {} +\textbf{set\_native\_env(env)} : used only for native products, at build and run time. + +\end{itemize} + + +\section{Command clean} +\label{commands/clean:svn}\label{commands/clean:command-clean}\label{commands/clean::doc} + +\subsection{Description} +\label{commands/clean:description} +The \textbf{clean} command removes products in the \emph{source, build, or install} directories of an application. Theses directories are usually named \code{SOURCES, BUILD, INSTALL}. + +Use the options to define what directories you want to suppress and to set the list of products + + +\subsection{Usage} +\label{commands/clean:usage}\begin{itemize} +\item {} +Clean all previously created \emph{build} and \emph{install} directories (example application as \emph{SALOME\_xx}): + +\begin{Verbatim}[commandchars=\\\{\}] +\PYG{c}{\PYGZsh{} take care, is long time to restore, sometimes} +sat clean SALOME-xx --build --install +\end{Verbatim} + +\item {} +Clean previously created \emph{build} and \emph{install} directories, only for products with property \emph{is\_salome\_module}: + +\begin{Verbatim}[commandchars=\\\{\}] +sat clean SALOME-xxx --build --install \PYG{l+s+se}{\PYGZbs{}} + --properties is\PYGZus{}salome\PYGZus{}module:yes +\end{Verbatim} + +\end{itemize} + + +\subsection{Availables options} +\label{commands/clean:availables-options}\begin{itemize} +\item {} +\textbf{--products} : Products to clean. + +\item {} +\textbf{--properties} : + +\begin{DUlineblock}{0em} +\item[] Filter the products by their properties. +\item[] Syntax: \emph{--properties \textless{}property\textgreater{}:\textless{}value\textgreater{}} +\end{DUlineblock} + +\item {} +\textbf{--sources} : Clean the product source directories. + +\item {} +\textbf{--build} : Clean the product build directories. + +\item {} +\textbf{--install} : Clean the product install directories. + +\item {} +\textbf{--all} : Clean the product source, build and install directories. + +\item {} +\textbf{--sources\_without\_dev} : + +\begin{DUlineblock}{0em} +\item[] Do not clean the products in development mode, +\item[] (they could have \href{https://en.wikipedia.org/wiki/Version\_control}{VCS} (https://en.wikipedia.org/wiki/Version\_control) commits pending). +\end{DUlineblock} + +\end{itemize} + + +\subsection{Some useful configuration pathes} +\label{commands/clean:some-useful-configuration-pathes} +No specific configuration. + + +\section{Command package} +\label{commands/package:svn}\label{commands/package:command-package}\label{commands/package::doc} + +\subsection{Description} +\label{commands/package:description} +The \textbf{package} command creates a \href{http://www.salome-platform.org}{SALOME} (http://www.salome-platform.org) archive (usually a compressed \href{https://en.wikipedia.org/wiki/Tar\_(computing)}{Tar} (https://en.wikipedia.org/wiki/Tar\_(computing)) file .tgz). +This tar file is used later to intall SALOME on other remote computer. + +Depending on the selected options, the archive includes sources and binaries +of SALOME products and prerequisites. + +Usually utility \emph{salomeTools} is included in the archive. + +\begin{notice}{note}{Note:} +By default the package includes the sources of prerequisites and products. +To select a subset use the \emph{--without\_property} or \emph{--with\_vcs} options. +\end{notice} + + +\subsection{Usage} +\label{commands/package:usage}\begin{itemize} +\item {} +Create a package for a product (example as \emph{SALOME\_xx}): + +\begin{Verbatim}[commandchars=\\\{\}] +sat package SALOME\_xx +\end{Verbatim} + +This command will create an archive named \code{SALOME\_xx.tgz} +in the working directory (\code{USER.workDir}). +If the archive already exists, do nothing. + +\item {} +Create a package with a specific name: + +\begin{Verbatim}[commandchars=\\\{\}] +sat package SALOME\_xx --name YourSpecificName +\end{Verbatim} + +\end{itemize} + +\begin{notice}{note}{Note:} +By default, the archive is created in the working directory of the user (\code{USER.workDir}). + +If the option \emph{--name} is used with a path (relative or absolute) it will be used. + +If the option \emph{--name} is not used and binaries (prerequisites and products) +are included in the package, the \href{https://en.wikipedia.org/wiki/Operating\_system}{OS} (https://en.wikipedia.org/wiki/Operating\_system) architecture +will be appended to the name (example: \code{SALOME\_xx-CO7.tgz}). + +Examples: + +\begin{Verbatim}[commandchars=\\\{\}] +\# Creates SALOME\_xx.tgz in \$USER.workDir +sat package SALOME\_xx + +\# Creates SALOME\_xx\_\textless{}arch\textgreater{}.tgz in \$USER.workDir +sat package SALOME\_xx --binaries + +\# Creates MySpecificName.tgz in \$USER.workDir +sat package SALOME\_xx --name MySpecificName +\end{Verbatim} +\end{notice} +\begin{itemize} +\item {} +Force the creation of the archive (if it already exists): + +\begin{Verbatim}[commandchars=\\\{\}] +sat package SALOME\_xx --force +\end{Verbatim} + +\item {} +Include the binaries in the archive (products and prerequisites): + +\begin{Verbatim}[commandchars=\\\{\}] +sat package SALOME\_xx --binaries +\end{Verbatim} + +This command will create an archive named \code{SALOME\_xx \_\textless{}arch\textgreater{}.tgz} +where \textless{}arch\textgreater{} is the \href{https://en.wikipedia.org/wiki/Operating\_system}{OS} (https://en.wikipedia.org/wiki/Operating\_system) architecture of the machine. + +\item {} +Do not delete Version Control System (\href{https://en.wikipedia.org/wiki/Version\_control}{VCS} (https://en.wikipedia.org/wiki/Version\_control)) informations from the configurations files of the embedded salomeTools: + +\begin{Verbatim}[commandchars=\\\{\}] +sat package SALOME\_xx --with\_vcs +\end{Verbatim} + +The version control systems known by this option are \href{https://fr.wikipedia.org/wiki/Concurrent\_versions\_system}{CVS} (https://fr.wikipedia.org/wiki/Concurrent\_versions\_system), \href{https://en.wikipedia.org/wiki/Apache\_Subversion}{SVN} (https://en.wikipedia.org/wiki/Apache\_Subversion) and \href{https://git-scm.com}{Git} (https://git-scm.com). + +\end{itemize} + + +\subsection{Some useful configuration pathes} +\label{commands/package:some-useful-configuration-pathes} +No specific configuration. + + +\section{Command generate} +\label{commands/generate:svn}\label{commands/generate:command-generate}\label{commands/generate::doc} + +\subsection{Description} +\label{commands/generate:description} +The \textbf{generate} command generates and compile SALOME modules from cpp modules using YACSGEN. + +\begin{notice}{note}{Note:} +This command uses YACSGEN to generate the module. It needs to be specified with \emph{--yacsgen} option, or defined in the product or by the environment variable \code{\$YACSGEN\_ROOT\_DIR}. +\end{notice} + + +\subsection{Remarks} +\label{commands/generate:remarks}\begin{itemize} +\item {} +This command will only apply on the CPP modules of the application, those who have both properties: + +\begin{Verbatim}[commandchars=\\\{\}] +cpp : "yes" +generate : "yes" +\end{Verbatim} + +\item {} +The cpp module are usually computational components, and the generated module brings the CORBA layer which allows distributing the compononent on remore machines. cpp modules should conform to YACSGEN/hxx2salome requirements (please refer to YACSGEN documentation) + +\end{itemize} + + +\subsection{Usage} +\label{commands/generate:usage}\begin{itemize} +\item {} +Generate all the modules of a product: + +\begin{Verbatim}[commandchars=\\\{\}] +sat generate \textless{}application\textgreater{} +\end{Verbatim} + +\item {} +Generate only specific modules: + +\begin{Verbatim}[commandchars=\\\{\}] +sat generate \textless{}application\textgreater{} --products \textless{}list\_of\_products\textgreater{} +\end{Verbatim} + +Remark: modules which don't have the \emph{generate} property are ignored. + +\item {} +Use a specific version of YACSGEN: + +\begin{Verbatim}[commandchars=\\\{\}] +sat generate \textless{}application\textgreater{} --yacsgen \textless{}path\_to\_yacsgen\textgreater{} +\end{Verbatim} + +\end{itemize} + + +\chapter{Developer documentation} +\label{index:developer-documentation} + +\section{Add a user custom command} +\label{write_command:svn}\label{write_command:add-a-user-custom-command}\label{write_command::doc} + +\subsection{Introduction} +\label{write_command:introduction} +\begin{notice}{note}{Note:} +This documentation is for \href{https://docs.python.org/2.7}{Python} (https://docs.python.org/2.7) developers. +\end{notice} + +The salomeTools product provides a simple way to develop commands. +The first thing to do is to add a file with \emph{.py} extension in the \code{commands} directory of salomeTools. + +Here are the basic requirements that must be followed in this file in order to add a command. + + +\subsection{Basic requirements} +\label{write_command:basic-requirements} +By adding a file \emph{mycommand.py} in the \code{commands} directory, salomeTools will define a new command named \code{mycommand}. + +In \emph{mycommand.py}, there must be the following method: + +\begin{Verbatim}[commandchars=\\\{\}] +\PYG{k}{def} \PYG{n+nf}{run}\PYG{p}{(}\PYG{n}{args}\PYG{p}{,} \PYG{n}{runner}\PYG{p}{,} \PYG{n}{logger}\PYG{p}{)}\PYG{p}{:} + \PYG{c}{\PYGZsh{} your algorithm ...} + \PYG{k}{pass} +\end{Verbatim} + +In fact, at this point, the command will already be functional. +But there are some useful services provided by salomeTools : +\begin{itemize} +\item {} +You can give some options to your command: + +\end{itemize} + +\begin{Verbatim}[commandchars=\\\{\}] +\PYG{k+kn}{import} \PYG{n+nn}{src} + +\PYG{c}{\PYGZsh{} Define all possible option for mycommand command : 'sat mycommand \textless{}options\textgreater{}'} +\PYG{n}{parser} \PYG{o}{=} \PYG{n}{src}\PYG{o}{.}\PYG{n}{options}\PYG{o}{.}\PYG{n}{Options}\PYG{p}{(}\PYG{p}{)} +\PYG{n}{parser}\PYG{o}{.}\PYG{n}{add\PYGZus{}option}\PYG{p}{(}\PYG{l+s}{'}\PYG{l+s}{m}\PYG{l+s}{'}\PYG{p}{,} \PYG{l+s}{'}\PYG{l+s}{myoption}\PYG{l+s}{'}\PYG{p}{,} \PYGZbs{} + \PYG{l+s}{'}\PYG{l+s}{boolean}\PYG{l+s}{'}\PYG{p}{,} \PYG{l+s}{'}\PYG{l+s}{myoption}\PYG{l+s}{'}\PYG{p}{,} \PYGZbs{} + \PYG{l+s}{'}\PYG{l+s}{My option changes the behavior of my command.}\PYG{l+s}{'}\PYG{p}{)} + +\PYG{k}{def} \PYG{n+nf}{run}\PYG{p}{(}\PYG{n}{args}\PYG{p}{,} \PYG{n}{runner}\PYG{p}{,} \PYG{n}{logger}\PYG{p}{)}\PYG{p}{:} + \PYG{c}{\PYGZsh{} Parse the options} + \PYG{p}{(}\PYG{n}{options}\PYG{p}{,} \PYG{n}{args}\PYG{p}{)} \PYG{o}{=} \PYG{n}{parser}\PYG{o}{.}\PYG{n}{parse\PYGZus{}args}\PYG{p}{(}\PYG{n}{args}\PYG{p}{)} + \PYG{c}{\PYGZsh{} algorithm} +\end{Verbatim} +\begin{itemize} +\item {} +You can add a \emph{description} method that will display a message when the user will call the help: + +\end{itemize} + +\begin{Verbatim}[commandchars=\\\{\}] + \PYG{k+kn}{import} \PYG{n+nn}{src} + + \PYG{c}{\PYGZsh{} Define all possible option for mycommand command : 'sat mycommand \textless{}options\textgreater{}'} + \PYG{n}{parser} \PYG{o}{=} \PYG{n}{src}\PYG{o}{.}\PYG{n}{options}\PYG{o}{.}\PYG{n}{Options}\PYG{p}{(}\PYG{p}{)} + \PYG{n}{parser}\PYG{o}{.}\PYG{n}{add\PYGZus{}option}\PYG{p}{(}\PYG{l+s}{'}\PYG{l+s}{m}\PYG{l+s}{'}\PYG{p}{,} \PYG{l+s}{'}\PYG{l+s}{myoption}\PYG{l+s}{'}\PYG{p}{,} \PYGZbs{} + \PYG{l+s}{'}\PYG{l+s}{boolean}\PYG{l+s}{'}\PYG{p}{,} \PYG{l+s}{'}\PYG{l+s}{myoption}\PYG{l+s}{'}\PYG{p}{,} \PYGZbs{} + \PYG{l+s}{'}\PYG{l+s}{My option changes the behavior of my command.}\PYG{l+s}{'}\PYG{p}{)} + + \PYG{k}{def} \PYG{n+nf}{description}\PYG{p}{(}\PYG{p}{)}\PYG{p}{:} + \PYG{k}{return} \PYG{n}{\PYGZus{}}\PYG{p}{(}\PYG{l+s}{"}\PYG{l+s}{The help of mycommand.}\PYG{l+s}{"}\PYG{p}{)} + + \PYG{k}{def} \PYG{n+nf}{run}\PYG{p}{(}\PYG{n}{args}\PYG{p}{,} \PYG{n}{runner}\PYG{p}{,} \PYG{n}{logger}\PYG{p}{)}\PYG{p}{:} + \PYG{c}{\PYGZsh{} Parse the options} + \PYG{p}{(}\PYG{n}{options}\PYG{p}{,} \PYG{n}{args}\PYG{p}{)} \PYG{o}{=} \PYG{n}{parser}\PYG{o}{.}\PYG{n}{parse\PYGZus{}args}\PYG{p}{(}\PYG{n}{args}\PYG{p}{)} + \PYG{c}{\PYGZsh{} algorithm} +\end{Verbatim} + + +\subsection{HowTo access salomeTools config and other commands} +\label{write_command:howto-access-salometools-config-and-other-commands} +The \emph{runner} variable is an python instance of \emph{Sat} class. +It gives access to \emph{runner.cfg} which is the data model defined from all +\emph{configuration pyconf files} of salomeTools +For example, \emph{runner.cfg.APPLICATION.workdir} +contains the root directory of the current application. + +The \emph{runner} variable gives also access to other commands of salomeTools: + +\begin{Verbatim}[commandchars=\\\{\}] +\PYG{c}{\PYGZsh{} as CLI\PYGZus{} 'sat prepare ...'} +\PYG{n}{runner}\PYG{o}{.}\PYG{n}{prepare}\PYG{p}{(}\PYG{n}{runner}\PYG{o}{.}\PYG{n}{cfg}\PYG{o}{.}\PYG{n}{VARS}\PYG{o}{.}\PYG{n}{application}\PYG{p}{)} +\end{Verbatim} + + +\subsection{HowTo logger} +\label{write_command:howto-logger} +The logger variable is an instance of the Logger class. +It gives access to the write method. + +When this method is called, the message passed as parameter +will be displayed in the terminal and written in an xml log file. + +\begin{Verbatim}[commandchars=\\\{\}] +\PYG{n}{logger}\PYG{o}{.}\PYG{n}{write}\PYG{p}{(}\PYG{l+s}{"}\PYG{l+s}{My message}\PYG{l+s}{"}\PYG{p}{,} \PYG{l+m+mi}{3}\PYG{p}{)} \PYG{c}{\PYGZsh{} 3 as default} +\end{Verbatim} + +The second argument defines the level of verbosity +that is wanted for this message. +It has to be between 1 and 5 (the most verbose level). + + +\subsection{HELLO example} +\label{write_command:hello-example} +Here is a \emph{hello} command, file \emph{commands/hello.py}: + +\begin{Verbatim}[commandchars=\\\{\}] +\PYG{k+kn}{import} \PYG{n+nn}{src} + +\PYG{l+s+sd}{"""} +\PYG{l+s+sd}{hello.py} +\PYG{l+s+sd}{Define all possible options for hello command:} +\PYG{l+s+sd}{sat hello \textless{}options\textgreater{}} +\PYG{l+s+sd}{"""} + +\PYG{n}{parser} \PYG{o}{=} \PYG{n}{src}\PYG{o}{.}\PYG{n}{options}\PYG{o}{.}\PYG{n}{Options}\PYG{p}{(}\PYG{p}{)} +\PYG{n}{parser}\PYG{o}{.}\PYG{n}{add\PYGZus{}option}\PYG{p}{(}\PYG{l+s}{'}\PYG{l+s}{f}\PYG{l+s}{'}\PYG{p}{,} \PYG{l+s}{'}\PYG{l+s}{french}\PYG{l+s}{'}\PYG{p}{,} \PYG{l+s}{'}\PYG{l+s}{boolean}\PYG{l+s}{'}\PYG{p}{,} \PYG{l+s}{'}\PYG{l+s}{french}\PYG{l+s}{'}\PYG{p}{,} \PYG{l+s}{"}\PYG{l+s}{french set hello message in french.}\PYG{l+s}{"}\PYG{p}{)} + +\PYG{k}{def} \PYG{n+nf}{description}\PYG{p}{(}\PYG{p}{)}\PYG{p}{:} + \PYG{k}{return} \PYG{n}{\PYGZus{}}\PYG{p}{(}\PYG{l+s}{"}\PYG{l+s}{The help of hello.}\PYG{l+s}{"}\PYG{p}{)} + +\PYG{k}{def} \PYG{n+nf}{run}\PYG{p}{(}\PYG{n}{args}\PYG{p}{,} \PYG{n}{runner}\PYG{p}{,} \PYG{n}{logger}\PYG{p}{)}\PYG{p}{:} + \PYG{c}{\PYGZsh{} Parse the options} + \PYG{p}{(}\PYG{n}{options}\PYG{p}{,} \PYG{n}{args}\PYG{p}{)} \PYG{o}{=} \PYG{n}{parser}\PYG{o}{.}\PYG{n}{parse\PYGZus{}args}\PYG{p}{(}\PYG{n}{args}\PYG{p}{)} + \PYG{c}{\PYGZsh{} algorithm} + \PYG{k}{if} \PYG{o+ow}{not} \PYG{n}{options}\PYG{o}{.}\PYG{n}{french}\PYG{p}{:} + \PYG{n}{logger}\PYG{o}{.}\PYG{n}{write}\PYG{p}{(}\PYG{l+s}{'}\PYG{l+s}{HELLO! WORLD!}\PYG{l+s+se}{\PYGZbs{}n}\PYG{l+s}{'}\PYG{p}{)} + \PYG{k}{else}\PYG{p}{:} + \PYG{n}{logger}\PYG{o}{.}\PYG{n}{write}\PYG{p}{(}\PYG{l+s}{'}\PYG{l+s}{Bonjour tout le monde!}\PYG{l+s+se}{\PYGZbs{}n}\PYG{l+s}{'}\PYG{p}{)} +\end{Verbatim} + +A first call of hello: + +\begin{Verbatim}[commandchars=\\\{\}] +\PYG{c}{\PYGZsh{} Get the help of hello:} +./sat --help hello + +\PYG{c}{\PYGZsh{} To get bonjour} +./sat hello --french +Bonjour tout le monde! + +\PYG{c}{\PYGZsh{} To get hello} +./sat hello +HELLO! WORLD! + +\PYG{c}{\PYGZsh{} To get the log} +./sat log +\end{Verbatim} + + +\chapter{Code documentation} +\label{index:code-documentation} + +\section{src} +\label{commands/apidoc/modules:src}\label{commands/apidoc/modules::doc} + +\subsection{src Package} +\label{commands/apidoc/src::doc}\label{commands/apidoc/src:src-package} + +\subsubsection{\texttt{src} Package} +\label{commands/apidoc/src:id1}\phantomsection\label{commands/apidoc/src:module-src.__init__}\index{src.\_\_init\_\_ (module)} +initial imports and utilities methods for salomeTools +\index{Path (class in src.\_\_init\_\_)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.__init__.Path}\pysiglinewithargsret{\strong{class }\code{src.\_\_init\_\_.}\bfcode{Path}}{\emph{path}}{}~\index{base() (src.\_\_init\_\_.Path method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.__init__.Path.base}\pysiglinewithargsret{\bfcode{base}}{}{} +\end{fulllineitems} + +\index{chmod() (src.\_\_init\_\_.Path method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.__init__.Path.chmod}\pysiglinewithargsret{\bfcode{chmod}}{\emph{mode}}{} +\end{fulllineitems} + +\index{copy() (src.\_\_init\_\_.Path method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.__init__.Path.copy}\pysiglinewithargsret{\bfcode{copy}}{\emph{path}, \emph{smart=False}}{} +\end{fulllineitems} + +\index{copydir() (src.\_\_init\_\_.Path method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.__init__.Path.copydir}\pysiglinewithargsret{\bfcode{copydir}}{\emph{dst}, \emph{smart=False}}{} +\end{fulllineitems} + +\index{copyfile() (src.\_\_init\_\_.Path method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.__init__.Path.copyfile}\pysiglinewithargsret{\bfcode{copyfile}}{\emph{path}}{} +\end{fulllineitems} + +\index{copylink() (src.\_\_init\_\_.Path method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.__init__.Path.copylink}\pysiglinewithargsret{\bfcode{copylink}}{\emph{path}}{} +\end{fulllineitems} + +\index{dir() (src.\_\_init\_\_.Path method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.__init__.Path.dir}\pysiglinewithargsret{\bfcode{dir}}{}{} +\end{fulllineitems} + +\index{exists() (src.\_\_init\_\_.Path method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.__init__.Path.exists}\pysiglinewithargsret{\bfcode{exists}}{}{} +\end{fulllineitems} + +\index{isdir() (src.\_\_init\_\_.Path method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.__init__.Path.isdir}\pysiglinewithargsret{\bfcode{isdir}}{}{} +\end{fulllineitems} + +\index{isfile() (src.\_\_init\_\_.Path method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.__init__.Path.isfile}\pysiglinewithargsret{\bfcode{isfile}}{}{} +\end{fulllineitems} + +\index{islink() (src.\_\_init\_\_.Path method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.__init__.Path.islink}\pysiglinewithargsret{\bfcode{islink}}{}{} +\end{fulllineitems} + +\index{list() (src.\_\_init\_\_.Path method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.__init__.Path.list}\pysiglinewithargsret{\bfcode{list}}{}{} +\end{fulllineitems} + +\index{make() (src.\_\_init\_\_.Path method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.__init__.Path.make}\pysiglinewithargsret{\bfcode{make}}{\emph{mode=None}}{} +\end{fulllineitems} + +\index{readlink() (src.\_\_init\_\_.Path method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.__init__.Path.readlink}\pysiglinewithargsret{\bfcode{readlink}}{}{} +\end{fulllineitems} + +\index{rm() (src.\_\_init\_\_.Path method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.__init__.Path.rm}\pysiglinewithargsret{\bfcode{rm}}{}{} +\end{fulllineitems} + +\index{smartcopy() (src.\_\_init\_\_.Path method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.__init__.Path.smartcopy}\pysiglinewithargsret{\bfcode{smartcopy}}{\emph{path}}{} +\end{fulllineitems} + +\index{symlink() (src.\_\_init\_\_.Path method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.__init__.Path.symlink}\pysiglinewithargsret{\bfcode{symlink}}{\emph{path}}{} +\end{fulllineitems} + + +\end{fulllineitems} + +\index{SatException} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.__init__.SatException}\pysigline{\strong{exception }\code{src.\_\_init\_\_.}\bfcode{SatException}} +Bases: \code{exceptions.Exception} + +rename Exception Class + +\end{fulllineitems} + +\index{activate\_mesa\_property() (in module src.\_\_init\_\_)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.__init__.activate_mesa_property}\pysiglinewithargsret{\code{src.\_\_init\_\_.}\bfcode{activate\_mesa\_property}}{\emph{config}}{} +Add mesa property into application properties +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{Config} (\emph{config}) -- The global configuration. It must have an application! + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{check\_config\_has\_application() (in module src.\_\_init\_\_)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.__init__.check_config_has_application}\pysiglinewithargsret{\code{src.\_\_init\_\_.}\bfcode{check\_config\_has\_application}}{\emph{config}, \emph{details=None}}{} +check that the config has the key APPLICATION. Else raise an exception. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{class `common.pyconf.Config'} (\emph{config}) -- The config. + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{check\_config\_has\_profile() (in module src.\_\_init\_\_)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.__init__.check_config_has_profile}\pysiglinewithargsret{\code{src.\_\_init\_\_.}\bfcode{check\_config\_has\_profile}}{\emph{config}, \emph{details=None}}{} +check that the config has the key APPLICATION.profile. +else, raise an exception. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{class `common.pyconf.Config'} (\emph{config}) -- The config. + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{config\_has\_application() (in module src.\_\_init\_\_)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.__init__.config_has_application}\pysiglinewithargsret{\code{src.\_\_init\_\_.}\bfcode{config\_has\_application}}{\emph{config}}{} +\end{fulllineitems} + +\index{deepcopy\_list() (in module src.\_\_init\_\_)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.__init__.deepcopy_list}\pysiglinewithargsret{\code{src.\_\_init\_\_.}\bfcode{deepcopy\_list}}{\emph{input\_list}}{} +Do a deep copy of a list +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{List} (\emph{input\_list}) -- The list to copy + +\item[{Returns}] \leavevmode +The copy of the list + +\item[{Return type}] \leavevmode +List + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{ensure\_path\_exists() (in module src.\_\_init\_\_)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.__init__.ensure_path_exists}\pysiglinewithargsret{\code{src.\_\_init\_\_.}\bfcode{ensure\_path\_exists}}{\emph{p}}{} +Create a path if not existing +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{str} (\emph{p}) -- The path. + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{find\_file\_in\_lpath() (in module src.\_\_init\_\_)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.__init__.find_file_in_lpath}\pysiglinewithargsret{\code{src.\_\_init\_\_.}\bfcode{find\_file\_in\_lpath}}{\emph{file\_name}, \emph{lpath}, \emph{additional\_dir='`}}{} +Find in all the directories in lpath list the file that has the same name +as file\_name. +If it is found +then return the full path of the file +else return False. + +The additional\_dir (optional) is the name of the directory to add to all +paths in lpath. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{str} (\emph{additional\_dir}) -- The file name to search + +\item {} +\textbf{List} (\emph{lpath}) -- The list of directories where to search + +\item {} +\textbf{str} -- The name of the additional directory + +\end{itemize} + +\item[{Returns}] \leavevmode +the full path of the file or False if not found + +\item[{Return type}] \leavevmode +str + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{get\_base\_path() (in module src.\_\_init\_\_)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.__init__.get_base_path}\pysiglinewithargsret{\code{src.\_\_init\_\_.}\bfcode{get\_base\_path}}{\emph{config}}{} +Returns the path of the products base. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{Config} (\emph{config}) -- The global Config instance. + +\item[{Returns}] \leavevmode +The path of the products base. + +\item[{Return type}] \leavevmode +str + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{get\_cfg\_param() (in module src.\_\_init\_\_)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.__init__.get_cfg_param}\pysiglinewithargsret{\code{src.\_\_init\_\_.}\bfcode{get\_cfg\_param}}{\emph{config}, \emph{param\_name}, \emph{default}}{} +eearch for param\_name value in config. +if param\_name is not in config +then return default, +else return the found value +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{class `common.pyconf.Config'} (\emph{config}) -- The config. + +\item {} +\textbf{str} (\emph{default}) -- the name of the parameter to get the value + +\item {} +\textbf{str} -- The value to return if param\_name is not in config + +\end{itemize} + +\item[{Returns}] \leavevmode +see initial description of the function + +\item[{Return type}] \leavevmode +str + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{get\_launcher\_name() (in module src.\_\_init\_\_)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.__init__.get_launcher_name}\pysiglinewithargsret{\code{src.\_\_init\_\_.}\bfcode{get\_launcher\_name}}{\emph{config}}{} +Returns the name of salome launcher. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{Config} (\emph{config}) -- The global Config instance. + +\item[{Returns}] \leavevmode +The name of salome launcher. + +\item[{Return type}] \leavevmode +str + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{get\_log\_path() (in module src.\_\_init\_\_)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.__init__.get_log_path}\pysiglinewithargsret{\code{src.\_\_init\_\_.}\bfcode{get\_log\_path}}{\emph{config}}{} +Returns the path of the logs. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{Config} (\emph{config}) -- The global Config instance. + +\item[{Returns}] \leavevmode +The path of the logs. + +\item[{Return type}] \leavevmode +str + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{get\_property\_in\_product\_cfg() (in module src.\_\_init\_\_)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.__init__.get_property_in_product_cfg}\pysiglinewithargsret{\code{src.\_\_init\_\_.}\bfcode{get\_property\_in\_product\_cfg}}{\emph{product\_cfg}, \emph{pprty}}{} +\end{fulllineitems} + +\index{get\_salome\_version() (in module src.\_\_init\_\_)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.__init__.get_salome_version}\pysiglinewithargsret{\code{src.\_\_init\_\_.}\bfcode{get\_salome\_version}}{\emph{config}}{} +\end{fulllineitems} + +\index{get\_tmp\_filename() (in module src.\_\_init\_\_)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.__init__.get_tmp_filename}\pysiglinewithargsret{\code{src.\_\_init\_\_.}\bfcode{get\_tmp\_filename}}{\emph{cfg}, \emph{name}}{} +\end{fulllineitems} + +\index{handleRemoveReadonly() (in module src.\_\_init\_\_)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.__init__.handleRemoveReadonly}\pysiglinewithargsret{\code{src.\_\_init\_\_.}\bfcode{handleRemoveReadonly}}{\emph{func}, \emph{path}, \emph{exc}}{} +\end{fulllineitems} + +\index{merge\_dicts() (in module src.\_\_init\_\_)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.__init__.merge_dicts}\pysiglinewithargsret{\code{src.\_\_init\_\_.}\bfcode{merge\_dicts}}{\emph{*dict\_args}}{} +Given any number of dicts, shallow copy and merge into a new dict, +precedence goes to key value pairs in latter dicts. + +\end{fulllineitems} + +\index{only\_numbers() (in module src.\_\_init\_\_)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.__init__.only_numbers}\pysiglinewithargsret{\code{src.\_\_init\_\_.}\bfcode{only\_numbers}}{\emph{str\_num}}{} +\end{fulllineitems} + +\index{parse\_date() (in module src.\_\_init\_\_)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.__init__.parse_date}\pysiglinewithargsret{\code{src.\_\_init\_\_.}\bfcode{parse\_date}}{\emph{date}}{} +Transform YYYYMMDD\_hhmmss into YYYY-MM-DD hh:mm:ss. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{str} (\emph{date}) -- The date to transform + +\item[{Returns}] \leavevmode +The date in the new format + +\item[{Return type}] \leavevmode +str + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{print\_info() (in module src.\_\_init\_\_)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.__init__.print_info}\pysiglinewithargsret{\code{src.\_\_init\_\_.}\bfcode{print\_info}}{\emph{logger}, \emph{info}}{} +Prints the tuples that are in info variable in a formatted way. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{Logger} (\emph{logger}) -- The logging instance to use for the prints. + +\item {} +\textbf{list} (\emph{info}) -- The list of tuples to display + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{read\_config\_from\_a\_file() (in module src.\_\_init\_\_)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.__init__.read_config_from_a_file}\pysiglinewithargsret{\code{src.\_\_init\_\_.}\bfcode{read\_config\_from\_a\_file}}{\emph{filePath}}{} +\end{fulllineitems} + +\index{remove\_item\_from\_list() (in module src.\_\_init\_\_)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.__init__.remove_item_from_list}\pysiglinewithargsret{\code{src.\_\_init\_\_.}\bfcode{remove\_item\_from\_list}}{\emph{input\_list}, \emph{item}}{} +Remove all occurences of item from input\_list +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{List} (\emph{input\_list}) -- The list to modify + +\item[{Returns}] \leavevmode +The without any item + +\item[{Return type}] \leavevmode +List + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{replace\_in\_file() (in module src.\_\_init\_\_)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.__init__.replace_in_file}\pysiglinewithargsret{\code{src.\_\_init\_\_.}\bfcode{replace\_in\_file}}{\emph{filein}, \emph{strin}, \emph{strout}}{} +Replace \textless{}strin\textgreater{} by \textless{}strout\textgreater{} in file \textless{}filein\textgreater{} + +\end{fulllineitems} + + + +\subsubsection{\texttt{ElementTree} Module} +\label{commands/apidoc/src:elementtree-module}\label{commands/apidoc/src:module-src.ElementTree}\index{src.ElementTree (module)}\index{Comment() (in module src.ElementTree)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.ElementTree.Comment}\pysiglinewithargsret{\code{src.ElementTree.}\bfcode{Comment}}{\emph{text=None}}{} +\end{fulllineitems} + +\index{dump() (in module src.ElementTree)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.ElementTree.dump}\pysiglinewithargsret{\code{src.ElementTree.}\bfcode{dump}}{\emph{elem}}{} +\end{fulllineitems} + +\index{Element() (in module src.ElementTree)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.ElementTree.Element}\pysiglinewithargsret{\code{src.ElementTree.}\bfcode{Element}}{\emph{tag}, \emph{attrib=\{\}}, \emph{**extra}}{} +\end{fulllineitems} + +\index{ElementTree (class in src.ElementTree)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.ElementTree.ElementTree}\pysiglinewithargsret{\strong{class }\code{src.ElementTree.}\bfcode{ElementTree}}{\emph{element=None}, \emph{file=None}}{}~\index{find() (src.ElementTree.ElementTree method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.ElementTree.ElementTree.find}\pysiglinewithargsret{\bfcode{find}}{\emph{path}}{} +\end{fulllineitems} + +\index{findall() (src.ElementTree.ElementTree method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.ElementTree.ElementTree.findall}\pysiglinewithargsret{\bfcode{findall}}{\emph{path}}{} +\end{fulllineitems} + +\index{findtext() (src.ElementTree.ElementTree method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.ElementTree.ElementTree.findtext}\pysiglinewithargsret{\bfcode{findtext}}{\emph{path}, \emph{default=None}}{} +\end{fulllineitems} + +\index{getiterator() (src.ElementTree.ElementTree method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.ElementTree.ElementTree.getiterator}\pysiglinewithargsret{\bfcode{getiterator}}{\emph{tag=None}}{} +\end{fulllineitems} + +\index{getroot() (src.ElementTree.ElementTree method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.ElementTree.ElementTree.getroot}\pysiglinewithargsret{\bfcode{getroot}}{}{} +\end{fulllineitems} + +\index{parse() (src.ElementTree.ElementTree method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.ElementTree.ElementTree.parse}\pysiglinewithargsret{\bfcode{parse}}{\emph{source}, \emph{parser=None}}{} +\end{fulllineitems} + +\index{write() (src.ElementTree.ElementTree method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.ElementTree.ElementTree.write}\pysiglinewithargsret{\bfcode{write}}{\emph{file}, \emph{encoding='us-ascii'}}{} +\end{fulllineitems} + + +\end{fulllineitems} + +\index{fromstring() (in module src.ElementTree)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.ElementTree.fromstring}\pysiglinewithargsret{\code{src.ElementTree.}\bfcode{fromstring}}{\emph{text}}{} +\end{fulllineitems} + +\index{iselement() (in module src.ElementTree)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.ElementTree.iselement}\pysiglinewithargsret{\code{src.ElementTree.}\bfcode{iselement}}{\emph{element}}{} +\end{fulllineitems} + +\index{iterparse (class in src.ElementTree)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.ElementTree.iterparse}\pysiglinewithargsret{\strong{class }\code{src.ElementTree.}\bfcode{iterparse}}{\emph{source}, \emph{events=None}}{}~\index{next() (src.ElementTree.iterparse method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.ElementTree.iterparse.next}\pysiglinewithargsret{\bfcode{next}}{}{} +\end{fulllineitems} + + +\end{fulllineitems} + +\index{parse() (in module src.ElementTree)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.ElementTree.parse}\pysiglinewithargsret{\code{src.ElementTree.}\bfcode{parse}}{\emph{source}, \emph{parser=None}}{} +\end{fulllineitems} + +\index{PI() (in module src.ElementTree)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.ElementTree.PI}\pysiglinewithargsret{\code{src.ElementTree.}\bfcode{PI}}{\emph{target}, \emph{text=None}}{} +\end{fulllineitems} + +\index{ProcessingInstruction() (in module src.ElementTree)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.ElementTree.ProcessingInstruction}\pysiglinewithargsret{\code{src.ElementTree.}\bfcode{ProcessingInstruction}}{\emph{target}, \emph{text=None}}{} +\end{fulllineitems} + +\index{QName (class in src.ElementTree)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.ElementTree.QName}\pysiglinewithargsret{\strong{class }\code{src.ElementTree.}\bfcode{QName}}{\emph{text\_or\_uri}, \emph{tag=None}}{} +\end{fulllineitems} + +\index{SubElement() (in module src.ElementTree)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.ElementTree.SubElement}\pysiglinewithargsret{\code{src.ElementTree.}\bfcode{SubElement}}{\emph{parent}, \emph{tag}, \emph{attrib=\{\}}, \emph{**extra}}{} +\end{fulllineitems} + +\index{tostring() (in module src.ElementTree)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.ElementTree.tostring}\pysiglinewithargsret{\code{src.ElementTree.}\bfcode{tostring}}{\emph{element}, \emph{encoding=None}}{} +\end{fulllineitems} + +\index{TreeBuilder (class in src.ElementTree)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.ElementTree.TreeBuilder}\pysiglinewithargsret{\strong{class }\code{src.ElementTree.}\bfcode{TreeBuilder}}{\emph{element\_factory=None}}{}~\index{close() (src.ElementTree.TreeBuilder method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.ElementTree.TreeBuilder.close}\pysiglinewithargsret{\bfcode{close}}{}{} +\end{fulllineitems} + +\index{data() (src.ElementTree.TreeBuilder method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.ElementTree.TreeBuilder.data}\pysiglinewithargsret{\bfcode{data}}{\emph{data}}{} +\end{fulllineitems} + +\index{end() (src.ElementTree.TreeBuilder method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.ElementTree.TreeBuilder.end}\pysiglinewithargsret{\bfcode{end}}{\emph{tag}}{} +\end{fulllineitems} + +\index{start() (src.ElementTree.TreeBuilder method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.ElementTree.TreeBuilder.start}\pysiglinewithargsret{\bfcode{start}}{\emph{tag}, \emph{attrs}}{} +\end{fulllineitems} + + +\end{fulllineitems} + +\index{XML() (in module src.ElementTree)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.ElementTree.XML}\pysiglinewithargsret{\code{src.ElementTree.}\bfcode{XML}}{\emph{text}}{} +\end{fulllineitems} + +\index{XMLTreeBuilder (class in src.ElementTree)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.ElementTree.XMLTreeBuilder}\pysiglinewithargsret{\strong{class }\code{src.ElementTree.}\bfcode{XMLTreeBuilder}}{\emph{html=0}, \emph{target=None}}{}~\index{close() (src.ElementTree.XMLTreeBuilder method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.ElementTree.XMLTreeBuilder.close}\pysiglinewithargsret{\bfcode{close}}{}{} +\end{fulllineitems} + +\index{doctype() (src.ElementTree.XMLTreeBuilder method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.ElementTree.XMLTreeBuilder.doctype}\pysiglinewithargsret{\bfcode{doctype}}{\emph{name}, \emph{pubid}, \emph{system}}{} +\end{fulllineitems} + +\index{feed() (src.ElementTree.XMLTreeBuilder method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.ElementTree.XMLTreeBuilder.feed}\pysiglinewithargsret{\bfcode{feed}}{\emph{data}}{} +\end{fulllineitems} + + +\end{fulllineitems} + + + +\subsubsection{\texttt{architecture} Module} +\label{commands/apidoc/src:architecture-module}\label{commands/apidoc/src:module-src.architecture}\index{src.architecture (module)} +In this file : all the stuff that can change with the architecture +on which SAT is running +\index{get\_distrib\_version() (in module src.architecture)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.architecture.get_distrib_version}\pysiglinewithargsret{\code{src.architecture.}\bfcode{get\_distrib\_version}}{\emph{distrib}, \emph{codes}}{} +Gets the version of the distribution +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{str} (\emph{distrib}) -- The distribution on which the version will be found. + +\item {} +\textbf{L\{Mapping\}} (\emph{codes}) -- The map containing distribution correlation table. + +\end{itemize} + +\item[{Returns}] \leavevmode +The version of the distribution on which salomeTools is running, +regarding the distribution correlation table contained in codes +variable. + +\item[{Return type}] \leavevmode +str + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{get\_distribution() (in module src.architecture)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.architecture.get_distribution}\pysiglinewithargsret{\code{src.architecture.}\bfcode{get\_distribution}}{\emph{codes}}{} +Gets the code for the distribution +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{L\{Mapping\}} (\emph{codes}) -- The map containing distribution correlation table. + +\item[{Returns}] \leavevmode +The distribution on which salomeTools is running, regarding the +distribution correlation table contained in codes variable. + +\item[{Return type}] \leavevmode +str + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{get\_nb\_proc() (in module src.architecture)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.architecture.get_nb_proc}\pysiglinewithargsret{\code{src.architecture.}\bfcode{get\_nb\_proc}}{}{} +Gets the number of processors of the machine +on which salomeTools is running. +\begin{quote}\begin{description} +\item[{Returns}] \leavevmode +the number of processors. + +\item[{Return type}] \leavevmode +str + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{get\_python\_version() (in module src.architecture)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.architecture.get_python_version}\pysiglinewithargsret{\code{src.architecture.}\bfcode{get\_python\_version}}{}{} +Gets the version of the running python. +\begin{quote}\begin{description} +\item[{Returns}] \leavevmode +the version of the running python. + +\item[{Return type}] \leavevmode +str + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{get\_user() (in module src.architecture)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.architecture.get_user}\pysiglinewithargsret{\code{src.architecture.}\bfcode{get\_user}}{}{} +method that gets the username that launched sat +\begin{quote}\begin{description} +\item[{Return type}] \leavevmode +str + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{is\_windows() (in module src.architecture)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.architecture.is_windows}\pysiglinewithargsret{\code{src.architecture.}\bfcode{is\_windows}}{}{} +method that checks windows OS +\begin{quote}\begin{description} +\item[{Return type}] \leavevmode +boolean + +\end{description}\end{quote} + +\end{fulllineitems} + + + +\subsubsection{\texttt{compilation} Module} +\label{commands/apidoc/src:module-src.compilation}\label{commands/apidoc/src:compilation-module}\index{src.compilation (module)}\index{Builder (class in src.compilation)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.compilation.Builder}\pysiglinewithargsret{\strong{class }\code{src.compilation.}\bfcode{Builder}}{\emph{config}, \emph{logger}, \emph{product\_info}, \emph{options=\textless{}src.options.OptResult object at 0x245afd0\textgreater{}}, \emph{check\_src=True}}{} +Class to handle all construction steps, like cmake, configure, make, ... +\index{build\_configure() (src.compilation.Builder method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.compilation.Builder.build_configure}\pysiglinewithargsret{\bfcode{build\_configure}}{\emph{options='`}}{} +\end{fulllineitems} + +\index{check() (src.compilation.Builder method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.compilation.Builder.check}\pysiglinewithargsret{\bfcode{check}}{\emph{command='`}}{} +\end{fulllineitems} + +\index{cmake() (src.compilation.Builder method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.compilation.Builder.cmake}\pysiglinewithargsret{\bfcode{cmake}}{\emph{options='`}}{} +\end{fulllineitems} + +\index{complete\_environment() (src.compilation.Builder method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.compilation.Builder.complete_environment}\pysiglinewithargsret{\bfcode{complete\_environment}}{\emph{make\_options}}{} +\end{fulllineitems} + +\index{configure() (src.compilation.Builder method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.compilation.Builder.configure}\pysiglinewithargsret{\bfcode{configure}}{\emph{options='`}}{} +\end{fulllineitems} + +\index{do\_batch\_script\_build() (src.compilation.Builder method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.compilation.Builder.do_batch_script_build}\pysiglinewithargsret{\bfcode{do\_batch\_script\_build}}{\emph{script}, \emph{nb\_proc}}{} +\end{fulllineitems} + +\index{do\_default\_build() (src.compilation.Builder method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.compilation.Builder.do_default_build}\pysiglinewithargsret{\bfcode{do\_default\_build}}{\emph{build\_conf\_options='`}, \emph{configure\_options='`}, \emph{show\_warning=True}}{} +\end{fulllineitems} + +\index{do\_python\_script\_build() (src.compilation.Builder method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.compilation.Builder.do_python_script_build}\pysiglinewithargsret{\bfcode{do\_python\_script\_build}}{\emph{script}, \emph{nb\_proc}}{} +\end{fulllineitems} + +\index{do\_script\_build() (src.compilation.Builder method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.compilation.Builder.do_script_build}\pysiglinewithargsret{\bfcode{do\_script\_build}}{\emph{script}, \emph{number\_of\_proc=0}}{} +\end{fulllineitems} + +\index{hack\_libtool() (src.compilation.Builder method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.compilation.Builder.hack_libtool}\pysiglinewithargsret{\bfcode{hack\_libtool}}{}{} +\end{fulllineitems} + +\index{install() (src.compilation.Builder method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.compilation.Builder.install}\pysiglinewithargsret{\bfcode{install}}{}{} +\end{fulllineitems} + +\index{log() (src.compilation.Builder method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.compilation.Builder.log}\pysiglinewithargsret{\bfcode{log}}{\emph{text}, \emph{level}, \emph{showInfo=True}}{} +\end{fulllineitems} + +\index{log\_command() (src.compilation.Builder method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.compilation.Builder.log_command}\pysiglinewithargsret{\bfcode{log\_command}}{\emph{command}}{} +\end{fulllineitems} + +\index{make() (src.compilation.Builder method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.compilation.Builder.make}\pysiglinewithargsret{\bfcode{make}}{\emph{nb\_proc}, \emph{make\_opt='`}}{} +\end{fulllineitems} + +\index{prepare() (src.compilation.Builder method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.compilation.Builder.prepare}\pysiglinewithargsret{\bfcode{prepare}}{}{} +\end{fulllineitems} + +\index{put\_txt\_log\_in\_appli\_log\_dir() (src.compilation.Builder method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.compilation.Builder.put_txt_log_in_appli_log_dir}\pysiglinewithargsret{\bfcode{put\_txt\_log\_in\_appli\_log\_dir}}{\emph{file\_name}}{} +Put the txt log (that contain the system logs, like make command +output) in the directory \textless{}APPLICATION DIR\textgreater{}/LOGS/\textless{}product\_name\textgreater{}/ +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{Str} (\emph{file\_name}) -- the name of the file to write + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{wmake() (src.compilation.Builder method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.compilation.Builder.wmake}\pysiglinewithargsret{\bfcode{wmake}}{\emph{nb\_proc}, \emph{opt\_nb\_proc=None}}{} +\end{fulllineitems} + + +\end{fulllineitems} + + + +\subsubsection{\texttt{debug} Module} +\label{commands/apidoc/src:module-src.debug}\label{commands/apidoc/src:debug-module}\index{src.debug (module)} +This file assume DEBUG functionalities use +\begin{itemize} +\item {} +print debug messages in sys.stderr for salomeTools + +\item {} +show pretty print debug representation from instances of SAT classes +(pretty print src.pyconf.Config), and python dict/list etc. (as `aVariable') + +\end{itemize} + +WARNING: obviously supposedly show messages in SAT development phase, not production + +usage: +\textgreater{}\textgreater{} import debug as DBG +\textgreater{}\textgreater{} DBG.write(``aTitle'', aVariable) \# not shown in production +\textgreater{}\textgreater{} DBG.write(``aTitle'', aVariable, True) \# unconditionaly shown (as show=True) + +to set show message as development phase: +\textgreater{}\textgreater{} DBG.push\_debug(True) + +to set no show message as production phase: +\textgreater{}\textgreater{} DBG.push\_debug(False) + +to set show message temporary as development phase, only in a method: +\textgreater{}\textgreater{} def aMethodToDebug(...): +\textgreater{}\textgreater{} DBG.push\_debug(True) \#force show as appended status +\textgreater{}\textgreater{} etc. method code with some DBG.write() +\textgreater{}\textgreater{} DBG.pop\_debug() \#restore previous status (show or not show) +\textgreater{}\textgreater{} return + +to set a message for future fix, as temporary problem to not forget: +DBG.tofix(``aTitle'', aVariable, True/False) \#True/False in production shown, or not + +in command line interface you could redirect stderr to file `myDebug.log': +\textgreater{}\textgreater{} sat compile ... 2\textgreater{} myDebug.log \# only stderr +\textgreater{}\textgreater{} sat compile ... \&\textgreater{} myDebug.log \# stdout and stderr +\index{InStream (class in src.debug)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.debug.InStream}\pysiglinewithargsret{\strong{class }\code{src.debug.}\bfcode{InStream}}{\emph{buf='`}}{} +Bases: \code{StringIO.StringIO} + +utility class for pyconf.Config input iostream + +\end{fulllineitems} + +\index{OutStream (class in src.debug)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.debug.OutStream}\pysiglinewithargsret{\strong{class }\code{src.debug.}\bfcode{OutStream}}{\emph{buf='`}}{} +Bases: \code{StringIO.StringIO} + +utility class for pyconf.Config output iostream +\index{close() (src.debug.OutStream method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.debug.OutStream.close}\pysiglinewithargsret{\bfcode{close}}{}{} +because Config.\_\_save\_\_ calls close() stream as file +keep value before lost as self.value + +\end{fulllineitems} + + +\end{fulllineitems} + +\index{getLocalEnv() (in module src.debug)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.debug.getLocalEnv}\pysiglinewithargsret{\code{src.debug.}\bfcode{getLocalEnv}}{}{} +get string for environment variables representation + +\end{fulllineitems} + +\index{getStrConfigDbg() (in module src.debug)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.debug.getStrConfigDbg}\pysiglinewithargsret{\code{src.debug.}\bfcode{getStrConfigDbg}}{\emph{config}}{} +set string as saveConfigDbg, +as (path expression evaluation) for debug + +\end{fulllineitems} + +\index{getStrConfigStd() (in module src.debug)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.debug.getStrConfigStd}\pysiglinewithargsret{\code{src.debug.}\bfcode{getStrConfigStd}}{\emph{config}}{} +set string as saveConfigStd, as file .pyconf + +\end{fulllineitems} + +\index{indent() (in module src.debug)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.debug.indent}\pysiglinewithargsret{\code{src.debug.}\bfcode{indent}}{\emph{text}, \emph{amount=2}, \emph{ch=' `}}{} +indent multi lines message + +\end{fulllineitems} + +\index{pop\_debug() (in module src.debug)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.debug.pop_debug}\pysiglinewithargsret{\code{src.debug.}\bfcode{pop\_debug}}{}{} +restore previous debug outputs status + +\end{fulllineitems} + +\index{push\_debug() (in module src.debug)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.debug.push_debug}\pysiglinewithargsret{\code{src.debug.}\bfcode{push\_debug}}{\emph{aBool}}{} +set debug outputs activated, or not + +\end{fulllineitems} + +\index{saveConfigDbg() (in module src.debug)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.debug.saveConfigDbg}\pysiglinewithargsret{\code{src.debug.}\bfcode{saveConfigDbg}}{\emph{config}, \emph{aStream}, \emph{indent=0}, \emph{path='`}}{} +pyconf returns multilines (path expression evaluation) for debug + +\end{fulllineitems} + +\index{saveConfigStd() (in module src.debug)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.debug.saveConfigStd}\pysiglinewithargsret{\code{src.debug.}\bfcode{saveConfigStd}}{\emph{config}, \emph{aStream}}{} +returns as file .pyconf + +\end{fulllineitems} + +\index{tofix() (in module src.debug)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.debug.tofix}\pysiglinewithargsret{\code{src.debug.}\bfcode{tofix}}{\emph{title}, \emph{var='`}, \emph{force=None}}{} +write sys.stderr a message if \_debug{[}-1{]}==True or optionaly force=True +use this only if no logger accessible for classic +logger.warning(message) or logger.debug(message) + +\end{fulllineitems} + +\index{write() (in module src.debug)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.debug.write}\pysiglinewithargsret{\code{src.debug.}\bfcode{write}}{\emph{title}, \emph{var='`}, \emph{force=None}, \emph{fmt='\textbackslash{}n\#\#\#\# DEBUG: \%s:\textbackslash{}n\%s\textbackslash{}n'}}{} +write sys.stderr a message if \_debug{[}-1{]}==True or optionaly force=True + +\end{fulllineitems} + + + +\subsubsection{\texttt{environment} Module} +\label{commands/apidoc/src:environment-module}\label{commands/apidoc/src:module-src.environment}\index{src.environment (module)}\index{Environ (class in src.environment)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.environment.Environ}\pysiglinewithargsret{\strong{class }\code{src.environment.}\bfcode{Environ}}{\emph{environ=None}}{} +Class to manage the environment context +\index{append() (src.environment.Environ method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.environment.Environ.append}\pysiglinewithargsret{\bfcode{append}}{\emph{key}, \emph{value}, \emph{sep=':'}}{} +Same as append\_value but the value argument can be a list +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{str} (\emph{sep}) -- the environment variable to append + +\item {} +\textbf{str or list} (\emph{value}) -- the value(s) to append to key + +\item {} +\textbf{str} -- the separator string + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{append\_value() (src.environment.Environ method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.environment.Environ.append_value}\pysiglinewithargsret{\bfcode{append\_value}}{\emph{key}, \emph{value}, \emph{sep=':'}}{} +append value to key using sep +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{str} (\emph{sep}) -- the environment variable to append + +\item {} +\textbf{str} -- the value to append to key + +\item {} +\textbf{str} -- the separator string + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{command\_value() (src.environment.Environ method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.environment.Environ.command_value}\pysiglinewithargsret{\bfcode{command\_value}}{\emph{key}, \emph{command}}{} +Get the value given by the system command ``command'' +and put it in the environment variable key +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{str} (\emph{command}) -- the environment variable + +\item {} +\textbf{str} -- the command to execute + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{get() (src.environment.Environ method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.environment.Environ.get}\pysiglinewithargsret{\bfcode{get}}{\emph{key}}{} +Get the value of the environment variable ``key'' +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{str} (\emph{key}) -- the environment variable + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{is\_defined() (src.environment.Environ method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.environment.Environ.is_defined}\pysiglinewithargsret{\bfcode{is\_defined}}{\emph{key}}{} +Check if the key exists in the environment +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{str} (\emph{key}) -- the environment variable to check + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{prepend() (src.environment.Environ method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.environment.Environ.prepend}\pysiglinewithargsret{\bfcode{prepend}}{\emph{key}, \emph{value}, \emph{sep=':'}}{} +Same as prepend\_value but the value argument can be a list +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{str} (\emph{sep}) -- the environment variable to prepend + +\item {} +\textbf{str or list} (\emph{value}) -- the value(s) to prepend to key + +\item {} +\textbf{str} -- the separator string + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{prepend\_value() (src.environment.Environ method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.environment.Environ.prepend_value}\pysiglinewithargsret{\bfcode{prepend\_value}}{\emph{key}, \emph{value}, \emph{sep=':'}}{} +prepend value to key using sep +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{str} (\emph{sep}) -- the environment variable to prepend + +\item {} +\textbf{str} -- the value to prepend to key + +\item {} +\textbf{str} -- the separator string + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{set() (src.environment.Environ method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.environment.Environ.set}\pysiglinewithargsret{\bfcode{set}}{\emph{key}, \emph{value}}{} +Set the environment variable ``key'' to value ``value'' +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{str} (\emph{value}) -- the environment variable to set + +\item {} +\textbf{str} -- the value + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + + +\end{fulllineitems} + +\index{FileEnvWriter (class in src.environment)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.environment.FileEnvWriter}\pysiglinewithargsret{\strong{class }\code{src.environment.}\bfcode{FileEnvWriter}}{\emph{config}, \emph{logger}, \emph{out\_dir}, \emph{src\_root}, \emph{env\_info=None}}{} +Class to dump the environment to a file. +\index{write\_cfgForPy\_file() (src.environment.FileEnvWriter method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.environment.FileEnvWriter.write_cfgForPy_file}\pysiglinewithargsret{\bfcode{write\_cfgForPy\_file}}{\emph{filename}, \emph{additional\_env=\{\}}, \emph{for\_package=None}, \emph{with\_commercial=True}}{} +Append to current opened aFile a cfgForPy +environment (SALOME python launcher). +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{str} (\emph{for\_package}) -- the file path + +\item {} +\textbf{dict} (\emph{additional\_env}) -- a dictionary of additional variables +to add to the environment + +\item {} +\textbf{str} -- If not None, produce a relative environment +designed for a package. + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{write\_env\_file() (src.environment.FileEnvWriter method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.environment.FileEnvWriter.write_env_file}\pysiglinewithargsret{\bfcode{write\_env\_file}}{\emph{filename}, \emph{forBuild}, \emph{shell}, \emph{for\_package=None}}{} +Create an environment file. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{str} (\emph{shell}) -- the file path + +\item {} +\textbf{bool} (\emph{forBuild}) -- if true, the build environment + +\item {} +\textbf{str} -- the type of file wanted (.sh, .bat) + +\end{itemize} + +\item[{Returns}] \leavevmode +The path to the generated file + +\item[{Return type}] \leavevmode +str + +\end{description}\end{quote} + +\end{fulllineitems} + + +\end{fulllineitems} + +\index{SalomeEnviron (class in src.environment)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron}\pysiglinewithargsret{\strong{class }\code{src.environment.}\bfcode{SalomeEnviron}}{\emph{cfg}, \emph{environ}, \emph{forBuild=False}, \emph{for\_package=None}, \emph{enable\_simple\_env\_script=True}}{} +Class to manage the environment of SALOME. +\index{add\_comment() (src.environment.SalomeEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron.add_comment}\pysiglinewithargsret{\bfcode{add\_comment}}{\emph{comment}}{} +Add a commentary to the out stream (in case of file generation) +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{str} (\emph{comment}) -- the commentary to add + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{add\_line() (src.environment.SalomeEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron.add_line}\pysiglinewithargsret{\bfcode{add\_line}}{\emph{nb\_line}}{} +Add empty lines to the out stream (in case of file generation) +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{int} (\emph{nb\_line}) -- the number of empty lines to add + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{add\_warning() (src.environment.SalomeEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron.add_warning}\pysiglinewithargsret{\bfcode{add\_warning}}{\emph{warning}}{} +Add a warning to the out stream (in case of file generation) +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{str} (\emph{warning}) -- the warning to add + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{append() (src.environment.SalomeEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron.append}\pysiglinewithargsret{\bfcode{append}}{\emph{key}, \emph{value}, \emph{sep=':'}}{} +append value to key using sep +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{str} (\emph{sep}) -- the environment variable to append + +\item {} +\textbf{str} -- the value to append to key + +\item {} +\textbf{str} -- the separator string + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{dump() (src.environment.SalomeEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron.dump}\pysiglinewithargsret{\bfcode{dump}}{\emph{out}}{} +Write the environment to out +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{file} (\emph{out}) -- the stream where to write the environment + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{finish() (src.environment.SalomeEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron.finish}\pysiglinewithargsret{\bfcode{finish}}{\emph{required}}{} +Add a final instruction in the out file (in case of file generation) +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{bool} (\emph{required}) -- Do nothing if required is False + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{get() (src.environment.SalomeEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron.get}\pysiglinewithargsret{\bfcode{get}}{\emph{key}}{} +Get the value of the environment variable ``key'' +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{str} (\emph{key}) -- the environment variable + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{get\_names() (src.environment.SalomeEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron.get_names}\pysiglinewithargsret{\bfcode{get\_names}}{\emph{lProducts}}{} +Get the products name to add in SALOME\_MODULES environment variable +It is the name of the product, except in the case where the is a +component name. And it has to be in SALOME\_MODULES variable only +if the product has the property has\_salome\_hui = ``yes'' +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{list} (\emph{lProducts}) -- List of products to potentially add + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{is\_defined() (src.environment.SalomeEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron.is_defined}\pysiglinewithargsret{\bfcode{is\_defined}}{\emph{key}}{} +Check if the key exists in the environment +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{str} (\emph{key}) -- the environment variable to check + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{load\_cfg\_environment() (src.environment.SalomeEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron.load_cfg_environment}\pysiglinewithargsret{\bfcode{load\_cfg\_environment}}{\emph{cfg\_env}}{} +Loads environment defined in cfg\_env +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{Config} (\emph{cfg\_env}) -- A config containing an environment + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{prepend() (src.environment.SalomeEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron.prepend}\pysiglinewithargsret{\bfcode{prepend}}{\emph{key}, \emph{value}, \emph{sep=':'}}{} +prepend value to key using sep +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{str} (\emph{sep}) -- the environment variable to prepend + +\item {} +\textbf{str} -- the value to prepend to key + +\item {} +\textbf{str} -- the separator string + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{run\_env\_script() (src.environment.SalomeEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron.run_env_script}\pysiglinewithargsret{\bfcode{run\_env\_script}}{\emph{product\_info}, \emph{logger=None}, \emph{native=False}}{} +Runs an environment script. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{Config} (\emph{product\_info}) -- The product description + +\item {} +\textbf{Logger} (\emph{logger}) -- The logger instance to display messages + +\item {} +\textbf{Boolean} (\emph{native}) -- if True load set\_native\_env instead of set\_env + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{run\_simple\_env\_script() (src.environment.SalomeEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron.run_simple_env_script}\pysiglinewithargsret{\bfcode{run\_simple\_env\_script}}{\emph{script\_path}, \emph{logger=None}}{} +Runs an environment script. Same as run\_env\_script, but with a +script path as parameter. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{str} (\emph{script\_path}) -- a path to an environment script + +\item {} +\textbf{Logger} (\emph{logger}) -- The logger instance to display messages + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{set() (src.environment.SalomeEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron.set}\pysiglinewithargsret{\bfcode{set}}{\emph{key}, \emph{value}}{} +Set the environment variable ``key'' to value ``value'' +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{str} (\emph{value}) -- the environment variable to set + +\item {} +\textbf{str} -- the value + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{set\_a\_product() (src.environment.SalomeEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron.set_a_product}\pysiglinewithargsret{\bfcode{set\_a\_product}}{\emph{product}, \emph{logger}}{} +Sets the environment of a product. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{str} (\emph{product}) -- The product name + +\item {} +\textbf{Logger} (\emph{logger}) -- The logger instance to display messages + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{set\_application\_env() (src.environment.SalomeEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron.set_application_env}\pysiglinewithargsret{\bfcode{set\_application\_env}}{\emph{logger}}{} +Sets the environment defined in the APPLICATION file. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{Logger} (\emph{logger}) -- The logger instance to display messages + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{set\_cpp\_env() (src.environment.SalomeEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron.set_cpp_env}\pysiglinewithargsret{\bfcode{set\_cpp\_env}}{\emph{product\_info}}{} +Sets the generic environment for a SALOME cpp product. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{Config} (\emph{product\_info}) -- The product description + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{set\_full\_environ() (src.environment.SalomeEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron.set_full_environ}\pysiglinewithargsret{\bfcode{set\_full\_environ}}{\emph{logger}, \emph{env\_info}}{} +Sets the full environment for products +specified in env\_info dictionary. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{Logger} (\emph{logger}) -- The logger instance to display messages + +\item {} +\textbf{list} (\emph{env\_info}) -- the list of products + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{set\_products() (src.environment.SalomeEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron.set_products}\pysiglinewithargsret{\bfcode{set\_products}}{\emph{logger}, \emph{src\_root=None}}{} +Sets the environment for all the products. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{Logger} (\emph{logger}) -- The logger instance to display messages + +\item {} +\textbf{src} (\emph{src\_root}) -- the application working directory + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{set\_python\_libdirs() (src.environment.SalomeEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron.set_python_libdirs}\pysiglinewithargsret{\bfcode{set\_python\_libdirs}}{}{} +Set some generic variables for python library paths + +\end{fulllineitems} + +\index{set\_salome\_generic\_product\_env() (src.environment.SalomeEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron.set_salome_generic_product_env}\pysiglinewithargsret{\bfcode{set\_salome\_generic\_product\_env}}{\emph{pi}}{} +Sets the generic environment for a SALOME product. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{Config} (\emph{pi}) -- The product description + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{set\_salome\_minimal\_product\_env() (src.environment.SalomeEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.environment.SalomeEnviron.set_salome_minimal_product_env}\pysiglinewithargsret{\bfcode{set\_salome\_minimal\_product\_env}}{\emph{product\_info}, \emph{logger}}{} +Sets the minimal environment for a SALOME product. +xxx\_ROOT\_DIR and xxx\_SRC\_DIR +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{Config} (\emph{product\_info}) -- The product description + +\item {} +\textbf{Logger} (\emph{logger}) -- The logger instance to display messages + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + + +\end{fulllineitems} + +\index{Shell (class in src.environment)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.environment.Shell}\pysiglinewithargsret{\strong{class }\code{src.environment.}\bfcode{Shell}}{\emph{name}, \emph{extension}}{} +Definition of a Shell. + +\end{fulllineitems} + +\index{load\_environment() (in module src.environment)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.environment.load_environment}\pysiglinewithargsret{\code{src.environment.}\bfcode{load\_environment}}{\emph{config}, \emph{build}, \emph{logger}}{} +Loads the environment (used to run the tests, for example). +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{Config} (\emph{config}) -- the global config + +\item {} +\textbf{bool} (\emph{build}) -- build environement if True + +\item {} +\textbf{Logger} (\emph{logger}) -- The logger instance to display messages + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + + + +\subsubsection{\texttt{fileEnviron} Module} +\label{commands/apidoc/src:fileenviron-module}\label{commands/apidoc/src:module-src.fileEnviron}\index{src.fileEnviron (module)}\index{BashFileEnviron (class in src.fileEnviron)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fileEnviron.BashFileEnviron}\pysiglinewithargsret{\strong{class }\code{src.fileEnviron.}\bfcode{BashFileEnviron}}{\emph{output}, \emph{environ=None}}{} +Bases: {\hyperref[commands/apidoc/src:src.fileEnviron.FileEnviron]{\code{src.fileEnviron.FileEnviron}}} + +Class for bash shell. +\index{command\_value() (src.fileEnviron.BashFileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fileEnviron.BashFileEnviron.command_value}\pysiglinewithargsret{\bfcode{command\_value}}{\emph{key}, \emph{command}}{} +Get the value given by the system command ``command'' +and put it in the environment variable key. +Has to be overwritten in the derived classes +This can be seen as a virtual method +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{str} (\emph{command}) -- the environment variable + +\item {} +\textbf{str} -- the command to execute + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{finish() (src.fileEnviron.BashFileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fileEnviron.BashFileEnviron.finish}\pysiglinewithargsret{\bfcode{finish}}{\emph{required=True}}{} +Add a final instruction in the out file (in case of file generation) +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{bool} (\emph{required}) -- Do nothing if required is False + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{set() (src.fileEnviron.BashFileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fileEnviron.BashFileEnviron.set}\pysiglinewithargsret{\bfcode{set}}{\emph{key}, \emph{value}}{} +Set the environment variable ``key'' to value ``value'' +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{str} (\emph{value}) -- the environment variable to set + +\item {} +\textbf{str} -- the value + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + + +\end{fulllineitems} + +\index{BatFileEnviron (class in src.fileEnviron)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fileEnviron.BatFileEnviron}\pysiglinewithargsret{\strong{class }\code{src.fileEnviron.}\bfcode{BatFileEnviron}}{\emph{output}, \emph{environ=None}}{} +Bases: {\hyperref[commands/apidoc/src:src.fileEnviron.FileEnviron]{\code{src.fileEnviron.FileEnviron}}} + +for Windows batch shell. +\index{add\_comment() (src.fileEnviron.BatFileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fileEnviron.BatFileEnviron.add_comment}\pysiglinewithargsret{\bfcode{add\_comment}}{\emph{comment}}{} +Add a comment in the shell file +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{str} (\emph{comment}) -- the comment to add + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{command\_value() (src.fileEnviron.BatFileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fileEnviron.BatFileEnviron.command_value}\pysiglinewithargsret{\bfcode{command\_value}}{\emph{key}, \emph{command}}{} +Get the value given by the system command ``command'' +and put it in the environment variable key. +Has to be overwritten in the derived classes +This can be seen as a virtual method +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{str} (\emph{command}) -- the environment variable + +\item {} +\textbf{str} -- the command to execute + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{finish() (src.fileEnviron.BatFileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fileEnviron.BatFileEnviron.finish}\pysiglinewithargsret{\bfcode{finish}}{\emph{required=True}}{} +Add a final instruction in the out file (in case of file generation) +In the particular windows case, do nothing +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{bool} (\emph{required}) -- Do nothing if required is False + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{get() (src.fileEnviron.BatFileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fileEnviron.BatFileEnviron.get}\pysiglinewithargsret{\bfcode{get}}{\emph{key}}{} +Get the value of the environment variable ``key'' +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{str} (\emph{key}) -- the environment variable + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{set() (src.fileEnviron.BatFileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fileEnviron.BatFileEnviron.set}\pysiglinewithargsret{\bfcode{set}}{\emph{key}, \emph{value}}{} +Set the environment variable ``key'' to value ``value'' +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{str} (\emph{value}) -- the environment variable to set + +\item {} +\textbf{str} -- the value + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + + +\end{fulllineitems} + +\index{ContextFileEnviron (class in src.fileEnviron)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fileEnviron.ContextFileEnviron}\pysiglinewithargsret{\strong{class }\code{src.fileEnviron.}\bfcode{ContextFileEnviron}}{\emph{output}, \emph{environ=None}}{} +Bases: {\hyperref[commands/apidoc/src:src.fileEnviron.FileEnviron]{\code{src.fileEnviron.FileEnviron}}} + +Class for a salome context configuration file. +\index{add\_echo() (src.fileEnviron.ContextFileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.add_echo}\pysiglinewithargsret{\bfcode{add\_echo}}{\emph{text}}{} +Add a comment +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{str} (\emph{text}) -- the comment to add + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{add\_warning() (src.fileEnviron.ContextFileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.add_warning}\pysiglinewithargsret{\bfcode{add\_warning}}{\emph{warning}}{} +Add a warning +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{str} (\emph{text}) -- the warning to add + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{append\_value() (src.fileEnviron.ContextFileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.append_value}\pysiglinewithargsret{\bfcode{append\_value}}{\emph{key}, \emph{value}, \emph{sep=':'}}{} +append value to key using sep +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{str} (\emph{sep}) -- the environment variable to append + +\item {} +\textbf{str} -- the value to append to key + +\item {} +\textbf{str} -- the separator string + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{command\_value() (src.fileEnviron.ContextFileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.command_value}\pysiglinewithargsret{\bfcode{command\_value}}{\emph{key}, \emph{command}}{} +Get the value given by the system command ``command'' +and put it in the environment variable key. +Has to be overwritten in the derived classes +This can be seen as a virtual method +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{str} (\emph{command}) -- the environment variable + +\item {} +\textbf{str} -- the command to execute + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{finish() (src.fileEnviron.ContextFileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.finish}\pysiglinewithargsret{\bfcode{finish}}{\emph{required=True}}{} +Add a final instruction in the out file (in case of file generation) +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{bool} (\emph{required}) -- Do nothing if required is False + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{get() (src.fileEnviron.ContextFileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.get}\pysiglinewithargsret{\bfcode{get}}{\emph{key}}{} +Get the value of the environment variable ``key'' +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{str} (\emph{key}) -- the environment variable + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{prepend\_value() (src.fileEnviron.ContextFileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.prepend_value}\pysiglinewithargsret{\bfcode{prepend\_value}}{\emph{key}, \emph{value}, \emph{sep=':'}}{} +prepend value to key using sep +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{str} (\emph{sep}) -- the environment variable to prepend + +\item {} +\textbf{str} -- the value to prepend to key + +\item {} +\textbf{str} -- the separator string + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{set() (src.fileEnviron.ContextFileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.set}\pysiglinewithargsret{\bfcode{set}}{\emph{key}, \emph{value}}{} +Set the environment variable ``key'' to value ``value'' +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{str} (\emph{value}) -- the environment variable to set + +\item {} +\textbf{str} -- the value + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + + +\end{fulllineitems} + +\index{FileEnviron (class in src.fileEnviron)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fileEnviron.FileEnviron}\pysiglinewithargsret{\strong{class }\code{src.fileEnviron.}\bfcode{FileEnviron}}{\emph{output}, \emph{environ=None}}{} +Bases: \code{object} + +Base class for shell environment +\index{add\_comment() (src.fileEnviron.FileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fileEnviron.FileEnviron.add_comment}\pysiglinewithargsret{\bfcode{add\_comment}}{\emph{comment}}{} +Add a comment in the shell file +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{str} (\emph{comment}) -- the comment to add + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{add\_echo() (src.fileEnviron.FileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fileEnviron.FileEnviron.add_echo}\pysiglinewithargsret{\bfcode{add\_echo}}{\emph{text}}{} +Add a ``echo'' in the shell file +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{str} (\emph{text}) -- the text to echo + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{add\_line() (src.fileEnviron.FileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fileEnviron.FileEnviron.add_line}\pysiglinewithargsret{\bfcode{add\_line}}{\emph{number}}{} +Add some empty lines in the shell file +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{int} (\emph{number}) -- the number of lines to add + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{add\_warning() (src.fileEnviron.FileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fileEnviron.FileEnviron.add_warning}\pysiglinewithargsret{\bfcode{add\_warning}}{\emph{warning}}{} +Add a warning ``echo'' in the shell file +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{str} (\emph{warning}) -- the text to echo + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{append() (src.fileEnviron.FileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fileEnviron.FileEnviron.append}\pysiglinewithargsret{\bfcode{append}}{\emph{key}, \emph{value}, \emph{sep=':'}}{} +Same as append\_value but the value argument can be a list +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{str} (\emph{sep}) -- the environment variable to append + +\item {} +\textbf{str or list} (\emph{value}) -- the value(s) to append to key + +\item {} +\textbf{str} -- the separator string + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{append\_value() (src.fileEnviron.FileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fileEnviron.FileEnviron.append_value}\pysiglinewithargsret{\bfcode{append\_value}}{\emph{key}, \emph{value}, \emph{sep=':'}}{} +append value to key using sep +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{str} (\emph{sep}) -- the environment variable to append + +\item {} +\textbf{str} -- the value to append to key + +\item {} +\textbf{str} -- the separator string + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{command\_value() (src.fileEnviron.FileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fileEnviron.FileEnviron.command_value}\pysiglinewithargsret{\bfcode{command\_value}}{\emph{key}, \emph{command}}{} +Get the value given by the system command ``command'' +and put it in the environment variable key. +Has to be overwritten in the derived classes +This can be seen as a virtual method +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{str} (\emph{command}) -- the environment variable + +\item {} +\textbf{str} -- the command to execute + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{finish() (src.fileEnviron.FileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fileEnviron.FileEnviron.finish}\pysiglinewithargsret{\bfcode{finish}}{\emph{required=True}}{} +Add a final instruction in the out file (in case of file generation) +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{bool} (\emph{required}) -- Do nothing if required is False + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{get() (src.fileEnviron.FileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fileEnviron.FileEnviron.get}\pysiglinewithargsret{\bfcode{get}}{\emph{key}}{} +Get the value of the environment variable ``key'' +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{str} (\emph{key}) -- the environment variable + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{is\_defined() (src.fileEnviron.FileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fileEnviron.FileEnviron.is_defined}\pysiglinewithargsret{\bfcode{is\_defined}}{\emph{key}}{} +Check if the key exists in the environment +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{str} (\emph{key}) -- the environment variable to check + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{prepend() (src.fileEnviron.FileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fileEnviron.FileEnviron.prepend}\pysiglinewithargsret{\bfcode{prepend}}{\emph{key}, \emph{value}, \emph{sep=':'}}{} +Same as prepend\_value but the value argument can be a list +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{str} (\emph{sep}) -- the environment variable to prepend + +\item {} +\textbf{str or list} (\emph{value}) -- the value(s) to prepend to key + +\item {} +\textbf{str} -- the separator string + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{prepend\_value() (src.fileEnviron.FileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fileEnviron.FileEnviron.prepend_value}\pysiglinewithargsret{\bfcode{prepend\_value}}{\emph{key}, \emph{value}, \emph{sep=':'}}{} +prepend value to key using sep +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{str} (\emph{sep}) -- the environment variable to prepend + +\item {} +\textbf{str} -- the value to prepend to key + +\item {} +\textbf{str} -- the separator string + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{set() (src.fileEnviron.FileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fileEnviron.FileEnviron.set}\pysiglinewithargsret{\bfcode{set}}{\emph{key}, \emph{value}}{} +Set the environment variable `key' to value `value' +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{str} (\emph{value}) -- the environment variable to set + +\item {} +\textbf{str} -- the value + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + + +\end{fulllineitems} + +\index{LauncherFileEnviron (class in src.fileEnviron)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron}\pysiglinewithargsret{\strong{class }\code{src.fileEnviron.}\bfcode{LauncherFileEnviron}}{\emph{output}, \emph{environ=None}}{} +Class to generate a launcher file script +(in python syntax) SalomeContext API +\index{add() (src.fileEnviron.LauncherFileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add}\pysiglinewithargsret{\bfcode{add}}{\emph{key}, \emph{value}}{} +prepend value to key using sep +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{str} (\emph{value}) -- the environment variable to prepend + +\item {} +\textbf{str} -- the value to prepend to key + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{add\_comment() (src.fileEnviron.LauncherFileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add_comment}\pysiglinewithargsret{\bfcode{add\_comment}}{\emph{comment}}{} +\end{fulllineitems} + +\index{add\_echo() (src.fileEnviron.LauncherFileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add_echo}\pysiglinewithargsret{\bfcode{add\_echo}}{\emph{text}}{} +Add a comment +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{str} (\emph{text}) -- the comment to add + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{add\_line() (src.fileEnviron.LauncherFileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add_line}\pysiglinewithargsret{\bfcode{add\_line}}{\emph{number}}{} +Add some empty lines in the launcher file +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{int} (\emph{number}) -- the number of lines to add + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{add\_warning() (src.fileEnviron.LauncherFileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add_warning}\pysiglinewithargsret{\bfcode{add\_warning}}{\emph{warning}}{} +Add a warning +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{str} (\emph{text}) -- the warning to add + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{append() (src.fileEnviron.LauncherFileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.append}\pysiglinewithargsret{\bfcode{append}}{\emph{key}, \emph{value}, \emph{sep=':'}}{} +Same as append\_value but the value argument can be a list +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{str} (\emph{sep}) -- the environment variable to append + +\item {} +\textbf{str or list} (\emph{value}) -- the value(s) to append to key + +\item {} +\textbf{str} -- the separator string + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{append\_value() (src.fileEnviron.LauncherFileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.append_value}\pysiglinewithargsret{\bfcode{append\_value}}{\emph{key}, \emph{value}, \emph{sep=':'}}{} +append value to key using sep +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{str} (\emph{sep}) -- the environment variable to append + +\item {} +\textbf{str} -- the value to append to key + +\item {} +\textbf{str} -- the separator string + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{change\_to\_launcher() (src.fileEnviron.LauncherFileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.change_to_launcher}\pysiglinewithargsret{\bfcode{change\_to\_launcher}}{\emph{value}}{} +\end{fulllineitems} + +\index{command\_value() (src.fileEnviron.LauncherFileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.command_value}\pysiglinewithargsret{\bfcode{command\_value}}{\emph{key}, \emph{command}}{} +Get the value given by the system command ``command'' +and put it in the environment variable key. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{str} (\emph{command}) -- the environment variable + +\item {} +\textbf{str} -- the command to execute + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{finish() (src.fileEnviron.LauncherFileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.finish}\pysiglinewithargsret{\bfcode{finish}}{\emph{required=True}}{} +Add a final instruction in the out file (in case of file generation) +In the particular launcher case, do nothing +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{bool} (\emph{required}) -- Do nothing if required is False + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{get() (src.fileEnviron.LauncherFileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.get}\pysiglinewithargsret{\bfcode{get}}{\emph{key}}{} +Get the value of the environment variable ``key'' +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{str} (\emph{key}) -- the environment variable + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{is\_defined() (src.fileEnviron.LauncherFileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.is_defined}\pysiglinewithargsret{\bfcode{is\_defined}}{\emph{key}}{} +Check if the key exists in the environment +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{str} (\emph{key}) -- the environment variable to check + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{prepend() (src.fileEnviron.LauncherFileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.prepend}\pysiglinewithargsret{\bfcode{prepend}}{\emph{key}, \emph{value}, \emph{sep=':'}}{} +Same as prepend\_value but the value argument can be a list +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{str} (\emph{sep}) -- the environment variable to prepend + +\item {} +\textbf{str or list} (\emph{value}) -- the value(s) to prepend to key + +\item {} +\textbf{str} -- the separator string + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{prepend\_value() (src.fileEnviron.LauncherFileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.prepend_value}\pysiglinewithargsret{\bfcode{prepend\_value}}{\emph{key}, \emph{value}, \emph{sep=':'}}{} +prepend value to key using sep +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{str} (\emph{sep}) -- the environment variable to prepend + +\item {} +\textbf{str} -- the value to prepend to key + +\item {} +\textbf{str} -- the separator string + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{set() (src.fileEnviron.LauncherFileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.set}\pysiglinewithargsret{\bfcode{set}}{\emph{key}, \emph{value}}{} +Set the environment variable ``key'' to value ``value'' +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{str} (\emph{value}) -- the environment variable to set + +\item {} +\textbf{str} -- the value + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + + +\end{fulllineitems} + +\index{ScreenEnviron (class in src.fileEnviron)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fileEnviron.ScreenEnviron}\pysiglinewithargsret{\strong{class }\code{src.fileEnviron.}\bfcode{ScreenEnviron}}{\emph{output}, \emph{environ=None}}{} +Bases: {\hyperref[commands/apidoc/src:src.fileEnviron.FileEnviron]{\code{src.fileEnviron.FileEnviron}}} +\index{add\_comment() (src.fileEnviron.ScreenEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fileEnviron.ScreenEnviron.add_comment}\pysiglinewithargsret{\bfcode{add\_comment}}{\emph{comment}}{} +\end{fulllineitems} + +\index{add\_echo() (src.fileEnviron.ScreenEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fileEnviron.ScreenEnviron.add_echo}\pysiglinewithargsret{\bfcode{add\_echo}}{\emph{text}}{} +\end{fulllineitems} + +\index{add\_line() (src.fileEnviron.ScreenEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fileEnviron.ScreenEnviron.add_line}\pysiglinewithargsret{\bfcode{add\_line}}{\emph{number}}{} +\end{fulllineitems} + +\index{add\_warning() (src.fileEnviron.ScreenEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fileEnviron.ScreenEnviron.add_warning}\pysiglinewithargsret{\bfcode{add\_warning}}{\emph{warning}}{} +\end{fulllineitems} + +\index{append() (src.fileEnviron.ScreenEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fileEnviron.ScreenEnviron.append}\pysiglinewithargsret{\bfcode{append}}{\emph{name}, \emph{value}, \emph{sep=':'}}{} +\end{fulllineitems} + +\index{command\_value() (src.fileEnviron.ScreenEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fileEnviron.ScreenEnviron.command_value}\pysiglinewithargsret{\bfcode{command\_value}}{\emph{key}, \emph{command}}{} +\end{fulllineitems} + +\index{get() (src.fileEnviron.ScreenEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fileEnviron.ScreenEnviron.get}\pysiglinewithargsret{\bfcode{get}}{\emph{name}}{} +\end{fulllineitems} + +\index{is\_defined() (src.fileEnviron.ScreenEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fileEnviron.ScreenEnviron.is_defined}\pysiglinewithargsret{\bfcode{is\_defined}}{\emph{name}}{} +\end{fulllineitems} + +\index{prepend() (src.fileEnviron.ScreenEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fileEnviron.ScreenEnviron.prepend}\pysiglinewithargsret{\bfcode{prepend}}{\emph{name}, \emph{value}, \emph{sep=':'}}{} +\end{fulllineitems} + +\index{run\_env\_script() (src.fileEnviron.ScreenEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fileEnviron.ScreenEnviron.run_env_script}\pysiglinewithargsret{\bfcode{run\_env\_script}}{\emph{module}, \emph{script}}{} +\end{fulllineitems} + +\index{set() (src.fileEnviron.ScreenEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fileEnviron.ScreenEnviron.set}\pysiglinewithargsret{\bfcode{set}}{\emph{name}, \emph{value}}{} +\end{fulllineitems} + +\index{write() (src.fileEnviron.ScreenEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fileEnviron.ScreenEnviron.write}\pysiglinewithargsret{\bfcode{write}}{\emph{command}, \emph{name}, \emph{value}, \emph{sign='='}}{} +\end{fulllineitems} + + +\end{fulllineitems} + +\index{get\_file\_environ() (in module src.fileEnviron)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fileEnviron.get_file_environ}\pysiglinewithargsret{\code{src.fileEnviron.}\bfcode{get\_file\_environ}}{\emph{output}, \emph{shell}, \emph{environ=None}}{} +Instantiate correct FileEnvironment sub-class. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{file} (\emph{output}) -- the output file stream. + +\item {} +\textbf{str} (\emph{shell}) -- the type of shell syntax to use. + +\item {} +\textbf{dict} (\emph{environ}) -- a potential additional environment. + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{special\_path\_separator() (in module src.fileEnviron)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fileEnviron.special_path_separator}\pysiglinewithargsret{\code{src.fileEnviron.}\bfcode{special\_path\_separator}}{\emph{name}}{} +TCLLIBPATH, TKLIBPATH, PV\_PLUGIN\_PATH environments variables need +some exotic path separator. +This function gives the separator regarding the name of the variable +to append or prepend. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{str} (\emph{name}) -- The name of the variable to find the separator + +\end{description}\end{quote} + +\end{fulllineitems} + + + +\subsubsection{\texttt{fork} Module} +\label{commands/apidoc/src:fork-module}\label{commands/apidoc/src:module-src.fork}\index{src.fork (module)}\index{batch() (in module src.fork)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fork.batch}\pysiglinewithargsret{\code{src.fork.}\bfcode{batch}}{\emph{cmd}, \emph{logger}, \emph{cwd}, \emph{args=}\optional{}, \emph{log=None}, \emph{delai=20}, \emph{sommeil=1}}{} +\end{fulllineitems} + +\index{batch\_salome() (in module src.fork)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fork.batch_salome}\pysiglinewithargsret{\code{src.fork.}\bfcode{batch\_salome}}{\emph{cmd}, \emph{logger}, \emph{cwd}, \emph{args}, \emph{getTmpDir}, \emph{pendant='SALOME\_Session\_Server'}, \emph{fin='killSalome.py'}, \emph{log=None}, \emph{delai=20}, \emph{sommeil=1}, \emph{delaiapp=0}}{} +\end{fulllineitems} + +\index{launch\_command() (in module src.fork)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fork.launch_command}\pysiglinewithargsret{\code{src.fork.}\bfcode{launch\_command}}{\emph{cmd}, \emph{logger}, \emph{cwd}, \emph{args=}\optional{}, \emph{log=None}}{} +\end{fulllineitems} + +\index{show\_progress() (in module src.fork)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fork.show_progress}\pysiglinewithargsret{\code{src.fork.}\bfcode{show\_progress}}{\emph{logger}, \emph{top}, \emph{delai}, \emph{ss='`}}{} +shortcut function to display the progression +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{Logger} (\emph{logger}) -- The logging instance + +\item {} +\textbf{int} (\emph{delai}) -- the number to display + +\item {} +\textbf{int} -- the number max + +\item {} +\textbf{str} (\emph{ss}) -- the string to display + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{write\_back() (in module src.fork)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.fork.write_back}\pysiglinewithargsret{\code{src.fork.}\bfcode{write\_back}}{\emph{logger}, \emph{message}, \emph{level}}{} +shortcut function to write at the begin of the line +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{Logger} (\emph{logger}) -- The logging instance + +\item {} +\textbf{str} (\emph{message}) -- the text to display + +\item {} +\textbf{int} (\emph{level}) -- the level of verbosity + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + + + +\subsubsection{\texttt{logger} Module} +\label{commands/apidoc/src:logger-module}\label{commands/apidoc/src:module-src.logger}\index{src.logger (module)} +Implements the classes and method relative to the logging +\index{Logger (class in src.logger)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.logger.Logger}\pysiglinewithargsret{\strong{class }\code{src.logger.}\bfcode{Logger}}{\emph{config}, \emph{silent\_sysstd=False}, \emph{all\_in\_terminal=False}, \emph{micro\_command=False}}{} +Bases: \code{object} + +Class to handle log mechanism. +\index{add\_link() (src.logger.Logger method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.logger.Logger.add_link}\pysiglinewithargsret{\bfcode{add\_link}}{\emph{log\_file\_name}, \emph{command\_name}, \emph{command\_res}, \emph{full\_launched\_command}}{} +Add a link to another log file. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{str} (\emph{command\_res}) -- The file name of the link. + +\item {} +\textbf{str} -- The name of the command linked. + +\item {} +\textbf{str} -- The result of the command linked. ``0'' or ``1'' + +\end{itemize} + +\item[{Parma full\_launched\_command str}] \leavevmode +The full lanch command +(``sat command ...'') + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{end\_write() (src.logger.Logger method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.logger.Logger.end_write}\pysiglinewithargsret{\bfcode{end\_write}}{\emph{attribute}}{} +Called just after command end: Put all fields +corresponding to the command end context (time). +Write the log xml file on the hard drive. +And display the command to launch to get the log +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{dict} (\emph{attribute}) -- the attribute to add to the node ``Site''. + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{error() (src.logger.Logger method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.logger.Logger.error}\pysiglinewithargsret{\bfcode{error}}{\emph{message}}{} +Print an error. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{str} (\emph{message}) -- The message to print. + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{flush() (src.logger.Logger method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.logger.Logger.flush}\pysiglinewithargsret{\bfcode{flush}}{}{} +Flush terminal + +\end{fulllineitems} + +\index{put\_initial\_xml\_fields() (src.logger.Logger method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.logger.Logger.put_initial_xml_fields}\pysiglinewithargsret{\bfcode{put\_initial\_xml\_fields}}{}{} +Called at class initialization: Put all fields +corresponding to the command context (user, time, ...) + +\end{fulllineitems} + +\index{write() (src.logger.Logger method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.logger.Logger.write}\pysiglinewithargsret{\bfcode{write}}{\emph{message}, \emph{level=None}, \emph{screenOnly=False}}{} +function used in the commands +to print in the terminal and the log file. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{str} (\emph{message}) -- The message to print. + +\item {} +\textbf{int} (\emph{level}) -- The output level corresponding +to the message 0 \textless{} level \textless{} 6. + +\item {} +\textbf{boolean} (\emph{screenOnly}) -- if True, do not write in log file. + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + + +\end{fulllineitems} + +\index{date\_to\_datetime() (in module src.logger)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.logger.date_to_datetime}\pysiglinewithargsret{\code{src.logger.}\bfcode{date\_to\_datetime}}{\emph{date}}{} +From a string date in format YYYYMMDD\_HHMMSS +returns list year, mon, day, hour, minutes, seconds +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{str} (\emph{date}) -- The date in format YYYYMMDD\_HHMMSS + +\item[{Returns}] \leavevmode +the same date and time in separate variables. + +\item[{Return type}] \leavevmode +(str,str,str,str,str,str) + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{list\_log\_file() (in module src.logger)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.logger.list_log_file}\pysiglinewithargsret{\code{src.logger.}\bfcode{list\_log\_file}}{\emph{dirPath}, \emph{expression}}{} +Find all files corresponding to expression in dirPath +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{str} (\emph{expression}) -- the directory where to search the files + +\item {} +\textbf{str} -- the regular expression of files to find + +\end{itemize} + +\item[{Returns}] \leavevmode +the list of files path and informations about it + +\item[{Return type}] \leavevmode +list + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{show\_command\_log() (in module src.logger)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.logger.show_command_log}\pysiglinewithargsret{\code{src.logger.}\bfcode{show\_command\_log}}{\emph{logFilePath}, \emph{cmd}, \emph{application}, \emph{notShownCommands}}{} +Used in updateHatXml. +Determine if the log xml file logFilePath +has to be shown or not in the hat log. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{str} (\emph{application}) -- the path to the command xml log file + +\item {} +\textbf{str} -- the command of the log file + +\item {} +\textbf{str} -- the application passed as parameter +to the salomeTools command + +\item {} +\textbf{list} (\emph{notShownCommands}) -- the list of commands +that are not shown by default + +\end{itemize} + +\item[{Returns}] \leavevmode +True if cmd is not in notShownCommands and the application +in the log file corresponds to application + +\item[{Return type}] \leavevmode +boolean + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{timedelta\_total\_seconds() (in module src.logger)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.logger.timedelta_total_seconds}\pysiglinewithargsret{\code{src.logger.}\bfcode{timedelta\_total\_seconds}}{\emph{timedelta}}{} +Replace total\_seconds from datetime module +in order to be compatible with old python versions +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{datetime.timedelta} (\emph{timedelta}) -- The delta between two dates + +\item[{Returns}] \leavevmode +The number of seconds corresponding to timedelta. + +\item[{Return type}] \leavevmode +float + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{update\_hat\_xml() (in module src.logger)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.logger.update_hat_xml}\pysiglinewithargsret{\code{src.logger.}\bfcode{update\_hat\_xml}}{\emph{logDir}, \emph{application=None}, \emph{notShownCommands=}\optional{}}{} +Create the xml file in logDir that contain all the xml file +and have a name like YYYYMMDD\_HHMMSS\_namecmd.xml +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{str} (\emph{application}) -- the directory to parse + +\item {} +\textbf{str} -- the name of the application if there is any + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + + + +\subsubsection{\texttt{options} Module} +\label{commands/apidoc/src:module-src.options}\label{commands/apidoc/src:options-module}\index{src.options (module)} +The Options class that manages the access to all options passed as +parameters in salomeTools command lines +\index{OptResult (class in src.options)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.options.OptResult}\pysigline{\strong{class }\code{src.options.}\bfcode{OptResult}} +Bases: \code{object} + +An instance of this class will be the object manipulated +in code of all salomeTools commands +The aim of this class is to have an elegant syntax +to manipulate the options. +ex: +print(options.level) +5 + +\end{fulllineitems} + +\index{Options (class in src.options)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.options.Options}\pysigline{\strong{class }\code{src.options.}\bfcode{Options}} +Class to manage all salomeTools options +\index{add\_option() (src.options.Options method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.options.Options.add_option}\pysiglinewithargsret{\bfcode{add\_option}}{\emph{shortName}, \emph{longName}, \emph{optionType}, \emph{destName}, \emph{helpString='`}, \emph{default=None}}{} +Method to add an option to a command. It gets all attributes +of an option and append it in the options field +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{str} (\emph{helpString}) -- The short name of the option +(ex ``l'' for level option). + +\item {} +\textbf{str} -- The long name of the option +(ex ``level'' for level option). + +\item {} +\textbf{str} -- The type of the option (ex ``int''). + +\item {} +\textbf{str} -- The name that will be used in the code. + +\item {} +\textbf{str} -- The text to display +when user ask for help on a command. + +\end{itemize} + +\item[{Returns}] \leavevmode +Nothing. + +\item[{Return type}] \leavevmode +NA + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{parse\_args() (src.options.Options method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.options.Options.parse_args}\pysiglinewithargsret{\bfcode{parse\_args}}{\emph{argList=None}}{} +Method that instantiates the class OptResult +that gives access to all options in the code +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{list} (\emph{argList}) -- the raw list of arguments that were passed + +\item[{Returns}] \leavevmode +optResult, args : optResult is the option instance +to manipulate in the code. args +is the full raw list of passed options + +\item[{Return type}] \leavevmode +(class `common.options.OptResult',list) + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{print\_help() (src.options.Options method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.options.Options.print_help}\pysiglinewithargsret{\bfcode{print\_help}}{}{} +Method that display all options stored in self.options and there help +\begin{quote}\begin{description} +\item[{Returns}] \leavevmode +Nothing. + +\item[{Return type}] \leavevmode +NA + +\end{description}\end{quote} + +\end{fulllineitems} + + +\end{fulllineitems} + + + +\subsubsection{\texttt{printcolors} Module} +\label{commands/apidoc/src:printcolors-module}\label{commands/apidoc/src:module-src.printcolors}\index{src.printcolors (module)} +In this file is stored the mechanism that manage color prints in the terminal +\index{cleancolor() (in module src.printcolors)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.printcolors.cleancolor}\pysiglinewithargsret{\code{src.printcolors.}\bfcode{cleancolor}}{\emph{message}}{} +remove color from a colored text. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{str} (\emph{message}) -- The text to be cleaned. + +\item[{Returns}] \leavevmode +The cleaned text. + +\item[{Return type}] \leavevmode +str + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{print\_color\_map() (in module src.printcolors)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.printcolors.print_color_map}\pysiglinewithargsret{\code{src.printcolors.}\bfcode{print\_color\_map}}{}{} +This method prints the color map + +\end{fulllineitems} + +\index{print\_color\_range() (in module src.printcolors)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.printcolors.print_color_range}\pysiglinewithargsret{\code{src.printcolors.}\bfcode{print\_color\_range}}{\emph{start}, \emph{end}}{} +print possible range values for colors +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{int} (\emph{end}) -- The smaller value. + +\item {} +\textbf{int} -- The bigger value. + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{print\_value() (in module src.printcolors)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.printcolors.print_value}\pysiglinewithargsret{\code{src.printcolors.}\bfcode{print\_value}}{\emph{logger}, \emph{label}, \emph{value}, \emph{level=1}, \emph{suffix='`}}{} +shortcut method to print a label and a value with the info color +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{class logger} (\emph{logger}) -- the logger instance. + +\item {} +\textbf{int} (\emph{level}) -- the label to print. + +\item {} +\textbf{str} (\emph{suffix}) -- the value to print. + +\item {} +\textbf{int} -- the level of verboseness. + +\item {} +\textbf{str} -- the suffix to add at the end. + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{printc() (in module src.printcolors)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.printcolors.printc}\pysiglinewithargsret{\code{src.printcolors.}\bfcode{printc}}{\emph{txt}, \emph{code='`}}{} +print a text with colors +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{str} (\emph{code}) -- The text to be printed. + +\item {} +\textbf{str} -- The color to use. + +\end{itemize} + +\item[{Returns}] \leavevmode +The colored text. + +\item[{Return type}] \leavevmode +str + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{printcError() (in module src.printcolors)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.printcolors.printcError}\pysiglinewithargsret{\code{src.printcolors.}\bfcode{printcError}}{\emph{txt}}{} +print a text error color +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{str} (\emph{txt}) -- The text to be printed. + +\item[{Returns}] \leavevmode +The colored text. + +\item[{Return type}] \leavevmode +str + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{printcHeader() (in module src.printcolors)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.printcolors.printcHeader}\pysiglinewithargsret{\code{src.printcolors.}\bfcode{printcHeader}}{\emph{txt}}{} +print a text header color +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{str} (\emph{txt}) -- The text to be printed. + +\item[{Returns}] \leavevmode +The colored text. + +\item[{Return type}] \leavevmode +str + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{printcHighlight() (in module src.printcolors)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.printcolors.printcHighlight}\pysiglinewithargsret{\code{src.printcolors.}\bfcode{printcHighlight}}{\emph{txt}}{} +print a text highlight color +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{str} (\emph{txt}) -- The text to be printed. + +\item[{Returns}] \leavevmode +The colored text. + +\item[{Return type}] \leavevmode +str + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{printcInfo() (in module src.printcolors)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.printcolors.printcInfo}\pysiglinewithargsret{\code{src.printcolors.}\bfcode{printcInfo}}{\emph{txt}}{} +print a text info color +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{str} (\emph{txt}) -- The text to be printed. + +\item[{Returns}] \leavevmode +The colored text. + +\item[{Return type}] \leavevmode +str + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{printcLabel() (in module src.printcolors)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.printcolors.printcLabel}\pysiglinewithargsret{\code{src.printcolors.}\bfcode{printcLabel}}{\emph{txt}}{} +print a text label color +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{str} (\emph{txt}) -- The text to be printed. + +\item[{Returns}] \leavevmode +The colored text. + +\item[{Return type}] \leavevmode +str + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{printcSuccess() (in module src.printcolors)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.printcolors.printcSuccess}\pysiglinewithargsret{\code{src.printcolors.}\bfcode{printcSuccess}}{\emph{txt}}{} +print a text success color +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{str} (\emph{txt}) -- The text to be printed. + +\item[{Returns}] \leavevmode +The colored text. + +\item[{Return type}] \leavevmode +str + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{printcWarning() (in module src.printcolors)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.printcolors.printcWarning}\pysiglinewithargsret{\code{src.printcolors.}\bfcode{printcWarning}}{\emph{txt}}{} +print a text warning color +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{str} (\emph{txt}) -- The text to be printed. + +\item[{Returns}] \leavevmode +The colored text. + +\item[{Return type}] \leavevmode +str + +\end{description}\end{quote} + +\end{fulllineitems} + + + +\subsubsection{\texttt{product} Module} +\label{commands/apidoc/src:module-src.product}\label{commands/apidoc/src:product-module}\index{src.product (module)} +In this file are implemented the methods +relative to the product notion of salomeTools +\index{check\_config\_exists() (in module src.product)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.product.check_config_exists}\pysiglinewithargsret{\code{src.product.}\bfcode{check\_config\_exists}}{\emph{config}, \emph{prod\_dir}, \emph{prod\_info}}{} +Verify that the installation directory of a product in a base exists +Check all the config-\textless{}i\textgreater{} directory and verify the sat-config.pyconf file +that is in it +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{Config} (\emph{product\_info}) -- The global configuration + +\item {} +\textbf{str} (\emph{prod\_dir}) -- The product installation directory path +(without config-\textless{}i\textgreater{}) + +\item {} +\textbf{Config} -- The configuration specific to +the product + +\end{itemize} + +\item[{Returns}] \leavevmode +True or false is the installation is found or not +and if it is found, the path of the found installation + +\item[{Return type}] \leavevmode +(boolean, str) + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{check\_installation() (in module src.product)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.product.check_installation}\pysiglinewithargsret{\code{src.product.}\bfcode{check\_installation}}{\emph{product\_info}}{} +Verify if a product is well installed. Checks install directory presence +and some additional files if it is defined in the config +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{Config} (\emph{product\_info}) -- The configuration specific to +the product + +\item[{Returns}] \leavevmode +True if it is well installed + +\item[{Return type}] \leavevmode +boolean + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{check\_source() (in module src.product)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.product.check_source}\pysiglinewithargsret{\code{src.product.}\bfcode{check\_source}}{\emph{product\_info}}{} +Verify if a sources of product is preset. Checks source directory presence +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{Config} (\emph{product\_info}) -- The configuration specific to +the product + +\item[{Returns}] \leavevmode +True if it is well installed + +\item[{Return type}] \leavevmode +boolean + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{get\_base\_install\_dir() (in module src.product)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.product.get_base_install_dir}\pysiglinewithargsret{\code{src.product.}\bfcode{get\_base\_install\_dir}}{\emph{config}, \emph{prod\_info}, \emph{version}}{} +Compute the installation directory of a product in base +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{Config} (\emph{product\_info}) -- The global configuration + +\item {} +\textbf{Config} -- The configuration specific to +the product + +\item {} +\textbf{str} (\emph{version}) -- The version of the product + +\end{itemize} + +\item[{Returns}] \leavevmode +The path of the product installation + +\item[{Return type}] \leavevmode +str + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{get\_install\_dir() (in module src.product)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.product.get_install_dir}\pysiglinewithargsret{\code{src.product.}\bfcode{get\_install\_dir}}{\emph{config}, \emph{base}, \emph{version}, \emph{prod\_info}}{} +Compute the installation directory of a given product +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{Config} (\emph{product\_info}) -- The global configuration + +\item {} +\textbf{str} (\emph{version}) -- This corresponds to the value given by user in its +application.pyconf for the specific product. If ``yes'', the +user wants the product to be in base. If ``no'', he wants the +product to be in the application workdir + +\item {} +\textbf{str} -- The version of the product + +\item {} +\textbf{Config} -- The configuration specific to +the product + +\end{itemize} + +\item[{Returns}] \leavevmode +The path of the product installation + +\item[{Return type}] \leavevmode +str + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{get\_product\_components() (in module src.product)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.product.get_product_components}\pysiglinewithargsret{\code{src.product.}\bfcode{get\_product\_components}}{\emph{product\_info}}{} +Get the component list to generate with the product +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{Config} (\emph{product\_info}) -- The configuration specific to +the product + +\item[{Returns}] \leavevmode +The list of names of the components + +\item[{Return type}] \leavevmode +List + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{get\_product\_config() (in module src.product)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.product.get_product_config}\pysiglinewithargsret{\code{src.product.}\bfcode{get\_product\_config}}{\emph{config}, \emph{product\_name}, \emph{with\_install\_dir=True}}{} +Get the specific configuration of a product from the global configuration +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{Config} (\emph{config}) -- The global configuration + +\item {} +\textbf{str} (\emph{product\_name}) -- The name of the product + +\item {} +\textbf{boolean} (\emph{with\_install\_dir}) -- If false, do not provide an install +directory (at false only for internal use +of the function check\_config\_exists) + +\end{itemize} + +\item[{Returns}] \leavevmode +the specific configuration of the product + +\item[{Return type}] \leavevmode +Config + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{get\_product\_dependencies() (in module src.product)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.product.get_product_dependencies}\pysiglinewithargsret{\code{src.product.}\bfcode{get\_product\_dependencies}}{\emph{config}, \emph{product\_info}}{} +Get recursively the list of products that are +in the product\_info dependencies +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{Config} (\emph{product\_info}) -- The global configuration + +\item {} +\textbf{Config} -- The configuration specific to +the product + +\end{itemize} + +\item[{Returns}] \leavevmode +the list of products in dependence + +\item[{Return type}] \leavevmode +list + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{get\_product\_section() (in module src.product)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.product.get_product_section}\pysiglinewithargsret{\code{src.product.}\bfcode{get\_product\_section}}{\emph{config}, \emph{product\_name}, \emph{version}, \emph{section=None}}{} +Get the product description from the configuration +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{Config} (\emph{config}) -- The global configuration + +\item {} +\textbf{str} (\emph{section}) -- The product name + +\item {} +\textbf{str} -- The version of the product + +\item {} +\textbf{str} -- The searched section (if not None, the section is +explicitly given + +\end{itemize} + +\item[{Returns}] \leavevmode +The product description + +\item[{Return type}] \leavevmode +Config + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{get\_products\_infos() (in module src.product)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.product.get_products_infos}\pysiglinewithargsret{\code{src.product.}\bfcode{get\_products\_infos}}{\emph{lproducts}, \emph{config}}{} +Get the specific configuration of a list of products +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{List} (\emph{lproducts}) -- The list of product names + +\item {} +\textbf{Config} (\emph{config}) -- The global configuration + +\end{itemize} + +\item[{Returns}] \leavevmode +the list of tuples +(product name, specific configuration of the product) + +\item[{Return type}] \leavevmode +{[}(str, Config){]} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{product\_compiles() (in module src.product)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.product.product_compiles}\pysiglinewithargsret{\code{src.product.}\bfcode{product\_compiles}}{\emph{product\_info}}{} +Know if a product compiles or not +(some products do not have a compilation procedure) +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{Config} (\emph{product\_info}) -- The configuration specific to +the product + +\item[{Returns}] \leavevmode +True if the product compiles, else False + +\item[{Return type}] \leavevmode +boolean + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{product\_has\_env\_script() (in module src.product)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.product.product_has_env_script}\pysiglinewithargsret{\code{src.product.}\bfcode{product\_has\_env\_script}}{\emph{product\_info}}{} +Know if a product has an environment script +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{Config} (\emph{product\_info}) -- The configuration specific to +the product + +\item[{Returns}] \leavevmode +True if the product it has an environment script, else False + +\item[{Return type}] \leavevmode +boolean + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{product\_has\_logo() (in module src.product)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.product.product_has_logo}\pysiglinewithargsret{\code{src.product.}\bfcode{product\_has\_logo}}{\emph{product\_info}}{} +Know if a product has a logo (YACSGEN generate) +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{Config} (\emph{product\_info}) -- The configuration specific to +the product + +\item[{Returns}] \leavevmode +The path of the logo if the product has a logo, else False + +\item[{Return type}] \leavevmode +Str + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{product\_has\_patches() (in module src.product)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.product.product_has_patches}\pysiglinewithargsret{\code{src.product.}\bfcode{product\_has\_patches}}{\emph{product\_info}}{} +Know if a product has one or more patches +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{Config} (\emph{product\_info}) -- The configuration specific to +the product + +\item[{Returns}] \leavevmode +True if the product has one or more patches + +\item[{Return type}] \leavevmode +boolean + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{product\_has\_salome\_gui() (in module src.product)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.product.product_has_salome_gui}\pysiglinewithargsret{\code{src.product.}\bfcode{product\_has\_salome\_gui}}{\emph{product\_info}}{} +Know if a product has a SALOME gui +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{Config} (\emph{product\_info}) -- The configuration specific to +the product + +\item[{Returns}] \leavevmode +True if the product has a SALOME gui, else False + +\item[{Return type}] \leavevmode +Boolean + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{product\_has\_script() (in module src.product)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.product.product_has_script}\pysiglinewithargsret{\code{src.product.}\bfcode{product\_has\_script}}{\emph{product\_info}}{} +Know if a product has a compilation script +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{Config} (\emph{product\_info}) -- The configuration specific to +the product + +\item[{Returns}] \leavevmode +True if the product it has a compilation script, else False + +\item[{Return type}] \leavevmode +boolean + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{product\_is\_autotools() (in module src.product)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.product.product_is_autotools}\pysiglinewithargsret{\code{src.product.}\bfcode{product\_is\_autotools}}{\emph{product\_info}}{} +Know if a product is compiled using the autotools +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{Config} (\emph{product\_info}) -- The configuration specific to +the product + +\item[{Returns}] \leavevmode +True if the product is autotools, else False + +\item[{Return type}] \leavevmode +boolean + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{product\_is\_cmake() (in module src.product)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.product.product_is_cmake}\pysiglinewithargsret{\code{src.product.}\bfcode{product\_is\_cmake}}{\emph{product\_info}}{} +Know if a product is compiled using the cmake +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{Config} (\emph{product\_info}) -- The configuration specific to +the product + +\item[{Returns}] \leavevmode +True if the product is cmake, else False + +\item[{Return type}] \leavevmode +boolean + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{product\_is\_cpp() (in module src.product)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.product.product_is_cpp}\pysiglinewithargsret{\code{src.product.}\bfcode{product\_is\_cpp}}{\emph{product\_info}}{} +Know if a product is cpp +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{Config} (\emph{product\_info}) -- The configuration specific to +the product + +\item[{Returns}] \leavevmode +True if the product is a cpp, else False + +\item[{Return type}] \leavevmode +boolean + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{product\_is\_debug() (in module src.product)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.product.product_is_debug}\pysiglinewithargsret{\code{src.product.}\bfcode{product\_is\_debug}}{\emph{product\_info}}{} +Know if a product is in debug mode +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{Config} (\emph{product\_info}) -- The configuration specific to +the product + +\item[{Returns}] \leavevmode +True if the product is in debug mode, else False + +\item[{Return type}] \leavevmode +boolean + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{product\_is\_dev() (in module src.product)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.product.product_is_dev}\pysiglinewithargsret{\code{src.product.}\bfcode{product\_is\_dev}}{\emph{product\_info}}{} +Know if a product is in dev mode +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{Config} (\emph{product\_info}) -- The configuration specific to +the product + +\item[{Returns}] \leavevmode +True if the product is in dev mode, else False + +\item[{Return type}] \leavevmode +boolean + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{product\_is\_fixed() (in module src.product)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.product.product_is_fixed}\pysiglinewithargsret{\code{src.product.}\bfcode{product\_is\_fixed}}{\emph{product\_info}}{} +Know if a product is fixed +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{Config} (\emph{product\_info}) -- The configuration specific to +the product + +\item[{Returns}] \leavevmode +True if the product is fixed, else False + +\item[{Return type}] \leavevmode +boolean + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{product\_is\_generated() (in module src.product)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.product.product_is_generated}\pysiglinewithargsret{\code{src.product.}\bfcode{product\_is\_generated}}{\emph{product\_info}}{} +Know if a product is generated (YACSGEN) +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{Config} (\emph{product\_info}) -- The configuration specific to +the product + +\item[{Returns}] \leavevmode +True if the product is generated + +\item[{Return type}] \leavevmode +boolean + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{product\_is\_mpi() (in module src.product)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.product.product_is_mpi}\pysiglinewithargsret{\code{src.product.}\bfcode{product\_is\_mpi}}{\emph{product\_info}}{} +Know if a product has openmpi in its dependencies +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{Config} (\emph{product\_info}) -- The configuration specific to +the product + +\item[{Returns}] \leavevmode +True if the product has openmpi inits dependencies + +\item[{Return type}] \leavevmode +boolean + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{product\_is\_native() (in module src.product)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.product.product_is_native}\pysiglinewithargsret{\code{src.product.}\bfcode{product\_is\_native}}{\emph{product\_info}}{} +Know if a product is native +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{Config} (\emph{product\_info}) -- The configuration specific to +the product + +\item[{Returns}] \leavevmode +True if the product is native, else False + +\item[{Return type}] \leavevmode +boolean + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{product\_is\_salome() (in module src.product)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.product.product_is_salome}\pysiglinewithargsret{\code{src.product.}\bfcode{product\_is\_salome}}{\emph{product\_info}}{} +Know if a product is a SALOME module +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{Config} (\emph{product\_info}) -- The configuration specific to +the product + +\item[{Returns}] \leavevmode +True if the product is a SALOME module, else False + +\item[{Return type}] \leavevmode +boolean + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{product\_is\_sample() (in module src.product)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.product.product_is_sample}\pysiglinewithargsret{\code{src.product.}\bfcode{product\_is\_sample}}{\emph{product\_info}}{} +Know if a product has the sample type +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{Config} (\emph{product\_info}) -- The configuration specific to +the product + +\item[{Returns}] \leavevmode +True if the product has the sample type, else False + +\item[{Return type}] \leavevmode +boolean + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{product\_is\_smesh\_plugin() (in module src.product)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.product.product_is_smesh_plugin}\pysiglinewithargsret{\code{src.product.}\bfcode{product\_is\_smesh\_plugin}}{\emph{product\_info}}{} +Know if a product is a SMESH plugin +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{Config} (\emph{product\_info}) -- The configuration specific to +the product + +\item[{Returns}] \leavevmode +True if the product is a SMESH plugin, else False + +\item[{Return type}] \leavevmode +boolean + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{product\_is\_vcs() (in module src.product)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.product.product_is_vcs}\pysiglinewithargsret{\code{src.product.}\bfcode{product\_is\_vcs}}{\emph{product\_info}}{} +Know if a product is download using git, svn or cvs (not archive) +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{Config} (\emph{product\_info}) -- The configuration specific to +the product + +\item[{Returns}] \leavevmode +True if the product is vcs, else False + +\item[{Return type}] \leavevmode +boolean + +\end{description}\end{quote} + +\end{fulllineitems} + + + +\subsubsection{\texttt{pyconf} Module} +\label{commands/apidoc/src:pyconf-module}\label{commands/apidoc/src:module-src.pyconf}\index{src.pyconf (module)} +This is a configuration module for Python. + +This module should work under Python versions \textgreater{}= 2.2, and cannot be used with +earlier versions since it uses new-style classes. + +Development and testing has only been carried out (so far) on Python 2.3.4 and +Python 2.4.2. See the test module (test\_config.py) included in the +U\{distribution\textless{}\href{http://www.red-dove.com/python\_config}{http://www.red-dove.com/python\_config}.html\textbar{}\_blank\textgreater{}\} (follow the +download link). + +A simple example - with the example configuration file: + +\begin{Verbatim}[commandchars=\\\{\}] +messages: +[ + \PYGZob{} + stream : {}`sys.stderr{}` + message: 'Welcome' + name: 'Harry' + \PYGZcb{} + \PYGZob{} + stream : {}`sys.stdout{}` + message: 'Welkom' + name: 'Ruud' + \PYGZcb{} + \PYGZob{} + stream : \$messages[0].stream + message: 'Bienvenue' + name: Yves + \PYGZcb{} +] +\end{Verbatim} + +a program to read the configuration would be: + +\begin{Verbatim}[commandchars=\\\{\}] +\PYG{k+kn}{from} \PYG{n+nn}{config} \PYG{k+kn}{import} \PYG{n}{Config} + +\PYG{n}{f} \PYG{o}{=} \PYG{n+nb}{file}\PYG{p}{(}\PYG{l+s}{'}\PYG{l+s}{simple.cfg}\PYG{l+s}{'}\PYG{p}{)} +\PYG{n}{cfg} \PYG{o}{=} \PYG{n}{Config}\PYG{p}{(}\PYG{n}{f}\PYG{p}{)} +\PYG{k}{for} \PYG{n}{m} \PYG{o+ow}{in} \PYG{n}{cfg}\PYG{o}{.}\PYG{n}{messages}\PYG{p}{:} + \PYG{n}{s} \PYG{o}{=} \PYG{l+s}{'}\PYG{l+s+si}{\PYGZpc{}s}\PYG{l+s}{, }\PYG{l+s+si}{\PYGZpc{}s}\PYG{l+s}{'} \PYG{o}{\PYGZpc{}} \PYG{p}{(}\PYG{n}{m}\PYG{o}{.}\PYG{n}{message}\PYG{p}{,} \PYG{n}{m}\PYG{o}{.}\PYG{n}{name}\PYG{p}{)} + \PYG{k}{try}\PYG{p}{:} + \PYG{k}{print} \PYG{o}{\textgreater{}\textgreater{}} \PYG{n}{m}\PYG{o}{.}\PYG{n}{stream}\PYG{p}{,} \PYG{n}{s} + \PYG{k}{except} \PYG{n+ne}{IOError}\PYG{p}{,} \PYG{n}{e}\PYG{p}{:} + \PYG{k}{print} \PYG{n}{e} +\end{Verbatim} + +which, when run, would yield the console output: + +\begin{Verbatim}[commandchars=\\\{\}] +\PYG{n}{Welcome}\PYG{p}{,} \PYG{n}{Harry} +\PYG{n}{Welkom}\PYG{p}{,} \PYG{n}{Ruud} +\PYG{n}{Bienvenue}\PYG{p}{,} \PYG{n}{Yves} +\end{Verbatim} + +See U\{this tutorial\textless{}\href{http://www.red-dove.com/python\_config}{http://www.red-dove.com/python\_config}.html\textbar{}\_blank\textgreater{}\} for more +information. + +\#modified for salomeTools +@version: 0.3.7.1 + +@author: Vinay Sajip + +@copyright: Copyright (C) 2004-2007 Vinay Sajip. All Rights Reserved. + +@var streamOpener: The default stream opener. This is a factory function which +takes a string (e.g. filename) and returns a stream suitable for reading. If +unable to open the stream, an IOError exception should be thrown. + +The default value of this variable is L\{defaultStreamOpener\}. For an example +of how it's used, see test\_config.py (search for streamOpener). +\index{Config (class in src.pyconf)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.Config}\pysiglinewithargsret{\strong{class }\code{src.pyconf.}\bfcode{Config}}{\emph{streamOrFile=None}, \emph{parent=None}, \emph{PWD=None}}{} +Bases: {\hyperref[commands/apidoc/src:src.pyconf.Mapping]{\code{src.pyconf.Mapping}}} + +This class represents a configuration, and is the only one which clients +need to interface to, under normal circumstances. +\index{Config.Namespace (class in src.pyconf)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.Config.Namespace}\pysigline{\strong{class }\bfcode{Namespace}} +Bases: \code{object} + +This internal class is used for implementing default namespaces. + +An instance acts as a namespace. + +\end{fulllineitems} + +\index{addNamespace() (src.pyconf.Config method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.Config.addNamespace}\pysiglinewithargsret{\code{Config.}\bfcode{addNamespace}}{\emph{ns}, \emph{name=None}}{} +Add a namespace to this configuration which can be used to evaluate +(resolve) dotted-identifier expressions. +@param ns: The namespace to be added. +@type ns: A module or other namespace suitable for passing as an +argument to vars(). +@param name: A name for the namespace, which, if specified, provides +an additional level of indirection. +@type name: str + +\end{fulllineitems} + +\index{getByPath() (src.pyconf.Config method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.Config.getByPath}\pysiglinewithargsret{\code{Config.}\bfcode{getByPath}}{\emph{path}}{} +Obtain a value in the configuration via its path. +@param path: The path of the required value +@type path: str +@return the value at the specified path. +@rtype: any +@raise ConfigError: If the path is invalid + +\end{fulllineitems} + +\index{load() (src.pyconf.Config method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.Config.load}\pysiglinewithargsret{\code{Config.}\bfcode{load}}{\emph{stream}}{} +Load the configuration from the specified stream. Multiple streams can +be used to populate the same instance, as long as there are no +clashing keys. The stream is closed. +@param stream: A stream from which the configuration is read. +@type stream: A read-only stream (file-like object). +@raise ConfigError: if keys in the loaded configuration clash with +existing keys. +@raise ConfigFormatError: if there is a syntax error in the stream. + +\end{fulllineitems} + +\index{removeNamespace() (src.pyconf.Config method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.Config.removeNamespace}\pysiglinewithargsret{\code{Config.}\bfcode{removeNamespace}}{\emph{ns}, \emph{name=None}}{} +Remove a namespace added with L\{addNamespace\}. +@param ns: The namespace to be removed. +@param name: The name which was specified when L\{addNamespace\} was +called. +@type name: str + +\end{fulllineitems} + + +\end{fulllineitems} + +\index{ConfigError} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigError}\pysigline{\strong{exception }\code{src.pyconf.}\bfcode{ConfigError}} +Bases: \code{exceptions.Exception} + +This is the base class of exceptions raised by this module. + +\end{fulllineitems} + +\index{ConfigFormatError} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigFormatError}\pysigline{\strong{exception }\code{src.pyconf.}\bfcode{ConfigFormatError}} +Bases: {\hyperref[commands/apidoc/src:src.pyconf.ConfigError]{\code{src.pyconf.ConfigError}}} + +This is the base class of exceptions raised due to syntax errors in +configurations. + +\end{fulllineitems} + +\index{ConfigInputStream (class in src.pyconf)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigInputStream}\pysiglinewithargsret{\strong{class }\code{src.pyconf.}\bfcode{ConfigInputStream}}{\emph{stream}}{} +Bases: \code{object} + +An input stream which can read either ANSI files with default encoding +or Unicode files with BOMs. + +Handles UTF-8, UTF-16LE, UTF-16BE. Could handle UTF-32 if Python had +built-in support. +\index{close() (src.pyconf.ConfigInputStream method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigInputStream.close}\pysiglinewithargsret{\bfcode{close}}{}{} +\end{fulllineitems} + +\index{read() (src.pyconf.ConfigInputStream method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigInputStream.read}\pysiglinewithargsret{\bfcode{read}}{\emph{size}}{} +\end{fulllineitems} + +\index{readline() (src.pyconf.ConfigInputStream method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigInputStream.readline}\pysiglinewithargsret{\bfcode{readline}}{}{} +\end{fulllineitems} + + +\end{fulllineitems} + +\index{ConfigList (class in src.pyconf)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigList}\pysigline{\strong{class }\code{src.pyconf.}\bfcode{ConfigList}} +Bases: \code{list} + +This class implements an ordered list of configurations and allows you +to try getting the configuration from each entry in turn, returning +the first successfully obtained value. +\index{getByPath() (src.pyconf.ConfigList method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigList.getByPath}\pysiglinewithargsret{\bfcode{getByPath}}{\emph{path}}{} +Obtain a value from the first configuration in the list which defines +it. + +@param path: The path of the value to retrieve. +@type path: str +@return: The value from the earliest configuration in the list which +defines it. +@rtype: any +@raise ConfigError: If no configuration in the list has an entry with +the specified path. + +\end{fulllineitems} + + +\end{fulllineitems} + +\index{ConfigMerger (class in src.pyconf)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigMerger}\pysiglinewithargsret{\strong{class }\code{src.pyconf.}\bfcode{ConfigMerger}}{\emph{resolver=\textless{}function defaultMergeResolve at 0x2379de8\textgreater{}}}{} +Bases: \code{object} + +This class is used for merging two configurations. If a key exists in the +merge operand but not the merge target, then the entry is copied from the +merge operand to the merge target. If a key exists in both configurations, +then a resolver (a callable) is called to decide how to handle the +conflict. +\index{handleMismatch() (src.pyconf.ConfigMerger method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigMerger.handleMismatch}\pysiglinewithargsret{\bfcode{handleMismatch}}{\emph{obj1}, \emph{obj2}}{} +Handle a mismatch between two objects. + +@param obj1: The object to merge into. +@type obj1: any +@param obj2: The object to merge. +@type obj2: any + +\end{fulllineitems} + +\index{merge() (src.pyconf.ConfigMerger method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigMerger.merge}\pysiglinewithargsret{\bfcode{merge}}{\emph{merged}, \emph{mergee}}{} +Merge two configurations. The second configuration is unchanged, +and the first is changed to reflect the results of the merge. + +@param merged: The configuration to merge into. +@type merged: L\{Config\}. +@param mergee: The configuration to merge. +@type mergee: L\{Config\}. + +\end{fulllineitems} + +\index{mergeMapping() (src.pyconf.ConfigMerger method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigMerger.mergeMapping}\pysiglinewithargsret{\bfcode{mergeMapping}}{\emph{map1}, \emph{map2}}{} +Merge two mappings recursively. The second mapping is unchanged, +and the first is changed to reflect the results of the merge. + +@param map1: The mapping to merge into. +@type map1: L\{Mapping\}. +@param map2: The mapping to merge. +@type map2: L\{Mapping\}. + +\end{fulllineitems} + +\index{mergeSequence() (src.pyconf.ConfigMerger method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigMerger.mergeSequence}\pysiglinewithargsret{\bfcode{mergeSequence}}{\emph{seq1}, \emph{seq2}}{} +Merge two sequences. The second sequence is unchanged, +and the first is changed to have the elements of the second +appended to it. + +@param seq1: The sequence to merge into. +@type seq1: L\{Sequence\}. +@param seq2: The sequence to merge. +@type seq2: L\{Sequence\}. + +\end{fulllineitems} + +\index{overwriteKeys() (src.pyconf.ConfigMerger method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigMerger.overwriteKeys}\pysiglinewithargsret{\bfcode{overwriteKeys}}{\emph{map1}, \emph{seq2}}{} +Renint variables. The second mapping is unchanged, +and the first is changed depending the keys of the second mapping. +@param map1: The mapping to reinit keys into. +@type map1: L\{Mapping\}. +@param map2: The mapping container reinit information. +@type map2: L\{Mapping\}. + +\end{fulllineitems} + + +\end{fulllineitems} + +\index{ConfigOutputStream (class in src.pyconf)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigOutputStream}\pysiglinewithargsret{\strong{class }\code{src.pyconf.}\bfcode{ConfigOutputStream}}{\emph{stream}, \emph{encoding=None}}{} +Bases: \code{object} + +An output stream which can write either ANSI files with default encoding +or Unicode files with BOMs. + +Handles UTF-8, UTF-16LE, UTF-16BE. Could handle UTF-32 if Python had +built-in support. +\index{close() (src.pyconf.ConfigOutputStream method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigOutputStream.close}\pysiglinewithargsret{\bfcode{close}}{}{} +\end{fulllineitems} + +\index{flush() (src.pyconf.ConfigOutputStream method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigOutputStream.flush}\pysiglinewithargsret{\bfcode{flush}}{}{} +\end{fulllineitems} + +\index{write() (src.pyconf.ConfigOutputStream method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigOutputStream.write}\pysiglinewithargsret{\bfcode{write}}{\emph{data}}{} +\end{fulllineitems} + + +\end{fulllineitems} + +\index{ConfigReader (class in src.pyconf)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigReader}\pysiglinewithargsret{\strong{class }\code{src.pyconf.}\bfcode{ConfigReader}}{\emph{config}}{} +Bases: \code{object} + +This internal class implements a parser for configurations. +\index{getChar() (src.pyconf.ConfigReader method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigReader.getChar}\pysiglinewithargsret{\bfcode{getChar}}{}{} +Get the next char from the stream. Update line and column numbers +appropriately. + +@return: The next character from the stream. +@rtype: str + +\end{fulllineitems} + +\index{getToken() (src.pyconf.ConfigReader method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigReader.getToken}\pysiglinewithargsret{\bfcode{getToken}}{}{} +Get a token from the stream. String values are returned in a form +where you need to eval() the returned value to get the actual +string. The return value is (token\_type, token\_value). + +Multiline string tokenizing is thanks to David Janes (BlogMatrix) + +@return: The next token. +@rtype: A token tuple. + +\end{fulllineitems} + +\index{load() (src.pyconf.ConfigReader method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigReader.load}\pysiglinewithargsret{\bfcode{load}}{\emph{stream}, \emph{parent=None}, \emph{suffix=None}}{} +Load the configuration from the specified stream. + +@param stream: A stream from which to load the configuration. +@type stream: A stream (file-like object). +@param parent: The parent of the configuration (to which this reader +belongs) in the hierarchy. Specified when the configuration is +included in another one. +@type parent: A L\{Container\} instance. +@param suffix: The suffix of this configuration in the parent +configuration. Should be specified whenever the parent is not None. +@raise ConfigError: If parent is specified but suffix is not. +@raise ConfigFormatError: If there are syntax errors in the stream. + +\end{fulllineitems} + +\index{location() (src.pyconf.ConfigReader method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigReader.location}\pysiglinewithargsret{\bfcode{location}}{}{} +Return the current location (filename, line, column) in the stream +as a string. + +Used when printing error messages, + +@return: A string representing a location in the stream being read. +@rtype: str + +\end{fulllineitems} + +\index{match() (src.pyconf.ConfigReader method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigReader.match}\pysiglinewithargsret{\bfcode{match}}{\emph{t}}{} +Ensure that the current token type matches the specified value, and +advance to the next token. + +@param t: The token type to match. +@type t: A valid token type. +@return: The token which was last read from the stream before this +function is called. +@rtype: a token tuple - see L\{getToken\}. +@raise ConfigFormatError: If the token does not match what's expected. + +\end{fulllineitems} + +\index{parseFactor() (src.pyconf.ConfigReader method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigReader.parseFactor}\pysiglinewithargsret{\bfcode{parseFactor}}{}{} +Parse a factor in an multiplicative expression (a * b, a / b, a \% b) + +@return: the parsed factor +@rtype: any scalar +@raise ConfigFormatError: if a syntax error is found. + +\end{fulllineitems} + +\index{parseKeyValuePair() (src.pyconf.ConfigReader method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigReader.parseKeyValuePair}\pysiglinewithargsret{\bfcode{parseKeyValuePair}}{\emph{parent}}{} +Parse a key-value pair, and add it to the provided L\{Mapping\}. + +@param parent: The mapping to add entries to. +@type parent: A L\{Mapping\} instance. +@raise ConfigFormatError: if a syntax error is found. + +\end{fulllineitems} + +\index{parseMapping() (src.pyconf.ConfigReader method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigReader.parseMapping}\pysiglinewithargsret{\bfcode{parseMapping}}{\emph{parent}, \emph{suffix}}{} +Parse a mapping. + +@param parent: The container to which the mapping will be added. +@type parent: A L\{Container\} instance. +@param suffix: The suffix for the value. +@type suffix: str +@return: a L\{Mapping\} instance representing the mapping. +@rtype: L\{Mapping\} +@raise ConfigFormatError: if a syntax error is found. + +\end{fulllineitems} + +\index{parseMappingBody() (src.pyconf.ConfigReader method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigReader.parseMappingBody}\pysiglinewithargsret{\bfcode{parseMappingBody}}{\emph{parent}}{} +Parse the internals of a mapping, and add entries to the provided +L\{Mapping\}. + +@param parent: The mapping to add entries to. +@type parent: A L\{Mapping\} instance. + +\end{fulllineitems} + +\index{parseReference() (src.pyconf.ConfigReader method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigReader.parseReference}\pysiglinewithargsret{\bfcode{parseReference}}{\emph{type}}{} +Parse a reference. + +@return: the parsed reference +@rtype: L\{Reference\} +@raise ConfigFormatError: if a syntax error is found. + +\end{fulllineitems} + +\index{parseScalar() (src.pyconf.ConfigReader method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigReader.parseScalar}\pysiglinewithargsret{\bfcode{parseScalar}}{}{} +Parse a scalar - a terminal value such as a string or number, or +an L\{Expression\} or L\{Reference\}. + +@return: the parsed scalar +@rtype: any scalar +@raise ConfigFormatError: if a syntax error is found. + +\end{fulllineitems} + +\index{parseSequence() (src.pyconf.ConfigReader method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigReader.parseSequence}\pysiglinewithargsret{\bfcode{parseSequence}}{\emph{parent}, \emph{suffix}}{} +Parse a sequence. + +@param parent: The container to which the sequence will be added. +@type parent: A L\{Container\} instance. +@param suffix: The suffix for the value. +@type suffix: str +@return: a L\{Sequence\} instance representing the sequence. +@rtype: L\{Sequence\} +@raise ConfigFormatError: if a syntax error is found. + +\end{fulllineitems} + +\index{parseSuffix() (src.pyconf.ConfigReader method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigReader.parseSuffix}\pysiglinewithargsret{\bfcode{parseSuffix}}{\emph{ref}}{} +Parse a reference suffix. + +@param ref: The reference of which this suffix is a part. +@type ref: L\{Reference\}. +@raise ConfigFormatError: if a syntax error is found. + +\end{fulllineitems} + +\index{parseTerm() (src.pyconf.ConfigReader method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigReader.parseTerm}\pysiglinewithargsret{\bfcode{parseTerm}}{}{} +Parse a term in an additive expression (a + b, a - b) + +@return: the parsed term +@rtype: any scalar +@raise ConfigFormatError: if a syntax error is found. + +\end{fulllineitems} + +\index{parseValue() (src.pyconf.ConfigReader method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigReader.parseValue}\pysiglinewithargsret{\bfcode{parseValue}}{\emph{parent}, \emph{suffix}}{} +Parse a value. + +@param parent: The container to which the value will be added. +@type parent: A L\{Container\} instance. +@param suffix: The suffix for the value. +@type suffix: str +@return: The value +@rtype: any +@raise ConfigFormatError: if a syntax error is found. + +\end{fulllineitems} + +\index{setStream() (src.pyconf.ConfigReader method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigReader.setStream}\pysiglinewithargsret{\bfcode{setStream}}{\emph{stream}}{} +Set the stream to the specified value, and prepare to read from it. + +@param stream: A stream from which to load the configuration. +@type stream: A stream (file-like object). + +\end{fulllineitems} + + +\end{fulllineitems} + +\index{ConfigResolutionError} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.ConfigResolutionError}\pysigline{\strong{exception }\code{src.pyconf.}\bfcode{ConfigResolutionError}} +Bases: {\hyperref[commands/apidoc/src:src.pyconf.ConfigError]{\code{src.pyconf.ConfigError}}} + +This is the base class of exceptions raised due to semantic errors in +configurations. + +\end{fulllineitems} + +\index{Container (class in src.pyconf)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.Container}\pysiglinewithargsret{\strong{class }\code{src.pyconf.}\bfcode{Container}}{\emph{parent}}{} +Bases: \code{object} + +This internal class is the base class for mappings and sequences. + +@ivar path: A string which describes how to get +to this instance from the root of the hierarchy. + +Example: + +\begin{Verbatim}[commandchars=\\\{\}] +a.list.of[1].or['more'].elements +\end{Verbatim} +\index{evaluate() (src.pyconf.Container method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.Container.evaluate}\pysiglinewithargsret{\bfcode{evaluate}}{\emph{item}}{} +Evaluate items which are instances of L\{Reference\} or L\{Expression\}. + +L\{Reference\} instances are evaluated using L\{Reference.resolve\}, +and L\{Expression\} instances are evaluated using +L\{Expression.evaluate\}. + +@param item: The item to be evaluated. +@type item: any +@return: If the item is an instance of L\{Reference\} or L\{Expression\}, +the evaluated value is returned, otherwise the item is returned +unchanged. + +\end{fulllineitems} + +\index{setPath() (src.pyconf.Container method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.Container.setPath}\pysiglinewithargsret{\bfcode{setPath}}{\emph{path}}{} +Set the path for this instance. +@param path: The path - a string which describes how to get +to this instance from the root of the hierarchy. +@type path: str + +\end{fulllineitems} + +\index{writeToStream() (src.pyconf.Container method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.Container.writeToStream}\pysiglinewithargsret{\bfcode{writeToStream}}{\emph{stream}, \emph{indent}, \emph{container}}{} +Write this instance to a stream at the specified indentation level. + +Should be redefined in subclasses. + +@param stream: The stream to write to +@type stream: A writable stream (file-like object) +@param indent: The indentation level +@type indent: int +@param container: The container of this instance +@type container: L\{Container\} +@raise NotImplementedError: If a subclass does not override this + +\end{fulllineitems} + +\index{writeValue() (src.pyconf.Container method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.Container.writeValue}\pysiglinewithargsret{\bfcode{writeValue}}{\emph{value}, \emph{stream}, \emph{indent}}{} +\end{fulllineitems} + + +\end{fulllineitems} + +\index{Expression (class in src.pyconf)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.Expression}\pysiglinewithargsret{\strong{class }\code{src.pyconf.}\bfcode{Expression}}{\emph{op}, \emph{lhs}, \emph{rhs}}{} +Bases: \code{object} + +This internal class implements a value which is obtained by evaluating an expression. +\index{evaluate() (src.pyconf.Expression method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.Expression.evaluate}\pysiglinewithargsret{\bfcode{evaluate}}{\emph{container}}{} +Evaluate this instance in the context of a container. + +@param container: The container to evaluate in from. +@type container: L\{Container\} +@return: The evaluated value. +@rtype: any +@raise ConfigResolutionError: If evaluation fails. +@raise ZeroDivideError: If division by zero occurs. +@raise TypeError: If the operation is invalid, e.g. +subtracting one string from another. + +\end{fulllineitems} + + +\end{fulllineitems} + +\index{Mapping (class in src.pyconf)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.Mapping}\pysiglinewithargsret{\strong{class }\code{src.pyconf.}\bfcode{Mapping}}{\emph{parent=None}}{} +Bases: {\hyperref[commands/apidoc/src:src.pyconf.Container]{\code{src.pyconf.Container}}} + +This internal class implements key-value mappings in configurations. +\index{addMapping() (src.pyconf.Mapping method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.Mapping.addMapping}\pysiglinewithargsret{\bfcode{addMapping}}{\emph{key}, \emph{value}, \emph{comment}, \emph{setting=False}}{} +Add a key-value mapping with a comment. + +@param key: The key for the mapping. +@type key: str +@param value: The value for the mapping. +@type value: any +@param comment: The comment for the key (can be None). +@type comment: str +@param setting: If True, ignore clashes. This is set +to true when called from L\{\_\_setattr\_\_\}. +@raise ConfigFormatError: If an existing key is seen +again and setting is False. + +\end{fulllineitems} + +\index{get() (src.pyconf.Mapping method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.Mapping.get}\pysiglinewithargsret{\bfcode{get}}{\emph{key}, \emph{default=None}}{} +Allows a dictionary-style get operation. + +\end{fulllineitems} + +\index{iteritems() (src.pyconf.Mapping method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.Mapping.iteritems}\pysiglinewithargsret{\bfcode{iteritems}}{}{} +\end{fulllineitems} + +\index{iterkeys() (src.pyconf.Mapping method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.Mapping.iterkeys}\pysiglinewithargsret{\bfcode{iterkeys}}{}{} +\end{fulllineitems} + +\index{keys() (src.pyconf.Mapping method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.Mapping.keys}\pysiglinewithargsret{\bfcode{keys}}{}{} +Return the keys in a similar way to a dictionary. + +\end{fulllineitems} + +\index{writeToStream() (src.pyconf.Mapping method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.Mapping.writeToStream}\pysiglinewithargsret{\bfcode{writeToStream}}{\emph{stream}, \emph{indent}, \emph{container}}{} +Write this instance to a stream at the specified indentation level. + +Should be redefined in subclasses. + +@param stream: The stream to write to +@type stream: A writable stream (file-like object) +@param indent: The indentation level +@type indent: int +@param container: The container of this instance +@type container: L\{Container\} + +\end{fulllineitems} + + +\end{fulllineitems} + +\index{Reference (class in src.pyconf)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.Reference}\pysiglinewithargsret{\strong{class }\code{src.pyconf.}\bfcode{Reference}}{\emph{config}, \emph{type}, \emph{ident}}{} +Bases: \code{object} + +This internal class implements a value which is a reference to another value. +\index{addElement() (src.pyconf.Reference method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.Reference.addElement}\pysiglinewithargsret{\bfcode{addElement}}{\emph{type}, \emph{ident}}{} +Add an element to the reference. + +@param type: The type of reference. +@type type: BACKTICK or DOLLAR +@param ident: The identifier which continues the reference. +@type ident: str + +\end{fulllineitems} + +\index{findConfig() (src.pyconf.Reference method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.Reference.findConfig}\pysiglinewithargsret{\bfcode{findConfig}}{\emph{container}}{} +Find the closest enclosing configuration to the specified container. + +@param container: The container to start from. +@type container: L\{Container\} +@return: The closest enclosing configuration, or None. +@rtype: L\{Config\} + +\end{fulllineitems} + +\index{resolve() (src.pyconf.Reference method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.Reference.resolve}\pysiglinewithargsret{\bfcode{resolve}}{\emph{container}}{} +Resolve this instance in the context of a container. + +@param container: The container to resolve from. +@type container: L\{Container\} +@return: The resolved value. +@rtype: any +@raise ConfigResolutionError: If resolution fails. + +\end{fulllineitems} + + +\end{fulllineitems} + +\index{Sequence (class in src.pyconf)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.Sequence}\pysiglinewithargsret{\strong{class }\code{src.pyconf.}\bfcode{Sequence}}{\emph{parent=None}}{} +Bases: {\hyperref[commands/apidoc/src:src.pyconf.Container]{\code{src.pyconf.Container}}} + +This internal class implements a value which is a sequence of other values. +\index{Sequence.SeqIter (class in src.pyconf)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.Sequence.SeqIter}\pysiglinewithargsret{\strong{class }\bfcode{SeqIter}}{\emph{seq}}{} +Bases: \code{object} + +This internal class implements an iterator for a L\{Sequence\} instance. +\index{next() (src.pyconf.Sequence.SeqIter method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.Sequence.SeqIter.next}\pysiglinewithargsret{\bfcode{next}}{}{} +\end{fulllineitems} + + +\end{fulllineitems} + +\index{append() (src.pyconf.Sequence method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.Sequence.append}\pysiglinewithargsret{\code{Sequence.}\bfcode{append}}{\emph{item}, \emph{comment}}{} +Add an item to the sequence. + +@param item: The item to add. +@type item: any +@param comment: A comment for the item. +@type comment: str + +\end{fulllineitems} + +\index{writeToStream() (src.pyconf.Sequence method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.Sequence.writeToStream}\pysiglinewithargsret{\code{Sequence.}\bfcode{writeToStream}}{\emph{stream}, \emph{indent}, \emph{container}}{} +Write this instance to a stream at the specified indentation level. + +Should be redefined in subclasses. + +@param stream: The stream to write to +@type stream: A writable stream (file-like object) +@param indent: The indentation level +@type indent: int +@param container: The container of this instance +@type container: L\{Container\} + +\end{fulllineitems} + + +\end{fulllineitems} + +\index{deepCopyMapping() (in module src.pyconf)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.deepCopyMapping}\pysiglinewithargsret{\code{src.pyconf.}\bfcode{deepCopyMapping}}{\emph{inMapping}}{} +\end{fulllineitems} + +\index{defaultMergeResolve() (in module src.pyconf)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.defaultMergeResolve}\pysiglinewithargsret{\code{src.pyconf.}\bfcode{defaultMergeResolve}}{\emph{map1}, \emph{map2}, \emph{key}}{} +A default resolver for merge conflicts. +Returns a string indicating what action to take to resolve the conflict. + +@param map1: The map being merged into. +@type map1: L\{Mapping\}. +@param map2: The map being used as the merge operand. +@type map2: L\{Mapping\}. +@param key: The key in map2 (which also exists in map1). +@type key: str +\begin{description} +\item[{@return: One of ``merge'', ``append'', ``mismatch'' or ``overwrite''}] \leavevmode +indicating what action should be taken. This should +be appropriate to the objects being merged - e.g. +there is no point returning ``merge'' if the two objects +are instances of L\{Sequence\}. + +\end{description} + +@rtype: str + +\end{fulllineitems} + +\index{defaultStreamOpener() (in module src.pyconf)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.defaultStreamOpener}\pysiglinewithargsret{\code{src.pyconf.}\bfcode{defaultStreamOpener}}{\emph{name}}{} +This function returns a read-only stream, given its name. The name passed +in should correspond to an existing stream, otherwise an exception will be +raised. + +This is the default value of L\{streamOpener\}; assign your own callable to +streamOpener to return streams based on names. For example, you could use +urllib2.urlopen(). + +@param name: The name of a stream, most commonly a file name. +@type name: str +@return: A stream with the specified name. +@rtype: A read-only stream (file-like object) + +\end{fulllineitems} + +\index{isWord() (in module src.pyconf)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.isWord}\pysiglinewithargsret{\code{src.pyconf.}\bfcode{isWord}}{\emph{s}}{} +See if a passed-in value is an identifier. If the value passed in is not a +string, False is returned. An identifier consists of alphanumerics or +underscore characters. + +Examples: + +\begin{Verbatim}[commandchars=\\\{\}] +isWord('a word') -\textgreater{}False +isWord('award') -\textgreater{} True +isWord(9) -\textgreater{} False +isWord('a\_b\_c\_') -\textgreater{}True +\end{Verbatim} + +@note: isWord(`9abc') will return True - not exactly correct, but adequate +for the way it's used here. + +@param s: The name to be tested +@type s: any +@return: True if a word, else False +@rtype: bool + +\end{fulllineitems} + +\index{makePath() (in module src.pyconf)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.makePath}\pysiglinewithargsret{\code{src.pyconf.}\bfcode{makePath}}{\emph{prefix}, \emph{suffix}}{} +Make a path from a prefix and suffix. + +Examples: +makePath(`', `suffix') -\textgreater{} `suffix' +makePath(`prefix', `suffix') -\textgreater{} `prefix.suffix' +makePath(`prefix', `{[}1{]}') -\textgreater{} `prefix{[}1{]}' + +@param prefix: The prefix to use. If it evaluates as false, the suffix is returned. +@type prefix: str +@param suffix: The suffix to use. It is either an identifier or an index in brackets. +@type suffix: str +@return: The path concatenation of prefix and suffix, with adot if the suffix is not a bracketed index. +@rtype: str + +\end{fulllineitems} + +\index{overwriteMergeResolve() (in module src.pyconf)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.pyconf.overwriteMergeResolve}\pysiglinewithargsret{\code{src.pyconf.}\bfcode{overwriteMergeResolve}}{\emph{map1}, \emph{map2}, \emph{key}}{} +An overwriting resolver for merge conflicts. Calls L\{defaultMergeResolve\}, +but where a ``mismatch'' is detected, returns ``overwrite'' instead. + +@param map1: The map being merged into. +@type map1: L\{Mapping\}. +@param map2: The map being used as the merge operand. +@type map2: L\{Mapping\}. +@param key: The key in map2 (which also exists in map1). +@type key: str + +\end{fulllineitems} + + + +\subsubsection{\texttt{system} Module} +\label{commands/apidoc/src:system-module}\label{commands/apidoc/src:module-src.system}\index{src.system (module)} +In this file : all functions that do a system call, +like open a browser or an editor, or call a git command +\index{archive\_extract() (in module src.system)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.system.archive_extract}\pysiglinewithargsret{\code{src.system.}\bfcode{archive\_extract}}{\emph{from\_what}, \emph{where}, \emph{logger}}{} +Extracts sources from an archive. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{str} (\emph{where}) -- The path to the archive. + +\item {} +\textbf{str} -- The path where to extract. + +\item {} +\textbf{Logger} (\emph{logger}) -- The logger instance to use. + +\end{itemize} + +\item[{Returns}] \leavevmode +True if the extraction is successful + +\item[{Return type}] \leavevmode +boolean + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{cvs\_extract() (in module src.system)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.system.cvs_extract}\pysiglinewithargsret{\code{src.system.}\bfcode{cvs\_extract}}{\emph{protocol}, \emph{user}, \emph{server}, \emph{base}, \emph{tag}, \emph{product}, \emph{where}, \emph{logger}, \emph{checkout=False}, \emph{environment=None}}{} +Extracts sources from a cvs repository. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{str} (\emph{where}) -- The cvs protocol. + +\item {} +\textbf{str} -- The user to be used. + +\item {} +\textbf{str} -- The remote cvs server. + +\item {} +\textbf{str} -- +. + + +\item {} +\textbf{str} -- The tag. + +\item {} +\textbf{str} -- The product. + +\item {} +\textbf{str} -- The path where to extract. + +\item {} +\textbf{Logger} (\emph{logger}) -- The logger instance to use. + +\item {} +\textbf{boolean} (\emph{checkout}) -- If true use checkout cvs. + +\item {} +\textbf{src.environment.Environ} (\emph{environment}) -- The environment to source when +extracting. + +\end{itemize} + +\item[{Returns}] \leavevmode +True if the extraction is successful + +\item[{Return type}] \leavevmode +boolean + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{git\_extract() (in module src.system)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.system.git_extract}\pysiglinewithargsret{\code{src.system.}\bfcode{git\_extract}}{\emph{from\_what}, \emph{tag}, \emph{where}, \emph{logger}, \emph{environment=None}}{} +Extracts sources from a git repository. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{str} (\emph{where}) -- The remote git repository. + +\item {} +\textbf{str} -- The tag. + +\item {} +\textbf{str} -- The path where to extract. + +\item {} +\textbf{Logger} (\emph{logger}) -- The logger instance to use. + +\item {} +\textbf{src.environment.Environ} (\emph{environment}) -- The environment to source when +extracting. + +\end{itemize} + +\item[{Returns}] \leavevmode +True if the extraction is successful + +\item[{Return type}] \leavevmode +boolean + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{show\_in\_editor() (in module src.system)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.system.show_in_editor}\pysiglinewithargsret{\code{src.system.}\bfcode{show\_in\_editor}}{\emph{editor}, \emph{filePath}, \emph{logger}}{} +open filePath using editor. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{str} (\emph{filePath}) -- The editor to use. + +\item {} +\textbf{str} -- The path to the file to open. + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{svn\_extract() (in module src.system)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.system.svn_extract}\pysiglinewithargsret{\code{src.system.}\bfcode{svn\_extract}}{\emph{user}, \emph{from\_what}, \emph{tag}, \emph{where}, \emph{logger}, \emph{checkout=False}, \emph{environment=None}}{} +Extracts sources from a svn repository. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{str} (\emph{where}) -- The user to be used. + +\item {} +\textbf{str} -- The remote git repository. + +\item {} +\textbf{str} -- The tag. + +\item {} +\textbf{str} -- The path where to extract. + +\item {} +\textbf{Logger} (\emph{logger}) -- The logger instance to use. + +\item {} +\textbf{boolean} (\emph{checkout}) -- If true use checkout svn. + +\item {} +\textbf{src.environment.Environ} (\emph{environment}) -- The environment to source when +extracting. + +\end{itemize} + +\item[{Returns}] \leavevmode +True if the extraction is successful + +\item[{Return type}] \leavevmode +boolean + +\end{description}\end{quote} + +\end{fulllineitems} + + + +\subsubsection{\texttt{template} Module} +\label{commands/apidoc/src:template-module}\label{commands/apidoc/src:module-src.template}\index{src.template (module)}\index{MyTemplate (class in src.template)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.template.MyTemplate}\pysiglinewithargsret{\strong{class }\code{src.template.}\bfcode{MyTemplate}}{\emph{template}}{} +Bases: \code{string.Template} +\index{delimiter (src.template.MyTemplate attribute)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.template.MyTemplate.delimiter}\pysigline{\bfcode{delimiter}\strong{ = `\textbackslash{}xc2\textbackslash{}xa4'}} +\end{fulllineitems} + +\index{pattern (src.template.MyTemplate attribute)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.template.MyTemplate.pattern}\pysigline{\bfcode{pattern}\strong{ = \textless{}\_sre.SRE\_Pattern object at 0x24c9d70\textgreater{}}} +\end{fulllineitems} + + +\end{fulllineitems} + +\index{substitute() (in module src.template)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.template.substitute}\pysiglinewithargsret{\code{src.template.}\bfcode{substitute}}{\emph{template\_file}, \emph{subst\_dic}}{} +\end{fulllineitems} + + + +\subsubsection{\texttt{test\_module} Module} +\label{commands/apidoc/src:module-src.test_module}\label{commands/apidoc/src:test-module-module}\index{src.test\_module (module)}\index{Test (class in src.test\_module)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.test_module.Test}\pysiglinewithargsret{\strong{class }\code{src.test\_module.}\bfcode{Test}}{\emph{config}, \emph{logger}, \emph{tmp\_working\_dir}, \emph{testbase='`}, \emph{grids=None}, \emph{sessions=None}, \emph{launcher='`}, \emph{show\_desktop=True}}{}~\index{generate\_launching\_commands() (src.test\_module.Test method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.test_module.Test.generate_launching_commands}\pysiglinewithargsret{\bfcode{generate\_launching\_commands}}{}{} +\end{fulllineitems} + +\index{generate\_script() (src.test\_module.Test method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.test_module.Test.generate_script}\pysiglinewithargsret{\bfcode{generate\_script}}{\emph{listTest}, \emph{script\_path}, \emph{ignoreList}}{} +\end{fulllineitems} + +\index{get\_test\_timeout() (src.test\_module.Test method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.test_module.Test.get_test_timeout}\pysiglinewithargsret{\bfcode{get\_test\_timeout}}{\emph{test\_name}, \emph{default\_value}}{} +\end{fulllineitems} + +\index{get\_tmp\_dir() (src.test\_module.Test method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.test_module.Test.get_tmp_dir}\pysiglinewithargsret{\bfcode{get\_tmp\_dir}}{}{} +\end{fulllineitems} + +\index{prepare\_testbase() (src.test\_module.Test method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.test_module.Test.prepare_testbase}\pysiglinewithargsret{\bfcode{prepare\_testbase}}{\emph{test\_base\_name}}{} +\end{fulllineitems} + +\index{prepare\_testbase\_from\_dir() (src.test\_module.Test method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.test_module.Test.prepare_testbase_from_dir}\pysiglinewithargsret{\bfcode{prepare\_testbase\_from\_dir}}{\emph{testbase\_name}, \emph{testbase\_dir}}{} +\end{fulllineitems} + +\index{prepare\_testbase\_from\_git() (src.test\_module.Test method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.test_module.Test.prepare_testbase_from_git}\pysiglinewithargsret{\bfcode{prepare\_testbase\_from\_git}}{\emph{testbase\_name}, \emph{testbase\_base}, \emph{testbase\_tag}}{} +\end{fulllineitems} + +\index{prepare\_testbase\_from\_svn() (src.test\_module.Test method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.test_module.Test.prepare_testbase_from_svn}\pysiglinewithargsret{\bfcode{prepare\_testbase\_from\_svn}}{\emph{user}, \emph{testbase\_name}, \emph{testbase\_base}}{} +\end{fulllineitems} + +\index{read\_results() (src.test\_module.Test method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.test_module.Test.read_results}\pysiglinewithargsret{\bfcode{read\_results}}{\emph{listTest}, \emph{has\_timed\_out}}{} +\end{fulllineitems} + +\index{run\_all\_tests() (src.test\_module.Test method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.test_module.Test.run_all_tests}\pysiglinewithargsret{\bfcode{run\_all\_tests}}{}{} +\end{fulllineitems} + +\index{run\_grid\_tests() (src.test\_module.Test method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.test_module.Test.run_grid_tests}\pysiglinewithargsret{\bfcode{run\_grid\_tests}}{}{} +\end{fulllineitems} + +\index{run\_script() (src.test\_module.Test method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.test_module.Test.run_script}\pysiglinewithargsret{\bfcode{run\_script}}{\emph{script\_name}}{} +\end{fulllineitems} + +\index{run\_session\_tests() (src.test\_module.Test method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.test_module.Test.run_session_tests}\pysiglinewithargsret{\bfcode{run\_session\_tests}}{}{} +\end{fulllineitems} + +\index{run\_testbase\_tests() (src.test\_module.Test method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.test_module.Test.run_testbase_tests}\pysiglinewithargsret{\bfcode{run\_testbase\_tests}}{}{} +\end{fulllineitems} + +\index{run\_tests() (src.test\_module.Test method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.test_module.Test.run_tests}\pysiglinewithargsret{\bfcode{run\_tests}}{\emph{listTest}, \emph{ignoreList}}{} +\end{fulllineitems} + +\index{search\_known\_errors() (src.test\_module.Test method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.test_module.Test.search_known_errors}\pysiglinewithargsret{\bfcode{search\_known\_errors}}{\emph{status}, \emph{test\_grid}, \emph{test\_session}, \emph{test}}{} +\end{fulllineitems} + +\index{write\_test\_margin() (src.test\_module.Test method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.test_module.Test.write_test_margin}\pysiglinewithargsret{\bfcode{write\_test\_margin}}{\emph{tab}}{} +\end{fulllineitems} + + +\end{fulllineitems} + +\index{getTmpDirDEFAULT() (in module src.test\_module)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.test_module.getTmpDirDEFAULT}\pysiglinewithargsret{\code{src.test\_module.}\bfcode{getTmpDirDEFAULT}}{}{} +\end{fulllineitems} + + + +\subsubsection{\texttt{xmlManager} Module} +\label{commands/apidoc/src:xmlmanager-module}\label{commands/apidoc/src:module-src.xmlManager}\index{src.xmlManager (module)}\index{ReadXmlFile (class in src.xmlManager)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.xmlManager.ReadXmlFile}\pysiglinewithargsret{\strong{class }\code{src.xmlManager.}\bfcode{ReadXmlFile}}{\emph{filePath}}{} +Bases: \code{object} + +Class to manage reading of an xml log file +\index{getRootAttrib() (src.xmlManager.ReadXmlFile method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.xmlManager.ReadXmlFile.getRootAttrib}\pysiglinewithargsret{\bfcode{getRootAttrib}}{}{} +Get the attibutes of the self.xmlroot +\begin{quote}\begin{description} +\item[{Returns}] \leavevmode +The attributes of the root node + +\item[{Return type}] \leavevmode +dict + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{get\_attrib() (src.xmlManager.ReadXmlFile method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.xmlManager.ReadXmlFile.get_attrib}\pysiglinewithargsret{\bfcode{get\_attrib}}{\emph{node\_name}}{} +Get the attibutes of the node node\_name in self.xmlroot +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{str} (\emph{node\_name}) -- the name of the node + +\item[{Returns}] \leavevmode +the attibutes of the node node\_name in self.xmlroot + +\item[{Return type}] \leavevmode +dict + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{get\_node\_text() (src.xmlManager.ReadXmlFile method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.xmlManager.ReadXmlFile.get_node_text}\pysiglinewithargsret{\bfcode{get\_node\_text}}{\emph{node}}{} +Get the text of the first node that has name +that corresponds to the parameter node +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{str} (\emph{node}) -- the name of the node from which get the text + +\item[{Returns}] \leavevmode +the text of the first node that has name +that corresponds to the parameter node + +\item[{Return type}] \leavevmode +str + +\end{description}\end{quote} + +\end{fulllineitems} + + +\end{fulllineitems} + +\index{XmlLogFile (class in src.xmlManager)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.xmlManager.XmlLogFile}\pysiglinewithargsret{\strong{class }\code{src.xmlManager.}\bfcode{XmlLogFile}}{\emph{filePath}, \emph{rootname}, \emph{attrib=\{\}}}{} +Bases: \code{object} + +Class to manage writing in salomeTools xml log file +\index{add\_simple\_node() (src.xmlManager.XmlLogFile method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.xmlManager.XmlLogFile.add_simple_node}\pysiglinewithargsret{\bfcode{add\_simple\_node}}{\emph{node\_name}, \emph{text=None}, \emph{attrib=\{\}}}{} +Add a node with some attibutes and text to the root node. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{str} (\emph{text}) -- the name of the node to add + +\item {} +\textbf{str} -- the text of the node + +\item {} +\textbf{dict} (\emph{attrib}) -- the dictionary containing the +attribute of the new node + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{append\_node\_attrib() (src.xmlManager.XmlLogFile method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.xmlManager.XmlLogFile.append_node_attrib}\pysiglinewithargsret{\bfcode{append\_node\_attrib}}{\emph{node\_name}, \emph{attrib}}{} +Append a new attributes to the node that has node\_name as name +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{str} (\emph{node\_name}) -- The name of the node on which append text + +\item {} +\textbf{dixt} (\emph{attrib}) -- The attrib to append + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{append\_node\_text() (src.xmlManager.XmlLogFile method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.xmlManager.XmlLogFile.append_node_text}\pysiglinewithargsret{\bfcode{append\_node\_text}}{\emph{node\_name}, \emph{text}}{} +Append a new text to the node that has node\_name as name +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{str} (\emph{text}) -- The name of the node on which append text + +\item {} +\textbf{str} -- The text to append + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{write\_tree() (src.xmlManager.XmlLogFile method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.xmlManager.XmlLogFile.write_tree}\pysiglinewithargsret{\bfcode{write\_tree}}{\emph{stylesheet=None}, \emph{file\_path=None}}{} +Write the xml tree in the log file path. Add the stylesheet if asked. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\textbf{str} (\emph{stylesheet}) -- The stylesheet to apply to the xml file + +\end{description}\end{quote} + +\end{fulllineitems} + + +\end{fulllineitems} + +\index{add\_simple\_node() (in module src.xmlManager)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.xmlManager.add_simple_node}\pysiglinewithargsret{\code{src.xmlManager.}\bfcode{add\_simple\_node}}{\emph{root\_node}, \emph{node\_name}, \emph{text=None}, \emph{attrib=\{\}}}{} +Add a node with some attibutes and text to the root node. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{etree.Element} (\emph{root\_node}) -- the Etree element where to add the new node + +\item {} +\textbf{str} (\emph{text}) -- the name of the node to add + +\item {} +\textbf{str} -- the text of the node + +\item {} +\textbf{dict} (\emph{attrib}) -- the dictionary containing the +attribute of the new node + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{append\_node\_attrib() (in module src.xmlManager)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.xmlManager.append_node_attrib}\pysiglinewithargsret{\code{src.xmlManager.}\bfcode{append\_node\_attrib}}{\emph{root\_node}, \emph{attrib}}{} +Append a new attributes to the node that has node\_name as name +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{etree.Element} (\emph{root\_node}) -- the Etree element +where to append the new attibutes + +\item {} +\textbf{dixt} (\emph{attrib}) -- The attrib to append + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{find\_node\_by\_attrib() (in module src.xmlManager)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.xmlManager.find_node_by_attrib}\pysiglinewithargsret{\code{src.xmlManager.}\bfcode{find\_node\_by\_attrib}}{\emph{xmlroot}, \emph{name\_node}, \emph{key}, \emph{value}}{} +Find the nfirst ode from xmlroot that has name name\_node and that has in +its attributes \{key : value\}. Return the node +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{etree.Element} (\emph{xmlroot}) -- the Etree element where to search + +\item {} +\textbf{str} (\emph{value}) -- the name of node to search + +\item {} +\textbf{str} -- the key to search + +\item {} +\textbf{str} -- the value to search + +\end{itemize} + +\item[{Returns}] \leavevmode +the found node + +\item[{Return type}] \leavevmode +xmlroot etree.Element + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{write\_report() (in module src.xmlManager)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src:src.xmlManager.write_report}\pysiglinewithargsret{\code{src.xmlManager.}\bfcode{write\_report}}{\emph{filename}, \emph{xmlroot}, \emph{stylesheet}}{} +Writes a report file from a XML tree. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\textbf{str} (\emph{stylesheet}) -- The path to the file to create + +\item {} +\textbf{etree.Element} (\emph{xmlroot}) -- the Etree element to write to the file + +\item {} +\textbf{str} -- The stylesheet to add to the begin of the file + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + + + +\subsubsection{Subpackages} +\label{commands/apidoc/src:subpackages} + +\paragraph{colorama Package} +\label{commands/apidoc/src.colorama:colorama-package}\label{commands/apidoc/src.colorama::doc} + +\subparagraph{\texttt{colorama} Package} +\label{commands/apidoc/src.colorama:id1}\phantomsection\label{commands/apidoc/src.colorama:module-src.colorama}\index{src.colorama (module)} + +\subparagraph{\texttt{ansi} Module} +\label{commands/apidoc/src.colorama:module-src.colorama.ansi}\label{commands/apidoc/src.colorama:ansi-module}\index{src.colorama.ansi (module)} +This module generates ANSI character codes to printing colors to terminals. +See: \href{http://en.wikipedia.org/wiki/ANSI\_escape\_code}{http://en.wikipedia.org/wiki/ANSI\_escape\_code} +\index{AnsiBack (class in src.colorama.ansi)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack}\pysigline{\strong{class }\code{src.colorama.ansi.}\bfcode{AnsiBack}} +Bases: {\hyperref[commands/apidoc/src.colorama:src.colorama.ansi.AnsiCodes]{\code{src.colorama.ansi.AnsiCodes}}} +\index{BLACK (src.colorama.ansi.AnsiBack attribute)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.BLACK}\pysigline{\bfcode{BLACK}\strong{ = 40}} +\end{fulllineitems} + +\index{BLUE (src.colorama.ansi.AnsiBack attribute)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.BLUE}\pysigline{\bfcode{BLUE}\strong{ = 44}} +\end{fulllineitems} + +\index{CYAN (src.colorama.ansi.AnsiBack attribute)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.CYAN}\pysigline{\bfcode{CYAN}\strong{ = 46}} +\end{fulllineitems} + +\index{GREEN (src.colorama.ansi.AnsiBack attribute)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.GREEN}\pysigline{\bfcode{GREEN}\strong{ = 42}} +\end{fulllineitems} + +\index{LIGHTBLACK\_EX (src.colorama.ansi.AnsiBack attribute)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTBLACK_EX}\pysigline{\bfcode{LIGHTBLACK\_EX}\strong{ = 100}} +\end{fulllineitems} + +\index{LIGHTBLUE\_EX (src.colorama.ansi.AnsiBack attribute)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTBLUE_EX}\pysigline{\bfcode{LIGHTBLUE\_EX}\strong{ = 104}} +\end{fulllineitems} + +\index{LIGHTCYAN\_EX (src.colorama.ansi.AnsiBack attribute)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTCYAN_EX}\pysigline{\bfcode{LIGHTCYAN\_EX}\strong{ = 106}} +\end{fulllineitems} + +\index{LIGHTGREEN\_EX (src.colorama.ansi.AnsiBack attribute)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTGREEN_EX}\pysigline{\bfcode{LIGHTGREEN\_EX}\strong{ = 102}} +\end{fulllineitems} + +\index{LIGHTMAGENTA\_EX (src.colorama.ansi.AnsiBack attribute)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTMAGENTA_EX}\pysigline{\bfcode{LIGHTMAGENTA\_EX}\strong{ = 105}} +\end{fulllineitems} + +\index{LIGHTRED\_EX (src.colorama.ansi.AnsiBack attribute)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTRED_EX}\pysigline{\bfcode{LIGHTRED\_EX}\strong{ = 101}} +\end{fulllineitems} + +\index{LIGHTWHITE\_EX (src.colorama.ansi.AnsiBack attribute)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTWHITE_EX}\pysigline{\bfcode{LIGHTWHITE\_EX}\strong{ = 107}} +\end{fulllineitems} + +\index{LIGHTYELLOW\_EX (src.colorama.ansi.AnsiBack attribute)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTYELLOW_EX}\pysigline{\bfcode{LIGHTYELLOW\_EX}\strong{ = 103}} +\end{fulllineitems} + +\index{MAGENTA (src.colorama.ansi.AnsiBack attribute)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.MAGENTA}\pysigline{\bfcode{MAGENTA}\strong{ = 45}} +\end{fulllineitems} + +\index{RED (src.colorama.ansi.AnsiBack attribute)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.RED}\pysigline{\bfcode{RED}\strong{ = 41}} +\end{fulllineitems} + +\index{RESET (src.colorama.ansi.AnsiBack attribute)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.RESET}\pysigline{\bfcode{RESET}\strong{ = 49}} +\end{fulllineitems} + +\index{WHITE (src.colorama.ansi.AnsiBack attribute)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.WHITE}\pysigline{\bfcode{WHITE}\strong{ = 47}} +\end{fulllineitems} + +\index{YELLOW (src.colorama.ansi.AnsiBack attribute)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.YELLOW}\pysigline{\bfcode{YELLOW}\strong{ = 43}} +\end{fulllineitems} + + +\end{fulllineitems} + +\index{AnsiCodes (class in src.colorama.ansi)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCodes}\pysigline{\strong{class }\code{src.colorama.ansi.}\bfcode{AnsiCodes}} +Bases: \code{object} + +\end{fulllineitems} + +\index{AnsiCursor (class in src.colorama.ansi)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor}\pysigline{\strong{class }\code{src.colorama.ansi.}\bfcode{AnsiCursor}} +Bases: \code{object} +\index{BACK() (src.colorama.ansi.AnsiCursor method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.BACK}\pysiglinewithargsret{\bfcode{BACK}}{\emph{n=1}}{} +\end{fulllineitems} + +\index{DOWN() (src.colorama.ansi.AnsiCursor method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.DOWN}\pysiglinewithargsret{\bfcode{DOWN}}{\emph{n=1}}{} +\end{fulllineitems} + +\index{FORWARD() (src.colorama.ansi.AnsiCursor method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.FORWARD}\pysiglinewithargsret{\bfcode{FORWARD}}{\emph{n=1}}{} +\end{fulllineitems} + +\index{POS() (src.colorama.ansi.AnsiCursor method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.POS}\pysiglinewithargsret{\bfcode{POS}}{\emph{x=1}, \emph{y=1}}{} +\end{fulllineitems} + +\index{UP() (src.colorama.ansi.AnsiCursor method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.UP}\pysiglinewithargsret{\bfcode{UP}}{\emph{n=1}}{} +\end{fulllineitems} + + +\end{fulllineitems} + +\index{AnsiFore (class in src.colorama.ansi)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore}\pysigline{\strong{class }\code{src.colorama.ansi.}\bfcode{AnsiFore}} +Bases: {\hyperref[commands/apidoc/src.colorama:src.colorama.ansi.AnsiCodes]{\code{src.colorama.ansi.AnsiCodes}}} +\index{BLACK (src.colorama.ansi.AnsiFore attribute)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.BLACK}\pysigline{\bfcode{BLACK}\strong{ = 30}} +\end{fulllineitems} + +\index{BLUE (src.colorama.ansi.AnsiFore attribute)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.BLUE}\pysigline{\bfcode{BLUE}\strong{ = 34}} +\end{fulllineitems} + +\index{CYAN (src.colorama.ansi.AnsiFore attribute)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.CYAN}\pysigline{\bfcode{CYAN}\strong{ = 36}} +\end{fulllineitems} + +\index{GREEN (src.colorama.ansi.AnsiFore attribute)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.GREEN}\pysigline{\bfcode{GREEN}\strong{ = 32}} +\end{fulllineitems} + +\index{LIGHTBLACK\_EX (src.colorama.ansi.AnsiFore attribute)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTBLACK_EX}\pysigline{\bfcode{LIGHTBLACK\_EX}\strong{ = 90}} +\end{fulllineitems} + +\index{LIGHTBLUE\_EX (src.colorama.ansi.AnsiFore attribute)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTBLUE_EX}\pysigline{\bfcode{LIGHTBLUE\_EX}\strong{ = 94}} +\end{fulllineitems} + +\index{LIGHTCYAN\_EX (src.colorama.ansi.AnsiFore attribute)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTCYAN_EX}\pysigline{\bfcode{LIGHTCYAN\_EX}\strong{ = 96}} +\end{fulllineitems} + +\index{LIGHTGREEN\_EX (src.colorama.ansi.AnsiFore attribute)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTGREEN_EX}\pysigline{\bfcode{LIGHTGREEN\_EX}\strong{ = 92}} +\end{fulllineitems} + +\index{LIGHTMAGENTA\_EX (src.colorama.ansi.AnsiFore attribute)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTMAGENTA_EX}\pysigline{\bfcode{LIGHTMAGENTA\_EX}\strong{ = 95}} +\end{fulllineitems} + +\index{LIGHTRED\_EX (src.colorama.ansi.AnsiFore attribute)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTRED_EX}\pysigline{\bfcode{LIGHTRED\_EX}\strong{ = 91}} +\end{fulllineitems} + +\index{LIGHTWHITE\_EX (src.colorama.ansi.AnsiFore attribute)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTWHITE_EX}\pysigline{\bfcode{LIGHTWHITE\_EX}\strong{ = 97}} +\end{fulllineitems} + +\index{LIGHTYELLOW\_EX (src.colorama.ansi.AnsiFore attribute)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTYELLOW_EX}\pysigline{\bfcode{LIGHTYELLOW\_EX}\strong{ = 93}} +\end{fulllineitems} + +\index{MAGENTA (src.colorama.ansi.AnsiFore attribute)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.MAGENTA}\pysigline{\bfcode{MAGENTA}\strong{ = 35}} +\end{fulllineitems} + +\index{RED (src.colorama.ansi.AnsiFore attribute)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.RED}\pysigline{\bfcode{RED}\strong{ = 31}} +\end{fulllineitems} + +\index{RESET (src.colorama.ansi.AnsiFore attribute)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.RESET}\pysigline{\bfcode{RESET}\strong{ = 39}} +\end{fulllineitems} + +\index{WHITE (src.colorama.ansi.AnsiFore attribute)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.WHITE}\pysigline{\bfcode{WHITE}\strong{ = 37}} +\end{fulllineitems} + +\index{YELLOW (src.colorama.ansi.AnsiFore attribute)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.YELLOW}\pysigline{\bfcode{YELLOW}\strong{ = 33}} +\end{fulllineitems} + + +\end{fulllineitems} + +\index{AnsiStyle (class in src.colorama.ansi)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle}\pysigline{\strong{class }\code{src.colorama.ansi.}\bfcode{AnsiStyle}} +Bases: {\hyperref[commands/apidoc/src.colorama:src.colorama.ansi.AnsiCodes]{\code{src.colorama.ansi.AnsiCodes}}} +\index{BRIGHT (src.colorama.ansi.AnsiStyle attribute)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle.BRIGHT}\pysigline{\bfcode{BRIGHT}\strong{ = 1}} +\end{fulllineitems} + +\index{DIM (src.colorama.ansi.AnsiStyle attribute)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle.DIM}\pysigline{\bfcode{DIM}\strong{ = 2}} +\end{fulllineitems} + +\index{NORMAL (src.colorama.ansi.AnsiStyle attribute)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle.NORMAL}\pysigline{\bfcode{NORMAL}\strong{ = 22}} +\end{fulllineitems} + +\index{RESET\_ALL (src.colorama.ansi.AnsiStyle attribute)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle.RESET_ALL}\pysigline{\bfcode{RESET\_ALL}\strong{ = 0}} +\end{fulllineitems} + + +\end{fulllineitems} + +\index{clear\_line() (in module src.colorama.ansi)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.clear_line}\pysiglinewithargsret{\code{src.colorama.ansi.}\bfcode{clear\_line}}{\emph{mode=2}}{} +\end{fulllineitems} + +\index{clear\_screen() (in module src.colorama.ansi)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.clear_screen}\pysiglinewithargsret{\code{src.colorama.ansi.}\bfcode{clear\_screen}}{\emph{mode=2}}{} +\end{fulllineitems} + +\index{code\_to\_chars() (in module src.colorama.ansi)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.code_to_chars}\pysiglinewithargsret{\code{src.colorama.ansi.}\bfcode{code\_to\_chars}}{\emph{code}}{} +\end{fulllineitems} + +\index{set\_title() (in module src.colorama.ansi)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansi.set_title}\pysiglinewithargsret{\code{src.colorama.ansi.}\bfcode{set\_title}}{\emph{title}}{} +\end{fulllineitems} + + + +\subparagraph{\texttt{ansitowin32} Module} +\label{commands/apidoc/src.colorama:ansitowin32-module}\label{commands/apidoc/src.colorama:module-src.colorama.ansitowin32}\index{src.colorama.ansitowin32 (module)}\index{AnsiToWin32 (class in src.colorama.ansitowin32)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32}\pysiglinewithargsret{\strong{class }\code{src.colorama.ansitowin32.}\bfcode{AnsiToWin32}}{\emph{wrapped}, \emph{convert=None}, \emph{strip=None}, \emph{autoreset=False}}{} +Bases: \code{object} + +Implements a `write()' method which, on Windows, will strip ANSI character +sequences from the text, and if outputting to a tty, will convert them into +win32 function calls. +\index{ANSI\_CSI\_RE (src.colorama.ansitowin32.AnsiToWin32 attribute)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.ANSI_CSI_RE}\pysigline{\bfcode{ANSI\_CSI\_RE}\strong{ = \textless{}\_sre.SRE\_Pattern object at 0x3ff4610\textgreater{}}} +\end{fulllineitems} + +\index{ANSI\_OSC\_RE (src.colorama.ansitowin32.AnsiToWin32 attribute)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.ANSI_OSC_RE}\pysigline{\bfcode{ANSI\_OSC\_RE}\strong{ = \textless{}\_sre.SRE\_Pattern object at 0x42d2cf0\textgreater{}}} +\end{fulllineitems} + +\index{call\_win32() (src.colorama.ansitowin32.AnsiToWin32 method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.call_win32}\pysiglinewithargsret{\bfcode{call\_win32}}{\emph{command}, \emph{params}}{} +\end{fulllineitems} + +\index{convert\_ansi() (src.colorama.ansitowin32.AnsiToWin32 method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.convert_ansi}\pysiglinewithargsret{\bfcode{convert\_ansi}}{\emph{paramstring}, \emph{command}}{} +\end{fulllineitems} + +\index{convert\_osc() (src.colorama.ansitowin32.AnsiToWin32 method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.convert_osc}\pysiglinewithargsret{\bfcode{convert\_osc}}{\emph{text}}{} +\end{fulllineitems} + +\index{extract\_params() (src.colorama.ansitowin32.AnsiToWin32 method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.extract_params}\pysiglinewithargsret{\bfcode{extract\_params}}{\emph{command}, \emph{paramstring}}{} +\end{fulllineitems} + +\index{get\_win32\_calls() (src.colorama.ansitowin32.AnsiToWin32 method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.get_win32_calls}\pysiglinewithargsret{\bfcode{get\_win32\_calls}}{}{} +\end{fulllineitems} + +\index{reset\_all() (src.colorama.ansitowin32.AnsiToWin32 method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.reset_all}\pysiglinewithargsret{\bfcode{reset\_all}}{}{} +\end{fulllineitems} + +\index{should\_wrap() (src.colorama.ansitowin32.AnsiToWin32 method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.should_wrap}\pysiglinewithargsret{\bfcode{should\_wrap}}{}{} +True if this class is actually needed. If false, then the output +stream will not be affected, nor will win32 calls be issued, so +wrapping stdout is not actually required. This will generally be +False on non-Windows platforms, unless optional functionality like +autoreset has been requested using kwargs to init() + +\end{fulllineitems} + +\index{write() (src.colorama.ansitowin32.AnsiToWin32 method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.write}\pysiglinewithargsret{\bfcode{write}}{\emph{text}}{} +\end{fulllineitems} + +\index{write\_and\_convert() (src.colorama.ansitowin32.AnsiToWin32 method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.write_and_convert}\pysiglinewithargsret{\bfcode{write\_and\_convert}}{\emph{text}}{} +Write the given text to our wrapped stream, stripping any ANSI +sequences from the text, and optionally converting them into win32 +calls. + +\end{fulllineitems} + +\index{write\_plain\_text() (src.colorama.ansitowin32.AnsiToWin32 method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.write_plain_text}\pysiglinewithargsret{\bfcode{write\_plain\_text}}{\emph{text}, \emph{start}, \emph{end}}{} +\end{fulllineitems} + + +\end{fulllineitems} + +\index{StreamWrapper (class in src.colorama.ansitowin32)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansitowin32.StreamWrapper}\pysiglinewithargsret{\strong{class }\code{src.colorama.ansitowin32.}\bfcode{StreamWrapper}}{\emph{wrapped}, \emph{converter}}{} +Bases: \code{object} + +Wraps a stream (such as stdout), acting as a transparent proxy for all +attribute access apart from method `write()', which is delegated to our +Converter instance. +\index{write() (src.colorama.ansitowin32.StreamWrapper method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansitowin32.StreamWrapper.write}\pysiglinewithargsret{\bfcode{write}}{\emph{text}}{} +\end{fulllineitems} + + +\end{fulllineitems} + +\index{is\_a\_tty() (in module src.colorama.ansitowin32)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansitowin32.is_a_tty}\pysiglinewithargsret{\code{src.colorama.ansitowin32.}\bfcode{is\_a\_tty}}{\emph{stream}}{} +\end{fulllineitems} + +\index{is\_stream\_closed() (in module src.colorama.ansitowin32)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.ansitowin32.is_stream_closed}\pysiglinewithargsret{\code{src.colorama.ansitowin32.}\bfcode{is\_stream\_closed}}{\emph{stream}}{} +\end{fulllineitems} + + + +\subparagraph{\texttt{initialise} Module} +\label{commands/apidoc/src.colorama:initialise-module}\label{commands/apidoc/src.colorama:module-src.colorama.initialise}\index{src.colorama.initialise (module)}\index{colorama\_text() (in module src.colorama.initialise)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.initialise.colorama_text}\pysiglinewithargsret{\code{src.colorama.initialise.}\bfcode{colorama\_text}}{\emph{*args}, \emph{**kwds}}{} +\end{fulllineitems} + +\index{deinit() (in module src.colorama.initialise)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.initialise.deinit}\pysiglinewithargsret{\code{src.colorama.initialise.}\bfcode{deinit}}{}{} +\end{fulllineitems} + +\index{init() (in module src.colorama.initialise)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.initialise.init}\pysiglinewithargsret{\code{src.colorama.initialise.}\bfcode{init}}{\emph{autoreset=False}, \emph{convert=None}, \emph{strip=None}, \emph{wrap=True}}{} +\end{fulllineitems} + +\index{reinit() (in module src.colorama.initialise)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.initialise.reinit}\pysiglinewithargsret{\code{src.colorama.initialise.}\bfcode{reinit}}{}{} +\end{fulllineitems} + +\index{reset\_all() (in module src.colorama.initialise)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.initialise.reset_all}\pysiglinewithargsret{\code{src.colorama.initialise.}\bfcode{reset\_all}}{}{} +\end{fulllineitems} + +\index{wrap\_stream() (in module src.colorama.initialise)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.initialise.wrap_stream}\pysiglinewithargsret{\code{src.colorama.initialise.}\bfcode{wrap\_stream}}{\emph{stream}, \emph{convert}, \emph{strip}, \emph{autoreset}, \emph{wrap}}{} +\end{fulllineitems} + + + +\subparagraph{\texttt{win32} Module} +\label{commands/apidoc/src.colorama:win32-module}\label{commands/apidoc/src.colorama:module-src.colorama.win32}\index{src.colorama.win32 (module)}\index{SetConsoleTextAttribute() (in module src.colorama.win32)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.win32.SetConsoleTextAttribute}\pysiglinewithargsret{\code{src.colorama.win32.}\bfcode{SetConsoleTextAttribute}}{\emph{*\_}}{} +\end{fulllineitems} + +\index{winapi\_test() (in module src.colorama.win32)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.win32.winapi_test}\pysiglinewithargsret{\code{src.colorama.win32.}\bfcode{winapi\_test}}{\emph{*\_}}{} +\end{fulllineitems} + + + +\subparagraph{\texttt{winterm} Module} +\label{commands/apidoc/src.colorama:winterm-module}\label{commands/apidoc/src.colorama:module-src.colorama.winterm}\index{src.colorama.winterm (module)}\index{WinColor (class in src.colorama.winterm)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinColor}\pysigline{\strong{class }\code{src.colorama.winterm.}\bfcode{WinColor}} +Bases: \code{object} +\index{BLACK (src.colorama.winterm.WinColor attribute)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.BLACK}\pysigline{\bfcode{BLACK}\strong{ = 0}} +\end{fulllineitems} + +\index{BLUE (src.colorama.winterm.WinColor attribute)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.BLUE}\pysigline{\bfcode{BLUE}\strong{ = 1}} +\end{fulllineitems} + +\index{CYAN (src.colorama.winterm.WinColor attribute)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.CYAN}\pysigline{\bfcode{CYAN}\strong{ = 3}} +\end{fulllineitems} + +\index{GREEN (src.colorama.winterm.WinColor attribute)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.GREEN}\pysigline{\bfcode{GREEN}\strong{ = 2}} +\end{fulllineitems} + +\index{GREY (src.colorama.winterm.WinColor attribute)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.GREY}\pysigline{\bfcode{GREY}\strong{ = 7}} +\end{fulllineitems} + +\index{MAGENTA (src.colorama.winterm.WinColor attribute)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.MAGENTA}\pysigline{\bfcode{MAGENTA}\strong{ = 5}} +\end{fulllineitems} + +\index{RED (src.colorama.winterm.WinColor attribute)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.RED}\pysigline{\bfcode{RED}\strong{ = 4}} +\end{fulllineitems} + +\index{YELLOW (src.colorama.winterm.WinColor attribute)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.YELLOW}\pysigline{\bfcode{YELLOW}\strong{ = 6}} +\end{fulllineitems} + + +\end{fulllineitems} + +\index{WinStyle (class in src.colorama.winterm)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinStyle}\pysigline{\strong{class }\code{src.colorama.winterm.}\bfcode{WinStyle}} +Bases: \code{object} +\index{BRIGHT (src.colorama.winterm.WinStyle attribute)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinStyle.BRIGHT}\pysigline{\bfcode{BRIGHT}\strong{ = 8}} +\end{fulllineitems} + +\index{BRIGHT\_BACKGROUND (src.colorama.winterm.WinStyle attribute)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinStyle.BRIGHT_BACKGROUND}\pysigline{\bfcode{BRIGHT\_BACKGROUND}\strong{ = 128}} +\end{fulllineitems} + +\index{NORMAL (src.colorama.winterm.WinStyle attribute)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinStyle.NORMAL}\pysigline{\bfcode{NORMAL}\strong{ = 0}} +\end{fulllineitems} + + +\end{fulllineitems} + +\index{WinTerm (class in src.colorama.winterm)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm}\pysigline{\strong{class }\code{src.colorama.winterm.}\bfcode{WinTerm}} +Bases: \code{object} +\index{back() (src.colorama.winterm.WinTerm method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.back}\pysiglinewithargsret{\bfcode{back}}{\emph{back=None}, \emph{light=False}, \emph{on\_stderr=False}}{} +\end{fulllineitems} + +\index{cursor\_adjust() (src.colorama.winterm.WinTerm method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.cursor_adjust}\pysiglinewithargsret{\bfcode{cursor\_adjust}}{\emph{x}, \emph{y}, \emph{on\_stderr=False}}{} +\end{fulllineitems} + +\index{erase\_line() (src.colorama.winterm.WinTerm method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.erase_line}\pysiglinewithargsret{\bfcode{erase\_line}}{\emph{mode=0}, \emph{on\_stderr=False}}{} +\end{fulllineitems} + +\index{erase\_screen() (src.colorama.winterm.WinTerm method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.erase_screen}\pysiglinewithargsret{\bfcode{erase\_screen}}{\emph{mode=0}, \emph{on\_stderr=False}}{} +\end{fulllineitems} + +\index{fore() (src.colorama.winterm.WinTerm method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.fore}\pysiglinewithargsret{\bfcode{fore}}{\emph{fore=None}, \emph{light=False}, \emph{on\_stderr=False}}{} +\end{fulllineitems} + +\index{get\_attrs() (src.colorama.winterm.WinTerm method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.get_attrs}\pysiglinewithargsret{\bfcode{get\_attrs}}{}{} +\end{fulllineitems} + +\index{get\_position() (src.colorama.winterm.WinTerm method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.get_position}\pysiglinewithargsret{\bfcode{get\_position}}{\emph{handle}}{} +\end{fulllineitems} + +\index{reset\_all() (src.colorama.winterm.WinTerm method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.reset_all}\pysiglinewithargsret{\bfcode{reset\_all}}{\emph{on\_stderr=None}}{} +\end{fulllineitems} + +\index{set\_attrs() (src.colorama.winterm.WinTerm method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.set_attrs}\pysiglinewithargsret{\bfcode{set\_attrs}}{\emph{value}}{} +\end{fulllineitems} + +\index{set\_console() (src.colorama.winterm.WinTerm method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.set_console}\pysiglinewithargsret{\bfcode{set\_console}}{\emph{attrs=None}, \emph{on\_stderr=False}}{} +\end{fulllineitems} + +\index{set\_cursor\_position() (src.colorama.winterm.WinTerm method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.set_cursor_position}\pysiglinewithargsret{\bfcode{set\_cursor\_position}}{\emph{position=None}, \emph{on\_stderr=False}}{} +\end{fulllineitems} + +\index{set\_title() (src.colorama.winterm.WinTerm method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.set_title}\pysiglinewithargsret{\bfcode{set\_title}}{\emph{title}}{} +\end{fulllineitems} + +\index{style() (src.colorama.winterm.WinTerm method)} + +\begin{fulllineitems} +\phantomsection\label{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.style}\pysiglinewithargsret{\bfcode{style}}{\emph{style=None}, \emph{on\_stderr=False}}{} +\end{fulllineitems} + + +\end{fulllineitems} + + + +\chapter{Release Notes} +\label{index:release-notes} + +\section{Release notes} +\label{release_notes/release_notes_5.0.0:release-notes}\label{release_notes/release_notes_5.0.0::doc} +In construction. + + +\renewcommand{\indexname}{Python Module Index} +\begin{theindex} +\def\bigletter#1{{\Large\sffamily#1}\nopagebreak\vspace{1mm}} +\bigletter{s} +\item {\texttt{src.\_\_init\_\_}}, \pageref{commands/apidoc/src:module-src.__init__} +\item {\texttt{src.architecture}}, \pageref{commands/apidoc/src:module-src.architecture} +\item {\texttt{src.colorama}}, \pageref{commands/apidoc/src.colorama:module-src.colorama} +\item {\texttt{src.colorama.ansi}}, \pageref{commands/apidoc/src.colorama:module-src.colorama.ansi} +\item {\texttt{src.colorama.ansitowin32}}, \pageref{commands/apidoc/src.colorama:module-src.colorama.ansitowin32} +\item {\texttt{src.colorama.initialise}}, \pageref{commands/apidoc/src.colorama:module-src.colorama.initialise} +\item {\texttt{src.colorama.win32}}, \pageref{commands/apidoc/src.colorama:module-src.colorama.win32} +\item {\texttt{src.colorama.winterm}}, \pageref{commands/apidoc/src.colorama:module-src.colorama.winterm} +\item {\texttt{src.compilation}}, \pageref{commands/apidoc/src:module-src.compilation} +\item {\texttt{src.debug}}, \pageref{commands/apidoc/src:module-src.debug} +\item {\texttt{src.ElementTree}}, \pageref{commands/apidoc/src:module-src.ElementTree} +\item {\texttt{src.environment}}, \pageref{commands/apidoc/src:module-src.environment} +\item {\texttt{src.fileEnviron}}, \pageref{commands/apidoc/src:module-src.fileEnviron} +\item {\texttt{src.fork}}, \pageref{commands/apidoc/src:module-src.fork} +\item {\texttt{src.logger}}, \pageref{commands/apidoc/src:module-src.logger} +\item {\texttt{src.options}}, \pageref{commands/apidoc/src:module-src.options} +\item {\texttt{src.printcolors}}, \pageref{commands/apidoc/src:module-src.printcolors} +\item {\texttt{src.product}}, \pageref{commands/apidoc/src:module-src.product} +\item {\texttt{src.pyconf}}, \pageref{commands/apidoc/src:module-src.pyconf} +\item {\texttt{src.system}}, \pageref{commands/apidoc/src:module-src.system} +\item {\texttt{src.template}}, \pageref{commands/apidoc/src:module-src.template} +\item {\texttt{src.test\_module}}, \pageref{commands/apidoc/src:module-src.test_module} +\item {\texttt{src.xmlManager}}, \pageref{commands/apidoc/src:module-src.xmlManager} +\end{theindex} + +\renewcommand{\indexname}{Index} +\printindex +\end{document} diff --git a/doc/build/latex/salomeTools.toc b/doc/build/latex/salomeTools.toc new file mode 100644 index 0000000..44f82a3 --- /dev/null +++ b/doc/build/latex/salomeTools.toc @@ -0,0 +1,104 @@ +\babel@toc {english}{} +\contentsline {chapter}{\numberline {1}Quick start}{3}{chapter.1} +\contentsline {section}{\numberline {1.1}Installation}{3}{section.1.1} +\contentsline {section}{\numberline {1.2}Configuration}{3}{section.1.2} +\contentsline {subsection}{\numberline {1.2.1}Syntax}{3}{subsection.1.2.1} +\contentsline {subsection}{\numberline {1.2.2}Description}{3}{subsection.1.2.2} +\contentsline {subsubsection}{VARS section}{3}{subsubsection*.3} +\contentsline {subsubsection}{PRODUCTS section}{4}{subsubsection*.4} +\contentsline {subsubsection}{APPLICATION section}{4}{subsubsection*.5} +\contentsline {subsubsection}{USER section}{4}{subsubsection*.6} +\contentsline {section}{\numberline {1.3}Usage of SAlomeTools}{4}{section.1.3} +\contentsline {subsection}{\numberline {1.3.1}Usage}{4}{subsection.1.3.1} +\contentsline {subsubsection}{Options of sat}{4}{subsubsection*.7} +\contentsline {paragraph}{\emph {--help or -h}}{5}{paragraph*.8} +\contentsline {paragraph}{\emph {--debug or -g}}{5}{paragraph*.9} +\contentsline {paragraph}{\emph {--verbose or -v}}{5}{paragraph*.10} +\contentsline {subsection}{\numberline {1.3.2}Build a SALOME product}{5}{subsection.1.3.2} +\contentsline {subsubsection}{Get the list of available products}{5}{subsubsection*.11} +\contentsline {subsubsection}{Prepare sources of a product}{5}{subsubsection*.12} +\contentsline {subsubsection}{Compile SALOME}{5}{subsubsection*.13} +\contentsline {chapter}{\numberline {2}List of Commands}{7}{chapter.2} +\contentsline {section}{\numberline {2.1}Command config}{7}{section.2.1} +\contentsline {subsection}{\numberline {2.1.1}Description}{7}{subsection.2.1.1} +\contentsline {subsection}{\numberline {2.1.2}Usage}{7}{subsection.2.1.2} +\contentsline {subsection}{\numberline {2.1.3}Some useful configuration pathes}{8}{subsection.2.1.3} +\contentsline {section}{\numberline {2.2}Command prepare}{8}{section.2.2} +\contentsline {subsection}{\numberline {2.2.1}Description}{8}{subsection.2.2.1} +\contentsline {subsection}{\numberline {2.2.2}Remarks}{8}{subsection.2.2.2} +\contentsline {subsubsection}{VCS bases (git, svn, cvs)}{8}{subsubsection*.14} +\contentsline {subsubsection}{Dev mode}{9}{subsubsection*.15} +\contentsline {subsection}{\numberline {2.2.3}Usage}{9}{subsection.2.2.3} +\contentsline {subsection}{\numberline {2.2.4}Some useful configuration pathes}{9}{subsection.2.2.4} +\contentsline {section}{\numberline {2.3}Command compile}{10}{section.2.3} +\contentsline {subsection}{\numberline {2.3.1}Description}{10}{subsection.2.3.1} +\contentsline {subsection}{\numberline {2.3.2}Usage}{10}{subsection.2.3.2} +\contentsline {subsection}{\numberline {2.3.3}Some useful configuration pathes}{11}{subsection.2.3.3} +\contentsline {section}{\numberline {2.4}Command launcher}{11}{section.2.4} +\contentsline {subsection}{\numberline {2.4.1}Description}{11}{subsection.2.4.1} +\contentsline {subsection}{\numberline {2.4.2}Usage}{11}{subsection.2.4.2} +\contentsline {subsection}{\numberline {2.4.3}Configuration}{11}{subsection.2.4.3} +\contentsline {section}{\numberline {2.5}Command application}{12}{section.2.5} +\contentsline {subsection}{\numberline {2.5.1}Description}{12}{subsection.2.5.1} +\contentsline {subsection}{\numberline {2.5.2}Usage}{12}{subsection.2.5.2} +\contentsline {subsection}{\numberline {2.5.3}Some useful configuration pathes}{12}{subsection.2.5.3} +\contentsline {section}{\numberline {2.6}Command log}{13}{section.2.6} +\contentsline {subsection}{\numberline {2.6.1}Description}{13}{subsection.2.6.1} +\contentsline {subsection}{\numberline {2.6.2}Usage}{13}{subsection.2.6.2} +\contentsline {subsection}{\numberline {2.6.3}Some useful configuration pathes}{13}{subsection.2.6.3} +\contentsline {section}{\numberline {2.7}Command environ}{13}{section.2.7} +\contentsline {subsection}{\numberline {2.7.1}Description}{13}{subsection.2.7.1} +\contentsline {subsection}{\numberline {2.7.2}Usage}{14}{subsection.2.7.2} +\contentsline {subsection}{\numberline {2.7.3}Configuration}{14}{subsection.2.7.3} +\contentsline {section}{\numberline {2.8}Command clean}{15}{section.2.8} +\contentsline {subsection}{\numberline {2.8.1}Description}{15}{subsection.2.8.1} +\contentsline {subsection}{\numberline {2.8.2}Usage}{15}{subsection.2.8.2} +\contentsline {subsection}{\numberline {2.8.3}Availables options}{16}{subsection.2.8.3} +\contentsline {subsection}{\numberline {2.8.4}Some useful configuration pathes}{16}{subsection.2.8.4} +\contentsline {section}{\numberline {2.9}Command package}{16}{section.2.9} +\contentsline {subsection}{\numberline {2.9.1}Description}{16}{subsection.2.9.1} +\contentsline {subsection}{\numberline {2.9.2}Usage}{16}{subsection.2.9.2} +\contentsline {subsection}{\numberline {2.9.3}Some useful configuration pathes}{17}{subsection.2.9.3} +\contentsline {section}{\numberline {2.10}Command generate}{17}{section.2.10} +\contentsline {subsection}{\numberline {2.10.1}Description}{17}{subsection.2.10.1} +\contentsline {subsection}{\numberline {2.10.2}Remarks}{18}{subsection.2.10.2} +\contentsline {subsection}{\numberline {2.10.3}Usage}{18}{subsection.2.10.3} +\contentsline {chapter}{\numberline {3}Developer documentation}{19}{chapter.3} +\contentsline {section}{\numberline {3.1}Add a user custom command}{19}{section.3.1} +\contentsline {subsection}{\numberline {3.1.1}Introduction}{19}{subsection.3.1.1} +\contentsline {subsection}{\numberline {3.1.2}Basic requirements}{19}{subsection.3.1.2} +\contentsline {subsection}{\numberline {3.1.3}HowTo access salomeTools config and other commands}{20}{subsection.3.1.3} +\contentsline {subsection}{\numberline {3.1.4}HowTo logger}{20}{subsection.3.1.4} +\contentsline {subsection}{\numberline {3.1.5}HELLO example}{20}{subsection.3.1.5} +\contentsline {chapter}{\numberline {4}Code documentation}{23}{chapter.4} +\contentsline {section}{\numberline {4.1}src}{23}{section.4.1} +\contentsline {subsection}{\numberline {4.1.1}src Package}{23}{subsection.4.1.1} +\contentsline {subsubsection}{\texttt {src} Package}{23}{subsubsection*.16} +\contentsline {subsubsection}{\texttt {ElementTree} Module}{25}{subsubsection*.59} +\contentsline {subsubsection}{\texttt {architecture} Module}{26}{subsubsection*.91} +\contentsline {subsubsection}{\texttt {compilation} Module}{27}{subsubsection*.98} +\contentsline {subsubsection}{\texttt {debug} Module}{28}{subsubsection*.117} +\contentsline {subsubsection}{\texttt {environment} Module}{29}{subsubsection*.131} +\contentsline {subsubsection}{\texttt {fileEnviron} Module}{33}{subsubsection*.169} +\contentsline {subsubsection}{\texttt {fork} Module}{38}{subsubsection*.234} +\contentsline {subsubsection}{\texttt {logger} Module}{38}{subsubsection*.240} +\contentsline {subsubsection}{\texttt {options} Module}{40}{subsubsection*.253} +\contentsline {subsubsection}{\texttt {printcolors} Module}{41}{subsubsection*.259} +\contentsline {subsubsection}{\texttt {product} Module}{42}{subsubsection*.272} +\contentsline {subsubsection}{\texttt {pyconf} Module}{46}{subsubsection*.302} +\contentsline {subsubsection}{\texttt {system} Module}{53}{subsubsection*.374} +\contentsline {subsubsection}{\texttt {template} Module}{55}{subsubsection*.380} +\contentsline {subsubsection}{\texttt {test\_module} Module}{55}{subsubsection*.385} +\contentsline {subsubsection}{\texttt {xmlManager} Module}{56}{subsubsection*.405} +\contentsline {subsubsection}{Subpackages}{57}{subsubsection*.419} +\contentsline {paragraph}{colorama Package}{57}{paragraph*.420} +\contentsline {subparagraph}{\texttt {colorama} Package}{57}{subparagraph*.421} +\contentsline {subparagraph}{\texttt {ansi} Module}{57}{subparagraph*.423} +\contentsline {subparagraph}{\texttt {ansitowin32} Module}{59}{subparagraph*.476} +\contentsline {subparagraph}{\texttt {initialise} Module}{60}{subparagraph*.494} +\contentsline {subparagraph}{\texttt {win32} Module}{60}{subparagraph*.501} +\contentsline {subparagraph}{\texttt {winterm} Module}{60}{subparagraph*.504} +\contentsline {chapter}{\numberline {5}Release Notes}{63}{chapter.5} +\contentsline {section}{\numberline {5.1}Release notes}{63}{section.5.1} +\contentsline {chapter}{Python Module Index}{65}{section*.532} +\contentsline {chapter}{Index}{67}{section*.533} diff --git a/doc/build/latex/sat_about.png b/doc/build/latex/sat_about.png new file mode 100644 index 0000000..600d3d8 Binary files /dev/null and b/doc/build/latex/sat_about.png differ diff --git a/doc/build/latex/sphinx.sty b/doc/build/latex/sphinx.sty new file mode 100644 index 0000000..08adec9 --- /dev/null +++ b/doc/build/latex/sphinx.sty @@ -0,0 +1,478 @@ +% +% sphinx.sty +% +% Adapted from the old python.sty, mostly written by Fred Drake, +% by Georg Brandl. +% + +\NeedsTeXFormat{LaTeX2e}[1995/12/01] +\ProvidesPackage{sphinx}[2010/01/15 LaTeX package (Sphinx markup)] + +\RequirePackage{textcomp} +\RequirePackage{fancyhdr} +\RequirePackage{fancybox} +\RequirePackage{titlesec} +\RequirePackage{tabulary} +\RequirePackage{amsmath} % for \text +\RequirePackage{makeidx} +\RequirePackage{framed} +\RequirePackage{ifthen} +\RequirePackage{color} +% For highlighted code. +\RequirePackage{fancyvrb} +% For table captions. +\RequirePackage{threeparttable} +% Handle footnotes in tables. +\RequirePackage{footnote} +\makesavenoteenv{tabulary} +% For floating figures in the text. +\RequirePackage{wrapfig} +% Separate paragraphs by space by default. +\RequirePackage{parskip} + +% Redefine these colors to your liking in the preamble. +\definecolor{TitleColor}{rgb}{0.126,0.263,0.361} +\definecolor{InnerLinkColor}{rgb}{0.208,0.374,0.486} +\definecolor{OuterLinkColor}{rgb}{0.216,0.439,0.388} +% Redefine these colors to something not white if you want to have colored +% background and border for code examples. +\definecolor{VerbatimColor}{rgb}{1,1,1} +\definecolor{VerbatimBorderColor}{rgb}{1,1,1} + +% Uncomment these two lines to ignore the paper size and make the page +% size more like a typical published manual. +%\renewcommand{\paperheight}{9in} +%\renewcommand{\paperwidth}{8.5in} % typical squarish manual +%\renewcommand{\paperwidth}{7in} % O'Reilly ``Programmming Python'' + +% For graphicx, check if we are compiling under latex or pdflatex. +\ifx\pdftexversion\undefined + \usepackage{graphicx} +\else + \usepackage[pdftex]{graphicx} +\fi + +% for PDF output, use colors and maximal compression +\newif\ifsphinxpdfoutput\sphinxpdfoutputfalse +\ifx\pdfoutput\undefined\else\ifcase\pdfoutput + \let\py@NormalColor\relax + \let\py@TitleColor\relax +\else + \sphinxpdfoutputtrue + \input{pdfcolor} + \def\py@NormalColor{\color[rgb]{0.0,0.0,0.0}} + \def\py@TitleColor{\color{TitleColor}} + \pdfcompresslevel=9 +\fi\fi + +% XeLaTeX can do colors, too +\ifx\XeTeXrevision\undefined\else + \def\py@NormalColor{\color[rgb]{0.0,0.0,0.0}} + \def\py@TitleColor{\color{TitleColor}} +\fi + +% Increase printable page size (copied from fullpage.sty) +\topmargin 0pt +\advance \topmargin by -\headheight +\advance \topmargin by -\headsep + +% attempt to work a little better for A4 users +\textheight \paperheight +\advance\textheight by -2in + +\oddsidemargin 0pt +\evensidemargin 0pt +%\evensidemargin -.25in % for ``manual size'' documents +\marginparwidth 0.5in + +\textwidth \paperwidth +\advance\textwidth by -2in + + +% Style parameters and macros used by most documents here +\raggedbottom +\sloppy +\hbadness = 5000 % don't print trivial gripes + +\pagestyle{empty} % start this way; change for +\pagenumbering{roman} % ToC & chapters + +% Use this to set the font family for headers and other decor: +\newcommand{\py@HeaderFamily}{\sffamily\bfseries} + +% Redefine the 'normal' header/footer style when using "fancyhdr" package: +\@ifundefined{fancyhf}{}{ + % Use \pagestyle{normal} as the primary pagestyle for text. + \fancypagestyle{normal}{ + \fancyhf{} + \fancyfoot[LE,RO]{{\py@HeaderFamily\thepage}} + \fancyfoot[LO]{{\py@HeaderFamily\nouppercase{\rightmark}}} + \fancyfoot[RE]{{\py@HeaderFamily\nouppercase{\leftmark}}} + \fancyhead[LE,RO]{{\py@HeaderFamily \@title, \py@release}} + \renewcommand{\headrulewidth}{0.4pt} + \renewcommand{\footrulewidth}{0.4pt} + } + % Update the plain style so we get the page number & footer line, + % but not a chapter or section title. This is to keep the first + % page of a chapter and the blank page between chapters `clean.' + \fancypagestyle{plain}{ + \fancyhf{} + \fancyfoot[LE,RO]{{\py@HeaderFamily\thepage}} + \renewcommand{\headrulewidth}{0pt} + \renewcommand{\footrulewidth}{0.4pt} + } +} + +% Some custom font markup commands. +% +\newcommand{\strong}[1]{{\bf #1}} +\newcommand{\code}[1]{\texttt{#1}} +\newcommand{\bfcode}[1]{\code{\bfseries#1}} +\newcommand{\email}[1]{\textsf{#1}} + +% Redefine the Verbatim environment to allow border and background colors. +% The original environment is still used for verbatims within tables. +\let\OriginalVerbatim=\Verbatim +\let\endOriginalVerbatim=\endVerbatim + +% Play with vspace to be able to keep the indentation. +\newlength\distancetoright +\def\mycolorbox#1{% + \setlength\distancetoright{\linewidth}% + \advance\distancetoright -\@totalleftmargin % + \fcolorbox{VerbatimBorderColor}{VerbatimColor}{% + \begin{minipage}{\distancetoright}% + #1 + \end{minipage}% + }% +} +\def\FrameCommand{\mycolorbox} + +\renewcommand{\Verbatim}[1][1]{% + % list starts new par, but we don't want it to be set apart vertically + \bgroup\parskip=0pt% + \smallskip% + % The list environement is needed to control perfectly the vertical + % space. + \list{}{% + \setlength\parskip{0pt}% + \setlength\itemsep{0ex}% + \setlength\topsep{0ex}% + \setlength\partopsep{0pt}% + \setlength\leftmargin{0pt}% + }% + \item\MakeFramed {\FrameRestore}% + \small% + \OriginalVerbatim[#1]% +} +\renewcommand{\endVerbatim}{% + \endOriginalVerbatim% + \endMakeFramed% + \endlist% + % close group to restore \parskip + \egroup% +} + + +% \moduleauthor{name}{email} +\newcommand{\moduleauthor}[2]{} + +% \sectionauthor{name}{email} +\newcommand{\sectionauthor}[2]{} + +% Augment the sectioning commands used to get our own font family in place, +% and reset some internal data items: +\titleformat{\section}{\Large\py@HeaderFamily}% + {\py@TitleColor\thesection}{0.5em}{\py@TitleColor}{\py@NormalColor} +\titleformat{\subsection}{\large\py@HeaderFamily}% + {\py@TitleColor\thesubsection}{0.5em}{\py@TitleColor}{\py@NormalColor} +\titleformat{\subsubsection}{\py@HeaderFamily}% + {\py@TitleColor\thesubsubsection}{0.5em}{\py@TitleColor}{\py@NormalColor} +\titleformat{\paragraph}{\small\py@HeaderFamily}% + {\py@TitleColor}{0em}{\py@TitleColor}{\py@NormalColor} + +% {fulllineitems} is the main environment for object descriptions. +% +\newcommand{\py@itemnewline}[1]{% + \@tempdima\linewidth% + \advance\@tempdima \leftmargin\makebox[\@tempdima][l]{#1}% +} + +\newenvironment{fulllineitems}{ + \begin{list}{}{\labelwidth \leftmargin \labelsep 0pt + \rightmargin 0pt \topsep -\parskip \partopsep \parskip + \itemsep -\parsep + \let\makelabel=\py@itemnewline} +}{\end{list}} + +% \optional is used for ``[, arg]``, i.e. desc_optional nodes. +\newcommand{\optional}[1]{% + {\textnormal{\Large[}}{#1}\hspace{0.5mm}{\textnormal{\Large]}}} + +\newlength{\py@argswidth} +\newcommand{\py@sigparams}[2]{% + \parbox[t]{\py@argswidth}{#1\code{)}#2}} +\newcommand{\pysigline}[1]{\item[#1]\nopagebreak} +\newcommand{\pysiglinewithargsret}[3]{% + \settowidth{\py@argswidth}{#1\code{(}}% + \addtolength{\py@argswidth}{-2\py@argswidth}% + \addtolength{\py@argswidth}{\linewidth}% + \item[#1\code{(}\py@sigparams{#2}{#3}]} + +% Production lists +% +\newenvironment{productionlist}{ +% \def\optional##1{{\Large[}##1{\Large]}} + \def\production##1##2{\\\code{##1}&::=&\code{##2}} + \def\productioncont##1{\\& &\code{##1}} + \parindent=2em + \indent + \begin{tabular}{lcl} +}{% + \end{tabular} +} + +% Notices / Admonitions +% +\newlength{\py@noticelength} + +\newcommand{\py@heavybox}{ + \setlength{\fboxrule}{1pt} + \setlength{\fboxsep}{6pt} + \setlength{\py@noticelength}{\linewidth} + \addtolength{\py@noticelength}{-2\fboxsep} + \addtolength{\py@noticelength}{-2\fboxrule} + %\setlength{\shadowsize}{3pt} + \Sbox + \minipage{\py@noticelength} +} +\newcommand{\py@endheavybox}{ + \endminipage + \endSbox + \fbox{\TheSbox} +} + +\newcommand{\py@lightbox}{{% + \setlength\parskip{0pt}\par + \rule[0ex]{\linewidth}{0.5pt}% + \par\vspace{-0.5ex}% + }} +\newcommand{\py@endlightbox}{{% + \setlength{\parskip}{0pt}% + \par\rule[0.5ex]{\linewidth}{0.5pt}% + \par\vspace{-0.5ex}% + }} + +% Some are quite plain: +\newcommand{\py@noticestart@note}{\py@lightbox} +\newcommand{\py@noticeend@note}{\py@endlightbox} +\newcommand{\py@noticestart@hint}{\py@lightbox} +\newcommand{\py@noticeend@hint}{\py@endlightbox} +\newcommand{\py@noticestart@important}{\py@lightbox} +\newcommand{\py@noticeend@important}{\py@endlightbox} +\newcommand{\py@noticestart@tip}{\py@lightbox} +\newcommand{\py@noticeend@tip}{\py@endlightbox} + +% Others gets more visible distinction: +\newcommand{\py@noticestart@warning}{\py@heavybox} +\newcommand{\py@noticeend@warning}{\py@endheavybox} +\newcommand{\py@noticestart@caution}{\py@heavybox} +\newcommand{\py@noticeend@caution}{\py@endheavybox} +\newcommand{\py@noticestart@attention}{\py@heavybox} +\newcommand{\py@noticeend@attention}{\py@endheavybox} +\newcommand{\py@noticestart@danger}{\py@heavybox} +\newcommand{\py@noticeend@danger}{\py@endheavybox} +\newcommand{\py@noticestart@error}{\py@heavybox} +\newcommand{\py@noticeend@error}{\py@endheavybox} + +\newenvironment{notice}[2]{ + \def\py@noticetype{#1} + \csname py@noticestart@#1\endcsname + \strong{#2} +}{\csname py@noticeend@\py@noticetype\endcsname} + +% Allow the release number to be specified independently of the +% \date{}. This allows the date to reflect the document's date and +% release to specify the release that is documented. +% +\newcommand{\py@release}{} +\newcommand{\version}{} +\newcommand{\shortversion}{} +\newcommand{\releaseinfo}{} +\newcommand{\releasename}{Release} +\newcommand{\release}[1]{% + \renewcommand{\py@release}{\releasename\space\version}% + \renewcommand{\version}{#1}} +\newcommand{\setshortversion}[1]{% + \renewcommand{\shortversion}{#1}} +\newcommand{\setreleaseinfo}[1]{% + \renewcommand{\releaseinfo}{#1}} + +% Allow specification of the author's address separately from the +% author's name. This can be used to format them differently, which +% is a good thing. +% +\newcommand{\py@authoraddress}{} +\newcommand{\authoraddress}[1]{\renewcommand{\py@authoraddress}{#1}} + +% This sets up the fancy chapter headings that make the documents look +% at least a little better than the usual LaTeX output. +% +\@ifundefined{ChTitleVar}{}{ + \ChNameVar{\raggedleft\normalsize\py@HeaderFamily} + \ChNumVar{\raggedleft \bfseries\Large\py@HeaderFamily} + \ChTitleVar{\raggedleft \rm\Huge\py@HeaderFamily} + % This creates chapter heads without the leading \vspace*{}: + \def\@makechapterhead#1{% + {\parindent \z@ \raggedright \normalfont + \ifnum \c@secnumdepth >\m@ne + \DOCH + \fi + \interlinepenalty\@M + \DOTI{#1} + } + } +} + +% Redefine description environment so that it is usable inside fulllineitems. +% +\renewcommand{\description}{% + \list{}{\labelwidth\z@% + \itemindent-\leftmargin% + \labelsep5pt% + \let\makelabel=\descriptionlabel}} + +% Definition lists; requested by AMK for HOWTO documents. Probably useful +% elsewhere as well, so keep in in the general style support. +% +\newenvironment{definitions}{% + \begin{description}% + \def\term##1{\item[##1]\mbox{}\\*[0mm]} +}{% + \end{description}% +} + +% Tell TeX about pathological hyphenation cases: +\hyphenation{Base-HTTP-Re-quest-Hand-ler} + + +% The following is stuff copied from docutils' latex writer. +% +\newcommand{\optionlistlabel}[1]{\bf #1 \hfill} +\newenvironment{optionlist}[1] +{\begin{list}{} + {\setlength{\labelwidth}{#1} + \setlength{\rightmargin}{1cm} + \setlength{\leftmargin}{\rightmargin} + \addtolength{\leftmargin}{\labelwidth} + \addtolength{\leftmargin}{\labelsep} + \renewcommand{\makelabel}{\optionlistlabel}} +}{\end{list}} + +\newlength{\lineblockindentation} +\setlength{\lineblockindentation}{2.5em} +\newenvironment{lineblock}[1] +{\begin{list}{} + {\setlength{\partopsep}{\parskip} + \addtolength{\partopsep}{\baselineskip} + \topsep0pt\itemsep0.15\baselineskip\parsep0pt + \leftmargin#1} + \raggedright} +{\end{list}} + +% Redefine includgraphics for avoiding images larger than the screen size +% If the size is not specified. +\let\py@Oldincludegraphics\includegraphics + +\newbox\image@box% +\newdimen\image@width% +\renewcommand\includegraphics[2][\@empty]{% + \ifx#1\@empty% + \setbox\image@box=\hbox{\py@Oldincludegraphics{#2}}% + \image@width\wd\image@box% + \ifdim \image@width>\linewidth% + \setbox\image@box=\hbox{\py@Oldincludegraphics[width=\linewidth]{#2}}% + \box\image@box% + \else% + \py@Oldincludegraphics{#2}% + \fi% + \else% + \py@Oldincludegraphics[#1]{#2}% + \fi% +} + + +% Fix the index environment to add an entry to the Table of +% Contents; this is much nicer than just having to jump to the end of the book +% and flip around, especially with multiple indexes. +% +% A similiar fix must be done to the bibliography environment, although +% dependant on document class. In particular, the '\addcontentsline' command +% should use 'chapter' for a report and 'section' for an article. +% See sphinxmanual.cls and sphinxhowto.cls for specific fixes. +% +\let\py@OldTheindex=\theindex +\renewcommand{\theindex}{ + \cleardoublepage + \phantomsection + \py@OldTheindex + \addcontentsline{toc}{chapter}{\indexname} +} + +% Include hyperref last. +\RequirePackage[colorlinks,breaklinks, + linkcolor=InnerLinkColor,filecolor=OuterLinkColor, + menucolor=OuterLinkColor,urlcolor=OuterLinkColor, + citecolor=InnerLinkColor]{hyperref} +% Fix anchor placement for figures with captions. +% (Note: we don't use a package option here; instead, we give an explicit +% \capstart for figures that actually have a caption.) +\RequirePackage{hypcap} + +% From docutils.writers.latex2e +\providecommand{\DUspan}[2]{% + {% group ("span") to limit the scope of styling commands + \@for\node@class@name:=#1\do{% + \ifcsname docutilsrole\node@class@name\endcsname% + \csname docutilsrole\node@class@name\endcsname% + \fi% + }% + {#2}% node content + }% close "span" +} + +\providecommand*{\DUprovidelength}[2]{ + \ifthenelse{\isundefined{#1}}{\newlength{#1}\setlength{#1}{#2}}{} +} + +\DUprovidelength{\DUlineblockindent}{2.5em} +\ifthenelse{\isundefined{\DUlineblock}}{ + \newenvironment{DUlineblock}[1]{% + \list{}{\setlength{\partopsep}{\parskip} + \addtolength{\partopsep}{\baselineskip} + \setlength{\topsep}{0pt} + \setlength{\itemsep}{0.15\baselineskip} + \setlength{\parsep}{0pt} + \setlength{\leftmargin}{#1}} + \raggedright + } + {\endlist} +}{} + + +% From footmisc.sty: allows footnotes in titles +\let\FN@sf@@footnote\footnote +\def\footnote{\ifx\protect\@typeset@protect + \expandafter\FN@sf@@footnote + \else + \expandafter\FN@sf@gobble@opt + \fi +} +\edef\FN@sf@gobble@opt{\noexpand\protect + \expandafter\noexpand\csname FN@sf@gobble@opt \endcsname} +\expandafter\def\csname FN@sf@gobble@opt \endcsname{% + \@ifnextchar[%] + \FN@sf@gobble@twobracket + \@gobble +} +\def\FN@sf@gobble@twobracket[#1]#2{} diff --git a/doc/build/latex/sphinxhowto.cls b/doc/build/latex/sphinxhowto.cls new file mode 100644 index 0000000..f4e3d2f --- /dev/null +++ b/doc/build/latex/sphinxhowto.cls @@ -0,0 +1,92 @@ +% +% sphinxhowto.cls for Sphinx (http://sphinx.pocoo.org/) +% + +\NeedsTeXFormat{LaTeX2e}[1995/12/01] +\ProvidesClass{sphinxhowto}[2009/06/02 Document class (Sphinx HOWTO)] + +% 'oneside' option overriding the 'twoside' default +\newif\if@oneside +\DeclareOption{oneside}{\@onesidetrue} +% Pass remaining document options to the parent class. +\DeclareOption*{\PassOptionsToClass{\CurrentOption}{\sphinxdocclass}} +\ProcessOptions\relax + +% Default to two-side document +\if@oneside +% nothing to do (oneside is the default) +\else +\PassOptionsToClass{twoside}{\sphinxdocclass} +\fi + +\LoadClass{\sphinxdocclass} + +% Set some sane defaults for section numbering depth and TOC depth. You can +% reset these counters in your preamble. +% +\setcounter{secnumdepth}{2} + +% Change the title page to look a bit better, and fit in with the fncychap +% ``Bjarne'' style a bit better. +% +\renewcommand{\maketitle}{ + \rule{\textwidth}{1pt} + \ifsphinxpdfoutput + \begingroup + % These \defs are required to deal with multi-line authors; it + % changes \\ to ', ' (comma-space), making it pass muster for + % generating document info in the PDF file. + \def\\{, } + \def\and{and } + \pdfinfo{ + /Author (\@author) + /Title (\@title) + } + \endgroup + \fi + \begin{flushright} + \sphinxlogo% + {\rm\Huge\py@HeaderFamily \@title} \par + {\em\large\py@HeaderFamily \py@release\releaseinfo} \par + \vspace{25pt} + {\Large\py@HeaderFamily + \begin{tabular}[t]{c} + \@author + \end{tabular}} \par + \vspace{25pt} + \@date \par + \py@authoraddress \par + \end{flushright} + \@thanks + \setcounter{footnote}{0} + \let\thanks\relax\let\maketitle\relax + %\gdef\@thanks{}\gdef\@author{}\gdef\@title{} +} + +\let\py@OldTableofcontents=\tableofcontents +\renewcommand{\tableofcontents}{ + \begingroup + \parskip = 0mm + \py@OldTableofcontents + \endgroup + \rule{\textwidth}{1pt} + \vspace{12pt} +} + +\@ifundefined{fancyhf}{ + \pagestyle{plain}}{ + \pagestyle{normal}} % start this way; change for +\pagenumbering{arabic} % ToC & chapters + +\thispagestyle{empty} + +% Fix the bibliography environment to add an entry to the Table of +% Contents. +% For an article document class this environment is a section, +% so no page break before it. +\let\py@OldThebibliography=\thebibliography +\renewcommand{\thebibliography}[1]{ + \phantomsection + \py@OldThebibliography{1} + \addcontentsline{toc}{section}{\bibname} +} diff --git a/doc/build/latex/sphinxmanual.cls b/doc/build/latex/sphinxmanual.cls new file mode 100644 index 0000000..57fad1a --- /dev/null +++ b/doc/build/latex/sphinxmanual.cls @@ -0,0 +1,133 @@ +% +% sphinxmanual.cls for Sphinx (http://sphinx.pocoo.org/) +% + +\NeedsTeXFormat{LaTeX2e}[1995/12/01] +\ProvidesClass{sphinxmanual}[2009/06/02 Document class (Sphinx manual)] + +% chapters starting at odd pages (overridden by 'openany' document option) +\PassOptionsToClass{openright}{\sphinxdocclass} + +% 'oneside' option overriding the 'twoside' default +\newif\if@oneside +\DeclareOption{oneside}{\@onesidetrue} +% Pass remaining document options to the parent class. +\DeclareOption*{\PassOptionsToClass{\CurrentOption}{\sphinxdocclass}} +\ProcessOptions\relax + +% Defaults two-side document +\if@oneside +% nothing to do (oneside is the default) +\else +\PassOptionsToClass{twoside}{\sphinxdocclass} +\fi + +\LoadClass{\sphinxdocclass} + +% Set some sane defaults for section numbering depth and TOC depth. You can +% reset these counters in your preamble. +% +\setcounter{secnumdepth}{2} +\setcounter{tocdepth}{1} + +% Change the title page to look a bit better, and fit in with the fncychap +% ``Bjarne'' style a bit better. +% +\renewcommand{\maketitle}{% + \begin{titlepage}% + \let\footnotesize\small + \let\footnoterule\relax + \rule{\textwidth}{1pt}% + \ifsphinxpdfoutput + \begingroup + % These \defs are required to deal with multi-line authors; it + % changes \\ to ', ' (comma-space), making it pass muster for + % generating document info in the PDF file. + \def\\{, } + \def\and{and } + \pdfinfo{ + /Author (\@author) + /Title (\@title) + } + \endgroup + \fi + \begin{flushright}% + \sphinxlogo% + {\rm\Huge\py@HeaderFamily \@title \par}% + {\em\LARGE\py@HeaderFamily \py@release\releaseinfo \par} + \vfill + {\LARGE\py@HeaderFamily + \begin{tabular}[t]{c} + \@author + \end{tabular} + \par} + \vfill\vfill + {\large + \@date \par + \vfill + \py@authoraddress \par + }% + \end{flushright}%\par + \@thanks + \end{titlepage}% + \cleardoublepage% + \setcounter{footnote}{0}% + \let\thanks\relax\let\maketitle\relax + %\gdef\@thanks{}\gdef\@author{}\gdef\@title{} +} + + +% Catch the end of the {abstract} environment, but here make sure the abstract +% is followed by a blank page if the 'openright' option is used. +% +\let\py@OldEndAbstract=\endabstract +\renewcommand{\endabstract}{ + \if@openright + \ifodd\value{page} + \typeout{Adding blank page after the abstract.} + \vfil\pagebreak + \fi + \fi + \py@OldEndAbstract +} + +% This wraps the \tableofcontents macro with all the magic to get the spacing +% right and have the right number of pages if the 'openright' option has been +% used. This eliminates a fair amount of crud in the individual document files. +% +\let\py@OldTableofcontents=\tableofcontents +\renewcommand{\tableofcontents}{% + \setcounter{page}{1}% + \pagebreak% + \pagestyle{plain}% + {% + \parskip = 0mm% + \py@OldTableofcontents% + \if@openright% + \ifodd\value{page}% + \typeout{Adding blank page after the table of contents.}% + \pagebreak\hspace{0pt}% + \fi% + \fi% + \cleardoublepage% + }% + \pagenumbering{arabic}% + \@ifundefined{fancyhf}{}{\pagestyle{normal}}% +} + +% This is needed to get the width of the section # area wide enough in the +% library reference. Doing it here keeps it the same for all the manuals. +% +\renewcommand*\l@section{\@dottedtocline{1}{1.5em}{2.6em}} +\renewcommand*\l@subsection{\@dottedtocline{2}{4.1em}{3.5em}} + +% Fix the bibliography environment to add an entry to the Table of +% Contents. +% For a report document class this environment is a chapter. +\let\py@OldThebibliography=\thebibliography +\renewcommand{\thebibliography}[1]{ + \cleardoublepage + \phantomsection + \py@OldThebibliography{1} + \addcontentsline{toc}{chapter}{\bibname} +} diff --git a/doc/build/latex/tabulary.sty b/doc/build/latex/tabulary.sty new file mode 100644 index 0000000..ba83c0a --- /dev/null +++ b/doc/build/latex/tabulary.sty @@ -0,0 +1,452 @@ +%% +%% This is file `tabulary.sty', +%% generated with the docstrip utility. +%% +%% The original source files were: +%% +%% tabulary.dtx (with options: `package') +%% DRAFT VERSION +%% +%% File `tabulary.dtx'. +%% Copyright (C) 1995 1996 2003 David Carlisle +%% This file may be distributed under the terms of the LPPL. +%% See 00readme.txt for details. +%% +\NeedsTeXFormat{LaTeX2e} +\ProvidesPackage{tabulary} + [2007/10/02 v0.9 tabulary package (DPC)] +\RequirePackage{array} +\catcode`\Z=14 +\DeclareOption{debugshow}{\catcode`\Z=9\relax} +\ProcessOptions +\def\arraybackslash{\let\\=\@arraycr} +\def\@finalstrut#1{% + \unskip\ifhmode\nobreak\fi\vrule\@width\z@\@height\z@\@depth\dp#1} +\newcount\TY@count +\def\tabulary{% + \let\TY@final\tabular + \let\endTY@final\endtabular + \TY@tabular} +\def\TY@tabular#1{% + \edef\TY@{\@currenvir}% + {\ifnum0=`}\fi + \@ovxx\TY@linewidth + \@ovyy\TY@tablewidth + \count@\z@ + \@tempswatrue + \@whilesw\if@tempswa\fi{% + \advance\count@\@ne + \expandafter\ifx\csname TY@F\the\count@\endcsname\relax + \@tempswafalse + \else + \expandafter\let\csname TY@SF\the\count@\expandafter\endcsname + \csname TY@F\the\count@\endcsname + \global\expandafter\let\csname TY@F\the\count@\endcsname\relax + \expandafter\let\csname TY@S\the\count@\expandafter\endcsname + \csname TY@\the\count@\endcsname + \fi}% + \global\TY@count\@ne + \TY@width\xdef{0pt}% + \global\TY@tablewidth\z@ + \global\TY@linewidth#1\relax +Z\message{^^J^^JTable^^J% +Z Target Width: \the\TY@linewidth^^J% +Z \string\tabcolsep: \the\tabcolsep\space +Z \string\arrayrulewidth: \the\arrayrulewidth\space +Z \string\doublerulesep: \the\doublerulesep^^J% +Z \string\tymin: \the\tymin\space +Z \string\tymax: \the\tymax^^J}% + \let\@classz\TY@classz + \let\verb\TX@verb + \toks@{}\TY@get@body} +\let\TY@@mkpream\@mkpream +\def\TY@mkpream{% + \def\@addamp{% + \if@firstamp \@firstampfalse \else + \global\advance\TY@count\@ne + \edef\@preamble{\@preamble &}\fi + \TY@width\xdef{0pt}}% + \def\@acol{% + \TY@subwidth\col@sep + \@addtopreamble{\hskip\col@sep}}% + \let\@arrayrule\TY@arrayrule + \let\@classvi\TY@classvi + \def\@classv{\save@decl + \expandafter\NC@ecs\@nextchar\extracolsep{}\extracolsep\@@@ + \sbox\z@{\d@llarbegin\@nextchar\d@llarend}% + \TY@subwidth{\wd\z@}% + \@addtopreamble{\d@llarbegin\the@toks\the\count@\relax\d@llarend}% + \prepnext@tok}% + \global\let\@mkpream\TY@@mkpream + \TY@@mkpream} +\def\TY@arrayrule{% + \TY@subwidth\arrayrulewidth + \@addtopreamble \vline} +\def\TY@classvi{\ifcase \@lastchclass + \@acol \or + \TY@subwidth\doublerulesep + \@addtopreamble{\hskip \doublerulesep}\or + \@acol \or + \@classvii + \fi} +\def\TY@tab{% + \setbox\z@\hbox\bgroup + \let\[$\let\]$% + \let\equation$\let\endequation$% + \col@sep\tabcolsep + \let\d@llarbegin\begingroup\let\d@llarend\endgroup + \let\@mkpream\TY@mkpream + \def\multicolumn##1##2##3{\multispan##1\relax}% + \CT@start\TY@tabarray} +\def\TY@tabarray{\@ifnextchar[{\TY@array}{\@array[t]}} +\def\TY@array[#1]{\@array[t]} +\def\TY@width#1{% + \expandafter#1\csname TY@\the\TY@count\endcsname} +\def\TY@subwidth#1{% + \TY@width\dimen@ + \advance\dimen@-#1\relax + \TY@width\xdef{\the\dimen@}% + \global\advance\TY@linewidth-#1\relax} +\def\endtabulary{% + \gdef\@halignto{}% + \let\TY@footnote\footnote% + \def\footnote{}% prevent footnotes from doing anything + \expandafter\TY@tab\the\toks@ + \crcr\omit + {\xdef\TY@save@row{}% + \loop + \advance\TY@count\m@ne + \ifnum\TY@count>\z@ + \xdef\TY@save@row{\TY@save@row&\omit}% + \repeat}\TY@save@row + \endarray\global\setbox1=\lastbox\setbox0=\vbox{\unvbox1 + \unskip\global\setbox1=\lastbox}\egroup + \dimen@\TY@linewidth + \divide\dimen@\TY@count + \ifdim\dimen@<\tymin + \TY@warn{tymin too large (\the\tymin), resetting to \the\dimen@}% + \tymin\dimen@ + \fi + \setbox\tw@=\hbox{\unhbox\@ne + \loop +\@tempdima=\lastskip +\ifdim\@tempdima>\z@ +Z \message{ecs=\the\@tempdima^^J}% + \global\advance\TY@linewidth-\@tempdima +\fi + \unskip + \setbox\tw@=\lastbox + \ifhbox\tw@ +Z \message{Col \the\TY@count: Initial=\the\wd\tw@\space}% + \ifdim\wd\tw@>\tymax + \wd\tw@\tymax +Z \message{> max\space}% +Z \else +Z \message{ \@spaces\space}% + \fi + \TY@width\dimen@ +Z \message{\the\dimen@\space}% + \advance\dimen@\wd\tw@ +Z \message{Final=\the\dimen@\space}% + \TY@width\xdef{\the\dimen@}% + \ifdim\dimen@<\tymin +Z \message{< tymin}% + \global\advance\TY@linewidth-\dimen@ + \expandafter\xdef\csname TY@F\the\TY@count\endcsname + {\the\dimen@}% + \else + \expandafter\ifx\csname TY@F\the\TY@count\endcsname\z@ +Z \message{***}% + \global\advance\TY@linewidth-\dimen@ + \expandafter\xdef\csname TY@F\the\TY@count\endcsname + {\the\dimen@}% + \else +Z \message{> tymin}% + \global\advance\TY@tablewidth\dimen@ + \global\expandafter\let\csname TY@F\the\TY@count\endcsname + \maxdimen + \fi\fi + \advance\TY@count\m@ne + \repeat}% + \TY@checkmin + \TY@checkmin + \TY@checkmin + \TY@checkmin + \TY@count\z@ + \let\TY@box\TY@box@v + \let\footnote\TY@footnote % restore footnotes + {\expandafter\TY@final\the\toks@\endTY@final}% + \count@\z@ + \@tempswatrue + \@whilesw\if@tempswa\fi{% + \advance\count@\@ne + \expandafter\ifx\csname TY@SF\the\count@\endcsname\relax + \@tempswafalse + \else + \global\expandafter\let\csname TY@F\the\count@\expandafter\endcsname + \csname TY@SF\the\count@\endcsname + \global\expandafter\let\csname TY@\the\count@\expandafter\endcsname + \csname TY@S\the\count@\endcsname + \fi}% + \TY@linewidth\@ovxx + \TY@tablewidth\@ovyy + \ifnum0=`{\fi}} +\def\TY@checkmin{% + \let\TY@checkmin\relax +\ifdim\TY@tablewidth>\z@ + \Gscale@div\TY@ratio\TY@linewidth\TY@tablewidth + \ifdim\TY@tablewidth <\linewidth + \def\TY@ratio{1}% + \fi +\else + \TY@warn{No suitable columns!}% + \def\TY@ratio{1}% +\fi +\count@\z@ +Z \message{^^JLine Width: \the\TY@linewidth, +Z Natural Width: \the\TY@tablewidth, +Z Ratio: \TY@ratio^^J}% +\@tempdima\z@ +\loop +\ifnum\count@<\TY@count +\advance\count@\@ne + \ifdim\csname TY@F\the\count@\endcsname>\tymin + \dimen@\csname TY@\the\count@\endcsname + \dimen@\TY@ratio\dimen@ + \ifdim\dimen@<\tymin +Z \message{Column \the\count@\space ->}% + \global\expandafter\let\csname TY@F\the\count@\endcsname\tymin + \global\advance\TY@linewidth-\tymin + \global\advance\TY@tablewidth-\csname TY@\the\count@\endcsname + \let\TY@checkmin\TY@@checkmin + \else + \expandafter\xdef\csname TY@F\the\count@\endcsname{\the\dimen@}% + \advance\@tempdima\csname TY@F\the\count@\endcsname + \fi + \fi +Z \dimen@\csname TY@F\the\count@\endcsname\message{\the\dimen@, }% +\repeat +Z \message{^^JTotal:\the\@tempdima^^J}% +} +\let\TY@@checkmin\TY@checkmin +\newdimen\TY@linewidth +\def\tyformat{\everypar{{\nobreak\hskip\z@skip}}} +\newdimen\tymin +\tymin=10pt +\newdimen\tymax +\tymax=2\textwidth +\def\@testpach{\@chclass + \ifnum \@lastchclass=6 \@ne \@chnum \@ne \else + \ifnum \@lastchclass=7 5 \else + \ifnum \@lastchclass=8 \tw@ \else + \ifnum \@lastchclass=9 \thr@@ + \else \z@ + \ifnum \@lastchclass = 10 \else + \edef\@nextchar{\expandafter\string\@nextchar}% + \@chnum + \if \@nextchar c\z@ \else + \if \@nextchar l\@ne \else + \if \@nextchar r\tw@ \else + \if \@nextchar C7 \else + \if \@nextchar L8 \else + \if \@nextchar R9 \else + \if \@nextchar J10 \else + \z@ \@chclass + \if\@nextchar |\@ne \else + \if \@nextchar !6 \else + \if \@nextchar @7 \else + \if \@nextchar <8 \else + \if \@nextchar >9 \else + 10 + \@chnum + \if \@nextchar m\thr@@\else + \if \@nextchar p4 \else + \if \@nextchar b5 \else + \z@ \@chclass \z@ \@preamerr \z@ \fi \fi \fi \fi\fi \fi \fi\fi \fi + \fi \fi \fi \fi \fi \fi \fi \fi \fi \fi \fi} +\def\TY@classz{% + \@classx + \@tempcnta\count@ + \ifx\TY@box\TY@box@v + \global\advance\TY@count\@ne + \fi + \let\centering c% + \let\raggedright\noindent + \let\raggedleft\indent + \let\arraybackslash\relax + \prepnext@tok + \ifnum\@chnum<4 + \global\expandafter\let\csname TY@F\the\TY@count\endcsname\z@ + \fi + \ifnum\@chnum=6 + \global\expandafter\let\csname TY@F\the\TY@count\endcsname\z@ + \fi + \@addtopreamble{% + \ifcase\@chnum + \hfil \d@llarbegin\insert@column\d@llarend \hfil \or + \kern\z@ + \d@llarbegin \insert@column \d@llarend \hfil \or + \hfil\kern\z@ \d@llarbegin \insert@column \d@llarend \or + $\vcenter\@startpbox{\@nextchar}\insert@column \@endpbox $\or + \vtop \@startpbox{\@nextchar}\insert@column \@endpbox \or + \vbox \@startpbox{\@nextchar}\insert@column \@endpbox \or + \d@llarbegin \insert@column \d@llarend \or% dubious "s" case + \TY@box\centering\or + \TY@box\raggedright\or + \TY@box\raggedleft\or + \TY@box\relax + \fi}\prepnext@tok} +\def\TY@box#1{% + \ifx\centering#1% + \hfil \d@llarbegin\insert@column\d@llarend \hfil \else + \ifx\raggedright#1% + \kern\z@%<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< + \d@llarbegin \insert@column \d@llarend \hfil \else + \ifx\raggedleft#1% + \hfil\kern\z@ \d@llarbegin \insert@column \d@llarend \else + \ifx\relax#1% + \d@llarbegin \insert@column \d@llarend + \fi \fi \fi \fi} +\def\TY@box@v#1{% + \vtop \@startpbox{\csname TY@F\the\TY@count\endcsname}% + #1\arraybackslash\tyformat + \insert@column\@endpbox} +\newdimen\TY@tablewidth +\def\Gscale@div#1#2#3{% + \setlength\dimen@{#3}% + \ifdim\dimen@=\z@ + \PackageError{graphics}{Division by 0}\@eha + \dimen@#2% + \fi + \edef\@tempd{\the\dimen@}% + \setlength\dimen@{#2}% + \count@65536\relax + \ifdim\dimen@<\z@ + \dimen@-\dimen@ + \count@-\count@ + \fi + \loop + \ifdim\dimen@<8192\p@ + \dimen@\tw@\dimen@ + \divide\count@\tw@ + \repeat + \dimen@ii=\@tempd\relax + \divide\dimen@ii\count@ + \divide\dimen@\dimen@ii + \edef#1{\strip@pt\dimen@}} +\long\def\TY@get@body#1\end + {\toks@\expandafter{\the\toks@#1}\TY@find@end} +\def\TY@find@end#1{% + \def\@tempa{#1}% + \ifx\@tempa\TY@\def\@tempa{\end{#1}}\expandafter\@tempa + \else\toks@\expandafter + {\the\toks@\end{#1}}\expandafter\TY@get@body\fi} +\def\TY@warn{% + \PackageWarning{tabulary}} +\catcode`\Z=11 +\AtBeginDocument{ +\@ifpackageloaded{colortbl}{% +\expandafter\def\expandafter\@mkpream\expandafter#\expandafter1% + \expandafter{% + \expandafter\let\expandafter\CT@setup\expandafter\relax + \expandafter\let\expandafter\CT@color\expandafter\relax + \expandafter\let\expandafter\CT@do@color\expandafter\relax + \expandafter\let\expandafter\color\expandafter\relax + \expandafter\let\expandafter\CT@column@color\expandafter\relax + \expandafter\let\expandafter\CT@row@color\expandafter\relax + \@mkpream{#1}} +\let\TY@@mkpream\@mkpream +\def\TY@classz{% + \@classx + \@tempcnta\count@ + \ifx\TY@box\TY@box@v + \global\advance\TY@count\@ne + \fi + \let\centering c% + \let\raggedright\noindent + \let\raggedleft\indent + \let\arraybackslash\relax + \prepnext@tok +\expandafter\CT@extract\the\toks\@tempcnta\columncolor!\@nil + \ifnum\@chnum<4 + \global\expandafter\let\csname TY@F\the\TY@count\endcsname\z@ + \fi + \ifnum\@chnum=6 + \global\expandafter\let\csname TY@F\the\TY@count\endcsname\z@ + \fi + \@addtopreamble{% + \setbox\z@\hbox\bgroup\bgroup + \ifcase\@chnum + \hskip\stretch{.5}\kern\z@ + \d@llarbegin\insert@column\d@llarend\hskip\stretch{.5}\or + \kern\z@%<<<<<<<<<<<<<<<<<<<<<<<<<<< + \d@llarbegin \insert@column \d@llarend \hfill \or + \hfill\kern\z@ \d@llarbegin \insert@column \d@llarend \or + $\vcenter\@startpbox{\@nextchar}\insert@column \@endpbox $\or + \vtop \@startpbox{\@nextchar}\insert@column \@endpbox \or + \vbox \@startpbox{\@nextchar}\insert@column \@endpbox \or + \d@llarbegin \insert@column \d@llarend \or% dubious s case + \TY@box\centering\or + \TY@box\raggedright\or + \TY@box\raggedleft\or + \TY@box\relax + \fi + \egroup\egroup +\begingroup + \CT@setup + \CT@column@color + \CT@row@color + \CT@do@color +\endgroup + \@tempdima\ht\z@ + \advance\@tempdima\minrowclearance + \vrule\@height\@tempdima\@width\z@ +\unhbox\z@ +}\prepnext@tok}% + \def\TY@arrayrule{% + \TY@subwidth\arrayrulewidth + \@addtopreamble{{\CT@arc@\vline}}}% + \def\TY@classvi{\ifcase \@lastchclass + \@acol \or + \TY@subwidth\doublerulesep + \ifx\CT@drsc@\relax + \@addtopreamble{\hskip\doublerulesep}% + \else + \@addtopreamble{{\CT@drsc@\vrule\@width\doublerulesep}}% + \fi\or + \@acol \or + \@classvii + \fi}% +}{% +\let\CT@start\relax +} +} +{\uccode`\*=`\ % +\uppercase{\gdef\TX@verb{% + \leavevmode\null\TX@vwarn + {\ifnum0=`}\fi\ttfamily\let\\\ignorespaces + \@ifstar{\let~*\TX@vb}{\TX@vb}}}} +\def\TX@vb#1{\def\@tempa##1#1{\toks@{##1}\edef\@tempa{\the\toks@}% + \expandafter\TX@v\meaning\@tempa\\ \\\ifnum0=`{\fi}}\@tempa!} +\def\TX@v#1!{\afterassignment\TX@vfirst\let\@tempa= } +\begingroup +\catcode`\*=\catcode`\# +\catcode`\#=12 +\gdef\TX@vfirst{% + \if\@tempa#% + \def\@tempb{\TX@v@#}% + \else + \let\@tempb\TX@v@ + \if\@tempa\space~\else\@tempa\fi + \fi + \@tempb} +\gdef\TX@v@*1 *2{% + \TX@v@hash*1##\relax\if*2\\\else~\expandafter\TX@v@\fi*2} +\gdef\TX@v@hash*1##*2{*1\ifx*2\relax\else#\expandafter\TX@v@hash\fi*2} +\endgroup +\def\TX@vwarn{% + \@warning{\noexpand\verb may be unreliable inside tabularx/y}% + \global\let\TX@vwarn\@empty} +\endinput +%% +%% End of file `tabulary.sty'.