docutils.parsers.rst.states.SpecializedBody

class documentation

class SpecializedBody(Body): (source)

Known subclasses: docutils.parsers.rst.directives.html.MetaBody, docutils.parsers.rst.states.BulletList, docutils.parsers.rst.states.DefinitionList, docutils.parsers.rst.states.EnumeratedList, docutils.parsers.rst.states.Explicit, docutils.parsers.rst.states.FieldList, docutils.parsers.rst.states.LineBlock, docutils.parsers.rst.states.OptionList, docutils.parsers.rst.states.RFC2822List

View In Hierarchy

Superclass for second and subsequent compound element members. Compound elements are lists and list-like constructs.

All transition methods are disabled (redefined as invalid_input). Override individual methods in subclasses to re-enable.

For example, once an initial bullet list item, say, is recognized, the BulletList subclass takes over, with a "bullet_list" node as its container. Upon encountering the initial bullet list item, Body.bullet calls its self.nested_list_parse (RSTState.nested_list_parse), which starts up a nested parsing session with BulletList as the initial state. Only the bullet transition method is enabled in BulletList; as long as only bullet list items are encountered, they are parsed and inserted into the container. The first construct which is not a bullet list item triggers the invalid_input method, which ends the nested parse and closes the container. BulletList needs to recognize input that is invalid in the context of a bullet list, which means everything other than bullet list items, so it inherits the transition list created in Body.

Method invalid​_input Not a compound element member. Abort this state machine.

Inherited from Body:

Method add​_target Undocumented
Method anonymous Anonymous hyperlink targets.
Method anonymous​_target Undocumented
Method block​_quote Undocumented
Method build​_table Undocumented
Method build​_table​_row Undocumented
Method bullet Bullet list item.
Method check​_attribution Check attribution shape. Return the index past the end of the attribution, and the indent.
Method citation Undocumented
Method comment Undocumented
Method directive Returns a 2-tuple: list of nodes, and a "blank finish" boolean.
Method disallowed​_inside​_substitution​_definitions Undocumented
Method doctest Undocumented
Method enumerator Enumerated List Item
Method explicit​_construct Determine which explicit construct this is, parse & return it.
Method explicit​_list Create a nested state machine for a series of explicit markup constructs (including anonymous hyperlink targets).
Method explicit​_markup Footnotes, hyperlink targets, directives, comments.
Method field Undocumented
Method field​_marker Field list item.
Method footnote Undocumented
Method grid​_table​_top Top border of a full table.
Method hyperlink​_target Undocumented
Method indent Block quote.
Method is​_enumerated​_list​_item Check validity based on the ordinal value and the second line.
Method is​_reference Undocumented
Method isolate​_grid​_table Undocumented
Method isolate​_simple​_table Undocumented
Method line Section title overline or transition marker.
Method line​_block First line of a line block.
Method line​_block​_line Return one line element of a line_block.
Method list​_item Undocumented
Method make​_enumerator Construct and return the next enumerated list item marker, and an auto-enumerator ("#" instead of the regular enumerator).
Method make​_target Undocumented
Method malformed​_table Undocumented
Method nest​_line​_block​_lines Undocumented
Method nest​_line​_block​_segment Undocumented
Method option​_list​_item Undocumented
Method option​_marker Option list item.
Method parse​_attribution Undocumented
Method parse​_directive​_arguments Undocumented
Method parse​_directive​_block Undocumented
Method parse​_directive​_options Undocumented
Method parse​_enumerator Analyze an enumerator and return the results.
Method parse​_extension​_options Parse datalines for a field list containing extension options matching option_spec.
Method parse​_field​_body Undocumented
Method parse​_field​_marker Extract & return field name from a field marker match.
Method parse​_option​_marker Return a list of node.option and node.option_argument objects, parsed from an option marker match.
Method parse​_target Determine the type of reference of a target.
Method run​_directive Parse a directive then run its directive function.
Method simple​_table​_top Top border of a simple table.
Method split​_attribution Check for a block quote attribution and split it off:
Method substitution​_def Undocumented
Method table Parse a table.
Method table​_top Top border of a generic table.
Method text Titles, definition lists, paragraphs.
Method unknown​_directive Undocumented
Class Variable attribution​_pattern Undocumented
Class Variable enum Enumerated list parsing information.
Class Variable explicit Patterns and constants used for explicit markup recognition.
Class Variable grid​_table​_top​_pat Matches the top (& bottom) of a full table).
Class Variable initial​_transitions A list of transitions to initialize when a State is instantiated. Each entry is either a transition name string, or a (transition name, next state name) pair. See make_transitions(). Override in subclasses.
Class Variable pats Fragments of patterns used by transitions.
Class Variable patterns {Name: pattern} mapping, used by make_transition(). Each pattern may be a string or a compiled re pattern. Override in subclasses.
Class Variable simple​_table​_border​_pat Matches the bottom & header bottom of a simple table.
Class Variable simple​_table​_top​_pat Matches the top of a simple table.

