Dodatkowe moduły Python

From FreeCAD Documentation
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.
This page is a translated version of the page Extra python modules and the translation is 100% complete.

Informacje ogólne

Ta strona zawiera listę kilku dodatkowych modułów środowiska Python lub innych elementów oprogramowania, które można pobrać z Internetu i dodać do swojej instalacji FreeCAD.

PySide (poprzednio PyQt)

  • strona główna (PySide): http://qt-project.org/wiki/PySide
  • licencja: LGPL
  • opcjonalny, ale wymagany przez kilka modułów: Rysunek Roboczy, Architektura, Statek, Wykres, OpenSCAD, Arkusz Kalkulacyjny

PySide (wcześniej PyQt) jest wymagany przez kilka modułów FreeCAD, aby uzyskać dostęp do interfejsu Qt FreeCAD. Jest on już dołączony do wersji FreeCAD dla systemu Windows i jest zwykle instalowany automatycznie przez FreeCAD w systemie Linux podczas instalacji z oficjalnych repozytoriów. Jeśli te moduły (Rysunek Roboczy, Architektura itp.) są włączone po zainstalowaniu FreeCAD, oznacza to, że PySide (wcześniej PyQt) już tam jest i nie trzeba nic więcej robić.

Uwaga: FreeCAD stopniowo odchodził od PyQt po wersji 0.13, na rzecz PySide, który wykonuje dokładnie to samo zadanie, ale ma licencję (LGPL) bardziej kompatybilną z FreeCAD.

Instalacja

Linux

Najprostszym sposobem na zainstalowanie PySide jest skorzystanie z menedżera pakietów danej dystrybucji. W systemach Debian / Ubuntu nazwa pakietu to zazwyczaj python-PySide, podczas gdy w systemach opartych na RPM nosi on nazwę pyside. Niezbędne zależności (Qt i SIP) zostaną pobrane automatycznie.

Windows

Program można pobrać ze strony http://qt-project.org/wiki/Category:LanguageBindings::PySide::Downloads . Przed instalacją PySide należy zainstalować biblioteki Qt i SIP (co zostanie udokumentowane).

Mac OS

PySide na Maca może być zainstalowany przez homebrew lub port. Więcej informacji można znaleźć w Instalacja zależności.

Użycie

Po zainstalowaniu można sprawdzić, czy wszystko działa, wpisując w konsoli Python programu FreeCAD:

import PySide

Aby uzyskać dostęp do interfejsu programu FreeCAD, należy wpisać:

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

Teraz możesz zacząć poznawać interfejs za pomocą polecenia dir(). Możesz dodać nowe elementy, takie jak niestandardowy widżet, za pomocą poleceń takich jak:

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

Praca z Unicode:

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

Praca z QFileDialog i OpenFileName:

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

Praca z QFileDialog i SaveFileName:

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

Przykład przejścia z PyQt4 i PySide

PS: te przykłady błędów zostały znalezione podczas przejścia z PyQt4 na PySide i te poprawki zostały wprowadzone, inne rozwiązania są z pewnością dostępne w powyższych przykładach

try:
    import PyQt4                                        # PyQt4
    from PyQt4 import QtGui ,QtCore                     # PyQt4
    from PyQt4.QtGui import QComboBox                   # PyQt4
    from PyQt4.QtGui import QMessageBox                 # PyQt4
    from PyQt4.QtGui import QTableWidget, QApplication  # PyQt4
    from PyQt4.QtGui import *                           # PyQt4
    from PyQt4.QtCore import *                          # PyQt4
except Exception:
    import PySide                                       # PySide
    from PySide import QtGui ,QtCore                    # PySide
    from PySide.QtGui import QComboBox                  # PySide
    from PySide.QtGui import QMessageBox                # PySide
    from PySide.QtGui import QTableWidget, QApplication # PySide
    from PySide.QtGui import *                          # PySide
    from PySide.QtCore import *                         # PySide

Aby uzyskać dostęp do interfejsu FreeCAD, wpisz: Możesz dodawać nowe elementy, takie jak niestandardowy widżet, za pomocą poleceń takich jak:

myNewFreeCADWidget = QtGui.QDockWidget()          # create a new dockwidget
myNewFreeCADWidget.ui = Ui_MainWindow()           # myWidget_Ui()             # load the Ui script
myNewFreeCADWidget.ui.setupUi(myNewFreeCADWidget) # setup the ui
try:
    app = QtGui.qApp                              # PyQt4 # the active qt window, = the freecad window since we are inside it
    FCmw = app.activeWindow()                     # PyQt4 # the active qt window, = the freecad window since we are inside it
    FCmw.addDockWidget(QtCore.Qt.RightDockWidgetArea,myNewFreeCADWidget) # add the widget to the main window
