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

Question

我是docstrings中的示例的朋友，并且在我看来，很好的示例包含了一条关于如果她执行一些代码行时用户将看到什么的声明。有时输出是字典，这些字典都是天生无序的。

"""This method prints a dictionary. 

Examples 
-------- 
>>> a = dict(x=1, y=2) 
>>> a 
{'y': 2, 'x': 1} 
"""" 

我当然也可以是{'x': 1, 'y': 2}。正因为如此，特拉维斯CI会抱怨“失败文档测试测试”类似于这样的话：

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

我不能告诉特拉维斯CI是一本字典是无序的。我如何编写一个文档字符串，其中包含字典输出的示例，以便通过文档字符串测试？

Answer 1

我的问题基本上是关于文档中的字典。我最喜欢的解决方法是

""" 
>>> a = dict(x=1, y=2) 
>>> sorted(a.items()) 
[('x', 1), ('y', 2)] 
""" 

Answer 2

这听起来很讨厌。

除了向Travis CI提出问题（因为是是一个Travis bug）并希望它会得到修复，我不认为你可以做任何事情。

与此同时，您可以配置Travis CI不要运行这个特定的测试，或者您可以调整顺序并且在特定输入的情况下为您的特定安装祈祷结果至少是部分确定性的。

对于它的价值，你并不孤单：

• https://github.com/nengo/nengo/issues/809
• https://github.com/nengo/nengo/issues/830

它看起来像各种项目都不得不写变通办法此问题。