docutils.parsers.rst.states.Text

class documentation

class Text(RSTState): (source)

Known subclasses: docutils.parsers.rst.states.SpecializedText

Classifier of second line of a text block. Could be a paragraph, a definition list item, or a title.

Method	`blank`	End of paragraph.
Method	`definition_list_item`	Undocumented
Method	`eof`	Handle end-of-file. Return empty result.
Method	`indent`	Definition list item.
Method	`literal_block`	Return a list of nodes.
Method	`quoted_literal_block`	Undocumented
Method	`term`	Return a definition_list's term and optional classifiers.
Method	`text`	Paragraph.
Method	`underline`	Section title.
Class Variable	`classifier_delimiter`	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.

Inherited from RSTState:

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 (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`	A mapping of transition names to 3-tuples containing (compiled_pattern, transition_method, next_state_name). Initialized as an instance attribute dynamically (instead of as a class attribute) because it may make forward references to patterns and methods in this or other classes.

def blank(self, match, context, next_state): (source)

overrides docutils.statemachine.StateWS.blank

overridden in docutils.parsers.rst.states.Line

End of paragraph.

def definition_list_item(self, termline): (source)

Undocumented

def eof(self, context): (source)

overrides docutils.statemachine.State.eof

overridden in docutils.parsers.rst.states.SpecializedText

Handle end-of-file. Return empty result. Override in subclasses. Parameter `context`: application-defined storage.

def indent(self, match, context, next_state): (source)

overrides docutils.statemachine.StateWS.indent

overridden in docutils.parsers.rst.states.Definition

Definition list item.

def literal_block(self): (source)

Return a list of nodes.

def quoted_literal_block(self): (source)

Undocumented

def term(self, lines, lineno): (source)

Return a definition_list's term and optional classifiers.

def text(self, match, context, next_state): (source)

overridden in docutils.parsers.rst.states.Line

Paragraph.

def underline(self, match, context, next_state): (source)

overridden in docutils.parsers.rst.states.Line

Section title.

classifier_delimiter = (source)

Undocumented

initial_transitions: list = (source)

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 = (source)

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.