Introduction à Python

From FreeCAD Documentation
Revision as of 16:05, 24 May 2020 by Donatello (talk | contribs)
Macros
Python scripting tutorial

Introduction

Ceci est un petit tutoriel créé pour ceux qui veulent débuter en programmation Python. Python est un langage de programmation open-source et multiplate-forme. Il a de nombreuses fonctionnalités qui le différencie des autres langages de programmation et est facilement accessible aux nouveaux utilisateurs.

  • Il a été conçu pour être lisible par les êtres humains, le faisant relativement facile à apprendre et comprendre.
  • Il est interprété, ce qui signifie que les programmes n'ont pas besoin d'être compilés avant qu'ils puissent être exécutés. Le code Python peut être exécuté immédiatement même ligne par ligne si vous le désirez.
  • Il peut être intégré dans d'autres programmes comme un langage de script. FreeCAD possède un interpréteur Python intégré. Vous pouvez écrire du code Python pour manipuler des éléments de FreeCAD. Cela est très puissant et signifie que vous pouvez construire vos propres outils.
  • Il est extensible, vous pouvez simplement installer de nouveaux modules dans votre programme Python et étendre ses fonctionnalités. Par exemple, il y a des modules qui permettent à Python de lire et d'écrire des images, pour communiquer avec Twitter, pour planifier des tâches exécutées par votre système d'exploitation, etc...

Ce qui suit est une introduction très basique et en aucun cas un tutoriel complet. Mais espérons le, il fournira un bon point de départ pour une exploration plus approfondie dans FreeCAD et ses mécanismes. Nous vous encourageons fortement à saisir les extraits de code ci-dessous dans un interpréteur Python.

L’interpréteur

Habituellement, lors de l'écriture d'un programme informatique, vous ouvrez un éditeur de texte ou votre environnement de programmation préféré (qui est essentiellement un éditeur de texte avec quelques outils supplémentaires), vous écrivez votre programme, puis vous le compilez et l'exécutez. Souvent une ou plusieurs erreurs ont été commises lors de la saisie, votre programme ne fonctionnera donc pas. Vous pouvez même recevoir un message d'erreur vous indiquant ce qui n'a pas fonctionné. Ensuite, vous revenez à votre éditeur de texte, corrigez les erreurs, exécutez à nouveau, et ainsi de suite jusqu'à ce que votre programme fonctionne comme prévu.

En Python, tout ce processus peut être effectué de manière transparente dans l'interpréteur Python. L’interpréteur est une fenêtre Python avec une invite de commande, où vous pouvez simplement taper du code Python. Si vous avez installé Python sur votre ordinateur (téléchargez-le depuis le site Web Python si vous êtes sous Windows ou Mac, installez le à partir des gestionnaires de paquets, si vous êtes sous GNU/Linux), vous aurez un interpréteur Python dans votre menu de démarrage. Mais comme déjà mentionné, FreeCAD dispose également d'un interpréteur Python intégré: la console Python.

La console Python FreeCAD

Si vous ne la voyez pas, cliquez sur le menu Affichage --> Panneaux --> Console Python. La console Python peut être redimensionnée et également non "dockée".

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

print("hello")

print() est une commande Python qui affiche manifestement quelque chose à l'écran. Lorsque vous appuyez sur Entrée, l'opération est exécutée et le message "hello" apparaît. Si vous faites une erreur, par exemple, écrivez:

print(hello)

Python vous le dira immédiatement. Dans ce cas Python ne sait pas ce qu'est hello. Les caractères " " spécifient que le contenu est une chaîne de caractères, un jargon de programmation pour un morceau de texte. Sans cela la commande print() ne reconnaît pas hello. En appuyant sur la flèche vers le haut, vous pouvez revenir à la dernière ligne de code et la corriger.

L'interpréteur Python dispose également d'un système d'aide intégré. Disons que nous ne comprenons pas ce qui s'est mal passé avec print(hello) et que nous voulons des informations spécifiques sur la commande:

help("print")

Vous obtiendrez une description longue et complète de tout ce que la commande print() peut faire.

