Rename cookie types

Author: agg23

playwright/_impl/_api_structures.py

@@ -32,9 +32,10 @@ class Cookie(TypedDict, total=False):
     httpOnly: bool
     secure: bool
     sameSite: Literal["Lax", "None", "Strict"]
+    partitionKey: Optional[str]
 
 
-class ContextCookie(TypedDict, total=False):
+class StorageStateCookie(TypedDict, total=False):
     name: str
     value: str
     domain: str
@@ -43,7 +44,6 @@ class ContextCookie(TypedDict, total=False):
     httpOnly: bool
     secure: bool
     sameSite: Literal["Lax", "None", "Strict"]
-    partitionKey: Optional[str]
 
 
 # TODO: We are waiting for PEP705 so SetCookieParam can be readonly and matches Cookie.
@@ -110,7 +110,7 @@ class ProxySettings(TypedDict, total=False):
 
 
 class StorageState(TypedDict, total=False):
-    cookies: List[Cookie]
+    cookies: List[StorageStateCookie]
     origins: List[OriginState]
 
 

playwright/_impl/_browser_context.py

@@ -32,7 +32,7 @@
 )
 
 from playwright._impl._api_structures import (
-    ContextCookie,
+    Cookie,
     Geolocation,
     SetCookieParam,
     StorageState,
@@ -334,9 +334,7 @@ async def new_page(self) -> Page:
             raise Error("Please use browser.new_context()")
         return from_channel(await self._channel.send("newPage", None))
 
-    async def cookies(
-        self, urls: Union[str, Sequence[str]] = None
-    ) -> List[ContextCookie]:
+    async def cookies(self, urls: Union[str, Sequence[str]] = None) -> List[Cookie]:
         if urls is None:
             urls = []
         if isinstance(urls, str):

playwright/async_api/__init__.py

@@ -68,7 +68,6 @@
 
 ChromiumBrowserContext = BrowserContext
 
-ContextCookie = playwright._impl._api_structures.ContextCookie
 Cookie = playwright._impl._api_structures.Cookie
 FilePayload = playwright._impl._api_structures.FilePayload
 FloatRect = playwright._impl._api_structures.FloatRect
@@ -80,6 +79,7 @@
 ResourceTiming = playwright._impl._api_structures.ResourceTiming
 SourceLocation = playwright._impl._api_structures.SourceLocation
 StorageState = playwright._impl._api_structures.StorageState
+StorageStateCookie = playwright._impl._api_structures.StorageStateCookie
 ViewportSize = playwright._impl._api_structures.ViewportSize
 
 Error = playwright._impl._errors.Error
@@ -160,7 +160,6 @@ def __call__(
     "CDPSession",
     "ChromiumBrowserContext",
     "ConsoleMessage",
-    "ContextCookie",
     "Cookie",
     "Dialog",
     "Download",
@@ -189,6 +188,7 @@ def __call__(
     "Selectors",
     "SourceLocation",
     "StorageState",
+    "StorageStateCookie",
     "TimeoutError",
     "Touchscreen",
     "Video",

playwright/async_api/_generated.py

@@ -21,7 +21,7 @@
 from playwright._impl._accessibility import Accessibility as AccessibilityImpl
 from playwright._impl._api_structures import (
     ClientCertificate,
-    ContextCookie,
+    Cookie,
     FilePayload,
     FloatRect,
     Geolocation,
@@ -12794,7 +12794,7 @@ async def new_page(self) -> "Page":
 
     async def cookies(
         self, urls: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None
-    ) -> typing.List[ContextCookie]:
+    ) -> typing.List[Cookie]:
         """BrowserContext.cookies
 
         If no URLs are specified, this method returns all cookies. If URLs are specified, only cookies that affect those

playwright/sync_api/__init__.py

@@ -68,7 +68,6 @@
 
 ChromiumBrowserContext = BrowserContext
 
-ContextCookie = playwright._impl._api_structures.ContextCookie
 Cookie = playwright._impl._api_structures.Cookie
 FilePayload = playwright._impl._api_structures.FilePayload
 FloatRect = playwright._impl._api_structures.FloatRect
@@ -80,6 +79,7 @@
 ResourceTiming = playwright._impl._api_structures.ResourceTiming
 SourceLocation = playwright._impl._api_structures.SourceLocation
 StorageState = playwright._impl._api_structures.StorageState
+StorageStateCookie = playwright._impl._api_structures.StorageStateCookie
 ViewportSize = playwright._impl._api_structures.ViewportSize
 
 Error = playwright._impl._errors.Error
@@ -159,7 +159,6 @@ def __call__(
     "CDPSession",
     "ChromiumBrowserContext",
     "ConsoleMessage",
-    "ContextCookie",
     "Cookie",
     "Dialog",
     "Download",
@@ -188,6 +187,7 @@ def __call__(
     "Selectors",
     "SourceLocation",
     "StorageState",
+    "StorageStateCookie",
     "sync_playwright",
     "TimeoutError",
     "Touchscreen",

playwright/sync_api/_generated.py

@@ -21,7 +21,7 @@
 from playwright._impl._accessibility import Accessibility as AccessibilityImpl
 from playwright._impl._api_structures import (
     ClientCertificate,
-    ContextCookie,
+    Cookie,
     FilePayload,
     FloatRect,
     Geolocation,
@@ -12816,7 +12816,7 @@ def new_page(self) -> "Page":
 
     def cookies(
         self, urls: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None
-    ) -> typing.List[ContextCookie]:
+    ) -> typing.List[Cookie]:
         """BrowserContext.cookies
 
         If no URLs are specified, this method returns all cookies. If URLs are specified, only cookies that affect those

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 ContextCookie, SetCookieParam, FloatRect, FilePayload, Geolocation, HttpCredentials, PdfMargins, Position, ProxySettings, ResourceTiming, SourceLocation, StorageState, ClientCertificate, ViewportSize, RemoteAddr, SecurityDetails, RequestSizes, NameValue, TracingGroupLocation
+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._browser import Browser as BrowserImpl
 from playwright._impl._browser_context import BrowserContext as BrowserContextImpl
 from playwright._impl._browser_type import BrowserType as BrowserTypeImpl