feat: Add python definitions for the TKET metadata keys by aborgna-q · Pull Request #1535 · Quantinuum/tket2

aborgna-q · 2026-04-21T15:25:09Z

We should also add a metadata for inline hints either here or in #1532, whichever gets merged second.

codecov · 2026-04-21T15:28:01Z

Codecov Report

❌ Patch coverage is 69.73684% with 23 lines in your changes missing coverage. Please review.
✅ Project coverage is 84.05%. Comparing base (54998e1) to head (ddb56dd).

Files with missing lines	Patch %	Lines
tket-py/tket/metadata.py	60.34%	23 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1535      +/-   ##
==========================================
- Coverage   84.09%   84.05%   -0.05%     
==========================================
  Files         188      189       +1     
  Lines       29298    29358      +60     
  Branches    28172    28174       +2     
==========================================
+ Hits        24639    24676      +37     
- Misses       3479     3502      +23     
  Partials     1180     1180

Flag	Coverage Δ
python	`90.75% <61.01%> (-1.64%)`	⬇️
qis-compiler	`91.66% <ø> (ø)`
rust	`83.76% <100.00%> (+<0.01%)`	⬆️

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.

acl-cqc

In #1449 I found myself wondering, does this not exist...so yes thank you :-) 👍.

Mostly just naming suggestions, nothing major, looks good!

acl-cqc · 2026-05-12T14:12:31Z

+    KEY = _metadata.CIRCUIT_REWRITE_TRACES
+
+
+class Unitary(Metadata[int]):


Maybe UnitaryFlags? It's definitely not a unitary (i.e. matrix) itself

acl-cqc · 2026-05-12T14:13:17Z

+    KEY = _metadata.INPUT_PARAMETERS
+
+
+class OpGroup(Metadata[str]):


Perhaps PytketOpGroup? And elsewhere in this file for other metadata relating to pytket, but there are some that are not

acl-cqc · 2026-05-12T14:23:12Z

+        return _read_pytket_register(cls.KEY, value)
+
+
+class Phase(Metadata[str]):


PytketPhaseExpr?

acl-cqc · 2026-05-12T14:25:03Z

+    individual_matches: int
+
+
+class MaxQubits(Metadata[int]):


Should this be MaxQubitsHint?

acl-cqc · 2026-05-12T14:25:49Z

