icplot 0.3.3__tar.gz → 0.3.5__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: icplot
-Version: 0.3.3
+Version: 0.3.5
 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
@@ -31,6 +31,7 @@ Requires-Dist: isort; extra == "test"
 Requires-Dist: mypy; extra == "test"
 Requires-Dist: flake8; extra == "test"
 Requires-Dist: pylint; extra == "test"
+Requires-Dist: types-PyYAML; extra == "test"
 Provides-Extra: cairo
 Requires-Dist: pycairo; extra == "cairo"
 Requires-Dist: CairoSVG; extra == "cairo"

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

@@ -1,6 +1,6 @@
 [project]
 name = "icplot"
-version = "0.3.3"
+version = "0.3.5"
 authors = [
   { name="James Grogan, Irish Centre for High End Computing", email="james.grogan@ichec.ie" },
 ]
@@ -38,7 +38,8 @@ test = [
     "isort",
     "mypy",
     "flake8",
-    "pylint"
+    "pylint",
+    "types-PyYAML"
 ]
 
 cairo = [
@@ -113,7 +114,7 @@ addopts = "--cov=icplot --cov-report term --cov-fail-under=55 --cov-report xml:c
 
 [tool.tox]
 requires = ["tox"]
-env_list = ["format_check", "lint", "style", "type", "3.10", "3.13", "docs"]
+env_list = ["format_check", "lint", "style", "type", "3.10", "3.14", "docs"]
 skip_missing_interpreters = true
 
 [tool.tox.env_run_base]
@@ -153,7 +154,7 @@ commands = [["flake8", "src"]]
 
 [tool.tox.env.type]
 description = "Run Type Checks"
-deps = ["mypy", ".[types]"]
+deps = ["mypy", ".[test]"]
 commands = [["mypy", "src"]]
 
 [tool.tox.env.docs]

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

@@ -45,12 +45,17 @@ def _get_out_filename(source: Path, target: Path | None, extension: str) -> Path
     return source.parent / f"{source.stem}.{extension}"
 
 
+# The order of ImageMagick arguments was changed so that `-alpha off`
+# is applied after loading the source file rather than before.
+# This ensures proper handling when converting PDFs/SVGs,
+# as some versions of ImageMagick ignore or misapply `-alpha off` if it
+# appears before the input file.
 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}"
+        f"magick -density {resolution} -background white {source} -alpha off {outfile}"
     )
     subprocess.run(cmd, shell=True, check=True)
 

icplot-0.3.5/src/icplot/renderer/config.py

@@ -0,0 +1,73 @@
+import logging
+from pathlib import Path
+
+from pydantic import BaseModel
+
+logger = logging.getLogger(__name__)
+
+
+class TexConfig(BaseModel, frozen=True):
+    """
+    This holds settings for the Tex build
+    """
+
+    build_engine: str = "pdflatex"
+    nonstopmode: bool = True
+    use_woff_fonts: bool = True
+    templates: list[Path] = []
+
+
+class PlantUmlConfig(BaseModel, frozen=True):
+    config_path: Path | None = None
+
+
+class MermaidConfig(BaseModel, frozen=True):
+    browser_config: Path | None = None
+
+
+class RenderConfig(BaseModel, frozen=True):
+    tex: TexConfig = TexConfig()
+    plantuml: PlantUmlConfig = PlantUmlConfig()
+    mermaid: MermaidConfig = MermaidConfig()
+    extra_config: Path | None = None
+    input_formats: list[str] = []
+    output_formats: list[str] = []
+    excludes: list[str] = []
+
+
+def apply_frontmatter(config: "RenderConfig", frontmatter: dict) -> "RenderConfig":
+    """
+    Return a copy of *config* with per-file overrides from *frontmatter* applied.
+
+    Recognised keys
+    ---------------
+    theme : str
+        ``"none"``  — suppress the global plantuml config_path for this file.
+        Any other value (or absent) — leave config_path unchanged.
+    meta : dict
+        Stored for future use (SVG metadata injection). Currently a no-op.
+    """
+    if not frontmatter:
+        return config
+
+    updated_plantuml = config.plantuml
+
+    theme = frontmatter.get("theme")
+    if theme == "none":
+        updated_plantuml = config.plantuml.model_copy(update={"config_path": None})
+    elif theme not in (None, "platform"):
+        logger.warning("Unknown frontmatter theme value %r — ignoring", theme)
+
+    if "meta" in frontmatter:
+        logger.debug("Frontmatter meta present — SVG injection not yet implemented")
+
+    return config.model_copy(update={"plantuml": updated_plantuml})
+
+
+class RenderContext(BaseModel, frozen=True):
+    config: RenderConfig
+    source: Path
+    output_type: str
+    build_dir: Path
+    output_dir: Path | None = None
+    clear_workdir: bool = True

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

