feat: PersistentHugr Walker API #2168

lmondada · 2025-05-07T18:46:11Z

Closes #2074
Closes #2190

codecov · 2025-05-07T18:49:22Z

Codecov Report

Attention: Patch coverage is 96.22642% with 8 lines in your changes missing coverage. Please review.

Project coverage is 82.15%. Comparing base (3d2ab66) to head (20958fe).
Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
hugr-core/src/hugr/persistent/walker/pinned.rs	93.42%	4 Missing and 1 partial ⚠️
hugr-core/src/hugr/persistent/walker.rs	98.42%	2 Missing ⚠️
hugr-core/src/hugr/persistent/state_space.rs	80.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2168      +/-   ##
==========================================
+ Coverage   82.00%   82.15%   +0.15%     
==========================================
  Files         237      239       +2     
  Lines       42778    42989     +211     
  Branches    38690    38901     +211     
==========================================
+ Hits        35079    35319     +240     
+ Misses       5706     5679      -27     
+ Partials     1993     1991       -2

Flag	Coverage Δ
python	`85.34% <ø> (ø)`
rust	`81.82% <96.22%> (+0.17%)`	⬆️

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.

lmondada · 2025-05-10T16:09:04Z

EDIT: resolved!

~~I'm currently unhappy with the state of the end_to_end test within the walker folder, but this can't be simplified and moved out of the repo into tests until further enhancements to the API.~~

~~It is nonetheless a very useful test to have, even in its current form.~~

~~See #2190~~

acl-cqc

Thanks @lmondada, this is great! Not what you'd call easy stuff, but great job in making it comprehensible :-). I have about 60 small suggestions, there are only two big enough to justify not immediately approving:

Have I understand PinnedWire always has at least one endpoint pinned? I wasn't clear from the doc so I had to guess a bit, if that's not right then this may need some more thought
That equivalent_descendant_ports method....what is all the direction-changing doing...

hugr-core/src/hugr/persistent/walker.rs

hugr-core/tests/walker.rs

hugr-core/src/hugr/persistent/walker.rs

hugr-core/tests/walker.rs

…-impl-hugrview

acl-cqc

Great stuff Luca, looks good to me, thanks! :). I think you can take it from here, indeed I think some of my comments actually pertain to code from other approved/merged PRs rather than this one...(but the opportunity to remove IteratorNonEmpty might be best taken before we forget 😉)

hugr-core/src/hugr/persistent/tests.rs

hugr-core/src/hugr/persistent.rs

hugr-core/src/hugr/persistent/walker.rs

I mistakenly made these as comments on #2168 because GitHub's "show changes from last review" includes changes merged in from main - the code I was commenting on actually went into main as part of #2202 . So, nothing major, but separating out.

