test_dbm.py 6.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217
  1. """Test script for the dbm.open function based on testdumbdbm.py"""
  2. import unittest
  3. import dbm
  4. import os
  5. from test.support import import_helper
  6. from test.support import os_helper
  7. try:
  8. from dbm import ndbm
  9. except ImportError:
  10. ndbm = None
  11. dirname = os_helper.TESTFN
  12. _fname = os.path.join(dirname, os_helper.TESTFN)
  13. #
  14. # Iterates over every database module supported by dbm currently available.
  15. #
  16. def dbm_iterator():
  17. for name in dbm._names:
  18. try:
  19. mod = __import__(name, fromlist=['open'])
  20. except ImportError:
  21. continue
  22. dbm._modules[name] = mod
  23. yield mod
  24. #
  25. # Clean up all scratch databases we might have created during testing
  26. #
  27. def cleaunup_test_dir():
  28. os_helper.rmtree(dirname)
  29. def setup_test_dir():
  30. cleaunup_test_dir()
  31. os.mkdir(dirname)
  32. class AnyDBMTestCase:
  33. _dict = {'a': b'Python:',
  34. 'b': b'Programming',
  35. 'c': b'the',
  36. 'd': b'way',
  37. 'f': b'Guido',
  38. 'g': b'intended',
  39. }
  40. def init_db(self):
  41. f = dbm.open(_fname, 'n')
  42. for k in self._dict:
  43. f[k.encode("ascii")] = self._dict[k]
  44. f.close()
  45. def keys_helper(self, f):
  46. keys = sorted(k.decode("ascii") for k in f.keys())
  47. dkeys = sorted(self._dict.keys())
  48. self.assertEqual(keys, dkeys)
  49. return keys
  50. def test_error(self):
  51. self.assertTrue(issubclass(self.module.error, OSError))
  52. def test_anydbm_not_existing(self):
  53. self.assertRaises(dbm.error, dbm.open, _fname)
  54. def test_anydbm_creation(self):
  55. f = dbm.open(_fname, 'c')
  56. self.assertEqual(list(f.keys()), [])
  57. for key in self._dict:
  58. f[key.encode("ascii")] = self._dict[key]
  59. self.read_helper(f)
  60. f.close()
  61. def test_anydbm_creation_n_file_exists_with_invalid_contents(self):
  62. # create an empty file
  63. os_helper.create_empty_file(_fname)
  64. with dbm.open(_fname, 'n') as f:
  65. self.assertEqual(len(f), 0)
  66. def test_anydbm_modification(self):
  67. self.init_db()
  68. f = dbm.open(_fname, 'c')
  69. self._dict['g'] = f[b'g'] = b"indented"
  70. self.read_helper(f)
  71. # setdefault() works as in the dict interface
  72. self.assertEqual(f.setdefault(b'xxx', b'foo'), b'foo')
  73. self.assertEqual(f[b'xxx'], b'foo')
  74. f.close()
  75. def test_anydbm_read(self):
  76. self.init_db()
  77. f = dbm.open(_fname, 'r')
  78. self.read_helper(f)
  79. # get() works as in the dict interface
  80. self.assertEqual(f.get(b'a'), self._dict['a'])
  81. self.assertEqual(f.get(b'xxx', b'foo'), b'foo')
  82. self.assertIsNone(f.get(b'xxx'))
  83. with self.assertRaises(KeyError):
  84. f[b'xxx']
  85. f.close()
  86. def test_anydbm_keys(self):
  87. self.init_db()
  88. f = dbm.open(_fname, 'r')
  89. keys = self.keys_helper(f)
  90. f.close()
  91. def test_empty_value(self):
  92. if getattr(dbm._defaultmod, 'library', None) == 'Berkeley DB':
  93. self.skipTest("Berkeley DB doesn't distinguish the empty value "
  94. "from the absent one")
  95. f = dbm.open(_fname, 'c')
  96. self.assertEqual(f.keys(), [])
  97. f[b'empty'] = b''
  98. self.assertEqual(f.keys(), [b'empty'])
  99. self.assertIn(b'empty', f)
  100. self.assertEqual(f[b'empty'], b'')
  101. self.assertEqual(f.get(b'empty'), b'')
  102. self.assertEqual(f.setdefault(b'empty'), b'')
  103. f.close()
  104. def test_anydbm_access(self):
  105. self.init_db()
  106. f = dbm.open(_fname, 'r')
  107. key = "a".encode("ascii")
  108. self.assertIn(key, f)
  109. assert(f[key] == b"Python:")
  110. f.close()
  111. def test_open_with_bytes(self):
  112. dbm.open(os.fsencode(_fname), "c").close()
  113. def test_open_with_pathlib_path(self):
  114. dbm.open(os_helper.FakePath(_fname), "c").close()
  115. def test_open_with_pathlib_path_bytes(self):
  116. dbm.open(os_helper.FakePath(os.fsencode(_fname)), "c").close()
  117. def read_helper(self, f):
  118. keys = self.keys_helper(f)
  119. for key in self._dict:
  120. self.assertEqual(self._dict[key], f[key.encode("ascii")])
  121. def test_keys(self):
  122. with dbm.open(_fname, 'c') as d:
  123. self.assertEqual(d.keys(), [])
  124. a = [(b'a', b'b'), (b'12345678910', b'019237410982340912840198242')]
  125. for k, v in a:
  126. d[k] = v
  127. self.assertEqual(sorted(d.keys()), sorted(k for (k, v) in a))
  128. for k, v in a:
  129. self.assertIn(k, d)
  130. self.assertEqual(d[k], v)
  131. self.assertNotIn(b'xxx', d)
  132. self.assertRaises(KeyError, lambda: d[b'xxx'])
  133. def setUp(self):
  134. self.addCleanup(setattr, dbm, '_defaultmod', dbm._defaultmod)
  135. dbm._defaultmod = self.module
  136. self.addCleanup(cleaunup_test_dir)
  137. setup_test_dir()
  138. class WhichDBTestCase(unittest.TestCase):
  139. def test_whichdb(self):
  140. self.addCleanup(setattr, dbm, '_defaultmod', dbm._defaultmod)
  141. _bytes_fname = os.fsencode(_fname)
  142. fnames = [_fname, os_helper.FakePath(_fname),
  143. _bytes_fname, os_helper.FakePath(_bytes_fname)]
  144. for module in dbm_iterator():
  145. # Check whether whichdb correctly guesses module name
  146. # for databases opened with "module" module.
  147. name = module.__name__
  148. setup_test_dir()
  149. dbm._defaultmod = module
  150. # Try with empty files first
  151. with module.open(_fname, 'c'): pass
  152. for path in fnames:
  153. self.assertEqual(name, self.dbm.whichdb(path))
  154. # Now add a key
  155. with module.open(_fname, 'w') as f:
  156. f[b"1"] = b"1"
  157. # and test that we can find it
  158. self.assertIn(b"1", f)
  159. # and read it
  160. self.assertEqual(f[b"1"], b"1")
  161. for path in fnames:
  162. self.assertEqual(name, self.dbm.whichdb(path))
  163. @unittest.skipUnless(ndbm, reason='Test requires ndbm')
  164. def test_whichdb_ndbm(self):
  165. # Issue 17198: check that ndbm which is referenced in whichdb is defined
  166. with open(_fname + '.db', 'wb'): pass
  167. _bytes_fname = os.fsencode(_fname)
  168. fnames = [_fname, os_helper.FakePath(_fname),
  169. _bytes_fname, os_helper.FakePath(_bytes_fname)]
  170. for path in fnames:
  171. self.assertIsNone(self.dbm.whichdb(path))
  172. def setUp(self):
  173. self.addCleanup(cleaunup_test_dir)
  174. setup_test_dir()
  175. self.dbm = import_helper.import_fresh_module('dbm')
  176. for mod in dbm_iterator():
  177. assert mod.__name__.startswith('dbm.')
  178. suffix = mod.__name__[4:]
  179. testname = f'TestCase_{suffix}'
  180. globals()[testname] = type(testname,
  181. (AnyDBMTestCase, unittest.TestCase),
  182. {'module': mod})
  183. if __name__ == "__main__":
  184. unittest.main()