Python API数据提取教程：理解循环与字典创建的缩进陷阱_技术教程

本文深入探讨了在Python中从嵌套API响应中提取数据时，因循环缩进不当导致字典追加不完整的问题。通过一个具体的PGA高尔夫赛事数据抓取案例，详细分析了错误原因，并提供了正确的代码结构和解决方案。教程强调了Python中缩进的重要性，指导读者如何确保在多层嵌套循环中正确构建并累加所有目标数据记录，最终生成完整的DataFrame。

在处理来自外部API的复杂JSON数据时，开发者经常需要遍历多层嵌套结构来提取所需信息。然而，不正确的代码缩进是导致数据丢失或不完整的一个常见陷阱。本教程将通过一个实际案例，详细剖析这一问题及其解决方案。

API数据提取与不完整的记录：问题场景

假设我们需要从ESPN的PGA高尔夫赛事API中获取所有参赛选手的信息。API返回的JSON数据结构通常是多层嵌套的，例如：events -> competitions -> competitors -> athlete。我们的目标是从中提取每个赛事（event）的ID、日期、名称以及所有参赛选手（playerName）。

初次尝试的代码可能如下所示，旨在遍历赛事和选手并收集数据：

import requests
import pandas as pd

# 定义API端点
api = 'https://site.web.api.espn.com/apis/site/v2/sports/golf/leaderboard?league=pga'

# 发送GET请求并获取JSON响应
response = requests.get(api)
data = response.json()

# 提取事件数据
events = data['events']

# 创建一个空列表来存储游戏数据
games = []

# 遍历每个事件并获取相关信息
for event in events:
    game_id = event['id']
    date = event['date']
    name = event['name']

    for competition in event['competitions']:
        for competitor in competition['competitors']:
            athlete = competitor['athlete']
            playerName = athlete['displayName'] # 每次循环都会更新playerName变量

    # 在循环外部创建字典并追加，此时playerName已是最后一个competitor的值
    game = {
        'game_id': game_id,
        'date': date,
        'name': name,
        'playerName': playerName
    }
    games.append(game)

# 转换为pandas DataFrame
df = pd.DataFrame(games)
print(df)

运行上述代码，我们可能会得到类似以下的结果：

     game_id               date        name playerName
0  401580329  2025-01-04T05:00Z  The Sentry  Sam Burns

从结果中可以看出，尽管API响应中包含多名选手，但最终的DataFrame中却只显示了最后一位选手的记录（例如 "Sam Burns"），并且每场赛事只有一条记录，这显然不是我们期望的。

问题分析：Python缩进与变量作用域的影响

出现上述问题的原因在于Python的缩进规则和变量作用域。在原始代码中：

最内层的 for competitor in competition['competitors']: 循环确实遍历了所有的 competitor，并且每次迭代都正确地更新了 playerName 变量。
然而，game 字典的创建和 games.append(game) 操作却被放置在 for competitor 循环的外部。
这意味着，对于每个 event，当 for competitor 循环结束后，playerName 变量将保留其在 最后一次 迭代中的值。
随后，game 字典只会被创建一次，并使用这个最终的 playerName 值，然后被追加到 games 列表中。

因此，对于每个赛事，无论有多少参赛者，我们最终只会得到一条记录，其中包含该赛事下最后一个参赛者的信息。

解决方案：调整字典创建和追加的缩进

要解决这个问题，我们需要确保在每次遍历到新的 competitor 时，都创建一个新的 game 字典并将其追加到 games 列表中。这需要将 game 字典的创建和 games.append(game) 操作移动到 for competitor 循环的内部，使其成为该循环的一部分。

以下是修正后的代码：

import requests
import pandas as pd

# 定义API端点
api = 'https://site.web.api.espn.com/apis/site/v2/sports/golf/leaderboard?league=pga'

# 发送GET请求并获取JSON响应
response = requests.get(api)
data = response.json()

# 提取事件数据
events = data['events']

# 创建一个空列表来存储游戏数据
games = []

# 遍历每个事件并获取相关信息
for event in events:
    game_id = event['id']
    date = event['date']
    name = event['name']

    for competition in event['competitions']:
        for competitor in competition['competitors']:
            athlete = competitor['athlete']
            playerName = athlete['displayName']

            # 关键修改：将字典创建和追加操作移到最内层循环内部
            game = {
                'game_id': game_id,
                'date': date,
                'name': name,
                'playerName': playerName
            }
            games.append(game) # 每次循环一个competitor，就创建一个字典并追加

# 转换为pandas DataFrame
df = pd.DataFrame(games)
print(df)

通过这次修改，每当代码遍历到一个新的 competitor 时，它都会立即创建一个包含当前 game_id、date、name 和 playerName 的字典，并将其添加到 games 列表中。这样，所有参赛者的信息都将被正确捕获和存储。

关键点与注意事项

Python的缩进规则： Python使用缩进来定义代码块（如循环体、函数体、条件语句等）。理解这一点对于避免逻辑错误至关重要。错误的缩进不会导致语法错误，但会导致程序逻辑与预期不符。
嵌套循环中的数据累积： 当处理多层嵌套数据结构时，务必清楚在哪个循环层级创建和累积数据。如果需要为内层循环的每个元素生成一条记录，那么字典的创建和列表的追加操作就必须发生在最内层循环内部。
变量作用域： 变量的生命周期和作用域由其定义位置和缩进决定。在循环外部定义的变量在整个循环过程中保持不变，而在循环内部定义的变量则会在每次迭代时重新创建或更新。
调试技巧：
- 使用 print() 语句： 在循环内部的关键位置打印变量的值，可以帮助你追踪数据流和变量状态。例如，在 playerName = athlete['displayName'] 之后立即 print(playerName)，可以确认每个 competitor 的名字是否被正确获取。
- 逐步调试器： 使用IDE（如VS Code、PyCharm）提供的调试器，可以逐行执行代码，观察变量的变化，从而更直观地发现问题。
- 检查API响应结构： 在开始编码前，仔细检查API返回的JSON结构，明确数据路径，有助于规划循环和数据提取逻辑。