blob: 38160220853ea836f3436649700f2e35c6464fa7 [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
Inada Naoki902356a2020-07-20 12:02:50 +090013from test.support import warnings_helper
Raymond Hettinger43ca4522016-08-30 12:35:50 -070014from itertools import permutations
Raymond Hettinger8ca35702016-08-30 12:57:26 -070015from textwrap import dedent
16from collections import OrderedDict
Skip Montanarob4a04172003-03-20 23:29:12 +000017
Serhiy Storchakac88239f2020-06-22 11:21:59 +030018
19class BadIterable:
20 def __iter__(self):
21 raise OSError
22
23
Skip Montanarob4a04172003-03-20 23:29:12 +000024class Test_Csv(unittest.TestCase):
25 """
Tim Peters0eadaac2003-04-24 16:02:54 +000026 Test the underlying C csv parser in ways that are not appropriate
Skip Montanarob4a04172003-03-20 23:29:12 +000027 from the high level interface. Further tests of this nature are done
28 in TestDialectRegistry.
29 """
Andrew McNamara1196cf12005-01-07 04:42:45 +000030 def _test_arg_valid(self, ctor, arg):
31 self.assertRaises(TypeError, ctor)
32 self.assertRaises(TypeError, ctor, None)
33 self.assertRaises(TypeError, ctor, arg, bad_attr = 0)
34 self.assertRaises(TypeError, ctor, arg, delimiter = 0)
35 self.assertRaises(TypeError, ctor, arg, delimiter = 'XX')
36 self.assertRaises(csv.Error, ctor, arg, 'foo')
Andrew McNamara1196cf12005-01-07 04:42:45 +000037 self.assertRaises(TypeError, ctor, arg, delimiter=None)
38 self.assertRaises(TypeError, ctor, arg, delimiter=1)
39 self.assertRaises(TypeError, ctor, arg, quotechar=1)
40 self.assertRaises(TypeError, ctor, arg, lineterminator=None)
41 self.assertRaises(TypeError, ctor, arg, lineterminator=1)
42 self.assertRaises(TypeError, ctor, arg, quoting=None)
Tim Peters608c2ff2005-01-13 17:37:38 +000043 self.assertRaises(TypeError, ctor, arg,
Andrew McNamaraaf1e3122005-01-12 01:55:21 +000044 quoting=csv.QUOTE_ALL, quotechar='')
Tim Peters608c2ff2005-01-13 17:37:38 +000045 self.assertRaises(TypeError, ctor, arg,
Andrew McNamara5d45a8d2005-01-12 08:16:17 +000046 quoting=csv.QUOTE_ALL, quotechar=None)
Andrew McNamara1196cf12005-01-07 04:42:45 +000047
48 def test_reader_arg_valid(self):
49 self._test_arg_valid(csv.reader, [])
Serhiy Storchakac88239f2020-06-22 11:21:59 +030050 self.assertRaises(OSError, csv.reader, BadIterable())
Skip Montanarob4a04172003-03-20 23:29:12 +000051
52 def test_writer_arg_valid(self):
Andrew McNamara1196cf12005-01-07 04:42:45 +000053 self._test_arg_valid(csv.writer, StringIO())
Serhiy Storchakac88239f2020-06-22 11:21:59 +030054 class BadWriter:
55 @property
56 def write(self):
57 raise OSError
58 self.assertRaises(OSError, csv.writer, BadWriter())
Skip Montanarob4a04172003-03-20 23:29:12 +000059
Andrew McNamara1196cf12005-01-07 04:42:45 +000060 def _test_default_attrs(self, ctor, *args):
61 obj = ctor(*args)
62 # Check defaults
Skip Montanarob4a04172003-03-20 23:29:12 +000063 self.assertEqual(obj.dialect.delimiter, ',')
Serhiy Storchaka323748a2018-07-26 13:21:09 +030064 self.assertIs(obj.dialect.doublequote, True)
Skip Montanarob4a04172003-03-20 23:29:12 +000065 self.assertEqual(obj.dialect.escapechar, None)
Andrew McNamara1196cf12005-01-07 04:42:45 +000066 self.assertEqual(obj.dialect.lineterminator, "\r\n")
67 self.assertEqual(obj.dialect.quotechar, '"')
68 self.assertEqual(obj.dialect.quoting, csv.QUOTE_MINIMAL)
Serhiy Storchaka323748a2018-07-26 13:21:09 +030069 self.assertIs(obj.dialect.skipinitialspace, False)
70 self.assertIs(obj.dialect.strict, False)
Andrew McNamara1196cf12005-01-07 04:42:45 +000071 # Try deleting or changing attributes (they are read-only)
Collin Winter42dae6a2007-03-28 21:44:53 +000072 self.assertRaises(AttributeError, delattr, obj.dialect, 'delimiter')
73 self.assertRaises(AttributeError, setattr, obj.dialect, 'delimiter', ':')
Barry Warsawb180c062005-04-20 19:41:36 +000074 self.assertRaises(AttributeError, delattr, obj.dialect, 'quoting')
75 self.assertRaises(AttributeError, setattr, obj.dialect,
76 'quoting', None)
Skip Montanarob4a04172003-03-20 23:29:12 +000077
78 def test_reader_attrs(self):
Andrew McNamara1196cf12005-01-07 04:42:45 +000079 self._test_default_attrs(csv.reader, [])
Skip Montanarob4a04172003-03-20 23:29:12 +000080
81 def test_writer_attrs(self):
Andrew McNamara1196cf12005-01-07 04:42:45 +000082 self._test_default_attrs(csv.writer, StringIO())
83
84 def _test_kw_attrs(self, ctor, *args):
85 # Now try with alternate options
86 kwargs = dict(delimiter=':', doublequote=False, escapechar='\\',
87 lineterminator='\r', quotechar='*',
88 quoting=csv.QUOTE_NONE, skipinitialspace=True,
89 strict=True)
90 obj = ctor(*args, **kwargs)
91 self.assertEqual(obj.dialect.delimiter, ':')
Serhiy Storchaka323748a2018-07-26 13:21:09 +030092 self.assertIs(obj.dialect.doublequote, False)
Andrew McNamara1196cf12005-01-07 04:42:45 +000093 self.assertEqual(obj.dialect.escapechar, '\\')
94 self.assertEqual(obj.dialect.lineterminator, "\r")
95 self.assertEqual(obj.dialect.quotechar, '*')
96 self.assertEqual(obj.dialect.quoting, csv.QUOTE_NONE)
Serhiy Storchaka323748a2018-07-26 13:21:09 +030097 self.assertIs(obj.dialect.skipinitialspace, True)
98 self.assertIs(obj.dialect.strict, True)
Andrew McNamara1196cf12005-01-07 04:42:45 +000099
100 def test_reader_kw_attrs(self):
101 self._test_kw_attrs(csv.reader, [])
102
103 def test_writer_kw_attrs(self):
104 self._test_kw_attrs(csv.writer, StringIO())
105
106 def _test_dialect_attrs(self, ctor, *args):
107 # Now try with dialect-derived options
108 class dialect:
109 delimiter='-'
110 doublequote=False
111 escapechar='^'
112 lineterminator='$'
113 quotechar='#'
114 quoting=csv.QUOTE_ALL
115 skipinitialspace=True
116 strict=False
117 args = args + (dialect,)
118 obj = ctor(*args)
119 self.assertEqual(obj.dialect.delimiter, '-')
Serhiy Storchaka323748a2018-07-26 13:21:09 +0300120 self.assertIs(obj.dialect.doublequote, False)
Andrew McNamara1196cf12005-01-07 04:42:45 +0000121 self.assertEqual(obj.dialect.escapechar, '^')
122 self.assertEqual(obj.dialect.lineterminator, "$")
123 self.assertEqual(obj.dialect.quotechar, '#')
124 self.assertEqual(obj.dialect.quoting, csv.QUOTE_ALL)
Serhiy Storchaka323748a2018-07-26 13:21:09 +0300125 self.assertIs(obj.dialect.skipinitialspace, True)
126 self.assertIs(obj.dialect.strict, False)
Andrew McNamara1196cf12005-01-07 04:42:45 +0000127
128 def test_reader_dialect_attrs(self):
129 self._test_dialect_attrs(csv.reader, [])
130
131 def test_writer_dialect_attrs(self):
132 self._test_dialect_attrs(csv.writer, StringIO())
133
Skip Montanarob4a04172003-03-20 23:29:12 +0000134
135 def _write_test(self, fields, expect, **kwargs):
Guido van Rossumf0c74162007-08-28 03:29:45 +0000136 with TemporaryFile("w+", newline='') as fileobj:
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000137 writer = csv.writer(fileobj, **kwargs)
138 writer.writerow(fields)
139 fileobj.seek(0)
Guido van Rossumf0c74162007-08-28 03:29:45 +0000140 self.assertEqual(fileobj.read(),
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000141 expect + writer.dialect.lineterminator)
Skip Montanarob4a04172003-03-20 23:29:12 +0000142
Serhiy Storchaka0b4e3552015-03-25 19:16:15 +0200143 def _write_error_test(self, exc, fields, **kwargs):
144 with TemporaryFile("w+", newline='') as fileobj:
145 writer = csv.writer(fileobj, **kwargs)
146 with self.assertRaises(exc):
147 writer.writerow(fields)
148 fileobj.seek(0)
149 self.assertEqual(fileobj.read(), '')
150
Skip Montanarob4a04172003-03-20 23:29:12 +0000151 def test_write_arg_valid(self):
Serhiy Storchaka0b4e3552015-03-25 19:16:15 +0200152 self._write_error_test(csv.Error, None)
Skip Montanarob4a04172003-03-20 23:29:12 +0000153 self._write_test((), '')
154 self._write_test([None], '""')
Serhiy Storchaka0b4e3552015-03-25 19:16:15 +0200155 self._write_error_test(csv.Error, [None], quoting = csv.QUOTE_NONE)
Skip Montanarob4a04172003-03-20 23:29:12 +0000156 # Check that exceptions are passed up the chain
Serhiy Storchakac88239f2020-06-22 11:21:59 +0300157 self._write_error_test(OSError, BadIterable())
Skip Montanarob4a04172003-03-20 23:29:12 +0000158 class BadList:
159 def __len__(self):
160 return 10;
161 def __getitem__(self, i):
162 if i > 2:
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200163 raise OSError
Serhiy Storchaka0b4e3552015-03-25 19:16:15 +0200164 self._write_error_test(OSError, BadList())
Skip Montanarob4a04172003-03-20 23:29:12 +0000165 class BadItem:
166 def __str__(self):
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200167 raise OSError
Serhiy Storchaka0b4e3552015-03-25 19:16:15 +0200168 self._write_error_test(OSError, [BadItem()])
Skip Montanarob4a04172003-03-20 23:29:12 +0000169
170 def test_write_bigfield(self):
171 # This exercises the buffer realloc functionality
172 bigstring = 'X' * 50000
173 self._write_test([bigstring,bigstring], '%s,%s' % \
174 (bigstring, bigstring))
175
176 def test_write_quoting(self):
Andrew McNamarac89f2842005-01-12 07:44:42 +0000177 self._write_test(['a',1,'p,q'], 'a,1,"p,q"')
Serhiy Storchaka0b4e3552015-03-25 19:16:15 +0200178 self._write_error_test(csv.Error, ['a',1,'p,q'],
179 quoting = csv.QUOTE_NONE)
Andrew McNamarac89f2842005-01-12 07:44:42 +0000180 self._write_test(['a',1,'p,q'], 'a,1,"p,q"',
Skip Montanarob4a04172003-03-20 23:29:12 +0000181 quoting = csv.QUOTE_MINIMAL)
Andrew McNamarac89f2842005-01-12 07:44:42 +0000182 self._write_test(['a',1,'p,q'], '"a",1,"p,q"',
Skip Montanarob4a04172003-03-20 23:29:12 +0000183 quoting = csv.QUOTE_NONNUMERIC)
Andrew McNamarac89f2842005-01-12 07:44:42 +0000184 self._write_test(['a',1,'p,q'], '"a","1","p,q"',
Skip Montanarob4a04172003-03-20 23:29:12 +0000185 quoting = csv.QUOTE_ALL)
R. David Murraycde68cf2009-04-01 22:37:58 +0000186 self._write_test(['a\nb',1], '"a\nb","1"',
187 quoting = csv.QUOTE_ALL)
Skip Montanarob4a04172003-03-20 23:29:12 +0000188
189 def test_write_escape(self):
Andrew McNamarac89f2842005-01-12 07:44:42 +0000190 self._write_test(['a',1,'p,q'], 'a,1,"p,q"',
Skip Montanarob4a04172003-03-20 23:29:12 +0000191 escapechar='\\')
Serhiy Storchaka0b4e3552015-03-25 19:16:15 +0200192 self._write_error_test(csv.Error, ['a',1,'p,"q"'],
193 escapechar=None, doublequote=False)
Andrew McNamarac89f2842005-01-12 07:44:42 +0000194 self._write_test(['a',1,'p,"q"'], 'a,1,"p,\\"q\\""',
195 escapechar='\\', doublequote = False)
Tim Peters608c2ff2005-01-13 17:37:38 +0000196 self._write_test(['"'], '""""',
Andrew McNamarac89f2842005-01-12 07:44:42 +0000197 escapechar='\\', quoting = csv.QUOTE_MINIMAL)
Tim Peters608c2ff2005-01-13 17:37:38 +0000198 self._write_test(['"'], '\\"',
Andrew McNamarac89f2842005-01-12 07:44:42 +0000199 escapechar='\\', quoting = csv.QUOTE_MINIMAL,
200 doublequote = False)
Tim Peters608c2ff2005-01-13 17:37:38 +0000201 self._write_test(['"'], '\\"',
Andrew McNamarac89f2842005-01-12 07:44:42 +0000202 escapechar='\\', quoting = csv.QUOTE_NONE)
203 self._write_test(['a',1,'p,q'], 'a,1,p\\,q',
Skip Montanarob4a04172003-03-20 23:29:12 +0000204 escapechar='\\', quoting = csv.QUOTE_NONE)
205
Serhiy Storchaka7901b482015-03-30 09:09:54 +0300206 def test_write_iterable(self):
207 self._write_test(iter(['a', 1, 'p,q']), 'a,1,"p,q"')
208 self._write_test(iter(['a', 1, None]), 'a,1,')
209 self._write_test(iter([]), '')
210 self._write_test(iter([None]), '""')
211 self._write_error_test(csv.Error, iter([None]), quoting=csv.QUOTE_NONE)
212 self._write_test(iter([None, None]), ',')
213
Skip Montanarob4a04172003-03-20 23:29:12 +0000214 def test_writerows(self):
215 class BrokenFile:
216 def write(self, buf):
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200217 raise OSError
Skip Montanarob4a04172003-03-20 23:29:12 +0000218 writer = csv.writer(BrokenFile())
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200219 self.assertRaises(OSError, writer.writerows, [['a']])
Guido van Rossum46264582007-08-06 19:32:18 +0000220
Guido van Rossumf0c74162007-08-28 03:29:45 +0000221 with TemporaryFile("w+", newline='') as fileobj:
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000222 writer = csv.writer(fileobj)
223 self.assertRaises(TypeError, writer.writerows, None)
Licht Takeuchi20019002017-12-12 18:57:06 +0900224 writer.writerows([['a', 'b'], ['c', 'd']])
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000225 fileobj.seek(0)
Guido van Rossumf0c74162007-08-28 03:29:45 +0000226 self.assertEqual(fileobj.read(), "a,b\r\nc,d\r\n")
Tim Peters27f88362004-07-08 04:22:35 +0000227
Licht Takeuchi20019002017-12-12 18:57:06 +0900228 def test_writerows_with_none(self):
229 with TemporaryFile("w+", newline='') as fileobj:
230 writer = csv.writer(fileobj)
231 writer.writerows([['a', None], [None, 'd']])
232 fileobj.seek(0)
233 self.assertEqual(fileobj.read(), "a,\r\n,d\r\n")
234
235 with TemporaryFile("w+", newline='') as fileobj:
236 writer = csv.writer(fileobj)
237 writer.writerows([[None], ['a']])
238 fileobj.seek(0)
239 self.assertEqual(fileobj.read(), '""\r\na\r\n')
240
241 with TemporaryFile("w+", newline='') as fileobj:
242 writer = csv.writer(fileobj)
243 writer.writerows([['a'], [None]])
244 fileobj.seek(0)
245 self.assertEqual(fileobj.read(), 'a\r\n""\r\n')
246
Serhiy Storchakac88239f2020-06-22 11:21:59 +0300247 def test_writerows_errors(self):
248 with TemporaryFile("w+", newline='') as fileobj:
249 writer = csv.writer(fileobj)
250 self.assertRaises(TypeError, writer.writerows, None)
251 self.assertRaises(OSError, writer.writerows, BadIterable())
252
Stefan Krahe6996ed2012-11-02 14:44:20 +0100253 @support.cpython_only
Serhiy Storchaka4c8f09d2020-07-10 23:26:06 +0300254 @support.requires_legacy_unicode_capi
Inada Naoki902356a2020-07-20 12:02:50 +0900255 @warnings_helper.ignore_warnings(category=DeprecationWarning)
Stefan Krahe6996ed2012-11-02 14:44:20 +0100256 def test_writerows_legacy_strings(self):
257 import _testcapi
Stefan Krahe6996ed2012-11-02 14:44:20 +0100258 c = _testcapi.unicode_legacy_string('a')
259 with TemporaryFile("w+", newline='') as fileobj:
260 writer = csv.writer(fileobj)
261 writer.writerows([[c]])
262 fileobj.seek(0)
263 self.assertEqual(fileobj.read(), "a\r\n")
264
Skip Montanarob4a04172003-03-20 23:29:12 +0000265 def _read_test(self, input, expect, **kwargs):
266 reader = csv.reader(input, **kwargs)
267 result = list(reader)
268 self.assertEqual(result, expect)
269
270 def test_read_oddinputs(self):
271 self._read_test([], [])
272 self._read_test([''], [[]])
273 self.assertRaises(csv.Error, self._read_test,
274 ['"ab"c'], None, strict = 1)
275 # cannot handle null bytes for the moment
276 self.assertRaises(csv.Error, self._read_test,
277 ['ab\0c'], None, strict = 1)
278 self._read_test(['"ab"c'], [['abc']], doublequote = 0)
279
Amaury Forgeot d'Arc10c476d2007-11-19 21:20:21 +0000280 self.assertRaises(csv.Error, self._read_test,
281 [b'ab\0c'], None)
282
283
Skip Montanarob4a04172003-03-20 23:29:12 +0000284 def test_read_eol(self):
285 self._read_test(['a,b'], [['a','b']])
286 self._read_test(['a,b\n'], [['a','b']])
287 self._read_test(['a,b\r\n'], [['a','b']])
288 self._read_test(['a,b\r'], [['a','b']])
289 self.assertRaises(csv.Error, self._read_test, ['a,b\rc,d'], [])
290 self.assertRaises(csv.Error, self._read_test, ['a,b\nc,d'], [])
291 self.assertRaises(csv.Error, self._read_test, ['a,b\r\nc,d'], [])
292
Senthil Kumaran67b7b982012-09-25 02:30:27 -0700293 def test_read_eof(self):
294 self._read_test(['a,"'], [['a', '']])
295 self._read_test(['"a'], [['a']])
296 self._read_test(['^'], [['\n']], escapechar='^')
297 self.assertRaises(csv.Error, self._read_test, ['a,"'], [], strict=True)
298 self.assertRaises(csv.Error, self._read_test, ['"a'], [], strict=True)
299 self.assertRaises(csv.Error, self._read_test,
300 ['^'], [], escapechar='^', strict=True)
301
Skip Montanarob4a04172003-03-20 23:29:12 +0000302 def test_read_escape(self):
Andrew McNamara36a76912005-01-10 01:04:40 +0000303 self._read_test(['a,\\b,c'], [['a', 'b', 'c']], escapechar='\\')
Skip Montanarob4a04172003-03-20 23:29:12 +0000304 self._read_test(['a,b\\,c'], [['a', 'b,c']], escapechar='\\')
305 self._read_test(['a,"b\\,c"'], [['a', 'b,c']], escapechar='\\')
Andrew McNamara36a76912005-01-10 01:04:40 +0000306 self._read_test(['a,"b,\\c"'], [['a', 'b,c']], escapechar='\\')
Skip Montanarob4a04172003-03-20 23:29:12 +0000307 self._read_test(['a,"b,c\\""'], [['a', 'b,c"']], escapechar='\\')
308 self._read_test(['a,"b,c"\\'], [['a', 'b,c\\']], escapechar='\\')
309
Andrew McNamara1196cf12005-01-07 04:42:45 +0000310 def test_read_quoting(self):
311 self._read_test(['1,",3,",5'], [['1', ',3,', '5']])
312 self._read_test(['1,",3,",5'], [['1', '"', '3', '"', '5']],
313 quotechar=None, escapechar='\\')
314 self._read_test(['1,",3,",5'], [['1', '"', '3', '"', '5']],
315 quoting=csv.QUOTE_NONE, escapechar='\\')
Andrew McNamara0f0599d2005-01-12 09:45:18 +0000316 # will this fail where locale uses comma for decimals?
Andrew McNamara7f2053e2005-01-12 11:17:16 +0000317 self._read_test([',3,"5",7.3, 9'], [['', 3, '5', 7.3, 9]],
Andrew McNamara0f0599d2005-01-12 09:45:18 +0000318 quoting=csv.QUOTE_NONNUMERIC)
R. David Murraycde68cf2009-04-01 22:37:58 +0000319 self._read_test(['"a\nb", 7'], [['a\nb', ' 7']])
Tim Peters608c2ff2005-01-13 17:37:38 +0000320 self.assertRaises(ValueError, self._read_test,
Andrew McNamara0f0599d2005-01-12 09:45:18 +0000321 ['abc,3'], [[]],
322 quoting=csv.QUOTE_NONNUMERIC)
Andrew McNamara1196cf12005-01-07 04:42:45 +0000323
Skip Montanarob4a04172003-03-20 23:29:12 +0000324 def test_read_bigfield(self):
Andrew McNamarae4d05c42005-01-11 07:32:02 +0000325 # This exercises the buffer realloc functionality and field size
326 # limits.
Andrew McNamara31d88962005-01-12 03:45:10 +0000327 limit = csv.field_size_limit()
Andrew McNamaraaf1e3122005-01-12 01:55:21 +0000328 try:
329 size = 50000
330 bigstring = 'X' * size
331 bigline = '%s,%s' % (bigstring, bigstring)
332 self._read_test([bigline], [[bigstring, bigstring]])
Andrew McNamara31d88962005-01-12 03:45:10 +0000333 csv.field_size_limit(size)
Andrew McNamaraaf1e3122005-01-12 01:55:21 +0000334 self._read_test([bigline], [[bigstring, bigstring]])
Andrew McNamara31d88962005-01-12 03:45:10 +0000335 self.assertEqual(csv.field_size_limit(), size)
336 csv.field_size_limit(size-1)
Andrew McNamaraaf1e3122005-01-12 01:55:21 +0000337 self.assertRaises(csv.Error, self._read_test, [bigline], [])
Andrew McNamara31d88962005-01-12 03:45:10 +0000338 self.assertRaises(TypeError, csv.field_size_limit, None)
339 self.assertRaises(TypeError, csv.field_size_limit, 1, None)
Andrew McNamaraaf1e3122005-01-12 01:55:21 +0000340 finally:
Andrew McNamara31d88962005-01-12 03:45:10 +0000341 csv.field_size_limit(limit)
Skip Montanarob4a04172003-03-20 23:29:12 +0000342
Andrew McNamara7f2053e2005-01-12 11:17:16 +0000343 def test_read_linenum(self):
344 r = csv.reader(['line,1', 'line,2', 'line,3'])
345 self.assertEqual(r.line_num, 0)
Georg Brandla18af4e2007-04-21 15:47:16 +0000346 next(r)
Andrew McNamara7f2053e2005-01-12 11:17:16 +0000347 self.assertEqual(r.line_num, 1)
Georg Brandla18af4e2007-04-21 15:47:16 +0000348 next(r)
Andrew McNamara7f2053e2005-01-12 11:17:16 +0000349 self.assertEqual(r.line_num, 2)
Georg Brandla18af4e2007-04-21 15:47:16 +0000350 next(r)
Andrew McNamara7f2053e2005-01-12 11:17:16 +0000351 self.assertEqual(r.line_num, 3)
Georg Brandla18af4e2007-04-21 15:47:16 +0000352 self.assertRaises(StopIteration, next, r)
Andrew McNamara7f2053e2005-01-12 11:17:16 +0000353 self.assertEqual(r.line_num, 3)
354
R. David Murraycde68cf2009-04-01 22:37:58 +0000355 def test_roundtrip_quoteed_newlines(self):
356 with TemporaryFile("w+", newline='') as fileobj:
357 writer = csv.writer(fileobj)
R. David Murraycde68cf2009-04-01 22:37:58 +0000358 rows = [['a\nb','b'],['c','x\r\nd']]
359 writer.writerows(rows)
360 fileobj.seek(0)
361 for i, row in enumerate(csv.reader(fileobj)):
362 self.assertEqual(row, rows[i])
363
R David Murrayc7c42ef2013-03-19 22:41:47 -0400364 def test_roundtrip_escaped_unquoted_newlines(self):
365 with TemporaryFile("w+", newline='') as fileobj:
366 writer = csv.writer(fileobj,quoting=csv.QUOTE_NONE,escapechar="\\")
367 rows = [['a\nb','b'],['c','x\r\nd']]
368 writer.writerows(rows)
369 fileobj.seek(0)
370 for i, row in enumerate(csv.reader(fileobj,quoting=csv.QUOTE_NONE,escapechar="\\")):
371 self.assertEqual(row,rows[i])
372
Skip Montanarob4a04172003-03-20 23:29:12 +0000373class TestDialectRegistry(unittest.TestCase):
374 def test_registry_badargs(self):
375 self.assertRaises(TypeError, csv.list_dialects, None)
376 self.assertRaises(TypeError, csv.get_dialect)
377 self.assertRaises(csv.Error, csv.get_dialect, None)
378 self.assertRaises(csv.Error, csv.get_dialect, "nonesuch")
379 self.assertRaises(TypeError, csv.unregister_dialect)
380 self.assertRaises(csv.Error, csv.unregister_dialect, None)
381 self.assertRaises(csv.Error, csv.unregister_dialect, "nonesuch")
382 self.assertRaises(TypeError, csv.register_dialect, None)
383 self.assertRaises(TypeError, csv.register_dialect, None, None)
Andrew McNamaraaf1e3122005-01-12 01:55:21 +0000384 self.assertRaises(TypeError, csv.register_dialect, "nonesuch", 0, 0)
385 self.assertRaises(TypeError, csv.register_dialect, "nonesuch",
386 badargument=None)
387 self.assertRaises(TypeError, csv.register_dialect, "nonesuch",
388 quoting=None)
389 self.assertRaises(TypeError, csv.register_dialect, [])
Skip Montanarob4a04172003-03-20 23:29:12 +0000390
391 def test_registry(self):
392 class myexceltsv(csv.excel):
393 delimiter = "\t"
394 name = "myexceltsv"
395 expected_dialects = csv.list_dialects() + [name]
396 expected_dialects.sort()
397 csv.register_dialect(name, myexceltsv)
Éric Araujo5137d642010-12-02 22:16:19 +0000398 self.addCleanup(csv.unregister_dialect, name)
399 self.assertEqual(csv.get_dialect(name).delimiter, '\t')
400 got_dialects = sorted(csv.list_dialects())
401 self.assertEqual(expected_dialects, got_dialects)
Skip Montanarob4a04172003-03-20 23:29:12 +0000402
Andrew McNamara86625972005-01-11 01:28:33 +0000403 def test_register_kwargs(self):
404 name = 'fedcba'
405 csv.register_dialect(name, delimiter=';')
Éric Araujo5137d642010-12-02 22:16:19 +0000406 self.addCleanup(csv.unregister_dialect, name)
407 self.assertEqual(csv.get_dialect(name).delimiter, ';')
408 self.assertEqual([['X', 'Y', 'Z']], list(csv.reader(['X;Y;Z'], name)))
Andrew McNamara86625972005-01-11 01:28:33 +0000409
Skip Montanarob4a04172003-03-20 23:29:12 +0000410 def test_incomplete_dialect(self):
411 class myexceltsv(csv.Dialect):
412 delimiter = "\t"
413 self.assertRaises(csv.Error, myexceltsv)
414
415 def test_space_dialect(self):
416 class space(csv.excel):
417 delimiter = " "
418 quoting = csv.QUOTE_NONE
419 escapechar = "\\"
420
Guido van Rossum46264582007-08-06 19:32:18 +0000421 with TemporaryFile("w+") as fileobj:
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000422 fileobj.write("abc def\nc1ccccc1 benzene\n")
423 fileobj.seek(0)
Georg Brandla18af4e2007-04-21 15:47:16 +0000424 reader = csv.reader(fileobj, dialect=space())
425 self.assertEqual(next(reader), ["abc", "def"])
426 self.assertEqual(next(reader), ["c1ccccc1", "benzene"])
Guido van Rossum46264582007-08-06 19:32:18 +0000427
428 def compare_dialect_123(self, expected, *writeargs, **kwwriteargs):
Guido van Rossumf0c74162007-08-28 03:29:45 +0000429
430 with TemporaryFile("w+", newline='', encoding="utf-8") as fileobj:
431
Guido van Rossum46264582007-08-06 19:32:18 +0000432 writer = csv.writer(fileobj, *writeargs, **kwwriteargs)
433 writer.writerow([1,2,3])
434 fileobj.seek(0)
Guido van Rossumf0c74162007-08-28 03:29:45 +0000435 self.assertEqual(fileobj.read(), expected)
Tim Peters27f88362004-07-08 04:22:35 +0000436
Skip Montanarob4a04172003-03-20 23:29:12 +0000437 def test_dialect_apply(self):
438 class testA(csv.excel):
439 delimiter = "\t"
440 class testB(csv.excel):
441 delimiter = ":"
442 class testC(csv.excel):
443 delimiter = "|"
Guido van Rossum46264582007-08-06 19:32:18 +0000444 class testUni(csv.excel):
445 delimiter = "\u039B"
Skip Montanarob4a04172003-03-20 23:29:12 +0000446
447 csv.register_dialect('testC', testC)
448 try:
Guido van Rossum46264582007-08-06 19:32:18 +0000449 self.compare_dialect_123("1,2,3\r\n")
450 self.compare_dialect_123("1\t2\t3\r\n", testA)
451 self.compare_dialect_123("1:2:3\r\n", dialect=testB())
452 self.compare_dialect_123("1|2|3\r\n", dialect='testC')
453 self.compare_dialect_123("1;2;3\r\n", dialect=testA,
454 delimiter=';')
455 self.compare_dialect_123("1\u039B2\u039B3\r\n",
456 dialect=testUni)
Skip Montanarob4a04172003-03-20 23:29:12 +0000457
Skip Montanarob4a04172003-03-20 23:29:12 +0000458 finally:
459 csv.unregister_dialect('testC')
460
461 def test_bad_dialect(self):
462 # Unknown parameter
Andrew McNamara1196cf12005-01-07 04:42:45 +0000463 self.assertRaises(TypeError, csv.reader, [], bad_attr = 0)
Skip Montanarob4a04172003-03-20 23:29:12 +0000464 # Bad values
465 self.assertRaises(TypeError, csv.reader, [], delimiter = None)
466 self.assertRaises(TypeError, csv.reader, [], quoting = -1)
467 self.assertRaises(TypeError, csv.reader, [], quoting = 100)
468
Serhiy Storchakaf81be8a2015-12-25 21:04:29 +0200469 def test_copy(self):
470 for name in csv.list_dialects():
471 dialect = csv.get_dialect(name)
472 self.assertRaises(TypeError, copy.copy, dialect)
473
474 def test_pickle(self):
475 for name in csv.list_dialects():
476 dialect = csv.get_dialect(name)
477 for proto in range(pickle.HIGHEST_PROTOCOL + 1):
478 self.assertRaises(TypeError, pickle.dumps, dialect, proto)
479
Skip Montanarob4a04172003-03-20 23:29:12 +0000480class TestCsvBase(unittest.TestCase):
481 def readerAssertEqual(self, input, expected_result):
Amaury Forgeot d'Arc10c476d2007-11-19 21:20:21 +0000482 with TemporaryFile("w+", newline='') as fileobj:
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000483 fileobj.write(input)
484 fileobj.seek(0)
485 reader = csv.reader(fileobj, dialect = self.dialect)
486 fields = list(reader)
487 self.assertEqual(fields, expected_result)
Skip Montanarob4a04172003-03-20 23:29:12 +0000488
489 def writerAssertEqual(self, input, expected_result):
Guido van Rossumf0c74162007-08-28 03:29:45 +0000490 with TemporaryFile("w+", newline='') as fileobj:
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000491 writer = csv.writer(fileobj, dialect = self.dialect)
492 writer.writerows(input)
493 fileobj.seek(0)
Guido van Rossumf0c74162007-08-28 03:29:45 +0000494 self.assertEqual(fileobj.read(), expected_result)
Skip Montanarob4a04172003-03-20 23:29:12 +0000495
496class TestDialectExcel(TestCsvBase):
497 dialect = 'excel'
498
499 def test_single(self):
500 self.readerAssertEqual('abc', [['abc']])
501
502 def test_simple(self):
503 self.readerAssertEqual('1,2,3,4,5', [['1','2','3','4','5']])
504
505 def test_blankline(self):
506 self.readerAssertEqual('', [])
507
508 def test_empty_fields(self):
509 self.readerAssertEqual(',', [['', '']])
510
511 def test_singlequoted(self):
512 self.readerAssertEqual('""', [['']])
513
514 def test_singlequoted_left_empty(self):
515 self.readerAssertEqual('"",', [['','']])
516
517 def test_singlequoted_right_empty(self):
518 self.readerAssertEqual(',""', [['','']])
519
520 def test_single_quoted_quote(self):
521 self.readerAssertEqual('""""', [['"']])
522
523 def test_quoted_quotes(self):
524 self.readerAssertEqual('""""""', [['""']])
525
526 def test_inline_quote(self):
527 self.readerAssertEqual('a""b', [['a""b']])
528
529 def test_inline_quotes(self):
530 self.readerAssertEqual('a"b"c', [['a"b"c']])
531
532 def test_quotes_and_more(self):
Guido van Rossumd8faa362007-04-27 19:54:29 +0000533 # Excel would never write a field containing '"a"b', but when
534 # reading one, it will return 'ab'.
Skip Montanarob4a04172003-03-20 23:29:12 +0000535 self.readerAssertEqual('"a"b', [['ab']])
536
537 def test_lone_quote(self):
538 self.readerAssertEqual('a"b', [['a"b']])
539
540 def test_quote_and_quote(self):
Guido van Rossumd8faa362007-04-27 19:54:29 +0000541 # Excel would never write a field containing '"a" "b"', but when
542 # reading one, it will return 'a "b"'.
Skip Montanarob4a04172003-03-20 23:29:12 +0000543 self.readerAssertEqual('"a" "b"', [['a "b"']])
544
545 def test_space_and_quote(self):
546 self.readerAssertEqual(' "a"', [[' "a"']])
547
548 def test_quoted(self):
Tim Peters0eadaac2003-04-24 16:02:54 +0000549 self.readerAssertEqual('1,2,3,"I think, therefore I am",5,6',
550 [['1', '2', '3',
551 'I think, therefore I am',
Skip Montanarob4a04172003-03-20 23:29:12 +0000552 '5', '6']])
553
554 def test_quoted_quote(self):
555 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 +0000556 [['1', '2', '3',
557 '"I see," said the blind man',
Skip Montanarob4a04172003-03-20 23:29:12 +0000558 'as he picked up his hammer and saw']])
559
560 def test_quoted_nl(self):
561 input = '''\
5621,2,3,"""I see,""
563said the blind man","as he picked up his
564hammer and saw"
5659,8,7,6'''
566 self.readerAssertEqual(input,
Tim Peters0eadaac2003-04-24 16:02:54 +0000567 [['1', '2', '3',
568 '"I see,"\nsaid the blind man',
Skip Montanarob4a04172003-03-20 23:29:12 +0000569 'as he picked up his\nhammer and saw'],
570 ['9','8','7','6']])
571
572 def test_dubious_quote(self):
573 self.readerAssertEqual('12,12,1",', [['12', '12', '1"', '']])
574
575 def test_null(self):
576 self.writerAssertEqual([], '')
577
Georg Brandl89fad142010-03-14 10:23:39 +0000578 def test_single_writer(self):
Skip Montanarob4a04172003-03-20 23:29:12 +0000579 self.writerAssertEqual([['abc']], 'abc\r\n')
580
Georg Brandl89fad142010-03-14 10:23:39 +0000581 def test_simple_writer(self):
Skip Montanarob4a04172003-03-20 23:29:12 +0000582 self.writerAssertEqual([[1, 2, 'abc', 3, 4]], '1,2,abc,3,4\r\n')
583
584 def test_quotes(self):
585 self.writerAssertEqual([[1, 2, 'a"bc"', 3, 4]], '1,2,"a""bc""",3,4\r\n')
586
587 def test_quote_fieldsep(self):
588 self.writerAssertEqual([['abc,def']], '"abc,def"\r\n')
589
590 def test_newlines(self):
591 self.writerAssertEqual([[1, 2, 'a\nbc', 3, 4]], '1,2,"a\nbc",3,4\r\n')
592
593class EscapedExcel(csv.excel):
594 quoting = csv.QUOTE_NONE
595 escapechar = '\\'
596
597class TestEscapedExcel(TestCsvBase):
598 dialect = EscapedExcel()
599
600 def test_escape_fieldsep(self):
601 self.writerAssertEqual([['abc,def']], 'abc\\,def\r\n')
602
603 def test_read_escape_fieldsep(self):
604 self.readerAssertEqual('abc\\,def\r\n', [['abc,def']])
605
Georg Brandl7424dd32010-10-27 07:27:06 +0000606class TestDialectUnix(TestCsvBase):
607 dialect = 'unix'
608
609 def test_simple_writer(self):
610 self.writerAssertEqual([[1, 'abc def', 'abc']], '"1","abc def","abc"\n')
611
612 def test_simple_reader(self):
613 self.readerAssertEqual('"1","abc def","abc"\n', [['1', 'abc def', 'abc']])
614
Skip Montanarob4a04172003-03-20 23:29:12 +0000615class QuotedEscapedExcel(csv.excel):
616 quoting = csv.QUOTE_NONNUMERIC
617 escapechar = '\\'
618
619class TestQuotedEscapedExcel(TestCsvBase):
620 dialect = QuotedEscapedExcel()
621
622 def test_write_escape_fieldsep(self):
623 self.writerAssertEqual([['abc,def']], '"abc,def"\r\n')
624
625 def test_read_escape_fieldsep(self):
626 self.readerAssertEqual('"abc\\,def"\r\n', [['abc,def']])
627
Skip Montanarob4a04172003-03-20 23:29:12 +0000628class TestDictFields(unittest.TestCase):
629 ### "long" means the row is longer than the number of fieldnames
630 ### "short" means there are fewer elements in the row than fieldnames
Rémi Lapeyrefce5ff12019-05-10 03:50:11 +0200631 def test_writeheader_return_value(self):
632 with TemporaryFile("w+", newline='') as fileobj:
633 writer = csv.DictWriter(fileobj, fieldnames = ["f1", "f2", "f3"])
634 writeheader_return_value = writer.writeheader()
635 self.assertEqual(writeheader_return_value, 10)
636
Skip Montanarob4a04172003-03-20 23:29:12 +0000637 def test_write_simple_dict(self):
Guido van Rossumf0c74162007-08-28 03:29:45 +0000638 with TemporaryFile("w+", newline='') as fileobj:
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000639 writer = csv.DictWriter(fileobj, fieldnames = ["f1", "f2", "f3"])
R. David Murraybe0698b2010-02-23 22:57:58 +0000640 writer.writeheader()
641 fileobj.seek(0)
642 self.assertEqual(fileobj.readline(), "f1,f2,f3\r\n")
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000643 writer.writerow({"f1": 10, "f3": "abc"})
644 fileobj.seek(0)
R. David Murraybe0698b2010-02-23 22:57:58 +0000645 fileobj.readline() # header
Guido van Rossumf0c74162007-08-28 03:29:45 +0000646 self.assertEqual(fileobj.read(), "10,,abc\r\n")
Skip Montanarob4a04172003-03-20 23:29:12 +0000647
Antoine Pitrou05da1ef2014-04-29 01:58:06 +0200648 def test_write_multiple_dict_rows(self):
649 fileobj = StringIO()
650 writer = csv.DictWriter(fileobj, fieldnames=["f1", "f2", "f3"])
651 writer.writeheader()
652 self.assertEqual(fileobj.getvalue(), "f1,f2,f3\r\n")
653 writer.writerows([{"f1": 1, "f2": "abc", "f3": "f"},
654 {"f1": 2, "f2": 5, "f3": "xyz"}])
655 self.assertEqual(fileobj.getvalue(),
656 "f1,f2,f3\r\n1,abc,f\r\n2,5,xyz\r\n")
657
Skip Montanarob4a04172003-03-20 23:29:12 +0000658 def test_write_no_fields(self):
659 fileobj = StringIO()
660 self.assertRaises(TypeError, csv.DictWriter, fileobj)
661
R David Murrayfb099c92013-11-19 13:16:20 -0500662 def test_write_fields_not_in_fieldnames(self):
663 with TemporaryFile("w+", newline='') as fileobj:
664 writer = csv.DictWriter(fileobj, fieldnames = ["f1", "f2", "f3"])
665 # Of special note is the non-string key (issue 19449)
666 with self.assertRaises(ValueError) as cx:
667 writer.writerow({"f4": 10, "f2": "spam", 1: "abc"})
668 exception = str(cx.exception)
669 self.assertIn("fieldnames", exception)
670 self.assertIn("'f4'", exception)
671 self.assertNotIn("'f2'", exception)
672 self.assertIn("1", exception)
673
INADA Naoki0a421a22016-10-21 19:47:57 +0900674 def test_typo_in_extrasaction_raises_error(self):
675 fileobj = StringIO()
676 self.assertRaises(ValueError, csv.DictWriter, fileobj, ['f1', 'f2'],
677 extrasaction="raised")
678
679 def test_write_field_not_in_field_names_raise(self):
680 fileobj = StringIO()
681 writer = csv.DictWriter(fileobj, ['f1', 'f2'], extrasaction="raise")
682 dictrow = {'f0': 0, 'f1': 1, 'f2': 2, 'f3': 3}
683 self.assertRaises(ValueError, csv.DictWriter.writerow, writer, dictrow)
684
685 def test_write_field_not_in_field_names_ignore(self):
686 fileobj = StringIO()
687 writer = csv.DictWriter(fileobj, ['f1', 'f2'], extrasaction="ignore")
688 dictrow = {'f0': 0, 'f1': 1, 'f2': 2, 'f3': 3}
689 csv.DictWriter.writerow(writer, dictrow)
690 self.assertEqual(fileobj.getvalue(), "1,2\r\n")
691
Skip Montanarob4a04172003-03-20 23:29:12 +0000692 def test_read_dict_fields(self):
Guido van Rossum46264582007-08-06 19:32:18 +0000693 with TemporaryFile("w+") as fileobj:
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000694 fileobj.write("1,2,abc\r\n")
695 fileobj.seek(0)
696 reader = csv.DictReader(fileobj,
697 fieldnames=["f1", "f2", "f3"])
Georg Brandla18af4e2007-04-21 15:47:16 +0000698 self.assertEqual(next(reader), {"f1": '1', "f2": '2', "f3": 'abc'})
Skip Montanarob4a04172003-03-20 23:29:12 +0000699
Skip Montanarodffeed32003-10-03 14:03:01 +0000700 def test_read_dict_no_fieldnames(self):
Guido van Rossum46264582007-08-06 19:32:18 +0000701 with TemporaryFile("w+") as fileobj:
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000702 fileobj.write("f1,f2,f3\r\n1,2,abc\r\n")
703 fileobj.seek(0)
704 reader = csv.DictReader(fileobj)
Georg Brandla18af4e2007-04-21 15:47:16 +0000705 self.assertEqual(next(reader), {"f1": '1', "f2": '2', "f3": 'abc'})
Skip Montanaroaf8fcfa2008-08-09 19:44:22 +0000706 self.assertEqual(reader.fieldnames, ["f1", "f2", "f3"])
707
708 # Two test cases to make sure existing ways of implicitly setting
709 # fieldnames continue to work. Both arise from discussion in issue3436.
710 def test_read_dict_fieldnames_from_file(self):
711 with TemporaryFile("w+") as fileobj:
712 fileobj.write("f1,f2,f3\r\n1,2,abc\r\n")
713 fileobj.seek(0)
714 reader = csv.DictReader(fileobj,
715 fieldnames=next(csv.reader(fileobj)))
716 self.assertEqual(reader.fieldnames, ["f1", "f2", "f3"])
717 self.assertEqual(next(reader), {"f1": '1', "f2": '2', "f3": 'abc'})
718
719 def test_read_dict_fieldnames_chain(self):
720 import itertools
721 with TemporaryFile("w+") as fileobj:
722 fileobj.write("f1,f2,f3\r\n1,2,abc\r\n")
723 fileobj.seek(0)
724 reader = csv.DictReader(fileobj)
725 first = next(reader)
726 for row in itertools.chain([first], reader):
727 self.assertEqual(reader.fieldnames, ["f1", "f2", "f3"])
728 self.assertEqual(row, {"f1": '1', "f2": '2', "f3": 'abc'})
Skip Montanarodffeed32003-10-03 14:03:01 +0000729
Skip Montanarob4a04172003-03-20 23:29:12 +0000730 def test_read_long(self):
Guido van Rossum46264582007-08-06 19:32:18 +0000731 with TemporaryFile("w+") as fileobj:
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000732 fileobj.write("1,2,abc,4,5,6\r\n")
733 fileobj.seek(0)
734 reader = csv.DictReader(fileobj,
735 fieldnames=["f1", "f2"])
Georg Brandla18af4e2007-04-21 15:47:16 +0000736 self.assertEqual(next(reader), {"f1": '1', "f2": '2',
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000737 None: ["abc", "4", "5", "6"]})
Skip Montanarob4a04172003-03-20 23:29:12 +0000738
739 def test_read_long_with_rest(self):
Guido van Rossum46264582007-08-06 19:32:18 +0000740 with TemporaryFile("w+") as fileobj:
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000741 fileobj.write("1,2,abc,4,5,6\r\n")
742 fileobj.seek(0)
743 reader = csv.DictReader(fileobj,
744 fieldnames=["f1", "f2"], restkey="_rest")
Georg Brandla18af4e2007-04-21 15:47:16 +0000745 self.assertEqual(next(reader), {"f1": '1', "f2": '2',
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000746 "_rest": ["abc", "4", "5", "6"]})
Skip Montanarob4a04172003-03-20 23:29:12 +0000747
Skip Montanarodffeed32003-10-03 14:03:01 +0000748 def test_read_long_with_rest_no_fieldnames(self):
Guido van Rossum46264582007-08-06 19:32:18 +0000749 with TemporaryFile("w+") as fileobj:
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000750 fileobj.write("f1,f2\r\n1,2,abc,4,5,6\r\n")
751 fileobj.seek(0)
752 reader = csv.DictReader(fileobj, restkey="_rest")
Skip Montanaroaf8fcfa2008-08-09 19:44:22 +0000753 self.assertEqual(reader.fieldnames, ["f1", "f2"])
Georg Brandla18af4e2007-04-21 15:47:16 +0000754 self.assertEqual(next(reader), {"f1": '1', "f2": '2',
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000755 "_rest": ["abc", "4", "5", "6"]})
Skip Montanarodffeed32003-10-03 14:03:01 +0000756
Skip Montanarob4a04172003-03-20 23:29:12 +0000757 def test_read_short(self):
Guido van Rossum46264582007-08-06 19:32:18 +0000758 with TemporaryFile("w+") as fileobj:
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000759 fileobj.write("1,2,abc,4,5,6\r\n1,2,abc\r\n")
760 fileobj.seek(0)
761 reader = csv.DictReader(fileobj,
762 fieldnames="1 2 3 4 5 6".split(),
763 restval="DEFAULT")
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": '4', "5": '5', "6": '6'})
Georg Brandla18af4e2007-04-21 15:47:16 +0000766 self.assertEqual(next(reader), {"1": '1', "2": '2', "3": 'abc',
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000767 "4": 'DEFAULT', "5": 'DEFAULT',
768 "6": 'DEFAULT'})
Skip Montanarob4a04172003-03-20 23:29:12 +0000769
Skip Montanaro1546bc42003-06-12 02:40:22 +0000770 def test_read_multi(self):
771 sample = [
772 '2147483648,43.0e12,17,abc,def\r\n',
773 '147483648,43.0e2,17,abc,def\r\n',
774 '47483648,43.0,170,abc,def\r\n'
775 ]
776
777 reader = csv.DictReader(sample,
778 fieldnames="i1 float i2 s1 s2".split())
Georg Brandla18af4e2007-04-21 15:47:16 +0000779 self.assertEqual(next(reader), {"i1": '2147483648',
Skip Montanaro1546bc42003-06-12 02:40:22 +0000780 "float": '43.0e12',
781 "i2": '17',
782 "s1": 'abc',
783 "s2": 'def'})
784
Skip Montanarob4a04172003-03-20 23:29:12 +0000785 def test_read_with_blanks(self):
786 reader = csv.DictReader(["1,2,abc,4,5,6\r\n","\r\n",
787 "1,2,abc,4,5,6\r\n"],
788 fieldnames="1 2 3 4 5 6".split())
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'})
Georg Brandla18af4e2007-04-21 15:47:16 +0000791 self.assertEqual(next(reader), {"1": '1', "2": '2', "3": 'abc',
Skip Montanarob4a04172003-03-20 23:29:12 +0000792 "4": '4', "5": '5', "6": '6'})
793
Skip Montanaro3f7a9482003-09-06 19:52:12 +0000794 def test_read_semi_sep(self):
795 reader = csv.DictReader(["1;2;abc;4;5;6\r\n"],
796 fieldnames="1 2 3 4 5 6".split(),
797 delimiter=';')
Georg Brandla18af4e2007-04-21 15:47:16 +0000798 self.assertEqual(next(reader), {"1": '1', "2": '2', "3": 'abc',
Skip Montanaro3f7a9482003-09-06 19:52:12 +0000799 "4": '4', "5": '5', "6": '6'})
800
Skip Montanarob4a04172003-03-20 23:29:12 +0000801class TestArrayWrites(unittest.TestCase):
802 def test_int_write(self):
803 import array
804 contents = [(20-i) for i in range(20)]
805 a = array.array('i', contents)
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000806
Guido van Rossumf0c74162007-08-28 03:29:45 +0000807 with TemporaryFile("w+", newline='') as fileobj:
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000808 writer = csv.writer(fileobj, dialect="excel")
809 writer.writerow(a)
810 expected = ",".join([str(i) for i in a])+"\r\n"
811 fileobj.seek(0)
Guido van Rossumf0c74162007-08-28 03:29:45 +0000812 self.assertEqual(fileobj.read(), expected)
Skip Montanarob4a04172003-03-20 23:29:12 +0000813
814 def test_double_write(self):
815 import array
816 contents = [(20-i)*0.1 for i in range(20)]
817 a = array.array('d', contents)
Guido van Rossumf0c74162007-08-28 03:29:45 +0000818 with TemporaryFile("w+", newline='') as fileobj:
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000819 writer = csv.writer(fileobj, dialect="excel")
820 writer.writerow(a)
821 expected = ",".join([str(i) for i in a])+"\r\n"
822 fileobj.seek(0)
Guido van Rossumf0c74162007-08-28 03:29:45 +0000823 self.assertEqual(fileobj.read(), expected)
Skip Montanarob4a04172003-03-20 23:29:12 +0000824
825 def test_float_write(self):
826 import array
827 contents = [(20-i)*0.1 for i in range(20)]
828 a = array.array('f', contents)
Guido van Rossumf0c74162007-08-28 03:29:45 +0000829 with TemporaryFile("w+", newline='') as fileobj:
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000830 writer = csv.writer(fileobj, dialect="excel")
831 writer.writerow(a)
832 expected = ",".join([str(i) for i in a])+"\r\n"
833 fileobj.seek(0)
Guido van Rossumf0c74162007-08-28 03:29:45 +0000834 self.assertEqual(fileobj.read(), expected)
Skip Montanarob4a04172003-03-20 23:29:12 +0000835
836 def test_char_write(self):
837 import array, string
Martin v. Löwis967f1e32007-08-14 09:23:10 +0000838 a = array.array('u', string.ascii_letters)
Guido van Rossum46264582007-08-06 19:32:18 +0000839
Guido van Rossumf0c74162007-08-28 03:29:45 +0000840 with TemporaryFile("w+", newline='') as fileobj:
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000841 writer = csv.writer(fileobj, dialect="excel")
842 writer.writerow(a)
843 expected = ",".join(a)+"\r\n"
844 fileobj.seek(0)
Guido van Rossumf0c74162007-08-28 03:29:45 +0000845 self.assertEqual(fileobj.read(), expected)
Skip Montanarob4a04172003-03-20 23:29:12 +0000846
847class TestDialectValidity(unittest.TestCase):
848 def test_quoting(self):
849 class mydialect(csv.Dialect):
850 delimiter = ";"
851 escapechar = '\\'
852 doublequote = False
853 skipinitialspace = True
854 lineterminator = '\r\n'
855 quoting = csv.QUOTE_NONE
856 d = mydialect()
Serhiy Storchakacac23a52013-12-19 16:27:18 +0200857 self.assertEqual(d.quoting, csv.QUOTE_NONE)
Skip Montanarob4a04172003-03-20 23:29:12 +0000858
859 mydialect.quoting = None
860 self.assertRaises(csv.Error, mydialect)
861
Skip Montanarob4a04172003-03-20 23:29:12 +0000862 mydialect.doublequote = True
863 mydialect.quoting = csv.QUOTE_ALL
864 mydialect.quotechar = '"'
865 d = mydialect()
Serhiy Storchakacac23a52013-12-19 16:27:18 +0200866 self.assertEqual(d.quoting, csv.QUOTE_ALL)
867 self.assertEqual(d.quotechar, '"')
868 self.assertTrue(d.doublequote)
Skip Montanarob4a04172003-03-20 23:29:12 +0000869
870 mydialect.quotechar = "''"
Serhiy Storchakacac23a52013-12-19 16:27:18 +0200871 with self.assertRaises(csv.Error) as cm:
872 mydialect()
873 self.assertEqual(str(cm.exception),
Berker Peksag0f41acb2014-07-27 23:22:34 +0300874 '"quotechar" must be a 1-character string')
Skip Montanarob4a04172003-03-20 23:29:12 +0000875
876 mydialect.quotechar = 4
Serhiy Storchakacac23a52013-12-19 16:27:18 +0200877 with self.assertRaises(csv.Error) as cm:
878 mydialect()
879 self.assertEqual(str(cm.exception),
880 '"quotechar" must be string, not int')
Skip Montanarob4a04172003-03-20 23:29:12 +0000881
882 def test_delimiter(self):
883 class mydialect(csv.Dialect):
884 delimiter = ";"
885 escapechar = '\\'
886 doublequote = False
887 skipinitialspace = True
888 lineterminator = '\r\n'
889 quoting = csv.QUOTE_NONE
890 d = mydialect()
Serhiy Storchakacac23a52013-12-19 16:27:18 +0200891 self.assertEqual(d.delimiter, ";")
Skip Montanarob4a04172003-03-20 23:29:12 +0000892
893 mydialect.delimiter = ":::"
Serhiy Storchakacac23a52013-12-19 16:27:18 +0200894 with self.assertRaises(csv.Error) as cm:
895 mydialect()
896 self.assertEqual(str(cm.exception),
Berker Peksag0f41acb2014-07-27 23:22:34 +0300897 '"delimiter" must be a 1-character string')
Serhiy Storchakacac23a52013-12-19 16:27:18 +0200898
899 mydialect.delimiter = ""
900 with self.assertRaises(csv.Error) as cm:
901 mydialect()
902 self.assertEqual(str(cm.exception),
Berker Peksag0f41acb2014-07-27 23:22:34 +0300903 '"delimiter" must be a 1-character string')
Serhiy Storchakacac23a52013-12-19 16:27:18 +0200904
905 mydialect.delimiter = b","
906 with self.assertRaises(csv.Error) as cm:
907 mydialect()
908 self.assertEqual(str(cm.exception),
909 '"delimiter" must be string, not bytes')
Skip Montanarob4a04172003-03-20 23:29:12 +0000910
911 mydialect.delimiter = 4
Serhiy Storchakacac23a52013-12-19 16:27:18 +0200912 with self.assertRaises(csv.Error) as cm:
913 mydialect()
914 self.assertEqual(str(cm.exception),
915 '"delimiter" must be string, not int')
Skip Montanarob4a04172003-03-20 23:29:12 +0000916
917 def test_lineterminator(self):
918 class mydialect(csv.Dialect):
919 delimiter = ";"
920 escapechar = '\\'
921 doublequote = False
922 skipinitialspace = True
923 lineterminator = '\r\n'
924 quoting = csv.QUOTE_NONE
925 d = mydialect()
Serhiy Storchakacac23a52013-12-19 16:27:18 +0200926 self.assertEqual(d.lineterminator, '\r\n')
Skip Montanarob4a04172003-03-20 23:29:12 +0000927
928 mydialect.lineterminator = ":::"
929 d = mydialect()
Serhiy Storchakacac23a52013-12-19 16:27:18 +0200930 self.assertEqual(d.lineterminator, ":::")
Skip Montanarob4a04172003-03-20 23:29:12 +0000931
932 mydialect.lineterminator = 4
Serhiy Storchakacac23a52013-12-19 16:27:18 +0200933 with self.assertRaises(csv.Error) as cm:
934 mydialect()
935 self.assertEqual(str(cm.exception),
936 '"lineterminator" must be a string')
Skip Montanarob4a04172003-03-20 23:29:12 +0000937
Victor Stinner6a31b0f2014-01-02 12:53:13 +0100938 def test_invalid_chars(self):
939 def create_invalid(field_name, value):
940 class mydialect(csv.Dialect):
941 pass
942 setattr(mydialect, field_name, value)
943 d = mydialect()
944
945 for field_name in ("delimiter", "escapechar", "quotechar"):
Victor Stinner009771e2014-01-02 12:53:50 +0100946 with self.subTest(field_name=field_name):
947 self.assertRaises(csv.Error, create_invalid, field_name, "")
948 self.assertRaises(csv.Error, create_invalid, field_name, "abc")
949 self.assertRaises(csv.Error, create_invalid, field_name, b'x')
950 self.assertRaises(csv.Error, create_invalid, field_name, 5)
Victor Stinner6a31b0f2014-01-02 12:53:13 +0100951
Skip Montanarob4a04172003-03-20 23:29:12 +0000952
Skip Montanaro48816c62003-04-25 14:43:14 +0000953class TestSniffer(unittest.TestCase):
954 sample1 = """\
955Harry's, Arlington Heights, IL, 2/1/03, Kimi Hayes
956Shark City, Glendale Heights, IL, 12/28/02, Prezence
957Tommy's Place, Blue Island, IL, 12/28/02, Blue Sunday/White Crow
958Stonecutters Seafood and Chop House, Lemont, IL, 12/19/02, Week Back
959"""
960 sample2 = """\
961'Harry''s':'Arlington Heights':'IL':'2/1/03':'Kimi Hayes'
962'Shark City':'Glendale Heights':'IL':'12/28/02':'Prezence'
963'Tommy''s Place':'Blue Island':'IL':'12/28/02':'Blue Sunday/White Crow'
Benjamin Peterson4ac9ce42009-10-04 14:49:41 +0000964'Stonecutters ''Seafood'' and Chop House':'Lemont':'IL':'12/19/02':'Week Back'
Skip Montanaro48816c62003-04-25 14:43:14 +0000965"""
R David Murray925a3222013-06-29 18:40:53 -0400966 header1 = '''\
Skip Montanaro48816c62003-04-25 14:43:14 +0000967"venue","city","state","date","performers"
968'''
Skip Montanaro77892372003-05-19 15:33:36 +0000969 sample3 = '''\
97005/05/03?05/05/03?05/05/03?05/05/03?05/05/03?05/05/03
97105/05/03?05/05/03?05/05/03?05/05/03?05/05/03?05/05/03
97205/05/03?05/05/03?05/05/03?05/05/03?05/05/03?05/05/03
973'''
974
Skip Montanaro1546bc42003-06-12 02:40:22 +0000975 sample4 = '''\
9762147483648;43.0e12;17;abc;def
977147483648;43.0e2;17;abc;def
97847483648;43.0;170;abc;def
979'''
980
Skip Montanaro91bb70c2005-12-28 15:37:25 +0000981 sample5 = "aaa\tbbb\r\nAAA\t\r\nBBB\t\r\n"
Skip Montanaro39b29be2005-12-30 05:09:48 +0000982 sample6 = "a|b|c\r\nd|e|f\r\n"
983 sample7 = "'a'|'b'|'c'\r\n'd'|e|f\r\n"
Skip Montanaro91bb70c2005-12-28 15:37:25 +0000984
R David Murray925a3222013-06-29 18:40:53 -0400985# Issue 18155: Use a delimiter that is a special char to regex:
986
987 header2 = '''\
988"venue"+"city"+"state"+"date"+"performers"
989'''
990 sample8 = """\
991Harry's+ Arlington Heights+ IL+ 2/1/03+ Kimi Hayes
992Shark City+ Glendale Heights+ IL+ 12/28/02+ Prezence
993Tommy's Place+ Blue Island+ IL+ 12/28/02+ Blue Sunday/White Crow
994Stonecutters Seafood and Chop House+ Lemont+ IL+ 12/19/02+ Week Back
995"""
996 sample9 = """\
997'Harry''s'+ Arlington Heights'+ 'IL'+ '2/1/03'+ 'Kimi Hayes'
998'Shark City'+ Glendale Heights'+' IL'+ '12/28/02'+ 'Prezence'
999'Tommy''s Place'+ Blue Island'+ 'IL'+ '12/28/02'+ 'Blue Sunday/White Crow'
1000'Stonecutters ''Seafood'' and Chop House'+ 'Lemont'+ 'IL'+ '12/19/02'+ 'Week Back'
1001"""
1002
Skip Montanaro48816c62003-04-25 14:43:14 +00001003 def test_has_header(self):
1004 sniffer = csv.Sniffer()
Serhiy Storchaka323748a2018-07-26 13:21:09 +03001005 self.assertIs(sniffer.has_header(self.sample1), False)
1006 self.assertIs(sniffer.has_header(self.header1 + self.sample1), True)
R David Murray925a3222013-06-29 18:40:53 -04001007
1008 def test_has_header_regex_special_delimiter(self):
1009 sniffer = csv.Sniffer()
Serhiy Storchaka323748a2018-07-26 13:21:09 +03001010 self.assertIs(sniffer.has_header(self.sample8), False)
1011 self.assertIs(sniffer.has_header(self.header2 + self.sample8), True)
Skip Montanaro48816c62003-04-25 14:43:14 +00001012
Serhiy Storchaka24112922018-02-09 20:00:49 +02001013 def test_guess_quote_and_delimiter(self):
1014 sniffer = csv.Sniffer()
1015 for header in (";'123;4';", "'123;4';", ";'123;4'", "'123;4'"):
1016 with self.subTest(header):
1017 dialect = sniffer.sniff(header, ",;")
1018 self.assertEqual(dialect.delimiter, ';')
1019 self.assertEqual(dialect.quotechar, "'")
1020 self.assertIs(dialect.doublequote, False)
1021 self.assertIs(dialect.skipinitialspace, False)
1022
Skip Montanaro48816c62003-04-25 14:43:14 +00001023 def test_sniff(self):
1024 sniffer = csv.Sniffer()
1025 dialect = sniffer.sniff(self.sample1)
1026 self.assertEqual(dialect.delimiter, ",")
1027 self.assertEqual(dialect.quotechar, '"')
Serhiy Storchaka323748a2018-07-26 13:21:09 +03001028 self.assertIs(dialect.skipinitialspace, True)
Skip Montanaro48816c62003-04-25 14:43:14 +00001029
1030 dialect = sniffer.sniff(self.sample2)
1031 self.assertEqual(dialect.delimiter, ":")
1032 self.assertEqual(dialect.quotechar, "'")
Serhiy Storchaka323748a2018-07-26 13:21:09 +03001033 self.assertIs(dialect.skipinitialspace, False)
Skip Montanaro48816c62003-04-25 14:43:14 +00001034
Skip Montanaro77892372003-05-19 15:33:36 +00001035 def test_delimiters(self):
1036 sniffer = csv.Sniffer()
1037 dialect = sniffer.sniff(self.sample3)
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00001038 # given that all three lines in sample3 are equal,
1039 # I think that any character could have been 'guessed' as the
1040 # delimiter, depending on dictionary order
Benjamin Peterson577473f2010-01-19 00:09:57 +00001041 self.assertIn(dialect.delimiter, self.sample3)
Skip Montanaro77892372003-05-19 15:33:36 +00001042 dialect = sniffer.sniff(self.sample3, delimiters="?,")
1043 self.assertEqual(dialect.delimiter, "?")
1044 dialect = sniffer.sniff(self.sample3, delimiters="/,")
1045 self.assertEqual(dialect.delimiter, "/")
Skip Montanaro1546bc42003-06-12 02:40:22 +00001046 dialect = sniffer.sniff(self.sample4)
1047 self.assertEqual(dialect.delimiter, ";")
Skip Montanaro91bb70c2005-12-28 15:37:25 +00001048 dialect = sniffer.sniff(self.sample5)
1049 self.assertEqual(dialect.delimiter, "\t")
Skip Montanaro39b29be2005-12-30 05:09:48 +00001050 dialect = sniffer.sniff(self.sample6)
1051 self.assertEqual(dialect.delimiter, "|")
1052 dialect = sniffer.sniff(self.sample7)
1053 self.assertEqual(dialect.delimiter, "|")
1054 self.assertEqual(dialect.quotechar, "'")
R David Murray925a3222013-06-29 18:40:53 -04001055 dialect = sniffer.sniff(self.sample8)
1056 self.assertEqual(dialect.delimiter, '+')
1057 dialect = sniffer.sniff(self.sample9)
1058 self.assertEqual(dialect.delimiter, '+')
1059 self.assertEqual(dialect.quotechar, "'")
Skip Montanaro77892372003-05-19 15:33:36 +00001060
Benjamin Peterson4ac9ce42009-10-04 14:49:41 +00001061 def test_doublequote(self):
1062 sniffer = csv.Sniffer()
R David Murray925a3222013-06-29 18:40:53 -04001063 dialect = sniffer.sniff(self.header1)
1064 self.assertFalse(dialect.doublequote)
1065 dialect = sniffer.sniff(self.header2)
Benjamin Peterson4ac9ce42009-10-04 14:49:41 +00001066 self.assertFalse(dialect.doublequote)
1067 dialect = sniffer.sniff(self.sample2)
1068 self.assertTrue(dialect.doublequote)
R David Murray925a3222013-06-29 18:40:53 -04001069 dialect = sniffer.sniff(self.sample8)
1070 self.assertFalse(dialect.doublequote)
1071 dialect = sniffer.sniff(self.sample9)
1072 self.assertTrue(dialect.doublequote)
Benjamin Peterson4ac9ce42009-10-04 14:49:41 +00001073
Serhiy Storchaka43767632013-11-03 21:31:38 +02001074class NUL:
1075 def write(s, *args):
1076 pass
1077 writelines = write
Skip Montanarob4a04172003-03-20 23:29:12 +00001078
Serhiy Storchaka43767632013-11-03 21:31:38 +02001079@unittest.skipUnless(hasattr(sys, "gettotalrefcount"),
1080 'requires sys.gettotalrefcount()')
1081class TestLeaks(unittest.TestCase):
1082 def test_create_read(self):
1083 delta = 0
1084 lastrc = sys.gettotalrefcount()
1085 for i in range(20):
1086 gc.collect()
1087 self.assertEqual(gc.garbage, [])
1088 rc = sys.gettotalrefcount()
1089 csv.reader(["a,b,c\r\n"])
1090 csv.reader(["a,b,c\r\n"])
1091 csv.reader(["a,b,c\r\n"])
1092 delta = rc-lastrc
1093 lastrc = rc
1094 # if csv.reader() leaks, last delta should be 3 or more
Serhiy Storchaka323748a2018-07-26 13:21:09 +03001095 self.assertLess(delta, 3)
Skip Montanarob4a04172003-03-20 23:29:12 +00001096
Serhiy Storchaka43767632013-11-03 21:31:38 +02001097 def test_create_write(self):
1098 delta = 0
1099 lastrc = sys.gettotalrefcount()
1100 s = NUL()
1101 for i in range(20):
1102 gc.collect()
1103 self.assertEqual(gc.garbage, [])
1104 rc = sys.gettotalrefcount()
1105 csv.writer(s)
1106 csv.writer(s)
1107 csv.writer(s)
1108 delta = rc-lastrc
1109 lastrc = rc
1110 # if csv.writer() leaks, last delta should be 3 or more
Serhiy Storchaka323748a2018-07-26 13:21:09 +03001111 self.assertLess(delta, 3)
Skip Montanarob4a04172003-03-20 23:29:12 +00001112
Serhiy Storchaka43767632013-11-03 21:31:38 +02001113 def test_read(self):
1114 delta = 0
1115 rows = ["a,b,c\r\n"]*5
1116 lastrc = sys.gettotalrefcount()
1117 for i in range(20):
1118 gc.collect()
1119 self.assertEqual(gc.garbage, [])
1120 rc = sys.gettotalrefcount()
1121 rdr = csv.reader(rows)
1122 for row in rdr:
1123 pass
1124 delta = rc-lastrc
1125 lastrc = rc
1126 # if reader leaks during read, delta should be 5 or more
Serhiy Storchaka323748a2018-07-26 13:21:09 +03001127 self.assertLess(delta, 5)
Skip Montanarob4a04172003-03-20 23:29:12 +00001128
Serhiy Storchaka43767632013-11-03 21:31:38 +02001129 def test_write(self):
1130 delta = 0
1131 rows = [[1,2,3]]*5
1132 s = NUL()
1133 lastrc = sys.gettotalrefcount()
1134 for i in range(20):
1135 gc.collect()
1136 self.assertEqual(gc.garbage, [])
1137 rc = sys.gettotalrefcount()
1138 writer = csv.writer(s)
1139 for row in rows:
1140 writer.writerow(row)
1141 delta = rc-lastrc
1142 lastrc = rc
1143 # if writer leaks during write, last delta should be 5 or more
Serhiy Storchaka323748a2018-07-26 13:21:09 +03001144 self.assertLess(delta, 5)
Skip Montanarob4a04172003-03-20 23:29:12 +00001145
Guido van Rossum46264582007-08-06 19:32:18 +00001146class TestUnicode(unittest.TestCase):
1147
1148 names = ["Martin von Löwis",
1149 "Marc André Lemburg",
1150 "Guido van Rossum",
1151 "François Pinard"]
1152
1153 def test_unicode_read(self):
Guido van Rossumf0c74162007-08-28 03:29:45 +00001154 with TemporaryFile("w+", newline='', encoding="utf-8") as fileobj:
Guido van Rossum46264582007-08-06 19:32:18 +00001155 fileobj.write(",".join(self.names) + "\r\n")
Guido van Rossum46264582007-08-06 19:32:18 +00001156 fileobj.seek(0)
1157 reader = csv.reader(fileobj)
1158 self.assertEqual(list(reader), [self.names])
1159
1160
1161 def test_unicode_write(self):
Guido van Rossumf0c74162007-08-28 03:29:45 +00001162 with TemporaryFile("w+", newline='', encoding="utf-8") as fileobj:
1163 writer = csv.writer(fileobj)
Guido van Rossum46264582007-08-06 19:32:18 +00001164 writer.writerow(self.names)
1165 expected = ",".join(self.names)+"\r\n"
1166 fileobj.seek(0)
Guido van Rossumf0c74162007-08-28 03:29:45 +00001167 self.assertEqual(fileobj.read(), expected)
Guido van Rossum46264582007-08-06 19:32:18 +00001168
Raymond Hettinger43ca4522016-08-30 12:35:50 -07001169class KeyOrderingTest(unittest.TestCase):
1170
1171 def test_ordering_for_the_dict_reader_and_writer(self):
1172 resultset = set()
1173 for keys in permutations("abcde"):
1174 with TemporaryFile('w+', newline='', encoding="utf-8") as fileobject:
1175 dw = csv.DictWriter(fileobject, keys)
1176 dw.writeheader()
1177 fileobject.seek(0)
1178 dr = csv.DictReader(fileobject)
1179 kt = tuple(dr.fieldnames)
1180 self.assertEqual(keys, kt)
1181 resultset.add(kt)
1182 # Final sanity check: were all permutations unique?
1183 self.assertEqual(len(resultset), 120, "Key ordering: some key permutations not collected (expected 120)")
Guido van Rossum46264582007-08-06 19:32:18 +00001184
Raymond Hettinger8ca35702016-08-30 12:57:26 -07001185 def test_ordered_dict_reader(self):
1186 data = dedent('''\
1187 FirstName,LastName
1188 Eric,Idle
1189 Graham,Chapman,Over1,Over2
1190
1191 Under1
1192 John,Cleese
1193 ''').splitlines()
1194
1195 self.assertEqual(list(csv.DictReader(data)),
1196 [OrderedDict([('FirstName', 'Eric'), ('LastName', 'Idle')]),
1197 OrderedDict([('FirstName', 'Graham'), ('LastName', 'Chapman'),
1198 (None, ['Over1', 'Over2'])]),
1199 OrderedDict([('FirstName', 'Under1'), ('LastName', None)]),
1200 OrderedDict([('FirstName', 'John'), ('LastName', 'Cleese')]),
1201 ])
1202
1203 self.assertEqual(list(csv.DictReader(data, restkey='OtherInfo')),
1204 [OrderedDict([('FirstName', 'Eric'), ('LastName', 'Idle')]),
1205 OrderedDict([('FirstName', 'Graham'), ('LastName', 'Chapman'),
1206 ('OtherInfo', ['Over1', 'Over2'])]),
1207 OrderedDict([('FirstName', 'Under1'), ('LastName', None)]),
1208 OrderedDict([('FirstName', 'John'), ('LastName', 'Cleese')]),
1209 ])
1210
1211 del data[0] # Remove the header row
1212 self.assertEqual(list(csv.DictReader(data, fieldnames=['fname', 'lname'])),
1213 [OrderedDict([('fname', 'Eric'), ('lname', 'Idle')]),
1214 OrderedDict([('fname', 'Graham'), ('lname', 'Chapman'),
1215 (None, ['Over1', 'Over2'])]),
1216 OrderedDict([('fname', 'Under1'), ('lname', None)]),
1217 OrderedDict([('fname', 'John'), ('lname', 'Cleese')]),
1218 ])
1219
1220
Martin Panter19e69c52015-11-14 12:46:42 +00001221class MiscTestCase(unittest.TestCase):
1222 def test__all__(self):
1223 extra = {'__doc__', '__version__'}
1224 support.check__all__(self, csv, ('csv', '_csv'), extra=extra)
1225
1226
Skip Montanarob4a04172003-03-20 23:29:12 +00001227if __name__ == '__main__':
Zachary Ware38c707e2015-04-13 15:00:43 -05001228 unittest.main()