Cookie

Cookie dataclass

Represents an HTTP cookie.

Parameters:
  • key (str) –

    The name of the cookie.

  • value (str, default: '' ) –

    The value of the cookie.

  • operation (Literal['set', 'delete'], default: 'set' ) –

    The operation to perform on the cookie, either "set" or "delete". Defaults to "set".

  • max_age (timedelta | int | None, default: None ) –

    The maximum age of the cookie in seconds. If None, the cookie will last only as long as the client’s browser session. Defaults to None.

  • expires (str | datetime | int | float | None, default: None ) –

    The expiration date of the cookie. Can be a datetime object, a UNIX timestamp, or None. Defaults to None.

  • path (str, default: '/' ) –

    The path for which the cookie is valid. If None, the cookie will be valid for the entire domain. Defaults to "/".

  • domain (str | None, default: None ) –

    The domain for which the cookie is valid. If None, the cookie will only be valid for the domain that set it. Defaults to None.

  • secure (bool, default: False ) –

    If True, the cookie will only be available via HTTPS. Defaults to False.

  • httponly (bool, default: False ) –

    If True, JavaScript will not be able to access the cookie. Defaults to False.

  • samesite (str | None, default: None ) –

    The SameSite attribute of the cookie, which can be "Strict", "Lax", or "None". Defaults to None.
Source code in src/alpha/utils/cookie.py 
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
@dataclass(frozen=True)
class Cookie:
    """Represents an HTTP cookie.

    Parameters
    ----------
    key
        The name of the cookie.
    value
        The value of the cookie.
    operation
        The operation to perform on the cookie, either "set" or "delete".
        Defaults to "set".
    max_age
        The maximum age of the cookie in seconds. If None, the cookie will last
        only as long as the client’s browser session. Defaults to None.
    expires
        The expiration date of the cookie. Can be a datetime object, a UNIX
        timestamp, or None. Defaults to None.
    path
        The path for which the cookie is valid. If None, the cookie will be
        valid for the entire domain. Defaults to "/".
    domain
        The domain for which the cookie is valid. If None, the cookie will only
        be valid for the domain that set it. Defaults to None.
    secure
        If True, the cookie will only be available via HTTPS. Defaults to
        False.
    httponly
        If True, JavaScript will not be able to access the cookie. Defaults to
        False.
    samesite
        The SameSite attribute of the cookie, which can be "Strict", "Lax", or
        "None". Defaults to None.
    """

    key: str
    value: str = ""
    operation: Literal["set", "delete"] = "set"
    max_age: timedelta | int | None = None
    expires: str | datetime | int | float | None = None
    path: str = "/"
    domain: str | None = None
    secure: bool = False
    httponly: bool = False
    samesite: str | None = None