feat(hugr-py)!: pretty printing for ops and types #1482

ss2165 · 2024-08-29T12:26:39Z

Closes #1468
Closes #1470

Previous testing wasn't covering label formatting because it requires actually rendering the dot in to an image. Have enabled that, but put it behind an env var because it significantly slows down tests.

BREAKING CHANGE: rename Custom.name to Custom.op_name and Func(Defn/Decl).name to f_name to allow for new name method

codecov · 2024-08-29T12:28:31Z

Codecov Report

Attention: Patch coverage is 95.12195% with 8 lines in your changes missing coverage. Please review.

Project coverage is 88.00%. Comparing base (a7b2718) to head (79f9b00).
Report is 2 commits behind head on main.

Files with missing lines	Patch %	Lines
hugr-py/src/hugr/ops.py	95.31%	3 Missing ⚠️
hugr-py/src/hugr/hugr/render.py	90.00%	2 Missing ⚠️
hugr-py/src/hugr/_serialization/tys.py	83.33%	1 Missing ⚠️
hugr-py/src/hugr/ext.py	80.00%	1 Missing ⚠️
hugr-py/src/hugr/hugr/base.py	66.66%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1482      +/-   ##
==========================================
+ Coverage   87.95%   88.00%   +0.05%     
==========================================
  Files         125      125              
  Lines       21114    21244     +130     
  Branches    18272    18272              
==========================================
+ Hits        18570    18695     +125     
- Misses       1760     1765       +5     
  Partials      784      784

