Extra python modules/it

Other languages:
Creare un Ambiente di lavoro
Documentazione del codice sorgente
Indice

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

PySide è 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, BIM, ecc. sono abilitati, dopo che FreeCAD è installato, significa che PySide è 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.

Installazione

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

MacOS

PySide 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: 

import PySide

Per accedere all'interfaccia di FreeCAD, digitare: 

from PySide import QtCore,QtGui
FreeCADWindow = FreeCADGui.getMainWindow()

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

FreeCADWindow.addDockWidget(QtCore.Qt.RghtDockWidgetArea,my_custom_widget)

Lavorare con Unicode: 

text = text.encode('utf-8')

Lavorare con QFileDialog e OpenFileName: 

path = FreeCAD.ConfigGet("AppHomePath")
#path = FreeCAD.ConfigGet("UserAppData")
OpenName, Filter = PySide.QtGui.QFileDialog.getOpenFileName(None, "Read a txt file", path, "*.txt")

Lavorare con QFileDialog e SaveFileName: 

path = FreeCAD.ConfigGet("AppHomePath")
#path = FreeCAD.ConfigGet("UserAppData")
SaveName, Filter = PySide.QtGui.QFileDialog.getSaveFileName(None, "Save a file txt", path, "*.txt")

Documentazione aggiuntiva

Pivy

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 macOS, purtroppo, è necessario compilare pivy da soli.

Installazione

Prerequisiti

Si presume 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: 

patch -p1 < ../pivy_0.5.0~svn765-2.diff

poi 

debuild

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:

Informazioni da aggiungere.

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

./configure
make
make install (or checkinstall if you use it)

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 macOS (vedere sotto), mentre pare si costruisca bene su Fedora Core 15.

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

python setup.py build

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

python setup.py install (or checkinstall python setup.py install)

Questo è tutto. Pivy è installato.

MacOS

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: 

hg clone http://hg.sim.no/Pivy/default Pivy

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

port install mercurial

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

port install swig

C'è bisogno anche di: 

port install swig-python

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

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: 

python setup.py build
sudo python setup.py install

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: 

set PATH=path_to_python_3.x;%PATH%

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

Informazioni da aggiungere.

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 

set PATH=path_to_swig_1.3.25;%PATH%

e impostare il percorso appropriato per COINDIR 

set COINDIR=path_to_coin

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: 

python setup.py build

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 

set INCLUDE=%INCLUDE%;path_to_coin_include_dir

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

set INCLUDE=%INCLUDE%;path_to_soqt_include_dir

e infine impostare le intestazioni di Qt 

set INCLUDE=%INCLUDE%;path_to_pyside\include\Qt

Se si utilizza la Express Edition di Visual Studio si potrebbe ricevere un'eccezione keyerror di Python. In questo caso è necessario modificare alcune parti in msvccompiler.py, che si trova nella propria installazione di Python.

Andare alla riga 122 e sostituire la riga 

vsbase = r"Software\Microsoft\VisualStudio\%0.1f" % version

con 

vsbase = r"Software\Microsoft\VCExpress\%0.1f" % version

Quindi riprovare di nuovo. Se si riceve un secondo errore del tipo 

error: Python was built with Visual Studio 2003;...

è necessario sostituire anche la riga 128 

self.set_macro("FrameworkSDKDir", net, "sdkinstallrootv1.1")

con 

self.set_macro("FrameworkSDKDir", net, "sdkinstallrootv2.0")

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

error: Python was built with Visual Studio version 8.0, and extensions need to be built with the same version of the compiler, but it isn't installed.

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

echo %DISTUTILS_USE_SDK%
echo %MSSDK%

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

set DISTUTILS_USE_SDK=1
set MSSDK=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: 

import pivy

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

from pivy import coin
App.newDocument() # Open a document and a view
view = Gui.ActiveDocument.ActiveView
FCSceneGraph = view.getSceneGraph() # returns a pivy Python object that holds a SoSeparator, the main "container" of the Coin scenegraph
FCSceneGraph.addChild(coin.SoCube()) # add a box to scene

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:

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

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

Linux

sudo apt-get install python3-collada

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

import collada

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

Linux AppImages e Snaps

Incollare questo codice nella Console Python: 

import addonmanager_utilities as utils
import subprocess
import os

if hasattr(utils, "get_python_exe"):
    # For v0.21:
    python_exe = utils.get_python_exe()
else:
    # For v0.22/v1.0:
    from freecad.utils import get_python_exe

python_exe = get_python_exe()
vendor_path = utils.get_pip_target_directory()
if not os.path.exists(vendor_path):
    os.makedirs(vendor_path)

subprocess.run(
    [
        python_exe,
        "-m",
        "pip",
        "install",
        "--disable-pip-version-check",
        "--target",
        vendor_path,
        "pycollada",
    ],
    stdout=subprocess.PIPE,
    stderr=subprocess.PIPE,
    timeout=120,
    check=True,
)

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.

MacOS

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

Se è necessario installare pip: 

$ sudo easy_install pip

Installare pycollada: 

$ sudo pip install pycollada

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

$ pip install --target="/Applications/FreeCAD.app/Contents/lib/python3.x/site-packages" pycollada

o dopo aver scaricato il codice pycollada 

$ export PYTHONPATH=/Applications/FreeCAD\ 0.16.6706.app/Contents/lib/python3.x/site-packages:$PYTHONPATH
$ python setup.py install --prefix=/Applications/FreeCAD\ 0.2x.yyyy.app/Contents

IfcOpenShell

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, l'Ambiente BIM 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

Linux

Le istruzioni di installazione possono essere trovate qui.

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

import ifcopenshell

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

Windows e macOS

IfcOpenShell è incluso sia nella versione di FreeCAD che nelle build per sviluppatori, quindi non sono necessari passaggi aggiuntivi.

Link

Tutorial Importare e Esportare IFC - compilare IfcOpenShell

LazyLoader

LazyLoader è un modulo Python che consente il caricamento differito, pur continuando a importare all'inizio dello script. Ciò è utile se stai importando un altro modulo che è lento e viene utilizzato più volte durante lo script. L'utilizzo di LazyLoader può migliorare i tempi di avvio del workbench, ma il modulo dovrà comunque essere caricato al primo utilizzo.

Installazione

LazyLoader è incluso in FreeCAD v0.19

Utilizzo

Dovrai importare LazyLoader, quindi modificare l'importazione di qualsiasi modulo desideri rinviare. 

from lazy_loader.lazy_loader import LazyLoader
Part = LazyLoader('Part', globals(), 'Part')

La variabile Part è il nome del modulo nel tuo script. È possibile replicare "importa parte come P" modificando la variabile. 

P = LazyLoader('Part', globals(), 'Part')

Si può anche importare un modulo da un pacchetto. 

utils = LazyLoader('PathScripts', globals(), 'PathScripts.PathUtils')

Non si può importare singole funzioni, solo interi moduli.

Link


Creare un Ambiente di lavoro
Documentazione del codice sorgente
Indice
User documentation