feat: add qsystem op for measure leaked #1057

narmlu · 2025-06-25T19:38:45Z

Closes: #1056

Depends on:

tests/integration/test_qsystem.py

guppylang/std/qsystem/__init__.py

codecov-commenter · 2025-07-03T17:03:47Z

Codecov Report

Attention: Patch coverage is 70.00000% with 9 lines in your changes missing coverage. Please review.

Project coverage is 92.31%. Comparing base (eee77ae) to head (8ff7e20).

Files with missing lines	Patch %	Lines
guppylang/std/qsystem/__init__.py	70.00%	9 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1057      +/-   ##
==========================================
- Coverage   92.37%   92.31%   -0.07%     
==========================================
  Files         112      112              
  Lines       10818    10848      +30     
==========================================
+ Hits         9993    10014      +21     
- Misses        825      834       +9

☔ 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.

narmlu · 2025-07-03T18:37:41Z

Everything seems to be working. The MaybeLeaked wrapper struct around the _measurement: Future[int] value has three funcs:

is_leaked() calls future's .copy().read() (i.e., does not consume it)
to_result() calls .read() (consumes it)
discard() to consume the future, which needs to be called if to_result() was never called because it was leaked.

I'm not sure that we can omit discard, because I don't think that is_leaked should consume _measurement. Concrete example is in test_qsystem.

narmlu · 2025-07-03T18:50:22Z

guppylang/std/_internal/compiler/futures.py

These are Marks changes in #1075. I'm happy to rebase to that branch if you want, but I'm inclined to just wait until that's merged.

qartik · 2025-07-03T22:08:26Z

tests/integration/test_qsystem.py

+                q = qubit()
+                m = measure(q)
+                return m


What's the intention of this code pattern?

This doesn't represent a "real" pattern. It is intended to make sure that things type check and that the variable q was properly consumed when measure_leaked(q) was called.

Might be nice to document that. Or remove it.

mark-koch

Looks good, but we should wait to merge until #1075 is merged

I'm not sure that we can omit discard, because I don't think that is_leaked should consume _measurement. Concrete example is in test_qsystem.

I think discard is nice to have 👍

mark-koch · 2025-07-04T08:45:03Z

guppylang/std/qsystem/__init__.py

+
+@guppy
+@no_type_check
+def measure_leaked(q: qubit @ owned) -> "MaybeLeaked":


Could you add a dosctring here?

mark-koch · 2025-07-04T08:46:13Z

guppylang/std/qsystem/__init__.py

+    @guppy
+    @no_type_check
+    def to_result(self: "MaybeLeaked @ owned") -> Option[bool]:
+        """Get the measurement result if not leaked."""


Maybe something like this would be more accurate?

Suggested change

"""Get the measurement result if not leaked."""

"""Returns the measurement result or `nothing` if leaked."""

narmlu · 2025-07-07T13:32:21Z

@mark-koch - it looks like #1075 was merged. Anything else we should wait on for this one?

mark-koch · 2025-07-07T14:27:48Z

pyproject.toml

 # Uncomment these to test the latest dependency version during development
 # hugr = { git = "https://github.com/CQCL/hugr", subdirectory = "hugr-py", tag = "hugr-v0.20.2" }
-# tket2-exts = { git = "https://github.com/CQCL/tket2", subdirectory = "tket2-exts", rev = "652a7d0" }
+tket2-exts = { git = "https://github.com/CQCL/tket2", subdirectory = "tket2-exts", rev = "38d1c6f" }


Is this rev dependency still needed? If yes we should wait for a tket-exts release before merging

Yes, good catch, we can wait until then (corresponding tket2 release PR CQCL/tket2#952)

I think this is the one you need: CQCL/tket2#951

Ah yes, exts. Got it, thanks.

now released

Bumped exts to the new release. Will merge when you remove wait to merge in case there are any other gotchas :).

the only concern is selene support, @jake-arkinstall thoughts on merging?

From @jake-arkinstall in teams:

I have no concerns, merge away. It won’t work with Selene and it’ll link error if used, but it won’t break existing usage (if it isn’t used it isn’t emitted). Selene can play catch up next week.

@ss2165 - I think this is ready to merge. I'll do so tomorrow morning (Colorado time) unless you tell me otherwise.

@Custom

