Merge pull request #9 from kthyng/types

trying type annotations

Author: kthyng

.pre-commit-config.yaml

@@ -46,12 +46,13 @@ repos:
   - id: black
     language_version: python3
 
-# - repo: https://github.com/pre-commit/mirrors-mypy
-#   rev: v0.770
-#   hooks:
-#   - id: mypy
-#     exclude: docs/source/conf.py
-#     args: [--ignore-missing-imports]
+- repo: https://github.com/pre-commit/mirrors-mypy
+  rev: v0.982
+  hooks:
+  - id: mypy
+    additional_dependencies: [types-setuptools]
+    exclude: docs/source/conf.py
+    args: [--ignore-missing-imports]
 
 - repo: https://github.com/codespell-project/codespell
   rev: v1.16.0

cf_pandas/accessor.py

@@ -21,7 +21,7 @@ def __init__(self, pandas_obj):
     #     if "latitude" not in obj.columns or "longitude" not in obj.columns:
     #         raise AttributeError("Must have 'latitude' and 'longitude'.")
 
-    def __getitem__(self, key):
+    def __getitem__(self, key: str):
         """Redefinition of dict-like behavior.
         This enables user to use syntax `reader[dataset_id]` to read in and
         save dataset into the object.

cf_pandas/options.py

@@ -55,7 +55,7 @@ def _apply_update(self, options_dict):
         for k, v in options_dict.items():
             if k == "custom_criteria":
                 options_dict["custom_criteria"] = cfp.always_iterable(
-                    options_dict["custom_criteria"], allowed=(tuple, list)
+                    options_dict["custom_criteria"], allowed=(tuple, list, set)
                 )
         OPTIONS.update(options_dict)
 

cf_pandas/utils.py

@@ -30,27 +30,31 @@ def astype(value, type_):
     return value
 
 
-def set_up_criteria(criteria: Optional[dict] = None):
+def set_up_criteria(criteria: Union[dict, Iterable] = None) -> ChainMap:
     """Get custom criteria from options.
 
     Parameters
     ----------
     criteria : dict, optional
-        Criteria to use to map from variable to attributes describing the variable. If user has defined custom_criteria, this will be used by default.
+        Criteria to use to map from variable to attributes describing the variable. If user has defined
+        custom_criteria, this will be used by default.
+
+    Returns
+    -------
+    ChainMap
+        Criteria
     """
 
     if criteria is None:
         if not OPTIONS["custom_criteria"]:
-            return []
-        criteria = OPTIONS["custom_criteria"]
-
-    if criteria is not None:
-        criteria = always_iterable(criteria, allowed=(tuple, list, set))
-
-    criteria = always_iterable(criteria, allowed=(tuple, list, set))
-    criteria = ChainMap(*criteria)
-
-    return criteria
+            raise ValueError(
+                "criteria needs to be defined either using set_options or directly input."
+            )
+        criteria_it = OPTIONS["custom_criteria"]
+    else:
+        criteria_it = always_iterable(criteria, allowed=(tuple, list, set))
+
+    return ChainMap(*criteria_it)
 
 
 def match_criteria_key(