文章详情

短信预约-IT技能 免费直播动态提醒

请输入下面的图形验证码

提交验证

短信预约提醒成功

如何在VS Code 中调试 Python 脚本?

2024-12-03 12:55

关注

调试是检测和删除代码中的错误或非预期行为的过程,代码可能会返回一些东西(我们想要的或不想要的) ,也可能根本不会工作,并在执行过程中抛出一些错误。那么当我们在代码中发现一个 bug 时会发生什么呢?

在 Jupyter Notebooks 中,我们可以将代码分割成更多的单元,并按顺序执行它们以检查每个步骤。我们还可以在代码中放入许多 print 语句,只是为了看看是否一切都按计划进行。或者,我们可以使用一些神奇的命令,比如 % debug来打开Jupyter Notebook 的交互式调试器窗口。

最后一种方法与我们调试 Python 脚本的方法非常相似。在本文中,我将展示如何使用 VS Code 快速有效地调试 Python 脚本。最好的情况是,你可以将这些方法应用于任何代码。

在 VS Code 中调试

让我们直接进入调试。首先,我们需要写一些代码。可以用下面简化的脚本完成这项工作。演示时可以看到代码上出了什么问题,以及代码什么时候会立即抛出错误。

import pandas as pd

df = pd.DataFrame(data={"id": ['a', 'b', 'c'],
"value": [1, 2, 3]})

def multiply_value(df, multiplier):
df = df.copy()
df["value"] = df["value"] * multiplier

multiplier_list = [1, 2, "3"]

for mult in multiplier_list:
multiply_value(df, mult)

第一步是打开 VS Code,导航到我们想要设置项目的目录,创建一个新的脚本,然后粘贴上面的代码。

点击窗口右上角的运行按钮(或者右键单击编辑器窗格中的某个地方并选择“ Run Python File in Terminal”)在终端中运行脚本。我们可以在得到运行结果。

我们可以尝试从这里解决它,或者直接进入调试阶段。


我们可以看到窗格填充了预期的信息。此外,在出现错误的地方弹出的屏幕,连同其类型和一些额外的信息。这对于确定 bug 有很大帮助。让我们看一下错误发生的函数,在这里,我们可以看到乘数的值为“3” ,而它应该是一个数字才能完成乘法工作。

虽然这个事例情况很简单,因为我们自己定义了列表,但在更复杂的脚本中,它可能真的很容易丢失每个变量所存储的内容。特别是当值从其他地方填充时,例如,数据库。

调试控制台与终端不同,在终端中,我们只能看到打印/日志和脚本中断时的错误消息,而在调试控制台中,我们可以交互式地工作并探索变量。每当调试器遇到断点或发生错误时,在调试控制台中,我们可以在该步骤上使用变量的当前状态执行命令。上图中,我们检查了 mult 变量的当前值,打印了 df 并检查了我们是否真的可以将列乘以3。

这个功能在脚本崩溃时非常有用。例如,我们可以在调试控制台中运行以下命令:

df[“value”] * “3”

观察我们之前遇到过的相同的错误。虽然这可以帮我们调试脚本,但是在调试更复杂的案例时,了解更多的方法是很有帮助的。

断点类型

VS Code提供了三种类型的断点,每种都有不同的用途。要选择它们,我们首先创建一个普通的断点,然后右键单击它并选择“Edit breakpoint…”。


当然,您也可以通过右键单击并选择“禁用断点”来临时禁用一个断点。

调试配置文件

调试配置在调试会话期间驱动 VS 代码的行为。配置在 launch.json 文件中定义,该文件存储在。我们工作区的 vscode 文件夹。要访问 JSON 文件,我们可以在 VS Code 中首次打开调试窗口时单击“ create a launch.JSON file” ,或者只需单击用于启动调试会话的绿色播放按钮旁边的“ gear”图标。

使用配置文件我们可以做什么?设置环境变量是一个经常派上用场的例子。假设我们的代码是使用某个调度程序部署和运行的,例如,Airflow (远不止这些,但是现在我们假设这样的简化是可以接受的)。然后,我们使用一组 env 变量来控制脚本的行为。例如,在 ETL 脚本中,我们可以使用 env 变量来控制是否扩展特性。

当我们尝试在本地调试代码时,我们的系统中不会有那些 env 变量,因为它们是由气流处理的。因此,一种选择是在全球范围内增加这些措施,但这可能导致以后出现混乱。或者,我们可以使用 launch.json 配置文件为调试环境提供一组 env 变量。

为此,我们按下“ gear”图标来打开文件,并通过添加第10行的内容来修改它。

{
"version": "0.2.0",
"configurations": [
{
"name": "Python: Current File",
"type": "python",
"request": "launch",
"program": "${file}",
"console": "integratedTerminal",
"env": {"RUN_TYPE": "prod"},
}
]
}

当我们运行下一个调试会话时,我们可以直接访问 RUN _ type env 变量。

结语

在本文中展示了如何快速使用 VS Code 来调试 Python 脚本。使用本文中提到的几种技术,您可以快速缩小潜在错误的来源,并在交互式调试控制台中尝试不同的修复方法。

如果你没有在工作中遇到过调试脚本,学会这种技能是非常重要的。虽然本文是特定于 VS Code 的,但大多数 ide (例如 PyCharm)都提供了类似的功能集。

【51CTO译稿,合作站点转载请注明原文译者和出处为51CTO.com】

阅读原文内容投诉

免责声明:

① 本站未注明“稿件来源”的信息均来自网络整理。其文字、图片和音视频稿件的所属权归原作者所有。本站收集整理出于非商业性的教育和科研之目的,并不意味着本站赞同其观点或证实其内容的真实性。仅作为临时的测试数据,供内部测试之用。本站并未授权任何人以任何方式主动获取本站任何信息。

② 本站未注明“稿件来源”的临时测试数据将在测试完成后最终做删除处理。有问题或投稿请发送至: 邮箱/279061341@qq.com QQ/279061341

软考中级精品资料免费领

  • 历年真题答案解析
  • 备考技巧名师总结
  • 高频考点精准押题
  • 2024年上半年信息系统项目管理师第二批次真题及答案解析(完整版)

    难度     813人已做
    查看
  • 【考后总结】2024年5月26日信息系统项目管理师第2批次考情分析

    难度     354人已做
    查看
  • 【考后总结】2024年5月25日信息系统项目管理师第1批次考情分析

    难度     318人已做
    查看
  • 2024年上半年软考高项第一、二批次真题考点汇总(完整版)

    难度     435人已做
    查看
  • 2024年上半年系统架构设计师考试综合知识真题

    难度     224人已做
    查看

相关文章

发现更多好内容

猜你喜欢

AI推送时光机
位置:首页-资讯-后端开发
咦!没有更多了?去看看其它编程学习网 内容吧
首页课程
资料下载
问答资讯