Error could not locate a flask application

This error happens when flask run command is run before setting The FLASK_APP environment variable.

How to reproduce the error:

mkdir flask_test

cd flask_test

pipenv shell

pipenv install Flask

Then write the following code inside the flask_test directory and save it as hello_flask.py

from flask import Flask
app = Flask(__name__)


@app.route('/')
def hello_world():
    return 'Hello World!'

if __name__ == '__main__':
    app.run()

Then run the following command:

flask run

The error:

 * Environment: production
   WARNING: This is a development server. Do not use it in a production deployment.
   Use a production WSGI server instead.
 * Debug mode: off
Usage: flask run [OPTIONS]
Try 'flask run --help' for help.

Error: Could not locate a Flask application. You did not provide the "FLASK_APP" environment variable, and a "wsgi.py" or "app.py" module was not found in the current directory.

How to fix it:

The flask command must be told where to find your application in order to use it. The FLASK_APP environment variable is used to specify how to load the application.

To set the FLASK_APP environment run the following command.

• On Powershell

 $env:FLASK_APP = "hello_flask"

• CMD

set FLASK_APP=hello

• On Bash

export FLASK_APP=hello

Then finally the command flask run can run normally.

Output:

 * Serving Flask app 'hello_flask' (lazy loading)
 * Environment: production
   WARNING: This is a development server. Do not use it in a production deployment.
   Use a production WSGI server instead.
 * Debug mode: off
 * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)

Нажмите выше «Школа программирования«, выберите как»Установить звезду”

Качественные изделия с доставкой немедленно!

Автор: Ли Хуэй, веб-разработчик

Источник: greyli.com

Строго говоря, это не ошибка, а конструкция, которая легко может привести к ошибкам.

Конкретное поведение заключается в том, что если вы установите python-dotenv и создадите файл .env или .flaskenv в верхнем каталоге программы Flask, вы не сможете успешно выполнять такие команды, как запуск flask, потому что это приведет к сбою Flask. чтобы найти соответствующий пример программы Flask.

Эта проблема существует с тех пор, как Flask представила механизм CLI, и она беспокоила меня в течение двух лет. За 18 лет я случайно создал файл .env в корневом каталоге пользователя и обнаружил, что программа Flask не может работать. В то время было слишком много различных ошибок, и я не тщательно рассмотрел взаимосвязь между ними. Позже, после нескольких тестов, было определено, что это было вызвано файлами .env и .flaskenv в верхнем каталоге, но причина не была обнаружена некоторое время, и она была временно устранена. До 19 ноября на расследование ушло несколько часов, но причины так и не нашли.

