带你迅速入门 Python Flask 框架

原创
小哥 4年前 (2022-10-13) 阅读数 3 #PYTHON

Flask 是 python 一个非常受欢迎的一个web 框架,容容易学习。文章主要通过2 解释实际情况下Flask 如何使用。一个例子是实现一个接口服务调用公共汽车到来信息;第二个例子是通过界面来显示所有的测试报告。

Flask 安装

  1. 安装 python
  2. pip install flask

Flask 开始服务

from flask import Flask

app = Flask(__name__)

app.run()

通过 3 行代码,可以开始flask 的服务。

  1. 第一行,入
  2. 第二行,创建建 Flask 程序的例子3. 第三行,一般启动服务实例 运行这段代码在当地的5000 端口访问, 结果是404 页面无法找到:

为 Flask 程序添加界面

此时,访问 http://localhost:5000 看到 404 错误,是因为没有接口定义。 一个 url 对应于一个处理函数的地址一个接口可以形成。 下面的代码,你可以添加一个接口基于前面的代码:

@app.route(/)
def index():
    return {
        "msg": "success",
        "data": "welcome to use flask."
    }

后添加的接口次访问 http://localhost:5000, 你可以看到正常的响应数据:

如果额外的接口需要被定义,只有您需要继续定义参照上面的例子。 例如,要实现一个注册界面:

@app.route(/user/)
def user_info(u_id):
    return {
        "msg": "success",
        "data": {
            "id": u_id,
            "username": yuz,
            "age": 18
        }
    }

访问在这个时间/user/3 将会得到id 为 3 用户信息:

*Flask 实现公共交通信息查询服务

Flask 完全胜任中型和大型的项目,但是是的,这不是它的目标。如果你想成为一个完整的web 项目,建议用 Django。Flask 它更适合一些小型项目例如,当您完成一些计算任务,你想通过 web 它提供了数据服务或表示为用户服务。 你不需要django 一样,去太多的维护模块。

例如。现在我写了一个程序来计算公共汽车将通过计算Sanyuanli站在接下来的一段时间。计算结果可以呈现给他人以各种形式:

  1. 控制台输出

  2. 保存到数据库

  3. 展示到 api 上

  4. 给手机app 上

  5. 展示到 web 网页上

我现在可以通过flask 创建一个api , 向用户显示这些数据。 但是注意,展览显示数据只是一个小函数心理程序应该如何计算公交车站的信息这个项目的真正价值是什么?它可以显示在上面的任何一种方式:和不只有 web 开发一个表单。演示的逻辑很简单,和不需要使用django 如此巨大的框架。

真正的公交信息计算程序是非常复杂的我使用一个简单的程序来模拟计算总线数据的过程。程序将随机生成的10 组总线数据存储把它放在一个列表。

import random

def get_bus_info(station):
    info = []
    for random_bus in range(10):
        bus_name = f"W{random.randint(1, 100)}"
        bus_arrival_time = random.randint(1, 30)
        bus_info = f"{bus_name} 还有 {bus_arrival_time} 分钟到达{station}"
        info.append({bus_name: bus_info})
    return info

您可以直接调用这个函数来获取相关数据总线:

for bus in get_bus_info(三元里):
    print(bus)

控制台的输出类似于:

现在我可以使用flask 创建一个api, 所有用户和其他服务提供者希望我的数据可以得到数据,

至于他们的直读这是显示在页面上便吧,这这不是我的问题。只负责计算,但是提供数据后,如如果这个技术是非常强大的,我你可以通过这些数据和使用用户必须为我提供的接口。

接下来我要创建一个/bus/<station> 的接口, 当我往 url 输入 station 公共汽车站的名称退出将返回这个公交车站的公交信息给我。

定义接口:

@app.route(/bus/)
def bus_info(station):
    import bus
    info = bus.get_bus_info(station)
    return {
        "msg": "success",
        "data": info
    }

访问 /bus/天安门 从获得的数据接口:

Flask 实现测试报告服务

在前面的例子中,我通过 Flask 提供了一个api 显示总线操作数据。接下来,我们将用一个例子来显示测试报告flask 提供 api 的功能。

编写代码通常需要测试试验完成后生成的测试报告数据通常存储在本地。有许多形式的发布:

  1. txt 文本
  2. xml 文件
  3. html 文件
  4. json 文件
  5. yaml 文件。

这里以 html 文件的例子。 编写一个测试程序来生成html 测试报告:

import pytest
from datetime import datetime

def test_add():
    assert 1 == 2

def gen_report_name():
    prefix = 测试报告        ts = datetime.now().strftime(%Y-%m-%d-%H-%M-%S)
    return prefix + ts + .html

if __name__ == __main__:
    report_name = gen_report_name()
    pytest.main([f--html=output/{report_name}])

每次程序运行测试用例,它会的output 目录下生成测试报告。一些报道`测试报告的 前缀,文件名称:

现在我想设计一个API, 地址为 /report/<filename> 。 当我类型report/测试报告2020-04-28-13-53-42.html 时,能查看此测试报告的内容:

实现这一功能,需要在 api.py 添加相应的程序文件。程序打开output 测试报告文件目录下,回报回到前端:

@app.route(/report/)
def get_report(file_name):
    """得到测试报告根据文件名。"""
    import pathlib
    file_path = pathlib.Path(__file__).parent / output / file_name
    f = open(file_path, encoding=utf-8)
    report = f.read()
    f.close()
    return Response(report)

Flask 查看所有测试报告链接

现在,虽但我可以通过API 查看测试报告,但是是的,我需要知道测试报告的名称之前提前进入相应的url。如果要使用的其他人,他我们不知道这些报告的名字。

我现在可以设计另一个API /reports , 当用户访问这个界面,他们可以所有测试报告地址可以直接获得。后,复制这些地址就可以查看每次的测试报告:

要实现这个接口,放在第一位首先,我将编写一个函数自动收集output 所有测试报告和规范目录下则是以 .html 后缀的文件:

def discover_reports():
    """找到所有测试报告”""
    import pathlib
    report_dir = pathlib.Path(__file__).parent / output
    reports = [f.name for f in report_dir.iterdir() if f.suffix == .html]
    return reports

当我调用这个函数回 output 所有测试报告目录下的文件名:

接下来,我在 api.py 添加相应的界面用这个 discover_report 功能:

@app.route(/reports)
def get_reports():
    import test_helper
    report_names = test_helper.discover_reports()
    return {
        "msg": "success",
        "data": [f"http://localhost:5000/report/{name}"
                 for name in report_names
                 ]
    }

最后,检查所有测试的执行效果报告:

总结

Flask 这是一个非常休闲的框架。如果你想使用Flask, 你不需要知道关于他的一切当你需要学习。在上面的程序计算汽车站信息,web 唯一的代码显示7 行,而程序模拟总线数据已经达到了9 行。

我对 Flask 的理解,web 它只是一个显示数据,和不是一个目标。在现实生活中,有太多的公司或开发商web 整个的生活。 这是设计理念的差异。

如果你喜欢简约主义,你我真的应该试一试。

版权声明

所有资源都来源于爬虫采集,如有侵权请联系我们,我们将立即删除