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

Так что это неловко. У меня есть приложение, которое я собрал вместе в Flask, и на данный момент он просто обслуживает одну статическую HTML-страницу с некоторыми ссылками на CSS и JS. И я не могу найти, где в документации Flask описывается возврат статических файлов. Да, я мог бы использовать render_template, но я знаю, что данные не temtatized. Я бы подумал, что send_file или url_for это правильная вещь, но я не мог заставить их работать. Тем временем я открываю файлы, читаю контент и настраиваю Response с соответствующим типом mimetype:

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)
        # Figure out how flask returns static files
        # Tried:
        # - render_template
        # - send_file
        # This should not be so non-obvious
        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)

Кто-то хочет дать образец кода или URL-адрес для этого? Я знаю, что это будет очень просто.

Ответы

Ответ 1

Предпочтительным методом является использование nginx или другого веб-сервера для обслуживания статических файлов; они смогут сделать это более эффективно, чем Flask.

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

from flask import Flask, request, send_from_directory

# set the project root directory as the static folder, you can set others.
app = Flask(__name__, static_url_path='')

@app.route('/js/<path:path>')
def send_js(path):
    return send_from_directory('js', path)

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

Do не используйте send_file или send_static_file с указанным пользователем путем.

send_static_file пример:

from flask import Flask, request
# set the project root directory as the static folder, you can set others.
app = Flask(__name__, static_url_path='')

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

Ответ 2

Если вы просто хотите переместить расположение ваших статических файлов, тогда самый простой способ - объявить пути в конструкторе. В приведенном ниже примере я переместил свои шаблоны и статические файлы в подпапку с именем web.

app = Flask(__name__,
            static_url_path='', 
            static_folder='web/static',
            template_folder='web/templates')
  • static_url_path='' удаляет любой предыдущий путь из URL (т.е. по умолчанию /static).
  • static_folder='web/static' скажет Flask, чтобы он обслуживал файлы, найденные на web/static.
  • template_folder='web/templates', аналогично, это меняет папка шаблонов.

Используя этот метод, следующий URL вернет файл CSS:

<link rel="stylesheet" type="text/css" href="/css/bootstrap.min.css">

И, наконец, краткий обзор структуры папок, где flask_server.py - это экземпляр Flask:

Nested Static Flask Folders

Ответ 3

Я уверен, что вы найдете то, что вам нужно: http://flask.pocoo.org/docs/quickstart/#static-files

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

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

Ответ 4

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

app = Flask(__name__, static_url_path='/static')

С помощью этого набора вы можете использовать стандартный HTML:

<link rel="stylesheet" type="text/css" href="/static/style.css">

Ответ 5

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

send_static_file(filename)
Функция, используемая внутренне для отправки статического файлы из статической папки в браузер.

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

Ответ 6

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

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

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

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

Здесь ссылка на "каноническое" неофициальное учебное пособие по фляге - множество замечательных советов здесь, чтобы помочь вам попасть в землю.

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

Ответ 7

Самый простой рабочий пример, основанный на других ответах, следующий:

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>Hello World!</title>
</head>
<body>
    <div>
         <p>
            This is a test.
         </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, поэтому дайте им верхнюю часть.

Ответ 8

Для angular + потока шаблонов, который создает следующее дерево папок:

backend/
|
|------ui/
|      |------------------build/          <--'static' folder, constructed by Grunt
|      |--<proj           |----vendors/   <-- angular.js and others here
|      |--     folders>   |----src/       <-- your js
|                         |----index.html <-- your SPA entrypoint 
|------<proj
|------     folders>
|
|------view.py  <-- Flask app here

Я использую следующее решение:

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


@app.route('/', methods=['GET'])
def redirect_to_index():
    return send_from_directory(root, 'index.html')
...

Это помогает переопределить "статическую" папку для пользовательских.

Ответ 9

Итак, я все заработал (основываясь на ответе @user1671599) и хотел поделиться этим с вами, ребята.

(Я надеюсь, что я делаю это правильно, так как это мое первое приложение на Python)

Я сделал это -

Структура проекта:

enter image description here

server.py:

from server.AppStarter import AppStarter
import os

static_folder_root = os.path.join(os.path.dirname(os.path.abspath(__file__)), "client")

app = AppStarter()
app.register_routes_to_resources(static_folder_root)
app.run(__name__)

AppStarter.py:

from flask import Flask, send_from_directory
from flask_restful import Api, Resource
from server.ApiResources.TodoList import TodoList
from server.ApiResources.Todo import Todo


