docutils.parsers.rst.states.RSTState Class Reference

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

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

Public Member Functions
	__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)
	indent (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
	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
	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

reStructuredText State superclass.

Contains methods used by all State subclasses.

Constructor & Destructor Documentation

__init__()

docutils.parsers.rst.states.RSTState.__init__	(		self,
			state_machine,
			debug = False
	)

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

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

Reimplemented from docutils.statemachine.StateWS.

Reimplemented in docutils.parsers.rst.states.QuotedLiteralBlock.

Member Function Documentation

bof()

docutils.parsers.rst.states.RSTState.bof	(		self,
			context
	)

Called at beginning of file.

Reimplemented from docutils.statemachine.State.

check_subsection()

docutils.parsers.rst.states.RSTState.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?

:Exception: `EOFError` when a sibling or supersection encountered.

goto_line()

docutils.parsers.rst.states.RSTState.goto_line	(		self,
			abs_line_offset
	)

Jump to input line `abs_line_offset`, ignoring jumps past the end.

inline_text()

docutils.parsers.rst.states.RSTState.inline_text	(		self,
			text,
			lineno
	)

Return 2 lists: nodes (text and inline elements), and system_messages.

nested_list_parse()

docutils.parsers.rst.states.RSTState.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.

nested_parse()

docutils.parsers.rst.states.RSTState.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`.

new_subsection()

docutils.parsers.rst.states.RSTState.new_subsection	(		self,
			title,
			lineno,
			messages
	)

Append new subsection to document tree. On return, check level.

no_match()

docutils.parsers.rst.states.RSTState.no_match	(		self,
			context,
			transitions
	)

Override `StateWS.no_match` to generate a system message.

This code should never be run.

Reimplemented from docutils.statemachine.State.

paragraph()

docutils.parsers.rst.states.RSTState.paragraph	(		self,
			lines,
			lineno
	)

Return a list (paragraph & messages) & a boolean: literal_block next?

runtime_init()

docutils.parsers.rst.states.RSTState.runtime_init

(

self

)

Initialize this `State` before running the state machine; called from
`self.state_machine.run()`.

Reimplemented from docutils.statemachine.State.

section()

docutils.parsers.rst.states.RSTState.section	(		self,
			title,
			source,
			style,
			lineno,
			messages
	)

Check for a valid subsection and create one if it checks out.

---

The documentation for this class was generated from the following file:

• docs/help/help-venv/lib/python3.12/site-packages/docutils/parsers/rst/states.py