SessionCookies

Storage cookies for session with browser-compatible serialization and deserialization.

Index

Methods

• __bool__
• __deepcopy__
• __eq__
• __getitem__
• __init__
• __iter__
• __len__
• __repr__
• __setitem__
• get_cookies_as_dicts
• get_cookies_as_playwright_format
• set
• set_cookies
• set_cookies_from_playwright_format
• store_cookie
• store_cookies

Properties

• jar

Methods

__bool__

• __bool__(): bool

• Returns bool

__deepcopy__

• __deepcopy__(memo): SessionCookies

• Parameters

  • memo: dict[int, Any] | None

  Returns SessionCookies

__eq__

• __eq__(other): bool

• Parameters

  • other: object

  Returns bool

__getitem__

• __getitem__(name): str | None

• Parameters

  • name: str

  Returns str | None

__init__

• __init__(cookies): None

• Parameters

  • optionalcookies: (((SessionCookies | CookieJar) | dict[str, str]) | list[CookieParam]) | None = None

  Returns None

__iter__

• __iter__(): Iterator[CookieParam]

• Returns Iterator[CookieParam]

__len__

• __len__(): int

• Returns int

__repr__

• __repr__(): str

• Returns str

__setitem__

• __setitem__(name, value): None

• Parameters

  • name: str

  • value: str

  Returns None

get_cookies_as_dicts

• get_cookies_as_dicts(): list[CookieParam]

• Convert cookies to a list with CookieParam dicts.

  ---

  Returns list[CookieParam]

get_cookies_as_playwright_format

• get_cookies_as_playwright_format(): list[PlaywrightCookieParam]

• Get cookies in playwright format.

  ---

  Returns list[PlaywrightCookieParam]

set

• set(name, value, *, domain, path, expires, http_only, secure, same_site): None

• Create and store a cookie with modern browser attributes.

  ---

  Parameters

  • name: str

    Cookie name.

  • value: str

    Cookie value.

  • optionalkeyword-onlydomain: str = ''

    Cookie domain.

  • optionalkeyword-onlypath: str = '/'

    Cookie path.

  • optionalkeyword-onlyexpires: int | None = None

    Cookie expiration timestamp.

  • optionalkeyword-onlyhttp_only: bool = False

    Whether cookie is HTTP-only.

  • optionalkeyword-onlysecure: bool = False

    Whether cookie requires secure context.

  • optionalkeyword-onlysame_site: Literal[Lax, None, Strict] | None = None

    SameSite cookie attribute value.

  Returns None

set_cookies

• set_cookies(cookie_dicts): None

• Create and store cookies from their dictionary representations.

  ---

  Parameters

  • cookie_dicts: list[CookieParam]

    List of dictionaries where each dict represents cookie parameters.

  Returns None

set_cookies_from_playwright_format

• set_cookies_from_playwright_format(pw_cookies): None

• Set cookies from playwright format.

  ---

  Parameters

  • pw_cookies: list[PlaywrightCookieParam]

  Returns None

store_cookie

• store_cookie(cookie): None

• Store a Cookie object in the session cookie jar.

  ---

  Parameters

  • cookie: Cookie

    The Cookie object to store in the jar.

  Returns None

store_cookies

• store_cookies(cookies): None

• Store multiple cookie objects in the session cookie jar.

  ---

  Parameters

  • cookies: list[Cookie]

    A list of cookie objects to store in the jar.

  Returns None

Properties

jar

jar: CookieJar

The cookie jar instance.