Debugging/fr

Prérequis :

• le package logiciel gdb installé
• une version de débogage de FreeCAD (pour l'instant uniquement disponible par compilation à partir des sources)
• un modèle FreeCAD qui provoque un crash.

Étapes : Entrez ce qui suit dans votre fenêtre de terminal :

Trouvez le binaire FreeCAD sur votre système :

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

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

GNUdebugger affichera des informations d’initialisation. Le (gdb) montre que GNUDebugger est en cours d’exécution dans le terminal, entrez maintenant :

(gdb) handle SIG33 noprint nostop
(gdb) run

FreeCAD va maintenant démarrer. Effectuez les étapes qui provoquent le crash ou le blocage de FreeCAD, puis entrez dans la fenêtre du terminal :

(gdb) bt

Cela va générer une longue liste de ce que le programme faisait quand il s'est planté ou gelé. Incluez ceci avec votre rapport de problème.

(gdb) bt full

Affiche également les valeurs des variables locales. Ceci peut être combiné avec un nombre pour limiter le nombre d'images affichées.

Prerequis :

• logiciel lldb installé
• une version de débogage de FreeCAD
• un modèle FreeCAD qui provoque un crash

Étapes: Entrez ce qui suit dans la fenêtre de votre terminal :

$ cd FreeCAD/bin
$ lldb FreeCAD

LLDB générera des informations d’initialisation. Le (lldb) montre que le débogueur s'exécute dans le terminal, entrez maintenant :

(lldb) run

FreeCAD va maintenant démarrer. Effectuez les étapes qui provoquent le crash ou le blocage de FreeCAD, puis entrez dans la fenêtre du terminal :

(lldb) bt

Cela va générer une longue liste de ce que le programme faisait quand il s'est bloqué ou arrêté. Incluez ceci avec votre rapport de problème.

Voici un exemple d'usage de Winpdb dans FreeCAD :

Nous avons besoin du débogueur Python : Winpdb. Si vous ne l'avez pas installé, vous pouvez le faire sous Ubuntu/Debian avec :

sudo apt-get install winpdb

Vous pouvez maintenant configurer le débogueur.

1. Démarrez Winpdb.
2. Définissez le mot de passe du débogueur sur "test" : Allez dans le menu "Fichier" → "Mot de passe" et définissez le mot de passe.

Nous allons maintenant exécuter étape par étape un script de test Python dans FreeCAD.

1. Lancez winpdb et définissez le mot de passe (par exemple, test)
2. Créer un fichier Python avec ce contenu

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. Démarrer FreeCAD et charger le fichier ci-dessus dans FreeCAD
2. Appuyez sur F6 pour l'exécuter
3. Maintenant, FreeCAD ne répondra plus car le débogueur Python attend
4. Passez à l'interface graphique de Windpdb et cliquez sur "Attacher". Après quelques secondes, un élément "<Input>" apparaît où vous devez double-cliquer
5. Maintenant, le script actuellement exécuté apparaît dans Winpdb.
6. Définir une pause à la dernière ligne et appuyez sur F5
7. Maintenant, appuyez sur F7 pour entrer dans le code Python de Draft.makeWire

Prerequis :

• Le paquet ptvsd doit être installé dans un Python 3 en dehors de FreeCAD, puis le module doit être copié dans le dossier de la bibliothèque Python de FreeCAD.

# 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"

Page pypi

Documentation du code Visual Studio pour debugging à distance

Étapes :

• Ajoutez le code suivant au début de votre 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()

• Ajoutez une configuration de débogage dans le Code Visual Studio Debug → Add Configurations….
• La configuration doit ressembler à ceci :

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

• Dans VS Code, ajoutez un point d'arrêt où vous voulez.
• Lancez le script dans FreeCAD. FreeCAD se fige en attendant la pièce jointe.
• Dans VS Code commencez le débogage en utilisant la configuration créée. Vous devriez voir des variables dans la zone du débogueur.
• Lors de la mise en place de points d'arrêt, VS Code se plaindra de ne pas trouver le fichier .py ouvert dans l'éditeur VS Code.
  • Changer "remoteRoot" : "." en "remoteRoot" : "<directory of file>"
    • Par exemple, si le fichier Python se trouve dans /home/FC_myscripts/myscript.py.
    • Changez en : "remoteRoot" : "/home/FC_myscripts"
  • Si vous ne faites que déboguer les macros FreeCAD depuis le dossier des macros FreeCAD, et que ce dossier est "C:/Users/<userid>/AppData/Roaming/FreeCAD/Macro", alors utilisez :
    • "localRoot" : "C:/Users/<userid>/AppData/Roaming/FreeCAD/Macro",
    • "remoteRoot" : "C:/Users/<userid>/AppData/Roaming/FreeCAD/Macro".
• Si votre macro ne trouve pas ptvsd alors que vous l'avez installé quelque part, faites précéder 'import ptvsd' par

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

Où le chemin est celui du répertoire où ptvsd a été installé.

• Sur le bord inférieur gauche de VSCode, vous pouvez choisir l'exécutable Python - il est préférable de choisir la version fournie avec FreeCAD.

Dans le paquetage Mac c'est /Applications/FreeCAD.App/Contents/Resources/bin/python.

Vous pouvez le trouver sur votre système en tapant

import sys
print(sys.executable)

dans la console Python de FreeCAD.

• Extraire AppImage.

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

• L'emplacement sqashfs-root est l'endroit où le débogueur sera connecté plus tard.

• Assurez-vous que vous pouvez démarrer une session FreeCAD à partir de l'emplacement squashfs-root.

squashfs-root> ./usr/bin/freecadcmd

• Doit démarrer une session de ligne de commande FreeCAD.

• Installez LiClipse.
  • Il est livré prêt avec pydev et possède des installateurs pour toutes les plateformes.
  • Pour linux, il suffit d'extraire (à n'importe quel endroit) et d'exécuter.

