Rename cache_geom_slices to cache_geometry_slices

Author: djhoese

docs/source/howtos/configuration.rst

@@ -101,8 +101,8 @@ the `platformdirs <https://github.com/platformdirs/platformdirs#example-output>`
 Cache Geometry Slices
 ^^^^^^^^^^^^^^^^^^^^^
 
-* **Environment variable**: ``PYRESAMPLE_CACHE_GEOM_SLICES``
-* **YAML/Config Key**: ``cache_geom_slices``
+* **Environment variable**: ``PYRESAMPLE_CACHE_GEOMETRY_SLICES``
+* **YAML/Config Key**: ``cache_geometry_slices``
 * **Default**: ``False``
 
 Whether or not generated slices for geometry objects are cached to disk.

pyresample/_caching.py

@@ -64,7 +64,7 @@ def _run_and_cache(self, arg_hash: str, args: tuple[Any]) -> Any:
             res = self._callable(*args)
             json_path.parent.mkdir(exist_ok=True)
             with open(json_path, "w") as json_cache:
-                json.dump(res, json_cache, cls=_ExtraJSONEncoder)
+                json.dump(res, json_cache, cls=_JSONEncoderWithSlice)
 
         # for consistency, always load the cached result
         with open(json_path, "r") as json_cache:
@@ -97,7 +97,7 @@ def _hash_args(args: tuple[Any]) -> str:
     return arg_hash.hexdigest()
 
 
-class _ExtraJSONEncoder(json.JSONEncoder):
+class _JSONEncoderWithSlice(json.JSONEncoder):
     def default(self, obj: Any) -> Any:
         if isinstance(obj, slice):
             return {"__slice__": True, "start": obj.start, "stop": obj.stop, "step": obj.step}

pyresample/_config.py

@@ -21,7 +21,6 @@
 from donfig import Config
 
 BASE_PATH = os.path.dirname(os.path.realpath(__file__))
-# FIXME: Use package_resources?
 PACKAGE_CONFIG_PATH = os.path.join(BASE_PATH, 'etc')
 
 _user_config_dir = platformdirs.user_config_dir("pyresample", "pytroll")
@@ -37,7 +36,7 @@
     "pyresample",
     defaults=[{
         "cache_dir": platformdirs.user_cache_dir("pyresample", "pytroll"),
-        "cache_geom_slices": False,
+        "cache_geometry_slices": False,
         "features": {
             "future_geometries": False,
         },

pyresample/future/geometry/_subset.py

@@ -18,7 +18,7 @@
     from pyresample import AreaDefinition
 
 
-@cache_to_json_if("cache_geom_slices")
+@cache_to_json_if("cache_geometry_slices")
 def get_area_slices(
         src_area: AreaDefinition,
         area_to_cover: AreaDefinition,

pyresample/test/conftest.py

@@ -42,7 +42,7 @@
 def reset_pyresample_config(tmpdir):
     """Set pyresample config to logical defaults for tests."""
     test_config = {
-        "cache_geom_slices": False,
+        "cache_geometry_slices": False,
         "features": {
             "future_geometries": False,
         },

pyresample/test/test_geometry/test_area.py

@@ -1833,7 +1833,7 @@ def test_area_slices_caching(self, create_test_area, tmp_path, cache_slices):
                                      100, 100,
                                      (15.9689, 58.5284, 16.4346, 58.6995))
         cache_glob = str(tmp_path / "geometry_slices_v1" / "*.json")
-        with pyresample.config.set(cache_dir=tmp_path, cache_geom_slices=cache_slices):
+        with pyresample.config.set(cache_dir=tmp_path, cache_geometry_slices=cache_slices):
             assert len(glob(cache_glob)) == 0
             slice_x, slice_y = src_area.get_area_slices(crop_area)
             assert len(glob(cache_glob)) == int(cache_slices)
@@ -1857,7 +1857,7 @@ def test_area_slices_caching_no_swaths(self, tmp_path, create_test_area, create_
         lats = create_test_latitude(25.0, 35.0, shape=(1000, 500))
         swath = create_test_swath(lons, lats)
 
-        with pyresample.config.set(cache_dir=tmp_path, cache_geom_slices=True), pytest.raises(NotImplementedError):
+        with pyresample.config.set(cache_dir=tmp_path, cache_geometry_slices=True), pytest.raises(NotImplementedError):
             with pytest.warns(UserWarning, match="unhashable"):
                 get_area_slices(swath, area, None)