Skip to content

Wire up PDF output (port of upstream PR #367) #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
SomethingNew71 merged 2 commits into from
May 5, 2026
Merged

Wire up PDF output (port of upstream PR #367) #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
44e1951
Wire up PDF output (port of upstream PR #367)
SomethingNew71 May 5, 2026
10baef3
Align parse() PDF docstring with diagram-only reality (PR #8 review f…
SomethingNew71 May 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions src/wireviz/Harness.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -726,9 +726,6 @@ def output(
if "csv" in fmt:
# TODO: implement CSV output (preferably using CSV library)
sys.stderr.write("CSV output is not yet supported\n")
if "pdf" in fmt:
# TODO: implement PDF output
sys.stderr.write("PDF output is not yet supported\n")

if filename is None:
# stdout mode — emit each rendered format in the user-requested order
Expand Down Expand Up @@ -812,6 +809,9 @@ def _render(
png_bytes = graph.pipe(format="png")
outputs["png"] = png_bytes

if "pdf" in fmt:
outputs["pdf"] = graph.pipe(format="pdf")
Comment on lines +812 to +813

@gemini-code-assist gemini-code-assist Bot May 5, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The current implementation of PDF output only renders the Graphviz diagram. However, the docstring in src/wireviz/wireviz.py (line 55) states that the PDF format includes "the diagram and (depending on the template) the BOM".

Since this implementation only pipes the graph to PDF, the resulting file will miss the summary Bill of Materials (BOM) table that is present in the HTML output. To maintain consistency with the documentation, you should either update the docstring in wireviz.py to clarify that PDF only contains the diagram (consistent with PNG and SVG), or consider extending the implementation to include the BOM.


if "gv" in fmt:
outputs["gv"] = graph.source

Expand Down
2 changes: 1 addition & 1 deletion src/wireviz/wireviz.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ def parse(
* "gv": the diagram, as a GraphViz source file
* "html": the diagram and (depending on the template) the BOM, as a HTML file
* "png": the diagram, as a PNG raster image
* "pdf": the diagram and (depending on the template) the BOM, as a PDF file
* "pdf": the diagram, as a PDF document (no BOM — see "html" for that)
* "svg": the diagram, as a SVG vector image
* "tsv": the BOM, as a tab-separated text file

Expand Down
2 changes: 1 addition & 1 deletion src/wireviz/wv_cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
"g": "gv",
"h": "html",
"p": "png",
# "P": "pdf",
"P": "pdf",
"s": "svg",
"t": "tsv",
}
Expand Down