refactor!: Make Either::Right the "success" case #1489

aborgna-q · 2024-08-30T10:59:56Z

Similarly for options, which now have type [] + [elems...].
Adds const_ok/_fail aliases to const_right/_left.

Closes #1487.

Modifies the old folding tests that hard-coded the sum tags.

BREAKING CHANGE: Binary sums representing fallible values now use tag 1 for the successful variant

…s-bad

codecov · 2024-08-30T11:05:45Z

Codecov Report

Attention: Patch coverage is 96.93878% with 3 lines in your changes missing coverage. Please review.

Project coverage is 87.27%. Comparing base (aca403a) to head (1488d69).
Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
...td_extensions/arithmetic/conversions/const_fold.rs	25.00%	3 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1489      +/-   ##
==========================================
+ Coverage   87.24%   87.27%   +0.02%     
==========================================
  Files         125      125              
  Lines       21352    21331      -21     
  Branches    18380    18359      -21     
==========================================
- Hits        18628    18616      -12     
+ Misses       1950     1948       -2     
+ Partials      774      767       -7

Flag	Coverage Δ
python	`92.69% <100.00%> (ø)`
rust	`86.39% <96.80%> (+0.03%)`	⬆️

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.

ss2165 · 2024-08-30T13:03:27Z

hugr-core/src/extension/prelude.rs

+ ///
+ /// args:
+ /// ty_ok: The type of the success variant.
+ pub fn as_either(self, ty_ok: impl Into<TypeRowRV>) -> Value {


ss2165 · 2024-08-30T13:07:01Z

hugr-py/src/hugr/val.py


 def __repr__(self) -> str:
- return f"None({', '.join(map(repr, self.typ.variant_rows[0]))})"
+ return f"None({', '.join(map(repr, self.typ.variant_rows[1]))})"


can use comma_sep_repr from utils

## 🤖 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>Changelog</summary> ## `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> </details> --- This PR was generated with [release-plz](https://github.com/MarcoIeni/release-plz/).

🤖 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>

aborgna-q added 2 commits August 30, 2024 11:54

refactor: Either::Right is the success case

fa85657

const_fail instead of _err, to distinguish from ERROR_T

27b5e9d

aborgna-q requested a review from a team as a code owner August 30, 2024 10:59

aborgna-q requested a review from ss2165 August 30, 2024 10:59

Merge remote-tracking branch 'origin/main' into ab/one-is-good-zero-i…

e0411db

…s-bad

Update extension ops defs

3b7d350

ss2165 approved these changes Aug 30, 2024

View reviewed changes

Use comma_sep_str

1488d69

aborgna-q added this pull request to the merge queue Aug 30, 2024

Merged via the queue into main with commit 8caa572 Aug 30, 2024
21 checks passed

aborgna-q deleted the ab/one-is-good-zero-is-bad branch August 30, 2024 14:09

This was referenced Aug 30, 2024

chore(main): release hugr-py 0.8.0 #1430

Merged

chore: release #1420

Closed

chore: release #1492

Closed

chore: release #1495

Merged

hugrbot mentioned this pull request Sep 3, 2024

chore: release #1504

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor!: Make Either::Right the "success" case #1489

refactor!: Make Either::Right the "success" case #1489

aborgna-q commented Aug 30, 2024 •

edited

Loading

codecov bot commented Aug 30, 2024 •

edited

Loading

ss2165 Aug 30, 2024

ss2165 Aug 30, 2024

refactor!: Make Either::Right the "success" case #1489

refactor!: Make Either::Right the "success" case #1489

Conversation

aborgna-q commented Aug 30, 2024 • edited Loading

codecov bot commented Aug 30, 2024 • edited Loading

Codecov Report

ss2165 Aug 30, 2024

Choose a reason for hiding this comment

ss2165 Aug 30, 2024

Choose a reason for hiding this comment

aborgna-q commented Aug 30, 2024 •

edited

Loading

codecov bot commented Aug 30, 2024 •

edited

Loading