`http.cookies.md`

200 строк · 12.7 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.3/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.3/library/http.cookies.html#module-http.cookies) – управление состоянием HTTP89**Исходный код:** [Lib/http/cookies.py](https://python-all.ru/src/3.3/Lib/http/cookies.py)1011---1213Модуль [`http.cookies`](https://python-all.ru/3.3/library/http.cookies.html#module-http.cookies) определяет классы для абстракции понятия cookie – механизма управления состоянием HTTP. Он поддерживает как простые строковые cookie, так и предоставляет абстракцию для использования любого сериализуемого типа данных в качестве значения cookie.1415Раньше модуль строго применял правила разбора, описанные в спецификациях [**RFC 2109**](https://python-all.ru/3.3/library/http.cookies.html) и [**RFC 2068**](https://python-all.ru/3.3/library/http.cookies.html). Но с тех пор выяснилось, что MSIE 3.0x не соблюдает описанные в этих спецификациях правила набора символов, и к тому же многие современные браузеры и серверы при работе с Cookie придерживаются менее строгих правил разбора. В результате используемые правила разбора стали несколько менее строгими.1617Набор символов [`string.ascii_letters`](https://python-all.ru/3.3/library/string.html#string.ascii_letters), [`string.digits`](https://python-all.ru/3.3/library/string.html#string.digits) и `` !#$%&'*+-.^_`|~: `` обозначают множество допустимых символов, разрешенных этим модулем в имени Cookie (как [`key`](https://python-all.ru/3.3/library/http.cookies.html#http.cookies.Morsel.key)).1819Изменено в версии 3.3: Разрешён символ ‘:’ в качестве допустимого символа имени Cookie.2021> **Примечание**22>23> При обнаружении недопустимого cookie возникает [`CookieError`](https://python-all.ru/3.3/library/http.cookies.html#http.cookies.CookieError), поэтому, если данные cookie поступают из браузера, всегда следует готовиться к недопустимым данным и перехватывать [`CookieError`](https://python-all.ru/3.3/library/http.cookies.html#http.cookies.CookieError) при разборе.2425#### `exception http.cookies.CookieError`2627Исключение, возникающее из-за недействительности [**RFC 2109**](https://python-all.ru/3.3/library/http.cookies.html): неверные атрибуты, неверный заголовок *Set-Cookie* и т.д.2829#### `class http.cookies.BaseCookie([input])`3031Этот класс представляет собой объект, подобный словарю, ключи которого – строки, а значения – экземпляры [`Morsel`](https://python-all.ru/3.3/library/http.cookies.html#http.cookies.Morsel). Обратите внимание, что при установке ключа в значение, это значение сначала преобразуется в [`Morsel`](https://python-all.ru/3.3/library/http.cookies.html#http.cookies.Morsel), содержащий ключ и значение.3233Если указан параметр *input*, он передаётся методу [`load()`](https://python-all.ru/3.3/library/http.cookies.html#http.cookies.BaseCookie.load).3435#### `class http.cookies.SimpleCookie([input])`3637Этот класс наследует от [`BaseCookie`](https://python-all.ru/3.3/library/http.cookies.html#http.cookies.BaseCookie) и переопределяет `value_decode()` и `value_encode()` как тождественную функцию и [`str()`](https://python-all.ru/3.3/library/stdtypes.html#str) соответственно.3839> **См. также**40>41> **Модуль [`http.cookiejar`](https://python-all.ru/3.3/library/http.cookiejar.html#module-http.cookiejar)**42>43> Обработка HTTP cookie для веб-44>45> *клиентов*46>47> . Модули48>49> [`http.cookiejar`](https://python-all.ru/3.3/library/http.cookiejar.html#module-http.cookiejar)50>51> и52>53> [`http.cookies`](https://python-all.ru/3.3/library/http.cookies.html#module-http.cookies)54>55> не зависят друг от друга.56>57> **[**RFC 2109**](https://python-all.ru/3.3/library/http.cookies.html) – Механизм управления состоянием HTTP**58>59> Это спецификация управления состоянием, реализованная этим модулем.6061## 21.23.1. Объекты Cookie6263#### `BaseCookie.value_decode(val)`6465Возвращает декодированное значение из строкового представления. Возвращаемое значение может быть любого типа. Этот метод ничего не делает в [`BaseCookie`](https://python-all.ru/3.3/library/http.cookies.html#http.cookies.BaseCookie) – он существует для того, чтобы его можно было переопределить.6667#### `BaseCookie.value_encode(val)`6869Возвращает закодированное значение. *val* может быть любого типа, но возвращаемое значение должно быть строкой. Этот метод ничего не делает в [`BaseCookie`](https://python-all.ru/3.3/library/http.cookies.html#http.cookies.BaseCookie) – он существует, чтобы его можно было переопределить7071В общем случае предполагается, что [`value_encode()`](https://python-all.ru/3.3/library/http.cookies.html#http.cookies.BaseCookie.value_encode) и [`value_decode()`](https://python-all.ru/3.3/library/http.cookies.html#http.cookies.BaseCookie.value_decode) являются обратными функциями на области значений *value\_decode*.7273#### `BaseCookie.output(attrs=None, header='Set-Cookie:', sep='\r\n')`7475Возвращает строковое представление, пригодное для отправки в качестве HTTP-заголовков. *attrs* и *header* передаются методу [`output()`](https://python-all.ru/3.3/library/http.cookies.html#http.cookies.BaseCookie.output) каждого объекта [`Morsel`](https://python-all.ru/3.3/library/http.cookies.html#http.cookies.Morsel). *sep* используется для объединения заголовков; по умолчанию это комбинация `'\r\n'` (CRLF).7677#### `BaseCookie.js_output(attrs=None)`7879Возвращает встраиваемый фрагмент JavaScript, который при выполнении в браузере, поддерживающем JavaScript, будет действовать так же, как если бы были отправлены HTTP-заголовки.8081Значение *attrs* такое же, как в [`output()`](https://python-all.ru/3.3/library/http.cookies.html#http.cookies.BaseCookie.output).8283#### `BaseCookie.load(rawdata)`8485Если *rawdata* является строкой, она разбирается как `HTTP_COOKIE`, а найденные значения добавляются как объекты [`Morsel`](https://python-all.ru/3.3/library/http.cookies.html#http.cookies.Morsel). Если это словарь, то эквивалентно следующему:8687```python88for k, v in rawdata.items():89    cookie[k] = v90```9192## 21.23.2. Объекты Morsel9394#### `class http.cookies.Morsel`9596Абстрагирует пару ключ/значение с атрибутами [**RFC 2109**](https://python-all.ru/3.3/library/http.cookies.html).9798Объекты Morsel похожи на словари, и их набор ключей постоянен: это допустимые атрибуты [**RFC 2109**](https://python-all.ru/3.3/library/http.cookies.html), которые99100- `expires`101- `path`102- `comment`103- `domain`104- `max-age`105- `secure`106- `version`107- `httponly`108109Атрибут `httponly` указывает, что cookie передаётся только в HTTP-запросах и недоступна через JavaScript. Это предназначено для смягчения некоторых форм межсайтового скриптинга.110111Ключи нечувствительны к регистру.112113#### `Morsel.value`114115Значение cookie.116117#### `Morsel.coded_value`118119Закодированное значение cookie – именно его следует отправлять.120121#### `Morsel.key`122123Имя cookie.124125#### `Morsel.set(key, value, coded_value)`126127Устанавливает атрибуты *key*, *value* и *coded\_value*.128129#### `Morsel.isReservedKey(K)`130131Определяет, является ли *K* одним из ключей объекта [`Morsel`](https://python-all.ru/3.3/library/http.cookies.html#http.cookies.Morsel).132133#### `Morsel.output(attrs=None, header='Set-Cookie:')`134135Возвращает строковое представление объекта Morsel, подходящее для отправки в качестве HTTP-заголовка. По умолчанию включаются все атрибуты, если не указан *attrs*; в этом случае он должен быть списком используемых атрибутов. *header* по умолчанию равен `"Set-Cookie:"`.136137#### `Morsel.js_output(attrs=None)`138139Возвращает встраиваемый фрагмент JavaScript, который при выполнении в браузере, поддерживающем JavaScript, будет действовать так же, как если бы был отправлен HTTP-заголовок.140141Значение *attrs* такое же, как в [`output()`](https://python-all.ru/3.3/library/http.cookies.html#http.cookies.Morsel.output).142143#### `Morsel.OutputString(attrs=None)`144145Возвращает строку, представляющую Morsel, без какого-либо окружающего HTTP или JavaScript.146147Значение *attrs* такое же, как в [`output()`](https://python-all.ru/3.3/library/http.cookies.html#http.cookies.Morsel.output).148149## 21.23.3. Пример150151Следующий пример демонстрирует, как использовать модуль [`http.cookies`](https://python-all.ru/3.3/library/http.cookies.html#module-http.cookies).152153```python154>>> from http import cookies155>>> C = cookies.SimpleCookie()156>>> C["fig"] = "newton"157>>> C["sugar"] = "wafer"158>>> print(C) # сгенерировать HTTP-заголовки159Set-Cookie: fig=newton160Set-Cookie: sugar=wafer161>>> print(C.output()) # то же самое162Set-Cookie: fig=newton163Set-Cookie: sugar=wafer164>>> C = cookies.SimpleCookie()165>>> C["rocky"] = "road"166>>> C["rocky"]["path"] = "/cookie"167>>> print(C.output(header="Cookie:"))168Cookie: rocky=road; Path=/cookie169>>> print(C.output(attrs=[], header="Cookie:"))170Cookie: rocky=road171>>> C = cookies.SimpleCookie()172>>> C.load("chips=ahoy; vienna=finger") # загрузить из строки (HTTP-заголовок)173>>> print(C)174Set-Cookie: chips=ahoy175Set-Cookie: vienna=finger176>>> C = cookies.SimpleCookie()177>>> C.load('keebler="E=everybody; L=\\"Loves\\"; fudge=\\012;";')178>>> print(C)179Set-Cookie: keebler="E=everybody; L=\"Loves\"; fudge=\012;"180>>> C = cookies.SimpleCookie()181>>> C["oreo"] = "doublestuff"182>>> C["oreo"]["path"] = "/"183>>> print(C)184Set-Cookie: oreo=doublestuff; Path=/185>>> C = cookies.SimpleCookie()186>>> C["twix"] = "none for you"187>>> C["twix"].value188'none for you'189>>> C = cookies.SimpleCookie()190>>> C["number"] = 7 # эквивалентно C["number"] = str(7)191>>> C["string"] = "seven"192>>> C["number"].value193'7'194>>> C["string"].value195'seven'196>>> print(C)197Set-Cookie: number=7198Set-Cookie: string=seven199```200