Inherited from RSTState (via Body):

Method __init__ Initialize a StateSM object; extends State.__init__().
Method bof Called at beginning of file.
Method check​_subsection Check for a valid subsection header. Return 1 (true) or None (false).
Method goto​_line Jump to input line abs_line_offset, ignoring jumps past the end.
Method inline​_text Return 2 lists: nodes (text and inline elements), and system_messages.
Method nested​_list​_parse Create a new StateMachine rooted at node and run it over the input block. Also keep track of optional intermediate blank lines and the required final one.
Method nested​_parse Create a new StateMachine rooted at node and run it over the input block.
Method new​_subsection Append new subsection to document tree. On return, check level.
Method no​_match Override StateWS.no_match to generate a system message.
Method paragraph Return a list (paragraph & messages) & a boolean: literal_block next?
Method runtime​_init Initialize this State before running the state machine; called from self.state_machine.run().
Method section Check for a valid subsection and create one if it checks out.
Method title​_inconsistent Undocumented
Method unindent​_warning Undocumented
Class Variable nested​_sm​_cache Undocumented
Instance Variable document Undocumented
Instance Variable inliner Undocumented
Instance Variable memo Undocumented
Instance Variable nested​_sm​_kwargs Keyword arguments dictionary, passed to the nested_sm constructor.
Instance Variable parent Undocumented
Instance Variable reporter Undocumented

Inherited from StateWS (via Body, RSTState):

Method add​_initial​_transitions Add whitespace-specific transitions before those defined in subclass.
Method blank Handle blank lines. Does nothing. Override in subclasses.
Method first​_known​_indent Handle an indented text block (first line's indent known).
Method known​_indent Handle a known-indent text block. Extend or override in subclasses.
Class Variable ws​_initial​_transitions Default initial whitespace transitions, added before those listed in State.initial_transitions. May be overridden in subclasses.
Class Variable ws​_patterns Patterns for default whitespace transitions. May be overridden in subclasses.
Instance Variable indent​_sm The StateMachine class handling indented text blocks.
Instance Variable indent​_sm​_kwargs Keyword arguments dictionary, passed to the indent_sm constructor.
Instance Variable known​_indent​_sm The StateMachine class handling known-indented text blocks.
Instance Variable known​_indent​_sm​_kwargs Keyword arguments dictionary, passed to the known_indent_sm constructor.

Inherited from State (via Body, RSTState, StateWS):

Method add​_transition Add a transition to the start of the transition list.
Method add​_transitions Add a list of transitions to the start of the transition list.
Method eof Handle end-of-file. Return empty result.
Method make​_transition Make & return a transition tuple based on name.
Method make​_transitions Return a list of transition names and a transition mapping.
Method nop A "do nothing" transition method.
Method remove​_transition Remove a transition by name.
Method unlink Remove circular references to objects no longer required.
Instance Variable debug Debugging mode on/off.
Instance Variable nested​_sm The StateMachine class for handling nested processing.
Instance Variable state​_machine A reference to the controlling StateMachine object.
Instance Variable transition​_order A list of transition names in search order.
Instance Variable transitions No summary
def invalid_input(self, match=None, context=None, next_state=None): (source)
Not a compound element member. Abort this state machine.