feat: add toposort to HUGR-py #2367

CalMacCQ · 2025-06-24T10:42:34Z

Basic Toposort implementation with Kahn's algorithm.

This is my first code contribution to hugr-py so any pointers on how to write a good test would be appreciated. Spent quite some time trying to figure out the graph builder.

codecov · 2025-06-24T12:52:04Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.23%. Comparing base (5da112b) to head (e1cdb47).
Report is 6 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2367      +/-   ##
==========================================
+ Coverage   82.17%   82.23%   +0.05%     
==========================================
  Files         244      244              
  Lines       44787    44352     -435     
  Branches    40566    40108     -458     
==========================================
- Hits        36805    36474     -331     
+ Misses       5981     5889      -92     
+ Partials     2001     1989      -12

Flag	Coverage Δ
python	`85.34% <100.00%> (+0.07%)`	⬆️

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.

CalMacCQ · 2025-06-24T12:56:36Z

hugr-py/tests/test_hugr_build.py

+    validate(Package([f.hugr], [QUANTUM_EXT]))
+
+    sorted_nodes = f.hugr.get_sorted_nodes(f.hugr.module_root)
+    assert len(list(sorted_nodes)) == len(list(f.hugr))


This is a bad test. Will replace with asserting that the sort is a valid topological ordering

hugr-py/src/hugr/hugr/base.py

.

Co-authored-by: Agustín Borgna <[email protected]>

CalMacCQ · 2025-06-25T15:39:25Z

This implementation handles non-local edges

We may also want to check that there are no cycles in the case where we run the sort on an invalid HUGR. I don't know if the builder allows for the construction of invalid graphs which contain cycles.

hugr-py/src/hugr/hugr/base.py

aborgna-q · 2025-06-25T16:11:20Z

We may also want to check that there are no cycles

If queue is empty but visit_dict still has elements then there are things that we couldn't reach, so there is a loop and we should raise an error.

Co-authored-by: Agustín Borgna <[email protected]>

hugr-py/tests/test_hugr_build.py

hugr-py/src/hugr/hugr/base.py

hugr-py/tests/test_hugr_build.py

Co-authored-by: Agustín Borgna <[email protected]>

aborgna-q

hugr-py/src/hugr/hugr/base.py

Co-authored-by: Agustín Borgna <[email protected]>

Basic Toposort implementation with [Kahn's algorithm](https://en.wikipedia.org/wiki/Topological_sorting#Kahn's_algorithm). This is my first code contribution to hugr-py so any pointers on how to write a good test would be appreciated. Spent quite some time trying to figure out the graph builder. --------- Co-authored-by: Agustín Borgna <[email protected]>

🤖 I have created a release *beep* *boop* --- ## [0.12.3](hugr-py-v0.12.2...hugr-py-v0.12.3) (2025-07-03) ### Features * add toposort to HUGR-py ([#2367](#2367)) ([ba8988e](ba8988e)) * **core, llvm:** add array unpack operations ([#2339](#2339)) ([74b25aa](74b25aa)), closes [#1947](#1947) * **py:** Helper methods to get the neighbours of a node ([#2370](#2370)) ([1ed6440](1ed6440)) ### Bug Fixes * Escape html-like labels in DotRenderer ([#2383](#2383)) ([c7a43a6](c7a43a6)) * Fixed invalid extension name in test. ([#2319](#2319)) ([fbe1d9c](fbe1d9c)) * **py:** correct ConstString JSON encoding ([#2325](#2325)) ([325168b](325168b)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).

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

CalMacCQ added 4 commits June 24, 2025 10:46

add initial implementation

7719f06

add initial (failing) test

75b85b6

add docstring

d329829

use a visit dict

465c65f

CalMacCQ requested a review from a team as a code owner June 24, 2025 10:42

CalMacCQ requested review from zrho and removed request for zrho June 24, 2025 10:42

CalMacCQ marked this pull request as draft June 24, 2025 10:43

CalMacCQ added 3 commits June 24, 2025 13:21

use decendants method

1b0dd30

