Sommaire

Documenter et tester son code en une seule fois avec le module doctest Documenter:module doctest

La documentation du code est une étape essentielle lors de l’élaboration d’un programme Python. En entreprise et dans de nombreux projets open source, documenter son code est primordial car celui-ci est distribué à un très grand nombre de développeurs. Il est important que le code soit clair et compréhensible, et une bonne documentation facilite grandement cette étape. En Python, l’écriture de documentation passe par l’utilisation des docstrings. Les concepteurs du langage considèrent les docstrings tellement importantes qu’il existe même une PEP qui explique les standards d’écriture de celles-ci. PEP 0257 - Docstring Conventions, disponible à l’adresse https://www.python.org/dev/peps/pep-0257/. Docstring:PEP 0257 - Docstring Conventions Documentation PEP

Pour mieux comprendre à quoi sert une docstring, il est utile d’écrire un module contenant deux fonctions, fois_deux et fois_cinq, qui multiplient respectivement un entier par 2 ou par 5, et retournent le résultat. Jusqu’à présent, les exemples que nous avons écrits n’étaient pas documentés afin d’optimiser la place et les caractères. Ici, le module est documenté dans son intégralité (Chapitre_9/doctest_1.py) :

1 #!/usr/bin/env python3 
2 import operator  ...