Python中的调试

2025年1月5日 | 阅读 4 分钟

简介

调试是软件行业中至关重要的一部分。作为一名 Python 开发者，编写正确无误的代码意味着需要完美掌握调试的艺术。这是一份全面的指南，将向我们展示几种调试方法、Python 工具以及更优的调试方式。

理解基础知识

首先，在深入研究工具和方法论之前，需要理解调试的基本原理。本质上，调试就是查找并修复代码中的 bug。Python 提供了许多内置工具和功能来简化这一过程。

1. Print 语句

最基本的调试类型是利用 print 语句显示不同变量的值和执行路径。它最适用于短脚本，可以快速发现问题。

import pdb
def addition(a, b):
    result = a * b
    return result 
pdb.set_trace()
x = input("Enter first number : ")
y = input("Enter second number : ")
sum = addition(x, y)
print(sum)

输出

 <string>(14)<module>()
(Pdb)

2. 使用 assert 语句

断言语句也称为防御性编程，它断言在代码的选定点必须存在某些条件。

def divide(a, b):
    assert b != 0, "Cannot divide by zero"
    result = a / b
    return result
# Example usage
result = divide(10, 2)
print(f"Division Result: {result}")

输出

Division Result: 5.0

assert 语句检查给定的条件是否存在，如果存在则引发错误。
在开发阶段识别潜在问题非常重要。

3. Traceback 和 Exception（回溯和异常）

掌握 traceback 和 exception 至关重要，因为它们可以识别代码中的错误位置和类型。

def calculate_square_root(x):
    try:
        result=x ** 0.5
        return result
    except Exception as e:
        print(f"Error: {e}")
# Example usage
square_root=calculate_square_root(-1)
print(f"Square Root: {square_root}")

输出

Square Root: (6.123233995736766e-17+1j)

使用 'try' 和 'except' 块可以很好地处理可能的异常。
异常提供了错误的详细信息。

4. 使用 pdb 进行交互式调试

Pdb, the Python Debugger is an effective tool for post mortem and on-the-fly debugging.
import pdb
def complex_function(a, b):
    result = a * b
    pdb.set_trace()  # Start interactive debugging session
    result += a / b
    return result
# Example usage
result = complex_function(3, 0)
print(f"Final Result: {result}")

输出

<string>(6)complex_function()
(Pdb)

'pdb.set_trace()' 会停止程序执行并启动交互式调试器会话。
用户可以查看变量、单步执行代码并计算表达式。

5. 日志记录用于调试

日志记录操作不仅非常灵活且可扩展，还可以作为记录程序运行过程中任何必要数据的一种方式。

import logging
logging.basicConfig(level=logging.DEBUG)
def calculate_interest(principal, rate, time):
    logging.debug(f"Calculating interest for {time} years")
    result = principal * (1 + rate) ** time
    return result
# Example usage
interest = calculate_interest(1000, 0.05, 3)
print(f"Final Interest: {interest}")

输出

DEBUG:root:Calculating interest for 3 years
Final Interest: 1157.6250000000002

日志消息构成了程序操作中发生的活动的轨迹。
使用不同日志级别（DEBUG、INFO、ERROR）的日志记录用于过滤信息。

6. 使用 IDE 调试器

事实上，像 PyCharm 这样的 IDE 具有内置的调试功能，便于使用。

# 此示例假定使用 IDE 调试器。

def perform_complex_operation():
    a = 5
    b = 0
    result = a / b  # Trigger a division by zero error
    return result
# Set a breakpoint in your IDE and run the code in debug mode.
result = perform_complex_operation()
print(f"Result: {result}")

使用 IDE 调试器，您可以设置断点并检查变量，还可以单步执行程序的执行。
可视化和交互式的调试体验。

7. 使用单元测试进行调试

开发人员也可以使用“单元测试”在编程的早期阶段检测和避免 bug。

import unittest
def add_positive_numbers(a, b):
    if a < 0 or b < 0:
        raise ValueError("Both numbers must be positive")
    return a + b
# Unit test for the add_positive_numbers function
class TestAddPositiveNumbers(unittest.TestCase):
    def test_add_positive_numbers(self):
        result = add_positive_numbers(2, 3)
        self.assertEqual(result, 5)
    def test_add_positive_numbers_negative_input(self):
        with self.assertRaises(ValueError):
            add_positive_numbers(-2, 3)
# Run the tests
if __name__ == '__main__':
    unittest.main()

输出

..
Ran 2 tests in 0.000s
OK
Traceback (most recent call last):
  File "", line 21, in 
  File "/usr/local/lib/python3.11/unittest/main.py", line 102, in __init__
Self.runTests()
File "/usr/local/lib/python3.11/unittest/main.py", line 276, in runTests
Sys.exit(not self.result.wasSuccessful())
SystemExit: False

单元测试是一种测试，用于确认程序的所有部分都能正常运行。
确保代码在持续开发过程中保持一致。

结论

随着时间的推移，调试会成为一项熟练的技能。将所有这些测试技术融入您的开发工作流程，可以帮助您发现并纠正 Python 代码中的任何错误。系统而有条理的方法可能包括使用 print 或 assert 语句，或者依赖于高效的调试器以获得有效的结果。

调试不仅仅是修复错误的做法，它是一种帮助您深入理解代码并成为优秀程序员的方法。祝您调试愉快！

下一主题Python 中的默认参数

Python中的调试

简介

理解基础知识

1. Print 语句

2. 使用 assert 语句

3. Traceback 和 Exception（回溯和异常）

4. 使用 pdb 进行交互式调试

5. 日志记录用于调试

6. 使用 IDE 调试器

7. 使用单元测试进行调试

结论

联系信息

关注我们

教程

面试题

在线编译器

Python

Java

.Net Framework

AI, ML and Data Science

Cloud Technology

B.Tech and MCA

Web Technology

PHP

Software Testing

Technical Interview

Java Interview

Python

Web Interview

Database Interview

B.Tech / MCA

Important Interview

Software Testing Interview

Company Interviews

Online Compilers

Multiple Choice Questions

其他

Python中的调试

简介

理解基础知识

1. Print 语句

2. 使用 assert 语句

3. Traceback 和 Exception（回溯和异常）

4. 使用 pdb 进行交互式调试

5. 日志记录用于调试

6. 使用 IDE 调试器

7. 使用单元测试进行调试

结论

相关帖子

如何以追加模式打开Python文件

PyVista Python入门

如何在Python中查找目录是否存在

Python原生数据类型程序

使用Python将XLSX转换为CSV

Python程序：查找客户端的IP地址

如何在Python的Numpy数组中查找值的索引

Python中创建哈希映射

如何在Python中使用Matplotlib单独显示图形

Python中的列联表

订阅 Tpoint Tech

联系信息

关注我们

教程

面试题

在线编译器