except Exception:
    FCmw = FreeCADGui.getMainWindow()             # PySide # the active qt window, = the freecad window since we are inside it
    FCmw.addDockWidget(QtCore.Qt.RightDockWidgetArea,myNewFreeCADWidget) # add the widget to the main window

Praca z Unicode:

try:
    text = unicode(text, 'ISO-8859-1').encode('UTF-8')  # PyQt4
except Exception:
    text = text.encode('utf-8')                         # PySide

Praca z QFileDialog i OpenFileName:

OpenName = ""
try:
    OpenName = QFileDialog.getOpenFileName(None,QString.fromLocal8Bit("Lire un fichier FCInfo ou txt"),path,"*.FCInfo *.txt") # PyQt4
except Exception:
    OpenName, Filter = PySide.QtGui.QFileDialog.getOpenFileName(None, "Lire un fichier FCInfo ou txt", path, "*.FCInfo *.txt")#PySide

Praca z QFileDialog i SaveFileName:

SaveName = ""
try:
    SaveName = QFileDialog.getSaveFileName(None,QString.fromLocal8Bit("Sauver un fichier FCInfo"),path,"*.FCInfo") # PyQt4
except Exception:
    SaveName, Filter = PySide.QtGui.QFileDialog.getSaveFileName(None, "Sauver un fichier FCInfo", path, "*.FCInfo")# PySide

Okno dialogowe:

def errorDialog(msg):
    diag = QtGui.QMessageBox(QtGui.QMessageBox.Critical,u"Error Message",msg )
    try:
        diag.setWindowFlags(PyQt4.QtCore.Qt.WindowStaysOnTopHint) # PyQt4 # this function sets the window before
    except Exception:
        diag.setWindowFlags(PySide.QtCore.Qt.WindowStaysOnTopHint)# PySide # this function sets the window before
#    diag.setWindowModality(QtCore.Qt.ApplicationModal)       # function has been disabled to promote "WindowStaysOnTopHint"
    diag.exec_()

Praca z setProperty (PyQt4) i setValue (PySide)

self.doubleSpinBox.setProperty("value", 10.0) # PyQt4

zastąp:

self.doubleSpinBox.setValue(10.0) # PySide

Praca z setToolTip

self.doubleSpinBox.setToolTip(_translate("MainWindow", "Coordinate placement Axis Y", None)) # PyQt4

zastąp:

self.doubleSpinBox.setToolTip(_fromUtf8("Coordinate placement Axis Y")) # PySide

lub:

self.doubleSpinBox.setToolTip(u"Coordinate placement Axis Y.")# PySide

Dokumentacja dodatkowa

Pivy

Pivy jest wymagany przez kilka modułów, aby uzyskać dostęp do widoku 3D FreeCAD. W systemie Windows Pivy jest już dołączony do instalatora FreeCAD, a w systemie Linux jest zwykle instalowany automatycznie po zainstalowaniu FreeCAD z oficjalnego repozytorium. Na macOS niestety będziesz musiał samodzielnie skompilować pivy.

Instalacja

Wymagania wstępne

Myślę, że przed kompilacją Pivy będziesz chciał mieć zainstalowane Coin i SoQt.

Odkryłem, że do kompilacji na Macu wystarczy zainstalować Coin3 pakiet binarny. Próba zainstalowania monety z MacPorts była problematyczna: próbowałem dodać wiele pakietów X Windows i ostatecznie zawiesiłem się z błędem skryptu.

Dla Fedory znalazłem RPM z Coin3.

SoQt skompilowany ze źródła [1] działa dobrze na Macu i Linuksie.

Debian oraz Ubuntu

Począwszy od Debiana Squeeze i Ubuntu Lucid, pivy będzie dostępne bezpośrednio z oficjalnych repozytoriów, oszczędzając nam wiele kłopotów. W międzyczasie możesz pobrać jeden z pakietów (dla Debiana i Ubuntu Karmic) dostępnych na stronach pobierania lub skompilować go samodzielnie.

Najlepszym sposobem na łatwą kompilację pivy jest pobranie pakietu źródłowego Debiana dla pivy i utworzenie pakietu za pomocą debuild. Jest to ten sam kod źródłowy z oficjalnej strony pivy, ale ludzie z Debiana dodali kilka poprawek błędów. Kompiluje się również dobrze na ubuntu karmic: http://packages.debian.org/squeeze/python-pivy pobierz plik .orig.gz i .diff.gz, następnie rozpakuj oba, a następnie zastosuj .diff do źródła: przejdź do rozpakowanego folderu źródłowego pivy i zastosuj łatkę .diff:

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

