Difference between revisions of "Debugging/tr"

From FreeCAD Documentation
Jump to navigation Jump to search
(Updating to match new version of source page)
(Updating to match new version of source page)
 
(11 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
<languages/>
 
<languages/>
 +
 
{{Docnav
 
{{Docnav
|[[Module Creation|Module Creation]]
+
|[[Bug_Triage|Bug Triage]]
 
|[[Testing|Testing]]
 
|[[Testing|Testing]]
 
}}
 
}}
 +
 +
{{TOCright}}
  
 
== Test First ==
 
== Test First ==
Line 13: Line 16:
 
The ''debugging'' of FreeCAD is supported by a few internal mechanisms. The command line version of FreeCAD provides some options for debugging support.
 
The ''debugging'' of FreeCAD is supported by a few internal mechanisms. The command line version of FreeCAD provides some options for debugging support.
  
These are the currently recognized options in FreeCAD 0.15:
+
These are the currently recognized options in FreeCAD 0.19:
  
 
Generic options:
 
Generic options:
   -v [ --version ]     Prints version string
+
   -v [ --version ]         Prints version string
   -h [ --help ]         Prints help message
+
   -h [ --help ]             Prints help message
   -c [ --console ]     Starts in console mode
+
   -c [ --console ]         Starts in console mode
   --response-file arg   Can be specified with '@name', too
+
   --response-file arg       Can be specified with '@name', too
 +
  --dump-config            Dumps configuration
 +
  --get-config arg          Prints the value of the requested configuration key
  
 
Configuration:
 
Configuration:
   -l [ --write-log ]       Writes a log file to:
+
   -l [ --write-log ]       Writes a log file to:
                          $HOME/.FreeCAD/FreeCAD.log
+
                            $HOME/.FreeCAD/FreeCAD.log (Linux)
   --log-file arg           Unlike to --write-log this allows to log to an  
+
                            $HOME/Library/Preferences/FreeCAD/FreeCAD.log (macOS)
                          arbitrary file
+
                            %APPDATA%\FreeCAD\FreeCAD.log (Windows)
   -u [ --user-cfg ] arg   User config file to load/save user settings
+
   --log-file arg           Unlike to --write-log this allows to log to an  
   -s [ --system-cfg ] arg System config file to load/save system settings
+
                            arbitrary file
   -t [ --run-test ] arg   Test level
+
   -u [ --user-cfg ] arg     User config file to load/save user settings
   -M [ --module-path ] arg Additional module paths
+
   -s [ --system-cfg ] arg   System config file to load/save system settings
   -P [ --python-path ] arg Additional python paths
+
   -t [ --run-test ] arg     Test case - or 0 for all
 +
   -M [ --module-path ] arg Additional module paths
 +
   -P [ --python-path ] arg Additional Python paths
 +
  --single-instance        Allow to run a single instance of the application
  
 
== Generating a Backtrace ==
 
== Generating a Backtrace ==
Line 47: Line 55:
  
 
* software package gdb installed
 
* software package gdb installed
* a debug build of FreeCAD (at this time only available by [[Compile_on_Linux/Unix#For_a_Debug_build|building from source]])
+
* a debug build of FreeCAD (at this time only available by [[Compile_on_Linux#For_a_Debug_build|building from source]])
 
* a FreeCAD model that causes a crash
 
* a FreeCAD model that causes a crash
  
 
Steps:
 
Steps:
 
Enter the following in your terminal window:
 
Enter the following in your terminal window:
 +
 +
Find FreeCAD binary on your system:
  
 
{{Code|code=
 
{{Code|code=
$ cd FreeCAD/bin
+
$ whereis freecad
 +
freecad: /usr/local/freecad <--- for example
 +
 
 +
$ cd /usr/local/freecad/bin
 
$ gdb FreeCAD
 
$ gdb FreeCAD
 
}}
 
}}
Line 81: Line 94:
 
</div></div> <!-- END OF COLLAPSIBLE DIV -->
 
</div></div> <!-- END OF COLLAPSIBLE DIV -->
  
=== For MacOSX ===
+
=== For macOS ===
  
 
<!-- START OF COLLAPISBLE DIV --><div class="toccolours mw-collapsible mw-collapsed" style="width:800px;">
 
<!-- START OF COLLAPISBLE DIV --><div class="toccolours mw-collapsible mw-collapsed" style="width:800px;">
  
MacOSX Debugging →  
+
macOS Debugging →  
  
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
Line 118: Line 131:
  
 
</div></div> <!-- END OF COLLAPSIBLE DIV -->
 
</div></div> <!-- END OF COLLAPSIBLE DIV -->
 +
 +
== 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:
 +
 +
{{incode|ps -A &#124; grep FreeCAD}}
 +
 +
Use the returned id and pass it to {{incode|lsof}}:
 +
 +
{{incode| 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:
 +
 +
{{incode|lsof -p process_id &#124; grep Coin}}
  
 
== Python Debugging ==
 
== Python Debugging ==
Line 136: Line 165:
 
Here is an example of using ''Winpdb'' inside FreeCAD:
 
Here is an example of using ''Winpdb'' inside FreeCAD:
  
We need the python debugger: ''Winpdb''. If you do not have it installed, on Ubuntu/Debian install it with:
+
We need the Python debugger: ''Winpdb''. If you do not have it installed, on Ubuntu/Debian install it with:
  
 
{{Code|code=
 
{{Code|code=
Line 147: Line 176:
 
# Set the debugger password to "test": Go to menu ''File'' → ''Password" and set the password.
 
# Set the debugger password to "test": Go to menu ''File'' → ''Password" and set the password.
  
Now we will run a test python script in FreeCAD step by step.
+
Now we will run a test Python script in FreeCAD step by step.
  
 
# Run winpdb and set the password (e.g. test)
 
# Run winpdb and set the password (e.g. test)
Line 228: Line 257:
 
* In VS Code add a breakpoint anywhere you want.
 
* In VS Code add a breakpoint anywhere you want.
 
* Launch the script in FreeCAD. FreeCAD freeze waiting for attachment.
 
* Launch the script in FreeCAD. FreeCAD freeze waiting for attachment.
* In VS Code start debugging used created configuration. You should see variables in debugger area.
+
* 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 your macro can't find ptvsd despite having installed it somewhere precede 'import ptvsd' with
 +
{{Code|code=
 +
from sys import path
 +
sys.path.append('/path/to/site-packages')
 +
}}
 +
where the path is to the directory where ptvsd got 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
 +
{{Code|code=
 +
import sys
 +
print(sys.executable)
 +
}}
 +
into FreeCAD's Python console.
 
</div></div> <!-- END OF COLLAPSIBLE DIV -->
 
</div></div> <!-- END OF COLLAPSIBLE DIV -->
 +
 +
== Debugging OpenCasCade ==
 +
 +
For developers needing to dig deeper in to the OpenCasCade kernel, user @abdullah has created a [https://forum.freecadweb.org/viewtopic.php?f=10&t=47017 thread] orientation discussing how to do so.
 +
  
 
{{Docnav
 
{{Docnav
|[[Module Creation|Module Creation]]
+
|[[Bug_Triage|Bug Triage]]
 
|[[Testing|Testing]]
 
|[[Testing|Testing]]
 
}}
 
}}
  
{{Userdocnavi}}
+
{{Powerdocnavi{{#translation:}}}}
 
+
[[Category:Developer Documentation{{#translation:}}]]
[[Category:Developer Documentation/tr]]
+
[[Category:Python Code{{#translation:}}]]
 
 
 
{{clear}}
 
{{clear}}

Latest revision as of 03:43, 25 August 2021

Other languages:
Deutsch • ‎English • ‎Türkçe • ‎español • ‎français • ‎hrvatski • ‎italiano • ‎polski • ‎português • ‎português do Brasil • ‎română • ‎svenska • ‎čeština • ‎български • ‎русский • ‎中文 • ‎中文(中国大陆)‎ • ‎中文(台灣)‎
Arrow-left.svg Previous: Bug Triage
Next: Testing Arrow-right.svg

Test First

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.

Command Line

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

These are the currently recognized options in FreeCAD 0.19:

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
 --dump-config             Dumps configuration
 --get-config arg          Prints the value of the requested configuration key

Configuration:

 -l [ --write-log ]        Writes a log file to:
                           $HOME/.FreeCAD/FreeCAD.log (Linux)
                           $HOME/Library/Preferences/FreeCAD/FreeCAD.log (macOS)
                           %APPDATA%\FreeCAD\FreeCAD.log (Windows)
 --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 case - or 0 for all
 -M [ --module-path ] arg  Additional module paths
 -P [ --python-path ] arg  Additional Python paths
 --single-instance         Allow to run a single instance of the application

Generating a Backtrace

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:

  • software package gdb installed
  • a debug build of FreeCAD (at this time only available by building from source)
  • a FreeCAD model that causes a crash

Steps: Enter the following in your terminal window:

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 will now start up. Perform the steps that cause FreeCAD to crash or freeze, then enter in the terminal window:

(gdb) bt

This will generate a lengthy listing of exactly what the program was doing when it crashed or froze. Include this with your problem report.

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

macOS 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 will now start up. Perform the steps that cause FreeCAD to crash or freeze, then enter in the terminal window:

(lldb) bt

This will generate a lengthy listing of exactly what the program was doing when it crashed or froze. Include this with your problem report.

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

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

winpdb

winpdb Debugging →

Here is an example of using Winpdb inside FreeCAD:

We need the Python debugger: Winpdb. If you do not have it installed, on Ubuntu/Debian install it with:

sudo apt-get install winpdb

Now lets setup the debugger.

  1. Start Winpdb.
  2. Set the debugger password to "test": Go to menu FilePassword" and set the password.

Now we will run a test Python script in FreeCAD step by step.

  1. Run winpdb and set the password (e.g. test)
  2. Create a Python file with this content
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. Start FreeCAD and load the above file into FreeCAD
  2. Press F6 to execute it
  3. Now FreeCAD will become unresponsive because the Python debugger is waiting
  4. Switch to the Windpdb GUI and click on "Attach". After a few seconds an item "<Input>" appears where you have to double-click
  5. Now the currently executed script appears in Winpdb.
  6. Set a break at the last line and press F5
  7. Now press F7 to step into the Python code of Draft.makeWire

Visual Studio Code (VS Code)

VS Code Debugging →

Prerequisites:

  • ptvsd package need to be installed
pip install 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…. It should looks 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 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 got 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.

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.


Arrow-left.svg Previous: Bug Triage
Next: Testing Arrow-right.svg