Use pythonic variable names where possible (#304)

Author: moradology

stac_fastapi/api/stac_fastapi/api/app.py

@@ -152,14 +152,14 @@ def register_conformance_classes(self):
         )
 
     def register_get_item(self):
-        """Register get item endpoint (GET /collections/{collectionId}/items/{itemId}).
+        """Register get item endpoint (GET /collections/{collection_id}/items/{item_id}).
 
         Returns:
             None
         """
         self.router.add_api_route(
             name="Get Item",
-            path="/collections/{collectionId}/items/{itemId}",
+            path="/collections/{collection_id}/items/{item_id}",
             response_model=Item if self.settings.enable_response_models else None,
             response_class=self.response_class,
             response_model_exclude_unset=True,
@@ -237,14 +237,14 @@ def register_get_collections(self):
         )
 
     def register_get_collection(self):
-        """Register get collection endpoint (GET /collection/{collectionId}).
+        """Register get collection endpoint (GET /collection/{collection_id}).
 
         Returns:
             None
         """
         self.router.add_api_route(
             name="Get Collection",
-            path="/collections/{collectionId}",
+            path="/collections/{collection_id}",
             response_model=Collection if self.settings.enable_response_models else None,
             response_class=self.response_class,
             response_model_exclude_unset=True,
@@ -256,14 +256,14 @@ def register_get_collection(self):
         )
 
     def register_get_item_collection(self):
-        """Register get item collection endpoint (GET /collection/{collectionId}/items).
+        """Register get item collection endpoint (GET /collection/{collection_id}/items).
 
         Returns:
             None
         """
         self.router.add_api_route(
             name="Get ItemCollection",
-            path="/collections/{collectionId}/items",
+            path="/collections/{collection_id}/items",
             response_model=ItemCollection
             if self.settings.enable_response_models
             else None,
@@ -284,9 +284,9 @@ def register_core(self):
             GET /
             GET /conformance
             GET /collections
-            GET /collections/{collectionId}
-            GET /collections/{collectionId}/items
-            GET /collection/{collectionId}/items/{itemId}
+            GET /collections/{collection_id}
+            GET /collections/{collection_id}/items
+            GET /collection/{collection_id}/items/{item_id}
             GET /search
             POST /search
 

stac_fastapi/api/stac_fastapi/api/models.py

@@ -56,22 +56,22 @@ def kwargs(self) -> Dict:
 class CollectionUri(APIRequest):
     """Delete collection."""
 
-    collectionId: str = attr.ib(default=Path(..., description="Collection ID"))
+    collection_id: str = attr.ib(default=Path(..., description="Collection ID"))
 
     def kwargs(self) -> Dict:
         """kwargs."""
-        return {"id": self.collectionId}
+        return {"id": self.collection_id}
 
 
 @attr.s
 class ItemUri(CollectionUri):
     """Delete item."""
 
-    itemId: str = attr.ib(default=Path(..., description="Item ID"))
+    item_id: str = attr.ib(default=Path(..., description="Item ID"))
 
     def kwargs(self) -> Dict:
         """kwargs."""
-        return {"collection_id": self.collectionId, "item_id": self.itemId}
+        return {"collection_id": self.collection_id, "item_id": self.item_id}
 
 
 @attr.s
@@ -93,7 +93,7 @@ class ItemCollectionUri(CollectionUri):
     def kwargs(self) -> Dict:
         """kwargs."""
         return {
-            "id": self.collectionId,
+            "id": self.collection_id,
             "limit": self.limit,
             "token": self.token,
         }

stac_fastapi/extensions/stac_fastapi/extensions/core/context.py

@@ -11,7 +11,7 @@
 class ContextExtension(ApiExtension):
     """Context Extension.
 
-    The Context extension adds a JSON object to ItemCollection responses (`/search`, `/collections/{collectionId}/items`)
+    The Context extension adds a JSON object to ItemCollection responses (`/search`, `/collections/{collection_id}/items`)
     which includes the number of items matched, returned, and the limit requested.
 
     https://github.com/radiantearth/stac-api-spec/blob/master/item-search/README.md#context

stac_fastapi/extensions/stac_fastapi/extensions/core/filter.py