Maintenant que vous comprenez l'interpréteur Python, nous pouvons continuer avec des choses plus sérieuses.

En haut

Les Variables

Très souvent dans la programmation vous avez besoin de stocker une valeur sous un nom. C'est là que les variables entrent en jeu. Par exemple, tapez ceci:

a = "hello"
print(a)

Vous comprenez probablement ce qui s'est passé ici, nous avons enregistré la chaîne de caractères "hello" sous le nom a. Maintenant que a est connu, nous pouvons l'utiliser n'importe où, par exemple dans la commande print(). Nous pouvons utiliser n'importe quel nom souhaité, nous avons juste besoin de suivre quelques règles simples, telles que ne pas utiliser d'espaces ou de ponctuation et ne pas utiliser de mots-clés Python. Par exemple, nous pouvons écrire:

hello = "my own version of hello"
print(hello)

Maintenant hello n'est plus un indéfini. Les variables peuvent être modifiées à tout moment, c'est pourquoi elles sont appelées variables, leur contenu peut varier. Par exemple:

myVariable = "hello"
print(myVariable)
myVariable = "good bye"
print(myVariable)

Nous avons changé la valeur de myVariable. Nous pouvons également copier des variables:

var1 = "hello"
var2 = var1
print(var2)

Il est conseillé de donner des noms significatifs à vos variables. Après un certain temps, vous ne vous souviendrez plus de ce que représente votre variable nommée a. Mais si vous l'avez nommé, par exemple, myWelcomeMessage vous vous souviendrez facilement de son objectif. De plus, votre code est un pas supplémentaire vers l'auto-documentation.

La casse est très importante, myVariable n'est pas la même chose que myvariable. Si vous deviez entrer print (myvariable), il produirait une erreur "not defined" (non défini).

En haut

Les Nombres

Bien sûr les programmes Python peuvent traiter toutes sortes de données, pas seulement les chaînes de caractères. Une chose est importante, Python doit savoir de quel type de données il s'agit. Nous avons vu dans notre exemple print hello que la commande print () a reconnu notre chaîne de caractères "hello". En utilisant les caractères " ", nous avons spécifié que ce qui suit est une chaîne de caractères.

Nous pouvons toujours vérifier le type de données d'une variable avec la commande type():

myVar = "hello"
type(myVar)

Il nous dira que le contenu de myVar est un 'str', qui est l'abréviation de string. Nous avons également d'autres types de données de base, tels que les nombres entiers et flottants:

firstNumber = 10
secondNumber = 20
print(firstNumber + secondNumber)
type(firstNumber)

Python sait que 10 et 20 sont des nombres entiers, ils sont donc stockés en tant que 'int' et Python peut faire avec eux tout ce qu'il peut faire avec des entiers. Voyez les résultats suivants:

firstNumber = "10"
secondNumber = "20"
print(firstNumber + secondNumber)

Ici nous avons forcé Python à considérer que nos deux variables ne sont pas des nombres mais des morceaux de texte. Python peut ajouter deux morceaux de texte ensemble, bien que dans ce cas, bien sûr, ça ne fonctionnera pas en arithmétique. Mais nous parlions des nombres entiers. Il existe également des nombres à virgule flottante. La différence est que les nombres à virgule flottante peuvent avoir une partie décimale et les nombres entiers n'en ont pas:

var1 = 13
var2 = 15.65
print("var1 is of type ", type(var1))
print("var2 is of type ", type(var2))

Les entiers et les nombres à virgule flottante peuvent être mélangés sans problème:

total = var1 + var2
print(total)
print(type(total))

Parce que var2 est un flottant, Python décide automatiquement que le résultat doit également être un flottant. Mais il y a des cas où Python ne sait pas quel type utiliser. Par exemple:

varA = "hello 123"
varB = 456
print(varA + varB)

Il en résulte une erreur, varA est une chaîne de caractères et varB est un entier, et Python ne sait pas quoi faire. Cependant, nous pouvons forcer Python à convertir entre les types:

varA = "hello"
varB = 123
print(varA + str(varB))