@@ -2,6 +2,7 @@
 This module has functionality for publishing Tex documents
 """
 
+import hashlib
 import logging
 import os
 import shutil
@@ -90,7 +91,8 @@ def render(ctx: RenderContext):
         ctx.config.tex.build_engine,
     )
 
-    work_dir = ctx.build_dir / ctx.source.stem
+    path_hash = hashlib.md5(str(ctx.source).encode()).hexdigest()[:8]
+    work_dir = ctx.build_dir / f"{ctx.source.stem}_{path_hash}"
     work_dir.mkdir(exist_ok=True, parents=True)
 
     err = _run_commands(ctx, work_dir)

icplot-0.3.5/src/icplot/renderer/frontmatter.py

@@ -0,0 +1,62 @@
+"""
+Parse icplot frontmatter from diagram source files.
+
+Frontmatter is embedded in a PlantUML block comment immediately after @startuml:
+
+    @startuml
+    /' icplot
+    theme: none
+    meta:
+      description: My diagram
+    '/
+
+The block is valid PlantUML (a block comment) and is ignored by the renderer.
+icplot reads it before invoking the renderer to control per-file behaviour.
+"""
+
+import logging
+import re
+from pathlib import Path
+
+import yaml
+
+logger = logging.getLogger(__name__)
+
+_OPEN = re.compile(r"^\s*/'[ \t]*icplot[ \t]*$")
+_CLOSE = re.compile(r"^\s*'/\s*$")
+
+
+def parse(path: Path) -> dict:
+    """
+    Return the icplot frontmatter from *path* as a dict.
+
+    Returns an empty dict if no frontmatter block is present or if the block
+    cannot be parsed as YAML.
+    """
+    try:
+        lines = path.read_text(encoding="utf-8").splitlines()
+    except OSError as exc:
+        logger.warning("Could not read %s for frontmatter: %s", path, exc)
+        return {}
+
+    in_block = False
+    block_lines: list[str] = []
+
+    for line in lines:
+        if not in_block:
+            if _OPEN.match(line):
+                in_block = True
+        else:
+            if _CLOSE.match(line):
+                break
+            block_lines.append(line)
+
+    if not block_lines:
+        return {}
+
+    try:
+        result = yaml.safe_load("\n".join(block_lines))
+        return result if isinstance(result, dict) else {}
+    except yaml.YAMLError as exc:
+        logger.warning("Could not parse icplot frontmatter in %s: %s", path, exc)
+        return {}

{icplot-0.3.3 → icplot-0.3.5}/src/icplot/renderer/graph/matplotlib.py

@@ -2,9 +2,9 @@ import logging
 from pathlib import Path
 from typing import cast
 
-from icplot.graph.series import (  # NOQA
+from icplot.graph.series import LinePlotSeries  # NOQA
+from icplot.graph.series import (
     ImageSeries,
-    LinePlotSeries,
     PlotSeries,
     ScatterPlotSeries,
 )

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

@@ -5,42 +5,72 @@ from concurrent.futures import ThreadPoolExecutor, as_completed
 from functools import partial
 from pathlib import Path
 
-from .config import RenderConfig, RenderContext
+from .config import RenderConfig, RenderContext, apply_frontmatter
 from .formats.mermaid import is_supported as mmd_supported
 from .formats.mermaid import render as render_mmd
 from .formats.plantuml import is_supported as puml_supported
 from .formats.plantuml import render as render_puml
 from .formats.tex import is_supported as tex_supported
 from .formats.tex import render as render_tex
+from .frontmatter import parse as parse_frontmatter
 
 logger = logging.getLogger(__name__)
 
-
 _ENVIRONMENT_CHECKS = {
     "tex": tex_supported,
     "puml": puml_supported,
     "mmd": mmd_supported,
 }
 
-_RENDERERS = {"tex": render_tex, "puml": render_puml, "mmd": render_mmd}
+_RENDERERS = {
+    "tex": render_tex,
+    "puml": render_puml,
+    "mmd": render_mmd,
+}
 
 _FORMATS = ["puml", "mmd", "tex"]
 
-_DEFAULT_OUTPUT_FORMATS = {"tex": ["svg"], "puml": ["png", "svg"], "mmd": ["svg"]}
+_DEFAULT_OUTPUT_FORMATS = {
+    "tex": ["svg"],
+    "puml": ["png", "svg"],
+    "mmd": ["svg"],
+}
+
+
+def _fail_task(ctx: RenderContext, reason: str):
+    """Return failure reason"""
+    logger.debug("Fail task triggered for %s: %s", ctx.source, reason)
+    return reason
 
 
 def run_tasks(tasks: list) -> list:
+    """
+    Execute render tasks and collect failures.
+    Returns a list of dicts: {"source": Path, "error": str}
+    """
     errors = []
+
     with ThreadPoolExecutor() as executor:
         futures = {}
         for t in tasks:
             ctx = t.args[0]
             logger.info("Queuing: %s -> %s", ctx.source.name, ctx.output_type)
             futures[executor.submit(t)] = t
+
         for future in as_completed(futures):
-            msg = future.result()
-            if msg:
-                errors.append(futures[future])
+            task = futures[future]
+            ctx = task.args[0]
+
+            try:
+                result = future.result()
+
+                # Some renderers may return error messages instead of raising
+                if result:
+                    errors.append({"source": ctx.source, "error": str(result)})
+
+            except Exception as e:
+                errors.append({"source": ctx.source, "error": str(e)})
+
     return errors
 
 
@@ -57,35 +87,24 @@ def find_files(root: Path, extension: str, excludes: list[str] | None) -> list[P
 
 
 def _get_extension(path: Path) -> str:
-    return path.suffix.split(".")[1]
+    return path.suffix.lstrip(".")
 
 
 def _collect_sources(root: Path, formats: list[str], excludes: list[str]) -> list[Path]:
     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:
-            logger.warning(
-                "Render environment doesn't support requested extension: %s", root
-            )
+        files.append(root)
     else:
         logger.info("Searching for sources in: %s", root)
         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:
-                logger.debug("Skipping .%s — renderer not available in environment", f)
+                logger.warning("Unknown format requested: %s — including anyway", f)
+
+            files.extend(find_files(root, f, excludes))
+
     return files
 
 
@@ -97,27 +116,49 @@ def _setup_tasks(
     for f in sources:
 
         ext = _get_extension(f)
-        if config.output_formats:
-            output_formats = config.output_formats
-        else:
-            output_formats = _DEFAULT_OUTPUT_FORMATS[ext]
+
+        output_formats = (
+            config.output_formats
+            if config.output_formats
+            else _DEFAULT_OUTPUT_FORMATS.get(ext, ["png"])
+        )
+
+        file_config = apply_frontmatter(config, parse_frontmatter(f))
 
         for fmt in output_formats:
+            ctx = RenderContext(
+                config=file_config,
+                source=f,
+                build_dir=build_dir,
+                output_dir=output_dir,
+                output_type=fmt,
+            )
+
+            # No renderer, return error
             if ext not in _RENDERERS:
-                logger.warning("No renderer for extension .%s — skipping %s", ext, f)
+                logger.warning("No renderer for .%s — reporting error for %s", ext, f)
+                tasks.append(
+                    partial(_fail_task, ctx, f"No renderer for extension: {ext}")
+                )
                 continue
-            tasks.append(
-                partial(
-                    _RENDERERS[ext],
-                    RenderContext(
-                        config=config,
-                        source=f,
-                        build_dir=build_dir,
-                        output_dir=output_dir,
-                        output_type=fmt,
-                    ),
+
+            # Environment not supported, return error
+            if not _ENVIRONMENT_CHECKS.get(ext, lambda: False)():
+                logger.warning(
+                    "Renderer unavailable for .%s — reporting error for %s", ext, f
                 )
-            )
+                tasks.append(
+                    partial(
+                        _fail_task,
+                        ctx,
+                        f"Environment not supported for extension: {ext}",
+                    )
+                )
+                continue
+
+            # Normal rendering
+            tasks.append(partial(_RENDERERS[ext], ctx))
+
     return tasks
 
 
@@ -127,12 +168,11 @@ def render(
     config: RenderConfig,
     output_dir: Path | None = None,
 ):
-
     sources = _collect_sources(root, config.input_formats, config.excludes)
 
     if not sources:
         logger.warning("No renderable sources found under: %s", root)
-        return
+        return []
 
     # There can be multiple tasks per source, if there are multiple output formats
     tasks = _setup_tasks(sources, config, build_dir, output_dir)
@@ -143,7 +183,9 @@ def render(
     succeeded = len(tasks) - len(errors)
     if errors:
         logger.error("%d/%d task(s) failed:", len(errors), len(tasks))
-        for task_error in errors:
-            logger.error("  %s", task_error.args[0].source.relative_to(root))
+        for err in errors:
+            logger.error("  %s: %s", err["source"].relative_to(root), err["error"])
     else:
         logger.info("Done — %d/%d task(s) succeeded", succeeded, len(tasks))
+
+    return errors

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: icplot
-Version: 0.3.3
+Version: 0.3.5
 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
@@ -31,6 +31,7 @@ Requires-Dist: isort; extra == "test"
 Requires-Dist: mypy; extra == "test"
 Requires-Dist: flake8; extra == "test"
 Requires-Dist: pylint; extra == "test"
+Requires-Dist: types-PyYAML; extra == "test"
 Provides-Extra: cairo
 Requires-Dist: pycairo; extra == "cairo"
 Requires-Dist: CairoSVG; extra == "cairo"

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

@@ -43,6 +43,7 @@ src/icplot/graph/series.py
 src/icplot/renderer/__init__.py
 src/icplot/renderer/cli.py
 src/icplot/renderer/config.py
+src/icplot/renderer/frontmatter.py
 src/icplot/renderer/render.py
 src/icplot/renderer/video.py
 src/icplot/renderer/charts/pgfgantt.py
@@ -67,6 +68,7 @@ src/icplot/theme/theme_generator.py
 src/icplot/theme/templates/puml.j2
 src/icplot/theme/templates/tikz.j2
 test/test_cairo.py
+test/test_frontmatter.py
 test/test_gantt_chart.py
 test/test_geometry.py
 test/test_image.py

{icplot-0.3.3 → icplot-0.3.5}/src/icplot.egg-info/requires.txt

@@ -20,3 +20,4 @@ isort
 mypy
 flake8
 pylint
+types-PyYAML

icplot-0.3.5/test/test_frontmatter.py

@@ -0,0 +1,52 @@
+from pathlib import Path
+
+from iccore.test_utils import get_test_data_dir
+
+from icplot.renderer.config import PlantUmlConfig, RenderConfig, apply_frontmatter
+from icplot.renderer.frontmatter import parse
+
+
+def test_parse_returns_dict():
+    fm = parse(get_test_data_dir() / "test_frontmatter.puml")
+    assert fm["theme"] == "none"
+    assert fm["meta"]["description"] == "Frontmatter parse test"
+
+
+def test_parse_no_frontmatter():
+    fm = parse(get_test_data_dir() / "test.puml")
+    assert fm == {}
+
+
+def test_parse_missing_file():
+    fm = parse(Path("/nonexistent/file.puml"))
+    assert fm == {}
+
+
+def test_apply_theme_none_clears_config_path(tmp_path):
+    config_file = tmp_path / "theme.puml"
+    config_file.touch()
+    config = RenderConfig(plantuml=PlantUmlConfig(config_path=config_file))
+
+    result = apply_frontmatter(config, {"theme": "none"})
+
+    assert result.plantuml.config_path is None
+
+
+def test_apply_empty_frontmatter_leaves_config_unchanged(tmp_path):
+    config_file = tmp_path / "theme.puml"
+    config_file.touch()
+    config = RenderConfig(plantuml=PlantUmlConfig(config_path=config_file))
+
+    result = apply_frontmatter(config, {})
+
+    assert result.plantuml.config_path == config_file
+
+
+def test_apply_meta_only_leaves_config_unchanged(tmp_path):
+    config_file = tmp_path / "theme.puml"
+    config_file.touch()
+    config = RenderConfig(plantuml=PlantUmlConfig(config_path=config_file))
+
+    result = apply_frontmatter(config, {"meta": {"description": "test"}})
+
+    assert result.plantuml.config_path == config_file

icplot-0.3.5/test/test_image.py

@@ -0,0 +1,37 @@
+import os
+from pathlib import Path
+
+import pytest
+from iccore.test_utils import get_test_output_dir
+
+from icplot.converter.image import _pdf_to_png, svg_to_pdf, svg_to_png
+
+
+def get_test_data_dir():
+    return Path(__file__).parent / "data"
+
+
+def test_convert_svg():
+
+    source = get_test_data_dir() / "test.svg"
+
+    png_out = Path(os.getcwd()) / "out.png"
+    svg_to_png(source, png_out)
+    png_out.unlink()
+
+    pdf_out = Path(os.getcwd()) / "out.pdf"
+    svg_to_pdf(source, pdf_out)
+    pdf_out.unlink()
+
+
+def test_convert_pdf():
+
+    source = get_test_data_dir() / "test.pdf"
+    output_dir = get_test_output_dir()
+    target = output_dir / "test.png"
+
+    _pdf_to_png(source, target)
+
+    assert target.exists()
+    assert target.stat().st_size > 0
+    target.unlink()

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

@@ -1,41 +0,0 @@
-from pathlib import Path
-
-from pydantic import BaseModel
-
-
-class TexConfig(BaseModel, frozen=True):
-    """
-    This holds settings for the Tex build
-    """
-
-    build_engine: str = "pdflatex"
-    nonstopmode: bool = True
-    use_woff_fonts: bool = True
-    templates: list[Path] = []
-
-
-class PlantUmlConfig(BaseModel, frozen=True):
-    config_path: Path | None = None
-
-
-class MermaidConfig(BaseModel, frozen=True):
-    browser_config: Path | None = None
-
-
-class RenderConfig(BaseModel, frozen=True):
-    tex: TexConfig = TexConfig()
-    plantuml: PlantUmlConfig = PlantUmlConfig()
-    mermaid: MermaidConfig = MermaidConfig()
-    extra_config: Path | None = None
-    input_formats: list[str] = []
-    output_formats: list[str] = []
-    excludes: list[str] = []
-
-
-class RenderContext(BaseModel, frozen=True):
-    config: RenderConfig
-    source: Path
-    output_type: str
-    build_dir: Path
-    output_dir: Path | None = None
-    clear_workdir: bool = True

icplot-0.3.3/test/test_image.py

@@ -1,21 +0,0 @@
-import os
-from pathlib import Path
-
-from icplot.converter.image import svg_to_pdf, svg_to_png
-
-
-def get_test_data_dir():
-    return Path(__file__).parent / "data"
-
-
-def test_convert_svg():
-
-    source = get_test_data_dir() / "test.svg"
-
-    png_out = Path(os.getcwd()) / "out.png"
-    svg_to_png(source, png_out)
-    png_out.unlink()
-
-    pdf_out = Path(os.getcwd()) / "out.pdf"
-    svg_to_pdf(source, pdf_out)
-    pdf_out.unlink()