feat(py): `ComposablePass` protocol and `ComposedPass` for hugr-py #2636

CalMacCQ · 2025-10-27T11:00:32Z

Mostly follows Agustin's suggestion see eeb4c50

I'm also added some to/from_dict methods as well as a supported_ops property. EDIT: removed these additional methods for now.

BEGIN_COMMIT_OVERRIDE

feat: ComposablePass protocol and ComposedPass for hugr-py (unstable) (#2636)

END_COMMIT_OVERRIDE

aborgna-q · 2025-10-27T11:04:08Z

hugr-py/src/hugr/hugr/pass.py

+    @classmethod
+    def from_dict(cls, dictionary: dict) -> Self: ...
+
+    def to_dict(self) -> dict: ...


We won't support encoding/decoding every pass, as some may have non encodable context.

Should we do a best effort to_dict encoding, and signal when the result is not complete? (so handlers downstream can get some partial info about it), or outright error-out if not supported?

For the from_dict implementation, we'll need some kind of pass registry that knows a set of passes it can decode. We can think about that later.

What would be an example of a pass with a non-encodable context? A user defined pass where the user passes a function into the builder?

Also do you think I should remove the to/from_dict for now? Not sure pass serialisation belongs in the initial work for Guppy optimisation.

We should add it at some point for nexus integration though I think.

Yeah, I think it needs more design discussion.

I'm also guessing that we'd want to return a dataclass rather than an arbitrary dict, to keep some structure...

Yes, good point. I'll remove it for now.

codecov · 2025-10-27T11:46:22Z

Codecov Report

❌ Patch coverage is 54.16667% with 11 lines in your changes missing coverage. Please review.
✅ Project coverage is 83.38%. Comparing base (5e354b9) to head (01b7126).
⚠️ Report is 4 commits behind head on main.

Files with missing lines	Patch %	Lines
hugr-py/src/hugr/passes/composable_pass.py	54.16%	11 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2636      +/-   ##
==========================================
- Coverage   83.46%   83.38%   -0.08%     
==========================================
  Files         262      261       -1     
  Lines       51297    50562     -735     
  Branches    46858    46033     -825     
==========================================
- Hits        42813    42160     -653     
+ Misses       6105     6055      -50     
+ Partials     2379     2347      -32

Flag	Coverage Δ
python	`91.32% <54.16%> (-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.

CalMacCQ · 2025-10-27T11:58:00Z

After chatting to Alec it may be worth removing the supported_ops property. In TKET1 having a similar property for supported gates causes issues when we compose passes with mismatching GateSetPredicates. Its been a bit of a maintence headache. What do you think @aborgna-q?

aborgna-q · 2025-10-27T13:09:40Z

it may be worth removing the supported_ops property

Makes sense. Passes are more generic here than just rewrites over specific sets of gates, so fixing a closed set of optypes here seems counter-productive.

CalMacCQ · 2025-10-27T13:20:51Z

Using typing_extensions rather than typing as the Self type was introduced in Python 3.11 and we still support 3.10.

CalMacCQ · 2025-10-27T13:54:43Z

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

 """The main HUGR structure."""

 from .base import Hugr, NodeData
+from .composable_pass import ComposablePass


Open to better suggestions for this module name. I opted to not use pass.py as pass is a keyword in Python.

LGTM
Though maybe I'd move it out of hugr.hugr, and into its own thing?
hugr.passes.ComposablePass?

CalMacCQ · 2025-11-12T16:03:22Z

C.I. failure to do with coverage checks or something?

hugr-py/src/hugr/passes/composable_pass.py

aborgna-q · 2025-11-12T16:33:46Z

hugr-py/src/hugr/passes/composable_pass.py

C.I. failure to do with coverage checks or something?

Yeah, it's complaining that there are no tests here.

You can see the codecov report linked from the message.

We could add a test with a dummy no-op pass

Done in 01b7126

Some maybe the isinstance checks are not needed. I also made ComposablePass runtime checkable.

Co-authored-by: Agustín Borgna <[email protected]>

aborgna-q

LGTM

aborgna-q · 2025-11-12T17:41:21Z

hugr-py/tests/test_passes.py

+        def then(self, other: ComposablePass) -> ComposablePass:
+            return ComposedPass([self, other])
+


Let it use the default implementation (we want to test that rather than test code)

Suggested change

def then(self, other: ComposablePass) -> ComposablePass:

return ComposedPass([self, other])

This suggestion wasn't implemented?

🤖 I have created a release *beep* *boop* --- ## [0.14.2](hugr-py-v0.14.1...hugr-py-v0.14.2) (2025-11-13) ### Features * **cli, python:** programmatic interface to cli with python bindings ([#2677](#2677)) ([0fd0332](0fd0332)) * ComposablePass protocol and ComposedPass for hugr-py (unstable) ([[#2636](https://github.com/CQCL/hugr/issues/2636)](https://github.com/CQCL/hugr/pull/2636)) ([45dc3fc](45dc3fc)) * return description output to python on error ([#2681](#2681)) ([f483146](f483146)) * track package descriptions when loading ([#2639](#2639)) ([349dd61](349dd61)) ### Documentation * Fix typo in docstring. ([#2656](#2656)) ([a1ce622](a1ce622)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). --------- Co-authored-by: Seyon Sivarajah <[email protected]>

Suggestion missing from #2636, makes sure we test the actual implementation rather than the dummy one. drive-by: Improve `name` impl for ComposedPass

CalMacCQ added 3 commits October 27, 2025 10:46

Agustin's suggested Protocol class

eeb4c50

minor fixes

c5cf1d7

more methods

8a3d6ba

CalMacCQ requested a review from a team as a code owner October 27, 2025 11:00

CalMacCQ requested a review from croyzor October 27, 2025 11:00

CalMacCQ marked this pull request as draft October 27, 2025 11:00

aborgna-q reviewed Oct 27, 2025

View reviewed changes

CalMacCQ added 3 commits October 27, 2025 11:33

import Self from typing_extensions

7b58c05

Merge branch 'main' into cm/composable_pass

33e325b

fix import

5e31a3d

CalMacCQ marked this pull request as ready for review October 27, 2025 11:48

CalMacCQ added 2 commits October 27, 2025 13:17

remove to_dict and from_dict methods as well as supported Ops

c52de85

remove unused import

6d7afc2

CalMacCQ changed the title ~~feat: a ComposablePass protocol for hugr-py~~ feat(py): a ComposablePass protocol for hugr-py Oct 27, 2025

CalMacCQ added 3 commits October 27, 2025 13:26

node -> entrypoint

89fabf0

Merge branch 'main' into cm/composable_pass

91879cd

rename and update __init__.py

4878d5f

CalMacCQ commented Oct 27, 2025

View reviewed changes

CalMacCQ requested a review from ss2165 October 27, 2025 14:04

CalMacCQ added 2 commits October 27, 2025 14:30

Merge branch 'main' into cm/composable_pass

7045270

Merge branch 'main' into cm/composable_pass

d20aaaa

CalMacCQ requested a review from aborgna-q October 28, 2025 09:50

CalMacCQ added 4 commits October 28, 2025 10:26

make a passes module

954730f

move passes into hugr root

448b5cf

remove from build

17d1dc8

add __init__.py for passes

b6fa9a5

CalMacCQ added 7 commits November 12, 2025 15:19

fix default impl

f139d7c

fixup then impl

df0ab15

fixup mypy and ruff

ac63dd5

yet another fix

9a157b8

more ruff nonsense

3db5bdd

rm self

67d7d38

fixes

975ddbb

CalMacCQ requested a review from aborgna-q November 12, 2025 16:02

CalMacCQ enabled auto-merge November 12, 2025 16:07

CalMacCQ removed request for acl-cqc, croyzor and ss2165 November 12, 2025 16:07

aborgna-q reviewed Nov 12, 2025

View reviewed changes

CalMacCQ and others added 4 commits November 12, 2025 16:35

Update hugr-py/src/hugr/passes/composable_pass.py

0165ae7

Co-authored-by: Agustín Borgna <[email protected]>

fmt

2def5fc

make name a property

9673dc2

add a dummy test

01b7126

CalMacCQ requested a review from aborgna-q November 12, 2025 17:26

aborgna-q approved these changes Nov 12, 2025

View reviewed changes

CalMacCQ added this pull request to the merge queue Nov 12, 2025

Merged via the queue into main with commit 45dc3fc Nov 12, 2025
28 of 29 checks passed

CalMacCQ deleted the cm/composable_pass branch November 12, 2025 17:46

hugrbot mentioned this pull request Nov 12, 2025

chore(main): release hugr-py 0.14.2 #2657

Merged

aborgna-q mentioned this pull request Nov 17, 2025

test: Improve ComposablePass tests #2688

Merged

acl-cqc mentioned this pull request Nov 18, 2025

hugr-py: regions in ComposablePass #2696

Open

github-merge-queue bot pushed a commit that referenced this pull request Nov 18, 2025

test: Improve ComposablePass tests (#2688)

775fbd9

Suggestion missing from #2636, makes sure we test the actual implementation rather than the dummy one. drive-by: Improve `name` impl for ComposedPass

aborgna-q added a commit that referenced this pull request Nov 24, 2025

test: Improve ComposablePass tests (#2688)

bd90c75

Suggestion missing from #2636, makes sure we test the actual implementation rather than the dummy one. drive-by: Improve `name` impl for ComposedPass

		def then(self, other: ComposablePass) -> ComposablePass:
		return ComposedPass([self, other])

feat(py): ComposablePass protocol and ComposedPass for hugr-py #2636

feat(py): ComposablePass protocol and ComposedPass for hugr-py #2636

Uh oh!

Conversation

CalMacCQ commented Oct 27, 2025 • edited by aborgna-q Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

CalMacCQ Oct 27, 2025 • 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!

CalMacCQ Oct 27, 2025 • 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

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

Uh oh!

Codecov Report

Uh oh!

CalMacCQ commented Oct 27, 2025

Uh oh!

aborgna-q commented Oct 27, 2025

Uh oh!

CalMacCQ commented Oct 27, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

CalMacCQ commented Nov 12, 2025

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

aborgna-q left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

feat(py): `ComposablePass` protocol and `ComposedPass` for hugr-py #2636

feat(py): `ComposablePass` protocol and `ComposedPass` for hugr-py #2636

CalMacCQ commented Oct 27, 2025 •

edited by aborgna-q

Loading

CalMacCQ Oct 27, 2025 •

edited

Loading

CalMacCQ Oct 27, 2025 •

edited

Loading

codecov bot commented Oct 27, 2025 •

edited

Loading