Làm cách nào để kiểm tra sự bình đẳng từ điển với gói doctest của Python?

Question

Tôi đang viết một tài liệu cho một hàm xuất ra từ điển. Các doctest trông giống như

>>> my_function() 
{'this': 'is', 'a': 'dictionary'} 

Khi tôi chạy nó, nó không thành công với

Expected: 
    {'this': 'is', 'a': 'dictionary'} 
Got: 
    {'a': 'dictionary', 'this': 'is'} 

đoán tốt nhất của tôi như là nguyên nhân của sự thất bại này là doctest không kiểm tra bình đẳng từ điển, nhưng __repr__ bình đẳng. This post chỉ ra rằng có một số cách để lừa doctest vào kiểm tra bình đẳng từ điển. Tôi có thể làm cái này như thế nào?

Answer 1

Doctest không kiểm tra số __repr__ bình đẳng, nó chỉ kiểm tra xem kết quả có giống hệt nhau hay không. Bạn phải đảm bảo rằng mọi thứ được in sẽ giống nhau cho cùng một từ điển. Bạn có thể làm điều đó với một-liner:

>>> sorted(my_function().items()) 
[('a', 'dictionary'), ('this', 'is')] 

Mặc dù sự thay đổi này trên giải pháp của bạn có thể là sạch hơn:

>>> my_function() == {'this': 'is', 'a': 'dictionary'} 
True 

Answer 2

lượt nó thành một danh sách qua dict.items() và sau đó sắp xếp nó ...

>>> l = my_function().items() 
>>> l.sort() 
>>> l 
[('a', 'dictionary'), ('this', 'is')] 

Answer 3

tôi đã kết thúc sử dụng này. Hacky, nhưng nó hoạt động.

>>> p = my_function() 
>>> {'this': 'is', 'a': 'dictionary'} == p 
True 

Answer 4

Một cách tốt là sử dụng pprint (trong thư viện tiêu chuẩn).

>>> import pprint 
>>> pprint.pprint({"second": 1, "first": 0}) 
{'first': 0, 'second': 1} 

Theo mã nguồn của nó, nó sắp xếp dicts cho bạn:

http://hg.python.org/cpython/file/2.7/Lib/pprint.py#l158

items = _sorted(object.items()) 

Answer 5

Bạn có thể tạo một thể hiện của unittest.TestCase lớp bên doctests của bạn, và sử dụng nó để so sánh các từ điển:

def my_function(x): 
    """ 
    >>> from unittest import TestCase 
    >>> t = TestCase() 

    >>> t.assertDictEqual(
    ...  my_function('a'), 
    ...  {'this': 'is', 'a': 'dictionary'} 
    ...) 

    >>> t.assertDictEqual(
    ...  my_function('b'), 
    ...  {'this': 'is', 'b': 'dictionary'} 
    ...) 

    """ 
    return {'this': 'is', x: 'dictionary'} 

Lưu ý: phương pháp này tốt hơn đơn giản là kiểm tra xem từ điển có bình đẳng không, vì nó sẽ hiển thị khác biệt giữa hai từ điển.

Answer 6

Hầu hết người ta đã đã nói ở đây .. anyway JSYK: có một phần dành riêng trong tài liệu doctest:

https://docs.python.org/3.5/library/doctest.html#warnings