markdown.inlinepatterns §

In version 3.0, a new, more flexible inline processor was added, markdown.inlinepatterns.InlineProcessor. The original inline patterns, which inherit from markdown.inlinepatterns.Pattern or one of its children are still supported, though users are encouraged to migrate.

The new InlineProcessor provides two major enhancements to Patterns:

1. Inline Processors no longer need to match the entire block, so regular expressions no longer need to start with r'^(.*?)' and end with r'(.*?)%'. This runs faster. The returned Match object will only contain what is explicitly matched in the pattern, and extension pattern groups now start with m.group(1).

2. The handleMatch method now takes an additional input called data, which is the entire block under analysis, not just what is matched with the specified pattern. The method now returns the element and the indexes relative to data that the return element is replacing (usually m.start(0) and m.end(0)). If the boundaries are returned as None, it is assumed that the match did not take place, and nothing will be altered in data.

   This allows handling of more complex constructs than regular expressions can handle, e.g., matching nested brackets, and explicit control of the span “consumed” by the processor.

Classes:

• EmStrongItem –

  Emphasis/strong pattern item.

• Pattern –

  Base class that inline patterns subclass.

• InlineProcessor –

  Base class that inline processors subclass.

• SimpleTextPattern –

  Return a simple text of group(2) of a Pattern.

• SimpleTextInlineProcessor –

  Return a simple text of group(1) of a Pattern.

• EscapeInlineProcessor –

  Return an escaped character.

• SimpleTagPattern –

  Return element of type tag with a text attribute of group(3)

• SimpleTagInlineProcessor –

  Return element of type tag with a text attribute of group(2)

• SubstituteTagPattern –

  Return an element of type tag with no children.

• SubstituteTagInlineProcessor –

  Return an element of type tag with no children.

• BacktickInlineProcessor –

  Return a <code> element containing the escaped matching text.

• DoubleTagPattern –

  Return a ElementTree element nested in tag2 nested in tag1.

• DoubleTagInlineProcessor –

  Return a ElementTree element nested in tag2 nested in tag1.

• HtmlInlineProcessor –

  Store raw inline html and return a placeholder.

• Delimiter –

  Delimiter.

• DelimiterProcessor –

  Processor for handling complex nested patterns such as strong and em matches.

• LinkInlineProcessor –

  Return a link element from the given match.

• ImageInlineProcessor –

  Return a img element from the given match.

• ReferenceInlineProcessor –

  Match to a stored reference and return link element.

• ShortReferenceInlineProcessor –

  Short form of reference: [google].

• ImageReferenceInlineProcessor –

  Match to a stored reference and return img element.

• ShortImageReferenceInlineProcessor –

  Short form of image reference: ![ref].

• AutolinkInlineProcessor –

  Return a link Element given an auto-link (<http://example/com>).

• AutomailInlineProcessor –

  Return a mailto link Element given an auto-mail link (<foo@example.com>).

Functions:

• build_inlinepatterns –

  Build the default set of inline patterns for Markdown.

• dequote –

  Remove quotes from around a string.

Attributes:

• NOIMG –

  Match not an image. Partial regular expression which matches if not preceded by !.

• BACKTICK_RE –

  Match backtick quoted string (`e=f()` or ``e=f("`")``).

• ESCAPE_RE –

  Match a backslash escaped character (\< or \*).

• LINK_RE –

  Match start of in-line link ([text](url) or [text](<url>) or [text](url "title")).

• IMAGE_LINK_RE –

  Match start of in-line image link (![alttxt](url) or ![alttxt](<url>)).

• REFERENCE_RE –

  Match start of reference link ([Label][3]).

• IMAGE_REFERENCE_RE –

  Match start of image reference (![alt text][2]).

• AUTOLINK_RE –

  Match an automatic link (<http://www.example.com>).

• AUTOMAIL_RE –

  Match an automatic email link (<me@example.com>).

• HTML_RE –

  Match an HTML tag (<...>).

• ENTITY_RE –

  Match an HTML entity (& (decimal) or & (hex) or & (named)).

• LINE_BREAK_RE –

  Match two spaces at end of line.

NOIMG = r'(?<!\!)'

BACKTICK_RE = r'(?:(?<!\\)((?:\\{2})+)(?=`+)|(?<!\\)`)'

ESCAPE_RE = r'\\(.)'

LINK_RE = NOIMG + r'\['

IMAGE_LINK_RE = r'\!\['

REFERENCE_RE = LINK_RE

IMAGE_REFERENCE_RE = IMAGE_LINK_RE

AUTOLINK_RE = r'<([A-Za-z][A-Za-z0-9+.-]*://[^<>]*)>'

AUTOMAIL_RE = r'<([^<> !]+@[^@<> ]+)>'

HTML_RE = (
    # Tag
    r'''(<(\/?+[a-zA-Z][^\s"'<>@]*+(?:\s+[^\s"'=<>]++(?:\s*+=\s*+(?:"[^"]*+"|'[^']*+'|[^\s"'=<>]++))?+)*+\s*+/?|'''
    # Comment
    r'!--(?:(?!<!--|-->).)*--|'
    # Processing instruction
    r'[?](?:(?!<[?]|[?]>).)*[?]|'
    # `CDATA`
    r'!\[CDATA\[(?:(?!<!\[CDATA\[|\]\]>).)*\]\]'
    ')>)'
)

ENTITY_RE = r'(&(?:\#[0-9]+|\#x[0-9a-fA-F]+|[a-zA-Z0-9]+);)'

LINE_BREAK_RE = r'  \n'

ANCESTOR_EXCLUDES: Collection[str] = tuple()

ANCESTOR_EXCLUDES: Collection[str] = tuple()

ANCESTOR_EXCLUDES: Collection[str] = tuple()