Flak快速上手

Posted 2021-02-05 code1992

本文介绍如何上手 Flask 。 这里假定你已经安装好了 Flask ，否则请先阅读《 安装 》。

 

如果已安装好Flask，通过以下命令查看

 

一个简单的例子：

from flask import Flask
app = Flask(__name__)

@app.route(‘/‘)
def hello_world():
    return ‘Hello World!‘

if __name__ == ‘__main__‘:
    app.run()

把它保存为 hello.py ，然后用 Python 解释器来运行。 不能保存为 flask.py ，因为这与 Flask 本身冲突。

$ python hello.py
 * Running on http://127.0.0.1:5000/

现在访问 http://127.0.0.1:5000/ ，你会看见 Hello World 问候。

 

那么，这段代码是什么意思呢？

1. 首先，导入了 Flask 类。这个类的实例将会成为我们的 WSGI 应用程序。
2. 接下来，我们创建一个该类的实例，第一个参数是应用模块或者包的名称。 如果使用单一的模块（如本例），应该使用 __name__，因为模块的名称 作为单独应用启动还是作为模块导入是不同的（ 也即是 ‘__main__‘ 或实际的导入名）。这个参数是必须的，这样 Flask 才知道到哪去找模板、静态文件等等。详情见 Flask 的文档。
3. 然后，我们使用 route() 装饰器告诉 Flask 哪些URL能触发我们的函数。
4. 这个函数的名字也在生成 URL 时被特定的函数采用，函数返回想在浏览器中显示的信息。
5. 最后我们用 run() 函数让应用运行在本地服务器上。 其中 if __name__ == ‘__main__‘: 确保服务器只会在该脚本被 Python 解释器直接执行的时候才会运行，而不是作为模块导入的时候。

想要关闭服务器，按 Ctrl+C。

 

外部可访问的服务器

如果你运行了这个服务器，你会发现它只能从你自己的计算机上访问，网络中其它任何的地方都不能访问。在调试模式下，用户可以在你的计算机上执行任意 Python 代码。因此，这个行为是默认的。

如果你禁用了 debug 或信任你所在网络的用户，你可以简单修改调用 run() 的方法使你的服务器公开可用，如下:

app.run(host=‘0.0.0.0‘)

这会让操作系统监听所有公网 IP。

 

调试模式

 run() 方法适用于启动本地的开发服务器，但是每次修改代码后都要手动重启它。这样并不够优雅，如果你启用了调试模式，服务器会在代码修改后自动重新载入，并在发生错误时提供一个相当有用的调试器。

有两种途径来启用调试模式。一种是直接在应用对象上设置:

app.debug = True
app.run()

另一种是作为 run 方法的一个参数传入:

app.run(debug=True)

注意：调试器允许执行任意代码。这是一个巨大的安全隐患，因此调试模式 绝对不能用于生产环境 。

 

路由

现代 web 应用都使用有意义的 URL ，这样有助于用户记忆，提高回头率。

使用 route() 装饰器来把一个函数绑定到对应的 URL 上。

例如:

@app.route(‘/‘)
def index():
    return ‘Index Page‘

@app.route(‘/hello‘)
def hello():
    return ‘Hello World‘

但是能做的不仅仅是这些！你可以动态变化 URL 的某些部分， 还可以为一个函数指定多个规则。

 

变量规则

　　要给 URL 添加变量部分，你可以把这些特殊的字段标记为 <variable_name> ， 这个部分将会作为命名参数传递到你的函数。规则可以用 <converter:variable_name> 指定一个可选的转换器。这里有一些不错的例子:

　　通过把 URL 的一部分标记为  <variable_name>  就可以 在 URL 中添加变量，标记的部分会作为关键字参数传递给函数。

　　通过使用 <converter:variable_name>   可以 添加一个可选的转换器，为变量指定规则。

例如:

@app.route(‘/user/<username>‘)
def show_user_profile(username):
    # show the user profile for that user
    return ‘User %s‘ % username

@app.route(‘/post/<int:post_id>‘)
def show_post(post_id):
    # show the post with the given id, the id is an integer
    return ‘Post %d‘ % post_id

@app.route(‘/path/<path:subpath>‘)
def show_subpath(subpath):
    # show the subpath after /path/
    return ‘Subpath %s‘ % subpath

 

post/英文会报错

 

转换器类型：

string	（缺省值） 接受任何不包含斜杠的文本
int	接受正整数
float	接受正浮点数
path	类似 string ，但可以包含斜杠
uuid	接受 UUID 字符串

 

唯一 URL / 重定向行为

　　Flask 的 URL 规则基于 Werkzeug 的路由模块。这个模块背后的思想是基于 Apache 以及更早的 HTTP 服务器主张的先例，保证优雅且唯一的 URL。

 

　　以下两条规则的不同点是否使用尾部的斜杠

@app.route(‘/projects/‘)
def projects():
    return ‘The project page‘

@app.route(‘/about‘)
def about():
    return ‘The about page‘

projects 的尾部有一个斜杠，看起来就像一个文件夹。 访问一个没有斜杠结尾的 URL 时 Flask 会自动进行重定向，帮你在尾部加上一个斜杠。

http://127.0.0.1:5000/projects =>  http://127.0.0.1:5000/projects/ 

about 的URL尾部没有斜杠，因此其行为表现与一个文件类似。如果访问这个 URL 时添加了尾部斜杠就会得到一个 404 错误。这样可以保持 URL 唯一，并帮助 搜索引擎避免重复索引同一页面。

 

构建 URL

   url_for() 本质是根据函数名反向生成url。它把函数名称作为第一个 参数。它可以接受任意个关键字参数，每个关键字参数对应 URL 中的变量。未知变量 将添加到 URL 中作为查询参数。

　　一般我们通过一个URL就可以执行到某一个函数。如果反过来，我们知道一个函数，怎么去获得这个URL呢？url_for函数就可以帮我们实现这个功能。

　　url_for()函数接收两个及以上的参数，他接收函数名作为第一个参数，接收对应URL规则的命名参数，如果还出现其他的参数，则会添加到URL的后面作为查询参数。

通过构建URL的方式而选择直接在代码中拼URL的原因有两点：

1. 将来如果修改了URL，但没有修改该URL对应的函数名，就不用到处去替换URL了。
2. url_for()函数会转义特殊字符和Unocode数据，这些工作都不需要我们自己处理。

 

 　　这里我们使用 test_request_context() 方法来尝试使用 url_for() 。 test_request_context() 告诉 Flask 正在处理一个请求，而实际上也许我们正处在交互 Python shell 之中， 并没有真正的请求。参见 本地环境 。

from flask import Flask, url_for
app = Flask(__name__)
 
@app.route(‘/‘)
def index():
    return ‘index‘

@app.route(‘/login‘)
def login():
    return ‘login‘

@app.route(‘/user/<username>‘)
def profile(username):
    return ‘{}‘s profile‘.format(username)

with app.test_request_context():
    print(url_for(‘index‘))
    print(url_for(‘login‘))
    print(url_for(‘login‘, next=‘/‘))
    print(url_for(‘profile‘, username=‘John Doe‘))

打印结果：

/
/login
/login?next=/
/user/John%20Doe

 

 

 

参考

1. http://docs.jinkan.org/docs/flask/quickstart.html

2. https://dormousehole.readthedocs.io/en/latest/quickstart.html