Skip to content

Check Matches

hexa.check_matches

Summary

Verify that two hexa representations agree.

check_matches parses two representations — one YAML spec and/or ABC Python module each — and reports whether they describe the same port tree.


Notes

  • Uses PortNode.diff to produce human-readable difference strings.

Classes

Functions

check_matches

1
2
3
check_matches(
    path_a: str | Path, path_b: str | Path
) -> bool | list[str]

Verify two representations agree.

Parameters:

Name Type Description Default
path_a str | Path

Path to a .yaml or .py file.

required
path_b str | Path

Path to a .yaml or .py file.

required

Returns:

Type Description
bool | list[str]

bool | list[str]: True if they match exactly, otherwise a list of difference strings.