feat: Packages in `hugr-model` and envelope support. #2026

zrho · 2025-03-25T15:25:33Z

This PR adds packages to hugr-model with support for envelopes.

Packages for both the AST and table representation of hugr-model.
Packages in the Python model classes.
Reading and writing model envelopes in Rust.
Writing model envelopes in Python.

codecov · 2025-03-26T10:19:35Z

Codecov Report

Attention: Patch coverage is 52.73632% with 95 lines in your changes missing coverage. Please review.

Project coverage is 82.96%. Comparing base (4734948) to head (f1789a9).

Files with missing lines	Patch %	Lines
hugr-model/src/capnp/hugr_v0_capnp.rs	24.39%	61 Missing and 1 partial ⚠️
hugr-model/src/v0/ast/python.rs	0.00%	11 Missing ⚠️
hugr-py/src/hugr/envelope.py	30.00%	7 Missing ⚠️
hugr-py/src/hugr/model/__init__.py	66.66%	4 Missing ⚠️
hugr-core/src/envelope.rs	25.00%	0 Missing and 3 partials ⚠️
hugr-model/src/v0/binary/read.rs	80.00%	0 Missing and 3 partials ⚠️
hugr-core/src/import.rs	91.66%	0 Missing and 1 partial ⚠️
hugr-model/src/v0/ast/mod.rs	90.90%	0 Missing and 1 partial ⚠️
hugr-model/src/v0/ast/parse.rs	87.50%	0 Missing and 1 partial ⚠️
hugr-model/src/v0/table/mod.rs	87.50%	0 Missing and 1 partial ⚠️
... and 1 more

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2026      +/-   ##
==========================================
- Coverage   83.09%   82.96%   -0.14%     
==========================================
  Files         215      215              
  Lines       40905    41075     +170     
  Branches    37119    37273     +154     
==========================================
+ Hits        33992    34077      +85     
- Misses       5027     5107      +80     
- Partials     1886     1891       +5

Flag	Coverage Δ
python	`85.79% <52.00%> (-0.13%)`	⬇️
rust	`82.67% <52.84%> (-0.14%)`	⬇️

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.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

by macro generated code.

aborgna-q

Cool. I mostly have a question about APIs

aborgna-q · 2025-03-31T12:54:14Z

hugr-core/src/export.rs

@@ -28,7 +28,7 @@ use petgraph::unionfind::UnionFind;
 use std::fmt::Write;

 /// Export a [`Hugr`] graph to its representation in the model.
