Debugging/ro

Module Creation

Testing

Indeks

Testează mai întâi

Înainte de a trece prin durerea de a depana utilizați Test framework pentru a verifica dacă testele standard funcționează corect. Dacă acestea nu se execută complet, este posibil să fie o instalare defectuoasă.

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.

Linie de Commandă

Depanarea debugging în FreeCAD este susținută de câteva mecanisme interne. Versiunea liniei de comandă a FreeCAD oferă câteva opțiuni pentru suportul de depanare.

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

Acestea sunt opțiunile recunoscute curent în FreeCAD 0.15:

Generic options:

 -v [ --version ]      Prints version string
 -h [ --help ]         Prints help message
 -c [ --console ]      Starts in console mode
 --response-file arg   Can be specified with '@name', too

Configuration:

 -l [ --write-log ]       Writes a log file to:
                          $HOME/.FreeCAD/FreeCAD.log
 --log-file arg           Unlike to --write-log this allows to log to an 
                          arbitrary file
 -u [ --user-cfg ] arg    User config file to load/save user settings
 -s [ --system-cfg ] arg  System config file to load/save system settings
 -t [ --run-test ] arg    Test level
 -M [ --module-path ] arg Additional module paths
 -P [ --python-path ] arg Additional python paths

Generarea unei Backtrace

Dacă rulați o versiune experimentală de FreeCAD care este încă în curs de dezvoltare, aceasta poate "îngheța". Vă puteți ajuta să rezolvați astfel de probleme furnizând dezvoltatorilor o "backtrace". Pentru a face acest lucru, trebuie să executați o "Debug build" a software-ului. "Debug build" este un parametru care este setat în timpul compilării, deci va trebui fie să compilați FreeCAD dvs înșivă, fie să obțineți o versiune "debug" precompilată.

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.

For Linux

Linux Debugging →

Prerequisites:

• varianta software de package gdb instalat
• o depanare a variantei compilate a FreeCAD (în acest moment disponibilă prin building from source)
• un model FreeCAD care a cauzat crash-ul

Pași: Introduceți următoarelor în fereastra terminalului dvs:

Find FreeCAD binary on your system:

$ whereis freecad
freecad: /usr/local/freecad <--- for example

$ cd /usr/local/freecad/bin
$ gdb FreeCAD

GNUdebugger will output some initializing information. The (gdb) shows GNUDebugger is running in the terminal, now input:

(gdb) handle SIG33 noprint nostop
(gdb) run

FreeCAD va porni. Efectuați pașii care determină ca FreeCAD să se prăbușească sau să înghețe, apoi introduceți în fereastra terminalului:

(gdb) bt

Aceasta va genera o listă lungă a exact ceea ce a făcut programul atunci când sa prăbușit sau a înghețat. Includeți acest lucru cu raportul problemei dvs.

(gdb) bt full

Print the values of the local variables also. This can be combined with a number to limit the number of frames shown.

For MacOSX

MacOSX Debugging →

Prerequisites:

• software package lldb installed
• a debug build of FreeCAD
• a FreeCAD model that causes a crash

Steps: Enter the following in your terminal window:

$ cd FreeCAD/bin
$ lldb FreeCAD

LLDB will output some initializing information. The (lldb) shows the debugger is running in the terminal, now input:

(lldb) run

FreeCAD va porni. Efectuați pașii care determină ca FreeCAD să se prăbușească sau să înghețe, apoi introduceți în fereastra terminalului:

(lldb) bt

Aceasta va genera o listă lungă a exact ceea ce a făcut programul atunci când sa prăbușit sau a înghețat. Includeți acest lucru cu raportul problemei dvs.

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 Debugging

Pentru o abordare mai modernă a depanării Python, cel puțin în Windows, a se vedea asta

• Debugging macros with VS 2017
• Python workbenches debugging

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

• Debugging macros with VS 2017
• Python workbenches debugging
• python3.dll, Qt5Windgets.dll, Qt5Gui.dll and Qt5Core.dll not found

winpdb

winpdb Debugging →

Here is an example of using Winpdb inside FreeCAD:

Avem nevoie de depanatorul Python: Winpdb . Dacă nu aveți instalat, instalați-l sub Ubuntu / Debian cu:

sudo apt-get install winpdb

Acum permiteți configurarea programului de depanare.

1. Start Winpdb.
2. Set the debugger password to "test": Go to menu File->Password" and set the password.

Acum vom rula pas cu pas un script de testare Python în FreeCAD.

