dedicated minimal tests -- nodes.get_components() (#57)

* dedicated testing for nodes.get_components()

* add lil typehint + docstring for nodes._status()

Author: jGaboardi

sgeop/geometry.py

@@ -104,13 +104,13 @@ def voronoi_skeleton(
     secondary_snap_to: None | gpd.GeoSeries = None,
     clip_limit: None | int = 2,
     consolidation_tolerance: None | float = None,
-):
+) -> tuple[np.ndarray]:
     """
     Returns average geometry.
 
     Parameters
     ----------
-    lines : array_like
+    lines : list | numpy.ndarray | geopandas.GeoSeries
         LineStrings connected at endpoints. If ``poly`` is passed in, ``lines``
         must be a ``geopandas.GeoSeries``.
     poly : None | shapely.Polygon = None
@@ -136,8 +136,10 @@ def voronoi_skeleton(
 
     Returns
     -------
-    numpy.ndarray
+    edgelines : numpy.ndarray
         Array of averaged geometries.
+    splitters : numpy.ndarray
+        Split points.
     """
     if buffer is None:
         buffer = max_segment_length * 20

sgeop/nodes.py

@@ -74,15 +74,37 @@ def _snap_n_split(e: shapely.LineString, s: shapely.Point, tol: float) -> np.nda
     return _lines_split[~shapely.is_empty(_lines_split)]
 
 
-def _status(x):
+def _status(x: pd.Series) -> str:
+    """Determine the status of edge line(s)."""
     if len(x) == 1:
         return x.iloc[0]
     if "new" in x:
         return "new"
     return "changed"
 
 
-def get_components(edgelines, ignore=None):
+def get_components(
+    edgelines: list | np.ndarray | gpd.GeoSeries,
+    ignore: None | gpd.GeoSeries = None,
+) -> np.ndarray:
+    """Associate edges with connected component labels and return.
+
+    Parameters
+    ----------
+    edgelines : list | np.ndarray | gpd.GeoSeries
+        Collection of line objects.
+    ignore : None | gpd.GeoSeries = None
+        Nodes to ignore when labeling components.
+
+    Returns
+    -------
+    np.ndarray
+        Edge connected component labels.
+
+    Notes
+    -----
+    See [https://github.com/uscuni/sgeop/issues/56] for detailed explanation of output.
+    """
     edgelines = np.array(edgelines)
     start_points = shapely.get_point(edgelines, 0)
     end_points = shapely.get_point(edgelines, -1)

sgeop/tests/test_nodes.py

@@ -180,3 +180,77 @@ def test_split(split_points, cleaned_roads, known):
 def test_snap_n_split(edge, split_point, tol, known):
     observed = sgeop.nodes._snap_n_split(edge, split_point, tol)
     numpy.testing.assert_array_equal(observed, known)
+
+
+line_3_4 = shapely.LineString((point_3, point_4))
+line_4_5 = shapely.LineString((point_4, point_5))
+line_234 = shapely.LineString((point_2, point_3, point_4))
+
+edgeline_types_get_components = [
+    [line_1_2, line_2_4],
+    numpy.array([line_1_2, line_3_4]),
+    geopandas.GeoSeries([line_1_2, line_234]),
+    [line_1_2, line_2_4] + [line_4_5],
+]
+
+ignore_types_get_components = [
+    None,
+    point_2,
+    [point_2],
+    numpy.array([point_3]),
+    geopandas.GeoSeries([point_3]),
+]
+
+cases_types_get_components = [
+    list(c)
+    for c in itertools.product(
+        edgeline_types_get_components, ignore_types_get_components
+    )
+]
+
+known_get_components = [
+    [0, 0],
+    [2.0, 3.0],
+    [2.0, 3.0],
+    [0, 0],
+    [0, 0],
+    [2.0, 3.0],
+    [2.0, 3.0],
+    [2.0, 3.0],
+    [2.0, 3.0],
+    [2.0, 3.0],
+    [0, 0],
+    [2.0, 3.0],
+    [2.0, 3.0],
+    [0, 0],
+    [0, 0],
+    [0, 0, 0],
+    [1.0, 0.0, 0.0],
+    [1.0, 0.0, 0.0],
+    [0, 0, 0],
+    [0, 0, 0],
+]
+
+cases_get_components = [
+    (*arg12, arg3)
+    for arg12, arg3 in list(
+        zip(cases_types_get_components, known_get_components, strict=True)
+    )
+]
+
+
+t1_get_components = ["list", "ndarray", "GeoSeries", "list"]
+t2_get_components = ["NoneType", "Point", "list", "ndarray", "GeoSeries"]
+case_ids_get_components = [
+    "-".join(c) for c in itertools.product(t1_get_components, t2_get_components)
+]
+
+
+@pytest.mark.parametrize(
+    "edgelines,ignore,known",
+    cases_get_components,
+    ids=case_ids_get_components,
+)
+def test_get_components(edgelines, ignore, known):
+    observed = sgeop.nodes.get_components(edgelines, ignore=ignore)
+    numpy.testing.assert_array_equal(observed, known)