Fehlerdiagnose

From FreeCAD Documentation
Revision as of 09:25, 2 June 2020 by FuzzyBot (talk | contribs) (Updating to match new version of source page)

Erster Test

Bevor du den Aufwand der Fehlerbeseitigung durchläufst, 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.

Before you go through the pain of debugging use the Test framework to check if the standard tests work properly. If they do not run complete there is possibly a broken installation.

Befehlszeile

Die Fehlerbeseitigung von FreeCAD wird durch einige interne Mechanismen unterstützt. Die Kommandozeilenversion von FreeCAD bietet einige Optionen für die Fehlerbeseitigungsunterstützung.

The debugging of FreeCAD is supported by a few internal mechanisms. The command line version of FreeCAD provides some options for debugging support.

Dies sind die derzeit anerkannten Optionen in FreeCAD 0.15:

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.

Konfiguration:

 -l [ --write-log ]       Schreibt eine Log-Datei nach:
                          $HOME/.FreeCAD/FreeCAD.log
 --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
 -M [ --module-path ] arg Zusätzliche Modulpfade
 -P [ --python-path ] arg Zusätzliche Python-Pfade

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 "Backtrace" an die Entwickler schickst. Um dies zu tun, musst Du ein "Debug build" der Software haben. "Debug build" ist ein Parameter, der zur Compile-Zeit gesetzt wird, also musst Du entweder FreeCAD selbst kompilieren oder Dir eine vorkompilierte "debug"-Version besorgen.

If you are running a version of FreeCAD from the bleeding edge of the development curve, it may "crash". You can help solve such problems by providing the developers with a "backtrace". To do this, you need to be running a "debug build" of the software. "Debug build" is a parameter that is set at compile time, so you'll either need to compile FreeCAD yourself, or obtain a pre-compiled "debug" version.

Für Linux

Linux Fehlerbehebung →

Voraussetzungen:

  • Softwarepaket gdb installiert
  • ein Fehlerbehebungs Build von FreeCAD (zur Zeit nur verfügbar unter building from source)
  • ein FreeCAD-Modell, das einen Absturz verursacht

Schritte: Gib in deinem Terminalfenster Folgendes ein:

$ cd FreeCAD/bin
$ gdb FreeCAD

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

(gdb) handle SIG33 noprint nostop
(gdb) run

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:

(gdb) bt

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

(gdb) bt full

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

Für MacOSX

MacOSX Fehlerbehebung →

Voraussetzungen:

  • Softwarepaket lldb installiert
  • ein Fehlerbehebungs build von FreeCAD
  • ein FreeCAD Modell, dass den Absturz verursacht

Schritte: Gib das Folgende in Dein Terminal Fenster ein:

$ cd FreeCAD/bin
$ lldb FreeCAD

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

(lldb) run

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:

(lldb) bt

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.

List Libraries Loaded by FreeCAD

(Applicable to Linux and MacOS)

Sometimes it's helpful to understand what libraries FreeCAD is loading, specifically if there are multiple libraries being loaded of the same name but different versions (version collision). In order to see which libraries are loaded by FreeCAD when it crashes you should open a terminal and run it in the debugger. In a second terminal window, find out the process id of FreeCAD:

ps -A | grep FreeCAD

Use the returned id and pass it to lsof:

lsof -p process_id

This prints a long list of loaded resources. So for example, if trying to ascertain if more than one Coin3d library versions is loaded, scroll through the list or search directly for Coin in the output:

lsof -p process_id | grep Coin

Python Fehlerbehebung

Für einen moderneren Ansatz zur Fehlerbehebung bei Python siehe diese Beiträge:

For a more modern approach to debugging Python, see these posts:

winpdb

winpdb Fehlersuche →

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

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

sudo apt-get install winpdb

Jetzt werden wir den Debugger einrichten.

  1. Starte Winpdb.
  2. Setze das Fehlerbeseitigungsprogramm Passwort auf "test": Gehe zum Menü DateiPasswort 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:
import rpdb2
rpdb2.start_embedded_debugger("test")
import FreeCAD
import Part
import Draft
print "hello"
print "hello"
import Draft
points=[FreeCAD.Vector(-3.0,-1.0,0.0),FreeCAD.Vector(-2.0,0.0,0.0)]
Draft.makeWire(points,closed=False,face=False,support=None)
  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 Fehlerbeseitigungsprogramm wartet.
  4. Wechsle zur Windpdb GUI und klicke auf "Anhängen". Nach einigen Sekunden erscheint ein Eintrag "<Eingabe>", 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 Fehlerbehebung →

Voraussetzungen:

  • Das ptvsd Paket muss installiert werden
pip install ptvsd

pypi Seite

Visual Studio Code Dokumentation für die Fern Fehlerbeseitigung

Schritte:

  • Füge folgenden Code am Anfang deines Skripts hinzu
import ptvsd
print("Waiting for debugger attach")
# 5678 is the default attach port in the VS Code debug configurations
ptvsd.enable_attach(address=('localhost', 5678), redirect_output=True)
ptvsd.wait_for_attach()
    "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 Fehlersuche der verwendeten erstellten Konfiguration. Du solltest Variablen im Fehlersuchbereich sehen.

Debugging OpenCasCade

For developers needing to dig deeper in to the OpenCasCade kernel, user @abdullah has created a thread orientation discussing how to do so.