Як обслуговувати статичні файли в колбі

Тож це бентежить. У мене є додаток, який я зібрав разом, 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)
        # 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 або іншого веб-сервера для обслуговування статичних файлів; вони зможуть зробити це ефективніше, ніж колба.

Однак ви можете використовувати 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_filesend_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)

Що я використовую (і це чудово працює) - це каталог «шаблони» та «статичний» каталог. Я розміщую всі свої .html файли / шаблони колби всередині каталогу шаблонів, а статичний містить 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

Найпростіший робочий приклад, заснований на інших відповідях:

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 як відповідь, коли хост: 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])```

   За замовчуванням, колба використовує папку "шаблони", щоб містити всі файли шаблонів (будь-який звичайний текстовий файл, але зазвичай .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