Inheritance diagram for docutils.parsers.rst.states.Body:

Collaboration diagram for docutils.parsers.rst.states.Body:

Public Member Functions
	indent (self, match, context, next_state)

	block_quote (self, indented, line_offset)

	split_attribution (self, indented, line_offset)

	check_attribution (self, indented, attribution_start)

	parse_attribution (self, indented, line_offset)

	bullet (self, match, context, next_state)

	list_item (self, indent)

	enumerator (self, match, context, next_state)

	parse_enumerator (self, match, expected_sequence=None)

	is_enumerated_list_item (self, ordinal, sequence, format)

	make_enumerator (self, ordinal, sequence, format)

	field_marker (self, match, context, next_state)

	field (self, match)

	parse_field_marker (self, match)

	parse_field_body (self, indented, offset, node)

	option_marker (self, match, context, next_state)

	option_list_item (self, match)

	parse_option_marker (self, match)

	doctest (self, match, context, next_state)

	line_block (self, match, context, next_state)

	line_block_line (self, match, lineno)

	nest_line_block_lines (self, block)

	nest_line_block_segment (self, block)

	grid_table_top (self, match, context, next_state)

	simple_table_top (self, match, context, next_state)

	table_top (self, match, context, next_state, isolate_function, parser_class)

	table (self, isolate_function, parser_class)

	isolate_grid_table (self)

	isolate_simple_table (self)

	malformed_table (self, block, detail='', offset=0)

	build_table (self, tabledata, tableline, stub_columns=0, widths=None)

	build_table_row (self, rowdata, tableline)

	footnote (self, match)

	citation (self, match)

	hyperlink_target (self, match)

	make_target (self, block, block_text, lineno, target_name)

	parse_target (self, block, block_text, lineno)

	is_reference (self, reference)

	add_target (self, targetname, refuri, target, lineno)

	substitution_def (self, match)

	disallowed_inside_substitution_definitions (self, node)

	directive (self, match, **option_presets)

	run_directive (self, directive, match, type_name, option_presets)

	parse_directive_block (self, indented, line_offset, directive, option_presets)

	parse_directive_options (self, option_presets, option_spec, arg_block)

	parse_directive_arguments (self, directive, arg_block)

	parse_extension_options (self, option_spec, datalines)

	unknown_directive (self, type_name)

	comment (self, match)

	explicit_markup (self, match, context, next_state)

	explicit_construct (self, match)

	explicit_list (self, blank_finish)

	anonymous (self, match, context, next_state)

	anonymous_target (self, match)

	line (self, match, context, next_state)

	text (self, match, context, next_state)

Public Member Functions inherited from docutils.parsers.rst.states.RSTState
	__init__ (self, state_machine, debug=False)

	runtime_init (self)

	goto_line (self, abs_line_offset)

	no_match (self, context, transitions)

	bof (self, context)

	nested_parse (self, block, input_offset, node, match_titles=False, state_machine_class=None, state_machine_kwargs=None)

	nested_list_parse (self, block, input_offset, node, initial_state, blank_finish, blank_finish_state=None, extra_settings={}, match_titles=False, state_machine_class=None, state_machine_kwargs=None)

	section (self, title, source, style, lineno, messages)

	check_subsection (self, source, style, lineno)

	title_inconsistent (self, sourcetext, lineno)

	new_subsection (self, title, lineno, messages)

	paragraph (self, lines, lineno)

	inline_text (self, text, lineno)

	unindent_warning (self, node_name)

Public Member Functions inherited from docutils.statemachine.StateWS
	add_initial_transitions (self)

	blank (self, match, context, next_state)

	known_indent (self, match, context, next_state)

	first_known_indent (self, match, context, next_state)

Public Member Functions inherited from docutils.statemachine.State
	unlink (self)

	add_transitions (self, names, transitions)

	add_transition (self, name, transition)

	remove_transition (self, name)

	make_transition (self, name, next_state=None)

	make_transitions (self, name_list)

	eof (self, context)

	nop (self, match, context, next_state)

Public Attributes
	isolate_grid_table

	isolate_simple_table

	parent

	document

	state_machine

Public Attributes inherited from docutils.parsers.rst.states.RSTState
	nested_sm_kwargs

	memo

	reporter

	inliner

	document

	parent

Public Attributes inherited from docutils.statemachine.StateWS
	patterns

	ws_patterns

	ws_initial_transitions

Public Attributes inherited from docutils.statemachine.State
	transition_order

	transitions

	state_machine

	debug

