FastAPI Backend Development Bootcamp · 课时

调试 FastAPI 应用

掌握 FastAPI 调试技巧，包括使用集成开发环境调试器和日志记录。

调试 FastAPI 应用 是 CoddyKit 上的免费 FastAPI Backend Development Bootcamp 课时。这是第 3 节课，共 4 节。你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。这是 FastAPI Backend Development Bootcamp 学习路径的一部分，你的进度在网页和 CoddyKit 应用中同步。 FastAPI Backend Development Bootcamp 课程共包含 4 节课。

本课时的部分内容尚未翻译，以英文显示。

What is Debugging?

Welcome to debugging! As developers, we don't just write code; we also fix it. Debugging is the process of finding and resolving errors or 'bugs' in your software.

It's an essential skill that helps you understand how your code truly behaves, not just how you think it should.

Find Errors: Pinpoint exactly where issues occur.
Understand Flow: Trace execution path.
Inspect State: See variable values at any point.

The Simple `print()` Debug

The most basic form of debugging is using print() statements. You can sprinkle them throughout your code to see values of variables or confirm if a certain part of your code is being executed.

While quick, print() statements can clutter your output and need to be manually removed later.

Try running this simple example:

def calculate_sum(a, b):
    print(f"DEBUG: Input: a={a}, b={b}")
    result = a + b
    print(f"DEBUG: Output: result={result}")
    return result

if __name__ == "__main__":
    print("Starting calculation...")
    total = calculate_sum(5, 3)
    print(f"Final total: {total}")

Structured Logging with Python

For more robust debugging and application monitoring, Python's built-in logging module is far superior to print(). It allows you to categorize messages by severity.

Key log levels:

DEBUG: Detailed info, typically only for development.
INFO: Confirmation that things are working as expected.
WARNING: Something unexpected happened, but the software is still working.
ERROR: Serious problem, the software couldn't perform a function.
CRITICAL: A severe error, the program might be unable to continue.

Basic Logging in Action

With logging, you can control which messages are displayed based on their level. You can also direct logs to files, the network, or other destinations, making it much more flexible than print().

Run this example to see different log levels in action:

import logging

# Configure basic logging to show DEBUG level and above
logging.basicConfig(level=logging.DEBUG, format='%(asctime)s - %(levelname)s - %(message)s')

def process_data(data):
    logging.debug(f"Attempting to process data: {data}")
    if not data:
        logging.warning("Received empty data for processing!")
        return []
    
    processed = [item.upper() for item in data]
    logging.info(f"Data processed successfully. Items count: {len(processed)}")
    return processed

if __name__ == "__main__":
    logging.info("Application started.")
    result1 = process_data(["apple", "banana"])
    print(f"Result 1: {result1}")
    
    result2 = process_data([])
    print(f"Result 2: {result2}")
    logging.info("Application finished.")

Integrating Logging with FastAPI

FastAPI applications, powered by Uvicorn, already use Python's logging module. When you add your own logging, you can often see it alongside Uvicorn's output.

You can create a named logger for your application to better organize your messages and control their output separately.

Here's a simple FastAPI example with integrated logging:

import logging
from fastapi import FastAPI
import uvicorn

# Get a logger for our application module
logger = logging.getLogger("my-fastapi-app")
logger.setLevel(logging.INFO) # Set default level for this logger