class AppStarter(Resource):
    def __init__(self):
        self._static_files_root_folder_path = ''  # Default is current folder
        self._app = Flask(__name__)  # , static_folder='client', static_url_path='')
        self._api = Api(self._app)

    def _register_static_server(self, static_files_root_folder_path):
        self._static_files_root_folder_path = static_files_root_folder_path
        self._app.add_url_rule('/<path:file_relative_path_to_root>', 'serve_page', self._serve_page, methods=['GET'])
        self._app.add_url_rule('/', 'index', self._goto_index, methods=['GET'])

    def register_routes_to_resources(self, static_files_root_folder_path):

        self._register_static_server(static_files_root_folder_path)
        self._api.add_resource(TodoList, '/todos')
        self._api.add_resource(Todo, '/todos/<todo_id>')

    def _goto_index(self):
        return self._serve_page("index.html")

    def _serve_page(self, file_relative_path_to_root):
        return send_from_directory(self._static_files_root_folder_path, file_relative_path_to_root)

    def run(self, module_name):
        if module_name == '__main__':
            self._app.run(debug=True)

Ответ 10

Мысль о совместном использовании.... этот пример.

from flask import Flask
app = Flask(__name__)

@app.route('/loading/')
def hello_world():
    data = open('sample.html').read()    
    return data

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

Это работает лучше и проще.

Ответ 11

Один из простых способов сделать. Ура!

demo.py

from flask import Flask, render_template
app = Flask(__name__)

@app.route("/")
def index():
   return render_template("index.html")

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

Теперь создайте имя папки под названием шаблоны. Добавьте ваш файл index.html в папку с шаблонами

index.html

<!DOCTYPE html>
<html>
<head>
    <title>Python Web Application</title>
</head>
<body>
    <div>
         <p>
            Welcomes You!!
         </p>
    </div>
</body>
</html>

Структура проекта

-demo.py
-templates/index.html

Ответ 12

from flask import redirect, url_for
...
@app.route('/', methods=['GET'])
def metrics():
    return redirect(url_for('static', filename='jenkins_analytics.html'))

Здесь хранятся все файлы (css и js...), указанные в вашем html файле.

Ответ 13

Все ответы хорошие, но для меня хорошо работает простая функция send_file из Flask. Это хорошо работает, когда вам просто нужно отправить html файл в качестве ответа, когда host: port/ApiName покажет вывод файла в браузере


@app.route('/ApiName')
def ApiFunc():
    try:
        return send_file('some-other-directory-than-root/your-file.extension')
    except Exception as e:
        logging.info(e.args[0])'''

Ответ 14

    По умолчанию фляга использует папку "шаблоны", чтобы содержать все ваши файлы шаблонов (любой текстовый файл, но обычно .html или какой-то язык шаблонов, такой как jinja2) и "static", чтобы содержать все ваши статические файлы (т.е. .js .css и ваши изображения).
    В вашем routes вы можете использовать render_template() для рендеринга файла шаблона (как я сказал выше, по умолчанию он помещается в папку templates) в качестве ответа для вашего запроса. И в файле шаблона (обычно это файл в формате .html), вы можете использовать некоторые файлы .js и/или `.css ', поэтому, я думаю, ваш вопрос заключается в том, как увязать эти статические файлы с текущим файлом шаблона.

Ответ 15

Если вы просто пытаетесь открыть файл, вы можете использовать app.open_resource(). Поэтому чтение файла будет выглядеть примерно так:

with app.open_resource('/static/path/yourfile'):
      #code to read the file and do something

Ответ 16

Самый простой способ - создать статическую папку внутри основной папки проекта. Статическая папка содержит файлы .css.

главная папка

/Main Folder
/Main Folder/templates
/Main Folder/static
/Main Folderapplication.py(flask script)

колбу

from flask import Flask, render_template

app = Flask(__name__)

@app.route("/")
def login():
    return render_template("login.html")

html (макет)

<!DOCTYPE html>
<html>
    <head>
        <title>Project(1)</title>
        <link rel="stylesheet" href="/static/styles.css">
     </head>
    <body>
        <header>
            <div class="container">
                <nav>
                    <a class="title" href="">Kamook</a>
                    <a class="text" href="">Sign Up</a>
                    <a class="text" href="">Log In</a>
                </nav>
            </div>
        </header>  
        {% block body %}
        {% endblock %}
    </body>
</html>

HTML

{% extends "layout.html" %}

{% block body %}
    <div class="col">
        <input type="text" name="username" placeholder="Username" required>
        <input type="password" name="password" placeholder="Password" required>
        <input type="submit" value="Login">
    </div>
{% endblock %}