Static Public Attributes
	double_width_pad_char = tableparser.TableParser.double_width_pad_char

	enum = Struct()

	formatinfo

	prefix

	suffix

	start

	end

	formats

	sequences

	sequencepats

	converters

	sequenceregexps

	grid_table_top_pat = re.compile(r'\+-[-+]+-\+ *$')

	simple_table_top_pat = re.compile('=+( +=+)+ *$')

	simple_table_border_pat = re.compile('=+[ =]*$')

dict	pats = {}

dict	patterns

tuple	initial_transitions

	attribution_pattern = re.compile('(---?(?!-)\|\u2014) *(?=[^ \\n])')

	explicit = Struct()

	patterns

	target

	reference

	substitution

	constructs

Static Public Attributes inherited from docutils.parsers.rst.states.RSTState
	nested_sm = NestedStateMachine

list	nested_sm_cache = []

Static Public Attributes inherited from docutils.statemachine.StateWS
	indent_sm = None

	indent_sm_kwargs = None

	known_indent_sm = None

	known_indent_sm_kwargs = None

dict	ws_patterns

tuple	ws_initial_transitions = ('blank', 'indent')

Static Public Attributes inherited from docutils.statemachine.State
	patterns = None

	initial_transitions = None

	nested_sm = None

	nested_sm_kwargs = None

Detailed Description

Generic classifier of the first line of a block.

Member Function Documentation

◆ anonymous()

docutils.parsers.rst.states.Body.anonymous	(	self,
		match,
		context,
		next_state
	)

Anonymous hyperlink targets.

Reimplemented in docutils.parsers.rst.states.Explicit.

◆ bullet()

docutils.parsers.rst.states.Body.bullet	(	self,
		match,
		context,
		next_state
	)

Bullet list item.

Reimplemented in docutils.parsers.rst.states.BulletList.

◆ check_attribution()

docutils.parsers.rst.states.Body.check_attribution	(	self,
		indented,
		attribution_start
	)

Check attribution shape.
Return the index past the end of the attribution, and the indent.

◆ directive()

docutils.parsers.rst.states.Body.directive	(		self,
			match,
		**	option_presets
	)

Returns a 2-tuple: list of nodes, and a "blank finish" boolean.

◆ enumerator()

docutils.parsers.rst.states.Body.enumerator	(	self,
		match,
		context,
		next_state
	)

Enumerated List Item

Reimplemented in docutils.parsers.rst.states.EnumeratedList.

◆ explicit_construct()

docutils.parsers.rst.states.Body.explicit_construct	(	self,
		match
	)

Determine which explicit construct this is, parse & return it.

◆ explicit_list()

docutils.parsers.rst.states.Body.explicit_list	(	self,
		blank_finish
	)

Create a nested state machine for a series of explicit markup
constructs (including anonymous hyperlink targets).

◆ explicit_markup()

docutils.parsers.rst.states.Body.explicit_markup	(	self,
		match,
		context,
		next_state
	)

Footnotes, hyperlink targets, directives, comments.

Reimplemented in docutils.parsers.rst.states.Explicit.

◆ field_marker()

docutils.parsers.rst.states.Body.field_marker	(	self,
		match,
		context,
		next_state
	)

Field list item.

Reimplemented in docutils.parsers.rst.directives.misc.MetaBody, and docutils.parsers.rst.states.FieldList.

◆ grid_table_top()

docutils.parsers.rst.states.Body.grid_table_top	(	self,
		match,
		context,
		next_state
	)

Top border of a full table.

◆ indent()

docutils.parsers.rst.states.Body.indent	(	self,
		match,
		context,
		next_state
	)

Block quote.

Reimplemented from docutils.statemachine.StateWS.

◆ is_enumerated_list_item()

docutils.parsers.rst.states.Body.is_enumerated_list_item	(	self,
		ordinal,
		sequence,
		format
	)

Check validity based on the ordinal value and the second line.

Return true if the ordinal is valid and the second line is blank,
indented, or starts with the next enumerator or an auto-enumerator.

◆ line()

docutils.parsers.rst.states.Body.line	(	self,
		match,
		context,
		next_state
	)

Section title overline or transition marker.

◆ line_block()

docutils.parsers.rst.states.Body.line_block	(	self,
		match,
		context,
		next_state
	)

First line of a line block.

Reimplemented in docutils.parsers.rst.states.LineBlock.

◆ line_block_line()

docutils.parsers.rst.states.Body.line_block_line	(	self,
		match,
		lineno
	)

Return one line element of a line_block.

◆ make_enumerator()

docutils.parsers.rst.states.Body.make_enumerator	(	self,
		ordinal,
		sequence,
		format
	)

Construct and return the next enumerated list item marker, and an
auto-enumerator ("#" instead of the regular enumerator).

Return ``None`` for invalid (out of range) ordinals.

◆ option_marker()

docutils.parsers.rst.states.Body.option_marker	(	self,
		match,
		context,
		next_state
	)

