Skip to content

bareutils.cookies

module bareutils.cookies

Summary

Cookies

function bareutils.cookies.decode_cookies

Summary

Decode a cookie header

bareutils.cookies.decode_cookies(
cookies: bytes
) -> Mapping[bytes, list[bytes]]

Parameters

cookies: bytes

The header

Returns

Mapping[bytes, list[bytes]]: The cookies

Summary

Decode a set-cookie header into a dictionary.

Description

The max-age value is represented as a datatime.timedelta. The expires value is represented as a datetine.datetime. The secure value is represented as a bool.

bareutils.cookies.decode_set_cookie(
set_cookie: bytes
) -> Mapping[str, Any]

Parameters

set_cookie: bytes

The set-cookie header

Returns

Mapping[str, Any]: A dictionary of the values

function bareutils.cookies.encode_cookies

Summary

Encode the cookie header

bareutils.cookies.encode_cookies(
cookies: Mapping[bytes, List[bytes]]
) -> bytes

Parameters

cookies: Mapping[bytes, List[bytes]]

The cookies

Returns

bytes: The cookie header

Summary

Encode set-cookie

bareutils.cookies.encode_set_cookie(
name: bytes,
value: bytes,
*,
expires: Optional[datetime],
max_age: Optional[Union[int, timedelta]],
path: Optional[bytes],
domain: Optional[bytes],
secure: bool,
http_only: bool,
same_site: Optional[bytes]
) -> bytes

Parameters

name: bytes

The cookie name

value: bytes

The cookie value

expires: Optional[datetime]

The time the cookie expires. Defaults to None.

max_age: Optional[Union[int, timedelta]]

The maximum age of the cookie in seconds. Defaults to None.

path: Optional[bytes] (optional)

The cookie path. Defaults to None.

domain: Optional[bytes] (optional)

The cookie domain. Defaults to None.

secure: bool

Indicates if the cookie is restricted to https. Defaults to False.

http_only: bool

Indicates if the cookie is available to the API. Defaults to False.

same_site: Optional[bytes] (optional)

CORS directive. Defaults to None.

Returns

bytes: The set-cookie header

Summary

Make a set-cookie header

bareutils.cookies.make_cookie(
key: bytes,
value: bytes,
*,
expires: Optional[Union[datetime, timedelta]],
path: Optional[bytes],
domain: Optional[bytes],
secure: bool,
http_only: bool,
same_site: Optional[bytes]
) -> bytes

Parameters

key: bytes

The cookie name

value: bytes

The cookie value

expires: Optional[Union[datetime, timedelta]]

The expiry time of the cookie. Defaults to None.

path: Optional[bytes] (optional)

The cookie path. Defaults to None.

domain: Optional[bytes] (optional)

The cookie domain. Defaults to None.

secure: bool

Indicates if the cookie is restricted to https. Defaults to False.

http_only: bool

Indicates if the cookie is available to the API. Defaults to False.

same_site: Optional[bytes] (optional)

CORS directive. Defaults to None.

Returns

bytes: The set-cookie header

Summary

Make an expired cookie

bareutils.cookies.make_expired_cookie(
key: bytes,
path: bytes
) -> bytes

Parameters

key: bytes

The cookie name

path: bytes (optional)

The cookie path. Defaults to b'/'.

Returns

bytes: [description]