myst_parser.mocking.MockState Class Reference

Public Member Functions
	__init__ (self, DocutilsRenderer renderer, MockStateMachine state_machine, int lineno)
tuple[list[str], dict[str, Any], StringList, int]	parse_directive_block (self, StringList content, int line_offset, type[Directive] directive, dict[str, Any] option_presets)
None	nested_parse (self, StringList block, int input_offset, nodes.Element node, bool match_titles=False, state_machine_class=None, state_machine_kwargs=None)
	parse_target (self, block, block_text, int lineno)
tuple[list[nodes.Element], list[nodes.Element]]	inline_text (self, str text, int lineno)
list[nodes.Element]	block_quote (self, list[str] lines, int line_offset)
	build_table (self, tabledata, tableline, int stub_columns=0, widths=None)
	build_table_row (self, rowdata, tableline)
	nest_line_block_lines (self, nodes.line_block block)
	__getattr__ (self, str name)

Public Attributes
	document
	reporter
	state_machine
	inliner
	memo

Static Public Attributes
	attribution_pattern = re.compile("^((?:---?(?!-)|\u2014) *)(.+)")

Protected Member Functions
	_nest_line_block_segment (self, nodes.line_block block)

Protected Attributes
	_renderer
	_lineno

Detailed Description

A mock version of `docutils.parsers.rst.states.RSTState`.

This is parsed to the `Directives.run()` method,
so that they may run nested parses on their content that will be parsed as markdown,
rather than RST.

Member Function Documentation

__getattr__()

myst_parser.mocking.MockState.__getattr__	(		self,
		str	name
	)

This method is only be called if the attribute requested has not
been defined. Defined attributes will not be overridden.

block_quote()

list[nodes.Element] myst_parser.mocking.MockState.block_quote	(		self,
		list[str]	lines,
		int	line_offset
	)

Parse a block quote, which is a block of text,
followed by an (optional) attribution.

::

   No matter where you go, there you are.

   -- Buckaroo Banzai

inline_text()

tuple[list[nodes.Element], list[nodes.Element]] myst_parser.mocking.MockState.inline_text	(		self,
		str	text,
		int	lineno
	)

Parse text with only inline rules.

:returns: (list of nodes, list of messages)

nest_line_block_lines()

myst_parser.mocking.MockState.nest_line_block_lines	(		self,
		nodes.line_block	block
	)

Modify the line block element in-place, to nest line block segments.

Line nodes are placed into child line block containers, based on their indentation.

nested_parse()

None myst_parser.mocking.MockState.nested_parse	(		self,
		StringList	block,
		int	input_offset,
		nodes.Element	node,
		bool	match_titles = False,
			state_machine_class = None,
			state_machine_kwargs = None
	)

Perform a nested parse of the input block, with ``node`` as the parent.

:param block: The block of lines to parse.
:param input_offset: The offset of the first line of block,
    to the starting line of the state (i.e. directive).
:param node: The parent node to attach the parsed content to.
:param match_titles: Whether to to allow the parsing of headings
    (normally this is false,
    since nested heading would break the document structure)

parse_directive_block()

tuple[list[str], dict[str, Any], StringList, int] myst_parser.mocking.MockState.parse_directive_block	(		self,
		StringList	content,
		int	line_offset,
		type[Directive]	directive,
		dict[str, Any]	option_presets
	)

Parse the full directive text

:raises MarkupError: for errors in parsing the directive
:returns: (arguments, options, content, content_offset)

parse_target()

myst_parser.mocking.MockState.parse_target	(		self,
			block,
			block_text,
		int	lineno
	)

Taken from https://github.com/docutils-mirror/docutils/blob/e88c5fb08d5cdfa8b4ac1020dd6f7177778d5990/docutils/parsers/rst/states.py#L1927

---

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

• docs/help/help-venv/lib/python3.12/site-packages/myst_parser/mocking.py