Salome HOME
add doc/build for EZ direct html or pdf
[tools/sat.git] / doc / build / html / _modules / src / colorama / initialise.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
6 <html xmlns="http://www.w3.org/1999/xhtml">
7   <head>
8     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9     
10     <title>src.colorama.initialise &mdash; salomeTools 5.0.0dev documentation</title>
11     
12     <link rel="stylesheet" href="../../../_static/alabaster.css" type="text/css" />
13     <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
14     <link rel="stylesheet" href="/volatile/wambeke/SAT5/SAT5_S840_MATIX24/SAT/doc/src/custom.css" type="text/css" />
15     
16     <script type="text/javascript">
17       var DOCUMENTATION_OPTIONS = {
18         URL_ROOT:    '../../../',
19         VERSION:     '5.0.0dev',
20         COLLAPSE_INDEX: false,
21         FILE_SUFFIX: '.html',
22         HAS_SOURCE:  true
23       };
24     </script>
25     <script type="text/javascript" src="../../../_static/jquery.js"></script>
26     <script type="text/javascript" src="../../../_static/underscore.js"></script>
27     <script type="text/javascript" src="../../../_static/doctools.js"></script>
28     <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
29     <link rel="top" title="salomeTools 5.0.0dev documentation" href="../../../index.html" />
30     <link rel="up" title="Module code" href="../../index.html" />
31    
32   <link rel="stylesheet" href="../../../_static/custom.css" type="text/css" />
33   
34   
35   <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
36
37   </head>
38   <body>
39   
40
41     <div class="document">
42       <div class="documentwrapper">
43         <div class="bodywrapper">
44           <div class="body" role="main">
45             
46   <h1>Source code for src.colorama.initialise</h1><div class="highlight"><pre>
47 <span class="c"># Copyright Jonathan Hartley 2013. BSD 3-Clause license, see LICENSE file.</span>
48 <span class="kn">import</span> <span class="nn">atexit</span>
49 <span class="kn">import</span> <span class="nn">contextlib</span>
50 <span class="kn">import</span> <span class="nn">sys</span>
51
52 <span class="kn">from</span> <span class="nn">.ansitowin32</span> <span class="kn">import</span> <span class="n">AnsiToWin32</span>
53
54
55 <span class="n">orig_stdout</span> <span class="o">=</span> <span class="bp">None</span>
56 <span class="n">orig_stderr</span> <span class="o">=</span> <span class="bp">None</span>
57
58 <span class="n">wrapped_stdout</span> <span class="o">=</span> <span class="bp">None</span>
59 <span class="n">wrapped_stderr</span> <span class="o">=</span> <span class="bp">None</span>
60
61 <span class="n">atexit_done</span> <span class="o">=</span> <span class="bp">False</span>
62
63
64 <div class="viewcode-block" id="reset_all"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.initialise.reset_all">[docs]</a><span class="k">def</span> <span class="nf">reset_all</span><span class="p">():</span>
65     <span class="k">if</span> <span class="n">AnsiToWin32</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>    <span class="c"># Issue #74: objects might become None at exit</span>
66         <span class="n">AnsiToWin32</span><span class="p">(</span><span class="n">orig_stdout</span><span class="p">)</span><span class="o">.</span><span class="n">reset_all</span><span class="p">()</span>
67
68 </div>
69 <div class="viewcode-block" id="init"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.initialise.init">[docs]</a><span class="k">def</span> <span class="nf">init</span><span class="p">(</span><span class="n">autoreset</span><span class="o">=</span><span class="bp">False</span><span class="p">,</span> <span class="n">convert</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">strip</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">wrap</span><span class="o">=</span><span class="bp">True</span><span class="p">):</span>
70
71     <span class="k">if</span> <span class="ow">not</span> <span class="n">wrap</span> <span class="ow">and</span> <span class="nb">any</span><span class="p">([</span><span class="n">autoreset</span><span class="p">,</span> <span class="n">convert</span><span class="p">,</span> <span class="n">strip</span><span class="p">]):</span>
72         <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s">&#39;wrap=False conflicts with any other arg=True&#39;</span><span class="p">)</span>
73
74     <span class="k">global</span> <span class="n">wrapped_stdout</span><span class="p">,</span> <span class="n">wrapped_stderr</span>
75     <span class="k">global</span> <span class="n">orig_stdout</span><span class="p">,</span> <span class="n">orig_stderr</span>
76
77     <span class="n">orig_stdout</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">stdout</span>
78     <span class="n">orig_stderr</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">stderr</span>
79
80     <span class="k">if</span> <span class="n">sys</span><span class="o">.</span><span class="n">stdout</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
81         <span class="n">wrapped_stdout</span> <span class="o">=</span> <span class="bp">None</span>
82     <span class="k">else</span><span class="p">:</span>
83         <span class="n">sys</span><span class="o">.</span><span class="n">stdout</span> <span class="o">=</span> <span class="n">wrapped_stdout</span> <span class="o">=</span> \
84             <span class="n">wrap_stream</span><span class="p">(</span><span class="n">orig_stdout</span><span class="p">,</span> <span class="n">convert</span><span class="p">,</span> <span class="n">strip</span><span class="p">,</span> <span class="n">autoreset</span><span class="p">,</span> <span class="n">wrap</span><span class="p">)</span>
85     <span class="k">if</span> <span class="n">sys</span><span class="o">.</span><span class="n">stderr</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
86         <span class="n">wrapped_stderr</span> <span class="o">=</span> <span class="bp">None</span>
87     <span class="k">else</span><span class="p">:</span>
88         <span class="n">sys</span><span class="o">.</span><span class="n">stderr</span> <span class="o">=</span> <span class="n">wrapped_stderr</span> <span class="o">=</span> \
89             <span class="n">wrap_stream</span><span class="p">(</span><span class="n">orig_stderr</span><span class="p">,</span> <span class="n">convert</span><span class="p">,</span> <span class="n">strip</span><span class="p">,</span> <span class="n">autoreset</span><span class="p">,</span> <span class="n">wrap</span><span class="p">)</span>
90
91     <span class="k">global</span> <span class="n">atexit_done</span>
92     <span class="k">if</span> <span class="ow">not</span> <span class="n">atexit_done</span><span class="p">:</span>
93         <span class="n">atexit</span><span class="o">.</span><span class="n">register</span><span class="p">(</span><span class="n">reset_all</span><span class="p">)</span>
94         <span class="n">atexit_done</span> <span class="o">=</span> <span class="bp">True</span>
95
96 </div>
97 <div class="viewcode-block" id="deinit"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.initialise.deinit">[docs]</a><span class="k">def</span> <span class="nf">deinit</span><span class="p">():</span>
98     <span class="k">if</span> <span class="n">orig_stdout</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
99         <span class="n">sys</span><span class="o">.</span><span class="n">stdout</span> <span class="o">=</span> <span class="n">orig_stdout</span>
100     <span class="k">if</span> <span class="n">orig_stderr</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
101         <span class="n">sys</span><span class="o">.</span><span class="n">stderr</span> <span class="o">=</span> <span class="n">orig_stderr</span>
102
103 </div>
104 <span class="nd">@contextlib.contextmanager</span>
105 <div class="viewcode-block" id="colorama_text"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.initialise.colorama_text">[docs]</a><span class="k">def</span> <span class="nf">colorama_text</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
106     <span class="n">init</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
107     <span class="k">try</span><span class="p">:</span>
108         <span class="k">yield</span>
109     <span class="k">finally</span><span class="p">:</span>
110         <span class="n">deinit</span><span class="p">()</span>
111
112 </div>
113 <div class="viewcode-block" id="reinit"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.initialise.reinit">[docs]</a><span class="k">def</span> <span class="nf">reinit</span><span class="p">():</span>
114     <span class="k">if</span> <span class="n">wrapped_stdout</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
115         <span class="n">sys</span><span class="o">.</span><span class="n">stdout</span> <span class="o">=</span> <span class="n">wrapped_stdout</span>
116     <span class="k">if</span> <span class="n">wrapped_stderr</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
117         <span class="n">sys</span><span class="o">.</span><span class="n">stderr</span> <span class="o">=</span> <span class="n">wrapped_stderr</span>
118
119 </div>
120 <div class="viewcode-block" id="wrap_stream"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.initialise.wrap_stream">[docs]</a><span class="k">def</span> <span class="nf">wrap_stream</span><span class="p">(</span><span class="n">stream</span><span class="p">,</span> <span class="n">convert</span><span class="p">,</span> <span class="n">strip</span><span class="p">,</span> <span class="n">autoreset</span><span class="p">,</span> <span class="n">wrap</span><span class="p">):</span>
121     <span class="k">if</span> <span class="n">wrap</span><span class="p">:</span>
122         <span class="n">wrapper</span> <span class="o">=</span> <span class="n">AnsiToWin32</span><span class="p">(</span><span class="n">stream</span><span class="p">,</span>
123             <span class="n">convert</span><span class="o">=</span><span class="n">convert</span><span class="p">,</span> <span class="n">strip</span><span class="o">=</span><span class="n">strip</span><span class="p">,</span> <span class="n">autoreset</span><span class="o">=</span><span class="n">autoreset</span><span class="p">)</span>
124         <span class="k">if</span> <span class="n">wrapper</span><span class="o">.</span><span class="n">should_wrap</span><span class="p">():</span>
125             <span class="n">stream</span> <span class="o">=</span> <span class="n">wrapper</span><span class="o">.</span><span class="n">stream</span>
126     <span class="k">return</span> <span class="n">stream</span>
127 </pre></div></div>
128
129           </div>
130         </div>
131       </div>
132       <div class="sphinxsidebar">
133         <div class="sphinxsidebarwrapper">
134             <p class="logo"><a href="../../../index.html">
135               <img class="logo" src="../../../_static/sat_v5.0.png" alt="Logo"/>
136             </a></p><div class="relations">
137 <h3>Related Topics</h3>
138 <ul>
139   <li><a href="../../../index.html">Documentation overview</a><ul>
140   <li><a href="../../index.html">Module code</a><ul>
141   </ul></li>
142   </ul></li>
143 </ul>
144 </div>
145 <div id="searchbox" style="display: none">
146   <h3>Quick search</h3>
147     <form class="search" action="../../../search.html" method="get">
148       <input type="text" name="q" />
149       <input type="submit" value="Go" />
150       <input type="hidden" name="check_keywords" value="yes" />
151       <input type="hidden" name="area" value="default" />
152     </form>
153     <p class="searchtip" style="font-size: 90%">
154     Enter search terms or a module, class or function name.
155     </p>
156 </div>
157 <script type="text/javascript">$('#searchbox').show(0);</script>
158         </div>
159       </div>
160       <div class="clearer"></div>
161     </div>
162     <div class="footer">
163       &copy;2018, CEA.
164       
165       |
166       Powered by <a href="http://sphinx-doc.org/">Sphinx 1.1.3</a>
167       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster </a>
168       
169     </div>
170
171     
172
173     
174   </body>
175 </html>