Move check_geom to validators

Author: angaither

planet/cli/data.py

@@ -18,7 +18,7 @@
 import click
 
 from planet.reporting import AssetStatusBar
-from planet import data_filter, DataClient, exceptions, geojson
+from planet import data_filter, DataClient, exceptions
 from planet.clients.data import (SEARCH_SORT,
                                  LIST_SEARCH_TYPE,
                                  LIST_SEARCH_TYPE_DEFAULT,
@@ -36,6 +36,7 @@
 from .io import echo_json
 from .options import limit, pretty
 from .session import CliSession
+from .validators import check_geom
 
 valid_item_string = "Valid entries for ITEM_TYPES: " + "|".join(
     get_data_item_types())
@@ -80,17 +81,6 @@ def check_item_types(ctx, param, item_types) -> Optional[List[dict]]:
         raise click.BadParameter(str(e))
 
 
-def check_geom(ctx, param, geometry) -> Optional[dict]:
-    """Validates geometry as GeoJSON or feature ref(s)."""
-    if isinstance(geometry, dict):
-        return geojson.as_geom_or_ref(geometry)
-    geoms = {}
-    if geometry:
-        for geom in geometry:
-            geoms.update(geojson.as_geom_or_ref(geom))
-    return geoms if geoms else None
-
-
 def check_item_type(ctx, param, item_type) -> Optional[List[dict]]:
     """Validates the item type provided by comparing it to all supported
     item types."""

planet/cli/subscriptions.py

@@ -13,7 +13,7 @@
 from .. import subscription_request
 from ..subscription_request import sentinel_hub
 from ..specs import get_item_types, validate_item_type, SpecificationException
-from planet import geojson
+from .validators import check_geom
 
 ALL_ITEM_TYPES = get_item_types()
 valid_item_string = "Valid entries for ITEM_TYPES: " + "|".join(ALL_ITEM_TYPES)
@@ -30,17 +30,6 @@ def check_item_types(ctx, param, item_types) -> Optional[List[dict]]:
         raise click.BadParameter(str(e))
 
 
-def check_geom(ctx, param, geometry) -> Optional[dict]:
-    """Validates geometry as GeoJSON or feature ref(s)."""
-    if isinstance(geometry, dict):
-        return geojson.as_geom_or_ref(geometry)
-    geoms = {}
-    if geometry:
-        for geom in geometry:
-            geoms.update(geojson.as_geom_or_ref(geom))
-    return geoms if geoms else None
-
-
 def check_item_type(ctx, param, item_type) -> Optional[List[dict]]:
     """Validates the item type provided by comparing it to all supported
     item types."""

planet/cli/validators.py

@@ -0,0 +1,27 @@
+# Copyright 2022 Planet Labs, PBC.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may not
+# use this file except in compliance with the License. You may obtain a copy of
+# the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations under
+# the License.
+"""CLI Parameter validation"""
+from typing import Optional
+from planet import geojson
+
+
+def check_geom(ctx, param, geometry) -> Optional[dict]:
+    """Validates geometry as GeoJSON or feature ref(s)."""
+    if isinstance(geometry, dict):
+        return geojson.as_geom_or_ref(geometry)
+    geoms = {}
+    if geometry:
+        for geom in geometry:
+            geoms.update(geojson.as_geom_or_ref(geom))
+    return geoms if geoms else None