pytilpack.markdown

必要なextra

pip install pytilpack[markdown]

pytilpack.markdown

markdown関連。

ALLOWED_TAGS = {'a', 'abbr', 'acronym', 'address', 'area', 'article', 'aside', 'b', 'base', 'basefont', 'bdi', 'bdo', 'big', 'blink', 'blockquote', 'br', 'button', 'caption', 'center', 'cite', 'code', 'col', 'colgroup', 'command', 'content', 'data', 'datalist', 'dd', 'del', 'details', 'dfn', 'dialog', 'dir', 'div', 'dl', 'dt', 'element', 'em', 'fieldset', 'figcaption', 'figure', 'font', 'footer', 'form', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'header', 'hgroup', 'hr', 'i', 'image', 'img', 'input', 'ins', 'isindex', 'kbd', 'keygen', 'label', 'legend', 'li', 'listing', 'main', 'map', 'mark', 'marquee', 'menu', 'menuitem', 'meter', 'multicol', 'nav', 'nobr', 'noembed', 'noframes', 'noscript', 'ol', 'optgroup', 'option', 'output', 'p', 'picture', 'plaintext', 'pre', 'progress', 'q', 'rp', 's', 'samp', 'section', 'select', 'shadow', 'small', 'spacer', 'span', 'strike', 'strong', 'style', 'sub', 'summary', 'sup', 'table', 'tbody', 'td', 'template', 'textarea', 'tfoot', 'th', 'thead', 'time', 'tr', 'tt', 'u', 'ul', 'var', 'wbr'} module-attribute

許可するタグ。

ALLOWED_ATTRIBUTES = {'*': ['id', 'title', 'class', 'style'], 'a': ['href', 'alt', 'title', 'target', 'rel'], 'details': ['open'], 'img': ['src', 'alt', 'title', 'width', 'height'], 'td': ['colspan', 'rowspan'], 'th': ['colspan', 'rowspan'], 'tr': ['rowspan']} module-attribute

許可する属性。

ALLOWED_PROTOCOLS = {'http', 'https', 'mailto'} module-attribute

許可するプロトコル。

escape(text)

Markdown文字列をエスケープ。

ソースコード位置： pytilpack/markdown.py

def escape(text: str) -> str:
    """Markdown文字列をエスケープ。"""
    text = text.replace("\\", "\\\\")
    return _MARKDOWN_ESCAPE_PATTERN.sub(r"\\\1", text)

inline_code(text)

テキストをMarkdownのインラインコードブロックに変換。

ソースコード位置： pytilpack/markdown.py

def inline_code(text: str) -> str:
    """テキストをMarkdownのインラインコードブロックに変換。"""
    # 最大連続バッククォート数 + 1 個のバッククォートをデリミタとして使用
    max_backticks = max((len(m.group()) for m in re.finditer(r"`+", text)), default=0)
    delimiter = "`" * (max_backticks + 1)
    # テキストがバッククォートで始まる・終わる場合はスペースを追加
    if text.startswith("`") or text.endswith("`"):
        return f"{delimiter} {text} {delimiter}"
    return f"{delimiter}{text}{delimiter}"

markdownfy(text, extensions=None, extension_configs=None, tab_length=2, sanitize=True, allow_tags=None, allow_attributes=None, allow_protocols=None, strip=False, strip_comments=True, css_sanitizer=None, **kwargs)

Markdown変換。

ソースコード位置： pytilpack/markdown.py

def markdownfy(
    text: str,
    extensions: typing.Sequence[str | markdown.Extension] | None = None,
    extension_configs: (typing.Mapping[str, typing.Mapping[str, typing.Any]] | None) = None,
    tab_length: int | None = 2,
    sanitize: bool = True,
    allow_tags: typing.Iterable[str] | None = None,
    allow_attributes: typing.Mapping[str, typing.Iterable[str]] | None = None,
    allow_protocols: typing.Iterable[str] | None = None,
    strip: bool = False,
    strip_comments: bool = True,
    css_sanitizer: bleach.css_sanitizer.CSSSanitizer | None = None,
    **kwargs,
) -> str:
    """Markdown変換。"""
    if extensions is None:
        extensions = ["markdown.extensions.extra", "markdown.extensions.toc"]
    if extension_configs is None:
        extension_configs = {"toc": {"title": "目次", "permalink": True}}
    html = markdown.markdown(
        text,
        extensions=extensions,
        extension_configs=extension_configs,
        tab_length=tab_length,
        **kwargs,
    )

    if sanitize:
        if allow_tags is None:
            allow_tags = ALLOWED_TAGS
        if allow_attributes is None:
            allow_attributes = ALLOWED_ATTRIBUTES
        if allow_protocols is None:
            allow_protocols = ALLOWED_PROTOCOLS
        if css_sanitizer is None:
            css_sanitizer = bleach.css_sanitizer.CSSSanitizer()
        html = bleach.clean(
            html,
            tags=allow_tags,
            attributes={k: list(v) for k, v in allow_attributes.items()},
            protocols=allow_protocols,
            strip=strip,
            strip_comments=strip_comments,
            css_sanitizer=css_sanitizer,
        )

    return html