如何在通過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

它看起來像各種項目都不得不寫變通辦法此問題。