Extra python modules/it

Introduzione
Questa pagina elenca alcuni moduli Python aggiuntivi o altre parti di software che possono essere scaricati gratuitamente da internet, e che aggiungono funzionalità alla vostra installazione FreeCAD.

PySide (sostituisce PyQt4)

 * homepage (PySide): http://qt-project.org/wiki/PySide
 * licenza: LGPL
 * optional, ma è necessario per diversi moduli: Draft, Arch, Ship, Plot, OpenSCAD, Spreadsheet

PySide (precedentemente PyQt) è richiesto da diversi moduli di FreeCAD per accedere all'interfaccia Qt di FreeCAD. È già incluso nella versione per windows di FreeCAD, e di solito su Linux è installato automaticamente da FreeCAD quando l'installazione viene fatta dai repository ufficiali. Se i moduli Draft, Arch, ecc. sono abilitati, dopo che FreeCAD è installato, significa che PySide (precedentemente PyQt) è presente e non è più necessario fare nulla.

Note:

In FreeCAD, PyQt4 diventerà progressivamente obsoleto dopo la versione 0.13, a favore di PySide, che fa esattamente lo stesso lavoro, ma ha una licenza (LGPL) più compatibile con FreeCAD.

Linux
Il modo più semplice per installare PySide è attraverso il gestore dei pacchetti della propria distribuzione. Su sistemi Debian/Ubuntu, il nome del pacchetto è generalmente python-PySide, mentre per i sistemi basati su RPM viene chiamato pyside. Le dipendenze necessarie (Qt e SIP) si installano automaticamente.

Windows
Il programma può essere scaricato da http://qt-project.org/wiki/Category:LanguageBindings::PySide::Downloads. Prima di installare PyQt4 è necessario installare le librerie Qt e SIP (operazioni da documentare).

MacOSX
PyQt può essere installato su Mac tramite homebrew oppure port. Per maggiori informazioni, vedere Installare le dipendenze.

Utilizzo
Dopo l'installazione, è possibile verificare che tutto funzioni digitando nella console Python di FreeCAD:

Per accedere all'interfaccia di FreeCAD, digitare:

Quindi si può iniziare ad esplorare l'interfaccia con il comando dir. È possibile aggiungere nuovi elementi, ad esempio un widget personalizzato, con comandi come:

Lavorare con Unicode

Lavorare con QFileDialog e OpenFileName :

Lavorare con QFileDialog e SaveFileName :

Esempio di passaggio da PyQt4 a PySide
Nota: questi sono esempi di errori riscontrati nella transizione da PyQt4 verso PySide con le correzioni che sono state fatte. Con gli esempi precedenti sono certamente possibili altre soluzioni

Per accedere all'interfaccia di FreeCAD, digitare:

è possibile aggiungere nuovi elementi, come un widget personalizzato, con comandi come:

Lavorare con Unicode

Lavorare con QFileDialog e OpenFileName :

Lavorare con QFileDialog e SaveFileName :

Il MessageBox:

Lavorare con setProperty (PyQt4) e setValue (PySide)

sostituire con:

Lavorare con setToolTip

sostituire con:

oppure:

Documentazione
Ecco alcuni tutorial di PyQt4 (che spiegano come costruire interfacce con Qt Designer da utilizzare con Python):
 * http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/classes.html - il riferimento ufficiale delle API di PyQt4
 * http://www.rkblog.rk.edu.pl/w/p/introduction-pyqt4/ - una semplice introduzione
 * http://www.zetcode.com/tutorials/pyqt4/ - un manuale molto approfondito e completo

Pivy

 * homepage: https://bitbucket.org/Coin3D/coin/wiki/Home
 * licenza: BSD
 * optional, ma è necessario per alcuni moduli di FreeCAD: Draft, Arch

Pivy serve a alcuni moduli per accedere alla visualizzazione 3D di FreeCAD. Su Windows, Pivy è già in impacchettato nel programma di installazione FreeCAD, e su Linux solitamente è installato automaticamente quando si installa FreeCAD da un repository ufficiale. Su MacOSX, purtroppo, è necessario compilare pivy da soli.

Prerequisiti
Credo che prima di compilare Pivy si desideri avere Coin e SoQt installati.

Per compilarlo su Mac è sufficiente installare il pacchetto binario Coin3. Il tentativo di installare Coin da MacPorts è stato problematico: ha cercato di aggiungere un sacco di pacchetti di X Windows e alla fine il tentativo è fallito con un errore di script.