wtedy:

debuild

aby pivy zostało poprawnie wbudowane w oficjalny pakiet instalacyjny. Następnie wystarczy zainstalować pakiet za pomocą gdebi.

Inne dystrybucje linuksa

Najpierw pobierz najnowsze źródła z repozytorium projektu:

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

Od marca 2012 r. najnowszą wersją jest Pivy-0.5.

Następnie potrzebne jest narzędzie o nazwie SWIG do generowania kodu C++ dla wiązań Python. Pivy-0.5 informuje, że był testowany tylko z SWIG 1.3.31, 1.3.33, 1.3.35 i 1.3.40. Możesz więc pobrać źródłowy tarball dla jednej z tych starych wersji z http://www.swig.org. Następnie rozpakuj go i z wiersza poleceń wykonaj (jako root):

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

Jego utworzenie zajmuje zaledwie kilka sekund.

Alternatywnie, można spróbować kompilacji z nowszą wersją SWIG. Od marca 2012, typową wersją repozytorium jest 2.0.4. Pivy ma niewielki problem z kompilacją z SWIG 2.0.4 na macOS (patrz poniżej), ale wydaje się, że kompiluje się dobrze na Fedora Core 15.

Następnie przejdź do źródeł pivy i wywołaj:

python setup.py build

która tworzy pliki źródłowe. Zauważ, że build może wygenerować tysiące ostrzeżeń, ale miejmy nadzieję, że nie będzie żadnych błędów.

Prawdopodobnie jest to przestarzałe, ale możesz napotkać błąd kompilatora, w którym 'const char*' nie może zostać przekonwertowane na 'char*'. Aby to naprawić, wystarczy napisać "const" przed odpowiednimi liniami. Do naprawienia jest sześć linii.

Następnie zainstaluj, wydając polecenie (jako root):

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

To wszystko, pivy jest zainstalowany.

Mac OS

Te instrukcje mogą nie być kompletne. Coś zbliżonego do tego działało dla OS 10.7 od marca 2012. Używam MacPorts dla repozytoriów, ale inne opcje powinny również działać.

As for linux, get the latest source:

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

Jeśli nie masz hg, możesz go pobrać z MacPorts:

port install mercurial

Następnie, jak wyżej, potrzebujesz SWIG. Powinno to być kwestią:

port install swig

Okazało się, że potrzebowałem również:

port install swig-python

Od marca 2012, MacPorts SWIG jest w wersji 2.0.4. Jak wspomniano powyżej dla linuxa, może być lepiej pobrać starszą wersję. SWIG 2.0.4 wydaje się mieć błąd, który zatrzymuje budowanie Pivy. Zobacz pierwszą wiadomość w tym streszczeniu.

Można to poprawić, edytując 2 lokalizacje źródłowe, aby dodać odsyłacze: *arg4, *arg5 zamiast arg4, arg5. Teraz Pivy powinien się zbudować:

python setup.py build
sudo python setup.py install

Windows

Zakładając, że używasz Visual Studio 2005 lub nowszego, powinieneś otworzyć wiersz polecenia za pomocą "Wiersz polecenia Visual Studio 2005" z menu Narzędzia. Jeśli interpreter Python nie znajduje się jeszcze w ścieżce systemowej, wykonaj następujące czynności:

set PATH=path_to_python_2.5;%PATH%

Aby uruchomić pivy, należy pobrać najnowsze źródła z repozytorium projektu:

svn co https://svn.coin3d.org/repos/Pivy/trunk Pivy

Następnie potrzebne jest narzędzie o nazwie SWIG do generowania kodu C++ dla wiązań Pythona. Zaleca się użycie wersji 1.3.25 SWIG, nie najnowszej, ponieważ w tej chwili pivy będzie działać poprawnie tylko z wersją 1.3.25. Pobierz pliki binarne dla wersji 1.3.25 ze strony http://www.swig.org. Następnie rozpakuj je i z wiersza poleceń dodaj do ścieżki systemowej

set PATH=path_to_swig_1.3.25;%PATH%

i ustaw COINDIR na odpowiednią ścieżkę

set COINDIR=path_to_coin

