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

http.client.md

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

1> **Источник:** https://python-all.ru/3.0/library/http.client.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# `http.client` – клиент протокола HTTP89Этот модуль определяет классы, реализующие клиентскую сторону протоколов HTTP и HTTPS. Обычно он не используется напрямую – модуль [`urllib.request`](https://python-all.ru/3.0/library/urllib.request.html#module-urllib.request) применяет его для обработки URL, использующих HTTP и HTTPS.1011> **Примечание**12>13> Поддержка HTTPS доступна только в том случае, если модуль [`socket`](https://python-all.ru/3.0/library/socket.html#module-socket) был скомпилирован с поддержкой SSL.1415Модуль предоставляет следующие классы:1617#### `[http.client.HTTPConnection]class http.client.HTTPConnection(host[, port[, strict[, timeout]]])`1819Экземпляр [`HTTPConnection`](https://python-all.ru/3.0/library/http.client.html#http.client.HTTPConnection) представляет одну транзакцию с HTTP-сервером. Его следует создавать, передавая хост и необязательный номер порта. Если номер порта не передан, порт извлекается из строки хоста, если она имеет вид `host:port`; в противном случае используется порт HTTP по умолчанию (80). Если True, необязательный параметр *strict* (по умолчанию ложное значение) вызывает `BadStatusLine`, если строка состояния не может быть разобрана как допустимая строка состояния HTTP/1.0 или 1.1. Если задан необязательный параметр *timeout*, блокирующие операции (например, попытки соединения) будут прерваны по истечении этого количества секунд (если он не задан, используется глобальная настройка таймаута по умолчанию).2021Например, следующие вызовы создают экземпляры, подключающиеся к одному и тому же серверу по одному и тому же хосту и порту:2223```python24>>> h1 = http.client.HTTPConnection('www.cwi.nl')25>>> h2 = http.client.HTTPConnection('www.cwi.nl:80')26>>> h3 = http.client.HTTPConnection('www.cwi.nl', 80)27>>> h3 = http.client.HTTPConnection('www.cwi.nl', 80, timeout=10)28```2930#### `[http.client.HTTPSConnection]class http.client.HTTPSConnection(host[, port[, key_file[, cert_file[, strict[, timeout]]]]])`3132Подкласс [`HTTPConnection`](https://python-all.ru/3.0/library/http.client.html#http.client.HTTPConnection), использующий SSL для связи с защищёнными серверами. Порт по умолчанию: `443`. *key\_file* – это имя PEM-файла, содержащего ваш закрытый ключ. *cert\_file* – это PEM-файл цепочки сертификатов.3334> **Предупреждение**35>36> Проверка сертификатов не выполняется!3738#### `[http.client.HTTPResponse]class http.client.HTTPResponse(sock[, debuglevel=0][, strict=0])`3940Класс, экземпляры которого возвращаются при успешном подключении. Не создаётся напрямую пользователем.4142При необходимости генерируются следующие исключения:4344#### `[http.client.HTTPException]exception http.client.HTTPException`4546Базовый класс остальных исключений этого модуля. Является подклассом4748[`Exception`](https://python-all.ru/3.0/library/exceptions.html#exceptions.Exception)4950.5152#### `[http.client.NotConnected]exception http.client.NotConnected`5354Подкласс5556[`HTTPException`](https://python-all.ru/3.0/library/http.client.html#http.client.HTTPException)5758.5960#### `[http.client.InvalidURL]exception http.client.InvalidURL`6162Подкласс6364[`HTTPException`](https://python-all.ru/3.0/library/http.client.html#http.client.HTTPException)6566; возбуждается, если указан порт, но он не является числом или пуст.6768#### `[http.client.UnknownProtocol]exception http.client.UnknownProtocol`6970Подкласс7172[`HTTPException`](https://python-all.ru/3.0/library/http.client.html#http.client.HTTPException)7374.7576#### `[http.client.UnknownTransferEncoding]exception http.client.UnknownTransferEncoding`7778Подкласс7980[`HTTPException`](https://python-all.ru/3.0/library/http.client.html#http.client.HTTPException)8182.8384#### `[http.client.UnimplementedFileMode]exception http.client.UnimplementedFileMode`8586Подкласс8788[`HTTPException`](https://python-all.ru/3.0/library/http.client.html#http.client.HTTPException)8990.9192#### `[http.client.IncompleteRead]exception http.client.IncompleteRead`9394Подкласс9596[`HTTPException`](https://python-all.ru/3.0/library/http.client.html#http.client.HTTPException)9798.99100#### `[http.client.ImproperConnectionState]exception http.client.ImproperConnectionState`101102Подкласс103104[`HTTPException`](https://python-all.ru/3.0/library/http.client.html#http.client.HTTPException)105106.107108#### `[http.client.CannotSendRequest]exception http.client.CannotSendRequest`109110Подкласс111112[`ImproperConnectionState`](https://python-all.ru/3.0/library/http.client.html#http.client.ImproperConnectionState)113114.115116#### `[http.client.CannotSendHeader]exception http.client.CannotSendHeader`117118Подкласс119120[`ImproperConnectionState`](https://python-all.ru/3.0/library/http.client.html#http.client.ImproperConnectionState)121122.123124#### `[http.client.ResponseNotReady]exception http.client.ResponseNotReady`125126Подкласс127128[`ImproperConnectionState`](https://python-all.ru/3.0/library/http.client.html#http.client.ImproperConnectionState)129130.131132#### `[http.client.BadStatusLine]exception http.client.BadStatusLine`133134Подкласс135136[`HTTPException`](https://python-all.ru/3.0/library/http.client.html#http.client.HTTPException)137138. Возникает, если сервер отвечает кодом состояния HTTP, который не удаётся распознать.139140Константы, определённые в этом модуле:141142#### `[http.client.HTTP_PORT]http.client.HTTP_PORT`143144Порт по умолчанию для протокола HTTP (всегда145146`80`147148).149150#### `[http.client.HTTPS_PORT]http.client.HTTPS_PORT`151152Порт по умолчанию для протокола HTTPS (всегда153154`443`155156).157158а также следующие константы для целочисленных кодов состояния:159160| Константа | Значение | Определение |161| --- | --- | --- |162| `CONTINUE` | `100` | HTTP/1.1, [RFC 2616, раздел 10.1.1](https://python-all.ru/3.0/library/http.client.html) |163| `SWITCHING_PROTOCOLS` | `101` | HTTP/1.1, [RFC 2616, раздел 10.1.2](https://python-all.ru/3.0/library/http.client.html) |164| `PROCESSING` | `102` | WEBDAV, [RFC 2518, раздел 10.1](https://python-all.ru/3.0/library/http.client.html) |165| `OK` | `200` | HTTP/1.1, [RFC 2616, раздел 10.2.1](https://python-all.ru/3.0/library/http.client.html) |166| `CREATED` | `201` | HTTP/1.1, [RFC 2616, раздел 10.2.2](https://python-all.ru/3.0/library/http.client.html) |167| `ACCEPTED` | `202` | HTTP/1.1, [RFC 2616, раздел 10.2.3](https://python-all.ru/3.0/library/http.client.html) |168| `NON_AUTHORITATIVE_INFORMATION` | `203` | HTTP/1.1, [RFC 2616, раздел 10.2.4](https://python-all.ru/3.0/library/http.client.html) |169| `NO_CONTENT` | `204` | HTTP/1.1, [RFC 2616, раздел 10.2.5](https://python-all.ru/3.0/library/http.client.html) |170| `RESET_CONTENT` | `205` | HTTP/1.1, [RFC 2616, раздел 10.2.6](https://python-all.ru/3.0/library/http.client.html) |171| `PARTIAL_CONTENT` | `206` | HTTP/1.1, [RFC 2616, раздел 10.2.7](https://python-all.ru/3.0/library/http.client.html) |172| `MULTI_STATUS` | `207` | WEBDAV [RFC 2518, раздел 10.2](https://python-all.ru/3.0/library/http.client.html) |173| `IM_USED` | `226` | Дельта-кодирование в HTTP, [**RFC 3229**](https://python-all.ru/3.0/library/http.client.html), раздел 10.4.1 |174| `MULTIPLE_CHOICES` | `300` | HTTP/1.1, [RFC 2616, раздел 10.3.1](https://python-all.ru/3.0/library/http.client.html) |175| `MOVED_PERMANENTLY` | `301` | HTTP/1.1, [RFC 2616, раздел 10.3.2](https://python-all.ru/3.0/library/http.client.html) |176| `FOUND` | `302` | HTTP/1.1, [RFC 2616, раздел 10.3.3](https://python-all.ru/3.0/library/http.client.html) |177| `SEE_OTHER` | `303` | HTTP/1.1, [RFC 2616, раздел 10.3.4](https://python-all.ru/3.0/library/http.client.html) |178| `NOT_MODIFIED` | `304` | HTTP/1.1, [RFC 2616, раздел 10.3.5](https://python-all.ru/3.0/library/http.client.html) |179| `USE_PROXY` | `305` | HTTP/1.1, [RFC 2616, раздел 10.3.6](https://python-all.ru/3.0/library/http.client.html) |180| `TEMPORARY_REDIRECT` | `307` | HTTP/1.1, [RFC 2616, раздел 10.3.8](https://python-all.ru/3.0/library/http.client.html) |181| `BAD_REQUEST` | `400` | HTTP/1.1, [RFC 2616, раздел 10.4.1](https://python-all.ru/3.0/library/http.client.html) |182| `UNAUTHORIZED` | `401` | HTTP/1.1, [RFC 2616, раздел 10.4.2](https://python-all.ru/3.0/library/http.client.html) |183| `PAYMENT_REQUIRED` | `402` | HTTP/1.1, [RFC 2616, раздел 10.4.3](https://python-all.ru/3.0/library/http.client.html) |184| `FORBIDDEN` | `403` | HTTP/1.1, [RFC 2616, раздел 10.4.4](https://python-all.ru/3.0/library/http.client.html) |185| `NOT_FOUND` | `404` | HTTP/1.1, [RFC 2616, раздел 10.4.5](https://python-all.ru/3.0/library/http.client.html) |186| `METHOD_NOT_ALLOWED` | `405` | HTTP/1.1, [RFC 2616, раздел 10.4.6](https://python-all.ru/3.0/library/http.client.html) |187| `NOT_ACCEPTABLE` | `406` | HTTP/1.1, [RFC 2616, раздел 10.4.7](https://python-all.ru/3.0/library/http.client.html) |188| `PROXY_AUTHENTICATION_REQUIRED` | `407` | HTTP/1.1, [RFC 2616, раздел 10.4.8](https://python-all.ru/3.0/library/http.client.html) |189| `REQUEST_TIMEOUT` | `408` | HTTP/1.1, [RFC 2616, раздел 10.4.9](https://python-all.ru/3.0/library/http.client.html) |190| `CONFLICT` | `409` | HTTP/1.1, [RFC 2616, раздел 10.4.10](https://python-all.ru/3.0/library/http.client.html) |191| `GONE` | `410` | HTTP/1.1, [RFC 2616, раздел 10.4.11](https://python-all.ru/3.0/library/http.client.html) |192| `LENGTH_REQUIRED` | `411` | HTTP/1.1, [RFC 2616, раздел 10.4.12](https://python-all.ru/3.0/library/http.client.html) |193| `PRECONDITION_FAILED` | `412` | HTTP/1.1, [RFC 2616, раздел 10.4.13](https://python-all.ru/3.0/library/http.client.html) |194| `REQUEST_ENTITY_TOO_LARGE` | `413` | HTTP/1.1, [RFC 2616, раздел 10.4.14](https://python-all.ru/3.0/library/http.client.html) |195| `REQUEST_URI_TOO_LONG` | `414` | HTTP/1.1, [RFC 2616, раздел 10.4.15](https://python-all.ru/3.0/library/http.client.html) |196| `UNSUPPORTED_MEDIA_TYPE` | `415` | HTTP/1.1, [RFC 2616, раздел 10.4.16](https://python-all.ru/3.0/library/http.client.html) |197| `REQUESTED_RANGE_NOT_SATISFIABLE` | `416` | HTTP/1.1, [RFC 2616, раздел 10.4.17](https://python-all.ru/3.0/library/http.client.html) |198| `EXPECTATION_FAILED` | `417` | HTTP/1.1, [RFC 2616, раздел 10.4.18](https://python-all.ru/3.0/library/http.client.html) |199| `UNPROCESSABLE_ENTITY` | `422` | WEBDAV, [RFC 2518, раздел 10.3](https://python-all.ru/3.0/library/http.client.html) |200| `LOCKED` | `423` | WEBDAV [RFC 2518, раздел 10.4](https://python-all.ru/3.0/library/http.client.html) |201| `FAILED_DEPENDENCY` | `424` | WEBDAV, [RFC 2518, раздел 10.5](https://python-all.ru/3.0/library/http.client.html) |202| `UPGRADE_REQUIRED` | `426` | Обновление HTTP до TLS, [**RFC 2817**](https://python-all.ru/3.0/library/http.client.html), раздел 6 |203| `INTERNAL_SERVER_ERROR` | `500` | HTTP/1.1, [RFC 2616, раздел 10.5.1](https://python-all.ru/3.0/library/http.client.html) |204| `NOT_IMPLEMENTED` | `501` | HTTP/1.1, [RFC 2616, раздел 10.5.2](https://python-all.ru/3.0/library/http.client.html) |205| `BAD_GATEWAY` | `502` | HTTP/1.1 [RFC 2616, раздел 10.5.3](https://python-all.ru/3.0/library/http.client.html) |206| `SERVICE_UNAVAILABLE` | `503` | HTTP/1.1, [RFC 2616, раздел 10.5.4](https://python-all.ru/3.0/library/http.client.html) |207| `GATEWAY_TIMEOUT` | `504` | HTTP/1.1 [RFC 2616, раздел 10.5.5](https://python-all.ru/3.0/library/http.client.html) |208| `HTTP_VERSION_NOT_SUPPORTED` | `505` | HTTP/1.1, [RFC 2616, раздел 10.5.6](https://python-all.ru/3.0/library/http.client.html) |209| `INSUFFICIENT_STORAGE` | `507` | WEBDAV, [RFC 2518, раздел 10.6](https://python-all.ru/3.0/library/http.client.html) |210| `NOT_EXTENDED` | `510` | Расширение HTTP Framework, [**RFC 2774**](https://python-all.ru/3.0/library/http.client.html), раздел 7 |211212#### `[http.client.responses]http.client.responses`213214Этот словарь сопоставляет коды состояния HTTP 1.1 с названиями W3C.215216Пример: `http.client.responses[http.client.NOT_FOUND]` – это `'Not Found'`.217218## Объекты HTTPConnection219220Экземпляры [`HTTPConnection`](https://python-all.ru/3.0/library/http.client.html#http.client.HTTPConnection) имеют следующие методы:221222#### `[http.client.HTTPConnection.request]HTTPConnection.request(method, url[, body[, headers]])`223224Этот метод отправляет запрос на сервер, используя HTTP-метод225226*method*227228и селектор229230*url*231232. Если аргумент233234*body*235236присутствует, он должен быть строкой с данными для отправки после заголовков. Или это может быть открытый файловый объект, в этом случае содержимое файла отправляется; этот файловый объект должен поддерживать методы237238`fileno()`239240и241242`read()`243244. Заголовок Content-Length устанавливается автоматически в правильное значение. Аргумент245246*headers*247248должен быть словарём дополнительных HTTP-заголовков для отправки вместе с запросом.249250#### `[http.client.HTTPConnection.getresponse]HTTPConnection.getresponse()`251252Должен вызываться после отправки запроса для получения ответа от сервера. Возвращает экземпляр [`HTTPResponse`](https://python-all.ru/3.0/library/http.client.html#http.client.HTTPResponse).253254> **Примечание**255>256> Обратите внимание: необходимо прочитать весь ответ, прежде чем отправлять новый запрос на сервер.257258#### `[http.client.HTTPConnection.set_debuglevel]HTTPConnection.set_debuglevel(level)`259260Устанавливает уровень отладки (количество выводимой отладочной информации). Уровень отладки по умолчанию –261262`0`263264, то есть отладочная информация не выводится.265266#### `[http.client.HTTPConnection.connect]HTTPConnection.connect()`267268Подключается к серверу, указанному при создании объекта.269270#### `[http.client.HTTPConnection.close]HTTPConnection.close()`271272Закрывает соединение с сервером.273274В качестве альтернативы описанному выше методу `request()` можно отправлять запрос пошагово, используя четыре функции ниже.275276#### `[http.client.HTTPConnection.putrequest]HTTPConnection.putrequest(request, selector[, skip_host[, skip_accept_encoding]])`277278Это должен быть первый вызов после установки соединения с сервером. Он отправляет серверу строку, состоящую из строки279280*request*281282, строки283284*selector*285286и версии HTTP (287288`HTTP/1.1`289290). Чтобы отключить автоматическую отправку заголовков291292`Host:`293294или295296`Accept-Encoding:`297298(например, для поддержки дополнительных кодировок содержимого), укажите299300*skip\_host*301302или303304*skip\_accept\_encoding*305306со значениями, отличными от False.307308#### `[http.client.HTTPConnection.putheader]HTTPConnection.putheader(header, argument[, ...])`309310Отправляет заголовок в стиле311312[**RFC 822**](https://python-all.ru/3.0/library/http.client.html)313314на сервер. Он отправляет строку, состоящую из заголовка, двоеточия, пробела и первого аргумента. Если заданы дополнительные аргументы, отправляются строки продолжения, каждая из которых состоит из табуляции и аргумента.315316#### `[http.client.HTTPConnection.endheaders]HTTPConnection.endheaders()`317318Отправляет пустую строку на сервер, сигнализируя об окончании заголовков.319320#### `[http.client.HTTPConnection.send]HTTPConnection.send(data)`321322Send data to the server. This should be used directly only after the323324[`endheaders()`](https://python-all.ru/3.0/library/http.client.html#http.client.HTTPConnection.endheaders)325326method has been called and before327328[`getresponse()`](https://python-all.ru/3.0/library/http.client.html#http.client.HTTPConnection.getresponse)329330is called.331332## Объекты HTTPResponse333334Экземпляры [`HTTPResponse`](https://python-all.ru/3.0/library/http.client.html#http.client.HTTPResponse) имеют следующие методы и атрибуты:335336#### `[http.client.HTTPResponse.read]HTTPResponse.read([amt])`337338Читает и возвращает тело ответа, или до следующих339340*amt*341342байт.343344#### `[http.client.HTTPResponse.getheader]HTTPResponse.getheader(name[, default])`345346Возвращает содержимое заголовка347348*name*349350или351352*default*353354, если соответствующий заголовок отсутствует.355356#### `[http.client.HTTPResponse.getheaders]HTTPResponse.getheaders()`357358Возвращает список кортежей (заголовок, значение).359360#### `[http.client.HTTPResponse.msg]HTTPResponse.msg`361362Экземпляр363364[`email.message.Message`](https://python-all.ru/3.0/library/email.message.html#email.message.Message)365366, содержащий заголовки ответа.367368#### `[http.client.HTTPResponse.version]HTTPResponse.version`369370Версия протокола HTTP, используемая сервером. 10 для HTTP/1.0, 11 для HTTP/1.1.371372#### `[http.client.HTTPResponse.status]HTTPResponse.status`373374Код состояния, возвращаемый сервером.375376#### `[http.client.HTTPResponse.reason]HTTPResponse.reason`377378Фраза причины, возвращаемая сервером.379380## Примеры381382Ниже приведён пример сеанса, использующего метод `GET`:383384```python385>>> import http.client386>>> conn = http.client.HTTPConnection("www.python.org")387>>> conn.request("GET", "/index.html")388>>> r1 = conn.getresponse()389>>> print(r1.status, r1.reason)390200 OK391>>> data1 = r1.read()392>>> conn.request("GET", "/parrot.spam")393>>> r2 = conn.getresponse()394>>> print(r2.status, r2.reason)395404 Not Found396>>> data2 = r2.read()397>>> conn.close()398```399400Ниже приведён пример сеанса, показывающий, как выполнять запросы `POST`:401402```python403>>> import http.client, urllib.parse404>>> params = urllib.parse.urlencode({'spam': 1, 'eggs': 2, 'bacon': 0})405>>> headers = {"Content-type": "application/x-www-form-urlencoded",406...            "Accept": "text/plain"}407>>> conn = http.client.HTTPConnection("musi-cal.mojam.com:80")408>>> conn.request("POST", "/cgi-bin/query", params, headers)409>>> response = conn.getresponse()410>>> print(response.status, response.reason)411200 OK412>>> data = response.read()413>>> conn.close()414```415