• Configurez liclipse pour le débogage.
  • Clic droit sur l'icône pydev (coin supérieur droit) et choisissez la personnalisation.
    • Activez "PyDev Debug" (par la case à cocher, ou il peut être nécessaire d'aller dans l'onglet "Action Set Availability" et de l'activer d'abord).
    • Dans le menu pydev, vous pouvez maintenant choisir "démarrer le serveur de débogage".
  • Utilisez le menu window/open perspective/other > debug.
    • Cliquez avec le bouton droit de la souris sur l'icône de débogage (coin supérieur droit) et choisissez "customize".
    • Cochez "Debug" fait apparaître les outils de navigation de débogage dans la barre d'outils.
  • Ouvrez les préférences par le menu fenêtre/préférences.
    • Dans PyDev/Interpreters ajoutez "new Interpreter by browsing".
    • L'interprète ajouté devrait être : votre localité/squashfs-root/usr/bin/python.
    • Si vous ne l'utilisez que pour fc, vous pouvez également ajouter les dossiers de l'atelier AddOn ou le faire plus tard dans un projet pydev.

• Trouvez le chemin vers pydevd.py dans votre installation de liclipse.
  • Quelque chose du genre : votre emplacement/liclipse/plugins/org.python.pydev.xx/pysrc.
• Créez un projet pydev normal dans liclipse.
  • Importez des sources externes, par exemple une macro que vous voulez déboguer, ou un atelier externe.
  • Dans cette macro (ou dans le fichier .py de l'atelier), ajoutez les lignes de code :

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

• C'est l'endroit où l'exécution s'arrêtera lorsque la macro sera exécutée.

• Démarrez le serveur de débogage de Liclipse (menu pydev).

• Lancez FreeCAD.

squashfs-root> ./usr/bin/freecad

• Exécutez la macro (ou tout autre fichier avec un déclencheur pydevd.settrace()) à partir de freecad, comme vous le feriez normalement.

• Bon débogage.

• L'utilisation de LiClipse pour le débogage à distance, et les étapes décrites ici liées à liclipse, devraient fonctionner sur n'importe quelle plateforme. Les parties relatives à AppImage sont pour linux uniquement.