http.cookies — Управление состоянием 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')

Возвращает строковое представление, подходящее для отправки в качестве заголовков HTTP. attrs и header передаются каждому Morsel’s методу output(). sep используется для объединения заголовков, по умолчанию он представляет собой комбинацию '\r\n' (CRLF).

BaseCookie.js_output(attrs=None)

Возвращает фрагмент встраиваемого JavaScript, который, если он выполняется в браузере, поддерживающем JavaScript, будет действовать так же, как если бы были отправлены заголовки HTTP.

Значение параметра attrs такое же, как в output().

BaseCookie.load(rawdata)

Если rawdata является строкой, она разбирается как HTTP_COOKIE и найденные там значения добавляются как Morsels. Если это словарь, эквивалентно:

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

Объекты Morsel

class http.cookies.Morsel

Абстрагирует пару ключ/значение, имеющую некоторые атрибуты RFC 2109.

Объекты Morsel похожи на словари, но набор ключей является постоянным — это допустимые атрибуты RFC 2109, которые

• expires
• path
• comment
• domain
• max-age
• secure
• version
• httponly
• samesite

Атрибут httponly указывает, что куки передаются только в HTTP-запросах и недоступны через JavaScript. Это призвано смягчить некоторые формы межсайтовых сценариев.

Атрибут samesite указывает, что браузеру запрещено отправлять куки вместе с межсайтовыми запросами. Это помогает смягчить атаки CSRF. Допустимые значения для этого атрибута — “Strict” и “Lax”.

Ключи регистронезависимы, и их значение по умолчанию — ''.

Изменено в версии 3.5: __eq__() теперь учитывает key и value.

Изменено в версии 3.7: Атрибуты key, value и coded_value являются только для чтения. Используйте set() для их установки.

Изменено в версии 3.8: Добавлена поддержка атрибута samesite.

Morsel.value

Значение куки.

Morsel.coded_value

Закодированное значение куки — именно это значение должно быть отправлено.

Morsel.key

Имя куки.

Morsel.set(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().

Morsel.OutputString(attrs=None)

Возвращает строку, представляющую объект Morsel, без каких-либо окружающих HTTP или JavaScript.

Значение attrs такое же, как в output().

Morsel.update(values)

Обновить значения в словаре Morsel значениями в словаре значения. Вызовите ошибку, если любой из ключей в словаре значения не является допустимым атрибутом RFC 2109.

Изменено в версии 3.5: для недопустимых ключей возникает ошибка.

Morsel.copy(value)

Возвращает поверхностную копию объекта Morsel.

Изменено в версии 3.5: возвращает объект Morsel вместо словаря.

Morsel.setdefault(key, value=None)

Вызовите ошибку, если ключ не является допустимым атрибутом RFC 2109, в противном случае ведите себя так же, как dict.setdefault().

Пример

Следующий пример демонстрирует, как использовать модуль http.cookies.

>>> 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=\\012;";')
>>> print(C)
Set-Cookie: keebler="E=everybody; L=\"Loves\"; fudge=\012;"
>>> 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