http.cookies — Управление состоянием HTTP

Исходный код: Lib/http/cookies.py

Модуль http.cookies определяет классы для абстрагирования понятия куки, механизма управления состоянием HTTP. Он поддерживает как простые куки только в виде строк, так и абстракцию для использования произвольных сериализуемых типов данных в качестве значений куки.

Ранее модуль строго применял правила разбора, описанные в спецификациях RFC 2109 и RFC 2068. Позднее было обнаружено, что MSIE 3.0x не следует правилам символов, изложенным в этих спецификациях, а также многие современные браузеры и серверы ослабили правила разбора при обработке куки. В результате используемые правила разбора немного менее строгие.

Символьный набор, string.ascii_letters, string.digits и !#$%&'*+-.^_`|~: обозначают набор допустимых символов, разрешенных этим модулем в имени куки (как key).

exception http.cookies.CookieError

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

class http.cookies.BaseCookie([input])

Этот класс — объект, подобный словарю, ключами которого являются строки, а значениями — экземпляры Morsel. Обратите внимание, что при присвоении значения ключу, это значение преобразуется в экземпляр Morsel, содержащий ключ и значение.

Если input задан, он передается в метод load().

class http.cookies.SimpleCookie([input])

Этот класс наследуется от BaseCookie и переопределяет value_decode() и value_encode(). SimpleCookie поддерживает строки в качестве значений куки. При установке значения SimpleCookie вызывает встроенную функцию str() для преобразования значения в строку. Значения, полученные из HTTP, сохраняются как строки.

Объекты куки

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

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

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

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

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

Morsel.value

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

Morsel.coded_value

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

Morsel.key

Имя куки.

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 задан, то должен быть передан список атрибутов для использования. header по умолчанию "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 значениями из словаря values. Возбуждает ошибку, если любой из ключей в словаре values не является допустимым атрибутом 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