`http.client.md`

370 строк · 29.3 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.6/library/http.client.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# 21.12. [`http.client`](https://python-all.ru/3.6/library/http.client.html#module-http.client) – клиент протокола HTTP89**Исходный код:** [Lib/http/client.py](https://python-all.ru/src/3.6/Lib/http/client.py)1011---1213Этот модуль определяет классы, реализующие клиентскую часть протоколов HTTP и HTTPS. Обычно он не используется напрямую – модуль [`urllib.request`](https://python-all.ru/3.6/library/urllib.request.html#module-urllib.request) использует его для обработки URL, которые используют HTTP и HTTPS.1415> **См. также**16>17> Для высокоуровневого интерфейса HTTP-клиента рекомендуется [пакет Requests](https://python-all.ru/3.6/library/http.client.html).1819> **Примечание**20>21> Поддержка HTTPS доступна только при компиляции Python с поддержкой SSL (через модуль [`ssl`](https://python-all.ru/3.6/library/ssl.html#module-ssl)).2223Модуль предоставляет следующие классы:2425#### `class http.client.HTTPConnection(host, port=None, [timeout, ]source_address=None)`2627Экземпляр [`HTTPConnection`](https://python-all.ru/3.6/library/http.client.html#http.client.HTTPConnection) представляет одну транзакцию с HTTP-сервером. Экземпляр должен быть создан с указанием хоста и необязательного номера порта. Если номер порта не передан, порт извлекается из строки хоста, если она имеет вид `host:port`, в противном случае используется порт HTTP по умолчанию (80). Если указан необязательный параметр *timeout*, блокирующие операции (например, попытки подключения) будут завершаться по истечении указанного количества секунд (если параметр не задан, используется глобальная настройка таймаута по умолчанию). Необязательный параметр *source\_address* может быть кортежем (host, port), который используется в качестве исходного адреса для HTTP-соединения.2829Например, следующие вызовы создают экземпляры, подключающиеся к одному и тому же серверу по одному и тому же хосту и порту:3031```python32>>> h1 = http.client.HTTPConnection('www.python.org')33>>> h2 = http.client.HTTPConnection('www.python.org:80')34>>> h3 = http.client.HTTPConnection('www.python.org', 80)35>>> h4 = http.client.HTTPConnection('www.python.org', 80, timeout=10)36```3738Изменено в версии 3.2: Добавлен параметр *source\_address*.3940Изменено в версии 3.4: Параметр *strict* был удалён. Ответы в стиле HTTP 0.9 («простые ответы») больше не поддерживаются.4142#### `class http.client.HTTPSConnection(host, port=None, key_file=None, cert_file=None, [timeout, ]source_address=None, *, context=None, check_hostname=None)`4344Подкласс [`HTTPConnection`](https://python-all.ru/3.6/library/http.client.html#http.client.HTTPConnection), использующий SSL для связи с защищёнными серверами. Порт по умолчанию – `443`. Если указан *context*, он должен быть экземпляром [`ssl.SSLContext`](https://python-all.ru/3.6/library/ssl.html#ssl.SSLContext), описывающим различные параметры SSL.4546Пожалуйста, прочитайте [Рекомендации по безопасности](https://python-all.ru/3.6/library/ssl.html#ssl-security) для получения дополнительной информации о лучших практиках.4748Изменено в версии 3.2: Добавлены *source\_address*, *context* и *check\_hostname*.4950Изменено в версии 3.2: Теперь этот класс поддерживает виртуальные хосты HTTPS (если [`ssl.HAS_SNI`](https://python-all.ru/3.6/library/ssl.html#ssl.HAS_SNI) истинно).5152Изменено в версии 3.4: Параметр *strict* удалён. «Простые ответы» в стиле HTTP 0.9 больше не поддерживаются.5354Изменено в версии 3.4.3: Теперь этот класс по умолчанию выполняет все необходимые проверки сертификата и имени хоста. Чтобы вернуть прежнее непроверенное поведение, можно передать `ssl._create_unverified_context()` параметру *context*.5556Устарело с версии 3.6: *key\_file* и *cert\_file* устарели в пользу *context*. Пожалуйста, используйте [`ssl.SSLContext.load_cert_chain()`](https://python-all.ru/3.6/library/ssl.html#ssl.SSLContext.load_cert_chain) вместо этого, или пусть [`ssl.create_default_context()`](https://python-all.ru/3.6/library/ssl.html#ssl.create_default_context) выберет доверенные сертификаты CA системы.5758Параметр *check\_hostname* также устарел; следует использовать атрибут [`ssl.SSLContext.check_hostname`](https://python-all.ru/3.6/library/ssl.html#ssl.SSLContext.check_hostname) объекта *context*.5960#### `class http.client.HTTPResponse(sock, debuglevel=0, method=None, url=None)`6162Класс, экземпляры которого возвращаются при успешном соединении. Не создаётся напрямую пользователем.6364Изменено в версии 3.4: Параметр *strict* удалён. «Простые ответы» в стиле HTTP 0.9 больше не поддерживаются.6566При необходимости генерируются следующие исключения:6768#### `exception http.client.HTTPException`6970Базовый класс остальных исключений в этом модуле. Является подклассом [`Exception`](https://python-all.ru/3.6/library/exceptions.html#Exception).7172#### `exception http.client.NotConnected`7374Подкласс [`HTTPException`](https://python-all.ru/3.6/library/http.client.html#http.client.HTTPException).7576#### `exception http.client.InvalidURL`7778Подкласс [`HTTPException`](https://python-all.ru/3.6/library/http.client.html#http.client.HTTPException), возбуждается, если указан порт, который не является числом или пуст.7980#### `exception http.client.UnknownProtocol`8182Подкласс [`HTTPException`](https://python-all.ru/3.6/library/http.client.html#http.client.HTTPException).8384#### `exception http.client.UnknownTransferEncoding`8586Подкласс [`HTTPException`](https://python-all.ru/3.6/library/http.client.html#http.client.HTTPException).8788#### `exception http.client.UnimplementedFileMode`8990Подкласс [`HTTPException`](https://python-all.ru/3.6/library/http.client.html#http.client.HTTPException).9192#### `exception http.client.IncompleteRead`9394Подкласс [`HTTPException`](https://python-all.ru/3.6/library/http.client.html#http.client.HTTPException).9596#### `exception http.client.ImproperConnectionState`9798Подкласс [`HTTPException`](https://python-all.ru/3.6/library/http.client.html#http.client.HTTPException).99100#### `exception http.client.CannotSendRequest`101102Подкласс [`ImproperConnectionState`](https://python-all.ru/3.6/library/http.client.html#http.client.ImproperConnectionState).103104#### `exception http.client.CannotSendHeader`105106Подкласс [`ImproperConnectionState`](https://python-all.ru/3.6/library/http.client.html#http.client.ImproperConnectionState).107108#### `exception http.client.ResponseNotReady`109110Подкласс [`ImproperConnectionState`](https://python-all.ru/3.6/library/http.client.html#http.client.ImproperConnectionState).111112#### `exception http.client.BadStatusLine`113114Подкласс [`HTTPException`](https://python-all.ru/3.6/library/http.client.html#http.client.HTTPException). Возбуждается, если сервер отвечает HTTP-кодом состояния, который не распознаётся.115116#### `exception http.client.LineTooLong`117118Подкласс [`HTTPException`](https://python-all.ru/3.6/library/http.client.html#http.client.HTTPException). Возбуждается, если от сервера по протоколу HTTP получена чрезмерно длинная строка.119120#### `exception http.client.RemoteDisconnected`121122Подкласс [`ConnectionResetError`](https://python-all.ru/3.6/library/exceptions.html#ConnectionResetError) и [`BadStatusLine`](https://python-all.ru/3.6/library/http.client.html#http.client.BadStatusLine). Возбуждается [`HTTPConnection.getresponse()`](https://python-all.ru/3.6/library/http.client.html#http.client.HTTPConnection.getresponse), когда при попытке чтения ответа из соединения не получено данных, что указывает на закрытие соединения удалённой стороной.123124Новое в версии 3.5: Ранее возбуждалось [`BadStatusLine`](https://python-all.ru/3.6/library/http.client.html#http.client.BadStatusLine)`('')`.125126Константы, определённые в этом модуле:127128#### `http.client.HTTP_PORT`129130Порт по умолчанию для протокола HTTP (всегда `80`).131132#### `http.client.HTTPS_PORT`133134Порт по умолчанию для протокола HTTPS (всегда `443`).135136#### `http.client.responses`137138Этот словарь сопоставляет коды состояния HTTP 1.1 с названиями W3C.139140Пример: `http.client.responses[http.client.NOT_FOUND]` – это `'Not Found'`.141142См. [коды состояния HTTP](https://python-all.ru/3.6/library/http.html#http-status-codes) для списка кодов состояния HTTP, доступных в этом модуле как константы.143144## 21.12.1. Объекты HTTPConnection145146Экземпляры [`HTTPConnection`](https://python-all.ru/3.6/library/http.client.html#http.client.HTTPConnection) имеют следующие методы:147148#### `HTTPConnection.request(method, url, body=None, headers={}, *, encode_chunked=False)`149150Это отправляет запрос на сервер, используя метод HTTP *method* и селектор *url*.151152If *body* is specified, the specified data is sent after the headers are finished. It may be a [`str`](https://python-all.ru/3.6/library/stdtypes.html#str), a [bytes-like object](https://python-all.ru/3.6/glossary.html#term-bytes-like-object), an open [file object](https://python-all.ru/3.6/glossary.html#term-file-object), or an iterable of [`bytes`](https://python-all.ru/3.6/library/stdtypes.html#bytes). If *body* is a string, it is encoded as ISO-8859-1, the default for HTTP. If it is a bytes-like object, the bytes are sent as is. If it is a [file object](https://python-all.ru/3.6/glossary.html#term-file-object), the contents of the file is sent; this file object should support at least the `read()` method. If the file object is an instance of [`io.TextIOBase`](https://python-all.ru/3.6/library/io.html#io.TextIOBase), the data returned by the `read()` method will be encoded as ISO-8859-1, otherwise the data returned by `read()` is sent as is. If *body* is an iterable, the elements of the iterable are sent as is until the iterable is exhausted.153154Аргумент *headers* должен быть отображением дополнительных HTTP-заголовков, отправляемых с запросом.155156Если *headers* не содержит ни Content-Length, ни Transfer-Encoding, но есть тело запроса, одно из этих полей заголовка будет добавлено автоматически. Если *body* равно `None`, заголовок Content-Length устанавливается в `0` для методов, которые ожидают тело (`PUT`, `POST` и `PATCH`). Если *body* является строкой или байтоподобным объектом, который не является также [файлом](https://python-all.ru/3.6/glossary.html#term-file-object), заголовок Content-Length устанавливается в его длину. Любой другой тип *body* (файлы и итерируемые объекты в целом) будет передаваться по частям, и заголовок Transfer-Encoding будет установлен автоматически вместо Content-Length.157158Аргумент *encode\_chunked* актуален только в том случае, если в *headers* указан Transfer-Encoding. Если *encode\_chunked* равно `False`, объект HTTPConnection предполагает, что всё кодирование выполняется вызывающим кодом. Если равно `True`, тело будет закодировано по частям (chunked).159160> **Примечание**161>162> Фрагментированное кодирование передачи (chunked transfer encoding) было добавлено в протокол HTTP версии 1.1. Если неизвестно, что HTTP-сервер поддерживает HTTP 1.1, вызывающий код должен либо указать Content-Length, либо передать [`str`](https://python-all.ru/3.6/library/stdtypes.html#str) или байтоподобный объект, который не является файлом, в качестве представления тела.163164Новое в версии 3.2: *body* теперь может быть итерируемым объектом.165166Изменено в версии 3.6: Если в *headers* не установлены ни Content-Length, ни Transfer-Encoding, файловые и итерируемые объекты *body* теперь кодируются по частям (chunked). Был добавлен аргумент *encode\_chunked*. Для файловых объектов не предпринимается попыток определить Content-Length.167168#### `HTTPConnection.getresponse()`169170Должен вызываться после отправки запроса для получения ответа от сервера. Возвращает экземпляр [`HTTPResponse`](https://python-all.ru/3.6/library/http.client.html#http.client.HTTPResponse).171172> **Примечание**173>174> Обратите внимание: необходимо прочитать весь ответ, прежде чем отправлять новый запрос на сервер.175176Изменено в версии 3.5: Если возникло исключение [`ConnectionError`](https://python-all.ru/3.6/library/exceptions.html#ConnectionError) или его подкласс, объект [`HTTPConnection`](https://python-all.ru/3.6/library/http.client.html#http.client.HTTPConnection) будет готов к переподключению при отправке нового запроса.177178#### `HTTPConnection.set_debuglevel(level)`179180Устанавливает уровень отладки. Уровень отладки по умолчанию – `0`, что означает отсутствие вывода отладочной информации. Любое значение больше `0` приведет к выводу всей текущей отладочной информации в stdout. Значение `debuglevel` передается всем новым создаваемым объектам [`HTTPResponse`](https://python-all.ru/3.6/library/http.client.html#http.client.HTTPResponse).181182Новое в версии 3.1.183184#### `HTTPConnection.set_tunnel(host, port=None, headers=None)`185186Устанавливает хост и порт для HTTP Connect Tunnelling. Это позволяет пропускать соединение через прокси-сервер.187188Аргументы host и port задают конечную точку туннелированного соединения (т.е. адрес, включённый в запрос CONNECT, *а не* адрес прокси-сервера).189190Аргумент headers должен быть отображением дополнительных HTTP-заголовков, отправляемых вместе с запросом CONNECT.191192Например, чтобы пройти туннель через HTTPS-прокси-сервер, работающий локально на порту 8080, нужно передать адрес прокси конструктору [`HTTPSConnection`](https://python-all.ru/3.6/library/http.client.html#http.client.HTTPSConnection), а адрес хоста, который мы в конечном итоге хотим достичь, методу [`set_tunnel()`](https://python-all.ru/3.6/library/http.client.html#http.client.HTTPConnection.set_tunnel):193194```python195>>> import http.client196>>> conn = http.client.HTTPSConnection("localhost", 8080)197>>> conn.set_tunnel("www.python.org")198>>> conn.request("HEAD","/index.html")199```200201Новое в версии 3.2.202203#### `HTTPConnection.connect()`204205Подключается к серверу, указанному при создании объекта. По умолчанию этот метод вызывается автоматически при выполнении запроса, если у клиента ещё нет соединения.206207#### `HTTPConnection.close()`208209Закрывает соединение с сервером.210211В качестве альтернативы использованию описанного выше метода `request()` вы также можете отправлять запрос пошагово, используя четыре функции, приведённые ниже.212213#### `HTTPConnection.putrequest(method, url, skip_host=False, skip_accept_encoding=False)`214215Этот вызов должен быть первым после установки соединения с сервером. Он отправляет на сервер строку, состоящую из строки *method*, строки *url* и версии HTTP (`HTTP/1.1`). Чтобы отключить автоматическую отправку заголовков `Host:` или `Accept-Encoding:` (например, для приёма дополнительных кодировок содержимого), укажите *skip\_host* или *skip\_accept\_encoding* со значением, отличным от False.216217#### `HTTPConnection.putheader(header, argument[, ...])`218219Отправляет заголовок в стиле [**RFC 822**](https://python-all.ru/3.6/library/http.client.html) на сервер. Он отправляет строку, состоящую из заголовка, двоеточия, пробела и первого аргумента. Если заданы дополнительные аргументы, отправляются строки продолжения, каждая из которых состоит из табуляции и аргумента.220221#### `HTTPConnection.endheaders(message_body=None, *, encode_chunked=False)`222223Отправляет пустую строку на сервер, сигнализируя об окончании заголовков. Необязательный аргумент *message\_body* можно использовать для передачи тела сообщения, связанного с запросом.224225Если *encode\_chunked* равно `True`, результат каждой итерации *message\_body* будет кодироваться по частям (chunk-encoded), как указано в [**RFC 7230**](https://python-all.ru/3.6/library/http.client.html), раздел 3.3.1. Способ кодирования данных зависит от типа *message\_body*. Если *message\_body* реализует [интерфейс буфера](https://python-all.ru/3.6/c-api/buffer.html#bufferobjects), кодирование даст один чанк. Если *message\_body* – это `collections.Iterable`, каждая итерация *message\_body* даст чанк. Если *message\_body* – это [файловый объект](https://python-all.ru/3.6/glossary.html#term-file-object), каждый вызов `.read()` даст чанк. Метод автоматически сигнализирует об окончании данных, закодированных чанками, сразу после *message\_body*.226227> **Примечание**228>229> В соответствии со спецификацией кодирования чанками, пустые чанки, полученные из тела-итератора, будут игнорироваться кодировщиком чанков. Это сделано для предотвращения преждевременного завершения чтения запроса целевым сервером из-за неверного кодирования.230231Новое в версии 3.6: Поддержка фрагментированного кодирования. Был добавлен параметр *encode\_chunked*.232233#### `HTTPConnection.send(data)`234235Отправляет данные на сервер. Это следует использовать напрямую только после вызова метода [`endheaders()`](https://python-all.ru/3.6/library/http.client.html#http.client.HTTPConnection.endheaders) и до вызова [`getresponse()`](https://python-all.ru/3.6/library/http.client.html#http.client.HTTPConnection.getresponse).236237## 21.12.2. Объекты HTTPResponse238239Экземпляр [`HTTPResponse`](https://python-all.ru/3.6/library/http.client.html#http.client.HTTPResponse) оборачивает HTTP-ответ от сервера. Он предоставляет доступ к заголовкам запроса и телу сущности. Ответ является итерируемым объектом и может использоваться в операторе with.240241Изменено в версии 3.5: Теперь реализован интерфейс [`io.BufferedIOBase`](https://python-all.ru/3.6/library/io.html#io.BufferedIOBase) и поддерживаются все его операции чтения.242243#### `HTTPResponse.read([amt])`244245Читает и возвращает тело ответа, или до следующих *amt* байт.246247#### `HTTPResponse.readinto(b)`248249Читает до следующих len(b) байт тела ответа в буфер *b*. Возвращает количество прочитанных байт.250251Новое в версии 3.3.252253#### `HTTPResponse.getheader(name, default=None)`254255Возвращает значение заголовка *name* или *default*, если нет заголовка, соответствующего *name*. Если существует более одного заголовка с именем *name*, возвращает все значения, объединённые через ', '. Если 'default' является любым итерируемым объектом, отличным от одной строки, его элементы аналогично возвращаются объединёнными запятыми.256257#### `HTTPResponse.getheaders()`258259Возвращает список кортежей (заголовок, значение).260261#### `HTTPResponse.fileno()`262263Возвращает `fileno` базового сокета.264265#### `HTTPResponse.msg`266267Экземпляр `http.client.HTTPMessage`, содержащий заголовки ответа. `http.client.HTTPMessage` является подклассом [`email.message.Message`](https://python-all.ru/3.6/library/email.compat32-message.html#email.message.Message).268269#### `HTTPResponse.version`270271Версия протокола HTTP, используемая сервером. 10 для HTTP/1.0, 11 для HTTP/1.1.272273#### `HTTPResponse.status`274275Код состояния, возвращаемый сервером.276277#### `HTTPResponse.reason`278279Фраза причины, возвращаемая сервером.280281#### `HTTPResponse.debuglevel`282283Отладочная привязка. Если [`debuglevel`](https://python-all.ru/3.6/library/http.client.html#http.client.HTTPResponse.debuglevel) больше нуля, сообщения будут выводиться в stdout по мере чтения и разбора ответа.284285#### `HTTPResponse.closed`286287Равно `True`, если поток закрыт.288289## 21.12.3. Примеры290291Вот пример сеанса, в котором используется метод `GET`:292293```python294>>> import http.client295>>> conn = http.client.HTTPSConnection("www.python.org")296>>> conn.request("GET", "/")297>>> r1 = conn.getresponse()298>>> print(r1.status, r1.reason)299200 OK300>>> data1 = r1.read()  # Возвращает всё содержимое.301>>> # Следующий пример демонстрирует чтение данных по частям.302>>> conn.request("GET", "/")303>>> r1 = conn.getresponse()304>>> while not r1.closed:305...     print(r1.read(200))  # 200 байт306b'<!doctype html>\n<!--[if"...307...308>>> # Пример некорректного запроса309>>> conn.request("GET", "/parrot.spam")310>>> r2 = conn.getresponse()311>>> print(r2.status, r2.reason)312404 Not Found313>>> data2 = r2.read()314>>> conn.close()315```316317Вот пример сеанса, в котором используется метод `HEAD`. Обратите внимание, что метод `HEAD` никогда не возвращает данные.318319```python320>>> import http.client321>>> conn = http.client.HTTPSConnection("www.python.org")322>>> conn.request("HEAD", "/")323>>> res = conn.getresponse()324>>> print(res.status, res.reason)325200 OK326>>> data = res.read()327>>> print(len(data))3280329>>> data == b''330True331```332333Ниже приведён пример сеанса, показывающий, как отправлять `POST` запросы:334335```python336>>> import http.client, urllib.parse337>>> params = urllib.parse.urlencode({'@number': 12524, '@type': 'issue', '@action': 'show'})338>>> headers = {"Content-type": "application/x-www-form-urlencoded",339...            "Accept": "text/plain"}340>>> conn = http.client.HTTPConnection("bugs.python.org")341>>> conn.request("POST", "", params, headers)342>>> response = conn.getresponse()343>>> print(response.status, response.reason)344302 Found345>>> data = response.read()346>>> data347b'Redirecting to <a href="http://bugs.python.org/issue12524">http://bugs.python.org/issue12524</a>'348>>> conn.close()349```350351Клиентские `HTTP PUT`-запросы очень похожи на `POST`-запросы. Разница заключается только на стороне сервера, где HTTP-сервер позволяет создавать ресурсы через `PUT`-запрос. Следует отметить, что пользовательские HTTP-методы также обрабатываются в [`urllib.request.Request`](https://python-all.ru/3.6/library/urllib.request.html#urllib.request.Request) путём передачи соответствующего атрибута method. Ниже приведён пример сеанса работы, показывающий, как выполнить `PUT`-запрос с помощью http.client:352353```python354>>> # Это создаёт HTTP-сообщение.355>>> # с содержимым BODY в качестве вложенного представления356>>> # для ресурса http://localhost:8080/file357...358>>> import http.client359>>> BODY = "***filecontents***"360>>> conn = http.client.HTTPConnection("localhost", 8080)361>>> conn.request("PUT", "/file", BODY)362>>> response = conn.getresponse()363>>> print(response.status, response.reason)364200, OK365```366367## 21.12.4. Объекты HTTPMessage368369Экземпляр `http.client.HTTPMessage` содержит заголовки из HTTP ответа. Он реализован с помощью класса [`email.message.Message`](https://python-all.ru/3.6/library/email.compat32-message.html#email.message.Message).370