Can you perform Python remote debugging based on Pycharm, like Intellij Idea?

Because the Pycharm script is written on your computer, the Python script is executed in the remote server, sometimes error error, requires the Debug positioning reason, but debug Python code on the Linux server is extremely painful.

This paper summarizes Python remote debugging based on Pycharm to make it easy and fast to debug Python code running on Linux servers.

test environment

• Pycharm 2020.1 Professional Edition, running on Win10
• Remote server is CentOS 7.9x
• Debug the os_collector_linux.py code under the MISC of the Benchmark 5.0 tool as an example

Configure a remote server

File synchronization configuration

• Open Pycharm, open the Project folder D: \ code \ pycode \ benchmarksql-5.0 \ run \ Misc
• In Tools> Deployment> Configuration Configure Remote Server Information
  • Root path: root path of SFTP
  • Local Path: Local Code Storage Path
  • Deployment Path: Server-side code storage path, this path is relative to rootpath path
  • Web path: Can not be used, it is a web project to configure
• After the configuration file is successfully successfully, the following features are available:
  • Compare, download file, remote file, and local files
  • Open a remote file view, you can see files in the remote host on the right window.
    

Select a remote debugger

Select File> Settings> Project> Project Interpreter, then on the right, click on the pinion setting, add a new Interpreter

• The Interpreter address is the address of Python on the remote server.
• Sync Folders is the code storage path on the remote server

Remote debugging

Debug os_collector_linux.py, the running parameter is set to:1 1.0 net_ens2f1 blk_md0
After clicking the debug button, output the following information, the screenshot of the Debug interface is as follows:

sh://omm@172.25.xx.xx:22/opt/anaconda3/bin/python -u /home/omm/.pycharm_helpers/pydev/pydevd.py --multiproc --qt-support=auto --client 0.0.0.0 --port 43016 --file /data1/opengauss/tpcc/benchmarksql-5.0/run/misc/os_collector_linux.py 1 1.0 net_ens2f1 blk_md0
pydev debugger: process 723675 is connecting
Connected to pydev debugger (build 201.6668.115)