用于导出文件的函数改变列表布局，如何排查并调整？

问题描述 #

我编写了一段代码，用于将5个员工相关列表导出至单个文件。问题在于代码运行后，列表的布局完全改变了，想确认代码中是否存在导致布局变更的因素，以及如何调整。

原代码 #

def employee_export():
    global employeeName, employeeSSN, employeePhone, employeeEmail, employeeSalary
    employeeList = zip(employeeName, employeeSSN, employeePhone, employeeEmail, employeeSalary)

    with open('employees.txt','w') as employees:
        for (employeeName, employeeSSN, employeePhone, employeeEmail, employeeSalary) in employeeList:
            employees.write('{0} {1} {2} {3} {4}\n'.format(employeeName, employeeSSN, employeePhone, employeeEmail, employeeSalary))

问题原因 #

1. 全局变量被意外覆盖：循环中使用了和全局列表同名的变量名，迭代时全局列表会被替换成单个元素值，后续再使用这些全局变量时数据完全错误，也会间接导致布局混乱。
2. 无明确字段分隔规则：用空格直接拼接字段，若字段本身包含空格（如员工姓名含空格），会导致字段边界混淆，看起来布局全乱。
3. zip的截断特性：如果5个列表长度不一致，zip会以最短列表为准截断其他列表，导致部分数据丢失，表现为布局异常。

修复方案 #

1. 避免覆盖全局变量 #

循环内使用与全局列表不同的变量名，防止全局数据被篡改：

def employee_export():
    global employeeName, employeeSSN, employeePhone, employeeEmail, employeeSalary
    employeeList = zip(employeeName, employeeSSN, employeePhone, employeeEmail, employeeSalary)

    with open('employees.txt','w') as employees:
        # 改用不同的变量名
        for emp_name, emp_ssn, emp_phone, emp_email, emp_salary in employeeList:
            employees.write('{0}\t{1}\t{2}\t{3}\t{4}\n'.format(emp_name, emp_ssn, emp_phone, emp_email, emp_salary))

2. 使用规范的分隔格式（推荐CSV） #

用Python内置的csv模块处理，自动处理字段包含空格的情况，格式更规范：

import csv

def employee_export(emp_names, emp_ssns, emp_phones, emp_emails, emp_salaries):
    with open('employees.csv', 'w', newline='') as csvfile:
        writer = csv.writer(csvfile, delimiter='\t') # 用制表符分隔，也可以用逗号
        # 写入表头（可选）
        writer.writerow(['姓名', '社保号', '电话', '邮箱', '薪资'])
        # 迭代写入数据
        for row in zip(emp_names, emp_ssns, emp_phones, emp_emails, emp_salaries):
            writer.writerow(row)

3. 处理列表长度不一致的情况 #

如果列表长度可能不同，用itertools.zip_longest填充缺失值，避免数据截断：

from itertools import zip_longest

def employee_export():
    global employeeName, employeeSSN, employeePhone, employeeEmail, employeeSalary
    # 用N/A填充缺失的元素，也可以指定其他默认值
    employeeList = zip_longest(employeeName, employeeSSN, employeePhone, employeeEmail, employeeSalary, fillvalue='N/A')

    with open('employees.txt','w') as employees:
        for emp_name, emp_ssn, emp_phone, emp_email, emp_salary in employeeList:
            employees.write('{0}\t{1}\t{2}\t{3}\t{4}\n'.format(emp_name, emp_ssn, emp_phone, emp_email, emp_salary))

4. 避免滥用全局变量 #

尽量将列表作为函数参数传入，减少全局变量带来的副作用，代码更易维护：

def employee_export(emp_names, emp_ssns, emp_phones, emp_emails, emp_salaries):
    with open('employees.txt','w') as employees:
        for emp_name, emp_ssn, emp_phone, emp_email, emp_salary in zip(emp_names, emp_ssns, emp_phones, emp_emails, emp_salaries):
            employees.write('{0}\t{1}\t{2}\t{3}\t{4}\n'.format(emp_name, emp_ssn, emp_phone, emp_email, emp_salary))

# 调用时传入列表
employee_export(employeeName, employeeSSN, employeePhone, employeeEmail, employeeSalary)

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