python-picnic-api2 1.3.1__tar.gz → 1.3.3__tar.gz

python_picnic_api2-1.3.3/.envrc

@@ -0,0 +1 @@
+use flake

{python_picnic_api2-1.3.1 → python_picnic_api2-1.3.3}/.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.1 → python_picnic_api2-1.3.3}/.github/workflows/ci.yaml

@@ -11,16 +11,16 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: [3.11,3.12]
+        python-version: [3.13,3.14]
         uv-version: [0.6.6]
 
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v6
 
     - 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.1 → python_picnic_api2-1.3.3}/.github/workflows/it.yaml

@@ -11,12 +11,12 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v6
 
-    - name: Set up Python 3.12
-      uses: actions/setup-python@v5
+    - name: Set up Python 3.13
+      uses: actions/setup-python@v6
       with:
-        python-version: 3.12
+        python-version: 3.13
 
     - name: Install uv 0.6.6
       run: |

{python_picnic_api2-1.3.1 → python_picnic_api2-1.3.3}/.github/workflows/release.yml

@@ -4,12 +4,12 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v6
   
-    - name: Set up Python 3.11
-      uses: actions/setup-python@v5
+    - name: Set up Python 3.13
+      uses: actions/setup-python@v6
       with:
-        python-version: 3.11
+        python-version: 3.13
   
     - name: Install uv 0.6.6
       run: |
@@ -26,7 +26,7 @@ jobs:
       run: uv build
 
     - name: Upload artifacts
-      uses: actions/upload-artifact@v4
+      uses: actions/upload-artifact@v6
       with:
         name: release-dists
         path: dist/
@@ -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.1 → python_picnic_api2-1.3.3}/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.4
 Name: python-picnic-api2
-Version: 1.3.1
+Version: 1.3.3
 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>
 Maintainer-email: CodeSalat <pypi@codesalat.dev>
 License: Apache-2.0
 License-File: LICENSE.md
-Requires-Python: >=3.11
+Requires-Python: >=3.13
 Requires-Dist: requests>=2.24.0
 Requires-Dist: typing-extensions>=4.12.2
 Description-Content-Type: text/x-rst

{python_picnic_api2-1.3.1 → python_picnic_api2-1.3.3}/README.md

@@ -1,6 +1,8 @@
 # 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 bu the Home Assistant integration**
+**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. 
 

python_picnic_api2-1.3.3/flake.lock

