python使用IPython调试debug程序

目录
  • 安装
  • 使用方法
  • 优点
  • 提示和不足
  • 参考链接

关于IPython使用的入门文章,主要介绍了如何在程序代码中嵌入ipython用于调试,并分析了优点与不足。

在 Python 中编程时,我会花费大量时间使用 IPython 及其强大的交互式提示,不仅用于一些一次性计算,还用于大量实际编程和调试。我特别将它用于一些探索性的编程,比如对一些不熟悉的 API,或者想知道程序在代码中特定位置的运行状态。

我不确定这种IPython调试的方法有多普遍,但我很少听到其他人谈论它,所以我认为它值得分享。

安装

使用前,需要将 IPython 安装到您当前的 virtualenv 中:

pip install ipython

使用方法

基本上有两种方法可以打开 IPython 提示符。

第一种是直接从终端运行它:

$ ipython
Python 3.9.5 (default, Jul  1 2021, 11:45:58)
Type 'copyright', 'credits' or 'license' for more information
IPython 8.3.0 -- An enhanced Interactive Python. Type '?' for help.
In [1]:

在 Django 项目中,如果您安装了 IPython,也可以使用 ./manage.py shell,好处是它会为帮您正确初始化 Django。

如果您想探索编写一些“顶级”代码,例如,在尚未创建入口点的情况下,编写一个新的功能,那么这种方法很管用。然而,我写的大部分代码都不是这样的。大多数时候,我发现自己需要写代码时,已经想好10层的函数调用了——比如:

  • 我正在一个Django应用程序中编写一些视图代码,其中有一个请求对象--如果你在IPython提示符下从头开始,你不可能轻易重新创建这个对象。
  • 或者,模型层代码,比如 save() 方法内部的代码,该方法本身正在被您尚未编写的其他代码调用,比如Django admin或某个信号。
  • 或者,在一个测试中,设置代码已经创建了一大堆在打开IPython时不可用的东西。

对于这些情况,我使用第二种方法:

找到我想要修改、探索或调试的代码。这通常是我自己的代码,但也可能是第三方库。我一直习惯在 virtualenv 中工作,所以即使使用第三方库,在我的编辑器中“go to definition”也会直接将我带到代码的可写副本的定义区(除了不是用 Python 编写的代码)。

插入 IPython 提示的代码并保存文件:

import IPython; IPython.embed()

我将此绑定到编辑器中的一个功能键。
因此,如果它是Django视图,那么代码最终可能会是这样:

def contact_us(request):
    if request.method == "POST":
        form = ContactUsForm_class(request.POST)
        if form.is_valid():
            import IPython; IPython.embed()
        # …

以适当的方式触发代码。对于上述情况,首先需要在终端中运行 Django 服务器,然后打开网页,填写表单并按下提交。对于测试,它将从终端运行特定的测试。对于命令行应用程序,它将直接运行应用程序。

在终端中,我会发现自己现在已经在 IPython REPL 中,我可以继续:

  • 想出我需要写什么代码
  • 或者调试我感到困惑的代码

请注意,您可以在此 REPL 中编写和编辑多行代码——它不像编辑器那么舒服,但没关系,并且具有良好的历史记录支持。关于 IPython 及其更多特性,你可以在官方 文档 中了解它。

对于那些有其他语言背景的人来说,可能还值得指出的是,Python REPL 与普通 Python 并没有什么不同。你可以在普通 Python 中做的所有事情,比如定义函数和类,都可以在 REPL 中进行。

调试结束后,我可以将任何有用的片段从 REPL 复制回我的真实代码中,使用历史记录来查看我曾经输入的内容。

优点

这种方法的优点是:

  • 当您实际拥有一个对象时,您可以更轻松地探索API和对象(APIs and objects),而不是阅读关于对象的文档,或者编辑器的自动完成工具推断对象应该具有的内容。例如,Django的HttpRequest上有哪些属性和方法?你不必确保你有正确的类型注释,并且希望它们是完整的,或者假设值是什么——你已经有了对象,你可以检查它,用广泛的合适的制表符自动补全完成。你可以调用函数,看看它们是怎么做的。
    例如,Django的请求对象通常有一个用户(user)属性,该属性不属于HttpRequest定义的一部分,因为它是在以后添加的。但它在REPL中是可见的。
  • 您可以直接探索程序的整体状态。这对于探索性编程和调试来说都是一个巨大的优势。
    对于调试,pdb 和类似的调试工具和环境通常会为您提供“the state of the system”,并且它们更擅长单步执行多层代码。但我经常发现 IPython 提示的功能和舒适性对于探索和寻找解决方案要好得多。

这种环境的感觉并不像Lisp中REPL驱动的编程那样流畅,但我仍然觉得它非常有趣和高效。与许多其他方法相比,比如迭代代码,然后进行手动或自动测试,它将反馈循环的延迟从几秒或几分钟减少到几毫秒,这是巨大的效率提升。

