Skip to content

feat: Standarize the string formating of sum types and values #2432

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

Merged
merged 1 commit into from
Jul 14, 2025

Conversation

aborgna-q
Copy link
Collaborator

The Sum value and type helpers get coerced back into val.Sum and tys.Sum after a serialization roundtrip. This used to change the rendering of the values, falling back to the verbose Sum(tag=#, typ=[..., ...], vals=[...,...]).

This PR centralizes the str/repr definition, so equivalent values and types are always rendered in the same way. (I needed this for roundtrip checks).

@aborgna-q aborgna-q requested a review from a team as a code owner July 11, 2025 10:25
@aborgna-q aborgna-q requested a review from doug-q July 11, 2025 10:25
Copy link

codecov bot commented Jul 11, 2025

Codecov Report

Attention: Patch coverage is 89.79592% with 10 lines in your changes missing coverage. Please review.

Project coverage is 82.56%. Comparing base (71c0e89) to head (d445e65).
Report is 2 commits behind head on main.

Files with missing lines Patch % Lines
hugr-py/src/hugr/utils.py 50.00% 7 Missing ⚠️
hugr-py/src/hugr/tys.py 91.66% 3 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2432      +/-   ##
==========================================
- Coverage   82.56%   82.56%   -0.01%     
==========================================
  Files         246      246              
  Lines       45792    45839      +47     
  Branches    41528    41528              
==========================================
+ Hits        37809    37846      +37     
- Misses       5961     5971      +10     
  Partials     2022     2022              
Flag Coverage Δ
python 91.37% <89.79%> (-0.14%) ⬇️

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.

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.

Thanks!

@aborgna-q aborgna-q added this pull request to the merge queue Jul 14, 2025
Merged via the queue into main with commit ec207e7 Jul 14, 2025
48 checks passed
@aborgna-q aborgna-q deleted the ab/sum-str branch July 14, 2025 10:18
github-merge-queue bot pushed a commit that referenced this pull request Jul 25, 2025
🤖 I have created a release *beep* *boop*
---


##
[0.13.0rc1](hugr-py-v0.12.2...hugr-py-v0.13.0rc1)
(2025-07-24)


### ⚠ BREAKING CHANGES

* Lowering functions in extension operations are now encoded as binary
envelopes. Older hugr versions will error out when trying to load them.
* **py:** `EnvelopeConfig::BINARY` now uses the model binary encoding.
`EnvelopeFormat.MODULE` is now `EnvelopeFormat.MODEL`.
`EnvelopeFormat.MODULE_WITH_EXTS` is now
`EnvelopeFormat.MODEL_WITH_EXTS`
* hugr-model: Symbol has an extra field
* Renamed the `Any` type bound to `Linear`
* The model CFG signature types were changed.
* Added `TypeParam`s and `TypeArg`s corresponding to floats and bytes.
* `TypeArg::Sequence` needs to be replaced with `TypeArg::List` or
`TypeArg::Tuple`
* FuncDefns must be moved to beneath Module.
`Container::define_function` is gone, use
`HugrBuilder::module_root_builder`; similarly in hugr-py
`DefinitionBuilder` (`define_function` ->
`module_root_builder().define_function`). In hugr-llvm, some uses of

### Features

* Add `BorrowArray` extension
([#2395](#2395))
([782687e](782687e))
* Add `MakeError` op ([#2377](#2377))
([909a794](909a794)),
closes [#1863](#1863)
* add toposort to HUGR-py
([#2367](#2367))
([34eed34](34eed34))
* Add Visibility to FuncDefn/FuncDecl.
([#2143](#2143))
([5bbe0cd](5bbe0cd))
* Added float and bytes literal to core and python bindings.
([#2289](#2289))
([e9c5e91](e9c5e91))
* **core, llvm:** add array unpack operations
([#2339](#2339))
([a1a70f1](a1a70f1)),
closes [#1947](#1947)
* Detect and fail on unrecognised envelope flags
([#2453](#2453))
([5e36770](5e36770))
* Export entrypoint metadata in Python and fix bug in import
([#2434](#2434))
([d17b245](d17b245))
* Expose `BorrowArray` in `hugr-py`
([#2425](#2425))
([fdb675f](fdb675f)),
closes [#2406](#2406)
* include generator metatada in model import and cli validate errors
([#2452](#2452))
([f7cedb4](f7cedb4))
* Names of private functions become `core.title` metadata.
([#2448](#2448))
([4bc7f65](4bc7f65))
* No nested FuncDefns (or AliasDefns)
([#2256](#2256))
([214b8df](214b8df))
* Non-region entrypoints in `hugr-model`.
([#2467](#2467))
([7b42da6](7b42da6))
* Open lists and tuples in `Term`
([#2360](#2360))
([292af80](292af80))
* **py:** enable Model as default BINARY envelope format
([#2317](#2317))
([f089931](f089931))
* **py:** Helper methods to get the neighbours of a node
([#2370](#2370))
([bb6fa50](bb6fa50))
* **py:** Use SumValue serialization for tuples
([#2466](#2466))
([f615037](f615037))
* Rename 'Any' type bound to 'Linear'
([#2421](#2421))
([c2f8b30](c2f8b30))
* Split `TypeArg::Sequence` into tuples and lists.
([#2140](#2140))
([cc4997f](cc4997f))
* Standarize the string formating of sum types and values
([#2432](#2432))
([ec207e7](ec207e7))
* Use binary envelopes for operation lower_func encoding
([#2447](#2447))
([2c16a77](2c16a77))


### Bug Fixes

* Ensure SumTypes have the same json encoding in -rs and -py
([#2465](#2465))
([7f97e6f](7f97e6f))
* Escape html-like labels in DotRenderer
([#2383](#2383))
([eaa7dfe](eaa7dfe))
* Export metadata in Python
([#2342](#2342))
([7be52db](7be52db))
* Fix model export of `Opaque` types.
([#2446](#2446))
([3943499](3943499))
* Fixed bug in python model export name mangling.
([#2323](#2323))
([041342f](041342f))
* Fixed bugs in model CFG handling and improved CFG signatures
([#2334](#2334))
([ccd2eb2](ccd2eb2))
* Fixed export of `Call` and `LoadConst` nodes in `hugr-py`.
([#2429](#2429))
([6a0e270](6a0e270))
* Fixed invalid extension name in test.
([#2319](#2319))
([c58ddbf](c58ddbf))
* Fixed two bugs in import/export of function operations
([#2324](#2324))
([1ad450f](1ad450f))
* map IntValue to unsigned repr when serializing
([#2413](#2413))
([26d426e](26d426e)),
closes [#2409](#2409)
* Order hints on input and output nodes.
([#2422](#2422))
([a31ccbc](a31ccbc))
* **py:** correct ConstString JSON encoding
([#2325](#2325))
([9649a48](9649a48))
* StaticArrayVal payload encoding, improve roundtrip checker
([#2444](#2444))
([1a301eb](1a301eb))
* stringify metadata before escaping in renderer
([#2405](#2405))
([8d67420](8d67420))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Release-As: 0.13.0rc1

---------

Co-authored-by: Agustín Borgna <[email protected]>
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.

2 participants