Обслуживание WSGI-приложений

Существует множество способов обслуживания WSGI-приложения. Во время разработки вы обычно не хотите использовать полнофункциональный веб-сервер, как Apache, а вместо этого предпочитаете простой автономный. Поэтому Werkzeug поставляется с встроенным сервером разработки.

Самый простой способ — создать небольшой start-myproject.py файл, который запускает приложение с помощью встроенного сервера:

from werkzeug.serving import run_simple
from myproject import make_app

app = make_app(...)
run_simple('localhost', 8080, app, use_reloader=True)

Вы также можете передать ему extra_files ключевое слово со списком дополнительных файлов (например, файлов конфигурации), за которыми вы хотите наблюдать.

werkzeug.serving.run_simple(hostname, port, application, use_reloader=False, use_debugger=False, use_evalex=True, extra_files=None, exclude_patterns=None, reloader_interval=1, reloader_type='auto', threaded=False, processes=1, request_handler=None, static_files=None, passthrough_errors=False, ssl_context=None)

Запуск сервера разработки для WSGI-приложения. Различные дополнительные возможности могут быть включены.

Предупреждение

Не используйте сервер разработки при развертывании в продакшене. Он предназначен только для использования во время локальной разработки. Он не предназначен для высокой эффективности, стабильности или безопасности.

Параметры:

• hostname (str) – Хост, к которому нужно привязаться, например 'localhost'. Может быть доменом, IPv4- или IPv6-адресом или путем к файлу, начинающемуся с unix:// для сокета Unix.
• port (int) – Порт, к которому нужно привязаться, например 8080. Использование 0 сообщает ОС выбрать случайный свободный порт.
• application (WSGIApplication) – WSGI-приложение, которое нужно запустить.
• use_reloader (bool) – Использовать процесс перезагрузчика для перезапуска процесса сервера при изменении файлов.
• use_debugger (bool) – Использовать отладчик Werkzeug, который покажет отформатированные трассировки при возникновении необработанных исключений.
• use_evalex (bool) – Сделать отладчик интерактивным. Можно открыть терминал Python для любой строки в трассировке. Предоставляется некоторая защита, требующая PIN-кода, но это никогда не должно быть включено на публично доступном сервере.
• extra_files (t.Iterable[str] | None) – Перезагрузчик будет следить за этими файлами на предмет изменений помимо модулей Python. Например, следить за файлом конфигурации.
• exclude_patterns (t.Iterable[str] | None) – Перезагрузчик будет игнорировать изменения в любых файлах, соответствующих этим fnmatch шаблонам. Например, игнорировать файлы кэша.
• reloader_interval (int) – Насколько часто перезагрузчик пытается проверить изменения.
• reloader_type (str) – Используемый перезагрузчик. Встроенный 'stat' перезагрузчик, но может потребовать значительных ресурсов ЦП для отслеживания файлов. 'watchdog' перезагрузчик гораздо эффективнее, но для него требуется предварительная установка пакета watchdog.
• threaded (bool) – Обработка одновременных запросов с использованием потоков. Не может быть использовано с processes.
• processes (int) – Обработка одновременных запросов с использованием не более этого количества процессов. Не может быть использовано с threaded.
• request_handler (type[WSGIRequestHandler] | None) – Использование другого BaseHTTPRequestHandler подкласса для обработки запросов.
• static_files (dict[str, str | tuple[str, str]] | None) – Словарь, сопоставляющий префиксы URL с каталогами для обслуживания статических файлов с использованием SharedDataMiddleware.
• passthrough_errors (bool) – Не ловить необработанные исключения на уровне сервера, а вместо этого позволить серверу аварийно завершиться. Если use_debugger включен, отладчик по-прежнему будет ловить такие ошибки.
• ssl_context (_TSSLContextArg | None) – Настройка TLS для обслуживания через HTTPS. Может быть объектом ssl.SSLContext, кортежем (cert_file, key_file) для создания типичного контекста или строкой 'adhoc' для генерации временного самоподписанного сертификата.

Тип возвращаемого значения:

None

Журнал изменений

Изменено в версии 2.1: Показаны инструкции по работе с ошибкой «адрес уже используется».

Изменено в версии 2.1: Запуск на 0.0.0.0 или :: показывает адрес петли обратной связи помимо реального IP.

Изменено в версии 2.1: Интерфейс командной строки был удален.

Изменено в версии 2.0: Запуск на 0.0.0.0 или :: показывает реальный IP-адрес, к которому был выполнен привяз, а также предупреждение о том, что сервер разработки не следует запускать в продакшене.

Изменено в версии 2.0: Добавлен параметр exclude_patterns.

Изменено в версии 0.15: Привязка к сокету Unix путем передачи hostname, начинающегося с unix://.

Изменено в версии 0.10: Улучшен перезагрузчик и добавлена поддержка изменения бэкэнда через параметр reloader_type.

Изменено в версии 0.9: Добавлен интерфейс командной строки.

Изменено в версии 0.8: ssl_context может быть кортежем путей к файлам сертификата и закрытого ключа.

Изменено в версии 0.6: Добавлен параметр ssl_context.

Изменено в версии 0.5: Добавлены параметры static_files и passthrough_errors.

werkzeug.serving.is_running_from_reloader()

Проверка, работает ли сервер как подпроцесс в рамках перезагрузчика Werkzeug.

Журнал изменений

Добавлено в версии 0.10.

Тип возвращаемого значения:

bool

werkzeug.serving.make_ssl_devcert(base_path, host=None, cn=None)

Создаёт SSL-ключ для разработки. Это следует использовать вместо 'adhoc' ключа, который генерирует новый сертификат при каждом запуске сервера. Он принимает путь для хранения ключа и сертификата, а также имя хоста или CN. Если указан хост, будет использовано значение CN *.host/CN=host.

Дополнительную информацию см. в run_simple().

Журнал изменений

Новая функция в версии 0.9.

Параметры:

• base_path (str) – путь к сертификату и ключу. Расширение .crt добавляется для сертификата, .key добавляется для ключа.
• host (str | None) – имя хоста. Это можно использовать как альтернативу для cn.
• cn (str | None) – используемое CN.

Тип возвращаемого значения:

tuple[str, str]

127.0.0.1       localhost yourapplication.local api.yourapplication.local

import multiprocessing
from werkzeug import Request, Response, run_simple

def get_token(q: multiprocessing.Queue) -> None:
    @Request.application
    def app(request: Request) -> Response:
        q.put(request.args["token"])
        return Response("", 204)

    run_simple("localhost", 5000, app)

if __name__ == "__main__":
    q = multiprocessing.Queue()
    p = multiprocessing.Process(target=get_token, args=(q,))
    p.start()
    print("waiting")
    token = q.get(block=True)
    p.terminate()
    print(token)

::1             localhost

import ssl
ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_SERVER)
ctx.load_cert_chain('ssl.cert', 'ssl.key')
run_simple('localhost', 4000, application, ssl_context=ctx)

$ openssl genrsa 1024 > ssl.key
$ openssl req -new -x509 -nodes -sha1 -days 365 -key ssl.key > ssl.cert

run_simple('localhost', 4000, application,
           ssl_context='adhoc')

from werkzeug.serving import run_simple
run_simple('unix://example.sock', 0, app)