W systemie Windows plik konfiguracyjny pivy domyślnie oczekuje SoWin zamiast SoQt. Nie znalazłem oczywistego sposobu na kompilację z SoQt, więc zmodyfikowałem plik setup.py bezpośrednio. W linii 200 wystarczy usunąć część 'sowin': ('gui._sowin', 'sowin-config', 'pivy.gui.') (nie usuwaj nawiasu zamykającego).

Następnie przejdź do źródeł pivy i wywołaj:

python setup.py build

który tworzy pliki źródłowe. Możesz napotkać błąd kompilatora, gdy nie można znaleźć kilku plików nagłówkowych. W takim przypadku należy dostosować zmienną INCLUDE

set INCLUDE=%INCLUDE%;path_to_coin_include_dir

a jeśli nagłówki SoQt nie znajdują się w tym samym miejscu, co nagłówki Coin również:

set INCLUDE=%INCLUDE%;path_to_soqt_include_dir

i wreszcie nagłówki Qt

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

Jeśli korzystasz z Express Edition Visual Studio, możesz otrzymać wyjątek błędu klucza Python. W takim przypadku należy zmodyfikować kilka rzeczy w pliku msvccompiler.py znajdującym się w instalacji Python.

Przejdź do linii 122 i zastąp linię

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

przez

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

Następnie spróbuj ponownie. Jeśli pojawi się drugi błąd jak np.

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

musisz również zastąpić linię 128

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

przez

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

Spróbuj ponownie. Jeśli ponownie pojawi się błąd, taki jak

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.

następnie należy sprawdzić zmienne środowiskowe DISTUTILS_USE_SDK i MSSDK za pomocą

echo %DISTUTILS_USE_SDK%
echo %MSSDK%

Jeśli nie jest jeszcze ustawiony, wystarczy ustawić go np. na 1.

set DISTUTILS_USE_SDK=1
set MSSDK=1

Teraz możesz napotkać błąd kompilatora, w którym "const char*" nie może zostać przekonwertowany na "char*". Aby to naprawić, wystarczy napisać "const" przed w odpowiednich wierszach. Do poprawienia jest sześć linii. Następnie skopiuj wygenerowany katalog pivy do miejsca, w którym interpreter Pythona we FreeCAD może go znaleźć.

Użycie

Aby sprawdzić, czy Pivy jest poprawnie zainstalowany:

import pivy

Aby Pivy uzyskał dostęp do scenorysu FreeCAD, wykonaj następujące czynności:

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

Możesz teraz eksplorować FCSceneGraph za pomocą polecenia dir().

Dokumentacja dodatkowa

Niestety dokumentacja na temat pivy jest wciąż prawie nieobecna w sieci. Ale dokumentacja Coin może okazać się przydatna, ponieważ pivy po prostu tłumaczy funkcje, węzły i metody Coin w Python, wszystko zachowuje tę samą nazwę i właściwości, pamiętając o różnicach w składni między C i Pythonem:

Możesz również spojrzeć na plik Draft.py w folderze FreeCAD Mod/Draft, ponieważ w dużym stopniu wykorzystuje on pivy.

pyCollada

  • strona główna: http://pycollada.github.com
  • licencja: BSD.
  • opcjonalne, potrzebne do umożliwienia importu i eksportu plików Collada (.DAE).

pyCollada to biblioteka Python, która umożliwia programom odczytywanie i zapisywanie plików Collada (*.DAE). Po zainstalowaniu pyCollada w systemie, FreeCAD będzie w stanie obsługiwać import i eksport w formacie pliku Collada.

Instalacja

Linux

sudo apt-get install python3-collada

Możesz sprawdzić, czy pycollada została poprawnie zainstalowana, wydając polecenie w konsoli Python:

import collada

Jeśli nic nie zwróci (brak komunikatu o błędzie), wszystko jest w porządku

Windows

W systemie Windows od wersji 0.15 pycollada jest zawarta zarówno w wersji FreeCAD, jak i w kompilacjach deweloperskich, więc nie są wymagane żadne dodatkowe kroki.

MacOS

Jeśli korzystasz z wersji Homebrew FreeCAD, możesz zainstalować pycollada w swoim systemie Python za pomocą programu.

Jeśli musisz zainstalować program:

$ sudo easy_install pip

Zainstaluj pycollada:

$ sudo pip install pycollada

Jeśli używasz binarnej wersji FreeCAD, możesz polecić programowi, aby zainstalował pycollada w pakietach witryn wewnątrz FreeCAD.app:

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

lub po pobraniu kodu pycollada

$ export PYTHONPATH=/Applications/FreeCAD\ 0.16.6706.app/Contents/lib/python2.7/site-packages:$PYTHONPATH
$ python setup.py install --prefix=/Applications/FreeCAD\ 0.16.6706.app/Contents

