docutils.parsers.rst.states.Inliner

class documentation

class Inliner: (source)

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 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.
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): (source)

Undocumented

def adjust_uri(self, uri): (source)

Undocumented

def anonymous_reference(self, match, lineno): (source)

Undocumented

def emphasis(self, match, lineno): (source)

Undocumented

def footnote_reference(self, match, lineno): (source)

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

def implicit_inline(self, text, lineno): (source)

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): (source)

Undocumented

def inline_internal_target(self, match, lineno): (source)

Undocumented

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

Undocumented

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

Undocumented

def interpreted_or_phrase_ref(self, match, lineno): (source)

Undocumented

def literal(self, match, lineno): (source)

Undocumented

def parse(self, text, lineno, memo, parent): (source)

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())

def pep_reference(self, match, lineno): (source)

Undocumented

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

Undocumented

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

Undocumented

def quoted_start(self, match): (source)

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): (source)

Undocumented

def rfc_reference(self, match, lineno): (source)

Undocumented

def standalone_uri(self, match, lineno): (source)

Undocumented

def strong(self, match, lineno): (source)

Undocumented

def substitution_reference(self, match, lineno): (source)

Undocumented

dispatch = (source)

Undocumented

email_pattern: str = (source)

Undocumented

emailc: str = (source)

Undocumented

non_unescaped_whitespace_escape_before: str = (source)

Undocumented

non_whitespace_after: str = (source)

Undocumented

non_whitespace_before: str = (source)

Undocumented

non_whitespace_escape_before: str = (source)

Undocumented

rfc_url: str = (source)

Undocumented

simplename: str = (source)

Undocumented

uri_end = (source)

Undocumented

uri_end_delim: str = (source)

Undocumented

uric: str = (source)

Undocumented

urilast: str = (source)

Undocumented

document = (source)

Undocumented

end_string_suffix = (source)

Undocumented

implicit_dispatch: list = (source)

List of (pattern, bound method) tuples, used by `self.implicit_inline`.

language = (source)

Undocumented

parent = (source)

Undocumented

parts = (source)

Undocumented

patterns = (source)

Undocumented

reporter = (source)

Undocumented

start_string_prefix = (source)

Undocumented