merge tag 2.0.2

Author: jreiberkyle

CHANGES.txt

@@ -1,3 +1,12 @@
+2.0.2 (2023-05-24)
+
+Fixed:
+- Fixed bug where SkySatVideo was not recognized as a valid data api item type.
+- Fixed wheel name to indicate that only python 3 is supported and updated
+  build metadata to indicate that the package is now a stable release and only
+  supports Python 3.
+
+
 2.0.1 (2023-05-10)
 
 Fixed:
@@ -13,6 +22,7 @@ Docs:
 - Update the syntax of example code in the docstrings in the Order and Data
   clients and add example code to the Subscriptions client docstring (#943).
 
+
 2.0.0 (2023-04-17)
 
 User Interface Changes:

planet/cli/data.py

@@ -28,8 +28,8 @@
                                  SEARCH_SORT_DEFAULT,
                                  STATS_INTERVAL)
 
-from planet.specs import (get_item_types,
-                          validate_item_type,
+from planet.specs import (get_data_item_types,
+                          validate_data_item_type,
                           SpecificationException)
 
 from . import types
@@ -38,8 +38,8 @@
 from .options import limit, pretty
 from .session import CliSession
 
-ALL_ITEM_TYPES = get_item_types()
-valid_item_string = "Valid entries for ITEM_TYPES: " + "|".join(ALL_ITEM_TYPES)
+valid_item_string = "Valid entries for ITEM_TYPES: " + "|".join(
+    get_data_item_types())
 
 
 @asynccontextmanager
@@ -75,7 +75,7 @@ def check_item_types(ctx, param, item_types) -> Optional[List[dict]]:
     item types.'''
     try:
         for item_type in item_types:
-            validate_item_type(item_type)
+            validate_data_item_type(item_type)
         return item_types
     except SpecificationException as e:
         raise click.BadParameter(str(e))
@@ -85,7 +85,7 @@ def check_item_type(ctx, param, item_type) -> Optional[List[dict]]:
     '''Validates the item type provided by comparing it to all supported
     item types.'''
     try:
-        validate_item_type(item_type)
+        validate_data_item_type(item_type)
     except SpecificationException as e:
         raise click.BadParameter(str(e))
 

planet/clients/data.py

@@ -25,7 +25,7 @@
 from ..constants import PLANET_BASE_URL
 from ..http import Session
 from ..models import Paged, StreamingBody
-from ..specs import validate_item_type
+from ..specs import validate_data_item_type
 
 BASE_URL = f'{PLANET_BASE_URL}/data/v1/'
 SEARCHES_PATH = '/searches'
@@ -147,7 +147,7 @@ async def search(self,
 
         search_filter = search_filter or empty_filter()
 
-        item_types = [validate_item_type(item) for item in item_types]
+        item_types = [validate_data_item_type(item) for item in item_types]
         request_json = {'filter': search_filter, 'item_types': item_types}
         if name:
             request_json['name'] = name
@@ -204,7 +204,7 @@ async def create_search(self,
         """
         url = self._searches_url()
 
-        item_types = [validate_item_type(item) for item in item_types]
+        item_types = [validate_data_item_type(item) for item in item_types]
         request = {
             'name': name,
             'filter': search_filter,
@@ -237,7 +237,7 @@ async def update_search(self,
         """
         url = f'{self._searches_url()}/{search_id}'
 
-        item_types = [validate_item_type(item) for item in item_types]
+        item_types = [validate_data_item_type(item) for item in item_types]
         request = {
             'name': name,
             'filter': search_filter,
@@ -396,7 +396,7 @@ async def get_stats(self,
 
         url = f'{self._base_url}{STATS_PATH}'
 
-        item_types = [validate_item_type(item) for item in item_types]
+        item_types = [validate_data_item_type(item) for item in item_types]
         request = {
             'interval': interval,
             'filter': search_filter,
@@ -450,7 +450,7 @@ async def get_asset(self,
             planet.exceptions.ClientError: If asset type identifier is not
             valid.
         """
-        item_type_id = validate_item_type(item_type_id)
+        item_type_id = validate_data_item_type(item_type_id)
         assets = await self.list_item_assets(item_type_id, item_id)
 
         try:

planet/specs.py

@@ -70,6 +70,17 @@ def validate_item_type(item_type):
     return _validate_field(item_type, supported_item_types, 'item_type')
 
 
+def validate_data_item_type(item_type):
+    '''Validate and correct capitalization of data api item type.'''
+    return _validate_field(item_type, get_data_item_types(), 'item_type')
+
+
+def get_data_item_types():
+    '''Item types supported by the data api.'''
+    # This is a quick-fix for gh-956, to be superseded by gh-960
+    return get_item_types() | {'SkySatVideo'}
+
+
 def validate_order_type(order_type):
     return _validate_field(order_type, SUPPORTED_ORDER_TYPES, 'order_type')
 

setup.cfg

@@ -1,6 +1,3 @@
-[bdist_wheel]
-universal: 1
-
 [metadata]
 license_file: LICENSE
 

setup.py

@@ -51,12 +51,12 @@
     long_description=Path("README.md").read_text("utf-8"),
     long_description_content_type="text/markdown",
     classifiers=[
-        'Development Status :: 3 - Alpha',
+        'Development Status :: 5 - Production/Stable',
         'Environment :: Console',
         'Intended Audience :: Developers',
         'License :: OSI Approved :: Apache Software License',
         'Operating System :: OS Independent',
-        'Programming Language :: Python',
+        'Programming Language :: Python :: 3',
         'Topic :: Scientific/Engineering',
         'Topic :: Software Development',
         'Topic :: Utilities'

tests/unit/test_specs.py

@@ -103,6 +103,11 @@ def test_validate_item_type_notsupported_itemtype():
         specs.validate_item_type('notsupported')
 
 
+def test_validate_data_item_type():
+    '''ensure skysatvideo is included'''
+    specs.validate_data_item_type('skysatvideo')
+
+
 def test_validate_order_type_supported():
     assert 'full' == specs.validate_order_type('FULL')