IfcOpenShell

IFCOpenShell jest obecnie rozwijaną biblioteką, która umożliwia importowanie (a wkrótce eksportowanie) plików Industry Foundation Classes (*.IFC). IFC jest rozszerzeniem formatu STEP i staje się standardem w przepływach pracy BIM. Gdy ifcopenshell jest poprawnie zainstalowany w systemie, Środowisko pracy FreeCAD Architektura wykryje go i użyje do importowania plików IFC, zamiast wbudowanego podstawowego importera. Ponieważ ifcopenshell jest oparty na OpenCasCade, podobnie jak FreeCAD, jakość importu jest bardzo wysoka, tworząc wysokiej jakości geometrię brył.

Instalacja

Ponieważ ifcopenshell jest całkiem nowy, prawdopodobnie będziesz musiał skompilować go samodzielnie.

Linux

Do skompilowania ifcopenshell będziesz potrzebował kilku pakietów deweloperskich zainstalowanych w systemie:

liboce-*-dev
python-dev
swig

ale ponieważ FreeCAD również wymaga ich wszystkich, jeśli możesz skompilować FreeCAD, nie będziesz potrzebował żadnych dodatkowych zależności do kompilacji IfcOpenShell.

Pobierz najnowszy kod źródłowy stąd:

git clone https://github.com/IfcOpenShell/IfcOpenShell.git

Proces kompilacji jest bardzo prosty:

mkdir ifcopenshell-build
cd ifcopenshell-build
cmake ../IfcOpenShell/cmake

lub, jeśli używasz Oce zamiast Opencascade:

cmake -DOCC_INCLUDE_DIR=/usr/include/oce ../ifcopenshell/cmake

Ponieważ ifcopenshell został stworzony głównie dla Blendera, domyślnie używa Pythona3. Aby użyć go wewnątrz FreeCAD, należy skompilować go z tą samą wersją Python, która jest używana przez FreeCAD. Może więc być konieczne wymuszenie wersji Python za pomocą dodatkowych parametrów cmake (dostosuj wersję Python do swojej):

cmake -DOCC_INCLUDE_DIR=/usr/include/oce -DPYTHON_INCLUDE_DIR=/usr/include/python2.7 -DPYTHON_LIBRARY=/usr/lib/python2.7.so ../ifcopenshell/cmake

wtedy:

make
sudo make install

Możesz sprawdzić, czy ifcopenshell został poprawnie zainstalowany, wydając polecenie w konsoli Python:

import ifcopenshell

Jeśli nic nie zwróci (brak komunikatu o błędzie), wszystko jest w porządku

Windows

Uwaga: Oficjalne instalatory FreeCAD uzyskane ze strony FreeCAD / Github zawierają już ifcopenshell.

Skopiowane z pliku README IfcOpenShell

Użytkownikom zaleca się korzystanie z pliku Visual Studio .sln w folderze win/. Dla użytkowników systemu Windows wstępnie skompilowana wersja Open CASCADE jest dostępna na stronie opencascade. Pobierz i zainstaluj tę wersję i podaj ścieżki do plików nagłówkowych i bibliotecznych Open CASCADE do MS Visual Studio C++.

Aby zbudować wrapper IfcPython, należy zainstalować SWIG. Pobierz najnowszą wersję swigwin ze strony swig. Po rozpakowaniu pliku .zip należy dodać rozpakowany folder do zmiennej środowiskowej PATH. Python musi być zainstalowany, należy podać ścieżki dołączania i biblioteki do Visual Studio.

Odnośniki internetowe

Poradnik Import / Eksport IFC - kompilacja IfcOpenShell

LazyLoader

LazyLoader to moduł Python, który umożliwia odroczone ładowanie, a jednocześnie importowanie na początku skryptu. Jest to przydatne, jeśli importujesz inny moduł, który jest powolny i jest używany kilka razy w skrypcie. Korzystanie z LazyLoader może poprawić czas uruchamiania środowiska pracy, ale moduł nadal będzie musiał zostać załadowany przy pierwszym użyciu.

Instalacja

LazyLoader jest dołączony do FreeCAD v0.19

Użycie

Będziesz musiał zaimportować LazyLoader, a następnie zmienić import dowolnego modułu, który chcesz poddać odroczeniu.

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

Zmienna Part to nazwa modułu w skrypcie. Możesz powtórzyć "import Part as P", zmieniając zmienną.

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

You can also import a module from a package.

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

Nie można importować pojedynczych funkcji, tylko całe moduły.

Odnośniki internetowe