Introduction to Python/fr

Ceci est un petit tutoriel créé pour ceux qui veulent débuter en programmation Python, qui est un langage de programmation open-source et multiplate-forme. Python a de nombreuses fonctionnalités qui le différencie des autre langages de programmation, et est facilement accessible à celui qui veut se lancer dans la programmation.


 * It has been designed specially to be easy to read by human beings, and so it is very easy to learn and understand.
 * It is interpreted, that is, unlike compiled languages like C, your program doesn't need to be compiled before it is executed. The code you write can be immediately executed, line by line if you want so. This makes it extremely easy to learn and to find errors in your code, because you go slowly, step-by-step.
 * It can be embedded in other programs to be used as scripting language. FreeCAD has an embedded Python interpreter, so you can write Python code in FreeCAD, that will manipulate parts of FreeCAD, for example to create geometry. This is extremely powerful, because instead of just clicking a button labeled "create sphere", that a programmer has placed there for you, you have the freedom to create easily your own tool to create exactly the geometry you want.
 * It is extensible, you can easily plug new modules in your Python installation and extend its functionality. For example, you have modules that allow Python to read and write jpg images, to communicate with twitter, to schedule tasks to be performed by your operating system, etc.

Et maintenant au travail ! Soyez conscient que ce qui suit est une introduction simplifiée, et en aucun cas un tutoriel complet. Mais nous espérons qu'après cette lecture vous aurez acquis les bases nécessaires pour connaître et exploiter plus profondément les mécanismes de FreeCad.

L’interpréteur
Habituellement, lors de l'écriture d'un programme informatique, il suffit d'ouvrir votre environnement de programmation préféré qui, est dans la plupart des cas, un éditeur de texte avec plusieurs outils autour de lui, écrire votre programme, puis le compiler et l'exécuter. Lorsque vous avez fait des erreurs pendant l'écriture, votre programme ne fonctionnera pas! et vous obtiendrez un message d'erreur vous indiquant ce qu'il s'est passé. Ensuite, vous revenez à votre éditeur de texte, corrigez les erreurs, exécutez à nouveau, et ainsi de suite jusqu'à ce que votre programme fonctionne parfaitement.

En Python, tout ce processus, peut être exécuté de manière transparente dans l'interpréteur Python. L’interpréteur Python est une fenêtre avec une invite de commande, vous pouvez simplement y taper votre code Python. Si vous installez Python sur votre ordinateur (téléchargez le depuis le site web Python si vous êtes sous Windows ou Mac, installez le à partir des gestionnaire de paquets, si vous êtes sous GNU / Linux), vous aurez l'interpréteur Python dans votre menu de démarrage. Mais FreeCAD dispose également d'un interpréteur Python intégré, vous n'êtes donc pas obligé de l'installer, cet interpréteur est visible dans la fenêtre inférieure (Si vous ne voyez pas cette fenêtre, cliquez sur Affichage->Vues->Console Python). Tous ces exemples ont été relu à partir de l'interpréteur disponible dans FreeCad.



