> **Источник:** https://python-all.ru/3.4/library/urllib.request.html
>
> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.

---

# 21.6. [`urllib.request`](https://python-all.ru/3.4/library/urllib.request.html#module-urllib.request) – расширяемая библиотека для открытия URL

Модуль [`urllib.request`](https://python-all.ru/3.4/library/urllib.request.html#module-urllib.request) определяет функции и классы, которые помогают открывать URL (в основном HTTP) в сложном мире – базовая и дайджест-аутентификация, перенаправления, куки и многое другое.

> **См. также**
>
> Для работы с HTTP на более высоком уровне рекомендуется [пакет Requests](https://python-all.ru/3.4/library/urllib.request.html).

Модуль [`urllib.request`](https://python-all.ru/3.4/library/urllib.request.html#module-urllib.request) определяет следующие функции:

#### `urllib.request.urlopen(url, data=None, [timeout, ]*, cafile=None, capath=None, cadefault=False, context=None)`

Открывает URL *url*, который может быть строкой или объектом [`Request`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.Request).

*data* должен быть объектом bytes, задающим дополнительные данные для отправки на сервер, или `None`, если такие данные не нужны. *data* также может быть итерируемым объектом, и в этом случае значение Content-Length должно быть указано в заголовках. В настоящее время только HTTP-запросы используют *data*; HTTP-запрос будет POST вместо GET, когда указан параметр *data*.

*data* должен быть буфером в стандартном формате *application/x-www-form-urlencoded*. Функция [`urllib.parse.urlencode()`](https://python-all.ru/3.4/library/urllib.parse.html#urllib.parse.urlencode) принимает отображение или последовательность кортежей из 2 элементов и возвращает строку ASCII-текста в этом формате. Перед использованием в качестве параметра *data* её следует закодировать в bytes.

Модуль urllib.request использует HTTP/1.1 и включает заголовок `Connection:close` в свои HTTP-запросы.

Необязательный параметр *timeout* задает таймаут в секундах для блокирующих операций, таких как попытка подключения (если не указан, используется глобальная настройка таймаута по умолчанию). Это на самом деле работает только для HTTP, HTTPS и FTP-соединений.

Если указан *context*, он должен быть экземпляром [`ssl.SSLContext`](https://python-all.ru/3.4/library/ssl.html#ssl.SSLContext), описывающим различные параметры SSL. Подробнее см. [`HTTPSConnection`](https://python-all.ru/3.4/library/http.client.html#http.client.HTTPSConnection).

Необязательные параметры *cafile* и *capath* задают набор доверенных сертификатов ЦС для HTTPS-запросов. *cafile* должен указывать на один файл, содержащий набор сертификатов ЦС, а *capath* – на каталог с файлами сертификатов с хешированными именами. Дополнительную информацию можно найти в [`ssl.SSLContext.load_verify_locations()`](https://python-all.ru/3.4/library/ssl.html#ssl.SSLContext.load_verify_locations).

Параметр *cadefault* игнорируется.

Эта функция всегда возвращает объект, который может работать как [*контекстный менеджер*](https://python-all.ru/3.4/glossary.html#term-context-manager) и имеет такие методы, как

- `geturl()` – возвращает URL полученного ресурса; часто используется для определения, было ли выполнено перенаправление
- `info()` – возвращает метаинформацию страницы, такую как заголовки, в виде экземпляра [`email.message_from_string()`](https://python-all.ru/3.4/library/email.parser.html#email.message_from_string) (см. [Краткий справочник по HTTP-заголовкам](https://python-all.ru/3.4/library/urllib.request.html))
- `getcode()` – возвращает HTTP-статус код ответа.

Для URL http и https эта функция возвращает немного изменённый объект [`http.client.HTTPResponse`](https://python-all.ru/3.4/library/http.client.html#http.client.HTTPResponse). В дополнение к трём новым методам выше, атрибут msg содержит ту же информацию, что и атрибут [`reason`](https://python-all.ru/3.4/library/http.client.html#http.client.HTTPResponse.reason) – фразу причины, возвращённую сервером, а не заголовки ответа, как указано в документации на [`HTTPResponse`](https://python-all.ru/3.4/library/http.client.html#http.client.HTTPResponse).

Для URL ftp, file, data и запросов, явно обрабатываемых устаревшими классами [`URLopener`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.URLopener) и [`FancyURLopener`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.FancyURLopener), эта функция возвращает объект `urllib.response.addinfourl`.

Вызывает [`URLError`](https://python-all.ru/3.4/library/urllib.error.html#urllib.error.URLError) при ошибках.

Обратите внимание, что может быть возвращён `None`, если ни один обработчик не обрабатывает запрос (хотя установленный по умолчанию глобальный [`OpenerDirector`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.OpenerDirector) использует [`UnknownHandler`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.UnknownHandler), чтобы гарантировать, что этого никогда не произойдёт).

Кроме того, если обнаружены настройки прокси (например, когда установлена переменная окружения `*_proxy`, такая как `http_proxy`), по умолчанию устанавливается [`ProxyHandler`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.ProxyHandler), который обеспечивает обработку запросов через прокси.

Устаревшая функция `urllib.urlopen` из Python 2.6 и более ранних версий была прекращена; [`urllib.request.urlopen()`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.urlopen) соответствует старой `urllib2.urlopen`. Обработка прокси, которая выполнялась путём передачи словаря в `urllib.urlopen`, может быть получена с помощью объектов [`ProxyHandler`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.ProxyHandler).

Изменено в версии 3.2: добавлены *cafile* и *capath*.

Изменено в версии 3.2: Виртуальные хосты HTTPS теперь поддерживаются, если это возможно (то есть если [`ssl.HAS_SNI`](https://python-all.ru/3.4/library/ssl.html#ssl.HAS_SNI) истинно).

Новое в версии 3.2: Параметр *data* может быть итерируемым объектом.

Изменено в версии 3.3: добавлен *cadefault*.

Изменено в версии 3.4.3: добавлен *context*.

#### `urllib.request.install_opener(opener)`

Устанавливает экземпляр [`OpenerDirector`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.OpenerDirector) в качестве глобального открывателя по умолчанию. Установка открывателя нужна только в том случае, если требуется, чтобы urlopen использовал именно этот открыватель; в противном случае просто вызывайте [`OpenerDirector.open()`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.OpenerDirector.open) вместо [`urlopen()`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.urlopen). Код не проверяет, является ли объект реальным [`OpenerDirector`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.OpenerDirector); подойдёт любой класс с подходящим интерфейсом.

#### `urllib.request.build_opener([handler, ...])`

Возвращает экземпляр [`OpenerDirector`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.OpenerDirector), который объединяет обработчики в заданном порядке. *handler* могут быть как экземплярами [`BaseHandler`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.BaseHandler), так и подклассами [`BaseHandler`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.BaseHandler) (в этом случае должна быть возможность вызвать конструктор без параметров). Экземпляры следующих классов будут помещены перед *handler*, если только *handler* не содержат их, их экземпляры или их подклассы: [`ProxyHandler`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.ProxyHandler) (если обнаружены настройки прокси), [`UnknownHandler`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.UnknownHandler), [`HTTPHandler`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.HTTPHandler), [`HTTPDefaultErrorHandler`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.HTTPDefaultErrorHandler), [`HTTPRedirectHandler`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.HTTPRedirectHandler), [`FTPHandler`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.FTPHandler), [`FileHandler`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.FileHandler), [`HTTPErrorProcessor`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.HTTPErrorProcessor).

Если установка Python имеет поддержку SSL (т.е. если можно импортировать модуль [`ssl`](https://python-all.ru/3.4/library/ssl.html#module-ssl)), будет также добавлен [`HTTPSHandler`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.HTTPSHandler).

Подкласс [`BaseHandler`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.BaseHandler) может также изменить свой атрибут `handler_order`, чтобы изменить свою позицию в списке обработчиков.

#### `urllib.request.pathname2url(path)`

Преобразует имя пути *path* из локального синтаксиса пути в форму, используемую в компоненте пути URL. Это не создаёт полный URL. Возвращаемое значение уже будет закодировано с помощью функции [`quote()`](https://python-all.ru/3.4/library/urllib.parse.html#urllib.parse.quote).

#### `urllib.request.url2pathname(path)`

Преобразует компонент пути *path* из процентно-кодированного URL в локальный синтаксис пути. Эта функция не принимает полный URL. Для декодирования *path* используется функция [`unquote()`](https://python-all.ru/3.4/library/urllib.parse.html#urllib.parse.unquote).

#### `urllib.request.getproxies()`

Эта вспомогательная функция возвращает словарь, сопоставляющий схему с URL прокси-сервера. Сначала она ищет переменные окружения вида `<scheme>_proxy` (без учёта регистра) для всех операционных систем, а если не находит, то обращается к системной конфигурации Mac OS X и реестру Windows.

> **Примечание**
>
> Если установлена переменная окружения `REQUEST_METHOD`, что обычно означает, что скрипт выполняется в CGI-среде, то переменная окружения `HTTP_PROXY` (в верхнем регистре `_PROXY`) будет игнорироваться. Это связано с тем, что клиент может подставить эту переменную через HTTP-заголовок «Proxy:». Если необходимо использовать HTTP-прокси в CGI-среде, следует явно использовать `ProxyHandler`.

Предоставляются следующие классы:

#### `class urllib.request.Request(url, data=None, headers={}, origin_req_host=None, unverifiable=False, method=None)`

Этот класс представляет абстракцию URL-запроса.

*url* должен быть строкой, содержащей корректный URL.

*data* должен быть объектом bytes, содержащим дополнительные данные для отправки на сервер, или `None`, если такие данные не нужны. В настоящее время только HTTP-запросы используют *data*; при передаче параметра *data* HTTP-запрос будет POST, а не GET. *data* должен быть буфером в стандартном формате *application/x-www-form-urlencoded*. Функция [`urllib.parse.urlencode()`](https://python-all.ru/3.4/library/urllib.parse.html#urllib.parse.urlencode) принимает отображение или последовательность кортежей из двух элементов и возвращает строку ASCII в этом формате. Её следует закодировать в bytes перед использованием в качестве параметра *data*.

*headers* должен быть словарём, и он будет обрабатываться так, как если бы для каждой пары ключ-значение была вызвана [`add_header()`](https://python-all.ru/3.4/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`](https://python-all.ru/3.4/library/urllib.html#module-urllib) – `"Python-urllib/2.6"` (в Python 2.6).

Пример использования заголовка `Content-Type` с аргументом *data* – отправка словаря вида `{"Content-Type": "application/x-www-form-urlencoded"}`.

Последние два аргумента представляют интерес только для корректной обработки сторонних HTTP-куки:

*origin\_req\_host* должен быть хостом запроса исходной транзакции, как определено в [**RFC 2965**](https://python-all.ru/3.4/library/urllib.request.html). По умолчанию `http.cookiejar.request_host(self)`. Это имя хоста или IP-адрес исходного запроса, инициированного пользователем. Например, если запрос предназначен для изображения в HTML-документе, здесь должен быть хост запроса страницы, содержащей изображение.

*unverifiable* должен указывать, является ли запрос непроверяемым (unverifiable), как определено в RFC 2965. По умолчанию `False`. Непроверяемый запрос – это запрос, URL которого пользователь не имел возможности подтвердить. Например, если запрос предназначен для изображения в HTML-документе, и у пользователя не было возможности подтвердить автоматическую загрузку изображения, это должно быть true.

*method* должен быть строкой, определяющей метод HTTP-запроса (например, `'HEAD'`). Если он указан, его значение сохраняется в атрибуте [`method`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.Request.method) и используется [`get_method()`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.Request.get_method). Подклассы могут указать метод по умолчанию, установив атрибут [`method`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.Request.method) в самом классе.

Изменено в версии 3.3: добавлен аргумент [`Request.method`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.Request.method) в класс Request.

Изменено в версии 3.4: Метод по умолчанию [`Request.method`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.Request.method) может быть указан на уровне класса.

#### `class urllib.request.OpenerDirector`

Класс [`OpenerDirector`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.OpenerDirector) открывает URL-адреса через цепочку обработчиков [`BaseHandler`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.BaseHandler). Он управляет объединением обработчиков в цепочку и восстановлением после ошибок.

#### `class urllib.request.BaseHandler`

Это базовый класс для всех зарегистрированных обработчиков – он отвечает только за простую механику регистрации.

#### `class urllib.request.HTTPDefaultErrorHandler`

Класс, определяющий обработчик по умолчанию для HTTP-ответов с ошибками; все ответы преобразуются в исключения [`HTTPError`](https://python-all.ru/3.4/library/urllib.error.html#urllib.error.HTTPError).

#### `class urllib.request.HTTPRedirectHandler`

Класс для обработки перенаправлений.

#### `class urllib.request.HTTPCookieProcessor(cookiejar=None)`

Класс для обработки HTTP-куки.

#### `class urllib.request.ProxyHandler(proxies=None)`

Заставляет запросы проходить через прокси. Если указан *proxies*, это должен быть словарь, сопоставляющий имена протоколов с URL-адресами прокси. По умолчанию список прокси читается из переменных окружения `<протокол>_proxy`. Если переменные окружения прокси не заданы, то в среде Windows настройки прокси берутся из раздела Internet Settings реестра, а в среде Mac OS X информация о прокси извлекается из OS X System Configuration Framework.

Чтобы отключить автоматически обнаруженный прокси, передайте пустой словарь.

> **Примечание**
>
> `HTTP_PROXY` будет игнорироваться, если установлена переменная `REQUEST_METHOD`; см. документацию по [`getproxies()`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.getproxies).

#### `class urllib.request.HTTPPasswordMgr`

Ведёт базу данных соответствий между `(realm, uri) -> и (user, password)`.

#### `class urllib.request.HTTPPasswordMgrWithDefaultRealm`

Ведёт базу данных соответствий между `(realm, uri) -> и (user, password)`. Область (realm) со значением `None` считается универсальной – она используется, если не подходит ни одна другая.

#### `class urllib.request.AbstractBasicAuthHandler(password_mgr=None)`

Это миксин-класс, помогающий с HTTP-аутентификацией как на удалённом хосте, так и на прокси. *password\_mgr*, если указан, должен быть совместим с [`HTTPPasswordMgr`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.HTTPPasswordMgr); информацию об интерфейсе, который необходимо поддерживать, см. в разделе [*HTTPPasswordMgr Objects*](https://python-all.ru/3.4/library/urllib.request.html#http-password-mgr).

#### `class urllib.request.HTTPBasicAuthHandler(password_mgr=None)`

Обрабатывает аутентификацию на удалённом хосте. *password\_mgr*, если указан, должен быть совместим с [`HTTPPasswordMgr`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.HTTPPasswordMgr); информацию об интерфейсе, который необходимо поддерживать, см. в разделе [*HTTPPasswordMgr Objects*](https://python-all.ru/3.4/library/urllib.request.html#http-password-mgr). HTTPBasicAuthHandler вызовет исключение [`ValueError`](https://python-all.ru/3.4/library/exceptions.html#ValueError) при неправильной схеме аутентификации.

#### `class urllib.request.ProxyBasicAuthHandler(password_mgr=None)`

Обрабатывает аутентификацию на прокси. *password\_mgr*, если указан, должен быть совместим с [`HTTPPasswordMgr`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.HTTPPasswordMgr); информацию об интерфейсе, который необходимо поддерживать, см. в разделе [*HTTPPasswordMgr Objects*](https://python-all.ru/3.4/library/urllib.request.html#http-password-mgr).

#### `class urllib.request.AbstractDigestAuthHandler(password_mgr=None)`

Это миксин-класс, который помогает с HTTP-аутентификацией как на удалённом хосте, так и на прокси. *password\_mgr*, если задан, должен быть совместим с [`HTTPPasswordMgr`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.HTTPPasswordMgr); информацию об интерфейсе, который должен поддерживаться, см. в разделе [*HTTPPasswordMgr Objects*](https://python-all.ru/3.4/library/urllib.request.html#http-password-mgr).

#### `class urllib.request.HTTPDigestAuthHandler(password_mgr=None)`

Обрабатывает аутентификацию с удалённым хостом. *password\_mgr*, если задан, должен быть совместим с [`HTTPPasswordMgr`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.HTTPPasswordMgr); информацию об интерфейсе, который должен поддерживаться, см. в разделе [*HTTPPasswordMgr Objects*](https://python-all.ru/3.4/library/urllib.request.html#http-password-mgr). Когда добавлены и обработчик дайджест-аутентификации, и обработчик базовой аутентификации, дайджест-аутентификация всегда выполняется первой. Если дайджест-аутентификация снова возвращает ответ 40x, он передаётся обработчику базовой аутентификации. Этот метод-обработчик возбуждает исключение [`ValueError`](https://python-all.ru/3.4/library/exceptions.html#ValueError) при получении схемы аутентификации, отличной от Digest или Basic.

Изменено в версии 3.3: Возбуждает [`ValueError`](https://python-all.ru/3.4/library/exceptions.html#ValueError) при неподдерживаемой схеме аутентификации.

#### `class urllib.request.ProxyDigestAuthHandler(password_mgr=None)`

Обрабатывает аутентификацию с прокси. *password\_mgr*, если задан, должен быть совместим с [`HTTPPasswordMgr`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.HTTPPasswordMgr); информацию об интерфейсе, который должен поддерживаться, см. в разделе [*HTTPPasswordMgr Objects*](https://python-all.ru/3.4/library/urllib.request.html#http-password-mgr).

#### `class urllib.request.HTTPHandler`

Класс для открытия HTTP-URL.

#### `class urllib.request.HTTPSHandler(debuglevel=0, context=None, check_hostname=None)`

Класс для открытия HTTPS-URL. *context* и *check\_hostname* имеют тот же смысл, что и в [`http.client.HTTPSConnection`](https://python-all.ru/3.4/library/http.client.html#http.client.HTTPSConnection).

Изменено в версии 3.2: Добавлены параметры *context* и *check\_hostname*.

#### `class urllib.request.FileHandler`

Открывает локальные файлы.

#### `class urllib.request.DataHandler`

Открывает data-URL.

Новое в версии 3.4.

#### `class urllib.request.FTPHandler`

Открывает FTP-URL.

#### `class urllib.request.CacheFTPHandler`

Открывает FTP-URL, сохраняя кеш открытых FTP-соединений для минимизации задержек.

#### `class urllib.request.UnknownHandler`

Универсальный класс для обработки неизвестных URL.

#### `class urllib.request.HTTPErrorProcessor`

Обрабатывает ошибочные HTTP-ответы.

## 21.6.1. Объекты запросов

Следующие методы описывают открытый интерфейс [`Request`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.Request), и все они могут быть переопределены в подклассах. Он также определяет несколько открытых атрибутов, которые могут использоваться клиентами для анализа разобранного запроса.

#### `Request.full_url`

Оригинальный URL, переданный конструктору.

Изменено в версии 3.4.

Request.full\_url – это свойство с сеттером, геттером и делитером. При получении [`full_url`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.Request.full_url) возвращается исходный URL запроса с фрагментом, если он присутствовал.

#### `Request.type`

Схема URI.

#### `Request.host`

Авторитетная часть URI, обычно хост, но может также содержать порт, отделённый двоеточием.

#### `Request.origin_req_host`

Исходный хост запроса, без порта.

#### `Request.selector`

Путь URI. Если [`Request`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.Request) использует прокси, то selector будет полным URL, который передаётся прокси.

#### `Request.data`

Тело запроса (entity body) или None, если не указано.

Изменено в версии 3.4: Изменение значения [`Request.data`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.Request.data) теперь удаляет заголовок “Content-Length”, если он был ранее установлен или вычислен.

#### `Request.unverifiable`

логическое значение, указывает, является ли запрос непроверяемым, как определено в RFC 2965.

#### `Request.method`

Метод HTTP-запроса для использования. По умолчанию его значение равно [`None`](https://python-all.ru/3.4/library/constants.html#None), что означает, что [`get_method()`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.Request.get_method) выполнит обычное вычисление используемого метода. Его значение может быть установлено (таким образом переопределяя вычисление по умолчанию в [`get_method()`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.Request.get_method)) либо путём предоставления значения по умолчанию на уровне класса в подклассе [`Request`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.Request), либо путём передачи значения в конструктор [`Request`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.Request) через аргумент *method*.

Новое в версии 3.3.

Изменено в версии 3.4: Теперь значение по умолчанию можно задавать в подклассах; ранее его можно было установить только через аргумент конструктора.

#### `Request.get_method()`

Возвращает строку, указывающую метод HTTP-запроса. Если [`Request.method`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.Request.method) не равен `None`, возвращает его значение; в противном случае возвращает `'GET'`, если [`Request.data`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.Request.data) равно `None`, или `'POST'` в противном случае. Это имеет смысл только для HTTP-запросов.

Изменено в версии 3.3: get\_method теперь проверяет значение [`Request.method`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.Request.method).

#### `Request.add_header(key, val)`

Добавляет ещё один заголовок к запросу. В настоящее время заголовки игнорируются всеми обработчиками, кроме HTTP-обработчиков, где они добавляются в список заголовков, отправляемых серверу. Обратите внимание, что не может быть более одного заголовка с одним и тем же именем, и последующие вызовы перезапишут предыдущие в случае совпадения *ключа*. В настоящее время это не приводит к потере функциональности HTTP, поскольку все заголовки, имеющие смысл при многократном использовании, имеют (специфичный для заголовка) способ достижения той же функциональности с помощью только одного заголовка.

#### `Request.add_unredirected_header(key, header)`

Добавляет заголовок, который не будет добавлен в перенаправленный запрос.

#### `Request.has_header(header)`

Возвращает, имеет ли экземпляр указанный заголовок (проверяет как обычные, так и неперенаправленные).

#### `Request.remove_header(header)`

Удаляет указанный заголовок из экземпляра запроса (как из обычных, так и из неперенаправленных заголовков).

Новое в версии 3.4.

#### `Request.get_full_url()`

Возвращает URL, переданный в конструктор.

Изменено в версии 3.4.

Возвращает [`Request.full_url`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.Request.full_url).

#### `Request.set_proxy(host, type)`

Подготавливает запрос, подключаясь к прокси-серверу. *host* и *type* заменят соответствующие значения экземпляра, а selector экземпляра будет содержать исходный URL, переданный в конструктор.

#### `Request.get_header(header_name, default=None)`

Возвращает значение указанного заголовка. Если заголовок отсутствует, возвращает значение по умолчанию.

#### `Request.header_items()`

Возвращает список кортежей (имя\_заголовка, значение\_заголовка) заголовков запроса.

Изменено в версии 3.4:Методы запроса add\_data, has\_data, get\_data, get\_type, get\_host, get\_selector, get\_origin\_req\_host и is\_unverifiable, которые были объявлены устаревшими начиная с версии 3.3, удалены.

## 21.6.2. Объекты OpenerDirector

[`OpenerDirector`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.OpenerDirector) имеет следующие методы:

#### `OpenerDirector.add_handler(handler)`

*handler* должен быть экземпляром [`BaseHandler`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.BaseHandler). Ищутся и добавляются в возможные цепочки следующие методы (обратите внимание, что ошибки HTTP являются особым случаем).

- `protocol_open()` – сигнал о том, что обработчик умеет открывать URL-адреса *протокол*.
- `http_error_type()` – сигнал о том, что обработчик умеет обрабатывать ошибки HTTP с кодом ошибки HTTP *type*.
- `protocol_error()` – сигнал о том, что обработчик умеет обрабатывать ошибки от протокола *протокол* (кроме `http`).
- `protocol_request()` – сигнал о том, что обработчик умеет предварительно обрабатывать запросы *протокол*.
- `protocol_response()` – сигнал о том, что обработчик умеет выполнять последующую обработку ответов *протокол*.

#### `OpenerDirector.open(url, data=None[, timeout])`

Открывает указанный *url* (может быть объектом запроса или строкой), необязательно передавая указанные *data*. Аргументы, возвращаемые значения и исключения такие же, как у [`urlopen()`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.urlopen) (которая просто вызывает метод [`open()`](https://python-all.ru/3.4/library/functions.html#open) у текущего установленного глобального [`OpenerDirector`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.OpenerDirector)). Необязательный параметр *timeout* задает тайм-аут в секундах для блокирующих операций, таких как попытка соединения (если не указан, используется глобальный тайм-аут по умолчанию). Тайм-аут работает только для соединений HTTP, HTTPS и FTP).

#### `OpenerDirector.error(proto, *args)`

Обрабатывает ошибку указанного протокола. Вызывает зарегистрированные обработчики ошибок для данного протокола с указанными аргументами (которые зависят от протокола). Протокол HTTP является особым случаем, использующим код ответа HTTP для определения конкретного обработчика ошибок; обратитесь к методам `http_error_*()` классов обработчиков.

Возвращаемые значения и исключения такие же, как у [`urlopen()`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.urlopen).

Объекты OpenerDirector открывают URL в три этапа:

Порядок вызова этих методов в каждом этапе определяется сортировкой экземпляров обработчиков.

1. У каждого обработчика, имеющего метод с именем вида `protocol_request()`, этот метод вызывается для предварительной обработки запроса.
2. Обработчики с методом вида `protocol_open()` вызываются для обработки запроса. Этот этап завершается, когда обработчик возвращает значение, отличное от [`None`](https://python-all.ru/3.4/library/constants.html#None) (т.е. ответ), или возбуждает исключение (обычно [`URLError`](https://python-all.ru/3.4/library/urllib.error.html#urllib.error.URLError)). Исключения могут распространяться.

   На самом деле описанный алгоритм сначала применяется к методам с именем `default_open()`. Если все такие методы возвращают [`None`](https://python-all.ru/3.4/library/constants.html#None), алгоритм повторяется для методов с именем вида `protocol_open()`. Если все такие методы возвращают [`None`](https://python-all.ru/3.4/library/constants.html#None), алгоритм повторяется для методов с именем `unknown_open()`.

   Обратите внимание, что реализация этих методов может включать вызовы методов [`open()`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.OpenerDirector.open) и [`error()`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.OpenerDirector.error) родительского экземпляра [`OpenerDirector`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.OpenerDirector).
3. У каждого обработчика, имеющего метод с именем вида `protocol_response()`, этот метод вызывается для последующей обработки ответа.

## 21.6.3. Объекты BaseHandler

Объекты [`BaseHandler`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.BaseHandler) предоставляют несколько методов, которые полезны непосредственно, и другие, предназначенные для использования производными классами. Следующие предназначены для прямого использования:

#### `BaseHandler.add_parent(director)`

Добавляет директор в качестве родителя.

#### `BaseHandler.close()`

Удаляет всех родителей.

Следующий атрибут и методы должны использоваться только классами, производными от [`BaseHandler`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.BaseHandler).

> **Примечание**
>
> Принято соглашение: подклассы, определяющие методы `protocol_request()` или `protocol_response()`, называются `*Processor`; все остальные называются `*Handler`.

#### `BaseHandler.parent`

Действительный объект [`OpenerDirector`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.OpenerDirector), который можно использовать для открытия с помощью другого протокола или для обработки ошибок.

#### `BaseHandler.default_open(req)`

Этот метод *не* определён в [`BaseHandler`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.BaseHandler), но подклассы должны определить его, если хотят перехватывать все URL.

Этот метод, если он реализован, вызывается родительским [`OpenerDirector`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.OpenerDirector). Он должен возвращать файлоподобный объект, как описано в возвращаемом значении метода [`open()`](https://python-all.ru/3.4/library/functions.html#open) объекта [`OpenerDirector`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.OpenerDirector), или `None`. Он должен возбуждать [`URLError`](https://python-all.ru/3.4/library/urllib.error.html#urllib.error.URLError), если только не происходит поистине исключительная ситуация (например, [`MemoryError`](https://python-all.ru/3.4/library/exceptions.html#MemoryError) не должен отображаться на `URLError`).

Этот метод будет вызван перед любым методом открытия, специфичным для протокола.

#### `BaseHandler.protocol_open(req)`

Этот метод *не* определён в [`BaseHandler`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.BaseHandler), но подклассы должны определить его, если хотят обрабатывать URL с указанным протоколом.

Этот метод, если он определён, вызывается родительским [`OpenerDirector`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.OpenerDirector). Возвращаемые значения должны быть такими же, как и для [`default_open()`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.BaseHandler.default_open).

#### `BaseHandler.unknown_open(req)`

Этот метод *не* определён в [`BaseHandler`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.BaseHandler), но подклассы должны определить его, если хотят перехватывать все URL, для открытия которых нет зарегистрированного конкретного обработчика.

Этот метод, если он реализован, вызывается родительским [`родительский`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.BaseHandler.parent) [`OpenerDirector`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.OpenerDirector). Возвращаемые значения должны быть такими же, как и для [`default_open()`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.BaseHandler.default_open).

#### `BaseHandler.http_error_default(req, fp, code, msg, hdrs)`

Этот метод *не* определён в [`BaseHandler`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.BaseHandler), но подклассы должны переопределить его, если намерены предоставить универсальный обработчик для всех прочих необработанных HTTP-ошибок. Он будет автоматически вызван [`OpenerDirector`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.OpenerDirector) при получении ошибки и обычно не должен вызываться в других обстоятельствах.

*req* будет объектом [`Request`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.Request), *fp* – файлоподобным объектом с телом HTTP-ошибки, *code* – трёхзначным кодом ошибки, *msg* – понятным пользователю пояснением кода, а *hdrs* – объектом-отображением с заголовками ошибки.

Возвращаемые значения и возбуждаемые исключения должны быть такими же, как у [`urlopen()`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.urlopen).

#### `BaseHandler.http_error_nnn(req, fp, code, msg, hdrs)`

*nnn* должен быть трёхзначным кодом HTTP-ошибки. Этот метод также не определён в [`BaseHandler`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.BaseHandler), но будет вызван, если он существует, на экземпляре подкласса при возникновении HTTP-ошибки с кодом *nnn*.

Подклассы должны переопределить этот метод для обработки конкретных HTTP-ошибок.

Аргументы, возвращаемые значения и возбуждаемые исключения должны быть такими же, как и для [`http_error_default()`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.BaseHandler.http_error_default).

#### `BaseHandler.protocol_request(req)`

Этот метод *не* определён в [`BaseHandler`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.BaseHandler), но подклассы должны определить его, если хотят предварительно обрабатывать запросы указанного протокола.

Этот метод, если он определён, вызывается родительским [`OpenerDirector`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.OpenerDirector). *req* будет объектом [`Request`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.Request). Возвращаемое значение должно быть объектом [`Request`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.Request).

#### `BaseHandler.protocol_response(req, response)`

Этот метод *не* определён в [`BaseHandler`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.BaseHandler), но подклассы должны определить его, если хотят выполнять последующую обработку ответов указанного протокола.

Этот метод, если он определён, вызывается родительским [`OpenerDirector`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.OpenerDirector). *req* будет объектом [`Request`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.Request). *response* будет объектом, реализующим тот же интерфейс, что и возвращаемое значение [`urlopen()`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.urlopen). Возвращаемое значение должно реализовывать тот же интерфейс, что и возвращаемое значение [`urlopen()`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.urlopen).

## 21.6.4. Объекты HTTPRedirectHandler

> **Примечание**
>
> Некоторые HTTP-перенаправления требуют действий от клиентского кода этого модуля. В таком случае возбуждается [`HTTPError`](https://python-all.ru/3.4/library/urllib.error.html#urllib.error.HTTPError). См. [**RFC 2616**](https://python-all.ru/3.4/library/urllib.request.html) для получения подробной информации о точном значении различных кодов перенаправления.
>
> Исключение `HTTPError` возбуждается из соображений безопасности, если HTTPRedirectHandler получает перенаправленный URL, который не является HTTP, HTTPS или FTP URL.

#### `HTTPRedirectHandler.redirect_request(req, fp, code, msg, hdrs, newurl)`

Возвращает [`Request`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.Request) или `None` в ответ на перенаправление. Этот метод вызывается реализациями по умолчанию методов `http_error_30*()`, когда от сервера получено перенаправление. Если необходимо выполнить перенаправление, верните новый [`Request`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.Request), чтобы дать возможность `http_error_30*()` выполнить перенаправление на *newurl*. В противном случае возбудите [`HTTPError`](https://python-all.ru/3.4/library/urllib.error.html#urllib.error.HTTPError), если ни один другой обработчик не должен пытаться обработать этот URL, или верните `None`, если вы не можете этого сделать, но другой обработчик может.

> **Примечание**
>
> Реализация этого метода по умолчанию не строго следует [**RFC 2616**](https://python-all.ru/3.4/library/urllib.request.html), в котором сказано, что ответы с кодами 301 и 302 на `POST` запросы не должны автоматически перенаправляться без подтверждения пользователем. На практике браузеры разрешают автоматическое перенаправление этих ответов, заменяя POST на `GET`, и реализация по умолчанию воспроизводит такое поведение.

#### `HTTPRedirectHandler.http_error_301(req, fp, code, msg, hdrs)`

Перенаправляет на URL из заголовков `Location:` или `URI:`. Этот метод вызывается родительским [`OpenerDirector`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.OpenerDirector) при получении HTTP-ответа «перемещён навсегда».

#### `HTTPRedirectHandler.http_error_302(req, fp, code, msg, hdrs)`

То же, что и [`http_error_301()`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.HTTPRedirectHandler.http_error_301), но вызывается для ответа «found».

#### `HTTPRedirectHandler.http_error_303(req, fp, code, msg, hdrs)`

То же, что и [`http_error_301()`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.HTTPRedirectHandler.http_error_301), но вызывается для ответа «see other».

#### `HTTPRedirectHandler.http_error_307(req, fp, code, msg, hdrs)`

То же, что и [`http_error_301()`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.HTTPRedirectHandler.http_error_301), но вызывается для ответа «temporary redirect».

## 21.6.5. Объекты HTTPCookieProcessor

Экземпляры [`HTTPCookieProcessor`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.HTTPCookieProcessor) имеют один атрибут:

#### `HTTPCookieProcessor.cookiejar`

Объект [`http.cookiejar.CookieJar`](https://python-all.ru/3.4/library/http.cookiejar.html#http.cookiejar.CookieJar), в котором хранятся куки.

## 21.6.6. Объекты ProxyHandler

#### `ProxyHandler.protocol_open(request)`

Для каждого *протокола*, для которого в словаре *proxies*, переданном в конструктор, указан прокси, объект [`ProxyHandler`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.ProxyHandler) будет иметь метод `protocol_open()`. Этот метод изменяет запрос для направления через прокси, вызывая `request.set_proxy()`, и передаёт управление следующему обработчику в цепочке для фактического выполнения протокола.

## 21.6.7. Объекты HTTPPasswordMgr

Эти методы доступны для объектов [`HTTPPasswordMgr`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.HTTPPasswordMgr) и [`HTTPPasswordMgrWithDefaultRealm`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.HTTPPasswordMgrWithDefaultRealm).

#### `HTTPPasswordMgr.add_password(realm, uri, user, passwd)`

*uri* может быть как одним URI, так и последовательностью URI. *realm*, *user* и *passwd* должны быть строками. В результате `(user, passwd)` будет использоваться в качестве токенов аутентификации при запросе аутентификации для *realm* и супер-URI любого из указанных URI.

#### `HTTPPasswordMgr.find_user_password(realm, authuri)`

Возвращает пару пользователь/пароль для указанных realm и URI, если они есть. Если совпадений нет, этот метод вернёт `(None, None)`.

Для объектов [`HTTPPasswordMgrWithDefaultRealm`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.HTTPPasswordMgrWithDefaultRealm), если для указанного *realm* нет подходящей пары пользователь/пароль, будет выполнен поиск по realm `None`.

## 21.6.8. Объекты AbstractBasicAuthHandler

#### `AbstractBasicAuthHandler.http_error_auth_reqed(authreq, host, req, headers)`

Обрабатывает запрос аутентификации, получая пару пользователь/пароль и повторяя запрос. *authreq* должно быть именем заголовка, в котором содержится информация о realm, *host* указывает URL и путь для аутентификации, *req* должен быть (неудачным) объектом [`Request`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.Request), а *headers* – заголовками ошибки.

*host* – это либо полномочное имя (например, `"python.org"`), либо URL, содержащий компонент полномочного имени (например, `"http://python.org/"`). В любом случае полномочное имя не должно содержать компонента userinfo (так что `"python.org"` и `"python.org:80"` допустимы, а `"joe:password@python.org"` – нет).

## 21.6.9. Объекты HTTPBasicAuthHandler

#### `HTTPBasicAuthHandler.http_error_401(req, fp, code, msg, hdrs)`

Повторяет запрос с информацией аутентификации, если она доступна.

## 21.6.10. Объекты ProxyBasicAuthHandler

#### `ProxyBasicAuthHandler.http_error_407(req, fp, code, msg, hdrs)`

Повторяет запрос с информацией аутентификации, если она доступна.

## 21.6.11. Объекты AbstractDigestAuthHandler

#### `AbstractDigestAuthHandler.http_error_auth_reqed(authreq, host, req, headers)`

*authreq* должно быть именем заголовка, в котором содержится информация о realm, *host* должен быть хостом для аутентификации, *req* должен быть (неудачным) объектом [`Request`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.Request), а *headers* – заголовками ошибки.

## 21.6.12. Объекты HTTPDigestAuthHandler

#### `HTTPDigestAuthHandler.http_error_401(req, fp, code, msg, hdrs)`

Повторяет запрос с информацией аутентификации, если она доступна.

## 21.6.13. Объекты ProxyDigestAuthHandler

#### `ProxyDigestAuthHandler.http_error_407(req, fp, code, msg, hdrs)`

Повторяет запрос с информацией аутентификации, если она доступна.

## 21.6.14. Объекты HTTPHandler

#### `HTTPHandler.http_open(req)`

Отправляет HTTP-запрос, который может быть GET или POST, в зависимости от `req.has_data()`.

## 21.6.15. Объекты HTTPSHandler

#### `HTTPSHandler.https_open(req)`

Отправляет HTTPS-запрос, который может быть GET или POST, в зависимости от `req.has_data()`.

## 21.6.16. Объекты FileHandler

#### `FileHandler.file_open(req)`

Открывает файл локально, если имя хоста отсутствует или равно `'localhost'`.

Изменено в версии 3.2: Этот метод применим только к локальным именам хостов. При указании удалённого имени хоста возникает исключение [`URLError`](https://python-all.ru/3.4/library/urllib.error.html#urllib.error.URLError).

## 21.6.17. Объекты DataHandler

#### `DataHandler.data_open(req)`

Читает data URL. URL такого типа содержит содержимое, закодированное непосредственно в самом URL. Синтаксис data URL описан в [**RFC 2397**](https://python-all.ru/3.4/library/urllib.request.html). Реализация игнорирует пробелы в base64-кодированных data URL, поэтому URL может быть перенесён в любом исходном файле. Но даже если некоторые браузеры не обращают внимания на отсутствие дополнения (padding) в конце base64-кодированного data URL, данная реализация в таком случае вызовет исключение [`ValueError`](https://python-all.ru/3.4/library/exceptions.html#ValueError).

## 21.6.18. Объекты FTPHandler

#### `FTPHandler.ftp_open(req)`

Открывает FTP-файл, указанный *req*. Вход всегда выполняется с пустыми именем пользователя и паролем.

## 21.6.19. Объекты CacheFTPHandler

Объекты [`CacheFTPHandler`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.CacheFTPHandler) являются объектами [`FTPHandler`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.FTPHandler) с дополнительными методами:

#### `CacheFTPHandler.setTimeout(t)`

Устанавливает тайм-аут соединений равным *t* секунд.

#### `CacheFTPHandler.setMaxConns(m)`

Устанавливает максимальное количество кэшированных соединений равным *m*.

## 21.6.20. Объекты UnknownHandler

#### `UnknownHandler.unknown_open()`

Вызывает исключение [`URLError`](https://python-all.ru/3.4/library/urllib.error.html#urllib.error.URLError).

## 21.6.21. Объекты HTTPErrorProcessor

#### `HTTPErrorProcessor.http_response()`

Обрабатывает ошибочные HTTP-ответы.

Для кода 200 объект ответа возвращается немедленно.

Для кодов ошибок, отличных от 200, он просто передаёт задачу методам-обработчикам `protocol_error_code()` через [`OpenerDirector.error()`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.OpenerDirector.error). В конечном итоге [`HTTPDefaultErrorHandler`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.HTTPDefaultErrorHandler) вызовет исключение [`HTTPError`](https://python-all.ru/3.4/library/urllib.error.html#urllib.error.HTTPError), если ни один другой обработчик не обработает ошибку.

#### `HTTPErrorProcessor.https_response()`

Обрабатывает ошибочные HTTPS-ответы.

Поведение такое же, как у [`http_response()`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.HTTPErrorProcessor.http_response).

## 21.6.22. Примеры

Этот пример получает главную страницу python.org и отображает первые 300 байт этой страницы.

```python
>>> import urllib.request
>>> with urllib.request.urlopen('http://www.python.org/') as f:
...     print(f.read(300))
...
b'<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">\n\n\n<html
xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">\n\n<head>\n
<meta http-equiv="content-type" content="text/html; charset=utf-8" />\n
<title>Python Programming '
```

Обратите внимание, что urlopen возвращает объект bytes. Это связано с тем, что urlopen не может автоматически определить кодировку байтового потока, получаемого от HTTP-сервера. В общем случае программа декодирует возвращаемый объект bytes в строку после того, как определит или угадает подходящую кодировку.

Следующий документ W3C, [http://www.w3.org/International/O-charset](https://python-all.ru/3.4/library/urllib.request.html), перечисляет различные способы, которыми (X)HTML- или XML-документ может указывать информацию о своей кодировке.

Поскольку веб-сайт python.org использует кодировку *utf-8*, как указано в его метатеге, мы будем использовать ту же кодировку для декодирования объекта bytes.

```python
>>> with urllib.request.urlopen('http://www.python.org/') as f:
...     print(f.read(100).decode('utf-8'))
...
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtm
```

Тот же результат можно получить и без использования [*менеджера контекста*](https://python-all.ru/3.4/glossary.html#term-context-manager) подхода.

```python
>>> import urllib.request
>>> f = urllib.request.urlopen('http://www.python.org/')
>>> print(f.read(100).decode('utf-8'))
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtm
```

В следующем примере мы отправляем поток данных на стандартный ввод CGI и читаем данные, которые он возвращает. Обратите внимание: этот пример будет работать только в том случае, если установка Python поддерживает SSL.

```python
>>> import urllib.request
>>> req = urllib.request.Request(url='https://localhost/cgi-bin/test.cgi',
...                       data=b'This data is passed to stdin of the CGI')
>>> with urllib.request.urlopen(req) as f:
...     print(f.read().decode('utf-8'))
...
Got Data: "This data is passed to stdin of the CGI"
```

Код образца CGI, использованного в приведённом выше примере:

```python
#!/usr/bin/env python
import sys
data = sys.stdin.read()
print('Content-type: text/plain\n\nGot Data: "%s"' % data)
```

Вот пример выполнения запроса `PUT` с использованием [`Request`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.Request):

```python
import urllib.request
DATA=b'some data'
req = urllib.request.Request(url='http://localhost:8080', data=DATA,method='PUT')
with urllib.request.urlopen(req) as f:
    pass
print(f.status)
print(f.reason)
```

Использование базовой HTTP-аутентификации:

```python
import urllib.request
# Создать OpenerDirector с поддержкой базовой HTTP-аутентификации...
auth_handler = urllib.request.HTTPBasicAuthHandler()
auth_handler.add_password(realm='PDQ Application',
                          uri='https://mahler:8092/site-updates.py',
                          user='klem',
                          passwd='kadidd!ehopper')
opener = urllib.request.build_opener(auth_handler)
# ...и установить его глобально, чтобы его можно было использовать с urlopen.
urllib.request.install_opener(opener)
urllib.request.urlopen('http://www.example.com/login.html')
```

[`build_opener()`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.build_opener) по умолчанию предоставляет множество обработчиков, включая [`ProxyHandler`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.ProxyHandler). По умолчанию [`ProxyHandler`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.ProxyHandler) использует переменные окружения с именами вида `<scheme>_proxy`, где `<scheme>` – это соответствующая схема URL. Например, переменная окружения `http_proxy` считывается для получения URL HTTP-прокси.

В этом примере стандартный [`ProxyHandler`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.ProxyHandler) заменяется на тот, который использует программно задаваемые URL прокси, и добавляется поддержка авторизации прокси с помощью [`ProxyBasicAuthHandler`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.ProxyBasicAuthHandler).

```python
proxy_handler = urllib.request.ProxyHandler({'http': 'http://www.example.com:3128/'})
proxy_auth_handler = urllib.request.ProxyBasicAuthHandler()
proxy_auth_handler.add_password('realm', 'host', 'username', 'password')

opener = urllib.request.build_opener(proxy_handler, proxy_auth_handler)
# На этот раз, вместо установки OpenerDirector, используется напрямую:
opener.open('http://www.example.com/login.html')
```

Добавление HTTP-заголовков:

Используйте аргумент *headers* конструктора [`Request`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.Request) или:

```python
import urllib.request
req = urllib.request.Request('http://www.example.com/')
req.add_header('Referer', 'http://www.python.org/')
r = urllib.request.urlopen(req)
```

[`OpenerDirector`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.OpenerDirector) автоматически добавляет заголовок *User-Agent* к каждому [`Request`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.Request). Чтобы изменить это:

```python
import urllib.request
opener = urllib.request.build_opener()
opener.addheaders = [('User-agent', 'Mozilla/5.0')]
opener.open('http://www.example.com/')
```

Кроме того, следует помнить, что некоторые стандартные заголовки (*Content-Length*, *Content-Type* и *Host*) добавляются, когда [`Request`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.Request) передаётся в [`urlopen()`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.urlopen) (или [`OpenerDirector.open()`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.OpenerDirector.open)).

Ниже приведён пример сеанса, в котором используется метод `GET` для получения URL, содержащего параметры:

```python
>>> import urllib.request
>>> import urllib.parse
>>> params = urllib.parse.urlencode({'spam': 1, 'eggs': 2, 'bacon': 0})
>>> url = "http://www.musi-cal.com/cgi-bin/query?%s" % params
>>> with urllib.request.urlopen(url) as f:
...     print(f.read().decode('utf-8'))
...
```

В следующем примере вместо этого используется метод `POST`. Обратите внимание, что вывод params из urlencode кодируется в байты перед отправкой в urlopen в качестве data:

```python
>>> import urllib.request
>>> import urllib.parse
>>> data = urllib.parse.urlencode({'spam': 1, 'eggs': 2, 'bacon': 0})
>>> data = data.encode('ascii')
>>> with urllib.request.urlopen("http://requestb.in/xrbl82xr", data) as f:
...     print(f.read().decode('utf-8'))
...
```

В следующем примере используется явно указанный HTTP-прокси, переопределяющий настройки окружения:

```python
>>> import urllib.request
>>> proxies = {'http': 'http://proxy.example.com:8080/'}
>>> opener = urllib.request.FancyURLopener(proxies)
>>> with opener.open("http://www.python.org") as f:
...     f.read().decode('utf-8')
...
```

В следующем примере прокси не используются вовсе, переопределяя настройки окружения:

```python
>>> import urllib.request
>>> opener = urllib.request.FancyURLopener({})
>>> with opener.open("http://www.python.org/") as f:
...     f.read().decode('utf-8')
...
```

## 21.6.23. Устаревший интерфейс

Следующие функции и классы перенесены из модуля Python 2 `urllib` (в отличие от `urllib2`). В будущем они могут стать устаревшими.

#### `urllib.request.urlretrieve(url, filename=None, reporthook=None, data=None)`

Копирует сетевой объект, заданный URL, в локальный файл. Если URL указывает на локальный файл, объект не будет скопирован, если не указан filename. Возвращает кортеж `(filename, headers)`, где *filename* – это имя локального файла, в котором находится объект, а *headers* – это то, что вернул метод `info()` объекта, возвращённого [`urlopen()`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.urlopen) (для удалённого объекта). Исключения те же, что и для [`urlopen()`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.urlopen).

Второй аргумент, если он задан, указывает, в какой файл копировать данные (если отсутствует, данные будут записаны во временный файл с автоматически сгенерированным именем). Третий аргумент, если он задан, – это функция-обработчик, которая будет вызвана один раз при установке сетевого соединения и затем после каждого прочитанного блока. Функция будет получать три аргумента: количество переданных блоков, размер блока в байтах и общий размер файла. Третий аргумент может быть `-1` на старых FTP-серверах, которые не возвращают размер файла в ответ на запрос получения.

Следующий пример иллюстрирует наиболее распространённый сценарий использования:

```python
>>> import urllib.request
>>> local_filename, headers = urllib.request.urlretrieve('http://python.org/')
>>> html = open(local_filename)
>>> html.close()
```

Если в *url* используется идентификатор схемы `http:`, необязательный аргумент *data* может быть задан для указания запроса `POST` (обычно тип запроса – `GET`). Аргумент *data* должен быть объектом bytes в стандартном формате *application/x-www-form-urlencoded*; см. функцию [`urllib.parse.urlencode()`](https://python-all.ru/3.4/library/urllib.parse.html#urllib.parse.urlencode).

[`urlretrieve()`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.urlretrieve) вызовет исключение `ContentTooShortError`, если обнаружит, что объём доступных данных меньше ожидаемого (то есть размера, указанного в заголовке *Content-Length*). Это может произойти, например, если загрузка была прервана.

Заголовок *Content-Length* рассматривается как нижняя граница: если доступно больше данных для чтения, urlretrieve читает больше данных, но если данных меньше, он вызывает исключение.

В этом случае загруженные данные всё ещё можно получить, они хранятся в атрибуте `content` экземпляра исключения.

Если заголовок *Content-Length* не был передан, urlretrieve не может проверить размер загруженных данных и просто возвращает их. В этом случае остаётся только предполагать, что загрузка прошла успешно.

#### `urllib.request.urlcleanup()`

Удаляет временные файлы, которые могли остаться после предыдущих вызовов [`urlretrieve()`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.urlretrieve).

#### `class urllib.request.URLopener(proxies=None, **x509)`

Устарело с версии 3.3.

Базовый класс для открытия и чтения URL. Если не требуется поддержка открытия объектов с использованием схем, отличных от `http:`, `ftp:` или `file:`, вероятно, стоит использовать [`FancyURLopener`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.FancyURLopener).

По умолчанию класс [`URLopener`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.URLopener) отправляет заголовок *User-Agent* со значением `urllib/VVV`, где *VVV* – это номер версии [`urllib`](https://python-all.ru/3.4/library/urllib.html#module-urllib). Приложения могут определить собственный заголовок *User-Agent*, создав подкласс [`URLopener`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.URLopener) или [`FancyURLopener`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.FancyURLopener) и установив атрибут класса [`version`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.URLopener.version) в соответствующее строковое значение в определении подкласса.

Необязательный параметр *proxies* должен быть словарём, сопоставляющим имена схем с URL прокси, причём пустой словарь полностью отключает прокси. По умолчанию значение равно `None`; в этом случае будут использованы настройки прокси из окружения, если они присутствуют, как описано в определении [`urlopen()`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.urlopen) выше.

Дополнительные именованные параметры, собранные в *x509*, могут использоваться для аутентификации клиента при использовании схемы `https:`. Поддерживаются ключи *key\_file* и *cert\_file* для предоставления SSL-ключа и сертификата; оба необходимы для поддержки аутентификации клиента.

Объекты [`URLopener`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.URLopener) вызывают исключение [`OSError`](https://python-all.ru/3.4/library/exceptions.html#OSError), если сервер возвращает код ошибки.

> #### `open(fullurl, data=None)`
>
> Открывает *fullurl*, используя соответствующий протокол. Этот метод настраивает кеш и информацию о прокси, затем вызывает соответствующий метод open с его входными аргументами. Если схема не распознана, вызывается [`open_unknown()`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.URLopener.open_unknown). Аргумент *data* имеет тот же смысл, что и аргумент *data* функции [`urlopen()`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.urlopen).
>
> #### `open_unknown(fullurl, data=None)`
>
> Переопределяемый интерфейс для открытия неизвестных типов URL.
>
> #### `retrieve(url, filename=None, reporthook=None, data=None)`
>
> Загружает содержимое *url* и помещает его в *filename*. Возвращаемое значение – кортеж, состоящий из имени локального файла и либо объекта [`email.message.Message`](https://python-all.ru/3.4/library/email.message.html#email.message.Message), содержащего заголовки ответа (для удалённых URL), либо `None` (для локальных URL). Затем вызывающий код должен открыть и прочитать содержимое *filename*. Если *filename* не указан и URL ссылается на локальный файл, возвращается имя входного файла. Если URL не локальный и *filename* не указан, имя файла будет результатом вызова [`tempfile.mktemp()`](https://python-all.ru/3.4/library/tempfile.html#tempfile.mktemp) с суффиксом, соответствующим суффиксу последнего компонента пути из входного URL. Если указан *reporthook*, это должна быть функция, принимающая три числовых параметра: номер чанка, максимальный размер читаемых чанков и общий размер загрузки (-1, если неизвестен). Она будет вызвана один раз в начале и после каждого чанка данных, прочитанного из сети. *reporthook* игнорируется для локальных URL.
>
> Если в *url* используется идентификатор схемы `http:`, необязательный аргумент *data* может быть задан для указания запроса `POST` (обычно тип запроса – `GET`). Аргумент *data* должен быть в стандартном формате *application/x-www-form-urlencoded*; см. функцию [`urllib.parse.urlencode()`](https://python-all.ru/3.4/library/urllib.parse.html#urllib.parse.urlencode).
>
> #### `version`
>
> Переменная, задающая пользовательский агент объекта opener. Чтобы заставить [`urllib`](https://python-all.ru/3.4/library/urllib.html#module-urllib) сообщать серверам, что это определённый пользовательский агент, установите её в подклассе как переменную класса или в конструкторе перед вызовом конструктора базового класса.

#### `class urllib.request.FancyURLopener(...)`

Устарело с версии 3.3.

[`FancyURLopener`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.FancyURLopener) является подклассом [`URLopener`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.URLopener), предоставляющим стандартную обработку следующих кодов ответа HTTP: 301, 302, 303, 307 и 401. Для перечисленных выше кодов 30x заголовок *Location* используется для получения фактического URL. Для кода 401 (требуется аутентификация) выполняется базовая HTTP-аутентификация. Для кодов 30x рекурсия ограничена значением атрибута *maxtries*, по умолчанию равным 10.

Для всех остальных кодов ответа вызывается метод `http_error_default()`, который можно переопределить в подклассах для соответствующей обработки ошибки.

> **Примечание**
>
> Согласно букве [**RFC 2616**](https://python-all.ru/3.4/library/urllib.request.html), ответы 301 и 302 на POST-запросы не должны автоматически перенаправляться без подтверждения пользователем. На деле браузеры допускают автоматическое перенаправление этих ответов, изменяя POST на GET, и [`urllib`](https://python-all.ru/3.4/library/urllib.html#module-urllib) воспроизводит такое поведение.

Параметры конструктора такие же, как и для [`URLopener`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.URLopener).

> **Примечание**
>
> При выполнении базовой аутентификации экземпляр [`FancyURLopener`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.FancyURLopener) вызывает свой метод [`prompt_user_passwd()`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.FancyURLopener.prompt_user_passwd). Реализация по умолчанию запрашивает у пользователя необходимые сведения на управляющем терминале. При необходимости подкласс может переопределить этот метод, чтобы обеспечить более подходящее поведение.

Класс [`FancyURLopener`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.FancyURLopener) предоставляет один дополнительный метод, который следует переопределить для обеспечения соответствующего поведения:

#### `prompt_user_passwd(host, realm)`

Возвращает информацию, необходимую для аутентификации пользователя на указанном хосте в заданной области безопасности. Возвращаемое значение должно быть кортежем, `(user, password)`, который можно использовать для базовой аутентификации.

Реализация запрашивает эту информацию на терминале; приложение должно переопределить этот метод, чтобы использовать подходящую модель взаимодействия в локальной среде.

## 21.6.24. [`urllib.request`](https://python-all.ru/3.4/library/urllib.request.html#module-urllib.request) Ограничения

>

- В настоящее время поддерживаются только следующие протоколы: HTTP (версии 0.9 и 1.0), FTP, локальные файлы и data-URL.

  Изменено в версии 3.4: Добавлена поддержка data-URL.
- Функция кэширования [`urlretrieve()`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.urlretrieve) отключена до тех пор, пока кто-нибудь не найдет время реализовать правильную обработку заголовков с временем истечения.
- Должна быть функция для проверки, находится ли определённый URL в кэше.
- Для обратной совместимости, если URL указывает на локальный файл, но файл не удаётся открыть, URL интерпретируется заново с использованием протокола FTP. Это иногда может приводить к запутанным сообщениям об ошибках.
- Функции [`urlopen()`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.urlopen) и [`urlretrieve()`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.urlretrieve) могут вызывать сколь угодно долгие задержки при ожидании установки сетевого соединения. Это означает, что создать интерактивный веб-клиент с помощью этих функций без использования потоков сложно.
- Данные, возвращаемые [`urlopen()`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.urlopen) или [`urlretrieve()`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.urlretrieve), представляют собой необработанные данные, возвращаемые сервером. Это могут быть бинарные данные (например, изображение), обычный текст или, скажем, HTML. Протокол HTTP предоставляет информацию о типе в заголовке ответа, которую можно узнать, посмотрев на заголовок *Content-Type*. Если возвращаемые данные являются HTML, можно использовать модуль [`html.parser`](https://python-all.ru/3.4/library/html.parser.html#module-html.parser) для его разбора.
- Код, работающий с протоколом FTP, не может различить файл и каталог. Это может привести к неожиданному поведению при попытке чтения URL, указывающего на недоступный файл. Если URL заканчивается на `/`, считается, что он ссылается на каталог, и обработка будет соответствующей. Но если попытка чтения файла приводит к ошибке 550 (означающей, что URL не найден или недоступен, часто по причинам прав доступа), то путь обрабатывается как каталог, чтобы учесть случай, когда в URL указан каталог, но завершающий `/` опущен. Это может привести к вводящим в заблуждение результатам при попытке получить файл, права на чтение которого делают его недоступным; код FTP попытается его прочитать, получит ошибку 550, а затем выполнит листинг каталога для недоступного файла. Если требуется тонкий контроль, рассмотрите возможность использования модуля [`ftplib`](https://python-all.ru/3.4/library/ftplib.html#module-ftplib), создания подкласса [`FancyURLopener`](https://python-all.ru/3.4/library/urllib.request.html#urllib.request.FancyURLopener) или изменения *\_urlopener* в соответствии с вашими потребностями.

# 21.7. [`urllib.response`](https://python-all.ru/3.4/library/urllib.request.html#module-urllib.response) – Классы ответов, используемые urllib

Модуль [`urllib.response`](https://python-all.ru/3.4/library/urllib.request.html#module-urllib.response) определяет функции и классы, которые задают минимальный файлоподобный интерфейс, включая `read()` и `readline()`. Типичный объект ответа – это экземпляр addinfourl, который определяет метод `info()`, возвращающий заголовки, и метод `geturl()`, возвращающий URL. Функции, определенные этим модулем, используются внутри модуля [`urllib.request`](https://python-all.ru/3.4/library/urllib.request.html#module-urllib.request).