🤖 I have created a release *beep* *boop* --- ## [0.21.0](guppylang-v0.20.0...guppylang-v0.21.0) (2025-08-04) ### ⚠ BREAKING CHANGES * All compiler-internal and non-userfacing functionality is moved into a new `guppylang_internals` package * `guppy.compile(foo)` and `guppy.check(foo)` replaced with `foo.check()` and `foo.compile()` * default HUGR output uses compressed binary encoding. * `guppylang.tracing.object.GuppyDefinition` moved to `guppylang.defs.GuppyDefinition` `guppylang.tracing.object.TypeVarGuppyDefinition` moved and renamed to `guppylang.defs.GuppyTypeVarDefinition` * All `to_hugr` methods on types, arguments, and parameters now require a `ToHugrContext` `CompileableDef.compile_outer` now requires a `ToHugrContext` `guppy.hugr_op` now passes the compiler context to the function generating the op `CheckedFunctionDef` now implements `MonomorphizableDef` instead of `CompileableDef` `CompilerContext.build_compiled_def` now requires an instantiation for the definition's type parameters The `ToHugrContext` protocol now requires two additional methods: `type_var_to_hugr` and `const_var_to_hugr` `CompilerContext.{compiled, worklist}` and `CompilationEngine.compiled` are now indexed by a tuple of `DefId` and optional `PartiallyMonomorphizedArgs` * comptime code that previously used constant integers outside i64 will now fail to compile. * Capturing closures are now disabled by default. Enabling them requires calling `guppylang.enable_experimental_features()`, however note that they are not supported throughout the stack. ### Features * Add `Future` type ([#1075](#1075)) ([5ad7673](5ad7673)) * add error when constant integer out of bounds ([#1084](#1084)) ([eee77ae](eee77ae)) * Add guppy version metadata to hugr entrypoint ([#1039](#1039)) ([0eafbd9](0eafbd9)), closes [#1037](#1037) * Add manual registration of extensions ([#1045](#1045)) ([4b42936](4b42936)) * add qsystem op for measure leaked ([#1057](#1057)) ([c555727](c555727)) * add selene via optional feature and use for testing ([#1081](#1081)) ([cefc70e](cefc70e)) * Add support for V and Vdg. ([#1094](#1094)) ([6b0d44a](6b0d44a)) * Allow indexing on tuples ([#1038](#1038)) ([0e9097e](0e9097e)), closes [#711](#711) * Declare WASM modules in guppy ([#942](#942)) ([e1240fb](e1240fb)) * Extend comptime arguments to arbitrary non-linear types ([#1110](#1110)) ([384dd8c](384dd8c)) * Make decorator return types more precise ([#1115](#1115)) ([c84e8b1](c84e8b1)) * set hugr entrypoint to compiled function ([#1063](#1063)) ([16bd267](16bd267)) * store used extensions and versions in HUGR metadata ([#1049](#1049)) ([a9a300c](a9a300c)), closes [#1048](#1048) * Support arbitrary const generics via monomorphisation ([#1033](#1033)) ([bcf9865](bcf9865)) * Support Python 3.12 generic syntax ([#1051](#1051)) ([ab2e118](ab2e118)), closes [#823](#823) * Top level compile + emulate Interface ([#1127](#1127)) ([5e2f595](5e2f595)) * update to hugr-py v0.13 ([#1083](#1083)) ([8f071c8](8f071c8)) * use `core.` prefix for metadata keys ([#1055](#1055)) ([2bf0d68](2bf0d68)) ### Bug Fixes * Allow array comprehension syntax in comptime functions ([#1068](#1068)) ([da8f04a](da8f04a)), closes [#1067](#1067) * Allow struct redefinitions for Python < 3.13 ([#1108](#1108)) ([959a4e4](959a4e4)), closes [#1107](#1107) * Correctly detect `[@Custom](https://github.com/custom)_guppy_decorator` in nested scopes ([#1086](#1086)) ([678583c](678583c)) * Fix diagnostics rendering for comptime entrypoints ([#1099](#1099)) ([fdd2676](fdd2676)), closes [#1097](#1097) * Fix frame lookup for Python 3.12 annotation scopes ([#1120](#1120)) ([a69e489](a69e489)), closes [#1116](#1116) * Fix hugr conversion and bounds checks on numeric literals ([#1100](#1100)) ([73d5e92](73d5e92)) * Fix Jupyter notebook diagnostic rendering ([#1109](#1109)) ([6002474](6002474)) * Fix nested function definitions in Python 3.12 ([#1064](#1064)) ([090f920](090f920)) * Stop showing temporary variables in comptime diagnostics ([#1112](#1112)) ([63854c5](63854c5)), closes [#1111](#1111) * support comptime entrypoint ([#1079](#1079)) ([721e3dd](721e3dd)) * Turn capturing closures into experimental feature ([#1065](#1065)) ([a959b18](a959b18)) ### Documentation * add docstrings for emulator module ([#1131](#1131)) ([b33e065](b33e065)) * add quantum and qsystem gate definitions ([#912](#912)) ([32a4bbc](32a4bbc)) * Fix docstrings ([#1128](#1128)) ([0aded85](0aded85)) * Improve RNG docs ([#1043](#1043)) ([8640f06](8640f06)) * replace `compile_module` usage in README ([#1041](#1041)) ([03ccf3a](03ccf3a)) * Update guppy examples ([#1121](#1121)) ([b994655](b994655)) ### Code Refactoring * Split up into `guppylang_internals` package ([#1126](#1126)) ([81d50c0](81d50c0)) --- 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]>

