A Hypothesis strategy for generating NetworkX graphs
Project description
Hypothesisnetworkx
This module provides a Hypothesis strategy for generating networkx graphs. This can be used to efficiently and thoroughly test your code.
Installation
This module can be installed via pip
:
pip install hypothesisnetworkx
User guide
The module exposes a single function: graph_builder
. This function is a
hypothesis composite strategy for building graphs. You can use it as follows:
from hypothesis_networkx import graph_builder
from hypothesis import strategies as st
import networkx as nx
node_data = st.fixed_dictionaries({'name': st.text(),
'number': st.integers()})
edge_data = st.fixed_dictionaries({'weight': st.floats(allow_nan=False,
allow_infinity=False)})
builder = graph_builder(graph_type=nx.Graph,
node_keys=st.integers(),
node_data=node_data,
edge_data=edge_data,
min_nodes=2, max_nodes=10,
min_edges=1, max_edges=None,
self_loops=False,
connected=True)
graph = builder.example()
print(graph.nodes(data=True))
print(graph.edges(data=True))
Of course this builder is a valid hypothesis strategy, and using it to just make examples is not super useful. Instead, you can (and should) use it in your testing framework:
from hypothesis import given
@given(graph=builder)
def test_my_function(graph):
assert my_function(graph) == known_function(graph)
The meaning of the arguments given to graph_builder
are pretty
selfexplanatory, but they must be given as keyword arguments.
node_data
: The strategy from which node attributes will be drawn.edge_data
: The strategy from which edge attributes will be drawn.node_keys
: Either the strategy from which node keys will be draw, or None. If None, node keys will be integers from the range (0, number of nodes).min_nodes
andmax_nodes
: The minimum and maximum number of nodes the produced graphs will contain.min_edges
andmax_edges
: The minimum and maximum number of edges the produced graphs will contain. Note that less edges thanmin_edges
may be added if there are not enough nodes, and more thanmax_edges
ifconnected
is True.graph_type
: This function (or class) will be called without arguments to create an empty initial graph.connected
: If True, the generated graph is guaranteed to be a single connected component.self_loops
: If False, there will be no selfloops in the generated graph. Selfloops are edges between a node and itself.
Known limitations
There are a few (minor) outstanding issues with this module:
 Graph generation may be slow for large graphs.
 The
min_edges
argument is not always respected when the produced graph is too small.  The
max_edges
argument is not always respected ifconnected
is True.  It currently works for Python 2.7, but this is considered deprecated and may stop working without notice.
See also
Project details
Release history Release notifications  RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for hypothesis_networkx0.3.0.tar.gz
Algorithm  Hash digest  

SHA256  a8211dec83cbeea6b3fcddd9fc6879d852d15f7a3bc2896045057d0cd67ebfbe 

MD5  4b58575a4307edf3ee2b083589174535 

BLAKE2b256  6aa19300093166310e734dad3396531c38a3e32f0da3b977884e7899d74f7a0d 
Hashes for hypothesis_networkx0.3.0py2.py3noneany.whl
Algorithm  Hash digest  

SHA256  85ae8c4986cd311f0edebcf720b4b3a31ffa7800d560b6f1aa85efb38b4178eb 

MD5  a47c2521909ff6595942709604dddf98 

BLAKE2b256  1dd20a05f16d030f96e91e4e89fa0be96f7554b7c0d9992c5ec716fc6608df93 