Use pydantic.validate_arguments decorator to validate individual func…

…tions (#377)

intake_esm/core.py

@@ -130,6 +130,7 @@ def _get_entries(self) -> typing.Dict[str, ESMDataSource]:
             _ = self[key]
         return self._entries
 
+    @pydantic.validate_arguments
     def __getitem__(self, key: str) -> ESMDataSource:
         """
         This method takes a key argument and return a data source
@@ -237,9 +238,10 @@ def __dir__(self):
     def _ipython_key_completions_(self):
         return self.__dir__()
 
+    @pydantic.validate_arguments
     def search(
-        self, require_all_on: typing.Union[str, typing.List[str]] = None, **query
-    ) -> 'esm_datastore':
+        self, require_all_on: typing.Union[str, typing.List[str]] = None, **query: typing.Any
+    ):
         """Search for entries in the catalog.
 
         Parameters
@@ -307,7 +309,13 @@ def search(
         cat._requested_variables = requested_variables
         return cat
 
-    def serialize(self, name: str, directory: str = None, catalog_type: str = 'dict') -> None:
+    @pydantic.validate_arguments
+    def serialize(
+        self,
+        name: pydantic.StrictStr,
+        directory: typing.Union[pydantic.DirectoryPath, pydantic.StrictStr] = None,
+        catalog_type: str = 'dict',
+    ) -> None:
         """Serialize collection/catalog to corresponding json and csv files.
 
         Parameters
@@ -369,14 +377,15 @@ def unique(self) -> pd.Series:
 
         return self.esmcat.unique()
 
+    @pydantic.validate_arguments
     def to_dataset_dict(
         self,
         xarray_open_kwargs: typing.Dict[str, typing.Any] = None,
         xarray_combine_by_coords_kwargs: typing.Dict[str, typing.Any] = None,
-        preprocess: typing.Dict[str, typing.Any] = None,
-        storage_options: typing.Dict[str, typing.Any] = None,
-        progressbar: bool = None,
-        aggregate: bool = None,
+        preprocess: typing.Callable = None,
+        storage_options: typing.Dict[pydantic.StrictStr, typing.Any] = None,
+        progressbar: pydantic.StrictBool = None,
+        aggregate: pydantic.StrictBool = None,
         **kwargs,
     ) -> typing.Dict[str, xr.Dataset]:
         """
@@ -476,9 +485,6 @@ def to_dataset_dict(
         if progressbar is not None:
             self.progressbar = progressbar
 
-        if preprocess is not None and not callable(preprocess):
-            raise ValueError('preprocess argument must be callable')
-
         if self.progressbar:
             print(
                 f"""\n--> The keys in the returned dictionary of datasets are constructed as follows:\n\t'{self.key_template}'"""

intake_esm/source.py

@@ -99,6 +99,7 @@ class ESMDataSource(DataSource):
     name = 'esm_datasource'
     partition_access = True
 
+    @pydantic.validate_arguments
     def __init__(
         self,
         key: pydantic.StrictStr,
@@ -114,7 +115,7 @@ def __init__(
         xarray_open_kwargs: typing.Dict[str, typing.Any] = None,
         xarray_combine_by_coords_kwargs: typing.Dict[str, typing.Any] = None,
         intake_kwargs: typing.Dict[str, typing.Any] = None,
-    ) -> 'ESMDataSource':
+    ):
 
         intake_kwargs = intake_kwargs or {}
         super().__init__(**intake_kwargs)

requirements.txt

@@ -6,4 +6,4 @@ netCDF4>=1.5.5
 requests>=2.24.0
 xarray>=0.19
 zarr>=2.5
-pydantic
+pydantic>=1.8.2

tests/test_core.py

@@ -2,6 +2,7 @@
 
 import intake
 import pandas as pd
+import pydantic
 import pytest
 import xarray as xr
 
@@ -257,5 +258,5 @@ def test_to_dataset_dict_cdf_zarr_kwargs_deprecation():
 
 def test_to_dataset_dict_w_preprocess_error():
     cat = intake.open_esm_datastore(cdf_col_sample_cmip5)
-    with pytest.raises(ValueError, match=r'preprocess argument must be callable'):
+    with pytest.raises(pydantic.ValidationError):
         cat.to_dataset_dict(preprocess='foo')