Merge pull request h5py#2529 from h5py/h5s-select-same-shape

takluyver · web-flow · commit 55a88f3e62f2 · 2024-12-09T15:41:39.000Z
Expose H5Sselect_shape_same function
diff --git a/h5py/api_functions.txt b/h5py/api_functions.txt
@@ -495,6 +495,8 @@ hdf5:
   htri_t H5Sis_regular_hyperslab(hid_t spaceid)
   htri_t H5Sget_regular_hyperslab(hid_t spaceid, hsize_t* start, hsize_t* stride, hsize_t* count, hsize_t* block)
 
+  1.10.7 htri_t H5Sselect_shape_same(hid_t space1_id, hid_t space2_id)
+
 
   # === H5T - Datatypes =========================================================
 
diff --git a/h5py/h5s.pyx b/h5py/h5s.pyx
@@ -394,6 +394,10 @@ cdef class SpaceID(ObjectID):
             efree(start)
             efree(end)
 
+    IF HDF5_VERSION >= (1, 10, 7):
+        @with_phil
+        def select_shape_same(self, SpaceID space2):
+            return <bint>H5Sselect_shape_same(self.id, space2.id)
 
     @with_phil
     def select_all(self):
diff --git a/h5py/tests/test_h5s.py b/h5py/tests/test_h5s.py
@@ -0,0 +1,27 @@
+import pytest
+
+from h5py import h5s, version
+from h5py._selector import Selector
+
+class Helper:
+    def __init__(self, shape: tuple):
+        self.shape = shape
+
+    def __getitem__(self, item) -> h5s.SpaceID:
+        if not isinstance(item, tuple):
+            item = (item,)
+        space = h5s.create_simple(self.shape)
+        sel = Selector(space)
+        sel.make_selection(item)
+        return space
+
+
+@pytest.mark.skipif(version.hdf5_version_tuple < (1, 10, 7),
+                    reason='H5Sselect_shape_same not available')
+def test_same_shape():
+    s1 = Helper((5, 6))[:3, :4]
+    s2 = Helper((5, 6))[2:, 2:]
+    assert s1.select_shape_same(s2)
+
+    s3 = Helper((5, 6))[:4, :3]
+    assert not s1.select_shape_same(s3)
diff --git a/news/h5s-select-same-shape.rst b/news/h5s-select-same-shape.rst
@@ -0,0 +1,29 @@
+New features
+------------
+
+* <news item>
+
+Deprecations
+------------
+
+* <news item>
+
+Exposing HDF5 functions
+-----------------------
+
+* ``H5Sselect_shape_same`` exposed as :meth:`.SpaceID.select_shape_same`.
+
+Bug fixes
+---------
+
+* <news item>
+
+Building h5py
+-------------
+
+* <news item>
+
+Development
+-----------
+
+* <news item>
