Python 自动化指南（繁琐工作自动化）第二版：八、输入验证

原文：https://automatetheboringstuff.com/2e/chapter8/

输入验证代码检查用户输入的值，比如来自input()函数的文本，格式是否正确。例如，如果您希望用户输入他们的年龄，您的代码不应该接受无意义的答案，如负数（在可接受的整数范围之外）或单词（这是错误的数据类型）。输入验证还可以防止错误或安全漏洞。如果您实现了一个withdrawFromAccount()函数，该函数接受一个参数作为要从帐户中减去的金额，那么您需要确保该金额是一个正数。如果withdrawFromAccount()函数从账户中减去一个负数，那么“取款”将会增加钱！

通常，我们通过反复要求用户输入来执行输入验证，直到他们输入有效文本，如下例所示：

while True:
    print('Enter your age:')
    age = input()
    try:
        age = int(age)
    except:
        print('Please use numeric digits.')
        continue
    if age < 1:
        print('Please enter a positive number.')
        continue
    break
print(f'Your age is {age}.')

当您运行此程序时，输出可能如下所示：

Enter your age:
five
Please use numeric digits.
Enter your age:
-2
Please enter a positive number.
Enter your age:
30
Your age is 30.

当您运行此代码时，系统会提示您输入年龄，直到您输入一个有效的年龄。这确保了当执行离开while循环时，age变量将包含一个不会在以后使程序崩溃的有效值。

然而，为程序中的每个input()调用编写输入验证代码很快就变得乏味了。此外，您可能会错过某些情况，并允许无效的输入通过您的检查。在本章中，您将学习如何使用第三方 PyInputPlus 模块进行输入验证。

PyInputPlus 模块

PyInputPlus 包含类似于input()的函数，用于几种数据：数字、日期、电子邮件地址等等。如果用户输入了无效的输入，比如格式错误的日期或超出预期范围的数字，PyInputPlus 将重新提示用户输入，就像上一节中我们的代码所做的那样。PyInputPlus 还有其他有用的特性，比如限制它重新提示用户的次数，如果要求用户在限定的时间内做出响应，还会超时。

PyInputPlus 不是 Python 标准库的一部分，所以必须使用 PIP 单独安装。要安装 PyInputPlus，请从命令行运行pip install --user pyinputplus。附录 A 有安装第三方模块的完整说明。要检查 PyInputPlus 是否安装正确，请在交互式 Shell 中导入它：

>>> import pyinputplus

如果在导入模块时没有出现错误，则说明该模块已成功安装。

PyInputPlus 有几个用于不同类型输入的函数：

inputStr()类似于内置的input()函数，但是具有 PyInputPlus 的一般特性。您还可以向它传递一个自定义验证函数

inputNum()确保用户输入一个数字并返回一个int或float，这取决于数字中是否有小数点

inputChoice()确保用户输入所提供的选项之一

inputMenu()类似于inputChoice()，但是提供了一个带有数字或字母选项的菜单

inputDatetime()确保用户输入日期和时间

inputYesNo()确保用户输入“是”或“否”的回答

inputBool()与inputYesNo()类似，但是接受“真”或“假”响应并返回一个布尔值

inputEmail()确保用户输入有效的电子邮件地址

inputFilepath()确保用户输入有效的文件路径和文件名，并且可以选择性地检查具有该名称的文件是否存在

inputPassword()类似于内置的input()，但是在用户输入时显示*字符，这样密码或其他敏感信息就不会显示在屏幕上

只要用户输入无效的输入，这些函数就会自动重新提示用户：

>>> import pyinputplus as pyip
>>> response = pyip.inputNum()
five
'five' is not a number.
42
>>> response
42

每次我们想调用 PyInputPlus 函数时，import语句中的as pyip代码可以避免我们键入pyinputplus。相反，我们可以使用更短的pyip名称。如果你看一下这个例子，你会发现不像input()，这些函数返回一个int或float值：42和3.14，而不是字符串'42'和'3.14'。

