blob: 09e72a71f1db922126d1b655f62a9ff91dfdf541 [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):
Inada Naoki35715d12021-04-04 09:01:23 +0900136 with TemporaryFile("w+", encoding="utf-8", 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):
Inada Naoki35715d12021-04-04 09:01:23 +0900144 with TemporaryFile("w+", encoding="utf-8", newline='') as fileobj:
Serhiy Storchaka0b4e3552015-03-25 19:16:15 +0200145 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):
Miss Islington (bot)280425d2021-06-23 03:02:40 -0700160 return 10
Skip Montanarob4a04172003-03-20 23:29:12 +0000161 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)
Berker Peksag5c0eed72020-09-20 09:38:07 +0300205 self._write_test(['\\', 'a'], '\\\\,a',
206 escapechar='\\', quoting=csv.QUOTE_NONE)
207 self._write_test(['\\', 'a'], '\\\\,a',
208 escapechar='\\', quoting=csv.QUOTE_MINIMAL)
209 self._write_test(['\\', 'a'], '"\\\\","a"',
210 escapechar='\\', quoting=csv.QUOTE_ALL)
211 self._write_test(['\\ ', 'a'], '\\\\ ,a',
212 escapechar='\\', quoting=csv.QUOTE_MINIMAL)
213 self._write_test(['\\,', 'a'], '\\\\\\,,a',
214 escapechar='\\', quoting=csv.QUOTE_NONE)
215 self._write_test([',\\', 'a'], '",\\\\",a',
216 escapechar='\\', quoting=csv.QUOTE_MINIMAL)
217 self._write_test(['C\\', '6', '7', 'X"'], 'C\\\\,6,7,"X"""',
218 escapechar='\\', quoting=csv.QUOTE_MINIMAL)
Skip Montanarob4a04172003-03-20 23:29:12 +0000219
Serhiy Storchaka7901b482015-03-30 09:09:54 +0300220 def test_write_iterable(self):
221 self._write_test(iter(['a', 1, 'p,q']), 'a,1,"p,q"')
222 self._write_test(iter(['a', 1, None]), 'a,1,')
223 self._write_test(iter([]), '')
224 self._write_test(iter([None]), '""')
225 self._write_error_test(csv.Error, iter([None]), quoting=csv.QUOTE_NONE)
226 self._write_test(iter([None, None]), ',')
227
Skip Montanarob4a04172003-03-20 23:29:12 +0000228 def test_writerows(self):
229 class BrokenFile:
230 def write(self, buf):
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200231 raise OSError
Skip Montanarob4a04172003-03-20 23:29:12 +0000232 writer = csv.writer(BrokenFile())
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200233 self.assertRaises(OSError, writer.writerows, [['a']])
Guido van Rossum46264582007-08-06 19:32:18 +0000234
Inada Naoki35715d12021-04-04 09:01:23 +0900235 with TemporaryFile("w+", encoding="utf-8", newline='') as fileobj:
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000236 writer = csv.writer(fileobj)
237 self.assertRaises(TypeError, writer.writerows, None)
Licht Takeuchi20019002017-12-12 18:57:06 +0900238 writer.writerows([['a', 'b'], ['c', 'd']])
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000239 fileobj.seek(0)
Guido van Rossumf0c74162007-08-28 03:29:45 +0000240 self.assertEqual(fileobj.read(), "a,b\r\nc,d\r\n")
Tim Peters27f88362004-07-08 04:22:35 +0000241
Licht Takeuchi20019002017-12-12 18:57:06 +0900242 def test_writerows_with_none(self):
Inada Naoki35715d12021-04-04 09:01:23 +0900243 with TemporaryFile("w+", encoding="utf-8", newline='') as fileobj:
Licht Takeuchi20019002017-12-12 18:57:06 +0900244 writer = csv.writer(fileobj)
245 writer.writerows([['a', None], [None, 'd']])
246 fileobj.seek(0)
247 self.assertEqual(fileobj.read(), "a,\r\n,d\r\n")
248
Inada Naoki35715d12021-04-04 09:01:23 +0900249 with TemporaryFile("w+", encoding="utf-8", newline='') as fileobj:
Licht Takeuchi20019002017-12-12 18:57:06 +0900250 writer = csv.writer(fileobj)
251 writer.writerows([[None], ['a']])
252 fileobj.seek(0)
253 self.assertEqual(fileobj.read(), '""\r\na\r\n')
254
Inada Naoki35715d12021-04-04 09:01:23 +0900255 with TemporaryFile("w+", encoding="utf-8", newline='') as fileobj:
Licht Takeuchi20019002017-12-12 18:57:06 +0900256 writer = csv.writer(fileobj)
257 writer.writerows([['a'], [None]])
258 fileobj.seek(0)
259 self.assertEqual(fileobj.read(), 'a\r\n""\r\n')
260
Serhiy Storchakac88239f2020-06-22 11:21:59 +0300261 def test_writerows_errors(self):
Inada Naoki35715d12021-04-04 09:01:23 +0900262 with TemporaryFile("w+", encoding="utf-8", newline='') as fileobj:
Serhiy Storchakac88239f2020-06-22 11:21:59 +0300263 writer = csv.writer(fileobj)
264 self.assertRaises(TypeError, writer.writerows, None)
265 self.assertRaises(OSError, writer.writerows, BadIterable())
266
Stefan Krahe6996ed2012-11-02 14:44:20 +0100267 @support.cpython_only
Serhiy Storchaka4c8f09d2020-07-10 23:26:06 +0300268 @support.requires_legacy_unicode_capi
Inada Naoki902356a2020-07-20 12:02:50 +0900269 @warnings_helper.ignore_warnings(category=DeprecationWarning)
Stefan Krahe6996ed2012-11-02 14:44:20 +0100270 def test_writerows_legacy_strings(self):
271 import _testcapi
Stefan Krahe6996ed2012-11-02 14:44:20 +0100272 c = _testcapi.unicode_legacy_string('a')
Inada Naoki35715d12021-04-04 09:01:23 +0900273 with TemporaryFile("w+", encoding="utf-8", newline='') as fileobj:
Stefan Krahe6996ed2012-11-02 14:44:20 +0100274 writer = csv.writer(fileobj)
275 writer.writerows([[c]])
276 fileobj.seek(0)
277 self.assertEqual(fileobj.read(), "a\r\n")
278
Skip Montanarob4a04172003-03-20 23:29:12 +0000279 def _read_test(self, input, expect, **kwargs):
280 reader = csv.reader(input, **kwargs)
281 result = list(reader)
282 self.assertEqual(result, expect)
283
284 def test_read_oddinputs(self):
285 self._read_test([], [])
286 self._read_test([''], [[]])
287 self.assertRaises(csv.Error, self._read_test,
288 ['"ab"c'], None, strict = 1)
289 # cannot handle null bytes for the moment
290 self.assertRaises(csv.Error, self._read_test,
291 ['ab\0c'], None, strict = 1)
292 self._read_test(['"ab"c'], [['abc']], doublequote = 0)
293
Amaury Forgeot d'Arc10c476d2007-11-19 21:20:21 +0000294 self.assertRaises(csv.Error, self._read_test,
295 [b'ab\0c'], None)
296
297
Skip Montanarob4a04172003-03-20 23:29:12 +0000298 def test_read_eol(self):
299 self._read_test(['a,b'], [['a','b']])
300 self._read_test(['a,b\n'], [['a','b']])
301 self._read_test(['a,b\r\n'], [['a','b']])
302 self._read_test(['a,b\r'], [['a','b']])
303 self.assertRaises(csv.Error, self._read_test, ['a,b\rc,d'], [])
304 self.assertRaises(csv.Error, self._read_test, ['a,b\nc,d'], [])
305 self.assertRaises(csv.Error, self._read_test, ['a,b\r\nc,d'], [])
306
Senthil Kumaran67b7b982012-09-25 02:30:27 -0700307 def test_read_eof(self):
308 self._read_test(['a,"'], [['a', '']])
309 self._read_test(['"a'], [['a']])
310 self._read_test(['^'], [['\n']], escapechar='^')
311 self.assertRaises(csv.Error, self._read_test, ['a,"'], [], strict=True)
312 self.assertRaises(csv.Error, self._read_test, ['"a'], [], strict=True)
313 self.assertRaises(csv.Error, self._read_test,
314 ['^'], [], escapechar='^', strict=True)
315
Skip Montanarob4a04172003-03-20 23:29:12 +0000316 def test_read_escape(self):
Andrew McNamara36a76912005-01-10 01:04:40 +0000317 self._read_test(['a,\\b,c'], [['a', 'b', 'c']], escapechar='\\')
Skip Montanarob4a04172003-03-20 23:29:12 +0000318 self._read_test(['a,b\\,c'], [['a', 'b,c']], escapechar='\\')
319 self._read_test(['a,"b\\,c"'], [['a', 'b,c']], escapechar='\\')
Andrew McNamara36a76912005-01-10 01:04:40 +0000320 self._read_test(['a,"b,\\c"'], [['a', 'b,c']], escapechar='\\')
Skip Montanarob4a04172003-03-20 23:29:12 +0000321 self._read_test(['a,"b,c\\""'], [['a', 'b,c"']], escapechar='\\')
322 self._read_test(['a,"b,c"\\'], [['a', 'b,c\\']], escapechar='\\')
323
Andrew McNamara1196cf12005-01-07 04:42:45 +0000324 def test_read_quoting(self):
325 self._read_test(['1,",3,",5'], [['1', ',3,', '5']])
326 self._read_test(['1,",3,",5'], [['1', '"', '3', '"', '5']],
327 quotechar=None, escapechar='\\')
328 self._read_test(['1,",3,",5'], [['1', '"', '3', '"', '5']],
329 quoting=csv.QUOTE_NONE, escapechar='\\')
Andrew McNamara0f0599d2005-01-12 09:45:18 +0000330 # will this fail where locale uses comma for decimals?
Andrew McNamara7f2053e2005-01-12 11:17:16 +0000331 self._read_test([',3,"5",7.3, 9'], [['', 3, '5', 7.3, 9]],
Andrew McNamara0f0599d2005-01-12 09:45:18 +0000332 quoting=csv.QUOTE_NONNUMERIC)
R. David Murraycde68cf2009-04-01 22:37:58 +0000333 self._read_test(['"a\nb", 7'], [['a\nb', ' 7']])
Tim Peters608c2ff2005-01-13 17:37:38 +0000334 self.assertRaises(ValueError, self._read_test,
Andrew McNamara0f0599d2005-01-12 09:45:18 +0000335 ['abc,3'], [[]],
336 quoting=csv.QUOTE_NONNUMERIC)
Andrew McNamara1196cf12005-01-07 04:42:45 +0000337
Skip Montanarob4a04172003-03-20 23:29:12 +0000338 def test_read_bigfield(self):
Andrew McNamarae4d05c42005-01-11 07:32:02 +0000339 # This exercises the buffer realloc functionality and field size
340 # limits.
Andrew McNamara31d88962005-01-12 03:45:10 +0000341 limit = csv.field_size_limit()
Andrew McNamaraaf1e3122005-01-12 01:55:21 +0000342 try:
343 size = 50000
344 bigstring = 'X' * size
345 bigline = '%s,%s' % (bigstring, bigstring)
346 self._read_test([bigline], [[bigstring, bigstring]])
Andrew McNamara31d88962005-01-12 03:45:10 +0000347 csv.field_size_limit(size)
Andrew McNamaraaf1e3122005-01-12 01:55:21 +0000348 self._read_test([bigline], [[bigstring, bigstring]])
Andrew McNamara31d88962005-01-12 03:45:10 +0000349 self.assertEqual(csv.field_size_limit(), size)
350 csv.field_size_limit(size-1)
Andrew McNamaraaf1e3122005-01-12 01:55:21 +0000351 self.assertRaises(csv.Error, self._read_test, [bigline], [])
Andrew McNamara31d88962005-01-12 03:45:10 +0000352 self.assertRaises(TypeError, csv.field_size_limit, None)
353 self.assertRaises(TypeError, csv.field_size_limit, 1, None)
Andrew McNamaraaf1e3122005-01-12 01:55:21 +0000354 finally:
Andrew McNamara31d88962005-01-12 03:45:10 +0000355 csv.field_size_limit(limit)
Skip Montanarob4a04172003-03-20 23:29:12 +0000356
Andrew McNamara7f2053e2005-01-12 11:17:16 +0000357 def test_read_linenum(self):
358 r = csv.reader(['line,1', 'line,2', 'line,3'])
359 self.assertEqual(r.line_num, 0)
Georg Brandla18af4e2007-04-21 15:47:16 +0000360 next(r)
Andrew McNamara7f2053e2005-01-12 11:17:16 +0000361 self.assertEqual(r.line_num, 1)
Georg Brandla18af4e2007-04-21 15:47:16 +0000362 next(r)
Andrew McNamara7f2053e2005-01-12 11:17:16 +0000363 self.assertEqual(r.line_num, 2)
Georg Brandla18af4e2007-04-21 15:47:16 +0000364 next(r)
Andrew McNamara7f2053e2005-01-12 11:17:16 +0000365 self.assertEqual(r.line_num, 3)
Georg Brandla18af4e2007-04-21 15:47:16 +0000366 self.assertRaises(StopIteration, next, r)
Andrew McNamara7f2053e2005-01-12 11:17:16 +0000367 self.assertEqual(r.line_num, 3)
368
R. David Murraycde68cf2009-04-01 22:37:58 +0000369 def test_roundtrip_quoteed_newlines(self):
Inada Naoki35715d12021-04-04 09:01:23 +0900370 with TemporaryFile("w+", encoding="utf-8", newline='') as fileobj:
R. David Murraycde68cf2009-04-01 22:37:58 +0000371 writer = csv.writer(fileobj)
R. David Murraycde68cf2009-04-01 22:37:58 +0000372 rows = [['a\nb','b'],['c','x\r\nd']]
373 writer.writerows(rows)
374 fileobj.seek(0)
375 for i, row in enumerate(csv.reader(fileobj)):
376 self.assertEqual(row, rows[i])
377
R David Murrayc7c42ef2013-03-19 22:41:47 -0400378 def test_roundtrip_escaped_unquoted_newlines(self):
Inada Naoki35715d12021-04-04 09:01:23 +0900379 with TemporaryFile("w+", encoding="utf-8", newline='') as fileobj:
R David Murrayc7c42ef2013-03-19 22:41:47 -0400380 writer = csv.writer(fileobj,quoting=csv.QUOTE_NONE,escapechar="\\")
381 rows = [['a\nb','b'],['c','x\r\nd']]
382 writer.writerows(rows)
383 fileobj.seek(0)
384 for i, row in enumerate(csv.reader(fileobj,quoting=csv.QUOTE_NONE,escapechar="\\")):
385 self.assertEqual(row,rows[i])
386
Skip Montanarob4a04172003-03-20 23:29:12 +0000387class TestDialectRegistry(unittest.TestCase):
388 def test_registry_badargs(self):
389 self.assertRaises(TypeError, csv.list_dialects, None)
390 self.assertRaises(TypeError, csv.get_dialect)
391 self.assertRaises(csv.Error, csv.get_dialect, None)
392 self.assertRaises(csv.Error, csv.get_dialect, "nonesuch")
393 self.assertRaises(TypeError, csv.unregister_dialect)
394 self.assertRaises(csv.Error, csv.unregister_dialect, None)
395 self.assertRaises(csv.Error, csv.unregister_dialect, "nonesuch")
396 self.assertRaises(TypeError, csv.register_dialect, None)
397 self.assertRaises(TypeError, csv.register_dialect, None, None)
Andrew McNamaraaf1e3122005-01-12 01:55:21 +0000398 self.assertRaises(TypeError, csv.register_dialect, "nonesuch", 0, 0)
399 self.assertRaises(TypeError, csv.register_dialect, "nonesuch",
400 badargument=None)
401 self.assertRaises(TypeError, csv.register_dialect, "nonesuch",
402 quoting=None)
403 self.assertRaises(TypeError, csv.register_dialect, [])
Skip Montanarob4a04172003-03-20 23:29:12 +0000404
405 def test_registry(self):
406 class myexceltsv(csv.excel):
407 delimiter = "\t"
408 name = "myexceltsv"
409 expected_dialects = csv.list_dialects() + [name]
410 expected_dialects.sort()
411 csv.register_dialect(name, myexceltsv)
Éric Araujo5137d642010-12-02 22:16:19 +0000412 self.addCleanup(csv.unregister_dialect, name)
413 self.assertEqual(csv.get_dialect(name).delimiter, '\t')
414 got_dialects = sorted(csv.list_dialects())
415 self.assertEqual(expected_dialects, got_dialects)
Skip Montanarob4a04172003-03-20 23:29:12 +0000416
Andrew McNamara86625972005-01-11 01:28:33 +0000417 def test_register_kwargs(self):
418 name = 'fedcba'
419 csv.register_dialect(name, delimiter=';')
Éric Araujo5137d642010-12-02 22:16:19 +0000420 self.addCleanup(csv.unregister_dialect, name)
421 self.assertEqual(csv.get_dialect(name).delimiter, ';')
422 self.assertEqual([['X', 'Y', 'Z']], list(csv.reader(['X;Y;Z'], name)))
Andrew McNamara86625972005-01-11 01:28:33 +0000423
Skip Montanarob4a04172003-03-20 23:29:12 +0000424 def test_incomplete_dialect(self):
425 class myexceltsv(csv.Dialect):
426 delimiter = "\t"
427 self.assertRaises(csv.Error, myexceltsv)
428
429 def test_space_dialect(self):
430 class space(csv.excel):
431 delimiter = " "
432 quoting = csv.QUOTE_NONE
433 escapechar = "\\"
434
Inada Naoki35715d12021-04-04 09:01:23 +0900435 with TemporaryFile("w+", encoding="utf-8") as fileobj:
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000436 fileobj.write("abc def\nc1ccccc1 benzene\n")
437 fileobj.seek(0)
Georg Brandla18af4e2007-04-21 15:47:16 +0000438 reader = csv.reader(fileobj, dialect=space())
439 self.assertEqual(next(reader), ["abc", "def"])
440 self.assertEqual(next(reader), ["c1ccccc1", "benzene"])
Guido van Rossum46264582007-08-06 19:32:18 +0000441
442 def compare_dialect_123(self, expected, *writeargs, **kwwriteargs):
Guido van Rossumf0c74162007-08-28 03:29:45 +0000443
444 with TemporaryFile("w+", newline='', encoding="utf-8") as fileobj:
445
Guido van Rossum46264582007-08-06 19:32:18 +0000446 writer = csv.writer(fileobj, *writeargs, **kwwriteargs)
447 writer.writerow([1,2,3])
448 fileobj.seek(0)
Guido van Rossumf0c74162007-08-28 03:29:45 +0000449 self.assertEqual(fileobj.read(), expected)
Tim Peters27f88362004-07-08 04:22:35 +0000450
Skip Montanarob4a04172003-03-20 23:29:12 +0000451 def test_dialect_apply(self):
452 class testA(csv.excel):
453 delimiter = "\t"
454 class testB(csv.excel):
455 delimiter = ":"
456 class testC(csv.excel):
457 delimiter = "|"
Guido van Rossum46264582007-08-06 19:32:18 +0000458 class testUni(csv.excel):
459 delimiter = "\u039B"
Skip Montanarob4a04172003-03-20 23:29:12 +0000460
Miss Islington (bot)bb260c22021-07-13 16:18:28 -0700461 class unspecified():
462 # A class to pass as dialect but with no dialect attributes.
463 pass
464
Skip Montanarob4a04172003-03-20 23:29:12 +0000465 csv.register_dialect('testC', testC)
466 try:
Guido van Rossum46264582007-08-06 19:32:18 +0000467 self.compare_dialect_123("1,2,3\r\n")
Miss Islington (bot)bb260c22021-07-13 16:18:28 -0700468 self.compare_dialect_123("1,2,3\r\n", dialect=None)
469 self.compare_dialect_123("1,2,3\r\n", dialect=unspecified)
Guido van Rossum46264582007-08-06 19:32:18 +0000470 self.compare_dialect_123("1\t2\t3\r\n", testA)
471 self.compare_dialect_123("1:2:3\r\n", dialect=testB())
472 self.compare_dialect_123("1|2|3\r\n", dialect='testC')
473 self.compare_dialect_123("1;2;3\r\n", dialect=testA,
474 delimiter=';')
475 self.compare_dialect_123("1\u039B2\u039B3\r\n",
476 dialect=testUni)
Skip Montanarob4a04172003-03-20 23:29:12 +0000477
Skip Montanarob4a04172003-03-20 23:29:12 +0000478 finally:
479 csv.unregister_dialect('testC')
480
481 def test_bad_dialect(self):
482 # Unknown parameter
Andrew McNamara1196cf12005-01-07 04:42:45 +0000483 self.assertRaises(TypeError, csv.reader, [], bad_attr = 0)
Skip Montanarob4a04172003-03-20 23:29:12 +0000484 # Bad values
485 self.assertRaises(TypeError, csv.reader, [], delimiter = None)
486 self.assertRaises(TypeError, csv.reader, [], quoting = -1)
487 self.assertRaises(TypeError, csv.reader, [], quoting = 100)
488
Serhiy Storchakaf81be8a2015-12-25 21:04:29 +0200489 def test_copy(self):
490 for name in csv.list_dialects():
491 dialect = csv.get_dialect(name)
492 self.assertRaises(TypeError, copy.copy, dialect)
493
494 def test_pickle(self):
495 for name in csv.list_dialects():
496 dialect = csv.get_dialect(name)
497 for proto in range(pickle.HIGHEST_PROTOCOL + 1):
498 self.assertRaises(TypeError, pickle.dumps, dialect, proto)
499
Skip Montanarob4a04172003-03-20 23:29:12 +0000500class TestCsvBase(unittest.TestCase):
501 def readerAssertEqual(self, input, expected_result):
Inada Naoki35715d12021-04-04 09:01:23 +0900502 with TemporaryFile("w+", encoding="utf-8", newline='') as fileobj:
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000503 fileobj.write(input)
504 fileobj.seek(0)
505 reader = csv.reader(fileobj, dialect = self.dialect)
506 fields = list(reader)
507 self.assertEqual(fields, expected_result)
Skip Montanarob4a04172003-03-20 23:29:12 +0000508
509 def writerAssertEqual(self, input, expected_result):
Inada Naoki35715d12021-04-04 09:01:23 +0900510 with TemporaryFile("w+", encoding="utf-8", newline='') as fileobj:
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000511 writer = csv.writer(fileobj, dialect = self.dialect)
512 writer.writerows(input)
513 fileobj.seek(0)
Guido van Rossumf0c74162007-08-28 03:29:45 +0000514 self.assertEqual(fileobj.read(), expected_result)
Skip Montanarob4a04172003-03-20 23:29:12 +0000515
516class TestDialectExcel(TestCsvBase):
517 dialect = 'excel'
518
519 def test_single(self):
520 self.readerAssertEqual('abc', [['abc']])
521
522 def test_simple(self):
523 self.readerAssertEqual('1,2,3,4,5', [['1','2','3','4','5']])
524
525 def test_blankline(self):
526 self.readerAssertEqual('', [])
527
528 def test_empty_fields(self):
529 self.readerAssertEqual(',', [['', '']])
530
531 def test_singlequoted(self):
532 self.readerAssertEqual('""', [['']])
533
534 def test_singlequoted_left_empty(self):
535 self.readerAssertEqual('"",', [['','']])
536
537 def test_singlequoted_right_empty(self):
538 self.readerAssertEqual(',""', [['','']])
539
540 def test_single_quoted_quote(self):
541 self.readerAssertEqual('""""', [['"']])
542
543 def test_quoted_quotes(self):
544 self.readerAssertEqual('""""""', [['""']])
545
546 def test_inline_quote(self):
547 self.readerAssertEqual('a""b', [['a""b']])
548
549 def test_inline_quotes(self):
550 self.readerAssertEqual('a"b"c', [['a"b"c']])
551
552 def test_quotes_and_more(self):
Guido van Rossumd8faa362007-04-27 19:54:29 +0000553 # Excel would never write a field containing '"a"b', but when
554 # reading one, it will return 'ab'.
Skip Montanarob4a04172003-03-20 23:29:12 +0000555 self.readerAssertEqual('"a"b', [['ab']])
556
557 def test_lone_quote(self):
558 self.readerAssertEqual('a"b', [['a"b']])
559
560 def test_quote_and_quote(self):
Guido van Rossumd8faa362007-04-27 19:54:29 +0000561 # Excel would never write a field containing '"a" "b"', but when
562 # reading one, it will return 'a "b"'.
Skip Montanarob4a04172003-03-20 23:29:12 +0000563 self.readerAssertEqual('"a" "b"', [['a "b"']])
564
565 def test_space_and_quote(self):
566 self.readerAssertEqual(' "a"', [[' "a"']])
567
568 def test_quoted(self):
Tim Peters0eadaac2003-04-24 16:02:54 +0000569 self.readerAssertEqual('1,2,3,"I think, therefore I am",5,6',
570 [['1', '2', '3',
571 'I think, therefore I am',
Skip Montanarob4a04172003-03-20 23:29:12 +0000572 '5', '6']])
573
574 def test_quoted_quote(self):
575 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 +0000576 [['1', '2', '3',
577 '"I see," said the blind man',
Skip Montanarob4a04172003-03-20 23:29:12 +0000578 'as he picked up his hammer and saw']])
579
580 def test_quoted_nl(self):
581 input = '''\
5821,2,3,"""I see,""
583said the blind man","as he picked up his
584hammer and saw"
5859,8,7,6'''
586 self.readerAssertEqual(input,
Tim Peters0eadaac2003-04-24 16:02:54 +0000587 [['1', '2', '3',
588 '"I see,"\nsaid the blind man',
Skip Montanarob4a04172003-03-20 23:29:12 +0000589 'as he picked up his\nhammer and saw'],
590 ['9','8','7','6']])
591
592 def test_dubious_quote(self):
593 self.readerAssertEqual('12,12,1",', [['12', '12', '1"', '']])
594
595 def test_null(self):
596 self.writerAssertEqual([], '')
597
Georg Brandl89fad142010-03-14 10:23:39 +0000598 def test_single_writer(self):
Skip Montanarob4a04172003-03-20 23:29:12 +0000599 self.writerAssertEqual([['abc']], 'abc\r\n')
600
Georg Brandl89fad142010-03-14 10:23:39 +0000601 def test_simple_writer(self):
Skip Montanarob4a04172003-03-20 23:29:12 +0000602 self.writerAssertEqual([[1, 2, 'abc', 3, 4]], '1,2,abc,3,4\r\n')
603
604 def test_quotes(self):
605 self.writerAssertEqual([[1, 2, 'a"bc"', 3, 4]], '1,2,"a""bc""",3,4\r\n')
606
607 def test_quote_fieldsep(self):
608 self.writerAssertEqual([['abc,def']], '"abc,def"\r\n')
609
610 def test_newlines(self):
611 self.writerAssertEqual([[1, 2, 'a\nbc', 3, 4]], '1,2,"a\nbc",3,4\r\n')
612
613class EscapedExcel(csv.excel):
614 quoting = csv.QUOTE_NONE
615 escapechar = '\\'
616
617class TestEscapedExcel(TestCsvBase):
618 dialect = EscapedExcel()
619
620 def test_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
Georg Brandl7424dd32010-10-27 07:27:06 +0000626class TestDialectUnix(TestCsvBase):
627 dialect = 'unix'
628
629 def test_simple_writer(self):
630 self.writerAssertEqual([[1, 'abc def', 'abc']], '"1","abc def","abc"\n')
631
632 def test_simple_reader(self):
633 self.readerAssertEqual('"1","abc def","abc"\n', [['1', 'abc def', 'abc']])
634
Skip Montanarob4a04172003-03-20 23:29:12 +0000635class QuotedEscapedExcel(csv.excel):
636 quoting = csv.QUOTE_NONNUMERIC
637 escapechar = '\\'
638
639class TestQuotedEscapedExcel(TestCsvBase):
640 dialect = QuotedEscapedExcel()
641
642 def test_write_escape_fieldsep(self):
643 self.writerAssertEqual([['abc,def']], '"abc,def"\r\n')
644
645 def test_read_escape_fieldsep(self):
646 self.readerAssertEqual('"abc\\,def"\r\n', [['abc,def']])
647
Skip Montanarob4a04172003-03-20 23:29:12 +0000648class TestDictFields(unittest.TestCase):
649 ### "long" means the row is longer than the number of fieldnames
650 ### "short" means there are fewer elements in the row than fieldnames
Rémi Lapeyrefce5ff12019-05-10 03:50:11 +0200651 def test_writeheader_return_value(self):
Inada Naoki35715d12021-04-04 09:01:23 +0900652 with TemporaryFile("w+", encoding="utf-8", newline='') as fileobj:
Rémi Lapeyrefce5ff12019-05-10 03:50:11 +0200653 writer = csv.DictWriter(fileobj, fieldnames = ["f1", "f2", "f3"])
654 writeheader_return_value = writer.writeheader()
655 self.assertEqual(writeheader_return_value, 10)
656
Skip Montanarob4a04172003-03-20 23:29:12 +0000657 def test_write_simple_dict(self):
Inada Naoki35715d12021-04-04 09:01:23 +0900658 with TemporaryFile("w+", encoding="utf-8", newline='') as fileobj:
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000659 writer = csv.DictWriter(fileobj, fieldnames = ["f1", "f2", "f3"])
R. David Murraybe0698b2010-02-23 22:57:58 +0000660 writer.writeheader()
661 fileobj.seek(0)
662 self.assertEqual(fileobj.readline(), "f1,f2,f3\r\n")
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000663 writer.writerow({"f1": 10, "f3": "abc"})
664 fileobj.seek(0)
R. David Murraybe0698b2010-02-23 22:57:58 +0000665 fileobj.readline() # header
Guido van Rossumf0c74162007-08-28 03:29:45 +0000666 self.assertEqual(fileobj.read(), "10,,abc\r\n")
Skip Montanarob4a04172003-03-20 23:29:12 +0000667
Antoine Pitrou05da1ef2014-04-29 01:58:06 +0200668 def test_write_multiple_dict_rows(self):
669 fileobj = StringIO()
670 writer = csv.DictWriter(fileobj, fieldnames=["f1", "f2", "f3"])
671 writer.writeheader()
672 self.assertEqual(fileobj.getvalue(), "f1,f2,f3\r\n")
673 writer.writerows([{"f1": 1, "f2": "abc", "f3": "f"},
674 {"f1": 2, "f2": 5, "f3": "xyz"}])
675 self.assertEqual(fileobj.getvalue(),
676 "f1,f2,f3\r\n1,abc,f\r\n2,5,xyz\r\n")
677
Skip Montanarob4a04172003-03-20 23:29:12 +0000678 def test_write_no_fields(self):
679 fileobj = StringIO()
680 self.assertRaises(TypeError, csv.DictWriter, fileobj)
681
R David Murrayfb099c92013-11-19 13:16:20 -0500682 def test_write_fields_not_in_fieldnames(self):
Inada Naoki35715d12021-04-04 09:01:23 +0900683 with TemporaryFile("w+", encoding="utf-8", newline='') as fileobj:
R David Murrayfb099c92013-11-19 13:16:20 -0500684 writer = csv.DictWriter(fileobj, fieldnames = ["f1", "f2", "f3"])
685 # Of special note is the non-string key (issue 19449)
686 with self.assertRaises(ValueError) as cx:
687 writer.writerow({"f4": 10, "f2": "spam", 1: "abc"})
688 exception = str(cx.exception)
689 self.assertIn("fieldnames", exception)
690 self.assertIn("'f4'", exception)
691 self.assertNotIn("'f2'", exception)
692 self.assertIn("1", exception)
693
INADA Naoki0a421a22016-10-21 19:47:57 +0900694 def test_typo_in_extrasaction_raises_error(self):
695 fileobj = StringIO()
696 self.assertRaises(ValueError, csv.DictWriter, fileobj, ['f1', 'f2'],
697 extrasaction="raised")
698
699 def test_write_field_not_in_field_names_raise(self):
700 fileobj = StringIO()
701 writer = csv.DictWriter(fileobj, ['f1', 'f2'], extrasaction="raise")
702 dictrow = {'f0': 0, 'f1': 1, 'f2': 2, 'f3': 3}
703 self.assertRaises(ValueError, csv.DictWriter.writerow, writer, dictrow)
704
705 def test_write_field_not_in_field_names_ignore(self):
706 fileobj = StringIO()
707 writer = csv.DictWriter(fileobj, ['f1', 'f2'], extrasaction="ignore")
708 dictrow = {'f0': 0, 'f1': 1, 'f2': 2, 'f3': 3}
709 csv.DictWriter.writerow(writer, dictrow)
710 self.assertEqual(fileobj.getvalue(), "1,2\r\n")
711
Skip Montanarob4a04172003-03-20 23:29:12 +0000712 def test_read_dict_fields(self):
Inada Naoki35715d12021-04-04 09:01:23 +0900713 with TemporaryFile("w+", encoding="utf-8") as fileobj:
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000714 fileobj.write("1,2,abc\r\n")
715 fileobj.seek(0)
716 reader = csv.DictReader(fileobj,
717 fieldnames=["f1", "f2", "f3"])
Georg Brandla18af4e2007-04-21 15:47:16 +0000718 self.assertEqual(next(reader), {"f1": '1', "f2": '2', "f3": 'abc'})
Skip Montanarob4a04172003-03-20 23:29:12 +0000719
Skip Montanarodffeed32003-10-03 14:03:01 +0000720 def test_read_dict_no_fieldnames(self):
Inada Naoki35715d12021-04-04 09:01:23 +0900721 with TemporaryFile("w+", encoding="utf-8") as fileobj:
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000722 fileobj.write("f1,f2,f3\r\n1,2,abc\r\n")
723 fileobj.seek(0)
724 reader = csv.DictReader(fileobj)
Georg Brandla18af4e2007-04-21 15:47:16 +0000725 self.assertEqual(next(reader), {"f1": '1', "f2": '2', "f3": 'abc'})
Skip Montanaroaf8fcfa2008-08-09 19:44:22 +0000726 self.assertEqual(reader.fieldnames, ["f1", "f2", "f3"])
727
728 # Two test cases to make sure existing ways of implicitly setting
729 # fieldnames continue to work. Both arise from discussion in issue3436.
730 def test_read_dict_fieldnames_from_file(self):
Inada Naoki35715d12021-04-04 09:01:23 +0900731 with TemporaryFile("w+", encoding="utf-8") as fileobj:
Skip Montanaroaf8fcfa2008-08-09 19:44:22 +0000732 fileobj.write("f1,f2,f3\r\n1,2,abc\r\n")
733 fileobj.seek(0)
734 reader = csv.DictReader(fileobj,
735 fieldnames=next(csv.reader(fileobj)))
736 self.assertEqual(reader.fieldnames, ["f1", "f2", "f3"])
737 self.assertEqual(next(reader), {"f1": '1', "f2": '2', "f3": 'abc'})
738
739 def test_read_dict_fieldnames_chain(self):
740 import itertools
Inada Naoki35715d12021-04-04 09:01:23 +0900741 with TemporaryFile("w+", encoding="utf-8") as fileobj:
Skip Montanaroaf8fcfa2008-08-09 19:44:22 +0000742 fileobj.write("f1,f2,f3\r\n1,2,abc\r\n")
743 fileobj.seek(0)
744 reader = csv.DictReader(fileobj)
745 first = next(reader)
746 for row in itertools.chain([first], reader):
747 self.assertEqual(reader.fieldnames, ["f1", "f2", "f3"])
748 self.assertEqual(row, {"f1": '1', "f2": '2', "f3": 'abc'})
Skip Montanarodffeed32003-10-03 14:03:01 +0000749
Skip Montanarob4a04172003-03-20 23:29:12 +0000750 def test_read_long(self):
Inada Naoki35715d12021-04-04 09:01:23 +0900751 with TemporaryFile("w+", encoding="utf-8") as fileobj:
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000752 fileobj.write("1,2,abc,4,5,6\r\n")
753 fileobj.seek(0)
754 reader = csv.DictReader(fileobj,
755 fieldnames=["f1", "f2"])
Georg Brandla18af4e2007-04-21 15:47:16 +0000756 self.assertEqual(next(reader), {"f1": '1', "f2": '2',
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000757 None: ["abc", "4", "5", "6"]})
Skip Montanarob4a04172003-03-20 23:29:12 +0000758
759 def test_read_long_with_rest(self):
Inada Naoki35715d12021-04-04 09:01:23 +0900760 with TemporaryFile("w+", encoding="utf-8") as fileobj:
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000761 fileobj.write("1,2,abc,4,5,6\r\n")
762 fileobj.seek(0)
763 reader = csv.DictReader(fileobj,
764 fieldnames=["f1", "f2"], restkey="_rest")
Georg Brandla18af4e2007-04-21 15:47:16 +0000765 self.assertEqual(next(reader), {"f1": '1', "f2": '2',
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000766 "_rest": ["abc", "4", "5", "6"]})
Skip Montanarob4a04172003-03-20 23:29:12 +0000767
Skip Montanarodffeed32003-10-03 14:03:01 +0000768 def test_read_long_with_rest_no_fieldnames(self):
Inada Naoki35715d12021-04-04 09:01:23 +0900769 with TemporaryFile("w+", encoding="utf-8") as fileobj:
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000770 fileobj.write("f1,f2\r\n1,2,abc,4,5,6\r\n")
771 fileobj.seek(0)
772 reader = csv.DictReader(fileobj, restkey="_rest")
Skip Montanaroaf8fcfa2008-08-09 19:44:22 +0000773 self.assertEqual(reader.fieldnames, ["f1", "f2"])
Georg Brandla18af4e2007-04-21 15:47:16 +0000774 self.assertEqual(next(reader), {"f1": '1', "f2": '2',
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000775 "_rest": ["abc", "4", "5", "6"]})
Skip Montanarodffeed32003-10-03 14:03:01 +0000776
Skip Montanarob4a04172003-03-20 23:29:12 +0000777 def test_read_short(self):
Inada Naoki35715d12021-04-04 09:01:23 +0900778 with TemporaryFile("w+", encoding="utf-8") as fileobj:
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000779 fileobj.write("1,2,abc,4,5,6\r\n1,2,abc\r\n")
780 fileobj.seek(0)
781 reader = csv.DictReader(fileobj,
782 fieldnames="1 2 3 4 5 6".split(),
783 restval="DEFAULT")
Georg Brandla18af4e2007-04-21 15:47:16 +0000784 self.assertEqual(next(reader), {"1": '1', "2": '2', "3": 'abc',
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000785 "4": '4', "5": '5', "6": '6'})
Georg Brandla18af4e2007-04-21 15:47:16 +0000786 self.assertEqual(next(reader), {"1": '1', "2": '2', "3": 'abc',
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000787 "4": 'DEFAULT', "5": 'DEFAULT',
788 "6": 'DEFAULT'})
Skip Montanarob4a04172003-03-20 23:29:12 +0000789
Skip Montanaro1546bc42003-06-12 02:40:22 +0000790 def test_read_multi(self):
791 sample = [
792 '2147483648,43.0e12,17,abc,def\r\n',
793 '147483648,43.0e2,17,abc,def\r\n',
794 '47483648,43.0,170,abc,def\r\n'
795 ]
796
797 reader = csv.DictReader(sample,
798 fieldnames="i1 float i2 s1 s2".split())
Georg Brandla18af4e2007-04-21 15:47:16 +0000799 self.assertEqual(next(reader), {"i1": '2147483648',
Skip Montanaro1546bc42003-06-12 02:40:22 +0000800 "float": '43.0e12',
801 "i2": '17',
802 "s1": 'abc',
803 "s2": 'def'})
804
Skip Montanarob4a04172003-03-20 23:29:12 +0000805 def test_read_with_blanks(self):
806 reader = csv.DictReader(["1,2,abc,4,5,6\r\n","\r\n",
807 "1,2,abc,4,5,6\r\n"],
808 fieldnames="1 2 3 4 5 6".split())
Georg Brandla18af4e2007-04-21 15:47:16 +0000809 self.assertEqual(next(reader), {"1": '1', "2": '2', "3": 'abc',
Skip Montanarob4a04172003-03-20 23:29:12 +0000810 "4": '4', "5": '5', "6": '6'})
Georg Brandla18af4e2007-04-21 15:47:16 +0000811 self.assertEqual(next(reader), {"1": '1', "2": '2', "3": 'abc',
Skip Montanarob4a04172003-03-20 23:29:12 +0000812 "4": '4', "5": '5', "6": '6'})
813
Skip Montanaro3f7a9482003-09-06 19:52:12 +0000814 def test_read_semi_sep(self):
815 reader = csv.DictReader(["1;2;abc;4;5;6\r\n"],
816 fieldnames="1 2 3 4 5 6".split(),
817 delimiter=';')
Georg Brandla18af4e2007-04-21 15:47:16 +0000818 self.assertEqual(next(reader), {"1": '1', "2": '2', "3": 'abc',
Skip Montanaro3f7a9482003-09-06 19:52:12 +0000819 "4": '4', "5": '5', "6": '6'})
820
Skip Montanarob4a04172003-03-20 23:29:12 +0000821class TestArrayWrites(unittest.TestCase):
822 def test_int_write(self):
823 import array
824 contents = [(20-i) for i in range(20)]
825 a = array.array('i', contents)
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000826
Inada Naoki35715d12021-04-04 09:01:23 +0900827 with TemporaryFile("w+", encoding="utf-8", 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_double_write(self):
835 import array
836 contents = [(20-i)*0.1 for i in range(20)]
837 a = array.array('d', contents)
Inada Naoki35715d12021-04-04 09:01:23 +0900838 with TemporaryFile("w+", encoding="utf-8", newline='') as fileobj:
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000839 writer = csv.writer(fileobj, dialect="excel")
840 writer.writerow(a)
841 expected = ",".join([str(i) for i in 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
845 def test_float_write(self):
846 import array
847 contents = [(20-i)*0.1 for i in range(20)]
848 a = array.array('f', contents)
Inada Naoki35715d12021-04-04 09:01:23 +0900849 with TemporaryFile("w+", encoding="utf-8", newline='') as fileobj:
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000850 writer = csv.writer(fileobj, dialect="excel")
851 writer.writerow(a)
852 expected = ",".join([str(i) for i in a])+"\r\n"
853 fileobj.seek(0)
Guido van Rossumf0c74162007-08-28 03:29:45 +0000854 self.assertEqual(fileobj.read(), expected)
Skip Montanarob4a04172003-03-20 23:29:12 +0000855
856 def test_char_write(self):
857 import array, string
Martin v. Löwis967f1e32007-08-14 09:23:10 +0000858 a = array.array('u', string.ascii_letters)
Guido van Rossum46264582007-08-06 19:32:18 +0000859
Inada Naoki35715d12021-04-04 09:01:23 +0900860 with TemporaryFile("w+", encoding="utf-8", newline='') as fileobj:
Skip Montanaro58fc5d082004-06-05 17:03:20 +0000861 writer = csv.writer(fileobj, dialect="excel")
862 writer.writerow(a)
863 expected = ",".join(a)+"\r\n"
864 fileobj.seek(0)
Guido van Rossumf0c74162007-08-28 03:29:45 +0000865 self.assertEqual(fileobj.read(), expected)
Skip Montanarob4a04172003-03-20 23:29:12 +0000866
867class TestDialectValidity(unittest.TestCase):
868 def test_quoting(self):
869 class mydialect(csv.Dialect):
870 delimiter = ";"
871 escapechar = '\\'
872 doublequote = False
873 skipinitialspace = True
874 lineterminator = '\r\n'
875 quoting = csv.QUOTE_NONE
876 d = mydialect()
Serhiy Storchakacac23a52013-12-19 16:27:18 +0200877 self.assertEqual(d.quoting, csv.QUOTE_NONE)
Skip Montanarob4a04172003-03-20 23:29:12 +0000878
879 mydialect.quoting = None
880 self.assertRaises(csv.Error, mydialect)
881
Skip Montanarob4a04172003-03-20 23:29:12 +0000882 mydialect.doublequote = True
883 mydialect.quoting = csv.QUOTE_ALL
884 mydialect.quotechar = '"'
885 d = mydialect()
Serhiy Storchakacac23a52013-12-19 16:27:18 +0200886 self.assertEqual(d.quoting, csv.QUOTE_ALL)
887 self.assertEqual(d.quotechar, '"')
888 self.assertTrue(d.doublequote)
Skip Montanarob4a04172003-03-20 23:29:12 +0000889
890 mydialect.quotechar = "''"
Serhiy Storchakacac23a52013-12-19 16:27:18 +0200891 with self.assertRaises(csv.Error) as cm:
892 mydialect()
893 self.assertEqual(str(cm.exception),
Berker Peksag0f41acb2014-07-27 23:22:34 +0300894 '"quotechar" must be a 1-character string')
Skip Montanarob4a04172003-03-20 23:29:12 +0000895
896 mydialect.quotechar = 4
Serhiy Storchakacac23a52013-12-19 16:27:18 +0200897 with self.assertRaises(csv.Error) as cm:
898 mydialect()
899 self.assertEqual(str(cm.exception),
900 '"quotechar" must be string, not int')
Skip Montanarob4a04172003-03-20 23:29:12 +0000901
902 def test_delimiter(self):
903 class mydialect(csv.Dialect):
904 delimiter = ";"
905 escapechar = '\\'
906 doublequote = False
907 skipinitialspace = True
908 lineterminator = '\r\n'
909 quoting = csv.QUOTE_NONE
910 d = mydialect()
Serhiy Storchakacac23a52013-12-19 16:27:18 +0200911 self.assertEqual(d.delimiter, ";")
Skip Montanarob4a04172003-03-20 23:29:12 +0000912
913 mydialect.delimiter = ":::"
Serhiy Storchakacac23a52013-12-19 16:27:18 +0200914 with self.assertRaises(csv.Error) as cm:
915 mydialect()
916 self.assertEqual(str(cm.exception),
Berker Peksag0f41acb2014-07-27 23:22:34 +0300917 '"delimiter" must be a 1-character string')
Serhiy Storchakacac23a52013-12-19 16:27:18 +0200918
919 mydialect.delimiter = ""
920 with self.assertRaises(csv.Error) as cm:
921 mydialect()
922 self.assertEqual(str(cm.exception),
Berker Peksag0f41acb2014-07-27 23:22:34 +0300923 '"delimiter" must be a 1-character string')
Serhiy Storchakacac23a52013-12-19 16:27:18 +0200924
925 mydialect.delimiter = b","
926 with self.assertRaises(csv.Error) as cm:
927 mydialect()
928 self.assertEqual(str(cm.exception),
929 '"delimiter" must be string, not bytes')
Skip Montanarob4a04172003-03-20 23:29:12 +0000930
931 mydialect.delimiter = 4
Serhiy Storchakacac23a52013-12-19 16:27:18 +0200932 with self.assertRaises(csv.Error) as cm:
933 mydialect()
934 self.assertEqual(str(cm.exception),
935 '"delimiter" must be string, not int')
Skip Montanarob4a04172003-03-20 23:29:12 +0000936
937 def test_lineterminator(self):
938 class mydialect(csv.Dialect):
939 delimiter = ";"
940 escapechar = '\\'
941 doublequote = False
942 skipinitialspace = True
943 lineterminator = '\r\n'
944 quoting = csv.QUOTE_NONE
945 d = mydialect()
Serhiy Storchakacac23a52013-12-19 16:27:18 +0200946 self.assertEqual(d.lineterminator, '\r\n')
Skip Montanarob4a04172003-03-20 23:29:12 +0000947
948 mydialect.lineterminator = ":::"
949 d = mydialect()
Serhiy Storchakacac23a52013-12-19 16:27:18 +0200950 self.assertEqual(d.lineterminator, ":::")
Skip Montanarob4a04172003-03-20 23:29:12 +0000951
952 mydialect.lineterminator = 4
Serhiy Storchakacac23a52013-12-19 16:27:18 +0200953 with self.assertRaises(csv.Error) as cm:
954 mydialect()
955 self.assertEqual(str(cm.exception),
956 '"lineterminator" must be a string')
Skip Montanarob4a04172003-03-20 23:29:12 +0000957
Victor Stinner6a31b0f2014-01-02 12:53:13 +0100958 def test_invalid_chars(self):
959 def create_invalid(field_name, value):
960 class mydialect(csv.Dialect):
961 pass
962 setattr(mydialect, field_name, value)
963 d = mydialect()
964
965 for field_name in ("delimiter", "escapechar", "quotechar"):
Victor Stinner009771e2014-01-02 12:53:50 +0100966 with self.subTest(field_name=field_name):
967 self.assertRaises(csv.Error, create_invalid, field_name, "")
968 self.assertRaises(csv.Error, create_invalid, field_name, "abc")
969 self.assertRaises(csv.Error, create_invalid, field_name, b'x')
970 self.assertRaises(csv.Error, create_invalid, field_name, 5)
Victor Stinner6a31b0f2014-01-02 12:53:13 +0100971
Skip Montanarob4a04172003-03-20 23:29:12 +0000972
Skip Montanaro48816c62003-04-25 14:43:14 +0000973class TestSniffer(unittest.TestCase):
974 sample1 = """\
975Harry's, Arlington Heights, IL, 2/1/03, Kimi Hayes
976Shark City, Glendale Heights, IL, 12/28/02, Prezence
977Tommy's Place, Blue Island, IL, 12/28/02, Blue Sunday/White Crow
978Stonecutters Seafood and Chop House, Lemont, IL, 12/19/02, Week Back
979"""
980 sample2 = """\
981'Harry''s':'Arlington Heights':'IL':'2/1/03':'Kimi Hayes'
982'Shark City':'Glendale Heights':'IL':'12/28/02':'Prezence'
983'Tommy''s Place':'Blue Island':'IL':'12/28/02':'Blue Sunday/White Crow'
Benjamin Peterson4ac9ce42009-10-04 14:49:41 +0000984'Stonecutters ''Seafood'' and Chop House':'Lemont':'IL':'12/19/02':'Week Back'
Skip Montanaro48816c62003-04-25 14:43:14 +0000985"""
R David Murray925a3222013-06-29 18:40:53 -0400986 header1 = '''\
Skip Montanaro48816c62003-04-25 14:43:14 +0000987"venue","city","state","date","performers"
988'''
Skip Montanaro77892372003-05-19 15:33:36 +0000989 sample3 = '''\
99005/05/03?05/05/03?05/05/03?05/05/03?05/05/03?05/05/03
99105/05/03?05/05/03?05/05/03?05/05/03?05/05/03?05/05/03
99205/05/03?05/05/03?05/05/03?05/05/03?05/05/03?05/05/03
993'''
994
Skip Montanaro1546bc42003-06-12 02:40:22 +0000995 sample4 = '''\
9962147483648;43.0e12;17;abc;def
997147483648;43.0e2;17;abc;def
99847483648;43.0;170;abc;def
999'''
1000
Skip Montanaro91bb70c2005-12-28 15:37:25 +00001001 sample5 = "aaa\tbbb\r\nAAA\t\r\nBBB\t\r\n"
Skip Montanaro39b29be2005-12-30 05:09:48 +00001002 sample6 = "a|b|c\r\nd|e|f\r\n"
1003 sample7 = "'a'|'b'|'c'\r\n'd'|e|f\r\n"
Skip Montanaro91bb70c2005-12-28 15:37:25 +00001004
R David Murray925a3222013-06-29 18:40:53 -04001005# Issue 18155: Use a delimiter that is a special char to regex:
1006
1007 header2 = '''\
1008"venue"+"city"+"state"+"date"+"performers"
1009'''
1010 sample8 = """\
1011Harry's+ Arlington Heights+ IL+ 2/1/03+ Kimi Hayes
1012Shark City+ Glendale Heights+ IL+ 12/28/02+ Prezence
1013Tommy's Place+ Blue Island+ IL+ 12/28/02+ Blue Sunday/White Crow
1014Stonecutters Seafood and Chop House+ Lemont+ IL+ 12/19/02+ Week Back
1015"""
1016 sample9 = """\
1017'Harry''s'+ Arlington Heights'+ 'IL'+ '2/1/03'+ 'Kimi Hayes'
1018'Shark City'+ Glendale Heights'+' IL'+ '12/28/02'+ 'Prezence'
1019'Tommy''s Place'+ Blue Island'+ 'IL'+ '12/28/02'+ 'Blue Sunday/White Crow'
1020'Stonecutters ''Seafood'' and Chop House'+ 'Lemont'+ 'IL'+ '12/19/02'+ 'Week Back'
1021"""
1022
Miss Islington (bot)440c9f72021-07-30 10:30:09 -07001023 sample10 = dedent("""
1024 abc,def
1025 ghijkl,mno
1026 ghi,jkl
1027 """)
1028
1029 sample11 = dedent("""
1030 abc,def
1031 ghijkl,mnop
1032 ghi,jkl
1033 """)
1034
1035 sample12 = dedent(""""time","forces"
1036 1,1.5
1037 0.5,5+0j
1038 0,0
1039 1+1j,6
1040 """)
1041
1042 sample13 = dedent(""""time","forces"
1043 0,0
1044 1,2
1045 a,b
1046 """)
1047
1048 def test_issue43625(self):
1049 sniffer = csv.Sniffer()
1050 self.assertTrue(sniffer.has_header(self.sample12))
1051 self.assertFalse(sniffer.has_header(self.sample13))
1052
1053 def test_has_header_strings(self):
1054 "More to document existing (unexpected?) behavior than anything else."
1055 sniffer = csv.Sniffer()
1056 self.assertFalse(sniffer.has_header(self.sample10))
1057 self.assertFalse(sniffer.has_header(self.sample11))
1058
Skip Montanaro48816c62003-04-25 14:43:14 +00001059 def test_has_header(self):
1060 sniffer = csv.Sniffer()
Serhiy Storchaka323748a2018-07-26 13:21:09 +03001061 self.assertIs(sniffer.has_header(self.sample1), False)
1062 self.assertIs(sniffer.has_header(self.header1 + self.sample1), True)
R David Murray925a3222013-06-29 18:40:53 -04001063
1064 def test_has_header_regex_special_delimiter(self):
1065 sniffer = csv.Sniffer()
Serhiy Storchaka323748a2018-07-26 13:21:09 +03001066 self.assertIs(sniffer.has_header(self.sample8), False)
1067 self.assertIs(sniffer.has_header(self.header2 + self.sample8), True)
Skip Montanaro48816c62003-04-25 14:43:14 +00001068
Serhiy Storchaka24112922018-02-09 20:00:49 +02001069 def test_guess_quote_and_delimiter(self):
1070 sniffer = csv.Sniffer()
1071 for header in (";'123;4';", "'123;4';", ";'123;4'", "'123;4'"):
1072 with self.subTest(header):
1073 dialect = sniffer.sniff(header, ",;")
1074 self.assertEqual(dialect.delimiter, ';')
1075 self.assertEqual(dialect.quotechar, "'")
1076 self.assertIs(dialect.doublequote, False)
1077 self.assertIs(dialect.skipinitialspace, False)
1078
Skip Montanaro48816c62003-04-25 14:43:14 +00001079 def test_sniff(self):
1080 sniffer = csv.Sniffer()
1081 dialect = sniffer.sniff(self.sample1)
1082 self.assertEqual(dialect.delimiter, ",")
1083 self.assertEqual(dialect.quotechar, '"')
Serhiy Storchaka323748a2018-07-26 13:21:09 +03001084 self.assertIs(dialect.skipinitialspace, True)
Skip Montanaro48816c62003-04-25 14:43:14 +00001085
1086 dialect = sniffer.sniff(self.sample2)
1087 self.assertEqual(dialect.delimiter, ":")
1088 self.assertEqual(dialect.quotechar, "'")
Serhiy Storchaka323748a2018-07-26 13:21:09 +03001089 self.assertIs(dialect.skipinitialspace, False)
Skip Montanaro48816c62003-04-25 14:43:14 +00001090
Skip Montanaro77892372003-05-19 15:33:36 +00001091 def test_delimiters(self):
1092 sniffer = csv.Sniffer()
1093 dialect = sniffer.sniff(self.sample3)
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00001094 # given that all three lines in sample3 are equal,
1095 # I think that any character could have been 'guessed' as the
1096 # delimiter, depending on dictionary order
Benjamin Peterson577473f2010-01-19 00:09:57 +00001097 self.assertIn(dialect.delimiter, self.sample3)
Skip Montanaro77892372003-05-19 15:33:36 +00001098 dialect = sniffer.sniff(self.sample3, delimiters="?,")
1099 self.assertEqual(dialect.delimiter, "?")
1100 dialect = sniffer.sniff(self.sample3, delimiters="/,")
1101 self.assertEqual(dialect.delimiter, "/")
Skip Montanaro1546bc42003-06-12 02:40:22 +00001102 dialect = sniffer.sniff(self.sample4)
1103 self.assertEqual(dialect.delimiter, ";")
Skip Montanaro91bb70c2005-12-28 15:37:25 +00001104 dialect = sniffer.sniff(self.sample5)
1105 self.assertEqual(dialect.delimiter, "\t")
Skip Montanaro39b29be2005-12-30 05:09:48 +00001106 dialect = sniffer.sniff(self.sample6)
1107 self.assertEqual(dialect.delimiter, "|")
1108 dialect = sniffer.sniff(self.sample7)
1109 self.assertEqual(dialect.delimiter, "|")
1110 self.assertEqual(dialect.quotechar, "'")
R David Murray925a3222013-06-29 18:40:53 -04001111 dialect = sniffer.sniff(self.sample8)
1112 self.assertEqual(dialect.delimiter, '+')
1113 dialect = sniffer.sniff(self.sample9)
1114 self.assertEqual(dialect.delimiter, '+')
1115 self.assertEqual(dialect.quotechar, "'")
Skip Montanaro77892372003-05-19 15:33:36 +00001116
Benjamin Peterson4ac9ce42009-10-04 14:49:41 +00001117 def test_doublequote(self):
1118 sniffer = csv.Sniffer()
R David Murray925a3222013-06-29 18:40:53 -04001119 dialect = sniffer.sniff(self.header1)
1120 self.assertFalse(dialect.doublequote)
1121 dialect = sniffer.sniff(self.header2)
Benjamin Peterson4ac9ce42009-10-04 14:49:41 +00001122 self.assertFalse(dialect.doublequote)
1123 dialect = sniffer.sniff(self.sample2)
1124 self.assertTrue(dialect.doublequote)
R David Murray925a3222013-06-29 18:40:53 -04001125 dialect = sniffer.sniff(self.sample8)
1126 self.assertFalse(dialect.doublequote)
1127 dialect = sniffer.sniff(self.sample9)
1128 self.assertTrue(dialect.doublequote)
Benjamin Peterson4ac9ce42009-10-04 14:49:41 +00001129
Serhiy Storchaka43767632013-11-03 21:31:38 +02001130class NUL:
1131 def write(s, *args):
1132 pass
1133 writelines = write
Skip Montanarob4a04172003-03-20 23:29:12 +00001134
Serhiy Storchaka43767632013-11-03 21:31:38 +02001135@unittest.skipUnless(hasattr(sys, "gettotalrefcount"),
1136 'requires sys.gettotalrefcount()')
1137class TestLeaks(unittest.TestCase):
1138 def test_create_read(self):
1139 delta = 0
1140 lastrc = sys.gettotalrefcount()
1141 for i in range(20):
1142 gc.collect()
1143 self.assertEqual(gc.garbage, [])
1144 rc = sys.gettotalrefcount()
1145 csv.reader(["a,b,c\r\n"])
1146 csv.reader(["a,b,c\r\n"])
1147 csv.reader(["a,b,c\r\n"])
1148 delta = rc-lastrc
1149 lastrc = rc
1150 # if csv.reader() leaks, last delta should be 3 or more
Serhiy Storchaka323748a2018-07-26 13:21:09 +03001151 self.assertLess(delta, 3)
Skip Montanarob4a04172003-03-20 23:29:12 +00001152
Serhiy Storchaka43767632013-11-03 21:31:38 +02001153 def test_create_write(self):
1154 delta = 0
1155 lastrc = sys.gettotalrefcount()
1156 s = NUL()
1157 for i in range(20):
1158 gc.collect()
1159 self.assertEqual(gc.garbage, [])
1160 rc = sys.gettotalrefcount()
1161 csv.writer(s)
1162 csv.writer(s)
1163 csv.writer(s)
1164 delta = rc-lastrc
1165 lastrc = rc
1166 # if csv.writer() leaks, last delta should be 3 or more
Serhiy Storchaka323748a2018-07-26 13:21:09 +03001167 self.assertLess(delta, 3)
Skip Montanarob4a04172003-03-20 23:29:12 +00001168
Serhiy Storchaka43767632013-11-03 21:31:38 +02001169 def test_read(self):
1170 delta = 0
1171 rows = ["a,b,c\r\n"]*5
1172 lastrc = sys.gettotalrefcount()
1173 for i in range(20):
1174 gc.collect()
1175 self.assertEqual(gc.garbage, [])
1176 rc = sys.gettotalrefcount()
1177 rdr = csv.reader(rows)
1178 for row in rdr:
1179 pass
1180 delta = rc-lastrc
1181 lastrc = rc
1182 # if reader leaks during read, delta should be 5 or more
Serhiy Storchaka323748a2018-07-26 13:21:09 +03001183 self.assertLess(delta, 5)
Skip Montanarob4a04172003-03-20 23:29:12 +00001184
Serhiy Storchaka43767632013-11-03 21:31:38 +02001185 def test_write(self):
1186 delta = 0
1187 rows = [[1,2,3]]*5
1188 s = NUL()
1189 lastrc = sys.gettotalrefcount()
1190 for i in range(20):
1191 gc.collect()
1192 self.assertEqual(gc.garbage, [])
1193 rc = sys.gettotalrefcount()
1194 writer = csv.writer(s)
1195 for row in rows:
1196 writer.writerow(row)
1197 delta = rc-lastrc
1198 lastrc = rc
1199 # if writer leaks during write, last delta should be 5 or more
Serhiy Storchaka323748a2018-07-26 13:21:09 +03001200 self.assertLess(delta, 5)
Skip Montanarob4a04172003-03-20 23:29:12 +00001201
Guido van Rossum46264582007-08-06 19:32:18 +00001202class TestUnicode(unittest.TestCase):
1203
1204 names = ["Martin von Löwis",
1205 "Marc André Lemburg",
1206 "Guido van Rossum",
1207 "François Pinard"]
1208
1209 def test_unicode_read(self):
Guido van Rossumf0c74162007-08-28 03:29:45 +00001210 with TemporaryFile("w+", newline='', encoding="utf-8") as fileobj:
Guido van Rossum46264582007-08-06 19:32:18 +00001211 fileobj.write(",".join(self.names) + "\r\n")
Guido van Rossum46264582007-08-06 19:32:18 +00001212 fileobj.seek(0)
1213 reader = csv.reader(fileobj)
1214 self.assertEqual(list(reader), [self.names])
1215
1216
1217 def test_unicode_write(self):
Guido van Rossumf0c74162007-08-28 03:29:45 +00001218 with TemporaryFile("w+", newline='', encoding="utf-8") as fileobj:
1219 writer = csv.writer(fileobj)
Guido van Rossum46264582007-08-06 19:32:18 +00001220 writer.writerow(self.names)
1221 expected = ",".join(self.names)+"\r\n"
1222 fileobj.seek(0)
Guido van Rossumf0c74162007-08-28 03:29:45 +00001223 self.assertEqual(fileobj.read(), expected)
Guido van Rossum46264582007-08-06 19:32:18 +00001224
Raymond Hettinger43ca4522016-08-30 12:35:50 -07001225class KeyOrderingTest(unittest.TestCase):
1226
1227 def test_ordering_for_the_dict_reader_and_writer(self):
1228 resultset = set()
1229 for keys in permutations("abcde"):
1230 with TemporaryFile('w+', newline='', encoding="utf-8") as fileobject:
1231 dw = csv.DictWriter(fileobject, keys)
1232 dw.writeheader()
1233 fileobject.seek(0)
1234 dr = csv.DictReader(fileobject)
1235 kt = tuple(dr.fieldnames)
1236 self.assertEqual(keys, kt)
1237 resultset.add(kt)
1238 # Final sanity check: were all permutations unique?
1239 self.assertEqual(len(resultset), 120, "Key ordering: some key permutations not collected (expected 120)")
Guido van Rossum46264582007-08-06 19:32:18 +00001240
Raymond Hettinger8ca35702016-08-30 12:57:26 -07001241 def test_ordered_dict_reader(self):
1242 data = dedent('''\
1243 FirstName,LastName
1244 Eric,Idle
1245 Graham,Chapman,Over1,Over2
1246
1247 Under1
1248 John,Cleese
1249 ''').splitlines()
1250
1251 self.assertEqual(list(csv.DictReader(data)),
1252 [OrderedDict([('FirstName', 'Eric'), ('LastName', 'Idle')]),
1253 OrderedDict([('FirstName', 'Graham'), ('LastName', 'Chapman'),
1254 (None, ['Over1', 'Over2'])]),
1255 OrderedDict([('FirstName', 'Under1'), ('LastName', None)]),
1256 OrderedDict([('FirstName', 'John'), ('LastName', 'Cleese')]),
1257 ])
1258
1259 self.assertEqual(list(csv.DictReader(data, restkey='OtherInfo')),
1260 [OrderedDict([('FirstName', 'Eric'), ('LastName', 'Idle')]),
1261 OrderedDict([('FirstName', 'Graham'), ('LastName', 'Chapman'),
1262 ('OtherInfo', ['Over1', 'Over2'])]),
1263 OrderedDict([('FirstName', 'Under1'), ('LastName', None)]),
1264 OrderedDict([('FirstName', 'John'), ('LastName', 'Cleese')]),
1265 ])
1266
1267 del data[0] # Remove the header row
1268 self.assertEqual(list(csv.DictReader(data, fieldnames=['fname', 'lname'])),
1269 [OrderedDict([('fname', 'Eric'), ('lname', 'Idle')]),
1270 OrderedDict([('fname', 'Graham'), ('lname', 'Chapman'),
1271 (None, ['Over1', 'Over2'])]),
1272 OrderedDict([('fname', 'Under1'), ('lname', None)]),
1273 OrderedDict([('fname', 'John'), ('lname', 'Cleese')]),
1274 ])
1275
1276
Martin Panter19e69c52015-11-14 12:46:42 +00001277class MiscTestCase(unittest.TestCase):
1278 def test__all__(self):
1279 extra = {'__doc__', '__version__'}
1280 support.check__all__(self, csv, ('csv', '_csv'), extra=extra)
1281
Miss Islington (bot)3e44e9a2021-05-12 07:02:46 -07001282 def test_subclassable(self):
1283 # issue 44089
1284 class Foo(csv.Error): ...
Martin Panter19e69c52015-11-14 12:46:42 +00001285
Skip Montanarob4a04172003-03-20 23:29:12 +00001286if __name__ == '__main__':
Zachary Ware38c707e2015-04-13 15:00:43 -05001287 unittest.main()