etsy-python 1.2.3__tar.gz → 1.2.4__tar.gz

{etsy_python-1.2.3/etsy_python.egg-info → etsy_python-1.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: etsy-python
-Version: 1.2.3
+Version: 1.2.4
 Summary: Etsy API Client Library for Python
 Author: Amit Ray
 Author-email: mail@amitray.dev

{etsy_python-1.2.3 → etsy_python-1.2.4}/etsy_python/_version.py

@@ -1,3 +1,3 @@
 """Version information for etsy-python package."""
 
-__version__ = "1.2.3"
+__version__ = "1.2.4"

{etsy_python-1.2.3 → etsy_python-1.2.4}/etsy_python/v3/common/Utils.py

@@ -1,6 +1,6 @@
 import warnings
 from enum import Enum
-from typing import Any, Dict, List, Optional
+from typing import Any, Dict, Iterable, List, Optional
 
 
 def warn_removed_legacy_param(operation_id: str) -> None:
@@ -25,6 +25,21 @@ def warn_removed_legacy_param(operation_id: str) -> None:
     )
 
 
+def join_ids(name: str, ids: Iterable[Any]) -> str:
+    """Join a required list of IDs into Etsy's comma-separated query value.
+
+    Raises ``TypeError`` for a string (iterating it would split the ID into
+    characters) and ``ValueError`` when no IDs are given, so a request Etsy
+    would reject is caught before it is sent.
+    """
+    if isinstance(ids, (str, bytes)):
+        raise TypeError(f"{name} must be a list of IDs, not a string")
+    joined = ",".join(map(str, ids)) if ids is not None else ""
+    if not joined:
+        raise ValueError(f"{name} is required and must contain at least one ID")
+    return joined
+
+
 def generate_get_uri(uri: str, params: Optional[Dict[str, Any]] = None) -> str:
     if not params:
         return uri

{etsy_python-1.2.3 → etsy_python-1.2.4}/etsy_python/v3/resources/Listing.py

@@ -2,7 +2,7 @@ import warnings
 from dataclasses import dataclass
 from typing import Optional, List, Dict, Any, Union
 
-from etsy_python.v3.common.Utils import warn_removed_legacy_param
+from etsy_python.v3.common.Utils import join_ids, warn_removed_legacy_param
 from etsy_python.v3.enums.Listing import Includes, State, SortOn, SortOrder
 from etsy_python.v3.exceptions.RequestException import RequestException
 from etsy_python.v3.models.Listing import (
@@ -150,7 +150,7 @@ class ListingResource:
     ) -> Union[Response, RequestException]:
         endpoint = "/listings/batch"
         query_params: Dict[str, Any] = {
-            "listing_ids": ",".join(list(map(str, listing_ids))),
+            "listing_ids": join_ids("listing_ids", listing_ids),
             "includes": ",".join(list(map(lambda inc: inc.value, includes)))
             if includes is not None
             else None,
@@ -179,7 +179,7 @@ class ListingResource:
     ) -> Union[Response, RequestException]:
         endpoint = "/listings/batch/inventory"
         query_params: Dict[str, Any] = {
-            "listing_ids": ",".join(list(map(str, listing_ids))),
+            "listing_ids": join_ids("listing_ids", listing_ids),
         }
         return self.session.make_request(endpoint, query_params=query_params)
 
@@ -188,7 +188,7 @@ class ListingResource:
     ) -> Union[Response, RequestException]:
         endpoint = "/listings/batch/shipping"
         query_params: Dict[str, Any] = {
-            "listing_ids": ",".join(list(map(str, listing_ids))),
+            "listing_ids": join_ids("listing_ids", listing_ids),
         }
         return self.session.make_request(endpoint, query_params=query_params)
 
@@ -260,18 +260,21 @@ class ListingResource:
     def get_listings_by_shop_section_id(
         self,
         shop_id: int,
-        shop_section_ids: Optional[List[int]] = None,
+        shop_section_ids: List[int],
         limit: int = 25,
         offset: int = 0,
         sort_on: SortOn = SortOn.CREATED,
         sort_order: SortOrder = SortOrder.DESC,
         legacy: Optional[bool] = None,
     ) -> Union[Response, RequestException]:
+        """Get listings in the given shop sections.
+
+        Raises ``ValueError`` if ``shop_section_ids`` is empty and
+        ``TypeError`` if it is a string, before any request is sent.
+        """
         endpoint = f"/shops/{shop_id}/shop-sections/listings"
         query_params: Dict[str, Any] = {
-            "shop_section_ids": ",".join(list(map(str, shop_section_ids)))
-            if shop_section_ids is not None
-            else None,
+            "shop_section_ids": join_ids("shop_section_ids", shop_section_ids),
             "limit": limit,
             "offset": offset,
             "sort_on": sort_on.value,

{etsy_python-1.2.3 → etsy_python-1.2.4}/etsy_python/v3/resources/Payment.py

@@ -2,6 +2,7 @@ import warnings
 from dataclasses import dataclass
 from typing import Union, Dict, Any, List
 
+from etsy_python.v3.common.Utils import join_ids
 from etsy_python.v3.exceptions.RequestException import RequestException
 from etsy_python.v3.resources.Session import EtsyClient
 from etsy_python.v3.resources.Response import Response
@@ -16,7 +17,7 @@ class PaymentResource:
     ) -> Union[Response, RequestException]:
         endpoint = f"/shops/{shop_id}/payment-account/ledger-entries/payments"
         query_params: Dict[str, Any] = {
-            "ledger_entry_ids": ",".join(list(map(str, ledger_entry_ids)))
+            "ledger_entry_ids": join_ids("ledger_entry_ids", ledger_entry_ids)
         }
         return self.session.make_request(endpoint, query_params=query_params)
 
@@ -42,5 +43,5 @@ class PaymentResource:
         self, shop_id: int, payment_ids: List[int]
     ) -> Union[Response, RequestException]:
         endpoint = f"/shops/{shop_id}/payments"
-        query_params: Dict[str, Any] = {"payment_ids": ",".join(list(map(str, payment_ids)))}
+        query_params: Dict[str, Any] = {"payment_ids": join_ids("payment_ids", payment_ids)}
         return self.session.make_request(endpoint, query_params=query_params)

{etsy_python-1.2.3 → etsy_python-1.2.4/etsy_python.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: etsy-python
-Version: 1.2.3
+Version: 1.2.4
 Summary: Etsy API Client Library for Python
 Author: Amit Ray
 Author-email: mail@amitray.dev