`wsgiref.md`

488 строк · 57.4 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.9/library/wsgiref.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# [`wsgiref`](https://python-all.ru/3.9/library/wsgiref.html#module-wsgiref) – утилиты WSGI и эталонная реализация89---1011Интерфейс шлюза веб-сервера (WSGI) – это стандартный интерфейс между веб-сервером и веб-приложениями на Python. Наличие стандартного интерфейса упрощает использование приложения, поддерживающего WSGI, с различными веб-серверами.1213Только разработчики веб-серверов и фреймворков должны знать все тонкости и пограничные случаи дизайна WSGI. Чтобы установить WSGI-приложение или написать веб-приложение с помощью готового фреймворка, не нужно понимать каждую деталь WSGI.1415[`wsgiref`](https://python-all.ru/3.9/library/wsgiref.html#module-wsgiref) – эталонная реализация спецификации WSGI, которую можно использовать для добавления поддержки WSGI в веб-сервер или фреймворк. Она предоставляет утилиты для работы с переменными окружения WSGI и заголовками ответов, базовые классы для реализации серверов WSGI, демонстрационный HTTP-сервер для запуска WSGI-приложений и инструмент проверки, который сверяет WSGI-серверы и приложения на соответствие спецификации WSGI ([**PEP 3333**](https://python-all.ru/3.9/library/wsgiref.html)).1617См. [wsgi.readthedocs.io](https://python-all.ru/3.9/library/wsgiref.html) для получения дополнительной информации о WSGI и ссылок на учебные пособия и другие ресурсы.1819## [`wsgiref.util`](https://python-all.ru/3.9/library/wsgiref.html#module-wsgiref.util) – утилиты окружения WSGI2021Этот модуль предоставляет различные утилиты для работы с окружениями WSGI. Окружение WSGI – это словарь, содержащий переменные HTTP-запроса, как описано в [**PEP 3333**](https://python-all.ru/3.9/library/wsgiref.html). Все функции, принимающие параметр *environ*, ожидают словарь, совместимый с WSGI; подробную спецификацию см. в [**PEP 3333**](https://python-all.ru/3.9/library/wsgiref.html).2223#### `wsgiref.util.guess_scheme(environ)`2425Возвращает предположение о том, должно ли `wsgi.url_scheme` быть "http" или "https", проверяя переменную окружения `HTTPS` в словаре *environ*. Возвращаемое значение – строка.2627Эта функция полезна при создании шлюза, оборачивающего CGI или подобный CGI протокол, например FastCGI. Обычно серверы, реализующие такие протоколы, устанавливают переменную `HTTPS` со значением “1”, “yes” или “on”, когда запрос получен через SSL. Поэтому функция возвращает “https”, если найдено такое значение, и “http” в противном случае.2829#### `wsgiref.util.request_uri(environ, include_query=True)`3031Возвращает полный URI запроса, опционально включая строку запроса, используя алгоритм, описанный в разделе «URL Reconstruction» [**PEP 3333**](https://python-all.ru/3.9/library/wsgiref.html). Если *include\_query* равно false, строка запроса не включается в результирующий URI.3233#### `wsgiref.util.application_uri(environ)`3435Аналогично [`request_uri()`](https://python-all.ru/3.9/library/wsgiref.html#wsgiref.util.request_uri), за исключением того, что переменные `PATH_INFO` и `QUERY_STRING` игнорируются. Результат – базовый URI объекта приложения, адресованного запросом.3637#### `wsgiref.util.shift_path_info(environ)`3839Перемещает одно имя из `PATH_INFO` в `SCRIPT_NAME` и возвращает это имя. Словарь *environ* изменяется *на месте*; используйте копию, если нужно сохранить исходные `PATH_INFO` или `SCRIPT_NAME` неизменными.4041Если в `PATH_INFO` не осталось сегментов пути, возвращается `None`.4243Обычно эта процедура используется для обработки каждой части пути URI запроса, например, чтобы рассматривать путь как последовательность ключей словаря. Эта процедура изменяет переданное окружение, чтобы сделать его пригодным для вызова другого WSGI-приложения, расположенного по целевому URI. Например, если есть WSGI-приложение по адресу `/foo`, и путь URI запроса – `/foo/bar/baz`, и WSGI-приложение по адресу `/foo` вызывает [`shift_path_info()`](https://python-all.ru/3.9/library/wsgiref.html#wsgiref.util.shift_path_info), оно получит строку “bar”, а окружение будет обновлено для передачи WSGI-приложению по адресу `/foo/bar`. То есть, `SCRIPT_NAME` изменится с `/foo` на `/foo/bar`, а `PATH_INFO` изменится с `/bar/baz` на `/baz`.4445Когда `PATH_INFO` представляет собой просто “/”, эта процедура возвращает пустую строку и добавляет завершающий слеш к `SCRIPT_NAME`, хотя пустые сегменты пути обычно игнорируются, и `SCRIPT_NAME` обычно не заканчивается слешем. Это преднамеренное поведение, чтобы гарантировать, что приложение сможет отличить URI, заканчивающиеся на `/x`, от URI, заканчивающихся на `/x/`, при использовании этой процедуры для обхода объектов.4647#### `wsgiref.util.setup_testing_defaults(environ)`4849Обновляет *environ* простыми значениями по умолчанию для целей тестирования.5051Эта процедура добавляет различные параметры, необходимые для WSGI, включая `HTTP_HOST`, `SERVER_NAME`, `SERVER_PORT`, `REQUEST_METHOD`, `SCRIPT_NAME`, `PATH_INFO` и все переменные `wsgi.*`, определённые в [**PEP 3333**](https://python-all.ru/3.9/library/wsgiref.html). Она только задаёт значения по умолчанию и не заменяет существующие настройки этих переменных.5253Эта процедура предназначена для упрощения настройки фиктивных окружений в модульных тестах серверов и приложений WSGI. Её НЕ следует использовать в реальных серверах или приложениях WSGI, поскольку данные являются фиктивными!5455Пример использования:5657```python58from wsgiref.util import setup_testing_defaults59from wsgiref.simple_server import make_server6061# Относительно простое WSGI-приложение. Оно выведет62# словарь окружения после обновления с помощью setup_testing_defaults63def simple_app(environ, start_response):64    setup_testing_defaults(environ)6566    status = '200 OK'67    headers = [('Content-type', 'text/plain; charset=utf-8')]6869    start_response(status, headers)7071    ret = [("%s: %s\n" % (key, value)).encode("utf-8")72           for key, value in environ.items()]73    return ret7475with make_server('', 8000, simple_app) as httpd:76    print("Serving on port 8000...")77    httpd.serve_forever()78```7980В дополнение к функциям окружения, описанным выше, модуль [`wsgiref.util`](https://python-all.ru/3.9/library/wsgiref.html#module-wsgiref.util) также предоставляет следующие вспомогательные утилиты:8182#### `wsgiref.util.is_hop_by_hop(header_name)`8384Возвращает `True`, если ‘header\_name’ является HTTP/1.1 «Hop-by-Hop»-заголовком, как определено в [**RFC 2616**](https://python-all.ru/3.9/library/wsgiref.html).8586#### `class wsgiref.util.FileWrapper(filelike, blksize=8192)`8788Обёртка для преобразования файлоподобного объекта в [итератор](https://python-all.ru/3.9/glossary.html#term-iterator). Полученные объекты поддерживают как стиль итерации [`__getitem__()`](https://python-all.ru/3.9/reference/datamodel.html#object.__getitem__), так и [`__iter__()`](https://python-all.ru/3.9/reference/datamodel.html#object.__iter__) для совместимости с Python 2.1 и Jython. При итерации по объекту необязательный параметр *blksize* будет многократно передаваться методу *filelike* объекта `read()` для получения байтовых строк. Когда `read()` возвращает пустую байтовую строку, итерация завершается и не может быть возобновлена.8990Если *файлоподобный объект* имеет метод `close()`, возвращаемый объект также будет иметь метод `close()`, и при вызове он будет вызывать метод `close()` объекта *файлоподобный объект*.9192Пример использования:9394```python95from io import StringIO96from wsgiref.util import FileWrapper9798# В качестве файлоподобного объекта используется буфер StringIO99filelike = StringIO("This is an example file-like object"*10)100wrapper = FileWrapper(filelike, blksize=5)101102for chunk in wrapper:103    print(chunk)104```105106Устарело с версии 3.8: поддержка [`sequence protocol`](https://python-all.ru/3.9/reference/datamodel.html#object.__getitem__) устарела.107108## [`wsgiref.headers`](https://python-all.ru/3.9/library/wsgiref.html#module-wsgiref.headers) – инструменты для работы с заголовками ответа WSGI109110Этот модуль предоставляет единственный класс [`Headers`](https://python-all.ru/3.9/library/wsgiref.html#wsgiref.headers.Headers) для удобной работы с заголовками ответов WSGI через интерфейс, напоминающий словарь (mapping).111112#### `class wsgiref.headers.Headers([headers])`113114Создаёт объект, похожий на словарь, оборачивающий *headers*, который должен быть списком кортежей (имя заголовка, значение), как описано в [**PEP 3333**](https://python-all.ru/3.9/library/wsgiref.html). По умолчанию *headers* равен пустому списку.115116Объекты [`Headers`](https://python-all.ru/3.9/library/wsgiref.html#wsgiref.headers.Headers) поддерживают стандартные операции отображения, включая [`__getitem__()`](https://python-all.ru/3.9/reference/datamodel.html#object.__getitem__), `get()`, [`__setitem__()`](https://python-all.ru/3.9/reference/datamodel.html#object.__setitem__), `setdefault()`, [`__delitem__()`](https://python-all.ru/3.9/reference/datamodel.html#object.__delitem__) и [`__contains__()`](https://python-all.ru/3.9/reference/datamodel.html#object.__contains__). В каждом из этих методов ключом является имя заголовка (регистронезависимо), а значением – первое значение, связанное с этим именем заголовка. Установка заголовка удаляет все существующие значения для этого заголовка, затем добавляет новое значение в конец обёрнутого списка заголовков. Существующий порядок заголовков в целом сохраняется, новые заголовки добавляются в конец обёрнутого списка.117118В отличие от словаря, объекты [`Headers`](https://python-all.ru/3.9/library/wsgiref.html#wsgiref.headers.Headers) не вызывают ошибку при попытке получить или удалить ключ, которого нет в обёрнутом списке заголовков. Получение несуществующего заголовка просто возвращает `None`, а удаление несуществующего заголовка ничего не делает.119120Объекты [`Headers`](https://python-all.ru/3.9/library/wsgiref.html#wsgiref.headers.Headers) также поддерживают методы `keys()`, `values()` и `items()`. Списки, возвращаемые `keys()` и `items()`, могут содержать один и тот же ключ несколько раз, если заголовок многозначный. Длина (`len()`) объекта [`Headers`](https://python-all.ru/3.9/library/wsgiref.html#wsgiref.headers.Headers) равна длине его `items()`, которая равна длине обёрнутого списка заголовков. По сути, метод `items()` просто возвращает копию обёрнутого списка заголовков.121122Вызов `bytes()` для объекта [`Headers`](https://python-all.ru/3.9/library/wsgiref.html#wsgiref.headers.Headers) возвращает форматированную байтовую строку, пригодную для передачи в качестве HTTP-заголовков ответа. Каждый заголовок размещается на отдельной строке со своим значением, разделёнными двоеточием и пробелом. Каждая строка завершается символами возврата каретки и перевода строки, а байтовая строка завершается пустой строкой.123124В дополнение к интерфейсу отображения и функциям форматирования, объекты [`Headers`](https://python-all.ru/3.9/library/wsgiref.html#wsgiref.headers.Headers) также имеют следующие методы для запроса и добавления многозначных заголовков, а также для добавления заголовков с MIME-параметрами:125126#### `get_all(name)`127128Возвращает список всех значений для указанного заголовка.129130Возвращаемый список будет отсортирован в порядке появления в исходном списке заголовков или добавления в данный экземпляр, и может содержать дубликаты. Любые удалённые и повторно вставленные поля всегда добавляются в конец списка заголовков. Если полей с указанным именем не существует, возвращается пустой список.131132#### `add_header(name, value, **_params)`133134Добавляет (возможно, многозначный) заголовок с необязательными MIME-параметрами, задаваемыми через именованные аргументы.135136*name* – это добавляемое поле заголовка. Именованные аргументы можно использовать для установки MIME-параметров поля заголовка. Каждый параметр должен быть строкой или `None`. Подчёркивания в именах параметров заменяются на дефисы, поскольку дефисы недопустимы в идентификаторах Python, но многие имена MIME-параметров содержат дефисы. Если значение параметра – строка, оно добавляется к параметрам значения заголовка в виде `name="value"`. Если это `None`, добавляется только имя параметра. (Это используется для MIME-параметров без значения.) Пример использования:137138```python139h.add_header('content-disposition', 'attachment', filename='bud.gif')140```141142Приведённый выше код добавит заголовок, который будет выглядеть так:143144```python145Content-Disposition: attachment; filename="bud.gif"146```147148Изменено в версии 3.5: Параметр *headers* стал необязательным.149150## [`wsgiref.simple_server`](https://python-all.ru/3.9/library/wsgiref.html#module-wsgiref.simple_server) – простой WSGI HTTP-сервер151152Этот модуль реализует простой HTTP-сервер (на базе [`http.server`](https://python-all.ru/3.9/library/http.server.html#module-http.server)), обслуживающий WSGI-приложения. Каждый экземпляр сервера обслуживает одно WSGI-приложение на заданном хосте и порту. Если требуется обслуживать несколько приложений на одном хосте и порту, следует создать WSGI-приложение, которое анализирует `PATH_INFO`, чтобы выбрать, какое приложение вызывать для каждого запроса. (Например, с помощью функции `shift_path_info()` из [`wsgiref.util`](https://python-all.ru/3.9/library/wsgiref.html#module-wsgiref.util).)153154#### `wsgiref.simple_server.make_server(host, port, app, server_class=WSGIServer, handler_class=WSGIRequestHandler)`155156Создаёт новый WSGI-сервер, прослушивающий *host* и *port*, принимающий соединения для *app*. Возвращаемое значение – экземпляр указанного *server\_class*, который будет обрабатывать запросы с помощью заданного *handler\_class*. *app* должен быть объектом WSGI-приложения, как определено в [**PEP 3333**](https://python-all.ru/3.9/library/wsgiref.html).157158Пример использования:159160```python161from wsgiref.simple_server import make_server, demo_app162163with make_server('', 8000, demo_app) as httpd:164    print("Serving HTTP on port 8000...")165166    # Отвечать на запросы до завершения процесса167    httpd.serve_forever()168169    # Альтернатива: обработать один запрос и завершить работу170    httpd.handle_request()171```172173#### `wsgiref.simple_server.demo_app(environ, start_response)`174175Эта функция представляет собой небольшое, но полноценное WSGI-приложение, которое возвращает текстовую страницу с сообщением «Hello world!» и списком пар ключ/значение, переданных в параметре *environ*. Она полезна для проверки того, что WSGI-сервер (например, [`wsgiref.simple_server`](https://python-all.ru/3.9/library/wsgiref.html#module-wsgiref.simple_server)) способен корректно запустить простое WSGI-приложение.176177#### `class wsgiref.simple_server.WSGIServer(server_address, RequestHandlerClass)`178179Создаёт экземпляр [`WSGIServer`](https://python-all.ru/3.9/library/wsgiref.html#wsgiref.simple_server.WSGIServer). *server\_address* должен быть кортежем `(host,port)`, а *RequestHandlerClass* – подклассом [`http.server.BaseHTTPRequestHandler`](https://python-all.ru/3.9/library/http.server.html#http.server.BaseHTTPRequestHandler), который будет использоваться для обработки запросов.180181Обычно нет необходимости вызывать этот конструктор, поскольку функция [`make_server()`](https://python-all.ru/3.9/library/wsgiref.html#wsgiref.simple_server.make_server) берёт на себя все детали.182183[`WSGIServer`](https://python-all.ru/3.9/library/wsgiref.html#wsgiref.simple_server.WSGIServer) является подклассом [`http.server.HTTPServer`](https://python-all.ru/3.9/library/http.server.html#http.server.HTTPServer), поэтому все его методы (такие как `serve_forever()` и `handle_request()`) доступны. [`WSGIServer`](https://python-all.ru/3.9/library/wsgiref.html#wsgiref.simple_server.WSGIServer) также предоставляет следующие специфичные для WSGI методы:184185#### `set_app(application)`186187Устанавливает вызываемый объект *application* в качестве WSGI-приложения, которое будет получать запросы.188189#### `get_app()`190191Возвращает установленный в данный момент вызываемый объект приложения.192193Однако обычно нет необходимости использовать эти дополнительные методы, так как [`set_app()`](https://python-all.ru/3.9/library/wsgiref.html#wsgiref.simple_server.WSGIServer.set_app) обычно вызывается [`make_server()`](https://python-all.ru/3.9/library/wsgiref.html#wsgiref.simple_server.make_server), а [`get_app()`](https://python-all.ru/3.9/library/wsgiref.html#wsgiref.simple_server.WSGIServer.get_app) существует в основном для удобства экземпляров обработчиков запросов.194195#### `class wsgiref.simple_server.WSGIRequestHandler(request, client_address, server)`196197Создаёт HTTP-обработчик для заданного *request* (т.е. сокета), *client\_address* (кортеж `(host,port)`) и *server* (экземпляр [`WSGIServer`](https://python-all.ru/3.9/library/wsgiref.html#wsgiref.simple_server.WSGIServer)).198199Нет необходимости создавать экземпляры этого класса напрямую; они создаются автоматически по мере необходимости объектами [`WSGIServer`](https://python-all.ru/3.9/library/wsgiref.html#wsgiref.simple_server.WSGIServer). Однако можно создать подкласс этого класса и передать его в качестве *handler\_class* функции [`make_server()`](https://python-all.ru/3.9/library/wsgiref.html#wsgiref.simple_server.make_server). Некоторые методы, которые могут быть переопределены в подклассах:200201#### `get_environ()`202203Возвращает словарь, содержащий окружение WSGI для запроса. Реализация по умолчанию копирует содержимое атрибута-словаря `base_environ` объекта [`WSGIServer`](https://python-all.ru/3.9/library/wsgiref.html#wsgiref.simple_server.WSGIServer) и затем добавляет различные заголовки, полученные из HTTP-запроса. Каждый вызов этого метода должен возвращать новый словарь, содержащий все соответствующие переменные окружения CGI, как указано в [**PEP 3333**](https://python-all.ru/3.9/library/wsgiref.html).204205#### `get_stderr()`206207Возвращает объект, который следует использовать в качестве потока `wsgi.errors`. Реализация по умолчанию просто возвращает `sys.stderr`.208209#### `handle()`210211Обрабатывает HTTP-запрос. Реализация по умолчанию создаёт экземпляр обработчика, используя класс [`wsgiref.handlers`](https://python-all.ru/3.9/library/wsgiref.html#module-wsgiref.handlers) для реализации фактического интерфейса WSGI-приложения.212213## [`wsgiref.validate`](https://python-all.ru/3.9/library/wsgiref.html#module-wsgiref.validate) – средство проверки соответствия WSGI214215При создании новых объектов WSGI-приложений, фреймворков, серверов или промежуточного ПО может быть полезно проверить соответствие нового кода с помощью [`wsgiref.validate`](https://python-all.ru/3.9/library/wsgiref.html#module-wsgiref.validate). Этот модуль предоставляет функцию, которая создаёт объекты WSGI-приложений, проверяющие взаимодействие между WSGI-сервером или шлюзом и объектом WSGI-приложения, чтобы проверить обе стороны на соответствие протоколу.216217Обратите внимание, что эта утилита не гарантирует полного соответствия [**PEP 3333**](https://python-all.ru/3.9/library/wsgiref.html); отсутствие ошибок от этого модуля не обязательно означает, что ошибок не существует. Однако если этот модуль выдаёт ошибку, то практически наверняка либо сервер, либо приложение не соответствует требованиям на 100%.218219Этот модуль основан на модуле `paste.lint` из библиотеки «Python Paste» Иана Бикинга.220221#### `wsgiref.validate.validator(application)`222223Оборачивает *application* и возвращает новый объект WSGI-приложения. Возвращённое приложение будет перенаправлять все запросы исходному *application* и проверять, что и *application*, и вызывающий его сервер соответствуют спецификации WSGI и [**RFC 2616**](https://python-all.ru/3.9/library/wsgiref.html).224225Любое обнаруженное несоответствие приводит к возбуждению [`AssertionError`](https://python-all.ru/3.9/library/exceptions.html#AssertionError); однако обратите внимание, что обработка этих ошибок зависит от сервера. Например, [`wsgiref.simple_server`](https://python-all.ru/3.9/library/wsgiref.html#module-wsgiref.simple_server) и другие серверы на основе [`wsgiref.handlers`](https://python-all.ru/3.9/library/wsgiref.html#module-wsgiref.handlers) (которые не переопределяют методы обработки ошибок для других действий) просто выведут сообщение о том, что произошла ошибка, и отправят трассировку в `sys.stderr` или другой поток ошибок.226227Эта обёртка также может генерировать вывод с помощью модуля [`warnings`](https://python-all.ru/3.9/library/warnings.html#module-warnings), чтобы указать на поведение, которое вызывает сомнения, но может и не быть явно запрещённым [**PEP 3333**](https://python-all.ru/3.9/library/wsgiref.html). Если такие предупреждения не подавлены с помощью параметров командной строки Python или API [`warnings`](https://python-all.ru/3.9/library/warnings.html#module-warnings), они будут записаны в `sys.stderr` (*не* в `wsgi.errors`, если только это не один и тот же объект).228229Пример использования:230231```python232from wsgiref.validate import validator233from wsgiref.simple_server import make_server234235# Наш вызываемый объект, который намеренно не соответствует236# стандарту, поэтому валидатор выдаст ошибку237def simple_app(environ, start_response):238    status = '200 OK'  # HTTP-статус239    headers = [('Content-type', 'text/plain')]  # HTTP-заголовки240    start_response(status, headers)241242    # Это приведёт к ошибке, потому что нужно вернуть список, и243    # валидатор сообщит об этом244    return b"Hello World"245246# Это приложение, обёрнутое в валидатор247validator_app = validator(simple_app)248249with make_server('', 8000, validator_app) as httpd:250    print("Listening on port 8000....")251    httpd.serve_forever()252```253254## [`wsgiref.handlers`](https://python-all.ru/3.9/library/wsgiref.html#module-wsgiref.handlers) – базовые классы серверов/шлюзов255256Этот модуль предоставляет базовые классы обработчиков для реализации WSGI-серверов и шлюзов. Эти базовые классы берут на себя большую часть работы по взаимодействию с WSGI-приложением при условии, что им предоставлено окружение, подобное CGI, а также потоки ввода, вывода и ошибок.257258#### `class wsgiref.handlers.CGIHandler`259260Вызов на основе CGI через `sys.stdin`, `sys.stdout`, `sys.stderr` и `os.environ`. Это полезно, когда есть WSGI-приложение, которое нужно запустить как CGI-скрипт. Просто вызовите `CGIHandler().run(app)`, где `app` – это объект WSGI-приложения, которое требуется вызвать.261262Этот класс является подклассом [`BaseCGIHandler`](https://python-all.ru/3.9/library/wsgiref.html#wsgiref.handlers.BaseCGIHandler), который устанавливает `wsgi.run_once` в true, `wsgi.multithread` в false, а `wsgi.multiprocess` в true и всегда использует [`sys`](https://python-all.ru/3.9/library/sys.html#module-sys) и [`os`](https://python-all.ru/3.9/library/os.html#module-os) для получения необходимых CGI-потоков и окружения.263264#### `class wsgiref.handlers.IISCGIHandler`265266Специализированная альтернатива [`CGIHandler`](https://python-all.ru/3.9/library/wsgiref.html#wsgiref.handlers.CGIHandler) для использования при развёртывании на веб-сервере Microsoft IIS без установки опции конфигурации allowPathInfo (IIS\>=7) или метабазы allowPathInfoForScriptMappings (IIS\<7).267268По умолчанию IIS предоставляет `PATH_INFO`, который дублирует `SCRIPT_NAME` в начале, что вызывает проблемы для WSGI-приложений, желающих реализовать маршрутизацию. Этот обработчик удаляет любой такой дублированный путь.269270IIS можно настроить на передачу правильного `PATH_INFO`, но это вызывает другую ошибку, при которой `PATH_TRANSLATED` оказывается неверным. К счастью, эта переменная редко используется и не гарантируется WSGI. Однако на IIS\<7 настройка может быть выполнена только на уровне виртуального хоста, затрагивая все остальные сопоставления скриптов, многие из которых ломаются при воздействии ошибки `PATH_TRANSLATED`. По этой причине IIS\<7 почти никогда не разворачивается с исправлением (даже IIS7 редко его использует, так как для него до сих пор нет пользовательского интерфейса).271272У CGI-кода нет способа определить, была ли установлена опция, поэтому предоставляется отдельный класс обработчика. Он используется так же, как [`CGIHandler`](https://python-all.ru/3.9/library/wsgiref.html#wsgiref.handlers.CGIHandler), то есть вызовом `IISCGIHandler().run(app)`, где `app` – это объект WSGI-приложения, которое требуется вызвать.273274Новое в версии 3.2.275276#### `class wsgiref.handlers.BaseCGIHandler(stdin, stdout, stderr, environ, multithread=True, multiprocess=False)`277278Аналогично [`CGIHandler`](https://python-all.ru/3.9/library/wsgiref.html#wsgiref.handlers.CGIHandler), но вместо использования модулей [`sys`](https://python-all.ru/3.9/library/sys.html#module-sys) и [`os`](https://python-all.ru/3.9/library/os.html#module-os) окружение CGI и потоки ввода-вывода задаются явно. Значения *multithread* и *multiprocess* используются для установки флагов `wsgi.multithread` и `wsgi.multiprocess` для любых приложений, запускаемых экземпляром обработчика.279280Этот класс является подклассом [`SimpleHandler`](https://python-all.ru/3.9/library/wsgiref.html#wsgiref.handlers.SimpleHandler), предназначенным для использования с программами, отличными от HTTP-«исходных серверов». Если вы пишете реализацию шлюзового протокола (например, CGI, FastCGI, SCGI и т.д.), которая использует заголовок `Status:` для отправки HTTP-статуса, то, вероятно, стоит создать подкласс этого класса, а не [`SimpleHandler`](https://python-all.ru/3.9/library/wsgiref.html#wsgiref.handlers.SimpleHandler).281282#### `class wsgiref.handlers.SimpleHandler(stdin, stdout, stderr, environ, multithread=True, multiprocess=False)`283284Похож на [`BaseCGIHandler`](https://python-all.ru/3.9/library/wsgiref.html#wsgiref.handlers.BaseCGIHandler), но предназначен для использования с исходными HTTP-серверами. Если вы пишете реализацию HTTP-сервера, то, вероятно, стоит создать подкласс этого класса, а не [`BaseCGIHandler`](https://python-all.ru/3.9/library/wsgiref.html#wsgiref.handlers.BaseCGIHandler).285286Этот класс является подклассом [`BaseHandler`](https://python-all.ru/3.9/library/wsgiref.html#wsgiref.handlers.BaseHandler). Он переопределяет методы [`__init__()`](https://python-all.ru/3.9/reference/datamodel.html#object.__init__), `get_stdin()`, `get_stderr()`, `add_cgi_vars()`, `_write()` и `_flush()` для поддержки явной установки окружения и потоков через конструктор. Предоставленные окружение и потоки сохраняются в атрибутах `stdin`, `stdout`, `stderr` и `environ`.287288Метод [`write()`](https://python-all.ru/3.9/library/io.html#io.BufferedIOBase.write) объекта *stdout* должен записывать каждый фрагмент полностью, как [`io.BufferedIOBase`](https://python-all.ru/3.9/library/io.html#io.BufferedIOBase).289290#### `class wsgiref.handlers.BaseHandler`291292Это абстрактный базовый класс для запуска WSGI-приложений. Каждый экземпляр будет обрабатывать один HTTP-запрос, хотя в принципе можно создать подкласс, пригодный для повторного использования для нескольких запросов.293294Экземпляры [`BaseHandler`](https://python-all.ru/3.9/library/wsgiref.html#wsgiref.handlers.BaseHandler) имеют только один метод, предназначенный для внешнего использования:295296#### `run(app)`297298Запускает указанное WSGI-приложение *app*.299300Все остальные методы [`BaseHandler`](https://python-all.ru/3.9/library/wsgiref.html#wsgiref.handlers.BaseHandler) вызываются этим методом в процессе выполнения приложения и, по существу, существуют для возможности настройки процесса.301302Следующие методы ОБЯЗАТЕЛЬНО должны быть переопределены в подклассе:303304#### `_write(data)`305306Буферизует байты *data* для передачи клиенту. Нормально, если этот метод фактически передаёт данные; [`BaseHandler`](https://python-all.ru/3.9/library/wsgiref.html#wsgiref.handlers.BaseHandler) просто разделяет операции записи и сброса для повышения эффективности, когда базовая система действительно имеет такое различие.307308#### `_flush()`309310Принудительно отправляет буферизованные данные клиенту. Нормально, если этот метод ничего не делает (т.е. если [`_write()`](https://python-all.ru/3.9/library/wsgiref.html#wsgiref.handlers.BaseHandler._write) фактически отправляет данные).311312#### `get_stdin()`313314Возвращает объект входного потока, подходящий для использования в качестве `wsgi.input` текущего обрабатываемого запроса.315316#### `get_stderr()`317318Возвращает объект выходного потока, подходящий для использования в качестве `wsgi.errors` текущего обрабатываемого запроса.319320#### `add_cgi_vars()`321322Вставляет переменные CGI для текущего запроса в атрибут `environ`.323324Вот некоторые другие методы и атрибуты, которые вы можете захотеть переопределить. Однако этот список является лишь кратким обзором и не включает все методы, которые можно переопределить. Перед попыткой создать собственный подкласс [`BaseHandler`](https://python-all.ru/3.9/library/wsgiref.html#wsgiref.handlers.BaseHandler) следует ознакомиться с дополнительной информацией в строках документации и исходном коде.325326Атрибуты и методы для настройки окружения WSGI:327328#### `wsgi_multithread`329330Значение, которое будет использоваться для переменной окружения `wsgi.multithread`. По умолчанию оно равно true в [`BaseHandler`](https://python-all.ru/3.9/library/wsgiref.html#wsgiref.handlers.BaseHandler), но может иметь другое значение по умолчанию (или быть установлено конструктором) в других подклассах.331332#### `wsgi_multiprocess`333334Значение, которое будет использоваться для переменной окружения `wsgi.multiprocess`. По умолчанию оно равно true в [`BaseHandler`](https://python-all.ru/3.9/library/wsgiref.html#wsgiref.handlers.BaseHandler), но может иметь другое значение по умолчанию (или быть установлено конструктором) в других подклассах.335336#### `wsgi_run_once`337338Значение, которое будет использоваться для переменной окружения `wsgi.run_once`. По умолчанию оно равно false в [`BaseHandler`](https://python-all.ru/3.9/library/wsgiref.html#wsgiref.handlers.BaseHandler), но [`CGIHandler`](https://python-all.ru/3.9/library/wsgiref.html#wsgiref.handlers.CGIHandler) устанавливает его в true по умолчанию.339340#### `os_environ`341342Переменные окружения по умолчанию, которые будут включены в WSGI-окружение каждого запроса. По умолчанию это копия `os.environ` на момент импорта [`wsgiref.handlers`](https://python-all.ru/3.9/library/wsgiref.html#module-wsgiref.handlers), но подклассы могут создать собственные на уровне класса или экземпляра. Обратите внимание, что словарь следует считать доступным только для чтения, поскольку значение по умолчанию совместно используется несколькими классами и экземплярами.343344#### `server_software`345346Если атрибут [`origin_server`](https://python-all.ru/3.9/library/wsgiref.html#wsgiref.handlers.BaseHandler.origin_server) установлен, его значение используется для установки переменной окружения WSGI `SERVER_SOFTWARE` по умолчанию, а также для установки заголовка `Server:` по умолчанию в HTTP-ответах. Он игнорируется для обработчиков (таких как [`BaseCGIHandler`](https://python-all.ru/3.9/library/wsgiref.html#wsgiref.handlers.BaseCGIHandler) и [`CGIHandler`](https://python-all.ru/3.9/library/wsgiref.html#wsgiref.handlers.CGIHandler)), которые не являются исходными HTTP-серверами.347348Изменено в версии 3.3: Термин «Python» заменён на термин, специфичный для реализации, например «CPython», «Jython» и т.д.349350#### `get_scheme()`351352Возвращает схему URL, используемую для текущего запроса. Реализация по умолчанию использует функцию `guess_scheme()` из [`wsgiref.util`](https://python-all.ru/3.9/library/wsgiref.html#module-wsgiref.util), чтобы определить, должна ли схема быть «http» или «https», на основе переменных `environ` текущего запроса.353354#### `setup_environ()`355356Устанавливает атрибут `environ` в полностью заполненное WSGI-окружение. Реализация по умолчанию использует все перечисленные выше методы и атрибуты, а также [`get_stdin()`](https://python-all.ru/3.9/library/wsgiref.html#wsgiref.handlers.BaseHandler.get_stdin), [`get_stderr()`](https://python-all.ru/3.9/library/wsgiref.html#wsgiref.handlers.BaseHandler.get_stderr) и [`add_cgi_vars()`](https://python-all.ru/3.9/library/wsgiref.html#wsgiref.handlers.BaseHandler.add_cgi_vars) методы и атрибут [`wsgi_file_wrapper`](https://python-all.ru/3.9/library/wsgiref.html#wsgiref.handlers.BaseHandler.wsgi_file_wrapper). Она также вставляет ключ `SERVER_SOFTWARE`, если он отсутствует, при условии, что атрибут [`origin_server`](https://python-all.ru/3.9/library/wsgiref.html#wsgiref.handlers.BaseHandler.origin_server) имеет истинное значение, а атрибут [`server_software`](https://python-all.ru/3.9/library/wsgiref.html#wsgiref.handlers.BaseHandler.server_software) установлен.357358Методы и атрибуты для настройки обработки исключений:359360#### `log_exception(exc_info)`361362Записывает кортеж *exc\_info* в журнал сервера. *exc\_info* – это кортеж `(type, value, traceback)`. Реализация по умолчанию просто записывает трассировку в поток `wsgi.errors` запроса и сбрасывает его. Подклассы могут переопределить этот метод, чтобы изменить формат или перенаправить вывод, отправить трассировку администратору по почте или выполнить любое другое действие, которое сочтут подходящим.363364#### `traceback_limit`365366Максимальное количество фреймов, включаемых в трассировки, выводимые методом [`log_exception()`](https://python-all.ru/3.9/library/wsgiref.html#wsgiref.handlers.BaseHandler.log_exception) по умолчанию. Если `None`, включаются все фреймы.367368#### `error_output(environ, start_response)`369370Этот метод представляет собой WSGI-приложение для генерации страницы ошибки для пользователя. Он вызывается только в том случае, если ошибка возникает до отправки заголовков клиенту.371372Этот метод может получить доступ к текущей информации об ошибке с помощью `sys.exc_info()` и должен передавать эту информацию в *start\_response* при его вызове (как описано в разделе «Обработка ошибок» [**PEP 3333**](https://python-all.ru/3.9/library/wsgiref.html)).373374Реализация по умолчанию просто использует атрибуты [`error_status`](https://python-all.ru/3.9/library/wsgiref.html#wsgiref.handlers.BaseHandler.error_status), [`error_headers`](https://python-all.ru/3.9/library/wsgiref.html#wsgiref.handlers.BaseHandler.error_headers) и [`error_body`](https://python-all.ru/3.9/library/wsgiref.html#wsgiref.handlers.BaseHandler.error_body) для генерации выходной страницы. Подклассы могут переопределить это для создания более динамичного вывода ошибок.375376Однако с точки зрения безопасности не рекомендуется выводить диагностическую информацию любому пользователю; в идеале необходимо выполнить специальные действия для включения диагностического вывода, поэтому в реализации по умолчанию он отсутствует.377378#### `error_status`379380HTTP-статус, используемый для ответов об ошибках. Это должна быть строка статуса, как определено в [**PEP 3333**](https://python-all.ru/3.9/library/wsgiref.html); по умолчанию это код 500 и соответствующее сообщение.381382#### `error_headers`383384HTTP-заголовки, используемые для ответов об ошибках. Это должен быть список заголовков ответа WSGI (кортежи `(name, value)`), как описано в [**PEP 3333**](https://python-all.ru/3.9/library/wsgiref.html). Список по умолчанию просто устанавливает тип содержимого `text/plain`.385386#### `error_body`387388Тело ответа об ошибке. Это должна быть байтовая строка тела HTTP-ответа. По умолчанию это обычный текст: «A server error occurred. Please contact the administrator.»389390Методы и атрибуты для функции «Optional Platform-Specific File Handling» из [**PEP 3333**](https://python-all.ru/3.9/library/wsgiref.html):391392#### `wsgi_file_wrapper`393394Фабрика `wsgi.file_wrapper`, или `None`. Значение этого атрибута по умолчанию – класс [`wsgiref.util.FileWrapper`](https://python-all.ru/3.9/library/wsgiref.html#wsgiref.util.FileWrapper).395396#### `sendfile()`397398Переопределите для реализации передачи файлов, зависящей от платформы. Этот метод вызывается только в том случае, если возвращаемое значение приложения является экземпляром класса, указанного атрибутом [`wsgi_file_wrapper`](https://python-all.ru/3.9/library/wsgiref.html#wsgiref.handlers.BaseHandler.wsgi_file_wrapper). Он должен возвращать истинное значение, если файл был успешно передан, чтобы код передачи по умолчанию не выполнялся. Реализация этого метода по умолчанию просто возвращает ложное значение.399400Разные методы и атрибуты:401402#### `origin_server`403404Этот атрибут должен быть установлен в истинное значение, если [`_write()`](https://python-all.ru/3.9/library/wsgiref.html#wsgiref.handlers.BaseHandler._write) и [`_flush()`](https://python-all.ru/3.9/library/wsgiref.html#wsgiref.handlers.BaseHandler._flush) обработчика используются для прямой связи с клиентом, а не через шлюзовой протокол типа CGI, который ожидает HTTP-статус в специальном заголовке `Status:`.405406Значение этого атрибута по умолчанию равно true в [`BaseHandler`](https://python-all.ru/3.9/library/wsgiref.html#wsgiref.handlers.BaseHandler), но false в [`BaseCGIHandler`](https://python-all.ru/3.9/library/wsgiref.html#wsgiref.handlers.BaseCGIHandler) и [`CGIHandler`](https://python-all.ru/3.9/library/wsgiref.html#wsgiref.handlers.CGIHandler).407408#### `http_version`409410Если [`origin_server`](https://python-all.ru/3.9/library/wsgiref.html#wsgiref.handlers.BaseHandler.origin_server) равно True, этот строковый атрибут используется для установки HTTP-версии ответа, отправляемого клиенту. По умолчанию он равен `"1.0"`.411412#### `wsgiref.handlers.read_environ()`413414Перекодирует CGI-переменные из `os.environ` в [**PEP 3333**](https://python-all.ru/3.9/library/wsgiref.html) строки «bytes in unicode» и возвращает новый словарь. Эта функция используется [`CGIHandler`](https://python-all.ru/3.9/library/wsgiref.html#wsgiref.handlers.CGIHandler) и [`IISCGIHandler`](https://python-all.ru/3.9/library/wsgiref.html#wsgiref.handlers.IISCGIHandler) вместо прямого использования `os.environ`, который не обязательно совместим с WSGI на всех платформах и веб-серверах, использующих Python 3 – в частности, на тех, где реальное окружение ОС в Unicode (например, Windows), или на тех, где окружение – байты, но системная кодировка, используемая Python для его декодирования, отлична от ISO-8859-1 (например, Unix-системы с UTF-8).415416При реализации собственного CGI-обработчика, вероятно, следует использовать эту процедуру вместо прямого копирования значений из `os.environ`.417418Новое в версии 3.2.419420## Примеры421422Это рабочее WSGI-приложение «Hello World»:423424```python425from wsgiref.simple_server import make_server426427# Каждое WSGI-приложение должно иметь объект приложения – вызываемый428# объект, который принимает два аргумента. Для этого429# можно использовать функцию (обратите внимание: можно не только функцию, но и, например, класс)430# использовать, например, класс). Первый аргумент, передаваемый функции,431# это словарь, содержащий переменные окружения в стиле CGI, а432# второй аргумент – вызываемый объект.433def hello_world_app(environ, start_response):434    status = '200 OK'  # HTTP-статус435    headers = [('Content-type', 'text/plain; charset=utf-8')]  # HTTP-заголовки436    start_response(status, headers)437438    # Возвращаемый объект будет выведен439    return [b"Hello World"]440441with make_server('', 8000, hello_world_app) as httpd:442    print("Serving on port 8000...")443444    # Обслуживать до завершения процесса445    httpd.serve_forever()446```447448Пример WSGI-приложения, обслуживающего текущий каталог; принимает опциональные каталог и номер порта (по умолчанию: 8000) из командной строки:449450```python451#!/usr/bin/env python3452'''453Небольшой веб-сервер на основе wsgiref. Принимает путь для раздачи и454необязательный номер порта (по умолчанию 8000), затем пытается раздавать файлы.455Типы MIME определяются по именам файлов, а если файл не найден, возвращается ошибка 404.456если файл не найден. Используется для цели make serve в документации.457'''458import sys459import os460import mimetypes461from wsgiref import simple_server, util462463def app(environ, respond):464465    fn = os.path.join(path, environ['PATH_INFO'][1:])466    if '.' not in fn.split(os.path.sep)[-1]:467        fn = os.path.join(fn, 'index.html')468    type = mimetypes.guess_type(fn)[0]469470    if os.path.exists(fn):471        respond('200 OK', [('Content-Type', type)])472        return util.FileWrapper(open(fn, "rb"))473    else:474        respond('404 Not Found', [('Content-Type', 'text/plain')])475        return [b'not found']476477if __name__ == '__main__':478    path = sys.argv[1] if len(sys.argv) > 1 else os.getcwd()479    port = int(sys.argv[2]) if len(sys.argv) > 2 else 8000480    httpd = simple_server.make_server('', port, app)481    print("Serving {} on port {}, control-C to stop".format(path, port))482    try:483        httpd.serve_forever()484    except KeyboardInterrupt:485        print("Shutting down.")486        httpd.server_close()487```488