How to install macros/fr

Description
Cette page vous montrera comment installer et utiliser FreeCAD macro.

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, les macros FreeCAD doivent avoir comme extension. 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.

Barre d'outils

 * [[Image:Macro-record.svg|32px|record]] Lance l'enregistrement de la macro
 * [[Image:Macro-stop.svg|32px|stop]] Arrête l'enregistrement
 * [[Image:Std_DlgMacroExecuteDirect.svg|32px|open editor]] Ouvre le menu des macros
 * [[Image:Macro-execute.svg|32px|execute]] Exécute la macro

Menu
Outre les outils de la barre d'outils, les fonctions suivantes sont également disponibles dans le menu.
 * [[Image:Debug-start.svg|32px|start]] Debug Start
 * [[Image:Debug-stop.svg|32px|stop]] Debug Stop
 * Step over
 * Step into
 * Toggle breakpoint

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 Lancer la macro (???) ou dans Editeur de préférences via le menu.

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

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

Le 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.
 * Sous Windows, il s’agit généralement de.
 * Sous Mac OSX, il s’agit généralement de.

Le pourrait être le répertoire d'un utilisateur particulier.
 * Sous Linux, il s’agit généralement de.
 * Sous Windows, il s’agit généralement de.
 * Sous Mac OSX, il s’agit généralement de.

Configuration du répertoire utilisateur
1. Ouvrez le menu pour ouvrir la Lancer la macro.



2. Définissez l'emplacement approprié.
 * Linux: généralement.
 * Windows: généralement.
 * MacOS: généralement.



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 + pour rendre le répertoire masqué 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 dans l'explorateur de fichiers pour un fichier sur le disque.



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.



Méthode automatique
À partir de FreeCAD 0.17, utilisez le Addon Manager dans pour installer une macro incluse dans le répertoire 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 addons:
 * addons_installer.FCMacro: elle-même une macro, elle était le précurseur du gestionnaire d'addon 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 addons, c'est-à-dire Ateliers externes et les macros, est le Addon Manager. 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 allons utiliser Macro Apothem Based Prism GUI comme 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 ; 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.



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

3. Dans FreeCAD, ouvrez le menu pour ouvrir la dialogue d'exécution de la macro.



4. Cliquer.



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



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



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



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

Redémarrez FreeCAD pour enregistrer correctement la nouvelle macro.



9. Ouvrez à nouveau le menu,, sélectionnez la nouvelle macro et appuyez sur.



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



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 puis répétez les étapes précédentes pour exécuter la macro.



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



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



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



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, tarball 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 allons utiliser Macro screw maker comme 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

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



3. Décompressez votre fichier dans le dossier.



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



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



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



7. Dans FreeCAD, ouvrez le menu  pour ouvrir le dialogue d'exécution de la macro.



7 : La fenêtre des macros s'ouvre, sélectionnez votre macro et cliquez sur le bouton



8 : Votre macro est exécutée entrez les données et cliquez sur le bouton





Exemples de code erroné dû à des erreurs d'indentation
L'indentation dans la programmation Python est très importante et fait partie intégrante du code, un espace ou un décalage inapproprié provoque une erreur d'indentation et la macro ne s'exécute pas ex :

This section describes some errors that may be encountered when copying and pasting, and writing macro code.

 : ('expected an indented block', ('C:/Users/d/AppData/Roaming/FreeCAD/Macro_Apothem_Based_Prism_GUI.FCMacro', 21, 3, 'def priSm(self):\n'))

1 : Dans cet exemple le code a été collé sans aucune indentation et bien sûr ne fonctionne pas ! ici certainement une erreur du programmeur au moment de coller son code sur la page car il n'aurait jamais su le faire fonctionner.

If the code lacks any indentation, the code won't work. Class and function definitions, as well as control structures  should be followed by a block of indented code.

This error is possible if the user doesn't copy the code correctly, and all spaces are accidentally removed.



2 : le code a été corrigé les indentations sont à la bonne place.



3 : nous sélectionnons le code et nous voyons que la sélection est bien au bord du code, la macro doit fonctionner tout va bien



4 : Ici un espace supplémentaire est sélectionné (ça peut arriver) vous devez alors copier le code dans un traitement de texte pour supprimer un espace dans toutes les lignes

If an additional space is introduced at the beginning of all lines, the Python interpreter will fail and complain about unnecessary indentation. In this case, all lines need the initial space removed.



5 : Ici le code a été copié dans une fenêtre du forum avec le bouton apparemment la sélection est bonne

Here the code has been copied from a forum thread by using the button. Apparently the selection is good.



6 : Mais la sélection collée dans l'éditeur de FreeCAD donne une surprise, une indentation de quatre espaces a été ajoutée par le système ? le code n'est pas bon



7 : Vous devez effacer tous les espaces supplémentaires c'est à dire quatre espaces à chaque ligne (pour Windows le traitement de textes notepad-plus-plus permet sélection verticale avec une combinaison de touches + Mouse dragging ou Menu > Édition > Indentation > Réduire l'indentation)

In Windows, Notepad++ can perform selection with + Mouse dragging, and then use.



8 : Ici la sélection prend aussi les numéros de colonne qui donnera aussi une erreur

Here the selection also selects the line numbers in the code example. If this selection is pasted into the macro editor, it won't work. All line numbers need to be removed, and the spaces adjusted so that the Python code has the proper indentation.



9 : Code parfait.



Pour ceux qui ne voient aucune information s'afficher.
Certaines macros affichent des informations à l'écran en général elles s'affichent dans la Vue rapport

Macros may output information to the report view to detail what the code is doing when it is running.

If no information is displayed, make sure the report view and Python console are visible, and that the output is directed tot he report view.

FreeCAD utilise deux méthodes pour afficher les informations dans la fenêtre Vue rapport.

Printing information
FreeCAD macros have two methods to print information to the report view.

1 : Commandes

ou

Pour voir afficher ces renseignements dans la console vous devez :

1 : ouvrir FreeCAD





3 : cochez Vue rapport et Console python



4 : les fenêtres sont activées et disponibles et les commandes comme "App.Console.PrintMessage("Hello World!\n")" seront affichées dans la "Vue rapport"



2 : la commande "print" qui est une commande Python

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



2 : dans la nouvelle fenêtre, cliquez sur Général et sélectionnez l'onglet Fenêtre de sortie



3 : cochez les deux cases:

Rediriger les messages internes Python vers la Vue rapport

Rediriger les erreurs internes de Python vers la Vue rapport

et validez en cliquant sur le bouton