doc/build/html/_modules/src/colorama/ansi.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.ansi &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.ansi</h1><div class="highlight"><pre>
  47 <span class="c"># Copyright Jonathan Hartley 2013. BSD 3-Clause license, see LICENSE file.</span>
  48 <span class="sd">&#39;&#39;&#39;</span>
  49 <span class="sd">This module generates ANSI character codes to printing colors to terminals.</span>
  50 <span class="sd">See: http://en.wikipedia.org/wiki/ANSI_escape_code</span>
  51 <span class="sd">&#39;&#39;&#39;</span>
  52
  53 <span class="n">CSI</span> <span class="o">=</span> <span class="s">&#39;</span><span class="se">\033</span><span class="s">[&#39;</span>
  54 <span class="n">OSC</span> <span class="o">=</span> <span class="s">&#39;</span><span class="se">\033</span><span class="s">]&#39;</span>
  55 <span class="n">BEL</span> <span class="o">=</span> <span class="s">&#39;</span><span class="se">\007</span><span class="s">&#39;</span>
  56
  57
  58 <div class="viewcode-block" id="code_to_chars"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.ansi.code_to_chars">[docs]</a><span class="k">def</span> <span class="nf">code_to_chars</span><span class="p">(</span><span class="n">code</span><span class="p">):</span>
  59     <span class="k">return</span> <span class="n">CSI</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">code</span><span class="p">)</span> <span class="o">+</span> <span class="s">&#39;m&#39;</span>
  60 </div>
  61 <div class="viewcode-block" id="set_title"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.ansi.set_title">[docs]</a><span class="k">def</span> <span class="nf">set_title</span><span class="p">(</span><span class="n">title</span><span class="p">):</span>
  62     <span class="k">return</span> <span class="n">OSC</span> <span class="o">+</span> <span class="s">&#39;2;&#39;</span> <span class="o">+</span> <span class="n">title</span> <span class="o">+</span> <span class="n">BEL</span>
  63 </div>
  64 <div class="viewcode-block" id="clear_screen"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.ansi.clear_screen">[docs]</a><span class="k">def</span> <span class="nf">clear_screen</span><span class="p">(</span><span class="n">mode</span><span class="o">=</span><span class="mi">2</span><span class="p">):</span>
  65     <span class="k">return</span> <span class="n">CSI</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">mode</span><span class="p">)</span> <span class="o">+</span> <span class="s">&#39;J&#39;</span>
  66 </div>
  67 <div class="viewcode-block" id="clear_line"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.ansi.clear_line">[docs]</a><span class="k">def</span> <span class="nf">clear_line</span><span class="p">(</span><span class="n">mode</span><span class="o">=</span><span class="mi">2</span><span class="p">):</span>
  68     <span class="k">return</span> <span class="n">CSI</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">mode</span><span class="p">)</span> <span class="o">+</span> <span class="s">&#39;K&#39;</span>
  69
  70 </div>
  71 <div class="viewcode-block" id="AnsiCodes"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiCodes">[docs]</a><span class="k">class</span> <span class="nc">AnsiCodes</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
  72     <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  73         <span class="c"># the subclasses declare class attributes which are numbers.</span>
  74         <span class="c"># Upon instantiation we define instance attributes, which are the same</span>
  75         <span class="c"># as the class attributes but wrapped with the ANSI escape sequence</span>
  76         <span class="k">for</span> <span class="n">name</span> <span class="ow">in</span> <span class="nb">dir</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  77             <span class="k">if</span> <span class="ow">not</span> <span class="n">name</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s">&#39;_&#39;</span><span class="p">):</span>
  78                 <span class="n">value</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span>
  79                 <span class="nb">setattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">code_to_chars</span><span class="p">(</span><span class="n">value</span><span class="p">))</span>
  80
  81 </div>
  82 <div class="viewcode-block" id="AnsiCursor"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiCursor">[docs]</a><span class="k">class</span> <span class="nc">AnsiCursor</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
  83 <div class="viewcode-block" id="AnsiCursor.UP"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiCursor.UP">[docs]</a>    <span class="k">def</span> <span class="nf">UP</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">n</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
  84         <span class="k">return</span> <span class="n">CSI</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">n</span><span class="p">)</span> <span class="o">+</span> <span class="s">&#39;A&#39;</span></div>
  85 <div class="viewcode-block" id="AnsiCursor.DOWN"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiCursor.DOWN">[docs]</a>    <span class="k">def</span> <span class="nf">DOWN</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">n</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
  86         <span class="k">return</span> <span class="n">CSI</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">n</span><span class="p">)</span> <span class="o">+</span> <span class="s">&#39;B&#39;</span></div>
  87 <div class="viewcode-block" id="AnsiCursor.FORWARD"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiCursor.FORWARD">[docs]</a>    <span class="k">def</span> <span class="nf">FORWARD</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">n</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
  88         <span class="k">return</span> <span class="n">CSI</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">n</span><span class="p">)</span> <span class="o">+</span> <span class="s">&#39;C&#39;</span></div>
  89 <div class="viewcode-block" id="AnsiCursor.BACK"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiCursor.BACK">[docs]</a>    <span class="k">def</span> <span class="nf">BACK</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">n</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
  90         <span class="k">return</span> <span class="n">CSI</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">n</span><span class="p">)</span> <span class="o">+</span> <span class="s">&#39;D&#39;</span></div>
  91 <div class="viewcode-block" id="AnsiCursor.POS"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiCursor.POS">[docs]</a>    <span class="k">def</span> <span class="nf">POS</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">y</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
  92         <span class="k">return</span> <span class="n">CSI</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">y</span><span class="p">)</span> <span class="o">+</span> <span class="s">&#39;;&#39;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">+</span> <span class="s">&#39;H&#39;</span>
  93
  94 </div></div>
  95 <div class="viewcode-block" id="AnsiFore"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiFore">[docs]</a><span class="k">class</span> <span class="nc">AnsiFore</span><span class="p">(</span><span class="n">AnsiCodes</span><span class="p">):</span>
  96     <span class="n">BLACK</span>           <span class="o">=</span> <span class="mi">30</span>
  97     <span class="n">RED</span>             <span class="o">=</span> <span class="mi">31</span>
  98     <span class="n">GREEN</span>           <span class="o">=</span> <span class="mi">32</span>
  99     <span class="n">YELLOW</span>          <span class="o">=</span> <span class="mi">33</span>
 100     <span class="n">BLUE</span>            <span class="o">=</span> <span class="mi">34</span>
 101     <span class="n">MAGENTA</span>         <span class="o">=</span> <span class="mi">35</span>
 102     <span class="n">CYAN</span>            <span class="o">=</span> <span class="mi">36</span>
 103     <span class="n">WHITE</span>           <span class="o">=</span> <span class="mi">37</span>
 104     <span class="n">RESET</span>           <span class="o">=</span> <span class="mi">39</span>
 105
 106     <span class="c"># These are fairly well supported, but not part of the standard.</span>
 107     <span class="n">LIGHTBLACK_EX</span>   <span class="o">=</span> <span class="mi">90</span>
 108     <span class="n">LIGHTRED_EX</span>     <span class="o">=</span> <span class="mi">91</span>
 109     <span class="n">LIGHTGREEN_EX</span>   <span class="o">=</span> <span class="mi">92</span>
 110     <span class="n">LIGHTYELLOW_EX</span>  <span class="o">=</span> <span class="mi">93</span>
 111     <span class="n">LIGHTBLUE_EX</span>    <span class="o">=</span> <span class="mi">94</span>
 112     <span class="n">LIGHTMAGENTA_EX</span> <span class="o">=</span> <span class="mi">95</span>
 113     <span class="n">LIGHTCYAN_EX</span>    <span class="o">=</span> <span class="mi">96</span>
 114     <span class="n">LIGHTWHITE_EX</span>   <span class="o">=</span> <span class="mi">97</span>
 115
 116 </div>
 117 <div class="viewcode-block" id="AnsiBack"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiBack">[docs]</a><span class="k">class</span> <span class="nc">AnsiBack</span><span class="p">(</span><span class="n">AnsiCodes</span><span class="p">):</span>
 118     <span class="n">BLACK</span>           <span class="o">=</span> <span class="mi">40</span>
 119     <span class="n">RED</span>             <span class="o">=</span> <span class="mi">41</span>
 120     <span class="n">GREEN</span>           <span class="o">=</span> <span class="mi">42</span>
 121     <span class="n">YELLOW</span>          <span class="o">=</span> <span class="mi">43</span>
 122     <span class="n">BLUE</span>            <span class="o">=</span> <span class="mi">44</span>
 123     <span class="n">MAGENTA</span>         <span class="o">=</span> <span class="mi">45</span>
 124     <span class="n">CYAN</span>            <span class="o">=</span> <span class="mi">46</span>
 125     <span class="n">WHITE</span>           <span class="o">=</span> <span class="mi">47</span>
 126     <span class="n">RESET</span>           <span class="o">=</span> <span class="mi">49</span>
 127
 128     <span class="c"># These are fairly well supported, but not part of the standard.</span>
 129     <span class="n">LIGHTBLACK_EX</span>   <span class="o">=</span> <span class="mi">100</span>
 130     <span class="n">LIGHTRED_EX</span>     <span class="o">=</span> <span class="mi">101</span>
 131     <span class="n">LIGHTGREEN_EX</span>   <span class="o">=</span> <span class="mi">102</span>
 132     <span class="n">LIGHTYELLOW_EX</span>  <span class="o">=</span> <span class="mi">103</span>
 133     <span class="n">LIGHTBLUE_EX</span>    <span class="o">=</span> <span class="mi">104</span>
 134     <span class="n">LIGHTMAGENTA_EX</span> <span class="o">=</span> <span class="mi">105</span>
 135     <span class="n">LIGHTCYAN_EX</span>    <span class="o">=</span> <span class="mi">106</span>
 136     <span class="n">LIGHTWHITE_EX</span>   <span class="o">=</span> <span class="mi">107</span>
 137
 138 </div>
 139 <div class="viewcode-block" id="AnsiStyle"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.ansi.AnsiStyle">[docs]</a><span class="k">class</span> <span class="nc">AnsiStyle</span><span class="p">(</span><span class="n">AnsiCodes</span><span class="p">):</span>
 140     <span class="n">BRIGHT</span>    <span class="o">=</span> <span class="mi">1</span>
 141     <span class="n">DIM</span>       <span class="o">=</span> <span class="mi">2</span>
 142     <span class="n">NORMAL</span>    <span class="o">=</span> <span class="mi">22</span>
 143     <span class="n">RESET_ALL</span> <span class="o">=</span> <span class="mi">0</span>
 144 </div>
 145 <span class="n">Fore</span>   <span class="o">=</span> <span class="n">AnsiFore</span><span class="p">()</span>
 146 <span class="n">Back</span>   <span class="o">=</span> <span class="n">AnsiBack</span><span class="p">()</span>
 147 <span class="n">Style</span>  <span class="o">=</span> <span class="n">AnsiStyle</span><span class="p">()</span>
 148 <span class="n">Cursor</span> <span class="o">=</span> <span class="n">AnsiCursor</span><span class="p">()</span>
 149 </pre></div>
 150
 151           </div>
 152         </div>
 153       </div>
 154       <div class="sphinxsidebar">
 155         <div class="sphinxsidebarwrapper">
 156             <p class="logo"><a href="../../../index.html">
 157               <img class="logo" src="../../../_static/sat_v5.0.png" alt="Logo"/>
 158             </a></p><div class="relations">
 159 <h3>Related Topics</h3>
 160 <ul>
 161   <li><a href="../../../index.html">Documentation overview</a><ul>
 162   <li><a href="../../index.html">Module code</a><ul>
 163   </ul></li>
 164   </ul></li>
 165 </ul>
 166 </div>
 167 <div id="searchbox" style="display: none">
 168   <h3>Quick search</h3>
 169     <form class="search" action="../../../search.html" method="get">
 170       <input type="text" name="q" />
 171       <input type="submit" value="Go" />
 172       <input type="hidden" name="check_keywords" value="yes" />
 173       <input type="hidden" name="area" value="default" />
 174     </form>
 175     <p class="searchtip" style="font-size: 90%">
 176     Enter search terms or a module, class or function name.
 177     </p>
 178 </div>
 179 <script type="text/javascript">$('#searchbox').show(0);</script>
 180         </div>
 181       </div>
 182       <div class="clearer"></div>
 183     </div>
 184     <div class="footer">
 185       &copy;2018, CEA.
 186
 187       |
 188       Powered by <a href="http://sphinx-doc.org/">Sphinx 1.1.3</a>
 189       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster </a>
 190
 191     </div>
 192
 193
 194
 195
 196   </body>
 197 </html>