Fix formatting for new ruff rules

Author: codesalatdev

.github/workflows/ci.yaml

@@ -44,7 +44,7 @@ jobs:
         
     - name: Lint with ruff
       run: |
-        python -m poetry run ruff check
+        python -m poetry run ruff check --output-format=github --ignore FIX
     
 
 

integration_tests/test_client.py

@@ -1,9 +1,11 @@
-from python_picnic_api2 import PicnicAPI
-from dotenv import load_dotenv
 import os
-import pytest
 import time
 
+import pytest
+from dotenv import load_dotenv
+
+from python_picnic_api2 import PicnicAPI
+
 load_dotenv()
 
 username = os.getenv("USERNAME")
@@ -28,23 +30,23 @@ def _get_amount(cart: dict, product_id: str):
 def test_get_user():
     response = picnic.get_user()
     assert isinstance(response, dict)
-    assert "contact_email" in response.keys()
+    assert "contact_email" in response
     assert response["contact_email"] == username
 
 
 def test_search():
     response = picnic.search("kaffee")
     assert isinstance(response, list)
     assert isinstance(response[0], dict)
-    assert "items" in response[0].keys()
+    assert "items" in response[0]
     assert isinstance(response[0]["items"], list)
     assert "id" in response[0]["items"][0]
 
 
 def test_get_article():
     response = picnic.get_article("s1018620")
     assert isinstance(response, dict)
-    assert "id" in response.keys()
+    assert "id" in response
     assert response["id"] == "s1018620"
     assert response["name"] == "Gut&Günstig H-Milch 3,5%"
 
@@ -57,7 +59,7 @@ def test_get_article_with_category_name():
 def test_get_cart():
     response = picnic.get_cart()
     assert isinstance(response, dict)
-    assert "id" in response.keys()
+    assert "id" in response
     assert response["id"] == "shopping_cart"
 
 
@@ -67,9 +69,8 @@ def test_add_product():
     response = picnic.add_product("s1018620", count=2)
 
     assert isinstance(response, dict)
-    assert "items" in response.keys()
-    assert any(
-        item["id"] == "s1018620" for item in response["items"][0]["items"])
+    assert "items" in response
+    assert any(item["id"] == "s1018620" for item in response["items"][0]["items"])
     assert _get_amount(response, "s1018620") == 2
 
 
@@ -83,7 +84,7 @@ def test_remove_product():
     amount = _get_amount(response, "s1018620")
 
     assert isinstance(response, dict)
-    assert "items" in response.keys()
+    assert "items" in response
     assert amount == 1
 
 
@@ -96,14 +97,14 @@ def test_clear_cart():
     response = picnic.clear_cart()
 
     assert isinstance(response, dict)
-    assert "items" in response.keys()
+    assert "items" in response
     assert len(response["items"]) == 0
 
 
 def test_get_delivery_slots():
     response = picnic.get_delivery_slots()
     assert isinstance(response, dict)
-    assert "delivery_slots" in response.keys()
+    assert "delivery_slots" in response
     assert isinstance(response["delivery_slots"], list)
 
 
@@ -143,4 +144,4 @@ def test_print_categories(capsys):
     assert isinstance(captured.out, str)
 
 
-# TO DO: add test for re-logging
+# TODO: add test for re-logging

integration_tests/test_helper.py

@@ -1,6 +1,7 @@
-from python_picnic_api2.helper import get_image, get_recipe_image
 import requests
 
+from python_picnic_api2.helper import get_image, get_recipe_image
+
 
 def test_get_image():
     id = "8560e1f1c2d2811dfefbbb2342ef0d95250533f2131416aca459bde35d73e901"

integration_tests/test_session.py

@@ -1,9 +1,11 @@
-from python_picnic_api2.session import PicnicAPISession, PicnicAuthError
-from python_picnic_api2.client import PicnicAPI
-from requests import Session
-from dotenv import load_dotenv
 import os
 
+from dotenv import load_dotenv
+from requests import Session
+
+from python_picnic_api2.client import PicnicAPI
+from python_picnic_api2.session import PicnicAPISession, PicnicAuthError
+
 load_dotenv()
 
 username = os.getenv("USERNAME")
@@ -19,16 +21,20 @@ def test_init():
 
 
 def test_login():
-    client = PicnicAPI(username=username, password=password,
-                       country_code=country_code)
-    assert "x-picnic-auth" in client.session.headers.keys()
+    client = PicnicAPI(
+        username=username, password=password, country_code=country_code
+    )
+    assert "x-picnic-auth" in client.session.headers
 
 
 def test_login_auth_error():
     try:
-        PicnicAPI(username="[email protected]", password="PasSWorD12345!",
-                  country_code=country_code)
+        PicnicAPI(
+            username="[email protected]",
+            password="PasSWorD12345!",
+            country_code=country_code,
+        )
     except PicnicAuthError:
         assert True
     else:
-        assert False
+        raise AssertionError()

poetry.lock

@@ -14,7 +14,8 @@ authors = [
 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"
+  "requests>=2.24.0",
+  "typing_extensions>=4.12.2"
 ]
 
 [tool.poetry.group.dev.dependencies]
@@ -23,10 +24,28 @@ ruff = "^0.9.6"
 python-dotenv = "^0.15.0"
 
 [tool.ruff]
-line-length = 80
+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"

pyproject.toml

@@ -1,10 +1,12 @@
-from hashlib import md5
 import re
+from hashlib import md5
+
+import typing_extensions
 
 from .helper import (
+    _extract_search_results,
     _tree_generator,
     _url_generator,
-    _extract_search_results,
 )
 from .session import PicnicAPISession, PicnicAuthError
 
@@ -60,12 +62,13 @@ def _get(self, path: str, add_picnic_headers=False):
         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')}"
+                f"Picnic authentication error: \
+                    {response['error'].get('message')}"
             )
 
         return response
@@ -114,13 +117,9 @@ def get_article(self, article_id: str, add_category_name=False):
 
         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"]))
+        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}", "id": article_id}
 
         return article
 
@@ -154,7 +153,14 @@ def get_delivery_position(self, delivery_id: str):
         path = "/deliveries/" + delivery_id + "/position"
         return self._get(path, add_picnic_headers=True)
 
-    def get_deliveries(self, summary: bool = True, 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 not summary:
             raise NotImplementedError()

python_picnic_api2/client.py

@@ -1,6 +1,5 @@
 import json
 import re
-from typing import Optional
 
 # prefix components:
 space = "    "
@@ -10,7 +9,9 @@
 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,13 +23,13 @@ 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():
+            if "display_price" in item:
                 after = f" €{int(item['display_price']) / 100.0:.2f}"
 
             yield prefix + pointer + pre + item["name"] + after
@@ -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(
@@ -84,16 +85,20 @@ def get_image(id: str, size="regular", suffix="webp"):
 
 
 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

python_picnic_api2/helper.py

@@ -22,7 +22,8 @@ def __init__(self, auth_token: str = None):
 
     @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 @@ def _update_auth_token(self, auth_token):
 
     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