Flag	Coverage Δ
python	`92.69% <95.12%> (+0.15%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

aborgna-q · 2024-08-29T12:34:26Z

hugr-py/tests/conftest.py

+        if os.environ.get("HUGR_RENDER_DOT"):
+            with NamedTemporaryFile(mode="w", delete=True) as f:
+                # test rendering succeeds
+                dot.render(f.name)


Use dot.pipe("svg") instead of writing to a file.
It should be much quicker.

https://graphviz.readthedocs.io/en/stable/manual.html#piped-output

much simpler, thanks (though it is similarly slow)

mark-koch

Looks good, the only thing I'm not sure about are generic function types (see comment below)

hugr-py/src/hugr/ops.py

hugr-py/src/hugr/tys.py

mark-koch · 2024-08-29T15:20:14Z

hugr-py/src/hugr/tys.py

+    def __str__(self) -> str:
+        # ∀[a]. [list<a>] -> [Bool]
+        return f"∀{self.params}. {self.body!s})"


This would look more like ∀[TypeTypeParam(TypeBound.Any)].[list<Variable(0)>] -> [Bool]

We probably want more concise __str__ implementations for TypeParams. Also maybe we should print sth like $0 instead of Variable(0) (same for VariableArg)?

mark-koch · 2024-08-29T15:21:22Z

hugr-py/src/hugr/tys.py

+    def __str__(self) -> str:
+        return f"{self.type_def.name}<{', '.join(str(arg) for arg in self.args)}>"
+


<> should be left out if self.args is empty

mark-koch · 2024-08-29T15:22:01Z

hugr-py/src/hugr/tys.py

+    def __str__(self) -> str:
+        return f"{self.id}<{', '.join(str(arg) for arg in self.args)}>"


BREAKING CHANGE: rename Custom.name to Custom.op_name to allow for new `name` method

…qualified

mark-koch

Love the tests!

🤖 I have created a release *beep* *boop* --- ## [0.8.0](hugr-py-v0.7.0...hugr-py-v0.8.0) (2024-08-30) ### ⚠ BREAKING CHANGES * Moved `itobool`/`ifrombool`/`itostring_{u,s}` to the conversions extension. * Binary sums representing fallible values now use tag `1` for the successful variant * **hugr-py:** rename `Custom.name` to `Custom.op_name` and `Func(Defn/Decl).name` to `f_name` to allow for new `name` method * `ListOp::pop` now returns an option. * Moved all builder definitions into the `hugr.build` module. Moved `node_port` and `render` into the `hugr.hugr` module. * Move `Lift`, `MakeTuple`, `UnpackTuple` and `Lift` from core operations to prelude. Rename `ops::leaf` module to `ops::sum`. * **hugr-py:** `hugr.serialization` module and `to_serial` methods are now internal only. * Renamed `_DfBase` to `DfBase` and `_DefinitionBuilder` to `DefinitionBuilder` * `idivmod_checked`, `idivmod`, `idiv`, `idiv_checked`, `imod`, `ishl`, `ishr`, `irotl`, `irotr` operations now only have one width argument for all inputs and outputs rather than two. * HUGRs containing opaque operations that don't point to an extension in the registry will fail to validate. Use `Package` to pack extensions with HUGRs for serialisation. * `CustomOp` removed, `OpType` now contains `ExtensionOp` and `OpaqueOp` directly. `CustomOpError` renamed to`OpaqueOpError`. ### Features * `Option` / `Result` helpers ([#1481](#1481)) ([9698420](9698420)) * Add missing ops ([#1463](#1463)) ([841f450](841f450)) * Add more list operations ([#1474](#1474)) ([037005f](037005f)) * Bring in the pure-python renderer from guppy ([#1462](#1462)) ([001e66a](001e66a)) * disallow opaque ops during validation ([#1431](#1431)) ([fbbb805](fbbb805)) * fill out array ops ([#1491](#1491)) ([26ec57a](26ec57a)) * **hugr-py:** pretty printing for ops and types ([#1482](#1482)) ([aca403a](aca403a)) * **hugr-py:** use serialized extensions in python ([#1459](#1459)) ([a61f4df](a61f4df)), closes [#1450](#1450) * int operations other than widen/narrow have only one width arg ([#1455](#1455)) ([c39ed15](c39ed15)) * Move `Lift`, `MakeTuple`, `UnpackTuple` and `Lift` to prelude ([#1475](#1475)) ([b387505](b387505)) * Move int conversions to `conversions` ext, add to/from usize ([#1490](#1490)) ([88913f2](88913f2)) ### Bug Fixes * **hugr-py:** record node children correctly when deserializing ([#1480](#1480)) ([331125a](331125a)), closes [#1479](#1479) * **py:** Invalid node indexing ([#1457](#1457)) ([d6edcd7](d6edcd7)) * schema for array inner types ([#1494](#1494)) ([d43cbb2](d43cbb2)), closes [#1471](#1471) * Sum value equality. Add unit tests ([#1484](#1484)) ([a7b2718](a7b2718)) ### Code Refactoring * flatten `CustomOp` in to `OpType` ([#1429](#1429)) ([8e8bba5](8e8bba5)) * **hugr-py:** make serialization (module/methods) private ([#1477](#1477)) ([49a5bad](49a5bad)) * Make `_DfBase` and `_DefinitionBuilder` public ([#1461](#1461)) ([ea9cca0](ea9cca0)) * Make Either::Right the "success" case ([#1489](#1489)) ([8caa572](8caa572)) * Organise the hugr-py modules ([#1460](#1460)) ([3ca56f4](3ca56f4)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). --------- Co-authored-by: Agustín Borgna <121866228+aborgna-q@users.noreply.github.com> Co-authored-by: Agustin Borgna <agustin.borgna@quantinuum.com>

ss2165 requested a review from mark-koch August 29, 2024 12:26

ss2165 requested a review from a team as a code owner August 29, 2024 12:26

aborgna-q reviewed Aug 29, 2024

View reviewed changes

ss2165 mentioned this pull request Aug 29, 2024

feat: Option / Result helpers #1481

Merged

ss2165 added this to the hugr-rs 0.12 / hugr-py 0.8 milestone Aug 29, 2024

mark-koch reviewed Aug 29, 2024

View reviewed changes

ss2165 added 8 commits August 29, 2024 17:17

chore: add graphviz to devenv

e37787a

feat(hugr-py)!: pretty printing for ops and types

ec0a52a

BREAKING CHANGE: rename Custom.name to Custom.op_name to allow for new `name` method

add render testing, flagged by env var

ea7ed43

feat(hugr-py): render config object, with default op names not fully …

78fca17

…qualified

add rendering to coverage tests

e68a573

add setup graphviz step

7209fe9

use dot pipe rather than tempfile

91f9b73

apply review suggestions

2408784

ss2165 force-pushed the ss/repr branch from fa4a818 to 2408784 Compare August 29, 2024 16:23

ss2165 added 2 commits August 29, 2024 18:07

add tests for tys strings

4e484c7

test ops strings

79f9b00

ss2165 requested a review from mark-koch August 29, 2024 17:30

mark-koch approved these changes Aug 30, 2024

View reviewed changes

ss2165 added this pull request to the merge queue Aug 30, 2024

Merged via the queue into main with commit aca403a Aug 30, 2024
20 checks passed

ss2165 deleted the ss/repr branch August 30, 2024 09:48

hugrbot mentioned this pull request Aug 30, 2024

chore(main): release hugr-py 0.8.0 #1430

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(hugr-py)!: pretty printing for ops and types #1482

feat(hugr-py)!: pretty printing for ops and types #1482

ss2165 commented Aug 29, 2024 •

edited

Loading

codecov bot commented Aug 29, 2024 •

edited

Loading

aborgna-q Aug 29, 2024 •

edited

Loading

ss2165 Aug 29, 2024

mark-koch left a comment

mark-koch Aug 29, 2024

mark-koch Aug 29, 2024

mark-koch Aug 29, 2024

mark-koch left a comment

		def __str__(self) -> str:
		return f"{self.type_def.name}<{', '.join(str(arg) for arg in self.args)}>"

		def __str__(self) -> str:
		return f"{self.id}<{', '.join(str(arg) for arg in self.args)}>"

feat(hugr-py)!: pretty printing for ops and types #1482

feat(hugr-py)!: pretty printing for ops and types #1482

Conversation

ss2165 commented Aug 29, 2024 • edited Loading

codecov bot commented Aug 29, 2024 • edited Loading

Codecov Report

aborgna-q Aug 29, 2024 • edited Loading

Choose a reason for hiding this comment

ss2165 Aug 29, 2024

Choose a reason for hiding this comment

mark-koch left a comment

Choose a reason for hiding this comment

mark-koch Aug 29, 2024

Choose a reason for hiding this comment

mark-koch Aug 29, 2024

Choose a reason for hiding this comment

mark-koch Aug 29, 2024

Choose a reason for hiding this comment

mark-koch left a comment

Choose a reason for hiding this comment

ss2165 commented Aug 29, 2024 •

edited

Loading

codecov bot commented Aug 29, 2024 •

edited

Loading

aborgna-q Aug 29, 2024 •

edited

Loading