use items instead of "features"

Author: stephenhillier

planet/cli/features.py

@@ -94,7 +94,7 @@ async def collections_list(ctx, pretty, compact):
 @click.argument("collection_id", required=True)
 @pretty
 async def collection_get(ctx, collection_id, pretty):
-    """List Features API collections
+    """Get a collection by ID
 
     Example:
 
@@ -119,7 +119,7 @@ async def items_list(ctx, collection_id, pretty):
     planet features items-list my-collection-123
     """
     async with features_client(ctx) as cl:
-        results = cl.list_features(collection_id)
+        results = cl.list_items(collection_id)
         echo_json([f async for f in results], pretty)
 
 
@@ -154,7 +154,7 @@ async def item_get(ctx, collection_id, feature_id, pretty):
         collection_id, feature_id = split_ref(collection_id)
 
     async with features_client(ctx) as cl:
-        feature = await cl.get_feature(collection_id, feature_id)
+        feature = await cl.get_item(collection_id, feature_id)
         echo_json(feature, pretty)
 
 
@@ -175,7 +175,7 @@ async def item_add(ctx, collection_id, filename, pretty):
     async with features_client(ctx) as cl:
         with open(filename) as data:
             try:
-                res = await cl.add_features(collection_id, json.load(data))
+                res = await cl.add_items(collection_id, json.load(data))
             except json.decoder.JSONDecodeError:
                 raise ClickException(
                     "Only JSON (.json, .geojson) files are supported in the CLI. Please use https://planet.com/features to upload other files."

planet/clients/features.py

@@ -114,7 +114,7 @@ async def get_collection(self, collection_id: str) -> dict:
         response = await self._session.request(method='GET', url=url)
         return response.json()
 
-    async def list_features(
+    async def list_items(
         self,
         collection_id: str,
         limit: int = 10,
@@ -131,7 +131,7 @@ async def list_features(
         example:
 
         ```
-        results = await client.list_features(collection_id)
+        results = await client.list_items(collection_id)
         async for feature in results:
             print(feature.ref)
             print(feature["id"])
@@ -164,8 +164,7 @@ def _next_link(self, page):
                                          limit=limit):
             yield Feature(**feat)
 
-    async def get_feature(self, collection_id: str,
-                          feature_id: str) -> Feature:
+    async def get_item(self, collection_id: str, feature_id: str) -> Feature:
         """
         Return metadata for a single feature in a collection
         """
@@ -198,10 +197,10 @@ async def create_collection(self,
 
         return resp.json()["id"]
 
-    async def add_features(self,
-                           collection_id: str,
-                           feature: Union[dict, GeoInterface],
-                           property_id: Optional[str] = None) -> list[str]:
+    async def add_items(self,
+                        collection_id: str,
+                        feature: Union[dict, GeoInterface],
+                        property_id: Optional[str] = None) -> list[str]:
         """
         Add a Feature or FeatureCollection to the collection given by `collection_id`.
         Returns a list of feature references.

planet/sync/features.py

@@ -83,7 +83,7 @@ def create_collection(self,
         collection = self._client.create_collection(title, description)
         return self._client._call_sync(collection)
 
-    def list_features(self, collection_id: str) -> Iterator[Feature]:
+    def list_items(self, collection_id: str) -> Iterator[Feature]:
         """
         List features in `collection_id`.
 
@@ -97,7 +97,7 @@ def list_features(self, collection_id: str) -> Iterator[Feature]:
 
         ```
         pl = Planet()
-        features = pl.features.list_features(collection_id)
+        features = pl.features.list_items(collection_id)
         for feature in features:
             print(feature.ref)
             print(feature["id"])
@@ -107,25 +107,25 @@ def list_features(self, collection_id: str) -> Iterator[Feature]:
             results = pl.data.search(["PSScene"], geometry=feature])
         ```
         """
-        results = self._client.list_features(collection_id)
+        results = self._client.list_items(collection_id)
 
         try:
             while True:
                 yield self._client._call_sync(results.__anext__())
         except StopAsyncIteration:
             pass
 
-    def get_feature(self, collection_id: str, feature_id: str) -> Feature:
+    def get_item(self, collection_id: str, feature_id: str) -> Feature:
         """
         Return metadata for a single feature in a collection
         """
         return self._client._call_sync(
-            self._client.get_feature(collection_id, feature_id))
+            self._client.get_item(collection_id, feature_id))
 
