Macro at Startup/fr

= Synopsis=

Cette documentation explique comment configurer une macro pour qu'elle s'exécute automatiquement au démarrage de FreeCAD.

Avant de commencer, les points suivants doivent être pris en compte:
 * L'exécution automatique d'une macro au démarrage peut être considérée comme un risque pour la sécurité. Vous ne devez exécuter que des macros fiables et testées auparavant
 * Vous avez probablement besoin de quelques notions de Python et de codage pour suivre cette procédure
 * Lorsque les dossiers utilisateur ('Mod', 'Macro', ...) sont mentionnés, ils se trouvent dans votre dossier utilisateur FreeCAD. Vous pouvez les localiser au démarrage et à la configuration → Informations relatives à l'utilisateur
 * Cela ne devrait pas être fait pour les macros traitant de la modélisation de pièces. Ceci est plutôt approprié pour les macros qui ajoutent des fonctionnalités en améliorant l'interface utilisateur, ...

= Comment =

Préparer la macro
Généralement, il arrivera qu'une macro ne soit pas directement compatible avec un lancement au démarrage et devra être ajustée

Considérez la macro ci-dessous que vous avez téléchargée quelque part et qui est stockée dans votre dossier 'Macro' avec le nom 'MySuperMacro.FCMacro': from PySide import QtGui
 * 1) Import section ##

class MyMsgBox(QtGui.QMessageBox):
 * 1) Definition section (classes, functions, ...)

def __init__(self): super(MyMsgBox, self).information(None, "MyTitle", "MyText")

MyMsgBox Toutes les macros présentent généralement une structure similaire avec une première section d'importation, puis une section de définition et enfin une section d'instruction principale. Nous allons nous concentrer sur ce dernier point car les instructions principales (elles sont assez faciles à repérer car elles commencent au début de la ligne) sont en réalité celles qui "exécutent" la macro. Pour une étape ultérieure, nous devrons importer la macro avec un programme puis l'exécuter. Cela ne peut pas être fait avec la structure réelle de la macro. Pour pouvoir le faire, nous devons inclure les instructions principales dans une fonction - par exemple. run - puis assurez-vous que cette fonction est toujours appelée lorsque la macro est exécutée manuellement par l'utilisateur. Si vous n'êtes pas totalement sûr de ce que vous faites, il est conseillé de travailler sur une copie de la macro (ou vous pouvez simplement vouloir conserver la macro d'origine telle quelle). Le fichier d'origine doit être modifié comme suit: from PySide import QtGui import FreeCAD as App import FreeCADGui as Gui
 * 1) Main instruction section
 * 1) The 2 below lines shall be added if not already present to ensure FreeCAD modules are imported

class MyMsgBox(QtGui.QMessageBox):

def __init__(self): super(MyMsgBox, self).information(None, "MyTitle", "MyText")

def run: MyMsgBox
 * 1) Enclose the main instructions in a function

if __name__ == '__main__': run Bien sûr, si la fonction "run" existe déjà dans la macro, vous pouvez choisir n'importe quel autre nom commode. La macro est maintenant prête à être intégrée au démarrage de FreeCAD.
 * 1) Ensure main instructions are still called in case of manal run

Intégration au démarrage de FreeCAD
Commencez par créer un nouveau dossier dans votre dossier utilisateur "Mod" de appelé "MacroStartup". Copiez la macro modifiée dans ce dossier nouvellement créé et renommez-la avec une extension ".py" si ce n'est pas encore le cas (notez que si vous développez la macro vous-même, vous pouvez également la nommer avec l'extension ".py" dans le dossier "Macro" pour ne pas avoir à le renommer lors de la copie). Enfin, créez dans le même dossier un fichier appelé "InitGui.py" qui contient le code suivant: def runMacroStartup(name): #Do not run when NoneWorkbench is activated because UI isn't yet completely there if name != "NoneWorkbench": #Run macro only once by disconnecting the signal at first call FreeCADGui.getMainWindow.workbenchActivated.disconnect(runMacroStartup) ##Following 2 lines shall be duplicated for each macro to run import MySuperMacro MySuperMacro.run ##Eg. if a second macro shall be launched at startup #import MyWonderfulMacro #MyWonderfulMacro.run

import __main__ __main__.runMacro = runMacro
 * 1) The following 2 lines are important because InitGui.py files are passed to the exec function...
 * 2) ...and the runMacro wouldn't be visible outside. So explicitly add it to __main__

FreeCADGui.getMainWindow.workbenchActivated.connect(runMacro) Notez que cela ne sera fait qu'une fois. Si vous souhaitez exécuter plus d'une macro, vous pouvez simplement ajouter les autres macros dans le même fichier (consultez les commentaires sur le code ci-dessus).
 * 1) Connect the function that runs the macro to the appropriate signal

Nous avons finis. Votre macro devrait s'exécuter automatiquement au prochain lancement de FreeCAD.

Notez que si la macro originale a été téléchargée via le gestionnaire d’addon, elle sera écrasée lors de la mise à jour et vous devrez donc à nouveau suivre les étapes décrites ici.