Перезавантажте програму Flask, коли файл шаблону змінюється

За замовчуванням, під час запуску програми Flask за допомогою вбудованого сервера ( Flask.run), він відстежує свої файли Python і автоматично перезавантажує програму, якщо її код змінюється:

* Detected change in '/home/xion/hello-world/app.py', reloading
* Restarting with reloader

На жаль, це, здається, працює лише для файлів * .py , і я, здається, не знаходжу жодного способу поширити цю функціональність на інші файли. Найголовніше, було б надзвичайно корисно, щоб Flask перезапустив програму при зміні шаблону . Я втратив підрахунок того, скільки разів возився з розміткою в шаблонах і заплутувався, не бачачи змін, лише з’ясувавши, що програма все ще використовує стару версію шаблону Jinja.

Отже, чи є спосіб мати файли монітора Flask у каталозі шаблонів , або це вимагає занурення у джерело фреймворку?

Редагувати : я використовую Ubuntu 10.10. Ще не пробував цього на жодних інших платформах.

Після подальших досліджень, я виявив , що зміни в шаблонах дійсно будуть оновлені в режимі реального часу, без перезавантаження самої програми. Однак, схоже, це стосується лише тих шаблонів, які передаються flask.render_template.

Але трапляється так, що в моєму додатку у мене є багато багаторазово використовуваних параметризованих компонентів, які я використовую в шаблонах Jinja. Вони реалізовані як {% macro %}s, знаходяться у виділених "модулях" та {% import %}редагуються у фактичні сторінки. Все приємно і СУХО ... за винятком того, що ці імпортовані шаблони, мабуть, ніколи не перевіряються на внесення змін, оскільки вони взагалі не проходять render_template.

(Цікаво, що це не відбувається для шаблонів, що викликаються через {% extends %}. Щодо {% include %}, я не маю уявлення, оскільки я насправді їх не використовую.)

Отже, підсумовуючи, коріння цього явища, здається, лежить десь між Джинджею та Фляшкою чи Веркцогом. Думаю, це може вимагати поїздки до відстежувача помилок для будь-якого з цих проектів :) Тим часом я прийняв jd. відповідь, тому що це рішення, яке я насправді використовував - і воно працює як шарм.

З мого досвіду, шаблони навіть не потребують оновлення програми для перезапуску, оскільки їх слід завантажувати з диска щоразу, коли render_template()їх викликають. Можливо, ваші шаблони використовуються по-різному.

Щоб перезавантажити програму, коли змінюються шаблони (або будь-який інший файл), ви можете передати extra_filesаргумент Flask().run()колекції назв файлів для перегляду: будь-яка зміна цих файлів спричинить перезавантаження.

Приклад:

from os import path, walk

extra_dirs = ['directory/to/watch',]
extra_files = extra_dirs[:]
for extra_dir in extra_dirs:
    for dirname, dirs, files in walk(extra_dir):
        for filename in files:
            filename = path.join(dirname, filename)
            if path.isfile(filename):
                extra_files.append(filename)
app.run(extra_files=extra_files)

Дивіться тут: http://werkzeug.pocoo.org/docs/0.10/serving/?highlight=run_simple#werkzeug.serving.run_simple

ви можете використовувати

TEMPLATES_AUTO_RELOAD = True

З http://flask.pocoo.org/docs/1.0/config/

Чи потрібно перевіряти модифікації джерела шаблону та перезавантажувати його автоматично. За замовчуванням значення None, що означає, що Flask перевіряє оригінальний файл лише в режимі налагодження.

Коли ви працюєте з jinjaшаблонами, вам потрібно встановити деякі параметри. У моєму випадку з python3 я вирішив це за допомогою наступного коду:

if __name__ == '__main__':
    app.jinja_env.auto_reload = True
    app.config['TEMPLATES_AUTO_RELOAD'] = True
    app.run(debug=True, host='0.0.0.0')

Для мене це чудово працює:

 from flask import Flask, render_template, request, url_for, redirect
 app = Flask(__name__)
 app.config["TEMPLATES_AUTO_RELOAD"] = True

Детальніше див. На http://flask.pocoo.org/docs/1.0/config/

Насправді у мене TEMPLATES_AUTO_RELOAD = Trueце не працює (версія 0,12). Я використовую jinja2 і те, що я зробив:

1. Створити функцію before_request

   def before_request():
       app.jinja_env.cache = {}

2. Зареєструйте його в додатку

   app.before_request(before_request)

3. Це воно.

У мене спрацювало лише додавання цього:

@app.before_request
def before_request():
    # When you import jinja2 macros, they get cached which is annoying for local
    # development, so wipe the cache every request.
    if 'localhost' in request.host_url or '0.0.0.0' in request.host_url:
        app.jinja_env.cache = {}

( взято з відповіді @ dikkini )

Використовуючи останню версію Flask для Windows, використовуючи команду запуску та налагодження, встановлену на true; Колбу не потрібно скидати, щоб зміни в шаблонах були введені в дію. Спробуйте Shift + F5 (або Shift плюс кнопка перезавантаження), щоб переконатися, що він не кешований.

Дивіться http://flask.pocoo.org/docs/1.0/quickstart/ та використовуйтеFLASK_ENV=development

Оновлено станом на червень 2019 року:

CLI колби рекомендується над app.run () для запуску сервера розробника, тому якщо ми хочемо використовувати CLI , то прийняте рішення не може бути використаний.

Використання версії Flask (1.1) для розробки на момент написання статті дозволяє нам встановити змінну середовища FLASK_RUN_EXTRA_FILES, яка фактично робить те саме, що і прийнята відповідь.

Дивіться цю проблему github .

Приклад використання:

export FLASK_RUN_EXTRA_FILES="app/templates/index.html"
flask run

в Linux. Щоб вказати кілька зайвих файлів, розділіть шляхи до файлів двокрапками. , напр

export FLASK_RUN_EXTRA_FILES="app/templates/index.html:app/templates/other.html"

CLI також підтримує --extra-filesаргумент станом на Flask 1.1.

Шаблони перезавантажуються автоматично, чому б не зробити ctrl+f5оновлення веб-сторінки, оскільки веб-браузери зазвичай зберігають кеш.