`http.cookies.md`

214 строк · 14.8 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.6/library/http.cookies.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# 21.23. [`http.cookies`](https://python-all.ru/3.6/library/http.cookies.html#module-http.cookies) – управление состоянием HTTP89**Исходный код:** [Lib/http/cookies.py](https://python-all.ru/src/3.6/Lib/http/cookies.py)1011---1213Модуль [`http.cookies`](https://python-all.ru/3.6/library/http.cookies.html#module-http.cookies) определяет классы для абстрагирования концепции куки – механизма управления состоянием HTTP. Он поддерживает как простые куки, состоящие только из строк, так и абстракцию для использования любого сериализуемого типа данных в качестве значения куки.1415Раньше модуль строго применял правила разбора, описанные в спецификациях [**RFC 2109**](https://python-all.ru/3.6/library/http.cookies.html) и [**RFC 2068**](https://python-all.ru/3.6/library/http.cookies.html). Но с тех пор выяснилось, что MSIE 3.0x не соблюдает описанные в этих спецификациях правила набора символов, и к тому же многие современные браузеры и серверы при работе с Cookie придерживаются менее строгих правил разбора. В результате используемые правила разбора стали несколько менее строгими.1617Набор символов [`string.ascii_letters`](https://python-all.ru/3.6/library/string.html#string.ascii_letters), [`string.digits`](https://python-all.ru/3.6/library/string.html#string.digits) и `` !#$%&'*+-.^_`|~: `` обозначает множество допустимых символов, которые разрешены этим модулем в имени Cookie (как [`key`](https://python-all.ru/3.6/library/http.cookies.html#http.cookies.Morsel.key)).1819Изменено в версии 3.3: Разрешён символ ‘:’ в качестве допустимого символа имени Cookie.2021> **Примечание**22>23> При обнаружении недопустимой куки возбуждается исключение [`CookieError`](https://python-all.ru/3.6/library/http.cookies.html#http.cookies.CookieError), поэтому, если данные куки поступают из браузера, всегда следует быть готовым к недопустимым данным и перехватывать [`CookieError`](https://python-all.ru/3.6/library/http.cookies.html#http.cookies.CookieError) при разборе.2425#### `exception http.cookies.CookieError`2627Исключение, возникающее из-за недействительности [**RFC 2109**](https://python-all.ru/3.6/library/http.cookies.html): неверные атрибуты, неверный заголовок *Set-Cookie* и т.д.2829#### `class http.cookies.BaseCookie([input])`3031Этот класс является объектом, подобным словарю, ключи которого – строки, а значения – экземпляры [`Morsel`](https://python-all.ru/3.6/library/http.cookies.html#http.cookies.Morsel). Обратите внимание, что при установке ключа в значение, это значение сначала преобразуется в объект [`Morsel`](https://python-all.ru/3.6/library/http.cookies.html#http.cookies.Morsel), содержащий ключ и значение.3233Если передан параметр *input*, он передаётся методу [`load()`](https://python-all.ru/3.6/library/http.cookies.html#http.cookies.BaseCookie.load).3435#### `class http.cookies.SimpleCookie([input])`3637Этот класс наследуется от [`BaseCookie`](https://python-all.ru/3.6/library/http.cookies.html#http.cookies.BaseCookie) и переопределяет `value_decode()` и `value_encode()`, превращая их в identity и [`str()`](https://python-all.ru/3.6/library/stdtypes.html#str) соответственно.3839> **См. также**40>41> **Модуль [`http.cookiejar`](https://python-all.ru/3.6/library/http.cookiejar.html#module-http.cookiejar)**42>43> Обработка HTTP-куки для веб-*клиентов*. Модули [`http.cookiejar`](https://python-all.ru/3.6/library/http.cookiejar.html#module-http.cookiejar) и [`http.cookies`](https://python-all.ru/3.6/library/http.cookies.html#module-http.cookies) не зависят друг от друга.44>45> **[**RFC 2109**](https://python-all.ru/3.6/library/http.cookies.html) – Механизм управления состоянием HTTP**46>47> Это спецификация управления состоянием, реализованная этим модулем.4849## 21.23.1. Объекты Cookie5051#### `BaseCookie.value_decode(val)`5253Возвращает декодированное значение из строкового представления. Возвращаемое значение может быть любого tипа. Этот метод ничего не делает в [`BaseCookie`](https://python-all.ru/3.6/library/http.cookies.html#http.cookies.BaseCookie) – он существует, чтобы его можно было переопределить.5455#### `BaseCookie.value_encode(val)`5657Возвращает закодированное значение. *val* может быть любого типа, но возвращаемое значение должно быть строкой. Этот метод ничего не делает в [`BaseCookie`](https://python-all.ru/3.6/library/http.cookies.html#http.cookies.BaseCookie) – он существует, чтобы его можно было переопределить.5859В общем случае должно выполняться условие, что [`value_encode()`](https://python-all.ru/3.6/library/http.cookies.html#http.cookies.BaseCookie.value_encode) и [`value_decode()`](https://python-all.ru/3.6/library/http.cookies.html#http.cookies.BaseCookie.value_decode) являются взаимно обратными на области значений *value\_decode*.6061#### `BaseCookie.output(attrs=None, header='Set-Cookie:', sep='\r\n')`6263Возвращает строковое представление, пригодное для отправки в качестве HTTP-заголовков. *attrs* и *header* передаются каждому методу [`output()`](https://python-all.ru/3.6/library/http.cookies.html#http.cookies.BaseCookie.output) объекта [`Morsel`](https://python-all.ru/3.6/library/http.cookies.html#http.cookies.Morsel). *sep* используется для объединения заголовков, и по умолчанию имеет значение `'\r\n'` (CRLF).6465#### `BaseCookie.js_output(attrs=None)`6667Возвращает встраиваемый фрагмент JavaScript, который при выполнении в браузере, поддерживающем JavaScript, будет действовать так же, как если бы были отправлены HTTP-заголовки.6869Значение *attrs* такое же, как в [`output()`](https://python-all.ru/3.6/library/http.cookies.html#http.cookies.BaseCookie.output).7071#### `BaseCookie.load(rawdata)`7273Если *rawdata* является строкой, разобрать её как `HTTP_COOKIE` и добавить найденные значения как объекты [`Morsel`](https://python-all.ru/3.6/library/http.cookies.html#http.cookies.Morsel). Если это словарь, это эквивалентно:7475```python76for k, v in rawdata.items():77    cookie[k] = v78```7980## 21.23.2. Объекты Morsel8182#### `class http.cookies.Morsel`8384Абстрагирует пару ключ/значение с атрибутами [**RFC 2109**](https://python-all.ru/3.6/library/http.cookies.html).8586Объекты Morsel похожи на словари, и их набор ключей постоянен: это допустимые атрибуты [**RFC 2109**](https://python-all.ru/3.6/library/http.cookies.html), которые8788- `expires`89- `path`90- `comment`91- `domain`92- `max-age`93- `secure`94- `version`95- `httponly`9697Атрибут `httponly` указывает, что cookie передаётся только в HTTP-запросах и недоступен через JavaScript. Это предназначено для снижения риска некоторых форм межсайтового скриптинга.9899Ключи нечувствительны к регистру, и их значение по умолчанию – `''`.100101Изменено в версии 3.5: `__eq__()` теперь учитывает [`key`](https://python-all.ru/3.6/library/http.cookies.html#http.cookies.Morsel.key) и [`value`](https://python-all.ru/3.6/library/http.cookies.html#http.cookies.Morsel.value).102103#### `Morsel.value`104105Значение cookie.106107Устарело с версии 3.5: присваивание `value`; используйте [`set()`](https://python-all.ru/3.6/library/http.cookies.html#http.cookies.Morsel.set).108109#### `Morsel.coded_value`110111Закодированное значение cookie – именно его следует отправлять.112113Устарело с версии 3.5: присваивание `coded_value`; используйте [`set()`](https://python-all.ru/3.6/library/http.cookies.html#http.cookies.Morsel.set).114115#### `Morsel.key`116117Имя cookie.118119Устарело с версии 3.5: присваивание `key`; используйте [`set()`](https://python-all.ru/3.6/library/http.cookies.html#http.cookies.Morsel.set).120121#### `Morsel.set(key, value, coded_value)`122123Устанавливает атрибуты *key*, *value* и *coded\_value*.124125Устарело с версии 3.5: недокументированный параметр *LegalChars* игнорируется и будет удалён в будущей версии.126127#### `Morsel.isReservedKey(K)`128129Проверяет, входит ли *K* в набор ключей [`Morsel`](https://python-all.ru/3.6/library/http.cookies.html#http.cookies.Morsel).130131#### `Morsel.output(attrs=None, header='Set-Cookie:')`132133Возвращает строковое представление Morsel, пригодное для отправки в качестве HTTP-заголовка. По умолчанию включаются все атрибуты, если не указан *attrs* – в этом случае это должен быть список используемых атрибутов. *header* по умолчанию равен `"Set-Cookie:"`.134135#### `Morsel.js_output(attrs=None)`136137Возвращает встраиваемый фрагмент JavaScript, который при выполнении в браузере, поддерживающем JavaScript, будет действовать так же, как если бы был отправлен HTTP-заголовок.138139Значение *attrs* такое же, как в [`output()`](https://python-all.ru/3.6/library/http.cookies.html#http.cookies.Morsel.output).140141#### `Morsel.OutputString(attrs=None)`142143Возвращает строку, представляющую Morsel, без какого-либо окружающего HTTP или JavaScript.144145Значение *attrs* такое же, как в [`output()`](https://python-all.ru/3.6/library/http.cookies.html#http.cookies.Morsel.output).146147#### `Morsel.update(values)`148149Обновляет значения в словаре Morsel значениями из словаря *values*. Вызывает ошибку, если какой-либо из ключей в словаре *values* не является допустимым атрибутом [**RFC 2109**](https://python-all.ru/3.6/library/http.cookies.html).150151Изменено в версии 3.5: возникает ошибка для недопустимых ключей.152153#### `Morsel.copy(value)`154155Возвращает поверхностную копию объекта Morsel.156157Изменено в версии 3.5: возвращает объект Morsel вместо словаря.158159#### `Morsel.setdefault(key, value=None)`160161Вызывает ошибку, если ключ не является допустимым атрибутом [**RFC 2109**](https://python-all.ru/3.6/library/http.cookies.html), в противном случае ведёт себя так же, как [`dict.setdefault()`](https://python-all.ru/3.6/library/stdtypes.html#dict.setdefault).162163## 21.23.3. Пример164165Следующий пример демонстрирует, как использовать модуль [`http.cookies`](https://python-all.ru/3.6/library/http.cookies.html#module-http.cookies).166167```pycon168>>> from http import cookies169>>> C = cookies.SimpleCookie()170>>> C["fig"] = "newton"171>>> C["sugar"] = "wafer"172>>> print(C) # сгенерировать HTTP-заголовки173Set-Cookie: fig=newton174Set-Cookie: sugar=wafer175>>> print(C.output()) # то же самое176Set-Cookie: fig=newton177Set-Cookie: sugar=wafer178>>> C = cookies.SimpleCookie()179>>> C["rocky"] = "road"180>>> C["rocky"]["path"] = "/cookie"181>>> print(C.output(header="Cookie:"))182Cookie: rocky=road; Path=/cookie183>>> print(C.output(attrs=[], header="Cookie:"))184Cookie: rocky=road185>>> C = cookies.SimpleCookie()186>>> C.load("chips=ahoy; vienna=finger") # загрузить из строки (HTTP-заголовок)187>>> print(C)188Set-Cookie: chips=ahoy189Set-Cookie: vienna=finger190>>> C = cookies.SimpleCookie()191>>> C.load('keebler="E=everybody; L=\\"Loves\\"; fudge=\\012;";')192>>> print(C)193Set-Cookie: keebler="E=everybody; L=\"Loves\"; fudge=\012;"194>>> C = cookies.SimpleCookie()195>>> C["oreo"] = "doublestuff"196>>> C["oreo"]["path"] = "/"197>>> print(C)198Set-Cookie: oreo=doublestuff; Path=/199>>> C = cookies.SimpleCookie()200>>> C["twix"] = "none for you"201>>> C["twix"].value202'none for you'203>>> C = cookies.SimpleCookie()204>>> C["number"] = 7 # эквивалентно C["number"] = str(7)205>>> C["string"] = "seven"206>>> C["number"].value207'7'208>>> C["string"].value209'seven'210>>> print(C)211Set-Cookie: number=7212Set-Cookie: string=seven213```214