## 🤖 New release * `hugr-model`: 0.20.0 -> 0.20.1 * `hugr-core`: 0.20.0 -> 0.20.1 (✓ API compatible changes) * `hugr-llvm`: 0.20.0 -> 0.20.1 (✓ API compatible changes) * `hugr-passes`: 0.20.0 -> 0.20.1 (✓ API compatible changes) * `hugr`: 0.20.0 -> 0.20.1 (✓ API compatible changes) * `hugr-cli`: 0.20.0 -> 0.20.1 (✓ API compatible changes) <details><summary>Changelog</summary> ## `hugr-model` <blockquote> ## [0.20.0](hugr-model-v0.19.0...hugr-model-v0.20.0) - 2025-05-14 ### New Features - [**breaking**] Mark all Error enums as non_exhaustive ([#2056](#2056)) - [**breaking**] Bump MSRV to 1.85 ([#2136](#2136)) - Export and import entrypoints via metadata in `hugr-model`. ([#2172](#2172)) - Define text-model envelope formats ([#2188](#2188)) - Import CFG regions without adding an entry block. ([#2200](#2200)) - Symbol applications can leave out prefixes of wildcards. ([#2201](#2201)) </blockquote> ## `hugr-core` <blockquote> ## [0.20.1](hugr-core-v0.20.0...hugr-core-v0.20.1) - 2025-06-03 ### Bug Fixes - check well-definedness of DFG wires in validate ([#2221](#2221)) - Check for order edges in SiblingSubgraph::from_node ([#2223](#2223)) - Make SumType::Unit(N) equal to SumType::General([(); N]) ([#2250](#2250)) - canonicalize_nodes sometimes mangles the entrypoint ([#2263](#2263)) ### New Features - Add PersistentHugr ([#2080](#2080)) - Add `Type::used_extensions` ([#2224](#2224)) - Add boundary edge traversal in SimpleReplacement ([#2231](#2231)) - Add signature map function for DFGs ([#2239](#2239)) - PersistentHugr implements HugrView ([#2202](#2202)) - PersistentHugr Walker API ([#2168](#2168)) - Hugr::store_with_exts and auto-include in serde_as ([#2280](#2280)) ### Refactor - tidies/readability improvements to PersistentHugr ([#2251](#2251)) - Deprecate ValidationError::ExtensionError ([#2281](#2281)) ### Testing - Ignore miri errors in tests involving `assert_snapshot` ([#2261](#2261)) </blockquote> ## `hugr-llvm` <blockquote> ## [0.20.1](hugr-llvm-v0.20.0...hugr-llvm-v0.20.1) - 2025-06-03 ### Bug Fixes - Make SumType::Unit(N) equal to SumType::General([(); N]) ([#2250](#2250)) ### Testing - Add exec tests for widen op ([#2043](#2043)) </blockquote> ## `hugr-passes` <blockquote> ## [0.20.1](hugr-passes-v0.20.0...hugr-passes-v0.20.1) - 2025-06-03 ### Bug Fixes - Dataflow analysis produces unsound results on Hugrs with entrypoint ([#2255](#2255)) ### New Features - LocalizeEdges pass ([#2237](#2237)) </blockquote> ## `hugr` <blockquote> ## [0.20.1](hugr-v0.20.0...hugr-v0.20.1) - 2025-06-03 ### Bug Fixes - Dataflow analysis produces unsound results on Hugrs with entrypoint ([#2255](#2255)) - check well-definedness of DFG wires in validate ([#2221](#2221)) - Check for order edges in SiblingSubgraph::from_node ([#2223](#2223)) - Make SumType::Unit(N) equal to SumType::General([(); N]) ([#2250](#2250)) - canonicalize_nodes sometimes mangles the entrypoint ([#2263](#2263)) ### New Features - LocalizeEdges pass ([#2237](#2237)) - Add PersistentHugr ([#2080](#2080)) - Add `Type::used_extensions` ([#2224](#2224)) - Add boundary edge traversal in SimpleReplacement ([#2231](#2231)) - Add signature map function for DFGs ([#2239](#2239)) - PersistentHugr implements HugrView ([#2202](#2202)) - PersistentHugr Walker API ([#2168](#2168)) - Hugr::store_with_exts and auto-include in serde_as ([#2280](#2280)) ### Refactor - tidies/readability improvements to PersistentHugr ([#2251](#2251)) - Deprecate ValidationError::ExtensionError ([#2281](#2281)) ### Testing - Ignore miri errors in tests involving `assert_snapshot` ([#2261](#2261)) </blockquote> ## `hugr-cli` <blockquote> ## [0.20.1](hugr-cli-v0.20.0...hugr-cli-v0.20.1) - 2025-06-03 ### New Features - support external subcommands via PATH ([#1343](#1343)) ([#2278](#2278)) </blockquote> </details> --- This PR was generated with [release-plz](https://github.com/release-plz/release-plz/).

lmondada requested a review from a team as a code owner May 7, 2025 18:46

lmondada requested review from cqc-alec and removed request for a team May 7, 2025 18:46

lmondada marked this pull request as draft May 7, 2025 18:46

lmondada removed the request for review from cqc-alec May 7, 2025 18:46

Squashed commit of feat/persistenthugr changes

cb812be

lmondada force-pushed the feat/persistenthugr branch from a7729f3 to cb812be Compare May 8, 2025 07:05

