mod_wsgi (Apache)

Если вы используете веб-сервер Apache, рассмотрите использование mod_wsgi.

Установка mod_wsgi

Если у вас ещё не установлен mod_wsgi, вы должны либо установить его с помощью менеджера пакетов, либо скомпилировать самостоятельно. Инструкции по установке mod_wsgi покрывают установку из исходного кода на системах UNIX.

Если вы используете Ubuntu/Debian, вы можете установить его с помощью apt-get и активировать следующим образом:

$ apt-get install libapache2-mod-wsgi-py3

Если вы используете дистрибутив на базе yum (Fedora, OpenSUSE и т. д.), вы можете установить его следующим образом:

$ yum install mod_wsgi

В FreeBSD установите mod_wsgi, скомпилировав порт www/mod_wsgi или используя pkg_add:

$ pkg install ap24-py37-mod_wsgi

Если вы используете pkgsrc, вы можете установить mod_wsgi, скомпилировав пакет www/ap2-wsgi.

Если после первой перезагрузки Apache вы столкнётесь с ошибкой segfaulting дочерних процессов, можете их смело игнорировать. Просто перезапустите сервер.

Создание файла .wsgi

Для запуска вашего приложения вам нужен файл yourapplication.wsgi. Этот файл содержит код, который mod_wsgi выполняет при запуске, чтобы получить объект приложения. Объект, называемый application в этом файле, затем используется как приложение.

Для большинства приложений достаточно следующего файла:

from yourapplication import app as application

Если в файле __init__.py используется функция-фабрика, то функция должна быть импортирована:

from yourapplication import create_app
application = create_app()

Если у вас нет функции-фабрики для создания приложения, но есть экземпляр синглтона, вы можете напрямую импортировать его как application.

Сохраните этот файл где-нибудь, где вы сможете его найти (например: /var/www/yourapplication) и убедитесь, что yourapplication и все используемые библиотеки находятся в пути поиска Python. Если вы не хотите устанавливать их глобально, рассмотрите использование виртуального окружения Python virtual python. Помните, что вам также необходимо установить ваше приложение в виртуальное окружение. В качестве альтернативы можно просто изменить путь в файле .wsgi перед импортом:

import sys
sys.path.insert(0, '/path/to/the/application')

Настройка Apache

Последнее, что вам нужно сделать, это создать конфигурационный файл Apache для вашего приложения. В этом примере мы указываем mod_wsgi выполнить приложение под другим пользователем по соображениям безопасности:

<VirtualHost *>
    ServerName example.com

    WSGIDaemonProcess yourapplication user=user1 group=group1 threads=5
    WSGIScriptAlias / /var/www/yourapplication/yourapplication.wsgi

    <Directory /var/www/yourapplication>
        WSGIProcessGroup yourapplication
        WSGIApplicationGroup %{GLOBAL}
        Order deny,allow
        Allow from all
    </Directory>
</VirtualHost>

Примечание: WSGIDaemonProcess не реализован в Windows, и Apache откажется работать с вышеприведенной конфигурацией. В Windows удалите эти строки:

<VirtualHost *>
    ServerName example.com
    WSGIScriptAlias / C:\yourdir\yourapp.wsgi
    <Directory C:\yourdir>
        Order deny,allow
        Allow from all
    </Directory>
</VirtualHost>

Примечание: Произошли некоторые изменения в конфигурации контроля доступа для Apache 2.4.

В частности, синтаксис разрешений каталогов изменился с httpd 2.2

Order allow,deny
Allow from all

до синтаксиса httpd 2.4

Require all granted

Для получения дополнительной информации обратитесь к документации mod_wsgi.

Устранение неполадок

Если ваше приложение не запускается, воспользуйтесь этим руководством для устранения неполадок:

Проблема: приложение не запускается, в журнале ошибок показано игнорирование SystemExit

В вашем файле приложения есть вызов app.run(), который не защищён условием if __name__ == '__main__':. Либо удалите вызов run() из файла и переместите его в отдельный файл run.py, либо поместите его в такой блок if.

Проблема: приложение даёт ошибки доступа

Вероятно, это вызвано тем, что ваше приложение выполняется не от нужного пользователя. Убедитесь, что папки, к которым приложение должно иметь доступ, имеют соответствующие привилегии, и приложение выполняется от правильного пользователя (параметр user и group директивы WSGIDaemonProcess).

Проблема: приложение завершается с ошибкой при выводе

Обратите внимание, что mod_wsgi запрещает любые операции с sys.stdout и sys.stderr. Можно отключить эту защиту из конфигурации, установив WSGIRestrictStdout в off:

WSGIRestrictStdout Off

В качестве альтернативы, вы также можете заменить стандартный вывод в файле .wsgi другим потоком:

import sys
sys.stdout = sys.stderr

Проблема: доступ к ресурсам даёт ошибки IO

Вероятно, ваше приложение представлено одним файлом .py, который вы установили как символическую ссылку в папку site-packages. Пожалуйста, будьте внимательны, так не работает. Вместо этого необходимо либо поместить папку в путь pythonpath, в которой хранится файл, либо преобразовать ваше приложение в пакет.

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

Поддержка автоматической перезагрузки

Для помощи инструментам развертывания можно активировать поддержку автоматической перезагрузки. Всякий раз, когда что-то изменяется в файле .wsgi, mod_wsgi будет перезагружать все демоны для нас.

Для этого добавьте следующую директиву в раздел Directory:

WSGIScriptReloading On

Работа с виртуальными окружениями

Виртуальные окружения имеют преимущество в том, что они никогда не устанавливают необходимые зависимости глобально, поэтому вы имеете больший контроль над тем, где что используется. Если вы хотите использовать виртуальное окружение с mod_wsgi, вам нужно немного изменить ваш файл .wsgi.

Добавьте следующие строки в начало вашего файла .wsgi:

activate_this = '/path/to/env/bin/activate_this.py'
with open(activate_this) as file_:
    exec(file_.read(), dict(__file__=activate_this))

Это настраивает пути поиска в соответствии с настройками виртуального окружения. Помните, что путь должен быть абсолютным.