Maintenant que les deux variables sont des chaînes de caractères, l'opération fonctionne. Notez que nous avons "stratifié" varB au moment de l'affichage, mais nous n'avons pas changé varB elle-même. Si nous voulions transformer varB de façon permanente en une chaîne de caractères, nous aurions besoin de faire ceci:

varB = str(varB)

Nous pouvons également utiliser int() et float() pour convertir en entier et en flottant si nous voulons:

varA = "123"
print(int(varA))
print(float(varA))

Vous devez avoir remarqué que nous avons utilisé la commande print() de plusieurs manières. Nous avons affiché des variables, des sommes, plusieurs choses séparées par des virgules et même le résultat d'une autre commande Python. Vous avez peut-être aussi vu que ces deux commandes:

type(varA)
print(type(varA))

ont le même résultat. C'est parce que nous sommes dans l'interpréteur et tout est automatiquement affiché. Lorsque nous écrivons des programmes plus complexes qui s'exécutent en dehors de l'interpréteur, ils ne s'affichent pas automatiquement, nous devons donc utiliser la commande print(). Dans cet esprit arrêtons de l'utiliser ici. Désormais, nous écrirons simplement:

myVar = "hello friends"
myVar

En haut

Les Listes (Tableaux)

Un autre type de données utile est le type list. Une liste est une collection d'autres données. Pour définir une liste nous utilisons [ ]:

myList = [1, 2, 3]
type(myList)
myOtherList = ["Bart", "Frank", "Bob"]
myMixedList = ["hello", 345, 34.567]

Comme vous pouvez le voir, une liste peut contenir tout type de données. Vous pouvez faire beaucoup de choses avec une liste. Par exemple, comptez ses articles:

len(myOtherList)

Ou récupérez un élément:

myName = myOtherList[0]
myFriendsName = myOtherList[1]

Alors que la commande len() renvoie le nombre total d'éléments dans une liste, le premier élément d'une liste est toujours à la position 0, donc dans notre myOtherList "Bob" sera en position 2. Nous pouvons faire beaucoup plus avec des listes tel que le tri, la suppression ou l'ajout d'éléments.

Fait intéressant, une chaîne de caractères est très similaire à une liste de caractères en Python. Essayez de faire ceci:

myvar = "hello"
len(myvar)
myvar[2]

Habituellement ce que vous pouvez faire avec des 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.

Outre les chaînes de caractères, les entiers, les flottants et les listes, il existe davantage de types de données intégrés, tels que les dictionnaires et vous pouvez même créer vos propres types de données avec des classes.

En haut

L'indentation

Une utilisation importante des listes est la possibilité de « les parcourir » et de faire quelque chose avec chaque élément. Par exemple, regardez ceci:

alldaltons = ["Joe", "William", "Jack", "Averell"]
for dalton in alldaltons:
    print(dalton + " Dalton")

Nous avons itéré (jargon de programmation) à travers notre liste avec la commande for in et avons fait quelque chose avec chacun des éléments. Notez la syntaxe spéciale: la commande for se termine par : indiquant que ce qui suit sera un bloc d'une ou plusieurs commandes. Dans l'interpréteur, immédiatement après avoir entré la ligne de commande se terminant par :, l'invite de commande passera à ..., ce qui signifie que Python sait qu'il y a plus à venir.

Comment Python saura-t-il combien de lignes suivantes devront être exécutées à l'intérieur de l'opération for in ? Pour cela, Python s'appuie sur l'indentation. Les lignes suivantes doivent commencer par un espace vide, ou plusieurs espaces vides, ou une tabulation, ou plusieures tabulations. Et tant que l'indentation reste la même, les lignes seront considérées comme faisant partie du bloc for in. Si vous commencez une ligne avec 2 espaces et la suivante avec 4, il y aura une erreur. Lorsque vous avez terminé, écrivez simplement une autre ligne sans retrait, ou appuyez sur Entrée pour revenir du bloc for in

L'indentation facilite également la lisibilité du programme. Si vous utilisez de grandes indentations (par exemple des tabulations au lieu d'espaces) lorsque vous écrivez un gros programme, vous aurez une vue claire de ce qui est exécuté en son sein. Nous verrons que d'autres commandes utilisent également des blocs de code indentés.

