docutils.parsers.rst.tableparser.TableParser

class documentation

class TableParser: (source)

Known subclasses: docutils.parsers.rst.tableparser.GridTableParser, docutils.parsers.rst.tableparser.SimpleTableParser

View In Hierarchy

Abstract superclass for the common parts of the syntax-specific parsers.

Method	`find_head_body_sep`	Look for a head/body row separator line; store the line index.
Method	`parse`	Analyze the text `block` and return a table data structure.
Class Variable	`double_width_pad_char`	Padding character for East Asian double-width text.
Class Variable	`head_body_separator_pat`	Matches the row separator between head rows and body rows.

def find_head_body_sep(self): (source)

Look for a head/body row separator line; store the line index.

def parse(self, block): (source)

Analyze the text `block` and return a table data structure. Given a plaintext-graphic table in `block` (list of lines of text; no whitespace padding), parse the table, construct and return the data necessary to construct a CALS table or equivalent. Raise `TableMarkupError` if there is any problem with the markup.

double_width_pad_char: str = (source)

Padding character for East Asian double-width text.

head_body_separator_pat = (source)

overridden in docutils.parsers.rst.tableparser.GridTableParser, docutils.parsers.rst.tableparser.SimpleTableParser

Matches the row separator between head rows and body rows.