Remote Python Debugger

Co umí

Integrace používá knihovnu debugpy a umožňuje připojit vzdálený debugger. Hodí se pro lokální vývojovou instalaci nebo cílené ladění problému.

Debugger lze spustit při startu, nechat čekat na připojení nebo ho načíst bez aktivace a spustit později akcí debugpy.start.

Příprava

RichPear Home v místní síti otevřete na http://rphome.local:8123. Pokud místní název v dané síti neodpoví, použijte http://IP-ADRESA:8123.

Na počítači, ze kterého ladíte, připravte klienta kompatibilního s debugpy. Nejčastější je Visual Studio Code s Python rozšířením.

Používejte jen v důvěryhodné síti. Každý, kdo dosáhne na debug port, může spouštět kód v instanci. Nikdy nevystavujte port přímo do internetu.

Nastavení

Tato integrace se nastavuje ručně v konfiguraci. Po úpravě YAML ověřte syntaxi, restartujte systém a až potom kontrolujte vytvořené entity.

debugpy:

Výchozí nastavení naslouchá na všech lokálních rozhraních na portu 5678, spouští debugger při startu a nečeká na připojení. Volby jsou host, port, start a wait.

Kontrola

Po restartu ověřte, že port naslouchá jen tam, kde má. Připojte debugger z vývojového počítače a nastavte breakpoint v testovaném kódu.

debugpy:
  host: localhost
  port: 6789
  start: true
  wait: false

Automatizace

Integrace poskytuje akci debugpy.start, která debugger injektuje za běhu, pokud nechcete, aby běžel od startu.

debugpy:
  start: false

Provoz

Aktivní debugger zvyšuje spotřebu paměti a snižuje výkon, i když není připojený klient. V běžné instalaci ho nenechávejte zapnutý trvale.

Jakmile je debugger spuštěný, není k dispozici akce pro jeho zastavení. Pro ukončení restartujte systém.

Řešení problémů

Pokud se klient nepřipojí, zkontrolujte host, port, firewall a to, zda debugger skutečně běží. Při nastavení wait: true může start systému čekat na připojení debuggeru.

Při vzdáleném ladění upravte pathMappings ve vývojovém nástroji tak, aby odpovídaly cestám v běžící instanci.