ENH: implement __repr__ for the index (#65)

* implement __repr__ showing geoms * execute notebooks * backwards compat
xarray-contrib · Apr 22, 2024 · 2e55fbb · 2e55fbb
1 parent 4e808e8
commit 2e55fbb
Show file tree

Hide file tree

Showing 9 changed files with 909 additions and 522 deletions.
diff --git a/doc/source/extract_pts.ipynb b/doc/source/extract_pts.ipynb
diff --git a/doc/source/geopandas.ipynb b/doc/source/geopandas.ipynb
diff --git a/doc/source/indexing.ipynb b/doc/source/indexing.ipynb
diff --git a/doc/source/intro.ipynb b/doc/source/intro.ipynb
diff --git a/doc/source/io.ipynb b/doc/source/io.ipynb
diff --git a/doc/source/projections.ipynb b/doc/source/projections.ipynb
diff --git a/doc/source/zonal_stats.ipynb b/doc/source/zonal_stats.ipynb
diff --git a/xvec/index.py b/xvec/index.py
@@ -273,3 +273,20 @@ def _repr_inline_(self, max_width: int) -> str:
 
         srs = _format_crs(self.crs, max_width=max_width)
         return f"{self.__class__.__name__} (crs={srs})"
+
+    def __repr__(self) -> str:
+        srs = _format_crs(self.crs)
+        shape = self._index.index.shape[0]
+        if shape < 10:
+            wkts = [repr(g) for g in self._index.index]
+        else:
+            wkts = [repr(g) for g in self._index.index[:4]]
+            wkts.append("...")
+            wkts = wkts + [repr(g) for g in self._index.index[-4:]]
+
+        if len(wkts) == 1:
+            return f"GeometryIndex([{wkts[0]}], crs={srs})"
+        joined = "\n ".join(wkts[1:])
+        return f"GeometryIndex(\n[{wkts[0]}\n {joined}],\ncrs={srs})".replace(
+            "\n", "\n" + " " * 4
+        )
diff --git a/xvec/tests/test_index.py b/xvec/tests/test_index.py
@@ -172,3 +172,24 @@ def test_repr_inline(geom_dataset, geom_dataset_no_crs):
     actual = geom_dataset_no_crs.xindexes["geom"]._repr_inline_(70)
     expected = "GeometryIndex (crs=None)"
     assert actual == expected
+
+
+def test_repr(geom_dataset, geom_dataset_no_crs):
+    actual = repr(geom_dataset.xindexes["geom"])
+    expected = (
+        "GeometryIndex(\n    [<POINT (1 2)>\n     <POINT (3 4)>],\n    crs=EPSG:26915)"
+    )
+    assert actual == expected
+
+    actual = repr(geom_dataset_no_crs.xindexes["geom"])
+    expected = "GeometryIndex(\n    [<POINT (1 2)>\n     <POINT (3 4)>],\n    crs=None)"
+    assert actual == expected
+
+    single = geom_dataset.sel(geom=[shapely.Point(1, 2)])
+    actual = repr(single.xindexes["geom"])
+    expected = "GeometryIndex([<POINT (1 2)>], crs=EPSG:26915)"
+    assert actual == expected
+
+    long = xr.concat([geom_dataset] * 10, dim="geom")
+    actual = repr(long.xindexes["geom"])
+    expected = "GeometryIndex(\n    [<POINT (1 2)>\n     <POINT (3 4)>\n     <POINT (1 2)>\n     <POINT (3 4)>\n     ...\n     <POINT (1 2)>\n     <POINT (3 4)>\n     <POINT (1 2)>\n     <POINT (3 4)>],\n    crs=EPSG:26915)"