feat: Add `Package` definition on `hugr-core` #1587

aborgna-q · 2024-10-16T16:10:05Z

Moves the definition of packages out of hugr-cli. (We leave a re-export there to avoid breaking the API, it should be removed on the next breaking release).

Adds some helper functions to load and validate the package.

Closes #1530

drive-by: Replace hugr-core dependency on hugr-cli by hugr. There's no need to access the internals there.

codecov · 2024-10-16T16:12:34Z

Codecov Report

Attention: Patch coverage is 71.08434% with 24 lines in your changes missing coverage. Please review.

Project coverage is 85.75%. Comparing base (2412599) to head (cfadec3).
Report is 2 commits behind head on main.

Files with missing lines	Patch %	Lines
hugr-core/src/package.rs	54.00%	21 Missing and 2 partials ⚠️
hugr-cli/src/validate.rs	85.71%	0 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1587      +/-   ##
==========================================
- Coverage   85.79%   85.75%   -0.04%     
==========================================
  Files         135      136       +1     
  Lines       24687    24746      +59     
  Branches    21623    21682      +59     
==========================================
+ Hits        21180    21221      +41     
- Misses       2405     2423      +18     
  Partials     1102     1102

Flag	Coverage Δ
python	`92.68% <ø> (ø)`
rust	`84.77% <71.08%> (-0.05%)`	⬇️

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.

ss2165 · 2024-10-16T16:36:04Z

hugr-core/src/extension.rs

