Package docutils :: Package parsers :: Package rst :: Module tableparser :: Class SimpleTableParser
[show private | hide private]
[frames | no frames]

Class SimpleTableParser

TableParser --+
              |
             SimpleTableParser


Parse a simple table using parse().

Here's an example of a simple table:

=====  =====
col 1  col 2
=====  =====
1      Second column of row 1.
2      Second column of row 2.
       Second line of paragraph.
3      - Second column of row 3.

       - Second item in bullet
         list (row 3, column 2).
4 is a span
------------
5
=====  =====

Top and bottom borders use '=', column span underlines use '-', column separation is indicated with spaces.

Passing the above table to the parse() method will result in the following data structure, whose interpretation is the same as for GridTableParser:

([5, 25],
 [[(0, 0, 1, ['col 1']),
   (0, 0, 1, ['col 2'])]],
 [[(0, 0, 3, ['1']),
   (0, 0, 3, ['Second column of row 1.'])],
  [(0, 0, 4, ['2']),
   (0, 0, 4, ['Second column of row 2.',
              'Second line of paragraph.'])],
  [(0, 0, 6, ['3']),
   (0, 0, 6, ['- Second column of row 3.',
              '',
              '- Second item in bullet',
              '  list (row 3, column 2).'])],
  [(0, 1, 10, ['4 is a span'])],
  [(0, 0, 12, ['5']),
   (0, 0, 12, [''])]])

Method Summary
  adjust_last_column(self, new_end)
  init_row(self, colspec, offset)
  parse_columns(self, line, offset)
Given a column span underline, return a list of (begin, end) pairs.
  parse_row(self, lines, spanline)
Given the text lines of a row, parse it and append to self.table.
  parse_table(self)
First determine the column boundaries from the top border, then process rows.
  setup(self, block)
  structure_from_cells(self)
    Inherited from TableParser
  find_head_body_sep(self)
Look for a head/body row separator line; store the line index.
  parse(self, block)
Analyze the text block and return a table data structure.

Class Variable Summary
SRE_Pattern head_body_separator_pat = =[ =]*$
SRE_Pattern span_pat = -[ -]*$

Method Details

parse_columns(self, line, offset)

Given a column span underline, return a list of (begin, end) pairs.

parse_row(self, lines, spanline=None)

Given the text lines of a row, parse it and append to self.table.

The row is parsed according to the current column spec (either spanline if provided or self.columns). For each column, extract text from each line, and check for text in column margins. Finally, adjust for insigificant whitespace.

parse_table(self)

First determine the column boundaries from the top border, then process rows. Each row may consist of multiple lines; accumulate lines until a row is complete. Call self.parse_row to finish the job.

Class Variable Details

head_body_separator_pat

Type:
SRE_Pattern
Value:
=[ =]*$                                                                

span_pat

Type:
SRE_Pattern
Value:
-[ -]*$                                                                

Generated by Epydoc 2.0 on Tue Jul 22 05:30:35 2003 http://epydoc.sf.net