python-picnic-api2 1.3.0__tar.gz → 1.3.2__tar.gz

{python_picnic_api2-1.3.0 → python_picnic_api2-1.3.2}/.github/ISSUE_TEMPLATE/config.yml

@@ -7,8 +7,8 @@ contact_links:
     url: https://www.home-assistant.io/help
     about: We use GitHub for tracking bugs, check the Home Assistant website for resources on getting help.
   - name: Feature Request
-    url: https://community.home-assistant.io/c/feature-requests
-    about: Please use the Home Assistant Community Forum for making feature requests.
+    url: https://github.com/orgs/home-assistant/discussions/new?category=integration-enhancements&integration_name=picnic
+    about: Please use the Home Assistant Discussions for making feature requests.
   - name: I'm unsure where to go
     url: https://www.home-assistant.io/join-chat
     about: If you are unsure where to go, then joining our chat is recommended; Just ask!

{python_picnic_api2-1.3.0 → python_picnic_api2-1.3.2}/.github/workflows/ci.yaml

@@ -17,10 +17,10 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
 
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v5
+      uses: actions/setup-python@v6
       with:
         python-version: ${{ matrix.python-version }}
 

{python_picnic_api2-1.3.0 → python_picnic_api2-1.3.2}/.github/workflows/it.yaml

@@ -11,10 +11,10 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
 
     - name: Set up Python 3.12
-      uses: actions/setup-python@v5
+      uses: actions/setup-python@v6
       with:
         python-version: 3.12
 

{python_picnic_api2-1.3.0 → python_picnic_api2-1.3.2}/.github/workflows/release.yml

@@ -4,10 +4,10 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
   
     - name: Set up Python 3.11
-      uses: actions/setup-python@v5
+      uses: actions/setup-python@v6
       with:
         python-version: 3.11
   
@@ -40,10 +40,10 @@ jobs:
 
     steps:
       - name: Retrieve release distributions
-        uses: actions/download-artifact@v4
+        uses: actions/download-artifact@v5
         with:
           name: release-dists
           path: dist/
 
       - name: Publish release distributions to PyPI
-        uses: pypa/gh-action-pypi-publish@v1.12.4
+        uses: pypa/gh-action-pypi-publish@v1.13.0