+            btree_map::Entry::Occupied(mut prev) => {
+                if prev.get().version() < extension.version() {
+                    *prev.get_mut() = extension.clone();
+                }
+                Ok(prev.into_mut())


doesn't appear to be tested

ss2165

📦

aborgna-q · 2024-10-17T14:02:38Z

I added some to_json methods too, to keep things symmetric.

Note that we are not enforcing that packages must only contain module-rooted HUGRs.
I'll make a separate PR with that, as we need to fix hugr-cli once that starts getting checked.

Followup to #1587. Ensures that rust `Package`s only contain module-rooted hugrs. Returns errors at construction times if the condition is not met. This required fixing `hugr-cli`, as it should be able to load both packages and arbitrary hugrs. Added `Package::from_hugr{,s}` methods that try to wrap the hugrs if possible. We'll need these for tket2. Packages are not on the spec yet, their description should include this restriction. See #1388. This PR does only modify the (unpublished) API introduced in #1587, so I'm not marking it as breaking.

Replaces the breaking changes introduced in #1587 with non-breaking deprecations. We should be able to remove these on the next breaking release.

## 🤖 New release * `hugr`: 0.13.1 -> 0.13.2 (✓ API compatible changes) * `hugr-core`: 0.13.1 -> 0.13.2 (✓ API compatible changes) * `hugr-model`: 0.13.1 -> 0.13.2 (✓ API compatible changes) * `hugr-passes`: 0.13.1 -> 0.13.2 (✓ API compatible changes) * `hugr-cli`: 0.13.1 -> 0.13.2 (✓ API compatible changes) <details><summary>Changelog</summary> ## `hugr` <blockquote> ## [0.13.2](hugr-v0.13.1...hugr-v0.13.2) - 2024-10-22 ### Bug Fixes - Allocate ports on root nodes ([#1585](#1585)) ### New Features - Render function names in `mermaid`/`dot` ([#1583](#1583)) - Add filter_edge_kind to PortIterator ([#1593](#1593)) - make errors more readable with Display impls ([#1597](#1597)) - Ensure packages always have modules at the root ([#1589](#1589)) - Add `Package` definition on `hugr-core` ([#1587](#1587)) </blockquote> ## `hugr-core` <blockquote> ## [0.13.2](hugr-core-v0.13.1...hugr-core-v0.13.2) - 2024-10-22 ### Bug Fixes - Allocate ports on root nodes ([#1585](#1585)) ### New Features - Add `Package` definition on `hugr-core` ([#1587](#1587)) - Render function names in `mermaid`/`dot` ([#1583](#1583)) - Add filter_edge_kind to PortIterator ([#1593](#1593)) - make errors more readable with Display impls ([#1597](#1597)) - Ensure packages always have modules at the root ([#1589](#1589)) </blockquote> ## `hugr-model` <blockquote> ## [0.13.2](hugr-model-v0.13.1...hugr-model-v0.13.2) - 2024-10-22 ### New Features - make errors more readable with Display impls ([#1597](#1597)) </blockquote> ## `hugr-passes` <blockquote> ## [0.13.2](hugr-passes-v0.13.1...hugr-passes-v0.13.2) - 2024-10-22 ### New Features - make errors more readable with Display impls ([#1597](#1597)) </blockquote> ## `hugr-cli` <blockquote> ## [0.13.2](hugr-cli-v0.13.1...hugr-cli-v0.13.2) - 2024-10-22 ### New Features - Add `Package` definition on `hugr-core` ([#1587](#1587)) - Ensure packages always have modules at the root ([#1589](#1589)) </blockquote> </details> --- This PR was generated with [release-plz](https://github.com/MarcoIeni/release-plz/).

## 🤖 New release * `hugr`: 0.13.2 -> 0.13.3 (✓ API compatible changes) * `hugr-core`: 0.13.2 -> 0.13.3 (✓ API compatible changes) * `hugr-model`: 0.13.2 -> 0.14.0 (⚠️ API breaking changes) * `hugr-passes`: 0.13.2 -> 0.13.3 * `hugr-cli`: 0.13.2 -> 0.13.3 ### ⚠️ `hugr-model` breaking changes ``` --- 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.36.0/src/lints/enum_variant_added.ron Failed in: variant RegionKind:Module in /tmp/.tmpL1Ich1/hugr/hugr-model/src/v0/mod.rs:390 variant Operation:DeclareConstructor in /tmp/.tmpL1Ich1/hugr/hugr-model/src/v0/mod.rs:349 variant Operation:DeclareOperation in /tmp/.tmpL1Ich1/hugr/hugr-model/src/v0/mod.rs:357 ``` <details><summary>Changelog</summary> ## `hugr` <blockquote> ## [0.13.3](hugr-v0.13.2...hugr-v0.13.3) - 2024-11-06 ### Bug Fixes - Insert DFG directly as a funcdefn in `Package::from_hugr` ([#1621](#1621)) ### New Features - `HugrMut::remove_metadata` ([#1619](#1619)) - Operation and constructor declarations in `hugr-model` ([#1605](#1605)) - Add TailLoop::BREAK_TAG and CONTINUE_TAG ([#1626](#1626)) </blockquote> ## `hugr-core` <blockquote> ## [0.13.3](hugr-core-v0.13.2...hugr-core-v0.13.3) - 2024-11-06 ### Bug Fixes - Insert DFG directly as a funcdefn in `Package::from_hugr` ([#1621](#1621)) ### New Features - `HugrMut::remove_metadata` ([#1619](#1619)) - Operation and constructor declarations in `hugr-model` ([#1605](#1605)) - Add TailLoop::BREAK_TAG and CONTINUE_TAG ([#1626](#1626)) </blockquote> ## `hugr-model` <blockquote> ## [0.14.0](hugr-model-v0.13.2...hugr-model-v0.14.0) - 2024-11-06 ### New Features - Operation and constructor declarations in `hugr-model` ([#1605](#1605)) </blockquote> ## `hugr-passes` <blockquote> ## [0.13.2](hugr-passes-v0.13.1...hugr-passes-v0.13.2) - 2024-10-22 ### New Features - make errors more readable with Display impls ([#1597](#1597)) </blockquote> ## `hugr-cli` <blockquote> ## [0.13.2](hugr-cli-v0.13.1...hugr-cli-v0.13.2) - 2024-10-22 ### New Features - Add `Package` definition on `hugr-core` ([#1587](#1587)) - Ensure packages always have modules at the root ([#1589](#1589)) </blockquote> </details> --- This PR was generated with [release-plz](https://github.com/MarcoIeni/release-plz/).

Followup to #1587. Ensures that rust `Package`s only contain module-rooted hugrs. Returns errors at construction times if the condition is not met. This required fixing `hugr-cli`, as it should be able to load both packages and arbitrary hugrs. Added `Package::from_hugr{,s}` methods that try to wrap the hugrs if possible. We'll need these for tket2. Packages are not on the spec yet, their description should include this restriction. See #1388. This PR does only modify the (unpublished) API introduced in #1587, so I'm not marking it as breaking.

Replaces the breaking changes introduced in #1587 with non-breaking deprecations. We should be able to remove these on the next breaking release.

## 🤖 New release * `hugr`: 0.13.1 -> 0.13.2 (✓ API compatible changes) * `hugr-core`: 0.13.1 -> 0.13.2 (✓ API compatible changes) * `hugr-model`: 0.13.1 -> 0.13.2 (✓ API compatible changes) * `hugr-passes`: 0.13.1 -> 0.13.2 (✓ API compatible changes) * `hugr-cli`: 0.13.1 -> 0.13.2 (✓ API compatible changes) <details><summary>Changelog</summary> ## `hugr` <blockquote> ## [0.13.2](hugr-v0.13.1...hugr-v0.13.2) - 2024-10-22 ### Bug Fixes - Allocate ports on root nodes ([#1585](#1585)) ### New Features - Render function names in `mermaid`/`dot` ([#1583](#1583)) - Add filter_edge_kind to PortIterator ([#1593](#1593)) - make errors more readable with Display impls ([#1597](#1597)) - Ensure packages always have modules at the root ([#1589](#1589)) - Add `Package` definition on `hugr-core` ([#1587](#1587)) </blockquote> ## `hugr-core` <blockquote> ## [0.13.2](hugr-core-v0.13.1...hugr-core-v0.13.2) - 2024-10-22 ### Bug Fixes - Allocate ports on root nodes ([#1585](#1585)) ### New Features - Add `Package` definition on `hugr-core` ([#1587](#1587)) - Render function names in `mermaid`/`dot` ([#1583](#1583)) - Add filter_edge_kind to PortIterator ([#1593](#1593)) - make errors more readable with Display impls ([#1597](#1597)) - Ensure packages always have modules at the root ([#1589](#1589)) </blockquote> ## `hugr-model` <blockquote> ## [0.13.2](hugr-model-v0.13.1...hugr-model-v0.13.2) - 2024-10-22 ### New Features - make errors more readable with Display impls ([#1597](#1597)) </blockquote> ## `hugr-passes` <blockquote> ## [0.13.2](hugr-passes-v0.13.1...hugr-passes-v0.13.2) - 2024-10-22 ### New Features - make errors more readable with Display impls ([#1597](#1597)) </blockquote> ## `hugr-cli` <blockquote> ## [0.13.2](hugr-cli-v0.13.1...hugr-cli-v0.13.2) - 2024-10-22 ### New Features - Add `Package` definition on `hugr-core` ([#1587](#1587)) - Ensure packages always have modules at the root ([#1589](#1589)) </blockquote> </details> --- This PR was generated with [release-plz](https://github.com/MarcoIeni/release-plz/).

## 🤖 New release * `hugr`: 0.13.2 -> 0.13.3 (✓ API compatible changes) * `hugr-core`: 0.13.2 -> 0.13.3 (✓ API compatible changes) * `hugr-model`: 0.13.2 -> 0.14.0 (⚠️ API breaking changes) * `hugr-passes`: 0.13.2 -> 0.13.3 * `hugr-cli`: 0.13.2 -> 0.13.3 ### ⚠️ `hugr-model` breaking changes ``` --- 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.36.0/src/lints/enum_variant_added.ron Failed in: variant RegionKind:Module in /tmp/.tmpL1Ich1/hugr/hugr-model/src/v0/mod.rs:390 variant Operation:DeclareConstructor in /tmp/.tmpL1Ich1/hugr/hugr-model/src/v0/mod.rs:349 variant Operation:DeclareOperation in /tmp/.tmpL1Ich1/hugr/hugr-model/src/v0/mod.rs:357 ``` <details><summary>Changelog</summary> ## `hugr` <blockquote> ## [0.13.3](hugr-v0.13.2...hugr-v0.13.3) - 2024-11-06 ### Bug Fixes - Insert DFG directly as a funcdefn in `Package::from_hugr` ([#1621](#1621)) ### New Features - `HugrMut::remove_metadata` ([#1619](#1619)) - Operation and constructor declarations in `hugr-model` ([#1605](#1605)) - Add TailLoop::BREAK_TAG and CONTINUE_TAG ([#1626](#1626)) </blockquote> ## `hugr-core` <blockquote> ## [0.13.3](hugr-core-v0.13.2...hugr-core-v0.13.3) - 2024-11-06 ### Bug Fixes - Insert DFG directly as a funcdefn in `Package::from_hugr` ([#1621](#1621)) ### New Features - `HugrMut::remove_metadata` ([#1619](#1619)) - Operation and constructor declarations in `hugr-model` ([#1605](#1605)) - Add TailLoop::BREAK_TAG and CONTINUE_TAG ([#1626](#1626)) </blockquote> ## `hugr-model` <blockquote> ## [0.14.0](hugr-model-v0.13.2...hugr-model-v0.14.0) - 2024-11-06 ### New Features - Operation and constructor declarations in `hugr-model` ([#1605](#1605)) </blockquote> ## `hugr-passes` <blockquote> ## [0.13.2](hugr-passes-v0.13.1...hugr-passes-v0.13.2) - 2024-10-22 ### New Features - make errors more readable with Display impls ([#1597](#1597)) </blockquote> ## `hugr-cli` <blockquote> ## [0.13.2](hugr-cli-v0.13.1...hugr-cli-v0.13.2) - 2024-10-22 ### New Features - Add `Package` definition on `hugr-core` ([#1587](#1587)) - Ensure packages always have modules at the root ([#1589](#1589)) </blockquote> </details> --- This PR was generated with [release-plz](https://github.com/MarcoIeni/release-plz/).

feat: Add Package definition on hugr-core

5846fd7

aborgna-q requested a review from a team as a code owner October 16, 2024 16:10

aborgna-q requested a review from zrho October 16, 2024 16:10

ss2165 reviewed Oct 16, 2024

View reviewed changes

Add more extension tests

43ef6a0

ss2165 approved these changes Oct 17, 2024

View reviewed changes

Add to_json methods

cfadec3

aborgna-q added this pull request to the merge queue Oct 17, 2024

Merged via the queue into main with commit d899bd3 Oct 17, 2024
20 of 21 checks passed

aborgna-q deleted the ab/package-on-core branch October 17, 2024 14:19

This was referenced Oct 17, 2024

chore: release v0.14.0 #1582

Closed

chore: release v0.13.2 #1588

Merged

This was referenced Oct 17, 2024

feat: Ensure packages always have modules at the root #1589

Merged

chore: Unbreak release #1591

Merged

github-merge-queue bot pushed a commit that referenced this pull request Oct 21, 2024

chore: Unbreak release (#1591)

45c3106

Replaces the breaking changes introduced in #1587 with non-breaking deprecations. We should be able to remove these on the next breaking release.

hugrbot mentioned this pull request Oct 29, 2024

chore: release #1617

Merged

hugrbot mentioned this pull request Nov 8, 2024

chore: release #1644

Closed

ss2165 pushed a commit that referenced this pull request Nov 22, 2024

chore: Unbreak release (#1591)

9371881

Replaces the breaking changes introduced in #1587 with non-breaking deprecations. We should be able to remove these on the next breaking release.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add `Package` definition on `hugr-core` #1587

feat: Add `Package` definition on `hugr-core` #1587

aborgna-q commented Oct 16, 2024

codecov bot commented Oct 16, 2024 •

edited

Loading

ss2165 Oct 16, 2024

ss2165 left a comment

aborgna-q commented Oct 17, 2024

feat: Add Package definition on hugr-core #1587

feat: Add Package definition on hugr-core #1587

Conversation

aborgna-q commented Oct 16, 2024

codecov bot commented Oct 16, 2024 • edited Loading

Codecov Report

ss2165 Oct 16, 2024

Choose a reason for hiding this comment

ss2165 left a comment

Choose a reason for hiding this comment

aborgna-q commented Oct 17, 2024

feat: Add `Package` definition on `hugr-core` #1587

feat: Add `Package` definition on `hugr-core` #1587

codecov bot commented Oct 16, 2024 •

edited

Loading