(If you don't have it, click on View → Views → Python console.)

L’interpréteur affiche la version de Python installée, puis le symbole >>>, qui est l'invite de commande pour entrer votre code Python. L'écriture du code dans l'interpréteur est très simple: une ligne, est une instruction. Lorsque vous appuyez sur, votre ligne de code est exécuté (après avoir été instantanément compilé et cela de manière transparente pour vous).

Par exemple, écrivez ce code:

Ici print est une commande spéciale de Python qui signifie: affiche ce que je te demande. Lorsque vous pressez, l'opération s’exécute et le message "bonjour" s'affiche à l'écran. Si vous effectuez une erreur, par exemple, écrivez:

Python vous dira qu'il ne sait pas ce qu'est bonjour. Les caractères " (guillemets) spécifient que le contenu est une chaîne de caractères qui doit être affichée. Sans les " (guillemets), la commande d'affichage de bonjour n'est pas reconnue comme du texte, mais comme un mot-réservé spécial de Python. L'important est, que vous obtenez immédiatement une notification d'erreur. En appuyant sur la (ou, dans l'interpréteur FreeCAD, ), vous pouvez revenir à la dernière commande que vous avez écrite et la corriger.

L'interpréteur Python dispose également d'un système d'aide intégré. Voulez vous taper:

ou, par exemple, nous n'avons pas compris ce qui n'allait pas avec notre commande d'affichage "help" ci-dessus, et nous allons demander des informations spécifiques sur la commande "print": tapez

Nous voilà devant une longue description sur la commande "print".

Maintenant, nous dominons totalement notre interpréteur, et nous pouvons commencer à travailler sérieusement.

Les Variables
Bien sûr, vous vous dites que l'affichage de "bonjour" n'est pas très intéressant. Il peut y avoir alors des choses plus intéressantes comme par exemple, l'affichage de choses que vous ne savez pas, et laisser Python trouver ces choses pour vous. C'est là que le concept de "variable" entre en jeu. Une variable est tout simplement une valeur que vous stockez en mémoire avec un nom identificateur. Par exemple, tapez ceci:

Avez vous compris ce qui s'est passé ? Nous avons «sauvé» en mémoire la chaîne "bonjour" dans la variable qui porte le nom de a. Maintenant, a n'est plus un nom inconnu ! Nous pouvons maintenant l'utiliser n'importe où, comme par exemple dans la commande d'affichage à l'écran print. Nous pouvons dans Python utiliser n'importe quel nom que nous voulons, tout en respectant de simples règles, comme, ne pas utiliser d'espaces ou de signes de ponctuation. Par exemple, nous pouvons écrire:

Compris ? maintenant hello n'est plus un mot inconnu. Que faire alors si, par inattention ou par méprise nous choisissons un nom qui existe dans Python? Admettons que nous voulons stocker notre chaîne sous le nom de "print":

Python se rend compte immédiatement de l'erreur et vous signale qu'il est impossible de donner ce nom à votre variable. Il y a quelques restrictions dans Python, les mots "réservés" ne peuvent pas être modifiés! Mais, nos propres variables peuvent être modifiées à tout moment, c'est exactement pour cela qu'elles sont appelées variables, le contenu de la variable peut varier. Par exemple:

Nous venons de changer la valeur de myVariable. Nous pouvons également copier des variables:

Notez qu'il est judicieux de donner des noms descriptifs à vos variables, lorsque vous écrivez un long programme, vous ne saurez plus à quoi sert votre variable "a". Mais, si vous la nommez, par exemple MonMessageDeBienvenue, vous vous souviendrez facilement a quoi vous l'aviez destinée quand vous la verrez.

Plus de renseignements sur les variables Python

Les Nombres
Vous savez qu'un programme informatique est utilisé pour traiter toutes sortes de données, non seulement du texte mais aussi et surtout des nombres. Une des choses les plus importantes dans Python, est que Python doit savoir quel type de données seront traitées. Nous avons vu dans notre exemple d'affichage "bonjour" que la commande d'affichage print a reconnu «bonjour» comme une chaîne. C'est grâce au " " " (guillemets), que la commande d'affichage print sait qu'il va traiter une chaîne de caractères alphabétiques (du texte).

Le type de donnée contenu dans une variable peut être connu à n'importe quel moment grâce à la commande spéciale de Python type:

Dans cet exemple, il s'affiche dans la console Python  dans le langage informatique on dit qu'il est de type "string" (chaîne de caractères alphabétiques). Il y a d'autres types de données, par exemple: les nombres entier (integer), les nombres à virgule flottante (float). . .:

C'est déjà plus intéressant, n'est-ce pas? Maintenant nous avons une puissante calculatrice! Voyons maintenant comment elle fonctionne. Python sait que 10 et 20 sont des nombres entiers. Donc, ils sont stockés en mémoire sous forme "int" (integer), et Python peut travailler avec eux comme il peut le faire avec des nombres entiers. Regardez les résultats de ce code:

Vu ? Nous avons forcé Python à considérer nos deux variables non pas comme de simples nombres, mais comme des parties de texte. Python peut concaténer deux parties de texte, mais il ne cherchera pas à trouver leur somme. Nous avons parlé de nombres entiers, il y a aussi des nombres à virgule flottante. La différence est, que les nombres entiers n'ont pas de partie décimale, alors que les nombres à virgule flottante peuvent avoir une partie décimale:

Les types entier et à virgule flottante, Int et Float peuvent être mélangés sans problème:

Naturellement, la somme comporte des décimales, vrai? Pendant l'opération, Python automatiquement a décidé que le résultat serait un type Float (virgule flottante). Dans certains cas comme celui-ci, Python détermine automatiquement quel type doit être choisi pour un résultat. Dans d'autres cas il déclanchera une erreur. Par exemple:

Dans cet exemple, varA est une chaîne et varB est un int, Python ne mélange pas les types différents et nous donnera une erreur. Mais, nous pouvons forcer Python a mélanger des types différents grâce à la conversion:

Maintenant, l'opération fonctionne, pourquoi ! Vous avez noté, que nous avons converti varB en "string" au moment de l'affichage avec la commande str, mais nous n'avons pas modifié le type de varB qui reste un int. Si nous voulons convertir varB de façon permanente en une chaîne de caractères pour les besoins futur du programme, nous aurons besoin de faire:

Nous pouvons également utiliser les commandes int et float pour convertir une chaîne de caractères str en un int ou float Pour la conversion, il faut faire:

Note au sujet des commandes Python

Vous avez sûrement remarqué que dans cette partie du tutoriel, nous avons utilisé la commande d'affichage print de plusieurs manières. Nous avons affiché des variables, des opérations, des chaînes séparées par des virgules et même le résultat de la commande Python type. Peut-être avez vous également remarqué qu'en faisant ces deux commandes,

nous obtenons le même résultat.

Tout s'affiche automatiquement à l'écran parce que nous sommes dans l'interpréteur. Lorsque nous allons écrire des programmes plus complexes qui s'exécuteront hors de l’interpréteur, ils ne seront pas affichés à l'écran, pour les afficher nous aurons besoin d'utiliser la commande print. Mais maintenant, nous allons cesser de l'utiliser pour augmenter la vitesse d'exécution.

Donc, nous allons simplement écrire:

Attention, Python est sensible à la casse, myVar est différent de myvar !!!

Vous avez remarqué que la plupart des commandes Python (ou mots-réservés) que nous connaissons ont des parenthèses, qui sont utilisées pour dire avec quoi la commande doit travailler: type, int, str. . . etc. La seule exception est la commande print, qui en vérité ne l'est pas car, elle peut fonctionner aussi bien avec ou sans parenthèses.

Exemple: print ("bonjour") print "bonjour"

Les Listes (Tableaux)
Un autre type de données intéressant, est le type list. Le type list est simplement une liste de données. De la même manière que nous définissons une chaîne de texte en utilisant " " (guillemets), nous définirons des listes en utilisant [ ] (crochets):

Vous voyez qu'une liste peut contenir n'importe quel type de données. Les listes sont très utiles car vous pouvez grouper des variables ou des données ensembles. Vous pouvez alors faire toutes sortes de choses au sein de ces groupes, par exemple, les compter avec len:

ou récupérer un objet de cette liste:

Vous voyez que la commande len renvoie le nombre d'éléments dans une liste, la «position» d'un objet dans la liste commence à 0. Le premier élément dans une liste est toujours à la position 0, donc dans notre myOtherList, "Bob" est a la deuxième position. Nous pouvons faire beaucoup plus de choses avec les listes tel que le tri du contenu, la suppression ou l'ajout d'éléments d'autres renseignements sur List.

Une chaîne de texte est très semblable à une liste et chaque caractère peut être adressé séparément! Essayez ce code:

Pratiquement, ce que vous faites avec les listes peut également être fait avec les chaînes de caractères. En fait, les listes et les chaînes de caractères sont des séquences que Python voit en interne de la même manière.

Outre les chaînes de caractères "String", les entiers "Integer", les nombres à virgule flottante "float" et les listes "list", il y a beaucoup de type de données, plus de renseignements sur les dictionnaires. Vous pouvez même créer vos propres types de données avec des classes.

L'Indentation
Une manière pratique et élégante d'afficher chaque élément de la liste, est de naviguer à l’intérieur de cette liste.

Entrez ce code dans la console:

Nous venons de faire une "itération" (encore un nouveau mot de programmeur!) grâce à notre boucle " for ... in ... :  " nous avons scruté chaque "champ" de la variable alldaltons. Notez la syntaxe particulière de la boucle, la commande se termine avec un " : " ce qui indique à Python que la suite sera un bloc d'une ou plusieurs commandes ou instructions.

Après avoir frappé derrière le " : ", l'invite de commande va changer en " ... " ce qui indique à Python que la suite sera une partie de celui-ci.

How will Python know how many of the next lines will be to be executed inside the for...in operation? For that, Python uses indentation. That is, your next lines won't begin immediately. You will begin them with a blank space, or several blank spaces, or a tab, or several tabs. Other programming languages use other methods, like putting everythin inside parenthesis, etc. As long as you write your next lines with the same indentation, they will be considered part of the for-in block. If you begin one line with 2 spaces and the next one with 4, there will be an error. When you finished, just write another line without indentation, or simply press Enter to come back from the for-in block

Créer des indentations permet aussi d'éclaircir la lecture code dans le cas de grands programmes. Nous allons voir que de nombreuses autres commandes indentées peuvent avoir des blocs de code aussi.
 * >>> alldaltons = ["Joe", "William", "Jack", "Averell"]
 * >>> for dalton in alldaltons:
 * ... print dalton + " Dalton"

La commande " for ... in ... :  " peut être utilisée pour de nombreuses procédures qui doivent être effectuées plus d'une fois (en boucle). Elle peut aussi par exemple être combinée avec la commande range:

Ou des choses plus complexes comme ceci:

Vous voyez que la commande range a également la particularité de commencer à 0 (si vous ne spécifiez pas un nombre de départ) et que son dernier nombre sera le nombre que vous aurez spécifié moins un. Bien sûr, cette commande fonctionne parfaitement avec les autres commandes Python.

Par exemple:

Une autre fonction intéressante utilisée dans un bloc indenté est la commande de condition if (si). Avec " if " la suite de la procédure sera exécutée uniquement si la condition est remplie.

C'est bien, ce code affiche "OK il c'est bien un Dalton !!!" car la condition est exacte. Mais maintenant essayons cette ligne:

Il ne c'est rien affiché car la condition n'était pas remplie. Nous pouvons alors lui demander else (si la condition n'est pas remplie alors):

Les Fonctions
Il n'y a pas beaucoup mots réservés dans Python, à peine une trentaine, et nous en connaissons maintenant quelques unes. Imaginons que nous voulions construire nous même une commande spéciale! Et bien, il est extrêmement facile de construire sa propre commande dans Python. Vous pouvez ajouter ces commandes dans votre installation Python de manière à en augmenter les capacités et les utiliser comme bon vous semble. Ces nouvelles commandes que vous allez créer dans Python, s'appellent des Fonctions. Elles sont faites de cette manière:

Extremely simple: the def command defines a new function. You give it a name, and inside the parenthesis you define arguments that we'll use in our function. Arguments are data that will be passed to the function. For example, look at the len command. If you just write len alone, Python will tell you it needs an argument. That is, you want len of something, right? Then, for example, you'll write len(myList) and you'll get the length of myList. Well, myList is an argument that you pass to the len function. The len function is defined in such a way that it knows what to do with what is passed to it. Same as we did here.

Le nom de la variable "myValue" peut être n'importe quel nom, et cette variable ne sera utilisée qu'à l'intérieur de la fonction. C'est juste un nom qui représentera l'argument dans la fonction en vue de l'utiliser, mais elle sert aussi a renseigner la fonction de combien d'arguments elle disposera. Par exemple, faites ceci:

Cette commande affichera l'erreur "TypeError: printsqm takes exactly 1 argument (2 given)" car la fonction "def printsqm(myValue):" ne demande qu'un seul argument, "myValue" et, nous lui en avons donné deux, 45 et 34.

Maintenant, écrivez cette fonction:

Nous avons créé une fonction qui demande deux arguments, les exécutes, et nous renvoie le résultat. Le retour du résultat est très utile car nous pouvons l'utiliser pour l'afficher ou le stocker dans une variable myTotal (pour notre exemple mais n'importe quel nom conviendra) ou les deux. Comme nous sommes dans l'interpréteur de Python, le résultat s'affiche en faisant:

Mais une fois le programme terminé et exécuté hors de l'interpréteur il n'y aura pas d'affichage ! Pour afficher le résultat hors de l'interpréteur Python, il faut bien sûr utiliser la commande print. Alors il faudra faire:

Voilà c'est affiché.

Pour plus de renseignements sur les autres possibilités des fonctions.

Les Modules
Maintenant, vous avez une idée du fonctionnement de Python: mais comment faire pour travailler avec les fichiers et les modules.

Until now, we wrote Python instructions line by line in the interpreter, right? What if we could write several lines together, and have them executed all at once? It would certainly be handier for doing more complex things. And we could save our work too. Well, that too, is extremely easy. Simply open a text editor (such as the windows notepad), and write all your Python lines, the same way as you write them in the interpreter, with indentations, etc. Then, save that file somewhere, preferably with a .py extension. That's it, you have a complete Python program. Of course, there are much better editors than notepad, but it is just to show you that a Python program is nothing else than a text file.

Pour exécuter un programme Python, il ya des centaines de manières. Dans Windows, cliquez simplement sur le fichier, ouvrez-le avec Python, et exécutez le. Mais vous pouvez également l'exécuter avec l'interpréteur Python. Pour ce faire, l’interpréteur doit savoir où se trouve le programme .Py. Dans FreeCAD, le plus simple est de placer les fichiers .Py dans le répertoire par défaut destiné aux programmes Python, cet endroit connu de l'interpréteur inclut dans FreeCAD est C:\Program Files\FreeCAD0.12\bin, mais d'autres endroits sont aussi connu de FreeCad C:\Program Files\FreeCAD0.12\Mod (tous les outils de FreeCad) et 'C:\Travail\Mes documents\. . .\FREECAD\Macro où sont répertoriés tous vos programmes créés dans l’interpréteur de FreeCad Macro-->Macros'. Le chemin de destination de vos modules peut être forcé à partir du menu Édition-->Préférences-->Macro Chemin de la macro.

Supposons que nous écrivions ce fichier programme:

et, nous allons l'enregistrer en "test.py" dans '''. . ./FreeCAD/bin'''.

Maintenant, allons dans FreeCAD, et dans la fenêtre de l'interpréteur, écrivez:

sans l'extension .py.

Le contenu du fichier sera tout simplement exécuté, ligne par ligne, comme si nous l'avions écrit dans l'interpréteur. La fonction somme a été créée, et le message "test.py a bien été chargé" sera affiché. Il ya une grande différence: la commande import est faite non seulement pour exécuter des programmes écrits dans des fichiers comme le nôtre, mais aussi de charger des fonctions dans Python, de sorte qu'elles deviennent disponibles dans l'interpréteur. Les fichiers contenant des fonctions, comme le nôtre, sont appelés modules.

Normally when we write a sum function in the interpreter, we execute it simply like that:

Like we did earlier. When we import a module containing our sum function, the syntax is a bit different. We do:

That is, the module is imported as a "container", and all its functions are inside. This is extremely useful, because we can import a lot of modules, and keep everything well organized. So, basically, everywhere you see something.somethingElse, with a dot in between, that means somethingElse is inside something.

We can also throw out the test part, and import our sum function directly into the main interpreter space, like this:

Basically all modules behave like that. You import a module, then you can use its functions like that: module.function(argument). Almost all modules do that: they define functions, new data types and classes that you can use in the interpreter or in your own Python modules, because nothing prevents you to import modules inside your module!

One last extremely useful thing. How do we know what modules we have, what functions are inside and how to use them (that is, what kind of arguments they need)? We saw already that Python has a help function. Doing:

Will give us a list of all available modules. We can now type q to get out of the interactive help, and import any of them. We can even browse their content with the dir command

We'll see all the functions contained in the math module, as well as strange stuff named __doc__, __file__, __name__. The __doc__ is extremely useful, it is a documentation text. Every function of (well-made) modules has a __doc__ that explains how to use it. For example, we see that there is a sin function in side the math module. Want to know how to use it?

And finally one last little goodie: When we work on programming a new module, we often want to test it. So once we wrote a little piece of module, in a python interpreter, we do something like this, to test our new code:

But what if we see that myTestFunction doesn't work correctly? We go back to our editor and modifiy it. Then, instead of closing and reopening the python interpreter, we can simply update the module like this:

Starting with FreeCAD
Well, I think you must know have a good idea of how Python works, and you can start exploring what FreeCAD has to offer. FreeCAD's Python functions are all well organized in different modules. Some of them are already loaded (imported) when you start FreeCAD. So, just do

and read on to FreeCAD Scripting Basics...

Of course, we saw here only a very small part of the Python world. There are many important concepts that we didn't mention here. There are three very important Python reference documents on the net: Be sure to bookmark them!
 * the official Python tutorial with way more information than this one
 * the official Python reference
 * the Dive into Python wikibook/ book.