提示和不足

IPython 有很多很酷的特性可以在 REPL 环境中帮助你,比如 %autoreload 和许多其他很酷的魔法。你应该花时间去了解他们!

在多线程(或多进程)环境中,IPython 提示表现不是很好。如果可能的话,关闭多线程,或者确保你没有遇到那个问题。

如果您确实在终端中搞砸了,您可能需要手动找到要杀死的进程并在终端中进行重置。

使用 Django 开发服务器:

  • 它默认是多线程的,所以要么确保你不会多次点击视图代码,要么使用 --nothreading。
  • 当心自动重新加载,如果你在启动时仍然处于 IPython 提示符中,它会搞砸你。要么使用 --noreload 要么确保在执行任何会触发重新加载的操作之前干净地退出 IPython。

当心捕获标准输入/输出的环境,这会破坏这种功能。

pytest 默认捕获标准输入并破坏一些事物。您可以使用 -s 将其关闭。此外,如果您使用的是 pytest-xdist,您应该记得使用 -n0 来关闭多个进程。

使用 IPython.embed() 时,由于 Python 的限制,存在一个烦人的错误,涉及闭包和未定义的名称。它经常在使用生成器表达式时出现,但在其他时候也是如此。它通常可以通过以下方式解决:

globals().update(locals())

参考链接

以上就是python使用IPython调试debug程序的详细内容,更多关于IPython调试debug的资料请关注我们其它相关文章!

(0)

