python-picnic-api2 1.1.0__tar.gz → 1.2.2__tar.gz

{python_picnic_api2-1.1.0 → python_picnic_api2-1.2.2}/PKG-INFO

@@ -1,22 +1,21 @@
 Metadata-Version: 2.3
 Name: python-picnic-api2
-Version: 1.1.0
+Version: 1.2.2
 Summary: 
 License: Apache-2.0
 Author: Mike Brink
 Author-email: mjh.brink@icloud.com
-Requires-Python: >=3.6,<4.0
+Maintainer: CodeSalat
+Maintainer-email: pypi@codesalat.dev
+Requires-Python: >=3.11
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.6
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
-Requires-Dist: requests (>=2.24.0,<3.0.0)
+Requires-Dist: requests (>=2.24.0)
+Requires-Dist: typing_extensions (>=4.12.2)
+Project-URL: Homepage, https://github.com/codesalatdev/python-picnic-api
 Project-URL: Repository, https://github.com/codesalatdev/python-picnic-api
 Description-Content-Type: text/x-rst
 

python_picnic_api2-1.2.2/pyproject.toml

@@ -0,0 +1,51 @@
+[project]
+name = "python-picnic-api2"
+version = "1.2.2"
+description = ""
+readme = "README.rst"
+license = "Apache-2.0"
+maintainers = [
+  { name = "CodeSalat", email = "pypi@codesalat.dev"}
+]
+authors = [
+  { name = "Mike Brink", email = "mjh.brink@icloud.com"},
+  { 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"
+dependencies = [
+  "requests>=2.24.0",
+  "typing_extensions>=4.12.2"
+]
+
+[tool.poetry.group.dev.dependencies]
+pytest = "^8.3"
+ruff = "^0.9.6"
+python-dotenv = "^0.15.0"
+
+[tool.ruff]
+line-length = 88
+indent-width = 4
+target-version = "py311"
+
+[tool.ruff.lint]
+select = [
+  # pycodestyle
+  "E",
+  # Pyflakes
+  "F",
+  # pyupgrade
+  "UP",
+  # flake8-bugbear
+  "B",
+  # flake8-simplify
+  "SIM",
+  # isort
+  "I",
+  # flake8-fixme
+  "FIX"
+]
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

{python_picnic_api2-1.1.0 → python_picnic_api2-1.2.2}/python_picnic_api2/client.py

@@ -1,6 +1,13 @@
+import re
 from hashlib import md5
 
-from .helper import _tree_generator, _url_generator, _get_category_name, _extract_search_results
+import typing_extensions
+
+from .helper import (
+    _extract_search_results,
+    _tree_generator,
+    _url_generator,
+)
 from .session import PicnicAPISession, PicnicAuthError
 
 DEFAULT_URL = "https://storefront-prod.{}.picnicinternational.com/api/{}"
@@ -11,8 +18,11 @@ DEFAULT_API_VERSION = "15"
 
 class PicnicAPI:
     def __init__(
-        self, username: str = None, password: str = None,
-        country_code: str = DEFAULT_COUNTRY_CODE, auth_token: str = None
+        self,
+        username: str = None,
+        password: str = None,
+        country_code: str = DEFAULT_COUNTRY_CODE,
+        auth_token: str = None,
     ):
         self._country_code = country_code
         self._base_url = _url_generator(
@@ -36,10 +46,14 @@ class PicnicAPI:
         url = self._base_url + path
 
         # Make the request, add special picnic headers if needed
-        headers = {
-            "x-picnic-agent": "30100;1.15.272-15295;",
-            "x-picnic-did": "3C417201548B2E3B"
-        } if add_picnic_headers else None
+        headers = (
+            {
+                "x-picnic-agent": "30100;1.15.272-15295;",
+                "x-picnic-did": "3C417201548B2E3B",
+            }
+            if add_picnic_headers
+            else None
+        )
         response = self.session.get(url, headers=headers).json()
 
         if self._contains_auth_error(response):
@@ -48,11 +62,14 @@ class PicnicAPI:
         return response
 
     def _post(self, path: str, data=None, base_url_override=None):
-        url = (self._base_url if not base_url_override else base_url_override) + path
+        url = (base_url_override if base_url_override else self._base_url) + path
         response = self.session.post(url, json=data).json()
 
         if self._contains_auth_error(response):
-            raise PicnicAuthError(f"Picnic authentication error: {response['error'].get('message')}")
+            raise PicnicAuthError(
+                f"Picnic authentication error: \
+                    {response['error'].get('message')}"
+            )
 
         return response
 
@@ -82,36 +99,28 @@ class PicnicAPI:
         raw_results = self._get(path, add_picnic_headers=True)
         return _extract_search_results(raw_results)
 
-    def get_lists(self, list_id: str = None):
-        if list_id:
-            path = "/lists/" + list_id
-        else:
-            path = "/lists"
-        return self._get(path)
+    def get_cart(self):
+        return self._get("/cart")
 
-    def get_sublist(self, list_id: str, sublist_id: str) -> list:
-        """Get sublist.
+    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}"
+        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"]
 
-        Args:
-            list_id (str): ID of list, corresponding to requested sublist.
-            sublist_id (str): ID of sublist.
+        if len(article_details) == 0:
+            return None
 
-        Returns:
-            list: Sublist result.
-        """
-        return self._get(f"/lists/{list_id}?sublist={sublist_id}")
+        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"]))
 
-    def get_cart(self):
-        return self._get("/cart")
+        article = {"name": f"{producer} {article_name}", "id": article_id}
 
-    def get_article(self, article_id: str, add_category_name=False):
-        path = "/articles/" + article_id
-        article = self._get(path)
-        if add_category_name and "category_link" in article:
-            self.initialize_high_level_categories()
-            article.update(
-                category_name=_get_category_name(article['category_link'], self.high_level_categories)
-            )
         return article
 
     def get_article_category(self, article_id: str):
@@ -144,11 +153,18 @@ class PicnicAPI:
         path = "/deliveries/" + delivery_id + "/position"
         return self._get(path, add_picnic_headers=True)
 
-    def get_deliveries(self, summary: bool = False, data=None):
+    @typing_extensions.deprecated(
+        """The option to show unsummarized deliveries was removed by picnic.
+        The optional parameter 'summary' will be removed in the future and default
+        to True.
+        You can ignore this warning if you do not pass the 'summary' argument to
+        this function."""
+    )
+    def get_deliveries(self, summary: bool = True, data: list = None):
         data = [] if data is None else data
-        if summary:
-            return self._post("/deliveries/summary", data=data)
-        return self._post("/deliveries", data=data)
+        if not summary:
+            raise NotImplementedError()
+        return self._post("/deliveries/summary", data=data)
 
     def get_current_deliveries(self):
         return self.get_deliveries(data=["CURRENT"])

{python_picnic_api2-1.1.0 → python_picnic_api2-1.2.2}/python_picnic_api2/helper.py

@@ -1,6 +1,5 @@
 import json
 import re
-from typing import List, Dict, Any, Optional
 
 # prefix components:
 space = "    "
@@ -10,7 +9,9 @@ tee = "├── "
 last = "└── "
 
 IMAGE_SIZES = ["small", "medium", "regular", "large", "extra-large"]
-IMAGE_BASE_URL = "https://storefront-prod.nl.picnicinternational.com/static/images"
+IMAGE_BASE_URL = (
+    "https://storefront-prod.nl.picnicinternational.com/static/images"
+)
 
 SOLE_ARTICLE_ID_PATTERN = re.compile(r'"sole_article_id":"(\w+)"')
 
@@ -22,14 +23,14 @@ def _tree_generator(response: list, prefix: str = ""):
     """
     # response each get pointers that are ├── with a final └── :
     pointers = [tee] * (len(response) - 1) + [last]
-    for pointer, item in zip(pointers, response):
+    for pointer, item in zip(pointers, response, strict=False):
         if "name" in item:  # print the item
             pre = ""
-            if "unit_quantity" in item.keys():
+            if "unit_quantity" in item:
                 pre = f"{item['unit_quantity']} "
             after = ""
-            if "display_price" in item.keys():
-                after = f" €{int(item['display_price'])/100.0:.2f}"
+            if "display_price" in item:
+                after = f" €{int(item['display_price']) / 100.0:.2f}"
 
             yield prefix + pointer + pre + item["name"] + after
         if "items" in item:  # extend the prefix and recurse:
@@ -42,7 +43,7 @@ def _url_generator(url: str, country_code: str, api_version: str):
     return url.format(country_code.lower(), api_version)
 
 
-def _get_category_id_from_link(category_link: str) -> Optional[str]:
+def _get_category_id_from_link(category_link: str) -> str | None:
     pattern = r"categories/(\d+)"
     first_number = re.search(pattern, category_link)
     if first_number:
@@ -52,7 +53,7 @@ def _get_category_id_from_link(category_link: str) -> Optional[str]:
         return None
 
 
-def _get_category_name(category_link: str, categories: list) -> Optional[str]:
+def _get_category_name(category_link: str, categories: list) -> str | None:
     category_id = _get_category_id_from_link(category_link)
     if category_id:
         category = next(
@@ -73,26 +74,31 @@ def get_recipe_image(id: str, size="regular"):
 
 
 def get_image(id: str, size="regular", suffix="webp"):
-    assert (
-        "tile" in size if suffix == "webp" else True
-    ), "webp format only supports tile sizes"
+    assert "tile" in size if suffix == "webp" else True, (
+        "webp format only supports tile sizes"
+    )
     assert suffix in ["webp", "png"], "suffix must be webp or png"
     sizes = IMAGE_SIZES + [f"tile-{size}" for size in IMAGE_SIZES]
 
     assert size in sizes, "size must be one of: " + ", ".join(sizes)
     return f"{IMAGE_BASE_URL}/{id}/{size}.{suffix}"
 
+
 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"""
+    """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 = []
-    
+
     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:
+        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
@@ -101,11 +107,11 @@ def _extract_search_results(raw_results, max_items: int = 10):
                 "sole_article_id": sole_article_id,
             }
             search_results.append(result_entry)
-        
+
         for child in node.get("children", []):
             find_articles(child)
 
     body = raw_results.get("body", {})
     find_articles(body.get("child", {}))
-    
+
     return [{"items": search_results}]

{python_picnic_api2-1.1.0 → python_picnic_api2-1.2.2}/python_picnic_api2/session.py

@@ -14,15 +14,16 @@ class PicnicAPISession(Session):
 
         self.headers.update(
             {
-                "User-Agent": "okhttp/3.9.0",
+                "User-Agent": "okhttp/4.9.0",
                 "Content-Type": "application/json; charset=UTF-8",
-                self.AUTH_HEADER: self._auth_token
+                self.AUTH_HEADER: self._auth_token,
             }
         )
 
     @property
     def authenticated(self):
-        """Returns whether the user is authenticated by checking if the authentication token is set."""
+        """Returns whether the user is authenticated by checking if the
+        authentication token is set."""
         return bool(self._auth_token)
 
     @property
@@ -38,14 +39,14 @@ class PicnicAPISession(Session):
 
     def get(self, url, **kwargs) -> Response:
         """Do a GET request and update the auth token if set."""
-        response = super(PicnicAPISession, self).get(url, **kwargs)
+        response = super().get(url, **kwargs)
         self._update_auth_token(response.headers.get(self.AUTH_HEADER))
 
         return response
 
     def post(self, url, data=None, json=None, **kwargs) -> Response:
         """Do a POST request and update the auth token if set."""
-        response = super(PicnicAPISession, self).post(url, data, json, **kwargs)
+        response = super().post(url, data, json, **kwargs)
         self._update_auth_token(response.headers.get(self.AUTH_HEADER))
 
         return response

python_picnic_api2-1.1.0/pyproject.toml

@@ -1,22 +0,0 @@
-[tool.poetry]
-name = "python-picnic-api2"
-version = "1.1.0"
-description = ""
-license = "Apache-2.0"
-authors = ["Mike Brink <mjh.brink@icloud.com>", "Noah Groß <pypi@codesalat.dev>"]
-readme = "README.rst"
-repository = "https://github.com/codesalatdev/python-picnic-api"
-
-[tool.poetry.dependencies]
-python = "^3.6"
-requests = "^2.24.0"
-
-[tool.poetry.dev-dependencies]
-pytest = "^5.2"
-flake8 = "^3.8.3"
-black = {version = "^19.10b0", allow-prereleases = true}
-python-dotenv = "^0.15.0"
-
-[build-system]
-requires = ["poetry-core"]
-build-backend = "poetry.core.masonry.api"