refactor!: Organise the hugr-py modules #1460
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1460 +/- ##
==========================================
- Coverage 87.89% 87.87% -0.02%
==========================================
Files 122 125 +3
Lines 20971 20989 +18
Branches 18200 18200
==========================================
+ Hits 18432 18445 +13
- Misses 1755 1760 +5
Partials 784 784
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
ss2165
approved these changes
Aug 28, 2024
There was a problem hiding this comment.
My main concern with rexporting is that any initalisation code in every re-exported submodule is run whenever the top level init is run. This would be quite bad for example for the standard extensions which load from JSON currently. I think it is acceptable for the things being re-exported here, which are just builder things mostly.
ss2165
reviewed
Aug 28, 2024
hugr-py/src/hugr/__init__.py
Outdated
| from .hugr import Hugr | ||
| from .node_port import Direction, InPort, Node, OutPort, Wire | ||
| from .hugr.base import Hugr | ||
| from .hugr.node_port import Direction, InPort, Node, OutPort, Wire | ||
| from .ops import Op | ||
| from .tys import Kind, Type |
There was a problem hiding this comment.
It might be worth removing the ops and tys rexports for consistency
aborgna-q
force-pushed
the
ab/reorganise-py-modules
branch
from
69186b5
to
1e01cd4
Compare
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Quick breaking change:
hugrdefinition andnode_portinside ahugrmodulebuildmoduleBREAKING CHANGE: Moved all builder definitions into the
hugr.buildmodule. Movednode_portandrenderinto thehugr.hugrmodule.