From: Christian Van Wambeke Date: Thu, 26 Apr 2018 06:57:19 +0000 (+0200) Subject: update doc from master 8d6ad91 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=9a82b0561cb022bdfe1f54f032c2cfdfce0ad8d7;p=tools%2Fsat.git update doc from master 8d6ad91 --- diff --git a/.gitignore b/.gitignore index 6bab5df..6413d40 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/README b/doc/README new file mode 100644 index 0000000..f5ccaa7 --- /dev/null +++ b/doc/README @@ -0,0 +1,20 @@ + +# needs sphinx-build +# to make doc html + +cd doc +make html +firefox build/html/index.html & + +# to make doc pdf +# needs texlive a jour (done on machines lgls for x86_64-linux) +# https://www.tug.org/texlive/quickinstall.html + +export INFOPATH=/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/doc/info +export MANPATH=/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/doc/man +export PATH=/data/tmplgls/wambeke/share/texlive/2017/bin/x86_64-linux:${PATH} + +cd doc +make latexpdf +evince build/latex/salomeTools.pdf & + diff --git a/doc/_themes/alabaster/.gitignore b/doc/_themes/alabaster/.gitignore new file mode 100644 index 0000000..f604433 --- /dev/null +++ b/doc/_themes/alabaster/.gitignore @@ -0,0 +1,4 @@ +*.egg-info/ +build/ +dist/ +docs/_build diff --git a/doc/_themes/alabaster/.travis.yml b/doc/_themes/alabaster/.travis.yml new file mode 100644 index 0000000..ccc202e --- /dev/null +++ b/doc/_themes/alabaster/.travis.yml @@ -0,0 +1,37 @@ +language: python +cache: pip +python: + - "2.7" + - "3.4" + - "3.5" + - "3.6" + - "pypy" + - "pypy3" +env: + - SPHINX=">=1.3,<1.4" + - SPHINX=">=1.4,<1.5" + - SPHINX=">=1.5,<1.6" + - SPHINX=">=1.6,<1.7" +install: + # For some reason Travis' build envs have wildly different pip/setuptools + # versions between minor Python versions, and this can cause many hilarious + # corner packaging cases. So... + - pip install -U pip + # Setuptools 34+ seems to get less stable + - pip install 'setuptools>33,<34' + # Install dev requirements + - pip install -r dev-requirements.txt + # Limit Sphinx version re: test matrix + - pip install "sphinx$SPHINX" + # Sanity/debug-friendliness: list what got installed + - pip list --format=columns + # Dev tooling sanity test: can invoke list tasks? + - inv --list +script: + # We have no real tests at present so we just make sure installation works, + # first off. + - pip install . + # Does our own dogfooding website build ok? :D + - inv docs + # I have this in my git pre-push hook, but contributors probably don't + - flake8 diff --git a/doc/_themes/alabaster/LICENSE b/doc/_themes/alabaster/LICENSE new file mode 100644 index 0000000..b5abb04 --- /dev/null +++ b/doc/_themes/alabaster/LICENSE @@ -0,0 +1,34 @@ +Copyright (c) 2018 Jeff Forcier. + +Based on original work copyright (c) 2011 Kenneth Reitz and copyright (c) 2010 +Armin Ronacher. + +Some rights reserved. + +Redistribution and use in source and binary forms of the theme, with or +without modification, are permitted provided that the following conditions +are met: + +* Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + +* Redistributions in binary form must reproduce the above + copyright notice, this list of conditions and the following + disclaimer in the documentation and/or other materials provided + with the distribution. + +* The names of the contributors may not be used to endorse or + promote products derived from this software without specific + prior written permission. + +THIS THEME IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE +LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +ARISING IN ANY WAY OUT OF THE USE OF THIS THEME, EVEN IF ADVISED OF THE +POSSIBILITY OF SUCH DAMAGE. diff --git a/doc/_themes/alabaster/MANIFEST.in b/doc/_themes/alabaster/MANIFEST.in new file mode 100644 index 0000000..d16888e --- /dev/null +++ b/doc/_themes/alabaster/MANIFEST.in @@ -0,0 +1,4 @@ +include LICENSE +include README.md +recursive-include alabaster *.* +recursive-exclude alabaster .*.swp diff --git a/doc/_themes/alabaster/README.rst b/doc/_themes/alabaster/README.rst new file mode 100644 index 0000000..08093fb --- /dev/null +++ b/doc/_themes/alabaster/README.rst @@ -0,0 +1,19 @@ +What is Alabaster? +================== + +Alabaster is a visually (c)lean, responsive, configurable theme for the `Sphinx +`_ documentation system. It is Python 2+3 compatible. + +It began as a third-party theme, and is still maintained separately, but as of +Sphinx 1.3, Alabaster is an install-time dependency of Sphinx and is selected +as the default theme. + +Live examples of this theme can be seen on `this project's own website +`_, `paramiko.org `_, +`fabfile.org `_ and `pyinvoke.org `_. + +For more documentation, please see http://alabaster.readthedocs.io. + +.. note:: + You can install the development version via ``pip install -e + git+https://github.com/bitprophet/alabaster/#egg=alabaster``. diff --git a/doc/_themes/alabaster/alabaster/__init__.py b/doc/_themes/alabaster/alabaster/__init__.py new file mode 100644 index 0000000..39f1407 --- /dev/null +++ b/doc/_themes/alabaster/alabaster/__init__.py @@ -0,0 +1,24 @@ +import os + +from alabaster import _version as version + + +def get_path(): + """ + Shortcut for users whose theme is next to their conf.py. + """ + # Theme directory is defined as our parent directory + return os.path.abspath(os.path.dirname(os.path.dirname(__file__))) + + +def update_context(app, pagename, templatename, context, doctree): + context['alabaster_version'] = version.__version__ + +def setup(app): + # add_html_theme is new in Sphinx 1.6+ + if hasattr(app, 'add_html_theme'): + theme_path = os.path.abspath(os.path.dirname(__file__)) + app.add_html_theme('alabaster', theme_path) + app.connect('html-page-context', update_context) + return {'version': version.__version__, + 'parallel_read_safe': True} diff --git a/doc/_themes/alabaster/alabaster/_version.py b/doc/_themes/alabaster/alabaster/_version.py new file mode 100644 index 0000000..9e641f7 --- /dev/null +++ b/doc/_themes/alabaster/alabaster/_version.py @@ -0,0 +1,2 @@ +__version_info__ = (0, 7, 10) +__version__ = '.'.join(map(str, __version_info__)) diff --git a/doc/_themes/alabaster/alabaster/about.html b/doc/_themes/alabaster/alabaster/about.html new file mode 100644 index 0000000..d6884e7 --- /dev/null +++ b/doc/_themes/alabaster/alabaster/about.html @@ -0,0 +1,57 @@ +{% if theme_logo %} +

{{ project }}

+ {% endif %} + +

+{% else %} +

{{ project }}

+{% endif %} + +{% if theme_description %} +

{{ theme_description }}

+{% endif %} + +{% if theme_github_user and theme_github_repo %} +{% if theme_github_button|lower == 'true' %} +

+ +

+{% endif %} +{% endif %} + +{% if theme_travis_button|lower != 'false' %} +{% if theme_travis_button|lower == 'true' %} + {% set path = theme_github_user + '/' + theme_github_repo %} +{% else %} + {% set path = theme_travis_button %} +{% endif %} +

+ + https://secure.travis-ci.org/{{ path }}.svg?branch={{ theme_badge_branch }} + +

+{% endif %} + +{% if theme_codecov_button|lower != 'false' %} +{% if theme_codecov_button|lower == 'true' %} + {% set path = theme_github_user + '/' + theme_github_repo %} +{% else %} + {% set path = theme_codecov_button %} +{% endif %} +

+ + https://codecov.io/github/{{ path }}/coverage.svg?branch={{ theme_badge_branch }} + +

+{% endif %} diff --git a/doc/_themes/alabaster/alabaster/donate.html b/doc/_themes/alabaster/alabaster/donate.html new file mode 100644 index 0000000..62f289e --- /dev/null +++ b/doc/_themes/alabaster/alabaster/donate.html @@ -0,0 +1,9 @@ +{% if theme_gratipay_user or theme_gittip_user %} +

Donate

+

+Consider supporting the authors on Gratipay: + +

+{% endif %} diff --git a/doc/_themes/alabaster/alabaster/layout.html b/doc/_themes/alabaster/alabaster/layout.html new file mode 100644 index 0000000..459700f --- /dev/null +++ b/doc/_themes/alabaster/alabaster/layout.html @@ -0,0 +1,82 @@ +{%- extends "basic/layout.html" %} + +{%- block extrahead %} + {{ super() }} + + {% if theme_touch_icon %} + + {% endif %} + {% if theme_canonical_url %} + + {% endif %} + +{% endblock %} + +{# Disable base theme's top+bottom related navs; we have our own in sidebar #} +{%- block relbar1 %}{% endblock %} +{%- block relbar2 %}{% endblock %} + +{# Nav should appear before content, not after #} +{%- block content %} +{%- if theme_fixed_sidebar|lower == 'true' %} +
+ {{ sidebar() }} + {%- block document %} +
+ {%- if render_sidebar %} +
+ {%- endif %} +
+ {% block body %} {% endblock %} +
+ {%- if render_sidebar %} +
+ {%- endif %} +
+ {%- endblock %} +
+
+{%- else %} +{{ super() }} +{%- endif %} +{%- endblock %} + +{%- block footer %} +
+ {% if show_copyright %}©{{ copyright }}.{% endif %} + {% if theme_show_powered_by|lower == 'true' %} + {% if show_copyright %}|{% endif %} + Powered by Sphinx {{ sphinx_version }} + & Alabaster {{ alabaster_version }} + {% endif %} + {%- if show_source and has_source and sourcename %} + {% if show_copyright or theme_show_powered_by %}|{% endif %} + {{ _('Page source') }} + {%- endif %} +
+ + {% if theme_github_banner|lower != 'false' %} + + Fork me on GitHub + + {% endif %} + + {% if theme_analytics_id %} + + {% endif %} +{%- endblock %} diff --git a/doc/_themes/alabaster/alabaster/navigation.html b/doc/_themes/alabaster/alabaster/navigation.html new file mode 100644 index 0000000..760dcc9 --- /dev/null +++ b/doc/_themes/alabaster/alabaster/navigation.html @@ -0,0 +1,10 @@ +

{{ _('Navigation') }}

+{{ toctree(includehidden=theme_sidebar_includehidden, collapse=theme_sidebar_collapse) }} +{% if theme_extra_nav_links %} +
+
    + {% for text, uri in theme_extra_nav_links.items() %} +
  • {{ text }}
    • + {% endfor %} +
+{% endif %} diff --git a/doc/_themes/alabaster/alabaster/relations.html b/doc/_themes/alabaster/alabaster/relations.html new file mode 100644 index 0000000..770446c --- /dev/null +++ b/doc/_themes/alabaster/alabaster/relations.html @@ -0,0 +1,21 @@ +
+

Related Topics

+ +
diff --git a/doc/_themes/alabaster/alabaster/static/alabaster.css_t b/doc/_themes/alabaster/alabaster/static/alabaster.css_t new file mode 100644 index 0000000..3964f98 --- /dev/null +++ b/doc/_themes/alabaster/alabaster/static/alabaster.css_t @@ -0,0 +1,706 @@ +{% set theme_body_bg = theme_body_bg or theme_base_bg %} +{% set theme_code_highlight_bg = theme_code_highlight_bg or theme_body_bg %} +{% set theme_sidebar_header = theme_sidebar_header or theme_gray_1 %} +{% set theme_sidebar_link = theme_sidebar_link or theme_gray_1 %} +{% set theme_anchor_hover_fg = theme_anchor_hover_fg or theme_gray_1 %} + +{% set theme_footnote_border = theme_footnote_border or theme_gray_2 %} +{% set theme_pre_bg = theme_pre_bg or theme_gray_2 %} + + +{# set up admonition styling #} +{# - basic level #} +{% set theme_admonition_xref_bg = theme_admonition_xref_bg or theme_xref_bg %} +{% set theme_admonition_bg = theme_admonition_bg or theme_gray_2 %} +{% set theme_note_bg = theme_note_bg or theme_gray_2 %} +{% set theme_seealso_bg = theme_seealso_bg or theme_gray_2 %} + +{# - critical level #} +{% set theme_danger_bg = theme_danger_bg or theme_pink_1 %} +{% set theme_danger_border = theme_danger_border or theme_pink_2 %} +{% set theme_danger_shadow = theme_danger_shadow or theme_pink_3 %} + +{% set theme_error_bg = theme_error_bg or theme_pink_1 %} +{% set theme_error_border = theme_error_border or theme_pink_2 %} +{% set theme_error_shadow = theme_error_shadow or theme_pink_3 %} + +{# - warning level #} +{% set theme_caution_bg = theme_caution_bg or theme_pink_1 %} +{% set theme_caution_border = theme_caution_border or theme_pink_2 %} + +{% set theme_attention_bg = theme_attention_bg or theme_pink_1 %} +{% set theme_attention_border = theme_attention_border or theme_pink_2 %} + +{% set theme_warn_bg = theme_warn_bg or theme_pink_1 %} +{% set theme_warn_border = theme_warn_border or theme_pink_2 %} + +{# - normal level #} +{% set theme_important_bg = theme_important_bg or theme_gray_2 %} +{% set theme_tip_bg = theme_tip_bg or theme_gray_2 %} +{% set theme_hint_bg = theme_hint_bg or theme_gray_2 %} + +{# /set up admonition styling #} + +{% set theme_shadow = theme_shadow or theme_gray_2 %} + + +{% set theme_topic_bg = theme_topic_bg or theme_gray_2 %} + +{% set theme_narrow_sidebar_link = theme_narrow_sidebar_link or theme_gray_3 %} +{% set theme_sidebar_hr = theme_sidebar_hr or theme_gray_3 %} + + +@import url("basic.css"); + +/* -- page layout ----------------------------------------------------------- */ + +body { + font-family: {{ theme_font_family }}; + font-size: {{ theme_font_size }}; + background-color: {{ theme_base_bg }}; + color: {{ theme_base_text }}; + margin: 0; + padding: 0; +} + + +div.document { + width: {{ theme_page_width }}; + margin: 30px auto 0 auto; +} + +div.documentwrapper { + float: left; + width: 100%; +} + +div.bodywrapper { + margin: 0 0 0 {{ theme_sidebar_width }}; +} + +div.sphinxsidebar { + width: {{ theme_sidebar_width }}; + font-size: 14px; + line-height: 1.5; +} + +hr { + border: 1px solid {{ theme_hr_border }}; +} + +div.body { + background-color: {{ theme_body_bg }}; + color: {{ theme_body_text }}; + padding: 0 30px 0 30px; +} + +div.body > .section { + text-align: {{ theme_body_text_align }}; +} + +div.footer { + width: {{ theme_page_width }}; + margin: 20px auto 30px auto; + font-size: 14px; + color: {{ theme_footer_text }}; + text-align: right; +} + +div.footer a { + color: {{ theme_footer_text }}; +} + +p.caption { + font-family: {{ theme_caption_font_family }}; + font-size: {{ theme_caption_font_size }}; +} + +{% if theme_show_related|lower == 'false' %} +div.relations { + display: none; +} +{% endif %} + +div.sphinxsidebar a { + color: {{ theme_sidebar_link }}; + text-decoration: none; + border-bottom: 1px dotted {{ theme_sidebar_link_underscore }}; +} + +div.sphinxsidebar a:hover { + border-bottom: 1px solid {{ theme_sidebar_link_underscore }}; +} + +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: {{ theme_logo_text_align }}; +} + +div.sphinxsidebarwrapper h1.logo-name { + margin-top: 0px; +} + +div.sphinxsidebarwrapper p.blurb { + margin-top: 0; + font-style: {{ theme_description_font_style }}; +} + +div.sphinxsidebar h3, +div.sphinxsidebar h4 { + font-family: {{ theme_head_font_family }}; + color: {{ theme_sidebar_header }}; + font-size: 24px; + font-weight: normal; + margin: 0 0 5px 0; + padding: 0; +} + +div.sphinxsidebar h4 { + font-size: 20px; +} + +div.sphinxsidebar h3 a { + color: {{ theme_sidebar_link }}; +} + +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: {{ theme_sidebar_text }}; + margin: 10px 0; +} + +div.sphinxsidebar ul { + margin: 10px 0; + padding: 0; + color: {{ theme_sidebar_list }}; +} + +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 {{ theme_sidebar_search_button }}; + font-family: {{ theme_font_family }}; + font-size: 1em; +} + +div.sphinxsidebar hr { + border: none; + height: 1px; + color: {{ theme_sidebar_hr }}; + background: {{ theme_sidebar_hr }}; + + text-align: left; + margin-left: 0; + width: 50%; +} + +/* -- body styles ----------------------------------------------------------- */ + +a { + color: {{ theme_link }}; + text-decoration: underline; +} + +a:hover { + color: {{ theme_link_hover }}; + text-decoration: underline; +} + +div.body h1, +div.body h2, +div.body h3, +div.body h4, +div.body h5, +div.body h6 { + font-family: {{ theme_head_font_family }}; + 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: {{ theme_anchor }}; + padding: 0 4px; + text-decoration: none; +} + +a.headerlink:hover { + color: {{ theme_anchor_hover_fg }}; + background: {{ theme_anchor_hover_bg }}; +} + +div.body p, div.body dd, div.body li { + line-height: 1.4em; +} + +div.admonition { + margin: 20px 0px; + padding: 10px 30px; + background-color: {{ theme_admonition_bg }}; + border: 1px solid {{ theme_admonition_border }}; +} + +div.admonition tt.xref, div.admonition code.xref, div.admonition a tt { + background-color: {{ theme_admonition_xref_bg }}; + border-bottom: 1px solid {{ theme_admonition_xref_border }}; +} + +div.admonition p.admonition-title { + font-family: {{ theme_head_font_family }}; + 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: {{ theme_code_highlight_bg }}; +} + +dt:target, .highlight { + background: {{ theme_highlight_bg }}; +} + +div.warning { + background-color: {{ theme_warn_bg }}; + border: 1px solid {{ theme_warn_border }}; +} + +div.danger { + background-color: {{ theme_danger_bg }}; + border: 1px solid {{ theme_danger_border }}; + -moz-box-shadow: 2px 2px 4px {{ theme_danger_shadow }}; + -webkit-box-shadow: 2px 2px 4px {{ theme_danger_shadow }}; + box-shadow: 2px 2px 4px {{ theme_danger_shadow }}; +} + +div.error { + background-color: {{ theme_error_bg }}; + border: 1px solid {{ theme_error_border }}; + -moz-box-shadow: 2px 2px 4px {{ theme_error_shadow }}; + -webkit-box-shadow: 2px 2px 4px {{ theme_error_shadow }}; + box-shadow: 2px 2px 4px {{ theme_error_shadow }}; +} + +div.caution { + background-color: {{ theme_caution_bg }}; + border: 1px solid {{ theme_caution_border }}; +} + +div.attention { + background-color: {{ theme_attention_bg }}; + border: 1px solid {{ theme_attention_border }}; +} + +div.important { + background-color: {{ theme_important_bg }}; + border: 1px solid {{ theme_important_border }}; +} + +div.note { + background-color: {{ theme_note_bg }}; + border: 1px solid {{ theme_note_border }}; +} + +div.tip { + background-color: {{ theme_tip_bg }}; + border: 1px solid {{ theme_tip_border }}; +} + +div.hint { + background-color: {{ theme_hint_bg }}; + border: 1px solid {{ theme_hint_border }}; +} + +div.seealso { + background-color: {{ theme_seealso_bg }}; + border: 1px solid {{ theme_seealso_border }}; +} + +div.topic { + background-color: {{ theme_topic_bg }}; +} + +p.admonition-title { + display: inline; +} + +p.admonition-title:after { + content: ":"; +} + +pre, tt, code { + font-family: {{theme_code_font_family}}; + font-size: {{ theme_code_font_size }}; +} + +.hll { + background-color: {{theme_code_highlight}}; + 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 {{ theme_shadow }}; + -webkit-box-shadow: 2px 2px 4px {{ theme_shadow }}; + box-shadow: 2px 2px 4px {{ theme_shadow }}; +} + +table.docutils { + border: 1px solid {{ theme_table_border }}; + -moz-box-shadow: 2px 2px 4px {{ theme_shadow }}; + -webkit-box-shadow: 2px 2px 4px {{ theme_shadow }}; + box-shadow: 2px 2px 4px {{ theme_shadow }}; +} + +table.docutils td, table.docutils th { + border: 1px solid {{ theme_table_border }}; + 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 {{ theme_footnote_border }}; + background: {{ theme_footnote_bg }}; + 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: {{ theme_pre_bg }}; + padding: 7px 30px; + margin: 15px 0px; + line-height: 1.3em; +} + +div.viewcode-block:target { + background: {{ theme_viewcode_target_bg }}; +} + +dl pre, blockquote pre, li pre { + margin-left: 0; + padding-left: 30px; +} + +tt, code { + background-color: {{ theme_code_bg }}; + color: {{ theme_code_text }}; + /* padding: 1px 2px; */ +} + +tt.xref, code.xref, a tt { + background-color: {{ theme_xref_bg }}; + border-bottom: 1px solid {{ theme_xref_border }}; +} + +a.reference { + text-decoration: none; + border-bottom: 1px dotted {{ theme_link }}; +} + +/* Don't put an underline on images */ +a.image-reference, a.image-reference:hover { + border-bottom: none; +} + +a.reference:hover { + border-bottom: 1px solid {{ theme_link_hover }}; +} + +a.footnote-reference { + text-decoration: none; + font-size: 0.7em; + vertical-align: top; + border-bottom: 1px dotted {{ theme_link }}; +} + +a.footnote-reference:hover { + border-bottom: 1px solid {{ theme_link_hover }}; +} + +a:hover tt, a:hover code { + background: {{ theme_code_hover }}; +} + + +@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: {{ theme_base_bg }}; + } + + div.sphinxsidebar { + display: block; + float: none; + width: 102.5%; + {%- if theme_fixed_sidebar|lower == 'true' %} + margin: -20px -30px 20px -30px; + {%- else %} + margin: 50px -30px -20px -30px; + {%- endif %} + padding: 10px 20px; + background: {{ theme_narrow_sidebar_bg }}; + color: {{ theme_narrow_sidebar_fg }}; + } + + div.sphinxsidebar h3, div.sphinxsidebar h4, div.sphinxsidebar p, + div.sphinxsidebar h3 a { + color: {{ theme_base_bg }}; + } + + div.sphinxsidebar a { + color: {{ theme_narrow_sidebar_link }}; + } + + 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; + } +} + +{%- if theme_fixed_sidebar|lower == 'true' %} +@media screen and (min-width: 876px) { + div.sphinxsidebar { + position: fixed; + margin-left: 0; + } +} +{%- endif %} + + +/* 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; +} diff --git a/doc/_themes/alabaster/alabaster/static/custom.css b/doc/_themes/alabaster/alabaster/static/custom.css new file mode 120000 index 0000000..5e50e76 --- /dev/null +++ b/doc/_themes/alabaster/alabaster/static/custom.css @@ -0,0 +1 @@ +../../../../src/custom.css \ No newline at end of file diff --git a/doc/_themes/alabaster/alabaster/support.py b/doc/_themes/alabaster/alabaster/support.py new file mode 100644 index 0000000..0f3aa8c --- /dev/null +++ b/doc/_themes/alabaster/alabaster/support.py @@ -0,0 +1,88 @@ +# flake8: noqa + +from pygments.style import Style +from pygments.token import Keyword, Name, Comment, String, Error, \ + Number, Operator, Generic, Whitespace, Punctuation, Other, Literal + + +# Originally based on FlaskyStyle which was based on 'tango'. +class Alabaster(Style): + background_color = "#f8f8f8" # doesn't seem to override CSS 'pre' styling? + default_style = "" + + styles = { + # No corresponding class for the following: + #Text: "", # class: '' + Whitespace: "underline #f8f8f8", # class: 'w' + Error: "#a40000 border:#ef2929", # class: 'err' + Other: "#000000", # class 'x' + + Comment: "italic #8f5902", # class: 'c' + Comment.Preproc: "noitalic", # class: 'cp' + + Keyword: "bold #004461", # class: 'k' + Keyword.Constant: "bold #004461", # class: 'kc' + Keyword.Declaration: "bold #004461", # class: 'kd' + Keyword.Namespace: "bold #004461", # class: 'kn' + Keyword.Pseudo: "bold #004461", # class: 'kp' + Keyword.Reserved: "bold #004461", # class: 'kr' + Keyword.Type: "bold #004461", # class: 'kt' + + Operator: "#582800", # class: 'o' + Operator.Word: "bold #004461", # class: 'ow' - like keywords + + Punctuation: "bold #000000", # class: 'p' + + # because special names such as Name.Class, Name.Function, etc. + # are not recognized as such later in the parsing, we choose them + # to look the same as ordinary variables. + Name: "#000000", # class: 'n' + Name.Attribute: "#c4a000", # class: 'na' - to be revised + Name.Builtin: "#004461", # class: 'nb' + Name.Builtin.Pseudo: "#3465a4", # class: 'bp' + Name.Class: "#000000", # class: 'nc' - to be revised + Name.Constant: "#000000", # class: 'no' - to be revised + Name.Decorator: "#888", # class: 'nd' - to be revised + Name.Entity: "#ce5c00", # class: 'ni' + Name.Exception: "bold #cc0000", # class: 'ne' + Name.Function: "#000000", # class: 'nf' + Name.Property: "#000000", # class: 'py' + Name.Label: "#f57900", # class: 'nl' + Name.Namespace: "#000000", # class: 'nn' - to be revised + Name.Other: "#000000", # class: 'nx' + Name.Tag: "bold #004461", # class: 'nt' - like a keyword + Name.Variable: "#000000", # class: 'nv' - to be revised + Name.Variable.Class: "#000000", # class: 'vc' - to be revised + Name.Variable.Global: "#000000", # class: 'vg' - to be revised + Name.Variable.Instance: "#000000", # class: 'vi' - to be revised + + Number: "#990000", # class: 'm' + + Literal: "#000000", # class: 'l' + Literal.Date: "#000000", # class: 'ld' + + String: "#4e9a06", # class: 's' + String.Backtick: "#4e9a06", # class: 'sb' + String.Char: "#4e9a06", # class: 'sc' + String.Doc: "italic #8f5902", # class: 'sd' - like a comment + String.Double: "#4e9a06", # class: 's2' + String.Escape: "#4e9a06", # class: 'se' + String.Heredoc: "#4e9a06", # class: 'sh' + String.Interpol: "#4e9a06", # class: 'si' + String.Other: "#4e9a06", # class: 'sx' + String.Regex: "#4e9a06", # class: 'sr' + String.Single: "#4e9a06", # class: 's1' + String.Symbol: "#4e9a06", # class: 'ss' + + Generic: "#000000", # class: 'g' + Generic.Deleted: "#a40000", # class: 'gd' + Generic.Emph: "italic #000000", # class: 'ge' + Generic.Error: "#ef2929", # class: 'gr' + Generic.Heading: "bold #000080", # class: 'gh' + Generic.Inserted: "#00A000", # class: 'gi' + Generic.Output: "#888", # class: 'go' + Generic.Prompt: "#745334", # class: 'gp' + Generic.Strong: "bold #000000", # class: 'gs' + Generic.Subheading: "bold #800080", # class: 'gu' + Generic.Traceback: "bold #a40000", # class: 'gt' + } diff --git a/doc/_themes/alabaster/alabaster/theme.conf b/doc/_themes/alabaster/alabaster/theme.conf new file mode 100644 index 0000000..b334015 --- /dev/null +++ b/doc/_themes/alabaster/alabaster/theme.conf @@ -0,0 +1,122 @@ +[theme] +inherit = basic +stylesheet = alabaster.css +pygments_style = alabaster.support.Alabaster + +[options] +logo = +logo_name = false +logo_text_align = left +description = +description_font_style = normal +github_user = +github_repo = +github_button = true +github_banner = false +github_type = watch +github_count = true +badge_branch = master +travis_button = false +codecov_button = false +gratipay_user = +gittip_user = +analytics_id = +touch_icon = +canonical_url = +extra_nav_links = +sidebar_includehidden = true +sidebar_collapse = true +show_powered_by = true +show_related = false + +gray_1 = #444 +gray_2 = #EEE +gray_3 = #AAA + +pink_1 = #FCC +pink_2 = #FAA +pink_3 = #D52C2C + +base_bg = #fff +base_text = #000 +hr_border = #B1B4B6 +body_bg = +body_text = #3E4349 +body_text_align = left +footer_text = #888 +link = #004B6B +link_hover = #6D4100 +sidebar_header = +sidebar_text = #555 +sidebar_link = +sidebar_link_underscore = #999 +sidebar_search_button = #CCC +sidebar_list = #000 +sidebar_hr = +anchor = #DDD +anchor_hover_fg = +anchor_hover_bg = #EAEAEA +table_border = #888 +shadow = + +# Admonition options +## basic level +admonition_bg = +admonition_border = #CCC +note_bg = +note_border = #CCC +seealso_bg = +seealso_border = #CCC + +## critical level +danger_bg = +danger_border = +danger_shadow = +error_bg = +error_border = +error_shadow = + +## normal level +tip_bg = +tip_border = #CCC +hint_bg = +hint_border = #CCC +important_bg = +important_border = #CCC + +## warning level +caution_bg = +caution_border = +attention_bg = +attention_border = +warn_bg = +warn_border = + +topic_bg = +code_highlight_bg = +highlight_bg = #FAF3E8 +xref_border = #fff +xref_bg = #FBFBFB +admonition_xref_border = #fafafa +admonition_xref_bg = +footnote_bg = #FDFDFD +footnote_border = +pre_bg = +narrow_sidebar_bg = #333 +narrow_sidebar_fg = #FFF +narrow_sidebar_link = +font_size = 17px +caption_font_size = inherit +viewcode_target_bg = #ffd +code_bg = #ecf0f3 +code_text = #222 +code_hover = #EEE +code_font_size = 0.9em +code_font_family = 'Consolas', 'Menlo', 'Deja Vu Sans Mono', 'Bitstream Vera Sans Mono', monospace +font_family = 'goudy old style', 'minion pro', 'bell mt', Georgia, 'Hiragino Mincho Pro', serif +head_font_family = 'Garamond', 'Georgia', serif +caption_font_family = inherit +code_highlight = #FFC +page_width = 940px +sidebar_width = 220px +fixed_sidebar = false diff --git a/doc/_themes/alabaster/dev-requirements.txt b/doc/_themes/alabaster/dev-requirements.txt new file mode 100644 index 0000000..f9b7c8a --- /dev/null +++ b/doc/_themes/alabaster/dev-requirements.txt @@ -0,0 +1,8 @@ +sphinx>=1.3 +invoke>=0.10.1 +invocations>=0.6.2 +semantic_version>=2.4,<2.5 +wheel==0.24 +twine==1.11.0 +releases>=1.2.0,<2.0 +flake8==2.4.0 diff --git a/doc/_themes/alabaster/docs/changelog.rst b/doc/_themes/alabaster/docs/changelog.rst new file mode 100644 index 0000000..68b72a8 --- /dev/null +++ b/doc/_themes/alabaster/docs/changelog.rst @@ -0,0 +1,175 @@ +========= +Changelog +========= + +* :support:`- backported` Miscellaneous project maintenance updates such as + adding to Travis CI and enforcing the use of ``flake8``. +* :feature:`110 backported` Add ``badge_branch`` option allowing + configurability of which specific Git branch the Travis, Codecov, etc buttons + default to. Credit: ``@TitanSnow``. +* :support:`111 backported` Add setuptools-level entrypoint for improved theme + distribution compatibility. Thanks to Aaron Carlisle for the patch. +* :release:`0.7.10 <2017-02-28>` +* :bug:`32` Update styling of various block-level elements such as admonitions + (``.. note::``, ``.. warning::``, etc) and code blocks (``.. code::``) so + they are no longer 'dedented' outside the main column of text they're + embedded in. This is both a stylistic change and a bugfix, since e.g. nesting + code blocks *within* note blocks looks actively broken. Thanks to Takayuki + Shimizukawa for the report. +* :bug:`96` ``admonition_xref`` had a template typo preventing it from + receiving styling; this has been fixed. Credit: Kenzie Togami. +* :bug:`95` Independently ran across + `sphinx-doc/sphinx#3276 `_, + namely that parameter lists become squashed together if one is running on + Sphinx 1.4.x. While that fix was merged in Sphinx itself, we felt it prudent + to include it in our own stylesheet as well, for immediate relief. +* :release:`0.7.9 <2016-07-25>` +* :feature:`6` (and :issue:`70`, both via :issue:`84`) Make all remaining + hardcoded style colors configurable, plus related cleanup (such as improving + differentiation of some admonition blocks such as ``warn`` and ``note``, + ensuring generic admonitions are left untouched, etc). Credit: + ``@ShadowKyogre``. +* :feature:`83` Expose Sphinx's toctree ``collapse`` option as the new + ``sidebar_collapse`` config option. Credit: Eric Holscher. +* :feature:`80` Add support for ```` (i.e. canonical + URLs). Thanks to Ben Gamari for the patch. +* :support:`7` Generate real documentation site, both because the README is + just too big now, and so we can `eat our own dog food + `_. +* :release:`0.7.8 <2016-05-05>` +* #51 (via #67): Hide Github button if ``github_user`` and ``github_repo`` + aren't set. This is necessary since ``github_button`` defaults to True. + Thanks to Sam Whited for the report & Dmitry Shachnev for the patch. +* #75: Use SVG version of the Travis-CI button. Thanks to Sebastian Wiesner for + the patch. +* #41: Update the Github buttons to use a newer linked image & change the link + to their docs. Thanks to Tomi Hukkalainen. +* #45 (via #46) Tweak styling of nested bullet lists to prevent an issue where + they all collapse to the same indent level when viewed on smaller display + sizes. Thanks to Bram Geron for catch & patch, and to Jochen Kupperschmidt + for review/discussion. +* #44 (partial; via #57) Add an opt-in fixed sidebar behavior for users who + prefer a sidebar that never scrolls out of view. Credit: Joe Cross. +* #61: Set a small-but-nonzero footnote width to work around a common browser + display bug. Thanks to Konstantin Molchanov for catch & patch. +* #64: Add config options for font size and caption font size/family. Credit: + Marçal Solà. +* #78: Add custom stylesheet support. (This release will thus be the last to + merge simplistic style tweaks as feature toggles - only thorny CSS issues or + actual template-related changes will be merged afterwards.) +* #65: Wrap the sidebar's "Navigation" header in Sphinx's translation helper so + it gets translated if possible. Thanks to ``@uralbash``. +* #77: Fix image link styling to remove a bottom border which appears in some + situations. Thanks to Eric Holscher for the patch & ``@barbara-sfx`` for the + report. +* :release:`0.7.7 <2015-12-21>` +* Add some ``margin-bottom`` to ``table.field-list p`` so field lists (e.g. + Python function parameter lists in docstrings) written as multiple + paragraphs, look like actual paragraphs instead of all globbing together. +* Fix incorrect notes in README re: renamed ``github_button_*`` options - the + ``button_`` was dropped but docs did not reflect this. Thanks to Nik Nyby. +* Fix ``sidebar_hr`` setting - stylesheet wasn't correctly referencing the + right variable name. Thanks to Jannis Leidel. +* Allow configuring body text-align via ``body_text_align``. Credit to Marçal + Solà. +* Fix a handful of mismatched/unclosed HTML tags in the templates. Thanks to + Marvin Pinto for catch & patch. +* Add `Codecov `_ badge support to sidebar. +* :release:`0.7.6 <2015-06-22>` +* Update how ``setup.py`` handles the ``README.rst`` file - load it explicitly + as UTF-8 so the changelog containing non-ASCII characters doesn't generate + ``UnicodeDecodeError`` in terminal environments whose default encoding is not + UTF-8 or other Unicode-compatible encodings. Thanks to Arun Persaud for the + report and Max Tepkeev for the suggested fix. +* Fix left-margin & padding styling for code blocks within list-item elements, + making them consistent with earlier changes applied to top-level code blocks. +* Expose page & sidebar widths as theme options ``page_width`` and + ``sidebar_width``. Their defaults are the same as the previously static + values. +* :release:`0.7.5 <2015-06-15>` +* Honor Sphinx's core ``html_show_copyright`` option when rendering page + footer. Thanks to Marcin Wojdyr for the report. +* Pre-history versions of Alabaster attempted to remove the "related" + sub-navigation (typically found as next/previous links in other themes) but + this didn't work right for mobile-oriented styling. + + This has been fixed by (re-)adding an improved sidebar nav element for these + links and making its display controllable via the new ``show_related`` theme + option (which defaults to ``false`` for backwards compatibility). + + .. note:: + To enable the related-links nav, you'll need to set ``show_related`` to + ``true`` **and** add ``relations.html`` to your ``html_sidebars`` (we've + updated the example config in this README to indicate this for new + installs). + + Thanks to Tomi Pieviläinen for the bug report. +* Update the "Fork me on Github" banner image to use an ``https://`` URI so + sites hosted over HTTPS don't encounter mixed-content errors. Thanks to + ``@nikolas`` for the patch. +* Remove an orphaned ```` from the footer 'show source' section. Credit to + Marcin Wojdyr. +* :release:`0.7.4 <2015-05-03>` +* Add ``code_highlight`` option (which includes general fixes to styling of + code blocks containing highlighted lines). Thanks to Steven Loria. +* :release:`0.7.3 <2015-03-20>` +* Hide ``shadow`` related styles on bibliography elements, in addition to the + earlier change re: ``border``. Thanks again to Philippe Dessus. +* :release:`0.7.2 <2015-03-10>` +* Updated CSS stylesheets to apply monospace styling to both ``tt`` and + ``code`` elements, instead of just to ``tt``. This addresses a change in HTML + generation in Sphinx 1.3 while retaining support for Sphinx 1.2. Thanks to + Eric Holscher for the heads up. +* :release:`0.7.1 <2015-02-27>` +* Finally add a changelog. To the README, for now, because a full doc site + isn't worthwhile just yet. +* Allow configuring a custom Github banner image (instead of simply toggling a + default on or off). Thanks to Nicola Iarocci for the original patch. +* Explicitly note Python version support in the README and ``setup.py``. +* Update Github button image link to use the newly-available HTTPS version of + the URL; this helps prevent errors on doc pages served via HTTPS. Thanks to + Gustavo Narea for the report. +* Add control over the font size & family of code blocks. Credit to Steven + Loria. +* Allow control over font family of body text and headings. Thanks to Georg + Brandl. +* Stylize ``.. seealso::`` blocks same as ``.. note::`` blocks for + consistency's sake (previously, ``.. seealso::`` used the Sphinx default + styling, which clashed). We may update these again later but for now, this is + an improvement! Thanks again to Steven Loria. +* Allow control over CSS ``font-style`` for the site description/tagline + element. Credit: Steven Loria. +* Add styling to disable default cell borders on ``.. bibliography::`` + directives' output. Thanks to Philippe Dessus for the report. +* :release:`0.6.2 <2014-11-25>` +* Make ``.. warn::`` blocks have a pink background (instead of having no + background, which was apparently an oversight of the themes Alabaster is + based on) and also make that color configurable. +* :release:`0.6.1 <2014-09-04>` +* Update Gittip support to acknowledge the service's rename to Gratipay. +* :release:`0.6.0 <2014-04-17>` +* Allow hiding the 'powered by' section of the footer. +* Fix outdated name in ``setup.py`` URL field. +* :release:`0.5.1 <2014-04-15>` +* Fix a bug in the new Travis support, re: its default value. +* :release:`0.5.0 <2014-04-09>` +* Add support for sidebar Travis status buttons. +* :release:`0.4.1 <2014-04-06>` +* Fix an inaccuracy in the description of ``logo_text_align``. +* Update logo & text styling to be more sensible. +* :release:`0.4.0 <2014-04-06>` +* Add an option to allow un-hiding one's toctree. +* :release:`0.3.1 <2014-03-13>` +* Improved Python 3 compatibility. +* Update styling of changelog pages generated by `bitprophet/releases + `_. +* :release:`0.3.0 <2014-02-03>` +* Display Alabaster version in footers alongside Sphinx version (necessitating + use of a mini Sphinx extension) plus other footer tweaks. +* :release:`0.2.0 <2014-01-28>` +* Allow control of logo replacement text's alignment. +* Add customized navigation sidebar element. +* Tweak page margins a bit. +* Add a 3rd level of medium-gray to the stylesheet & apply in a few places. +* :release:`0.1.0 <2013-12-31>` +* First tagged/PyPI'd version. diff --git a/doc/_themes/alabaster/docs/conf.py b/doc/_themes/alabaster/docs/conf.py new file mode 100644 index 0000000..82ad04c --- /dev/null +++ b/doc/_themes/alabaster/docs/conf.py @@ -0,0 +1,35 @@ +from datetime import datetime + + +extensions = [] +templates_path = ['_templates'] +source_suffix = '.rst' +master_doc = 'index' + +project = u'Alabaster' +year = datetime.now().year +copyright = u'%d Jeff Forcier' % year + +exclude_patterns = ['_build'] + +html_theme = 'alabaster' +html_sidebars = { + '**': [ + 'about.html', + 'navigation.html', + 'relations.html', + 'searchbox.html', + 'donate.html', + ] +} +html_theme_options = { + 'description': "A light, configurable Sphinx theme", + 'github_user': 'bitprophet', + 'github_repo': 'alabaster', + 'fixed_sidebar': True, +} + +extensions.append('releases') +releases_github_path = 'bitprophet/alabaster' +# Our pre-0.x releases are unstable / mix bugs+features +releases_unstable_prehistory = True diff --git a/doc/_themes/alabaster/docs/customization.rst b/doc/_themes/alabaster/docs/customization.rst new file mode 100644 index 0000000..c2df344 --- /dev/null +++ b/doc/_themes/alabaster/docs/customization.rst @@ -0,0 +1,228 @@ +============= +Customization +============= + +Alabaster's behavior & style can be customized in multiple ways: + +* Various template-level or nontrivial-style settings can be configured via + your ``conf.py`` in ``html_theme_options``; see :ref:`theme-options`. +* As of Alabaster 0.7.8, you can provide your own CSS stylesheet overrides via + a :ref:`custom stylesheet `. This is suitable for changes + that only need minor CSS modifications. + + .. note:: + Some theme options implemented prior to 0.7.8 would have been more suitable + as local custom stylesheet overrides. Therefore: + + * We no longer accept feature requests which are more appropriately solved + by using this functionality instead. + * In future backwards-incompatible versions we may deprecate some of those + options; as such we highly recommend leveraging the custom stylesheet + whenever possible, even if an option is present below. + + * When in doubt, simply check `the built-in stylesheet's template + `_ + to see whether the option you're looking at is a basic variable + insertion or something more complicated.) + + +.. _custom-stylesheet: + +Custom stylesheet +================= + +If you need to modify Alabaster's default CSS styles in a way not covered by +the theme options from the next section, you may provide a custom CSS +stylesheet as follows: + +* Create a file named ``custom.css`` anywhere you prefer (typically + ``_static/``, but this is solely convention) containing your desired + overrides to the CSS found in Alabaster's ``static/alabaster_css_t``. +* Set the core Sphinx option `html_static_path + `_ + to either that file's path, or the directory it lives within. + + +.. _theme-options: + +Theme options +============= + +Alabaster's primary configuration route is the ``html_theme_options`` variable, +set in ``conf.py`` alongside the rest, e.g.: + +.. code-block:: python + + html_theme_options = { + 'logo': 'logo.png', + 'github_user': 'bitprophet', + 'github_repo': 'alabaster', + } + +The following subsections detail available such options, including notes about +behavior & default values. + +Variables and feature toggles +----------------------------- + +* ``logo``: Relative path (from ``$PROJECT/_static/``) to a logo image, which + will appear in the upper left corner above the name of the project. + + * If ``logo`` is not set, your ``project`` name setting (from the top + level Sphinx config) will be used in a text header instead. This + preserves a link back to your homepage from inner doc pages. + +* ``logo_name``: Set to ``true`` to insert your site's ``project`` name + under the logo image as text. Useful if your logo doesn't include the + project name itself. Defaults to ``false``. +* ``logo_text_align``: Which CSS ``text-align`` value to use for logo text + (if there is any.) +* ``body_text_align``: Which CSS ``text-align`` value to use for body text + (if there is any.) +* ``description``: Text blurb about your project, to appear under the logo. +* ``description_font_style``: Which CSS ``font-style`` to use for description + text. Defaults to ``normal``. +* ``github_user``, ``github_repo``: Used by ``github_button`` and + ``github_banner`` (see below); does nothing if both of those are set to + ``false``. +* ``github_button``: ``true`` or ``false`` (default: ``true``) - whether to + link to your Github. + + * If ``true``, requires that you set ``github_user`` and ``github_repo``. + * See also these other related options, which behave as described in + `Github Buttons' documentation + `_: + + * ``github_type``: Defaults to ``watch``. + * ``github_count``: Defaults to ``true``. + +* ``github_banner``: ``true`` or ``false`` (default: ``false``) - whether to + apply a 'Fork me on Github' banner in the top right corner of the page. + + * If ``true``, requires that you set ``github_user`` and ``github_repo``. + * May also submit a string file path (as with ``logo``, relative to + ``$PROJECT/_static/``) to be used as the banner image instead of the + default. + +* ``badge_branch``: Set which branch is used in Travis, CodeCov, etc badges. + Defaults to ``master``. + +* ``travis_button``: ``true``, ``false`` or a Github-style ``"account/repo"`` + string - used to display a `Travis-CI `_ build status + button in the sidebar. If ``true``, uses your ``github_(user|repo)`` + settings; defaults to ``false.`` +* ``codecov_button``: ``true``, ``false`` or a Github-style ``"account/repo"`` + string - used to display a `Codecov `_ build status + button in the sidebar. If ``true``, uses your ``github_(user|repo)`` + settings; defaults to ``false.`` +* ``gratipay_user``: Set to your `Gratipay `_ username + if you want a Gratipay 'Donate' section in your sidebar. + + * This used to be ``gittip_user`` before that service changed its name to + Gratipay; we've left the old setting in place as an alias for backwards + compatibility reasons. It may be removed in the future. + * If both options are given, ``gratipay_user`` wins. + +* ``analytics_id``: Set to your `Google Analytics + `_ ID (e.g. ``UA-#######-##``) to enable + tracking. +* ``touch_icon``: Path to an image (as with ``logo``, relative to + ``$PROJECT/_static/``) to be used for an iOS application icon, for when + pages are saved to an iOS device's home screen via Safari. +* ``canonical_url``: If set, is used as the base URL (set before the relative + path/pagename) for a ```` `canonical URL + `_ header tag. + + .. note:: This value must end with a trailing slash. + +* ``extra_nav_links``: Dictionary mapping link names to link targets; these + will be added in a UL below the main sidebar navigation (provided you've + enabled ``navigation.html`` via the ``html_sidebars`` option; see + :doc:`installation`.) Useful for static links outside your Sphinx doctree. +* ``sidebar_includehidden``: Boolean determining whether the TOC sidebar + should include hidden Sphinx toctree elements. Defaults to ``true`` so you + can use ``:hidden:`` in your index page's root toctree & avoid having 2x + copies of your navigation on your landing page. +* ``sidebar_collapse``: Boolean determining whether all TOC entries that + are not ancestors of the current page are collapsed. + You can read more about this in the Sphinx toctree + `docs `_. +* ``show_powered_by``: Boolean controlling display of the ``Powered by + Sphinx N.N.N. & Alabaster M.M.M`` section of the footer. When ``true``, is + displayed next to the copyright information; when ``false``, is hidden. +* ``show_related``: Boolean controlling whether the 'next/previous/related' + secondary navigation elements are hidden or displayed. Defaults to ``false`` + since on many sites these elements are superfluous. +* ``page_width``: CSS width specifier controlling default content/page width. + Defaults to ``940px``. +* ``sidebar_width``: CSS width specifier controlling default sidebar width. + Defaults to ``220px``. +* ``fixed_sidebar``: Makes the sidebar 'fixed' or pinned in place, so that the + main body of the page scrolls but the sidebar remains visible. (Applies only + to desktop window sizes; the mobile view is unaffected.) Defaults to + ``false``. + +Style colors +------------ + +These should be fully qualified CSS color specifiers such as ``#004B6B`` or +``#444``. The first few items in the list are "global" colors used as defaults +for many of the others; update these to make sweeping changes to the +colorscheme. The more granular settings can be used to override as needed. + +* ``gray_1``: Dark gray. +* ``gray_2``: Light gray. +* ``gray_3``: Medium gray. +* ``pink_1``: Light pink. +* ``pink_2``: Medium pink. +* ``body_text``: Main content text. +* ``footer_text``: Footer text (includes links.) +* ``link``: Non-hovered body links. +* ``link_hover``: Body links, hovered. +* ``sidebar_header``: Sidebar headers. Defaults to ``gray_1``. +* ``sidebar_text``: Sidebar paragraph text. +* ``sidebar_link``: Sidebar links (there is no hover variant.) Applies to + both header & text links. Defaults to ``gray_1``. +* ``sidebar_link_underscore``: Sidebar links' underline (technically a + bottom-border). +* ``sidebar_search_button``: Background color of the search field's 'Go' + button. +* ``sidebar_list``: Foreground color of sidebar list bullets & unlinked text. +* ``sidebar_hr``: Color of sidebar horizontal rule dividers. Defaults to + ``gray_3``. +* ``anchor``: Foreground color of section anchor links (the 'paragraph' + symbol that shows up when you mouseover page section headers.) +* ``anchor_hover_fg``: Foreground color of section anchor links (as above) + when moused over. Defaults to ``gray_1``. +* ``anchor_hover_bg``: Background color of above. +* ``note_bg``: Background of ``.. note::`` blocks. Defaults to ``gray_2``. +* ``note_border``: Border of same. +* ``seealso_bg``: Background of ``.. seealso::`` blocks. Defaults to + ``gray_2``. +* ``seealso_border``: Border of same. +* ``warn_bg``: Background of ``.. warn::`` blocks. Defaults to ``pink_1``. +* ``warn_border``: Border of same. Defaults to ``pink_2``. +* ``footnote_bg``: Background of footnote blocks. +* ``footnote_border``: Border of same. Defaults to ``gray_2``. +* ``pre_bg``: Background of preformatted text blocks (including code + snippets.) Defaults to ``gray_2``. +* ``narrow_sidebar_bg``: Background of 'sidebar' when narrow window forces + it to the bottom of the page. +* ``narrow_sidebar_fg``: Text color of same. +* ``narrow_sidebar_link``: Link color of same. Defaults to ``gray_3``. +* ``code_highlight``: Color of highlight when using ``:emphasize-lines:`` in a code block. + +Fonts +----- + +* ``font_family``: Font family of body text. Defaults to ``'goudy old style', + 'minion pro', 'bell mt', Georgia, 'Hiragino Mincho Pro', serif``. +* ``font_size``: Font size of body text. Defaults to ``17px`` (``1.0625em``). +* ``head_font_family``: Font family of headings. Defaults to ``'Garamond', + 'Georgia', serif``. +* ``code_font_size``: Font size of code block text. Defaults to ``0.9em``. +* ``code_font_family``: Font family of code block text. Defaults to + ``'Consolas', 'Menlo', 'Deja Vu Sans Mono', 'Bitstream Vera Sans Mono', + monospace``. +* ``caption_font_size``: Font size of caption block text. Defaults to ``font-size``. +* ``caption_font_family``: Font family of caption block text. Defaults to ``font-family``. diff --git a/doc/_themes/alabaster/docs/index.rst b/doc/_themes/alabaster/docs/index.rst new file mode 100644 index 0000000..f2957d7 --- /dev/null +++ b/doc/_themes/alabaster/docs/index.rst @@ -0,0 +1,49 @@ +========================= +Alabaster: a Sphinx theme +========================= + +.. include:: ../README.rst + +Features +======== + +* Easy ability to install/use as a Python package (tip o' the hat to `Dave & + Eric's sphinx_rtd_theme `_ for + showing the way); +* Style tweaks compared to the source themes, such as better code-block + alignment, Github button placement, page source link moved to footer, + improved (optional) related-items sidebar item, and many more; +* Many customization hooks, including toggle of various sidebar & footer + components; header/link/etc color control; etc; +* Improved documentation for all customizations (pre-existing & new). + + +Project background +================== + +Alabaster is a modified (with permission) version of `Kenneth Reitz's +`_ `"krTheme" Sphinx theme +`_ (it's the one used +in his `Requests `_ project). Kenneth's +theme was itself originally based on Armin Ronacher's `Flask +`_ theme. Many thanks to both for their hard work. + + +Implementation notes +==================== + +* `Fabric #419 `_ contains a lot of + general exposition & thoughts as I developed Alabaster, specifically with a + mind towards using it on two nearly identical 'sister' sites (single-version + www 'info' site & versioned API docs site). +* Alabaster includes/requires a tiny Sphinx extension on top of the theme + itself; this is just so we can inject dynamic metadata (like Alabaster's own + version number) into template contexts. It doesn't add any additional + directives or the like, at least not yet. + + +.. toctree:: + :hidden: + :glob: + + * diff --git a/doc/_themes/alabaster/docs/installation.rst b/doc/_themes/alabaster/docs/installation.rst new file mode 100644 index 0000000..3964033 --- /dev/null +++ b/doc/_themes/alabaster/docs/installation.rst @@ -0,0 +1,90 @@ +============ +Installation +============ + +The bare minimum required to install Alabaster is as follows: + +* If you're on **Sphinx 1.2 or older**: + + * ``pip install alabaster`` or equivalent. + * Add the following to your ``conf.py`` so Alabaster's theme location & + mini-extension are located & loaded: + + .. code-block:: python + + import alabaster + + html_theme_path = [alabaster.get_path()] + extensions = ['alabaster'] + html_theme = 'alabaster' + + * If you've installed Alabaster by hand (without using ``pip``) and/or are + doing funky things to your PYTHONPATH, you may need to replace the + ``alabaster.get_path()`` call with your own explicit string, as per `the + Sphinx config docs + `_. + +* If you have **Sphinx 1.3 or above**: + + * You already have Alabaster installed as a dependency! No need to manually + install it or explicitly load it. + + .. note:: + If you distribute your documentation via the excellent `Read the Docs + `_, you may need to explicitly enable + Alabaster (as RTD defaults to using its own theme) by adding this line + to your ``conf.py``:: + + html_theme = 'alabaster' + +* **Either way**, add an explicit ``html_sidebars`` setting so Alabaster's + customized sidebar templates are loaded: + + .. code-block:: python + + html_sidebars = { + '**': [ + 'about.html', + 'navigation.html', + 'relations.html', + 'searchbox.html', + 'donate.html', + ] + } + +That's it! You now have the standard Alabaster theme set up. Read on for more +core configuration concerns, or see :doc:`customization` for feature/style +options. + + +Sidebars +-------- + +Feel free to adjust ``html_sidebars`` as desired - the theme is designed +assuming you'll always have ``about.html`` activated, but otherwise it doesn't +care much. + +* See `the Sphinx docs + `_ for details on + how this setting behaves. +* Alabaster provides ``about.html`` (logo, github button + blurb), + ``donate.html`` (Gratipay blurb/button) and ``navigation.html`` (a more + flexible version of the builtin ``localtoc``/``globaltoc`` templates). + ``searchbox.html`` comes with Sphinx itself. + + +.. _static-path: + +Static path for images and/or custom stylesheet +----------------------------------------------- + +If you're using any of the image-related options listed on :doc:`customization` +(``logo`` or ``touch-icon``) or a :ref:`custom stylesheet `, +you'll also want to tell Sphinx where to get these files from. If so, add a +line like this (changing the path if necessary; see `the Sphinx docs for +'html_static_path' +`_) to your ``conf.py``: + +.. code-block:: python + + html_static_path = ['_static'] diff --git a/doc/_themes/alabaster/setup.cfg b/doc/_themes/alabaster/setup.cfg new file mode 100644 index 0000000..04af7cb --- /dev/null +++ b/doc/_themes/alabaster/setup.cfg @@ -0,0 +1,9 @@ +[bdist_wheel] +universal = 1 + +[metadata] +license_file = LICENSE + +[flake8] +ignore = E124,E125,E128,E261,E301,E302,E303 +max-line-length = 79 diff --git a/doc/_themes/alabaster/setup.py b/doc/_themes/alabaster/setup.py new file mode 100644 index 0000000..2170208 --- /dev/null +++ b/doc/_themes/alabaster/setup.py @@ -0,0 +1,51 @@ +#!/usr/bin/env python + +import codecs +from setuptools import setup + +# Version info -- read without importing +_locals = {} +with open('alabaster/_version.py') as fp: + exec(fp.read(), None, _locals) +version = _locals['__version__'] + +# README into long description +with codecs.open('README.rst', encoding='utf-8') as f: + readme = f.read() + +setup( + name='alabaster', + version=version, + description='A configurable sidebar-enabled Sphinx theme', + long_description=readme, + author='Jeff Forcier', + author_email='jeff@bitprophet.org', + url='https://alabaster.readthedocs.io', + packages=['alabaster'], + include_package_data=True, + entry_points={ + 'sphinx.html_themes': [ + 'alabaster = alabaster', + ] + }, + classifiers=[ + 'Development Status :: 5 - Production/Stable', + 'Intended Audience :: Developers', + 'License :: OSI Approved :: BSD License', + 'Operating System :: OS Independent', + 'Programming Language :: Python', + 'Programming Language :: Python :: 2', + 'Programming Language :: Python :: 2.6', + 'Programming Language :: Python :: 2.7', + 'Programming Language :: Python :: 3', + 'Programming Language :: Python :: 3.2', + 'Programming Language :: Python :: 3.3', + 'Programming Language :: Python :: 3.4', + 'Programming Language :: Python :: 3.5', + 'Programming Language :: Python :: 3.6', + 'Programming Language :: Python :: Implementation :: CPython', + 'Programming Language :: Python :: Implementation :: PyPy', + 'Topic :: Documentation', + 'Topic :: Software Development :: Documentation', + ], +) diff --git a/doc/_themes/alabaster/tasks.py b/doc/_themes/alabaster/tasks.py new file mode 100644 index 0000000..ff51d9e --- /dev/null +++ b/doc/_themes/alabaster/tasks.py @@ -0,0 +1,13 @@ +from invoke import Collection +from invocations import docs +from invocations.packaging import release + + +ns = Collection(release, docs) +ns.configure({ + 'packaging': { + 'sign': True, + 'wheel': True, + 'changelog_file': 'docs/changelog.rst', + } +}) diff --git a/doc/build/doctrees/commands/apidoc/modules.doctree b/doc/build/doctrees/commands/apidoc/modules.doctree new file mode 100644 index 0000000..7d6f90e 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..1e7d19c 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..4ef126d 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..bade1c3 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..3c4dcad 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..4dddde6 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..7266a1f 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..c88330f 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..284094e 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..9f32b81 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..5cad307 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..d311772 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..8dbe702 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..9d39c88 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..073ae4e 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..06e4560 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..29be655 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..f562e29 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..2a6501d 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..f4e01f0 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..83f65b3 --- /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: d7bdbf2f29518819f629c0dfc8f7331a +tags: 645f666f9bcd5a90fca523b33c5a78b7 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..1f4ee4a --- /dev/null +++ b/doc/build/html/_modules/index.html @@ -0,0 +1,101 @@ + + + + + + + + Overview: module code — salomeTools 5.0.0dev documentation + + + + + + + + + + + + + + + + + + +
+
+
+
+ +

All modules for which code is available

+ + +
+
+
+ +
+
+
+ ©2018, CEA. + + | + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 + +
+ + + + + + \ 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..c03cb3d --- /dev/null +++ b/doc/build/html/_modules/src/ElementTree.html @@ -0,0 +1,1379 @@ + + + + + + + + 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

+
+ +
+
+
+ +
+
+
+ ©2018, CEA. + + | + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 + +
+ + + + + + \ 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..b32dd4c --- /dev/null +++ b/doc/build/html/_modules/src/__init__.html @@ -0,0 +1,531 @@ + + + + + + + + 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"

+
+
+ +
+
+
+ +
+
+
+ ©2018, CEA. + + | + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 + +
+ + + + + + \ 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..34f1184 --- /dev/null +++ b/doc/build/html/_modules/src/architecture.html @@ -0,0 +1,225 @@ + + + + + + + + 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

+
+ +
+
+
+ +
+
+
+ ©2018, CEA. + + | + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 + +
+ + + + + + \ 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..a28a4c7 --- /dev/null +++ b/doc/build/html/_modules/src/colorama/ansi.html @@ -0,0 +1,183 @@ + + + + + + + + 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()
+
+ +
+
+
+ +
+
+
+ ©2018, CEA. + + | + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 + +
+ + + + + + \ 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..e619a62 --- /dev/null +++ b/doc/build/html/_modules/src/colorama/ansitowin32.html @@ -0,0 +1,317 @@ + + + + + + + + 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

+
+ +
+
+
+ +
+
+
+ ©2018, CEA. + + | + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 + +
+ + + + + + \ 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..d26d883 --- /dev/null +++ b/doc/build/html/_modules/src/colorama/initialise.html @@ -0,0 +1,163 @@ + + + + + + + + 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

+
+
+
[docs]@contextlib.contextmanager
+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

+
+
+
+ +
+
+
+ +
+
+
+ ©2018, CEA. + + | + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 + +
+ + + + + + \ 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..9f4e534 --- /dev/null +++ b/doc/build/html/_modules/src/colorama/win32.html @@ -0,0 +1,235 @@ + + + + + + + + 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)
+
+ +
+
+
+ +
+
+
+ ©2018, CEA. + + | + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 + +
+ + + + + + \ 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..777fcfd --- /dev/null +++ b/doc/build/html/_modules/src/colorama/winterm.html @@ -0,0 +1,243 @@ + + + + + + + + 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)

+
+ +
+
+
+ +
+
+
+ ©2018, CEA. + + | + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 + +
+ + + + + + \ 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..533a60a --- /dev/null +++ b/doc/build/html/_modules/src/compilation.html @@ -0,0 +1,574 @@ + + + + + + + + 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())

+        
+
+ +
+
+
+ +
+
+
+ ©2018, CEA. + + | + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 + +
+ + + + + + \ 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..227c71f --- /dev/null +++ b/doc/build/html/_modules/src/debug.html @@ -0,0 +1,283 @@ + + + + + + + + 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))
+
+ +
+
+
+ +
+
+
+ ©2018, CEA. + + | + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 + +
+ + + + + + \ 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..fb9c49d --- /dev/null +++ b/doc/build/html/_modules/src/environment.html @@ -0,0 +1,968 @@ + + + + + + + + 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)

+
+ +
+
+
+ +
+
+
+ ©2018, CEA. + + | + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 + +
+ + + + + + \ 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..098a7eb --- /dev/null +++ b/doc/build/html/_modules/src/fileEnviron.html @@ -0,0 +1,950 @@ + + + + + + + + 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)
+#
+"""
+    
+
+ +
+
+
+ +
+
+
+ ©2018, CEA. + + | + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 + +
+ + + + + + \ 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..c7b2490 --- /dev/null +++ b/doc/build/html/_modules/src/fork.html @@ -0,0 +1,242 @@ + + + + + + + + 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

+
+ +
+
+
+ +
+
+
+ ©2018, CEA. + + | + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 + +
+ + + + + + \ 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..1757670 --- /dev/null +++ b/doc/build/html/_modules/src/logger.html @@ -0,0 +1,492 @@ + + + + + + + + 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')

+
+ +
+
+
+ +
+
+
+ ©2018, CEA. + + | + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 + +
+ + + + + + \ 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..b27df28 --- /dev/null +++ b/doc/build/html/_modules/src/options.html @@ -0,0 +1,277 @@ + + + + + + + + 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

+
+
+ +
+
+
+ +
+
+
+ ©2018, CEA. + + | + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 + +
+ + + + + + \ 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..bba9968 --- /dev/null +++ b/doc/build/html/_modules/src/printcolors.html @@ -0,0 +1,266 @@ + + + + + + + + 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

+
+
+
+
+
+# This method prints the color map
+
+
+
+
+ +
+
+
+ +
+
+
+ ©2018, CEA. + + | + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 + +
+ + + + + + \ 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..14c4799 --- /dev/null +++ b/doc/build/html/_modules/src/product.html @@ -0,0 +1,903 @@ + + + + + + + + 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

+
+ +
+
+
+ +
+
+
+ ©2018, CEA. + + | + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 + +
+ + + + + + \ 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..f58827c --- /dev/null +++ b/doc/build/html/_modules/src/pyconf.html @@ -0,0 +1,1822 @@ + + + + + + + + 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

+
+ +
+
+
+ +
+
+
+ ©2018, CEA. + + | + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 + +
+ + + + + + \ 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..ec2338e --- /dev/null +++ b/doc/build/html/_modules/src/system.html @@ -0,0 +1,297 @@ + + + + + + + + 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)

+
+ +
+
+
+ +
+
+
+ ©2018, CEA. + + | + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 + +
+ + + + + + \ 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..e79f036 --- /dev/null +++ b/doc/build/html/_modules/src/template.html @@ -0,0 +1,110 @@ + + + + + + + + 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)

+
+
+ +
+
+
+ +
+
+
+ ©2018, CEA. + + | + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 + +
+ + + + + + \ 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..c9b8bca --- /dev/null +++ b/doc/build/html/_modules/src/test_module.html @@ -0,0 +1,982 @@ + + + + + + + + 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) + "+ "

+
+
+ +
+
+
+ +
+
+
+ ©2018, CEA. + + | + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 + +
+ + + + + + \ 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..e068203 --- /dev/null +++ b/doc/build/html/_modules/src/xmlManager.html @@ -0,0 +1,293 @@ + + + + + + + + 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()   

+    
+
+ +
+
+
+ +
+
+
+ ©2018, CEA. + + | + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 + +
+ + + + + + \ No newline at end of file diff --git a/doc/build/html/_sources/commands/apidoc/modules.rst.txt b/doc/build/html/_sources/commands/apidoc/modules.rst.txt new file mode 100644 index 0000000..e9ff8ac --- /dev/null +++ b/doc/build/html/_sources/commands/apidoc/modules.rst.txt @@ -0,0 +1,7 @@ +src +=== + +.. toctree:: + :maxdepth: 4 + + src diff --git a/doc/build/html/_sources/commands/apidoc/src.colorama.rst.txt b/doc/build/html/_sources/commands/apidoc/src.colorama.rst.txt new file mode 100644 index 0000000..ba8c5f6 --- /dev/null +++ b/doc/build/html/_sources/commands/apidoc/src.colorama.rst.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.rst.txt b/doc/build/html/_sources/commands/apidoc/src.rst.txt new file mode 100644 index 0000000..ac8627e --- /dev/null +++ b/doc/build/html/_sources/commands/apidoc/src.rst.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.rst.txt b/doc/build/html/_sources/commands/application.rst.txt new file mode 100644 index 0000000..2052da0 --- /dev/null +++ b/doc/build/html/_sources/commands/application.rst.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.rst.txt b/doc/build/html/_sources/commands/clean.rst.txt new file mode 100644 index 0000000..e5d2f38 --- /dev/null +++ b/doc/build/html/_sources/commands/clean.rst.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.rst.txt b/doc/build/html/_sources/commands/compile.rst.txt new file mode 100644 index 0000000..915705e --- /dev/null +++ b/doc/build/html/_sources/commands/compile.rst.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.rst.txt b/doc/build/html/_sources/commands/config.rst.txt new file mode 100644 index 0000000..ffcfdf9 --- /dev/null +++ b/doc/build/html/_sources/commands/config.rst.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.rst.txt b/doc/build/html/_sources/commands/environ.rst.txt new file mode 100644 index 0000000..d487e4c --- /dev/null +++ b/doc/build/html/_sources/commands/environ.rst.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:: bash + + 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:: bash + + 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.rst.txt b/doc/build/html/_sources/commands/generate.rst.txt new file mode 100644 index 0000000..f753261 --- /dev/null +++ b/doc/build/html/_sources/commands/generate.rst.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.rst.txt b/doc/build/html/_sources/commands/launcher.rst.txt new file mode 100644 index 0000000..864a31a --- /dev/null +++ b/doc/build/html/_sources/commands/launcher.rst.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.rst.txt b/doc/build/html/_sources/commands/log.rst.txt new file mode 100644 index 0000000..9908f4b --- /dev/null +++ b/doc/build/html/_sources/commands/log.rst.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.rst.txt b/doc/build/html/_sources/commands/package.rst.txt new file mode 100644 index 0000000..6d6648a --- /dev/null +++ b/doc/build/html/_sources/commands/package.rst.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.rst.txt b/doc/build/html/_sources/commands/prepare.rst.txt new file mode 100644 index 0000000..a28fdae --- /dev/null +++ b/doc/build/html/_sources/commands/prepare.rst.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.rst.txt b/doc/build/html/_sources/configuration.rst.txt new file mode 100644 index 0000000..7f415a3 --- /dev/null +++ b/doc/build/html/_sources/configuration.rst.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.rst.txt b/doc/build/html/_sources/index.rst.txt new file mode 100644 index 0000000..3428cdf --- /dev/null +++ b/doc/build/html/_sources/index.rst.txt @@ -0,0 +1,83 @@ + +.. include:: ../rst_prolog.rst + +.. empty first toctree is used for pdf contents maxdepth, see sphinx/builders/latex/__init__.py, toctrees[0].get('maxdepth') + +.. toctree:: + :maxdepth: 2 + +************ +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. + +Find a `pdf version of this documentation `_ + + +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.rst.txt b/doc/build/html/_sources/installation_of_sat.rst.txt new file mode 100644 index 0000000..da661be --- /dev/null +++ b/doc/build/html/_sources/installation_of_sat.rst.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.rst.txt b/doc/build/html/_sources/release_notes/release_notes_5.0.0.rst.txt new file mode 100644 index 0000000..55b6aad --- /dev/null +++ b/doc/build/html/_sources/release_notes/release_notes_5.0.0.rst.txt @@ -0,0 +1,5 @@ +*************** +Release notes +*************** + +In construction. diff --git a/doc/build/html/_sources/usage_of_sat.rst.txt b/doc/build/html/_sources/usage_of_sat.rst.txt new file mode 100644 index 0000000..80c7b46 --- /dev/null +++ b/doc/build/html/_sources/usage_of_sat.rst.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.rst.txt b/doc/build/html/_sources/write_command.rst.txt new file mode 100644 index 0000000..9a68de8 --- /dev/null +++ b/doc/build/html/_sources/write_command.rst.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..19ced10 --- /dev/null +++ b/doc/build/html/_static/basic.css @@ -0,0 +1,665 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2018 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%; + word-wrap: break-word; + overflow-wrap : break-word; +} + +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"] { + float: left; + width: 80%; + padding: 0.25em; + box-sizing: border-box; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + float: left; + width: 20%; + border-left: none; + padding: 0.25em; + box-sizing: border-box; +} + + +img { + border: 0; + max-width: 100%; +} + +/* -- 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%; + margin-left: auto; + margin-right: auto; +} + +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 ul { + margin-top: 0; + margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; +} + +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; +} + +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + +/* -- general body styles --------------------------------------------------- */ + +div.body { + min-width: 450px; + max-width: 800px; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + +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, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.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.align-center { + margin-left: auto; + margin-right: auto; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +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.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; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text { +} + +/* -- field list styles ----------------------------------------------------- */ + +table.field-list td, table.field-list th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +/* -- 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, span.highlighted { + background-color: #fbe54e; +} + +rect.highlighted { + fill: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.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 */ +} + +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; +} + +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; +} + +div.code-block-caption { + padding: 2px 5px; + font-size: small; +} + +div.code-block-caption code { + background-color: transparent; +} + +div.code-block-caption + div > div.highlight > pre { + margin-top: 0; +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + padding: 1em 1em 0; +} + +div.literal-block-wrapper div.highlight { + margin: 0; +} + +code.descname { + background-color: transparent; + font-weight: bold; + font-size: 1.2em; +} + +code.descclassname { + background-color: transparent; +} + +code.xref, a code { + background-color: transparent; + font-weight: bold; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + 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; +} + +span.eqno a.headerlink { + position: relative; + left: 0px; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + +/* -- 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..15e27ed 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..4d91bcf 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..dfbc0cb 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..a088ba6 --- /dev/null +++ b/doc/build/html/_static/custom.css @@ -0,0 +1,25 @@ +/* This file is for theme alabaster custom. */ + +/* +http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html +set backquotes: ``text`` for code samples more color red +*/ +tt, code { + background-color: #ecf0f3; + color: #842; + /* padding: 1px 2px; */ +} + +/* +set 'Note:' etc size less than titles +*/ +div.admonition p.admonition-title { + font-family: {{ theme_head_font_family }}; + font-weight: normal; + font-size: 16px; + margin: 0 0 10px 0; + padding: 0; + line-height: 1; +} + + diff --git a/doc/build/html/_static/doctools.js b/doc/build/html/_static/doctools.js new file mode 100644 index 0000000..d892892 --- /dev/null +++ b/doc/build/html/_static/doctools.js @@ -0,0 +1,313 @@ +/* + * doctools.js + * ~~~~~~~~~~~ + * + * Sphinx JavaScript utilities for all documentation. + * + * :copyright: Copyright 2007-2018 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; +}; + +/** + * 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, addItems) { + if (node.nodeType === 3) { + var val = node.nodeValue; + var pos = val.toLowerCase().indexOf(text); + if (pos >= 0 && + !jQuery(node.parentNode).hasClass(className) && + !jQuery(node.parentNode).hasClass("nohighlight")) { + var span; + var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + 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); + if (isInSVG) { + var bbox = span.getBBox(); + var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute('class', className); + var parentOfText = node.parentNode.parentNode; + addItems.push({ + "parent": node.parentNode, + "target": rect}); + } + } + } + else if (!jQuery(node).is("button, select, textarea")) { + jQuery.each(node.childNodes, function() { + highlight(this, addItems); + }); + } + } + var addItems = []; + var result = this.each(function() { + highlight(this, addItems); + }); + for (var i = 0; i < addItems.length; ++i) { + jQuery(addItems[i].parent).before(addItems[i].target); + } + return result; +}; + +/* + * backward compatibility for jQuery.browser + * This will be supported until firefox bug is fixed. + */ +if (!jQuery.browser) { + jQuery.uaMatch = function(ua) { + ua = ua.toLowerCase(); + + var match = /(chrome)[ \/]([\w.]+)/.exec(ua) || + /(webkit)[ \/]([\w.]+)/.exec(ua) || + /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) || + /(msie) ([\w.]+)/.exec(ua) || + ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) || + []; + + return { + browser: match[ 1 ] || "", + version: match[ 2 ] || "0" + }; + }; + jQuery.browser = {}; + jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true; +} + +/** + * 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 + * see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075 + */ + 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'); + if (!body.length) { + body = $('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); + }, + + initOnKeyListeners: function() { + $(document).keyup(function(event) { + var activeElementType = document.activeElement.tagName; + // don't navigate when in search box or textarea + if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT') { + switch (event.keyCode) { + case 37: // left + var prevHref = $('link[rel="prev"]').prop('href'); + if (prevHref) { + window.location.href = prevHref; + return false; + } + case 39: // right + var nextHref = $('link[rel="next"]').prop('href'); + if (nextHref) { + window.location.href = nextHref; + return false; + } + } + } + }); + } +}; + +// quick alias for translations +_ = Documentation.gettext; + +$(document).ready(function() { + Documentation.init(); +}); \ No newline at end of file diff --git a/doc/build/html/_static/documentation_options.js b/doc/build/html/_static/documentation_options.js new file mode 100644 index 0000000..47f9066 --- /dev/null +++ b/doc/build/html/_static/documentation_options.js @@ -0,0 +1,9 @@ +var DOCUMENTATION_OPTIONS = { + URL_ROOT: '', + VERSION: '5.0.0dev', + LANGUAGE: 'None', + COLLAPSE_INDEX: false, + FILE_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt' +}; \ No newline at end of file diff --git a/doc/build/html/_static/down-pressed.png b/doc/build/html/_static/down-pressed.png new file mode 100644 index 0000000..5756c8c 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..1b3bdad 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..a858a41 Binary files /dev/null and b/doc/build/html/_static/file.png differ diff --git a/doc/build/html/_static/jquery-3.2.1.js b/doc/build/html/_static/jquery-3.2.1.js new file mode 100644 index 0000000..d2d8ca4 --- /dev/null +++ b/doc/build/html/_static/jquery-3.2.1.js @@ -0,0 +1,10253 @@ +/*! + * jQuery JavaScript Library v3.2.1 + * https://jquery.com/ + * + * Includes Sizzle.js + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://jquery.org/license + * + * Date: 2017-03-20T18:59Z + */ +( function( global, factory ) { + + "use strict"; + + if ( typeof module === "object" && typeof module.exports === "object" ) { + + // For CommonJS and CommonJS-like environments where a proper `window` + // is present, execute the factory and get jQuery. + // For environments that do not have a `window` with a `document` + // (such as Node.js), expose a factory as module.exports. + // This accentuates the need for the creation of a real `window`. + // e.g. var jQuery = require("jquery")(window); + // See ticket #14549 for more info. + module.exports = global.document ? + factory( global, true ) : + function( w ) { + if ( !w.document ) { + throw new Error( "jQuery requires a window with a document" ); + } + return factory( w ); + }; + } else { + factory( global ); + } + +// Pass this if window is not defined yet +} )( typeof window !== "undefined" ? window : this, function( window, noGlobal ) { + +// Edge <= 12 - 13+, Firefox <=18 - 45+, IE 10 - 11, Safari 5.1 - 9+, iOS 6 - 9.1 +// throw exceptions when non-strict code (e.g., ASP.NET 4.5) accesses strict mode +// arguments.callee.caller (trac-13335). But as of jQuery 3.0 (2016), strict mode should be common +// enough that all such attempts are guarded in a try block. +"use strict"; + +var arr = []; + +var document = window.document; + +var getProto = Object.getPrototypeOf; + +var slice = arr.slice; + +var concat = arr.concat; + +var push = arr.push; + +var indexOf = arr.indexOf; + +var class2type = {}; + +var toString = class2type.toString; + +var hasOwn = class2type.hasOwnProperty; + +var fnToString = hasOwn.toString; + +var ObjectFunctionString = fnToString.call( Object ); + +var support = {}; + + + + function DOMEval( code, doc ) { + doc = doc || document; + + var script = doc.createElement( "script" ); + + script.text = code; + doc.head.appendChild( script ).parentNode.removeChild( script ); + } +/* global Symbol */ +// Defining this global in .eslintrc.json would create a danger of using the global +// unguarded in another place, it seems safer to define global only for this module + + + +var + version = "3.2.1", + + // Define a local copy of jQuery + jQuery = function( selector, context ) { + + // The jQuery object is actually just the init constructor 'enhanced' + // Need init if jQuery is called (just allow error to be thrown if not included) + return new jQuery.fn.init( selector, context ); + }, + + // Support: Android <=4.0 only + // Make sure we trim BOM and NBSP + rtrim = /^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g, + + // Matches dashed string for camelizing + rmsPrefix = /^-ms-/, + rdashAlpha = /-([a-z])/g, + + // Used by jQuery.camelCase as callback to replace() + fcamelCase = function( all, letter ) { + return letter.toUpperCase(); + }; + +jQuery.fn = jQuery.prototype = { + + // The current version of jQuery being used + jquery: version, + + constructor: jQuery, + + // The default length of a jQuery object is 0 + length: 0, + + toArray: function() { + return slice.call( this ); + }, + + // Get the Nth element in the matched element set OR + // Get the whole matched element set as a clean array + get: function( num ) { + + // Return all the elements in a clean array + if ( num == null ) { + return slice.call( this ); + } + + // Return just the one element from the set + return num < 0 ? this[ num + this.length ] : this[ num ]; + }, + + // Take an array of elements and push it onto the stack + // (returning the new matched element set) + pushStack: function( elems ) { + + // Build a new jQuery matched element set + var ret = jQuery.merge( this.constructor(), elems ); + + // Add the old object onto the stack (as a reference) + ret.prevObject = this; + + // Return the newly-formed element set + return ret; + }, + + // Execute a callback for every element in the matched set. + each: function( callback ) { + return jQuery.each( this, callback ); + }, + + map: function( callback ) { + return this.pushStack( jQuery.map( this, function( elem, i ) { + return callback.call( elem, i, elem ); + } ) ); + }, + + slice: function() { + return this.pushStack( slice.apply( this, arguments ) ); + }, + + first: function() { + return this.eq( 0 ); + }, + + last: function() { + return this.eq( -1 ); + }, + + eq: function( i ) { + var len = this.length, + j = +i + ( i < 0 ? len : 0 ); + return this.pushStack( j >= 0 && j < len ? [ this[ j ] ] : [] ); + }, + + end: function() { + return this.prevObject || this.constructor(); + }, + + // For internal use only. + // Behaves like an Array's method, not like a jQuery method. + push: push, + sort: arr.sort, + splice: arr.splice +}; + +jQuery.extend = jQuery.fn.extend = function() { + var options, name, src, copy, copyIsArray, clone, + target = arguments[ 0 ] || {}, + i = 1, + length = arguments.length, + deep = false; + + // Handle a deep copy situation + if ( typeof target === "boolean" ) { + deep = target; + + // Skip the boolean and the target + target = arguments[ i ] || {}; + i++; + } + + // Handle case when target is a string or something (possible in deep copy) + if ( typeof target !== "object" && !jQuery.isFunction( target ) ) { + target = {}; + } + + // Extend jQuery itself if only one argument is passed + if ( i === length ) { + target = this; + i--; + } + + for ( ; i < length; i++ ) { + + // Only deal with non-null/undefined values + if ( ( options = arguments[ i ] ) != null ) { + + // Extend the base object + for ( name in options ) { + src = target[ name ]; + copy = options[ name ]; + + // Prevent never-ending loop + if ( target === copy ) { + continue; + } + + // Recurse if we're merging plain objects or arrays + if ( deep && copy && ( jQuery.isPlainObject( copy ) || + ( copyIsArray = Array.isArray( copy ) ) ) ) { + + if ( copyIsArray ) { + copyIsArray = false; + clone = src && Array.isArray( src ) ? src : []; + + } else { + clone = src && jQuery.isPlainObject( src ) ? src : {}; + } + + // Never move original objects, clone them + target[ name ] = jQuery.extend( deep, clone, copy ); + + // Don't bring in undefined values + } else if ( copy !== undefined ) { + target[ name ] = copy; + } + } + } + } + + // Return the modified object + return target; +}; + +jQuery.extend( { + + // Unique for each copy of jQuery on the page + expando: "jQuery" + ( version + Math.random() ).replace( /\D/g, "" ), + + // Assume jQuery is ready without the ready module + isReady: true, + + error: function( msg ) { + throw new Error( msg ); + }, + + noop: function() {}, + + isFunction: function( obj ) { + return jQuery.type( obj ) === "function"; + }, + + isWindow: function( obj ) { + return obj != null && obj === obj.window; + }, + + isNumeric: function( obj ) { + + // As of jQuery 3.0, isNumeric is limited to + // strings and numbers (primitives or objects) + // that can be coerced to finite numbers (gh-2662) + var type = jQuery.type( obj ); + return ( type === "number" || type === "string" ) && + + // parseFloat NaNs numeric-cast false positives ("") + // ...but misinterprets leading-number strings, particularly hex literals ("0x...") + // subtraction forces infinities to NaN + !isNaN( obj - parseFloat( obj ) ); + }, + + isPlainObject: function( obj ) { + var proto, Ctor; + + // Detect obvious negatives + // Use toString instead of jQuery.type to catch host objects + if ( !obj || toString.call( obj ) !== "[object Object]" ) { + return false; + } + + proto = getProto( obj ); + + // Objects with no prototype (e.g., `Object.create( null )`) are plain + if ( !proto ) { + return true; + } + + // Objects with prototype are plain iff they were constructed by a global Object function + Ctor = hasOwn.call( proto, "constructor" ) && proto.constructor; + return typeof Ctor === "function" && fnToString.call( Ctor ) === ObjectFunctionString; + }, + + isEmptyObject: function( obj ) { + + /* eslint-disable no-unused-vars */ + // See https://github.com/eslint/eslint/issues/6125 + var name; + + for ( name in obj ) { + return false; + } + return true; + }, + + type: function( obj ) { + if ( obj == null ) { + return obj + ""; + } + + // Support: Android <=2.3 only (functionish RegExp) + return typeof obj === "object" || typeof obj === "function" ? + class2type[ toString.call( obj ) ] || "object" : + typeof obj; + }, + + // Evaluates a script in a global context + globalEval: function( code ) { + DOMEval( code ); + }, + + // Convert dashed to camelCase; used by the css and data modules + // Support: IE <=9 - 11, Edge 12 - 13 + // Microsoft forgot to hump their vendor prefix (#9572) + camelCase: function( string ) { + return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase ); + }, + + each: function( obj, callback ) { + var length, i = 0; + + if ( isArrayLike( obj ) ) { + length = obj.length; + for ( ; i < length; i++ ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } else { + for ( i in obj ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } + + return obj; + }, + + // Support: Android <=4.0 only + trim: function( text ) { + return text == null ? + "" : + ( text + "" ).replace( rtrim, "" ); + }, + + // results is for internal usage only + makeArray: function( arr, results ) { + var ret = results || []; + + if ( arr != null ) { + if ( isArrayLike( Object( arr ) ) ) { + jQuery.merge( ret, + typeof arr === "string" ? + [ arr ] : arr + ); + } else { + push.call( ret, arr ); + } + } + + return ret; + }, + + inArray: function( elem, arr, i ) { + return arr == null ? -1 : indexOf.call( arr, elem, i ); + }, + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + merge: function( first, second ) { + var len = +second.length, + j = 0, + i = first.length; + + for ( ; j < len; j++ ) { + first[ i++ ] = second[ j ]; + } + + first.length = i; + + return first; + }, + + grep: function( elems, callback, invert ) { + var callbackInverse, + matches = [], + i = 0, + length = elems.length, + callbackExpect = !invert; + + // Go through the array, only saving the items + // that pass the validator function + for ( ; i < length; i++ ) { + callbackInverse = !callback( elems[ i ], i ); + if ( callbackInverse !== callbackExpect ) { + matches.push( elems[ i ] ); + } + } + + return matches; + }, + + // arg is for internal usage only + map: function( elems, callback, arg ) { + var length, value, + i = 0, + ret = []; + + // Go through the array, translating each of the items to their new values + if ( isArrayLike( elems ) ) { + length = elems.length; + for ( ; i < length; i++ ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + + // Go through every key on the object, + } else { + for ( i in elems ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + } + + // Flatten any nested arrays + return concat.apply( [], ret ); + }, + + // A global GUID counter for objects + guid: 1, + + // Bind a function to a context, optionally partially applying any + // arguments. + proxy: function( fn, context ) { + var tmp, args, proxy; + + if ( typeof context === "string" ) { + tmp = fn[ context ]; + context = fn; + fn = tmp; + } + + // Quick check to determine if target is callable, in the spec + // this throws a TypeError, but we will just return undefined. + if ( !jQuery.isFunction( fn ) ) { + return undefined; + } + + // Simulated bind + args = slice.call( arguments, 2 ); + proxy = function() { + return fn.apply( context || this, args.concat( slice.call( arguments ) ) ); + }; + + // Set the guid of unique handler to the same of original handler, so it can be removed + proxy.guid = fn.guid = fn.guid || jQuery.guid++; + + return proxy; + }, + + now: Date.now, + + // jQuery.support is not used in Core but other projects attach their + // properties to it so it needs to exist. + support: support +} ); + +if ( typeof Symbol === "function" ) { + jQuery.fn[ Symbol.iterator ] = arr[ Symbol.iterator ]; +} + +// Populate the class2type map +jQuery.each( "Boolean Number String Function Array Date RegExp Object Error Symbol".split( " " ), +function( i, name ) { + class2type[ "[object " + name + "]" ] = name.toLowerCase(); +} ); + +function isArrayLike( obj ) { + + // Support: real iOS 8.2 only (not reproducible in simulator) + // `in` check used to prevent JIT error (gh-2145) + // hasOwn isn't used here due to false negatives + // regarding Nodelist length in IE + var length = !!obj && "length" in obj && obj.length, + type = jQuery.type( obj ); + + if ( type === "function" || jQuery.isWindow( obj ) ) { + return false; + } + + return type === "array" || length === 0 || + typeof length === "number" && length > 0 && ( length - 1 ) in obj; +} +var Sizzle = +/*! + * Sizzle CSS Selector Engine v2.3.3 + * https://sizzlejs.com/ + * + * Copyright jQuery Foundation and other contributors + * Released under the MIT license + * http://jquery.org/license + * + * Date: 2016-08-08 + */ +(function( window ) { + +var i, + support, + Expr, + getText, + isXML, + tokenize, + compile, + select, + outermostContext, + sortInput, + hasDuplicate, + + // Local document vars + setDocument, + document, + docElem, + documentIsHTML, + rbuggyQSA, + rbuggyMatches, + matches, + contains, + + // Instance-specific data + expando = "sizzle" + 1 * new Date(), + preferredDoc = window.document, + dirruns = 0, + done = 0, + classCache = createCache(), + tokenCache = createCache(), + compilerCache = createCache(), + sortOrder = function( a, b ) { + if ( a === b ) { + hasDuplicate = true; + } + return 0; + }, + + // Instance methods + hasOwn = ({}).hasOwnProperty, + arr = [], + pop = arr.pop, + push_native = arr.push, + push = arr.push, + slice = arr.slice, + // Use a stripped-down indexOf as it's faster than native + // https://jsperf.com/thor-indexof-vs-for/5 + indexOf = function( list, elem ) { + var i = 0, + len = list.length; + for ( ; i < len; i++ ) { + if ( list[i] === elem ) { + return i; + } + } + return -1; + }, + + booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|ismap|loop|multiple|open|readonly|required|scoped", + + // Regular expressions + + // http://www.w3.org/TR/css3-selectors/#whitespace + whitespace = "[\\x20\\t\\r\\n\\f]", + + // http://www.w3.org/TR/CSS21/syndata.html#value-def-identifier + identifier = "(?:\\\\.|[\\w-]|[^\0-\\xa0])+", + + // Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors + attributes = "\\[" + whitespace + "*(" + identifier + ")(?:" + whitespace + + // Operator (capture 2) + "*([*^$|!~]?=)" + whitespace + + // "Attribute values must be CSS identifiers [capture 5] or strings [capture 3 or capture 4]" + "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" + whitespace + + "*\\]", + + pseudos = ":(" + identifier + ")(?:\\((" + + // To reduce the number of selectors needing tokenize in the preFilter, prefer arguments: + // 1. quoted (capture 3; capture 4 or capture 5) + "('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|" + + // 2. simple (capture 6) + "((?:\\\\.|[^\\\\()[\\]]|" + attributes + ")*)|" + + // 3. anything else (capture 2) + ".*" + + ")\\)|)", + + // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter + rwhitespace = new RegExp( whitespace + "+", "g" ), + rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + whitespace + "+$", "g" ), + + rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ), + rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace + "*" ), + + rattributeQuotes = new RegExp( "=" + whitespace + "*([^\\]'\"]*?)" + whitespace + "*\\]", "g" ), + + rpseudo = new RegExp( pseudos ), + ridentifier = new RegExp( "^" + identifier + "$" ), + + matchExpr = { + "ID": new RegExp( "^#(" + identifier + ")" ), + "CLASS": new RegExp( "^\\.(" + identifier + ")" ), + "TAG": new RegExp( "^(" + identifier + "|[*])" ), + "ATTR": new RegExp( "^" + attributes ), + "PSEUDO": new RegExp( "^" + pseudos ), + "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" + whitespace + + "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" + whitespace + + "*(\\d+)|))" + whitespace + "*\\)|)", "i" ), + "bool": new RegExp( "^(?:" + booleans + ")$", "i" ), + // For use in libraries implementing .is() + // We use this for POS matching in `select` + "needsContext": new RegExp( "^" + whitespace + "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" + + whitespace + "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" ) + }, + + rinputs = /^(?:input|select|textarea|button)$/i, + rheader = /^h\d$/i, + + rnative = /^[^{]+\{\s*\[native \w/, + + // Easily-parseable/retrievable ID or TAG or CLASS selectors + rquickExpr = /^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/, + + rsibling = /[+~]/, + + // CSS escapes + // http://www.w3.org/TR/CSS21/syndata.html#escaped-characters + runescape = new RegExp( "\\\\([\\da-f]{1,6}" + whitespace + "?|(" + whitespace + ")|.)", "ig" ), + funescape = function( _, escaped, escapedWhitespace ) { + var high = "0x" + escaped - 0x10000; + // NaN means non-codepoint + // Support: Firefox<24 + // Workaround erroneous numeric interpretation of +"0x" + return high !== high || escapedWhitespace ? + escaped : + high < 0 ? + // BMP codepoint + String.fromCharCode( high + 0x10000 ) : + // Supplemental Plane codepoint (surrogate pair) + String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 ); + }, + + // CSS string/identifier serialization + // https://drafts.csswg.org/cssom/#common-serializing-idioms + rcssescape = /([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g, + fcssescape = function( ch, asCodePoint ) { + if ( asCodePoint ) { + + // U+0000 NULL becomes U+FFFD REPLACEMENT CHARACTER + if ( ch === "\0" ) { + return "\uFFFD"; + } + + // Control characters and (dependent upon position) numbers get escaped as code points + return ch.slice( 0, -1 ) + "\\" + ch.charCodeAt( ch.length - 1 ).toString( 16 ) + " "; + } + + // Other potentially-special ASCII characters get backslash-escaped + return "\\" + ch; + }, + + // Used for iframes + // See setDocument() + // Removing the function wrapper causes a "Permission Denied" + // error in IE + unloadHandler = function() { + setDocument(); + }, + + disabledAncestor = addCombinator( + function( elem ) { + return elem.disabled === true && ("form" in elem || "label" in elem); + }, + { dir: "parentNode", next: "legend" } + ); + +// Optimize for push.apply( _, NodeList ) +try { + push.apply( + (arr = slice.call( preferredDoc.childNodes )), + preferredDoc.childNodes + ); + // Support: Android<4.0 + // Detect silently failing push.apply + arr[ preferredDoc.childNodes.length ].nodeType; +} catch ( e ) { + push = { apply: arr.length ? + + // Leverage slice if possible + function( target, els ) { + push_native.apply( target, slice.call(els) ); + } : + + // Support: IE<9 + // Otherwise append directly + function( target, els ) { + var j = target.length, + i = 0; + // Can't trust NodeList.length + while ( (target[j++] = els[i++]) ) {} + target.length = j - 1; + } + }; +} + +function Sizzle( selector, context, results, seed ) { + var m, i, elem, nid, match, groups, newSelector, + newContext = context && context.ownerDocument, + + // nodeType defaults to 9, since context defaults to document + nodeType = context ? context.nodeType : 9; + + results = results || []; + + // Return early from calls with invalid selector or context + if ( typeof selector !== "string" || !selector || + nodeType !== 1 && nodeType !== 9 && nodeType !== 11 ) { + + return results; + } + + // Try to shortcut find operations (as opposed to filters) in HTML documents + if ( !seed ) { + + if ( ( context ? context.ownerDocument || context : preferredDoc ) !== document ) { + setDocument( context ); + } + context = context || document; + + if ( documentIsHTML ) { + + // If the selector is sufficiently simple, try using a "get*By*" DOM method + // (excepting DocumentFragment context, where the methods don't exist) + if ( nodeType !== 11 && (match = rquickExpr.exec( selector )) ) { + + // ID selector + if ( (m = match[1]) ) { + + // Document context + if ( nodeType === 9 ) { + if ( (elem = context.getElementById( m )) ) { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( elem.id === m ) { + results.push( elem ); + return results; + } + } else { + return results; + } + + // Element context + } else { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( newContext && (elem = newContext.getElementById( m )) && + contains( context, elem ) && + elem.id === m ) { + + results.push( elem ); + return results; + } + } + + // Type selector + } else if ( match[2] ) { + push.apply( results, context.getElementsByTagName( selector ) ); + return results; + + // Class selector + } else if ( (m = match[3]) && support.getElementsByClassName && + context.getElementsByClassName ) { + + push.apply( results, context.getElementsByClassName( m ) ); + return results; + } + } + + // Take advantage of querySelectorAll + if ( support.qsa && + !compilerCache[ selector + " " ] && + (!rbuggyQSA || !rbuggyQSA.test( selector )) ) { + + if ( nodeType !== 1 ) { + newContext = context; + newSelector = selector; + + // qSA looks outside Element context, which is not what we want + // Thanks to Andrew Dupont for this workaround technique + // Support: IE <=8 + // Exclude object elements + } else if ( context.nodeName.toLowerCase() !== "object" ) { + + // Capture the context ID, setting it first if necessary + if ( (nid = context.getAttribute( "id" )) ) { + nid = nid.replace( rcssescape, fcssescape ); + } else { + context.setAttribute( "id", (nid = expando) ); + } + + // Prefix every selector in the list + groups = tokenize( selector ); + i = groups.length; + while ( i-- ) { + groups[i] = "#" + nid + " " + toSelector( groups[i] ); + } + newSelector = groups.join( "," ); + + // Expand context for sibling selectors + newContext = rsibling.test( selector ) && testContext( context.parentNode ) || + context; + } + + if ( newSelector ) { + try { + push.apply( results, + newContext.querySelectorAll( newSelector ) + ); + return results; + } catch ( qsaError ) { + } finally { + if ( nid === expando ) { + context.removeAttribute( "id" ); + } + } + } + } + } + } + + // All others + return select( selector.replace( rtrim, "$1" ), context, results, seed ); +} + +/** + * Create key-value caches of limited size + * @returns {function(string, object)} Returns the Object data after storing it on itself with + * property name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength) + * deleting the oldest entry + */ +function createCache() { + var keys = []; + + function cache( key, value ) { + // Use (key + " ") to avoid collision with native prototype properties (see Issue #157) + if ( keys.push( key + " " ) > Expr.cacheLength ) { + // Only keep the most recent entries + delete cache[ keys.shift() ]; + } + return (cache[ key + " " ] = value); + } + return cache; +} + +/** + * Mark a function for special use by Sizzle + * @param {Function} fn The function to mark + */ +function markFunction( fn ) { + fn[ expando ] = true; + return fn; +} + +/** + * Support testing using an element + * @param {Function} fn Passed the created element and returns a boolean result + */ +function assert( fn ) { + var el = document.createElement("fieldset"); + + try { + return !!fn( el ); + } catch (e) { + return false; + } finally { + // Remove from its parent by default + if ( el.parentNode ) { + el.parentNode.removeChild( el ); + } + // release memory in IE + el = null; + } +} + +/** + * Adds the same handler for all of the specified attrs + * @param {String} attrs Pipe-separated list of attributes + * @param {Function} handler The method that will be applied + */ +function addHandle( attrs, handler ) { + var arr = attrs.split("|"), + i = arr.length; + + while ( i-- ) { + Expr.attrHandle[ arr[i] ] = handler; + } +} + +/** + * Checks document order of two siblings + * @param {Element} a + * @param {Element} b + * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b + */ +function siblingCheck( a, b ) { + var cur = b && a, + diff = cur && a.nodeType === 1 && b.nodeType === 1 && + a.sourceIndex - b.sourceIndex; + + // Use IE sourceIndex if available on both nodes + if ( diff ) { + return diff; + } + + // Check if b follows a + if ( cur ) { + while ( (cur = cur.nextSibling) ) { + if ( cur === b ) { + return -1; + } + } + } + + return a ? 1 : -1; +} + +/** + * Returns a function to use in pseudos for input types + * @param {String} type + */ +function createInputPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for buttons + * @param {String} type + */ +function createButtonPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return (name === "input" || name === "button") && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for :enabled/:disabled + * @param {Boolean} disabled true for :disabled; false for :enabled + */ +function createDisabledPseudo( disabled ) { + + // Known :disabled false positives: fieldset[disabled] > legend:nth-of-type(n+2) :can-disable + return function( elem ) { + + // Only certain elements can match :enabled or :disabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-enabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-disabled + if ( "form" in elem ) { + + // Check for inherited disabledness on relevant non-disabled elements: + // * listed form-associated elements in a disabled fieldset + // https://html.spec.whatwg.org/multipage/forms.html#category-listed + // https://html.spec.whatwg.org/multipage/forms.html#concept-fe-disabled + // * option elements in a disabled optgroup + // https://html.spec.whatwg.org/multipage/forms.html#concept-option-disabled + // All such elements have a "form" property. + if ( elem.parentNode && elem.disabled === false ) { + + // Option elements defer to a parent optgroup if present + if ( "label" in elem ) { + if ( "label" in elem.parentNode ) { + return elem.parentNode.disabled === disabled; + } else { + return elem.disabled === disabled; + } + } + + // Support: IE 6 - 11 + // Use the isDisabled shortcut property to check for disabled fieldset ancestors + return elem.isDisabled === disabled || + + // Where there is no isDisabled, check manually + /* jshint -W018 */ + elem.isDisabled !== !disabled && + disabledAncestor( elem ) === disabled; + } + + return elem.disabled === disabled; + + // Try to winnow out elements that can't be disabled before trusting the disabled property. + // Some victims get caught in our net (label, legend, menu, track), but it shouldn't + // even exist on them, let alone have a boolean value. + } else if ( "label" in elem ) { + return elem.disabled === disabled; + } + + // Remaining elements are neither :enabled nor :disabled + return false; + }; +} + +/** + * Returns a function to use in pseudos for positionals + * @param {Function} fn + */ +function createPositionalPseudo( fn ) { + return markFunction(function( argument ) { + argument = +argument; + return markFunction(function( seed, matches ) { + var j, + matchIndexes = fn( [], seed.length, argument ), + i = matchIndexes.length; + + // Match elements found at the specified indexes + while ( i-- ) { + if ( seed[ (j = matchIndexes[i]) ] ) { + seed[j] = !(matches[j] = seed[j]); + } + } + }); + }); +} + +/** + * Checks a node for validity as a Sizzle context + * @param {Element|Object=} context + * @returns {Element|Object|Boolean} The input node if acceptable, otherwise a falsy value + */ +function testContext( context ) { + return context && typeof context.getElementsByTagName !== "undefined" && context; +} + +// Expose support vars for convenience +support = Sizzle.support = {}; + +/** + * Detects XML nodes + * @param {Element|Object} elem An element or a document + * @returns {Boolean} True iff elem is a non-HTML XML node + */ +isXML = Sizzle.isXML = function( elem ) { + // documentElement is verified for cases where it doesn't yet exist + // (such as loading iframes in IE - #4833) + var documentElement = elem && (elem.ownerDocument || elem).documentElement; + return documentElement ? documentElement.nodeName !== "HTML" : false; +}; + +/** + * Sets document-related variables once based on the current document + * @param {Element|Object} [doc] An element or document object to use to set the document + * @returns {Object} Returns the current document + */ +setDocument = Sizzle.setDocument = function( node ) { + var hasCompare, subWindow, + doc = node ? node.ownerDocument || node : preferredDoc; + + // Return early if doc is invalid or already selected + if ( doc === document || doc.nodeType !== 9 || !doc.documentElement ) { + return document; + } + + // Update global variables + document = doc; + docElem = document.documentElement; + documentIsHTML = !isXML( document ); + + // Support: IE 9-11, Edge + // Accessing iframe documents after unload throws "permission denied" errors (jQuery #13936) + if ( preferredDoc !== document && + (subWindow = document.defaultView) && subWindow.top !== subWindow ) { + + // Support: IE 11, Edge + if ( subWindow.addEventListener ) { + subWindow.addEventListener( "unload", unloadHandler, false ); + + // Support: IE 9 - 10 only + } else if ( subWindow.attachEvent ) { + subWindow.attachEvent( "onunload", unloadHandler ); + } + } + + /* Attributes + ---------------------------------------------------------------------- */ + + // Support: IE<8 + // Verify that getAttribute really returns attributes and not properties + // (excepting IE8 booleans) + support.attributes = assert(function( el ) { + el.className = "i"; + return !el.getAttribute("className"); + }); + + /* getElement(s)By* + ---------------------------------------------------------------------- */ + + // Check if getElementsByTagName("*") returns only elements + support.getElementsByTagName = assert(function( el ) { + el.appendChild( document.createComment("") ); + return !el.getElementsByTagName("*").length; + }); + + // Support: IE<9 + support.getElementsByClassName = rnative.test( document.getElementsByClassName ); + + // Support: IE<10 + // Check if getElementById returns elements by name + // The broken getElementById methods don't pick up programmatically-set names, + // so use a roundabout getElementsByName test + support.getById = assert(function( el ) { + docElem.appendChild( el ).id = expando; + return !document.getElementsByName || !document.getElementsByName( expando ).length; + }); + + // ID filter and find + if ( support.getById ) { + Expr.filter["ID"] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + return elem.getAttribute("id") === attrId; + }; + }; + Expr.find["ID"] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var elem = context.getElementById( id ); + return elem ? [ elem ] : []; + } + }; + } else { + Expr.filter["ID"] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + var node = typeof elem.getAttributeNode !== "undefined" && + elem.getAttributeNode("id"); + return node && node.value === attrId; + }; + }; + + // Support: IE 6 - 7 only + // getElementById is not reliable as a find shortcut + Expr.find["ID"] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var node, i, elems, + elem = context.getElementById( id ); + + if ( elem ) { + + // Verify the id attribute + node = elem.getAttributeNode("id"); + if ( node && node.value === id ) { + return [ elem ]; + } + + // Fall back on getElementsByName + elems = context.getElementsByName( id ); + i = 0; + while ( (elem = elems[i++]) ) { + node = elem.getAttributeNode("id"); + if ( node && node.value === id ) { + return [ elem ]; + } + } + } + + return []; + } + }; + } + + // Tag + Expr.find["TAG"] = support.getElementsByTagName ? + function( tag, context ) { + if ( typeof context.getElementsByTagName !== "undefined" ) { + return context.getElementsByTagName( tag ); + + // DocumentFragment nodes don't have gEBTN + } else if ( support.qsa ) { + return context.querySelectorAll( tag ); + } + } : + + function( tag, context ) { + var elem, + tmp = [], + i = 0, + // By happy coincidence, a (broken) gEBTN appears on DocumentFragment nodes too + results = context.getElementsByTagName( tag ); + + // Filter out possible comments + if ( tag === "*" ) { + while ( (elem = results[i++]) ) { + if ( elem.nodeType === 1 ) { + tmp.push( elem ); + } + } + + return tmp; + } + return results; + }; + + // Class + Expr.find["CLASS"] = support.getElementsByClassName && function( className, context ) { + if ( typeof context.getElementsByClassName !== "undefined" && documentIsHTML ) { + return context.getElementsByClassName( className ); + } + }; + + /* QSA/matchesSelector + ---------------------------------------------------------------------- */ + + // QSA and matchesSelector support + + // matchesSelector(:active) reports false when true (IE9/Opera 11.5) + rbuggyMatches = []; + + // qSa(:focus) reports false when true (Chrome 21) + // We allow this because of a bug in IE8/9 that throws an error + // whenever `document.activeElement` is accessed on an iframe + // So, we allow :focus to pass through QSA all the time to avoid the IE error + // See https://bugs.jquery.com/ticket/13378 + rbuggyQSA = []; + + if ( (support.qsa = rnative.test( document.querySelectorAll )) ) { + // Build QSA regex + // Regex strategy adopted from Diego Perini + assert(function( el ) { + // Select is set to empty string on purpose + // This is to test IE's treatment of not explicitly + // setting a boolean content attribute, + // since its presence should be enough + // https://bugs.jquery.com/ticket/12359 + docElem.appendChild( el ).innerHTML = "" + + ""; + + // Support: IE8, Opera 11-12.16 + // Nothing should be selected when empty strings follow ^= or $= or *= + // The test attribute must be unknown in Opera but "safe" for WinRT + // https://msdn.microsoft.com/en-us/library/ie/hh465388.aspx#attribute_section + if ( el.querySelectorAll("[msallowcapture^='']").length ) { + rbuggyQSA.push( "[*^$]=" + whitespace + "*(?:''|\"\")" ); + } + + // Support: IE8 + // Boolean attributes and "value" are not treated correctly + if ( !el.querySelectorAll("[selected]").length ) { + rbuggyQSA.push( "\\[" + whitespace + "*(?:value|" + booleans + ")" ); + } + + // Support: Chrome<29, Android<4.4, Safari<7.0+, iOS<7.0+, PhantomJS<1.9.8+ + if ( !el.querySelectorAll( "[id~=" + expando + "-]" ).length ) { + rbuggyQSA.push("~="); + } + + // Webkit/Opera - :checked should return selected option elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + // IE8 throws error here and will not see later tests + if ( !el.querySelectorAll(":checked").length ) { + rbuggyQSA.push(":checked"); + } + + // Support: Safari 8+, iOS 8+ + // https://bugs.webkit.org/show_bug.cgi?id=136851 + // In-page `selector#id sibling-combinator selector` fails + if ( !el.querySelectorAll( "a#" + expando + "+*" ).length ) { + rbuggyQSA.push(".#.+[+~]"); + } + }); + + assert(function( el ) { + el.innerHTML = "" + + ""; + + // Support: Windows 8 Native Apps + // The type and name attributes are restricted during .innerHTML assignment + var input = document.createElement("input"); + input.setAttribute( "type", "hidden" ); + el.appendChild( input ).setAttribute( "name", "D" ); + + // Support: IE8 + // Enforce case-sensitivity of name attribute + if ( el.querySelectorAll("[name=d]").length ) { + rbuggyQSA.push( "name" + whitespace + "*[*^$|!~]?=" ); + } + + // FF 3.5 - :enabled/:disabled and hidden elements (hidden elements are still enabled) + // IE8 throws error here and will not see later tests + if ( el.querySelectorAll(":enabled").length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: IE9-11+ + // IE's :disabled selector does not pick up the children of disabled fieldsets + docElem.appendChild( el ).disabled = true; + if ( el.querySelectorAll(":disabled").length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Opera 10-11 does not throw on post-comma invalid pseudos + el.querySelectorAll("*,:x"); + rbuggyQSA.push(",.*:"); + }); + } + + if ( (support.matchesSelector = rnative.test( (matches = docElem.matches || + docElem.webkitMatchesSelector || + docElem.mozMatchesSelector || + docElem.oMatchesSelector || + docElem.msMatchesSelector) )) ) { + + assert(function( el ) { + // Check to see if it's possible to do matchesSelector + // on a disconnected node (IE 9) + support.disconnectedMatch = matches.call( el, "*" ); + + // This should fail with an exception + // Gecko does not error, returns false instead + matches.call( el, "[s!='']:x" ); + rbuggyMatches.push( "!=", pseudos ); + }); + } + + rbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join("|") ); + rbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join("|") ); + + /* Contains + ---------------------------------------------------------------------- */ + hasCompare = rnative.test( docElem.compareDocumentPosition ); + + // Element contains another + // Purposefully self-exclusive + // As in, an element does not contain itself + contains = hasCompare || rnative.test( docElem.contains ) ? + function( a, b ) { + var adown = a.nodeType === 9 ? a.documentElement : a, + bup = b && b.parentNode; + return a === bup || !!( bup && bup.nodeType === 1 && ( + adown.contains ? + adown.contains( bup ) : + a.compareDocumentPosition && a.compareDocumentPosition( bup ) & 16 + )); + } : + function( a, b ) { + if ( b ) { + while ( (b = b.parentNode) ) { + if ( b === a ) { + return true; + } + } + } + return false; + }; + + /* Sorting + ---------------------------------------------------------------------- */ + + // Document order sorting + sortOrder = hasCompare ? + function( a, b ) { + + // Flag for duplicate removal + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + // Sort on method existence if only one input has compareDocumentPosition + var compare = !a.compareDocumentPosition - !b.compareDocumentPosition; + if ( compare ) { + return compare; + } + + // Calculate position if both inputs belong to the same document + compare = ( a.ownerDocument || a ) === ( b.ownerDocument || b ) ? + a.compareDocumentPosition( b ) : + + // Otherwise we know they are disconnected + 1; + + // Disconnected nodes + if ( compare & 1 || + (!support.sortDetached && b.compareDocumentPosition( a ) === compare) ) { + + // Choose the first element that is related to our preferred document + if ( a === document || a.ownerDocument === preferredDoc && contains(preferredDoc, a) ) { + return -1; + } + if ( b === document || b.ownerDocument === preferredDoc && contains(preferredDoc, b) ) { + return 1; + } + + // Maintain original order + return sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + } + + return compare & 4 ? -1 : 1; + } : + function( a, b ) { + // Exit early if the nodes are identical + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + var cur, + i = 0, + aup = a.parentNode, + bup = b.parentNode, + ap = [ a ], + bp = [ b ]; + + // Parentless nodes are either documents or disconnected + if ( !aup || !bup ) { + return a === document ? -1 : + b === document ? 1 : + aup ? -1 : + bup ? 1 : + sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + + // If the nodes are siblings, we can do a quick check + } else if ( aup === bup ) { + return siblingCheck( a, b ); + } + + // Otherwise we need full lists of their ancestors for comparison + cur = a; + while ( (cur = cur.parentNode) ) { + ap.unshift( cur ); + } + cur = b; + while ( (cur = cur.parentNode) ) { + bp.unshift( cur ); + } + + // Walk down the tree looking for a discrepancy + while ( ap[i] === bp[i] ) { + i++; + } + + return i ? + // Do a sibling check if the nodes have a common ancestor + siblingCheck( ap[i], bp[i] ) : + + // Otherwise nodes in our document sort first + ap[i] === preferredDoc ? -1 : + bp[i] === preferredDoc ? 1 : + 0; + }; + + return document; +}; + +Sizzle.matches = function( expr, elements ) { + return Sizzle( expr, null, null, elements ); +}; + +Sizzle.matchesSelector = function( elem, expr ) { + // Set document vars if needed + if ( ( elem.ownerDocument || elem ) !== document ) { + setDocument( elem ); + } + + // Make sure that attribute selectors are quoted + expr = expr.replace( rattributeQuotes, "='$1']" ); + + if ( support.matchesSelector && documentIsHTML && + !compilerCache[ expr + " " ] && + ( !rbuggyMatches || !rbuggyMatches.test( expr ) ) && + ( !rbuggyQSA || !rbuggyQSA.test( expr ) ) ) { + + try { + var ret = matches.call( elem, expr ); + + // IE 9's matchesSelector returns false on disconnected nodes + if ( ret || support.disconnectedMatch || + // As well, disconnected nodes are said to be in a document + // fragment in IE 9 + elem.document && elem.document.nodeType !== 11 ) { + return ret; + } + } catch (e) {} + } + + return Sizzle( expr, document, null, [ elem ] ).length > 0; +}; + +Sizzle.contains = function( context, elem ) { + // Set document vars if needed + if ( ( context.ownerDocument || context ) !== document ) { + setDocument( context ); + } + return contains( context, elem ); +}; + +Sizzle.attr = function( elem, name ) { + // Set document vars if needed + if ( ( elem.ownerDocument || elem ) !== document ) { + setDocument( elem ); + } + + var fn = Expr.attrHandle[ name.toLowerCase() ], + // Don't get fooled by Object.prototype properties (jQuery #13807) + val = fn && hasOwn.call( Expr.attrHandle, name.toLowerCase() ) ? + fn( elem, name, !documentIsHTML ) : + undefined; + + return val !== undefined ? + val : + support.attributes || !documentIsHTML ? + elem.getAttribute( name ) : + (val = elem.getAttributeNode(name)) && val.specified ? + val.value : + null; +}; + +Sizzle.escape = function( sel ) { + return (sel + "").replace( rcssescape, fcssescape ); +}; + +Sizzle.error = function( msg ) { + throw new Error( "Syntax error, unrecognized expression: " + msg ); +}; + +/** + * Document sorting and removing duplicates + * @param {ArrayLike} results + */ +Sizzle.uniqueSort = function( results ) { + var elem, + duplicates = [], + j = 0, + i = 0; + + // Unless we *know* we can detect duplicates, assume their presence + hasDuplicate = !support.detectDuplicates; + sortInput = !support.sortStable && results.slice( 0 ); + results.sort( sortOrder ); + + if ( hasDuplicate ) { + while ( (elem = results[i++]) ) { + if ( elem === results[ i ] ) { + j = duplicates.push( i ); + } + } + while ( j-- ) { + results.splice( duplicates[ j ], 1 ); + } + } + + // Clear input after sorting to release objects + // See https://github.com/jquery/sizzle/pull/225 + sortInput = null; + + return results; +}; + +/** + * Utility function for retrieving the text value of an array of DOM nodes + * @param {Array|Element} elem + */ +getText = Sizzle.getText = function( elem ) { + var node, + ret = "", + i = 0, + nodeType = elem.nodeType; + + if ( !nodeType ) { + // If no nodeType, this is expected to be an array + while ( (node = elem[i++]) ) { + // Do not traverse comment nodes + ret += getText( node ); + } + } else if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) { + // Use textContent for elements + // innerText usage removed for consistency of new lines (jQuery #11153) + if ( typeof elem.textContent === "string" ) { + return elem.textContent; + } else { + // Traverse its children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + ret += getText( elem ); + } + } + } else if ( nodeType === 3 || nodeType === 4 ) { + return elem.nodeValue; + } + // Do not include comment or processing instruction nodes + + return ret; +}; + +Expr = Sizzle.selectors = { + + // Can be adjusted by the user + cacheLength: 50, + + createPseudo: markFunction, + + match: matchExpr, + + attrHandle: {}, + + find: {}, + + relative: { + ">": { dir: "parentNode", first: true }, + " ": { dir: "parentNode" }, + "+": { dir: "previousSibling", first: true }, + "~": { dir: "previousSibling" } + }, + + preFilter: { + "ATTR": function( match ) { + match[1] = match[1].replace( runescape, funescape ); + + // Move the given value to match[3] whether quoted or unquoted + match[3] = ( match[3] || match[4] || match[5] || "" ).replace( runescape, funescape ); + + if ( match[2] === "~=" ) { + match[3] = " " + match[3] + " "; + } + + return match.slice( 0, 4 ); + }, + + "CHILD": function( match ) { + /* matches from matchExpr["CHILD"] + 1 type (only|nth|...) + 2 what (child|of-type) + 3 argument (even|odd|\d*|\d*n([+-]\d+)?|...) + 4 xn-component of xn+y argument ([+-]?\d*n|) + 5 sign of xn-component + 6 x of xn-component + 7 sign of y-component + 8 y of y-component + */ + match[1] = match[1].toLowerCase(); + + if ( match[1].slice( 0, 3 ) === "nth" ) { + // nth-* requires argument + if ( !match[3] ) { + Sizzle.error( match[0] ); + } + + // numeric x and y parameters for Expr.filter.CHILD + // remember that false/true cast respectively to 0/1 + match[4] = +( match[4] ? match[5] + (match[6] || 1) : 2 * ( match[3] === "even" || match[3] === "odd" ) ); + match[5] = +( ( match[7] + match[8] ) || match[3] === "odd" ); + + // other types prohibit arguments + } else if ( match[3] ) { + Sizzle.error( match[0] ); + } + + return match; + }, + + "PSEUDO": function( match ) { + var excess, + unquoted = !match[6] && match[2]; + + if ( matchExpr["CHILD"].test( match[0] ) ) { + return null; + } + + // Accept quoted arguments as-is + if ( match[3] ) { + match[2] = match[4] || match[5] || ""; + + // Strip excess characters from unquoted arguments + } else if ( unquoted && rpseudo.test( unquoted ) && + // Get excess from tokenize (recursively) + (excess = tokenize( unquoted, true )) && + // advance to the next closing parenthesis + (excess = unquoted.indexOf( ")", unquoted.length - excess ) - unquoted.length) ) { + + // excess is a negative index + match[0] = match[0].slice( 0, excess ); + match[2] = unquoted.slice( 0, excess ); + } + + // Return only captures needed by the pseudo filter method (type and argument) + return match.slice( 0, 3 ); + } + }, + + filter: { + + "TAG": function( nodeNameSelector ) { + var nodeName = nodeNameSelector.replace( runescape, funescape ).toLowerCase(); + return nodeNameSelector === "*" ? + function() { return true; } : + function( elem ) { + return elem.nodeName && elem.nodeName.toLowerCase() === nodeName; + }; + }, + + "CLASS": function( className ) { + var pattern = classCache[ className + " " ]; + + return pattern || + (pattern = new RegExp( "(^|" + whitespace + ")" + className + "(" + whitespace + "|$)" )) && + classCache( className, function( elem ) { + return pattern.test( typeof elem.className === "string" && elem.className || typeof elem.getAttribute !== "undefined" && elem.getAttribute("class") || "" ); + }); + }, + + "ATTR": function( name, operator, check ) { + return function( elem ) { + var result = Sizzle.attr( elem, name ); + + if ( result == null ) { + return operator === "!="; + } + if ( !operator ) { + return true; + } + + result += ""; + + return operator === "=" ? result === check : + operator === "!=" ? result !== check : + operator === "^=" ? check && result.indexOf( check ) === 0 : + operator === "*=" ? check && result.indexOf( check ) > -1 : + operator === "$=" ? check && result.slice( -check.length ) === check : + operator === "~=" ? ( " " + result.replace( rwhitespace, " " ) + " " ).indexOf( check ) > -1 : + operator === "|=" ? result === check || result.slice( 0, check.length + 1 ) === check + "-" : + false; + }; + }, + + "CHILD": function( type, what, argument, first, last ) { + var simple = type.slice( 0, 3 ) !== "nth", + forward = type.slice( -4 ) !== "last", + ofType = what === "of-type"; + + return first === 1 && last === 0 ? + + // Shortcut for :nth-*(n) + function( elem ) { + return !!elem.parentNode; + } : + + function( elem, context, xml ) { + var cache, uniqueCache, outerCache, node, nodeIndex, start, + dir = simple !== forward ? "nextSibling" : "previousSibling", + parent = elem.parentNode, + name = ofType && elem.nodeName.toLowerCase(), + useCache = !xml && !ofType, + diff = false; + + if ( parent ) { + + // :(first|last|only)-(child|of-type) + if ( simple ) { + while ( dir ) { + node = elem; + while ( (node = node[ dir ]) ) { + if ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) { + + return false; + } + } + // Reverse direction for :only-* (if we haven't yet done so) + start = dir = type === "only" && !start && "nextSibling"; + } + return true; + } + + start = [ forward ? parent.firstChild : parent.lastChild ]; + + // non-xml :nth-child(...) stores cache data on `parent` + if ( forward && useCache ) { + + // Seek `elem` from a previously-cached index + + // ...in a gzip-friendly way + node = parent; + outerCache = node[ expando ] || (node[ expando ] = {}); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + (outerCache[ node.uniqueID ] = {}); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex && cache[ 2 ]; + node = nodeIndex && parent.childNodes[ nodeIndex ]; + + while ( (node = ++nodeIndex && node && node[ dir ] || + + // Fallback to seeking `elem` from the start + (diff = nodeIndex = 0) || start.pop()) ) { + + // When found, cache indexes on `parent` and break + if ( node.nodeType === 1 && ++diff && node === elem ) { + uniqueCache[ type ] = [ dirruns, nodeIndex, diff ]; + break; + } + } + + } else { + // Use previously-cached element index if available + if ( useCache ) { + // ...in a gzip-friendly way + node = elem; + outerCache = node[ expando ] || (node[ expando ] = {}); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + (outerCache[ node.uniqueID ] = {}); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex; + } + + // xml :nth-child(...) + // or :nth-last-child(...) or :nth(-last)?-of-type(...) + if ( diff === false ) { + // Use the same loop as above to seek `elem` from the start + while ( (node = ++nodeIndex && node && node[ dir ] || + (diff = nodeIndex = 0) || start.pop()) ) { + + if ( ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) && + ++diff ) { + + // Cache the index of each encountered element + if ( useCache ) { + outerCache = node[ expando ] || (node[ expando ] = {}); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + (outerCache[ node.uniqueID ] = {}); + + uniqueCache[ type ] = [ dirruns, diff ]; + } + + if ( node === elem ) { + break; + } + } + } + } + } + + // Incorporate the offset, then check against cycle size + diff -= last; + return diff === first || ( diff % first === 0 && diff / first >= 0 ); + } + }; + }, + + "PSEUDO": function( pseudo, argument ) { + // pseudo-class names are case-insensitive + // http://www.w3.org/TR/selectors/#pseudo-classes + // Prioritize by case sensitivity in case custom pseudos are added with uppercase letters + // Remember that setFilters inherits from pseudos + var args, + fn = Expr.pseudos[ pseudo ] || Expr.setFilters[ pseudo.toLowerCase() ] || + Sizzle.error( "unsupported pseudo: " + pseudo ); + + // The user may use createPseudo to indicate that + // arguments are needed to create the filter function + // just as Sizzle does + if ( fn[ expando ] ) { + return fn( argument ); + } + + // But maintain support for old signatures + if ( fn.length > 1 ) { + args = [ pseudo, pseudo, "", argument ]; + return Expr.setFilters.hasOwnProperty( pseudo.toLowerCase() ) ? + markFunction(function( seed, matches ) { + var idx, + matched = fn( seed, argument ), + i = matched.length; + while ( i-- ) { + idx = indexOf( seed, matched[i] ); + seed[ idx ] = !( matches[ idx ] = matched[i] ); + } + }) : + function( elem ) { + return fn( elem, 0, args ); + }; + } + + return fn; + } + }, + + pseudos: { + // Potentially complex pseudos + "not": markFunction(function( selector ) { + // Trim the selector passed to compile + // to avoid treating leading and trailing + // spaces as combinators + var input = [], + results = [], + matcher = compile( selector.replace( rtrim, "$1" ) ); + + return matcher[ expando ] ? + markFunction(function( seed, matches, context, xml ) { + var elem, + unmatched = matcher( seed, null, xml, [] ), + i = seed.length; + + // Match elements unmatched by `matcher` + while ( i-- ) { + if ( (elem = unmatched[i]) ) { + seed[i] = !(matches[i] = elem); + } + } + }) : + function( elem, context, xml ) { + input[0] = elem; + matcher( input, null, xml, results ); + // Don't keep the element (issue #299) + input[0] = null; + return !results.pop(); + }; + }), + + "has": markFunction(function( selector ) { + return function( elem ) { + return Sizzle( selector, elem ).length > 0; + }; + }), + + "contains": markFunction(function( text ) { + text = text.replace( runescape, funescape ); + return function( elem ) { + return ( elem.textContent || elem.innerText || getText( elem ) ).indexOf( text ) > -1; + }; + }), + + // "Whether an element is represented by a :lang() selector + // is based solely on the element's language value + // being equal to the identifier C, + // or beginning with the identifier C immediately followed by "-". + // The matching of C against the element's language value is performed case-insensitively. + // The identifier C does not have to be a valid language name." + // http://www.w3.org/TR/selectors/#lang-pseudo + "lang": markFunction( function( lang ) { + // lang value must be a valid identifier + if ( !ridentifier.test(lang || "") ) { + Sizzle.error( "unsupported lang: " + lang ); + } + lang = lang.replace( runescape, funescape ).toLowerCase(); + return function( elem ) { + var elemLang; + do { + if ( (elemLang = documentIsHTML ? + elem.lang : + elem.getAttribute("xml:lang") || elem.getAttribute("lang")) ) { + + elemLang = elemLang.toLowerCase(); + return elemLang === lang || elemLang.indexOf( lang + "-" ) === 0; + } + } while ( (elem = elem.parentNode) && elem.nodeType === 1 ); + return false; + }; + }), + + // Miscellaneous + "target": function( elem ) { + var hash = window.location && window.location.hash; + return hash && hash.slice( 1 ) === elem.id; + }, + + "root": function( elem ) { + return elem === docElem; + }, + + "focus": function( elem ) { + return elem === document.activeElement && (!document.hasFocus || document.hasFocus()) && !!(elem.type || elem.href || ~elem.tabIndex); + }, + + // Boolean properties + "enabled": createDisabledPseudo( false ), + "disabled": createDisabledPseudo( true ), + + "checked": function( elem ) { + // In CSS3, :checked should return both checked and selected elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + var nodeName = elem.nodeName.toLowerCase(); + return (nodeName === "input" && !!elem.checked) || (nodeName === "option" && !!elem.selected); + }, + + "selected": function( elem ) { + // Accessing this property makes selected-by-default + // options in Safari work properly + if ( elem.parentNode ) { + elem.parentNode.selectedIndex; + } + + return elem.selected === true; + }, + + // Contents + "empty": function( elem ) { + // http://www.w3.org/TR/selectors/#empty-pseudo + // :empty is negated by element (1) or content nodes (text: 3; cdata: 4; entity ref: 5), + // but not by others (comment: 8; processing instruction: 7; etc.) + // nodeType < 6 works because attributes (2) do not appear as children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + if ( elem.nodeType < 6 ) { + return false; + } + } + return true; + }, + + "parent": function( elem ) { + return !Expr.pseudos["empty"]( elem ); + }, + + // Element/input types + "header": function( elem ) { + return rheader.test( elem.nodeName ); + }, + + "input": function( elem ) { + return rinputs.test( elem.nodeName ); + }, + + "button": function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === "button" || name === "button"; + }, + + "text": function( elem ) { + var attr; + return elem.nodeName.toLowerCase() === "input" && + elem.type === "text" && + + // Support: IE<8 + // New HTML5 attribute values (e.g., "search") appear with elem.type === "text" + ( (attr = elem.getAttribute("type")) == null || attr.toLowerCase() === "text" ); + }, + + // Position-in-collection + "first": createPositionalPseudo(function() { + return [ 0 ]; + }), + + "last": createPositionalPseudo(function( matchIndexes, length ) { + return [ length - 1 ]; + }), + + "eq": createPositionalPseudo(function( matchIndexes, length, argument ) { + return [ argument < 0 ? argument + length : argument ]; + }), + + "even": createPositionalPseudo(function( matchIndexes, length ) { + var i = 0; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + }), + + "odd": createPositionalPseudo(function( matchIndexes, length ) { + var i = 1; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + }), + + "lt": createPositionalPseudo(function( matchIndexes, length, argument ) { + var i = argument < 0 ? argument + length : argument; + for ( ; --i >= 0; ) { + matchIndexes.push( i ); + } + return matchIndexes; + }), + + "gt": createPositionalPseudo(function( matchIndexes, length, argument ) { + var i = argument < 0 ? argument + length : argument; + for ( ; ++i < length; ) { + matchIndexes.push( i ); + } + return matchIndexes; + }) + } +}; + +Expr.pseudos["nth"] = Expr.pseudos["eq"]; + +// Add button/input type pseudos +for ( i in { radio: true, checkbox: true, file: true, password: true, image: true } ) { + Expr.pseudos[ i ] = createInputPseudo( i ); +} +for ( i in { submit: true, reset: true } ) { + Expr.pseudos[ i ] = createButtonPseudo( i ); +} + +// Easy API for creating new setFilters +function setFilters() {} +setFilters.prototype = Expr.filters = Expr.pseudos; +Expr.setFilters = new setFilters(); + +tokenize = Sizzle.tokenize = function( selector, parseOnly ) { + var matched, match, tokens, type, + soFar, groups, preFilters, + cached = tokenCache[ selector + " " ]; + + if ( cached ) { + return parseOnly ? 0 : cached.slice( 0 ); + } + + soFar = selector; + groups = []; + preFilters = Expr.preFilter; + + while ( soFar ) { + + // Comma and first run + if ( !matched || (match = rcomma.exec( soFar )) ) { + if ( match ) { + // Don't consume trailing commas as valid + soFar = soFar.slice( match[0].length ) || soFar; + } + groups.push( (tokens = []) ); + } + + matched = false; + + // Combinators + if ( (match = rcombinators.exec( soFar )) ) { + matched = match.shift(); + tokens.push({ + value: matched, + // Cast descendant combinators to space + type: match[0].replace( rtrim, " " ) + }); + soFar = soFar.slice( matched.length ); + } + + // Filters + for ( type in Expr.filter ) { + if ( (match = matchExpr[ type ].exec( soFar )) && (!preFilters[ type ] || + (match = preFilters[ type ]( match ))) ) { + matched = match.shift(); + tokens.push({ + value: matched, + type: type, + matches: match + }); + soFar = soFar.slice( matched.length ); + } + } + + if ( !matched ) { + break; + } + } + + // Return the length of the invalid excess + // if we're just parsing + // Otherwise, throw an error or return tokens + return parseOnly ? + soFar.length : + soFar ? + Sizzle.error( selector ) : + // Cache the tokens + tokenCache( selector, groups ).slice( 0 ); +}; + +function toSelector( tokens ) { + var i = 0, + len = tokens.length, + selector = ""; + for ( ; i < len; i++ ) { + selector += tokens[i].value; + } + return selector; +} + +function addCombinator( matcher, combinator, base ) { + var dir = combinator.dir, + skip = combinator.next, + key = skip || dir, + checkNonElements = base && key === "parentNode", + doneName = done++; + + return combinator.first ? + // Check against closest ancestor/preceding element + function( elem, context, xml ) { + while ( (elem = elem[ dir ]) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + return matcher( elem, context, xml ); + } + } + return false; + } : + + // Check against all ancestor/preceding elements + function( elem, context, xml ) { + var oldCache, uniqueCache, outerCache, + newCache = [ dirruns, doneName ]; + + // We can't set arbitrary data on XML nodes, so they don't benefit from combinator caching + if ( xml ) { + while ( (elem = elem[ dir ]) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + if ( matcher( elem, context, xml ) ) { + return true; + } + } + } + } else { + while ( (elem = elem[ dir ]) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + outerCache = elem[ expando ] || (elem[ expando ] = {}); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ elem.uniqueID ] || (outerCache[ elem.uniqueID ] = {}); + + if ( skip && skip === elem.nodeName.toLowerCase() ) { + elem = elem[ dir ] || elem; + } else if ( (oldCache = uniqueCache[ key ]) && + oldCache[ 0 ] === dirruns && oldCache[ 1 ] === doneName ) { + + // Assign to newCache so results back-propagate to previous elements + return (newCache[ 2 ] = oldCache[ 2 ]); + } else { + // Reuse newcache so results back-propagate to previous elements + uniqueCache[ key ] = newCache; + + // A match means we're done; a fail means we have to keep checking + if ( (newCache[ 2 ] = matcher( elem, context, xml )) ) { + return true; + } + } + } + } + } + return false; + }; +} + +function elementMatcher( matchers ) { + return matchers.length > 1 ? + function( elem, context, xml ) { + var i = matchers.length; + while ( i-- ) { + if ( !matchers[i]( elem, context, xml ) ) { + return false; + } + } + return true; + } : + matchers[0]; +} + +function multipleContexts( selector, contexts, results ) { + var i = 0, + len = contexts.length; + for ( ; i < len; i++ ) { + Sizzle( selector, contexts[i], results ); + } + return results; +} + +function condense( unmatched, map, filter, context, xml ) { + var elem, + newUnmatched = [], + i = 0, + len = unmatched.length, + mapped = map != null; + + for ( ; i < len; i++ ) { + if ( (elem = unmatched[i]) ) { + if ( !filter || filter( elem, context, xml ) ) { + newUnmatched.push( elem ); + if ( mapped ) { + map.push( i ); + } + } + } + } + + return newUnmatched; +} + +function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postSelector ) { + if ( postFilter && !postFilter[ expando ] ) { + postFilter = setMatcher( postFilter ); + } + if ( postFinder && !postFinder[ expando ] ) { + postFinder = setMatcher( postFinder, postSelector ); + } + return markFunction(function( seed, results, context, xml ) { + var temp, i, elem, + preMap = [], + postMap = [], + preexisting = results.length, + + // Get initial elements from seed or context + elems = seed || multipleContexts( selector || "*", context.nodeType ? [ context ] : context, [] ), + + // Prefilter to get matcher input, preserving a map for seed-results synchronization + matcherIn = preFilter && ( seed || !selector ) ? + condense( elems, preMap, preFilter, context, xml ) : + elems, + + matcherOut = matcher ? + // If we have a postFinder, or filtered seed, or non-seed postFilter or preexisting results, + postFinder || ( seed ? preFilter : preexisting || postFilter ) ? + + // ...intermediate processing is necessary + [] : + + // ...otherwise use results directly + results : + matcherIn; + + // Find primary matches + if ( matcher ) { + matcher( matcherIn, matcherOut, context, xml ); + } + + // Apply postFilter + if ( postFilter ) { + temp = condense( matcherOut, postMap ); + postFilter( temp, [], context, xml ); + + // Un-match failing elements by moving them back to matcherIn + i = temp.length; + while ( i-- ) { + if ( (elem = temp[i]) ) { + matcherOut[ postMap[i] ] = !(matcherIn[ postMap[i] ] = elem); + } + } + } + + if ( seed ) { + if ( postFinder || preFilter ) { + if ( postFinder ) { + // Get the final matcherOut by condensing this intermediate into postFinder contexts + temp = []; + i = matcherOut.length; + while ( i-- ) { + if ( (elem = matcherOut[i]) ) { + // Restore matcherIn since elem is not yet a final match + temp.push( (matcherIn[i] = elem) ); + } + } + postFinder( null, (matcherOut = []), temp, xml ); + } + + // Move matched elements from seed to results to keep them synchronized + i = matcherOut.length; + while ( i-- ) { + if ( (elem = matcherOut[i]) && + (temp = postFinder ? indexOf( seed, elem ) : preMap[i]) > -1 ) { + + seed[temp] = !(results[temp] = elem); + } + } + } + + // Add elements to results, through postFinder if defined + } else { + matcherOut = condense( + matcherOut === results ? + matcherOut.splice( preexisting, matcherOut.length ) : + matcherOut + ); + if ( postFinder ) { + postFinder( null, results, matcherOut, xml ); + } else { + push.apply( results, matcherOut ); + } + } + }); +} + +function matcherFromTokens( tokens ) { + var checkContext, matcher, j, + len = tokens.length, + leadingRelative = Expr.relative[ tokens[0].type ], + implicitRelative = leadingRelative || Expr.relative[" "], + i = leadingRelative ? 1 : 0, + + // The foundational matcher ensures that elements are reachable from top-level context(s) + matchContext = addCombinator( function( elem ) { + return elem === checkContext; + }, implicitRelative, true ), + matchAnyContext = addCombinator( function( elem ) { + return indexOf( checkContext, elem ) > -1; + }, implicitRelative, true ), + matchers = [ function( elem, context, xml ) { + var ret = ( !leadingRelative && ( xml || context !== outermostContext ) ) || ( + (checkContext = context).nodeType ? + matchContext( elem, context, xml ) : + matchAnyContext( elem, context, xml ) ); + // Avoid hanging onto element (issue #299) + checkContext = null; + return ret; + } ]; + + for ( ; i < len; i++ ) { + if ( (matcher = Expr.relative[ tokens[i].type ]) ) { + matchers = [ addCombinator(elementMatcher( matchers ), matcher) ]; + } else { + matcher = Expr.filter[ tokens[i].type ].apply( null, tokens[i].matches ); + + // Return special upon seeing a positional matcher + if ( matcher[ expando ] ) { + // Find the next relative operator (if any) for proper handling + j = ++i; + for ( ; j < len; j++ ) { + if ( Expr.relative[ tokens[j].type ] ) { + break; + } + } + return setMatcher( + i > 1 && elementMatcher( matchers ), + i > 1 && toSelector( + // If the preceding token was a descendant combinator, insert an implicit any-element `*` + tokens.slice( 0, i - 1 ).concat({ value: tokens[ i - 2 ].type === " " ? "*" : "" }) + ).replace( rtrim, "$1" ), + matcher, + i < j && matcherFromTokens( tokens.slice( i, j ) ), + j < len && matcherFromTokens( (tokens = tokens.slice( j )) ), + j < len && toSelector( tokens ) + ); + } + matchers.push( matcher ); + } + } + + return elementMatcher( matchers ); +} + +function matcherFromGroupMatchers( elementMatchers, setMatchers ) { + var bySet = setMatchers.length > 0, + byElement = elementMatchers.length > 0, + superMatcher = function( seed, context, xml, results, outermost ) { + var elem, j, matcher, + matchedCount = 0, + i = "0", + unmatched = seed && [], + setMatched = [], + contextBackup = outermostContext, + // We must always have either seed elements or outermost context + elems = seed || byElement && Expr.find["TAG"]( "*", outermost ), + // Use integer dirruns iff this is the outermost matcher + dirrunsUnique = (dirruns += contextBackup == null ? 1 : Math.random() || 0.1), + len = elems.length; + + if ( outermost ) { + outermostContext = context === document || context || outermost; + } + + // Add elements passing elementMatchers directly to results + // Support: IE<9, Safari + // Tolerate NodeList properties (IE: "length"; Safari: ) matching elements by id + for ( ; i !== len && (elem = elems[i]) != null; i++ ) { + if ( byElement && elem ) { + j = 0; + if ( !context && elem.ownerDocument !== document ) { + setDocument( elem ); + xml = !documentIsHTML; + } + while ( (matcher = elementMatchers[j++]) ) { + if ( matcher( elem, context || document, xml) ) { + results.push( elem ); + break; + } + } + if ( outermost ) { + dirruns = dirrunsUnique; + } + } + + // Track unmatched elements for set filters + if ( bySet ) { + // They will have gone through all possible matchers + if ( (elem = !matcher && elem) ) { + matchedCount--; + } + + // Lengthen the array for every element, matched or not + if ( seed ) { + unmatched.push( elem ); + } + } + } + + // `i` is now the count of elements visited above, and adding it to `matchedCount` + // makes the latter nonnegative. + matchedCount += i; + + // Apply set filters to unmatched elements + // NOTE: This can be skipped if there are no unmatched elements (i.e., `matchedCount` + // equals `i`), unless we didn't visit _any_ elements in the above loop because we have + // no element matchers and no seed. + // Incrementing an initially-string "0" `i` allows `i` to remain a string only in that + // case, which will result in a "00" `matchedCount` that differs from `i` but is also + // numerically zero. + if ( bySet && i !== matchedCount ) { + j = 0; + while ( (matcher = setMatchers[j++]) ) { + matcher( unmatched, setMatched, context, xml ); + } + + if ( seed ) { + // Reintegrate element matches to eliminate the need for sorting + if ( matchedCount > 0 ) { + while ( i-- ) { + if ( !(unmatched[i] || setMatched[i]) ) { + setMatched[i] = pop.call( results ); + } + } + } + + // Discard index placeholder values to get only actual matches + setMatched = condense( setMatched ); + } + + // Add matches to results + push.apply( results, setMatched ); + + // Seedless set matches succeeding multiple successful matchers stipulate sorting + if ( outermost && !seed && setMatched.length > 0 && + ( matchedCount + setMatchers.length ) > 1 ) { + + Sizzle.uniqueSort( results ); + } + } + + // Override manipulation of globals by nested matchers + if ( outermost ) { + dirruns = dirrunsUnique; + outermostContext = contextBackup; + } + + return unmatched; + }; + + return bySet ? + markFunction( superMatcher ) : + superMatcher; +} + +compile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) { + var i, + setMatchers = [], + elementMatchers = [], + cached = compilerCache[ selector + " " ]; + + if ( !cached ) { + // Generate a function of recursive functions that can be used to check each element + if ( !match ) { + match = tokenize( selector ); + } + i = match.length; + while ( i-- ) { + cached = matcherFromTokens( match[i] ); + if ( cached[ expando ] ) { + setMatchers.push( cached ); + } else { + elementMatchers.push( cached ); + } + } + + // Cache the compiled function + cached = compilerCache( selector, matcherFromGroupMatchers( elementMatchers, setMatchers ) ); + + // Save selector and tokenization + cached.selector = selector; + } + return cached; +}; + +/** + * A low-level selection function that works with Sizzle's compiled + * selector functions + * @param {String|Function} selector A selector or a pre-compiled + * selector function built with Sizzle.compile + * @param {Element} context + * @param {Array} [results] + * @param {Array} [seed] A set of elements to match against + */ +select = Sizzle.select = function( selector, context, results, seed ) { + var i, tokens, token, type, find, + compiled = typeof selector === "function" && selector, + match = !seed && tokenize( (selector = compiled.selector || selector) ); + + results = results || []; + + // Try to minimize operations if there is only one selector in the list and no seed + // (the latter of which guarantees us context) + if ( match.length === 1 ) { + + // Reduce context if the leading compound selector is an ID + tokens = match[0] = match[0].slice( 0 ); + if ( tokens.length > 2 && (token = tokens[0]).type === "ID" && + context.nodeType === 9 && documentIsHTML && Expr.relative[ tokens[1].type ] ) { + + context = ( Expr.find["ID"]( token.matches[0].replace(runescape, funescape), context ) || [] )[0]; + if ( !context ) { + return results; + + // Precompiled matchers will still verify ancestry, so step up a level + } else if ( compiled ) { + context = context.parentNode; + } + + selector = selector.slice( tokens.shift().value.length ); + } + + // Fetch a seed set for right-to-left matching + i = matchExpr["needsContext"].test( selector ) ? 0 : tokens.length; + while ( i-- ) { + token = tokens[i]; + + // Abort if we hit a combinator + if ( Expr.relative[ (type = token.type) ] ) { + break; + } + if ( (find = Expr.find[ type ]) ) { + // Search, expanding context for leading sibling combinators + if ( (seed = find( + token.matches[0].replace( runescape, funescape ), + rsibling.test( tokens[0].type ) && testContext( context.parentNode ) || context + )) ) { + + // If seed is empty or no tokens remain, we can return early + tokens.splice( i, 1 ); + selector = seed.length && toSelector( tokens ); + if ( !selector ) { + push.apply( results, seed ); + return results; + } + + break; + } + } + } + } + + // Compile and execute a filtering function if one is not provided + // Provide `match` to avoid retokenization if we modified the selector above + ( compiled || compile( selector, match ) )( + seed, + context, + !documentIsHTML, + results, + !context || rsibling.test( selector ) && testContext( context.parentNode ) || context + ); + return results; +}; + +// One-time assignments + +// Sort stability +support.sortStable = expando.split("").sort( sortOrder ).join("") === expando; + +// Support: Chrome 14-35+ +// Always assume duplicates if they aren't passed to the comparison function +support.detectDuplicates = !!hasDuplicate; + +// Initialize against the default document +setDocument(); + +// Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27) +// Detached nodes confoundingly follow *each other* +support.sortDetached = assert(function( el ) { + // Should return 1, but returns 4 (following) + return el.compareDocumentPosition( document.createElement("fieldset") ) & 1; +}); + +// Support: IE<8 +// Prevent attribute/property "interpolation" +// https://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx +if ( !assert(function( el ) { + el.innerHTML = ""; + return el.firstChild.getAttribute("href") === "#" ; +}) ) { + addHandle( "type|href|height|width", function( elem, name, isXML ) { + if ( !isXML ) { + return elem.getAttribute( name, name.toLowerCase() === "type" ? 1 : 2 ); + } + }); +} + +// Support: IE<9 +// Use defaultValue in place of getAttribute("value") +if ( !support.attributes || !assert(function( el ) { + el.innerHTML = ""; + el.firstChild.setAttribute( "value", "" ); + return el.firstChild.getAttribute( "value" ) === ""; +}) ) { + addHandle( "value", function( elem, name, isXML ) { + if ( !isXML && elem.nodeName.toLowerCase() === "input" ) { + return elem.defaultValue; + } + }); +} + +// Support: IE<9 +// Use getAttributeNode to fetch booleans when getAttribute lies +if ( !assert(function( el ) { + return el.getAttribute("disabled") == null; +}) ) { + addHandle( booleans, function( elem, name, isXML ) { + var val; + if ( !isXML ) { + return elem[ name ] === true ? name.toLowerCase() : + (val = elem.getAttributeNode( name )) && val.specified ? + val.value : + null; + } + }); +} + +return Sizzle; + +})( window ); + + + +jQuery.find = Sizzle; +jQuery.expr = Sizzle.selectors; + +// Deprecated +jQuery.expr[ ":" ] = jQuery.expr.pseudos; +jQuery.uniqueSort = jQuery.unique = Sizzle.uniqueSort; +jQuery.text = Sizzle.getText; +jQuery.isXMLDoc = Sizzle.isXML; +jQuery.contains = Sizzle.contains; +jQuery.escapeSelector = Sizzle.escape; + + + + +var dir = function( elem, dir, until ) { + var matched = [], + truncate = until !== undefined; + + while ( ( elem = elem[ dir ] ) && elem.nodeType !== 9 ) { + if ( elem.nodeType === 1 ) { + if ( truncate && jQuery( elem ).is( until ) ) { + break; + } + matched.push( elem ); + } + } + return matched; +}; + + +var siblings = function( n, elem ) { + var matched = []; + + for ( ; n; n = n.nextSibling ) { + if ( n.nodeType === 1 && n !== elem ) { + matched.push( n ); + } + } + + return matched; +}; + + +var rneedsContext = jQuery.expr.match.needsContext; + + + +function nodeName( elem, name ) { + + return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase(); + +}; +var rsingleTag = ( /^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i ); + + + +var risSimple = /^.[^:#\[\.,]*$/; + +// Implement the identical functionality for filter and not +function winnow( elements, qualifier, not ) { + if ( jQuery.isFunction( qualifier ) ) { + return jQuery.grep( elements, function( elem, i ) { + return !!qualifier.call( elem, i, elem ) !== not; + } ); + } + + // Single element + if ( qualifier.nodeType ) { + return jQuery.grep( elements, function( elem ) { + return ( elem === qualifier ) !== not; + } ); + } + + // Arraylike of elements (jQuery, arguments, Array) + if ( typeof qualifier !== "string" ) { + return jQuery.grep( elements, function( elem ) { + return ( indexOf.call( qualifier, elem ) > -1 ) !== not; + } ); + } + + // Simple selector that can be filtered directly, removing non-Elements + if ( risSimple.test( qualifier ) ) { + return jQuery.filter( qualifier, elements, not ); + } + + // Complex selector, compare the two sets, removing non-Elements + qualifier = jQuery.filter( qualifier, elements ); + return jQuery.grep( elements, function( elem ) { + return ( indexOf.call( qualifier, elem ) > -1 ) !== not && elem.nodeType === 1; + } ); +} + +jQuery.filter = function( expr, elems, not ) { + var elem = elems[ 0 ]; + + if ( not ) { + expr = ":not(" + expr + ")"; + } + + if ( elems.length === 1 && elem.nodeType === 1 ) { + return jQuery.find.matchesSelector( elem, expr ) ? [ elem ] : []; + } + + return jQuery.find.matches( expr, jQuery.grep( elems, function( elem ) { + return elem.nodeType === 1; + } ) ); +}; + +jQuery.fn.extend( { + find: function( selector ) { + var i, ret, + len = this.length, + self = this; + + if ( typeof selector !== "string" ) { + return this.pushStack( jQuery( selector ).filter( function() { + for ( i = 0; i < len; i++ ) { + if ( jQuery.contains( self[ i ], this ) ) { + return true; + } + } + } ) ); + } + + ret = this.pushStack( [] ); + + for ( i = 0; i < len; i++ ) { + jQuery.find( selector, self[ i ], ret ); + } + + return len > 1 ? jQuery.uniqueSort( ret ) : ret; + }, + filter: function( selector ) { + return this.pushStack( winnow( this, selector || [], false ) ); + }, + not: function( selector ) { + return this.pushStack( winnow( this, selector || [], true ) ); + }, + is: function( selector ) { + return !!winnow( + this, + + // If this is a positional/relative selector, check membership in the returned set + // so $("p:first").is("p:last") won't return true for a doc with two "p". + typeof selector === "string" && rneedsContext.test( selector ) ? + jQuery( selector ) : + selector || [], + false + ).length; + } +} ); + + +// Initialize a jQuery object + + +// A central reference to the root jQuery(document) +var rootjQuery, + + // A simple way to check for HTML strings + // Prioritize #id over to avoid XSS via location.hash (#9521) + // Strict HTML recognition (#11290: must start with <) + // Shortcut simple #id case for speed + rquickExpr = /^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/, + + init = jQuery.fn.init = function( selector, context, root ) { + var match, elem; + + // HANDLE: $(""), $(null), $(undefined), $(false) + if ( !selector ) { + return this; + } + + // Method init() accepts an alternate rootjQuery + // so migrate can support jQuery.sub (gh-2101) + root = root || rootjQuery; + + // Handle HTML strings + if ( typeof selector === "string" ) { + if ( selector[ 0 ] === "<" && + selector[ selector.length - 1 ] === ">" && + selector.length >= 3 ) { + + // Assume that strings that start and end with <> are HTML and skip the regex check + match = [ null, selector, null ]; + + } else { + match = rquickExpr.exec( selector ); + } + + // Match html or make sure no context is specified for #id + if ( match && ( match[ 1 ] || !context ) ) { + + // HANDLE: $(html) -> $(array) + if ( match[ 1 ] ) { + context = context instanceof jQuery ? context[ 0 ] : context; + + // Option to run scripts is true for back-compat + // Intentionally let the error be thrown if parseHTML is not present + jQuery.merge( this, jQuery.parseHTML( + match[ 1 ], + context && context.nodeType ? context.ownerDocument || context : document, + true + ) ); + + // HANDLE: $(html, props) + if ( rsingleTag.test( match[ 1 ] ) && jQuery.isPlainObject( context ) ) { + for ( match in context ) { + + // Properties of context are called as methods if possible + if ( jQuery.isFunction( this[ match ] ) ) { + this[ match ]( context[ match ] ); + + // ...and otherwise set as attributes + } else { + this.attr( match, context[ match ] ); + } + } + } + + return this; + + // HANDLE: $(#id) + } else { + elem = document.getElementById( match[ 2 ] ); + + if ( elem ) { + + // Inject the element directly into the jQuery object + this[ 0 ] = elem; + this.length = 1; + } + return this; + } + + // HANDLE: $(expr, $(...)) + } else if ( !context || context.jquery ) { + return ( context || root ).find( selector ); + + // HANDLE: $(expr, context) + // (which is just equivalent to: $(context).find(expr) + } else { + return this.constructor( context ).find( selector ); + } + + // HANDLE: $(DOMElement) + } else if ( selector.nodeType ) { + this[ 0 ] = selector; + this.length = 1; + return this; + + // HANDLE: $(function) + // Shortcut for document ready + } else if ( jQuery.isFunction( selector ) ) { + return root.ready !== undefined ? + root.ready( selector ) : + + // Execute immediately if ready is not present + selector( jQuery ); + } + + return jQuery.makeArray( selector, this ); + }; + +// Give the init function the jQuery prototype for later instantiation +init.prototype = jQuery.fn; + +// Initialize central reference +rootjQuery = jQuery( document ); + + +var rparentsprev = /^(?:parents|prev(?:Until|All))/, + + // Methods guaranteed to produce a unique set when starting from a unique set + guaranteedUnique = { + children: true, + contents: true, + next: true, + prev: true + }; + +jQuery.fn.extend( { + has: function( target ) { + var targets = jQuery( target, this ), + l = targets.length; + + return this.filter( function() { + var i = 0; + for ( ; i < l; i++ ) { + if ( jQuery.contains( this, targets[ i ] ) ) { + return true; + } + } + } ); + }, + + closest: function( selectors, context ) { + var cur, + i = 0, + l = this.length, + matched = [], + targets = typeof selectors !== "string" && jQuery( selectors ); + + // Positional selectors never match, since there's no _selection_ context + if ( !rneedsContext.test( selectors ) ) { + for ( ; i < l; i++ ) { + for ( cur = this[ i ]; cur && cur !== context; cur = cur.parentNode ) { + + // Always skip document fragments + if ( cur.nodeType < 11 && ( targets ? + targets.index( cur ) > -1 : + + // Don't pass non-elements to Sizzle + cur.nodeType === 1 && + jQuery.find.matchesSelector( cur, selectors ) ) ) { + + matched.push( cur ); + break; + } + } + } + } + + return this.pushStack( matched.length > 1 ? jQuery.uniqueSort( matched ) : matched ); + }, + + // Determine the position of an element within the set + index: function( elem ) { + + // No argument, return index in parent + if ( !elem ) { + return ( this[ 0 ] && this[ 0 ].parentNode ) ? this.first().prevAll().length : -1; + } + + // Index in selector + if ( typeof elem === "string" ) { + return indexOf.call( jQuery( elem ), this[ 0 ] ); + } + + // Locate the position of the desired element + return indexOf.call( this, + + // If it receives a jQuery object, the first element is used + elem.jquery ? elem[ 0 ] : elem + ); + }, + + add: function( selector, context ) { + return this.pushStack( + jQuery.uniqueSort( + jQuery.merge( this.get(), jQuery( selector, context ) ) + ) + ); + }, + + addBack: function( selector ) { + return this.add( selector == null ? + this.prevObject : this.prevObject.filter( selector ) + ); + } +} ); + +function sibling( cur, dir ) { + while ( ( cur = cur[ dir ] ) && cur.nodeType !== 1 ) {} + return cur; +} + +jQuery.each( { + parent: function( elem ) { + var parent = elem.parentNode; + return parent && parent.nodeType !== 11 ? parent : null; + }, + parents: function( elem ) { + return dir( elem, "parentNode" ); + }, + parentsUntil: function( elem, i, until ) { + return dir( elem, "parentNode", until ); + }, + next: function( elem ) { + return sibling( elem, "nextSibling" ); + }, + prev: function( elem ) { + return sibling( elem, "previousSibling" ); + }, + nextAll: function( elem ) { + return dir( elem, "nextSibling" ); + }, + prevAll: function( elem ) { + return dir( elem, "previousSibling" ); + }, + nextUntil: function( elem, i, until ) { + return dir( elem, "nextSibling", until ); + }, + prevUntil: function( elem, i, until ) { + return dir( elem, "previousSibling", until ); + }, + siblings: function( elem ) { + return siblings( ( elem.parentNode || {} ).firstChild, elem ); + }, + children: function( elem ) { + return siblings( elem.firstChild ); + }, + contents: function( elem ) { + if ( nodeName( elem, "iframe" ) ) { + return elem.contentDocument; + } + + // Support: IE 9 - 11 only, iOS 7 only, Android Browser <=4.3 only + // Treat the template element as a regular one in browsers that + // don't support it. + if ( nodeName( elem, "template" ) ) { + elem = elem.content || elem; + } + + return jQuery.merge( [], elem.childNodes ); + } +}, function( name, fn ) { + jQuery.fn[ name ] = function( until, selector ) { + var matched = jQuery.map( this, fn, until ); + + if ( name.slice( -5 ) !== "Until" ) { + selector = until; + } + + if ( selector && typeof selector === "string" ) { + matched = jQuery.filter( selector, matched ); + } + + if ( this.length > 1 ) { + + // Remove duplicates + if ( !guaranteedUnique[ name ] ) { + jQuery.uniqueSort( matched ); + } + + // Reverse order for parents* and prev-derivatives + if ( rparentsprev.test( name ) ) { + matched.reverse(); + } + } + + return this.pushStack( matched ); + }; +} ); +var rnothtmlwhite = ( /[^\x20\t\r\n\f]+/g ); + + + +// Convert String-formatted options into Object-formatted ones +function createOptions( options ) { + var object = {}; + jQuery.each( options.match( rnothtmlwhite ) || [], function( _, flag ) { + object[ flag ] = true; + } ); + return object; +} + +/* + * Create a callback list using the following parameters: + * + * options: an optional list of space-separated options that will change how + * the callback list behaves or a more traditional option object + * + * By default a callback list will act like an event callback list and can be + * "fired" multiple times. + * + * Possible options: + * + * once: will ensure the callback list can only be fired once (like a Deferred) + * + * memory: will keep track of previous values and will call any callback added + * after the list has been fired right away with the latest "memorized" + * values (like a Deferred) + * + * unique: will ensure a callback can only be added once (no duplicate in the list) + * + * stopOnFalse: interrupt callings when a callback returns false + * + */ +jQuery.Callbacks = function( options ) { + + // Convert options from String-formatted to Object-formatted if needed + // (we check in cache first) + options = typeof options === "string" ? + createOptions( options ) : + jQuery.extend( {}, options ); + + var // Flag to know if list is currently firing + firing, + + // Last fire value for non-forgettable lists + memory, + + // Flag to know if list was already fired + fired, + + // Flag to prevent firing + locked, + + // Actual callback list + list = [], + + // Queue of execution data for repeatable lists + queue = [], + + // Index of currently firing callback (modified by add/remove as needed) + firingIndex = -1, + + // Fire callbacks + fire = function() { + + // Enforce single-firing + locked = locked || options.once; + + // Execute callbacks for all pending executions, + // respecting firingIndex overrides and runtime changes + fired = firing = true; + for ( ; queue.length; firingIndex = -1 ) { + memory = queue.shift(); + while ( ++firingIndex < list.length ) { + + // Run callback and check for early termination + if ( list[ firingIndex ].apply( memory[ 0 ], memory[ 1 ] ) === false && + options.stopOnFalse ) { + + // Jump to end and forget the data so .add doesn't re-fire + firingIndex = list.length; + memory = false; + } + } + } + + // Forget the data if we're done with it + if ( !options.memory ) { + memory = false; + } + + firing = false; + + // Clean up if we're done firing for good + if ( locked ) { + + // Keep an empty list if we have data for future add calls + if ( memory ) { + list = []; + + // Otherwise, this object is spent + } else { + list = ""; + } + } + }, + + // Actual Callbacks object + self = { + + // Add a callback or a collection of callbacks to the list + add: function() { + if ( list ) { + + // If we have memory from a past run, we should fire after adding + if ( memory && !firing ) { + firingIndex = list.length - 1; + queue.push( memory ); + } + + ( function add( args ) { + jQuery.each( args, function( _, arg ) { + if ( jQuery.isFunction( arg ) ) { + if ( !options.unique || !self.has( arg ) ) { + list.push( arg ); + } + } else if ( arg && arg.length && jQuery.type( arg ) !== "string" ) { + + // Inspect recursively + add( arg ); + } + } ); + } )( arguments ); + + if ( memory && !firing ) { + fire(); + } + } + return this; + }, + + // Remove a callback from the list + remove: function() { + jQuery.each( arguments, function( _, arg ) { + var index; + while ( ( index = jQuery.inArray( arg, list, index ) ) > -1 ) { + list.splice( index, 1 ); + + // Handle firing indexes + if ( index <= firingIndex ) { + firingIndex--; + } + } + } ); + return this; + }, + + // Check if a given callback is in the list. + // If no argument is given, return whether or not list has callbacks attached. + has: function( fn ) { + return fn ? + jQuery.inArray( fn, list ) > -1 : + list.length > 0; + }, + + // Remove all callbacks from the list + empty: function() { + if ( list ) { + list = []; + } + return this; + }, + + // Disable .fire and .add + // Abort any current/pending executions + // Clear all callbacks and values + disable: function() { + locked = queue = []; + list = memory = ""; + return this; + }, + disabled: function() { + return !list; + }, + + // Disable .fire + // Also disable .add unless we have memory (since it would have no effect) + // Abort any pending executions + lock: function() { + locked = queue = []; + if ( !memory && !firing ) { + list = memory = ""; + } + return this; + }, + locked: function() { + return !!locked; + }, + + // Call all callbacks with the given context and arguments + fireWith: function( context, args ) { + if ( !locked ) { + args = args || []; + args = [ context, args.slice ? args.slice() : args ]; + queue.push( args ); + if ( !firing ) { + fire(); + } + } + return this; + }, + + // Call all the callbacks with the given arguments + fire: function() { + self.fireWith( this, arguments ); + return this; + }, + + // To know if the callbacks have already been called at least once + fired: function() { + return !!fired; + } + }; + + return self; +}; + + +function Identity( v ) { + return v; +} +function Thrower( ex ) { + throw ex; +} + +function adoptValue( value, resolve, reject, noValue ) { + var method; + + try { + + // Check for promise aspect first to privilege synchronous behavior + if ( value && jQuery.isFunction( ( method = value.promise ) ) ) { + method.call( value ).done( resolve ).fail( reject ); + + // Other thenables + } else if ( value && jQuery.isFunction( ( method = value.then ) ) ) { + method.call( value, resolve, reject ); + + // Other non-thenables + } else { + + // Control `resolve` arguments by letting Array#slice cast boolean `noValue` to integer: + // * false: [ value ].slice( 0 ) => resolve( value ) + // * true: [ value ].slice( 1 ) => resolve() + resolve.apply( undefined, [ value ].slice( noValue ) ); + } + + // For Promises/A+, convert exceptions into rejections + // Since jQuery.when doesn't unwrap thenables, we can skip the extra checks appearing in + // Deferred#then to conditionally suppress rejection. + } catch ( value ) { + + // Support: Android 4.0 only + // Strict mode functions invoked without .call/.apply get global-object context + reject.apply( undefined, [ value ] ); + } +} + +jQuery.extend( { + + Deferred: function( func ) { + var tuples = [ + + // action, add listener, callbacks, + // ... .then handlers, argument index, [final state] + [ "notify", "progress", jQuery.Callbacks( "memory" ), + jQuery.Callbacks( "memory" ), 2 ], + [ "resolve", "done", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 0, "resolved" ], + [ "reject", "fail", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 1, "rejected" ] + ], + state = "pending", + promise = { + state: function() { + return state; + }, + always: function() { + deferred.done( arguments ).fail( arguments ); + return this; + }, + "catch": function( fn ) { + return promise.then( null, fn ); + }, + + // Keep pipe for back-compat + pipe: function( /* fnDone, fnFail, fnProgress */ ) { + var fns = arguments; + + return jQuery.Deferred( function( newDefer ) { + jQuery.each( tuples, function( i, tuple ) { + + // Map tuples (progress, done, fail) to arguments (done, fail, progress) + var fn = jQuery.isFunction( fns[ tuple[ 4 ] ] ) && fns[ tuple[ 4 ] ]; + + // deferred.progress(function() { bind to newDefer or newDefer.notify }) + // deferred.done(function() { bind to newDefer or newDefer.resolve }) + // deferred.fail(function() { bind to newDefer or newDefer.reject }) + deferred[ tuple[ 1 ] ]( function() { + var returned = fn && fn.apply( this, arguments ); + if ( returned && jQuery.isFunction( returned.promise ) ) { + returned.promise() + .progress( newDefer.notify ) + .done( newDefer.resolve ) + .fail( newDefer.reject ); + } else { + newDefer[ tuple[ 0 ] + "With" ]( + this, + fn ? [ returned ] : arguments + ); + } + } ); + } ); + fns = null; + } ).promise(); + }, + then: function( onFulfilled, onRejected, onProgress ) { + var maxDepth = 0; + function resolve( depth, deferred, handler, special ) { + return function() { + var that = this, + args = arguments, + mightThrow = function() { + var returned, then; + + // Support: Promises/A+ section 2.3.3.3.3 + // https://promisesaplus.com/#point-59 + // Ignore double-resolution attempts + if ( depth < maxDepth ) { + return; + } + + returned = handler.apply( that, args ); + + // Support: Promises/A+ section 2.3.1 + // https://promisesaplus.com/#point-48 + if ( returned === deferred.promise() ) { + throw new TypeError( "Thenable self-resolution" ); + } + + // Support: Promises/A+ sections 2.3.3.1, 3.5 + // https://promisesaplus.com/#point-54 + // https://promisesaplus.com/#point-75 + // Retrieve `then` only once + then = returned && + + // Support: Promises/A+ section 2.3.4 + // https://promisesaplus.com/#point-64 + // Only check objects and functions for thenability + ( typeof returned === "object" || + typeof returned === "function" ) && + returned.then; + + // Handle a returned thenable + if ( jQuery.isFunction( then ) ) { + + // Special processors (notify) just wait for resolution + if ( special ) { + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ) + ); + + // Normal processors (resolve) also hook into progress + } else { + + // ...and disregard older resolution values + maxDepth++; + + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ), + resolve( maxDepth, deferred, Identity, + deferred.notifyWith ) + ); + } + + // Handle all other returned values + } else { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Identity ) { + that = undefined; + args = [ returned ]; + } + + // Process the value(s) + // Default process is resolve + ( special || deferred.resolveWith )( that, args ); + } + }, + + // Only normal processors (resolve) catch and reject exceptions + process = special ? + mightThrow : + function() { + try { + mightThrow(); + } catch ( e ) { + + if ( jQuery.Deferred.exceptionHook ) { + jQuery.Deferred.exceptionHook( e, + process.stackTrace ); + } + + // Support: Promises/A+ section 2.3.3.3.4.1 + // https://promisesaplus.com/#point-61 + // Ignore post-resolution exceptions + if ( depth + 1 >= maxDepth ) { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Thrower ) { + that = undefined; + args = [ e ]; + } + + deferred.rejectWith( that, args ); + } + } + }; + + // Support: Promises/A+ section 2.3.3.3.1 + // https://promisesaplus.com/#point-57 + // Re-resolve promises immediately to dodge false rejection from + // subsequent errors + if ( depth ) { + process(); + } else { + + // Call an optional hook to record the stack, in case of exception + // since it's otherwise lost when execution goes async + if ( jQuery.Deferred.getStackHook ) { + process.stackTrace = jQuery.Deferred.getStackHook(); + } + window.setTimeout( process ); + } + }; + } + + return jQuery.Deferred( function( newDefer ) { + + // progress_handlers.add( ... ) + tuples[ 0 ][ 3 ].add( + resolve( + 0, + newDefer, + jQuery.isFunction( onProgress ) ? + onProgress : + Identity, + newDefer.notifyWith + ) + ); + + // fulfilled_handlers.add( ... ) + tuples[ 1 ][ 3 ].add( + resolve( + 0, + newDefer, + jQuery.isFunction( onFulfilled ) ? + onFulfilled : + Identity + ) + ); + + // rejected_handlers.add( ... ) + tuples[ 2 ][ 3 ].add( + resolve( + 0, + newDefer, + jQuery.isFunction( onRejected ) ? + onRejected : + Thrower + ) + ); + } ).promise(); + }, + + // Get a promise for this deferred + // If obj is provided, the promise aspect is added to the object + promise: function( obj ) { + return obj != null ? jQuery.extend( obj, promise ) : promise; + } + }, + deferred = {}; + + // Add list-specific methods + jQuery.each( tuples, function( i, tuple ) { + var list = tuple[ 2 ], + stateString = tuple[ 5 ]; + + // promise.progress = list.add + // promise.done = list.add + // promise.fail = list.add + promise[ tuple[ 1 ] ] = list.add; + + // Handle state + if ( stateString ) { + list.add( + function() { + + // state = "resolved" (i.e., fulfilled) + // state = "rejected" + state = stateString; + }, + + // rejected_callbacks.disable + // fulfilled_callbacks.disable + tuples[ 3 - i ][ 2 ].disable, + + // progress_callbacks.lock + tuples[ 0 ][ 2 ].lock + ); + } + + // progress_handlers.fire + // fulfilled_handlers.fire + // rejected_handlers.fire + list.add( tuple[ 3 ].fire ); + + // deferred.notify = function() { deferred.notifyWith(...) } + // deferred.resolve = function() { deferred.resolveWith(...) } + // deferred.reject = function() { deferred.rejectWith(...) } + deferred[ tuple[ 0 ] ] = function() { + deferred[ tuple[ 0 ] + "With" ]( this === deferred ? undefined : this, arguments ); + return this; + }; + + // deferred.notifyWith = list.fireWith + // deferred.resolveWith = list.fireWith + // deferred.rejectWith = list.fireWith + deferred[ tuple[ 0 ] + "With" ] = list.fireWith; + } ); + + // Make the deferred a promise + promise.promise( deferred ); + + // Call given func if any + if ( func ) { + func.call( deferred, deferred ); + } + + // All done! + return deferred; + }, + + // Deferred helper + when: function( singleValue ) { + var + + // count of uncompleted subordinates + remaining = arguments.length, + + // count of unprocessed arguments + i = remaining, + + // subordinate fulfillment data + resolveContexts = Array( i ), + resolveValues = slice.call( arguments ), + + // the master Deferred + master = jQuery.Deferred(), + + // subordinate callback factory + updateFunc = function( i ) { + return function( value ) { + resolveContexts[ i ] = this; + resolveValues[ i ] = arguments.length > 1 ? slice.call( arguments ) : value; + if ( !( --remaining ) ) { + master.resolveWith( resolveContexts, resolveValues ); + } + }; + }; + + // Single- and empty arguments are adopted like Promise.resolve + if ( remaining <= 1 ) { + adoptValue( singleValue, master.done( updateFunc( i ) ).resolve, master.reject, + !remaining ); + + // Use .then() to unwrap secondary thenables (cf. gh-3000) + if ( master.state() === "pending" || + jQuery.isFunction( resolveValues[ i ] && resolveValues[ i ].then ) ) { + + return master.then(); + } + } + + // Multiple arguments are aggregated like Promise.all array elements + while ( i-- ) { + adoptValue( resolveValues[ i ], updateFunc( i ), master.reject ); + } + + return master.promise(); + } +} ); + + +// These usually indicate a programmer mistake during development, +// warn about them ASAP rather than swallowing them by default. +var rerrorNames = /^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/; + +jQuery.Deferred.exceptionHook = function( error, stack ) { + + // Support: IE 8 - 9 only + // Console exists when dev tools are open, which can happen at any time + if ( window.console && window.console.warn && error && rerrorNames.test( error.name ) ) { + window.console.warn( "jQuery.Deferred exception: " + error.message, error.stack, stack ); + } +}; + + + + +jQuery.readyException = function( error ) { + window.setTimeout( function() { + throw error; + } ); +}; + + + + +// The deferred used on DOM ready +var readyList = jQuery.Deferred(); + +jQuery.fn.ready = function( fn ) { + + readyList + .then( fn ) + + // Wrap jQuery.readyException in a function so that the lookup + // happens at the time of error handling instead of callback + // registration. + .catch( function( error ) { + jQuery.readyException( error ); + } ); + + return this; +}; + +jQuery.extend( { + + // Is the DOM ready to be used? Set to true once it occurs. + isReady: false, + + // A counter to track how many items to wait for before + // the ready event fires. See #6781 + readyWait: 1, + + // Handle when the DOM is ready + ready: function( wait ) { + + // Abort if there are pending holds or we're already ready + if ( wait === true ? --jQuery.readyWait : jQuery.isReady ) { + return; + } + + // Remember that the DOM is ready + jQuery.isReady = true; + + // If a normal DOM Ready event fired, decrement, and wait if need be + if ( wait !== true && --jQuery.readyWait > 0 ) { + return; + } + + // If there are functions bound, to execute + readyList.resolveWith( document, [ jQuery ] ); + } +} ); + +jQuery.ready.then = readyList.then; + +// The ready event handler and self cleanup method +function completed() { + document.removeEventListener( "DOMContentLoaded", completed ); + window.removeEventListener( "load", completed ); + jQuery.ready(); +} + +// Catch cases where $(document).ready() is called +// after the browser event has already occurred. +// Support: IE <=9 - 10 only +// Older IE sometimes signals "interactive" too soon +if ( document.readyState === "complete" || + ( document.readyState !== "loading" && !document.documentElement.doScroll ) ) { + + // Handle it asynchronously to allow scripts the opportunity to delay ready + window.setTimeout( jQuery.ready ); + +} else { + + // Use the handy event callback + document.addEventListener( "DOMContentLoaded", completed ); + + // A fallback to window.onload, that will always work + window.addEventListener( "load", completed ); +} + + + + +// Multifunctional method to get and set values of a collection +// The value/s can optionally be executed if it's a function +var access = function( elems, fn, key, value, chainable, emptyGet, raw ) { + var i = 0, + len = elems.length, + bulk = key == null; + + // Sets many values + if ( jQuery.type( key ) === "object" ) { + chainable = true; + for ( i in key ) { + access( elems, fn, i, key[ i ], true, emptyGet, raw ); + } + + // Sets one value + } else if ( value !== undefined ) { + chainable = true; + + if ( !jQuery.isFunction( value ) ) { + raw = true; + } + + if ( bulk ) { + + // Bulk operations run against the entire set + if ( raw ) { + fn.call( elems, value ); + fn = null; + + // ...except when executing function values + } else { + bulk = fn; + fn = function( elem, key, value ) { + return bulk.call( jQuery( elem ), value ); + }; + } + } + + if ( fn ) { + for ( ; i < len; i++ ) { + fn( + elems[ i ], key, raw ? + value : + value.call( elems[ i ], i, fn( elems[ i ], key ) ) + ); + } + } + } + + if ( chainable ) { + return elems; + } + + // Gets + if ( bulk ) { + return fn.call( elems ); + } + + return len ? fn( elems[ 0 ], key ) : emptyGet; +}; +var acceptData = function( owner ) { + + // Accepts only: + // - Node + // - Node.ELEMENT_NODE + // - Node.DOCUMENT_NODE + // - Object + // - Any + return owner.nodeType === 1 || owner.nodeType === 9 || !( +owner.nodeType ); +}; + + + + +function Data() { + this.expando = jQuery.expando + Data.uid++; +} + +Data.uid = 1; + +Data.prototype = { + + cache: function( owner ) { + + // Check if the owner object already has a cache + var value = owner[ this.expando ]; + + // If not, create one + if ( !value ) { + value = {}; + + // We can accept data for non-element nodes in modern browsers, + // but we should not, see #8335. + // Always return an empty object. + if ( acceptData( owner ) ) { + + // If it is a node unlikely to be stringify-ed or looped over + // use plain assignment + if ( owner.nodeType ) { + owner[ this.expando ] = value; + + // Otherwise secure it in a non-enumerable property + // configurable must be true to allow the property to be + // deleted when data is removed + } else { + Object.defineProperty( owner, this.expando, { + value: value, + configurable: true + } ); + } + } + } + + return value; + }, + set: function( owner, data, value ) { + var prop, + cache = this.cache( owner ); + + // Handle: [ owner, key, value ] args + // Always use camelCase key (gh-2257) + if ( typeof data === "string" ) { + cache[ jQuery.camelCase( data ) ] = value; + + // Handle: [ owner, { properties } ] args + } else { + + // Copy the properties one-by-one to the cache object + for ( prop in data ) { + cache[ jQuery.camelCase( prop ) ] = data[ prop ]; + } + } + return cache; + }, + get: function( owner, key ) { + return key === undefined ? + this.cache( owner ) : + + // Always use camelCase key (gh-2257) + owner[ this.expando ] && owner[ this.expando ][ jQuery.camelCase( key ) ]; + }, + access: function( owner, key, value ) { + + // In cases where either: + // + // 1. No key was specified + // 2. A string key was specified, but no value provided + // + // Take the "read" path and allow the get method to determine + // which value to return, respectively either: + // + // 1. The entire cache object + // 2. The data stored at the key + // + if ( key === undefined || + ( ( key && typeof key === "string" ) && value === undefined ) ) { + + return this.get( owner, key ); + } + + // When the key is not a string, or both a key and value + // are specified, set or extend (existing objects) with either: + // + // 1. An object of properties + // 2. A key and value + // + this.set( owner, key, value ); + + // Since the "set" path can have two possible entry points + // return the expected data based on which path was taken[*] + return value !== undefined ? value : key; + }, + remove: function( owner, key ) { + var i, + cache = owner[ this.expando ]; + + if ( cache === undefined ) { + return; + } + + if ( key !== undefined ) { + + // Support array or space separated string of keys + if ( Array.isArray( key ) ) { + + // If key is an array of keys... + // We always set camelCase keys, so remove that. + key = key.map( jQuery.camelCase ); + } else { + key = jQuery.camelCase( key ); + + // If a key with the spaces exists, use it. + // Otherwise, create an array by matching non-whitespace + key = key in cache ? + [ key ] : + ( key.match( rnothtmlwhite ) || [] ); + } + + i = key.length; + + while ( i-- ) { + delete cache[ key[ i ] ]; + } + } + + // Remove the expando if there's no more data + if ( key === undefined || jQuery.isEmptyObject( cache ) ) { + + // Support: Chrome <=35 - 45 + // Webkit & Blink performance suffers when deleting properties + // from DOM nodes, so set to undefined instead + // https://bugs.chromium.org/p/chromium/issues/detail?id=378607 (bug restricted) + if ( owner.nodeType ) { + owner[ this.expando ] = undefined; + } else { + delete owner[ this.expando ]; + } + } + }, + hasData: function( owner ) { + var cache = owner[ this.expando ]; + return cache !== undefined && !jQuery.isEmptyObject( cache ); + } +}; +var dataPriv = new Data(); + +var dataUser = new Data(); + + + +// Implementation Summary +// +// 1. Enforce API surface and semantic compatibility with 1.9.x branch +// 2. Improve the module's maintainability by reducing the storage +// paths to a single mechanism. +// 3. Use the same single mechanism to support "private" and "user" data. +// 4. _Never_ expose "private" data to user code (TODO: Drop _data, _removeData) +// 5. Avoid exposing implementation details on user objects (eg. expando properties) +// 6. Provide a clear path for implementation upgrade to WeakMap in 2014 + +var rbrace = /^(?:\{[\w\W]*\}|\[[\w\W]*\])$/, + rmultiDash = /[A-Z]/g; + +function getData( data ) { + if ( data === "true" ) { + return true; + } + + if ( data === "false" ) { + return false; + } + + if ( data === "null" ) { + return null; + } + + // Only convert to a number if it doesn't change the string + if ( data === +data + "" ) { + return +data; + } + + if ( rbrace.test( data ) ) { + return JSON.parse( data ); + } + + return data; +} + +function dataAttr( elem, key, data ) { + var name; + + // If nothing was found internally, try to fetch any + // data from the HTML5 data-* attribute + if ( data === undefined && elem.nodeType === 1 ) { + name = "data-" + key.replace( rmultiDash, "-$&" ).toLowerCase(); + data = elem.getAttribute( name ); + + if ( typeof data === "string" ) { + try { + data = getData( data ); + } catch ( e ) {} + + // Make sure we set the data so it isn't changed later + dataUser.set( elem, key, data ); + } else { + data = undefined; + } + } + return data; +} + +jQuery.extend( { + hasData: function( elem ) { + return dataUser.hasData( elem ) || dataPriv.hasData( elem ); + }, + + data: function( elem, name, data ) { + return dataUser.access( elem, name, data ); + }, + + removeData: function( elem, name ) { + dataUser.remove( elem, name ); + }, + + // TODO: Now that all calls to _data and _removeData have been replaced + // with direct calls to dataPriv methods, these can be deprecated. + _data: function( elem, name, data ) { + return dataPriv.access( elem, name, data ); + }, + + _removeData: function( elem, name ) { + dataPriv.remove( elem, name ); + } +} ); + +jQuery.fn.extend( { + data: function( key, value ) { + var i, name, data, + elem = this[ 0 ], + attrs = elem && elem.attributes; + + // Gets all values + if ( key === undefined ) { + if ( this.length ) { + data = dataUser.get( elem ); + + if ( elem.nodeType === 1 && !dataPriv.get( elem, "hasDataAttrs" ) ) { + i = attrs.length; + while ( i-- ) { + + // Support: IE 11 only + // The attrs elements can be null (#14894) + if ( attrs[ i ] ) { + name = attrs[ i ].name; + if ( name.indexOf( "data-" ) === 0 ) { + name = jQuery.camelCase( name.slice( 5 ) ); + dataAttr( elem, name, data[ name ] ); + } + } + } + dataPriv.set( elem, "hasDataAttrs", true ); + } + } + + return data; + } + + // Sets multiple values + if ( typeof key === "object" ) { + return this.each( function() { + dataUser.set( this, key ); + } ); + } + + return access( this, function( value ) { + var data; + + // The calling jQuery object (element matches) is not empty + // (and therefore has an element appears at this[ 0 ]) and the + // `value` parameter was not undefined. An empty jQuery object + // will result in `undefined` for elem = this[ 0 ] which will + // throw an exception if an attempt to read a data cache is made. + if ( elem && value === undefined ) { + + // Attempt to get data from the cache + // The key will always be camelCased in Data + data = dataUser.get( elem, key ); + if ( data !== undefined ) { + return data; + } + + // Attempt to "discover" the data in + // HTML5 custom data-* attrs + data = dataAttr( elem, key ); + if ( data !== undefined ) { + return data; + } + + // We tried really hard, but the data doesn't exist. + return; + } + + // Set the data... + this.each( function() { + + // We always store the camelCased key + dataUser.set( this, key, value ); + } ); + }, null, value, arguments.length > 1, null, true ); + }, + + removeData: function( key ) { + return this.each( function() { + dataUser.remove( this, key ); + } ); + } +} ); + + +jQuery.extend( { + queue: function( elem, type, data ) { + var queue; + + if ( elem ) { + type = ( type || "fx" ) + "queue"; + queue = dataPriv.get( elem, type ); + + // Speed up dequeue by getting out quickly if this is just a lookup + if ( data ) { + if ( !queue || Array.isArray( data ) ) { + queue = dataPriv.access( elem, type, jQuery.makeArray( data ) ); + } else { + queue.push( data ); + } + } + return queue || []; + } + }, + + dequeue: function( elem, type ) { + type = type || "fx"; + + var queue = jQuery.queue( elem, type ), + startLength = queue.length, + fn = queue.shift(), + hooks = jQuery._queueHooks( elem, type ), + next = function() { + jQuery.dequeue( elem, type ); + }; + + // If the fx queue is dequeued, always remove the progress sentinel + if ( fn === "inprogress" ) { + fn = queue.shift(); + startLength--; + } + + if ( fn ) { + + // Add a progress sentinel to prevent the fx queue from being + // automatically dequeued + if ( type === "fx" ) { + queue.unshift( "inprogress" ); + } + + // Clear up the last queue stop function + delete hooks.stop; + fn.call( elem, next, hooks ); + } + + if ( !startLength && hooks ) { + hooks.empty.fire(); + } + }, + + // Not public - generate a queueHooks object, or return the current one + _queueHooks: function( elem, type ) { + var key = type + "queueHooks"; + return dataPriv.get( elem, key ) || dataPriv.access( elem, key, { + empty: jQuery.Callbacks( "once memory" ).add( function() { + dataPriv.remove( elem, [ type + "queue", key ] ); + } ) + } ); + } +} ); + +jQuery.fn.extend( { + queue: function( type, data ) { + var setter = 2; + + if ( typeof type !== "string" ) { + data = type; + type = "fx"; + setter--; + } + + if ( arguments.length < setter ) { + return jQuery.queue( this[ 0 ], type ); + } + + return data === undefined ? + this : + this.each( function() { + var queue = jQuery.queue( this, type, data ); + + // Ensure a hooks for this queue + jQuery._queueHooks( this, type ); + + if ( type === "fx" && queue[ 0 ] !== "inprogress" ) { + jQuery.dequeue( this, type ); + } + } ); + }, + dequeue: function( type ) { + return this.each( function() { + jQuery.dequeue( this, type ); + } ); + }, + clearQueue: function( type ) { + return this.queue( type || "fx", [] ); + }, + + // Get a promise resolved when queues of a certain type + // are emptied (fx is the type by default) + promise: function( type, obj ) { + var tmp, + count = 1, + defer = jQuery.Deferred(), + elements = this, + i = this.length, + resolve = function() { + if ( !( --count ) ) { + defer.resolveWith( elements, [ elements ] ); + } + }; + + if ( typeof type !== "string" ) { + obj = type; + type = undefined; + } + type = type || "fx"; + + while ( i-- ) { + tmp = dataPriv.get( elements[ i ], type + "queueHooks" ); + if ( tmp && tmp.empty ) { + count++; + tmp.empty.add( resolve ); + } + } + resolve(); + return defer.promise( obj ); + } +} ); +var pnum = ( /[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/ ).source; + +var rcssNum = new RegExp( "^(?:([+-])=|)(" + pnum + ")([a-z%]*)$", "i" ); + + +var cssExpand = [ "Top", "Right", "Bottom", "Left" ]; + +var isHiddenWithinTree = function( elem, el ) { + + // isHiddenWithinTree might be called from jQuery#filter function; + // in that case, element will be second argument + elem = el || elem; + + // Inline style trumps all + return elem.style.display === "none" || + elem.style.display === "" && + + // Otherwise, check computed style + // Support: Firefox <=43 - 45 + // Disconnected elements can have computed display: none, so first confirm that elem is + // in the document. + jQuery.contains( elem.ownerDocument, elem ) && + + jQuery.css( elem, "display" ) === "none"; + }; + +var swap = function( elem, options, callback, args ) { + var ret, name, + old = {}; + + // Remember the old values, and insert the new ones + for ( name in options ) { + old[ name ] = elem.style[ name ]; + elem.style[ name ] = options[ name ]; + } + + ret = callback.apply( elem, args || [] ); + + // Revert the old values + for ( name in options ) { + elem.style[ name ] = old[ name ]; + } + + return ret; +}; + + + + +function adjustCSS( elem, prop, valueParts, tween ) { + var adjusted, + scale = 1, + maxIterations = 20, + currentValue = tween ? + function() { + return tween.cur(); + } : + function() { + return jQuery.css( elem, prop, "" ); + }, + initial = currentValue(), + unit = valueParts && valueParts[ 3 ] || ( jQuery.cssNumber[ prop ] ? "" : "px" ), + + // Starting value computation is required for potential unit mismatches + initialInUnit = ( jQuery.cssNumber[ prop ] || unit !== "px" && +initial ) && + rcssNum.exec( jQuery.css( elem, prop ) ); + + if ( initialInUnit && initialInUnit[ 3 ] !== unit ) { + + // Trust units reported by jQuery.css + unit = unit || initialInUnit[ 3 ]; + + // Make sure we update the tween properties later on + valueParts = valueParts || []; + + // Iteratively approximate from a nonzero starting point + initialInUnit = +initial || 1; + + do { + + // If previous iteration zeroed out, double until we get *something*. + // Use string for doubling so we don't accidentally see scale as unchanged below + scale = scale || ".5"; + + // Adjust and apply + initialInUnit = initialInUnit / scale; + jQuery.style( elem, prop, initialInUnit + unit ); + + // Update scale, tolerating zero or NaN from tween.cur() + // Break the loop if scale is unchanged or perfect, or if we've just had enough. + } while ( + scale !== ( scale = currentValue() / initial ) && scale !== 1 && --maxIterations + ); + } + + if ( valueParts ) { + initialInUnit = +initialInUnit || +initial || 0; + + // Apply relative offset (+=/-=) if specified + adjusted = valueParts[ 1 ] ? + initialInUnit + ( valueParts[ 1 ] + 1 ) * valueParts[ 2 ] : + +valueParts[ 2 ]; + if ( tween ) { + tween.unit = unit; + tween.start = initialInUnit; + tween.end = adjusted; + } + } + return adjusted; +} + + +var defaultDisplayMap = {}; + +function getDefaultDisplay( elem ) { + var temp, + doc = elem.ownerDocument, + nodeName = elem.nodeName, + display = defaultDisplayMap[ nodeName ]; + + if ( display ) { + return display; + } + + temp = doc.body.appendChild( doc.createElement( nodeName ) ); + display = jQuery.css( temp, "display" ); + + temp.parentNode.removeChild( temp ); + + if ( display === "none" ) { + display = "block"; + } + defaultDisplayMap[ nodeName ] = display; + + return display; +} + +function showHide( elements, show ) { + var display, elem, + values = [], + index = 0, + length = elements.length; + + // Determine new display value for elements that need to change + for ( ; index < length; index++ ) { + elem = elements[ index ]; + if ( !elem.style ) { + continue; + } + + display = elem.style.display; + if ( show ) { + + // Since we force visibility upon cascade-hidden elements, an immediate (and slow) + // check is required in this first loop unless we have a nonempty display value (either + // inline or about-to-be-restored) + if ( display === "none" ) { + values[ index ] = dataPriv.get( elem, "display" ) || null; + if ( !values[ index ] ) { + elem.style.display = ""; + } + } + if ( elem.style.display === "" && isHiddenWithinTree( elem ) ) { + values[ index ] = getDefaultDisplay( elem ); + } + } else { + if ( display !== "none" ) { + values[ index ] = "none"; + + // Remember what we're overwriting + dataPriv.set( elem, "display", display ); + } + } + } + + // Set the display of the elements in a second loop to avoid constant reflow + for ( index = 0; index < length; index++ ) { + if ( values[ index ] != null ) { + elements[ index ].style.display = values[ index ]; + } + } + + return elements; +} + +jQuery.fn.extend( { + show: function() { + return showHide( this, true ); + }, + hide: function() { + return showHide( this ); + }, + toggle: function( state ) { + if ( typeof state === "boolean" ) { + return state ? this.show() : this.hide(); + } + + return this.each( function() { + if ( isHiddenWithinTree( this ) ) { + jQuery( this ).show(); + } else { + jQuery( this ).hide(); + } + } ); + } +} ); +var rcheckableType = ( /^(?:checkbox|radio)$/i ); + +var rtagName = ( /<([a-z][^\/\0>\x20\t\r\n\f]+)/i ); + +var rscriptType = ( /^$|\/(?:java|ecma)script/i ); + + + +// We have to close these tags to support XHTML (#13200) +var wrapMap = { + + // Support: IE <=9 only + option: [ 1, "" ], + + // XHTML parsers do not magically insert elements in the + // same way that tag soup parsers do. So we cannot shorten + // this by omitting or other required elements. + thead: [ 1, "", "
" ], + col: [ 2, "", "
" ], + tr: [ 2, "", "
" ], + td: [ 3, "", "
" ], + + _default: [ 0, "", "" ] +}; + +// Support: IE <=9 only +wrapMap.optgroup = wrapMap.option; + +wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead; +wrapMap.th = wrapMap.td; + + +function getAll( context, tag ) { + + // Support: IE <=9 - 11 only + // Use typeof to avoid zero-argument method invocation on host objects (#15151) + var ret; + + if ( typeof context.getElementsByTagName !== "undefined" ) { + ret = context.getElementsByTagName( tag || "*" ); + + } else if ( typeof context.querySelectorAll !== "undefined" ) { + ret = context.querySelectorAll( tag || "*" ); + + } else { + ret = []; + } + + if ( tag === undefined || tag && nodeName( context, tag ) ) { + return jQuery.merge( [ context ], ret ); + } + + return ret; +} + + +// Mark scripts as having already been evaluated +function setGlobalEval( elems, refElements ) { + var i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + dataPriv.set( + elems[ i ], + "globalEval", + !refElements || dataPriv.get( refElements[ i ], "globalEval" ) + ); + } +} + + +var rhtml = /<|&#?\w+;/; + +function buildFragment( elems, context, scripts, selection, ignored ) { + var elem, tmp, tag, wrap, contains, j, + fragment = context.createDocumentFragment(), + nodes = [], + i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + elem = elems[ i ]; + + if ( elem || elem === 0 ) { + + // Add nodes directly + if ( jQuery.type( elem ) === "object" ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, elem.nodeType ? [ elem ] : elem ); + + // Convert non-html into a text node + } else if ( !rhtml.test( elem ) ) { + nodes.push( context.createTextNode( elem ) ); + + // Convert html into DOM nodes + } else { + tmp = tmp || fragment.appendChild( context.createElement( "div" ) ); + + // Deserialize a standard representation + tag = ( rtagName.exec( elem ) || [ "", "" ] )[ 1 ].toLowerCase(); + wrap = wrapMap[ tag ] || wrapMap._default; + tmp.innerHTML = wrap[ 1 ] + jQuery.htmlPrefilter( elem ) + wrap[ 2 ]; + + // Descend through wrappers to the right content + j = wrap[ 0 ]; + while ( j-- ) { + tmp = tmp.lastChild; + } + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, tmp.childNodes ); + + // Remember the top-level container + tmp = fragment.firstChild; + + // Ensure the created nodes are orphaned (#12392) + tmp.textContent = ""; + } + } + } + + // Remove wrapper from fragment + fragment.textContent = ""; + + i = 0; + while ( ( elem = nodes[ i++ ] ) ) { + + // Skip elements already in the context collection (trac-4087) + if ( selection && jQuery.inArray( elem, selection ) > -1 ) { + if ( ignored ) { + ignored.push( elem ); + } + continue; + } + + contains = jQuery.contains( elem.ownerDocument, elem ); + + // Append to fragment + tmp = getAll( fragment.appendChild( elem ), "script" ); + + // Preserve script evaluation history + if ( contains ) { + setGlobalEval( tmp ); + } + + // Capture executables + if ( scripts ) { + j = 0; + while ( ( elem = tmp[ j++ ] ) ) { + if ( rscriptType.test( elem.type || "" ) ) { + scripts.push( elem ); + } + } + } + } + + return fragment; +} + + +( function() { + var fragment = document.createDocumentFragment(), + div = fragment.appendChild( document.createElement( "div" ) ), + input = document.createElement( "input" ); + + // Support: Android 4.0 - 4.3 only + // Check state lost if the name is set (#11217) + // Support: Windows Web Apps (WWA) + // `name` and `type` must use .setAttribute for WWA (#14901) + input.setAttribute( "type", "radio" ); + input.setAttribute( "checked", "checked" ); + input.setAttribute( "name", "t" ); + + div.appendChild( input ); + + // Support: Android <=4.1 only + // Older WebKit doesn't clone checked state correctly in fragments + support.checkClone = div.cloneNode( true ).cloneNode( true ).lastChild.checked; + + // Support: IE <=11 only + // Make sure textarea (and checkbox) defaultValue is properly cloned + div.innerHTML = ""; + support.noCloneChecked = !!div.cloneNode( true ).lastChild.defaultValue; +} )(); +var documentElement = document.documentElement; + + + +var + rkeyEvent = /^key/, + rmouseEvent = /^(?:mouse|pointer|contextmenu|drag|drop)|click/, + rtypenamespace = /^([^.]*)(?:\.(.+)|)/; + +function returnTrue() { + return true; +} + +function returnFalse() { + return false; +} + +// Support: IE <=9 only +// See #13393 for more info +function safeActiveElement() { + try { + return document.activeElement; + } catch ( err ) { } +} + +function on( elem, types, selector, data, fn, one ) { + var origFn, type; + + // Types can be a map of types/handlers + if ( typeof types === "object" ) { + + // ( types-Object, selector, data ) + if ( typeof selector !== "string" ) { + + // ( types-Object, data ) + data = data || selector; + selector = undefined; + } + for ( type in types ) { + on( elem, type, selector, data, types[ type ], one ); + } + return elem; + } + + if ( data == null && fn == null ) { + + // ( types, fn ) + fn = selector; + data = selector = undefined; + } else if ( fn == null ) { + if ( typeof selector === "string" ) { + + // ( types, selector, fn ) + fn = data; + data = undefined; + } else { + + // ( types, data, fn ) + fn = data; + data = selector; + selector = undefined; + } + } + if ( fn === false ) { + fn = returnFalse; + } else if ( !fn ) { + return elem; + } + + if ( one === 1 ) { + origFn = fn; + fn = function( event ) { + + // Can use an empty set, since event contains the info + jQuery().off( event ); + return origFn.apply( this, arguments ); + }; + + // Use same guid so caller can remove using origFn + fn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ ); + } + return elem.each( function() { + jQuery.event.add( this, types, fn, data, selector ); + } ); +} + +/* + * Helper functions for managing events -- not part of the public interface. + * Props to Dean Edwards' addEvent library for many of the ideas. + */ +jQuery.event = { + + global: {}, + + add: function( elem, types, handler, data, selector ) { + + var handleObjIn, eventHandle, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.get( elem ); + + // Don't attach events to noData or text/comment nodes (but allow plain objects) + if ( !elemData ) { + return; + } + + // Caller can pass in an object of custom data in lieu of the handler + if ( handler.handler ) { + handleObjIn = handler; + handler = handleObjIn.handler; + selector = handleObjIn.selector; + } + + // Ensure that invalid selectors throw exceptions at attach time + // Evaluate against documentElement in case elem is a non-element node (e.g., document) + if ( selector ) { + jQuery.find.matchesSelector( documentElement, selector ); + } + + // Make sure that the handler has a unique ID, used to find/remove it later + if ( !handler.guid ) { + handler.guid = jQuery.guid++; + } + + // Init the element's event structure and main handler, if this is the first + if ( !( events = elemData.events ) ) { + events = elemData.events = {}; + } + if ( !( eventHandle = elemData.handle ) ) { + eventHandle = elemData.handle = function( e ) { + + // Discard the second event of a jQuery.event.trigger() and + // when an event is called after a page has unloaded + return typeof jQuery !== "undefined" && jQuery.event.triggered !== e.type ? + jQuery.event.dispatch.apply( elem, arguments ) : undefined; + }; + } + + // Handle multiple events separated by a space + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // There *must* be a type, no attaching namespace-only handlers + if ( !type ) { + continue; + } + + // If event changes its type, use the special event handlers for the changed type + special = jQuery.event.special[ type ] || {}; + + // If selector defined, determine special event api type, otherwise given type + type = ( selector ? special.delegateType : special.bindType ) || type; + + // Update special based on newly reset type + special = jQuery.event.special[ type ] || {}; + + // handleObj is passed to all event handlers + handleObj = jQuery.extend( { + type: type, + origType: origType, + data: data, + handler: handler, + guid: handler.guid, + selector: selector, + needsContext: selector && jQuery.expr.match.needsContext.test( selector ), + namespace: namespaces.join( "." ) + }, handleObjIn ); + + // Init the event handler queue if we're the first + if ( !( handlers = events[ type ] ) ) { + handlers = events[ type ] = []; + handlers.delegateCount = 0; + + // Only use addEventListener if the special events handler returns false + if ( !special.setup || + special.setup.call( elem, data, namespaces, eventHandle ) === false ) { + + if ( elem.addEventListener ) { + elem.addEventListener( type, eventHandle ); + } + } + } + + if ( special.add ) { + special.add.call( elem, handleObj ); + + if ( !handleObj.handler.guid ) { + handleObj.handler.guid = handler.guid; + } + } + + // Add to the element's handler list, delegates in front + if ( selector ) { + handlers.splice( handlers.delegateCount++, 0, handleObj ); + } else { + handlers.push( handleObj ); + } + + // Keep track of which events have ever been used, for event optimization + jQuery.event.global[ type ] = true; + } + + }, + + // Detach an event or set of events from an element + remove: function( elem, types, handler, selector, mappedTypes ) { + + var j, origCount, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.hasData( elem ) && dataPriv.get( elem ); + + if ( !elemData || !( events = elemData.events ) ) { + return; + } + + // Once for each type.namespace in types; type may be omitted + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // Unbind all events (on this namespace, if provided) for the element + if ( !type ) { + for ( type in events ) { + jQuery.event.remove( elem, type + types[ t ], handler, selector, true ); + } + continue; + } + + special = jQuery.event.special[ type ] || {}; + type = ( selector ? special.delegateType : special.bindType ) || type; + handlers = events[ type ] || []; + tmp = tmp[ 2 ] && + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ); + + // Remove matching events + origCount = j = handlers.length; + while ( j-- ) { + handleObj = handlers[ j ]; + + if ( ( mappedTypes || origType === handleObj.origType ) && + ( !handler || handler.guid === handleObj.guid ) && + ( !tmp || tmp.test( handleObj.namespace ) ) && + ( !selector || selector === handleObj.selector || + selector === "**" && handleObj.selector ) ) { + handlers.splice( j, 1 ); + + if ( handleObj.selector ) { + handlers.delegateCount--; + } + if ( special.remove ) { + special.remove.call( elem, handleObj ); + } + } + } + + // Remove generic event handler if we removed something and no more handlers exist + // (avoids potential for endless recursion during removal of special event handlers) + if ( origCount && !handlers.length ) { + if ( !special.teardown || + special.teardown.call( elem, namespaces, elemData.handle ) === false ) { + + jQuery.removeEvent( elem, type, elemData.handle ); + } + + delete events[ type ]; + } + } + + // Remove data and the expando if it's no longer used + if ( jQuery.isEmptyObject( events ) ) { + dataPriv.remove( elem, "handle events" ); + } + }, + + dispatch: function( nativeEvent ) { + + // Make a writable jQuery.Event from the native event object + var event = jQuery.event.fix( nativeEvent ); + + var i, j, ret, matched, handleObj, handlerQueue, + args = new Array( arguments.length ), + handlers = ( dataPriv.get( this, "events" ) || {} )[ event.type ] || [], + special = jQuery.event.special[ event.type ] || {}; + + // Use the fix-ed jQuery.Event rather than the (read-only) native event + args[ 0 ] = event; + + for ( i = 1; i < arguments.length; i++ ) { + args[ i ] = arguments[ i ]; + } + + event.delegateTarget = this; + + // Call the preDispatch hook for the mapped type, and let it bail if desired + if ( special.preDispatch && special.preDispatch.call( this, event ) === false ) { + return; + } + + // Determine handlers + handlerQueue = jQuery.event.handlers.call( this, event, handlers ); + + // Run delegates first; they may want to stop propagation beneath us + i = 0; + while ( ( matched = handlerQueue[ i++ ] ) && !event.isPropagationStopped() ) { + event.currentTarget = matched.elem; + + j = 0; + while ( ( handleObj = matched.handlers[ j++ ] ) && + !event.isImmediatePropagationStopped() ) { + + // Triggered event must either 1) have no namespace, or 2) have namespace(s) + // a subset or equal to those in the bound event (both can have no namespace). + if ( !event.rnamespace || event.rnamespace.test( handleObj.namespace ) ) { + + event.handleObj = handleObj; + event.data = handleObj.data; + + ret = ( ( jQuery.event.special[ handleObj.origType ] || {} ).handle || + handleObj.handler ).apply( matched.elem, args ); + + if ( ret !== undefined ) { + if ( ( event.result = ret ) === false ) { + event.preventDefault(); + event.stopPropagation(); + } + } + } + } + } + + // Call the postDispatch hook for the mapped type + if ( special.postDispatch ) { + special.postDispatch.call( this, event ); + } + + return event.result; + }, + + handlers: function( event, handlers ) { + var i, handleObj, sel, matchedHandlers, matchedSelectors, + handlerQueue = [], + delegateCount = handlers.delegateCount, + cur = event.target; + + // Find delegate handlers + if ( delegateCount && + + // Support: IE <=9 + // Black-hole SVG instance trees (trac-13180) + cur.nodeType && + + // Support: Firefox <=42 + // Suppress spec-violating clicks indicating a non-primary pointer button (trac-3861) + // https://www.w3.org/TR/DOM-Level-3-Events/#event-type-click + // Support: IE 11 only + // ...but not arrow key "clicks" of radio inputs, which can have `button` -1 (gh-2343) + !( event.type === "click" && event.button >= 1 ) ) { + + for ( ; cur !== this; cur = cur.parentNode || this ) { + + // Don't check non-elements (#13208) + // Don't process clicks on disabled elements (#6911, #8165, #11382, #11764) + if ( cur.nodeType === 1 && !( event.type === "click" && cur.disabled === true ) ) { + matchedHandlers = []; + matchedSelectors = {}; + for ( i = 0; i < delegateCount; i++ ) { + handleObj = handlers[ i ]; + + // Don't conflict with Object.prototype properties (#13203) + sel = handleObj.selector + " "; + + if ( matchedSelectors[ sel ] === undefined ) { + matchedSelectors[ sel ] = handleObj.needsContext ? + jQuery( sel, this ).index( cur ) > -1 : + jQuery.find( sel, this, null, [ cur ] ).length; + } + if ( matchedSelectors[ sel ] ) { + matchedHandlers.push( handleObj ); + } + } + if ( matchedHandlers.length ) { + handlerQueue.push( { elem: cur, handlers: matchedHandlers } ); + } + } + } + } + + // Add the remaining (directly-bound) handlers + cur = this; + if ( delegateCount < handlers.length ) { + handlerQueue.push( { elem: cur, handlers: handlers.slice( delegateCount ) } ); + } + + return handlerQueue; + }, + + addProp: function( name, hook ) { + Object.defineProperty( jQuery.Event.prototype, name, { + enumerable: true, + configurable: true, + + get: jQuery.isFunction( hook ) ? + function() { + if ( this.originalEvent ) { + return hook( this.originalEvent ); + } + } : + function() { + if ( this.originalEvent ) { + return this.originalEvent[ name ]; + } + }, + + set: function( value ) { + Object.defineProperty( this, name, { + enumerable: true, + configurable: true, + writable: true, + value: value + } ); + } + } ); + }, + + fix: function( originalEvent ) { + return originalEvent[ jQuery.expando ] ? + originalEvent : + new jQuery.Event( originalEvent ); + }, + + special: { + load: { + + // Prevent triggered image.load events from bubbling to window.load + noBubble: true + }, + focus: { + + // Fire native event if possible so blur/focus sequence is correct + trigger: function() { + if ( this !== safeActiveElement() && this.focus ) { + this.focus(); + return false; + } + }, + delegateType: "focusin" + }, + blur: { + trigger: function() { + if ( this === safeActiveElement() && this.blur ) { + this.blur(); + return false; + } + }, + delegateType: "focusout" + }, + click: { + + // For checkbox, fire native event so checked state will be right + trigger: function() { + if ( this.type === "checkbox" && this.click && nodeName( this, "input" ) ) { + this.click(); + return false; + } + }, + + // For cross-browser consistency, don't fire native .click() on links + _default: function( event ) { + return nodeName( event.target, "a" ); + } + }, + + beforeunload: { + postDispatch: function( event ) { + + // Support: Firefox 20+ + // Firefox doesn't alert if the returnValue field is not set. + if ( event.result !== undefined && event.originalEvent ) { + event.originalEvent.returnValue = event.result; + } + } + } + } +}; + +jQuery.removeEvent = function( elem, type, handle ) { + + // This "if" is needed for plain objects + if ( elem.removeEventListener ) { + elem.removeEventListener( type, handle ); + } +}; + +jQuery.Event = function( src, props ) { + + // Allow instantiation without the 'new' keyword + if ( !( this instanceof jQuery.Event ) ) { + return new jQuery.Event( src, props ); + } + + // Event object + if ( src && src.type ) { + this.originalEvent = src; + this.type = src.type; + + // Events bubbling up the document may have been marked as prevented + // by a handler lower down the tree; reflect the correct value. + this.isDefaultPrevented = src.defaultPrevented || + src.defaultPrevented === undefined && + + // Support: Android <=2.3 only + src.returnValue === false ? + returnTrue : + returnFalse; + + // Create target properties + // Support: Safari <=6 - 7 only + // Target should not be a text node (#504, #13143) + this.target = ( src.target && src.target.nodeType === 3 ) ? + src.target.parentNode : + src.target; + + this.currentTarget = src.currentTarget; + this.relatedTarget = src.relatedTarget; + + // Event type + } else { + this.type = src; + } + + // Put explicitly provided properties onto the event object + if ( props ) { + jQuery.extend( this, props ); + } + + // Create a timestamp if incoming event doesn't have one + this.timeStamp = src && src.timeStamp || jQuery.now(); + + // Mark it as fixed + this[ jQuery.expando ] = true; +}; + +// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding +// https://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html +jQuery.Event.prototype = { + constructor: jQuery.Event, + isDefaultPrevented: returnFalse, + isPropagationStopped: returnFalse, + isImmediatePropagationStopped: returnFalse, + isSimulated: false, + + preventDefault: function() { + var e = this.originalEvent; + + this.isDefaultPrevented = returnTrue; + + if ( e && !this.isSimulated ) { + e.preventDefault(); + } + }, + stopPropagation: function() { + var e = this.originalEvent; + + this.isPropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopPropagation(); + } + }, + stopImmediatePropagation: function() { + var e = this.originalEvent; + + this.isImmediatePropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopImmediatePropagation(); + } + + this.stopPropagation(); + } +}; + +// Includes all common event props including KeyEvent and MouseEvent specific props +jQuery.each( { + altKey: true, + bubbles: true, + cancelable: true, + changedTouches: true, + ctrlKey: true, + detail: true, + eventPhase: true, + metaKey: true, + pageX: true, + pageY: true, + shiftKey: true, + view: true, + "char": true, + charCode: true, + key: true, + keyCode: true, + button: true, + buttons: true, + clientX: true, + clientY: true, + offsetX: true, + offsetY: true, + pointerId: true, + pointerType: true, + screenX: true, + screenY: true, + targetTouches: true, + toElement: true, + touches: true, + + which: function( event ) { + var button = event.button; + + // Add which for key events + if ( event.which == null && rkeyEvent.test( event.type ) ) { + return event.charCode != null ? event.charCode : event.keyCode; + } + + // Add which for click: 1 === left; 2 === middle; 3 === right + if ( !event.which && button !== undefined && rmouseEvent.test( event.type ) ) { + if ( button & 1 ) { + return 1; + } + + if ( button & 2 ) { + return 3; + } + + if ( button & 4 ) { + return 2; + } + + return 0; + } + + return event.which; + } +}, jQuery.event.addProp ); + +// Create mouseenter/leave events using mouseover/out and event-time checks +// so that event delegation works in jQuery. +// Do the same for pointerenter/pointerleave and pointerover/pointerout +// +// Support: Safari 7 only +// Safari sends mouseenter too often; see: +// https://bugs.chromium.org/p/chromium/issues/detail?id=470258 +// for the description of the bug (it existed in older Chrome versions as well). +jQuery.each( { + mouseenter: "mouseover", + mouseleave: "mouseout", + pointerenter: "pointerover", + pointerleave: "pointerout" +}, function( orig, fix ) { + jQuery.event.special[ orig ] = { + delegateType: fix, + bindType: fix, + + handle: function( event ) { + var ret, + target = this, + related = event.relatedTarget, + handleObj = event.handleObj; + + // For mouseenter/leave call the handler if related is outside the target. + // NB: No relatedTarget if the mouse left/entered the browser window + if ( !related || ( related !== target && !jQuery.contains( target, related ) ) ) { + event.type = handleObj.origType; + ret = handleObj.handler.apply( this, arguments ); + event.type = fix; + } + return ret; + } + }; +} ); + +jQuery.fn.extend( { + + on: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn ); + }, + one: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn, 1 ); + }, + off: function( types, selector, fn ) { + var handleObj, type; + if ( types && types.preventDefault && types.handleObj ) { + + // ( event ) dispatched jQuery.Event + handleObj = types.handleObj; + jQuery( types.delegateTarget ).off( + handleObj.namespace ? + handleObj.origType + "." + handleObj.namespace : + handleObj.origType, + handleObj.selector, + handleObj.handler + ); + return this; + } + if ( typeof types === "object" ) { + + // ( types-object [, selector] ) + for ( type in types ) { + this.off( type, selector, types[ type ] ); + } + return this; + } + if ( selector === false || typeof selector === "function" ) { + + // ( types [, fn] ) + fn = selector; + selector = undefined; + } + if ( fn === false ) { + fn = returnFalse; + } + return this.each( function() { + jQuery.event.remove( this, types, fn, selector ); + } ); + } +} ); + + +var + + /* eslint-disable max-len */ + + // See https://github.com/eslint/eslint/issues/3229 + rxhtmlTag = /<(?!area|br|col|embed|hr|img|input|link|meta|param)(([a-z][^\/\0>\x20\t\r\n\f]*)[^>]*)\/>/gi, + + /* eslint-enable */ + + // Support: IE <=10 - 11, Edge 12 - 13 + // In IE/Edge using regex groups here causes severe slowdowns. + // See https://connect.microsoft.com/IE/feedback/details/1736512/ + rnoInnerhtml = /\s*$/g; + +// Prefer a tbody over its parent table for containing new rows +function manipulationTarget( elem, content ) { + if ( nodeName( elem, "table" ) && + nodeName( content.nodeType !== 11 ? content : content.firstChild, "tr" ) ) { + + return jQuery( ">tbody", elem )[ 0 ] || elem; + } + + return elem; +} + +// Replace/restore the type attribute of script elements for safe DOM manipulation +function disableScript( elem ) { + elem.type = ( elem.getAttribute( "type" ) !== null ) + "/" + elem.type; + return elem; +} +function restoreScript( elem ) { + var match = rscriptTypeMasked.exec( elem.type ); + + if ( match ) { + elem.type = match[ 1 ]; + } else { + elem.removeAttribute( "type" ); + } + + return elem; +} + +function cloneCopyEvent( src, dest ) { + var i, l, type, pdataOld, pdataCur, udataOld, udataCur, events; + + if ( dest.nodeType !== 1 ) { + return; + } + + // 1. Copy private data: events, handlers, etc. + if ( dataPriv.hasData( src ) ) { + pdataOld = dataPriv.access( src ); + pdataCur = dataPriv.set( dest, pdataOld ); + events = pdataOld.events; + + if ( events ) { + delete pdataCur.handle; + pdataCur.events = {}; + + for ( type in events ) { + for ( i = 0, l = events[ type ].length; i < l; i++ ) { + jQuery.event.add( dest, type, events[ type ][ i ] ); + } + } + } + } + + // 2. Copy user data + if ( dataUser.hasData( src ) ) { + udataOld = dataUser.access( src ); + udataCur = jQuery.extend( {}, udataOld ); + + dataUser.set( dest, udataCur ); + } +} + +// Fix IE bugs, see support tests +function fixInput( src, dest ) { + var nodeName = dest.nodeName.toLowerCase(); + + // Fails to persist the checked state of a cloned checkbox or radio button. + if ( nodeName === "input" && rcheckableType.test( src.type ) ) { + dest.checked = src.checked; + + // Fails to return the selected option to the default selected state when cloning options + } else if ( nodeName === "input" || nodeName === "textarea" ) { + dest.defaultValue = src.defaultValue; + } +} + +function domManip( collection, args, callback, ignored ) { + + // Flatten any nested arrays + args = concat.apply( [], args ); + + var fragment, first, scripts, hasScripts, node, doc, + i = 0, + l = collection.length, + iNoClone = l - 1, + value = args[ 0 ], + isFunction = jQuery.isFunction( value ); + + // We can't cloneNode fragments that contain checked, in WebKit + if ( isFunction || + ( l > 1 && typeof value === "string" && + !support.checkClone && rchecked.test( value ) ) ) { + return collection.each( function( index ) { + var self = collection.eq( index ); + if ( isFunction ) { + args[ 0 ] = value.call( this, index, self.html() ); + } + domManip( self, args, callback, ignored ); + } ); + } + + if ( l ) { + fragment = buildFragment( args, collection[ 0 ].ownerDocument, false, collection, ignored ); + first = fragment.firstChild; + + if ( fragment.childNodes.length === 1 ) { + fragment = first; + } + + // Require either new content or an interest in ignored elements to invoke the callback + if ( first || ignored ) { + scripts = jQuery.map( getAll( fragment, "script" ), disableScript ); + hasScripts = scripts.length; + + // Use the original fragment for the last item + // instead of the first because it can end up + // being emptied incorrectly in certain situations (#8070). + for ( ; i < l; i++ ) { + node = fragment; + + if ( i !== iNoClone ) { + node = jQuery.clone( node, true, true ); + + // Keep references to cloned scripts for later restoration + if ( hasScripts ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( scripts, getAll( node, "script" ) ); + } + } + + callback.call( collection[ i ], node, i ); + } + + if ( hasScripts ) { + doc = scripts[ scripts.length - 1 ].ownerDocument; + + // Reenable scripts + jQuery.map( scripts, restoreScript ); + + // Evaluate executable scripts on first document insertion + for ( i = 0; i < hasScripts; i++ ) { + node = scripts[ i ]; + if ( rscriptType.test( node.type || "" ) && + !dataPriv.access( node, "globalEval" ) && + jQuery.contains( doc, node ) ) { + + if ( node.src ) { + + // Optional AJAX dependency, but won't run scripts if not present + if ( jQuery._evalUrl ) { + jQuery._evalUrl( node.src ); + } + } else { + DOMEval( node.textContent.replace( rcleanScript, "" ), doc ); + } + } + } + } + } + } + + return collection; +} + +function remove( elem, selector, keepData ) { + var node, + nodes = selector ? jQuery.filter( selector, elem ) : elem, + i = 0; + + for ( ; ( node = nodes[ i ] ) != null; i++ ) { + if ( !keepData && node.nodeType === 1 ) { + jQuery.cleanData( getAll( node ) ); + } + + if ( node.parentNode ) { + if ( keepData && jQuery.contains( node.ownerDocument, node ) ) { + setGlobalEval( getAll( node, "script" ) ); + } + node.parentNode.removeChild( node ); + } + } + + return elem; +} + +jQuery.extend( { + htmlPrefilter: function( html ) { + return html.replace( rxhtmlTag, "<$1>" ); + }, + + clone: function( elem, dataAndEvents, deepDataAndEvents ) { + var i, l, srcElements, destElements, + clone = elem.cloneNode( true ), + inPage = jQuery.contains( elem.ownerDocument, elem ); + + // Fix IE cloning issues + if ( !support.noCloneChecked && ( elem.nodeType === 1 || elem.nodeType === 11 ) && + !jQuery.isXMLDoc( elem ) ) { + + // We eschew Sizzle here for performance reasons: https://jsperf.com/getall-vs-sizzle/2 + destElements = getAll( clone ); + srcElements = getAll( elem ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + fixInput( srcElements[ i ], destElements[ i ] ); + } + } + + // Copy the events from the original to the clone + if ( dataAndEvents ) { + if ( deepDataAndEvents ) { + srcElements = srcElements || getAll( elem ); + destElements = destElements || getAll( clone ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + cloneCopyEvent( srcElements[ i ], destElements[ i ] ); + } + } else { + cloneCopyEvent( elem, clone ); + } + } + + // Preserve script evaluation history + destElements = getAll( clone, "script" ); + if ( destElements.length > 0 ) { + setGlobalEval( destElements, !inPage && getAll( elem, "script" ) ); + } + + // Return the cloned set + return clone; + }, + + cleanData: function( elems ) { + var data, elem, type, + special = jQuery.event.special, + i = 0; + + for ( ; ( elem = elems[ i ] ) !== undefined; i++ ) { + if ( acceptData( elem ) ) { + if ( ( data = elem[ dataPriv.expando ] ) ) { + if ( data.events ) { + for ( type in data.events ) { + if ( special[ type ] ) { + jQuery.event.remove( elem, type ); + + // This is a shortcut to avoid jQuery.event.remove's overhead + } else { + jQuery.removeEvent( elem, type, data.handle ); + } + } + } + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataPriv.expando ] = undefined; + } + if ( elem[ dataUser.expando ] ) { + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataUser.expando ] = undefined; + } + } + } + } +} ); + +jQuery.fn.extend( { + detach: function( selector ) { + return remove( this, selector, true ); + }, + + remove: function( selector ) { + return remove( this, selector ); + }, + + text: function( value ) { + return access( this, function( value ) { + return value === undefined ? + jQuery.text( this ) : + this.empty().each( function() { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + this.textContent = value; + } + } ); + }, null, value, arguments.length ); + }, + + append: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.appendChild( elem ); + } + } ); + }, + + prepend: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.insertBefore( elem, target.firstChild ); + } + } ); + }, + + before: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this ); + } + } ); + }, + + after: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this.nextSibling ); + } + } ); + }, + + empty: function() { + var elem, + i = 0; + + for ( ; ( elem = this[ i ] ) != null; i++ ) { + if ( elem.nodeType === 1 ) { + + // Prevent memory leaks + jQuery.cleanData( getAll( elem, false ) ); + + // Remove any remaining nodes + elem.textContent = ""; + } + } + + return this; + }, + + clone: function( dataAndEvents, deepDataAndEvents ) { + dataAndEvents = dataAndEvents == null ? false : dataAndEvents; + deepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents; + + return this.map( function() { + return jQuery.clone( this, dataAndEvents, deepDataAndEvents ); + } ); + }, + + html: function( value ) { + return access( this, function( value ) { + var elem = this[ 0 ] || {}, + i = 0, + l = this.length; + + if ( value === undefined && elem.nodeType === 1 ) { + return elem.innerHTML; + } + + // See if we can take a shortcut and just use innerHTML + if ( typeof value === "string" && !rnoInnerhtml.test( value ) && + !wrapMap[ ( rtagName.exec( value ) || [ "", "" ] )[ 1 ].toLowerCase() ] ) { + + value = jQuery.htmlPrefilter( value ); + + try { + for ( ; i < l; i++ ) { + elem = this[ i ] || {}; + + // Remove element nodes and prevent memory leaks + if ( elem.nodeType === 1 ) { + jQuery.cleanData( getAll( elem, false ) ); + elem.innerHTML = value; + } + } + + elem = 0; + + // If using innerHTML throws an exception, use the fallback method + } catch ( e ) {} + } + + if ( elem ) { + this.empty().append( value ); + } + }, null, value, arguments.length ); + }, + + replaceWith: function() { + var ignored = []; + + // Make the changes, replacing each non-ignored context element with the new content + return domManip( this, arguments, function( elem ) { + var parent = this.parentNode; + + if ( jQuery.inArray( this, ignored ) < 0 ) { + jQuery.cleanData( getAll( this ) ); + if ( parent ) { + parent.replaceChild( elem, this ); + } + } + + // Force callback invocation + }, ignored ); + } +} ); + +jQuery.each( { + appendTo: "append", + prependTo: "prepend", + insertBefore: "before", + insertAfter: "after", + replaceAll: "replaceWith" +}, function( name, original ) { + jQuery.fn[ name ] = function( selector ) { + var elems, + ret = [], + insert = jQuery( selector ), + last = insert.length - 1, + i = 0; + + for ( ; i <= last; i++ ) { + elems = i === last ? this : this.clone( true ); + jQuery( insert[ i ] )[ original ]( elems ); + + // Support: Android <=4.0 only, PhantomJS 1 only + // .get() because push.apply(_, arraylike) throws on ancient WebKit + push.apply( ret, elems.get() ); + } + + return this.pushStack( ret ); + }; +} ); +var rmargin = ( /^margin/ ); + +var rnumnonpx = new RegExp( "^(" + pnum + ")(?!px)[a-z%]+$", "i" ); + +var getStyles = function( elem ) { + + // Support: IE <=11 only, Firefox <=30 (#15098, #14150) + // IE throws on elements created in popups + // FF meanwhile throws on frame elements through "defaultView.getComputedStyle" + var view = elem.ownerDocument.defaultView; + + if ( !view || !view.opener ) { + view = window; + } + + return view.getComputedStyle( elem ); + }; + + + +( function() { + + // Executing both pixelPosition & boxSizingReliable tests require only one layout + // so they're executed at the same time to save the second computation. + function computeStyleTests() { + + // This is a singleton, we need to execute it only once + if ( !div ) { + return; + } + + div.style.cssText = + "box-sizing:border-box;" + + "position:relative;display:block;" + + "margin:auto;border:1px;padding:1px;" + + "top:1%;width:50%"; + div.innerHTML = ""; + documentElement.appendChild( container ); + + var divStyle = window.getComputedStyle( div ); + pixelPositionVal = divStyle.top !== "1%"; + + // Support: Android 4.0 - 4.3 only, Firefox <=3 - 44 + reliableMarginLeftVal = divStyle.marginLeft === "2px"; + boxSizingReliableVal = divStyle.width === "4px"; + + // Support: Android 4.0 - 4.3 only + // Some styles come back with percentage values, even though they shouldn't + div.style.marginRight = "50%"; + pixelMarginRightVal = divStyle.marginRight === "4px"; + + documentElement.removeChild( container ); + + // Nullify the div so it wouldn't be stored in the memory and + // it will also be a sign that checks already performed + div = null; + } + + var pixelPositionVal, boxSizingReliableVal, pixelMarginRightVal, reliableMarginLeftVal, + container = document.createElement( "div" ), + div = document.createElement( "div" ); + + // Finish early in limited (non-browser) environments + if ( !div.style ) { + return; + } + + // Support: IE <=9 - 11 only + // Style of cloned element affects source element cloned (#8908) + div.style.backgroundClip = "content-box"; + div.cloneNode( true ).style.backgroundClip = ""; + support.clearCloneStyle = div.style.backgroundClip === "content-box"; + + container.style.cssText = "border:0;width:8px;height:0;top:0;left:-9999px;" + + "padding:0;margin-top:1px;position:absolute"; + container.appendChild( div ); + + jQuery.extend( support, { + pixelPosition: function() { + computeStyleTests(); + return pixelPositionVal; + }, + boxSizingReliable: function() { + computeStyleTests(); + return boxSizingReliableVal; + }, + pixelMarginRight: function() { + computeStyleTests(); + return pixelMarginRightVal; + }, + reliableMarginLeft: function() { + computeStyleTests(); + return reliableMarginLeftVal; + } + } ); +} )(); + + +function curCSS( elem, name, computed ) { + var width, minWidth, maxWidth, ret, + + // Support: Firefox 51+ + // Retrieving style before computed somehow + // fixes an issue with getting wrong values + // on detached elements + style = elem.style; + + computed = computed || getStyles( elem ); + + // getPropertyValue is needed for: + // .css('filter') (IE 9 only, #12537) + // .css('--customProperty) (#3144) + if ( computed ) { + ret = computed.getPropertyValue( name ) || computed[ name ]; + + if ( ret === "" && !jQuery.contains( elem.ownerDocument, elem ) ) { + ret = jQuery.style( elem, name ); + } + + // A tribute to the "awesome hack by Dean Edwards" + // Android Browser returns percentage for some values, + // but width seems to be reliably pixels. + // This is against the CSSOM draft spec: + // https://drafts.csswg.org/cssom/#resolved-values + if ( !support.pixelMarginRight() && rnumnonpx.test( ret ) && rmargin.test( name ) ) { + + // Remember the original values + width = style.width; + minWidth = style.minWidth; + maxWidth = style.maxWidth; + + // Put in the new values to get a computed value out + style.minWidth = style.maxWidth = style.width = ret; + ret = computed.width; + + // Revert the changed values + style.width = width; + style.minWidth = minWidth; + style.maxWidth = maxWidth; + } + } + + return ret !== undefined ? + + // Support: IE <=9 - 11 only + // IE returns zIndex value as an integer. + ret + "" : + ret; +} + + +function addGetHookIf( conditionFn, hookFn ) { + + // Define the hook, we'll check on the first run if it's really needed. + return { + get: function() { + if ( conditionFn() ) { + + // Hook not needed (or it's not possible to use it due + // to missing dependency), remove it. + delete this.get; + return; + } + + // Hook needed; redefine it so that the support test is not executed again. + return ( this.get = hookFn ).apply( this, arguments ); + } + }; +} + + +var + + // Swappable if display is none or starts with table + // except "table", "table-cell", or "table-caption" + // See here for display values: https://developer.mozilla.org/en-US/docs/CSS/display + rdisplayswap = /^(none|table(?!-c[ea]).+)/, + rcustomProp = /^--/, + cssShow = { position: "absolute", visibility: "hidden", display: "block" }, + cssNormalTransform = { + letterSpacing: "0", + fontWeight: "400" + }, + + cssPrefixes = [ "Webkit", "Moz", "ms" ], + emptyStyle = document.createElement( "div" ).style; + +// Return a css property mapped to a potentially vendor prefixed property +function vendorPropName( name ) { + + // Shortcut for names that are not vendor prefixed + if ( name in emptyStyle ) { + return name; + } + + // Check for vendor prefixed names + var capName = name[ 0 ].toUpperCase() + name.slice( 1 ), + i = cssPrefixes.length; + + while ( i-- ) { + name = cssPrefixes[ i ] + capName; + if ( name in emptyStyle ) { + return name; + } + } +} + +// Return a property mapped along what jQuery.cssProps suggests or to +// a vendor prefixed property. +function finalPropName( name ) { + var ret = jQuery.cssProps[ name ]; + if ( !ret ) { + ret = jQuery.cssProps[ name ] = vendorPropName( name ) || name; + } + return ret; +} + +function setPositiveNumber( elem, value, subtract ) { + + // Any relative (+/-) values have already been + // normalized at this point + var matches = rcssNum.exec( value ); + return matches ? + + // Guard against undefined "subtract", e.g., when used as in cssHooks + Math.max( 0, matches[ 2 ] - ( subtract || 0 ) ) + ( matches[ 3 ] || "px" ) : + value; +} + +function augmentWidthOrHeight( elem, name, extra, isBorderBox, styles ) { + var i, + val = 0; + + // If we already have the right measurement, avoid augmentation + if ( extra === ( isBorderBox ? "border" : "content" ) ) { + i = 4; + + // Otherwise initialize for horizontal or vertical properties + } else { + i = name === "width" ? 1 : 0; + } + + for ( ; i < 4; i += 2 ) { + + // Both box models exclude margin, so add it if we want it + if ( extra === "margin" ) { + val += jQuery.css( elem, extra + cssExpand[ i ], true, styles ); + } + + if ( isBorderBox ) { + + // border-box includes padding, so remove it if we want content + if ( extra === "content" ) { + val -= jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + } + + // At this point, extra isn't border nor margin, so remove border + if ( extra !== "margin" ) { + val -= jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + } else { + + // At this point, extra isn't content, so add padding + val += jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + + // At this point, extra isn't content nor padding, so add border + if ( extra !== "padding" ) { + val += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + } + } + + return val; +} + +function getWidthOrHeight( elem, name, extra ) { + + // Start with computed style + var valueIsBorderBox, + styles = getStyles( elem ), + val = curCSS( elem, name, styles ), + isBorderBox = jQuery.css( elem, "boxSizing", false, styles ) === "border-box"; + + // Computed unit is not pixels. Stop here and return. + if ( rnumnonpx.test( val ) ) { + return val; + } + + // Check for style in case a browser which returns unreliable values + // for getComputedStyle silently falls back to the reliable elem.style + valueIsBorderBox = isBorderBox && + ( support.boxSizingReliable() || val === elem.style[ name ] ); + + // Fall back to offsetWidth/Height when value is "auto" + // This happens for inline elements with no explicit setting (gh-3571) + if ( val === "auto" ) { + val = elem[ "offset" + name[ 0 ].toUpperCase() + name.slice( 1 ) ]; + } + + // Normalize "", auto, and prepare for extra + val = parseFloat( val ) || 0; + + // Use the active box-sizing model to add/subtract irrelevant styles + return ( val + + augmentWidthOrHeight( + elem, + name, + extra || ( isBorderBox ? "border" : "content" ), + valueIsBorderBox, + styles + ) + ) + "px"; +} + +jQuery.extend( { + + // Add in style property hooks for overriding the default + // behavior of getting and setting a style property + cssHooks: { + opacity: { + get: function( elem, computed ) { + if ( computed ) { + + // We should always get a number back from opacity + var ret = curCSS( elem, "opacity" ); + return ret === "" ? "1" : ret; + } + } + } + }, + + // Don't automatically add "px" to these possibly-unitless properties + cssNumber: { + "animationIterationCount": true, + "columnCount": true, + "fillOpacity": true, + "flexGrow": true, + "flexShrink": true, + "fontWeight": true, + "lineHeight": true, + "opacity": true, + "order": true, + "orphans": true, + "widows": true, + "zIndex": true, + "zoom": true + }, + + // Add in properties whose names you wish to fix before + // setting or getting the value + cssProps: { + "float": "cssFloat" + }, + + // Get and set the style property on a DOM Node + style: function( elem, name, value, extra ) { + + // Don't set styles on text and comment nodes + if ( !elem || elem.nodeType === 3 || elem.nodeType === 8 || !elem.style ) { + return; + } + + // Make sure that we're working with the right name + var ret, type, hooks, + origName = jQuery.camelCase( name ), + isCustomProp = rcustomProp.test( name ), + style = elem.style; + + // Make sure that we're working with the right name. We don't + // want to query the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Gets hook for the prefixed version, then unprefixed version + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // Check if we're setting a value + if ( value !== undefined ) { + type = typeof value; + + // Convert "+=" or "-=" to relative numbers (#7345) + if ( type === "string" && ( ret = rcssNum.exec( value ) ) && ret[ 1 ] ) { + value = adjustCSS( elem, name, ret ); + + // Fixes bug #9237 + type = "number"; + } + + // Make sure that null and NaN values aren't set (#7116) + if ( value == null || value !== value ) { + return; + } + + // If a number was passed in, add the unit (except for certain CSS properties) + if ( type === "number" ) { + value += ret && ret[ 3 ] || ( jQuery.cssNumber[ origName ] ? "" : "px" ); + } + + // background-* props affect original clone's values + if ( !support.clearCloneStyle && value === "" && name.indexOf( "background" ) === 0 ) { + style[ name ] = "inherit"; + } + + // If a hook was provided, use that value, otherwise just set the specified value + if ( !hooks || !( "set" in hooks ) || + ( value = hooks.set( elem, value, extra ) ) !== undefined ) { + + if ( isCustomProp ) { + style.setProperty( name, value ); + } else { + style[ name ] = value; + } + } + + } else { + + // If a hook was provided get the non-computed value from there + if ( hooks && "get" in hooks && + ( ret = hooks.get( elem, false, extra ) ) !== undefined ) { + + return ret; + } + + // Otherwise just get the value from the style object + return style[ name ]; + } + }, + + css: function( elem, name, extra, styles ) { + var val, num, hooks, + origName = jQuery.camelCase( name ), + isCustomProp = rcustomProp.test( name ); + + // Make sure that we're working with the right name. We don't + // want to modify the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Try prefixed name followed by the unprefixed name + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // If a hook was provided get the computed value from there + if ( hooks && "get" in hooks ) { + val = hooks.get( elem, true, extra ); + } + + // Otherwise, if a way to get the computed value exists, use that + if ( val === undefined ) { + val = curCSS( elem, name, styles ); + } + + // Convert "normal" to computed value + if ( val === "normal" && name in cssNormalTransform ) { + val = cssNormalTransform[ name ]; + } + + // Make numeric if forced or a qualifier was provided and val looks numeric + if ( extra === "" || extra ) { + num = parseFloat( val ); + return extra === true || isFinite( num ) ? num || 0 : val; + } + + return val; + } +} ); + +jQuery.each( [ "height", "width" ], function( i, name ) { + jQuery.cssHooks[ name ] = { + get: function( elem, computed, extra ) { + if ( computed ) { + + // Certain elements can have dimension info if we invisibly show them + // but it must have a current display style that would benefit + return rdisplayswap.test( jQuery.css( elem, "display" ) ) && + + // Support: Safari 8+ + // Table columns in Safari have non-zero offsetWidth & zero + // getBoundingClientRect().width unless display is changed. + // Support: IE <=11 only + // Running getBoundingClientRect on a disconnected node + // in IE throws an error. + ( !elem.getClientRects().length || !elem.getBoundingClientRect().width ) ? + swap( elem, cssShow, function() { + return getWidthOrHeight( elem, name, extra ); + } ) : + getWidthOrHeight( elem, name, extra ); + } + }, + + set: function( elem, value, extra ) { + var matches, + styles = extra && getStyles( elem ), + subtract = extra && augmentWidthOrHeight( + elem, + name, + extra, + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + styles + ); + + // Convert to pixels if value adjustment is needed + if ( subtract && ( matches = rcssNum.exec( value ) ) && + ( matches[ 3 ] || "px" ) !== "px" ) { + + elem.style[ name ] = value; + value = jQuery.css( elem, name ); + } + + return setPositiveNumber( elem, value, subtract ); + } + }; +} ); + +jQuery.cssHooks.marginLeft = addGetHookIf( support.reliableMarginLeft, + function( elem, computed ) { + if ( computed ) { + return ( parseFloat( curCSS( elem, "marginLeft" ) ) || + elem.getBoundingClientRect().left - + swap( elem, { marginLeft: 0 }, function() { + return elem.getBoundingClientRect().left; + } ) + ) + "px"; + } + } +); + +// These hooks are used by animate to expand properties +jQuery.each( { + margin: "", + padding: "", + border: "Width" +}, function( prefix, suffix ) { + jQuery.cssHooks[ prefix + suffix ] = { + expand: function( value ) { + var i = 0, + expanded = {}, + + // Assumes a single number if not a string + parts = typeof value === "string" ? value.split( " " ) : [ value ]; + + for ( ; i < 4; i++ ) { + expanded[ prefix + cssExpand[ i ] + suffix ] = + parts[ i ] || parts[ i - 2 ] || parts[ 0 ]; + } + + return expanded; + } + }; + + if ( !rmargin.test( prefix ) ) { + jQuery.cssHooks[ prefix + suffix ].set = setPositiveNumber; + } +} ); + +jQuery.fn.extend( { + css: function( name, value ) { + return access( this, function( elem, name, value ) { + var styles, len, + map = {}, + i = 0; + + if ( Array.isArray( name ) ) { + styles = getStyles( elem ); + len = name.length; + + for ( ; i < len; i++ ) { + map[ name[ i ] ] = jQuery.css( elem, name[ i ], false, styles ); + } + + return map; + } + + return value !== undefined ? + jQuery.style( elem, name, value ) : + jQuery.css( elem, name ); + }, name, value, arguments.length > 1 ); + } +} ); + + +function Tween( elem, options, prop, end, easing ) { + return new Tween.prototype.init( elem, options, prop, end, easing ); +} +jQuery.Tween = Tween; + +Tween.prototype = { + constructor: Tween, + init: function( elem, options, prop, end, easing, unit ) { + this.elem = elem; + this.prop = prop; + this.easing = easing || jQuery.easing._default; + this.options = options; + this.start = this.now = this.cur(); + this.end = end; + this.unit = unit || ( jQuery.cssNumber[ prop ] ? "" : "px" ); + }, + cur: function() { + var hooks = Tween.propHooks[ this.prop ]; + + return hooks && hooks.get ? + hooks.get( this ) : + Tween.propHooks._default.get( this ); + }, + run: function( percent ) { + var eased, + hooks = Tween.propHooks[ this.prop ]; + + if ( this.options.duration ) { + this.pos = eased = jQuery.easing[ this.easing ]( + percent, this.options.duration * percent, 0, 1, this.options.duration + ); + } else { + this.pos = eased = percent; + } + this.now = ( this.end - this.start ) * eased + this.start; + + if ( this.options.step ) { + this.options.step.call( this.elem, this.now, this ); + } + + if ( hooks && hooks.set ) { + hooks.set( this ); + } else { + Tween.propHooks._default.set( this ); + } + return this; + } +}; + +Tween.prototype.init.prototype = Tween.prototype; + +Tween.propHooks = { + _default: { + get: function( tween ) { + var result; + + // Use a property on the element directly when it is not a DOM element, + // or when there is no matching style property that exists. + if ( tween.elem.nodeType !== 1 || + tween.elem[ tween.prop ] != null && tween.elem.style[ tween.prop ] == null ) { + return tween.elem[ tween.prop ]; + } + + // Passing an empty string as a 3rd parameter to .css will automatically + // attempt a parseFloat and fallback to a string if the parse fails. + // Simple values such as "10px" are parsed to Float; + // complex values such as "rotate(1rad)" are returned as-is. + result = jQuery.css( tween.elem, tween.prop, "" ); + + // Empty strings, null, undefined and "auto" are converted to 0. + return !result || result === "auto" ? 0 : result; + }, + set: function( tween ) { + + // Use step hook for back compat. + // Use cssHook if its there. + // Use .style if available and use plain properties where available. + if ( jQuery.fx.step[ tween.prop ] ) { + jQuery.fx.step[ tween.prop ]( tween ); + } else if ( tween.elem.nodeType === 1 && + ( tween.elem.style[ jQuery.cssProps[ tween.prop ] ] != null || + jQuery.cssHooks[ tween.prop ] ) ) { + jQuery.style( tween.elem, tween.prop, tween.now + tween.unit ); + } else { + tween.elem[ tween.prop ] = tween.now; + } + } + } +}; + +// Support: IE <=9 only +// Panic based approach to setting things on disconnected nodes +Tween.propHooks.scrollTop = Tween.propHooks.scrollLeft = { + set: function( tween ) { + if ( tween.elem.nodeType && tween.elem.parentNode ) { + tween.elem[ tween.prop ] = tween.now; + } + } +}; + +jQuery.easing = { + linear: function( p ) { + return p; + }, + swing: function( p ) { + return 0.5 - Math.cos( p * Math.PI ) / 2; + }, + _default: "swing" +}; + +jQuery.fx = Tween.prototype.init; + +// Back compat <1.8 extension point +jQuery.fx.step = {}; + + + + +var + fxNow, inProgress, + rfxtypes = /^(?:toggle|show|hide)$/, + rrun = /queueHooks$/; + +function schedule() { + if ( inProgress ) { + if ( document.hidden === false && window.requestAnimationFrame ) { + window.requestAnimationFrame( schedule ); + } else { + window.setTimeout( schedule, jQuery.fx.interval ); + } + + jQuery.fx.tick(); + } +} + +// Animations created synchronously will run synchronously +function createFxNow() { + window.setTimeout( function() { + fxNow = undefined; + } ); + return ( fxNow = jQuery.now() ); +} + +// Generate parameters to create a standard animation +function genFx( type, includeWidth ) { + var which, + i = 0, + attrs = { height: type }; + + // If we include width, step value is 1 to do all cssExpand values, + // otherwise step value is 2 to skip over Left and Right + includeWidth = includeWidth ? 1 : 0; + for ( ; i < 4; i += 2 - includeWidth ) { + which = cssExpand[ i ]; + attrs[ "margin" + which ] = attrs[ "padding" + which ] = type; + } + + if ( includeWidth ) { + attrs.opacity = attrs.width = type; + } + + return attrs; +} + +function createTween( value, prop, animation ) { + var tween, + collection = ( Animation.tweeners[ prop ] || [] ).concat( Animation.tweeners[ "*" ] ), + index = 0, + length = collection.length; + for ( ; index < length; index++ ) { + if ( ( tween = collection[ index ].call( animation, prop, value ) ) ) { + + // We're done with this property + return tween; + } + } +} + +function defaultPrefilter( elem, props, opts ) { + var prop, value, toggle, hooks, oldfire, propTween, restoreDisplay, display, + isBox = "width" in props || "height" in props, + anim = this, + orig = {}, + style = elem.style, + hidden = elem.nodeType && isHiddenWithinTree( elem ), + dataShow = dataPriv.get( elem, "fxshow" ); + + // Queue-skipping animations hijack the fx hooks + if ( !opts.queue ) { + hooks = jQuery._queueHooks( elem, "fx" ); + if ( hooks.unqueued == null ) { + hooks.unqueued = 0; + oldfire = hooks.empty.fire; + hooks.empty.fire = function() { + if ( !hooks.unqueued ) { + oldfire(); + } + }; + } + hooks.unqueued++; + + anim.always( function() { + + // Ensure the complete handler is called before this completes + anim.always( function() { + hooks.unqueued--; + if ( !jQuery.queue( elem, "fx" ).length ) { + hooks.empty.fire(); + } + } ); + } ); + } + + // Detect show/hide animations + for ( prop in props ) { + value = props[ prop ]; + if ( rfxtypes.test( value ) ) { + delete props[ prop ]; + toggle = toggle || value === "toggle"; + if ( value === ( hidden ? "hide" : "show" ) ) { + + // Pretend to be hidden if this is a "show" and + // there is still data from a stopped show/hide + if ( value === "show" && dataShow && dataShow[ prop ] !== undefined ) { + hidden = true; + + // Ignore all other no-op show/hide data + } else { + continue; + } + } + orig[ prop ] = dataShow && dataShow[ prop ] || jQuery.style( elem, prop ); + } + } + + // Bail out if this is a no-op like .hide().hide() + propTween = !jQuery.isEmptyObject( props ); + if ( !propTween && jQuery.isEmptyObject( orig ) ) { + return; + } + + // Restrict "overflow" and "display" styles during box animations + if ( isBox && elem.nodeType === 1 ) { + + // Support: IE <=9 - 11, Edge 12 - 13 + // Record all 3 overflow attributes because IE does not infer the shorthand + // from identically-valued overflowX and overflowY + opts.overflow = [ style.overflow, style.overflowX, style.overflowY ]; + + // Identify a display type, preferring old show/hide data over the CSS cascade + restoreDisplay = dataShow && dataShow.display; + if ( restoreDisplay == null ) { + restoreDisplay = dataPriv.get( elem, "display" ); + } + display = jQuery.css( elem, "display" ); + if ( display === "none" ) { + if ( restoreDisplay ) { + display = restoreDisplay; + } else { + + // Get nonempty value(s) by temporarily forcing visibility + showHide( [ elem ], true ); + restoreDisplay = elem.style.display || restoreDisplay; + display = jQuery.css( elem, "display" ); + showHide( [ elem ] ); + } + } + + // Animate inline elements as inline-block + if ( display === "inline" || display === "inline-block" && restoreDisplay != null ) { + if ( jQuery.css( elem, "float" ) === "none" ) { + + // Restore the original display value at the end of pure show/hide animations + if ( !propTween ) { + anim.done( function() { + style.display = restoreDisplay; + } ); + if ( restoreDisplay == null ) { + display = style.display; + restoreDisplay = display === "none" ? "" : display; + } + } + style.display = "inline-block"; + } + } + } + + if ( opts.overflow ) { + style.overflow = "hidden"; + anim.always( function() { + style.overflow = opts.overflow[ 0 ]; + style.overflowX = opts.overflow[ 1 ]; + style.overflowY = opts.overflow[ 2 ]; + } ); + } + + // Implement show/hide animations + propTween = false; + for ( prop in orig ) { + + // General show/hide setup for this element animation + if ( !propTween ) { + if ( dataShow ) { + if ( "hidden" in dataShow ) { + hidden = dataShow.hidden; + } + } else { + dataShow = dataPriv.access( elem, "fxshow", { display: restoreDisplay } ); + } + + // Store hidden/visible for toggle so `.stop().toggle()` "reverses" + if ( toggle ) { + dataShow.hidden = !hidden; + } + + // Show elements before animating them + if ( hidden ) { + showHide( [ elem ], true ); + } + + /* eslint-disable no-loop-func */ + + anim.done( function() { + + /* eslint-enable no-loop-func */ + + // The final step of a "hide" animation is actually hiding the element + if ( !hidden ) { + showHide( [ elem ] ); + } + dataPriv.remove( elem, "fxshow" ); + for ( prop in orig ) { + jQuery.style( elem, prop, orig[ prop ] ); + } + } ); + } + + // Per-property setup + propTween = createTween( hidden ? dataShow[ prop ] : 0, prop, anim ); + if ( !( prop in dataShow ) ) { + dataShow[ prop ] = propTween.start; + if ( hidden ) { + propTween.end = propTween.start; + propTween.start = 0; + } + } + } +} + +function propFilter( props, specialEasing ) { + var index, name, easing, value, hooks; + + // camelCase, specialEasing and expand cssHook pass + for ( index in props ) { + name = jQuery.camelCase( index ); + easing = specialEasing[ name ]; + value = props[ index ]; + if ( Array.isArray( value ) ) { + easing = value[ 1 ]; + value = props[ index ] = value[ 0 ]; + } + + if ( index !== name ) { + props[ name ] = value; + delete props[ index ]; + } + + hooks = jQuery.cssHooks[ name ]; + if ( hooks && "expand" in hooks ) { + value = hooks.expand( value ); + delete props[ name ]; + + // Not quite $.extend, this won't overwrite existing keys. + // Reusing 'index' because we have the correct "name" + for ( index in value ) { + if ( !( index in props ) ) { + props[ index ] = value[ index ]; + specialEasing[ index ] = easing; + } + } + } else { + specialEasing[ name ] = easing; + } + } +} + +function Animation( elem, properties, options ) { + var result, + stopped, + index = 0, + length = Animation.prefilters.length, + deferred = jQuery.Deferred().always( function() { + + // Don't match elem in the :animated selector + delete tick.elem; + } ), + tick = function() { + if ( stopped ) { + return false; + } + var currentTime = fxNow || createFxNow(), + remaining = Math.max( 0, animation.startTime + animation.duration - currentTime ), + + // Support: Android 2.3 only + // Archaic crash bug won't allow us to use `1 - ( 0.5 || 0 )` (#12497) + temp = remaining / animation.duration || 0, + percent = 1 - temp, + index = 0, + length = animation.tweens.length; + + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( percent ); + } + + deferred.notifyWith( elem, [ animation, percent, remaining ] ); + + // If there's more to do, yield + if ( percent < 1 && length ) { + return remaining; + } + + // If this was an empty animation, synthesize a final progress notification + if ( !length ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + } + + // Resolve the animation and report its conclusion + deferred.resolveWith( elem, [ animation ] ); + return false; + }, + animation = deferred.promise( { + elem: elem, + props: jQuery.extend( {}, properties ), + opts: jQuery.extend( true, { + specialEasing: {}, + easing: jQuery.easing._default + }, options ), + originalProperties: properties, + originalOptions: options, + startTime: fxNow || createFxNow(), + duration: options.duration, + tweens: [], + createTween: function( prop, end ) { + var tween = jQuery.Tween( elem, animation.opts, prop, end, + animation.opts.specialEasing[ prop ] || animation.opts.easing ); + animation.tweens.push( tween ); + return tween; + }, + stop: function( gotoEnd ) { + var index = 0, + + // If we are going to the end, we want to run all the tweens + // otherwise we skip this part + length = gotoEnd ? animation.tweens.length : 0; + if ( stopped ) { + return this; + } + stopped = true; + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( 1 ); + } + + // Resolve when we played the last frame; otherwise, reject + if ( gotoEnd ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + deferred.resolveWith( elem, [ animation, gotoEnd ] ); + } else { + deferred.rejectWith( elem, [ animation, gotoEnd ] ); + } + return this; + } + } ), + props = animation.props; + + propFilter( props, animation.opts.specialEasing ); + + for ( ; index < length; index++ ) { + result = Animation.prefilters[ index ].call( animation, elem, props, animation.opts ); + if ( result ) { + if ( jQuery.isFunction( result.stop ) ) { + jQuery._queueHooks( animation.elem, animation.opts.queue ).stop = + jQuery.proxy( result.stop, result ); + } + return result; + } + } + + jQuery.map( props, createTween, animation ); + + if ( jQuery.isFunction( animation.opts.start ) ) { + animation.opts.start.call( elem, animation ); + } + + // Attach callbacks from options + animation + .progress( animation.opts.progress ) + .done( animation.opts.done, animation.opts.complete ) + .fail( animation.opts.fail ) + .always( animation.opts.always ); + + jQuery.fx.timer( + jQuery.extend( tick, { + elem: elem, + anim: animation, + queue: animation.opts.queue + } ) + ); + + return animation; +} + +jQuery.Animation = jQuery.extend( Animation, { + + tweeners: { + "*": [ function( prop, value ) { + var tween = this.createTween( prop, value ); + adjustCSS( tween.elem, prop, rcssNum.exec( value ), tween ); + return tween; + } ] + }, + + tweener: function( props, callback ) { + if ( jQuery.isFunction( props ) ) { + callback = props; + props = [ "*" ]; + } else { + props = props.match( rnothtmlwhite ); + } + + var prop, + index = 0, + length = props.length; + + for ( ; index < length; index++ ) { + prop = props[ index ]; + Animation.tweeners[ prop ] = Animation.tweeners[ prop ] || []; + Animation.tweeners[ prop ].unshift( callback ); + } + }, + + prefilters: [ defaultPrefilter ], + + prefilter: function( callback, prepend ) { + if ( prepend ) { + Animation.prefilters.unshift( callback ); + } else { + Animation.prefilters.push( callback ); + } + } +} ); + +jQuery.speed = function( speed, easing, fn ) { + var opt = speed && typeof speed === "object" ? jQuery.extend( {}, speed ) : { + complete: fn || !fn && easing || + jQuery.isFunction( speed ) && speed, + duration: speed, + easing: fn && easing || easing && !jQuery.isFunction( easing ) && easing + }; + + // Go to the end state if fx are off + if ( jQuery.fx.off ) { + opt.duration = 0; + + } else { + if ( typeof opt.duration !== "number" ) { + if ( opt.duration in jQuery.fx.speeds ) { + opt.duration = jQuery.fx.speeds[ opt.duration ]; + + } else { + opt.duration = jQuery.fx.speeds._default; + } + } + } + + // Normalize opt.queue - true/undefined/null -> "fx" + if ( opt.queue == null || opt.queue === true ) { + opt.queue = "fx"; + } + + // Queueing + opt.old = opt.complete; + + opt.complete = function() { + if ( jQuery.isFunction( opt.old ) ) { + opt.old.call( this ); + } + + if ( opt.queue ) { + jQuery.dequeue( this, opt.queue ); + } + }; + + return opt; +}; + +jQuery.fn.extend( { + fadeTo: function( speed, to, easing, callback ) { + + // Show any hidden elements after setting opacity to 0 + return this.filter( isHiddenWithinTree ).css( "opacity", 0 ).show() + + // Animate to the value specified + .end().animate( { opacity: to }, speed, easing, callback ); + }, + animate: function( prop, speed, easing, callback ) { + var empty = jQuery.isEmptyObject( prop ), + optall = jQuery.speed( speed, easing, callback ), + doAnimation = function() { + + // Operate on a copy of prop so per-property easing won't be lost + var anim = Animation( this, jQuery.extend( {}, prop ), optall ); + + // Empty animations, or finishing resolves immediately + if ( empty || dataPriv.get( this, "finish" ) ) { + anim.stop( true ); + } + }; + doAnimation.finish = doAnimation; + + return empty || optall.queue === false ? + this.each( doAnimation ) : + this.queue( optall.queue, doAnimation ); + }, + stop: function( type, clearQueue, gotoEnd ) { + var stopQueue = function( hooks ) { + var stop = hooks.stop; + delete hooks.stop; + stop( gotoEnd ); + }; + + if ( typeof type !== "string" ) { + gotoEnd = clearQueue; + clearQueue = type; + type = undefined; + } + if ( clearQueue && type !== false ) { + this.queue( type || "fx", [] ); + } + + return this.each( function() { + var dequeue = true, + index = type != null && type + "queueHooks", + timers = jQuery.timers, + data = dataPriv.get( this ); + + if ( index ) { + if ( data[ index ] && data[ index ].stop ) { + stopQueue( data[ index ] ); + } + } else { + for ( index in data ) { + if ( data[ index ] && data[ index ].stop && rrun.test( index ) ) { + stopQueue( data[ index ] ); + } + } + } + + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && + ( type == null || timers[ index ].queue === type ) ) { + + timers[ index ].anim.stop( gotoEnd ); + dequeue = false; + timers.splice( index, 1 ); + } + } + + // Start the next in the queue if the last step wasn't forced. + // Timers currently will call their complete callbacks, which + // will dequeue but only if they were gotoEnd. + if ( dequeue || !gotoEnd ) { + jQuery.dequeue( this, type ); + } + } ); + }, + finish: function( type ) { + if ( type !== false ) { + type = type || "fx"; + } + return this.each( function() { + var index, + data = dataPriv.get( this ), + queue = data[ type + "queue" ], + hooks = data[ type + "queueHooks" ], + timers = jQuery.timers, + length = queue ? queue.length : 0; + + // Enable finishing flag on private data + data.finish = true; + + // Empty the queue first + jQuery.queue( this, type, [] ); + + if ( hooks && hooks.stop ) { + hooks.stop.call( this, true ); + } + + // Look for any active animations, and finish them + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && timers[ index ].queue === type ) { + timers[ index ].anim.stop( true ); + timers.splice( index, 1 ); + } + } + + // Look for any animations in the old queue and finish them + for ( index = 0; index < length; index++ ) { + if ( queue[ index ] && queue[ index ].finish ) { + queue[ index ].finish.call( this ); + } + } + + // Turn off finishing flag + delete data.finish; + } ); + } +} ); + +jQuery.each( [ "toggle", "show", "hide" ], function( i, name ) { + var cssFn = jQuery.fn[ name ]; + jQuery.fn[ name ] = function( speed, easing, callback ) { + return speed == null || typeof speed === "boolean" ? + cssFn.apply( this, arguments ) : + this.animate( genFx( name, true ), speed, easing, callback ); + }; +} ); + +// Generate shortcuts for custom animations +jQuery.each( { + slideDown: genFx( "show" ), + slideUp: genFx( "hide" ), + slideToggle: genFx( "toggle" ), + fadeIn: { opacity: "show" }, + fadeOut: { opacity: "hide" }, + fadeToggle: { opacity: "toggle" } +}, function( name, props ) { + jQuery.fn[ name ] = function( speed, easing, callback ) { + return this.animate( props, speed, easing, callback ); + }; +} ); + +jQuery.timers = []; +jQuery.fx.tick = function() { + var timer, + i = 0, + timers = jQuery.timers; + + fxNow = jQuery.now(); + + for ( ; i < timers.length; i++ ) { + timer = timers[ i ]; + + // Run the timer and safely remove it when done (allowing for external removal) + if ( !timer() && timers[ i ] === timer ) { + timers.splice( i--, 1 ); + } + } + + if ( !timers.length ) { + jQuery.fx.stop(); + } + fxNow = undefined; +}; + +jQuery.fx.timer = function( timer ) { + jQuery.timers.push( timer ); + jQuery.fx.start(); +}; + +jQuery.fx.interval = 13; +jQuery.fx.start = function() { + if ( inProgress ) { + return; + } + + inProgress = true; + schedule(); +}; + +jQuery.fx.stop = function() { + inProgress = null; +}; + +jQuery.fx.speeds = { + slow: 600, + fast: 200, + + // Default speed + _default: 400 +}; + + +// Based off of the plugin by Clint Helfers, with permission. +// https://web.archive.org/web/20100324014747/http://blindsignals.com/index.php/2009/07/jquery-delay/ +jQuery.fn.delay = function( time, type ) { + time = jQuery.fx ? jQuery.fx.speeds[ time ] || time : time; + type = type || "fx"; + + return this.queue( type, function( next, hooks ) { + var timeout = window.setTimeout( next, time ); + hooks.stop = function() { + window.clearTimeout( timeout ); + }; + } ); +}; + + +( function() { + var input = document.createElement( "input" ), + select = document.createElement( "select" ), + opt = select.appendChild( document.createElement( "option" ) ); + + input.type = "checkbox"; + + // Support: Android <=4.3 only + // Default value for a checkbox should be "on" + support.checkOn = input.value !== ""; + + // Support: IE <=11 only + // Must access selectedIndex to make default options select + support.optSelected = opt.selected; + + // Support: IE <=11 only + // An input loses its value after becoming a radio + input = document.createElement( "input" ); + input.value = "t"; + input.type = "radio"; + support.radioValue = input.value === "t"; +} )(); + + +var boolHook, + attrHandle = jQuery.expr.attrHandle; + +jQuery.fn.extend( { + attr: function( name, value ) { + return access( this, jQuery.attr, name, value, arguments.length > 1 ); + }, + + removeAttr: function( name ) { + return this.each( function() { + jQuery.removeAttr( this, name ); + } ); + } +} ); + +jQuery.extend( { + attr: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set attributes on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + // Fallback to prop when attributes are not supported + if ( typeof elem.getAttribute === "undefined" ) { + return jQuery.prop( elem, name, value ); + } + + // Attribute hooks are determined by the lowercase version + // Grab necessary hook if one is defined + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + hooks = jQuery.attrHooks[ name.toLowerCase() ] || + ( jQuery.expr.match.bool.test( name ) ? boolHook : undefined ); + } + + if ( value !== undefined ) { + if ( value === null ) { + jQuery.removeAttr( elem, name ); + return; + } + + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + elem.setAttribute( name, value + "" ); + return value; + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + ret = jQuery.find.attr( elem, name ); + + // Non-existent attributes return null, we normalize to undefined + return ret == null ? undefined : ret; + }, + + attrHooks: { + type: { + set: function( elem, value ) { + if ( !support.radioValue && value === "radio" && + nodeName( elem, "input" ) ) { + var val = elem.value; + elem.setAttribute( "type", value ); + if ( val ) { + elem.value = val; + } + return value; + } + } + } + }, + + removeAttr: function( elem, value ) { + var name, + i = 0, + + // Attribute names can contain non-HTML whitespace characters + // https://html.spec.whatwg.org/multipage/syntax.html#attributes-2 + attrNames = value && value.match( rnothtmlwhite ); + + if ( attrNames && elem.nodeType === 1 ) { + while ( ( name = attrNames[ i++ ] ) ) { + elem.removeAttribute( name ); + } + } + } +} ); + +// Hooks for boolean attributes +boolHook = { + set: function( elem, value, name ) { + if ( value === false ) { + + // Remove boolean attributes when set to false + jQuery.removeAttr( elem, name ); + } else { + elem.setAttribute( name, name ); + } + return name; + } +}; + +jQuery.each( jQuery.expr.match.bool.source.match( /\w+/g ), function( i, name ) { + var getter = attrHandle[ name ] || jQuery.find.attr; + + attrHandle[ name ] = function( elem, name, isXML ) { + var ret, handle, + lowercaseName = name.toLowerCase(); + + if ( !isXML ) { + + // Avoid an infinite loop by temporarily removing this function from the getter + handle = attrHandle[ lowercaseName ]; + attrHandle[ lowercaseName ] = ret; + ret = getter( elem, name, isXML ) != null ? + lowercaseName : + null; + attrHandle[ lowercaseName ] = handle; + } + return ret; + }; +} ); + + + + +var rfocusable = /^(?:input|select|textarea|button)$/i, + rclickable = /^(?:a|area)$/i; + +jQuery.fn.extend( { + prop: function( name, value ) { + return access( this, jQuery.prop, name, value, arguments.length > 1 ); + }, + + removeProp: function( name ) { + return this.each( function() { + delete this[ jQuery.propFix[ name ] || name ]; + } ); + } +} ); + +jQuery.extend( { + prop: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set properties on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + + // Fix name and attach hooks + name = jQuery.propFix[ name ] || name; + hooks = jQuery.propHooks[ name ]; + } + + if ( value !== undefined ) { + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + return ( elem[ name ] = value ); + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + return elem[ name ]; + }, + + propHooks: { + tabIndex: { + get: function( elem ) { + + // Support: IE <=9 - 11 only + // elem.tabIndex doesn't always return the + // correct value when it hasn't been explicitly set + // https://web.archive.org/web/20141116233347/http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/ + // Use proper attribute retrieval(#12072) + var tabindex = jQuery.find.attr( elem, "tabindex" ); + + if ( tabindex ) { + return parseInt( tabindex, 10 ); + } + + if ( + rfocusable.test( elem.nodeName ) || + rclickable.test( elem.nodeName ) && + elem.href + ) { + return 0; + } + + return -1; + } + } + }, + + propFix: { + "for": "htmlFor", + "class": "className" + } +} ); + +// Support: IE <=11 only +// Accessing the selectedIndex property +// forces the browser to respect setting selected +// on the option +// The getter ensures a default option is selected +// when in an optgroup +// eslint rule "no-unused-expressions" is disabled for this code +// since it considers such accessions noop +if ( !support.optSelected ) { + jQuery.propHooks.selected = { + get: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent && parent.parentNode ) { + parent.parentNode.selectedIndex; + } + return null; + }, + set: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent ) { + parent.selectedIndex; + + if ( parent.parentNode ) { + parent.parentNode.selectedIndex; + } + } + } + }; +} + +jQuery.each( [ + "tabIndex", + "readOnly", + "maxLength", + "cellSpacing", + "cellPadding", + "rowSpan", + "colSpan", + "useMap", + "frameBorder", + "contentEditable" +], function() { + jQuery.propFix[ this.toLowerCase() ] = this; +} ); + + + + + // Strip and collapse whitespace according to HTML spec + // https://html.spec.whatwg.org/multipage/infrastructure.html#strip-and-collapse-whitespace + function stripAndCollapse( value ) { + var tokens = value.match( rnothtmlwhite ) || []; + return tokens.join( " " ); + } + + +function getClass( elem ) { + return elem.getAttribute && elem.getAttribute( "class" ) || ""; +} + +jQuery.fn.extend( { + addClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( jQuery.isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).addClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + if ( typeof value === "string" && value ) { + classes = value.match( rnothtmlwhite ) || []; + + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + if ( cur.indexOf( " " + clazz + " " ) < 0 ) { + cur += clazz + " "; + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + removeClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( jQuery.isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).removeClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + if ( !arguments.length ) { + return this.attr( "class", "" ); + } + + if ( typeof value === "string" && value ) { + classes = value.match( rnothtmlwhite ) || []; + + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + + // This expression is here for better compressibility (see addClass) + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + + // Remove *all* instances + while ( cur.indexOf( " " + clazz + " " ) > -1 ) { + cur = cur.replace( " " + clazz + " ", " " ); + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + toggleClass: function( value, stateVal ) { + var type = typeof value; + + if ( typeof stateVal === "boolean" && type === "string" ) { + return stateVal ? this.addClass( value ) : this.removeClass( value ); + } + + if ( jQuery.isFunction( value ) ) { + return this.each( function( i ) { + jQuery( this ).toggleClass( + value.call( this, i, getClass( this ), stateVal ), + stateVal + ); + } ); + } + + return this.each( function() { + var className, i, self, classNames; + + if ( type === "string" ) { + + // Toggle individual class names + i = 0; + self = jQuery( this ); + classNames = value.match( rnothtmlwhite ) || []; + + while ( ( className = classNames[ i++ ] ) ) { + + // Check each className given, space separated list + if ( self.hasClass( className ) ) { + self.removeClass( className ); + } else { + self.addClass( className ); + } + } + + // Toggle whole class name + } else if ( value === undefined || type === "boolean" ) { + className = getClass( this ); + if ( className ) { + + // Store className if set + dataPriv.set( this, "__className__", className ); + } + + // If the element has a class name or if we're passed `false`, + // then remove the whole classname (if there was one, the above saved it). + // Otherwise bring back whatever was previously saved (if anything), + // falling back to the empty string if nothing was stored. + if ( this.setAttribute ) { + this.setAttribute( "class", + className || value === false ? + "" : + dataPriv.get( this, "__className__" ) || "" + ); + } + } + } ); + }, + + hasClass: function( selector ) { + var className, elem, + i = 0; + + className = " " + selector + " "; + while ( ( elem = this[ i++ ] ) ) { + if ( elem.nodeType === 1 && + ( " " + stripAndCollapse( getClass( elem ) ) + " " ).indexOf( className ) > -1 ) { + return true; + } + } + + return false; + } +} ); + + + + +var rreturn = /\r/g; + +jQuery.fn.extend( { + val: function( value ) { + var hooks, ret, isFunction, + elem = this[ 0 ]; + + if ( !arguments.length ) { + if ( elem ) { + hooks = jQuery.valHooks[ elem.type ] || + jQuery.valHooks[ elem.nodeName.toLowerCase() ]; + + if ( hooks && + "get" in hooks && + ( ret = hooks.get( elem, "value" ) ) !== undefined + ) { + return ret; + } + + ret = elem.value; + + // Handle most common string cases + if ( typeof ret === "string" ) { + return ret.replace( rreturn, "" ); + } + + // Handle cases where value is null/undef or number + return ret == null ? "" : ret; + } + + return; + } + + isFunction = jQuery.isFunction( value ); + + return this.each( function( i ) { + var val; + + if ( this.nodeType !== 1 ) { + return; + } + + if ( isFunction ) { + val = value.call( this, i, jQuery( this ).val() ); + } else { + val = value; + } + + // Treat null/undefined as ""; convert numbers to string + if ( val == null ) { + val = ""; + + } else if ( typeof val === "number" ) { + val += ""; + + } else if ( Array.isArray( val ) ) { + val = jQuery.map( val, function( value ) { + return value == null ? "" : value + ""; + } ); + } + + hooks = jQuery.valHooks[ this.type ] || jQuery.valHooks[ this.nodeName.toLowerCase() ]; + + // If set returns undefined, fall back to normal setting + if ( !hooks || !( "set" in hooks ) || hooks.set( this, val, "value" ) === undefined ) { + this.value = val; + } + } ); + } +} ); + +jQuery.extend( { + valHooks: { + option: { + get: function( elem ) { + + var val = jQuery.find.attr( elem, "value" ); + return val != null ? + val : + + // Support: IE <=10 - 11 only + // option.text throws exceptions (#14686, #14858) + // Strip and collapse whitespace + // https://html.spec.whatwg.org/#strip-and-collapse-whitespace + stripAndCollapse( jQuery.text( elem ) ); + } + }, + select: { + get: function( elem ) { + var value, option, i, + options = elem.options, + index = elem.selectedIndex, + one = elem.type === "select-one", + values = one ? null : [], + max = one ? index + 1 : options.length; + + if ( index < 0 ) { + i = max; + + } else { + i = one ? index : 0; + } + + // Loop through all the selected options + for ( ; i < max; i++ ) { + option = options[ i ]; + + // Support: IE <=9 only + // IE8-9 doesn't update selected after form reset (#2551) + if ( ( option.selected || i === index ) && + + // Don't return options that are disabled or in a disabled optgroup + !option.disabled && + ( !option.parentNode.disabled || + !nodeName( option.parentNode, "optgroup" ) ) ) { + + // Get the specific value for the option + value = jQuery( option ).val(); + + // We don't need an array for one selects + if ( one ) { + return value; + } + + // Multi-Selects return an array + values.push( value ); + } + } + + return values; + }, + + set: function( elem, value ) { + var optionSet, option, + options = elem.options, + values = jQuery.makeArray( value ), + i = options.length; + + while ( i-- ) { + option = options[ i ]; + + /* eslint-disable no-cond-assign */ + + if ( option.selected = + jQuery.inArray( jQuery.valHooks.option.get( option ), values ) > -1 + ) { + optionSet = true; + } + + /* eslint-enable no-cond-assign */ + } + + // Force browsers to behave consistently when non-matching value is set + if ( !optionSet ) { + elem.selectedIndex = -1; + } + return values; + } + } + } +} ); + +// Radios and checkboxes getter/setter +jQuery.each( [ "radio", "checkbox" ], function() { + jQuery.valHooks[ this ] = { + set: function( elem, value ) { + if ( Array.isArray( value ) ) { + return ( elem.checked = jQuery.inArray( jQuery( elem ).val(), value ) > -1 ); + } + } + }; + if ( !support.checkOn ) { + jQuery.valHooks[ this ].get = function( elem ) { + return elem.getAttribute( "value" ) === null ? "on" : elem.value; + }; + } +} ); + + + + +// Return jQuery for attributes-only inclusion + + +var rfocusMorph = /^(?:focusinfocus|focusoutblur)$/; + +jQuery.extend( jQuery.event, { + + trigger: function( event, data, elem, onlyHandlers ) { + + var i, cur, tmp, bubbleType, ontype, handle, special, + eventPath = [ elem || document ], + type = hasOwn.call( event, "type" ) ? event.type : event, + namespaces = hasOwn.call( event, "namespace" ) ? event.namespace.split( "." ) : []; + + cur = tmp = elem = elem || document; + + // Don't do events on text and comment nodes + if ( elem.nodeType === 3 || elem.nodeType === 8 ) { + return; + } + + // focus/blur morphs to focusin/out; ensure we're not firing them right now + if ( rfocusMorph.test( type + jQuery.event.triggered ) ) { + return; + } + + if ( type.indexOf( "." ) > -1 ) { + + // Namespaced trigger; create a regexp to match event type in handle() + namespaces = type.split( "." ); + type = namespaces.shift(); + namespaces.sort(); + } + ontype = type.indexOf( ":" ) < 0 && "on" + type; + + // Caller can pass in a jQuery.Event object, Object, or just an event type string + event = event[ jQuery.expando ] ? + event : + new jQuery.Event( type, typeof event === "object" && event ); + + // Trigger bitmask: & 1 for native handlers; & 2 for jQuery (always true) + event.isTrigger = onlyHandlers ? 2 : 3; + event.namespace = namespaces.join( "." ); + event.rnamespace = event.namespace ? + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ) : + null; + + // Clean up the event in case it is being reused + event.result = undefined; + if ( !event.target ) { + event.target = elem; + } + + // Clone any incoming data and prepend the event, creating the handler arg list + data = data == null ? + [ event ] : + jQuery.makeArray( data, [ event ] ); + + // Allow special events to draw outside the lines + special = jQuery.event.special[ type ] || {}; + if ( !onlyHandlers && special.trigger && special.trigger.apply( elem, data ) === false ) { + return; + } + + // Determine event propagation path in advance, per W3C events spec (#9951) + // Bubble up to document, then to window; watch for a global ownerDocument var (#9724) + if ( !onlyHandlers && !special.noBubble && !jQuery.isWindow( elem ) ) { + + bubbleType = special.delegateType || type; + if ( !rfocusMorph.test( bubbleType + type ) ) { + cur = cur.parentNode; + } + for ( ; cur; cur = cur.parentNode ) { + eventPath.push( cur ); + tmp = cur; + } + + // Only add window if we got to document (e.g., not plain obj or detached DOM) + if ( tmp === ( elem.ownerDocument || document ) ) { + eventPath.push( tmp.defaultView || tmp.parentWindow || window ); + } + } + + // Fire handlers on the event path + i = 0; + while ( ( cur = eventPath[ i++ ] ) && !event.isPropagationStopped() ) { + + event.type = i > 1 ? + bubbleType : + special.bindType || type; + + // jQuery handler + handle = ( dataPriv.get( cur, "events" ) || {} )[ event.type ] && + dataPriv.get( cur, "handle" ); + if ( handle ) { + handle.apply( cur, data ); + } + + // Native handler + handle = ontype && cur[ ontype ]; + if ( handle && handle.apply && acceptData( cur ) ) { + event.result = handle.apply( cur, data ); + if ( event.result === false ) { + event.preventDefault(); + } + } + } + event.type = type; + + // If nobody prevented the default action, do it now + if ( !onlyHandlers && !event.isDefaultPrevented() ) { + + if ( ( !special._default || + special._default.apply( eventPath.pop(), data ) === false ) && + acceptData( elem ) ) { + + // Call a native DOM method on the target with the same name as the event. + // Don't do default actions on window, that's where global variables be (#6170) + if ( ontype && jQuery.isFunction( elem[ type ] ) && !jQuery.isWindow( elem ) ) { + + // Don't re-trigger an onFOO event when we call its FOO() method + tmp = elem[ ontype ]; + + if ( tmp ) { + elem[ ontype ] = null; + } + + // Prevent re-triggering of the same event, since we already bubbled it above + jQuery.event.triggered = type; + elem[ type ](); + jQuery.event.triggered = undefined; + + if ( tmp ) { + elem[ ontype ] = tmp; + } + } + } + } + + return event.result; + }, + + // Piggyback on a donor event to simulate a different one + // Used only for `focus(in | out)` events + simulate: function( type, elem, event ) { + var e = jQuery.extend( + new jQuery.Event(), + event, + { + type: type, + isSimulated: true + } + ); + + jQuery.event.trigger( e, null, elem ); + } + +} ); + +jQuery.fn.extend( { + + trigger: function( type, data ) { + return this.each( function() { + jQuery.event.trigger( type, data, this ); + } ); + }, + triggerHandler: function( type, data ) { + var elem = this[ 0 ]; + if ( elem ) { + return jQuery.event.trigger( type, data, elem, true ); + } + } +} ); + + +jQuery.each( ( "blur focus focusin focusout resize scroll click dblclick " + + "mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave " + + "change select submit keydown keypress keyup contextmenu" ).split( " " ), + function( i, name ) { + + // Handle event binding + jQuery.fn[ name ] = function( data, fn ) { + return arguments.length > 0 ? + this.on( name, null, data, fn ) : + this.trigger( name ); + }; +} ); + +jQuery.fn.extend( { + hover: function( fnOver, fnOut ) { + return this.mouseenter( fnOver ).mouseleave( fnOut || fnOver ); + } +} ); + + + + +support.focusin = "onfocusin" in window; + + +// Support: Firefox <=44 +// Firefox doesn't have focus(in | out) events +// Related ticket - https://bugzilla.mozilla.org/show_bug.cgi?id=687787 +// +// Support: Chrome <=48 - 49, Safari <=9.0 - 9.1 +// focus(in | out) events fire after focus & blur events, +// which is spec violation - http://www.w3.org/TR/DOM-Level-3-Events/#events-focusevent-event-order +// Related ticket - https://bugs.chromium.org/p/chromium/issues/detail?id=449857 +if ( !support.focusin ) { + jQuery.each( { focus: "focusin", blur: "focusout" }, function( orig, fix ) { + + // Attach a single capturing handler on the document while someone wants focusin/focusout + var handler = function( event ) { + jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ) ); + }; + + jQuery.event.special[ fix ] = { + setup: function() { + var doc = this.ownerDocument || this, + attaches = dataPriv.access( doc, fix ); + + if ( !attaches ) { + doc.addEventListener( orig, handler, true ); + } + dataPriv.access( doc, fix, ( attaches || 0 ) + 1 ); + }, + teardown: function() { + var doc = this.ownerDocument || this, + attaches = dataPriv.access( doc, fix ) - 1; + + if ( !attaches ) { + doc.removeEventListener( orig, handler, true ); + dataPriv.remove( doc, fix ); + + } else { + dataPriv.access( doc, fix, attaches ); + } + } + }; + } ); +} +var location = window.location; + +var nonce = jQuery.now(); + +var rquery = ( /\?/ ); + + + +// Cross-browser xml parsing +jQuery.parseXML = function( data ) { + var xml; + if ( !data || typeof data !== "string" ) { + return null; + } + + // Support: IE 9 - 11 only + // IE throws on parseFromString with invalid input. + try { + xml = ( new window.DOMParser() ).parseFromString( data, "text/xml" ); + } catch ( e ) { + xml = undefined; + } + + if ( !xml || xml.getElementsByTagName( "parsererror" ).length ) { + jQuery.error( "Invalid XML: " + data ); + } + return xml; +}; + + +var + rbracket = /\[\]$/, + rCRLF = /\r?\n/g, + rsubmitterTypes = /^(?:submit|button|image|reset|file)$/i, + rsubmittable = /^(?:input|select|textarea|keygen)/i; + +function buildParams( prefix, obj, traditional, add ) { + var name; + + if ( Array.isArray( obj ) ) { + + // Serialize array item. + jQuery.each( obj, function( i, v ) { + if ( traditional || rbracket.test( prefix ) ) { + + // Treat each array item as a scalar. + add( prefix, v ); + + } else { + + // Item is non-scalar (array or object), encode its numeric index. + buildParams( + prefix + "[" + ( typeof v === "object" && v != null ? i : "" ) + "]", + v, + traditional, + add + ); + } + } ); + + } else if ( !traditional && jQuery.type( obj ) === "object" ) { + + // Serialize object item. + for ( name in obj ) { + buildParams( prefix + "[" + name + "]", obj[ name ], traditional, add ); + } + + } else { + + // Serialize scalar item. + add( prefix, obj ); + } +} + +// Serialize an array of form elements or a set of +// key/values into a query string +jQuery.param = function( a, traditional ) { + var prefix, + s = [], + add = function( key, valueOrFunction ) { + + // If value is a function, invoke it and use its return value + var value = jQuery.isFunction( valueOrFunction ) ? + valueOrFunction() : + valueOrFunction; + + s[ s.length ] = encodeURIComponent( key ) + "=" + + encodeURIComponent( value == null ? "" : value ); + }; + + // If an array was passed in, assume that it is an array of form elements. + if ( Array.isArray( a ) || ( a.jquery && !jQuery.isPlainObject( a ) ) ) { + + // Serialize the form elements + jQuery.each( a, function() { + add( this.name, this.value ); + } ); + + } else { + + // If traditional, encode the "old" way (the way 1.3.2 or older + // did it), otherwise encode params recursively. + for ( prefix in a ) { + buildParams( prefix, a[ prefix ], traditional, add ); + } + } + + // Return the resulting serialization + return s.join( "&" ); +}; + +jQuery.fn.extend( { + serialize: function() { + return jQuery.param( this.serializeArray() ); + }, + serializeArray: function() { + return this.map( function() { + + // Can add propHook for "elements" to filter or add form elements + var elements = jQuery.prop( this, "elements" ); + return elements ? jQuery.makeArray( elements ) : this; + } ) + .filter( function() { + var type = this.type; + + // Use .is( ":disabled" ) so that fieldset[disabled] works + return this.name && !jQuery( this ).is( ":disabled" ) && + rsubmittable.test( this.nodeName ) && !rsubmitterTypes.test( type ) && + ( this.checked || !rcheckableType.test( type ) ); + } ) + .map( function( i, elem ) { + var val = jQuery( this ).val(); + + if ( val == null ) { + return null; + } + + if ( Array.isArray( val ) ) { + return jQuery.map( val, function( val ) { + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ); + } + + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ).get(); + } +} ); + + +var + r20 = /%20/g, + rhash = /#.*$/, + rantiCache = /([?&])_=[^&]*/, + rheaders = /^(.*?):[ \t]*([^\r\n]*)$/mg, + + // #7653, #8125, #8152: local protocol detection + rlocalProtocol = /^(?:about|app|app-storage|.+-extension|file|res|widget):$/, + rnoContent = /^(?:GET|HEAD)$/, + rprotocol = /^\/\//, + + /* Prefilters + * 1) They are useful to introduce custom dataTypes (see ajax/jsonp.js for an example) + * 2) These are called: + * - BEFORE asking for a transport + * - AFTER param serialization (s.data is a string if s.processData is true) + * 3) key is the dataType + * 4) the catchall symbol "*" can be used + * 5) execution will start with transport dataType and THEN continue down to "*" if needed + */ + prefilters = {}, + + /* Transports bindings + * 1) key is the dataType + * 2) the catchall symbol "*" can be used + * 3) selection will start with transport dataType and THEN go to "*" if needed + */ + transports = {}, + + // Avoid comment-prolog char sequence (#10098); must appease lint and evade compression + allTypes = "*/".concat( "*" ), + + // Anchor tag for parsing the document origin + originAnchor = document.createElement( "a" ); + originAnchor.href = location.href; + +// Base "constructor" for jQuery.ajaxPrefilter and jQuery.ajaxTransport +function addToPrefiltersOrTransports( structure ) { + + // dataTypeExpression is optional and defaults to "*" + return function( dataTypeExpression, func ) { + + if ( typeof dataTypeExpression !== "string" ) { + func = dataTypeExpression; + dataTypeExpression = "*"; + } + + var dataType, + i = 0, + dataTypes = dataTypeExpression.toLowerCase().match( rnothtmlwhite ) || []; + + if ( jQuery.isFunction( func ) ) { + + // For each dataType in the dataTypeExpression + while ( ( dataType = dataTypes[ i++ ] ) ) { + + // Prepend if requested + if ( dataType[ 0 ] === "+" ) { + dataType = dataType.slice( 1 ) || "*"; + ( structure[ dataType ] = structure[ dataType ] || [] ).unshift( func ); + + // Otherwise append + } else { + ( structure[ dataType ] = structure[ dataType ] || [] ).push( func ); + } + } + } + }; +} + +// Base inspection function for prefilters and transports +function inspectPrefiltersOrTransports( structure, options, originalOptions, jqXHR ) { + + var inspected = {}, + seekingTransport = ( structure === transports ); + + function inspect( dataType ) { + var selected; + inspected[ dataType ] = true; + jQuery.each( structure[ dataType ] || [], function( _, prefilterOrFactory ) { + var dataTypeOrTransport = prefilterOrFactory( options, originalOptions, jqXHR ); + if ( typeof dataTypeOrTransport === "string" && + !seekingTransport && !inspected[ dataTypeOrTransport ] ) { + + options.dataTypes.unshift( dataTypeOrTransport ); + inspect( dataTypeOrTransport ); + return false; + } else if ( seekingTransport ) { + return !( selected = dataTypeOrTransport ); + } + } ); + return selected; + } + + return inspect( options.dataTypes[ 0 ] ) || !inspected[ "*" ] && inspect( "*" ); +} + +// A special extend for ajax options +// that takes "flat" options (not to be deep extended) +// Fixes #9887 +function ajaxExtend( target, src ) { + var key, deep, + flatOptions = jQuery.ajaxSettings.flatOptions || {}; + + for ( key in src ) { + if ( src[ key ] !== undefined ) { + ( flatOptions[ key ] ? target : ( deep || ( deep = {} ) ) )[ key ] = src[ key ]; + } + } + if ( deep ) { + jQuery.extend( true, target, deep ); + } + + return target; +} + +/* Handles responses to an ajax request: + * - finds the right dataType (mediates between content-type and expected dataType) + * - returns the corresponding response + */ +function ajaxHandleResponses( s, jqXHR, responses ) { + + var ct, type, finalDataType, firstDataType, + contents = s.contents, + dataTypes = s.dataTypes; + + // Remove auto dataType and get content-type in the process + while ( dataTypes[ 0 ] === "*" ) { + dataTypes.shift(); + if ( ct === undefined ) { + ct = s.mimeType || jqXHR.getResponseHeader( "Content-Type" ); + } + } + + // Check if we're dealing with a known content-type + if ( ct ) { + for ( type in contents ) { + if ( contents[ type ] && contents[ type ].test( ct ) ) { + dataTypes.unshift( type ); + break; + } + } + } + + // Check to see if we have a response for the expected dataType + if ( dataTypes[ 0 ] in responses ) { + finalDataType = dataTypes[ 0 ]; + } else { + + // Try convertible dataTypes + for ( type in responses ) { + if ( !dataTypes[ 0 ] || s.converters[ type + " " + dataTypes[ 0 ] ] ) { + finalDataType = type; + break; + } + if ( !firstDataType ) { + firstDataType = type; + } + } + + // Or just use first one + finalDataType = finalDataType || firstDataType; + } + + // If we found a dataType + // We add the dataType to the list if needed + // and return the corresponding response + if ( finalDataType ) { + if ( finalDataType !== dataTypes[ 0 ] ) { + dataTypes.unshift( finalDataType ); + } + return responses[ finalDataType ]; + } +} + +/* Chain conversions given the request and the original response + * Also sets the responseXXX fields on the jqXHR instance + */ +function ajaxConvert( s, response, jqXHR, isSuccess ) { + var conv2, current, conv, tmp, prev, + converters = {}, + + // Work with a copy of dataTypes in case we need to modify it for conversion + dataTypes = s.dataTypes.slice(); + + // Create converters map with lowercased keys + if ( dataTypes[ 1 ] ) { + for ( conv in s.converters ) { + converters[ conv.toLowerCase() ] = s.converters[ conv ]; + } + } + + current = dataTypes.shift(); + + // Convert to each sequential dataType + while ( current ) { + + if ( s.responseFields[ current ] ) { + jqXHR[ s.responseFields[ current ] ] = response; + } + + // Apply the dataFilter if provided + if ( !prev && isSuccess && s.dataFilter ) { + response = s.dataFilter( response, s.dataType ); + } + + prev = current; + current = dataTypes.shift(); + + if ( current ) { + + // There's only work to do if current dataType is non-auto + if ( current === "*" ) { + + current = prev; + + // Convert response if prev dataType is non-auto and differs from current + } else if ( prev !== "*" && prev !== current ) { + + // Seek a direct converter + conv = converters[ prev + " " + current ] || converters[ "* " + current ]; + + // If none found, seek a pair + if ( !conv ) { + for ( conv2 in converters ) { + + // If conv2 outputs current + tmp = conv2.split( " " ); + if ( tmp[ 1 ] === current ) { + + // If prev can be converted to accepted input + conv = converters[ prev + " " + tmp[ 0 ] ] || + converters[ "* " + tmp[ 0 ] ]; + if ( conv ) { + + // Condense equivalence converters + if ( conv === true ) { + conv = converters[ conv2 ]; + + // Otherwise, insert the intermediate dataType + } else if ( converters[ conv2 ] !== true ) { + current = tmp[ 0 ]; + dataTypes.unshift( tmp[ 1 ] ); + } + break; + } + } + } + } + + // Apply converter (if not an equivalence) + if ( conv !== true ) { + + // Unless errors are allowed to bubble, catch and return them + if ( conv && s.throws ) { + response = conv( response ); + } else { + try { + response = conv( response ); + } catch ( e ) { + return { + state: "parsererror", + error: conv ? e : "No conversion from " + prev + " to " + current + }; + } + } + } + } + } + } + + return { state: "success", data: response }; +} + +jQuery.extend( { + + // Counter for holding the number of active queries + active: 0, + + // Last-Modified header cache for next request + lastModified: {}, + etag: {}, + + ajaxSettings: { + url: location.href, + type: "GET", + isLocal: rlocalProtocol.test( location.protocol ), + global: true, + processData: true, + async: true, + contentType: "application/x-www-form-urlencoded; charset=UTF-8", + + /* + timeout: 0, + data: null, + dataType: null, + username: null, + password: null, + cache: null, + throws: false, + traditional: false, + headers: {}, + */ + + accepts: { + "*": allTypes, + text: "text/plain", + html: "text/html", + xml: "application/xml, text/xml", + json: "application/json, text/javascript" + }, + + contents: { + xml: /\bxml\b/, + html: /\bhtml/, + json: /\bjson\b/ + }, + + responseFields: { + xml: "responseXML", + text: "responseText", + json: "responseJSON" + }, + + // Data converters + // Keys separate source (or catchall "*") and destination types with a single space + converters: { + + // Convert anything to text + "* text": String, + + // Text to html (true = no transformation) + "text html": true, + + // Evaluate text as a json expression + "text json": JSON.parse, + + // Parse text as xml + "text xml": jQuery.parseXML + }, + + // For options that shouldn't be deep extended: + // you can add your own custom options here if + // and when you create one that shouldn't be + // deep extended (see ajaxExtend) + flatOptions: { + url: true, + context: true + } + }, + + // Creates a full fledged settings object into target + // with both ajaxSettings and settings fields. + // If target is omitted, writes into ajaxSettings. + ajaxSetup: function( target, settings ) { + return settings ? + + // Building a settings object + ajaxExtend( ajaxExtend( target, jQuery.ajaxSettings ), settings ) : + + // Extending ajaxSettings + ajaxExtend( jQuery.ajaxSettings, target ); + }, + + ajaxPrefilter: addToPrefiltersOrTransports( prefilters ), + ajaxTransport: addToPrefiltersOrTransports( transports ), + + // Main method + ajax: function( url, options ) { + + // If url is an object, simulate pre-1.5 signature + if ( typeof url === "object" ) { + options = url; + url = undefined; + } + + // Force options to be an object + options = options || {}; + + var transport, + + // URL without anti-cache param + cacheURL, + + // Response headers + responseHeadersString, + responseHeaders, + + // timeout handle + timeoutTimer, + + // Url cleanup var + urlAnchor, + + // Request state (becomes false upon send and true upon completion) + completed, + + // To know if global events are to be dispatched + fireGlobals, + + // Loop variable + i, + + // uncached part of the url + uncached, + + // Create the final options object + s = jQuery.ajaxSetup( {}, options ), + + // Callbacks context + callbackContext = s.context || s, + + // Context for global events is callbackContext if it is a DOM node or jQuery collection + globalEventContext = s.context && + ( callbackContext.nodeType || callbackContext.jquery ) ? + jQuery( callbackContext ) : + jQuery.event, + + // Deferreds + deferred = jQuery.Deferred(), + completeDeferred = jQuery.Callbacks( "once memory" ), + + // Status-dependent callbacks + statusCode = s.statusCode || {}, + + // Headers (they are sent all at once) + requestHeaders = {}, + requestHeadersNames = {}, + + // Default abort message + strAbort = "canceled", + + // Fake xhr + jqXHR = { + readyState: 0, + + // Builds headers hashtable if needed + getResponseHeader: function( key ) { + var match; + if ( completed ) { + if ( !responseHeaders ) { + responseHeaders = {}; + while ( ( match = rheaders.exec( responseHeadersString ) ) ) { + responseHeaders[ match[ 1 ].toLowerCase() ] = match[ 2 ]; + } + } + match = responseHeaders[ key.toLowerCase() ]; + } + return match == null ? null : match; + }, + + // Raw string + getAllResponseHeaders: function() { + return completed ? responseHeadersString : null; + }, + + // Caches the header + setRequestHeader: function( name, value ) { + if ( completed == null ) { + name = requestHeadersNames[ name.toLowerCase() ] = + requestHeadersNames[ name.toLowerCase() ] || name; + requestHeaders[ name ] = value; + } + return this; + }, + + // Overrides response content-type header + overrideMimeType: function( type ) { + if ( completed == null ) { + s.mimeType = type; + } + return this; + }, + + // Status-dependent callbacks + statusCode: function( map ) { + var code; + if ( map ) { + if ( completed ) { + + // Execute the appropriate callbacks + jqXHR.always( map[ jqXHR.status ] ); + } else { + + // Lazy-add the new callbacks in a way that preserves old ones + for ( code in map ) { + statusCode[ code ] = [ statusCode[ code ], map[ code ] ]; + } + } + } + return this; + }, + + // Cancel the request + abort: function( statusText ) { + var finalText = statusText || strAbort; + if ( transport ) { + transport.abort( finalText ); + } + done( 0, finalText ); + return this; + } + }; + + // Attach deferreds + deferred.promise( jqXHR ); + + // Add protocol if not provided (prefilters might expect it) + // Handle falsy url in the settings object (#10093: consistency with old signature) + // We also use the url parameter if available + s.url = ( ( url || s.url || location.href ) + "" ) + .replace( rprotocol, location.protocol + "//" ); + + // Alias method option to type as per ticket #12004 + s.type = options.method || options.type || s.method || s.type; + + // Extract dataTypes list + s.dataTypes = ( s.dataType || "*" ).toLowerCase().match( rnothtmlwhite ) || [ "" ]; + + // A cross-domain request is in order when the origin doesn't match the current origin. + if ( s.crossDomain == null ) { + urlAnchor = document.createElement( "a" ); + + // Support: IE <=8 - 11, Edge 12 - 13 + // IE throws exception on accessing the href property if url is malformed, + // e.g. http://example.com:80x/ + try { + urlAnchor.href = s.url; + + // Support: IE <=8 - 11 only + // Anchor's host property isn't correctly set when s.url is relative + urlAnchor.href = urlAnchor.href; + s.crossDomain = originAnchor.protocol + "//" + originAnchor.host !== + urlAnchor.protocol + "//" + urlAnchor.host; + } catch ( e ) { + + // If there is an error parsing the URL, assume it is crossDomain, + // it can be rejected by the transport if it is invalid + s.crossDomain = true; + } + } + + // Convert data if not already a string + if ( s.data && s.processData && typeof s.data !== "string" ) { + s.data = jQuery.param( s.data, s.traditional ); + } + + // Apply prefilters + inspectPrefiltersOrTransports( prefilters, s, options, jqXHR ); + + // If request was aborted inside a prefilter, stop there + if ( completed ) { + return jqXHR; + } + + // We can fire global events as of now if asked to + // Don't fire events if jQuery.event is undefined in an AMD-usage scenario (#15118) + fireGlobals = jQuery.event && s.global; + + // Watch for a new set of requests + if ( fireGlobals && jQuery.active++ === 0 ) { + jQuery.event.trigger( "ajaxStart" ); + } + + // Uppercase the type + s.type = s.type.toUpperCase(); + + // Determine if request has content + s.hasContent = !rnoContent.test( s.type ); + + // Save the URL in case we're toying with the If-Modified-Since + // and/or If-None-Match header later on + // Remove hash to simplify url manipulation + cacheURL = s.url.replace( rhash, "" ); + + // More options handling for requests with no content + if ( !s.hasContent ) { + + // Remember the hash so we can put it back + uncached = s.url.slice( cacheURL.length ); + + // If data is available, append data to url + if ( s.data ) { + cacheURL += ( rquery.test( cacheURL ) ? "&" : "?" ) + s.data; + + // #9682: remove data so that it's not used in an eventual retry + delete s.data; + } + + // Add or update anti-cache param if needed + if ( s.cache === false ) { + cacheURL = cacheURL.replace( rantiCache, "$1" ); + uncached = ( rquery.test( cacheURL ) ? "&" : "?" ) + "_=" + ( nonce++ ) + uncached; + } + + // Put hash and anti-cache on the URL that will be requested (gh-1732) + s.url = cacheURL + uncached; + + // Change '%20' to '+' if this is encoded form body content (gh-2658) + } else if ( s.data && s.processData && + ( s.contentType || "" ).indexOf( "application/x-www-form-urlencoded" ) === 0 ) { + s.data = s.data.replace( r20, "+" ); + } + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + if ( jQuery.lastModified[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-Modified-Since", jQuery.lastModified[ cacheURL ] ); + } + if ( jQuery.etag[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-None-Match", jQuery.etag[ cacheURL ] ); + } + } + + // Set the correct header, if data is being sent + if ( s.data && s.hasContent && s.contentType !== false || options.contentType ) { + jqXHR.setRequestHeader( "Content-Type", s.contentType ); + } + + // Set the Accepts header for the server, depending on the dataType + jqXHR.setRequestHeader( + "Accept", + s.dataTypes[ 0 ] && s.accepts[ s.dataTypes[ 0 ] ] ? + s.accepts[ s.dataTypes[ 0 ] ] + + ( s.dataTypes[ 0 ] !== "*" ? ", " + allTypes + "; q=0.01" : "" ) : + s.accepts[ "*" ] + ); + + // Check for headers option + for ( i in s.headers ) { + jqXHR.setRequestHeader( i, s.headers[ i ] ); + } + + // Allow custom headers/mimetypes and early abort + if ( s.beforeSend && + ( s.beforeSend.call( callbackContext, jqXHR, s ) === false || completed ) ) { + + // Abort if not done already and return + return jqXHR.abort(); + } + + // Aborting is no longer a cancellation + strAbort = "abort"; + + // Install callbacks on deferreds + completeDeferred.add( s.complete ); + jqXHR.done( s.success ); + jqXHR.fail( s.error ); + + // Get transport + transport = inspectPrefiltersOrTransports( transports, s, options, jqXHR ); + + // If no transport, we auto-abort + if ( !transport ) { + done( -1, "No Transport" ); + } else { + jqXHR.readyState = 1; + + // Send global event + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxSend", [ jqXHR, s ] ); + } + + // If request was aborted inside ajaxSend, stop there + if ( completed ) { + return jqXHR; + } + + // Timeout + if ( s.async && s.timeout > 0 ) { + timeoutTimer = window.setTimeout( function() { + jqXHR.abort( "timeout" ); + }, s.timeout ); + } + + try { + completed = false; + transport.send( requestHeaders, done ); + } catch ( e ) { + + // Rethrow post-completion exceptions + if ( completed ) { + throw e; + } + + // Propagate others as results + done( -1, e ); + } + } + + // Callback for when everything is done + function done( status, nativeStatusText, responses, headers ) { + var isSuccess, success, error, response, modified, + statusText = nativeStatusText; + + // Ignore repeat invocations + if ( completed ) { + return; + } + + completed = true; + + // Clear timeout if it exists + if ( timeoutTimer ) { + window.clearTimeout( timeoutTimer ); + } + + // Dereference transport for early garbage collection + // (no matter how long the jqXHR object will be used) + transport = undefined; + + // Cache response headers + responseHeadersString = headers || ""; + + // Set readyState + jqXHR.readyState = status > 0 ? 4 : 0; + + // Determine if successful + isSuccess = status >= 200 && status < 300 || status === 304; + + // Get response data + if ( responses ) { + response = ajaxHandleResponses( s, jqXHR, responses ); + } + + // Convert no matter what (that way responseXXX fields are always set) + response = ajaxConvert( s, response, jqXHR, isSuccess ); + + // If successful, handle type chaining + if ( isSuccess ) { + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + modified = jqXHR.getResponseHeader( "Last-Modified" ); + if ( modified ) { + jQuery.lastModified[ cacheURL ] = modified; + } + modified = jqXHR.getResponseHeader( "etag" ); + if ( modified ) { + jQuery.etag[ cacheURL ] = modified; + } + } + + // if no content + if ( status === 204 || s.type === "HEAD" ) { + statusText = "nocontent"; + + // if not modified + } else if ( status === 304 ) { + statusText = "notmodified"; + + // If we have data, let's convert it + } else { + statusText = response.state; + success = response.data; + error = response.error; + isSuccess = !error; + } + } else { + + // Extract error from statusText and normalize for non-aborts + error = statusText; + if ( status || !statusText ) { + statusText = "error"; + if ( status < 0 ) { + status = 0; + } + } + } + + // Set data for the fake xhr object + jqXHR.status = status; + jqXHR.statusText = ( nativeStatusText || statusText ) + ""; + + // Success/Error + if ( isSuccess ) { + deferred.resolveWith( callbackContext, [ success, statusText, jqXHR ] ); + } else { + deferred.rejectWith( callbackContext, [ jqXHR, statusText, error ] ); + } + + // Status-dependent callbacks + jqXHR.statusCode( statusCode ); + statusCode = undefined; + + if ( fireGlobals ) { + globalEventContext.trigger( isSuccess ? "ajaxSuccess" : "ajaxError", + [ jqXHR, s, isSuccess ? success : error ] ); + } + + // Complete + completeDeferred.fireWith( callbackContext, [ jqXHR, statusText ] ); + + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxComplete", [ jqXHR, s ] ); + + // Handle the global AJAX counter + if ( !( --jQuery.active ) ) { + jQuery.event.trigger( "ajaxStop" ); + } + } + } + + return jqXHR; + }, + + getJSON: function( url, data, callback ) { + return jQuery.get( url, data, callback, "json" ); + }, + + getScript: function( url, callback ) { + return jQuery.get( url, undefined, callback, "script" ); + } +} ); + +jQuery.each( [ "get", "post" ], function( i, method ) { + jQuery[ method ] = function( url, data, callback, type ) { + + // Shift arguments if data argument was omitted + if ( jQuery.isFunction( data ) ) { + type = type || callback; + callback = data; + data = undefined; + } + + // The url can be an options object (which then must have .url) + return jQuery.ajax( jQuery.extend( { + url: url, + type: method, + dataType: type, + data: data, + success: callback + }, jQuery.isPlainObject( url ) && url ) ); + }; +} ); + + +jQuery._evalUrl = function( url ) { + return jQuery.ajax( { + url: url, + + // Make this explicit, since user can override this through ajaxSetup (#11264) + type: "GET", + dataType: "script", + cache: true, + async: false, + global: false, + "throws": true + } ); +}; + + +jQuery.fn.extend( { + wrapAll: function( html ) { + var wrap; + + if ( this[ 0 ] ) { + if ( jQuery.isFunction( html ) ) { + html = html.call( this[ 0 ] ); + } + + // The elements to wrap the target around + wrap = jQuery( html, this[ 0 ].ownerDocument ).eq( 0 ).clone( true ); + + if ( this[ 0 ].parentNode ) { + wrap.insertBefore( this[ 0 ] ); + } + + wrap.map( function() { + var elem = this; + + while ( elem.firstElementChild ) { + elem = elem.firstElementChild; + } + + return elem; + } ).append( this ); + } + + return this; + }, + + wrapInner: function( html ) { + if ( jQuery.isFunction( html ) ) { + return this.each( function( i ) { + jQuery( this ).wrapInner( html.call( this, i ) ); + } ); + } + + return this.each( function() { + var self = jQuery( this ), + contents = self.contents(); + + if ( contents.length ) { + contents.wrapAll( html ); + + } else { + self.append( html ); + } + } ); + }, + + wrap: function( html ) { + var isFunction = jQuery.isFunction( html ); + + return this.each( function( i ) { + jQuery( this ).wrapAll( isFunction ? html.call( this, i ) : html ); + } ); + }, + + unwrap: function( selector ) { + this.parent( selector ).not( "body" ).each( function() { + jQuery( this ).replaceWith( this.childNodes ); + } ); + return this; + } +} ); + + +jQuery.expr.pseudos.hidden = function( elem ) { + return !jQuery.expr.pseudos.visible( elem ); +}; +jQuery.expr.pseudos.visible = function( elem ) { + return !!( elem.offsetWidth || elem.offsetHeight || elem.getClientRects().length ); +}; + + + + +jQuery.ajaxSettings.xhr = function() { + try { + return new window.XMLHttpRequest(); + } catch ( e ) {} +}; + +var xhrSuccessStatus = { + + // File protocol always yields status code 0, assume 200 + 0: 200, + + // Support: IE <=9 only + // #1450: sometimes IE returns 1223 when it should be 204 + 1223: 204 + }, + xhrSupported = jQuery.ajaxSettings.xhr(); + +support.cors = !!xhrSupported && ( "withCredentials" in xhrSupported ); +support.ajax = xhrSupported = !!xhrSupported; + +jQuery.ajaxTransport( function( options ) { + var callback, errorCallback; + + // Cross domain only allowed if supported through XMLHttpRequest + if ( support.cors || xhrSupported && !options.crossDomain ) { + return { + send: function( headers, complete ) { + var i, + xhr = options.xhr(); + + xhr.open( + options.type, + options.url, + options.async, + options.username, + options.password + ); + + // Apply custom fields if provided + if ( options.xhrFields ) { + for ( i in options.xhrFields ) { + xhr[ i ] = options.xhrFields[ i ]; + } + } + + // Override mime type if needed + if ( options.mimeType && xhr.overrideMimeType ) { + xhr.overrideMimeType( options.mimeType ); + } + + // X-Requested-With header + // For cross-domain requests, seeing as conditions for a preflight are + // akin to a jigsaw puzzle, we simply never set it to be sure. + // (it can always be set on a per-request basis or even using ajaxSetup) + // For same-domain requests, won't change header if already provided. + if ( !options.crossDomain && !headers[ "X-Requested-With" ] ) { + headers[ "X-Requested-With" ] = "XMLHttpRequest"; + } + + // Set headers + for ( i in headers ) { + xhr.setRequestHeader( i, headers[ i ] ); + } + + // Callback + callback = function( type ) { + return function() { + if ( callback ) { + callback = errorCallback = xhr.onload = + xhr.onerror = xhr.onabort = xhr.onreadystatechange = null; + + if ( type === "abort" ) { + xhr.abort(); + } else if ( type === "error" ) { + + // Support: IE <=9 only + // On a manual native abort, IE9 throws + // errors on any property access that is not readyState + if ( typeof xhr.status !== "number" ) { + complete( 0, "error" ); + } else { + complete( + + // File: protocol always yields status 0; see #8605, #14207 + xhr.status, + xhr.statusText + ); + } + } else { + complete( + xhrSuccessStatus[ xhr.status ] || xhr.status, + xhr.statusText, + + // Support: IE <=9 only + // IE9 has no XHR2 but throws on binary (trac-11426) + // For XHR2 non-text, let the caller handle it (gh-2498) + ( xhr.responseType || "text" ) !== "text" || + typeof xhr.responseText !== "string" ? + { binary: xhr.response } : + { text: xhr.responseText }, + xhr.getAllResponseHeaders() + ); + } + } + }; + }; + + // Listen to events + xhr.onload = callback(); + errorCallback = xhr.onerror = callback( "error" ); + + // Support: IE 9 only + // Use onreadystatechange to replace onabort + // to handle uncaught aborts + if ( xhr.onabort !== undefined ) { + xhr.onabort = errorCallback; + } else { + xhr.onreadystatechange = function() { + + // Check readyState before timeout as it changes + if ( xhr.readyState === 4 ) { + + // Allow onerror to be called first, + // but that will not handle a native abort + // Also, save errorCallback to a variable + // as xhr.onerror cannot be accessed + window.setTimeout( function() { + if ( callback ) { + errorCallback(); + } + } ); + } + }; + } + + // Create the abort callback + callback = callback( "abort" ); + + try { + + // Do send the request (this may raise an exception) + xhr.send( options.hasContent && options.data || null ); + } catch ( e ) { + + // #14683: Only rethrow if this hasn't been notified as an error yet + if ( callback ) { + throw e; + } + } + }, + + abort: function() { + if ( callback ) { + callback(); + } + } + }; + } +} ); + + + + +// Prevent auto-execution of scripts when no explicit dataType was provided (See gh-2432) +jQuery.ajaxPrefilter( function( s ) { + if ( s.crossDomain ) { + s.contents.script = false; + } +} ); + +// Install script dataType +jQuery.ajaxSetup( { + accepts: { + script: "text/javascript, application/javascript, " + + "application/ecmascript, application/x-ecmascript" + }, + contents: { + script: /\b(?:java|ecma)script\b/ + }, + converters: { + "text script": function( text ) { + jQuery.globalEval( text ); + return text; + } + } +} ); + +// Handle cache's special case and crossDomain +jQuery.ajaxPrefilter( "script", function( s ) { + if ( s.cache === undefined ) { + s.cache = false; + } + if ( s.crossDomain ) { + s.type = "GET"; + } +} ); + +// Bind script tag hack transport +jQuery.ajaxTransport( "script", function( s ) { + + // This transport only deals with cross domain requests + if ( s.crossDomain ) { + var script, callback; + return { + send: function( _, complete ) { + script = jQuery( " + + + + + + + + + + + + + + + + + +
+
+
+
+ + + + +
+
+
+ +
+
+
+ ©2018, CEA. + + | + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 + + | + 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..a4a265f --- /dev/null +++ b/doc/build/html/commands/apidoc/src.colorama.html @@ -0,0 +1,676 @@ + + + + + + + + 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 0x4986ff0>¶
+
+ +
+
+ANSI_OSC_RE = <_sre.SRE_Pattern object at 0x44e4620>¶
+
+ +
+
+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]¶
+
+ +
+ +
+
+ + +
+
+
+ +
+
+
+ ©2018, CEA. + + | + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 + + | + 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..3ad8fcf --- /dev/null +++ b/doc/build/html/commands/apidoc/src.html @@ -0,0 +1,5015 @@ + + + + + + + + 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 0x37b8f90>, 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 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(name, 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
    • +
+
+
+ +
+
+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
    • +
+
+
+ +
+
+get(name)[source]¶
+

Get the value of the environment variable “key”

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

Check if the key exists in the environment

+ +++ + + + +
Parameters:str (key) – the environment variable to check
+
+ +
+
+prepend(name, 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
    • +
+
+
+ +
+
+run_env_script(module, script)[source]¶
+
+ +
+
+set(name, value)[source]¶
+

Set the environment variable ‘key’ to value ‘value’

+ +++ + + + +
Parameters:
    +
  • str (value) – the environment variable to set
    • +
  • str – the value
    • +
+
+
+ +
+
+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.

+
+ +
+
+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

+
+ +
+
+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

+
+ +
+
+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.

+
+ +
+
+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 0x36fa5f0>)[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]¶
+
+ +
+ +
+
+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

+
+ +
+
+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 0x37f8420>¶
+
+ +
+ +
+
+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
    • +
+
+
+ +
+ +
+ + +
+
+
+ +
+
+
+ ©2018, CEA. + + | + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 + + | + 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..0e987b8 --- /dev/null +++ b/doc/build/html/commands/application.html @@ -0,0 +1,160 @@ + + + + + + + + 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.
      • +
    +
    • +
+
+
+ + +
+
+
+ +
+
+
+ ©2018, CEA. + + | + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 + + | + 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..61bdc22 --- /dev/null +++ b/doc/build/html/commands/clean.html @@ -0,0 +1,161 @@ + + + + + + + + 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.

+
+
+ + +
+
+
+ +
+
+
+ ©2018, CEA. + + | + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 + + | + 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..c3c5d05 --- /dev/null +++ b/doc/build/html/commands/compile.html @@ -0,0 +1,194 @@ + + + + + + + + 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.
    • +
+
+
+
+ + +
+
+
+ +
+
+
+ ©2018, CEA. + + | + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 + + | + 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..e2d8291 --- /dev/null +++ b/doc/build/html/commands/config.html @@ -0,0 +1,194 @@ + + + + + + + + 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
+
+
+
+
+ + +
+
+
+ +
+
+
+ ©2018, CEA. + + | + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 + + | + 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..7a32af2 --- /dev/null +++ b/doc/build/html/commands/environ.html @@ -0,0 +1,229 @@ + + + + + + + + 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.
    • +
+
+
+ + +
+
+
+ +
+
+
+ ©2018, CEA. + + | + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 + + | + 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..14f3566 --- /dev/null +++ b/doc/build/html/commands/generate.html @@ -0,0 +1,147 @@ + + + + + + + + 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>
+
    +
    +
    • +
+
+
+ + +
+
+
+ +
+
+
+ ©2018, CEA. + + | + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 + + | + 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..1b3aaf2 --- /dev/null +++ b/doc/build/html/commands/launcher.html @@ -0,0 +1,154 @@ + + + + + + + + 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.
      • +
    +
    • +
+
+
+ + +
+
+
+ +
+
+
+ ©2018, CEA. + + | + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 + + | + 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..11da33c --- /dev/null +++ b/doc/build/html/commands/log.html @@ -0,0 +1,154 @@ + + + + + + + + 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.
      • +
    +
    • +
+
+
+ + +
+
+
+ +
+
+
+ ©2018, CEA. + + | + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 + + | + 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..8ef7236 --- /dev/null +++ b/doc/build/html/commands/package.html @@ -0,0 +1,179 @@ + + + + + + + + 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.

+
+
+ + +
+
+
+ +
+
+
+ ©2018, CEA. + + | + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 + + | + 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..ea6379f --- /dev/null +++ b/doc/build/html/commands/prepare.html @@ -0,0 +1,204 @@ + + + + + + + + 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.
    • +
+
+
+ + +
+
+
+ +
+
+
+ ©2018, CEA. + + | + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 + + | + 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..18c8654 --- /dev/null +++ b/doc/build/html/configuration.html @@ -0,0 +1,192 @@ + + + + + + + + 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
+
+
+
+
+
+ + +
+
+
+ +
+
+
+ ©2018, CEA. + + | + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 + + | + 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..7ddb9d8 --- /dev/null +++ b/doc/build/html/genindex.html @@ -0,0 +1,1406 @@ + + + + + + + + + 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

+ + + +
+ +

B

+ + + +
+ +

C

+ + + +
+ +

D

+ + + +
+ +

E

+ + + +
+ +

F

+ + + +
+ +

G

+ + + +
+ +

H

+ + + +
+ +

I

+ + + +
+ +

K

+ + +
+ +

L

+ + + +
+ +

M

+ + + +
+ +

N

+ + + +
+ +

O

+ + + +
+ +

P

+ + + +
+ +

Q

+ + +
+ +

R

+ + + +
+ +

S

+ + + +
+ +

T

+ + + +
+ +

U

+ + + +
+ +

W

+ + + +
+ +

X

+ + + +
+ +

Y

+ + +
+ + + +
+
+
+ +
+
+
+ ©2018, CEA. + + | + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 + +
+ + + + + + \ 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..9b6a119 --- /dev/null +++ b/doc/build/html/index.html @@ -0,0 +1,170 @@ + + + + + + + + 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.

+

Find a pdf version of this documentation

+ + +
+

Developer documentation¶

+
+ +
+
+
+

Code documentation¶

+
+ +
+
+
+

Release Notes¶

+
+ +
+
+
+ + +
+
+
+ +
+
+
+ ©2018, CEA. + + | + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 + + | + 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..d5977d2 --- /dev/null +++ b/doc/build/html/installation_of_sat.html @@ -0,0 +1,102 @@ + + + + + + + + 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.

+
+ + +
+
+
+ +
+
+
+ ©2018, CEA. + + | + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 + + | + 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..6680337 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..9a2aafa --- /dev/null +++ b/doc/build/html/py-modindex.html @@ -0,0 +1,214 @@ + + + + + + + + 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 +
+ + +
+
+
+ +
+
+
+ ©2018, CEA. + + | + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 + +
+ + + + + + \ 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..ae12e1b --- /dev/null +++ b/doc/build/html/release_notes/release_notes_5.0.0.html @@ -0,0 +1,94 @@ + + + + + + + + Release notes — salomeTools 5.0.0dev documentation + + + + + + + + + + + + + + + + + + + +
+
+
+
+ +
+

Release notes¶

+

In construction.

+
+ + +
+
+
+ +
+
+
+ ©2018, CEA. + + | + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 + + | + 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..6ddceb1 --- /dev/null +++ b/doc/build/html/search.html @@ -0,0 +1,96 @@ + + + + + + + + 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. +

+
+ + + +
+ +
+ +
+ +
+
+
+ +
+
+
+ ©2018, CEA. + + | + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 + +
+ + + + + + \ 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..84b13f2 --- /dev/null +++ b/doc/build/html/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({docnames:["commands/apidoc/modules","commands/apidoc/src","commands/apidoc/src.colorama","commands/application","commands/clean","commands/compile","commands/config","commands/environ","commands/generate","commands/launcher","commands/log","commands/package","commands/prepare","configuration","index","installation_of_sat","release_notes/release_notes_5.0.0","usage_of_sat","write_command"],envversion:52,filenames:["commands/apidoc/modules.rst","commands/apidoc/src.rst","commands/apidoc/src.colorama.rst","commands/application.rst","commands/clean.rst","commands/compile.rst","commands/config.rst","commands/environ.rst","commands/generate.rst","commands/launcher.rst","commands/log.rst","commands/package.rst","commands/prepare.rst","configuration.rst","index.rst","installation_of_sat.rst","release_notes/release_notes_5.0.0.rst","usage_of_sat.rst","write_command.rst"],objects:{"src.ElementTree":{Comment:[1,1,1,""],Element:[1,1,1,""],ElementTree:[1,2,1,""],PI:[1,1,1,""],ProcessingInstruction:[1,1,1,""],QName:[1,2,1,""],SubElement:[1,1,1,""],TreeBuilder:[1,2,1,""],XML:[1,1,1,""],XMLTreeBuilder:[1,2,1,""],dump:[1,1,1,""],fromstring:[1,1,1,""],iselement:[1,1,1,""],iterparse:[1,2,1,""],parse:[1,1,1,""],tostring:[1,1,1,""]},"src.ElementTree.ElementTree":{find:[1,3,1,""],findall:[1,3,1,""],findtext:[1,3,1,""],getiterator:[1,3,1,""],getroot:[1,3,1,""],parse:[1,3,1,""],write:[1,3,1,""]},"src.ElementTree.TreeBuilder":{close:[1,3,1,""],data:[1,3,1,""],end:[1,3,1,""],start:[1,3,1,""]},"src.ElementTree.XMLTreeBuilder":{close:[1,3,1,""],doctype:[1,3,1,""],feed:[1,3,1,""]},"src.ElementTree.iterparse":{next:[1,3,1,""]},"src.__init__":{Path:[1,2,1,""],SatException:[1,4,1,""],activate_mesa_property:[1,1,1,""],check_config_has_application:[1,1,1,""],check_config_has_profile:[1,1,1,""],config_has_application:[1,1,1,""],deepcopy_list:[1,1,1,""],ensure_path_exists:[1,1,1,""],find_file_in_lpath:[1,1,1,""],get_base_path:[1,1,1,""],get_cfg_param:[1,1,1,""],get_launcher_name:[1,1,1,""],get_log_path:[1,1,1,""],get_property_in_product_cfg:[1,1,1,""],get_salome_version:[1,1,1,""],get_tmp_filename:[1,1,1,""],handleRemoveReadonly:[1,1,1,""],merge_dicts:[1,1,1,""],only_numbers:[1,1,1,""],parse_date:[1,1,1,""],print_info:[1,1,1,""],read_config_from_a_file:[1,1,1,""],remove_item_from_list:[1,1,1,""],replace_in_file:[1,1,1,""]},"src.__init__.Path":{base:[1,3,1,""],chmod:[1,3,1,""],copy:[1,3,1,""],copydir:[1,3,1,""],copyfile:[1,3,1,""],copylink:[1,3,1,""],dir:[1,3,1,""],exists:[1,3,1,""],isdir:[1,3,1,""],isfile:[1,3,1,""],islink:[1,3,1,""],list:[1,3,1,""],make:[1,3,1,""],readlink:[1,3,1,""],rm:[1,3,1,""],smartcopy:[1,3,1,""],symlink:[1,3,1,""]},"src.architecture":{get_distrib_version:[1,1,1,""],get_distribution:[1,1,1,""],get_nb_proc:[1,1,1,""],get_python_version:[1,1,1,""],get_user:[1,1,1,""],is_windows:[1,1,1,""]},"src.colorama":{ansi:[2,0,0,"-"],ansitowin32:[2,0,0,"-"],initialise:[2,0,0,"-"],win32:[2,0,0,"-"],winterm:[2,0,0,"-"]},"src.colorama.ansi":{AnsiBack:[2,2,1,""],AnsiCodes:[2,2,1,""],AnsiCursor:[2,2,1,""],AnsiFore:[2,2,1,""],AnsiStyle:[2,2,1,""],clear_line:[2,1,1,""],clear_screen:[2,1,1,""],code_to_chars:[2,1,1,""],set_title:[2,1,1,""]},"src.colorama.ansi.AnsiBack":{BLACK:[2,5,1,""],BLUE:[2,5,1,""],CYAN:[2,5,1,""],GREEN:[2,5,1,""],LIGHTBLACK_EX:[2,5,1,""],LIGHTBLUE_EX:[2,5,1,""],LIGHTCYAN_EX:[2,5,1,""],LIGHTGREEN_EX:[2,5,1,""],LIGHTMAGENTA_EX:[2,5,1,""],LIGHTRED_EX:[2,5,1,""],LIGHTWHITE_EX:[2,5,1,""],LIGHTYELLOW_EX:[2,5,1,""],MAGENTA:[2,5,1,""],RED:[2,5,1,""],RESET:[2,5,1,""],WHITE:[2,5,1,""],YELLOW:[2,5,1,""]},"src.colorama.ansi.AnsiCursor":{BACK:[2,3,1,""],DOWN:[2,3,1,""],FORWARD:[2,3,1,""],POS:[2,3,1,""],UP:[2,3,1,""]},"src.colorama.ansi.AnsiFore":{BLACK:[2,5,1,""],BLUE:[2,5,1,""],CYAN:[2,5,1,""],GREEN:[2,5,1,""],LIGHTBLACK_EX:[2,5,1,""],LIGHTBLUE_EX:[2,5,1,""],LIGHTCYAN_EX:[2,5,1,""],LIGHTGREEN_EX:[2,5,1,""],LIGHTMAGENTA_EX:[2,5,1,""],LIGHTRED_EX:[2,5,1,""],LIGHTWHITE_EX:[2,5,1,""],LIGHTYELLOW_EX:[2,5,1,""],MAGENTA:[2,5,1,""],RED:[2,5,1,""],RESET:[2,5,1,""],WHITE:[2,5,1,""],YELLOW:[2,5,1,""]},"src.colorama.ansi.AnsiStyle":{BRIGHT:[2,5,1,""],DIM:[2,5,1,""],NORMAL:[2,5,1,""],RESET_ALL:[2,5,1,""]},"src.colorama.ansitowin32":{AnsiToWin32:[2,2,1,""],StreamWrapper:[2,2,1,""],is_a_tty:[2,1,1,""],is_stream_closed:[2,1,1,""]},"src.colorama.ansitowin32.AnsiToWin32":{ANSI_CSI_RE:[2,5,1,""],ANSI_OSC_RE:[2,5,1,""],call_win32:[2,3,1,""],convert_ansi:[2,3,1,""],convert_osc:[2,3,1,""],extract_params:[2,3,1,""],get_win32_calls:[2,3,1,""],reset_all:[2,3,1,""],should_wrap:[2,3,1,""],write:[2,3,1,""],write_and_convert:[2,3,1,""],write_plain_text:[2,3,1,""]},"src.colorama.ansitowin32.StreamWrapper":{write:[2,3,1,""]},"src.colorama.initialise":{colorama_text:[2,1,1,""],deinit:[2,1,1,""],init:[2,1,1,""],reinit:[2,1,1,""],reset_all:[2,1,1,""],wrap_stream:[2,1,1,""]},"src.colorama.win32":{SetConsoleTextAttribute:[2,1,1,""],winapi_test:[2,1,1,""]},"src.colorama.winterm":{WinColor:[2,2,1,""],WinStyle:[2,2,1,""],WinTerm:[2,2,1,""]},"src.colorama.winterm.WinColor":{BLACK:[2,5,1,""],BLUE:[2,5,1,""],CYAN:[2,5,1,""],GREEN:[2,5,1,""],GREY:[2,5,1,""],MAGENTA:[2,5,1,""],RED:[2,5,1,""],YELLOW:[2,5,1,""]},"src.colorama.winterm.WinStyle":{BRIGHT:[2,5,1,""],BRIGHT_BACKGROUND:[2,5,1,""],NORMAL:[2,5,1,""]},"src.colorama.winterm.WinTerm":{back:[2,3,1,""],cursor_adjust:[2,3,1,""],erase_line:[2,3,1,""],erase_screen:[2,3,1,""],fore:[2,3,1,""],get_attrs:[2,3,1,""],get_position:[2,3,1,""],reset_all:[2,3,1,""],set_attrs:[2,3,1,""],set_console:[2,3,1,""],set_cursor_position:[2,3,1,""],set_title:[2,3,1,""],style:[2,3,1,""]},"src.compilation":{Builder:[1,2,1,""]},"src.compilation.Builder":{build_configure:[1,3,1,""],check:[1,3,1,""],cmake:[1,3,1,""],complete_environment:[1,3,1,""],configure:[1,3,1,""],do_batch_script_build:[1,3,1,""],do_default_build:[1,3,1,""],do_python_script_build:[1,3,1,""],do_script_build:[1,3,1,""],hack_libtool:[1,3,1,""],install:[1,3,1,""],log:[1,3,1,""],log_command:[1,3,1,""],make:[1,3,1,""],prepare:[1,3,1,""],put_txt_log_in_appli_log_dir:[1,3,1,""],wmake:[1,3,1,""]},"src.debug":{InStream:[1,2,1,""],OutStream:[1,2,1,""],getLocalEnv:[1,1,1,""],getStrConfigDbg:[1,1,1,""],getStrConfigStd:[1,1,1,""],indent:[1,1,1,""],pop_debug:[1,1,1,""],push_debug:[1,1,1,""],saveConfigDbg:[1,1,1,""],saveConfigStd:[1,1,1,""],tofix:[1,1,1,""],write:[1,1,1,""]},"src.debug.OutStream":{close:[1,3,1,""]},"src.environment":{Environ:[1,2,1,""],FileEnvWriter:[1,2,1,""],SalomeEnviron:[1,2,1,""],Shell:[1,2,1,""],load_environment:[1,1,1,""]},"src.environment.Environ":{append:[1,3,1,""],append_value:[1,3,1,""],command_value:[1,3,1,""],get:[1,3,1,""],is_defined:[1,3,1,""],prepend:[1,3,1,""],prepend_value:[1,3,1,""],set:[1,3,1,""]},"src.environment.FileEnvWriter":{write_cfgForPy_file:[1,3,1,""],write_env_file:[1,3,1,""]},"src.environment.SalomeEnviron":{add_comment:[1,3,1,""],add_line:[1,3,1,""],add_warning:[1,3,1,""],append:[1,3,1,""],dump:[1,3,1,""],finish:[1,3,1,""],get:[1,3,1,""],get_names:[1,3,1,""],is_defined:[1,3,1,""],load_cfg_environment:[1,3,1,""],prepend:[1,3,1,""],run_env_script:[1,3,1,""],run_simple_env_script:[1,3,1,""],set:[1,3,1,""],set_a_product:[1,3,1,""],set_application_env:[1,3,1,""],set_cpp_env:[1,3,1,""],set_full_environ:[1,3,1,""],set_products:[1,3,1,""],set_python_libdirs:[1,3,1,""],set_salome_generic_product_env:[1,3,1,""],set_salome_minimal_product_env:[1,3,1,""]},"src.fileEnviron":{BashFileEnviron:[1,2,1,""],BatFileEnviron:[1,2,1,""],ContextFileEnviron:[1,2,1,""],FileEnviron:[1,2,1,""],LauncherFileEnviron:[1,2,1,""],ScreenEnviron:[1,2,1,""],get_file_environ:[1,1,1,""],special_path_separator:[1,1,1,""]},"src.fileEnviron.BashFileEnviron":{command_value:[1,3,1,""],finish:[1,3,1,""],set:[1,3,1,""]},"src.fileEnviron.BatFileEnviron":{add_comment:[1,3,1,""],command_value:[1,3,1,""],finish:[1,3,1,""],get:[1,3,1,""],set:[1,3,1,""]},"src.fileEnviron.ContextFileEnviron":{add_echo:[1,3,1,""],add_warning:[1,3,1,""],append_value:[1,3,1,""],command_value:[1,3,1,""],finish:[1,3,1,""],get:[1,3,1,""],prepend_value:[1,3,1,""],set:[1,3,1,""]},"src.fileEnviron.FileEnviron":{add_comment:[1,3,1,""],add_echo:[1,3,1,""],add_line:[1,3,1,""],add_warning:[1,3,1,""],append:[1,3,1,""],append_value:[1,3,1,""],command_value:[1,3,1,""],finish:[1,3,1,""],get:[1,3,1,""],is_defined:[1,3,1,""],prepend:[1,3,1,""],prepend_value:[1,3,1,""],set:[1,3,1,""]},"src.fileEnviron.LauncherFileEnviron":{add:[1,3,1,""],add_comment:[1,3,1,""],add_echo:[1,3,1,""],add_line:[1,3,1,""],add_warning:[1,3,1,""],append:[1,3,1,""],append_value:[1,3,1,""],change_to_launcher:[1,3,1,""],command_value:[1,3,1,""],finish:[1,3,1,""],get:[1,3,1,""],is_defined:[1,3,1,""],prepend:[1,3,1,""],prepend_value:[1,3,1,""],set:[1,3,1,""]},"src.fileEnviron.ScreenEnviron":{add_comment:[1,3,1,""],add_echo:[1,3,1,""],add_line:[1,3,1,""],add_warning:[1,3,1,""],append:[1,3,1,""],command_value:[1,3,1,""],get:[1,3,1,""],is_defined:[1,3,1,""],prepend:[1,3,1,""],run_env_script:[1,3,1,""],set:[1,3,1,""],write:[1,3,1,""]},"src.fork":{batch:[1,1,1,""],batch_salome:[1,1,1,""],launch_command:[1,1,1,""],show_progress:[1,1,1,""],write_back:[1,1,1,""]},"src.logger":{Logger:[1,2,1,""],date_to_datetime:[1,1,1,""],list_log_file:[1,1,1,""],show_command_log:[1,1,1,""],timedelta_total_seconds:[1,1,1,""],update_hat_xml:[1,1,1,""]},"src.logger.Logger":{add_link:[1,3,1,""],end_write:[1,3,1,""],error:[1,3,1,""],flush:[1,3,1,""],put_initial_xml_fields:[1,3,1,""],write:[1,3,1,""]},"src.options":{OptResult:[1,2,1,""],Options:[1,2,1,""]},"src.options.Options":{add_option:[1,3,1,""],parse_args:[1,3,1,""],print_help:[1,3,1,""]},"src.printcolors":{cleancolor:[1,1,1,""],print_color_map:[1,1,1,""],print_color_range:[1,1,1,""],print_value:[1,1,1,""],printc:[1,1,1,""],printcError:[1,1,1,""],printcHeader:[1,1,1,""],printcHighlight:[1,1,1,""],printcInfo:[1,1,1,""],printcLabel:[1,1,1,""],printcSuccess:[1,1,1,""],printcWarning:[1,1,1,""]},"src.product":{check_config_exists:[1,1,1,""],check_installation:[1,1,1,""],check_source:[1,1,1,""],get_base_install_dir:[1,1,1,""],get_install_dir:[1,1,1,""],get_product_components:[1,1,1,""],get_product_config:[1,1,1,""],get_product_dependencies:[1,1,1,""],get_product_section:[1,1,1,""],get_products_infos:[1,1,1,""],product_compiles:[1,1,1,""],product_has_env_script:[1,1,1,""],product_has_logo:[1,1,1,""],product_has_patches:[1,1,1,""],product_has_salome_gui:[1,1,1,""],product_has_script:[1,1,1,""],product_is_autotools:[1,1,1,""],product_is_cmake:[1,1,1,""],product_is_cpp:[1,1,1,""],product_is_debug:[1,1,1,""],product_is_dev:[1,1,1,""],product_is_fixed:[1,1,1,""],product_is_generated:[1,1,1,""],product_is_mpi:[1,1,1,""],product_is_native:[1,1,1,""],product_is_salome:[1,1,1,""],product_is_sample:[1,1,1,""],product_is_smesh_plugin:[1,1,1,""],product_is_vcs:[1,1,1,""]},"src.pyconf":{Config:[1,2,1,""],ConfigError:[1,4,1,""],ConfigFormatError:[1,4,1,""],ConfigInputStream:[1,2,1,""],ConfigList:[1,2,1,""],ConfigMerger:[1,2,1,""],ConfigOutputStream:[1,2,1,""],ConfigReader:[1,2,1,""],ConfigResolutionError:[1,4,1,""],Container:[1,2,1,""],Expression:[1,2,1,""],Mapping:[1,2,1,""],Reference:[1,2,1,""],Sequence:[1,2,1,""],deepCopyMapping:[1,1,1,""],defaultMergeResolve:[1,1,1,""],defaultStreamOpener:[1,1,1,""],isWord:[1,1,1,""],makePath:[1,1,1,""],overwriteMergeResolve:[1,1,1,""]},"src.pyconf.Config":{Namespace:[1,2,1,""],addNamespace:[1,3,1,""],getByPath:[1,3,1,""],load:[1,3,1,""],removeNamespace:[1,3,1,""]},"src.pyconf.ConfigInputStream":{close:[1,3,1,""],read:[1,3,1,""],readline:[1,3,1,""]},"src.pyconf.ConfigList":{getByPath:[1,3,1,""]},"src.pyconf.ConfigMerger":{handleMismatch:[1,3,1,""],merge:[1,3,1,""],mergeMapping:[1,3,1,""],mergeSequence:[1,3,1,""],overwriteKeys:[1,3,1,""]},"src.pyconf.ConfigOutputStream":{close:[1,3,1,""],flush:[1,3,1,""],write:[1,3,1,""]},"src.pyconf.ConfigReader":{getChar:[1,3,1,""],getToken:[1,3,1,""],load:[1,3,1,""],location:[1,3,1,""],match:[1,3,1,""],parseFactor:[1,3,1,""],parseKeyValuePair:[1,3,1,""],parseMapping:[1,3,1,""],parseMappingBody:[1,3,1,""],parseReference:[1,3,1,""],parseScalar:[1,3,1,""],parseSequence:[1,3,1,""],parseSuffix:[1,3,1,""],parseTerm:[1,3,1,""],parseValue:[1,3,1,""],setStream:[1,3,1,""]},"src.pyconf.Container":{evaluate:[1,3,1,""],setPath:[1,3,1,""],writeToStream:[1,3,1,""],writeValue:[1,3,1,""]},"src.pyconf.Expression":{evaluate:[1,3,1,""]},"src.pyconf.Mapping":{addMapping:[1,3,1,""],get:[1,3,1,""],iteritems:[1,3,1,""],iterkeys:[1,3,1,""],keys:[1,3,1,""],writeToStream:[1,3,1,""]},"src.pyconf.Reference":{addElement:[1,3,1,""],findConfig:[1,3,1,""],resolve:[1,3,1,""]},"src.pyconf.Sequence":{SeqIter:[1,2,1,""],append:[1,3,1,""],writeToStream:[1,3,1,""]},"src.pyconf.Sequence.SeqIter":{next:[1,3,1,""]},"src.system":{archive_extract:[1,1,1,""],cvs_extract:[1,1,1,""],git_extract:[1,1,1,""],show_in_editor:[1,1,1,""],svn_extract:[1,1,1,""]},"src.template":{MyTemplate:[1,2,1,""],substitute:[1,1,1,""]},"src.template.MyTemplate":{delimiter:[1,5,1,""],pattern:[1,5,1,""]},"src.test_module":{Test:[1,2,1,""],getTmpDirDEFAULT:[1,1,1,""]},"src.test_module.Test":{generate_launching_commands:[1,3,1,""],generate_script:[1,3,1,""],get_test_timeout:[1,3,1,""],get_tmp_dir:[1,3,1,""],prepare_testbase:[1,3,1,""],prepare_testbase_from_dir:[1,3,1,""],prepare_testbase_from_git:[1,3,1,""],prepare_testbase_from_svn:[1,3,1,""],read_results:[1,3,1,""],run_all_tests:[1,3,1,""],run_grid_tests:[1,3,1,""],run_script:[1,3,1,""],run_session_tests:[1,3,1,""],run_testbase_tests:[1,3,1,""],run_tests:[1,3,1,""],search_known_errors:[1,3,1,""],write_test_margin:[1,3,1,""]},"src.xmlManager":{ReadXmlFile:[1,2,1,""],XmlLogFile:[1,2,1,""],add_simple_node:[1,1,1,""],append_node_attrib:[1,1,1,""],find_node_by_attrib:[1,1,1,""],write_report:[1,1,1,""]},"src.xmlManager.ReadXmlFile":{getRootAttrib:[1,3,1,""],get_attrib:[1,3,1,""],get_node_text:[1,3,1,""]},"src.xmlManager.XmlLogFile":{add_simple_node:[1,3,1,""],append_node_attrib:[1,3,1,""],append_node_text:[1,3,1,""],write_tree:[1,3,1,""]},src:{ElementTree:[1,0,0,"-"],__init__:[1,0,0,"-"],architecture:[1,0,0,"-"],colorama:[2,0,0,"-"],compilation:[1,0,0,"-"],debug:[1,0,0,"-"],environment:[1,0,0,"-"],fileEnviron:[1,0,0,"-"],fork:[1,0,0,"-"],logger:[1,0,0,"-"],options:[1,0,0,"-"],printcolors:[1,0,0,"-"],product:[1,0,0,"-"],pyconf:[1,0,0,"-"],system:[1,0,0,"-"],template:[1,0,0,"-"],test_module:[1,0,0,"-"],xmlManager:[1,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","class","Python class"],"3":["py","method","Python method"],"4":["py","exception","Python exception"],"5":["py","attribute","Python attribute"]},objtypes:{"0":"py:module","1":"py:function","2":"py:class","3":"py:method","4":"py:exception","5":"py:attribute"},terms:{"0x36fa5f0":1,"0x37b8f90":1,"0x37f8420":1,"0x44e4620":2,"0x4986ff0":2,"16be":1,"16le":1,"9abc":1,"boolean":[1,18],"case":1,"char":1,"class":[1,2,18],"default":[1,3,5,6,7,9,10,11,12,17,18],"export":12,"final":[1,6,12],"float":1,"function":[1,2,18],"import":[1,7,18],"int":[1,10],"long":[1,4],"new":[1,12,18],"return":[1,7,18],"short":1,"true":[1,2],"try":1,"var":[1,7,18],And:[1,6,7],But:18,CVS:11,For:[1,7,12,14,18],Has:1,One:1,POS:2,The:[1,3,4,5,6,7,8,9,10,11,12,13,14,17,18],Then:[12,13],There:13,These:7,Theses:4,Use:[3,4,5,6,7,8,9,12],Used:1,Useful:17,VCS:[4,11],__init__:1,__save__:1,__setattr__:1,_appli:3,_blank:1,_build:7,_debug:1,_launch:7,_ld_library_path:7,_sre:[1,2],a_b_c_:1,abool:1,about:[1,13],absolut:11,access:[1,2,10],account:7,act:[1,2],action:1,activ:[1,12],activate_mesa_properti:1,actual:[1,2,15],add:[1,5,14],add_com:1,add_echo:1,add_lin:1,add_link:1,add_opt:[1,18],add_simple_nod:1,add_warn:1,added:1,addel:1,adding:18,addit:[1,5,13],additional_dir:1,additional_env:1,addmap:1,addnamespac:1,adequ:1,adot:1,advanc:1,affect:2,afil:1,after:[1,5,15],again:1,agent:12,aim:1,algorithm:18,all:[1,2,4,6,7,8,12,13,17,18],all_in_termin:1,allow:[1,5,6,8,14,17],alphanumer:1,alreadi:[11,18],also:[1,7,12,13,18],alter:12,amethodtodebug:1,amount:1,ani:[1,2,6,10,12],anoth:[1,13],ansi:[0,1],ansi_csi_r:2,ansi_escape_cod:2,ansi_osc_r:2,ansiback:2,ansicod:2,ansicursor:2,ansifor:2,ansistyl:2,ansitowin32:[0,1],apart:2,api:1,append:[1,7,11],append_node_attrib:1,append_node_text:1,append_valu:1,appli:[1,6,8,12],applic:[1,4,5,6,7,8,9,10,12,14,18],application_nam:3,appropri:1,arch:11,architectur:[0,11,13],archiv:[1,11,12],archive_extract:1,archive_info:12,arg:[1,2,18],arglist:1,argument:[1,18],ascii:1,ask:1,assign:1,assum:1,astream:1,atitl:1,attibut:1,attr:[1,2],attrib:1,attribut:[1,2],authent:12,author:1,automat:[6,7],autoreset:2,autotool:[1,5],avail:6,avari:1,avoid:12,award:1,back:2,backtick:1,base:[1,2,13],bash:[1,7,12],bashfileenviron:1,bat:[1,7],batch:1,batch_salom:1,batfileenviron:1,becaus:1,been:[1,2],befor:[1,5],begin:1,behavior:18,being:1,belong:1,below:7,between:[1,18],bienvenu:1,big:5,bigger:1,bin:7,binari:11,black:2,blogmatrix:1,blue:2,bom:1,bonjour:18,bool:1,both:[1,7,8],bracket:1,branch:12,bright:2,bright_background:2,bring:[8,12],browser:[1,6,10,13],buf:1,build:[1,4,5,7,13],build_conf_opt:1,build_configur:1,build_sourc:5,builder:1,built:1,call:[1,2,7,9,18],call_win32:2,callabl:1,can:[1,3,7,12,13,14,18],cannot:1,care:4,carri:1,catalog:[3,9],cfg:[1,7,18],cfg_env:1,cfgforpi:1,chang:[1,3,17,18],change_to_launch:1,charact:[1,2],charg:9,check:[1,5,7],check_config_exist:1,check_config_has_appl:1,check_config_has_profil:1,check_instal:1,check_sourc:1,check_src:1,checkout:[1,12],chmod:1,choic:6,circumst:1,clash:1,classic:1,clean:[1,5,10,14],clean_al:[5,17],clean_build_aft:5,clean_instal:5,cleancolor:1,clear_lin:2,clear_screen:2,cli:[10,17],cli_:18,client:1,clone:12,close:1,closest:1,cmake:[1,5],cmake_opt:5,cmd:1,co7:11,code:[1,2,7],code_to_char:2,color:[1,2],colorama:[0,1],colorama_text:2,column:1,com:1,come:6,command:[1,2,13,15,17],command_nam:1,command_opt:17,command_r:1,command_valu:1,comment:[1,13],commentari:1,commit:4,common:1,commonli:1,compat:1,compil:[0,7,8,10,12,14],compil_script:5,complementari:7,complet:[5,6,12,13],complete_environ:1,compon:[1,3,8],componon:8,compress:11,comput:[1,8,11],concaten:1,concern:12,config:[1,12,13,14,17],config_has_appl:1,configerror:1,configformaterror:1,configinputstream:1,configlist:1,configmerg:1,configoutputstream:1,configread:1,configresolutionerror:1,configur:[1,14,18],configure_opt:1,configut:3,conflict:1,conform:8,consist:1,consol:1,construct:[1,14,16],contain:[1,13,18],context:[1,17],contextfileenviron:1,continu:1,control:11,convert:2,convert_ansi:2,convert_osc:2,copi:[1,3,6,9,17],copydir:1,copyfil:1,copylink:1,copyright:1,corba:8,correct:1,correl:1,correspond:[1,7,10,12],could:[1,4,7,15],cpp:[1,8],creat:[1,3,4,7,9,11,12,13,14],creation:11,current:[1,6,13,17,18],cursor_adjust:2,cvs:1,cvs_extract:1,cvs_info:12,cvspass:12,cwd:1,cyan:2,dai:1,data:[1,6,18],date:[1,13],date_to_datetim:1,datetim:1,david:1,dbg:1,debug:[0,6,7,12],decid:1,declar:12,deep:1,deepcopy_list:1,deepcopymap:1,def:[1,7,18],default_valu:1,defaultmergeresolv:1,defaultstreamopen:1,defin:[1,4,5,6,7,8,13,18],definit:1,deinit:2,delai:1,delaiapp:1,deleg:2,delet:11,delimit:1,delta:1,depend:[1,5,11],deriv:1,describ:1,descript:[1,18],design:1,destnam:1,detail:1,detar:15,detect:1,determin:1,dev:1,develop:[1,4,6,7,12,18],dict:1,dict_arg:1,dictionari:[1,13],differ:7,dim:2,dir:[1,6,12],dir_info:12,directli:[7,10,15],directori:[1,3,4,5,6,7,9,10,11,12,13,15,17,18],dirpath:1,displai:[1,5,6,10,18],distant:3,distinguish:7,distrib:1,distribut:[1,3,8],divis:1,dixt:1,do_batch_script_build:1,do_default_build:1,do_python_script_build:1,do_script_build:1,doctyp:1,document:[8,13,18],doe:[1,7,12],dollar:1,don:8,done:[7,17],dot:1,dove:1,down:2,download:[1,12],drive:1,dst:1,due:1,dump:1,duplic:5,dure:12,dynam:13,each:[1,3,9,12,13],earlier:1,earliest:1,echo:1,edit:[6,12],editor:[1,6,13],eearch:1,either:[1,7],eleg:1,elem:1,element:1,element_factori:1,elementtre:0,els:[1,18],embed:11,empti:1,enable_simple_env_script:1,enclos:1,encod:1,end:[1,2,7],end_writ:1,ensur:1,ensure_path_exist:1,entri:1,env:7,env_build:7,env_info:1,env_launch:7,env_script:7,environ:[0,8,13,14],equal:5,eras:10,erase_lin:2,erase_screen:2,error:1,etc:[1,13,14],etre:1,eval:1,evalu:1,event:1,everyth:5,exactli:1,exampl:[1,4,5,6,7,11,12,14,17],exc:1,except:[1,12,17],execut:[1,5,12,17],exhaust:[13,17],exist:[1,11,12,17],exot:1,expect:1,explain:7,explicitli:1,explor:6,express:[1,6],extens:[1,18],extra:1,extract:1,extract_param:2,fact:18,factor:1,factori:1,fail:[1,5],fals:[1,2],far:1,favorit:6,feed:1,field:1,file:[1,3,5,6,7,9,10,11,12,13,14,18],file_nam:1,file_path:1,fileenviron:0,fileenvwrit:1,filein:1,filenam:1,filepath:1,filter:4,fin:1,find:[1,6,14,15],find_file_in_lpath:1,find_node_by_attrib:1,findal:1,findconfig:1,findtext:1,finish:1,firefox:[10,13],first:[1,7,12,18],fix:1,flag:5,flush:1,fmt:1,follow:[1,7,18],for_packag:1,forbuild:1,forc:[1,11,12],force_patch:12,fore:2,forget:1,fork:0,form:1,format:[1,7,13],forward:[2,3,9],found:1,four:7,french:18,from:[1,2,6,7,8,11,12,18],from_what:1,fromstr:1,full:1,full_launched_command:1,fun:6,func:1,futur:1,gdb:7,gencat:[3,9],gener:[1,2,3,7,9,14,17],generate_launching_command:1,generate_script:1,generic_opt:17,geom:5,get:[1,6,12,13,18],get_attr:2,get_attrib:1,get_base_install_dir:1,get_base_path:1,get_cfg_param:1,get_distrib_vers:1,get_distribut:1,get_file_environ:1,get_install_dir:1,get_launcher_nam:1,get_log_path:1,get_method:12,get_nam:1,get_nb_proc:1,get_node_text:1,get_posit:2,get_product_compon:1,get_product_config:1,get_product_depend:1,get_product_sect:1,get_products_info:1,get_property_in_product_cfg:1,get_python_vers:1,get_salome_vers:1,get_test_timeout:1,get_tmp_dir:1,get_tmp_filenam:1,get_us:1,get_win32_cal:2,getbypath:1,getchar:1,getiter:1,getlocalenv:1,getroot:1,getrootattrib:1,getstrconfigdbg:1,getstrconfigstd:1,gettmpdir:1,gettmpdirdefault:1,gettoken:1,git:[1,11],git_extract:1,git_info:12,gitconfig:12,give:[1,3,13,18],given:[1,2,3,7,9],global:1,goe:1,green:2,grei:2,grep:6,grid:1,gui:1,hack_libtool:1,had:1,handl:[1,2,7],handlemismatch:1,handleremovereadonli:1,hard:1,harri:1,has:[1,2,7,18],has_salome_hui:1,has_timed_out:1,hat:1,have:[1,3,4,8,9,12],header:1,help:[1,18],helpstr:1,here:[1,7,13,18],hierarchi:1,highlight:1,himself:7,hold:9,home:6,hour:1,how:[1,7,12,13],html:1,http:[1,2],hxx2salom:8,ident:1,identifi:1,ignor:[1,8],ignorelist:1,imag:12,implement:[1,2,7],includ:[1,7,11,13],indent:1,index:1,indic:1,indirect:1,info:[1,6,12],inform:[1,6,11,12,13],init:[1,2],initi:1,initialis:[0,1],inmap:1,input:1,input_list:1,insid:12,instal:[1,4,5,13,14,17],install_dir:7,instanc:[1,2,18],instanti:1,instead:1,instream:1,instruct:[1,13],intal:11,interact:10,interfac:[1,17],intern:1,invalid:1,ioerror:1,iostream:1,is_a_tti:2,is_defin:1,is_salome_modul:[4,7],is_stream_clos:2,is_window:1,isdir:1,isel:1,isfil:1,islink:1,issu:2,isword:1,item:1,iter:1,iteritem:1,iterkei:1,iterpars:1,its:[1,5,6,7,13],ivar:1,jane:1,job:5,join:7,just:[1,5],keep:1,kei:[1,7,12],kernel:[6,17],killsalom:1,know:[1,12],known:11,kwarg:2,kwd:2,label:[1,6],lanch:1,lapack:7,lapack_root_dir:7,last:[1,7,10],last_termin:10,later:11,latter:1,launch:[1,7],launch_command:1,launcher:[1,3,7,14],launcher_nam:9,launcherfileenviron:1,layer:8,ld_library_path:7,left:7,level:[1,17,18],lhs:1,lib:7,librari:1,light:2,lightblack_ex:2,lightblue_ex:2,lightcyan_ex:2,lightgreen_ex:2,lightmagenta_ex:2,lightred_ex:2,lightwhite_ex:2,lightyellow_ex:2,like:[1,2,3,5,6,9,13],line:[1,6,17],link:[1,12],list:[1,3,4,6,9,13],list_log_fil:1,list_of_product:8,listtest:1,llvm:[3,9],load:[1,13],load_cfg_environ:1,load_environ:1,local:6,locat:1,log:[1,5,14,18],log_command:1,log_dir:10,log_file_nam:1,logdir:1,logfilepath:1,logger:0,login:12,logo:[1,9],lome:14,longnam:1,lost:1,lpath:1,lproduct:1,machin:[1,3,8,9,11],machine1:3,machine2:3,machine3:3,magenta:2,mai:12,main:5,make:[1,5],make_flag:5,make_opt:1,makepath:1,manag:[1,6,12],manipul:[1,6],map1:1,map2:1,map:1,match:1,max:1,mechan:[1,7],med:5,memori:[3,9],menu:10,merg:1,merge:1,merge_dict:1,mergemap:1,mergesequ:1,mesa:[1,3,9],messag:[1,18],method:[1,2,5,7,12,18],micro_command:1,minim:1,minut:1,mismatch:1,miss:[3,5],mistak:12,mode:[1,2,4,6,7,10,17],model:18,modifi:[1,7,12],modul:[0,3,5,8,9,12,13,14],mon:1,mond:18,more:[1,17],most:[1,7,18],multi:1,multilin:1,multipl:1,must:[1,18],my_application_directori:3,my_application_nam:3,my_tag:12,mycommand:18,mydebug:1,myoption:18,myspecificnam:11,mytempl:1,name:[1,3,4,6,7,9,11,12,13,17,18],name_nod:1,namespac:1,nativ:[1,7],nb_line:1,nb_proc:[1,5],need:[1,2,3,8,12],new_nam:6,next:1,nfirst:1,no_label:6,node:1,node_nam:1,non:2,none:[1,2],nor:2,normal:[1,2],note:[1,3,7,9,13],noth:[1,11],notimplementederror:1,notion:1,notshowncommand:1,number:[1,3,5,9,10],number_of_proc:1,obj1:1,obj2:1,object:[1,2,13],obtain:1,obvious:1,occur:1,ode:1,old:1,older:10,on_stderr:2,onc:12,one:[1,6],onli:[1,3,4,5,6,7,8,9,10,12,17],only_numb:1,ool:14,open:1,openggl:[3,9],openmpi:1,oper:[1,6,14],operand:1,opt_nb_proc:1,option:[0,2,3,5,6,7,8,9,10,11,12,13,18],optionali:1,optiontyp:1,optresult:1,order:[1,12,13,18],org:2,other:[1,7,11,13],otherwis:[1,12],our:2,out:1,out_dir:1,output:[1,2],outstream:1,overrid:[1,3],overwrit:1,overwritekei:1,overwritemergeresolv:1,overwritten:1,own:1,packag:[0,14,15],page:7,pair:1,param:[1,2],param_nam:1,paramet:[1,6,13,18],parameter_path:6,paramstr:2,paravi:[3,9],parent:1,parma:1,pars:[1,18],parse_arg:[1,18],parse_d:1,parsefactor:1,parsekeyvaluepair:1,parsemap:1,parsemappingbodi:1,parser:[1,18],parserefer:1,parsescalar:1,parsesequ:1,parsesuffix:1,parseterm:1,parsevalu:1,part:[1,3,7,9],particular:1,pass:[1,13,18],passphras:12,password:12,patch:[1,6,12],path:[1,7,9],path_to_catalog:3,path_to_yacsgen:8,pattern:1,pdf:[6,14],pend:4,pendant:1,perform:[12,14],person:6,phase:1,platform:[2,7],pleas:[7,8],plugin:[1,5],pluma:13,point:[1,18],pop_debug:1,popul:1,posit:2,possibl:[1,7,12,18],potenti:1,pprty:1,preced:1,prefer:[6,13],prefix:[1,7,13],prepar:[1,14,18],prepare_testbas:1,prepare_testbase_from_dir:1,prepare_testbase_from_git:1,prepare_testbase_from_svn:1,prepend:[1,7],prepend_valu:1,prereq_dir:7,prerequisit:[7,11,13,14,17],presenc:1,preset:1,pretti:1,previou:1,previous:4,print:[1,2,6,10],print_color_map:1,print_color_rang:1,print_help:1,print_info:1,print_valu:1,printc:1,printcerror:1,printchead:1,printchighlight:1,printcinfo:1,printclabel:1,printcolor:0,printcsuccess:1,printcwarn:1,problem:[1,3,9],procedur:1,process:12,processinginstruct:1,processor:[1,3,9],prod_dir:1,prod_info:1,produc:1,product1:[5,7,12],product2:[5,7,12],product:[0,4,5,6,7,8,9,11,12,14,18],product_cfg:1,product_compil:1,product_has_env_script:1,product_has_logo:1,product_has_patch:1,product_has_salome_gui:1,product_has_script:1,product_info:1,product_is_autotool:1,product_is_cmak:1,product_is_cpp:1,product_is_debug:1,product_is_dev:1,product_is_fix:1,product_is_gener:1,product_is_mpi:1,product_is_n:1,product_is_salom:1,product_is_sampl:1,product_is_smesh_plugin:1,product_is_vc:1,product_nam:1,profil:[1,9],program:1,programmat:7,progress:1,project:[6,7],properti:[1,4,7,8],protocol:[1,3],provid:[1,7,18],proxi:2,pubid:1,push:12,push_debug:1,put:1,put_initial_xml_field:1,put_txt_log_in_appli_log_dir:1,pv_plugin_path:1,pwd:1,pyconf:[0,5,6,7,12,13,18],python:[1,7,9,13,14,15,18],python_config:1,pythonpath:7,pythonpath_:7,qname:1,queri:[3,9],rais:[1,17],rang:1,raw:1,read:1,read_config_from_a_fil:1,read_result:1,reader:1,readi:12,readlin:1,readlink:1,readxmlfil:1,recurs:[1,6],red:[1,2],redefin:1,redirect:1,ref:1,refer:[1,8,13],reflect:1,regard:1,regular:1,reinit:[1,2],rel:[1,11],remain:[10,15],remark:3,remor:8,remot:[1,11],remov:[1,4,5,12],remove_item_from_list:1,removenamespac:1,renam:1,renint:1,replac:[1,3],replace_in_fil:1,report:1,repositori:[1,12],repres:1,represent:1,request:2,requir:[1,2,7,8],reserv:1,reset:2,reset_al:2,resolut:1,resolv:1,resourc:[3,9],respect:7,restor:[1,4],result:1,retriev:1,rhs:1,right:[1,7],root:[1,18],root_nod:1,rootnam:1,rtype:1,run:[1,7,13,14,18],run_all_test:1,run_env_script:1,run_grid_test:1,run_script:1,run_session_test:1,run_simple_env_script:1,run_test:1,run_testbase_test:1,runappli:3,runner:18,ruud:1,sajip:1,salom:[1,3,4,5,6,7,8,9,11,13,15],salome_modul:1,salome_session_serv:1,salome_xx:[4,11,15,17],salome_xx_:11,salomecontext:1,salomeenviron:1,salometool:[1,3,6,7,11,13,14,15],same:1,sampl:[1,17],sat:[1,3,4,5,6,7,8,9,10,11,12,13,14,15,18],satexcept:1,save:7,saveconfigdbg:1,saveconfigstd:1,scalar:1,screenenviron:1,screenonli:1,script:[1,5,6,7,9,13,14,15],script_nam:1,script_path:1,search:1,search_known_error:1,second:[1,7,18],section:[1,3,7,12],secur:12,see:[1,2,13,17],seen:1,select:11,self:1,semant:1,sep:[1,7],separ:1,seq1:1,seq2:1,seq:1,seqit:1,sequenc:[1,2],server:[1,12],servic:18,session:1,set:[1,3,4,7,9,13,14,18],set_a_product:1,set_application_env:1,set_attr:2,set_consol:2,set_cpp_env:1,set_cursor_posit:2,set_env:[1,7],set_env_build:7,set_env_launch:7,set_full_environ:1,set_native_env:[1,7],set_product:1,set_python_libdir:1,set_salome_generic_product_env:1,set_salome_minimal_product_env:1,set_titl:2,setconsoletextattribut:2,setpath:1,setstream:1,sever:[7,13],shallow:1,shell:[1,7],shortcut:1,shortnam:1,should:[1,7,8],should_wrap:2,show:[1,5,10],show_command_log:1,show_desktop:1,show_in_editor:1,show_patch:6,show_progress:1,show_warn:1,showinfo:1,shown:[1,5],sign:1,silent_sysstd:1,similar:1,simpl:[1,17,18],sinc:1,site:1,size:1,smaller:1,smart:1,smartcopi:1,smesh:1,softwar:12,some:[1,7,9,13,18],someon:7,sometim:4,sommeil:1,soon:5,sourc:[1,2,4,6,11,12],sources_without_dev:4,special_path_separ:1,specif:[1,3,4,7,8,9,11,13,17],specifi:[1,3,7,8,9,12],splashscreen:9,src:[2,18],src_root:1,sre_pattern:[1,2],ssh:[3,9,12],stack:17,start:[1,2,3,5,9],statu:1,stderr:1,stdout:[1,2],step:1,stop:5,stop_first_fail:5,store:[1,5,6,10,12,13],str:1,str_num:1,stream:[1,2],streamopen:1,streamorfil:1,streamwrapp:2,strin:1,string:1,stringio:1,strip:2,strout:1,structur:13,stuff:[1,9],style:[1,2],stylesheet:1,sub:[1,13],subclass:1,subel:1,subpackag:0,subsect:7,subset:11,subst_dic:1,substitut:1,subtract:1,success:[1,5],successfulli:1,suffici:7,suffix:1,suit:14,suitabl:1,support:1,supposedli:1,suppress:4,svn:[1,11],svn_extract:1,svn_info:12,symlink:1,syntax:[1,4],sys:1,system:[0,11],tab:1,tabl:1,tag:[1,12],take:[1,4],taken:[1,7],tar:[11,15],target:[1,3,7],tcllibpath:1,templat:0,template_fil:1,temporari:1,term:1,termin:[1,2,5,10,18],test:[1,5,14],test_base_nam:1,test_config:1,test_grid:1,test_modul:0,test_nam:1,test_sess:1,testbas:1,testbase_bas:1,testbase_dir:1,testbase_nam:1,testbase_tag:1,text:[1,2,17],text_or_uri:1,tgz:[11,15],thank:1,thei:[4,6,7,12],them:[2,12],thi:[1,2,3,5,6,7,8,9,11,12,13,14,18],thing:18,those:8,through:[3,7,9,10],thrown:1,time:[1,4,7,12,13],timedelta:1,timedelta_total_second:1,titl:[1,2],tklibpath:1,tmp_working_dir:1,tofix:1,token:1,token_typ:1,token_valu:1,top:1,tostr:1,total_second:1,tout:18,trace:17,transform:1,transpar:2,tree:1,treebuild:1,trust_root_dir:7,tty:2,tupl:1,turn:1,tutori:1,two:[1,7],txt:1,type:[1,12],typeerror:1,unabl:1,unchang:1,unconditionali:[1,17],under:[1,14],underscor:[1,7],unicod:1,unit:5,unless:[2,12],updat:1,update_hat_xml:1,updatehatxml:1,urllib2:1,urlopen:1,usag:[1,14],use:[1,3,5,7,9,10,11,12,13,15],use_mesa:[3,9],used:[1,3,5,6,7,10,11,12,13,14],useful:[7,9,18],user:[1,6,7,10,11,15,17],usernam:1,uses:[1,7,8,12,13],using:[1,2,8],usr:7,usual:[4,8,11,13,15,17],utf:[1,7],util:[1,11,14],valid:1,valu:[1,2,3,4,6,12,13],variabl:[1,7,8,18],vcs:1,verbos:[1,18],verifi:[1,12],version:[1,7,8,11,13,14],via:1,viewer:6,vinai:1,virtual:[1,3],virtual_app:3,visualis:7,wai:[1,5,18],want:[1,4,7,18],warn:[1,5],web:[6,10,13],welcom:1,welkom:1,well:1,were:1,what:[1,4],when:[1,3,7,12,13,18],whenev:1,where:[1,3,5,6,11],which:[1,2,7,8,13,18],white:2,who:8,wiki:2,wikipedia:2,wil:7,win32:[0,1],winapi_test:2,wincolor:2,window:[1,2,7],winstyl:2,winterm:[0,1],with_children:5,with_commerci:1,with_fath:5,with_install_dir:1,with_vc:11,within:7,without:[1,6,12],without_properti:11,wmake:1,word:1,work:[1,6,11,12,13],workdir:[1,3,6,9,11,13,17,18],world:18,would:1,wrap:2,wrap_stream:2,writabl:1,write:[1,2,18],write_and_convert:2,write_back:1,write_cfgforpy_fil:1,write_env_fil:1,write_plain_text:2,write_report:1,write_test_margin:1,write_tre:1,writetostream:1,writevalu:1,written:18,www:1,xa4:1,xc2:1,xml:[1,18],xmllogfil:1,xmlmanag:0,xmlroot:1,xmltreebuild:1,xxx:[4,13],xxx_root_dir:1,xxx_src_dir:1,yacsgen:[1,8],yacsgen_root_dir:8,year:1,yellow:2,yes:[1,4,7,8,12],yet:17,yield:1,you:[1,3,4,7,9,12,14,18],your:[1,7,12,17,18],yourspecificnam:11,yve:1,yyi:13,yyyi:1,yyyymmdd_hhmmss:1,yyyymmdd_hhmmss_namecmd:1,zelaunch:9,zero:1,zerodivideerror:1},titles:["src","src Package","colorama Package","Command application","Command clean","Command compile","Command config","Command environ","Command generate","Command launcher","Command log","Command package","Command prepare","Configuration","Salome Tools","Installation","Release notes","Usage of SAlomeTools","Add a user custom command"],titleterms:{"var":13,VCS:12,access:18,add:18,ansi:2,ansitowin32:2,applic:[3,13],architectur:1,avail:[4,17],base:12,basic:18,build:17,clean:4,code:14,colorama:2,command:[3,4,5,6,7,8,9,10,11,12,14,18],compil:[1,5,17],config:[6,18],configur:[3,4,5,6,7,9,10,11,12,13],custom:18,cvs:12,debug:[1,17],descript:[3,4,5,6,7,8,9,10,11,12,13],dev:12,develop:14,document:14,elementtre:1,environ:[1,7],exampl:18,fileenviron:1,fork:1,gener:8,get:17,git:12,hello:18,help:17,howto:18,initialis:2,instal:15,introduct:18,launcher:9,list:[14,17],log:10,logger:[1,18],mode:12,modul:[1,2],note:[14,16],option:[1,4,17],other:18,packag:[1,2,11],path:[3,4,5,6,10,11,12],prepar:[12,17],printcolor:1,product:[1,13,17],pyconf:1,quick:14,releas:[14,16],remark:[8,12],requir:18,salom:[14,17],salometool:[17,18],sat:17,section:13,some:[3,4,5,6,10,11,12],sourc:17,src:[0,1],start:14,subpackag:1,svn:12,syntax:13,system:1,templat:1,test_modul:1,tool:14,usag:[3,4,5,6,7,8,9,10,11,12,17],useful:[3,4,5,6,10,11,12],user:[13,18],verbos:17,win32:2,winterm:2,xmlmanag:1}}) \ 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..6c926c6 --- /dev/null +++ b/doc/build/html/usage_of_sat.html @@ -0,0 +1,191 @@ + + + + + + + + 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
+
+
+
+
+ + +
+
+
+ +
+
+
+ ©2018, CEA. + + | + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 + + | + 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..ce276e2 --- /dev/null +++ b/doc/build/html/write_command.html @@ -0,0 +1,236 @@ + + + + + + + + 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
+
+
+
+
+ + +
+
+
+ +
+
+
+ ©2018, CEA. + + | + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 + + | + 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..c561680 --- /dev/null +++ b/doc/build/latex/Makefile @@ -0,0 +1,68 @@ +# Makefile for Sphinx LaTeX output + +ALLDOCS = $(basename $(wildcard *.tex)) +ALLPDF = $(addsuffix .pdf,$(ALLDOCS)) +ALLDVI = $(addsuffix .dvi,$(ALLDOCS)) +ALLXDV = +ALLPS = $(addsuffix .ps,$(ALLDOCS)) +ALLIMGS = $(wildcard *.png *.gif *.jpg *.jpeg) + +# Prefix for archive names +ARCHIVEPREFIX = +# Additional LaTeX options (passed via variables in latexmkrc/latexmkjarc file) +export LATEXOPTS = +# Additional latexmk options +LATEXMKOPTS = +# format: pdf or dvi (used only by archive targets) +FMT = pdf + +LATEX = latexmk -dvi +PDFLATEX = latexmk -pdf -dvi- -ps- + + +%.png %.gif %.jpg %.jpeg: FORCE_MAKE + extractbb '$@' + +%.dvi: %.tex FORCE_MAKE + $(LATEX) $(LATEXMKOPTS) '$<' + +%.ps: %.dvi + dvips '$<' + +%.pdf: %.tex FORCE_MAKE + $(PDFLATEX) $(LATEXMKOPTS) '$<' + +all: $(ALLPDF) + +all-dvi: $(ALLDVI) + +all-ps: $(ALLPS) + +all-pdf: $(ALLPDF) + +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) + +gz: tar + gzip -9 < $(ARCHIVEPREFIX)docs-$(FMT).tar > $(ARCHIVEPREFIX)docs-$(FMT).tar.gz + +bz2: tar + bzip2 -9 -k $(ARCHIVEPREFIX)docs-$(FMT).tar + +xz: tar + xz -9 -k $(ARCHIVEPREFIX)docs-$(FMT).tar + +clean: + rm -f *.log *.ind *.aux *.toc *.syn *.idx *.out *.ilg *.pla *.ps *.tar *.tar.gz *.tar.bz2 *.tar.xz $(ALLPDF) $(ALLDVI) $(ALLXDV) *.fls *.fdb_latexmk + +.PHONY: all all-pdf all-dvi all-ps clean zip tar gz bz2 xz +.PHONY: FORCE_MAKE \ No newline at end of file diff --git a/doc/build/latex/footnotehyper-sphinx.sty b/doc/build/latex/footnotehyper-sphinx.sty new file mode 100644 index 0000000..5995f01 --- /dev/null +++ b/doc/build/latex/footnotehyper-sphinx.sty @@ -0,0 +1,269 @@ +\NeedsTeXFormat{LaTeX2e} +\ProvidesPackage{footnotehyper-sphinx}% + [2017/10/27 v1.7 hyperref aware footnote.sty for sphinx (JFB)] +%% +%% Package: footnotehyper-sphinx +%% Version: based on footnotehyper.sty 2017/03/07 v1.0 +%% as available at http://www.ctan.org/pkg/footnotehyper +%% License: the one applying to Sphinx +%% +%% Refer to the PDF documentation at http://www.ctan.org/pkg/footnotehyper for +%% the code comments. +%% +%% Differences: +%% 1. a partial tabulary compatibility layer added (enough for Sphinx mark-up), +%% 2. use of \spx@opt@BeforeFootnote from sphinx.sty, +%% 3. use of \sphinxunactivateextrasandspace from sphinx.sty, +%% 4. macro definition \sphinxfootnotemark, +%% 5. macro definition \sphinxlongtablepatch +%% 6. replaced an \undefined by \@undefined +\DeclareOption*{\PackageWarning{footnotehyper-sphinx}{Option `\CurrentOption' is unknown}}% +\ProcessOptions\relax +\newbox\FNH@notes +\newdimen\FNH@width +\let\FNH@colwidth\columnwidth +\newif\ifFNH@savingnotes +\AtBeginDocument {% + \let\FNH@latex@footnote \footnote + \let\FNH@latex@footnotetext\footnotetext + \let\FNH@H@@footnotetext \@footnotetext + \newenvironment{savenotes} + {\FNH@savenotes\ignorespaces}{\FNH@spewnotes\ignorespacesafterend}% + \let\spewnotes \FNH@spewnotes + \let\footnote \FNH@footnote + \let\footnotetext \FNH@footnotetext + \let\endfootnote \FNH@endfntext + \let\endfootnotetext\FNH@endfntext + \@ifpackageloaded{hyperref} + {\ifHy@hyperfootnotes + \let\FNH@H@@footnotetext\H@@footnotetext + \else + \let\FNH@hyper@fntext\FNH@nohyp@fntext + \fi}% + {\let\FNH@hyper@fntext\FNH@nohyp@fntext}% +}% +\def\FNH@hyper@fntext{\FNH@fntext\FNH@hyper@fntext@i}% +\def\FNH@nohyp@fntext{\FNH@fntext\FNH@nohyp@fntext@i}% +\def\FNH@fntext #1{% + \ifx\ifmeasuring@\@undefined + \expandafter\@secondoftwo\else\expandafter\@firstofone\fi +% these two lines modified for Sphinx (tabulary compatibility): + {\ifmeasuring@\expandafter\@gobbletwo\else\expandafter\@firstofone\fi}% + {\ifx\equation$\expandafter\@gobbletwo\fi #1}%$ +}% +\long\def\FNH@hyper@fntext@i#1{% + \global\setbox\FNH@notes\vbox + {\unvbox\FNH@notes + \FNH@startnote + \@makefntext + {\rule\z@\footnotesep\ignorespaces + \ifHy@nesting\expandafter\ltx@firstoftwo + \else\expandafter\ltx@secondoftwo + \fi + {\expandafter\hyper@@anchor\expandafter{\Hy@footnote@currentHref}{#1}}% + {\Hy@raisedlink + {\expandafter\hyper@@anchor\expandafter{\Hy@footnote@currentHref}% + {\relax}}% + \let\@currentHref\Hy@footnote@currentHref + \let\@currentlabelname\@empty + #1}% + \@finalstrut\strutbox + }% + \FNH@endnote + }% +}% +\long\def\FNH@nohyp@fntext@i#1{% + \global\setbox\FNH@notes\vbox + {\unvbox\FNH@notes + \FNH@startnote + \@makefntext{\rule\z@\footnotesep\ignorespaces#1\@finalstrut\strutbox}% + \FNH@endnote + }% +}% +\def\FNH@startnote{% + \hsize\FNH@colwidth + \interlinepenalty\interfootnotelinepenalty + \reset@font\footnotesize + \floatingpenalty\@MM + \@parboxrestore + \protected@edef\@currentlabel{\csname p@\@mpfn\endcsname\@thefnmark}% + \color@begingroup +}% +\def\FNH@endnote{\color@endgroup}% +\def\FNH@savenotes{% + \begingroup + \ifFNH@savingnotes\else + \FNH@savingnotestrue + \let\@footnotetext \FNH@hyper@fntext + \let\@mpfootnotetext \FNH@hyper@fntext + \let\H@@mpfootnotetext\FNH@nohyp@fntext + \FNH@width\columnwidth + \let\FNH@colwidth\FNH@width + \global\setbox\FNH@notes\box\voidb@x + \let\FNH@thempfn\thempfn + \let\FNH@mpfn\@mpfn + \ifx\@minipagerestore\relax\let\@minipagerestore\@empty\fi + \expandafter\def\expandafter\@minipagerestore\expandafter{% + \@minipagerestore + \let\thempfn\FNH@thempfn + \let\@mpfn\FNH@mpfn + }% + \fi +}% +\def\FNH@spewnotes {% + \endgroup + \ifFNH@savingnotes\else + \ifvoid\FNH@notes\else + \begingroup + \let\@makefntext\@empty + \let\@finalstrut\@gobble + \let\rule\@gobbletwo + \FNH@H@@footnotetext{\unvbox\FNH@notes}% + \endgroup + \fi + \fi +}% +\def\FNH@footnote@envname {footnote}% +\def\FNH@footnotetext@envname{footnotetext}% +\def\FNH@footnote{% +% this line added for Sphinx: + \spx@opt@BeforeFootnote + \ifx\@currenvir\FNH@footnote@envname + \expandafter\FNH@footnoteenv + \else + \expandafter\FNH@latex@footnote + \fi +}% +\def\FNH@footnoteenv{% +% this line added for Sphinx (footnotes in parsed literal blocks): + \catcode13=5 \sphinxunactivateextrasandspace + \@ifnextchar[% + \FNH@footnoteenv@i %] + {\stepcounter\@mpfn + \protected@xdef\@thefnmark{\thempfn}% + \@footnotemark + \def\FNH@endfntext@fntext{\@footnotetext}% + \FNH@startfntext}% +}% +\def\FNH@footnoteenv@i[#1]{% + \begingroup + \csname c@\@mpfn\endcsname #1\relax + \unrestored@protected@xdef\@thefnmark{\thempfn}% + \endgroup + \@footnotemark + \def\FNH@endfntext@fntext{\@footnotetext}% + \FNH@startfntext +}% +\def\FNH@footnotetext{% + \ifx\@currenvir\FNH@footnotetext@envname + \expandafter\FNH@footnotetextenv + \else + \expandafter\FNH@latex@footnotetext + \fi +}% +\def\FNH@footnotetextenv{% + \@ifnextchar[% + \FNH@footnotetextenv@i %] + {\protected@xdef\@thefnmark{\thempfn}% + \def\FNH@endfntext@fntext{\@footnotetext}% + \FNH@startfntext}% +}% +\def\FNH@footnotetextenv@i[#1]{% + \begingroup + \csname c@\@mpfn\endcsname #1\relax + \unrestored@protected@xdef\@thefnmark{\thempfn}% + \endgroup + \ifFNH@savingnotes + \def\FNH@endfntext@fntext{\FNH@nohyp@fntext}% + \else + \def\FNH@endfntext@fntext{\FNH@H@@footnotetext}% + \fi + \FNH@startfntext +}% +\def\FNH@startfntext{% + \setbox\z@\vbox\bgroup + \FNH@startnote + \FNH@prefntext + \rule\z@\footnotesep\ignorespaces +}% +\def\FNH@endfntext {% + \@finalstrut\strutbox + \FNH@postfntext + \FNH@endnote + \egroup + \begingroup + \let\@makefntext\@empty\let\@finalstrut\@gobble\let\rule\@gobbletwo + \FNH@endfntext@fntext {\unvbox\z@}% + \endgroup +}% +\AtBeginDocument{% + \let\FNH@@makefntext\@makefntext + \ifx\@makefntextFB\@undefined + \expandafter\@gobble\else\expandafter\@firstofone\fi + {\ifFBFrenchFootnotes \let\FNH@@makefntext\@makefntextFB \else + \let\FNH@@makefntext\@makefntextORI\fi}% + \expandafter\FNH@check@a\FNH@@makefntext{1.2!3?4,}% + \FNH@@@1.2!3?4,\FNH@@@\relax +}% +\long\def\FNH@check@a #11.2!3?4,#2\FNH@@@#3{% + \ifx\relax#3\expandafter\@firstoftwo\else\expandafter\@secondoftwo\fi + \FNH@bad@makefntext@alert + {\def\FNH@prefntext{#1}\def\FNH@postfntext{#2}\FNH@check@b}% +}% +\def\FNH@check@b #1\relax{% + \expandafter\expandafter\expandafter\FNH@check@c + \expandafter\meaning\expandafter\FNH@prefntext + \meaning\FNH@postfntext1.2!3?4,\FNH@check@c\relax +}% +\def\FNH@check@c #11.2!3?4,#2#3\relax{% + \ifx\FNH@check@c#2\expandafter\@gobble\fi\FNH@bad@makefntext@alert +}% +% slight reformulation for Sphinx +\def\FNH@bad@makefntext@alert{% + \PackageWarningNoLine{footnotehyper-sphinx}% + {Footnotes will be sub-optimal, sorry. This is due to the document class or^^J + some package modifying macro \string\@makefntext.^^J + You can try to report this incompatibility at^^J + https://github.com/sphinx-doc/sphinx with this info:}% + \typeout{\meaning\@makefntext}% + \let\FNH@prefntext\@empty\let\FNH@postfntext\@empty +}% +% this macro from original footnote.sty is not used anymore by Sphinx +% but for simplicity sake let's just keep it as is +\def\makesavenoteenv{\@ifnextchar[\FNH@msne@ii\FNH@msne@i}%] +\def\FNH@msne@i #1{% + \expandafter\let\csname FNH$#1\expandafter\endcsname %$ + \csname #1\endcsname + \expandafter\let\csname endFNH$#1\expandafter\endcsname %$ + \csname end#1\endcsname + \FNH@msne@ii[#1]{FNH$#1}%$ +}% +\def\FNH@msne@ii[#1]#2{% + \expandafter\edef\csname#1\endcsname{% + \noexpand\savenotes + \expandafter\noexpand\csname#2\endcsname + }% + \expandafter\edef\csname end#1\endcsname{% + \expandafter\noexpand\csname end#2\endcsname + \noexpand\expandafter + \noexpand\spewnotes + \noexpand\if@endpe\noexpand\@endpetrue\noexpand\fi + }% +}% +% end of footnotehyper 2017/02/16 v0.99 +% some extras for Sphinx : +% \sphinxfootnotemark: usable in section titles and silently removed from TOCs. +\def\sphinxfootnotemark [#1]% + {\ifx\thepage\relax\else\protect\spx@opt@BeforeFootnote + \protect\footnotemark[#1]\fi}% +\AtBeginDocument{% + % let hyperref less complain + \pdfstringdefDisableCommands{\def\sphinxfootnotemark [#1]{}}% + % to obtain hyperlinked footnotes in longtable environment we must replace + % hyperref's patch of longtable's patch of \@footnotetext by our own + \let\LT@p@ftntext\FNH@hyper@fntext + % this *requires* longtable to be used always wrapped in savenotes environment +}% +\endinput +%% +%% End of file `footnotehyper-sphinx.sty'. diff --git a/doc/build/latex/latexmkjarc b/doc/build/latex/latexmkjarc new file mode 100644 index 0000000..39ea47f --- /dev/null +++ b/doc/build/latex/latexmkjarc @@ -0,0 +1,7 @@ +$latex = 'platex ' . $ENV{'LATEXOPTS'} . ' -kanji=utf8 %O %S'; +$dvipdf = 'dvipdfmx %O -o %D %S'; +$makeindex = 'rm -f %D; mendex -U -f -d %B.dic -s python.ist %S || echo "mendex exited with error code $? (ignoring)" && : >> %D'; +add_cus_dep( "glo", "gls", 0, "makeglo" ); +sub makeglo { + return system( "mendex -J -f -s gglo.ist -o '$_[0].gls' '$_[0].glo'" ); +} diff --git a/doc/build/latex/latexmkrc b/doc/build/latex/latexmkrc new file mode 100644 index 0000000..bba17fa --- /dev/null +++ b/doc/build/latex/latexmkrc @@ -0,0 +1,9 @@ +$latex = 'latex ' . $ENV{'LATEXOPTS'} . ' %O %S'; +$pdflatex = 'pdflatex ' . $ENV{'LATEXOPTS'} . ' %O %S'; +$lualatex = 'lualatex ' . $ENV{'LATEXOPTS'} . ' %O %S'; +$xelatex = 'xelatex --no-pdf ' . $ENV{'LATEXOPTS'} . ' %O %S'; +$makeindex = 'makeindex -s python.ist %O -o %D %S'; +add_cus_dep( "glo", "gls", 0, "makeglo" ); +sub makeglo { + return system( "makeindex -s gglo.ist -o '$_[0].gls' '$_[0].glo'" ); +} \ No newline at end of file diff --git a/doc/build/latex/python.ist b/doc/build/latex/python.ist new file mode 100644 index 0000000..687d26c --- /dev/null +++ b/doc/build/latex/python.ist @@ -0,0 +1,13 @@ +line_max 100 +headings_flag 1 +heading_prefix " \\bigletter " + +preamble "\\begin{sphinxtheindex} +\\def\\bigletter#1{{\\Large\\sffamily#1}\\nopagebreak\\vspace{1mm}} + +" + +postamble "\n\n\\end{sphinxtheindex}\n" + +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..ba5b552 --- /dev/null +++ b/doc/build/latex/salomeTools.aux @@ -0,0 +1,779 @@ +\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: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}{5}{section.1.3}} +\newlabel{usage_of_sat:svn}{{1.3}{5}{Usage of SAlomeTools}{section.1.3}{}} +\newlabel{usage_of_sat:usage-of-salometools}{{1.3}{5}{Usage of SAlomeTools}{section.1.3}{}} +\newlabel{usage_of_sat::doc}{{1.3}{5}{Usage of SAlomeTools}{section.1.3}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {1.3.1}Usage}{5}{subsection.1.3.1}} +\newlabel{usage_of_sat:usage}{{1.3.1}{5}{Usage}{subsection.1.3.1}{}} +\@writefile{toc}{\contentsline {subsubsection}{Options of sat}{5}{subsubsection*.7}} +\newlabel{usage_of_sat:options-of-sat}{{1.3.1}{5}{Options of sat}{subsubsection*.7}{}} +\@writefile{toc}{\contentsline {paragraph}{\sphinxstyleemphasis {\textendash {}help or -h}}{5}{paragraph*.8}} +\newlabel{usage_of_sat:help-or-h}{{1.3.1}{5}{\sphinxstyleemphasis {\textendash {}help or -h}}{paragraph*.8}{}} +\@writefile{toc}{\contentsline {paragraph}{\sphinxstyleemphasis {\textendash {}debug or -g}}{5}{paragraph*.9}} +\newlabel{usage_of_sat:debug-or-g}{{1.3.1}{5}{\sphinxstyleemphasis {\textendash {}debug or -g}}{paragraph*.9}{}} +\@writefile{toc}{\contentsline {paragraph}{\sphinxstyleemphasis {\textendash {}verbose or -v}}{5}{paragraph*.10}} +\newlabel{usage_of_sat:verbose-or-v}{{1.3.1}{5}{\sphinxstyleemphasis {\textendash {}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}{6}{subsubsection*.13}} +\newlabel{usage_of_sat:compile-salome}{{1.3.2}{6}{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}{8}{section.2.1}} +\newlabel{commands/config:svn}{{2.1}{8}{Command config}{section.2.1}{}} +\newlabel{commands/config:command-config}{{2.1}{8}{Command config}{section.2.1}{}} +\newlabel{commands/config::doc}{{2.1}{8}{Command config}{section.2.1}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.1.1}Description}{8}{subsection.2.1.1}} +\newlabel{commands/config:description}{{2.1.1}{8}{Description}{subsection.2.1.1}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.1.2}Usage}{8}{subsection.2.1.2}} +\newlabel{commands/config:usage}{{2.1.2}{8}{Usage}{subsection.2.1.2}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.1.3}Some useful configuration pathes}{9}{subsection.2.1.3}} +\newlabel{commands/config:some-useful-configuration-pathes}{{2.1.3}{9}{Some useful configuration pathes}{subsection.2.1.3}{}} +\@writefile{toc}{\contentsline {section}{\numberline {2.2}Command prepare}{10}{section.2.2}} +\newlabel{commands/prepare:svn}{{2.2}{10}{Command prepare}{section.2.2}{}} +\newlabel{commands/prepare:command-prepare}{{2.2}{10}{Command prepare}{section.2.2}{}} +\newlabel{commands/prepare::doc}{{2.2}{10}{Command prepare}{section.2.2}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.2.1}Description}{10}{subsection.2.2.1}} +\newlabel{commands/prepare:description}{{2.2.1}{10}{Description}{subsection.2.2.1}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.2.2}Remarks}{10}{subsection.2.2.2}} +\newlabel{commands/prepare:remarks}{{2.2.2}{10}{Remarks}{subsection.2.2.2}{}} +\@writefile{toc}{\contentsline {subsubsection}{VCS bases (git, svn, cvs)}{10}{subsubsection*.14}} +\newlabel{commands/prepare:vcs-bases-git-svn-cvs}{{2.2.2}{10}{VCS bases (git, svn, cvs)}{subsubsection*.14}{}} +\@writefile{toc}{\contentsline {subsubsection}{Dev mode}{10}{subsubsection*.15}} +\newlabel{commands/prepare:dev-mode}{{2.2.2}{10}{Dev mode}{subsubsection*.15}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.2.3}Usage}{10}{subsection.2.2.3}} +\newlabel{commands/prepare:usage}{{2.2.3}{10}{Usage}{subsection.2.2.3}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.2.4}Some useful configuration pathes}{11}{subsection.2.2.4}} +\newlabel{commands/prepare:some-useful-configuration-pathes}{{2.2.4}{11}{Some useful configuration pathes}{subsection.2.2.4}{}} +\@writefile{toc}{\contentsline {section}{\numberline {2.3}Command compile}{12}{section.2.3}} +\newlabel{commands/compile:svn}{{2.3}{12}{Command compile}{section.2.3}{}} +\newlabel{commands/compile:command-compile}{{2.3}{12}{Command compile}{section.2.3}{}} +\newlabel{commands/compile::doc}{{2.3}{12}{Command compile}{section.2.3}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.3.1}Description}{12}{subsection.2.3.1}} +\newlabel{commands/compile:description}{{2.3.1}{12}{Description}{subsection.2.3.1}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.3.2}Usage}{12}{subsection.2.3.2}} +\newlabel{commands/compile:usage}{{2.3.2}{12}{Usage}{subsection.2.3.2}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.3.3}Some useful configuration pathes}{13}{subsection.2.3.3}} +\newlabel{commands/compile:some-useful-configuration-pathes}{{2.3.3}{13}{Some useful configuration pathes}{subsection.2.3.3}{}} +\@writefile{toc}{\contentsline {section}{\numberline {2.4}Command launcher}{14}{section.2.4}} +\newlabel{commands/launcher:svn}{{2.4}{14}{Command launcher}{section.2.4}{}} +\newlabel{commands/launcher:command-launcher}{{2.4}{14}{Command launcher}{section.2.4}{}} +\newlabel{commands/launcher::doc}{{2.4}{14}{Command launcher}{section.2.4}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.4.1}Description}{14}{subsection.2.4.1}} +\newlabel{commands/launcher:description}{{2.4.1}{14}{Description}{subsection.2.4.1}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.4.2}Usage}{14}{subsection.2.4.2}} +\newlabel{commands/launcher:usage}{{2.4.2}{14}{Usage}{subsection.2.4.2}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.4.3}Configuration}{14}{subsection.2.4.3}} +\newlabel{commands/launcher:configuration}{{2.4.3}{14}{Configuration}{subsection.2.4.3}{}} +\@writefile{toc}{\contentsline {section}{\numberline {2.5}Command application}{15}{section.2.5}} +\newlabel{commands/application:svn}{{2.5}{15}{Command application}{section.2.5}{}} +\newlabel{commands/application::doc}{{2.5}{15}{Command application}{section.2.5}{}} +\newlabel{commands/application:command-application}{{2.5}{15}{Command application}{section.2.5}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.5.1}Description}{15}{subsection.2.5.1}} +\newlabel{commands/application:description}{{2.5.1}{15}{Description}{subsection.2.5.1}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.5.2}Usage}{15}{subsection.2.5.2}} +\newlabel{commands/application:usage}{{2.5.2}{15}{Usage}{subsection.2.5.2}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.5.3}Some useful configuration pathes}{15}{subsection.2.5.3}} +\newlabel{commands/application:some-useful-configuration-pathes}{{2.5.3}{15}{Some useful configuration pathes}{subsection.2.5.3}{}} +\@writefile{toc}{\contentsline {section}{\numberline {2.6}Command log}{16}{section.2.6}} +\newlabel{commands/log:svn}{{2.6}{16}{Command log}{section.2.6}{}} +\newlabel{commands/log:command-log}{{2.6}{16}{Command log}{section.2.6}{}} +\newlabel{commands/log::doc}{{2.6}{16}{Command log}{section.2.6}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.6.1}Description}{16}{subsection.2.6.1}} +\newlabel{commands/log:description}{{2.6.1}{16}{Description}{subsection.2.6.1}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.6.2}Usage}{16}{subsection.2.6.2}} +\newlabel{commands/log:usage}{{2.6.2}{16}{Usage}{subsection.2.6.2}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.6.3}Some useful configuration pathes}{16}{subsection.2.6.3}} +\newlabel{commands/log:some-useful-configuration-pathes}{{2.6.3}{16}{Some useful configuration pathes}{subsection.2.6.3}{}} +\@writefile{toc}{\contentsline {section}{\numberline {2.7}Command environ}{17}{section.2.7}} +\newlabel{commands/environ:svn}{{2.7}{17}{Command environ}{section.2.7}{}} +\newlabel{commands/environ:command-environ}{{2.7}{17}{Command environ}{section.2.7}{}} +\newlabel{commands/environ::doc}{{2.7}{17}{Command environ}{section.2.7}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.7.1}Description}{17}{subsection.2.7.1}} +\newlabel{commands/environ:description}{{2.7.1}{17}{Description}{subsection.2.7.1}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.7.2}Usage}{17}{subsection.2.7.2}} +\newlabel{commands/environ:usage}{{2.7.2}{17}{Usage}{subsection.2.7.2}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.7.3}Configuration}{17}{subsection.2.7.3}} +\newlabel{commands/environ:configuration}{{2.7.3}{17}{Configuration}{subsection.2.7.3}{}} +\@writefile{toc}{\contentsline {section}{\numberline {2.8}Command clean}{20}{section.2.8}} +\newlabel{commands/clean:svn}{{2.8}{20}{Command clean}{section.2.8}{}} +\newlabel{commands/clean:command-clean}{{2.8}{20}{Command clean}{section.2.8}{}} +\newlabel{commands/clean::doc}{{2.8}{20}{Command clean}{section.2.8}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.8.1}Description}{20}{subsection.2.8.1}} +\newlabel{commands/clean:description}{{2.8.1}{20}{Description}{subsection.2.8.1}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.8.2}Usage}{20}{subsection.2.8.2}} +\newlabel{commands/clean:usage}{{2.8.2}{20}{Usage}{subsection.2.8.2}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.8.3}Availables options}{20}{subsection.2.8.3}} +\newlabel{commands/clean:availables-options}{{2.8.3}{20}{Availables options}{subsection.2.8.3}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.8.4}Some useful configuration pathes}{20}{subsection.2.8.4}} +\newlabel{commands/clean:some-useful-configuration-pathes}{{2.8.4}{20}{Some useful configuration pathes}{subsection.2.8.4}{}} +\@writefile{toc}{\contentsline {section}{\numberline {2.9}Command package}{21}{section.2.9}} +\newlabel{commands/package:svn}{{2.9}{21}{Command package}{section.2.9}{}} +\newlabel{commands/package:command-package}{{2.9}{21}{Command package}{section.2.9}{}} +\newlabel{commands/package::doc}{{2.9}{21}{Command package}{section.2.9}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.9.1}Description}{21}{subsection.2.9.1}} +\newlabel{commands/package:description}{{2.9.1}{21}{Description}{subsection.2.9.1}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.9.2}Usage}{21}{subsection.2.9.2}} +\newlabel{commands/package:usage}{{2.9.2}{21}{Usage}{subsection.2.9.2}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.9.3}Some useful configuration pathes}{22}{subsection.2.9.3}} +\newlabel{commands/package:some-useful-configuration-pathes}{{2.9.3}{22}{Some useful configuration pathes}{subsection.2.9.3}{}} +\@writefile{toc}{\contentsline {section}{\numberline {2.10}Command generate}{23}{section.2.10}} +\newlabel{commands/generate:svn}{{2.10}{23}{Command generate}{section.2.10}{}} +\newlabel{commands/generate:command-generate}{{2.10}{23}{Command generate}{section.2.10}{}} +\newlabel{commands/generate::doc}{{2.10}{23}{Command generate}{section.2.10}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.10.1}Description}{23}{subsection.2.10.1}} +\newlabel{commands/generate:description}{{2.10.1}{23}{Description}{subsection.2.10.1}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.10.2}Remarks}{23}{subsection.2.10.2}} +\newlabel{commands/generate:remarks}{{2.10.2}{23}{Remarks}{subsection.2.10.2}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.10.3}Usage}{23}{subsection.2.10.3}} +\newlabel{commands/generate:usage}{{2.10.3}{23}{Usage}{subsection.2.10.3}{}} +\@writefile{toc}{\contentsline {chapter}{\numberline {3}Developer documentation}{25}{chapter.3}} +\@writefile{lof}{\addvspace {10\p@ }} +\@writefile{lot}{\addvspace {10\p@ }} +\newlabel{index:developer-documentation}{{3}{25}{Developer documentation}{chapter.3}{}} +\@writefile{toc}{\contentsline {section}{\numberline {3.1}Add a user custom command}{26}{section.3.1}} +\newlabel{write_command:svn}{{3.1}{26}{Add a user custom command}{section.3.1}{}} +\newlabel{write_command:add-a-user-custom-command}{{3.1}{26}{Add a user custom command}{section.3.1}{}} +\newlabel{write_command::doc}{{3.1}{26}{Add a user custom command}{section.3.1}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {3.1.1}Introduction}{26}{subsection.3.1.1}} +\newlabel{write_command:introduction}{{3.1.1}{26}{Introduction}{subsection.3.1.1}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {3.1.2}Basic requirements}{26}{subsection.3.1.2}} +\newlabel{write_command:basic-requirements}{{3.1.2}{26}{Basic requirements}{subsection.3.1.2}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {3.1.3}HowTo access salomeTools config and other commands}{27}{subsection.3.1.3}} +\newlabel{write_command:howto-access-salometools-config-and-other-commands}{{3.1.3}{27}{HowTo access salomeTools config and other commands}{subsection.3.1.3}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {3.1.4}HowTo logger}{27}{subsection.3.1.4}} +\newlabel{write_command:howto-logger}{{3.1.4}{27}{HowTo logger}{subsection.3.1.4}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {3.1.5}HELLO example}{27}{subsection.3.1.5}} +\newlabel{write_command:hello-example}{{3.1.5}{27}{HELLO example}{subsection.3.1.5}{}} +\@writefile{toc}{\contentsline {chapter}{\numberline {4}Code documentation}{29}{chapter.4}} +\@writefile{lof}{\addvspace {10\p@ }} +\@writefile{lot}{\addvspace {10\p@ }} +\newlabel{index:code-documentation}{{4}{29}{Code documentation}{chapter.4}{}} +\@writefile{toc}{\contentsline {section}{\numberline {4.1}src}{29}{section.4.1}} +\newlabel{commands/apidoc/modules:src}{{4.1}{29}{src}{section.4.1}{}} +\newlabel{commands/apidoc/modules::doc}{{4.1}{29}{src}{section.4.1}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {4.1.1}src Package}{29}{subsection.4.1.1}} +\newlabel{commands/apidoc/src::doc}{{4.1.1}{29}{src Package}{subsection.4.1.1}{}} +\newlabel{commands/apidoc/src:src-package}{{4.1.1}{29}{src Package}{subsection.4.1.1}{}} +\@writefile{toc}{\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{29}{subsubsection*.16}} +\newlabel{commands/apidoc/src:id1}{{4.1.1}{29}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{subsubsection*.16}{}} +\newlabel{commands/apidoc/src:module-src.__init__}{{4.1.1}{29}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.17}{}} +\newlabel{commands/apidoc/src:src.__init__.Path}{{4.1.1}{29}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.18}{}} +\newlabel{commands/apidoc/src:src.__init__.Path.base}{{4.1.1}{29}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.19}{}} +\newlabel{commands/apidoc/src:src.__init__.Path.chmod}{{4.1.1}{29}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.20}{}} +\newlabel{commands/apidoc/src:src.__init__.Path.copy}{{4.1.1}{29}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.21}{}} +\newlabel{commands/apidoc/src:src.__init__.Path.copydir}{{4.1.1}{29}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.22}{}} +\newlabel{commands/apidoc/src:src.__init__.Path.copyfile}{{4.1.1}{29}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.23}{}} +\newlabel{commands/apidoc/src:src.__init__.Path.copylink}{{4.1.1}{29}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.24}{}} +\newlabel{commands/apidoc/src:src.__init__.Path.dir}{{4.1.1}{29}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.25}{}} +\newlabel{commands/apidoc/src:src.__init__.Path.exists}{{4.1.1}{29}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.26}{}} +\newlabel{commands/apidoc/src:src.__init__.Path.isdir}{{4.1.1}{29}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.27}{}} +\newlabel{commands/apidoc/src:src.__init__.Path.isfile}{{4.1.1}{29}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.28}{}} +\newlabel{commands/apidoc/src:src.__init__.Path.islink}{{4.1.1}{29}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.29}{}} +\newlabel{commands/apidoc/src:src.__init__.Path.list}{{4.1.1}{29}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.30}{}} +\newlabel{commands/apidoc/src:src.__init__.Path.make}{{4.1.1}{29}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.31}{}} +\newlabel{commands/apidoc/src:src.__init__.Path.readlink}{{4.1.1}{29}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.32}{}} +\newlabel{commands/apidoc/src:src.__init__.Path.rm}{{4.1.1}{29}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.33}{}} +\newlabel{commands/apidoc/src:src.__init__.Path.smartcopy}{{4.1.1}{29}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.34}{}} +\newlabel{commands/apidoc/src:src.__init__.Path.symlink}{{4.1.1}{29}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.35}{}} +\newlabel{commands/apidoc/src:src.__init__.SatException}{{4.1.1}{29}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.36}{}} +\newlabel{commands/apidoc/src:src.__init__.activate_mesa_property}{{4.1.1}{29}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.37}{}} +\newlabel{commands/apidoc/src:src.__init__.check_config_has_application}{{4.1.1}{29}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.38}{}} +\newlabel{commands/apidoc/src:src.__init__.check_config_has_profile}{{4.1.1}{30}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.39}{}} +\newlabel{commands/apidoc/src:src.__init__.config_has_application}{{4.1.1}{30}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.40}{}} +\newlabel{commands/apidoc/src:src.__init__.deepcopy_list}{{4.1.1}{30}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.41}{}} +\newlabel{commands/apidoc/src:src.__init__.ensure_path_exists}{{4.1.1}{30}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.42}{}} +\newlabel{commands/apidoc/src:src.__init__.find_file_in_lpath}{{4.1.1}{30}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.43}{}} +\newlabel{commands/apidoc/src:src.__init__.get_base_path}{{4.1.1}{30}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.44}{}} +\newlabel{commands/apidoc/src:src.__init__.get_cfg_param}{{4.1.1}{30}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.45}{}} +\newlabel{commands/apidoc/src:src.__init__.get_launcher_name}{{4.1.1}{30}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.46}{}} +\newlabel{commands/apidoc/src:src.__init__.get_log_path}{{4.1.1}{31}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.47}{}} +\newlabel{commands/apidoc/src:src.__init__.get_property_in_product_cfg}{{4.1.1}{31}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.48}{}} +\newlabel{commands/apidoc/src:src.__init__.get_salome_version}{{4.1.1}{31}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.49}{}} +\newlabel{commands/apidoc/src:src.__init__.get_tmp_filename}{{4.1.1}{31}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.50}{}} +\newlabel{commands/apidoc/src:src.__init__.handleRemoveReadonly}{{4.1.1}{31}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.51}{}} +\newlabel{commands/apidoc/src:src.__init__.merge_dicts}{{4.1.1}{31}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.52}{}} +\newlabel{commands/apidoc/src:src.__init__.only_numbers}{{4.1.1}{31}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.53}{}} +\newlabel{commands/apidoc/src:src.__init__.parse_date}{{4.1.1}{31}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.54}{}} +\newlabel{commands/apidoc/src:src.__init__.print_info}{{4.1.1}{31}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.55}{}} +\newlabel{commands/apidoc/src:src.__init__.read_config_from_a_file}{{4.1.1}{31}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.56}{}} +\newlabel{commands/apidoc/src:src.__init__.remove_item_from_list}{{4.1.1}{31}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.57}{}} +\newlabel{commands/apidoc/src:src.__init__.replace_in_file}{{4.1.1}{31}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{section*.58}{}} +\@writefile{toc}{\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{31}{subsubsection*.59}} +\newlabel{commands/apidoc/src:elementtree-module}{{4.1.1}{31}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{subsubsection*.59}{}} +\newlabel{commands/apidoc/src:module-src.ElementTree}{{4.1.1}{31}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{subsubsection*.59}{}} +\newlabel{commands/apidoc/src:src.ElementTree.Comment}{{4.1.1}{31}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{section*.60}{}} +\newlabel{commands/apidoc/src:src.ElementTree.dump}{{4.1.1}{31}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{section*.61}{}} +\newlabel{commands/apidoc/src:src.ElementTree.Element}{{4.1.1}{31}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{section*.62}{}} +\newlabel{commands/apidoc/src:src.ElementTree.ElementTree}{{4.1.1}{31}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{section*.63}{}} +\newlabel{commands/apidoc/src:src.ElementTree.ElementTree.find}{{4.1.1}{31}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{section*.64}{}} +\newlabel{commands/apidoc/src:src.ElementTree.ElementTree.findall}{{4.1.1}{31}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{section*.65}{}} +\newlabel{commands/apidoc/src:src.ElementTree.ElementTree.findtext}{{4.1.1}{32}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{section*.66}{}} +\newlabel{commands/apidoc/src:src.ElementTree.ElementTree.getiterator}{{4.1.1}{32}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{section*.67}{}} +\newlabel{commands/apidoc/src:src.ElementTree.ElementTree.getroot}{{4.1.1}{32}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{section*.68}{}} +\newlabel{commands/apidoc/src:src.ElementTree.ElementTree.parse}{{4.1.1}{32}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{section*.69}{}} +\newlabel{commands/apidoc/src:src.ElementTree.ElementTree.write}{{4.1.1}{32}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{section*.70}{}} +\newlabel{commands/apidoc/src:src.ElementTree.fromstring}{{4.1.1}{32}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{section*.71}{}} +\newlabel{commands/apidoc/src:src.ElementTree.iselement}{{4.1.1}{32}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{section*.72}{}} +\newlabel{commands/apidoc/src:src.ElementTree.iterparse}{{4.1.1}{32}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{section*.73}{}} +\newlabel{commands/apidoc/src:src.ElementTree.iterparse.next}{{4.1.1}{32}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{section*.74}{}} +\newlabel{commands/apidoc/src:src.ElementTree.parse}{{4.1.1}{32}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{section*.75}{}} +\newlabel{commands/apidoc/src:src.ElementTree.PI}{{4.1.1}{32}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{section*.76}{}} +\newlabel{commands/apidoc/src:src.ElementTree.ProcessingInstruction}{{4.1.1}{32}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{section*.77}{}} +\newlabel{commands/apidoc/src:src.ElementTree.QName}{{4.1.1}{32}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{section*.78}{}} +\newlabel{commands/apidoc/src:src.ElementTree.SubElement}{{4.1.1}{32}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{section*.79}{}} +\newlabel{commands/apidoc/src:src.ElementTree.tostring}{{4.1.1}{32}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{section*.80}{}} +\newlabel{commands/apidoc/src:src.ElementTree.TreeBuilder}{{4.1.1}{32}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{section*.81}{}} +\newlabel{commands/apidoc/src:src.ElementTree.TreeBuilder.close}{{4.1.1}{32}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{section*.82}{}} +\newlabel{commands/apidoc/src:src.ElementTree.TreeBuilder.data}{{4.1.1}{32}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{section*.83}{}} +\newlabel{commands/apidoc/src:src.ElementTree.TreeBuilder.end}{{4.1.1}{32}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{section*.84}{}} +\newlabel{commands/apidoc/src:src.ElementTree.TreeBuilder.start}{{4.1.1}{32}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{section*.85}{}} +\newlabel{commands/apidoc/src:src.ElementTree.XML}{{4.1.1}{32}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{section*.86}{}} +\newlabel{commands/apidoc/src:src.ElementTree.XMLTreeBuilder}{{4.1.1}{32}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{section*.87}{}} +\newlabel{commands/apidoc/src:src.ElementTree.XMLTreeBuilder.close}{{4.1.1}{32}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{section*.88}{}} +\newlabel{commands/apidoc/src:src.ElementTree.XMLTreeBuilder.doctype}{{4.1.1}{32}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{section*.89}{}} +\newlabel{commands/apidoc/src:src.ElementTree.XMLTreeBuilder.feed}{{4.1.1}{32}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{section*.90}{}} +\@writefile{toc}{\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {architecture}} Module}{32}{subsubsection*.91}} +\newlabel{commands/apidoc/src:architecture-module}{{4.1.1}{32}{\sphinxstyleliteralintitle {\sphinxupquote {architecture}} Module}{subsubsection*.91}{}} +\newlabel{commands/apidoc/src:module-src.architecture}{{4.1.1}{32}{\sphinxstyleliteralintitle {\sphinxupquote {architecture}} Module}{subsubsection*.91}{}} +\newlabel{commands/apidoc/src:src.architecture.get_distrib_version}{{4.1.1}{32}{\sphinxstyleliteralintitle {\sphinxupquote {architecture}} Module}{section*.92}{}} +\newlabel{commands/apidoc/src:src.architecture.get_distribution}{{4.1.1}{32}{\sphinxstyleliteralintitle {\sphinxupquote {architecture}} Module}{section*.93}{}} +\newlabel{commands/apidoc/src:src.architecture.get_nb_proc}{{4.1.1}{33}{\sphinxstyleliteralintitle {\sphinxupquote {architecture}} Module}{section*.94}{}} +\newlabel{commands/apidoc/src:src.architecture.get_python_version}{{4.1.1}{33}{\sphinxstyleliteralintitle {\sphinxupquote {architecture}} Module}{section*.95}{}} +\newlabel{commands/apidoc/src:src.architecture.get_user}{{4.1.1}{33}{\sphinxstyleliteralintitle {\sphinxupquote {architecture}} Module}{section*.96}{}} +\newlabel{commands/apidoc/src:src.architecture.is_windows}{{4.1.1}{33}{\sphinxstyleliteralintitle {\sphinxupquote {architecture}} Module}{section*.97}{}} +\@writefile{toc}{\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {compilation}} Module}{33}{subsubsection*.98}} +\newlabel{commands/apidoc/src:module-src.compilation}{{4.1.1}{33}{\sphinxstyleliteralintitle {\sphinxupquote {compilation}} Module}{subsubsection*.98}{}} +\newlabel{commands/apidoc/src:compilation-module}{{4.1.1}{33}{\sphinxstyleliteralintitle {\sphinxupquote {compilation}} Module}{subsubsection*.98}{}} +\newlabel{commands/apidoc/src:src.compilation.Builder}{{4.1.1}{33}{\sphinxstyleliteralintitle {\sphinxupquote {compilation}} Module}{section*.99}{}} +\newlabel{commands/apidoc/src:src.compilation.Builder.build_configure}{{4.1.1}{33}{\sphinxstyleliteralintitle {\sphinxupquote {compilation}} Module}{section*.100}{}} +\newlabel{commands/apidoc/src:src.compilation.Builder.check}{{4.1.1}{33}{\sphinxstyleliteralintitle {\sphinxupquote {compilation}} Module}{section*.101}{}} +\newlabel{commands/apidoc/src:src.compilation.Builder.cmake}{{4.1.1}{33}{\sphinxstyleliteralintitle {\sphinxupquote {compilation}} Module}{section*.102}{}} +\newlabel{commands/apidoc/src:src.compilation.Builder.complete_environment}{{4.1.1}{33}{\sphinxstyleliteralintitle {\sphinxupquote {compilation}} Module}{section*.103}{}} +\newlabel{commands/apidoc/src:src.compilation.Builder.configure}{{4.1.1}{33}{\sphinxstyleliteralintitle {\sphinxupquote {compilation}} Module}{section*.104}{}} +\newlabel{commands/apidoc/src:src.compilation.Builder.do_batch_script_build}{{4.1.1}{33}{\sphinxstyleliteralintitle {\sphinxupquote {compilation}} Module}{section*.105}{}} +\newlabel{commands/apidoc/src:src.compilation.Builder.do_default_build}{{4.1.1}{33}{\sphinxstyleliteralintitle {\sphinxupquote {compilation}} Module}{section*.106}{}} +\newlabel{commands/apidoc/src:src.compilation.Builder.do_python_script_build}{{4.1.1}{33}{\sphinxstyleliteralintitle {\sphinxupquote {compilation}} Module}{section*.107}{}} +\newlabel{commands/apidoc/src:src.compilation.Builder.do_script_build}{{4.1.1}{33}{\sphinxstyleliteralintitle {\sphinxupquote {compilation}} Module}{section*.108}{}} +\newlabel{commands/apidoc/src:src.compilation.Builder.hack_libtool}{{4.1.1}{33}{\sphinxstyleliteralintitle {\sphinxupquote {compilation}} Module}{section*.109}{}} +\newlabel{commands/apidoc/src:src.compilation.Builder.install}{{4.1.1}{33}{\sphinxstyleliteralintitle {\sphinxupquote {compilation}} Module}{section*.110}{}} +\newlabel{commands/apidoc/src:src.compilation.Builder.log}{{4.1.1}{33}{\sphinxstyleliteralintitle {\sphinxupquote {compilation}} Module}{section*.111}{}} +\newlabel{commands/apidoc/src:src.compilation.Builder.log_command}{{4.1.1}{33}{\sphinxstyleliteralintitle {\sphinxupquote {compilation}} Module}{section*.112}{}} +\newlabel{commands/apidoc/src:src.compilation.Builder.make}{{4.1.1}{33}{\sphinxstyleliteralintitle {\sphinxupquote {compilation}} Module}{section*.113}{}} +\newlabel{commands/apidoc/src:src.compilation.Builder.prepare}{{4.1.1}{33}{\sphinxstyleliteralintitle {\sphinxupquote {compilation}} Module}{section*.114}{}} +\newlabel{commands/apidoc/src:src.compilation.Builder.put_txt_log_in_appli_log_dir}{{4.1.1}{33}{\sphinxstyleliteralintitle {\sphinxupquote {compilation}} Module}{section*.115}{}} +\newlabel{commands/apidoc/src:src.compilation.Builder.wmake}{{4.1.1}{34}{\sphinxstyleliteralintitle {\sphinxupquote {compilation}} Module}{section*.116}{}} +\@writefile{toc}{\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {debug}} Module}{34}{subsubsection*.117}} +\newlabel{commands/apidoc/src:module-src.debug}{{4.1.1}{34}{\sphinxstyleliteralintitle {\sphinxupquote {debug}} Module}{subsubsection*.117}{}} +\newlabel{commands/apidoc/src:debug-module}{{4.1.1}{34}{\sphinxstyleliteralintitle {\sphinxupquote {debug}} Module}{subsubsection*.117}{}} +\newlabel{commands/apidoc/src:src.debug.InStream}{{4.1.1}{34}{\sphinxstyleliteralintitle {\sphinxupquote {debug}} Module}{section*.118}{}} +\newlabel{commands/apidoc/src:src.debug.OutStream}{{4.1.1}{34}{\sphinxstyleliteralintitle {\sphinxupquote {debug}} Module}{section*.119}{}} +\newlabel{commands/apidoc/src:src.debug.OutStream.close}{{4.1.1}{34}{\sphinxstyleliteralintitle {\sphinxupquote {debug}} Module}{section*.120}{}} +\newlabel{commands/apidoc/src:src.debug.getLocalEnv}{{4.1.1}{34}{\sphinxstyleliteralintitle {\sphinxupquote {debug}} Module}{section*.121}{}} +\newlabel{commands/apidoc/src:src.debug.getStrConfigDbg}{{4.1.1}{34}{\sphinxstyleliteralintitle {\sphinxupquote {debug}} Module}{section*.122}{}} +\newlabel{commands/apidoc/src:src.debug.getStrConfigStd}{{4.1.1}{34}{\sphinxstyleliteralintitle {\sphinxupquote {debug}} Module}{section*.123}{}} +\newlabel{commands/apidoc/src:src.debug.indent}{{4.1.1}{34}{\sphinxstyleliteralintitle {\sphinxupquote {debug}} Module}{section*.124}{}} +\newlabel{commands/apidoc/src:src.debug.pop_debug}{{4.1.1}{34}{\sphinxstyleliteralintitle {\sphinxupquote {debug}} Module}{section*.125}{}} +\newlabel{commands/apidoc/src:src.debug.push_debug}{{4.1.1}{34}{\sphinxstyleliteralintitle {\sphinxupquote {debug}} Module}{section*.126}{}} +\newlabel{commands/apidoc/src:src.debug.saveConfigDbg}{{4.1.1}{34}{\sphinxstyleliteralintitle {\sphinxupquote {debug}} Module}{section*.127}{}} +\newlabel{commands/apidoc/src:src.debug.saveConfigStd}{{4.1.1}{34}{\sphinxstyleliteralintitle {\sphinxupquote {debug}} Module}{section*.128}{}} +\newlabel{commands/apidoc/src:src.debug.tofix}{{4.1.1}{35}{\sphinxstyleliteralintitle {\sphinxupquote {debug}} Module}{section*.129}{}} +\newlabel{commands/apidoc/src:src.debug.write}{{4.1.1}{35}{\sphinxstyleliteralintitle {\sphinxupquote {debug}} Module}{section*.130}{}} +\@writefile{toc}{\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{35}{subsubsection*.131}} +\newlabel{commands/apidoc/src:environment-module}{{4.1.1}{35}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{subsubsection*.131}{}} +\newlabel{commands/apidoc/src:module-src.environment}{{4.1.1}{35}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{subsubsection*.131}{}} +\newlabel{commands/apidoc/src:src.environment.Environ}{{4.1.1}{35}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.132}{}} +\newlabel{commands/apidoc/src:src.environment.Environ.append}{{4.1.1}{35}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.133}{}} +\newlabel{commands/apidoc/src:src.environment.Environ.append_value}{{4.1.1}{35}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.134}{}} +\newlabel{commands/apidoc/src:src.environment.Environ.command_value}{{4.1.1}{35}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.135}{}} +\newlabel{commands/apidoc/src:src.environment.Environ.get}{{4.1.1}{35}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.136}{}} +\newlabel{commands/apidoc/src:src.environment.Environ.is_defined}{{4.1.1}{35}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.137}{}} +\newlabel{commands/apidoc/src:src.environment.Environ.prepend}{{4.1.1}{35}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.138}{}} +\newlabel{commands/apidoc/src:src.environment.Environ.prepend_value}{{4.1.1}{35}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.139}{}} +\newlabel{commands/apidoc/src:src.environment.Environ.set}{{4.1.1}{36}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.140}{}} +\newlabel{commands/apidoc/src:src.environment.FileEnvWriter}{{4.1.1}{36}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.141}{}} +\newlabel{commands/apidoc/src:src.environment.FileEnvWriter.write_cfgForPy_file}{{4.1.1}{36}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.142}{}} +\newlabel{commands/apidoc/src:src.environment.FileEnvWriter.write_env_file}{{4.1.1}{36}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.143}{}} +\newlabel{commands/apidoc/src:src.environment.SalomeEnviron}{{4.1.1}{36}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.144}{}} +\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.add_comment}{{4.1.1}{36}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.145}{}} +\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.add_line}{{4.1.1}{36}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.146}{}} +\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.add_warning}{{4.1.1}{36}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.147}{}} +\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.append}{{4.1.1}{36}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.148}{}} +\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.dump}{{4.1.1}{37}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.149}{}} +\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.finish}{{4.1.1}{37}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.150}{}} +\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.get}{{4.1.1}{37}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.151}{}} +\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.get_names}{{4.1.1}{37}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.152}{}} +\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.is_defined}{{4.1.1}{37}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.153}{}} +\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.load_cfg_environment}{{4.1.1}{37}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.154}{}} +\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.prepend}{{4.1.1}{37}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.155}{}} +\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.run_env_script}{{4.1.1}{37}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.156}{}} +\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.run_simple_env_script}{{4.1.1}{37}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.157}{}} +\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.set}{{4.1.1}{37}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.158}{}} +\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.set_a_product}{{4.1.1}{37}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.159}{}} +\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.set_application_env}{{4.1.1}{38}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.160}{}} +\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.set_cpp_env}{{4.1.1}{38}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.161}{}} +\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.set_full_environ}{{4.1.1}{38}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.162}{}} +\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.set_products}{{4.1.1}{38}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.163}{}} +\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.set_python_libdirs}{{4.1.1}{38}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.164}{}} +\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.set_salome_generic_product_env}{{4.1.1}{38}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.165}{}} +\newlabel{commands/apidoc/src:src.environment.SalomeEnviron.set_salome_minimal_product_env}{{4.1.1}{38}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.166}{}} +\newlabel{commands/apidoc/src:src.environment.Shell}{{4.1.1}{38}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.167}{}} +\newlabel{commands/apidoc/src:src.environment.load_environment}{{4.1.1}{38}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{section*.168}{}} +\@writefile{toc}{\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{39}{subsubsection*.169}} +\newlabel{commands/apidoc/src:fileenviron-module}{{4.1.1}{39}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{subsubsection*.169}{}} +\newlabel{commands/apidoc/src:module-src.fileEnviron}{{4.1.1}{39}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{subsubsection*.169}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.BashFileEnviron}{{4.1.1}{39}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.170}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.BashFileEnviron.command_value}{{4.1.1}{39}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.171}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.BashFileEnviron.finish}{{4.1.1}{39}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.172}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.BashFileEnviron.set}{{4.1.1}{39}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.173}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.BatFileEnviron}{{4.1.1}{39}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.174}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.BatFileEnviron.add_comment}{{4.1.1}{39}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.175}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.BatFileEnviron.command_value}{{4.1.1}{39}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.176}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.BatFileEnviron.finish}{{4.1.1}{39}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.177}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.BatFileEnviron.get}{{4.1.1}{39}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.178}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.BatFileEnviron.set}{{4.1.1}{39}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.179}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.ContextFileEnviron}{{4.1.1}{39}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.180}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.add_echo}{{4.1.1}{40}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.181}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.add_warning}{{4.1.1}{40}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.182}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.append_value}{{4.1.1}{40}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.183}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.command_value}{{4.1.1}{40}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.184}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.finish}{{4.1.1}{40}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.185}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.get}{{4.1.1}{40}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.186}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.prepend_value}{{4.1.1}{40}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.187}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.set}{{4.1.1}{40}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.188}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron}{{4.1.1}{40}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.189}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.add_comment}{{4.1.1}{40}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.190}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.add_echo}{{4.1.1}{41}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.191}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.add_line}{{4.1.1}{41}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.192}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.add_warning}{{4.1.1}{41}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.193}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.append}{{4.1.1}{41}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.194}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.append_value}{{4.1.1}{41}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.195}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.command_value}{{4.1.1}{41}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.196}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.finish}{{4.1.1}{41}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.197}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.get}{{4.1.1}{41}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.198}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.is_defined}{{4.1.1}{41}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.199}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.prepend}{{4.1.1}{41}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.200}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.prepend_value}{{4.1.1}{42}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.201}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.FileEnviron.set}{{4.1.1}{42}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.202}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron}{{4.1.1}{42}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.203}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add}{{4.1.1}{42}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.204}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add_comment}{{4.1.1}{42}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.205}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add_echo}{{4.1.1}{42}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.206}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add_line}{{4.1.1}{42}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.207}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add_warning}{{4.1.1}{42}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.208}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.append}{{4.1.1}{42}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.209}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.append_value}{{4.1.1}{42}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.210}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.change_to_launcher}{{4.1.1}{42}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.211}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.command_value}{{4.1.1}{42}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.212}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.finish}{{4.1.1}{43}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.213}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.get}{{4.1.1}{43}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.214}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.is_defined}{{4.1.1}{43}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.215}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.prepend}{{4.1.1}{43}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.216}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.prepend_value}{{4.1.1}{43}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.217}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.set}{{4.1.1}{43}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.218}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron}{{4.1.1}{43}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.219}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron.add_comment}{{4.1.1}{43}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.220}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron.add_echo}{{4.1.1}{43}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.221}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron.add_line}{{4.1.1}{43}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.222}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron.add_warning}{{4.1.1}{43}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.223}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron.append}{{4.1.1}{44}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.224}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron.command_value}{{4.1.1}{44}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.225}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron.get}{{4.1.1}{44}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.226}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron.is_defined}{{4.1.1}{44}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.227}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron.prepend}{{4.1.1}{44}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.228}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron.run_env_script}{{4.1.1}{44}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.229}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron.set}{{4.1.1}{44}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.230}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.ScreenEnviron.write}{{4.1.1}{44}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.231}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.get_file_environ}{{4.1.1}{44}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.232}{}} +\newlabel{commands/apidoc/src:src.fileEnviron.special_path_separator}{{4.1.1}{44}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{section*.233}{}} +\@writefile{toc}{\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {fork}} Module}{45}{subsubsection*.234}} +\newlabel{commands/apidoc/src:fork-module}{{4.1.1}{45}{\sphinxstyleliteralintitle {\sphinxupquote {fork}} Module}{subsubsection*.234}{}} +\newlabel{commands/apidoc/src:module-src.fork}{{4.1.1}{45}{\sphinxstyleliteralintitle {\sphinxupquote {fork}} Module}{subsubsection*.234}{}} +\newlabel{commands/apidoc/src:src.fork.batch}{{4.1.1}{45}{\sphinxstyleliteralintitle {\sphinxupquote {fork}} Module}{section*.235}{}} +\newlabel{commands/apidoc/src:src.fork.batch_salome}{{4.1.1}{45}{\sphinxstyleliteralintitle {\sphinxupquote {fork}} Module}{section*.236}{}} +\newlabel{commands/apidoc/src:src.fork.launch_command}{{4.1.1}{45}{\sphinxstyleliteralintitle {\sphinxupquote {fork}} Module}{section*.237}{}} +\newlabel{commands/apidoc/src:src.fork.show_progress}{{4.1.1}{45}{\sphinxstyleliteralintitle {\sphinxupquote {fork}} Module}{section*.238}{}} +\newlabel{commands/apidoc/src:src.fork.write_back}{{4.1.1}{45}{\sphinxstyleliteralintitle {\sphinxupquote {fork}} Module}{section*.239}{}} +\@writefile{toc}{\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {logger}} Module}{45}{subsubsection*.240}} +\newlabel{commands/apidoc/src:logger-module}{{4.1.1}{45}{\sphinxstyleliteralintitle {\sphinxupquote {logger}} Module}{subsubsection*.240}{}} +\newlabel{commands/apidoc/src:module-src.logger}{{4.1.1}{45}{\sphinxstyleliteralintitle {\sphinxupquote {logger}} Module}{subsubsection*.240}{}} +\newlabel{commands/apidoc/src:src.logger.Logger}{{4.1.1}{45}{\sphinxstyleliteralintitle {\sphinxupquote {logger}} Module}{section*.241}{}} +\newlabel{commands/apidoc/src:src.logger.Logger.add_link}{{4.1.1}{45}{\sphinxstyleliteralintitle {\sphinxupquote {logger}} Module}{section*.242}{}} +\newlabel{commands/apidoc/src:src.logger.Logger.end_write}{{4.1.1}{45}{\sphinxstyleliteralintitle {\sphinxupquote {logger}} Module}{section*.243}{}} +\newlabel{commands/apidoc/src:src.logger.Logger.error}{{4.1.1}{45}{\sphinxstyleliteralintitle {\sphinxupquote {logger}} Module}{section*.244}{}} +\newlabel{commands/apidoc/src:src.logger.Logger.flush}{{4.1.1}{45}{\sphinxstyleliteralintitle {\sphinxupquote {logger}} Module}{section*.245}{}} +\newlabel{commands/apidoc/src:src.logger.Logger.put_initial_xml_fields}{{4.1.1}{46}{\sphinxstyleliteralintitle {\sphinxupquote {logger}} Module}{section*.246}{}} +\newlabel{commands/apidoc/src:src.logger.Logger.write}{{4.1.1}{46}{\sphinxstyleliteralintitle {\sphinxupquote {logger}} Module}{section*.247}{}} +\newlabel{commands/apidoc/src:src.logger.date_to_datetime}{{4.1.1}{46}{\sphinxstyleliteralintitle {\sphinxupquote {logger}} Module}{section*.248}{}} +\newlabel{commands/apidoc/src:src.logger.list_log_file}{{4.1.1}{46}{\sphinxstyleliteralintitle {\sphinxupquote {logger}} Module}{section*.249}{}} +\newlabel{commands/apidoc/src:src.logger.show_command_log}{{4.1.1}{46}{\sphinxstyleliteralintitle {\sphinxupquote {logger}} Module}{section*.250}{}} +\newlabel{commands/apidoc/src:src.logger.timedelta_total_seconds}{{4.1.1}{46}{\sphinxstyleliteralintitle {\sphinxupquote {logger}} Module}{section*.251}{}} +\newlabel{commands/apidoc/src:src.logger.update_hat_xml}{{4.1.1}{46}{\sphinxstyleliteralintitle {\sphinxupquote {logger}} Module}{section*.252}{}} +\@writefile{toc}{\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {options}} Module}{47}{subsubsection*.253}} +\newlabel{commands/apidoc/src:module-src.options}{{4.1.1}{47}{\sphinxstyleliteralintitle {\sphinxupquote {options}} Module}{subsubsection*.253}{}} +\newlabel{commands/apidoc/src:options-module}{{4.1.1}{47}{\sphinxstyleliteralintitle {\sphinxupquote {options}} Module}{subsubsection*.253}{}} +\newlabel{commands/apidoc/src:src.options.OptResult}{{4.1.1}{47}{\sphinxstyleliteralintitle {\sphinxupquote {options}} Module}{section*.254}{}} +\newlabel{commands/apidoc/src:src.options.Options}{{4.1.1}{47}{\sphinxstyleliteralintitle {\sphinxupquote {options}} Module}{section*.255}{}} +\newlabel{commands/apidoc/src:src.options.Options.add_option}{{4.1.1}{47}{\sphinxstyleliteralintitle {\sphinxupquote {options}} Module}{section*.256}{}} +\newlabel{commands/apidoc/src:src.options.Options.parse_args}{{4.1.1}{47}{\sphinxstyleliteralintitle {\sphinxupquote {options}} Module}{section*.257}{}} +\newlabel{commands/apidoc/src:src.options.Options.print_help}{{4.1.1}{47}{\sphinxstyleliteralintitle {\sphinxupquote {options}} Module}{section*.258}{}} +\@writefile{toc}{\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {printcolors}} Module}{47}{subsubsection*.259}} +\newlabel{commands/apidoc/src:printcolors-module}{{4.1.1}{47}{\sphinxstyleliteralintitle {\sphinxupquote {printcolors}} Module}{subsubsection*.259}{}} +\newlabel{commands/apidoc/src:module-src.printcolors}{{4.1.1}{47}{\sphinxstyleliteralintitle {\sphinxupquote {printcolors}} Module}{subsubsection*.259}{}} +\newlabel{commands/apidoc/src:src.printcolors.cleancolor}{{4.1.1}{47}{\sphinxstyleliteralintitle {\sphinxupquote {printcolors}} Module}{section*.260}{}} +\newlabel{commands/apidoc/src:src.printcolors.print_color_map}{{4.1.1}{47}{\sphinxstyleliteralintitle {\sphinxupquote {printcolors}} Module}{section*.261}{}} +\newlabel{commands/apidoc/src:src.printcolors.print_color_range}{{4.1.1}{48}{\sphinxstyleliteralintitle {\sphinxupquote {printcolors}} Module}{section*.262}{}} +\newlabel{commands/apidoc/src:src.printcolors.print_value}{{4.1.1}{48}{\sphinxstyleliteralintitle {\sphinxupquote {printcolors}} Module}{section*.263}{}} +\newlabel{commands/apidoc/src:src.printcolors.printc}{{4.1.1}{48}{\sphinxstyleliteralintitle {\sphinxupquote {printcolors}} Module}{section*.264}{}} +\newlabel{commands/apidoc/src:src.printcolors.printcError}{{4.1.1}{48}{\sphinxstyleliteralintitle {\sphinxupquote {printcolors}} Module}{section*.265}{}} +\newlabel{commands/apidoc/src:src.printcolors.printcHeader}{{4.1.1}{48}{\sphinxstyleliteralintitle {\sphinxupquote {printcolors}} Module}{section*.266}{}} +\newlabel{commands/apidoc/src:src.printcolors.printcHighlight}{{4.1.1}{48}{\sphinxstyleliteralintitle {\sphinxupquote {printcolors}} Module}{section*.267}{}} +\newlabel{commands/apidoc/src:src.printcolors.printcInfo}{{4.1.1}{48}{\sphinxstyleliteralintitle {\sphinxupquote {printcolors}} Module}{section*.268}{}} +\newlabel{commands/apidoc/src:src.printcolors.printcLabel}{{4.1.1}{49}{\sphinxstyleliteralintitle {\sphinxupquote {printcolors}} Module}{section*.269}{}} +\newlabel{commands/apidoc/src:src.printcolors.printcSuccess}{{4.1.1}{49}{\sphinxstyleliteralintitle {\sphinxupquote {printcolors}} Module}{section*.270}{}} +\newlabel{commands/apidoc/src:src.printcolors.printcWarning}{{4.1.1}{49}{\sphinxstyleliteralintitle {\sphinxupquote {printcolors}} Module}{section*.271}{}} +\@writefile{toc}{\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{49}{subsubsection*.272}} +\newlabel{commands/apidoc/src:module-src.product}{{4.1.1}{49}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{subsubsection*.272}{}} +\newlabel{commands/apidoc/src:product-module}{{4.1.1}{49}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{subsubsection*.272}{}} +\newlabel{commands/apidoc/src:src.product.check_config_exists}{{4.1.1}{49}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{section*.273}{}} +\newlabel{commands/apidoc/src:src.product.check_installation}{{4.1.1}{49}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{section*.274}{}} +\newlabel{commands/apidoc/src:src.product.check_source}{{4.1.1}{49}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{section*.275}{}} +\newlabel{commands/apidoc/src:src.product.get_base_install_dir}{{4.1.1}{49}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{section*.276}{}} +\newlabel{commands/apidoc/src:src.product.get_install_dir}{{4.1.1}{50}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{section*.277}{}} +\newlabel{commands/apidoc/src:src.product.get_product_components}{{4.1.1}{50}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{section*.278}{}} +\newlabel{commands/apidoc/src:src.product.get_product_config}{{4.1.1}{50}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{section*.279}{}} +\newlabel{commands/apidoc/src:src.product.get_product_dependencies}{{4.1.1}{50}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{section*.280}{}} +\newlabel{commands/apidoc/src:src.product.get_product_section}{{4.1.1}{50}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{section*.281}{}} +\newlabel{commands/apidoc/src:src.product.get_products_infos}{{4.1.1}{51}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{section*.282}{}} +\newlabel{commands/apidoc/src:src.product.product_compiles}{{4.1.1}{51}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{section*.283}{}} +\newlabel{commands/apidoc/src:src.product.product_has_env_script}{{4.1.1}{51}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{section*.284}{}} +\newlabel{commands/apidoc/src:src.product.product_has_logo}{{4.1.1}{51}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{section*.285}{}} +\newlabel{commands/apidoc/src:src.product.product_has_patches}{{4.1.1}{51}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{section*.286}{}} +\newlabel{commands/apidoc/src:src.product.product_has_salome_gui}{{4.1.1}{51}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{section*.287}{}} +\newlabel{commands/apidoc/src:src.product.product_has_script}{{4.1.1}{51}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{section*.288}{}} +\newlabel{commands/apidoc/src:src.product.product_is_autotools}{{4.1.1}{51}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{section*.289}{}} +\newlabel{commands/apidoc/src:src.product.product_is_cmake}{{4.1.1}{52}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{section*.290}{}} +\newlabel{commands/apidoc/src:src.product.product_is_cpp}{{4.1.1}{52}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{section*.291}{}} +\newlabel{commands/apidoc/src:src.product.product_is_debug}{{4.1.1}{52}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{section*.292}{}} +\newlabel{commands/apidoc/src:src.product.product_is_dev}{{4.1.1}{52}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{section*.293}{}} +\newlabel{commands/apidoc/src:src.product.product_is_fixed}{{4.1.1}{52}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{section*.294}{}} +\newlabel{commands/apidoc/src:src.product.product_is_generated}{{4.1.1}{52}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{section*.295}{}} +\newlabel{commands/apidoc/src:src.product.product_is_mpi}{{4.1.1}{52}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{section*.296}{}} +\newlabel{commands/apidoc/src:src.product.product_is_native}{{4.1.1}{52}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{section*.297}{}} +\newlabel{commands/apidoc/src:src.product.product_is_salome}{{4.1.1}{53}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{section*.298}{}} +\newlabel{commands/apidoc/src:src.product.product_is_sample}{{4.1.1}{53}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{section*.299}{}} +\newlabel{commands/apidoc/src:src.product.product_is_smesh_plugin}{{4.1.1}{53}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{section*.300}{}} +\newlabel{commands/apidoc/src:src.product.product_is_vcs}{{4.1.1}{53}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{section*.301}{}} +\@writefile{toc}{\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{53}{subsubsection*.302}} +\newlabel{commands/apidoc/src:pyconf-module}{{4.1.1}{53}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{subsubsection*.302}{}} +\newlabel{commands/apidoc/src:module-src.pyconf}{{4.1.1}{53}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{subsubsection*.302}{}} +\newlabel{commands/apidoc/src:src.pyconf.Config}{{4.1.1}{54}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.303}{}} +\newlabel{commands/apidoc/src:src.pyconf.Config.Namespace}{{4.1.1}{54}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.304}{}} +\newlabel{commands/apidoc/src:src.pyconf.Config.addNamespace}{{4.1.1}{54}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.305}{}} +\newlabel{commands/apidoc/src:src.pyconf.Config.getByPath}{{4.1.1}{54}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.306}{}} +\newlabel{commands/apidoc/src:src.pyconf.Config.load}{{4.1.1}{54}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.307}{}} +\newlabel{commands/apidoc/src:src.pyconf.Config.removeNamespace}{{4.1.1}{55}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.308}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigError}{{4.1.1}{55}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.309}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigFormatError}{{4.1.1}{55}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.310}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigInputStream}{{4.1.1}{55}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.311}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigInputStream.close}{{4.1.1}{55}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.312}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigInputStream.read}{{4.1.1}{55}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.313}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigInputStream.readline}{{4.1.1}{55}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.314}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigList}{{4.1.1}{55}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.315}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigList.getByPath}{{4.1.1}{55}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.316}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigMerger}{{4.1.1}{55}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.317}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigMerger.handleMismatch}{{4.1.1}{55}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.318}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigMerger.merge}{{4.1.1}{55}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.319}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigMerger.mergeMapping}{{4.1.1}{55}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.320}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigMerger.mergeSequence}{{4.1.1}{56}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.321}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigMerger.overwriteKeys}{{4.1.1}{56}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.322}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigOutputStream}{{4.1.1}{56}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.323}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigOutputStream.close}{{4.1.1}{56}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.324}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigOutputStream.flush}{{4.1.1}{56}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.325}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigOutputStream.write}{{4.1.1}{56}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.326}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigReader}{{4.1.1}{56}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.327}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.getChar}{{4.1.1}{56}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.328}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.getToken}{{4.1.1}{56}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.329}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.load}{{4.1.1}{56}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.330}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.location}{{4.1.1}{56}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.331}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.match}{{4.1.1}{56}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.332}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.parseFactor}{{4.1.1}{56}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.333}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.parseKeyValuePair}{{4.1.1}{57}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.334}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.parseMapping}{{4.1.1}{57}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.335}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.parseMappingBody}{{4.1.1}{57}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.336}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.parseReference}{{4.1.1}{57}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.337}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.parseScalar}{{4.1.1}{57}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.338}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.parseSequence}{{4.1.1}{57}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.339}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.parseSuffix}{{4.1.1}{57}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.340}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.parseTerm}{{4.1.1}{57}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.341}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.parseValue}{{4.1.1}{57}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.342}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigReader.setStream}{{4.1.1}{57}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.343}{}} +\newlabel{commands/apidoc/src:src.pyconf.ConfigResolutionError}{{4.1.1}{57}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.344}{}} +\newlabel{commands/apidoc/src:src.pyconf.Container}{{4.1.1}{57}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.345}{}} +\newlabel{commands/apidoc/src:src.pyconf.Container.evaluate}{{4.1.1}{58}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.346}{}} +\newlabel{commands/apidoc/src:src.pyconf.Container.setPath}{{4.1.1}{58}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.347}{}} +\newlabel{commands/apidoc/src:src.pyconf.Container.writeToStream}{{4.1.1}{58}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.348}{}} +\newlabel{commands/apidoc/src:src.pyconf.Container.writeValue}{{4.1.1}{58}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.349}{}} +\newlabel{commands/apidoc/src:src.pyconf.Expression}{{4.1.1}{58}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.350}{}} +\newlabel{commands/apidoc/src:src.pyconf.Expression.evaluate}{{4.1.1}{58}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.351}{}} +\newlabel{commands/apidoc/src:src.pyconf.Mapping}{{4.1.1}{58}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.352}{}} +\newlabel{commands/apidoc/src:src.pyconf.Mapping.addMapping}{{4.1.1}{58}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.353}{}} +\newlabel{commands/apidoc/src:src.pyconf.Mapping.get}{{4.1.1}{58}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.354}{}} +\newlabel{commands/apidoc/src:src.pyconf.Mapping.iteritems}{{4.1.1}{58}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.355}{}} +\newlabel{commands/apidoc/src:src.pyconf.Mapping.iterkeys}{{4.1.1}{58}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.356}{}} +\newlabel{commands/apidoc/src:src.pyconf.Mapping.keys}{{4.1.1}{58}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.357}{}} +\newlabel{commands/apidoc/src:src.pyconf.Mapping.writeToStream}{{4.1.1}{59}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.358}{}} +\newlabel{commands/apidoc/src:src.pyconf.Reference}{{4.1.1}{59}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.359}{}} +\newlabel{commands/apidoc/src:src.pyconf.Reference.addElement}{{4.1.1}{59}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.360}{}} +\newlabel{commands/apidoc/src:src.pyconf.Reference.findConfig}{{4.1.1}{59}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.361}{}} +\newlabel{commands/apidoc/src:src.pyconf.Reference.resolve}{{4.1.1}{59}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.362}{}} +\newlabel{commands/apidoc/src:src.pyconf.Sequence}{{4.1.1}{59}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.363}{}} +\newlabel{commands/apidoc/src:src.pyconf.Sequence.SeqIter}{{4.1.1}{59}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.364}{}} +\newlabel{commands/apidoc/src:src.pyconf.Sequence.SeqIter.next}{{4.1.1}{59}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.365}{}} +\newlabel{commands/apidoc/src:src.pyconf.Sequence.append}{{4.1.1}{59}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.366}{}} +\newlabel{commands/apidoc/src:src.pyconf.Sequence.writeToStream}{{4.1.1}{59}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.367}{}} +\newlabel{commands/apidoc/src:src.pyconf.deepCopyMapping}{{4.1.1}{59}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.368}{}} +\newlabel{commands/apidoc/src:src.pyconf.defaultMergeResolve}{{4.1.1}{59}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.369}{}} +\newlabel{commands/apidoc/src:src.pyconf.defaultStreamOpener}{{4.1.1}{60}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.370}{}} +\newlabel{commands/apidoc/src:src.pyconf.isWord}{{4.1.1}{60}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.371}{}} +\newlabel{commands/apidoc/src:src.pyconf.makePath}{{4.1.1}{60}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.372}{}} +\newlabel{commands/apidoc/src:src.pyconf.overwriteMergeResolve}{{4.1.1}{60}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{section*.373}{}} +\@writefile{toc}{\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {system}} Module}{60}{subsubsection*.374}} +\newlabel{commands/apidoc/src:system-module}{{4.1.1}{60}{\sphinxstyleliteralintitle {\sphinxupquote {system}} Module}{subsubsection*.374}{}} +\newlabel{commands/apidoc/src:module-src.system}{{4.1.1}{60}{\sphinxstyleliteralintitle {\sphinxupquote {system}} Module}{subsubsection*.374}{}} +\newlabel{commands/apidoc/src:src.system.archive_extract}{{4.1.1}{60}{\sphinxstyleliteralintitle {\sphinxupquote {system}} Module}{section*.375}{}} +\newlabel{commands/apidoc/src:src.system.cvs_extract}{{4.1.1}{60}{\sphinxstyleliteralintitle {\sphinxupquote {system}} Module}{section*.376}{}} +\newlabel{commands/apidoc/src:src.system.git_extract}{{4.1.1}{61}{\sphinxstyleliteralintitle {\sphinxupquote {system}} Module}{section*.377}{}} +\newlabel{commands/apidoc/src:src.system.show_in_editor}{{4.1.1}{61}{\sphinxstyleliteralintitle {\sphinxupquote {system}} Module}{section*.378}{}} +\newlabel{commands/apidoc/src:src.system.svn_extract}{{4.1.1}{61}{\sphinxstyleliteralintitle {\sphinxupquote {system}} Module}{section*.379}{}} +\@writefile{toc}{\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {template}} Module}{62}{subsubsection*.380}} +\newlabel{commands/apidoc/src:template-module}{{4.1.1}{62}{\sphinxstyleliteralintitle {\sphinxupquote {template}} Module}{subsubsection*.380}{}} +\newlabel{commands/apidoc/src:module-src.template}{{4.1.1}{62}{\sphinxstyleliteralintitle {\sphinxupquote {template}} Module}{subsubsection*.380}{}} +\newlabel{commands/apidoc/src:src.template.MyTemplate}{{4.1.1}{62}{\sphinxstyleliteralintitle {\sphinxupquote {template}} Module}{section*.381}{}} +\newlabel{commands/apidoc/src:src.template.MyTemplate.delimiter}{{4.1.1}{62}{\sphinxstyleliteralintitle {\sphinxupquote {template}} Module}{section*.382}{}} +\newlabel{commands/apidoc/src:src.template.MyTemplate.pattern}{{4.1.1}{62}{\sphinxstyleliteralintitle {\sphinxupquote {template}} Module}{section*.383}{}} +\newlabel{commands/apidoc/src:src.template.substitute}{{4.1.1}{62}{\sphinxstyleliteralintitle {\sphinxupquote {template}} Module}{section*.384}{}} +\@writefile{toc}{\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {test\_module}} Module}{62}{subsubsection*.385}} +\newlabel{commands/apidoc/src:module-src.test_module}{{4.1.1}{62}{\sphinxstyleliteralintitle {\sphinxupquote {test\_module}} Module}{subsubsection*.385}{}} +\newlabel{commands/apidoc/src:test-module-module}{{4.1.1}{62}{\sphinxstyleliteralintitle {\sphinxupquote {test\_module}} Module}{subsubsection*.385}{}} +\newlabel{commands/apidoc/src:src.test_module.Test}{{4.1.1}{62}{\sphinxstyleliteralintitle {\sphinxupquote {test\_module}} Module}{section*.386}{}} +\newlabel{commands/apidoc/src:src.test_module.Test.generate_launching_commands}{{4.1.1}{62}{\sphinxstyleliteralintitle {\sphinxupquote {test\_module}} Module}{section*.387}{}} +\newlabel{commands/apidoc/src:src.test_module.Test.generate_script}{{4.1.1}{62}{\sphinxstyleliteralintitle {\sphinxupquote {test\_module}} Module}{section*.388}{}} +\newlabel{commands/apidoc/src:src.test_module.Test.get_test_timeout}{{4.1.1}{62}{\sphinxstyleliteralintitle {\sphinxupquote {test\_module}} Module}{section*.389}{}} +\newlabel{commands/apidoc/src:src.test_module.Test.get_tmp_dir}{{4.1.1}{62}{\sphinxstyleliteralintitle {\sphinxupquote {test\_module}} Module}{section*.390}{}} +\newlabel{commands/apidoc/src:src.test_module.Test.prepare_testbase}{{4.1.1}{62}{\sphinxstyleliteralintitle {\sphinxupquote {test\_module}} Module}{section*.391}{}} +\newlabel{commands/apidoc/src:src.test_module.Test.prepare_testbase_from_dir}{{4.1.1}{62}{\sphinxstyleliteralintitle {\sphinxupquote {test\_module}} Module}{section*.392}{}} +\newlabel{commands/apidoc/src:src.test_module.Test.prepare_testbase_from_git}{{4.1.1}{62}{\sphinxstyleliteralintitle {\sphinxupquote {test\_module}} Module}{section*.393}{}} +\newlabel{commands/apidoc/src:src.test_module.Test.prepare_testbase_from_svn}{{4.1.1}{62}{\sphinxstyleliteralintitle {\sphinxupquote {test\_module}} Module}{section*.394}{}} +\newlabel{commands/apidoc/src:src.test_module.Test.read_results}{{4.1.1}{62}{\sphinxstyleliteralintitle {\sphinxupquote {test\_module}} Module}{section*.395}{}} +\newlabel{commands/apidoc/src:src.test_module.Test.run_all_tests}{{4.1.1}{62}{\sphinxstyleliteralintitle {\sphinxupquote {test\_module}} Module}{section*.396}{}} +\newlabel{commands/apidoc/src:src.test_module.Test.run_grid_tests}{{4.1.1}{62}{\sphinxstyleliteralintitle {\sphinxupquote {test\_module}} Module}{section*.397}{}} +\newlabel{commands/apidoc/src:src.test_module.Test.run_script}{{4.1.1}{62}{\sphinxstyleliteralintitle {\sphinxupquote {test\_module}} Module}{section*.398}{}} +\newlabel{commands/apidoc/src:src.test_module.Test.run_session_tests}{{4.1.1}{62}{\sphinxstyleliteralintitle {\sphinxupquote {test\_module}} Module}{section*.399}{}} +\newlabel{commands/apidoc/src:src.test_module.Test.run_testbase_tests}{{4.1.1}{62}{\sphinxstyleliteralintitle {\sphinxupquote {test\_module}} Module}{section*.400}{}} +\newlabel{commands/apidoc/src:src.test_module.Test.run_tests}{{4.1.1}{62}{\sphinxstyleliteralintitle {\sphinxupquote {test\_module}} Module}{section*.401}{}} +\newlabel{commands/apidoc/src:src.test_module.Test.search_known_errors}{{4.1.1}{62}{\sphinxstyleliteralintitle {\sphinxupquote {test\_module}} Module}{section*.402}{}} +\newlabel{commands/apidoc/src:src.test_module.Test.write_test_margin}{{4.1.1}{62}{\sphinxstyleliteralintitle {\sphinxupquote {test\_module}} Module}{section*.403}{}} +\newlabel{commands/apidoc/src:src.test_module.getTmpDirDEFAULT}{{4.1.1}{62}{\sphinxstyleliteralintitle {\sphinxupquote {test\_module}} Module}{section*.404}{}} +\@writefile{toc}{\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {xmlManager}} Module}{62}{subsubsection*.405}} +\newlabel{commands/apidoc/src:xmlmanager-module}{{4.1.1}{62}{\sphinxstyleliteralintitle {\sphinxupquote {xmlManager}} Module}{subsubsection*.405}{}} +\newlabel{commands/apidoc/src:module-src.xmlManager}{{4.1.1}{62}{\sphinxstyleliteralintitle {\sphinxupquote {xmlManager}} Module}{subsubsection*.405}{}} +\newlabel{commands/apidoc/src:src.xmlManager.ReadXmlFile}{{4.1.1}{62}{\sphinxstyleliteralintitle {\sphinxupquote {xmlManager}} Module}{section*.406}{}} +\newlabel{commands/apidoc/src:src.xmlManager.ReadXmlFile.getRootAttrib}{{4.1.1}{62}{\sphinxstyleliteralintitle {\sphinxupquote {xmlManager}} Module}{section*.407}{}} +\newlabel{commands/apidoc/src:src.xmlManager.ReadXmlFile.get_attrib}{{4.1.1}{63}{\sphinxstyleliteralintitle {\sphinxupquote {xmlManager}} Module}{section*.408}{}} +\newlabel{commands/apidoc/src:src.xmlManager.ReadXmlFile.get_node_text}{{4.1.1}{63}{\sphinxstyleliteralintitle {\sphinxupquote {xmlManager}} Module}{section*.409}{}} +\newlabel{commands/apidoc/src:src.xmlManager.XmlLogFile}{{4.1.1}{63}{\sphinxstyleliteralintitle {\sphinxupquote {xmlManager}} Module}{section*.410}{}} +\newlabel{commands/apidoc/src:src.xmlManager.XmlLogFile.add_simple_node}{{4.1.1}{63}{\sphinxstyleliteralintitle {\sphinxupquote {xmlManager}} Module}{section*.411}{}} +\newlabel{commands/apidoc/src:src.xmlManager.XmlLogFile.append_node_attrib}{{4.1.1}{63}{\sphinxstyleliteralintitle {\sphinxupquote {xmlManager}} Module}{section*.412}{}} +\newlabel{commands/apidoc/src:src.xmlManager.XmlLogFile.append_node_text}{{4.1.1}{63}{\sphinxstyleliteralintitle {\sphinxupquote {xmlManager}} Module}{section*.413}{}} +\newlabel{commands/apidoc/src:src.xmlManager.XmlLogFile.write_tree}{{4.1.1}{63}{\sphinxstyleliteralintitle {\sphinxupquote {xmlManager}} Module}{section*.414}{}} +\newlabel{commands/apidoc/src:src.xmlManager.add_simple_node}{{4.1.1}{63}{\sphinxstyleliteralintitle {\sphinxupquote {xmlManager}} Module}{section*.415}{}} +\newlabel{commands/apidoc/src:src.xmlManager.append_node_attrib}{{4.1.1}{64}{\sphinxstyleliteralintitle {\sphinxupquote {xmlManager}} Module}{section*.416}{}} +\newlabel{commands/apidoc/src:src.xmlManager.find_node_by_attrib}{{4.1.1}{64}{\sphinxstyleliteralintitle {\sphinxupquote {xmlManager}} Module}{section*.417}{}} +\newlabel{commands/apidoc/src:src.xmlManager.write_report}{{4.1.1}{64}{\sphinxstyleliteralintitle {\sphinxupquote {xmlManager}} Module}{section*.418}{}} +\@writefile{toc}{\contentsline {subsubsection}{Subpackages}{64}{subsubsection*.419}} +\newlabel{commands/apidoc/src:subpackages}{{4.1.1}{64}{Subpackages}{subsubsection*.419}{}} +\@writefile{toc}{\contentsline {paragraph}{colorama Package}{64}{paragraph*.420}} +\newlabel{commands/apidoc/src.colorama:colorama-package}{{4.1.1}{64}{colorama Package}{paragraph*.420}{}} +\newlabel{commands/apidoc/src.colorama::doc}{{4.1.1}{64}{colorama Package}{paragraph*.420}{}} +\@writefile{toc}{\contentsline {subparagraph}{\sphinxstyleliteralintitle {\sphinxupquote {colorama}} Package}{64}{subparagraph*.421}} +\newlabel{commands/apidoc/src.colorama:id1}{{4.1.1}{64}{\sphinxstyleliteralintitle {\sphinxupquote {colorama}} Package}{subparagraph*.421}{}} +\newlabel{commands/apidoc/src.colorama:module-src.colorama}{{4.1.1}{64}{\sphinxstyleliteralintitle {\sphinxupquote {colorama}} Package}{section*.422}{}} +\@writefile{toc}{\contentsline {subparagraph}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{64}{subparagraph*.423}} +\newlabel{commands/apidoc/src.colorama:module-src.colorama.ansi}{{4.1.1}{64}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{subparagraph*.423}{}} +\newlabel{commands/apidoc/src.colorama:ansi-module}{{4.1.1}{64}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{subparagraph*.423}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack}{{4.1.1}{64}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.424}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.BLACK}{{4.1.1}{64}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.425}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.BLUE}{{4.1.1}{64}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.426}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.CYAN}{{4.1.1}{64}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.427}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.GREEN}{{4.1.1}{64}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.428}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTBLACK_EX}{{4.1.1}{64}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.429}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTBLUE_EX}{{4.1.1}{64}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.430}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTCYAN_EX}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.431}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTGREEN_EX}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.432}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTMAGENTA_EX}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.433}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTRED_EX}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.434}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTWHITE_EX}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.435}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTYELLOW_EX}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.436}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.MAGENTA}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.437}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.RED}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.438}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.RESET}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.439}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.WHITE}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.440}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.YELLOW}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.441}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCodes}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.442}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.443}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.BACK}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.444}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.DOWN}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.445}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.FORWARD}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.446}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.POS}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.447}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.UP}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.448}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.449}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.BLACK}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.450}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.BLUE}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.451}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.CYAN}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.452}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.GREEN}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.453}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTBLACK_EX}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.454}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTBLUE_EX}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.455}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTCYAN_EX}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.456}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTGREEN_EX}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.457}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTMAGENTA_EX}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.458}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTRED_EX}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.459}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTWHITE_EX}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.460}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTYELLOW_EX}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.461}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.MAGENTA}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.462}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.RED}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.463}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.RESET}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.464}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.WHITE}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.465}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.YELLOW}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.466}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle}{{4.1.1}{65}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.467}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle.BRIGHT}{{4.1.1}{66}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.468}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle.DIM}{{4.1.1}{66}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.469}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle.NORMAL}{{4.1.1}{66}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.470}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle.RESET_ALL}{{4.1.1}{66}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.471}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.clear_line}{{4.1.1}{66}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.472}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.clear_screen}{{4.1.1}{66}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.473}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.code_to_chars}{{4.1.1}{66}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.474}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansi.set_title}{{4.1.1}{66}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{section*.475}{}} +\@writefile{toc}{\contentsline {subparagraph}{\sphinxstyleliteralintitle {\sphinxupquote {ansitowin32}} Module}{66}{subparagraph*.476}} +\newlabel{commands/apidoc/src.colorama:ansitowin32-module}{{4.1.1}{66}{\sphinxstyleliteralintitle {\sphinxupquote {ansitowin32}} Module}{subparagraph*.476}{}} +\newlabel{commands/apidoc/src.colorama:module-src.colorama.ansitowin32}{{4.1.1}{66}{\sphinxstyleliteralintitle {\sphinxupquote {ansitowin32}} Module}{subparagraph*.476}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32}{{4.1.1}{66}{\sphinxstyleliteralintitle {\sphinxupquote {ansitowin32}} Module}{section*.477}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.ANSI_CSI_RE}{{4.1.1}{66}{\sphinxstyleliteralintitle {\sphinxupquote {ansitowin32}} Module}{section*.478}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.ANSI_OSC_RE}{{4.1.1}{66}{\sphinxstyleliteralintitle {\sphinxupquote {ansitowin32}} Module}{section*.479}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.call_win32}{{4.1.1}{66}{\sphinxstyleliteralintitle {\sphinxupquote {ansitowin32}} Module}{section*.480}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.convert_ansi}{{4.1.1}{66}{\sphinxstyleliteralintitle {\sphinxupquote {ansitowin32}} Module}{section*.481}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.convert_osc}{{4.1.1}{66}{\sphinxstyleliteralintitle {\sphinxupquote {ansitowin32}} Module}{section*.482}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.extract_params}{{4.1.1}{66}{\sphinxstyleliteralintitle {\sphinxupquote {ansitowin32}} Module}{section*.483}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.get_win32_calls}{{4.1.1}{66}{\sphinxstyleliteralintitle {\sphinxupquote {ansitowin32}} Module}{section*.484}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.reset_all}{{4.1.1}{66}{\sphinxstyleliteralintitle {\sphinxupquote {ansitowin32}} Module}{section*.485}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.should_wrap}{{4.1.1}{66}{\sphinxstyleliteralintitle {\sphinxupquote {ansitowin32}} Module}{section*.486}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.write}{{4.1.1}{66}{\sphinxstyleliteralintitle {\sphinxupquote {ansitowin32}} Module}{section*.487}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.write_and_convert}{{4.1.1}{66}{\sphinxstyleliteralintitle {\sphinxupquote {ansitowin32}} Module}{section*.488}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.write_plain_text}{{4.1.1}{66}{\sphinxstyleliteralintitle {\sphinxupquote {ansitowin32}} Module}{section*.489}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.StreamWrapper}{{4.1.1}{66}{\sphinxstyleliteralintitle {\sphinxupquote {ansitowin32}} Module}{section*.490}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.StreamWrapper.write}{{4.1.1}{66}{\sphinxstyleliteralintitle {\sphinxupquote {ansitowin32}} Module}{section*.491}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.is_a_tty}{{4.1.1}{66}{\sphinxstyleliteralintitle {\sphinxupquote {ansitowin32}} Module}{section*.492}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.ansitowin32.is_stream_closed}{{4.1.1}{66}{\sphinxstyleliteralintitle {\sphinxupquote {ansitowin32}} Module}{section*.493}{}} +\@writefile{toc}{\contentsline {subparagraph}{\sphinxstyleliteralintitle {\sphinxupquote {initialise}} Module}{67}{subparagraph*.494}} +\newlabel{commands/apidoc/src.colorama:initialise-module}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {initialise}} Module}{subparagraph*.494}{}} +\newlabel{commands/apidoc/src.colorama:module-src.colorama.initialise}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {initialise}} Module}{subparagraph*.494}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.initialise.colorama_text}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {initialise}} Module}{section*.495}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.initialise.deinit}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {initialise}} Module}{section*.496}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.initialise.init}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {initialise}} Module}{section*.497}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.initialise.reinit}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {initialise}} Module}{section*.498}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.initialise.reset_all}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {initialise}} Module}{section*.499}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.initialise.wrap_stream}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {initialise}} Module}{section*.500}{}} +\@writefile{toc}{\contentsline {subparagraph}{\sphinxstyleliteralintitle {\sphinxupquote {win32}} Module}{67}{subparagraph*.501}} +\newlabel{commands/apidoc/src.colorama:win32-module}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {win32}} Module}{subparagraph*.501}{}} +\newlabel{commands/apidoc/src.colorama:module-src.colorama.win32}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {win32}} Module}{subparagraph*.501}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.win32.SetConsoleTextAttribute}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {win32}} Module}{section*.502}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.win32.winapi_test}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {win32}} Module}{section*.503}{}} +\@writefile{toc}{\contentsline {subparagraph}{\sphinxstyleliteralintitle {\sphinxupquote {winterm}} Module}{67}{subparagraph*.504}} +\newlabel{commands/apidoc/src.colorama:winterm-module}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {winterm}} Module}{subparagraph*.504}{}} +\newlabel{commands/apidoc/src.colorama:module-src.colorama.winterm}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {winterm}} Module}{subparagraph*.504}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinColor}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {winterm}} Module}{section*.505}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.BLACK}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {winterm}} Module}{section*.506}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.BLUE}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {winterm}} Module}{section*.507}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.CYAN}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {winterm}} Module}{section*.508}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.GREEN}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {winterm}} Module}{section*.509}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.GREY}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {winterm}} Module}{section*.510}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.MAGENTA}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {winterm}} Module}{section*.511}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.RED}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {winterm}} Module}{section*.512}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.YELLOW}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {winterm}} Module}{section*.513}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinStyle}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {winterm}} Module}{section*.514}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinStyle.BRIGHT}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {winterm}} Module}{section*.515}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinStyle.BRIGHT_BACKGROUND}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {winterm}} Module}{section*.516}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinStyle.NORMAL}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {winterm}} Module}{section*.517}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {winterm}} Module}{section*.518}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.back}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {winterm}} Module}{section*.519}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.cursor_adjust}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {winterm}} Module}{section*.520}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.erase_line}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {winterm}} Module}{section*.521}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.erase_screen}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {winterm}} Module}{section*.522}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.fore}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {winterm}} Module}{section*.523}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.get_attrs}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {winterm}} Module}{section*.524}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.get_position}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {winterm}} Module}{section*.525}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.reset_all}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {winterm}} Module}{section*.526}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.set_attrs}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {winterm}} Module}{section*.527}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.set_console}{{4.1.1}{67}{\sphinxstyleliteralintitle {\sphinxupquote {winterm}} Module}{section*.528}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.set_cursor_position}{{4.1.1}{68}{\sphinxstyleliteralintitle {\sphinxupquote {winterm}} Module}{section*.529}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.set_title}{{4.1.1}{68}{\sphinxstyleliteralintitle {\sphinxupquote {winterm}} Module}{section*.530}{}} +\newlabel{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.style}{{4.1.1}{68}{\sphinxstyleliteralintitle {\sphinxupquote {winterm}} Module}{section*.531}{}} +\@writefile{toc}{\contentsline {chapter}{\numberline {5}Release Notes}{69}{chapter.5}} +\@writefile{lof}{\addvspace {10\p@ }} +\@writefile{lot}{\addvspace {10\p@ }} +\newlabel{index:release-notes}{{5}{69}{Release Notes}{chapter.5}{}} +\@writefile{toc}{\contentsline {section}{\numberline {5.1}Release notes}{69}{section.5.1}} +\newlabel{release_notes/release_notes_5.0.0:release-notes}{{5.1}{69}{Release notes}{section.5.1}{}} +\newlabel{release_notes/release_notes_5.0.0::doc}{{5.1}{69}{Release notes}{section.5.1}{}} +\@writefile{toc}{\contentsline {chapter}{Python Module Index}{71}{section*.532}} +\@writefile{toc}{\contentsline {chapter}{Index}{73}{section*.533}} diff --git a/doc/build/latex/salomeTools.fdb_latexmk b/doc/build/latex/salomeTools.fdb_latexmk new file mode 100644 index 0000000..e218880 --- /dev/null +++ b/doc/build/latex/salomeTools.fdb_latexmk @@ -0,0 +1,189 @@ +# Fdb version 3 +["makeindex salomeTools.idx"] 1524653369 "salomeTools.idx" "salomeTools.ind" "salomeTools" 1524653371 + "salomeTools.idx" 1524653371 37218 47758ed2f5c8639f0fe54efc5cfe25d0 "" + (generated) + "salomeTools.ind" + "salomeTools.ilg" +["pdflatex"] 1524653370 "salomeTools.tex" "salomeTools.pdf" "salomeTools" 1524653371 + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/enc/dvips/base/8r.enc" 1480098666 4850 80dc9bab7f31fb78a000ccfed0e27cab "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/map/fontname/texfonts.map" 1511824771 3332 103109f5612ad95229751940c61aada0 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrb8c.tfm" 1480098688 1268 8067e4f35cbae42c0f58b48da75bf496 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrb8r.tfm" 1480098688 1292 3059476c50a24578715759f22652f3d0 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrb8t.tfm" 1480098688 1384 87406e4336af44af883a035f17f319d9 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrr8c.tfm" 1480098688 1268 8bd405dc5751cfed76cb6fb2db78cb50 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrr8r.tfm" 1480098688 1292 bd42be2f344128bff6d35d98474adfe3 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrr8t.tfm" 1480098688 1384 4632f5e54900a7dadbb83f555bc61e56 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrro8c.tfm" 1480098688 1344 dab2eee300fafcab19064bcc62d66daa "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrro8r.tfm" 1480098688 1544 4fb84cf2931ec523c2c6a08d939088ba "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrro8t.tfm" 1480098688 1596 04a657f277f0401ba37d66e716627ac4 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvb8r.tfm" 1480098688 4484 b828043cbd581d289d955903c1339981 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvb8t.tfm" 1480098688 6628 34c39492c0adc454c1c199922bba8363 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvbo8r.tfm" 1480098688 4736 423eba67d4e9420ec9df4a8def143b08 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvbo8t.tfm" 1480098688 6880 fe6c7967f27585f6fa9876f3af14edd2 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvr8r.tfm" 1480098688 4712 9ef4d7d106579d4b136e1529e1a4533c "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvr8t.tfm" 1480098688 7040 b2bd27e2bfe6f6948cbc3239cae7444f "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmb8r.tfm" 1480098689 4524 6bce29db5bc272ba5f332261583fee9c "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmb8t.tfm" 1480098689 6880 f19b8995b61c334d78fc734065f6b4d4 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmr8c.tfm" 1480098689 1352 fa28a7e6d323c65ce7d13d5342ff6be2 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmr8r.tfm" 1480098689 4408 25b74d011a4c66b7f212c0cc3c90061b "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmr8t.tfm" 1480098689 6672 e3ab9e37e925f3045c9005e6d1473d56 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmri8r.tfm" 1480098689 4640 532ca3305aad10cc01d769f3f91f1029 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmri8t.tfm" 1480098689 6944 94c55ad86e6ea2826f78ba2240d50df9 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/jknappen/ec/ecrm1000.tfm" 1480098696 3584 adb004a0c8e7c46ee66cad73671f37b4 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/cmextra/cmex7.tfm" 1480098698 1004 54797486969f23fa377b128694d548df "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/cmextra/cmex8.tfm" 1480098698 988 bdf658c3bfc2d96d3c8b02cfc1c94c20 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/symbols/msam10.tfm" 1480098698 916 f87d7c45f9c908e672703b83b72241a3 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/symbols/msam5.tfm" 1480098698 924 9904cf1d39e9767e7a3622f2a125a565 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/symbols/msam7.tfm" 1480098698 928 2dc8d444221b7a635bb58038579b861a "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/symbols/msbm10.tfm" 1480098698 908 2921f8a10601f252058503cc6570e581 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/symbols/msbm5.tfm" 1480098698 940 75ac932a52f80982a9f8ea75d03a34cf "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/symbols/msbm7.tfm" 1480098698 940 228d6584342e91276bf566bcf9716b83 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmex10.tfm" 1480098701 992 662f679a0b3d2d53c1b94050fdaa3f50 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmmi12.tfm" 1480098701 1524 4414a8315f39513458b80dfc63bff03a "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmmi6.tfm" 1480098701 1512 f21f83efb36853c0b70002322c1ab3ad "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmmi8.tfm" 1480098701 1520 eccf95517727cb11801f4f1aee3a21b4 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmr12.tfm" 1480098701 1288 655e228510b4c2a1abe905c368440826 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmr17.tfm" 1480098701 1292 296a67155bdbfc32aa9c636f21e91433 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmr6.tfm" 1480098701 1300 b62933e007d01cfd073f79b963c01526 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmr8.tfm" 1480098701 1292 21c1c5bfeaebccffdb478fd231a0997d "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmsy10.tfm" 1480098701 1124 6c73e740cf17375f03eec0ee63599741 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmsy6.tfm" 1480098701 1116 933a60c408fc0a863a92debe84b2d294 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmsy8.tfm" 1480098701 1120 8b7d695260f3cff42e636090a8002094 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/public/amsfonts/cm/cmmi5.pfb" 1480098733 37912 77d683123f92148345f3fc36a38d9ab1 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/public/amsfonts/cm/cmsy5.pfb" 1480098733 32915 7bf7720c61a5b3a7ff25b0964421c9b6 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/urw/courier/ucrb8a.pfb" 1480098746 50493 4ed1f7e9eba8f1f3e1ec25195460190d "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/urw/courier/ucrr8a.pfb" 1480098746 45758 19968a0990191524e34e1994d4a31cb6 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/urw/courier/ucrro8a.pfb" 1480098746 44404 ea3d9c0311883914133975dd62a9185c "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/urw/helvetic/uhvb8a.pfb" 1480098746 35941 f27169cc74234d5bd5e4cca5abafaabb "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/urw/helvetic/uhvbo8a.pfb" 1480098746 39013 b244066151b1e3e718f9b8e88a5ff23b "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/urw/helvetic/uhvr8a.pfb" 1480098746 44648 23115b2a545ebfe2c526c3ca99db8b95 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/urw/times/utmb8a.pfb" 1480098746 44729 811d6c62865936705a31c797a1d5dada "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/urw/times/utmr8a.pfb" 1480098746 46026 6dab18b61c907687b520c72847215a68 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/urw/times/utmri8a.pfb" 1480098746 45458 a3faba884469519614ca56ba5f6b1de1 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/courier/pcrb8c.vf" 1480098757 3560 cb6af2c6d0b5f763f3aae03f60590c57 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/courier/pcrb8t.vf" 1480098757 2184 5d20c8b00cd914e50251116c274e2d0b "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/courier/pcrr8c.vf" 1480098757 3552 6a7911d0b338a7c32cbfc3a9e985ccca "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/courier/pcrr8t.vf" 1480098757 2184 8475af1b9cfa983db5f46f5ed4b8f9f7 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/courier/pcrro8c.vf" 1480098757 3560 a297982f0907d62e9886d9e2666bf30b "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/courier/pcrro8t.vf" 1480098757 2280 d7cd083c724c9449e1d12731253966f7 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/helvetic/phvb8t.vf" 1480098757 2340 0efed6a948c3c37d870e4e7ddb85c7c3 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/helvetic/phvbo8t.vf" 1480098757 2344 88834f8322177295b0266ecc4b0754c3 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/helvetic/phvr8t.vf" 1480098757 2344 44ff28c9ef2fc97180cd884f900fee71 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/times/ptmb8t.vf" 1480098758 2340 df9c920cc5688ebbf16a93f45ce7bdd3 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/times/ptmr8c.vf" 1480098758 3556 8a9a6dcbcd146ef985683f677f4758a6 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/times/ptmr8t.vf" 1480098758 2348 91706c542228501c410c266421fbe30c "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/times/ptmri8t.vf" 1480098758 2328 6cd7df782b09b29cfc4d93e55b6b9a59 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/context/base/mkii/supp-pdf.mkii" 1480098806 71627 94eb9990bed73c364d7f53f960cc8c5b "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/babel-english/english.ldf" 1496785618 7008 9ff5fdcc865b01beca2b0fe4a46231d4 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/babel/babel.def" 1518644053 67244 2dce3d67c354c8d92f638d0f8682fb73 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/babel/babel.sty" 1518644053 15861 065fe343082d0cd2428cf984d6b2ef66 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/babel/switch.def" 1518644053 12523 d80bc74bf5e02fe4304443a6de8d01be "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/babel/txtbabel.def" 1518644053 7434 1b3955075683beb1c883a0fcf92ed2d5 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/ifxetex/ifxetex.sty" 1480098815 1458 43ab4710dc82f3edeabecd0d099626b2 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/etexcmds.sty" 1480098815 7612 729a8cc22a1ee0029997c7f74717ae05 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/gettitlestring.sty" 1480098815 8237 3b62ef1f7e2c23a328c814b3893bc11f "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/hobsub-generic.sty" 1517006633 185082 6c11d4e30ed78e2a12957b7e77030856 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/hobsub-hyperref.sty" 1480098815 70864 bcd5b216757bd619ae692a151d90085d "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/ifluatex.sty" 1480098815 7324 2310d1247db0114eb4726807c8837a0e "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/ifpdf.sty" 1490564930 1251 d170e11a3246c3392bc7f59595af42cb "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/ifvtex.sty" 1480098815 6797 90b7f83b0ad46826bc16058b1e3d48df "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/infwarerr.sty" 1480098815 8253 473e0e41f9adadb1977e8631b8f72ea6 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/kvsetkeys.sty" 1480098815 14040 ac8866aac45982ac84021584b0abb252 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/ltxcmds.sty" 1480098815 18425 5b3c0c59d76fac78978b5558e83c1f36 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsfonts/amsfonts.sty" 1480098820 5949 3f3fd50a8cc94c3d4cbf4fc66cd3df1c "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsfonts/amssymb.sty" 1480098820 13829 94730e64147574077f8ecfea9bb69af4 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsfonts/umsa.fd" 1480098820 961 6518c6525a34feb5e8250ffa91731cff "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsfonts/umsb.fd" 1480098820 961 d02606146ba5601b5645f987c92e6193 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsmath/amsbsy.sty" 1480098820 2210 5c54ab129b848a5071554186d0168766 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsmath/amsgen.sty" 1480098820 4160 c115536cf8d4ff25aa8c1c9bc4ecb79a "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsmath/amsmath.sty" 1504905757 84352 897a476d96a0681047a5b0f91178a3d2 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsmath/amsopn.sty" 1480098820 4115 318a66090112f3aa3f415aeb6fe8540f "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsmath/amstext.sty" 1480098820 2431 fe3078ec12fc30287f568596f8e0b948 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/alltt.sty" 1480098821 3140 977eaf314c97ac67b8675753fb15f67f "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/fontenc.sty" 1492297155 4571 13977df0eda144b93597fc709035ad1f "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/inputenc.sty" 1480098821 4732 d63eda807ac82cca2ca8488efd31a966 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/makeidx.sty" 1480098821 1940 c559b92ca91f1b2a0e60d836d4973f41 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/omsenc.dfu" 1487721667 2004 ac51aeac484f08c01026120d62677eca "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/ot1enc.dfu" 1487721667 3181 1cb3e9ad01f4a01127b2ffd821bfeec7 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/report.cls" 1480098821 22880 e7be6f7dd8c05d5108bf3a7d8cabe59a "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/size10.clo" 1480098821 8292 e897c12e1e886ce77fe26afc5d470886 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/t1enc.def" 1492297155 10006 a90ba4035cf778f32f424e297d92e235 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/t1enc.dfu" 1487721667 11255 9d97362866549d3d3c994b5f28d1b9b5 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/textcomp.sty" 1492297155 16154 f2c73e20ca771d534a8516c62c6b0eae "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/ts1cmr.fd" 1480098821 2217 d274654bda1292013bdf48d5f720a495 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/ts1enc.def" 1480098821 7767 aa88823823f5e767d79ea1166ab1ae74 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/ts1enc.dfu" 1487721667 4919 76510afd60e8282294f944c2f9f5103b "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/utf8.def" 1487721667 7784 325a2a09984cb5c4ff230f9867145ad3 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/capt-of/capt-of.sty" 1480098823 1311 063f8536a047a2d9cb1803321f793f37 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/carlisle/remreset.sty" 1480098823 1096 6a75275ca00e32428c6f059d2f618ea7 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/cmap/cmap.sty" 1480098825 2883 427a7f7cb58418a0394dbd85c80668f6 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/cmap/ot1.cmap" 1480098825 1207 4e0d96772f0d338847cbfb4eca683c81 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/cmap/t1.cmap" 1480098825 1938 beaa4a8467aa0074076e0e19f2992e29 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/fancyhdr/fancyhdr.sty" 1498861448 10663 d7fcc0dc4f35e8998b8cfeef8407d37d "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/fancyvrb/fancyvrb.sty" 1480098827 45360 a0833d32f1b541964596b02870342d5a "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/float/float.sty" 1480098828 6749 16d2656a1984957e674b149555f1ea1d "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/fncychap/fncychap.sty" 1480098828 19488 fdd52eb173b3197d748e1ec25acb042f "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/framed/framed.sty" 1480098829 22449 7ec15c16d0d66790f28e90343c5434a3 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/geometry/geometry.sty" 1480098829 40502 e003406220954b0716679d7928aedd8a "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics-cfg/color.cfg" 1480098830 1213 620bba36b25224fa9b7e1ccb4ecb76fd "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics-cfg/graphics.cfg" 1480098830 1224 978390e9c2234eab29404bc21b268d1e "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics-def/pdftex.def" 1515537368 17334 520b9b85ad8a2a48eda3f643e27a5179 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics/graphics.sty" 1498427532 15275 7d676729b1bedd3e7f3c6717affb366c "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics/graphicx.sty" 1498427532 9066 649f2ccf62888e3d8c3e57256b70b8e1 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics/keyval.sty" 1480098830 2594 d18d5e19aa8239cf867fa670c556d2e9 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics/trig.sty" 1480098830 3980 0a268fbfda01e381fa95821ab13b6aee "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/hyperref/hpdftex.def" 1518041854 51699 9069fc983fff0db91d59a15af144ad62 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/hyperref/hyperref.sty" 1518041854 234088 2c849389d62d41c593d9f5176c4116ab "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/hyperref/nameref.sty" 1480098831 12949 81e4e808884a8f0e276b69410e234656 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/hyperref/pd1enc.def" 1518041854 14098 4e70bf396c7c265bd8b0e5cab3fd3d4d "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/hyperref/puenc.def" 1518041854 122411 10b605a58a28bbe5d61db37da4a85beb "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/latexconfig/epstopdf-sys.cfg" 1480098833 678 4792914a8f45be57bb98413425e4c7af "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/latexconfig/hyperref.cfg" 1480098833 235 6031e5765137be07eed51a510b2b8fb7 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/mmap/oml.cmap" 1480098835 1866 c1c12138091b4a8edd4a24a940e6f792 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/mmap/oms.cmap" 1480098835 2370 3b1f71b14b974f07cef532db09ae9ee0 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/mmap/omx.cmap" 1480098835 3001 252c8ca42b06a22cb1a11c0e47790c6e "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/needspace/needspace.sty" 1480098835 852 0e34dbb72efc69fa07602405ad95585e "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/auxhook.sty" 1480098836 3834 4363110eb0ef1eb2b71c8fcbcdb6c357 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/epstopdf-base.sty" 1480098836 12095 5337833c991d80788a43d3ce26bd1c46 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/grfext.sty" 1480098836 7075 2fe3d848bba95f139de11ded085e74aa "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/hypcap.sty" 1480098836 3720 63669daeb0b67d5fbec899824e2f1491 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/kvoptions.sty" 1480098836 22417 1d9df1eb66848aa31b18a593099cf45c "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/rerunfilecheck.sty" 1480098836 9581 023642318cef9f4677efe364de1e2a27 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/parskip/parskip.sty" 1480098836 2763 02a40cc5a32805c41d919cfbdba7e99a "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/t1pcr.fd" 1480098837 798 d5895e9edc628f2be019beb2c0ec66df "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/t1phv.fd" 1480098837 1488 9a55ac1cde6b4798a7f56844bb75a553 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/t1ptm.fd" 1480098837 774 61d7da1e9f9e74989b196d147e623736 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/times.sty" 1480098837 857 6c716f26c5eadfb81029fcd6ce2d45e6 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/ts1pcr.fd" 1480098837 643 92c451bb86386a4e36a174603ddb5a13 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/ts1ptm.fd" 1480098837 619 96f56dc5d1ef1fe1121f1cfeec70ee0c "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/tabulary/tabulary.sty" 1480098840 13791 8c83287d79183c3bf58fd70871e8a70b "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/titlesec/titlesec.sty" 1480098841 37387 afa86533e532701faf233f3f592c61e0 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/tools/array.sty" 1485129666 12396 d41f82b039f900e95f351e54ae740f31 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/tools/longtable.sty" 1480098841 12083 80916157594a8e4354985aaefae4f367 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/upquote/upquote.sty" 1480098842 1048 517e01cde97c1c0baf72e69d43aa5a2e "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/url/url.sty" 1480098842 12796 8edb7d69a20b857904dd0ea757c14ec9 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/varwidth/varwidth.sty" 1480098842 10894 d359a13923460b2a73d4312d613554c8 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/wrapfig/wrapfig.sty" 1480098843 26220 3701aebf80ccdef248c0c20dd062fea9 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/xcolor/xcolor.sty" 1480098843 55589 34128738f682d033422ca125f82e5d62 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/web2c/texmf.cnf" 1518824182 33095 db9a077a3f94a5d0b580d566a7906714 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-var/fonts/map/pdftex/updmap/pdftex.map" 1523607852 2700841 1bc9624fdc91e264bac08ef05942a34b "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf-var/web2c/pdftex/pdflatex.fmt" 1523607929 4139413 5fd665779d626eb6c28594ed7061af12 "" + "/data/tmplgls/wambeke/share/texlive/2017/texmf.cnf" 1523607755 455 5b996dcaa0eb4ef14a83b026bc0a008c "" + "footnotehyper-sphinx.sty" 1524638079 8886 0562fcad2b7e25f93331edc6fc422c87 "" + "salomeTools.aux" 1524653371 106073 2b781281a6d65424fa361090a2e9f8d0 "" + "salomeTools.ind" 1524653369 36465 aadaf8846c67437e6589571999e85f92 "makeindex salomeTools.idx" + "salomeTools.out" 1524653371 2961 322546514f02df4090c0b702dc220115 "" + "salomeTools.tex" 1524653368 338658 83495bb642018093f0319dce6d65ae53 "" + "salomeTools.toc" 1524653371 9038 c339204d39ab9495bf6ec9c1f8815576 "" + "sat_about.png" 1524487606 282130 625d3edc0de2910af30fe6407ab411b3 "" + "sphinx.sty" 1524638079 67712 9b578972569f0169bf44cfae88da82f2 "" + "sphinxhighlight.sty" 1524653367 8137 b8d4ef963833564f6e4eadc09cd757c4 "" + "sphinxmanual.cls" 1524638079 3589 0b0aac49c6f36925cf5f9d524a75a978 "" + "sphinxmulticell.sty" 1524638079 14618 0defbdc8536ad2e67f1eac6a1431bc55 "" + (generated) + "salomeTools.aux" + "salomeTools.out" + "salomeTools.idx" + "salomeTools.log" + "salomeTools.toc" + "salomeTools.pdf" diff --git a/doc/build/latex/salomeTools.fls b/doc/build/latex/salomeTools.fls new file mode 100644 index 0000000..58544f5 --- /dev/null +++ b/doc/build/latex/salomeTools.fls @@ -0,0 +1,346 @@ +PWD /volatile/wambeke/SAT5/SAT5_S840_MATIX24/SAT/doc/build/latex +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf.cnf +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/web2c/texmf.cnf +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-var/web2c/pdftex/pdflatex.fmt +INPUT salomeTools.tex +OUTPUT salomeTools.log +INPUT sphinxmanual.cls +INPUT sphinxmanual.cls +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/report.cls +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/report.cls +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/size10.clo +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/size10.clo +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/inputenc.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/inputenc.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/utf8.def +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/utf8.def +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/t1enc.dfu +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/t1enc.dfu +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/ot1enc.dfu +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/ot1enc.dfu +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/omsenc.dfu +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/omsenc.dfu +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/cmap/cmap.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/cmap/cmap.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/fontenc.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/fontenc.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/t1enc.def +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/t1enc.def +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/map/fontname/texfonts.map +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/jknappen/ec/ecrm1000.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/cmap/t1.cmap +OUTPUT salomeTools.pdf +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/cmap/t1.cmap +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsmath/amsmath.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsmath/amsmath.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsmath/amstext.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsmath/amstext.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsmath/amsgen.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsmath/amsgen.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsmath/amsbsy.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsmath/amsbsy.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsmath/amsopn.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsmath/amsopn.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsfonts/amssymb.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsfonts/amssymb.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsfonts/amsfonts.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsfonts/amsfonts.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/babel/babel.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/babel/babel.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/babel/switch.def +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/babel-english/english.ldf +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/babel-english/english.ldf +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/babel-english/english.ldf +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/babel/babel.def +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/babel/txtbabel.def +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/times.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/times.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/fncychap/fncychap.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/fncychap/fncychap.sty +INPUT sphinx.sty +INPUT sphinx.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/ltxcmds.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/ltxcmds.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics/graphicx.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics/graphicx.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics/keyval.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics/keyval.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics/graphics.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics/graphics.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics/trig.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics/trig.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics-cfg/graphics.cfg +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics-cfg/graphics.cfg +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics-def/pdftex.def +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics-def/pdftex.def +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/fancyhdr/fancyhdr.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/fancyhdr/fancyhdr.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/textcomp.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/textcomp.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/ts1enc.def +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/ts1enc.def +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/ts1enc.dfu +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/ts1enc.dfu +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/titlesec/titlesec.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/titlesec/titlesec.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/tabulary/tabulary.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/tabulary/tabulary.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/tools/array.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/tools/array.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/tools/longtable.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/tools/longtable.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/varwidth/varwidth.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/varwidth/varwidth.sty +INPUT sphinxmulticell.sty +INPUT sphinxmulticell.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/makeidx.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/makeidx.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/framed/framed.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/framed/framed.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/xcolor/xcolor.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/xcolor/xcolor.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/xcolor/xcolor.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics-cfg/color.cfg +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics-cfg/color.cfg +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/fancyvrb/fancyvrb.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/fancyvrb/fancyvrb.sty +INPUT footnotehyper-sphinx.sty +INPUT footnotehyper-sphinx.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/float/float.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/float/float.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/wrapfig/wrapfig.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/wrapfig/wrapfig.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/parskip/parskip.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/parskip/parskip.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/alltt.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/alltt.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/upquote/upquote.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/upquote/upquote.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/capt-of/capt-of.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/capt-of/capt-of.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/needspace/needspace.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/needspace/needspace.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/carlisle/remreset.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/carlisle/remreset.sty +INPUT sphinxhighlight.sty +INPUT sphinxhighlight.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/kvoptions.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/kvoptions.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/kvsetkeys.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/kvsetkeys.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/infwarerr.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/infwarerr.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/etexcmds.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/etexcmds.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/ifluatex.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/ifluatex.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/geometry/geometry.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/geometry/geometry.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/ifpdf.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/ifpdf.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/ifvtex.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/ifvtex.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/ifxetex/ifxetex.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/ifxetex/ifxetex.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/hyperref/hyperref.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/hyperref/hyperref.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/hobsub-hyperref.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/hobsub-hyperref.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/hobsub-hyperref.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/hobsub-generic.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/hobsub-generic.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/auxhook.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/auxhook.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/hyperref/pd1enc.def +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/hyperref/pd1enc.def +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/latexconfig/hyperref.cfg +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/latexconfig/hyperref.cfg +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/hyperref/puenc.def +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/hyperref/puenc.def +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/url/url.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/url/url.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/hyperref/hpdftex.def +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/hyperref/hpdftex.def +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/rerunfilecheck.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/rerunfilecheck.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/hypcap.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/hypcap.sty +OUTPUT salomeTools.idx +INPUT salomeTools.aux +INPUT salomeTools.aux +OUTPUT salomeTools.aux +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/ts1cmr.fd +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/ts1cmr.fd +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/t1ptm.fd +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/t1ptm.fd +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmr8t.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/context/base/mkii/supp-pdf.mkii +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/context/base/mkii/supp-pdf.mkii +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/epstopdf-base.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/epstopdf-base.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/grfext.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/grfext.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/latexconfig/epstopdf-sys.cfg +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/latexconfig/epstopdf-sys.cfg +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/hyperref/nameref.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/hyperref/nameref.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/gettitlestring.sty +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/gettitlestring.sty +INPUT salomeTools.out +INPUT salomeTools.out +INPUT salomeTools.out +INPUT salomeTools.out +INPUT ./salomeTools.out +INPUT ./salomeTools.out +OUTPUT salomeTools.out +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/t1phv.fd +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/t1phv.fd +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvr8t.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvb8t.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvb8t.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvbo8t.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvbo8t.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvb8t.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmr17.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/cmap/ot1.cmap +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/cmap/ot1.cmap +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmr12.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmmi12.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/mmap/oml.cmap +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/mmap/oml.cmap +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmmi12.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmsy10.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/mmap/oms.cmap +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/mmap/oms.cmap +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmsy10.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmex10.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/mmap/omx.cmap +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/mmap/omx.cmap +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmex10.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsfonts/umsa.fd +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsfonts/umsa.fd +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/symbols/msam10.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/symbols/msam10.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/symbols/msam10.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsfonts/umsb.fd +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsfonts/umsb.fd +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/symbols/msbm10.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/symbols/msbm10.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/symbols/msbm10.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvb8t.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/helvetic/phvb8t.vf +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvb8r.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-var/fonts/map/pdftex/updmap/pdftex.map +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/helvetic/phvbo8t.vf +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvbo8r.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/helvetic/phvb8t.vf +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvb8r.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/helvetic/phvb8t.vf +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvb8r.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmr8t.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvr8t.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvb8t.tfm +INPUT salomeTools.toc +INPUT salomeTools.toc +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmb8t.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/cmextra/cmex7.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/cmextra/cmex7.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/symbols/msam7.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/symbols/msam5.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/symbols/msbm7.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/symbols/msbm5.tfm +OUTPUT salomeTools.toc +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/helvetic/phvb8t.vf +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvb8r.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/times/ptmb8t.vf +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmb8r.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/times/ptmr8t.vf +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmr8r.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/helvetic/phvb8t.vf +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvb8r.tfm +INPUT sat_about.png +INPUT ./sat_about.png +INPUT ./sat_about.png +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/t1pcr.fd +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/t1pcr.fd +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrr8t.tfm +INPUT sat_about.png +INPUT ./sat_about.png +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmr8t.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmr8t.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmr8.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmr6.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmmi8.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmmi6.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmsy8.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmsy6.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/cmextra/cmex8.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/cmextra/cmex7.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/symbols/msam10.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/symbols/msam7.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/symbols/msbm10.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/symbols/msbm7.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmr8t.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/times/ptmr8t.vf +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmr8r.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/times/ptmr8t.vf +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmr8r.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/times/ptmr8t.vf +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmr8r.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmr8t.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrr8t.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrr8t.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrro8t.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmri8t.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmr8t.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvr8t.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/ts1ptm.fd +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/ts1ptm.fd +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmr8c.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/courier/pcrr8t.vf +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrr8r.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/courier/pcrro8t.vf +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrro8r.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/times/ptmri8t.vf +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmri8r.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/times/ptmr8c.vf +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/courier/pcrr8t.vf +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrr8r.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/ts1pcr.fd +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/ts1pcr.fd +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrro8c.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/helvetic/phvbo8t.vf +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvbo8r.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/courier/pcrro8c.vf +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrr8c.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrb8t.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/courier/pcrr8c.vf +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/courier/pcrb8t.vf +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrb8r.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrb8t.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrro8t.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/courier/pcrb8t.vf +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrb8r.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/courier/pcrro8t.vf +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrro8r.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrb8c.tfm +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/courier/pcrb8c.vf +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/helvetic/phvr8t.vf +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvr8r.tfm +INPUT salomeTools.ind +INPUT salomeTools.ind +INPUT salomeTools.aux +INPUT ./salomeTools.out +INPUT ./salomeTools.out +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/enc/dvips/base/8r.enc +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/public/amsfonts/cm/cmmi5.pfb +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/public/amsfonts/cm/cmsy5.pfb +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/urw/courier/ucrb8a.pfb +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/urw/courier/ucrr8a.pfb +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/urw/courier/ucrro8a.pfb +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/urw/helvetic/uhvb8a.pfb +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/urw/helvetic/uhvbo8a.pfb +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/urw/helvetic/uhvr8a.pfb +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/urw/times/utmb8a.pfb +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/urw/times/utmr8a.pfb +INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/urw/times/utmri8a.pfb diff --git a/doc/build/latex/salomeTools.idx b/doc/build/latex/salomeTools.idx new file mode 100644 index 0000000..7cb620a --- /dev/null +++ b/doc/build/latex/salomeTools.idx @@ -0,0 +1,512 @@ +\indexentry{src.\_\_init\_\_ (module)|hyperpage}{29} +\indexentry{Path (class in src.\_\_init\_\_)|hyperpage}{29} +\indexentry{base() (src.\_\_init\_\_.Path method)|hyperpage}{29} +\indexentry{chmod() (src.\_\_init\_\_.Path method)|hyperpage}{29} +\indexentry{copy() (src.\_\_init\_\_.Path method)|hyperpage}{29} +\indexentry{copydir() (src.\_\_init\_\_.Path method)|hyperpage}{29} +\indexentry{copyfile() (src.\_\_init\_\_.Path method)|hyperpage}{29} +\indexentry{copylink() (src.\_\_init\_\_.Path method)|hyperpage}{29} +\indexentry{dir() (src.\_\_init\_\_.Path method)|hyperpage}{29} +\indexentry{exists() (src.\_\_init\_\_.Path method)|hyperpage}{29} +\indexentry{isdir() (src.\_\_init\_\_.Path method)|hyperpage}{29} +\indexentry{isfile() (src.\_\_init\_\_.Path method)|hyperpage}{29} +\indexentry{islink() (src.\_\_init\_\_.Path method)|hyperpage}{29} +\indexentry{list() (src.\_\_init\_\_.Path method)|hyperpage}{29} +\indexentry{make() (src.\_\_init\_\_.Path method)|hyperpage}{29} +\indexentry{readlink() (src.\_\_init\_\_.Path method)|hyperpage}{29} +\indexentry{rm() (src.\_\_init\_\_.Path method)|hyperpage}{29} +\indexentry{smartcopy() (src.\_\_init\_\_.Path method)|hyperpage}{29} +\indexentry{symlink() (src.\_\_init\_\_.Path method)|hyperpage}{29} +\indexentry{SatException|hyperpage}{29} +\indexentry{activate\_mesa\_property() (in module src.\_\_init\_\_)|hyperpage}{29} +\indexentry{check\_config\_has\_application() (in module src.\_\_init\_\_)|hyperpage}{29} +\indexentry{check\_config\_has\_profile() (in module src.\_\_init\_\_)|hyperpage}{30} +\indexentry{config\_has\_application() (in module src.\_\_init\_\_)|hyperpage}{30} +\indexentry{deepcopy\_list() (in module src.\_\_init\_\_)|hyperpage}{30} +\indexentry{ensure\_path\_exists() (in module src.\_\_init\_\_)|hyperpage}{30} +\indexentry{find\_file\_in\_lpath() (in module src.\_\_init\_\_)|hyperpage}{30} +\indexentry{get\_base\_path() (in module src.\_\_init\_\_)|hyperpage}{30} +\indexentry{get\_cfg\_param() (in module src.\_\_init\_\_)|hyperpage}{30} +\indexentry{get\_launcher\_name() (in module src.\_\_init\_\_)|hyperpage}{30} +\indexentry{get\_log\_path() (in module src.\_\_init\_\_)|hyperpage}{31} +\indexentry{get\_property\_in\_product\_cfg() (in module src.\_\_init\_\_)|hyperpage}{31} +\indexentry{get\_salome\_version() (in module src.\_\_init\_\_)|hyperpage}{31} +\indexentry{get\_tmp\_filename() (in module src.\_\_init\_\_)|hyperpage}{31} +\indexentry{handleRemoveReadonly() (in module src.\_\_init\_\_)|hyperpage}{31} +\indexentry{merge\_dicts() (in module src.\_\_init\_\_)|hyperpage}{31} +\indexentry{only\_numbers() (in module src.\_\_init\_\_)|hyperpage}{31} +\indexentry{parse\_date() (in module src.\_\_init\_\_)|hyperpage}{31} +\indexentry{print\_info() (in module src.\_\_init\_\_)|hyperpage}{31} +\indexentry{read\_config\_from\_a\_file() (in module src.\_\_init\_\_)|hyperpage}{31} +\indexentry{remove\_item\_from\_list() (in module src.\_\_init\_\_)|hyperpage}{31} +\indexentry{replace\_in\_file() (in module src.\_\_init\_\_)|hyperpage}{31} +\indexentry{src.ElementTree (module)|hyperpage}{31} +\indexentry{Comment() (in module src.ElementTree)|hyperpage}{31} +\indexentry{dump() (in module src.ElementTree)|hyperpage}{31} +\indexentry{Element() (in module src.ElementTree)|hyperpage}{31} +\indexentry{ElementTree (class in src.ElementTree)|hyperpage}{31} +\indexentry{find() (src.ElementTree.ElementTree method)|hyperpage}{31} +\indexentry{findall() (src.ElementTree.ElementTree method)|hyperpage}{31} +\indexentry{findtext() (src.ElementTree.ElementTree method)|hyperpage}{32} +\indexentry{getiterator() (src.ElementTree.ElementTree method)|hyperpage}{32} +\indexentry{getroot() (src.ElementTree.ElementTree method)|hyperpage}{32} +\indexentry{parse() (src.ElementTree.ElementTree method)|hyperpage}{32} +\indexentry{write() (src.ElementTree.ElementTree method)|hyperpage}{32} +\indexentry{fromstring() (in module src.ElementTree)|hyperpage}{32} +\indexentry{iselement() (in module src.ElementTree)|hyperpage}{32} +\indexentry{iterparse (class in src.ElementTree)|hyperpage}{32} +\indexentry{next() (src.ElementTree.iterparse method)|hyperpage}{32} +\indexentry{parse() (in module src.ElementTree)|hyperpage}{32} +\indexentry{PI() (in module src.ElementTree)|hyperpage}{32} +\indexentry{ProcessingInstruction() (in module src.ElementTree)|hyperpage}{32} +\indexentry{QName (class in src.ElementTree)|hyperpage}{32} +\indexentry{SubElement() (in module src.ElementTree)|hyperpage}{32} +\indexentry{tostring() (in module src.ElementTree)|hyperpage}{32} +\indexentry{TreeBuilder (class in src.ElementTree)|hyperpage}{32} +\indexentry{close() (src.ElementTree.TreeBuilder method)|hyperpage}{32} +\indexentry{data() (src.ElementTree.TreeBuilder method)|hyperpage}{32} +\indexentry{end() (src.ElementTree.TreeBuilder method)|hyperpage}{32} +\indexentry{start() (src.ElementTree.TreeBuilder method)|hyperpage}{32} +\indexentry{XML() (in module src.ElementTree)|hyperpage}{32} +\indexentry{XMLTreeBuilder (class in src.ElementTree)|hyperpage}{32} +\indexentry{close() (src.ElementTree.XMLTreeBuilder method)|hyperpage}{32} +\indexentry{doctype() (src.ElementTree.XMLTreeBuilder method)|hyperpage}{32} +\indexentry{feed() (src.ElementTree.XMLTreeBuilder method)|hyperpage}{32} +\indexentry{src.architecture (module)|hyperpage}{32} +\indexentry{get\_distrib\_version() (in module src.architecture)|hyperpage}{32} +\indexentry{get\_distribution() (in module src.architecture)|hyperpage}{32} +\indexentry{get\_nb\_proc() (in module src.architecture)|hyperpage}{33} +\indexentry{get\_python\_version() (in module src.architecture)|hyperpage}{33} +\indexentry{get\_user() (in module src.architecture)|hyperpage}{33} +\indexentry{is\_windows() (in module src.architecture)|hyperpage}{33} +\indexentry{src.compilation (module)|hyperpage}{33} +\indexentry{Builder (class in src.compilation)|hyperpage}{33} +\indexentry{build\_configure() (src.compilation.Builder method)|hyperpage}{33} +\indexentry{check() (src.compilation.Builder method)|hyperpage}{33} +\indexentry{cmake() (src.compilation.Builder method)|hyperpage}{33} +\indexentry{complete\_environment() (src.compilation.Builder method)|hyperpage}{33} +\indexentry{configure() (src.compilation.Builder method)|hyperpage}{33} +\indexentry{do\_batch\_script\_build() (src.compilation.Builder method)|hyperpage}{33} +\indexentry{do\_default\_build() (src.compilation.Builder method)|hyperpage}{33} +\indexentry{do\_python\_script\_build() (src.compilation.Builder method)|hyperpage}{33} +\indexentry{do\_script\_build() (src.compilation.Builder method)|hyperpage}{33} +\indexentry{hack\_libtool() (src.compilation.Builder method)|hyperpage}{33} +\indexentry{install() (src.compilation.Builder method)|hyperpage}{33} +\indexentry{log() (src.compilation.Builder method)|hyperpage}{33} +\indexentry{log\_command() (src.compilation.Builder method)|hyperpage}{33} +\indexentry{make() (src.compilation.Builder method)|hyperpage}{33} +\indexentry{prepare() (src.compilation.Builder method)|hyperpage}{33} +\indexentry{put\_txt\_log\_in\_appli\_log\_dir() (src.compilation.Builder method)|hyperpage}{33} +\indexentry{wmake() (src.compilation.Builder method)|hyperpage}{34} +\indexentry{src.debug (module)|hyperpage}{34} +\indexentry{InStream (class in src.debug)|hyperpage}{34} +\indexentry{OutStream (class in src.debug)|hyperpage}{34} +\indexentry{close() (src.debug.OutStream method)|hyperpage}{34} +\indexentry{getLocalEnv() (in module src.debug)|hyperpage}{34} +\indexentry{getStrConfigDbg() (in module src.debug)|hyperpage}{34} +\indexentry{getStrConfigStd() (in module src.debug)|hyperpage}{34} +\indexentry{indent() (in module src.debug)|hyperpage}{34} +\indexentry{pop\_debug() (in module src.debug)|hyperpage}{34} +\indexentry{push\_debug() (in module src.debug)|hyperpage}{34} +\indexentry{saveConfigDbg() (in module src.debug)|hyperpage}{34} +\indexentry{saveConfigStd() (in module src.debug)|hyperpage}{34} +\indexentry{tofix() (in module src.debug)|hyperpage}{35} +\indexentry{write() (in module src.debug)|hyperpage}{35} +\indexentry{src.environment (module)|hyperpage}{35} +\indexentry{Environ (class in src.environment)|hyperpage}{35} +\indexentry{append() (src.environment.Environ method)|hyperpage}{35} +\indexentry{append\_value() (src.environment.Environ method)|hyperpage}{35} +\indexentry{command\_value() (src.environment.Environ method)|hyperpage}{35} +\indexentry{get() (src.environment.Environ method)|hyperpage}{35} +\indexentry{is\_defined() (src.environment.Environ method)|hyperpage}{35} +\indexentry{prepend() (src.environment.Environ method)|hyperpage}{35} +\indexentry{prepend\_value() (src.environment.Environ method)|hyperpage}{35} +\indexentry{set() (src.environment.Environ method)|hyperpage}{36} +\indexentry{FileEnvWriter (class in src.environment)|hyperpage}{36} +\indexentry{write\_cfgForPy\_file() (src.environment.FileEnvWriter method)|hyperpage}{36} +\indexentry{write\_env\_file() (src.environment.FileEnvWriter method)|hyperpage}{36} +\indexentry{SalomeEnviron (class in src.environment)|hyperpage}{36} +\indexentry{add\_comment() (src.environment.SalomeEnviron method)|hyperpage}{36} +\indexentry{add\_line() (src.environment.SalomeEnviron method)|hyperpage}{36} +\indexentry{add\_warning() (src.environment.SalomeEnviron method)|hyperpage}{36} +\indexentry{append() (src.environment.SalomeEnviron method)|hyperpage}{36} +\indexentry{dump() (src.environment.SalomeEnviron method)|hyperpage}{37} +\indexentry{finish() (src.environment.SalomeEnviron method)|hyperpage}{37} +\indexentry{get() (src.environment.SalomeEnviron method)|hyperpage}{37} +\indexentry{get\_names() (src.environment.SalomeEnviron method)|hyperpage}{37} +\indexentry{is\_defined() (src.environment.SalomeEnviron method)|hyperpage}{37} +\indexentry{load\_cfg\_environment() (src.environment.SalomeEnviron method)|hyperpage}{37} +\indexentry{prepend() (src.environment.SalomeEnviron method)|hyperpage}{37} +\indexentry{run\_env\_script() (src.environment.SalomeEnviron method)|hyperpage}{37} +\indexentry{run\_simple\_env\_script() (src.environment.SalomeEnviron method)|hyperpage}{37} +\indexentry{set() (src.environment.SalomeEnviron method)|hyperpage}{37} +\indexentry{set\_a\_product() (src.environment.SalomeEnviron method)|hyperpage}{37} +\indexentry{set\_application\_env() (src.environment.SalomeEnviron method)|hyperpage}{38} +\indexentry{set\_cpp\_env() (src.environment.SalomeEnviron method)|hyperpage}{38} +\indexentry{set\_full\_environ() (src.environment.SalomeEnviron method)|hyperpage}{38} +\indexentry{set\_products() (src.environment.SalomeEnviron method)|hyperpage}{38} +\indexentry{set\_python\_libdirs() (src.environment.SalomeEnviron method)|hyperpage}{38} +\indexentry{set\_salome\_generic\_product\_env() (src.environment.SalomeEnviron method)|hyperpage}{38} +\indexentry{set\_salome\_minimal\_product\_env() (src.environment.SalomeEnviron method)|hyperpage}{38} +\indexentry{Shell (class in src.environment)|hyperpage}{38} +\indexentry{load\_environment() (in module src.environment)|hyperpage}{38} +\indexentry{src.fileEnviron (module)|hyperpage}{39} +\indexentry{BashFileEnviron (class in src.fileEnviron)|hyperpage}{39} +\indexentry{command\_value() (src.fileEnviron.BashFileEnviron method)|hyperpage}{39} +\indexentry{finish() (src.fileEnviron.BashFileEnviron method)|hyperpage}{39} +\indexentry{set() (src.fileEnviron.BashFileEnviron method)|hyperpage}{39} +\indexentry{BatFileEnviron (class in src.fileEnviron)|hyperpage}{39} +\indexentry{add\_comment() (src.fileEnviron.BatFileEnviron method)|hyperpage}{39} +\indexentry{command\_value() (src.fileEnviron.BatFileEnviron method)|hyperpage}{39} +\indexentry{finish() (src.fileEnviron.BatFileEnviron method)|hyperpage}{39} +\indexentry{get() (src.fileEnviron.BatFileEnviron method)|hyperpage}{39} +\indexentry{set() (src.fileEnviron.BatFileEnviron method)|hyperpage}{39} +\indexentry{ContextFileEnviron (class in src.fileEnviron)|hyperpage}{39} +\indexentry{add\_echo() (src.fileEnviron.ContextFileEnviron method)|hyperpage}{40} +\indexentry{add\_warning() (src.fileEnviron.ContextFileEnviron method)|hyperpage}{40} +\indexentry{append\_value() (src.fileEnviron.ContextFileEnviron method)|hyperpage}{40} +\indexentry{command\_value() (src.fileEnviron.ContextFileEnviron method)|hyperpage}{40} +\indexentry{finish() (src.fileEnviron.ContextFileEnviron method)|hyperpage}{40} +\indexentry{get() (src.fileEnviron.ContextFileEnviron method)|hyperpage}{40} +\indexentry{prepend\_value() (src.fileEnviron.ContextFileEnviron method)|hyperpage}{40} +\indexentry{set() (src.fileEnviron.ContextFileEnviron method)|hyperpage}{40} +\indexentry{FileEnviron (class in src.fileEnviron)|hyperpage}{40} +\indexentry{add\_comment() (src.fileEnviron.FileEnviron method)|hyperpage}{40} +\indexentry{add\_echo() (src.fileEnviron.FileEnviron method)|hyperpage}{41} +\indexentry{add\_line() (src.fileEnviron.FileEnviron method)|hyperpage}{41} +\indexentry{add\_warning() (src.fileEnviron.FileEnviron method)|hyperpage}{41} +\indexentry{append() (src.fileEnviron.FileEnviron method)|hyperpage}{41} +\indexentry{append\_value() (src.fileEnviron.FileEnviron method)|hyperpage}{41} +\indexentry{command\_value() (src.fileEnviron.FileEnviron method)|hyperpage}{41} +\indexentry{finish() (src.fileEnviron.FileEnviron method)|hyperpage}{41} +\indexentry{get() (src.fileEnviron.FileEnviron method)|hyperpage}{41} +\indexentry{is\_defined() (src.fileEnviron.FileEnviron method)|hyperpage}{41} +\indexentry{prepend() (src.fileEnviron.FileEnviron method)|hyperpage}{41} +\indexentry{prepend\_value() (src.fileEnviron.FileEnviron method)|hyperpage}{42} +\indexentry{set() (src.fileEnviron.FileEnviron method)|hyperpage}{42} +\indexentry{LauncherFileEnviron (class in src.fileEnviron)|hyperpage}{42} +\indexentry{add() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{42} +\indexentry{add\_comment() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{42} +\indexentry{add\_echo() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{42} +\indexentry{add\_line() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{42} +\indexentry{add\_warning() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{42} +\indexentry{append() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{42} +\indexentry{append\_value() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{42} +\indexentry{change\_to\_launcher() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{42} +\indexentry{command\_value() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{42} +\indexentry{finish() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{43} +\indexentry{get() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{43} +\indexentry{is\_defined() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{43} +\indexentry{prepend() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{43} +\indexentry{prepend\_value() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{43} +\indexentry{set() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{43} +\indexentry{ScreenEnviron (class in src.fileEnviron)|hyperpage}{43} +\indexentry{add\_comment() (src.fileEnviron.ScreenEnviron method)|hyperpage}{43} +\indexentry{add\_echo() (src.fileEnviron.ScreenEnviron method)|hyperpage}{43} +\indexentry{add\_line() (src.fileEnviron.ScreenEnviron method)|hyperpage}{43} +\indexentry{add\_warning() (src.fileEnviron.ScreenEnviron method)|hyperpage}{43} +\indexentry{append() (src.fileEnviron.ScreenEnviron method)|hyperpage}{44} +\indexentry{command\_value() (src.fileEnviron.ScreenEnviron method)|hyperpage}{44} +\indexentry{get() (src.fileEnviron.ScreenEnviron method)|hyperpage}{44} +\indexentry{is\_defined() (src.fileEnviron.ScreenEnviron method)|hyperpage}{44} +\indexentry{prepend() (src.fileEnviron.ScreenEnviron method)|hyperpage}{44} +\indexentry{run\_env\_script() (src.fileEnviron.ScreenEnviron method)|hyperpage}{44} +\indexentry{set() (src.fileEnviron.ScreenEnviron method)|hyperpage}{44} +\indexentry{write() (src.fileEnviron.ScreenEnviron method)|hyperpage}{44} +\indexentry{get\_file\_environ() (in module src.fileEnviron)|hyperpage}{44} +\indexentry{special\_path\_separator() (in module src.fileEnviron)|hyperpage}{44} +\indexentry{src.fork (module)|hyperpage}{45} +\indexentry{batch() (in module src.fork)|hyperpage}{45} +\indexentry{batch\_salome() (in module src.fork)|hyperpage}{45} +\indexentry{launch\_command() (in module src.fork)|hyperpage}{45} +\indexentry{show\_progress() (in module src.fork)|hyperpage}{45} +\indexentry{write\_back() (in module src.fork)|hyperpage}{45} +\indexentry{src.logger (module)|hyperpage}{45} +\indexentry{Logger (class in src.logger)|hyperpage}{45} +\indexentry{add\_link() (src.logger.Logger method)|hyperpage}{45} +\indexentry{end\_write() (src.logger.Logger method)|hyperpage}{45} +\indexentry{error() (src.logger.Logger method)|hyperpage}{45} +\indexentry{flush() (src.logger.Logger method)|hyperpage}{45} +\indexentry{put\_initial\_xml\_fields() (src.logger.Logger method)|hyperpage}{46} +\indexentry{write() (src.logger.Logger method)|hyperpage}{46} +\indexentry{date\_to\_datetime() (in module src.logger)|hyperpage}{46} +\indexentry{list\_log\_file() (in module src.logger)|hyperpage}{46} +\indexentry{show\_command\_log() (in module src.logger)|hyperpage}{46} +\indexentry{timedelta\_total\_seconds() (in module src.logger)|hyperpage}{46} +\indexentry{update\_hat\_xml() (in module src.logger)|hyperpage}{46} +\indexentry{src.options (module)|hyperpage}{47} +\indexentry{OptResult (class in src.options)|hyperpage}{47} +\indexentry{Options (class in src.options)|hyperpage}{47} +\indexentry{add\_option() (src.options.Options method)|hyperpage}{47} +\indexentry{parse\_args() (src.options.Options method)|hyperpage}{47} +\indexentry{print\_help() (src.options.Options method)|hyperpage}{47} +\indexentry{src.printcolors (module)|hyperpage}{47} +\indexentry{cleancolor() (in module src.printcolors)|hyperpage}{47} +\indexentry{print\_color\_map() (in module src.printcolors)|hyperpage}{47} +\indexentry{print\_color\_range() (in module src.printcolors)|hyperpage}{48} +\indexentry{print\_value() (in module src.printcolors)|hyperpage}{48} +\indexentry{printc() (in module src.printcolors)|hyperpage}{48} +\indexentry{printcError() (in module src.printcolors)|hyperpage}{48} +\indexentry{printcHeader() (in module src.printcolors)|hyperpage}{48} +\indexentry{printcHighlight() (in module src.printcolors)|hyperpage}{48} +\indexentry{printcInfo() (in module src.printcolors)|hyperpage}{48} +\indexentry{printcLabel() (in module src.printcolors)|hyperpage}{49} +\indexentry{printcSuccess() (in module src.printcolors)|hyperpage}{49} +\indexentry{printcWarning() (in module src.printcolors)|hyperpage}{49} +\indexentry{src.product (module)|hyperpage}{49} +\indexentry{check\_config\_exists() (in module src.product)|hyperpage}{49} +\indexentry{check\_installation() (in module src.product)|hyperpage}{49} +\indexentry{check\_source() (in module src.product)|hyperpage}{49} +\indexentry{get\_base\_install\_dir() (in module src.product)|hyperpage}{49} +\indexentry{get\_install\_dir() (in module src.product)|hyperpage}{50} +\indexentry{get\_product\_components() (in module src.product)|hyperpage}{50} +\indexentry{get\_product\_config() (in module src.product)|hyperpage}{50} +\indexentry{get\_product\_dependencies() (in module src.product)|hyperpage}{50} +\indexentry{get\_product\_section() (in module src.product)|hyperpage}{50} +\indexentry{get\_products\_infos() (in module src.product)|hyperpage}{51} +\indexentry{product\_compiles() (in module src.product)|hyperpage}{51} +\indexentry{product\_has\_env\_script() (in module src.product)|hyperpage}{51} +\indexentry{product\_has\_logo() (in module src.product)|hyperpage}{51} +\indexentry{product\_has\_patches() (in module src.product)|hyperpage}{51} +\indexentry{product\_has\_salome\_gui() (in module src.product)|hyperpage}{51} +\indexentry{product\_has\_script() (in module src.product)|hyperpage}{51} +\indexentry{product\_is\_autotools() (in module src.product)|hyperpage}{51} +\indexentry{product\_is\_cmake() (in module src.product)|hyperpage}{52} +\indexentry{product\_is\_cpp() (in module src.product)|hyperpage}{52} +\indexentry{product\_is\_debug() (in module src.product)|hyperpage}{52} +\indexentry{product\_is\_dev() (in module src.product)|hyperpage}{52} +\indexentry{product\_is\_fixed() (in module src.product)|hyperpage}{52} +\indexentry{product\_is\_generated() (in module src.product)|hyperpage}{52} +\indexentry{product\_is\_mpi() (in module src.product)|hyperpage}{52} +\indexentry{product\_is\_native() (in module src.product)|hyperpage}{52} +\indexentry{product\_is\_salome() (in module src.product)|hyperpage}{53} +\indexentry{product\_is\_sample() (in module src.product)|hyperpage}{53} +\indexentry{product\_is\_smesh\_plugin() (in module src.product)|hyperpage}{53} +\indexentry{product\_is\_vcs() (in module src.product)|hyperpage}{53} +\indexentry{src.pyconf (module)|hyperpage}{53} +\indexentry{Config (class in src.pyconf)|hyperpage}{54} +\indexentry{Config.Namespace (class in src.pyconf)|hyperpage}{54} +\indexentry{addNamespace() (src.pyconf.Config method)|hyperpage}{54} +\indexentry{getByPath() (src.pyconf.Config method)|hyperpage}{54} +\indexentry{load() (src.pyconf.Config method)|hyperpage}{54} +\indexentry{removeNamespace() (src.pyconf.Config method)|hyperpage}{55} +\indexentry{ConfigError|hyperpage}{55} +\indexentry{ConfigFormatError|hyperpage}{55} +\indexentry{ConfigInputStream (class in src.pyconf)|hyperpage}{55} +\indexentry{close() (src.pyconf.ConfigInputStream method)|hyperpage}{55} +\indexentry{read() (src.pyconf.ConfigInputStream method)|hyperpage}{55} +\indexentry{readline() (src.pyconf.ConfigInputStream method)|hyperpage}{55} +\indexentry{ConfigList (class in src.pyconf)|hyperpage}{55} +\indexentry{getByPath() (src.pyconf.ConfigList method)|hyperpage}{55} +\indexentry{ConfigMerger (class in src.pyconf)|hyperpage}{55} +\indexentry{handleMismatch() (src.pyconf.ConfigMerger method)|hyperpage}{55} +\indexentry{merge() (src.pyconf.ConfigMerger method)|hyperpage}{55} +\indexentry{mergeMapping() (src.pyconf.ConfigMerger method)|hyperpage}{55} +\indexentry{mergeSequence() (src.pyconf.ConfigMerger method)|hyperpage}{56} +\indexentry{overwriteKeys() (src.pyconf.ConfigMerger method)|hyperpage}{56} +\indexentry{ConfigOutputStream (class in src.pyconf)|hyperpage}{56} +\indexentry{close() (src.pyconf.ConfigOutputStream method)|hyperpage}{56} +\indexentry{flush() (src.pyconf.ConfigOutputStream method)|hyperpage}{56} +\indexentry{write() (src.pyconf.ConfigOutputStream method)|hyperpage}{56} +\indexentry{ConfigReader (class in src.pyconf)|hyperpage}{56} +\indexentry{getChar() (src.pyconf.ConfigReader method)|hyperpage}{56} +\indexentry{getToken() (src.pyconf.ConfigReader method)|hyperpage}{56} +\indexentry{load() (src.pyconf.ConfigReader method)|hyperpage}{56} +\indexentry{location() (src.pyconf.ConfigReader method)|hyperpage}{56} +\indexentry{match() (src.pyconf.ConfigReader method)|hyperpage}{56} +\indexentry{parseFactor() (src.pyconf.ConfigReader method)|hyperpage}{56} +\indexentry{parseKeyValuePair() (src.pyconf.ConfigReader method)|hyperpage}{57} +\indexentry{parseMapping() (src.pyconf.ConfigReader method)|hyperpage}{57} +\indexentry{parseMappingBody() (src.pyconf.ConfigReader method)|hyperpage}{57} +\indexentry{parseReference() (src.pyconf.ConfigReader method)|hyperpage}{57} +\indexentry{parseScalar() (src.pyconf.ConfigReader method)|hyperpage}{57} +\indexentry{parseSequence() (src.pyconf.ConfigReader method)|hyperpage}{57} +\indexentry{parseSuffix() (src.pyconf.ConfigReader method)|hyperpage}{57} +\indexentry{parseTerm() (src.pyconf.ConfigReader method)|hyperpage}{57} +\indexentry{parseValue() (src.pyconf.ConfigReader method)|hyperpage}{57} +\indexentry{setStream() (src.pyconf.ConfigReader method)|hyperpage}{57} +\indexentry{ConfigResolutionError|hyperpage}{57} +\indexentry{Container (class in src.pyconf)|hyperpage}{57} +\indexentry{evaluate() (src.pyconf.Container method)|hyperpage}{58} +\indexentry{setPath() (src.pyconf.Container method)|hyperpage}{58} +\indexentry{writeToStream() (src.pyconf.Container method)|hyperpage}{58} +\indexentry{writeValue() (src.pyconf.Container method)|hyperpage}{58} +\indexentry{Expression (class in src.pyconf)|hyperpage}{58} +\indexentry{evaluate() (src.pyconf.Expression method)|hyperpage}{58} +\indexentry{Mapping (class in src.pyconf)|hyperpage}{58} +\indexentry{addMapping() (src.pyconf.Mapping method)|hyperpage}{58} +\indexentry{get() (src.pyconf.Mapping method)|hyperpage}{58} +\indexentry{iteritems() (src.pyconf.Mapping method)|hyperpage}{58} +\indexentry{iterkeys() (src.pyconf.Mapping method)|hyperpage}{58} +\indexentry{keys() (src.pyconf.Mapping method)|hyperpage}{58} +\indexentry{writeToStream() (src.pyconf.Mapping method)|hyperpage}{59} +\indexentry{Reference (class in src.pyconf)|hyperpage}{59} +\indexentry{addElement() (src.pyconf.Reference method)|hyperpage}{59} +\indexentry{findConfig() (src.pyconf.Reference method)|hyperpage}{59} +\indexentry{resolve() (src.pyconf.Reference method)|hyperpage}{59} +\indexentry{Sequence (class in src.pyconf)|hyperpage}{59} +\indexentry{Sequence.SeqIter (class in src.pyconf)|hyperpage}{59} +\indexentry{next() (src.pyconf.Sequence.SeqIter method)|hyperpage}{59} +\indexentry{append() (src.pyconf.Sequence method)|hyperpage}{59} +\indexentry{writeToStream() (src.pyconf.Sequence method)|hyperpage}{59} +\indexentry{deepCopyMapping() (in module src.pyconf)|hyperpage}{59} +\indexentry{defaultMergeResolve() (in module src.pyconf)|hyperpage}{59} +\indexentry{defaultStreamOpener() (in module src.pyconf)|hyperpage}{60} +\indexentry{isWord() (in module src.pyconf)|hyperpage}{60} +\indexentry{makePath() (in module src.pyconf)|hyperpage}{60} +\indexentry{overwriteMergeResolve() (in module src.pyconf)|hyperpage}{60} +\indexentry{src.system (module)|hyperpage}{60} +\indexentry{archive\_extract() (in module src.system)|hyperpage}{60} +\indexentry{cvs\_extract() (in module src.system)|hyperpage}{60} +\indexentry{git\_extract() (in module src.system)|hyperpage}{61} +\indexentry{show\_in\_editor() (in module src.system)|hyperpage}{61} +\indexentry{svn\_extract() (in module src.system)|hyperpage}{61} +\indexentry{src.template (module)|hyperpage}{62} +\indexentry{MyTemplate (class in src.template)|hyperpage}{62} +\indexentry{delimiter (src.template.MyTemplate attribute)|hyperpage}{62} +\indexentry{pattern (src.template.MyTemplate attribute)|hyperpage}{62} +\indexentry{substitute() (in module src.template)|hyperpage}{62} +\indexentry{src.test\_module (module)|hyperpage}{62} +\indexentry{Test (class in src.test\_module)|hyperpage}{62} +\indexentry{generate\_launching\_commands() (src.test\_module.Test method)|hyperpage}{62} +\indexentry{generate\_script() (src.test\_module.Test method)|hyperpage}{62} +\indexentry{get\_test\_timeout() (src.test\_module.Test method)|hyperpage}{62} +\indexentry{get\_tmp\_dir() (src.test\_module.Test method)|hyperpage}{62} +\indexentry{prepare\_testbase() (src.test\_module.Test method)|hyperpage}{62} +\indexentry{prepare\_testbase\_from\_dir() (src.test\_module.Test method)|hyperpage}{62} +\indexentry{prepare\_testbase\_from\_git() (src.test\_module.Test method)|hyperpage}{62} +\indexentry{prepare\_testbase\_from\_svn() (src.test\_module.Test method)|hyperpage}{62} +\indexentry{read\_results() (src.test\_module.Test method)|hyperpage}{62} +\indexentry{run\_all\_tests() (src.test\_module.Test method)|hyperpage}{62} +\indexentry{run\_grid\_tests() (src.test\_module.Test method)|hyperpage}{62} +\indexentry{run\_script() (src.test\_module.Test method)|hyperpage}{62} +\indexentry{run\_session\_tests() (src.test\_module.Test method)|hyperpage}{62} +\indexentry{run\_testbase\_tests() (src.test\_module.Test method)|hyperpage}{62} +\indexentry{run\_tests() (src.test\_module.Test method)|hyperpage}{62} +\indexentry{search\_known\_errors() (src.test\_module.Test method)|hyperpage}{62} +\indexentry{write\_test\_margin() (src.test\_module.Test method)|hyperpage}{62} +\indexentry{getTmpDirDEFAULT() (in module src.test\_module)|hyperpage}{62} +\indexentry{src.xmlManager (module)|hyperpage}{62} +\indexentry{ReadXmlFile (class in src.xmlManager)|hyperpage}{62} +\indexentry{getRootAttrib() (src.xmlManager.ReadXmlFile method)|hyperpage}{62} +\indexentry{get\_attrib() (src.xmlManager.ReadXmlFile method)|hyperpage}{63} +\indexentry{get\_node\_text() (src.xmlManager.ReadXmlFile method)|hyperpage}{63} +\indexentry{XmlLogFile (class in src.xmlManager)|hyperpage}{63} +\indexentry{add\_simple\_node() (src.xmlManager.XmlLogFile method)|hyperpage}{63} +\indexentry{append\_node\_attrib() (src.xmlManager.XmlLogFile method)|hyperpage}{63} +\indexentry{append\_node\_text() (src.xmlManager.XmlLogFile method)|hyperpage}{63} +\indexentry{write\_tree() (src.xmlManager.XmlLogFile method)|hyperpage}{63} +\indexentry{add\_simple\_node() (in module src.xmlManager)|hyperpage}{63} +\indexentry{append\_node\_attrib() (in module src.xmlManager)|hyperpage}{64} +\indexentry{find\_node\_by\_attrib() (in module src.xmlManager)|hyperpage}{64} +\indexentry{write\_report() (in module src.xmlManager)|hyperpage}{64} +\indexentry{src.colorama (module)|hyperpage}{64} +\indexentry{src.colorama.ansi (module)|hyperpage}{64} +\indexentry{AnsiBack (class in src.colorama.ansi)|hyperpage}{64} +\indexentry{BLACK (src.colorama.ansi.AnsiBack attribute)|hyperpage}{64} +\indexentry{BLUE (src.colorama.ansi.AnsiBack attribute)|hyperpage}{64} +\indexentry{CYAN (src.colorama.ansi.AnsiBack attribute)|hyperpage}{64} +\indexentry{GREEN (src.colorama.ansi.AnsiBack attribute)|hyperpage}{64} +\indexentry{LIGHTBLACK\_EX (src.colorama.ansi.AnsiBack attribute)|hyperpage}{64} +\indexentry{LIGHTBLUE\_EX (src.colorama.ansi.AnsiBack attribute)|hyperpage}{64} +\indexentry{LIGHTCYAN\_EX (src.colorama.ansi.AnsiBack attribute)|hyperpage}{65} +\indexentry{LIGHTGREEN\_EX (src.colorama.ansi.AnsiBack attribute)|hyperpage}{65} +\indexentry{LIGHTMAGENTA\_EX (src.colorama.ansi.AnsiBack attribute)|hyperpage}{65} +\indexentry{LIGHTRED\_EX (src.colorama.ansi.AnsiBack attribute)|hyperpage}{65} +\indexentry{LIGHTWHITE\_EX (src.colorama.ansi.AnsiBack attribute)|hyperpage}{65} +\indexentry{LIGHTYELLOW\_EX (src.colorama.ansi.AnsiBack attribute)|hyperpage}{65} +\indexentry{MAGENTA (src.colorama.ansi.AnsiBack attribute)|hyperpage}{65} +\indexentry{RED (src.colorama.ansi.AnsiBack attribute)|hyperpage}{65} +\indexentry{RESET (src.colorama.ansi.AnsiBack attribute)|hyperpage}{65} +\indexentry{WHITE (src.colorama.ansi.AnsiBack attribute)|hyperpage}{65} +\indexentry{YELLOW (src.colorama.ansi.AnsiBack attribute)|hyperpage}{65} +\indexentry{AnsiCodes (class in src.colorama.ansi)|hyperpage}{65} +\indexentry{AnsiCursor (class in src.colorama.ansi)|hyperpage}{65} +\indexentry{BACK() (src.colorama.ansi.AnsiCursor method)|hyperpage}{65} +\indexentry{DOWN() (src.colorama.ansi.AnsiCursor method)|hyperpage}{65} +\indexentry{FORWARD() (src.colorama.ansi.AnsiCursor method)|hyperpage}{65} +\indexentry{POS() (src.colorama.ansi.AnsiCursor method)|hyperpage}{65} +\indexentry{UP() (src.colorama.ansi.AnsiCursor method)|hyperpage}{65} +\indexentry{AnsiFore (class in src.colorama.ansi)|hyperpage}{65} +\indexentry{BLACK (src.colorama.ansi.AnsiFore attribute)|hyperpage}{65} +\indexentry{BLUE (src.colorama.ansi.AnsiFore attribute)|hyperpage}{65} +\indexentry{CYAN (src.colorama.ansi.AnsiFore attribute)|hyperpage}{65} +\indexentry{GREEN (src.colorama.ansi.AnsiFore attribute)|hyperpage}{65} +\indexentry{LIGHTBLACK\_EX (src.colorama.ansi.AnsiFore attribute)|hyperpage}{65} +\indexentry{LIGHTBLUE\_EX (src.colorama.ansi.AnsiFore attribute)|hyperpage}{65} +\indexentry{LIGHTCYAN\_EX (src.colorama.ansi.AnsiFore attribute)|hyperpage}{65} +\indexentry{LIGHTGREEN\_EX (src.colorama.ansi.AnsiFore attribute)|hyperpage}{65} +\indexentry{LIGHTMAGENTA\_EX (src.colorama.ansi.AnsiFore attribute)|hyperpage}{65} +\indexentry{LIGHTRED\_EX (src.colorama.ansi.AnsiFore attribute)|hyperpage}{65} +\indexentry{LIGHTWHITE\_EX (src.colorama.ansi.AnsiFore attribute)|hyperpage}{65} +\indexentry{LIGHTYELLOW\_EX (src.colorama.ansi.AnsiFore attribute)|hyperpage}{65} +\indexentry{MAGENTA (src.colorama.ansi.AnsiFore attribute)|hyperpage}{65} +\indexentry{RED (src.colorama.ansi.AnsiFore attribute)|hyperpage}{65} +\indexentry{RESET (src.colorama.ansi.AnsiFore attribute)|hyperpage}{65} +\indexentry{WHITE (src.colorama.ansi.AnsiFore attribute)|hyperpage}{65} +\indexentry{YELLOW (src.colorama.ansi.AnsiFore attribute)|hyperpage}{65} +\indexentry{AnsiStyle (class in src.colorama.ansi)|hyperpage}{65} +\indexentry{BRIGHT (src.colorama.ansi.AnsiStyle attribute)|hyperpage}{66} +\indexentry{DIM (src.colorama.ansi.AnsiStyle attribute)|hyperpage}{66} +\indexentry{NORMAL (src.colorama.ansi.AnsiStyle attribute)|hyperpage}{66} +\indexentry{RESET\_ALL (src.colorama.ansi.AnsiStyle attribute)|hyperpage}{66} +\indexentry{clear\_line() (in module src.colorama.ansi)|hyperpage}{66} +\indexentry{clear\_screen() (in module src.colorama.ansi)|hyperpage}{66} +\indexentry{code\_to\_chars() (in module src.colorama.ansi)|hyperpage}{66} +\indexentry{set\_title() (in module src.colorama.ansi)|hyperpage}{66} +\indexentry{src.colorama.ansitowin32 (module)|hyperpage}{66} +\indexentry{AnsiToWin32 (class in src.colorama.ansitowin32)|hyperpage}{66} +\indexentry{ANSI\_CSI\_RE (src.colorama.ansitowin32.AnsiToWin32 attribute)|hyperpage}{66} +\indexentry{ANSI\_OSC\_RE (src.colorama.ansitowin32.AnsiToWin32 attribute)|hyperpage}{66} +\indexentry{call\_win32() (src.colorama.ansitowin32.AnsiToWin32 method)|hyperpage}{66} +\indexentry{convert\_ansi() (src.colorama.ansitowin32.AnsiToWin32 method)|hyperpage}{66} +\indexentry{convert\_osc() (src.colorama.ansitowin32.AnsiToWin32 method)|hyperpage}{66} +\indexentry{extract\_params() (src.colorama.ansitowin32.AnsiToWin32 method)|hyperpage}{66} +\indexentry{get\_win32\_calls() (src.colorama.ansitowin32.AnsiToWin32 method)|hyperpage}{66} +\indexentry{reset\_all() (src.colorama.ansitowin32.AnsiToWin32 method)|hyperpage}{66} +\indexentry{should\_wrap() (src.colorama.ansitowin32.AnsiToWin32 method)|hyperpage}{66} +\indexentry{write() (src.colorama.ansitowin32.AnsiToWin32 method)|hyperpage}{66} +\indexentry{write\_and\_convert() (src.colorama.ansitowin32.AnsiToWin32 method)|hyperpage}{66} +\indexentry{write\_plain\_text() (src.colorama.ansitowin32.AnsiToWin32 method)|hyperpage}{66} +\indexentry{StreamWrapper (class in src.colorama.ansitowin32)|hyperpage}{66} +\indexentry{write() (src.colorama.ansitowin32.StreamWrapper method)|hyperpage}{66} +\indexentry{is\_a\_tty() (in module src.colorama.ansitowin32)|hyperpage}{66} +\indexentry{is\_stream\_closed() (in module src.colorama.ansitowin32)|hyperpage}{66} +\indexentry{src.colorama.initialise (module)|hyperpage}{67} +\indexentry{colorama\_text() (in module src.colorama.initialise)|hyperpage}{67} +\indexentry{deinit() (in module src.colorama.initialise)|hyperpage}{67} +\indexentry{init() (in module src.colorama.initialise)|hyperpage}{67} +\indexentry{reinit() (in module src.colorama.initialise)|hyperpage}{67} +\indexentry{reset\_all() (in module src.colorama.initialise)|hyperpage}{67} +\indexentry{wrap\_stream() (in module src.colorama.initialise)|hyperpage}{67} +\indexentry{src.colorama.win32 (module)|hyperpage}{67} +\indexentry{SetConsoleTextAttribute() (in module src.colorama.win32)|hyperpage}{67} +\indexentry{winapi\_test() (in module src.colorama.win32)|hyperpage}{67} +\indexentry{src.colorama.winterm (module)|hyperpage}{67} +\indexentry{WinColor (class in src.colorama.winterm)|hyperpage}{67} +\indexentry{BLACK (src.colorama.winterm.WinColor attribute)|hyperpage}{67} +\indexentry{BLUE (src.colorama.winterm.WinColor attribute)|hyperpage}{67} +\indexentry{CYAN (src.colorama.winterm.WinColor attribute)|hyperpage}{67} +\indexentry{GREEN (src.colorama.winterm.WinColor attribute)|hyperpage}{67} +\indexentry{GREY (src.colorama.winterm.WinColor attribute)|hyperpage}{67} +\indexentry{MAGENTA (src.colorama.winterm.WinColor attribute)|hyperpage}{67} +\indexentry{RED (src.colorama.winterm.WinColor attribute)|hyperpage}{67} +\indexentry{YELLOW (src.colorama.winterm.WinColor attribute)|hyperpage}{67} +\indexentry{WinStyle (class in src.colorama.winterm)|hyperpage}{67} +\indexentry{BRIGHT (src.colorama.winterm.WinStyle attribute)|hyperpage}{67} +\indexentry{BRIGHT\_BACKGROUND (src.colorama.winterm.WinStyle attribute)|hyperpage}{67} +\indexentry{NORMAL (src.colorama.winterm.WinStyle attribute)|hyperpage}{67} +\indexentry{WinTerm (class in src.colorama.winterm)|hyperpage}{67} +\indexentry{back() (src.colorama.winterm.WinTerm method)|hyperpage}{67} +\indexentry{cursor\_adjust() (src.colorama.winterm.WinTerm method)|hyperpage}{67} +\indexentry{erase\_line() (src.colorama.winterm.WinTerm method)|hyperpage}{67} +\indexentry{erase\_screen() (src.colorama.winterm.WinTerm method)|hyperpage}{67} +\indexentry{fore() (src.colorama.winterm.WinTerm method)|hyperpage}{67} +\indexentry{get\_attrs() (src.colorama.winterm.WinTerm method)|hyperpage}{67} +\indexentry{get\_position() (src.colorama.winterm.WinTerm method)|hyperpage}{67} +\indexentry{reset\_all() (src.colorama.winterm.WinTerm method)|hyperpage}{67} +\indexentry{set\_attrs() (src.colorama.winterm.WinTerm method)|hyperpage}{67} +\indexentry{set\_console() (src.colorama.winterm.WinTerm method)|hyperpage}{67} +\indexentry{set\_cursor\_position() (src.colorama.winterm.WinTerm method)|hyperpage}{68} +\indexentry{set\_title() (src.colorama.winterm.WinTerm method)|hyperpage}{68} +\indexentry{style() (src.colorama.winterm.WinTerm method)|hyperpage}{68} diff --git a/doc/build/latex/salomeTools.ilg b/doc/build/latex/salomeTools.ilg new file mode 100644 index 0000000..4bbd791 --- /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 (7 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..72c38d8 --- /dev/null +++ b/doc/build/latex/salomeTools.ind @@ -0,0 +1,584 @@ +\begin{sphinxtheindex} +\def\bigletter#1{{\Large\sffamily#1}\nopagebreak\vspace{1mm}} + + \bigletter A + \item activate\_mesa\_property() (in module src.\_\_init\_\_), \hyperpage{29} + \item add() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{42} + \item add\_comment() (src.environment.SalomeEnviron method), \hyperpage{36} + \item add\_comment() (src.fileEnviron.BatFileEnviron method), \hyperpage{39} + \item add\_comment() (src.fileEnviron.FileEnviron method), \hyperpage{40} + \item add\_comment() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{42} + \item add\_comment() (src.fileEnviron.ScreenEnviron method), \hyperpage{43} + \item add\_echo() (src.fileEnviron.ContextFileEnviron method), \hyperpage{40} + \item add\_echo() (src.fileEnviron.FileEnviron method), \hyperpage{41} + \item add\_echo() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{42} + \item add\_echo() (src.fileEnviron.ScreenEnviron method), \hyperpage{43} + \item add\_line() (src.environment.SalomeEnviron method), \hyperpage{36} + \item add\_line() (src.fileEnviron.FileEnviron method), \hyperpage{41} + \item add\_line() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{42} + \item add\_line() (src.fileEnviron.ScreenEnviron method), \hyperpage{43} + \item add\_link() (src.logger.Logger method), \hyperpage{45} + \item add\_option() (src.options.Options method), \hyperpage{47} + \item add\_simple\_node() (in module src.xmlManager), \hyperpage{63} + \item add\_simple\_node() (src.xmlManager.XmlLogFile method), \hyperpage{63} + \item add\_warning() (src.environment.SalomeEnviron method), \hyperpage{36} + \item add\_warning() (src.fileEnviron.ContextFileEnviron method), \hyperpage{40} + \item add\_warning() (src.fileEnviron.FileEnviron method), \hyperpage{41} + \item add\_warning() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{42} + \item add\_warning() (src.fileEnviron.ScreenEnviron method), \hyperpage{43} + \item addElement() (src.pyconf.Reference method), \hyperpage{59} + \item addMapping() (src.pyconf.Mapping method), \hyperpage{58} + \item addNamespace() (src.pyconf.Config method), \hyperpage{54} + \item ANSI\_CSI\_RE (src.colorama.ansitowin32.AnsiToWin32 attribute), \hyperpage{66} + \item ANSI\_OSC\_RE (src.colorama.ansitowin32.AnsiToWin32 attribute), \hyperpage{66} + \item AnsiBack (class in src.colorama.ansi), \hyperpage{64} + \item AnsiCodes (class in src.colorama.ansi), \hyperpage{65} + \item AnsiCursor (class in src.colorama.ansi), \hyperpage{65} + \item AnsiFore (class in src.colorama.ansi), \hyperpage{65} + \item AnsiStyle (class in src.colorama.ansi), \hyperpage{65} + \item AnsiToWin32 (class in src.colorama.ansitowin32), \hyperpage{66} + \item append() (src.environment.Environ method), \hyperpage{35} + \item append() (src.environment.SalomeEnviron method), \hyperpage{36} + \item append() (src.fileEnviron.FileEnviron method), \hyperpage{41} + \item append() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{42} + \item append() (src.fileEnviron.ScreenEnviron method), \hyperpage{44} + \item append() (src.pyconf.Sequence method), \hyperpage{59} + \item append\_node\_attrib() (in module src.xmlManager), \hyperpage{64} + \item append\_node\_attrib() (src.xmlManager.XmlLogFile method), \hyperpage{63} + \item append\_node\_text() (src.xmlManager.XmlLogFile method), \hyperpage{63} + \item append\_value() (src.environment.Environ method), \hyperpage{35} + \item append\_value() (src.fileEnviron.ContextFileEnviron method), \hyperpage{40} + \item append\_value() (src.fileEnviron.FileEnviron method), \hyperpage{41} + \item append\_value() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{42} + \item archive\_extract() (in module src.system), \hyperpage{60} + + \indexspace + \bigletter B + \item BACK() (src.colorama.ansi.AnsiCursor method), \hyperpage{65} + \item back() (src.colorama.winterm.WinTerm method), \hyperpage{67} + \item base() (src.\_\_init\_\_.Path method), \hyperpage{29} + \item BashFileEnviron (class in src.fileEnviron), \hyperpage{39} + \item batch() (in module src.fork), \hyperpage{45} + \item batch\_salome() (in module src.fork), \hyperpage{45} + \item BatFileEnviron (class in src.fileEnviron), \hyperpage{39} + \item BLACK (src.colorama.ansi.AnsiBack attribute), \hyperpage{64} + \item BLACK (src.colorama.ansi.AnsiFore attribute), \hyperpage{65} + \item BLACK (src.colorama.winterm.WinColor attribute), \hyperpage{67} + \item BLUE (src.colorama.ansi.AnsiBack attribute), \hyperpage{64} + \item BLUE (src.colorama.ansi.AnsiFore attribute), \hyperpage{65} + \item BLUE (src.colorama.winterm.WinColor attribute), \hyperpage{67} + \item BRIGHT (src.colorama.ansi.AnsiStyle attribute), \hyperpage{66} + \item BRIGHT (src.colorama.winterm.WinStyle attribute), \hyperpage{67} + \item BRIGHT\_BACKGROUND (src.colorama.winterm.WinStyle attribute), \hyperpage{67} + \item build\_configure() (src.compilation.Builder method), \hyperpage{33} + \item Builder (class in src.compilation), \hyperpage{33} + + \indexspace + \bigletter C + \item call\_win32() (src.colorama.ansitowin32.AnsiToWin32 method), \hyperpage{66} + \item change\_to\_launcher() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{42} + \item check() (src.compilation.Builder method), \hyperpage{33} + \item check\_config\_exists() (in module src.product), \hyperpage{49} + \item check\_config\_has\_application() (in module src.\_\_init\_\_), \hyperpage{29} + \item check\_config\_has\_profile() (in module src.\_\_init\_\_), \hyperpage{30} + \item check\_installation() (in module src.product), \hyperpage{49} + \item check\_source() (in module src.product), \hyperpage{49} + \item chmod() (src.\_\_init\_\_.Path method), \hyperpage{29} + \item cleancolor() (in module src.printcolors), \hyperpage{47} + \item clear\_line() (in module src.colorama.ansi), \hyperpage{66} + \item clear\_screen() (in module src.colorama.ansi), \hyperpage{66} + \item close() (src.debug.OutStream method), \hyperpage{34} + \item close() (src.ElementTree.TreeBuilder method), \hyperpage{32} + \item close() (src.ElementTree.XMLTreeBuilder method), \hyperpage{32} + \item close() (src.pyconf.ConfigInputStream method), \hyperpage{55} + \item close() (src.pyconf.ConfigOutputStream method), \hyperpage{56} + \item cmake() (src.compilation.Builder method), \hyperpage{33} + \item code\_to\_chars() (in module src.colorama.ansi), \hyperpage{66} + \item colorama\_text() (in module src.colorama.initialise), \hyperpage{67} + \item command\_value() (src.environment.Environ method), \hyperpage{35} + \item command\_value() (src.fileEnviron.BashFileEnviron method), \hyperpage{39} + \item command\_value() (src.fileEnviron.BatFileEnviron method), \hyperpage{39} + \item command\_value() (src.fileEnviron.ContextFileEnviron method), \hyperpage{40} + \item command\_value() (src.fileEnviron.FileEnviron method), \hyperpage{41} + \item command\_value() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{42} + \item command\_value() (src.fileEnviron.ScreenEnviron method), \hyperpage{44} + \item Comment() (in module src.ElementTree), \hyperpage{31} + \item complete\_environment() (src.compilation.Builder method), \hyperpage{33} + \item Config (class in src.pyconf), \hyperpage{54} + \item Config.Namespace (class in src.pyconf), \hyperpage{54} + \item config\_has\_application() (in module src.\_\_init\_\_), \hyperpage{30} + \item ConfigError, \hyperpage{55} + \item ConfigFormatError, \hyperpage{55} + \item ConfigInputStream (class in src.pyconf), \hyperpage{55} + \item ConfigList (class in src.pyconf), \hyperpage{55} + \item ConfigMerger (class in src.pyconf), \hyperpage{55} + \item ConfigOutputStream (class in src.pyconf), \hyperpage{56} + \item ConfigReader (class in src.pyconf), \hyperpage{56} + \item ConfigResolutionError, \hyperpage{57} + \item configure() (src.compilation.Builder method), \hyperpage{33} + \item Container (class in src.pyconf), \hyperpage{57} + \item ContextFileEnviron (class in src.fileEnviron), \hyperpage{39} + \item convert\_ansi() (src.colorama.ansitowin32.AnsiToWin32 method), \hyperpage{66} + \item convert\_osc() (src.colorama.ansitowin32.AnsiToWin32 method), \hyperpage{66} + \item copy() (src.\_\_init\_\_.Path method), \hyperpage{29} + \item copydir() (src.\_\_init\_\_.Path method), \hyperpage{29} + \item copyfile() (src.\_\_init\_\_.Path method), \hyperpage{29} + \item copylink() (src.\_\_init\_\_.Path method), \hyperpage{29} + \item cursor\_adjust() (src.colorama.winterm.WinTerm method), \hyperpage{67} + \item cvs\_extract() (in module src.system), \hyperpage{60} + \item CYAN (src.colorama.ansi.AnsiBack attribute), \hyperpage{64} + \item CYAN (src.colorama.ansi.AnsiFore attribute), \hyperpage{65} + \item CYAN (src.colorama.winterm.WinColor attribute), \hyperpage{67} + + \indexspace + \bigletter D + \item data() (src.ElementTree.TreeBuilder method), \hyperpage{32} + \item date\_to\_datetime() (in module src.logger), \hyperpage{46} + \item deepcopy\_list() (in module src.\_\_init\_\_), \hyperpage{30} + \item deepCopyMapping() (in module src.pyconf), \hyperpage{59} + \item defaultMergeResolve() (in module src.pyconf), \hyperpage{59} + \item defaultStreamOpener() (in module src.pyconf), \hyperpage{60} + \item deinit() (in module src.colorama.initialise), \hyperpage{67} + \item delimiter (src.template.MyTemplate attribute), \hyperpage{62} + \item DIM (src.colorama.ansi.AnsiStyle attribute), \hyperpage{66} + \item dir() (src.\_\_init\_\_.Path method), \hyperpage{29} + \item do\_batch\_script\_build() (src.compilation.Builder method), \hyperpage{33} + \item do\_default\_build() (src.compilation.Builder method), \hyperpage{33} + \item do\_python\_script\_build() (src.compilation.Builder method), \hyperpage{33} + \item do\_script\_build() (src.compilation.Builder method), \hyperpage{33} + \item doctype() (src.ElementTree.XMLTreeBuilder method), \hyperpage{32} + \item DOWN() (src.colorama.ansi.AnsiCursor method), \hyperpage{65} + \item dump() (in module src.ElementTree), \hyperpage{31} + \item dump() (src.environment.SalomeEnviron method), \hyperpage{37} + + \indexspace + \bigletter E + \item Element() (in module src.ElementTree), \hyperpage{31} + \item ElementTree (class in src.ElementTree), \hyperpage{31} + \item end() (src.ElementTree.TreeBuilder method), \hyperpage{32} + \item end\_write() (src.logger.Logger method), \hyperpage{45} + \item ensure\_path\_exists() (in module src.\_\_init\_\_), \hyperpage{30} + \item Environ (class in src.environment), \hyperpage{35} + \item erase\_line() (src.colorama.winterm.WinTerm method), \hyperpage{67} + \item erase\_screen() (src.colorama.winterm.WinTerm method), \hyperpage{67} + \item error() (src.logger.Logger method), \hyperpage{45} + \item evaluate() (src.pyconf.Container method), \hyperpage{58} + \item evaluate() (src.pyconf.Expression method), \hyperpage{58} + \item exists() (src.\_\_init\_\_.Path method), \hyperpage{29} + \item Expression (class in src.pyconf), \hyperpage{58} + \item extract\_params() (src.colorama.ansitowin32.AnsiToWin32 method), \hyperpage{66} + + \indexspace + \bigletter F + \item feed() (src.ElementTree.XMLTreeBuilder method), \hyperpage{32} + \item FileEnviron (class in src.fileEnviron), \hyperpage{40} + \item FileEnvWriter (class in src.environment), \hyperpage{36} + \item find() (src.ElementTree.ElementTree method), \hyperpage{31} + \item find\_file\_in\_lpath() (in module src.\_\_init\_\_), \hyperpage{30} + \item find\_node\_by\_attrib() (in module src.xmlManager), \hyperpage{64} + \item findall() (src.ElementTree.ElementTree method), \hyperpage{31} + \item findConfig() (src.pyconf.Reference method), \hyperpage{59} + \item findtext() (src.ElementTree.ElementTree method), \hyperpage{32} + \item finish() (src.environment.SalomeEnviron method), \hyperpage{37} + \item finish() (src.fileEnviron.BashFileEnviron method), \hyperpage{39} + \item finish() (src.fileEnviron.BatFileEnviron method), \hyperpage{39} + \item finish() (src.fileEnviron.ContextFileEnviron method), \hyperpage{40} + \item finish() (src.fileEnviron.FileEnviron method), \hyperpage{41} + \item finish() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{43} + \item flush() (src.logger.Logger method), \hyperpage{45} + \item flush() (src.pyconf.ConfigOutputStream method), \hyperpage{56} + \item fore() (src.colorama.winterm.WinTerm method), \hyperpage{67} + \item FORWARD() (src.colorama.ansi.AnsiCursor method), \hyperpage{65} + \item fromstring() (in module src.ElementTree), \hyperpage{32} + + \indexspace + \bigletter G + \item generate\_launching\_commands() (src.test\_module.Test method), \hyperpage{62} + \item generate\_script() (src.test\_module.Test method), \hyperpage{62} + \item get() (src.environment.Environ method), \hyperpage{35} + \item get() (src.environment.SalomeEnviron method), \hyperpage{37} + \item get() (src.fileEnviron.BatFileEnviron method), \hyperpage{39} + \item get() (src.fileEnviron.ContextFileEnviron method), \hyperpage{40} + \item get() (src.fileEnviron.FileEnviron method), \hyperpage{41} + \item get() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{43} + \item get() (src.fileEnviron.ScreenEnviron method), \hyperpage{44} + \item get() (src.pyconf.Mapping method), \hyperpage{58} + \item get\_attrib() (src.xmlManager.ReadXmlFile method), \hyperpage{63} + \item get\_attrs() (src.colorama.winterm.WinTerm method), \hyperpage{67} + \item get\_base\_install\_dir() (in module src.product), \hyperpage{49} + \item get\_base\_path() (in module src.\_\_init\_\_), \hyperpage{30} + \item get\_cfg\_param() (in module src.\_\_init\_\_), \hyperpage{30} + \item get\_distrib\_version() (in module src.architecture), \hyperpage{32} + \item get\_distribution() (in module src.architecture), \hyperpage{32} + \item get\_file\_environ() (in module src.fileEnviron), \hyperpage{44} + \item get\_install\_dir() (in module src.product), \hyperpage{50} + \item get\_launcher\_name() (in module src.\_\_init\_\_), \hyperpage{30} + \item get\_log\_path() (in module src.\_\_init\_\_), \hyperpage{31} + \item get\_names() (src.environment.SalomeEnviron method), \hyperpage{37} + \item get\_nb\_proc() (in module src.architecture), \hyperpage{33} + \item get\_node\_text() (src.xmlManager.ReadXmlFile method), \hyperpage{63} + \item get\_position() (src.colorama.winterm.WinTerm method), \hyperpage{67} + \item get\_product\_components() (in module src.product), \hyperpage{50} + \item get\_product\_config() (in module src.product), \hyperpage{50} + \item get\_product\_dependencies() (in module src.product), \hyperpage{50} + \item get\_product\_section() (in module src.product), \hyperpage{50} + \item get\_products\_infos() (in module src.product), \hyperpage{51} + \item get\_property\_in\_product\_cfg() (in module src.\_\_init\_\_), \hyperpage{31} + \item get\_python\_version() (in module src.architecture), \hyperpage{33} + \item get\_salome\_version() (in module src.\_\_init\_\_), \hyperpage{31} + \item get\_test\_timeout() (src.test\_module.Test method), \hyperpage{62} + \item get\_tmp\_dir() (src.test\_module.Test method), \hyperpage{62} + \item get\_tmp\_filename() (in module src.\_\_init\_\_), \hyperpage{31} + \item get\_user() (in module src.architecture), \hyperpage{33} + \item get\_win32\_calls() (src.colorama.ansitowin32.AnsiToWin32 method), \hyperpage{66} + \item getByPath() (src.pyconf.Config method), \hyperpage{54} + \item getByPath() (src.pyconf.ConfigList method), \hyperpage{55} + \item getChar() (src.pyconf.ConfigReader method), \hyperpage{56} + \item getiterator() (src.ElementTree.ElementTree method), \hyperpage{32} + \item getLocalEnv() (in module src.debug), \hyperpage{34} + \item getroot() (src.ElementTree.ElementTree method), \hyperpage{32} + \item getRootAttrib() (src.xmlManager.ReadXmlFile method), \hyperpage{62} + \item getStrConfigDbg() (in module src.debug), \hyperpage{34} + \item getStrConfigStd() (in module src.debug), \hyperpage{34} + \item getTmpDirDEFAULT() (in module src.test\_module), \hyperpage{62} + \item getToken() (src.pyconf.ConfigReader method), \hyperpage{56} + \item git\_extract() (in module src.system), \hyperpage{61} + \item GREEN (src.colorama.ansi.AnsiBack attribute), \hyperpage{64} + \item GREEN (src.colorama.ansi.AnsiFore attribute), \hyperpage{65} + \item GREEN (src.colorama.winterm.WinColor attribute), \hyperpage{67} + \item GREY (src.colorama.winterm.WinColor attribute), \hyperpage{67} + + \indexspace + \bigletter H + \item hack\_libtool() (src.compilation.Builder method), \hyperpage{33} + \item handleMismatch() (src.pyconf.ConfigMerger method), \hyperpage{55} + \item handleRemoveReadonly() (in module src.\_\_init\_\_), \hyperpage{31} + + \indexspace + \bigletter I + \item indent() (in module src.debug), \hyperpage{34} + \item init() (in module src.colorama.initialise), \hyperpage{67} + \item install() (src.compilation.Builder method), \hyperpage{33} + \item InStream (class in src.debug), \hyperpage{34} + \item is\_a\_tty() (in module src.colorama.ansitowin32), \hyperpage{66} + \item is\_defined() (src.environment.Environ method), \hyperpage{35} + \item is\_defined() (src.environment.SalomeEnviron method), \hyperpage{37} + \item is\_defined() (src.fileEnviron.FileEnviron method), \hyperpage{41} + \item is\_defined() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{43} + \item is\_defined() (src.fileEnviron.ScreenEnviron method), \hyperpage{44} + \item is\_stream\_closed() (in module src.colorama.ansitowin32), \hyperpage{66} + \item is\_windows() (in module src.architecture), \hyperpage{33} + \item isdir() (src.\_\_init\_\_.Path method), \hyperpage{29} + \item iselement() (in module src.ElementTree), \hyperpage{32} + \item isfile() (src.\_\_init\_\_.Path method), \hyperpage{29} + \item islink() (src.\_\_init\_\_.Path method), \hyperpage{29} + \item isWord() (in module src.pyconf), \hyperpage{60} + \item iteritems() (src.pyconf.Mapping method), \hyperpage{58} + \item iterkeys() (src.pyconf.Mapping method), \hyperpage{58} + \item iterparse (class in src.ElementTree), \hyperpage{32} + + \indexspace + \bigletter K + \item keys() (src.pyconf.Mapping method), \hyperpage{58} + + \indexspace + \bigletter L + \item launch\_command() (in module src.fork), \hyperpage{45} + \item LauncherFileEnviron (class in src.fileEnviron), \hyperpage{42} + \item LIGHTBLACK\_EX (src.colorama.ansi.AnsiBack attribute), \hyperpage{64} + \item LIGHTBLACK\_EX (src.colorama.ansi.AnsiFore attribute), \hyperpage{65} + \item LIGHTBLUE\_EX (src.colorama.ansi.AnsiBack attribute), \hyperpage{64} + \item LIGHTBLUE\_EX (src.colorama.ansi.AnsiFore attribute), \hyperpage{65} + \item LIGHTCYAN\_EX (src.colorama.ansi.AnsiBack attribute), \hyperpage{65} + \item LIGHTCYAN\_EX (src.colorama.ansi.AnsiFore attribute), \hyperpage{65} + \item LIGHTGREEN\_EX (src.colorama.ansi.AnsiBack attribute), \hyperpage{65} + \item LIGHTGREEN\_EX (src.colorama.ansi.AnsiFore attribute), \hyperpage{65} + \item LIGHTMAGENTA\_EX (src.colorama.ansi.AnsiBack attribute), \hyperpage{65} + \item LIGHTMAGENTA\_EX (src.colorama.ansi.AnsiFore attribute), \hyperpage{65} + \item LIGHTRED\_EX (src.colorama.ansi.AnsiBack attribute), \hyperpage{65} + \item LIGHTRED\_EX (src.colorama.ansi.AnsiFore attribute), \hyperpage{65} + \item LIGHTWHITE\_EX (src.colorama.ansi.AnsiBack attribute), \hyperpage{65} + \item LIGHTWHITE\_EX (src.colorama.ansi.AnsiFore attribute), \hyperpage{65} + \item LIGHTYELLOW\_EX (src.colorama.ansi.AnsiBack attribute), \hyperpage{65} + \item LIGHTYELLOW\_EX (src.colorama.ansi.AnsiFore attribute), \hyperpage{65} + \item list() (src.\_\_init\_\_.Path method), \hyperpage{29} + \item list\_log\_file() (in module src.logger), \hyperpage{46} + \item load() (src.pyconf.Config method), \hyperpage{54} + \item load() (src.pyconf.ConfigReader method), \hyperpage{56} + \item load\_cfg\_environment() (src.environment.SalomeEnviron method), \hyperpage{37} + \item load\_environment() (in module src.environment), \hyperpage{38} + \item location() (src.pyconf.ConfigReader method), \hyperpage{56} + \item log() (src.compilation.Builder method), \hyperpage{33} + \item log\_command() (src.compilation.Builder method), \hyperpage{33} + \item Logger (class in src.logger), \hyperpage{45} + + \indexspace + \bigletter M + \item MAGENTA (src.colorama.ansi.AnsiBack attribute), \hyperpage{65} + \item MAGENTA (src.colorama.ansi.AnsiFore attribute), \hyperpage{65} + \item MAGENTA (src.colorama.winterm.WinColor attribute), \hyperpage{67} + \item make() (src.\_\_init\_\_.Path method), \hyperpage{29} + \item make() (src.compilation.Builder method), \hyperpage{33} + \item makePath() (in module src.pyconf), \hyperpage{60} + \item Mapping (class in src.pyconf), \hyperpage{58} + \item match() (src.pyconf.ConfigReader method), \hyperpage{56} + \item merge() (src.pyconf.ConfigMerger method), \hyperpage{55} + \item merge\_dicts() (in module src.\_\_init\_\_), \hyperpage{31} + \item mergeMapping() (src.pyconf.ConfigMerger method), \hyperpage{55} + \item mergeSequence() (src.pyconf.ConfigMerger method), \hyperpage{56} + \item MyTemplate (class in src.template), \hyperpage{62} + + \indexspace + \bigletter N + \item next() (src.ElementTree.iterparse method), \hyperpage{32} + \item next() (src.pyconf.Sequence.SeqIter method), \hyperpage{59} + \item NORMAL (src.colorama.ansi.AnsiStyle attribute), \hyperpage{66} + \item NORMAL (src.colorama.winterm.WinStyle attribute), \hyperpage{67} + + \indexspace + \bigletter O + \item only\_numbers() (in module src.\_\_init\_\_), \hyperpage{31} + \item Options (class in src.options), \hyperpage{47} + \item OptResult (class in src.options), \hyperpage{47} + \item OutStream (class in src.debug), \hyperpage{34} + \item overwriteKeys() (src.pyconf.ConfigMerger method), \hyperpage{56} + \item overwriteMergeResolve() (in module src.pyconf), \hyperpage{60} + + \indexspace + \bigletter P + \item parse() (in module src.ElementTree), \hyperpage{32} + \item parse() (src.ElementTree.ElementTree method), \hyperpage{32} + \item parse\_args() (src.options.Options method), \hyperpage{47} + \item parse\_date() (in module src.\_\_init\_\_), \hyperpage{31} + \item parseFactor() (src.pyconf.ConfigReader method), \hyperpage{56} + \item parseKeyValuePair() (src.pyconf.ConfigReader method), \hyperpage{57} + \item parseMapping() (src.pyconf.ConfigReader method), \hyperpage{57} + \item parseMappingBody() (src.pyconf.ConfigReader method), \hyperpage{57} + \item parseReference() (src.pyconf.ConfigReader method), \hyperpage{57} + \item parseScalar() (src.pyconf.ConfigReader method), \hyperpage{57} + \item parseSequence() (src.pyconf.ConfigReader method), \hyperpage{57} + \item parseSuffix() (src.pyconf.ConfigReader method), \hyperpage{57} + \item parseTerm() (src.pyconf.ConfigReader method), \hyperpage{57} + \item parseValue() (src.pyconf.ConfigReader method), \hyperpage{57} + \item Path (class in src.\_\_init\_\_), \hyperpage{29} + \item pattern (src.template.MyTemplate attribute), \hyperpage{62} + \item PI() (in module src.ElementTree), \hyperpage{32} + \item pop\_debug() (in module src.debug), \hyperpage{34} + \item POS() (src.colorama.ansi.AnsiCursor method), \hyperpage{65} + \item prepare() (src.compilation.Builder method), \hyperpage{33} + \item prepare\_testbase() (src.test\_module.Test method), \hyperpage{62} + \item prepare\_testbase\_from\_dir() (src.test\_module.Test method), \hyperpage{62} + \item prepare\_testbase\_from\_git() (src.test\_module.Test method), \hyperpage{62} + \item prepare\_testbase\_from\_svn() (src.test\_module.Test method), \hyperpage{62} + \item prepend() (src.environment.Environ method), \hyperpage{35} + \item prepend() (src.environment.SalomeEnviron method), \hyperpage{37} + \item prepend() (src.fileEnviron.FileEnviron method), \hyperpage{41} + \item prepend() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{43} + \item prepend() (src.fileEnviron.ScreenEnviron method), \hyperpage{44} + \item prepend\_value() (src.environment.Environ method), \hyperpage{35} + \item prepend\_value() (src.fileEnviron.ContextFileEnviron method), \hyperpage{40} + \item prepend\_value() (src.fileEnviron.FileEnviron method), \hyperpage{42} + \item prepend\_value() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{43} + \item print\_color\_map() (in module src.printcolors), \hyperpage{47} + \item print\_color\_range() (in module src.printcolors), \hyperpage{48} + \item print\_help() (src.options.Options method), \hyperpage{47} + \item print\_info() (in module src.\_\_init\_\_), \hyperpage{31} + \item print\_value() (in module src.printcolors), \hyperpage{48} + \item printc() (in module src.printcolors), \hyperpage{48} + \item printcError() (in module src.printcolors), \hyperpage{48} + \item printcHeader() (in module src.printcolors), \hyperpage{48} + \item printcHighlight() (in module src.printcolors), \hyperpage{48} + \item printcInfo() (in module src.printcolors), \hyperpage{48} + \item printcLabel() (in module src.printcolors), \hyperpage{49} + \item printcSuccess() (in module src.printcolors), \hyperpage{49} + \item printcWarning() (in module src.printcolors), \hyperpage{49} + \item ProcessingInstruction() (in module src.ElementTree), \hyperpage{32} + \item product\_compiles() (in module src.product), \hyperpage{51} + \item product\_has\_env\_script() (in module src.product), \hyperpage{51} + \item product\_has\_logo() (in module src.product), \hyperpage{51} + \item product\_has\_patches() (in module src.product), \hyperpage{51} + \item product\_has\_salome\_gui() (in module src.product), \hyperpage{51} + \item product\_has\_script() (in module src.product), \hyperpage{51} + \item product\_is\_autotools() (in module src.product), \hyperpage{51} + \item product\_is\_cmake() (in module src.product), \hyperpage{52} + \item product\_is\_cpp() (in module src.product), \hyperpage{52} + \item product\_is\_debug() (in module src.product), \hyperpage{52} + \item product\_is\_dev() (in module src.product), \hyperpage{52} + \item product\_is\_fixed() (in module src.product), \hyperpage{52} + \item product\_is\_generated() (in module src.product), \hyperpage{52} + \item product\_is\_mpi() (in module src.product), \hyperpage{52} + \item product\_is\_native() (in module src.product), \hyperpage{52} + \item product\_is\_salome() (in module src.product), \hyperpage{53} + \item product\_is\_sample() (in module src.product), \hyperpage{53} + \item product\_is\_smesh\_plugin() (in module src.product), \hyperpage{53} + \item product\_is\_vcs() (in module src.product), \hyperpage{53} + \item push\_debug() (in module src.debug), \hyperpage{34} + \item put\_initial\_xml\_fields() (src.logger.Logger method), \hyperpage{46} + \item put\_txt\_log\_in\_appli\_log\_dir() (src.compilation.Builder method), \hyperpage{33} + + \indexspace + \bigletter Q + \item QName (class in src.ElementTree), \hyperpage{32} + + \indexspace + \bigletter R + \item read() (src.pyconf.ConfigInputStream method), \hyperpage{55} + \item read\_config\_from\_a\_file() (in module src.\_\_init\_\_), \hyperpage{31} + \item read\_results() (src.test\_module.Test method), \hyperpage{62} + \item readline() (src.pyconf.ConfigInputStream method), \hyperpage{55} + \item readlink() (src.\_\_init\_\_.Path method), \hyperpage{29} + \item ReadXmlFile (class in src.xmlManager), \hyperpage{62} + \item RED (src.colorama.ansi.AnsiBack attribute), \hyperpage{65} + \item RED (src.colorama.ansi.AnsiFore attribute), \hyperpage{65} + \item RED (src.colorama.winterm.WinColor attribute), \hyperpage{67} + \item Reference (class in src.pyconf), \hyperpage{59} + \item reinit() (in module src.colorama.initialise), \hyperpage{67} + \item remove\_item\_from\_list() (in module src.\_\_init\_\_), \hyperpage{31} + \item removeNamespace() (src.pyconf.Config method), \hyperpage{55} + \item replace\_in\_file() (in module src.\_\_init\_\_), \hyperpage{31} + \item RESET (src.colorama.ansi.AnsiBack attribute), \hyperpage{65} + \item RESET (src.colorama.ansi.AnsiFore attribute), \hyperpage{65} + \item RESET\_ALL (src.colorama.ansi.AnsiStyle attribute), \hyperpage{66} + \item reset\_all() (in module src.colorama.initialise), \hyperpage{67} + \item reset\_all() (src.colorama.ansitowin32.AnsiToWin32 method), \hyperpage{66} + \item reset\_all() (src.colorama.winterm.WinTerm method), \hyperpage{67} + \item resolve() (src.pyconf.Reference method), \hyperpage{59} + \item rm() (src.\_\_init\_\_.Path method), \hyperpage{29} + \item run\_all\_tests() (src.test\_module.Test method), \hyperpage{62} + \item run\_env\_script() (src.environment.SalomeEnviron method), \hyperpage{37} + \item run\_env\_script() (src.fileEnviron.ScreenEnviron method), \hyperpage{44} + \item run\_grid\_tests() (src.test\_module.Test method), \hyperpage{62} + \item run\_script() (src.test\_module.Test method), \hyperpage{62} + \item run\_session\_tests() (src.test\_module.Test method), \hyperpage{62} + \item run\_simple\_env\_script() (src.environment.SalomeEnviron method), \hyperpage{37} + \item run\_testbase\_tests() (src.test\_module.Test method), \hyperpage{62} + \item run\_tests() (src.test\_module.Test method), \hyperpage{62} + + \indexspace + \bigletter S + \item SalomeEnviron (class in src.environment), \hyperpage{36} + \item SatException, \hyperpage{29} + \item saveConfigDbg() (in module src.debug), \hyperpage{34} + \item saveConfigStd() (in module src.debug), \hyperpage{34} + \item ScreenEnviron (class in src.fileEnviron), \hyperpage{43} + \item search\_known\_errors() (src.test\_module.Test method), \hyperpage{62} + \item Sequence (class in src.pyconf), \hyperpage{59} + \item Sequence.SeqIter (class in src.pyconf), \hyperpage{59} + \item set() (src.environment.Environ method), \hyperpage{36} + \item set() (src.environment.SalomeEnviron method), \hyperpage{37} + \item set() (src.fileEnviron.BashFileEnviron method), \hyperpage{39} + \item set() (src.fileEnviron.BatFileEnviron method), \hyperpage{39} + \item set() (src.fileEnviron.ContextFileEnviron method), \hyperpage{40} + \item set() (src.fileEnviron.FileEnviron method), \hyperpage{42} + \item set() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{43} + \item set() (src.fileEnviron.ScreenEnviron method), \hyperpage{44} + \item set\_a\_product() (src.environment.SalomeEnviron method), \hyperpage{37} + \item set\_application\_env() (src.environment.SalomeEnviron method), \hyperpage{38} + \item set\_attrs() (src.colorama.winterm.WinTerm method), \hyperpage{67} + \item set\_console() (src.colorama.winterm.WinTerm method), \hyperpage{67} + \item set\_cpp\_env() (src.environment.SalomeEnviron method), \hyperpage{38} + \item set\_cursor\_position() (src.colorama.winterm.WinTerm method), \hyperpage{68} + \item set\_full\_environ() (src.environment.SalomeEnviron method), \hyperpage{38} + \item set\_products() (src.environment.SalomeEnviron method), \hyperpage{38} + \item set\_python\_libdirs() (src.environment.SalomeEnviron method), \hyperpage{38} + \item set\_salome\_generic\_product\_env() (src.environment.SalomeEnviron method), \hyperpage{38} + \item set\_salome\_minimal\_product\_env() (src.environment.SalomeEnviron method), \hyperpage{38} + \item set\_title() (in module src.colorama.ansi), \hyperpage{66} + \item set\_title() (src.colorama.winterm.WinTerm method), \hyperpage{68} + \item SetConsoleTextAttribute() (in module src.colorama.win32), \hyperpage{67} + \item setPath() (src.pyconf.Container method), \hyperpage{58} + \item setStream() (src.pyconf.ConfigReader method), \hyperpage{57} + \item Shell (class in src.environment), \hyperpage{38} + \item should\_wrap() (src.colorama.ansitowin32.AnsiToWin32 method), \hyperpage{66} + \item show\_command\_log() (in module src.logger), \hyperpage{46} + \item show\_in\_editor() (in module src.system), \hyperpage{61} + \item show\_progress() (in module src.fork), \hyperpage{45} + \item smartcopy() (src.\_\_init\_\_.Path method), \hyperpage{29} + \item special\_path\_separator() (in module src.fileEnviron), \hyperpage{44} + \item src.\_\_init\_\_ (module), \hyperpage{29} + \item src.architecture (module), \hyperpage{32} + \item src.colorama (module), \hyperpage{64} + \item src.colorama.ansi (module), \hyperpage{64} + \item src.colorama.ansitowin32 (module), \hyperpage{66} + \item src.colorama.initialise (module), \hyperpage{67} + \item src.colorama.win32 (module), \hyperpage{67} + \item src.colorama.winterm (module), \hyperpage{67} + \item src.compilation (module), \hyperpage{33} + \item src.debug (module), \hyperpage{34} + \item src.ElementTree (module), \hyperpage{31} + \item src.environment (module), \hyperpage{35} + \item src.fileEnviron (module), \hyperpage{39} + \item src.fork (module), \hyperpage{45} + \item src.logger (module), \hyperpage{45} + \item src.options (module), \hyperpage{47} + \item src.printcolors (module), \hyperpage{47} + \item src.product (module), \hyperpage{49} + \item src.pyconf (module), \hyperpage{53} + \item src.system (module), \hyperpage{60} + \item src.template (module), \hyperpage{62} + \item src.test\_module (module), \hyperpage{62} + \item src.xmlManager (module), \hyperpage{62} + \item start() (src.ElementTree.TreeBuilder method), \hyperpage{32} + \item StreamWrapper (class in src.colorama.ansitowin32), \hyperpage{66} + \item style() (src.colorama.winterm.WinTerm method), \hyperpage{68} + \item SubElement() (in module src.ElementTree), \hyperpage{32} + \item substitute() (in module src.template), \hyperpage{62} + \item svn\_extract() (in module src.system), \hyperpage{61} + \item symlink() (src.\_\_init\_\_.Path method), \hyperpage{29} + + \indexspace + \bigletter T + \item Test (class in src.test\_module), \hyperpage{62} + \item timedelta\_total\_seconds() (in module src.logger), \hyperpage{46} + \item tofix() (in module src.debug), \hyperpage{35} + \item tostring() (in module src.ElementTree), \hyperpage{32} + \item TreeBuilder (class in src.ElementTree), \hyperpage{32} + + \indexspace + \bigletter U + \item UP() (src.colorama.ansi.AnsiCursor method), \hyperpage{65} + \item update\_hat\_xml() (in module src.logger), \hyperpage{46} + + \indexspace + \bigletter W + \item WHITE (src.colorama.ansi.AnsiBack attribute), \hyperpage{65} + \item WHITE (src.colorama.ansi.AnsiFore attribute), \hyperpage{65} + \item winapi\_test() (in module src.colorama.win32), \hyperpage{67} + \item WinColor (class in src.colorama.winterm), \hyperpage{67} + \item WinStyle (class in src.colorama.winterm), \hyperpage{67} + \item WinTerm (class in src.colorama.winterm), \hyperpage{67} + \item wmake() (src.compilation.Builder method), \hyperpage{34} + \item wrap\_stream() (in module src.colorama.initialise), \hyperpage{67} + \item write() (in module src.debug), \hyperpage{35} + \item write() (src.colorama.ansitowin32.AnsiToWin32 method), \hyperpage{66} + \item write() (src.colorama.ansitowin32.StreamWrapper method), \hyperpage{66} + \item write() (src.ElementTree.ElementTree method), \hyperpage{32} + \item write() (src.fileEnviron.ScreenEnviron method), \hyperpage{44} + \item write() (src.logger.Logger method), \hyperpage{46} + \item write() (src.pyconf.ConfigOutputStream method), \hyperpage{56} + \item write\_and\_convert() (src.colorama.ansitowin32.AnsiToWin32 method), \hyperpage{66} + \item write\_back() (in module src.fork), \hyperpage{45} + \item write\_cfgForPy\_file() (src.environment.FileEnvWriter method), \hyperpage{36} + \item write\_env\_file() (src.environment.FileEnvWriter method), \hyperpage{36} + \item write\_plain\_text() (src.colorama.ansitowin32.AnsiToWin32 method), \hyperpage{66} + \item write\_report() (in module src.xmlManager), \hyperpage{64} + \item write\_test\_margin() (src.test\_module.Test method), \hyperpage{62} + \item write\_tree() (src.xmlManager.XmlLogFile method), \hyperpage{63} + \item writeToStream() (src.pyconf.Container method), \hyperpage{58} + \item writeToStream() (src.pyconf.Mapping method), \hyperpage{59} + \item writeToStream() (src.pyconf.Sequence method), \hyperpage{59} + \item writeValue() (src.pyconf.Container method), \hyperpage{58} + + \indexspace + \bigletter X + \item XML() (in module src.ElementTree), \hyperpage{32} + \item XmlLogFile (class in src.xmlManager), \hyperpage{63} + \item XMLTreeBuilder (class in src.ElementTree), \hyperpage{32} + + \indexspace + \bigletter Y + \item YELLOW (src.colorama.ansi.AnsiBack attribute), \hyperpage{65} + \item YELLOW (src.colorama.ansi.AnsiFore attribute), \hyperpage{65} + \item YELLOW (src.colorama.winterm.WinColor attribute), \hyperpage{67} + +\end{sphinxtheindex} diff --git a/doc/build/latex/salomeTools.out b/doc/build/latex/salomeTools.out new file mode 100644 index 0000000..f59789f --- /dev/null +++ b/doc/build/latex/salomeTools.out @@ -0,0 +1,23 @@ +\BOOKMARK [0][-]{chapter.1}{\376\377\000Q\000u\000i\000c\000k\000\040\000s\000t\000a\000r\000t}{}% 1 +\BOOKMARK [1][-]{section.1.1}{\376\377\000I\000n\000s\000t\000a\000l\000l\000a\000t\000i\000o\000n}{chapter.1}% 2 +\BOOKMARK [1][-]{section.1.2}{\376\377\000C\000o\000n\000f\000i\000g\000u\000r\000a\000t\000i\000o\000n}{chapter.1}% 3 +\BOOKMARK [1][-]{section.1.3}{\376\377\000U\000s\000a\000g\000e\000\040\000o\000f\000\040\000S\000A\000l\000o\000m\000e\000T\000o\000o\000l\000s}{chapter.1}% 4 +\BOOKMARK [0][-]{chapter.2}{\376\377\000L\000i\000s\000t\000\040\000o\000f\000\040\000C\000o\000m\000m\000a\000n\000d\000s}{}% 5 +\BOOKMARK [1][-]{section.2.1}{\376\377\000C\000o\000m\000m\000a\000n\000d\000\040\000c\000o\000n\000f\000i\000g}{chapter.2}% 6 +\BOOKMARK [1][-]{section.2.2}{\376\377\000C\000o\000m\000m\000a\000n\000d\000\040\000p\000r\000e\000p\000a\000r\000e}{chapter.2}% 7 +\BOOKMARK [1][-]{section.2.3}{\376\377\000C\000o\000m\000m\000a\000n\000d\000\040\000c\000o\000m\000p\000i\000l\000e}{chapter.2}% 8 +\BOOKMARK [1][-]{section.2.4}{\376\377\000C\000o\000m\000m\000a\000n\000d\000\040\000l\000a\000u\000n\000c\000h\000e\000r}{chapter.2}% 9 +\BOOKMARK [1][-]{section.2.5}{\376\377\000C\000o\000m\000m\000a\000n\000d\000\040\000a\000p\000p\000l\000i\000c\000a\000t\000i\000o\000n}{chapter.2}% 10 +\BOOKMARK [1][-]{section.2.6}{\376\377\000C\000o\000m\000m\000a\000n\000d\000\040\000l\000o\000g}{chapter.2}% 11 +\BOOKMARK [1][-]{section.2.7}{\376\377\000C\000o\000m\000m\000a\000n\000d\000\040\000e\000n\000v\000i\000r\000o\000n}{chapter.2}% 12 +\BOOKMARK [1][-]{section.2.8}{\376\377\000C\000o\000m\000m\000a\000n\000d\000\040\000c\000l\000e\000a\000n}{chapter.2}% 13 +\BOOKMARK [1][-]{section.2.9}{\376\377\000C\000o\000m\000m\000a\000n\000d\000\040\000p\000a\000c\000k\000a\000g\000e}{chapter.2}% 14 +\BOOKMARK [1][-]{section.2.10}{\376\377\000C\000o\000m\000m\000a\000n\000d\000\040\000g\000e\000n\000e\000r\000a\000t\000e}{chapter.2}% 15 +\BOOKMARK [0][-]{chapter.3}{\376\377\000D\000e\000v\000e\000l\000o\000p\000e\000r\000\040\000d\000o\000c\000u\000m\000e\000n\000t\000a\000t\000i\000o\000n}{}% 16 +\BOOKMARK [1][-]{section.3.1}{\376\377\000A\000d\000d\000\040\000a\000\040\000u\000s\000e\000r\000\040\000c\000u\000s\000t\000o\000m\000\040\000c\000o\000m\000m\000a\000n\000d}{chapter.3}% 17 +\BOOKMARK [0][-]{chapter.4}{\376\377\000C\000o\000d\000e\000\040\000d\000o\000c\000u\000m\000e\000n\000t\000a\000t\000i\000o\000n}{}% 18 +\BOOKMARK [1][-]{section.4.1}{\376\377\000s\000r\000c}{chapter.4}% 19 +\BOOKMARK [0][-]{chapter.5}{\376\377\000R\000e\000l\000e\000a\000s\000e\000\040\000N\000o\000t\000e\000s}{}% 20 +\BOOKMARK [1][-]{section.5.1}{\376\377\000R\000e\000l\000e\000a\000s\000e\000\040\000n\000o\000t\000e\000s}{chapter.5}% 21 +\BOOKMARK [0][-]{section*.532}{\376\377\000P\000y\000t\000h\000o\000n\000\040\000M\000o\000d\000u\000l\000e\000\040\000I\000n\000d\000e\000x}{}% 22 +\BOOKMARK [0][-]{section*.533}{\376\377\000I\000n\000d\000e\000x}{}% 23 diff --git a/doc/build/latex/salomeTools.pdf b/doc/build/latex/salomeTools.pdf new file mode 100644 index 0000000..b04b7a8 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..acb5ced --- /dev/null +++ b/doc/build/latex/salomeTools.tex @@ -0,0 +1,7901 @@ +%% Generated by Sphinx. +\def\sphinxdocclass{report} +\documentclass[a4paper,10pt,english]{sphinxmanual} +\ifdefined\pdfpxdimen + \let\sphinxpxdimen\pdfpxdimen\else\newdimen\sphinxpxdimen +\fi \sphinxpxdimen=.75bp\relax + +\PassOptionsToPackage{warn}{textcomp} +\usepackage[utf8]{inputenc} +\ifdefined\DeclareUnicodeCharacter + \ifdefined\DeclareUnicodeCharacterAsOptional + \DeclareUnicodeCharacter{"00A0}{\nobreakspace} + \DeclareUnicodeCharacter{"2500}{\sphinxunichar{2500}} + \DeclareUnicodeCharacter{"2502}{\sphinxunichar{2502}} + \DeclareUnicodeCharacter{"2514}{\sphinxunichar{2514}} + \DeclareUnicodeCharacter{"251C}{\sphinxunichar{251C}} + \DeclareUnicodeCharacter{"2572}{\textbackslash} + \else + \DeclareUnicodeCharacter{00A0}{\nobreakspace} + \DeclareUnicodeCharacter{2500}{\sphinxunichar{2500}} + \DeclareUnicodeCharacter{2502}{\sphinxunichar{2502}} + \DeclareUnicodeCharacter{2514}{\sphinxunichar{2514}} + \DeclareUnicodeCharacter{251C}{\sphinxunichar{251C}} + \DeclareUnicodeCharacter{2572}{\textbackslash} + \fi +\fi +\usepackage{cmap} +\usepackage[T1]{fontenc} +\usepackage{amsmath,amssymb,amstext} +\usepackage{babel} +\usepackage{times} +\usepackage[Bjarne]{fncychap} +\usepackage{sphinx} +\sphinxsetup{verbatimwithframe=false, VerbatimColor={rgb}{.98,.94,.94}} +\usepackage{geometry} + +% Include hyperref last. +\usepackage{hyperref} +% Fix anchor placement for figures with captions. +\usepackage{hypcap}% it must be loaded after hyperref. +% Set up styles of URL: it should be placed after hyperref. +\urlstyle{same} + +\addto\captionsenglish{\renewcommand{\figurename}{Fig.}} +\addto\captionsenglish{\renewcommand{\tablename}{Table}} +\addto\captionsenglish{\renewcommand{\literalblockname}{Listing}} + +\addto\captionsenglish{\renewcommand{\literalblockcontinuedname}{continued from previous page}} +\addto\captionsenglish{\renewcommand{\literalblockcontinuesname}{continues on next page}} + +\addto\extrasenglish{\def\pageautorefname{page}} + +\setcounter{tocdepth}{1} + + + +\title{salomeTools Documentation} +\date{Apr 25, 2018} +\release{5.0.0dev} +\author{CEA DEN/DANS/DM2S/STMF/LGLS} +\newcommand{\sphinxlogo}{\vbox{}} +\renewcommand{\releasename}{Release} +\makeindex + +\begin{document} + +\maketitle +\sphinxtableofcontents +\phantomsection\label{\detokenize{index::doc}} +\clearpage + + + +\noindent{\hspace*{\fill}\sphinxincludegraphics[scale=1.0]{{sat_about}.png}\hspace*{\fill}} + +\begin{sphinxadmonition}{warning}{Warning:} +This documentation is under construction. +\end{sphinxadmonition} + +The \sphinxstylestrong{Sa}lome\sphinxstylestrong{T}ools (sat) is a suite of commands +that can be used to perform operations on \sphinxhref{http://www.salome-platform.org}{SALOME}% +\begin{footnote}[1]\sphinxAtStartFootnote +\sphinxnolinkurl{http://www.salome-platform.org} +% +\end{footnote}. + +For example, sat allows you to compile SALOME’s codes +(prerequisites, products) +create application, run tests, create package, etc. + +This utility code is a set of \sphinxhref{https://docs.python.org/2.7}{Python}% +\begin{footnote}[2]\sphinxAtStartFootnote +\sphinxnolinkurl{https://docs.python.org/2.7} +% +\end{footnote} scripts files. + +Find a \sphinxhref{./../latex/salomeTools.pdf}{pdf version of this documentation} + + +\chapter{Quick start} +\label{\detokenize{index:quick-start}}\label{\detokenize{index:salome-tools}} + +\section{Installation} +\label{\detokenize{installation_of_sat:installation}}\label{\detokenize{installation_of_sat::doc}} +Usually user could find (and use) command \sphinxstylestrong{sat} directly after a ‘detar’ installation of SALOME. + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +tar \PYGZhy{}xf .../SALOME\PYGZus{}xx.tgz +\PYG{n+nb}{cd} SALOME\PYGZus{}xx +ls \PYGZhy{}l sat \PYG{c+c1}{\PYGZsh{} sat \PYGZhy{}\PYGZgt{} salomeTools/sat} +\end{sphinxVerbatim} + +Python package (scripts of salomeTools) actually remains in directory \sphinxstyleemphasis{salomeTools}. + + +\section{Configuration} +\label{\detokenize{configuration:configuration}}\label{\detokenize{configuration::doc}} +\sphinxstyleemphasis{salomeTools} uses files to store its configuration parameters. + +There are several configuration files which are loaded by salomeTools in a specific order. +When all the files are loaded a \sphinxstyleemphasis{config} object is created. +Then, this object is passed to all command scripts. + + +\subsection{Syntax} +\label{\detokenize{configuration:syntax}} +The configuration files use a python-like structure format +(see \sphinxhref{http://www.red-dove.com/config-doc/}{config module}% +\begin{footnote}[3]\sphinxAtStartFootnote +\sphinxnolinkurl{http://www.red-dove.com/config-doc/} +% +\end{footnote} for a complete description). +\begin{itemize} +\item {} +\sphinxstylestrong{\{\}} define a dictionary, + +\item {} +\sphinxstylestrong{{[}{]}} define a list, + +\item {} +\sphinxstylestrong{@} can be used to include a file, + +\item {} +\sphinxstylestrong{\$prefix} reference to another parameter (ex: \sphinxcode{\sphinxupquote{\$PRODUCT.name}}), + +\item {} +\sphinxstylestrong{\#} comments. + +\end{itemize} + +\begin{sphinxadmonition}{note}{Note:} +in this documentation a reference to a configuration parameter will be noted \sphinxcode{\sphinxupquote{XXX.YYY}}. +\end{sphinxadmonition} + + +\subsection{Description} +\label{\detokenize{configuration:description}} + +\subsubsection{VARS section} +\label{\detokenize{configuration:vars-section}}\label{\detokenize{configuration:id1}} +\begin{DUlineblock}{0em} +\item[] This section is dynamically created by salomeTools at run time. +\item[] It contains information about the environment: date, time, OS, architecture etc. +\end{DUlineblock} + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{c+c1}{\PYGZsh{} to get the current setting} +\PYG{n}{sat} \PYG{n}{config} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{value} \PYG{n}{VARS} +\end{sphinxVerbatim} + + +\subsubsection{PRODUCTS section} +\label{\detokenize{configuration:products-section}} +\begin{DUlineblock}{0em} +\item[] This section is defined in the product file. +\item[] It contains instructions on how to build a version of SALOME (list of prerequisites-products and versions) +\end{DUlineblock} + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{c+c1}{\PYGZsh{} to get the current setting} +\PYG{n}{sat} \PYG{n}{config} \PYG{n}{SALOME}\PYG{o}{\PYGZhy{}}\PYG{n}{xx} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{value} \PYG{n}{PRODUCTS} +\end{sphinxVerbatim} + + +\subsubsection{APPLICATION section} +\label{\detokenize{configuration:application-section}} +\begin{DUlineblock}{0em} +\item[] This section is optional, it is also defined in the product file. +\item[] It gives additional parameters to create an application based on SALOME, as versions of products to use. +\end{DUlineblock} + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{c+c1}{\PYGZsh{} to get the current setting} +\PYG{n}{sat} \PYG{n}{config} \PYG{n}{SALOME}\PYG{o}{\PYGZhy{}}\PYG{n}{xx} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{value} \PYG{n}{APPLICATION} +\end{sphinxVerbatim} + + +\subsubsection{USER section} +\label{\detokenize{configuration:user-section}}\label{\detokenize{configuration:id2}} +This section is defined by the user configuration file, +\sphinxcode{\sphinxupquote{\textasciitilde{}/.salomeTools/salomeTools.pyconf}}. + +The \sphinxcode{\sphinxupquote{USER}} section defines some parameters (not exhaustive): +\begin{itemize} +\item {} +\sphinxstylestrong{workDir} : +\begin{quote} + +\begin{DUlineblock}{0em} +\item[] The working directory. +\item[] Each product will be usually installed here (in sub-directories). +\end{DUlineblock} +\end{quote} + +\item {} +\sphinxstylestrong{browser} : The web browser to use (\sphinxstyleemphasis{firefox}). + +\item {} +\sphinxstylestrong{editor} : The editor to use (\sphinxstyleemphasis{vi, pluma}). + +\item {} +and other user preferences. + +\end{itemize} + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{c+c1}{\PYGZsh{} to get the current setting} +\PYG{n}{sat} \PYG{n}{config} \PYG{n}{SALOME}\PYG{o}{\PYGZhy{}}\PYG{n}{xx} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{value} \PYG{n}{USER} +\end{sphinxVerbatim} + +\clearpage + + +\section{Usage of SAlomeTools} +\label{\detokenize{usage_of_sat:svn}}\label{\detokenize{usage_of_sat:usage-of-salometools}}\label{\detokenize{usage_of_sat::doc}} + +\subsection{Usage} +\label{\detokenize{usage_of_sat:usage}} +sat usage is a Command Line Interface (\sphinxhref{https://en.wikipedia.org/wiki/Command-line\_interface}{CLI}% +\begin{footnote}[4]\sphinxAtStartFootnote +\sphinxnolinkurl{https://en.wikipedia.org/wiki/Command-line\_interface} +% +\end{footnote}). + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +sat \PYG{o}{[}generic\PYGZus{}options\PYG{o}{]} \PYG{o}{[}command\PYG{o}{]} \PYG{o}{[}product\PYG{o}{]} \PYG{o}{[}command\PYGZus{}options\PYG{o}{]} +\end{sphinxVerbatim} + + +\subsubsection{Options of sat} +\label{\detokenize{usage_of_sat:options-of-sat}} +Useful \sphinxstyleemphasis{not exhaustive} generic options of \sphinxstyleemphasis{sat} CLI. + + +\paragraph{\sphinxstyleemphasis{\textendash{}help or -h}} +\label{\detokenize{usage_of_sat:help-or-h}} +Get help as simple text. + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +sat \PYGZhy{}\PYGZhy{}help \PYG{c+c1}{\PYGZsh{} get the list of existing commands} +sat \PYGZhy{}\PYGZhy{}help compile \PYG{c+c1}{\PYGZsh{} get the help on a specific command \PYGZsq{}compile\PYGZsq{}} +\end{sphinxVerbatim} + + +\paragraph{\sphinxstyleemphasis{\textendash{}debug or -g}} +\label{\detokenize{usage_of_sat:debug-or-g}} +Execution in debug mode allows to see more trace and \sphinxstyleemphasis{stack} if an exception is raised. + + +\paragraph{\sphinxstyleemphasis{\textendash{}verbose or -v}} +\label{\detokenize{usage_of_sat:verbose-or-v}} +Change verbosity level (default is 3). + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{c+c1}{\PYGZsh{} for product \PYGZsq{}SALOME\PYGZus{}xx\PYGZsq{} for example} +\PYG{c+c1}{\PYGZsh{} execute compile command in debug mode with trace level 4} +sat \PYGZhy{}g \PYGZhy{}v \PYG{l+m}{4} compile SALOME\PYGZus{}xx +\end{sphinxVerbatim} + + +\subsection{Build a SALOME product} +\label{\detokenize{usage_of_sat:build-a-salome-product}} + +\subsubsection{Get the list of available products} +\label{\detokenize{usage_of_sat:get-the-list-of-available-products}} +To get the list of the current available products in your context: + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +sat config \PYGZhy{}\PYGZhy{}list +\end{sphinxVerbatim} + + +\subsubsection{Prepare sources of a product} +\label{\detokenize{usage_of_sat:prepare-sources-of-a-product}} +To prepare (get) \sphinxstyleemphasis{all} the sources of a product (\sphinxstyleemphasis{SALOME\_xx} for example): + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +sat prepare SALOME\PYGZus{}xx +\end{sphinxVerbatim} + +\begin{DUlineblock}{0em} +\item[] The sources are usually copied in directories +\item[] \sphinxstyleemphasis{\$USER.workDir + SALOME\_xx… + SOURCES + \$PRODUCT.name} +\end{DUlineblock} + + +\subsubsection{Compile SALOME} +\label{\detokenize{usage_of_sat:compile-salome}} +To compile products: + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{c+c1}{\PYGZsh{} compile all prerequisites/products} +sat compile SALOME\PYGZus{}xx + +\PYG{c+c1}{\PYGZsh{} compile only 2 products (KERNEL and SAMPLES), if not done yet} +sat compile SALOME\PYGZus{}xx \PYGZhy{}\PYGZhy{}products KERNEL,SAMPLES + +\PYG{c+c1}{\PYGZsh{} compile only 2 products, unconditionaly} +sat compile SALOME\PYGZus{}xx \PYGZhy{}\PYGZhy{}\PYGZhy{}products SAMPLES \PYGZhy{}\PYGZhy{}clean\PYGZus{}all +\end{sphinxVerbatim} + +\begin{DUlineblock}{0em} +\item[] The products are usually build in the directories +\item[] \sphinxstyleemphasis{\$USER.workDir + SALOME\_xx… + BUILD + \$PRODUCT.name} +\item[] +\item[] The products are usually installed in the directories +\item[] \sphinxstyleemphasis{\$USER.workDir + SALOME\_xx… + INSTALL + \$PRODUCT.name} +\end{DUlineblock} + + +\chapter{List of Commands} +\label{\detokenize{index:list-of-commands}} +\clearpage + + +\section{Command config} +\label{\detokenize{commands/config:svn}}\label{\detokenize{commands/config:command-config}}\label{\detokenize{commands/config::doc}} + +\subsection{Description} +\label{\detokenize{commands/config:description}} +The \sphinxstylestrong{config} command manages sat configuration. +It allows display, manipulation and operation on configuration files + + +\subsection{Usage} +\label{\detokenize{commands/config:usage}}\begin{itemize} +\item {} +Edit the user personal configuration file \sphinxcode{\sphinxupquote{\$HOME/.salomeTools/SAT.pyconf}}. It is used to store the user personal choices, like the favorite editor, browser, pdf viewer: + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{n}{sat} \PYG{n}{config} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{edit} +\end{sphinxVerbatim} + +\item {} +List the available applications (they come from the sat projects defined in \sphinxcode{\sphinxupquote{data/local.pyconf}}: + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{n}{sat} \PYG{n}{config} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n+nb}{list} +\end{sphinxVerbatim} + +\item {} +Edit the configuration of an application: + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{n}{sat} \PYG{n}{config} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{edit} +\end{sphinxVerbatim} + +\item {} +Copy an application configuration file into the user personal directory: + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{n}{sat} \PYG{n}{config} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{copy} \PYG{p}{[}\PYG{n}{new\PYGZus{}name}\PYG{p}{]} +\end{sphinxVerbatim} + +\item {} +\begin{DUlineblock}{0em} +\item[] Print the value of a configuration parameter. +\item[] Use the automatic completion to get recursively the parameter names. +\item[] Use \sphinxstyleemphasis{\textendash{}no\_label} option to get \sphinxstyleemphasis{only} the value, \sphinxstyleemphasis{without} label (useful in automatic scripts). +\item[] Examples (with \sphinxstyleemphasis{SALOME-xx} as \sphinxstyleemphasis{SALOME-8.4.0} ): +\end{DUlineblock} + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{c+c1}{\PYGZsh{} sat config \PYGZhy{}\PYGZhy{}value \PYGZlt{}parameter\PYGZus{}path\PYGZgt{}} +sat config \PYGZhy{}\PYGZhy{}value . \PYG{c+c1}{\PYGZsh{} all the configuration} +sat config \PYGZhy{}\PYGZhy{}value LOCAL +sat config \PYGZhy{}\PYGZhy{}value LOCAL.workdir + +\PYG{c+c1}{\PYGZsh{} sat config \PYGZlt{}application\PYGZgt{} \PYGZhy{}\PYGZhy{}value \PYGZlt{}parameter\PYGZus{}path\PYGZgt{}} +sat config SALOME\PYGZhy{}xx \PYGZhy{}\PYGZhy{}value APPLICATION.workdir +sat config SALOME\PYGZhy{}xx \PYGZhy{}\PYGZhy{}no\PYGZus{}label \PYGZhy{}\PYGZhy{}value APPLICATION.workdir +\end{sphinxVerbatim} + +\item {} +\begin{DUlineblock}{0em} +\item[] Print in one-line-by-value mode the value of a configuration parameter, +\item[] with its source \sphinxstyleemphasis{expression}, if any. +\item[] This is a debug mode, useful for developers. +\item[] Prints the parameter path, the source expression if any, and the final value: +\end{DUlineblock} + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{n}{sat} \PYG{n}{config} \PYG{n}{SALOME}\PYG{o}{\PYGZhy{}}\PYG{n}{xx} \PYG{o}{\PYGZhy{}}\PYG{n}{g} \PYG{n}{USER} +\end{sphinxVerbatim} + +\begin{sphinxadmonition}{note}{Note:} +And so, \sphinxstyleemphasis{not only for fun}, to get \sphinxstylestrong{all expressions} of configuration + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +sat config SALOME\PYGZhy{}xx \PYGZhy{}g . \PYG{p}{\textbar{}} grep \PYGZhy{}e \PYG{l+s+s2}{\PYGZdq{}\PYGZhy{}\PYGZhy{}\PYGZgt{}\PYGZdq{}} +\end{sphinxVerbatim} +\end{sphinxadmonition} + +\item {} +Print the patches that are applied: + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{n}{sat} \PYG{n}{config} \PYG{n}{SALOME}\PYG{o}{\PYGZhy{}}\PYG{n}{xx} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{show\PYGZus{}patchs} +\end{sphinxVerbatim} + +\item {} +Get information on a product configuration: + +\end{itemize} + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{c+c1}{\PYGZsh{} sat config \PYGZlt{}application\PYGZgt{} \PYGZhy{}\PYGZhy{}info \PYGZlt{}product\PYGZgt{}} +sat config SALOME\PYGZhy{}xx \PYGZhy{}\PYGZhy{}info KERNEL +sat config SALOME\PYGZhy{}xx \PYGZhy{}\PYGZhy{}info qt +\end{sphinxVerbatim} + + +\subsection{Some useful configuration pathes} +\label{\detokenize{commands/config:some-useful-configuration-pathes}} +Exploring a current configuration. +\begin{itemize} +\item {} +\sphinxstylestrong{PATHS}: To get list of directories where to find files. + +\item {} +\sphinxstylestrong{USER}: To get user preferences (editor, pdf viewer, web browser, default working dir). + +\end{itemize} + +sat commands: + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{n}{sat} \PYG{n}{config} \PYG{n}{SALOME}\PYG{o}{\PYGZhy{}}\PYG{n}{xx} \PYG{o}{\PYGZhy{}}\PYG{n}{v} \PYG{n}{PATHS} +\PYG{n}{sat} \PYG{n}{config} \PYG{n}{SALOME}\PYG{o}{\PYGZhy{}}\PYG{n}{xx} \PYG{o}{\PYGZhy{}}\PYG{n}{v} \PYG{n}{USERS} +\end{sphinxVerbatim} + +\clearpage + + +\section{Command prepare} +\label{\detokenize{commands/prepare:svn}}\label{\detokenize{commands/prepare:command-prepare}}\label{\detokenize{commands/prepare::doc}} + +\subsection{Description} +\label{\detokenize{commands/prepare:description}} +The \sphinxstylestrong{prepare} command brings the sources of an application in the \sphinxstyleemphasis{sources +application directory}, in order to compile them with the compile command. + +The sources can be prepared from VCS software (\sphinxstyleemphasis{cvs, svn, git}), an archive or a directory. + +\begin{sphinxadmonition}{warning}{Warning:} +When sat prepares a product, it first removes the +existing directory, except if the development mode is activated. +When you are working on a product, you need to declare in +the application configuration this product in \sphinxstylestrong{dev} mode. +\end{sphinxadmonition} + + +\subsection{Remarks} +\label{\detokenize{commands/prepare:remarks}} + +\subsubsection{VCS bases (git, svn, cvs)} +\label{\detokenize{commands/prepare:vcs-bases-git-svn-cvs}} +The \sphinxstyleemphasis{prepare} command does not manage authentication on the cvs server. +For example, to prepare modules from a cvs server, you first need to login once. + +To avoid typing a password for each product, +you may use a ssh key with passphrase, or store your password +(in .cvspass or .gitconfig files). +If you have security concerns, it is also possible to use +a bash agent and type your password only once. + + +\subsubsection{Dev mode} +\label{\detokenize{commands/prepare:dev-mode}} +By default \sphinxstyleemphasis{prepare} uses \sphinxstyleemphasis{export} mode: it creates an image +of the sources, corresponding to the tag or branch specified, +without any link to the VCS base. +To perform a \sphinxstyleemphasis{checkout} (svn, cvs) or a \sphinxstyleemphasis{git clone} (git), +you need to declare the product in dev mode in your application configuration: +edit the application configuration file (pyconf) and modify the product declaration: + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +sat config \PYGZlt{}application\PYGZgt{} \PYGZhy{}e +\PYG{c+c1}{\PYGZsh{} and edit the product section:} +\PYG{c+c1}{\PYGZsh{} \PYGZlt{}product\PYGZgt{} : \PYGZob{}tag : \PYGZdq{}my\PYGZus{}tag\PYGZdq{}, dev : \PYGZdq{}yes\PYGZdq{}, debug : \PYGZdq{}yes\PYGZdq{}\PYGZcb{}} +\end{sphinxVerbatim} + +The first time you will execute the \sphinxstyleemphasis{sat prepare} command, +your module will be downloaded in \sphinxstyleemphasis{checkout} mode +(inside the SOURCES directory of the application. +Then, you can develop in this repository, and finally push +them in the base when they are ready. +If you type during the development process by mistake +a \sphinxstyleemphasis{sat prepare} command, the sources in dev mode will +not be altered/removed (Unless you use -f option) + + +\subsection{Usage} +\label{\detokenize{commands/prepare:usage}}\begin{itemize} +\item {} +Prepare the sources of a complete application in SOURCES directory (all products): + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{n}{sat} \PYG{n}{prepare} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} +\end{sphinxVerbatim} + +\item {} +Prepare only some modules: + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{n}{sat} \PYG{n}{prepare} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{products} \PYG{o}{\PYGZlt{}}\PYG{n}{product1}\PYG{o}{\PYGZgt{}}\PYG{p}{,}\PYG{o}{\PYGZlt{}}\PYG{n}{product2}\PYG{o}{\PYGZgt{}} \PYG{o}{.}\PYG{o}{.}\PYG{o}{.} +\end{sphinxVerbatim} + +\item {} +Use \textendash{}force to force to prepare the products in development mode +(this will remove the sources and do a new clone/checkout): + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{n}{sat} \PYG{n}{prepare} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{force} +\end{sphinxVerbatim} + +\item {} +Use \textendash{}force\_patch to force to apply patch to the products +in development mode (otherwise they are not applied): + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{n}{sat} \PYG{n}{prepare} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{force\PYGZus{}patch} +\end{sphinxVerbatim} + +\end{itemize} + + +\subsection{Some useful configuration pathes} +\label{\detokenize{commands/prepare:some-useful-configuration-pathes}} +Command \sphinxstyleemphasis{sat prepare} uses the \sphinxstyleemphasis{pyconf file configuration} of each product to know how to get the sources. + +\begin{sphinxadmonition}{note}{Note:} +to verify configuration of a product, and get name of this \sphinxstyleemphasis{pyconf files configuration} + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +sat config \PYGZlt{}application\PYGZgt{} \PYGZhy{}\PYGZhy{}info \PYGZlt{}product\PYGZgt{} +\end{sphinxVerbatim} +\end{sphinxadmonition} +\begin{itemize} +\item {} +\sphinxstylestrong{get\_method}: the method to use to prepare the module, possible values are cvs, git, archive, dir. + +\item {} +\sphinxstylestrong{git\_info} : (used if get\_method = git) information to prepare sources from git. + +\item {} +\sphinxstylestrong{svn\_info} : (used if get\_method = svn) information to prepare sources from cvs. + +\item {} +\sphinxstylestrong{cvs\_info} : (used if get\_method = cvs) information to prepare sources from cvs. + +\item {} +\sphinxstylestrong{archive\_info} : (used if get\_method = archive) the path to the archive. + +\item {} +\sphinxstylestrong{dir\_info} : (used if get\_method = dir) the directory with the sources. + +\end{itemize} + +\clearpage + + +\section{Command compile} +\label{\detokenize{commands/compile:svn}}\label{\detokenize{commands/compile:command-compile}}\label{\detokenize{commands/compile::doc}} + +\subsection{Description} +\label{\detokenize{commands/compile:description}} +The \sphinxstylestrong{compile} command allows compiling the products of a \sphinxhref{http://www.salome-platform.org}{SALOME}% +\begin{footnote}[5]\sphinxAtStartFootnote +\sphinxnolinkurl{http://www.salome-platform.org} +% +\end{footnote} application. + + +\subsection{Usage} +\label{\detokenize{commands/compile:usage}}\begin{itemize} +\item {} +Compile a complete application: + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{n}{sat} \PYG{n+nb}{compile} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} +\end{sphinxVerbatim} + +\item {} +Compile only some products: + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{n}{sat} \PYG{n+nb}{compile} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{products} \PYG{o}{\PYGZlt{}}\PYG{n}{product1}\PYG{o}{\PYGZgt{}}\PYG{p}{,}\PYG{o}{\PYGZlt{}}\PYG{n}{product2}\PYG{o}{\PYGZgt{}} \PYG{o}{.}\PYG{o}{.}\PYG{o}{.} +\end{sphinxVerbatim} + +\item {} +Use \sphinxstyleemphasis{sat -t} to duplicate the logs in the terminal (by default the log are stored and displayed with \sphinxstyleemphasis{sat log} command): + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{n}{sat} \PYG{o}{\PYGZhy{}}\PYG{n}{t} \PYG{n+nb}{compile} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{products} \PYG{o}{\PYGZlt{}}\PYG{n}{product1}\PYG{o}{\PYGZgt{}} +\end{sphinxVerbatim} + +\item {} +Compile a module and its dependencies: + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{n}{sat} \PYG{n+nb}{compile} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{products} \PYG{n}{med} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{with\PYGZus{}fathers} +\end{sphinxVerbatim} + +\item {} +Compile a module and the modules depending on it (for example plugins): + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{n}{sat} \PYG{n+nb}{compile} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{products} \PYG{n}{med} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{with\PYGZus{}children} +\end{sphinxVerbatim} + +\item {} +Clean the build and install directories before starting compilation: + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{n}{sat} \PYG{n+nb}{compile} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{products} \PYG{n}{GEOM} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{clean\PYGZus{}all} +\end{sphinxVerbatim} + +\begin{sphinxadmonition}{note}{Note:} +\begin{DUlineblock}{0em} +\item[] a warning will be shown if option \sphinxstyleemphasis{\textendash{}products} is missing +\item[] (as it will clean everything) +\end{DUlineblock} +\end{sphinxadmonition} + +\item {} +Clean only the install directories before starting compilation: + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{n}{sat} \PYG{n+nb}{compile} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{clean\PYGZus{}install} +\end{sphinxVerbatim} + +\item {} +Add options for make: + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{n}{sat} \PYG{n+nb}{compile} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{products} \PYG{o}{\PYGZlt{}}\PYG{n}{product}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{make\PYGZus{}flags} \PYG{o}{\PYGZlt{}}\PYG{n}{flags}\PYG{o}{\PYGZgt{}} +\end{sphinxVerbatim} + +\item {} +Use the \sphinxstyleemphasis{\textendash{}check} option to execute the unit tests after compilation: + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{n}{sat} \PYG{n+nb}{compile} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{check} +\end{sphinxVerbatim} + +\item {} +Remove the build directory after successful compilation (some build directory like qt are big): + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{n}{sat} \PYG{n+nb}{compile} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{products} \PYG{n}{qt} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{clean\PYGZus{}build\PYGZus{}after} +\end{sphinxVerbatim} + +\item {} +Stop the compilation as soon as the compilation of a module fails: + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{n}{sat} \PYG{n+nb}{compile} \PYG{o}{\PYGZlt{}}\PYG{n}{product}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{stop\PYGZus{}first\PYGZus{}fail} +\end{sphinxVerbatim} + +\item {} +Do not compile, just show if products are installed or not, and where is the installation: + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{n}{sat} \PYG{n+nb}{compile} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{show} +\end{sphinxVerbatim} + +\end{itemize} + + +\subsection{Some useful configuration pathes} +\label{\detokenize{commands/compile:some-useful-configuration-pathes}} +The way to compile a product is defined in the \sphinxstyleemphasis{pyconf file configuration}. +The main options are: +\begin{itemize} +\item {} +\sphinxstylestrong{build\_source} : the method used to build the product (cmake/autotools/script) + +\item {} +\sphinxstylestrong{compil\_script} : the compilation script if build\_source is equal to “script” + +\item {} +\sphinxstylestrong{cmake\_options} : additional options for cmake. + +\item {} +\sphinxstylestrong{nb\_proc} : number of jobs to use with make for this product. + +\end{itemize} + +\clearpage + + +\section{Command launcher} +\label{\detokenize{commands/launcher:svn}}\label{\detokenize{commands/launcher:command-launcher}}\label{\detokenize{commands/launcher::doc}} + +\subsection{Description} +\label{\detokenize{commands/launcher:description}} +The \sphinxstylestrong{launcher} command creates a SALOME launcher, a python script file to start \sphinxhref{http://www.salome-platform.org}{SALOME}% +\begin{footnote}[6]\sphinxAtStartFootnote +\sphinxnolinkurl{http://www.salome-platform.org} +% +\end{footnote}. + + +\subsection{Usage} +\label{\detokenize{commands/launcher:usage}}\begin{itemize} +\item {} +Create a launcher: + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{n}{sat} \PYG{n}{launcher} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} +\end{sphinxVerbatim} + +Generate a launcher in the application directory, i.e \sphinxcode{\sphinxupquote{\$APPLICATION.workdir}}. + +\item {} +Create a launcher with a given name (default name is \sphinxcode{\sphinxupquote{APPLICATION.profile.launcher\_name}}) + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{n}{sat} \PYG{n}{launcher} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{name} \PYG{n}{ZeLauncher} +\end{sphinxVerbatim} + +The launcher will be called \sphinxstyleemphasis{ZeLauncher}. + +\item {} +Set a specific resources catalog: + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{n}{sat} \PYG{n}{launcher} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{catalog} \PYG{o}{\PYGZlt{}}\PYG{n}{path} \PYG{n}{of} \PYG{n}{a} \PYG{n}{salome} \PYG{n}{resources} \PYG{n}{catalog}\PYG{o}{\PYGZgt{}} +\end{sphinxVerbatim} + +Note that the catalog specified will be copied to the profile directory. + +\item {} +Generate the catalog for a list of machines: + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{n}{sat} \PYG{n}{launcher} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{gencat} \PYG{o}{\PYGZlt{}}\PYG{n+nb}{list} \PYG{n}{of} \PYG{n}{machines}\PYG{o}{\PYGZgt{}} +\end{sphinxVerbatim} + +This will create a catalog by querying each machine (memory, number of processor) with ssh. + +\item {} +Generate a mesa launcher (if mesa and llvm are parts of the application). Use this option only if you have to use salome through ssh and have problems with ssh X forwarding of OpengGL modules (like Paravis): + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{n}{sat} \PYG{n}{launcher} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{use\PYGZus{}mesa} +\end{sphinxVerbatim} + +\end{itemize} + + +\subsection{Configuration} +\label{\detokenize{commands/launcher:configuration}} +Some useful configuration pathes: +\begin{itemize} +\item {} +\sphinxstylestrong{APPLICATION.profile} +\begin{itemize} +\item {} +\sphinxstylestrong{product} : the name of the profile product (the product in charge of holding the application stuff, like logos, splashscreen) + +\item {} +\sphinxstylestrong{launcher\_name} : the name of the launcher. + +\end{itemize} + +\end{itemize} + +\clearpage + + +\section{Command application} +\label{\detokenize{commands/application:svn}}\label{\detokenize{commands/application::doc}}\label{\detokenize{commands/application:command-application}} + +\subsection{Description} +\label{\detokenize{commands/application:description}} +The \sphinxstylestrong{application} command creates a virtual \sphinxhref{http://www.salome-platform.org}{SALOME}% +\begin{footnote}[7]\sphinxAtStartFootnote +\sphinxnolinkurl{http://www.salome-platform.org} +% +\end{footnote} application. +Virtual SALOME applications are used to start SALOME when distribution is needed. + + +\subsection{Usage} +\label{\detokenize{commands/application:usage}}\begin{itemize} +\item {} +Create an application: + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{n}{sat} \PYG{n}{application} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} +\end{sphinxVerbatim} + +Create the virtual application directory in the salomeTool application directory \sphinxcode{\sphinxupquote{\$APPLICATION.workdir}}. + +\item {} +Give a name to the application: + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{n}{sat} \PYG{n}{application} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{name} \PYG{o}{\PYGZlt{}}\PYG{n}{my\PYGZus{}application\PYGZus{}name}\PYG{o}{\PYGZgt{}} +\end{sphinxVerbatim} + +\sphinxstyleemphasis{Remark}: this option overrides the name given in the virtual\_app section of the configuration file \sphinxcode{\sphinxupquote{\$APPLICATION.virtual\_app.name}}. + +\item {} +Change the directory where the application is created: + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{n}{sat} \PYG{n}{application} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{target} \PYG{o}{\PYGZlt{}}\PYG{n}{my\PYGZus{}application\PYGZus{}directory}\PYG{o}{\PYGZgt{}} +\end{sphinxVerbatim} + +\item {} +Set a specific \sphinxhref{http://www.salome-platform.org}{SALOME}% +\begin{footnote}[8]\sphinxAtStartFootnote +\sphinxnolinkurl{http://www.salome-platform.org} +% +\end{footnote} resources catalog (it will be used for the distribution of components on distant machines): + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{n}{sat} \PYG{n}{application} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{catalog} \PYG{o}{\PYGZlt{}}\PYG{n}{path\PYGZus{}to\PYGZus{}catalog}\PYG{o}{\PYGZgt{}} +\end{sphinxVerbatim} + +Note that the catalog specified will be copied to the application directory. + +\item {} +Generate the catalog for a list of machines: + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{n}{sat} \PYG{n}{application} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{gencat} \PYG{n}{machine1}\PYG{p}{,}\PYG{n}{machine2}\PYG{p}{,}\PYG{n}{machine3} +\end{sphinxVerbatim} + +This will create a catalog by querying each machine through ssh protocol (memory, number of processor) with ssh. + +\item {} +Generate a mesa application (if mesa and llvm are parts of the application). Use this option only if you have to use salome through ssh and have problems with ssh X forwarding of OpengGL modules (like Paravis): + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{n}{sat} \PYG{n}{launcher} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{use\PYGZus{}mesa} +\end{sphinxVerbatim} + +\end{itemize} + + +\subsection{Some useful configuration pathes} +\label{\detokenize{commands/application:some-useful-configuration-pathes}} +The virtual application can be configured with the virtual\_app section of the configutation file. +\begin{itemize} +\item {} +\sphinxstylestrong{APPLICATION.virtual\_app} +\begin{itemize} +\item {} +\sphinxstylestrong{name} : name of the launcher (to replace the default runAppli). + +\item {} +\sphinxstylestrong{application\_name} : (optional) the name of the virtual application directory, if missing the default value is \sphinxcode{\sphinxupquote{\$name + \_appli}}. + +\end{itemize} + +\end{itemize} + +\clearpage + + +\section{Command log} +\label{\detokenize{commands/log:svn}}\label{\detokenize{commands/log:command-log}}\label{\detokenize{commands/log::doc}} + +\subsection{Description} +\label{\detokenize{commands/log:description}} +The \sphinxstylestrong{log} command displays sat log in a web browser or in a terminal. + + +\subsection{Usage} +\label{\detokenize{commands/log:usage}}\begin{itemize} +\item {} +Show (in a web browser) the log of the commands corresponding to an application: + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{n}{sat} \PYG{n}{log} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} +\end{sphinxVerbatim} + +\item {} +Show the log for commands that do not use any application: + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{n}{sat} \PYG{n}{log} +\end{sphinxVerbatim} + +\item {} +The \textendash{}terminal (or -t) display the log directly in the terminal, through a \sphinxhref{https://en.wikipedia.org/wiki/Command-line\_interface}{CLI}% +\begin{footnote}[9]\sphinxAtStartFootnote +\sphinxnolinkurl{https://en.wikipedia.org/wiki/Command-line\_interface} +% +\end{footnote} interactive menu: + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{n}{sat} \PYG{n}{log} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{terminal} +\end{sphinxVerbatim} + +\item {} +The \textendash{}last option displays only the last command: + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{n}{sat} \PYG{n}{log} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{last} +\end{sphinxVerbatim} + +\item {} +To access the last compilation log in terminal mode, use \textendash{}last\_terminal option: + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{n}{sat} \PYG{n}{log} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{last\PYGZus{}terminal} +\end{sphinxVerbatim} + +\item {} +The \textendash{}clean (int) option erases the n older log files and print the number of remaining log files: + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{n}{sat} \PYG{n}{log} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{clean} \PYG{l+m+mi}{50} +\end{sphinxVerbatim} + +\end{itemize} + + +\subsection{Some useful configuration pathes} +\label{\detokenize{commands/log:some-useful-configuration-pathes}}\begin{itemize} +\item {} +\sphinxstylestrong{USER} +\begin{itemize} +\item {} +\sphinxstylestrong{browser} : The browser used to show the log (by default \sphinxstyleemphasis{firefox}). + +\item {} +\sphinxstylestrong{log\_dir} : The directory used to store the log files. + +\end{itemize} + +\end{itemize} + +\clearpage + + +\section{Command environ} +\label{\detokenize{commands/environ:svn}}\label{\detokenize{commands/environ:command-environ}}\label{\detokenize{commands/environ::doc}} + +\subsection{Description} +\label{\detokenize{commands/environ:description}} +The \sphinxstylestrong{environ} command generates the environment files used +to run and compile your application (as \sphinxhref{http://www.salome-platform.org}{SALOME}% +\begin{footnote}[10]\sphinxAtStartFootnote +\sphinxnolinkurl{http://www.salome-platform.org} +% +\end{footnote} is an example). + +\begin{sphinxadmonition}{note}{Note:} +these files are \sphinxstylestrong{not} required, +salomeTool set the environment himself, when compiling. +And so does the salome launcher. + +These files are useful when someone wants to check the environment. +They could be used in debug mode to set the environment for \sphinxstyleemphasis{gdb}. +\end{sphinxadmonition} + +The configuration part at the end of this page explains how +to specify the environment used by sat (at build or run time), +and saved in some files by \sphinxstyleemphasis{sat environ} command. + + +\subsection{Usage} +\label{\detokenize{commands/environ:usage}}\begin{itemize} +\item {} +Create the shell environment files of the application: + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{n}{sat} \PYG{n}{environ} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} +\end{sphinxVerbatim} + +\item {} +Create the environment files of the application for a given shell. +Options are bash, bat (for windows) and cfg (the configuration format used by \sphinxhref{http://www.salome-platform.org}{SALOME}% +\begin{footnote}[11]\sphinxAtStartFootnote +\sphinxnolinkurl{http://www.salome-platform.org} +% +\end{footnote}): + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{n}{sat} \PYG{n}{environ} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{shell} \PYG{p}{[}\PYG{n}{bash}\PYG{o}{\textbar{}}\PYG{n}{cfg}\PYG{o}{\textbar{}}\PYG{n+nb}{all}\PYG{p}{]} +\end{sphinxVerbatim} + +\item {} +Use a different prefix for the files (default is ‘env’): + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{c+c1}{\PYGZsh{} This will create file \PYGZlt{}prefix\PYGZgt{}\PYGZus{}launch.sh, \PYGZlt{}prefix\PYGZgt{}\PYGZus{}build.sh} +sat environ \PYGZlt{}application\PYGZgt{} \PYGZhy{}\PYGZhy{}prefix \PYGZlt{}prefix\PYGZgt{} +\end{sphinxVerbatim} + +\item {} +Use a different target directory for the files: + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{c+c1}{\PYGZsh{} This will create file env\PYGZus{}launch.sh, env\PYGZus{}build.sh} +\PYG{c+c1}{\PYGZsh{} in the directory corresponding to \PYGZlt{}path\PYGZgt{}} +sat environ \PYGZlt{}application\PYGZgt{} \PYGZhy{}\PYGZhy{}target \PYGZlt{}path\PYGZgt{} +\end{sphinxVerbatim} + +\item {} +Generate the environment files only with the given products: + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{c+c1}{\PYGZsh{} This will create the environment files only for the given products} +\PYG{c+c1}{\PYGZsh{} and their prerequisites.} +\PYG{c+c1}{\PYGZsh{} It is useful when you want to visualise which environment uses} +\PYG{c+c1}{\PYGZsh{} sat to compile a given product.} +sat environ \PYGZlt{}application\PYGZgt{} \PYGZhy{}\PYGZhy{}product \PYGZlt{}product1\PYGZgt{},\PYGZlt{}product2\PYGZgt{}, ... +\end{sphinxVerbatim} + +\end{itemize} + + +\subsection{Configuration} +\label{\detokenize{commands/environ:configuration}} +The specification of the environment can be done through several mechanisms. +\begin{enumerate} +\item {} +For salome products (the products with the property \sphinxcode{\sphinxupquote{is\_SALOME\_module}} as \sphinxcode{\sphinxupquote{yes}}) the environment is set automatically by sat, in respect with \sphinxhref{http://www.salome-platform.org}{SALOME}% +\begin{footnote}[12]\sphinxAtStartFootnote +\sphinxnolinkurl{http://www.salome-platform.org} +% +\end{footnote} requirements. + +\item {} +For other products, the environment is set with the use of the environ section within the pyconf file of the product. The user has two possibilities, either set directly the environment within the section, or specify a python script which wil be used to set the environment programmatically. + +\end{enumerate} + +Within the section, the user can define environment variables. He can also modify PATH variables, by appending or prepending directories. +In the following example, we prepend \sphinxstyleemphasis{\textless{}install\_dir\textgreater{}/lib} to \sphinxcode{\sphinxupquote{LD\_LIBRARY\_PATH}} (note the \sphinxstyleemphasis{left first} underscore), append \sphinxstyleemphasis{\textless{}install\_dir\textgreater{}/lib} to \sphinxcode{\sphinxupquote{PYTHONPATH}} (note the \sphinxstyleemphasis{right last} underscore), and set \sphinxcode{\sphinxupquote{LAPACK\_ROOT\_DIR}} to \sphinxstyleemphasis{\textless{}install\_dir\textgreater{}}: + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +environ : +\PYG{o}{\PYGZob{}} + \PYGZus{}LD\PYGZus{}LIBRARY\PYGZus{}PATH : \PYG{n+nv}{\PYGZdl{}install\PYGZus{}dir} + \PYG{n+nv}{\PYGZdl{}VARS}.sep + \PYG{l+s+s2}{\PYGZdq{}lib\PYGZdq{}} + PYTHONPATH\PYGZus{} : \PYG{n+nv}{\PYGZdl{}install\PYGZus{}dir} + \PYG{n+nv}{\PYGZdl{}VARS}.sep + \PYG{l+s+s2}{\PYGZdq{}lib\PYGZdq{}} + LAPACK\PYGZus{}ROOT\PYGZus{}DIR : \PYG{n+nv}{\PYGZdl{}install\PYGZus{}dir} +\PYG{o}{\PYGZcb{}} +\end{sphinxVerbatim} + +It is possible to distinguish the build environment from the launch environment: use a subsection called \sphinxstyleemphasis{build} or \sphinxstyleemphasis{launch}. In the example below, \sphinxcode{\sphinxupquote{LD\_LIBRARY\_PATH}} and \sphinxcode{\sphinxupquote{PYTHONPATH}} are only modified at run time, not at compile time: + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +environ : +\PYG{o}{\PYGZob{}} + build : + \PYG{o}{\PYGZob{}} + LAPACK\PYGZus{}ROOT\PYGZus{}DIR : \PYG{n+nv}{\PYGZdl{}install\PYGZus{}dir} + \PYG{o}{\PYGZcb{}} + launch : + \PYG{o}{\PYGZob{}} + LAPACK\PYGZus{}ROOT\PYGZus{}DIR : \PYG{n+nv}{\PYGZdl{}install\PYGZus{}dir} + \PYGZus{}LD\PYGZus{}LIBRARY\PYGZus{}PATH : \PYG{n+nv}{\PYGZdl{}install\PYGZus{}dir} + \PYG{n+nv}{\PYGZdl{}VARS}.sep + \PYG{l+s+s2}{\PYGZdq{}lib\PYGZdq{}} + PYTHONPATH\PYGZus{} : \PYG{n+nv}{\PYGZdl{}install\PYGZus{}dir} + \PYG{n+nv}{\PYGZdl{}VARS}.sep + \PYG{l+s+s2}{\PYGZdq{}lib\PYGZdq{}} + \PYG{o}{\PYGZcb{}} +\PYG{o}{\PYGZcb{}} +\end{sphinxVerbatim} +\begin{enumerate} +\setcounter{enumi}{2} +\item {} +The last possibility is to set the environment with a python script. The script should be provided in the \sphinxstyleemphasis{products/env\_scripts} directory of the sat project, and its name is specified in the environment section with the key \sphinxcode{\sphinxupquote{environ.env\_script}}: + +\end{enumerate} + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{n}{environ} \PYG{p}{:} +\PYG{p}{\PYGZob{}} + \PYG{n}{env\PYGZus{}script} \PYG{p}{:} \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{lapack.py}\PYG{l+s+s1}{\PYGZsq{}} +\PYG{p}{\PYGZcb{}} +\end{sphinxVerbatim} + +Please note that the two modes are complementary and are both taken into account. +Most of the time, the first mode is sufficient. + +The second mode can be used when the environment has to be set programmatically. +The developer implements a handle (as a python method) +which is called by sat to set the environment. +Here is an example: + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{c+ch}{\PYGZsh{}!/usr/bin/env python} +\PYG{c+c1}{\PYGZsh{}\PYGZhy{}*\PYGZhy{} coding:utf\PYGZhy{}8 \PYGZhy{}*\PYGZhy{}} + +\PYG{k+kn}{import} \PYG{n+nn}{os.path} +\PYG{k+kn}{import} \PYG{n+nn}{platform} + +\PYG{k}{def} \PYG{n+nf}{set\PYGZus{}env}\PYG{p}{(}\PYG{n}{env}\PYG{p}{,} \PYG{n}{prereq\PYGZus{}dir}\PYG{p}{,} \PYG{n}{version}\PYG{p}{)}\PYG{p}{:} + \PYG{n}{env}\PYG{o}{.}\PYG{n}{set}\PYG{p}{(}\PYG{l+s+s2}{\PYGZdq{}}\PYG{l+s+s2}{TRUST\PYGZus{}ROOT\PYGZus{}DIR}\PYG{l+s+s2}{\PYGZdq{}}\PYG{p}{,}\PYG{n}{prereq\PYGZus{}dir}\PYG{p}{)} + \PYG{n}{env}\PYG{o}{.}\PYG{n}{prepend}\PYG{p}{(}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{PATH}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{n}{os}\PYG{o}{.}\PYG{n}{path}\PYG{o}{.}\PYG{n}{join}\PYG{p}{(}\PYG{n}{prereq\PYGZus{}dir}\PYG{p}{,} \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{bin}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{)}\PYG{p}{)} + \PYG{n}{env}\PYG{o}{.}\PYG{n}{prepend}\PYG{p}{(}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{PATH}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{n}{os}\PYG{o}{.}\PYG{n}{path}\PYG{o}{.}\PYG{n}{join}\PYG{p}{(}\PYG{n}{prereq\PYGZus{}dir}\PYG{p}{,} \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{include}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{)}\PYG{p}{)} + \PYG{n}{env}\PYG{o}{.}\PYG{n}{prepend}\PYG{p}{(}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{LD\PYGZus{}LIBRARY\PYGZus{}PATH}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{n}{os}\PYG{o}{.}\PYG{n}{path}\PYG{o}{.}\PYG{n}{join}\PYG{p}{(}\PYG{n}{prereq\PYGZus{}dir}\PYG{p}{,} \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{lib}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{)}\PYG{p}{)} + \PYG{k}{return} +\end{sphinxVerbatim} + +SalomeTools defines four handles: +\begin{itemize} +\item {} +\sphinxstylestrong{set\_env(env, prereq\_dir, version)} : used at build and run time. + +\item {} +\sphinxstylestrong{set\_env\_launch(env, prereq\_dir, version)} : used only at run time (if defined!) + +\item {} +\sphinxstylestrong{set\_env\_build(env, prereq\_dir, version)} : used only at build time (if defined!) + +\item {} +\sphinxstylestrong{set\_native\_env(env)} : used only for native products, at build and run time. + +\end{itemize} + +\clearpage + + +\section{Command clean} +\label{\detokenize{commands/clean:svn}}\label{\detokenize{commands/clean:command-clean}}\label{\detokenize{commands/clean::doc}} + +\subsection{Description} +\label{\detokenize{commands/clean:description}} +The \sphinxstylestrong{clean} command removes products in the \sphinxstyleemphasis{source, build, or install} directories of an application. Theses directories are usually named \sphinxcode{\sphinxupquote{SOURCES, BUILD, INSTALL}}. + +Use the options to define what directories you want to suppress and to set the list of products + + +\subsection{Usage} +\label{\detokenize{commands/clean:usage}}\begin{itemize} +\item {} +Clean all previously created \sphinxstyleemphasis{build} and \sphinxstyleemphasis{install} directories (example application as \sphinxstyleemphasis{SALOME\_xx}): + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{c+c1}{\PYGZsh{} take care, is long time to restore, sometimes} +sat clean SALOME\PYGZhy{}xx \PYGZhy{}\PYGZhy{}build \PYGZhy{}\PYGZhy{}install +\end{sphinxVerbatim} + +\item {} +Clean previously created \sphinxstyleemphasis{build} and \sphinxstyleemphasis{install} directories, only for products with property \sphinxstyleemphasis{is\_salome\_module}: + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +sat clean SALOME\PYGZhy{}xxx \PYGZhy{}\PYGZhy{}build \PYGZhy{}\PYGZhy{}install \PYG{l+s+se}{\PYGZbs{}} + \PYGZhy{}\PYGZhy{}properties is\PYGZus{}salome\PYGZus{}module:yes +\end{sphinxVerbatim} + +\end{itemize} + + +\subsection{Availables options} +\label{\detokenize{commands/clean:availables-options}}\begin{itemize} +\item {} +\sphinxstylestrong{\textendash{}products} : Products to clean. + +\item {} +\sphinxstylestrong{\textendash{}properties} : + +\begin{DUlineblock}{0em} +\item[] Filter the products by their properties. +\item[] Syntax: \sphinxstyleemphasis{\textendash{}properties \textless{}property\textgreater{}:\textless{}value\textgreater{}} +\end{DUlineblock} + +\item {} +\sphinxstylestrong{\textendash{}sources} : Clean the product source directories. + +\item {} +\sphinxstylestrong{\textendash{}build} : Clean the product build directories. + +\item {} +\sphinxstylestrong{\textendash{}install} : Clean the product install directories. + +\item {} +\sphinxstylestrong{\textendash{}all} : Clean the product source, build and install directories. + +\item {} +\sphinxstylestrong{\textendash{}sources\_without\_dev} : + +\begin{DUlineblock}{0em} +\item[] Do not clean the products in development mode, +\item[] (they could have \sphinxhref{https://en.wikipedia.org/wiki/Version\_control}{VCS}% +\begin{footnote}[13]\sphinxAtStartFootnote +\sphinxnolinkurl{https://en.wikipedia.org/wiki/Version\_control} +% +\end{footnote} commits pending). +\end{DUlineblock} + +\end{itemize} + + +\subsection{Some useful configuration pathes} +\label{\detokenize{commands/clean:some-useful-configuration-pathes}} +No specific configuration. + +\clearpage + + +\section{Command package} +\label{\detokenize{commands/package:svn}}\label{\detokenize{commands/package:command-package}}\label{\detokenize{commands/package::doc}} + +\subsection{Description} +\label{\detokenize{commands/package:description}} +The \sphinxstylestrong{package} command creates a \sphinxhref{http://www.salome-platform.org}{SALOME}% +\begin{footnote}[14]\sphinxAtStartFootnote +\sphinxnolinkurl{http://www.salome-platform.org} +% +\end{footnote} archive (usually a compressed \sphinxhref{https://en.wikipedia.org/wiki/Tar\_(computing)}{Tar}% +\begin{footnote}[15]\sphinxAtStartFootnote +\sphinxnolinkurl{https://en.wikipedia.org/wiki/Tar\_(computing)} +% +\end{footnote} file .tgz). +This tar file is used later to intall SALOME on other remote computer. + +Depending on the selected options, the archive includes sources and binaries +of SALOME products and prerequisites. + +Usually utility \sphinxstyleemphasis{salomeTools} is included in the archive. + +\begin{sphinxadmonition}{note}{Note:} +By default the package includes the sources of prerequisites and products. +To select a subset use the \sphinxstyleemphasis{\textendash{}without\_property} or \sphinxstyleemphasis{\textendash{}with\_vcs} options. +\end{sphinxadmonition} + + +\subsection{Usage} +\label{\detokenize{commands/package:usage}}\begin{itemize} +\item {} +Create a package for a product (example as \sphinxstyleemphasis{SALOME\_xx}): + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{n}{sat} \PYG{n}{package} \PYG{n}{SALOME\PYGZus{}xx} +\end{sphinxVerbatim} + +This command will create an archive named \sphinxcode{\sphinxupquote{SALOME\_xx.tgz}} +in the working directory (\sphinxcode{\sphinxupquote{USER.workDir}}). +If the archive already exists, do nothing. + +\item {} +Create a package with a specific name: + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{n}{sat} \PYG{n}{package} \PYG{n}{SALOME\PYGZus{}xx} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{name} \PYG{n}{YourSpecificName} +\end{sphinxVerbatim} + +\end{itemize} + +\begin{sphinxadmonition}{note}{Note:} +By default, the archive is created in the working directory of the user (\sphinxcode{\sphinxupquote{USER.workDir}}). + +If the option \sphinxstyleemphasis{\textendash{}name} is used with a path (relative or absolute) it will be used. + +If the option \sphinxstyleemphasis{\textendash{}name} is not used and binaries (prerequisites and products) +are included in the package, the \sphinxhref{https://en.wikipedia.org/wiki/Operating\_system}{OS}% +\begin{footnote}[16]\sphinxAtStartFootnote +\sphinxnolinkurl{https://en.wikipedia.org/wiki/Operating\_system} +% +\end{footnote} architecture +will be appended to the name (example: \sphinxcode{\sphinxupquote{SALOME\_xx-CO7.tgz}}). + +Examples: + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{c+c1}{\PYGZsh{} Creates SALOME\PYGZus{}xx.tgz in \PYGZdl{}USER.workDir} +\PYG{n}{sat} \PYG{n}{package} \PYG{n}{SALOME\PYGZus{}xx} + +\PYG{c+c1}{\PYGZsh{} Creates SALOME\PYGZus{}xx\PYGZus{}\PYGZlt{}arch\PYGZgt{}.tgz in \PYGZdl{}USER.workDir} +\PYG{n}{sat} \PYG{n}{package} \PYG{n}{SALOME\PYGZus{}xx} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{binaries} + +\PYG{c+c1}{\PYGZsh{} Creates MySpecificName.tgz in \PYGZdl{}USER.workDir} +\PYG{n}{sat} \PYG{n}{package} \PYG{n}{SALOME\PYGZus{}xx} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{name} \PYG{n}{MySpecificName} +\end{sphinxVerbatim} +\end{sphinxadmonition} +\begin{itemize} +\item {} +Force the creation of the archive (if it already exists): + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{n}{sat} \PYG{n}{package} \PYG{n}{SALOME\PYGZus{}xx} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{force} +\end{sphinxVerbatim} + +\item {} +Include the binaries in the archive (products and prerequisites): + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{n}{sat} \PYG{n}{package} \PYG{n}{SALOME\PYGZus{}xx} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{binaries} +\end{sphinxVerbatim} + +This command will create an archive named \sphinxcode{\sphinxupquote{SALOME\_xx \_\textless{}arch\textgreater{}.tgz}} +where \textless{}arch\textgreater{} is the \sphinxhref{https://en.wikipedia.org/wiki/Operating\_system}{OS}% +\begin{footnote}[17]\sphinxAtStartFootnote +\sphinxnolinkurl{https://en.wikipedia.org/wiki/Operating\_system} +% +\end{footnote} architecture of the machine. + +\item {} +Do not delete Version Control System (\sphinxhref{https://en.wikipedia.org/wiki/Version\_control}{VCS}% +\begin{footnote}[18]\sphinxAtStartFootnote +\sphinxnolinkurl{https://en.wikipedia.org/wiki/Version\_control} +% +\end{footnote}) informations from the configurations files of the embedded salomeTools: + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{n}{sat} \PYG{n}{package} \PYG{n}{SALOME\PYGZus{}xx} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{with\PYGZus{}vcs} +\end{sphinxVerbatim} + +The version control systems known by this option are \sphinxhref{https://fr.wikipedia.org/wiki/Concurrent\_versions\_system}{CVS}% +\begin{footnote}[19]\sphinxAtStartFootnote +\sphinxnolinkurl{https://fr.wikipedia.org/wiki/Concurrent\_versions\_system} +% +\end{footnote}, \sphinxhref{https://en.wikipedia.org/wiki/Apache\_Subversion}{SVN}% +\begin{footnote}[20]\sphinxAtStartFootnote +\sphinxnolinkurl{https://en.wikipedia.org/wiki/Apache\_Subversion} +% +\end{footnote} and \sphinxhref{https://git-scm.com}{Git}% +\begin{footnote}[21]\sphinxAtStartFootnote +\sphinxnolinkurl{https://git-scm.com} +% +\end{footnote}. + +\end{itemize} + + +\subsection{Some useful configuration pathes} +\label{\detokenize{commands/package:some-useful-configuration-pathes}} +No specific configuration. + +\clearpage + + +\section{Command generate} +\label{\detokenize{commands/generate:svn}}\label{\detokenize{commands/generate:command-generate}}\label{\detokenize{commands/generate::doc}} + +\subsection{Description} +\label{\detokenize{commands/generate:description}} +The \sphinxstylestrong{generate} command generates and compile SALOME modules from cpp modules using YACSGEN. + +\begin{sphinxadmonition}{note}{Note:} +This command uses YACSGEN to generate the module. It needs to be specified with \sphinxstyleemphasis{\textendash{}yacsgen} option, or defined in the product or by the environment variable \sphinxcode{\sphinxupquote{\$YACSGEN\_ROOT\_DIR}}. +\end{sphinxadmonition} + + +\subsection{Remarks} +\label{\detokenize{commands/generate:remarks}}\begin{itemize} +\item {} +This command will only apply on the CPP modules of the application, those who have both properties: + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{n}{cpp} \PYG{p}{:} \PYG{l+s+s2}{\PYGZdq{}}\PYG{l+s+s2}{yes}\PYG{l+s+s2}{\PYGZdq{}} +\PYG{n}{generate} \PYG{p}{:} \PYG{l+s+s2}{\PYGZdq{}}\PYG{l+s+s2}{yes}\PYG{l+s+s2}{\PYGZdq{}} +\end{sphinxVerbatim} + +\item {} +The cpp module are usually computational components, and the generated module brings the CORBA layer which allows distributing the compononent on remore machines. cpp modules should conform to YACSGEN/hxx2salome requirements (please refer to YACSGEN documentation) + +\end{itemize} + + +\subsection{Usage} +\label{\detokenize{commands/generate:usage}}\begin{itemize} +\item {} +Generate all the modules of a product: + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{n}{sat} \PYG{n}{generate} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} +\end{sphinxVerbatim} + +\item {} +Generate only specific modules: + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{n}{sat} \PYG{n}{generate} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{products} \PYG{o}{\PYGZlt{}}\PYG{n}{list\PYGZus{}of\PYGZus{}products}\PYG{o}{\PYGZgt{}} +\end{sphinxVerbatim} + +Remark: modules which don’t have the \sphinxstyleemphasis{generate} property are ignored. + +\item {} +Use a specific version of YACSGEN: + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{n}{sat} \PYG{n}{generate} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{yacsgen} \PYG{o}{\PYGZlt{}}\PYG{n}{path\PYGZus{}to\PYGZus{}yacsgen}\PYG{o}{\PYGZgt{}} +\end{sphinxVerbatim} + +\end{itemize} + + +\chapter{Developer documentation} +\label{\detokenize{index:developer-documentation}} +\clearpage + + +\section{Add a user custom command} +\label{\detokenize{write_command:svn}}\label{\detokenize{write_command:add-a-user-custom-command}}\label{\detokenize{write_command::doc}} + +\subsection{Introduction} +\label{\detokenize{write_command:introduction}} +\begin{sphinxadmonition}{note}{Note:} +This documentation is for \sphinxhref{https://docs.python.org/2.7}{Python}% +\begin{footnote}[22]\sphinxAtStartFootnote +\sphinxnolinkurl{https://docs.python.org/2.7} +% +\end{footnote} developers. +\end{sphinxadmonition} + +The salomeTools product provides a simple way to develop commands. +The first thing to do is to add a file with \sphinxstyleemphasis{.py} extension in the \sphinxcode{\sphinxupquote{commands}} directory of salomeTools. + +Here are the basic requirements that must be followed in this file in order to add a command. + + +\subsection{Basic requirements} +\label{\detokenize{write_command:basic-requirements}} +By adding a file \sphinxstyleemphasis{mycommand.py} in the \sphinxcode{\sphinxupquote{commands}} directory, salomeTools will define a new command named \sphinxcode{\sphinxupquote{mycommand}}. + +In \sphinxstyleemphasis{mycommand.py}, there must be the following method: + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{k}{def} \PYG{n+nf}{run}\PYG{p}{(}\PYG{n}{args}\PYG{p}{,} \PYG{n}{runner}\PYG{p}{,} \PYG{n}{logger}\PYG{p}{)}\PYG{p}{:} + \PYG{c+c1}{\PYGZsh{} your algorithm ...} + \PYG{k}{pass} +\end{sphinxVerbatim} + +In fact, at this point, the command will already be functional. +But there are some useful services provided by salomeTools : +\begin{itemize} +\item {} +You can give some options to your command: + +\end{itemize} + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{k+kn}{import} \PYG{n+nn}{src} + +\PYG{c+c1}{\PYGZsh{} Define all possible option for mycommand command : \PYGZsq{}sat mycommand \PYGZlt{}options\PYGZgt{}\PYGZsq{}} +\PYG{n}{parser} \PYG{o}{=} \PYG{n}{src}\PYG{o}{.}\PYG{n}{options}\PYG{o}{.}\PYG{n}{Options}\PYG{p}{(}\PYG{p}{)} +\PYG{n}{parser}\PYG{o}{.}\PYG{n}{add\PYGZus{}option}\PYG{p}{(}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{m}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{myoption}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYGZbs{} + \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{boolean}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{myoption}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYGZbs{} + \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{My option changes the behavior of my command.}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{)} + +\PYG{k}{def} \PYG{n+nf}{run}\PYG{p}{(}\PYG{n}{args}\PYG{p}{,} \PYG{n}{runner}\PYG{p}{,} \PYG{n}{logger}\PYG{p}{)}\PYG{p}{:} + \PYG{c+c1}{\PYGZsh{} Parse the options} + \PYG{p}{(}\PYG{n}{options}\PYG{p}{,} \PYG{n}{args}\PYG{p}{)} \PYG{o}{=} \PYG{n}{parser}\PYG{o}{.}\PYG{n}{parse\PYGZus{}args}\PYG{p}{(}\PYG{n}{args}\PYG{p}{)} + \PYG{c+c1}{\PYGZsh{} algorithm} +\end{sphinxVerbatim} +\begin{itemize} +\item {} +You can add a \sphinxstyleemphasis{description} method that will display a message when the user will call the help: + +\end{itemize} + +\fvset{hllines={, 9, 10,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] + \PYG{k+kn}{import} \PYG{n+nn}{src} + + \PYG{c+c1}{\PYGZsh{} Define all possible option for mycommand command : \PYGZsq{}sat mycommand \PYGZlt{}options\PYGZgt{}\PYGZsq{}} + \PYG{n}{parser} \PYG{o}{=} \PYG{n}{src}\PYG{o}{.}\PYG{n}{options}\PYG{o}{.}\PYG{n}{Options}\PYG{p}{(}\PYG{p}{)} + \PYG{n}{parser}\PYG{o}{.}\PYG{n}{add\PYGZus{}option}\PYG{p}{(}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{m}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{myoption}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYGZbs{} + \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{boolean}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{myoption}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYGZbs{} + \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{My option changes the behavior of my command.}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{)} + + \PYG{k}{def} \PYG{n+nf}{description}\PYG{p}{(}\PYG{p}{)}\PYG{p}{:} + \PYG{k}{return} \PYG{n}{\PYGZus{}}\PYG{p}{(}\PYG{l+s+s2}{\PYGZdq{}}\PYG{l+s+s2}{The help of mycommand.}\PYG{l+s+s2}{\PYGZdq{}}\PYG{p}{)} + + \PYG{k}{def} \PYG{n+nf}{run}\PYG{p}{(}\PYG{n}{args}\PYG{p}{,} \PYG{n}{runner}\PYG{p}{,} \PYG{n}{logger}\PYG{p}{)}\PYG{p}{:} + \PYG{c+c1}{\PYGZsh{} Parse the options} + \PYG{p}{(}\PYG{n}{options}\PYG{p}{,} \PYG{n}{args}\PYG{p}{)} \PYG{o}{=} \PYG{n}{parser}\PYG{o}{.}\PYG{n}{parse\PYGZus{}args}\PYG{p}{(}\PYG{n}{args}\PYG{p}{)} + \PYG{c+c1}{\PYGZsh{} algorithm} +\end{sphinxVerbatim} + + +\subsection{HowTo access salomeTools config and other commands} +\label{\detokenize{write_command:howto-access-salometools-config-and-other-commands}} +The \sphinxstyleemphasis{runner} variable is an python instance of \sphinxstyleemphasis{Sat} class. +It gives access to \sphinxstyleemphasis{runner.cfg} which is the data model defined from all +\sphinxstyleemphasis{configuration pyconf files} of salomeTools +For example, \sphinxstyleemphasis{runner.cfg.APPLICATION.workdir} +contains the root directory of the current application. + +The \sphinxstyleemphasis{runner} variable gives also access to other commands of salomeTools: + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{c+c1}{\PYGZsh{} as CLI\PYGZus{} \PYGZsq{}sat prepare ...\PYGZsq{}} +\PYG{n}{runner}\PYG{o}{.}\PYG{n}{prepare}\PYG{p}{(}\PYG{n}{runner}\PYG{o}{.}\PYG{n}{cfg}\PYG{o}{.}\PYG{n}{VARS}\PYG{o}{.}\PYG{n}{application}\PYG{p}{)} +\end{sphinxVerbatim} + + +\subsection{HowTo logger} +\label{\detokenize{write_command:howto-logger}} +The logger variable is an instance of the Logger class. +It gives access to the write method. + +When this method is called, the message passed as parameter +will be displayed in the terminal and written in an xml log file. + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{n}{logger}\PYG{o}{.}\PYG{n}{write}\PYG{p}{(}\PYG{l+s+s2}{\PYGZdq{}}\PYG{l+s+s2}{My message}\PYG{l+s+s2}{\PYGZdq{}}\PYG{p}{,} \PYG{l+m+mi}{3}\PYG{p}{)} \PYG{c+c1}{\PYGZsh{} 3 as default} +\end{sphinxVerbatim} + +The second argument defines the level of verbosity +that is wanted for this message. +It has to be between 1 and 5 (the most verbose level). + + +\subsection{HELLO example} +\label{\detokenize{write_command:hello-example}} +Here is a \sphinxstyleemphasis{hello} command, file \sphinxstyleemphasis{commands/hello.py}: + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{k+kn}{import} \PYG{n+nn}{src} + +\PYG{l+s+sd}{\PYGZdq{}\PYGZdq{}\PYGZdq{}} +\PYG{l+s+sd}{hello.py} +\PYG{l+s+sd}{Define all possible options for hello command:} +\PYG{l+s+sd}{sat hello \PYGZlt{}options\PYGZgt{}} +\PYG{l+s+sd}{\PYGZdq{}\PYGZdq{}\PYGZdq{}} + +\PYG{n}{parser} \PYG{o}{=} \PYG{n}{src}\PYG{o}{.}\PYG{n}{options}\PYG{o}{.}\PYG{n}{Options}\PYG{p}{(}\PYG{p}{)} +\PYG{n}{parser}\PYG{o}{.}\PYG{n}{add\PYGZus{}option}\PYG{p}{(}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{f}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{french}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{boolean}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{french}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{l+s+s2}{\PYGZdq{}}\PYG{l+s+s2}{french set hello message in french.}\PYG{l+s+s2}{\PYGZdq{}}\PYG{p}{)} + +\PYG{k}{def} \PYG{n+nf}{description}\PYG{p}{(}\PYG{p}{)}\PYG{p}{:} + \PYG{k}{return} \PYG{n}{\PYGZus{}}\PYG{p}{(}\PYG{l+s+s2}{\PYGZdq{}}\PYG{l+s+s2}{The help of hello.}\PYG{l+s+s2}{\PYGZdq{}}\PYG{p}{)} + +\PYG{k}{def} \PYG{n+nf}{run}\PYG{p}{(}\PYG{n}{args}\PYG{p}{,} \PYG{n}{runner}\PYG{p}{,} \PYG{n}{logger}\PYG{p}{)}\PYG{p}{:} + \PYG{c+c1}{\PYGZsh{} Parse the options} + \PYG{p}{(}\PYG{n}{options}\PYG{p}{,} \PYG{n}{args}\PYG{p}{)} \PYG{o}{=} \PYG{n}{parser}\PYG{o}{.}\PYG{n}{parse\PYGZus{}args}\PYG{p}{(}\PYG{n}{args}\PYG{p}{)} + \PYG{c+c1}{\PYGZsh{} algorithm} + \PYG{k}{if} \PYG{o+ow}{not} \PYG{n}{options}\PYG{o}{.}\PYG{n}{french}\PYG{p}{:} + \PYG{n}{logger}\PYG{o}{.}\PYG{n}{write}\PYG{p}{(}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{HELLO! WORLD!}\PYG{l+s+se}{\PYGZbs{}n}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{)} + \PYG{k}{else}\PYG{p}{:} + \PYG{n}{logger}\PYG{o}{.}\PYG{n}{write}\PYG{p}{(}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{Bonjour tout le monde!}\PYG{l+s+se}{\PYGZbs{}n}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{)} +\end{sphinxVerbatim} + +A first call of hello: + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{c+c1}{\PYGZsh{} Get the help of hello:} +./sat \PYGZhy{}\PYGZhy{}help hello + +\PYG{c+c1}{\PYGZsh{} To get bonjour} +./sat hello \PYGZhy{}\PYGZhy{}french +Bonjour tout le monde! + +\PYG{c+c1}{\PYGZsh{} To get hello} +./sat hello +HELLO! WORLD! + +\PYG{c+c1}{\PYGZsh{} To get the log} +./sat log +\end{sphinxVerbatim} + + +\chapter{Code documentation} +\label{\detokenize{index:code-documentation}} + +\section{src} +\label{\detokenize{commands/apidoc/modules:src}}\label{\detokenize{commands/apidoc/modules::doc}} + +\subsection{src Package} +\label{\detokenize{commands/apidoc/src::doc}}\label{\detokenize{commands/apidoc/src:src-package}} + +\subsubsection{\sphinxstyleliteralintitle{\sphinxupquote{src}} Package} +\label{\detokenize{commands/apidoc/src:id1}}\phantomsection\label{\detokenize{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{\detokenize{commands/apidoc/src:src.__init__.Path}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.\_\_init\_\_.}}\sphinxbfcode{\sphinxupquote{Path}}}{\emph{path}}{}~\index{base() (src.\_\_init\_\_.Path method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.Path.base}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{base}}}{}{} +\end{fulllineitems} + +\index{chmod() (src.\_\_init\_\_.Path method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.Path.chmod}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{chmod}}}{\emph{mode}}{} +\end{fulllineitems} + +\index{copy() (src.\_\_init\_\_.Path method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.Path.copy}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{copy}}}{\emph{path}, \emph{smart=False}}{} +\end{fulllineitems} + +\index{copydir() (src.\_\_init\_\_.Path method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.Path.copydir}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{copydir}}}{\emph{dst}, \emph{smart=False}}{} +\end{fulllineitems} + +\index{copyfile() (src.\_\_init\_\_.Path method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.Path.copyfile}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{copyfile}}}{\emph{path}}{} +\end{fulllineitems} + +\index{copylink() (src.\_\_init\_\_.Path method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.Path.copylink}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{copylink}}}{\emph{path}}{} +\end{fulllineitems} + +\index{dir() (src.\_\_init\_\_.Path method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.Path.dir}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{dir}}}{}{} +\end{fulllineitems} + +\index{exists() (src.\_\_init\_\_.Path method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.Path.exists}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{exists}}}{}{} +\end{fulllineitems} + +\index{isdir() (src.\_\_init\_\_.Path method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.Path.isdir}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{isdir}}}{}{} +\end{fulllineitems} + +\index{isfile() (src.\_\_init\_\_.Path method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.Path.isfile}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{isfile}}}{}{} +\end{fulllineitems} + +\index{islink() (src.\_\_init\_\_.Path method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.Path.islink}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{islink}}}{}{} +\end{fulllineitems} + +\index{list() (src.\_\_init\_\_.Path method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.Path.list}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{list}}}{}{} +\end{fulllineitems} + +\index{make() (src.\_\_init\_\_.Path method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.Path.make}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{make}}}{\emph{mode=None}}{} +\end{fulllineitems} + +\index{readlink() (src.\_\_init\_\_.Path method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.Path.readlink}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{readlink}}}{}{} +\end{fulllineitems} + +\index{rm() (src.\_\_init\_\_.Path method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.Path.rm}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{rm}}}{}{} +\end{fulllineitems} + +\index{smartcopy() (src.\_\_init\_\_.Path method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.Path.smartcopy}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{smartcopy}}}{\emph{path}}{} +\end{fulllineitems} + +\index{symlink() (src.\_\_init\_\_.Path method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.Path.symlink}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{symlink}}}{\emph{path}}{} +\end{fulllineitems} + + +\end{fulllineitems} + +\index{SatException} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.SatException}}\pysigline{\sphinxbfcode{\sphinxupquote{exception }}\sphinxcode{\sphinxupquote{src.\_\_init\_\_.}}\sphinxbfcode{\sphinxupquote{SatException}}} +Bases: \sphinxcode{\sphinxupquote{exceptions.Exception}} + +rename Exception Class + +\end{fulllineitems} + +\index{activate\_mesa\_property() (in module src.\_\_init\_\_)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.activate_mesa_property}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.\_\_init\_\_.}}\sphinxbfcode{\sphinxupquote{activate\_mesa\_property}}}{\emph{config}}{} +Add mesa property into application properties +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} The global configuration. It must have an application! + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{check\_config\_has\_application() (in module src.\_\_init\_\_)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.check_config_has_application}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.\_\_init\_\_.}}\sphinxbfcode{\sphinxupquote{check\_config\_has\_application}}}{\emph{config}, \emph{details=None}}{} +check that the config has the key APPLICATION. Else raise an exception. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{class 'common.pyconf.Config'}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} The config. + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{check\_config\_has\_profile() (in module src.\_\_init\_\_)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.check_config_has_profile}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.\_\_init\_\_.}}\sphinxbfcode{\sphinxupquote{check\_config\_has\_profile}}}{\emph{config}, \emph{details=None}}{} +check that the config has the key APPLICATION.profile. +else, raise an exception. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{class 'common.pyconf.Config'}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} The config. + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{config\_has\_application() (in module src.\_\_init\_\_)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.config_has_application}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.\_\_init\_\_.}}\sphinxbfcode{\sphinxupquote{config\_has\_application}}}{\emph{config}}{} +\end{fulllineitems} + +\index{deepcopy\_list() (in module src.\_\_init\_\_)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.deepcopy_list}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.\_\_init\_\_.}}\sphinxbfcode{\sphinxupquote{deepcopy\_list}}}{\emph{input\_list}}{} +Do a deep copy of a list +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{List}} (\sphinxstyleliteralemphasis{\sphinxupquote{input\_list}}) \textendash{} The list to copy + +\item[{Returns}] \leavevmode +The copy of the list + +\item[{Return type}] \leavevmode +List + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{ensure\_path\_exists() (in module src.\_\_init\_\_)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.ensure_path_exists}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.\_\_init\_\_.}}\sphinxbfcode{\sphinxupquote{ensure\_path\_exists}}}{\emph{p}}{} +Create a path if not existing +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{p}}) \textendash{} The path. + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{find\_file\_in\_lpath() (in module src.\_\_init\_\_)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.find_file_in_lpath}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.\_\_init\_\_.}}\sphinxbfcode{\sphinxupquote{find\_file\_in\_lpath}}}{\emph{file\_name}, \emph{lpath}, \emph{additional\_dir=''}}{} +Find in all the directories in lpath list the file that has the same name +as file\_name. +If it is found +then return the full path of the file +else return False. + +The additional\_dir (optional) is the name of the directory to add to all +paths in lpath. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{additional\_dir}}) \textendash{} The file name to search + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{List}} (\sphinxstyleliteralemphasis{\sphinxupquote{lpath}}) \textendash{} The list of directories where to search + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The name of the additional directory + +\end{itemize} + +\item[{Returns}] \leavevmode +the full path of the file or False if not found + +\item[{Return type}] \leavevmode +str + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{get\_base\_path() (in module src.\_\_init\_\_)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.get_base_path}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.\_\_init\_\_.}}\sphinxbfcode{\sphinxupquote{get\_base\_path}}}{\emph{config}}{} +Returns the path of the products base. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} The global Config instance. + +\item[{Returns}] \leavevmode +The path of the products base. + +\item[{Return type}] \leavevmode +str + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{get\_cfg\_param() (in module src.\_\_init\_\_)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.get_cfg_param}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.\_\_init\_\_.}}\sphinxbfcode{\sphinxupquote{get\_cfg\_param}}}{\emph{config}, \emph{param\_name}, \emph{default}}{} +eearch for param\_name value in config. +if param\_name is not in config +then return default, +else return the found value +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{class 'common.pyconf.Config'}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} The config. + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{default}}) \textendash{} the name of the parameter to get the value + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The value to return if param\_name is not in config + +\end{itemize} + +\item[{Returns}] \leavevmode +see initial description of the function + +\item[{Return type}] \leavevmode +str + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{get\_launcher\_name() (in module src.\_\_init\_\_)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.get_launcher_name}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.\_\_init\_\_.}}\sphinxbfcode{\sphinxupquote{get\_launcher\_name}}}{\emph{config}}{} +Returns the name of salome launcher. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} The global Config instance. + +\item[{Returns}] \leavevmode +The name of salome launcher. + +\item[{Return type}] \leavevmode +str + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{get\_log\_path() (in module src.\_\_init\_\_)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.get_log_path}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.\_\_init\_\_.}}\sphinxbfcode{\sphinxupquote{get\_log\_path}}}{\emph{config}}{} +Returns the path of the logs. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} The global Config instance. + +\item[{Returns}] \leavevmode +The path of the logs. + +\item[{Return type}] \leavevmode +str + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{get\_property\_in\_product\_cfg() (in module src.\_\_init\_\_)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.get_property_in_product_cfg}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.\_\_init\_\_.}}\sphinxbfcode{\sphinxupquote{get\_property\_in\_product\_cfg}}}{\emph{product\_cfg}, \emph{pprty}}{} +\end{fulllineitems} + +\index{get\_salome\_version() (in module src.\_\_init\_\_)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.get_salome_version}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.\_\_init\_\_.}}\sphinxbfcode{\sphinxupquote{get\_salome\_version}}}{\emph{config}}{} +\end{fulllineitems} + +\index{get\_tmp\_filename() (in module src.\_\_init\_\_)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.get_tmp_filename}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.\_\_init\_\_.}}\sphinxbfcode{\sphinxupquote{get\_tmp\_filename}}}{\emph{cfg}, \emph{name}}{} +\end{fulllineitems} + +\index{handleRemoveReadonly() (in module src.\_\_init\_\_)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.handleRemoveReadonly}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.\_\_init\_\_.}}\sphinxbfcode{\sphinxupquote{handleRemoveReadonly}}}{\emph{func}, \emph{path}, \emph{exc}}{} +\end{fulllineitems} + +\index{merge\_dicts() (in module src.\_\_init\_\_)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.merge_dicts}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.\_\_init\_\_.}}\sphinxbfcode{\sphinxupquote{merge\_dicts}}}{\emph{*dict\_args}}{} +Given any number of dicts, shallow copy and merge into a new dict, +precedence goes to key value pairs in latter dicts. + +\end{fulllineitems} + +\index{only\_numbers() (in module src.\_\_init\_\_)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.only_numbers}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.\_\_init\_\_.}}\sphinxbfcode{\sphinxupquote{only\_numbers}}}{\emph{str\_num}}{} +\end{fulllineitems} + +\index{parse\_date() (in module src.\_\_init\_\_)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.parse_date}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.\_\_init\_\_.}}\sphinxbfcode{\sphinxupquote{parse\_date}}}{\emph{date}}{} +Transform YYYYMMDD\_hhmmss into YYYY-MM-DD hh:mm:ss. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{date}}) \textendash{} The date to transform + +\item[{Returns}] \leavevmode +The date in the new format + +\item[{Return type}] \leavevmode +str + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{print\_info() (in module src.\_\_init\_\_)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.print_info}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.\_\_init\_\_.}}\sphinxbfcode{\sphinxupquote{print\_info}}}{\emph{logger}, \emph{info}}{} +Prints the tuples that are in info variable in a formatted way. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logging instance to use for the prints. + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{info}}) \textendash{} The list of tuples to display + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{read\_config\_from\_a\_file() (in module src.\_\_init\_\_)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.read_config_from_a_file}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.\_\_init\_\_.}}\sphinxbfcode{\sphinxupquote{read\_config\_from\_a\_file}}}{\emph{filePath}}{} +\end{fulllineitems} + +\index{remove\_item\_from\_list() (in module src.\_\_init\_\_)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.remove_item_from_list}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.\_\_init\_\_.}}\sphinxbfcode{\sphinxupquote{remove\_item\_from\_list}}}{\emph{input\_list}, \emph{item}}{} +Remove all occurences of item from input\_list +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{List}} (\sphinxstyleliteralemphasis{\sphinxupquote{input\_list}}) \textendash{} The list to modify + +\item[{Returns}] \leavevmode +The without any item + +\item[{Return type}] \leavevmode +List + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{replace\_in\_file() (in module src.\_\_init\_\_)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.__init__.replace_in_file}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.\_\_init\_\_.}}\sphinxbfcode{\sphinxupquote{replace\_in\_file}}}{\emph{filein}, \emph{strin}, \emph{strout}}{} +Replace \textless{}strin\textgreater{} by \textless{}strout\textgreater{} in file \textless{}filein\textgreater{} + +\end{fulllineitems} + + + +\subsubsection{\sphinxstyleliteralintitle{\sphinxupquote{ElementTree}} Module} +\label{\detokenize{commands/apidoc/src:elementtree-module}}\label{\detokenize{commands/apidoc/src:module-src.ElementTree}}\index{src.ElementTree (module)}\index{Comment() (in module src.ElementTree)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.Comment}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{Comment}}}{\emph{text=None}}{} +\end{fulllineitems} + +\index{dump() (in module src.ElementTree)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.dump}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{dump}}}{\emph{elem}}{} +\end{fulllineitems} + +\index{Element() (in module src.ElementTree)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.Element}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{Element}}}{\emph{tag}, \emph{attrib=\{\}}, \emph{**extra}}{} +\end{fulllineitems} + +\index{ElementTree (class in src.ElementTree)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.ElementTree}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{ElementTree}}}{\emph{element=None}, \emph{file=None}}{}~\index{find() (src.ElementTree.ElementTree method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.ElementTree.find}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{find}}}{\emph{path}}{} +\end{fulllineitems} + +\index{findall() (src.ElementTree.ElementTree method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.ElementTree.findall}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{findall}}}{\emph{path}}{} +\end{fulllineitems} + +\index{findtext() (src.ElementTree.ElementTree method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.ElementTree.findtext}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{findtext}}}{\emph{path}, \emph{default=None}}{} +\end{fulllineitems} + +\index{getiterator() (src.ElementTree.ElementTree method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.ElementTree.getiterator}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getiterator}}}{\emph{tag=None}}{} +\end{fulllineitems} + +\index{getroot() (src.ElementTree.ElementTree method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.ElementTree.getroot}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getroot}}}{}{} +\end{fulllineitems} + +\index{parse() (src.ElementTree.ElementTree method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.ElementTree.parse}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parse}}}{\emph{source}, \emph{parser=None}}{} +\end{fulllineitems} + +\index{write() (src.ElementTree.ElementTree method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.ElementTree.write}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write}}}{\emph{file}, \emph{encoding='us-ascii'}}{} +\end{fulllineitems} + + +\end{fulllineitems} + +\index{fromstring() (in module src.ElementTree)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.fromstring}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{fromstring}}}{\emph{text}}{} +\end{fulllineitems} + +\index{iselement() (in module src.ElementTree)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.iselement}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{iselement}}}{\emph{element}}{} +\end{fulllineitems} + +\index{iterparse (class in src.ElementTree)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.iterparse}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{iterparse}}}{\emph{source}, \emph{events=None}}{}~\index{next() (src.ElementTree.iterparse method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.iterparse.next}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{next}}}{}{} +\end{fulllineitems} + + +\end{fulllineitems} + +\index{parse() (in module src.ElementTree)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.parse}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{parse}}}{\emph{source}, \emph{parser=None}}{} +\end{fulllineitems} + +\index{PI() (in module src.ElementTree)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.PI}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{PI}}}{\emph{target}, \emph{text=None}}{} +\end{fulllineitems} + +\index{ProcessingInstruction() (in module src.ElementTree)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.ProcessingInstruction}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{ProcessingInstruction}}}{\emph{target}, \emph{text=None}}{} +\end{fulllineitems} + +\index{QName (class in src.ElementTree)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.QName}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{QName}}}{\emph{text\_or\_uri}, \emph{tag=None}}{} +\end{fulllineitems} + +\index{SubElement() (in module src.ElementTree)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.SubElement}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{SubElement}}}{\emph{parent}, \emph{tag}, \emph{attrib=\{\}}, \emph{**extra}}{} +\end{fulllineitems} + +\index{tostring() (in module src.ElementTree)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.tostring}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{tostring}}}{\emph{element}, \emph{encoding=None}}{} +\end{fulllineitems} + +\index{TreeBuilder (class in src.ElementTree)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.TreeBuilder}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{TreeBuilder}}}{\emph{element\_factory=None}}{}~\index{close() (src.ElementTree.TreeBuilder method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.TreeBuilder.close}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{close}}}{}{} +\end{fulllineitems} + +\index{data() (src.ElementTree.TreeBuilder method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.TreeBuilder.data}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{data}}}{\emph{data}}{} +\end{fulllineitems} + +\index{end() (src.ElementTree.TreeBuilder method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.TreeBuilder.end}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{end}}}{\emph{tag}}{} +\end{fulllineitems} + +\index{start() (src.ElementTree.TreeBuilder method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.TreeBuilder.start}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{start}}}{\emph{tag}, \emph{attrs}}{} +\end{fulllineitems} + + +\end{fulllineitems} + +\index{XML() (in module src.ElementTree)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.XML}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{XML}}}{\emph{text}}{} +\end{fulllineitems} + +\index{XMLTreeBuilder (class in src.ElementTree)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.XMLTreeBuilder}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{XMLTreeBuilder}}}{\emph{html=0}, \emph{target=None}}{}~\index{close() (src.ElementTree.XMLTreeBuilder method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.XMLTreeBuilder.close}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{close}}}{}{} +\end{fulllineitems} + +\index{doctype() (src.ElementTree.XMLTreeBuilder method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.XMLTreeBuilder.doctype}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{doctype}}}{\emph{name}, \emph{pubid}, \emph{system}}{} +\end{fulllineitems} + +\index{feed() (src.ElementTree.XMLTreeBuilder method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.ElementTree.XMLTreeBuilder.feed}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{feed}}}{\emph{data}}{} +\end{fulllineitems} + + +\end{fulllineitems} + + + +\subsubsection{\sphinxstyleliteralintitle{\sphinxupquote{architecture}} Module} +\label{\detokenize{commands/apidoc/src:architecture-module}}\label{\detokenize{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{\detokenize{commands/apidoc/src:src.architecture.get_distrib_version}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.architecture.}}\sphinxbfcode{\sphinxupquote{get\_distrib\_version}}}{\emph{distrib}, \emph{codes}}{} +Gets the version of the distribution +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{distrib}}) \textendash{} The distribution on which the version will be found. + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{L\{Mapping\}}} (\sphinxstyleliteralemphasis{\sphinxupquote{codes}}) \textendash{} The map containing distribution correlation table. + +\end{itemize} + +\item[{Returns}] \leavevmode +The version of the distribution on which salomeTools is running, +regarding the distribution correlation table contained in codes +variable. + +\item[{Return type}] \leavevmode +str + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{get\_distribution() (in module src.architecture)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.architecture.get_distribution}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.architecture.}}\sphinxbfcode{\sphinxupquote{get\_distribution}}}{\emph{codes}}{} +Gets the code for the distribution +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{L\{Mapping\}}} (\sphinxstyleliteralemphasis{\sphinxupquote{codes}}) \textendash{} The map containing distribution correlation table. + +\item[{Returns}] \leavevmode +The distribution on which salomeTools is running, regarding the +distribution correlation table contained in codes variable. + +\item[{Return type}] \leavevmode +str + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{get\_nb\_proc() (in module src.architecture)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.architecture.get_nb_proc}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.architecture.}}\sphinxbfcode{\sphinxupquote{get\_nb\_proc}}}{}{}~\begin{description} +\item[{Gets the number of processors of the machine }] \leavevmode +on which salomeTools is running. + +\end{description} +\begin{quote}\begin{description} +\item[{Returns}] \leavevmode +the number of processors. + +\item[{Return type}] \leavevmode +str + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{get\_python\_version() (in module src.architecture)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.architecture.get_python_version}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.architecture.}}\sphinxbfcode{\sphinxupquote{get\_python\_version}}}{}{} +Gets the version of the running python. +\begin{quote}\begin{description} +\item[{Returns}] \leavevmode +the version of the running python. + +\item[{Return type}] \leavevmode +str + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{get\_user() (in module src.architecture)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.architecture.get_user}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.architecture.}}\sphinxbfcode{\sphinxupquote{get\_user}}}{}{} +method that gets the username that launched sat +\begin{quote}\begin{description} +\item[{Return type}] \leavevmode +str + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{is\_windows() (in module src.architecture)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.architecture.is_windows}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.architecture.}}\sphinxbfcode{\sphinxupquote{is\_windows}}}{}{} +method that checks windows OS +\begin{quote}\begin{description} +\item[{Return type}] \leavevmode +boolean + +\end{description}\end{quote} + +\end{fulllineitems} + + + +\subsubsection{\sphinxstyleliteralintitle{\sphinxupquote{compilation}} Module} +\label{\detokenize{commands/apidoc/src:module-src.compilation}}\label{\detokenize{commands/apidoc/src:compilation-module}}\index{src.compilation (module)}\index{Builder (class in src.compilation)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.compilation.}}\sphinxbfcode{\sphinxupquote{Builder}}}{\emph{config}, \emph{logger}, \emph{product\_info}, \emph{options=\textless{}src.options.OptResult object at 0x37b8f90\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{\detokenize{commands/apidoc/src:src.compilation.Builder.build_configure}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{build\_configure}}}{\emph{options=''}}{} +\end{fulllineitems} + +\index{check() (src.compilation.Builder method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.check}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{check}}}{\emph{command=''}}{} +\end{fulllineitems} + +\index{cmake() (src.compilation.Builder method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.cmake}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{cmake}}}{\emph{options=''}}{} +\end{fulllineitems} + +\index{complete\_environment() (src.compilation.Builder method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.complete_environment}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{complete\_environment}}}{\emph{make\_options}}{} +\end{fulllineitems} + +\index{configure() (src.compilation.Builder method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.configure}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{configure}}}{\emph{options=''}}{} +\end{fulllineitems} + +\index{do\_batch\_script\_build() (src.compilation.Builder method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.do_batch_script_build}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{do\_batch\_script\_build}}}{\emph{script}, \emph{nb\_proc}}{} +\end{fulllineitems} + +\index{do\_default\_build() (src.compilation.Builder method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.do_default_build}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{do\_default\_build}}}{\emph{build\_conf\_options=''}, \emph{configure\_options=''}, \emph{show\_warning=True}}{} +\end{fulllineitems} + +\index{do\_python\_script\_build() (src.compilation.Builder method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.do_python_script_build}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{do\_python\_script\_build}}}{\emph{script}, \emph{nb\_proc}}{} +\end{fulllineitems} + +\index{do\_script\_build() (src.compilation.Builder method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.do_script_build}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{do\_script\_build}}}{\emph{script}, \emph{number\_of\_proc=0}}{} +\end{fulllineitems} + +\index{hack\_libtool() (src.compilation.Builder method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.hack_libtool}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{hack\_libtool}}}{}{} +\end{fulllineitems} + +\index{install() (src.compilation.Builder method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.install}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{install}}}{}{} +\end{fulllineitems} + +\index{log() (src.compilation.Builder method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.log}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{log}}}{\emph{text}, \emph{level}, \emph{showInfo=True}}{} +\end{fulllineitems} + +\index{log\_command() (src.compilation.Builder method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.log_command}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{log\_command}}}{\emph{command}}{} +\end{fulllineitems} + +\index{make() (src.compilation.Builder method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.make}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{make}}}{\emph{nb\_proc}, \emph{make\_opt=''}}{} +\end{fulllineitems} + +\index{prepare() (src.compilation.Builder method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.prepare}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepare}}}{}{} +\end{fulllineitems} + +\index{put\_txt\_log\_in\_appli\_log\_dir() (src.compilation.Builder method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.put_txt_log_in_appli_log_dir}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{put\_txt\_log\_in\_appli\_log\_dir}}}{\emph{file\_name}}{}~\begin{description} +\item[{Put the txt log (that contain the system logs, like make command}] \leavevmode +output) in the directory \textless{}APPLICATION DIR\textgreater{}/LOGS/\textless{}product\_name\textgreater{}/ + +\end{description} +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{Str}} (\sphinxstyleliteralemphasis{\sphinxupquote{file\_name}}) \textendash{} the name of the file to write + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{wmake() (src.compilation.Builder method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.compilation.Builder.wmake}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{wmake}}}{\emph{nb\_proc}, \emph{opt\_nb\_proc=None}}{} +\end{fulllineitems} + + +\end{fulllineitems} + + + +\subsubsection{\sphinxstyleliteralintitle{\sphinxupquote{debug}} Module} +\label{\detokenize{commands/apidoc/src:module-src.debug}}\label{\detokenize{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{\detokenize{commands/apidoc/src:src.debug.InStream}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{InStream}}}{\emph{buf=''}}{} +Bases: \sphinxcode{\sphinxupquote{StringIO.StringIO}} + +utility class for pyconf.Config input iostream + +\end{fulllineitems} + +\index{OutStream (class in src.debug)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.debug.OutStream}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{OutStream}}}{\emph{buf=''}}{} +Bases: \sphinxcode{\sphinxupquote{StringIO.StringIO}} + +utility class for pyconf.Config output iostream +\index{close() (src.debug.OutStream method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.debug.OutStream.close}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{close}}}{}{} +because Config.\_\_save\_\_ calls close() stream as file +keep value before lost as self.value + +\end{fulllineitems} + + +\end{fulllineitems} + +\index{getLocalEnv() (in module src.debug)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.debug.getLocalEnv}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{getLocalEnv}}}{}{} +get string for environment variables representation + +\end{fulllineitems} + +\index{getStrConfigDbg() (in module src.debug)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.debug.getStrConfigDbg}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{getStrConfigDbg}}}{\emph{config}}{} +set string as saveConfigDbg, +as (path expression evaluation) for debug + +\end{fulllineitems} + +\index{getStrConfigStd() (in module src.debug)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.debug.getStrConfigStd}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{getStrConfigStd}}}{\emph{config}}{} +set string as saveConfigStd, as file .pyconf + +\end{fulllineitems} + +\index{indent() (in module src.debug)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.debug.indent}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{indent}}}{\emph{text}, \emph{amount=2}, \emph{ch=' '}}{} +indent multi lines message + +\end{fulllineitems} + +\index{pop\_debug() (in module src.debug)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.debug.pop_debug}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{pop\_debug}}}{}{} +restore previous debug outputs status + +\end{fulllineitems} + +\index{push\_debug() (in module src.debug)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.debug.push_debug}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{push\_debug}}}{\emph{aBool}}{} +set debug outputs activated, or not + +\end{fulllineitems} + +\index{saveConfigDbg() (in module src.debug)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.debug.saveConfigDbg}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{saveConfigDbg}}}{\emph{config}, \emph{aStream}, \emph{indent=0}, \emph{path=''}}{} +pyconf returns multilines (path expression evaluation) for debug + +\end{fulllineitems} + +\index{saveConfigStd() (in module src.debug)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.debug.saveConfigStd}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{saveConfigStd}}}{\emph{config}, \emph{aStream}}{} +returns as file .pyconf + +\end{fulllineitems} + +\index{tofix() (in module src.debug)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.debug.tofix}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{tofix}}}{\emph{title}, \emph{var=''}, \emph{force=None}}{} +write sys.stderr a message if \_debug{[}-1{]}==True or optionaly force=True +use this only if no logger accessible for classic +logger.warning(message) or logger.debug(message) + +\end{fulllineitems} + +\index{write() (in module src.debug)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.debug.write}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{write}}}{\emph{title}, \emph{var=''}, \emph{force=None}, \emph{fmt='\textbackslash{}n\#\#\#\# DEBUG: \%s:\textbackslash{}n\%s\textbackslash{}n'}}{} +write sys.stderr a message if \_debug{[}-1{]}==True or optionaly force=True + +\end{fulllineitems} + + + +\subsubsection{\sphinxstyleliteralintitle{\sphinxupquote{environment}} Module} +\label{\detokenize{commands/apidoc/src:environment-module}}\label{\detokenize{commands/apidoc/src:module-src.environment}}\index{src.environment (module)}\index{Environ (class in src.environment)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.Environ}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.environment.}}\sphinxbfcode{\sphinxupquote{Environ}}}{\emph{environ=None}}{} +Class to manage the environment context +\index{append() (src.environment.Environ method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.Environ.append}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{} +Same as append\_value but the value argument can be a list +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to append + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}}\sphinxstyleliteralstrong{\sphinxupquote{ or }}\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the value(s) to append to key + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{append\_value() (src.environment.Environ method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.Environ.append_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append\_value}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{} +append value to key using sep +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to append + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to append to key + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{command\_value() (src.environment.Environ method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.Environ.command_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{command\_value}}}{\emph{key}, \emph{command}}{} +Get the value given by the system command “command” +and put it in the environment variable key +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{command}}) \textendash{} the environment variable + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the command to execute + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{get() (src.environment.Environ method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.Environ.get}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get}}}{\emph{key}}{} +Get the value of the environment variable “key” +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{is\_defined() (src.environment.Environ method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.Environ.is_defined}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{is\_defined}}}{\emph{key}}{} +Check if the key exists in the environment +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable to check + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{prepend() (src.environment.Environ method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.Environ.prepend}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepend}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{} +Same as prepend\_value but the value argument can be a list +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to prepend + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}}\sphinxstyleliteralstrong{\sphinxupquote{ or }}\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the value(s) to prepend to key + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{prepend\_value() (src.environment.Environ method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.Environ.prepend_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepend\_value}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{} +prepend value to key using sep +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to prepend + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to prepend to key + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{set() (src.environment.Environ method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.Environ.set}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set}}}{\emph{key}, \emph{value}}{} +Set the environment variable “key” to value “value” +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the environment variable to set + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + + +\end{fulllineitems} + +\index{FileEnvWriter (class in src.environment)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.FileEnvWriter}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.environment.}}\sphinxbfcode{\sphinxupquote{FileEnvWriter}}}{\emph{config}, \emph{logger}, \emph{out\_dir}, \emph{src\_root}, \emph{env\_info=None}}{} +Class to dump the environment to a file. +\index{write\_cfgForPy\_file() (src.environment.FileEnvWriter method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.FileEnvWriter.write_cfgForPy_file}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write\_cfgForPy\_file}}}{\emph{filename}, \emph{additional\_env=\{\}}, \emph{for\_package=None}, \emph{with\_commercial=True}}{} +Append to current opened aFile a cfgForPy +environment (SALOME python launcher). +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{for\_package}}) \textendash{} the file path + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{dict}} (\sphinxstyleliteralemphasis{\sphinxupquote{additional\_env}}) \textendash{} a dictionary of additional variables +to add to the environment + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} If not None, produce a relative environment +designed for a package. + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{write\_env\_file() (src.environment.FileEnvWriter method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.FileEnvWriter.write_env_file}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write\_env\_file}}}{\emph{filename}, \emph{forBuild}, \emph{shell}, \emph{for\_package=None}}{} +Create an environment file. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{shell}}) \textendash{} the file path + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{bool}} (\sphinxstyleliteralemphasis{\sphinxupquote{forBuild}}) \textendash{} if true, the build environment + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the type of file wanted (.sh, .bat) + +\end{itemize} + +\item[{Returns}] \leavevmode +The path to the generated file + +\item[{Return type}] \leavevmode +str + +\end{description}\end{quote} + +\end{fulllineitems} + + +\end{fulllineitems} + +\index{SalomeEnviron (class in src.environment)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.environment.}}\sphinxbfcode{\sphinxupquote{SalomeEnviron}}}{\emph{cfg}, \emph{environ}, \emph{forBuild=False}, \emph{for\_package=None}, \emph{enable\_simple\_env\_script=True}}{} +Class to manage the environment of SALOME. +\index{add\_comment() (src.environment.SalomeEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.add_comment}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_comment}}}{\emph{comment}}{} +Add a commentary to the out stream (in case of file generation) +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{comment}}) \textendash{} the commentary to add + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{add\_line() (src.environment.SalomeEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.add_line}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_line}}}{\emph{nb\_line}}{} +Add empty lines to the out stream (in case of file generation) +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{int}} (\sphinxstyleliteralemphasis{\sphinxupquote{nb\_line}}) \textendash{} the number of empty lines to add + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{add\_warning() (src.environment.SalomeEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.add_warning}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_warning}}}{\emph{warning}}{} +Add a warning to the out stream (in case of file generation) +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{warning}}) \textendash{} the warning to add + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{append() (src.environment.SalomeEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.append}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{} +append value to key using sep +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to append + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to append to key + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{dump() (src.environment.SalomeEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.dump}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{dump}}}{\emph{out}}{} +Write the environment to out +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{file}} (\sphinxstyleliteralemphasis{\sphinxupquote{out}}) \textendash{} the stream where to write the environment + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{finish() (src.environment.SalomeEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.finish}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{finish}}}{\emph{required}}{} +Add a final instruction in the out file (in case of file generation) +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{bool}} (\sphinxstyleliteralemphasis{\sphinxupquote{required}}) \textendash{} Do nothing if required is False + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{get() (src.environment.SalomeEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.get}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get}}}{\emph{key}}{} +Get the value of the environment variable “key” +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{get\_names() (src.environment.SalomeEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.get_names}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_names}}}{\emph{lProducts}}{} +Get the products name to add in SALOME\_MODULES environment variable +It is the name of the product, except in the case where the is a +component name. And it has to be in SALOME\_MODULES variable only +if the product has the property has\_salome\_hui = “yes” +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{lProducts}}) \textendash{} List of products to potentially add + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{is\_defined() (src.environment.SalomeEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.is_defined}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{is\_defined}}}{\emph{key}}{} +Check if the key exists in the environment +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable to check + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{load\_cfg\_environment() (src.environment.SalomeEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.load_cfg_environment}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{load\_cfg\_environment}}}{\emph{cfg\_env}}{} +Loads environment defined in cfg\_env +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{cfg\_env}}) \textendash{} A config containing an environment + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{prepend() (src.environment.SalomeEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.prepend}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepend}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{} +prepend value to key using sep +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to prepend + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to prepend to key + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{run\_env\_script() (src.environment.SalomeEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.run_env_script}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run\_env\_script}}}{\emph{product\_info}, \emph{logger=None}, \emph{native=False}}{} +Runs an environment script. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The product description + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to display messages + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{Boolean}} (\sphinxstyleliteralemphasis{\sphinxupquote{native}}) \textendash{} if True load set\_native\_env instead of set\_env + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{run\_simple\_env\_script() (src.environment.SalomeEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.run_simple_env_script}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run\_simple\_env\_script}}}{\emph{script\_path}, \emph{logger=None}}{} +Runs an environment script. Same as run\_env\_script, but with a +script path as parameter. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{script\_path}}) \textendash{} a path to an environment script + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to display messages + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{set() (src.environment.SalomeEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.set}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set}}}{\emph{key}, \emph{value}}{} +Set the environment variable “key” to value “value” +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the environment variable to set + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{set\_a\_product() (src.environment.SalomeEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.set_a_product}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_a\_product}}}{\emph{product}, \emph{logger}}{} +Sets the environment of a product. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{product}}) \textendash{} The product name + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to display messages + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{set\_application\_env() (src.environment.SalomeEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.set_application_env}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_application\_env}}}{\emph{logger}}{} +Sets the environment defined in the APPLICATION file. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to display messages + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{set\_cpp\_env() (src.environment.SalomeEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.set_cpp_env}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_cpp\_env}}}{\emph{product\_info}}{} +Sets the generic environment for a SALOME cpp product. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The product description + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{set\_full\_environ() (src.environment.SalomeEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.set_full_environ}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_full\_environ}}}{\emph{logger}, \emph{env\_info}}{} +Sets the full environment for products +specified in env\_info dictionary. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to display messages + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{env\_info}}) \textendash{} the list of products + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{set\_products() (src.environment.SalomeEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.set_products}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_products}}}{\emph{logger}, \emph{src\_root=None}}{} +Sets the environment for all the products. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to display messages + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{src}} (\sphinxstyleliteralemphasis{\sphinxupquote{src\_root}}) \textendash{} the application working directory + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{set\_python\_libdirs() (src.environment.SalomeEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.set_python_libdirs}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_python\_libdirs}}}{}{} +Set some generic variables for python library paths + +\end{fulllineitems} + +\index{set\_salome\_generic\_product\_env() (src.environment.SalomeEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.set_salome_generic_product_env}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_salome\_generic\_product\_env}}}{\emph{pi}}{} +Sets the generic environment for a SALOME product. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{pi}}) \textendash{} The product description + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{set\_salome\_minimal\_product\_env() (src.environment.SalomeEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.SalomeEnviron.set_salome_minimal_product_env}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_salome\_minimal\_product\_env}}}{\emph{product\_info}, \emph{logger}}{} +Sets the minimal environment for a SALOME product. +xxx\_ROOT\_DIR and xxx\_SRC\_DIR +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The product description + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to display messages + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + + +\end{fulllineitems} + +\index{Shell (class in src.environment)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.Shell}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.environment.}}\sphinxbfcode{\sphinxupquote{Shell}}}{\emph{name}, \emph{extension}}{} +Definition of a Shell. + +\end{fulllineitems} + +\index{load\_environment() (in module src.environment)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.environment.load_environment}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.environment.}}\sphinxbfcode{\sphinxupquote{load\_environment}}}{\emph{config}, \emph{build}, \emph{logger}}{} +Loads the environment (used to run the tests, for example). +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} the global config + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{bool}} (\sphinxstyleliteralemphasis{\sphinxupquote{build}}) \textendash{} build environement if True + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to display messages + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + + + +\subsubsection{\sphinxstyleliteralintitle{\sphinxupquote{fileEnviron}} Module} +\label{\detokenize{commands/apidoc/src:fileenviron-module}}\label{\detokenize{commands/apidoc/src:module-src.fileEnviron}}\index{src.fileEnviron (module)}\index{BashFileEnviron (class in src.fileEnviron)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.BashFileEnviron}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.fileEnviron.}}\sphinxbfcode{\sphinxupquote{BashFileEnviron}}}{\emph{output}, \emph{environ=None}}{} +Bases: {\hyperref[\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.fileEnviron.FileEnviron}}}}} (\autopageref*{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron}}) + +Class for bash shell. +\index{command\_value() (src.fileEnviron.BashFileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.BashFileEnviron.command_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{command\_value}}}{\emph{key}, \emph{command}}{} +Get the value given by the system command “command” +and put it in the environment variable key. +Has to be overwritten in the derived classes +This can be seen as a virtual method +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{command}}) \textendash{} the environment variable + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the command to execute + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{finish() (src.fileEnviron.BashFileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.BashFileEnviron.finish}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{finish}}}{\emph{required=True}}{} +Add a final instruction in the out file (in case of file generation) +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{bool}} (\sphinxstyleliteralemphasis{\sphinxupquote{required}}) \textendash{} Do nothing if required is False + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{set() (src.fileEnviron.BashFileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.BashFileEnviron.set}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set}}}{\emph{key}, \emph{value}}{} +Set the environment variable “key” to value “value” +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the environment variable to set + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + + +\end{fulllineitems} + +\index{BatFileEnviron (class in src.fileEnviron)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.BatFileEnviron}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.fileEnviron.}}\sphinxbfcode{\sphinxupquote{BatFileEnviron}}}{\emph{output}, \emph{environ=None}}{} +Bases: {\hyperref[\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.fileEnviron.FileEnviron}}}}} (\autopageref*{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron}}) + +for Windows batch shell. +\index{add\_comment() (src.fileEnviron.BatFileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.BatFileEnviron.add_comment}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_comment}}}{\emph{comment}}{} +Add a comment in the shell file +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{comment}}) \textendash{} the comment to add + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{command\_value() (src.fileEnviron.BatFileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.BatFileEnviron.command_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{command\_value}}}{\emph{key}, \emph{command}}{} +Get the value given by the system command “command” +and put it in the environment variable key. +Has to be overwritten in the derived classes +This can be seen as a virtual method +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{command}}) \textendash{} the environment variable + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the command to execute + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{finish() (src.fileEnviron.BatFileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.BatFileEnviron.finish}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{finish}}}{\emph{required=True}}{} +Add a final instruction in the out file (in case of file generation) +In the particular windows case, do nothing +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{bool}} (\sphinxstyleliteralemphasis{\sphinxupquote{required}}) \textendash{} Do nothing if required is False + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{get() (src.fileEnviron.BatFileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.BatFileEnviron.get}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get}}}{\emph{key}}{} +Get the value of the environment variable “key” +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{set() (src.fileEnviron.BatFileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.BatFileEnviron.set}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set}}}{\emph{key}, \emph{value}}{} +Set the environment variable “key” to value “value” +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the environment variable to set + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + + +\end{fulllineitems} + +\index{ContextFileEnviron (class in src.fileEnviron)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ContextFileEnviron}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.fileEnviron.}}\sphinxbfcode{\sphinxupquote{ContextFileEnviron}}}{\emph{output}, \emph{environ=None}}{} +Bases: {\hyperref[\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.fileEnviron.FileEnviron}}}}} (\autopageref*{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron}}) + +Class for a salome context configuration file. +\index{add\_echo() (src.fileEnviron.ContextFileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.add_echo}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_echo}}}{\emph{text}}{} +Add a comment +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{text}}) \textendash{} the comment to add + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{add\_warning() (src.fileEnviron.ContextFileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.add_warning}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_warning}}}{\emph{warning}}{} +Add a warning +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{text}}) \textendash{} the warning to add + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{append\_value() (src.fileEnviron.ContextFileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.append_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append\_value}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{} +append value to key using sep +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to append + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to append to key + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{command\_value() (src.fileEnviron.ContextFileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.command_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{command\_value}}}{\emph{key}, \emph{command}}{} +Get the value given by the system command “command” +and put it in the environment variable key. +Has to be overwritten in the derived classes +This can be seen as a virtual method +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{command}}) \textendash{} the environment variable + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the command to execute + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{finish() (src.fileEnviron.ContextFileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.finish}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{finish}}}{\emph{required=True}}{} +Add a final instruction in the out file (in case of file generation) +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{bool}} (\sphinxstyleliteralemphasis{\sphinxupquote{required}}) \textendash{} Do nothing if required is False + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{get() (src.fileEnviron.ContextFileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.get}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get}}}{\emph{key}}{} +Get the value of the environment variable “key” +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{prepend\_value() (src.fileEnviron.ContextFileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.prepend_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepend\_value}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{} +prepend value to key using sep +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to prepend + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to prepend to key + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{set() (src.fileEnviron.ContextFileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ContextFileEnviron.set}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set}}}{\emph{key}, \emph{value}}{} +Set the environment variable “key” to value “value” +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the environment variable to set + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + + +\end{fulllineitems} + +\index{FileEnviron (class in src.fileEnviron)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.fileEnviron.}}\sphinxbfcode{\sphinxupquote{FileEnviron}}}{\emph{output}, \emph{environ=None}}{} +Bases: \sphinxcode{\sphinxupquote{object}} + +Base class for shell environment +\index{add\_comment() (src.fileEnviron.FileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.add_comment}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_comment}}}{\emph{comment}}{} +Add a comment in the shell file +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{comment}}) \textendash{} the comment to add + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{add\_echo() (src.fileEnviron.FileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.add_echo}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_echo}}}{\emph{text}}{} +Add a “echo” in the shell file +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{text}}) \textendash{} the text to echo + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{add\_line() (src.fileEnviron.FileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.add_line}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_line}}}{\emph{number}}{} +Add some empty lines in the shell file +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{int}} (\sphinxstyleliteralemphasis{\sphinxupquote{number}}) \textendash{} the number of lines to add + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{add\_warning() (src.fileEnviron.FileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.add_warning}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_warning}}}{\emph{warning}}{} +Add a warning “echo” in the shell file +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{warning}}) \textendash{} the text to echo + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{append() (src.fileEnviron.FileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.append}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{} +Same as append\_value but the value argument can be a list +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to append + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}}\sphinxstyleliteralstrong{\sphinxupquote{ or }}\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the value(s) to append to key + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{append\_value() (src.fileEnviron.FileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.append_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append\_value}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{} +append value to key using sep +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to append + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to append to key + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{command\_value() (src.fileEnviron.FileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.command_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{command\_value}}}{\emph{key}, \emph{command}}{} +Get the value given by the system command “command” +and put it in the environment variable key. +Has to be overwritten in the derived classes +This can be seen as a virtual method +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{command}}) \textendash{} the environment variable + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the command to execute + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{finish() (src.fileEnviron.FileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.finish}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{finish}}}{\emph{required=True}}{} +Add a final instruction in the out file (in case of file generation) +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{bool}} (\sphinxstyleliteralemphasis{\sphinxupquote{required}}) \textendash{} Do nothing if required is False + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{get() (src.fileEnviron.FileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.get}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get}}}{\emph{key}}{} +Get the value of the environment variable “key” +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{is\_defined() (src.fileEnviron.FileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.is_defined}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{is\_defined}}}{\emph{key}}{} +Check if the key exists in the environment +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable to check + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{prepend() (src.fileEnviron.FileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.prepend}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepend}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{} +Same as prepend\_value but the value argument can be a list +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to prepend + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}}\sphinxstyleliteralstrong{\sphinxupquote{ or }}\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the value(s) to prepend to key + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{prepend\_value() (src.fileEnviron.FileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.prepend_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepend\_value}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{} +prepend value to key using sep +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to prepend + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to prepend to key + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{set() (src.fileEnviron.FileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron.set}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set}}}{\emph{key}, \emph{value}}{} +Set the environment variable ‘key’ to value ‘value’ +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the environment variable to set + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + + +\end{fulllineitems} + +\index{LauncherFileEnviron (class in src.fileEnviron)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.fileEnviron.}}\sphinxbfcode{\sphinxupquote{LauncherFileEnviron}}}{\emph{output}, \emph{environ=None}}{} +Class to generate a launcher file script +(in python syntax) SalomeContext API +\index{add() (src.fileEnviron.LauncherFileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add}}}{\emph{key}, \emph{value}}{} +prepend value to key using sep +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the environment variable to prepend + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to prepend to key + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{add\_comment() (src.fileEnviron.LauncherFileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add_comment}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_comment}}}{\emph{comment}}{} +\end{fulllineitems} + +\index{add\_echo() (src.fileEnviron.LauncherFileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add_echo}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_echo}}}{\emph{text}}{} +Add a comment +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{text}}) \textendash{} the comment to add + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{add\_line() (src.fileEnviron.LauncherFileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add_line}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_line}}}{\emph{number}}{} +Add some empty lines in the launcher file +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{int}} (\sphinxstyleliteralemphasis{\sphinxupquote{number}}) \textendash{} the number of lines to add + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{add\_warning() (src.fileEnviron.LauncherFileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.add_warning}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_warning}}}{\emph{warning}}{} +Add a warning +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{text}}) \textendash{} the warning to add + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{append() (src.fileEnviron.LauncherFileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.append}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{} +Same as append\_value but the value argument can be a list +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to append + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}}\sphinxstyleliteralstrong{\sphinxupquote{ or }}\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the value(s) to append to key + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{append\_value() (src.fileEnviron.LauncherFileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.append_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append\_value}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{} +append value to key using sep +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to append + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to append to key + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{change\_to\_launcher() (src.fileEnviron.LauncherFileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.change_to_launcher}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{change\_to\_launcher}}}{\emph{value}}{} +\end{fulllineitems} + +\index{command\_value() (src.fileEnviron.LauncherFileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.command_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{command\_value}}}{\emph{key}, \emph{command}}{} +Get the value given by the system command “command” +and put it in the environment variable key. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{command}}) \textendash{} the environment variable + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the command to execute + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{finish() (src.fileEnviron.LauncherFileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.finish}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{finish}}}{\emph{required=True}}{} +Add a final instruction in the out file (in case of file generation) +In the particular launcher case, do nothing +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{bool}} (\sphinxstyleliteralemphasis{\sphinxupquote{required}}) \textendash{} Do nothing if required is False + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{get() (src.fileEnviron.LauncherFileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.get}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get}}}{\emph{key}}{} +Get the value of the environment variable “key” +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{is\_defined() (src.fileEnviron.LauncherFileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.is_defined}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{is\_defined}}}{\emph{key}}{} +Check if the key exists in the environment +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable to check + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{prepend() (src.fileEnviron.LauncherFileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.prepend}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepend}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{} +Same as prepend\_value but the value argument can be a list +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to prepend + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}}\sphinxstyleliteralstrong{\sphinxupquote{ or }}\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the value(s) to prepend to key + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{prepend\_value() (src.fileEnviron.LauncherFileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.prepend_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepend\_value}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{} +prepend value to key using sep +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to prepend + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to prepend to key + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{set() (src.fileEnviron.LauncherFileEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.LauncherFileEnviron.set}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set}}}{\emph{key}, \emph{value}}{} +Set the environment variable “key” to value “value” +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the environment variable to set + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + + +\end{fulllineitems} + +\index{ScreenEnviron (class in src.fileEnviron)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.fileEnviron.}}\sphinxbfcode{\sphinxupquote{ScreenEnviron}}}{\emph{output}, \emph{environ=None}}{} +Bases: {\hyperref[\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.fileEnviron.FileEnviron}}}}} (\autopageref*{\detokenize{commands/apidoc/src:src.fileEnviron.FileEnviron}}) +\index{add\_comment() (src.fileEnviron.ScreenEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.add_comment}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_comment}}}{\emph{comment}}{} +Add a comment in the shell file +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{comment}}) \textendash{} the comment to add + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{add\_echo() (src.fileEnviron.ScreenEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.add_echo}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_echo}}}{\emph{text}}{} +Add a “echo” in the shell file +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{text}}) \textendash{} the text to echo + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{add\_line() (src.fileEnviron.ScreenEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.add_line}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_line}}}{\emph{number}}{} +Add some empty lines in the shell file +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{int}} (\sphinxstyleliteralemphasis{\sphinxupquote{number}}) \textendash{} the number of lines to add + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{add\_warning() (src.fileEnviron.ScreenEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.add_warning}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_warning}}}{\emph{warning}}{} +Add a warning “echo” in the shell file +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{warning}}) \textendash{} the text to echo + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{append() (src.fileEnviron.ScreenEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.append}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append}}}{\emph{name}, \emph{value}, \emph{sep=':'}}{} +Same as append\_value but the value argument can be a list +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to append + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}}\sphinxstyleliteralstrong{\sphinxupquote{ or }}\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the value(s) to append to key + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{command\_value() (src.fileEnviron.ScreenEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.command_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{command\_value}}}{\emph{key}, \emph{command}}{} +Get the value given by the system command “command” +and put it in the environment variable key. +Has to be overwritten in the derived classes +This can be seen as a virtual method +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{command}}) \textendash{} the environment variable + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the command to execute + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{get() (src.fileEnviron.ScreenEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.get}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get}}}{\emph{name}}{} +Get the value of the environment variable “key” +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{is\_defined() (src.fileEnviron.ScreenEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.is_defined}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{is\_defined}}}{\emph{name}}{} +Check if the key exists in the environment +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{key}}) \textendash{} the environment variable to check + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{prepend() (src.fileEnviron.ScreenEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.prepend}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepend}}}{\emph{name}, \emph{value}, \emph{sep=':'}}{} +Same as prepend\_value but the value argument can be a list +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{sep}}) \textendash{} the environment variable to prepend + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}}\sphinxstyleliteralstrong{\sphinxupquote{ or }}\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the value(s) to prepend to key + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the separator string + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{run\_env\_script() (src.fileEnviron.ScreenEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.run_env_script}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run\_env\_script}}}{\emph{module}, \emph{script}}{} +\end{fulllineitems} + +\index{set() (src.fileEnviron.ScreenEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.set}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set}}}{\emph{name}, \emph{value}}{} +Set the environment variable ‘key’ to value ‘value’ +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the environment variable to set + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{write() (src.fileEnviron.ScreenEnviron method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.ScreenEnviron.write}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write}}}{\emph{command}, \emph{name}, \emph{value}, \emph{sign='='}}{} +\end{fulllineitems} + + +\end{fulllineitems} + +\index{get\_file\_environ() (in module src.fileEnviron)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.get_file_environ}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.fileEnviron.}}\sphinxbfcode{\sphinxupquote{get\_file\_environ}}}{\emph{output}, \emph{shell}, \emph{environ=None}}{} +Instantiate correct FileEnvironment sub-class. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{file}} (\sphinxstyleliteralemphasis{\sphinxupquote{output}}) \textendash{} the output file stream. + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{shell}}) \textendash{} the type of shell syntax to use. + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{dict}} (\sphinxstyleliteralemphasis{\sphinxupquote{environ}}) \textendash{} a potential additional environment. + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{special\_path\_separator() (in module src.fileEnviron)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fileEnviron.special_path_separator}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.fileEnviron.}}\sphinxbfcode{\sphinxupquote{special\_path\_separator}}}{\emph{name}}{} +TCLLIBPATH, TKLIBPATH, PV\_PLUGIN\_PATH environments variables need +some exotic path separator. +This function gives the separator regarding the name of the variable +to append or prepend. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{name}}) \textendash{} The name of the variable to find the separator + +\end{description}\end{quote} + +\end{fulllineitems} + + + +\subsubsection{\sphinxstyleliteralintitle{\sphinxupquote{fork}} Module} +\label{\detokenize{commands/apidoc/src:fork-module}}\label{\detokenize{commands/apidoc/src:module-src.fork}}\index{src.fork (module)}\index{batch() (in module src.fork)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fork.batch}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.fork.}}\sphinxbfcode{\sphinxupquote{batch}}}{\emph{cmd}, \emph{logger}, \emph{cwd}, \emph{args={[}{]}}, \emph{log=None}, \emph{delai=20}, \emph{sommeil=1}}{} +\end{fulllineitems} + +\index{batch\_salome() (in module src.fork)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fork.batch_salome}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.fork.}}\sphinxbfcode{\sphinxupquote{batch\_salome}}}{\emph{cmd}, \emph{logger}, \emph{cwd}, \emph{args}, \emph{getTmpDir}, \emph{pendant='SALOME\_Session\_Server'}, \emph{fin='killSalome.py'}, \emph{log=None}, \emph{delai=20}, \emph{sommeil=1}, \emph{delaiapp=0}}{} +\end{fulllineitems} + +\index{launch\_command() (in module src.fork)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fork.launch_command}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.fork.}}\sphinxbfcode{\sphinxupquote{launch\_command}}}{\emph{cmd}, \emph{logger}, \emph{cwd}, \emph{args={[}{]}}, \emph{log=None}}{} +\end{fulllineitems} + +\index{show\_progress() (in module src.fork)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fork.show_progress}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.fork.}}\sphinxbfcode{\sphinxupquote{show\_progress}}}{\emph{logger}, \emph{top}, \emph{delai}, \emph{ss=''}}{} +shortcut function to display the progression +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logging instance + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{int}} (\sphinxstyleliteralemphasis{\sphinxupquote{delai}}) \textendash{} the number to display + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{int}} \textendash{} the number max + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{ss}}) \textendash{} the string to display + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{write\_back() (in module src.fork)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.fork.write_back}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.fork.}}\sphinxbfcode{\sphinxupquote{write\_back}}}{\emph{logger}, \emph{message}, \emph{level}}{} +shortcut function to write at the begin of the line +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logging instance + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{message}}) \textendash{} the text to display + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{int}} (\sphinxstyleliteralemphasis{\sphinxupquote{level}}) \textendash{} the level of verbosity + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + + + +\subsubsection{\sphinxstyleliteralintitle{\sphinxupquote{logger}} Module} +\label{\detokenize{commands/apidoc/src:logger-module}}\label{\detokenize{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{\detokenize{commands/apidoc/src:src.logger.Logger}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.logger.}}\sphinxbfcode{\sphinxupquote{Logger}}}{\emph{config}, \emph{silent\_sysstd=False}, \emph{all\_in\_terminal=False}, \emph{micro\_command=False}}{} +Bases: \sphinxcode{\sphinxupquote{object}} + +Class to handle log mechanism. +\index{add\_link() (src.logger.Logger method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.logger.Logger.add_link}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_link}}}{\emph{log\_file\_name}, \emph{command\_name}, \emph{command\_res}, \emph{full\_launched\_command}}{} +Add a link to another log file. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{command\_res}}) \textendash{} The file name of the link. + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The name of the command linked. + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The result of the command linked. “0” or “1” + +\end{itemize} + +\item[{Parma full\_launched\_command str}] \leavevmode +The full lanch command +(“sat command …”) + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{end\_write() (src.logger.Logger method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.logger.Logger.end_write}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{end\_write}}}{\emph{attribute}}{} +Called just after command end: Put all fields +corresponding to the command end context (time). +Write the log xml file on the hard drive. +And display the command to launch to get the log +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{dict}} (\sphinxstyleliteralemphasis{\sphinxupquote{attribute}}) \textendash{} the attribute to add to the node “Site”. + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{error() (src.logger.Logger method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.logger.Logger.error}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{error}}}{\emph{message}}{} +Print an error. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{message}}) \textendash{} The message to print. + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{flush() (src.logger.Logger method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.logger.Logger.flush}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{flush}}}{}{} +Flush terminal + +\end{fulllineitems} + +\index{put\_initial\_xml\_fields() (src.logger.Logger method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.logger.Logger.put_initial_xml_fields}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{put\_initial\_xml\_fields}}}{}{} +Called at class initialization: Put all fields +corresponding to the command context (user, time, …) + +\end{fulllineitems} + +\index{write() (src.logger.Logger method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.logger.Logger.write}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write}}}{\emph{message}, \emph{level=None}, \emph{screenOnly=False}}{} +function used in the commands +to print in the terminal and the log file. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{message}}) \textendash{} The message to print. + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{int}} (\sphinxstyleliteralemphasis{\sphinxupquote{level}}) \textendash{} The output level corresponding +to the message 0 \textless{} level \textless{} 6. + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{boolean}} (\sphinxstyleliteralemphasis{\sphinxupquote{screenOnly}}) \textendash{} if True, do not write in log file. + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + + +\end{fulllineitems} + +\index{date\_to\_datetime() (in module src.logger)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.logger.date_to_datetime}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.logger.}}\sphinxbfcode{\sphinxupquote{date\_to\_datetime}}}{\emph{date}}{} +From a string date in format YYYYMMDD\_HHMMSS +returns list year, mon, day, hour, minutes, seconds +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{date}}) \textendash{} The date in format YYYYMMDD\_HHMMSS + +\item[{Returns}] \leavevmode +the same date and time in separate variables. + +\item[{Return type}] \leavevmode +(str,str,str,str,str,str) + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{list\_log\_file() (in module src.logger)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.logger.list_log_file}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.logger.}}\sphinxbfcode{\sphinxupquote{list\_log\_file}}}{\emph{dirPath}, \emph{expression}}{} +Find all files corresponding to expression in dirPath +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{expression}}) \textendash{} the directory where to search the files + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the regular expression of files to find + +\end{itemize} + +\item[{Returns}] \leavevmode +the list of files path and informations about it + +\item[{Return type}] \leavevmode +list + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{show\_command\_log() (in module src.logger)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.logger.show_command_log}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.logger.}}\sphinxbfcode{\sphinxupquote{show\_command\_log}}}{\emph{logFilePath}, \emph{cmd}, \emph{application}, \emph{notShownCommands}}{} +Used in updateHatXml. +Determine if the log xml file logFilePath +has to be shown or not in the hat log. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{application}}) \textendash{} the path to the command xml log file + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the command of the log file + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the application passed as parameter +to the salomeTools command + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{notShownCommands}}) \textendash{} the list of commands +that are not shown by default + +\end{itemize} + +\item[{Returns}] \leavevmode +True if cmd is not in notShownCommands and the application +in the log file corresponds to application + +\item[{Return type}] \leavevmode +boolean + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{timedelta\_total\_seconds() (in module src.logger)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.logger.timedelta_total_seconds}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.logger.}}\sphinxbfcode{\sphinxupquote{timedelta\_total\_seconds}}}{\emph{timedelta}}{} +Replace total\_seconds from datetime module +in order to be compatible with old python versions +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{datetime.timedelta}} (\sphinxstyleliteralemphasis{\sphinxupquote{timedelta}}) \textendash{} The delta between two dates + +\item[{Returns}] \leavevmode +The number of seconds corresponding to timedelta. + +\item[{Return type}] \leavevmode +float + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{update\_hat\_xml() (in module src.logger)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.logger.update_hat_xml}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.logger.}}\sphinxbfcode{\sphinxupquote{update\_hat\_xml}}}{\emph{logDir}, \emph{application=None}, \emph{notShownCommands={[}{]}}}{} +Create the xml file in logDir that contain all the xml file +and have a name like YYYYMMDD\_HHMMSS\_namecmd.xml +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{application}}) \textendash{} the directory to parse + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the name of the application if there is any + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + + + +\subsubsection{\sphinxstyleliteralintitle{\sphinxupquote{options}} Module} +\label{\detokenize{commands/apidoc/src:module-src.options}}\label{\detokenize{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{\detokenize{commands/apidoc/src:src.options.OptResult}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.options.}}\sphinxbfcode{\sphinxupquote{OptResult}}} +Bases: \sphinxcode{\sphinxupquote{object}} + +An instance of this class will be the object manipulated +in code of all salomeTools commands +The aim of this class is to have an elegant syntax +to manipulate the options. +ex: +print(options.level) +5 + +\end{fulllineitems} + +\index{Options (class in src.options)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.options.Options}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.options.}}\sphinxbfcode{\sphinxupquote{Options}}} +Class to manage all salomeTools options +\index{add\_option() (src.options.Options method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.options.Options.add_option}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_option}}}{\emph{shortName}, \emph{longName}, \emph{optionType}, \emph{destName}, \emph{helpString=''}, \emph{default=None}}{}~\begin{description} +\item[{Method to add an option to a command. It gets all attributes}] \leavevmode +of an option and append it in the options field + +\end{description} +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{helpString}}) \textendash{} The short name of the option +(ex “l” for level option). + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The long name of the option +(ex “level” for level option). + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The type of the option (ex “int”). + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The name that will be used in the code. + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} 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{\detokenize{commands/apidoc/src:src.options.Options.parse_args}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parse\_args}}}{\emph{argList=None}}{}~\begin{description} +\item[{Method that instantiates the class OptResult }] \leavevmode +that gives access to all options in the code + +\end{description} +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{list}} (\sphinxstyleliteralemphasis{\sphinxupquote{argList}}) \textendash{} 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{\detokenize{commands/apidoc/src:src.options.Options.print_help}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{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{\sphinxstyleliteralintitle{\sphinxupquote{printcolors}} Module} +\label{\detokenize{commands/apidoc/src:printcolors-module}}\label{\detokenize{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{\detokenize{commands/apidoc/src:src.printcolors.cleancolor}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{cleancolor}}}{\emph{message}}{} +remove color from a colored text. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{message}}) \textendash{} The text to be cleaned. + +\item[{Returns}] \leavevmode +The cleaned text. + +\item[{Return type}] \leavevmode +str + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{print\_color\_map() (in module src.printcolors)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.print_color_map}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{print\_color\_map}}}{}{} +This method prints the color map + +\end{fulllineitems} + +\index{print\_color\_range() (in module src.printcolors)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.print_color_range}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{print\_color\_range}}}{\emph{start}, \emph{end}}{} +print possible range values for colors +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{int}} (\sphinxstyleliteralemphasis{\sphinxupquote{end}}) \textendash{} The smaller value. + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{int}} \textendash{} The bigger value. + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{print\_value() (in module src.printcolors)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.print_value}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{print\_value}}}{\emph{logger}, \emph{label}, \emph{value}, \emph{level=1}, \emph{suffix=''}}{} +shortcut method to print a label and a value with the info color +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{class logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} the logger instance. + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{int}} (\sphinxstyleliteralemphasis{\sphinxupquote{level}}) \textendash{} the label to print. + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{suffix}}) \textendash{} the value to print. + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{int}} \textendash{} the level of verboseness. + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the suffix to add at the end. + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{printc() (in module src.printcolors)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.printc}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{printc}}}{\emph{txt}, \emph{code=''}}{} +print a text with colors +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{code}}) \textendash{} The text to be printed. + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The color to use. + +\end{itemize} + +\item[{Returns}] \leavevmode +The colored text. + +\item[{Return type}] \leavevmode +str + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{printcError() (in module src.printcolors)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.printcError}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{printcError}}}{\emph{txt}}{} +print a text error color +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{txt}}) \textendash{} The text to be printed. + +\item[{Returns}] \leavevmode +The colored text. + +\item[{Return type}] \leavevmode +str + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{printcHeader() (in module src.printcolors)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.printcHeader}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{printcHeader}}}{\emph{txt}}{} +print a text header color +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{txt}}) \textendash{} The text to be printed. + +\item[{Returns}] \leavevmode +The colored text. + +\item[{Return type}] \leavevmode +str + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{printcHighlight() (in module src.printcolors)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.printcHighlight}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{printcHighlight}}}{\emph{txt}}{} +print a text highlight color +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{txt}}) \textendash{} The text to be printed. + +\item[{Returns}] \leavevmode +The colored text. + +\item[{Return type}] \leavevmode +str + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{printcInfo() (in module src.printcolors)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.printcInfo}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{printcInfo}}}{\emph{txt}}{} +print a text info color +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{txt}}) \textendash{} The text to be printed. + +\item[{Returns}] \leavevmode +The colored text. + +\item[{Return type}] \leavevmode +str + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{printcLabel() (in module src.printcolors)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.printcLabel}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{printcLabel}}}{\emph{txt}}{} +print a text label color +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{txt}}) \textendash{} The text to be printed. + +\item[{Returns}] \leavevmode +The colored text. + +\item[{Return type}] \leavevmode +str + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{printcSuccess() (in module src.printcolors)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.printcSuccess}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{printcSuccess}}}{\emph{txt}}{} +print a text success color +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{txt}}) \textendash{} The text to be printed. + +\item[{Returns}] \leavevmode +The colored text. + +\item[{Return type}] \leavevmode +str + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{printcWarning() (in module src.printcolors)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.printcolors.printcWarning}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.printcolors.}}\sphinxbfcode{\sphinxupquote{printcWarning}}}{\emph{txt}}{} +print a text warning color +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{txt}}) \textendash{} The text to be printed. + +\item[{Returns}] \leavevmode +The colored text. + +\item[{Return type}] \leavevmode +str + +\end{description}\end{quote} + +\end{fulllineitems} + + + +\subsubsection{\sphinxstyleliteralintitle{\sphinxupquote{product}} Module} +\label{\detokenize{commands/apidoc/src:module-src.product}}\label{\detokenize{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{\detokenize{commands/apidoc/src:src.product.check_config_exists}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{check\_config\_exists}}}{\emph{config}, \emph{prod\_dir}, \emph{prod\_info}}{} +Verify that the installation directory of a product in a base exists +Check all the config-\textless{}i\textgreater{} directory and verify the sat-config.pyconf file +that is in it +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The global configuration + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{prod\_dir}}) \textendash{} The product installation directory path +(without config-\textless{}i\textgreater{}) + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{Config}} \textendash{} The configuration specific to +the product + +\end{itemize} + +\item[{Returns}] \leavevmode +True or false is the installation is found or not +and if it is found, the path of the found installation + +\item[{Return type}] \leavevmode +(boolean, str) + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{check\_installation() (in module src.product)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.product.check_installation}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{check\_installation}}}{\emph{product\_info}}{} +Verify if a product is well installed. Checks install directory presence +and some additional files if it is defined in the config +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to +the product + +\item[{Returns}] \leavevmode +True if it is well installed + +\item[{Return type}] \leavevmode +boolean + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{check\_source() (in module src.product)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.product.check_source}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{check\_source}}}{\emph{product\_info}}{} +Verify if a sources of product is preset. Checks source directory presence +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to +the product + +\item[{Returns}] \leavevmode +True if it is well installed + +\item[{Return type}] \leavevmode +boolean + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{get\_base\_install\_dir() (in module src.product)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.product.get_base_install_dir}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{get\_base\_install\_dir}}}{\emph{config}, \emph{prod\_info}, \emph{version}}{} +Compute the installation directory of a product in base +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The global configuration + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{Config}} \textendash{} The configuration specific to +the product + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{version}}) \textendash{} The version of the product + +\end{itemize} + +\item[{Returns}] \leavevmode +The path of the product installation + +\item[{Return type}] \leavevmode +str + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{get\_install\_dir() (in module src.product)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.product.get_install_dir}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{get\_install\_dir}}}{\emph{config}, \emph{base}, \emph{version}, \emph{prod\_info}}{} +Compute the installation directory of a given product +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The global configuration + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{version}}) \textendash{} This corresponds to the value given by user in its +application.pyconf for the specific product. If “yes”, the +user wants the product to be in base. If “no”, he wants the +product to be in the application workdir + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The version of the product + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{Config}} \textendash{} The configuration specific to +the product + +\end{itemize} + +\item[{Returns}] \leavevmode +The path of the product installation + +\item[{Return type}] \leavevmode +str + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{get\_product\_components() (in module src.product)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.product.get_product_components}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{get\_product\_components}}}{\emph{product\_info}}{} +Get the component list to generate with the product +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to +the product + +\item[{Returns}] \leavevmode +The list of names of the components + +\item[{Return type}] \leavevmode +List + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{get\_product\_config() (in module src.product)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.product.get_product_config}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{get\_product\_config}}}{\emph{config}, \emph{product\_name}, \emph{with\_install\_dir=True}}{} +Get the specific configuration of a product from the global configuration +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} The global configuration + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_name}}) \textendash{} The name of the product + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{boolean}} (\sphinxstyleliteralemphasis{\sphinxupquote{with\_install\_dir}}) \textendash{} If false, do not provide an install +directory (at false only for internal use +of the function check\_config\_exists) + +\end{itemize} + +\item[{Returns}] \leavevmode +the specific configuration of the product + +\item[{Return type}] \leavevmode +{\hyperref[\detokenize{commands/apidoc/src:src.pyconf.Config}]{\sphinxcrossref{Config}}} (\autopageref*{\detokenize{commands/apidoc/src:src.pyconf.Config}}) + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{get\_product\_dependencies() (in module src.product)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.product.get_product_dependencies}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{get\_product\_dependencies}}}{\emph{config}, \emph{product\_info}}{} +Get recursively the list of products that are +in the product\_info dependencies +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The global configuration + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{Config}} \textendash{} The configuration specific to +the product + +\end{itemize} + +\item[{Returns}] \leavevmode +the list of products in dependence + +\item[{Return type}] \leavevmode +list + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{get\_product\_section() (in module src.product)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.product.get_product_section}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{get\_product\_section}}}{\emph{config}, \emph{product\_name}, \emph{version}, \emph{section=None}}{} +Get the product description from the configuration +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} The global configuration + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{section}}) \textendash{} The product name + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The version of the product + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The searched section (if not None, the section is +explicitly given + +\end{itemize} + +\item[{Returns}] \leavevmode +The product description + +\item[{Return type}] \leavevmode +{\hyperref[\detokenize{commands/apidoc/src:src.pyconf.Config}]{\sphinxcrossref{Config}}} (\autopageref*{\detokenize{commands/apidoc/src:src.pyconf.Config}}) + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{get\_products\_infos() (in module src.product)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.product.get_products_infos}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{get\_products\_infos}}}{\emph{lproducts}, \emph{config}}{} +Get the specific configuration of a list of products +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{List}} (\sphinxstyleliteralemphasis{\sphinxupquote{lproducts}}) \textendash{} The list of product names + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{config}}) \textendash{} The global configuration + +\end{itemize} + +\item[{Returns}] \leavevmode +the list of tuples +(product name, specific configuration of the product) + +\item[{Return type}] \leavevmode +{[}(str, {\hyperref[\detokenize{commands/apidoc/src:src.pyconf.Config}]{\sphinxcrossref{Config}}} (\autopageref*{\detokenize{commands/apidoc/src:src.pyconf.Config}})){]} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{product\_compiles() (in module src.product)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_compiles}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_compiles}}}{\emph{product\_info}}{} +Know if a product compiles or not +(some products do not have a compilation procedure) +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to +the product + +\item[{Returns}] \leavevmode +True if the product compiles, else False + +\item[{Return type}] \leavevmode +boolean + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{product\_has\_env\_script() (in module src.product)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_has_env_script}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_has\_env\_script}}}{\emph{product\_info}}{} +Know if a product has an environment script +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to +the product + +\item[{Returns}] \leavevmode +True if the product it has an environment script, else False + +\item[{Return type}] \leavevmode +boolean + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{product\_has\_logo() (in module src.product)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_has_logo}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_has\_logo}}}{\emph{product\_info}}{} +Know if a product has a logo (YACSGEN generate) +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to +the product + +\item[{Returns}] \leavevmode +The path of the logo if the product has a logo, else False + +\item[{Return type}] \leavevmode +Str + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{product\_has\_patches() (in module src.product)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_has_patches}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_has\_patches}}}{\emph{product\_info}}{} +Know if a product has one or more patches +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to +the product + +\item[{Returns}] \leavevmode +True if the product has one or more patches + +\item[{Return type}] \leavevmode +boolean + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{product\_has\_salome\_gui() (in module src.product)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_has_salome_gui}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_has\_salome\_gui}}}{\emph{product\_info}}{} +Know if a product has a SALOME gui +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to +the product + +\item[{Returns}] \leavevmode +True if the product has a SALOME gui, else False + +\item[{Return type}] \leavevmode +Boolean + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{product\_has\_script() (in module src.product)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_has_script}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_has\_script}}}{\emph{product\_info}}{} +Know if a product has a compilation script +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to +the product + +\item[{Returns}] \leavevmode +True if the product it has a compilation script, else False + +\item[{Return type}] \leavevmode +boolean + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{product\_is\_autotools() (in module src.product)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_autotools}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_autotools}}}{\emph{product\_info}}{} +Know if a product is compiled using the autotools +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to +the product + +\item[{Returns}] \leavevmode +True if the product is autotools, else False + +\item[{Return type}] \leavevmode +boolean + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{product\_is\_cmake() (in module src.product)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_cmake}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_cmake}}}{\emph{product\_info}}{} +Know if a product is compiled using the cmake +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to +the product + +\item[{Returns}] \leavevmode +True if the product is cmake, else False + +\item[{Return type}] \leavevmode +boolean + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{product\_is\_cpp() (in module src.product)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_cpp}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_cpp}}}{\emph{product\_info}}{} +Know if a product is cpp +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to +the product + +\item[{Returns}] \leavevmode +True if the product is a cpp, else False + +\item[{Return type}] \leavevmode +boolean + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{product\_is\_debug() (in module src.product)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_debug}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_debug}}}{\emph{product\_info}}{} +Know if a product is in debug mode +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to +the product + +\item[{Returns}] \leavevmode +True if the product is in debug mode, else False + +\item[{Return type}] \leavevmode +boolean + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{product\_is\_dev() (in module src.product)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_dev}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_dev}}}{\emph{product\_info}}{} +Know if a product is in dev mode +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to +the product + +\item[{Returns}] \leavevmode +True if the product is in dev mode, else False + +\item[{Return type}] \leavevmode +boolean + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{product\_is\_fixed() (in module src.product)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_fixed}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_fixed}}}{\emph{product\_info}}{} +Know if a product is fixed +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to +the product + +\item[{Returns}] \leavevmode +True if the product is fixed, else False + +\item[{Return type}] \leavevmode +boolean + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{product\_is\_generated() (in module src.product)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_generated}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_generated}}}{\emph{product\_info}}{} +Know if a product is generated (YACSGEN) +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to +the product + +\item[{Returns}] \leavevmode +True if the product is generated + +\item[{Return type}] \leavevmode +boolean + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{product\_is\_mpi() (in module src.product)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_mpi}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_mpi}}}{\emph{product\_info}}{} +Know if a product has openmpi in its dependencies +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to +the product + +\item[{Returns}] \leavevmode +True if the product has openmpi inits dependencies + +\item[{Return type}] \leavevmode +boolean + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{product\_is\_native() (in module src.product)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_native}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_native}}}{\emph{product\_info}}{} +Know if a product is native +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to +the product + +\item[{Returns}] \leavevmode +True if the product is native, else False + +\item[{Return type}] \leavevmode +boolean + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{product\_is\_salome() (in module src.product)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_salome}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_salome}}}{\emph{product\_info}}{} +Know if a product is a SALOME module +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to +the product + +\item[{Returns}] \leavevmode +True if the product is a SALOME module, else False + +\item[{Return type}] \leavevmode +boolean + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{product\_is\_sample() (in module src.product)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_sample}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_sample}}}{\emph{product\_info}}{} +Know if a product has the sample type +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to +the product + +\item[{Returns}] \leavevmode +True if the product has 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{\detokenize{commands/apidoc/src:src.product.product_is_smesh_plugin}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_smesh\_plugin}}}{\emph{product\_info}}{} +Know if a product is a SMESH plugin +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to +the product + +\item[{Returns}] \leavevmode +True if the product is a SMESH plugin, else False + +\item[{Return type}] \leavevmode +boolean + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{product\_is\_vcs() (in module src.product)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.product.product_is_vcs}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_vcs}}}{\emph{product\_info}}{} +Know if a product is download using git, svn or cvs (not archive) +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{Config}} (\sphinxstyleliteralemphasis{\sphinxupquote{product\_info}}) \textendash{} The configuration specific to +the product + +\item[{Returns}] \leavevmode +True if the product is vcs, else False + +\item[{Return type}] \leavevmode +boolean + +\end{description}\end{quote} + +\end{fulllineitems} + + + +\subsubsection{\sphinxstyleliteralintitle{\sphinxupquote{pyconf}} Module} +\label{\detokenize{commands/apidoc/src:pyconf-module}}\label{\detokenize{commands/apidoc/src:module-src.pyconf}}\index{src.pyconf (module)} +This is a configuration module for Python. + +This module should work under Python versions \textgreater{}= 2.2, and cannot be used with +earlier versions since it uses new-style classes. + +Development and testing has only been carried out (so far) on Python 2.3.4 and +Python 2.4.2. See the test module (test\_config.py) included in the +U\{distribution\textless{}\sphinxurl{http://www.red-dove.com/python\_config}.html\textbar{}\_blank\textgreater{}\} (follow the +download link). + +A simple example - with the example configuration file: + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +messages: +[ + \PYGZob{} + stream : {}`sys.stderr{}` + message: \PYGZsq{}Welcome\PYGZsq{} + name: \PYGZsq{}Harry\PYGZsq{} + \PYGZcb{} + \PYGZob{} + stream : {}`sys.stdout{}` + message: \PYGZsq{}Welkom\PYGZsq{} + name: \PYGZsq{}Ruud\PYGZsq{} + \PYGZcb{} + \PYGZob{} + stream : \PYGZdl{}messages[0].stream + message: \PYGZsq{}Bienvenue\PYGZsq{} + name: Yves + \PYGZcb{} +] +\end{sphinxVerbatim} + +a program to read the configuration would be: + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{k+kn}{from} \PYG{n+nn}{config} \PYG{k}{import} \PYG{n}{Config} + +\PYG{n}{f} \PYG{o}{=} \PYG{n}{file}\PYG{p}{(}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{simple.cfg}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{)} +\PYG{n}{cfg} \PYG{o}{=} \PYG{n}{Config}\PYG{p}{(}\PYG{n}{f}\PYG{p}{)} +\PYG{k}{for} \PYG{n}{m} \PYG{o+ow}{in} \PYG{n}{cfg}\PYG{o}{.}\PYG{n}{messages}\PYG{p}{:} + \PYG{n}{s} \PYG{o}{=} \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+si}{\PYGZpc{}s}\PYG{l+s+s1}{, }\PYG{l+s+si}{\PYGZpc{}s}\PYG{l+s+s1}{\PYGZsq{}} \PYG{o}{\PYGZpc{}} \PYG{p}{(}\PYG{n}{m}\PYG{o}{.}\PYG{n}{message}\PYG{p}{,} \PYG{n}{m}\PYG{o}{.}\PYG{n}{name}\PYG{p}{)} + \PYG{k}{try}\PYG{p}{:} + \PYG{n+nb}{print} \PYG{o}{\PYGZgt{}\PYGZgt{}} \PYG{n}{m}\PYG{o}{.}\PYG{n}{stream}\PYG{p}{,} \PYG{n}{s} + \PYG{k}{except} \PYG{n+ne}{IOError}\PYG{p}{,} \PYG{n}{e}\PYG{p}{:} + \PYG{n+nb}{print} \PYG{n}{e} +\end{sphinxVerbatim} + +which, when run, would yield the console output: + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{n}{Welcome}\PYG{p}{,} \PYG{n}{Harry} +\PYG{n}{Welkom}\PYG{p}{,} \PYG{n}{Ruud} +\PYG{n}{Bienvenue}\PYG{p}{,} \PYG{n}{Yves} +\end{sphinxVerbatim} + +See U\{this tutorial\textless{}\sphinxurl{http://www.red-dove.com/python\_config}.html\textbar{}\_blank\textgreater{}\} for more +information. + +\#modified for salomeTools +@version: 0.3.7.1 + +@author: Vinay Sajip + +@copyright: Copyright (C) 2004-2007 Vinay Sajip. All Rights Reserved. + +@var streamOpener: The default stream opener. This is a factory function which +takes a string (e.g. filename) and returns a stream suitable for reading. If +unable to open the stream, an IOError exception should be thrown. + +The default value of this variable is L\{defaultStreamOpener\}. For an example +of how it’s used, see test\_config.py (search for streamOpener). +\index{Config (class in src.pyconf)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Config}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{Config}}}{\emph{streamOrFile=None}, \emph{parent=None}, \emph{PWD=None}}{} +Bases: {\hyperref[\detokenize{commands/apidoc/src:src.pyconf.Mapping}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.pyconf.Mapping}}}}} (\autopageref*{\detokenize{commands/apidoc/src:src.pyconf.Mapping}}) + +This class represents a configuration, and is the only one which clients +need to interface to, under normal circumstances. +\index{Config.Namespace (class in src.pyconf)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Config.Namespace}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxbfcode{\sphinxupquote{Namespace}}} +Bases: \sphinxcode{\sphinxupquote{object}} + +This internal class is used for implementing default namespaces. + +An instance acts as a namespace. + +\end{fulllineitems} + +\index{addNamespace() (src.pyconf.Config method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Config.addNamespace}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{addNamespace}}}{\emph{ns}, \emph{name=None}}{} +Add a namespace to this configuration which can be used to evaluate +(resolve) dotted-identifier expressions. +@param ns: The namespace to be added. +@type ns: A module or other namespace suitable for passing as an +argument to vars(). +@param name: A name for the namespace, which, if specified, provides +an additional level of indirection. +@type name: str + +\end{fulllineitems} + +\index{getByPath() (src.pyconf.Config method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Config.getByPath}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getByPath}}}{\emph{path}}{} +Obtain a value in the configuration via its path. +@param path: The path of the required value +@type path: str +@return the value at the specified path. +@rtype: any +@raise ConfigError: If the path is invalid + +\end{fulllineitems} + +\index{load() (src.pyconf.Config method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Config.load}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{load}}}{\emph{stream}}{} +Load the configuration from the specified stream. Multiple streams can +be used to populate the same instance, as long as there are no +clashing keys. The stream is closed. +@param stream: A stream from which the configuration is read. +@type stream: A read-only stream (file-like object). +@raise ConfigError: if keys in the loaded configuration clash with +existing keys. +@raise ConfigFormatError: if there is a syntax error in the stream. + +\end{fulllineitems} + +\index{removeNamespace() (src.pyconf.Config method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Config.removeNamespace}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{removeNamespace}}}{\emph{ns}, \emph{name=None}}{} +Remove a namespace added with L\{addNamespace\}. +@param ns: The namespace to be removed. +@param name: The name which was specified when L\{addNamespace\} was +called. +@type name: str + +\end{fulllineitems} + + +\end{fulllineitems} + +\index{ConfigError} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigError}}\pysigline{\sphinxbfcode{\sphinxupquote{exception }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{ConfigError}}} +Bases: \sphinxcode{\sphinxupquote{exceptions.Exception}} + +This is the base class of exceptions raised by this module. + +\end{fulllineitems} + +\index{ConfigFormatError} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigFormatError}}\pysigline{\sphinxbfcode{\sphinxupquote{exception }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{ConfigFormatError}}} +Bases: {\hyperref[\detokenize{commands/apidoc/src:src.pyconf.ConfigError}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.pyconf.ConfigError}}}}} (\autopageref*{\detokenize{commands/apidoc/src:src.pyconf.ConfigError}}) + +This is the base class of exceptions raised due to syntax errors in +configurations. + +\end{fulllineitems} + +\index{ConfigInputStream (class in src.pyconf)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigInputStream}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{ConfigInputStream}}}{\emph{stream}}{} +Bases: \sphinxcode{\sphinxupquote{object}} + +An input stream which can read either ANSI files with default encoding +or Unicode files with BOMs. + +Handles UTF-8, UTF-16LE, UTF-16BE. Could handle UTF-32 if Python had +built-in support. +\index{close() (src.pyconf.ConfigInputStream method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigInputStream.close}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{close}}}{}{} +\end{fulllineitems} + +\index{read() (src.pyconf.ConfigInputStream method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigInputStream.read}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{read}}}{\emph{size}}{} +\end{fulllineitems} + +\index{readline() (src.pyconf.ConfigInputStream method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigInputStream.readline}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{readline}}}{}{} +\end{fulllineitems} + + +\end{fulllineitems} + +\index{ConfigList (class in src.pyconf)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigList}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{ConfigList}}} +Bases: \sphinxcode{\sphinxupquote{list}} + +This class implements an ordered list of configurations and allows you +to try getting the configuration from each entry in turn, returning +the first successfully obtained value. +\index{getByPath() (src.pyconf.ConfigList method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigList.getByPath}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getByPath}}}{\emph{path}}{} +Obtain a value from the first configuration in the list which defines +it. + +@param path: The path of the value to retrieve. +@type path: str +@return: The value from the earliest configuration in the list which +defines it. +@rtype: any +@raise ConfigError: If no configuration in the list has an entry with +the specified path. + +\end{fulllineitems} + + +\end{fulllineitems} + +\index{ConfigMerger (class in src.pyconf)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigMerger}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{ConfigMerger}}}{\emph{resolver=\textless{}function defaultMergeResolve at 0x36fa5f0\textgreater{}}}{} +Bases: \sphinxcode{\sphinxupquote{object}} + +This class is used for merging two configurations. If a key exists in the +merge operand but not the merge target, then the entry is copied from the +merge operand to the merge target. If a key exists in both configurations, +then a resolver (a callable) is called to decide how to handle the +conflict. +\index{handleMismatch() (src.pyconf.ConfigMerger method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigMerger.handleMismatch}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{handleMismatch}}}{\emph{obj1}, \emph{obj2}}{} +Handle a mismatch between two objects. + +@param obj1: The object to merge into. +@type obj1: any +@param obj2: The object to merge. +@type obj2: any + +\end{fulllineitems} + +\index{merge() (src.pyconf.ConfigMerger method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigMerger.merge}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{merge}}}{\emph{merged}, \emph{mergee}}{} +Merge two configurations. The second configuration is unchanged, +and the first is changed to reflect the results of the merge. + +@param merged: The configuration to merge into. +@type merged: L\{Config\}. +@param mergee: The configuration to merge. +@type mergee: L\{Config\}. + +\end{fulllineitems} + +\index{mergeMapping() (src.pyconf.ConfigMerger method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigMerger.mergeMapping}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{mergeMapping}}}{\emph{map1}, \emph{map2}}{} +Merge two mappings recursively. The second mapping is unchanged, +and the first is changed to reflect the results of the merge. + +@param map1: The mapping to merge into. +@type map1: L\{Mapping\}. +@param map2: The mapping to merge. +@type map2: L\{Mapping\}. + +\end{fulllineitems} + +\index{mergeSequence() (src.pyconf.ConfigMerger method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigMerger.mergeSequence}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{mergeSequence}}}{\emph{seq1}, \emph{seq2}}{} +Merge two sequences. The second sequence is unchanged, +and the first is changed to have the elements of the second +appended to it. + +@param seq1: The sequence to merge into. +@type seq1: L\{Sequence\}. +@param seq2: The sequence to merge. +@type seq2: L\{Sequence\}. + +\end{fulllineitems} + +\index{overwriteKeys() (src.pyconf.ConfigMerger method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigMerger.overwriteKeys}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{overwriteKeys}}}{\emph{map1}, \emph{seq2}}{} +Renint variables. The second mapping is unchanged, +and the first is changed depending the keys of the second mapping. +@param map1: The mapping to reinit keys into. +@type map1: L\{Mapping\}. +@param map2: The mapping container reinit information. +@type map2: L\{Mapping\}. + +\end{fulllineitems} + + +\end{fulllineitems} + +\index{ConfigOutputStream (class in src.pyconf)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigOutputStream}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{ConfigOutputStream}}}{\emph{stream}, \emph{encoding=None}}{} +Bases: \sphinxcode{\sphinxupquote{object}} + +An output stream which can write either ANSI files with default encoding +or Unicode files with BOMs. + +Handles UTF-8, UTF-16LE, UTF-16BE. Could handle UTF-32 if Python had +built-in support. +\index{close() (src.pyconf.ConfigOutputStream method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigOutputStream.close}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{close}}}{}{} +\end{fulllineitems} + +\index{flush() (src.pyconf.ConfigOutputStream method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigOutputStream.flush}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{flush}}}{}{} +\end{fulllineitems} + +\index{write() (src.pyconf.ConfigOutputStream method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigOutputStream.write}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write}}}{\emph{data}}{} +\end{fulllineitems} + + +\end{fulllineitems} + +\index{ConfigReader (class in src.pyconf)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{ConfigReader}}}{\emph{config}}{} +Bases: \sphinxcode{\sphinxupquote{object}} + +This internal class implements a parser for configurations. +\index{getChar() (src.pyconf.ConfigReader method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.getChar}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getChar}}}{}{} +Get the next char from the stream. Update line and column numbers +appropriately. + +@return: The next character from the stream. +@rtype: str + +\end{fulllineitems} + +\index{getToken() (src.pyconf.ConfigReader method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.getToken}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getToken}}}{}{} +Get a token from the stream. String values are returned in a form +where you need to eval() the returned value to get the actual +string. The return value is (token\_type, token\_value). + +Multiline string tokenizing is thanks to David Janes (BlogMatrix) + +@return: The next token. +@rtype: A token tuple. + +\end{fulllineitems} + +\index{load() (src.pyconf.ConfigReader method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.load}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{load}}}{\emph{stream}, \emph{parent=None}, \emph{suffix=None}}{} +Load the configuration from the specified stream. + +@param stream: A stream from which to load the configuration. +@type stream: A stream (file-like object). +@param parent: The parent of the configuration (to which this reader +belongs) in the hierarchy. Specified when the configuration is +included in another one. +@type parent: A L\{Container\} instance. +@param suffix: The suffix of this configuration in the parent +configuration. Should be specified whenever the parent is not None. +@raise ConfigError: If parent is specified but suffix is not. +@raise ConfigFormatError: If there are syntax errors in the stream. + +\end{fulllineitems} + +\index{location() (src.pyconf.ConfigReader method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.location}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{location}}}{}{} +Return the current location (filename, line, column) in the stream +as a string. + +Used when printing error messages, + +@return: A string representing a location in the stream being read. +@rtype: str + +\end{fulllineitems} + +\index{match() (src.pyconf.ConfigReader method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.match}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{match}}}{\emph{t}}{} +Ensure that the current token type matches the specified value, and +advance to the next token. + +@param t: The token type to match. +@type t: A valid token type. +@return: The token which was last read from the stream before this +function is called. +@rtype: a token tuple - see L\{getToken\}. +@raise ConfigFormatError: If the token does not match what’s expected. + +\end{fulllineitems} + +\index{parseFactor() (src.pyconf.ConfigReader method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseFactor}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseFactor}}}{}{} +Parse a factor in an multiplicative expression (a * b, a / b, a \% b) + +@return: the parsed factor +@rtype: any scalar +@raise ConfigFormatError: if a syntax error is found. + +\end{fulllineitems} + +\index{parseKeyValuePair() (src.pyconf.ConfigReader method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseKeyValuePair}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseKeyValuePair}}}{\emph{parent}}{} +Parse a key-value pair, and add it to the provided L\{Mapping\}. + +@param parent: The mapping to add entries to. +@type parent: A L\{Mapping\} instance. +@raise ConfigFormatError: if a syntax error is found. + +\end{fulllineitems} + +\index{parseMapping() (src.pyconf.ConfigReader method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseMapping}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseMapping}}}{\emph{parent}, \emph{suffix}}{} +Parse a mapping. + +@param parent: The container to which the mapping will be added. +@type parent: A L\{Container\} instance. +@param suffix: The suffix for the value. +@type suffix: str +@return: a L\{Mapping\} instance representing the mapping. +@rtype: L\{Mapping\} +@raise ConfigFormatError: if a syntax error is found. + +\end{fulllineitems} + +\index{parseMappingBody() (src.pyconf.ConfigReader method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseMappingBody}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseMappingBody}}}{\emph{parent}}{} +Parse the internals of a mapping, and add entries to the provided +L\{Mapping\}. + +@param parent: The mapping to add entries to. +@type parent: A L\{Mapping\} instance. + +\end{fulllineitems} + +\index{parseReference() (src.pyconf.ConfigReader method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseReference}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseReference}}}{\emph{type}}{} +Parse a reference. + +@return: the parsed reference +@rtype: L\{Reference\} +@raise ConfigFormatError: if a syntax error is found. + +\end{fulllineitems} + +\index{parseScalar() (src.pyconf.ConfigReader method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseScalar}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseScalar}}}{}{} +Parse a scalar - a terminal value such as a string or number, or +an L\{Expression\} or L\{Reference\}. + +@return: the parsed scalar +@rtype: any scalar +@raise ConfigFormatError: if a syntax error is found. + +\end{fulllineitems} + +\index{parseSequence() (src.pyconf.ConfigReader method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseSequence}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseSequence}}}{\emph{parent}, \emph{suffix}}{} +Parse a sequence. + +@param parent: The container to which the sequence will be added. +@type parent: A L\{Container\} instance. +@param suffix: The suffix for the value. +@type suffix: str +@return: a L\{Sequence\} instance representing the sequence. +@rtype: L\{Sequence\} +@raise ConfigFormatError: if a syntax error is found. + +\end{fulllineitems} + +\index{parseSuffix() (src.pyconf.ConfigReader method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseSuffix}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseSuffix}}}{\emph{ref}}{} +Parse a reference suffix. + +@param ref: The reference of which this suffix is a part. +@type ref: L\{Reference\}. +@raise ConfigFormatError: if a syntax error is found. + +\end{fulllineitems} + +\index{parseTerm() (src.pyconf.ConfigReader method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseTerm}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseTerm}}}{}{} +Parse a term in an additive expression (a + b, a - b) + +@return: the parsed term +@rtype: any scalar +@raise ConfigFormatError: if a syntax error is found. + +\end{fulllineitems} + +\index{parseValue() (src.pyconf.ConfigReader method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.parseValue}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseValue}}}{\emph{parent}, \emph{suffix}}{} +Parse a value. + +@param parent: The container to which the value will be added. +@type parent: A L\{Container\} instance. +@param suffix: The suffix for the value. +@type suffix: str +@return: The value +@rtype: any +@raise ConfigFormatError: if a syntax error is found. + +\end{fulllineitems} + +\index{setStream() (src.pyconf.ConfigReader method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigReader.setStream}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{setStream}}}{\emph{stream}}{} +Set the stream to the specified value, and prepare to read from it. + +@param stream: A stream from which to load the configuration. +@type stream: A stream (file-like object). + +\end{fulllineitems} + + +\end{fulllineitems} + +\index{ConfigResolutionError} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.ConfigResolutionError}}\pysigline{\sphinxbfcode{\sphinxupquote{exception }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{ConfigResolutionError}}} +Bases: {\hyperref[\detokenize{commands/apidoc/src:src.pyconf.ConfigError}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.pyconf.ConfigError}}}}} (\autopageref*{\detokenize{commands/apidoc/src:src.pyconf.ConfigError}}) + +This is the base class of exceptions raised due to semantic errors in +configurations. + +\end{fulllineitems} + +\index{Container (class in src.pyconf)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Container}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{Container}}}{\emph{parent}}{} +Bases: \sphinxcode{\sphinxupquote{object}} + +This internal class is the base class for mappings and sequences. + +@ivar path: A string which describes how to get +to this instance from the root of the hierarchy. + +Example: + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{n}{a}\PYG{o}{.}\PYG{n}{list}\PYG{o}{.}\PYG{n}{of}\PYG{p}{[}\PYG{l+m+mi}{1}\PYG{p}{]}\PYG{o}{.}\PYG{o+ow}{or}\PYG{p}{[}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{more}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{]}\PYG{o}{.}\PYG{n}{elements} +\end{sphinxVerbatim} +\index{evaluate() (src.pyconf.Container method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Container.evaluate}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{evaluate}}}{\emph{item}}{} +Evaluate items which are instances of L\{Reference\} or L\{Expression\}. + +L\{Reference\} instances are evaluated using L\{Reference.resolve\}, +and L\{Expression\} instances are evaluated using +L\{Expression.evaluate\}. + +@param item: The item to be evaluated. +@type item: any +@return: If the item is an instance of L\{Reference\} or L\{Expression\}, +the evaluated value is returned, otherwise the item is returned +unchanged. + +\end{fulllineitems} + +\index{setPath() (src.pyconf.Container method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Container.setPath}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{setPath}}}{\emph{path}}{} +Set the path for this instance. +@param path: The path - a string which describes how to get +to this instance from the root of the hierarchy. +@type path: str + +\end{fulllineitems} + +\index{writeToStream() (src.pyconf.Container method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Container.writeToStream}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{writeToStream}}}{\emph{stream}, \emph{indent}, \emph{container}}{} +Write this instance to a stream at the specified indentation level. + +Should be redefined in subclasses. + +@param stream: The stream to write to +@type stream: A writable stream (file-like object) +@param indent: The indentation level +@type indent: int +@param container: The container of this instance +@type container: L\{Container\} +@raise NotImplementedError: If a subclass does not override this + +\end{fulllineitems} + +\index{writeValue() (src.pyconf.Container method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Container.writeValue}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{writeValue}}}{\emph{value}, \emph{stream}, \emph{indent}}{} +\end{fulllineitems} + + +\end{fulllineitems} + +\index{Expression (class in src.pyconf)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Expression}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{Expression}}}{\emph{op}, \emph{lhs}, \emph{rhs}}{} +Bases: \sphinxcode{\sphinxupquote{object}} + +This internal class implements a value which is obtained by evaluating an expression. +\index{evaluate() (src.pyconf.Expression method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Expression.evaluate}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{evaluate}}}{\emph{container}}{} +Evaluate this instance in the context of a container. + +@param container: The container to evaluate in from. +@type container: L\{Container\} +@return: The evaluated value. +@rtype: any +@raise ConfigResolutionError: If evaluation fails. +@raise ZeroDivideError: If division by zero occurs. +@raise TypeError: If the operation is invalid, e.g. +subtracting one string from another. + +\end{fulllineitems} + + +\end{fulllineitems} + +\index{Mapping (class in src.pyconf)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Mapping}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{Mapping}}}{\emph{parent=None}}{} +Bases: {\hyperref[\detokenize{commands/apidoc/src:src.pyconf.Container}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.pyconf.Container}}}}} (\autopageref*{\detokenize{commands/apidoc/src:src.pyconf.Container}}) + +This internal class implements key-value mappings in configurations. +\index{addMapping() (src.pyconf.Mapping method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Mapping.addMapping}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{addMapping}}}{\emph{key}, \emph{value}, \emph{comment}, \emph{setting=False}}{} +Add a key-value mapping with a comment. + +@param key: The key for the mapping. +@type key: str +@param value: The value for the mapping. +@type value: any +@param comment: The comment for the key (can be None). +@type comment: str +@param setting: If True, ignore clashes. This is set +to true when called from L\{\_\_setattr\_\_\}. +@raise ConfigFormatError: If an existing key is seen +again and setting is False. + +\end{fulllineitems} + +\index{get() (src.pyconf.Mapping method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Mapping.get}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get}}}{\emph{key}, \emph{default=None}}{} +Allows a dictionary-style get operation. + +\end{fulllineitems} + +\index{iteritems() (src.pyconf.Mapping method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Mapping.iteritems}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{iteritems}}}{}{} +\end{fulllineitems} + +\index{iterkeys() (src.pyconf.Mapping method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Mapping.iterkeys}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{iterkeys}}}{}{} +\end{fulllineitems} + +\index{keys() (src.pyconf.Mapping method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Mapping.keys}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{keys}}}{}{} +Return the keys in a similar way to a dictionary. + +\end{fulllineitems} + +\index{writeToStream() (src.pyconf.Mapping method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Mapping.writeToStream}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{writeToStream}}}{\emph{stream}, \emph{indent}, \emph{container}}{} +Write this instance to a stream at the specified indentation level. + +Should be redefined in subclasses. + +@param stream: The stream to write to +@type stream: A writable stream (file-like object) +@param indent: The indentation level +@type indent: int +@param container: The container of this instance +@type container: L\{Container\} + +\end{fulllineitems} + + +\end{fulllineitems} + +\index{Reference (class in src.pyconf)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Reference}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{Reference}}}{\emph{config}, \emph{type}, \emph{ident}}{} +Bases: \sphinxcode{\sphinxupquote{object}} + +This internal class implements a value which is a reference to another value. +\index{addElement() (src.pyconf.Reference method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Reference.addElement}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{addElement}}}{\emph{type}, \emph{ident}}{} +Add an element to the reference. + +@param type: The type of reference. +@type type: BACKTICK or DOLLAR +@param ident: The identifier which continues the reference. +@type ident: str + +\end{fulllineitems} + +\index{findConfig() (src.pyconf.Reference method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Reference.findConfig}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{findConfig}}}{\emph{container}}{} +Find the closest enclosing configuration to the specified container. + +@param container: The container to start from. +@type container: L\{Container\} +@return: The closest enclosing configuration, or None. +@rtype: L\{Config\} + +\end{fulllineitems} + +\index{resolve() (src.pyconf.Reference method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Reference.resolve}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{resolve}}}{\emph{container}}{} +Resolve this instance in the context of a container. + +@param container: The container to resolve from. +@type container: L\{Container\} +@return: The resolved value. +@rtype: any +@raise ConfigResolutionError: If resolution fails. + +\end{fulllineitems} + + +\end{fulllineitems} + +\index{Sequence (class in src.pyconf)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Sequence}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{Sequence}}}{\emph{parent=None}}{} +Bases: {\hyperref[\detokenize{commands/apidoc/src:src.pyconf.Container}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.pyconf.Container}}}}} (\autopageref*{\detokenize{commands/apidoc/src:src.pyconf.Container}}) + +This internal class implements a value which is a sequence of other values. +\index{Sequence.SeqIter (class in src.pyconf)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Sequence.SeqIter}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxbfcode{\sphinxupquote{SeqIter}}}{\emph{seq}}{} +Bases: \sphinxcode{\sphinxupquote{object}} + +This internal class implements an iterator for a L\{Sequence\} instance. +\index{next() (src.pyconf.Sequence.SeqIter method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Sequence.SeqIter.next}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{next}}}{}{} +\end{fulllineitems} + + +\end{fulllineitems} + +\index{append() (src.pyconf.Sequence method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Sequence.append}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append}}}{\emph{item}, \emph{comment}}{} +Add an item to the sequence. + +@param item: The item to add. +@type item: any +@param comment: A comment for the item. +@type comment: str + +\end{fulllineitems} + +\index{writeToStream() (src.pyconf.Sequence method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.Sequence.writeToStream}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{writeToStream}}}{\emph{stream}, \emph{indent}, \emph{container}}{} +Write this instance to a stream at the specified indentation level. + +Should be redefined in subclasses. + +@param stream: The stream to write to +@type stream: A writable stream (file-like object) +@param indent: The indentation level +@type indent: int +@param container: The container of this instance +@type container: L\{Container\} + +\end{fulllineitems} + + +\end{fulllineitems} + +\index{deepCopyMapping() (in module src.pyconf)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.deepCopyMapping}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{deepCopyMapping}}}{\emph{inMapping}}{} +\end{fulllineitems} + +\index{defaultMergeResolve() (in module src.pyconf)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.defaultMergeResolve}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{defaultMergeResolve}}}{\emph{map1}, \emph{map2}, \emph{key}}{} +A default resolver for merge conflicts. +Returns a string indicating what action to take to resolve the conflict. + +@param map1: The map being merged into. +@type map1: L\{Mapping\}. +@param map2: The map being used as the merge operand. +@type map2: L\{Mapping\}. +@param key: The key in map2 (which also exists in map1). +@type key: str +\begin{description} +\item[{@return: One of “merge”, “append”, “mismatch” or “overwrite”}] \leavevmode +indicating what action should be taken. This should +be appropriate to the objects being merged - e.g. +there is no point returning “merge” if the two objects +are instances of L\{Sequence\}. + +\end{description} + +@rtype: str + +\end{fulllineitems} + +\index{defaultStreamOpener() (in module src.pyconf)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.defaultStreamOpener}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{defaultStreamOpener}}}{\emph{name}}{} +This function returns a read-only stream, given its name. The name passed +in should correspond to an existing stream, otherwise an exception will be +raised. + +This is the default value of L\{streamOpener\}; assign your own callable to +streamOpener to return streams based on names. For example, you could use +urllib2.urlopen(). + +@param name: The name of a stream, most commonly a file name. +@type name: str +@return: A stream with the specified name. +@rtype: A read-only stream (file-like object) + +\end{fulllineitems} + +\index{isWord() (in module src.pyconf)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.isWord}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{isWord}}}{\emph{s}}{} +See if a passed-in value is an identifier. If the value passed in is not a +string, False is returned. An identifier consists of alphanumerics or +underscore characters. + +Examples: + +\fvset{hllines={, ,}}% +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{n}{isWord}\PYG{p}{(}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{a word}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{)} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZgt{}}\PYG{k+kc}{False} +\PYG{n}{isWord}\PYG{p}{(}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{award}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{)} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZgt{}} \PYG{k+kc}{True} +\PYG{n}{isWord}\PYG{p}{(}\PYG{l+m+mi}{9}\PYG{p}{)} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZgt{}} \PYG{k+kc}{False} +\PYG{n}{isWord}\PYG{p}{(}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{a\PYGZus{}b\PYGZus{}c\PYGZus{}}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{)} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZgt{}}\PYG{k+kc}{True} +\end{sphinxVerbatim} + +@note: isWord(‘9abc’) will return True - not exactly correct, but adequate +for the way it’s used here. + +@param s: The name to be tested +@type s: any +@return: True if a word, else False +@rtype: bool + +\end{fulllineitems} + +\index{makePath() (in module src.pyconf)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.makePath}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{makePath}}}{\emph{prefix}, \emph{suffix}}{} +Make a path from a prefix and suffix. + +Examples: +makePath(‘’, ‘suffix’) -\textgreater{} ‘suffix’ +makePath(‘prefix’, ‘suffix’) -\textgreater{} ‘prefix.suffix’ +makePath(‘prefix’, ‘{[}1{]}’) -\textgreater{} ‘prefix{[}1{]}’ + +@param prefix: The prefix to use. If it evaluates as false, the suffix is returned. +@type prefix: str +@param suffix: The suffix to use. It is either an identifier or an index in brackets. +@type suffix: str +@return: The path concatenation of prefix and suffix, with adot if the suffix is not a bracketed index. +@rtype: str + +\end{fulllineitems} + +\index{overwriteMergeResolve() (in module src.pyconf)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.pyconf.overwriteMergeResolve}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{overwriteMergeResolve}}}{\emph{map1}, \emph{map2}, \emph{key}}{} +An overwriting resolver for merge conflicts. Calls L\{defaultMergeResolve\}, +but where a “mismatch” is detected, returns “overwrite” instead. + +@param map1: The map being merged into. +@type map1: L\{Mapping\}. +@param map2: The map being used as the merge operand. +@type map2: L\{Mapping\}. +@param key: The key in map2 (which also exists in map1). +@type key: str + +\end{fulllineitems} + + + +\subsubsection{\sphinxstyleliteralintitle{\sphinxupquote{system}} Module} +\label{\detokenize{commands/apidoc/src:system-module}}\label{\detokenize{commands/apidoc/src:module-src.system}}\index{src.system (module)} +In this file : all functions that do a system call, +like open a browser or an editor, or call a git command +\index{archive\_extract() (in module src.system)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.system.archive_extract}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.system.}}\sphinxbfcode{\sphinxupquote{archive\_extract}}}{\emph{from\_what}, \emph{where}, \emph{logger}}{} +Extracts sources from an archive. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{where}}) \textendash{} The path to the archive. + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The path where to extract. + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to use. + +\end{itemize} + +\item[{Returns}] \leavevmode +True if the extraction is successful + +\item[{Return type}] \leavevmode +boolean + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{cvs\_extract() (in module src.system)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.system.cvs_extract}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.system.}}\sphinxbfcode{\sphinxupquote{cvs\_extract}}}{\emph{protocol}, \emph{user}, \emph{server}, \emph{base}, \emph{tag}, \emph{product}, \emph{where}, \emph{logger}, \emph{checkout=False}, \emph{environment=None}}{} +Extracts sources from a cvs repository. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{where}}) \textendash{} The cvs protocol. + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The user to be used. + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The remote cvs server. + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} +. + + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The tag. + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The product. + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The path where to extract. + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to use. + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{boolean}} (\sphinxstyleliteralemphasis{\sphinxupquote{checkout}}) \textendash{} If true use checkout cvs. + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{src.environment.Environ}} (\sphinxstyleliteralemphasis{\sphinxupquote{environment}}) \textendash{} The environment to source when +extracting. + +\end{itemize} + +\item[{Returns}] \leavevmode +True if the extraction is successful + +\item[{Return type}] \leavevmode +boolean + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{git\_extract() (in module src.system)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.system.git_extract}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.system.}}\sphinxbfcode{\sphinxupquote{git\_extract}}}{\emph{from\_what}, \emph{tag}, \emph{where}, \emph{logger}, \emph{environment=None}}{} +Extracts sources from a git repository. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{where}}) \textendash{} The remote git repository. + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The tag. + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The path where to extract. + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to use. + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{src.environment.Environ}} (\sphinxstyleliteralemphasis{\sphinxupquote{environment}}) \textendash{} The environment to source when +extracting. + +\end{itemize} + +\item[{Returns}] \leavevmode +True if the extraction is successful + +\item[{Return type}] \leavevmode +boolean + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{show\_in\_editor() (in module src.system)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.system.show_in_editor}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.system.}}\sphinxbfcode{\sphinxupquote{show\_in\_editor}}}{\emph{editor}, \emph{filePath}, \emph{logger}}{} +open filePath using editor. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{filePath}}) \textendash{} The editor to use. + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The path to the file to open. + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{svn\_extract() (in module src.system)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.system.svn_extract}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.system.}}\sphinxbfcode{\sphinxupquote{svn\_extract}}}{\emph{user}, \emph{from\_what}, \emph{tag}, \emph{where}, \emph{logger}, \emph{checkout=False}, \emph{environment=None}}{} +Extracts sources from a svn repository. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{where}}) \textendash{} The user to be used. + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The remote git repository. + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The tag. + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The path where to extract. + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} The logger instance to use. + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{boolean}} (\sphinxstyleliteralemphasis{\sphinxupquote{checkout}}) \textendash{} If true use checkout svn. + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{src.environment.Environ}} (\sphinxstyleliteralemphasis{\sphinxupquote{environment}}) \textendash{} The environment to source when +extracting. + +\end{itemize} + +\item[{Returns}] \leavevmode +True if the extraction is successful + +\item[{Return type}] \leavevmode +boolean + +\end{description}\end{quote} + +\end{fulllineitems} + + + +\subsubsection{\sphinxstyleliteralintitle{\sphinxupquote{template}} Module} +\label{\detokenize{commands/apidoc/src:template-module}}\label{\detokenize{commands/apidoc/src:module-src.template}}\index{src.template (module)}\index{MyTemplate (class in src.template)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.template.MyTemplate}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.template.}}\sphinxbfcode{\sphinxupquote{MyTemplate}}}{\emph{template}}{} +Bases: \sphinxcode{\sphinxupquote{string.Template}} +\index{delimiter (src.template.MyTemplate attribute)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.template.MyTemplate.delimiter}}\pysigline{\sphinxbfcode{\sphinxupquote{delimiter}}\sphinxbfcode{\sphinxupquote{ = '\textbackslash{}xc2\textbackslash{}xa4'}}} +\end{fulllineitems} + +\index{pattern (src.template.MyTemplate attribute)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.template.MyTemplate.pattern}}\pysigline{\sphinxbfcode{\sphinxupquote{pattern}}\sphinxbfcode{\sphinxupquote{ = \textless{}\_sre.SRE\_Pattern object at 0x37f8420\textgreater{}}}} +\end{fulllineitems} + + +\end{fulllineitems} + +\index{substitute() (in module src.template)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.template.substitute}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.template.}}\sphinxbfcode{\sphinxupquote{substitute}}}{\emph{template\_file}, \emph{subst\_dic}}{} +\end{fulllineitems} + + + +\subsubsection{\sphinxstyleliteralintitle{\sphinxupquote{test\_module}} Module} +\label{\detokenize{commands/apidoc/src:module-src.test_module}}\label{\detokenize{commands/apidoc/src:test-module-module}}\index{src.test\_module (module)}\index{Test (class in src.test\_module)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.test\_module.}}\sphinxbfcode{\sphinxupquote{Test}}}{\emph{config}, \emph{logger}, \emph{tmp\_working\_dir}, \emph{testbase=''}, \emph{grids=None}, \emph{sessions=None}, \emph{launcher=''}, \emph{show\_desktop=True}}{}~\index{generate\_launching\_commands() (src.test\_module.Test method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.generate_launching_commands}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{generate\_launching\_commands}}}{}{} +\end{fulllineitems} + +\index{generate\_script() (src.test\_module.Test method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.generate_script}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{generate\_script}}}{\emph{listTest}, \emph{script\_path}, \emph{ignoreList}}{} +\end{fulllineitems} + +\index{get\_test\_timeout() (src.test\_module.Test method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.get_test_timeout}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_test\_timeout}}}{\emph{test\_name}, \emph{default\_value}}{} +\end{fulllineitems} + +\index{get\_tmp\_dir() (src.test\_module.Test method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.get_tmp_dir}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_tmp\_dir}}}{}{} +\end{fulllineitems} + +\index{prepare\_testbase() (src.test\_module.Test method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.prepare_testbase}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepare\_testbase}}}{\emph{test\_base\_name}}{} +\end{fulllineitems} + +\index{prepare\_testbase\_from\_dir() (src.test\_module.Test method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.prepare_testbase_from_dir}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepare\_testbase\_from\_dir}}}{\emph{testbase\_name}, \emph{testbase\_dir}}{} +\end{fulllineitems} + +\index{prepare\_testbase\_from\_git() (src.test\_module.Test method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.prepare_testbase_from_git}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepare\_testbase\_from\_git}}}{\emph{testbase\_name}, \emph{testbase\_base}, \emph{testbase\_tag}}{} +\end{fulllineitems} + +\index{prepare\_testbase\_from\_svn() (src.test\_module.Test method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.prepare_testbase_from_svn}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepare\_testbase\_from\_svn}}}{\emph{user}, \emph{testbase\_name}, \emph{testbase\_base}}{} +\end{fulllineitems} + +\index{read\_results() (src.test\_module.Test method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.read_results}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{read\_results}}}{\emph{listTest}, \emph{has\_timed\_out}}{} +\end{fulllineitems} + +\index{run\_all\_tests() (src.test\_module.Test method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.run_all_tests}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run\_all\_tests}}}{}{} +\end{fulllineitems} + +\index{run\_grid\_tests() (src.test\_module.Test method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.run_grid_tests}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run\_grid\_tests}}}{}{} +\end{fulllineitems} + +\index{run\_script() (src.test\_module.Test method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.run_script}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run\_script}}}{\emph{script\_name}}{} +\end{fulllineitems} + +\index{run\_session\_tests() (src.test\_module.Test method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.run_session_tests}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run\_session\_tests}}}{}{} +\end{fulllineitems} + +\index{run\_testbase\_tests() (src.test\_module.Test method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.run_testbase_tests}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run\_testbase\_tests}}}{}{} +\end{fulllineitems} + +\index{run\_tests() (src.test\_module.Test method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.run_tests}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run\_tests}}}{\emph{listTest}, \emph{ignoreList}}{} +\end{fulllineitems} + +\index{search\_known\_errors() (src.test\_module.Test method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.search_known_errors}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{search\_known\_errors}}}{\emph{status}, \emph{test\_grid}, \emph{test\_session}, \emph{test}}{} +\end{fulllineitems} + +\index{write\_test\_margin() (src.test\_module.Test method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.Test.write_test_margin}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write\_test\_margin}}}{\emph{tab}}{} +\end{fulllineitems} + + +\end{fulllineitems} + +\index{getTmpDirDEFAULT() (in module src.test\_module)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.test_module.getTmpDirDEFAULT}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.test\_module.}}\sphinxbfcode{\sphinxupquote{getTmpDirDEFAULT}}}{}{} +\end{fulllineitems} + + + +\subsubsection{\sphinxstyleliteralintitle{\sphinxupquote{xmlManager}} Module} +\label{\detokenize{commands/apidoc/src:xmlmanager-module}}\label{\detokenize{commands/apidoc/src:module-src.xmlManager}}\index{src.xmlManager (module)}\index{ReadXmlFile (class in src.xmlManager)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.ReadXmlFile}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.xmlManager.}}\sphinxbfcode{\sphinxupquote{ReadXmlFile}}}{\emph{filePath}}{} +Bases: \sphinxcode{\sphinxupquote{object}} + +Class to manage reading of an xml log file +\index{getRootAttrib() (src.xmlManager.ReadXmlFile method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.ReadXmlFile.getRootAttrib}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getRootAttrib}}}{}{} +Get the attibutes of the self.xmlroot +\begin{quote}\begin{description} +\item[{Returns}] \leavevmode +The attributes of the root node + +\item[{Return type}] \leavevmode +dict + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{get\_attrib() (src.xmlManager.ReadXmlFile method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.ReadXmlFile.get_attrib}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_attrib}}}{\emph{node\_name}}{} +Get the attibutes of the node node\_name in self.xmlroot +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{node\_name}}) \textendash{} the name of the node + +\item[{Returns}] \leavevmode +the attibutes of the node node\_name in self.xmlroot + +\item[{Return type}] \leavevmode +dict + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{get\_node\_text() (src.xmlManager.ReadXmlFile method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.ReadXmlFile.get_node_text}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_node\_text}}}{\emph{node}}{}~\begin{description} +\item[{Get the text of the first node that has name }] \leavevmode +that corresponds to the parameter node + +\end{description} +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{node}}) \textendash{} the name of the node from which get the text + +\item[{Returns}] \leavevmode +the text of the first node that has name +that corresponds to the parameter node + +\item[{Return type}] \leavevmode +str + +\end{description}\end{quote} + +\end{fulllineitems} + + +\end{fulllineitems} + +\index{XmlLogFile (class in src.xmlManager)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.XmlLogFile}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.xmlManager.}}\sphinxbfcode{\sphinxupquote{XmlLogFile}}}{\emph{filePath}, \emph{rootname}, \emph{attrib=\{\}}}{} +Bases: \sphinxcode{\sphinxupquote{object}} + +Class to manage writing in salomeTools xml log file +\index{add\_simple\_node() (src.xmlManager.XmlLogFile method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.XmlLogFile.add_simple_node}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_simple\_node}}}{\emph{node\_name}, \emph{text=None}, \emph{attrib=\{\}}}{} +Add a node with some attibutes and text to the root node. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{text}}) \textendash{} the name of the node to add + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the text of the node + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{dict}} (\sphinxstyleliteralemphasis{\sphinxupquote{attrib}}) \textendash{} the dictionary containing the +attribute of the new node + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{append\_node\_attrib() (src.xmlManager.XmlLogFile method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.XmlLogFile.append_node_attrib}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append\_node\_attrib}}}{\emph{node\_name}, \emph{attrib}}{} +Append a new attributes to the node that has node\_name as name +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{node\_name}}) \textendash{} The name of the node on which append text + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{dixt}} (\sphinxstyleliteralemphasis{\sphinxupquote{attrib}}) \textendash{} The attrib to append + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{append\_node\_text() (src.xmlManager.XmlLogFile method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.XmlLogFile.append_node_text}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append\_node\_text}}}{\emph{node\_name}, \emph{text}}{} +Append a new text to the node that has node\_name as name +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{text}}) \textendash{} The name of the node on which append text + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The text to append + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{write\_tree() (src.xmlManager.XmlLogFile method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.XmlLogFile.write_tree}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write\_tree}}}{\emph{stylesheet=None}, \emph{file\_path=None}}{} +Write the xml tree in the log file path. Add the stylesheet if asked. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{stylesheet}}) \textendash{} The stylesheet to apply to the xml file + +\end{description}\end{quote} + +\end{fulllineitems} + + +\end{fulllineitems} + +\index{add\_simple\_node() (in module src.xmlManager)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.add_simple_node}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.xmlManager.}}\sphinxbfcode{\sphinxupquote{add\_simple\_node}}}{\emph{root\_node}, \emph{node\_name}, \emph{text=None}, \emph{attrib=\{\}}}{} +Add a node with some attibutes and text to the root node. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{etree.Element}} (\sphinxstyleliteralemphasis{\sphinxupquote{root\_node}}) \textendash{} the Etree element where to add the new node + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{text}}) \textendash{} the name of the node to add + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the text of the node + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{dict}} (\sphinxstyleliteralemphasis{\sphinxupquote{attrib}}) \textendash{} the dictionary containing the +attribute of the new node + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{append\_node\_attrib() (in module src.xmlManager)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.append_node_attrib}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.xmlManager.}}\sphinxbfcode{\sphinxupquote{append\_node\_attrib}}}{\emph{root\_node}, \emph{attrib}}{} +Append a new attributes to the node that has node\_name as name +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{etree.Element}} (\sphinxstyleliteralemphasis{\sphinxupquote{root\_node}}) \textendash{} the Etree element +where to append the new attibutes + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{dixt}} (\sphinxstyleliteralemphasis{\sphinxupquote{attrib}}) \textendash{} The attrib to append + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{find\_node\_by\_attrib() (in module src.xmlManager)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.find_node_by_attrib}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.xmlManager.}}\sphinxbfcode{\sphinxupquote{find\_node\_by\_attrib}}}{\emph{xmlroot}, \emph{name\_node}, \emph{key}, \emph{value}}{}~\begin{description} +\item[{Find the nfirst ode from xmlroot that has name name\_node and that has in }] \leavevmode +its attributes \{key : value\}. Return the node + +\end{description} +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{etree.Element}} (\sphinxstyleliteralemphasis{\sphinxupquote{xmlroot}}) \textendash{} the Etree element where to search + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{value}}) \textendash{} the name of node to search + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the key to search + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} the value to search + +\end{itemize} + +\item[{Returns}] \leavevmode +the found node + +\item[{Return type}] \leavevmode +xmlroot etree.Element + +\end{description}\end{quote} + +\end{fulllineitems} + +\index{write\_report() (in module src.xmlManager)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src:src.xmlManager.write_report}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.xmlManager.}}\sphinxbfcode{\sphinxupquote{write\_report}}}{\emph{filename}, \emph{xmlroot}, \emph{stylesheet}}{} +Writes a report file from a XML tree. +\begin{quote}\begin{description} +\item[{Parameters}] \leavevmode\begin{itemize} +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} (\sphinxstyleliteralemphasis{\sphinxupquote{stylesheet}}) \textendash{} The path to the file to create + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{etree.Element}} (\sphinxstyleliteralemphasis{\sphinxupquote{xmlroot}}) \textendash{} the Etree element to write to the file + +\item {} +\sphinxstyleliteralstrong{\sphinxupquote{str}} \textendash{} The stylesheet to add to the begin of the file + +\end{itemize} + +\end{description}\end{quote} + +\end{fulllineitems} + + + +\subsubsection{Subpackages} +\label{\detokenize{commands/apidoc/src:subpackages}} + +\paragraph{colorama Package} +\label{\detokenize{commands/apidoc/src.colorama:colorama-package}}\label{\detokenize{commands/apidoc/src.colorama::doc}} + +\subparagraph{\sphinxstyleliteralintitle{\sphinxupquote{colorama}} Package} +\label{\detokenize{commands/apidoc/src.colorama:id1}}\phantomsection\label{\detokenize{commands/apidoc/src.colorama:module-src.colorama}}\index{src.colorama (module)} + +\subparagraph{\sphinxstyleliteralintitle{\sphinxupquote{ansi}} Module} +\label{\detokenize{commands/apidoc/src.colorama:module-src.colorama.ansi}}\label{\detokenize{commands/apidoc/src.colorama:ansi-module}}\index{src.colorama.ansi (module)} +This module generates ANSI character codes to printing colors to terminals. +See: \sphinxurl{http://en.wikipedia.org/wiki/ANSI\_escape\_code} +\index{AnsiBack (class in src.colorama.ansi)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.colorama.ansi.}}\sphinxbfcode{\sphinxupquote{AnsiBack}}} +Bases: {\hyperref[\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCodes}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.colorama.ansi.AnsiCodes}}}}} (\autopageref*{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCodes}}) +\index{BLACK (src.colorama.ansi.AnsiBack attribute)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.BLACK}}\pysigline{\sphinxbfcode{\sphinxupquote{BLACK}}\sphinxbfcode{\sphinxupquote{ = 40}}} +\end{fulllineitems} + +\index{BLUE (src.colorama.ansi.AnsiBack attribute)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.BLUE}}\pysigline{\sphinxbfcode{\sphinxupquote{BLUE}}\sphinxbfcode{\sphinxupquote{ = 44}}} +\end{fulllineitems} + +\index{CYAN (src.colorama.ansi.AnsiBack attribute)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.CYAN}}\pysigline{\sphinxbfcode{\sphinxupquote{CYAN}}\sphinxbfcode{\sphinxupquote{ = 46}}} +\end{fulllineitems} + +\index{GREEN (src.colorama.ansi.AnsiBack attribute)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.GREEN}}\pysigline{\sphinxbfcode{\sphinxupquote{GREEN}}\sphinxbfcode{\sphinxupquote{ = 42}}} +\end{fulllineitems} + +\index{LIGHTBLACK\_EX (src.colorama.ansi.AnsiBack attribute)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTBLACK_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTBLACK\_EX}}\sphinxbfcode{\sphinxupquote{ = 100}}} +\end{fulllineitems} + +\index{LIGHTBLUE\_EX (src.colorama.ansi.AnsiBack attribute)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTBLUE_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTBLUE\_EX}}\sphinxbfcode{\sphinxupquote{ = 104}}} +\end{fulllineitems} + +\index{LIGHTCYAN\_EX (src.colorama.ansi.AnsiBack attribute)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTCYAN_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTCYAN\_EX}}\sphinxbfcode{\sphinxupquote{ = 106}}} +\end{fulllineitems} + +\index{LIGHTGREEN\_EX (src.colorama.ansi.AnsiBack attribute)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTGREEN_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTGREEN\_EX}}\sphinxbfcode{\sphinxupquote{ = 102}}} +\end{fulllineitems} + +\index{LIGHTMAGENTA\_EX (src.colorama.ansi.AnsiBack attribute)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTMAGENTA_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTMAGENTA\_EX}}\sphinxbfcode{\sphinxupquote{ = 105}}} +\end{fulllineitems} + +\index{LIGHTRED\_EX (src.colorama.ansi.AnsiBack attribute)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTRED_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTRED\_EX}}\sphinxbfcode{\sphinxupquote{ = 101}}} +\end{fulllineitems} + +\index{LIGHTWHITE\_EX (src.colorama.ansi.AnsiBack attribute)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTWHITE_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTWHITE\_EX}}\sphinxbfcode{\sphinxupquote{ = 107}}} +\end{fulllineitems} + +\index{LIGHTYELLOW\_EX (src.colorama.ansi.AnsiBack attribute)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.LIGHTYELLOW_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTYELLOW\_EX}}\sphinxbfcode{\sphinxupquote{ = 103}}} +\end{fulllineitems} + +\index{MAGENTA (src.colorama.ansi.AnsiBack attribute)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.MAGENTA}}\pysigline{\sphinxbfcode{\sphinxupquote{MAGENTA}}\sphinxbfcode{\sphinxupquote{ = 45}}} +\end{fulllineitems} + +\index{RED (src.colorama.ansi.AnsiBack attribute)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.RED}}\pysigline{\sphinxbfcode{\sphinxupquote{RED}}\sphinxbfcode{\sphinxupquote{ = 41}}} +\end{fulllineitems} + +\index{RESET (src.colorama.ansi.AnsiBack attribute)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.RESET}}\pysigline{\sphinxbfcode{\sphinxupquote{RESET}}\sphinxbfcode{\sphinxupquote{ = 49}}} +\end{fulllineitems} + +\index{WHITE (src.colorama.ansi.AnsiBack attribute)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.WHITE}}\pysigline{\sphinxbfcode{\sphinxupquote{WHITE}}\sphinxbfcode{\sphinxupquote{ = 47}}} +\end{fulllineitems} + +\index{YELLOW (src.colorama.ansi.AnsiBack attribute)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiBack.YELLOW}}\pysigline{\sphinxbfcode{\sphinxupquote{YELLOW}}\sphinxbfcode{\sphinxupquote{ = 43}}} +\end{fulllineitems} + + +\end{fulllineitems} + +\index{AnsiCodes (class in src.colorama.ansi)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCodes}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.colorama.ansi.}}\sphinxbfcode{\sphinxupquote{AnsiCodes}}} +Bases: \sphinxcode{\sphinxupquote{object}} + +\end{fulllineitems} + +\index{AnsiCursor (class in src.colorama.ansi)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.colorama.ansi.}}\sphinxbfcode{\sphinxupquote{AnsiCursor}}} +Bases: \sphinxcode{\sphinxupquote{object}} +\index{BACK() (src.colorama.ansi.AnsiCursor method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.BACK}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{BACK}}}{\emph{n=1}}{} +\end{fulllineitems} + +\index{DOWN() (src.colorama.ansi.AnsiCursor method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.DOWN}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{DOWN}}}{\emph{n=1}}{} +\end{fulllineitems} + +\index{FORWARD() (src.colorama.ansi.AnsiCursor method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.FORWARD}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{FORWARD}}}{\emph{n=1}}{} +\end{fulllineitems} + +\index{POS() (src.colorama.ansi.AnsiCursor method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.POS}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{POS}}}{\emph{x=1}, \emph{y=1}}{} +\end{fulllineitems} + +\index{UP() (src.colorama.ansi.AnsiCursor method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCursor.UP}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{UP}}}{\emph{n=1}}{} +\end{fulllineitems} + + +\end{fulllineitems} + +\index{AnsiFore (class in src.colorama.ansi)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.colorama.ansi.}}\sphinxbfcode{\sphinxupquote{AnsiFore}}} +Bases: {\hyperref[\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCodes}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.colorama.ansi.AnsiCodes}}}}} (\autopageref*{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCodes}}) +\index{BLACK (src.colorama.ansi.AnsiFore attribute)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.BLACK}}\pysigline{\sphinxbfcode{\sphinxupquote{BLACK}}\sphinxbfcode{\sphinxupquote{ = 30}}} +\end{fulllineitems} + +\index{BLUE (src.colorama.ansi.AnsiFore attribute)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.BLUE}}\pysigline{\sphinxbfcode{\sphinxupquote{BLUE}}\sphinxbfcode{\sphinxupquote{ = 34}}} +\end{fulllineitems} + +\index{CYAN (src.colorama.ansi.AnsiFore attribute)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.CYAN}}\pysigline{\sphinxbfcode{\sphinxupquote{CYAN}}\sphinxbfcode{\sphinxupquote{ = 36}}} +\end{fulllineitems} + +\index{GREEN (src.colorama.ansi.AnsiFore attribute)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.GREEN}}\pysigline{\sphinxbfcode{\sphinxupquote{GREEN}}\sphinxbfcode{\sphinxupquote{ = 32}}} +\end{fulllineitems} + +\index{LIGHTBLACK\_EX (src.colorama.ansi.AnsiFore attribute)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTBLACK_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTBLACK\_EX}}\sphinxbfcode{\sphinxupquote{ = 90}}} +\end{fulllineitems} + +\index{LIGHTBLUE\_EX (src.colorama.ansi.AnsiFore attribute)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTBLUE_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTBLUE\_EX}}\sphinxbfcode{\sphinxupquote{ = 94}}} +\end{fulllineitems} + +\index{LIGHTCYAN\_EX (src.colorama.ansi.AnsiFore attribute)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTCYAN_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTCYAN\_EX}}\sphinxbfcode{\sphinxupquote{ = 96}}} +\end{fulllineitems} + +\index{LIGHTGREEN\_EX (src.colorama.ansi.AnsiFore attribute)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTGREEN_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTGREEN\_EX}}\sphinxbfcode{\sphinxupquote{ = 92}}} +\end{fulllineitems} + +\index{LIGHTMAGENTA\_EX (src.colorama.ansi.AnsiFore attribute)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTMAGENTA_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTMAGENTA\_EX}}\sphinxbfcode{\sphinxupquote{ = 95}}} +\end{fulllineitems} + +\index{LIGHTRED\_EX (src.colorama.ansi.AnsiFore attribute)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTRED_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTRED\_EX}}\sphinxbfcode{\sphinxupquote{ = 91}}} +\end{fulllineitems} + +\index{LIGHTWHITE\_EX (src.colorama.ansi.AnsiFore attribute)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTWHITE_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTWHITE\_EX}}\sphinxbfcode{\sphinxupquote{ = 97}}} +\end{fulllineitems} + +\index{LIGHTYELLOW\_EX (src.colorama.ansi.AnsiFore attribute)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.LIGHTYELLOW_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTYELLOW\_EX}}\sphinxbfcode{\sphinxupquote{ = 93}}} +\end{fulllineitems} + +\index{MAGENTA (src.colorama.ansi.AnsiFore attribute)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.MAGENTA}}\pysigline{\sphinxbfcode{\sphinxupquote{MAGENTA}}\sphinxbfcode{\sphinxupquote{ = 35}}} +\end{fulllineitems} + +\index{RED (src.colorama.ansi.AnsiFore attribute)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.RED}}\pysigline{\sphinxbfcode{\sphinxupquote{RED}}\sphinxbfcode{\sphinxupquote{ = 31}}} +\end{fulllineitems} + +\index{RESET (src.colorama.ansi.AnsiFore attribute)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.RESET}}\pysigline{\sphinxbfcode{\sphinxupquote{RESET}}\sphinxbfcode{\sphinxupquote{ = 39}}} +\end{fulllineitems} + +\index{WHITE (src.colorama.ansi.AnsiFore attribute)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.WHITE}}\pysigline{\sphinxbfcode{\sphinxupquote{WHITE}}\sphinxbfcode{\sphinxupquote{ = 37}}} +\end{fulllineitems} + +\index{YELLOW (src.colorama.ansi.AnsiFore attribute)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiFore.YELLOW}}\pysigline{\sphinxbfcode{\sphinxupquote{YELLOW}}\sphinxbfcode{\sphinxupquote{ = 33}}} +\end{fulllineitems} + + +\end{fulllineitems} + +\index{AnsiStyle (class in src.colorama.ansi)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.colorama.ansi.}}\sphinxbfcode{\sphinxupquote{AnsiStyle}}} +Bases: {\hyperref[\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCodes}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.colorama.ansi.AnsiCodes}}}}} (\autopageref*{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiCodes}}) +\index{BRIGHT (src.colorama.ansi.AnsiStyle attribute)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle.BRIGHT}}\pysigline{\sphinxbfcode{\sphinxupquote{BRIGHT}}\sphinxbfcode{\sphinxupquote{ = 1}}} +\end{fulllineitems} + +\index{DIM (src.colorama.ansi.AnsiStyle attribute)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle.DIM}}\pysigline{\sphinxbfcode{\sphinxupquote{DIM}}\sphinxbfcode{\sphinxupquote{ = 2}}} +\end{fulllineitems} + +\index{NORMAL (src.colorama.ansi.AnsiStyle attribute)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle.NORMAL}}\pysigline{\sphinxbfcode{\sphinxupquote{NORMAL}}\sphinxbfcode{\sphinxupquote{ = 22}}} +\end{fulllineitems} + +\index{RESET\_ALL (src.colorama.ansi.AnsiStyle attribute)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.AnsiStyle.RESET_ALL}}\pysigline{\sphinxbfcode{\sphinxupquote{RESET\_ALL}}\sphinxbfcode{\sphinxupquote{ = 0}}} +\end{fulllineitems} + + +\end{fulllineitems} + +\index{clear\_line() (in module src.colorama.ansi)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.clear_line}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.ansi.}}\sphinxbfcode{\sphinxupquote{clear\_line}}}{\emph{mode=2}}{} +\end{fulllineitems} + +\index{clear\_screen() (in module src.colorama.ansi)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.clear_screen}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.ansi.}}\sphinxbfcode{\sphinxupquote{clear\_screen}}}{\emph{mode=2}}{} +\end{fulllineitems} + +\index{code\_to\_chars() (in module src.colorama.ansi)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.code_to_chars}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.ansi.}}\sphinxbfcode{\sphinxupquote{code\_to\_chars}}}{\emph{code}}{} +\end{fulllineitems} + +\index{set\_title() (in module src.colorama.ansi)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansi.set_title}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.ansi.}}\sphinxbfcode{\sphinxupquote{set\_title}}}{\emph{title}}{} +\end{fulllineitems} + + + +\subparagraph{\sphinxstyleliteralintitle{\sphinxupquote{ansitowin32}} Module} +\label{\detokenize{commands/apidoc/src.colorama:ansitowin32-module}}\label{\detokenize{commands/apidoc/src.colorama:module-src.colorama.ansitowin32}}\index{src.colorama.ansitowin32 (module)}\index{AnsiToWin32 (class in src.colorama.ansitowin32)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.colorama.ansitowin32.}}\sphinxbfcode{\sphinxupquote{AnsiToWin32}}}{\emph{wrapped}, \emph{convert=None}, \emph{strip=None}, \emph{autoreset=False}}{} +Bases: \sphinxcode{\sphinxupquote{object}} + +Implements a ‘write()’ method which, on Windows, will strip ANSI character +sequences from the text, and if outputting to a tty, will convert them into +win32 function calls. +\index{ANSI\_CSI\_RE (src.colorama.ansitowin32.AnsiToWin32 attribute)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.ANSI_CSI_RE}}\pysigline{\sphinxbfcode{\sphinxupquote{ANSI\_CSI\_RE}}\sphinxbfcode{\sphinxupquote{ = \textless{}\_sre.SRE\_Pattern object at 0x4986ff0\textgreater{}}}} +\end{fulllineitems} + +\index{ANSI\_OSC\_RE (src.colorama.ansitowin32.AnsiToWin32 attribute)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.ANSI_OSC_RE}}\pysigline{\sphinxbfcode{\sphinxupquote{ANSI\_OSC\_RE}}\sphinxbfcode{\sphinxupquote{ = \textless{}\_sre.SRE\_Pattern object at 0x44e4620\textgreater{}}}} +\end{fulllineitems} + +\index{call\_win32() (src.colorama.ansitowin32.AnsiToWin32 method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.call_win32}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{call\_win32}}}{\emph{command}, \emph{params}}{} +\end{fulllineitems} + +\index{convert\_ansi() (src.colorama.ansitowin32.AnsiToWin32 method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.convert_ansi}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{convert\_ansi}}}{\emph{paramstring}, \emph{command}}{} +\end{fulllineitems} + +\index{convert\_osc() (src.colorama.ansitowin32.AnsiToWin32 method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.convert_osc}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{convert\_osc}}}{\emph{text}}{} +\end{fulllineitems} + +\index{extract\_params() (src.colorama.ansitowin32.AnsiToWin32 method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.extract_params}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{extract\_params}}}{\emph{command}, \emph{paramstring}}{} +\end{fulllineitems} + +\index{get\_win32\_calls() (src.colorama.ansitowin32.AnsiToWin32 method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.get_win32_calls}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_win32\_calls}}}{}{} +\end{fulllineitems} + +\index{reset\_all() (src.colorama.ansitowin32.AnsiToWin32 method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.reset_all}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{reset\_all}}}{}{} +\end{fulllineitems} + +\index{should\_wrap() (src.colorama.ansitowin32.AnsiToWin32 method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.should_wrap}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{should\_wrap}}}{}{} +True if this class is actually needed. If false, then the output +stream will not be affected, nor will win32 calls be issued, so +wrapping stdout is not actually required. This will generally be +False on non-Windows platforms, unless optional functionality like +autoreset has been requested using kwargs to init() + +\end{fulllineitems} + +\index{write() (src.colorama.ansitowin32.AnsiToWin32 method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.write}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write}}}{\emph{text}}{} +\end{fulllineitems} + +\index{write\_and\_convert() (src.colorama.ansitowin32.AnsiToWin32 method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.write_and_convert}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write\_and\_convert}}}{\emph{text}}{} +Write the given text to our wrapped stream, stripping any ANSI +sequences from the text, and optionally converting them into win32 +calls. + +\end{fulllineitems} + +\index{write\_plain\_text() (src.colorama.ansitowin32.AnsiToWin32 method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.AnsiToWin32.write_plain_text}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write\_plain\_text}}}{\emph{text}, \emph{start}, \emph{end}}{} +\end{fulllineitems} + + +\end{fulllineitems} + +\index{StreamWrapper (class in src.colorama.ansitowin32)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.StreamWrapper}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.colorama.ansitowin32.}}\sphinxbfcode{\sphinxupquote{StreamWrapper}}}{\emph{wrapped}, \emph{converter}}{} +Bases: \sphinxcode{\sphinxupquote{object}} + +Wraps a stream (such as stdout), acting as a transparent proxy for all +attribute access apart from method ‘write()’, which is delegated to our +Converter instance. +\index{write() (src.colorama.ansitowin32.StreamWrapper method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.StreamWrapper.write}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write}}}{\emph{text}}{} +\end{fulllineitems} + + +\end{fulllineitems} + +\index{is\_a\_tty() (in module src.colorama.ansitowin32)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.is_a_tty}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.ansitowin32.}}\sphinxbfcode{\sphinxupquote{is\_a\_tty}}}{\emph{stream}}{} +\end{fulllineitems} + +\index{is\_stream\_closed() (in module src.colorama.ansitowin32)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.ansitowin32.is_stream_closed}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.ansitowin32.}}\sphinxbfcode{\sphinxupquote{is\_stream\_closed}}}{\emph{stream}}{} +\end{fulllineitems} + + + +\subparagraph{\sphinxstyleliteralintitle{\sphinxupquote{initialise}} Module} +\label{\detokenize{commands/apidoc/src.colorama:initialise-module}}\label{\detokenize{commands/apidoc/src.colorama:module-src.colorama.initialise}}\index{src.colorama.initialise (module)}\index{colorama\_text() (in module src.colorama.initialise)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.initialise.colorama_text}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.initialise.}}\sphinxbfcode{\sphinxupquote{colorama\_text}}}{\emph{*args}, \emph{**kwds}}{} +\end{fulllineitems} + +\index{deinit() (in module src.colorama.initialise)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.initialise.deinit}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.initialise.}}\sphinxbfcode{\sphinxupquote{deinit}}}{}{} +\end{fulllineitems} + +\index{init() (in module src.colorama.initialise)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.initialise.init}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.initialise.}}\sphinxbfcode{\sphinxupquote{init}}}{\emph{autoreset=False}, \emph{convert=None}, \emph{strip=None}, \emph{wrap=True}}{} +\end{fulllineitems} + +\index{reinit() (in module src.colorama.initialise)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.initialise.reinit}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.initialise.}}\sphinxbfcode{\sphinxupquote{reinit}}}{}{} +\end{fulllineitems} + +\index{reset\_all() (in module src.colorama.initialise)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.initialise.reset_all}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.initialise.}}\sphinxbfcode{\sphinxupquote{reset\_all}}}{}{} +\end{fulllineitems} + +\index{wrap\_stream() (in module src.colorama.initialise)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.initialise.wrap_stream}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.initialise.}}\sphinxbfcode{\sphinxupquote{wrap\_stream}}}{\emph{stream}, \emph{convert}, \emph{strip}, \emph{autoreset}, \emph{wrap}}{} +\end{fulllineitems} + + + +\subparagraph{\sphinxstyleliteralintitle{\sphinxupquote{win32}} Module} +\label{\detokenize{commands/apidoc/src.colorama:win32-module}}\label{\detokenize{commands/apidoc/src.colorama:module-src.colorama.win32}}\index{src.colorama.win32 (module)}\index{SetConsoleTextAttribute() (in module src.colorama.win32)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.win32.SetConsoleTextAttribute}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.win32.}}\sphinxbfcode{\sphinxupquote{SetConsoleTextAttribute}}}{\emph{*\_}}{} +\end{fulllineitems} + +\index{winapi\_test() (in module src.colorama.win32)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.win32.winapi_test}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.win32.}}\sphinxbfcode{\sphinxupquote{winapi\_test}}}{\emph{*\_}}{} +\end{fulllineitems} + + + +\subparagraph{\sphinxstyleliteralintitle{\sphinxupquote{winterm}} Module} +\label{\detokenize{commands/apidoc/src.colorama:winterm-module}}\label{\detokenize{commands/apidoc/src.colorama:module-src.colorama.winterm}}\index{src.colorama.winterm (module)}\index{WinColor (class in src.colorama.winterm)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinColor}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.colorama.winterm.}}\sphinxbfcode{\sphinxupquote{WinColor}}} +Bases: \sphinxcode{\sphinxupquote{object}} +\index{BLACK (src.colorama.winterm.WinColor attribute)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.BLACK}}\pysigline{\sphinxbfcode{\sphinxupquote{BLACK}}\sphinxbfcode{\sphinxupquote{ = 0}}} +\end{fulllineitems} + +\index{BLUE (src.colorama.winterm.WinColor attribute)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.BLUE}}\pysigline{\sphinxbfcode{\sphinxupquote{BLUE}}\sphinxbfcode{\sphinxupquote{ = 1}}} +\end{fulllineitems} + +\index{CYAN (src.colorama.winterm.WinColor attribute)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.CYAN}}\pysigline{\sphinxbfcode{\sphinxupquote{CYAN}}\sphinxbfcode{\sphinxupquote{ = 3}}} +\end{fulllineitems} + +\index{GREEN (src.colorama.winterm.WinColor attribute)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.GREEN}}\pysigline{\sphinxbfcode{\sphinxupquote{GREEN}}\sphinxbfcode{\sphinxupquote{ = 2}}} +\end{fulllineitems} + +\index{GREY (src.colorama.winterm.WinColor attribute)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.GREY}}\pysigline{\sphinxbfcode{\sphinxupquote{GREY}}\sphinxbfcode{\sphinxupquote{ = 7}}} +\end{fulllineitems} + +\index{MAGENTA (src.colorama.winterm.WinColor attribute)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.MAGENTA}}\pysigline{\sphinxbfcode{\sphinxupquote{MAGENTA}}\sphinxbfcode{\sphinxupquote{ = 5}}} +\end{fulllineitems} + +\index{RED (src.colorama.winterm.WinColor attribute)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.RED}}\pysigline{\sphinxbfcode{\sphinxupquote{RED}}\sphinxbfcode{\sphinxupquote{ = 4}}} +\end{fulllineitems} + +\index{YELLOW (src.colorama.winterm.WinColor attribute)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinColor.YELLOW}}\pysigline{\sphinxbfcode{\sphinxupquote{YELLOW}}\sphinxbfcode{\sphinxupquote{ = 6}}} +\end{fulllineitems} + + +\end{fulllineitems} + +\index{WinStyle (class in src.colorama.winterm)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinStyle}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.colorama.winterm.}}\sphinxbfcode{\sphinxupquote{WinStyle}}} +Bases: \sphinxcode{\sphinxupquote{object}} +\index{BRIGHT (src.colorama.winterm.WinStyle attribute)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinStyle.BRIGHT}}\pysigline{\sphinxbfcode{\sphinxupquote{BRIGHT}}\sphinxbfcode{\sphinxupquote{ = 8}}} +\end{fulllineitems} + +\index{BRIGHT\_BACKGROUND (src.colorama.winterm.WinStyle attribute)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinStyle.BRIGHT_BACKGROUND}}\pysigline{\sphinxbfcode{\sphinxupquote{BRIGHT\_BACKGROUND}}\sphinxbfcode{\sphinxupquote{ = 128}}} +\end{fulllineitems} + +\index{NORMAL (src.colorama.winterm.WinStyle attribute)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinStyle.NORMAL}}\pysigline{\sphinxbfcode{\sphinxupquote{NORMAL}}\sphinxbfcode{\sphinxupquote{ = 0}}} +\end{fulllineitems} + + +\end{fulllineitems} + +\index{WinTerm (class in src.colorama.winterm)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.colorama.winterm.}}\sphinxbfcode{\sphinxupquote{WinTerm}}} +Bases: \sphinxcode{\sphinxupquote{object}} +\index{back() (src.colorama.winterm.WinTerm method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.back}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{back}}}{\emph{back=None}, \emph{light=False}, \emph{on\_stderr=False}}{} +\end{fulllineitems} + +\index{cursor\_adjust() (src.colorama.winterm.WinTerm method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.cursor_adjust}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{cursor\_adjust}}}{\emph{x}, \emph{y}, \emph{on\_stderr=False}}{} +\end{fulllineitems} + +\index{erase\_line() (src.colorama.winterm.WinTerm method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.erase_line}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{erase\_line}}}{\emph{mode=0}, \emph{on\_stderr=False}}{} +\end{fulllineitems} + +\index{erase\_screen() (src.colorama.winterm.WinTerm method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.erase_screen}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{erase\_screen}}}{\emph{mode=0}, \emph{on\_stderr=False}}{} +\end{fulllineitems} + +\index{fore() (src.colorama.winterm.WinTerm method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.fore}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{fore}}}{\emph{fore=None}, \emph{light=False}, \emph{on\_stderr=False}}{} +\end{fulllineitems} + +\index{get\_attrs() (src.colorama.winterm.WinTerm method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.get_attrs}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_attrs}}}{}{} +\end{fulllineitems} + +\index{get\_position() (src.colorama.winterm.WinTerm method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.get_position}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_position}}}{\emph{handle}}{} +\end{fulllineitems} + +\index{reset\_all() (src.colorama.winterm.WinTerm method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.reset_all}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{reset\_all}}}{\emph{on\_stderr=None}}{} +\end{fulllineitems} + +\index{set\_attrs() (src.colorama.winterm.WinTerm method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.set_attrs}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_attrs}}}{\emph{value}}{} +\end{fulllineitems} + +\index{set\_console() (src.colorama.winterm.WinTerm method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.set_console}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_console}}}{\emph{attrs=None}, \emph{on\_stderr=False}}{} +\end{fulllineitems} + +\index{set\_cursor\_position() (src.colorama.winterm.WinTerm method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.set_cursor_position}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_cursor\_position}}}{\emph{position=None}, \emph{on\_stderr=False}}{} +\end{fulllineitems} + +\index{set\_title() (src.colorama.winterm.WinTerm method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.set_title}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_title}}}{\emph{title}}{} +\end{fulllineitems} + +\index{style() (src.colorama.winterm.WinTerm method)} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{commands/apidoc/src.colorama:src.colorama.winterm.WinTerm.style}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{style}}}{\emph{style=None}, \emph{on\_stderr=False}}{} +\end{fulllineitems} + + +\end{fulllineitems} + + + +\chapter{Release Notes} +\label{\detokenize{index:release-notes}} + +\section{Release notes} +\label{\detokenize{release_notes/release_notes_5.0.0:release-notes}}\label{\detokenize{release_notes/release_notes_5.0.0::doc}} +In construction. + + +\renewcommand{\indexname}{Python Module Index} +\begin{sphinxtheindex} +\def\bigletter#1{{\Large\sffamily#1}\nopagebreak\vspace{1mm}} +\bigletter{s} +\item {\sphinxstyleindexentry{src.\_\_init\_\_}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.__init__}} +\item {\sphinxstyleindexentry{src.architecture}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.architecture}} +\item {\sphinxstyleindexentry{src.colorama}}\sphinxstyleindexpageref{commands/apidoc/src.colorama:\detokenize{module-src.colorama}} +\item {\sphinxstyleindexentry{src.colorama.ansi}}\sphinxstyleindexpageref{commands/apidoc/src.colorama:\detokenize{module-src.colorama.ansi}} +\item {\sphinxstyleindexentry{src.colorama.ansitowin32}}\sphinxstyleindexpageref{commands/apidoc/src.colorama:\detokenize{module-src.colorama.ansitowin32}} +\item {\sphinxstyleindexentry{src.colorama.initialise}}\sphinxstyleindexpageref{commands/apidoc/src.colorama:\detokenize{module-src.colorama.initialise}} +\item {\sphinxstyleindexentry{src.colorama.win32}}\sphinxstyleindexpageref{commands/apidoc/src.colorama:\detokenize{module-src.colorama.win32}} +\item {\sphinxstyleindexentry{src.colorama.winterm}}\sphinxstyleindexpageref{commands/apidoc/src.colorama:\detokenize{module-src.colorama.winterm}} +\item {\sphinxstyleindexentry{src.compilation}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.compilation}} +\item {\sphinxstyleindexentry{src.debug}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.debug}} +\item {\sphinxstyleindexentry{src.ElementTree}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.ElementTree}} +\item {\sphinxstyleindexentry{src.environment}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.environment}} +\item {\sphinxstyleindexentry{src.fileEnviron}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.fileEnviron}} +\item {\sphinxstyleindexentry{src.fork}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.fork}} +\item {\sphinxstyleindexentry{src.logger}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.logger}} +\item {\sphinxstyleindexentry{src.options}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.options}} +\item {\sphinxstyleindexentry{src.printcolors}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.printcolors}} +\item {\sphinxstyleindexentry{src.product}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.product}} +\item {\sphinxstyleindexentry{src.pyconf}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.pyconf}} +\item {\sphinxstyleindexentry{src.system}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.system}} +\item {\sphinxstyleindexentry{src.template}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.template}} +\item {\sphinxstyleindexentry{src.test\_module}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.test_module}} +\item {\sphinxstyleindexentry{src.xmlManager}}\sphinxstyleindexpageref{commands/apidoc/src:\detokenize{module-src.xmlManager}} +\end{sphinxtheindex} + +\renewcommand{\indexname}{Index} +\printindex +\end{document} \ No newline at end of file diff --git a/doc/build/latex/salomeTools.toc b/doc/build/latex/salomeTools.toc new file mode 100644 index 0000000..9aa30ea --- /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}{5}{section.1.3} +\contentsline {subsection}{\numberline {1.3.1}Usage}{5}{subsection.1.3.1} +\contentsline {subsubsection}{Options of sat}{5}{subsubsection*.7} +\contentsline {paragraph}{\sphinxstyleemphasis {\textendash {}help or -h}}{5}{paragraph*.8} +\contentsline {paragraph}{\sphinxstyleemphasis {\textendash {}debug or -g}}{5}{paragraph*.9} +\contentsline {paragraph}{\sphinxstyleemphasis {\textendash {}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}{6}{subsubsection*.13} +\contentsline {chapter}{\numberline {2}List of Commands}{7}{chapter.2} +\contentsline {section}{\numberline {2.1}Command config}{8}{section.2.1} +\contentsline {subsection}{\numberline {2.1.1}Description}{8}{subsection.2.1.1} +\contentsline {subsection}{\numberline {2.1.2}Usage}{8}{subsection.2.1.2} +\contentsline {subsection}{\numberline {2.1.3}Some useful configuration pathes}{9}{subsection.2.1.3} +\contentsline {section}{\numberline {2.2}Command prepare}{10}{section.2.2} +\contentsline {subsection}{\numberline {2.2.1}Description}{10}{subsection.2.2.1} +\contentsline {subsection}{\numberline {2.2.2}Remarks}{10}{subsection.2.2.2} +\contentsline {subsubsection}{VCS bases (git, svn, cvs)}{10}{subsubsection*.14} +\contentsline {subsubsection}{Dev mode}{10}{subsubsection*.15} +\contentsline {subsection}{\numberline {2.2.3}Usage}{10}{subsection.2.2.3} +\contentsline {subsection}{\numberline {2.2.4}Some useful configuration pathes}{11}{subsection.2.2.4} +\contentsline {section}{\numberline {2.3}Command compile}{12}{section.2.3} +\contentsline {subsection}{\numberline {2.3.1}Description}{12}{subsection.2.3.1} +\contentsline {subsection}{\numberline {2.3.2}Usage}{12}{subsection.2.3.2} +\contentsline {subsection}{\numberline {2.3.3}Some useful configuration pathes}{13}{subsection.2.3.3} +\contentsline {section}{\numberline {2.4}Command launcher}{14}{section.2.4} +\contentsline {subsection}{\numberline {2.4.1}Description}{14}{subsection.2.4.1} +\contentsline {subsection}{\numberline {2.4.2}Usage}{14}{subsection.2.4.2} +\contentsline {subsection}{\numberline {2.4.3}Configuration}{14}{subsection.2.4.3} +\contentsline {section}{\numberline {2.5}Command application}{15}{section.2.5} +\contentsline {subsection}{\numberline {2.5.1}Description}{15}{subsection.2.5.1} +\contentsline {subsection}{\numberline {2.5.2}Usage}{15}{subsection.2.5.2} +\contentsline {subsection}{\numberline {2.5.3}Some useful configuration pathes}{15}{subsection.2.5.3} +\contentsline {section}{\numberline {2.6}Command log}{16}{section.2.6} +\contentsline {subsection}{\numberline {2.6.1}Description}{16}{subsection.2.6.1} +\contentsline {subsection}{\numberline {2.6.2}Usage}{16}{subsection.2.6.2} +\contentsline {subsection}{\numberline {2.6.3}Some useful configuration pathes}{16}{subsection.2.6.3} +\contentsline {section}{\numberline {2.7}Command environ}{17}{section.2.7} +\contentsline {subsection}{\numberline {2.7.1}Description}{17}{subsection.2.7.1} +\contentsline {subsection}{\numberline {2.7.2}Usage}{17}{subsection.2.7.2} +\contentsline {subsection}{\numberline {2.7.3}Configuration}{17}{subsection.2.7.3} +\contentsline {section}{\numberline {2.8}Command clean}{20}{section.2.8} +\contentsline {subsection}{\numberline {2.8.1}Description}{20}{subsection.2.8.1} +\contentsline {subsection}{\numberline {2.8.2}Usage}{20}{subsection.2.8.2} +\contentsline {subsection}{\numberline {2.8.3}Availables options}{20}{subsection.2.8.3} +\contentsline {subsection}{\numberline {2.8.4}Some useful configuration pathes}{20}{subsection.2.8.4} +\contentsline {section}{\numberline {2.9}Command package}{21}{section.2.9} +\contentsline {subsection}{\numberline {2.9.1}Description}{21}{subsection.2.9.1} +\contentsline {subsection}{\numberline {2.9.2}Usage}{21}{subsection.2.9.2} +\contentsline {subsection}{\numberline {2.9.3}Some useful configuration pathes}{22}{subsection.2.9.3} +\contentsline {section}{\numberline {2.10}Command generate}{23}{section.2.10} +\contentsline {subsection}{\numberline {2.10.1}Description}{23}{subsection.2.10.1} +\contentsline {subsection}{\numberline {2.10.2}Remarks}{23}{subsection.2.10.2} +\contentsline {subsection}{\numberline {2.10.3}Usage}{23}{subsection.2.10.3} +\contentsline {chapter}{\numberline {3}Developer documentation}{25}{chapter.3} +\contentsline {section}{\numberline {3.1}Add a user custom command}{26}{section.3.1} +\contentsline {subsection}{\numberline {3.1.1}Introduction}{26}{subsection.3.1.1} +\contentsline {subsection}{\numberline {3.1.2}Basic requirements}{26}{subsection.3.1.2} +\contentsline {subsection}{\numberline {3.1.3}HowTo access salomeTools config and other commands}{27}{subsection.3.1.3} +\contentsline {subsection}{\numberline {3.1.4}HowTo logger}{27}{subsection.3.1.4} +\contentsline {subsection}{\numberline {3.1.5}HELLO example}{27}{subsection.3.1.5} +\contentsline {chapter}{\numberline {4}Code documentation}{29}{chapter.4} +\contentsline {section}{\numberline {4.1}src}{29}{section.4.1} +\contentsline {subsection}{\numberline {4.1.1}src Package}{29}{subsection.4.1.1} +\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {src}} Package}{29}{subsubsection*.16} +\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {ElementTree}} Module}{31}{subsubsection*.59} +\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {architecture}} Module}{32}{subsubsection*.91} +\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {compilation}} Module}{33}{subsubsection*.98} +\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {debug}} Module}{34}{subsubsection*.117} +\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {environment}} Module}{35}{subsubsection*.131} +\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {fileEnviron}} Module}{39}{subsubsection*.169} +\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {fork}} Module}{45}{subsubsection*.234} +\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {logger}} Module}{45}{subsubsection*.240} +\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {options}} Module}{47}{subsubsection*.253} +\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {printcolors}} Module}{47}{subsubsection*.259} +\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {product}} Module}{49}{subsubsection*.272} +\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {pyconf}} Module}{53}{subsubsection*.302} +\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {system}} Module}{60}{subsubsection*.374} +\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {template}} Module}{62}{subsubsection*.380} +\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {test\_module}} Module}{62}{subsubsection*.385} +\contentsline {subsubsection}{\sphinxstyleliteralintitle {\sphinxupquote {xmlManager}} Module}{62}{subsubsection*.405} +\contentsline {subsubsection}{Subpackages}{64}{subsubsection*.419} +\contentsline {paragraph}{colorama Package}{64}{paragraph*.420} +\contentsline {subparagraph}{\sphinxstyleliteralintitle {\sphinxupquote {colorama}} Package}{64}{subparagraph*.421} +\contentsline {subparagraph}{\sphinxstyleliteralintitle {\sphinxupquote {ansi}} Module}{64}{subparagraph*.423} +\contentsline {subparagraph}{\sphinxstyleliteralintitle {\sphinxupquote {ansitowin32}} Module}{66}{subparagraph*.476} +\contentsline {subparagraph}{\sphinxstyleliteralintitle {\sphinxupquote {initialise}} Module}{67}{subparagraph*.494} +\contentsline {subparagraph}{\sphinxstyleliteralintitle {\sphinxupquote {win32}} Module}{67}{subparagraph*.501} +\contentsline {subparagraph}{\sphinxstyleliteralintitle {\sphinxupquote {winterm}} Module}{67}{subparagraph*.504} +\contentsline {chapter}{\numberline {5}Release Notes}{69}{chapter.5} +\contentsline {section}{\numberline {5.1}Release notes}{69}{section.5.1} +\contentsline {chapter}{Python Module Index}{71}{section*.532} +\contentsline {chapter}{Index}{73}{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..e323b2a --- /dev/null +++ b/doc/build/latex/sphinx.sty @@ -0,0 +1,1648 @@ +% +% sphinx.sty +% +% Adapted from the old python.sty, mostly written by Fred Drake, +% by Georg Brandl. +% + +\NeedsTeXFormat{LaTeX2e}[1995/12/01] +\ProvidesPackage{sphinx}[2018/03/11 v1.7.2 LaTeX package (Sphinx markup)] + +% provides \ltx@ifundefined +% (many packages load ltxcmds: graphicx does for pdftex and lualatex but +% not xelatex, and anyhow kvoptions does, but it may be needed in future to +% use \sphinxdeprecationwarning earlier, and it needs \ltx@ifundefined) +\RequirePackage{ltxcmds} + +%% for deprecation warnings +\newcommand\sphinxdeprecationwarning[4]{% #1 the deprecated macro or name, +% #2 = when deprecated, #3 = when removed, #4 = additional info + \edef\spx@tempa{\detokenize{#1}}% + \ltx@ifundefined{sphinx_depr_\spx@tempa}{% + \global\expandafter\let\csname sphinx_depr_\spx@tempa\endcsname\spx@tempa + \expandafter\AtEndDocument\expandafter{\expandafter\let\expandafter + \sphinxdeprecatedmacro\csname sphinx_depr_\spx@tempa\endcsname + \PackageWarningNoLine{sphinx}{^^J**** SPHINX DEPRECATION WARNING:^^J + \sphinxdeprecatedmacro^^J + \@spaces- is deprecated at Sphinx #2^^J + \@spaces- and removed at Sphinx #3.^^J + #4^^J****}}% + }{% warning already emitted (at end of latex log), don't repeat + }} + + +%% PACKAGES +% +% we delay handling of options to after having loaded packages, because +% of the need to use \definecolor. +\RequirePackage{graphicx} +\@ifclassloaded{memoir}{}{\RequirePackage{fancyhdr}} +% for \text macro and \iffirstchoice@ conditional even if amsmath not loaded +\RequirePackage{amstext} +\RequirePackage{textcomp}% "warn" option issued from template +\RequirePackage{titlesec} +\@ifpackagelater{titlesec}{2016/03/15}% + {\@ifpackagelater{titlesec}{2016/03/21}% + {}% + {\newif\ifsphinx@ttlpatch@ok + \IfFileExists{etoolbox.sty}{% + \RequirePackage{etoolbox}% + \patchcmd{\ttlh@hang}{\parindent\z@}{\parindent\z@\leavevmode}% + {\sphinx@ttlpatch@oktrue}{}% + \ifsphinx@ttlpatch@ok + \patchcmd{\ttlh@hang}{\noindent}{}{}{\sphinx@ttlpatch@okfalse}% + \fi + }{}% + \ifsphinx@ttlpatch@ok + \typeout{^^J Package Sphinx Info: ^^J + **** titlesec 2.10.1 successfully patched for bugfix ****^^J}% + \else + \AtEndDocument{\PackageWarningNoLine{sphinx}{^^J% +******** titlesec 2.10.1 has a bug, (section numbers disappear) ......|^^J% +******** and Sphinx could not patch it, perhaps because your local ...|^^J% +******** copy is already fixed without a changed release date. .......|^^J% +******** If not, you must update titlesec! ...........................|}}% + \fi + }% + }{} +\RequirePackage{tabulary} +% tabulary has a bug with its re-definition of \multicolumn in its first pass +% which is not \long. But now Sphinx does not use LaTeX's \multicolumn but its +% own macro. Hence we don't even need to patch tabulary. See sphinxmulticell.sty +% X or S (Sphinx) may have meanings if some table package is loaded hence +% \X was chosen to avoid possibility of conflict +\newcolumntype{\X}[2]{p{\dimexpr + (\linewidth-\arrayrulewidth)*#1/#2-\tw@\tabcolsep-\arrayrulewidth\relax}} +\newcolumntype{\Y}[1]{p{\dimexpr + #1\dimexpr\linewidth-\arrayrulewidth\relax-\tw@\tabcolsep-\arrayrulewidth\relax}} +% using here T (for Tabulary) feels less of a problem than the X could be +\newcolumntype{T}{J}% +% For tables allowing pagebreaks +\RequirePackage{longtable} +% User interface to set-up whitespace before and after tables: +\newcommand*\sphinxtablepre {0pt}% +\newcommand*\sphinxtablepost{\medskipamount}% +\newcommand*\sphinxbelowcaptionspace{.5\sphinxbaselineskip}% +% as one can not use \baselineskip from inside longtable (it is zero there) +% we need \sphinxbaselineskip, which defaults to \baselineskip +\def\sphinxbaselineskip{\baselineskip}% +% These commands are inserted by the table templates +\def\sphinxatlongtablestart + {\par + \vskip\parskip + \vskip\dimexpr\sphinxtablepre\relax % adjust vertical position + \vbox{}% get correct baseline from above + \LTpre\z@skip\LTpost\z@skip % set to zero longtable's own skips + \edef\sphinxbaselineskip{\dimexpr\the\dimexpr\baselineskip\relax\relax}% + }% +\def\sphinxatlongtableend{\prevdepth\z@\vskip\sphinxtablepost\relax}% +\def\sphinxlongtablecapskipadjust + {\dimexpr-\dp\strutbox-\sphinxbaselineskip+\sphinxbelowcaptionspace\relax}% +% Now for tables not using longtable +\def\sphinxattablestart + {\par + \vskip\dimexpr\sphinxtablepre\relax + }% +\let\sphinxattableend\sphinxatlongtableend +% longtable's wraps captions to a maximal width of \LTcapwidth +% so we do the same for all tables +\newcommand*\sphinxcapstartof[1]{% + \vskip\parskip + \vbox{}% force baselineskip for good positioning by capstart of hyperanchor + \def\@captype{#1}% + \capstart +% move back vertically to compensate space inserted by next paragraph + \vskip-\baselineskip\vskip-\parskip +}% +% use \LTcapwidth (default is 4in) to wrap caption (if line width is bigger) +\newcommand\sphinxcaption[2][\LTcapwidth]{% + \noindent\hb@xt@\linewidth{\hss + \vtop{\@tempdima\dimexpr#1\relax +% don't exceed linewidth for the caption width + \ifdim\@tempdima>\linewidth\hsize\linewidth\else\hsize\@tempdima\fi +% longtable ignores \abovecaptionskip/\belowcaptionskip, so add hooks here +% to uniformize control of caption distance to tables + \abovecaptionskip\sphinxabovecaptionskip + \belowcaptionskip\sphinxbelowcaptionskip + \caption[{#2}]% + {\strut\ignorespaces#2\ifhmode\unskip\@finalstrut\strutbox\fi}% + }\hss}% + \par\prevdepth\dp\strutbox +}% +\def\spx@abovecaptionskip{\abovecaptionskip} +\newcommand*\sphinxabovecaptionskip{\z@skip} +\newcommand*\sphinxbelowcaptionskip{\z@skip} + +\newcommand\sphinxaftercaption +{% this default definition serves with a caption *above* a table, to make sure + % its last baseline is \sphinxbelowcaptionspace above table top + \nobreak + \vskip\dimexpr\sphinxbelowcaptionspace\relax + \vskip-\baselineskip\vskip-\parskip +}% +% varwidth is crucial for our handling of general contents in merged cells +\RequirePackage{varwidth} +% but addition of a compatibility patch with hyperref is needed +% (tested with varwidth v 0.92 Mar 2009) +\AtBeginDocument {% + \let\@@vwid@Hy@raisedlink\Hy@raisedlink + \long\def\@vwid@Hy@raisedlink#1{\@vwid@wrap{\@@vwid@Hy@raisedlink{#1}}}% + \edef\@vwid@setup{% + \let\noexpand\Hy@raisedlink\noexpand\@vwid@Hy@raisedlink % HYPERREF ! + \unexpanded\expandafter{\@vwid@setup}}% +}% +% Homemade package to handle merged cells +\RequirePackage{sphinxmulticell} +\RequirePackage{makeidx} +% For framing code-blocks and warning type notices, and shadowing topics +\RequirePackage{framed} +% The xcolor package draws better fcolorboxes around verbatim code +\IfFileExists{xcolor.sty}{ + \RequirePackage{xcolor} +}{ + \RequirePackage{color} +} +% For highlighted code. +\RequirePackage{fancyvrb} +\fvset{fontsize=\small} +\define@key{FV}{hllines}{\def\sphinx@verbatim@checkifhl##1{\in@{, ##1,}{#1}}} +% For hyperlinked footnotes in tables; also for gathering footnotes from +% topic and warning blocks. Also to allow code-blocks in footnotes. +\RequirePackage{footnotehyper-sphinx} +% For the H specifier. Do not \restylefloat{figure}, it breaks Sphinx code +% for allowing figures in tables. +\RequirePackage{float} +% For floating figures in the text. Better to load after float. +\RequirePackage{wrapfig} +% Separate paragraphs by space by default. +\RequirePackage{parskip} +% For parsed-literal blocks. +\RequirePackage{alltt} +% Display "real" single quotes in literal blocks. +\RequirePackage{upquote} +% control caption around literal-block +\RequirePackage{capt-of} +\RequirePackage{needspace} +\RequirePackage{remreset}% provides \@removefromreset +% to make pdf with correct encoded bookmarks in Japanese +% this should precede the hyperref package +\ifx\kanjiskip\@undefined +% for non-Japanese: make sure bookmarks are ok also with lualatex + \PassOptionsToPackage{pdfencoding=unicode}{hyperref} +\else + \RequirePackage{atbegshi} + \ifx\ucs\@undefined + \ifnum 42146=\euc"A4A2 + \AtBeginShipoutFirst{\special{pdf:tounicode EUC-UCS2}} + \else + \AtBeginShipoutFirst{\special{pdf:tounicode 90ms-RKSJ-UCS2}} + \fi + \else + \AtBeginShipoutFirst{\special{pdf:tounicode UTF8-UCS2}} + \fi +\fi + +\ifx\@jsc@uplatextrue\@undefined\else + \PassOptionsToPackage{setpagesize=false}{hyperref} +\fi + +% These options can be overriden inside 'hyperref' key +% or by later use of \hypersetup. +\PassOptionsToPackage{colorlinks,breaklinks,% + linkcolor=InnerLinkColor,filecolor=OuterLinkColor,% + menucolor=OuterLinkColor,urlcolor=OuterLinkColor,% + citecolor=InnerLinkColor}{hyperref} + +% stylesheet for highlighting with pygments +\RequirePackage{sphinxhighlight} +% fix baseline increase from Pygments latex formatter in case of error tokens +% and keep \fboxsep's scope local via added braces +\def\PYG@tok@err{% + \def\PYG@bc##1{{\setlength{\fboxsep}{-\fboxrule}% + \fcolorbox[rgb]{1.00,0.00,0.00}{1,1,1}{\strut ##1}}}% +} +\def\PYG@tok@cs{% + \def\PYG@tc##1{\textcolor[rgb]{0.25,0.50,0.56}{##1}}% + \def\PYG@bc##1{{\setlength{\fboxsep}{0pt}% + \colorbox[rgb]{1.00,0.94,0.94}{\strut ##1}}}% +}% + + +%% OPTIONS +% +% Handle options via "kvoptions" (later loaded by hyperref anyhow) +\RequirePackage{kvoptions} +\SetupKeyvalOptions{prefix=spx@opt@} % use \spx@opt@ prefix + +% Sphinx legacy text layout: 1in margins on all four sides +\ifx\@jsc@uplatextrue\@undefined +\DeclareStringOption[1in]{hmargin} +\DeclareStringOption[1in]{vmargin} +\DeclareStringOption[.5in]{marginpar} +\else +% Japanese standard document classes handle \mag in a special way +\DeclareStringOption[\inv@mag in]{hmargin} +\DeclareStringOption[\inv@mag in]{vmargin} +\DeclareStringOption[.5\dimexpr\inv@mag in\relax]{marginpar} +\fi + +\DeclareStringOption[0]{maxlistdepth}% \newcommand*\spx@opt@maxlistdepth{0} +\DeclareStringOption[-1]{numfigreset} +\DeclareBoolOption[false]{nonumfigreset} +\DeclareBoolOption[false]{mathnumfig} +% \DeclareBoolOption[false]{usespart}% not used +% dimensions, we declare the \dimen registers here. +\newdimen\sphinxverbatimsep +\newdimen\sphinxverbatimborder +\newdimen\sphinxshadowsep +\newdimen\sphinxshadowsize +\newdimen\sphinxshadowrule +% \DeclareStringOption is not convenient for the handling of these dimensions +% because we want to assign the values to the corresponding registers. Even if +% we added the code to the key handler it would be too late for the initial +% set-up and we would need to do initial assignments explicitely. We end up +% using \define@key directly. +% verbatim +\sphinxverbatimsep=\fboxsep + \define@key{sphinx}{verbatimsep}{\sphinxverbatimsep\dimexpr #1\relax} +\sphinxverbatimborder=\fboxrule + \define@key{sphinx}{verbatimborder}{\sphinxverbatimborder\dimexpr #1\relax} +% topic boxes +\sphinxshadowsep =5pt + \define@key{sphinx}{shadowsep}{\sphinxshadowsep\dimexpr #1\relax} +\sphinxshadowsize=4pt + \define@key{sphinx}{shadowsize}{\sphinxshadowsize\dimexpr #1\relax} +\sphinxshadowrule=\fboxrule + \define@key{sphinx}{shadowrule}{\sphinxshadowrule\dimexpr #1\relax} +% verbatim +\DeclareBoolOption[true]{verbatimwithframe} +\DeclareBoolOption[true]{verbatimwrapslines} +\DeclareBoolOption[true]{verbatimhintsturnover} +\DeclareBoolOption[true]{inlineliteralwraps} +\DeclareStringOption[t]{literalblockcappos} +\DeclareStringOption[r]{verbatimcontinuedalign} +\DeclareStringOption[r]{verbatimcontinuesalign} +% parsed literal +\DeclareBoolOption[true]{parsedliteralwraps} +% \textvisiblespace for compatibility with fontspec+XeTeX/LuaTeX +\DeclareStringOption[\textcolor{red}{\textvisiblespace}]{verbatimvisiblespace} +\DeclareStringOption % must use braces to hide the brackets + [{\makebox[2\fontcharwd\font`\x][r]{\textcolor{red}{\tiny$\m@th\hookrightarrow$}}}]% + {verbatimcontinued} +% notices/admonitions +% the dimensions for notices/admonitions are kept as macros and assigned to +% \spx@notice@border at time of use, hence \DeclareStringOption is ok for this +\newdimen\spx@notice@border +\DeclareStringOption[0.5pt]{noteborder} +\DeclareStringOption[0.5pt]{hintborder} +\DeclareStringOption[0.5pt]{importantborder} +\DeclareStringOption[0.5pt]{tipborder} +\DeclareStringOption[1pt]{warningborder} +\DeclareStringOption[1pt]{cautionborder} +\DeclareStringOption[1pt]{attentionborder} +\DeclareStringOption[1pt]{dangerborder} +\DeclareStringOption[1pt]{errorborder} +% footnotes +\DeclareStringOption[\mbox{ }]{AtStartFootnote} +% we need a public macro name for direct use in latex file +\newcommand*{\sphinxAtStartFootnote}{\spx@opt@AtStartFootnote} +% no such need for this one, as it is used inside other macros +\DeclareStringOption[\leavevmode\unskip]{BeforeFootnote} +% some font styling. +\DeclareStringOption[\sffamily\bfseries]{HeaderFamily} +% colours +% same problems as for dimensions: we want the key handler to use \definecolor. +% first, some colours with no prefix, for backwards compatibility +\newcommand*{\sphinxDeclareColorOption}[2]{% + \definecolor{#1}#2% + \define@key{sphinx}{#1}{\definecolor{#1}##1}% +}% +\sphinxDeclareColorOption{TitleColor}{{rgb}{0.126,0.263,0.361}} +\sphinxDeclareColorOption{InnerLinkColor}{{rgb}{0.208,0.374,0.486}} +\sphinxDeclareColorOption{OuterLinkColor}{{rgb}{0.216,0.439,0.388}} +\sphinxDeclareColorOption{VerbatimColor}{{rgb}{1,1,1}} +\sphinxDeclareColorOption{VerbatimBorderColor}{{rgb}{0,0,0}} +% now the colours defined with "sphinx" prefix in their names +\newcommand*{\sphinxDeclareSphinxColorOption}[2]{% + % set the initial default + \definecolor{sphinx#1}#2% + % set the key handler. The "value" ##1 must be acceptable by \definecolor. + \define@key{sphinx}{#1}{\definecolor{sphinx#1}##1}% +}% +% Default color chosen to be as in minted.sty LaTeX package! +\sphinxDeclareSphinxColorOption{VerbatimHighlightColor}{{rgb}{0.878,1,1}} +% admonition boxes, "light" style +\sphinxDeclareSphinxColorOption{noteBorderColor}{{rgb}{0,0,0}} +\sphinxDeclareSphinxColorOption{hintBorderColor}{{rgb}{0,0,0}} +\sphinxDeclareSphinxColorOption{importantBorderColor}{{rgb}{0,0,0}} +\sphinxDeclareSphinxColorOption{tipBorderColor}{{rgb}{0,0,0}} +% admonition boxes, "heavy" style +\sphinxDeclareSphinxColorOption{warningBorderColor}{{rgb}{0,0,0}} +\sphinxDeclareSphinxColorOption{cautionBorderColor}{{rgb}{0,0,0}} +\sphinxDeclareSphinxColorOption{attentionBorderColor}{{rgb}{0,0,0}} +\sphinxDeclareSphinxColorOption{dangerBorderColor}{{rgb}{0,0,0}} +\sphinxDeclareSphinxColorOption{errorBorderColor}{{rgb}{0,0,0}} +\sphinxDeclareSphinxColorOption{warningBgColor}{{rgb}{1,1,1}} +\sphinxDeclareSphinxColorOption{cautionBgColor}{{rgb}{1,1,1}} +\sphinxDeclareSphinxColorOption{attentionBgColor}{{rgb}{1,1,1}} +\sphinxDeclareSphinxColorOption{dangerBgColor}{{rgb}{1,1,1}} +\sphinxDeclareSphinxColorOption{errorBgColor}{{rgb}{1,1,1}} + +\DeclareDefaultOption{\@unknownoptionerror} +\ProcessKeyvalOptions* +% don't allow use of maxlistdepth via \sphinxsetup. +\DisableKeyvalOption{sphinx}{maxlistdepth} +\DisableKeyvalOption{sphinx}{numfigreset} +\DisableKeyvalOption{sphinx}{nonumfigreset} +\DisableKeyvalOption{sphinx}{mathnumfig} +% user interface: options can be changed midway in a document! +\newcommand\sphinxsetup[1]{\setkeys{sphinx}{#1}} + + +%% MAXLISTDEPTH +% +% remove LaTeX's cap on nesting depth if 'maxlistdepth' key used. +% This is a hack, which works with the standard classes: it assumes \@toodeep +% is always used in "true" branches: "\if ... \@toodeep \else .. \fi." + +% will force use the "false" branch (if there is one) +\def\spx@toodeep@hack{\fi\iffalse} + +% do nothing if 'maxlistdepth' key not used or if package enumitem loaded. +\ifnum\spx@opt@maxlistdepth=\z@\expandafter\@gobbletwo\fi +\AtBeginDocument{% +\@ifpackageloaded{enumitem}{\remove@to@nnil}{}% + \let\spx@toodeepORI\@toodeep + \def\@toodeep{% + \ifnum\@listdepth<\spx@opt@maxlistdepth\relax + \expandafter\spx@toodeep@hack + \else + \expandafter\spx@toodeepORI + \fi}% +% define all missing \@list... macros + \count@\@ne + \loop + \ltx@ifundefined{@list\romannumeral\the\count@} + {\iffalse}{\iftrue\advance\count@\@ne}% + \repeat + \loop + \ifnum\count@>\spx@opt@maxlistdepth\relax\else + \expandafter\let + \csname @list\romannumeral\the\count@\expandafter\endcsname + \csname @list\romannumeral\the\numexpr\count@-\@ne\endcsname + % workaround 2.6--3.2d babel-french issue (fixed in 3.2e; no change needed) + \ltx@ifundefined{leftmargin\romannumeral\the\count@} + {\expandafter\let + \csname leftmargin\romannumeral\the\count@\expandafter\endcsname + \csname leftmargin\romannumeral\the\numexpr\count@-\@ne\endcsname}{}% + \advance\count@\@ne + \repeat +% define all missing enum... counters and \labelenum... macros and \p@enum.. + \count@\@ne + \loop + \ltx@ifundefined{c@enum\romannumeral\the\count@} + {\iffalse}{\iftrue\advance\count@\@ne}% + \repeat + \loop + \ifnum\count@>\spx@opt@maxlistdepth\relax\else + \newcounter{enum\romannumeral\the\count@}% + \expandafter\def + \csname labelenum\romannumeral\the\count@\expandafter\endcsname + \expandafter + {\csname theenum\romannumeral\the\numexpr\count@\endcsname.}% + \expandafter\def + \csname p@enum\romannumeral\the\count@\expandafter\endcsname + \expandafter + {\csname p@enum\romannumeral\the\numexpr\count@-\@ne\expandafter + \endcsname\csname theenum\romannumeral\the\numexpr\count@-\@ne\endcsname.}% + \advance\count@\@ne + \repeat +% define all missing labelitem... macros + \count@\@ne + \loop + \ltx@ifundefined{labelitem\romannumeral\the\count@} + {\iffalse}{\iftrue\advance\count@\@ne}% + \repeat + \loop + \ifnum\count@>\spx@opt@maxlistdepth\relax\else + \expandafter\let + \csname labelitem\romannumeral\the\count@\expandafter\endcsname + \csname labelitem\romannumeral\the\numexpr\count@-\@ne\endcsname + \advance\count@\@ne + \repeat + \PackageInfo{sphinx}{maximal list depth extended to \spx@opt@maxlistdepth}% +\@gobble\@nnil +} + + +%% INDEX, BIBLIOGRAPHY, APPENDIX, TABLE OF CONTENTS +% +% fix the double index and bibliography on the table of contents +% in jsclasses (Japanese standard document classes) +\ifx\@jsc@uplatextrue\@undefined\else + \renewenvironment{sphinxtheindex} + {\cleardoublepage\phantomsection + \begin{theindex}} + {\end{theindex}} + + \renewenvironment{sphinxthebibliography}[1] + {\cleardoublepage% \phantomsection % not needed here since TeXLive 2010's hyperref + \begin{thebibliography}{1}} + {\end{thebibliography}} +\fi + +% disable \@chappos in Appendix in pTeX +\ifx\kanjiskip\@undefined\else + \let\py@OldAppendix=\appendix + \renewcommand{\appendix}{ + \py@OldAppendix + \gdef\@chappos{} + } +\fi + +% make commands known to non-Sphinx document classes +\providecommand*{\sphinxtableofcontents}{\tableofcontents} +\ltx@ifundefined{sphinxthebibliography} + {\newenvironment + {sphinxthebibliography}{\begin{thebibliography}}{\end{thebibliography}}% + } + {}% else clause of \ltx@ifundefined +\ltx@ifundefined{sphinxtheindex} + {\newenvironment{sphinxtheindex}{\begin{theindex}}{\end{theindex}}}% + {}% else clause of \ltx@ifundefined + + +%% COLOR (general) +% +% FIXME: \normalcolor should probably be used in place of \py@NormalColor +% elsewhere, and \py@NormalColor should never be defined. \normalcolor +% switches to the colour from last \color call in preamble. +\def\py@NormalColor{\color{black}} +% FIXME: it is probably better to use \color{TitleColor}, as TitleColor +% can be customized from 'sphinxsetup', and drop usage of \py@TitleColor +\def\py@TitleColor{\color{TitleColor}} +% FIXME: this line should be dropped, as "9" is default anyhow. +\ifdefined\pdfcompresslevel\pdfcompresslevel = 9 \fi + + +%% PAGE STYLING +% +% Style parameters and macros used by most documents here +\raggedbottom +\sloppy +\hbadness = 5000 % don't print trivial gripes + +\pagestyle{empty} % start this way + +% Redefine the 'normal' header/footer style when using "fancyhdr" package: +% Note: this presupposes "twoside". If "oneside" class option, there will be warnings. +\ltx@ifundefined{fancyhf}{}{ + % Use \pagestyle{normal} as the primary pagestyle for text. + \fancypagestyle{normal}{ + \fancyhf{} +% (for \py@HeaderFamily cf "TITLES") + \fancyfoot[LE,RO]{{\py@HeaderFamily\thepage}} + \fancyfoot[LO]{{\py@HeaderFamily\nouppercase{\rightmark}}} + \fancyfoot[RE]{{\py@HeaderFamily\nouppercase{\leftmark}}} + \fancyhead[LE,RO]{{\py@HeaderFamily \@title\sphinxheadercomma\py@release}} + \renewcommand{\headrulewidth}{0.4pt} + \renewcommand{\footrulewidth}{0.4pt} + % define chaptermark with \@chappos when \@chappos is available for Japanese + \ltx@ifundefined{@chappos}{} + {\def\chaptermark##1{\markboth{\@chapapp\space\thechapter\space\@chappos\space ##1}{}}} + } + % 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} + } +} + +% geometry +\ifx\kanjiskip\@undefined + \PassOptionsToPackage{% + hmargin={\unexpanded{\spx@opt@hmargin}},% + vmargin={\unexpanded{\spx@opt@vmargin}},% + marginpar=\unexpanded{\spx@opt@marginpar}} + {geometry} +\else + % set text width for Japanese documents to be integer multiple of 1zw + % and text height to be integer multiple of \baselineskip + % the execution is delayed to \sphinxsetup then geometry.sty + \normalsize\normalfont + \newcommand*\sphinxtextwidthja[1]{% + \if@twocolumn\tw@\fi + \dimexpr + \numexpr\dimexpr\paperwidth-\tw@\dimexpr#1\relax\relax/ + \dimexpr\if@twocolumn\tw@\else\@ne\fi zw\relax + zw\relax}% + \newcommand*\sphinxmarginparwidthja[1]{% + \dimexpr\numexpr\dimexpr#1\relax/\dimexpr1zw\relax zw\relax}% + \newcommand*\sphinxtextlinesja[1]{% + \numexpr\@ne+\dimexpr\paperheight-\topskip-\tw@\dimexpr#1\relax\relax/ + \baselineskip\relax}% + \ifx\@jsc@uplatextrue\@undefined\else + % the way we found in order for the papersize special written by + % geometry in the dvi file to be correct in case of jsbook class + \ifnum\mag=\@m\else % do nothing special if nomag class option or 10pt + \PassOptionsToPackage{truedimen}{geometry}% + \fi + \fi + \PassOptionsToPackage{% + hmarginratio={1:1},% + textwidth=\unexpanded{\sphinxtextwidthja{\spx@opt@hmargin}},% + vmarginratio={1:1},% + lines=\unexpanded{\sphinxtextlinesja{\spx@opt@vmargin}},% + marginpar=\unexpanded{\sphinxmarginparwidthja{\spx@opt@marginpar}},% + footskip=2\baselineskip,% + }{geometry}% + \AtBeginDocument + {% update a dimension used by the jsclasses + \ifx\@jsc@uplatextrue\@undefined\else\fullwidth\textwidth\fi + % for some reason, jreport normalizes all dimensions with \@settopoint + \@ifclassloaded{jreport} + {\@settopoint\textwidth\@settopoint\textheight\@settopoint\marginparwidth} + {}% <-- "false" clause of \@ifclassloaded + }% +\fi + +% fix fncychap's bug which uses prematurely the \textwidth value +\@ifpackagewith{fncychap}{Bjornstrup} + {\AtBeginDocument{\mylen\textwidth\advance\mylen-2\myhi}}% + {}% <-- "false" clause of \@ifpackagewith + + +%% TITLES +% +% Since Sphinx 1.5, users should use HeaderFamily key to 'sphinxsetup' rather +% than defining their own \py@HeaderFamily command (which is still possible). +% Memo: \py@HeaderFamily is also used by \maketitle as defined in +% sphinxmanual.cls/sphinxhowto.cls +\newcommand{\py@HeaderFamily}{\spx@opt@HeaderFamily} + +% This sets up the fancy chapter headings that make the documents look +% at least a little better than the usual LaTeX output. +\@ifpackagewith{fncychap}{Bjarne}{ + \ChNameVar {\raggedleft\normalsize \py@HeaderFamily} + \ChNumVar {\raggedleft\Large \py@HeaderFamily} + \ChTitleVar{\raggedleft\Large \py@HeaderFamily} + % This creates (numbered) chapter heads without the leading \vspace*{}: + \def\@makechapterhead#1{% + {\parindent \z@ \raggedright \normalfont + \ifnum \c@secnumdepth >\m@ne + \if@mainmatter + \DOCH + \fi + \fi + \interlinepenalty\@M + \if@mainmatter + \DOTI{#1}% + \else% + \DOTIS{#1}% + \fi + }} +}{}% <-- "false" clause of \@ifpackagewith + +% Augment the sectioning commands used to get our own font family in place, +% and reset some internal data items (\titleformat from titlesec package) +\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} +% By default paragraphs (and subsubsections) will not be numbered because +% sphinxmanual.cls and sphinxhowto.cls set secnumdepth to 2 +\titleformat{\paragraph}{\py@HeaderFamily}% + {\py@TitleColor\theparagraph}{0.5em}{\py@TitleColor}{\py@NormalColor} +\titleformat{\subparagraph}{\py@HeaderFamily}% + {\py@TitleColor\thesubparagraph}{0.5em}{\py@TitleColor}{\py@NormalColor} + + +%% GRAPHICS +% +% \sphinxincludegraphics defined to resize images larger than the line width, +% except if height or width option present. +% +% If scale is present, rescale before fitting to line width. (since 1.5) +\newbox\spx@image@box +\newcommand*{\sphinxincludegraphics}[2][]{% + \in@{height}{#1}\ifin@\else\in@{width}{#1}\fi + \ifin@ % height or width present + \includegraphics[#1]{#2}% + \else % no height nor width (but #1 may be "scale=...") + \setbox\spx@image@box\hbox{\includegraphics[#1,draft]{#2}}% + \ifdim \wd\spx@image@box>\linewidth + \setbox\spx@image@box\box\voidb@x % clear memory + \includegraphics[#1,width=\linewidth]{#2}% + \else + \includegraphics[#1]{#2}% + \fi + \fi +} + + +%% FIGURE IN TABLE +% +\newenvironment{sphinxfigure-in-table}[1][\linewidth]{% + \def\@captype{figure}% + \sphinxsetvskipsforfigintablecaption + \begin{minipage}{#1}% +}{\end{minipage}} +% store original \caption macro for use with figures in longtable and tabulary +\AtBeginDocument{\let\spx@originalcaption\caption} +\newcommand*\sphinxfigcaption + {\ifx\equation$%$% this is trick to identify tabulary first pass + \firstchoice@false\else\firstchoice@true\fi + \spx@originalcaption } +\newcommand*\sphinxsetvskipsforfigintablecaption + {\abovecaptionskip\smallskipamount + \belowcaptionskip\smallskipamount} + + +%% FOOTNOTES +% +% Support large numbered footnotes in minipage +% But now obsolete due to systematic use of \savenotes/\spewnotes +% when minipages are in use in the various macro definitions next. +\def\thempfootnote{\arabic{mpfootnote}} + + +%% NUMBERING OF FIGURES, TABLES, AND LITERAL BLOCKS +\ltx@ifundefined{c@chapter} + {\newcounter{literalblock}}% + {\newcounter{literalblock}[chapter]% + \def\theliteralblock{\ifnum\c@chapter>\z@\arabic{chapter}.\fi + \arabic{literalblock}}% + }% +\ifspx@opt@nonumfigreset + \ltx@ifundefined{c@chapter}{}{% + \@removefromreset{figure}{chapter}% + \@removefromreset{table}{chapter}% + \@removefromreset{literalblock}{chapter}% + \ifspx@opt@mathnumfig + \@removefromreset{equation}{chapter}% + \fi + }% + \def\thefigure{\arabic{figure}}% + \def\thetable {\arabic{table}}% + \def\theliteralblock{\arabic{literalblock}}% + \ifspx@opt@mathnumfig + \def\theequation{\arabic{equation}}% + \fi +\else +\let\spx@preAthefigure\@empty +\let\spx@preBthefigure\@empty +% \ifspx@opt@usespart % <-- LaTeX writer could pass such a 'usespart' boolean +% % as sphinx.sty package option +% If document uses \part, (triggered in Sphinx by latex_toplevel_sectioning) +% LaTeX core per default does not reset chapter or section +% counters at each part. +% But if we modify this, we need to redefine \thechapter, \thesection to +% include the part number and this will cause problems in table of contents +% because of too wide numbering. Simplest is to do nothing. +% \fi +\ifnum\spx@opt@numfigreset>0 + \ltx@ifundefined{c@chapter} + {} + {\g@addto@macro\spx@preAthefigure{\ifnum\c@chapter>\z@\arabic{chapter}.}% + \g@addto@macro\spx@preBthefigure{\fi}}% +\fi +\ifnum\spx@opt@numfigreset>1 + \@addtoreset{figure}{section}% + \@addtoreset{table}{section}% + \@addtoreset{literalblock}{section}% + \ifspx@opt@mathnumfig + \@addtoreset{equation}{section}% + \fi + \g@addto@macro\spx@preAthefigure{\ifnum\c@section>\z@\arabic{section}.}% + \g@addto@macro\spx@preBthefigure{\fi}% +\fi +\ifnum\spx@opt@numfigreset>2 + \@addtoreset{figure}{subsection}% + \@addtoreset{table}{subsection}% + \@addtoreset{literalblock}{subsection}% + \ifspx@opt@mathnumfig + \@addtoreset{equation}{subsection}% + \fi + \g@addto@macro\spx@preAthefigure{\ifnum\c@subsection>\z@\arabic{subsection}.}% + \g@addto@macro\spx@preBthefigure{\fi}% +\fi +\ifnum\spx@opt@numfigreset>3 + \@addtoreset{figure}{subsubsection}% + \@addtoreset{table}{subsubsection}% + \@addtoreset{literalblock}{subsubsection}% + \ifspx@opt@mathnumfig + \@addtoreset{equation}{subsubsection}% + \fi + \g@addto@macro\spx@preAthefigure{\ifnum\c@subsubsection>\z@\arabic{subsubsection}.}% + \g@addto@macro\spx@preBthefigure{\fi}% +\fi +\ifnum\spx@opt@numfigreset>4 + \@addtoreset{figure}{paragraph}% + \@addtoreset{table}{paragraph}% + \@addtoreset{literalblock}{paragraph}% + \ifspx@opt@mathnumfig + \@addtoreset{equation}{paragraph}% + \fi + \g@addto@macro\spx@preAthefigure{\ifnum\c@subparagraph>\z@\arabic{subparagraph}.}% + \g@addto@macro\spx@preBthefigure{\fi}% +\fi +\ifnum\spx@opt@numfigreset>5 + \@addtoreset{figure}{subparagraph}% + \@addtoreset{table}{subparagraph}% + \@addtoreset{literalblock}{subparagraph}% + \ifspx@opt@mathnumfig + \@addtoreset{equation}{subparagraph}% + \fi + \g@addto@macro\spx@preAthefigure{\ifnum\c@subsubparagraph>\z@\arabic{subsubparagraph}.}% + \g@addto@macro\spx@preBthefigure{\fi}% +\fi +\expandafter\g@addto@macro +\expandafter\spx@preAthefigure\expandafter{\spx@preBthefigure}% +\let\thefigure\spx@preAthefigure +\let\thetable\spx@preAthefigure +\let\theliteralblock\spx@preAthefigure +\g@addto@macro\thefigure{\arabic{figure}}% +\g@addto@macro\thetable{\arabic{table}}% +\g@addto@macro\theliteralblock{\arabic{literalblock}}% + \ifspx@opt@mathnumfig + \let\theequation\spx@preAthefigure + \g@addto@macro\theequation{\arabic{equation}}% + \fi +\fi + + +%% LITERAL BLOCKS +% +% Based on use of "fancyvrb.sty"'s Verbatim. +% - with framing allowing page breaks ("framed.sty") +% - with breaking of long lines (exploits Pygments mark-up), +% - with possibly of a top caption, non-separable by pagebreak. +% - and usable inside tables or footnotes ("footnotehyper-sphinx"). + +% For extensions which use \OriginalVerbatim and compatibility with Sphinx < +% 1.5, we define and use these when (unmodified) Verbatim will be needed. But +% Sphinx >= 1.5 does not modify the \Verbatim macro anymore. +\let\OriginalVerbatim \Verbatim +\let\endOriginalVerbatim\endVerbatim + +% for captions of literal blocks +% at start of caption title +\newcommand*{\fnum@literalblock}{\literalblockname\nobreakspace\theliteralblock} +% this will be overwritten in document preamble by Babel translation +\newcommand*{\literalblockname}{Listing } +% file extension needed for \caption's good functioning, the file is created +% only if a \listof{literalblock}{foo} command is encountered, which is +% analogous to \listoffigures, but for the code listings (foo = chosen title.) +\newcommand*{\ext@literalblock}{lol} + +\newif\ifspx@inframed % flag set if we are already in a framed environment +% if forced use of minipage encapsulation is needed (e.g. table cells) +\newif\ifsphinxverbatimwithminipage \sphinxverbatimwithminipagefalse + +% Framing macro for use with framed.sty's \FrameCommand +% - it obeys current indentation, +% - frame is \fboxsep separated from the contents, +% - the contents use the full available text width, +% - #1 = color of frame, #2 = color of background, +% - #3 = above frame, #4 = below frame, #5 = within frame, +% - #3 and #4 must be already typeset boxes; they must issue \normalcolor +% or similar, else, they are under scope of color #1 +\long\def\spx@fcolorbox #1#2#3#4#5{% + \hskip\@totalleftmargin + \hskip-\fboxsep\hskip-\fboxrule + % use of \color@b@x here is compatible with both xcolor.sty and color.sty + \color@b@x {\color{#1}\spx@CustomFBox{#3}{#4}}{\color{#2}}{#5}% + \hskip-\fboxsep\hskip-\fboxrule + \hskip-\linewidth \hskip-\@totalleftmargin \hskip\columnwidth +}% +% #1 = for material above frame, such as a caption or a "continued" hint +% #2 = for material below frame, such as a caption or "continues on next page" +% #3 = actual contents, which will be typeset with a background color +\long\def\spx@CustomFBox#1#2#3{% + \begingroup + \setbox\@tempboxa\hbox{{#3}}% inner braces to avoid color leaks + \vbox{#1% above frame + % draw frame border _latest_ to avoid pdf viewer issue + \kern\fboxrule + \hbox{\kern\fboxrule + \copy\@tempboxa + \kern-\wd\@tempboxa\kern-\fboxrule + \vrule\@width\fboxrule + \kern\wd\@tempboxa + \vrule\@width\fboxrule}% + \kern-\dimexpr\ht\@tempboxa+\dp\@tempboxa+\fboxrule\relax + \hrule\@height\fboxrule + \kern\dimexpr\ht\@tempboxa+\dp\@tempboxa\relax + \hrule\@height\fboxrule + #2% below frame + }% + \endgroup +}% +\def\spx@fcolorbox@put@c#1{% hide width from framed.sty measuring + \moveright\dimexpr\fboxrule+.5\wd\@tempboxa\hb@xt@\z@{\hss#1\hss}% +}% +\def\spx@fcolorbox@put@r#1{% right align with contents, width hidden + \moveright\dimexpr\fboxrule+\wd\@tempboxa-\fboxsep\hb@xt@\z@{\hss#1}% +}% +\def\spx@fcolorbox@put@l#1{% left align with contents, width hidden + \moveright\dimexpr\fboxrule+\fboxsep\hb@xt@\z@{#1\hss}% +}% +% +\def\sphinxVerbatim@Continued + {\csname spx@fcolorbox@put@\spx@opt@verbatimcontinuedalign\endcsname + {\normalcolor\sphinxstylecodecontinued\literalblockcontinuedname}}% +\def\sphinxVerbatim@Continues + {\csname spx@fcolorbox@put@\spx@opt@verbatimcontinuesalign\endcsname + {\normalcolor\sphinxstylecodecontinues\literalblockcontinuesname}}% +\def\sphinxVerbatim@Title + {\spx@fcolorbox@put@c{\unhcopy\sphinxVerbatim@TitleBox}}% +\let\sphinxVerbatim@Before\@empty +\let\sphinxVerbatim@After\@empty +% Defaults are redefined in document preamble according to language +\newcommand*\literalblockcontinuedname{continued from previous page}% +\newcommand*\literalblockcontinuesname{continues on next page}% +% +\def\spx@verbatimfcolorbox{\spx@fcolorbox{VerbatimBorderColor}{VerbatimColor}}% +\def\sphinxVerbatim@FrameCommand + {\spx@verbatimfcolorbox\sphinxVerbatim@Before\sphinxVerbatim@After}% +\def\sphinxVerbatim@FirstFrameCommand + {\spx@verbatimfcolorbox\sphinxVerbatim@Before\sphinxVerbatim@Continues}% +\def\sphinxVerbatim@MidFrameCommand + {\spx@verbatimfcolorbox\sphinxVerbatim@Continued\sphinxVerbatim@Continues}% +\def\sphinxVerbatim@LastFrameCommand + {\spx@verbatimfcolorbox\sphinxVerbatim@Continued\sphinxVerbatim@After}% + +% For linebreaks inside Verbatim environment from package fancyvrb. +\newbox\sphinxcontinuationbox +\newbox\sphinxvisiblespacebox +\newcommand*\sphinxafterbreak {\copy\sphinxcontinuationbox} + +% Take advantage of the already applied Pygments mark-up to insert +% potential linebreaks for TeX processing. +% {, <, #, %, $, ' and ": go to next line. +% _, }, ^, &, >, - and ~: stay at end of broken line. +% Use of \textquotesingle for straight quote. +% FIXME: convert this to package options ? +\newcommand*\sphinxbreaksbeforelist {% + \do\PYGZob\{\do\PYGZlt\<\do\PYGZsh\#\do\PYGZpc\%% {, <, #, %, + \do\PYGZdl\$\do\PYGZdq\"% $, " + \def\PYGZsq + {\discretionary{}{\sphinxafterbreak\textquotesingle}{\textquotesingle}}% ' +} +\newcommand*\sphinxbreaksafterlist {% + \do\PYGZus\_\do\PYGZcb\}\do\PYGZca\^\do\PYGZam\&% _, }, ^, &, + \do\PYGZgt\>\do\PYGZhy\-\do\PYGZti\~% >, -, ~ +} +\newcommand*\sphinxbreaksatspecials {% + \def\do##1##2% + {\def##1{\discretionary{}{\sphinxafterbreak\char`##2}{\char`##2}}}% + \sphinxbreaksbeforelist + \def\do##1##2% + {\def##1{\discretionary{\char`##2}{\sphinxafterbreak}{\char`##2}}}% + \sphinxbreaksafterlist +} + +\def\sphinx@verbatim@nolig@list {\do \`}% +% Some characters . , ; ? ! / are not pygmentized. +% This macro makes them "active" and they will insert potential linebreaks. +% Not compatible with math mode (cf \sphinxunactivateextras). +\newcommand*\sphinxbreaksbeforeactivelist {}% none +\newcommand*\sphinxbreaksafteractivelist {\do\.\do\,\do\;\do\?\do\!\do\/} +\newcommand*\sphinxbreaksviaactive {% + \def\do##1{\lccode`\~`##1% + \lowercase{\def~}{\discretionary{}{\sphinxafterbreak\char`##1}{\char`##1}}% + \catcode`##1\active}% + \sphinxbreaksbeforeactivelist + \def\do##1{\lccode`\~`##1% + \lowercase{\def~}{\discretionary{\char`##1}{\sphinxafterbreak}{\char`##1}}% + \catcode`##1\active}% + \sphinxbreaksafteractivelist + \lccode`\~`\~ +} + +% If the linebreak is at a space, the latter will be displayed as visible +% space at end of first line, and a continuation symbol starts next line. +\def\spx@verbatim@space {% + \nobreak\hskip\z@skip + \discretionary{\copy\sphinxvisiblespacebox}{\sphinxafterbreak} + {\kern\fontdimen2\font}% +}% + +% if the available space on page is less than \literalblockneedspace, insert pagebreak +\newcommand{\sphinxliteralblockneedspace}{5\baselineskip} +\newcommand{\sphinxliteralblockwithoutcaptionneedspace}{1.5\baselineskip} +% The title (caption) is specified from outside as macro \sphinxVerbatimTitle. +% \sphinxVerbatimTitle is reset to empty after each use of Verbatim. +\newcommand*\sphinxVerbatimTitle {} +% This box to typeset the caption before framed.sty multiple passes for framing. +\newbox\sphinxVerbatim@TitleBox +% This is a workaround to a "feature" of French lists, when literal block +% follows immediately; usable generally (does only \par then), a priori... +\newcommand*\sphinxvspacefixafterfrenchlists{% + \ifvmode\ifdim\lastskip<\z@ \vskip\parskip\fi\else\par\fi +} +% Holder macro for labels of literal blocks. Set-up by LaTeX writer. +\newcommand*\sphinxLiteralBlockLabel {} +\newcommand*\sphinxSetupCaptionForVerbatim [1] +{% + \sphinxvspacefixafterfrenchlists + \needspace{\sphinxliteralblockneedspace}% +% insert a \label via \sphinxLiteralBlockLabel +% reset to normal the color for the literal block caption + \def\sphinxVerbatimTitle + {\py@NormalColor\sphinxcaption{\sphinxLiteralBlockLabel #1}}% +} +\newcommand*\sphinxSetupCodeBlockInFootnote {% + \fvset{fontsize=\footnotesize}\let\caption\sphinxfigcaption + \sphinxverbatimwithminipagetrue % reduces vertical spaces + % we counteract (this is in a group) the \@normalsize from \caption + \let\normalsize\footnotesize\let\@parboxrestore\relax + \def\spx@abovecaptionskip{\sphinxverbatimsmallskipamount}% +} +% needed to create wrapper environments of fancyvrb's Verbatim +\newcommand*{\sphinxVerbatimEnvironment}{\gdef\FV@EnvironName{sphinxVerbatim}} +\newcommand*{\sphinxverbatimsmallskipamount}{\smallskipamount} +% serves to implement line highlighting and line wrapping +\newcommand\sphinxFancyVerbFormatLine[1]{% + \expandafter\sphinx@verbatim@checkifhl\expandafter{\the\FV@CodeLineNo}% + \ifin@ + \sphinxVerbatimHighlightLine{#1}% + \else + \sphinxVerbatimFormatLine{#1}% + \fi +}% +\newcommand\sphinxVerbatimHighlightLine[1]{% + \edef\sphinxrestorefboxsep{\fboxsep\the\fboxsep\relax}% + \fboxsep0pt\relax % cf LaTeX bug graphics/4524 + \colorbox{sphinxVerbatimHighlightColor}% + {\sphinxrestorefboxsep\sphinxVerbatimFormatLine{#1}}% + % no need to restore \fboxsep here, as this ends up in a \hbox from fancyvrb +}% +% \sphinxVerbatimFormatLine will be set locally to one of those two: +\newcommand\sphinxVerbatimFormatLineWrap[1]{% + \hsize\linewidth + \vtop{\raggedright\hyphenpenalty\z@\exhyphenpenalty\z@ + \doublehyphendemerits\z@\finalhyphendemerits\z@ + \strut #1\strut}% +}% +\newcommand\sphinxVerbatimFormatLineNoWrap[1]{\hb@xt@\linewidth{\strut #1\hss}}% +\g@addto@macro\FV@SetupFont{% + \sbox\sphinxcontinuationbox {\spx@opt@verbatimcontinued}% + \sbox\sphinxvisiblespacebox {\spx@opt@verbatimvisiblespace}% +}% +\newenvironment{sphinxVerbatim}{% + % first, let's check if there is a caption + \ifx\sphinxVerbatimTitle\empty + \sphinxvspacefixafterfrenchlists + \parskip\z@skip + \vskip\sphinxverbatimsmallskipamount + % there was no caption. Check if nevertheless a label was set. + \ifx\sphinxLiteralBlockLabel\empty\else + % we require some space to be sure hyperlink target from \phantomsection + % will not be separated from upcoming verbatim by a page break + \needspace{\sphinxliteralblockwithoutcaptionneedspace}% + \phantomsection\sphinxLiteralBlockLabel + \fi + \else + \parskip\z@skip + \if t\spx@opt@literalblockcappos + \vskip\spx@abovecaptionskip + \def\sphinxVerbatim@Before + {\sphinxVerbatim@Title\nointerlineskip + \kern\dimexpr-\dp\strutbox+\sphinxbelowcaptionspace\relax}% + \else + \vskip\sphinxverbatimsmallskipamount + \def\sphinxVerbatim@After + {\nointerlineskip\kern\dp\strutbox\sphinxVerbatim@Title}% + \fi + \def\@captype{literalblock}% + \capstart + % \sphinxVerbatimTitle must reset color + \setbox\sphinxVerbatim@TitleBox + \hbox{\begin{minipage}{\linewidth}% + \sphinxVerbatimTitle + \end{minipage}}% + \fi + \global\let\sphinxLiteralBlockLabel\empty + \global\let\sphinxVerbatimTitle\empty + \fboxsep\sphinxverbatimsep \fboxrule\sphinxverbatimborder + \ifspx@opt@verbatimwithframe\else\fboxrule\z@\fi + \let\FrameCommand \sphinxVerbatim@FrameCommand + \let\FirstFrameCommand\sphinxVerbatim@FirstFrameCommand + \let\MidFrameCommand \sphinxVerbatim@MidFrameCommand + \let\LastFrameCommand \sphinxVerbatim@LastFrameCommand + \ifspx@opt@verbatimhintsturnover\else + \let\sphinxVerbatim@Continued\@empty + \let\sphinxVerbatim@Continues\@empty + \fi + \ifspx@opt@verbatimwrapslines + % fancyvrb's Verbatim puts each input line in (unbreakable) horizontal boxes. + % This customization wraps each line from the input in a \vtop, thus + % allowing it to wrap and display on two or more lines in the latex output. + % - The codeline counter will be increased only once. + % - The wrapped material will not break across pages, it is impossible + % to achieve this without extensive rewrite of fancyvrb. + % - The (not used in sphinx) obeytabs option to Verbatim is + % broken by this change (showtabs and tabspace work). + \let\sphinxVerbatimFormatLine\sphinxVerbatimFormatLineWrap + \let\FV@Space\spx@verbatim@space + % Allow breaks at special characters using \PYG... macros. + \sphinxbreaksatspecials + % Breaks at punctuation characters . , ; ? ! and / (needs catcode activation) + \fvset{codes*=\sphinxbreaksviaactive}% + \else % end of conditional code for wrapping long code lines + \let\sphinxVerbatimFormatLine\sphinxVerbatimFormatLineNoWrap + \fi + \let\FancyVerbFormatLine\sphinxFancyVerbFormatLine + % workaround to fancyvrb's check of \@currenvir + \let\VerbatimEnvironment\sphinxVerbatimEnvironment + % workaround to fancyvrb's check of current list depth + \def\@toodeep {\advance\@listdepth\@ne}% + % The list environment is needed to control perfectly the vertical space. + % Note: \OuterFrameSep used by framed.sty is later set to \topsep hence 0pt. + % - if caption: distance from last text baseline to caption baseline is + % A+(B-F)+\ht\strutbox, A = \abovecaptionskip (default 10pt), B = + % \baselineskip, F is the framed.sty \FrameHeightAdjust macro, default 6pt. + % Formula valid for F < 10pt. + % - distance of baseline of caption to top of frame is like for tables: + % \sphinxbelowcaptionspace (=0.5\baselineskip) + % - if no caption: distance of last text baseline to code frame is S+(B-F), + % with S = \sphinxverbatimtopskip (=\smallskip) + % - and distance from bottom of frame to next text baseline is + % \baselineskip+\parskip. + % The \trivlist is used to avoid possible "too deeply nested" error. + \itemsep \z@skip + \topsep \z@skip + \partopsep \z@skip + % trivlist will set \parsep to \parskip = zero + % \leftmargin will be set to zero by trivlist + \rightmargin\z@ + \parindent \z@% becomes \itemindent. Default zero, but perhaps overwritten. + \trivlist\item\relax + \ifsphinxverbatimwithminipage\spx@inframedtrue\fi + % use a minipage if we are already inside a framed environment + \ifspx@inframed\noindent\begin{minipage}{\linewidth}\fi + \MakeFramed {% adapted over from framed.sty's snugshade environment + \advance\hsize-\width\@totalleftmargin\z@\linewidth\hsize\@setminipage + }% + % For grid placement from \strut's in \FancyVerbFormatLine + \lineskip\z@skip + % active comma should not be overwritten by \@noligs + \ifspx@opt@verbatimwrapslines + \let\verbatim@nolig@list \sphinx@verbatim@nolig@list + \fi + % will fetch its optional arguments if any + \OriginalVerbatim +} +{% + \endOriginalVerbatim + \par\unskip\@minipagefalse\endMakeFramed % from framed.sty snugshade + \ifspx@inframed\end{minipage}\fi + \endtrivlist +} +\newenvironment {sphinxVerbatimNoFrame} + {\spx@opt@verbatimwithframefalse + % needed for fancyvrb as literal code will end in \end{sphinxVerbatimNoFrame} + \def\sphinxVerbatimEnvironment{\gdef\FV@EnvironName{sphinxVerbatimNoFrame}}% + \begin{sphinxVerbatim}} + {\end{sphinxVerbatim}} +\newenvironment {sphinxVerbatimintable} + {% don't use a frame if in a table cell + \spx@opt@verbatimwithframefalse + \sphinxverbatimwithminipagetrue + % the literal block caption uses \sphinxcaption which is wrapper of \caption, + % but \caption must be modified because longtable redefines it to work only + % for the own table caption, and tabulary has multiple passes + \let\caption\sphinxfigcaption + % reduce above caption skip + \def\spx@abovecaptionskip{\sphinxverbatimsmallskipamount}% + \def\sphinxVerbatimEnvironment{\gdef\FV@EnvironName{sphinxVerbatimintable}}% + \begin{sphinxVerbatim}} + {\end{sphinxVerbatim}} + + +%% PARSED LITERALS +% allow long lines to wrap like they do in code-blocks + +% this should be kept in sync with definitions in sphinx.util.texescape +\newcommand*\sphinxbreaksattexescapedchars{% + \def\do##1##2% put potential break point before character + {\def##1{\discretionary{}{\sphinxafterbreak\char`##2}{\char`##2}}}% + \do\{\{\do\textless\<\do\#\#\do\%\%\do\$\$% {, <, #, %, $ + \def\do##1##2% put potential break point after character + {\def##1{\discretionary{\char`##2}{\sphinxafterbreak}{\char`##2}}}% + \do\_\_\do\}\}\do\textasciicircum\^\do\&\&% _, }, ^, &, + \do\textgreater\>\do\textasciitilde\~% >, ~ +} +\newcommand*\sphinxbreaksviaactiveinparsedliteral{% + \sphinxbreaksviaactive % by default handles . , ; ? ! / + \do\-% we need also the hyphen character (ends up "as is" in parsed-literal) + \lccode`\~`\~ % + % update \dospecials as it is used by \url + % but deactivation will already have been done hence this is unneeded: + % \expandafter\def\expandafter\dospecials\expandafter{\dospecials + % \sphinxbreaksbeforeactivelist\sphinxbreaksafteractivelist\do\-}% +} +\newcommand*\sphinxbreaksatspaceinparsedliteral{% + \lccode`~32 \lowercase{\let~}\spx@verbatim@space\lccode`\~`\~ +} +\newcommand*{\sphinxunactivateextras}{\let\do\@makeother + \sphinxbreaksbeforeactivelist\sphinxbreaksafteractivelist\do\-}% +% the \catcode13=5\relax (deactivate end of input lines) is left to callers +\newcommand*{\sphinxunactivateextrasandspace}{\catcode32=10\relax + \sphinxunactivateextras}% +% now for the modified alltt environment +\newenvironment{sphinxalltt} +{% at start of next line to workaround Emacs/AUCTeX issue with this file +\begin{alltt}% + \ifspx@opt@parsedliteralwraps + \sbox\sphinxcontinuationbox {\spx@opt@verbatimcontinued}% + \sbox\sphinxvisiblespacebox {\spx@opt@verbatimvisiblespace}% + \sphinxbreaksattexescapedchars + \sphinxbreaksviaactiveinparsedliteral + \sphinxbreaksatspaceinparsedliteral +% alltt takes care of the ' as derivative ("prime") in math mode + \everymath\expandafter{\the\everymath\sphinxunactivateextrasandspace + \catcode`\<=12\catcode`\>=12\catcode`\^=7\catcode`\_=8 }% +% not sure if displayed math (align,...) can end up in parsed-literal, anyway + \everydisplay\expandafter{\the\everydisplay + \catcode13=5 \sphinxunactivateextrasandspace + \catcode`\<=12\catcode`\>=12\catcode`\^=7\catcode`\_=8 }% + \fi } +{\end{alltt}} + +% Protect \href's first argument in contexts such as sphinxalltt (or +% \sphinxcode). Sphinx uses \#, \%, \& ... always inside \sphinxhref. +\protected\def\sphinxhref#1#2{{% + \sphinxunactivateextrasandspace % never do \scantokens with active space! + \endlinechar\m@ne\everyeof{{#2}}% keep catcode regime for #2 + \scantokens{\href{#1}}% normalise it for #1 during \href expansion +}} +% Same for \url. And also \nolinkurl for coherence. +\protected\def\sphinxurl#1{{% + \sphinxunactivateextrasandspace\everyeof{}% (<- precaution for \scantokens) + \endlinechar\m@ne\scantokens{\url{#1}}% +}} +\protected\def\sphinxnolinkurl#1{{% + \sphinxunactivateextrasandspace\everyeof{}% + \endlinechar\m@ne\scantokens{\nolinkurl{#1}}% +}} + + +%% TOPIC AND CONTENTS BOXES +% +% Again based on use of "framed.sty", this allows breakable framed boxes. +\long\def\spx@ShadowFBox#1{% + \leavevmode\begingroup + % first we frame the box #1 + \setbox\@tempboxa + \hbox{\vrule\@width\sphinxshadowrule + \vbox{\hrule\@height\sphinxshadowrule + \kern\sphinxshadowsep + \hbox{\kern\sphinxshadowsep #1\kern\sphinxshadowsep}% + \kern\sphinxshadowsep + \hrule\@height\sphinxshadowrule}% + \vrule\@width\sphinxshadowrule}% + % Now we add the shadow, like \shadowbox from fancybox.sty would do + \dimen@\dimexpr.5\sphinxshadowrule+\sphinxshadowsize\relax + \hbox{\vbox{\offinterlineskip + \hbox{\copy\@tempboxa\kern-.5\sphinxshadowrule + % add shadow on right side + \lower\sphinxshadowsize + \hbox{\vrule\@height\ht\@tempboxa \@width\dimen@}% + }% + \kern-\dimen@ % shift back vertically to bottom of frame + % and add shadow at bottom + \moveright\sphinxshadowsize + \vbox{\hrule\@width\wd\@tempboxa \@height\dimen@}% + }% + % move left by the size of right shadow so shadow adds no width + \kern-\sphinxshadowsize + }% + \endgroup +} + +% use framed.sty to allow page breaks in frame+shadow +% works well inside Lists and Quote-like environments +% produced by ``topic'' directive (or local contents) +% could nest if LaTeX writer authorized it +\newenvironment{sphinxShadowBox} + {\def\FrameCommand {\spx@ShadowFBox }% + % configure framed.sty not to add extra vertical spacing + \ltx@ifundefined{OuterFrameSep}{}{\OuterFrameSep\z@skip}% + % the \trivlist will add the vertical spacing on top and bottom which is + % typical of center environment as used in Sphinx <= 1.4.1 + % the \noindent has the effet of an extra blank line on top, to + % imitate closely the layout from Sphinx <= 1.4.1; the \FrameHeightAdjust + % will put top part of frame on this baseline. + \def\FrameHeightAdjust {\baselineskip}% + % use package footnote to handle footnotes + \savenotes + \trivlist\item\noindent + % use a minipage if we are already inside a framed environment + \ifspx@inframed\begin{minipage}{\linewidth}\fi + \MakeFramed {\spx@inframedtrue + % framed.sty puts into "\width" the added width (=2shadowsep+2shadowrule) + % adjust \hsize to what the contents must use + \advance\hsize-\width + % adjust LaTeX parameters to behave properly in indented/quoted contexts + \FrameRestore + % typeset the contents as in a minipage (Sphinx <= 1.4.1 used a minipage and + % itemize/enumerate are therein typeset more tightly, we want to keep + % that). We copy-paste from LaTeX source code but don't do a real minipage. + \@pboxswfalse + \let\@listdepth\@mplistdepth \@mplistdepth\z@ + \@minipagerestore + \@setminipage + }% + }% + {% insert the "endminipage" code + \par\unskip + \@minipagefalse + \endMakeFramed + \ifspx@inframed\end{minipage}\fi + \endtrivlist + % output the stored footnotes + \spewnotes + } + + +%% NOTICES AND ADMONITIONS +% +% Some are quite plain +% the spx@notice@bordercolor etc are set in the sphinxadmonition environment +\newenvironment{sphinxlightbox}{% + \par\allowbreak + \noindent{\color{spx@notice@bordercolor}% + \rule{\linewidth}{\spx@notice@border}}\par\nobreak + {\parskip\z@skip\noindent}% + } + {% + % counteract previous possible negative skip (French lists!): + % (we can't cancel that any earlier \vskip introduced a potential pagebreak) + \sphinxvspacefixafterfrenchlists + \nobreak\vbox{\noindent\kern\@totalleftmargin + {\color{spx@notice@bordercolor}% + \rule[\dimexpr.4\baselineskip-\spx@notice@border\relax] + {\linewidth}{\spx@notice@border}}\hss}\allowbreak + }% end of sphinxlightbox environment definition +% may be renewenvironment'd by user for complete customization +\newenvironment{sphinxnote}[1] + {\begin{sphinxlightbox}\sphinxstrong{#1} }{\end{sphinxlightbox}} +\newenvironment{sphinxhint}[1] + {\begin{sphinxlightbox}\sphinxstrong{#1} }{\end{sphinxlightbox}} +\newenvironment{sphinximportant}[1] + {\begin{sphinxlightbox}\sphinxstrong{#1} }{\end{sphinxlightbox}} +\newenvironment{sphinxtip}[1] + {\begin{sphinxlightbox}\sphinxstrong{#1} }{\end{sphinxlightbox}} +% or just use the package options +% these are needed for common handling by notice environment of lightbox +% and heavybox but they are currently not used by lightbox environment +% and there is consequently no corresponding package option +\definecolor{sphinxnoteBgColor}{rgb}{1,1,1} +\definecolor{sphinxhintBgColor}{rgb}{1,1,1} +\definecolor{sphinximportantBgColor}{rgb}{1,1,1} +\definecolor{sphinxtipBgColor}{rgb}{1,1,1} + +% Others get more distinction +% Code adapted from framed.sty's "snugshade" environment. +% Nesting works (inner frames do not allow page breaks). +\newenvironment{sphinxheavybox}{\par + \setlength{\FrameRule}{\spx@notice@border}% + \setlength{\FrameSep}{\dimexpr.6\baselineskip-\FrameRule\relax} + % configure framed.sty's parameters to obtain same vertical spacing + % as for "light" boxes. We need for this to manually insert parskip glue and + % revert a skip done by framed before the frame. + \ltx@ifundefined{OuterFrameSep}{}{\OuterFrameSep\z@skip}% + \vspace{\FrameHeightAdjust} + % copied/adapted from framed.sty's snugshade + \def\FrameCommand##1{\hskip\@totalleftmargin + \fboxsep\FrameSep \fboxrule\FrameRule + \fcolorbox{spx@notice@bordercolor}{spx@notice@bgcolor}{##1}% + \hskip-\linewidth \hskip-\@totalleftmargin \hskip\columnwidth}% + \savenotes + % use a minipage if we are already inside a framed environment + \ifspx@inframed + \noindent\begin{minipage}{\linewidth} + \else + % handle case where notice is first thing in a list item (or is quoted) + \if@inlabel + \noindent\par\vspace{-\baselineskip} + \else + \vspace{\parskip} + \fi + \fi + \MakeFramed {\spx@inframedtrue + \advance\hsize-\width \@totalleftmargin\z@ \linewidth\hsize + % minipage initialization copied from LaTeX source code. + \@pboxswfalse + \let\@listdepth\@mplistdepth \@mplistdepth\z@ + \@minipagerestore + \@setminipage }% + } + {% + \par\unskip + \@minipagefalse + \endMakeFramed + \ifspx@inframed\end{minipage}\fi + % set footnotes at bottom of page + \spewnotes + % arrange for similar spacing below frame as for "light" boxes. + \vskip .4\baselineskip + }% end of sphinxheavybox environment definition +% may be renewenvironment'd by user for complete customization +\newenvironment{sphinxwarning}[1] + {\begin{sphinxheavybox}\sphinxstrong{#1} }{\end{sphinxheavybox}} +\newenvironment{sphinxcaution}[1] + {\begin{sphinxheavybox}\sphinxstrong{#1} }{\end{sphinxheavybox}} +\newenvironment{sphinxattention}[1] + {\begin{sphinxheavybox}\sphinxstrong{#1} }{\end{sphinxheavybox}} +\newenvironment{sphinxdanger}[1] + {\begin{sphinxheavybox}\sphinxstrong{#1} }{\end{sphinxheavybox}} +\newenvironment{sphinxerror}[1] + {\begin{sphinxheavybox}\sphinxstrong{#1} }{\end{sphinxheavybox}} +% or just use package options + +% the \colorlet of xcolor (if at all loaded) is overkill for our use case +\newcommand{\sphinxcolorlet}[2] + {\expandafter\let\csname\@backslashchar color@#1\expandafter\endcsname + \csname\@backslashchar color@#2\endcsname } + +% the main dispatch for all types of notices +\newenvironment{sphinxadmonition}[2]{% #1=type, #2=heading + % can't use #1 directly in definition of end part + \def\spx@noticetype {#1}% + % set parameters of heavybox/lightbox + \sphinxcolorlet{spx@notice@bordercolor}{sphinx#1BorderColor}% + \sphinxcolorlet{spx@notice@bgcolor}{sphinx#1BgColor}% + \spx@notice@border \dimexpr\csname spx@opt@#1border\endcsname\relax + % start specific environment, passing the heading as argument + \begin{sphinx#1}{#2}} + % workaround some LaTeX "feature" of \end command + {\edef\spx@temp{\noexpand\end{sphinx\spx@noticetype}}\spx@temp} + + +%% PYTHON DOCS MACROS AND ENVIRONMENTS +% (some macros here used by \maketitle in sphinxmanual.cls and sphinxhowto.cls) + +% \moduleauthor{name}{email} +\newcommand{\moduleauthor}[2]{} + +% \sectionauthor{name}{email} +\newcommand{\sectionauthor}[2]{} + +% 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}{\releasename\space\version} +\newcommand{\version}{}% part of \py@release, used by title page and headers +% \releaseinfo is used on titlepage (sphinxmanual.cls, sphinxhowto.cls) +\newcommand{\releaseinfo}{} +\newcommand{\setreleaseinfo}[1]{\renewcommand{\releaseinfo}{#1}} +% this is inserted via template and #1=release config variable +\newcommand{\release}[1]{\renewcommand{\version}{#1}} +% this is defined by template to 'releasename' latex_elements key +\newcommand{\releasename}{} +% Fix issue in case release and releasename deliberately left blank +\newcommand{\sphinxheadercomma}{, }% used in fancyhdr header definition +\newcommand{\sphinxifemptyorblank}[1]{% +% test after one expansion of macro #1 if contents is empty or spaces + \if&\expandafter\@firstofone\detokenize\expandafter{#1}&% + \expandafter\@firstoftwo\else\expandafter\@secondoftwo\fi}% +\AtBeginDocument {% + \sphinxifemptyorblank{\releasename} + {\sphinxifemptyorblank{\version}{\let\sphinxheadercomma\empty}{}} + {}% +}% + +% 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}} + +% {fulllineitems} is the main environment for object descriptions. +% +\newcommand{\py@itemnewline}[1]{% + \kern\labelsep + \@tempdima\linewidth + \advance\@tempdima \labelwidth\makebox[\@tempdima][l]{#1}% + \kern-\labelsep +} + +\newenvironment{fulllineitems}{% + \begin{list}{}{\labelwidth \leftmargin + \rightmargin \z@ \topsep -\parskip \partopsep \parskip + \itemsep -\parsep + \let\makelabel=\py@itemnewline}% +}{\end{list}} + +% Signatures, possibly multi-line +% +\newlength{\py@argswidth} +\newcommand{\py@sigparams}[2]{% + \parbox[t]{\py@argswidth}{#1\sphinxcode{)}#2}} +\newcommand{\pysigline}[1]{\item[{#1}]} +\newcommand{\pysiglinewithargsret}[3]{% + \settowidth{\py@argswidth}{#1\sphinxcode{(}}% + \addtolength{\py@argswidth}{-2\py@argswidth}% + \addtolength{\py@argswidth}{\linewidth}% + \item[{#1\sphinxcode{(}\py@sigparams{#2}{#3}}]} +\newcommand{\pysigstartmultiline}{% + \def\pysigstartmultiline{\vskip\smallskipamount\parskip\z@skip\itemsep\z@skip}% + \edef\pysigstopmultiline + {\noexpand\leavevmode\parskip\the\parskip\relax\itemsep\the\itemsep\relax}% + \parskip\z@skip\itemsep\z@skip +} + +% Production lists +% +\newenvironment{productionlist}{% +% \def\sphinxoptional##1{{\Large[}##1{\Large]}} + \def\production##1##2{\\\sphinxcode{\sphinxupquote{##1}}&::=&\sphinxcode{\sphinxupquote{##2}}}% + \def\productioncont##1{\\& &\sphinxcode{\sphinxupquote{##1}}}% + \parindent=2em + \indent + \setlength{\LTpre}{0pt}% + \setlength{\LTpost}{0pt}% + \begin{longtable}[l]{lcl} +}{% + \end{longtable} +} + +% 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}% +} + +%% FROM DOCTUTILS LATEX WRITER +% +% The following is stuff copied from docutils' latex writer. +% +\newcommand{\optionlistlabel}[1]{\normalfont\bfseries #1 \hfill}% \bf deprecated +\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\relax} + \raggedright} +{\end{list}} + +% From docutils.writers.latex2e +% inline markup (custom roles) +% \DUrole{#1}{#2} tries \DUrole#1{#2} +\providecommand*{\DUrole}[2]{% + \ifcsname DUrole\detokenize{#1}\endcsname + \csname DUrole\detokenize{#1}\endcsname{#2}% + \else% backwards compatibility: try \docutilsrole#1{#2} + \ifcsname docutilsrole\detokenize{#1}\endcsname + \csname docutilsrole\detokenize{#1}\endcsname{#2}% + \else + #2% + \fi + \fi +} + +\providecommand*{\DUprovidelength}[2]{% + \ifdefined#1\else\newlength{#1}\setlength{#1}{#2}\fi +} + +\DUprovidelength{\DUlineblockindent}{2.5em} +\ifdefined\DUlineblock\else + \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} +\fi + +%% TEXT STYLING +% +% to obtain straight quotes we execute \@noligs as patched by upquote, and +% \scantokens is needed in cases where it would be too late for the macro to +% first set catcodes and then fetch its argument. We also make the contents +% breakable at non-escaped . , ; ? ! / using \sphinxbreaksviaactive. +% the macro must be protected if it ends up used in moving arguments, +% in 'alltt' \@noligs is done already, and the \scantokens must be avoided. +\protected\def\sphinxupquote#1{{\def\@tempa{alltt}% + \ifx\@tempa\@currenvir\else + \ifspx@opt@inlineliteralwraps + \sphinxbreaksviaactive\let\sphinxafterbreak\empty + % do not overwrite the comma set-up + \let\verbatim@nolig@list\sphinx@literal@nolig@list + \fi + % fix a space-gobbling issue due to LaTeX's original \do@noligs + \let\do@noligs\sphinx@do@noligs + \@noligs\endlinechar\m@ne\everyeof{}% (<- in case inside \sphinxhref) + \expandafter\scantokens + \fi {{#1}}}}% extra brace pair to fix end-space gobbling issue... +\def\sphinx@do@noligs #1{\catcode`#1\active\begingroup\lccode`\~`#1\relax + \lowercase{\endgroup\def~{\leavevmode\kern\z@\char`#1 }}} +\def\sphinx@literal@nolig@list {\do\`\do\<\do\>\do\'\do\-}% + +% Some custom font markup commands. +\protected\def\sphinxstrong#1{\textbf{#1}} +\protected\def\sphinxcode#1{\texttt{#1}} +\protected\def\sphinxbfcode#1{\textbf{\sphinxcode{#1}}} +\protected\def\sphinxemail#1{\textsf{#1}} +\protected\def\sphinxtablecontinued#1{\textsf{#1}} +\protected\def\sphinxtitleref#1{\emph{#1}} +\protected\def\sphinxmenuselection#1{\emph{#1}} +\protected\def\sphinxaccelerator#1{\underline{#1}} +\protected\def\sphinxcrossref#1{\emph{#1}} +\protected\def\sphinxtermref#1{\emph{#1}} +% \optional is used for ``[, arg]``, i.e. desc_optional nodes. +\long\protected\def\sphinxoptional#1{% + {\textnormal{\Large[}}{#1}\hspace{0.5mm}{\textnormal{\Large]}}} + +% additional customizable styling +% FIXME: convert this to package options ? +\protected\def\sphinxstyleindexentry #1{\texttt{#1}} +\protected\def\sphinxstyleindexextra #1{ \emph{(#1)}} +\protected\def\sphinxstyleindexpageref #1{, \pageref{#1}} +\protected\def\sphinxstyletopictitle #1{\textbf{#1}\par\medskip} +\let\sphinxstylesidebartitle\sphinxstyletopictitle +\protected\def\sphinxstyleothertitle #1{\textbf{#1}} +\protected\def\sphinxstylesidebarsubtitle #1{~\\\textbf{#1} \smallskip} +% \text.. commands do not allow multiple paragraphs +\protected\def\sphinxstyletheadfamily {\sffamily} +\protected\def\sphinxstyleemphasis #1{\emph{#1}} +\protected\def\sphinxstyleliteralemphasis#1{\emph{\sphinxcode{#1}}} +\protected\def\sphinxstylestrong #1{\textbf{#1}} +\protected\def\sphinxstyleliteralstrong#1{\sphinxbfcode{#1}} +\protected\def\sphinxstyleabbreviation #1{\textsc{#1}} +\protected\def\sphinxstyleliteralintitle#1{\sphinxcode{#1}} +\newcommand*\sphinxstylecodecontinued[1]{\footnotesize(#1)}% +\newcommand*\sphinxstylecodecontinues[1]{\footnotesize(#1)}% +% figure legend comes after caption and may contain arbitrary body elements +\newenvironment{sphinxlegend}{\par\small}{\par} + +% Declare Unicode characters used by linux tree command to pdflatex utf8/utf8x +\def\spx@bd#1#2{% + \leavevmode + \begingroup + \ifx\spx@bd@height \@undefined\def\spx@bd@height{\baselineskip}\fi + \ifx\spx@bd@width \@undefined\setbox0\hbox{0}\def\spx@bd@width{\wd0 }\fi + \ifx\spx@bd@thickness\@undefined\def\spx@bd@thickness{.6\p@}\fi + \ifx\spx@bd@lower \@undefined\def\spx@bd@lower{\dp\strutbox}\fi + \lower\spx@bd@lower#1{#2}% + \endgroup +}% +\@namedef{sphinx@u2500}% BOX DRAWINGS LIGHT HORIZONTAL + {\spx@bd{\vbox to\spx@bd@height} + {\vss\hrule\@height\spx@bd@thickness + \@width\spx@bd@width\vss}}% +\@namedef{sphinx@u2502}% BOX DRAWINGS LIGHT VERTICAL + {\spx@bd{\hb@xt@\spx@bd@width} + {\hss\vrule\@height\spx@bd@height + \@width \spx@bd@thickness\hss}}% +\@namedef{sphinx@u2514}% BOX DRAWINGS LIGHT UP AND RIGHT + {\spx@bd{\hb@xt@\spx@bd@width} + {\hss\raise.5\spx@bd@height + \hb@xt@\z@{\hss\vrule\@height.5\spx@bd@height + \@width \spx@bd@thickness\hss}% + \vbox to\spx@bd@height{\vss\hrule\@height\spx@bd@thickness + \@width.5\spx@bd@width\vss}}}% +\@namedef{sphinx@u251C}% BOX DRAWINGS LIGHT VERTICAL AND RIGHT + {\spx@bd{\hb@xt@\spx@bd@width} + {\hss + \hb@xt@\z@{\hss\vrule\@height\spx@bd@height + \@width \spx@bd@thickness\hss}% + \vbox to\spx@bd@height{\vss\hrule\@height\spx@bd@thickness + \@width.5\spx@bd@width\vss}}}% +\protected\def\sphinxunichar#1{\@nameuse{sphinx@u#1}}% + +% Tell TeX about pathological hyphenation cases: +\hyphenation{Base-HTTP-Re-quest-Hand-ler} +\endinput diff --git a/doc/build/latex/sphinxhighlight.sty b/doc/build/latex/sphinxhighlight.sty new file mode 100644 index 0000000..77c7e2c --- /dev/null +++ b/doc/build/latex/sphinxhighlight.sty @@ -0,0 +1,105 @@ +\NeedsTeXFormat{LaTeX2e}[1995/12/01] +\ProvidesPackage{sphinxhighlight}[2016/05/29 stylesheet for highlighting with pygments] + + +\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}} + +\expandafter\def\csname PYG@tok@gd\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.63,0.00,0.00}{##1}}} +\expandafter\def\csname PYG@tok@gu\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.50,0.00,0.50}{##1}}} +\expandafter\def\csname PYG@tok@gt\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.27,0.87}{##1}}} +\expandafter\def\csname PYG@tok@gs\endcsname{\let\PYG@bf=\textbf} +\expandafter\def\csname PYG@tok@gr\endcsname{\def\PYG@tc##1{\textcolor[rgb]{1.00,0.00,0.00}{##1}}} +\expandafter\def\csname PYG@tok@cm\endcsname{\let\PYG@it=\textit\def\PYG@tc##1{\textcolor[rgb]{0.25,0.50,0.56}{##1}}} +\expandafter\def\csname PYG@tok@vg\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.73,0.38,0.84}{##1}}} +\expandafter\def\csname PYG@tok@vi\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.73,0.38,0.84}{##1}}} +\expandafter\def\csname PYG@tok@vm\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.73,0.38,0.84}{##1}}} +\expandafter\def\csname PYG@tok@mh\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}} +\expandafter\def\csname PYG@tok@cs\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.50,0.56}{##1}}\def\PYG@bc##1{\setlength{\fboxsep}{0pt}\colorbox[rgb]{1.00,0.94,0.94}{\strut ##1}}} +\expandafter\def\csname PYG@tok@ge\endcsname{\let\PYG@it=\textit} +\expandafter\def\csname PYG@tok@vc\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.73,0.38,0.84}{##1}}} +\expandafter\def\csname PYG@tok@il\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}} +\expandafter\def\csname PYG@tok@go\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.20,0.20,0.20}{##1}}} +\expandafter\def\csname PYG@tok@cp\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}} +\expandafter\def\csname PYG@tok@gi\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.63,0.00}{##1}}} +\expandafter\def\csname PYG@tok@gh\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.00,0.50}{##1}}} +\expandafter\def\csname PYG@tok@ni\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.84,0.33,0.22}{##1}}} +\expandafter\def\csname PYG@tok@nl\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.13,0.44}{##1}}} +\expandafter\def\csname PYG@tok@nn\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.05,0.52,0.71}{##1}}} +\expandafter\def\csname PYG@tok@no\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.38,0.68,0.84}{##1}}} +\expandafter\def\csname PYG@tok@na\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}} +\expandafter\def\csname PYG@tok@nb\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}} +\expandafter\def\csname PYG@tok@nc\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.05,0.52,0.71}{##1}}} +\expandafter\def\csname PYG@tok@nd\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.33,0.33,0.33}{##1}}} +\expandafter\def\csname PYG@tok@ne\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}} +\expandafter\def\csname PYG@tok@nf\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.02,0.16,0.49}{##1}}} +\expandafter\def\csname PYG@tok@si\endcsname{\let\PYG@it=\textit\def\PYG@tc##1{\textcolor[rgb]{0.44,0.63,0.82}{##1}}} +\expandafter\def\csname PYG@tok@s2\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}} +\expandafter\def\csname PYG@tok@nt\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.02,0.16,0.45}{##1}}} +\expandafter\def\csname PYG@tok@nv\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.73,0.38,0.84}{##1}}} +\expandafter\def\csname PYG@tok@s1\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}} +\expandafter\def\csname PYG@tok@dl\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}} +\expandafter\def\csname PYG@tok@ch\endcsname{\let\PYG@it=\textit\def\PYG@tc##1{\textcolor[rgb]{0.25,0.50,0.56}{##1}}} +\expandafter\def\csname PYG@tok@m\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}} +\expandafter\def\csname PYG@tok@gp\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.78,0.36,0.04}{##1}}} +\expandafter\def\csname PYG@tok@sh\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}} +\expandafter\def\csname PYG@tok@ow\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}} +\expandafter\def\csname PYG@tok@sx\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.78,0.36,0.04}{##1}}} +\expandafter\def\csname PYG@tok@bp\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}} +\expandafter\def\csname PYG@tok@c1\endcsname{\let\PYG@it=\textit\def\PYG@tc##1{\textcolor[rgb]{0.25,0.50,0.56}{##1}}} +\expandafter\def\csname PYG@tok@fm\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.02,0.16,0.49}{##1}}} +\expandafter\def\csname PYG@tok@o\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.40,0.40,0.40}{##1}}} +\expandafter\def\csname PYG@tok@kc\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}} +\expandafter\def\csname PYG@tok@c\endcsname{\let\PYG@it=\textit\def\PYG@tc##1{\textcolor[rgb]{0.25,0.50,0.56}{##1}}} +\expandafter\def\csname PYG@tok@mf\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}} +\expandafter\def\csname PYG@tok@err\endcsname{\def\PYG@bc##1{\setlength{\fboxsep}{0pt}\fcolorbox[rgb]{1.00,0.00,0.00}{1,1,1}{\strut ##1}}} +\expandafter\def\csname PYG@tok@mb\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}} +\expandafter\def\csname PYG@tok@ss\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.32,0.47,0.09}{##1}}} +\expandafter\def\csname PYG@tok@sr\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.14,0.33,0.53}{##1}}} +\expandafter\def\csname PYG@tok@mo\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}} +\expandafter\def\csname PYG@tok@kd\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}} +\expandafter\def\csname PYG@tok@mi\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}} +\expandafter\def\csname PYG@tok@kn\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}} +\expandafter\def\csname PYG@tok@cpf\endcsname{\let\PYG@it=\textit\def\PYG@tc##1{\textcolor[rgb]{0.25,0.50,0.56}{##1}}} +\expandafter\def\csname PYG@tok@kr\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}} +\expandafter\def\csname PYG@tok@s\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}} +\expandafter\def\csname PYG@tok@kp\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}} +\expandafter\def\csname PYG@tok@w\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.73,0.73,0.73}{##1}}} +\expandafter\def\csname PYG@tok@kt\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.56,0.13,0.00}{##1}}} +\expandafter\def\csname PYG@tok@sc\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}} +\expandafter\def\csname PYG@tok@sb\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}} +\expandafter\def\csname PYG@tok@sa\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}} +\expandafter\def\csname PYG@tok@k\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}} +\expandafter\def\csname PYG@tok@se\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}} +\expandafter\def\csname PYG@tok@sd\endcsname{\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\PYGZam{\char`\&} +\def\PYGZlt{\char`\<} +\def\PYGZgt{\char`\>} +\def\PYGZsh{\char`\#} +\def\PYGZpc{\char`\%} +\def\PYGZdl{\char`\$} +\def\PYGZhy{\char`\-} +\def\PYGZsq{\char`\'} +\def\PYGZdq{\char`\"} +\def\PYGZti{\char`\~} +% for compatibility with earlier versions +\def\PYGZat{@} +\def\PYGZlb{[} +\def\PYGZrb{]} +\makeatother + +\renewcommand\PYGZsq{\textquotesingle} diff --git a/doc/build/latex/sphinxhowto.cls b/doc/build/latex/sphinxhowto.cls new file mode 100644 index 0000000..11a49a2 --- /dev/null +++ b/doc/build/latex/sphinxhowto.cls @@ -0,0 +1,95 @@ +% +% sphinxhowto.cls for Sphinx (http://sphinx-doc.org/) +% + +\NeedsTeXFormat{LaTeX2e}[1995/12/01] +\ProvidesClass{sphinxhowto}[2017/03/26 v1.6 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} +\setcounter{tocdepth}{2}% i.e. section and subsection + +% Change the title page to look a bit better, and fit in with the fncychap +% ``Bjarne'' style a bit better. +% +\renewcommand{\maketitle}{% + \noindent\rule{\textwidth}{1pt}\par + \begingroup % for PDF information dictionary + \def\endgraf{ }\def\and{\& }% + \pdfstringdefDisableCommands{\def\\{, }}% overwrite hyperref setup + \hypersetup{pdfauthor={\@author}, pdftitle={\@title}}% + \endgroup + \begin{flushright} + \sphinxlogo + \py@HeaderFamily + {\Huge \@title }\par + {\itshape\large \py@release \releaseinfo}\par + \vspace{25pt} + {\Large + \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{} +} + +\newcommand{\sphinxtableofcontents}{ + \begingroup + \parskip = 0mm + \tableofcontents + \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. +% +\newenvironment{sphinxthebibliography}[1]{% + % \phantomsection % not needed here since TeXLive 2010's hyperref + \begin{thebibliography}{1}% + \addcontentsline{toc}{section}{\ifdefined\refname\refname\else\ifdefined\bibname\bibname\fi\fi}}{\end{thebibliography}} + + +% Same for the indices. +% The memoir class already does this, so we don't duplicate it in that case. +% +\@ifclassloaded{memoir} + {\newenvironment{sphinxtheindex}{\begin{theindex}}{\end{theindex}}} + {\newenvironment{sphinxtheindex}{% + \phantomsection % needed because no chapter, section, ... is created by theindex + \begin{theindex}% + \addcontentsline{toc}{section}{\indexname}}{\end{theindex}}} diff --git a/doc/build/latex/sphinxmanual.cls b/doc/build/latex/sphinxmanual.cls new file mode 100644 index 0000000..5b3d183 --- /dev/null +++ b/doc/build/latex/sphinxmanual.cls @@ -0,0 +1,114 @@ +% +% sphinxmanual.cls for Sphinx (http://sphinx-doc.org/) +% + +\NeedsTeXFormat{LaTeX2e}[1995/12/01] +\ProvidesClass{sphinxmanual}[2017/03/26 v1.6 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}{% + \let\spx@tempa\relax + \ifHy@pageanchor\def\spx@tempa{\Hy@pageanchortrue}\fi + \hypersetup{pageanchor=false}% avoid duplicate destination warnings + \begin{titlepage}% + \let\footnotesize\small + \let\footnoterule\relax + \noindent\rule{\textwidth}{1pt}\par + \begingroup % for PDF information dictionary + \def\endgraf{ }\def\and{\& }% + \pdfstringdefDisableCommands{\def\\{, }}% overwrite hyperref setup + \hypersetup{pdfauthor={\@author}, pdftitle={\@title}}% + \endgroup + \begin{flushright}% + \sphinxlogo + \py@HeaderFamily + {\Huge \@title \par} + {\itshape\LARGE \py@release\releaseinfo \par} + \vfill + {\LARGE + \begin{tabular}[t]{c} + \@author + \end{tabular} + \par} + \vfill\vfill + {\large + \@date \par + \vfill + \py@authoraddress \par + }% + \end{flushright}%\par + \@thanks + \end{titlepage}% + \setcounter{footnote}{0}% + \let\thanks\relax\let\maketitle\relax + %\gdef\@thanks{}\gdef\@author{}\gdef\@title{} + \if@openright\cleardoublepage\else\clearpage\fi + \spx@tempa +} + +\newcommand{\sphinxtableofcontents}{% + \pagenumbering{roman}% + \pagestyle{plain}% + \begingroup + \parskip \z@skip + \tableofcontents + \endgroup + % before resetting page counter, let's do the right thing. + \if@openright\cleardoublepage\else\clearpage\fi + \pagenumbering{arabic}% + \ifdefined\fancyhf\pagestyle{normal}\fi +} + +% 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. +% +\newenvironment{sphinxthebibliography}[1]{% + \if@openright\cleardoublepage\else\clearpage\fi + % \phantomsection % not needed here since TeXLive 2010's hyperref + \begin{thebibliography}{1}% + \addcontentsline{toc}{chapter}{\bibname}}{\end{thebibliography}} + +% Same for the indices. +% The memoir class already does this, so we don't duplicate it in that case. +% +\@ifclassloaded{memoir} + {\newenvironment{sphinxtheindex}{\begin{theindex}}{\end{theindex}}} + {\newenvironment{sphinxtheindex}{% + \if@openright\cleardoublepage\else\clearpage\fi + \phantomsection % needed as no chapter, section, ... created + \begin{theindex}% + \addcontentsline{toc}{chapter}{\indexname}}{\end{theindex}}} diff --git a/doc/build/latex/sphinxmulticell.sty b/doc/build/latex/sphinxmulticell.sty new file mode 100644 index 0000000..f0d11b1 --- /dev/null +++ b/doc/build/latex/sphinxmulticell.sty @@ -0,0 +1,317 @@ +\NeedsTeXFormat{LaTeX2e} +\ProvidesPackage{sphinxmulticell}% + [2017/02/23 v1.6 better span rows and columns of a table (Sphinx team)]% +\DeclareOption*{\PackageWarning{sphinxmulticell}{Option `\CurrentOption' is unknown}}% +\ProcessOptions\relax +% +% --- MULTICOLUMN --- +% standard LaTeX's \multicolumn +% 1. does not allow verbatim contents, +% 2. interacts very poorly with tabulary. +% +% It is needed to write own macros for Sphinx: to allow code-blocks in merged +% cells rendered by tabular/longtable, and to allow multi-column cells with +% paragraphs to be taken into account sanely by tabulary algorithm for column +% widths. +% +% This requires quite a bit of hacking. First, in Sphinx, the multi-column +% contents will *always* be wrapped in a varwidth environment. The issue +% becomes to pass it the correct target width. We must trick tabulary into +% believing the multicolumn is simply separate columns, else tabulary does not +% incorporate the contents in its algorithm. But then we must clear the +% vertical rules... +% +% configuration of tabulary +\setlength{\tymin}{3\fontcharwd\font`0 }% minimal width of "squeezed" columns +\setlength{\tymax}{10000pt}% allow enough room for paragraphs to "compete" +% we need access to tabulary's final computed width. \@tempdima is too volatile +% to hope it has kept tabulary's value when \sphinxcolwidth needs it. +\newdimen\sphinx@TY@tablewidth +\def\tabulary{% + \def\TY@final{\sphinx@TY@tablewidth\@tempdima\tabular}% + \let\endTY@final\endtabular + \TY@tabular}% +% next hack is needed only if user has set latex_use_latex_multicolumn to True: +% it fixes tabulary's bug with \multicolumn defined "short" in first pass. (if +% upstream tabulary adds a \long, our extra one causes no harm) +\def\sphinx@tempa #1\def\multicolumn#2#3#4#5#6#7#8#9\sphinx@tempa + {\def\TY@tab{#1\long\def\multicolumn####1####2####3{\multispan####1\relax}#9}}% +\expandafter\sphinx@tempa\TY@tab\sphinx@tempa +% +% TN. 1: as \omit is never executed, Sphinx multicolumn does not need to worry +% like standard multicolumn about |l| vs l|. On the other hand it assumes +% columns are separated by a | ... (if not it will add extraneous +% \arrayrulewidth space for each column separation in its estimate of available +% width). +% +% TN. 1b: as Sphinx multicolumn uses neither \omit nor \span, it can not +% (easily) get rid of extra macros from >{...} or <{...} between columns. At +% least, it has been made compatible with colortbl's \columncolor. +% +% TN. 2: tabulary's second pass is handled like tabular/longtable's single +% pass, with the difference that we hacked \TY@final to set in +% \sphinx@TY@tablewidth the final target width as computed by tabulary. This is +% needed only to handle columns with a "horizontal" specifier: "p" type columns +% (inclusive of tabulary's LJRC) holds the target column width in the +% \linewidth dimension. +% +% TN. 3: use of \begin{sphinxmulticolumn}...\end{sphinxmulticolumn} mark-up +% would need some hacking around the fact that groups can not span across table +% cells (the code does inserts & tokens, see TN1b). It was decided to keep it +% simple with \sphinxstartmulticolumn...\sphinxstopmulticolumn. +% +% MEMO about nesting: if sphinxmulticolumn is encountered in a nested tabular +% inside a tabulary it will think to be at top level in the tabulary. But +% Sphinx generates no nested tables, and if some LaTeX macro uses internally a +% tabular this will not have a \sphinxstartmulticolumn within it! +% +\def\sphinxstartmulticolumn{% + \ifx\equation$% $ tabulary's first pass + \expandafter\sphinx@TYI@start@multicolumn + \else % either not tabulary or tabulary's second pass + \expandafter\sphinx@start@multicolumn + \fi +}% +\def\sphinxstopmulticolumn{% + \ifx\equation$% $ tabulary's first pass + \expandafter\sphinx@TYI@stop@multicolumn + \else % either not tabulary or tabulary's second pass + \ignorespaces + \fi +}% +\def\sphinx@TYI@start@multicolumn#1{% + % use \gdef always to avoid stack space build up + \gdef\sphinx@tempa{#1}\begingroup\setbox\z@\hbox\bgroup +}% +\def\sphinx@TYI@stop@multicolumn{\egroup % varwidth was used with \tymax + \xdef\sphinx@tempb{\the\dimexpr\wd\z@/\sphinx@tempa}% per column width + \endgroup + \expandafter\sphinx@TYI@multispan\expandafter{\sphinx@tempa}% +}% +\def\sphinx@TYI@multispan #1{% + \kern\sphinx@tempb\ignorespaces % the per column occupied width + \ifnum#1>\@ne % repeat, taking into account subtleties of TeX's & ... + \expandafter\sphinx@TYI@multispan@next\expandafter{\the\numexpr#1-\@ne\expandafter}% + \fi +}% +\def\sphinx@TYI@multispan@next{&\relax\sphinx@TYI@multispan}% +% +% Now the branch handling either the second pass of tabulary or the single pass +% of tabular/longtable. This is the delicate part where we gather the +% dimensions from the p columns either set-up by tabulary or by user p column +% or Sphinx \X, \Y columns. The difficulty is that to get the said width, the +% template must be inserted (other hacks would be horribly complicated except +% if we rewrote crucial parts of LaTeX's \@array !) and we can not do +% \omit\span like standard \multicolumn's easy approach. Thus we must cancel +% the \vrule separators. Also, perhaps the column specifier is of the l, c, r +% type, then we attempt an ad hoc rescue to give varwidth a reasonable target +% width. +\def\sphinx@start@multicolumn#1{% + \gdef\sphinx@multiwidth{0pt}\gdef\sphinx@tempa{#1}\sphinx@multispan{#1}% +}% +\def\sphinx@multispan #1{% + \ifnum#1=\@ne\expandafter\sphinx@multispan@end + \else\expandafter\sphinx@multispan@next + \fi {#1}% +}% +\def\sphinx@multispan@next #1{% + % trick to recognize L, C, R, J or p, m, b type columns + \ifdim\baselineskip>\z@ + \gdef\sphinx@tempb{\linewidth}% + \else + % if in an l, r, c type column, try and hope for the best + \xdef\sphinx@tempb{\the\dimexpr(\ifx\TY@final\@undefined\linewidth\else + \sphinx@TY@tablewidth\fi-\arrayrulewidth)/\sphinx@tempa + -\tw@\tabcolsep-\arrayrulewidth\relax}% + \fi + \noindent\kern\sphinx@tempb\relax + \xdef\sphinx@multiwidth + {\the\dimexpr\sphinx@multiwidth+\sphinx@tempb+\tw@\tabcolsep+\arrayrulewidth}% + % hack the \vline and the colortbl macros + \sphinx@hack@vline\sphinx@hack@CT&\relax + % repeat + \expandafter\sphinx@multispan\expandafter{\the\numexpr#1-\@ne}% +}% +% packages like colortbl add group levels, we need to "climb back up" to be +% able to hack the \vline and also the colortbl inserted tokens. This creates +% empty space whether or not the columns were | separated: +\def\sphinx@hack@vline{\ifnum\currentgrouptype=6\relax + \kern\arrayrulewidth\arrayrulewidth\z@\else\aftergroup\sphinx@hack@vline\fi}% +\def\sphinx@hack@CT{\ifnum\currentgrouptype=6\relax + \let\CT@setup\sphinx@CT@setup\else\aftergroup\sphinx@hack@CT\fi}% +% It turns out \CT@row@color is not expanded contrarily to \CT@column@color +% during LaTeX+colortbl preamble preparation, hence it would be possible for +% \sphinx@CT@setup to discard only the column color and choose to obey or not +% row color and cell color. It would even be possible to propagate cell color +% to row color for the duration of the Sphinx multicolumn... the (provisional?) +% choice has been made to cancel the colortbl colours for the multicolumn +% duration. +\def\sphinx@CT@setup #1\endgroup{\endgroup}% hack to remove colour commands +\def\sphinx@multispan@end#1{% + % first, trace back our steps horizontally + \noindent\kern-\dimexpr\sphinx@multiwidth\relax + % and now we set the final computed width for the varwidth environment + \ifdim\baselineskip>\z@ + \xdef\sphinx@multiwidth{\the\dimexpr\sphinx@multiwidth+\linewidth}% + \else + \xdef\sphinx@multiwidth{\the\dimexpr\sphinx@multiwidth+ + (\ifx\TY@final\@undefined\linewidth\else + \sphinx@TY@tablewidth\fi-\arrayrulewidth)/\sphinx@tempa + -\tw@\tabcolsep-\arrayrulewidth\relax}% + \fi + % we need to remove colour set-up also for last cell of the multi-column + \aftergroup\sphinx@hack@CT +}% +\newcommand*\sphinxcolwidth[2]{% + % this dimension will always be used for varwidth, and serves as maximum + % width when cells are merged either via multirow or multicolumn or both, + % as always their contents is wrapped in varwidth environment. + \ifnum#1>\@ne % multi-column (and possibly also multi-row) + % we wrote our own multicolumn code especially to handle that (and allow + % verbatim contents) + \ifx\equation$%$ + \tymax % first pass of tabulary (cf MEMO above regarding nesting) + \else % the \@gobble thing is for compatibility with standard \multicolumn + \sphinx@multiwidth\@gobble{#1/#2}% + \fi + \else % single column multirow + \ifx\TY@final\@undefined % not a tabulary. + \ifdim\baselineskip>\z@ + % in a p{..} type column, \linewidth is the target box width + \linewidth + \else + % l, c, r columns. Do our best. + \dimexpr(\linewidth-\arrayrulewidth)/#2- + \tw@\tabcolsep-\arrayrulewidth\relax + \fi + \else % in tabulary + \ifx\equation$%$% first pass + \tymax % it is set to a big value so that paragraphs can express themselves + \else + % second pass. + \ifdim\baselineskip>\z@ + \linewidth % in a L, R, C, J column or a p, \X, \Y ... + \else + % we have hacked \TY@final to put in \sphinx@TY@tablewidth the table width + \dimexpr(\sphinx@TY@tablewidth-\arrayrulewidth)/#2- + \tw@\tabcolsep-\arrayrulewidth\relax + \fi + \fi + \fi + \fi +}% +% fallback default in case user has set latex_use_latex_multicolumn to True: +% \sphinxcolwidth will use this only inside LaTeX's standard \multicolumn +\def\sphinx@multiwidth #1#2{\dimexpr % #1 to gobble the \@gobble (!) + (\ifx\TY@final\@undefined\linewidth\else\sphinx@TY@tablewidth\fi + -\arrayrulewidth)*#2-\tw@\tabcolsep-\arrayrulewidth\relax}% +% +% --- MULTIROW --- +% standard \multirow +% 1. does not allow verbatim contents, +% 2. does not allow blank lines in its argument, +% 3. its * specifier means to typeset "horizontally" which is very +% bad for paragraph content. 2016 version has = specifier but it +% must be used with p type columns only, else results are bad, +% 4. it requires manual intervention if the contents is too long to fit +% in the asked-for number of rows. +% 5. colour panels (either from \rowcolor or \columncolor) will hide +% the bottom part of multirow text, hence manual tuning is needed +% to put the multirow insertion at the _bottom_. +% +% The Sphinx solution consists in always having contents wrapped +% in a varwidth environment so that it makes sense to estimate how many +% lines it will occupy, and then ensure by insertion of suitable struts +% that the table rows have the needed height. The needed mark-up is done +% by LaTeX writer, which has its own id for the merged cells. +% +% The colour issue is solved by clearing colour panels in all cells, +% whether or not the multirow is single-column or multi-column. +% +% In passing we obtain baseline alignements across rows (only if +% \arraylinestretch is 1, as LaTeX's does not obey \arraylinestretch in "p" +% multi-line contents, only first and last line...) +% +% TODO: examine the situation with \arraylinestretch > 1. The \extrarowheight +% is hopeless for multirow anyhow, it makes baseline alignment strictly +% impossible. +\newcommand\sphinxmultirow[2]{\begingroup + % #1 = nb of spanned rows, #2 = Sphinx id of "cell", #3 = contents + % but let's fetch #3 in a way allowing verbatim contents ! + \def\sphinx@nbofrows{#1}\def\sphinx@cellid{#2}% + \afterassignment\sphinx@multirow\let\next= +}% +\def\sphinx@multirow {% + \setbox\z@\hbox\bgroup\aftergroup\sphinx@@multirow\strut +}% +\def\sphinx@@multirow {% + % The contents, which is a varwidth environment, has been captured in + % \box0 (a \hbox). + % We have with \sphinx@cellid an assigned unique id. The goal is to give + % about the same height to all the involved rows. + % For this Sphinx will insert a \sphinxtablestrut{cell_id} mark-up + % in LaTeX file and the expansion of the latter will do the suitable thing. + \dimen@\dp\z@ + \dimen\tw@\ht\@arstrutbox + \advance\dimen@\dimen\tw@ + \advance\dimen\tw@\dp\@arstrutbox + \count@=\dimen@ % type conversion dim -> int + \count\tw@=\dimen\tw@ + \divide\count@\count\tw@ % TeX division truncates + \advance\dimen@-\count@\dimen\tw@ + % 1300sp is about 0.02pt. For comparison a rule default width is 0.4pt. + % (note that if \count@ holds 0, surely \dimen@>1300sp) + \ifdim\dimen@>1300sp \advance\count@\@ne \fi + % now \count@ holds the count L of needed "lines" + % and \sphinx@nbofrows holds the number N of rows + % we have L >= 1 and N >= 1 + % if L is a multiple of N, ... clear what to do ! + % else write L = qN + r, 1 <= r < N and we will + % arrange for each row to have enough space for: + % q+1 "lines" in each of the first r rows + % q "lines" in each of the (N-r) bottom rows + % for a total of (q+1) * r + q * (N-r) = q * N + r = L + % It is possible that q == 0. + \count\tw@\count@ + % the TeX division truncates + \divide\count\tw@\sphinx@nbofrows\relax + \count4\count\tw@ % q + \multiply\count\tw@\sphinx@nbofrows\relax + \advance\count@-\count\tw@ % r + \expandafter\xdef\csname sphinx@tablestrut_\sphinx@cellid\endcsname + {\noexpand\sphinx@tablestrut{\the\count4}{\the\count@}{\sphinx@cellid}}% + \dp\z@\z@ + % this will use the real height if it is >\ht\@arstrutbox + \sphinxtablestrut{\sphinx@cellid}\box\z@ + \endgroup % group was opened in \sphinxmultirow +}% +\newcommand*\sphinxtablestrut[1]{% + % #1 is a "cell_id", i.e. the id of a merged group of table cells + \csname sphinx@tablestrut_#1\endcsname +}% +% LaTeX typesets the table row by row, hence each execution can do +% an update for the next row. +\newcommand*\sphinx@tablestrut[3]{\begingroup + % #1 = q, #2 = (initially) r, #3 = cell_id, q+1 lines in first r rows + % if #2 = 0, create space for max(q,1) table lines + % if #2 > 0, create space for q+1 lines and decrement #2 + \leavevmode + \count@#1\relax + \ifnum#2=\z@ + \ifnum\count@=\z@\count@\@ne\fi + \else + % next row will be with a #2 decremented by one + \expandafter\xdef\csname sphinx@tablestrut_#3\endcsname + {\noexpand\sphinx@tablestrut{#1}{\the\numexpr#2-\@ne}{#3}}% + \advance\count@\@ne + \fi + \vrule\@height\ht\@arstrutbox + \@depth\dimexpr\count@\ht\@arstrutbox+\count@\dp\@arstrutbox-\ht\@arstrutbox\relax + \@width\z@ + \endgroup + % we need this to avoid colour panels hiding bottom parts of multirow text + \sphinx@hack@CT +}% +\endinput +%% +%% End of file `sphinxmulticell.sty'. diff --git a/doc/rst_prolog.rst b/doc/rst_prolog.rst new file mode 100644 index 0000000..55ae5ae --- /dev/null +++ b/doc/rst_prolog.rst @@ -0,0 +1,27 @@ + +.. raw:: latex + + \clearpage + + +.. _SALOME: http://www.salome-platform.org +.. _SPHINX: http://sphinx-doc.org +.. _CAST3M: http://www-cast3m.cea.fr +.. _MATIX: ../../MATIX_PROFILE/doc/index.html +.. _C++: http://www.cplusplus.com/ +.. _CMake: https://cmake.org/ +.. _Python: https://docs.python.org/2.7 +.. _ParaView: http://www.paraview.org +.. _Anaconda: https://docs.continuum.io/anaconda/pkg-docs# +.. _Miniconda: http://conda.pydata.org/miniconda.html +.. _Git: https://git-scm.com +.. _GitCheatSheet: https://services.github.com/kit/downloads/github-git-cheat-sheet.pdf +.. _SatCheatSheet: ../sat-cheat-sheet.pdf +.. _SatPdf: ./../latex/salomeTools.pdf +.. _CLI: https://en.wikipedia.org/wiki/Command-line_interface +.. _Tar: https://en.wikipedia.org/wiki/Tar_(computing) +.. _OS: https://en.wikipedia.org/wiki/Operating_system +.. _VCS: https://en.wikipedia.org/wiki/Version_control +.. _CVS: https://fr.wikipedia.org/wiki/Concurrent_versions_system +.. _SVN: https://en.wikipedia.org/wiki/Apache_Subversion + diff --git a/doc/src/Makefile_tmp b/doc/src/Makefile_tmp new file mode 100644 index 0000000..cdd6fff --- /dev/null +++ b/doc/src/Makefile_tmp @@ -0,0 +1,153 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = build + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext + +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + +clean: + -rm -rf $(BUILDDIR)/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/toto.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/toto.qhc" + +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/toto" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/toto" + @echo "# devhelp" + +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." diff --git a/doc/src/commands/application.rst b/doc/src/commands/application.rst index 5e414c2..2052da0 100644 --- a/doc/src/commands/application.rst +++ b/doc/src/commands/application.rst @@ -1,10 +1,12 @@ -*********** -application -*********** + +.. include:: ../../rst_prolog.rst + +Command application +********************* Description =========== -The **application** command creates a virtual SALOME application. +The **application** command creates a virtual SALOME_ application. Virtual SALOME applications are used to start SALOME when distribution is needed. Usage @@ -13,38 +15,41 @@ Usage sat application - Create the virtual application directory in the salomeTool application directory, i.e. ``$APPLICATION.workdir`` + Create the virtual application directory in the salomeTool application directory ``$APPLICATION.workdir``. * Give a name to the application: :: - sat application --name MYAPP + sat application --name - *Remark*: this option overrides the name given in the virtual_app section of the configuration file (``$APPLICATION.virtual_app.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 + sat application --target -* Set a specific SALOME resources catalog (it will be used for the distribution of components on distant machines): :: +* Set a specific SALOME_ resources catalog (it will be used for the distribution of components on distant machines): :: - sat application --catalog + 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 machine,machine2,machine3 + 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 +================================= -Configuration -============= 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. +* **APPLICATION.virtual_app** - * if missing the default value is '$name + _appli'. + * **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/src/commands/clean.rst b/doc/src/commands/clean.rst new file mode 100644 index 0000000..e5d2f38 --- /dev/null +++ b/doc/src/commands/clean.rst @@ -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/src/commands/compile.rst b/doc/src/commands/compile.rst index 6c06143..915705e 100644 --- a/doc/src/commands/compile.rst +++ b/doc/src/commands/compile.rst @@ -1,10 +1,12 @@ -******* -compile -******* + +.. include:: ../../rst_prolog.rst + +Command compile +**************** Description =========== -The **compile** command allows compiling the products of a SALOME application. +The **compile** command allows compiling the products of a SALOME_ application. Usage @@ -17,7 +19,7 @@ Usage 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): :: +* 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 @@ -32,7 +34,9 @@ Usage * 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!) + + .. note:: | a warning will be shown if option *--products* is missing + | (as it will clean everything) * Clean only the install directories before starting compilation: :: @@ -42,26 +46,27 @@ Usage sat compile --products --make_flags -* Use the --check option to execute the unit tests after compilation: :: +* 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!): :: +* 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 a the compilation of a module fails: :: +* 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: :: +* Do not compile, just show if products are installed or not, and where is the installation: :: sat compile --show -Configuration -============= -The way to compile a product is defined in the product configuration file (pyconf). +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) diff --git a/doc/src/commands/config.rst b/doc/src/commands/config.rst index 30db82a..ffcfdf9 100644 --- a/doc/src/commands/config.rst +++ b/doc/src/commands/config.rst @@ -1,18 +1,21 @@ -****** -config -****** + +.. include:: ../../rst_prolog.rst + +Command config +****************** Description =========== -The **config** command manages sat configuration. It allows display, manipulation and operation on configuration files +The **config** command manages sat configuration. +It allows display, manipulation and operation on configuration files Usage ===== -* Edit the user personal configuration file (~/.salomeTools/SAT.pyconf). It is used to store the user personal choices, like the favorite editor, browser, pdf viewer: :: +* 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): :: +* List the available applications (they come from the sat projects defined in ``data/local.pyconf``: :: sat config --list @@ -24,35 +27,63 @@ Usage sat config --copy [new_name] -* Print the value of a configuration parameter. Use the automatic completion to get recursively the parameter names. Use -n option to get only the value, not the lable (useful in automatic scripts). Examples: :: +* | 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 + .. 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-8.4.0 --value APPLICATION.workdir - sat config SALOME-8.4.0 -n --value APPLICATION.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-8.4.0 --show_patchs + 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. -* Get information on a product configuration: :: +* **USER**: To get user preferences (editor, pdf viewer, web browser, default working dir). - sat config --info - sat config SALOME-8.4.0 --info KERNEL - sat config SALOME-8.4.0 --info qt +sat commands: :: -Configuration -============= -* PATH. + sat config SALOME-xx -v PATHS + sat config SALOME-xx -v USERS - * **ARCHIVEPATH** list of directories where to find application files. - * **PRODUCTPATH** list of directories where to find products configuration files. -* USER - * **editor**: command to use to start an editor (by default vi), - * **browser**: command to use to start a browser (by default firefox), - * **pdf_viewer**: command to use to start a pdf viewer (by default evince). diff --git a/doc/src/commands/environ.rst b/doc/src/commands/environ.rst new file mode 100644 index 0000000..d487e4c --- /dev/null +++ b/doc/src/commands/environ.rst @@ -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:: bash + + 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:: bash + + 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/src/commands/generate.rst b/doc/src/commands/generate.rst new file mode 100644 index 0000000..f753261 --- /dev/null +++ b/doc/src/commands/generate.rst @@ -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/src/commands/launcher.rst b/doc/src/commands/launcher.rst index a4912a9..864a31a 100644 --- a/doc/src/commands/launcher.rst +++ b/doc/src/commands/launcher.rst @@ -1,10 +1,12 @@ -******** -launcher -******** + +.. include:: ../../rst_prolog.rst + +Command launcher +****************** Description =========== -The **launcher** command creates a SALOME launcher (a python command to start SALOME). +The **launcher** command creates a SALOME launcher, a python script file to start SALOME_. Usage @@ -15,28 +17,36 @@ Usage Generate a launcher in the application directory, i.e ``$APPLICATION.workdir``. -* Create a launcher with a given name :: +* Create a launcher with a given name (default name is ``APPLICATION.profile.launcher_name``) :: - sat launcher + sat launcher --name ZeLauncher - The launcher will called ZeLauncher. + The launcher will be called *ZeLauncher*. * Set a specific resources catalog: :: - sat launcher + 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 + 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 ============= -* 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. +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/src/commands/log.rst b/doc/src/commands/log.rst index 97e7454..9908f4b 100644 --- a/doc/src/commands/log.rst +++ b/doc/src/commands/log.rst @@ -1,6 +1,8 @@ -*** -log -*** + +.. include:: ../../rst_prolog.rst + +Command log +**************** Description =========== @@ -16,26 +18,29 @@ Usage sat log -* The --terminal (or -t) display the log directly in the terminal, through a interactive menu: :: +* The --terminal (or -t) display the log directly in the terminal, through a CLI_ interactive menu: :: - sat log () --terminal + sat log --terminal * The --last option displays only the last command: :: - sat log () --last + sat log --last * To access the last compilation log in terminal mode, use --last_terminal option: :: - sat log () --last_terminal + 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 + sat log --clean 50 + + +Some useful configuration pathes +================================= +* **USER** -Configuration -============= -* USER.browser + * **browser** : The browser used to show the log (by default *firefox*). + * **log_dir** : The directory used to store the log files. - * **browser**: The browser used to show the log (by default *firefox*). diff --git a/doc/src/commands/package.rst b/doc/src/commands/package.rst new file mode 100644 index 0000000..6d6648a --- /dev/null +++ b/doc/src/commands/package.rst @@ -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/src/commands/prepare.rst b/doc/src/commands/prepare.rst index 29d7ac3..a28fdae 100644 --- a/doc/src/commands/prepare.rst +++ b/doc/src/commands/prepare.rst @@ -1,15 +1,20 @@ -******* -prepare -******* + +.. 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 **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. +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 developement mode is activated. - When you are working on a product,, you need to declare in the application configuration this product in **dev** mode. +.. 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 ======= @@ -20,25 +25,38 @@ 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). -If you have security concerns, it is also possible to use a bash agent and type your password only 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. -For that, edit the application configuration and modify the product declaration: :: +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 - # edit the product section : - : {tag : "my_tag", dev : "yes", debug : "yes"} + # 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 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) +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 @@ -51,22 +69,32 @@ Usage 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): :: +* 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): :: +* Use --force_patch to force to apply patch to the products + in development mode (otherwise they are not applied): :: sat prepare --force_patch -Configuration -============= -* sat prepare uses the pyconf configuration of each product to know how to get the sources. +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. +* **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/src/conf.py b/doc/src/conf.py index 39d1117..0025b6e 100644 --- a/doc/src/conf.py +++ b/doc/src/conf.py @@ -1,7 +1,7 @@ # -*- coding: utf-8 -*- # -# salomeTools documentation build configuration file, created by -# sphinx-quickstart on Wed Sep 14 11:55:14 2011. +# sat documentation build configuration file, created by +# sphinx-quickstart on Fri Apr 13 10:08:59 2018. # # This file is execfile()d with the current directory set to its containing dir. # @@ -14,6 +14,19 @@ import sys import os +# Append source folder to path in order to enable autodoc +currentPath = os.path.dirname(__file__) +print "sphinx on file", __file__ +sys.path.append(os.path.join(currentPath, '..', '..')) + +# https://stackoverflow.com/questions/23462494/how-to-add-a-custom-css-file-to-sphinx +# this needs realpath(custom), cause problem on relocated git clone, +# so use file link instead in _themes/alabaster: ln -s ../../../../src/custom.css custom.css +# def setup(app): +# custom = os.path.join('src', 'custom.css') +# print "setup add_stylesheet\n %s as\n %s" % (custom, os.path.realpath(custom)) +# app.add_stylesheet(os.path.realpath(custom)) + # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. @@ -26,7 +39,10 @@ import os # Add any Sphinx extension module names here, as strings. They can be extensions # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = ['sphinx.ext.autodoc'] +extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.mathjax', 'sphinx.ext.viewcode'] + +# do not use rst_prolog please use doc/rst_prolog.rst and '.. include:: ../rst_prolog.rst' +# https://github.com/sphinx-doc/sphinx/issues/2445 # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -42,7 +58,7 @@ master_doc = 'index' # General information about the project. project = u'salomeTools' -copyright = u'2010-2016, CEA' +copyright = u'2018, CEA' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -93,15 +109,34 @@ pygments_style = 'sphinx' # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # default sphinxdoc scrolls agogo traditional nature haiku -html_theme = 'default' +html_theme = 'alabaster' #added in _theme dir # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. -#html_theme_options = {} +html_theme_options = { + #'logo': 'logo.png', + #'github_user': 'bitprophet', + #'github_repo': 'alabaster', + #'description': 'MYYY DESCRIPTION', + #'sidebar_includehidden': True, + #'sidebar_collapse': True, + #'show_powered_by': False, + 'show_related': True, + 'fixed_sidebar': False, + 'page_width': '1000px', + 'sidebar_width': '250px', + 'font_size': '0.9em', #'1.0625em', + 'code_font_size': '0.8em', + #'note_bg': '#eee', + 'pre_bg': '#fee', # code-block background + #'gray_1': '#00f', + #'gray_2': '#f00', + #'gray_3': '#0f0', +} # Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] +html_theme_path = ["../_themes/alabaster", ] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". @@ -112,12 +147,12 @@ html_theme = 'default' # The name of an image file (relative to this directory) to place at the top # of the sidebar. -#html_logo = None +html_logo = "images/sat_v5.0.png" # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. -#html_favicon = "images/salomeTools.ico" +# html_favicon = "" # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, @@ -171,8 +206,23 @@ htmlhelp_basename = 'salomeToolsdoc' # -- Options for LaTeX output -------------------------------------------------- +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + 'papersize': 'a4paper', + + # The font size ('10pt', '11pt' or '12pt'). + 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + #'preamble': '', + + # http://www.sphinx-doc.org/en/master/latex.html + 'sphinxsetup': 'verbatimwithframe=false, VerbatimColor={rgb}{.98,.94,.94}', +} + + # The paper size ('letter' or 'a4'). -latex_paper_size = 'a4' +#latex_paper_size = 'a4' # The font size ('10pt', '11pt' or '12pt'). #latex_font_size = '10pt' @@ -181,7 +231,7 @@ latex_paper_size = 'a4' # (source start file, target name, title, author, documentclass [howto/manual]). latex_documents = [ ('index', 'salomeTools.tex', u'salomeTools Documentation', - u'CEA', 'manual'), + u'CEA DEN/DANS/DM2S/STMF/LGLS', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of @@ -193,10 +243,10 @@ latex_documents = [ #latex_use_parts = False # If true, show page references after internal links. -#latex_show_pagerefs = False +latex_show_pagerefs = True # If true, show URL addresses after external links. -#latex_show_urls = False +latex_show_urls = 'footnote' # sphinx version 1.7 # True # Additional stuff for the LaTeX preamble. #latex_preamble = '' @@ -214,8 +264,7 @@ latex_documents = [ # (source start file, name, description, authors, manual section). man_pages = [ ('index', 'salometools', u'salomeTools Documentation', - [u'CEA'], 1) + [u'CEA DEN/DANS/DM2S/STMF/LGLS'], 1) ] -# Append source folder to path in order to enable autodoc -sys.path.append(os.path.join('..')) \ No newline at end of file + diff --git a/doc/src/configuration.rst b/doc/src/configuration.rst new file mode 100644 index 0000000..7f415a3 --- /dev/null +++ b/doc/src/configuration.rst @@ -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/src/custom.css b/doc/src/custom.css new file mode 100644 index 0000000..a088ba6 --- /dev/null +++ b/doc/src/custom.css @@ -0,0 +1,25 @@ +/* This file is for theme alabaster custom. */ + +/* +http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html +set backquotes: ``text`` for code samples more color red +*/ +tt, code { + background-color: #ecf0f3; + color: #842; + /* padding: 1px 2px; */ +} + +/* +set 'Note:' etc size less than titles +*/ +div.admonition p.admonition-title { + font-family: {{ theme_head_font_family }}; + font-weight: normal; + font-size: 16px; + margin: 0 0 10px 0; + padding: 0; + line-height: 1; +} + + diff --git a/doc/src/images/sat_about.png b/doc/src/images/sat_about.png new file mode 100644 index 0000000..600d3d8 Binary files /dev/null and b/doc/src/images/sat_about.png differ diff --git a/doc/src/images/sat_small.png b/doc/src/images/sat_small.png new file mode 100644 index 0000000..77a9de7 Binary files /dev/null and b/doc/src/images/sat_small.png differ diff --git a/doc/src/images/sat_v5.0.png b/doc/src/images/sat_v5.0.png new file mode 100644 index 0000000..1057f5b Binary files /dev/null and b/doc/src/images/sat_v5.0.png differ diff --git a/doc/src/images/sat_v5_about.png b/doc/src/images/sat_v5_about.png new file mode 100644 index 0000000..681be86 Binary files /dev/null and b/doc/src/images/sat_v5_about.png differ diff --git a/doc/src/images/sat_v5_small.png b/doc/src/images/sat_v5_small.png new file mode 100644 index 0000000..05a5aaa Binary files /dev/null and b/doc/src/images/sat_v5_small.png differ diff --git a/doc/src/index.rst b/doc/src/index.rst index 9ce9148..3428cdf 100644 --- a/doc/src/index.rst +++ b/doc/src/index.rst @@ -1,24 +1,42 @@ + +.. include:: ../rst_prolog.rst + +.. empty first toctree is used for pdf contents maxdepth, see sphinx/builders/latex/__init__.py, toctrees[0].get('maxdepth') + +.. toctree:: + :maxdepth: 2 + ************ -SAlome Tools +Salome Tools ************ -.. note:: - - This documentation is under construction. +.. 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_. -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. + +Find a `pdf version of this documentation `_ -For example, sat allows you to compile SALOME's modules or prerequisites, create an application, run tests, create a package... Quick start =========== .. toctree:: - :maxdepth: 1 + :maxdepth: 1 - Installation of salomeTools (to be competed) - Configuration (to be competed) - Usage of salomeTools (to be competed) + Installation of salomeTools + Configuration + Usage of salomeTools List of Commands ================ @@ -32,29 +50,34 @@ List of Commands launcher application log + environ + clean + package + generate -Code documentation -================== +Developer documentation +======================= .. toctree:: :maxdepth: 1 - - SAT modules -developer documentation -======================= + Add a command + + +Code documentation +================== .. toctree:: :maxdepth: 1 - - Add a command + + SAT modules + Release Notes ============= -Here are the release notes for sat: .. toctree:: - :maxdepth: 1 + :maxdepth: 1 - Release Notes 5.0.0 (to be completed) + Release Notes 5.0.0 diff --git a/doc/src/installation_of_sat.rst b/doc/src/installation_of_sat.rst new file mode 100644 index 0000000..da661be --- /dev/null +++ b/doc/src/installation_of_sat.rst @@ -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/src/release_notes/release_notes_5.0.0.rst b/doc/src/release_notes/release_notes_5.0.0.rst new file mode 100644 index 0000000..55b6aad --- /dev/null +++ b/doc/src/release_notes/release_notes_5.0.0.rst @@ -0,0 +1,5 @@ +*************** +Release notes +*************** + +In construction. diff --git a/doc/src/usage_of_sat.rst b/doc/src/usage_of_sat.rst new file mode 100644 index 0000000..80c7b46 --- /dev/null +++ b/doc/src/usage_of_sat.rst @@ -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/src/write_command.rst b/doc/src/write_command.rst index 726c553..9a68de8 100644 --- a/doc/src/write_command.rst +++ b/doc/src/write_command.rst @@ -1,23 +1,30 @@ -*************** -Write a command -*************** + +.. 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. +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**. +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: :: +In *mycommand.py*, there must be the following method: :: def run(args, runner, logger): - # algorithm + # your algorithm ... pass In fact, at this point, the command will already be functional. @@ -26,13 +33,14 @@ But there are some useful services provided by salomeTools : * You can give some options to your command: .. code-block:: python - :emphasize-lines: 1,3,4,5,8,9 import src - # Define all possible option for mycommand command : sat mycommand + # 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.") + parser.add_option('m', 'myoption', \ + 'boolean', 'myoption', \ + 'My option changes the behavior of my command.') def run(args, runner, logger): # Parse the options @@ -40,17 +48,19 @@ But there are some useful services provided by salomeTools : # algorithm -* You can add a **description** method that will display a message when the user will call the help: +* You can add a *description* method that will display a message when the user will call the help: .. code-block:: python - :emphasize-lines: 7,8 + :emphasize-lines: 9,10 import src - # Define all possible option for mycommand command : sat mycommand + # 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.") + parser.add_option('m', 'myoption', \ + 'boolean', 'myoption', \ + 'My option changes the behavior of my command.') def description(): return _("The help of mycommand.") @@ -60,85 +70,88 @@ But there are some useful services provided by salomeTools : (options, args) = parser.parse_args(args) # algorithm -How to access to salomeTools config and other commands ? +HowTo access salomeTools config and other commands ======================================================== -The runner variable is an instance of the Sat class. It gives access to cfg : the data model that is read from all configuration files of salomeTools (*.pyconf) For example, runner.cfg.APPLICATION.out_dir will contain the root directory of the application on which you are working. +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. -It gives also access to all other commands of salomeTools : +The *runner* variable gives also access to other commands of salomeTools: .. code-block:: python + # as CLI_ 'sat prepare ...' runner.prepare(runner.cfg.VARS.application) -How to log ? -============ +HowTo logger +============== -The logger variable is an instance of the Logger class. It gives access to the write method. +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 termnial and written in an xml log file. +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) + 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). +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 WORLD ! -============= +HELLO example +============== -Here is a hello world command : +Here is a *hello* command, file *commands/hello.py*: .. code-block:: python import src - # Define all possible option for mycommand command : sat mycommand + """ + hello.py + Define all possible options for hello command: + sat hello + """ + parser = src.options.Options() - parser.add_option('m', 'myoption', 'boolean', 'myoption', "My option changes the behavior of my command.") + parser.add_option('f', 'french', 'boolean', 'french', "french set hello message in french.") def description(): - return _("The help of mycommand.") + return _("The help of hello.") def run(args, runner, logger): # Parse the options (options, args) = parser.parse_args(args) # algorithm - if options.myoption: - logger.write('HELLO, WORLD !\n') + if not options.french: + logger.write('HELLO! WORLD!\n') else: - logger.write('WORLD, HELLO !\n') + logger.write('Bonjour tout le monde!\n') -A first call of mycommand: +A first call of hello: .. code-block:: bash - >./sat mycommand --myoption - HELLO, WORLD ! - - Tap the following command to get the log : - /path/to/salomeTools/sat log - -Another call of mycommand: - -.. code-block:: bash + # Get the help of hello: + ./sat --help hello - >./sat mycommand - WORLD, HELLO ! + # To get bonjour + ./sat hello --french + Bonjour tout le monde! + + # To get hello + ./sat hello + HELLO! WORLD! - Tap the following command to get the log : - /path/to/salomeTools/sat log - -Get the help of mycommand: + # To get the log + ./sat log -.. code-block:: bash - >./sat --help mycommand - Version: 5.0.0dev - Description: - The help of mycommand. + - Available options are: - -m, --myoption (boolean) - My option changes the behavior of my command. \ No newline at end of file