La commande for in peut être utilisée pour de nombreuses choses qui doivent être effectuées plusieurs fois. Elle peut par exemple être combinée avec la commande range():

serie = range(1,11)
total = 0
print("sum")
for number in serie:
    print(number)
    total = total + number
print("----")
print(total)

Si vous avez exécuté les exemples de code dans un interpréteur par copier-coller, vous trouverez que le bloc de texte précédent générera une erreur. À la place copiez à la fin du bloc en retrait, c'est-à-dire à la fin de la ligne total = total + number, puis collez-la dans l'interpréteur. Dans l'interpréteur appuyez sur Entrée jusqu'à ce que l'invite à trois points disparaisse et que le code s'exécute. Copiez ensuite les deux dernières lignes suivies d'une autre Enter. La réponse finale devrait apparaître.

Si vous tapez dans l'interpréteur help(range), vous verrez:

range(...)
    range(stop) -> list of integers
    range(start, stop[, step]) -> list of integers

Here the square brackets denote an optional parameter. However all are expected to be integers. Below we will force the step parameter to be an integer using int():

number = 1000
for i in range(0, 180 * number, int(0.5 * number)):
    print(float(i) / number)

Ou des choses plus complexes comme ceci:

alldaltons = ["Joe", "William", "Jack", "Averell"]
for n in range(4):
    print(alldaltons[n], " is Dalton number ", n)

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:

alldaltons = ["Joe", "William", "Jack", "Averell"]
total = len(alldaltons)
for n in range(total):
    print(alldaltons[n])

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.

alldaltons = ["Joe", "William", "Jack", "Averell"]
if "Joe" in alldaltons:
    print("We found that Dalton!!!")

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

if "Lucky" in alldaltons:

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):

alldaltons = ["Joe", "William", "Jack", "Averell"]
if "Lucky" in alldaltons:
    print("We found that Dalton!!!")
else:
    print("Such Dalton doesn't exist!")

top

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:

def printsqm(myValue):
    print(str(myValue) + " square meters")

printsqm(45)

Extrêmement simple: la commande def() définit une nouvelle fonction. Vous lui donnez un nom, et à l'intérieur de la parenthèse vous définissez les arguments que nous utiliserons dans notre fonction. Les arguments sont des données qui seront transmises à la fonction. Par exemple, regardez la commande len(). Si vous écrivez simplement len(), Python vous dira qu'il a besoin d'un argument. C'est-à-dire que tu veux len() de quelque chose, non ? Ensuite, par exemple, vous écrirez len(myList) et vous aurez la longueur de myList. Eh bien, myList est un argument que vous transmettez à la fonction len(). La fonction len() est définie de manière à savoir quoi faire avec ce qui lui est transmis. Comme nous l'avons fait ici.

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:

printsqm(45,34)

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:

def sum(val1, val2):
    total = val1 + val2
    return total

myTotal = sum(45, 34)

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:

top

Les Modules

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

Jusqu'à présent, nous avons écrit des instructions ligne par ligne pour travailler dans l'interpréteur Python, pas vrai? Lorsque vous voulez faire des choses plus complexes, il est commode d'écrire les premières lignes de code, puis de les exécuter en une seule fois. Eh bien, c'est très facile à faire, et cela permet aussi de sauver son travail. Il suffit d'ouvrir un éditeur de texte (par exemple, Le Bloc-notes Windows), et d'écrire toutes les lignes de code de Python, de la même manière qu'elles sont écrites dans l'interpréteur, avec les indentations, etc. Ensuite, enregistrez le fichier sur votre disque, de préférence avec l'extension .Py.

