How to install macros/fr: Difference between revisions

From FreeCAD Documentation
m (Created page with "Comment installer une Macro")
 
No edit summary
 
(403 intermediate revisions by 6 users not shown)
Line 1: Line 1:
<languages/>
{{VeryImportantMessage|'''This tutorial has been translated with [https://translate.google.com/ Google translate] a rereading correction will be appreciated, thank you after confirmation to remove this banner'''}}

{{TutorialInfo|Class=Programming|Level=Medium programmer|Time=15 minutes|FCVersion=All|Author=[[User:Mario52|Mario52]]|FCVersion=All}}
{{TutorialInfo/fr
|Topic=Programmation
|Level=Programmeur moyen
|Time=15 minutes
|FCVersion=Toutes versions
|Author=[[User:Mario52|Mario52]]
}}


==Description==
==Description==
This short tutorial will guide you on how to use macros available and incorporate them into the FreeCAD editor.


Depuis la v0.17, il est facile d'ajouter des macros en utilisant le [[Std_AddonMgr/fr|Gestionnaire des extensions]]. Un utilisateur régulier n'a pas besoin de faire plus que d'utiliser cet outil. Continuez à lire pour plus d'informations sur l'installation de [[Macros/fr|macros]].
This tutorial was made on the Windows platform a small adjustment path may be necessary for other systems.


Les macros sont des séquences de commandes utilisées pour effectuer une opération de dessin complexe. Les macros sont des scripts en [[Python/fr|Python]], ce qui signifie qu'il s'agit de fichiers texte pouvant être écrits et modifiés à l'aide d'un éditeur de texte.
==Python==
Python is a programming language, very simple to use and very fast to [[Introduction_to_Python|learn]].


