Switch to 2025-06-07 and fix cookies

Author: agg23

playwright/_impl/_api_structures.py

@@ -34,6 +34,10 @@ class Cookie(TypedDict, total=False):
     sameSite: Literal["Lax", "None", "Strict"]
 
 
+class PartitionedCookie(Cookie):
+    partitionKey: Optional[str]
+
+
 # TODO: We are waiting for PEP705 so SetCookieParam can be readonly and matches Cookie.
 class SetCookieParam(TypedDict, total=False):
     name: str
@@ -45,6 +49,7 @@ class SetCookieParam(TypedDict, total=False):
     httpOnly: Optional[bool]
     secure: Optional[bool]
     sameSite: Optional[Literal["Lax", "None", "Strict"]]
+    partitionKey: Optional[str]
 
 
 class FloatRect(TypedDict):
@@ -101,6 +106,11 @@ class StorageState(TypedDict, total=False):
     origins: List[OriginState]
 
 
+class PartitionedStorageState(TypedDict, total=False):
+    cookies: List[PartitionedCookie]
+    origins: List[OriginState]
+
+
 class ClientCertificate(TypedDict, total=False):
     origin: str
     certPath: Optional[Union[str, Path]]

playwright/_impl/_browser_context.py

@@ -32,10 +32,10 @@
 )
 
 from playwright._impl._api_structures import (
-    Cookie,
     Geolocation,
+    PartitionedCookie,
+    PartitionedStorageState,
     SetCookieParam,
-    StorageState,
 )
 from playwright._impl._artifact import Artifact
 from playwright._impl._cdp_session import CDPSession
@@ -317,7 +317,9 @@ async def new_page(self) -> Page:
             raise Error("Please use browser.new_context()")
         return from_channel(await self._channel.send("newPage"))
 
-    async def cookies(self, urls: Union[str, Sequence[str]] = None) -> List[Cookie]:
+    async def cookies(
+        self, urls: Union[str, Sequence[str]] = None
+    ) -> List[PartitionedCookie]:
         if urls is None:
             urls = []
         if isinstance(urls, str):
@@ -594,7 +596,7 @@ async def _inner_close() -> None:
 
     async def storage_state(
         self, path: Union[str, Path] = None, indexedDB: bool = None
-    ) -> StorageState:
+    ) -> PartitionedStorageState:
         result = await self._channel.send_return_as_dict(
             "storageState", {"indexedDB": indexedDB}
         )

playwright/async_api/__init__.py

@@ -69,6 +69,7 @@
 ChromiumBrowserContext = BrowserContext
 
 Cookie = playwright._impl._api_structures.Cookie
+PartitionedCookie = playwright._impl._api_structures.PartitionedCookie
 FilePayload = playwright._impl._api_structures.FilePayload
 FloatRect = playwright._impl._api_structures.FloatRect
 Geolocation = playwright._impl._api_structures.Geolocation

playwright/async_api/_generated.py

