markdown.util

module documentation
(source)

Python Markdown A Python implementation of John Gruber's Markdown. Documentation: https://python-markdown.github.io/ GitHub: https://github.com/Python-Markdown/markdown/ PyPI: https://pypi.org/project/Markdown/ Started by Manfred Stienstra (http://www.dwerg.net/). Maintained for a few years by Yuri Takhteyev (http://www.freewisdom.org). Currently maintained by Waylan Limberg (https://github.com/waylan), Dmitry Shachnev (https://github.com/mitya57) and Isaac Muse (https://github.com/facelessuser). Copyright 2007-2018 The Python Markdown Project (v. 1.7 and later) Copyright 2004, 2005, 2006 Yuri Takhteyev (v. 0.2-1.6b) Copyright 2004 Manfred Stienstra (the original version) License: BSD (see LICENSE.md for details).

Class AtomicString A string which should not be further processed.
Class HtmlStash This class is used for stashing HTML objects that we extract in the beginning and replace with place-holders.
Class Processor Undocumented
Class Registry A priority sorted registry.
Function code_escape Escape code.
Function deprecated Raise a DeprecationWarning when wrapped function/method is called.
Function get_installed_extensions Undocumented
Function nearing_recursion_limit Return true if current stack depth is within 100 of maximum limit.
Function parseBoolValue Parses a string representing bool value. If parsing was successful, returns True or False. If preserve_none=True, returns True, False, or None. If parsing was not successful, raises ValueError, or, if fail_on_errors=False, returns None.
Constant AMP_SUBSTITUTE Undocumented
Constant BLOCK_LEVEL_ELEMENTS Undocumented
Constant ETX Undocumented
Constant HTML_PLACEHOLDER Undocumented
Constant HTML_PLACEHOLDER_RE Undocumented
Constant INLINE_PLACEHOLDER Undocumented
Constant INLINE_PLACEHOLDER_PREFIX Undocumented
Constant INLINE_PLACEHOLDER_RE Undocumented
Constant RTL_BIDI_RANGES AUXILIARY GLOBAL FUNCTIONS =============================================================================
Constant STX Undocumented
Constant TAG_PLACEHOLDER Constants you probably do not need to change -----------------------------------------------------------------------------
Function _get_stack_depth Get current stack depth, performantly.
Variable _PriorityItem Undocumented
def code_escape(text): (source)

Escape code.

def deprecated(message, stacklevel=2): (source)

Raise a DeprecationWarning when wrapped function/method is called. Usage: @deprecated("This method will be removed in version X; use Y instead.") def some_method()" pass

@lru_cache(maxsize=None)
def get_installed_extensions(): (source)

Undocumented

def nearing_recursion_limit(): (source)

Return true if current stack depth is within 100 of maximum limit.

def parseBoolValue(value, fail_on_errors=True, preserve_none=False): (source)

Parses a string representing bool value. If parsing was successful, returns True or False. If preserve_none=True, returns True, False, or None. If parsing was not successful, raises ValueError, or, if fail_on_errors=False, returns None.

AMP_SUBSTITUTE = (source)

Undocumented

Value
(STX+'amp')+ETX
BLOCK_LEVEL_ELEMENTS: list[str] = (source)

Undocumented

Value
['address',
 'article',
 'aside',
 'blockquote',
 'details',
 'div',
 'dl',
...
ETX: str = (source)

Undocumented

Value
'\x03'
HTML_PLACEHOLDER = (source)

Undocumented

Value
(STX+'wzxhzdk:%s')+ETX
HTML_PLACEHOLDER_RE = (source)

Undocumented

Value
re.compile(HTML_PLACEHOLDER%'([0-9]+)')
INLINE_PLACEHOLDER = (source)

Undocumented

Value
(INLINE_PLACEHOLDER_PREFIX+'%s')+ETX
INLINE_PLACEHOLDER_PREFIX = (source)

Undocumented

Value
STX+'klzzwxh:'
INLINE_PLACEHOLDER_RE = (source)

Undocumented

Value
re.compile(INLINE_PLACEHOLDER%'([0-9]+)')
RTL_BIDI_RANGES: tuple = (source)

AUXILIARY GLOBAL FUNCTIONS =============================================================================

Value
(('֐', '߿'), ('ⴰ', '⵿'))
STX: str = (source)

Undocumented

Value
'\x02'
TAG_PLACEHOLDER = (source)

Constants you probably do not need to change -----------------------------------------------------------------------------

Value
(STX+'hzzhzkh:%s')+ETX
def _get_stack_depth(size=2): (source)

Get current stack depth, performantly.

_PriorityItem = (source)

Undocumented