feat!: Support old Composite alias for CustomGate
#91
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
This PR contains breaking changes to the public Rust API. cargo-semver-checks summary |
cqc-alec
reviewed
Nov 13, 2024
| @@ -129,10 +129,11 @@ pub enum OpBox { | |||
| /// A user-defined assertion specified by a 2x2, 4x4, or 8x8 projector matrix. | |||
| ProjectorAssertionBox { id: BoxID, matrix: Matrix }, | |||
| /// A user-defined gate defined by a parametrised Circuit. | |||
| #[serde(alias = "Composite")] | |||
There was a problem hiding this comment.
Should this be CompositeGate?
| @@ -486,6 +486,7 @@ pub enum OpType { | |||
| /// See [`CustomGate`] | |||
| /// | |||
| /// [`CustomGate`]: crate::opbox::OpBox::CustomGate | |||
| #[serde(alias = "Composite")] | |||
There was a problem hiding this comment.
Should this be CompositeGate?
There was a problem hiding this comment.
The optype enum said Composite, but the class was CompositeGate.
https://github.com/CQCL/tket/pull/175/files#diff-76f05b37a15248c7c6dd673f19dc5b8e74829d4d2ae0ad1316c982ab7fd3373fL567-L570
Do you know which one should it be?
I don't have an old json to verify (@johnchildren do you?).
I could also just add both alias.
There was a problem hiding this comment.
I'm not sure it was ever called CompositeGate, but I'd have to look through the tket commit history too check. I think it was called Composite with a class of CompositeGate but was then renamed to CustomGate (both op type and class) later from memory.
There was a problem hiding this comment.
Sorry yeah see the PR from the issue: https://github.com/CQCL/tket/pull/175/files
It was called Composite and was never called CompositeGate
There was a problem hiding this comment.
Ah, looks like it should match the OpType rather than the class, so Composite is correct.
cqc-alec
approved these changes
Nov 13, 2024
Merged
github-merge-queue bot
pushed a commit
that referenced
this pull request
Nov 13, 2024
## 🤖 New release * `tket-json-rs`: 0.6.2 -> 0.7.0 (⚠️ API breaking changes) ###⚠️ `tket-json-rs` breaking changes ``` --- failure enum_variant_missing: pub enum variant removed or renamed --- Description: A publicly-visible enum has at least one variant that is no longer available under its prior name. It may have been renamed or removed entirely. ref: https://doc.rust-lang.org/cargo/reference/semver.html#item-remove impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.36.0/src/lints/enum_variant_missing.ron Failed in: variant ClassicalExpUnit::Register, previously in file /tmp/.tmpgK5lkw/tket-json-rs/src/circuit_json.rs:56 --- failure struct_marked_non_exhaustive: struct marked #[non_exhaustive] --- Description: A public struct has been marked #[non_exhaustive], which will prevent it from being constructed using a struct literal outside of its crate. It previously had no private fields, so a struct literal could be used to construct it outside its crate. ref: https://doc.rust-lang.org/cargo/reference/semver.html#attr-adding-non-exhaustive impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.36.0/src/lints/struct_marked_non_exhaustive.ron Failed in: struct SerialCircuit in /tmp/.tmp7Vjg5L/tket-json-rs/src/circuit_json.rs:202 struct SerialCircuit in /tmp/.tmp7Vjg5L/tket-json-rs/src/circuit_json.rs:202 --- failure struct_missing: pub struct removed or renamed --- Description: A publicly-visible struct cannot be imported by its prior path. A `pub use` may have been removed, or the struct itself may have been renamed or removed entirely. ref: https://doc.rust-lang.org/cargo/reference/semver.html#item-remove impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.36.0/src/lints/struct_missing.ron Failed in: struct tket_json_rs::circuit_json::Bitstring, previously in file /tmp/.tmpgK5lkw/tket-json-rs/src/circuit_json.rs:35 struct tket_json_rs::circuit_json::BitRegister, previously in file /tmp/.tmpgK5lkw/tket-json-rs/src/circuit_json.rs:25 struct tket_json_rs::circuit_json::CompositeGate, previously in file /tmp/.tmpgK5lkw/tket-json-rs/src/circuit_json.rs:14 struct tket_json_rs::circuit_json::Register, previously in file /tmp/.tmpgK5lkw/tket-json-rs/src/circuit_json.rs:10 ``` <details><summary><i><b>Changelog</b></i></summary><p> <blockquote> ### ⚠ BREAKING CHANGES - Made `SerialCircuit` non exhaustive. - `Register` renamed to `ElementId`, `Qubit` and `Bit` - Moved some definitions from `::circuit_json` to `::register` - Bumped MSRV to rust 1.75 - Renamed `circuit_json::CompositeGate` to `CustomGate` ## 0.7.0 (2024-11-13) ### Features - [**breaking**] `created/discarded_qubits` circuit attribute ([#87](#87)) - Support classical expressions ([#86](#86)) - [**breaking**] Rename `Register` and cleanup definitions ([#89](#89)) - [**breaking**] Support old `Composite` alias for `CustomGate` ([#91](#91)) </blockquote> </p></details> --- This PR was generated with [release-plz](https://github.com/MarcoIeni/release-plz/). --------- Co-authored-by: Agustín Borgna <121866228+aborgna-q@users.noreply.github.com>
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #67
BREAKING CHANGE: Renamed
circuit_json::CompositeGatetoCustomGate