Skip to main content
 首页 » 编程设计

python之如何在通过 Travis CI 的文档字符串中编写示例

2025年05月04日45lhb25

我是文档字符串示例的 friend ,好的示例(在我看来)包括用户执行某些代码行时将看到的内容的声明。有时输出是字典,众所周知,字典本质上是无序的。

"""This method prints a dictionary. 
 
Examples 
-------- 
>>> a = dict(x=1, y=2) 
>>> a 
{'y': 2, 'x': 1} 
"""" 

我当然也可以是{'x': 1, 'y': 2}。正因为如此,Travis CI 会提示“失败的 doctest 测试”,并使用类似于以下的词语:

Expected: 
    {'y': 2, 'x': 1} 
Got: 
    {'x': 1, 'y': 2} 

我不能告诉 Travis CI 字典是无序的。如何使用包含字典输出的示例编写文档字符串,以便通过文档字符串测试?

请您参考如下方法:

这听起来确实有点烦人。

我认为除了针对 Travis CI 提出问题(因为这 是 Travis 错误)并希望它能得到修复之外,您无能为力。

与此同时,您可以将 Travis CI 配置为不运行此特定测试,或者您可以调整顺序并祈祷在给定特定输入的情况下,结果至少对您的特定安装具有部分确定性。

就其值(value)而言,您并不孤单:

看起来各种项目都必须为这个问题编写解决方法。