Merge branch 'master' into pont-612-rfc3339

Author: pont-us

CHANGES.md

@@ -1,15 +1,23 @@
-## Changes in 0.10.1 (in development)
+## Changes in 0.10.2 (in development)
 
 ### Enhancements
 
 ### Fixes
 
+### Other
+
+## Changes in 0.10.1
+
+### Fixes
+
+* Deprecated argument `xy_var_names` in function `GridMapping.from_dataset`,
+  thereby preventing a NotImplementedError. (#551) 
+
 ### Other Changes
 
-* For compatibility, now also `xcube.__version__` now contains the xcube 
+* For compatibility, now also `xcube.__version__` contains the xcube 
   version number.
 
-
 ## Changes in 0.10.0
 
 ### Incompatible Changes 

test/core/gridmapping/test_dataset.py

@@ -131,17 +131,6 @@ def test_from_sentinel_2(self):
         self.assertEqual('Geographic 2D CRS', gm.crs.type_name)
         self.assertEqual(False, gm.is_regular)
 
-    def test_xy_names(self):
-        dataset = create_s2plus_dataset()
-        with self.assertRaises(ValueError) as cm:
-            GridMapping.from_dataset(dataset, xy_var_names=('lons', 'lats'))
-        self.assertEqual('coordinate variables "lons" or "lats" not found in dataset', f'{cm.exception}')
-
-        dataset = create_s2plus_dataset()
-        with self.assertRaises(NotImplementedError) as cm:
-            GridMapping.from_dataset(dataset, xy_var_names=('lon', 'lat'))
-        self.assertEqual('xy_var_names not yet supported', f'{cm.exception}')
-
     def test_no_grid_mapping_found(self):
         with self.assertRaises(ValueError) as cm:
             GridMapping.from_dataset(xr.Dataset())

xcube/core/gridmapping/base.py

@@ -648,6 +648,7 @@ def from_dataset(cls,
         :param crs: Optional spatial coordinate reference system.
         :param xy_var_names: Optional tuple of the x- and
             y-coordinate variables in *dataset*.
+            Deprecated since xcube 0.10.1.
         :param tile_size: Optional tile size
         :param prefer_is_regular: Whether to prefer a regular
             grid mapping if multiple found. Default is True.

xcube/core/gridmapping/dataset.py

@@ -20,6 +20,7 @@
 # SOFTWARE.
 
 from typing import Optional, Union, Tuple
+import warnings
 
 import pyproj
 import xarray as xr
@@ -53,13 +54,10 @@ def new_grid_mapping_from_dataset(
         prefer_crs = _normalize_crs(prefer_crs)
     else:
         prefer_crs = crs
-    if xy_var_names is not None:
-        x_var_name, y_var_name = xy_var_names
-        if x_var_name not in dataset or y_var_name not in dataset:
-            raise ValueError(f'coordinate variables "{x_var_name}" '
-                             f'or "{y_var_name}" not found in dataset')
-        # TODO: create new instance using named coordinate variables
-        raise NotImplementedError('xy_var_names not yet supported')
+    if xy_var_names:
+        warnings.warn('Argument "xy_var_names" is deprecated since '
+                      'xcube 0.10.1 and will be ignored.',
+                      category=DeprecationWarning)
 
     grid_mapping_proxies = get_dataset_grid_mapping_proxies(
         dataset,

xcube/version.py

@@ -19,4 +19,4 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-version = '0.10.1.dev0'
+version = '0.10.2.dev0'