`http.server.md`

294 строк · 30.6 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.6/library/http.server.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# 21.22. [`http.server`](https://python-all.ru/3.6/library/http.server.html#module-http.server) – HTTP-серверы89**Исходный код:** [Lib/http/server.py](https://python-all.ru/src/3.6/Lib/http/server.py)1011---1213Этот модуль определяет классы для реализации HTTP-серверов (веб-серверов).1415> **Предупреждение**16>17> [`http.server`](https://python-all.ru/3.6/library/http.server.html#module-http.server) не рекомендуется для промышленного использования. Он реализует только базовые проверки безопасности.1819Один класс, [`HTTPServer`](https://python-all.ru/3.6/library/http.server.html#http.server.HTTPServer), является подклассом [`socketserver.TCPServer`](https://python-all.ru/3.6/library/socketserver.html#socketserver.TCPServer). Он создает HTTP-сокет, прослушивает его и передает запросы обработчику. Код для создания и запуска сервера выглядит так:2021```python22def run(server_class=HTTPServer, handler_class=BaseHTTPRequestHandler):23    server_address = ('', 8000)24    httpd = server_class(server_address, handler_class)25    httpd.serve_forever()26```2728#### `class http.server.HTTPServer(server_address, RequestHandlerClass)`2930Этот класс расширяет класс [`TCPServer`](https://python-all.ru/3.6/library/socketserver.html#socketserver.TCPServer), сохраняя адрес сервера в переменных экземпляра с именами `server_name` и `server_port`. Сервер доступен через обработчик, обычно через переменную экземпляра `server` обработчика.3132При создании экземпляра [`HTTPServer`](https://python-all.ru/3.6/library/http.server.html#http.server.HTTPServer) необходимо передать *RequestHandlerClass*, для которого данный модуль предоставляет три различных варианта:3334#### `class http.server.BaseHTTPRequestHandler(request, client_address, server)`3536Этот класс используется для обработки HTTP-запросов, поступающих на сервер. Сам по себе он не может отвечать на реальные HTTP-запросы; его нужно подклассифицировать для обработки каждого метода запроса (например, GET или POST). [`BaseHTTPRequestHandler`](https://python-all.ru/3.6/library/http.server.html#http.server.BaseHTTPRequestHandler) предоставляет ряд переменных класса и экземпляра, а также методы для использования подклассами.3738Обработчик разбирает запрос и заголовки, затем вызывает метод, соответствующий типу запроса. Имя метода формируется из запроса. Например, для метода запроса `SPAM` будет вызван метод `do_SPAM()` без аргументов. Вся соответствующая информация хранится в переменных экземпляра обработчика. Подклассам не нужно переопределять или расширять метод [`__init__()`](https://python-all.ru/3.6/reference/datamodel.html#object.__init__).3940[`BaseHTTPRequestHandler`](https://python-all.ru/3.6/library/http.server.html#http.server.BaseHTTPRequestHandler) имеет следующие переменные экземпляра:4142#### `client_address`4344Содержит кортеж вида `(host, port)`, относящийся к адресу клиента.4546#### `server`4748Содержит экземпляр сервера.4950#### `close_connection`5152Логическое значение, которое следует установить до того, как [`handle_one_request()`](https://python-all.ru/3.6/library/http.server.html#http.server.BaseHTTPRequestHandler.handle_one_request) вернёт результат. Оно указывает, ожидается ли ещё один запрос или соединение следует закрыть.5354#### `requestline`5556Содержит строковое представление HTTP-строки запроса. Завершающий CRLF удаляется. Этот атрибут должен быть установлен [`handle_one_request()`](https://python-all.ru/3.6/library/http.server.html#http.server.BaseHTTPRequestHandler.handle_one_request). Если ни одна допустимая строка запроса не была обработана, его следует установить в пустую строку.5758#### `command`5960Содержит команду (тип запроса). Например, `'GET'`.6162#### `path`6364Содержит путь запроса.6566#### `request_version`6768Содержит строку версии из запроса. Например, `'HTTP/1.0'`.6970#### `headers`7172Содержит экземпляр класса, заданного переменной класса [`MessageClass`](https://python-all.ru/3.6/library/http.server.html#http.server.BaseHTTPRequestHandler.MessageClass). Этот экземпляр разбирает и управляет заголовками HTTP-запроса. Функция `parse_headers()` из [`http.client`](https://python-all.ru/3.6/library/http.client.html#module-http.client) используется для разбора заголовков, и она требует, чтобы HTTP-запрос предоставлял корректный заголовок в стиле [**RFC 2822**](https://python-all.ru/3.6/library/http.server.html).7374#### `rfile`7576Входной поток [`io.BufferedIOBase`](https://python-all.ru/3.6/library/io.html#io.BufferedIOBase), готовый к чтению с начала необязательных входных данных.7778#### `wfile`7980Содержит выходной поток для записи ответа обратно клиенту. При записи в этот поток необходимо правильно соблюдать протокол HTTP для обеспечения успешного взаимодействия с HTTP-клиентами.8182Изменено в версии 3.6: Это поток [`io.BufferedIOBase`](https://python-all.ru/3.6/library/io.html#io.BufferedIOBase).8384[`BaseHTTPRequestHandler`](https://python-all.ru/3.6/library/http.server.html#http.server.BaseHTTPRequestHandler) имеет следующие атрибуты:8586#### `server_version`8788Задаёт версию серверного программного обеспечения. Возможно, вы захотите переопределить это. Формат – несколько строк, разделённых пробелами, где каждая строка имеет вид имя\[/версия\]. Например, `'BaseHTTP/0.2'`.8990#### `sys_version`9192Содержит версию системы Python в форме, пригодной для использования методом [`version_string`](https://python-all.ru/3.6/library/http.server.html#http.server.BaseHTTPRequestHandler.version_string) и классовой переменной [`server_version`](https://python-all.ru/3.6/library/http.server.html#http.server.BaseHTTPRequestHandler.server_version). Например, `'Python/1.4'`.9394#### `error_message_format`9596Задаёт строку формата, которая должна использоваться методом [`send_error()`](https://python-all.ru/3.6/library/http.server.html#http.server.BaseHTTPRequestHandler.send_error) для формирования ответа об ошибке клиенту. Строка по умолчанию заполняется переменными из [`responses`](https://python-all.ru/3.6/library/http.server.html#http.server.BaseHTTPRequestHandler.responses) на основе кода состояния, переданного в [`send_error()`](https://python-all.ru/3.6/library/http.server.html#http.server.BaseHTTPRequestHandler.send_error).9798#### `error_content_type`99100Задаёт HTTP-заголовок Content-Type ответов об ошибках, отправляемых клиенту. Значение по умолчанию – `'text/html'`.101102#### `protocol_version`103104Определяет версию HTTP-протокола, используемую в ответах. Если установлено в `'HTTP/1.1'`, сервер будет разрешать постоянные HTTP-соединения; однако сервер *должен* затем включать точный заголовок `Content-Length` (используя [`send_header()`](https://python-all.ru/3.6/library/http.server.html#http.server.BaseHTTPRequestHandler.send_header)) во все свои ответы клиентам. Для обратной совместимости по умолчанию используется `'HTTP/1.0'`.105106#### `MessageClass`107108Задаёт класс, подобный [`email.message.Message`](https://python-all.ru/3.6/library/email.compat32-message.html#email.message.Message), для разбора HTTP-заголовков. Обычно он не переопределяется и по умолчанию равен `http.client.HTTPMessage`.109110#### `responses`111112Этот атрибут содержит соответствие целочисленных кодов ошибок кортежам из двух элементов – короткого и длинного сообщения. Например, `{code: (shortmessage, longmessage)}`. Обычно *shortmessage* используется как ключ *message* в ответе об ошибке, а *longmessage* – как ключ *explain*. Он используется методами [`send_response_only()`](https://python-all.ru/3.6/library/http.server.html#http.server.BaseHTTPRequestHandler.send_response_only) и [`send_error()`](https://python-all.ru/3.6/library/http.server.html#http.server.BaseHTTPRequestHandler.send_error).113114Экземпляр [`BaseHTTPRequestHandler`](https://python-all.ru/3.6/library/http.server.html#http.server.BaseHTTPRequestHandler) имеет следующие методы:115116#### `handle()`117118Вызывает [`handle_one_request()`](https://python-all.ru/3.6/library/http.server.html#http.server.BaseHTTPRequestHandler.handle_one_request) один раз (или, если включены постоянные соединения, несколько раз) для обработки входящих HTTP-запросов. Этот метод не требуется переопределять; вместо этого следует реализовать соответствующие методы `do_*()` .119120#### `handle_one_request()`121122Этот метод разбирает и направляет запрос соответствующему методу `do_*()`. Его не требуется переопределять.123124#### `handle_expect_100()`125126Когда совместимый с HTTP/1.1 сервер получает заголовок запроса `Expect: 100-continue`, он отвечает заголовком `100 Continue`, за которым следуют заголовки `200 OK`. Этот метод можно переопределить, чтобы вызвать ошибку, если сервер не хочет, чтобы клиент продолжал. Например, сервер может решить отправить `417 Expectation Failed` в качестве заголовка ответа и `return False`.127128Новое в версии 3.2.129130#### `send_error(code, message=None, explain=None)`131132Отправляет и записывает в журнал полный ответ об ошибке клиенту. Числовой код *code* задаёт код HTTP-ошибки, а *message* – необязательное короткое, понятное человеку описание ошибки. Аргумент *explain* можно использовать для предоставления более подробной информации об ошибке; он будет отформатирован с использованием атрибута [`error_message_format`](https://python-all.ru/3.6/library/http.server.html#http.server.BaseHTTPRequestHandler.error_message_format) и отправлен после полного набора заголовков в качестве тела ответа. Атрибут [`responses`](https://python-all.ru/3.6/library/http.server.html#http.server.BaseHTTPRequestHandler.responses) содержит значения по умолчанию для *message* и *explain*, которые будут использованы, если значение не указано; для неизвестных кодов значением по умолчанию для обоих является строка `???`. Тело будет пустым, если метод HEAD или код ответа является одним из следующих: `1xx`, `204 No Content`, `205 Reset Content`, `304 Not Modified`.133134Изменено в версии 3.4: Ответ об ошибке включает заголовок Content-Length. Добавлен аргумент *explain*.135136#### `send_response(code, message=None)`137138Добавляет заголовок ответа в буфер заголовков и записывает в журнал принятый запрос. Строка состояния HTTP записывается во внутренний буфер, за которым следуют заголовки *Server* и *Date*. Значения этих двух заголовков берутся из методов [`version_string()`](https://python-all.ru/3.6/library/http.server.html#http.server.BaseHTTPRequestHandler.version_string) и [`date_time_string()`](https://python-all.ru/3.6/library/http.server.html#http.server.BaseHTTPRequestHandler.date_time_string) соответственно. Если сервер не собирается отправлять другие заголовки с помощью метода [`send_header()`](https://python-all.ru/3.6/library/http.server.html#http.server.BaseHTTPRequestHandler.send_header), то после [`send_response()`](https://python-all.ru/3.6/library/http.server.html#http.server.BaseHTTPRequestHandler.send_response) следует вызов [`end_headers()`](https://python-all.ru/3.6/library/http.server.html#http.server.BaseHTTPRequestHandler.end_headers) .139140Изменено в версии 3.3: Заголовки сохраняются во внутреннем буфере, и [`end_headers()`](https://python-all.ru/3.6/library/http.server.html#http.server.BaseHTTPRequestHandler.end_headers) должен вызываться явно.141142#### `send_header(keyword, value)`143144Добавляет HTTP-заголовок во внутренний буфер, который будет записан в выходной поток при вызове [`end_headers()`](https://python-all.ru/3.6/library/http.server.html#http.server.BaseHTTPRequestHandler.end_headers) или [`flush_headers()`](https://python-all.ru/3.6/library/http.server.html#http.server.BaseHTTPRequestHandler.flush_headers). Параметр *keyword* должен задавать ключевое слово заголовка, а *value* – его значение. Обратите внимание, что после завершения вызовов send\_header [`end_headers()`](https://python-all.ru/3.6/library/http.server.html#http.server.BaseHTTPRequestHandler.end_headers) ДОЛЖЕН БЫТЬ ВЫЗВАН для завершения операции.145146Изменено в версии 3.2: Заголовки сохраняются во внутреннем буфере.147148#### `send_response_only(code, message=None)`149150Отправляет только заголовок ответа, используется в случаях, когда сервер отправляет клиенту ответ `100 Continue`. Заголовки не буферизуются и отправляются непосредственно в выходной поток. Если *message* не указан, отправляется HTTP-сообщение, соответствующее коду ответа *code*.151152Новое в версии 3.2.153154#### `end_headers()`155156Добавляет пустую строку (обозначающую конец HTTP-заголовков в ответе) в буфер заголовков и вызывает [`flush_headers()`](https://python-all.ru/3.6/library/http.server.html#http.server.BaseHTTPRequestHandler.flush_headers).157158Изменено в версии 3.2: Буферизированные заголовки записываются в выходной поток.159160#### `flush_headers()`161162Наконец отправляет заголовки в выходной поток и очищает внутренний буфер заголовков.163164Новое в версии 3.3.165166#### `log_request(code='-', size='-')`167168Записывает в журнал принятый (успешный) запрос. Параметр *code* должен задавать числовой код HTTP, связанный с ответом. Если размер ответа доступен, его следует передать как параметр *size*.169170#### `log_error(...)`171172Записывает в журнал ошибку, когда запрос не может быть выполнен. По умолчанию передаёт сообщение в [`log_message()`](https://python-all.ru/3.6/library/http.server.html#http.server.BaseHTTPRequestHandler.log_message), поэтому принимает те же аргументы (*format* и дополнительные значения).173174#### `log_message(format, ...)`175176Записывает произвольное сообщение в `sys.stderr`. Обычно этот метод переопределяют, чтобы создать собственные механизмы логирования ошибок. Аргумент *format* – это стандартная форматная строка в стиле printf, в которую дополнительные аргументы [`log_message()`](https://python-all.ru/3.6/library/http.server.html#http.server.BaseHTTPRequestHandler.log_message) подставляются в качестве входных данных для форматирования. IP-адрес клиента и текущая дата и время добавляются в начало каждого сообщения.177178#### `version_string()`179180Возвращает строку версии серверного программного обеспечения. Это комбинация атрибутов [`server_version`](https://python-all.ru/3.6/library/http.server.html#http.server.BaseHTTPRequestHandler.server_version) и [`sys_version`](https://python-all.ru/3.6/library/http.server.html#http.server.BaseHTTPRequestHandler.sys_version).181182#### `date_time_string(timestamp=None)`183184Возвращает дату и время, заданные *timestamp* (который должен быть `None` или в формате, возвращаемом [`time.time()`](https://python-all.ru/3.6/library/time.html#time.time)), отформатированные для заголовка сообщения. Если *timestamp* опущен, используются текущие дата и время.185186Результат выглядит как `'Sun, 06 Nov 1994 08:49:37 GMT'`.187188#### `log_date_time_string()`189190Возвращает текущие дату и время, отформатированные для логирования.191192#### `address_string()`193194Возвращает адрес клиента.195196Изменено в версии 3.3: Ранее выполнялся поиск по имени. Чтобы избежать задержек разрешения имён, теперь всегда возвращается IP-адрес.197198#### `class http.server.SimpleHTTPRequestHandler(request, client_address, server)`199200Этот класс обслуживает файлы из текущего каталога и подкаталогов, напрямую отображая структуру каталогов на HTTP-запросы.201202Бо́льшая часть работы, например разбор запроса, выполняется базовым классом [`BaseHTTPRequestHandler`](https://python-all.ru/3.6/library/http.server.html#http.server.BaseHTTPRequestHandler). Этот класс реализует функции [`do_GET()`](https://python-all.ru/3.6/library/http.server.html#http.server.SimpleHTTPRequestHandler.do_GET) и [`do_HEAD()`](https://python-all.ru/3.6/library/http.server.html#http.server.SimpleHTTPRequestHandler.do_HEAD).203204Следующие атрибуты определены на уровне класса [`SimpleHTTPRequestHandler`](https://python-all.ru/3.6/library/http.server.html#http.server.SimpleHTTPRequestHandler):205206#### `server_version`207208Это будет `"SimpleHTTP/" + __version__`, где `__version__` определён на уровне модуля.209210#### `extensions_map`211212Словарь, сопоставляющий суффиксы с MIME-типами. По умолчанию обозначается пустой строкой и считается `application/octet-stream`. Сопоставление используется без учёта регистра, поэтому должно содержать только ключи в нижнем регистре.213214Класс [`SimpleHTTPRequestHandler`](https://python-all.ru/3.6/library/http.server.html#http.server.SimpleHTTPRequestHandler) определяет следующие методы:215216#### `do_HEAD()`217218Этот метод обслуживает тип запроса `'HEAD'`: он отправляет заголовки, которые отправил бы для эквивалентного запроса `GET`. Смотрите метод [`do_GET()`](https://python-all.ru/3.6/library/http.server.html#http.server.SimpleHTTPRequestHandler.do_GET) для более полного объяснения возможных заголовков.219220#### `do_GET()`221222Запрос сопоставляется с локальным файлом путём интерпретации запроса как пути относительно текущего рабочего каталога.223224Если запрос был сопоставлен с каталогом, то в этом каталоге ищется файл с именем `index.html` или `index.htm` (именно в таком порядке). Если файл найден, возвращается его содержимое; в противном случае формируется список содержимого каталога вызовом метода `list_directory()`. Этот метод использует [`os.listdir()`](https://python-all.ru/3.6/library/os.html#os.listdir) для обхода каталога и возвращает ответ с ошибкой `404`, если [`listdir()`](https://python-all.ru/3.6/library/os.html#os.listdir) завершается неудачей.225226Если запрос был сопоставлен файлу, он открывается и содержимое возвращается. Любое исключение [`OSError`](https://python-all.ru/3.6/library/exceptions.html#OSError) при открытии запрошенного файла отображается в ошибку `404`, `'File not found'`. В противном случае тип содержимого определяется вызовом метода `guess_type()`, который, в свою очередь, использует переменную *extensions\_map*.227228Выводится заголовок `'Content-type:'` с определённым типом содержимого, за которым следуют заголовок `'Content-Length:'` с размером файла и заголовок `'Last-Modified:'` со временем изменения файла.229230Затем следует пустая строка, обозначающая конец заголовков, и после этого выводится содержимое файла. Если MIME-тип файла начинается с `text/`, файл открывается в текстовом режиме; в противном случае используется двоичный режим.231232Для примера использования обратитесь к реализации вызова функции [`test()`](https://python-all.ru/3.6/library/test.html#module-test) в модуле [`http.server`](https://python-all.ru/3.6/library/http.server.html#module-http.server).233234Класс [`SimpleHTTPRequestHandler`](https://python-all.ru/3.6/library/http.server.html#http.server.SimpleHTTPRequestHandler) можно использовать следующим образом для создания очень простого веб-сервера, раздающего файлы из текущего каталога:235236```python237import http.server238import socketserver239240PORT = 8000241242Handler = http.server.SimpleHTTPRequestHandler243244with socketserver.TCPServer(("", PORT), Handler) as httpd:245    print("serving at port", PORT)246    httpd.serve_forever()247```248249[`http.server`](https://python-all.ru/3.6/library/http.server.html#module-http.server) также можно вызвать напрямую с помощью ключа [`-m`](https://python-all.ru/3.6/using/cmdline.html#cmdoption-m) интерпретатора с аргументом `port number`. Как и в предыдущем примере, это обслуживает файлы относительно текущего каталога:250251```python252python -m http.server 8000253```254255По умолчанию сервер привязывается ко всем интерфейсам. Опция `-b/--bind`\\nуказывает конкретный адрес, к которому он должен привязываться. Например,\\nследующая команда заставляет сервер привязываться только к localhost:256257```python258python -m http.server 8000 --bind 127.0.0.1259```260261Новое в версии 3.4: Был введён аргумент `--bind`.262263#### `class http.server.CGIHTTPRequestHandler(request, client_address, server)`264265Этот класс используется для обслуживания как файлов, так и вывода CGI-скриптов из текущего каталога и подкаталогов. Обратите внимание, что отображение иерархической структуры HTTP на локальную структуру каталогов выполняется точно так же, как в [`SimpleHTTPRequestHandler`](https://python-all.ru/3.6/library/http.server.html#http.server.SimpleHTTPRequestHandler).266267> **Примечание**268>269> CGI-скрипты, запускаемые классом [`CGIHTTPRequestHandler`](https://python-all.ru/3.6/library/http.server.html#http.server.CGIHTTPRequestHandler), не могут выполнять перенаправления (HTTP код 302), потому что код 200 (вывод скрипта следует) отправляется до выполнения CGI-скрипта. Это опережает код состояния.270271Однако класс будет запускать CGI-скрипт вместо того, чтобы отдавать его как файл, если он определит, что это CGI-скрипт. Используются только каталогизированные CGI – другая распространённая конфигурация сервера (обработка специальных расширений как обозначающих CGI-скрипты) не применяется.272273Функции `do_GET()` и `do_HEAD()` изменены таким образом, чтобы запускать CGI-скрипты и выдавать их результат вместо отдачи файлов, если запрос ведёт в каталог, расположенный ниже пути `cgi_directories`.274275Класс [`CGIHTTPRequestHandler`](https://python-all.ru/3.6/library/http.server.html#http.server.CGIHTTPRequestHandler) определяет следующий элемент данных:276277#### `cgi_directories`278279По умолчанию имеет значение `['/cgi-bin', '/htbin']` и описывает каталоги, которые следует считать содержащими CGI-скрипты.280281Класс [`CGIHTTPRequestHandler`](https://python-all.ru/3.6/library/http.server.html#http.server.CGIHTTPRequestHandler) определяет следующий метод:282283#### `do_POST()`284285Этот метод обслуживает запросы типа `'POST'`, разрешённые только для CGI- скриптов. При попытке выполнить POST на не-CGI URL выводится ошибка 501: «Can only POST to CGI scripts».286287Обратите внимание: из соображений безопасности CGI-скрипты будут запускаться с UID пользователя nobody. Проблемы с CGI-скриптом приведут к ошибке 403.288289[`CGIHTTPRequestHandler`](https://python-all.ru/3.6/library/http.server.html#http.server.CGIHTTPRequestHandler) можно включить в командной строке, передав параметр `--cgi`:290291```python292python -m http.server --cgi 8000293```294