Is there a flag I can check in my code to see if PyCharm's debugger is running?

Question

I'd like to take some actions in my code, conditioned on whether the PyCharm debugger is attached and running — e.g., I've launched my code using the IDE's "Debug" command; something like

if pycharm_debugger_is_running:
    do_something()
else:
    do_another_thing()

Is there a way to do that?

score 12 · Accepted Answer · edited May 23 '17 at 12:13

12

Since Pycharm debugger has been merged with Pydev's, you may like this answer.

Edit

In order to determine whether the script was launched by Pycharm, I can think of manually adding your own environment variable in the Run/Debug Configurations

environ pycharm

And then check for it:

if 'PYCHARM' in os.environ:
    print("running in Pycharm")

Actually the most convenient way would probably be to directly edit the default run configuration to automatically integrate that flag in any new run.

default run config pycharm

edited May 23 '17 at 12:13

Community

1
1

answered Jan 02 '15 at 20:44

Arnaud P

12,022
7
56
67

That seems to work! Is there a way to skip that check altogether if I'm running from PyCharm (i.e., is there a way to tell that my code has been launched from PyCharm)? – orome Jan 02 '15 at 20:55
I've extended my answer ;) – Arnaud P Jan 02 '15 at 21:39
That's a nice solution. – orome Jan 02 '15 at 21:54

score 4 · Answer 2 · answered Sep 16 '18 at 10:57

While setting your own environment variable works, I wanted something that was immutable, so there was no chance I could forget to include, or have to add something to every single project configuration. I found that in the modules PyCharm loads.

import sys

we_are_in_pycharm = '_pydev_bundle.pydev_log' in sys.modules.keys()

if we_are_in_pycharm:
    print("running in Pycharm")

Is there a flag I can check in my code to see if PyCharm's debugger is running?

2 Answers2

Linked