zl程序教程

您现在的位置是:首页 >  后端

当前栏目

命令行下 pdb 调试 Python 程序

2023-09-11 14:13:58 时间

官方参考网站 The Python Debugger : https://docs.python.org/3/library/pdb.html
gdb 调试命令的使用及总结:https://blog.csdn.net/freeking101/article/details/54406982
使用 Pdb 调试 Python:https://segmentfault.com/a/1190000006628456

增强的调试器,比如 IPython 的 ipdb 和 pdb++

命令行下 pdb 调试 Python 程序

Python 提供类似于 C++ gdb 的调试工具 pdb,可以使用 pdb 在命令行下进行 Python 程序的调试。 

使用 Pdb 调试 Python 的程序的方式主要是下面的三种

  • 1. 命令行加 -m 参数:python -m pdb testPdb.py
  • 2. 代码中插入一段程序( 比较常用 )。
    if __name__ == "__main__":
        a = 1
        import pdb
        pdb.set_trace()
        b = 2
        c = a + b
        print(c)

    然后正常运行脚本: python testPdb.py ,程序运行到 pdb.set_trace() 就会暂停下来,然后就可以看到调试的提示符 (Pdb)了

  • 3. 在 python 交互环境调试。
            >>> import pdb
            >>> import testPdb
            >>> pdb.run('testPdb.test()')

下面介绍这三种方法:

python -m pdb xxx.py 或者 python -m ipdb xxx.py

1. 单步执行代码,通过命令 python -m pdb xxx.py 启动脚本,进入单步执行模式。即命令行启动目标程序时加上 -m 参数。

这样程序会自动停在第一行,等待你进行调试

我们可以使用调试命令进行调试,和使用IED调试类似。 

 pdb命令行:

    1)进入命令行Debug模式,python -m pdb xxx.py
    2)h:(help)帮助
    3)w:(where)打印当前执行堆栈
    4)d:(down)执行跳转到在当前堆栈的深一层(个人没觉得有什么用处)
    5)u:(up)执行跳转到当前堆栈的上一层
    6)b:(break)添加断点
                 b 列出当前所有断点,和断点执行到统计次数
                 b line_no:当前脚本的line_no行添加断点
                 b filename:line_no:脚本filename的line_no行添加断点
                 b function:在函数function的第一条可执行语句处添加断点
    7)tbreak:(temporary break)临时断点
                 在第一次执行到这个断点之后,就自动删除这个断点,用法和b一样
    8)cl:(clear)清除断点
                cl 清除所有断点
                cl bpnumber1 bpnumber2... 清除断点号为bpnumber1,bpnumber2...的断点
                cl lineno 清除当前脚本lineno行的断点
                cl filename:line_no 清除脚本filename的line_no行的断点
    9)disable:停用断点,参数为bpnumber,和cl的区别是,断点依然存在,只是不启用
    10)enable:激活断点,参数为bpnumber
    11)s:(step)执行下一条命令
                如果本句是函数调用,则s会执行到函数的第一句
    12)n:(next)执行下一条语句
                如果本句是函数调用,则执行函数,接着执行当前执行语句的下一条。
    13)r:(return)执行当前运行的函数直到结束。即执行到函数返回
    14)c:(continue)继续执行,直到遇到下一条断点
    15)l:(list)列出源码
                 l 列出当前执行语句周围11条代码
                 l first 列出first行周围11条代码
                 l first second 列出first--second范围的代码,如果second<first,second将被解析为行数
    16)a:(args)列出当前执行函数的函数
    17)p expression:(print)输出expression的值
    18)pp expression:好看一点的p expression
    19)run:重新启动debug,相当于restart
    20)q:(quit)退出debug
    21)j lineno:(jump)设置下条执行的语句函数
                只能在堆栈的最底层跳转,向后重新执行,向前可直接执行到行号
    22)unt:(until)执行到下一行(跳出循环),或者当前堆栈结束
    23)condition bpnumber conditon,给断点设置条件,当参数condition返回True的时候bpnumber断点有效,否则bpnumber断点无效
    24)bt : 查看调用堆栈信息

注意:
    1:直接输入Enter,会执行上一条命令;
    2:输入PDB 不认识的命令,PDB 会把他当做 Python语句 在当前环境下执行;

在程序中设置 pdb 调试

方法2:在程序中设置 pdb 调试:

示例代码(这里使用 selenium 驱动浏览器,然后得到 cookies ):
python selenium 用法 和 Chrome headless:https://blog.csdn.net/freeking101/article/details/70056173

注意:需要导入 pdb 包

#!/usr/bin/python3
# -*- coding: utf-8 -*-
# @Author      : 
# @File        : mao_yan_cookies.py
# @Software    : PyCharm
# @description : XXX


import pdb
from selenium import webdriver
from selenium.common.exceptions import NoSuchElementException
import selenium.webdriver.support.ui as ui

# from selenium.webdriver.common.action_chains import ActionChains

# chrome_options = webdriver.ChromeOptions()
# # chrome_options.add_argument('--headless')
# browser = webdriver.Chrome(chrome_options=chrome_options)
# # 打开浏览器 设定等待加载时间 访问URL
# wait = ui.WebDriverWait(browser, 10)