@@ -21,12 +21,13 @@
 from playwright._impl._accessibility import Accessibility as AccessibilityImpl
 from playwright._impl._api_structures import (
     ClientCertificate,
-    Cookie,
     FilePayload,
     FloatRect,
     Geolocation,
     HttpCredentials,
     NameValue,
+    PartitionedCookie,
+    PartitionedStorageState,
     PdfMargins,
     Position,
     ProxySettings,
@@ -12649,7 +12650,8 @@ def pages(self) -> typing.List["Page"]:
     def browser(self) -> typing.Optional["Browser"]:
         """BrowserContext.browser
 
-        Returns the browser instance of the context. If it was launched as a persistent context null gets returned.
+        Gets the browser instance that owns the context. Returns `null` if the context is created outside of normal
+        browser, e.g. Android or Electron.
 
         Returns
         -------
@@ -12776,7 +12778,7 @@ async def new_page(self) -> "Page":
 
     async def cookies(
         self, urls: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None
-    ) -> typing.List[Cookie]:
+    ) -> typing.List[PartitionedCookie]:
         """BrowserContext.cookies
 
         If no URLs are specified, this method returns all cookies. If URLs are specified, only cookies that affect those
@@ -12789,7 +12791,7 @@ async def cookies(
 
         Returns
         -------
-        List[{name: str, value: str, domain: str, path: str, expires: float, httpOnly: bool, secure: bool, sameSite: Union["Lax", "None", "Strict"]}]
+        List[{name: str, value: str, domain: str, path: str, expires: float, httpOnly: bool, secure: bool, sameSite: Union["Lax", "None", "Strict"], partitionKey: Union[str, None]}]
         """
 
         return mapping.from_impl_list(
@@ -12810,7 +12812,7 @@ async def add_cookies(self, cookies: typing.Sequence[SetCookieParam]) -> None:
 
         Parameters
         ----------
-        cookies : Sequence[{name: str, value: str, url: Union[str, None], domain: Union[str, None], path: Union[str, None], expires: Union[float, None], httpOnly: Union[bool, None], secure: Union[bool, None], sameSite: Union["Lax", "None", "Strict", None]}]
+        cookies : Sequence[{name: str, value: str, url: Union[str, None], domain: Union[str, None], path: Union[str, None], expires: Union[float, None], httpOnly: Union[bool, None], secure: Union[bool, None], sameSite: Union["Lax", "None", "Strict", None], partitionKey: Union[str, None]}]
         """
 
         return mapping.from_maybe_impl(
@@ -13436,7 +13438,7 @@ async def storage_state(
         *,
         path: typing.Optional[typing.Union[str, pathlib.Path]] = None,
         indexed_db: typing.Optional[bool] = None,
-    ) -> StorageState:
+    ) -> PartitionedStorageState:
         """BrowserContext.storage_state
 
         Returns storage state for this browser context, contains current cookies, local storage snapshot and IndexedDB
@@ -13454,7 +13456,7 @@ async def storage_state(
 
         Returns
         -------
-        {cookies: List[{name: str, value: str, domain: str, path: str, expires: float, httpOnly: bool, secure: bool, sameSite: Union["Lax", "None", "Strict"]}], origins: List[{origin: str, localStorage: List[{name: str, value: str}]}]}
+        {cookies: List[{name: str, value: str, domain: str, path: str, expires: float, httpOnly: bool, secure: bool, sameSite: Union["Lax", "None", "Strict"], partitionKey: Union[str, None]}], origins: List[{origin: str, localStorage: List[{name: str, value: str}]}]}
         """
 
         return mapping.from_impl(
@@ -16445,6 +16447,13 @@ def describe(self, description: str) -> "Locator":
         Describes the locator, description is used in the trace viewer and reports. Returns the locator pointing to the
         same element.
 
+        **Usage**
+
+        ```py
+        button = page.get_by_test_id(\"btn-sub\").describe(\"Subscribe button\")
+        await button.click()
+        ```
+
         Parameters
         ----------
         description : str

playwright/sync_api/__init__.py

@@ -69,6 +69,7 @@
 ChromiumBrowserContext = BrowserContext
 
 Cookie = playwright._impl._api_structures.Cookie
+PartitionedCookie = playwright._impl._api_structures.PartitionedCookie
 FilePayload = playwright._impl._api_structures.FilePayload
 FloatRect = playwright._impl._api_structures.FloatRect
 Geolocation = playwright._impl._api_structures.Geolocation
@@ -175,6 +176,7 @@ def __call__(
     "Locator",
     "Mouse",
     "Page",
+    "PartitionedCookie",
     "PdfMargins",
     "Position",
     "Playwright",

playwright/sync_api/_generated.py

@@ -21,12 +21,13 @@
 from playwright._impl._accessibility import Accessibility as AccessibilityImpl
 from playwright._impl._api_structures import (
     ClientCertificate,
-    Cookie,
     FilePayload,
     FloatRect,
     Geolocation,
     HttpCredentials,
     NameValue,
+    PartitionedCookie,
+    PartitionedStorageState,
     PdfMargins,
     Position,
     ProxySettings,
@@ -12671,7 +12672,8 @@ def pages(self) -> typing.List["Page"]:
     def browser(self) -> typing.Optional["Browser"]:
         """BrowserContext.browser
 
-        Returns the browser instance of the context. If it was launched as a persistent context null gets returned.
+        Gets the browser instance that owns the context. Returns `null` if the context is created outside of normal
+        browser, e.g. Android or Electron.
 
         Returns
         -------
@@ -12798,7 +12800,7 @@ def new_page(self) -> "Page":
 
     def cookies(
         self, urls: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None
-    ) -> typing.List[Cookie]:
+    ) -> typing.List[PartitionedCookie]:
         """BrowserContext.cookies
 
         If no URLs are specified, this method returns all cookies. If URLs are specified, only cookies that affect those
@@ -12811,7 +12813,7 @@ def cookies(
 
         Returns
         -------
-        List[{name: str, value: str, domain: str, path: str, expires: float, httpOnly: bool, secure: bool, sameSite: Union["Lax", "None", "Strict"]}]
+        List[{name: str, value: str, domain: str, path: str, expires: float, httpOnly: bool, secure: bool, sameSite: Union["Lax", "None", "Strict"], partitionKey: Union[str, None]}]
         """
 
         return mapping.from_impl_list(
@@ -12832,7 +12834,7 @@ def add_cookies(self, cookies: typing.Sequence[SetCookieParam]) -> None:
 
         Parameters
         ----------
-        cookies : Sequence[{name: str, value: str, url: Union[str, None], domain: Union[str, None], path: Union[str, None], expires: Union[float, None], httpOnly: Union[bool, None], secure: Union[bool, None], sameSite: Union["Lax", "None", "Strict", None]}]
+        cookies : Sequence[{name: str, value: str, url: Union[str, None], domain: Union[str, None], path: Union[str, None], expires: Union[float, None], httpOnly: Union[bool, None], secure: Union[bool, None], sameSite: Union["Lax", "None", "Strict", None], partitionKey: Union[str, None]}]
         """
 
         return mapping.from_maybe_impl(
@@ -13467,7 +13469,7 @@ def storage_state(
         *,
         path: typing.Optional[typing.Union[str, pathlib.Path]] = None,
         indexed_db: typing.Optional[bool] = None,
-    ) -> StorageState:
+    ) -> PartitionedStorageState:
         """BrowserContext.storage_state
 
         Returns storage state for this browser context, contains current cookies, local storage snapshot and IndexedDB
@@ -13485,7 +13487,7 @@ def storage_state(
 
         Returns
         -------
-        {cookies: List[{name: str, value: str, domain: str, path: str, expires: float, httpOnly: bool, secure: bool, sameSite: Union["Lax", "None", "Strict"]}], origins: List[{origin: str, localStorage: List[{name: str, value: str}]}]}
+        {cookies: List[{name: str, value: str, domain: str, path: str, expires: float, httpOnly: bool, secure: bool, sameSite: Union["Lax", "None", "Strict"], partitionKey: Union[str, None]}], origins: List[{origin: str, localStorage: List[{name: str, value: str}]}]}
         """
 
         return mapping.from_impl(
@@ -16509,6 +16511,13 @@ def describe(self, description: str) -> "Locator":
         Describes the locator, description is used in the trace viewer and reports. Returns the locator pointing to the
         same element.
 
+        **Usage**
+
+        ```py
+        button = page.get_by_test_id(\"btn-sub\").describe(\"Subscribe button\")
+        button.click()
+        ```
+
         Parameters
         ----------
         description : str

scripts/generate_api.py

@@ -225,7 +225,7 @@ def return_value(value: Any) -> List[str]:
 
 
 from playwright._impl._accessibility import Accessibility as AccessibilityImpl
-from playwright._impl._api_structures import Cookie, SetCookieParam, FloatRect, FilePayload, Geolocation, HttpCredentials, PdfMargins, Position, ProxySettings, ResourceTiming, SourceLocation, StorageState, ClientCertificate, ViewportSize, RemoteAddr, SecurityDetails, RequestSizes, NameValue, TracingGroupLocation
+from playwright._impl._api_structures import PartitionedCookie, SetCookieParam, FloatRect, FilePayload, Geolocation, HttpCredentials, PdfMargins, Position, ProxySettings, ResourceTiming, SourceLocation, PartitionedStorageState, StorageState, ClientCertificate, ViewportSize, RemoteAddr, SecurityDetails, RequestSizes, NameValue, TracingGroupLocation
 from playwright._impl._browser import Browser as BrowserImpl
 from playwright._impl._browser_context import BrowserContext as BrowserContextImpl
 from playwright._impl._browser_type import BrowserType as BrowserTypeImpl

setup.py

@@ -21,7 +21,7 @@
 import zipfile
 from typing import Dict
 
-driver_version = "1.53.0-alpha-2025-05-21"
+driver_version = "1.54.0-alpha-2025-06-07"
 
 base_wheel_bundles = [
     {

tests/async/test_defaultbrowsercontext.py

@@ -24,6 +24,7 @@
     List,
     Literal,
     Optional,
+    Sequence,
     Tuple,
 )
 
@@ -124,7 +125,7 @@ async def test_context_add_cookies_should_work(
     ]
 
 
-def _filter_cookies(cookies: List[Cookie]) -> List[Cookie]:
+def _filter_cookies(cookies: Sequence[Cookie]) -> List[Cookie]:
     return list(
         filter(lambda cookie: cookie["domain"] != "copilot.microsoft.com", cookies)
     )