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.

Sign up for GitHub

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

Jump to bottom

feat!: disallow opaque ops during validation #1431

Merged
merged 6 commits into from
Aug 15, 2024
Merged

feat!: disallow opaque ops during validation #1431

merged 6 commits into from
Aug 15, 2024

Conversation

ss2165
Copy link
Member

@ss2165 ss2165 commented Aug 14, 2024 •
edited
Loading

Update python to pass extensions as package when validating

Use cached signatures from opaque when resolving if missing binary compute.
Closes #1362

BREAKING CHANGE: HUGRs containing opaque operations that don't point to an extension in the registry will fail to validate. Use Package to pack extensions with HUGRs for serialisation.

@ss2165
feat!: disallow opaque ops during validation
48759b4 
Update python to pass extensions as package when validating
@ss2165 ss2165 requested a review from a team as a code owner August 14, 2024 16:28
@ss2165 ss2165 requested a review from cqc-alec August 14, 2024 16:28
@codecov Codecov
Copy link

codecov bot commented Aug 14, 2024 •
edited
Loading

Codecov Report

Attention: Patch coverage is 85.10638% with 21 lines in your changes missing coverage. Please review.

Project coverage is 87.55%. Comparing base (8e8bba5) to head (9e298c5).
Report is 1 commits behind head on main.

Files Patch % Lines
hugr-core/src/hugr/validate.rs 8.33% 10 Missing and 1 partial ⚠️
hugr-core/src/ops/custom.rs 90.12% 5 Missing and 3 partials ⚠️
hugr-core/src/hugr/serialize/test.rs 92.00% 0 Missing and 2 partials ⚠️
Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #1431      +/-   ##
==========================================
+ Coverage   87.47%   87.55%   +0.07%     
==========================================
  Files         119      119              
  Lines       20676    20781     +105     
  Branches    17950    18053     +103     
==========================================
+ Hits        18086    18194     +108     
+ Misses       1804     1802       -2     
+ Partials      786      785       -1
Flag Coverage Δ
python 90.61% <100.00%> (+0.33%) ⬆️
rust 87.08% <84.89%> (+0.04%) ⬆️

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.

@CQCL CQCL deleted a comment from hugrbot Aug 15, 2024
ss2165
ss2165 commented Aug 15, 2024
View reviewed changes
hugr-core/src/extension.rs Outdated Show resolved Hide resolved
cqc-alec
cqc-alec approved these changes Aug 15, 2024
View reviewed changes
Copy link
Collaborator

@cqc-alec cqc-alec left a comment

Choose a reason for hiding this comment

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

Should we remove OpaqueOp from the spec?

hugr-py/tests/test_custom.py Outdated Show resolved Hide resolved
ss2165 and others added 2 commits August 15, 2024 11:28
@ss2165 @cqc-alec
remove redundant alias
810b9d1 
Co-authored-by: Alec Edgington <54802828+cqc-alec@users.noreply.github.com>
@ss2165
use cached signatures when missing functions
94036d9
@ss2165 ss2165 requested a review from cqc-alec August 15, 2024 11:04
@ss2165
Copy link
Member Author

ss2165 commented Aug 15, 2024

Should we remove OpaqueOp from the spec?

yes, done

