etsy-python 1.2.3__py3-none-any.whl → 1.2.4__py3-none-any.whl

etsy_python/_version.py

@@ -1,3 +1,3 @@
 """Version information for etsy-python package."""
 
-__version__ = "1.2.3"
+__version__ = "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/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/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.dist-info → etsy_python-1.2.4.dist-info}/METADATA

@@ -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.dist-info → etsy_python-1.2.4.dist-info}/RECORD

@@ -1,11 +1,11 @@
 etsy_python/__init__.py,sha256=Xm1g_vbx8ePxmwQ6z-CAhz6_XNgJt7WYT8B5GdOQBcU,72
-etsy_python/_version.py,sha256=_nAucEp8K2gZ5Bj2MGk3ziiNts-4Vo7wpgHQi-JwH24,73
+etsy_python/_version.py,sha256=nKWiuXri-g-Jp66p1fkuyXnHw-sKbV99BMHIVFfeA10,73
 etsy_python/v3/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 etsy_python/v3/auth/OAuth.py,sha256=o4rZ1AoN_KvcoQOoBtW3wVgOOF0uJLjYPffuqrdX5ts,2239
 etsy_python/v3/auth/__init__.py,sha256=5qxAsOoBBneUIfPjmu0gwnd4lHNXebyvRr8V94zxzwA,29
 etsy_python/v3/common/Env.py,sha256=1CzXyv__9xC_BYAIXZr0ytRkSKG9tMwJ6qvkB5OjeIU,525
 etsy_python/v3/common/Request.py,sha256=mnhH-XUJbGUiMUFqoWUaClT_xyz3s4fJCZIULmm5lL0,452
-etsy_python/v3/common/Utils.py,sha256=53z1hU6gu3-0wh9bFhXhLIuYUGrdQO0cs42y250ZtFc,2941
+etsy_python/v3/common/Utils.py,sha256=zjwBnPmxQSoz8D7hvOpg9QBLbU6JZPGT-g8YTmwF3SU,3579
 etsy_python/v3/common/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 etsy_python/v3/enums/HolidayPreferences.py,sha256=z7S6rxlTWPPADUJIaAIUJYtF9bqaePBTpmGw39mbnt4,1180
 etsy_python/v3/enums/Language.py,sha256=JFw3CdB-VU5tz-pTc9N9cfHDnHFV0V2d7Hx2F8xiKR4,186
@@ -32,7 +32,7 @@ etsy_python/v3/models/ShopReturnPolicy.py,sha256=1A2ePna6hfS2Je6m18nR9LV-x_DcAvr
 etsy_python/v3/models/Utils.py,sha256=B2AX2BaqFwdEjdB3miiWaMSelO4u64SV4aa7jE7T4eE,421
 etsy_python/v3/models/__init__.py,sha256=wqm5-ZHKOcHikjKYcY6xT-oJ1PPp9V7sNVxo0dz0oG4,1155
 etsy_python/v3/resources/HolidayPreferences.py,sha256=NvGJbetRKiaWS4Opea8Ujx6Ds5_AlmSu7K62xzdcjgE,1287
-etsy_python/v3/resources/Listing.py,sha256=80d5uxMU6_TjCdYrLSbwLEsW4Us65UNMHohQst13lLg,12184
+etsy_python/v3/resources/Listing.py,sha256=wFbnrhfoGVXeOso49vNYv50N5gOMK-9E0GTTebAWe50,12313
 etsy_python/v3/resources/ListingFile.py,sha256=8o1y2vR5bKQA0RkNqUp0plznwA9V5F956S73cWqxF_M,1581
 etsy_python/v3/resources/ListingImage.py,sha256=ntDKL80h12q2GipI9xKxTD8GQGOSDRTuL2TguViEQBw,1520
 etsy_python/v3/resources/ListingInventory.py,sha256=x3TQx6t7lGDtuV7G7kKrIuYvCxaJmCsLGTP9MJrkOMw,2197
@@ -42,7 +42,7 @@ etsy_python/v3/resources/ListingTranslation.py,sha256=YPegknYGzxqbTqnp2kcngBT1Z7
 etsy_python/v3/resources/ListingVariationImages.py,sha256=29r4dy-_jFeSR_uc-eziETOOEE2jG80qOrQBCK4A9IU,1109
 etsy_python/v3/resources/ListingVideo.py,sha256=w_MKVfp87o5DvErZ8N2-0cmlyG2s6EdKyqwgJ4GvItE,2446
 etsy_python/v3/resources/Miscellaneous.py,sha256=XLPgdfj6-ozBI6cD9zztK1xHnGtOLA0SoTICWVTeBZo,743
-etsy_python/v3/resources/Payment.py,sha256=s5y6fQXB3nlmB4NvMNssvL35kWvEvuNL_kqmMwIjngk,1915
+etsy_python/v3/resources/Payment.py,sha256=nLG1nAZermuupVROznqZ6zYyvwKUPnujwj06EOrQ9o0,1967
 etsy_python/v3/resources/PaymentLedgerEntry.py,sha256=-DZt586d3loa9lUeJIkXGVTdQQPT0SFmel7Pt_u4CoQ,1173
 etsy_python/v3/resources/ProcessingProfile.py,sha256=PAzgN-YABSrjAKnM6dT5rz0GuteAzWZNy7arQSo9ZbY,2417
 etsy_python/v3/resources/Receipt.py,sha256=YqM2jjtqhb9ffvBhfK3HxyADCoHgO7UUTweGa2JYOXM,3176
@@ -62,8 +62,8 @@ etsy_python/v3/resources/__init__.py,sha256=IN6luuFIavLVbARxzg585uPyEKDzsh9BzEGa
 etsy_python/v3/resources/enums/RateLimit.py,sha256=vqbXWjCYXIJz1rzrlB0KmHkBbTCzV4dJbnwa6Qw-7aI,237
 etsy_python/v3/resources/enums/Request.py,sha256=5uRdrCLC9Gu5N55D-YWZeBmcQD5aDNB2CRx321F3uII,179
 etsy_python/v3/resources/enums/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-etsy_python-1.2.3.dist-info/licenses/LICENSE,sha256=FlZBgDGu0cnkgWwW-N0xxiZ3GkySmgH3ejOK76Hr32I,1065
-etsy_python-1.2.3.dist-info/METADATA,sha256=MLPGyaanhS5NVcBsrAr34ByimhxM1rqtAyJhLK6PCp0,15985
-etsy_python-1.2.3.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
-etsy_python-1.2.3.dist-info/top_level.txt,sha256=VFIw33_p9_8pq81cULjVi_mpreBx64_crxZjmFbHlGY,12
-etsy_python-1.2.3.dist-info/RECORD,,
+etsy_python-1.2.4.dist-info/licenses/LICENSE,sha256=FlZBgDGu0cnkgWwW-N0xxiZ3GkySmgH3ejOK76Hr32I,1065
+etsy_python-1.2.4.dist-info/METADATA,sha256=2ycPMDDc7tjCXm1VCJWXrY2_PySEqN9n_QjFalCmnEo,15985
+etsy_python-1.2.4.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
+etsy_python-1.2.4.dist-info/top_level.txt,sha256=VFIw33_p9_8pq81cULjVi_mpreBx64_crxZjmFbHlGY,12
+etsy_python-1.2.4.dist-info/RECORD,,