docutils.parsers.rst.states.RSTState

class documentation

class RSTState(StateWS):

Known subclasses: docutils.parsers.rst.states.Body, docutils.parsers.rst.states.QuotedLiteralBlock, docutils.parsers.rst.states.Text

View In Hierarchy

reStructuredText State superclass.

Contains methods used by all State subclasses.

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 True or 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:

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 indent Handle an indented text block. Extend or override in subclasses.
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.
Instance Variable patterns {Name: pattern} mapping, used by make_transition(). Each pattern may be a string or a compiled re pattern. Override in subclasses.

Inherited from State (via 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.
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.
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 __init__(self, state_machine, debug=False):
overrides docutils.statemachine.StateWS.__init__
overridden in docutils.parsers.rst.states.QuotedLiteralBlock

Initialize a StateSM object; extends State.__init__().

Check for indent state machine attributes, set defaults if not set.

def bof(self, context):
overrides docutils.statemachine.State.bof
Called at beginning of file.
def check_subsection(self, source, style, lineno):

Check for a valid subsection header. Return True or False.

When a new section is reached that isn't a subsection of the current section, back up the line count (use previous_line(-x)), then raise EOFError. The current StateMachine will finish, then the calling StateMachine can re-examine the title. This will work its way back up the calling chain until the correct section level isreached.

@@@ Alternative: Evaluate the title, store the title info & level, and back up the chain until that level is reached. Store in memo? Or return in results?

Unknown Field: exception
EOFError when a sibling or supersection encountered.
def goto_line(self, abs_line_offset):
Jump to input line abs_line_offset, ignoring jumps past the end.
def inline_text(self, text, lineno):
Return 2 lists: nodes (text and inline elements), and system_messages.
def 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):
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.
def nested_parse(self, block, input_offset, node, match_titles=False, state_machine_class=None, state_machine_kwargs=None):
Create a new StateMachine rooted at node and run it over the input block.
def new_subsection(self, title, lineno, messages):
Append new subsection to document tree. On return, check level.
def no_match(self, context, transitions):
overrides docutils.statemachine.State.no_match

Override StateWS.no_match to generate a system message.

This code should never be run.

def paragraph(self, lines, lineno):
Return a list (paragraph & messages) & a boolean: literal_block next?
def runtime_init(self):
overrides docutils.statemachine.State.runtime_init
Initialize this State before running the state machine; called from self.state_machine.run().
def section(self, title, source, style, lineno, messages):
Check for a valid subsection and create one if it checks out.
def title_inconsistent(self, sourcetext, lineno):

Undocumented

def unindent_warning(self, node_name):

Undocumented

nested_sm_cache: list =

Undocumented

document =

Undocumented

inliner =

Undocumented

memo =

Undocumented

nested_sm_kwargs =
overrides docutils.statemachine.State.nested_sm_kwargs

Keyword arguments dictionary, passed to the nested_sm constructor.

Two keys must have entries in the dictionary:

  • Key 'state_classes' must be set to a list of State classes.
  • Key 'initial_state' must be set to the name of the initial state class.

If nested_sm_kwargs is left as None, 'state_classes' defaults to the class of the current state, and 'initial_state' defaults to the name of the class of the current state. Override in subclasses to avoid the defaults.

parent =

Undocumented

reporter =

Undocumented