Debugging/pl



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/Application\ Support/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ę

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

Znajdź binaria FreeCAD w swoim systemie:

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

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

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.

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ę

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

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

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

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:

Użyj uzyskanego identyfikatora i podaj go do :

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:



Debugowanie w Python
Aby uzyskać bardziej nowoczesne podejście do debugowania w środowisku Python, zobacz te posty:
 * Debugowanie makrodefinicji z VS 2017
 * Debugowanie środowisk pracy w Pythonie
 * python3.dll, Qt5Windgets.dll, Qt5Gui.dll i Qt5Core.dll nie znaleziono

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ą:

Teraz skonfigurujmy debugger.


 * 1) Uruchom Winpdb.
 * 2) Ustaw hasło debuggera na "test": Przejdź do menu  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ą


 * 1) Uruchom program FreeCAD i załaduj powyższy plik do programu FreeCAD,
 * 2) Naciśnij klawisz  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 "", na którym należy dwukrotnie kliknąć,
 * 5) Teraz w Winpdb pojawi się aktualnie wykonywany skrypt,
 * 6) Ustaw punkt przerwanie w ostatniej linii i naciśnij klawisz ,
 * 7) Teraz naciśnij klawisz, aby wejść do kodu Python Draft.makeWire.



Kod Visual Studio (VS Code)
Debugowanie kodu VS →

Wymagania wstępne:


 * Pakiet ptvsd musi być zainstalowany w Python 3 poza środowiskiem programu FreeCAD, a następnie moduł musi być skopiowany do folderu biblioteki Pythona programu FreeCAD.

strona pypi

Dokumentacja Visual Studio Code do zdalnego debugowania

Postępowanie:
 * Dodaj następujący kod na początku swojego skryptu


 * Dodaj konfigurację debugowania w Visual Studio Code.
 * Powinna ona wyglądać następująco:

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


 * W VS Code dodaj punkt przerwania gdziekolwiek chcesz.
 * Uruchom skrypt w programie FreeCAD. FreeCAD zatrzymuje się w oczekiwaniu na załącznik.
 * W VS Code rozpocznij debugowanie używając stworzonej konfiguracji. Powinieneś zobaczyć zmienne w obszarze debuggera.
 * Podczas ustawiania punktów przerwania VS Code będzie zgłaszał, że nie znalazł pliku .py otwartego w edytorze VS Code.
 * Zmień "remoteRoot": "." na "remoteRoot": " "
 * Na przykład, jeśli plik Python rezyduje w /home/FC_myscripts/myscript.py
 * Zmień na: "remoteRoot": "/home/FC_myscripts"
 * Jeśli tylko debugujesz makrodefinicje FreeCAD z folderu makr FreeCAD, a ten folder to "C:/Users/ /AppData/Roaming/FreeCAD/Macro", to użyj:
 * "localRoot": "C:/Users/ /AppData/Roaming/FreeCAD/Macro",
 * "remoteRoot": "C:/Users/ /AppData/Roaming/FreeCAD/Macro".
 * Jeśli twoja makrodefinicja nie może znaleźć ptvsd, mimo że gdzieś go zainstalowało, poprzedź import ptvsd znakiem

Gdzie ścieżka wskazuje katalog, w którym ptvsd został zainstalowany. W pakiecie dla Maca jest to /Applications/FreeCAD.App/Contents/Resources/bin/python.
 * W lewej dolnej krawędzi VSCode możesz wybrać plik wykonywalny Python - najlepiej, aby była to wersja spakowana z programem FreeCAD.

Można go zlokalizować w systemie wpisując:

w konsoli Python programu FreeCAD.



Z LiClipse i AppImage
Debugowanie LiClipse →


 * Wyodrębnij AppImage.


 * Lokalizacja sqashfs-root jest miejscem, do którego później zostanie podłączony debugger.


 * Upewnij się, że możesz rozpocząć sesję FreeCAD z lokalizacji squashfs-root.


 * Powinna uruchomić się sesja wiersza poleceń programu FreeCAD.


 * Zainstaluj LiClipse.
 * Dostarczany jest z pydevem i posiada instalatory dla wszystkich platform.
 * W przypadku linuksa wystarczy rozpakować (do dowolnej lokalizacji) i uruchomić.


 * Skonfiguruj liclipse do debugowania.
 * Kliknij prawym przyciskiem myszy na ikonę pydev (prawy górny róg) i wybierz "Dostosuj".
 * Aktywuj opcję "PyDev Debug" (poprzez zaznaczenie pola wyboru, może być też konieczne przejście do zakładki "Action Set Availability" i aktywowanie jej).
 * W menu pydev można teraz wybrać opcję "Uruchom serwer debugowania".
 * Użyj menu okno → otwórz perspektywę → inne → debug.
 * Kliknij prawym przyciskiem myszy ikonę debugowania (prawy górny róg) i wybierz polecenie Dostosuj.
 * Zaznaczenie opcji "Debuguj" spowoduje pojawienie się na pasku narzędzi narzędzi narzędzi nawigacyjnych do debugowania.
 * Otwórz preferencje przez okno menu → preferencje.
 * W PyDev/Interpreters dodaj "nowy interpreter przez przeglądanie".
 * Dodany interpreter powinien być umieszczony w:.
 * Jeśli używasz tego tylko z FC, możesz dodać także foldery AddOn workbench, lub zrobić to później w projekcie pydev.


 * Znajdź ścieżkę do w swojej instalacji w liclipse.
 * Coś w stylu:.
 * Utwórz zwykły projekt pydev w liclipse.
 * Zaimportuj zewnętrzne źródła, na przykład makro, które chcesz debugować, lub zewnętrzne środowisko pracy.
 * W makrodefinicji (lub pliku .py) dodaj linie kodu:




 * W tym miejscu zostanie zatrzymane wykonywanie makrodefinicji.


 * Uruchom serwer debugowania Liclipse (menu pydev).


 * Uruchom program FreeCAD.


 * Uruchom makrodefinicję (lub jakikolwiek inny plik z wyzwalaczem ) w programie FreeCAD, tak jak robisz to normalnie.


 * Udanego debugowania.


 * Użycie LiClipse do zdalnego debugowania oraz opisane tutaj czynności związane z liclipse powinny działać na każdej platformie. Części związane z AppImage są przeznaczone tylko dla systemu linux.



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