fix: only reduce degree if nodes are connected

609dd38

add a type annotation for mypy

9967cb1

CalMacCQ commented Jun 24, 2025

View reviewed changes

aborgna-q previously approved these changes Jun 24, 2025

View reviewed changes

hugr-py/src/hugr/hugr/base.py Outdated Show resolved Hide resolved

hugr-py/src/hugr/hugr/base.py Outdated Show resolved Hide resolved

aborgna-q self-requested a review June 24, 2025 14:30

CalMacCQ and others added 4 commits June 24, 2025 16:42

use hugr.children() not hugr.decendants()

b8d89fb

Co-authored-by: Agustín Borgna <[email protected]>

Merge branch 'main' into cm/hugrpy-toposort

709646e

use agustins suggestion with helper methods

655a717

improve test

17eb2f7

make mypy happy

f5df896

aborgna-q reviewed Jun 25, 2025

View reviewed changes

hugr-py/src/hugr/hugr/base.py Outdated Show resolved Hide resolved

CalMacCQ and others added 6 commits June 25, 2025 17:12

Use suggestion for handling non-local edges

f1ba64e

Co-authored-by: Agustín Borgna <[email protected]>

fix syntax error

71c952d

error on cycles

7cfeb57

fix handling of input node

f95b0a1

add comments and rename

7f98f0d

add a test for cycle detection

3fca6fc

CalMacCQ requested a review from aborgna-q June 27, 2025 13:30

CalMacCQ commented Jun 27, 2025

View reviewed changes

hugr-py/tests/test_hugr_build.py Outdated Show resolved Hide resolved

refactor tests with a helper

69e214b

CalMacCQ commented Jun 27, 2025

View reviewed changes

hugr-py/tests/test_hugr_build.py Outdated Show resolved Hide resolved

aborgna-q reviewed Jun 27, 2025

View reviewed changes

CalMacCQ and others added 5 commits June 27, 2025 15:07

Use a set to validate toposort

5cb41a1

Co-authored-by: Agustín Borgna <[email protected]>

use pytest fixture

d6a0074

call validate inside helper

5041582

fix use of validate

e532c48

expand docstring

79f7b4a

aborgna-q linked an issue Jun 27, 2025 that may be closed by this pull request

Implement topological sort in hugr-py #2350

Closed

CalMacCQ added 5 commits June 30, 2025 14:04

Merge branch 'main' into cm/hugrpy-toposort

b686973

add doctest

08ba648

try to fix doctest

bbdfc63

update test and rename method

95bc63b

finally fix test

a9c6f25

CalMacCQ requested a review from aborgna-q July 2, 2025 17:01

aborgna-q approved these changes Jul 2, 2025

View reviewed changes

hugr-py/src/hugr/hugr/base.py Outdated Show resolved Hide resolved

Update hugr-py/src/hugr/hugr/base.py

e1cdb47

Co-authored-by: Agustín Borgna <[email protected]>

CalMacCQ enabled auto-merge July 2, 2025 17:37

CalMacCQ added this pull request to the merge queue Jul 2, 2025

Merged via the queue into main with commit 34eed34 Jul 2, 2025
27 checks passed

CalMacCQ deleted the cm/hugrpy-toposort branch July 2, 2025 17:43

hugrbot mentioned this pull request Jul 2, 2025

chore(main): release hugr-py 0.13.0rc1 #2302

Merged

hugrbot mentioned this pull request Jul 3, 2025

chore(release/hugr-py-0.12.3): release hugr-py 0.12.3 #2404

Merged

feat: add toposort to HUGR-py #2367

feat: add toposort to HUGR-py #2367

Uh oh!

Conversation

CalMacCQ commented Jun 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Jun 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

CalMacCQ Jun 24, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

CalMacCQ commented Jun 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

aborgna-q commented Jun 25, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

aborgna-q left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

CalMacCQ commented Jun 24, 2025 •

edited

Loading

codecov bot commented Jun 24, 2025 •

edited

Loading

CalMacCQ commented Jun 25, 2025 •

edited

Loading