Question

我目前正在用Python（3.1）编写一个小应用程序，就像一个好小男孩一样，我正在进行doctesting。但是，我遇到过一种我似乎无法进行doctest测试的方法。它包含input()，因此，我不完全确定将什么放在doctest的“期待”部分。

说明我的问题的示例代码如下：

"""
>>> getFiveNums()
Howdy. Please enter five numbers, hit <enter> after each one
Please type in a number:
Please type in a number:
Please type in a number:
Please type in a number:
Please type in a number:
"""

import doctest

numbers = list()

# stores 5 user-entered numbers (strings, for now) in a list
def getFiveNums():
    print("Howdy. Please enter five numbers, hit <enter> after each one")
    for i in range(5):
        newNum = input("Please type in a number:")
        numbers.append(newNum)
    print("Here are your numbers: ", numbers)

if __name__ == "__main__":
    doctest.testmod(verbose=True)

运行doctests时，程序在打印“Expecting”部分后立即停止执行，等待我一个接一个地输入五个数字（没有提示），然后继续。如下图所示：

doctest results http://i39.tinypic.com/14904n5.jpg

我不知道我可以在doctest的Expecting部分放置什么，以便能够测试接收然后显示用户输入的方法。所以我的问题（最后）是，这个函数是doctestable吗？

Answer 1

使这个可测试的最简单方法是parameter injection：

def getFiveNums(input_func=input):
    print("Howdy. Please enter five numbers, hit <enter> after each one")
    for i in range(5):
        newNum = input_func("Please type in a number:")
        numbers.append(newNum)
    print("Here are your numbers: ", numbers)

您无法实际预期单元测试输入/输出 - 您不必担心对input的调用可能会以某种方式失败。你最好的选择是传递某种性质的存根方法;

之类的东西

def fake_input(str):
    print(str)
    return 3

因此，在doctest中，您实际上是在测试getFiveNums(fake_input)。

此外，通过打破对input 现在的直接依赖，如果您以后将此代码移植到其他地方没有使用命令你可以直接删除新代码来检索输入（无论是GUI应用程序中的对话框，还是基于Web的应用程序中的Javascript弹出窗口等）。

Answer 2

我知道你要求一个doctest答案，但我可以建议这种类型的功能可能不适合doctest。我使用doctests进行文档测试而不是测试，而doctest对此不会提供良好的文档恕我直言。

最简单的方法可能如下：

import unittest

# stores 5 user-entered numbers (strings, for now) in a list
def getFiveNums():
    numbers = []
    print "Howdy. Please enter five numbers, hit <enter> after each one"
    for i in range(5):
        newNum = input("Please type in a number:")
        numbers.append(newNum)
    return numbers

def mock_input(dummy_prompt):
    return 1

class TestGetFiveNums(unittest.TestCase):
    def setUp(self):
        self.saved_input = __builtins__.input
        __builtins__.input = mock_input

    def tearDown(self):
        __builtins__.input = self.saved_input

    def testGetFiveNums(self):
        printed_lines = getFiveNums()
        self.assertEquals(printed_lines, [1, 1, 1, 1, 1])

if __name__ == "__main__":
    unittest.main()

可能没有准确测试你提出的功能，但你明白了。

Answer 3

我发现了一种不同的方式。

"""
>>> get_five_nums(testing=True)
Howdy. Please enter five numbers, hit <enter> after each one.
Please type in a number: 1
Please type in a number: 1
Please type in a number: 1
Please type in a number: 1
Please type in a number: 1
Here is a list of the numbers you entered:  [1, 1, 1, 1, 1]
>>>
"""

import doctest

numbers = []

def get_five_nums(testing=False):
    """Stores 5 user-entered numbers (strings, for now) in a list."""

    print("Howdy. Please enter five numbers, hit <enter> after each one.")
    for i in range(5):
        new_num = int(input("Please type in a number: "))
        if testing:
            print(new_num)
        numbers.append(new_num)
    print("Here is a list of the numbers you entered: ", numbers)


if __name__ == "__main__":
    doctest.testmod(verbose=True)

将上述代码保存在名为 foo.py 的文件中。现在创建一个名为 input.txt 的文件。

它所需要的只是。

五个。每行一个。

要测试你的程序，请在终端或命令提示符处执行以下操作（我正在使用mac）：

$ python foo.py＆lt; input.txt中

对于任何程序的任何类型的用户输入，这都很容易改变。有了这个，您现在可以复制终端会话的输出并将其用作doctest。

注意：终端中的函数调用将是 get_five_nums（）。在你doctest中它需要 get_five_nums（testing = True）。

尽管doctest似乎并不打算以这种方式使用，但它仍然是一个方便的黑客。

Answer 4

我可以同意kludginess，但是要稍微减少一点，为什么不添加另一个为您保留大部分kludginess的小功能（并在测试时添加测试：）

我确实同意doctest可能不是这种测试的最佳解决方案，但是我发现自己将doctest用于TDD，在这里我喜欢不必离开文件甚至编写测试时的函数的简单性，所以我也很想以同样的方式做这样的测试。就是说，应该将编写getFiveNums（）的方法更改为更适合测试的方法，例如前面提到的参数注入。

def redirInput(*lines):
    """
    >>> import sys
    >>> redirInput('foo','bar')
    >>> sys.stdin.readline().strip()
    'foo'
    >>> sys.stdin.readline().strip()
    'bar'
    """
    import sys,io
    sys.stdin = io.StringIO(chr(10).join(lines))


def getFiveNums():
    """
    >>> redirInput('1','2','3','4','5')
    >>> getFineFums()
    ... rest as already written ...

Answer 5

这是我想出的解决方法。有点笨拙，但是仅需要一行输入时就可以使用：

def capitalize_name():
    """
    >>> import io, sys ; sys.stdin = io.StringIO("Bob")  # input
    >>> capitalize_name()
    What is your name?  Your name is BOB!
    """
    name = input('What is your name?  ')
    print('Your name is ' + name.upper() + '!')

不幸的是，当输入包含换行符时（例如“ Bob \ nAlice”），它会抱怨。我怀疑这是由于doctest解析器不堪重负（但我不能肯定地说）。

您可以改用chr(10)来解决“ \ n”问题，如下所示：

# stores 5 user-entered numbers (strings, for now) in a list
def getFiveNums():
    """
    >>> import io, sys ; sys.stdin = io.StringIO(chr(10).join(['1','2','3','4','5']))  # input
    >>> getFiveNums()
    Howdy. Please enter five numbers, hit <enter> after each one
    Please type in a number:Please type in a number:Please type in a number:Please type in a number:Please type in a number:Here are your numbers:  ['1', '2', '3', '4', '5']
    """
    print("Howdy. Please enter five numbers, hit <enter> after each one")
    numbers = []
    for _ in range(5):
        newNum = input("Please type in a number:")
        numbers.append(newNum)
    print("Here are your numbers: ", numbers)

这甚至更加混乱，但是确实有效。您需要记住，所有提示文本（通过input（）函数）都显示为输出，而没有附带用户输入。（这就是为什么“请输入数字：”连续出现五次，且实例之间没有空格或换行符的原因。）

尽管此解决方案确实有效，但请记住，与其他某些给定解决方案相比，它更难阅读和维护。在决定使用哪种方法时，需要考虑这一点。

接收和显示用户输入的Doctesting函数 - Python（撕掉我的头发）

5 个答案: