`http.server.md`

289 строк · 29.3 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.4/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.4/library/http.server.html#module-http.server) – HTTP-серверы89**Исходный код:** [Lib/http/server.py](https://python-all.ru/src/3.4/Lib/http/server.py)1011---1213Этот модуль определяет классы для реализации HTTP-серверов (веб-серверов).1415Один класс, [`HTTPServer`](https://python-all.ru/3.4/library/http.server.html#http.server.HTTPServer), является подклассом `socketserver.TCPServer`. Он создаёт HTTP-сокет и прослушивает его, направляя запросы обработчику. Код для создания и запуска сервера выглядит так:1617```python18def run(server_class=HTTPServer, handler_class=BaseHTTPRequestHandler):19    server_address = ('', 8000)20    httpd = server_class(server_address, handler_class)21    httpd.serve_forever()22```2324#### `class http.server.HTTPServer(server_address, RequestHandlerClass)`2526Этот класс расширяет класс `TCPServer`, сохраняя адрес сервера в переменных экземпляра `server_name` и `server_port`. Сервер доступен обработчику, обычно через переменную экземпляра `server` обработчика.2728При создании экземпляра [`HTTPServer`](https://python-all.ru/3.4/library/http.server.html#http.server.HTTPServer) необходимо передать *RequestHandlerClass*, для которого этот модуль предоставляет три различных варианта:2930#### `class http.server.BaseHTTPRequestHandler(request, client_address, server)`3132Этот класс используется для обработки HTTP-запросов, поступающих на сервер. Сам по себе он не может отвечать на реальные HTTP-запросы; его нужно наследовать, чтобы обрабатывать каждый метод запроса (например, GET или POST). [`BaseHTTPRequestHandler`](https://python-all.ru/3.4/library/http.server.html#http.server.BaseHTTPRequestHandler) предоставляет ряд переменных класса и экземпляра, а также методы для использования подклассами.3334Обработчик разбирает запрос и заголовки, затем вызывает метод, соответствующий типу запроса. Имя метода формируется из запроса. Например, для метода запроса `SPAM` будет вызван метод `do_SPAM()` без аргументов. Вся соответствующая информация хранится в переменных экземпляра обработчика. Подклассы не должны переопределять или расширять метод [`__init__()`](https://python-all.ru/3.4/reference/datamodel.html#object.__init__).3536[`BaseHTTPRequestHandler`](https://python-all.ru/3.4/library/http.server.html#http.server.BaseHTTPRequestHandler) имеет следующие переменные экземпляра:3738#### `client_address`3940Содержит кортеж вида `(host, port)`, относящийся к адресу клиента.4142#### `server`4344Содержит экземпляр сервера.4546#### `close_connection`4748Логическое значение, которое должно быть установлено до возврата [`handle_one_request()`](https://python-all.ru/3.4/library/http.server.html#http.server.BaseHTTPRequestHandler.handle_one_request), указывающее, ожидается ли ещё один запрос или соединение должно быть закрыто.4950#### `requestline`5152Содержит строковое представление строки HTTP-запроса. Завершающие символы CRLF удаляются. Этот атрибут должен устанавливаться методом [`handle_one_request()`](https://python-all.ru/3.4/library/http.server.html#http.server.BaseHTTPRequestHandler.handle_one_request). Если ни одна корректная строка запроса не была обработана, он должен быть установлен в пустую строку.5354#### `command`5556Содержит команду (тип запроса). Например, `'GET'`.5758#### `path`5960Содержит путь запроса.6162#### `request_version`6364Содержит строку версии из запроса. Например, `'HTTP/1.0'`.6566#### `headers`6768Содержит экземпляр класса, указанного переменной класса [`MessageClass`](https://python-all.ru/3.4/library/http.server.html#http.server.BaseHTTPRequestHandler.MessageClass). Этот экземпляр разбирает и управляет заголовками в HTTP-запросе. Функция `parse_headers()` из [`http.client`](https://python-all.ru/3.4/library/http.client.html#module-http.client) используется для разбора заголовков, и она требует, чтобы HTTP-запрос содержал корректный заголовок в стиле [**RFC 2822**](https://python-all.ru/3.4/library/http.server.html).6970#### `rfile`7172Содержит входной поток, находящийся в начале необязательных входных данных.7374#### `wfile`7576Содержит выходной поток для записи ответа обратно клиенту. При записи в этот поток необходимо строго соблюдать протокол HTTP.7778[`BaseHTTPRequestHandler`](https://python-all.ru/3.4/library/http.server.html#http.server.BaseHTTPRequestHandler) имеет следующие переменные класса:7980#### `server_version`8182Указывает версию серверного программного обеспечения. Возможно, потребуется переопределить это значение. Формат – несколько строк, разделённых пробелами, где каждая строка имеет вид имя\[/версия\]. Например, `'BaseHTTP/0.2'`.8384#### `sys_version`8586Содержит версию системы Python в форме, пригодной для использования методом [`version_string`](https://python-all.ru/3.4/library/http.server.html#http.server.BaseHTTPRequestHandler.version_string) и переменной класса [`server_version`](https://python-all.ru/3.4/library/http.server.html#http.server.BaseHTTPRequestHandler.server_version). Например, `'Python/1.4'`.8788#### `error_message_format`8990Задаёт строку форматирования для построения ответа об ошибке клиенту. В ней используются указатели формата в скобках с ключами, поэтому операнд формата должен быть словарём. Ключ *code* должен быть целым числом, задающим числовой код ошибки HTTP. *message* должен быть строкой, содержащей (подробное) сообщение об ошибке, а *explain* – объяснением кода ошибки. Значения по умолчанию для *message* и *explain* находятся в переменной класса [`responses`](https://python-all.ru/3.4/library/http.server.html#http.server.BaseHTTPRequestHandler.responses).9192#### `error_content_type`9394Задаёт HTTP-заголовок Content-Type для ответов об ошибках, отправляемых клиенту. Значение по умолчанию: `'text/html'`.9596#### `protocol_version`9798Задаёт версию протокола HTTP, используемую в ответах. Если установлено `'HTTP/1.1'`, сервер будет разрешать постоянные соединения; однако в этом случае сервер *должен* включать точный заголовок `Content-Length` (с помощью [`send_header()`](https://python-all.ru/3.4/library/http.server.html#http.server.BaseHTTPRequestHandler.send_header)) во все свои ответы клиентам. Для обратной совместимости по умолчанию используется `'HTTP/1.0'`.99100#### `MessageClass`101102Задаёт класс, похожий на [`email.message.Message`](https://python-all.ru/3.4/library/email.message.html#email.message.Message), для разбора HTTP-заголовков. Обычно его не переопределяют, и по умолчанию используется `http.client.HTTPMessage`.103104#### `responses`105106Эта переменная содержит отображение целочисленных кодов ошибок в кортежи из двух элементов, содержащие краткое и полное сообщения. Например, `{code: (shortmessage, longmessage)}`. *shortmessage* обычно используется как ключ *message* в ответе об ошибке, а *longmessage* – как ключ *explain* (см. переменную класса [`error_message_format`](https://python-all.ru/3.4/library/http.server.html#http.server.BaseHTTPRequestHandler.error_message_format)).107108Экземпляр [`BaseHTTPRequestHandler`](https://python-all.ru/3.4/library/http.server.html#http.server.BaseHTTPRequestHandler) имеет следующие методы:109110#### `handle()`111112Вызывает [`handle_one_request()`](https://python-all.ru/3.4/library/http.server.html#http.server.BaseHTTPRequestHandler.handle_one_request) один раз (или несколько, если включены постоянные соединения) для обработки входящих HTTP-запросов. Этот метод не нужно переопределять; вместо этого следует реализовать соответствующие методы `do_*()`.113114#### `handle_one_request()`115116Этот метод разбирает запрос и направляет его в соответствующий метод `do_*()`. Его не нужно переопределять.117118#### `handle_expect_100()`119120Когда сервер, совместимый с HTTP/1.1, получает заголовок запроса `Expect: 100-continue`, он отвечает заголовками `100 Continue`, а затем `200 OK`. Этот метод можно переопределить, чтобы вызвать ошибку, если сервер не хочет, чтобы клиент продолжал. Например, сервер может отправить `417 Expectation Failed` в качестве заголовка ответа и `return False`.121122Новое в версии 3.2.123124#### `send_error(code, message=None, explain=None)`125126Отправляет и журналирует полный ответ об ошибке клиенту. Числовой *code* задаёт код ошибки HTTP, а *message* – необязательное краткое, понятное человеку описание ошибки. Аргумент *explain* можно использовать для предоставления более подробной информации об ошибке; он будет отформатирован с помощью переменной класса [`error_message_format`](https://python-all.ru/3.4/library/http.server.html#http.server.BaseHTTPRequestHandler.error_message_format) и отправлен после полного набора заголовков как тело ответа. Переменная класса [`responses`](https://python-all.ru/3.4/library/http.server.html#http.server.BaseHTTPRequestHandler.responses) содержит значения по умолчанию для *message* и *explain*, которые используются, если не указано иное; для неизвестных кодов по умолчанию для обоих используется строка `???`.127128Изменено в версии 3.4: Ответ об ошибке включает заголовок Content-Length. Добавлен аргумент *explain*.129130#### `send_response(code, message=None)`131132Добавляет заголовок ответа в буфер заголовков и журналирует принятый запрос. Строка ответа HTTP записывается во внутренний буфер, за ней следуют заголовки *Server* и *Date*. Значения для этих двух заголовков берутся из методов [`version_string()`](https://python-all.ru/3.4/library/http.server.html#http.server.BaseHTTPRequestHandler.version_string) и [`date_time_string()`](https://python-all.ru/3.4/library/http.server.html#http.server.BaseHTTPRequestHandler.date_time_string) соответственно. Если сервер не собирается отправлять другие заголовки с помощью метода [`send_header()`](https://python-all.ru/3.4/library/http.server.html#http.server.BaseHTTPRequestHandler.send_header), то после [`send_response()`](https://python-all.ru/3.4/library/http.server.html#http.server.BaseHTTPRequestHandler.send_response) должен следовать вызов [`end_headers()`](https://python-all.ru/3.4/library/http.server.html#http.server.BaseHTTPRequestHandler.end_headers).133134Изменено в версии 3.3: Заголовки сохраняются во внутренний буфер, и [`end_headers()`](https://python-all.ru/3.4/library/http.server.html#http.server.BaseHTTPRequestHandler.end_headers) требуется вызывать явно.135136#### `send_header(keyword, value)`137138Добавляет HTTP-заголовок во внутренний буфер, который будет записан в выходной поток при вызове [`end_headers()`](https://python-all.ru/3.4/library/http.server.html#http.server.BaseHTTPRequestHandler.end_headers) или [`flush_headers()`](https://python-all.ru/3.4/library/http.server.html#http.server.BaseHTTPRequestHandler.flush_headers). *keyword* задаёт ключевое слово заголовка, а *value* – его значение. Обратите внимание: после выполнения всех вызовов send\_header [`end_headers()`](https://python-all.ru/3.4/library/http.server.html#http.server.BaseHTTPRequestHandler.end_headers) ДОЛЖЕН быть вызван для завершения операции.139140Изменено в версии 3.2: Заголовки сохраняются во внутреннем буфере.141142#### `send_response_only(code, message=None)`143144Отправляет только заголовок ответа; используется, когда сервер отправляет клиенту ответ `100 Continue`. Заголовки не буферизуются и отправляются напрямую в выходной поток. Если *message* не указан, отправляется HTTP-сообщение, соответствующее коду ответа *code*.145146Новое в версии 3.2.147148#### `end_headers()`149150Добавляет пустую строку (означающую конец HTTP-заголовков в ответе) в буфер заголовков и вызывает [`flush_headers()`](https://python-all.ru/3.4/library/http.server.html#http.server.BaseHTTPRequestHandler.flush_headers).151152Изменено в версии 3.2: Буферизированные заголовки записываются в выходной поток.153154#### `flush_headers()`155156Наконец отправляет заголовки в выходной поток и очищает внутренний буфер заголовков.157158Новое в версии 3.3.159160#### `log_request(code='-', size='-')`161162Записывает в журнал принятый (успешный) запрос. Параметр *code* должен задавать числовой код HTTP, связанный с ответом. Если размер ответа доступен, его следует передать как параметр *size*.163164#### `log_error(...)`165166Журналирует ошибку, если запрос не может быть выполнен. По умолчанию передаёт сообщение в [`log_message()`](https://python-all.ru/3.4/library/http.server.html#http.server.BaseHTTPRequestHandler.log_message), поэтому принимает те же аргументы (*format* и дополнительные значения).167168#### `log_message(format, ...)`169170Записывает произвольное сообщение в `sys.stderr`. Обычно этот метод переопределяют для создания собственных механизмов регистрации ошибок. Аргумент *format* – это стандартная printf-строка форматирования, к которой дополнительные аргументы [`log_message()`](https://python-all.ru/3.4/library/http.server.html#http.server.BaseHTTPRequestHandler.log_message) применяются как входные данные для форматирования. IP-адрес клиента и текущие дата и время добавляются в начало каждого сообщения.171172#### `version_string()`173174Возвращает строку версии серверного ПО. Она представляет собой комбинацию классовых переменных [`server_version`](https://python-all.ru/3.4/library/http.server.html#http.server.BaseHTTPRequestHandler.server_version) и [`sys_version`](https://python-all.ru/3.4/library/http.server.html#http.server.BaseHTTPRequestHandler.sys_version).175176#### `date_time_string(timestamp=None)`177178Возвращает дату и время, заданные *timestamp* (который должен быть None или в формате, возвращаемом [`time.time()`](https://python-all.ru/3.4/library/time.html#time.time)), отформатированные для заголовка сообщения. Если *timestamp* опущен, используются текущие дата и время.179180Результат выглядит как `'Sun, 06 Nov 1994 08:49:37 GMT'`.181182#### `log_date_time_string()`183184Возвращает текущие дату и время, отформатированные для логирования.185186#### `address_string()`187188Возвращает адрес клиента.189190Изменено в версии 3.3: Ранее выполнялся поиск по имени. Чтобы избежать задержек разрешения имён, теперь всегда возвращается IP-адрес.191192#### `class http.server.SimpleHTTPRequestHandler(request, client_address, server)`193194Этот класс обслуживает файлы из текущего каталога и подкаталогов, напрямую отображая структуру каталогов на HTTP-запросы.195196Большая часть работы, такая как разбор запроса, выполняется базовым классом [`BaseHTTPRequestHandler`](https://python-all.ru/3.4/library/http.server.html#http.server.BaseHTTPRequestHandler). Этот класс реализует функции [`do_GET()`](https://python-all.ru/3.4/library/http.server.html#http.server.SimpleHTTPRequestHandler.do_GET) и [`do_HEAD()`](https://python-all.ru/3.4/library/http.server.html#http.server.SimpleHTTPRequestHandler.do_HEAD).197198Следующие атрибуты определены как атрибуты класса [`SimpleHTTPRequestHandler`](https://python-all.ru/3.4/library/http.server.html#http.server.SimpleHTTPRequestHandler):199200#### `server_version`201202Это будет `"SimpleHTTP/" + __version__`, где `__version__` определена на уровне модуля.203204#### `extensions_map`205206Словарь, сопоставляющий расширения с MIME-типами. Значение по умолчанию обозначается пустой строкой и считается равным `application/octet-stream`. Сопоставление используется без учёта регистра, поэтому должно содержать только ключи в нижнем регистре.207208Класс [`SimpleHTTPRequestHandler`](https://python-all.ru/3.4/library/http.server.html#http.server.SimpleHTTPRequestHandler) определяет следующие методы:209210#### `do_HEAD()`211212This method serves the `'HEAD'` request type: it sends the headers it would send for the equivalent `GET` request. See the [`do_GET()`](https://python-all.ru/3.4/library/http.server.html#http.server.SimpleHTTPRequestHandler.do_GET) method for a more complete explanation of the possible headers.213214#### `do_GET()`215216Запрос сопоставляется с локальным файлом путём интерпретации запроса как пути относительно текущего рабочего каталога.217218Если запрос был сопоставлен с каталогом, то в нём ищется файл с именем `index.html` или `index.htm` (именно в таком порядке). Если файл найден, возвращается его содержимое; в противном случае формируется список содержимого каталога вызовом метода `list_directory()`. Этот метод использует [`os.listdir()`](https://python-all.ru/3.4/library/os.html#os.listdir) для просмотра каталога и возвращает ответ с ошибкой `404`, если [`listdir()`](https://python-all.ru/3.4/library/os.html#os.listdir) завершается неудачей.219220Если запрос был сопоставлен с файлом, он открывается и возвращается его содержимое. Любое исключение [`OSError`](https://python-all.ru/3.4/library/exceptions.html#OSError) при открытии запрошенного файла преобразуется в ошибку `404`, `'File not found'`. В противном случае тип содержимого определяется вызовом метода `guess_type()`, который, в свою очередь, использует переменную *extensions\_map*.221222Выводится заголовок `'Content-type:'` с определённым типом содержимого, затем заголовок `'Content-Length:'` с размером файла и заголовок `'Last-Modified:'` с временем изменения файла.223224Затем идёт пустая строка, обозначающая конец заголовков, а затем выводится содержимое файла. Если MIME-тип файла начинается с `text/`, файл открывается в текстовом режиме; в противном случае используется двоичный режим.225226Пример использования см. в реализации вызова функции [`test()`](https://python-all.ru/3.4/library/test.html#module-test) в модуле [`http.server`](https://python-all.ru/3.4/library/http.server.html#module-http.server).227228Класс [`SimpleHTTPRequestHandler`](https://python-all.ru/3.4/library/http.server.html#http.server.SimpleHTTPRequestHandler) можно использовать следующим образом для создания самого простого веб-сервера, раздающего файлы из текущего каталога:229230```python231import http.server232import socketserver233234PORT = 8000235236Handler = http.server.SimpleHTTPRequestHandler237238httpd = socketserver.TCPServer(("", PORT), Handler)239240print("serving at port", PORT)241httpd.serve_forever()242```243244[`http.server`](https://python-all.ru/3.4/library/http.server.html#module-http.server) можно также запустить напрямую, используя ключ [*-m*](https://python-all.ru/3.4/using/cmdline.html#cmdoption-m) интерпретатора с аргументом `порт номер`. Как и в предыдущем примере, он раздаёт файлы из текущего каталога:245246```python247python -m http.server 8000248```249250По умолчанию сервер привязывается ко всем интерфейсам. Опция `-b/--bind` задаёт конкретный адрес, к которому он должен привязываться. Например, следующая команда заставляет сервер привязываться только к localhost:251252```python253python -m http.server 8000 --bind 127.0.0.1254```255256Новое в версии 3.4: `--bind` аргумент был добавлен.257258#### `class http.server.CGIHTTPRequestHandler(request, client_address, server)`259260Этот класс используется для обслуживания файлов или вывода CGI-скриптов из текущего каталога и всех подкаталогов. Обратите внимание, что сопоставление иерархической структуры HTTP с локальной файловой структурой производится точно так же, как в [`SimpleHTTPRequestHandler`](https://python-all.ru/3.4/library/http.server.html#http.server.SimpleHTTPRequestHandler).261262> **Примечание**263>264> CGI-скрипты, запускаемые классом [`CGIHTTPRequestHandler`](https://python-all.ru/3.4/library/http.server.html#http.server.CGIHTTPRequestHandler), не могут выполнять перенаправления (HTTP-код 302), поскольку код 200 (за которым следует вывод скрипта) отправляется до выполнения CGI-скрипта. Это заменяет код состояния.265266Однако класс будет запускать CGI-скрипт вместо того, чтобы отдавать его как файл, если он определит, что это CGI-скрипт. Используются только каталогизированные CGI – другая распространённая конфигурация сервера (обработка специальных расширений как обозначающих CGI-скрипты) не применяется.267268Функции `do_GET()` и `do_HEAD()` изменены для запуска CGI-скриптов и выдачи их результатов вместо файлов, если запрос ведёт к пути, расположенному внутри `cgi_directories`.269270[`CGIHTTPRequestHandler`](https://python-all.ru/3.4/library/http.server.html#http.server.CGIHTTPRequestHandler) определяет следующий атрибут данных:271272#### `cgi_directories`273274По умолчанию это значение равно `['/cgi-bin', '/htbin']` и определяет каталоги, которые считаются содержащими CGI-скрипты.275276[`CGIHTTPRequestHandler`](https://python-all.ru/3.4/library/http.server.html#http.server.CGIHTTPRequestHandler) определяет следующий метод:277278#### `do_POST()`279280Этот метод обрабатывает запросы типа `'POST'`, разрешённые только для CGI скриптов. При попытке отправить POST на не-CGI URL выводится ошибка 501 «Can only POST to CGI scripts».281282Обратите внимание: из соображений безопасности CGI-скрипты будут запускаться с UID пользователя nobody. Проблемы с CGI-скриптом приведут к ошибке 403.283284[`CGIHTTPRequestHandler`](https://python-all.ru/3.4/library/http.server.html#http.server.CGIHTTPRequestHandler) можно активировать из командной строки, указав параметр `--cgi`:285286```python287python -m http.server --cgi 8000288```289