Python数组过滤函数trim_matches参数异常修复需求

问题说明 #

编写了一个遍历字典并过滤结果的Python函数，当设置trim_matches=False时能得到预期结果，但trim_matches=True时返回全部数据，而非预期的未匹配条目。问题出在遍历匹配条件时，同一记录会被反复写入result_matches和result_unmatches字典，最终覆盖掉正确的分类。

原代码如下：

def filter_data(data, match_d=None, trim_matches=False):
    result_matches = {}  # stores matched
    result_unmatches = {}  # stores not matched

    # loop every record in data
    for key, value in data.items():

        # match record with filter criteria
        for search_string, search_key_name in match_d.items():

            if search_string == value[search_key_name]:
                result_matches[key] = value
            else:
                result_unmatches[key] = value

    if trim_matches is False:  # return only matches
        return result_matches
    else:  # return all but matches
        return result_unmatches


data_dict = {0: {'name': 'one'},
             1: {'name': 'two'},
             2: {'name': 'three'},
             3: {'name': 'four'},
             4: {'name': 'five'}}

result = filter_data(data_dict,
                     match_d={'one': 'name', 'two': 'name'},
                     trim_matches=True)

print(result)
# 返回: {0: {'name': 'one'}, 1: {'name': 'two'}, 2: {'name': 'three'}, 3: {'name': 'four'}, 4: {'name': 'five'}}
# 预期: {2: {'name': 'three'}, 3: {'name': 'four'}, 4: {'name': 'five'}}

原因分析 #

原逻辑中，每条记录会遍历match_d的所有匹配条件：

• 比如匹配"one"的记录，第一个条件匹配时会被加入result_matches，但第二个条件"two"不匹配时，又会被加入result_unmatches，最终该记录会留在result_unmatches中
• 所有记录都会因为至少一个条件不匹配被写入result_unmatches，导致trim_matches=True时返回全部数据

解决方案1：最小修改修复现有逻辑 #

核心思路是先判断当前记录是否匹配任意一个条件，再一次性加入对应字典，避免反复覆盖：

def filter_data(data, match_d=None, trim_matches=False):
    result_matches = {}  # stores matched
    result_unmatches = {}  # stores not matched

    # 处理match_d为空的边界情况
    match_d = match_d or {}

    # loop every record in data
    for key, value in data.items():
        # 判断当前记录是否匹配任意一个条件
        is_matched = any(search_str == value[key_name] for search_str, key_name in match_d.items())
        if is_matched:
            result_matches[key] = value
        else:
            result_unmatches[key] = value

    return result_matches if not trim_matches else result_unmatches

解决方案2：重写精简版实现 #

利用提前终止匹配检查和字典推导式，让代码更简洁高效：

基础精简版 #

def filter_data(data, match_d=None, trim_matches=False):
    match_d = match_d or {}
    matches = {}
    unmatches = {}
    
    for key, value in data.items():
        matched = False
        # 找到匹配后立即终止检查，避免无效循环
        for search_str, key_name in match_d.items():
            if value[key_name] == search_str:
                matched = True
                break
        matches[key] = value if matched else unmatches[key] = value
    
    return matches if not trim_matches else unmatches

字典推导式版 #

def filter_data(data, match_d=None, trim_matches=False):
    match_d = match_d or {}
    # 判断记录是否匹配的逻辑
    def is_matched(record):
        return any(record[key_name] == search_str for search_str, key_name in match_d.items())
    
    if not trim_matches:
        return {k: v for k, v in data.items() if is_matched(v)}
    else:
        return {k: v for k, v in data.items() if not is_matched(v)}

测试验证 #

运行修改后的代码，调用filter_data(data_dict, match_d={'one': 'name', 'two': 'name'}, trim_matches=True)会返回预期结果：{2: {'name': 'three'}, 3: {'name': 'four'}, 4: {'name': 'five'}}

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