Option list item.

Reimplemented in docutils.parsers.rst.states.OptionList.

◆ parse_enumerator()

docutils.parsers.rst.states.Body.parse_enumerator	(	self,
		match,
		expected_sequence = `None`
	)

Analyze an enumerator and return the results.

:Return:
    - the enumerator format ('period', 'parens', or 'rparen'),
    - the sequence used ('arabic', 'loweralpha', 'upperroman', etc.),
    - the text of the enumerator, stripped of formatting, and
    - the ordinal value of the enumerator ('a' -> 1, 'ii' -> 2, etc.;
      ``None`` is returned for invalid enumerator text).

The enumerator format has already been determined by the regular
expression match. If `expected_sequence` is given, that sequence is
tried first. If not, we check for Roman numeral 1. This way,
single-character Roman numerals (which are also alphabetical) can be
matched. If no sequence has been matched, all sequences are checked in
order.

◆ parse_extension_options()

docutils.parsers.rst.states.Body.parse_extension_options	(	self,
		option_spec,
		datalines
	)

Parse `datalines` for a field list containing extension options
matching `option_spec`.

:Parameters:
    - `option_spec`: a mapping of option name to conversion
      function, which should raise an exception on bad input.
    - `datalines`: a list of input strings.

:Return:
    - Success value, 1 or 0.
    - An option dictionary on success, an error string on failure.

◆ parse_field_body()

docutils.parsers.rst.states.Body.parse_field_body	(	self,
		indented,
		offset,
		node
	)

Reimplemented in docutils.parsers.rst.states.ExtensionOptions.

◆ parse_field_marker()

docutils.parsers.rst.states.Body.parse_field_marker	(	self,
		match
	)

Extract & return field name from a field marker match.

◆ parse_option_marker()

docutils.parsers.rst.states.Body.parse_option_marker	(	self,
		match
	)

Return a list of `node.option` and `node.option_argument` objects,
parsed from an option marker match.

:Exception: `MarkupError` for invalid option markers.

◆ parse_target()

docutils.parsers.rst.states.Body.parse_target	(	self,
		block,
		block_text,
		lineno
	)

Determine the type of reference of a target.

:Return: A 2-tuple, one of:

    - 'refname' and the indirect reference name
    - 'refuri' and the URI
    - 'malformed' and a system_message node

◆ run_directive()

docutils.parsers.rst.states.Body.run_directive	(	self,
		directive,
		match,
		type_name,
		option_presets
	)

Parse a directive then run its directive function.

Parameters:

- `directive`: The class implementing the directive.  Must be
  a subclass of `rst.Directive`.

- `match`: A regular expression match object which matched the first
  line of the directive.

- `type_name`: The directive name, as used in the source text.

- `option_presets`: A dictionary of preset options, defaults for the
  directive options.  Currently, only an "alt" option is passed by
  substitution definitions (value: the substitution name), which may
  be used by an embedded image directive.

Returns a 2-tuple: list of nodes, and a "blank finish" boolean.

◆ simple_table_top()

docutils.parsers.rst.states.Body.simple_table_top	(	self,
		match,
		context,
		next_state
	)

Top border of a simple table.

◆ split_attribution()

docutils.parsers.rst.states.Body.split_attribution	(	self,
		indented,
		line_offset
	)

Check for a block quote attribution and split it off:

* First line after a blank line must begin with a dash ("--", "---",
  em-dash; matches `self.attribution_pattern`).
* Every line after that must have consistent indentation.
* Attributions must be preceded by block quote content.

Return a tuple of: (block quote content lines, attribution lines,
attribution offset, remaining indented lines, remaining lines offset).

◆ table()

docutils.parsers.rst.states.Body.table	(	self,
		isolate_function,
		parser_class
	)

Parse a table.

◆ table_top()

docutils.parsers.rst.states.Body.table_top	(	self,
		match,
		context,
		next_state,
		isolate_function,
		parser_class
	)

Top border of a generic table.

◆ text()

docutils.parsers.rst.states.Body.text	(	self,
		match,
		context,
		next_state
	)

Titles, definition lists, paragraphs.

Reimplemented in docutils.parsers.rst.states.DefinitionList, and docutils.parsers.rst.states.SubstitutionDef.

Member Data Documentation

◆ initial_transitions

tuple docutils.parsers.rst.states.Body.initial_transitions

static

Initial value:

=  (
          'bullet',
          'enumerator',
          'field_marker',
          'option_marker',
          'doctest',
          'line_block',
          'grid_table_top',
          'simple_table_top',
          'explicit_markup',
          'anonymous',
          'line',
          'text')

◆ patterns

dict docutils.parsers.rst.states.Body.patterns