Note

This documents the development version of NetworkX. Documentation for the current release can be found here.

networkx.readwrite.sparse6.to_sparse6_bytes

to_sparse6_bytes(G, nodes=None, header=True)[source]

Convert an undirected graph to bytes in sparse6 format.

Parameters
GGraph (undirected)
nodes: list or iterable

Nodes are labeled 0…n-1 in the order provided. If None the ordering given by G.nodes() is used.

header: bool

If True add ‘>>sparse6<<’ bytes to head of data.

Raises
NetworkXNotImplemented

If the graph is directed.

ValueError

If the graph has at least 2 ** 36 nodes; the sparse6 format is only defined for graphs of order less than 2 ** 36.

See also

to_sparse6_bytes, read_sparse6, write_sparse6_bytes

Notes

The returned bytes end with a newline character.

The format does not support edge or node labels.

References

1

Graph6 specification <http://users.cecs.anu.edu.au/~bdm/data/formats.html>

Examples

>>> nx.to_sparse6_bytes(nx.path_graph(2))
b'>>sparse6<<:An\n'