blob: ed10ed79a47614d496d40f971941ca3d8e3d8f4e [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 McNamara5d45a8d2005-01-12 08:16:17 +000035 self.assertRaises(TypeError, ctor, arg,
36 quoting=csv.QUOTE_ALL, quotechar=None)
Andrew McNamara1196cf12005-01-07 04:42:45 +000037
38 def test_reader_arg_valid(self):
39 self._test_arg_valid(csv.reader, [])
Skip Montanarob4a04172003-03-20 23:29:12 +000040
41 def test_writer_arg_valid(self):
Andrew McNamara1196cf12005-01-07 04:42:45 +000042 self._test_arg_valid(csv.writer, StringIO())
Skip Montanarob4a04172003-03-20 23:29:12 +000043
Andrew McNamara1196cf12005-01-07 04:42:45 +000044 def _test_default_attrs(self, ctor, *args):
45 obj = ctor(*args)
46 # Check defaults
Skip Montanarob4a04172003-03-20 23:29:12 +000047 self.assertEqual(obj.dialect.delimiter, ',')
Andrew McNamara1196cf12005-01-07 04:42:45 +000048 self.assertEqual(obj.dialect.doublequote, True)
Skip Montanarob4a04172003-03-20 23:29:12 +000049 self.assertEqual(obj.dialect.escapechar, None)
Andrew McNamara1196cf12005-01-07 04:42:45 +000050 self.assertEqual(obj.dialect.lineterminator, "\r\n")
51 self.assertEqual(obj.dialect.quotechar, '"')
52 self.assertEqual(obj.dialect.quoting, csv.QUOTE_MINIMAL)
53 self.assertEqual(obj.dialect.skipinitialspace, False)
54 self.assertEqual(obj.dialect.strict, False)
55 # Try deleting or changing attributes (they are read-only)
56 self.assertRaises(TypeError, delattr, obj.dialect, 'delimiter')
57 self.assertRaises(TypeError, setattr, obj.dialect, 'delimiter', ':')
Skip Montanarob4a04172003-03-20 23:29:12 +000058 self.assertRaises(TypeError, delattr, obj.dialect, 'quoting')
59 self.assertRaises(TypeError, setattr, obj.dialect, 'quoting', None)
Skip Montanarob4a04172003-03-20 23:29:12 +000060
61 def test_reader_attrs(self):
Andrew McNamara1196cf12005-01-07 04:42:45 +000062 self._test_default_attrs(csv.reader, [])
Skip Montanarob4a04172003-03-20 23:29:12 +000063
64 def test_writer_attrs(self):
Andrew McNamara1196cf12005-01-07 04:42:45 +000065 self._test_default_attrs(csv.writer, StringIO())
66
67 def _test_kw_attrs(self, ctor, *args):
68 # Now try with alternate options
69 kwargs = dict(delimiter=':', doublequote=False, escapechar='\\',
70 lineterminator='\r', quotechar='*',
71 quoting=csv.QUOTE_NONE, skipinitialspace=True,
72 strict=True)
73 obj = ctor(*args, **kwargs)
74 self.assertEqual(obj.dialect.delimiter, ':')
75 self.assertEqual(obj.dialect.doublequote, False)
76 self.assertEqual(obj.dialect.escapechar, '\\')
77 self.assertEqual(obj.dialect.lineterminator, "\r")
78 self.assertEqual(obj.dialect.quotechar, '*')
79 self.assertEqual(obj.dialect.quoting, csv.QUOTE_NONE)
80 self.assertEqual(obj.dialect.skipinitialspace, True)
81 self.assertEqual(obj.dialect.strict, True)
82
83 def test_reader_kw_attrs(self):
84 self._test_kw_attrs(csv.reader, [])
85
86 def test_writer_kw_attrs(self):
87 self._test_kw_attrs(csv.writer, StringIO())
88
89 def _test_dialect_attrs(self, ctor, *args):
90 # Now try with dialect-derived options
91 class dialect:
92 delimiter='-'
93 doublequote=False
94 escapechar='^'
95 lineterminator='$'
96 quotechar='#'
97 quoting=csv.QUOTE_ALL
98 skipinitialspace=True
99 strict=False
100 args = args + (dialect,)
101 obj = ctor(*args)
102 self.assertEqual(obj.dialect.delimiter, '-')
103 self.assertEqual(obj.dialect.doublequote, False)
104 self.assertEqual(obj.dialect.escapechar, '^')
105 self.assertEqual(obj.dialect.lineterminator, "$")
106 self.assertEqual(obj.dialect.quotechar, '#')
107 self.assertEqual(obj.dialect.quoting, csv.QUOTE_ALL)
108 self.assertEqual(obj.dialect.skipinitialspace, True)
109 self.assertEqual(obj.dialect.strict, False)
110
111 def test_reader_dialect_attrs(self):
112 self._test_dialect_attrs(csv.reader, [])
113
114 def test_writer_dialect_attrs(self):
115 self._test_dialect_attrs(csv.writer, StringIO())
116
Skip Montanarob4a04172003-03-20 23:29:12 +0000117
118 def _write_test(self, fields, expect, **kwargs):
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000119 fd, name = tempfile.mkstemp()
120 fileobj = os.fdopen(fd, "w+b")
121 try:
122 writer = csv.writer(fileobj, **kwargs)
123 writer.writerow(fields)
124 fileobj.seek(0)
125 self.assertEqual(fileobj.read(),
126 expect + writer.dialect.lineterminator)
127 finally:
128 fileobj.close()
129 os.unlink(name)
Skip Montanarob4a04172003-03-20 23:29:12 +0000130
131 def test_write_arg_valid(self):
132 self.assertRaises(csv.Error, self._write_test, None, '')
133 self._write_test((), '')
134 self._write_test([None], '""')
Tim Peters0eadaac2003-04-24 16:02:54 +0000135 self.assertRaises(csv.Error, self._write_test,
Skip Montanarob4a04172003-03-20 23:29:12 +0000136 [None], None, quoting = csv.QUOTE_NONE)
137 # Check that exceptions are passed up the chain
138 class BadList:
139 def __len__(self):
140 return 10;
141 def __getitem__(self, i):
142 if i > 2:
143 raise IOError
144 self.assertRaises(IOError, self._write_test, BadList(), '')
145 class BadItem:
146 def __str__(self):
147 raise IOError
148 self.assertRaises(IOError, self._write_test, [BadItem()], '')
149
150 def test_write_bigfield(self):
151 # This exercises the buffer realloc functionality
152 bigstring = 'X' * 50000
153 self._write_test([bigstring,bigstring], '%s,%s' % \
154 (bigstring, bigstring))
155
156 def test_write_quoting(self):
Andrew McNamarac89f2842005-01-12 07:44:42 +0000157 self._write_test(['a',1,'p,q'], 'a,1,"p,q"')
Tim Peters0eadaac2003-04-24 16:02:54 +0000158 self.assertRaises(csv.Error,
Skip Montanarob4a04172003-03-20 23:29:12 +0000159 self._write_test,
Andrew McNamarac89f2842005-01-12 07:44:42 +0000160 ['a',1,'p,q'], 'a,1,p,q',
Skip Montanarob4a04172003-03-20 23:29:12 +0000161 quoting = csv.QUOTE_NONE)
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_MINIMAL)
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_NONNUMERIC)
Andrew McNamarac89f2842005-01-12 07:44:42 +0000166 self._write_test(['a',1,'p,q'], '"a","1","p,q"',
Skip Montanarob4a04172003-03-20 23:29:12 +0000167 quoting = csv.QUOTE_ALL)
168
169 def test_write_escape(self):
Andrew McNamarac89f2842005-01-12 07:44:42 +0000170 self._write_test(['a',1,'p,q'], 'a,1,"p,q"',
Skip Montanarob4a04172003-03-20 23:29:12 +0000171 escapechar='\\')
Andrew McNamarac89f2842005-01-12 07:44:42 +0000172 self.assertRaises(csv.Error,
173 self._write_test,
174 ['a',1,'p,"q"'], 'a,1,"p,\\"q\\""',
175 escapechar=None, doublequote=False)
176 self._write_test(['a',1,'p,"q"'], 'a,1,"p,\\"q\\""',
177 escapechar='\\', doublequote = False)
178 self._write_test(['"'], '""""',
179 escapechar='\\', quoting = csv.QUOTE_MINIMAL)
180 self._write_test(['"'], '\\"',
181 escapechar='\\', quoting = csv.QUOTE_MINIMAL,
182 doublequote = False)
183 self._write_test(['"'], '\\"',
184 escapechar='\\', quoting = csv.QUOTE_NONE)
185 self._write_test(['a',1,'p,q'], 'a,1,p\\,q',
Skip Montanarob4a04172003-03-20 23:29:12 +0000186 escapechar='\\', quoting = csv.QUOTE_NONE)
187
188 def test_writerows(self):
189 class BrokenFile:
190 def write(self, buf):
191 raise IOError
192 writer = csv.writer(BrokenFile())
193 self.assertRaises(IOError, writer.writerows, [['a']])
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000194 fd, name = tempfile.mkstemp()
195 fileobj = os.fdopen(fd, "w+b")
196 try:
197 writer = csv.writer(fileobj)
198 self.assertRaises(TypeError, writer.writerows, None)
199 writer.writerows([['a','b'],['c','d']])
200 fileobj.seek(0)
201 self.assertEqual(fileobj.read(), "a,b\r\nc,d\r\n")
202 finally:
203 fileobj.close()
204 os.unlink(name)
Tim Peters27f88362004-07-08 04:22:35 +0000205
Skip Montanarob4a04172003-03-20 23:29:12 +0000206 def _read_test(self, input, expect, **kwargs):
207 reader = csv.reader(input, **kwargs)
208 result = list(reader)
209 self.assertEqual(result, expect)
210
211 def test_read_oddinputs(self):
212 self._read_test([], [])
213 self._read_test([''], [[]])
214 self.assertRaises(csv.Error, self._read_test,
215 ['"ab"c'], None, strict = 1)
216 # cannot handle null bytes for the moment
217 self.assertRaises(csv.Error, self._read_test,
218 ['ab\0c'], None, strict = 1)
219 self._read_test(['"ab"c'], [['abc']], doublequote = 0)
220
221 def test_read_eol(self):
222 self._read_test(['a,b'], [['a','b']])
223 self._read_test(['a,b\n'], [['a','b']])
224 self._read_test(['a,b\r\n'], [['a','b']])
225 self._read_test(['a,b\r'], [['a','b']])
226 self.assertRaises(csv.Error, self._read_test, ['a,b\rc,d'], [])
227 self.assertRaises(csv.Error, self._read_test, ['a,b\nc,d'], [])
228 self.assertRaises(csv.Error, self._read_test, ['a,b\r\nc,d'], [])
229
230 def test_read_escape(self):
Andrew McNamara36a76912005-01-10 01:04:40 +0000231 self._read_test(['a,\\b,c'], [['a', 'b', 'c']], escapechar='\\')
Skip Montanarob4a04172003-03-20 23:29:12 +0000232 self._read_test(['a,b\\,c'], [['a', 'b,c']], escapechar='\\')
233 self._read_test(['a,"b\\,c"'], [['a', 'b,c']], escapechar='\\')
Andrew McNamara36a76912005-01-10 01:04:40 +0000234 self._read_test(['a,"b,\\c"'], [['a', 'b,c']], escapechar='\\')
Skip Montanarob4a04172003-03-20 23:29:12 +0000235 self._read_test(['a,"b,c\\""'], [['a', 'b,c"']], escapechar='\\')
236 self._read_test(['a,"b,c"\\'], [['a', 'b,c\\']], escapechar='\\')
237
Andrew McNamara1196cf12005-01-07 04:42:45 +0000238 def test_read_quoting(self):
239 self._read_test(['1,",3,",5'], [['1', ',3,', '5']])
240 self._read_test(['1,",3,",5'], [['1', '"', '3', '"', '5']],
241 quotechar=None, escapechar='\\')
242 self._read_test(['1,",3,",5'], [['1', '"', '3', '"', '5']],
243 quoting=csv.QUOTE_NONE, escapechar='\\')
244
Skip Montanarob4a04172003-03-20 23:29:12 +0000245 def test_read_bigfield(self):
Andrew McNamarae4d05c42005-01-11 07:32:02 +0000246 # This exercises the buffer realloc functionality and field size
247 # limits.
Andrew McNamara31d88962005-01-12 03:45:10 +0000248 limit = csv.field_size_limit()
Andrew McNamaraaf1e3122005-01-12 01:55:21 +0000249 try:
250 size = 50000
251 bigstring = 'X' * size
252 bigline = '%s,%s' % (bigstring, bigstring)
253 self._read_test([bigline], [[bigstring, bigstring]])
Andrew McNamara31d88962005-01-12 03:45:10 +0000254 csv.field_size_limit(size)
Andrew McNamaraaf1e3122005-01-12 01:55:21 +0000255 self._read_test([bigline], [[bigstring, bigstring]])
Andrew McNamara31d88962005-01-12 03:45:10 +0000256 self.assertEqual(csv.field_size_limit(), size)
257 csv.field_size_limit(size-1)
Andrew McNamaraaf1e3122005-01-12 01:55:21 +0000258 self.assertRaises(csv.Error, self._read_test, [bigline], [])
Andrew McNamara31d88962005-01-12 03:45:10 +0000259 self.assertRaises(TypeError, csv.field_size_limit, None)
260 self.assertRaises(TypeError, csv.field_size_limit, 1, None)
Andrew McNamaraaf1e3122005-01-12 01:55:21 +0000261 finally:
Andrew McNamara31d88962005-01-12 03:45:10 +0000262 csv.field_size_limit(limit)
Skip Montanarob4a04172003-03-20 23:29:12 +0000263
264class TestDialectRegistry(unittest.TestCase):
265 def test_registry_badargs(self):
266 self.assertRaises(TypeError, csv.list_dialects, None)
267 self.assertRaises(TypeError, csv.get_dialect)
268 self.assertRaises(csv.Error, csv.get_dialect, None)
269 self.assertRaises(csv.Error, csv.get_dialect, "nonesuch")
270 self.assertRaises(TypeError, csv.unregister_dialect)
271 self.assertRaises(csv.Error, csv.unregister_dialect, None)
272 self.assertRaises(csv.Error, csv.unregister_dialect, "nonesuch")
273 self.assertRaises(TypeError, csv.register_dialect, None)
274 self.assertRaises(TypeError, csv.register_dialect, None, None)
Andrew McNamaraaf1e3122005-01-12 01:55:21 +0000275 self.assertRaises(TypeError, csv.register_dialect, "nonesuch", 0, 0)
276 self.assertRaises(TypeError, csv.register_dialect, "nonesuch",
277 badargument=None)
278 self.assertRaises(TypeError, csv.register_dialect, "nonesuch",
279 quoting=None)
280 self.assertRaises(TypeError, csv.register_dialect, [])
Skip Montanarob4a04172003-03-20 23:29:12 +0000281
282 def test_registry(self):
283 class myexceltsv(csv.excel):
284 delimiter = "\t"
285 name = "myexceltsv"
286 expected_dialects = csv.list_dialects() + [name]
287 expected_dialects.sort()
288 csv.register_dialect(name, myexceltsv)
289 try:
Andrew McNamara86625972005-01-11 01:28:33 +0000290 self.failUnless(csv.get_dialect(name).delimiter, '\t')
Skip Montanarob4a04172003-03-20 23:29:12 +0000291 got_dialects = csv.list_dialects()
292 got_dialects.sort()
293 self.assertEqual(expected_dialects, got_dialects)
294 finally:
295 csv.unregister_dialect(name)
296
Andrew McNamara86625972005-01-11 01:28:33 +0000297 def test_register_kwargs(self):
298 name = 'fedcba'
299 csv.register_dialect(name, delimiter=';')
300 try:
301 self.failUnless(csv.get_dialect(name).delimiter, '\t')
302 self.failUnless(list(csv.reader('X;Y;Z', name)), ['X', 'Y', 'Z'])
303 finally:
304 csv.unregister_dialect(name)
305
Skip Montanarob4a04172003-03-20 23:29:12 +0000306 def test_incomplete_dialect(self):
307 class myexceltsv(csv.Dialect):
308 delimiter = "\t"
309 self.assertRaises(csv.Error, myexceltsv)
310
311 def test_space_dialect(self):
312 class space(csv.excel):
313 delimiter = " "
314 quoting = csv.QUOTE_NONE
315 escapechar = "\\"
316
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000317 fd, name = tempfile.mkstemp()
318 fileobj = os.fdopen(fd, "w+b")
319 try:
320 fileobj.write("abc def\nc1ccccc1 benzene\n")
321 fileobj.seek(0)
322 rdr = csv.reader(fileobj, dialect=space())
323 self.assertEqual(rdr.next(), ["abc", "def"])
324 self.assertEqual(rdr.next(), ["c1ccccc1", "benzene"])
325 finally:
326 fileobj.close()
327 os.unlink(name)
Tim Peters27f88362004-07-08 04:22:35 +0000328
Skip Montanarob4a04172003-03-20 23:29:12 +0000329 def test_dialect_apply(self):
330 class testA(csv.excel):
331 delimiter = "\t"
332 class testB(csv.excel):
333 delimiter = ":"
334 class testC(csv.excel):
335 delimiter = "|"
336
337 csv.register_dialect('testC', testC)
338 try:
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000339 fd, name = tempfile.mkstemp()
340 fileobj = os.fdopen(fd, "w+b")
341 try:
342 writer = csv.writer(fileobj)
343 writer.writerow([1,2,3])
344 fileobj.seek(0)
345 self.assertEqual(fileobj.read(), "1,2,3\r\n")
346 finally:
347 fileobj.close()
348 os.unlink(name)
Tim Peters27f88362004-07-08 04:22:35 +0000349
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000350 fd, name = tempfile.mkstemp()
351 fileobj = os.fdopen(fd, "w+b")
352 try:
353 writer = csv.writer(fileobj, testA)
354 writer.writerow([1,2,3])
355 fileobj.seek(0)
356 self.assertEqual(fileobj.read(), "1\t2\t3\r\n")
357 finally:
358 fileobj.close()
359 os.unlink(name)
Skip Montanarob4a04172003-03-20 23:29:12 +0000360
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000361 fd, name = tempfile.mkstemp()
362 fileobj = os.fdopen(fd, "w+b")
363 try:
364 writer = csv.writer(fileobj, dialect=testB())
365 writer.writerow([1,2,3])
366 fileobj.seek(0)
367 self.assertEqual(fileobj.read(), "1:2:3\r\n")
368 finally:
369 fileobj.close()
370 os.unlink(name)
Skip Montanarob4a04172003-03-20 23:29:12 +0000371
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000372 fd, name = tempfile.mkstemp()
373 fileobj = os.fdopen(fd, "w+b")
374 try:
375 writer = csv.writer(fileobj, dialect='testC')
376 writer.writerow([1,2,3])
377 fileobj.seek(0)
378 self.assertEqual(fileobj.read(), "1|2|3\r\n")
379 finally:
380 fileobj.close()
381 os.unlink(name)
Skip Montanarob4a04172003-03-20 23:29:12 +0000382
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000383 fd, name = tempfile.mkstemp()
384 fileobj = os.fdopen(fd, "w+b")
385 try:
386 writer = csv.writer(fileobj, dialect=testA, delimiter=';')
387 writer.writerow([1,2,3])
388 fileobj.seek(0)
389 self.assertEqual(fileobj.read(), "1;2;3\r\n")
390 finally:
391 fileobj.close()
392 os.unlink(name)
Skip Montanarob4a04172003-03-20 23:29:12 +0000393
Skip Montanarob4a04172003-03-20 23:29:12 +0000394 finally:
395 csv.unregister_dialect('testC')
396
397 def test_bad_dialect(self):
398 # Unknown parameter
Andrew McNamara1196cf12005-01-07 04:42:45 +0000399 self.assertRaises(TypeError, csv.reader, [], bad_attr = 0)
Skip Montanarob4a04172003-03-20 23:29:12 +0000400 # Bad values
401 self.assertRaises(TypeError, csv.reader, [], delimiter = None)
402 self.assertRaises(TypeError, csv.reader, [], quoting = -1)
403 self.assertRaises(TypeError, csv.reader, [], quoting = 100)
404
405class TestCsvBase(unittest.TestCase):
406 def readerAssertEqual(self, input, expected_result):
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000407 fd, name = tempfile.mkstemp()
408 fileobj = os.fdopen(fd, "w+b")
409 try:
410 fileobj.write(input)
411 fileobj.seek(0)
412 reader = csv.reader(fileobj, dialect = self.dialect)
413 fields = list(reader)
414 self.assertEqual(fields, expected_result)
415 finally:
416 fileobj.close()
417 os.unlink(name)
Skip Montanarob4a04172003-03-20 23:29:12 +0000418
419 def writerAssertEqual(self, input, expected_result):
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000420 fd, name = tempfile.mkstemp()
421 fileobj = os.fdopen(fd, "w+b")
422 try:
423 writer = csv.writer(fileobj, dialect = self.dialect)
424 writer.writerows(input)
425 fileobj.seek(0)
426 self.assertEqual(fileobj.read(), expected_result)
427 finally:
428 fileobj.close()
429 os.unlink(name)
Skip Montanarob4a04172003-03-20 23:29:12 +0000430
431class TestDialectExcel(TestCsvBase):
432 dialect = 'excel'
433
434 def test_single(self):
435 self.readerAssertEqual('abc', [['abc']])
436
437 def test_simple(self):
438 self.readerAssertEqual('1,2,3,4,5', [['1','2','3','4','5']])
439
440 def test_blankline(self):
441 self.readerAssertEqual('', [])
442
443 def test_empty_fields(self):
444 self.readerAssertEqual(',', [['', '']])
445
446 def test_singlequoted(self):
447 self.readerAssertEqual('""', [['']])
448
449 def test_singlequoted_left_empty(self):
450 self.readerAssertEqual('"",', [['','']])
451
452 def test_singlequoted_right_empty(self):
453 self.readerAssertEqual(',""', [['','']])
454
455 def test_single_quoted_quote(self):
456 self.readerAssertEqual('""""', [['"']])
457
458 def test_quoted_quotes(self):
459 self.readerAssertEqual('""""""', [['""']])
460
461 def test_inline_quote(self):
462 self.readerAssertEqual('a""b', [['a""b']])
463
464 def test_inline_quotes(self):
465 self.readerAssertEqual('a"b"c', [['a"b"c']])
466
467 def test_quotes_and_more(self):
468 self.readerAssertEqual('"a"b', [['ab']])
469
470 def test_lone_quote(self):
471 self.readerAssertEqual('a"b', [['a"b']])
472
473 def test_quote_and_quote(self):
474 self.readerAssertEqual('"a" "b"', [['a "b"']])
475
476 def test_space_and_quote(self):
477 self.readerAssertEqual(' "a"', [[' "a"']])
478
479 def test_quoted(self):
Tim Peters0eadaac2003-04-24 16:02:54 +0000480 self.readerAssertEqual('1,2,3,"I think, therefore I am",5,6',
481 [['1', '2', '3',
482 'I think, therefore I am',
Skip Montanarob4a04172003-03-20 23:29:12 +0000483 '5', '6']])
484
485 def test_quoted_quote(self):
486 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 +0000487 [['1', '2', '3',
488 '"I see," said the blind man',
Skip Montanarob4a04172003-03-20 23:29:12 +0000489 'as he picked up his hammer and saw']])
490
491 def test_quoted_nl(self):
492 input = '''\
4931,2,3,"""I see,""
494said the blind man","as he picked up his
495hammer and saw"
4969,8,7,6'''
497 self.readerAssertEqual(input,
Tim Peters0eadaac2003-04-24 16:02:54 +0000498 [['1', '2', '3',
499 '"I see,"\nsaid the blind man',
Skip Montanarob4a04172003-03-20 23:29:12 +0000500 'as he picked up his\nhammer and saw'],
501 ['9','8','7','6']])
502
503 def test_dubious_quote(self):
504 self.readerAssertEqual('12,12,1",', [['12', '12', '1"', '']])
505
506 def test_null(self):
507 self.writerAssertEqual([], '')
508
509 def test_single(self):
510 self.writerAssertEqual([['abc']], 'abc\r\n')
511
512 def test_simple(self):
513 self.writerAssertEqual([[1, 2, 'abc', 3, 4]], '1,2,abc,3,4\r\n')
514
515 def test_quotes(self):
516 self.writerAssertEqual([[1, 2, 'a"bc"', 3, 4]], '1,2,"a""bc""",3,4\r\n')
517
518 def test_quote_fieldsep(self):
519 self.writerAssertEqual([['abc,def']], '"abc,def"\r\n')
520
521 def test_newlines(self):
522 self.writerAssertEqual([[1, 2, 'a\nbc', 3, 4]], '1,2,"a\nbc",3,4\r\n')
523
524class EscapedExcel(csv.excel):
525 quoting = csv.QUOTE_NONE
526 escapechar = '\\'
527
528class TestEscapedExcel(TestCsvBase):
529 dialect = EscapedExcel()
530
531 def test_escape_fieldsep(self):
532 self.writerAssertEqual([['abc,def']], 'abc\\,def\r\n')
533
534 def test_read_escape_fieldsep(self):
535 self.readerAssertEqual('abc\\,def\r\n', [['abc,def']])
536
537class QuotedEscapedExcel(csv.excel):
538 quoting = csv.QUOTE_NONNUMERIC
539 escapechar = '\\'
540
541class TestQuotedEscapedExcel(TestCsvBase):
542 dialect = QuotedEscapedExcel()
543
544 def test_write_escape_fieldsep(self):
545 self.writerAssertEqual([['abc,def']], '"abc,def"\r\n')
546
547 def test_read_escape_fieldsep(self):
548 self.readerAssertEqual('"abc\\,def"\r\n', [['abc,def']])
549
Skip Montanarob4a04172003-03-20 23:29:12 +0000550class TestDictFields(unittest.TestCase):
551 ### "long" means the row is longer than the number of fieldnames
552 ### "short" means there are fewer elements in the row than fieldnames
553 def test_write_simple_dict(self):
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000554 fd, name = tempfile.mkstemp()
555 fileobj = os.fdopen(fd, "w+b")
556 try:
557 writer = csv.DictWriter(fileobj, fieldnames = ["f1", "f2", "f3"])
558 writer.writerow({"f1": 10, "f3": "abc"})
559 fileobj.seek(0)
560 self.assertEqual(fileobj.read(), "10,,abc\r\n")
561 finally:
562 fileobj.close()
563 os.unlink(name)
Skip Montanarob4a04172003-03-20 23:29:12 +0000564
565 def test_write_no_fields(self):
566 fileobj = StringIO()
567 self.assertRaises(TypeError, csv.DictWriter, fileobj)
568
569 def test_read_dict_fields(self):
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000570 fd, name = tempfile.mkstemp()
571 fileobj = os.fdopen(fd, "w+b")
572 try:
573 fileobj.write("1,2,abc\r\n")
574 fileobj.seek(0)
575 reader = csv.DictReader(fileobj,
576 fieldnames=["f1", "f2", "f3"])
577 self.assertEqual(reader.next(), {"f1": '1', "f2": '2', "f3": 'abc'})
578 finally:
579 fileobj.close()
580 os.unlink(name)
Skip Montanarob4a04172003-03-20 23:29:12 +0000581
Skip Montanarodffeed32003-10-03 14:03:01 +0000582 def test_read_dict_no_fieldnames(self):
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000583 fd, name = tempfile.mkstemp()
584 fileobj = os.fdopen(fd, "w+b")
585 try:
586 fileobj.write("f1,f2,f3\r\n1,2,abc\r\n")
587 fileobj.seek(0)
588 reader = csv.DictReader(fileobj)
589 self.assertEqual(reader.next(), {"f1": '1', "f2": '2', "f3": 'abc'})
590 finally:
591 fileobj.close()
592 os.unlink(name)
Skip Montanarodffeed32003-10-03 14:03:01 +0000593
Skip Montanarob4a04172003-03-20 23:29:12 +0000594 def test_read_long(self):
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000595 fd, name = tempfile.mkstemp()
596 fileobj = os.fdopen(fd, "w+b")
597 try:
598 fileobj.write("1,2,abc,4,5,6\r\n")
599 fileobj.seek(0)
600 reader = csv.DictReader(fileobj,
601 fieldnames=["f1", "f2"])
602 self.assertEqual(reader.next(), {"f1": '1', "f2": '2',
603 None: ["abc", "4", "5", "6"]})
604 finally:
605 fileobj.close()
606 os.unlink(name)
Skip Montanarob4a04172003-03-20 23:29:12 +0000607
608 def test_read_long_with_rest(self):
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000609 fd, name = tempfile.mkstemp()
610 fileobj = os.fdopen(fd, "w+b")
611 try:
612 fileobj.write("1,2,abc,4,5,6\r\n")
613 fileobj.seek(0)
614 reader = csv.DictReader(fileobj,
615 fieldnames=["f1", "f2"], restkey="_rest")
616 self.assertEqual(reader.next(), {"f1": '1', "f2": '2',
617 "_rest": ["abc", "4", "5", "6"]})
618 finally:
619 fileobj.close()
620 os.unlink(name)
Skip Montanarob4a04172003-03-20 23:29:12 +0000621
Skip Montanarodffeed32003-10-03 14:03:01 +0000622 def test_read_long_with_rest_no_fieldnames(self):
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000623 fd, name = tempfile.mkstemp()
624 fileobj = os.fdopen(fd, "w+b")
625 try:
626 fileobj.write("f1,f2\r\n1,2,abc,4,5,6\r\n")
627 fileobj.seek(0)
628 reader = csv.DictReader(fileobj, restkey="_rest")
629 self.assertEqual(reader.next(), {"f1": '1', "f2": '2',
630 "_rest": ["abc", "4", "5", "6"]})
631 finally:
632 fileobj.close()
633 os.unlink(name)
Skip Montanarodffeed32003-10-03 14:03:01 +0000634
Skip Montanarob4a04172003-03-20 23:29:12 +0000635 def test_read_short(self):
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000636 fd, name = tempfile.mkstemp()
637 fileobj = os.fdopen(fd, "w+b")
638 try:
639 fileobj.write("1,2,abc,4,5,6\r\n1,2,abc\r\n")
640 fileobj.seek(0)
641 reader = csv.DictReader(fileobj,
642 fieldnames="1 2 3 4 5 6".split(),
643 restval="DEFAULT")
644 self.assertEqual(reader.next(), {"1": '1', "2": '2', "3": 'abc',
645 "4": '4', "5": '5', "6": '6'})
646 self.assertEqual(reader.next(), {"1": '1', "2": '2', "3": 'abc',
647 "4": 'DEFAULT', "5": 'DEFAULT',
648 "6": 'DEFAULT'})
649 finally:
650 fileobj.close()
651 os.unlink(name)
Skip Montanarob4a04172003-03-20 23:29:12 +0000652
Skip Montanaro1546bc42003-06-12 02:40:22 +0000653 def test_read_multi(self):
654 sample = [
655 '2147483648,43.0e12,17,abc,def\r\n',
656 '147483648,43.0e2,17,abc,def\r\n',
657 '47483648,43.0,170,abc,def\r\n'
658 ]
659
660 reader = csv.DictReader(sample,
661 fieldnames="i1 float i2 s1 s2".split())
662 self.assertEqual(reader.next(), {"i1": '2147483648',
663 "float": '43.0e12',
664 "i2": '17',
665 "s1": 'abc',
666 "s2": 'def'})
667
Skip Montanarob4a04172003-03-20 23:29:12 +0000668 def test_read_with_blanks(self):
669 reader = csv.DictReader(["1,2,abc,4,5,6\r\n","\r\n",
670 "1,2,abc,4,5,6\r\n"],
671 fieldnames="1 2 3 4 5 6".split())
672 self.assertEqual(reader.next(), {"1": '1', "2": '2', "3": 'abc',
673 "4": '4', "5": '5', "6": '6'})
674 self.assertEqual(reader.next(), {"1": '1', "2": '2', "3": 'abc',
675 "4": '4', "5": '5', "6": '6'})
676
Skip Montanaro3f7a9482003-09-06 19:52:12 +0000677 def test_read_semi_sep(self):
678 reader = csv.DictReader(["1;2;abc;4;5;6\r\n"],
679 fieldnames="1 2 3 4 5 6".split(),
680 delimiter=';')
681 self.assertEqual(reader.next(), {"1": '1', "2": '2', "3": 'abc',
682 "4": '4', "5": '5', "6": '6'})
683
Skip Montanarob4a04172003-03-20 23:29:12 +0000684class TestArrayWrites(unittest.TestCase):
685 def test_int_write(self):
686 import array
687 contents = [(20-i) for i in range(20)]
688 a = array.array('i', contents)
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000689
690 fd, name = tempfile.mkstemp()
691 fileobj = os.fdopen(fd, "w+b")
692 try:
693 writer = csv.writer(fileobj, dialect="excel")
694 writer.writerow(a)
695 expected = ",".join([str(i) for i in a])+"\r\n"
696 fileobj.seek(0)
697 self.assertEqual(fileobj.read(), expected)
698 finally:
699 fileobj.close()
700 os.unlink(name)
Skip Montanarob4a04172003-03-20 23:29:12 +0000701
702 def test_double_write(self):
703 import array
704 contents = [(20-i)*0.1 for i in range(20)]
705 a = array.array('d', contents)
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000706 fd, name = tempfile.mkstemp()
707 fileobj = os.fdopen(fd, "w+b")
708 try:
709 writer = csv.writer(fileobj, dialect="excel")
710 writer.writerow(a)
711 expected = ",".join([str(i) for i in a])+"\r\n"
712 fileobj.seek(0)
713 self.assertEqual(fileobj.read(), expected)
714 finally:
715 fileobj.close()
716 os.unlink(name)
Skip Montanarob4a04172003-03-20 23:29:12 +0000717
718 def test_float_write(self):
719 import array
720 contents = [(20-i)*0.1 for i in range(20)]
721 a = array.array('f', contents)
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000722 fd, name = tempfile.mkstemp()
723 fileobj = os.fdopen(fd, "w+b")
724 try:
725 writer = csv.writer(fileobj, dialect="excel")
726 writer.writerow(a)
727 expected = ",".join([str(i) for i in a])+"\r\n"
728 fileobj.seek(0)
729 self.assertEqual(fileobj.read(), expected)
730 finally:
731 fileobj.close()
732 os.unlink(name)
Skip Montanarob4a04172003-03-20 23:29:12 +0000733
734 def test_char_write(self):
735 import array, string
736 a = array.array('c', string.letters)
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000737 fd, name = tempfile.mkstemp()
738 fileobj = os.fdopen(fd, "w+b")
739 try:
740 writer = csv.writer(fileobj, dialect="excel")
741 writer.writerow(a)
742 expected = ",".join(a)+"\r\n"
743 fileobj.seek(0)
744 self.assertEqual(fileobj.read(), expected)
745 finally:
746 fileobj.close()
747 os.unlink(name)
Skip Montanarob4a04172003-03-20 23:29:12 +0000748
749class TestDialectValidity(unittest.TestCase):
750 def test_quoting(self):
751 class mydialect(csv.Dialect):
752 delimiter = ";"
753 escapechar = '\\'
754 doublequote = False
755 skipinitialspace = True
756 lineterminator = '\r\n'
757 quoting = csv.QUOTE_NONE
758 d = mydialect()
759
760 mydialect.quoting = None
761 self.assertRaises(csv.Error, mydialect)
762
Skip Montanarob4a04172003-03-20 23:29:12 +0000763 mydialect.doublequote = True
764 mydialect.quoting = csv.QUOTE_ALL
765 mydialect.quotechar = '"'
766 d = mydialect()
767
768 mydialect.quotechar = "''"
769 self.assertRaises(csv.Error, mydialect)
770
771 mydialect.quotechar = 4
772 self.assertRaises(csv.Error, mydialect)
773
774 def test_delimiter(self):
775 class mydialect(csv.Dialect):
776 delimiter = ";"
777 escapechar = '\\'
778 doublequote = False
779 skipinitialspace = True
780 lineterminator = '\r\n'
781 quoting = csv.QUOTE_NONE
782 d = mydialect()
783
784 mydialect.delimiter = ":::"
785 self.assertRaises(csv.Error, mydialect)
786
787 mydialect.delimiter = 4
788 self.assertRaises(csv.Error, mydialect)
789
790 def test_lineterminator(self):
791 class mydialect(csv.Dialect):
792 delimiter = ";"
793 escapechar = '\\'
794 doublequote = False
795 skipinitialspace = True
796 lineterminator = '\r\n'
797 quoting = csv.QUOTE_NONE
798 d = mydialect()
799
800 mydialect.lineterminator = ":::"
801 d = mydialect()
802
803 mydialect.lineterminator = 4
804 self.assertRaises(csv.Error, mydialect)
805
806
Skip Montanaro48816c62003-04-25 14:43:14 +0000807class TestSniffer(unittest.TestCase):
808 sample1 = """\
809Harry's, Arlington Heights, IL, 2/1/03, Kimi Hayes
810Shark City, Glendale Heights, IL, 12/28/02, Prezence
811Tommy's Place, Blue Island, IL, 12/28/02, Blue Sunday/White Crow
812Stonecutters Seafood and Chop House, Lemont, IL, 12/19/02, Week Back
813"""
814 sample2 = """\
815'Harry''s':'Arlington Heights':'IL':'2/1/03':'Kimi Hayes'
816'Shark City':'Glendale Heights':'IL':'12/28/02':'Prezence'
817'Tommy''s Place':'Blue Island':'IL':'12/28/02':'Blue Sunday/White Crow'
818'Stonecutters Seafood and Chop House':'Lemont':'IL':'12/19/02':'Week Back'
819"""
820
821 header = '''\
822"venue","city","state","date","performers"
823'''
Skip Montanaro77892372003-05-19 15:33:36 +0000824 sample3 = '''\
82505/05/03?05/05/03?05/05/03?05/05/03?05/05/03?05/05/03
82605/05/03?05/05/03?05/05/03?05/05/03?05/05/03?05/05/03
82705/05/03?05/05/03?05/05/03?05/05/03?05/05/03?05/05/03
828'''
829
Skip Montanaro1546bc42003-06-12 02:40:22 +0000830 sample4 = '''\
8312147483648;43.0e12;17;abc;def
832147483648;43.0e2;17;abc;def
83347483648;43.0;170;abc;def
834'''
835
Skip Montanaro48816c62003-04-25 14:43:14 +0000836 def test_has_header(self):
837 sniffer = csv.Sniffer()
838 self.assertEqual(sniffer.has_header(self.sample1), False)
839 self.assertEqual(sniffer.has_header(self.header+self.sample1), True)
840
841 def test_sniff(self):
842 sniffer = csv.Sniffer()
843 dialect = sniffer.sniff(self.sample1)
844 self.assertEqual(dialect.delimiter, ",")
845 self.assertEqual(dialect.quotechar, '"')
846 self.assertEqual(dialect.skipinitialspace, True)
847
848 dialect = sniffer.sniff(self.sample2)
849 self.assertEqual(dialect.delimiter, ":")
850 self.assertEqual(dialect.quotechar, "'")
851 self.assertEqual(dialect.skipinitialspace, False)
852
Skip Montanaro77892372003-05-19 15:33:36 +0000853 def test_delimiters(self):
854 sniffer = csv.Sniffer()
855 dialect = sniffer.sniff(self.sample3)
856 self.assertEqual(dialect.delimiter, "0")
857 dialect = sniffer.sniff(self.sample3, delimiters="?,")
858 self.assertEqual(dialect.delimiter, "?")
859 dialect = sniffer.sniff(self.sample3, delimiters="/,")
860 self.assertEqual(dialect.delimiter, "/")
Skip Montanaro1546bc42003-06-12 02:40:22 +0000861 dialect = sniffer.sniff(self.sample4)
862 self.assertEqual(dialect.delimiter, ";")
Skip Montanaro77892372003-05-19 15:33:36 +0000863
Skip Montanarob4a04172003-03-20 23:29:12 +0000864if not hasattr(sys, "gettotalrefcount"):
Walter Dörwald21d3a322003-05-01 17:45:56 +0000865 if test_support.verbose: print "*** skipping leakage tests ***"
Skip Montanarob4a04172003-03-20 23:29:12 +0000866else:
867 class NUL:
868 def write(s, *args):
869 pass
870 writelines = write
871
872 class TestLeaks(unittest.TestCase):
873 def test_create_read(self):
874 delta = 0
875 lastrc = sys.gettotalrefcount()
876 for i in xrange(20):
877 gc.collect()
878 self.assertEqual(gc.garbage, [])
879 rc = sys.gettotalrefcount()
880 csv.reader(["a,b,c\r\n"])
881 csv.reader(["a,b,c\r\n"])
882 csv.reader(["a,b,c\r\n"])
883 delta = rc-lastrc
884 lastrc = rc
885 # if csv.reader() leaks, last delta should be 3 or more
886 self.assertEqual(delta < 3, True)
887
888 def test_create_write(self):
889 delta = 0
890 lastrc = sys.gettotalrefcount()
891 s = NUL()
892 for i in xrange(20):
893 gc.collect()
894 self.assertEqual(gc.garbage, [])
895 rc = sys.gettotalrefcount()
896 csv.writer(s)
897 csv.writer(s)
898 csv.writer(s)
899 delta = rc-lastrc
900 lastrc = rc
901 # if csv.writer() leaks, last delta should be 3 or more
902 self.assertEqual(delta < 3, True)
903
904 def test_read(self):
905 delta = 0
906 rows = ["a,b,c\r\n"]*5
907 lastrc = sys.gettotalrefcount()
908 for i in xrange(20):
909 gc.collect()
910 self.assertEqual(gc.garbage, [])
911 rc = sys.gettotalrefcount()
912 rdr = csv.reader(rows)
913 for row in rdr:
914 pass
915 delta = rc-lastrc
916 lastrc = rc
917 # if reader leaks during read, delta should be 5 or more
918 self.assertEqual(delta < 5, True)
919
920 def test_write(self):
921 delta = 0
922 rows = [[1,2,3]]*5
923 s = NUL()
924 lastrc = sys.gettotalrefcount()
925 for i in xrange(20):
926 gc.collect()
927 self.assertEqual(gc.garbage, [])
928 rc = sys.gettotalrefcount()
929 writer = csv.writer(s)
930 for row in rows:
931 writer.writerow(row)
932 delta = rc-lastrc
933 lastrc = rc
934 # if writer leaks during write, last delta should be 5 or more
935 self.assertEqual(delta < 5, True)
936
Skip Montanaro1a566652003-05-06 15:56:05 +0000937# commented out for now - csv module doesn't yet support Unicode
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000938## class TestUnicode(unittest.TestCase):
939## def test_unicode_read(self):
940## import codecs
941## f = codecs.EncodedFile(StringIO("Martin von Löwis,"
942## "Marc André Lemburg,"
943## "Guido van Rossum,"
944## "François Pinard\r\n"),
945## data_encoding='iso-8859-1')
946## reader = csv.reader(f)
947## self.assertEqual(list(reader), [[u"Martin von Löwis",
948## u"Marc André Lemburg",
949## u"Guido van Rossum",
950## u"François Pinardn"]])
Skip Montanaro1a566652003-05-06 15:56:05 +0000951
Walter Dörwald21d3a322003-05-01 17:45:56 +0000952def test_main():
Skip Montanarob4a04172003-03-20 23:29:12 +0000953 mod = sys.modules[__name__]
Walter Dörwald21d3a322003-05-01 17:45:56 +0000954 test_support.run_unittest(
955 *[getattr(mod, name) for name in dir(mod) if name.startswith('Test')]
956 )
Skip Montanarob4a04172003-03-20 23:29:12 +0000957
958if __name__ == '__main__':
Walter Dörwald21d3a322003-05-01 17:45:56 +0000959 test_main()