Flask-HelloWorld

Posted 2021-04-12 分享Python

Flask-HelloWorld

一个最小的应用

一个最小的 Flask 应用如下:

from flask import Flaskapp = Flask(__name__)
@app.route('/')def hello_world(): return 'Hello, World!'

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

1.首先我们导入了 flask.Flask 类。该类的实例将会成为我们的 WSGI应用。2.接着我们创建一个该类的实例。第一个参数是应用模块或者包的名称。如果你使用一个单一模块（就像本例），那么应当使用 __name__，因为名称会根据这个 模块是按应用方式使用还是作为一个模块导入而发生变化（可能是 '__main__' ， 也可能是实际导入的名称）。这个参数是必需的，这样 Flask 才能知道在哪里可以 找到模板和静态文件等东西。更多内容详见 flask.Flask 文档。3.然后我们使用 flask.Flask.route 装饰器来告诉 Flask 触发函数的 URL。4.函数名称被用于生成相关联的 URL。函数最后返回需要在用户浏览器中显示的信息。

把它保存为 hello.py 或其他类似名称。请不要使用 flask.py作为应用名称，这会与 Flask 本身发生冲突。

可以使用 flask 命令或者 python 的 -m 开关来运行这个应用。在运行应用之前，需要在终端里导出 FLASK_APP 环境变量:

$ export FLASK_APP=hello.py$ flask run * Running on http://127.0.0.1:5000/

如果是在 Windows下，那么导出环境变量的语法取决于使用的是哪种命令行解释器。在 Command Prompt 下:

C:\path\to\app>set FLASK_APP=hello.py

在 PowerShell 下:

PS C:\path\to\app> $env:FLASK_APP = "hello.py"

还可以使用 python -m flask:

$ export FLASK_APP=hello.py$ python -m flask run * Running on http://127.0.0.1:5000/

这样就启动了一个非常简单的内建的服务器。这个服务器用于测试应该是足够了，但是用于生产可能是不够的。

现在在浏览器中打开 http://127.0.0.1:5000/ ，应该可以看到 Hello World! 字样。

外部可见的服务器

运行服务器后，会发现只有你自己的电脑可以使用服务，而网络中的其他电脑却 不行。缺省设置就是这样的，因为在调试模式下该应用的用户可以执行你电脑中 的任意 Python 代码。

如果你关闭了调试器或信任你网络中的用户，那么可以让服务器被公开访问。只要在命令行上简单的加上 --host=0.0.0.0 即可:

$ flask run --host=0.0.0.0

这行代码告诉你的操作系统监听所有公开的 IP 。

调试模式

（只需要记录出错信息和追踪堆栈？参见 application-errors ）

虽然 flask 命令可以方便地启动一个本地开发服务器，但是每次应用代码 修改之后都需要手动重启服务器。这样不是很方便， Flask 可以做得更好。如果你打开 调试模式，那么服务器会在修改应用代码之后自动重启，并且当应用出错时还会提供一个 有用的调试器。

如果需要打开所有开发功能（包括调试模式），那么要在运行服务器之前导出 FLASK_ENV 环境变量并把其设置为 development:

$ export FLASK_ENV=development$ flask run

（在 Windows 下需要使用 set 来代替 export 。）

这样可以实现以下功能：

1.激活调试器。2.激活自动重载。3.打开 Flask 应用的调试模式。

还可以通过导出 FLASK_DEBUG=1 来单独控制调试模式的开关。

server 文档中还有更多的参数说明。

Attention

虽然交互调试器不能在分布环境下工作（这使得它基本不可能用于生产环境），但是 它允许执行任意代码，这样会成为一个重大安全隐患。因此， 绝对不能在生产环境 中使用调试器 。

运行中的调试器截图：

更多关于调试器的信息参见 Werkzeug 文档^[1] 。

路由

现代 web 应用都使用有意义的 URL ，这样有助于用户记忆，网页会更得到用户的青睐， 提高回头率。

使用 flask.Flask.route 装饰器来把函数绑定到 URL:

@app.route('/')def index(): return 'Index Page'
@app.route('/hello')def hello(): return 'Hello, World'

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

变量规则

通过把 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' % escape(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' % escape(subpath)

转换器类型：

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

唯一的 URL / 重定向行为

以下两条规则的不同之处在于是否使用尾部的斜杠。:

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

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

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

https://github.com/niaiai/wx_code/tree/master/实战类/FlaskHelloWorld

References

[1] Werkzeug 文档: https://werkzeug.palletsprojects.com/debug/#using-the-debugger