Debugging NiceGui with PyCharm

[brunnenhof]

First Check

• I added a very descriptive title here.
• I have checked the FAQs for a similar question and didn't find it.
• I used the GitHub search to find a similar question and didn't find it.
• I searched the NiceGUI documentation, with the integrated search.
• I already searched online "How to X in NiceGUI" and didn't find any information.

Example Code

NA

Description

Hi, I am a PyCharm user, mainly because of its seemless debugger. But with nicegui, the code just runs without stopping at any breakpoint. Any guidance on how to get this to work is much appreciated (I looked at #3921 and #3344 but this did not make sense to me - and asked Claude AI who could not help) Do I need to set something in ui.run to make it work?

NiceGUI Version

3.5.0

Python Version

3.12.

Browser

Firefox

Operating System

Windows

Additional Context

No response

[evnchn]

I have no experience with PyCharm sorry... However NiceGUI generally starts itself up and I have low confidence that will work with PyCharm.

I think you may find success if you:

1. do FastAPI debugging setup according to https://fastapi.tiangolo.com/tutorial/debugging/
2. attach NiceGUI to a running FastAPI instance via ui.run_with(app) (ref: https://nicegui.io/documentation/section_pages_routing#api_responses)

[brunnenhof]

Many thanks. Will go down that route and report back --- will take some time.

[ulrgolu]

Even with the help of Claude AI I did not succeed getting the PYCHARM debugger to work, even via the fastapi detour. BUT, switching to VSCode I got it to work with this debug json file:

    "configurations": [
        {
            "name": "Debug SDG3 Game (Full)",
            "type": "debugpy",
            "request": "launch",
            "program": "${workspaceFolder}/main.py",
            "console": "integratedTerminal",
            "justMyCode": true,
            "env": {
                "PYTHONUNBUFFERED": "1"
            }
        },

Pressing F5 in the file to be debugged and setting in ui.run() reload=False did the trick.