First version
This commit is contained in:
@@ -0,0 +1,176 @@
|
||||
"""Pipeline orchestration.
|
||||
|
||||
The three stages from the design document are exposed both individually
|
||||
(:func:`fetch`, :func:`render`, :func:`impose`) and combined (:func:`build`) so
|
||||
each step can be inspected before continuing.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
from collections.abc import Sequence
|
||||
from dataclasses import dataclass
|
||||
from pathlib import Path
|
||||
|
||||
from genshin_tcg.config import Settings
|
||||
from genshin_tcg.data.assets import download_required_assets
|
||||
from genshin_tcg.data.catalog import Catalog, load_catalog, load_raw_source, save_catalog
|
||||
from genshin_tcg.data.paimon import DownloadReport, PaimonSource
|
||||
from genshin_tcg.logging_setup import get_logger
|
||||
from genshin_tcg.models import parse_catalog
|
||||
from genshin_tcg.pdf.imposition import ImpositionGrid, ImpositionResult, impose_pdf
|
||||
from genshin_tcg.rendering.converters import HtmlConverter, PlaywrightConverter, Viewport
|
||||
from genshin_tcg.rendering.renderer import CardRenderer, RenderedCard, safe_name
|
||||
|
||||
__all__ = [
|
||||
"BuildResult",
|
||||
"FetchResult",
|
||||
"build",
|
||||
"fetch",
|
||||
"impose",
|
||||
"render",
|
||||
]
|
||||
|
||||
_logger = get_logger("pipeline")
|
||||
|
||||
|
||||
@dataclass(frozen=True, slots=True)
|
||||
class FetchResult:
|
||||
catalog: Catalog
|
||||
downloads: DownloadReport | None
|
||||
source_json: Path
|
||||
|
||||
|
||||
@dataclass(frozen=True, slots=True)
|
||||
class BuildResult:
|
||||
fetch: FetchResult
|
||||
rendered: list[RenderedCard]
|
||||
imposition: ImpositionResult
|
||||
|
||||
|
||||
def fetch(
|
||||
settings: Settings,
|
||||
*,
|
||||
only: Sequence[str] | None = None,
|
||||
force: bool = False,
|
||||
with_assets: bool = True,
|
||||
) -> FetchResult:
|
||||
"""Stage 1 - download the localised JSON (+ assets) and build the catalogue."""
|
||||
settings.ensure_directories()
|
||||
with PaimonSource(settings.source_base_url) as source:
|
||||
source.save_to(source.data_url(settings.language), settings.source_json, force=force)
|
||||
source.save_to(source.tags_url(settings.language), settings.tags_json, force=force)
|
||||
|
||||
catalog = Catalog(cards=tuple(parse_catalog(load_raw_source(settings.source_json))))
|
||||
_logger.info(
|
||||
"Parsed %d card(s): %d character(s), %d action(s)",
|
||||
len(catalog),
|
||||
len(catalog.characters),
|
||||
len(catalog.actions),
|
||||
)
|
||||
if only:
|
||||
catalog = catalog.select(only)
|
||||
|
||||
save_catalog(catalog, settings.catalog_path)
|
||||
|
||||
downloads: DownloadReport | None = None
|
||||
if with_assets:
|
||||
downloads = download_required_assets(
|
||||
catalog.cards,
|
||||
assets_dir=settings.assets_dir,
|
||||
base_url=settings.source_base_url,
|
||||
force=force,
|
||||
)
|
||||
if not downloads.ok:
|
||||
_logger.warning("%d asset(s) could not be downloaded", len(downloads.failed))
|
||||
|
||||
return FetchResult(catalog=catalog, downloads=downloads, source_json=settings.source_json)
|
||||
|
||||
|
||||
def render(
|
||||
settings: Settings,
|
||||
*,
|
||||
only: Sequence[str] | None = None,
|
||||
screenshot: bool = True,
|
||||
converter: HtmlConverter | None = None,
|
||||
) -> list[RenderedCard]:
|
||||
"""Stage 2 - emit HTML for every card and (optionally) rasterise to PNG.
|
||||
|
||||
*converter* lets callers inject a pre-opened :class:`HtmlConverter` (useful in
|
||||
tests); when omitted a :class:`PlaywrightConverter` is created and closed.
|
||||
"""
|
||||
catalog = _load_catalogue(settings)
|
||||
if only:
|
||||
catalog = catalog.select(only)
|
||||
|
||||
renderer = CardRenderer(settings)
|
||||
rendered = renderer.write_html(renderer.build_views(catalog))
|
||||
if not screenshot:
|
||||
return rendered
|
||||
|
||||
if converter is not None:
|
||||
return renderer.rasterise(rendered, converter)
|
||||
|
||||
card = settings.card
|
||||
viewport = Viewport(
|
||||
width_px=card.design_width_px,
|
||||
height_px=card.design_height_px,
|
||||
scale_factor=card.scale_factor,
|
||||
)
|
||||
with PlaywrightConverter(viewport, timeout_ms=settings.render.timeout_ms) as runner:
|
||||
return renderer.rasterise(rendered, runner)
|
||||
|
||||
|
||||
def impose(
|
||||
settings: Settings,
|
||||
*,
|
||||
only: Sequence[str] | None = None,
|
||||
output: Path | None = None,
|
||||
) -> ImpositionResult:
|
||||
"""Stage 3 - lay every rendered PNG out on A4 sheets and write a PDF."""
|
||||
catalog = _load_catalogue(settings)
|
||||
if only:
|
||||
catalog = catalog.select(only)
|
||||
|
||||
images = [settings.png_dir / f"{safe_name(card.id)}.png" for card in catalog]
|
||||
grid = _grid_from_settings(settings)
|
||||
return impose_pdf(images, output or settings.pdf_path, grid)
|
||||
|
||||
|
||||
def build(
|
||||
settings: Settings,
|
||||
*,
|
||||
only: Sequence[str] | None = None,
|
||||
force: bool = False,
|
||||
with_assets: bool = True,
|
||||
screenshot: bool = True,
|
||||
) -> BuildResult:
|
||||
"""Run all three stages in sequence."""
|
||||
fetch_result = fetch(settings, only=only, force=force, with_assets=with_assets)
|
||||
rendered = render(settings, only=only, screenshot=screenshot)
|
||||
imposition = impose(settings, only=only, output=settings.pdf_path)
|
||||
return BuildResult(fetch=fetch_result, rendered=rendered, imposition=imposition)
|
||||
|
||||
|
||||
def _load_catalogue(settings: Settings) -> Catalog:
|
||||
if not settings.catalog_path.is_file():
|
||||
raise FileNotFoundError(
|
||||
f"No catalogue at {settings.catalog_path}. Run the 'fetch' command first."
|
||||
)
|
||||
return load_catalog(settings.catalog_path)
|
||||
|
||||
|
||||
def _grid_from_settings(settings: Settings) -> ImpositionGrid:
|
||||
page = settings.page
|
||||
card = settings.card
|
||||
return ImpositionGrid(
|
||||
page_width_mm=page.width_mm,
|
||||
page_height_mm=page.height_mm,
|
||||
card_width_mm=card.width_mm,
|
||||
card_height_mm=card.height_mm,
|
||||
columns=page.columns,
|
||||
rows=page.rows,
|
||||
margin_mm=page.margin_mm,
|
||||
gutter_mm=page.gutter_mm,
|
||||
cut_marks=page.cut_marks,
|
||||
mark_length_mm=page.mark_length_mm,
|
||||
)
|
||||
Reference in New Issue
Block a user