add update filter

Author: jreiberkyle

planet/cli/data.py

@@ -142,6 +142,12 @@ def convert(self, value, param, ctx):
         return value
 
 
+class GTComparisonType(ComparisonType):
+    """Only support gt or gte comparison"""
+    valid = ['gt', 'gte']
+    help = 'COMP can be gt, or gte.'
+
+
 class DateTimeType(click.ParamType):
     name = 'datetime'
     help = 'DATETIME can be an RFC 3339 or ISO 8601 string.'
@@ -183,6 +189,22 @@ def convert(self, value, param, ctx):
         return data_filter.range_filter(**kwargs)
 
 
+class UpdateFilter(click.Tuple):
+    help = ('Filter to items with changes to a specified field value made ' +
+            'after a specified date.' +
+            f'{FieldType.help} {GTComparisonType.help} {DateTimeType.help}')
+
+    def __init__(self) -> None:
+        super().__init__([FieldType(), GTComparisonType(), DateTimeType()])
+
+    def convert(self, value, param, ctx):
+        vals = super().convert(value, param, ctx)
+
+        field, comp, value = vals
+        kwargs = {'field_name': field, comp: value}
+        return data_filter.update_filter(**kwargs)
+
+
 @data.command()
 @click.pass_context
 @translate_exceptions
@@ -201,16 +223,28 @@ def convert(self, value, param, ctx):
               default=None,
               callback=geom_to_filter,
               help='Filter to items that overlap a given geometry.')
+# @click.option('--number-in',
+#               type=RangeFilter(),
+#               multiple=True,
+#               help=RangeFilter.help)
 @click.option('--range',
               'nrange',
               type=RangeFilter(),
               multiple=True,
               help=RangeFilter.help)
+# @click.option('--string-in',
+#               type=RangeFilter(),
+#               multiple=True,
+#               help=RangeFilter.help)
+@click.option('--update',
+              type=UpdateFilter(),
+              multiple=True,
+              help=UpdateFilter.help)
 @click.option('--permission',
               type=bool,
               default=True,
               help='Filter to assets with download permissions.')
-def filter(ctx, asset, date_range, geom, nrange, permission, pretty):
+def filter(ctx, asset, date_range, geom, nrange, update, permission, pretty):
     """Create a structured item search filter.
 
     This command provides basic functionality for specifying a filter by
@@ -223,7 +257,7 @@ def filter(ctx, asset, date_range, geom, nrange, permission, pretty):
 
     # options allowing multiples are broken up so one filter is created for
     # each time the option is specified
-    filter_args = (asset, *date_range, geom, *nrange, permission)
+    filter_args = (asset, *date_range, geom, *nrange, *update, permission)
 
     filters = [f for f in filter_args if f]
 

tests/integration/test_data_cli.py

@@ -205,6 +205,41 @@ def test_data_filter_range(invoke, assert_and_filters_equal):
     assert_and_filters_equal(json.loads(result.output), expected_filt)
 
 
+@respx.mock
+@pytest.mark.asyncio
+def test_data_filter_update(invoke, assert_and_filters_equal):
+    """Check filter is created correctly and that multiple options results in
+    multiple filters"""
+    runner = CliRunner()
+
+    result = invoke(["filter"] + '--update field gt 2021-01-01'.split() +
+                    '--update field2 gte 2022-01-01'.split(),
+                    runner=runner)
+    assert result.exit_code == 0
+
+    update_filter1 = {
+        "type": "UpdateFilter",
+        "field_name": "field",
+        "config": {
+            "gt": "2021-01-01T00:00:00Z"
+        }
+    }
+    update_filter2 = {
+        "type": "UpdateFilter",
+        "field_name": "field2",
+        "config": {
+            "gte": "2022-01-01T00:00:00Z"
+        }
+    }
+
+    expected_filt = {
+        "type": "AndFilter",
+        "config": [permission_filter, update_filter1, update_filter2]
+    }
+
+    assert_and_filters_equal(json.loads(result.output), expected_filt)
+
+
 @respx.mock
 @pytest.mark.asyncio
 @pytest.mark.parametrize("filter", ['{1:1}', '{"foo"}'])