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

Так что это неловко. У меня есть приложение, которое я добавил вместе, Flaskи на данный момент оно просто обслуживает одну статическую HTML-страницу с некоторыми ссылками на CSS и JS. И я не могу найти, где в документации Flaskописано возвращение статических файлов. Да, я мог бы использовать, render_templateно я знаю, что данные не шаблонизированы. Я бы подумал 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 для этого? Я знаю, что это будет очень просто.

Предпочтительным методом является использование 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()

Как не использовать 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')

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

app = Flask(__name__,
            static_url_path='', 
            static_folder='web/static',
            template_folder='web/templates')

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

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

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

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

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

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

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

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

Я уверен, что вы найдете там то, что вам нужно: 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 и т. д.).

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

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

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

То, что я использую (и оно отлично работает) - это каталог «templates» и «static». Я помещаю все мои файлы .html / шаблоны Flask в каталог шаблонов, а 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>

Вот ссылка на «каноническое» неофициальное руководство Flask - здесь много полезных советов, которые помогут вам начать работу.

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

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

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 в папке называется статическим , то есть <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ответом, так что дайте им голос.

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

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

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

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

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

Я сделал это -

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

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)

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

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

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

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

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

Используйте redirectиurl_for

from flask import redirect, url_for

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

Это серверы всех файлов (css & js ...), указанных в вашем html.

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

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

/Main Folder
/Main Folder/templates/foo.html
/Main Folder/static/foo.css
/Main Folder/application.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 %}

app = Flask(__name__, static_folder="your path to static")

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

Все ответы хорошие, но для меня хорошо работало только использование простой функции send_fileFlask. Это хорошо работает, когда вам просто нужно отправить 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])```

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

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

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