如何在Flask中提供静态文件

So this is embarrassing. I've got an application that I threw together in Flask and for now it is just serving up a single static HTML page with some links to CSS and JS. And I can't find where in the documentation Flask describes returning static files. Yes, I could use render_template but I know the data is not templatized. I'd have thought send_file or url_for was the right thing, but I could not get those to work. In the meantime, I am opening the files, reading content, and rigging up a Response with appropriate 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吗?我知道这非常简单。

当前回答

基于其他答案的一个最简单的工作示例如下:

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)

使用名为index.html的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')

EDIT:如果需要显示文件夹中的所有文件，请使用此选项

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

这基本上就是黑曼巴的答案，所以给他们点赞。

2014-08-26 08:56:59

其他回答

使用重定向和url_for

from flask import redirect, url_for

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

这个服务器在你的html中引用的所有文件(css & js…)

2015-12-28 22:21:59

在我的情况下，我需要一个静态文件夹中的所有文件都可以由用户访问，以及我需要为我的一些html文件使用模板，这样公共html代码可以放在模板中，代码得到重用。以下是我如何同时实现这两个目标的:

from flask import Flask, request, render_template
from flask.json import JSONEncoder

app = Flask(__name__, template_folder='static')


@app.route('/<path:path>')
def serve_static_file(path):
    # In my case, only html files are having the template code inside them, like include.
    if path.endswith('.html'):
        return render_template(path)
    # Serve all other files from the static folder directly.
    return app.send_static_file(path)

我所有的文件都保存在静态文件夹下，与主flask文件平行。

2021-08-29 14:43:10

这是最简单的方法之一。干杯!

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)

现在创建名为templates的文件夹。将index.html文件添加到templates文件夹中

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

2019-05-30 14:04:38

例如，要返回我使用过的Adsense文件:

@app.route('/ads.txt')
def send_adstxt():
    return send_from_directory(app.static_folder, 'ads.txt')

2022-02-17 19:44:02

在生产环境中，在应用程序前面配置HTTP服务器(Nginx, Apache等)，从静态文件夹向/static提供请求。专用的web服务器非常擅长有效地提供静态文件，尽管与低容量的Flask相比，您可能不会注意到差异。

Flask自动创建一个/static/<path:filename>路由，它将在定义你的Flask应用程序的Python模块旁边的静态文件夹下提供任何文件名。使用url_for链接到静态文件:url_for('static'， filename='js/ analysis .js')

您还可以使用send_from_directory在自己的路由中提供来自某个目录的文件。这接受一个基本目录和一个路径，并确保该路径包含在目录中，从而可以安全地接受用户提供的路径。如果您希望在提供文件之前检查某些内容，例如登录用户是否具有权限，那么这可能非常有用。

from flask import send_from_directory

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

不要对用户提供的路径使用send_file或send_static_file。这将使您暴露于目录遍历攻击。Send_from_directory的设计目的是安全地处理已知目录下用户提供的路径，如果该路径试图逃离该目录，则会引发错误。

如果在内存中生成一个文件而不将其写入文件系统，则可以将BytesIO对象传递给send_file，使其像文件一样提供服务。在本例中，您需要将其他参数传递给send_file，因为它不能推断文件名或内容类型等内容。

2013-12-18 01:25:40

如何在Flask中提供静态文件

推荐文章

最新文章

标签