fix: Make typing match current specs

Author: Rafiot

pylacus/api.py

@@ -74,8 +74,8 @@ class CaptureSettings(TypedDict, total=False):
     user_agent: str | None
     proxy: str | dict[str, str] | None
     general_timeout_in_sec: int | None
-    cookies: list[dict[str, Any]] | None
-    storage: dict[str, Any] | None
+    cookies: str | dict[str, str] | list[dict[str, Any]] | None
+    storage: str | dict[str, Any] | None
     headers: str | dict[str, str] | None
     http_credentials: dict[str, str] | None
     geolocation: dict[str, float] | None
@@ -149,8 +149,8 @@ def enqueue(self, *,
                 user_agent: str | None=None,
                 proxy: str | dict[str, str] | None=None,
                 general_timeout_in_sec: int | None=None,
-                cookies: list[dict[str, Any]] | None=None,
-                storage: dict[str, Any] | None=None,
+                cookies: str | dict[str, str] | list[dict[str, Any]] | None=None,
+                storage: str | dict[str, Any] | None=None,
                 headers: str | dict[str, str] | None=None,
                 http_credentials: dict[str, str] | None=None,
                 geolocation: dict[str, float] | None=None,
@@ -181,8 +181,8 @@ def enqueue(self, *,
                 user_agent: str | None=None,
                 proxy: str | dict[str, str] | None=None,
                 general_timeout_in_sec: int | None=None,
-                cookies: list[dict[str, Any]] | None=None,
-                storage: dict[str, Any] | None=None,
+                cookies: str | dict[str, str] | list[dict[str, Any]] | None=None,
+                storage: str | dict[str, Any] | None=None,
                 headers: str | dict[str, str] | None=None,
                 http_credentials: dict[str, str] | None=None,
                 geolocation: dict[str, float] | None=None,

tests/test_web.py

@@ -5,6 +5,7 @@
 import unittest
 
 from datetime import datetime
+from typing import Any
 
 from pylacus import PyLacus
 from pylacus.api import CaptureStatus
@@ -39,11 +40,15 @@ def test_submit_cookies(self) -> None:
                 break
             time.sleep(5)
         response = self.client.get_capture(uuid)
+        if not response['cookies']:
+            self.fail("No cookies found")
+        if not response['storage'] or 'cookies' not in response['storage']:
+            self.fail("No storage found")
         self.assertEqual(len(response['cookies']), 1)
         self.assertEqual(response['cookies'][0]['domain'], 'circl.lu')
         self.assertEqual(response['cookies'], response['storage']['cookies'])
 
-        cookie_from_capture = response['cookies'][0]
+        cookie_from_capture: dict[str, Any] = response['cookies'][0]
         expires = datetime.now().timestamp() + 3600
         cookie_from_capture['expires'] = expires
         uuid = self.client.enqueue(url="circl.lu", cookies=cookie_from_capture, max_retries=0)
@@ -53,10 +58,12 @@ def test_submit_cookies(self) -> None:
                 break
             time.sleep(5)
         response = self.client.get_capture(uuid)
+        if not response['cookies']:
+            self.fail("No cookies found")
         self.assertEqual(response['cookies'][0]['expires'], expires)
 
         # Send list
-        cookies_from_capture = response['cookies']
+        cookies_from_capture: list[dict[str, Any]] = response['cookies']
         expires = datetime.now().timestamp() + 4000
         cookies_from_capture[0]['expires'] = expires
         uuid = self.client.enqueue(url="circl.lu", cookies=cookies_from_capture, max_retries=0)
@@ -66,6 +73,8 @@ def test_submit_cookies(self) -> None:
                 break
             time.sleep(5)
         response = self.client.get_capture(uuid)
+        if not response['cookies']:
+            self.fail("No cookies found")
         self.assertEqual(response['cookies'][0]['expires'], expires)
 
         # Send list as json
@@ -77,7 +86,8 @@ def test_submit_cookies(self) -> None:
                 break
             time.sleep(5)
         response = self.client.get_capture(uuid)
-        self.assertEqual(response['cookies'][0]['expires'], expires, response['cookies'])
+        if response['cookies']:
+            self.assertEqual(response['cookies'][0]['expires'], expires, response['cookies'])
 
     def test_submit_storage(self) -> None:
         uuid = self.client.enqueue(url="https://mdn.github.io/dom-examples/web-storage/",
@@ -89,6 +99,8 @@ def test_submit_storage(self) -> None:
             time.sleep(5)
         response = self.client.get_capture(uuid)
         storage = response['storage']
+        if not storage or 'origins' not in storage or not storage['origins']:
+            self.fail("No storage found")
         self.assertEqual(storage['origins'][0]['origin'], 'https://mdn.github.io')
         self.assertEqual(len(storage['origins'][0]['localStorage']), 3)
         for item in storage['origins'][0]['localStorage']:
@@ -118,6 +130,8 @@ def test_submit_storage(self) -> None:
             time.sleep(5)
         response = self.client.get_capture(uuid)
         storage = response['storage']
+        if not storage or 'origins' not in storage or not storage['origins']:
+            self.fail("No storage found")
         self.assertEqual(storage['origins'][0]['origin'], 'https://mdn.github.io')
         self.assertEqual(len(storage['origins'][0]['localStorage']), 3)
         for item in storage['origins'][0]['localStorage']:
@@ -140,6 +154,8 @@ def test_submit_indexeddb(self) -> None:
             time.sleep(5)
         response = self.client.get_capture(uuid)
         storage = response['storage']
+        if not storage or 'origins' not in storage or not storage['origins']:
+            self.fail("No storage found")
         self.assertEqual(storage['origins'][0]['origin'], 'https://mdn.github.io')
         self.assertEqual(len(storage['origins'][0]['indexedDB']), 1)
         indexeddb = storage['origins'][0]['indexedDB'][0]
@@ -162,6 +178,8 @@ def test_submit_indexeddb(self) -> None:
             time.sleep(5)
         response = self.client.get_capture(uuid)
         storage = response['storage']
+        if not storage or 'origins' not in storage or not storage['origins']:
+            self.fail("No storage found")
         self.assertEqual(storage['origins'][0]['origin'], 'https://mdn.github.io')
         self.assertEqual(len(storage['origins'][0]['indexedDB']), 1)
         indexeddb = storage['origins'][0]['indexedDB'][0]