import re from html import _replace_charref # type: ignore[attr-defined] from typing import Match from urllib.parse import quote _expand_tab_re = re.compile(r"^( {0,3})\t", flags=re.M) def expand_leading_tab(text: str, width: int = 4) -> str: def repl(m: Match[str]) -> str: s = m.group(1) return s + " " * (width - len(s)) return _expand_tab_re.sub(repl, text) def expand_tab(text: str, space: str = " ") -> str: repl = r"\1" + space return _expand_tab_re.sub(repl, text) def escape(s: str, quote: bool = True) -> str: """Escape characters of ``&<>``. If quote=True, ``"`` will be converted to ``"e;``.""" s = s.replace("&", "&") s = s.replace("<", "<") s = s.replace(">", ">") if quote: s = s.replace('"', """) return s def escape_url(link: str) -> str: """Escape URL for safety.""" safe = ( ":/?#@" # gen-delims - '[]' (rfc3986) "!$&()*+,;=" # sub-delims - "'" (rfc3986) "%" # leave already-encoded octets alone ) return quote(unescape(link), safe=safe) def safe_entity(s: str) -> str: """Escape characters for safety.""" return escape(unescape(s)) def unikey(s: str) -> str: """Generate a unique key for links and footnotes.""" key = " ".join(s.split()).strip() return key.lower().upper() _charref_re = re.compile( r"&(#[0-9]{1,7};" r"|#[xX][0-9a-fA-F]+;" r"|[^\t\n\f <&#;]{1,32};)" ) def unescape(s: str) -> str: """ Copy from `html.unescape`, but `_charref` is different. CommonMark does not accept entity references without a trailing semicolon """ if "&" not in s: return s return _charref_re.sub(_replace_charref, s) _striptags_re = re.compile(r"(|<[^>]*>)") def striptags(s: str) -> str: return _striptags_re.sub("", s) _strip_end_re = re.compile(r"\n\s+$") def strip_end(src: str) -> str: return _strip_end_re.sub("\n", src)