Debugging/pl: Difference between revisions

From FreeCAD Documentation
(Created page with "[https://code.visualstudio.com/docs/python/debugging#_remote-debugging Dokumentacja Visual Studio Code do zdalnego debugowania]")
(Created page with "Postępowanie: * Dodaj następujący kod na początku swojego skryptu")
Line 226: Line 226:
[https://code.visualstudio.com/docs/python/debugging#_remote-debugging Dokumentacja Visual Studio Code do zdalnego debugowania]
[https://code.visualstudio.com/docs/python/debugging#_remote-debugging Dokumentacja Visual Studio Code do zdalnego debugowania]


Postępowanie:
Steps:
* Dodaj następujący kod na początku swojego skryptu
* Add following code at the beginning of your script


{{Code|code=
{{Code|code=

Revision as of 16:57, 4 December 2021

Najpierw przetestuj

Zanim przejdziesz przez ból debugowania użyj środowiska pracy Test aby sprawdzić czy standardowe testy działają poprawnie. Jeśli testy nie są kompletne, prawdopodobnie instalacja jest uszkodzona.

Wiersz poleceń

Debugowanie w programie FreeCAD jest wspierane przez kilka wewnętrznych mechanizmów. Wersja programu FreeCAD z wierszem poleceń dostarcza kilka opcji do obsługi debugowania.

Są to obecnie rozpoznawane opcje w programie FreeCAD w wersji 0.19:

Opcje ogólne:

 -v [ --version ]     Drukuje ciąg znaków wersji.
 -h [ --help ]        Drukuje komunikat pomocy
 -c [ --console ]     Uruchamia się w trybie konsolowym
 --response-file arg  Można też podać z '@name'
 --dump-config        Zrzuca konfigurację
 --get-config arg     Wypisuje wartość żądanego klucza konfiguracyjnego

Konfiguracja:

 -l [ --write-log ]        Zapisuje plik dziennika do:
                           $HOME/.FreeCAD/FreeCAD.log (Linux)
                           $HOME/Library/Preferencje/FreeCAD/FreeCAD.log (macOS)
                           %APPDATA%FreeCAD/FreeCAD.log (Windows)
 --log-file arg            W przeciwieństwie do --write-log pozwala na logowanie do
                           dowolnego pliku. 
 -u [ --user-cfg ] arg     Plik konfiguracyjny użytkownika do ładowania / zapisywania
                           ustawień użytkownika
 -s [ --system-cfg ] arg   Plik konfiguracyjny systemu do załadowania / zapisu
                           ustawień systemowych
 -t [ --run-test ] arg     Przypadek testowy - lub 0 dla wszystkich
 -M [ --module-path ] arg  Ścieżki do dodatkowych modułów
 -P [ --python-path ] arg  Dodatkowe ścieżki dostępu do Pythona
 --single-instance         Pozwala na uruchomienie pojedynczej instancji aplikacji

Generowanie śladu wstecznego

Jeżeli używasz wersji FreeCAD z ostatniej fazy rozwoju, może ona ulec awarii. Możesz pomóc w rozwiązaniu takich problemów poprzez dostarczenie deweloperom śladów wstecz. Aby to zrobić, musisz mieć uruchomiony debug build oprogramowania. Debug build jest parametrem, który jest ustawiany w czasie kompilacji, więc albo będziesz musiał skompilować FreeCAD samodzielnie, albo zdobyć prekompilowaną wersję debug.

Dla systemu Linux

Debugowanie w systemie Linux →

Wymagania wstępne:

  • zainstalowany pakiet oprogramowania gdb
  • debug build FreeCAD (w tym momencie dostępny tylko przez kompilację ze źródeł)
  • model FreeCAD, który powoduje awarię

Kroki: W oknie terminala wprowadź następujące dane:

Znajdź binaria FreeCAD w swoim systemie:

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

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

GNUdebugger wyśle kilka informacji inicjalizujących. Polecenie (gdb) pokazuje, że GNUDebugger jest uruchomiony w terminalu, teraz wprowadź dane:

(gdb) handle SIG33 noprint nostop
(gdb) run

FreeCAD zostanie teraz uruchomiony. Wykonaj czynności, które powodują awarię lub zawieszenie programu FreeCAD, a następnie wpisz w oknie terminala:

(gdb) bt

Spowoduje to wygenerowanie długiej listy tego, co dokładnie robił program, kiedy się zawiesił lub przestał działać. Dołącz to do swojego raportu o problemie.

(gdb) bt full

Wypisuje również wartości zmiennych lokalnych. Może to być połączone z liczbą, aby ograniczyć ilość wyświetlanych klatek.

Dla systemu macOS

Debugowanie w systemie macOS →

Wymagania wstępne:

  • zainstalowany pakiet oprogramowania lldb
  • debug build FreeCAD
  • model FreeCAD, który powoduje awarię

Kroki: W oknie terminala wprowadź następujące dane:

$ cd FreeCAD/bin
$ lldb FreeCAD

LLDB wyśle kilka informacji inicjalizujących. Polecenie (lldb) pokazuje, że GNUDebugger jest uruchomiony w terminalu, teraz wprowadź dane:

(lldb) run

FreeCAD zostanie teraz uruchomiony. Wykonaj czynności, które powodują awarię lub zawieszenie programu FreeCAD, a następnie wpisz w oknie terminala:

(lldb) bt

Spowoduje to wygenerowanie długiej listy tego, co dokładnie robił program, kiedy się zawiesił lub przestał działać. Dołącz to do swojego raportu o problemie.

Lista bibliotek załadowanych przez FreeCAD

(Dotyczy systemów Linux i macOS)

Czasami pomocne staje się określenie, jakie biblioteki ładuje FreeCAD, szczególnie jeśli ładowane są biblioteki o tej samej nazwie, ale w różnych wersjach (kolizja wersji). Aby zobaczyć, które biblioteki są ładowane przez FreeCAD podczas awarii, powinieneś otworzyć terminal i uruchomić go w debugerze. W drugim oknie terminala znajdź id procesu dla FreeCAD:

ps -A | grep FreeCAD

Użyj uzyskanego identyfikatora i podaj go do lsof:

lsof -p process_id

Wyświetli to długą listę załadowanych zasobów. Tak więc, na przykład, jeśli próbujesz się upewnić, że więcej niż jedna wersja biblioteki Coin3d jest załadowana, przewiń listę lub poszukaj bezpośrednio Coin na liście:

lsof -p process_id | grep Coin

Debugowanie w Python

Aby uzyskać bardziej nowoczesne podejście do debugowania w środowisku Python, zobacz te posty:

winpdb

Debugowanie w winpdb →

Oto przykład użycia Winpdb wewnątrz FreeCAD:

Potrzebujemy debuggera Python Winpdb. Jeśli nie masz go zainstalowanego, na Ubuntu/Debianie zainstaluj go za pomocą:

sudo apt-get install winpdb

Teraz skonfigurujmy debugger.

  1. Uruchom Winpdb.
  2. Ustaw hasło debuggera na "test": Przejdź do menu Plik → Hasło i ustaw hasło.

Teraz krok po kroku uruchomimy testowy skrypt Python w programie FreeCAD.

  1. Uruchomić winpdb i ustawić hasło (np. test)
  2. Utwórz plik Python z tą zawartością
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. Uruchom program FreeCAD i załaduj powyższy plik do programu FreeCAD,
  2. Naciśnij klawisz F6 aby go wykonać,
  3. Teraz FreeCAD przestanie reagować, ponieważ debugger Pythona czeka,
  4. Przełącz się do GUI Windpdb i kliknij na "Dołącz". Po kilku sekundach pojawi się element "<Input>", na którym należy dwukrotnie kliknąć,
  5. Teraz w Winpdb pojawi się aktualnie wykonywany skrypt,
  6. Ustaw przerwanie w ostatniej linii i naciśnij klawisz F5,
  7. Teraz naciśnij klawisz F7, aby wejść do kodu Python Draft.makeWire.

Kod Visual Studio (VS Code)

Debugowanie kodu VS →

Wymagania wstępne:

  • wymagana jest instalacja pakietu ptvsd
pip install ptvsd

strona pypi

Dokumentacja Visual Studio Code do zdalnego debugowania

Postępowanie:

  • Dodaj następujący kod na początku swojego skryptu
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)

w konsoli Python programu FreeCAD.

Debugowanie OpenCasCade

Dla programistów chcących zagłębić się w kernel OpenCasCade, użytkownik @abdullah stworzył wątek orientacyjny omawiający jak tego dokonać.