test: Better python roundtrip tests, and lots of fixes

[aborgna-q]

The python validation tests did a roundtrip serialization check by encoding the HUGR, loading it, encoding it again, and checking for differences in the serialization.
This ignored any information loss in the first encoding, and resulted in a lot of hidden bugs.

This PR changes the test in conftest.py to instead compare the original HUGR and the loaded one directly, using a "node hash" that computes the main properties of each node and its children in an index-independent way. (we do not traverse graph edges to avoid having a graph isomorphism problem).
The node hash is defined as follows, and should be easily extensible if needed. We compare hugrs by checking the hashes of their root modules.

@dataclass
class _NodeHash:
    op: str
    entrypoint: bool
    input_neighbours: int
    output_neighbours: int
    input_ports: int
    output_ports: int
    input_order_edges: int
    output_order_edges: int
    is_region: bool
    node_depth: int
    children_hashes: list[_NodeHash] # sorted
    metadata: dict[str, str]

This revealed a bunch of bugs with the json serialization, hugr builders, node iterators, ...:

• Order edges were serialized incorrectly. The json encoding uses null for order edges, but python emitted #ports instead (and this caused problems when combined with the out port inconsistencies below).
• Standardize string/repr formatting for specialized types and values, so e.g. after roundtriping a Some(TRUE) it still shows as Some instead of Sum(tag=1, tys=[[], [Bool]], val=[TRUE]).
• Hugr.num_outgoing and num_incoming were counting ports instead of edges...
• Fixed many inconsistencies with the number of output ports in FuncDefn, Case, and the likes.
• The output port count wasn't being set in a lot of cases (this worked fine in the tests because adding an edge auto-allocates the ports).
• Order edges were inconsistently reported in the neighbours / links iterators. I fixed it and added new tests.
• Probably more bugfixes I'm missing.

The roundtrip checks also have options for checking all the format combinations (one variable for the encoding format and another for converting it with hugr convert before loading if necessary).
This only does json-json for the moment, as hugr-model detects multiple errors.

[codecov]

Codecov Report

Attention: Patch coverage is 90.00000% with 7 lines in your changes missing coverage. Please review.

Project coverage is 81.99%. Comparing base (ec207e7) to head (7235f67).
Report is 5 commits behind head on main.

Files with missing lines	Patch %	Lines
hugr-py/src/hugr/ops.py	86.11%	5 Missing ⚠️
hugr-py/src/hugr/hugr/base.py	91.66%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2436      +/-   ##
==========================================
- Coverage   82.56%   81.99%   -0.57%     
==========================================
  Files         247      247              
  Lines       45892    45938      +46     
  Branches    41528    41528              
==========================================
- Hits        37889    37667     -222     
- Misses       5981     6249     +268     
  Partials     2022     2022              

Flag	Coverage Δ
python	85.26% <90.00%> (-5.99%)	⬇️

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.

[mark-koch]

Looks good 👍

I'm not sure if #2439 is fixed by this, could you add a test? Also not sure about #2438?

[mark-koch]

Is there an issue for this?

[aborgna-q]

Fixed the issue and removed the skip.

[mark-koch]

Should the hash also include the links? E.g. a list of successor hashes here?

[aborgna-q]

That would break with non-dag regions.
Since this is a hash of the whole hugr, including CFGs, I had avoid node orderings

[mark-koch]

Do we allow order edges on consts?

[aborgna-q]

Ah, hugr-rs doesn't allow it. Rolling back this change.

Apparently Input and Output restrict in/out order edges to only one direction, so I'll fix that too.

[aborgna-q]

I'm not sure if #2439 is fixed by this, could you add a test? Also not sure about #2438?

Tested, and fixed :)