Потребовалось много времени, чтобы отследить специфичную для Windows ошибку Flask (TypeError: окружение может содержать только строки), что действительно пугает. Поскольку интерфейс командной строки Flask включает в себя слишком много вещей, иногда вам нужно углубиться в python-dotenv (# 101) и Werkzeug (# 1320), чтобы найти причину проблемы.

Но если проблема не будет решена, вы никогда не будете спать спокойно. Все примеры программ из первой части «Flask Web Development Actual Combat» помещаются в репозиторий программ, и все они помещаются в подкаталоги, что означает, что если читатели по ошибке создают файлы .env и .flaskenv в корневом каталоге хранилища , это приведет к невозможности запуска шести программ-примеров в подкаталоге. До и после было получено около 6 связанных отзывов читателей. Хотя на веб-сайт было добавлено напоминание, а в переизданную книгу — напоминание о создании файла .env / .flaskenv, это не решило проблему после все, и всегда будет кто-то Вы можете пропустить все советы идеально.

Если каждый может отметить место ошибки в книге и поделиться им, тогда на этой странице должно быть много маленьких красных крестиков (см. «Производство Super Mario», возможно, в какой-то платформе для электронных книг эта функция будет реализована в будущем: P) .

Несколько дней назад, учитывая напоминание об этой проблеме, потребовалось еще два часа, чтобы исследовать и наконец найти причину на этот раз. С добавлением PR (# 3560) и Issue (# 3561) потребовалось в общей сложности 8 часов в течение двух лет, и эта проблема наконец решилась. Если не неожиданно, ожидается, что он будет обновлен в следующей версии Flask. Вот конкретные причины.

Я думал, что эта проблема связана с python-dotenv или Werkzeug, но я не ожидал, что это просто проблема с кодом самого Flask. Я был слишком глуп. Эту проблему можно было решить раньше.

В соответствии с предопределенным поведением, когда установлен python-dotenv, Flask автоматически загружает переменные среды в .env и .flaskenv. Когда python-dotenv ищет файлы, в которых хранятся переменные среды, он ищет вверх от текущего каталога и возвращает соответствующий путь к файлу, если он найден. Но в это время, если Flask обнаружит, что каталог, в котором находится .env или .flaskenv, не является текущим каталогом, он переключит текущий рабочий каталог на каталог, в котором расположены .env и .flaskenv (связанный исходный код). И если ваш программный модуль или пакет не находится в том же каталоге, что и .env / .flaskenv, экземпляр программы не будет найден.

Для воспроизведения выполните следующие действия:

$ git clone https://github.com/greyli/flask-env-test
$ cd flask-env-test
$ pip install -r requirements.txt  # or just pip install flask[dotenv]
$ cd hello
$ flask run

Файловая структура примера проекта следующая:

- flask-env-test
    - .env
    - hello
        - app.py

Когда вы сохраняете программу в файле app.py как пример программы, запустите flask run, и вы увидите следующую ошибку:

$ flask run
 * Environment: production
   WARNING: This is a development server. Do not use it in a production deployment.
   Use a production WSGI server instead.
 * Debug mode: off
Usage: flask run [OPTIONS]
 
Error: Could not locate a Flask application. You did not provide the "FLASK_APP" environment variable, and a "wsgi.py" or "app.py" module was not found in the current directory.

Если вы используете FLASK_APP для указания пути импорта программы, ошибка, вероятно, будет такой:

$ flask run
 * Serving Flask app "myapp"
 * Environment: production
   WARNING: This is a development server. Do not use it in a production deployment.
   Use a production WSGI server instead.
 * Debug mode: off
Usage: flask run [OPTIONS]
 
Error: Could not import "myapp".

Ссылки по теме

• https://github.com/greyli/helloflask/issues/200

• https://github.com/pallets/flask/issues/3561

• https://github.com/pallets/flask/pull/3560

Выпущена стабильная версия PyCharm 2020.1

pip install претерпит серьезные изменения в этом году!

Набор библиотек инструментов, настоятельно рекомендуемых после входа в Python

Актуальный бой: Flask + Vue генерируют красивое облако слов

Github популярен, программисты хотят получить высокооплачиваемые предложения, чтобы проверить его

Ответьте на "ключевые слова" ниже, чтобы получить качественные ресурсы

 Ответьте на ключевое слово "pybook03", чтобы немедленно получить электронную версию "Think Python 2e", переведенную домашней страницей и друзьями.
 Ответьте на ключевое слово "Introduction", чтобы сразу получить электронную версию 10 вводных книг по Python, собранных на домашней странице.
 Ответьте на ключевое слово "m", чтобы сразу получить подборку избранных высококачественных статей на Python.
 Ответьте на ключевое слово "номер книги", замените номер цифрой от 0 и выше, есть сюрпризы и подарки ~
 Заглавное изображение: pexels, авторизовано CC0.

 Хорошая статья, читаю ❤️

С появлением интерфейса командной строки Flask, одна из самых раздражающих вещей, которые вы должны делать во время разработки, — это устанавливать переменные среды каждый раз, когда вы работаете над своим приложением, а именно FLASK_ENV и FLASK_APP. Но, у Flask есть способ справиться с этими вещами так, чтобы сделать это только один раз. И с помощью той же функциональности вы также можете добавить другие переменные окружения для вашего проекта. В этой статье я покажу вам, как использовать python-dotenv для загрузки переменных окружения, готовых к работе при каждом запуске приложения.

Единственный пакет, который заставляет все это работать — это python-dotenv

Что мы будем строить

Я собираюсь продемонстрировать, как это работает, через очень простое приложение Flask.

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

demo/__init__.py
demo/settings.py
.env
.flaskenv
run.py

Это приложение не будет делать ничего особенного. Оно просто покажет нам, какие значения конфигурации у нас есть.

Настройка проекта

Для начала в командной строке создайте новую виртуальную среду и установите flask и python-dotenv. Я использую pipenv, так что я могу сделать все это за один шаг:

pipenv install flask python-dotenv
pipenv shell

Затем в demo/__ init__.py нам нужно будет создать основы приложения Flask, что означает импорт Flask, создание фабричной функции приложения (create_app) и создание экземпляра Flask. Вот код, чтобы сделать это.

from flask import Flask 

def create_app():
    app = Flask(__name__)

    return app

Если вы уже работали с Flask, то вы точно знаете, как это работает.

Далее, давайте добавим простой маршрут, чтобы мы знали, что наше приложение действительно работает.

from flask import Flask 

def create_app():
    app = Flask(__name__)

    @app.route('/')
    def index():
        return '
Hey There!
'

    return app

Добавление переменой окружения FLASK_APP

Как только мы это сделаем, мы можем использовать интерфейс командной строки Flask для запуска приложения. Чтобы запустить приложение, используйте следующую команду, находясь в корневом каталоге вашего проекта.

Но когда мы выполним эту команду, мы получаем ошибку!

Error: Could not locate a Flask application. You did not provide the "FLASK_APP" environment variable, and a "wsgi.py" or "app.py" module was not found in the current directory.

Это распространенная ошибка. Обычно, чтобы это исправить, мы экспортируем переменную окружения FLASK_APP, которая будет равна имени каталога нашего приложения, например:

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

У нас есть два дот файла: .env и .flaskenv. Мы хотим использовать .flaskenv для любых команд конфигурации Flask CLI и использовать .env для конфигурации нашего приложения.

Мы поместим нашу переменную среды FLASK_APP в файл .flaskenv.

Теперь, когда мы добавили эту строку, давайте попробуем снова запустить приложение.

И откроем в браузере localhost:5000 или 127.0.0.1:5000, чтобы увидеть результат.

Обратите внимание на сообщение, которое появляется в командной строке, в котором говорится, что мы в режиме отладки.

Теперь, если мы прекратим работу над этим проектом и вернемся позже, все, что нам нужно сделать, — это запустить Flask и приложение запустится без необходимости повторного указания своего местоположения.

Параметры Flask CLI

Допустим, мы хотим изменить некоторые другие параметры Flask CLI, мы можем поместить их в наш файл .flaskenv.

Вот несколько вариантов:

1. FLASK_ENV — контролирует окружающую среду.
2. FLASK_DEBUG — включает режим отладки.
3. FLASK_RUN_EXTRA_FILES — Список файлов, которые будут просматриваться перегрузчиком в дополнение к модулям Python.
4. FLASK_RUN_HOST — хост, с которым вы хотите связать свое приложение.
5. FLASK_RUN_PORT — Порт, который вы хотите использовать.
6. FLASK_RUN_CERT — файл сертификата, чтобы ваше приложение могло работать с HTTPS.
7. FLASK_RUN_KEY — ключевой файл для вашего сертификата.

Я думаю, что наиболее распространенными из них являются FLASK_ENV, FLASK_RUN_PORT и FLASK_RUN_EXTRA_FILES, поэтому я создам примеры с ними здесь.

Давайте начнем с FLASK_ENV. По умолчанию это «production», которое не делает ничего заметного. Суть среды в том, что вы можете решить, какие действия предпринять в приложении, в зависимости от среды. Например, вы можете сделать что-то вроде создания библиотеки Sentry для регистрации ошибок, когда вы в production, а не в development.

Если вы измените свой FLASK_ENV на development, самое большое изменение, которое вы увидите, это то, что reloader начинает работать, и ваше приложение переводится в режим отладки. Итак, давайте установим это значение в нашем файле .flaskenv.

FLASK_APP=demo
FLASK_ENV=development

Давайте остановим сервер и снова запустим наше приложение.

Обратите внимание, как сообщение меняется сейчас.

Давайте добавим еще один для порта.

FLASK_APP=demo
FLASK_ENV=development
FLASK_RUN_PORT=8080

После перезапуска мы должны получить доступ к нашему сайту через порт 8080:

Что если мы не хотим останавливать и перезапускать наше приложение, когда мы изменяем не-py-файлы в нашем проекте? Мы можем использовать FLASK_RUN_EXTRA_FILES для этого. Например, чтобы посмотреть файлы с именами config.yml и README.md

FLASK_RUN_EXTRA_FILES=config.yml:README.md

(Если вы используете Windows, вам нужно использовать точку с запятой (;) вместо двоеточия (:) для разделения нескольких файлов)

Добавляем .env

Теперь, когда мы поработали с .flaskenv, давайте перейдем к добавлению переменных в файл .env. Мы будем использовать их в нашем приложении.

Одно из преимуществ наличия .env для хранения переменных среды нашего приложения заключается в том, что мы можем легко иметь несколько версий файла для каждого места, где мы запускаем наше приложение. Например, у нас может быть один для нашей локальной машины, один для промежуточной среды, один для production и т.д.

Давайте добавим два:

SECRET_KEY=topsecretkey
API_KEY=donotsharethisapikeywithanyone

В отличие от значений, добавленных перед FLASK_ в нашем файле .flaskenv, переменные в .env не предназначены для автоматической загрузки в CLI. Вместо этого нам нужно загрузить их в наше приложение. Для этого мы будем использовать файл settings.py.

Внутри файла settings.py давайте импортируем среду из ОС, чтобы у нас был доступ к переменным среды.

from os import environ 

Далее нам нужно присвоить эти переменные окружения переменным Python, а затем мы загрузим их в наше приложение.

from os import environ 

SECRET_KEY = environ.get('SECRET_KEY')
API_KEY = environ.get('API_KEY')

Далее, давайте добавим конфигурацию из этого файла в наш __init__.py.

from flask import Flask 

def create_app():
    app = Flask(__name__)

    app.config.from_pyfile('settings.py')

    @app.route('/')
    def index():
        return '
Hey There!
'

    return app

Теперь наши переменные окружения готовы к использованию. В случае SECRET_KEY, обычно некоторые расширения Flask, которые мы используем, подхватывают это и используют его автоматически. Для API_KEY нам нужно использовать это непосредственно в нашем коде.

В нашем коде мы просто отобразим API_KEY на нашем маршруте.

from flask import Flask 

def create_app():
    app = Flask(__name__)

    app.config.from_pyfile('settings.py')

    @app.route('/')
    def index():
        return f'API_KEY = { app.config.get("API_KEY") }'

    return app

Работа в production

Если вы хотите использовать ваши файлы .dotenv в рабочей среде, вам нужно внести небольшое изменение, поскольку вы не будете использовать интерфейс командной строки Flask на рабочем сервере.

Если вы хотите увидеть эту работу, вы можете установить gunicorn, чтобы вам не приходилось использовать сервер разработки для Flask.

Нам нужно создать файл, в котором gunicorn сможет найти объект приложения. Для этого мы создадим run.py. Давайте начнем со стандартного кода, который не загружает переменные среды, который состоит всего из двух строк.

from demo import create_app

app = create_app()
gunicorn run:app

Это должно работать на порту 8000 по умолчанию. Если вы перейдете в браузер, вы увидите, что значением API_KEY является None.

Это потому, что переменные окружения больше не загружаются для нас. Чтобы загрузить их, нам нужно использовать функцию load_dotenv из python-dotenv. Нам нужно добавить еще две строки кода:

from demo import create_app
from dotenv import load_dotenv

load_dotenv('.env') #the path to your .env file (or any other file of environment variables you want to load)

app = create_app()

Теперь, если мы снова запустим сервер с gunicorn, мы увидим наше значение API_KEY.