`http.cookiejar.md`

491 строк · 50.3 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.8/library/http.cookiejar.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# [`http.cookiejar`](https://python-all.ru/3.8/library/http.cookiejar.html#module-http.cookiejar) – Обработка cookie для HTTP-клиентов89**Исходный код:** [Lib/http/cookiejar.py](https://python-all.ru/src/3.8/Lib/http/cookiejar.py)1011---1213Модуль [`http.cookiejar`](https://python-all.ru/3.8/library/http.cookiejar.html#module-http.cookiejar) определяет классы для автоматической обработки HTTP куки. Он полезен для доступа к веб-сайтам, которые требуют, чтобы небольшие фрагменты данных – *куки* – устанавливались на клиентской машине HTTP-ответом от веб-сервера, а затем возвращались серверу в последующих HTTP-запросах.1415Обрабатываются как обычный протокол cookie Netscape, так и протокол, определённый в [**RFC 2965**](https://python-all.ru/3.8/library/http.cookiejar.html). Обработка RFC 2965 по умолчанию отключена. Cookie [**RFC 2109**](https://python-all.ru/3.8/library/http.cookiejar.html) разбираются как cookie Netscape и впоследствии обрабатываются либо как cookie Netscape, либо как cookie RFC 2965 в зависимости от действующей «политики». Обратите внимание, что подавляющее большинство cookie в интернете – это cookie Netscape. [`http.cookiejar`](https://python-all.ru/3.8/library/http.cookiejar.html#module-http.cookiejar) пытается следовать фактическому протоколу cookie Netscape (который существенно отличается от того, что изложено в оригинальной спецификации Netscape), в том числе учитывая атрибуты cookie `max-age` и `port`, введённые в RFC 2965.1617> **Примечание**18>19> Различные именованные параметры в заголовках *Set-Cookie* и *Set-Cookie2* (например, `domain` и `expires`) обычно называют *атрибутами*. Чтобы отличать их от атрибутов Python, в документации этого модуля используется термин *cookie-атрибут*.2021Модуль определяет следующее исключение:2223#### `exception http.cookiejar.LoadError`2425Экземпляры [`FileCookieJar`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.FileCookieJar) вызывают это исключение при неудачной загрузке куки из файла. [`LoadError`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.LoadError) является подклассом [`OSError`](https://python-all.ru/3.8/library/exceptions.html#OSError).2627Изменено в версии 3.3: LoadError стал подклассом [`OSError`](https://python-all.ru/3.8/library/exceptions.html#OSError) вместо [`IOError`](https://python-all.ru/3.8/library/exceptions.html#IOError).2829Предоставляются следующие классы:3031#### `class http.cookiejar.CookieJar(policy=None)`3233*policy* – это объект, реализующий интерфейс [`CookiePolicy`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.CookiePolicy).3435Класс [`CookieJar`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.CookieJar) хранит HTTP-куки. Он извлекает куки из HTTP-запросов и возвращает их в HTTP-ответах. Экземпляры [`CookieJar`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.CookieJar) автоматически удаляют устаревшие куки при необходимости. Подклассы также отвечают за сохранение и загрузку куки из файла или базы данных.3637#### `class http.cookiejar.FileCookieJar(filename, delayload=None, policy=None)`3839*policy* – это объект, реализующий интерфейс [`CookiePolicy`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.CookiePolicy). Остальные аргументы описаны в документации соответствующих атрибутов.4041[`CookieJar`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.CookieJar), который может загружать куки из файла на диске и, возможно, сохранять их туда. Куки **НЕ** загружаются из указанного файла до тех пор, пока не будет вызван метод [`load()`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.FileCookieJar.load) или [`revert()`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.FileCookieJar.revert). Подклассы этого класса описаны в разделе [Подклассы FileCookieJar и взаимодействие с веб-браузерами](https://python-all.ru/3.8/library/http.cookiejar.html#file-cookie-jar-classes).4243Изменено в версии 3.8: Параметр filename поддерживает [объект, подобный пути](https://python-all.ru/3.8/glossary.html#term-path-like-object).4445#### `class http.cookiejar.CookiePolicy`4647Этот класс отвечает за принятие решения о том, следует ли принять каждый куки от сервера / вернуть его серверу.4849#### `class http.cookiejar.DefaultCookiePolicy(blocked_domains=None, allowed_domains=None, netscape=True, rfc2965=False, rfc2109_as_netscape=None, hide_cookie2=False, strict_domain=False, strict_rfc2965_unverifiable=True, strict_ns_unverifiable=False, strict_ns_domain=DefaultCookiePolicy.DomainLiberal, strict_ns_set_initial_dollar=False, strict_ns_set_path=False, secure_protocols=("https", "wss"))`5051Аргументы конструктора должны передаваться только как именованные аргументы. *blocked\_domains* – это последовательность доменных имён, с которых мы никогда не принимаем куки и которым никогда не возвращаем куки. *allowed\_domains*, если не равно [`None`](https://python-all.ru/3.8/library/constants.html#None), – это последовательность единственных доменов, для которых мы принимаем и возвращаем куки. *secure\_protocols* – это последовательность протоколов, для которых могут быть добавлены защищённые куки. По умолчанию *https* и *wss* (защищённый вебсокет) считаются защищёнными протоколами. Остальные аргументы описаны в документации объектов [`CookiePolicy`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.CookiePolicy) и [`DefaultCookiePolicy`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.DefaultCookiePolicy).5253[`DefaultCookiePolicy`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.DefaultCookiePolicy) реализует стандартные правила принятия/отклонения для cookie Netscape и [**RFC 2965**](https://python-all.ru/3.8/library/http.cookiejar.html). По умолчанию cookie [**RFC 2109**](https://python-all.ru/3.8/library/http.cookiejar.html) (т.е. cookie, полученные в заголовке *Set-Cookie* с версией cookie-атрибута 1) обрабатываются по правилам RFC 2965. Однако, если обработка RFC 2965 отключена или [`rfc2109_as_netscape`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.DefaultCookiePolicy.rfc2109_as_netscape) равно `True`, cookie RFC 2109 «понижаются» экземпляром [`CookieJar`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.CookieJar) до cookie Netscape путем установки атрибута `version` экземпляра [`Cookie`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.Cookie) в 0. [`DefaultCookiePolicy`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.DefaultCookiePolicy) также предоставляет некоторые параметры для точной настройки политики.5455#### `class http.cookiejar.Cookie`5657Этот класс представляет куки Netscape, [**RFC 2109**](https://python-all.ru/3.8/library/http.cookiejar.html) и [**RFC 2965**](https://python-all.ru/3.8/library/http.cookiejar.html). Не предполагается, что пользователи [`http.cookiejar`](https://python-all.ru/3.8/library/http.cookiejar.html#module-http.cookiejar) будут создавать собственные экземпляры [`Cookie`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.Cookie). Вместо этого при необходимости следует вызвать `make_cookies()` на экземпляре [`CookieJar`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.CookieJar).5859> **См. также**60>61> **Модуль [`urllib.request`](https://python-all.ru/3.8/library/urllib.request.html#module-urllib.request)**62>63> Открытие URL с автоматической обработкой куки.64>65> **Модуль [`http.cookies`](https://python-all.ru/3.8/library/http.cookies.html#module-http.cookies)**66>67> Классы HTTP-куки, в основном полезные для серверного кода. Модули [`http.cookiejar`](https://python-all.ru/3.8/library/http.cookiejar.html#module-http.cookiejar) и [`http.cookies`](https://python-all.ru/3.8/library/http.cookies.html#module-http.cookies) не зависят друг от друга.68>69> **[https://curl.haxx.se/rfc/cookie\_spec.html](https://python-all.ru/3.8/library/http.cookiejar.html)**70>71> Спецификация оригинального протокола Netscape cookie. Хотя это всё ещё доминирующий протокол, «протокол Netscape cookie», реализованный всеми основными браузерами (и [`http.cookiejar`](https://python-all.ru/3.8/library/http.cookiejar.html#module-http.cookiejar)), лишь отдалённо напоминает тот, что описан в `cookie_spec.html`.72>73> **[**RFC 2109**](https://python-all.ru/3.8/library/http.cookiejar.html) – Механизм управления состоянием HTTP**74>75> Заменён [**RFC 2965**](https://python-all.ru/3.8/library/http.cookiejar.html). Использует *Set-Cookie* с version=1.76>77> **[**RFC 2965**](https://python-all.ru/3.8/library/http.cookiejar.html) – Механизм управления состоянием HTTP**78>79> Протокол Netscape с исправленными ошибками. Использует *Set-Cookie2* вместо *Set-Cookie*. Широко не используется.80>81> **[http://kristol.org/cookie/errata.html](https://python-all.ru/3.8/library/http.cookiejar.html)**82>83> Незавершённая errata к [**RFC 2965**](https://python-all.ru/3.8/library/http.cookiejar.html).84>85> [**RFC 2964**](https://python-all.ru/3.8/library/http.cookiejar.html) – Использование управления состоянием HTTP8687## Объекты CookieJar и FileCookieJar8889Объекты [`CookieJar`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.CookieJar) поддерживают протокол [итератора](https://python-all.ru/3.8/glossary.html#term-iterator) для итерации по содержащимся объектам [`Cookie`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.Cookie).9091[`CookieJar`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.CookieJar) имеет следующие методы:9293#### `CookieJar.add_cookie_header(request)`9495Добавляет правильный заголовок *Cookie* к *запросу*.9697Если политика разрешает (т.е. атрибуты `rfc2965` и `hide_cookie2` экземпляра [`CookieJar`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.CookieJar)'s [`CookiePolicy`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.CookiePolicy) равны, соответственно, true и false), заголовок *Cookie2* также добавляется, когда это уместно.9899Объект *request* (обычно экземпляр [`urllib.request.Request`](https://python-all.ru/3.8/library/urllib.request.html#urllib.request.Request)) должен поддерживать методы `get_full_url()`, `get_host()`, `get_type()`, `unverifiable()`, `has_header()`, `get_header()`, `header_items()`, `add_unredirected_header()` и атрибут `origin_req_host`, как описано в [`urllib.request`](https://python-all.ru/3.8/library/urllib.request.html#module-urllib.request).100101Изменено в версии 3.3: объекту *request* требуется атрибут `origin_req_host`. Зависимость от устаревшего метода `get_origin_req_host()` удалена.102103#### `CookieJar.extract_cookies(response, request)`104105Извлекает куки из HTTP-*ответа* и сохраняет их в [`CookieJar`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.CookieJar), где это разрешено политикой.106107[`CookieJar`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.CookieJar) будет искать допустимые заголовки *Set-Cookie* и *Set-Cookie2* в аргументе *ответа*, и сохранять cookie соответствующим образом (с учётом одобрения метода [`CookiePolicy.set_ok()`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.CookiePolicy.set_ok)).108109Объект *response* (обычно результат вызова [`urllib.request.urlopen()`](https://python-all.ru/3.8/library/urllib.request.html#urllib.request.urlopen) или аналогичного) должен поддерживать метод `info()`, который возвращает экземпляр [`email.message.Message`](https://python-all.ru/3.8/library/email.compat32-message.html#email.message.Message).110111Объект *request* (обычно экземпляр [`urllib.request.Request`](https://python-all.ru/3.8/library/urllib.request.html#urllib.request.Request)) должен поддерживать методы `get_full_url()`, `get_host()`, `unverifiable()` и атрибут `origin_req_host`, как описано в [`urllib.request`](https://python-all.ru/3.8/library/urllib.request.html#module-urllib.request). Request используется для установки значений по умолчанию для атрибутов cookie, а также для проверки, разрешена ли установка cookie.112113Изменено в версии 3.3: объекту *request* требуется атрибут `origin_req_host`. Зависимость от устаревшего метода `get_origin_req_host()` удалена.114115#### `CookieJar.set_policy(policy)`116117Устанавливает используемый экземпляр [`CookiePolicy`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.CookiePolicy).118119#### `CookieJar.make_cookies(response, request)`120121Возвращает последовательность объектов [`Cookie`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.Cookie), извлечённых из объекта *ответа*.122123Смотрите документацию к [`extract_cookies()`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.CookieJar.extract_cookies) для описания интерфейсов, требуемых от аргументов *ответа* и *запроса*.124125#### `CookieJar.set_cookie_if_ok(cookie, request)`126127Устанавливает [`Cookie`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.Cookie), если политика разрешает это.128129#### `CookieJar.set_cookie(cookie)`130131Устанавливает [`Cookie`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.Cookie) без проверки политики, следует ли его устанавливать.132133#### `CookieJar.clear([domain[, path[, name]]])`134135Очищает некоторые куки.136137Если вызван без аргументов, очищает все cookie. Если передан один аргумент, удаляются только cookie, принадлежащие этому *домену*. Если передано два аргумента, удаляются cookie, принадлежащие указанному *домену* и URL-*пути*. Если передано три аргумента, то удаляется cookie с указанными *доменом*, *путём* и *именем*.138139Возбуждает [`KeyError`](https://python-all.ru/3.8/library/exceptions.html#KeyError), если соответствующая cookie не найдена.140141#### `CookieJar.clear_session_cookies()`142143Удалить все сессионные куки.144145Удаляет все содержащиеся cookie, у которых атрибут `discard` имеет значение true (обычно потому, что у них не было атрибута cookie `max-age` или `expires`, либо был явный атрибут cookie `discard`). Для интерактивных браузеров окончание сессии обычно соответствует закрытию окна браузера.146147Обратите внимание, что метод `save()` в любом случае не сохраняет сессионные куки, если не указать иное, передав аргумент *ignore\_discard* со значением True.148149[`FileCookieJar`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.FileCookieJar) реализует следующие дополнительные методы:150151#### `FileCookieJar.save(filename=None, ignore_discard=False, ignore_expires=False)`152153Сохраняет куки в файл.154155Этот базовый класс вызывает исключение [`NotImplementedError`](https://python-all.ru/3.8/library/exceptions.html#NotImplementedError). Подклассы могут оставлять этот метод нереализованным.156157*filename* is the name of file in which to save cookies. If *filename* is not specified, `self.filename` is used (whose default is the value passed to the constructor, if any); if `self.filename` is [`None`](https://python-all.ru/3.8/library/constants.html#None), [`ValueError`](https://python-all.ru/3.8/library/exceptions.html#ValueError) is raised.158159*ignore\_discard*: сохранять даже те куки, которые помечены к удалению. *ignore\_expires*: сохранять даже куки с истекшим сроком действия.160161Файл перезаписывается, если он уже существует, при этом удаляются все куки, которые он содержит. Сохраненные куки можно восстановить позже с помощью методов [`load()`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.FileCookieJar.load) или [`revert()`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.FileCookieJar.revert).162163#### `FileCookieJar.load(filename=None, ignore_discard=False, ignore_expires=False)`164165Загружает куки из файла.166167Старые куки сохраняются, если они не перезаписываются вновь загруженными.168169Аргументы такие же, как для [`save()`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.FileCookieJar.save).170171Указанный файл должен быть в формате, понятном классу, иначе будет возбуждено [`LoadError`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.LoadError). Кроме того, может быть возбуждено [`OSError`](https://python-all.ru/3.8/library/exceptions.html#OSError), например, если файл не существует.172173Изменено в версии 3.3: [`IOError`](https://python-all.ru/3.8/library/exceptions.html#IOError) раньше возбуждалось, теперь это псевдоним [`OSError`](https://python-all.ru/3.8/library/exceptions.html#OSError).174175#### `FileCookieJar.revert(filename=None, ignore_discard=False, ignore_expires=False)`176177Очищает все куки и перезагружает куки из сохраненного файла.178179[`revert()`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.FileCookieJar.revert) может возбуждать те же исключения, что и [`load()`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.FileCookieJar.load). В случае неудачи состояние объекта не изменится.180181Экземпляры [`FileCookieJar`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.FileCookieJar) имеют следующие открытые атрибуты:182183#### `FileCookieJar.filename`184185Имя файла по умолчанию, в котором хранятся куки. Этому атрибуту можно присваивать значение.186187#### `FileCookieJar.delayload`188189Если истина, загружать куки с диска лениво. Этому атрибуту не следует присваивать значение. Это всего лишь подсказка, поскольку влияет только на производительность, а не на поведение (если только куки на диске не изменяются). Объект [`CookieJar`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.CookieJar) может игнорировать её. Ни один из классов [`FileCookieJar`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.FileCookieJar), входящих в стандартную библиотеку, не загружает куки лениво.190191## Подклассы FileCookieJar и взаимодействие с веб-браузерами192193Следующие подклассы [`CookieJar`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.CookieJar) предоставляются для чтения и записи.194195#### `class http.cookiejar.MozillaCookieJar(filename, delayload=None, policy=None)`196197[`FileCookieJar`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.FileCookieJar), который может загружать и сохранять куки на диск в файловом формате Mozilla `cookies.txt` (также используется браузерами Lynx и Netscape).198199> **Примечание**200>201> При этом теряется информация о cookie [**RFC 2965**](https://python-all.ru/3.8/library/http.cookiejar.html), а также о более новых или нестандартных атрибутах cookie, таких как `port`.202203> **Предупреждение**204>205> Сделайте резервную копию ваших куки перед сохранением, если у вас есть куки, потеря или повреждение которых будут нежелательны (есть некоторые тонкости, которые могут привести к небольшим изменениям в файле при полном цикле загрузки/сохранения).206207Также учтите, что куки, сохраненные во время работы Mozilla, будут перезаписаны Mozilla.208209#### `class http.cookiejar.LWPCookieJar(filename, delayload=None, policy=None)`210211Объект [`FileCookieJar`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.FileCookieJar), который может загружать и сохранять куки на диск в формате, совместимом с форматом файлов `Set-Cookie3` библиотеки libwww-perl. Это удобно, если нужно хранить куки в файле, читаемом человеком.212213Изменено в версии 3.8: Параметр filename поддерживает [объект, подобный пути](https://python-all.ru/3.8/glossary.html#term-path-like-object).214215## Объекты CookiePolicy216217Объекты, реализующие интерфейс [`CookiePolicy`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.CookiePolicy), имеют следующие методы:218219#### `CookiePolicy.set_ok(cookie, request)`220221Возвращает логическое значение, указывающее, следует ли принять куки от сервера.222223*cookie* – экземпляр [`Cookie`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.Cookie). *request* – объект, реализующий интерфейс, описанный в документации для [`CookieJar.extract_cookies()`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.CookieJar.extract_cookies).224225#### `CookiePolicy.return_ok(cookie, request)`226227Возвращает логическое значение, указывающее, следует ли вернуть куки серверу.228229*cookie* – экземпляр [`Cookie`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.Cookie). *request* – объект, реализующий интерфейс, описанный в документации для [`CookieJar.add_cookie_header()`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.CookieJar.add_cookie_header).230231#### `CookiePolicy.domain_return_ok(domain, request)`232233Возвращает `False`, если куки не следует возвращать, с учётом домена куки.234235Этот метод – оптимизация. Он избавляет от необходимости проверять каждый куки для определённого домена (что может потребовать чтения многих файлов). Возврат true от [`domain_return_ok()`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.CookiePolicy.domain_return_ok) и [`path_return_ok()`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.CookiePolicy.path_return_ok) оставляет всю работу [`return_ok()`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.CookiePolicy.return_ok).236237Если [`domain_return_ok()`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.CookiePolicy.domain_return_ok) возвращает true для домена куки, [`path_return_ok()`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.CookiePolicy.path_return_ok) вызывается для пути куки. В противном случае [`path_return_ok()`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.CookiePolicy.path_return_ok) и [`return_ok()`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.CookiePolicy.return_ok) никогда не вызываются для этого домена куки. Если [`path_return_ok()`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.CookiePolicy.path_return_ok) возвращает true, [`return_ok()`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.CookiePolicy.return_ok) вызывается с объектом [`Cookie`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.Cookie) для полной проверки. В противном случае [`return_ok()`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.CookiePolicy.return_ok) никогда не вызывается для этого пути куки.238239Обратите внимание, что [`domain_return_ok()`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.CookiePolicy.domain_return_ok) вызывается для каждого *домена куки*, а не только для *домена запроса*. Например, функция может вызываться как с `".example.com"`, так и с `"www.example.com"`, если домен запроса – `"www.example.com"`. То же самое относится к [`path_return_ok()`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.CookiePolicy.path_return_ok).240241Аргумент *request* описан в документации [`return_ok()`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.CookiePolicy.return_ok).242243#### `CookiePolicy.path_return_ok(path, request)`244245Возвращает `False`, если куки не следует возвращать, с учётом пути куки.246247См. документацию [`domain_return_ok()`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.CookiePolicy.domain_return_ok).248249Помимо реализации методов, описанных выше, реализации интерфейса [`CookiePolicy`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.CookiePolicy) должны также предоставлять следующие атрибуты, указывающие, какие протоколы следует использовать и как. Все эти атрибуты могут быть изменены (присвоены).250251#### `CookiePolicy.netscape`252253Реализация протокола Netscape.254255#### `CookiePolicy.rfc2965`256257Реализация протокола [**RFC 2965**](https://python-all.ru/3.8/library/http.cookiejar.html).258259#### `CookiePolicy.hide_cookie2`260261Не добавлять заголовок *Cookie2* к запросам (наличие этого заголовка указывает серверу, что мы понимаем куки [**RFC 2965**](https://python-all.ru/3.8/library/http.cookiejar.html)).262263Самый удобный способ определить класс [`CookiePolicy`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.CookiePolicy) – это создать подкласс от [`DefaultCookiePolicy`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.DefaultCookiePolicy) и переопределить некоторые (или все) методы выше. Сам [`CookiePolicy`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.CookiePolicy) может использоваться как «нулевая политика», позволяющая устанавливать и принимать любые куки (вряд ли это будет полезно).264265## Объекты DefaultCookiePolicy266267Реализует стандартные правила принятия и возврата куки.268269Охвачены как куки [**RFC 2965**](https://python-all.ru/3.8/library/http.cookiejar.html), так и Netscape. Обработка RFC 2965 отключена по умолчанию.270271Самый простой способ создать свою политику – переопределить этот класс и вызывать его методы в ваших переопределённых реализациях перед добавлением собственных дополнительных проверок:272273```python274import http.cookiejar275class MyCookiePolicy(http.cookiejar.DefaultCookiePolicy):276    def set_ok(self, cookie, request):277        if not http.cookiejar.DefaultCookiePolicy.set_ok(self, cookie, request):278            return False279        if i_dont_want_to_store_this_cookie(cookie):280            return False281        return True282```283284Помимо возможностей, необходимых для реализации интерфейса [`CookiePolicy`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.CookiePolicy), этот класс позволяет блокировать и разрешать домены при установке и получении куки. Также есть несколько переключателей строгости, которые позволяют немного ужесточить довольно свободные правила протокола Netscape (ценой блокировки некоторых безвредных куки).285286Предоставляются чёрный и белый списки доменов (оба отключены по умолчанию). В установке и возврате cookie участвуют только домены, не входящие в чёрный список и присутствующие в белом списке (если белый список активен). Используйте аргумент конструктора *blocked\_domains* и методы `blocked_domains()` и `set_blocked_domains()` (а также соответствующие аргумент и методы для *allowed\_domains*). Если белый список установлен, его можно снова отключить, присвоив ему значение [`None`](https://python-all.ru/3.8/library/constants.html#None).287288Домены из чёрного или белого списков, которые не начинаются с точки, должны в точности совпадать с доменом cookie для сопоставления. Например, `"example.com"` соответствует записи чёрного списка `"example.com"`, а `"www.example.com"` – нет. Домены, начинающиеся с точки, также сопоставляются с более конкретными доменами. Например, и `"www.example.com"`, и `"www.coyote.example.com"` соответствуют `".example.com"` (но сам `"example.com"` не соответствует). IP-адреса являются исключением и должны совпадать точно. Например, если blocked\_domains содержит `"192.168.1.2"` и `".168.1.2"`, то 192.168.1.2 блокируется, а 193.168.1.2 – нет.289290[`DefaultCookiePolicy`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.DefaultCookiePolicy) реализует следующие дополнительные методы:291292#### `DefaultCookiePolicy.blocked_domains()`293294Возвращает последовательность заблокированных доменов (в виде кортежа).295296#### `DefaultCookiePolicy.set_blocked_domains(blocked_domains)`297298Устанавливает последовательность заблокированных доменов.299300#### `DefaultCookiePolicy.is_blocked(domain)`301302Возвращает, находится ли *domain* в чёрном списке для установки или получения куки.303304#### `DefaultCookiePolicy.allowed_domains()`305306Возвращает [`None`](https://python-all.ru/3.8/library/constants.html#None) или последовательность разрешённых доменов (в виде кортежа).307308#### `DefaultCookiePolicy.set_allowed_domains(allowed_domains)`309310Устанавливает последовательность разрешённых доменов или [`None`](https://python-all.ru/3.8/library/constants.html#None).311312#### `DefaultCookiePolicy.is_not_allowed(domain)`313314Возвращает, не находится ли *domain* в белом списке для установки или получения куки.315316Экземпляры [`DefaultCookiePolicy`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.DefaultCookiePolicy) имеют следующие атрибуты, все они инициализируются из аргументов конструктора с теми же именами, и всем им можно присваивать значения.317318#### `DefaultCookiePolicy.rfc2109_as_netscape`319320Если истина, запросить, чтобы экземпляр [`CookieJar`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.CookieJar) понизил [**RFC 2109**](https://python-all.ru/3.8/library/http.cookiejar.html) cookie (то есть cookie, полученные в заголовке *Set-Cookie* с версией cookie-атрибута 1) до Netscape cookie, установив атрибут version экземпляра [`Cookie`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.Cookie) в 0. Значение по умолчанию – [`None`](https://python-all.ru/3.8/library/constants.html#None); в этом случае cookie RFC 2109 понижаются тогда и только тогда, когда обработка [**RFC 2965**](https://python-all.ru/3.8/library/http.cookiejar.html) отключена. Таким образом, cookie RFC 2109 понижаются по умолчанию.321322Общие переключатели строгости:323324#### `DefaultCookiePolicy.strict_domain`325326Не разрешает сайтам устанавливать двухкомпонентные домены с национальными доменами верхнего уровня, такими как `.co.uk`, `.gov.uk`, `.co.nz` и т.д. Это далеко от совершенства и не гарантирует работу!327328[**RFC 2965**](https://python-all.ru/3.8/library/http.cookiejar.html) переключатели строгости протокола:329330#### `DefaultCookiePolicy.strict_rfc2965_unverifiable`331332Следует правилам [**RFC 2965**](https://python-all.ru/3.8/library/http.cookiejar.html) для непроверяемых транзакций (обычно непроверяемая транзакция – это результат перенаправления или запроса изображения, размещённого на другом сайте). Если это ложь, cookies *никогда* не блокируются на основе проверяемости.333334Переключатели строгости протокола Netscape:335336#### `DefaultCookiePolicy.strict_ns_unverifiable`337338Применяет правила [**RFC 2965**](https://python-all.ru/3.8/library/http.cookiejar.html) для непроверяемых транзакций даже к cookies Netscape.339340#### `DefaultCookiePolicy.strict_ns_domain`341342Флаги, указывающие, насколько строгими должны быть правила сопоставления доменов для cookies Netscape. Допустимые значения приведены ниже.343344#### `DefaultCookiePolicy.strict_ns_set_initial_dollar`345346Игнорирует cookies в заголовках Set-Cookie, имена которых начинаются с `'$'`.347348#### `DefaultCookiePolicy.strict_ns_set_path`349350Не разрешать установку куки, путь которых не соответствует URI запроса.351352`strict_ns_domain` – это набор флагов. Его значение формируется путём логического ИЛИ (например, `DomainStrictNoDots|DomainStrictNonDomain` означает, что установлены оба флага).353354#### `DefaultCookiePolicy.DomainStrictNoDots`355356При установке cookie «префикс хоста» не должен содержать точку (например, `www.foo.bar.com` не может установить cookie для `.bar.com`, потому что `www.foo` содержит точку).357358#### `DefaultCookiePolicy.DomainStrictNonDomain`359360Cookie, которые не указали явно атрибут cookie `domain`, могут быть возвращены только домену, равному домену, установившему cookie (например, `spam.example.com` не будут возвращены cookie от `example.com`, у которых не было атрибута cookie `domain`).361362#### `DefaultCookiePolicy.DomainRFC2965Match`363364При установке куки требуется полное [**RFC 2965**](https://python-all.ru/3.8/library/http.cookiejar.html) соответствие доменов.365366Следующие атрибуты предоставлены для удобства и представляют собой наиболее полезные комбинации указанных выше флагов:367368#### `DefaultCookiePolicy.DomainLiberal`369370Эквивалентно 0 (то есть все указанные выше флаги строгости домена Netscape отключены).371372#### `DefaultCookiePolicy.DomainStrict`373374Эквивалентно `DomainStrictNoDots|DomainStrictNonDomain`.375376## Объекты Cookie377378Экземпляры [`Cookie`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.Cookie) имеют атрибуты Python, примерно соответствующие стандартным атрибутам cookie, определённым в различных стандартах cookies. Это соответствие не является взаимно однозначным, так как существуют сложные правила назначения значений по умолчанию, атрибуты `max-age` и `expires` содержат эквивалентную информацию, и cookie [**RFC 2109**](https://python-all.ru/3.8/library/http.cookiejar.html) могут быть 'понижены' с помощью [`http.cookiejar`](https://python-all.ru/3.8/library/http.cookiejar.html#module-http.cookiejar) с версии 1 до версии 0 (Netscape) cookies.379380Присваивание этим атрибутам должно быть необходимо только в редких случаях, например в методе [`CookiePolicy`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.CookiePolicy). Класс не обеспечивает внутренней согласованности, поэтому следует понимать, что делается при таком присваивании.381382#### `Cookie.version`383384Целое число или [`None`](https://python-all.ru/3.8/library/constants.html#None). Cookie Netscape имеют [`version`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.Cookie.version) 0. Cookie [**RFC 2965**](https://python-all.ru/3.8/library/http.cookiejar.html) и [**RFC 2109**](https://python-all.ru/3.8/library/http.cookiejar.html) имеют атрибут cookie `version` равный 1. Однако обратите внимание, что [`http.cookiejar`](https://python-all.ru/3.8/library/http.cookiejar.html#module-http.cookiejar) может 'понижать' RFC 2109 cookie до Netscape cookie, и в этом случае [`version`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.Cookie.version) равен 0.385386#### `Cookie.name`387388Имя cookie (строка).389390#### `Cookie.value`391392Значение cookie (строка) или [`None`](https://python-all.ru/3.8/library/constants.html#None).393394#### `Cookie.port`395396Строка, представляющая порт или набор портов (например, ‘80’ или ‘80,8080’), или [`None`](https://python-all.ru/3.8/library/constants.html#None).397398#### `Cookie.path`399400Путь cookie (строка, например `'/acme/rocket_launchers'`).401402#### `Cookie.secure`403404`True`, если cookie должна возвращаться только через защищённое соединение.405406#### `Cookie.expires`407408Целочисленная дата истечения срока в секундах от начала эпохи или [`None`](https://python-all.ru/3.8/library/constants.html#None). См. также метод [`is_expired()`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.Cookie.is_expired).409410#### `Cookie.discard`411412`True`, если это сессионный cookie.413414#### `Cookie.comment`415416Строковый комментарий от сервера, поясняющий назначение этого cookie, или [`None`](https://python-all.ru/3.8/library/constants.html#None).417418#### `Cookie.comment_url`419420URL, ведущий на комментарий от сервера, поясняющий назначение этого cookie, или [`None`](https://python-all.ru/3.8/library/constants.html#None).421422#### `Cookie.rfc2109`423424`True` если эта cookie была получена как [**RFC 2109**](https://python-all.ru/3.8/library/http.cookiejar.html) cookie (т.е. cookie пришла в заголовке *Set-Cookie*, и значение атрибута cookie Version в этом заголовке было равно 1). Этот атрибут предусмотрен, потому что [`http.cookiejar`](https://python-all.ru/3.8/library/http.cookiejar.html#module-http.cookiejar) может 'понижать' RFC 2109 cookies до cookies Netscape, и в таком случае [`version`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.Cookie.version) равно 0.425426#### `Cookie.port_specified`427428`True`, если порт или набор портов был явно указан сервером (в заголовке *Set-Cookie* / *Set-Cookie2*).429430#### `Cookie.domain_specified`431432`True`, если домен был явно указан сервером.433434#### `Cookie.domain_initial_dot`435436`True`, если домен, явно указанный сервером, начинался с точки (`'.'`).437438Cookie могут иметь дополнительные нестандартные атрибуты cookie. Доступ к ним можно получить с помощью следующих методов:439440#### `Cookie.has_nonstandard_attr(name)`441442Возвращает `True`, если cookie имеет указанный атрибут cookie.443444#### `Cookie.get_nonstandard_attr(name, default=None)`445446Если cookie имеет указанный атрибут cookie, возвращает его значение. В противном случае возвращает *default*.447448#### `Cookie.set_nonstandard_attr(name, value)`449450Устанавливает значение указанного атрибута cookie.451452Класс [`Cookie`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.Cookie) также определяет следующий метод:453454#### `Cookie.is_expired(now=None)`455456`True`, если срок действия cookie истёк (прошло время, указанное сервером для истечения). Если передан *now* (в секундах с начала эпохи), возвращается, истёк ли срок действия cookie на указанный момент времени.457458## Примеры459460Первый пример показывает наиболее распространённое использование [`http.cookiejar`](https://python-all.ru/3.8/library/http.cookiejar.html#module-http.cookiejar):461462```python463import http.cookiejar, urllib.request464cj = http.cookiejar.CookieJar()465opener = urllib.request.build_opener(urllib.request.HTTPCookieProcessor(cj))466r = opener.open("http://example.com/")467```468469Этот пример иллюстрирует, как открыть URL с использованием ваших куки Netscape, Mozilla или Lynx (предполагается соглашение Unix/Netscape о местоположении файла куки):470471```python472import os, http.cookiejar, urllib.request473cj = http.cookiejar.MozillaCookieJar()474cj.load(os.path.join(os.path.expanduser("~"), ".netscape", "cookies.txt"))475opener = urllib.request.build_opener(urllib.request.HTTPCookieProcessor(cj))476r = opener.open("http://example.com/")477```478479Следующий пример иллюстрирует использование [`DefaultCookiePolicy`](https://python-all.ru/3.8/library/http.cookiejar.html#http.cookiejar.DefaultCookiePolicy). Включите [**RFC 2965**](https://python-all.ru/3.8/library/http.cookiejar.html) куки, будьте более строги к доменам при установке и возврате куки Netscape и заблокируйте некоторые домены, чтобы они не могли устанавливать куки или возвращать их:480481```python482import urllib.request483from http.cookiejar import CookieJar, DefaultCookiePolicy484policy = DefaultCookiePolicy(485    rfc2965=True, strict_ns_domain=Policy.DomainStrict,486    blocked_domains=["ads.net", ".ads.net"])487cj = CookieJar(policy)488opener = urllib.request.build_opener(urllib.request.HTTPCookieProcessor(cj))489r = opener.open("http://example.com/")490```491