+    >>> node.metadata.get(QubitRegisters)
+    [('q', [0]), ('ancilla', [1])]
+"""
+# Changes to this file **MUST** be reflected in `tket/src/metadata.rs`


In the sense that they ought to match, but this doesn't mean that things will break if they don't match, right? Isn't that SHOULD ?

I guess this means that all of my suggested renames should be applied on the rust side too, heh

Changed to a SHOULD. I'll do the renaming on both rust and python (with some aliases for backwards compatibility)

🤖 I have created a release *beep* *boop* --- ## [0.13.1](Quantinuum/tket2@tket-py-v0.13.0...tket-py-v0.13.1) (2026-05-19) ### Features * Add python definitions for the TKET metadata keys ([Quantinuum#1535](Quantinuum#1535)) ([1bfef9a](Quantinuum@1bfef9a)) * Clean Up by Deleting Unconnected Nodes after Modifier Solve ([Quantinuum#1557](Quantinuum#1557)) ([d706867](Quantinuum@d706867)) * expose the QSystemPass to Python ([Quantinuum#1556](Quantinuum#1556)) ([394a610](Quantinuum@394a610)) * InlineFunctionsPass ([Quantinuum#1524](Quantinuum#1524)) ([f40dcef](Quantinuum@f40dcef)) * InlineHint metadata ([Quantinuum#1532](Quantinuum#1532)) ([e7949c2](Quantinuum@e7949c2)) ### Bug Fixes * Apply modifiers through function calls ([Quantinuum#1531](Quantinuum#1531)) ([6a13f0c](Quantinuum@6a13f0c)) * Incorrect matching of pytket parameters to unsupported graph ports ([Quantinuum#1561](Quantinuum#1561)) ([4fc5a25](Quantinuum@4fc5a25)) * Passes with Nested Modifier ([Quantinuum#1546](Quantinuum#1546)) ([bf6df51](Quantinuum@bf6df51)) * Update examples link in README.md ([Quantinuum#1506](Quantinuum#1506)) ([9a25ec8](Quantinuum@9a25ec8)) ### Documentation * Simplify package description. ([Quantinuum#1547](Quantinuum#1547)) ([54e855f](Quantinuum@54e855f)) --- 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: Agustín Borgna <agustin.borgna@quantinuum.com>

## 🤖 New release * `tket`: 0.18.0 -> 0.19.0 (✓ API compatible changes) * `tket-qsystem`: 0.24.0 -> 0.25.0 (✓ API compatible changes) <details><summary>Changelog</summary> ## `tket` <blockquote> ## [0.19.0](Quantinuum/tket2@tket-v0.18.0...tket-v0.19.0) - 2026-05-28 ### Bug Fixes - Apply modifiers through function calls ([Quantinuum#1531](Quantinuum#1531)) - Incorrect matching of pytket parameters to unsupported graph ports ([Quantinuum#1561](Quantinuum#1561)) - [**breaking**] Passes with Nested Modifier ([Quantinuum#1546](Quantinuum#1546)) - bug in hugr building when `control` modifiers are nested ([Quantinuum#1550](Quantinuum#1550)) - Multiple fixes to the pytket encoder ([Quantinuum#1566](Quantinuum#1566)) - [**breaking**] Replace non-deterministic iterations on hash maps ([Quantinuum#1582](Quantinuum#1582)) - Set inputs of functions loaded as values to top during dataflow analysis ([Quantinuum#1595](Quantinuum#1595)) - Using indexes inside dagger modifier ([Quantinuum#1588](Quantinuum#1588)) - address Miri unsoundness by installing nextest and skipping FFI/long running tests ([Quantinuum#1565](Quantinuum#1565)) - skip test_nested_array to resolve miri unsoundness ([Quantinuum#1623](Quantinuum#1623)) ### New Features - *(const-fold)* combine Consts for each out-port; write prepopulated inputs ([Quantinuum#1489](Quantinuum#1489)) - InlineFunctionsPass ([Quantinuum#1524](Quantinuum#1524)) - upgrade to hugr v0.27.1 ([Quantinuum#1568](Quantinuum#1568)) - [**breaking**] Ignore empty circuits when encoding Hugr regions into pytket ([Quantinuum#1562](Quantinuum#1562)) - Add python definitions for the TKET metadata keys ([Quantinuum#1535](Quantinuum#1535)) - Clean Up by Deleting Unconnected Nodes after Modifier Solve ([Quantinuum#1557](Quantinuum#1557)) - InlineHint metadata ([Quantinuum#1532](Quantinuum#1532)) - Allowing control flow in `control` ([Quantinuum#1603](Quantinuum#1603)) ### Performance - Improve modifier resolver pass by visiting nodes in a set ([Quantinuum#1621](Quantinuum#1621)) - Avoid string formatting in Hugr op hashing ([Quantinuum#1624](Quantinuum#1624)) ### Refactor - Replace portgraph toposort in CommandIterator with node vector ([Quantinuum#1608](Quantinuum#1608)) - [**breaking**] Deprecate commands iterator ([Quantinuum#1611](Quantinuum#1611)) ### Testing - Pin guppy version in example files, fix test ([Quantinuum#1534](Quantinuum#1534)) - Skip slow modifier test ([Quantinuum#1587](Quantinuum#1587)) - Add modifier test for subscripted control qubits ([Quantinuum#1601](Quantinuum#1601)) </blockquote> ## `tket-qsystem` <blockquote> ## [0.25.0](Quantinuum/tket2@tket-qsystem-v0.24.0...tket-qsystem-v0.25.0) - 2026-05-28 ### Bug Fixes - Multiple fixes to the pytket encoder ([Quantinuum#1566](Quantinuum#1566)) - [**breaking**] Replace non-deterministic iterations on hash maps ([Quantinuum#1582](Quantinuum#1582)) ### New Features - expose the QSystemPass to Python ([Quantinuum#1556](Quantinuum#1556)) - upgrade to hugr v0.27.1 ([Quantinuum#1568](Quantinuum#1568)) - [**breaking**] Ignore empty circuits when encoding Hugr regions into pytket ([Quantinuum#1562](Quantinuum#1562)) - *(qsystem)* [**breaking**] multiple platform extensions ([Quantinuum#1567](Quantinuum#1567)) ### Refactor - [**breaking**] Deprecate commands iterator ([Quantinuum#1611](Quantinuum#1611)) ### Testing - Pin guppy version in example files, fix test ([Quantinuum#1534](Quantinuum#1534)) </blockquote> </details> --- This PR was generated with [release-plz](https://github.com/release-plz/release-plz/).

feat: Add python definitions for the TKET metadata keys

31b6b81

aborgna-q requested a review from a team as a code owner April 21, 2026 15:25

aborgna-q requested a review from acl-cqc April 21, 2026 15:25

aborgna-q mentioned this pull request Apr 21, 2026

feat: (WIP) add metadata and guppy kwarg for inline="always" Quantinuum/guppylang#1513

Closed

aborgna-q added 2 commits April 22, 2026 10:58

drive-by: add module-level example docs

987664a

Single source of truth for metadata keys

cf72e1e

acl-cqc approved these changes May 12, 2026

View reviewed changes

aborgna-q added 3 commits May 12, 2026 15:47

non-rename review comments

ebd5cf6

Rename metadata key names, deprecate old ones

b844873

Merge remote-tracking branch 'origin/main' into ab/py-metadata

ddb56dd

aborgna-q added this pull request to the merge queue May 12, 2026

Merged via the queue into main with commit 1bfef9a May 12, 2026
23 of 24 checks passed

aborgna-q deleted the ab/py-metadata branch May 12, 2026 15:40

This was referenced May 12, 2026

chore(py): release tket-py 0.13.1 #1529

Merged

chore: release #1503

Merged

hugrbot mentioned this pull request Jun 1, 2026

chore: release #1641

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: Add python definitions for the TKET metadata keys#1535

feat: Add python definitions for the TKET metadata keys#1535
aborgna-q merged 6 commits into
mainfrom
ab/py-metadata

aborgna-q commented Apr 21, 2026

Uh oh!

codecov Bot commented Apr 21, 2026 •

edited

Loading

Uh oh!

acl-cqc left a comment

Uh oh!

acl-cqc May 12, 2026

Uh oh!

acl-cqc May 12, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

acl-cqc May 12, 2026

Uh oh!

acl-cqc May 12, 2026

Uh oh!

acl-cqc May 12, 2026

Uh oh!

acl-cqc May 12, 2026

Uh oh!

aborgna-q May 12, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

		KEY = _metadata.CIRCUIT_REWRITE_TRACES


		class Unitary(Metadata[int]):

		KEY = _metadata.INPUT_PARAMETERS


		class OpGroup(Metadata[str]):

		return _read_pytket_register(cls.KEY, value)


		class Phase(Metadata[str]):

Uh oh!

Conversation

aborgna-q commented Apr 21, 2026

Uh oh!

codecov Bot commented Apr 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

acl-cqc left a comment

Choose a reason for hiding this comment

Uh oh!

acl-cqc May 12, 2026

Choose a reason for hiding this comment

Uh oh!

acl-cqc May 12, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

acl-cqc May 12, 2026

Choose a reason for hiding this comment

Uh oh!

acl-cqc May 12, 2026

Choose a reason for hiding this comment

Uh oh!

acl-cqc May 12, 2026

Choose a reason for hiding this comment

Uh oh!

acl-cqc May 12, 2026

Choose a reason for hiding this comment

Uh oh!

aborgna-q May 12, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

codecov Bot commented Apr 21, 2026 •

edited

Loading