Debugging natlink during early initialization

[LexiconCode]

I'm trying to attach a remote debugger natlink during early startup utilizing the instructions below. Is there something I'm missing or these instructions no longer relevant? debugging python instructions.docx

[dougransom]

This appears to have been removed as part of natlink rework.

The documentation needs to be updated and the code also. I'll eventually add some debug support back in, with the configuration settings in the ini files instead of the environment variables.

In the short run, perhaps delete debugging_python_instructions.docx from the mainline code, and assign to me to fix?

[LexiconCode]

In the short run, perhaps delete debugging_python_instructions.docx from the mainline code, and assign to me to fix?

The instructions were on my computer from an earlier version of natlink which looking further has been removed from the mainline. Some sort of debugging early as possible in Natlink initialization would be great at one point.

[dougransom]

I think the portmappings section has to be configured or (preferably if you are on the same machine) just commented out. The defaults don't work, i think this has been a source of consternation for me in the past.

We could add an environment variable back which starts debugpy and does this (copied from https://github.com/dictation-toolbox/natlink/issues/137): `from debugpy import configure, listen, wait_for_client

def debugger_listen_and_wait(): print("Waiting for client...")

configure(python=r"C:\Program Files (x86)\Python39-32\python.exe")
listen(5678)
wait_for_client()

print("Client attached.")`

I think the first time someone needs to debug natlinkcore before it loads natlink.ini and starts up, they can this in to logic to https://github.com/dictation-toolbox/natlinkcore/blob/main/src/natlinkcore/init.py or something similar or follow the directions in https://github.com/dictation-toolbox/natlink/issues/137 wich would I think require temporary modifications to natlinkcore initialization.

These debug-related issues belong in natlinkcore but we should probably just leave them since they are cross-linked with PRs and each other.