关闭

使用PyCharm进行Python远程调试

标签: pycharm
4725人阅读 评论(0) 收藏 举报
分类:

背景描述
在机房中,服务器通过ADB与多台Android设备相连接,并通过Python应用程序(QMSInterceptor)对Android设备进行任务调度。
在开发环境中对QMSInterceptor调试完毕后,上传至服务器,发现程序运行异常;但是在开发环境中再三检查,都没有发现问题。于是就在想,要是可以在服务器环境中进行单步跟踪调试就好了。
然而,在服务器系统上安装一个IDE肯定是不现实的;通过SSH远程到服务器端,采用pdb进行调试虽然可行,但是操作还是较为繁琐,而且也不够直观。
那么,是否可以将开发环境中的IDE与服务器环境相连,实现利用开发环境的IDE调试服务器环境中运行的程序呢?
答案是肯定的,这就是远程调试(Remote Debug)。

远程调试的工作原理
远程调试的功能在Eclipse、IntelliJ IDEA等大型IDE中均有支持,实现原理都基本相同,这里采用PyCharm进行说明。

在远程调试的模式下,PyCharm(IDE)扮演服务端(Server)的角色,而运行在远程计算机上的应用程序扮演客户端(Client)的角色。正因如此,进行远程调试时,需要先在本地开发环境中设定端口并启动IDE,IDE会对设定的端口开始监听,等待客户端的连接请求;那远程计算机中的应用程序又是怎样与IDE建立通讯连接的呢?

针对远程调试功能,PyCharm提供了pydevd模块,该模块以pycharm-debug.egg的形式存在于PyCharm的安装路径中。远程计算机安装该库文件后,然后就可以调用pydevd.settrace方法,该方法会指定IDE所在机器的IP地址和监听的端口号,用于与IDE建立连接;建立连接后,便可在IDE中对远程在远程计算机中的程序进行单步调试。

远程调试的配置方法
1、在远程计算机上安装pydevd模块

在本地开发环境的PyCharm安装路径中找到pycharm-debug.egg文件(若远程计算机运行的是Python3,则需要pycharm-debug-py3k.egg)
将pycharm-debug.egg文件拷贝至远程计算机
在远程计算机中将pycharm-debug.egg添加至引用路径,可以采用多种方式:
采用easy_install pycharm-debug.egg命令进行安装(pip命令无法安装,只能使用easy_install)
将pycharm-debug.egg添加至PYTHONPATH或sys.path: import sys; sys.path.append(‘/home/leo/app-dependancies/pycharm-debug.egg’)
解压pycharm-debug.egg,将其中的pydev文件夹拷贝至远程应用程序目录下
验证:在远程计算机的Python命令行中输入import pydevd,若没有报错则说明安装成功
2、在本地开发环境的PyCharm中进行监听配置

【Run】->【Edit Configurations】
【Add New Configuration】->【Python Remote Debug】
填写Local host name和Port,其中Local host name指的是本机开发环境的IP地址,而Port则随便填写一个10000以上的即可;需要注意的是,由于远程计算机需要连接至本地开发环境,因此本地IP地址应该保证远程可以访问得到
【Apply】and【OK】
3、在本地开发环境的PyCharm中配置Mapping映射

4、在远程计算机的应用程序中插入代码

将如下代码插入至远程计算机的应用程序中。

import pydevd
pydevd.settrace(‘100.84.48.156’, port=31235, stdoutToServer=True, stderrToServer=True)
其中,IP地址和端口号要与PyCharm中的监听配置保持一致。

5、在PyCharm中启动Debug Server

【Run】->【Debug…】,选择刚创建的远程调试配置项,在Debug Console中会显示如下信息:

Starting debug server at port 31235
Waiting for process connection…
Use the following code to connect to the debugger:
import pydevd
pydevd.settrace(‘100.84.48.156’, port=31235, stdoutToServer=True, stderrToServer=True)
这说明Debug Server已经启动并处于监听状态。

6、在远程计算机中启动应用程序

在远程计算机中启动应用程序,当执行到pydevd.settrace语句时,便会与本地开发环境中的PyCharm建立通讯连接,接下来便可以在本地IDE中进行单步调试了。

需要注意的是,本地开发环境必须保证IP地址和端口号可从远程计算机访问得到,否则会无法建立连接。

telnet100.84.48.15631235Trying100.84.48.156telnet:Unabletoconnecttoremotehost:Connectionrefused python devicedectector.py
Could not connect to 100.84.48.156: 31236
Traceback (most recent call last):
File “/usr/local/lib/python2.7/dist-packages/pycharm-debug.egg/pydevd_comm.py”, line 478, in StartClient
s.connect((host, port))
File “/usr/lib/python2.7/socket.py”, line 224, in meth
return getattr(self._sock,name)(*args)
error: [Errno 111] Connection refused
Reference
http://stackoverflow.com/questions/6989965/how-do-i-start-up-remote-debugging-with-pycharm
https://www.jetbrains.com/pycharm/help/remote-debugging.html

Alt+Enter 自动添加包
Ctrl+t SVN更新
Ctrl+k SVN提交
Ctrl + / 注释(取消注释)选择的行
Ctrl + N 查找类
Ctrl+Shift+F 高级查找
Ctrl+Enter 补全
Shift + Enter 开始新行
TAB Shift+TAB 缩进/取消缩进所选择的行
Ctrl + Alt + I 自动缩进行
Ctrl + Y 删除当前插入符所在的行
Ctrl + D 复制当前行、或者选择的块
Ctrl + Shift + J 合并行
Ctrl + Shift + V 从最近的缓存区里粘贴
Ctrl + Delete 删除到字符结尾
Ctrl + Backspace 删除到字符的开始
Ctrl + NumPad+/- 展开或者收缩代码块
Ctrl + Shift + NumPad+ 展开所有的代码块
Ctrl + Shift + NumPad- 收缩所有的代码块

0
0

查看评论
* 以上用户言论只代表其个人观点,不代表CSDN网站的观点或立场
    个人资料
    • 访问:475718次
    • 积分:5865
    • 等级:
    • 排名:第4932名
    • 原创:126篇
    • 转载:219篇
    • 译文:6篇
    • 评论:20条
    文章分类
    最新评论