various fixes:

formatting, search params, test function name, unneeded code removed, imports cleaned up, endpoint extra slash removed

Author: Paul Duncan

predicthq/client.py

@@ -55,7 +55,9 @@ def get_headers(self, headers):
     @stamina.retry(on=RetriableError, attempts=3)
     def request(self, method, path, **kwargs):
         headers = self.get_headers(kwargs.pop("headers", {}))
-        response = requests.request(method, self.build_url(path), headers=headers, **kwargs)
+        response = requests.request(
+            method, self.build_url(path), headers=headers, **kwargs
+        )
         self.logger.debug(response.request.url)
         try:
             response.raise_for_status()

predicthq/config.py

@@ -12,7 +12,6 @@
 
 
 class Config(object):
-
     _config_sections = (
         "endpoint",
         "oauth2",

predicthq/endpoints/base.py

@@ -3,7 +3,7 @@ def __new__(mcs, name, bases, data):
         if "Meta" not in data:
 
             class Meta:
-                """ Used by decorators when overriding schema classes """
+                """Used by decorators when overriding schema classes"""
 
                 pass
 
@@ -35,6 +35,8 @@ def for_account(self, account_id):
 
     def build_url(self, prefix, suffix):
         if self.account_id is not None:
-            return f"/{prefix.strip('/')}/accounts/{self.account_id}/{suffix.strip('/')}/"
+            return (
+                f"/{prefix.strip('/')}/accounts/{self.account_id}/{suffix.strip('/')}/"
+            )
         else:
             return super(UserBaseEndpoint, self).build_url(prefix, suffix)

predicthq/endpoints/oauth2/endpoint.py

@@ -6,11 +6,10 @@
 
 
 class OAuth2Endpoint(BaseEndpoint):
-
     @deprecated(
         reason=(
-                "OAuth2 endpoints in the SDK are deprecated and will be removed in future releases. "
-                "Use TokenAuth (API Access Token) with Client(..., access_token=...)."
+            "OAuth2 endpoints in the SDK are deprecated and will be removed in future releases. "
+            "Use TokenAuth (API Access Token) with Client(..., access_token=...)."
         ),
         category=FutureWarning,
     )
@@ -31,11 +30,10 @@ def get_token(self, client_id, client_secret, scope, grant_type, **kwargs):
             verify=verify_ssl,
         )
 
-
     @deprecated(
         reason=(
-                "OAuth2 endpoints in the SDK are deprecated and will be removed in future releases. "
-                "Use TokenAuth (API Access Token) with Client(..., access_token=...)."
+            "OAuth2 endpoints in the SDK are deprecated and will be removed in future releases. "
+            "Use TokenAuth (API Access Token) with Client(..., access_token=...)."
         ),
         category=FutureWarning,
     )

predicthq/endpoints/v1/accounts/endpoint.py

@@ -5,11 +5,10 @@
 
 
 class AccountsEndpoint(BaseEndpoint):
-
     @deprecated(
         reason=(
-                "The Accounts endpoint in the SDK is deprecated and will be removed in future releases. "
-                "Account information can be managed via the PredictHQ dashboard."
+            "The Accounts endpoint in the SDK is deprecated and will be removed in future releases. "
+            "Account information can be managed via the PredictHQ dashboard."
         ),
         category=FutureWarning,
     )

predicthq/endpoints/v1/beam/endpoint.py

@@ -9,7 +9,7 @@
     AnalysisGroup,
     AnalysisGroupResultSet,
     GeoJson,
-    Place
+    Place,
 )
 from predicthq.endpoints.decorators import accepts, returns
 from typing import overload, List, Optional, TextIO, Union
@@ -185,8 +185,8 @@ def upload_demand(
             self,
             analysis_id: str,
             json: Optional[Union[str, TextIO]] = None,
-            ndjson:  Optional[Union[str, TextIO]] = None,
-            csv:  Optional[Union[str, TextIO]] = None,
+            ndjson: Optional[Union[str, TextIO]] = None,
+            csv: Optional[Union[str, TextIO]] = None,
             **params,
         ): ...
         def upload_demand(self, analysis_id: str, **params):

predicthq/endpoints/v1/beam/schemas.py

@@ -5,6 +5,7 @@
 
 # Python < 3.11 does not have StrEnum in the enum module
 import sys
+
 if sys.version_info < (3, 11):
     import enum
 
@@ -38,7 +39,6 @@ def get_next(self):
         return self._more(**self._kwargs)
 
 