{python_picnic_api2-1.3.0 → python_picnic_api2-1.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-picnic-api2
-Version: 1.3.0
+Version: 1.3.2
 Project-URL: homepage, https://github.com/codesalatdev/python-picnic-api
 Project-URL: repository, https://github.com/codesalatdev/python-picnic-api
 Author-email: Mike Brink <mjh.brink@icloud.com>, CodeSalat <pypi@codesalat.dev>

python_picnic_api2-1.3.2/README.md

@@ -0,0 +1,104 @@
+# Python-Picnic-API
+
+**This library is undergoing rapid changes as is the Picnic API itself. It is mainly intended for use within Home Assistant, but there are integration tests running regularly checking for failures in features not used by the Home Assistant integration.**
+
+**If you want to know why interacting with Picnic is getting harder than ever, check out their blogpost about architectural changes: https://blog.picnic.nl/adding-write-functionality-to-pages-with-self-service-apis-d09aa7dbc9c0**
+
+Fork of the Unofficial Python wrapper for the [Picnic](https://picnic.app) API. While not all API methods have been implemented yet, you'll find most of what you need to build a working application are available. 
+
+This library is not affiliated with Picnic and retrieves data from the endpoints of the mobile application. **Use at your own risk.**
+
+## Credits
+
+A big thanks to @MikeBrink for building the first versions of this library.
+
+@maartenpaul and @thijmen-j continously provided fixes that were then merged into this fork.
+
+## Getting started
+
+The easiest way to install is directly from pip:
+
+```bash
+$ pip install python-picnic-api2
+```
+
+Then create a new instance of `PicnicAPI` and login using your credentials:
+
+```python
+from python_picnic_api2 import PicnicAPI
+
+picnic = PicnicAPI(username='username', password='password', country_code="NL")
+```
+
+The country_code parameter defaults to `NL`, but you have to change it if you live in a different country than the Netherlands (ISO 3166-1 Alpha-2). This obviously only works for countries that picnic services.
+
+## Searching for an article
+
+```python
+picnic.search('coffee')
+```
+
+```python
+[{'items': [{'id': 's1019822', 'name': 'Lavazza Caffè Crema e Aroma Bohnen', 'decorators': [], 'display_price': 1799, 'image_id': 'aecbf7d3b018025ec78daf5a1099b6842a860a2e3faeceec777c13d708ce442c', 'max_count': 99, 'unit_quantity': '1kg', 'sole_article_id': None}, ... ]}]
+```
+
+## Get article by ID
+
+```python
+picnic.get_article("s1019822")
+```
+```python
+{'name': 'Lavazza Caffè Crema e Aroma Bohnen', 'id': 's1019822'}
+```
+
+## Get article by GTIN (EAN)
+```python
+picnic.get_article_by_gtin("8000070025400")
+```
+```python
+{'name': 'Lavazza Caffè Crema e Aroma Bohnen', 'id': 's1019822'}
+```
+
+## Check cart
+
+```python
+picnic.get_cart()
+```
+
+```python
+{'type': 'ORDER', 'id': 'shopping_cart', 'items': [{'type': 'ORDER_LINE', 'id': '1470', 'items': [{'type': 'ORDER_ARTICLE', 'id': 's1019822', 'name': 'Lavazza Caffè Crema e Aroma Bohnen',...
+```
+
+## Manipulating your cart
+All of these methods will return the shopping cart.
+
+```python
+# Add product with ID "s1019822" 2x
+picnic.add_product("s1019822", 2)
+
+# Remove product with ID "s1019822" 1x
+picnic.remove_product("s1019822")
+
+# Clear your cart
+picnic.clear_cart()
+```
+
+## See upcoming deliveries
+
+```python
+picnic.get_current_deliveries()
+```
+
+```python
+[{'delivery_id': 'XXYYZZ', 'creation_time': '2025-04-28T08:08:41.666+02:00', 'slot': {'slot_id': 'XXYYZZ', 'hub_id': '...
+```
+
+## See available delivery slots
+
+```python
+picnic.get_delivery_slots()
+```
+
+```python
+{'delivery_slots': [{'slot_id': 'XXYYZZ', 'hub_id': 'YYY', 'fc_id': 'FCX', 'window_start': '2025-04-29T17:15:00.000+02:00', 'window_end': '2025-04-29T19:15:00.000+02:00'...
+```

{python_picnic_api2-1.3.0 → python_picnic_api2-1.3.2}/integration_tests/test_client.py

@@ -52,8 +52,10 @@ def test_get_article():
 
 
 def test_get_article_with_category_name():
-    with pytest.raises(NotImplementedError):
-        picnic.get_article("s1018620", add_category_name=True)
+    response = picnic.get_article("s1018620", add_category=True)
+    assert isinstance(response, dict)
+    assert "category" in response
+    assert response["category"]["name"] == "H-Milch"
 
 
 def test_get_article_by_gtin():
@@ -81,7 +83,8 @@ def test_add_product():
 
     assert isinstance(response, dict)
     assert "items" in response
-    assert any(item["id"] == "s1018620" for item in response["items"][0]["items"])
+    assert any(
+        item["id"] == "s1018620" for item in response["items"][0]["items"])
     assert _get_amount(response, "s1018620") == 2
 
 

{python_picnic_api2-1.3.0 → python_picnic_api2-1.3.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "python-picnic-api2"
-version = "1.3.0"
+version = "1.3.2"
 description = ""
 readme = "README.rst"
 license = {text = "Apache-2.0"}

{python_picnic_api2-1.3.0 → python_picnic_api2-1.3.2}/src/python_picnic_api2/client.py

@@ -8,6 +8,7 @@ from .helper import (
     _extract_search_results,
     _tree_generator,
     _url_generator,
+    find_nodes_by_content,
 )
 from .session import PicnicAPISession, PicnicAuthError
 
@@ -16,8 +17,8 @@ GLOBAL_GATEWAY_URL = "https://gateway-prod.global.picnicinternational.com"
 DEFAULT_COUNTRY_CODE = "NL"
 DEFAULT_API_VERSION = "15"
 _HEADERS = {
-    "x-picnic-agent": "30100;1.15.272-15295;",
-    "x-picnic-did": "3C417201548B2E3B",
+    "x-picnic-agent": "30100;1.206.1-#15408",
+    "x-picnic-did": "598F770380CA54B6",
 }
 
 
@@ -100,24 +101,44 @@ class PicnicAPI:
     def get_cart(self):
         return self._get("/cart")
 
-    def get_article(self, article_id: str, add_category_name=False):
-        if add_category_name:
-            raise NotImplementedError()
-        path = f"/pages/product-details-page-root?id={article_id}"
+    def get_article(self, article_id: str, add_category=False):
+        path = f"/pages/product-details-page-root?id={article_id}" + \
+            "&show_category_action=true"
         data = self._get(path, add_picnic_headers=True)
         article_details = []
-        for block in data["body"]["child"]["child"]["children"]:
-            if block["id"] == "product-details-page-root-main-container":
-                article_details = block["pml"]["component"]["children"]
+
+        root_container = find_nodes_by_content(
+            data, {"id": "product-details-page-root-main-container"}, max_nodes=1)
+        if len(root_container) == 0:
+            return None
+
+        article_details = root_container[0]["pml"]["component"]["children"]
 
         if len(article_details) == 0:
             return None
 
+        article = {}
+        if add_category:
+            cat_node = find_nodes_by_content(
+                data, {"id": "category-button"}, max_nodes=1)
+            if len(cat_node) == 0:
+                raise KeyError(
+                    f"Could not extract category from article with id {article_id}")
+            category_regex = re.compile(
+                "app\\.picnic:\\/\\/categories\\/(\\d+)\\/l2\\/(\\d+)\\/l3\\/(\\d+)")
+            cat_ids = category_regex.match(
+                cat_node[0]["pml"]["component"]["onPress"]["target"]).groups()
+            article["category"] = self.get_category_by_ids(
+                int(cat_ids[1]), int(cat_ids[2]))
+
         color_regex = re.compile(r"#\(#\d{6}\)")
-        producer = re.sub(color_regex, "", str(article_details[1]["markdown"]))
-        article_name = re.sub(color_regex, "", str(article_details[0]["markdown"]))
+        producer = re.sub(color_regex, "", str(
+            article_details[1].get("markdown", "")))
+        article_name = re.sub(color_regex, "", str(
+            article_details[0]["markdown"]))
 
-        article = {"name": f"{producer} {article_name}", "id": article_id}
+        article["name"] = f"{producer} {article_name}"
+        article["id"] = article_id
 
         return article
 
@@ -170,6 +191,17 @@ class PicnicAPI:
     def get_categories(self, depth: int = 0):
         return self._get(f"/my_store?depth={depth}")["catalog"]
 
+    def get_category_by_ids(self, l2_id: int, l3_id: int):
+        path = "/pages/L2-category-page-root" + \
+            f"?category_id={l2_id}&l3_category_id={l3_id}"
+        data = self._get(path, add_picnic_headers=True)
+        nodes = find_nodes_by_content(
+            data, {"id": f"vertical-article-tiles-sub-header-{l3_id}"}, max_nodes=1)
+        if len(nodes) == 0:
+            raise KeyError("Could not find category with specified IDs")
+        return {"l2_id": l2_id, "l3_id": l3_id,
+                "name": nodes[0]["pml"]["component"]["accessibilityLabel"]}
+
     def print_categories(self, depth: int = 0):
         tree = "\n".join(_tree_generator(self.get_categories(depth=depth)))
         print(tree)

{python_picnic_api2-1.3.0 → python_picnic_api2-1.3.2}/src/python_picnic_api2/helper.py

@@ -85,39 +85,66 @@ def get_image(id: str, size="regular", suffix="webp"):
     return f"{IMAGE_BASE_URL}/{id}/{size}.{suffix}"
 
 
+def find_nodes_by_content(node, filter, max_nodes: int = 10):
+    nodes = []
+
+    if len(nodes) >= 10:
+        return nodes
+
+    def is_dict_included(node_dict, filter_dict):
+        for k, v in filter_dict.items():
+            if k not in node_dict:
+                return False
+            if isinstance(v, dict) and isinstance(node_dict[k], dict):
+                if not is_dict_included(node_dict[k], v):
+                    return False
+            elif node_dict[k] != v and v is not None:
+                return False
+        return True
+
+    if is_dict_included(node, filter):
+        nodes.append(node)
+
+    if isinstance(node, dict):
+        for _, v in node.items():
+            if isinstance(v, dict):
+                nodes.extend(find_nodes_by_content(v, filter, max_nodes))
+                continue
+            if isinstance(v, list):
+                for item in v:
+                    if isinstance(v, dict | list):
+                        nodes.extend(find_nodes_by_content(
+                            item, filter, max_nodes))
+                        continue
+
+    return nodes
+
+
 def _extract_search_results(raw_results, max_items: int = 10):
     """Extract search results from the nested dictionary structure returned by
     Picnic search. Number of max items can be defined to reduce excessive nested
     search"""
-    search_results = []
 
     LOGGER.debug(f"Extracting search results from {raw_results}")
 
-    def find_articles(node):
-        if len(search_results) >= max_items:
-            return
-
-        content = node.get("content", {})
-        if content.get("type") == "SELLING_UNIT_TILE" and "sellingUnit" in content:
-            selling_unit = content["sellingUnit"]
-            sole_article_ids = SOLE_ARTICLE_ID_PATTERN.findall(json.dumps(node))
-            sole_article_id = sole_article_ids[0] if sole_article_ids else None
-            result_entry = {
-                **selling_unit,
-                "sole_article_id": sole_article_id,
-            }
-            LOGGER.debug(f"Found article {result_entry}")
-            search_results.append(result_entry)
-
-        for child in node.get("children", []):
-            find_articles(child)
-
-        if "child" in node:
-            find_articles(node.get("child"))
-
     body = raw_results.get("body", {})
-    find_articles(body.get("child", {}))
+    nodes = find_nodes_by_content(body.get("child", {}), {
+        "type": "SELLING_UNIT_TILE", "sellingUnit": {}})
 
-    LOGGER.debug(f"Found {len(search_results)}/{max_items} products after extraction")
+    search_results = []
+    for node in nodes:
+        selling_unit = node["sellingUnit"]
+        sole_article_ids = SOLE_ARTICLE_ID_PATTERN.findall(
+            json.dumps(node))
+        sole_article_id = sole_article_ids[0] if sole_article_ids else None
+        result_entry = {
+            **selling_unit,
+            "sole_article_id": sole_article_id,
+        }
+        LOGGER.debug(f"Found article {result_entry}")
+        search_results.append(result_entry)
+
+    LOGGER.debug(
+        f"Found {len(search_results)}/{max_items} products after extraction")
 
     return [{"items": search_results}]

{python_picnic_api2-1.3.0 → python_picnic_api2-1.3.2}/tests/test_client.py

@@ -8,8 +8,8 @@ from python_picnic_api2.client import DEFAULT_URL
 from python_picnic_api2.session import PicnicAuthError
 
 PICNIC_HEADERS = {
-    "x-picnic-agent": "30100;1.15.272-15295;",
-    "x-picnic-did": "3C417201548B2E3B",
+    "x-picnic-agent": "30100;1.206.1-#15408",
+    "x-picnic-did": "598F770380CA54B6",
 }
 
 
@@ -23,7 +23,8 @@ class TestClient(unittest.TestCase):
             return self.json_data
 
     def setUp(self) -> None:
-        self.session_patcher = patch("python_picnic_api2.client.PicnicAPISession")
+        self.session_patcher = patch(
+            "python_picnic_api2.client.PicnicAPISession")
         self.session_mock = self.session_patcher.start()
         self.client = PicnicAPI(username="test@test.nl", password="test")
         self.expected_base_url = DEFAULT_URL.format("nl", "15")
@@ -106,6 +107,107 @@ class TestClient(unittest.TestCase):
             headers=PICNIC_HEADERS,
         )
 
+    def test_get_article(self):
+        self.session_mock().get.return_value = self.MockResponse(
+            {"body": {"child": {"child": {"children": [{
+                "id": "product-details-page-root-main-container",
+                "pml": {
+                    "component": {
+                        "children": [
+                            {
+                                "markdown": "#(#333333)Goede start halvarine#(#333333)",
+                            },
+                            {
+                                "markdown": "Blue Band",
+                            },
+
+                        ]
+                    }
+                }
+            }]}}}},
+            200
+        )
+
+        article = self.client.get_article("p3f2qa")
+        self.session_mock().get.assert_called_with(
+            "https://storefront-prod.nl.picnicinternational.com/api/15/pages/product-details-page-root?id=p3f2qa&show_category_action=true",
+            headers=PICNIC_HEADERS,
+        )
+
+        self.assertEqual(
+            article, {'name': 'Blue Band Goede start halvarine', 'id': 'p3f2qa'})
+
+    def test_get_article_with_category(self):
+        self.session_mock().get.return_value = self.MockResponse(
+            {"body": {"child": {"child": {"children": [{
+                "id": "product-details-page-root-main-container",
+                "pml": {
+                    "component": {
+                        "children": [
+                            {
+                                "markdown": "#(#333333)Goede start halvarine#(#333333)",
+                            },
+                            {
+                                "markdown": "Blue Band",
+                            },
+
+                        ]
+                    }
+                }
+            },
+                {
+                "id": "category-button",
+                "pml": {"component": {"onPress": {"target": "app.picnic://categories/1000/l2/2000/l3/3000"}}}
+            }]}}}},
+            200
+        )
+
+        category_patch = patch(
+            "python_picnic_api2.client.PicnicAPI.get_category_by_ids")
+        category_patch.start().return_value = {
+            "l2_id": 2000, "l3_id": 3000, "name": "Test"}
+
+        article = self.client.get_article("p3f2qa", True)
+
+        category_patch.stop()
+        self.session_mock().get.assert_called_with(
+            "https://storefront-prod.nl.picnicinternational.com/api/15/pages/product-details-page-root?id=p3f2qa&show_category_action=true",
+            headers=PICNIC_HEADERS,
+        )
+
+        self.assertEqual(
+            article, {'name': 'Blue Band Goede start halvarine', 'id': 'p3f2qa',
+                      "category": {"l2_id": 2000, "l3_id": 3000, "name": "Test"}})
+
+    def test_get_article_with_unsupported_structure(self):
+        self.session_mock().get.return_value = self.MockResponse(
+            {"body": {"child": {"child": {"children": [{
+                "id": "unsupported-root-container",
+                "pml": {
+                    "component": {
+                        "children": [
+                            {
+                                "markdown": "#(#333333)Goede start halvarine#(#333333)",
+                            },
+                            {
+                                "markdown": "Blue Band",
+                            },
+
+                        ]
+                    }
+                }
+            }]}}}},
+            200
+        )
+
+        article = self.client.get_article("p3f2qa")
+        self.session_mock().get.assert_called_with(
+            "https://storefront-prod.nl.picnicinternational.com/api/15/pages/product-details-page-root?id=p3f2qa&show_category_action=true",
+            headers=PICNIC_HEADERS,
+        )
+
+        assert article is None
+
     def test_get_article_by_gtin(self):
         self.client.get_article_by_gtin("123456789")
         self.session_mock().get.assert_called_with(
@@ -212,6 +314,30 @@ class TestClient(unittest.TestCase):
             {"type": "CATEGORY", "id": "purchases", "name": "Besteld"},
         )
 
+    def test_get_category_by_ids(self):
+        self.session_mock().get.return_value = self.MockResponse(
+            {"children": [
+                {
+                    "id": "vertical-article-tiles-sub-header-22193",
+                    "pml": {
+                        "component": {
+                            "accessibilityLabel": "Halvarine"
+                        }
+                    }
+                }
+            ]},
+            200
+        )
+
+        category = self.client.get_category_by_ids(1000, 22193)
+        self.session_mock().get.assert_called_with(
+            f"{self.expected_base_url}/pages/L2-category-page-root" +
+            "?category_id=1000&l3_category_id=22193", headers=PICNIC_HEADERS
+        )
+
+        self.assertDictEqual(
+            category, {"name": "Halvarine", "l2_id": 1000, "l3_id": 22193})
+
     def test_get_auth_exception(self):
         self.session_mock().get.return_value = self.MockResponse(
             {"error": {"code": "AUTH_ERROR"}}, 400

{python_picnic_api2-1.3.0 → python_picnic_api2-1.3.2}/uv.lock

@@ -197,7 +197,7 @@ wheels = [
 
 [[package]]
 name = "python-picnic-api2"
-version = "1.3.0"
+version = "1.3.2"
 source = { editable = "." }
 dependencies = [
     { name = "requests" },