Fix tests in main (#258)

* updated target image with artficat from runner

* increased DPI to reduce test flakyness due to pixel precision

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* added tight layout

* Regenerated images

* added images from runner

* attempt to force the runner to a fixed res

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* bump

* added figures from runner

* attempt to fix inconsistency across runners

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: timtreis

pyproject.toml

@@ -47,6 +47,7 @@ docs = [
 test = [
     "pytest",
     "pytest-cov",
+    "pooch", # for scipy.datasets module
 ]
 # this will be used by readthedocs and will make pip also look for pre-releases, generally installing the latest available version
 pre = [

pyproject.toml.rej

@@ -14,7 +14,6 @@
 from geopandas import GeoDataFrame
 from matplotlib.testing.compare import compare_images
 from multiscale_spatial_image import MultiscaleSpatialImage
-from numpy.random import default_rng
 from shapely.geometry import MultiPolygon, Polygon
 from spatial_image import SpatialImage
 from spatialdata import SpatialData
@@ -35,9 +34,9 @@
 EXPECTED = HERE / "_images"
 ACTUAL = HERE / "figures"
 TOL = 60
-DPI = 40
+DPI = 80
 
-RNG = default_rng()
+RNG = np.random.default_rng(seed=42)
 
 
 @pytest.fixture()
@@ -375,12 +374,19 @@ def compare(cls, basename: str, tolerance: Optional[float] = None):
         ACTUAL.mkdir(parents=True, exist_ok=True)
         out_path = ACTUAL / f"{basename}.png"
 
+        width, height = 400, 300  # fixed dimensions so runners don't change
+        fig = plt.gcf()
+        fig.set_size_inches(width / DPI, height / DPI)
+        fig.set_dpi(DPI)
+
+        # Apply constrained layout and save the plot
+        fig.set_constrained_layout(True)
         plt.savefig(out_path, dpi=DPI)
         plt.close()
 
         if tolerance is None:
             # see https://github.com/scverse/squidpy/pull/302
-            tolerance = 2 * TOL if "Napari" in str(basename) else TOL
+            tolerance = 2 * TOL if "Napari" in basename else TOL
 
         res = compare_images(str(EXPECTED / f"{basename}.png"), str(out_path), tolerance)
 

tests/_images/Extent_correct_plot_after_transformations.png

@@ -11,12 +11,14 @@
 from spatialdata.models import PointsModel, ShapesModel
 from spatialdata.transformations import Affine, set_transformation
 
-from tests.conftest import PlotTester, PlotTesterMeta
+from tests.conftest import DPI, PlotTester, PlotTesterMeta
 
+RNG = np.random.default_rng(seed=42)
 sc.pl.set_rcParams_defaults()
-sc.set_figure_params(dpi=40, color_map="viridis")
+sc.set_figure_params(dpi=DPI, color_map="viridis")
 matplotlib.use("agg")  # same as GitHub action runner
 _ = spatialdata_plot
+plt.tight_layout()
 
 # WARNING:
 # 1. all classes must both subclass PlotTester and use metaclass=PlotTesterMeta

tests/_images/Extent_extent_calculation_respects_element_selection_circles.png

@@ -1,14 +1,16 @@
 import dask.array as da
 import matplotlib
+import numpy as np
 import scanpy as sc
 import spatialdata_plot  # noqa: F401
 from spatial_image import to_spatial_image
 from spatialdata import SpatialData
 
-from tests.conftest import PlotTester, PlotTesterMeta
+from tests.conftest import DPI, PlotTester, PlotTesterMeta
 
+RNG = np.random.default_rng(seed=42)
 sc.pl.set_rcParams_defaults()
-sc.set_figure_params(dpi=40, color_map="viridis")
+sc.set_figure_params(dpi=DPI, color_map="viridis")
 matplotlib.use("agg")  # same as GitHub action runner
 _ = spatialdata_plot
 

tests/_images/Extent_extent_calculation_respects_element_selection_circles_and_polygons.png

@@ -10,14 +10,14 @@
 from spatialdata._core.query.relational_query import _get_unique_label_values_as_index
 from spatialdata.models import TableModel
 
-from tests.conftest import PlotTester, PlotTesterMeta
+from tests.conftest import DPI, PlotTester, PlotTesterMeta
 
+RNG = np.random.default_rng(seed=42)
 sc.pl.set_rcParams_defaults()
-sc.set_figure_params(dpi=40, color_map="viridis")
+sc.set_figure_params(dpi=DPI, color_map="viridis")
 matplotlib.use("agg")  # same as GitHub action runner
 _ = spatialdata_plot
 
-RNG = np.random.default_rng(seed=42)
 # WARNING:
 # 1. all classes must both subclass PlotTester and use metaclass=PlotTesterMeta
 # 2. tests which produce a plot must be prefixed with `test_plot_`
@@ -72,7 +72,7 @@ def test_plot_can_stack_render_labels(self, sdata_blobs: SpatialData):
                 elements="blobs_labels", na_color="red", fill_alpha=1, outline_alpha=0, outline=False
             )
             .pl.render_labels(
-                elements="blobs_labels", na_color="blue", fill_alpha=0, outline_alpha=1, outline=True, contour_px=10
+                elements="blobs_labels", na_color="blue", fill_alpha=0, outline_alpha=1, outline=True, contour_px=15
             )
             .pl.show()
         )
@@ -118,6 +118,9 @@ def test_plot_label_categorical_color(self, sdata_blobs: SpatialData):
         sdata_blobs.pl.render_labels("blobs_labels", color="category").pl.show()
 
     def test_plot_multiscale_label_categorical_color(self, sdata_blobs: SpatialData):
+        # recreate RNG to get same plot acorss 3.9 and 3.10 workers
+        RNG = np.random.default_rng(seed=42)
+
         n_obs = max(_get_unique_label_values_as_index(sdata_blobs["blobs_multiscale_labels"]))
         adata = AnnData(
             RNG.normal(size=(n_obs, 10)), obs=pd.DataFrame(RNG.normal(size=(n_obs, 3)), columns=["a", "b", "c"])
@@ -133,19 +136,3 @@ def test_plot_multiscale_label_categorical_color(self, sdata_blobs: SpatialData)
 
         sdata_blobs["other_table"].obs["category"] = sdata_blobs["other_table"].obs["category"].astype("category")
         sdata_blobs.pl.render_labels("blobs_multiscale_labels", color="category").pl.show()
-
-    # def test_plot_multiscale_label_coercable_categorical_color(self, sdata_blobs: SpatialData):
-    #     n_obs = max(_get_unique_label_values_as_index(sdata_blobs["blobs_multiscale_labels"]))
-    #     adata = AnnData(
-    #         RNG.normal(size=(n_obs, 10)), obs=pd.DataFrame(RNG.normal(size=(n_obs, 3)), columns=["a", "b", "c"])
-    #     )
-    #     adata.obs["instance_id"] = np.arange(adata.n_obs)
-    #     adata.obs["category"] = RNG.choice(["a", "b", "c"], size=adata.n_obs)
-    #     adata.obs["instance_id"] = list(range(adata.n_obs))
-    #     adata.obs["region"] = "blobs_multiscale_labels"
-    #     table = TableModel.parse(
-    #         adata=adata, region_key="region", instance_key="instance_id", region="blobs_multiscale_labels"
-    #     )
-    #     sdata_blobs["other_table"] = table
-    #
-    #     sdata_blobs.pl.render_labels("blobs_multiscale_labels", color="category").pl.show()

tests/_images/Extent_extent_calculation_respects_element_selection_polygons.png

@@ -7,11 +7,11 @@
 from spatialdata import SpatialData
 from spatialdata.models import TableModel
 
-from tests.conftest import PlotTester, PlotTesterMeta
+from tests.conftest import DPI, PlotTester, PlotTesterMeta
 
 RNG = np.random.default_rng(seed=42)
 sc.pl.set_rcParams_defaults()
-sc.set_figure_params(dpi=40, color_map="viridis")
+sc.set_figure_params(dpi=DPI, color_map="viridis")
 matplotlib.use("agg")  # same as GitHub action runner
 _ = spatialdata_plot
 

tests/_images/Extent_extent_of_img_full_canvas.png

@@ -10,14 +10,14 @@
 from spatialdata import SpatialData
 from spatialdata.models import ShapesModel, TableModel
 
-from tests.conftest import PlotTester, PlotTesterMeta
+from tests.conftest import DPI, PlotTester, PlotTesterMeta
 
+RNG = np.random.default_rng(seed=42)
 sc.pl.set_rcParams_defaults()
-sc.set_figure_params(dpi=40, color_map="viridis")
+sc.set_figure_params(dpi=DPI, color_map="viridis")
 matplotlib.use("agg")  # same as GitHub action runner
 _ = spatialdata_plot
 
-RNG = np.random.default_rng(seed=42)
 # WARNING:
 # 1. all classes must both subclass PlotTester and use metaclass=PlotTesterMeta
 # 2. tests which produce a plot must be prefixed with `test_plot_`

tests/_images/Extent_extent_of_img_is_correct_after_spatial_query.png

@@ -1,12 +1,14 @@
 import matplotlib
+import numpy as np
 import scanpy as sc
 import spatialdata_plot  # noqa: F401
 from spatialdata import SpatialData
 
-from tests.conftest import PlotTester, PlotTesterMeta
+from tests.conftest import DPI, PlotTester, PlotTesterMeta
 
+RNG = np.random.default_rng(seed=42)
 sc.pl.set_rcParams_defaults()
-sc.set_figure_params(dpi=40, color_map="viridis")
+sc.set_figure_params(dpi=DPI, color_map="viridis")
 matplotlib.use("agg")  # same as GitHub action runner
 _ = spatialdata_plot
 

tests/_images/Extent_extent_of_partial_canvas_on_full_canvas.png

@@ -2,6 +2,7 @@
 
 import matplotlib
 import matplotlib.pyplot as plt
+import numpy as np
 import scanpy as sc
 import spatialdata_plot  # noqa: F401
 from spatialdata import SpatialData
@@ -14,10 +15,11 @@
     set_transformation,
 )
 
-from tests.conftest import PlotTester, PlotTesterMeta
+from tests.conftest import DPI, PlotTester, PlotTesterMeta
 
-sc.pl.set_rcParams_defaults()
-sc.set_figure_params(dpi=40, color_map="viridis")
+RNG = np.random.default_rng(seed=42)
+# sc.pl.set_rcParams_defaults()
+sc.set_figure_params(dpi=DPI, color_map="viridis")
 matplotlib.use("agg")  # same as GitHub action runner
 _ = spatialdata_plot