VS Code - Run Debug Configuration for a console_script in module mode

Question

My setup.py has the following console_scripts as entry points:

entry_points={
        'console_scripts': ['script=myapp.app:do_something',
                            'script2=myapp.app:do_something2'],
    },

with the following structure

.
├── myapp
│   ├── __init__.py
│   ├── app.py
│   ├── mod.py
│   ├── mod2.py
│   └── submodules
│   ├── __init__.py
│   └── mod3.py
├── requirements.txt
└── setup.py

and app looking like

##my_app.app

def do_something():
  #do stuff
def do_something2():
  #do other stuff

How can I get VS code debug configuration to enter at these module attributes. I have this that can run the module if I use if __name__ == "__main__": do_something() but want seperate launch.json files depending on the console_scripts

##launch.json
{
  "configurations": [
    {
      "name": "Python: Module",
      "type": "python",
      "request": "launch",
      "cwd": "${workspaceFolder}",
      "module": "myapp.app",
      "args": ["--hello world"]
    }
  ]
}

Thought you might be able to do simlar with:

  "module": "myapp.app:do_something",

but alas:

No module named myapp.app:do_something

Brett Cannon · Accepted Answer · 2020-05-12 20:51:59Z

9

There currently isn't a way to make this work. At minimum you need a separate module per entry point or have a single module that took a command-line argument that then chose which function to call.

answered May 12, 2020 at 20:51

Brett Cannon

16.4k3 gold badges54 silver badges47 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

jwillis0720 Over a year ago

It's always nice to know. Thank you

Eric Hansen Over a year ago

Is this still the case?

Brett Cannon Over a year ago

@EricHansen yes, launch.json still has no concept of entry points. If you wanted to open a feature request at github.com/microsoft/vscode-python we could consider adding such support.

evolved · Accepted Answer · 2022-02-18 11:07:57Z

1

Here is a launch.json that worked for me to debug mkdocs plugins:

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Python: Module",
            "type": "python",
            "request": "launch",
            "console": "integratedTerminal",
            "module": "mkdocs",
            "args": ["serve"]
        }
    ]
}

It uses "console": "integratedTerminal",.

mkdocs provides the mkdocs entry point that accepts several arguments such as build and serve. This launch.json allowed me to set a breakpoint in a mkdocs plugin python file and stop at that breakpoing after running the mkdocs build/serve process.

answered Feb 18, 2022 at 11:07

evolved

2,29025 silver badges43 bronze badges

Collectives™ on Stack Overflow

VS Code - Run Debug Configuration for a console_script in module mode

2 Answers 2

3 Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

3 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related