httpx.Cookies

class documentation

class Cookies(MutableMapping):

View In Hierarchy

HTTP Cookies, as a mutable mapping.
Method __bool__ Undocumented
Method __delitem__ Undocumented
Method __getitem__ Undocumented
Method __init__ Undocumented
Method __iter__ Undocumented
Method __len__ Undocumented
Method __repr__ Undocumented
Method __setitem__ Undocumented
Method clear Delete all cookies. Optionally include a domain and path in order to only delete a subset of all the cookies.
Method delete Delete a cookie by name. May optionally include domain and path in order to specify exactly which cookie to delete.
Method extract​_cookies Loads any cookies based on the response Set-Cookie headers.
Method get Get a cookie by name. May optionally include domain and path in order to specify exactly which cookie to retrieve.
Method set Set a cookie value by name. May optionally include domain and path.
Method set​_cookie​_header Sets an appropriate 'Cookie:' HTTP header on the Request.
Method update Undocumented
Instance Variable jar Undocumented
Class _​Cookie​Compat​Request Wraps a Request instance up in a compatibility interface suitable for use with CookieJar operations.
Class _​Cookie​Compat​Response Wraps a Request instance up in a compatibility interface suitable for use with CookieJar operations.
def __bool__(self):

Undocumented

Returns
boolUndocumented
def __delitem__(self, name):

Undocumented

Parameters
name:strUndocumented
def __getitem__(self, name):

Undocumented

Parameters
name:strUndocumented
Returns
strUndocumented
def __init__(self, cookies=None):

Undocumented

Parameters
cookies:CookieTypesUndocumented
def __iter__(self):

Undocumented

Returns
typing.Iterator[str]Undocumented
def __len__(self):

Undocumented

Returns
intUndocumented
def __repr__(self):

Undocumented

Returns
strUndocumented
def __setitem__(self, name, value):

Undocumented

Parameters
name:strUndocumented
value:strUndocumented
def clear(self, domain=None, path=None):
Delete all cookies. Optionally include a domain and path in order to only delete a subset of all the cookies.
Parameters
domain:strUndocumented
path:strUndocumented
def delete(self, name, domain=None, path=None):
Delete a cookie by name. May optionally include domain and path in order to specify exactly which cookie to delete.
Parameters
name:strUndocumented
domain:strUndocumented
path:strUndocumented
def extract_cookies(self, response):
Loads any cookies based on the response Set-Cookie headers.
Parameters
response:ResponseUndocumented
def get(self, name, default=None, domain=None, path=None):
Get a cookie by name. May optionally include domain and path in order to specify exactly which cookie to retrieve.
Parameters
name:strUndocumented
default:strUndocumented
domain:strUndocumented
path:strUndocumented
Returns
typing.Optional[str]Undocumented
def set(self, name, value, domain='', path='/'):
Set a cookie value by name. May optionally include domain and path.
Parameters
name:strUndocumented
value:strUndocumented
domain:strUndocumented
path:strUndocumented
def set_cookie_header(self, request):
Sets an appropriate 'Cookie:' HTTP header on the Request.
Parameters
request:RequestUndocumented
def update(self, cookies=None):

Undocumented

Parameters
cookies:CookieTypesUndocumented
jar =

Undocumented