docutils.parsers.rst.states.QuotedLiteralBlock

class documentation

class QuotedLiteralBlock(RSTState):

View In Hierarchy

Nested parse handler for quoted (unindented) literal blocks.

Special-purpose. Not for inclusion in state_classes.

Method __init__ Initialize a StateSM object; extends State.__init__().
Method blank Handle blank lines. Does nothing. Override in subclasses.
Method eof Handle end-of-file. Return empty result.
Method indent Handle an indented text block. Extend or override in subclasses.
Method initial​_quoted Match arbitrary quote character on the first line only.
Method quoted Match consistent quotes on subsequent lines.
Method text Undocumented
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 patterns {Name: pattern} mapping, used by make_transition(). Each pattern may be a string or a compiled re pattern. Override in subclasses.
Instance Variable initial​_lineno Undocumented
Instance Variable messages Undocumented

Inherited from RSTState:

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 (via RSTState):

Method add​_initial​_transitions Add whitespace-specific transitions before those defined in subclass.
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 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 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 __init__(self, state_machine, debug=False):
overrides docutils.parsers.rst.states.RSTState.__init__

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

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

def blank(self, match, context, next_state):
overrides docutils.statemachine.StateWS.blank
Handle blank lines. Does nothing. Override in subclasses.
def eof(self, context):
overrides docutils.statemachine.State.eof

Handle end-of-file. Return empty result.

Override in subclasses.

Parameter context: application-defined storage.

def indent(self, match, context, next_state):
overrides docutils.statemachine.StateWS.indent

Handle an indented text block. Extend or override in subclasses.

Recursively run the registered state machine for indented blocks (self.indent_sm).

def initial_quoted(self, match, context, next_state):
Match arbitrary quote character on the first line only.
def quoted(self, match, context, next_state):
Match consistent quotes on subsequent lines.
def text(self, match, context, next_state):

Undocumented

initial_transitions: tuple[str, ...] =
overrides docutils.statemachine.State.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.
patterns =
overrides docutils.statemachine.StateWS.patterns
{Name: pattern} mapping, used by make_transition(). Each pattern may be a string or a compiled re pattern. Override in subclasses.
initial_lineno =

Undocumented

messages: list =

Undocumented