Introduction au langage Python

From FreeCAD Documentation
Jump to: navigation, search
This page is a translated version of the page Introduction to Python and the translation is 100% complete.

Other languages:
čeština • ‎Deutsch • ‎English • ‎español • ‎français • ‎Bahasa Indonesia • ‎italiano • ‎日本語 • ‎polski • ‎português • ‎português do Brasil • ‎română • ‎русский • ‎svenska • ‎Türkçe
(novembre 2018) FreeCAD a été conçu à l'origine pour fonctionner avec Python 2. De nombreuses fonctionnalités fonctionnent avec Python 3 mais d'autres pas. Rendre FreeCAD totalement compatible avec Python 3 est un travail en cours. Les informations décrites ici décrivent Python 2 mais la majorité du code devrait fonctionner de la même manière que Python 3. En particulier, la fonction print() est préférée à l’ancienne instruction print.


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.

  • Il a été conçu spécialement pour être facile à lire par les êtres humains, il est ainsi facile à apprendre et à comprendre
  • Il est interprété. C'est-à-dire que contrairement aux langages compilés comme le C, votre programme n'a pas besoin d'être compilé pour être exécuté. Le code que vous écrivez peut être directement exécuté, une ligne après l'autre si vous le souhaitez. Cela permet de l'apprendre et de trouver les erreurs dans votre code facilement, parce que vous avancez lentement, une étape après l'autre.
  • Il peut être intégré dans d'autres programmes comme langage de script. FreeCAD possède un interpréteur Python intégré, vous pouvez ainsi y écrire du code Python. Cela permet de manipuler des éléments de FreeCAD, par exemple de créer des objets géométriques. Il s'agit d'une fonction extrêmement puissante, parce qu'au lieu de se contenter de cliquer sur un bouton appelé "Créer une sphère", qu'un programmeur aurait placé là pour vous, vous avez la possibilité de créer simplement vos propres outils pour générer exactement les objets géométriques que vous souhaitez.
  • Il est extensible; vous pouvez simplement installer de nouveaux modules Python et étendre ses fonctionnalités. Par exemple, il existe un module qui permet à Python de lire et d'écrire des images jpg, de communiquer avec twitter, de planifier des tâches exécutées pour votre système d'exploitation, etc...

Nous vous encourageons vivement à entrer les extraits de code ci-dessous dans un interpréteur Python. Pour beaucoup de nos exemples, le point important est la ligne après l'exécution du code, le résultat. 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.

Screenshot pythoninterpreter.jpg

