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 передаются методу output() каждого объекта Morsel. Параметр sep используется для объединения заголовков; по умолчанию это комбинация '\r\n' (CRLF).

BaseCookie.js_output(attrs=None)

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

Параметр attrs имеет тот же смысл, что и в output().

BaseCookie.load(rawdata)

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

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

partitioned

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

Атрибут samesite определяет, когда браузер отправляет cookie вместе с межсайтовыми запросами. Это помогает снизить риск атак CSRF. Допустимые значения: «Strict» (отправляется только с запросами с того же сайта), «Lax» (отправляется с запросами с того же сайта и при переходах верхнего уровня) и «None» (отправляется с запросами как с того же, так и с других сайтов). При использовании значения «None» необходимо также установить атрибут «secure», как того требуют современные браузеры.

Атрибут partitioned сообщает пользовательским агентам, что эти межсайтовые файлы cookie должны быть доступны только в том же контексте верхнего уровня, в котором cookie был впервые установлен. Чтобы пользовательский агент принял этот атрибут, необходимо также установить Secure.

Кроме того, при установке разделенных файлов cookie рекомендуется использовать префикс __Host, чтобы привязать их к имени хоста, а не к регистрируемому домену. Полное описание и примеры приведены в CHIPS (файлы cookie с независимым разделенным состоянием).

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

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

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

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

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

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; в этом случае он должен представлять собой список используемых атрибутов. Значение 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, а не dict.

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=;";')
>>> 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