# `http.cookies` — HTTP state management

Вихідний код: Lib/http/cookies.py

The `http.cookies` module defines classes for abstracting the concept of cookies, an HTTP state management mechanism. It supports both simple string-only cookies, and provides an abstraction for having any serializable data-type as cookie value.

The module formerly strictly applied the parsing rules described in the RFC 2109 and RFC 2068 specifications. It has since been discovered that MSIE 3.0x didn’t follow the character rules outlined in those specs; many current-day browsers and servers have also relaxed parsing rules when it comes to cookie handling. As a result, this module now uses parsing rules that are a bit less strict than they once were.

The character set, `string.ascii_letters`, `string.digits` and `!#$%&'*+-.^_`|~:` denote the set of valid characters allowed by this module in a cookie name (as `key`).

Змінено в версії 3.3: Allowed „:“ as a valid cookie name character.

Примітка

У разі виявлення недійсних файлів cookie виникає помилка `CookieError`, тому, якщо ваші дані файлів cookie надходять із браузера, ви повинні завжди бути готовими до недійсних даних і виявляти помилку `CookieError` під час синтаксичного аналізу.

exception http.cookies.CookieError

  Помилка виключення через недійсність RFC 2109: неправильні атрибути, неправильний заголовок Set-Cookie тощо.

class http.cookies.BaseCookie([input])

  Цей клас є словниковим об’єктом, ключі якого є рядками, а значення – екземплярами `Morsel`. Зауважте, що після встановлення ключа значення, значення спочатку перетворюється на `Morsel`, що містить ключ і значення.

  Якщо задано input, воно передається в метод `load()`.

class http.cookies.SimpleCookie([input])

  This class derives from `BaseCookie` and overrides `value_decode()` and `value_encode()`. `SimpleCookie` supports strings as cookie values. When setting the value, `SimpleCookie` calls the builtin `str()` to convert the value to a string. Values received from HTTP are kept as strings.

Дивись також

Модуль `http.cookiejar`

  HTTP cookie handling for web clients. The `http.cookiejar` and `http.cookies` modules do not depend on each other.

RFC 2109 - механізм керування станом HTTP

  Це специфікація управління станом, реалізована цим модулем.

## Об’єкти cookie

BaseCookie.value_decode(val)

  Повертає кортеж `(real_value, coded_value)` із представлення рядка. `real_value` може мати будь-який тип. Цей метод не виконує декодування в `BaseCookie` — він існує, тому його можна замінити.

BaseCookie.value_encode(val)

  Повертає кортеж `(real_value, coded_value)`. val може мати будь-який тип, але `coded_value` завжди буде перетворено на рядок. Цей метод не кодує в `BaseCookie` — він існує, тому його можна замінити.

  Загалом має бути так, що `value_encode()` і `value_decode()` є зворотними в діапазоні value_decode.

BaseCookie.output(attrs=None, header='Set-Cookie:', sep='\r\n')

  Return a string representation suitable to be sent as HTTP headers. attrs and header are sent to each `Morsel`’s `output()` method. sep is used to join the headers together, and is by default the combination `'\r\n'` (CRLF).

BaseCookie.js_output(attrs=None)

  Повертає вбудований фрагмент JavaScript, який, якщо його запустити у браузері, який підтримує JavaScript, діятиме так само, як якщо б було надіслано заголовки HTTP.

  Значення attrs таке ж, як і в `output()`.

  Deprecated since version 3.15, will be removed in version 3.19: This method generates a JavaScript snippet to set cookies in the browser, which is no longer considered a standard or recommended approach. Use `output()` instead to generate HTTP headers.

BaseCookie.load(rawdata)

  Якщо rawdata є рядком, проаналізуйте його як `HTTP_COOKIE` і додайте знайдені значення як `Morsel`s. Якщо це словник, він еквівалентний:

      for k, v in rawdata.items():
          cookie[k] = v

## Шматок об’єктів

class http.cookies.Morsel

  Абстрагуйте пару ключ/значення, яка має деякі атрибути RFC 2109.

  Morsels are dictionary-like objects, whose set of keys is constant — the valid RFC 2109 attributes, which are:

  > expires
  > path
  > comment
  > domain
  > max-age
  > secure
  > version
  > httponly
  > samesite
  > partitioned

  Атрибут `httponly` вказує, що файл cookie передається лише в HTTP-запитах і не доступний через JavaScript. Це призначено для пом’якшення деяких форм міжсайтових сценаріїв.

  The attribute `samesite` controls when the browser sends the cookie with cross-site requests. This helps to mitigate CSRF attacks. Valid values are «Strict» (only sent with same-site requests), «Lax» (sent with same-site requests and top-level navigations), and «None» (sent with same-site and cross-site requests). When using «None», the «secure» attribute must also be set, as required by modern browsers.

  The attribute `partitioned` indicates to user agents that these cross-site cookies should only be available in the same top-level context that the cookie was first set in. For this to be accepted by the user agent, you must also set `Secure`.

  In addition, it is recommended to use the `__Host` prefix when setting partitioned cookies to make them bound to the hostname and not the registrable domain. Read CHIPS (Cookies Having Independent Partitioned State) for full details and examples.

  Ключі нечутливі до регістру, а їхнє значення за замовчуванням – `''`.

  Змінено в версії 3.5: `__eq__()` now takes `key` and `value` into account.

  Змінено в версії 3.7: Атрибути `key`, `value` і `coded_value` доступні лише для читання. Використовуйте `set()` для їх налаштування.

  Змінено в версії 3.8: Додано підтримку атрибута `samesite`.

  Змінено в версії 3.14: Added support for the `partitioned` attribute.

Morsel.value

  Значення файлу cookie.

Morsel.coded_value

  Закодоване значення файлу cookie — це те, що потрібно надіслати.

Morsel.key

  Назва файлу cookie.

Morsel.set(key, value, coded_value)

  Установіть атрибути key, value і coded_value.

Morsel.isReservedKey(K)

  Чи є K членом набору ключів `Morsel`.

Morsel.output(attrs=None, header='Set-Cookie:')

  Повертає рядкове представлення Morsel, придатне для надсилання як заголовок HTTP. За замовчуванням включено всі атрибути, якщо не вказано attrs, у цьому випадку це має бути список атрибутів для використання. заголовок за замовчуванням `"Set-Cookie:"`.

Morsel.js_output(attrs=None)

  Повертає вбудований фрагмент JavaScript, який, якщо запустити в браузері, який підтримує JavaScript, діятиме так само, як якщо б було надіслано заголовок HTTP.

  Значення attrs таке ж, як і в `output()`.

  Deprecated since version 3.15, will be removed in version 3.19: This method generates a JavaScript snippet to set cookies in the browser, which is no longer considered a standard or recommended approach. Use `output()` instead to generate HTTP headers.

Morsel.OutputString(attrs=None)

  Повертає рядок, що представляє Morsel, без будь-якого оточуючого HTTP або JavaScript.

  Значення attrs таке ж, як і в `output()`.

Morsel.update(values)

  Оновіть значення в словнику Morsel значеннями в словнику values. Викликає помилку, якщо будь-який із ключів у values dict не є дійсним атрибутом RFC 2109.

  Змінено в версії 3.5: виникає помилка для недійсних ключів.

Morsel.copy(value)

  Поверніть дрібну копію об’єкта Morsel.

  Змінено в версії 3.5: повертає об’єкт Morsel замість dict.

Morsel.setdefault(key, value=None)

  Викликає помилку, якщо ключ не є дійсним атрибутом RFC 2109, інакше веде себе так само, як `dict.setdefault()`.

## приклад

The following example demonstrates how to use the `http.cookies` module.

    >>> from http import cookies
    >>> C = cookies.SimpleCookie()
    >>> C["fig"] = "newton"
    >>> C["sugar"] = "wafer"
    >>> print(C) # generate HTTP headers
    Set-Cookie: fig=newton
    Set-Cookie: sugar=wafer
    >>> print(C.output()) # same thing
    Set-Cookie: fig=newton
    Set-Cookie: sugar=wafer
    >>> C = cookies.SimpleCookie()
    >>> C["rocky"] = "road"
    >>> C["rocky"]["path"] = "/cookie"
    >>> print(C.output(header="Cookie:"))
    Cookie: rocky=road; Path=/cookie
    >>> print(C.output(attrs=[], header="Cookie:"))
    Cookie: rocky=road
    >>> C = cookies.SimpleCookie()
    >>> C.load("chips=ahoy; vienna=finger") # load from a string (HTTP header)
    >>> print(C)
    Set-Cookie: chips=ahoy
    Set-Cookie: vienna=finger
    >>> C = cookies.SimpleCookie()
    >>> C.load('keebler="E=everybody; L=\\"Loves\\"; fudge=;";')
    >>> print(C)
    Set-Cookie: keebler="E=everybody; L=\"Loves\"; fudge=;"
    >>> C = cookies.SimpleCookie()
    >>> C["oreo"] = "doublestuff"
    >>> C["oreo"]["path"] = "/"
    >>> print(C)
    Set-Cookie: oreo=doublestuff; Path=/
    >>> C = cookies.SimpleCookie()
    >>> C["twix"] = "none for you"
    >>> C["twix"].value
    'none for you'
    >>> C = cookies.SimpleCookie()
    >>> C["number"] = 7 # equivalent to C["number"] = str(7)
    >>> C["string"] = "seven"
    >>> C["number"].value
    '7'
    >>> C["string"].value
    'seven'
    >>> print(C)
    Set-Cookie: number=7
    Set-Cookie: string=seven