工作中使用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文件中的連接命令。
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 配置文件后，注意區分啟動本地和遠程兩種不同的調試模式；