Wayfarer Module API

These are top-level classes and function.

class wayfarer.Edge(start_node: int | str, end_node: int | str, key: int | str, attributes: dict)

Bases: NamedTuple

A class representing a network edge

attributes: dict

Alias for field number 3

end_node: int | str

Alias for field number 1

key: int | str

Alias for field number 2

start_node: int | str

Alias for field number 0

wayfarer.to_edge(edge)

Convert a tuple into an Edge namedtuple

Return type:

Edge

>>> to_edge((0, 1, 1, {"LEN_": 10}))
Edge(start_node=0, end_node=1, key=1, attributes={'LEN_': 10})

>>> to_edge((0, 1, 1))
Edge(start_node=0, end_node=1, key=1, attributes={})

wayfarer.to_edges(edges)

Convert a list of tuples to a list of Edges

Return type:

list[Edge]

>>> tuples = [(0, 1, 1, {"LEN_": 10}), (1, 2, 2, {"LEN_": 20})]
>>> to_edges(tuples)
[Edge(start_node=0, end_node=1, key=1, attributes={'LEN_': 10}), Edge(start_node=1, end_node=2, key=2, attributes={'LEN_': 20})]