Diferenças entre as versões de 5 e 12 (7 versões de distância)

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   >>> fat(0)
   7   1
   8   >>> fat(5)
   9   120
  10   """
  11   if x == 0:
  12     return 1
  13   else:
  14     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   >>> fat(0)
   7   1
   8   >>> fat(5)
   9   120
  10   """
  11   if n == 0:
  12     return 1
  13   else:
  14     return n * fat(n-1)
  15 
  16 def _test():
  17   import doctest, minhasfuncoes
  18   return doctest.testmod(minhasfuncoes)
  19 
  20 if __name__ == '__main__':
  21   _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

-  ⇤ ← Revisão  5e 2004-07-19 19:07:20 → 
  Tamanho: 2276
  Editor: RudaMoura
  Comentário:
+   ← Revisão  12e 2004-07-19 19:45:15 → ⇥
  Tamanho: 2641
  Editor: RudaMoura
  Comentário:
-Deleções são marcadas assim.
+Adições são marcadas assim.
 Linha 1:
-= doctest: teste automatizado utilizando DocStrings =
+= doctest: Assegurando que documentação e implementação estejam sempre corretos =
 Linha 3:
-Você que é bom programador e cuidadoso, aposto que procuras documentar
direito o código que escreves. A linguagem Python é bem amiga nesse aspecto,
com a utilização de DocStrings. Por exemplo:
+Um bom programador procura documentar direito o código que escreve.
A linguagem Python é amiga do programador nesse aspecto
com utilização de DocStrings.
 Linha 7:
+Por exemplo:
-Linha 8:
+Linha 9:
+# este é o módulo minhasfuncoes.py
-Linha 10:
+Linha 13:
-  >>> f(0)
  1
  >>> f(5)
  120
  """
  if x == 0:
    return 1
  else:
    return x * f(x-1)
}}}
-Linha 21:
+Linha 14:
-é uma implementação bem documentada da função fatorial dentro de um hipotético
módulo {{{minhasfuncoes.py}}}.

Uma preocupação maior seria sempre assegurar que o que escrevemos
está correto, mesmo quando procuramos melhorar ou até mesmo reescrever
a implementação de uma função ou classe em Python. Mas como certificar
que não quebramos nada enquanto mudamos?

A resposta está nos testes automatizados.
Escolher bem o que testar e como testar é uma arte em si.
Repare nos exemplos que eu escrevi para
descrever a função fatorial, que tal eu usar esses exemplos
como teste?

Eu poderia escrever a uma função test() e assim escrever
novamente esses exemplos dentro desta função e conferir
se não tem nada errado com a entrada e a saída da função.

{{{#!python
def fat(n):
  """Calcula o fatorial de n.
  >>> f(0)
  1
  >>> f(5)
  120
  """
  if x == 0:
    return 1
  else:
    return x * f(x-1)

def test():
  assert f(0) == 1
  assert f(5) == 120

if __name__ == '__main__':
  test()
}}}

Mas tem um jeito melhor e mais amigo de fazer isso, através do módulo
{{{doctest}}} do Python. Aproveitando os próprios exemplos documentados
e sem copiar tudo novamente (passível de falha isso).

{{{#!python
def fat(n):
  """Calcula o fatorial de n.
-Linha 76:
+Linha 23:
+}}}

é 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
{{{#!python
# este é o módulo minhasfuncoes.py

def fat(n):
  """Calcula o fatorial de n.

  >>> fat(0)
  1
  >>> fat(5)
  120
  """
  if n == 0:
    return 1
  else:
    return n * fat(n-1)
-Linha 85:
+Linha 61:
-Observe que o que eu quero testar eu formato igualzinho
como eu usaria no modo interativo do Python (repare nos >>>).
O que eu quero executar, eu ponho como >>> na frente,
a saída esperada eu acrescento na linha a baixo,
conforme deveria ser.
+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.
-Linha 91:
+Linha 66:
-Pra testar é simples, {{{$ python minhasfuncoes.py}}}. Se nenhum
erro acontecer, a saída é muda, nada aparece na tela.
+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

Veja também:

Diferenças para "DocTest"

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

Para saber mais