Per Fedora ho trovato un RPM con Coin3

SoQt compilato da codice sorgente funziona bene su Mac e Linux.

Debian & Ubuntu
A partire da Debian Squeeze e Ubuntu Lucid, Pivy sarà disponibile direttamente dai repository ufficiali e questo eviterà un sacco di problemi.

Nel frattempo, è possibile scaricare uno dei pacchetti che abbiamo creato (per Debian e Ubuntu Karmic) e disponibili nelle pagine Download, o compilarlo da soli.

Il modo migliore per compilare facilmente Pivy è quello di prendere il pacchetto sorgente di Debian per Pivy e creare un pacchetto con debuild.

È lo stesso codice sorgente dal sito ufficiale di Pivy, ma la comunità di Debian vi ha fatto diverse aggiunte bug-fixing.

Si compila bene anche su Ubuntu Karmic: http://packages.debian.org/squeeze/python-pivy. Scaricare i file .orig.gz e .diff.gz, poi decomprimerli entrambi, quindi applicare .diff al codice sorgente: andare nella cartella del codice sorgente decompresso di Pivy, e applicare la patch .diff:

poi

per avere Pivy correttamente costruito in un pacchetto ufficiale installabile. Dopo è sufficiente installare il pacchetto con gdebi.

Altre distribuzioni Linux
Prima di tutto scaricare gli ultimi sorgenti dai repository del progetto:

A partire dal marzo 2012, l'ultima versione è Pivy-0.5.

In seguito serve uno strumento chiamato SWIG per generare il codice C++ per i binding di Python. Pivy-0.5 segnala che è stato testato solo con SWIG 1.3.31, 1.3.33, 1.3.35 e 1.3.40. Perciò si può scaricare un tarball del codice sorgente di una di queste vecchie versioni da http://www.swig.org. Poi scompattarlo e da una riga di comando fare (come root):

Impiega appena pochi secondi per costruirsi.

In alternativa, si può provare la costruzione con un SWIG più recente. A partire dal marzo 2012 la versione tipica del repository è la 2.0.4. Pivy presenta un piccolo problema di compilazione con SWIG 2.0.4 su Mac OS (vedere sotto), mentre pare si costruisca bene su Fedora Core 15.

Dopo le operazioni precedenti andare nel sorgente di Pivy e eseguire:

per creare i file sorgente. Notare che la generazione può produrre migliaia di avvisi, ma fortunatamente non ci sono errori.

Questo è probabilmente obsoleto, ma si può incorrere in un errore di compilazione in cui una 'const char*' non può essere convertita in una 'char*'. Per risolvere il problema basta scrivere una 'const' prima nelle righe appropriate. Si devono correggere sei righe.

Dopo di che, installare digitando (come root):

Questo è tutto. Pivy è installato.

Mac OS
Queste istruzioni potrebbero non essere complete. Qualcosa di simile a questo ha funzionato per OS 10,7 dopo marzo 2012. Io uso MacPorts come repository, ma dovrebbero funzionare anche le altre opzioni.

Per quanto riguarda Linux, scaricare l'ultimo codice sorgente:

Se non si dispone di hg, è possibile ottenerlo da MacPorts:

Poi, come prima, è necessario SWIG. Si tratta di fare:

Ho scoperto che avevo bisogno anche di:

Da marzo 2012, la versione di SWIG in MacPorts è la 2.0.4. Come detto in precedenza per Linux, potrebbe essere meglio scaricare una versione precedente. SWIG 2.0.4 sembra avere un bug che blocca la costruzione di Pivy. Vedere il primo messaggio in questa raccolta: https://sourceforge.net/mailarchive/message.php?msg_id=28114815

Questo problema può essere corretto modificando i 2 percorsi del codice sorgente per aggiungere dereferenziazioni: arg4 *, * arg5 al posto di arg4, arg5. Ora si può costruire Pivy:

Windows
Supponendo di utilizzare Visual Studio 2005 o versioni successive è necessario aprire un prompt dei comandi con 'Visual Studio 2005 Command prompt' dal menu Strumenti. Se l'interprete Python non è ancora nel percorso di sistema fare:

Per avere pivy funzionante si devono scaricare gli ultimi sorgenti dal repository del progetto:

