Документация Python неофициальный перевод

urllib.request.md

794 строк · 86.1 КБ · обычная страница · сырой текст · скачать

1> **Источник:** https://python-all.ru/3.2/library/urllib.request.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# 20.5. [`urllib.request`](https://python-all.ru/3.2/library/urllib.request.html#module-urllib.request) – Расширяемая библиотека для открытия URL-адресов89Модуль [`urllib.request`](https://python-all.ru/3.2/library/urllib.request.html#module-urllib.request) определяет функции и классы, которые помогают открывать URL (в основном HTTP) в сложном мире – базовая и дайджест-аутентификация, перенаправления, куки и многое другое.1011Модуль [`urllib.request`](https://python-all.ru/3.2/library/urllib.request.html#module-urllib.request) определяет следующие функции:1213#### `urllib.request.urlopen(url, data=None[, timeout], *, cafile=None, capath=None)`1415Открывает URL *url*, который может быть строкой или объектом [`Request`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.Request).1617*data* должен быть объектом bytes, задающим дополнительные данные для отправки на сервер, или `None`, если такие данные не нужны. *data* также может быть итерируемым объектом, и в этом случае значение Content-Length должно быть указано в заголовках. В настоящее время только HTTP-запросы используют *data*; HTTP-запрос будет POST вместо GET, когда указан параметр *data*.1819*data* должен быть буфером в стандартном *application/x-www-form-urlencoded* формате. Функция [`urllib.parse.urlencode()`](https://python-all.ru/3.2/library/urllib.parse.html#urllib.parse.urlencode) принимает отображение или последовательность кортежей из двух элементов и возвращает строку в этом формате. Перед использованием в качестве параметра *data* её следует закодировать в байты. Параметр charset в заголовке `Content-Type` может использоваться для указания кодировки. Если параметр charset не передан с заголовком Content-Type, сервер, следуя рекомендации HTTP 1.1, может предположить, что данные закодированы в ISO-8859-1. Рекомендуется использовать параметр charset с кодировкой, указанной в заголовке `Content-Type`, совместно с [`Request`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.Request).2021Модуль urllib.request использует HTTP/1.1 и включает заголовок `Connection:close` в свои HTTP-запросы.2223Необязательный параметр *timeout* задает таймаут в секундах для блокирующих операций, таких как попытка подключения (если не указан, используется глобальная настройка таймаута по умолчанию). Это на самом деле работает только для HTTP, HTTPS и FTP-соединений.2425Необязательные параметры *cafile* и *capath* задают набор доверенных сертификатов ЦС для HTTPS-запросов. *cafile* должен указывать на один файл, содержащий набор сертификатов ЦС, а *capath* – на каталог с файлами сертификатов с хешированными именами. Дополнительную информацию можно найти в [`ssl.SSLContext.load_verify_locations()`](https://python-all.ru/3.2/library/ssl.html#ssl.SSLContext.load_verify_locations).2627> **Предупреждение**28>29> Если не указаны ни *cafile*, ни *capath*, HTTPS-запрос не будет выполнять проверку сертификата сервера.3031Для URL http и https эта функция возвращает объект [`http.client.HTTPResponse`](https://python-all.ru/3.2/library/http.client.html#http.client.HTTPResponse), который имеет следующие методы [*HTTPResponse Objects*](https://python-all.ru/3.2/library/http.client.html#httpresponse-objects).3233Для URL ftp, file и data, а также запросов, явно обрабатываемых устаревшими классами [`URLopener`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.URLopener) и [`FancyURLopener`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.FancyURLopener), эта функция возвращает объект `urllib.response.addinfourl`, который может работать как [*контекстный менеджер*](https://python-all.ru/3.2/glossary.html#term-context-manager) и имеет такие методы, как3435- `geturl()` – возвращает URL полученного ресурса; часто используется для определения, было ли выполнено перенаправление36- `info()` – возвращает метаинформацию страницы, такую как заголовки, в виде экземпляра [`email.message_from_string()`](https://python-all.ru/3.2/library/email.parser.html#email.message_from_string) (см. [Краткий справочник по HTTP-заголовкам](https://python-all.ru/3.2/library/urllib.request.html))37- `getcode()` – возвращает HTTP-статус код ответа.3839Возбуждает `URLError` при ошибках.4041Обратите внимание, что может быть возвращён `None`, если ни один обработчик не обрабатывает запрос (хотя установленный по умолчанию глобальный [`OpenerDirector`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.OpenerDirector) использует [`UnknownHandler`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.UnknownHandler), чтобы гарантировать, что этого никогда не произойдёт).4243Кроме того, установленный по умолчанию [`ProxyHandler`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.ProxyHandler) гарантирует, что запросы обрабатываются через прокси, если они настроены.4445Устаревшая функция `urllib.urlopen` из Python 2.6 и более ранних версий была прекращена; [`urllib.request.urlopen()`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.urlopen) соответствует старой `urllib2.urlopen`. Обработка прокси, которая выполнялась путём передачи словаря в `urllib.urlopen`, может быть получена с помощью объектов [`ProxyHandler`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.ProxyHandler).4647Изменено в версии 3.2: добавлены *cafile* и *capath*.4849Изменено в версии 3.2: теперь поддерживаются виртуальные хосты HTTPS, если это возможно (то есть, если [`ssl.HAS_SNI`](https://python-all.ru/3.2/library/ssl.html#ssl.HAS_SNI) равно true).5051Новое в версии 3.2: *data* может быть итерируемым объектом.5253#### `urllib.request.install_opener(opener)`5455Устанавливает экземпляр [`OpenerDirector`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.OpenerDirector) в качестве глобального открывателя по умолчанию. Установка открывателя нужна только в том случае, если требуется, чтобы urlopen использовал именно этот открыватель; в противном случае просто вызывайте [`OpenerDirector.open()`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.OpenerDirector.open) вместо [`urlopen()`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.urlopen). Код не проверяет, является ли объект реальным [`OpenerDirector`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.OpenerDirector); подойдёт любой класс с подходящим интерфейсом.5657#### `urllib.request.build_opener([handler, ...])`5859Возвращает экземпляр [`OpenerDirector`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.OpenerDirector), который объединяет *обработчики* в указанном порядке. [`BaseHandler`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.BaseHandler), или подклассы [`BaseHandler`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.BaseHandler) (в этом случае конструктор должен вызываться без параметров). Экземпляры следующих классов будут располагаться перед *обработчиками*, если только *обработчики* не содержат их, их экземпляры или подклассы: [`ProxyHandler`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.ProxyHandler), [`UnknownHandler`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.UnknownHandler), [`HTTPHandler`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.HTTPHandler), [`HTTPDefaultErrorHandler`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.HTTPDefaultErrorHandler), [`HTTPRedirectHandler`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.HTTPRedirectHandler), [`FTPHandler`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.FTPHandler), [`FileHandler`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.FileHandler), [`HTTPErrorProcessor`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.HTTPErrorProcessor).6061Если установка Python имеет поддержку SSL (т.е. если можно импортировать модуль [`ssl`](https://python-all.ru/3.2/library/ssl.html#module-ssl)), будет также добавлен [`HTTPSHandler`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.HTTPSHandler).6263Подкласс [`BaseHandler`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.BaseHandler) может также изменить свой атрибут `handler_order`, чтобы изменить свою позицию в списке обработчиков.6465#### `urllib.request.pathname2url(path)`6667Преобразует имя пути *path* из локального синтаксиса в форму, используемую в компоненте пути URL. При этом не создаётся полный URL. Возвращаемое значение уже будет экранировано с помощью функции `quote()`.6869#### `urllib.request.url2pathname(path)`7071Преобразует компонент пути *path* из URL с процентным кодированием в локальный синтаксис пути. Эта функция не принимает полный URL. Для декодирования *path* используется `unquote()`.7273#### `urllib.request.getproxies()`7475Эта вспомогательная функция возвращает словарь, сопоставляющий схему с URL прокси-сервера. Сначала она ищет переменные окружения вида `<scheme>_proxy` (без учёта регистра) для всех операционных систем, а если не находит, то обращается к системной конфигурации Mac OS X и реестру Windows.7677Предоставляются следующие классы:7879#### `class urllib.request.Request(url, data=None, headers={}, origin_req_host=None, unverifiable=False)`8081Этот класс представляет абстракцию URL-запроса.8283*url* должен быть строкой, содержащей корректный URL.8485Параметр *data* должен быть объектом bytes, задающим дополнительные данные для отправки на сервер, или `None`, если такие данные не нужны. В настоящее время только HTTP-запросы используют *data*; HTTP-запрос будет POST вместо GET, когда указан параметр *data*. Параметр *data* должен быть буфером в стандартном формате *application/x-www-form-urlencoded*.8687Функция [`urllib.parse.urlencode()`](https://python-all.ru/3.2/library/urllib.parse.html#urllib.parse.urlencode) принимает отображение или последовательность кортежей из двух элементов и возвращает строку в этом формате. Её следует закодировать в байты перед использованием в качестве параметра *data*. Параметр charset в заголовке `Content-Type` может использоваться для указания кодировки. Если параметр charset не передан с заголовком Content-Type, сервер, следуя рекомендации HTTP 1.1, может предположить, что данные закодированы в ISO-8859-1. Рекомендуется использовать параметр charset с кодировкой, указанной в заголовке `Content-Type`, совместно с [`Request`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.Request).8889*headers* должен быть словарём, и будет обрабатываться так, как если бы для каждой пары ключ-значение была вызвана [`add_header()`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.Request.add_header). Это часто используется для «подделки» заголовка `User-Agent`, который браузер использует для самоидентификации – некоторые HTTP-серверы разрешают запросы только от распространённых браузеров, а не от скриптов. Например, Mozilla Firefox может идентифицировать себя как `"Mozilla/5.0 (X11; U; Linux i686) Gecko/20071127 Firefox/2.0.0.11"`, в то время как строка пользовательского агента по умолчанию для `urllib``"Python-urllib/2.6"` (на Python 2.6).9091Пример использования заголовка `Content-Type` с аргументом *data* – отправка словаря вида `{"Content-Type":" application/x-www-form-urlencoded;charset=utf-8"}`9293Последние два аргумента представляют интерес только для корректной обработки сторонних HTTP-куки:9495*origin\_req\_host* должен быть хостом запроса исходной транзакции, как определено в [**RFC 2965**](https://python-all.ru/3.2/library/urllib.request.html). По умолчанию `http.cookiejar.request_host(self)`. Это имя хоста или IP-адрес исходного запроса, инициированного пользователем. Например, если запрос предназначен для изображения в HTML-документе, здесь должен быть хост запроса страницы, содержащей изображение.9697*unverifiable* должен указывать, является ли запрос непроверяемым, как определено в RFC 2965. По умолчанию False. Непроверяемый запрос – это запрос, URL которого пользователь не мог утвердить. Например, если запрос предназначен для изображения в HTML-документе, и у пользователя не было возможности разрешить автоматическую загрузку изображения, это должно быть true.9899#### `class urllib.request.OpenerDirector`100101Класс [`OpenerDirector`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.OpenerDirector) открывает URL-адреса через цепочку обработчиков [`BaseHandler`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.BaseHandler). Он управляет объединением обработчиков в цепочку и восстановлением после ошибок.102103#### `class urllib.request.BaseHandler`104105Это базовый класс для всех зарегистрированных обработчиков – он отвечает только за простую механику регистрации.106107#### `class urllib.request.HTTPDefaultErrorHandler`108109Класс, который определяет обработчик по умолчанию для HTTP-ответов с ошибками; все ответы преобразуются в исключения `HTTPError`.110111#### `class urllib.request.HTTPRedirectHandler`112113Класс для обработки перенаправлений.114115#### `class urllib.request.HTTPCookieProcessor(cookiejar=None)`116117Класс для обработки HTTP-куки.118119#### `class urllib.request.ProxyHandler(proxies=None)`120121Заставляет запросы проходить через прокси. Если *proxies* указан, он должен быть словарём, сопоставляющим имена протоколов с URL-адресами прокси. По умолчанию список прокси читается из переменных окружения `<протокол>_proxy`. Если переменные окружения прокси не заданы, в среде Windows настройки прокси берутся из раздела Internet Settings реестра, а в среде Mac OS X информация о прокси получается из платформы System Configuration Framework.122123Чтобы отключить автоматически обнаруженный прокси, передайте пустой словарь.124125#### `class urllib.request.HTTPPasswordMgr`126127Ведёт базу данных соответствий между `(realm, uri) -> и (user, password)`.128129#### `class urllib.request.HTTPPasswordMgrWithDefaultRealm`130131Ведёт базу данных соответствий между `(realm, uri) -> и (user, password)`. Область (realm) со значением `None` считается универсальной – она используется, если не подходит ни одна другая.132133#### `class urllib.request.AbstractBasicAuthHandler(password_mgr=None)`134135Это миксин-класс, который помогает с HTTP-аутентификацией как на удалённом хосте, так и на прокси. *password\_mgr*, если задан, должен быть совместим с [`HTTPPasswordMgr`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.HTTPPasswordMgr); информацию об интерфейсе, который должен поддерживаться, см. в разделе [*HTTPPasswordMgr Objects*](https://python-all.ru/3.2/library/urllib.request.html#http-password-mgr).136137#### `class urllib.request.HTTPBasicAuthHandler(password_mgr=None)`138139Обрабатывает аутентификацию с удалённым хостом. Если указан, *password\_mgr* должен быть совместим с [`HTTPPasswordMgr`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.HTTPPasswordMgr); информацию о том, какой интерфейс должен поддерживаться, см. в разделе [*HTTPPasswordMgr Objects*](https://python-all.ru/3.2/library/urllib.request.html#http-password-mgr).140141#### `class urllib.request.ProxyBasicAuthHandler(password_mgr=None)`142143Обрабатывает аутентификацию с прокси. *password\_mgr*, если задан, должен быть совместим с [`HTTPPasswordMgr`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.HTTPPasswordMgr); информацию об интерфейсе, который должен поддерживаться, см. в разделе [*HTTPPasswordMgr Objects*](https://python-all.ru/3.2/library/urllib.request.html#http-password-mgr).144145#### `class urllib.request.AbstractDigestAuthHandler(password_mgr=None)`146147Это миксин-класс, который помогает с HTTP-аутентификацией как на удалённом хосте, так и на прокси. *password\_mgr*, если задан, должен быть совместим с [`HTTPPasswordMgr`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.HTTPPasswordMgr); информацию об интерфейсе, который должен поддерживаться, см. в разделе [*HTTPPasswordMgr Objects*](https://python-all.ru/3.2/library/urllib.request.html#http-password-mgr).148149#### `class urllib.request.HTTPDigestAuthHandler(password_mgr=None)`150151Обрабатывает аутентификацию с удалённым хостом. Если указан, *password\_mgr* должен быть совместим с [`HTTPPasswordMgr`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.HTTPPasswordMgr); информацию о том, какой интерфейс должен поддерживаться, см. в разделе [*HTTPPasswordMgr Objects*](https://python-all.ru/3.2/library/urllib.request.html#http-password-mgr).152153#### `class urllib.request.ProxyDigestAuthHandler(password_mgr=None)`154155Обрабатывает аутентификацию с прокси. *password\_mgr*, если задан, должен быть совместим с [`HTTPPasswordMgr`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.HTTPPasswordMgr); информацию об интерфейсе, который должен поддерживаться, см. в разделе [*HTTPPasswordMgr Objects*](https://python-all.ru/3.2/library/urllib.request.html#http-password-mgr).156157#### `class urllib.request.HTTPHandler`158159Класс для открытия HTTP-URL.160161#### `class urllib.request.HTTPSHandler(debuglevel=0, context=None, check_hostname=None)`162163Класс для открытия HTTPS-URL. *context* и *check\_hostname* имеют тот же смысл, что и в [`http.client.HTTPSConnection`](https://python-all.ru/3.2/library/http.client.html#http.client.HTTPSConnection).164165Изменено в версии 3.2: добавлены *context* и *check\_hostname*.166167#### `class urllib.request.FileHandler`168169Открывает локальные файлы.170171#### `class urllib.request.FTPHandler`172173Открывает FTP-URL.174175#### `class urllib.request.CacheFTPHandler`176177Открывает FTP-URL, сохраняя кеш открытых FTP-соединений для минимизации задержек.178179#### `class urllib.request.UnknownHandler`180181Универсальный класс для обработки неизвестных URL.182183#### `class urllib.request.HTTPErrorProcessor`184185Обрабатывает ошибочные HTTP-ответы.186187## 20.5.1. Объекты Request188189Следующие методы описывают открытый интерфейс [`Request`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.Request), и все они могут быть переопределены в подклассах. Он также определяет несколько открытых атрибутов, которые могут использоваться клиентами для анализа разобранного запроса.190191#### `Request.full_url`192193Оригинальный URL, переданный конструктору.194195#### `Request.type`196197Схема URI.198199#### `Request.host`200201Авторитетная часть URI, обычно хост, но может также содержать порт, отделённый двоеточием.202203#### `Request.origin_req_host`204205Исходный хост запроса, без порта.206207#### `Request.selector`208209Путь URI. Если [`Request`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.Request) использует прокси, то selector будет полным URL, который передаётся прокси.210211#### `Request.data`212213Тело запроса (entity body) или None, если не указано.214215#### `Request.unverifiable`216217логическое значение, указывает, является ли запрос непроверяемым, как определено в RFC 2965.218219#### `Request.add_data(data)`220221Устанавливает данные [`Request`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.Request) в *data*. Это игнорируется всеми обработчиками, кроме HTTP-обработчиков – в них это должна быть строка байтов, и изменит запрос на `POST` вместо `GET`.222223#### `Request.get_method()`224225Возвращает строку, указывающую метод HTTP-запроса. Это имеет смысл только для HTTP-запросов, и в настоящее время всегда возвращает `'GET'` или `'POST'`.226227#### `Request.has_data()`228229Возвращает, есть ли у экземпляра данные, отличные от `None`.230231#### `Request.get_data()`232233Возвращает данные экземпляра.234235#### `Request.add_header(key, val)`236237Добавляет ещё один заголовок к запросу. В настоящее время заголовки игнорируются всеми обработчиками, кроме HTTP-обработчиков, где они добавляются в список заголовков, отправляемых серверу. Обратите внимание, что не может быть более одного заголовка с одним и тем же именем, и последующие вызовы перезапишут предыдущие в случае совпадения *ключа*. В настоящее время это не приводит к потере функциональности HTTP, поскольку все заголовки, имеющие смысл при многократном использовании, имеют (специфичный для заголовка) способ достижения той же функциональности с помощью только одного заголовка.238239#### `Request.add_unredirected_header(key, header)`240241Добавляет заголовок, который не будет добавлен в перенаправленный запрос.242243#### `Request.has_header(header)`244245Возвращает, имеет ли экземпляр указанный заголовок (проверяет как обычные, так и неперенаправленные).246247#### `Request.get_full_url()`248249Возвращает URL, переданный в конструктор.250251#### `Request.get_type()`252253Возвращает тип URL – также известный как схема.254255#### `Request.get_host()`256257Возвращает хост, к которому будет установлено соединение.258259#### `Request.get_selector()`260261Возвращает селектор – часть URL, которая отправляется серверу.262263#### `Request.get_header(header_name, default=None)`264265Возвращает значение указанного заголовка. Если заголовок отсутствует, возвращает значение по умолчанию.266267#### `Request.header_items()`268269Возвращает список кортежей (имя\_заголовка, значение\_заголовка) заголовков запроса.270271#### `Request.set_proxy(host, type)`272273Подготавливает запрос, подключаясь к прокси-серверу. *host* и *type* заменят соответствующие значения экземпляра, а selector экземпляра будет содержать исходный URL, переданный в конструктор.274275#### `Request.get_origin_req_host()`276277Возвращает хост запроса исходной транзакции, как определено в [**RFC 2965**](https://python-all.ru/3.2/library/urllib.request.html). См. документацию к конструктору [`Request`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.Request).278279#### `Request.is_unverifiable()`280281Возвращает, является ли запрос непроверяемым, как определено в RFC 2965. См. документацию к конструктору [`Request`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.Request).282283## 20.5.2. Объекты OpenerDirector284285[`OpenerDirector`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.OpenerDirector) имеет следующие методы:286287#### `OpenerDirector.add_handler(handler)`288289*handler* должен быть экземпляром [`BaseHandler`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.BaseHandler). Ищутся и добавляются в возможные цепочки следующие методы (обратите внимание, что ошибки HTTP являются особым случаем).290291- `protocol_open()` – сигнал о том, что обработчик умеет открывать URL-адреса *протокол*.292- `http_error_type()` – сигнал о том, что обработчик умеет обрабатывать ошибки HTTP с кодом ошибки HTTP *type*.293- `protocol_error()` – сигнал о том, что обработчик умеет обрабатывать ошибки от протокола *протокол* (кроме `http`).294- `protocol_request()` – сигнал о том, что обработчик умеет предварительно обрабатывать запросы *протокол*.295- `protocol_response()` – сигнал о том, что обработчик умеет выполнять последующую обработку ответов *протокол*.296297#### `OpenerDirector.open(url, data=None[, timeout])`298299Открывает указанный *url* (может быть объектом запроса или строкой), необязательно передавая указанные *data*. Аргументы, возвращаемые значения и исключения такие же, как у [`urlopen()`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.urlopen) (которая просто вызывает метод [`open()`](https://python-all.ru/3.2/library/functions.html#open) у текущего установленного глобального [`OpenerDirector`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.OpenerDirector)). Необязательный параметр *timeout* задает тайм-аут в секундах для блокирующих операций, таких как попытка соединения (если не указан, используется глобальный тайм-аут по умолчанию). Тайм-аут работает только для соединений HTTP, HTTPS и FTP).300301#### `OpenerDirector.error(proto, *args)`302303Обрабатывает ошибку указанного протокола. Вызывает зарегистрированные обработчики ошибок для данного протокола с указанными аргументами (которые зависят от протокола). Протокол HTTP является особым случаем, использующим код ответа HTTP для определения конкретного обработчика ошибок; обратитесь к методам `http_error_*()` классов обработчиков.304305Возвращаемые значения и исключения такие же, как у [`urlopen()`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.urlopen).306307Объекты OpenerDirector открывают URL в три этапа:308309Порядок вызова этих методов в каждом этапе определяется сортировкой экземпляров обработчиков.3103111. У каждого обработчика, имеющего метод с именем вида `protocol_request()`, этот метод вызывается для предварительной обработки запроса.3122. Обработчики с методом, названным как `protocol_open()`, вызываются для обработки запроса. Этот этап завершается, когда обработчик либо возвращает значение, отличное от [`None`](https://python-all.ru/3.2/library/constants.html#None) (т.е. ответ), либо вызывает исключение (обычно `URLError`). Исключения могут распространяться.313314   На самом деле описанный алгоритм сначала применяется к методам с именем `default_open()`. Если все такие методы возвращают [`None`](https://python-all.ru/3.2/library/constants.html#None), алгоритм повторяется для методов с именем вида `protocol_open()`. Если все такие методы возвращают [`None`](https://python-all.ru/3.2/library/constants.html#None), алгоритм повторяется для методов с именем `unknown_open()`.315316   Обратите внимание, что реализация этих методов может включать вызовы методов [`open()`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.OpenerDirector.open) и [`error()`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.OpenerDirector.error) родительского экземпляра [`OpenerDirector`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.OpenerDirector).3173. У каждого обработчика, имеющего метод с именем вида `protocol_response()`, этот метод вызывается для последующей обработки ответа.318319## 20.5.3. Объекты BaseHandler320321Объекты [`BaseHandler`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.BaseHandler) предоставляют несколько методов, которые полезны непосредственно, и другие, предназначенные для использования производными классами. Следующие предназначены для прямого использования:322323#### `BaseHandler.add_parent(director)`324325Добавляет директор в качестве родителя.326327#### `BaseHandler.close()`328329Удаляет всех родителей.330331Следующий атрибут и методы должны использоваться только классами, производными от [`BaseHandler`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.BaseHandler).332333> **Примечание**334>335> Принято соглашение: подклассы, определяющие методы `protocol_request()` или `protocol_response()`, называются `*Processor`; все остальные называются `*Handler`.336337#### `BaseHandler.parent`338339Действительный объект [`OpenerDirector`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.OpenerDirector), который можно использовать для открытия с помощью другого протокола или для обработки ошибок.340341#### `BaseHandler.default_open(req)`342343Этот метод *не* определён в [`BaseHandler`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.BaseHandler), но подклассы должны определить его, если хотят перехватывать все URL.344345Этот метод, если реализован, будет вызван родительским [`OpenerDirector`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.OpenerDirector). Он должен вернуть объект, похожий на файл, как описано в возвращаемом значении [`open()`](https://python-all.ru/3.2/library/functions.html#open) класса [`OpenerDirector`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.OpenerDirector), или `None`. Он должен вызывать `URLError`, если только не происходит действительно исключительная ситуация (например, [`MemoryError`](https://python-all.ru/3.2/library/exceptions.html#MemoryError) не должно преобразовываться в `URLError`).346347Этот метод будет вызван перед любым методом открытия, специфичным для протокола.348349#### `BaseHandler.protocol_open(req)`350351Этот метод *не* определён в [`BaseHandler`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.BaseHandler), но подклассы должны определить его, если хотят обрабатывать URL с указанным протоколом.352353Этот метод, если он определён, вызывается родительским [`OpenerDirector`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.OpenerDirector). Возвращаемые значения должны быть такими же, как для `default_open()`.354355#### `BaseHandler.unknown_open(req)`356357Этот метод *не* определён в [`BaseHandler`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.BaseHandler), но подклассы должны определить его, если хотят перехватывать все URL, для открытия которых нет зарегистрированного конкретного обработчика.358359Этот метод, если он реализован, вызывается родительским [`родительский`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.BaseHandler.parent) [`OpenerDirector`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.OpenerDirector). Возвращаемые значения должны быть такими же, как и для [`default_open()`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.BaseHandler.default_open).360361#### `BaseHandler.http_error_default(req, fp, code, msg, hdrs)`362363Этот метод *не* определён в [`BaseHandler`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.BaseHandler), но подклассы должны переопределить его, если намерены предоставить универсальный обработчик для всех прочих необработанных HTTP-ошибок. Он будет автоматически вызван [`OpenerDirector`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.OpenerDirector) при получении ошибки и обычно не должен вызываться в других обстоятельствах.364365*req* будет объектом [`Request`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.Request), *fp* – файлоподобным объектом с телом HTTP-ошибки, *code* – трёхзначным кодом ошибки, *msg* – понятным пользователю пояснением кода, а *hdrs* – объектом-отображением с заголовками ошибки.366367Возвращаемые значения и возбуждаемые исключения должны быть такими же, как у [`urlopen()`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.urlopen).368369#### `BaseHandler.http_error_nnn(req, fp, code, msg, hdrs)`370371*nnn* должен быть трёхзначным кодом HTTP-ошибки. Этот метод также не определён в [`BaseHandler`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.BaseHandler), но будет вызван, если он существует, на экземпляре подкласса при возникновении HTTP-ошибки с кодом *nnn*.372373Подклассы должны переопределить этот метод для обработки конкретных HTTP-ошибок.374375Аргументы, возвращаемые значения и возбуждаемые исключения должны быть такими же, как и для [`http_error_default()`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.BaseHandler.http_error_default).376377#### `BaseHandler.protocol_request(req)`378379Этот метод *не* определён в [`BaseHandler`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.BaseHandler), но подклассы должны определить его, если хотят предварительно обрабатывать запросы указанного протокола.380381Этот метод, если он определён, вызывается родительским [`OpenerDirector`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.OpenerDirector). *req* будет объектом [`Request`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.Request). Возвращаемое значение должно быть объектом [`Request`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.Request).382383#### `BaseHandler.protocol_response(req, response)`384385Этот метод *не* определён в [`BaseHandler`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.BaseHandler), но подклассы должны определить его, если хотят выполнять последующую обработку ответов указанного протокола.386387Этот метод, если он определён, вызывается родительским [`OpenerDirector`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.OpenerDirector). *req* будет объектом [`Request`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.Request). *response* будет объектом, реализующим тот же интерфейс, что и возвращаемое значение [`urlopen()`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.urlopen). Возвращаемое значение должно реализовывать тот же интерфейс, что и возвращаемое значение [`urlopen()`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.urlopen).388389## 20.5.4. Объекты HTTPRedirectHandler390391> **Примечание**392>393> Некоторые HTTP-перенаправления требуют действий со стороны клиентского кода этого модуля. Если это так, возбуждается `HTTPError`. Подробнее о точном значении различных кодов перенаправления см. [**RFC 2616**](https://python-all.ru/3.2/library/urllib.request.html).394>395> Исключение `HTTPError` возбуждается из соображений безопасности, если HTTPRedirectHandler получает перенаправленный URL, который не является HTTP, HTTPS или FTP URL.396397#### `HTTPRedirectHandler.redirect_request(req, fp, code, msg, hdrs, newurl)`398399Возвращает [`Request`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.Request) или `None` в ответ на перенаправление. Вызывается реализациями по умолчанию методов `http_error_30*()` при получении перенаправления от сервера. Если перенаправление должно произойти, возвращается новый [`Request`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.Request), чтобы `http_error_30*()` выполнил перенаправление на *newurl*. В противном случае возбуждается `HTTPError`, если никакой другой обработчик не должен обрабатывать этот URL, или возвращается `None`, если нет возможности обработать, но другой обработчик может.400401> **Примечание**402>403> Реализация этого метода по умолчанию не строго следует [**RFC 2616**](https://python-all.ru/3.2/library/urllib.request.html), в котором сказано, что ответы с кодами 301 и 302 на `POST` запросы не должны автоматически перенаправляться без подтверждения пользователем. На практике браузеры разрешают автоматическое перенаправление этих ответов, заменяя POST на `GET`, и реализация по умолчанию воспроизводит такое поведение.404405#### `HTTPRedirectHandler.http_error_301(req, fp, code, msg, hdrs)`406407Перенаправляет на URL из заголовков `Location:` или `URI:`. Этот метод вызывается родительским [`OpenerDirector`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.OpenerDirector) при получении HTTP-ответа «перемещён навсегда».408409#### `HTTPRedirectHandler.http_error_302(req, fp, code, msg, hdrs)`410411То же, что и [`http_error_301()`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.HTTPRedirectHandler.http_error_301), но вызывается для ответа «found».412413#### `HTTPRedirectHandler.http_error_303(req, fp, code, msg, hdrs)`414415То же, что и [`http_error_301()`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.HTTPRedirectHandler.http_error_301), но вызывается для ответа «see other».416417#### `HTTPRedirectHandler.http_error_307(req, fp, code, msg, hdrs)`418419То же, что и [`http_error_301()`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.HTTPRedirectHandler.http_error_301), но вызывается для ответа «temporary redirect».420421## 20.5.5. Объекты HTTPCookieProcessor422423Экземпляры [`HTTPCookieProcessor`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.HTTPCookieProcessor) имеют один атрибут:424425#### `HTTPCookieProcessor.cookiejar`426427Объект [`http.cookiejar.CookieJar`](https://python-all.ru/3.2/library/http.cookiejar.html#http.cookiejar.CookieJar), в котором хранятся куки.428429## 20.5.6. Объекты ProxyHandler430431#### `ProxyHandler.protocol_open(request)`432433Для каждого *протокола*, для которого в словаре *proxies*, переданном в конструктор, указан прокси, объект [`ProxyHandler`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.ProxyHandler) будет иметь метод `protocol_open()`. Этот метод изменяет запрос для направления через прокси, вызывая `request.set_proxy()`, и передаёт управление следующему обработчику в цепочке для фактического выполнения протокола.434435## 20.5.7. Объекты HTTPPasswordMgr436437Эти методы доступны для объектов [`HTTPPasswordMgr`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.HTTPPasswordMgr) и [`HTTPPasswordMgrWithDefaultRealm`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.HTTPPasswordMgrWithDefaultRealm).438439#### `HTTPPasswordMgr.add_password(realm, uri, user, passwd)`440441*uri* может быть как одним URI, так и последовательностью URI. *realm*, *user* и *passwd* должны быть строками. В результате `(user, passwd)` будет использоваться в качестве токенов аутентификации при запросе аутентификации для *realm* и супер-URI любого из указанных URI.442443#### `HTTPPasswordMgr.find_user_password(realm, authuri)`444445Возвращает пару пользователь/пароль для указанных realm и URI, если они есть. Если совпадений нет, этот метод вернёт `(None, None)`.446447Для объектов [`HTTPPasswordMgrWithDefaultRealm`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.HTTPPasswordMgrWithDefaultRealm), если для указанного *realm* нет подходящей пары пользователь/пароль, будет выполнен поиск по realm `None`.448449## 20.5.8. Объекты AbstractBasicAuthHandler450451#### `AbstractBasicAuthHandler.http_error_auth_reqed(authreq, host, req, headers)`452453Обрабатывает запрос аутентификации, получая пару пользователь/пароль и повторяя запрос. *authreq* должно быть именем заголовка, в котором содержится информация о realm, *host* указывает URL и путь для аутентификации, *req* должен быть (неудачным) объектом [`Request`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.Request), а *headers* – заголовками ошибки.454455*host* – это либо полномочное имя (например, `"python.org"`), либо URL, содержащий компонент полномочного имени (например, `"http://python.org/"`). В любом случае полномочное имя не должно содержать компонента userinfo (так что `"python.org"` и `"python.org:80"` допустимы, а `"joe:password@python.org"` – нет).456457## 20.5.9. Объекты HTTPBasicAuthHandler458459#### `HTTPBasicAuthHandler.http_error_401(req, fp, code, msg, hdrs)`460461Повторяет запрос с информацией аутентификации, если она доступна.462463## 20.5.10. Объекты ProxyBasicAuthHandler464465#### `ProxyBasicAuthHandler.http_error_407(req, fp, code, msg, hdrs)`466467Повторяет запрос с информацией аутентификации, если она доступна.468469## 20.5.11. Объекты AbstractDigestAuthHandler470471#### `AbstractDigestAuthHandler.http_error_auth_reqed(authreq, host, req, headers)`472473*authreq* должно быть именем заголовка, в котором содержится информация о realm, *host* должен быть хостом для аутентификации, *req* должен быть (неудачным) объектом [`Request`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.Request), а *headers* – заголовками ошибки.474475## 20.5.12. Объекты HTTPDigestAuthHandler476477#### `HTTPDigestAuthHandler.http_error_401(req, fp, code, msg, hdrs)`478479Повторяет запрос с информацией аутентификации, если она доступна.480481## 20.5.13. Объекты ProxyDigestAuthHandler482483#### `ProxyDigestAuthHandler.http_error_407(req, fp, code, msg, hdrs)`484485Повторяет запрос с информацией аутентификации, если она доступна.486487## 20.5.14. Объекты HTTPHandler488489#### `HTTPHandler.http_open(req)`490491Отправляет HTTP-запрос, который может быть GET или POST, в зависимости от `req.has_data()`.492493## 20.5.15. Объекты HTTPSHandler494495#### `HTTPSHandler.https_open(req)`496497Отправляет HTTPS-запрос, который может быть GET или POST, в зависимости от `req.has_data()`.498499## 20.5.16. Объекты FileHandler500501#### `FileHandler.file_open(req)`502503Открывает файл локально, если имя хоста отсутствует или равно `'localhost'`.504505Изменено в версии 3.2: Этот метод применим только для локальных имен хостов. Когда указано удаленное имя хоста, возбуждается `URLError`.506507## 20.5.17. Объекты FTPHandler508509#### `FTPHandler.ftp_open(req)`510511Открывает FTP-файл, указанный *req*. Вход всегда выполняется с пустыми именем пользователя и паролем.512513## 20.5.18. Объекты CacheFTPHandler514515Объекты [`CacheFTPHandler`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.CacheFTPHandler) являются объектами [`FTPHandler`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.FTPHandler) с дополнительными методами:516517#### `CacheFTPHandler.setTimeout(t)`518519Устанавливает тайм-аут соединений равным *t* секунд.520521#### `CacheFTPHandler.setMaxConns(m)`522523Устанавливает максимальное количество кэшированных соединений равным *m*.524525## 20.5.19. Объекты UnknownHandler526527#### `UnknownHandler.unknown_open()`528529Возбуждает исключение `URLError`.530531## 20.5.20. Объекты HTTPErrorProcessor532533#### `HTTPErrorProcessor.http_response()`534535Обрабатывает ошибочные HTTP-ответы.536537Для кода 200 объект ответа возвращается немедленно.538539Для кодов ошибок, отличных от 200, этот метод просто передает задачу методам-обработчикам `protocol_error_code()` через [`OpenerDirector.error()`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.OpenerDirector.error). В конечном итоге [`HTTPDefaultErrorHandler`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.HTTPDefaultErrorHandler) возбудит `HTTPError`, если ни один другой обработчик не обработает ошибку.540541#### `HTTPErrorProcessor.https_response()`542543Обрабатывает ошибочные HTTPS-ответы.544545Поведение такое же, как у [`http_response()`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.HTTPErrorProcessor.http_response).546547## 20.5.21. Примеры548549Этот пример получает главную страницу python.org и отображает первые 300 байт этой страницы.550551```python552>>> import urllib.request553>>> f = urllib.request.urlopen('http://www.python.org/')554>>> print(f.read(300))555b'<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"556"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">\n\n\n<html557xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">\n\n<head>\n558<meta http-equiv="content-type" content="text/html; charset=utf-8" />\n559<title>Python Programming '560```561562Обратите внимание, что urlopen возвращает объект bytes. Это связано с тем, что urlopen не может автоматически определить кодировку байтового потока, получаемого от HTTP-сервера. В общем случае программа декодирует возвращаемый объект bytes в строку после того, как определит или угадает подходящую кодировку.563564В следующем документе W3C, [http://www.w3.org/International/O-charset](https://python-all.ru/3.2/library/urllib.request.html), перечислены различные способы, которыми (X)HTML- или XML-документ мог указать информацию о своей кодировке.565566Поскольку на сайте python.org используется кодировка *utf-8*, указанная в его мета-теге, мы будем использовать ту же самую для декодирования объекта bytes.567568```python569>>> with urllib.request.urlopen('http://www.python.org/') as f:570...     print(f.read(100).decode('utf-8'))571...572<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"573"http://www.w3.org/TR/xhtml1/DTD/xhtm574```575576Тот же результат можно получить и без использования [*менеджера контекста*](https://python-all.ru/3.2/glossary.html#term-context-manager) подхода.577578```python579>>> import urllib.request580>>> f = urllib.request.urlopen('http://www.python.org/')581>>> print(f.read(100).decode('utf-8'))582<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"583"http://www.w3.org/TR/xhtml1/DTD/xhtm584```585586В следующем примере мы отправляем поток данных на стандартный ввод CGI и читаем данные, которые он возвращает. Обратите внимание: этот пример будет работать только в том случае, если установка Python поддерживает SSL.587588```python589>>> import urllib.request590>>> req = urllib.request.Request(url='https://localhost/cgi-bin/test.cgi',591...                       data=b'This data is passed to stdin of the CGI')592>>> f = urllib.request.urlopen(req)593>>> print(f.read().decode('utf-8'))594Got Data: "This data is passed to stdin of the CGI"595```596597Код образца CGI, использованного в приведённом выше примере:598599```python600#!/usr/bin/env python601import sys602data = sys.stdin.read()603print('Content-type: text-plain\n\nGot Data: "%s"' % data)604```605606Использование базовой HTTP-аутентификации:607608```python609import urllib.request610# Создать OpenerDirector с поддержкой базовой HTTP-аутентификации...611auth_handler = urllib.request.HTTPBasicAuthHandler()612auth_handler.add_password(realm='PDQ Application',613                          uri='https://mahler:8092/site-updates.py',614                          user='klem',615                          passwd='kadidd!ehopper')616opener = urllib.request.build_opener(auth_handler)617# ...и установить его глобально, чтобы его можно было использовать с urlopen.618urllib.request.install_opener(opener)619urllib.request.urlopen('http://www.example.com/login.html')620```621622[`build_opener()`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.build_opener) по умолчанию предоставляет множество обработчиков, включая [`ProxyHandler`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.ProxyHandler). По умолчанию [`ProxyHandler`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.ProxyHandler) использует переменные окружения с именами вида `<scheme>_proxy`, где `<scheme>` – это соответствующая схема URL. Например, переменная окружения `http_proxy` считывается для получения URL HTTP-прокси.623624В этом примере стандартный [`ProxyHandler`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.ProxyHandler) заменяется на тот, который использует программно задаваемые URL прокси, и добавляется поддержка авторизации прокси с помощью [`ProxyBasicAuthHandler`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.ProxyBasicAuthHandler).625626```python627proxy_handler = urllib.request.ProxyHandler({'http': 'http://www.example.com:3128/'})628proxy_auth_handler = urllib.request.ProxyBasicAuthHandler()629proxy_auth_handler.add_password('realm', 'host', 'username', 'password')630631opener = urllib.request.build_opener(proxy_handler, proxy_auth_handler)632# На этот раз, вместо установки OpenerDirector, используется напрямую:633opener.open('http://www.example.com/login.html')634```635636Добавление HTTP-заголовков:637638Используйте аргумент *headers* конструктора [`Request`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.Request) или:639640```python641import urllib.request642req = urllib.request.Request('http://www.example.com/')643req.add_header('Referer', 'http://www.python.org/')644r = urllib.request.urlopen(req)645```646647[`OpenerDirector`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.OpenerDirector) автоматически добавляет заголовок *User-Agent* к каждому [`Request`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.Request). Чтобы изменить это:648649```python650import urllib.request651opener = urllib.request.build_opener()652opener.addheaders = [('User-agent', 'Mozilla/5.0')]653opener.open('http://www.example.com/')654```655656Также следует помнить, что несколько стандартных заголовков (*Content-Length*, *Content-Type* без параметра charset и *Host*) добавляются, когда [`Request`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.Request) передаётся в [`urlopen()`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.urlopen) (или [`OpenerDirector.open()`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.OpenerDirector.open)).657658Ниже приведён пример сеанса, в котором используется метод `GET` для получения URL, содержащего параметры:659660```python661>>> import urllib.request662>>> import urllib.parse663>>> params = urllib.parse.urlencode({'spam': 1, 'eggs': 2, 'bacon': 0})664>>> f = urllib.request.urlopen("http://www.musi-cal.com/cgi-bin/query?%s" % params)665>>> print(f.read().decode('utf-8'))666```667668В следующем примере вместо этого используется метод `POST`. Обратите внимание, что вывод params из urlencode кодируется в байты перед отправкой в urlopen в качестве data:669670```python671>>> import urllib.request672>>> import urllib.parse673>>> data = urllib.parse.urlencode({'spam': 1, 'eggs': 2, 'bacon': 0})674>>> data = data.encode('utf-8')675>>> request = urllib.request.Request("http://requestb.in/xrbl82xr")676>>> # добавление параметра charset в заголовок Content‑Type.677>>> request.add_header("Content-Type","application/x-www-form-urlencoded;charset=utf-8")678>>> f = urllib.request.urlopen(request, data)679>>> print(f.read().decode('utf-8'))680```681682В следующем примере используется явно указанный HTTP-прокси, переопределяющий настройки окружения:683684```python685>>> import urllib.request686>>> proxies = {'http': 'http://proxy.example.com:8080/'}687>>> opener = urllib.request.FancyURLopener(proxies)688>>> f = opener.open("http://www.python.org")689>>> f.read().decode('utf-8')690```691692В следующем примере прокси не используются вовсе, переопределяя настройки окружения:693694```python695>>> import urllib.request696>>> opener = urllib.request.FancyURLopener({})697>>> f = opener.open("http://www.python.org/")698>>> f.read().decode('utf-8')699```700701## 20.5.22. Устаревший интерфейс702703Следующие функции и классы перенесены из модуля Python 2 `urllib` (в отличие от `urllib2`). В будущем они могут стать устаревшими.704705#### `urllib.request.urlretrieve(url, filename=None, reporthook=None, data=None)`706707Копирует сетевой объект, заданный URL, в локальный файл, если это необходимо. Если URL указывает на локальный файл или существует валидная кешированная копия объекта, объект не копируется. Возвращает кортеж `(filename, headers)`, где *filename* – это имя локального файла, в котором можно найти объект, а *headers* – то, что вернул метод `info()` объекта, возвращенного [`urlopen()`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.urlopen) (для удаленного объекта, возможно кешированного). Исключения те же, что и для [`urlopen()`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.urlopen).708709Второй аргумент, если он задан, указывает, в какой файл копировать данные (если отсутствует, данные будут записаны во временный файл с автоматически сгенерированным именем). Третий аргумент, если он задан, – это функция-обработчик, которая будет вызвана один раз при установке сетевого соединения и затем после каждого прочитанного блока. Функция будет получать три аргумента: количество переданных блоков, размер блока в байтах и общий размер файла. Третий аргумент может быть `-1` на старых FTP-серверах, которые не возвращают размер файла в ответ на запрос получения.710711Если *url* использует идентификатор схемы `http:`, необязательный аргумент *data* может быть передан для указания запроса `POST` (обычно тип запроса – `GET`). Аргумент *data* должен быть объектом bytes в стандартном формате *application/x-www-form-urlencoded*; см. функцию `urlencode()` ниже.712713[`urlretrieve()`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.urlretrieve) вызовет исключение `ContentTooShortError`, если обнаружит, что объём доступных данных меньше ожидаемого (то есть размера, указанного в заголовке *Content-Length*). Это может произойти, например, если загрузка была прервана.714715Заголовок *Content-Length* рассматривается как нижняя граница: если есть больше данных для чтения, [`urlretrieve()`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.urlretrieve) читает больше данных, но если доступно меньше данных, он возбуждает исключение.716717В этом случае загруженные данные всё ещё можно получить, они хранятся в атрибуте `content` экземпляра исключения.718719Если заголовок *Content-Length* не был предоставлен, [`urlretrieve()`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.urlretrieve) не может проверить размер загруженных данных и просто возвращает их. В этом случае приходится предполагать, что загрузка прошла успешно.720721#### `urllib.request.urlcleanup()`722723Очищает кеш, который мог накопиться при предыдущих вызовах [`urlretrieve()`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.urlretrieve).724725#### `class urllib.request.URLopener(proxies=None, **x509)`726727Базовый класс для открытия и чтения URL. Если не требуется поддержка открытия объектов с использованием схем, отличных от `http:`, `ftp:` или `file:`, вероятно, стоит использовать [`FancyURLopener`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.FancyURLopener).728729По умолчанию класс [`URLopener`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.URLopener) отправляет заголовок *User-Agent* со значением `urllib/VVV`, где *VVV* – это номер версии `urllib`. Приложения могут определить свой собственный заголовок *User-Agent*, создав подкласс [`URLopener`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.URLopener) или [`FancyURLopener`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.FancyURLopener) и установив атрибут класса [`version`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.URLopener.version) в соответствующее строковое значение в определении подкласса.730731Необязательный параметр *proxies* должен быть словарём, сопоставляющим имена схем с URL прокси, причём пустой словарь полностью отключает прокси. По умолчанию значение равно `None`; в этом случае будут использованы настройки прокси из окружения, если они присутствуют, как описано в определении [`urlopen()`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.urlopen) выше.732733Дополнительные именованные параметры, собранные в *x509*, могут использоваться для аутентификации клиента при использовании схемы `https:`. Поддерживаются ключи *key\_file* и *cert\_file* для предоставления SSL-ключа и сертификата; оба необходимы для поддержки аутентификации клиента.734735Объекты [`URLopener`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.URLopener) возбуждают исключение [`IOError`](https://python-all.ru/3.2/library/exceptions.html#IOError), если сервер возвращает код ошибки.736737> #### `open(fullurl, data=None)`738>739> Открывает *fullurl*, используя соответствующий протокол. Этот метод настраивает кеш и информацию о прокси, затем вызывает соответствующий метод open с его входными аргументами. Если схема не распознана, вызывается [`open_unknown()`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.URLopener.open_unknown). Аргумент *data* имеет тот же смысл, что и аргумент *data* функции [`urlopen()`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.urlopen).740>741> #### `open_unknown(fullurl, data=None)`742>743> Переопределяемый интерфейс для открытия неизвестных типов URL.744>745> #### `retrieve(url, filename=None, reporthook=None, data=None)`746>747> Извлекает содержимое *url* и помещает его в *filename*. Возвращаемое значение – это кортеж, состоящий из локального имени файла и либо объекта [`email.message.Message`](https://python-all.ru/3.2/library/email.message.html#email.message.Message), содержащего заголовки ответа (для удаленных URL), либо `None` (для локальных URL). Вызывающий код затем должен открыть и прочитать содержимое *filename*. Если *filename* не указан и URL ссылается на локальный файл, возвращается исходное имя файла. Если URL не локальный и *filename* не указан, имя файла – результат вызова [`tempfile.mktemp()`](https://python-all.ru/3.2/library/tempfile.html#tempfile.mktemp) с суффиксом, соответствующим суффиксу последнего компонента пути входного URL. Если указан *reporthook*, он должен быть функцией, принимающей три числовых параметра. Она будет вызываться после каждого чтения блока данных из сети. *reporthook* игнорируется для локальных URL.748>749> Если *url* использует идентификатор схемы `http:`, необязательный аргумент *data* может быть передан для указания запроса `POST` (обычно тип запроса – `GET`). Аргумент *data* должен быть в стандартном формате *application/x-www-form-urlencoded*; см. функцию `urlencode()` ниже.750>751> #### `version`752>753> Переменная, задающая пользовательский агент объекта opener. Чтобы заставить `urllib` сообщать серверам, что он использует определённый пользовательский агент, задайте эту переменную в подклассе как переменную класса или в конструкторе перед вызовом конструктора базового класса.754755#### `class urllib.request.FancyURLopener(...)`756757[`FancyURLopener`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.FancyURLopener) является подклассом [`URLopener`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.URLopener), предоставляющим стандартную обработку следующих кодов ответа HTTP: 301, 302, 303, 307 и 401. Для перечисленных выше кодов 30x заголовок *Location* используется для получения фактического URL. Для кода 401 (требуется аутентификация) выполняется базовая HTTP-аутентификация. Для кодов 30x рекурсия ограничена значением атрибута *maxtries*, по умолчанию равным 10.758759Для всех остальных кодов ответа вызывается метод `http_error_default()`, который можно переопределить в подклассах для соответствующей обработки ошибки.760761> **Примечание**762>763> В соответствии с буквой [**RFC 2616**](https://python-all.ru/3.2/library/urllib.request.html) ответы 301 и 302 на POST-запросы не должны автоматически перенаправляться без подтверждения пользователем. Однако на практике браузеры разрешают автоматическое перенаправление таких ответов, изменяя POST на GET, и `urllib` воспроизводит это поведение.764765Параметры конструктора такие же, как и для [`URLopener`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.URLopener).766767> **Примечание**768>769> При выполнении базовой аутентификации экземпляр [`FancyURLopener`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.FancyURLopener) вызывает свой метод [`prompt_user_passwd()`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.FancyURLopener.prompt_user_passwd). Реализация по умолчанию запрашивает у пользователя необходимые сведения на управляющем терминале. При необходимости подкласс может переопределить этот метод, чтобы обеспечить более подходящее поведение.770771Класс [`FancyURLopener`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.FancyURLopener) предоставляет один дополнительный метод, который следует переопределить для обеспечения соответствующего поведения:772773#### `prompt_user_passwd(host, realm)`774775Возвращает информацию, необходимую для аутентификации пользователя на указанном хосте в заданной области безопасности. Возвращаемое значение должно быть кортежем, `(user, password)`, который можно использовать для базовой аутентификации.776777Реализация запрашивает эту информацию на терминале; приложение должно переопределить этот метод, чтобы использовать подходящую модель взаимодействия в локальной среде.778779## 20.5.23. [`urllib.request`](https://python-all.ru/3.2/library/urllib.request.html#module-urllib.request) Ограничения780781>782783- В настоящее время поддерживаются только следующие протоколы: HTTP (версии 0.9 и 1.0), FTP и локальные файлы.784- Функция кэширования [`urlretrieve()`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.urlretrieve) отключена до тех пор, пока кто-нибудь не найдет время реализовать правильную обработку заголовков с временем истечения.785- Должна быть функция для проверки, находится ли определённый URL в кэше.786- Для обратной совместимости, если URL указывает на локальный файл, но файл не удаётся открыть, URL интерпретируется заново с использованием протокола FTP. Это иногда может приводить к запутанным сообщениям об ошибках.787- Функции [`urlopen()`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.urlopen) и [`urlretrieve()`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.urlretrieve) могут вызывать сколь угодно долгие задержки при ожидании установки сетевого соединения. Это означает, что создать интерактивный веб-клиент с помощью этих функций без использования потоков сложно.788- Данные, возвращаемые [`urlopen()`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.urlopen) или [`urlretrieve()`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.urlretrieve), представляют собой необработанные данные, возвращаемые сервером. Это могут быть бинарные данные (например, изображение), обычный текст или, скажем, HTML. Протокол HTTP предоставляет информацию о типе в заголовке ответа, которую можно узнать, посмотрев на заголовок *Content-Type*. Если возвращаемые данные являются HTML, можно использовать модуль [`html.parser`](https://python-all.ru/3.2/library/html.parser.html#module-html.parser) для его разбора.789- Код, работающий с протоколом FTP, не может различить файл и каталог. Это может привести к неожиданному поведению при попытке чтения URL, указывающего на недоступный файл. Если URL заканчивается на `/`, считается, что он ссылается на каталог, и обработка будет соответствующей. Но если попытка чтения файла приводит к ошибке 550 (означающей, что URL не найден или недоступен, часто по причинам прав доступа), то путь обрабатывается как каталог, чтобы учесть случай, когда в URL указан каталог, но завершающий `/` опущен. Это может привести к вводящим в заблуждение результатам при попытке получить файл, права на чтение которого делают его недоступным; код FTP попытается его прочитать, получит ошибку 550, а затем выполнит листинг каталога для недоступного файла. Если требуется тонкий контроль, рассмотрите возможность использования модуля [`ftplib`](https://python-all.ru/3.2/library/ftplib.html#module-ftplib), создания подкласса [`FancyURLopener`](https://python-all.ru/3.2/library/urllib.request.html#urllib.request.FancyURLopener) или изменения *\_urlopener* в соответствии с вашими потребностями.790791# 20.6. [`urllib.response`](https://python-all.ru/3.2/library/urllib.request.html#module-urllib.response) – Классы ответов, используемые urllib792793Модуль [`urllib.response`](https://python-all.ru/3.2/library/urllib.request.html#module-urllib.response) определяет функции и классы, которые задают минимальный файлоподобный интерфейс, включая `read()` и `readline()`. Типичный объект ответа – это экземпляр addinfourl, который определяет метод `info()`, возвращающий заголовки, и метод `geturl()`, возвращающий URL. Функции, определенные этим модулем, используются внутри модуля [`urllib.request`](https://python-all.ru/3.2/library/urllib.request.html#module-urllib.request).794