Pycharm远程调试原理及具体配置详解

前言

工作中使用Pycharm作为python开发的IDE,作为专业的python集成开发环境,其功能之强大令人折服。开发过程中Debug是必不可少的。平时经常使用Pycharm的remote debug功能,非常好用。但是刚开始的时候并不了解该过程的原理,只是按部就班的配置。于是抽空了解了一下相关知识,期待能够了解其原理,今后能够在需要的时候自己独立的配置调试环境。本文将以浅显易懂的方式讲解一下相关过程。

1.应用环境

常见的IDE基本都具有Local Debugger功能。一般只需要简单的配置,直接加断点并使用Debug方式运行即可使用断点调试。这是对于本地调试开发而言。如果项目已经完成并上线部署到服务端,或者是本地需要在IDE之外单独配置并启动程序,那么显然不能使用本地调试。如果能够配合日志并使用断点定位分析问题,将会事半功倍。那么如何使用本地安装的Pycharm远程调试程序?

2.远程调试原理

如果程序部署在远端,要在本地获取程序运行状态并进行断点调试,必然需要连接到程序并进行通讯。利用Pycharm进行远程调试过程中,Pycharm充当服务器的角色。

首先,对Pycharm Run/Debug Configures进行配置,指定Pycharm安装端的一些属性,比如Pycharm所在主机的IP地址和端口号等。

然后,启动Pycharm的远程调试。这时Pycharm处于监听状态,等待独立于IDE之外运行的程序的连接。

其次,在远端程序刚启动时,需要根据Pycharm Debug Configures中的配置信息,连接到Pycharm。

最后,连接成功之后,当远程客户端运行到本地Pycharm中设置的断点处时,便会在断点处暂停程序的执行,而在本地Pycharm命中断点处能够看到远端程序当前运行的状态和调用栈等信息并进行下一步跟踪和逐步调试。

本地Pycharm中调试的源代码工程应和远端运行的程序源代码保持一致。Pycharm中Remote Debug Configure的配置要保证能够被远程连接。

由于远程客户端使用Pycharm提供的pydevd模块连接到本地的Pycharm remote Debug,两者通讯链接均遵循Pycharm自定义的协议。因此我们不必关心Pycharm设置断点和远程客户端命中断点过程中两端具体的实现和处理过程,只要保证我们的Debug Configure有效即可。然后在需要的地方通过断点暂定程序,分析当前程序状态找出问题所在。

3.Pycharm具体配置

下面是当前的操作环境,原理和步骤都是想通的,可根据实际情况进行配置配即可。

当前环境:

  • Win7
  • Python 2.7.12
  • PyCharm Professional 2017.1.4 (community版本 好像没有remote debug 功能)

本地完成Pycharm的安装,在安装目录找到debug-eggs文件夹,里面有两个文件:

  • pycharm-debug.egg
  • pycharm-debug-py3k.egg

分别对应本地python解释器为python2和python3的情况。

解压pycharm-debug.egg文件,得到的文件夹pycharm-debug中包含的是remote debug相关的模块。

远程客户端便是通过该文件夹中pydevd文件的settrace方法连接到指定的debug server的。

客户端配置:

为方便起见,我们将客户端也放置到本地。(远端的只需要将下面的localhost改为Pycharm所在端的IP即可)

工程中添加刚才解压得到的远程调试模块:

./pycharm-debug

下面还需要封装一个连接到Remote Debug Server的文件

./PycharmRemoteDebug.py

import sys
sys.path.append('./Pycharm_debug')
import pydevd
if __name__ != '__main__':
 pydevd.settrace('localhost', port=23456, stdoutToServer=True, stderrToServer=True, suspend=False)

当前待调试程序:./Main.py

# -*- coding:utf-8 -*-
import PycharmRemoteDebug