(SI vous ne l'avez pas, cliquez sur le menu Affichage --> Panneaux --> Console Python).

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 ENTREE, 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:

print "hello"

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

print hello

Python vous dira qu'il ne sait pas ce qu'est hello. 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 hello 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 flèche Haut (ou, dans l'interpréteur FreeCAD, CTRL + flèche Haut), 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é. Essayez :

help

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

help("print")

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

Maintenant que 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 hello 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:

a = "hello"
print a

Je suppose que vous avez compris ce qui s'est passé ? Nous avons «sauvé» en mémoire la chaîne "hello" 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, par exemple, ne pas utiliser d'espaces ou de signes de ponctuation. Par exemple, nous pouvons écrire:

hello = "my own version of hello"
print hello

Avez vous 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":

print = "hello"

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:

myVariable = "hello"
print myVariable
myVariable = "good bye"
print myVariable

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

var1 = "hello"
var2 = var1
print var2

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

La casse est très importante. Par exemple maVariable n'est pas identique à mavariable, la différence se situe dans la lettre majuscule/minuscule "v". Si vous saisissiez "print mavariable", vous aurez en retour une erreur de type : NameError: name is not defined.

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

myVar = "hello"
type(myVar)

Dans cet exemple, il s'affiche dans la console Python <type 'str'> 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) . . .:

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

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:

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

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:

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

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

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

Naturellement, la somme comporte des décimales, n'est-ce pas ? 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:

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

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:

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

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:

varB = str(varB)

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:

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

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,

type(varA)
print type(varA)

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:

myVar = "hello friends"
myVar

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

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

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

len(myOtherList)

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

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

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 vous pouvez les lire ici .

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

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

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:

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

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é ENTREE derrière le " : ", l'invite de commande va changer en " ... " ce qui indique à Python que la suite sera une partie de celui-ci.

Alors comment savoir, combien de ligne(s) sera ou seront exécutées par Python à l'intérieur de la boucle ? Pour créer un bloc, Python utilise l'indentation. Les prochaines lignes ne commenceront pas au prompt " >>> " mais elles commenceront par un ou plusieurs espaces vides, ou, une ou plusieurs tabulations. Les langages de programmation utilisent leurs propres méthodes , comme, la mise entre parenthèses du bloc, entre un BEGIN ... END etc.

Tant que vous écrirez vos lignes avec la même indentation, elles seront considérées comme faisant partie du bloc. Si vous commencez une ligne avec 2 espaces et la prochaine avec 4 espaces, il y aura une erreur. Lorsque vous avez terminé votre bloc, il suffit d'écrire la suite du programme sans indentation, ou appuyez simplement sur ​​Entrée.

L'indentation permet aussi d'éclaircir la lisibilité du programme. Si vous utilisez de grandes indentations (par exemple, utilisez des tabulations plutôt que des espaces car elles sont plus grandes), lorsque vous écrivez un gros programme, vous aurez une vue claire de ce qui est exécuté à l'intérieur de quoi. Nous verrons que les commandes autres que for-in peuvent aussi avoir des blocs de code en retrait.

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

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 en copier/coller, vous constaterez que le bloc de texte précédent génère une erreur. Au lieu de cela, copiez à la fin du bloc en retrait, c'est-à-dire la fin de la ligne " = total + nombre " puis collez-le dans l'interpréteur. Dans l'interpréteur, frappez sur la touche Enter jusqu'à ce que l'invite à trois points disparaisse et que le code s'exécute. Copiez ensuite les deux dernières lignes dans l'interpréteur suivi d'une ou plusieurs frappes sur la touche Enter la réponse finale devrait apparaître.)

Si vous tapez dans l'interprèteur help(range) vous allez voir:

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

Ici, les crochets indiquent un paramètre facultatif. Cependant, tous sont censés être des entiers. Ci-dessous, nous forcerons les paramètres de la plage à être un entier en utilisant int()

decimales = 1000                     # for 3 decimales 
#decimales = 10000                   # for 4 decimales ...
for i in range(int(0 * decimales),int(180 * decimales),int(0.5 * decimales)):
    print float(i) / decimales

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!"

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)

(Une autre erreur de copier-coller, copiez uniquement à la fin de la section en retrait, c'est à dire "square meters" Collez le dans l'interpréteur, et appuyez sur la touche Entrée jusqu'à ce que vous voyez l'invite de la ligne finale.)

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

sum(45,34)
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:

sum(45,34)

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:

print sum(45,34)

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.

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 myModule
myModule.myTestFunction()

Mais que faire, si myTestFunction() ne fonctionne pas correctement? Nous retournons à notre éditeur et nous le corrigeons. Puis, au lieu de fermer et de rouvrir l'interpréteur python, nous allons tout simplement mettre à jour le module comme ceci:

reload(myModule)

Le problème est que Python ne connaît pas l'extension native de FreeCAD : FCMacro

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.

f = open("myModule","r")
d = f.read()
exec d

ou

execfile "myModule"

Pour Python 3.xxx remplacer ce code par:

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

Pour partager le code entre les macros, vous pouvez par exemple accéder au modules FreeCAD ou FreeCADGui (ou tout autre module Python) et leur définir un attribut. Ceci doit survivre après l'exécution de la macro.

import FreeCAD
if hasattr(FreeCAD,"macro2_executed"):
    ...
else:
    FreeCAD.macro2_executed = True # you can assign any value because we only check for the existence of the attribute
    ... execute macro2

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

et lire Scripts de base dans FreeCad...

Bien sûr, nous n'avons vu qu'une très petite partie de l'univers Python. Il existe de nombreux concepts importants que nous n'avons pas mentionné ici.
Voici deux liens de référence de Python sur le net:

Pensez à en faire des onglets !


Arrow-left.svg Page précédente: Macros