docutils.statemachine._SearchOverride Class Reference

Inheritance diagram for docutils.statemachine._SearchOverride:

Public Member Functions
	match (self, pattern)

Public Attributes
	line

Detailed Description

Mix-in class to override `StateMachine` regular expression behavior.

Changes regular expression matching, from the default `re.match()`
(succeeds only if the pattern matches at the start of `self.line`) to
`re.search()` (succeeds if the pattern matches anywhere in `self.line`).
When subclassing a `StateMachine`, list this class **first** in the
inheritance list of the class definition.

Member Function Documentation

match()

docutils.statemachine._SearchOverride.match	(		self,
			pattern
	)

Return the result of a regular expression search.

Overrides `StateMachine.match()`.

Parameter `pattern`: `re` compiled regular expression.

---

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

• docs/help/help-venv/lib/python3.12/site-packages/docutils/statemachine.py