Xlsxwriter生成Excel文件时TypeError异常处理

133 阅读2分钟

在使用 XlsxWriter 生成 Excel 文件时,如果遇到 TypeError,通常是因为尝试写入的值或格式与 XlsxWriter 的限制或要求不兼容。

1、问题背景

在使用 Xlsxwriter 库生成 Excel 文件时,出现 TypeError: "expected string or buffer" 异常。此异常通常是由于某些字符串对象未正确转换为字符串或二进制缓冲区导致,从而导致库无法正确处理数据。

2、解决方案

为了解决此问题,需要确保在将字符串对象传递给 Xlsxwriter 时,将其正确转换为字符串或二进制缓冲区。在 Python 中,可以使用 str() 函数将字符串对象转换为字符串,或使用 BytesIO() 类创建一个二进制缓冲区。

下面提供一个代码示例,演示如何将字符串对象正确转换为字符串或二进制缓冲区,从而解决问题:

from StringIO import StringIO
import datetime
​
from django.http import HttpResponse, Http404
import xlsxwriter
​
class Contact(models.Model):
    # 省略字段定义
​
def export_xls(request, period=''):
    # 省略部分代码
​
    query = Contact.objects.all().order_by('-enviado_en')
​
    if period:
        query = query.filter(enviado_en__gt=datetime.datetime.now() - deltas[period])
​
    stream = StringIO()
    workbook = xlsxwriter.Workbook(stream, {'in_memory': True})
    worksheet = workbook.add_worksheet('Contactos')
​
    # 设置表头格式
    header_format = workbook.add_format()
    header_format.set_align("center")
    header_format.set_bold()
    header_format.set_font_name('Arial')
​
    # 设置每一列的宽度
    worksheet.set_column(9, 9, 40)
​
    # 写入表头
    worksheet.write_string(0, 0, str(Contact._meta.get_field('enviado_en').verbose_name), header_format)
    worksheet.write_string(0, 1, str(Contact._meta.get_field('nombre').verbose_name), header_format)
    worksheet.write_string(0, 2, str(Contact._meta.get_field('apellido').verbose_name), header_format)
    worksheet.write_string(0, 3, str(Contact._meta.get_field('email').verbose_name), header_format)
    worksheet.write_string(0, 4, str(Contact._meta.get_field('telefono').verbose_name), header_format)
    worksheet.write_string(0, 5, str(Contact._meta.get_field('ciudad').verbose_name), header_format)
    worksheet.write_string(0, 6, str(Contact._meta.get_field('vehiculo').verbose_name), header_format)
    worksheet.write_string(0, 7, str(Contact._meta.get_field('kilometraje').verbose_name), header_format)
    worksheet.write_string(0, 8, str(Contact._meta.get_field('dia_preferente').verbose_name), header_format)
    worksheet.write_string(0, 9, str(Contact._meta.get_field('mensaje').verbose_name), header_format)
​
    # 填充数据
    body_format = workbook.add_format()
    body_format.set_font_name('Arial')
    current_row = 1
    for contact in query:
        worksheet.write(current_row, 0, contact.enviado_en.strftime("%d/%m/%Y %H/%M/%S"), body_format)
        worksheet.write(current_row, 1, contact.nombre, body_format)
        worksheet.write(current_row, 2, contact.apellido, body_format)
        worksheet.write(current_row, 3, contact.email, body_format)
        worksheet.write(current_row, 4, contact.telefono, body_format)
        worksheet.write(current_row, 5, contact.ciudad, body_format)
        worksheet.write(current_row, 6, contact.get_vehiculo_display(), body_format)
        worksheet.write(current_row, 7, contact.get_kilometraje_display(), body_format)
        worksheet.write(current_row, 8, contact.get_dia_preferente_display(), body_format)
        worksheet.write(current_row, 9, contact.mensaje, body_format)
        current_row += 1
​
    workbook.close()
    data = stream.getvalue()
    response = HttpResponse(content=data, content_type='application/vnd.ms-excel')
    response['Content-Disposition'] = 'attachment; filename=reporte-%s.xlsx' % datetime.datetime.now().strftime("%Y%m%d%H%M%S")
    return response

在上面的示例中,我们使用 str() 函数将模型字段的 verbose_name 属性转换为字符串,并将模型字段的 get_display() 方法返回的字符串转换为字符串,以确保这些数据能够正确写入 Excel 文件。

总结

  • 避免写入不支持的数据类型,使用 str()int() 转换非法数据。
  • 对超长字符串和超大数字进行截取或格式化。
  • 确保日期为 datetime.datetime 类型,避免字符串或其他格式。
  • 使用全局异常处理机制和日志记录以捕获潜在问题。

通过这些方法,可以有效避免和处理 XlsxWriter 的 TypeError 异常。