如何使用doctest测试异步功能？
使用doctest测试异步功能的步骤如下：
- 导入必要的模块和函数：首先需要导入
doctest模块和需要测试的异步函数。
import doctest
from your_module import async_function- 创建测试用例：使用 doctest 的标准注释语法在函数的 docstring 中编写测试用例。确保测试用例中包含要测试的异步函数的调用和预期结果。
def async_function():
"""
This is an async function.
>>> import asyncio
>>> async def test():
... result = await async_function()
... print(result)
...
>>> asyncio.run(test())
Hello, World!
"""
return "Hello, World!"- 运行测试：使用
doctest.testmod()函数运行测试，并将测试结果打印到控制台。
if __name__ == "__main__":
doctest.testmod()- 执行测试：运行你的模块，执行测试用例。如果测试通过，将不会有任何输出。如果测试失败，将会打印出详细的错误信息。
Hello, World!
TestResults(failed=0, attempted=1)使用 doctest 可以简单、方便地测试异步功能，并且将测试用例直接嵌入到函数的文档字符串中，使得测试代码与文档紧密结合。这样可以确保文档中的示例代码与实际代码保持一致，并且方便其他开发人员理解和使用你的异步函数。
腾讯云相关产品和产品介绍链接地址：
- 腾讯云云服务器（CVM）：提供弹性计算能力，支持多种操作系统和应用场景。
- 腾讯云云数据库 MySQL 版：可靠、可扩展的关系型数据库服务。
- 腾讯云云原生容器服务（TKE）：帮助用户快速构建和管理容器化应用的托管服务。
- 腾讯云人工智能服务：提供多个人工智能服务，如图像识别、语音合成、自然语言处理等。
- 腾讯云物联网套件：为物联网开发者提供全套解决方案，包括设备连接、数据管理和应用开发等。
- 腾讯云移动开发平台（MPS）：提供多媒体处理和存储的服务，可用于音视频处理、直播等场景。
- 腾讯云分布式文件存储（CFS）：高性能、可扩展的文件存储服务，适用于多种应用场景。
- 腾讯云区块链服务（BCS）：提供区块链网络搭建和管理的平台，帮助企业快速实现区块链应用。
- 腾讯云云游戏解决方案：为游戏开发者提供云游戏相关的技术和服务。
请注意，以上链接仅供参考，并非广告推广。
相关·内容
我所参与的一个项目的一位开发人员同事认为，doctest和单元测试一样好，如果一段代码经过doctest测试，它就不需要进行单元测试。我不相信情况是这样的。有人能提供一些可靠的、理想的引用的例子，支持或反对文档测试取代单元测试需求的论点吗？
谢谢你，-Daniel
编辑:有没有人能提供一个证明文档测试不应该取代单元测试的参考资料？
浏览 3提问于2010-04-15得票数 12
回答已采纳
7回答
Django 1.4 声明：
对于给定的Django应用程序，测试运行程序在两个位置查找doctest：
models.py文件。您可以为单个模型定义模块级的doctest和/或doctest。通常的做法是在模块docstring中放置应用程序级doctest，在模型docstring中放置模型级doctest。
应用程序目录中名为tests.py的文件--即保存models.py的目录。这个文件是您想要编写的不一定与模型相关的所有文档测试的挂钩。
出于好奇，我想知道为什么Django的testrunner仅限于models.py中的doctest，但更实际的是
浏览 2提问于2010-03-04得票数 26
回答已采纳
在Delphi中有没有DocTest的等价物。我使用DUnit，但我喜欢Python DocTest的想法。我看到了一些像这样的答案，但我认为，对于简单的函数，像这样的DocTest可能是可以的。我的目标是在编写函数时在注释标头中定义测试。像这样：
function Plus(i1, i2 : integer) : integer;
//>>> Check( Plus(1, 3) = 4)
begin
result := i1 + i2;
end;
浏览 0提问于2012-04-06得票数 4
回答已采纳
我希望在一个文件中有几个doctest共享测试数据和/或函数。有没有一种方法可以做到这一点，而不需要在外部文件中或在被测试文件的代码中找到它们？
更新
"""This is the docstring for the module ``fish``.
I've discovered that I can access the module under test
from within the doctest, and make changes to it, eg
>>> import fish
>>> fish.da
浏览 2提问于2010-07-20得票数 2
我试图在我的类中的Python2.7程序中在中使用一个实例。我没有从测试中得到任何输出，而是得到了一个回答：“一无所获”。
这个简化的测试用例演示了错误：
#!/usr/bin/env python2.7
# encoding: utf-8
class Dummy(object):
'''Dummy: demonstrates a doctest problem
>>> from StringIO import StringIO
... s = StringIO()
... print("s is creat
浏览 1提问于2016-12-09得票数 3
回答已采纳
3回答
我正在使用Python Nose，我想打印测试ran的类型，比如它是Doctest还是unittest等等？如何做到这一点？
谢谢。
浏览 0提问于2012-10-09得票数 0
回答已采纳
我通常在模块中同时编写单元测试和文档测试。在运行测试套件时，我想自动运行所有的doctest。我认为这是可能的，但我在语法方面遇到了困难。
我有测试套件
import unittest
class ts(unittest.TestCase):
def test_null(self): self.assertTrue(True)
if __name__ == '__main__': unittest.main()
我想在这个套件中添加模块module1中的所有doctest。我该怎么做？我读过“”，但在这里，我离成功还差得远。加行
import doctest
impor
浏览 9提问于2011-04-15得票数 12
回答已采纳
给定以下python脚本：
# dedupe.py
import re
def dedupe_whitespace(s,spacechars='\t '):
"""Merge repeated whitespace characters.
Example:
>>> dedupe_whitespace(r"Green\t\tGround") # doctest: +REPORT_NDIFF
'Green\tGround'
"""
f
浏览 59提问于2012-01-12得票数 19
回答已采纳
2回答
我知道如何使用# doctest: +SKIP跳过doctest，但我不知道如何根据运行时条件有时跳过测试。例如：
>>> if os.path.isfile("foo"):
... open("foo").readlines()
... else:
... pass # doctest: +SKIP
['hello', 'world']
这就是我想做的事。我还将接受一个运行测试的解决方案，但是如果不满足条件(即无条件地运行测试，但修改预期的结果)，则会将预期的结果更改为具有回溯性的异常。
浏览 4提问于2017-03-10得票数 16
另一种问这个问题的方法是:如果我用reST编写文档测试，我可以将它用于Sphinx或其他自动文档编制工作吗？
背景:我不知道如何使用Sphinx，也没有太多使用reST的经验，所以我想知道我是否可以在其他地方使用reST编写的文档测试而不是Sphinx？
浏览 0提问于2012-05-19得票数 0
回答已采纳
我完全可以编写一个“正常”的测试来捕捉IO。
只想知道是否可以使用Doctest。
一个例子是：
defmodule CLI do
@doc """
Politely says Hello.
## Examples
iex> CLI.main([])
"Hello dear person." # this would be the expected IO output
"""
def main(args) do
IO.puts "Hello dear pers
浏览 2提问于2017-10-11得票数 3
回答已采纳
我如何使下列工作，以便帮助的测试运行？不会的。
def B():
def helper():
"""
>>> some doctest
result
"""
...
if __name__ == "__main__":
import doctest
doctest.testmod()
浏览 0提问于2015-03-27得票数 3
回答已采纳
以下(无意义的) Python模块的doctest失败：
"""
>>> L = []
>>> if True:
... append_to(L) # XXX
>>> L
[1]
"""
def append_to(L):
L.append(1)
class A(object):
pass
return A()
import doctest; doctest.testmod()
这是因为标记为XXX的行后的输出是<__main__.A o
浏览 1提问于2010-10-05得票数 4
回答已采纳
我正在使用进行C++项目中的测试。
我想把测试代码和我的实现放在一起，就像库说的那样，但是我似乎不知道如何处理doctest实现代码。
我有一个doctest.cpp文件，如下所示：
#define DOCTEST_CONFIG_IMPLEMENT_WITH_MAIN
#include "doctest.h"
一个看起来像这样的main.cpp：
#include "thing.h"
int main(int argc, const char *argv[]) {
do_thing();
}
thing.h是不言自明的，但thing.cpp如下所示：
浏览 1提问于2019-03-18得票数 3
回答已采纳
假设我们有两个文件：
失败/不合格
"""
>>> True
False
"""
传球/填塞
"""
>>> True
True
"""
然后我们在doctest下运行它们：
python -m doctest fail/stuff.py pass/stuff.py
正如预期的那样，我们看到了来自fail/stuff.py的一个错误。但如果我们按相反的顺序运行：
python -m doctest pass/stuff.py fail/stuff.py
然后它就过
浏览 3提问于2017-04-18得票数 3
回答已采纳
4回答
是否可以将Python的doctest概念用于类，而不仅仅是函数？
如果是这样，我应该把doctest放在哪里--放在类的docstring上，还是放在构造函数的docstring上？
为了澄清，我正在寻找类似这样的东西：
class Test:
"""
>>> a=Test(5)
>>> a.multiply_by_2()
10
"""
def __init__(self, number):
self._number=number
de
浏览 1提问于2010-04-25得票数 47
回答已采纳
多年前，数学家和软件开发人员time发现，在软件生命周期中，API文档往往会随着时间的推移而过时，因为当添加特性或函数或方法的调用签名发生变化时，记录API的注释往往被忽略。
为了解决这个问题，他发明了doctest模块，它引入了一些“可执行文档”或“读写测试”(另请参阅：博士文档)。
正如其他地方已经指出的那样，将大量的单元测试放入所有Python模块、函数、类和方法的文档字符串中，会使API文档变得过于混乱。
因此，我正在寻找一种优雅而聪明的方法来将曾经是doctest示例的测试用例转移到其他地方，在那里它们仍然可以被某个单元测试执行驱动程序找到。
浏览 0提问于2015-12-18得票数 5
回答已采纳
1回答
我只想运行特定的文档测试，而不是运行所有的文档测试。有什么办法可以做到这一点吗？我知道您可以通过--doc来只运行文档测试，但是有没有一个标志允许我只运行一个特定的测试。
浏览 25提问于2021-03-01得票数 4
回答已采纳
如何使用doctest测试“多重回溯”？似乎使用多个ELLIPSIS和<BLANKLINE>并不能达到目的：
def myfunc():
"""
>>> myfunc()
Traceback (most recent call last):
...
ValueError: this is
<BLANKLINE>
The above exception was the direct cause of the following exception:
<BLA
浏览 6提问于2018-11-23得票数 2
我们目前在tests目录中的测试上运行了带有coverage插件的pytest。
运行从我们的主代码中提取的文档测试的最简单方法是什么？--doctest-modules无法工作(可能是因为它只运行来自tests的文档测试)。请注意，我们希望在同一流程中包含文档测试(而不是简单地运行单独的py.test调用)，因为我们希望在代码覆盖率中考虑文档测试。
浏览 1提问于2013-06-12得票数 26
回答已采纳
在使用文档测试和快速检查时，如何定义Arbitrary实例(如所述)？
Doctest和Cabal按照的描述进行设置，并使用单独的目录进行测试。
doctest行如下所示：
-- prop> (\s -> (decode . encode $ s == s)) :: ByteString -> Bool
decode :: ByteString -> ByteString
encode :: ByteString -> ByteString
我应该在哪里以及如何定义Arbitrary实例，这样doctest才能找到它？请注意，我希望在测试项目中定义它。
浏览 1提问于2013-04-09得票数 1
回答已采纳
在Python3.9文档测试中，我遇到了一个非常奇怪的单元测试失败。通常，我需要清理我的问题，但是这是一个非常低级别的代码，所以我可以在这里完整地发布它。
我可以在Pycharm中运行这个文档测试，没有问题。当我在命令行上运行它时，我会得到一个没有意义的失败。任何帮助都将不胜感激。
quadratic_solver.py
import math
import numpy as np
import doctest
def solve(
a: float,
b: float,
c: float):
"""
浏览 3提问于2021-09-15得票数 0
回答已采纳
1回答
我已经编写了一个用于测试的assert_raised上下文管理器，它会检查是否如预期的那样引发了异常，如果没有，就会引发AssertionError。我也写了一个doctest来测试这个，但是doctest总是失败，我不完全确定为什么。这里是doctest：
>>> for e in [TypeError, ValueError, KeyError]:
... with assert_raised(TypeError, ValueError):
... print('Raising {}...'.format(e.__name__))
浏览 2提问于2012-04-10得票数 4
回答已采纳
在带有random.random模块的函数上进行文档测试会是什么样子。我的意思是，如果该方法生成一个包含360个介于0-1之间的不同随机数的列表，您如何测试它？
def berakna_slump_tal(self):
self.slump_tal = []
t = 0
while t <= 360:
slump = random.random()
self.slump_tal.append(slump)
t = t + 1
是否可以在一个单独的文件中使用doctest来测试这
浏览 1提问于2015-12-10得票数 0
我可以将python doctest放在每个函数的主体中，因为它们与函数位于同一个文件中，因此有时我喜欢使用小型库。
或者我可以将它们放在一个单独的文件中并执行单独的文件，这很好，以防我不希望在函数之间进行doctest。有时，我发现如果文档字符串很小，代码就更容易处理。
是否也有方法将python doctest保存在同一个文件中，但将它们放在文件的末尾？
编辑:基于以下已接受的答案的解决方案：
def hello_world():
return u'Hello World'
def hello(name):
return u'Hello %s'
浏览 2提问于2012-03-19得票数 2
回答已采纳
3回答
我有一个python模块some_module，它有一个导入方法的__init__.py文件，如下所示：
from .some_python_file import some_method
some_method有一个包含doctest的docstring：
def some_method():
"""
>>> assert False
"""
但是，当我在模块上运行doctest时，即使测试失败，它也会通过。
import some_module
# How do I get this to consi
浏览 8提问于2021-04-11得票数 2
回答已采纳
在python中，我们如何为类编写测试用例？例如：
class Employee(object):
num_employees = 0
# numEmployess is incremented each time an employee is constructed
def __init__(self, salary=0.0, firstName="", lastName="", ssID="", DOB=datetime.fromordinal(1), startDate=datetime.today()): #Employee
浏览 0提问于2012-05-10得票数 15
回答已采纳
1回答
我想将输入到doctest的文本拆分成新的行。下面是一个最小的例子： import doctest
def example1():
"""
>>> txt = '\\n'.join(['abcd', 'efg'])
"""
return '\\n'.join(['abcd', 'efg'])
def example2():
"""
>>>
浏览 10提问于2019-09-24得票数 0
回答已采纳
2回答
我很困惑为什么doctest.testmod()以奇怪的顺序调用测试函数
from doctest import testmod
def test_forwrite():
'''
>>> test_forwrite()
OP: Done
'''
write()
def test_forread():
'''
>>> test_forread()
OP: Done
'''
read(
浏览 3提问于2020-01-14得票数 3
回答已采纳
如何使用命令行对python中的单个函数运行doctest？我可以使用python3 -m doctest -v main.py，但这将运行main.py中的所有文档测试。如何指定一个函数来调用doctest？
浏览 41提问于2021-07-16得票数 0
回答已采纳
我想我遗漏了一些关于doctest的sphinx扩展。
文档中的典型示例是：
.. doctest::
>>> print 1
1
有没有办法让sphinx自动生成输出(这里是：1)？
据我所知，可以运行：
$ make doctest
其效果是测试代码片段，并将实际输出与预期输出进行比较。例如，如果您有
.. doctest::
>>> print 1
3
doctest将警告您，它在预期3时获得了1。
相反，我希望sphinx将实际输出单独插入到我的文档字符串或.rst文件中。例如，如果我们有这样的内容：
.. doctest
浏览 2提问于2012-03-22得票数 11
回答已采纳
3回答
我这样写我的doctest：
>>> some_function(a=1, b=2)
{u'id': u'123', u'name': u'abc'}
这适用于Python版本2.5、2.6和2.7，但无法用于Python 3，并显示以下错误：
Expected:
{u'id': u'123', u'name': u'abc'}
Got:
{'id': '123', 'name': &#
浏览 3提问于2012-11-20得票数 10
回答已采纳
我的Python 打开了一些它从未关闭过的文件。这不会造成任何问题；当对象被销毁时，它们会自动关闭，添加逻辑来确保它们被异常关闭会使我的文档变得不必要地复杂。
但是，当文档测试在中运行时，它们会开始发出ResourceWarning()，给我的输出增加了无用的噪音。
例如，给定leak.py：
def hello(f):
"""
>>> a = open("test-file","w")
>>> hello(a)
>>> open("test-
浏览 3提问于2021-07-29得票数 1
我不能让doctest测试我的模块类方法。
我的模块看起来像这样：
simplemod
├── A.py
└── __init__.py
A.py包含：
class A:
def method(self):
"""This is a test
>>> True
False
"""
pass
(所以测试应该会失败)
__init__.py包含
from .A import A
__test__ = {'A': A}
然后我跑
浏览 5提问于2017-03-03得票数 1
回答已采纳
2回答
import doctest
__test__['test'] = \
"""
>>> y = 1
>>> y == 1
True
"""
预期:0失败，1次尝试
实际:0失败，2次尝试
如何告诉doctest，第一行只是设置，而不是测试？
浏览 4提问于2020-07-14得票数 2
回答已采纳
我正在为输出字典的函数编写doctest。doctest看起来像这样
>>> my_function()
{'this': 'is', 'a': 'dictionary'}
当我运行它时，它失败了，如下所示
Expected:
{'this': 'is', 'a': 'dictionary'}
Got:
{'a': 'dictionary', 'this': 'is'}
浏览 3提问于2013-03-21得票数 44
回答已采纳
当我试图运行我接收到的目录的所有doctest时
/usr/bin/python3.4 /home/d9k/soft/pycharm-community-3.4.1/helpers/pycharm/docrunner.py /home/d9k/pr/bkuppr/
Testing started at 12:05 AM ...
usage: .........
docrunner.py: error: invalid choice: '/home/d9k/pr/bkuppr/' (choose from 'run', 'restore',
浏览 4提问于2014-11-08得票数 0
回答已采纳
4回答
以下文档测试失败：
import logging
logging.basicConfig(level=logging.DEBUG,format='%(message)s')
def say_hello():
'''
>>> say_hello()
Hello!
'''
logging.info('Hello!')
if __name__ == '__main__':
import doctest
doctest.testmod()
这几页
浏览 2提问于2014-03-10得票数 8
回答已采纳
我写了一些我想分享的代码，我想遵循创建/维护它的结构的最佳实践。我将把代码托管在BitBucket上，现在我正在考虑应该如何组织它。这是一个好的结构吗？
project_name/
lib/
test/
README
因此，这里的源代码在lib中，测试在test中。在Python项目中是这样做的吗？这就是我在Ruby项目中看到的最常用的结构。另外，当我运行单元测试时，这样做被认为是一种好的做法：
set PYTHONPATH=`pwd`/lib
python test/a_test.py
浏览 1提问于2011-06-12得票数 9
我有以下函数和docstring：
def vflip(self):
"""
Vertically flips the characters on this canvas.
>>> canvas = Canvas(4, 4)
>>> canvas.fill('.')
>>> canvas[0, 0] = 'A'
>>> canvas[1, 1] = 'B'
>>> canvas
浏览 9提问于2018-08-28得票数 1
我正在努力将doctest库添加到我的项目中。
我有以下几点
\apps
|____ \app1
| |____ App1.cpp, App1.h <<== which uses lib_a
| |____ CMakeLists.txt
|
|____ \src
|____ \lib_a
|____ \include : Class_a.h
|____ Class_a.cpp <<== which
浏览 1提问于2021-07-26得票数 0
我想像这样写一个doctest：
"""
>>> print a.string()
foo : a
bar : b
date : <I don't care about the date output>
baz : c
"""
有没有办法做到这一点？我认为切换到unittest会更有意义，但我很好奇是否可以指定一个不应该与doctest中的测试匹配的输出范围。
谢谢!
浏览 6提问于2009-06-21得票数 38
回答已采纳
有没有办法让Pycco将doctest识别为代码并适当地呈现它们？
例如，以下函数的文档字符串
def fib(i):
""" Fibonacci number
>>> fib(10)
55
"""
if i < 2:
return i
else:
return fib(i-1) + fib(i-2)
在Pycco中呈现，如下所示
Fibonacci number
fib(10) 5
显然，>>>被解
浏览 2提问于2015-01-06得票数 1
1回答
我希望每次从命令行运行程序时都会发生这种情况。我的方法是Pythonic吗？我想知道是否存在可读性或正确性方面的问题。任何关于更好的做事方式或潜在问题的一般性建议也是受欢迎的。
尽管main函数只是一个示例，但我希望查看其余代码，我打算将其附加到所有现有程序中，因此，它不仅仅是示例代码。我在这里包含了main函数示例，因为我使用它来观察在包含通过或失败的doctest时的不同行为。如果任何doctest失败，这将被打印到stdout，程序将不会运行。如果所有的doctest都通过了，那么测试中就没有输出，程序将正常运行。
"""Auto doctest.
Code t
浏览 0提问于2014-04-14得票数 10
回答已采纳
5回答
我正在使用doctest.testmod()做一些基本的测试。我有一个函数返回一个长字符串，比如get_string()。类似于：
def get_string(a, b):
r''' (a, b) -> c
>>> get_string(1, 2)
'This is \n\n a long \n string with new \
space characters \n\n'
# Doctest should work but does not.
'''
浏览 5提问于2015-03-02得票数 11
回答已采纳
为一种方法编写doctest，该方法通过在原始字典的键中搜索传递的关键字，并返回新的、缩写的字典来缩写字典。我的docstring看起来如下：
def abbreviate_dict(key_word, original_dict):
"""
>>> orig_dict = {apple_stems: 2, apple_cores: 5, apple_seeds: 3}
>>> abbreviate_dict('apple', orig_dict)
{'cores': 5
浏览 1提问于2016-06-22得票数 6
回答已采纳
1回答
我的Django测试套件出了点小问题。
我正在开发一个可以在Django和Plone ()中运行的Python包。所有的测试都是以文档测试的形式编写的，或者是在Python代码中，或者是在单独的文档文件中(例如README.txt)。
我可以让这些测试运行得很好，但Django就是不计算它们：
[vincent ~/buildouts/tests/django_pyproxy]> bin/django test pyproxy
...
Creating test database for alias 'default'...
----------------------
浏览 2提问于2011-09-29得票数 2
回答已采纳
1回答
我是一个Python初学者，为了学校，我有点挑剔。我的老师想让我写一个函数，返回一个带重音的句子，"print()“显示正确的字符，带重音，但doctest没有。
下面是我的代码：
def test() :
"""
>>> test()
à - â - ä - é - è - ê - ë - ï - î - ô - ö - ù - û - ü - ÿ - ç
"""
print("à - â - ä - é - è - ê - ë - ï - î - ô - ö - ù - û -
浏览 0提问于2017-09-30得票数 0
1回答
我正在努力弄清楚如何让doctest与Sphinx一起工作，但它似乎并没有找到我的测试。下面是一个简单的例子。
def my_func():
'''
Dummy test function. Returns the number 5.
.. doctest::
>>> my_func()
5
'''
return 5
当我运行make doctest时，输出告诉我没有测试。我很确定我的配置是正确的，因为如果我运行make html，然后转到我的index.html文件，我
浏览 2提问于2017-09-28得票数 1
回答已采纳
..。还有一匹小马！不，说真的。我正在寻找一种方法来组织“仅仅有效”的测试。大多数事情都是可行的，但并不是所有的东西都合二为一。所以我想要的是：
让测试自动发现。这包括医生测试。请注意，文档测试的总和不能显示为单个测试。(即不是py.test -doctest-模块所做的)
能够并行运行测试。(类似于xdist的py.test -n )
生成覆盖报告。
让python setup.py test发挥作用。
我目前的方法包括一个tests目录和。所有包含的文件都命名为test_*.py。如果我创建一个具有以下内容的test_doctests.py文件，这将使test_do
浏览 5提问于2013-06-07得票数 10
扫码
添加站长 进交流群
领取专属 10元无门槛券
手把手带您无忧上云
相关资讯
热门标签
云服务器
ICP备案
对象存储
实时音视频
即时通信 IM活动推荐
腾讯云开发者
