Pycharm遠程調(diào)試原理及具體配置詳解
前言
工作中使用Pycharm作為python開發(fā)的IDE,作為專業(yè)的python集成開發(fā)環(huán)境,其功能之強大令人折服。開發(fā)過程中Debug是必不可少的。平時經(jīng)常使用Pycharm的remote debug功能,非常好用。但是剛開始的時候并不了解該過程的原理,只是按部就班的配置。于是抽空了解了一下相關(guān)知識,期待能夠了解其原理,今后能夠在需要的時候自己獨立的配置調(diào)試環(huán)境。本文將以淺顯易懂的方式講解一下相關(guān)過程。
1.應用環(huán)境
常見的IDE基本都具有Local Debugger功能。一般只需要簡單的配置,直接加斷點并使用Debug方式運行即可使用斷點調(diào)試。這是對于本地調(diào)試開發(fā)而言。如果項目已經(jīng)完成并上線部署到服務端,或者是本地需要在IDE之外單獨配置并啟動程序,那么顯然不能使用本地調(diào)試。如果能夠配合日志并使用斷點定位分析問題,將會事半功倍。那么如何使用本地安裝的Pycharm遠程調(diào)試程序?
2.遠程調(diào)試原理
如果程序部署在遠端,要在本地獲取程序運行狀態(tài)并進行斷點調(diào)試,必然需要連接到程序并進行通訊。利用Pycharm進行遠程調(diào)試過程中,Pycharm充當服務器的角色。
首先,對Pycharm Run/Debug Configures進行配置,指定Pycharm安裝端的一些屬性,比如Pycharm所在主機的IP地址和端口號等。
然后,啟動Pycharm的遠程調(diào)試。這時Pycharm處于監(jiān)聽狀態(tài),等待獨立于IDE之外運行的程序的連接。
其次,在遠端程序剛啟動時,需要根據(jù)Pycharm Debug Configures中的配置信息,連接到Pycharm。
最后,連接成功之后,當遠程客戶端運行到本地Pycharm中設置的斷點處時,便會在斷點處暫停程序的執(zhí)行,而在本地Pycharm命中斷點處能夠看到遠端程序當前運行的狀態(tài)和調(diào)用棧等信息并進行下一步跟蹤和逐步調(diào)試。
本地Pycharm中調(diào)試的源代碼工程應和遠端運行的程序源代碼保持一致。Pycharm中Remote Debug Configure的配置要保證能夠被遠程連接。
由于遠程客戶端使用Pycharm提供的pydevd模塊連接到本地的Pycharm remote Debug,兩者通訊鏈接均遵循Pycharm自定義的協(xié)議。因此我們不必關(guān)心Pycharm設置斷點和遠程客戶端命中斷點過程中兩端具體的實現(xiàn)和處理過程,只要保證我們的Debug Configure有效即可。然后在需要的地方通過斷點暫定程序,分析當前程序狀態(tài)找出問題所在。
3.Pycharm具體配置
下面是當前的操作環(huán)境,原理和步驟都是想通的,可根據(jù)實際情況進行配置配即可。
當前環(huán)境:
- 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相關(guān)的模塊。
遠程客戶端便是通過該文件夾中pydevd文件的settrace方法連接到指定的debug server的。
客戶端配置:
為方便起見,我們將客戶端也放置到本地。(遠端的只需要將下面的localhost改為Pycharm所在端的IP即可)
工程中添加剛才解壓得到的遠程調(diào)試模塊:
./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)
當前待調(diào)試程序:./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
注意調(diào)試模塊pycharm-debug和鏈接文件PycharmRemoteDebug.py可以放置到任意的路徑和位置,只需要調(diào)整模塊引用的路徑即可。
當前工程目錄:
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已經(jīng)開啟并在監(jiān)聽狀態(tài):
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中,直接雙擊該文件或者使用命令行執(zhí)行)
Pycharm中命中斷點:
Watch程序當前狀態(tài)以及調(diào)用棧等信息:
5.注意事項
- 如果將程序部署到遠端,那么需要Remote Debug配置中的localhost修改為安裝Pycharm主機的IP地址,同時將PycharmRemoteDebug.py中的localhost改為同樣的IP地址;
- 使用Pycharm的Deployment功能映射遠程和本地代碼;
- 斷點命中時,客戶端程序處于暫定狀態(tài);
- 如果沒有開啟Remote Debug Server,運行客戶端會卡??;
- 不需要使用Remote Debug時一定不要在程序啟動的時候import PycharmRemoteDebug模塊;
- 添加remote debug 配置文件后,注意區(qū)分啟動本地和遠程兩種不同的調(diào)試模式;
以上就是本文的全部內(nèi)容,希望對大家的學習有所幫助,也希望大家多多支持腳本之家。
相關(guān)文章
Python實現(xiàn)圖形用戶界面和游戲開發(fā)的方法和技巧
GUI圖形用戶界面編程,我們可以通過python提供的豐富的組件,快速的實現(xiàn)使用圖形的界面和用戶交互, GUI編程類似于“搭積?”,將?個個組件(Widget)放到窗?中,這篇文章主要給大家介紹了基于Python的GUI圖形用戶界面編程的相關(guān)資料,需要的朋友可以參考下2023-05-05Python中g(shù)etpass模塊無回顯輸入源碼解析
這篇文章主要介紹了Python中g(shù)etpass模塊無回顯輸入源碼解析,具有一定借鑒價值,需要的朋友可以參考下2018-01-01Python使用matplotlib填充圖形指定區(qū)域代碼示例
這篇文章主要介紹了Python使用matplotlib填充圖形指定區(qū)域代碼示例,具有一定借鑒價值,需要的朋友可以參考下2018-01-01解決python繪圖使用subplots出現(xiàn)標題重疊的問題
這篇文章主要介紹了python繪圖使用subplots出現(xiàn)標題重疊的問題及解決方法,本文通過實例圖文相結(jié)合給大家介紹的非常詳細,對大家的學習或工作具有一定的參考借鑒價值,需要的朋友可以參考下2021-04-04python 安裝庫幾種方法之cmd,anaconda,pycharm詳解
在python項目開發(fā)的過程中,需要安裝大大小小的庫,本文會提供幾種安裝庫的方法,通過實例截圖給大家介紹的非常詳細,對大家的學習或工作具有一定的參考借鑒價值,需要的朋友參考下2020-04-04