Flask test_client()测试客户端为勾选框传递布尔值数据

李辉 — Sat, 28 Jul 2018 10:28:57 +0000

今天写单元测试发现了一个常见的问题，即测试时发送POST请求时如何传入布尔值数据（勾选框字段值）？答案是：你没法直接传递布尔值。其实这个答案相当显而易见，客户端当然没法向服务器端发送Python类型的数据，数据的转换是在接受到请求数据后在服务器端进行的。之前在不借助Flask-WTF/WTForms，手动编写表单并处理时就已经注意到了这个问题，不过在测试中不太容易想到。

首先，我们需要了解一下勾选框（）提交的行为：

如果没有勾选，那么勾选框字段的值为空值，而且这个字段不会被序列化到请求中；在服务器端，WTForms会将其转换为False。
如果勾选框被勾选，那么传入服务器端的数据会是该字段value属性的值，如果value属性的值为空，那么则提交字符串"on"；在服务器端，WTForms会将其转换为True。

也就是说，勾选框的数据只要不为空，WTForms就会将其转换为True。所以，在测试中，如果你想让勾选框的值最终转换为True，那么就传入任意字符串；反之则传递空字符串或直接不加入该字段。下面是传入空字符串的示例：

def test_privacy_setting(self):
    self.login()
    response = self.client.post(url_for('user.privacy_setting'), data=dict(
        public_collections='',  # <--
    ), follow_redirects=True)

    user = User.query.get(1)
    self.assertEqual(user.public_collections, False)

顺便说一句，基于勾选框的提交行为，如果没有使用Flask-WTF/WTForms，那么在手动处理提交数据的时候也要进行相应的处理：没有在request.form中获取到勾选框字段（比如，request.form.get('remember')会是None），即表示没有勾选，那么就转换为False；勾选框字段一旦出现，那么就表示勾选，转换为True。

Pipenv：新一代Python项目依赖管理工具

李辉 — Fri, 08 Jun 2018 00:04:04 +0000

UPDATE（2019/8/31）：不要用 Pipenv

什么是Pipenv

Pipenv是Kenneth Reitz在2017年1月发布的Python依赖管理工具，现在由PyPA维护。你可以把它看做是pip和virtualenv的组合体，而它基于的Pipfile则用来替代旧的依赖记录方式（requirements.txt）。

在这篇文章里，我将会以旧的依赖管理工作流程作为对比来介绍Pipenv的基本用法，更详细的用法可以参考Pipenv文档，或是Kenneth Reitz在PyCon 2018的演讲《Pipenv: The Future of Python Dependency Management》。

顺便说一句，我的还没想好名字的Flask书中所有示例程序都使用了Pipenv进行依赖管理。

提示如果你对virtualenv的用法以及虚拟环境的概念不熟悉的话，可以通过专栏的旧文《Flask出发之旅》进行简单的认识。

为什么使用Pipenv

Pipenv会自动帮你管理虚拟环境和依赖文件，并且提供了一系列命令和选项来帮助你实现各种依赖和环境管理相关的操作。简而言之，它更方便、完善和安全。你可以通过Pipenv文档开头的介绍来了解它的详细特性。Pipenv的slogan是“Python Dev Workflow for Humans”，作为人类，当然应该尝试一下……

如何使用Pipenv

假设我们要编写一个博客程序，项目的依赖是Flask和Flask-WTF。顺便说一句，可以使用下面的命令安装Pipenv：

$ pip install pipenv

下面我会通过不同操作来给出所需命令的对比，OLD（旧）表示使用pip和virtualenv，NEW（新）表示使用Pipenv。

创建虚拟环境

$ virtualenv venv

提示这里的venv是虚拟环境目录的名称，你可以自由更改，这会在你的项目根目录创建一个venv文件夹，其中包含独立的Python解释器环境。

$ pipenv install

Pipenv会自动为你创建虚拟环境，自动生成一个随机的虚拟环境目录名。

激活虚拟环境

在Linux或macOS系统中：

$ . venv/bin/activate

Windows：

> venv\Scripts\activate

$ pipenv shell

此外，Pipenv还提供了一个pipenv run命令，在该命令后附加的参数会直接作为命令在虚拟环境中执行，这允许你不必显式的激活虚拟环境即可在虚拟环境中执行命令。比如，pipenv run python会启动虚拟环境中的Python解释器。

安装依赖到虚拟环境

$ . venv/bin/activate # 需要先激活虚拟环境
(venv)$ pip install flask flask-wtf

使用Pipenv，不管你是否激活了虚拟环境，都可以通过pipenv install命令安装：

$ pipenv install flask flask-wtf

事实上，对一个新项目来说，你不必手动使用pipenv install来创建虚拟环境。当使用pipenv install xxx直接安装依赖包时，如果当前目录不包含虚拟环境，Pipenv会自动创建一个。

记录依赖

(venv)$ pip freeze > requirements.txt

这个命令会把依赖列表写入requirements.txt文件。每当你安装或卸载了依赖包时，都需要手动更新这个文件。你必须保持谨慎，否则非常容易把依赖列表弄乱。

使用Pipenv时，什么都不必做，Pipenv会自动帮你管理依赖。Pipenv会在你创建虚拟环境时自动创建Pipfile和Pipfile.lock文件（如果不存在），并且会在你使用pipenv install和pipenv uninstall命令安装和卸载包时自动更新Pipfile和Pipfile.lock。

附注 Pipfile用来记录项目依赖包列表，而Pipfile.lock记录了固定版本的详细依赖包列表。

在部署环境安装依赖

当我们需要在一个新的环境，比如部署上线环境安装所有依赖时，我们需要重复上面的多条命令：

$ virtualenv venv # 创建虚拟环境
$ . venv/bin/activate # 激活虚拟环境
(venv)$ pip install -r requirements.txt # 安装requirement.txt中记录的依赖

使用Pipenv则只需要执行pipenv install，它会自动安装Pipfile中记录的依赖：

$ pipenv install

区分开发依赖

使用requirements.txt时，我们通过会单独创建一个requirements-dev.txt文件来手动加入开发依赖。比如项目开发时才会用到pytest，那么你需要手动创建这个文件，然后写入：

-r requirements.txt
pytest==1.2.3

在新的开发环境安装依赖时，你需要安装这个文件中的依赖：

(venv)$ pip install -r requirements-dev.txt

使用Pipenv时，你只需要在安装pytest时添加一个–dev选项，它会自动被分类为开发依赖（写入Pipfile的dev-packages一节中）：

$ pipenv install pytest --dev

在新的开发环境安装依赖时，也只需要在pipenv install命令后添加–dev选项即可一并安装开发依赖：

$ pipenv install --dev

总结

为了让你更轻松的过渡，Pipenv甚至提供了读取和生成requirements.txt文件的功能（在使用pipenv install命令时它会自动读取requirements.txt文件安装依赖并生成Pipfile文件）。希望这篇文章可以让你更快的上手Pipenv。

– – – – –

知乎专栏 Hello, Flask!

Web开发 – 李辉 / Grey Li