Dopo serve lo strumento chiamato SWIG per generare il codice C++ per i binding con Python. Si raccomanda di utilizzare la versione 1.3.25 di SWIG, non l'ultima versione, perché al momento pivy funziona correttamente solo con la 1.3.25. Scaricare i file binari per 1.3.25 da http://www.swig.org. Poi scompattarli e dalla riga di comando aggiungerli al percorso di sistema

e impostare il percorso appropriato per COINDIR

Su Windows il file di configurazione di pivy si aspetta SoWin invece di SoQt come predefinito. Non ho trovato un modo valido per costruirlo con SoQt, così ho modificato direttamente il file setup.py. Nella riga 200 è sufficiente rimuovere la parte 'sowin': ('gui._sowin', 'sowin-config', 'Pivy.gui.') (non rimuovere le parentesi di chiusura).

Successivamente andare nel sorgente di pivy e eseguire:

per creare i file sorgente. Si può incorrere nell'errore di compilazione 'header files couldn't be found' (file di intestazione non trovati). In questo caso, impostare la variabile INCLUDE

e, se le intestazioni di SoQt non sono nella stessa posizione delle intestazioni di Coin, impostare anche

e infine impostare le intestazioni di Qt

Se si utilizza la versione Express Edition di Visual Studio è possibile ottenere un'eccezione di errore di chiave di Python (KeyError). In questo caso è necessario modificare alcune cose in msvccompiler.py situato nella propria installazione di Python.

Andare alla riga 122 e sostituire la riga

con

Riprovare di nuovo. Se si ottiene un secondo errore del tipo

è necessario sostituire anche la riga 128

con

Riprovare ancora una volta. Se si ottiene di nuovo un errore quale

allora si deve controllare le variabili d'ambiente DISTUTILS_USE_SDK e MSSDK con

Se non sono ancora impostate basta impostarle, ad esempio, a 1

Ora, si può incorrere in un errore di compilazione in cui una 'const char *' non può essere convertita in una 'char *'. Per risolvere il problema basta scrivere una 'const' prima nelle righe appropriate. Ci sono sei righe da correggere.

Infine, copiare la directory di pivy generata in un posto dove l'interprete di Python di FreeCAD possa trovarla.

Utilizzo
Per verificare se Pivy è installato correttamente:

Per consentire a Pivy di accedere al grafo di scena (Scenegraph) di FreeCAD effettuare le seguenti operazioni:

Ora è possibile esplorare FCSceneGraph con il comando dir.

Documentazione aggiuntiva
Purtroppo in rete la documentazione su Pivy è ancora quasi inesistente. Ma può essere utile la documentazione di Coin, in quanto Pivy semplicemente traduce le funzioni di Coin, i nodi e i metodi in Python, tutto mantiene lo stesso nome e le stesse proprietà, tenendo presente la differenza di sintassi tra C e Python:


 * http://doc.coin3d.org/Coin/classes.html - Coin3D API Reference
 * http://www-evasion.imag.fr/~Francois.Faure/doc/inventorMentor/sgi_html/index.html - The Inventor Mentor - La "Bibbia" del linguaggio di descrizione della scena di Inventor.

Potete anche esplorare il file Draft.py nella cartella Mod/Draft di FreeCAD, dato che che in esso si fa un grande uso di pivy.

pyCollada

 * homepage: http://pycollada.github.com
 * license: BSD
 * optional, necessario per consentire di importare ed esportare i file di Collada (.DAE)

pyCollada è una libreria di Python che permette ai programmi di leggere e di scrivere i file di Collada (*.DAE). Quando pyCollada è installato sul sistema, FreeCAD lo rileva e aggiunge le opzioni di importazione e di esportazione per gestire l'apertura e il salvataggio di file nel formato Collada.

Installazione
Pycollada in genere non è ancora disponibile nei repository delle distribuzioni Linux, ma dato che è composto solo di file Python, non richiede la compilazione, ed è facile da installare. Si può installare in 2 modi, o direttamente dal repository git ufficiale di pycollada, o con lo strumento easy_install.

Linux
In entrambi i casi, è necessario che nel sistema siano già installati i seguenti pacchetti:

Con easy_install
Supponendo di avere già una installazione completa di Python, l'utilità easy_install dovrebbe essere già presente:

Si può controllare se pycollada è stato installato correttamente digitando in una console python:

Se non viene restituito nulla (nessun messaggio di errore), allora tutto è OK

Windows
Su Windows, dalla versione 0.15, pycollada è incluso in FreeCAD sia nella versione di rilascio che in quella di sviluppo quindi non sono più necessari ulteriori passaggi.