1. Rulați winpdb și definiți password (e.g. test)
2. Creați un fișier Python cu acest conținut

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. Dați Start la FreeCAD și încărcați fișierul de mai sus în FreeCAD
2. Apăsați F6 ptru al-l executa
3. Acum FreeCAD se va bloca (nu va răspunde) deoarece debuggerul Python este în așteptare
4. Comutați pe Windpdb GUI și click on "Attach". După câteva secunde un articol "<Input>" apare acolo unde ați făcut dublu clic
5. Acum Scriptul aflat în execuție curentă apare în Winpdb.
6. Definiți o pauză la ultima linie și apăsați F5
7. Acum apăsați F7 pentru a intra în codul Python al Draft.makeWire

Visual Studio Code (VS Code)

VS Code Debugging →

Prerequisites:

• The ptvsd package needs to be installed in a Python 3 outside of FreeCAD, then the module must be copied to FreeCAD's Python library folder.

# In a cmd window that has a path to you local Python 3:
pip install ptvsd
# Then if your Python is installed in C:\Users\<userid>\AppData\Local\Programs\Python\Python37
# and your FreeCAD is installed in C:\freecad\bin
xcopy "C:\Users\<userid>\AppData\Local\Programs\Python\Python37\Lib\site-packages\ptvsd" "C:\freecad\bin\Lib\site-packages\ptvsd"

pypi page

Visual Studio Code documentation for remote debugging

Steps:

• Add following code at the beginning of your script

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

• Add a debug configuration in Visual Studio Code Debug → Add Configurations….
• The config should look like this:

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

• In VS Code add a breakpoint anywhere you want.
• Launch the script in FreeCAD. FreeCAD freeze waiting for attachment.
• In VS Code start debugging using created configuration. You should see variables in debugger area.
• When setting breakpoints, VS Code will complain about not finding the .py file opened in the VS Code editor.
  • Change "remoteRoot": "." to "remoteRoot": "<directory of file>"
    • For example, if the Python file resides in /home/FC_myscripts/myscript.py
    • Change to: "remoteRoot": "/home/FC_myscripts"
  • If you're just debugging FreeCAD macros from the FreeCAD macro folder, and that folder is "C:/Users/<userid>/AppData/Roaming/FreeCAD/Macro", then use:
    • "localRoot": "C:/Users/<userid>/AppData/Roaming/FreeCAD/Macro",
    • "remoteRoot": "C:/Users/<userid>/AppData/Roaming/FreeCAD/Macro"
• If your macro can't find ptvsd despite having installed it somewhere precede 'import ptvsd' with

from sys import path
sys.path.append('/path/to/site-packages')

Where the path is to the directory where ptvsd was installed.

• On the left bottom edge of VSCode you can choose the Python executable - it's best to make this the version packaged with FreeCAD.

In the Mac package it is /Applications/FreeCAD.App/Contents/Resources/bin/python.

You can locate it on your system by typing

import sys
print(sys.executable)

into FreeCAD's Python console.

With LiClipse and AppImage

LiClipse Debugging →

• Extract AppImage.

> ./your location/FreeCAD_xxx.AppImage --appimage-extract
> cd squashfs-root/

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

squashfs-root> ./usr/bin/freecadcmd

• 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: your loc/squashfs-root/usr/bin/python.
    • 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 pydevd.py in your liclipse installation.
  • Something along the lines of: your location/liclipse/plugins/org.python.pydev.xx/pysrc.
• 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:

import sys; sys.path.append("path ending with /pysrc")
import pydevd; pydevd.settrace()

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

• Start the liclipse debug server (menu pydev).

• Start FreeCAD.

squashfs-root> ./usr/bin/freecad

• Run the macro (or any other file with a pydevd.settrace() 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.

Pyzo

See the main article about Pyzo.

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.

Module Creation

Testing

Indeks

Power user documentation

• FreeCAD scripting: Python, Introduction to Python, Python scripting tutorial, FreeCAD Scripting Basics

---

• Modules: Builtin modules, Units, Quantity
• Workbenches: Workbench creation, Gui Commands, Commands, Installing more workbenches
• Meshes and Parts: Mesh Scripting, Topological data scripting, Mesh to Part, PythonOCC

---

• Parametric objects: Scripted objects, Viewproviders (Custom icon in tree view)
• Scenegraph: Coin (Inventor) scenegraph, Pivy
• Graphical interface: Interface creation, Interface creation completely in Python (1, 2, 3, 4, 5), PySide, PySide examples beginner, intermediate, advanced
• Macros: Macros, How to install macros
• Embedding: Embedding FreeCAD, Embedding FreeCADGui

---

• Other: Expressions, Code snippets, Line drawing function, FreeCAD vector math library (deprecated)

---

• Hubs: User hub, Power users hub, Developer hub