Cómo servir archivos estáticos en Flask
Así que esto es vergonzoso. Tengo una aplicación que he juntado en Flask y por ahora solo está sirviendo una sola página HTML estática con algunos enlaces a CSS y JS. Y no puedo encontrar dónde en la documentación Flask describe devolver archivos estáticos. Sí, podría usar render_template pero sé que los datos no están templatizados. Hubiera pensado que send_file o url_for era lo correcto, pero no pude hacer que funcionaran. Mientras tanto, estoy abriendo los archivos, leyendo contenido, y amañando un Response con el tipo mime apropiado:
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)
¿Alguien quiere dar una muestra de código o url para esto? Sé que esto va a ser muy simple.
13 answers
El método preferido es usar nginx u otro servidor web para servir archivos estáticos; podrán hacerlo de manera más eficiente que Flask.
Sin embargo, puede utilizar send_from_directory para enviar archivos desde un directorio, lo que puede ser bastante conveniente en algunas situaciones:
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 not use send_file o send_static_file con una ruta suministrada por el usuario.
send_static_file ejemplo:
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')
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/ajaxhispano.com/template/agent.layouts/content.php on line 61
2016-01-27 03:09:49
Estoy seguro de que encontrarás lo que necesitas allí: http://flask.pocoo.org/docs/quickstart/#static-files
Básicamente solo necesita una carpeta "estática" en la raíz de su paquete, y luego puede usar url_for('static', filename='foo.bar') o enlazar directamente a sus archivos con http://example.com/static/foo.bar .
EDITAR : Como se sugiere en los comentarios, podría usar directamente la ruta de URL '/static/foo.bar' PERO url_for() la sobrecarga (en cuanto al rendimiento) es bastante baja, y usarla significa que ser capaz de personalizar fácilmente el comportamiento después (cambiar la carpeta, cambiar la ruta de URL, mover sus archivos estáticos a S3, etc.).
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/ajaxhispano.com/template/agent.layouts/content.php on line 61
2014-12-27 10:49:59
También puede, y este es mi favorito, establecer una carpeta como ruta estática para que los archivos dentro sean accesibles para todos.
app = Flask(__name__, static_url_path='/static')
Con ese conjunto se puede utilizar el HTML estándar:
<link rel="stylesheet" type="text/css" href="/static/style.css">
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/ajaxhispano.com/template/agent.layouts/content.php on line 61
2014-10-24 19:02:06
Lo que uso (y ha estado funcionando muy bien) es un directorio "templates" y un directorio "static". Coloco todo mi .html files / Flask templates dentro del directorio templates, y static contiene CSS / JS. render_template funciona bien para archivos html genéricos que yo sepa, independientemente de la extensión en la que haya utilizado la sintaxis de plantillas de Flask. A continuación se muestra una llamada de muestra en mi views.py archivo.
@app.route('/projects')
def projects():
return render_template("projects.html", title = 'Projects')
Solo asegúrate de usar url_for() cuando quieras hacer referencia a algún archivo estático en el archivo separado directorio estático. Probablemente termines haciendo esto de todos modos en tus enlaces de archivos CSS/JS en html. Por ejemplo...
<script src="{{ url_for('static', filename='styles/dist/js/bootstrap.js') }}"></script>
Aquí hay un enlace al tutorial de frasco informal "canónico": muchos consejos excelentes aquí para ayudarlo a comenzar a trabajar.
Http://blog.miguelgrinberg.com/post/the-flask-mega-tutorial-part-i-hello-world
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/ajaxhispano.com/template/agent.layouts/content.php on line 61
2013-12-18 00:52:38
Puede usar esta función :
send_static_file(filename)
Función utilizada internamente para enviar estática archivos de la carpeta estática al navegador.
app = Flask(__name__)
@app.route('/<path:path>')
def static_file(path):
return app.send_static_file(path)
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/ajaxhispano.com/template/agent.layouts/content.php on line 61
2017-11-08 12:45:55
Un ejemplo de trabajo más simple basado en las otras respuestas es el siguiente:
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)
Con el HTML llamado index.html :
<!DOCTYPE html>
<html>
<head>
<title>Hello World!</title>
</head>
<body>
<div>
<p>
This is a test.
</p>
</div>
</body>
</html>
IMPORTANTE: Y índice.html está en una carpeta llamada static , lo que significa que <projectpath> tiene el archivo .py, y <projectpath>\static tiene el archivo html.
Si desea que el servidor sea visible en la red, use app.run(debug=True, host='0.0.0.0')
EDITAR: Para mostrar todos los archivos en la carpeta si se solicita, use esto
@app.route('/<path:path>')
def static_file(path):
return app.send_static_file(path)
Que es esencialmente BlackMamba's respuesta, así que darles un voto a favor.
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/ajaxhispano.com/template/agent.layouts/content.php on line 61
2016-07-14 12:23:27
Si solo desea mover la ubicación de sus archivos estáticos, entonces el método más simple es declarar las rutas en el constructor. En el siguiente ejemplo, he movido mis plantillas y archivos estáticos a una subcarpeta llamada web.
app = Flask(__name__,
static_url_path='',
static_folder='web/static',
template_folder='web/templates')
-
static_url_path=''elimina cualquier ruta anterior de la URL (i. e. el valor predeterminado/static). -
static_folder='web/static'le dirá a Flask que sirva los archivos encontrados enweb/static. -
template_folder='web/templates', del mismo modo, esto cambia la carpeta de plantillas.
Usando esto método, la siguiente URL devolverá un archivo CSS:
<link rel="stylesheet" type="text/css" href="/css/bootstrap.min.css">
Y finalmente, aquí hay un complemento de la estructura de carpetas, donde flask_server.py es la instancia de Flask:
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/ajaxhispano.com/template/agent.layouts/content.php on line 61
2017-07-21 14:02:50
Para el flujo angular + repetitivo que crea el siguiente árbol de carpetas:
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
Utilizo la siguiente solución:
...
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')
...
Ayuda a redefinir la carpeta 'estática' a personalizada.
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/ajaxhispano.com/template/agent.layouts/content.php on line 61
2015-02-03 23:05:58
Así que tengo las cosas funcionando (basado en @user1671599 respuesta) y quería compartirlo con ustedes.
(Espero que lo esté haciendo bien ya que es mi primera aplicación en Python)
Hice esto-
Estructura del proyecto:
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)
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/ajaxhispano.com/template/agent.layouts/content.php on line 61
2018-06-26 19:34:55
from flask import redirect, url_for
...
@app.route('/', methods=['GET'])
def metrics():
return redirect(url_for('static', filename='jenkins_analytics.html'))
Este servidor de todos los archivos (css y js...) referenciado en su archivo html.
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/ajaxhispano.com/template/agent.layouts/content.php on line 61
2015-12-28 22:21:59
De forma predeterminada, flask usa una carpeta "templates" para contener todos sus archivos de plantilla(cualquier archivo de texto sin formato, pero generalmente .html o algún tipo de lenguaje de plantilla como jinja2) y una carpeta "static" para contener todos sus archivos estáticos(p. ej. .js .css y sus imágenes).
En su routes, u puede usar render_template() para renderizar un archivo de plantilla (como dije anteriormente, por defecto se coloca en la carpeta templates) como respuesta a su solicitud. Y en el archivo de plantilla (suele ser a .html-like file), u puede utilizar algunos .js y/o `.css ' archivos, así que supongo que su pregunta es cómo u enlace estos archivos estáticos al archivo de plantilla actual.
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/ajaxhispano.com/template/agent.layouts/content.php on line 61
2013-12-18 13:49:13
Si solo está tratando de abrir un archivo, puede usar app.open_resource(). Así que leer un archivo se vería algo así como
with app.open_resource('/static/path/yourfile'):
#code to read the file and do something
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/ajaxhispano.com/template/agent.layouts/content.php on line 61
2017-08-31 02:26:59
Pensamiento de compartir.... este ejemplo.
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')
Esto funciona mejor y simple.
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/ajaxhispano.com/template/agent.layouts/content.php on line 61
2018-10-03 14:01:09