-
 class CreateAnalysisResponse(BaseModel):
     model_config: ConfigDict = ConfigDict(extra="allow")
 

predicthq/endpoints/v1/events/schemas.py

@@ -114,7 +114,9 @@ class Event(BaseModel):
     private: Optional[bool] = None  # Loop add-on
     rank: Optional[int] = None  # PHQ Rank add-on
     predicted_event_spend: Optional[int] = None  # Predicted Event Spend add-on
-    predicted_event_spend_industries: Optional[PredictedEventSpendIndustries] = None  # Predicted Event Spend add-on
+    predicted_event_spend_industries: Optional[PredictedEventSpendIndustries] = (
+        None  # Predicted Event Spend add-on
+    )
 
 
 class EventResultSet(ResultSet):

predicthq/endpoints/v1/features/schemas.py

@@ -20,7 +20,9 @@ def __flatten_json(d: dict, pk: str = "") -> dict:
                 flat_json.update({f"{pk}{separator}{k}" if pk else k: v})
             return flat_json
 
-        return [__flatten_json(d.model_dump(exclude_none=True)) for d in self.iter_all()]
+        return [
+            __flatten_json(d.model_dump(exclude_none=True)) for d in self.iter_all()
+        ]
 
     def to_csv(self, file: str, mode: str = "w+", separator: str = "_") -> None:
         header = None
@@ -65,4 +67,6 @@ def get_next(self):
         if not self.has_next() or not hasattr(self, "_more"):
             return
         params = self._parse_params(self.next)
-        return self._more(_params=params, _json=self._kwargs.get("_json", {}) or self._kwargs)
+        return self._more(
+            _params=params, _json=self._kwargs.get("_json", {}) or self._kwargs
+        )

predicthq/endpoints/v1/saved_locations/endpoint.py

@@ -1,83 +1,54 @@
-from predicthq.endpoints.base import UserBaseEndpoint
-from predicthq.endpoints.base import BaseEndpoint
-from predicthq.endpoints.decorators import accepts, returns
-from typing import overload, List, Optional, TextIO, Union
-from pydantic import BaseModel
+from predicthq.endpoints.base import UserBaseEndpoint, BaseEndpoint
 from predicthq.endpoints.decorators import accepts, returns
+from typing import overload, List, Optional
 from .schemas import (
     SavedLocation,
     SavedLocationResultSet,
     CreateSavedLocationResponse,
     PostSharingEnableResponse,
-    SuggestedRadiusResponse,Location
+    SuggestedRadiusResponse,
+    Location,
 )
 from ..events.schemas import EventResultSet
 
 
-from typing import Optional, List
-
-# Python < 3.11 does not have StrEnum in the enum module
-import sys
-if sys.version_info < (3, 11):
-    import enum
-
-    class StrEnum(str, enum.Enum):
-        pass
-else:
-    from enum import StrEnum
-
-# Python < 3.9 does not have Annotated
-if sys.version_info < (3, 9):
-    from typing_extensions import Annotated
-else:
-    from typing import Annotated
-
-# Python < 3.8 does not have Literal
-if sys.version_info < (3, 8):
-    from typing_extensions import Literal
-else:
-    from typing import Literal
-
-
 class SavedLocationsEndpoint(UserBaseEndpoint):
-
     @overload
     def search(
-            self,
-            location_id: Optional[List[str]] = None,
-            location_code: Optional[List[str]] = None,
-            labels: Optional[List[str]] = None,
-            user_id: Optional[List[str]] = None,
-            subscription_valid_types: Optional[List[str]] = None,
-            q: Optional[str] = None,
-            sort: Optional[List[str]] = None,
-            offset: Optional[int] = None,
-            limit: Optional[int] = None,
-            **params,
+        self,
+        location_id: Optional[List[str]] = None,
+        location_code: Optional[List[str]] = None,
+        labels: Optional[List[str]] = None,
+        user_id: Optional[List[str]] = None,
+        subscription_valid_types: Optional[List[str]] = None,
+        q: Optional[str] = None,
+        sort: Optional[List[str]] = None,
+        offset: Optional[int] = None,
+        limit: Optional[int] = None,
+        **params,
     ): ...
     @accepts()
     @returns(SavedLocationResultSet)
     def search(self, **params):
         verify_ssl = params.pop("config.verify_ssl", True)
