Improved CLI parsing and added support for extra Typst arguments (#1)

* Formatting

* Updated parsing and added arg for extra typst args

* Formatting

* Update README.md

* Fixed program description

* Fixed extra_args type

* Bumped version to 0.1.0

Breaking changes to the CLI commands.
Moving from `typst_pyimage compile/watch` to `typst_pyimage --compile/--watch`.

* Moved back from flags to subcommands

* Fixing formatting

Author: etiennecollin

README.md

@@ -61,20 +61,24 @@ This requires that you're using Typst locally -- it won't work with the web app.
 
 2. Use these functions.
 
-    a. `pyimage(string, ..arguments) -> content`. The positional string should be a Python program that creates a single matplotlib figure. Any named arguments are forwarded on to Typst's built-in `image` function. You can use it just like the normal `image` function, e.g. `#align(center, pyimage("..."))`.
+   a. `pyimage(string, ..arguments) -> content`. The positional string should be a Python program that creates a single matplotlib figure. Any named arguments are forwarded on to Typst's built-in `image` function. You can use it just like the normal `image` function, e.g. `#align(center, pyimage("..."))`.
 
-    b. `pycontent(string)`. The positional string should be a Python program that produces a string on its final line. This string will be treated as Typst code.
+   b. `pycontent(string)`. The positional string should be a Python program that produces a string on its final line. This string will be treated as Typst code.
 
-    c. `pyinit(string)`. The positional string should be a Python program. This will be evaluated before all `pyimage` or `pycontent` calls, e.g. to perform imports or other setup.
+   c. `pyinit(string)`. The positional string should be a Python program. This will be evaluated before all `pyimage` or `pycontent` calls, e.g. to perform imports or other setup.
 
 3. Compile or watch. Run either of the following two commands:
-    ```
-    python -m typst_pyimage compile your_file.typ
-    python -m typst_pyimage watch your_file.typ
-    ```
-    This will extract and run all your Python code. In addition it will call either `typst compile your_file.typ` or `typst watch your_file.typ`.
 
-    The resulting images are saved in the `.typst_pyimage` folder.
+   ```
+   python -m typst_pyimage compile your_file.typ
+   python -m typst_pyimage watch your_file.typ
+   ```
+
+   This will extract and run all your Python code. In addition it will call either `typst compile your_file.typ` or `typst watch your_file.typ`.
+
+   The resulting images are saved in the `.typst_pyimage` folder.
+
+   For more information on the available arguments, run `python -m typst_pyimage -h`.
 
 ## Notes
 
@@ -83,6 +87,7 @@ It's common to have an initial block of code that is in common to all `#pyimage(
 Each `#pyimage("...")` block is executed as a fresh module (i.e. as if each was a separate Python file), but with the same Python interpreter.
 
 Overall, this is essentially equivalent to the following Python code:
+
 ```
 # main.py
 import pyinit
@@ -100,6 +105,7 @@ from pyinit import *
 from pyinit import *
 ...  # your second #pyimage("...") code
 ```
+
 This means that e.g. any global caches will be shared across all `#pyimage("...")` calls. (Useful when using a library like JAX, which has a JIT compilation cache.)
 
 ## Limitations

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "typst_pyimage"
-version = "0.0.3"
+version = "0.0.4"
 description = "Typst extension, adding support for generating figures using inline Python code"
 readme = "README.md"
 requires-python = "~=3.8"

typst_pyimage/__main__.py

@@ -1,14 +1,85 @@
-import sys
+import argparse
+import os
 
 from .run import compile as compile, watch as watch
 
 
-if len(sys.argv) != 3:
-    raise RuntimeError("Usage is `python -m typst_pyimage <command> <file>`")
-_, command, filename = sys.argv
-if command == "watch":
-    watch(filename)
-elif command == "compile":
-    compile(filename)
-else:
-    raise RuntimeError(f"Invalid command {command}")
+def parse_args(args):
+    filepath = args.filepath
+
+    # Check if the file exists
+    if not os.path.exists(filepath):
+        raise FileNotFoundError(f"File '{filepath}' not found")
+
+    extra_args = args.extra_args.replace("~", os.path.expanduser("~")).split()
+
+    return filepath, extra_args
+
+
+def _compile_wrapper(args):
+    try:
+        filepath, extra_args = parse_args(args)
+    except Exception as e:
+        print(e)
+        return
+
+    compile(filepath, extra_args)
+
+
+def _watch_wrapper(args):
+    try:
+        filepath, extra_args = parse_args(args)
+    except Exception as e:
+        print(e)
+        return
+
+    watch(filepath, extra_args)
+
+
+program_description = (
+    "Typst extension, adding support for generating"
+    + " figures using inline Python code."
+)
+
+
+# Create the parser
+parser = argparse.ArgumentParser(
+    prog="typst_pyimage",
+    description=program_description,
+)
+
+# Create subparsers
+subparser = parser.add_subparsers(help="sub-command help")
+
+# Create subparsers for the subcommands
+subparser_compile = subparser.add_parser(
+    "compile", aliases=["c"], help="Compile the typst file"
+)
+subparser_watch = subparser.add_parser(
+    "watch", aliases=["w"], help="Watch the typst file"
+)
+
+# Set the subparsers to call the appropriate function
+subparser_compile.set_defaults(func=_compile_wrapper)
+subparser_watch.set_defaults(func=_watch_wrapper)
+
+# Required positional argument
+parser.add_argument(
+    "filepath",
+    action="store",
+    type=str,
+    default=".",
+    help="The path to the typst file to be compiled/watched",
+)
+
+# Optional argument
+parser.add_argument(
+    "-a",
+    "--extra-args",
+    type=str,
+    help="Extra arguments to be passed to typst",
+)
+
+# Parse the arguments
+args = parser.parse_args()
+args.func(args)

typst_pyimage/run.py

@@ -154,7 +154,13 @@ def _initial(
     return filepath, dirpath, init_code, init_scope
 
 
-def watch(filename: Union[str, pathlib.Path], timeout_s: Optional[int] = None):
+def watch(
+    filename: Union[str, pathlib.Path],
+    extra_args: Optional[list[str]] = None,
+    timeout_s: Optional[int] = None,
+):
+    if extra_args is None:
+        extra_args = []
     figcache = {}
     contentcache = {}
     filepath, dirpath, init_code, init_scope = _initial(
@@ -165,7 +171,7 @@ def watch(filename: Union[str, pathlib.Path], timeout_s: Optional[int] = None):
     file_time = last_time = _get_file_time(filepath)
     keep_running = True
     need_update = False
-    process = subprocess.Popen(["typst", "watch", str(filepath)])
+    process = subprocess.Popen(["typst", "watch"] + extra_args + [str(filepath)])
     try:
         while keep_running:
             if need_update:
@@ -184,6 +190,8 @@ def watch(filename: Union[str, pathlib.Path], timeout_s: Optional[int] = None):
         process.kill()
 
 
-def compile(filename: Union[str, pathlib.Path]):
+def compile(filename: Union[str, pathlib.Path], extra_args: Optional[list[str]] = None):
+    if extra_args is None:
+        extra_args = []
     filepath, _, _, _ = _initial(filename, figcache=None, contentcache=None)
-    subprocess.run(["typst", "compile", str(filepath)])
+    subprocess.run(["typst", "compile"] + extra_args + [str(filepath)])