yirgacheffe 1.7.1__tar.gz → 1.7.2__tar.gz

{yirgacheffe-1.7.1/yirgacheffe.egg-info → yirgacheffe-1.7.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: yirgacheffe
-Version: 1.7.1
+Version: 1.7.2
 Summary: Abstraction of gdal datasets for doing basic math operations
 Author-email: Michael Dales <mwd24@cam.ac.uk>
 License-Expression: ISC

{yirgacheffe-1.7.1 → yirgacheffe-1.7.2}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "yirgacheffe"
-version = "1.7.1"
+version = "1.7.2"
 description = "Abstraction of gdal datasets for doing basic math operations"
 readme = "README.md"
 authors = [{ name = "Michael Dales", email = "mwd24@cam.ac.uk" }]

{yirgacheffe-1.7.1 → yirgacheffe-1.7.2}/tests/test_operators.py

@@ -1472,42 +1472,54 @@ def test_to_geotiff_single_thread_and_sum() -> None:
             assert (expected == actual).all()
 
 @pytest.mark.skipif(yirgacheffe._backends.BACKEND != "NUMPY", reason="Only applies for numpy")
-def test_to_geotiff_parallel_thread(monkeypatch) -> None:
-    data1 = np.array([[1, 2, 3, 4], [5, 6, 7, 8]])
-    layer1 = RasterLayer(gdal_dataset_with_data((0.0, 0.0), 0.02, data1))
-
-    calc = layer1 * 2
-
-    with tempfile.TemporaryDirectory() as tempdir:
-        filename = os.path.join(tempdir, "test.tif")
-        with monkeypatch.context() as m:
-            m.setattr(yirgacheffe.constants, "YSTEP", 1)
-            calc.to_geotiff(filename, parallelism=2)
-
-        with RasterLayer.layer_from_file(filename) as result:
-            expected = data1 * 2
-            actual = result.read_array(0, 0, 4, 2)
-            assert (expected == actual).all()
+@pytest.mark.parametrize("parallelism", [
+    2,
+    True,
+])
+def test_to_geotiff_parallel_thread(monkeypatch, parallelism) -> None:
+    with monkeypatch.context() as m:
+        m.setattr(yirgacheffe.constants, "YSTEP", 1)
+        m.setattr(LayerOperation, "save", None)
+        with tempfile.TemporaryDirectory() as tempdir:
+            data1 = np.array([[1, 2, 3, 4], [5, 6, 7, 8]])
+            src_filename = os.path.join("src.tif")
+            dataset = gdal_dataset_with_data((0.0, 0.0), 0.02, data1, filename=src_filename)
+            dataset.Close()
+            with yirgacheffe.read_raster(src_filename) as layer1:
+                calc = layer1 * 2
+                filename = os.path.join(tempdir, "test.tif")
+                calc.to_geotiff(filename, parallelism=parallelism)
+
+                with RasterLayer.layer_from_file(filename) as result:
+                    expected = data1 * 2
+                    actual = result.read_array(0, 0, 4, 2)
+                    assert (expected == actual).all()
 
 @pytest.mark.skipif(yirgacheffe._backends.BACKEND != "NUMPY", reason="Only applies for numpy")
-def test_to_geotiff_parallel_thread_and_sum(monkeypatch) -> None:
-    data1 = np.array([[1, 2, 3, 4], [5, 6, 7, 8]])
-    layer1 = RasterLayer(gdal_dataset_with_data((0.0, 0.0), 0.02, data1))
-
-    calc = layer1 * 2
-
-    with tempfile.TemporaryDirectory() as tempdir:
-        filename = os.path.join(tempdir, "test.tif")
-        with monkeypatch.context() as m:
-            m.setattr(yirgacheffe.constants, "YSTEP", 1)
-            actual_sum = calc.to_geotiff(filename, and_sum=True)
-
-        assert (data1.sum() * 2) == actual_sum
-
-        with RasterLayer.layer_from_file(filename) as result:
-            expected = data1 * 2
-            actual = result.read_array(0, 0, 4, 2)
-            assert (expected == actual).all()
+@pytest.mark.parametrize("parallelism", [
+    2,
+    True,
+])
+def test_to_geotiff_parallel_thread_and_sum(monkeypatch, parallelism) -> None:
+    with monkeypatch.context() as m:
+        m.setattr(yirgacheffe.constants, "YSTEP", 1)
+        m.setattr(LayerOperation, "save", None)
+        with tempfile.TemporaryDirectory() as tempdir:
+            data1 = np.array([[1, 2, 3, 4], [5, 6, 7, 8]])
+            src_filename = os.path.join("src.tif")
+            dataset = gdal_dataset_with_data((0.0, 0.0), 0.02, data1, filename=src_filename)
+            dataset.Close()
+            with yirgacheffe.read_raster(src_filename) as layer1:
+                filename = os.path.join(tempdir, "test.tif")
+                calc = layer1 * 2
+                actual_sum = calc.to_geotiff(filename, and_sum=True, parallelism=parallelism)
+
+                assert (data1.sum() * 2) == actual_sum
+
+                with RasterLayer.layer_from_file(filename) as result:
+                    expected = data1 * 2
+                    actual = result.read_array(0, 0, 4, 2)
+                    assert (expected == actual).all()
 
 def test_raster_and_vector() -> None:
     with tempfile.TemporaryDirectory() as tempdir:

{yirgacheffe-1.7.1 → yirgacheffe-1.7.2}/yirgacheffe/operators.py

@@ -251,7 +251,7 @@ class LayerMathMixin:
         self,
         filename: Union[Path,str],
         and_sum: bool = False,
-        parallelism:Optional[int]=None
+        parallelism:Optional[Union[int,bool]]=None
     ) -> Optional[float]:
         return LayerOperation(self).to_geotiff(filename, and_sum, parallelism)
 
@@ -899,7 +899,7 @@ class LayerOperation(LayerMathMixin):
         self,
         filename: Union[Path,str],
         and_sum: bool = False,
-        parallelism:Optional[int]=None
+        parallelism:Optional[Union[int,bool]] = None
     ) -> Optional[float]:
         """Saves a calculation to a raster file, optionally also returning the sum of pixels.
 
@@ -909,8 +909,9 @@ class LayerOperation(LayerMathMixin):
             Path of the raster to save the result to.
         and_sum : bool, default=False
             If true then the function will also calculate the sum of the raster as it goes and return that value.
-        parallelism : int, optional, default=None
-            If passed, attempt to use multiple CPU cores up to the number provided.
+        parallelism : int or bool, optional, default=None
+            If passed, attempt to use multiple CPU cores up to the number provided, or if set to True, yirgacheffe
+            will pick a sensible value.
 
         Returns
         -------
@@ -932,6 +933,9 @@ class LayerOperation(LayerMathMixin):
                 if parallelism is None:
                     result = self.save(layer, and_sum=and_sum)
                 else:
+                    if isinstance(parallelism, bool):
+                        # Parallel save treats None as "work it out"
+                        parallelism = None
                     result = self.parallel_save(layer, and_sum=and_sum, parallelism=parallelism)
 
             os.makedirs(target_dir, exist_ok=True)

{yirgacheffe-1.7.1 → yirgacheffe-1.7.2/yirgacheffe.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: yirgacheffe
-Version: 1.7.1
+Version: 1.7.2
 Summary: Abstraction of gdal datasets for doing basic math operations
 Author-email: Michael Dales <mwd24@cam.ac.uk>
 License-Expression: ISC