相关推荐

  • 在IPython中执行Python程序文件的示例

    简单使用了一下之后,我觉得如果有机会(公司里面编码是极不自由的,也无所谓,我在公司不做数据分析),我肯定是更喜欢使用IPython作为我的Python shell环境了.简单的接触发现了不少我喜欢的功能.其中,在这种命令模式下能够方便地调用Python文件以及能够识别部分物理磁盘路径信息就是我比较喜欢的. 在IPython中集成了几个常用的shell命令,用起来确实感觉顺手了不少.之前偶尔需要用到跟操作系统交互的时候,我都是通过引用os模块. 下面是一个简单的小例子: In [18]: pwd

  • Python 在 VSCode 中使用 IPython Kernel 的方法详解

    本文介绍,在 VSCode 使用 IPython Kernel的设置方法,详细介绍如下所示: 要达到的效果: 只需按下 Ctrl+:,选中的几行代码,就会自动发送到 IPython Kernel,并运行,得到结果!当然,快捷键也可以另行设置! 为什么要这么做: 首先,这种配置方式,比较轻量快速: 主要用于,增加写代码时的"互动性",可以边写代码,边测试:例如,在写代码时候,快速测试下,一行或几行代码,看看效果: 所以,非常适合新手,边写边学习,或者,需要写个几十行代码,迅速解决问题,的

  • Python中使用ipython的详细教程

    ipython简介 ipython他是一个非常流行的python解释器,相比于原生的python解释器,有太多优点和长处,因此几乎是python开发人员的必知必会. 1.ipython相比于原生的python有什么优势 (1) python shell不能在退出保存历史:ipython历史记录自动保存:保存在history.sqlite文件下:可用"_"."__"."___"调用最近三次记录: (2) python shell不支持tab自动补全

  • Python利用IPython提高开发效率

    一.IPython 简介 IPython 是一个交互式的 Python 解释器,而且它更加高效. 它和大多传统工作模式(编辑 -> 编译 -> 运行)不同的是, 它采用的工作模式是:执行 -> 探索 ,而大部分和数据分析相关的代 码都含有探索式操作(比如试误法和迭代法),所以 IPython 能大大提高编码效率. IPython 发展到现在,它不仅仅只是一个加强版的 Python shell 了, 它集成了 GUI 控制台,这可以让你直接进行绘图操作:它还有一个基于 Web 的交互式笔记

  • 在spyder IPython console中,运行代码加入参数的实例

    在路径后面加入args = '参数1,[参数,]',如下 runfile('/home/liuxiaodong/image_stream/image.py', args = '0', wdir='/home/liuxiaodong/image_stream') 或者直接在ipython中输入要执行的脚本加参数 补充知识:ipython 下命令行参数如何传入 1:问题描述 使用spyder运行Python程序时,有时会遇到程序本身需要有命令行参数(程序内有arg[])传入才能运行的情况.我之前一般

  • python使用IPython调试debug程序

    目录 安装 使用方法 优点 提示和不足 参考链接 关于IPython使用的入门文章,主要介绍了如何在程序代码中嵌入ipython用于调试,并分析了优点与不足. 在 Python 中编程时,我会花费大量时间使用 IPython 及其强大的交互式提示,不仅用于一些一次性计算,还用于大量实际编程和调试.我特别将它用于一些探索性的编程,比如对一些不熟悉的 API,或者想知道程序在代码中特定位置的运行状态. 我不确定这种IPython调试的方法有多普遍,但我很少听到其他人谈论它,所以我认为它值得分享. 安

  • 解决pycharm的Python console不能调试当前程序的问题

    使用python时,程序能运行,但是不能调试,找了半天解决方法,最后此操作分分钟奏效. 两种方法: 方法一:选中要运行的代码,右键Execute Selection in Console(Alt + Shift + E). 方法二:菜单栏--Run--Edit Configuration--勾选Show command line afterwards. 以上这篇解决pycharm的Python console不能调试当前程序的问题就是小编分享给大家的全部内容了,希望能给大家一个参考,也希望大家多

  • 浅谈Python在pycharm中的调试(debug)

    作为一名程序员,调试(debug)程序是一项必会的事情,在利用pycharm这个pythonIDE时,不好好利用其调试功能真的是太可惜了. 借用这两天学习机器学习的工程. 在Deep_Learing工程中创建两个python文件,其中执行程序的文件名称为main.py,另一个KNN.py则是机器学习中一个小的模块,其中有算法代码. 在main.py中这样编写: 最关键的是写出 if __name__ == "__main__": 这句代码,这句代码代表主函数运行的入口,在其中写要进行测

  • 调试PHP程序的多种方法介绍

    调试的定义:通过一定方法,在程序中找到并减少缺陷的数量,从而使其能正常工作. 这里说一些如何调试PHP程序的经验. 一.PHP自带的调试功能 1.自带的报错功能 两个名词:开发环境是开发人员在进行开发和调试的环境,生产环境是最终客户在用的线上环境: 开发环境和生产环境要分开设置报错功能. (1)开发环境 开发环境需要打开报错,以下是php.ini的配置项及其说明: 复制代码 代码如下: ; This directive sets the error reporting level. ; Deve

  • 基于Python的Android图形解锁程序详解

    安卓手机的图形锁是3x3的点阵,按次序连接数个点从而达到锁定/解锁的功能.最少需要连接4个点,最多能连接9个点.网上也有暴力删除手机图形锁的方法,即直接干掉图形锁功能.但假如你想进入别人的手机,但又不想引起其警觉的话--你可以参考一下本文(前提条件:手机需要root,而且打开调试模式.一般来讲,如果用过诸如"豌豆荚手机助手"."360手机助手"一类的软件,都会被要求打开调试模式的.如果要删除手机内置软件,则需要将手机root). 首先科普一下,安卓手机是如何标记这9

  • Python Flask 搭建微信小程序后台详解

    前言: 近期需要开发一个打分的微信小程序,涉及到与后台服务器的数据交互,因为业务逻辑相对简单,故选择Python的轻量化web框架Flask来搭建后台程序.因为是初次接触小程序,经过一番摸索和尝试,个人觉得的微信小程序与后台的交互有点像ajax,所以有ajax开发经验的同学开发小程序应该很容易上手,因为本文着重讲解后台程序的搭建,所以,微信小程序的前端开发将一笔带过,有兴趣学习小程序前端语言的同学可移步网易云课堂的一套快速入门课程<轻松玩转微信小程序>. 分三步讲解微信小程序与Python后台

  • 调试php程序的简单步骤

    一般如何调试php程序? 一般使用Xdebug,Xdebug是一个开放源代码的PHP程序调试器(即一个Debug工具),可以用来跟踪,调试和分析PHP程序的运行状况. 第一步.下载xdebug 有两个版本带有Non-thread-safe和不带有Non-thread-safe,缩写(ts)主要是看你的php版本是否线程安全版本. 然后把下载的dll拷贝到php里面的ext文件夹里(扩展dll都在这里),改名为php_xdebug.dll 小编用的Windows7 + apache + mysql

  • python:动态路由的Flask程序代码

    如下所示: # Copyright (c)2018, 东北大学软件学院学生 # All rightsreserved # 文件名称:a.py # 作 者:孔云 #问题描述: from flask import Flask app=Flask(__name__) @app.route('/') def index(): return '<h1>Flask Web程序开始了....<h1>' @app.route('/user/<name>') def user(name)

  • 使用VSCode和VS2017编译调试STM32程序的实现

    近两年,微软越来越拥抱开源支持跨平台,win10搭载Linux子系统,开源VSCode作为跨平台编辑器,VS2017官方支持了Linux和嵌入式开发功能. ST也是,近两年开发的软件工具基本都是跨平台(基于Java)的,比如STM32CubeMX,MCUFinder,STM32CubeProgrammer等.17年年底收购了truestudio的开发公司-Atollic.这个公司的IDE就是基于Eclipse使用GNU套装的. 官方都支持了,那我们有必要了解一下.要是好用,说不定就可以淘汰老旧的

随机推荐