Écriture d'un projet

Conseil

Les conventions d'usage[1] ont déjà été décrite sur cette page web. Pour la rédaction d'un fichier, les éléments doivent apparaître dans l'ordre suivant :

  1. La licence du fichier est indiquée en utilisant des #

  2. une chaîne documentaire (docstring) décrivant ce que l'on trouve dans le fichier ;

  3. la liste des import ;

  4. les constantes ;

  5. les fonctions ou les classes avec les chaînes documentaires (docstring) correspondantes ;

  6. le programme principale si nécessaire.

1
# Author: Laurent Berger
2
# Contact: laurent.berger@univ-lemans.fr
3
4
"""
5
Organisation du code source pour répondre aux bonnes pratiques
6
"""
7
8
def ma_fonction(para1, para2, para3):
9
    """
10
    fonction calculant la somme du premier et deuxième paramètres,
11
    du premier et troisième paramètre,
12
    du deuxième et troisième,
13
    des trois paramètres
14
    Argument:
15
    para1 -- nombre
16
    para2 -- nombre
17
    para3 -- nombre
18
    """
19
    return para1 + para2, para1 + para3, para2 + para3, para1 + para2 + para3
20
if __name__ == '__main__':
21
    print(ma_fonction(1, 2, 3))
22
    print(ma_fonction(1, para3=3, para2=2))
23
ComplémentPylint
L'utilitaire pylint permet de vérifier la syntaxe et les conventions d'usage.
Une fois pylint localisé sur votre ordinateur, dans une fenêtre de commande vous pouvez appeler pylint avec en argument le nom de votre programme.
1
def ma_fonction(para1,para2, para3):
2
    return para1+para2, para1 + para3, para2 + para3, para1 + para2 + para3
3
    
4
print(ma_fonction(1,2, 3))
5
6
print(ma_fonction(1, para3=3, para2=2))
7
Avec le code précédant, les conventions ne sont pas respectées et donc la note est mauvaise. Il faut corriger les erreurs et relancer pylint.