Qiskit / rustworkx
95%
main: 94%

LAST BUILD BRANCH: more-lockfiles
DEFAULT BRANCH: main
Repo Added
Files 116
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst

LAST BUILD ON BRANCH gh-readonly-queue/main/pr-1464-b3bfd7a6cba44e38b82ced3627dd7409ef611f43
branch: gh-readonly-queue/main/pr-1464-b3bfd7a6cba44e38b82ced3627dd7409ef611f43
CHANGE BRANCH
x

coverage: 95.201% (-0.08%) from 95.283%
15708015562

push

github

web-flow 
Fix #840: Add GraphML serializer (#1464)

* Fix #840: Add GraphML serializer

This commit adds a GraphML serializer:

```python
def write_graphml(
    graphs: list[PyGraph | PyDiGraph],
    keys: list[tuple[str, Domain, str, Type, Any]],
    path: str,
    /,
    compression: str | None = ...,
) -> None: ...
```

`keys` is a list of tuples: id, domain, name of the key, type, and
default value. This commit also introduces the
`read_graphml_with_keys` function, which returns the key definitions
in the same format, along with the list of parsed graphs.

The implementation preserves the ids of graphs, nodes, and edges when
possible. If some ids conflict, fresh ids are generated in the written
GraphML file. The `read_graphml` function has also been updated to
store the graph id in the graph attributes, just like node and edge
ids are stored in the corresponding attributes.

The `write_graphml` function supports gzip compression, as does
`read_graphml`.

Note that the JSON node-link serializer (the other part of #840) was
already implemented in #1091.

Compared to #1462:

- Keys are passed explicitly instead of being inferred (which allows
to use the types `float` and `int`, and to use default values);

- Attributes for graphs, nodes, and edges are taken from the weight of elements, instead of relying on callbacks. This allows write_graphml to act as a proper reciprocal of read_graphml. Round-trip tests have been added.

- IDs are taken from attributes when possible, instead of being generated from indices.

- Multiple graphs can be written to the same file.

- Gzip compression is supported.

- Tests have been added.

Regarding @IvanIsCoding's
comment (https://github.com/Qiskit/rustworkx/pull/1462#issuecomment-2951935390),
about using https://github.com/jonasbb/petgraph-graphml:

- Rustworkx's `graphml.rs` introduces an internal `Graph` data
structure, which is used for `read_graphml`. It is natural to
have `write_graphml` rely on the same data structure.

... (continued)

447 of 487 new or added lines in 2 files covered. (91.79%)

19383 of 20360 relevant lines covered (95.2%)

1033394.12 hits per line

Relevant lines Covered
20360 RELEVANT LINES 19383 COVERED LINES
1033394.12 HITS PER LINE
Source Files on gh-readonly-queue/main/pr-1464-b3bfd7a6cba44e38b82ced3627dd7409ef611f43

Recent builds

Builds Branch Commit Type Ran Committer Via Coverage
15708015562 gh-readonly-queue/main/pr-1464-b3bfd7a6cba44e38b82ced3627dd7409ef611f43 Fix #840: Add GraphML serializer (#1464) * Fix #840: Add GraphML serializer This commit adds a GraphML serializer: ```python def write_graphml( graphs: list[PyGraph | PyDiGraph], keys: list[tuple[str, Domain, str, Type, Any]], path:... push web-flow github
95.2
See All Builds (2320)