# def test_1():
#     browser.get('https://www.baidu.com/')
#     print('打开浏览器')
#     print(browser.title)
#     browser.find_element_by_id('kw').send_keys('测试')
#     print('关闭')
#     browser.quit()
#     print('测试完成')
#
#
# def test_2():
#     url = "https://www.newrank.cn/public/info/list.html?period=pgcweek&type=data"
#     browser.get(url)
#     print(browser.page_source)  # 打印渲染后的页面代码
#
#
# def test_3():
#     url = 'http://www.runoob.com/try/try.php?filename=jqueryui-api-droppable'
#     browser.get(url)
#     browser.switch_to.frame('iframeResult')  # 切换到 嵌套的 html 页面
#     source = browser.find_element_by_css_selector('#draggable')
#     print(source)
#     try:
#         logo = browser.find_element_by_class_name('logo')
#     except NoSuchElementException:
#         print('NO LOGO')
#     browser.switch_to.parent_frame()  # 返回到父 html 页面
#     logo = browser.find_element_by_class_name('logo')
#     print(logo)
#     print(logo.text)


class MaoYanCookies(object):
    def __init__(self):
        super(MaoYanCookies, self).__init__()
        chrome_options = webdriver.ChromeOptions()
        # chrome_options.add_argument('--headless')
        self.browser = webdriver.Chrome(chrome_options=chrome_options)
        # 打开浏览器 设定等待加载时间 访问URL
        self.wait = ui.WebDriverWait(self.browser, 10)
        pass

    def get_cookies(self):
        cinema_url = 'http://maoyan.com/cinema/15280'
        self.browser.get(cinema_url)
        base_time_element = self.browser.find_element_by_xpath('//table[@class="plist"]//tbody//td//a')
        base_time_url = base_time_element.get_attribute('href')
        print(base_time_url)
        self.browser.get(base_time_url)
        cookies = self.browser.get_cookies()
        print(cookies)
        pass

    def __del__(self):
        self.browser.close()


if __name__ == "__main__":
    # test_1()
    # test_2()
    # test_3()
    pdb.set_trace()   # <-- Break point added here,设置的断点
    myc = MaoYanCookies()
    myc.get_cookies()
    pass

在程序中需要打断点处添加 pdb.set_trace()  ,这样程序会在 pdb.set_trace() 暂停并进入 pdb 调试环境,可以用 “p 变量名” 查看变量,或者 c 继续运行

命令行直接输入命令:python mao_yan_cookies.py,然后 回车

Python --- pdb 调试工具

From:http://www.bubuko.com/infodetail-1860030.html

学 C++ 时,老师教我们有 gdb 调试工具,在工作中会经常用到;
学 shell 时,经理让我见到了 "-x" 跟踪调试参数,我每天都会用到;
学 Python 后,我就在寻找类似的参数和工具,谷歌给了我 pdb 工具;

增强的调试器,比如 IPython 的 ipdb 和 pdb++,它们一般都提供了更好的用户体验,添加了有用的额外功能,例如语法突出高亮、更好的回溯和自省。

pdb++

pdb

import pdb    
pdb.set_trace()  #设置断点的地方,放置于程序中

ipdb ( python -m ipdb xxx.py )

相对于 python ,ipython 有漂亮的颜色,和<tab>补全提示,以及 bash 混用;
相对于 python 内置的 pdb,ipdb 的优势也正在于此,其实就是对 ipython 的调用:

使用时需要先安装 ipdb 包:pip install ipdb

import ipdb
ipdb.set_trace()

或者:python -m ipdb xxx.py #单步调试

ipdb 用法和 pdb 类似,只是更友好,更直观,如下:  

常用命令

  • ENTER(重复上次命令)
  • c(继续)
  • l(查找当前位于哪里)
  • s(进入子程序)
  • r(运行直到子程序结束)
  • !<python 命令>
  • h(帮助)
  • a(rgs) 打印当前函数的参数
  • j(ump) 让程序跳转到指定的行数
  • l(ist) 可以列出当前将要运行的代码块
  • n(ext) 让程序运行下一行,如果当前语句有一个函数调用,用 n 是不会进入被调用的函数体中的
  • p(rint) 最有用的命令之一,打印某个变量
  • q(uit) 退出调试
  • r(eturn) 继续执行,直到函数体返回
  • s(tep) 跟 n 相似,但是如果当前有一个函数调用,那么 s 会进入被调用的函数体中

pudb

是全屏的基于控制台的可视化调试器,有点像 c 语言中的 Turbo C 样式

为了支持 pudb,需要在代码中插入:from pudb import set_trace; set_trace()  or  import pudb

rpdb

上面的两种方案要求有终端输出的情况下可行,有时候我们需要以后台形式执行 python,此时是没有输出交互的,比如 django 开发,程序由 uwsgi 管理执行,标准输出已重定向,通常只能通过日志输出信息。这个时候我们就需要一个远程调试工具。
rpdb 会开启一个 socket 连接,用于远程调试,默认端口是 4444:

import rpdb
rpdb.set_trace(port=12345)

这样当程序被 hang 住之后,会监听该端口,可远程连接进行调试:
nc 127.0.0.1 12345

ripdb

rpdb只是 pdb 的远程版本,而 ripdb 就是将 rpdb 和 ipdb 的功能进行了整合,既有远程调试功能,又有漂亮的代码颜色:

import ripdb
ripdb.set_trace(port=12345)

如果还需要<Tab>自动补全功能,还需要对终端进行一下设置:
SAVED_STTY=`stty -g`; stty -icanon -opost -echo -echoe -echok -echoctl -echoke; nc 127.0.0.1 12345; stty $SAVED_STTY