正如您可以将一个字符串传递给input()来提供提示一样，您也可以将一个字符串传递给 PyInputPlus 函数的prompt关键字参数来显示提示：

>>> response = input('Enter a number: ')
Enter a number: 42
>>> response
'42'
>>> import pyinputplus as pyip
>>> response = pyip.inputInt(prompt='Enter a number: ')
Enter a number: cat
'cat' is not an integer.
Enter a number: 42
>>> response
42

使用 Python 的help()函数来了解关于这些函数的更多信息。例如，help(pyip.inputChoice)显示inputChoice()函数的帮助信息。完整的文档可以在pyinputplus.readthedocs.io找到。

与 Python 的内置input()不同，PyInputPlus 函数有几个额外的输入验证特性，如下一节所示。

关键字参数

接受int和float数的inputNum()、inputInt()和inputFloat()函数也有用于指定有效值范围的min、max、greaterThan和lessThan关键字参数。例如，在交互式 Shell 中输入以下内容：

>>> import pyinputplus as pyip
>>> response = pyip.inputNum('Enter num: ', min=4)
Enter num:3
Input must be at minimum 4.
Enter num:4
>>> response
4
>>> response = pyip.inputNum('Enter num: ', greaterThan=4)
Enter num: 4
Input must be greater than 4.
Enter num: 5
>>> response
5
>>> response = pyip.inputNum('>', min=4, lessThan=6)
Enter num: 6
Input must be less than 6.
Enter num: 3
Input must be at minimum 4.
Enter num: 4
>>> response
4

这些关键字参数是可选的，但是如果提供的话，输入不能小于min参数或大于max参数（尽管输入可以等于它们）。同样，输入必须大于greaterThan并且小于lessThan参数（也就是说，输入不能等于它们）。

`blank`关键字参数

默认情况下，不允许空白输入，除非blank关键字参数设置为True:

>>> import pyinputplus as pyip
>>> response = pyip.inputNum('Enter num: ')
Enter num:(blank input entered here)
Blank values are not allowed.
Enter num: 42
>>> response
42
>>> response = pyip.inputNum(blank=True)
(blank input entered here)
>>> response
''

如果你想让输入可选，用户不需要输入任何东西，使用blank=True。

`limit`、`timeout`和`default`关键字参数

默认情况下，PyInputPlus 函数将永远（或者只要程序运行）继续要求用户输入有效的数据。如果你想让一个函数在一定次数的尝试或一定时间后停止要求用户输入，你可以使用关键字参数limit和timeout。为limit关键字参数传递一个整数，以确定 PyInputPlus 函数在放弃之前尝试接收有效输入的次数，为timeout关键字参数传递一个整数，以确定在 PyInputPlus 函数放弃之前用户必须输入有效输入的秒数。

如果用户未能输入有效的输入，这些关键字参数将导致函数分别引发一个RetryLimitException或TimeoutException。例如，在交互式 Shell 中输入以下内容：

>>> import pyinputplus as pyip
>>> response = pyip.inputNum(limit=2)
blah
'blah' is not a number.
Enter num: number
'number' is not a number.
Traceback (most recent call last):
    --snip--
pyinputplus.RetryLimitException
>>> response = pyip.inputNum(timeout=10)
42 (entered after 10 seconds of waiting)
Traceback (most recent call last):
    --snip--
pyinputplus.TimeoutException

当您使用这些关键字参数并传递一个default关键字参数时，该函数将返回默认值，而不是引发异常。在交互式 Shell 中输入以下内容：

>>> response = pyip.inputNum(limit=2, default='N/A')
hello
'hello' is not a number.
world
'world' is not a number.
>>> response
'N/A'

inputNum()函数只是返回字符串'N/A'，而不是引发RetryLimitException。

`allowRegexes`和`blockRegexes`关键字参数

您还可以使用正则表达式来指定是否允许输入。allowRegexes和blockRegexes关键字参数采用正则表达式字符串列表来确定 PyInputPlus 函数将接受或拒绝哪些有效输入。例如，在交互式 Shell 中输入以下代码，以便inputNum()除了接受常用数字之外，还接受罗马数字：

