urllib2.md
1> **Источник:** https://python-all.ru/3.16/howto/urllib2.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# HOWTO получение интернет-ресурсов с помощью пакета urllib89## Введение1011Связанные статьи1213Возможно, вам также будет полезна следующая статья о получении веб-ресурсов с помощью Python:1415- [Базовая аутентификация](https://python-all.ru/3.16/howto/urllib2.html)1617 > Учебник по *базовой аутентификации* с примерами на Python.1819**urllib.request** – это модуль Python для получения URL (Uniform Resource Locators). Он предоставляет очень простой интерфейс в виде функции *urlopen*. Она позволяет получать URL с использованием различных протоколов. Также доступен несколько более сложный интерфейс для обработки типовых ситуаций, таких как базовая аутентификация, куки, прокси и т. д. Они реализованы через объекты, называемые обработчиками и открывателями.2021urllib.request поддерживает получение URL для множества «схем URL» (определяемых строкой перед `":"` в URL – например, `"ftp"` – это схема URL для `"ftp://python.org/"`) с использованием соответствующих сетевых протоколов (например, FTP, HTTP). Данное руководство сосредоточено на наиболее распространённом случае – HTTP.2223Для простых случаев *urlopen* очень прост в использовании. Но как только при открытии HTTP-URL возникают ошибки или нестандартные ситуации, потребуется некоторое понимание протокола передачи гипертекста (HTTP). Наиболее полным и авторитетным справочником по HTTP является [**RFC 2616**](https://python-all.ru/3.16/howto/urllib2.html). Это технический документ, не предназначенный для лёгкого чтения. Данное HOWTO призвано проиллюстрировать использование *urllib* с достаточным количеством деталей по HTTP, чтобы помочь разобраться. Оно не заменяет документацию [`urllib.request`](https://python-all.ru/3.16/library/urllib.request.html#module-urllib.request), а дополняет её.2425## Загрузка URL2627Простейший способ использования urllib.request выглядит так:2829```python30import urllib.request31with urllib.request.urlopen('http://python.org/') as response:32 html = response.read()33```3435Если вы хотите получить ресурс по URL и сохранить его во временное расположение, это можно сделать с помощью функций [`shutil.copyfileobj()`](https://python-all.ru/3.16/library/shutil.html#shutil.copyfileobj) и [`tempfile.NamedTemporaryFile()`](https://python-all.ru/3.16/library/tempfile.html#tempfile.NamedTemporaryFile):3637```python38import shutil39import tempfile40import urllib.request4142with urllib.request.urlopen('http://python.org/') as response:43 with tempfile.NamedTemporaryFile(delete=False) as tmp_file:44 shutil.copyfileobj(response, tmp_file)4546with open(tmp_file.name) as html:47 pass48```4950Многие случаи использования urllib будут столь же просты (заметим, что вместо URL вида 'http:' можно было бы использовать URL, начинающийся с 'ftp:', 'file:' и т.д.). Однако цель этого руководства – объяснить более сложные случаи, сосредоточившись на HTTP.5152HTTP основан на запросах и ответах: клиент отправляет запросы, а серверы присылают ответы. urllib.request отражает это с помощью объекта `Request`, представляющего отправляемый HTTP-запрос. В простейшей форме вы создаёте объект Request, указывающий URL для получения. Вызов `urlopen` с этим объектом Request возвращает объект ответа для запрошенного URL. Этот ответ является файлоподобным объектом, что позволяет, например, вызвать `.read()` для него:5354```python55import urllib.request5657req = urllib.request.Request('http://python.org/')58with urllib.request.urlopen(req) as response:59 the_page = response.read()60```6162Обратите внимание, что urllib.request использует тот же интерфейс Request для обработки всех схем URL. Например, можно сделать FTP-запрос так:6364```python65req = urllib.request.Request('ftp://example.com/')66```6768В случае HTTP есть две дополнительные возможности, которые предоставляют объекты Request: во-первых, можно передавать данные, которые будут отправлены серверу. Во-вторых, можно передавать дополнительную информацию («метаданные») *о* данных или о самом запросе на сервер – эта информация отправляется как HTTP-заголовки. Рассмотрим каждую из них по порядку.6970### Данные7172Иногда требуется отправить данные на URL (часто URL будет ссылаться на CGI-скрипт или другое веб-приложение). В HTTP это обычно делается с помощью того, что называется **POST**-запросом. Именно так часто поступает браузер, когда вы отправляете заполненную HTML-форму в интернете. Не все POST-запросы должны приходить из форм: можно использовать POST для передачи произвольных данных в собственное приложение. В типичном случае HTML-форм данные нужно закодировать стандартным образом, а затем передать объекту Request в качестве аргумента `data`. Кодирование выполняется с помощью функции из библиотеки [`urllib.parse`](https://python-all.ru/3.16/library/urllib.parse.html#module-urllib.parse).7374```python75import urllib.parse76import urllib.request7778url = 'http://www.someserver.com/cgi-bin/register.cgi'79values = {'name' : 'Michael Foord',80 'location' : 'Northampton',81 'language' : 'Python' }8283data = urllib.parse.urlencode(values)84data = data.encode('ascii') # data должна быть типа bytes85req = urllib.request.Request(url, data)86with urllib.request.urlopen(req) as response:87 the_page = response.read()88```8990Обратите внимание, что иногда требуются другие кодировки (например, для загрузки файлов из HTML-форм – подробнее см. [Спецификацию HTML, раздел «Отправка формы»](https://python-all.ru/3.16/howto/urllib2.html)).9192Если не передавать аргумент `data`, urllib использует **GET**-запрос. Одно из различий между GET- и POST-запросами в том, что POST-запросы часто имеют «побочные эффекты»: они изменяют состояние системы (например, размещают заказ на сайте для доставки). Хотя стандарт HTTP указывает, что POST-запросы предназначены для того, чтобы *всегда* вызывать побочные эффекты, а GET-запросы – *никогда*, ничто не мешает GET-запросу иметь побочные эффекты, а POST-запросу – не иметь. Данные также можно передавать в HTTP GET-запросе, кодируя их прямо в URL.9394Это делается следующим образом:9596```python97>>> import urllib.request98>>> import urllib.parse99>>> data = {}100>>> data['name'] = 'Somebody Here'101>>> data['location'] = 'Northampton'102>>> data['language'] = 'Python'103>>> url_values = urllib.parse.urlencode(data)104>>> print(url_values) # Порядок может отличаться от указанного ниже.105name=Somebody+Here&language=Python&location=Northampton106>>> url = 'http://www.example.com/example.cgi'107>>> full_url = url + '?' + url_values108>>> data = urllib.request.urlopen(full_url)109```110111Обратите внимание, что полный URL создаётся добавлением `?` к URL, после которого следуют закодированные значения.112113### Заголовки114115Здесь будет рассмотрен один конкретный HTTP-заголовок, чтобы проиллюстрировать, как добавлять заголовки в HTTP-запросы.116117Некоторые сайты [\[1\]](https://python-all.ru/3.16/howto/urllib2.html#id7) не любят, когда их просматривают программы, либо отправляют разные версии разным браузерам [\[2\]](https://python-all.ru/3.16/howto/urllib2.html#id8). По умолчанию urllib идентифицирует себя как `Python-urllib/x.y` (где `x` и `y` – номера старшей и младшей версии релиза Python, например `Python-urllib/2.5`), что может сбить сайт с толку или просто не работать. Браузер идентифицирует себя через заголовок `User-Agent`[\[3\]](https://python-all.ru/3.16/howto/urllib2.html#id9). При создании объекта Request можно передать словарь заголовков. Следующий пример делает тот же запрос, что и выше, но идентифицирует себя как версию Internet Explorer [\[4\]](https://python-all.ru/3.16/howto/urllib2.html#id10).118119```python120import urllib.parse121import urllib.request122123url = 'http://www.someserver.com/cgi-bin/register.cgi'124user_agent = 'Mozilla/5.0 (Windows NT 6.1; Win64; x64)'125values = {'name': 'Michael Foord',126 'location': 'Northampton',127 'language': 'Python' }128headers = {'User-Agent': user_agent}129130data = urllib.parse.urlencode(values)131data = data.encode('ascii')132req = urllib.request.Request(url, data, headers)133with urllib.request.urlopen(req) as response:134 the_page = response.read()135```136137Ответ также имеет два полезных метода. См. раздел [info и geturl](https://python-all.ru/3.16/howto/urllib2.html#info-and-geturl), который следует после того, как мы рассмотрим, что происходит, когда что-то идёт не так.138139## Обработка исключений140141*urlopen* возбуждает [`URLError`](https://python-all.ru/3.16/library/urllib.error.html#urllib.error.URLError), когда не может обработать ответ (хотя, как обычно в Python API, могут также возбуждаться встроенные исключения, такие как [`ValueError`](https://python-all.ru/3.16/library/exceptions.html#ValueError), [`TypeError`](https://python-all.ru/3.16/library/exceptions.html#TypeError) и т.д.).142143[`HTTPError`](https://python-all.ru/3.16/library/urllib.error.html#urllib.error.HTTPError) является подклассом [`URLError`](https://python-all.ru/3.16/library/urllib.error.html#urllib.error.URLError), возбуждаемым в конкретном случае HTTP URL.144145Классы исключений экспортируются из модуля [`urllib.error`](https://python-all.ru/3.16/library/urllib.error.html#module-urllib.error).146147### URLError148149Часто URLError возникает из-за отсутствия сетевого соединения (нет маршрута к указанному серверу) или потому что указанный сервер не существует. В этом случае возбуждённое исключение будет иметь атрибут 'reason', который представляет собой кортеж, содержащий код ошибки и текстовое сообщение об ошибке.150151например152153```python154>>> req = urllib.request.Request('http://www.pretend_server.org')155>>> try: urllib.request.urlopen(req)156... except urllib.error.URLError as e:157... print(e.reason)158...159(4, 'getaddrinfo failed')160```161162### HTTPError163164Каждый HTTP-ответ от сервера содержит числовой «код состояния». Иногда код состояния указывает, что сервер не может выполнить запрос. Обработчики по умолчанию обрабатывают некоторые из таких ответов (например, если ответ представляет собой «перенаправление», которое просит клиента получить документ по другому URL, urllib обработает это). Для тех, которые не может обработать, urlopen возбудит [`HTTPError`](https://python-all.ru/3.16/library/urllib.error.html#urllib.error.HTTPError). Типичные ошибки включают «404» (страница не найдена), «403» (запрос запрещён) и «401» (требуется аутентификация).165166См. раздел 10 в [**RFC 2616**](https://python-all.ru/3.16/howto/urllib2.html) для справки по всем кодам ошибок HTTP.167168Возбуждённый экземпляр [`HTTPError`](https://python-all.ru/3.16/library/urllib.error.html#urllib.error.HTTPError) будет иметь целочисленный атрибут 'code', который соответствует ошибке, отправленной сервером.169170#### Коды ошибок171172Поскольку обработчики по умолчанию обрабатывают перенаправления (коды в диапазоне 300), а коды в диапазоне 100–299 указывают на успех, обычно вы будете видеть только коды ошибок в диапазоне 400–599.173174[`http.server.BaseHTTPRequestHandler.responses`](https://python-all.ru/3.16/library/http.server.html#http.server.BaseHTTPRequestHandler.responses) – это полезный словарь кодов ответа, который показывает все коды ответа, используемые в [**RFC 2616**](https://python-all.ru/3.16/howto/urllib2.html). Ниже приведён фрагмент из этого словаря175176```python177responses = {178 ...179 <HTTPStatus.OK: 200>: ('OK', 'Request fulfilled, document follows'),180 ...181 <HTTPStatus.FORBIDDEN: 403>: ('Forbidden',182 'Request forbidden -- authorization will '183 'not help'),184 <HTTPStatus.NOT_FOUND: 404>: ('Not Found',185 'Nothing matches the given URI'),186 ...187 <HTTPStatus.IM_A_TEAPOT: 418>: ("I'm a Teapot",188 'Server refuses to brew coffee because '189 'it is a teapot'),190 ...191 <HTTPStatus.SERVICE_UNAVAILABLE: 503>: ('Service Unavailable',192 'The server cannot process the '193 'request due to a high load'),194 ...195 }196```197198При возникновении ошибки сервер отвечает, возвращая HTTP код ошибки *и* страницу с ошибкой. Можно использовать экземпляр [`HTTPError`](https://python-all.ru/3.16/library/urllib.error.html#urllib.error.HTTPError) как ответ на возвращённой странице. Это означает, что помимо атрибута code, у него также есть методы read, geturl и info, как у возвращаемых модулем `urllib.response`:199200```python201>>> req = urllib.request.Request('http://www.python.org/fish.html')202>>> try:203... urllib.request.urlopen(req)204... except urllib.error.HTTPError as e:205... print(e.code)206... print(e.read())207...208404209b'<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"210 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">\n\n\n<html211 ...212 <title>Page Not Found</title>\n213 ...214```215216### Резюме217218Итак, если вы хотите быть готовым к [`HTTPError`](https://python-all.ru/3.16/library/urllib.error.html#urllib.error.HTTPError) *или* [`URLError`](https://python-all.ru/3.16/library/urllib.error.html#urllib.error.URLError), есть два основных подхода. Второй подход предпочтительнее.219220#### Способ 1221222```python223from urllib.request import Request, urlopen224from urllib.error import URLError, HTTPError225req = Request(someurl)226try:227 response = urlopen(req)228except HTTPError as e:229 print('The server couldn\'t fulfill the request.')230 print('Error code: ', e.code)231except URLError as e:232 print('We failed to reach a server.')233 print('Reason: ', e.reason)234else:235 # всё в порядке236```237238> **Примечание**239>240> `except HTTPError` *должен* идти первым, иначе `except URLError` *также* перехватит [`HTTPError`](https://python-all.ru/3.16/library/urllib.error.html#urllib.error.HTTPError).241242#### Способ 2243244```python245from urllib.request import Request, urlopen246from urllib.error import URLError247req = Request(someurl)248try:249 response = urlopen(req)250except URLError as e:251 if hasattr(e, 'reason'):252 print('We failed to reach a server.')253 print('Reason: ', e.reason)254 elif hasattr(e, 'code'):255 print('The server couldn\'t fulfill the request.')256 print('Error code: ', e.code)257else:258 # всё в порядке259```260261## info и geturl262263Ответ, возвращаемый urlopen (или экземпляр [`HTTPError`](https://python-all.ru/3.16/library/urllib.error.html#urllib.error.HTTPError)), имеет два полезных метода `info()` и `geturl()` и определён в модуле [`urllib.response`](https://python-all.ru/3.16/library/urllib.request.html#module-urllib.response).264265- **geturl** – возвращает реальный URL полученной страницы. Это полезно, поскольку `urlopen` (или используемый объект opener) мог выполнить перенаправление. URL полученной страницы может не совпадать с запрошенным URL.266- **info** – возвращает объект, подобный словарю, который описывает полученную страницу, в частности заголовки, отправленные сервером. В настоящее время это экземпляр [`http.client.HTTPMessage`](https://python-all.ru/3.16/library/http.client.html#http.client.HTTPMessage).267268Типичные заголовки включают ‘Content-length’, ‘Content-type’ и т.д. Смотрите [Краткий справочник HTTP-заголовков](https://python-all.ru/3.16/howto/urllib2.html) для полезного списка HTTP-заголовков с краткими пояснениями их значения и использования.269270## Открыватели и обработчики271272При получении URL используется opener (экземпляр, возможно, запутанно названного [`urllib.request.OpenerDirector`](https://python-all.ru/3.16/library/urllib.request.html#urllib.request.OpenerDirector)). Обычно используется стандартный opener – через `urlopen`, – но можно создавать собственные opener'ы. Opener'ы используют обработчики. Вся «тяжёлая работа» выполняется обработчиками. Каждый обработчик знает, как открывать URL для определённой схемы URL (http, ftp и т.д.) или как обрабатывать аспект открытия URL, например HTTP-перенаправления или HTTP-cookies.273274Стоит создавать собственные opener'ы, если нужно получать URL с установленными определёнными обработчиками, например чтобы получить opener, обрабатывающий cookies, или opener, не обрабатывающий перенаправления.275276Чтобы создать opener, создайте экземпляр `OpenerDirector`, а затем вызывайте `.add_handler(some_handler_instance)` несколько раз.277278В качестве альтернативы можно использовать `build_opener` – удобную функцию для создания объектов opener одним вызовом. `build_opener` по умолчанию добавляет несколько обработчиков, но предоставляет быстрый способ добавить ещё и/или переопределить стандартные обработчики.279280Другие типы обработчиков могут обрабатывать прокси, аутентификацию и другие распространённые, но слегка специализированные ситуации.281282`install_opener` можно использовать, чтобы сделать объект `opener` (глобальным) стандартным opener'ом. Это означает, что вызовы `urlopen` будут использовать установленный opener.283284Объекты opener имеют метод `open`, который можно вызывать напрямую для получения URL так же, как функцию `urlopen`: нет необходимости вызывать `install_opener`, кроме как для удобства.285286## Базовая аутентификация287288Для иллюстрации создания и установки обработчика мы будем использовать `HTTPBasicAuthHandler`. Для более подробного обсуждения этой темы – включая объяснение того, как работает базовая аутентификация, – смотрите [Руководство по базовой аутентификации](https://python-all.ru/3.16/howto/urllib2.html).289290Когда требуется аутентификация, сервер отправляет заголовок (а также код ошибки 401) с запросом аутентификации. В нём указывается схема аутентификации и «realm». Заголовок выглядит так: `WWW-Authenticate: SCHEME realm="REALM"`.291292например293294```text295WWW-Authenticate: Basic realm="cPanel Users"296```297298Затем клиент должен повторить запрос, включив в него соответствующие имя и пароль для данной области в качестве заголовка. Это и есть «базовая аутентификация». Чтобы упростить этот процесс, можно создать экземпляр `HTTPBasicAuthHandler` и opener для использования этого обработчика.299300`HTTPBasicAuthHandler` использует объект, называемый менеджером паролей, для обработки соответствия URL и областей паролям и именам пользователей. Если известно, какая область (из заголовка аутентификации, отправленного сервером), то можно использовать `HTTPPasswordMgr`. Часто область не важна. В этом случае удобно использовать `HTTPPasswordMgrWithDefaultRealm`. Это позволяет указать имя пользователя и пароль по умолчанию для URL. Они будут использованы при отсутствии альтернативной комбинации для конкретной области. Это указывается передачей `None` в качестве аргумента realm методу `add_password`.301302URL верхнего уровня – это первый URL, требующий аутентификации. URL «глубже», чем переданный в .add\_password(), также будут соответствовать.303304```python305# создать менеджер паролей306password_mgr = urllib.request.HTTPPasswordMgrWithDefaultRealm()307308# Добавить имя пользователя и пароль.309# Если бы мы знали realm, мы могли бы использовать его вместо None.310top_level_url = "http://example.com/foo/"311password_mgr.add_password(None, top_level_url, username, password)312313handler = urllib.request.HTTPBasicAuthHandler(password_mgr)314315# создать "opener" (экземпляр OpenerDirector)316opener = urllib.request.build_opener(handler)317318# использовать opener для получения URL319opener.open(a_url)320321# Установить opener.322# Теперь все вызовы urllib.request.urlopen будут использовать наш opener.323urllib.request.install_opener(opener)324```325326> **Примечание**327>328> В приведённом выше примере мы передали только наш `HTTPBasicAuthHandler` в `build_opener`. По умолчанию открыватели имеют обработчики для обычных ситуаций – `ProxyHandler` (если установлена настройка прокси, например переменная окружения `http_proxy`), `UnknownHandler`, `HTTPHandler`, `HTTPDefaultErrorHandler`, `HTTPRedirectHandler`, `FTPHandler`, `FileHandler`, `DataHandler`, `HTTPErrorProcessor`.329330`top_level_url` на самом деле *либо* полный URL (включая компонент схемы 'http:' и имя хоста и, опционально, номер порта), например `"http://example.com/"`, *либо* «authority» (т.е. имя хоста, опционально включая номер порта), например `"example.com"` или `"example.com:8080"` (последний пример включает номер порта). Authority, если присутствует, НЕ должен содержать компонент «userinfo» – например `"joe:password@example.com"` некорректно.331332## Прокси333334**urllib** автоматически определяет настройки прокси и использует их. Это происходит через `ProxyHandler`, который является частью обычной цепочки обработчиков при обнаружении настройки прокси. Обычно это хорошо, но бывают случаи, когда это может быть нежелательно [\[5\]](https://python-all.ru/3.16/howto/urllib2.html#id11). Один из способов – настроить собственный `ProxyHandler` без определённых прокси. Это делается аналогично настройке обработчика [базовой аутентификации](https://python-all.ru/3.16/howto/urllib2.html#basic-authentication):335336```python337>>> proxy_support = urllib.request.ProxyHandler({})338>>> opener = urllib.request.build_opener(proxy_support)339>>> urllib.request.install_opener(opener)340```341342> **Примечание**343>344> В настоящее время `urllib.request` *не* поддерживает получение `https`-адресов через прокси. Однако это можно включить, расширив urllib.request, как показано в рецепте [\[6\]](https://python-all.ru/3.16/howto/urllib2.html#id12).345346> **Примечание**347>348> `HTTP_PROXY` будет проигнорирован, если установлена переменная `REQUEST_METHOD`; смотрите документацию по [`getproxies()`](https://python-all.ru/3.16/library/urllib.request.html#urllib.request.getproxies).349350## Сокеты и уровни351352Поддержка Python для получения ресурсов из сети является многоуровневой. urllib использует библиотеку [`http.client`](https://python-all.ru/3.16/library/http.client.html#module-http.client), которая, в свою очередь, использует библиотеку socket.353354Начиная с Python 2.3 можно указать, как долго сокет должен ждать ответа до истечения тайм-аута. Это может быть полезно в приложениях, которым приходится получать веб-страницы. По умолчанию модуль socket не имеет *тайм-аута* и может зависнуть. В настоящее время тайм-аут сокета не доступен на уровнях http.client или urllib.request. Однако можно установить глобальный тайм-аут по умолчанию для всех сокетов с помощью355356```python357import socket358import urllib.request359360# тайм-аут в секундах361timeout = 10362socket.setdefaulttimeout(timeout)363364# этот вызов urllib.request.urlopen теперь использует тайм-аут по умолчанию365# который мы установили в модуле socket366req = urllib.request.Request('http://www.voidspace.org.uk')367response = urllib.request.urlopen(req)368```369370---371372## Примечания373374Этот документ был проверен и доработан Джоном Ли.375376\[[1](https://python-all.ru/3.16/howto/urllib2.html#id1)\]377378Google, например.379380\[[2](https://python-all.ru/3.16/howto/urllib2.html#id2)\]381382Определение браузера (browser sniffing) – очень плохая практика для веб-дизайна: создание сайтов с использованием веб-стандартов гораздо разумнее. К сожалению, многие сайты до сих пор отправляют разные версии разным браузерам.383384\[[3](https://python-all.ru/3.16/howto/urllib2.html#id3)\]385386Пользовательский агент для MSIE 6 – *'Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1; .NET CLR 1.1.4322)'*387388\[[4](https://python-all.ru/3.16/howto/urllib2.html#id4)\]389390Подробнее о HTTP-заголовках запросов см. [Quick Reference to HTTP Headers](https://python-all.ru/3.16/howto/urllib2.html).391392\[[5](https://python-all.ru/3.16/howto/urllib2.html#id5)\]393394В моём случае на работе приходится использовать прокси для доступа в интернет. Если через этот прокси пытаться получить *localhost*-URL, он их блокирует. В IE настроено использование прокси, и urllib это подхватывает. Чтобы тестировать скрипты с локальным сервером, приходится запрещать urllib использовать прокси.395396\[[6](https://python-all.ru/3.16/howto/urllib2.html#id6)\]397398Открыватель urllib для SSL-прокси (метод CONNECT): [ASPN Cookbook Recipe](https://python-all.ru/3.16/howto/urllib2.html).399