doc/build/html/_modules/src/debug.html

   1
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   3   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   4
   5 <html xmlns="http://www.w3.org/1999/xhtml">
   6   <head>
   7     <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
   8     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   9     <title>src.debug &#8212; salomeTools 5.0.0dev documentation</title>
  10     <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
  11     <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
  12     <script type="text/javascript" src="../../_static/documentation_options.js"></script>
  13     <script type="text/javascript" src="../../_static/jquery.js"></script>
  14     <script type="text/javascript" src="../../_static/underscore.js"></script>
  15     <script type="text/javascript" src="../../_static/doctools.js"></script>
  16     <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
  17     <link rel="index" title="Index" href="../../genindex.html" />
  18     <link rel="search" title="Search" href="../../search.html" />
  19
  20   <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
  21
  22
  23   <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
  24
  25   </head><body>
  26
  27
  28     <div class="document">
  29       <div class="documentwrapper">
  30         <div class="bodywrapper">
  31           <div class="body" role="main">
  32
  33   <h1>Source code for src.debug</h1><div class="highlight"><pre>
  34 <span></span><span class="ch">#!/usr/bin/env python</span>
  35 <span class="c1">#-*- coding:utf-8 -*-</span>
  36
  37 <span class="c1">#  Copyright (C) 2010-2018  CEA/DEN</span>
  38 <span class="c1">#</span>
  39 <span class="c1">#  This library is free software; you can redistribute it and/or</span>
  40 <span class="c1">#  modify it under the terms of the GNU Lesser General Public</span>
  41 <span class="c1">#  License as published by the Free Software Foundation; either</span>
  42 <span class="c1">#  version 2.1 of the License.</span>
  43 <span class="c1">#</span>
  44 <span class="c1">#  This library is distributed in the hope that it will be useful,</span>
  45 <span class="c1">#  but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
  46 <span class="c1">#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU</span>
  47 <span class="c1">#  Lesser General Public License for more details.</span>
  48 <span class="c1">#</span>
  49 <span class="c1">#  You should have received a copy of the GNU Lesser General Public</span>
  50 <span class="c1">#  License along with this library; if not, write to the Free Software</span>
  51 <span class="c1">#  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA</span>
  52
  53 <span class="sd">&quot;&quot;&quot;</span>
  54 <span class="sd">This file assume DEBUG functionalities use.</span>
  55 <span class="sd">Print salomeTools debug messages in sys.stderr.</span>
  56 <span class="sd">Show pretty print debug representation from instances of SAT classes </span>
  57 <span class="sd">(pretty print src.pyconf.Config)</span>
  58
  59 <span class="sd">| Warning: supposedly show messages in SAT development phase, not production</span>
  60 <span class="sd">| </span>
  61 <span class="sd">| Usage:</span>
  62 <span class="sd">| &gt;&gt; import debug as DBG</span>
  63 <span class="sd">| &gt;&gt; DBG.write(&quot;aTitle&quot;, aVariable)        # not shown in production </span>
  64 <span class="sd">| &gt;&gt; DBG.write(&quot;aTitle&quot;, aVariable, True)  # unconditionaly shown (as show=True)</span>
  65 <span class="sd">| </span>
  66 <span class="sd">| to set show message as development phase:</span>
  67 <span class="sd">| &gt;&gt; DBG.push_debug(True)</span>
  68 <span class="sd">| </span>
  69 <span class="sd">| to set no show message as production phase:</span>
  70 <span class="sd">| &gt;&gt; DBG.push_debug(False)</span>
  71 <span class="sd">| </span>
  72 <span class="sd">| to set show message temporary as development phase, only in a method:</span>
  73 <span class="sd">| &gt;&gt; def aMethodToDebug(...):</span>
  74 <span class="sd">| &gt;&gt;   DBG.push_debug(True)              #force show as appended status</span>
  75 <span class="sd">| &gt;&gt;   etc. method code with some DBG.write()</span>
  76 <span class="sd">| &gt;&gt;   DBG.pop_debug()                   #restore previous status (show or not show)</span>
  77 <span class="sd">| &gt;&gt;   return</span>
  78 <span class="sd">| </span>
  79 <span class="sd">| to set a message for future fix, as temporary problem to not forget:</span>
  80 <span class="sd">| DBG.tofix(&quot;aTitle&quot;, aVariable, True/False) #True/False in production shown, or not</span>
  81 <span class="sd">| </span>
  82 <span class="sd">| in command line interface you could redirect stderr to file &#39;myDebug.log&#39;:</span>
  83 <span class="sd">| &gt;&gt; sat compile ... 2&gt; myDebug.log   # only stderr</span>
  84 <span class="sd">| &gt;&gt; sat compile ... &amp;&gt; myDebug.log   # stdout and stderr</span>
  85 <span class="sd">&quot;&quot;&quot;</span>
  86
  87 <span class="kn">import</span> <span class="nn">os</span>
  88 <span class="kn">import</span> <span class="nn">sys</span>
  89 <span class="kn">import</span> <span class="nn">traceback</span>
  90 <span class="kn">import</span> <span class="nn">StringIO</span> <span class="k">as</span> <span class="nn">SIO</span>
  91 <span class="kn">import</span> <span class="nn">pprint</span> <span class="k">as</span> <span class="nn">PP</span>
  92
  93 <span class="n">_debug</span> <span class="o">=</span> <span class="p">[</span><span class="kc">False</span><span class="p">]</span> <span class="c1">#support push/pop for temporary activate debug outputs</span>
  94
  95 <span class="n">_user</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s1">&#39;USER&#39;</span><span class="p">]</span>
  96 <span class="c1"># wambeke is christian at home</span>
  97 <span class="n">_developpers</span> <span class="o">=</span> <span class="p">[</span><span class="s2">&quot;christian&quot;</span><span class="p">,</span> <span class="s2">&quot;wambeke&quot;</span><span class="p">,</span> <span class="s2">&quot;crouzet&quot;</span><span class="p">]</span> <span class="c1"># crouzet, kloss ...</span>
  98
  99
 100 <div class="viewcode-block" id="indent"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.debug.indent">[docs]</a><span class="k">def</span> <span class="nf">indent</span><span class="p">(</span><span class="n">text</span><span class="p">,</span> <span class="n">amount</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span> <span class="n">ch</span><span class="o">=</span><span class="s1">&#39; &#39;</span><span class="p">):</span>
 101     <span class="sd">&quot;&quot;&quot;indent multi lines message&quot;&quot;&quot;</span>
 102     <span class="n">padding</span> <span class="o">=</span> <span class="n">amount</span> <span class="o">*</span> <span class="n">ch</span>
 103     <span class="k">return</span> <span class="s1">&#39;&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">padding</span> <span class="o">+</span> <span class="n">line</span> <span class="k">for</span> <span class="n">line</span> <span class="ow">in</span> <span class="n">text</span><span class="o">.</span><span class="n">splitlines</span><span class="p">(</span><span class="kc">True</span><span class="p">))</span></div>
 104
 105 <div class="viewcode-block" id="isTypeConfig"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.debug.isTypeConfig">[docs]</a><span class="k">def</span> <span class="nf">isTypeConfig</span><span class="p">(</span><span class="n">var</span><span class="p">):</span>
 106     <span class="sd">&quot;&quot;&quot;To know if var is instance from Config/pyconf&quot;&quot;&quot;</span>
 107     <span class="n">typ</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="n">var</span><span class="p">))</span>
 108     <span class="c1"># print &quot;isTypeConfig&quot; ,type, dir(var)</span>
 109     <span class="k">if</span> <span class="s2">&quot;.pyconf.Config&quot;</span> <span class="ow">in</span> <span class="n">typ</span><span class="p">:</span> <span class="k">return</span> <span class="kc">True</span>
 110     <span class="k">if</span> <span class="s2">&quot;.pyconf.Mapping&quot;</span> <span class="ow">in</span> <span class="n">typ</span><span class="p">:</span> <span class="k">return</span> <span class="kc">True</span>
 111     <span class="k">if</span> <span class="s2">&quot;.pyconf.Sequence&quot;</span> <span class="ow">in</span> <span class="n">typ</span><span class="p">:</span> <span class="k">return</span> <span class="kc">True</span>
 112     <span class="c1"># print &quot;NOT isTypeConfig %s&quot; % typ</span>
 113     <span class="k">return</span> <span class="kc">False</span></div>
 114
 115 <div class="viewcode-block" id="write"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.debug.write">[docs]</a><span class="k">def</span> <span class="nf">write</span><span class="p">(</span><span class="n">title</span><span class="p">,</span> <span class="n">var</span><span class="o">=</span><span class="s2">&quot;&quot;</span><span class="p">,</span> <span class="n">force</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">fmt</span><span class="o">=</span><span class="s2">&quot;</span><span class="se">\n</span><span class="s2">#### DEBUG: </span><span class="si">%s</span><span class="s2">:</span><span class="se">\n</span><span class="si">%s</span><span class="se">\n</span><span class="s2">&quot;</span><span class="p">):</span>
 116     <span class="sd">&quot;&quot;&quot;write sys.stderr a message if _debug[-1]==True or optionaly force=True&quot;&quot;&quot;</span>
 117     <span class="k">if</span> <span class="n">_debug</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="ow">or</span> <span class="n">force</span><span class="p">:</span>
 118       <span class="n">tvar</span> <span class="o">=</span> <span class="nb">type</span><span class="p">(</span><span class="n">var</span><span class="p">)</span>
 119       <span class="n">typ</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">tvar</span><span class="p">)</span>
 120       <span class="k">if</span> <span class="n">isTypeConfig</span><span class="p">(</span><span class="n">var</span><span class="p">):</span>
 121         <span class="n">sys</span><span class="o">.</span><span class="n">stderr</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">fmt</span> <span class="o">%</span> <span class="p">(</span><span class="n">title</span><span class="p">,</span> <span class="n">indent</span><span class="p">(</span><span class="n">COLS</span><span class="o">.</span><span class="n">toColor</span><span class="p">(</span><span class="n">getStrConfigDbg</span><span class="p">(</span><span class="n">var</span><span class="p">)))))</span>
 122         <span class="k">return</span>
 123       <span class="k">if</span> <span class="s1">&#39;UnittestStream&#39;</span> <span class="ow">in</span> <span class="n">typ</span><span class="p">:</span>
 124         <span class="n">sys</span><span class="o">.</span><span class="n">stderr</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">fmt</span> <span class="o">%</span> <span class="p">(</span><span class="n">title</span><span class="p">,</span> <span class="n">indent</span><span class="p">(</span><span class="n">var</span><span class="o">.</span><span class="n">getLogs</span><span class="p">())))</span>
 125         <span class="k">return</span>
 126       <span class="k">if</span> <span class="n">tvar</span> <span class="ow">is</span> <span class="ow">not</span> <span class="nb">str</span> <span class="ow">and</span> <span class="n">tvar</span> <span class="ow">is</span> <span class="ow">not</span> <span class="n">unicode</span><span class="p">:</span>
 127         <span class="n">sys</span><span class="o">.</span><span class="n">stderr</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">fmt</span> <span class="o">%</span> <span class="p">(</span><span class="n">title</span><span class="p">,</span> <span class="n">indent</span><span class="p">(</span><span class="n">PP</span><span class="o">.</span><span class="n">pformat</span><span class="p">(</span><span class="n">var</span><span class="p">))))</span>
 128         <span class="k">return</span>
 129       <span class="n">sys</span><span class="o">.</span><span class="n">stderr</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">fmt</span> <span class="o">%</span> <span class="p">(</span><span class="n">title</span><span class="p">,</span> <span class="n">indent</span><span class="p">(</span><span class="n">var</span><span class="p">)))</span>
 130       <span class="k">return</span>
 131     <span class="k">return</span></div>
 132
 133 <div class="viewcode-block" id="tofix"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.debug.tofix">[docs]</a><span class="k">def</span> <span class="nf">tofix</span><span class="p">(</span><span class="n">title</span><span class="p">,</span> <span class="n">var</span><span class="o">=</span><span class="s2">&quot;&quot;</span><span class="p">,</span> <span class="n">force</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
 134     <span class="sd">&quot;&quot;&quot;</span>
 135 <span class="sd">    write sys.stderr a message if _debug[-1]==True or optionaly force=True</span>
 136 <span class="sd">    use this only if no logger accessible for classic logger.warning(message)</span>
 137 <span class="sd">    &quot;&quot;&quot;</span>
 138     <span class="n">fmt</span> <span class="o">=</span> <span class="s2">&quot;</span><span class="se">\n</span><span class="s2">#### TOFIX: </span><span class="si">%s</span><span class="s2">:</span><span class="se">\n</span><span class="si">%s</span><span class="se">\n</span><span class="s2">&quot;</span>
 139     <span class="n">write</span><span class="p">(</span><span class="n">title</span><span class="p">,</span> <span class="n">var</span><span class="p">,</span> <span class="n">force</span><span class="p">,</span> <span class="n">fmt</span><span class="p">)</span></div>
 140
 141 <div class="viewcode-block" id="push_debug"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.debug.push_debug">[docs]</a><span class="k">def</span> <span class="nf">push_debug</span><span class="p">(</span><span class="n">aBool</span><span class="p">):</span>
 142     <span class="sd">&quot;&quot;&quot;set debug outputs activated, or not&quot;&quot;&quot;</span>
 143     <span class="n">_debug</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">aBool</span><span class="p">)</span></div>
 144
 145 <div class="viewcode-block" id="pop_debug"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.debug.pop_debug">[docs]</a><span class="k">def</span> <span class="nf">pop_debug</span><span class="p">():</span>
 146     <span class="sd">&quot;&quot;&quot;restore previous debug outputs status&quot;&quot;&quot;</span>
 147     <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">_debug</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">1</span><span class="p">:</span>
 148         <span class="k">return</span> <span class="n">_debug</span><span class="o">.</span><span class="n">pop</span><span class="p">()</span>
 149     <span class="k">else</span><span class="p">:</span>
 150         <span class="n">sys</span><span class="o">.</span><span class="n">stderr</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">&quot;</span><span class="se">\n</span><span class="s2">ERROR: pop_debug: too much pop.&quot;</span><span class="p">)</span>
 151         <span class="k">return</span> <span class="kc">None</span></div>
 152
 153
 154 <div class="viewcode-block" id="format_exception"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.debug.format_exception">[docs]</a><span class="k">def</span> <span class="nf">format_exception</span><span class="p">(</span><span class="n">msg</span><span class="p">,</span> <span class="n">limit</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">trace</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
 155   <span class="sd">&quot;&quot;&quot;</span>
 156 <span class="sd">  Format a stack trace and the exception information.</span>
 157 <span class="sd">  as traceback.format_exception(), without color</span>
 158 <span class="sd">  with traceback only if (_debug) or (DBG._user in DBG._developpers)</span>
 159 <span class="sd">  &quot;&quot;&quot;</span>
 160   <span class="n">etype</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">tb</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">exc_info</span><span class="p">()</span>
 161   <span class="k">if</span> <span class="p">(</span><span class="n">_debug</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">])</span> <span class="ow">or</span> <span class="p">(</span><span class="n">_user</span> <span class="ow">in</span> <span class="n">_developpers</span><span class="p">):</span>
 162     <span class="n">res</span> <span class="o">=</span> <span class="n">msg</span>
 163     <span class="k">if</span> <span class="n">tb</span><span class="p">:</span>
 164       <span class="n">res</span> <span class="o">+=</span> <span class="s2">&quot;</span><span class="se">\n</span><span class="s2">Traceback (most recent call last):</span><span class="se">\n</span><span class="s2">&quot;</span>
 165       <span class="n">res</span> <span class="o">+=</span> <span class="s2">&quot;&quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">traceback</span><span class="o">.</span><span class="n">format_tb</span><span class="p">(</span><span class="n">tb</span><span class="p">,</span> <span class="n">limit</span><span class="p">))</span>  <span class="c1"># [:-1])</span>
 166     <span class="n">res</span> <span class="o">+=</span> <span class="s2">&quot;</span><span class="se">\n</span><span class="s2">&quot;</span>
 167     <span class="n">res</span> <span class="o">+=</span> <span class="s2">&quot;</span><span class="se">\n</span><span class="s2">&quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">traceback</span><span class="o">.</span><span class="n">format_exception_only</span><span class="p">(</span><span class="n">etype</span><span class="p">,</span> <span class="n">value</span><span class="p">))</span>
 168     <span class="k">return</span> <span class="n">res</span>
 169   <span class="k">else</span><span class="p">:</span>
 170     <span class="n">res</span> <span class="o">=</span> <span class="n">msg</span>
 171     <span class="n">res</span> <span class="o">+=</span> <span class="s2">&quot;&quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">traceback</span><span class="o">.</span><span class="n">format_exception_only</span><span class="p">(</span><span class="n">etype</span><span class="p">,</span> <span class="n">value</span><span class="p">))</span>
 172     <span class="k">return</span> <span class="n">res</span></div>
 173
 174 <div class="viewcode-block" id="format_color_exception"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.debug.format_color_exception">[docs]</a><span class="k">def</span> <span class="nf">format_color_exception</span><span class="p">(</span><span class="n">msg</span><span class="p">,</span> <span class="n">limit</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">trace</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
 175   <span class="sd">&quot;&quot;&quot;</span>
 176 <span class="sd">  Format a stack trace and the exception information.</span>
 177 <span class="sd">  as traceback.format_exception(), with color</span>
 178 <span class="sd">  with traceback only if (_debug) or (DBG._user in DBG._developpers)</span>
 179 <span class="sd">  &quot;&quot;&quot;</span>
 180   <span class="n">etype</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">tb</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">exc_info</span><span class="p">()</span>
 181   <span class="k">if</span> <span class="p">(</span><span class="n">_debug</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">])</span> <span class="ow">or</span> <span class="p">(</span><span class="n">_user</span> <span class="ow">in</span> <span class="n">_developpers</span><span class="p">):</span>
 182     <span class="n">res</span> <span class="o">=</span> <span class="s2">&quot;&lt;red&gt;&quot;</span> <span class="o">+</span> <span class="n">msg</span>
 183     <span class="k">if</span> <span class="n">tb</span><span class="p">:</span>
 184       <span class="n">res</span> <span class="o">+=</span> <span class="s2">&quot;&lt;yellow&gt;</span><span class="se">\n</span><span class="s2">Traceback (most recent call last):</span><span class="se">\n</span><span class="s2">&quot;</span>
 185       <span class="n">res</span> <span class="o">+=</span> <span class="s2">&quot;&quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">traceback</span><span class="o">.</span><span class="n">format_tb</span><span class="p">(</span><span class="n">tb</span><span class="p">,</span> <span class="n">limit</span><span class="p">))</span>  <span class="c1"># [:-1])</span>
 186     <span class="n">res</span> <span class="o">+=</span> <span class="s2">&quot;</span><span class="se">\n</span><span class="s2">&lt;red&gt;&quot;</span>
 187     <span class="n">res</span> <span class="o">+=</span> <span class="s2">&quot;</span><span class="se">\n</span><span class="s2">&quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">traceback</span><span class="o">.</span><span class="n">format_exception_only</span><span class="p">(</span><span class="n">etype</span><span class="p">,</span> <span class="n">value</span><span class="p">))</span>
 188     <span class="k">return</span> <span class="n">res</span> <span class="o">+</span> <span class="s2">&quot;&lt;reset&gt;&quot;</span>
 189   <span class="k">else</span><span class="p">:</span>
 190     <span class="n">res</span> <span class="o">=</span> <span class="s2">&quot;&lt;red&gt;&quot;</span> <span class="o">+</span> <span class="n">msg</span>  <span class="c1"># + &quot;&lt;bright&gt;&quot;</span>
 191     <span class="n">res</span> <span class="o">+=</span> <span class="s2">&quot;&quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">traceback</span><span class="o">.</span><span class="n">format_exception_only</span><span class="p">(</span><span class="n">etype</span><span class="p">,</span> <span class="n">value</span><span class="p">))</span>
 192     <span class="k">return</span> <span class="n">res</span> <span class="o">+</span> <span class="s2">&quot;&lt;reset&gt;&quot;</span></div>
 193
 194
 195 <span class="c1">###############################################</span>
 196 <span class="c1"># utilitaires divers pour debug</span>
 197 <span class="c1">###############################################</span>
 198
 199 <div class="viewcode-block" id="OutStream"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.debug.OutStream">[docs]</a><span class="k">class</span> <span class="nc">OutStream</span><span class="p">(</span><span class="n">SIO</span><span class="o">.</span><span class="n">StringIO</span><span class="p">):</span>
 200     <span class="sd">&quot;&quot;&quot;</span>
 201 <span class="sd">    utility class for pyconf.Config output iostream</span>
 202 <span class="sd">    &quot;&quot;&quot;</span>
 203 <div class="viewcode-block" id="OutStream.close"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.debug.OutStream.close">[docs]</a>    <span class="k">def</span> <span class="nf">close</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 204       <span class="sd">&quot;&quot;&quot;</span>
 205 <span class="sd">      because Config.__save__ calls close() stream as file</span>
 206 <span class="sd">      keep value before lost as self.value</span>
 207 <span class="sd">      &quot;&quot;&quot;</span>
 208       <span class="bp">self</span><span class="o">.</span><span class="n">value</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">getvalue</span><span class="p">()</span>
 209       <span class="n">SIO</span><span class="o">.</span><span class="n">StringIO</span><span class="o">.</span><span class="n">close</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span></div></div>
 210
 211 <div class="viewcode-block" id="InStream"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.debug.InStream">[docs]</a><span class="k">class</span> <span class="nc">InStream</span><span class="p">(</span><span class="n">SIO</span><span class="o">.</span><span class="n">StringIO</span><span class="p">):</span>
 212     <span class="sd">&quot;&quot;&quot;utility class for pyconf.Config input iostream&quot;&quot;&quot;</span>
 213     <span class="k">pass</span></div>
 214
 215 <div class="viewcode-block" id="getLocalEnv"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.debug.getLocalEnv">[docs]</a><span class="k">def</span> <span class="nf">getLocalEnv</span><span class="p">():</span>
 216     <span class="sd">&quot;&quot;&quot;get string for environment variables representation&quot;&quot;&quot;</span>
 217     <span class="n">res</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
 218     <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">):</span>
 219         <span class="n">res</span> <span class="o">+=</span> <span class="s2">&quot;</span><span class="si">%s</span><span class="s2"> : </span><span class="si">%s</span><span class="se">\n</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">i</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="n">i</span><span class="p">])</span>
 220     <span class="k">return</span> <span class="n">res</span></div>
 221
 222 <span class="c1"># save as initial Config.save() moved as Config.__save__() </span>
 223 <div class="viewcode-block" id="saveConfigStd"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.debug.saveConfigStd">[docs]</a><span class="k">def</span> <span class="nf">saveConfigStd</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">aStream</span><span class="p">):</span>
 224     <span class="sd">&quot;&quot;&quot;returns as file .pyconf&quot;&quot;&quot;</span>
 225     <span class="n">indent</span> <span class="o">=</span>  <span class="mi">0</span>
 226     <span class="n">config</span><span class="o">.</span><span class="n">__save__</span><span class="p">(</span><span class="n">aStream</span><span class="p">,</span> <span class="n">indent</span><span class="p">)</span> </div>
 227
 228 <div class="viewcode-block" id="getStrConfigStd"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.debug.getStrConfigStd">[docs]</a><span class="k">def</span> <span class="nf">getStrConfigStd</span><span class="p">(</span><span class="n">config</span><span class="p">):</span>
 229     <span class="sd">&quot;&quot;&quot;set string as saveConfigStd, as file .pyconf&quot;&quot;&quot;</span>
 230     <span class="n">outStream</span> <span class="o">=</span> <span class="n">OutStream</span><span class="p">()</span>
 231     <span class="n">saveConfigStd</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">outStream</span><span class="p">)</span>
 232     <span class="k">return</span> <span class="n">outStream</span><span class="o">.</span><span class="n">value</span></div>
 233
 234 <div class="viewcode-block" id="getStrConfigDbg"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.debug.getStrConfigDbg">[docs]</a><span class="k">def</span> <span class="nf">getStrConfigDbg</span><span class="p">(</span><span class="n">config</span><span class="p">):</span>
 235     <span class="sd">&quot;&quot;&quot;</span>
 236 <span class="sd">    set string as saveConfigDbg, </span>
 237 <span class="sd">    as (path expression evaluation) for debug</span>
 238 <span class="sd">    &quot;&quot;&quot;</span>
 239     <span class="n">outStream</span> <span class="o">=</span> <span class="n">OutStream</span><span class="p">()</span>
 240     <span class="n">saveConfigDbg</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">outStream</span><span class="p">)</span>
 241     <span class="k">return</span> <span class="n">outStream</span><span class="o">.</span><span class="n">value</span></div>
 242
 243 <div class="viewcode-block" id="saveConfigDbg"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.debug.saveConfigDbg">[docs]</a><span class="k">def</span> <span class="nf">saveConfigDbg</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">aStream</span><span class="p">,</span> <span class="n">indent</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">path</span><span class="o">=</span><span class="s2">&quot;&quot;</span><span class="p">):</span>
 244     <span class="sd">&quot;&quot;&quot;pyconf returns multilines (path expression evaluation) for debug&quot;&quot;&quot;</span>
 245     <span class="n">_saveConfigRecursiveDbg</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">aStream</span><span class="p">,</span> <span class="n">indent</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
 246     <span class="n">aStream</span><span class="o">.</span><span class="n">close</span><span class="p">()</span> <span class="c1"># as config.__save__()</span></div>
 247
 248 <span class="k">def</span> <span class="nf">_saveConfigRecursiveDbg</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">aStream</span><span class="p">,</span> <span class="n">indent</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">nb</span><span class="p">):</span>
 249     <span class="sd">&quot;&quot;&quot;pyconf inspired from Mapping.__save__&quot;&quot;&quot;</span>
 250     <span class="n">debug</span> <span class="o">=</span> <span class="kc">False</span>
 251     <span class="n">nbp</span> <span class="o">=</span> <span class="n">nb</span> <span class="o">+</span> <span class="mi">1</span> <span class="c1"># depth recursive</span>
 252     <span class="k">if</span> <span class="n">indent</span> <span class="o">&lt;=</span> <span class="mi">0</span><span class="p">:</span>
 253       <span class="n">indentp</span> <span class="o">=</span> <span class="mi">0</span>
 254     <span class="k">else</span><span class="p">:</span>
 255       <span class="n">indentp</span> <span class="o">=</span> <span class="n">indent</span> <span class="o">+</span> <span class="mi">2</span>
 256
 257     <span class="k">if</span> <span class="n">nbp</span> <span class="o">&gt;</span> <span class="mi">10</span><span class="p">:</span> <span class="c1"># protection</span>
 258       <span class="c1"># raise Exception(&quot;!!! ERROR: Circular reference after %s&quot; % aStream.getvalue())</span>
 259       <span class="c1"># raise Exception(&quot;!!! ERROR: Circular reference %s&quot; % path)</span>
 260       <span class="n">aStream</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">&quot;&lt;red&gt;!!! ERROR: Circular reference after </span><span class="si">%s</span><span class="s2">&lt;reset&gt;</span><span class="se">\n</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="n">path</span><span class="p">)</span>
 261       <span class="k">return</span>
 262
 263     <span class="n">indstr</span> <span class="o">=</span> <span class="n">indent</span> <span class="o">*</span> <span class="s1">&#39; &#39;</span> <span class="c1"># &#39;&#39;:no indent, &#39; &#39;:indent</span>
 264     <span class="n">strType</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="n">config</span><span class="p">))</span>
 265     <span class="k">if</span> <span class="n">debug</span><span class="p">:</span> <span class="nb">print</span> <span class="s2">&quot;saveDbg Type&quot;</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">strType</span>
 266
 267     <span class="k">if</span> <span class="s2">&quot;Sequence&quot;</span> <span class="ow">in</span> <span class="n">strType</span><span class="p">:</span>
 268       <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">config</span><span class="p">)):</span>
 269         <span class="n">_saveConfigRecursiveDbg</span><span class="p">(</span><span class="n">config</span><span class="p">[</span><span class="n">i</span><span class="p">],</span> <span class="n">aStream</span><span class="p">,</span> <span class="n">indentp</span><span class="p">,</span> <span class="n">path</span><span class="o">+</span><span class="s2">&quot;[</span><span class="si">%i</span><span class="s2">]&quot;</span> <span class="o">%</span> <span class="n">i</span><span class="p">,</span> <span class="n">nbp</span><span class="p">)</span>
 270       <span class="k">return</span>
 271     <span class="sd">&#39;&#39;&#39;</span>
 272 <span class="sd">    if &quot;Reference&quot; in strType:</span>
 273 <span class="sd">      try:</span>
 274 <span class="sd">        #evaluate = value.resolve(config)</span>
 275 <span class="sd">        aStream.write(&quot;&lt;header&gt;%s%s&lt;reset&gt; : %s &lt;yellow&gt;--&gt; &#39;%s&#39;&lt;reset&gt;\n&quot; % (indstr, path, config, str(config)))</span>
 276 <span class="sd">      except Exception as e:  </span>
 277 <span class="sd">        aStream.write(&quot;&lt;header&gt;%s%s&lt;reset&gt; : &lt;red&gt;!!! ERROR: %s !!!&lt;reset&gt;\n&quot; % (indstr, path, e.message))     </span>
 278 <span class="sd">      return</span>
 279 <span class="sd">    &#39;&#39;&#39;</span>
 280
 281     <span class="k">try</span><span class="p">:</span> <span class="c1">#type config, mapping</span>
 282       <span class="n">order</span> <span class="o">=</span> <span class="nb">object</span><span class="o">.</span><span class="fm">__getattribute__</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="s1">&#39;order&#39;</span><span class="p">)</span>
 283       <span class="n">data</span> <span class="o">=</span> <span class="nb">object</span><span class="o">.</span><span class="fm">__getattribute__</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="s1">&#39;data&#39;</span><span class="p">)</span>
 284     <span class="k">except</span><span class="p">:</span>
 285       <span class="n">aStream</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">&quot;</span><span class="si">%s%s</span><span class="s2"> : &#39;</span><span class="si">%s</span><span class="s2">&#39;</span><span class="se">\n</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">indstr</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">config</span><span class="p">)))</span>
 286       <span class="k">return</span>
 287     <span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">data</span><span class="p">):</span> <span class="c1">#order): # data as sort alphabetical, order as initial order</span>
 288       <span class="n">value</span> <span class="o">=</span> <span class="n">data</span><span class="p">[</span><span class="n">key</span><span class="p">]</span>
 289       <span class="n">strType</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="n">value</span><span class="p">))</span>
 290       <span class="k">if</span> <span class="n">debug</span><span class="p">:</span> <span class="nb">print</span> <span class="s1">&#39;strType&#39;</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">strType</span>
 291       <span class="k">if</span> <span class="s2">&quot;Config&quot;</span> <span class="ow">in</span> <span class="n">strType</span><span class="p">:</span>
 292         <span class="n">_saveConfigRecursiveDbg</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">aStream</span><span class="p">,</span> <span class="n">indentp</span><span class="p">,</span> <span class="n">path</span><span class="o">+</span><span class="s2">&quot;.&quot;</span><span class="o">+</span><span class="n">key</span><span class="p">,</span> <span class="n">nbp</span><span class="p">)</span>
 293         <span class="k">continue</span>
 294       <span class="k">if</span> <span class="s2">&quot;Mapping&quot;</span> <span class="ow">in</span> <span class="n">strType</span><span class="p">:</span>
 295         <span class="n">_saveConfigRecursiveDbg</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">aStream</span><span class="p">,</span> <span class="n">indentp</span><span class="p">,</span> <span class="n">path</span><span class="o">+</span><span class="s2">&quot;.&quot;</span><span class="o">+</span><span class="n">key</span><span class="p">,</span> <span class="n">nbp</span><span class="p">)</span>
 296         <span class="k">continue</span>
 297       <span class="k">if</span> <span class="s2">&quot;Sequence&quot;</span> <span class="ow">in</span> <span class="n">strType</span><span class="p">:</span>
 298         <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">value</span><span class="p">)):</span>
 299           <span class="n">_saveConfigRecursiveDbg</span><span class="p">(</span><span class="n">value</span><span class="o">.</span><span class="n">data</span><span class="p">[</span><span class="n">i</span><span class="p">],</span> <span class="n">aStream</span><span class="p">,</span> <span class="n">indentp</span><span class="p">,</span> <span class="n">path</span><span class="o">+</span><span class="s2">&quot;.&quot;</span><span class="o">+</span><span class="n">key</span><span class="o">+</span><span class="s2">&quot;[</span><span class="si">%i</span><span class="s2">]&quot;</span> <span class="o">%</span> <span class="n">i</span><span class="p">,</span> <span class="n">nbp</span><span class="p">)</span>
 300         <span class="k">continue</span>
 301       <span class="k">if</span> <span class="s2">&quot;Expression&quot;</span> <span class="ow">in</span> <span class="n">strType</span><span class="p">:</span>
 302         <span class="k">try</span><span class="p">:</span>
 303           <span class="n">evaluate</span> <span class="o">=</span> <span class="n">value</span><span class="o">.</span><span class="n">evaluate</span><span class="p">(</span><span class="n">config</span><span class="p">)</span>
 304           <span class="n">aStream</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">&quot;</span><span class="si">%s%s</span><span class="s2">.</span><span class="si">%s</span><span class="s2"> : </span><span class="si">%s</span><span class="s2"> --&gt; &#39;</span><span class="si">%s</span><span class="s2">&#39;</span><span class="se">\n</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">indstr</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">),</span> <span class="n">evaluate</span><span class="p">))</span>
 305         <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
 306           <span class="n">aStream</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">&quot;</span><span class="si">%s%s</span><span class="s2">.</span><span class="si">%s</span><span class="s2"> : !!! ERROR: </span><span class="si">%s</span><span class="s2"> !!!</span><span class="se">\n</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">indstr</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">e</span><span class="o">.</span><span class="n">message</span><span class="p">))</span>
 307         <span class="k">continue</span>
 308       <span class="k">if</span> <span class="s2">&quot;Reference&quot;</span> <span class="ow">in</span> <span class="n">strType</span><span class="p">:</span>
 309         <span class="k">try</span><span class="p">:</span>
 310           <span class="n">evaluate</span> <span class="o">=</span> <span class="n">value</span><span class="o">.</span><span class="n">resolve</span><span class="p">(</span><span class="n">config</span><span class="p">)</span>
 311           <span class="n">aStream</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">&quot;</span><span class="si">%s%s</span><span class="s2">.</span><span class="si">%s</span><span class="s2"> : </span><span class="si">%s</span><span class="s2"> --&gt; &#39;</span><span class="si">%s</span><span class="s2">&#39;</span><span class="se">\n</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">indstr</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">),</span> <span class="n">evaluate</span><span class="p">))</span>
 312         <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
 313           <span class="n">aStream</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">&quot;</span><span class="si">%s%s</span><span class="s2">.</span><span class="si">%s</span><span class="s2"> : !!! ERROR: </span><span class="si">%s</span><span class="s2"> !!!</span><span class="se">\n</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">indstr</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">e</span><span class="o">.</span><span class="n">message</span><span class="p">))</span>
 314         <span class="k">continue</span>
 315       <span class="k">if</span> <span class="nb">type</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> <span class="ow">in</span> <span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">bool</span><span class="p">,</span> <span class="nb">int</span><span class="p">,</span> <span class="nb">type</span><span class="p">(</span><span class="kc">None</span><span class="p">),</span> <span class="n">unicode</span><span class="p">]:</span>
 316         <span class="n">aStream</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">&quot;</span><span class="si">%s%s</span><span class="s2">.</span><span class="si">%s</span><span class="s2"> : &#39;</span><span class="si">%s</span><span class="s2">&#39;</span><span class="se">\n</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">indstr</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)))</span>
 317         <span class="k">continue</span>
 318       <span class="k">try</span><span class="p">:</span>
 319         <span class="n">aStream</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">&quot;!!! TODO fix that </span><span class="si">%s</span><span class="s2"> </span><span class="si">%s%s</span><span class="s2">.</span><span class="si">%s</span><span class="s2"> : </span><span class="si">%s</span><span class="se">\n</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="n">value</span><span class="p">),</span> <span class="n">indstr</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)))</span>
 320       <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
 321         <span class="n">aStream</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">&quot;</span><span class="si">%s%s</span><span class="s2">.</span><span class="si">%s</span><span class="s2"> : !!! </span><span class="si">%s</span><span class="se">\n</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">indstr</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">e</span><span class="o">.</span><span class="n">message</span><span class="p">))</span>
 322 </pre></div>
 323
 324           </div>
 325         </div>
 326       </div>
 327       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
 328         <div class="sphinxsidebarwrapper">
 329             <p class="logo"><a href="../../index.html">
 330               <img class="logo" src="../../_static/sat_v5.0.png" alt="Logo"/>
 331             </a></p><div class="relations">
 332 <h3>Related Topics</h3>
 333 <ul>
 334   <li><a href="../../index.html">Documentation overview</a><ul>
 335   <li><a href="../index.html">Module code</a><ul>
 336   <li><a href="../src.html">src</a><ul>
 337   </ul></li>
 338   </ul></li>
 339   </ul></li>
 340 </ul>
 341 </div>
 342 <div id="searchbox" style="display: none" role="search">
 343   <h3>Quick search</h3>
 344     <div class="searchformwrapper">
 345     <form class="search" action="../../search.html" method="get">
 346       <input type="text" name="q" />
 347       <input type="submit" value="Go" />
 348       <input type="hidden" name="check_keywords" value="yes" />
 349       <input type="hidden" name="area" value="default" />
 350     </form>
 351     </div>
 352 </div>
 353 <script type="text/javascript">$('#searchbox').show(0);</script>
 354         </div>
 355       </div>
 356       <div class="clearer"></div>
 357     </div>
 358     <div class="footer">
 359       &copy;2018, CEA.
 360
 361       |
 362       Powered by <a href="http://sphinx-doc.org/">Sphinx 1.7.3</a>
 363       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
 364
 365     </div>
 366
 367
 368
 369
 370   </body>
 371 </html>