Instructions, indentation et commentaires en Python : Guide clair

Instructions, indentation et commentaires en Python

Ce guide explique les instructions Python, l'importance d'une indentation cohérente et comment utiliser efficacement les commentaires et les docstrings.

Instructions Python

Les instructions que l'interpréteur Python exécute sont appelées instructions. Les exemples courants incluent les instructions d'affectation comme a = 1, les instructions de contrôle de flux telles que if, for et while. Ces fondamentaux forment les blocs de construction de tout programme Python.

Instructions multi-lignes

Par défaut, un saut de ligne termine une instruction. Pour diviser une longue instruction sur plusieurs lignes, vous pouvez utiliser le caractère de continuation de ligne, la barre oblique inverse (\) :

a = 1 + 2 + 3 + \
4 + 5 + 6 + \
7 + 8 + 9

De manière plus idiomatique, Python permet la continuation implicite à l'intérieur des parenthèses, crochets ou accolades :

a = (1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9)

De même, les littéraux de liste peuvent s'étendre sur plusieurs lignes :

colors = ['red', 'blue', 'green']

Vous pouvez aussi placer plusieurs instructions simples sur une ligne en utilisant des points-virgules :

a = 1; b = 2; c = 3

---

Indentation en Python

Contrairement aux langages qui s'appuient sur des accolades, Python définit les blocs de code purement par l'indentation. Un bloc commence après un deux-points et se termine à la première ligne qui n'est pas indentée par rapport au début du bloc.

Bien que le langage permette tout niveau d'indentation cohérent, la norme communautaire est de quatre espaces. Les tabulations doivent être évitées pour prévenir la confusion.

for i in range(1, 11):
    print(i)
    if i == 5:
        break

Une indentation correcte n'impose pas seulement la syntaxe, elle rend aussi le code immédiatement lisible et maintenable. Par exemple :

if True:
    print('Hello')
    a = 5

versus la forme moins lisible sur une seule ligne :

if True: print('Hello'); a = 5

Une indentation incorrecte déclenche une IndentationError et arrête l'exécution.

---

Commentaires en Python

Les commentaires sont essentiels pour documenter l'intention et la logique, surtout quand on revisite du code des mois plus tard. En Python, un commentaire commence par un dièse (#) et s'étend jusqu'à la fin de la ligne. L'interpréteur ignore complètement ces lignes.

# Ceci est un commentaire
# Afficher un message
print('Hello')

---

Commentaires multi-lignes

Pour s'étendre sur plusieurs lignes, vous pouvez préfixer chaque ligne avec # :

# Ceci est un long commentaire
# qui continue sur plusieurs
# lignes

Alternativement, les chaînes triplement citées peuvent servir de commentaires de bloc. Quand elles ne sont pas assignées ou utilisées comme docstring, elles sont ignorées par l'interpréteur, n'imposant aucun coût à l'exécution :

"""Ceci est un commentaire multi-lignes
qui s'étend sur plusieurs lignes."""

---

Docstrings en Python

Un docstring est un littéral de chaîne qui suit une définition de fonction, classe ou module. Il documente le but de l'élément et est stocké dans son attribut __doc__. Les guillemets triples sont conventionnellement utilisés :

def double(num):
    """Retourne le double de la valeur d'entrée."""
    return 2 * num

Vous pouvez y accéder programmatiquement :

print(double.__doc__)

Sortie :

Retourne le double de la valeur d'entrée.

Pour des directives plus détaillées, consultez la documentation officielle Python sur les commentaires et les docstrings.