class Pyjo.UserAgent.CookieJar.Pyjo_UserAgent_CookieJar(*, file: str | PathLike[str] | None = None, ignore: Callable[[Pyjo_Cookie_Response], Any] | None = None, max_cookie_size: int = 4096)[source]

Pyjo.UserAgent.CookieJar inherits all methods from Pyjo.Base and implements the following new ones.

add(*cookies: Pyjo_Cookie_Response) → Self[source]
jar = jar.add(*cookies)

Add multiple Pyjo.Cookie.Response objects to the jar.

all() → list[Pyjo_Cookie_Response][source]
cookies = jar.all()

Return all Pyjo.Cookie.Response objects that are currently stored in the jar.

# Names of all cookies
for cookie in jar.all():
    print(cookie.name)
collect(tx: Pyjo_Transaction) → None[source]
jar.collect(Pyjo.Transaction.HTTP.new())

Collect response cookies from transaction.

empty() → Self[source]
jar = jar.empty()

Empty the jar.

file
file = jar.file
jar.file = '/home/sri/cookies.txt'

File to load() cookies from and save() cookies to in Netscape format.

# Save cookies to file
jar.file = 'cookies.txt'
jar.save()

# Empty cookie jar and load cookies from file
jar.file = 'cookies.txt'
jar.empty().load()
find(url: Pyjo_URL) → list[Pyjo_Cookie_Request][source]
cookies = jar.find(Pyjo.URL.new())

Find Pyjo.Cookie.Request objects in the jar for Pyjo.URL object.

# Names of all cookies found
for cookie in jar.find(Pyjo.URL.new('http://example.com/foo')):
    print(cookie.name)
ignore
ignore = jar.ignore
jar.ignore = lambda cookie: ...

A callback used to decide if a cookie should be ignored by collect().

# Ignore all cookies
jar.ignore = lambda cookie: True

# Ignore cookies for domains "com", "net" and "org"
jar.ignore = lambda cookie: cookie.domain in ('com', 'net', 'org')
load() → Self[source]
jar = jar.load()

Load cookies from file.

size = jar.max_cookie_size
jar.max_cookie_size = 4096

Maximum cookie size in bytes, defaults to 4096 (4KiB).

prepare(tx: Pyjo_Transaction) → None[source]
jar.prepare(Pyjo.Transaction.HTTP.new())

Prepare request cookies for transaction.

save() → Self[source]
jar = jar.save()

Save cookies to file.

to_str() → str[source]
string = jar.to_str()

Stringify cookies in Netscape format.