python-terminaltables-doc 3.1.0-2 / usr / share / doc / python-terminaltables-doc / html / asciitable.html

This file is indexed.

/usr/share/doc/python-terminaltables-doc/html/asciitable.html is in python-terminaltables-doc 3.1.0-2.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>AsciiTable &mdash; terminaltables</title>
  

  
  
    <link rel="shortcut icon" href="_static/favicon.ico"/>
  
  
  

  

  
  
    

  

  
  
    <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  

  
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
  

  
        <link rel="index" title="Index"
              href="genindex.html"/>
        <link rel="search" title="Search" href="search.html"/>
    <link rel="top" title="terminaltables" href="index.html"/>
        <link rel="next" title="SingleTable" href="singletable.html"/>
        <link rel="prev" title="Settings" href="settings.html"/> 

  
  <script src="_static/js/modernizr.min.js"></script>

</head>

<body class="wy-body-for-nav" role="document">

   
  <div class="wy-grid-for-nav">

    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search">
          

          
            <a href="index.html" class="icon icon-home"> terminaltables
          

          
          </a>

          
            
            
              <div class="version">
                3.1.0
              </div>
            
          

          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
            
              
            
            
              <p class="caption"><span class="caption-text">General</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="install.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quickstart</a></li>
<li class="toctree-l1"><a class="reference internal" href="settings.html">Settings</a></li>
</ul>
<p class="caption"><span class="caption-text">Table Styles</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">AsciiTable</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#api">API</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="singletable.html">SingleTable</a></li>
<li class="toctree-l1"><a class="reference internal" href="doubletable.html">DoubleTable</a></li>
<li class="toctree-l1"><a class="reference internal" href="githubtable.html">GithubFlavoredMarkdownTable</a></li>
</ul>
<p class="caption"><span class="caption-text">Appendix</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
</ul>

            
          
        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
        
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="index.html">terminaltables</a>
        
      </nav>


      
      <div class="wy-nav-content">
        <div class="rst-content">
          















<div role="navigation" aria-label="breadcrumbs navigation">

  <ul class="wy-breadcrumbs">
    
      <li><a href="index.html">Docs</a> &raquo;</li>
        
      <li>AsciiTable</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
            
            
              <a href="https://github.com/robpol86/terminaltables/blob/master/docs/asciitable.rst" class="fa fa-github"> Edit on GitHub</a>
            
          
        
      </li>
    
  </ul>

  
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <div class="section" id="asciitable">
<span id="id1"></span><h1>AsciiTable<a class="headerlink" href="#asciitable" title="Permalink to this headline"></a></h1>
<p>AsciiTable is the simplest table. It uses <code class="docutils literal"><span class="pre">+</span></code>, <code class="docutils literal"><span class="pre">|</span></code>, and <code class="docutils literal"><span class="pre">-</span></code> characters to build the borders.</p>
<a class="reference external image-reference" href="_images/asciitable.png"><img alt="_images/asciitable.png" src="_images/asciitable.png" /></a>
<div class="section" id="api">
<h2>API<a class="headerlink" href="#api" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="terminaltables.AsciiTable">
<em class="property">class </em><code class="descclassname">terminaltables.</code><code class="descname">AsciiTable</code><span class="sig-paren">(</span><em>table_data</em>, <em>title=None</em><span class="sig-paren">)</span><a class="headerlink" href="#terminaltables.AsciiTable" title="Permalink to this definition"></a></dt>
<dd><p>Draw a table using regular ASCII characters, such as <code class="docutils literal"><span class="pre">+</span></code>, <code class="docutils literal"><span class="pre">|</span></code>, and <code class="docutils literal"><span class="pre">-</span></code>.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Variables:</th><td class="field-body"><ul class="first last simple">
<li><a class="reference internal" href="settings.html#Table.table_data" title="Table.table_data"><strong>table_data</strong></a> (<em>iter</em>) – List (empty or list of lists of strings) representing the table.</li>
<li><a class="reference internal" href="settings.html#Table.title" title="Table.title"><strong>title</strong></a> (<em>str</em>) – Optional title to show within the top border of the table.</li>
<li><a class="reference internal" href="settings.html#Table.inner_column_border" title="Table.inner_column_border"><strong>inner_column_border</strong></a> (<em>bool</em>) – Separates columns.</li>
<li><a class="reference internal" href="settings.html#Table.inner_footing_row_border" title="Table.inner_footing_row_border"><strong>inner_footing_row_border</strong></a> (<em>bool</em>) – Show a border before the last row.</li>
<li><a class="reference internal" href="settings.html#Table.inner_heading_row_border" title="Table.inner_heading_row_border"><strong>inner_heading_row_border</strong></a> (<em>bool</em>) – Show a border after the first row.</li>
<li><a class="reference internal" href="settings.html#Table.inner_row_border" title="Table.inner_row_border"><strong>inner_row_border</strong></a> (<em>bool</em>) – Show a border in between every row.</li>
<li><a class="reference internal" href="settings.html#Table.outer_border" title="Table.outer_border"><strong>outer_border</strong></a> (<em>bool</em>) – Show the top, left, right, and bottom border.</li>
<li><a class="reference internal" href="settings.html#Table.justify_columns" title="Table.justify_columns"><strong>justify_columns</strong></a> (<em>dict</em>) – Horizontal justification. Keys are column indexes (int). Values are right/left/center.</li>
<li><a class="reference internal" href="settings.html#Table.padding_left" title="Table.padding_left"><strong>padding_left</strong></a> (<em>int</em>) – Number of spaces to pad on the left side of every cell.</li>
<li><a class="reference internal" href="settings.html#Table.padding_right" title="Table.padding_right"><strong>padding_right</strong></a> (<em>int</em>) – Number of spaces to pad on the right side of every cell.</li>
</ul>
</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="terminaltables.AsciiTable.column_max_width">
<code class="descname">column_max_width</code><span class="sig-paren">(</span><em>column_number</em><span class="sig-paren">)</span><a class="headerlink" href="#terminaltables.AsciiTable.column_max_width" title="Permalink to this definition"></a></dt>
<dd><p>Return the maximum width of a column based on the current terminal width.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>column_number</strong> (<em>int</em>) – The column number to query.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The max width of the column.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">int</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="attribute">
<dt id="terminaltables.AsciiTable.column_widths">
<code class="descname">column_widths</code><a class="headerlink" href="#terminaltables.AsciiTable.column_widths" title="Permalink to this definition"></a></dt>
<dd><p>Return a list of integers representing the widths of each table column without padding.</p>
</dd></dl>

