Skip to content

Free, Open Source, Self-Hosted WhatsApp API Gateway

fix(sdk): type Python catalog info and product reads as optional

Yudhi Armyndharis03faa640692a
diff --git a/sdk/python/openwa/resources/catalog.py b/sdk/python/openwa/resources/catalog.py
index 33522d9df..ef5a59d35 100644
--- a/sdk/python/openwa/resources/catalog.py
+++ b/sdk/python/openwa/resources/catalog.py
@@ -29,7 +29,7 @@ class CatalogResource:
def __init__(self, http: "HttpExecutor") -> None:
self._http = http
- def info(self, session_id: str) -> CatalogInfo:
+ def info(self, session_id: str) -> CatalogInfo | None:
return self._http.request("GET", f"/api/sessions/{quote_segment(session_id)}/catalog")
def products(
@@ -39,7 +39,7 @@ class CatalogResource:
"GET", f"/api/sessions/{quote_segment(session_id)}/catalog/products", query=query
)
- def product(self, session_id: str, product_id: str) -> CatalogProduct:
+ def product(self, session_id: str, product_id: str) -> CatalogProduct | None:
return self._http.request(
"GET", f"/api/sessions/{quote_segment(session_id)}/catalog/products/{quote_segment(product_id)}"
)
diff --git a/sdk/python/tests/test_sdk.py b/sdk/python/tests/test_sdk.py
index 634b14e61..0e91d9c4a 100644
--- a/sdk/python/tests/test_sdk.py
+++ b/sdk/python/tests/test_sdk.py
@@ -12,6 +12,7 @@ import pytest
from openwa import OpenWAClient, OpenWAApiError, OpenWANotFoundError
from openwa._http import build_url
from openwa.errors import OpenWAServiceUnavailableError
+from openwa.resources.catalog import CatalogResource
from openwa.resources.messages import MessagesResource
from openwa.types import (
BatchCancelResponse,
@@ -958,6 +959,16 @@ class TestLabelsChannelsCatalog:
assert "/messages/send-product" in backend.calls[-1].url
assert backend.calls[-1].body == {"chatId": "[email protected]", "productId": "p1", "body": "x"}
+ def test_catalog_reads_return_none_on_an_empty_body(self):
+ # The gateway answers 200 with an empty body when there is no catalog or no such product.
+ backend = MockBackend().on("GET", "/catalog", body=None)
+ client = make_client(backend)
+ assert client.catalog.info("s") is None
+ assert client.catalog.product("s", "p1") is None
+ # Read the annotation as written: evaluating `X | None` needs Python 3.10, and CI runs 3.9.
+ for method in (CatalogResource.info, CatalogResource.product):
+ assert method.__annotations__["return"].endswith("| None")
+
def test_templates_crud(self):
tpl = {"id": "t1", "sessionId": "s", "name": "welcome", "body": "Hi {{name}}", "createdAt": "", "updatedAt": ""}
backend = MockBackend()