Tutoriel Python - Déclaration et commentaire

  1. Déclaration Python
  2. Indentation Python
  3. Commentaires Python

Dans cette section, les déclarations Python, l’indentation et les commentaires seront abordés. La dernière session a également introduit la Docstring comme type spécial de commentaire Python.

Déclaration Python

Une instruction Python est une instruction donnée à l’interpréteur pour qu’il l’exécute. Une instruction peut contenir une expression comme ci-dessous

result = x + y

L’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, print ont une signification particulière; ces instructions seront discutées dans une section ultérieure.

Instructions Python à plusieurs lignes

Lorsque vous appuyez sur la touche Entrée après un relevé, ce relevé particulier est terminé et est un relevé d’une ligne. Une instruction à plusieurs lignes peut être créée en Python en utilisant le caractère de continuation de ligne \ qui étendra l’instruction Python à plusieurs lignes.

Considérez le code ci-dessous:

x = 100 + 101 + 102 \
    + 103 + 104 \
    + 105

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

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

Par exemple, vous pouvez écrire au-dessus d’une instruction de plusieurs lignes en utilisant des parenthèses comme:

x = (100 + 101 + 102 
    + 103 + 104 
    + 105)

Indentation Python

Le bloc d’instructions, par exemple le corps d’une fonction ou d’une boucle ou classe, commence par une indentation. L’indentation doit être la même pour chaque instruction à l’intérieur du bloc. Vous obtiendrez une IndentationError lorsque l’indentation est incorrecte.

Habituellement, 4 espaces pour l’indentation comme conseillé dans Style Guide for Python Code. Considérons 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 façons 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 a une meilleure lisibilité que le second.

Commentaires Python

Les commentaires servent à décrire le but ou le fonctionnement d’un programme. Les commentaires sont les lignes ignorées par Python lors de l’interprétation et ils ne perturbent pas le déroulement d’un programme.

Si vous écrivez un code de plusieurs centaines de lignes, vous devriez ajouter des commentaires car les autres utilisateurs n’ont pas assez de temps pour lire chaque ligne afin de 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 #.

#Single Line comment
#Program to print a string
print("Hello Python Programmer")

Commentaires Python multi-lignes

L’utilisation du symbole de hachage dans chaque ligne permet de définir un commentaire sur plusieurs lignes. Mais il y a une autre façon d’ajouter un commentaire multi-lignes en Python, c’est en utilisant des guillemets triples. Vous pouvez utiliser soit ''' ou """.

"""Multi-line
comments in 
Python Programming language"""

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

Docstring en Python

La Docstring est la chaîne de documentation qui est la première instruction d’une fonction, d’une classe, d’un module Python, etc. La description et les commentaires des fonctions, méthodes et classes sont à l’intérieur d’une docstring (chaîne de documentation).

Considérons l’exemple ci-dessous:

def sum(a, b):
    """This function adds two values"""
    return a+b

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

comments powered by Disqus