Debugging with Pygeoapi

[C-Loftus]

Hi all,

This is partially a comment for the future reference of others, and partially a question to see if others have strategies for debugging while doing pygeoapi development.

When I am inside the container using the pygeoapi python interpreter, from what I can tell, the debugger for vscode slightly modifies the python interpreter being used and as a result, JInja2 fails, prevents pygeoapi from launching, and throws an error AttributeError: module 'posixpath' has no attribute 'sep'

This bug is the result of an older jinja version I believe that is now fixed but not yet updated.

pallets/jinja#1697

I wanted to write this to both document it for others, since it is a confusing error, and also see if anyone had workarounds they like.

An example config to reproduce this in launch.json would be the following. I am running it inside a devcontainer in vscode.

        {
            "name": "Python Debugger: Module",
            "python": "/usr/bin/python3",
            "type": "debugpy",
            "request": "launch",
            "module": "gunicorn",
            "args": [
                "pygeoapi.flask_app:APP"
            ]
        },

[C-Loftus]

Another full launch.json debug config that works well for me. Seems like avoiding gunicorn and using the default flask server is a bit better for debugging. Had some weird fork issues with gunicorn workers locally on macos

{
  "version": "0.2.0",
  "configurations": [
    {
      "name": "Python Debugger: Flask",
      "type": "debugpy",
      "request": "launch",
      "module": "flask",
      "env": {
        "FLASK_APP": "pygeoapi.flask_app:APP",
        "FLASK_ENV": "development",
        "PYGEOAPI_CONFIG": "${workspaceFolder}/pygeoapi.config.yml",
        "PYGEOAPI_OPENAPI": "${workspaceFolder}/local.openapi.yml"
      },
      "args": [
        "run",
        "--host=127.0.0.1",
        "--port=5005"
      ],
      "jinja": true
    }
  ]
}

[C-Loftus]

I previously used this for starlette but as of right now don't recommend using starlette due to lack of async support internally

{ 
"version": "0.2.0",
  "configurations": [
    {
      "name": "Python Debugger: Starlette",
      "type": "debugpy",
      "request": "launch",
      "module": "uvicorn",
      "args": ["pygeoapi.starlette_app:APP", "--reload", "--port", "5005"],
      "env": {
        "PYGEOAPI_CONFIG": "${workspaceFolder}/pygeoapi.config.yml",
        "PYGEOAPI_OPENAPI": "${workspaceFolder}/local.openapi.yml"
      },
      "autoStartBrowser": true
    }
  ]
}