<dl class="attribute">
<dt id="terminaltables.AsciiTable.ok">
<code class="descname">ok</code><a class="headerlink" href="#terminaltables.AsciiTable.ok" title="Permalink to this definition"></a></dt>
<dd><p>Return True if the table fits within the terminal width, False if the table breaks.</p>
</dd></dl>

<dl class="attribute">
<dt id="terminaltables.AsciiTable.table">
<code class="descname">table</code><a class="headerlink" href="#terminaltables.AsciiTable.table" title="Permalink to this definition"></a></dt>
<dd><p>Return a large string of the entire table ready to be printed to the terminal.</p>
</dd></dl>

<dl class="attribute">
<dt id="terminaltables.AsciiTable.table_width">
<code class="descname">table_width</code><a class="headerlink" href="#terminaltables.AsciiTable.table_width" title="Permalink to this definition"></a></dt>
<dd><p>Return the width of the table including padding and borders.</p>
</dd></dl>

</dd></dl>

</div>
</div>


           </div>
           <div class="articleComments">
            
           </div>
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="singletable.html" class="btn btn-neutral float-right" title="SingleTable" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
      
      
        <a href="settings.html" class="btn btn-neutral" title="Settings" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2017, @Robpol86.

    </p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 

</footer>

        </div>
      </div>

    </section>

  </div>
  


  

    <script type="text/javascript">
        var DOCUMENTATION_OPTIONS = {
            URL_ROOT:'./',
            VERSION:'3.1.0',
            COLLAPSE_INDEX:false,
            FILE_SUFFIX:'.html',
            HAS_SOURCE:  true,
            SOURCELINK_SUFFIX: '.txt'
        };
    </script>
      <script type="text/javascript" src="_static/jquery.js"></script>
      <script type="text/javascript" src="_static/underscore.js"></script>
      <script type="text/javascript" src="_static/doctools.js"></script>

  

  
  
    <script type="text/javascript" src="_static/js/theme.js"></script>
  

  
  
  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.StickyNav.enable();
      });
  </script>
   

</body>
</html>

APT Browse - Built by Thomas Orozco.