8

Как обслуживать статические файлы в Flask

8

Неудобная ситуация. Я разрабатываю приложение на Flask, и на данный момент оно просто отображает одну статическую HTML-страницу с ссылками на CSS и JS. Однако я не могу найти в документации Flask информацию о том, как возвращать статические файлы. Да, я мог бы использовать render_template, но я знаю, что данные не являются шаблонами. Я подумал, что send_file или url_for подходят для этой задачи, но не смог заставить их работать. В результате я открываю файлы, читаю содержимое и создаю объект Response с соответствующим типом содержимого.

Вот что у меня получается:

import os.path
from flask import Flask, Response

app = Flask(__name__)
app.config.from_object(__name__)

def root_dir():  # pragma: no cover
    return os.path.abspath(os.path.dirname(__file__))

def get_file(filename):  # pragma: no cover
    try:
        src = os.path.join(root_dir(), filename)
        # Пытаюсь разобраться, как Flask возвращает статические файлы
        # Пробовал:
        # - render_template
        # - send_file
        # Это не должно быть так неочевидно
        return open(src).read()
    except IOError as exc:
        return str(exc)

@app.route('/', methods=['GET'])
def metrics():  # pragma: no cover
    content = get_file('jenkins_analytics.html')
    return Response(content, mimetype="text/html")

@app.route('/', defaults={'path': ''})
@app.route('/<path:path>')
def get_resource(path):  # pragma: no cover
    mimetypes = {
        ".css": "text/css",
        ".html": "text/html",
        ".js": "application/javascript",
    }
    complete_path = os.path.join(root_dir(), path)
    ext = os.path.splitext(path)[1]
    mimetype = mimetypes.get(ext, "text/html")
    content = get_file(complete_path)
    return Response(content, mimetype=mimetype)

if __name__ == '__main__':  # pragma: no cover
    app.run(port=80)

Кто-нибудь может предложить пример кода или ссылку на это? Я знаю, что это должно быть очень просто.

5 ответ(ов)

0

Вы можете найти необходимую информацию по этой ссылке: http://flask.pocoo.org/docs/quickstart/#static-files.

В общем, вам просто нужно создать папку "static" в корне вашего пакета. После этого вы можете использовать url_for('static', filename='foo.bar') или напрямую ссылаться на ваши файлы по адресу http://example.com/static/foo.bar.

Как уже упоминалось в комментариях, вы могли бы использовать URL-адрес '/static/foo.bar' напрямую, НО накладные расходы от использования url_for() с точки зрения производительности довольно низки, и использование этой функции позволяет вам проще настраивать поведение в будущем (например, изменить папку, изменить URL-адрес, перенести ваши статические файлы на S3 и т.д.).

0

Вы можете использовать следующую функцию:

send_static_file(filename)

Эта функция используется внутренне для отправки статических файлов из папки статических файлов в браузер.

Пример использования в приложении Flask:

from flask import Flask

app = Flask(__name__)

@app.route('/<path:path>')
def static_file(path):
    return app.send_static_file(path)

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

0

Я использую структуру с директорией "templates" и директорией "static", и это отлично работает. Все свои .html файлы/шаблоны Flask я помещаю в папку templates, а в папке static хранятся CSS и JS файлы. На мой взгляд, функция render_template работает хорошо для обычных HTML файлов, независимо от того, насколько широко вы используете синтаксис шаблонов Flask. Вот пример вызова в моем файле views.py:

@app.route('/projects')
def projects():
    return render_template("projects.html", title='Projects')

Обязательно используйте url_for() при ссылке на статические файлы в отдельной папке static. Вероятно, вам все равно придется использовать это при указании путей к CSS/JS файлам в HTML. Например:

<script src="{{ url_for('static', filename='styles/dist/js/bootstrap.js') }}"></script>

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

http://blog.miguelgrinberg.com/post/the-flask-mega-tutorial-part-i-hello-world

0

Простой рабочий пример на основе других ответов:

from flask import Flask, request
app = Flask(__name__, static_url_path='')

@app.route('/index/')
def root():
    return app.send_static_file('index.html')

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

С HTML-файлом под названием index.html:

<!DOCTYPE html>
<html>
<head>
    <title>Привет, мир!</title>
</head>
<body>
    <div>
        <p>Это тест.</p>
    </div>
</body>
</html>

ВАЖНО: Убедитесь, что index.html находится в папке под названием static, что означает, что <projectpath> содержит .py файл, а <projectpath>/static содержит html файл.

Если вы хотите, чтобы сервер был видим в сети, используйте app.run(debug=True, host='0.0.0.0').

Чтобы отображать все файлы в папке по запросу, используйте следующий код:

@app.route('/<path:path>')
def static_file(path):
    return app.send_static_file(path)

Это по сути ответ BlackMamba, поэтому не забудьте оценить его.

0

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

Вот пример, как можно реализовать это в вашем view.py:

import os
from flask import Flask, send_from_directory

app = Flask(__name__)

# Определение пути к папке `build`
root = os.path.join(os.path.dirname(os.path.abspath(__file__)), "ui", "build")

# Обработка запросов к статическим файлам
@app.route('/<path:path>', methods=['GET'])
def static_proxy(path):
    return send_from_directory(root, path)

# Перенаправление на `index.html` при заходе на корневой путь
@app.route('/', methods=['GET'])
def redirect_to_index():
    return send_from_directory(root, 'index.html')

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

Объяснение:

  1. Импорт модулей: Мы импортируем необходимые модули из Flask и os, чтобы работать с файловой системой.

  2. Определение маршрутов:

    • static_proxy(path): Этот маршрут будет обрабатывать все запросы к статическим ресурсам, например, к JS-файлам и другим ресурсам, находящимся в папке build.
    • redirect_to_index(): Этот маршрут перенаправляет запросы на корень (/) к вашему index.html, что позволяет начать загрузку SPA (Single Page Application).

Заключение:

Используя этот подход, вы можете легко переопределить стандартную папку для статических файлов и настроить ваше Angular-приложение для работы с Flask. Убедитесь, что пути к ресурсам в вашем index.html корректные, чтобы все файлы загружались правильно.

Чтобы ответить на вопрос, пожалуйста, войдите или зарегистрируйтесь