228 Commits

Author SHA1 Message Date
Daniel Rojas
a4581d0834 Bump version to 0.5-dev+refactor 2025-03-01 20:33:49 +01:00
Daniel Rojas
fe7f4a3329 Apply black 2025-03-01 19:41:28 +01:00
Daniel Rojas
8f0dbe9e7f Add TODOs about utf-8 encoding/charset (#395)
Co-authored-by: kvid <kvid@users.noreply.github.com>
2025-03-01 19:41:28 +01:00
Daniel Rojas
9fbce3bbf7 Avoid ResourceWarning: unclosed file (#395)
A number of such warnings showed up when running e.g.
PYTHONWARNINGS=always python build_examples.py
PYTHONWARNINGS=always wireviz ../../examples/demo0?.yml
See https://github.com/wireviz/WireViz/pull/309#issuecomment-2170988381

Fix: All open() calls should be in a "with open() as x" statement
to ensure closing the file when exiting the block in any way.
Otherwise, use the new file_read_text() or file_write_text() functions
to read or write the whole utf-8 text file and closing it.

Co-authored-by: kvid <kvid@users.noreply.github.com>
2025-03-01 19:41:28 +01:00
KV
38ca3e2689 Provide more information when raising exception 2025-03-01 19:41:28 +01:00
Martin Rieder
ff6afac510 Update comment in src/wireviz/wireviz.py (#392)
Clarify all exceptions catched, including changes in #392

Co-authored-by: kvid <kvid@users.noreply.github.com>
2025-03-01 19:41:28 +01:00
Martin Rieder
d4902ce87d Catch also ValueError (#392)
In Windows might ValueError be raised instead of the already
catched exceptions in some cases (depending on the Python version)

Fixes point 2 of https://github.com/wireviz/WireViz/pull/318#pullrequestreview-1457016602
2025-03-01 19:41:28 +01:00
Martin Rieder
edc68cf9fb Catch OSError also with errno=None (#392)
In Windows might OSError(errno = None) be raised instead of the already
catched exceptions in some cases (depending on the Python version)

Fixes #391
2025-03-01 19:41:28 +01:00
kvid
018e3de68b Update src/wireviz/wireviz.py (#383)
Raising TypeError is better than assert. (Black reformatted)

Co-authored-by: Andreas Motl <andreas.motl@panodata.org>
2025-03-01 19:41:28 +01:00
KV
07555f2386 Explain unexpeced top-level type (#383)
Might help in reported issues like #342
2025-03-01 19:41:28 +01:00
Daniel Rojas
152f97cc7b Add non-empty label to avoid over-sized loops (#381)
Work-around to improve the #286 use case.
- https://github.com/wireviz/WireViz/issues/286#issuecomment-2094309143
- https://stackoverflow.com/questions/70996779/graphviz-edges-between-cells-in-the-same-html-table-are-too-long

Co-authored-by: kvid <kvid@users.noreply.github.com>
2025-03-01 19:41:28 +01:00
Daniel Rojas
f5c00fa31c Rename "sheetsize_default" to <!-- %template_sheetsize% --> (#380)
Fixes #377 (makes HTML output template placeholders more consistent)

Co-authored-by: kvid <kvid@users.noreply.github.com>
2025-03-01 19:41:28 +01:00
Daniel Rojas
b06c75bf2f Rename diagram_png_base64 to diagram_png_b64 (#371)
Co-authored-by: kvid <kvid@users.noreply.github.com>
2025-03-01 19:41:28 +01:00
KV
7420718f10 Add HTML output templates README.md (#371)
Describe the HTML Output Templates, how they are specified,
and placeholder usage within these templates.
2025-03-01 19:41:27 +01:00
Daniel Rojas
812c4aa572 Avoid reading diagram file to embed unless used (#371)
Add local replacement_if_used() that call function to read the file
only when needed and append the return value as replacement.

Co-authored-by: kvid <kvid@users.noreply.github.com>
2025-03-01 19:41:27 +01:00
Daniel Rojas
6c30d0c40a Add HTML template placeholder for diagram_png_base64 (#371)
This will enable users to replace the SVG diagram with an embedded PNG,
that is an improved work-around when the SVG output from Graphviz
is not looking good. Suggested as work-around for Graphviz bug in
https://github.com/wireviz/WireViz/issues/175#issuecomment-2132206026

Co-authored-by: kvid <kvid@users.noreply.github.com>
2025-03-01 19:41:27 +01:00
Daniel Rojas
287c47a65e Add HTML template placeholders for filename (#371)
This will e.g. enable users to replace the SVG diagram with PNG,
that is needed as a work-around when the SVG output from Graphviz
is not looking good. Suggested as work-around for Graphviz bug in
https://github.com/wireviz/WireViz/issues/175#issuecomment-2132206026

Co-authored-by: kvid <kvid@users.noreply.github.com>
2025-03-01 19:41:27 +01:00
Daniel Rojas
ceaad3c39a Update APP_URL (#364)
The project was moved into the new organization 2023-05-30, but old
URLs are still working due to automatic redirects by GitHub.

https://github.com/wireviz/WireViz/issues/316#issuecomment-1568748914

Co-authored-by: kvid <kvid@users.noreply.github.com>
2025-03-01 19:41:27 +01:00
Daniel Rojas
32a62a6dd7 Use output_name as default title (#361)
The CLI handling code was redesigned for v0.4 and it seems the code
to assign a default title from v0.3.1 has been messed up. This bug
has not been triggered by build_examples.py due to it seems to call
the parse() function differently.

The output_name should be used as default title when present.

This will fix the #360 bug report.

Co-authored-by: kvid <kvid@users.noreply.github.com>
2025-03-01 19:41:27 +01:00
Daniel Rojas
98e103a0af Handle OSError(errno=EINVAL) that might be raised in Windows (#346)
In Windows might OSError(errno=EINVAL) be raised instead of the already
catched exceptions in some cases (depending on the Python version).

Suggested fix posted by JarrettR in
https://github.com/wireviz/WireViz/issues/344#issuecomment-2113476151

Co-authored-by: kvid <kvid@users.noreply.github.com>
Co-authored-by: JarrettR <jrainier@gmail.com>
2025-03-01 19:41:27 +01:00
Daniel Rojas
2400193435 Add check for outdated connector attributes
Co-authored-by: kvid <kvid@users.noreply.github.com>
2025-03-01 19:41:27 +01:00
Daniel Rojas
701815874c Remove references for unsupported output formats
Remove the references in the CLI help, but keep the placeholders elsewhere in the code as a TODO
2025-03-01 19:41:27 +01:00
Daniel Rojas
0fed30aa05 Apply suggestions from code review
Co-authored-by: kvid <kvid@users.noreply.github.com>
2025-03-01 19:41:27 +01:00
Daniel Rojas
9d1700c4a0 Improve gracefulness when invoking wireviz.parse() without file_out
This happened to be a regression for WireViz-Web [1], which aims to do
as much in memory as possible.

[1] https://github.com/daq-tools/wireviz-web.

kvid rebased and mixed original commit with similar change by Daniel Rojas

Co-authored-by: Andreas Motl <andreas.motl@panodata.org>
Co-authored-by: kvid <kvid@users.noreply.github.com>
2025-03-01 19:41:27 +01:00
Daniel Rojas
fee05a71fc Do not allow negative qty_multiplier
Co-authored-by: kvid <kvid@users.noreply.github.com>
2025-03-01 19:41:27 +01:00
Daniel Rojas
e756d62e50 Add unpopulated option to additional components qty multiplier
Co-authored-by: Jeremy Ruhland (hatchery) <jeremy@goopypanther.org>

squash me
2025-03-01 19:41:27 +01:00
Daniel Rojas
d8c6230b85 Add warning about unconnected components 2025-03-01 19:41:27 +01:00
Daniel Rojas
400c242c90 Move parse_number_and_unit() and NumberAndUnit definition to wv_utils.py
Remove unused attribute

Remove unused `&&` in GitHub workflow

Remove duplicate `category` attribute

Removed from `Connector` class since it is already defined in the `Component` superclass.

Remove unnecessary casting of `int` to `float`

https://github.com/wireviz/WireViz/pull/251#discussion_r1359000766

Continue work on BOM handling (WIP)
2025-03-01 19:41:27 +01:00
KV
6f6235ad25 Split out class AdditionalBomItem from AdditionalComponent
https://github.com/wireviz/WireViz/pull/251#discussion_r1359055105

No output changed for any examples/tutorial/tests input.
2025-03-01 19:41:27 +01:00
KV
51f730f28c Rename fill_partnumbers() to __post_init__()
https://github.com/wireviz/WireViz/pull/251#discussion_r1358992408
2025-03-01 19:41:27 +01:00
KV
bc01e7c59e Add PN string in gv_additional_component_table() 2025-03-01 19:41:27 +01:00
KV
e4ecf97c1a Avoid wrong function name in warnings 2025-03-01 19:41:27 +01:00
KV
f5f3842fa5 Handle also int colors in colon separated string
Bug: 0x112233:0x445566 in YAML input didn't convert such colors
to #112233:#445566 and the strings where just passed as uppercase
to the .gv file. Hence Graphviz printed warnings about unknown
colors and used black as color instead.

Add test for int as string. Re-ordered if statements to give an
exception when a color has an unknown type.
2025-03-01 19:41:27 +01:00
KV
c47de6be53 Include "tests" folders in the build tool groups
Allow absent "prefix" in group entries to simplify the code
2025-03-01 19:41:27 +01:00
KV
d0e25864b3 Change BOM output file extension from .bom.tsv to .tsv
Complementary changes to the commit with the same title
earlier in the same PR. Avoid refering to the old filenames.
2025-03-01 19:41:27 +01:00
KV
e7902e8f8e Change version string to comply with PEP440
It seems "-dev" (normalized to ".dev") should only be directly followed
by a number for different deveopment releases of the same version.
See full description: https://peps.python.org/pep-0440/
2025-03-01 19:41:27 +01:00
Daniel Rojas
c33a19708c Refactor code (squashed commit)
Refactor connector node generation

Further refactor connector node generation

Rebuild demos

Generate gauge string inside Cable object

WIP: refactor cable node generation

Implement HTML indentation

WIP

More WIP

Remove old stuff, slightly simplify code

Outsource `gv_pin_table()`, simplify padding

Add TODOs

Outsource `set_dot_basics()` and `apply_dot_tweaks()`

Make setting HTML tag attributes easier through `kwargs`

Fix and simplify bgcolor logic

Reactivate cable edge generation

Outsource `gv_edge_wire()`

Make connecting things more object-oriented

Alphabetize HTML tags, improve bgcolor rendering

Make mates object-oriented

Run `autoflake -i`

Run `autoflake -i --remove-all-unused-imports`

Streamline assignment of ports to simple connectors

Implement color objects

Use color objects in WireViz

Re-sort `wv_colors.py`

Make green color darker

Break longer lines not caught by `black`

because they were unbroken strings or comments

Make variable name more expressive

Apply dot tweaks last

Remove unused line

Improve subclassing of components, prepare for BOM refactoring

Clean up

Include nested additional components in BOM

do not add autogenerated designators to BOM

Improve BOM generation (TODO: wires from a bundle)

Prepare `harness.populate_bom()`

Change `description` to `type` in additional BOM item YAML

Define CLI epilog str in single statement

Rename modules, adjust imports, move `build_examples.py`

Restructure and update `.gitignore`

Clarify `wireviz.parse()` input types

Implement BOM population (missing: qty multipliers)

Make `pin_objects` and `wire_objects` dictionaries

Compute qty's of additional components (WIP)

Add qty test file

Adapt `tutorial08.yml` (remove `unit` field)

Add `tabulate` to dependency list (might remove later if not needed)

Sort BOM by category, assign BOM IDs

Rename `Options.color_mode` to `.color_output_mod` for consistency

Change BOM output file extension from `.bom.tsv` to `.tsv`

Implement BOM bubbles

Stop recursive nesting of additional components

Add BOM bubble to additional component list (WIP)

Fix gauge conversion

Fix line breaks in code

Optimize BOM bubble geometry

Implement pin color output

Small issue: GraphViz warning
```
Warning: table size too small for content
```

Add some test files to `tests/` directory

Update test files

Allow multiple colors for components

Implement multiple colors for components, improve multicolor table rendering

Fix color cell implementation

Fix node background color rendering

Add test file for node and title bgcolors

WIP: BOM modes

Add TODO for empty connector pin tables

Comment out BOM modes (WIP) and BOM bubbles

Resume work on BOM

Include part number info in BOM table

Fix BOM output in TSV and HTML

Add bundles' wires' part number info to BOM

Add TODOs

Implement bundle part number rendering

Improve conductor table rendering

Fix additional component BOM table layout

Disable CLI BOM output

Add suggestions from #246

Add suggestions from #186

Add .vscode/ to .gitignore

Fix PyLance problems

Update interim version number

Fix zero-size cell for simple connectors without type

Implement additional parameters dict for components

Implement note for additional components

Thicken additional component table

Add placeholder for add.comp. PN info

Apply black
2025-03-01 19:41:27 +01:00
Daniel Rojas
18782444b1 Make prefix for autogenerated component names configurable
`edotor.net` does not seem to like leading underscores, which makes GraphViz debugging difficult.
2023-09-12 19:37:05 +02:00
kvid
a26f734b94 Update src/wireviz/DataClasses.py as requested in review (#264)
No need to reference github issue in the code.

Co-authored-by: Daniel Rojas <github@danielrojas.net>
2023-09-08 17:37:25 +02:00
KV
f6c3a37563 Make sure loop connected pins are not hidden (#264)
- Resolves #263 that describes warnings and weird loop drawing because
  loop connected pins are hidden when hide_disconnected_pins=True.

- Activate loop pins as early as possible to enable correct counting of
  connected pins when
  connector.additional_components.qty_multiplier=populated.

- Check that loop pins actually exist before activating them.
2023-09-08 17:37:25 +02:00
RedshiftVelocities
6f9007f45d
Use portable OS error codes so program doesn't crash (#318)
Hard-coding OS error numbers that differ between different platforms
caused the program to crash at platforms using a different error number.

Using the Standard errno system symbols will avoid this problem.

Co-authored-by: kvid <kvid@users.noreply.github.com>
2023-09-01 22:24:34 +02:00
KV
f9d1dd0148 Fix bug commented in #186
Changes in #186 made it impossible to hide cable wire numbers.

https://github.com/wireviz/WireViz/pull/186#discussion_r716246852
2023-08-27 15:47:08 +02:00
Julien Lecoeur
9dbf4538fd Fix graphviz file header (#261)
The two header comments were missing trailing newlines.

This behavior is introduced by v0.18 of the graphviz Python package;
where as v0.17 did include the newline automatically.

Closes #258
2023-08-27 15:31:17 +02:00
Daniel Rojas
ba3f0248a5 Simplify Enum 2021-10-16 22:58:47 +02:00
Daniel Rojas
6f9bb67d02 Embed images into SVG output 2021-10-16 22:39:41 +02:00
Daniel Rojas
e31ed72655 Auto-assign missing harness title if reading from file 2021-10-16 22:27:00 +02:00
Daniel Rojas
d19c260940 Simplify file access operations 2021-10-16 22:27:00 +02:00
Daniel Rojas
45bcc1dd45 Make template separator character user-configurable 2021-10-16 22:27:00 +02:00
Daniel Rojas
08b5124adb Add support for multiple prepended files 2021-10-16 22:26:59 +02:00
Daniel Rojas
5aaea651b1 Automatically include input file directory in list to resolve image paths 2021-10-16 22:26:59 +02:00