工作中使用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

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

當前待除錯程式：./Main.py

 1 # -*- coding:utf-8 -*-
 2 import PycharmRemoteDebug
 3 
 4 class Singleton(object):
 5     _INSTANCE = {}
 6 
 7     def __init__(self, cls):
 8         self.cls = cls
 9 
10     def __call__(self, *args, **kwargs):
11         instance = self._INSTANCE.get(self.cls, None)
12         if not instance:
13             instance = self.cls(*args, **kwargs)
14             self._INSTANCE[self.cls] = instance
15         return instance
16 
17     def __getattr__(self, key):
18         return getattr(self.cls, key, None)
19 
20 @Singleton
21 class MyClass(object):
22     def __init__(self):
23         self.init_attr = "init_attr"
24     def __getattr__(self, key):
25         return self.__dict__.get(key, 1212)
26 
27 if __name__ == "__main__":
28     mcls1 = MyClass()
29     mcls2 = MyClass()
30     print mcls1 is mcls2

注意除錯模組pycharm-debug和連結檔案PycharmRemoteDebug.py可以放置到任意的路徑和位置，只需要調整模組引用的路徑即可。

當前工程目錄：

Pycharm Remote Debug 配置：

開啟Run/Debug Configures

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

上面的名字可以自己隨便命名，埠號可以隨便改，只要可用即可。

上面截圖綠色部分的標記也告訴了我們客戶端連線Debug Server的步驟方法，注意第三步中使用的命令就是我們客戶端配置中的PycharmRemoteDebug.py檔案中的連線命令。

5.使用步驟

選擇剛才新建的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程式當前狀態以及呼叫棧等資訊：

4.注意事項

1.  如果將程式部署到遠端，那麼需要Remote Debug配置中的localhost修改為安裝Pycharm主機的IP地址，同時將PycharmRemoteDebug.py中的localhost改為同樣的IP地址；
2. 使用Pycharm的Deployment功能對映遠端和原生代碼；
3. 斷點命中時，客戶端程式處於暫定狀態；
4. 如果沒有開啟Remote Debug Server，執行客戶端會卡住；
5. 不需要使用Remote Debug時一定不要在程式啟動的時候import PycharmRemoteDebug模組；
6. 新增remote debug 配置檔案後，注意區分啟動本地和遠端兩種不同的除錯模式；