From aec9fd58d4de930e396f832f77b9ece3b4c7638c Mon Sep 17 00:00:00 2001 From: "martin f. krafft" Date: Wed, 23 Aug 2023 23:53:24 +1200 Subject: [PATCH] buildmimetree.py: handle stylesheets/styling --- .config/neomutt/buildmimetree.py | 88 +++++++++++++++++++++++++++++--- 1 file changed, 81 insertions(+), 7 deletions(-) diff --git a/.config/neomutt/buildmimetree.py b/.config/neomutt/buildmimetree.py index c277e63..0dd1882 100755 --- a/.config/neomutt/buildmimetree.py +++ b/.config/neomutt/buildmimetree.py @@ -23,8 +23,8 @@ # - python3-markdown # Optional: # - pytest -# - Pynliner -# - Pygments, if installed, then syntax highlighting is enabled +# - Pynliner, provides --css-file and thus inline styling of HTML output +# - Pygments, then syntax highlighting for fenced code is enabled # # Latest version: # https://git.madduck.net/etc/neomutt.git/blob_plain/HEAD:/.config/neomutt/buildmimetree.py @@ -66,6 +66,16 @@ def parse_cli_args(*args, **kwargs): help="Markdown extension to use (comma-separated list)", ) + if _PYNLINER: + parser.add_argument( + "--css-file", + type=str, + default="", + help="CSS file to merge with the final HTML", + ) + else: + parser.set_defaults(css_file=None) + parser.add_argument( "--only-build", action="store_true", @@ -160,11 +170,15 @@ class InlineImageExtension(Extension): return self._images -def markdown_with_inline_image_support(text, *, extensions=None): +def markdown_with_inline_image_support( + text, *, extensions=None, extension_configs=None +): inline_image_handler = InlineImageExtension() extensions = extensions or [] extensions.append(inline_image_handler) - mdwn = markdown.Markdown(extensions=extensions) + mdwn = markdown.Markdown( + extensions=extensions, extension_configs=extension_configs + ) htmltext = mdwn.convert(text) images = inline_image_handler.get_images() @@ -179,6 +193,38 @@ def markdown_with_inline_image_support(text, *, extensions=None): return text, htmltext, images +# [ CSS STYLING ] ############################################################# + +try: + import pynliner + + _PYNLINER = True + +except ImportError: + _PYNLINER = False + +try: + from pygments.formatters import get_formatter_by_name + + _CODEHILITE_CLASS = "codehilite" + + _PYGMENTS_CSS = get_formatter_by_name( + "html", style="default" + ).get_style_defs(f".{_CODEHILITE_CLASS}") + +except ImportError: + _PYGMENTS_CSS = None + + +def apply_styling(html, css): + return ( + pynliner.Pynliner() + .from_string(html) + .with_cssString("\n".join(s for s in [_PYGMENTS_CSS, css] if s)) + .run() + ) + + # [ PARTS GENERATION ] ######################################################## @@ -240,12 +286,19 @@ def convert_markdown_to_html( origtext, draftpath, *, + cssfile=None, filewriter_fn=filewriter_fn, tempdir=None, extensions=None, + extension_configs=None, ): + # TODO extension_configs need to be handled differently + extension_configs = extension_configs or {} + extension_configs.setdefault("pymdownx.highlight", {}) + extension_configs["pymdownx.highlight"]["css_class"] = _CODEHILITE_CLASS + origtext, htmltext, images = markdown_with_inline_image_support( - origtext, extensions=extensions + origtext, extensions=extensions, extension_configs=extension_configs ) filewriter_fn(draftpath, origtext, encoding="utf-8") @@ -253,6 +306,8 @@ def convert_markdown_to_html( "text", "plain", draftpath, "Plain-text version", orig=True ) + htmltext = apply_styling(htmltext, cssfile) + htmlpath = draftpath.with_suffix(".html") filewriter_fn( htmlpath, htmltext, encoding="utf-8", errors="xmlcharrefreplace" @@ -408,6 +463,7 @@ def do_massage( cmd_f, *, extensions=None, + cssfile=None, converter=convert_markdown_to_html, only_build=False, tempdir=None, @@ -540,6 +596,7 @@ if __name__ == "__main__": pathlib.Path(args.MAILDRAFT), cmd_f, extensions=args.extensions, + cssfile=args.css_file, only_build=args.only_build, tempdir=args.tempdir, debug_commands=args.debug_commands, @@ -682,7 +739,7 @@ try: return StringIO(text or const1) def test_do_massage_basic(self, const1, string_io, capsys): - def converter(drafttext, draftpath, extensions, tempdir): + def converter(drafttext, draftpath, cssfile, extensions, tempdir): return Part("text", "plain", draftpath, orig=True) do_massage( @@ -706,7 +763,7 @@ try: def test_do_massage_fulltree( self, string_io, const1, basic_mime_tree, capsys ): - def converter(drafttext, draftpath, extensions, tempdir): + def converter(drafttext, draftpath, cssfile, extensions, tempdir): return basic_mime_tree do_massage( @@ -902,5 +959,22 @@ try: assert relparts[0].cid == const1 assert relparts[0].desc.endswith(const2) + def test_apply_stylesheet(self): + if _PYNLINER: + html = "

Hello, world!

" + css = "p { color:red }" + out = apply_styling(html, css) + assert 'p style="color' in out + + def test_apply_stylesheet_pygments(self): + if _PYGMENTS_CSS: + html = ( + f'
' + "
def foo():\n    return
" + ) + out = apply_styling(html, _PYGMENTS_CSS) + assert f'{_CODEHILITE_CLASS}" style="' in out + + except ImportError: pass -- 2.39.5