blob: a92870c24a1b4567fc4b9a19592003652569e212 [file] [log] [blame]
Skip Montanarob4a04172003-03-20 23:29:12 +00001# Copyright (C) 2001,2002 Python Software Foundation
2# csv package unit tests
3
Serhiy Storchakaf81be8a2015-12-25 21:04:29 +02004import copy
Skip Montanarob4a04172003-03-20 23:29:12 +00005import sys
6import unittest
R. David Murray8b7d4aa2009-04-04 01:38:38 +00007from io import StringIO
Guido van Rossum46264582007-08-06 19:32:18 +00008from tempfile import TemporaryFile
Skip Montanaro594adac2003-04-10 17:16:15 +00009import csv
Skip Montanarob4a04172003-03-20 23:29:12 +000010import gc
Serhiy Storchakaf81be8a2015-12-25 21:04:29 +020011import pickle
Benjamin Petersonee8712c2008-05-20 21:35:26 +000012from test import support
Raymond Hettinger43ca4522016-08-30 12:35:50 -070013from itertools import permutations
Raymond Hettinger8ca35702016-08-30 12:57:26 -070014from textwrap import dedent
15from collections import OrderedDict
Skip Montanarob4a04172003-03-20 23:29:12 +000016
Serhiy Storchakac88239f2020-06-22 11:21:59 +030017
18class BadIterable:
19 def __iter__(self):
20 raise OSError
21
22
Skip Montanarob4a04172003-03-20 23:29:12 +000023class Test_Csv(unittest.TestCase):
24 """
Tim Peters0eadaac2003-04-24 16:02:54 +000025 Test the underlying C csv parser in ways that are not appropriate
Skip Montanarob4a04172003-03-20 23:29:12 +000026 from the high level interface. Further tests of this nature are done
27 in TestDialectRegistry.
28 """
Andrew McNamara1196cf12005-01-07 04:42:45 +000029 def _test_arg_valid(self, ctor, arg):
30 self.assertRaises(TypeError, ctor)
31 self.assertRaises(TypeError, ctor, None)
32 self.assertRaises(TypeError, ctor, arg, bad_attr = 0)
33 self.assertRaises(TypeError, ctor, arg, delimiter = 0)
34 self.assertRaises(TypeError, ctor, arg, delimiter = 'XX')
35 self.assertRaises(csv.Error, ctor, arg, 'foo')
Andrew McNamara1196cf12005-01-07 04:42:45 +000036 self.assertRaises(TypeError, ctor, arg, delimiter=None)
37 self.assertRaises(TypeError, ctor, arg, delimiter=1)
38 self.assertRaises(TypeError, ctor, arg, quotechar=1)
39 self.assertRaises(TypeError, ctor, arg, lineterminator=None)
40 self.assertRaises(TypeError, ctor, arg, lineterminator=1)
41 self.assertRaises(TypeError, ctor, arg, quoting=None)
Tim Peters608c2ff2005-01-13 17:37:38 +000042 self.assertRaises(TypeError, ctor, arg,
Andrew McNamaraaf1e3122005-01-12 01:55:21 +000043 quoting=csv.QUOTE_ALL, quotechar='')
Tim Peters608c2ff2005-01-13 17:37:38 +000044 self.assertRaises(TypeError, ctor, arg,
Andrew McNamara5d45a8d2005-01-12 08:16:17 +000045 quoting=csv.QUOTE_ALL, quotechar=None)
Andrew McNamara1196cf12005-01-07 04:42:45 +000046
47 def test_reader_arg_valid(self):
48 self._test_arg_valid(csv.reader, [])
Serhiy Storchakac88239f2020-06-22 11:21:59 +030049 self.assertRaises(OSError, csv.reader, BadIterable())
Skip Montanarob4a04172003-03-20 23:29:12 +000050
51 def test_writer_arg_valid(self):
Andrew McNamara1196cf12005-01-07 04:42:45 +000052 self._test_arg_valid(csv.writer, StringIO())
Serhiy Storchakac88239f2020-06-22 11:21:59 +030053 class BadWriter:
54 @property
55 def write(self):
56 raise OSError
57 self.assertRaises(OSError, csv.writer, BadWriter())
Skip Montanarob4a04172003-03-20 23:29:12 +000058
Andrew McNamara1196cf12005-01-07 04:42:45 +000059 def _test_default_attrs(self, ctor, *args):
60 obj = ctor(*args)
61 # Check defaults
Skip Montanarob4a04172003-03-20 23:29:12 +000062 self.assertEqual(obj.dialect.delimiter, ',')
Serhiy Storchaka323748a2018-07-26 13:21:09 +030063 self.assertIs(obj.dialect.doublequote, True)
Skip Montanarob4a04172003-03-20 23:29:12 +000064 self.assertEqual(obj.dialect.escapechar, None)
Andrew McNamara1196cf12005-01-07 04:42:45 +000065 self.assertEqual(obj.dialect.lineterminator, "\r\n")
66 self.assertEqual(obj.dialect.quotechar, '"')
67 self.assertEqual(obj.dialect.quoting, csv.QUOTE_MINIMAL)
Serhiy Storchaka323748a2018-07-26 13:21:09 +030068 self.assertIs(obj.dialect.skipinitialspace, False)
69 self.assertIs(obj.dialect.strict, False)
Andrew McNamara1196cf12005-01-07 04:42:45 +000070 # Try deleting or changing attributes (they are read-only)
Collin Winter42dae6a2007-03-28 21:44:53 +000071 self.assertRaises(AttributeError, delattr, obj.dialect, 'delimiter')
72 self.assertRaises(AttributeError, setattr, obj.dialect, 'delimiter', ':')
Barry Warsawb180c062005-04-20 19:41:36 +000073 self.assertRaises(AttributeError, delattr, obj.dialect, 'quoting')
74 self.assertRaises(AttributeError, setattr, obj.dialect,
75 'quoting', None)
Skip Montanarob4a04172003-03-20 23:29:12 +000076
77 def test_reader_attrs(self):
Andrew McNamara1196cf12005-01-07 04:42:45 +000078 self._test_default_attrs(csv.reader, [])
Skip Montanarob4a04172003-03-20 23:29:12 +000079
80 def test_writer_attrs(self):
Andrew McNamara1196cf12005-01-07 04:42:45 +000081 self._test_default_attrs(csv.writer, StringIO())
82
83 def _test_kw_attrs(self, ctor, *args):
84 # Now try with alternate options
85 kwargs = dict(delimiter=':', doublequote=False, escapechar='\\',
86 lineterminator='\r', quotechar='*',
87 quoting=csv.QUOTE_NONE, skipinitialspace=True,
88 strict=True)
89 obj = ctor(*args, **kwargs)
90 self.assertEqual(obj.dialect.delimiter, ':')
Serhiy Storchaka323748a2018-07-26 13:21:09 +030091 self.assertIs(obj.dialect.doublequote, False)
Andrew McNamara1196cf12005-01-07 04:42:45 +000092 self.assertEqual(obj.dialect.escapechar, '\\')
93 self.assertEqual(obj.dialect.lineterminator, "\r")
94 self.assertEqual(obj.dialect.quotechar, '*')
95 self.assertEqual(obj.dialect.quoting, csv.QUOTE_NONE)
Serhiy Storchaka323748a2018-07-26 13:21:09 +030096 self.assertIs(obj.dialect.skipinitialspace, True)
97 self.assertIs(obj.dialect.strict, True)
Andrew McNamara1196cf12005-01-07 04:42:45 +000098
99 def test_reader_kw_attrs(self):
100 self._test_kw_attrs(csv.reader, [])
101
102 def test_writer_kw_attrs(self):
103 self._test_kw_attrs(csv.writer, StringIO())
104
105 def _test_dialect_attrs(self, ctor, *args):
106 # Now try with dialect-derived options
107 class dialect:
108 delimiter='-'
109 doublequote=False
110 escapechar='^'
111 lineterminator='$'
112 quotechar='#'
113 quoting=csv.QUOTE_ALL
114 skipinitialspace=True
115 strict=False
116 args = args + (dialect,)
117 obj = ctor(*args)
118 self.assertEqual(obj.dialect.delimiter, '-')
Serhiy Storchaka323748a2018-07-26 13:21:09 +0300119 self.assertIs(obj.dialect.doublequote, False)
Andrew McNamara1196cf12005-01-07 04:42:45 +0000120 self.assertEqual(obj.dialect.escapechar, '^')
121 self.assertEqual(obj.dialect.lineterminator, "$")
122 self.assertEqual(obj.dialect.quotechar, '#')
123 self.assertEqual(obj.dialect.quoting, csv.QUOTE_ALL)
Serhiy Storchaka323748a2018-07-26 13:21:09 +0300124 self.assertIs(obj.dialect.skipinitialspace, True)
125 self.assertIs(obj.dialect.strict, False)
Andrew McNamara1196cf12005-01-07 04:42:45 +0000126
127 def test_reader_dialect_attrs(self):
128 self._test_dialect_attrs(csv.reader, [])
129
130 def test_writer_dialect_attrs(self):
131 self._test_dialect_attrs(csv.writer, StringIO())
132
Skip Montanarob4a04172003-03-20 23:29:12 +0000133
134 def _write_test(self, fields, expect, **kwargs):
Guido van Rossumf0c74162007-08-28 03:29:45 +0000135 with TemporaryFile("w+", newline='') as fileobj:
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000136 writer = csv.writer(fileobj, **kwargs)
137 writer.writerow(fields)
138 fileobj.seek(0)
Guido van Rossumf0c74162007-08-28 03:29:45 +0000139 self.assertEqual(fileobj.read(),
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000140 expect + writer.dialect.lineterminator)
Skip Montanarob4a04172003-03-20 23:29:12 +0000141
Serhiy Storchaka0b4e3552015-03-25 19:16:15 +0200142 def _write_error_test(self, exc, fields, **kwargs):
143 with TemporaryFile("w+", newline='') as fileobj:
144 writer = csv.writer(fileobj, **kwargs)
145 with self.assertRaises(exc):
146 writer.writerow(fields)
147 fileobj.seek(0)
148 self.assertEqual(fileobj.read(), '')
149
Skip Montanarob4a04172003-03-20 23:29:12 +0000150 def test_write_arg_valid(self):
Serhiy Storchaka0b4e3552015-03-25 19:16:15 +0200151 self._write_error_test(csv.Error, None)
Skip Montanarob4a04172003-03-20 23:29:12 +0000152 self._write_test((), '')
153 self._write_test([None], '""')
Serhiy Storchaka0b4e3552015-03-25 19:16:15 +0200154 self._write_error_test(csv.Error, [None], quoting = csv.QUOTE_NONE)
Skip Montanarob4a04172003-03-20 23:29:12 +0000155 # Check that exceptions are passed up the chain
Serhiy Storchakac88239f2020-06-22 11:21:59 +0300156 self._write_error_test(OSError, BadIterable())
Skip Montanarob4a04172003-03-20 23:29:12 +0000157 class BadList:
158 def __len__(self):
159 return 10;
160 def __getitem__(self, i):
161 if i > 2:
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200162 raise OSError
Serhiy Storchaka0b4e3552015-03-25 19:16:15 +0200163 self._write_error_test(OSError, BadList())
Skip Montanarob4a04172003-03-20 23:29:12 +0000164 class BadItem:
165 def __str__(self):
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200166 raise OSError
Serhiy Storchaka0b4e3552015-03-25 19:16:15 +0200167 self._write_error_test(OSError, [BadItem()])
Skip Montanarob4a04172003-03-20 23:29:12 +0000168
169 def test_write_bigfield(self):
170 # This exercises the buffer realloc functionality
171 bigstring = 'X' * 50000
172 self._write_test([bigstring,bigstring], '%s,%s' % \
173 (bigstring, bigstring))
174
175 def test_write_quoting(self):
Andrew McNamarac89f2842005-01-12 07:44:42 +0000176 self._write_test(['a',1,'p,q'], 'a,1,"p,q"')
Serhiy Storchaka0b4e3552015-03-25 19:16:15 +0200177 self._write_error_test(csv.Error, ['a',1,'p,q'],
178 quoting = csv.QUOTE_NONE)
Andrew McNamarac89f2842005-01-12 07:44:42 +0000179 self._write_test(['a',1,'p,q'], 'a,1,"p,q"',
Skip Montanarob4a04172003-03-20 23:29:12 +0000180 quoting = csv.QUOTE_MINIMAL)
Andrew McNamarac89f2842005-01-12 07:44:42 +0000181 self._write_test(['a',1,'p,q'], '"a",1,"p,q"',
Skip Montanarob4a04172003-03-20 23:29:12 +0000182 quoting = csv.QUOTE_NONNUMERIC)
Andrew McNamarac89f2842005-01-12 07:44:42 +0000183 self._write_test(['a',1,'p,q'], '"a","1","p,q"',
Skip Montanarob4a04172003-03-20 23:29:12 +0000184 quoting = csv.QUOTE_ALL)
R. David Murraycde68cf2009-04-01 22:37:58 +0000185 self._write_test(['a\nb',1], '"a\nb","1"',
186 quoting = csv.QUOTE_ALL)
Skip Montanarob4a04172003-03-20 23:29:12 +0000187
188 def test_write_escape(self):
Andrew McNamarac89f2842005-01-12 07:44:42 +0000189 self._write_test(['a',1,'p,q'], 'a,1,"p,q"',
Skip Montanarob4a04172003-03-20 23:29:12 +0000190 escapechar='\\')
Serhiy Storchaka0b4e3552015-03-25 19:16:15 +0200191 self._write_error_test(csv.Error, ['a',1,'p,"q"'],
192 escapechar=None, doublequote=False)
Andrew McNamarac89f2842005-01-12 07:44:42 +0000193 self._write_test(['a',1,'p,"q"'], 'a,1,"p,\\"q\\""',
194 escapechar='\\', doublequote = False)
Tim Peters608c2ff2005-01-13 17:37:38 +0000195 self._write_test(['"'], '""""',
Andrew McNamarac89f2842005-01-12 07:44:42 +0000196 escapechar='\\', quoting = csv.QUOTE_MINIMAL)
Tim Peters608c2ff2005-01-13 17:37:38 +0000197 self._write_test(['"'], '\\"',
Andrew McNamarac89f2842005-01-12 07:44:42 +0000198 escapechar='\\', quoting = csv.QUOTE_MINIMAL,
199 doublequote = False)
Tim Peters608c2ff2005-01-13 17:37:38 +0000200 self._write_test(['"'], '\\"',
Andrew McNamarac89f2842005-01-12 07:44:42 +0000201 escapechar='\\', quoting = csv.QUOTE_NONE)
202 self._write_test(['a',1,'p,q'], 'a,1,p\\,q',
Skip Montanarob4a04172003-03-20 23:29:12 +0000203 escapechar='\\', quoting = csv.QUOTE_NONE)
204
Serhiy Storchaka7901b482015-03-30 09:09:54 +0300205 def test_write_iterable(self):
206 self._write_test(iter(['a', 1, 'p,q']), 'a,1,"p,q"')
207 self._write_test(iter(['a', 1, None]), 'a,1,')
208 self._write_test(iter([]), '')
209 self._write_test(iter([None]), '""')
210 self._write_error_test(csv.Error, iter([None]), quoting=csv.QUOTE_NONE)
211 self._write_test(iter([None, None]), ',')
212
Skip Montanarob4a04172003-03-20 23:29:12 +0000213 def test_writerows(self):
214 class BrokenFile:
215 def write(self, buf):
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200216 raise OSError
Skip Montanarob4a04172003-03-20 23:29:12 +0000217 writer = csv.writer(BrokenFile())
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200218 self.assertRaises(OSError, writer.writerows, [['a']])
Guido van Rossum46264582007-08-06 19:32:18 +0000219
Guido van Rossumf0c74162007-08-28 03:29:45 +0000220 with TemporaryFile("w+", newline='') as fileobj:
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000221 writer = csv.writer(fileobj)
222 self.assertRaises(TypeError, writer.writerows, None)
Licht Takeuchi20019002017-12-12 18:57:06 +0900223 writer.writerows([['a', 'b'], ['c', 'd']])
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000224 fileobj.seek(0)
Guido van Rossumf0c74162007-08-28 03:29:45 +0000225 self.assertEqual(fileobj.read(), "a,b\r\nc,d\r\n")
Tim Peters27f88362004-07-08 04:22:35 +0000226
Licht Takeuchi20019002017-12-12 18:57:06 +0900227 def test_writerows_with_none(self):
228 with TemporaryFile("w+", newline='') as fileobj:
229 writer = csv.writer(fileobj)
230 writer.writerows([['a', None], [None, 'd']])
231 fileobj.seek(0)
232 self.assertEqual(fileobj.read(), "a,\r\n,d\r\n")
233
234 with TemporaryFile("w+", newline='') as fileobj:
235 writer = csv.writer(fileobj)
236 writer.writerows([[None], ['a']])
237 fileobj.seek(0)
238 self.assertEqual(fileobj.read(), '""\r\na\r\n')
239
240 with TemporaryFile("w+", newline='') as fileobj:
241 writer = csv.writer(fileobj)
242 writer.writerows([['a'], [None]])
243 fileobj.seek(0)
244 self.assertEqual(fileobj.read(), 'a\r\n""\r\n')
245
Serhiy Storchakac88239f2020-06-22 11:21:59 +0300246 def test_writerows_errors(self):
247 with TemporaryFile("w+", newline='') as fileobj:
248 writer = csv.writer(fileobj)
249 self.assertRaises(TypeError, writer.writerows, None)
250 self.assertRaises(OSError, writer.writerows, BadIterable())
251
Stefan Krahe6996ed2012-11-02 14:44:20 +0100252 @support.cpython_only
Serhiy Storchaka4c8f09d2020-07-10 23:26:06 +0300253 @support.requires_legacy_unicode_capi
Stefan Krahe6996ed2012-11-02 14:44:20 +0100254 def test_writerows_legacy_strings(self):
255 import _testcapi
Stefan Krahe6996ed2012-11-02 14:44:20 +0100256 c = _testcapi.unicode_legacy_string('a')
257 with TemporaryFile("w+", newline='') as fileobj:
258 writer = csv.writer(fileobj)
259 writer.writerows([[c]])
260 fileobj.seek(0)
261 self.assertEqual(fileobj.read(), "a\r\n")
262
Skip Montanarob4a04172003-03-20 23:29:12 +0000263 def _read_test(self, input, expect, **kwargs):
264 reader = csv.reader(input, **kwargs)
265 result = list(reader)
266 self.assertEqual(result, expect)
267
268 def test_read_oddinputs(self):
269 self._read_test([], [])
270 self._read_test([''], [[]])
271 self.assertRaises(csv.Error, self._read_test,
272 ['"ab"c'], None, strict = 1)
273 # cannot handle null bytes for the moment
274 self.assertRaises(csv.Error, self._read_test,
275 ['ab\0c'], None, strict = 1)
276 self._read_test(['"ab"c'], [['abc']], doublequote = 0)
277
Amaury Forgeot d'Arc10c476d2007-11-19 21:20:21 +0000278 self.assertRaises(csv.Error, self._read_test,
279 [b'ab\0c'], None)
280
281
Skip Montanarob4a04172003-03-20 23:29:12 +0000282 def test_read_eol(self):
283 self._read_test(['a,b'], [['a','b']])
284 self._read_test(['a,b\n'], [['a','b']])
285 self._read_test(['a,b\r\n'], [['a','b']])
286 self._read_test(['a,b\r'], [['a','b']])
287 self.assertRaises(csv.Error, self._read_test, ['a,b\rc,d'], [])
288 self.assertRaises(csv.Error, self._read_test, ['a,b\nc,d'], [])
289 self.assertRaises(csv.Error, self._read_test, ['a,b\r\nc,d'], [])
290
Senthil Kumaran67b7b982012-09-25 02:30:27 -0700291 def test_read_eof(self):
292 self._read_test(['a,"'], [['a', '']])
293 self._read_test(['"a'], [['a']])
294 self._read_test(['^'], [['\n']], escapechar='^')
295 self.assertRaises(csv.Error, self._read_test, ['a,"'], [], strict=True)
296 self.assertRaises(csv.Error, self._read_test, ['"a'], [], strict=True)
297 self.assertRaises(csv.Error, self._read_test,
298 ['^'], [], escapechar='^', strict=True)
299
Skip Montanarob4a04172003-03-20 23:29:12 +0000300 def test_read_escape(self):
Andrew McNamara36a76912005-01-10 01:04:40 +0000301 self._read_test(['a,\\b,c'], [['a', 'b', 'c']], escapechar='\\')
Skip Montanarob4a04172003-03-20 23:29:12 +0000302 self._read_test(['a,b\\,c'], [['a', 'b,c']], escapechar='\\')
303 self._read_test(['a,"b\\,c"'], [['a', 'b,c']], escapechar='\\')
Andrew McNamara36a76912005-01-10 01:04:40 +0000304 self._read_test(['a,"b,\\c"'], [['a', 'b,c']], escapechar='\\')
Skip Montanarob4a04172003-03-20 23:29:12 +0000305 self._read_test(['a,"b,c\\""'], [['a', 'b,c"']], escapechar='\\')
306 self._read_test(['a,"b,c"\\'], [['a', 'b,c\\']], escapechar='\\')
307
Andrew McNamara1196cf12005-01-07 04:42:45 +0000308 def test_read_quoting(self):
309 self._read_test(['1,",3,",5'], [['1', ',3,', '5']])
310 self._read_test(['1,",3,",5'], [['1', '"', '3', '"', '5']],
311 quotechar=None, escapechar='\\')
312 self._read_test(['1,",3,",5'], [['1', '"', '3', '"', '5']],
313 quoting=csv.QUOTE_NONE, escapechar='\\')
Andrew McNamara0f0599d2005-01-12 09:45:18 +0000314 # will this fail where locale uses comma for decimals?
Andrew McNamara7f2053e2005-01-12 11:17:16 +0000315 self._read_test([',3,"5",7.3, 9'], [['', 3, '5', 7.3, 9]],
Andrew McNamara0f0599d2005-01-12 09:45:18 +0000316 quoting=csv.QUOTE_NONNUMERIC)
R. David Murraycde68cf2009-04-01 22:37:58 +0000317 self._read_test(['"a\nb", 7'], [['a\nb', ' 7']])
Tim Peters608c2ff2005-01-13 17:37:38 +0000318 self.assertRaises(ValueError, self._read_test,
Andrew McNamara0f0599d2005-01-12 09:45:18 +0000319 ['abc,3'], [[]],
320 quoting=csv.QUOTE_NONNUMERIC)
Andrew McNamara1196cf12005-01-07 04:42:45 +0000321
Skip Montanarob4a04172003-03-20 23:29:12 +0000322 def test_read_bigfield(self):
Andrew McNamarae4d05c42005-01-11 07:32:02 +0000323 # This exercises the buffer realloc functionality and field size
324 # limits.
Andrew McNamara31d88962005-01-12 03:45:10 +0000325 limit = csv.field_size_limit()
Andrew McNamaraaf1e3122005-01-12 01:55:21 +0000326 try:
327 size = 50000
328 bigstring = 'X' * size
329 bigline = '%s,%s' % (bigstring, bigstring)
330 self._read_test([bigline], [[bigstring, bigstring]])
Andrew McNamara31d88962005-01-12 03:45:10 +0000331 csv.field_size_limit(size)
Andrew McNamaraaf1e3122005-01-12 01:55:21 +0000332 self._read_test([bigline], [[bigstring, bigstring]])
Andrew McNamara31d88962005-01-12 03:45:10 +0000333 self.assertEqual(csv.field_size_limit(), size)
334 csv.field_size_limit(size-1)
Andrew McNamaraaf1e3122005-01-12 01:55:21 +0000335 self.assertRaises(csv.Error, self._read_test, [bigline], [])
Andrew McNamara31d88962005-01-12 03:45:10 +0000336 self.assertRaises(TypeError, csv.field_size_limit, None)
337 self.assertRaises(TypeError, csv.field_size_limit, 1, None)
Andrew McNamaraaf1e3122005-01-12 01:55:21 +0000338 finally:
Andrew McNamara31d88962005-01-12 03:45:10 +0000339 csv.field_size_limit(limit)
Skip Montanarob4a04172003-03-20 23:29:12 +0000340
Andrew McNamara7f2053e2005-01-12 11:17:16 +0000341 def test_read_linenum(self):
342 r = csv.reader(['line,1', 'line,2', 'line,3'])
343 self.assertEqual(r.line_num, 0)
Georg Brandla18af4e2007-04-21 15:47:16 +0000344 next(r)
Andrew McNamara7f2053e2005-01-12 11:17:16 +0000345 self.assertEqual(r.line_num, 1)
Georg Brandla18af4e2007-04-21 15:47:16 +0000346 next(r)
Andrew McNamara7f2053e2005-01-12 11:17:16 +0000347 self.assertEqual(r.line_num, 2)
Georg Brandla18af4e2007-04-21 15:47:16 +0000348 next(r)
Andrew McNamara7f2053e2005-01-12 11:17:16 +0000349 self.assertEqual(r.line_num, 3)
Georg Brandla18af4e2007-04-21 15:47:16 +0000350 self.assertRaises(StopIteration, next, r)
Andrew McNamara7f2053e2005-01-12 11:17:16 +0000351 self.assertEqual(r.line_num, 3)
352
R. David Murraycde68cf2009-04-01 22:37:58 +0000353 def test_roundtrip_quoteed_newlines(self):
354 with TemporaryFile("w+", newline='') as fileobj:
355 writer = csv.writer(fileobj)
R. David Murraycde68cf2009-04-01 22:37:58 +0000356 rows = [['a\nb','b'],['c','x\r\nd']]
357 writer.writerows(rows)
358 fileobj.seek(0)
359 for i, row in enumerate(csv.reader(fileobj)):
360 self.assertEqual(row, rows[i])
361
R David Murrayc7c42ef2013-03-19 22:41:47 -0400362 def test_roundtrip_escaped_unquoted_newlines(self):
363 with TemporaryFile("w+", newline='') as fileobj:
364 writer = csv.writer(fileobj,quoting=csv.QUOTE_NONE,escapechar="\\")
365 rows = [['a\nb','b'],['c','x\r\nd']]
366 writer.writerows(rows)
367 fileobj.seek(0)
368 for i, row in enumerate(csv.reader(fileobj,quoting=csv.QUOTE_NONE,escapechar="\\")):
369 self.assertEqual(row,rows[i])
370
Skip Montanarob4a04172003-03-20 23:29:12 +0000371class TestDialectRegistry(unittest.TestCase):
372 def test_registry_badargs(self):
373 self.assertRaises(TypeError, csv.list_dialects, None)
374 self.assertRaises(TypeError, csv.get_dialect)
375 self.assertRaises(csv.Error, csv.get_dialect, None)
376 self.assertRaises(csv.Error, csv.get_dialect, "nonesuch")
377 self.assertRaises(TypeError, csv.unregister_dialect)
378 self.assertRaises(csv.Error, csv.unregister_dialect, None)
379 self.assertRaises(csv.Error, csv.unregister_dialect, "nonesuch")
380 self.assertRaises(TypeError, csv.register_dialect, None)
381 self.assertRaises(TypeError, csv.register_dialect, None, None)
Andrew McNamaraaf1e3122005-01-12 01:55:21 +0000382 self.assertRaises(TypeError, csv.register_dialect, "nonesuch", 0, 0)
383 self.assertRaises(TypeError, csv.register_dialect, "nonesuch",
384 badargument=None)
385 self.assertRaises(TypeError, csv.register_dialect, "nonesuch",
386 quoting=None)
387 self.assertRaises(TypeError, csv.register_dialect, [])
Skip Montanarob4a04172003-03-20 23:29:12 +0000388
389 def test_registry(self):
390 class myexceltsv(csv.excel):
391 delimiter = "\t"
392 name = "myexceltsv"
393 expected_dialects = csv.list_dialects() + [name]
394 expected_dialects.sort()
395 csv.register_dialect(name, myexceltsv)
Éric Araujo5137d642010-12-02 22:16:19 +0000396 self.addCleanup(csv.unregister_dialect, name)
397 self.assertEqual(csv.get_dialect(name).delimiter, '\t')
398 got_dialects = sorted(csv.list_dialects())
399 self.assertEqual(expected_dialects, got_dialects)
Skip Montanarob4a04172003-03-20 23:29:12 +0000400
Andrew McNamara86625972005-01-11 01:28:33 +0000401 def test_register_kwargs(self):
402 name = 'fedcba'
403 csv.register_dialect(name, delimiter=';')
Éric Araujo5137d642010-12-02 22:16:19 +0000404 self.addCleanup(csv.unregister_dialect, name)
405 self.assertEqual(csv.get_dialect(name).delimiter, ';')
406 self.assertEqual([['X', 'Y', 'Z']], list(csv.reader(['X;Y;Z'], name)))
Andrew McNamara86625972005-01-11 01:28:33 +0000407
Skip Montanarob4a04172003-03-20 23:29:12 +0000408 def test_incomplete_dialect(self):
409 class myexceltsv(csv.Dialect):
410 delimiter = "\t"
411 self.assertRaises(csv.Error, myexceltsv)
412
413 def test_space_dialect(self):
414 class space(csv.excel):
415 delimiter = " "
416 quoting = csv.QUOTE_NONE
417 escapechar = "\\"
418
Guido van Rossum46264582007-08-06 19:32:18 +0000419 with TemporaryFile("w+") as fileobj:
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000420 fileobj.write("abc def\nc1ccccc1 benzene\n")
421 fileobj.seek(0)
Georg Brandla18af4e2007-04-21 15:47:16 +0000422 reader = csv.reader(fileobj, dialect=space())
423 self.assertEqual(next(reader), ["abc", "def"])
424 self.assertEqual(next(reader), ["c1ccccc1", "benzene"])
Guido van Rossum46264582007-08-06 19:32:18 +0000425
426 def compare_dialect_123(self, expected, *writeargs, **kwwriteargs):
Guido van Rossumf0c74162007-08-28 03:29:45 +0000427
428 with TemporaryFile("w+", newline='', encoding="utf-8") as fileobj:
429
Guido van Rossum46264582007-08-06 19:32:18 +0000430 writer = csv.writer(fileobj, *writeargs, **kwwriteargs)
431 writer.writerow([1,2,3])
432 fileobj.seek(0)
Guido van Rossumf0c74162007-08-28 03:29:45 +0000433 self.assertEqual(fileobj.read(), expected)
Tim Peters27f88362004-07-08 04:22:35 +0000434
Skip Montanarob4a04172003-03-20 23:29:12 +0000435 def test_dialect_apply(self):
436 class testA(csv.excel):
437 delimiter = "\t"
438 class testB(csv.excel):
439 delimiter = ":"
440 class testC(csv.excel):
441 delimiter = "|"
Guido van Rossum46264582007-08-06 19:32:18 +0000442 class testUni(csv.excel):
443 delimiter = "\u039B"
Skip Montanarob4a04172003-03-20 23:29:12 +0000444
445 csv.register_dialect('testC', testC)
446 try:
Guido van Rossum46264582007-08-06 19:32:18 +0000447 self.compare_dialect_123("1,2,3\r\n")
448 self.compare_dialect_123("1\t2\t3\r\n", testA)
449 self.compare_dialect_123("1:2:3\r\n", dialect=testB())
450 self.compare_dialect_123("1|2|3\r\n", dialect='testC')
451 self.compare_dialect_123("1;2;3\r\n", dialect=testA,
452 delimiter=';')
453 self.compare_dialect_123("1\u039B2\u039B3\r\n",
454 dialect=testUni)
Skip Montanarob4a04172003-03-20 23:29:12 +0000455
Skip Montanarob4a04172003-03-20 23:29:12 +0000456 finally:
457 csv.unregister_dialect('testC')
458
459 def test_bad_dialect(self):
460 # Unknown parameter
Andrew McNamara1196cf12005-01-07 04:42:45 +0000461 self.assertRaises(TypeError, csv.reader, [], bad_attr = 0)
Skip Montanarob4a04172003-03-20 23:29:12 +0000462 # Bad values
463 self.assertRaises(TypeError, csv.reader, [], delimiter = None)
464 self.assertRaises(TypeError, csv.reader, [], quoting = -1)
465 self.assertRaises(TypeError, csv.reader, [], quoting = 100)
466
Serhiy Storchakaf81be8a2015-12-25 21:04:29 +0200467 def test_copy(self):
468 for name in csv.list_dialects():
469 dialect = csv.get_dialect(name)
470 self.assertRaises(TypeError, copy.copy, dialect)
471
472 def test_pickle(self):
473 for name in csv.list_dialects():
474 dialect = csv.get_dialect(name)
475 for proto in range(pickle.HIGHEST_PROTOCOL + 1):
476 self.assertRaises(TypeError, pickle.dumps, dialect, proto)
477
Skip Montanarob4a04172003-03-20 23:29:12 +0000478class TestCsvBase(unittest.TestCase):
479 def readerAssertEqual(self, input, expected_result):
Amaury Forgeot d'Arc10c476d2007-11-19 21:20:21 +0000480 with TemporaryFile("w+", newline='') as fileobj:
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000481 fileobj.write(input)
482 fileobj.seek(0)
483 reader = csv.reader(fileobj, dialect = self.dialect)
484 fields = list(reader)
485 self.assertEqual(fields, expected_result)
Skip Montanarob4a04172003-03-20 23:29:12 +0000486
487 def writerAssertEqual(self, input, expected_result):
Guido van Rossumf0c74162007-08-28 03:29:45 +0000488 with TemporaryFile("w+", newline='') as fileobj:
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000489 writer = csv.writer(fileobj, dialect = self.dialect)
490 writer.writerows(input)
491 fileobj.seek(0)
Guido van Rossumf0c74162007-08-28 03:29:45 +0000492 self.assertEqual(fileobj.read(), expected_result)
Skip Montanarob4a04172003-03-20 23:29:12 +0000493
494class TestDialectExcel(TestCsvBase):
495 dialect = 'excel'
496
497 def test_single(self):
498 self.readerAssertEqual('abc', [['abc']])
499
500 def test_simple(self):
501 self.readerAssertEqual('1,2,3,4,5', [['1','2','3','4','5']])
502
503 def test_blankline(self):
504 self.readerAssertEqual('', [])
505
506 def test_empty_fields(self):
507 self.readerAssertEqual(',', [['', '']])
508
509 def test_singlequoted(self):
510 self.readerAssertEqual('""', [['']])
511
512 def test_singlequoted_left_empty(self):
513 self.readerAssertEqual('"",', [['','']])
514
515 def test_singlequoted_right_empty(self):
516 self.readerAssertEqual(',""', [['','']])
517
518 def test_single_quoted_quote(self):
519 self.readerAssertEqual('""""', [['"']])
520
521 def test_quoted_quotes(self):
522 self.readerAssertEqual('""""""', [['""']])
523
524 def test_inline_quote(self):
525 self.readerAssertEqual('a""b', [['a""b']])
526
527 def test_inline_quotes(self):
528 self.readerAssertEqual('a"b"c', [['a"b"c']])
529
530 def test_quotes_and_more(self):
Guido van Rossumd8faa362007-04-27 19:54:29 +0000531 # Excel would never write a field containing '"a"b', but when
532 # reading one, it will return 'ab'.
Skip Montanarob4a04172003-03-20 23:29:12 +0000533 self.readerAssertEqual('"a"b', [['ab']])
534
535 def test_lone_quote(self):
536 self.readerAssertEqual('a"b', [['a"b']])
537
538 def test_quote_and_quote(self):
Guido van Rossumd8faa362007-04-27 19:54:29 +0000539 # Excel would never write a field containing '"a" "b"', but when
540 # reading one, it will return 'a "b"'.
Skip Montanarob4a04172003-03-20 23:29:12 +0000541 self.readerAssertEqual('"a" "b"', [['a "b"']])
542
543 def test_space_and_quote(self):
544 self.readerAssertEqual(' "a"', [[' "a"']])
545
546 def test_quoted(self):
Tim Peters0eadaac2003-04-24 16:02:54 +0000547 self.readerAssertEqual('1,2,3,"I think, therefore I am",5,6',
548 [['1', '2', '3',
549 'I think, therefore I am',
Skip Montanarob4a04172003-03-20 23:29:12 +0000550 '5', '6']])
551
552 def test_quoted_quote(self):
553 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 +0000554 [['1', '2', '3',
555 '"I see," said the blind man',
Skip Montanarob4a04172003-03-20 23:29:12 +0000556 'as he picked up his hammer and saw']])
557
558 def test_quoted_nl(self):
559 input = '''\
5601,2,3,"""I see,""
561said the blind man","as he picked up his
562hammer and saw"
5639,8,7,6'''
564 self.readerAssertEqual(input,
Tim Peters0eadaac2003-04-24 16:02:54 +0000565 [['1', '2', '3',
566 '"I see,"\nsaid the blind man',
Skip Montanarob4a04172003-03-20 23:29:12 +0000567 'as he picked up his\nhammer and saw'],
568 ['9','8','7','6']])
569
570 def test_dubious_quote(self):
571 self.readerAssertEqual('12,12,1",', [['12', '12', '1"', '']])
572
573 def test_null(self):
574 self.writerAssertEqual([], '')
575
Georg Brandl89fad142010-03-14 10:23:39 +0000576 def test_single_writer(self):
Skip Montanarob4a04172003-03-20 23:29:12 +0000577 self.writerAssertEqual([['abc']], 'abc\r\n')
578
Georg Brandl89fad142010-03-14 10:23:39 +0000579 def test_simple_writer(self):
Skip Montanarob4a04172003-03-20 23:29:12 +0000580 self.writerAssertEqual([[1, 2, 'abc', 3, 4]], '1,2,abc,3,4\r\n')
581
582 def test_quotes(self):
583 self.writerAssertEqual([[1, 2, 'a"bc"', 3, 4]], '1,2,"a""bc""",3,4\r\n')
584
585 def test_quote_fieldsep(self):
586 self.writerAssertEqual([['abc,def']], '"abc,def"\r\n')
587
588 def test_newlines(self):
589 self.writerAssertEqual([[1, 2, 'a\nbc', 3, 4]], '1,2,"a\nbc",3,4\r\n')
590
591class EscapedExcel(csv.excel):
592 quoting = csv.QUOTE_NONE
593 escapechar = '\\'
594
595class TestEscapedExcel(TestCsvBase):
596 dialect = EscapedExcel()
597
598 def test_escape_fieldsep(self):
599 self.writerAssertEqual([['abc,def']], 'abc\\,def\r\n')
600
601 def test_read_escape_fieldsep(self):
602 self.readerAssertEqual('abc\\,def\r\n', [['abc,def']])
603
Georg Brandl7424dd32010-10-27 07:27:06 +0000604class TestDialectUnix(TestCsvBase):
605 dialect = 'unix'
606
607 def test_simple_writer(self):
608 self.writerAssertEqual([[1, 'abc def', 'abc']], '"1","abc def","abc"\n')
609
610 def test_simple_reader(self):
611 self.readerAssertEqual('"1","abc def","abc"\n', [['1', 'abc def', 'abc']])
612
Skip Montanarob4a04172003-03-20 23:29:12 +0000613class QuotedEscapedExcel(csv.excel):
614 quoting = csv.QUOTE_NONNUMERIC
615 escapechar = '\\'
616
617class TestQuotedEscapedExcel(TestCsvBase):
618 dialect = QuotedEscapedExcel()
619
620 def test_write_escape_fieldsep(self):
621 self.writerAssertEqual([['abc,def']], '"abc,def"\r\n')
622
623 def test_read_escape_fieldsep(self):
624 self.readerAssertEqual('"abc\\,def"\r\n', [['abc,def']])
625
Skip Montanarob4a04172003-03-20 23:29:12 +0000626class TestDictFields(unittest.TestCase):
627 ### "long" means the row is longer than the number of fieldnames
628 ### "short" means there are fewer elements in the row than fieldnames
Rémi Lapeyrefce5ff12019-05-10 03:50:11 +0200629 def test_writeheader_return_value(self):
630 with TemporaryFile("w+", newline='') as fileobj:
631 writer = csv.DictWriter(fileobj, fieldnames = ["f1", "f2", "f3"])
632 writeheader_return_value = writer.writeheader()
633 self.assertEqual(writeheader_return_value, 10)
634
Skip Montanarob4a04172003-03-20 23:29:12 +0000635 def test_write_simple_dict(self):
Guido van Rossumf0c74162007-08-28 03:29:45 +0000636 with TemporaryFile("w+", newline='') as fileobj:
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000637 writer = csv.DictWriter(fileobj, fieldnames = ["f1", "f2", "f3"])
R. David Murraybe0698b2010-02-23 22:57:58 +0000638 writer.writeheader()
639 fileobj.seek(0)
640 self.assertEqual(fileobj.readline(), "f1,f2,f3\r\n")
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000641 writer.writerow({"f1": 10, "f3": "abc"})
642 fileobj.seek(0)
R. David Murraybe0698b2010-02-23 22:57:58 +0000643 fileobj.readline() # header
Guido van Rossumf0c74162007-08-28 03:29:45 +0000644 self.assertEqual(fileobj.read(), "10,,abc\r\n")
Skip Montanarob4a04172003-03-20 23:29:12 +0000645
Antoine Pitrou05da1ef2014-04-29 01:58:06 +0200646 def test_write_multiple_dict_rows(self):
647 fileobj = StringIO()
648 writer = csv.DictWriter(fileobj, fieldnames=["f1", "f2", "f3"])
649 writer.writeheader()
650 self.assertEqual(fileobj.getvalue(), "f1,f2,f3\r\n")
651 writer.writerows([{"f1": 1, "f2": "abc", "f3": "f"},
652 {"f1": 2, "f2": 5, "f3": "xyz"}])
653 self.assertEqual(fileobj.getvalue(),
654 "f1,f2,f3\r\n1,abc,f\r\n2,5,xyz\r\n")
655
Skip Montanarob4a04172003-03-20 23:29:12 +0000656 def test_write_no_fields(self):
657 fileobj = StringIO()
658 self.assertRaises(TypeError, csv.DictWriter, fileobj)
659
R David Murrayfb099c92013-11-19 13:16:20 -0500660 def test_write_fields_not_in_fieldnames(self):
661 with TemporaryFile("w+", newline='') as fileobj:
662 writer = csv.DictWriter(fileobj, fieldnames = ["f1", "f2", "f3"])
663 # Of special note is the non-string key (issue 19449)
664 with self.assertRaises(ValueError) as cx:
665 writer.writerow({"f4": 10, "f2": "spam", 1: "abc"})
666 exception = str(cx.exception)
667 self.assertIn("fieldnames", exception)
668 self.assertIn("'f4'", exception)
669 self.assertNotIn("'f2'", exception)
670 self.assertIn("1", exception)
671
INADA Naoki0a421a22016-10-21 19:47:57 +0900672 def test_typo_in_extrasaction_raises_error(self):
673 fileobj = StringIO()
674 self.assertRaises(ValueError, csv.DictWriter, fileobj, ['f1', 'f2'],
675 extrasaction="raised")
676
677 def test_write_field_not_in_field_names_raise(self):
678 fileobj = StringIO()
679 writer = csv.DictWriter(fileobj, ['f1', 'f2'], extrasaction="raise")
680 dictrow = {'f0': 0, 'f1': 1, 'f2': 2, 'f3': 3}
681 self.assertRaises(ValueError, csv.DictWriter.writerow, writer, dictrow)
682
683 def test_write_field_not_in_field_names_ignore(self):
684 fileobj = StringIO()
685 writer = csv.DictWriter(fileobj, ['f1', 'f2'], extrasaction="ignore")
686 dictrow = {'f0': 0, 'f1': 1, 'f2': 2, 'f3': 3}
687 csv.DictWriter.writerow(writer, dictrow)
688 self.assertEqual(fileobj.getvalue(), "1,2\r\n")
689
Skip Montanarob4a04172003-03-20 23:29:12 +0000690 def test_read_dict_fields(self):
Guido van Rossum46264582007-08-06 19:32:18 +0000691 with TemporaryFile("w+") as fileobj:
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000692 fileobj.write("1,2,abc\r\n")
693 fileobj.seek(0)
694 reader = csv.DictReader(fileobj,
695 fieldnames=["f1", "f2", "f3"])
Georg Brandla18af4e2007-04-21 15:47:16 +0000696 self.assertEqual(next(reader), {"f1": '1', "f2": '2', "f3": 'abc'})
Skip Montanarob4a04172003-03-20 23:29:12 +0000697
Skip Montanarodffeed32003-10-03 14:03:01 +0000698 def test_read_dict_no_fieldnames(self):
Guido van Rossum46264582007-08-06 19:32:18 +0000699 with TemporaryFile("w+") as fileobj:
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000700 fileobj.write("f1,f2,f3\r\n1,2,abc\r\n")
701 fileobj.seek(0)
702 reader = csv.DictReader(fileobj)
Georg Brandla18af4e2007-04-21 15:47:16 +0000703 self.assertEqual(next(reader), {"f1": '1', "f2": '2', "f3": 'abc'})
Skip Montanaroaf8fcfa2008-08-09 19:44:22 +0000704 self.assertEqual(reader.fieldnames, ["f1", "f2", "f3"])
705
706 # Two test cases to make sure existing ways of implicitly setting
707 # fieldnames continue to work. Both arise from discussion in issue3436.
708 def test_read_dict_fieldnames_from_file(self):
709 with TemporaryFile("w+") as fileobj:
710 fileobj.write("f1,f2,f3\r\n1,2,abc\r\n")
711 fileobj.seek(0)
712 reader = csv.DictReader(fileobj,
713 fieldnames=next(csv.reader(fileobj)))
714 self.assertEqual(reader.fieldnames, ["f1", "f2", "f3"])
715 self.assertEqual(next(reader), {"f1": '1', "f2": '2', "f3": 'abc'})
716
717 def test_read_dict_fieldnames_chain(self):
718 import itertools
719 with TemporaryFile("w+") as fileobj:
720 fileobj.write("f1,f2,f3\r\n1,2,abc\r\n")
721 fileobj.seek(0)
722 reader = csv.DictReader(fileobj)
723 first = next(reader)
724 for row in itertools.chain([first], reader):
725 self.assertEqual(reader.fieldnames, ["f1", "f2", "f3"])
726 self.assertEqual(row, {"f1": '1', "f2": '2', "f3": 'abc'})
Skip Montanarodffeed32003-10-03 14:03:01 +0000727
Skip Montanarob4a04172003-03-20 23:29:12 +0000728 def test_read_long(self):
Guido van Rossum46264582007-08-06 19:32:18 +0000729 with TemporaryFile("w+") as fileobj:
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000730 fileobj.write("1,2,abc,4,5,6\r\n")
731 fileobj.seek(0)
732 reader = csv.DictReader(fileobj,
733 fieldnames=["f1", "f2"])
Georg Brandla18af4e2007-04-21 15:47:16 +0000734 self.assertEqual(next(reader), {"f1": '1', "f2": '2',
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000735 None: ["abc", "4", "5", "6"]})
Skip Montanarob4a04172003-03-20 23:29:12 +0000736
737 def test_read_long_with_rest(self):
Guido van Rossum46264582007-08-06 19:32:18 +0000738 with TemporaryFile("w+") as fileobj:
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000739 fileobj.write("1,2,abc,4,5,6\r\n")
740 fileobj.seek(0)
741 reader = csv.DictReader(fileobj,
742 fieldnames=["f1", "f2"], restkey="_rest")
Georg Brandla18af4e2007-04-21 15:47:16 +0000743 self.assertEqual(next(reader), {"f1": '1', "f2": '2',
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000744 "_rest": ["abc", "4", "5", "6"]})
Skip Montanarob4a04172003-03-20 23:29:12 +0000745
Skip Montanarodffeed32003-10-03 14:03:01 +0000746 def test_read_long_with_rest_no_fieldnames(self):
Guido van Rossum46264582007-08-06 19:32:18 +0000747 with TemporaryFile("w+") as fileobj:
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000748 fileobj.write("f1,f2\r\n1,2,abc,4,5,6\r\n")
749 fileobj.seek(0)
750 reader = csv.DictReader(fileobj, restkey="_rest")
Skip Montanaroaf8fcfa2008-08-09 19:44:22 +0000751 self.assertEqual(reader.fieldnames, ["f1", "f2"])
Georg Brandla18af4e2007-04-21 15:47:16 +0000752 self.assertEqual(next(reader), {"f1": '1', "f2": '2',
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000753 "_rest": ["abc", "4", "5", "6"]})
Skip Montanarodffeed32003-10-03 14:03:01 +0000754
Skip Montanarob4a04172003-03-20 23:29:12 +0000755 def test_read_short(self):
Guido van Rossum46264582007-08-06 19:32:18 +0000756 with TemporaryFile("w+") as fileobj:
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000757 fileobj.write("1,2,abc,4,5,6\r\n1,2,abc\r\n")
758 fileobj.seek(0)
759 reader = csv.DictReader(fileobj,
760 fieldnames="1 2 3 4 5 6".split(),
761 restval="DEFAULT")
Georg Brandla18af4e2007-04-21 15:47:16 +0000762 self.assertEqual(next(reader), {"1": '1', "2": '2', "3": 'abc',
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000763 "4": '4', "5": '5', "6": '6'})
Georg Brandla18af4e2007-04-21 15:47:16 +0000764 self.assertEqual(next(reader), {"1": '1', "2": '2', "3": 'abc',
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000765 "4": 'DEFAULT', "5": 'DEFAULT',
766 "6": 'DEFAULT'})
Skip Montanarob4a04172003-03-20 23:29:12 +0000767
Skip Montanaro1546bc42003-06-12 02:40:22 +0000768 def test_read_multi(self):
769 sample = [
770 '2147483648,43.0e12,17,abc,def\r\n',
771 '147483648,43.0e2,17,abc,def\r\n',
772 '47483648,43.0,170,abc,def\r\n'
773 ]
774
775 reader = csv.DictReader(sample,
776 fieldnames="i1 float i2 s1 s2".split())
Georg Brandla18af4e2007-04-21 15:47:16 +0000777 self.assertEqual(next(reader), {"i1": '2147483648',
Skip Montanaro1546bc42003-06-12 02:40:22 +0000778 "float": '43.0e12',
779 "i2": '17',
780 "s1": 'abc',
781 "s2": 'def'})
782
Skip Montanarob4a04172003-03-20 23:29:12 +0000783 def test_read_with_blanks(self):
784 reader = csv.DictReader(["1,2,abc,4,5,6\r\n","\r\n",
785 "1,2,abc,4,5,6\r\n"],
786 fieldnames="1 2 3 4 5 6".split())
Georg Brandla18af4e2007-04-21 15:47:16 +0000787 self.assertEqual(next(reader), {"1": '1', "2": '2', "3": 'abc',
Skip Montanarob4a04172003-03-20 23:29:12 +0000788 "4": '4', "5": '5', "6": '6'})
Georg Brandla18af4e2007-04-21 15:47:16 +0000789 self.assertEqual(next(reader), {"1": '1', "2": '2', "3": 'abc',
Skip Montanarob4a04172003-03-20 23:29:12 +0000790 "4": '4', "5": '5', "6": '6'})
791
Skip Montanaro3f7a9482003-09-06 19:52:12 +0000792 def test_read_semi_sep(self):
793 reader = csv.DictReader(["1;2;abc;4;5;6\r\n"],
794 fieldnames="1 2 3 4 5 6".split(),
795 delimiter=';')
Georg Brandla18af4e2007-04-21 15:47:16 +0000796 self.assertEqual(next(reader), {"1": '1', "2": '2', "3": 'abc',
Skip Montanaro3f7a9482003-09-06 19:52:12 +0000797 "4": '4', "5": '5', "6": '6'})
798
Skip Montanarob4a04172003-03-20 23:29:12 +0000799class TestArrayWrites(unittest.TestCase):
800 def test_int_write(self):
801 import array
802 contents = [(20-i) for i in range(20)]
803 a = array.array('i', contents)
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000804
Guido van Rossumf0c74162007-08-28 03:29:45 +0000805 with TemporaryFile("w+", newline='') as fileobj:
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000806 writer = csv.writer(fileobj, dialect="excel")
807 writer.writerow(a)
808 expected = ",".join([str(i) for i in a])+"\r\n"
809 fileobj.seek(0)
Guido van Rossumf0c74162007-08-28 03:29:45 +0000810 self.assertEqual(fileobj.read(), expected)
Skip Montanarob4a04172003-03-20 23:29:12 +0000811
812 def test_double_write(self):
813 import array
814 contents = [(20-i)*0.1 for i in range(20)]
815 a = array.array('d', contents)
Guido van Rossumf0c74162007-08-28 03:29:45 +0000816 with TemporaryFile("w+", newline='') as fileobj:
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000817 writer = csv.writer(fileobj, dialect="excel")
818 writer.writerow(a)
819 expected = ",".join([str(i) for i in a])+"\r\n"
820 fileobj.seek(0)
Guido van Rossumf0c74162007-08-28 03:29:45 +0000821 self.assertEqual(fileobj.read(), expected)
Skip Montanarob4a04172003-03-20 23:29:12 +0000822
823 def test_float_write(self):
824 import array
825 contents = [(20-i)*0.1 for i in range(20)]
826 a = array.array('f', contents)
Guido van Rossumf0c74162007-08-28 03:29:45 +0000827 with TemporaryFile("w+", newline='') as fileobj:
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000828 writer = csv.writer(fileobj, dialect="excel")
829 writer.writerow(a)
830 expected = ",".join([str(i) for i in a])+"\r\n"
831 fileobj.seek(0)
Guido van Rossumf0c74162007-08-28 03:29:45 +0000832 self.assertEqual(fileobj.read(), expected)
Skip Montanarob4a04172003-03-20 23:29:12 +0000833
834 def test_char_write(self):
835 import array, string
Martin v. Löwis967f1e32007-08-14 09:23:10 +0000836 a = array.array('u', string.ascii_letters)
Guido van Rossum46264582007-08-06 19:32:18 +0000837
Guido van Rossumf0c74162007-08-28 03:29:45 +0000838 with TemporaryFile("w+", newline='') as fileobj:
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000839 writer = csv.writer(fileobj, dialect="excel")
840 writer.writerow(a)
841 expected = ",".join(a)+"\r\n"
842 fileobj.seek(0)
Guido van Rossumf0c74162007-08-28 03:29:45 +0000843 self.assertEqual(fileobj.read(), expected)
Skip Montanarob4a04172003-03-20 23:29:12 +0000844
845class TestDialectValidity(unittest.TestCase):
846 def test_quoting(self):
847 class mydialect(csv.Dialect):
848 delimiter = ";"
849 escapechar = '\\'
850 doublequote = False
851 skipinitialspace = True
852 lineterminator = '\r\n'
853 quoting = csv.QUOTE_NONE
854 d = mydialect()
Serhiy Storchakacac23a52013-12-19 16:27:18 +0200855 self.assertEqual(d.quoting, csv.QUOTE_NONE)
Skip Montanarob4a04172003-03-20 23:29:12 +0000856
857 mydialect.quoting = None
858 self.assertRaises(csv.Error, mydialect)
859
Skip Montanarob4a04172003-03-20 23:29:12 +0000860 mydialect.doublequote = True
861 mydialect.quoting = csv.QUOTE_ALL
862 mydialect.quotechar = '"'
863 d = mydialect()
Serhiy Storchakacac23a52013-12-19 16:27:18 +0200864 self.assertEqual(d.quoting, csv.QUOTE_ALL)
865 self.assertEqual(d.quotechar, '"')
866 self.assertTrue(d.doublequote)
Skip Montanarob4a04172003-03-20 23:29:12 +0000867
868 mydialect.quotechar = "''"
Serhiy Storchakacac23a52013-12-19 16:27:18 +0200869 with self.assertRaises(csv.Error) as cm:
870 mydialect()
871 self.assertEqual(str(cm.exception),
Berker Peksag0f41acb2014-07-27 23:22:34 +0300872 '"quotechar" must be a 1-character string')
Skip Montanarob4a04172003-03-20 23:29:12 +0000873
874 mydialect.quotechar = 4
Serhiy Storchakacac23a52013-12-19 16:27:18 +0200875 with self.assertRaises(csv.Error) as cm:
876 mydialect()
877 self.assertEqual(str(cm.exception),
878 '"quotechar" must be string, not int')
Skip Montanarob4a04172003-03-20 23:29:12 +0000879
880 def test_delimiter(self):
881 class mydialect(csv.Dialect):
882 delimiter = ";"
883 escapechar = '\\'
884 doublequote = False
885 skipinitialspace = True
886 lineterminator = '\r\n'
887 quoting = csv.QUOTE_NONE
888 d = mydialect()
Serhiy Storchakacac23a52013-12-19 16:27:18 +0200889 self.assertEqual(d.delimiter, ";")
Skip Montanarob4a04172003-03-20 23:29:12 +0000890
891 mydialect.delimiter = ":::"
Serhiy Storchakacac23a52013-12-19 16:27:18 +0200892 with self.assertRaises(csv.Error) as cm:
893 mydialect()
894 self.assertEqual(str(cm.exception),
Berker Peksag0f41acb2014-07-27 23:22:34 +0300895 '"delimiter" must be a 1-character string')
Serhiy Storchakacac23a52013-12-19 16:27:18 +0200896
897 mydialect.delimiter = ""
898 with self.assertRaises(csv.Error) as cm:
899 mydialect()
900 self.assertEqual(str(cm.exception),
Berker Peksag0f41acb2014-07-27 23:22:34 +0300901 '"delimiter" must be a 1-character string')
Serhiy Storchakacac23a52013-12-19 16:27:18 +0200902
903 mydialect.delimiter = b","
904 with self.assertRaises(csv.Error) as cm:
905 mydialect()
906 self.assertEqual(str(cm.exception),
907 '"delimiter" must be string, not bytes')
Skip Montanarob4a04172003-03-20 23:29:12 +0000908
909 mydialect.delimiter = 4
Serhiy Storchakacac23a52013-12-19 16:27:18 +0200910 with self.assertRaises(csv.Error) as cm:
911 mydialect()
912 self.assertEqual(str(cm.exception),
913 '"delimiter" must be string, not int')
Skip Montanarob4a04172003-03-20 23:29:12 +0000914
915 def test_lineterminator(self):
916 class mydialect(csv.Dialect):
917 delimiter = ";"
918 escapechar = '\\'
919 doublequote = False
920 skipinitialspace = True
921 lineterminator = '\r\n'
922 quoting = csv.QUOTE_NONE
923 d = mydialect()
Serhiy Storchakacac23a52013-12-19 16:27:18 +0200924 self.assertEqual(d.lineterminator, '\r\n')
Skip Montanarob4a04172003-03-20 23:29:12 +0000925
926 mydialect.lineterminator = ":::"
927 d = mydialect()
Serhiy Storchakacac23a52013-12-19 16:27:18 +0200928 self.assertEqual(d.lineterminator, ":::")
Skip Montanarob4a04172003-03-20 23:29:12 +0000929
930 mydialect.lineterminator = 4
Serhiy Storchakacac23a52013-12-19 16:27:18 +0200931 with self.assertRaises(csv.Error) as cm:
932 mydialect()
933 self.assertEqual(str(cm.exception),
934 '"lineterminator" must be a string')
Skip Montanarob4a04172003-03-20 23:29:12 +0000935
Victor Stinner6a31b0f2014-01-02 12:53:13 +0100936 def test_invalid_chars(self):
937 def create_invalid(field_name, value):
938 class mydialect(csv.Dialect):
939 pass
940 setattr(mydialect, field_name, value)
941 d = mydialect()
942
943 for field_name in ("delimiter", "escapechar", "quotechar"):
Victor Stinner009771e2014-01-02 12:53:50 +0100944 with self.subTest(field_name=field_name):
945 self.assertRaises(csv.Error, create_invalid, field_name, "")
946 self.assertRaises(csv.Error, create_invalid, field_name, "abc")
947 self.assertRaises(csv.Error, create_invalid, field_name, b'x')
948 self.assertRaises(csv.Error, create_invalid, field_name, 5)
Victor Stinner6a31b0f2014-01-02 12:53:13 +0100949
Skip Montanarob4a04172003-03-20 23:29:12 +0000950
Skip Montanaro48816c62003-04-25 14:43:14 +0000951class TestSniffer(unittest.TestCase):
952 sample1 = """\
953Harry's, Arlington Heights, IL, 2/1/03, Kimi Hayes
954Shark City, Glendale Heights, IL, 12/28/02, Prezence
955Tommy's Place, Blue Island, IL, 12/28/02, Blue Sunday/White Crow
956Stonecutters Seafood and Chop House, Lemont, IL, 12/19/02, Week Back
957"""
958 sample2 = """\
959'Harry''s':'Arlington Heights':'IL':'2/1/03':'Kimi Hayes'
960'Shark City':'Glendale Heights':'IL':'12/28/02':'Prezence'
961'Tommy''s Place':'Blue Island':'IL':'12/28/02':'Blue Sunday/White Crow'
Benjamin Peterson4ac9ce42009-10-04 14:49:41 +0000962'Stonecutters ''Seafood'' and Chop House':'Lemont':'IL':'12/19/02':'Week Back'
Skip Montanaro48816c62003-04-25 14:43:14 +0000963"""
R David Murray925a3222013-06-29 18:40:53 -0400964 header1 = '''\
Skip Montanaro48816c62003-04-25 14:43:14 +0000965"venue","city","state","date","performers"
966'''
Skip Montanaro77892372003-05-19 15:33:36 +0000967 sample3 = '''\
96805/05/03?05/05/03?05/05/03?05/05/03?05/05/03?05/05/03
96905/05/03?05/05/03?05/05/03?05/05/03?05/05/03?05/05/03
97005/05/03?05/05/03?05/05/03?05/05/03?05/05/03?05/05/03
971'''
972
Skip Montanaro1546bc42003-06-12 02:40:22 +0000973 sample4 = '''\
9742147483648;43.0e12;17;abc;def
975147483648;43.0e2;17;abc;def
97647483648;43.0;170;abc;def
977'''
978
Skip Montanaro91bb70c2005-12-28 15:37:25 +0000979 sample5 = "aaa\tbbb\r\nAAA\t\r\nBBB\t\r\n"
Skip Montanaro39b29be2005-12-30 05:09:48 +0000980 sample6 = "a|b|c\r\nd|e|f\r\n"
981 sample7 = "'a'|'b'|'c'\r\n'd'|e|f\r\n"
Skip Montanaro91bb70c2005-12-28 15:37:25 +0000982
R David Murray925a3222013-06-29 18:40:53 -0400983# Issue 18155: Use a delimiter that is a special char to regex:
984
985 header2 = '''\
986"venue"+"city"+"state"+"date"+"performers"
987'''
988 sample8 = """\
989Harry's+ Arlington Heights+ IL+ 2/1/03+ Kimi Hayes
990Shark City+ Glendale Heights+ IL+ 12/28/02+ Prezence
991Tommy's Place+ Blue Island+ IL+ 12/28/02+ Blue Sunday/White Crow
992Stonecutters Seafood and Chop House+ Lemont+ IL+ 12/19/02+ Week Back
993"""
994 sample9 = """\
995'Harry''s'+ Arlington Heights'+ 'IL'+ '2/1/03'+ 'Kimi Hayes'
996'Shark City'+ Glendale Heights'+' IL'+ '12/28/02'+ 'Prezence'
997'Tommy''s Place'+ Blue Island'+ 'IL'+ '12/28/02'+ 'Blue Sunday/White Crow'
998'Stonecutters ''Seafood'' and Chop House'+ 'Lemont'+ 'IL'+ '12/19/02'+ 'Week Back'
999"""
1000
Skip Montanaro48816c62003-04-25 14:43:14 +00001001 def test_has_header(self):
1002 sniffer = csv.Sniffer()
Serhiy Storchaka323748a2018-07-26 13:21:09 +03001003 self.assertIs(sniffer.has_header(self.sample1), False)
1004 self.assertIs(sniffer.has_header(self.header1 + self.sample1), True)
R David Murray925a3222013-06-29 18:40:53 -04001005
1006 def test_has_header_regex_special_delimiter(self):
1007 sniffer = csv.Sniffer()
Serhiy Storchaka323748a2018-07-26 13:21:09 +03001008 self.assertIs(sniffer.has_header(self.sample8), False)
1009 self.assertIs(sniffer.has_header(self.header2 + self.sample8), True)
Skip Montanaro48816c62003-04-25 14:43:14 +00001010
Serhiy Storchaka24112922018-02-09 20:00:49 +02001011 def test_guess_quote_and_delimiter(self):
1012 sniffer = csv.Sniffer()
1013 for header in (";'123;4';", "'123;4';", ";'123;4'", "'123;4'"):
1014 with self.subTest(header):
1015 dialect = sniffer.sniff(header, ",;")
1016 self.assertEqual(dialect.delimiter, ';')
1017 self.assertEqual(dialect.quotechar, "'")
1018 self.assertIs(dialect.doublequote, False)
1019 self.assertIs(dialect.skipinitialspace, False)
1020
Skip Montanaro48816c62003-04-25 14:43:14 +00001021 def test_sniff(self):
1022 sniffer = csv.Sniffer()
1023 dialect = sniffer.sniff(self.sample1)
1024 self.assertEqual(dialect.delimiter, ",")
1025 self.assertEqual(dialect.quotechar, '"')
Serhiy Storchaka323748a2018-07-26 13:21:09 +03001026 self.assertIs(dialect.skipinitialspace, True)
Skip Montanaro48816c62003-04-25 14:43:14 +00001027
1028 dialect = sniffer.sniff(self.sample2)
1029 self.assertEqual(dialect.delimiter, ":")
1030 self.assertEqual(dialect.quotechar, "'")
Serhiy Storchaka323748a2018-07-26 13:21:09 +03001031 self.assertIs(dialect.skipinitialspace, False)
Skip Montanaro48816c62003-04-25 14:43:14 +00001032
Skip Montanaro77892372003-05-19 15:33:36 +00001033 def test_delimiters(self):
1034 sniffer = csv.Sniffer()
1035 dialect = sniffer.sniff(self.sample3)
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00001036 # given that all three lines in sample3 are equal,
1037 # I think that any character could have been 'guessed' as the
1038 # delimiter, depending on dictionary order
Benjamin Peterson577473f2010-01-19 00:09:57 +00001039 self.assertIn(dialect.delimiter, self.sample3)
Skip Montanaro77892372003-05-19 15:33:36 +00001040 dialect = sniffer.sniff(self.sample3, delimiters="?,")
1041 self.assertEqual(dialect.delimiter, "?")
1042 dialect = sniffer.sniff(self.sample3, delimiters="/,")
1043 self.assertEqual(dialect.delimiter, "/")
Skip Montanaro1546bc42003-06-12 02:40:22 +00001044 dialect = sniffer.sniff(self.sample4)
1045 self.assertEqual(dialect.delimiter, ";")
Skip Montanaro91bb70c2005-12-28 15:37:25 +00001046 dialect = sniffer.sniff(self.sample5)
1047 self.assertEqual(dialect.delimiter, "\t")
Skip Montanaro39b29be2005-12-30 05:09:48 +00001048 dialect = sniffer.sniff(self.sample6)
1049 self.assertEqual(dialect.delimiter, "|")
1050 dialect = sniffer.sniff(self.sample7)
1051 self.assertEqual(dialect.delimiter, "|")
1052 self.assertEqual(dialect.quotechar, "'")
R David Murray925a3222013-06-29 18:40:53 -04001053 dialect = sniffer.sniff(self.sample8)
1054 self.assertEqual(dialect.delimiter, '+')
1055 dialect = sniffer.sniff(self.sample9)
1056 self.assertEqual(dialect.delimiter, '+')
1057 self.assertEqual(dialect.quotechar, "'")
Skip Montanaro77892372003-05-19 15:33:36 +00001058
Benjamin Peterson4ac9ce42009-10-04 14:49:41 +00001059 def test_doublequote(self):
1060 sniffer = csv.Sniffer()
R David Murray925a3222013-06-29 18:40:53 -04001061 dialect = sniffer.sniff(self.header1)
1062 self.assertFalse(dialect.doublequote)
1063 dialect = sniffer.sniff(self.header2)
Benjamin Peterson4ac9ce42009-10-04 14:49:41 +00001064 self.assertFalse(dialect.doublequote)
1065 dialect = sniffer.sniff(self.sample2)
1066 self.assertTrue(dialect.doublequote)
R David Murray925a3222013-06-29 18:40:53 -04001067 dialect = sniffer.sniff(self.sample8)
1068 self.assertFalse(dialect.doublequote)
1069 dialect = sniffer.sniff(self.sample9)
1070 self.assertTrue(dialect.doublequote)
Benjamin Peterson4ac9ce42009-10-04 14:49:41 +00001071
Serhiy Storchaka43767632013-11-03 21:31:38 +02001072class NUL:
1073 def write(s, *args):
1074 pass
1075 writelines = write
Skip Montanarob4a04172003-03-20 23:29:12 +00001076
Serhiy Storchaka43767632013-11-03 21:31:38 +02001077@unittest.skipUnless(hasattr(sys, "gettotalrefcount"),
1078 'requires sys.gettotalrefcount()')
1079class TestLeaks(unittest.TestCase):
1080 def test_create_read(self):
1081 delta = 0
1082 lastrc = sys.gettotalrefcount()
1083 for i in range(20):
1084 gc.collect()
1085 self.assertEqual(gc.garbage, [])
1086 rc = sys.gettotalrefcount()
1087 csv.reader(["a,b,c\r\n"])
1088 csv.reader(["a,b,c\r\n"])
1089 csv.reader(["a,b,c\r\n"])
1090 delta = rc-lastrc
1091 lastrc = rc
1092 # if csv.reader() leaks, last delta should be 3 or more
Serhiy Storchaka323748a2018-07-26 13:21:09 +03001093 self.assertLess(delta, 3)
Skip Montanarob4a04172003-03-20 23:29:12 +00001094
Serhiy Storchaka43767632013-11-03 21:31:38 +02001095 def test_create_write(self):
1096 delta = 0
1097 lastrc = sys.gettotalrefcount()
1098 s = NUL()
1099 for i in range(20):
1100 gc.collect()
1101 self.assertEqual(gc.garbage, [])
1102 rc = sys.gettotalrefcount()
1103 csv.writer(s)
1104 csv.writer(s)
1105 csv.writer(s)
1106 delta = rc-lastrc
1107 lastrc = rc
1108 # if csv.writer() leaks, last delta should be 3 or more
Serhiy Storchaka323748a2018-07-26 13:21:09 +03001109 self.assertLess(delta, 3)
Skip Montanarob4a04172003-03-20 23:29:12 +00001110
Serhiy Storchaka43767632013-11-03 21:31:38 +02001111 def test_read(self):
1112 delta = 0
1113 rows = ["a,b,c\r\n"]*5
1114 lastrc = sys.gettotalrefcount()
1115 for i in range(20):
1116 gc.collect()
1117 self.assertEqual(gc.garbage, [])
1118 rc = sys.gettotalrefcount()
1119 rdr = csv.reader(rows)
1120 for row in rdr:
1121 pass
1122 delta = rc-lastrc
1123 lastrc = rc
1124 # if reader leaks during read, delta should be 5 or more
Serhiy Storchaka323748a2018-07-26 13:21:09 +03001125 self.assertLess(delta, 5)
Skip Montanarob4a04172003-03-20 23:29:12 +00001126
Serhiy Storchaka43767632013-11-03 21:31:38 +02001127 def test_write(self):
1128 delta = 0
1129 rows = [[1,2,3]]*5
1130 s = NUL()
1131 lastrc = sys.gettotalrefcount()
1132 for i in range(20):
1133 gc.collect()
1134 self.assertEqual(gc.garbage, [])
1135 rc = sys.gettotalrefcount()
1136 writer = csv.writer(s)
1137 for row in rows:
1138 writer.writerow(row)
1139 delta = rc-lastrc
1140 lastrc = rc
1141 # if writer leaks during write, last delta should be 5 or more
Serhiy Storchaka323748a2018-07-26 13:21:09 +03001142 self.assertLess(delta, 5)
Skip Montanarob4a04172003-03-20 23:29:12 +00001143
Guido van Rossum46264582007-08-06 19:32:18 +00001144class TestUnicode(unittest.TestCase):
1145
1146 names = ["Martin von Löwis",
1147 "Marc André Lemburg",
1148 "Guido van Rossum",
1149 "François Pinard"]
1150
1151 def test_unicode_read(self):
Guido van Rossumf0c74162007-08-28 03:29:45 +00001152 with TemporaryFile("w+", newline='', encoding="utf-8") as fileobj:
Guido van Rossum46264582007-08-06 19:32:18 +00001153 fileobj.write(",".join(self.names) + "\r\n")
Guido van Rossum46264582007-08-06 19:32:18 +00001154 fileobj.seek(0)
1155 reader = csv.reader(fileobj)
1156 self.assertEqual(list(reader), [self.names])
1157
1158
1159 def test_unicode_write(self):
Guido van Rossumf0c74162007-08-28 03:29:45 +00001160 with TemporaryFile("w+", newline='', encoding="utf-8") as fileobj:
1161 writer = csv.writer(fileobj)
Guido van Rossum46264582007-08-06 19:32:18 +00001162 writer.writerow(self.names)
1163 expected = ",".join(self.names)+"\r\n"
1164 fileobj.seek(0)
Guido van Rossumf0c74162007-08-28 03:29:45 +00001165 self.assertEqual(fileobj.read(), expected)
Guido van Rossum46264582007-08-06 19:32:18 +00001166
Raymond Hettinger43ca4522016-08-30 12:35:50 -07001167class KeyOrderingTest(unittest.TestCase):
1168
1169 def test_ordering_for_the_dict_reader_and_writer(self):
1170 resultset = set()
1171 for keys in permutations("abcde"):
1172 with TemporaryFile('w+', newline='', encoding="utf-8") as fileobject:
1173 dw = csv.DictWriter(fileobject, keys)
1174 dw.writeheader()
1175 fileobject.seek(0)
1176 dr = csv.DictReader(fileobject)
1177 kt = tuple(dr.fieldnames)
1178 self.assertEqual(keys, kt)
1179 resultset.add(kt)
1180 # Final sanity check: were all permutations unique?
1181 self.assertEqual(len(resultset), 120, "Key ordering: some key permutations not collected (expected 120)")
Guido van Rossum46264582007-08-06 19:32:18 +00001182
Raymond Hettinger8ca35702016-08-30 12:57:26 -07001183 def test_ordered_dict_reader(self):
1184 data = dedent('''\
1185 FirstName,LastName
1186 Eric,Idle
1187 Graham,Chapman,Over1,Over2
1188
1189 Under1
1190 John,Cleese
1191 ''').splitlines()
1192
1193 self.assertEqual(list(csv.DictReader(data)),
1194 [OrderedDict([('FirstName', 'Eric'), ('LastName', 'Idle')]),
1195 OrderedDict([('FirstName', 'Graham'), ('LastName', 'Chapman'),
1196 (None, ['Over1', 'Over2'])]),
1197 OrderedDict([('FirstName', 'Under1'), ('LastName', None)]),
1198 OrderedDict([('FirstName', 'John'), ('LastName', 'Cleese')]),
1199 ])
1200
1201 self.assertEqual(list(csv.DictReader(data, restkey='OtherInfo')),
1202 [OrderedDict([('FirstName', 'Eric'), ('LastName', 'Idle')]),
1203 OrderedDict([('FirstName', 'Graham'), ('LastName', 'Chapman'),
1204 ('OtherInfo', ['Over1', 'Over2'])]),
1205 OrderedDict([('FirstName', 'Under1'), ('LastName', None)]),
1206 OrderedDict([('FirstName', 'John'), ('LastName', 'Cleese')]),
1207 ])
1208
1209 del data[0] # Remove the header row
1210 self.assertEqual(list(csv.DictReader(data, fieldnames=['fname', 'lname'])),
1211 [OrderedDict([('fname', 'Eric'), ('lname', 'Idle')]),
1212 OrderedDict([('fname', 'Graham'), ('lname', 'Chapman'),
1213 (None, ['Over1', 'Over2'])]),
1214 OrderedDict([('fname', 'Under1'), ('lname', None)]),
1215 OrderedDict([('fname', 'John'), ('lname', 'Cleese')]),
1216 ])
1217
1218
Martin Panter19e69c52015-11-14 12:46:42 +00001219class MiscTestCase(unittest.TestCase):
1220 def test__all__(self):
1221 extra = {'__doc__', '__version__'}
1222 support.check__all__(self, csv, ('csv', '_csv'), extra=extra)
1223
1224
Skip Montanarob4a04172003-03-20 23:29:12 +00001225if __name__ == '__main__':
Zachary Ware38c707e2015-04-13 15:00:43 -05001226 unittest.main()