@@ -44,7 +44,7 @@ class FilterExtension(ApiExtension):
     The filter extension adds several endpoints which allow the retrieval of queryables and
     provides an expressive mechanism for searching based on Item Attributes:
         GET /queryables
-        GET /collections/{collectionId}/queryables
+        GET /collections/{collection_id}/queryables
 
     https://github.com/radiantearth/stac-api-spec/blob/master/fragments/filter/README.md
 
@@ -103,7 +103,7 @@ def register(self, app: FastAPI) -> None:
         )
         self.router.add_api_route(
             name="Collection Queryables",
-            path="/collections/{collectionId}/queryables",
+            path="/collections/{collection_id}/queryables",
             methods=["GET"],
             endpoint=self._create_endpoint(self.client.get_queryables, CollectionUri),
         )

stac_fastapi/extensions/stac_fastapi/extensions/core/transaction.py

@@ -22,11 +22,11 @@ class TransactionExtension(ApiExtension):
     The transaction extension adds several endpoints which allow the creation, deletion, and updating of items and
     collections:
         POST /collections
-        PUT /collections/{collectionId}
-        DELETE /collections/{collectionId}
-        POST /collections/{collectionId}/items
-        PUT /collections/{collectionId}/items
-        DELETE /collections/{collectionId}/items
+        PUT /collections/{collection_id}
+        DELETE /collections/{collection_id}
+        POST /collections/{collection_id}/items
+        PUT /collections/{collection_id}/items
+        DELETE /collections/{collection_id}/items
 
     https://github.com/radiantearth/stac-api-spec/blob/master/ogcapi-features/extensions/transaction/README.md
 
