docutils.parsers.rst.states.Inliner

class documentation

class Inliner(object):

View In Hierarchy

Parse inline markup; call the parse() method.
Method __init__ Undocumented
Method adjust​_uri Undocumented
Method anonymous​_reference Undocumented
Method emphasis Undocumented
Method footnote​_reference Handles nodes.footnote_reference and nodes.citation_reference elements.
Method implicit​_inline No summary
Method init​_customizations Undocumented
Method inline​_internal​_target Undocumented
Method inline​_obj Undocumented
Method interpreted Undocumented
Method interpreted​_or​_phrase​_ref Undocumented
Method literal Undocumented
Method parse Return 2 lists: nodes (text and inline elements), and system_messages.
Method pep​_reference Undocumented
Method phrase​_ref Undocumented
Method problematic Undocumented
Method quoted​_start Test if inline markup start-string is 'quoted'.
Method reference Undocumented
Method rfc​_reference Undocumented
Method standalone​_uri Undocumented
Method strong Undocumented
Method substitution​_reference Undocumented
Class Variable dispatch Undocumented
Class Variable email​_pattern Undocumented
Class Variable emailc Undocumented
Class Variable non​_unescaped​_whitespace​_escape​_before Undocumented
Class Variable non​_whitespace​_after Undocumented
Class Variable non​_whitespace​_before Undocumented
Class Variable non​_whitespace​_escape​_before Undocumented
Class Variable rfc​_url Undocumented
Class Variable simplename Undocumented
Class Variable uri​_end Undocumented
Class Variable uri​_end​_delim Undocumented
Class Variable uric Undocumented
Class Variable urilast Undocumented
Instance Variable document Undocumented
Instance Variable end​_string​_suffix Undocumented
Instance Variable implicit​_dispatch List of (pattern, bound method) tuples, used by self.implicit_inline.
Instance Variable language Undocumented
Instance Variable parent Undocumented
Instance Variable parts Undocumented
Instance Variable patterns Undocumented
Instance Variable reporter Undocumented
Instance Variable start​_string​_prefix Undocumented
def __init__(self):

Undocumented

def adjust_uri(self, uri):

Undocumented

def anonymous_reference(self, match, lineno):

Undocumented

def emphasis(self, match, lineno):

Undocumented

def footnote_reference(self, match, lineno):
Handles nodes.footnote_reference and nodes.citation_reference elements.
def 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.
def init_customizations(self, settings):

Undocumented

def inline_internal_target(self, match, lineno):

Undocumented

def inline_obj(self, match, lineno, end_pattern, nodeclass, restore_backslashes=False):

Undocumented

def interpreted(self, rawsource, text, role, lineno):

Undocumented

def interpreted_or_phrase_ref(self, match, lineno):

Undocumented

def literal(self, match, lineno):

Undocumented

def 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.

Unknown Field: text
source string
Unknown Field: lineno
absolute line number (cf. statemachine.get_source_and_line())
def pep_reference(self, match, lineno):

Undocumented

def phrase_ref(self, before, after, rawsource, escaped, text=None):

Undocumented

def problematic(self, text, rawsource, message):

Undocumented

def 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.

def reference(self, match, lineno, anonymous=False):

Undocumented

def rfc_reference(self, match, lineno):

Undocumented

def standalone_uri(self, match, lineno):

Undocumented

def strong(self, match, lineno):

Undocumented

def substitution_reference(self, match, lineno):

Undocumented

dispatch =

Undocumented

email_pattern: str =

Undocumented

emailc: str =

Undocumented

non_unescaped_whitespace_escape_before: str =

Undocumented

non_whitespace_after: str =

Undocumented

non_whitespace_before: str =

Undocumented

non_whitespace_escape_before: str =

Undocumented

rfc_url: str =

Undocumented

simplename: str =

Undocumented

uri_end =

Undocumented

uri_end_delim: str =

Undocumented

uric: str =

Undocumented

urilast: str =

Undocumented

document =

Undocumented

end_string_suffix =

Undocumented

implicit_dispatch: list =
List of (pattern, bound method) tuples, used by self.implicit_inline.
language =

Undocumented

parent =

Undocumented

parts =

Undocumented

patterns =

Undocumented

reporter =

Undocumented

start_string_prefix =

Undocumented