class Singleton(object):
 _INSTANCE = {}
 def __init__(self, cls):
  self.cls = cls

 def __call__(self, *args, **kwargs):
  instance = self._INSTANCE.get(self.cls, None)
  if not instance:
   instance = self.cls(*args, **kwargs)
   self._INSTANCE[self.cls] = instance
  return instance

 def __getattr__(self, key):
  return getattr(self.cls, key, None)
@Singleton
class MyClass(object):
 def __init__(self):
  self.init_attr = "init_attr"
 def __getattr__(self, key):
  return self.__dict__.get(key, 1212)
if __name__ == "__main__":
 mcls1 = MyClass()
 mcls2 = MyClass()
 print mcls1 is mcls2

注意调试模块pycharm-debug和链接文件PycharmRemoteDebug.py可以放置到任意的路径和位置,只需要调整模块引用的路径即可。

当前工程目录:

Pycharm Remote Debug 配置:

打开Run/Debug Configures

新建配置 Add New Configuration --> Python Remote Debug

上面的名字可以自己随便命名,端口号可以随便改,只要可用即可。

上面截图绿色部分的标记也告诉了我们客户端连接Debug Server的步骤方法,注意第三步中使用的命令就是我们客户端配置中的PycharmRemoteDebug.py文件中的连接命令。

4.使用步骤

选择刚才新建的Debug模式 Remote_Debug,点击绿色甲壳虫Debug按钮:

Debug Console 显示如下信息,说明本地Debug Server已经开启并在监听状态:

Starting debug server at port 23456
Use the following code to connect to the debugger:
import pydevd
pydevd.settrace('localhost', port=23456, stdoutToServer=True, stderrToServer=True, suspend=False)
Waiting for process connection...

然后在Pycharm中设置断点。

最后启动客户端(运行Main.py,并非在IDE中,直接双击该文件或者使用命令行执行)

Pycharm中命中断点:

Watch程序当前状态以及调用栈等信息:

5.注意事项

  • 如果将程序部署到远端,那么需要Remote Debug配置中的localhost修改为安装Pycharm主机的IP地址,同时将PycharmRemoteDebug.py中的localhost改为同样的IP地址;
  • 使用Pycharm的Deployment功能映射远程和本地代码;
  • 断点命中时,客户端程序处于暂定状态;
  • 如果没有开启Remote Debug Server,运行客户端会卡住;
  • 不需要使用Remote Debug时一定不要在程序启动的时候import PycharmRemoteDebug模块;
  • 添加remote debug 配置文件后,注意区分启动本地和远程两种不同的调试模式;

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持我们。

(0)

