blob: a3c084306b7ea03c30d0f141401dd7e75924e6cb [file] [log] [blame]
Skip Montanaro1a566652003-05-06 15:56:05 +00001# -*- coding: iso-8859-1 -*-
Skip Montanarob4a04172003-03-20 23:29:12 +00002# Copyright (C) 2001,2002 Python Software Foundation
3# csv package unit tests
4
5import sys
Skip Montanaro58fc5d082004-06-05 17:03:20 +00006import os
Skip Montanarob4a04172003-03-20 23:29:12 +00007import unittest
8from StringIO import StringIO
Skip Montanaro58fc5d082004-06-05 17:03:20 +00009import tempfile
Skip Montanaro594adac2003-04-10 17:16:15 +000010import csv
Skip Montanarob4a04172003-03-20 23:29:12 +000011import gc
Walter Dörwald21d3a322003-05-01 17:45:56 +000012from test import test_support
Skip Montanarob4a04172003-03-20 23:29:12 +000013
14class Test_Csv(unittest.TestCase):
15 """
Tim Peters0eadaac2003-04-24 16:02:54 +000016 Test the underlying C csv parser in ways that are not appropriate
Skip Montanarob4a04172003-03-20 23:29:12 +000017 from the high level interface. Further tests of this nature are done
18 in TestDialectRegistry.
19 """
Andrew McNamara1196cf12005-01-07 04:42:45 +000020 def _test_arg_valid(self, ctor, arg):
21 self.assertRaises(TypeError, ctor)
22 self.assertRaises(TypeError, ctor, None)
23 self.assertRaises(TypeError, ctor, arg, bad_attr = 0)
24 self.assertRaises(TypeError, ctor, arg, delimiter = 0)
25 self.assertRaises(TypeError, ctor, arg, delimiter = 'XX')
26 self.assertRaises(csv.Error, ctor, arg, 'foo')
Andrew McNamara1196cf12005-01-07 04:42:45 +000027 self.assertRaises(TypeError, ctor, arg, delimiter=None)
28 self.assertRaises(TypeError, ctor, arg, delimiter=1)
29 self.assertRaises(TypeError, ctor, arg, quotechar=1)
30 self.assertRaises(TypeError, ctor, arg, lineterminator=None)
31 self.assertRaises(TypeError, ctor, arg, lineterminator=1)
32 self.assertRaises(TypeError, ctor, arg, quoting=None)
Andrew McNamaraaf1e3122005-01-12 01:55:21 +000033 self.assertRaises(TypeError, ctor, arg,
34 quoting=csv.QUOTE_ALL, quotechar='')
Andrew McNamara1196cf12005-01-07 04:42:45 +000035
36 def test_reader_arg_valid(self):
37 self._test_arg_valid(csv.reader, [])
Skip Montanarob4a04172003-03-20 23:29:12 +000038
39 def test_writer_arg_valid(self):
Andrew McNamara1196cf12005-01-07 04:42:45 +000040 self._test_arg_valid(csv.writer, StringIO())
Skip Montanarob4a04172003-03-20 23:29:12 +000041
Andrew McNamara1196cf12005-01-07 04:42:45 +000042 def _test_default_attrs(self, ctor, *args):
43 obj = ctor(*args)
44 # Check defaults
Skip Montanarob4a04172003-03-20 23:29:12 +000045 self.assertEqual(obj.dialect.delimiter, ',')
Andrew McNamara1196cf12005-01-07 04:42:45 +000046 self.assertEqual(obj.dialect.doublequote, True)
Skip Montanarob4a04172003-03-20 23:29:12 +000047 self.assertEqual(obj.dialect.escapechar, None)
Andrew McNamara1196cf12005-01-07 04:42:45 +000048 self.assertEqual(obj.dialect.lineterminator, "\r\n")
49 self.assertEqual(obj.dialect.quotechar, '"')
50 self.assertEqual(obj.dialect.quoting, csv.QUOTE_MINIMAL)
51 self.assertEqual(obj.dialect.skipinitialspace, False)
52 self.assertEqual(obj.dialect.strict, False)
53 # Try deleting or changing attributes (they are read-only)
54 self.assertRaises(TypeError, delattr, obj.dialect, 'delimiter')
55 self.assertRaises(TypeError, setattr, obj.dialect, 'delimiter', ':')
Skip Montanarob4a04172003-03-20 23:29:12 +000056 self.assertRaises(TypeError, delattr, obj.dialect, 'quoting')
57 self.assertRaises(TypeError, setattr, obj.dialect, 'quoting', None)
Skip Montanarob4a04172003-03-20 23:29:12 +000058
59 def test_reader_attrs(self):
Andrew McNamara1196cf12005-01-07 04:42:45 +000060 self._test_default_attrs(csv.reader, [])
Skip Montanarob4a04172003-03-20 23:29:12 +000061
62 def test_writer_attrs(self):
Andrew McNamara1196cf12005-01-07 04:42:45 +000063 self._test_default_attrs(csv.writer, StringIO())
64
65 def _test_kw_attrs(self, ctor, *args):
66 # Now try with alternate options
67 kwargs = dict(delimiter=':', doublequote=False, escapechar='\\',
68 lineterminator='\r', quotechar='*',
69 quoting=csv.QUOTE_NONE, skipinitialspace=True,
70 strict=True)
71 obj = ctor(*args, **kwargs)
72 self.assertEqual(obj.dialect.delimiter, ':')
73 self.assertEqual(obj.dialect.doublequote, False)
74 self.assertEqual(obj.dialect.escapechar, '\\')
75 self.assertEqual(obj.dialect.lineterminator, "\r")
76 self.assertEqual(obj.dialect.quotechar, '*')
77 self.assertEqual(obj.dialect.quoting, csv.QUOTE_NONE)
78 self.assertEqual(obj.dialect.skipinitialspace, True)
79 self.assertEqual(obj.dialect.strict, True)
80
81 def test_reader_kw_attrs(self):
82 self._test_kw_attrs(csv.reader, [])
83
84 def test_writer_kw_attrs(self):
85 self._test_kw_attrs(csv.writer, StringIO())
86
87 def _test_dialect_attrs(self, ctor, *args):
88 # Now try with dialect-derived options
89 class dialect:
90 delimiter='-'
91 doublequote=False
92 escapechar='^'
93 lineterminator='$'
94 quotechar='#'
95 quoting=csv.QUOTE_ALL
96 skipinitialspace=True
97 strict=False
98 args = args + (dialect,)
99 obj = ctor(*args)
100 self.assertEqual(obj.dialect.delimiter, '-')
101 self.assertEqual(obj.dialect.doublequote, False)
102 self.assertEqual(obj.dialect.escapechar, '^')
103 self.assertEqual(obj.dialect.lineterminator, "$")
104 self.assertEqual(obj.dialect.quotechar, '#')
105 self.assertEqual(obj.dialect.quoting, csv.QUOTE_ALL)
106 self.assertEqual(obj.dialect.skipinitialspace, True)
107 self.assertEqual(obj.dialect.strict, False)
108
109 def test_reader_dialect_attrs(self):
110 self._test_dialect_attrs(csv.reader, [])
111
112 def test_writer_dialect_attrs(self):
113 self._test_dialect_attrs(csv.writer, StringIO())
114
Skip Montanarob4a04172003-03-20 23:29:12 +0000115
116 def _write_test(self, fields, expect, **kwargs):
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000117 fd, name = tempfile.mkstemp()
118 fileobj = os.fdopen(fd, "w+b")
119 try:
120 writer = csv.writer(fileobj, **kwargs)
121 writer.writerow(fields)
122 fileobj.seek(0)
123 self.assertEqual(fileobj.read(),
124 expect + writer.dialect.lineterminator)
125 finally:
126 fileobj.close()
127 os.unlink(name)
Skip Montanarob4a04172003-03-20 23:29:12 +0000128
129 def test_write_arg_valid(self):
130 self.assertRaises(csv.Error, self._write_test, None, '')
131 self._write_test((), '')
132 self._write_test([None], '""')
Tim Peters0eadaac2003-04-24 16:02:54 +0000133 self.assertRaises(csv.Error, self._write_test,
Skip Montanarob4a04172003-03-20 23:29:12 +0000134 [None], None, quoting = csv.QUOTE_NONE)
135 # Check that exceptions are passed up the chain
136 class BadList:
137 def __len__(self):
138 return 10;
139 def __getitem__(self, i):
140 if i > 2:
141 raise IOError
142 self.assertRaises(IOError, self._write_test, BadList(), '')
143 class BadItem:
144 def __str__(self):
145 raise IOError
146 self.assertRaises(IOError, self._write_test, [BadItem()], '')
147
148 def test_write_bigfield(self):
149 # This exercises the buffer realloc functionality
150 bigstring = 'X' * 50000
151 self._write_test([bigstring,bigstring], '%s,%s' % \
152 (bigstring, bigstring))
153
154 def test_write_quoting(self):
Andrew McNamarac89f2842005-01-12 07:44:42 +0000155 self._write_test(['a',1,'p,q'], 'a,1,"p,q"')
Tim Peters0eadaac2003-04-24 16:02:54 +0000156 self.assertRaises(csv.Error,
Skip Montanarob4a04172003-03-20 23:29:12 +0000157 self._write_test,
Andrew McNamarac89f2842005-01-12 07:44:42 +0000158 ['a',1,'p,q'], 'a,1,p,q',
Skip Montanarob4a04172003-03-20 23:29:12 +0000159 quoting = csv.QUOTE_NONE)
Andrew McNamarac89f2842005-01-12 07:44:42 +0000160 self._write_test(['a',1,'p,q'], 'a,1,"p,q"',
Skip Montanarob4a04172003-03-20 23:29:12 +0000161 quoting = csv.QUOTE_MINIMAL)
Andrew McNamarac89f2842005-01-12 07:44:42 +0000162 self._write_test(['a',1,'p,q'], '"a",1,"p,q"',
Skip Montanarob4a04172003-03-20 23:29:12 +0000163 quoting = csv.QUOTE_NONNUMERIC)
Andrew McNamarac89f2842005-01-12 07:44:42 +0000164 self._write_test(['a',1,'p,q'], '"a","1","p,q"',
Skip Montanarob4a04172003-03-20 23:29:12 +0000165 quoting = csv.QUOTE_ALL)
166
167 def test_write_escape(self):
Andrew McNamarac89f2842005-01-12 07:44:42 +0000168 self._write_test(['a',1,'p,q'], 'a,1,"p,q"',
Skip Montanarob4a04172003-03-20 23:29:12 +0000169 escapechar='\\')
Andrew McNamarac89f2842005-01-12 07:44:42 +0000170 self.assertRaises(csv.Error,
171 self._write_test,
172 ['a',1,'p,"q"'], 'a,1,"p,\\"q\\""',
173 escapechar=None, doublequote=False)
174 self._write_test(['a',1,'p,"q"'], 'a,1,"p,\\"q\\""',
175 escapechar='\\', doublequote = False)
176 self._write_test(['"'], '""""',
177 escapechar='\\', quoting = csv.QUOTE_MINIMAL)
178 self._write_test(['"'], '\\"',
179 escapechar='\\', quoting = csv.QUOTE_MINIMAL,
180 doublequote = False)
181 self._write_test(['"'], '\\"',
182 escapechar='\\', quoting = csv.QUOTE_NONE)
183 self._write_test(['a',1,'p,q'], 'a,1,p\\,q',
Skip Montanarob4a04172003-03-20 23:29:12 +0000184 escapechar='\\', quoting = csv.QUOTE_NONE)
185
186 def test_writerows(self):
187 class BrokenFile:
188 def write(self, buf):
189 raise IOError
190 writer = csv.writer(BrokenFile())
191 self.assertRaises(IOError, writer.writerows, [['a']])
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000192 fd, name = tempfile.mkstemp()
193 fileobj = os.fdopen(fd, "w+b")
194 try:
195 writer = csv.writer(fileobj)
196 self.assertRaises(TypeError, writer.writerows, None)
197 writer.writerows([['a','b'],['c','d']])
198 fileobj.seek(0)
199 self.assertEqual(fileobj.read(), "a,b\r\nc,d\r\n")
200 finally:
201 fileobj.close()
202 os.unlink(name)
Tim Peters27f88362004-07-08 04:22:35 +0000203
Skip Montanarob4a04172003-03-20 23:29:12 +0000204 def _read_test(self, input, expect, **kwargs):
205 reader = csv.reader(input, **kwargs)
206 result = list(reader)
207 self.assertEqual(result, expect)
208
209 def test_read_oddinputs(self):
210 self._read_test([], [])
211 self._read_test([''], [[]])
212 self.assertRaises(csv.Error, self._read_test,
213 ['"ab"c'], None, strict = 1)
214 # cannot handle null bytes for the moment
215 self.assertRaises(csv.Error, self._read_test,
216 ['ab\0c'], None, strict = 1)
217 self._read_test(['"ab"c'], [['abc']], doublequote = 0)
218
219 def test_read_eol(self):
220 self._read_test(['a,b'], [['a','b']])
221 self._read_test(['a,b\n'], [['a','b']])
222 self._read_test(['a,b\r\n'], [['a','b']])
223 self._read_test(['a,b\r'], [['a','b']])
224 self.assertRaises(csv.Error, self._read_test, ['a,b\rc,d'], [])
225 self.assertRaises(csv.Error, self._read_test, ['a,b\nc,d'], [])
226 self.assertRaises(csv.Error, self._read_test, ['a,b\r\nc,d'], [])
227
228 def test_read_escape(self):
Andrew McNamara36a76912005-01-10 01:04:40 +0000229 self._read_test(['a,\\b,c'], [['a', 'b', 'c']], escapechar='\\')
Skip Montanarob4a04172003-03-20 23:29:12 +0000230 self._read_test(['a,b\\,c'], [['a', 'b,c']], escapechar='\\')
231 self._read_test(['a,"b\\,c"'], [['a', 'b,c']], escapechar='\\')
Andrew McNamara36a76912005-01-10 01:04:40 +0000232 self._read_test(['a,"b,\\c"'], [['a', 'b,c']], escapechar='\\')
Skip Montanarob4a04172003-03-20 23:29:12 +0000233 self._read_test(['a,"b,c\\""'], [['a', 'b,c"']], escapechar='\\')
234 self._read_test(['a,"b,c"\\'], [['a', 'b,c\\']], escapechar='\\')
235
Andrew McNamara1196cf12005-01-07 04:42:45 +0000236 def test_read_quoting(self):
237 self._read_test(['1,",3,",5'], [['1', ',3,', '5']])
238 self._read_test(['1,",3,",5'], [['1', '"', '3', '"', '5']],
239 quotechar=None, escapechar='\\')
240 self._read_test(['1,",3,",5'], [['1', '"', '3', '"', '5']],
241 quoting=csv.QUOTE_NONE, escapechar='\\')
242
Skip Montanarob4a04172003-03-20 23:29:12 +0000243 def test_read_bigfield(self):
Andrew McNamarae4d05c42005-01-11 07:32:02 +0000244 # This exercises the buffer realloc functionality and field size
245 # limits.
Andrew McNamara31d88962005-01-12 03:45:10 +0000246 limit = csv.field_size_limit()
Andrew McNamaraaf1e3122005-01-12 01:55:21 +0000247 try:
248 size = 50000
249 bigstring = 'X' * size
250 bigline = '%s,%s' % (bigstring, bigstring)
251 self._read_test([bigline], [[bigstring, bigstring]])
Andrew McNamara31d88962005-01-12 03:45:10 +0000252 csv.field_size_limit(size)
Andrew McNamaraaf1e3122005-01-12 01:55:21 +0000253 self._read_test([bigline], [[bigstring, bigstring]])
Andrew McNamara31d88962005-01-12 03:45:10 +0000254 self.assertEqual(csv.field_size_limit(), size)
255 csv.field_size_limit(size-1)
Andrew McNamaraaf1e3122005-01-12 01:55:21 +0000256 self.assertRaises(csv.Error, self._read_test, [bigline], [])
Andrew McNamara31d88962005-01-12 03:45:10 +0000257 self.assertRaises(TypeError, csv.field_size_limit, None)
258 self.assertRaises(TypeError, csv.field_size_limit, 1, None)
Andrew McNamaraaf1e3122005-01-12 01:55:21 +0000259 finally:
Andrew McNamara31d88962005-01-12 03:45:10 +0000260 csv.field_size_limit(limit)
Skip Montanarob4a04172003-03-20 23:29:12 +0000261
262class TestDialectRegistry(unittest.TestCase):
263 def test_registry_badargs(self):
264 self.assertRaises(TypeError, csv.list_dialects, None)
265 self.assertRaises(TypeError, csv.get_dialect)
266 self.assertRaises(csv.Error, csv.get_dialect, None)
267 self.assertRaises(csv.Error, csv.get_dialect, "nonesuch")
268 self.assertRaises(TypeError, csv.unregister_dialect)
269 self.assertRaises(csv.Error, csv.unregister_dialect, None)
270 self.assertRaises(csv.Error, csv.unregister_dialect, "nonesuch")
271 self.assertRaises(TypeError, csv.register_dialect, None)
272 self.assertRaises(TypeError, csv.register_dialect, None, None)
Andrew McNamaraaf1e3122005-01-12 01:55:21 +0000273 self.assertRaises(TypeError, csv.register_dialect, "nonesuch", 0, 0)
274 self.assertRaises(TypeError, csv.register_dialect, "nonesuch",
275 badargument=None)
276 self.assertRaises(TypeError, csv.register_dialect, "nonesuch",
277 quoting=None)
278 self.assertRaises(TypeError, csv.register_dialect, [])
Skip Montanarob4a04172003-03-20 23:29:12 +0000279
280 def test_registry(self):
281 class myexceltsv(csv.excel):
282 delimiter = "\t"
283 name = "myexceltsv"
284 expected_dialects = csv.list_dialects() + [name]
285 expected_dialects.sort()
286 csv.register_dialect(name, myexceltsv)
287 try:
Andrew McNamara86625972005-01-11 01:28:33 +0000288 self.failUnless(csv.get_dialect(name).delimiter, '\t')
Skip Montanarob4a04172003-03-20 23:29:12 +0000289 got_dialects = csv.list_dialects()
290 got_dialects.sort()
291 self.assertEqual(expected_dialects, got_dialects)
292 finally:
293 csv.unregister_dialect(name)
294
Andrew McNamara86625972005-01-11 01:28:33 +0000295 def test_register_kwargs(self):
296 name = 'fedcba'
297 csv.register_dialect(name, delimiter=';')
298 try:
299 self.failUnless(csv.get_dialect(name).delimiter, '\t')
300 self.failUnless(list(csv.reader('X;Y;Z', name)), ['X', 'Y', 'Z'])
301 finally:
302 csv.unregister_dialect(name)
303
Skip Montanarob4a04172003-03-20 23:29:12 +0000304 def test_incomplete_dialect(self):
305 class myexceltsv(csv.Dialect):
306 delimiter = "\t"
307 self.assertRaises(csv.Error, myexceltsv)
308
309 def test_space_dialect(self):
310 class space(csv.excel):
311 delimiter = " "
312 quoting = csv.QUOTE_NONE
313 escapechar = "\\"
314
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000315 fd, name = tempfile.mkstemp()
316 fileobj = os.fdopen(fd, "w+b")
317 try:
318 fileobj.write("abc def\nc1ccccc1 benzene\n")
319 fileobj.seek(0)
320 rdr = csv.reader(fileobj, dialect=space())
321 self.assertEqual(rdr.next(), ["abc", "def"])
322 self.assertEqual(rdr.next(), ["c1ccccc1", "benzene"])
323 finally:
324 fileobj.close()
325 os.unlink(name)
Tim Peters27f88362004-07-08 04:22:35 +0000326
Skip Montanarob4a04172003-03-20 23:29:12 +0000327 def test_dialect_apply(self):
328 class testA(csv.excel):
329 delimiter = "\t"
330 class testB(csv.excel):
331 delimiter = ":"
332 class testC(csv.excel):
333 delimiter = "|"
334
335 csv.register_dialect('testC', testC)
336 try:
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000337 fd, name = tempfile.mkstemp()
338 fileobj = os.fdopen(fd, "w+b")
339 try:
340 writer = csv.writer(fileobj)
341 writer.writerow([1,2,3])
342 fileobj.seek(0)
343 self.assertEqual(fileobj.read(), "1,2,3\r\n")
344 finally:
345 fileobj.close()
346 os.unlink(name)
Tim Peters27f88362004-07-08 04:22:35 +0000347
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000348 fd, name = tempfile.mkstemp()
349 fileobj = os.fdopen(fd, "w+b")
350 try:
351 writer = csv.writer(fileobj, testA)
352 writer.writerow([1,2,3])
353 fileobj.seek(0)
354 self.assertEqual(fileobj.read(), "1\t2\t3\r\n")
355 finally:
356 fileobj.close()
357 os.unlink(name)
Skip Montanarob4a04172003-03-20 23:29:12 +0000358
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000359 fd, name = tempfile.mkstemp()
360 fileobj = os.fdopen(fd, "w+b")
361 try:
362 writer = csv.writer(fileobj, dialect=testB())
363 writer.writerow([1,2,3])
364 fileobj.seek(0)
365 self.assertEqual(fileobj.read(), "1:2:3\r\n")
366 finally:
367 fileobj.close()
368 os.unlink(name)
Skip Montanarob4a04172003-03-20 23:29:12 +0000369
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000370 fd, name = tempfile.mkstemp()
371 fileobj = os.fdopen(fd, "w+b")
372 try:
373 writer = csv.writer(fileobj, dialect='testC')
374 writer.writerow([1,2,3])
375 fileobj.seek(0)
376 self.assertEqual(fileobj.read(), "1|2|3\r\n")
377 finally:
378 fileobj.close()
379 os.unlink(name)
Skip Montanarob4a04172003-03-20 23:29:12 +0000380
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000381 fd, name = tempfile.mkstemp()
382 fileobj = os.fdopen(fd, "w+b")
383 try:
384 writer = csv.writer(fileobj, dialect=testA, delimiter=';')
385 writer.writerow([1,2,3])
386 fileobj.seek(0)
387 self.assertEqual(fileobj.read(), "1;2;3\r\n")
388 finally:
389 fileobj.close()
390 os.unlink(name)
Skip Montanarob4a04172003-03-20 23:29:12 +0000391
Skip Montanarob4a04172003-03-20 23:29:12 +0000392 finally:
393 csv.unregister_dialect('testC')
394
395 def test_bad_dialect(self):
396 # Unknown parameter
Andrew McNamara1196cf12005-01-07 04:42:45 +0000397 self.assertRaises(TypeError, csv.reader, [], bad_attr = 0)
Skip Montanarob4a04172003-03-20 23:29:12 +0000398 # Bad values
399 self.assertRaises(TypeError, csv.reader, [], delimiter = None)
400 self.assertRaises(TypeError, csv.reader, [], quoting = -1)
401 self.assertRaises(TypeError, csv.reader, [], quoting = 100)
402
403class TestCsvBase(unittest.TestCase):
404 def readerAssertEqual(self, input, expected_result):
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000405 fd, name = tempfile.mkstemp()
406 fileobj = os.fdopen(fd, "w+b")
407 try:
408 fileobj.write(input)
409 fileobj.seek(0)
410 reader = csv.reader(fileobj, dialect = self.dialect)
411 fields = list(reader)
412 self.assertEqual(fields, expected_result)
413 finally:
414 fileobj.close()
415 os.unlink(name)
Skip Montanarob4a04172003-03-20 23:29:12 +0000416
417 def writerAssertEqual(self, input, expected_result):
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000418 fd, name = tempfile.mkstemp()
419 fileobj = os.fdopen(fd, "w+b")
420 try:
421 writer = csv.writer(fileobj, dialect = self.dialect)
422 writer.writerows(input)
423 fileobj.seek(0)
424 self.assertEqual(fileobj.read(), expected_result)
425 finally:
426 fileobj.close()
427 os.unlink(name)
Skip Montanarob4a04172003-03-20 23:29:12 +0000428
429class TestDialectExcel(TestCsvBase):
430 dialect = 'excel'
431
432 def test_single(self):
433 self.readerAssertEqual('abc', [['abc']])
434
435 def test_simple(self):
436 self.readerAssertEqual('1,2,3,4,5', [['1','2','3','4','5']])
437
438 def test_blankline(self):
439 self.readerAssertEqual('', [])
440
441 def test_empty_fields(self):
442 self.readerAssertEqual(',', [['', '']])
443
444 def test_singlequoted(self):
445 self.readerAssertEqual('""', [['']])
446
447 def test_singlequoted_left_empty(self):
448 self.readerAssertEqual('"",', [['','']])
449
450 def test_singlequoted_right_empty(self):
451 self.readerAssertEqual(',""', [['','']])
452
453 def test_single_quoted_quote(self):
454 self.readerAssertEqual('""""', [['"']])
455
456 def test_quoted_quotes(self):
457 self.readerAssertEqual('""""""', [['""']])
458
459 def test_inline_quote(self):
460 self.readerAssertEqual('a""b', [['a""b']])
461
462 def test_inline_quotes(self):
463 self.readerAssertEqual('a"b"c', [['a"b"c']])
464
465 def test_quotes_and_more(self):
466 self.readerAssertEqual('"a"b', [['ab']])
467
468 def test_lone_quote(self):
469 self.readerAssertEqual('a"b', [['a"b']])
470
471 def test_quote_and_quote(self):
472 self.readerAssertEqual('"a" "b"', [['a "b"']])
473
474 def test_space_and_quote(self):
475 self.readerAssertEqual(' "a"', [[' "a"']])
476
477 def test_quoted(self):
Tim Peters0eadaac2003-04-24 16:02:54 +0000478 self.readerAssertEqual('1,2,3,"I think, therefore I am",5,6',
479 [['1', '2', '3',
480 'I think, therefore I am',
Skip Montanarob4a04172003-03-20 23:29:12 +0000481 '5', '6']])
482
483 def test_quoted_quote(self):
484 self.readerAssertEqual('1,2,3,"""I see,"" said the blind man","as he picked up his hammer and saw"',
Tim Peters0eadaac2003-04-24 16:02:54 +0000485 [['1', '2', '3',
486 '"I see," said the blind man',
Skip Montanarob4a04172003-03-20 23:29:12 +0000487 'as he picked up his hammer and saw']])
488
489 def test_quoted_nl(self):
490 input = '''\
4911,2,3,"""I see,""
492said the blind man","as he picked up his
493hammer and saw"
4949,8,7,6'''
495 self.readerAssertEqual(input,
Tim Peters0eadaac2003-04-24 16:02:54 +0000496 [['1', '2', '3',
497 '"I see,"\nsaid the blind man',
Skip Montanarob4a04172003-03-20 23:29:12 +0000498 'as he picked up his\nhammer and saw'],
499 ['9','8','7','6']])
500
501 def test_dubious_quote(self):
502 self.readerAssertEqual('12,12,1",', [['12', '12', '1"', '']])
503
504 def test_null(self):
505 self.writerAssertEqual([], '')
506
507 def test_single(self):
508 self.writerAssertEqual([['abc']], 'abc\r\n')
509
510 def test_simple(self):
511 self.writerAssertEqual([[1, 2, 'abc', 3, 4]], '1,2,abc,3,4\r\n')
512
513 def test_quotes(self):
514 self.writerAssertEqual([[1, 2, 'a"bc"', 3, 4]], '1,2,"a""bc""",3,4\r\n')
515
516 def test_quote_fieldsep(self):
517 self.writerAssertEqual([['abc,def']], '"abc,def"\r\n')
518
519 def test_newlines(self):
520 self.writerAssertEqual([[1, 2, 'a\nbc', 3, 4]], '1,2,"a\nbc",3,4\r\n')
521
522class EscapedExcel(csv.excel):
523 quoting = csv.QUOTE_NONE
524 escapechar = '\\'
525
526class TestEscapedExcel(TestCsvBase):
527 dialect = EscapedExcel()
528
529 def test_escape_fieldsep(self):
530 self.writerAssertEqual([['abc,def']], 'abc\\,def\r\n')
531
532 def test_read_escape_fieldsep(self):
533 self.readerAssertEqual('abc\\,def\r\n', [['abc,def']])
534
535class QuotedEscapedExcel(csv.excel):
536 quoting = csv.QUOTE_NONNUMERIC
537 escapechar = '\\'
538
539class TestQuotedEscapedExcel(TestCsvBase):
540 dialect = QuotedEscapedExcel()
541
542 def test_write_escape_fieldsep(self):
543 self.writerAssertEqual([['abc,def']], '"abc,def"\r\n')
544
545 def test_read_escape_fieldsep(self):
546 self.readerAssertEqual('"abc\\,def"\r\n', [['abc,def']])
547
Skip Montanarob4a04172003-03-20 23:29:12 +0000548class TestDictFields(unittest.TestCase):
549 ### "long" means the row is longer than the number of fieldnames
550 ### "short" means there are fewer elements in the row than fieldnames
551 def test_write_simple_dict(self):
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000552 fd, name = tempfile.mkstemp()
553 fileobj = os.fdopen(fd, "w+b")
554 try:
555 writer = csv.DictWriter(fileobj, fieldnames = ["f1", "f2", "f3"])
556 writer.writerow({"f1": 10, "f3": "abc"})
557 fileobj.seek(0)
558 self.assertEqual(fileobj.read(), "10,,abc\r\n")
559 finally:
560 fileobj.close()
561 os.unlink(name)
Skip Montanarob4a04172003-03-20 23:29:12 +0000562
563 def test_write_no_fields(self):
564 fileobj = StringIO()
565 self.assertRaises(TypeError, csv.DictWriter, fileobj)
566
567 def test_read_dict_fields(self):
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000568 fd, name = tempfile.mkstemp()
569 fileobj = os.fdopen(fd, "w+b")
570 try:
571 fileobj.write("1,2,abc\r\n")
572 fileobj.seek(0)
573 reader = csv.DictReader(fileobj,
574 fieldnames=["f1", "f2", "f3"])
575 self.assertEqual(reader.next(), {"f1": '1', "f2": '2', "f3": 'abc'})
576 finally:
577 fileobj.close()
578 os.unlink(name)
Skip Montanarob4a04172003-03-20 23:29:12 +0000579
Skip Montanarodffeed32003-10-03 14:03:01 +0000580 def test_read_dict_no_fieldnames(self):
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000581 fd, name = tempfile.mkstemp()
582 fileobj = os.fdopen(fd, "w+b")
583 try:
584 fileobj.write("f1,f2,f3\r\n1,2,abc\r\n")
585 fileobj.seek(0)
586 reader = csv.DictReader(fileobj)
587 self.assertEqual(reader.next(), {"f1": '1', "f2": '2', "f3": 'abc'})
588 finally:
589 fileobj.close()
590 os.unlink(name)
Skip Montanarodffeed32003-10-03 14:03:01 +0000591
Skip Montanarob4a04172003-03-20 23:29:12 +0000592 def test_read_long(self):
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000593 fd, name = tempfile.mkstemp()
594 fileobj = os.fdopen(fd, "w+b")
595 try:
596 fileobj.write("1,2,abc,4,5,6\r\n")
597 fileobj.seek(0)
598 reader = csv.DictReader(fileobj,
599 fieldnames=["f1", "f2"])
600 self.assertEqual(reader.next(), {"f1": '1', "f2": '2',
601 None: ["abc", "4", "5", "6"]})
602 finally:
603 fileobj.close()
604 os.unlink(name)
Skip Montanarob4a04172003-03-20 23:29:12 +0000605
606 def test_read_long_with_rest(self):
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000607 fd, name = tempfile.mkstemp()
608 fileobj = os.fdopen(fd, "w+b")
609 try:
610 fileobj.write("1,2,abc,4,5,6\r\n")
611 fileobj.seek(0)
612 reader = csv.DictReader(fileobj,
613 fieldnames=["f1", "f2"], restkey="_rest")
614 self.assertEqual(reader.next(), {"f1": '1', "f2": '2',
615 "_rest": ["abc", "4", "5", "6"]})
616 finally:
617 fileobj.close()
618 os.unlink(name)
Skip Montanarob4a04172003-03-20 23:29:12 +0000619
Skip Montanarodffeed32003-10-03 14:03:01 +0000620 def test_read_long_with_rest_no_fieldnames(self):
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000621 fd, name = tempfile.mkstemp()
622 fileobj = os.fdopen(fd, "w+b")
623 try:
624 fileobj.write("f1,f2\r\n1,2,abc,4,5,6\r\n")
625 fileobj.seek(0)
626 reader = csv.DictReader(fileobj, restkey="_rest")
627 self.assertEqual(reader.next(), {"f1": '1', "f2": '2',
628 "_rest": ["abc", "4", "5", "6"]})
629 finally:
630 fileobj.close()
631 os.unlink(name)
Skip Montanarodffeed32003-10-03 14:03:01 +0000632
Skip Montanarob4a04172003-03-20 23:29:12 +0000633 def test_read_short(self):
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000634 fd, name = tempfile.mkstemp()
635 fileobj = os.fdopen(fd, "w+b")
636 try:
637 fileobj.write("1,2,abc,4,5,6\r\n1,2,abc\r\n")
638 fileobj.seek(0)
639 reader = csv.DictReader(fileobj,
640 fieldnames="1 2 3 4 5 6".split(),
641 restval="DEFAULT")
642 self.assertEqual(reader.next(), {"1": '1', "2": '2', "3": 'abc',
643 "4": '4', "5": '5', "6": '6'})
644 self.assertEqual(reader.next(), {"1": '1', "2": '2', "3": 'abc',
645 "4": 'DEFAULT', "5": 'DEFAULT',
646 "6": 'DEFAULT'})
647 finally:
648 fileobj.close()
649 os.unlink(name)
Skip Montanarob4a04172003-03-20 23:29:12 +0000650
Skip Montanaro1546bc42003-06-12 02:40:22 +0000651 def test_read_multi(self):
652 sample = [
653 '2147483648,43.0e12,17,abc,def\r\n',
654 '147483648,43.0e2,17,abc,def\r\n',
655 '47483648,43.0,170,abc,def\r\n'
656 ]
657
658 reader = csv.DictReader(sample,
659 fieldnames="i1 float i2 s1 s2".split())
660 self.assertEqual(reader.next(), {"i1": '2147483648',
661 "float": '43.0e12',
662 "i2": '17',
663 "s1": 'abc',
664 "s2": 'def'})
665
Skip Montanarob4a04172003-03-20 23:29:12 +0000666 def test_read_with_blanks(self):
667 reader = csv.DictReader(["1,2,abc,4,5,6\r\n","\r\n",
668 "1,2,abc,4,5,6\r\n"],
669 fieldnames="1 2 3 4 5 6".split())
670 self.assertEqual(reader.next(), {"1": '1', "2": '2', "3": 'abc',
671 "4": '4', "5": '5', "6": '6'})
672 self.assertEqual(reader.next(), {"1": '1', "2": '2', "3": 'abc',
673 "4": '4', "5": '5', "6": '6'})
674
Skip Montanaro3f7a9482003-09-06 19:52:12 +0000675 def test_read_semi_sep(self):
676 reader = csv.DictReader(["1;2;abc;4;5;6\r\n"],
677 fieldnames="1 2 3 4 5 6".split(),
678 delimiter=';')
679 self.assertEqual(reader.next(), {"1": '1', "2": '2', "3": 'abc',
680 "4": '4', "5": '5', "6": '6'})
681
Skip Montanarob4a04172003-03-20 23:29:12 +0000682class TestArrayWrites(unittest.TestCase):
683 def test_int_write(self):
684 import array
685 contents = [(20-i) for i in range(20)]
686 a = array.array('i', contents)
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000687
688 fd, name = tempfile.mkstemp()
689 fileobj = os.fdopen(fd, "w+b")
690 try:
691 writer = csv.writer(fileobj, dialect="excel")
692 writer.writerow(a)
693 expected = ",".join([str(i) for i in a])+"\r\n"
694 fileobj.seek(0)
695 self.assertEqual(fileobj.read(), expected)
696 finally:
697 fileobj.close()
698 os.unlink(name)
Skip Montanarob4a04172003-03-20 23:29:12 +0000699
700 def test_double_write(self):
701 import array
702 contents = [(20-i)*0.1 for i in range(20)]
703 a = array.array('d', contents)
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000704 fd, name = tempfile.mkstemp()
705 fileobj = os.fdopen(fd, "w+b")
706 try:
707 writer = csv.writer(fileobj, dialect="excel")
708 writer.writerow(a)
709 expected = ",".join([str(i) for i in a])+"\r\n"
710 fileobj.seek(0)
711 self.assertEqual(fileobj.read(), expected)
712 finally:
713 fileobj.close()
714 os.unlink(name)
Skip Montanarob4a04172003-03-20 23:29:12 +0000715
716 def test_float_write(self):
717 import array
718 contents = [(20-i)*0.1 for i in range(20)]
719 a = array.array('f', contents)
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000720 fd, name = tempfile.mkstemp()
721 fileobj = os.fdopen(fd, "w+b")
722 try:
723 writer = csv.writer(fileobj, dialect="excel")
724 writer.writerow(a)
725 expected = ",".join([str(i) for i in a])+"\r\n"
726 fileobj.seek(0)
727 self.assertEqual(fileobj.read(), expected)
728 finally:
729 fileobj.close()
730 os.unlink(name)
Skip Montanarob4a04172003-03-20 23:29:12 +0000731
732 def test_char_write(self):
733 import array, string
734 a = array.array('c', string.letters)
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000735 fd, name = tempfile.mkstemp()
736 fileobj = os.fdopen(fd, "w+b")
737 try:
738 writer = csv.writer(fileobj, dialect="excel")
739 writer.writerow(a)
740 expected = ",".join(a)+"\r\n"
741 fileobj.seek(0)
742 self.assertEqual(fileobj.read(), expected)
743 finally:
744 fileobj.close()
745 os.unlink(name)
Skip Montanarob4a04172003-03-20 23:29:12 +0000746
747class TestDialectValidity(unittest.TestCase):
748 def test_quoting(self):
749 class mydialect(csv.Dialect):
750 delimiter = ";"
751 escapechar = '\\'
752 doublequote = False
753 skipinitialspace = True
754 lineterminator = '\r\n'
755 quoting = csv.QUOTE_NONE
756 d = mydialect()
757
758 mydialect.quoting = None
759 self.assertRaises(csv.Error, mydialect)
760
Skip Montanarob4a04172003-03-20 23:29:12 +0000761 mydialect.doublequote = True
762 mydialect.quoting = csv.QUOTE_ALL
763 mydialect.quotechar = '"'
764 d = mydialect()
765
766 mydialect.quotechar = "''"
767 self.assertRaises(csv.Error, mydialect)
768
769 mydialect.quotechar = 4
770 self.assertRaises(csv.Error, mydialect)
771
772 def test_delimiter(self):
773 class mydialect(csv.Dialect):
774 delimiter = ";"
775 escapechar = '\\'
776 doublequote = False
777 skipinitialspace = True
778 lineterminator = '\r\n'
779 quoting = csv.QUOTE_NONE
780 d = mydialect()
781
782 mydialect.delimiter = ":::"
783 self.assertRaises(csv.Error, mydialect)
784
785 mydialect.delimiter = 4
786 self.assertRaises(csv.Error, mydialect)
787
788 def test_lineterminator(self):
789 class mydialect(csv.Dialect):
790 delimiter = ";"
791 escapechar = '\\'
792 doublequote = False
793 skipinitialspace = True
794 lineterminator = '\r\n'
795 quoting = csv.QUOTE_NONE
796 d = mydialect()
797
798 mydialect.lineterminator = ":::"
799 d = mydialect()
800
801 mydialect.lineterminator = 4
802 self.assertRaises(csv.Error, mydialect)
803
804
Skip Montanaro48816c62003-04-25 14:43:14 +0000805class TestSniffer(unittest.TestCase):
806 sample1 = """\
807Harry's, Arlington Heights, IL, 2/1/03, Kimi Hayes
808Shark City, Glendale Heights, IL, 12/28/02, Prezence
809Tommy's Place, Blue Island, IL, 12/28/02, Blue Sunday/White Crow
810Stonecutters Seafood and Chop House, Lemont, IL, 12/19/02, Week Back
811"""
812 sample2 = """\
813'Harry''s':'Arlington Heights':'IL':'2/1/03':'Kimi Hayes'
814'Shark City':'Glendale Heights':'IL':'12/28/02':'Prezence'
815'Tommy''s Place':'Blue Island':'IL':'12/28/02':'Blue Sunday/White Crow'
816'Stonecutters Seafood and Chop House':'Lemont':'IL':'12/19/02':'Week Back'
817"""
818
819 header = '''\
820"venue","city","state","date","performers"
821'''
Skip Montanaro77892372003-05-19 15:33:36 +0000822 sample3 = '''\
82305/05/03?05/05/03?05/05/03?05/05/03?05/05/03?05/05/03
82405/05/03?05/05/03?05/05/03?05/05/03?05/05/03?05/05/03
82505/05/03?05/05/03?05/05/03?05/05/03?05/05/03?05/05/03
826'''
827
Skip Montanaro1546bc42003-06-12 02:40:22 +0000828 sample4 = '''\
8292147483648;43.0e12;17;abc;def
830147483648;43.0e2;17;abc;def
83147483648;43.0;170;abc;def
832'''
833
Skip Montanaro48816c62003-04-25 14:43:14 +0000834 def test_has_header(self):
835 sniffer = csv.Sniffer()
836 self.assertEqual(sniffer.has_header(self.sample1), False)
837 self.assertEqual(sniffer.has_header(self.header+self.sample1), True)
838
839 def test_sniff(self):
840 sniffer = csv.Sniffer()
841 dialect = sniffer.sniff(self.sample1)
842 self.assertEqual(dialect.delimiter, ",")
843 self.assertEqual(dialect.quotechar, '"')
844 self.assertEqual(dialect.skipinitialspace, True)
845
846 dialect = sniffer.sniff(self.sample2)
847 self.assertEqual(dialect.delimiter, ":")
848 self.assertEqual(dialect.quotechar, "'")
849 self.assertEqual(dialect.skipinitialspace, False)
850
Skip Montanaro77892372003-05-19 15:33:36 +0000851 def test_delimiters(self):
852 sniffer = csv.Sniffer()
853 dialect = sniffer.sniff(self.sample3)
854 self.assertEqual(dialect.delimiter, "0")
855 dialect = sniffer.sniff(self.sample3, delimiters="?,")
856 self.assertEqual(dialect.delimiter, "?")
857 dialect = sniffer.sniff(self.sample3, delimiters="/,")
858 self.assertEqual(dialect.delimiter, "/")
Skip Montanaro1546bc42003-06-12 02:40:22 +0000859 dialect = sniffer.sniff(self.sample4)
860 self.assertEqual(dialect.delimiter, ";")
Skip Montanaro77892372003-05-19 15:33:36 +0000861
Skip Montanarob4a04172003-03-20 23:29:12 +0000862if not hasattr(sys, "gettotalrefcount"):
Walter Dörwald21d3a322003-05-01 17:45:56 +0000863 if test_support.verbose: print "*** skipping leakage tests ***"
Skip Montanarob4a04172003-03-20 23:29:12 +0000864else:
865 class NUL:
866 def write(s, *args):
867 pass
868 writelines = write
869
870 class TestLeaks(unittest.TestCase):
871 def test_create_read(self):
872 delta = 0
873 lastrc = sys.gettotalrefcount()
874 for i in xrange(20):
875 gc.collect()
876 self.assertEqual(gc.garbage, [])
877 rc = sys.gettotalrefcount()
878 csv.reader(["a,b,c\r\n"])
879 csv.reader(["a,b,c\r\n"])
880 csv.reader(["a,b,c\r\n"])
881 delta = rc-lastrc
882 lastrc = rc
883 # if csv.reader() leaks, last delta should be 3 or more
884 self.assertEqual(delta < 3, True)
885
886 def test_create_write(self):
887 delta = 0
888 lastrc = sys.gettotalrefcount()
889 s = NUL()
890 for i in xrange(20):
891 gc.collect()
892 self.assertEqual(gc.garbage, [])
893 rc = sys.gettotalrefcount()
894 csv.writer(s)
895 csv.writer(s)
896 csv.writer(s)
897 delta = rc-lastrc
898 lastrc = rc
899 # if csv.writer() leaks, last delta should be 3 or more
900 self.assertEqual(delta < 3, True)
901
902 def test_read(self):
903 delta = 0
904 rows = ["a,b,c\r\n"]*5
905 lastrc = sys.gettotalrefcount()
906 for i in xrange(20):
907 gc.collect()
908 self.assertEqual(gc.garbage, [])
909 rc = sys.gettotalrefcount()
910 rdr = csv.reader(rows)
911 for row in rdr:
912 pass
913 delta = rc-lastrc
914 lastrc = rc
915 # if reader leaks during read, delta should be 5 or more
916 self.assertEqual(delta < 5, True)
917
918 def test_write(self):
919 delta = 0
920 rows = [[1,2,3]]*5
921 s = NUL()
922 lastrc = sys.gettotalrefcount()
923 for i in xrange(20):
924 gc.collect()
925 self.assertEqual(gc.garbage, [])
926 rc = sys.gettotalrefcount()
927 writer = csv.writer(s)
928 for row in rows:
929 writer.writerow(row)
930 delta = rc-lastrc
931 lastrc = rc
932 # if writer leaks during write, last delta should be 5 or more
933 self.assertEqual(delta < 5, True)
934
Skip Montanaro1a566652003-05-06 15:56:05 +0000935# commented out for now - csv module doesn't yet support Unicode
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000936## class TestUnicode(unittest.TestCase):
937## def test_unicode_read(self):
938## import codecs
939## f = codecs.EncodedFile(StringIO("Martin von Löwis,"
940## "Marc André Lemburg,"
941## "Guido van Rossum,"
942## "François Pinard\r\n"),
943## data_encoding='iso-8859-1')
944## reader = csv.reader(f)
945## self.assertEqual(list(reader), [[u"Martin von Löwis",
946## u"Marc André Lemburg",
947## u"Guido van Rossum",
948## u"François Pinardn"]])
Skip Montanaro1a566652003-05-06 15:56:05 +0000949
Walter Dörwald21d3a322003-05-01 17:45:56 +0000950def test_main():
Skip Montanarob4a04172003-03-20 23:29:12 +0000951 mod = sys.modules[__name__]
Walter Dörwald21d3a322003-05-01 17:45:56 +0000952 test_support.run_unittest(
953 *[getattr(mod, name) for name in dir(mod) if name.startswith('Test')]
954 )
Skip Montanarob4a04172003-03-20 23:29:12 +0000955
956if __name__ == '__main__':
Walter Dörwald21d3a322003-05-01 17:45:56 +0000957 test_main()