Fred Drake | 13634cf | 2000-06-29 19:17:04 +0000 | [diff] [blame] | 1 | # test the invariant that |
| 2 | # iff a==b then hash(a)==hash(b) |
| 3 | # |
Nick Coghlan | d1abd25 | 2008-07-15 15:46:38 +0000 | [diff] [blame] | 4 | # Also test that hash implementations are inherited as expected |
Fred Drake | 13634cf | 2000-06-29 19:17:04 +0000 | [diff] [blame] | 5 | |
Georg Brandl | 2daf6ae | 2012-02-20 19:54:16 +0100 | [diff] [blame] | 6 | import datetime |
| 7 | import os |
Georg Brandl | 09a7c72 | 2012-02-20 21:31:46 +0100 | [diff] [blame] | 8 | import sys |
Fred Drake | 97656a1 | 2001-05-18 21:45:35 +0000 | [diff] [blame] | 9 | import unittest |
Georg Brandl | 2daf6ae | 2012-02-20 19:54:16 +0100 | [diff] [blame] | 10 | from test.script_helper import assert_python_ok |
Nick Coghlan | d1abd25 | 2008-07-15 15:46:38 +0000 | [diff] [blame] | 11 | from collections import Hashable |
Fred Drake | 13634cf | 2000-06-29 19:17:04 +0000 | [diff] [blame] | 12 | |
Georg Brandl | 09a7c72 | 2012-02-20 21:31:46 +0100 | [diff] [blame] | 13 | IS_64BIT = sys.maxsize > 2**32 |
Georg Brandl | 2daf6ae | 2012-02-20 19:54:16 +0100 | [diff] [blame] | 14 | |
Fred Drake | 13634cf | 2000-06-29 19:17:04 +0000 | [diff] [blame] | 15 | |
Fred Drake | 97656a1 | 2001-05-18 21:45:35 +0000 | [diff] [blame] | 16 | class HashEqualityTestCase(unittest.TestCase): |
| 17 | |
| 18 | def same_hash(self, *objlist): |
Fred Drake | acb117e | 2001-05-18 21:50:02 +0000 | [diff] [blame] | 19 | # Hash each object given and fail if |
| 20 | # the hash values are not all the same. |
Guido van Rossum | c1f779c | 2007-07-03 08:25:58 +0000 | [diff] [blame] | 21 | hashed = list(map(hash, objlist)) |
Fred Drake | 97656a1 | 2001-05-18 21:45:35 +0000 | [diff] [blame] | 22 | for h in hashed[1:]: |
| 23 | if h != hashed[0]: |
Walter Dörwald | 70a6b49 | 2004-02-12 17:35:32 +0000 | [diff] [blame] | 24 | self.fail("hashed values differ: %r" % (objlist,)) |
Fred Drake | 97656a1 | 2001-05-18 21:45:35 +0000 | [diff] [blame] | 25 | |
| 26 | def test_numeric_literals(self): |
Guido van Rossum | e2a383d | 2007-01-15 16:59:06 +0000 | [diff] [blame] | 27 | self.same_hash(1, 1, 1.0, 1.0+0.0j) |
Thomas Wouters | ce272b6 | 2007-09-19 21:19:28 +0000 | [diff] [blame] | 28 | self.same_hash(0, 0.0, 0.0+0.0j) |
| 29 | self.same_hash(-1, -1.0, -1.0+0.0j) |
| 30 | self.same_hash(-2, -2.0, -2.0+0.0j) |
Fred Drake | 97656a1 | 2001-05-18 21:45:35 +0000 | [diff] [blame] | 31 | |
| 32 | def test_coerced_integers(self): |
Guido van Rossum | e2a383d | 2007-01-15 16:59:06 +0000 | [diff] [blame] | 33 | self.same_hash(int(1), int(1), float(1), complex(1), |
Fred Drake | 97656a1 | 2001-05-18 21:45:35 +0000 | [diff] [blame] | 34 | int('1'), float('1.0')) |
Thomas Wouters | ce272b6 | 2007-09-19 21:19:28 +0000 | [diff] [blame] | 35 | self.same_hash(int(-2**31), float(-2**31)) |
| 36 | self.same_hash(int(1-2**31), float(1-2**31)) |
| 37 | self.same_hash(int(2**31-1), float(2**31-1)) |
| 38 | # for 64-bit platforms |
| 39 | self.same_hash(int(2**31), float(2**31)) |
| 40 | self.same_hash(int(-2**63), float(-2**63)) |
Guilherme Polo | 887b3f2 | 2009-02-07 00:45:10 +0000 | [diff] [blame] | 41 | self.same_hash(int(2**63), float(2**63)) |
Fred Drake | 97656a1 | 2001-05-18 21:45:35 +0000 | [diff] [blame] | 42 | |
| 43 | def test_coerced_floats(self): |
Guido van Rossum | e2a383d | 2007-01-15 16:59:06 +0000 | [diff] [blame] | 44 | self.same_hash(int(1.23e300), float(1.23e300)) |
Fred Drake | 97656a1 | 2001-05-18 21:45:35 +0000 | [diff] [blame] | 45 | self.same_hash(float(0.5), complex(0.5, 0.0)) |
Fred Drake | 13634cf | 2000-06-29 19:17:04 +0000 | [diff] [blame] | 46 | |
Antoine Pitrou | 37bfa4e | 2012-11-11 20:10:48 +0100 | [diff] [blame] | 47 | def test_unaligned_buffers(self): |
| 48 | # The hash function for bytes-like objects shouldn't have |
| 49 | # alignment-dependent results (example in issue #16427). |
| 50 | b = b"123456789abcdefghijklmnopqrstuvwxyz" * 128 |
| 51 | for i in range(16): |
| 52 | for j in range(16): |
| 53 | aligned = b[i:128+j] |
| 54 | unaligned = memoryview(b)[i:128+j] |
| 55 | self.assertEqual(hash(aligned), hash(unaligned)) |
| 56 | |
Fred Drake | 13634cf | 2000-06-29 19:17:04 +0000 | [diff] [blame] | 57 | |
Nick Coghlan | d1abd25 | 2008-07-15 15:46:38 +0000 | [diff] [blame] | 58 | _default_hash = object.__hash__ |
| 59 | class DefaultHash(object): pass |
| 60 | |
| 61 | _FIXED_HASH_VALUE = 42 |
| 62 | class FixedHash(object): |
| 63 | def __hash__(self): |
| 64 | return _FIXED_HASH_VALUE |
| 65 | |
| 66 | class OnlyEquality(object): |
| 67 | def __eq__(self, other): |
| 68 | return self is other |
| 69 | |
| 70 | class OnlyInequality(object): |
| 71 | def __ne__(self, other): |
| 72 | return self is not other |
| 73 | |
Nick Coghlan | d1abd25 | 2008-07-15 15:46:38 +0000 | [diff] [blame] | 74 | class InheritedHashWithEquality(FixedHash, OnlyEquality): pass |
| 75 | class InheritedHashWithInequality(FixedHash, OnlyInequality): pass |
Nick Coghlan | d1abd25 | 2008-07-15 15:46:38 +0000 | [diff] [blame] | 76 | |
| 77 | class NoHash(object): |
| 78 | __hash__ = None |
| 79 | |
| 80 | class HashInheritanceTestCase(unittest.TestCase): |
| 81 | default_expected = [object(), |
| 82 | DefaultHash(), |
| 83 | OnlyInequality(), |
| 84 | ] |
| 85 | fixed_expected = [FixedHash(), |
| 86 | InheritedHashWithEquality(), |
| 87 | InheritedHashWithInequality(), |
Nick Coghlan | d1abd25 | 2008-07-15 15:46:38 +0000 | [diff] [blame] | 88 | ] |
| 89 | error_expected = [NoHash(), |
| 90 | OnlyEquality(), |
Nick Coghlan | d1abd25 | 2008-07-15 15:46:38 +0000 | [diff] [blame] | 91 | ] |
| 92 | |
| 93 | def test_default_hash(self): |
| 94 | for obj in self.default_expected: |
| 95 | self.assertEqual(hash(obj), _default_hash(obj)) |
| 96 | |
| 97 | def test_fixed_hash(self): |
| 98 | for obj in self.fixed_expected: |
| 99 | self.assertEqual(hash(obj), _FIXED_HASH_VALUE) |
| 100 | |
| 101 | def test_error_hash(self): |
| 102 | for obj in self.error_expected: |
| 103 | self.assertRaises(TypeError, hash, obj) |
| 104 | |
| 105 | def test_hashable(self): |
| 106 | objects = (self.default_expected + |
| 107 | self.fixed_expected) |
| 108 | for obj in objects: |
Ezio Melotti | e961593 | 2010-01-24 19:26:24 +0000 | [diff] [blame] | 109 | self.assertIsInstance(obj, Hashable) |
Nick Coghlan | d1abd25 | 2008-07-15 15:46:38 +0000 | [diff] [blame] | 110 | |
| 111 | def test_not_hashable(self): |
| 112 | for obj in self.error_expected: |
Ezio Melotti | e961593 | 2010-01-24 19:26:24 +0000 | [diff] [blame] | 113 | self.assertNotIsInstance(obj, Hashable) |
Nick Coghlan | d1abd25 | 2008-07-15 15:46:38 +0000 | [diff] [blame] | 114 | |
| 115 | |
Nick Coghlan | f1f2f68 | 2008-12-30 07:29:12 +0000 | [diff] [blame] | 116 | # Issue #4701: Check that some builtin types are correctly hashable |
| 117 | class DefaultIterSeq(object): |
| 118 | seq = range(10) |
| 119 | def __len__(self): |
| 120 | return len(self.seq) |
| 121 | def __getitem__(self, index): |
| 122 | return self.seq[index] |
| 123 | |
| 124 | class HashBuiltinsTestCase(unittest.TestCase): |
Mark Dickinson | 3664568 | 2011-10-23 19:53:01 +0100 | [diff] [blame] | 125 | hashes_to_check = [enumerate(range(10)), |
Nick Coghlan | f1f2f68 | 2008-12-30 07:29:12 +0000 | [diff] [blame] | 126 | iter(DefaultIterSeq()), |
| 127 | iter(lambda: 0, 0), |
| 128 | ] |
| 129 | |
| 130 | def test_hashes(self): |
| 131 | _default_hash = object.__hash__ |
| 132 | for obj in self.hashes_to_check: |
| 133 | self.assertEqual(hash(obj), _default_hash(obj)) |
| 134 | |
Ezio Melotti | e601fb0 | 2013-02-27 10:09:12 +0200 | [diff] [blame] | 135 | class HashRandomizationTests: |
Georg Brandl | 2daf6ae | 2012-02-20 19:54:16 +0100 | [diff] [blame] | 136 | |
| 137 | # Each subclass should define a field "repr_", containing the repr() of |
| 138 | # an object to be tested |
| 139 | |
| 140 | def get_hash_command(self, repr_): |
| 141 | return 'print(hash(%s))' % repr_ |
| 142 | |
| 143 | def get_hash(self, repr_, seed=None): |
| 144 | env = os.environ.copy() |
| 145 | env['__cleanenv'] = True # signal to assert_python not to do a copy |
| 146 | # of os.environ on its own |
| 147 | if seed is not None: |
| 148 | env['PYTHONHASHSEED'] = str(seed) |
| 149 | else: |
| 150 | env.pop('PYTHONHASHSEED', None) |
| 151 | out = assert_python_ok( |
| 152 | '-c', self.get_hash_command(repr_), |
| 153 | **env) |
| 154 | stdout = out[1].strip() |
| 155 | return int(stdout) |
| 156 | |
| 157 | def test_randomized_hash(self): |
| 158 | # two runs should return different hashes |
| 159 | run1 = self.get_hash(self.repr_, seed='random') |
| 160 | run2 = self.get_hash(self.repr_, seed='random') |
| 161 | self.assertNotEqual(run1, run2) |
| 162 | |
| 163 | class StringlikeHashRandomizationTests(HashRandomizationTests): |
| 164 | def test_null_hash(self): |
| 165 | # PYTHONHASHSEED=0 disables the randomized hash |
| 166 | if IS_64BIT: |
| 167 | known_hash_of_obj = 1453079729188098211 |
| 168 | else: |
| 169 | known_hash_of_obj = -1600925533 |
| 170 | |
Benjamin Peterson | c9f54cf | 2012-02-21 16:08:05 -0500 | [diff] [blame] | 171 | # Randomization is enabled by default: |
| 172 | self.assertNotEqual(self.get_hash(self.repr_), known_hash_of_obj) |
Georg Brandl | 2daf6ae | 2012-02-20 19:54:16 +0100 | [diff] [blame] | 173 | |
| 174 | # It can also be disabled by setting the seed to 0: |
| 175 | self.assertEqual(self.get_hash(self.repr_, seed=0), known_hash_of_obj) |
| 176 | |
| 177 | def test_fixed_hash(self): |
| 178 | # test a fixed seed for the randomized hash |
| 179 | # Note that all types share the same values: |
| 180 | if IS_64BIT: |
Antoine Pitrou | 679be99 | 2012-02-22 03:33:56 +0100 | [diff] [blame] | 181 | if sys.byteorder == 'little': |
| 182 | h = -4410911502303878509 |
| 183 | else: |
| 184 | h = -3570150969479994130 |
Georg Brandl | 2daf6ae | 2012-02-20 19:54:16 +0100 | [diff] [blame] | 185 | else: |
Antoine Pitrou | 679be99 | 2012-02-22 03:33:56 +0100 | [diff] [blame] | 186 | if sys.byteorder == 'little': |
| 187 | h = -206076799 |
| 188 | else: |
| 189 | h = -1024014457 |
Georg Brandl | 2daf6ae | 2012-02-20 19:54:16 +0100 | [diff] [blame] | 190 | self.assertEqual(self.get_hash(self.repr_, seed=42), h) |
| 191 | |
Ezio Melotti | e601fb0 | 2013-02-27 10:09:12 +0200 | [diff] [blame] | 192 | class StrHashRandomizationTests(StringlikeHashRandomizationTests, |
| 193 | unittest.TestCase): |
Georg Brandl | 2daf6ae | 2012-02-20 19:54:16 +0100 | [diff] [blame] | 194 | repr_ = repr('abc') |
| 195 | |
| 196 | def test_empty_string(self): |
| 197 | self.assertEqual(hash(""), 0) |
| 198 | |
Ezio Melotti | e601fb0 | 2013-02-27 10:09:12 +0200 | [diff] [blame] | 199 | class BytesHashRandomizationTests(StringlikeHashRandomizationTests, |
| 200 | unittest.TestCase): |
Georg Brandl | 2daf6ae | 2012-02-20 19:54:16 +0100 | [diff] [blame] | 201 | repr_ = repr(b'abc') |
| 202 | |
| 203 | def test_empty_string(self): |
| 204 | self.assertEqual(hash(b""), 0) |
| 205 | |
Ezio Melotti | e601fb0 | 2013-02-27 10:09:12 +0200 | [diff] [blame] | 206 | class MemoryviewHashRandomizationTests(StringlikeHashRandomizationTests, |
| 207 | unittest.TestCase): |
Antoine Pitrou | 07c6588 | 2012-02-21 19:14:26 +0100 | [diff] [blame] | 208 | repr_ = "memoryview(b'abc')" |
| 209 | |
| 210 | def test_empty_string(self): |
| 211 | self.assertEqual(hash(memoryview(b"")), 0) |
| 212 | |
Georg Brandl | 2daf6ae | 2012-02-20 19:54:16 +0100 | [diff] [blame] | 213 | class DatetimeTests(HashRandomizationTests): |
| 214 | def get_hash_command(self, repr_): |
| 215 | return 'import datetime; print(hash(%s))' % repr_ |
| 216 | |
Ezio Melotti | e601fb0 | 2013-02-27 10:09:12 +0200 | [diff] [blame] | 217 | class DatetimeDateTests(DatetimeTests, unittest.TestCase): |
Georg Brandl | 2daf6ae | 2012-02-20 19:54:16 +0100 | [diff] [blame] | 218 | repr_ = repr(datetime.date(1066, 10, 14)) |
| 219 | |
Ezio Melotti | e601fb0 | 2013-02-27 10:09:12 +0200 | [diff] [blame] | 220 | class DatetimeDatetimeTests(DatetimeTests, unittest.TestCase): |
Georg Brandl | 2daf6ae | 2012-02-20 19:54:16 +0100 | [diff] [blame] | 221 | repr_ = repr(datetime.datetime(1, 2, 3, 4, 5, 6, 7)) |
| 222 | |
Ezio Melotti | e601fb0 | 2013-02-27 10:09:12 +0200 | [diff] [blame] | 223 | class DatetimeTimeTests(DatetimeTests, unittest.TestCase): |
Georg Brandl | 2daf6ae | 2012-02-20 19:54:16 +0100 | [diff] [blame] | 224 | repr_ = repr(datetime.time(0)) |
| 225 | |
| 226 | |
Fred Drake | 2e2be37 | 2001-09-20 21:33:42 +0000 | [diff] [blame] | 227 | if __name__ == "__main__": |
Ezio Melotti | e601fb0 | 2013-02-27 10:09:12 +0200 | [diff] [blame] | 228 | unittest.main() |