Come posso testare l'uguaglianza dei dizionari con il pacchetto doctest di Python?

Question

Sto scrivendo un doctest per una funzione che genera un dizionario. Il doctest sembra

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

quando l'eseguo, non riesce con

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

La mia ipotesi migliore per quanto riguarda la causa di questo fallimento è che doctest non sta controllando l'uguaglianza dizionario, ma __repr__ uguaglianza. This post indica che esiste un modo per ingannare doctest nel controllo dell'uguaglianza dei dizionari. Come posso fare questo?

Answer 1

doctest non controlla __repr__ uguaglianza, di per sé, è solo controlla che l'uscita è esattamente lo stesso. Devi assicurarti che tutto ciò che è stampato sia lo stesso per lo stesso dizionario. È possibile farlo con questo one-liner:

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

Anche se questa variazione sul tuo soluzione potrebbe essere più pulita:

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

Answer 2

trasformarlo in un elenco tramite dict.items() e poi ordinarlo ...

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

Answer 3

ho finito per usare questo. Hacky, ma funziona.

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

Answer 4

Un altro buon modo è quello di utilizzare pprint (nella libreria standard).

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

Secondo il suo codice sorgente, è l'ordinamento dicts per voi:

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

items = _sorted(object.items()) 

Answer 5

È possibile creare un'istanza di unittest.TestCase classe all'interno del vostro doctests, e usarlo per confrontare dizionari:

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'} 

Nota: questo approccio è migliore piuttosto che controllare se i dizionari sono uguali, perché mostrerà diff tra i due dizionari.

Answer 6

La maggior parte di esso è stato già detto qui .. in ogni caso JSYK: v'è una sezione dedicata nella documentazione doctest:

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