Création d’un script documenté (avec des docstrings)

Création d’un script documenté (avec des docstrings)

Script « script_documente.py » :

"""module permettant à partir de deux nombres nb1 et nb2
d'exécuter les quatre opérations fondamentales"""

def addition (nb1, nb2) :
    """fonction de l'addition"""
    print (nb1, "+", nb2, "=", nb1+nb2)

def soustraction (nb1, nb2) :
    """fonction de la soustraction"""
    print (nb1, "-", nb2, "=", nb1-nb2)

def multiplication (nb1, nb2) :
    """fonction de la multiplication"""
    print (nb1, "X", nb2, "=", nb1*nb2)

def division (nb1, nb2) :
    """fonction de la division"""
    print (nb1, "/", nb2, "=", nb1/nb2)

Les docstrings s’écrivent entre 2 triples doubles guillemets

"""docstring"""

Exécution via F5 et appel de l’aide help ( ) :

>>> help ("script_documente")
Help on module script_documente:

NAME
    script_documente

DESCRIPTION
    module permettant à partir de deux nombres nb1 et nb2
    d'exécuter les quatre opérations fondamentales

FUNCTIONS
    addition(nb1, nb2)
        fonction de l'addition
    
    division(nb1, nb2)
        fonction de la division
    
    multiplication(nb1, nb2)
        fonction de la multiplication
    
    soustraction(nb1, nb2)
        fonction de la soustraction

FILE
    c:\users\fabricedumont\desktop\script_documente.py


>>> 

Vous pouvez donc documenter votre script en général ainsi que toutes vos fonctions

Exécution avec appel des fonctions :

>>> addition (10,3)
10 + 3 = 13
>>> division (10,4)
10 / 4 = 2.5
>>> multiplication (4,8)
4 X 8 = 32
>>> soustraction (45,6)
45 - 6 = 39
>>>

Laisser un commentaire

Votre adresse e-mail ne sera pas publiée. Les champs obligatoires sont indiqués avec *