Voilà, maintenant vous avez un programme Python complet. Bien sûr, il y a de meilleurs éditeurs que le bloc-notes de Windows ou le terminal d'OS X comme l'excellent Notepad++ (pour Windows) qui utilise la coloration syntaxique tout comme XCode (pour OS X) et ceci démontre qu'un programme Python n'est qu'un fichier texte.

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. (Sous Linux, vous avez probablement un répertoire /home/<username>/.FreeCAD/Mod, ajoutons un sous-répertoire à ce qu'on appelle les scripts où nous placerons le fichier texte.)

Supposons que nous écrivions ce fichier programme:

def sum(a,b):
    return a + b

print("myTest.py succesfully loaded")

et, nous allons l'enregistrer en "test.py" dans . . ./FreeCAD/bin. (ou avec Linux dans /home/<username>/.FreeCAD/Mod/scripts.) Maintenant, allons dans FreeCAD, et dans la fenêtre de l'interpréteur, écrivez:

import myTest

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.

Normalement, lorsque nous écrivons une fonction sum() dans l'interpréteur, nous l'exécutons simplement comme ceci,

sum(14,45)

comme nous l'avons fait plus haut.

Mais quand nous importons un module contenant une fonction comme sum(a,b), la syntaxe est un peu différente. Nous ferons:

myTest.sum(14,45)

Autrement dit, le module est importé comme un «conteneur», et toutes ses fonctions sont à l'intérieur. Cela est extrêmement utile, parce que nous pouvons importer un grand nombre de modules, et de les organiser.
Donc, en bref, quand vous voyez quelque_chose.quelque_chose (avec un point entre les deux), signifie que quelque chose est à l'intérieur quelque chose.

Nous pouvons aussi, importer et extraire notre fonction sum() contenue dans "test.py" directement dans l’interpréteur, comme ceci:

from myTest import *
sum(12,54)

Théoriquement, tous les modules se comportent de cette manière. Vous importez un module, et vous utilisez ses fonctions de cette manière: module.fonction(argument(s)).
Les modules travaillent de cette façon: ils définissent les fonctions, les nouveaux types de données et les classes que vous pouvez utiliser dans l'interpréteur Python ou dans vos propres modules, parce que rien ne vous empêche d'importer d'autres modules à l'intérieur de votre module!

Encore une chose extrêmement utile. Comment connaître les modules disponibles ? quelles sont les fonctions contenues dans ces modules et comment les utiliser (c'est à dire quels arguments sont demandés par la fonction)? Nous avons vu que Python a une fonction d'aide().

Alors, dans l'interpréteur Python de FreeCad faisons:

help("modules")

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

import math
dir(math)

Nous voyons maintenant toutes les fonctions contenues dans le module math, ainsi que des trucs étranges comme: __ doc__, __ FILE__, __ name__ . . . .
Le __ doc__ est extrêmement utile, il s'agit d'un texte de documentation. Dans les modules, chaque fonction de fait a une __ doc__ qui explique comment l'utiliser. Par exemple, nous voyons qu'il ya une fonction sin dans le module math.
Vous voulez savoir comment utiliser cette fonction ? alors:

print(math.sin.__doc__)

(Cela peut ne pas être évident, mais de chaque côté de doc sont deux caractères de soulignement.)

Et enfin, une dernier chose: Lorsque l'on travaille sur un nouveau module, nous avons besoin de le tester.

La meilleure chose a faire remplacez l'extension de la macro FreeCAD comme suit : myModule.fcmacromyModule.py.

import importlib
importlib.reload(myTest)

Cependant, il y a deux méthodes que vous pouvez utiliser: A l'intérieur d'une macro utilisez les fonctions Python exec ou execfile.

exec(open("C:/PathToMyMacro/myMacro.FCMacro").read())

top

Démarrer avec FreeCAD

Eh bien, je pense que maintenant vous devez avoir une bonne idée de la façon dont Python travaille, et vous pouvez commencer à explorer ce que FreeCAD peut nous offrir. Les fonctions Python de FreeCAD sont toutes bien organisées en différents modules. Certaines d'entre elles sont déjà chargées (importées) au démarrage de FreeCAD. Donc, il suffit de faire:

dir()

top

Notes

  • FreeCAD was originally designed to work with Python 2. Since Python 2 reached the end of its life in 2020, future development of FreeCAD will be done exclusively with Python 3, and backwards compatibility will not be supported.
  • Much more information about Python can be found in the official Python tutorial and the official Python reference.

top