icplot 0.3.0__tar.gz → 0.3.3__tar.gz

{icplot-0.3.0/src/icplot.egg-info → icplot-0.3.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: icplot
-Version: 0.3.0
+Version: 0.3.3
 Summary: Utilities for generating plots and graphics for technical reports.
 Author-email: "James Grogan, Irish Centre for High End Computing" <james.grogan@ichec.ie>
 Project-URL: Repository, https://git.ichec.ie/performance/toolshed/icplot

{icplot-0.3.0 → icplot-0.3.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "icplot"
-version = "0.3.0"
+version = "0.3.3"
 authors = [
   { name="James Grogan, Irish Centre for High End Computing", email="james.grogan@ichec.ie" },
 ]

{icplot-0.3.0 → icplot-0.3.3}/src/icplot/converter/image.py

@@ -5,6 +5,8 @@ formats
 
 import logging
 import os
+import shutil
+import subprocess
 from pathlib import Path
 
 logger = logging.getLogger(__name__)
@@ -29,6 +31,10 @@ def has_wand() -> bool:
     return _HAS_WAND
 
 
+def has_magick() -> bool:
+    return bool(shutil.which("magick"))
+
+
 def has_cairo_svg() -> bool:
     return _HAS_CAIRO_SVG
 
@@ -39,13 +45,27 @@ def _get_out_filename(source: Path, target: Path | None, extension: str) -> Path
     return source.parent / f"{source.stem}.{extension}"
 
 
+def _pdf_to_png(source: Path, target: Path | None = None, resolution: int = 300):
+
+    outfile = _get_out_filename(source, target, "png")
+    os.makedirs(outfile.parent, exist_ok=True)
+    cmd = (
+        f"magick -density {resolution} -background white -alpha off {source} {outfile}"
+    )
+    subprocess.run(cmd, shell=True, check=True)
+
+
 def pdf_to_png(source: Path, target: Path | None = None, resolution: int = 300):
     """
     Convert a pdf to png with white background
     """
 
     if not has_wand():
-        raise RuntimeError("Loading Wand failed - no pdf to png support")
+        if has_magick():
+            _pdf_to_png(source, target, resolution)
+            return
+        else:
+            raise RuntimeError("Loading Wand failed - no pdf to png support")
 
     outfile = _get_out_filename(source, target, "png")
     os.makedirs(outfile.parent, exist_ok=True)

icplot-0.3.3/src/icplot/renderer/__init__.py

@@ -0,0 +1,5 @@
+from . import formats  # noqa: F401 — trigger handler registration
+from .config import MermaidConfig, RenderConfig, TexConfig
+from .render import render
+
+__all__ = ["RenderConfig", "MermaidConfig", "TexConfig", "render"]

{icplot-0.3.0 → icplot-0.3.3}/src/icplot/renderer/formats/mermaid.py

@@ -5,8 +5,10 @@ Mermaid must already be set up on the system, eg. via the npm ecosystem.
 """
 
 import logging
+import os
 import shutil
 import subprocess
+from pathlib import Path
 
 from ..config import RenderContext
 
@@ -26,16 +28,20 @@ def render(ctx: RenderContext):
         raise RuntimeError("Mermaid CLI 'mmdc' not found in path.")
 
     if ctx.output_dir:
-        ctx.output_dir.mkdir(exist_ok=True)
+        ctx.output_dir.mkdir(exist_ok=True, parents=True)
         output_path = ctx.output_dir / f"{ctx.source.stem}.{ctx.output_type}"
     else:
         output_path = ctx.source.parent / f"{ctx.source.stem}.{ctx.output_type}"
 
     logger.info("Rendering: %s -> %s", ctx.source, output_path)
 
-    cmd = f"mmdc -i {ctx.source} -o {output_path}"
-    if ctx.config.mermaid.browser_config:
-        cmd += f" -p {ctx.config.mermaid.browser_config}"
+    browser_config = ctx.config.mermaid.browser_config
+    if not browser_config and (env_path := os.environ.get("MMDC_PUPPETEER_CONFIG")):
+        browser_config = Path(env_path)
+
+    cmd = f"mmdc -i '{ctx.source}' -o '{output_path}'"
+    if browser_config:
+        cmd += f" -p '{browser_config}'"
     logger.debug("Command: %s", cmd)
     subprocess.run(cmd, shell=True, check=True)
     logger.info("Done: %s", output_path.name)

{icplot-0.3.0 → icplot-0.3.3}/src/icplot/renderer/formats/plantuml.py

@@ -24,6 +24,9 @@ def render(ctx: RenderContext):
     logger.info("Rendering: %s -> %s", ctx.source, ctx.output_type)
 
     cmd = ["plantuml", f"-t{ctx.output_type}"]
+    if ctx.output_dir:
+        ctx.output_dir.mkdir(exist_ok=True, parents=True)
+        cmd.extend(["-o", str(ctx.output_dir)])
     if ctx.config.plantuml.config_path:
         cmd.extend(["-config", str(ctx.config.plantuml.config_path.resolve())])
     cmd.append(str(ctx.source))

{icplot-0.3.0 → icplot-0.3.3}/src/icplot/renderer/formats/tex.py

@@ -37,7 +37,7 @@ def _run_commands(ctx: RenderContext, work_dir: Path):
     logger.debug("Engine: %s | work_dir: %s", ctx.config.tex.build_engine, work_dir)
 
     if ctx.config.tex.build_engine == "pdflatex":
-        cmd = f"{ctx.config.tex.build_engine} {' '.join(extra_flags)} {ctx.source}"
+        cmd = f"{ctx.config.tex.build_engine} {' '.join(extra_flags)} '{ctx.source}'"
         logger.info("Command: %s", cmd.strip())
         with open(work_dir / "stdout.txt", "w", encoding="utf-8") as f:
             subprocess.run(
@@ -45,6 +45,7 @@ def _run_commands(ctx: RenderContext, work_dir: Path):
                 shell=True,
                 check=True,
                 cwd=work_dir,
+                env=tex_env,
                 stdout=f,
                 stderr=f,
                 stdin=subprocess.DEVNULL,
@@ -92,7 +93,9 @@ def render(ctx: RenderContext):
     work_dir = ctx.build_dir / ctx.source.stem
     work_dir.mkdir(exist_ok=True, parents=True)
 
-    _run_commands(ctx, work_dir)
+    err = _run_commands(ctx, work_dir)
+    if err:
+        raise RuntimeError(f"Render failed for {ctx.source.name}: {err}")
 
     tex_path = work_dir / ctx.source.name
     if ctx.config.tex.build_engine == "pdflatex":

{icplot-0.3.0 → icplot-0.3.3}/src/icplot/renderer/render.py

@@ -61,10 +61,13 @@ def _get_extension(path: Path) -> str:
 
 
 def _collect_sources(root: Path, formats: list[str], excludes: list[str]) -> list[Path]:
-    files = []
+    files: list[Path] = []
     if root.is_file():
         logger.info("Using source: %s", root)
         suffix = _get_extension(root)
+        if suffix not in _ENVIRONMENT_CHECKS:
+            logger.warning("Unknown extension .%s — no renderer registered", suffix)
+            return files
         if _ENVIRONMENT_CHECKS[suffix]():
             files.append(root)
         else:
@@ -76,6 +79,9 @@ def _collect_sources(root: Path, formats: list[str], excludes: list[str]) -> lis
         if not formats:
             formats = _FORMATS
         for f in formats:
+            if f not in _ENVIRONMENT_CHECKS:
+                logger.warning("Unknown format requested: %s — skipping", f)
+                continue
             if _ENVIRONMENT_CHECKS[f]():
                 files.extend(find_files(root, f, excludes))
             else:
@@ -97,6 +103,9 @@ def _setup_tasks(
             output_formats = _DEFAULT_OUTPUT_FORMATS[ext]
 
         for fmt in output_formats:
+            if ext not in _RENDERERS:
+                logger.warning("No renderer for extension .%s — skipping %s", ext, f)
+                continue
             tasks.append(
                 partial(
                     _RENDERERS[ext],
@@ -135,6 +144,6 @@ def render(
     if errors:
         logger.error("%d/%d task(s) failed:", len(errors), len(tasks))
         for task_error in errors:
-            logger.error("  %s", task_error[1].relative_to(root))
+            logger.error("  %s", task_error.args[0].source.relative_to(root))
     else:
         logger.info("Done — %d/%d task(s) succeeded", succeeded, len(tasks))

{icplot-0.3.0 → icplot-0.3.3/src/icplot.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: icplot
-Version: 0.3.0
+Version: 0.3.3
 Summary: Utilities for generating plots and graphics for technical reports.
 Author-email: "James Grogan, Irish Centre for High End Computing" <james.grogan@ichec.ie>
 Project-URL: Repository, https://git.ichec.ie/performance/toolshed/icplot

{icplot-0.3.0 → icplot-0.3.3}/src/icplot.egg-info/SOURCES.txt

@@ -76,5 +76,6 @@ test/test_meshing.py
 test/test_openfoam.py
 test/test_plot_group.py
 test/test_polymesh.py
+test/test_puml.py
 test/test_tex.py
 test/test_tree.py

icplot-0.3.3/test/test_puml.py

@@ -0,0 +1,24 @@
+import shutil
+
+from iccore.test_utils import get_test_data_dir, get_test_output_dir
+
+from icplot.renderer.config import RenderConfig, RenderContext
+from icplot.renderer.formats import plantuml
+
+
+def test_puml():
+
+    data_dir = get_test_data_dir()
+    build_dir = get_test_output_dir()
+
+    render_ctx = RenderContext(
+        config=RenderConfig(),
+        source=data_dir / "test.puml",
+        output_type="png",
+        output_dir=get_test_output_dir(),
+        build_dir=get_test_output_dir(),
+    )
+
+    plantuml.render(render_ctx)
+
+    shutil.rmtree(build_dir)

{icplot-0.3.0 → icplot-0.3.3}/test/test_tex.py

@@ -1,9 +1,8 @@
 import shutil
-from pathlib import Path
 
 from iccore.test_utils import get_test_data_dir, get_test_output_dir
 
-from icplot.renderer.config import MermaidConfig, RenderConfig, RenderContext
+from icplot.renderer.config import RenderConfig, RenderContext
 from icplot.renderer.formats import tex
 
 
@@ -11,11 +10,10 @@ def test_tex():
 
     data_dir = get_test_data_dir()
     build_dir = get_test_output_dir()
-    source = data_dir / "test.tex"
 
     render_ctx = RenderContext(
         config=RenderConfig(),
-        source=get_test_data_dir() / "test.tex",
+        source=data_dir / "test.tex",
         output_type="png",
         output_dir=get_test_output_dir(),
         build_dir=get_test_output_dir(),

icplot-0.3.0/src/icplot/renderer/__init__.py

@@ -1 +0,0 @@
-from . import formats  # noqa: F401 — trigger handler registration