1.4. Conventions

1.4.1. Présentation du code

Les exemples de code seront affichés comme ceci print a en ligne, et sinon comme ceci :

print a

Parfois la code comportera les numéros de ligne ou sera mis en valeur (cadre par exemple).

Le symbole >>> (prompt primaire) indique une invite de commande en mode interactif (voir section Interpréteurs interactifs pour davantage d’explications), et ... (prompt secondaire) lorsqu’une commande s’étend sur plusieurs lignes. Enfin, dans le cas d’une invite de commande, l’affichage attendu est affiché juste en dessous.

>>> a = 1
>>> if a == 1:
...     print(a)
1

Il s’agira donc exactement de ce que le lecteur doit s’attendre à écrire et à voir lorsqu’il utilise Python dans le terminal classique.

Dans le cas d’un code destiné à être placé dans un fichier, le code ne sera pas précédé de l’invite de commande (et la sortie ne sera logiquement pas affichée dans le code).

def function():
    return a
function()

Enfin, lorsque la représentation d’un objet sera affichée, des points de suspension remplaceront son adresse (tout ceci sera vu en détails) : par exemple, au lieu de <function func at 0xb7a9242c>, il sera écrit <function func at ...>, car l’adresse change à chaque exécution.

Parfois il sera nécessaire de se servir du terminal (ou ligne de commandes ou encore shell — les trois termes seront utilisés) pour lancer une commande bash. En ce cas, l’invite de commandes sera représentée par $. La sortie éventuelle sera affichée à la ligne.

$ echo 1
1

Dans le cas d’une simple commande au sein d’un paragraphe, l’invite et le résultat ne seront pas affichés, par exemple echo 1.

De même, les noms de fichiers, modules, noms de classe ou de fonction, ou tout autre élément du langage, seront affiché en police télétype, comme script.py.

Lorsque des variables sont utilisées sans avoir été définies explicitement, il est sous-entendu que l’utilisateur doit le faire lui-même. Par exemple si on écrit

print a + 1

on part du principe que la variable a a été définie auparavant, par exemple comme a = 2. L’utilisateur devra prendre garde à ce que les types ne soient pas incompatibles (dans l’exemple ci-dessus, il est vital que a soit un nombre).

1.4.2. Symboles

J’utiliserai parfois certains symboles afin de simplifier les notations. Ces symboles sont les suivants :

  • | est équivalent à OU, il indique donc une alternative, (a|b signifie que l’on peut écrire a ou b) ;
  • * remplace un ou plusieurs caractères quelconques ;
  • [] indique une option.

Ils ne seront utilisés que lorsque aucune confusion avec un autre élément du langage Python ne sera possible.

1.4.3. Touches

Lorsqu’il sera nécessaire d’appuyer sur une touche, cela se indiqué ainsi : A. Un + entre deux touches indiquent qu’il faut appuyer sur les deux touches en même temps : Ctrl + A.

1.4.4. Informations

Des encadrés peuvent donner des informations complémentaires :

  • Remarque : un ajout à propos d’un sujet évoqué, moins important que le reste du sujet.
  • Mise en garde : une remarque particulièrement importante.

Note

Le titre du cadre changera en fonction du sujet.

Une référence à une PEP (Python Enhancement Proposals) sera faite de manière très similaire à une information.

Voir aussi

PEP 0
Index of Python Enhancement Proposals

1.4.5. Exercices

Les solutions aux exercices sont triées par partie puis par chapitre. Le nom du fichier correspond au numéro de l’exercice. Dans les cas où plusieurs algorithmes sont proposés, une lettre (a, b…) sera ajoutée après le numéro.

1.4.6. Divers

Les traductions en anglais des mots importants seront indiquées entre parenthèses, afin que le lecteur puisse consulter la littérature ou la documentation anglaises sans problèmes.

La version de Python utilisée dans ce livre est la 3.2, mais la majorité du contenu sera valable pour toute version 3.x (où x désigne un numéro quelconque de version).

Les présentations des modules n’incluent pas la description de toutes leurs fonctionnalités : l’objectif est de les présenter et de donner une idée de quel module utiliser en fonction du contexte. Pour une utilisation plus poussée, il faudra se reporter à la documentation.

Les exemples fournis seront uniquement écrits en anglais, pour la simple et bonne raison que la quasi totalité des projets sont en anglais, et qu’il s’agit d’une habitude à prendre (de plus, il faut s’abstraire de la langue utilisée et concentrer nos efforts sur la logique). L’autre raison sera détaillée dans le cœur du livre et concerne le fait qu’il est impossible d’utiliser des caractères UTF-8 (lettres accentuées, par exemple) et que cela nuit à la lecture du code.

De plus, je n’offrirai pas de comparaisons détaillées de Python par rapport aux autres langages.

Table des matières

Sujet précédent

1.3. Plan de l’ouvrage

Sujet suivant

2. Introduction

Cette page