Skip to content
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.

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

feat: Bring in the pure-python renderer from guppy #1462

Merged
merged 3 commits into from
Aug 22, 2024
Merged

Conversation

aborgna-q
Copy link
Collaborator

Closes #1407.

Ports @mark-koch's rendering code from guppy, since it got deleted from there in the last hugr builder update.
Adds a Hugr.render_dot and a Hugr.store_dot method.

I'm using syrupy—a snapshot pytest extension—for testing it. I'm not sure if we want to be this strict with the generated output though.

@aborgna-q aborgna-q requested a review from a team as a code owner August 22, 2024 13:00
Copy link
Contributor

@mark-koch mark-koch left a comment

Choose a reason for hiding this comment

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

Nice! 🎉

I think the snapshot testing is fine as is for now since graphviz is deterministic (??). Can always change later if it leads to problems

hugr-py/src/hugr/hugr/base.py Outdated Show resolved Hide resolved
hugr-py/src/hugr/hugr/render.py Outdated Show resolved Hide resolved
hugr-py/src/hugr/hugr/render.py Outdated Show resolved Hide resolved
hugr-py/src/hugr/hugr/render.py Outdated Show resolved Hide resolved
color = self.palette.dark
case ConstKind():
color = self.palette.const
case _:
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe explicitly match against CFKind and add a fallthrough case with assert_never. Then mypy will enforce exhaustiveness

@aborgna-q aborgna-q changed the base branch from ab/reorganise-py-modules to main August 22, 2024 15:23
@aborgna-q aborgna-q added this pull request to the merge queue Aug 22, 2024
Copy link

codecov bot commented Aug 22, 2024

Codecov Report

Attention: Patch coverage is 89.42308% with 11 lines in your changes missing coverage. Please review.

Project coverage is 87.68%. Comparing base (ea9cca0) to head (b9072d9).
Report is 1 commits behind head on main.

Files Patch % Lines
hugr-py/src/hugr/render.py 91.57% 8 Missing ⚠️
hugr-py/src/hugr/hugr.py 66.66% 3 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1462      +/-   ##
==========================================
+ Coverage   87.66%   87.68%   +0.01%     
==========================================
  Files         120      121       +1     
  Lines       20702    20806     +104     
  Branches    17949    17949              
==========================================
+ Hits        18148    18243      +95     
- Misses       1785     1794       +9     
  Partials      769      769              
Flag Coverage Δ
python 91.31% <89.42%> (+<0.01%) ⬆️

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.

Merged via the queue into main with commit 001e66a Aug 22, 2024
21 checks passed
@aborgna-q aborgna-q deleted the ab/py-render branch August 22, 2024 15:29
github-merge-queue bot pushed a commit that referenced this pull request Aug 30, 2024
🤖 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Pure-python hugr renderer
2 participants