docutils.parsers.rst.directives.tables.CSVTable Class Reference

Inheritance diagram for docutils.parsers.rst.directives.tables.CSVTable:

Collaboration diagram for docutils.parsers.rst.directives.tables.CSVTable:

Classes
class	DocutilsDialect
class	HeaderDialect

Public Member Functions
	process_header_option (self)
	run (self)
	get_csv_data (self)
	parse_csv_data_into_rows (self, csv_data, dialect, source)
Public Member Functions inherited from docutils.parsers.rst.directives.tables.Table
	make_title (self)
	check_table_dimensions (self, rows, header_rows, stub_columns)
	set_table_width (self, table_node)
	widths (self)
	get_column_widths (self, n_cols)
	extend_short_rows_with_empty_cells (self, columns, parts)
Public Member Functions inherited from docutils.parsers.rst.Directive
	__init__ (self, name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)
	directive_error (self, level, message)
	debug (self, message)
	info (self, message)
	warning (self, message)
	error (self, message)
	severe (self, message)
	assert_has_content (self)
	add_name (self, node)

Static Public Member Functions
	check_requirements ()
	decode_from_csv (s)
	encode_for_csv (s)

Public Attributes
	options
	name
	block_text
Public Attributes inherited from docutils.parsers.rst.directives.tables.Table
	lineno
	name
	block_text
	widths
Public Attributes inherited from docutils.parsers.rst.Directive
	name
	arguments
	options
	content
	lineno
	content_offset
	block_text
	state
	state_machine
	reporter

Static Public Attributes
dict	option_spec
Static Public Attributes inherited from docutils.parsers.rst.directives.tables.Table
int	optional_arguments = 1
bool	final_argument_whitespace = True
dict	option_spec
bool	has_content = True
Static Public Attributes inherited from docutils.parsers.rst.Directive
int	required_arguments = 0
int	optional_arguments = 0
bool	final_argument_whitespace = False
	option_spec = None
bool	has_content = False

Member Function Documentation

get_csv_data()

docutils.parsers.rst.directives.tables.CSVTable.get_csv_data

(

self

)

Get CSV data from the directive content, from an external
file, or from a URL reference.

run()

docutils.parsers.rst.directives.tables.CSVTable.run

(

self

)

Reimplemented from docutils.parsers.rst.Directive.

Member Data Documentation

option_spec

dict docutils.parsers.rst.directives.tables.CSVTable.option_spec

static

Initial value:

=  {'header-rows': directives.nonnegative_int,
                   'stub-columns': directives.nonnegative_int,
                   'header': directives.unchanged,
                   'width': directives.length_or_percentage_or_unitless,
                   'widths': directives.value_or(('auto', ),
                                                 directives.positive_int_list),
                   'file': directives.path,
                   'url': directives.uri,
                   'encoding': directives.encoding,
                   'class': directives.class_option,
                   'name': directives.unchanged,
                   'align': align,
                   # field delimiter char
                   'delim': directives.single_char_or_whitespace_or_unicode,
                   # treat whitespace after delimiter as significant
                   'keepspace': directives.flag,
                   # text field quote/unquote char:
                   'quote': directives.single_char_or_unicode,
                   # char used to escape delim & quote as-needed:
                   'escape': directives.single_char_or_unicode}

---

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

• docs/help/help-venv/lib/python3.12/site-packages/docutils/parsers/rst/directives/tables.py