app root path for flask

本文介绍简单的 Flask 应用通过 Blueprint 给整个应用设置应用根目录的方法

主要是通过 Blueprint 的 url_prefix 和 Flask app 的 static_url_path 来完成设置的

static prefix

在默认的情况下 Flask 应用的使用的本地静态路径为应用目录下的static 远程路径(通过HTTP访问)为/static

Flask 应用可以通过两个变量 static_folder(static) 和 static_url_path(/static) 来分别设置本地和远端的路径前面括号内为变量的默认值

例如

1
2
3
4
5
6
""" 目录结构
.
├── app.py
├── 2.jpg
"""
app = Flask(__name__, static_url_path="/base/static", static_folder="./")

访问 127.0.0.1:5000/base/static/2.jpg 就能获得 ./2.jpg 这张图片

API prefix

静态资源的问题解决了剩下的就是 API 调用的问题了

app.config["APPLICATION_ROOT"] = prefix 似乎没有用所以不想给全部API手动写的话就需要使用 Blueprint 了

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from flask import Blueprint, Flask

bp = Blueprint("bp_name", __name__, url_prefix="/base")

@bp.route('/',methods=['GET','POST']) # 注意这里不是 app.route
def index():
  return "hello"

app = Flask(__name__)
app.register_blueprint(bp)

Blueprint 的简单使用如上可以直接写在 app.py 中

之后访问 127.0.0.1/base 就能获得 hello 了

render_template 中使用

不过在 render_template 中使用的时候需要注意

1
<a href="{{ url_for('bp_name.index')}}">About</a>

例如之前使用的Blueprint名为 bp_name 如果使用的template的话需要在 url_for 里面添加 blueprint 名(如果嵌套的话就顺序使用如parent.child.index)

示例

1
2
3
4
5
6
7
8
.
├── app.py
├── blue.py
├── static
│   └── 2.jpg
└── templates
    ├── base.html
    └── index.html

blue.py 是蓝图的具体代码可以单独放在一个文件里面

1
2
3
4
5
6
7
from flask import Flask
from blue import bp

app = Flask(__name__, static_url_path="/base/static", static_folder="/static")
app.register_blueprint(bp)
if __name__=="__main__":
    app.run("127.0.0.1", 8080, True)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
# blue.py
from flask import Blueprint, render_template

bp = Blueprint("bp", __name__, url_prefix="/base")

@bp.route('/',methods=['GET','POST'])
def index():
    return render_template("index.html")
@bp.route('/base')
def test_base():
    return "base path"

下面只截取了相关的代码

{% highlight html %}

About

{% endhighlight %}

{% highlight html %}

访问 127.0.0.1/base 可以访问到index.html 并且正常获取图片

访问 127.0.0.1/base/base 可以得到 “base path”