-        result =  self.client.get(
+        result = self.client.get(
             self.build_url("v1", "saved-locations"),
             params=params,
             verify=verify_ssl,
         )
         return result
 
-
     @overload
     def create(
-            self,
-            name: str,
-            geojson: dict,
-            labels: Optional[List[str]] = None,
-            location_code: Optional[str] = None,
-            formatted_address: Optional[str] = None,
-            description: Optional[str] = None,
-            place_ids: Optional[List[str]] = None,
-            **params,
+        self,
+        name: str,
+        geojson: dict,
+        labels: Optional[List[str]] = None,
+        location_code: Optional[str] = None,
+        formatted_address: Optional[str] = None,
+        description: Optional[str] = None,
+        place_ids: Optional[List[str]] = None,
+        **params,
     ): ...
     @accepts(query_string=False)
     @returns(CreateSavedLocationResponse)
@@ -91,7 +62,6 @@ def create(self, **params):
         )
         return result
 
-
     @accepts()
     @returns(SavedLocation)
     def get(self, location_id, **params):
@@ -102,30 +72,16 @@ def get(self, location_id, **params):
             verify=verify_ssl,
         )
 
-
     @overload
     def search_event_result_set(
-        location_id : str,
-        date_range_type : Optional[str] = None,
-        offset : Optional[int] = None,
-        limit : Optional[int] = None,
+        location_id: str,
+        date_range_type: Optional[str] = None,
+        offset: Optional[int] = None,
+        limit: Optional[int] = None,
         **params,
-    ):...
+    ): ...
     @returns(EventResultSet)
     def search_event_result_set(self, location_id, **params):
-        """
-        Search for events for a saved location.
-
-        Args:
-            location_id (str): The ID of the location.
-            date_range_type (str, optional): The date range type filter.
-            offset (int, optional): Pagination offset.
-            limit (int, optional): Pagination limit.
-            ... (other query params)
-
-        Returns:
-            EventResultSet: The result set of events.
-        """
         verify_ssl = params.pop("config.verify_ssl", True)
         url = f"{self.build_url('v1', 'saved-locations')}{location_id}/insights/events"
         response = self.client.get(
@@ -135,31 +91,29 @@ def search_event_result_set(self, location_id, **params):
         )
         return response
 
-
     @accepts()
     def refresh_location_insights(self, location_id: str, **params):
         verify_ssl = params.pop("config.verify_ssl", True)
         return self.client.post(
-            f"{self.build_url('v1', 'saved-locations')}{location_id}/insights/refresh/",
+            f"{self.build_url('v1', 'saved-locations')}{location_id}/insights/refresh",
             params=params,
             verify=verify_ssl,
         )
 
-
     @overload
     def replace_location_data(
-            self,
-            location_id: str,
-            name: str,
-            geojson: dict,
-            labels: Optional[List[str]] = None,
-            location_code: Optional[str] = None,
-            formatted_address: Optional[str] = None,
-            description: Optional[str] = None,
-            place_ids: Optional[List[str]] = None,
-            external_id: Optional[str] = None,
-            **params,
-    ):...
+        self,
+        location_id: str,
+        name: str,
+        geojson: dict,
+        labels: Optional[List[str]] = None,
+        location_code: Optional[str] = None,
+        formatted_address: Optional[str] = None,
+        description: Optional[str] = None,
+        place_ids: Optional[List[str]] = None,
+        external_id: Optional[str] = None,
+        **params,
+    ): ...
     @accepts(query_string=False)
     def replace_location_data(self, location_id: str, **params):
         verify_ssl = params.pop("config.verify_ssl", True)
@@ -171,7 +125,6 @@ def replace_location_data(self, location_id: str, **params):
         )
         return response
 
-
     @accepts()
     def delete_location(self, location_id: str, **params):
         verify_ssl = params.pop("config.verify_ssl", True)
@@ -180,8 +133,7 @@ def delete_location(self, location_id: str, **params):
             params=params,
             verify=verify_ssl,
         )
-    #
-    #
+
     @accepts()
     @returns(PostSharingEnableResponse)
     def sharing_enable(self, location_id: str, **params):
@@ -192,15 +144,14 @@ def sharing_enable(self, location_id: str, **params):
             verify=verify_ssl,
         )
 
-
     @overload
     def suggested_radius(
         self,
         location_origin: Location,
         radius_unit: str,
         industry: str,
         **params,
-    ):...
+    ): ...
     @accepts(query_string=False)
     @returns(SuggestedRadiusResponse)
     def suggested_radius(self, **params):
@@ -214,4 +165,4 @@ def suggested_radius(self, **params):
             f"{self.build_url('v1', 'suggested-radius')}",
             params=params,
             verify=verify_ssl,
-        )
+        )