5.2.1 Normale utilizzo

Nell'uso corrente, si sostituisce ogni modulo M con il modulo da testare:

def _test():
    import doctest, M           # sostituite M con il nome del vostro modulo
    return doctest.testmod(M)   # idem

if __name__ == "__main__":
    _test()

Se si vuole testare il modulo come modulo principale non c'è bisogno di aggiungere M a testmod(); in questo caso testerà il modulo corrente.

Così, lanciando il modulo come uno script, si ottiene l'esecuzione e la verifica degli esempi contenuti nelle docstring:

python M.py

Questo non mostrerà nulla a meno che non fallisca un esempio, nel qual caso, l'esempio sbagliato e la causa/e dell'errore/i saranno stampati sullo stdout e l'ultima linea dell'output sarà 'Test failed.'.

Utilizzo con l'opzione -v:

python M.py -v

viene stampato un rapporto dettagliato di tutti gli esempi provati, insieme ad un riepilogo finale.

Si può forzare la modalità prolissa passando verbose=1 a testmod(), o al contrario, disattivarla passando verbose=0. In entrambi i casi, sys.argv non viene esaminato da testmod().

In ogni caso, testmod() restituisce una coppia di interi (f, t), dove f è il numero della docstring di esempio che fallisce e t è il numero totale di doctring di esempio provate.

Vedete Circa questo documento... per informazioni su modifiche e suggerimenti.