使用tempfile编写csv临时文件

bri*_*nts 7 python csv unit-testing class

所以我正在为这个类写一个测试(编辑得更清楚):

class SpreadSheet(object):
    '''awesome docstring'''
    def __init__(self, filename):
        self.filename = filename
        self.table = []
        self.headers = []

        with open(self.filename) as csvfile:
            filereader = reader(csvfile, delimiter=',')
            for row in filereader:
                self.table.append(row)

    def create_headers(self, populations):
        ...code...

    def lookup_header(self, ltr):
        ...code...

    def write_header(self, targetfile):
        ...code...
Run Code Online (Sandbox Code Playgroud)

到目前为止看起来像这样:

class TestSpreadSheet(unittest.TestCase):
    @contextmanager
    def make_fake_csv(self, data):
        self.fake_namefile = tempfile.NamedTemporaryFile(delete=False)
        with open(self.fake_namefile, 'w') as fake_csv:
            fake_writer = csv.writer(fake_csv)
            fake_writer.writerows(data)
        yield self.fake_namefile.name
        os.unlink(self.fake_namefile.name)

    def setUp(self):
        self.headers = []
        self.table = [
            ['Col1', 'Col2', 'Col3', 'Col4', 'Col5', 'Col6', 'Col7', 'Col8'],
            ['val1', 'val2', 'val3', 'val4', 'val5', 'val6', 'val7', 'val8'],
            ['val1', 'val2', 'val3', 'val4', 'val5', 'val6', 'val7', 'val8'],
            ['val1', 'val2', 'val3', 'val4', 'val5', 'val6', 'val7', 'val8']]

    def test___init__(self):
        with self.make_fake_csv(self.table) as temp_csv:
            spread_sheet = SpreadSheet(temp_csv)
            self.assertEqual(
                self.table, spread_sheet.table)

    ...tests for other functions...
Run Code Online (Sandbox Code Playgroud)

我收到这个错误:

in make_fake_csv
with open(self.fake_namefile, 'w') as fake_csv:
TypeError: coercing to Unicode: need string or buffer, instance found
Run Code Online (Sandbox Code Playgroud)

我已经搜索过许多其他类似的主题,这些主题指向使用tempfile命名对象或实际可以使用的东西with open....虽然我确实让它工作,我的问题是当我尝试使用csv包格式化我self.table的csv格式化原始"字符串"(换句话说就像csv文件的原始输入).

有关如何以不同方式测试或使当前代码有效的任何指示?我再次尝试:

  1. 弄清楚如何使用csv来完成所有格式繁重来加载我的假csv文件,self.table这样我就不必制作一个巨大的字符串格式化表达式

  2. with openSpreadSheet运行测试时,确保伪文件与我原始类中使用的伪文件一起使用

  3. 可以进一步用于运行其他函数的测试,因为它们也需要SpreadSheet使用文件进行实例化以执行其功能.

作为一个侧面的问题,制作一个虚假的"内存"文件来做这样的事情(这是我正在尝试的事情)或者只是简单地在磁盘上制作一个实际的临时文件并加载它是"更精简"它在测试过程中使用了一个tearDown()函数来删除它?

Aus*_*ips 7

self.fake_namefile在你的例子中是一个实例NamedTemporaryFile.当您进行open()调用时,您需要传递包含文件名的字符串,而不是NamedTemporaryFile实例.name变量中提供了临时文件的名称.

with open(self.fake_namefile.name, 'w') as fake_csv:
Run Code Online (Sandbox Code Playgroud)

以下是一些建议:

  • 让您的Spreadsheet类采用类似文件的对象而不是文件名.这使它更通用,并允许它与其他基于流的对象一起使用.如果你有这个,就没有必要创建一个假文件,你可以简单地构建一个StringIO测试实例.
  • 如果您已经开始使用a NamedTemporaryFile,我建议将其直接用作上下文管理器,如其他答案中所述.
  • 您不必使用该delete=True选项NamedTemporaryFile.而是将整个测试包装在上下文管理器中,如下所示.
def test_stuff(self):
    with tempfile.NamedTemporaryFile() as temp_csv:
        self.write_csv_test_data(temp_csv)  # Create this to write to temp_csv file object.
        temp_csv.flush()
        temp_csv.seek(0)

        spread_sheet = SpreadSheet(temp_csv.name)
        # spread_sheet = SpreadSheet(temp_csv)  Use this if Spreadsheet takes a file-like object
        ...
Run Code Online (Sandbox Code Playgroud)

更新:

这是一个仅使用类文件对象的示例,不涉及磁盘文件.

class SpreadSheet(object):
    '''awesome docstring'''
    def __init__(self, fileobj):
        self.table = []
        self.headers = []

        filereader = reader(fileobj, delimiter=',')
        for row in filereader:
            self.table.append(row)
    ...
Run Code Online (Sandbox Code Playgroud)

它可以像这样使用,假设您正在从磁盘文件中读取:

with open(path) as csv_file:
    spreadsheet = Spreadsheet(csv_file)
    ....
Run Code Online (Sandbox Code Playgroud)

在测试期间,您可以使用StringIO模块来模拟磁盘上的文件.然后测试完全在内存中运行,因此非常快.

import StringIO

class TestSpreadSheet(unittest.TestCase):
    def make_fake_csv(self, data):
        """Return a populdated fake csv file object for testing."""
        fake_csv = StringIO.StringIO()
        fake_writer = csv.writer(fake_csv)
        fake_writer.writerows(data)
        fake_csv.seek(0)
        return fake_csv
    ....

    def test___init__(self):
        temp_csv = self.make_fake_csv(self.table)
        spread_sheet = SpreadSheet(temp_csv)
        self.assertEqual(
            self.table, spread_sheet.table)
Run Code Online (Sandbox Code Playgroud)