add std quality filter to planet data filter default

Author: jreiberkyle

planet/cli/data.py

@@ -294,7 +294,13 @@ def _func(obj):
 @click.option('--permission',
               type=bool,
               default=True,
+              show_default=True,
               help='Filter to assets with download permissions.')
+@click.option('--std-quality',
+              type=bool,
+              default=True,
+              show_default=True,
+              help='Filter to standard quality.')
 def filter(ctx,
            asset,
            date_range,
@@ -304,7 +310,8 @@ def filter(ctx,
            string_in,
            update,
            permission,
-           pretty):
+           pretty,
+           std_quality):
     """Create a structured item search filter.
 
     This command provides basic functionality for specifying a filter by
@@ -314,6 +321,7 @@ def filter(ctx,
     the Python API.
     """
     permission = data_filter.permission_filter() if permission else None
+    std_quality = data_filter.std_quality_filter() if std_quality else None
 
     filter_options = (asset,
                       date_range,
@@ -322,7 +330,8 @@ def filter(ctx,
                       nrange,
                       string_in,
                       update,
-                      permission)
+                      permission,
+                      std_quality)
 
     # options allowing multiples are broken up so one filter is created for
     # each time the option is specified

planet/data_filter.py

@@ -300,3 +300,12 @@ def permission_filter() -> dict:
     download.
     """
     return {'type': 'PermissionFilter', 'config': ['assets:download']}
+
+
+def std_quality_filter() -> dict:
+    """Create a filter for standard-quality items.
+
+    This is a custom filter which filters to items that are categorized as
+    standard quality.
+    """
+    return string_in_filter('quality_category', ['standard'])

tests/integration/test_data_cli.py

@@ -14,6 +14,7 @@
 """Tests of the Data CLI."""
 from http import HTTPStatus
 import json
+import logging
 
 import httpx
 import respx
@@ -23,6 +24,8 @@
 
 from planet.cli import cli
 
+LOGGER = logging.getLogger(__name__)
+
 TEST_URL = 'https://api.planet.com/data/v1'
 TEST_QUICKSEARCH_URL = f'{TEST_URL}/quick-search'
 TEST_SEARCHES_URL = f'{TEST_URL}/searches'
@@ -51,22 +54,17 @@ def test_data_command_registered(invoke):
     # Add other sub-commands here.
 
 
-permission_filter = {"type": "PermissionFilter", "config": ["assets:download"]}
+PERMISSION_FILTER = {"type": "PermissionFilter", "config": ["assets:download"]}
+STD_QUALITY_FILTER = {
+    "type": "StringInFilter",
+    "field_name": "quality_category",
+    "config": ["standard"]
+}
 
 
-@respx.mock
-@pytest.mark.asyncio
-@pytest.mark.parametrize("permission, expected",
-                         [(False, ''),
-                          (True, json.dumps(permission_filter) + '\n')])
-def test_data_filter_permission(invoke, permission, expected):
-    """Test that the proper filter is created when zero and one subfilters
-    are specified."""
-    runner = CliRunner()
-    result = invoke(["filter", f'--permission={permission}'], runner=runner)
-
-    assert result.exit_code == 0
-    assert result.output == expected
+@pytest.fixture()
+def default_filters():
+    return [PERMISSION_FILTER, STD_QUALITY_FILTER]
 
 
 @pytest.fixture
@@ -84,6 +82,37 @@ def _func(filter1, filter2):
     return _func
 
 
+@respx.mock
+@pytest.mark.asyncio
+@pytest.mark.parametrize("permission, p_remove",
+                         [(None, None),
+                          ('--permission=False', PERMISSION_FILTER)])
+@pytest.mark.parametrize("std_quality, s_remove",
+                         [(None, None),
+                          ('--std-quality=False', STD_QUALITY_FILTER)])
+def test_data_filter_defaults(permission,
+                              p_remove,
+                              std_quality,
+                              s_remove,
+                              invoke,
+                              default_filters,
+                              assert_and_filters_equal):
+    runner = CliRunner()
+
+    args = [arg for arg in [permission, std_quality] if arg]
+    result = invoke(["filter", *args], runner=runner)
+    assert result.exit_code == 0
+
+    [default_filters.remove(rem) for rem in [p_remove, s_remove] if rem]
+    if len(default_filters) > 1:
+        expected_filt = {"type": "AndFilter", "config": default_filters}
+        assert_and_filters_equal(json.loads(result.output), expected_filt)
+    elif len(default_filters) == 1:
+        assert json.loads(result.output) == default_filters[0]
+    else:
+        assert result.output == ''
+
+
 @respx.mock
 @pytest.mark.asyncio
 @pytest.mark.parametrize("asset, expected",
@@ -92,22 +121,28 @@ def _func(filter1, filter2):
                            ['ortho_analytic_8b_sr', 'ortho_analytic_4b_sr']),
                           ('ortho_analytic_8b_sr , ortho_analytic_4b_sr',
                            ['ortho_analytic_8b_sr', 'ortho_analytic_4b_sr'])])
-def test_data_filter_asset(asset, expected, invoke, assert_and_filters_equal):
+def test_data_filter_asset(asset,
+                           expected,
+                           invoke,
+                           default_filters,
+                           assert_and_filters_equal):
     runner = CliRunner()
 
     result = invoke(["filter", f'--asset={asset}'], runner=runner)
     assert result.exit_code == 0
 
     asset_filter = {"type": "AssetFilter", "config": expected}
     expected_filt = {
-        "type": "AndFilter", "config": [asset_filter, permission_filter]
+        "type": "AndFilter", "config": default_filters + [asset_filter]
     }
     assert_and_filters_equal(json.loads(result.output), expected_filt)
 
 
 @respx.mock
 @pytest.mark.asyncio
-def test_data_filter_date_range(invoke, assert_and_filters_equal):
+def test_data_filter_date_range(invoke,
+                                assert_and_filters_equal,
+                                default_filters):
     """Check filter is created correctly and that multiple options results in
     multiple filters"""
     runner = CliRunner()
@@ -134,7 +169,7 @@ def test_data_filter_date_range(invoke, assert_and_filters_equal):
 
     expected_filt = {
         "type": "AndFilter",
-        "config": [permission_filter, date_range_filter1, date_range_filter2]
+        "config": default_filters + [date_range_filter1, date_range_filter2]
     }
 
     assert_and_filters_equal(json.loads(result.output), expected_filt)
@@ -149,7 +184,8 @@ def test_data_filter_geom(geom_fixture,
                           request,
                           invoke,
                           geom_geojson,
-                          assert_and_filters_equal):
+                          assert_and_filters_equal,
+                          default_filters):
     """Ensure that all GeoJSON forms of describing a geometry are handled
     and all result in the same, valid GeometryFilter being created"""
     runner = CliRunner()
@@ -166,15 +202,17 @@ def test_data_filter_geom(geom_fixture,
     }
 
     expected_filt = {
-        "type": "AndFilter", "config": [permission_filter, geom_filter]
+        "type": "AndFilter", "config": default_filters + [geom_filter]
     }
 
     assert_and_filters_equal(json.loads(result.output), expected_filt)
 
 
 @respx.mock
 @pytest.mark.asyncio
-def test_data_filter_number_in(invoke, assert_and_filters_equal):
+def test_data_filter_number_in(invoke,
+                               assert_and_filters_equal,
+                               default_filters):
     runner = CliRunner()
 
     result = invoke(["filter"] + '--number-in field 1'.split() +
@@ -191,15 +229,15 @@ def test_data_filter_number_in(invoke, assert_and_filters_equal):
 
     expected_filt = {
         "type": "AndFilter",
-        "config": [permission_filter, number_in_filter1, number_in_filter2]
+        "config": default_filters + [number_in_filter1, number_in_filter2]
     }
 
     assert_and_filters_equal(json.loads(result.output), expected_filt)
 
 
 @respx.mock
 @pytest.mark.asyncio
-def test_data_filter_range(invoke, assert_and_filters_equal):
+def test_data_filter_range(invoke, assert_and_filters_equal, default_filters):
     """Check filter is created correctly, that multiple options results in
     multiple filters, and that floats are processed correctly."""
     runner = CliRunner()
@@ -224,15 +262,17 @@ def test_data_filter_range(invoke, assert_and_filters_equal):
 
     expected_filt = {
         "type": "AndFilter",
-        "config": [permission_filter, range_filter1, range_filter2]
+        "config": default_filters + [range_filter1, range_filter2]
     }
 
     assert_and_filters_equal(json.loads(result.output), expected_filt)
 
 
 @respx.mock
 @pytest.mark.asyncio
-def test_data_filter_string_in(invoke, assert_and_filters_equal):
+def test_data_filter_string_in(invoke,
+                               assert_and_filters_equal,
+                               default_filters):
     runner = CliRunner()
 
     result = invoke(["filter"] + '--string-in field foo'.split() +
@@ -251,15 +291,15 @@ def test_data_filter_string_in(invoke, assert_and_filters_equal):
 
     expected_filt = {
         "type": "AndFilter",
-        "config": [permission_filter, string_in_filter1, string_in_filter2]
+        "config": default_filters + [string_in_filter1, string_in_filter2]
     }
 
     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):
+def test_data_filter_update(invoke, assert_and_filters_equal, default_filters):
     """Check filter is created correctly and that multiple options results in
     multiple filters"""
     runner = CliRunner()
@@ -286,7 +326,7 @@ def test_data_filter_update(invoke, assert_and_filters_equal):
 
     expected_filt = {
         "type": "AndFilter",
-        "config": [permission_filter, update_filter1, update_filter2]
+        "config": default_filters + [update_filter1, update_filter2]
     }
 
     assert_and_filters_equal(json.loads(result.output), expected_filt)

tests/unit/test_data_filter.py

@@ -215,3 +215,13 @@ def test_permission_filter():
     res = data_filter.permission_filter()
     expected = {'type': 'PermissionFilter', 'config': ['assets:download']}
     assert res == expected
+
+
+def test_std_quality_filter():
+    res = data_filter.std_quality_filter()
+    expected = {
+        'type': 'StringInFilter',
+        'field_name': 'quality_category',
+        'config': ['standard']
+    }
+    assert res == expected