How do I test dictionary-equality with Python's doctest-package?

dictionary, doctest, python

Solution

Doctest doesn't check `__repr__` equality, per se, it just checks that the output is exactly the same. You have to ensure that whatever is printed will be the same for the same dictionary. You can do that with this one-liner:

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

Although this variation on your solution might be cleaner:

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

Problem

I'm writing a doctest for a function that outputs a dictionary. The doctest looks like ``` >>> my_function() {'this': 'is', 'a': 'dictionary'} ``` When I run it, it fails with ``` Expected: {'this': 'is', 'a': 'dictionary'} Got: {'a': 'dictionary', 'this': 'is'} ``` My best guess as to the cause of this failure is that doctest isn't checking dictionary equality, but `__repr__` equality. This post indicates that there's some way to trick doctest into checking dictionary equality. How can I do this?

Original source