Debugging/de



Erster Test
Bevor du den Schmerz der Fehlerdiagnose durchmachst, benutze das Test Framework, um zu überprüfen, ob die Standardtests ordnungsgemäß funktionieren. Wenn sie nicht vollständig ausgeführt werden, liegt möglicherweise eine defekte Installation vor.



Befehlszeile
Die Fehlerdiagnose von FreeCAD wird durch einige interne Mechanismen unterstützt. Die Kommandozeilenversion von FreeCAD bietet einige Optionen für die Fehlerdiagnoseunterstützung.

Dies sind die derzeit anerkannten Optionen in FreeCAD 0.19:

Grundlegende Optionen: -v [ --version ]     Druckt Versionszeichenkette -h [ --help ]        Druckt Hilfsmeldung aus -c [ --console ]     Startet im Konsolenmodus --response-file arg  Kann auch mit'@name' angegeben werden --dump-config        Dump der Konfiguration --get-config arg     Gibt den Wert des angegebenen Konfigurationsschlüssels aus

Konfiguration: -l [ --write-log ]      Schreibt eine Log-Datei nach: $HOME/.FreeCAD/FreeCAD.log (Linux) $HOME/Library/Application/Support/FreeCAD/FreeCAD.log (macOS) %APPDATA%\FreeCAD\FreeCAD.log (Windows) --log-file arg          Anders als bei --write-log wird hier in eine Datei mit beliebigem Namen geschrieben -u [ --user-cfg ] arg   Benutzerkonfigurationsdatei, um Benutzereinstellungen zu laden/speichern -s [ --system-cfg ] arg Systemkonfigurationsdatei, um Systemeinstellungen zu laden/speichern -t [ --run-test ] arg   Test-Level - oder 0 für alles -M [ --module-path ] arg Zusätzliche Modulpfade -P [ --python-path ] arg Zusätzliche Python-Pfade --single-instance       Ermöglicht eine (einzige) Instanz der Applikation zu starten



Erzeugen einer Rückverfolgung
Wenn Du eine FreeCAD Version der Anfangsphase der Entwicklungskurve verwendest, kann sie "abstürzen". Du kannst dabei helfen, diese Probleme zu lösen, indem Du einen "Rückverfolgung" an die Entwickler schickst. Um dies zu tun, musst Du ein "Fehlerdiagnose build" der Software haben. "Fehlerdiagnose build" ist ein Parameter, der zur Kompilierungszeit gesetzt wird, also musst Du entweder FreeCAD selbst kompilieren oder Dir eine vorkompilierte "Fehlerdiagnose" Version besorgen.



Für Linux
Linux Fehlerdiagnose →

Voraussetzungen:


 * Softwarepaket gdb installiert
 * ein Fehlersuch-Build von FreeCAD (zur Zeit nur verfügbar unter Für einen Fehlersuch Bau)
 * ein FreeCAD-Modell, das einen Absturz verursacht

Schritte: Gib in deinem Terminalfenster folgendes ein:

Finde das FreeCAD-Programm auf deinem System:

GNUdebugger gibt einige Initialisierungsinformationen aus. Die (gdb) zeigt, dass der GNUDebugger im Terminal läuft, das nun eingegeben wird:

FreeCAD wird nun gestartet. Führe die Schritte aus, die dazu führen, dass FreeCAD abstürzt oder einfriert, und gib dann in das Terminalfenster ein:

Dies führt zu einer langen Auflistung dessen, was das Programm beim Absturz oder Einfrieren genau getan hat. Füge dies deinem Problembericht bei.

Drucke auch die Werte der lokalen Variablen. Dies kann mit einer Zahl kombiniert werden, um die Anzahl der angezeigten Rahmen zu begrenzen.



Für macOS
macOS Debugging →

Voraussetzungen:


 * Softwarepaket lldb installiert
 * ein Fehlerdiagnose build von FreeCAD
 * ein FreeCAD Modell, dass den Absturz verursacht

Schritte: Gib das Folgende in Dein Terminalfenster ein:

LLDB gibt einige Initialisierungsinformationen aus. Die (lldb) zeigt an, dass das Fehlerdiagnoseprogramm im Terminal läuft, jetzt eingegeben:

FreeCAD wird nun gestartet. Führe die Schritte aus, die dazu führen, dass FreeCAD abstürzt oder einfriert, und gib dann in das Terminalfenster ein:

Dies führt zu einer längeren Auflistung dessen, was das Programm genau getan hat, als es abgestürzt ist oder eingefroren ist. Füge dies deinem Problembericht bei.



Von FreeCAD geladene Bibliotheken auflisten
(Anwendbar auf Linux und macOS)

Manchmal ist es hilfreich zu verstehen, welche Bibliotheken FreeCAD lädt, insbesondere wenn mehrere Bibliotheken mit demselben Namen, aber unterschiedlichen Versionen geladen werden (Versionskollision). Um zu sehen, welche Bibliotheken von FreeCAD geladen werden, wenn es abstürzt, solltest du ein Terminal öffnen und es im Debugger ausführen. In einem zweiten Terminalfenster findest du die Prozess ID von FreeCAD heraus:

Verwende die zurückgegebene ID und übergib sie an :

Dadurch wird eine lange Liste der geladenen Ressourcen gedruckt. Wenn z.B. herausgefunden werden soll, ob mehr als eine Coin3d Bibliotheksversion geladen ist, blättere durch die Liste oder suche direkt nach Coin in der Ausgabe:



Python Fehlerdiagnose
Für einen moderneren Ansatz zur Fehlerdiagnose bei Python siehe diese Beiträge:
 * Fehlerdiagnosemakros mit VS 2017
 * Python Arbeitsbereiche Fehlersuche
 * python3.dll, Qt5Windgets.dll, Qt5Gui.dll und Qt5Core.dll nicht gefunden

