iplotx 0.8.0__tar.gz → 0.9.0__tar.gz

{iplotx-0.8.0 → iplotx-0.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: iplotx
-Version: 0.8.0
+Version: 0.9.0
 Summary: Plot networkx from igraph and networkx.
 Project-URL: Homepage, https://github.com/fabilab/iplotx
 Project-URL: Documentation, https://readthedocs.org/iplotx

{iplotx-0.8.0 → iplotx-0.9.0}/iplotx/__init__.py

@@ -9,19 +9,19 @@ library was used to construct the network.
 from .version import __version__
 from .plotting import (
     network,
+    graph,
     tree,
+    plot,
 )
 import iplotx.artists as artists
 import iplotx.style as style
 
 
-# Shortcut to iplotx.plotting.network
-plot = network
-
 __all__ = [
     "network",
     "tree",
     "plot",
+    "graph",
     "artists",
     "style",
     "__version__",

{iplotx-0.8.0 → iplotx-0.9.0}/iplotx/plotting.py

@@ -22,6 +22,7 @@ def network(
     layout: Optional[LayoutType] = None,
     grouping: Optional[GroupingType] = None,
     vertex_labels: Optional[list | dict | pd.Series | bool] = None,
+    node_labels: Optional[list | dict | pd.Series | bool] = None,
     edge_labels: Optional[Sequence] = None,
     ax: Optional[mpl.axes.Axes] = None,
     style: str | dict | Sequence[str | dict] = (),
@@ -42,6 +43,9 @@ def network(
             will be drawn. If a list, the labels are taken from the list. If a dict, the keys
             should be the vertex IDs and the values should be the labels. If True (a single
             bool value), the vertex IDs will be used as labels.
+        node_labels: Same meaning as vertex_labels. This is an alias to help users who prefer
+            the word "node" over "vertex". If both vertex_labels and node_labels are specified,
+            "node_labels" overrides "vertex_labels".
         edge_labels: The labels for the edges. If None, no edge labels will be drawn. Defaults
             to None.
         ax: The axis to plot on. If None, a new figure and axis will be created. Defaults to
@@ -68,6 +72,11 @@ def network(
         The list can have one or two elements, depending on whether you are requesting to
         plot a network, a grouping, or both.
     """
+    # Equivalence of node_labels and vertex_labels
+    if node_labels is not None:
+        vertex_labels = node_labels
+    del node_labels
+
     stylecontext = context(style, **kwargs) if style or kwargs else nullcontext()
 
     with stylecontext:
@@ -126,11 +135,17 @@ def network(
         return artists
 
 
+# Aliases
+plot = network
+graph = network
+
+
 def tree(
     tree: Optional[TreeType] = None,
     layout: str | LayoutType = "horizontal",
     directed: bool | str = False,
     vertex_labels: Optional[list | dict | pd.Series | bool] = None,
+    node_labels: Optional[list | dict | pd.Series | bool] = None,
     leaf_labels: Optional[list | dict | pd.Series | bool] = None,
     show_support: bool = False,
     ax: Optional[mpl.axes.Axes] = None,
@@ -150,6 +165,9 @@ def tree(
         directed: If False, do not draw arrows.
         vertex_labels: The labels for the vertices. If None or False, no vertex labels. Also
             read leaf_labels for leaf nodes.
+        node_labels: Same meaning as vertex_labels. This is an alias to help users who prefer
+            the word "node" over "vertex". If both vertex_labels and node_labels are specified,
+            "node_labels" overrides "vertex_labels".
         leaf_labels: The labels for the leaf nodes. If None or False, no leaf labels are used
             except if vertex_labels are specified for leaf nodes. This argument and the
             previous vertex_labels provide somewhat redundant functionality but have quite
@@ -183,6 +201,11 @@ def tree(
     Returns:
         A TreeArtist object, set as a direct child of the matplotlib Axes.
     """
+    # Equivalence of node_labels and vertex_labels
+    if node_labels is not None:
+        vertex_labels = node_labels
+    del node_labels
+
     stylecontext = context(style, **kwargs) if style or kwargs else nullcontext()
 
     with stylecontext:

{iplotx-0.8.0 → iplotx-0.9.0}/iplotx/version.py

@@ -2,4 +2,4 @@
 iplotx version information module.
 """
 
-__version__ = "0.8.0"
+__version__ = "0.9.0"

{iplotx-0.8.0 → iplotx-0.9.0}/tests/test_igraph.py

@@ -31,19 +31,19 @@ class GraphTestRunner(unittest.TestCase):
     def test_basic(self):
         g = ig.Graph.Ring(5)
         fig, ax = plt.subplots(figsize=(3, 3))
-        ipx.plot(g, ax=ax, layout=self.layout_small_ring)
+        ipx.graph(g, ax=ax, layout=self.layout_small_ring)
 
     @image_comparison(baseline_images=["graph_directed"], remove_text=True)
     def test_directed(self):
         g = ig.Graph.Ring(5, directed=True)
         fig, ax = plt.subplots(figsize=(3, 3))
-        ipx.plot(g, ax=ax, layout=self.layout_small_ring)
+        ipx.graph(g, ax=ax, layout=self.layout_small_ring)
 
     @image_comparison(baseline_images=["graph_vertexsize"], remove_text=True)
     def test_vertexsize(self):
         g = ig.Graph.Ring(5)
         fig, ax = plt.subplots(figsize=(3, 3))
-        ipx.plot(
+        ipx.graph(
             g,
             ax=ax,
             layout=self.layout_small_ring,
@@ -55,7 +55,7 @@ class GraphTestRunner(unittest.TestCase):
     def test_labels(self):
         g = ig.Graph.Ring(5)
         fig, ax = plt.subplots(figsize=(3, 3))
-        ipx.plot(
+        ipx.graph(
             network=g,
             ax=ax,
             layout=self.layout_small_ring,
@@ -76,14 +76,14 @@ class GraphTestRunner(unittest.TestCase):
         g = ig.Graph.Ring(5)
         layout = g.layout("circle")
         fig, ax = plt.subplots(figsize=(3, 3))
-        ipx.plot(g, layout=layout, ax=ax)
+        ipx.graph(g, layout=layout, ax=ax)
 
     @image_comparison(baseline_images=["graph_layout_attribute"], remove_text=True)
     def test_layout_attribute_alt(self):
         g = ig.Graph.Ring(5)
         g["layout"] = ig.Layout([(x, x) for x in range(g.vcount())])
         fig, ax = plt.subplots(figsize=(3, 3))
-        ipx.plot(g, layout="layout", ax=ax)
+        ipx.graph(g, layout="layout", ax=ax)
 
     @image_comparison(baseline_images=["graph_directed_curved_loops"], remove_text=True)
     def test_directed_curved_loops(self):
@@ -94,7 +94,7 @@ class GraphTestRunner(unittest.TestCase):
         fig, ax = plt.subplots(figsize=(4, 4))
         # ax.set_xlim(-1.2, 1.2)
         # ax.set_ylim(-1.2, 1.2)
-        ipx.plot(
+        ipx.graph(
             g,
             ax=ax,
             layout=self.layout_small_ring,
@@ -112,7 +112,7 @@ class GraphTestRunner(unittest.TestCase):
     def test_mark_groups_squares(self):
         g = ig.Graph.Ring(5, directed=True)
         fig, ax = plt.subplots(figsize=(3, 3))
-        ipx.plot(
+        ipx.graph(
             g,
             ax=ax,
             layout=self.layout_small_ring,
@@ -125,7 +125,7 @@ class GraphTestRunner(unittest.TestCase):
     def test_edit_children(self):
         g = ig.Graph.Ring(5)
         fig, ax = plt.subplots(figsize=(4, 4))
-        ipx.plot(
+        ipx.graph(
             g,
             ax=ax,
             style={"vertex": {"marker": "o"}},
@@ -148,7 +148,7 @@ class GraphTestRunner(unittest.TestCase):
         fig, ax = plt.subplots()
         lo = g.layout("circle")
         lo.scale(3)
-        ipx.plot(
+        ipx.graph(
             g,
             ax=ax,
             layout=lo,
@@ -176,7 +176,7 @@ class GraphTestRunner(unittest.TestCase):
         fig, ax = plt.subplots()
         lo = g.layout("circle")
         lo.scale(3)
-        ipx.plot(
+        ipx.graph(
             g,
             ax=ax,
             layout=lo,
@@ -201,7 +201,7 @@ class GraphTestRunner(unittest.TestCase):
     def test_null_graph(self):
         g = ig.Graph()
         fig, ax = plt.subplots()
-        ipx.plot(g, ax=ax)
+        ipx.graph(g, ax=ax)
         ax.set_aspect(1.0)
 
 
@@ -278,14 +278,14 @@ class ClusteringTestRunner(unittest.TestCase):
         g = ig.Graph.Ring(5, directed=True)
         clu = ig.VertexClustering(g, [0] * 5)
         fig, ax = plt.subplots()
-        ipx.plot(g, grouping=clu, ax=ax, layout=self.layout_small_ring)
+        ipx.graph(g, grouping=clu, ax=ax, layout=self.layout_small_ring)
 
     @image_comparison(baseline_images=["clustering_directed_large"], remove_text=True)
     def test_clustering_directed_large(self):
         g = ig.Graph.Ring(50, directed=True)
         clu = ig.VertexClustering(g, [0] * 3 + [1] * 17 + [2] * 30)
         fig, ax = plt.subplots()
-        ipx.plot(
+        ipx.graph(
             g,
             grouping=clu,
             style={

{iplotx-0.8.0 → iplotx-0.9.0}/tests/test_networkx.py

@@ -26,14 +26,14 @@ class GraphTestRunner(unittest.TestCase):
             ]
         )
         pos = {1: (0, 0), 2: (-1, 0.3), 3: (2, 0.17), 4: (4, 0.255), 5: (5, 0.03)}
-        ipx.plot(
+        ipx.network(
             G,
             layout=pos,
-            vertex_labels=False,
-            vertex_size=5,
-            vertex_facecolor="white",
-            vertex_edgecolor="black",
-            vertex_linewidth=3,
+            node_labels=False,
+            node_size=5,
+            node_facecolor="white",
+            node_edgecolor="black",
+            node_linewidth=3,
             edge_linewidth=3,
             edge_color=["grey", "black"],
             margins=0.1,
@@ -52,10 +52,10 @@ class GraphTestRunner(unittest.TestCase):
         # explicitly set positions
         pos = {1: (0, 0), 2: (-1, 0.3), 3: (2, 0.17), 4: (4, 0.255), 5: (5, 0.03)}
 
-        ipx.plot(
+        ipx.network(
             G,
             layout=pos,
-            vertex_labels=True,
+            node_labels=True,
             style={
                 "vertex": {
                     "size": "label",
@@ -224,11 +224,11 @@ class GraphTestRunner(unittest.TestCase):
         )
 
         fig, ax = plt.subplots()
-        ipx.plot(
+        ipx.network(
             G,
             ax=ax,
             layout="pos",
-            vertex_labels=True,
+            node_labels=True,
             edge_labels=True,
         )
 
@@ -298,11 +298,11 @@ class GraphTestRunner(unittest.TestCase):
         )
 
         fig, ax = plt.subplots(figsize=(5, 4))
-        ipx.plot(
+        ipx.network(
             G,
             ax=ax,
             layout="pos",
-            vertex_labels=True,
+            node_labels=True,
             style={
                 "vertex": {
                     "facecolor": G.nodes.data("color"),