diff options
author | Arturs Artamonovs <dos21h@gmail.com> | 2023-01-29 10:30:54 +0000 |
---|---|---|
committer | Arturs Artamonovs <dos21h@gmail.com> | 2023-01-29 10:30:54 +0000 |
commit | 66fa71a8f11b6ce5e8471b533f67cc3a1fdb85a8 (patch) | |
tree | 7aed7f385826a3bd88c76a373e28c6cfae4f396e /src/mistune/__init__.py | |
parent | 129c1201ea5c4418f0f89ad932633c7cea2439b7 (diff) | |
download | md-site-66fa71a8f11b6ce5e8471b533f67cc3a1fdb85a8.tar.gz md-site-66fa71a8f11b6ce5e8471b533f67cc3a1fdb85a8.zip |
Update to new mistune, removed old mistune, rewrite to python3
Diffstat (limited to 'src/mistune/__init__.py')
-rw-r--r-- | src/mistune/__init__.py | 75 |
1 files changed, 75 insertions, 0 deletions
diff --git a/src/mistune/__init__.py b/src/mistune/__init__.py new file mode 100644 index 0000000..4de95c5 --- /dev/null +++ b/src/mistune/__init__.py @@ -0,0 +1,75 @@ +""" + mistune + ~~~~~~~ + + A fast yet powerful Python Markdown parser with renderers and + plugins, compatible with sane CommonMark rules. + + Documentation: https://mistune.lepture.com/ +""" + +from .markdown import Markdown +from .core import BlockState, InlineState, BaseRenderer +from .block_parser import BlockParser +from .inline_parser import InlineParser +from .renderers.html import HTMLRenderer +from .util import escape, escape_url, safe_entity, unikey +from .plugins import import_plugin + + +def create_markdown(escape=True, hard_wrap=False, renderer='html', plugins=None): + """Create a Markdown instance based on the given condition. + + :param escape: Boolean. If using html renderer, escape html. + :param hard_wrap: Boolean. Break every new line into ``<br>``. + :param renderer: renderer instance, default is HTMLRenderer. + :param plugins: List of plugins. + + This method is used when you want to re-use a Markdown instance:: + + markdown = create_markdown( + escape=False, + hard_wrap=True, + ) + # re-use markdown function + markdown('.... your text ...') + """ + if renderer == 'html': + renderer = HTMLRenderer(escape=escape) + + inline = InlineParser(hard_wrap=hard_wrap) + if plugins is not None: + plugins = [import_plugin(n) for n in plugins] + return Markdown(renderer=renderer, inline=inline, plugins=plugins) + + +html = create_markdown( + escape=False, + plugins=['strikethrough', 'footnotes', 'table', 'speedup'] +) + + +__cached_parsers = {} + + +def markdown(text, escape=True, renderer='html', plugins=None): + key = (escape, renderer, plugins) + if key in __cached_parsers: + return __cached_parsers[key](text) + + md = create_markdown(escape=escape, renderer=renderer, plugins=plugins) + # improve the speed for markdown parser creation + __cached_parsers[key] = md + return md(text) + + +__all__ = [ + 'Markdown', 'HTMLRenderer', + 'BlockParser', 'BlockState', 'BaseRenderer', + 'InlineParser', 'InlineState', + 'escape', 'escape_url', 'safe_entity', 'unikey', + 'html', 'create_markdown', 'markdown', +] + +__version__ = '3.0.0rc4' +__homepage__ = 'https://mistune.lepture.com/' |