feat: update passes to use PassScope where non-breaking by acl-cqc · Pull Request #2836 · Quantinuum/hugr

acl-cqc · 2026-01-23T17:45:31Z

Follow-up to #2772 with non-breaking updates to ConstFoldPass, DeadCodeElimPass, NormalizeCFGsPass, RedundantOrderEdgesPass, RemoveDeadFuncsPass, ReplaceTypes, UntuplePass. (Breaking updates to follow in #2871.)

Generally this means keeping pre-existing pass configurating methods but deprecating, and storing such config in an Either<PassScope, old-config>, so we can drop the old config in time.

Also deprecated toplevel functions constant_fold_pass, remove_dead_funcs and monomorphize.

codecov · 2026-01-23T17:50:12Z

Codecov Report

❌ Patch coverage is 80.16194% with 49 lines in your changes missing coverage. Please review.
✅ Project coverage is 83.78%. Comparing base (dc94210) to head (79641a5).
⚠️ Report is 8 commits behind head on main.

Files with missing lines	Patch %	Lines
hugr-passes/src/untuple.rs	72.58%	16 Missing and 1 partial ⚠️
hugr-passes/src/normalize_cfgs.rs	44.44%	14 Missing and 1 partial ⚠️
hugr-passes/src/monomorphize.rs	77.77%	1 Missing and 3 partials ⚠️
hugr-passes/src/replace_types.rs	66.66%	4 Missing ⚠️
hugr-passes/src/dead_funcs.rs	96.00%	3 Missing ⚠️
hugr-passes/src/composable.rs	66.66%	2 Missing ⚠️
hugr-passes/src/const_fold.rs	91.66%	1 Missing and 1 partial ⚠️
hugr-passes/src/dead_code.rs	88.23%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2836      +/-   ##
==========================================
- Coverage   83.83%   83.78%   -0.05%     
==========================================
  Files         269      269              
  Lines       54021    54206     +185     
  Branches    47974    48159     +185     
==========================================
+ Hits        45286    45414     +128     
- Misses       6320     6378      +58     
+ Partials     2415     2414       -1

Flag	Coverage Δ
python	`88.65% <ø> (ø)`
rust	`83.16% <80.16%> (-0.06%)`	⬇️

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.

This reverts commit 89088135b6ccfd1fad058f6011aa45dc53ece95a.

…nor ::recursive

… behaviour

hugr-passes/src/untuple.rs

aborgna-q · 2026-03-06T11:08:53Z

hugr-passes/src/untuple.rs

+    /// Create a new untuple pass with the given configuration
+    #[must_use]
+    pub fn new_scoped(scope: PassScope) -> Self {
+        Self {
+            scope: Either::Left(scope),
        }
    }


Do we need this? It's the same as
UntuplePass::default().with_scope(...)

Yeah, indeed. I think it's "nice" to have everywhere, but maybe inconsistent to have it here and not everywhere else. I'll remove it here?

hugr-passes/src/untuple.rs

hugr-passes/src/normalize_cfgs.rs

aborgna-q · 2026-03-06T11:31:47Z

hugr-passes/src/replace_types.rs

+    /// Sets the scope within which the pass will operate. Note that this pass respects
+    /// neither [PassScope::preserve_interface] nor [PassScope::recursive] as the former
+    /// would be contrary to the goals of the pass and non-recursion generally leads to
+    /// invalid Hugrs. Hence, really only the [PassScope::root] affects the pass.


This makes sense, but does it mean we need to adjust the PassScope definition somehow?

PassScope specifically says recursive==False is only a hint (recursive==True is a requirement, and we do that). So I think we're ok (within bounds of the contract), and it's merely good practice to note what we do here.

preserve_interface does mention that it only really applies to optimization passes I think, and this is not one. Have a look, perhaps it's not strong enough?

Yes, for recursive I see no issue.

preserve_interface is a bit iffy, but I think it works if it's only for optimizations.
I'd add a note in the scope definitions making that explicit.

See here:

hugr/hugr-passes/src/composable/scope.rs