# Add a console handler to the logger (if not already configured by uvicorn)
# This is often handled by uvicorn itself, but good to know for custom setup
handler = logging.StreamHandler()
handler.setFormatter(logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s'))
logger.addHandler(handler)

app = FastAPI()

@app.get("/hello/{name}")
async def say_hello(name: str):
    logger.info(f"API call: /hello/{name}")
    if name == "error":
        logger.error("Simulating an intentional error condition!")
        return {"message": f"Hello {name}, but an error occurred.", "status": "failed"}
    logger.debug(f"Successfully processed name: {name}") # Won't show with INFO level
    return {"message": f"Hello {name}", "status": "success"}

if __name__ == "__main__":
    # In a real setup, you'd run `uvicorn main:app --reload`
    # This block allows direct execution for demonstration
    logger.info("Starting FastAPI application for demonstration...")
    uvicorn.run(app, host="0.0.0.0", port=8000, log_level="info")

Python's `breakpoint()` Function

Since Python 3.7, you can use the built-in breakpoint() function to pause your program's execution at a specific line.

When breakpoint() is called, Python will drop you into a debugger (often pdb, the Python Debugger). From there, you can inspect variables, step through code, and more.

This is extremely powerful for interactive debugging without needing a full IDE setup.

def calculate_discount(price, discount_percentage):
    if not (0 <= discount_percentage <= 100):
        print("Invalid discount percentage.")
        return price

    discount_amount = price * (discount_percentage / 100)
    # Uncomment the line below to pause execution here!
    # breakpoint()
    final_price = price - discount_amount
    return final_price

if __name__ == "__main__":
    print("Calculating final price...")
    item_price = 100
    discount = 15
    final = calculate_discount(item_price, discount)
    print(f"Original price: ${item_price}, Discount: {discount}%, Final price: ${final}")

Power of IDE Debuggers

Integrated Development Environment (IDE) debuggers (like those in VS Code, PyCharm, or others) are the most powerful debugging tools. They offer a visual interface to control your program's execution.

Key benefits:

Visual Breakpoints: Click to set/clear.
Step-by-Step Execution: Control flow precisely.
Variable Inspection: See all variable values in real-time.
Call Stack: Understand how you got to the current point.

Setting & Using Breakpoints

A breakpoint is a marker you place in your code that tells the debugger to pause execution when that line is reached. This lets you 'freeze' your program at a specific moment.

In most IDEs, you set a breakpoint by simply clicking in the gutter (the area to the left of the line numbers) next to the line of code you want to pause at. When you run your application in debug mode, it will stop there.

Navigating Code: Step Over, Into, Out

Once execution is paused at a breakpoint, IDE debuggers provide controls to navigate your code:

Step Over: Executes the current line of code and moves to the next line. If the current line calls a function, the debugger executes the entire function without stepping into it.
Step Into: If the current line contains a function call, the debugger will jump inside that function, allowing you to debug its internal logic.
Step Out: Executes the remainder of the current function and returns to the line where the function was called.

Debugging Knowledge Check

Let's test your understanding of debugging techniques.

Debugging Essentials Recap

Great job! You've explored key debugging techniques for your FastAPI applications and Python code.

print(): Quick & dirty for immediate checks.
logging module: Structured, flexible, and scalable for production and development.
breakpoint(): Python's built-in way to pause execution and enter a debugger.
IDE Debuggers: The most powerful tools for visual step-by-step execution and state inspection.

Mastering these will significantly speed up your development and problem-solving process. Keep practicing them!

常见问题解答

「调试 FastAPI 应用」课时是免费的吗？

是的 — 「调试 FastAPI 应用」的完整文本可在网页上免费阅读。要进行交互式练习（内置代码编辑器和全天候 AI 导师）并解锁 FastAPI Backend Development Bootcamp 课程的其余内容，请升级到 CoddyKit PRO。 FastAPI Backend Development Bootcamp 课程共包含 4 节课。

「调试 FastAPI 应用」这节课中我会学到什么？

掌握 FastAPI 调试技巧，包括使用集成开发环境调试器和日志记录。你通过在浏览器中直接运行的动手代码来练习 FastAPI Backend Development Bootcamp，全天候 AI 导师会在你学习这节课的过程中回答你的问题。

学习 FastAPI Backend Development Bootcamp 需要有经验吗？

无需任何先前经验。CoddyKit 上的 FastAPI Backend Development Bootcamp 课程适合初学者到高级学习者，你可以从这里开始或从头开始，按照自己的节奏学习。这是第 3 节课，共 4 节。

「调试 FastAPI 应用」课时需要多长时间？

大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动，所以你能稳步进步，并在网页和应用中从离开的地方继续。

我能在这节 FastAPI Backend Development Bootcamp 课中编写并运行代码吗？

能。每节 FastAPI Backend Development Bootcamp 课都包含内置代码编辑器，你可以在浏览器中直接编写并运行真实代码，并获得即时 AI 反馈 — 无需本地设置。

此课程中的所有课时

← 返回 FastAPI Backend Development Bootcamp