@ss2165 ss2165 enabled auto-merge August 15, 2024 11:14
@ss2165 ss2165 added this pull request to the merge queue Aug 15, 2024
Merged via the queue into main with commit fbbb805 Aug 15, 2024
22 checks passed
@ss2165 ss2165 deleted the ss/no-opaque-valid branch August 15, 2024 11:18
This was referenced Aug 14, 2024
Merged
Closed
This was referenced Aug 30, 2024
Closed
Merged
github-merge-queue bot pushed a commit that referenced this pull request Aug 30, 2024
@hugrbot
chore: release (#1495)
3213063 
## 🤖 New release
* `hugr`: 0.11.0 -> 0.12.0
* `hugr-core`: 0.8.0 -> 0.9.0
* `hugr-passes`: 0.7.0 -> 0.8.0
* `hugr-cli`: 0.4.0 -> 0.5.0

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

## `hugr`
<blockquote>

## 0.12.0 (2024-08-30)

### Features

- [**breaking**] Disallow opaque ops during validation
([#1431](#1431))
- [**breaking**] Add collections to serialized standard extensions
([#1452](#1452))
- [**breaking**] Variadic logic ops now binary
([#1451](#1451))
- [**breaking**] Int operations other than widen/narrow have only one
width arg ([#1455](#1455))
- Add a `FuncTypeBase::io` method
([#1458](#1458))
- Add missing ops ([#1463](#1463))
- [**breaking**] Move `Lift`, `MakeTuple`, `UnpackTuple` and `Lift` to
prelude ([#1475](#1475))
- `Option` / `Result` helpers
([#1481](#1481))
- [**breaking**] Add more list operations
([#1474](#1474))
- [**breaking**] Move int conversions to `conversions` ext, add to/from
usize ([#1490](#1490))
- Fill out array ops ([#1491](#1491))

### Refactor

- [**breaking**] Bring the collections ext in line with other extension
defs ([#1469](#1469))
- [**breaking**] Make Either::Right the "success" case
([#1489](#1489))
- [**breaking**] Flatten `CustomOp` in to `OpType`
([#1429](#1429))

### Testing

- Add serialization benchmarks
([#1439](#1439))
</blockquote>

## `hugr-core`
<blockquote>

## 0.9.0 (2024-08-30)

### Features

- [**breaking**] Disallow opaque ops during validation
([#1431](#1431))
- [**breaking**] Add collections to serialized standard extensions
([#1452](#1452))
- [**breaking**] Variadic logic ops now binary
([#1451](#1451))
- [**breaking**] Int operations other than widen/narrow have only one
width arg ([#1455](#1455))
- Add a `FuncTypeBase::io` method
([#1458](#1458))
- Add missing ops ([#1463](#1463))
- [**breaking**] Move `Lift`, `MakeTuple`, `UnpackTuple` and `Lift` to
prelude ([#1475](#1475))
- `Option` / `Result` helpers
([#1481](#1481))
- [**breaking**] Add more list operations
([#1474](#1474))
- [**breaking**] Move int conversions to `conversions` ext, add to/from
usize ([#1490](#1490))
- Fill out array ops ([#1491](#1491))

### Refactor

- [**breaking**] Flatten `CustomOp` in to `OpType`
([#1429](#1429))
- [**breaking**] Bring the collections ext in line with other extension
defs ([#1469](#1469))
- [**breaking**] Make Either::Right the "success" case
([#1489](#1489))
</blockquote>

## `hugr-passes`
<blockquote>

## 0.8.0 (2024-08-30)

### Features

- [**breaking**] Variadic logic ops now binary
([#1451](#1451))
- [**breaking**] Int operations other than widen/narrow have only one
width arg ([#1455](#1455))
- [**breaking**] Move `Lift`, `MakeTuple`, `UnpackTuple` and `Lift` to
prelude ([#1475](#1475))
- [**breaking**] Add more list operations
([#1474](#1474))
- [**breaking**] Move int conversions to `conversions` ext, add to/from
usize ([#1490](#1490))

### Refactor

- [**breaking**] Flatten `CustomOp` in to `OpType`
([#1429](#1429))
- [**breaking**] Bring the collections ext in line with other extension
defs ([#1469](#1469))
- [**breaking**] Make Either::Right the "success" case
([#1489](#1489))
</blockquote>

## `hugr-cli`
<blockquote>

## 0.5.0 (2024-08-30)

### Features

- [**breaking**] Add collections to serialized standard extensions
([#1452](#1452))
</blockquote>


</p></details>

---
This PR was generated with
[release-plz](https://github.com/MarcoIeni/release-plz/).
github-merge-queue bot pushed a commit that referenced this pull request Aug 30, 2024
@hugrbot @aborgna-q
chore(main): release hugr-py 0.8.0 (#1430)
a38e58c 
🤖 I have created a release *beep* *boop*
---


##
[0.8.0](hugr-py-v0.7.0...hugr-py-v0.8.0)
(2024-08-30)


### ⚠ BREAKING CHANGES

* Moved `itobool`/`ifrombool`/`itostring_{u,s}` to the conversions
extension.
* Binary sums representing fallible values now use tag `1` for the
successful variant
* **hugr-py:** rename `Custom.name` to `Custom.op_name` and
`Func(Defn/Decl).name` to `f_name` to allow for new `name` method
* `ListOp::pop` now returns an option.
* Moved all builder definitions into the `hugr.build` module. Moved
`node_port` and `render` into the `hugr.hugr` module.
* Move `Lift`, `MakeTuple`, `UnpackTuple` and `Lift` from core
operations to prelude. Rename `ops::leaf` module to `ops::sum`.
* **hugr-py:** `hugr.serialization` module and `to_serial` methods are
now internal only.
* Renamed `_DfBase` to `DfBase` and `_DefinitionBuilder` to
`DefinitionBuilder`
* `idivmod_checked`, `idivmod`, `idiv`, `idiv_checked`, `imod`, `ishl`,
`ishr`, `irotl`, `irotr` operations now only have one width argument for
all inputs and outputs rather than two.
* HUGRs containing opaque operations that don't point to an extension in
the registry will fail to validate. Use `Package` to pack extensions
with HUGRs for serialisation.
* `CustomOp` removed, `OpType` now contains `ExtensionOp` and `OpaqueOp`
directly. `CustomOpError` renamed to`OpaqueOpError`.

### Features

* `Option` / `Result` helpers
([#1481](#1481))
([9698420](9698420))
* Add missing ops ([#1463](#1463))
([841f450](841f450))
* Add more list operations
([#1474](#1474))
([037005f](037005f))
* Bring in the pure-python renderer from guppy
([#1462](#1462))
([001e66a](001e66a))
* disallow opaque ops during validation
([#1431](#1431))
([fbbb805](fbbb805))
* fill out array ops ([#1491](#1491))
([26ec57a](26ec57a))
* **hugr-py:** pretty printing for ops and types
([#1482](#1482))
([aca403a](aca403a))
* **hugr-py:** use serialized extensions in python
([#1459](#1459))
([a61f4df](a61f4df)),
closes [#1450](#1450)
* int operations other than widen/narrow have only one width arg
([#1455](#1455))
([c39ed15](c39ed15))
* Move `Lift`, `MakeTuple`, `UnpackTuple` and `Lift` to prelude
([#1475](#1475))
([b387505](b387505))
* Move int conversions to `conversions` ext, add to/from usize
([#1490](#1490))
([88913f2](88913f2))


### Bug Fixes

* **hugr-py:** record node children correctly when deserializing
([#1480](#1480))
([331125a](331125a)),
closes [#1479](#1479)
* **py:** Invalid node indexing
([#1457](#1457))
([d6edcd7](d6edcd7))
* schema for array inner types
([#1494](#1494))
([d43cbb2](d43cbb2)),
closes [#1471](#1471)
* Sum value equality. Add unit tests
([#1484](#1484))
([a7b2718](a7b2718))


### Code Refactoring

* flatten `CustomOp` in to `OpType`
([#1429](#1429))
([8e8bba5](8e8bba5))
* **hugr-py:** make serialization (module/methods) private
([#1477](#1477))
([49a5bad](49a5bad))
* Make `_DfBase` and `_DefinitionBuilder` public
([#1461](#1461))
([ea9cca0](ea9cca0))
* Make Either::Right the "success" case
([#1489](#1489))
([8caa572](8caa572))
* Organise the hugr-py modules
([#1460](#1460))
([3ca56f4](3ca56f4))

---
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 <121866228+aborgna-q@users.noreply.github.com>
Co-authored-by: Agustin Borgna <agustin.borgna@quantinuum.com>
@hugrbot hugrbot mentioned this pull request Sep 3, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cqc-alec cqc-alec cqc-alec approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Remove OpaqueOp (used only for serialisation)
2 participants
@ss2165 @cqc-alec