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