@@ -0,0 +1,60 @@
+{
+  "nodes": {
+    "flake-utils": {
+      "inputs": {
+        "systems": "systems"
+      },
+      "locked": {
+        "lastModified": 1731533236,
+        "narHash": "sha256-l0KFg5HjrsfsO/JpG+r7fRrqm12kzFHyUHqHCVpMMbI=",
+        "owner": "numtide",
+        "repo": "flake-utils",
+        "rev": "11707dc2f618dd54ca8739b309ec4fc024de578b",
+        "type": "github"
+      },
+      "original": {
+        "owner": "numtide",
+        "repo": "flake-utils",
+        "type": "github"
+      }
+    },
+    "nixpkgs": {
+      "locked": {
+        "lastModified": 1757194111,
+        "narHash": "sha256-4I5rftBv5fUuLkGJ5TZ+LWBz8c+tZ/ZEkUJ/uB0QCOM=",
+        "owner": "nixos",
+        "repo": "nixpkgs",
+        "rev": "64028f19ae7ae87174d168286073ec0dc2b61395",
+        "type": "github"
+      },
+      "original": {
+        "owner": "nixos",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
+    "root": {
+      "inputs": {
+        "flake-utils": "flake-utils",
+        "nixpkgs": "nixpkgs"
+      }
+    },
+    "systems": {
+      "locked": {
+        "lastModified": 1681028828,
+        "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=",
+        "owner": "nix-systems",
+        "repo": "default",
+        "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e",
+        "type": "github"
+      },
+      "original": {
+        "owner": "nix-systems",
+        "repo": "default",
+        "type": "github"
+      }
+    }
+  },
+  "root": "root",
+  "version": 7
+}

python_picnic_api2-1.3.3/flake.nix

@@ -0,0 +1,19 @@
+{
+  inputs = {
+    nixpkgs.url = "github:nixos/nixpkgs";
+    flake-utils.url = "github:numtide/flake-utils";
+  };
+
+  outputs = { self, nixpkgs, flake-utils }:
+    flake-utils.lib.eachDefaultSystem (system:
+      let pkgs = nixpkgs.legacyPackages.${system};
+      in {
+        devShell = pkgs.mkShell { buildInputs = with pkgs; [
+          python313Packages.requests
+          python313Packages.python-lsp-ruff
+          python313Packages.ruff
+          python313Packages.typing-extensions
+        ];
+      };
+    });
+}

{python_picnic_api2-1.3.1 → python_picnic_api2-1.3.3}/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
 
 
@@ -144,15 +147,11 @@ def test_get_current_deliveries():
 
 
 def test_get_categories():
-    response = picnic.get_categories()
-    assert isinstance(response, list)
+    with pytest.raises(NotImplementedError):
+        picnic.get_categories()
 
 
 def test_print_categories(capsys):
-    picnic.print_categories()
-    captured = capsys.readouterr()
-
-    assert isinstance(captured.out, str)
-
+    with pytest.raises(NotImplementedError):
+        picnic.print_categories()
 
-# TODO: add test for re-logging

{python_picnic_api2-1.3.1 → python_picnic_api2-1.3.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "python-picnic-api2"
-version = "1.3.1"
+version = "1.3.3"
 description = ""
 readme = "README.rst"
 license = {text = "Apache-2.0"}
@@ -12,7 +12,7 @@ authors = [
   { name = "CodeSalat", email = "pypi@codesalat.dev"}
 ]
 urls = {homepage = "https://github.com/codesalatdev/python-picnic-api", repository = "https://github.com/codesalatdev/python-picnic-api"}
-requires-python = ">=3.11"
+requires-python = ">=3.13"
 dependencies = [
   "requests>=2.24.0",
   "typing_extensions>=4.12.2"
@@ -21,7 +21,7 @@ dependencies = [
 [tool.ruff]
 line-length = 88
 indent-width = 4
-target-version = "py311"
+target-version = "py313"
 
 [tool.ruff.lint]
 select = [

python_picnic_api2-1.3.3/src/python_picnic_api2/__init__.py

@@ -0,0 +1,7 @@
+from .client import PicnicAPI
+from .session import Picnic2FAError, Picnic2FARequired
+
+__all__ = ["PicnicAPI", "Picnic2FAError", "Picnic2FARequired"]
+__title__ = "python-picnic-api"
+__version__ = "1.1.0"
+__author__ = "Mike Brink"

{python_picnic_api2-1.3.1 → python_picnic_api2-1.3.3}/src/python_picnic_api2/client.py

@@ -8,16 +8,22 @@ from .helper import (
     _extract_search_results,
     _tree_generator,
     _url_generator,
+    find_nodes_by_content,
+)
+from .session import (
+    Picnic2FAError,
+    Picnic2FARequired,
+    PicnicAPISession,
+    PicnicAuthError,
 )
-from .session import PicnicAPISession, PicnicAuthError
 
 DEFAULT_URL = "https://storefront-prod.{}.picnicinternational.com/api/{}"
 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",
 }
 
 
@@ -59,14 +65,18 @@ class PicnicAPI:
 
         return response
 
-    def _post(self, path: str, data=None, base_url_override=None):
+    def _post(
+        self, path: str, data=None, base_url_override=None, add_picnic_headers=False
+    ):
         url = (base_url_override if base_url_override else self._base_url) + path
-        response = self.session.post(url, json=data).json()
+        kwargs = {"json": data}
+        if add_picnic_headers:
+            kwargs["headers"] = _HEADERS
+        response = self.session.post(url, **kwargs).json()
 
         if self._contains_auth_error(response):
             raise PicnicAuthError(
-                f"Picnic authentication error: \
-                    {response['error'].get('message')}"
+                f"Picnic authentication error: {response['error'].get('message')}"
             )
 
         return response
@@ -79,12 +89,82 @@ class PicnicAPI:
         error_code = response.setdefault("error", {}).get("code")
         return error_code == "AUTH_ERROR" or error_code == "AUTH_INVALID_CRED"
 
+    @staticmethod
+    def _requires_2fa(response):
+        if not isinstance(response, dict):
+            return False
+
+        error_code = response.get("error", {}).get("code")
+        return error_code == "TWO_FACTOR_AUTHENTICATION_REQUIRED"
+
     def login(self, username: str, password: str):
         path = "/user/login"
         secret = md5(password.encode("utf-8")).hexdigest()
         data = {"key": username, "secret": secret, "client_id": 30100}
 
-        return self._post(path, data)
+        response = self._post(path, data, add_picnic_headers=True)
+
+        if self._requires_2fa(response):
+            raise Picnic2FARequired(
+                message=response.get("error", {}).get(
+                    "message", "Two-factor authentication required"
+                ),
+                response=response,
+            )
+
+        return response
+
+    def _post_2fa(self, path: str, data=None):
+        """POST for 2FA endpoints that may return empty (204) or JSON error bodies."""
+        url = self._base_url + path
+        response = self.session.post(url, json=data, headers=_HEADERS)
+
+        if response.status_code == 204 or not response.content:
+            return None
+
+        json_body = response.json()
+
+        # This should not happen because password auth is already done
+        # at this point, but just in case.
+        if self._contains_auth_error(json_body):
+            raise PicnicAuthError(
+                f"Picnic authentication error: {json_body['error'].get('message')}"
+            )
+
+        error = json_body.get("error", {})
+        if error.get("code"):
+            raise Picnic2FAError(
+                message=error.get("message", "Two-factor authentication failed"),
+                code=error["code"],
+            )
+
+        return json_body
+
+    def generate_2fa_code(self, channel: str = "SMS"):
+        """Request a 2FA code to be sent via the specified channel.
+
+        Args:
+            channel: The delivery channel ("SMS" or "EMAIL").
+
+        Raises:
+            Picnic2FAError: If the server returns an error (e.g. invalid channel).
+        """
+        path = "/user/2fa/generate"
+        data = {"channel": channel}
+        self._post_2fa(path, data)
+
+    def verify_2fa_code(self, code: str):
+        """Verify the 2FA code to complete authentication.
+
+        Args:
+            code: The OTP code received via SMS or email.
+
+        Raises:
+            Picnic2FAError: If the OTP code is invalid.
+        """
+        path = "/user/2fa/verify"
+        data = {"otp": code}
+        self._post_2fa(path, data)
 
     def logged_in(self):
         return self.session.authenticated
@@ -100,24 +180,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].get("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
 
@@ -168,7 +268,19 @@ class PicnicAPI:
         return self.get_deliveries(data=["CURRENT"])
 
     def get_categories(self, depth: int = 0):
-        return self._get(f"/my_store?depth={depth}")["catalog"]
+        raise NotImplementedError("This endpoint has been removed by picnic\
+        and is no longer functional.")
+
+    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)))

{python_picnic_api2-1.3.1 → python_picnic_api2-1.3.3}/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.1 → python_picnic_api2-1.3.3}/src/python_picnic_api2/session.py

@@ -5,6 +5,30 @@ class PicnicAuthError(Exception):
     """Indicates an error when authenticating to the Picnic API."""
 
 
+class Picnic2FARequired(Exception):
+    """Indicates that two-factor authentication is required."""
+
+    def __init__(
+        self,
+        message: str = "Two-factor authentication required",
+        response: dict = None,
+    ):
+        super().__init__(message)
+        self.response = response or {}
+
+
+class Picnic2FAError(Exception):
+    """Indicates an error during two-factor authentication (e.g. invalid OTP)."""
+
+    def __init__(
+        self,
+        message: str = "Two-factor authentication failed",
+        code: str = None,
+    ):
+        super().__init__(message)
+        self.code = code
+
+
 class PicnicAPISession(Session):
     AUTH_HEADER = "x-picnic-auth"
 
@@ -52,4 +76,4 @@ class PicnicAPISession(Session):
         return response
 
 
-__all__ = ["PicnicAuthError", "PicnicAPISession"]
+__all__ = ["PicnicAuthError", "Picnic2FARequired", "Picnic2FAError", "PicnicAPISession"]