-pub fn export_hugr<'a>(hugr: &'a Hugr, bump: &'a Bump) -> table::Module<'a> {
+pub(crate) fn export_hugr<'a>(hugr: &'a Hugr, bump: &'a Bump) -> table::Module<'a> {


Check the semver-checks bot warnings!

If we don't want to expose this publicly anymore, it should be deprecated first (and leave a TODO indicating what to do in the next breaking release).

Edit: See my comment on hugr.rs about whether we should leave these un-deprecated.

aborgna-q · 2025-03-31T13:40:57Z

hugr-core/src/envelope.rs

@@ -34,6 +34,8 @@
 //! - Bit 7,6: Constant "01" to make some headers ascii-printable.
 //!

+#![allow(deprecated)]


I see you got bitten by JelteF/derive_more#419 -.-

Can you add a TODO to remove this once derive_more fixes that?
(if only we had expect...)

I've added the TODO comment with the links.

aborgna-q · 2025-03-31T13:47:55Z

hugr-core/src/hugr.rs

+    pub fn to_model<'a>(&'a self, bump: &'a model::bumpalo::Bump) -> model::table::Module<'a> {
+        export_hugr(self, bump)
+    }
+
+    /// Import a module from the model representation.
+    #[cfg(feature = "model_unstable")]
+    pub fn from_model<'a>(


I don't think we want this as a first-class HUGR method, as user should normally go via packages instead (esp. once #2029 is in.

I'd leave it in hugr::{im,ex}port::{im,ex}port_hugr instead. We'll add a to_envelope or something here once thing get implemented.

I also prefer to have this as the import_* and export_* functions. I had switched to these methods for consistency with the existing design, but it does make sense that ultimately we're going to use envelopes anyway. So it's reverted to the functions; that should address multiple comments.

aborgna-q · 2025-03-31T13:49:41Z

hugr-core/src/package.rs

+
+    /// Export this package to the model representation.
+    #[cfg(feature = "model_unstable")]
+    pub fn to_model<'a>(&'a self, bump: &'a model::bumpalo::Bump) -> model::table::Package<'a> {


Same here, do we want user to ever call this instead of load/store?

aborgna-q · 2025-03-31T13:59:00Z

hugr-py/src/hugr/model/__init__.py

Package methods missing docstrings

aborgna-q · 2025-03-31T14:01:26Z

hugr-py/src/hugr/envelope.py

Can we have some tests for module envelopes?
(see test_envelope.py)

We can't roundtrip on the Python side yet since the equivalent of import does not exist yet, since that is less relevant currently than being able to write. I agree that there should be more tests; in the interest of getting this in a release asap and fixing it later (which appears to be the strategy we're going for) this PR might not be the place.

zrho force-pushed the zrho/model-package branch from 882d225 to 7822310 Compare March 26, 2025 10:13

zrho marked this pull request as ready for review March 26, 2025 12:09

zrho requested a review from a team as a code owner March 26, 2025 12:09

zrho requested review from tatiana-s and ss2165 March 26, 2025 12:09

zrho force-pushed the zrho/model-package branch from d011326 to 7e48e3a Compare March 26, 2025 13:02

ss2165 requested review from aborgna-q and removed request for ss2165 March 26, 2025 16:16

zrho force-pushed the zrho/model-package branch from 65710d8 to 6d7776b Compare March 26, 2025 17:02

zrho added 4 commits March 26, 2025 17:33

Packages and envelopes for hugr-model.

28aba84

Deprecate multiple hugr error in envelope instead of removing it.

ed694e5

For now suppress deprecation warning in envelope.rs since it is caused

64ba45f

by macro generated code.

Lint reasons not allowed on old Rust versions.

5fd144e

zrho force-pushed the zrho/model-package branch from 6d7776b to 2e69e9a Compare March 26, 2025 17:37

aborgna-q reviewed Mar 31, 2025

View reviewed changes

zrho added 2 commits March 31, 2025 16:32

Import/export functions instead of methods in hugr-core.

0531706

Added comment on deactivated deprecation warning.

a0cb97c

zrho force-pushed the zrho/model-package branch from 81b4fb8 to a0cb97c Compare March 31, 2025 14:37

Added missing docstrings.

f1789a9

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Packages in `hugr-model` and envelope support. #2026

feat: Packages in `hugr-model` and envelope support. #2026

zrho commented Mar 25, 2025

codecov bot commented Mar 26, 2025 •

edited

Loading

aborgna-q left a comment

aborgna-q Mar 31, 2025

aborgna-q Mar 31, 2025 •

edited

Loading

zrho Mar 31, 2025

aborgna-q Mar 31, 2025

zrho Mar 31, 2025

aborgna-q Mar 31, 2025

aborgna-q Mar 31, 2025

aborgna-q Mar 31, 2025

zrho Mar 31, 2025

feat: Packages in hugr-model and envelope support. #2026

Are you sure you want to change the base?

feat: Packages in hugr-model and envelope support. #2026

Conversation

zrho commented Mar 25, 2025

codecov bot commented Mar 26, 2025 • edited Loading

Codecov Report

aborgna-q left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aborgna-q Mar 31, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

feat: Packages in `hugr-model` and envelope support. #2026

feat: Packages in `hugr-model` and envelope support. #2026

codecov bot commented Mar 26, 2025 •

edited

Loading

aborgna-q Mar 31, 2025 •

edited

Loading