feat: Python bindings for hugr-model.
#1959
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 ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #1959 +/- ##
==========================================
- Coverage 83.79% 82.62% -1.17%
==========================================
Files 211 214 +3
Lines 39757 40552 +795
Branches 36435 36763 +328
==========================================
+ Hits 33314 33506 +192
- Misses 4567 5170 +603
Partials 1876 1876
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
zrho
force-pushed
the
zrho/model-python
branch
3 times, most recently
from
49fd266 to
f7c4ba4
Compare
zrho
force-pushed
the
zrho/model-python
branch
3 times, most recently
from
fb1ac5f to
93ee945
Compare
|
related #882 |
aborgna-q
reviewed
Mar 24, 2025
croyzor
reviewed
Mar 24, 2025
| @@ -82,6 +91,10 @@ def resolve(self, registry: ext.ExtensionRegistry) -> Type: | |||
| """Resolve types in the type using the given registry.""" | |||
| return self | |||
|
|
|||
| def to_model(self) -> model.Term | model.Splice: | |||
| """Convert the type to a model Term.""" | |||
| raise NotImplementedError(self) | |||
There was a problem hiding this comment.
The absence of implementations for Type, TypeParam, TypeArg seem like significant omissions! Is there a reasoning behind it?
There was a problem hiding this comment.
These classes are protocols. The actual types, type params, etc inherit from the class and implement the method accordingly.
croyzor
reviewed
Mar 24, 2025
| @@ -103,6 +116,10 @@ def _to_serial(self) -> stys.TypeTypeParam: | |||
| def __str__(self) -> str: | |||
| return str(self.bound) | |||
|
|
|||
| def to_model(self) -> model.Term: | |||
| # Note that we drop the bound. | |||
There was a problem hiding this comment.
Why are we dropping the bounds here and in BoundedNatParam?
There was a problem hiding this comment.
They have no representation in hugr-model. There was a big discussion on this half a year ago, resulting in the realisation that the bounds introduce subtyping and therefore make the type system unnecessarily complex. But without having a stable serialisation format, we were unable to change anything about that, leading to an in part still unresolved chicken egg problem. Bounds for type variables in some situations are emulated with constraints.
croyzor
reviewed
Mar 24, 2025
croyzor
approved these changes
Mar 26, 2025
This was referenced Mar 26, 2025
Closed
github-merge-queue bot
pushed a commit
that referenced
this pull request
Mar 28, 2025
🤖 I have created a release *beep* *boop* --- ## [0.11.4](hugr-py-v0.11.3...hugr-py-v0.11.4) (2025-03-28) ### Features * Python bindings for `hugr-model`. ([#1959](#1959)) ([25df063](25df063)) * Remove extension sets from `hugr-model`. ([#2031](#2031)) ([5dd1f96](5dd1f96)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).
Merged
github-merge-queue bot
pushed a commit
that referenced
this pull request
Apr 2, 2025
## 🤖 New release
* `hugr-model`: 0.18.1 -> 0.19.0 (⚠ API breaking changes)
* `hugr-core`: 0.15.2 -> 0.15.3 ~(⚠ API breaking changes)~
* `hugr-llvm`: 0.15.2 -> 0.15.3 (✓ API compatible changes)
* `hugr-passes`: 0.15.2 -> 0.15.3 (✓ API compatible changes)
* `hugr`: 0.15.2 -> 0.15.3 (✓ API compatible changes)
* `hugr-cli`: 0.15.2 -> 0.15.3 (✓ API compatible changes)
### ⚠ `hugr-model` breaking changes
```text
--- failure enum_missing: pub enum removed or renamed ---
Description:
A publicly-visible enum cannot be imported by its prior path. A `pub use` may have been removed, or the enum itself may have been renamed or removed entirely.
ref: https://doc.rust-lang.org/cargo/reference/semver.html#item-remove
impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.40.0/src/lints/enum_missing.ron
Failed in:
enum hugr_model::v0::table::ExtSetPart, previously in file /tmp/.tmpDqJ3X7/hugr-model/src/v0/table/mod.rs:352
--- failure enum_variant_added: enum variant added on exhaustive enum ---
Description:
A publicly-visible enum without #[non_exhaustive] has a new variant.
ref: https://doc.rust-lang.org/cargo/reference/semver.html#enum-variant-new
impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.40.0/src/lints/enum_variant_added.ron
Failed in:
variant Term:Func in /tmp/.tmpIpZPlW/hugr/hugr-model/src/v0/table/mod.rs:341
--- failure enum_variant_missing: pub enum variant removed or renamed ---
Description:
A publicly-visible enum has at least one variant that is no longer available under its prior name. It may have been renamed or removed entirely.
ref: https://doc.rust-lang.org/cargo/reference/semver.html#item-remove
impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.40.0/src/lints/enum_variant_missing.ron
Failed in:
variant Term::ExtSet, previously in file /tmp/.tmpDqJ3X7/hugr-model/src/v0/table/mod.rs:316
variant Term::ConstFunc, previously in file /tmp/.tmpDqJ3X7/hugr-model/src/v0/table/mod.rs:321
variant Term::ExtSet, previously in file /tmp/.tmpDqJ3X7/hugr-model/src/v0/ast/mod.rs:237
--- failure pub_module_level_const_missing: pub module-level const is missing ---
Description:
A public const is missing or renamed
ref: https://doc.rust-lang.org/cargo/reference/semver.html#item-remove
impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.40.0/src/lints/pub_module_level_const_missing.ron
Failed in:
CORE_EXT_SET in file /tmp/.tmpDqJ3X7/hugr-model/src/v0/mod.rs:177
```
### ⚠ `hugr-core` breaking changes (⚠️ ignored ⚠️ )
```text
--- failure enum_variant_added: enum variant added on exhaustive enum ---
Description:
A publicly-visible enum without #[non_exhaustive] has a new variant.
ref: https://doc.rust-lang.org/cargo/reference/semver.html#enum-variant-new
impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.40.0/src/lints/enum_variant_added.ron
Failed in:
variant ImportError:OrderHint in /tmp/.tmpIpZPlW/hugr/hugr-core/src/import.rs:73
```
<details><summary><i><b>Changelog</b></i></summary><p>
## `hugr-model`
<blockquote>
##
[0.19.0](hugr-model-v0.18.1...hugr-model-v0.19.0)
- 2025-04-02
### New Features
- Python bindings for `hugr-model`.
([#1959](#1959))
- Remove extension sets from `hugr-model`.
([#2031](#2031))
- Packages in `hugr-model` and envelope support.
([#2026](#2026))
- Represent order edges in `hugr-model` as metadata.
([#2027](#2027))
</blockquote>
## `hugr-core`
<blockquote>
##
[0.16.0](hugr-core-v0.15.2...hugr-core-v0.16.0)
- 2025-04-02
### Documentation
- Provide docs for array ops, fix bad doc for HugrView::poly_func_type
([#2021](#2021))
### New Features
- Expand SimpleReplacement API
([#1920](#1920))
- Python bindings for `hugr-model`.
([#1959](#1959))
- ReplaceTypes pass allows replacing extension types and ops
([#1989](#1989))
- Remove extension sets from `hugr-model`.
([#2031](#2031))
- Packages in `hugr-model` and envelope support.
([#2026](#2026))
- Represent order edges in `hugr-model` as metadata.
([#2027](#2027))
- add `build_expect_sum` to allow specific error messages
([#2032](#2032))
</blockquote>
## `hugr-llvm`
<blockquote>
##
[0.16.0](hugr-llvm-v0.15.2...hugr-llvm-v0.16.0)
- 2025-04-02
### New Features
- *(hugr-llvm)* Add llvm codegen for `arithmetic.float.fpow`
([#2042](#2042))
- *(hugr-llvm)* Emit divmod and mod operations
([#2025](#2025))
</blockquote>
## `hugr-passes`
<blockquote>
##
[0.16.0](hugr-passes-v0.15.2...hugr-passes-v0.16.0)
- 2025-04-02
### New Features
- ReplaceTypes pass allows replacing extension types and ops
([#1989](#1989))
- MakeTuple->UnpackTuple elision pass
([#2012](#2012))
- [**breaking**] Extend LowerTypes pass to linearize by inserting
copy/discard ([#2018](#2018))
</blockquote>
## `hugr`
<blockquote>
##
[0.16.0](hugr-v0.15.2...hugr-v0.16.0)
- 2025-04-02
### Documentation
- Provide docs for array ops, fix bad doc for HugrView::poly_func_type
([#2021](#2021))
### New Features
- MakeTuple->UnpackTuple elision pass
([#2012](#2012))
- [**breaking**] Extend LowerTypes pass to linearize by inserting
copy/discard ([#2018](#2018))
- Expand SimpleReplacement API
([#1920](#1920))
- Python bindings for `hugr-model`.
([#1959](#1959))
- ReplaceTypes pass allows replacing extension types and ops
([#1989](#1989))
- Remove extension sets from `hugr-model`.
([#2031](#2031))
- Represent order edges in `hugr-model` as metadata.
([#2027](#2027))
- add `build_expect_sum` to allow specific error messages
([#2032](#2032))
- Packages in `hugr-model` and envelope support.
([#2026](#2026))
</blockquote>
## `hugr-cli`
<blockquote>
##
[0.16.0](hugr-cli-v0.15.2...hugr-cli-v0.16.0)
- 2025-04-02
### Documentation
- Add usage info to hugr-cli's rustdocs
([#2044](#2044))
</blockquote>
</p></details>
---
This PR was generated with
[release-plz](https://github.com/release-plz/release-plz/).
---------
Co-authored-by: Agustín Borgna <[email protected]>
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.
This PR introduces Python bindings to
hugr-model.hugr-pydata structures into the Python AST.Until spec ambiguities about uniqueness of names are decided, the export procedure mangles the names of symbols by adding the id of the defining node.