Déclaration et commentaire en Python

Cette section traite des déclarations, de l’indentation et des commentaires Python. La dernière session présente également Docstring comme un type spécial de commentaire Python.

Déclaration Python

Une déclaration Python est une instruction donnée à l’interpréteur pour qu’il l’exécute. Une déclaration peut contenir une expression telle que la suivante

resultat = x + y

Une instruction Python peut être considérée comme une instruction à l’interpréteur pour résoudre l’expression et stocker son résultat dans une variable. Les instructions telles que for , while et print ont une signification particulière ; ces instructions seront abordées dans une section ultérieure.

Instructions multi-lignes en Python

Lorsque vous appuyez sur la touche Entrée après une instruction, cette instruction particulière est terminée et constitue une instruction d’une ligne. Il est possible de créer une instruction multiligne en Python en utilisant le caractère de continuation de ligne \ qui permet d’étendre l’instruction Python à plusieurs lignes.

Considérez le code ci-dessous :

x = 1 + 2 + 3 \
    + 4 + 5 \
    + 6

C’est ce qu’on appelle la continuation explicite de la ligne.

Vous pouvez également effectuer une continuation de ligne implicite en utilisant des parenthèses () , des crochets [] ou des accolades {} .

Par exemple, vous pouvez écrire par-dessus l’instruction multi-lignes en utilisant des parenthèses, par exemple :

x = (1 + 2 + 3 
    + 4 + 5
    + 6)

Indentation Python

Le bloc d’instructions, par exemple le corps d’une fonction, d’une boucle ou d’une classe, commence par une indentation. L’indentation doit être la même pour chaque déclaration du bloc. Vous obtiendrez un IndentationError si l’indentation n’est pas correcte.

Habituellement, 4 espaces pour l’indentation, comme recommandé dans le Style Guide for Python Code. Prenons l’exemple ci-dessous :

x = {1, 2, 3, 4}
for i in x:
    print(i)

L’indentation est essentiellement utilisée pour créer des programmes plus lisibles.

Dans l’exemple ci-dessous, le même code est écrit de deux manières différentes :

x = {1, 2, 3, 4}
for i in x :
    print(i)

for i in x : print(i)

Vous pouvez voir ici que le premier exemple est plus lisible que le second.

Commentaires sur Python

Les commentaires sont utilisés pour décrire l’objectif ou le fonctionnement d’un programme. Les commentaires sont les lignes que Python ignore lors de l’interprétation et qui ne perturbent pas le flux d’un programme.

Si vous écrivez du code comportant des centaines de lignes, vous devez ajouter des commentaires car l’autre utilisateur n’a pas le temps de lire chaque ligne pour comprendre le fonctionnement du code. De cette façon, les commentaires augmentent la lisibilité et expliquent également le fonctionnement du code.

Un commentaire Python commence par le symbole dièse # .

# Commentaire sur une seule ligne
# Programme pour imprimer une chaîne de caractères
print("J'affiche des choses en Python")

Commentaires sur plusieurs lignes de Python

L’utilisation du symbole dièse dans chaque ligne permet de définir un commentaire de plusieurs lignes. Mais il existe un autre moyen d’ajouter un commentaire de plusieurs lignes en Python, qui consiste à utiliser des guillemets triples. Vous pouvez utiliser soit ‘ ‘ soit ‘ ‘.

'''commentaires sur
 plusieurs lignes en
Langage de programmation Python'''

Les guillemets triples sont en fait utilisés pour définir la chaîne de documentation multi-lignes, mais vous pouvez également les utiliser comme commentaires multi-lignes.

Docstring en Python
Docstring est la chaîne de documentation qui constitue la première déclaration dans une fonction, une classe, un module Python, etc. La description et les commentaires des fonctions, méthodes et classes se trouvent dans une docstring.

Prenons l’exemple suivant :

def addition(a:int, b:int):
    '''Cette fonction ajoute deux nombres'''
    return a+b

Vous pouvez voir ici que la docstring vous indique ce que fait la fonction.