doctest: Assegurando que documentação e implementação estejam sempre corretos

Um bom programador procura documentar direito o código que escreve. A linguagem Python é amiga do programador nesse aspecto com utilização de DocStrings.

Por exemplo:

   1 # este é o módulo minhasfuncoes.py
   2 
   3 def fat(n):
   4   """Calcula o fatorial de n.
   5 
   6   Exemplo de uso:
   7   >>> fat(0)
   8   1
   9   >>> fat(5)
  10   120
  11   """
  12   if x == 0:
  13     return 1
  14   else:
  15     return x * fat(x-1)

é uma implementação bem documentada da função fatorial dentro de um possível módulo chamado minhasfuncoes.

Uma preocupação maior seria sempre assegurar que o que escrevemos, código e documentação, estão corretos, mesmo quando procuramos melhorar ou até mesmo reescrever o que fizemos. Mas como certificar que não quebramos nada enquanto mudamos?

Repare nos exemplos apresentados para descrever a função fatorial, que tal usá-los como garantia de que não fizemos bobagem? Isto é possível através do módulo doctest do Python. vejamos como

   1 # este é o módulo minhasfuncoes.py
   2 
   3 def fat(n):
   4   """Calcula o fatorial de n.
   5 
   6   Exemplo de uso:
   7   >>> fat(0)
   8   1
   9   >>> fat(5)
  10   120
  11   """
  12   if n == 0:
  13     return 1
  14   else:
  15     return n * fat(n-1)
  16 
  17 def _test():
  18   import doctest, minhasfuncoes
  19   return doctest.testmod(minhasfuncoes)
  20 
  21 if __name__ == '__main__':
  22   _test()

O que se quer executar e testar formata-se igual ao que se usaria no modo interativo do Python (repare nos >>> antes). a saída esperada é indicada na linha logo a baixo, conforme deveria ser numa seção interativa.

Para rodar o teste é simples,

$ python minhasfuncoes.py

.Se nenhum erro acontecer a saída é muda, nada aparece na tela.

Digamos que eu mude if x == 0: return 1 para if x == 0: return 0 na implementação, a execução do teste me dirá que

$ python minhasfuncoes.py
*****************************************************************
Failure in example: fat(0)
from line #1 of minhasfuncoes.fat
Expected: 1
Got: 0
*****************************************************************
Failure in example: fat(5)
from line #3 of minhasfuncoes.fat
Expected: 120
Got: 0
*****************************************************************
1 items had failures:
   2 of   2 in minhasfuncoes.fat
***Test Failed*** 2 failures.

para fat(0) era esperado o valor 1, veio 0. Para fat(5) era esperado 120, veio 0 também. Dois erros foram indicados através da própria documentação da função.

Para saber mais

• Procure a documentação do doctest (>>> help(doctest)).

• Um exemplo de uso em VerificadorDeCpf.

-- RudaMoura