20.7. httplib – клиент протокола HTTP¶httplib – HTTP protocol client

20.7.1. Объекты HTTPConnection¶HTTPConnection Objects

Экземпляры HTTPConnection имеют следующие методы:

HTTPConnection.request(method, url[, body[, headers]])¶

Этот метод отправляет запрос на сервер, используя HTTP-метод method и селектор url. Если аргумент body присутствует, он должен быть строкой с данными, которые будут отправлены после заголовков. Альтернативно, это может быть открытый файловый объект; в этом случае отправляется содержимое файла. Этот файловый объект должен поддерживать методы fileno() и read(). Аргумент headers должен быть отображением (mapping) дополнительных HTTP-заголовков для отправки вместе с запросом.

Если заголовок не указан в headers, заголовок Content-Length добавляется автоматически для всех методов, если длина тела может быть определена – либо из длины представления str, либо из указанного размера файла на диске. Если body равен None, заголовок не устанавливается, за исключением методов, которые ожидают тело (PUT, POST и PATCH); в этом случае он устанавливается в 0.

Изменено в версии 2.6: body может быть файловым объектом.

HTTPConnection.getresponse()¶

Должен вызываться после отправки запроса для получения ответа от сервера. Возвращает экземпляр HTTPResponse.

Примечание

Обратите внимание: необходимо прочитать весь ответ, прежде чем отправлять новый запрос на сервер.

HTTPConnection.set_debuglevel(level)¶

Устанавливает уровень отладки (количество выводимой отладочной информации). Уровень отладки по умолчанию – 0, то есть отладочная информация не выводится.

HTTPConnection.set_tunnel(host, port=None, headers=None)¶

Устанавливает хост и порт для HTTP Connect Tunnelling. Обычно используется, когда требуется выполнить HTTPS-соединение через прокси-сервер.

Аргумент headers должен быть отображением дополнительных HTTP-заголовков, отправляемых с запросом CONNECT.

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

HTTPConnection.connect()¶

Подключается к серверу, указанному при создании объекта.

HTTPConnection.close()¶

Закрывает соединение с сервером.

В качестве альтернативы использованию описанного выше метода request() вы также можете отправлять запрос пошагово, используя четыре функции, приведённые ниже.

HTTPConnection.putrequest(request, selector[, skip_host[, skip_accept_encoding]])¶

Это должен быть первый вызов после установления соединения с сервером. Он отправляет на сервер строку, состоящую из строки request, строки selector и версии HTTP (HTTP/1.1). Чтобы отключить автоматическую отправку заголовков Host: или Accept-Encoding: (например, для принятия дополнительных кодировок содержимого), укажите skip_host или skip_accept_encoding с отличными от False значениями.

Изменено в версии 2.4: skip_accept_encoding аргумент добавлен.

HTTPConnection.putheader(header, argument[, ...])¶

Отправляет заголовок в стиле RFC 822 на сервер. Он отправляет строку, состоящую из заголовка, двоеточия, пробела и первого аргумента. Если заданы дополнительные аргументы, отправляются строки продолжения, каждая из которых состоит из табуляции и аргумента.

HTTPConnection.endheaders(message_body=None)¶

Отправляет пустую строку серверу, сигнализируя об окончании заголовков. Необязательный аргумент message_body можно использовать для передачи тела сообщения, связанного с запросом. Тело сообщения будет отправлено в том же пакете, что и заголовки, если оно является строкой; в противном случае оно отправляется в отдельном пакете.

Изменено в версии 2.7: message_body был добавлен.

HTTPConnection.send(data)¶

Отправляет данные на сервер. Это следует использовать напрямую только после вызова метода endheaders() и до вызова getresponse().

20.7.2. Объекты HTTPResponse¶HTTPResponse Objects

Экземпляры HTTPResponse имеют следующие методы и атрибуты:

HTTPResponse.read([amt])¶

Читает и возвращает тело ответа, или до следующих amt байт.

HTTPResponse.getheader(name[, default])¶

Возвращает содержимое заголовка name или default, если соответствующий заголовок отсутствует.

HTTPResponse.getheaders()¶

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

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

HTTPResponse.fileno()¶

Возвращает fileno базового сокета.

HTTPResponse.msg¶

Экземпляр mimetools.Message, содержащий заголовки ответа.

HTTPResponse.version¶

Версия протокола HTTP, используемая сервером. 10 для HTTP/1.0, 11 для HTTP/1.1.

HTTPResponse.status¶

Код состояния, возвращаемый сервером.

HTTPResponse.reason¶

Фраза причины, возвращаемая сервером.

20.7.3. Примеры¶Examples

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

>>> import httplib
>>> conn = httplib.HTTPSConnection("www.python.org")
>>> conn.request("GET", "/")
>>> r1 = conn.getresponse()
>>> print r1.status, r1.reason
200 OK
>>> data1 = r1.read()
>>> conn.request("GET", "/")
>>> r2 = conn.getresponse()
>>> print r2.status, r2.reason
404 Not Found
>>> data2 = r2.read()
>>> conn.close()

Вот пример сеанса, в котором используется метод HEAD. Обратите внимание, что метод HEAD никогда не возвращает данные.

>>> import httplib
>>> conn = httplib.HTTPSConnection("www.python.org")
>>> conn.request("HEAD","/")
>>> res = conn.getresponse()
>>> print res.status, res.reason
200 OK
>>> data = res.read()
>>> print len(data)
0
>>> data == ''
True

Ниже приведён пример сеанса, показывающий, как отправлять POST запросы:

>>> import httplib, urllib
>>> params = urllib.urlencode({'@number': 12524, '@type': 'issue', '@action': 'show'})
>>> headers = {"Content-type": "application/x-www-form-urlencoded",
...            "Accept": "text/plain"}
>>> conn = httplib.HTTPConnection("bugs.python.org")
>>> conn.request("POST", "", params, headers)
>>> response = conn.getresponse()
>>> print response.status, response.reason
302 Found
>>> data = response.read()
>>> data
'Redirecting to <a href="http://bugs.python.org/issue12524">http://bugs.python.org/issue12524</a>'
>>> conn.close()

Клиентские запросы HTTP PUT очень похожи на запросы POST. Разница состоит только на стороне сервера: HTTP-сервер позволяет создавать ресурсы с помощью запроса PUT. Ниже приведён пример сеанса работы, показывающий, как выполнить запрос PUT с помощью httplib:

>>> # Это создаёт HTTP-сообщение.
>>> # с содержимым BODY в качестве вложенного представления
>>> # для ресурса http://localhost:8080/foobar
...
>>> import httplib
>>> BODY = "***filecontents***"
>>> conn = httplib.HTTPConnection("localhost", 8080)
>>> conn.request("PUT", "/file", BODY)
>>> response = conn.getresponse()
>>> print response.status, response.reason
200, OK