feat: add qsystem op for measure leaked

605c8d5

narmlu requested a review from a team as a code owner June 25, 2025 19:38

narmlu requested a review from ss2165 June 25, 2025 19:38

fix: ruff format

c5c4c39

narmlu requested a review from akhil-quantum June 25, 2025 19:58

ss2165 reviewed Jun 26, 2025

View reviewed changes

tests/integration/test_qsystem.py Show resolved Hide resolved

guppylang/std/qsystem/__init__.py Outdated Show resolved Hide resolved

narmlu and others added 8 commits June 26, 2025 12:52

fix: test return int

9aa4d5a

update uv.lock with recent tket2-exts changes

6778c5c

feat: Add Future type

c906c22

tweak qsystem test

7dfbb67

Merge branch 'feat/futures' into feat/measure-leaked

05a903a

wip MaybeLeaked

9f374c1

add @guppy

a5cb8c9

wip fix test, still broken though

058e1bf

mark-koch reviewed Jul 3, 2025

View reviewed changes

guppylang/std/qsystem/__init__.py Outdated Show resolved Hide resolved

guppylang/std/qsystem/__init__.py Outdated Show resolved Hide resolved

guppylang/std/qsystem/__init__.py Outdated Show resolved Hide resolved

guppylang/std/qsystem/__init__.py Outdated Show resolved Hide resolved

narmlu added 3 commits July 3, 2025 10:31

fix MaybeLeaked

5ff08b3

fix MaybeLeaked and test

a119f37

fix ruff formats

b8f47c9

narmlu added 3 commits July 3, 2025 11:39

fix: add mypy ignore flags

0c2834c

fix ruff

b4a0ffe

fix precommit issues

fcc05dc

narmlu requested a review from ss2165 July 3, 2025 18:48

narmlu commented Jul 3, 2025

View reviewed changes

narmlu added 2 commits July 3, 2025 14:28

pin tket2-exts to commit 38d1c6f instead of branch

2ea4732

Merge branch 'main' into feat/measure-leaked

fc83207

narmlu removed the request for review from akhil-quantum July 3, 2025 21:38

qartik reviewed Jul 3, 2025

View reviewed changes

ss2165 requested a review from mark-koch July 4, 2025 08:39

ss2165 removed their request for review July 4, 2025 08:39

mark-koch approved these changes Jul 4, 2025

View reviewed changes

mark-koch added the wait to merge This PR to be merged after all dependencies are ready label Jul 4, 2025

narmlu added 2 commits July 7, 2025 07:22

Merge branch 'main' into feat/measure-leaked

46f6dbd

add docstrings

f481c4c

fix qsystem test

769eda7

mark-koch reviewed Jul 7, 2025

View reviewed changes

narmlu added 2 commits July 8, 2025 09:06

remove tket2-exts pin and bump to v0.9.2

4b31cb9

Merge branch 'main' into feat/measure-leaked

8ff7e20

jake-arkinstall mentioned this pull request Jul 14, 2025

feat!: add measure_leaked and bool/uint future results CQCL/selene#25

Merged

narmlu added this pull request to the merge queue Jul 15, 2025

Merged via the queue into main with commit c555727 Jul 15, 2025
4 checks passed

narmlu deleted the feat/measure-leaked branch July 15, 2025 11:41

hugrbot mentioned this pull request Jul 15, 2025

chore(main): release 0.21.0 #1042

Closed

hugrbot mentioned this pull request Aug 4, 2025

chore: release guppylang 0.21.0 #1135

Merged

	"""Get the measurement result if not leaked."""
	"""Returns the measurement result or `nothing` if leaked."""

feat: add qsystem op for measure leaked #1057

feat: add qsystem op for measure leaked #1057

Uh oh!

Conversation

narmlu commented Jun 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

codecov-commenter commented Jul 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

narmlu commented Jul 3, 2025

Uh oh!

narmlu Jul 3, 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mark-koch 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!

narmlu commented Jul 7, 2025

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!

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!

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!

6 participants

narmlu commented Jun 25, 2025 •

edited

Loading

codecov-commenter commented Jul 3, 2025 •

edited

Loading

narmlu Jul 3, 2025 •

edited

Loading