winpdb
winpdb Fehlerdiagnose →

Hier ist ein Beispiel für die Verwendung von Winpdb in FreeCAD:

Wir benötigen das Python-Fehlerdiagnoseprogramm Winpdb. Wenn es nicht installiert ist, lässt sich das auf Ubuntu/Debian wie folgt tun:

Jetzt werden wir das Fehlerdiagnoseprogramm einrichten.


 * 1) Starte Winpdb.
 * 2) Setze das Fehlerdiagnoseprogramm Passwort auf "test": Gehe zum Menü Datei → Passwort und setze das Passwort.

Jetzt werden wir ein Python-Test-Skript in FreeCAD Schritt-für-Schritt ablaufen lassen.


 * 1) Starten Sie winpdb und setzen Sie ein Passwort (z.B. Test)
 * 2) Erzeugen Sie eine Pythondatei mit folgendem Inhalt:


 * 1) Starte FreeCAD und lade die obige Datei in FreeCAD.
 * 2) Drücke F6, um es auszuführen.
 * 3) Jetzt wird FreeCAD nicht mehr reagieren, weil das Python Fehlerdiagnoseprogramm wartet.
 * 4) Wechsle zur Windpdb GUI und klicke auf "Anhängen". Nach einigen Sekunden erscheint ein Eintrag "", in dem du doppelt klicken musst.
 * 5) Nun erscheint das aktuell ausgeführte Skript in der Winpdb.
 * 6) Setze einen Bruch in der letzten Zeile und drücke F5.
 * 7) Drücke nun F7, um in den Python Code von Draft.makeWire zu gelangen.

Visual Studio Code (VS Code)
VS Code Fehlerdiagnose →

Voraussetzungen:


 * Das ptvsd Paket muss installiert werden

pypi Seite

Visual Studio Code Dokumentation für die Fern Fehlerdiagnose

Schritte:
 * Füge folgenden Code am Anfang deines Skripts hinzu


 * Füge eine Fehlerdiagnosekonfiguration in Visual Studio Code . Es sollte so aussehen:

"configurations": [ {           "name": "Python: Attacher", "type": "python", "request": "attach", "port": 5678, "host": "localhost", "pathMappings": [ {                   "localRoot": "${workspaceFolder}", "remoteRoot": "." }           ]        },


 * Füge im VS-Code einen Haltepunkt hinzu, wo immer Du willst.
 * Starte das Skript in FreeCAD. FreeCAD Freeze wartet auf den Anhang.
 * In VS Code startest Du die Fehlerdiagnose durch Verwendung der erstellten Konfiguration. Du solltest Variablen im Fehlerdiagnosebereich sehen.
 * Beim Setzen von Haltepunkten wird sich VS Code darüber beschweren, die im VS Code-Editor geöffnete .py-Datei nicht zu finden.
 * Ändere "remoteRoot": "." zu "remoteRoot": ""
 * z.B. wenn sich die Python-Datei in /home/FC_myscripts/myscript.py befindet
 * ändere zu "remoteRoot": "/home/FC_myscripts/myscript.py"
 * Wenn dein Makro ptvsd nicht findet, obwohl du es irgendwo installiert hast, stelle 'import ptvsd' folgendes voran

wobei der Pfad das Verzeichnis ist, in dem ptvsd installiert wurde In der Mac-Version ist es /Applications/FreeCAD.App/Contents/Resources/bin/python
 * Auf der linken unteren Seite des VSCode kannst Du das Python-Programm auswählen - es ist das Beste, die mit FreeCAD ausgelieferte Version zu verwenden.

Du kannst es auf deinem System lokalisieren durch Eingabe von

in die FreeCAD-Python-Konsole.

With LiClipse and AppImage
LiClipse Debugging →


 * Extract AppImage.


 * The sqashfs-root location is where the debugger later on is hooked up to.


 * Make sure you can start a FreeCAD session from within the squashfs-root location.


 * Should start up a FreeCAD commandline session.


 * Install LiClipse.
 * Comes ready with pydev and has installers for all platforms.
 * For linux it is just to extract (to any location) and run.


 * Configure liclipse for debugging.
 * Right-click pydev icon (upper right corner) and choose customize.
 * Activate "PyDev Debug" (through checkbox, or it might be needed to go to tab "Action Set Availability" and activate there first).
 * In the pydev menu you can now choose "start debug server".
 * Use menu window/open perspective/other > debug.
 * Right-click debug icon (upper right corner) and choose customize.
 * Checking "Debug" brings the debugging navigation tools to the toolbar.
 * Open preferences through menu window/preferences.
 * In PyDev/Interpreters add "new Interpreter by browsing".
 * The added interpreter should be:.
 * If you are only using this for fc, you can add AddOn workbench folders as well, or do that in a pydev-project later on.


 * Find path to in your liclipse installation.
 * Something along the lines of:.
 * Create a regular pydev-project in liclipse.
 * Import external sources, for example a macro that you want to debug, or an external workbench.
 * In that macro (or workbench .py file) add the code lines:




 * This is where the execution will halt when the macro is run.


 * Start the liclipse debug server (menu pydev).


 * Start FreeCAD.


 * Run the macro (or any other file with a trigger) from within freecad, as you would normally do.


 * Happy debugging.


 * The use of LiClipse for remote debugging, and the steps described here related to liclipse, should work on any platform. The parts related to AppImage is for linux only.



Fehlerdiagnose OpenCasCade
Für Entwickler, die tiefer in den OpenCasCade Kernel einsteigen müssen, hat der Benutzer @abdullah eine Forumsbetrag Orientierung erstellt, in der die Vorgehensweise diskutiert wird.