Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor!: use JSON rather than YAML in opaque fields. #1338

Merged
merged 2 commits into from
Jul 24, 2024
Merged

Conversation

ss2165
Copy link
Member

@ss2165 ss2165 commented Jul 24, 2024

Closes #1048

BREAKING CHANGE: use serde_json::Value rather than serde_yaml::Value in CustomSerialized, OpDef, OperationDeclaration

@ss2165 ss2165 requested a review from a team as a code owner July 24, 2024 14:32
@ss2165 ss2165 requested review from cqc-alec and doug-q and removed request for a team and cqc-alec July 24, 2024 14:32
Base automatically changed from ss/custom-typearg to main July 24, 2024 14:48
Closes #1048

BREAKING_CHANGE: use `serde_json::Value` rather than `serde_yaml::Value` in `CustomSerialized`, `CustomTypeArg`, `OpDef`, `OperationDeclaration`
Copy link
Collaborator

@doug-q doug-q left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome, just a couple nits.

hugr-core/src/proptest.rs Outdated Show resolved Hide resolved
hugr-core/src/proptest.rs Outdated Show resolved Hide resolved
hugr-core/src/proptest.rs Outdated Show resolved Hide resolved
Copy link

codecov bot commented Jul 24, 2024

Codecov Report

Attention: Patch coverage is 93.33333% with 2 lines in your changes missing coverage. Please review.

Project coverage is 87.48%. Comparing base (24b2217) to head (e004681).

Files Patch % Lines
hugr-core/src/ops/constant/custom.rs 87.50% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1338      +/-   ##
==========================================
- Coverage   87.48%   87.48%   -0.01%     
==========================================
  Files         111      111              
  Lines       19787    19785       -2     
  Branches    17524    17522       -2     
==========================================
- Hits        17311    17309       -2     
  Misses       1702     1702              
  Partials      774      774              
Flag Coverage Δ
python 91.51% <ø> (ø)
rust 86.96% <93.33%> (-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.

Co-authored-by: Douglas Wilson <141026920+doug-q@users.noreply.github.com>
@ss2165 ss2165 added this pull request to the merge queue Jul 24, 2024
Merged via the queue into main with commit 56c3f5f Jul 24, 2024
22 checks passed
@ss2165 ss2165 deleted the ss/no-yaml branch July 24, 2024 15:07
@hugrbot hugrbot mentioned this pull request Jul 24, 2024
github-merge-queue bot pushed a commit that referenced this pull request Jul 29, 2024
## 🤖 New release
* `hugr`: 0.9.1 -> 0.10.0
* `hugr-core`: 0.6.1 -> 0.7.0
* `hugr-passes`: 0.6.1 -> 0.6.2
* `hugr-cli`: 0.2.1 -> 0.3.0

<details><summary><i><b>Changelog</b></i></summary><p>

## `hugr`
<blockquote>

## 0.10.0 (2024-07-26)

### Bug Fixes

(#1350))
- [**breaking**] Bump serialisation version with no upgrade path
([#1352](#1352))

### Features

- Add `nonlocal_edges` and `ensure_no_nonlocal_edges`
([#1345](#1345))
- Serialization upgrade path
([#1327](#1327))
- [**breaking**] Replace opaque type arguments with String
([#1328](#1328))
- Add `impl Hash for Type`
([#1347](#1347))
- `HasDef` and `HasConcrete` traits for def/concrete op design pattern
([#1336](#1336))
- Add pointer standard extension
([#1337](#1337))
- [**breaking**] Remove the `Eq` type bound.
([#1364](#1364))

### Refactor

- [**breaking**] Use JSON rather than YAML in opaque fields.
([#1338](#1338))
- [**breaking**] Declarative module behind optional feature flag
([#1341](#1341))

### Testing

- Miri gate serialization upgrades
([#1349](#1349))
</blockquote>

## `hugr-core`
<blockquote>

## 0.7.0 (2024-07-26)

### Bug Fixes

(#1350))
- [**breaking**] Bump serialisation version with no upgrade path
([#1352](#1352))

### Features

- Serialization upgrade path
([#1327](#1327))
- [**breaking**] Replace opaque type arguments with String
([#1328](#1328))
- Add `impl Hash for Type`
([#1347](#1347))
- `HasDef` and `HasConcrete` traits for def/concrete op design pattern
([#1336](#1336))
- Add pointer standard extension
([#1337](#1337))
- [**breaking**] Remove the `Eq` type bound.
([#1364](#1364))

### Refactor

- [**breaking**] Use JSON rather than YAML in opaque fields.
([#1338](#1338))
- [**breaking**] Declarative module behind optional feature flag
([#1341](#1341))

### Testing

- Miri gate serialization upgrades
([#1349](#1349))
</blockquote>

## `hugr-passes`
<blockquote>

## 0.6.2 (2024-07-26)

### Features

- Add `nonlocal_edges` and `ensure_no_nonlocal_edges`
([#1345](#1345))
</blockquote>

## `hugr-cli`
<blockquote>

## 0.3.0 (2024-07-26)

### Features

- [**breaking**] Created `validate` CLI subcommand.
([#1312](#1312))
</blockquote>


</p></details>

---
This PR was generated with
[release-plz](https://github.com/MarcoIeni/release-plz/).

---------

Co-authored-by: Douglas Wilson <douglas.wilson@quantinuum.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

serde_yaml::Value does not perfectly round trip serialize.
2 participants