相关推荐

  • Pycharm配置远程调试的方法步骤

    动机 一些bug由于本地环境和线上环境的不一致可能导致本地无法复现 本地依赖和线上依赖版本不一致也可以导致一些问题 有时一些bug跟数据相关,本地数据无法和线上数据一致 有些三方平台会验证服务器的合法性或者异步回调结果,如微信支付,这时候本地无法测试 如上所诉,要是有一个很方便调试远程服务器的方法,岂不美哉.通过PyCharm我们可以很方便地实现远程调试,下面详细介绍下PyCharm这个牛叉的功能. 使用远程解释器 默认情况下我们在本地开发Python程序时,使用的是本地的Python解释器,如

  • pycharm下打开、执行并调试scrapy爬虫程序的方法

    首先得有一个Scrapy项目,我在Desktop上新建一个Scrapy的项目叫test,在Desktop目录打开命令行,键入命令:scrapy startproject test1 目录结构如下: 打开Pycharm,选择open 选择项目,ok 打开如下界面之后,按alt + 1, 打开project 面板 在test1/spiders/,文件夹下,新建一个爬虫spider.py, 注意代码中的name="dmoz".这个名字后面会用到. 在test1目录和scrapy.cfg同级目

  • pycharm运行和调试不显示结果的解决方法

    刚在虚拟机里面安装了pycharm,配置(setting)完后,新建一个py文件,键入"hello world",竟然没有结果,虽然运行成功.pycharm太不友好了吧! 然后开始找问题: 1:有人说是文件名的问题,这个可能有,但是我没有改,我觉得我的这个很规范. 2:pyqt的auto选项,试了一下没反应. 3:还有人说版本问题,我check了最新版应该没问题,再装一次太麻烦了,也没有改. 4:还有禁掉pycharm网络的问题.太扯了吧,反正我应该不是. 都TM什么问题些!!!好不靠

  • pycharm 使用心得(五)断点调试

    [运行]和[调试]前的设置,详见前面的文章,helloword. 1,设置断点 在代码前面,行号的后面,鼠标单击,就可以设置断点.如下: 2,调试 断点点击那个绿色的甲虫图标(似乎甲虫已经成为debug专用图标了),进行断点调试. 点击后,会运行到第一个断点.会显示该断点之前的变量信息. 点击Step Over 或者按F8,我们继续往下运行,到下一个断点: 补充: 断点的其他操作,和功能,大家可以把鼠标移到相应的按钮上,看一下,试试便知.如下: 总结: 这就是PyCharm的断点功能,还是很简单

  • python使用PyCharm进行远程开发和调试

    背景描述 有时候Python应用的代码在本地开发环境运行十分正常,但是放到线上以后却出现了莫名其妙的异常,经过再三排查以后还是找不到问题原因,于是就在想,要是可以在服务器环境中进行单步跟踪调试就好了. 然而,在服务器系统上安装一个IDE肯定是不现实的:通过SSH远程到服务器端,采用pdb进行调试虽然可行,但是操作还是较为繁琐,而且也不够直观. 那么,是否可以将开发环境中的IDE与服务器环境相连,实现利用开发环境的IDE调试服务器环境中运行的程序呢? 答案是肯定的,这就是远程调试(Remote D

  • 解决pycharm的Python console不能调试当前程序的问题

    使用python时,程序能运行,但是不能调试,找了半天解决方法,最后此操作分分钟奏效. 两种方法: 方法一:选中要运行的代码,右键Execute Selection in Console(Alt + Shift + E). 方法二:菜单栏--Run--Edit Configuration--勾选Show command line afterwards. 以上这篇解决pycharm的Python console不能调试当前程序的问题就是小编分享给大家的全部内容了,希望能给大家一个参考,也希望大家多

  • Pycharm远程调试原理及具体配置详解

    前言 工作中使用Pycharm作为python开发的IDE,作为专业的python集成开发环境,其功能之强大令人折服.开发过程中Debug是必不可少的.平时经常使用Pycharm的remote debug功能,非常好用.但是刚开始的时候并不了解该过程的原理,只是按部就班的配置.于是抽空了解了一下相关知识,期待能够了解其原理,今后能够在需要的时候自己独立的配置调试环境.本文将以浅显易懂的方式讲解一下相关过程. 1.应用环境 常见的IDE基本都具有Local Debugger功能.一般只需要简单的配

  • 使用PyCharm创建Django项目及基本配置详解

    pycharm是个很不错的python开发工具,大大缩短了python项目的创建时间以及调试时间 在使用python写脚本一段时间后,想尝试使用Django来编写一个python项目,现做以下记录备忘: 1.创建项目 如果本地没有安装与所选python版本对应Django版本,pycharm会自动下载相应的版本: 创建后运行项目,默认页面为http://127.0.0.1:8000/,打开后: 出现上面的页面,则正面项目创建成功 目录结构: 2.创建APP 在Django项目中可以包含多个APP

  • pycharm远程调试openstack代码

    本文实例为大家分享了pycharm远程调试openstack的具体代码,供大家参考,具体内容如下 1.安装pycharm专业版 本文安装pycharm 2016.2.3专业版.网上教程较多,这里不做详细介绍,只要到pycharm官网上下载应用程序进行安装即可. 2.pycharm配置 (1)首先按下图1打开tools->deployment->configuration:  图 (2)接下来add server,补充server name以及传输方式SFTP,点击ok,如下图2所示: (3)填

  • 解决pycharm 远程调试 上传 helpers 卡住的问题

    公司开发环境跑在linux上,用了一周都没问题,突然今天无法使用了,具体表现就是一打开pycharm,同步远程解释器就卡在上传helper文件之处,折腾一上午加一中午,用这个方法解决了,写下来避免其他人入坑! 解决:pycharm安装文件夹下 例如C:\Program Files\JetBrains\PyCharm 2017.2.3这里面找到并且 删掉skeletons文件夹,重新启动再配置远程环境就好了 以上这篇解决pycharm 远程调试 上传 helpers 卡住的问题就是小编分享给大家的

  • 如何使用PyCharm及常用配置详解

    一.Python 的 IDE -- PyCharm 1.1 集成开发环境(IDE) 集成开发环境(IDE,Integrated Development Environment) -- 集成了开发软件需要的大部分工具.一般包括以下工具: 图形用户界面 代码编辑器(支持 代码补全/自动缩进) 编译器/解释器 调试器(断点/单步执行)-- 1.2 PyCharm 介绍 1.PyCharm 是 Python 的一款非常优秀的集成开发环境 2.PyCharm 除了具有一般 IDE 所必备功能外,还可以在

  • Pycharm远程调试和MySQL数据库授权问题

    目录 一.pycharm配置 1.部署配置 2.python解释器 3.运行/调试配置 二.mysql数据库授权问题 1.settings.py 2.mysql远程数据库授权 一.pycharm配置 1.部署配置 工具==>部署==>配置 2.python解释器 文件==>设置==>项目:xx==>python解释器 3.运行/调试配置 运行==>编辑配置==>新增python配置 注:此处特别要注意如果要在pycharm中调试django需要将形参设置成:run

  • PyCharm+PyQt5+QtDesigner配置详解

    关于 最近要在python下做可视化界面的设计,想到之前用QtDesigner来画界面很是方便,当时画完之后都要手动在终端输入 pyuic5 -o 1.py 1.ui 来把.ui文件转换为.py的代码再进行编辑,不是很方便,联想到要是能在PyCharm下完成所有工作就好了,所以就有了这篇博客,简单记录下,不够详细的地方请谅解. 配置前提 PyCharm (这个不多说,官网下载安装) Anaconda 1.8.7(强烈安利,很好的python包管理平台,官网下载安装) python 3.6.5 (

  • Maven之远程仓库的配置详解

    在很多情况下,默认的中央仓库无法满足项目的需求,可能项目需要的构件存在于另外一个远程仓库中,如Company Maven仓库.这时,可以在项目POM中或maven的settings.xml中配置该仓库 <repositories> <repository> <id>company</id> <name>Company Repository</name> <url>http://repository.company.com/

  • Anaconda+spyder+pycharm的pytorch配置详解(GPU)

    第一步 : 从清华大学开源软件镜像站下载Anaconda:https://mirrors.tuna.tsinghua.edu.cn/anaconda/archive/?C=M&O=D 安装过程中需要勾选如下图 装好后测试是否装好,先配置环境变量(可能anaconda安装好后自己就有了) 打开CMD,输入代码 conda list 回车出现包的信息则说明安装完成 打开Anaconda Navigator(桌面没有的话就点击左下角看最近添加)可以看到spyder已经下好了 第二步:下载CUDA(GP

  • Redis Cluster原理及配置详解

    目录 Redis Cluster 原理说的头头是道,这些配置不懂就是纸上谈兵 cluster-enabled cluster-config-file cluster-node-timeout cluster-port cluster-replica-validity-factor cluster-migration-barrier cluster-require-full-coverage cluster-replica-no-failover cluster-allow-reads-when-

随机推荐