How to Debug using vs code

[fatheyabdelslam]

i'm using this repo for my next project,
but i can't figure out a way for debugging in vs code or connect jupyter server with vs code,
i want to be able to set breakpoints and watch call sack .. etc.

[miguelvalente]

To run a debugger dockerless do the following.

Create a new file

|-- backend
|   |-- app
|      |-- app
|      |-- alembic
|      |run.py           <--------- Create this file

run.py

import uvicorn

if __name__ == "__main__":
    uvicorn.run("app.main:app", host="0.0.0.0", port=8000, reload=True)

Use default launch

        {
            "name": "Python: Current File",
            "type": "python",
            "request": "launch",
            "program": "${file}",
            "console": "integratedTerminal",
            "justMyCode": true
        }

Let me know if works.

[MaxwellEdisons]

But the environment variable cannot be obtained

[davidhuser]

@MaxwellEdisons you could re-load them again with dotenv (which should already be present as it used by pydantic)

import uvicorn
from dotenv import load_dotenv

load_dotenv("../.env")

if __name__ == "__main__":
    uvicorn.run("app.main:app", host="0.0.0.0", port=8002, reload=True)

[AkashKobal]

Reload dotenv using load_dotenv and reload = True while calling run method

import uvicorn
from dotenv import load_dotenv

load_dotenv("./.env")

if __name__ == "__main__":
    uvicorn.run("app.main:app", host="yout_local_host", port=your_port_no, reload=True)

[QDFish]

I add the below code in backend/app/main.py

if settings.ENVIRONMENT == 'local':
    import debugpy
    print("listening")
    debugpy.listen(("0.0.0.0", 5678))
    print("wait for client")
    debugpy.wait_for_client()

adding attach action in launch.json

        {
            "name": "Python attach",
            "type": "debugpy",
            "request": "attach",
            "connect": {
                "host": "localhost",
                "port": 5678
            },
            "pathMappings": [
                {
                    "localRoot": "${workspaceFolder}/backend",
                    "remoteRoot": "/app"
                }
            ],
            "justMyCode": false,            
        }

and don't forget to add dependency 'debugpy' in the pyproject.toml

now, you can rebuild the compose file and you will see the log 'wait for client' then click the attach action

[gowrishankarin]

Here is a nice YT video...
https://www.youtube.com/watch?v=C-bie4ZY_o0