# 9.8 【调试技巧】使用 PyCharm 进行远程调试
一般情况下,我们开发调试都是在个人PC上完成,遇到问题,开一下 `Pycharm` 的调试器,很快就能找到问题所在。
可有些时候,项目代码的运行会对运行环境有依赖,必须在部署了相关依赖组件的服务器上才可以运行,这就直接导致了我们不能在本地进行调试。
对于这种特殊的场景,就我所知,有如下两种解决方案:
- pdb
- Remote Debug
本篇文章会先讲第二种方案,它是 `专业版Pycharm` 才开放的功能,需要你安装专业版的Pycharm,具体升级破解步骤,请自行 Google,这里不涉及。
远程调试的意思,是让我们可以在我们在 PC 上用 Pycharm 的图形化界面来进行调试代码,它和本地调试没有太大的区别,原来怎么调试的现在还是怎么调试。
区别就在于,本地调试不需要事前配置,只要你的代码准备好了,随时可以开始 Debug 。而远程调试需要不少前置步骤,这些设置过程,也是本文的主要内容。
### 1. 新建一个项目
首先,要在Pycharm中新建一个空的项目,后面我们拉服务器上的项目代码就会放置在这个项目目录下。我这边的名字是 NOVA,你可以自己定义。
![](http://image.iswbm.com/20190113104817.png)
### 2. 配置连接服务器
Tools -> Deployment -> configuration
![](http://image.iswbm.com/20190113105512.png)
添加一个`Server`
- Name:填你的服务器的IP
- Type:设定为SFTP
![](http://image.iswbm.com/20190113105858.png)
点击`OK`后,进入如下界面,你可以按我的备注,填写信息:
- SFTP host:公网ip
- Port:服务器开放的ssh端口
- Root path:你要调试的项目代码目录
- Username:你登陆服务器所用的用户
- Auth type:登陆类型,若用密码登陆的就是Password
- Password:选密码登陆后,这边输入你的登陆密码,可以选择保存密码。
这里请注意,要确保你的电脑可以ssh连接到你的服务器,不管是密钥登陆还是密码登陆,如果开启了白名单限制要先解除。
![](http://image.iswbm.com/20190113105931.png)
填写完成后,切换到`Mappings`选项卡,在箭头位置,填写`\`
![](http://image.iswbm.com/20190113110928.png)
以上服务器信息配置,全部正确填写完成后,点击`OK`
接下来,我们要连接远程服务器了。
Tools -> Deployment -> Browse Remote Host
![](http://image.iswbm.com/20190113111042.png)
### 3. 下载项目代码
如果之前填写的服务器登陆信息准确无误的话,现在就可以看到远程的项目代码。
![](http://image.iswbm.com/20190113111151.png)
选择下载远程代码要本地。
![](http://image.iswbm.com/20190113111217.png)
下载完成提示。
![](http://image.iswbm.com/20190113111248.png)
现在的IDE界面应该是这样子的。
![](http://image.iswbm.com/20190113111307.png)
### 4. 下载远程解释器
为什么需要这步呢?
远程调试是在远端的服务器上运行的,它除了依赖其他组件之外,还会有一些很多Python依赖包我们本地并没有。
进入 File -> Settings
按图示,添加远程解释器。
![](http://image.iswbm.com/20190113111747.png)
填写远程服务器信息,跟之前的一样,不再赘述。
![](http://image.iswbm.com/20190113111828.png)
点击`OK`后,会自动下载远程解释器。如果你的项目比较大,这个时间可能会比较久,请耐心等待。
### 5. 添加程序入口
因为我们要在本地DEBUG,所以你一定要知道你的项目的入口程序。如果这个入口程序已经包含在你的项目代码中,那么请略过这一步。
如果没有,就请自己生成入口程序。
比如,我这边的项目,在服务器上是以一个服务运行的。而我们都知道服务的入口是`Service文件`。
`cat /usr/lib/systemd/system/openstack-nova-compute.service`
```
[Unit]
Description=OpenStack Nova Compute Server
After=syslog.target network.target libvirtd.service
[Service]
Environment=LIBGUESTFS_ATTACH_METHOD=appliance
Type=notify
NotifyAccess=all
TimeoutStartSec=0
Restart=always
User=nova
ExecStart=/usr/bin/nova-compute
[Install]
WantedBy=multi-user.target
```
看到那个`ExecStart`没有?那个就是我们程序的入口。
我们只要将其拷贝至我们的Pycharm中,并向远程同步该文件。
![](http://image.iswbm.com/20190113112004.png)
### 6. 调试前设置
开启代码自动同步,这样,我们对代码的修改Pycharm都能识别,并且为我们提交到远程服务器。
![](http://image.iswbm.com/20190113112055.png)
开启 `Gevent compatible`,如果不开启,在调试过程中,很可能出现无法调试,或者无法追踪/查看变量等问题。
![](http://image.iswbm.com/20190113113211.png)
### 7. 开始调试代码
在你的程序入口文件处,点击右键,选择Debug即可。
如果你的程序入口,需要引入参数,这是经常有的事,可以的这里配置。
![](http://image.iswbm.com/20190113112456.png)
配置完点击保存即可。
![](http://image.iswbm.com/20190113112649.png)
### 8. 友情提醒
按照文章的试调试代码,会自动同步代码至远端,千万不要在生产环境使用,一定要在开发环境中使用,否则后果自负。
调试工具给了程序员提供了很大的便利,但还是希望你不要过度依赖。尽量在每次写代码的时候,都追求一次成型,提高自己的编码能力。
- 第一章:安装运行
- 1.1 【环境】快速安装 Python 解释器
- 1.2 【环境】Python 开发环境的搭建
- 1.3 【基础】两种运行 Python 程序方法
- 第二章:数据类型
- 2.1 【基础】常量与变量
- 2.2 【基础】字符串类型
- 2.3 【基础】整数与浮点数
- 2.4 【基础】布尔值:真与假
- 2.5 【基础】学会输入与输出
- 2.6 【基础】字符串格式化
- 2.6 【基础】运算符(超全整理)
- 第三章:数据结构
- 3.1 【基础】列表
- 3.2 【基础】元组
- 3.3 【基础】字典
- 3.4 【基础】集合
- 3.5 【基础】迭代器
- 3.6 【基础】生成器
- 第四章:控制流程
- 4.1 【基础】条件语句:if
- 4.2 【基础】循环语句:for
- 4.3 【基础】循环语句:while
- 4.4 【进阶】五种推导式
- 第五章:学习函数
- 5.1 【基础】普通函数
- 5.2 【基础】匿名函数
- 5.3 【基础】高阶函数
- 5.4 【基础】反射函数
- 5.5 【基础】偏函数
- 5.6 【进阶】泛型函数
- 5.7 【基础】变量的作用域
- 5.8 【进阶】上下文管理器
- 5.9 【进阶】装饰器的六种写法
- 第六章:错误异常
- 6.1 【基础】什么是异常?
- 6.2 【基础】如何抛出和捕获异常?
- 6.3 【基础】如何自定义异常?
- 6.4 【进阶】如何关闭异常自动关联上下文?
- 6.5 【进阶】异常处理的三个好习惯
- 第七章:类与对象
- 7.1 【基础】类的理解与使用
- 7.2 【基础】静态方法与类方法
- 7.3 【基础】私有变量与私有方法
- 7.4 【基础】类的封装(Encapsulation)
- 7.5 【基础】类的继承(Inheritance)
- 7.6 【基础】类的多态(Polymorphism)
- 7.7 【基础】类的 property 属性
- 7.8 【进阶】类的 Mixin 设计模式
- 7.9 【进阶】类的魔术方法(超全整理)
- 7.10 【进阶】神奇的元类编程(metaclass)
- 7.11 【进阶】深藏不露的描述符(Descriptor)
- 第八章:包与模块
- 8.1 【基础】什么是包、模块和库?
- 8.2 【基础】安装第三方包的八种方法
- 8.3 【基础】导入单元的构成
- 8.4 【基础】导入包的标准写法
- 8.5 【进阶】常规包与空间命名包
- 8.6 【进阶】花式导包的八种方法
- 8.7 【进阶】包导入的三个冷门知识点
- 8.8 【基础】pip 的超全使用指南
- 8.9 【进阶】理解模块的缓存
- 8.10 【进阶】理解查找器与加载器
- 8.11 【进阶】实现远程导入模块
- 8.12 【基础】分发工具:distutils和setuptools
- 8.13 【基础】源码包与二进制包有什么区别?
- 8.14 【基础】eggs与wheels 有什么区别?
- 8.15 【进阶】超详细讲解 setup.py 的编写
- 8.16 【进阶】打包辅助神器 PBR 是什么?
- 8.17 【进阶】开源自己的包到 PYPI 上
- 第九章:调试技巧
- 9.1 【调试技巧】超详细图文教你调试代码
- 9.2 【调试技巧】PyCharm 中指定参数调试程序
- 9.3 【调试技巧】PyCharm跑完后立即进入调试模式
- 9.4 【调试技巧】脚本报错后立即进入调试模式
- 9.5 【调试技巧】使用 PDB 进行无界面调试
- 9.6 【调试技巧】如何调试已经运行的程序?
- 9.7 【调试技巧】使用 PySnopper 调试疑难杂症
- 9.8 【调试技巧】使用 PyCharm 进行远程调试
- 第十章:并发编程
- 10.1 【并发编程】从性能角度初探并发编程
- 10.2 【并发编程】创建多线程的几种方法
- 10.3 【并发编程】谈谈线程中的“锁机制”
- 10.4 【并发编程】线程消息通信机制
- 10.5 【并发编程】线程中的信息隔离
- 10.6 【并发编程】线程池创建的几种方法
- 10.7 【并发编程】从 yield 开始入门协程
- 10.8 【并发编程】深入理解yield from语法
- 10.9 【并发编程】初识异步IO框架:asyncio 上篇
- 10.10 【并发编程】深入异步IO框架:asyncio 中篇
- 10.11 【并发编程】实战异步IO框架:asyncio 下篇
- 10.12 【并发编程】生成器与协程,你分清了吗?
- 10.14 【并发编程】浅谈线程安全那些事儿
- 第十二章:虚拟环境
- 12.1 【虚拟环境】为什么要有虚拟环境?
- 12.2 【虚拟环境】方案一:使用 virtualenv
- 12.3 【虚拟环境】方案二:使用 pipenv
- 12.4 【虚拟环境】方案三:使用 pipx
- 12.5 【虚拟环境】方案四:使用 poetry
- 第十三章:绝佳工具
- 13.1 【静态检查】mypy 的使用
- 13.2 【代码测试】pytest 的使用
- 13.3 【代码提交】pre-commit hook
- 13.4 【项目生成】cookiecutter 的使用
- 第十四章:数据可视化
- 14.1 【可视化之matplotlib】一图带你入门matplotlib
- 14.2 【可视化之matplotlib】详解六种可视化图表
- 14.3 【可视化之matplotlib】 绘制正余弦函数图象
- 14.4 【可视化之matplotlib】难点:子图与子区
- 14.5 【可视化之matplotlib】绘制酷炫的gif动态图
- 14.6 【可视化之matplotlib】自动生成图像视频
- 14.7 【可视化神器】最高级的可视化神器: plotly_express