Оказание 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-приложения. Дополнительные возможности включают поддержку перезагрузки, многопоточности и форков.

Эта функция также имеет интерфейс командной строки:

python -m werkzeug.serving --help

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

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

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

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

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

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

Добавлен в версии 0.6: Добавлена поддержка SSL.

Добавлен в версии 0.5: static_files был добавлен для упрощения оказания статических файлов, а также passthrough_errors.

Параметры

• hostname (str) – Хост, к которому нужно подключиться, например 'localhost'. Если значение представляет собой путь, начинающийся с unix://, то произойдёт подключение к сокету Unix, а не сокету TCP.
• port (int) – Порт сервера. Пример: 8080
• application (WSGIApplication) – WSGI-приложение для выполнения
• use_reloader (bool) – должен ли сервер автоматически перезапускать процесс Python, если были изменены модули?
• use_debugger (bool) – должен ли использоваться отладчик Werkzeug?
• use_evalex (bool) – должна ли быть включена функция оценки исключений?
• extra_files (Optional[Iterable[str]]) – список файлов, которые перезагрузчик должен дополнительно отслеживать помимо модулей. Например, файлы конфигурации.
• exclude_patterns (Optional[Iterable[str]]) – Список fnmatch шаблонов для игнорирования при запуске перезагрузчика. Например, игнорирование файлов кэша, которые не должны перезагружаться при обновлении.
• reloader_interval (int) – интервал перезагрузки в секундах.
• reloader_type (str) – тип используемого перезагрузчика. По умолчанию используется автоматическое определение. Допустимые значения: 'stat' и 'watchdog'. Дополнительная информация приведена в разделе Перезагрузчик.
• threaded (bool) – должен ли процесс обрабатывать каждый запрос в отдельном потоке?
• processes (int) – если значение больше 1, то каждый запрос будет обрабатываться в новом процессе до максимального числа одновременных процессов.
• request_handler (Optional[Type[werkzeug.serving.WSGIRequestHandler]]) – необязательный параметр, который можно использовать для замены значения по умолчанию. Можно использовать его для замены на другой BaseHTTPRequestHandler подкласс.
• static_files (Optional[Dict[str, Union[str, Tuple[str, str]]]]) – список или словарь путей к статическим файлам. Работает аналогично SharedDataMiddleware, по сути, просто оборачивает приложение в этот middleware перед оказанием.
• passthrough_errors (bool) – установите это в True для отключения обработки ошибок. Это означает, что сервер завершится при ошибках, но может быть полезно для подключения отладчиков (pdb и т. д.).
• ssl_context (Optional[Union[ssl.SSLContext, Tuple[str, Optional[str]], te.Literal['adhoc']]]) – контекст SSL для соединения. Либо ssl.SSLContext, кортеж в формате (cert_file, pkey_file), строка 'adhoc' (если сервер должен автоматически создать один) или None для отключения SSL (по умолчанию).

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

None

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 (Optional[str]) – имя хоста. Его можно использовать как альтернативу для cn.
• cn (Optional[str]) – используемое CN.

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

Tuple[str, str]

127.0.0.1       localhost yourapplication.local api.yourapplication.local

def shutdown_server(environ):
    if not 'werkzeug.server.shutdown' in environ:
        raise RuntimeError('Not running the development server')
    environ['werkzeug.server.shutdown']()

::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)