Inheritance diagram for docutils.parsers.rst.tableparser.SimpleTableParser:

Collaboration diagram for docutils.parsers.rst.tableparser.SimpleTableParser:

Public Member Functions
	setup (self, block)

	parse_table (self)

	parse_columns (self, line, offset)

	init_row (self, colspec, offset)

	parse_row (self, lines, start, spanline=None)

	check_columns (self, lines, first_line, columns)

	structure_from_cells (self)

Public Member Functions inherited from docutils.parsers.rst.tableparser.TableParser
	parse (self, block)

	find_head_body_sep (self)

Public Attributes
	block

	head_body_sep

	columns

	border_end

	table

	done

	rowseps

	colseps

	double_width_pad_char

Public Attributes inherited from docutils.parsers.rst.tableparser.TableParser
	block

	head_body_sep

Static Public Attributes
	head_body_separator_pat = re.compile('=[ =]*$')

	span_pat = re.compile('-[ -]*$')

Static Public Attributes inherited from docutils.parsers.rst.tableparser.TableParser
	head_body_separator_pat = None

str	double_width_pad_char = '\x00'

Detailed Description

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, [''])]])

Member Function Documentation

◆ check_columns()

docutils.parsers.rst.tableparser.SimpleTableParser.check_columns	(	self,
		lines,
		first_line,
		columns
	)

Check for text in column margins and text overflow in the last column.
Raise TableMarkupError if anything but whitespace is in column margins.
Adjust the end value for the last column if there is text overflow.

◆ parse_columns()

docutils.parsers.rst.tableparser.SimpleTableParser.parse_columns	(	self,
		line,
		offset
	)

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

◆ parse_row()

docutils.parsers.rst.tableparser.SimpleTableParser.parse_row	(	self,
		lines,
		start,
		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 insignificant whitespace.

◆ parse_table()

docutils.parsers.rst.tableparser.SimpleTableParser.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.

The documentation for this class was generated from the following file:

docs/help/help-venv/lib/python3.12/site-packages/docutils/parsers/rst/tableparser.py

Public Member Functions