PageRenderTime 51ms CodeModel.GetById 17ms RepoModel.GetById 0ms app.codeStats 1ms

/lib-python/modified-2.7/test/test_csv.py

https://bitbucket.org/dac_io/pypy
Python | 1057 lines | 1043 code | 5 blank | 9 comment | 2 complexity | 5a9ab7655f00ad05283d46e2e3d036f6 MD5 | raw file
  1. # -*- coding: iso-8859-1 -*-
  2. # Copyright (C) 2001,2002 Python Software Foundation
  3. # csv package unit tests
  4. import sys
  5. import os
  6. import unittest
  7. from StringIO import StringIO
  8. import tempfile
  9. import csv
  10. import gc
  11. import io
  12. from test import test_support
  13. class Test_Csv(unittest.TestCase):
  14. """
  15. Test the underlying C csv parser in ways that are not appropriate
  16. from the high level interface. Further tests of this nature are done
  17. in TestDialectRegistry.
  18. """
  19. def _test_arg_valid(self, ctor, arg):
  20. self.assertRaises(TypeError, ctor)
  21. self.assertRaises(TypeError, ctor, None)
  22. self.assertRaises(TypeError, ctor, arg, bad_attr = 0)
  23. self.assertRaises(TypeError, ctor, arg, delimiter = 0)
  24. self.assertRaises(TypeError, ctor, arg, delimiter = 'XX')
  25. self.assertRaises(csv.Error, ctor, arg, 'foo')
  26. self.assertRaises(TypeError, ctor, arg, delimiter=None)
  27. self.assertRaises(TypeError, ctor, arg, delimiter=1)
  28. self.assertRaises(TypeError, ctor, arg, quotechar=1)
  29. self.assertRaises(TypeError, ctor, arg, lineterminator=None)
  30. self.assertRaises(TypeError, ctor, arg, lineterminator=1)
  31. self.assertRaises(TypeError, ctor, arg, quoting=None)
  32. self.assertRaises(TypeError, ctor, arg,
  33. quoting=csv.QUOTE_ALL, quotechar='')
  34. self.assertRaises(TypeError, ctor, arg,
  35. quoting=csv.QUOTE_ALL, quotechar=None)
  36. def test_reader_arg_valid(self):
  37. self._test_arg_valid(csv.reader, [])
  38. def test_writer_arg_valid(self):
  39. self._test_arg_valid(csv.writer, StringIO())
  40. def _test_default_attrs(self, ctor, *args):
  41. obj = ctor(*args)
  42. # Check defaults
  43. self.assertEqual(obj.dialect.delimiter, ',')
  44. self.assertEqual(obj.dialect.doublequote, True)
  45. self.assertEqual(obj.dialect.escapechar, None)
  46. self.assertEqual(obj.dialect.lineterminator, "\r\n")
  47. self.assertEqual(obj.dialect.quotechar, '"')
  48. self.assertEqual(obj.dialect.quoting, csv.QUOTE_MINIMAL)
  49. self.assertEqual(obj.dialect.skipinitialspace, False)
  50. self.assertEqual(obj.dialect.strict, False)
  51. # Try deleting or changing attributes (they are read-only)
  52. self.assertRaises((TypeError, AttributeError), delattr, obj.dialect,
  53. 'delimiter')
  54. self.assertRaises((TypeError, AttributeError), setattr, obj.dialect,
  55. 'delimiter', ':')
  56. self.assertRaises(AttributeError, delattr, obj.dialect, 'quoting')
  57. self.assertRaises(AttributeError, setattr, obj.dialect,
  58. 'quoting', None)
  59. def test_reader_attrs(self):
  60. self._test_default_attrs(csv.reader, [])
  61. def test_writer_attrs(self):
  62. self._test_default_attrs(csv.writer, StringIO())
  63. def _test_kw_attrs(self, ctor, *args):
  64. # Now try with alternate options
  65. kwargs = dict(delimiter=':', doublequote=False, escapechar='\\',
  66. lineterminator='\r', quotechar='*',
  67. quoting=csv.QUOTE_NONE, skipinitialspace=True,
  68. strict=True)
  69. obj = ctor(*args, **kwargs)
  70. self.assertEqual(obj.dialect.delimiter, ':')
  71. self.assertEqual(obj.dialect.doublequote, False)
  72. self.assertEqual(obj.dialect.escapechar, '\\')
  73. self.assertEqual(obj.dialect.lineterminator, "\r")
  74. self.assertEqual(obj.dialect.quotechar, '*')
  75. self.assertEqual(obj.dialect.quoting, csv.QUOTE_NONE)
  76. self.assertEqual(obj.dialect.skipinitialspace, True)
  77. self.assertEqual(obj.dialect.strict, True)
  78. def test_reader_kw_attrs(self):
  79. self._test_kw_attrs(csv.reader, [])
  80. def test_writer_kw_attrs(self):
  81. self._test_kw_attrs(csv.writer, StringIO())
  82. def _test_dialect_attrs(self, ctor, *args):
  83. # Now try with dialect-derived options
  84. class dialect:
  85. delimiter='-'
  86. doublequote=False
  87. escapechar='^'
  88. lineterminator='$'
  89. quotechar='#'
  90. quoting=csv.QUOTE_ALL
  91. skipinitialspace=True
  92. strict=False
  93. args = args + (dialect,)
  94. obj = ctor(*args)
  95. self.assertEqual(obj.dialect.delimiter, '-')
  96. self.assertEqual(obj.dialect.doublequote, False)
  97. self.assertEqual(obj.dialect.escapechar, '^')
  98. self.assertEqual(obj.dialect.lineterminator, "$")
  99. self.assertEqual(obj.dialect.quotechar, '#')
  100. self.assertEqual(obj.dialect.quoting, csv.QUOTE_ALL)
  101. self.assertEqual(obj.dialect.skipinitialspace, True)
  102. self.assertEqual(obj.dialect.strict, False)
  103. def test_reader_dialect_attrs(self):
  104. self._test_dialect_attrs(csv.reader, [])
  105. def test_writer_dialect_attrs(self):
  106. self._test_dialect_attrs(csv.writer, StringIO())
  107. def _write_test(self, fields, expect, **kwargs):
  108. fd, name = tempfile.mkstemp()
  109. fileobj = os.fdopen(fd, "w+b")
  110. try:
  111. writer = csv.writer(fileobj, **kwargs)
  112. writer.writerow(fields)
  113. fileobj.seek(0)
  114. self.assertEqual(fileobj.read(),
  115. expect + writer.dialect.lineterminator)
  116. finally:
  117. fileobj.close()
  118. os.unlink(name)
  119. def test_write_arg_valid(self):
  120. self.assertRaises(csv.Error, self._write_test, None, '')
  121. self._write_test((), '')
  122. self._write_test([None], '""')
  123. self.assertRaises(csv.Error, self._write_test,
  124. [None], None, quoting = csv.QUOTE_NONE)
  125. # Check that exceptions are passed up the chain
  126. class BadList:
  127. def __len__(self):
  128. return 10;
  129. def __getitem__(self, i):
  130. if i > 2:
  131. raise IOError
  132. self.assertRaises(IOError, self._write_test, BadList(), '')
  133. class BadItem:
  134. def __str__(self):
  135. raise IOError
  136. self.assertRaises(IOError, self._write_test, [BadItem()], '')
  137. def test_write_bigfield(self):
  138. # This exercises the buffer realloc functionality
  139. bigstring = 'X' * 50000
  140. self._write_test([bigstring,bigstring], '%s,%s' % \
  141. (bigstring, bigstring))
  142. def test_write_quoting(self):
  143. self._write_test(['a',1,'p,q'], 'a,1,"p,q"')
  144. self.assertRaises(csv.Error,
  145. self._write_test,
  146. ['a',1,'p,q'], 'a,1,p,q',
  147. quoting = csv.QUOTE_NONE)
  148. self._write_test(['a',1,'p,q'], 'a,1,"p,q"',
  149. quoting = csv.QUOTE_MINIMAL)
  150. self._write_test(['a',1,'p,q'], '"a",1,"p,q"',
  151. quoting = csv.QUOTE_NONNUMERIC)
  152. self._write_test(['a',1,'p,q'], '"a","1","p,q"',
  153. quoting = csv.QUOTE_ALL)
  154. self._write_test(['a\nb',1], '"a\nb","1"',
  155. quoting = csv.QUOTE_ALL)
  156. def test_write_escape(self):
  157. self._write_test(['a',1,'p,q'], 'a,1,"p,q"',
  158. escapechar='\\')
  159. self.assertRaises(csv.Error,
  160. self._write_test,
  161. ['a',1,'p,"q"'], 'a,1,"p,\\"q\\""',
  162. escapechar=None, doublequote=False)
  163. self._write_test(['a',1,'p,"q"'], 'a,1,"p,\\"q\\""',
  164. escapechar='\\', doublequote = False)
  165. self._write_test(['"'], '""""',
  166. escapechar='\\', quoting = csv.QUOTE_MINIMAL)
  167. self._write_test(['"'], '\\"',
  168. escapechar='\\', quoting = csv.QUOTE_MINIMAL,
  169. doublequote = False)
  170. self._write_test(['"'], '\\"',
  171. escapechar='\\', quoting = csv.QUOTE_NONE)
  172. self._write_test(['a',1,'p,q'], 'a,1,p\\,q',
  173. escapechar='\\', quoting = csv.QUOTE_NONE)
  174. def test_writerows(self):
  175. class BrokenFile:
  176. def write(self, buf):
  177. raise IOError
  178. writer = csv.writer(BrokenFile())
  179. self.assertRaises(IOError, writer.writerows, [['a']])
  180. fd, name = tempfile.mkstemp()
  181. fileobj = os.fdopen(fd, "w+b")
  182. try:
  183. writer = csv.writer(fileobj)
  184. self.assertRaises(TypeError, writer.writerows, None)
  185. writer.writerows([['a','b'],['c','d']])
  186. fileobj.seek(0)
  187. self.assertEqual(fileobj.read(), "a,b\r\nc,d\r\n")
  188. finally:
  189. fileobj.close()
  190. os.unlink(name)
  191. def _read_test(self, input, expect, **kwargs):
  192. reader = csv.reader(input, **kwargs)
  193. result = list(reader)
  194. self.assertEqual(result, expect)
  195. def test_read_oddinputs(self):
  196. self._read_test([], [])
  197. self._read_test([''], [[]])
  198. self.assertRaises(csv.Error, self._read_test,
  199. ['"ab"c'], None, strict = 1)
  200. # cannot handle null bytes for the moment
  201. self.assertRaises(csv.Error, self._read_test,
  202. ['ab\0c'], None, strict = 1)
  203. self._read_test(['"ab"c'], [['abc']], doublequote = 0)
  204. def test_read_eol(self):
  205. self._read_test(['a,b'], [['a','b']])
  206. self._read_test(['a,b\n'], [['a','b']])
  207. self._read_test(['a,b\r\n'], [['a','b']])
  208. self._read_test(['a,b\r'], [['a','b']])
  209. self.assertRaises(csv.Error, self._read_test, ['a,b\rc,d'], [])
  210. self.assertRaises(csv.Error, self._read_test, ['a,b\nc,d'], [])
  211. self.assertRaises(csv.Error, self._read_test, ['a,b\r\nc,d'], [])
  212. def test_read_escape(self):
  213. self._read_test(['a,\\b,c'], [['a', 'b', 'c']], escapechar='\\')
  214. self._read_test(['a,b\\,c'], [['a', 'b,c']], escapechar='\\')
  215. self._read_test(['a,"b\\,c"'], [['a', 'b,c']], escapechar='\\')
  216. self._read_test(['a,"b,\\c"'], [['a', 'b,c']], escapechar='\\')
  217. self._read_test(['a,"b,c\\""'], [['a', 'b,c"']], escapechar='\\')
  218. self._read_test(['a,"b,c"\\'], [['a', 'b,c\\']], escapechar='\\')
  219. def test_read_quoting(self):
  220. self._read_test(['1,",3,",5'], [['1', ',3,', '5']])
  221. self._read_test(['1,",3,",5'], [['1', '"', '3', '"', '5']],
  222. quotechar=None, escapechar='\\')
  223. self._read_test(['1,",3,",5'], [['1', '"', '3', '"', '5']],
  224. quoting=csv.QUOTE_NONE, escapechar='\\')
  225. # will this fail where locale uses comma for decimals?
  226. self._read_test([',3,"5",7.3, 9'], [['', 3, '5', 7.3, 9]],
  227. quoting=csv.QUOTE_NONNUMERIC)
  228. self._read_test(['"a\nb", 7'], [['a\nb', ' 7']])
  229. self.assertRaises(ValueError, self._read_test,
  230. ['abc,3'], [[]],
  231. quoting=csv.QUOTE_NONNUMERIC)
  232. def test_read_bigfield(self):
  233. # This exercises the buffer realloc functionality and field size
  234. # limits.
  235. limit = csv.field_size_limit()
  236. try:
  237. size = 50000
  238. bigstring = 'X' * size
  239. bigline = '%s,%s' % (bigstring, bigstring)
  240. self._read_test([bigline], [[bigstring, bigstring]])
  241. csv.field_size_limit(size)
  242. self._read_test([bigline], [[bigstring, bigstring]])
  243. self.assertEqual(csv.field_size_limit(), size)
  244. csv.field_size_limit(size-1)
  245. self.assertRaises(csv.Error, self._read_test, [bigline], [])
  246. self.assertRaises(TypeError, csv.field_size_limit, None)
  247. self.assertRaises(TypeError, csv.field_size_limit, 1, None)
  248. finally:
  249. csv.field_size_limit(limit)
  250. def test_read_linenum(self):
  251. for r in (csv.reader(['line,1', 'line,2', 'line,3']),
  252. csv.DictReader(['line,1', 'line,2', 'line,3'],
  253. fieldnames=['a', 'b', 'c'])):
  254. self.assertEqual(r.line_num, 0)
  255. r.next()
  256. self.assertEqual(r.line_num, 1)
  257. r.next()
  258. self.assertEqual(r.line_num, 2)
  259. r.next()
  260. self.assertEqual(r.line_num, 3)
  261. self.assertRaises(StopIteration, r.next)
  262. self.assertEqual(r.line_num, 3)
  263. def test_roundtrip_quoteed_newlines(self):
  264. fd, name = tempfile.mkstemp()
  265. fileobj = os.fdopen(fd, "w+b")
  266. try:
  267. writer = csv.writer(fileobj)
  268. self.assertRaises(TypeError, writer.writerows, None)
  269. rows = [['a\nb','b'],['c','x\r\nd']]
  270. writer.writerows(rows)
  271. fileobj.seek(0)
  272. for i, row in enumerate(csv.reader(fileobj)):
  273. self.assertEqual(row, rows[i])
  274. finally:
  275. fileobj.close()
  276. os.unlink(name)
  277. class TestDialectRegistry(unittest.TestCase):
  278. def test_registry_badargs(self):
  279. self.assertRaises(TypeError, csv.list_dialects, None)
  280. self.assertRaises(TypeError, csv.get_dialect)
  281. self.assertRaises(csv.Error, csv.get_dialect, None)
  282. self.assertRaises(csv.Error, csv.get_dialect, "nonesuch")
  283. self.assertRaises(TypeError, csv.unregister_dialect)
  284. self.assertRaises(csv.Error, csv.unregister_dialect, None)
  285. self.assertRaises(csv.Error, csv.unregister_dialect, "nonesuch")
  286. self.assertRaises(TypeError, csv.register_dialect, None)
  287. self.assertRaises(TypeError, csv.register_dialect, None, None)
  288. self.assertRaises(TypeError, csv.register_dialect, "nonesuch", 0, 0)
  289. self.assertRaises(TypeError, csv.register_dialect, "nonesuch",
  290. badargument=None)
  291. self.assertRaises(TypeError, csv.register_dialect, "nonesuch",
  292. quoting=None)
  293. self.assertRaises(TypeError, csv.register_dialect, [])
  294. def test_registry(self):
  295. class myexceltsv(csv.excel):
  296. delimiter = "\t"
  297. name = "myexceltsv"
  298. expected_dialects = csv.list_dialects() + [name]
  299. expected_dialects.sort()
  300. csv.register_dialect(name, myexceltsv)
  301. self.addCleanup(csv.unregister_dialect, name)
  302. self.assertEqual(csv.get_dialect(name).delimiter, '\t')
  303. got_dialects = sorted(csv.list_dialects())
  304. self.assertEqual(expected_dialects, got_dialects)
  305. def test_register_kwargs(self):
  306. name = 'fedcba'
  307. csv.register_dialect(name, delimiter=';')
  308. self.addCleanup(csv.unregister_dialect, name)
  309. self.assertEqual(csv.get_dialect(name).delimiter, ';')
  310. self.assertEqual([['X', 'Y', 'Z']], list(csv.reader(['X;Y;Z'], name)))
  311. def test_incomplete_dialect(self):
  312. class myexceltsv(csv.Dialect):
  313. delimiter = "\t"
  314. self.assertRaises(csv.Error, myexceltsv)
  315. def test_space_dialect(self):
  316. class space(csv.excel):
  317. delimiter = " "
  318. quoting = csv.QUOTE_NONE
  319. escapechar = "\\"
  320. fd, name = tempfile.mkstemp()
  321. fileobj = os.fdopen(fd, "w+b")
  322. try:
  323. fileobj.write("abc def\nc1ccccc1 benzene\n")
  324. fileobj.seek(0)
  325. rdr = csv.reader(fileobj, dialect=space())
  326. self.assertEqual(rdr.next(), ["abc", "def"])
  327. self.assertEqual(rdr.next(), ["c1ccccc1", "benzene"])
  328. finally:
  329. fileobj.close()
  330. os.unlink(name)
  331. def test_dialect_apply(self):
  332. class testA(csv.excel):
  333. delimiter = "\t"
  334. class testB(csv.excel):
  335. delimiter = ":"
  336. class testC(csv.excel):
  337. delimiter = "|"
  338. csv.register_dialect('testC', testC)
  339. try:
  340. fd, name = tempfile.mkstemp()
  341. fileobj = os.fdopen(fd, "w+b")
  342. try:
  343. writer = csv.writer(fileobj)
  344. writer.writerow([1,2,3])
  345. fileobj.seek(0)
  346. self.assertEqual(fileobj.read(), "1,2,3\r\n")
  347. finally:
  348. fileobj.close()
  349. os.unlink(name)
  350. fd, name = tempfile.mkstemp()
  351. fileobj = os.fdopen(fd, "w+b")
  352. try:
  353. writer = csv.writer(fileobj, testA)
  354. writer.writerow([1,2,3])
  355. fileobj.seek(0)
  356. self.assertEqual(fileobj.read(), "1\t2\t3\r\n")
  357. finally:
  358. fileobj.close()
  359. os.unlink(name)
  360. fd, name = tempfile.mkstemp()
  361. fileobj = os.fdopen(fd, "w+b")
  362. try:
  363. writer = csv.writer(fileobj, dialect=testB())
  364. writer.writerow([1,2,3])
  365. fileobj.seek(0)
  366. self.assertEqual(fileobj.read(), "1:2:3\r\n")
  367. finally:
  368. fileobj.close()
  369. os.unlink(name)
  370. fd, name = tempfile.mkstemp()
  371. fileobj = os.fdopen(fd, "w+b")
  372. try:
  373. writer = csv.writer(fileobj, dialect='testC')
  374. writer.writerow([1,2,3])
  375. fileobj.seek(0)
  376. self.assertEqual(fileobj.read(), "1|2|3\r\n")
  377. finally:
  378. fileobj.close()
  379. os.unlink(name)
  380. fd, name = tempfile.mkstemp()
  381. fileobj = os.fdopen(fd, "w+b")
  382. try:
  383. writer = csv.writer(fileobj, dialect=testA, delimiter=';')
  384. writer.writerow([1,2,3])
  385. fileobj.seek(0)
  386. self.assertEqual(fileobj.read(), "1;2;3\r\n")
  387. finally:
  388. fileobj.close()
  389. os.unlink(name)
  390. finally:
  391. csv.unregister_dialect('testC')
  392. def test_bad_dialect(self):
  393. # Unknown parameter
  394. self.assertRaises(TypeError, csv.reader, [], bad_attr = 0)
  395. # Bad values
  396. self.assertRaises(TypeError, csv.reader, [], delimiter = None)
  397. self.assertRaises(TypeError, csv.reader, [], quoting = -1)
  398. self.assertRaises(TypeError, csv.reader, [], quoting = 100)
  399. class TestCsvBase(unittest.TestCase):
  400. def readerAssertEqual(self, input, expected_result):
  401. fd, name = tempfile.mkstemp()
  402. fileobj = os.fdopen(fd, "w+b")
  403. try:
  404. fileobj.write(input)
  405. fileobj.seek(0)
  406. reader = csv.reader(fileobj, dialect = self.dialect)
  407. fields = list(reader)
  408. self.assertEqual(fields, expected_result)
  409. finally:
  410. fileobj.close()
  411. os.unlink(name)
  412. def writerAssertEqual(self, input, expected_result):
  413. fd, name = tempfile.mkstemp()
  414. fileobj = os.fdopen(fd, "w+b")
  415. try:
  416. writer = csv.writer(fileobj, dialect = self.dialect)
  417. writer.writerows(input)
  418. fileobj.seek(0)
  419. self.assertEqual(fileobj.read(), expected_result)
  420. finally:
  421. fileobj.close()
  422. os.unlink(name)
  423. class TestDialectExcel(TestCsvBase):
  424. dialect = 'excel'
  425. def test_single(self):
  426. self.readerAssertEqual('abc', [['abc']])
  427. def test_simple(self):
  428. self.readerAssertEqual('1,2,3,4,5', [['1','2','3','4','5']])
  429. def test_blankline(self):
  430. self.readerAssertEqual('', [])
  431. def test_empty_fields(self):
  432. self.readerAssertEqual(',', [['', '']])
  433. def test_singlequoted(self):
  434. self.readerAssertEqual('""', [['']])
  435. def test_singlequoted_left_empty(self):
  436. self.readerAssertEqual('"",', [['','']])
  437. def test_singlequoted_right_empty(self):
  438. self.readerAssertEqual(',""', [['','']])
  439. def test_single_quoted_quote(self):
  440. self.readerAssertEqual('""""', [['"']])
  441. def test_quoted_quotes(self):
  442. self.readerAssertEqual('""""""', [['""']])
  443. def test_inline_quote(self):
  444. self.readerAssertEqual('a""b', [['a""b']])
  445. def test_inline_quotes(self):
  446. self.readerAssertEqual('a"b"c', [['a"b"c']])
  447. def test_quotes_and_more(self):
  448. # Excel would never write a field containing '"a"b', but when
  449. # reading one, it will return 'ab'.
  450. self.readerAssertEqual('"a"b', [['ab']])
  451. def test_lone_quote(self):
  452. self.readerAssertEqual('a"b', [['a"b']])
  453. def test_quote_and_quote(self):
  454. # Excel would never write a field containing '"a" "b"', but when
  455. # reading one, it will return 'a "b"'.
  456. self.readerAssertEqual('"a" "b"', [['a "b"']])
  457. def test_space_and_quote(self):
  458. self.readerAssertEqual(' "a"', [[' "a"']])
  459. def test_quoted(self):
  460. self.readerAssertEqual('1,2,3,"I think, therefore I am",5,6',
  461. [['1', '2', '3',
  462. 'I think, therefore I am',
  463. '5', '6']])
  464. def test_quoted_quote(self):
  465. self.readerAssertEqual('1,2,3,"""I see,"" said the blind man","as he picked up his hammer and saw"',
  466. [['1', '2', '3',
  467. '"I see," said the blind man',
  468. 'as he picked up his hammer and saw']])
  469. def test_quoted_nl(self):
  470. input = '''\
  471. 1,2,3,"""I see,""
  472. said the blind man","as he picked up his
  473. hammer and saw"
  474. 9,8,7,6'''
  475. self.readerAssertEqual(input,
  476. [['1', '2', '3',
  477. '"I see,"\nsaid the blind man',
  478. 'as he picked up his\nhammer and saw'],
  479. ['9','8','7','6']])
  480. def test_dubious_quote(self):
  481. self.readerAssertEqual('12,12,1",', [['12', '12', '1"', '']])
  482. def test_null(self):
  483. self.writerAssertEqual([], '')
  484. def test_single_writer(self):
  485. self.writerAssertEqual([['abc']], 'abc\r\n')
  486. def test_simple_writer(self):
  487. self.writerAssertEqual([[1, 2, 'abc', 3, 4]], '1,2,abc,3,4\r\n')
  488. def test_quotes(self):
  489. self.writerAssertEqual([[1, 2, 'a"bc"', 3, 4]], '1,2,"a""bc""",3,4\r\n')
  490. def test_quote_fieldsep(self):
  491. self.writerAssertEqual([['abc,def']], '"abc,def"\r\n')
  492. def test_newlines(self):
  493. self.writerAssertEqual([[1, 2, 'a\nbc', 3, 4]], '1,2,"a\nbc",3,4\r\n')
  494. class EscapedExcel(csv.excel):
  495. quoting = csv.QUOTE_NONE
  496. escapechar = '\\'
  497. class TestEscapedExcel(TestCsvBase):
  498. dialect = EscapedExcel()
  499. def test_escape_fieldsep(self):
  500. self.writerAssertEqual([['abc,def']], 'abc\\,def\r\n')
  501. def test_read_escape_fieldsep(self):
  502. self.readerAssertEqual('abc\\,def\r\n', [['abc,def']])
  503. class QuotedEscapedExcel(csv.excel):
  504. quoting = csv.QUOTE_NONNUMERIC
  505. escapechar = '\\'
  506. class TestQuotedEscapedExcel(TestCsvBase):
  507. dialect = QuotedEscapedExcel()
  508. def test_write_escape_fieldsep(self):
  509. self.writerAssertEqual([['abc,def']], '"abc,def"\r\n')
  510. def test_read_escape_fieldsep(self):
  511. self.readerAssertEqual('"abc\\,def"\r\n', [['abc,def']])
  512. class TestDictFields(unittest.TestCase):
  513. ### "long" means the row is longer than the number of fieldnames
  514. ### "short" means there are fewer elements in the row than fieldnames
  515. def test_write_simple_dict(self):
  516. fd, name = tempfile.mkstemp()
  517. fileobj = io.open(fd, 'w+b')
  518. try:
  519. writer = csv.DictWriter(fileobj, fieldnames = ["f1", "f2", "f3"])
  520. writer.writeheader()
  521. fileobj.seek(0)
  522. self.assertEqual(fileobj.readline(), "f1,f2,f3\r\n")
  523. writer.writerow({"f1": 10, "f3": "abc"})
  524. fileobj.seek(0)
  525. fileobj.readline() # header
  526. self.assertEqual(fileobj.read(), "10,,abc\r\n")
  527. finally:
  528. fileobj.close()
  529. os.unlink(name)
  530. def test_write_no_fields(self):
  531. fileobj = StringIO()
  532. self.assertRaises(TypeError, csv.DictWriter, fileobj)
  533. def test_read_dict_fields(self):
  534. fd, name = tempfile.mkstemp()
  535. fileobj = os.fdopen(fd, "w+b")
  536. try:
  537. fileobj.write("1,2,abc\r\n")
  538. fileobj.seek(0)
  539. reader = csv.DictReader(fileobj,
  540. fieldnames=["f1", "f2", "f3"])
  541. self.assertEqual(reader.next(), {"f1": '1', "f2": '2', "f3": 'abc'})
  542. finally:
  543. fileobj.close()
  544. os.unlink(name)
  545. def test_read_dict_no_fieldnames(self):
  546. fd, name = tempfile.mkstemp()
  547. fileobj = os.fdopen(fd, "w+b")
  548. try:
  549. fileobj.write("f1,f2,f3\r\n1,2,abc\r\n")
  550. fileobj.seek(0)
  551. reader = csv.DictReader(fileobj)
  552. self.assertEqual(reader.fieldnames, ["f1", "f2", "f3"])
  553. self.assertEqual(reader.next(), {"f1": '1', "f2": '2', "f3": 'abc'})
  554. finally:
  555. fileobj.close()
  556. os.unlink(name)
  557. # Two test cases to make sure existing ways of implicitly setting
  558. # fieldnames continue to work. Both arise from discussion in issue3436.
  559. def test_read_dict_fieldnames_from_file(self):
  560. fd, name = tempfile.mkstemp()
  561. f = os.fdopen(fd, "w+b")
  562. try:
  563. f.write("f1,f2,f3\r\n1,2,abc\r\n")
  564. f.seek(0)
  565. reader = csv.DictReader(f, fieldnames=csv.reader(f).next())
  566. self.assertEqual(reader.fieldnames, ["f1", "f2", "f3"])
  567. self.assertEqual(reader.next(), {"f1": '1', "f2": '2', "f3": 'abc'})
  568. finally:
  569. f.close()
  570. os.unlink(name)
  571. def test_read_dict_fieldnames_chain(self):
  572. import itertools
  573. fd, name = tempfile.mkstemp()
  574. f = os.fdopen(fd, "w+b")
  575. try:
  576. f.write("f1,f2,f3\r\n1,2,abc\r\n")
  577. f.seek(0)
  578. reader = csv.DictReader(f)
  579. first = next(reader)
  580. for row in itertools.chain([first], reader):
  581. self.assertEqual(reader.fieldnames, ["f1", "f2", "f3"])
  582. self.assertEqual(row, {"f1": '1', "f2": '2', "f3": 'abc'})
  583. finally:
  584. f.close()
  585. os.unlink(name)
  586. def test_read_long(self):
  587. fd, name = tempfile.mkstemp()
  588. fileobj = os.fdopen(fd, "w+b")
  589. try:
  590. fileobj.write("1,2,abc,4,5,6\r\n")
  591. fileobj.seek(0)
  592. reader = csv.DictReader(fileobj,
  593. fieldnames=["f1", "f2"])
  594. self.assertEqual(reader.next(), {"f1": '1', "f2": '2',
  595. None: ["abc", "4", "5", "6"]})
  596. finally:
  597. fileobj.close()
  598. os.unlink(name)
  599. def test_read_long_with_rest(self):
  600. fd, name = tempfile.mkstemp()
  601. fileobj = os.fdopen(fd, "w+b")
  602. try:
  603. fileobj.write("1,2,abc,4,5,6\r\n")
  604. fileobj.seek(0)
  605. reader = csv.DictReader(fileobj,
  606. fieldnames=["f1", "f2"], restkey="_rest")
  607. self.assertEqual(reader.next(), {"f1": '1', "f2": '2',
  608. "_rest": ["abc", "4", "5", "6"]})
  609. finally:
  610. fileobj.close()
  611. os.unlink(name)
  612. def test_read_long_with_rest_no_fieldnames(self):
  613. fd, name = tempfile.mkstemp()
  614. fileobj = os.fdopen(fd, "w+b")
  615. try:
  616. fileobj.write("f1,f2\r\n1,2,abc,4,5,6\r\n")
  617. fileobj.seek(0)
  618. reader = csv.DictReader(fileobj, restkey="_rest")
  619. self.assertEqual(reader.fieldnames, ["f1", "f2"])
  620. self.assertEqual(reader.next(), {"f1": '1', "f2": '2',
  621. "_rest": ["abc", "4", "5", "6"]})
  622. finally:
  623. fileobj.close()
  624. os.unlink(name)
  625. def test_read_short(self):
  626. fd, name = tempfile.mkstemp()
  627. fileobj = os.fdopen(fd, "w+b")
  628. try:
  629. fileobj.write("1,2,abc,4,5,6\r\n1,2,abc\r\n")
  630. fileobj.seek(0)
  631. reader = csv.DictReader(fileobj,
  632. fieldnames="1 2 3 4 5 6".split(),
  633. restval="DEFAULT")
  634. self.assertEqual(reader.next(), {"1": '1', "2": '2', "3": 'abc',
  635. "4": '4', "5": '5', "6": '6'})
  636. self.assertEqual(reader.next(), {"1": '1', "2": '2', "3": 'abc',
  637. "4": 'DEFAULT', "5": 'DEFAULT',
  638. "6": 'DEFAULT'})
  639. finally:
  640. fileobj.close()
  641. os.unlink(name)
  642. def test_read_multi(self):
  643. sample = [
  644. '2147483648,43.0e12,17,abc,def\r\n',
  645. '147483648,43.0e2,17,abc,def\r\n',
  646. '47483648,43.0,170,abc,def\r\n'
  647. ]
  648. reader = csv.DictReader(sample,
  649. fieldnames="i1 float i2 s1 s2".split())
  650. self.assertEqual(reader.next(), {"i1": '2147483648',
  651. "float": '43.0e12',
  652. "i2": '17',
  653. "s1": 'abc',
  654. "s2": 'def'})
  655. def test_read_with_blanks(self):
  656. reader = csv.DictReader(["1,2,abc,4,5,6\r\n","\r\n",
  657. "1,2,abc,4,5,6\r\n"],
  658. fieldnames="1 2 3 4 5 6".split())
  659. self.assertEqual(reader.next(), {"1": '1', "2": '2', "3": 'abc',
  660. "4": '4', "5": '5', "6": '6'})
  661. self.assertEqual(reader.next(), {"1": '1', "2": '2', "3": 'abc',
  662. "4": '4', "5": '5', "6": '6'})
  663. def test_read_semi_sep(self):
  664. reader = csv.DictReader(["1;2;abc;4;5;6\r\n"],
  665. fieldnames="1 2 3 4 5 6".split(),
  666. delimiter=';')
  667. self.assertEqual(reader.next(), {"1": '1', "2": '2', "3": 'abc',
  668. "4": '4', "5": '5', "6": '6'})
  669. class TestArrayWrites(unittest.TestCase):
  670. def test_int_write(self):
  671. import array
  672. contents = [(20-i) for i in range(20)]
  673. a = array.array('i', contents)
  674. fd, name = tempfile.mkstemp()
  675. fileobj = os.fdopen(fd, "w+b")
  676. try:
  677. writer = csv.writer(fileobj, dialect="excel")
  678. writer.writerow(a)
  679. expected = ",".join([str(i) for i in a])+"\r\n"
  680. fileobj.seek(0)
  681. self.assertEqual(fileobj.read(), expected)
  682. finally:
  683. fileobj.close()
  684. os.unlink(name)
  685. def test_double_write(self):
  686. import array
  687. contents = [(20-i)*0.1 for i in range(20)]
  688. a = array.array('d', contents)
  689. fd, name = tempfile.mkstemp()
  690. fileobj = os.fdopen(fd, "w+b")
  691. try:
  692. writer = csv.writer(fileobj, dialect="excel")
  693. writer.writerow(a)
  694. expected = ",".join([str(i) for i in a])+"\r\n"
  695. fileobj.seek(0)
  696. self.assertEqual(fileobj.read(), expected)
  697. finally:
  698. fileobj.close()
  699. os.unlink(name)
  700. def test_float_write(self):
  701. import array
  702. contents = [(20-i)*0.1 for i in range(20)]
  703. a = array.array('f', contents)
  704. fd, name = tempfile.mkstemp()
  705. fileobj = os.fdopen(fd, "w+b")
  706. try:
  707. writer = csv.writer(fileobj, dialect="excel")
  708. writer.writerow(a)
  709. expected = ",".join([str(i) for i in a])+"\r\n"
  710. fileobj.seek(0)
  711. self.assertEqual(fileobj.read(), expected)
  712. finally:
  713. fileobj.close()
  714. os.unlink(name)
  715. def test_char_write(self):
  716. import array, string
  717. a = array.array('c', string.letters)
  718. fd, name = tempfile.mkstemp()
  719. fileobj = os.fdopen(fd, "w+b")
  720. try:
  721. writer = csv.writer(fileobj, dialect="excel")
  722. writer.writerow(a)
  723. expected = ",".join(a)+"\r\n"
  724. fileobj.seek(0)
  725. self.assertEqual(fileobj.read(), expected)
  726. finally:
  727. fileobj.close()
  728. os.unlink(name)
  729. class TestDialectValidity(unittest.TestCase):
  730. def test_quoting(self):
  731. class mydialect(csv.Dialect):
  732. delimiter = ";"
  733. escapechar = '\\'
  734. doublequote = False
  735. skipinitialspace = True
  736. lineterminator = '\r\n'
  737. quoting = csv.QUOTE_NONE
  738. d = mydialect()
  739. mydialect.quoting = None
  740. self.assertRaises(csv.Error, mydialect)
  741. mydialect.doublequote = True
  742. mydialect.quoting = csv.QUOTE_ALL
  743. mydialect.quotechar = '"'
  744. d = mydialect()
  745. mydialect.quotechar = "''"
  746. self.assertRaises(csv.Error, mydialect)
  747. mydialect.quotechar = 4
  748. self.assertRaises(csv.Error, mydialect)
  749. def test_delimiter(self):
  750. class mydialect(csv.Dialect):
  751. delimiter = ";"
  752. escapechar = '\\'
  753. doublequote = False
  754. skipinitialspace = True
  755. lineterminator = '\r\n'
  756. quoting = csv.QUOTE_NONE
  757. d = mydialect()
  758. mydialect.delimiter = ":::"
  759. self.assertRaises(csv.Error, mydialect)
  760. mydialect.delimiter = 4
  761. self.assertRaises(csv.Error, mydialect)
  762. def test_lineterminator(self):
  763. class mydialect(csv.Dialect):
  764. delimiter = ";"
  765. escapechar = '\\'
  766. doublequote = False
  767. skipinitialspace = True
  768. lineterminator = '\r\n'
  769. quoting = csv.QUOTE_NONE
  770. d = mydialect()
  771. mydialect.lineterminator = ":::"
  772. d = mydialect()
  773. mydialect.lineterminator = 4
  774. self.assertRaises(csv.Error, mydialect)
  775. class TestSniffer(unittest.TestCase):
  776. sample1 = """\
  777. Harry's, Arlington Heights, IL, 2/1/03, Kimi Hayes
  778. Shark City, Glendale Heights, IL, 12/28/02, Prezence
  779. Tommy's Place, Blue Island, IL, 12/28/02, Blue Sunday/White Crow
  780. Stonecutters Seafood and Chop House, Lemont, IL, 12/19/02, Week Back
  781. """
  782. sample2 = """\
  783. 'Harry''s':'Arlington Heights':'IL':'2/1/03':'Kimi Hayes'
  784. 'Shark City':'Glendale Heights':'IL':'12/28/02':'Prezence'
  785. 'Tommy''s Place':'Blue Island':'IL':'12/28/02':'Blue Sunday/White Crow'
  786. 'Stonecutters ''Seafood'' and Chop House':'Lemont':'IL':'12/19/02':'Week Back'
  787. """
  788. header = '''\
  789. "venue","city","state","date","performers"
  790. '''
  791. sample3 = '''\
  792. 05/05/03?05/05/03?05/05/03?05/05/03?05/05/03?05/05/03
  793. 05/05/03?05/05/03?05/05/03?05/05/03?05/05/03?05/05/03
  794. 05/05/03?05/05/03?05/05/03?05/05/03?05/05/03?05/05/03
  795. '''
  796. sample4 = '''\
  797. 2147483648;43.0e12;17;abc;def
  798. 147483648;43.0e2;17;abc;def
  799. 47483648;43.0;170;abc;def
  800. '''
  801. sample5 = "aaa\tbbb\r\nAAA\t\r\nBBB\t\r\n"
  802. sample6 = "a|b|c\r\nd|e|f\r\n"
  803. sample7 = "'a'|'b'|'c'\r\n'd'|e|f\r\n"
  804. def test_has_header(self):
  805. sniffer = csv.Sniffer()
  806. self.assertEqual(sniffer.has_header(self.sample1), False)
  807. self.assertEqual(sniffer.has_header(self.header+self.sample1), True)
  808. def test_sniff(self):
  809. sniffer = csv.Sniffer()
  810. dialect = sniffer.sniff(self.sample1)
  811. self.assertEqual(dialect.delimiter, ",")
  812. self.assertEqual(dialect.quotechar, '"')
  813. self.assertEqual(dialect.skipinitialspace, True)
  814. dialect = sniffer.sniff(self.sample2)
  815. self.assertEqual(dialect.delimiter, ":")
  816. self.assertEqual(dialect.quotechar, "'")
  817. self.assertEqual(dialect.skipinitialspace, False)
  818. def test_delimiters(self):
  819. sniffer = csv.Sniffer()
  820. dialect = sniffer.sniff(self.sample3)
  821. # given that all three lines in sample3 are equal,
  822. # I think that any character could have been 'guessed' as the
  823. # delimiter, depending on dictionary order
  824. self.assertIn(dialect.delimiter, self.sample3)
  825. dialect = sniffer.sniff(self.sample3, delimiters="?,")
  826. self.assertEqual(dialect.delimiter, "?")
  827. dialect = sniffer.sniff(self.sample3, delimiters="/,")
  828. self.assertEqual(dialect.delimiter, "/")
  829. dialect = sniffer.sniff(self.sample4)
  830. self.assertEqual(dialect.delimiter, ";")
  831. dialect = sniffer.sniff(self.sample5)
  832. self.assertEqual(dialect.delimiter, "\t")
  833. dialect = sniffer.sniff(self.sample6)
  834. self.assertEqual(dialect.delimiter, "|")
  835. dialect = sniffer.sniff(self.sample7)
  836. self.assertEqual(dialect.delimiter, "|")
  837. self.assertEqual(dialect.quotechar, "'")
  838. def test_doublequote(self):
  839. sniffer = csv.Sniffer()
  840. dialect = sniffer.sniff(self.header)
  841. self.assertFalse(dialect.doublequote)
  842. dialect = sniffer.sniff(self.sample2)
  843. self.assertTrue(dialect.doublequote)
  844. if not hasattr(sys, "gettotalrefcount"):
  845. if test_support.verbose: print "*** skipping leakage tests ***"
  846. else:
  847. class NUL:
  848. def write(s, *args):
  849. pass
  850. writelines = write
  851. class TestLeaks(unittest.TestCase):
  852. def test_create_read(self):
  853. delta = 0
  854. lastrc = sys.gettotalrefcount()
  855. for i in xrange(20):
  856. gc.collect()
  857. self.assertEqual(gc.garbage, [])
  858. rc = sys.gettotalrefcount()
  859. csv.reader(["a,b,c\r\n"])
  860. csv.reader(["a,b,c\r\n"])
  861. csv.reader(["a,b,c\r\n"])
  862. delta = rc-lastrc
  863. lastrc = rc
  864. # if csv.reader() leaks, last delta should be 3 or more
  865. self.assertEqual(delta < 3, True)
  866. def test_create_write(self):
  867. delta = 0
  868. lastrc = sys.gettotalrefcount()
  869. s = NUL()
  870. for i in xrange(20):
  871. gc.collect()
  872. self.assertEqual(gc.garbage, [])
  873. rc = sys.gettotalrefcount()
  874. csv.writer(s)
  875. csv.writer(s)
  876. csv.writer(s)
  877. delta = rc-lastrc
  878. lastrc = rc
  879. # if csv.writer() leaks, last delta should be 3 or more
  880. self.assertEqual(delta < 3, True)
  881. def test_read(self):
  882. delta = 0
  883. rows = ["a,b,c\r\n"]*5
  884. lastrc = sys.gettotalrefcount()
  885. for i in xrange(20):
  886. gc.collect()
  887. self.assertEqual(gc.garbage, [])
  888. rc = sys.gettotalrefcount()
  889. rdr = csv.reader(rows)
  890. for row in rdr:
  891. pass
  892. delta = rc-lastrc
  893. lastrc = rc
  894. # if reader leaks during read, delta should be 5 or more
  895. self.assertEqual(delta < 5, True)
  896. def test_write(self):
  897. delta = 0
  898. rows = [[1,2,3]]*5
  899. s = NUL()
  900. lastrc = sys.gettotalrefcount()
  901. for i in xrange(20):
  902. gc.collect()
  903. self.assertEqual(gc.garbage, [])
  904. rc = sys.gettotalrefcount()
  905. writer = csv.writer(s)
  906. for row in rows:
  907. writer.writerow(row)
  908. delta = rc-lastrc
  909. lastrc = rc
  910. # if writer leaks during write, last delta should be 5 or more
  911. self.assertEqual(delta < 5, True)
  912. # commented out for now - csv module doesn't yet support Unicode
  913. ## class TestUnicode(unittest.TestCase):
  914. ## def test_unicode_read(self):
  915. ## import codecs
  916. ## f = codecs.EncodedFile(StringIO("Martin von Löwis,"
  917. ## "Marc André Lemburg,"
  918. ## "Guido van Rossum,"
  919. ## "François Pinard\r\n"),
  920. ## data_encoding='iso-8859-1')
  921. ## reader = csv.reader(f)
  922. ## self.assertEqual(list(reader), [[u"Martin von Löwis",
  923. ## u"Marc André Lemburg",
  924. ## u"Guido van Rossum",
  925. ## u"François Pinardn"]])
  926. def test_main():
  927. mod = sys.modules[__name__]
  928. test_support.run_unittest(
  929. *[getattr(mod, name) for name in dir(mod) if name.startswith('Test')]
  930. )
  931. if __name__ == '__main__':
  932. test_main()