X-Git-Url: https://git.madduck.net/etc/neomutt.git/blobdiff_plain/9bb6eec308bbe3c7f0d9348324cb1dade2437946..40b715db3525e0d93303af589502a2d433dddd9a:/.config/neomutt/buildmimetree.py diff --git a/.config/neomutt/buildmimetree.py b/.config/neomutt/buildmimetree.py index 06f62c5..f805884 100755 --- a/.config/neomutt/buildmimetree.py +++ b/.config/neomutt/buildmimetree.py @@ -6,8 +6,10 @@ # # Configuration: # neomuttrc (needs to be a single line): +# set my_mdwn_extensions="extra,admonition,codehilite,sane_lists,smarty" # macro compose B "\ -# source '$my_confdir/buildmimetree.py setup --tempdir $tempdir|'\ +# source '$my_confdir/buildmimetree.py \ +# --tempdir $tempdir --extensions $my_mdwn_extensions|'\ # sourc e \$my_mdwn_postprocess_cmd_file\ # " "Convert message into a modern MIME tree with inline images" # @@ -57,73 +59,48 @@ def parse_cli_args(*args, **kwargs): "Released under the MIT licence" ) - subp = parser.add_subparsers(help="Sub-command parsers", dest="mode") - parser_setup = subp.add_parser("setup", help="Setup phase") - parser_massage = subp.add_parser("massage", help="Massaging phase") + parser.add_argument( + "--extensions", + type=str, + default="", + help="Markdown extension to use (comma-separated list)" + ) - parser_setup.add_argument( - "--debug-commands", + parser.add_argument( + "--only-build", action="store_true", - help="Turn on debug logging of commands generated to stderr", + help="Only build, don't send the message", ) - parser_setup.add_argument( + parser.add_argument( "--tempdir", default=None, help="Specify temporary directory to use for attachments", ) - parser_setup.add_argument( - "--extension", - "-x", - metavar="EXTENSION", - dest="extensions", - nargs="?", - default=[], - action="append", - help="Markdown extension to add to the list of extensions use", - ) - - parser_setup.add_argument( - "--send-message", - action="store_true", - help="Generate command(s) to send the message after processing", - ) - - parser_massage.add_argument( + parser.add_argument( "--debug-commands", action="store_true", help="Turn on debug logging of commands generated to stderr", ) - parser_massage.add_argument( - "--debug-walk", - action="store_true", - help="Turn on debugging to stderr of the MIME tree walk", - ) - - parser_massage.add_argument( - "--tempdir", - default=None, - help="Specify temporary directory to use for attachments", - ) - - parser_massage.add_argument( - "--extensions", - metavar="EXTENSIONS", - type=str, - default="", - help="Markdown extension to use (comma-separated list)", - ) + subp = parser.add_subparsers(help="Sub-command parsers", dest="mode") + massage_p = subp.add_parser("massage", help="Massaging phase (internal use)") - parser_massage.add_argument( + massage_p.add_argument( "--write-commands-to", metavar="PATH", dest="cmdpath", help="Temporary file path to write commands to", ) - parser_massage.add_argument( + massage_p.add_argument( + "--debug-walk", + action="store_true", + help="Turn on debugging to stderr of the MIME tree walk", + ) + + massage_p.add_argument( "MAILDRAFT", nargs="?", help="If provided, the script is invoked as editor on the mail draft", @@ -396,26 +373,18 @@ class MuttCommands: def do_setup( - extensions=None, *, out_f=sys.stdout, temppath=None, tempdir=None, debug_commands=False, ): - extensions = extensions or [] temppath = temppath or pathlib.Path( tempfile.mkstemp(prefix="muttmdwn-", dir=tempdir)[1] ) cmds = MuttCommands(out_f, debug=debug_commands) - editor = f"{sys.argv[0]} massage --write-commands-to {temppath}" - if extensions: - editor = f'{editor} --extensions {",".join(extensions)}' - if tempdir: - editor = f"{editor} --tempdir {tempdir}" - if debug_commands: - editor = f"{editor} --debug-commands" + editor = f"{' '.join(sys.argv)} massage --write-commands-to {temppath}" cmds.cmd('set my_editor="$editor"') cmds.cmd('set my_edit_headers="$edit_headers"') @@ -433,6 +402,7 @@ def do_massage( *, extensions=None, converter=convert_markdown_to_html, + only_build=False, tempdir=None, debug_commands=False, debug_walk=False, @@ -466,6 +436,8 @@ def do_massage( depth-first, and responsible for telling NeoMutt how to assemble the tree. """ + KILL_LINE=r'\Ca\Ck' + if isinstance(item, Part): # We've hit a leaf-node, i.e. an alternative or a related part # with actual content. @@ -486,7 +458,7 @@ def do_massage( # information, then we might just as well update the NeoMutt # tree now: if item.cid: - cmds.push(f"\\Ca\\Ck{item.cid}") + cmds.push(f"{KILL_LINE}{item.cid}") elif isinstance(item, Multipart): # This node has children, but we already visited them (see @@ -506,7 +478,7 @@ def do_massage( # If the item has a description, we might just as well add it if item.desc: - cmds.push(f"\\Ca\\Ck{item.desc}") + cmds.push(f"{KILL_LINE}{item.desc}") # Finally, if we're at non-root level, tag the new container, # as it might itself be part of a container, to be processed @@ -521,6 +493,9 @@ def do_massage( # function mimetree.walk(tree, visitor_fn=visitor_fn) + if not only_build: + cmds.push("") + # Finally, cleanup. Since we're responsible for removing the temporary # file, how's this for a little hack? try: @@ -537,12 +512,8 @@ def do_massage( if __name__ == "__main__": args = parse_cli_args() - if args.mode == "setup": - if args.send_message: - raise NotImplementedError() - + if args.mode is None: do_setup( - args.extensions, tempdir=args.tempdir, debug_commands=args.debug_commands, ) @@ -556,6 +527,7 @@ if __name__ == "__main__": pathlib.Path(args.MAILDRAFT), cmd_f, extensions=args.extensions, + only_build=args.only_build, tempdir=args.tempdir, debug_commands=args.debug_commands, debug_walk=args.debug_walk, @@ -692,27 +664,6 @@ try: mimetree.walk(basic_mime_tree) assert len(items) == 5 - def test_do_setup_no_extensions(self, const1, capsys): - "Assert basics about the setup command output" - do_setup(temppath=const1, out_f=sys.stdout) - captout = capsys.readouterr() - lines = captout.out.splitlines() - assert lines[2].endswith(f'{const1}"') - assert lines[4].endswith(const1) - assert "first-entry" in lines[-1] - assert "edit-file" in lines[-1] - - def test_do_setup_extensions(self, const1, const2, capsys): - "Assert that extensions are passed to editor" - do_setup( - temppath=const1, extensions=[const2, const1], out_f=sys.stdout - ) - captout = capsys.readouterr() - lines = captout.out.splitlines() - # assert comma-separated list of extensions passed - assert lines[2].endswith(f'{const2},{const1}"') - assert lines[4].endswith(const1) - @pytest.fixture def string_io(self, const1, text=None): return StringIO(text or const1) @@ -734,6 +685,7 @@ try: assert '="$my_edit_headers"' in lines.pop(0) assert "unset my_editor" == lines.pop(0) assert "unset my_edit_headers" == lines.pop(0) + assert "send-message" in lines.pop(0) assert "update-encoding" in lines.pop(0) assert "source 'rm -f " in lines.pop(0) assert "unset my_mdwn_postprocess_cmd_file" == lines.pop(0) @@ -753,6 +705,7 @@ try: captured = capsys.readouterr() lines = captured.out.splitlines()[4:] + assert "send-message" in lines.pop(0) assert "Related" in lines.pop(0) assert "group-related" in lines.pop(0) assert "tag-entry" in lines.pop(0)