Merge branch 'main' into feat/persistenthugr

1ab5ea7

lmondada force-pushed the feat/persistentwalker branch 2 times, most recently from fd0c21f to 3b27b4d Compare May 10, 2025 15:51

lmondada marked this pull request as ready for review May 10, 2025 15:52

lmondada force-pushed the feat/persistentwalker branch 2 times, most recently from 2206368 to b81ed94 Compare May 10, 2025 16:07

lmondada force-pushed the feat/persistentwalker branch 2 times, most recently from 782e1ba to ca5d841 Compare May 10, 2025 21:43

lmondada added 3 commits May 12, 2025 10:42

Merge branch 'main' into feat/persistenthugr

6723c28

Merge branch 'main' into feat/persistenthugr

1771404

feat: PersistentHugr implements HugrView

7cd4af7

lmondada force-pushed the feat/persistentwalker branch from ca5d841 to 7874237 Compare May 12, 2025 14:37

lmondada changed the base branch from feat/persistenthugr to luca/persistent-impl-hugrview May 12, 2025 14:43

lmondada force-pushed the feat/persistentwalker branch from 7874237 to b1685fd Compare May 12, 2025 14:44

lmondada requested a review from acl-cqc May 12, 2025 14:45

lmondada added 2 commits May 12, 2025 18:06

cargo fmt

d04d1f6

test coverage ↗️

08e3eb0

lmondada force-pushed the feat/persistentwalker branch from b1685fd to 654c4fc Compare May 12, 2025 16:37

feat: PersistentHugr Walker API

b4bae59

lmondada force-pushed the feat/persistentwalker branch from 654c4fc to b4bae59 Compare May 12, 2025 16:43

acl-cqc reviewed May 13, 2025

View reviewed changes

feat: PersistentHugr implements HugrView

7cd85d7

lmondada force-pushed the luca/persistent-impl-hugrview branch from 08e3eb0 to 7cd85d7 Compare May 19, 2025 11:14

lmondada added 6 commits May 20, 2025 10:28

make functions fallible

52e722b

Merge branch 'luca/add-bd-traversal-simple-repl' into luca/persistent…

3136e17

…-impl-hugrview

Merge branch 'main' into luca/persistent-impl-hugrview

4e55567

Merge branch 'luca/persistent-impl-hugrview' into feat/persistentwalker

728d914

simplify equivalent_descendant_ports

6c102ee

fix test and compilation error

fc0aa0c

lmondada requested a review from acl-cqc May 21, 2025 07:30

fix outdated doc hyperlinks

1e2e05e

Base automatically changed from luca/persistent-impl-hugrview to main May 22, 2025 14:34

Merge branch 'main' into feat/persistentwalker

cd0a1eb

acl-cqc approved these changes May 23, 2025

View reviewed changes

acl-cqc mentioned this pull request May 23, 2025

refactor: tidies/readability improvements to PersistentHugr #2251

Merged

more exports

0cff934

address final comments

3b0df60

lmondada requested a review from a team as a code owner May 29, 2025 10:53

lmondada requested a review from mark-koch May 29, 2025 10:53

Merge branch 'main' into feat/persistentwalker

20958fe

lmondada enabled auto-merge May 29, 2025 10:55

lmondada removed the request for review from mark-koch May 29, 2025 10:55

lmondada added this pull request to the merge queue May 29, 2025

Merged via the queue into main with commit 157c44e May 29, 2025
27 checks passed

lmondada deleted the feat/persistentwalker branch May 29, 2025 11:02

This was referenced May 28, 2025

chore: release v0.21.0 #2220

Closed

chore: release v0.21.0 #2271

Closed

chore: release v0.20.1 #2273

Merged

feat: PersistentHugr Walker API #2168

feat: PersistentHugr Walker API #2168

Uh oh!

Conversation

lmondada commented May 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented May 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

lmondada commented May 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

acl-cqc left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

acl-cqc left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

lmondada commented May 7, 2025 •

edited

Loading

codecov bot commented May 7, 2025 •

edited

Loading

lmondada commented May 10, 2025 •

edited

Loading