PlaywrightCapture 1.31.5__tar.gz → 1.31.7__tar.gz

{playwrightcapture-1.31.5 → playwrightcapture-1.31.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: PlaywrightCapture
-Version: 1.31.5
+Version: 1.31.7
 Summary: A simple library to capture websites using playwright
 License: BSD-3-Clause
 Author: Raphaël Vinot

{playwrightcapture-1.31.5 → playwrightcapture-1.31.7}/playwrightcapture/__init__.py

@@ -1,4 +1,6 @@
 from .capture import Capture  # noqa
+from .capture import CaptureResponse  # noqa
+from .capture import SetCookieParam, Cookie  # noqa
 from .helpers import get_devices  # noqa
 from .exceptions import (PlaywrightCaptureException, UnknownPlaywrightDeviceType,  # noqa
                          UnknownPlaywrightBrowser, UnknownPlaywrightDevice,
@@ -6,6 +8,8 @@ from .exceptions import (PlaywrightCaptureException, UnknownPlaywrightDeviceType
 
 __all__ = [
     'Capture',
+    'CaptureResponse',
+    'SetCookieParam', 'Cookie',
     'get_devices',
     'PlaywrightCaptureException',
     'UnknownPlaywrightDeviceType',

{playwrightcapture-1.31.5 → playwrightcapture-1.31.7}/playwrightcapture/capture.py

@@ -46,18 +46,6 @@ if sys.version_info < (3, 11):
 else:
     from asyncio import timeout
 
-if sys.version_info < (3, 12):
-    from typing_extensions import TypedDict
-else:
-    from typing import TypedDict
-
-if TYPE_CHECKING:
-    from playwright._impl._api_structures import (SetCookieParam, Geolocation,
-                                                  HttpCredentials, Headers,
-                                                  ViewportSize, Cookie,
-                                                  ProxySettings, StorageState)
-    BROWSER = Literal['chromium', 'firefox', 'webkit']
-
 try:
     if sys.version_info < (3, 10):
         from pydub import AudioSegment  # type: ignore[attr-defined]
@@ -68,6 +56,54 @@ try:
 except ImportError:
     CAN_SOLVE_CAPTCHA = False
 
+# ####
+# This bit is required as long as we need to support python < 3.12, stop removing it, you idiot
+# That's the runtime failure: https://github.com/ail-project/lacus/actions/runs/16447900822/job/46484807036
+# And the MyPy failure: https://github.com/ail-project/LacusCore/actions/runs/16447753492/job/46484287947
+if sys.version_info < (3, 12):
+    from typing_extensions import TypedDict
+else:
+    from typing import TypedDict
+
+# These two classes are copies of te ones in Playwright, we need them until we can discard python 3.11
+# They come from this file:
+#   https://github.com/microsoft/playwright-python/blob/main/playwright/_impl/_api_structures.py
+
+
+class SetCookieParam(TypedDict, total=False):
+    name: str
+    value: str
+    url: str
+    domain: str
+    path: str
+    expires: float
+    httpOnly: bool
+    secure: bool
+    sameSite: Literal["Lax", "None", "Strict"]
+    partitionKey: str
+
+
+class Cookie(TypedDict, total=False):
+    name: str
+    value: str
+    domain: str
+    path: str
+    expires: float
+    httpOnly: bool
+    secure: bool
+    sameSite: Literal["Lax", "None", "Strict"]
+    partitionKey: str
+
+# ####################################
+
+
+if TYPE_CHECKING:
+    from playwright._impl._api_structures import (Geolocation,
+                                                  HttpCredentials, Headers,
+                                                  ViewportSize,
+                                                  ProxySettings, StorageState)
+    BROWSER = Literal['chromium', 'firefox', 'webkit']
+
 
 class CaptureResponse(TypedDict, total=False):
 
@@ -299,7 +335,7 @@ class Capture():
         return self._cookies
 
     @cookies.setter
-    def cookies(self, cookies: list[dict[str, Any]] | None) -> None:
+    def cookies(self, cookies: list[SetCookieParam | dict[str, Any]] | None) -> None:
         '''Cookies to send along to the initial request.
         :param cookies: The cookies, in this format: https://playwright.dev/python/docs/api/class-browsercontext#browser-context-add-cookies
         '''
@@ -515,7 +551,9 @@ class Capture():
 
         if self.cookies:
             try:
-                await self.context.add_cookies(self.cookies)
+                # NOTE: Ignore type until we can use python 3.12 + only
+                # playwrightcapture.capture.SetCookieParam == playwright._impl._api_structures.SetCookieParam
+                await self.context.add_cookies(self.cookies)  # type: ignore[arg-type]
             except Exception:
                 self.logger.exception(f'Unable to set cookies: {self.cookies}')
 
@@ -1237,7 +1275,9 @@ class Capture():
 
                 try:
                     async with timeout(15):
-                        to_return['cookies'] = await self.context.cookies()
+                        # NOTE: Ignore type until we can use python 3.12 + only
+                        # playwrightcapture.capture.SetCookieParam == playwright._impl._api_structures.SetCookieParam
+                        to_return['cookies'] = await self.context.cookies()  # type: ignore[typeddict-item]
                 except (TimeoutError, asyncio.TimeoutError):
                     self.logger.warning("Unable to get cookies (timeout).")
                     errors.append("Unable to get the cookies (timeout).")

{playwrightcapture-1.31.5 → playwrightcapture-1.31.7}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "PlaywrightCapture"
-version = "1.31.5"
+version = "1.31.7"
 description = "A simple library to capture websites using playwright"
 authors = [
     {name="Raphaël Vinot", email= "raphael.vinot@circl.lu"}