访问Pandas对象不存在的索引引发KeyError，如何修复该问题？

当传入的Pandas对象（Series/DataFrame）不存在指定索引时，直接通过[]访问会触发KeyError，导致代码中断。以下是问题复现及解决方案：

问题复现代码 #

import pandas as pd

def check_user_data(meta_df = pd.DataFrame(),
                 params = ['param1','param2']):
    if meta_df['alpha'] in params:
        print('Alpha is available')
    if meta_df['beta'] in params:
        print('Beta is available')

user_df = pd.Series(index=['alpha'],data=['alpha1'])
check_user_data(meta_df = user_df,
                 params = ['alpha1','beta1'])

报错信息 #

Alpha is available

---------------------------------------------------------------------------
KeyError                                  Traceback (most recent call last)

KeyError: 'beta'

The above exception was the direct cause of the following exception:

KeyError                                  Traceback (most recent call last)

Cell In[47], line 5, in check_user_data(meta_df, params)
----> 5 if meta_df['beta'] in params:
      6     print('Beta is available')

KeyError: 'beta'

解决方案 #

方法1：使用get()方法安全访问 #

Pandas的Series和DataFrame都支持get()方法，当索引/列不存在时返回默认值（默认是None），不会触发KeyError。

import pandas as pd

def check_user_data(meta_df = pd.DataFrame(),
                 params = ['param1','param2']):
    alpha_val = meta_df.get('alpha')
    if alpha_val in params:
        print('Alpha is available')
    beta_val = meta_df.get('beta')
    if beta_val is not None and beta_val in params:
        print('Beta is available')

user_df = pd.Series(index=['alpha'],data=['alpha1'])
check_user_data(meta_df = user_df,
                 params = ['alpha1','beta1'])

get('beta')返回None，后续先判断值是否存在，再检查是否在目标列表中，代码会正常执行仅输出"Alpha is available"。

方法2：先检查索引/列是否存在 #

在访问之前，先判断目标索引（或列）是否存在于Pandas对象中：

import pandas as pd

def check_user_data(meta_df = pd.DataFrame(),
                 params = ['param1','param2']):
    # Series判断索引，DataFrame判断列用 'alpha' in meta_df.columns
    if 'alpha' in meta_df.index and meta_df['alpha'] in params:
        print('Alpha is available')
    if 'beta' in meta_df.index and meta_df['beta'] in params:
        print('Beta is available')

user_df = pd.Series(index=['alpha'],data=['alpha1'])
check_user_data(meta_df = user_df,
                 params = ['alpha1','beta1'])

只有当索引/列存在时才执行后续判断，从根源避免KeyError。

方法3：异常捕获（try-except） #

通过捕获KeyError异常，跳过不存在索引的处理逻辑：

import pandas as pd

def check_user_data(meta_df = pd.DataFrame(),
                 params = ['param1','param2']):
    try:
        if meta_df['alpha'] in params:
            print('Alpha is available')
    except KeyError:
        pass  # alpha不存在时跳过
    try:
        if meta_df['beta'] in params:
            print('Beta is available')
    except KeyError:
        pass  # beta不存在时跳过

user_df = pd.Series(index=['alpha'],data=['alpha1'])
check_user_data(meta_df = user_df,
                 params = ['alpha1','beta1'])

将可能触发异常的代码块放在try中，捕获到异常时直接跳过，不中断整体代码执行。

内容的提问来源于stack exchange，提问作者Mainland