Eseguire automaticamente una macro all'avvio

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

Other languages:
English • ‎français • ‎italiano

Prefazione

Questa documentazione spiega come impostare una macro in modo che venga eseguita automaticamente all'avvio di FreeCAD.

Prima di iniziare, bisogna considerare le seguenti cose :

  • L'esecuzione automatica di macro all'avvio può essere considerata un rischio per la sicurezza. Si devono eseguire solo delle macro fidate e testate in precedenza.
  • Per seguire questa procedura bisogna avere alcune nozioni di Python e di codifica.
  • Quando si fa riferimento a delle cartelle utente ('Mod', 'Macro', ...), esse si trovano nella cartella FreeCAD dell'utente. È possibile trovarle in Avvio e configurazione → Informazioni relative all'utente
  • Questo comportamento non dovrebbe essere utilizzato per le macro che si occupano della modellazione delle parti. Questo è più appropriato per le macro che aggiungono funzionalità, migliorano l'interfaccia utente, ...

Come fare

Preparare la macro

In genere, una macro non è pensata e fatta per essere eseguita all'avvio, quindi deve essere ottimizzata.

Prendere in considerazione la macro sottostante, memorizzata nella propria cartella 'Macro' con il nome 'MySuperMacro.FCMacro':

## Import section ##
from PySide import QtGui

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

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

##Main instruction section
MyMsgBox()

Tutte le macro presentano generalmente una struttura simile con prima sezione di importazione, quindi una sezione di definizione e infine una sezione di istruzione principale. Ci concentreremo su quest'ultima sezione perché le istruzioni principali sono in realtà quelle che 'eseguono' la macro (sono abbastanza facili da individuare perché cominciano all'inizio della riga). Nel passaggio successivo, bisogna importare la macro a livello di codice, quindi eseguirla. Questo non può essere fatto con la struttura effettiva della macro. Per poterlo fare, bisogna racchiudere le istruzioni principali in una funzione --eg. run()-- quindi assicurarsi che questa funzione sia ancora chiamata quando la macro viene eseguita manualmente dall'utente. Se non si è completamente sicuri di ciò che si sta facendo, è meglio lavorare su una copia della macro (anche per conservare l'originale della macro). Il file originale deve essere modificato come segue:

from PySide import QtGui
##The 2 below lines shall be added if not already present to ensure FreeCAD modules are imported
import FreeCAD as App
import FreeCADGui as Gui

class MyMsgBox(QtGui.QMessageBox):

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

##Enclose the main instructions in a function
def run():
    MyMsgBox()

##Ensure main instructions are still called in case of manal run
if __name__ == '__main__':
    run()

Ovviamente se la funzione 'run()' esiste già nella macro, si può usare qualsiasi altro nome. Ora la macro è pronta per essere integrata nell'avvio di FreeCAD.

Integrare la macro nell'avvio di FreeCAD

Innanzitutto creare una nuova cartella nella cartella "Mod" dell'utente, ad esempio "MacroStartup". Copiare la macro modificata in questa cartella appena creata e rinominala con un'estensione '.py' se questo non è ancora il caso (nota che se sviluppi la macro da solo, può essere nominata con l'estensione ".py" anche in la cartella "Macro" in modo che non sia necessario rinominare durante la copia). Infine, creare nella stessa cartella un file chiamato "InitGui.py" in cui inserire il seguente codice:

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

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

##Connect the function that runs the macro to the appropriate signal
FreeCADGui.getMainWindow().workbenchActivated.connect(runMacro)

Notare che viene eseguita solo una volta. Se si vuole eseguire più di una macro, bisogna semplicemente aggiungere le altre nello stesso file (guardare i commenti sul codice precedente).

Il lavoro è finito. La macro dovrebbe essere eseguita automaticamente al prossimo avvio di FreeCAD.

Notare che se la macro originale è stata scaricata tramite Addon Manager, nel caso di aggiornamento essa viene sovrascritta e quindi è necessario eseguire di nuovo questi passaggi.