Mac OS
Se si utilizza la build Homebrew di FreeCAD è possibile installare pycollada nel proprio sistema Python utilizzando pip.

Se è necessario installare pip:

Installare pycollada:

Se si utilizza una versione binaria di FreeCAD, si può dire a pip di installare pycollada all'interno di FreeCAD.app:

o dopo aver scaricato il codice pycollada

IfcOpenShell

 * homepage: http://www.ifcopenshell.org
 * licenza: LGPL
 * optional, necessario per consentire di importare i file IFC

IFCOpenShell è una libreria attualmente in fase di sviluppo, che permette di importare (e presto di esportare) file Industry foundation Classes (*.IFC). IFC è una estensione per il formato STEP, e sta diventando lo standard nei processi di lavoro BIM. Quando ifcopenshell è installato correttamente nel vostro sistema, il modulo Arch di FreeCAD è grado di rilevarlo e usarlo per importare i file IFC. Poiché ifcopenshell si basa su OpenCascade, come FreeCAD, la qualità della importazione è molto buona, producendo geometria solida di alta qualità.

Installazione
Dato che ifcopenshell è abbastanza recente, dovrete probabilmente compilarla da soli.

Linux
Per compilare ifcopenshell serve che sul sistema siano installati un paio di pacchetti di sviluppo:

ma dato che anche FreeCAD richiede tutti questi pacchetti, se è possibile compilare FreeCAD, non serve alcun dipendenza in più per compilare IfcOpenShell.

Prelevare l'ultimo codice sorgente da:

Il processo di costruzione è molto semplice:

o, se si utilizza Oce invece di OpenCascade:

Siccome ifcopenshell è fatto principalmente per Blender, utilizza python3 di impostazione predefinita. Per usarlo dentro FreeCAD, è necessario compilarlo contro la stessa versione di Python che viene utilizzata da FreeCAD. Quindi potrebbe essere necessario forzare la versione di Python con parametri aggiuntivi cmake (adattare per la vostra versione di Python):

Poi:

Si può controllare se ifcopenshell è stato installato correttamente digitando in una console python:

Se non viene restituito nulla (nessun messaggio di errore), allora tutto è OK

Windows
Nota: I programmi di installazione di FreeCAD ufficiali ottenuti dal website/github di FreeCAD contengono già ifcopenshell.

Copiato dal file README di IfcOpenShell

Users are advised to use the Visual Studio .sln file in the win/ folder. For Windows users a prebuilt Open CASCADE version is available from the http://opencascade.org website. Download and install this version and provide the paths to the Open CASCADE header and library files to MS Visual Studio C++.

For building the IfcPython wrapper, SWIG needs to be installed. Please download the latest swigwin version from http://www.swig.org/download.html. After extracting the .zip file, please add the extracted folder to the PATH environment variable. Python needs to be installed, please provide the include and library paths to Visual Studio.

Link
Tutorial Importare e Esportare IFC - compilare IfcOpenShell

Installazione
Su tutte le piattaforme, basta installare il pacchetto appropriato da https://www.opendesign.com/guestfiles/oda_file_converter. Se, dopo l'installazione, l'utility non viene trovata automaticamente da FreeCAD, può essere necessario impostare manualmente il percorso del file eseguibile del converter. Attivare l'ambiente Draft, poi nelle opzioni del menu Modifica → Preferenze → Draft → Importa/Esporta → DWG compilare il campo "Percorso del convertitore File Teigha" con il corretto percorso.

LazyLoader
LazyLoader is a python module that allows deferred loading, while still importing at the top of the script. This is useful if you are importing another module that is slow, and it is used several times throughout the script. Using LazyLoader can improve workbench startup times, but the module will still need to be loaded on first use.

Installation
LazyLoader is included with FreeCAD v0.19

Usage
You will need to import LazyLoader, then change the import of whatever module you want to be deferred.

The variable Part is how the module is named in your script. You can replicate "import Part as P" by changing the variable.

You can also import a module from a package.

You can't import individual functions, just entire modules.

Links

 * Original source: https://github.com/tensorflow/tensorflow/blob/master/tensorflow/python/util/lazy_loader.py
 * Further explanation: https://wil.yegelwel.com/lazily-importing-python-modules/
 * Code within the FreeCAD source code: https://github.com/FreeCAD/FreeCAD/tree/master/src/3rdParty/lazy_loader
 * Forum discussion: https://forum.freecadweb.org/viewtopic.php?f=10&t=45298