Lines 54 to 59 in d657835

/// Run the pass on the whole Hugr, regardless of the entrypoint.

///

/// For lowering passes, signature changes etc. should be applied across the hugr.

///

/// For optimization passes, the inner [Preserve] details which parts must

/// have their interface preserved.

But I'll add a couple more notes

hugr-passes/src/dead_funcs.rs

Co-authored-by: Agustín Borgna <121866228+aborgna-q@users.noreply.github.com>

acl-cqc · 2026-03-06T12:57:03Z

hugr-passes/src/composable.rs


    use super::{ComposablePass, IfThen, ValidatePassError, ValidatingPass, validate_if_test};

+    pub(crate) fn run_validating<P: ComposablePass<H>, H: HugrMut>(


I mean, this could be outside test, even public; it's a simple-enough utility function

aborgna-q · 2026-03-06T13:16:21Z

hugr-passes/src/lib.rs

Suggested change

#[expect(deprecated)]

pub use monomorphize::{MonomorphizePass, mangle_name, monomorphize};

## 🤖 New release * `hugr-model`: 0.25.6 -> 0.25.7 (✓ API compatible changes) * `hugr-core`: 0.25.6 -> 0.25.7 (✓ API compatible changes) * `hugr-llvm`: 0.25.6 -> 0.25.7 (✓ API compatible changes) * `hugr-passes`: 0.25.6 -> 0.25.7 (✓ API compatible changes) * `hugr-persistent`: 0.4.6 -> 0.4.7 (✓ API compatible changes) * `hugr`: 0.25.6 -> 0.25.7 (✓ API compatible changes) * `hugr-cli`: 0.25.6 -> 0.25.7 (✓ API compatible changes) <details><summary>Changelog</summary> ## `hugr-model` <blockquote> ## [0.25.6](hugr-model-v0.25.5...hugr-model-v0.25.6) - 2026-02-20 ### New Features - Remove size limitation for binary envelopes ([#2880](#2880)) </blockquote> ## `hugr-core` <blockquote> ## [0.25.7](hugr-core-v0.25.6...hugr-core-v0.25.7) - 2026-03-06 ### Documentation - added examples in docs srtring ([#2920](#2920)) </blockquote> ## `hugr-llvm` <blockquote> ## [0.25.6](hugr-llvm-v0.25.5...hugr-llvm-v0.25.6) - 2026-02-20 ### New Features - Add error context when lowering hugrs to LLVM ([#2869](#2869)) </blockquote> ## `hugr-passes` <blockquote> ## [0.25.7](hugr-passes-v0.25.6...hugr-passes-v0.25.7) - 2026-03-06 ### Documentation - added examples in docs srtring ([#2920](#2920)) ### New Features - Define pass application scopes ([#2772](#2772)) - Modify dead code elimination pass to remove unreachable basic blocks ([#2884](#2884)) - Add non-generic `with_scope` method for composable passes ([#2910](#2910)) - update passes to use PassScope where non-breaking ([#2836](#2836)) </blockquote> ## `hugr-persistent` <blockquote> ## [0.4.0](hugr-persistent-v0.3.4...hugr-persistent-v0.4.0) - 2025-12-22 ### New Features - [**breaking**] Remove `RootCheckable` ([#2704](#2704)) - [**breaking**] Bump MSRV to Rust 1.89 ([#2747](#2747)) - [**breaking**] Type-safe access for node metadata ([#2755](#2755)) ### Refactor - [**breaking**] Remove multiple deprecated definitions ([#2751](#2751)) </blockquote> ## `hugr` <blockquote> ## [0.25.7](hugr-v0.25.6...hugr-v0.25.7) - 2026-03-06 ### Documentation - added examples in docs srtring ([#2920](#2920)) ### New Features - Define pass application scopes ([#2772](#2772)) - Modify dead code elimination pass to remove unreachable basic blocks ([#2884](#2884)) - Add non-generic `with_scope` method for composable passes ([#2910](#2910)) - update passes to use PassScope where non-breaking ([#2836](#2836)) </blockquote> ## `hugr-cli` <blockquote> ## [0.25.6](hugr-cli-v0.25.5...hugr-cli-v0.25.6) - 2026-02-20 ### New Features - Add s expression format to envelope formats ([#2864](#2864)) </blockquote> </details> --- This PR was generated with [release-plz](https://github.com/release-plz/release-plz/).

…_scope (#2871) Following #2836, the remaining passes, where breakage was inevitable - mostly passes that were an empty struct (without any previous config). Non-local-edges stuff needed some API changes where I did some deprecation, but we could just break. RedundantOrderEdgesPass I've removed the old config methods - we should perhaps deprecate first, but some breakage seems inevitable as the empty struct derived Copy. LocalizeEdges I've deprecated+moved top-level `ensure_no_nonlocal_edges` into a struct method `check_no_nonlocal_edges`, as IIUC it's used, but I've removed top-level `nonlocal_edges` altogether, it doesn't seem to be used. Also remove the default impl for `ComposablePass::with_scope_internal`, to check we got 'em all. BREAKING CHANGE: InlineDFGsPass, LocalizeEdgesPass, MonomorphizePass, RedundantOrderEdgesPass must be constructed via ::default(); remove RedundantOrderEdgesPass::recursive and don't derive Copy; ComposablePass::with_scope_internal requires impl; remove toplevel `fn nonlocal_edges`

Adds support for `PassScope`s in the pass definitions. See Quantinuum/hugr#2772. ~Requires a hugr release with the `PassScope` definition and Quantinuum/hugr#2910 ~Many of these also call other passes from `hugr_passes`. While we pass the scope config along, proper support requires Quantinuum/hugr#2836 and Quantinuum/hugr#2871 This is a rust-only change, the python interface will follow up. BREAKING CHANGE: Multiple unit-like pass structs must now be constructed using a `::default()` call instead. BREAKING CHANGE: `QSystemPass` is now a `ComposablePass`. Import the trait to call `run`. BREAKING CHANGE: `QSystemPass` no longer implements `Copy`. BREAKING CHANGE: Renamed `tket_qsystem::extension::qsystem::lower_tket_op` to `lower_tket_ops`.

aborgna-q and others added 8 commits December 19, 2025 16:38

feat: Define pass application scopes

1f05f19

Stub implementation for all passes

aba6477

Python definition for PassScope

3e0c6ac

Add default with_scope impl, make this non-breaking

02d2886

Move scope to a submodule of ::composable

e3a63b4

wip

0b730bf

All=>Preserve (make global), add PreserveEntrypoint, enum InScope

e71125c

docs, re-export InScope

11a643e

acl-cqc changed the title ~~WIP: update passes to use PassScope following #2772~~ WIP: update passes to use PassScope Jan 23, 2026

acl-cqc force-pushed the acl/pass-scopes branch 2 times, most recently from 05cf563 to dfe5791 Compare February 11, 2026 15:18

acl-cqc changed the title ~~WIP: update passes to use PassScope~~ feat: update passes to use PassScope where non-breaking Feb 11, 2026

acl-cqc mentioned this pull request Feb 11, 2026

feat!: Update remainder of passes to use PassScope, drop default with_scope #2871

Merged

acl-cqc force-pushed the acl/pass-scopes branch from dfe5791 to aa264fc Compare February 11, 2026 15:26

acl-cqc requested a review from aborgna-q February 11, 2026 15:27

acl-cqc added 9 commits February 11, 2026 15:30

(experimental) Add Scoped...breaking

62bd044

Revert "(experimental) Add Scoped...breaking"

ce4c551

This reverts commit 89088135b6ccfd1fad058f6011aa45dc53ece95a.

Update Dead Function Removal

293ef0f

Update UntuplePass

075e2b6

ReplaceTypes....ok if we don't respect PassScope::preserve_interface …

236c08c

…nor ::recursive

feat: normalize_cfgs (use Either for explicit CFG list)

b16b72a

feat: add PassScope to DeadCodeElim (alongside entry_points)

84b33c7

feat: ConstFold (add Scope alongside inputs)

d7eca10

Add PassScope::from_entrypoint

51bfb59

acl-cqc force-pushed the acl/pass-scopes branch from aa264fc to d7eca10 Compare February 11, 2026 15:32

acl-cqc added 4 commits February 11, 2026 15:57

clippy

3e6997c

docs, and deprecation note

b9cac77

DCE: Skip first descendant

f22c27e

ConstFold/DCE store Option<PassScope> allowing old entrypoint-subtree…

81f2cac

… behaviour

acl-cqc marked this pull request as ready for review March 5, 2026 17:47

acl-cqc requested a review from a team as a code owner March 5, 2026 17:47

aborgna-q approved these changes Mar 6, 2026

View reviewed changes

acl-cqc mentioned this pull request Mar 6, 2026

feat!: Make WithScope a supertrait of ComposablePass #2921

Merged

acl-cqc and others added 4 commits March 6, 2026 12:19

Specify since="0.25.7" on deprecations

89a5a17

Co-authored-by: Agustín Borgna <121866228+aborgna-q@users.noreply.github.com>

fmt those deprecated's

3dd5187

remove_dead_funcs_scoped

1866af0

Deprecate monomorphize; add run_validating inside test

4bb84f8

acl-cqc commented Mar 6, 2026

View reviewed changes

extend dead_code comment

7a03521

acl-cqc requested a review from aborgna-q March 6, 2026 12:59

acl-cqc added this to the hugr-rs 0.25.X milestone Mar 6, 2026

acl-cqc mentioned this pull request Mar 6, 2026

Clean up deprecated pass APIs #2923

Closed

aborgna-q approved these changes Mar 6, 2026

View reviewed changes

acl-cqc added 5 commits March 6, 2026 13:52

Comments re. ReplaceTypes

1e2b9d5

Avoid calling monomorphize;extend/expect deprecation

e3c9eee

Ooops, fix semicolon + fmt

c8c6e76

Remove UntuplePass::new_scoped

82cfd0e

update docs with_scope*_internal*

79641a5

acl-cqc enabled auto-merge March 6, 2026 16:54

acl-cqc added this pull request to the merge queue Mar 6, 2026

Merged via the queue into main with commit c774c48 Mar 6, 2026
31 checks passed

acl-cqc deleted the acl/pass-scopes branch March 6, 2026 17:01

hugrbot mentioned this pull request Mar 6, 2026

chore: release #2909

Merged

acl-cqc mentioned this pull request Mar 6, 2026

feat: update hugr-passes to use visibility #2418

Closed

hugrbot mentioned this pull request Mar 9, 2026

chore: release #2926

Merged

	/// Run the pass on the whole Hugr, regardless of the entrypoint.
	///
	/// For lowering passes, signature changes etc. should be applied across the hugr.
	///
	/// For optimization passes, the inner [Preserve] details which parts must
	/// have their interface preserved.


		use super::{ComposablePass, IfThen, ValidatePassError, ValidatingPass, validate_if_test};

		pub(crate) fn run_validating<P: ComposablePass<H>, H: HugrMut>(


	#[expect(deprecated)]
	pub use monomorphize::{MonomorphizePass, mangle_name, monomorphize};

Conversation

acl-cqc commented Jan 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Jan 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

aborgna-q Mar 6, 2026

Choose a reason for hiding this comment

Uh oh!

acl-cqc Mar 6, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

aborgna-q Mar 6, 2026

Choose a reason for hiding this comment

Uh oh!

acl-cqc Mar 6, 2026

Choose a reason for hiding this comment

Uh oh!

aborgna-q Mar 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

acl-cqc Mar 6, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

acl-cqc Mar 6, 2026

Choose a reason for hiding this comment

Uh oh!

aborgna-q Mar 6, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

acl-cqc commented Jan 23, 2026 •

edited

Loading

codecov bot commented Jan 23, 2026 •

edited

Loading

aborgna-q Mar 6, 2026 •

edited

Loading