@@ -68,10 +68,10 @@ def _create_endpoint(
         raise NotImplementedError
 
     def register_create_item(self):
-        """Register create item endpoint (POST /collections/{collectionId}/items)."""
+        """Register create item endpoint (POST /collections/{collection_id}/items)."""
         self.router.add_api_route(
             name="Create Item",
-            path="/collections/{collectionId}/items",
+            path="/collections/{collection_id}/items",
             response_model=Item if self.settings.enable_response_models else None,
             response_class=self.response_class,
             response_model_exclude_unset=True,
@@ -81,10 +81,10 @@ def register_create_item(self):
         )
 
     def register_update_item(self):
-        """Register update item endpoint (PUT /collections/{collectionId}/items)."""
+        """Register update item endpoint (PUT /collections/{collection_id}/items)."""
         self.router.add_api_route(
             name="Update Item",
-            path="/collections/{collectionId}/items",
+            path="/collections/{collection_id}/items",
             response_model=Item if self.settings.enable_response_models else None,
             response_class=self.response_class,
             response_model_exclude_unset=True,
@@ -94,10 +94,10 @@ def register_update_item(self):
         )
 
     def register_delete_item(self):
-        """Register delete item endpoint (DELETE /collections/{collectionId}/items/{itemId})."""
+        """Register delete item endpoint (DELETE /collections/{collection_id}/items/{item_id})."""
         self.router.add_api_route(
             name="Delete Item",
-            path="/collections/{collectionId}/items/{itemId}",
+            path="/collections/{collection_id}/items/{item_id}",
             response_model=Item if self.settings.enable_response_models else None,
             response_class=self.response_class,
             response_model_exclude_unset=True,
@@ -137,10 +137,10 @@ def register_update_collection(self):
         )
 
     def register_delete_collection(self):
-        """Register delete collection endpoint (DELETE /collections/{collectionId})."""
+        """Register delete collection endpoint (DELETE /collections/{collection_id})."""
         self.router.add_api_route(
             name="Delete Collection",
-            path="/collections/{collectionId}",
+            path="/collections/{collection_id}",
             response_model=Collection if self.settings.enable_response_models else None,
             response_class=self.response_class,
             response_model_exclude_unset=True,

stac_fastapi/extensions/stac_fastapi/extensions/third_party/bulk_transactions.py

@@ -55,7 +55,7 @@ def bulk_item_insert(
 class BulkTransactionExtension(ApiExtension):
     """Bulk Transaction Extension.
 
-    Bulk Transaction extension adds the `POST /collections/{collectionId}/bulk_items` endpoint to the application
+    Bulk Transaction extension adds the `POST /collections/{collection_id}/bulk_items` endpoint to the application
     for efficient bulk insertion of items.
     """
 
@@ -77,7 +77,7 @@ def register(self, app: FastAPI) -> None:
         router = APIRouter()
         router.add_api_route(
             name="Bulk Create Item",
-            path="/collections/{collectionId}/bulk_items",
+            path="/collections/{collection_id}/bulk_items",
             response_model=str,
             response_model_exclude_unset=True,
             response_model_exclude_none=True,

stac_fastapi/extensions/stac_fastapi/extensions/third_party/tiles.py

@@ -205,7 +205,7 @@ def stac_demo(request: Request):
 
         app.add_api_route(
             name="Get OGC Tiles Resource",
-            path="/collections/{collectionId}/items/{itemId}/tiles",
+            path="/collections/{collection_id}/items/{item_id}/tiles",
             response_model=TileSetResource,
             response_model_exclude_none=True,
             response_model_exclude_unset=True,

stac_fastapi/pgstac/stac_fastapi/pgstac/core.py

@@ -74,7 +74,7 @@ async def all_collections(self, **kwargs) -> Collections:
     async def get_collection(self, id: str, **kwargs) -> Collection:
         """Get collection by id.
 
-        Called with `GET /collections/{collectionId}`.
+        Called with `GET /collections/{collection_id}`.
 
         Args:
             id: Id of the collection.
@@ -179,7 +179,7 @@ async def item_collection(
     ) -> ItemCollection:
         """Get all items from a specific collection.
 
-        Called with `GET /collections/{collectionId}/items`
+        Called with `GET /collections/{collection_id}/items`
 
         Args:
             id: id of the collection.
@@ -203,7 +203,7 @@ async def item_collection(
     async def get_item(self, item_id: str, collection_id: str, **kwargs) -> Item:
         """Get item by id.
 
-        Called with `GET /collections/{collectionId}/items/{itemId}`.
+        Called with `GET /collections/{collection_id}/items/{item_id}`.
 
         Args:
             id: Id of the item.

stac_fastapi/pgstac/tests/api/test_api.py

@@ -5,21 +5,21 @@
 STAC_CORE_ROUTES = [
     "GET /",
     "GET /collections",
-    "GET /collections/{collectionId}",
-    "GET /collections/{collectionId}/items",
-    "GET /collections/{collectionId}/items/{itemId}",
+    "GET /collections/{collection_id}",
+    "GET /collections/{collection_id}/items",
+    "GET /collections/{collection_id}/items/{item_id}",
     "GET /conformance",
     "GET /search",
     "POST /search",
 ]
 
 STAC_TRANSACTION_ROUTES = [
-    "DELETE /collections/{collectionId}",
-    "DELETE /collections/{collectionId}/items/{itemId}",
+    "DELETE /collections/{collection_id}",
+    "DELETE /collections/{collection_id}/items/{item_id}",
     "POST /collections",
-    "POST /collections/{collectionId}/items",
+    "POST /collections/{collection_id}/items",
     "PUT /collections",
-    "PUT /collections/{collectionId}/items",
+    "PUT /collections/{collection_id}/items",
 ]
 
 

stac_fastapi/sqlalchemy/tests/api/test_api.py

@@ -5,21 +5,21 @@
 STAC_CORE_ROUTES = [
     "GET /",
     "GET /collections",
-    "GET /collections/{collectionId}",
-    "GET /collections/{collectionId}/items",
-    "GET /collections/{collectionId}/items/{itemId}",
+    "GET /collections/{collection_id}",
+    "GET /collections/{collection_id}/items",
+    "GET /collections/{collection_id}/items/{item_id}",
     "GET /conformance",
     "GET /search",
     "POST /search",
 ]
 
 STAC_TRANSACTION_ROUTES = [
-    "DELETE /collections/{collectionId}",
-    "DELETE /collections/{collectionId}/items/{itemId}",
+    "DELETE /collections/{collection_id}",
+    "DELETE /collections/{collection_id}/items/{item_id}",
     "POST /collections",
-    "POST /collections/{collectionId}/items",
+    "POST /collections/{collection_id}/items",
     "PUT /collections",
-    "PUT /collections/{collectionId}/items",
+    "PUT /collections/{collection_id}/items",
 ]