Alors que les scripts Python ont normalement pour extension {{incode|.py}}, les macros FreeCAD doivent avoir comme extension {{incode|.FCMacro}}. Une collection de macros écrites par des utilisateurs expérimentés se trouve dans la page [[macros recipes/fr|Macros]].
Extending Python files is '''.py'''. FreeCAD macros have the extension '''.FCMacro''' but can also be executed with the extension '''.py'''. Python was invented to [https://www.python.org/~guido/ Guido Van Rossun]


Voir [[Introduction to Python/fr|Introduction à Python]] pour en savoir plus sur le langage de programmation Python, puis sur [[Python scripting tutorial/fr|Tutoriel sur les scripts Python]] et sur [[FreeCAD Scripting Basics/fr|principes de base des scripts FreeCAD]] pour lancer la création de scripts dans FreeCAD.
==The Macro Menu and Toolbar Icons==


Ici une video sur l'installation [https://wiki.opensourceecology.org/wiki/Installing_Macros_in_FreeCAD installing FreeCAD macros in Ubuntu].
[[Image:Macro-record.svg|32px|record]] [[Std_DlgMacroRecord|Launch Record]]
[[Image:Macro-stop.svg|32px|stop]] [[Std_DebugStop|Stop Record]]
[[Image:Std_DlgMacroExecuteDirect.svg|32px|open editor]] [[Std_DlgMacroExecuteDirect|Open Menu macro]]
[[Image:Macro-execute.svg|32px|execute]] [[Std_DlgMacroExecute|Execute]]
[[Image:Debug-start.svg|32px|start]] [[Std_DebugMacro|Debug Macro]]
[[Image:Debug-stop.svg|32px|stop]] [[Std_DlgMacroStop|Stop]]


<span id="The_Macro_menu_and_toolbar"></span>
==Location and destination macros==
==Le menu Macro et sa barre d'outils==


<span id="Toolbar"></span>
This section allows you to locate the final location of your macros.
===Barre d'outils===


* [[Image:Std_DlgMacroRecord.svg|32px]] [[Std_DlgMacroRecord/fr|Enregistrer une macro]]
'''1 :''' click '''Menu > Macro > Macros''' or the click the bottom [[File:Std DlgMacroExecuteDirect.svg|24px]] "Open a dialog to let you execute a macro Recorded"
* [[Image:Std_MacroStopRecord.svg|32px]] [[Std_MacroStopRecord/fr|Arrêter l'enregistrement de la macro]]
* [[Image:Std_DlgMacroExecute.svg|32px]] [[Std_DlgMacroExecute/fr|Macros...]]
* [[Image:Std_DlgMacroExecuteDirect.svg|32px]] [[Std_DlgMacroExecuteDirect/fr|Lancer la macro]]


===Menu===
[[File:Dxf_Importer_Install_01.png|640px|center]]


Outre les outils de la barre d'outils, les fonctions suivantes sont également disponibles dans le menu {{MenuCommand|Macro}}.
'''2 :''' one dialog box open
* [[Std_MacroAttachDebugger/fr|Attacher au débogueur distant...]]
* [[Image:Std_MacroStartDebug.svg|32px]] [[Std_MacroStartDebug/fr|Déboguer la macro]]
* [[Image:Std_MacroStopDebug.svg|32px]] [[Std_MacroStopDebug/fr|Arrêter le débogage]]
* [[Std_MacroStepOver/fr|Passer outre]]
* [[Std_MacroStepInto/fr|Pénétrer dans]]
* [[Std_ToggleBreakpoint/fr|Basculer le point d'arrêt]]


<span id="Macros_directory"></span>
'''3 :''' the address of "Macro destination" (here '''C:\Users\your_user_name\AppData\Roaming\FreeCAD\''')
==Répertoires des macros==


<div class="toccolours mw-collapsible mw-collapsed">
In Ubuntu, this is normally '''/home/your_user_name/.FreeCAD'''


Les macros sont créées dans un dossier spécifique du répertoire FreeCAD de l'utilisateur. Ce répertoire peut être configuré dans la [[Std_DlgMacroExecute/fr|boîte d'exécution des macros]] ou dans l'[[Preferences Editor/fr|éditeur de préférences]], via le menu {{MenuCommand|Édition → Préférences → Python → Macro → Paramètres d'enregistrement des macros}}.
'''4 :''' copy the address of "Macro destination" (here '''C:\Users\your_user_name\AppData\Roaming\FreeCAD\''')


Les macros téléchargées doivent également être placées dans ce répertoire.
[[File:Dxf_Importer_Install_02.png|640px|center]]


<div class="mw-collapsible-content">
'''5 :''' paste the address into your browser and confirm


<span id="Default_directory"></span>
[[File:Dxf_Importer_Install_03.png|640px|center]]
=== Répertoire par défaut ===


Les macros peuvent être simplement copiées dans
'''6 :''' leave open the explorer

{{Code|code=
$ROOT_DIR/
}}

où {{incode|$ROOT_DIR}} est un des premiers répertoire recherché par FreeCAD au démarrage.

Le {{incode|$ROOT_DIR}} pourrait être un répertoire système, auquel cas la macro est installée pour tous les utilisateurs.
* Sous Linux, il s’agit généralement de {{incode|/usr/share/freecad/}}.
* Sous Windows, il s’agit généralement de {{incode|C:\Program Files\FreeCAD\}}.
* Sous Mac OSX, il s’agit généralement de {{incode|/Applications/FreeCAD/}}.

Le {{incode|$ROOT_DIR}} pourrait être le répertoire d'un utilisateur particulier.
* Sous Linux, il s’agit généralement de {{incode|/home/username/.local/share/FreeCAD/}} ({{VersionPlus/fr|0.20}}) ou {{incode|/home/username/.FreeCAD/}} ({{VersionMinus/fr|0.19}}).
* Sous Windows, il s’agit généralement de {{incode|C:\Users\username\AppData\FreeCAD\}}
* Sous Mac OSX, il s’agit généralement de {{incode|/Users/username/Library/Preferences/FreeCAD/}}.

<span id="Configuring_the_user_directory"></span>
=== Configuration du répertoire utilisateur ===

1. Ouvrez le menu {{MenuCommand|Macro → [[Image:Std_DlgMacroExecute.svg|16px]] [[Std_DlgMacroExecute/fr|Macros...]]}} pour ouvrir la [[Std_DlgMacroExecute/fr|boîte d'exécution des macros]].

[[Image:Dxf_Importer_Install_01.png|center]]
{{Caption|align=center|Ouverture de la boîte de dialogue de lancement des macro}}

2. Définissez l'emplacement {{incode|User macros location}} approprié.
* Linux: généralement {{incode|/home/username/.local/share/FreeCAD/}} ({{VersionPlus/fr|0.20}}) ou {{incode|/home/username/.FreeCAD/}} ({{VersionMinus/fr|0.19}})
* Windows: généralement {{incode|C:\Users\username\AppData\Roaming\FreeCAD\}}.
* MacOS: généralement {{incode|/Users/username/Library/Preferences/FreeCAD/}}.

[[Image:Dxf_Importer_Install_02.png|center]]
{{Caption|align=center|Paramétrage du répertoire des macros}}

3. Accédez à ce répertoire sur votre ordinateur.
* Linux: collez l'adresse dans votre gestionnaire de fichiers, "Nautilus" ou autre. Vous devrez peut-être appuyer sur {{KEY|Ctrl}}+{{KEY|H}} pour rendre le répertoire masqué {{incode|.FreeCAD /}} visible.
* Windows: collez l'adresse dans votre "Explorateur de fichiers" et confirmez.
* MacOS: localisez le dossier dans le "Finder" ou collez l'adresse dans un "Explorateur de fichiers"; rappelez-vous du préfixe {{incode|file:///}} dans l'explorateur de fichiers pour un fichier sur le disque.

[[Image:Dxf_Importer_Install_03.png|center]]
{{Caption|align=center|Accés au répertoire des macros dans le système d'exploitation}}

4. Ajoutez des fichiers de macro à ce répertoire.
* Linux: laissez le gestionnaire de fichiers ouvert et marquez l’emplacement pour un accès plus rapide.
* Windows: laissez ouvert l'explorateur de fichiers.
* MacOS: laissez une fenêtre du "Finder" ouverte ou enregistrez l'emplacement dans votre "Explorateur de fichiers", ou configurez un "Alias" pour le désigner, ou faites glisser le dossier dans la "Barre latérale" du "Finder" afin il est là pour utiliser d'autres programmes tels que des éditeurs de texte.

[[Image:Dxf_Importer_Install_04.png|center]]
{{Caption|align=center|Le répertoire des macros}}


[[File:Dxf_Importer_Install_04.png|640px|center]]
{{clear}}
{{clear}}
</div>
</div>


<span id="Installing_macros"></span>
== Installation de macros ==


<div class="toccolours mw-collapsible mw-collapsed">
'''Section to read if you are not familiar with Python programming (common mistakes copy/paste).'''

<span id="Automatic_method"></span>
=== Méthode automatique ===

À partir de FreeCAD 0.17, utilisez le [[Image:Std_AddonMgr.svg|24px]] [[Std_AddonMgr/fr|Gestionnaire des extensions]] dans {{MenuCommand|Outils → Gestionnaire des extensions}} pour installer une macro incluse dans le dépôt [https://github.com/FreeCAD/FreeCAD-macros FreeCAD-macros].

<div class="mw-collapsible-content">

Dans les versions précédentes de FreeCAD, vous pouviez utiliser deux méthodes automatisées pour installer des macros et d’autres extensions :
* [https://github.com/FreeCAD/FreeCAD-addons addons_installer.FCMacro]: elle-même une macro, elle était le précurseur du gestionnaire des extensions et est hébergée dans le répertoire [https://github.com/FreeCAD/FreeCAD-addons FreeCAD-addons]. Vous n'avez pas besoin d'utiliser cet outil dans les nouvelles installations de FreeCAD.
* [https://github.com/microelly2/freecad-pluginloader freecad-pluginloader]: également une macro, elle pourrait être utilisée pour installer de nouveaux composants dans FreeCAD. Ce n'est plus développé.

La méthode recommandée pour installer des extensions, c'est-à-dire des [[External_workbenches/fr|Ateliers externes]] et les macros, est le [[Image:Std_AddonMgr.svg|24px]] [[Std_AddonMgr/fr|Gestionnaire des extensions]]. Toutefois, vous pouvez toujours ajouter des macros à votre système avec les méthodes manuelles décrites dans les sections suivantes. Ceci est utile si vous développez et testez votre propre code.

</div>
</div>


<div class="toccolours mw-collapsible mw-collapsed">
<div class="toccolours mw-collapsible mw-collapsed">

==The indentation errors examples wrong code==
<span id="Manual_method_1._Copy_the_code_to_the_macro_editor"></span>
===Méthode manuelle 1. Copiez le code dans l'éditeur de macro===

Pour les macros relativement petites, 300 lignes ou moins, le code peut être copié et collé directement dans l'éditeur de macros FreeCAD.

<div class="mw-collapsible-content">
<div class="mw-collapsible-content">


Nous utiliserons [[Image:Part_Prism_Apothem.svg|24px]] [[Macro_Apothem_Based_Prism_GUI/fr|Macro Apothem Based Prism GUI]] par exemple.
The indentation in the phyton programming is very important and integral part of the code, a space or an inappropriate shift causes an indentation error ex :


1. Allez sur la page wiki macro qui devrait être présente dans la liste [[Macros recipes/fr|Macros]].
<span style="color:red">
'''<unknown exception traceback><type 'exceptions.IndentationError'>: ('expected an indented block', ('C:/Users/d/AppData/Roaming/FreeCAD/Macro_Apothem_Based_Prism_GUI.FCMacro', 21, 3, 'def priSm(self):\n'))'''
</span>


S'il y a une icône personnalisée, téléchargez-la. Cliquez dessus avec le bouton droit de la souris et sélectionnez {{incode|Save image as...}}; Placez l'icône dans le répertoire des macros. Cette icône peut être utilisée comme raccourci pour la macro dans une [[Customize_Toolbars/fr|Barre d'outils personnalisée]]. L'icône par défaut est [[Image:Text-x-python.png|24px]].
gives the error returned 'expected an indented block' block indentation expected to line '''21, 3,''' normal after a '''class p ():''' must be the next line an indentation at least one space.


[[File:Macro Install HowTo 28.png|center]]
'''1 :''' In this example, the code was stuck without any indentation and of course does not work! here definitely a programmer error when pasting the code on the page as it would have never known it to work.
{{Caption|align=center|Téléchargement de l'icône depuis la page macro}}


2. Dans la page macro, sélectionnez le code dans les sections {{Emphasis|Script}} ou {{Emphasis|Macro}} et copiez-le.
[[Image:Macro Install HowTo 09.png|center|the code was stuck without any indentation]]


3. Dans FreeCAD, ouvrez le menu {{MenuCommand|Macro → [[Image:Std_DlgMacroExecute.svg|16px]] [[Std_DlgMacroExecute/fr|Macros...]]}} pour ouvrir la [[Std_DlgMacroExecute/fr|boîte d'exécution des macros]].
'''2 :''' the code was correct indentations in the right place.


[[Image:Macro Install HowTo 10.png|center|the code was correct indentations in the right place]]
[[Image:Dxf_Importer_Install_01.png|center]]
{{Caption|align=center|Ouverture de la boîte de dialogue de lancement des macro}}


4. Cliquer {{Button|Créer}}.
'''3 :''' we select the code, and we see that the selection is at the edge of the code, the macro must works so good


[[Image:Macro Install HowTo 11.png|center|the macro must works so good]]
[[Image:Macro Install HowTo 17.png|center]]
{{Caption|align=center|Création d'une nouvelle macro}}


5. Entrez le nom de la macro, ici {{incode|Macro_Apothem_Based_Prism_GUI}}, puis appuyez sur {{Button|OK}}.
'''4 :''' Here additional space is selected (it can happen) then you need to copy the code into a word processor to remove '''one space all lines'''


[[Image:Macro Install HowTo 12.png|center|remove one space all lines]]
[[Image:Macro Install HowTo 18.png|center]]
{{Caption|align=center|Renseignement du nom de la macro}}


6. La fenêtre d'édition de macros de FreeCAD est maintenant disponible et porte le nom de notre future macro.
'''5 :''' Here the code has been copied in a forum window with the {{KEY|Select all}} button apparently the selection is good


[[Image:Macro Install HowTo 14.png|center|640px|Here the code has been copied in a forum]]
[[Image:Macro Install HowTo 19.png|center]]
{{Caption|align=center|Fenêtre d'édition de macros}}


7. Collez le code dans la fenêtre de l'éditeur puis cliquez sur la croix de l'onglet pour fermer la fenêtre.
'''6 :''' But the selection pasted into the FreeCAD editor gives a surprise, an indent of four spaces has been added by the system ? the code is not good


[[Image:Macro Install HowTo 15.png|center|640px|But the selection pasted into the FreeCAD editor gives a surprise]]
[[Image:Macro Install HowTo 20.png|center]]
{{Caption|align=center|Fermeture de la fenêtre}}


8. Une fenêtre apparaît vous demandant de confirmer l'enregistrement du code. Cliquez sur {{Button|Oui}}. Vous pouvez également utiliser {{KEY|Ctrl}}+{{KEY|S}} pour enregistrer le fichier.
'''7 :''' You must delete all the extra space that is four spaces on each line, for Windows word processing [http://notepad-plus-plus.org/ notepad-plus-plus] enables vertical selection with a combination of buttons {{KEY|Alt}} + Mouse dragging or Menu> Edit> Indent> Decrease the indentation


Redémarrez FreeCAD pour enregistrer correctement la nouvelle macro.
[[Image:Macro Install HowTo 16.png|center|640px|You must delete all the extra space]]


[[Image:Macro Install HowTo 27.png|center]]
'''8 :''' Here the selection also take the column numbers which will also give an error
{{Caption|align=center|Fenêtre pour confirmer la sauvegarde}}


9. Ouvrez à nouveau le menu, {{MenuCommand|Macro → [[Image:Std_DlgMacroExecute.svg|16px]] [[Std_DlgMacroExecute/fr|Macros...]]}}, sélectionnez la nouvelle macro et appuyez sur {{Button|Exécuter}}.
[[Image:Macro_Install_HowTo_29.png|center|640px|Here the selection also take the column numbers]]


[[Image:Macro Install HowTo 21.png|center]]
'''9 :''' Perfect code.
{{Caption|align=center|Cliquez sur votre macro pour la jouer}}


10. La macro s'exécute. Remplissez les champs avec vos valeurs et cliquez sur le bouton {{Button|OK}}.
[[Image:Macro Install HowTo 13.png|center|Perfect code]]

[[Image:Macro Install HowTo 22.png|center]]
{{Caption|align=center|La macro en action; remplissez les informations et appuyez sur OK lorsque vous êtes prêt}}

11. Cette macro doit renvoyer une erreur si aucun document n'est actif. Les autres macros ouvrent un nouveau document s'il n'en existe pas.

Créez un nouveau document avec {{MenuCommand|Fichier → [[Image:Std_New.svg|16px]] [[Std_New/fr|Nouveau]]}} puis répétez les étapes précédentes pour exécuter la macro.

[[Image:Macro Install HowTo 23.png|center|]]
{{Caption|align=center|La macro renvoyant une erreur si aucun document n'est actif}}

12. Lorsqu'un document actif est disponible, la macro s'exécute et crée un objet.

[[Image:Macro Install HowTo 24.png|center]]
{{Caption|align=center|Objet crée par la macro}}

13. Vous pouvez ouvrir à nouveau la macro dans l'éditeur pour l'exécuter ou la modifier. Accédez à {{MenuCommand|Macro → [[Image:Std_DlgMacroExecute.svg|16px]] [[Std_DlgMacroExecute/fr|Macros...]]}}, sélectionnez la macro et appuyez sur {{Button|Modifier}}.

[[Image:Macro Install HowTo 25.png|center]]
{{Caption|align=center|Ouverture de la macro dans l'éditeur}}

14. La macro peut maintenant être exécutée avec {{MenuCommand|Macro → [[Image:Std_DlgMacroExecuteDirect.svg|16px]] [[Std_DlgMacroExecuteDirect/fr|Lancer la macro]]}} ou en cliquant sur le {{Button|[[Image:Std_DlgMacroExecuteDirect.svg|16px]] [[Std_DlgMacroExecuteDirect/fr|Lancer la macro]]}} dans la barre d'outils.

[[Image:Macro Install HowTo 26.png|center]]
{{Caption|align=center|Exécution de la macro chargée dans l'éditeur}}


<br />
</div>
</div>
</div>
</div>

'''Method 1:'''


<div class="toccolours mw-collapsible mw-collapsed">
<div class="toccolours mw-collapsible mw-collapsed">

==Method copy the code in one window and paste in the FreeCAD editor==
<span id="Manual_method_2._Add_a_macro_file_from_a_compressed_.zip_file"></span>
===Méthode manuelle 2. Ajouter un fichier de macro à partir d'un fichier .zip compressé===

Certaines macros sont trop importantes pour être copier-coller dans l'éditeur de macros être hébergées sur le wiki. Dans ce cas, le code peut être hébergé ailleurs, dans un répertoir Github ou sur le [https://forum.freecadweb.org/ Forum FreeCAD]. Le code peut également être compressé dans un fichier {{incode|.zip}}, tarball {{incode|.tar.xz}} ou dans un autre type d'archive s'il contient plusieurs fichiers. Si le code est distribué de cette manière, l'archive doit être extraite et les fichiers placés dans le répertoire macros.

<div class="mw-collapsible-content">
<div class="mw-collapsible-content">


Nous utiliserons [[Image:Text-x-python.png|24px]] [[Macro_screw_maker1_2/fr|Macro screw maker]] par exemple.
For example we will copy the macro [[File:Part_Prism_Apothem.svg|16px]] [[Macro_Apothem_Based_Prism_GUI|Macro_Apothem_Based_Prism_GUI]]


1. Téléchargez le code compressé à partir du forum,[http://forum.freecadweb.org/viewtopic.php?f=22&t=6558#p52887 Screw Maker].
If there are one or more icon (s) download also position your mouse over the icon, click the right mouse button and click "Save image as ..." the icon or icons are placed in the macro directory and one of these icons serve as a shortcut icon to place on the [[Customize_ToolsBar|toolsbar.]]


Vous devez utiliser un décompresseur pour obtenir les fichiers internes.
[[File:Macro Install HowTo 28.png|300px|center|Download icon]]
* Pour Windows, vous pouvez utiliser une application telle que [http://www.7-zip.org/ 7-zip] ou [http://www.kanmandet.dk/?p=37 L-Zarc] ou [http: //www.quickzip.org/quickzip51.html quickzip].
* Pour Linux, vous pouvez utiliser une commande du terminal


{{Code|code=
After copying your code we will paste the code in FreeCAD editor.
unzip your_file.zip -d your_directory
}}


2. Téléchargez l'archive compressée avec le code de la macro dans un dossier local.
'''1 :''' Open FreeCAD and open the editor in FreeCAD


[[File:Dxf_Importer_Install_01.png|640px|center]]
[[Image:Macro Install HowTo 01.png|center]]
{{Caption|align=center|Téléchargement de l'archive compressée avec le code de macro dans un dossier local}}


3. Décompressez votre fichier dans le dossier.
'''2 :''' The window macros file opens, click {{KEY|Create}} button


[[File:Macro Install HowTo 17.png|300px|center|The window macros file opens]]
[[Image:Macro Install HowTo 02.png|center]]
{{Caption|align=center|Décompressez votre fichier dans le dossier}}


4. Le décompresseur crée un nouveau répertoire avec les fichiers décompressés.
'''3 :''' A new window opens, enter the macro name (here "'''Macro_Apothem_Based_Prism_GUI'''")and click the create {{KEY|Ok}} button


[[File:Macro Install HowTo 18.png|300px|center|enter the macro name]]
[[Image:Macro Install HowTo 03.png|center]]
{{Caption|align=center|Le nouveau répertoire créé après la décompression de l'archive}}


5. Accédez au nouveau répertoire et copiez ou coupez le fichier macro.
'''4 :''' The editing window FreeCAD macros is now available and has the name of our future macro.


[[File:Macro Install HowTo 19.png|640px|center|The editing window FreeCAD macros]]
[[Image:Macro Install HowTo 04.png|center]]
{{Caption|align=center|Saisie du nouveau répertoire créé avec le fichier de macro décompressé}}


6. Accédez au répertoire des macros et collez le fichier à cet endroit.
'''5 :''' Paste your code in the macro editor window and click the little '''cross''' to close the window.


[[File:Macro Install HowTo 20.png|640px|center|close the window]]
[[Image:Macro Install HowTo 05.png|center]]
{{Caption|align=center|Placer le fichier macro dans le répertoire macro}}


7. Dans FreeCAD, ouvrez le menu {{MenuCommand|Macro → [[Image:Std_DlgMacroExecute.svg|16px]] [[Std_DlgMacroExecute/fr|Macros...]]}} pour ouvrir la [[Std_DlgMacroExecute/fr|boîte d'exécution des macros]].
'''6 :''' A warning window appears asking for confirmation of save code, click on {{KEY|Yes}}


[[Image:Macro Install HowTo 06.png|center]]
'''PS:''' For the change silk consideration must save the macro and reopen it and just run it.
{{Caption|align=center|Ouverture de la boîte de dialogue de lancement des macro}}


8. Sélectionnez la nouvelle macro et appuyez sur {{Button|Execute}}.
[[File:Macro Install HowTo 27.png|300px|center|A warning window appears asking for confirmation of save code]]


[[Image:Macro Install HowTo 07.png|center]]
'''7 :''' Repeat the number '''1 :''' , Click on your new macro and button {{KEY|Execute}}
{{Caption|align=center|Cliquez sur votre macro pour la jouer}}


9. La macro s'exécute maintenant. Sélectionnez les options souhaitées et cliquez sur le bouton {{Button|Create}}.
[[File:Macro Install HowTo 21.png|300px|center|Click on your new macro and button Execute]]


[[Image:Macro Install HowTo 08.png|center|640px]]
'''8 :''' The macro runs, complete the fields with your values and click the {{KEY|OK}} button
{{Caption|align=center|La macro en action; sélectionnez les options souhaitées et appuyez sur Créer lorsque vous êtes prêt}}


[[File:Macro Install HowTo 22.png|640px|center|The macro runs, complete the fields]]
[[Image:Macro Install HowTo 30.png|center]]
{{Caption|align=center|Objet crée par la macro}}


</div>
9 : The macro returns an error ! we do not have to open document, open a document and repeat the operation '''7''' and '''8'''. Some macros open a new document if it does not find one.
</div>


<span id="Execute_a_macro_in_command_line"></span>
[[File:Macro Install HowTo 23.png|640px|center|The macro returns an error!]]
== Exécuter une macro en ligne de commande ==


<div class="toccolours mw-collapsible mw-collapsed">
10 : Here is your prism


Ligne de commande pour exécuter une macro en (.FCMacro or .py)
[[File:Macro Install HowTo 24.png|640px|center|your prism]]


<div class="mw-collapsible-content">
11 : You can also open your macro in the editor to run or modify, click the {{KEY|Edit}} button


sur Windows
[[File:Macro Install HowTo 25.png|300px|center|You can also open your macro in the editor]]


{{Code|code=
12: The macro is now in the FreeCAD editor you can run through the menu "Macro Run Macro" or by clicking on the triangle [[File:Macro-execute.svg|16px]] green in the macros toolsbar
"C:\Program Files\FreeCAD\bin\FreeCAD.exe" "C:\Users\userName\AppData\Roaming\FreeCAD\Mod\WorkFeature\start_WF.FCMacro"
}}


sur Linux
[[File:Macro Install HowTo 26.png|640px|center|The macro is now in the FreeCAD editor]]

{{Code|code=
todo
}}


</div>
</div>
</div>
</div>


<span id="Errors_in_macros"></span>
'''Method 2:'''
== Erreurs dans les macros ==


<div class="toccolours mw-collapsible mw-collapsed">
<div class="toccolours mw-collapsible mw-collapsed">
==Method macro in a compressed .ZIP file==
<div class="mw-collapsible-content">


<span id="Indentation_errors"></span>
Download the file compressed here (example) [http://forum.freecadweb.org/viewtopic.php?f=22&t=6558#p52887 Macro_screw_maker 1.7]. (the page [[Macro_screw_maker1_2|Macro_screw_maker]])
=== Exemples de code erroné dû à des erreurs d'indentation ===


L'espace blanc au début des lignes (indentation) dans le langage de programmation [[Python/fr|Python]] est très important et fait partie intégrante du code. Un espace inapproprié peut empêcher le code de s'exécuter ou présenter des erreurs.
Free for Windows [http://www.7-zip.org/ 7-zip] ou [http://www.kanmandet.dk/?p=37 L-Zarc] ou [http://www.quickzip.org/quickzip51.html quickzip]


Cette section décrit certaines erreurs susceptibles d’être rencontrées lors des opérations de copier-coller et d’écriture de code macro.
For Linux use this on the terminal

<div class="mw-collapsible-content">

Une erreur d’indentation typique ressemble à ceci:


{{Code|code=
{{Code|code=
<unknown exception traceback><type 'exceptions.IndentationError'>: ('expected an indented block', ('C:/Users/d/AppData/Roaming/FreeCAD/Macro_Apothem_Based_Prism_GUI.FCMacro', 21, 3, 'def priSm(self):\n'))
unzip your_file.zip -d your_directory
}}
}}


<span id="Example_1"></span>
you must unzip the zip and copy the file (or all the files and folders) in your macro directory.
==== Exemple 1 ====


Si le code manque d'indentation, le code ne fonctionnera pas. Les définitions de classe ({{incode|class}}) et de fonction ({{incode|def ()}}) ainsi que les structures de contrôle ({{incode|if}}, {{incode|while}}, {{incode|for}}) doivent être suivies d'un bloc de code en retrait.
'''Process'''


Cette erreur est possible si l'utilisateur ne copie pas le code correctement et si tous les espaces sont supprimés par inadvertance.
'''1 :''' Download your file in your local folder here the folder '''Temp'''


[[Image:Macro Install HowTo 01.png|center|640px|Download your file in your local folder here the folder Temp]]
[[Image:Macro Install HowTo 09.png|center]]
{{Caption|align=center|Code Python sans indentation; cela provoquera une erreur quand il sera exécuté}}


Problème d'indentation résolu.
'''2 :''' Unzip your file in the folder.


[[Image:Macro Install HowTo 02.png|center|640px|Unzip your file in the folder.
[[Image:Macro Install HowTo 10.png|center]]
{{Caption|align=center|Code Python avec l'indentation correcte}}
]]


Si le code est sélectionné, toutes les lignes doivent être mises en surbrillance jusqu'au bord gauche indiquant que les lignes sont alignées.
'''3 :''' The decompressor finished his work and created a new folder with the unpacked file


[[Image:Macro Install HowTo 03.png|center|640px|The decompressor finished his work and created a new folder with the unpacked file]]
[[Image:Macro Install HowTo 11.png|center]]
{{Caption|align=center|Code Python en surbrillance indiquant que toutes les lignes commencent au bord gauche}}


<span id="Example_2"></span>
'''4 :''' Enter in the newly created directory, move about the file, click the right mouse button and click on '''Cut'''.
==== Exemple 2 ====


Si un espace supplémentaire est introduit au début de toutes les lignes, l'interpréteur Python échouera et se plaindra de l'indentation inutile. Dans ce cas, toutes les lignes nécessitent la suppression de l'espace initial.
[[Image:Macro Install HowTo 04.png|center|640px|Enter in the newly created directory]]


[[Image:Macro Install HowTo 12.png|center]]
'''5 :''' Return to your browser remained open in the macro location (here '''C:\Users\your_user_name\AppData\Roaming\FreeCAD\''') and close the browser.
{{Caption|align=center|Code Python avec espace supplémentaire sur chaque ligne}}


<span id="Example_3"></span>
[[Image:Macro Install HowTo 05.png|center|640px|Return to your browser remained open]]
==== Exemple 3 ====


Ici, le code a été copié depuis un fil de forum en utilisant le bouton {{Button|Select all}}. Apparemment, le choix est bon.
'''6 :''' Open FreeCAD click '''Menu > Macro > Macros''' or the click the {{KEY|bottom}} [[File:Std_DlgMacroExecuteDirect.svg|18px]] "Open a dialog to let you execute a macro Recorded"


[[Image:Macro Install HowTo 06.png|center|640px|Open FreeCAD]]
[[Image:Macro Install HowTo 14.png|center]]
{{Caption|align=center|Code Python copié à partir d'un forum}}


Cependant, lorsque la sélection est collée dans l'éditeur de macro, une indentation indésirable semble apparaître.
'''7 :''' The macros window open , select your macro and click the button {{KEY|Execute}}


[[Image:Macro Install HowTo 07.png|center|640px|The macros window open]]
[[Image:Macro Install HowTo 15.png|center]]
{{Caption|align=center|Code Python copié d'un forum dans l'éditeur de macros; l'indentation inutile est ajoutée}}


Dans ce cas, les espaces initiaux doivent être supprimés. Cela peut être fait avec un éditeur de texte spécialisé pour réduire rapidement l'indentation des lignes.
'''8 :''' Your macro is executed enter the data and click the {{KEY|Create}} button


Sous Windows, [http://notepad-plus-plus.org/Notepad ++] peut effectuer une sélection avec {{KEY|Alt}} et le déplacement de la souris, puis utiliser {{MenuCommand|Edit → Indent → Diminuer l'indentation}}.
[[Image:Macro Install HowTo 08.png|center|640px|Your macro is executed]]


[[Image:Macro Install HowTo 16.png|center]]
'''9''' : Whaouu
{{Caption|align=center|Code Python avec l'indentation correcte}}


<span id="Example_4"></span>
[[Image:Macro Install HowTo 30.png|center|640px|Whaouu]]
==== Exemple 4 ====

Ici, la sélection sélectionne également les numéros de ligne dans l'exemple de code. Si cette sélection est collée dans l'éditeur de macro, cela ne fonctionnera pas. Tous les numéros de ligne doivent être supprimés et les espaces ajustés de manière à ce que le code Python présente l'indentation appropriée.

[[Image:Macro_Install_HowTo_29.png|center]]
{{Caption|align=center|Sélection qui sélectionne également les numéros de ligne; si ce code est collé dans l'éditeur de macro, cela ne fonctionnera pas}}

<span id="Good_code"></span>
==== Bon code ====

[[Image:Macro Install HowTo 13.png|center]]
{{Caption|align=center|Code Python avec l'indentation correcte}}


</div>
</div>
</div>
</div>


<div class="toccolours mw-collapsible mw-collapsed">
End tutorial good job.


<span id="No_text_output_from_macros"></span>
==Links==
===Pour ceux qui ne voient aucune information s'afficher===


Les macros peuvent générer des informations dans la vue du rapport afin de détailler l'action du code en cours d'exécution.
The [[Macros_recipes|Macros_recipes]] page


Si aucune information n'est affichée, assurez-vous que la vue du rapport et la console [[Python/fr|Python]] sont visibles et que la sortie est dirigée vers la vue du rapport.
<languages/>

<div class="mw-collapsible-content">

<span id="Printing_information"></span>
==== Informations sur l'affichage====

Les macros FreeCAD ont deux méthodes pour afficher des informations dans la vue rapport.

Les fonctions FreeCAD

{{Code|code=
FreeCAD.Console.PrintMessage("Hello World! \n")
FreeCAD.Console.PrintError("Hello World! \n")
FreeCAD.Console.PrintWarning("Hello World! \n")
}}

La simple fonction Python

{{Code|code=
print("Hello World!")
}}

<span id="Enabling_the_report_view"></span>
==== Activer la vue rapport ====

Pour voir les informations affichées dans la console, vous devez:

1. Accédez au menu {{MenuCommand|Affichage → Panneaux}}.

[[Image:Macro Install HowTo 31.png|center]]

[[Image:Macro Install HowTo 32.png|center]]
{{Caption|align=center|Rendre les panneaux visibles dans le menu Affichage → Panneaux}}

2. Cochez {{incode|Report view}} et {{incode|Python console}}.

[[Image:Macro Install HowTo 33.png|center]]
{{Caption|align=center|Activation de l'affichage du rapport et de la console Python}}

3. Les panneaux sont maintenant visibles et les commandes telles que {{incode|FreeCAD.Console.PrintMessage()}} affichent maintenant les informations qui apparaissent dans la {{incode|Affichage du rapport}}.

[[Image:Macro Install HowTo 34.png|center]]
{{Caption|align=center|Fenêtre principale de FreeCAD avec la vue Rapport et la console Python}}

<span id="Enabling_the_print()_command"></span>
==== Activer la commande <tt>print()</tt> ====

FreeCAD devra peut-être être configuré pour que la fonction {{incode|print()}} de [[Python/fr|Python]] redirige correctement sa sortie vers la vue du rapport.

'''1 :''' cliquez sur le menu '''Édition''' puis '''Préférences'''

1. Allez dans [[Preferences Editor/fr|Editeur de Préférences]] avec le menu {{MenuCommand|Édition → Préférences}}.

[[Image:Macro Install HowTo 35.png|center]]
{{Caption|align=center|Entrer dans l'éditeur de préférences}}

2. Accédez à la section {{MenuCommand|Python}} puis à {{MenuCommand|Fenêtre de sortie → Interpréteur Python}}.

[[Image:Macro Install HowTo 36.png|center]]
{{Caption|align=center|Préférences de la fenêtre de sortie}}

3. Cochez les deux cases:

* [[Image:Case_a_cocher_O.png|16px]] Rediriger es messages internes Python vers la vue rapport

* [[Image:Case_a_cocher_O.png|16px]] Rediriger les erreurs internes de Python vers la vue rapport

et validez en cliquant sur le bouton {{Button|OK}}.

[[Image:Macro Install HowTo 37.png|center]]
{{Caption|align=center|Redirection interne}}

[[Image:Macro Install HowTo 38.png|center]]
{{Caption|align=center|Commandes Python imprimant des informations dans la vue rapport}}
</div>
</div>

{{Powerdocnavi{{#translation:}}}}
[[Category:Developer Documentation{{#translation:}}]]
[[Category:Python Code{{#translation:}}]]

Latest revision as of 20:42, 10 October 2023

Other languages:
Tutoriel
Thème
Programmation
Niveau
Programmeur moyen
Temps d'exécution estimé
15 minutes
Auteurs
Mario52
Version de FreeCAD
Toutes versions
Fichiers exemples
None
Voir aussi
None

Description

Depuis la v0.17, il est facile d'ajouter des macros en utilisant le Gestionnaire des extensions. Un utilisateur régulier n'a pas besoin de faire plus que d'utiliser cet outil. Continuez à lire pour plus d'informations sur l'installation de macros.

Les macros sont des séquences de commandes utilisées pour effectuer une opération de dessin complexe. Les macros sont des scripts en Python, ce qui signifie qu'il s'agit de fichiers texte pouvant être écrits et modifiés à l'aide d'un éditeur de texte.

Alors que les scripts Python ont normalement pour extension .py, les macros FreeCAD doivent avoir comme extension .FCMacro. Une collection de macros écrites par des utilisateurs expérimentés se trouve dans la page Macros.

Voir Introduction à Python pour en savoir plus sur le langage de programmation Python, puis sur Tutoriel sur les scripts Python et sur principes de base des scripts FreeCAD pour lancer la création de scripts dans FreeCAD.

Ici une video sur l'installation installing FreeCAD macros in Ubuntu.

Le menu Macro et sa barre d'outils

Barre d'outils

Menu

Outre les outils de la barre d'outils, les fonctions suivantes sont également disponibles dans le menu Macro.

Répertoires des macros

Les macros sont créées dans un dossier spécifique du répertoire FreeCAD de l'utilisateur. Ce répertoire peut être configuré dans la boîte d'exécution des macros ou dans l'éditeur de préférences, via le menu Édition → Préférences → Python → Macro → Paramètres d'enregistrement des macros.

Les macros téléchargées doivent également être placées dans ce répertoire.

Répertoire par défaut

Les macros peuvent être simplement copiées dans 

$ROOT_DIR/

où $ROOT_DIR est un des premiers répertoire recherché par FreeCAD au démarrage.

Le $ROOT_DIR pourrait être un répertoire système, auquel cas la macro est installée pour tous les utilisateurs.

  • Sous Linux, il s’agit généralement de /usr/share/freecad/.
  • Sous Windows, il s’agit généralement de C:\Program Files\FreeCAD\.
  • Sous Mac OSX, il s’agit généralement de /Applications/FreeCAD/.

Le $ROOT_DIR pourrait être le répertoire d'un utilisateur particulier.

  • Sous Linux, il s’agit généralement de /home/username/.local/share/FreeCAD/ (version 0.20 et suivantes) ou /home/username/.FreeCAD/ (version 0.19 et précédentes).
  • Sous Windows, il s’agit généralement de C:\Users\username\AppData\FreeCAD\
  • Sous Mac OSX, il s’agit généralement de /Users/username/Library/Preferences/FreeCAD/.

Configuration du répertoire utilisateur

1. Ouvrez le menu Macro → Macros... pour ouvrir la boîte d'exécution des macros.

Ouverture de la boîte de dialogue de lancement des macro

2. Définissez l'emplacement User macros location approprié.

  • Linux: généralement /home/username/.local/share/FreeCAD/ (version 0.20 et suivantes) ou /home/username/.FreeCAD/ (version 0.19 et précédentes)
  • Windows: généralement C:\Users\username\AppData\Roaming\FreeCAD\.
  • MacOS: généralement /Users/username/Library/Preferences/FreeCAD/.

Paramétrage du répertoire des macros

3. Accédez à ce répertoire sur votre ordinateur.

  • Linux: collez l'adresse dans votre gestionnaire de fichiers, "Nautilus" ou autre. Vous devrez peut-être appuyer sur Ctrl+H pour rendre le répertoire masqué .FreeCAD / visible.
  • Windows: collez l'adresse dans votre "Explorateur de fichiers" et confirmez.
  • MacOS: localisez le dossier dans le "Finder" ou collez l'adresse dans un "Explorateur de fichiers"; rappelez-vous du préfixe file:/// dans l'explorateur de fichiers pour un fichier sur le disque.

Accés au répertoire des macros dans le système d'exploitation

4. Ajoutez des fichiers de macro à ce répertoire.

  • Linux: laissez le gestionnaire de fichiers ouvert et marquez l’emplacement pour un accès plus rapide.
  • Windows: laissez ouvert l'explorateur de fichiers.
  • MacOS: laissez une fenêtre du "Finder" ouverte ou enregistrez l'emplacement dans votre "Explorateur de fichiers", ou configurez un "Alias" pour le désigner, ou faites glisser le dossier dans la "Barre latérale" du "Finder" afin il est là pour utiliser d'autres programmes tels que des éditeurs de texte.

Le répertoire des macros

Installation de macros

Méthode automatique

À partir de FreeCAD 0.17, utilisez le Gestionnaire des extensions dans Outils → Gestionnaire des extensions pour installer une macro incluse dans le dépôt FreeCAD-macros.

Dans les versions précédentes de FreeCAD, vous pouviez utiliser deux méthodes automatisées pour installer des macros et d’autres extensions :

  • addons_installer.FCMacro: elle-même une macro, elle était le précurseur du gestionnaire des extensions et est hébergée dans le répertoire FreeCAD-addons. Vous n'avez pas besoin d'utiliser cet outil dans les nouvelles installations de FreeCAD.
  • freecad-pluginloader: également une macro, elle pourrait être utilisée pour installer de nouveaux composants dans FreeCAD. Ce n'est plus développé.

La méthode recommandée pour installer des extensions, c'est-à-dire des Ateliers externes et les macros, est le Gestionnaire des extensions. Toutefois, vous pouvez toujours ajouter des macros à votre système avec les méthodes manuelles décrites dans les sections suivantes. Ceci est utile si vous développez et testez votre propre code.

Méthode manuelle 1. Copiez le code dans l'éditeur de macro

Pour les macros relativement petites, 300 lignes ou moins, le code peut être copié et collé directement dans l'éditeur de macros FreeCAD.

Nous utiliserons Macro Apothem Based Prism GUI par exemple.

1. Allez sur la page wiki macro qui devrait être présente dans la liste Macros.

S'il y a une icône personnalisée, téléchargez-la. Cliquez dessus avec le bouton droit de la souris et sélectionnez Save image as...; Placez l'icône dans le répertoire des macros. Cette icône peut être utilisée comme raccourci pour la macro dans une Barre d'outils personnalisée. L'icône par défaut est .

Téléchargement de l'icône depuis la page macro

2. Dans la page macro, sélectionnez le code dans les sections Script ou Macro et copiez-le.

3. Dans FreeCAD, ouvrez le menu Macro → Macros... pour ouvrir la boîte d'exécution des macros.

Ouverture de la boîte de dialogue de lancement des macro

4. Cliquer Créer.

Création d'une nouvelle macro

5. Entrez le nom de la macro, ici Macro_Apothem_Based_Prism_GUI, puis appuyez sur OK.

Renseignement du nom de la macro

6. La fenêtre d'édition de macros de FreeCAD est maintenant disponible et porte le nom de notre future macro.

Fenêtre d'édition de macros

7. Collez le code dans la fenêtre de l'éditeur puis cliquez sur la croix de l'onglet pour fermer la fenêtre.

Fermeture de la fenêtre

8. Une fenêtre apparaît vous demandant de confirmer l'enregistrement du code. Cliquez sur Oui. Vous pouvez également utiliser Ctrl+S pour enregistrer le fichier.

Redémarrez FreeCAD pour enregistrer correctement la nouvelle macro.

Fenêtre pour confirmer la sauvegarde

9. Ouvrez à nouveau le menu, Macro → Macros..., sélectionnez la nouvelle macro et appuyez sur Exécuter.

Cliquez sur votre macro pour la jouer

10. La macro s'exécute. Remplissez les champs avec vos valeurs et cliquez sur le bouton OK.

La macro en action; remplissez les informations et appuyez sur OK lorsque vous êtes prêt

11. Cette macro doit renvoyer une erreur si aucun document n'est actif. Les autres macros ouvrent un nouveau document s'il n'en existe pas.

Créez un nouveau document avec Fichier → Nouveau puis répétez les étapes précédentes pour exécuter la macro.

La macro renvoyant une erreur si aucun document n'est actif

12. Lorsqu'un document actif est disponible, la macro s'exécute et crée un objet.

Objet crée par la macro

13. Vous pouvez ouvrir à nouveau la macro dans l'éditeur pour l'exécuter ou la modifier. Accédez à Macro → Macros..., sélectionnez la macro et appuyez sur Modifier.

Ouverture de la macro dans l'éditeur

14. La macro peut maintenant être exécutée avec Macro → Lancer la macro ou en cliquant sur le Lancer la macro dans la barre d'outils.

Exécution de la macro chargée dans l'éditeur

Méthode manuelle 2. Ajouter un fichier de macro à partir d'un fichier .zip compressé

Certaines macros sont trop importantes pour être copier-coller dans l'éditeur de macros être hébergées sur le wiki. Dans ce cas, le code peut être hébergé ailleurs, dans un répertoir Github ou sur le Forum FreeCAD. Le code peut également être compressé dans un fichier .zip, tarball .tar.xz ou dans un autre type d'archive s'il contient plusieurs fichiers. Si le code est distribué de cette manière, l'archive doit être extraite et les fichiers placés dans le répertoire macros.

Nous utiliserons Macro screw maker par exemple.

1. Téléchargez le code compressé à partir du forum,Screw Maker.

Vous devez utiliser un décompresseur pour obtenir les fichiers internes.

  • Pour Windows, vous pouvez utiliser une application telle que 7-zip ou L-Zarc ou [http: //www.quickzip.org/quickzip51.html quickzip].
  • Pour Linux, vous pouvez utiliser une commande du terminal
unzip your_file.zip -d your_directory

2. Téléchargez l'archive compressée avec le code de la macro dans un dossier local.

Téléchargement de l'archive compressée avec le code de macro dans un dossier local

3. Décompressez votre fichier dans le dossier.

Décompressez votre fichier dans le dossier

4. Le décompresseur crée un nouveau répertoire avec les fichiers décompressés.

Le nouveau répertoire créé après la décompression de l'archive

5. Accédez au nouveau répertoire et copiez ou coupez le fichier macro.

Saisie du nouveau répertoire créé avec le fichier de macro décompressé

6. Accédez au répertoire des macros et collez le fichier à cet endroit.

Placer le fichier macro dans le répertoire macro

7. Dans FreeCAD, ouvrez le menu Macro → Macros... pour ouvrir la boîte d'exécution des macros.

Ouverture de la boîte de dialogue de lancement des macro

8. Sélectionnez la nouvelle macro et appuyez sur Execute.

Cliquez sur votre macro pour la jouer

9. La macro s'exécute maintenant. Sélectionnez les options souhaitées et cliquez sur le bouton Create.

La macro en action; sélectionnez les options souhaitées et appuyez sur Créer lorsque vous êtes prêt

Objet crée par la macro

Exécuter une macro en ligne de commande

Ligne de commande pour exécuter une macro en (.FCMacro or .py)

sur Windows 

"C:\Program Files\FreeCAD\bin\FreeCAD.exe" "C:\Users\userName\AppData\Roaming\FreeCAD\Mod\WorkFeature\start_WF.FCMacro"

sur Linux 

todo

Erreurs dans les macros

Exemples de code erroné dû à des erreurs d'indentation

L'espace blanc au début des lignes (indentation) dans le langage de programmation Python est très important et fait partie intégrante du code. Un espace inapproprié peut empêcher le code de s'exécuter ou présenter des erreurs.

Cette section décrit certaines erreurs susceptibles d’être rencontrées lors des opérations de copier-coller et d’écriture de code macro.

Une erreur d’indentation typique ressemble à ceci: 

<unknown exception traceback><type 'exceptions.IndentationError'>: ('expected an indented block', ('C:/Users/d/AppData/Roaming/FreeCAD/Macro_Apothem_Based_Prism_GUI.FCMacro', 21, 3, 'def priSm(self):\n'))

Exemple 1

Si le code manque d'indentation, le code ne fonctionnera pas. Les définitions de classe (class) et de fonction (def ()) ainsi que les structures de contrôle (if, while, for) doivent être suivies d'un bloc de code en retrait.

Cette erreur est possible si l'utilisateur ne copie pas le code correctement et si tous les espaces sont supprimés par inadvertance.

Code Python sans indentation; cela provoquera une erreur quand il sera exécuté

Problème d'indentation résolu.

Code Python avec l'indentation correcte

Si le code est sélectionné, toutes les lignes doivent être mises en surbrillance jusqu'au bord gauche indiquant que les lignes sont alignées.

Code Python en surbrillance indiquant que toutes les lignes commencent au bord gauche

Exemple 2

Si un espace supplémentaire est introduit au début de toutes les lignes, l'interpréteur Python échouera et se plaindra de l'indentation inutile. Dans ce cas, toutes les lignes nécessitent la suppression de l'espace initial.

Code Python avec espace supplémentaire sur chaque ligne

Exemple 3

Ici, le code a été copié depuis un fil de forum en utilisant le bouton Select all. Apparemment, le choix est bon.

Code Python copié à partir d'un forum

Cependant, lorsque la sélection est collée dans l'éditeur de macro, une indentation indésirable semble apparaître.

Code Python copié d'un forum dans l'éditeur de macros; l'indentation inutile est ajoutée

Dans ce cas, les espaces initiaux doivent être supprimés. Cela peut être fait avec un éditeur de texte spécialisé pour réduire rapidement l'indentation des lignes.

Sous Windows, ++ peut effectuer une sélection avec Alt et le déplacement de la souris, puis utiliser Edit → Indent → Diminuer l'indentation.

Code Python avec l'indentation correcte

Exemple 4

Ici, la sélection sélectionne également les numéros de ligne dans l'exemple de code. Si cette sélection est collée dans l'éditeur de macro, cela ne fonctionnera pas. Tous les numéros de ligne doivent être supprimés et les espaces ajustés de manière à ce que le code Python présente l'indentation appropriée.

Sélection qui sélectionne également les numéros de ligne; si ce code est collé dans l'éditeur de macro, cela ne fonctionnera pas

Bon code

Code Python avec l'indentation correcte

Pour ceux qui ne voient aucune information s'afficher

Les macros peuvent générer des informations dans la vue du rapport afin de détailler l'action du code en cours d'exécution.

Si aucune information n'est affichée, assurez-vous que la vue du rapport et la console Python sont visibles et que la sortie est dirigée vers la vue du rapport.

Informations sur l'affichage

Les macros FreeCAD ont deux méthodes pour afficher des informations dans la vue rapport.

Les fonctions FreeCAD 

FreeCAD.Console.PrintMessage("Hello World! \n")
FreeCAD.Console.PrintError("Hello World! \n")
FreeCAD.Console.PrintWarning("Hello World! \n")

La simple fonction Python 

print("Hello World!")

Activer la vue rapport

Pour voir les informations affichées dans la console, vous devez:

1. Accédez au menu Affichage → Panneaux.

Rendre les panneaux visibles dans le menu Affichage → Panneaux

2. Cochez Report view et Python console.

Activation de l'affichage du rapport et de la console Python

3. Les panneaux sont maintenant visibles et les commandes telles que FreeCAD.Console.PrintMessage() affichent maintenant les informations qui apparaissent dans la Affichage du rapport.

Fenêtre principale de FreeCAD avec la vue Rapport et la console Python

Activer la commande print()

FreeCAD devra peut-être être configuré pour que la fonction print() de Python redirige correctement sa sortie vers la vue du rapport.

1 : cliquez sur le menu Édition puis Préférences

1. Allez dans Editeur de Préférences avec le menu Édition → Préférences.

Entrer dans l'éditeur de préférences

2. Accédez à la section Python puis à Fenêtre de sortie → Interpréteur Python.

Préférences de la fenêtre de sortie

3. Cochez les deux cases:

  • Rediriger es messages internes Python vers la vue rapport
  • Rediriger les erreurs internes de Python vers la vue rapport

et validez en cliquant sur le bouton OK.

Redirection interne

Commandes Python imprimant des informations dans la vue rapport

Hub utilisateurs expérimentés
Retrieved from "http://wiki.freecad.org/index.php?title=How_to_install_macros/fr&oldid=1311099"