docutils.parsers.rst.states.Inliner Class Reference

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

Public Member Functions
	__init__ (self)
	init_customizations (self, settings)
	parse (self, text, lineno, memo, parent)
	quoted_start (self, match)
	inline_obj (self, match, lineno, end_pattern, nodeclass, restore_backslashes=False)
	problematic (self, text, rawsource, message)
	emphasis (self, match, lineno)
	strong (self, match, lineno)
	interpreted_or_phrase_ref (self, match, lineno)
	phrase_ref (self, before, after, rawsource, escaped, text=None)
	adjust_uri (self, uri)
	interpreted (self, rawsource, text, role, lineno)
	literal (self, match, lineno)
	inline_internal_target (self, match, lineno)
	substitution_reference (self, match, lineno)
	footnote_reference (self, match, lineno)
	reference (self, match, lineno, anonymous=False)
	anonymous_reference (self, match, lineno)
	standalone_uri (self, match, lineno)
	pep_reference (self, match, lineno)
	rfc_reference (self, match, lineno)
	implicit_inline (self, text, lineno)

Public Attributes
	implicit_dispatch
	non_whitespace_after
	simplename
	start_string_prefix
	end_string_suffix
	parts
	patterns
	standalone_uri
	pep_reference
	rfc_reference
	reporter
	document
	language
	parent

Static Public Attributes
str	non_whitespace_before = r'(?<!\s)'
str	non_whitespace_escape_before = r'(?<![\s\x00])'
str	non_unescaped_whitespace_escape_before = r'(?<!(?<!\x00)[\s\x00])'
str	non_whitespace_after = r'(?!\s)'
str	simplename = r'(?:(?!_)\w)+(?:[-._+:](?:(?!_)\w)+)*'
str	uric = r"""[-_.!~*'()[\];/:@&=+$,%a-zA-Z0-9\x00]"""
str	uri_end_delim = r"""[>]"""
str	urilast = r"""[_~*/=+a-zA-Z0-9]"""
str	uri_end = r"""(?:%(urilast)s|%(uric)s(?=%(uri_end_delim)s))""" % locals()
str	emailc = r"""[-_!~*'{|}/#?^`&=+$%a-zA-Z0-9\x00]"""
str	email_pattern
str	rfc_url = 'rfc%d.html'
dict	dispatch

Detailed Description

Parse inline markup; call the `parse()` method.

Member Function Documentation

footnote_reference()

docutils.parsers.rst.states.Inliner.footnote_reference	(		self,
			match,
			lineno
	)

Handles `nodes.footnote_reference` and `nodes.citation_reference`
elements.

implicit_inline()

docutils.parsers.rst.states.Inliner.implicit_inline	(		self,
			text,
			lineno
	)

Check each of the patterns in `self.implicit_dispatch` for a match,
and dispatch to the stored method for the pattern.  Recursively check
the text before and after the match.  Return a list of `nodes.Text`
and inline element nodes.

parse()

docutils.parsers.rst.states.Inliner.parse	(		self,
			text,
			lineno,
			memo,
			parent
	)

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

Using `self.patterns.initial`, a pattern which matches start-strings
(emphasis, strong, interpreted, phrase reference, literal,
substitution reference, and inline target) and complete constructs
(simple reference, footnote reference), search for a candidate.  When
one is found, check for validity (e.g., not a quoted '*' character).
If valid, search for the corresponding end string if applicable, and
check it for validity.  If not found or invalid, generate a warning
and ignore the start-string.  Implicit inline markup (e.g. standalone
URIs) is found last.

:text: source string
:lineno: absolute line number (cf. statemachine.get_source_and_line())

quoted_start()

docutils.parsers.rst.states.Inliner.quoted_start	(		self,
			match
	)

Test if inline markup start-string is 'quoted'.

'Quoted' in this context means the start-string is enclosed in a pair
of matching opening/closing delimiters (not necessarily quotes)
or at the end of the match.

Member Data Documentation

dispatch

dict docutils.parsers.rst.states.Inliner.dispatch

static

Initial value:

=  {'*': emphasis,
                '**': strong,
                '`': interpreted_or_phrase_ref,
                '``': literal,
                '_`': inline_internal_target,
                ']_': footnote_reference,
                '|': substitution_reference,
                '_': reference,
                '__': anonymous_reference}

email_pattern

str docutils.parsers.rst.states.Inliner.email_pattern

static

Initial value:

=  r"""
          %(emailc)s+(?:\.%(emailc)s+)*   # name
          (?<!\x00)@                      # at
          %(emailc)s+(?:\.%(emailc)s*)*   # host
          %(uri_end)s                     # final URI char
          """

---

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