>>> import pyinputplus as pyip
>>> response = pyip.inputNum(allowRegexes=[r'(I|V|X|L|C|D|M)+', r'zero'])
XLII
>>> response
'XLII'
>>> response = pyip.inputNum(allowRegexes=[r'(i|v|x|l|c|d|m)+', r'zero'])
xlii
>>> response
'xlii'

当然，这个正则表达式只影响inputNum()函数从用户那里接受的字母；该函数仍将接受带有无效排序的罗马数字，如'XVX'或'MILLI'，因为r'(I|V|X|L|C|D|M)+'正则表达式接受这些字符串。

还可以通过使用blockRegexes关键字参数来指定 PyInputPlus 函数不接受的正则表达式字符串列表。在交互式 Shell 中输入以下内容，以便inputNum()不接受偶数：

>>> import pyinputplus as pyip
>>> response = pyip.inputNum(blockRegexes=[r'[02468]

如果同时指定了`allowRegexes`和`blockRegexes`参数，允许列表将覆盖阻止列表。例如，在交互式 Shell 中输入以下内容，它允许使用`'caterpillar'`和`'category'`，但阻止任何包含`'cat'`的内容：

```py
>>> import pyinputplus as pyip
>>> response = pyip.inputStr(allowRegexes=[r'caterpillar', 'category'],
blockRegexes=[r'cat'])
cat
This response is invalid.
catastrophe
This response is invalid.
category
>>> response
'category'

PyInputPlus 模块的函数可以让您不必自己编写繁琐的输入验证代码。但是 PyInputPlus 模块有比这里详细描述的更多的内容。你可以在pyinputplus.readthedocs.io的在线查看它的完整文档。

向`inputCustom()`传递自定义验证函数

通过将函数传递给inputCustom()，您可以编写一个函数来执行您自己的定制验证逻辑。例如，假设您希望用户输入一系列数字，其总和为 10。没有pyinputplus.inputAddsUpToTen()函数，但是您可以创建自己的函数：

接受用户输入内容的单个字符串参数
如果字符串验证失败，将引发异常
如果inputCustom()应该返回不变的字符串，则返回None（或者没有return语句）
如果inputCustom()应该返回一个不同于用户输入的字符串，则返回一个非None值
作为第一个参数传递给inputCustom()

比如我们可以创建自己的addsUpToTen()函数，然后传递给inputCustom()。注意，函数调用看起来像inputCustom(addsUpToTen)而不是inputCustom(addsUpToTen())，因为我们将addsUpToTen()函数本身传递给inputCustom()，而不是调用addsUpToTen()并传递它的返回值。

>>> import pyinputplus as pyip
>>> def addsUpToTen(numbers):
...   numbersList = list(numbers)
...   for i, digit in enumerate(numbersList):
...     numbersList[i] = int(digit)
...   if sum(numbersList) != 10:
...     raise Exception('The digits must add up to 10, not %s.' %
(sum(numbersList)))
...   return int(numbers) # Return an int form of numbers.
...
>>> response = pyip.inputCustom(addsUpToTen) # No parentheses after
addsUpToTen here.
123
The digits must add up to 10, not 6.
1235
The digits must add up to 10, not 11.
1234
>>> response # inputStr() returned an int, not a string.
1234
>>> response = pyip.inputCustom(addsUpToTen)
hello
invalid literal for int() with base 10: 'h'
55
>>> response

inputCustom()函数还支持一般的 PyInputPlus 特性，例如blank、limit、timeout、default、allowRegexes和blockRegexes关键字参数。当很难或不可能为有效输入编写正则表达式时，编写自己的自定义验证函数是有用的，如在“加起来等于 10”的例子中。

项目：如何让一个白痴忙上好几个小时

让我们使用 PyInputPlus 来创建一个简单的程序，它执行以下操作：

问用户是否想知道如何让一个白痴忙上几个小时。
如果用户回答否，退出。
如果用户回答是，请转到第一步。

当然，我们不知道用户是否会输入除“是”或“否”之外的内容，所以我们需要执行输入验证。对于用户来说，能够输入y或n而不是完整的单词也是很方便的。PyInputPlus 的inputYesNo()函数将为我们处理这个问题，并且无论用户输入的是哪种情况，都会返回一个小写的'yes'或'no'字符串值。

当您运行这个程序时，它看起来应该如下所示：

Want to know how to keep an idiot busy for hours?
sure
'sure' is not a valid yes/no response.
Want to know how to keep an idiot busy for hours?
yes
Want to know how to keep an idiot busy for hours?
y
Want to know how to keep an idiot busy for hours?
Yes
Want to know how to keep an idiot busy for hours?
YES
Want to know how to keep an idiot busy for hours?
YES!!!!!!
'YES!!!!!!' is not a valid yes/no response.
Want to know how to keep an idiot busy for hours?
TELL ME HOW TO KEEP AN IDIOT BUSY FOR HOURS.
'TELL ME HOW TO KEEP AN IDIOT BUSY FOR HOURS.' is not a valid yes/no response.
Want to know how to keep an idiot busy for hours?
no
Thank you. Have a nice day.

打开一个新的文件编辑器标签，保存为idiot.py。然后输入以下代码：

import pyinputplus as pyip

这将导入 PyInputPlus 模块。由于输入pyinputplus有点麻烦，我们将简称为pyip。

while True:
    prompt = 'Want to know how to keep an idiot busy for hours?\n'
    response = pyip.inputYesNo(prompt)

接下来，while True:创建一个无限循环，该循环将继续运行，直到遇到一个break语句。在这个循环中，我们调用pyip.inputYesNo()来确保这个函数调用不会返回，直到用户输入一个有效的答案。

    if response == 'no':
        break

保证调用pyip.inputYesNo()只返回字符串yes或字符串no。如果它返回了no，那么我们的程序就跳出了无限循环，继续执行最后一行，感谢用户：

print('Thank you. Have a nice day.')

否则，循环再次迭代。

你也可以通过传递关键字参数yesVal和noVal在非英语语言中使用inputYesNo()函数。例如，这个程序的西班牙语版本会有这两行：

    prompt = '¿Quieres saber cómo mantener ocupado a un idiota durante horas?\n'
    response = pyip.inputYesNo(prompt, yesVal='sí', noVal='no')
    if response == 'sí':

现在用户可以输入sí或s（小写或大写）来代替yes或y来得到肯定的答案。

项目：乘法竞猜

PyInputPlus 的特性对于创建一个定时乘法测验很有用。通过将allowRegexes、blockRegexes、timeout和limit关键字参数设置为pyip.inputStr()，可以将大部分实现留给 PyInputPlus。你需要写的代码越少，你写程序的速度就越快。让我们创建一个程序，向用户提出 10 个乘法问题，其中有效输入是问题的正确答案。打开一个新的文件编辑器选项卡，将文件保存为multiplicationQuiz.py。

首先，我们将导入pyinputplus、random和time。我们将使用变量numberOfQuestions和correctAnswers来跟踪程序问了多少问题以及用户给出了多少正确答案。一个for循环将重复提出 10 次随机乘法问题：

import pyinputplus as pyip
import random, time
numberOfQuestions = 10
correctAnswers = 0
for questionNumber in range(numberOfQuestions):

在for循环中，程序将选择两个一位数相乘。我们将使用这些数字为用户创建一个#Q: N × N =提示，其中Q是问题编号（1 到 10）N是要相乘的两个数字。

    # Pick two random numbers:
    num1 = random.randint(0, 9)
    num2 = random.randint(0, 9)
    prompt = '#%s: %s x %s = ' % (questionNumber, num1, num2)

pyip.inputStr()函数将处理这个测验程序的大部分功能。我们传递给allowRegexes的参数是一个包含正则表达式字符串'^%s$'的列表，其中%s被正确的答案替换。^和%字符确保答案以正确的数字开始和结束，尽管 PyInputPlus 会首先删除用户回答开头和结尾的任何空格，以防他们在回答之前或之后无意中按了空格键。我们传递给blocklistRegexes的参数是一个带有('.*', 'Incorrect!')的列表。元组中的第一个字符串是匹配所有可能字符串的正则表达式。因此，如果用户的回答与正确答案不匹配，程序将拒绝他们提供的任何其他答案。在这种情况下，将显示'Incorrect!'字符串，并提示用户再次回答。此外，通过timeout的8和limit的3将确保用户只有 8 秒和 3 次尝试来提供正确答案：

    try:
        # Right answers are handled by allowRegexes.
        # Wrong answers are handled by blockRegexes, with a custom message.
        pyip.inputStr(prompt, allowRegexes=['^%s$' % (num1 * num2)],
                              blockRegexes=[('.*', 'Incorrect!')],
                              timeout=8, limit=3)

如果用户在 8 秒超时后回答，即使他们回答正确，pyip.inputStr()也会引发TimeoutException异常。如果用户错误回答超过 3 次，就会引发一个RetryLimitException异常。这两种异常类型都在 PyInputPlus 模块中，所以pyip.需要预先考虑它们：

    except pyip.TimeoutException:
        print('Out of time!')
    except pyip.RetryLimitException:
        print('Out of tries!')

记住，就像else块可以跟随一个if或elif块一样，它们可以选择跟随最后一个except块。如果在try块中没有出现异常，下面的else块中的代码将会运行。在我们的例子中，这意味着如果用户输入了正确的答案，代码就会运行：

    else:
        # This block runs if no exceptions were raised in the try block.
        print('Correct!')
        correctAnswers += 1

不管是三条信息中的哪一条，“超时！”、“超出尝试次数！”，或者“正确！”，显示，让我们在for循环结束时暂停 1 秒钟，让用户有时间阅读。在程序问了 10 个问题并且for循环继续之后，让我们向用户展示他们做出了多少个正确答案：

    time.sleep(1) # Brief pause to let user see the result.
print('Score: %s / %s' % (correctAnswers, numberOfQuestions))

PyInputPlus 非常灵活，您可以在各种各样接受用户键盘输入的程序中使用它，如本章中的程序所示。

总结

很容易忘记编写输入验证代码，但是没有它，您的程序几乎肯定会有 bug。您期望用户输入的值和他们实际输入的值可能完全不同，您的程序需要足够健壮来处理这些异常情况。您可以使用正则表达式来创建自己的输入验证代码，但是对于一般情况，使用现有的模块更容易，比如 PyInputPlus。您可以使用import pyinputplus as pyip导入模块，以便在调用模块函数时输入一个较短的名称。

PyInputPlus 具有用于输入各种输入的函数，包括字符串、数字、日期、是/否、True / False、电子邮件和文件。虽然input()总是返回一个字符串，但是这些函数以适当的数据类型返回值。inputChoice()函数允许您从几个预先选择的选项中选择一个，而inputMenu()还添加了数字或字母以便快速选择。

所有这些函数都有以下标准特性：去掉两边的空白，用timeout和limit关键字参数设置超时和重试限制，将正则表达式字符串列表传递给allowRegexes或blockRegexes以包含或排除特定响应。您将不再需要编写自己繁琐的while循环来检查有效输入并重新提示用户。

如果 PyInputPlus 模块的函数都不符合您的需要，但是您仍然喜欢 PyInputPlus 提供的其他特性，您可以调用inputCustom()并传递您自己的自定义验证函数供 PyInputPlus 使用。pyinputplus.readthedocs.io/en/latest的文档中有 PyInputPlus 函数和附加特性的完整列表。PyInputPlus 在线文档中的内容比本章中描述的要多得多。重新发明轮子是没有用的，学会使用这个模块将使你不必自己编写和调试代码。*

现在您已经掌握了处理和验证文本的专业知识，是时候学习如何读写计算机硬盘上的文件了。