-    def add_features(self,
-                     collection_id: str,
-                     feature: Union[dict, GeoInterface],
-                     property_id: Optional[str] = None) -> list[str]:
+    def add_items(self,
+                  collection_id: str,
+                  feature: Union[dict, GeoInterface],
+                  property_id: Optional[str] = None) -> list[str]:
         """
         Add a Feature or FeatureCollection to the collection given by `collection_id`.
         Returns a list of feature references.
@@ -180,7 +180,7 @@ def add_features(self,
             "description": "Test feature"
           }
         }
-        new_features = pl.features.add_features(
+        new_features = pl.features.add_items(
           collection_id="my-collection",
           feature=feature,
         )
@@ -193,8 +193,8 @@ def add_features(self,
         The return value is always a list of references, even if you only upload one
         feature.
         """
-        uploaded_features = self._client.add_features(collection_id,
-                                                      feature,
-                                                      property_id)
+        uploaded_features = self._client.add_items(collection_id,
+                                                   feature,
+                                                   property_id)
 
         return self._client._call_sync(uploaded_features)

tests/integration/test_features_api.py

@@ -220,7 +220,7 @@ def assertf(resp):
 
 
 @respx.mock
-async def test_list_features(session: Session):
+async def test_list_items(session: Session):
     collection_id = "test"
     items_url = f'{TEST_URL}/collections/{collection_id}/items'
 
@@ -234,8 +234,8 @@ def assertf(resp):
     cl_async = FeaturesClient(session, base_url=TEST_URL)
     cl_sync = FeaturesAPI(session, base_url=TEST_URL)
 
-    assertf([feat async for feat in cl_async.list_features(collection_id)])
-    assertf(list(cl_sync.list_features(collection_id)))
+    assertf([feat async for feat in cl_async.list_items(collection_id)])
+    assertf(list(cl_sync.list_items(collection_id)))
 
 
 @respx.mock
@@ -245,7 +245,7 @@ def assertf(resp):
                              (TEST_GEOM, TEST_GEOM),
                              (ExampleGeoInterface(), TEST_GEOM),
                          ])
-async def test_add_features(feature, expected_body, session):
+async def test_add_items(feature, expected_body, session):
     """test adding a feature with the SDK
     cases:
     * a geojson Feature
@@ -266,8 +266,8 @@ def assertf(resp):
     cl_async = FeaturesClient(session, base_url=TEST_URL)
     cl_sync = FeaturesAPI(session, base_url=TEST_URL)
 
-    assertf(await cl_async.add_features(collection_id, feature))
-    assertf(cl_sync.add_features(collection_id, feature))
+    assertf(await cl_async.add_items(collection_id, feature))
+    assertf(cl_sync.add_items(collection_id, feature))
 
     # check request body. In all test cases, the request body
     # should be a geojson Feature.

tests/integration/test_features_cli.py

@@ -74,7 +74,7 @@ def assertf(resp):
 
 
 @respx.mock
-def test_list_features():
+def test_list_items():
     collection_id = "test"
     items_url = f'{TEST_URL}/collections/{collection_id}/items'
 
@@ -93,7 +93,7 @@ def assertf(resp):
     (TEST_FEAT, TEST_GEOM),
     (TEST_GEOM, TEST_GEOM),
 ])
-def test_add_features(feature, expected_body):
+def test_add_items(feature, expected_body):
     """test adding a feature with the CLI
     cases:
     * a geojson Feature