Thomas Wouters | 73e5a5b | 2006-06-08 15:35:45 +0000 | [diff] [blame] | 1 | from test.test_support import TestFailed, verbose, verify, vereq |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 2 | import test.test_support |
Barry Warsaw | 07a0eec | 1996-12-12 23:34:06 +0000 | [diff] [blame] | 3 | import struct |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 4 | import array |
Thomas Wouters | 4d70c3d | 2006-06-08 14:42:34 +0000 | [diff] [blame] | 5 | import warnings |
Barry Warsaw | 07a0eec | 1996-12-12 23:34:06 +0000 | [diff] [blame] | 6 | |
Tim Peters | 17e17d4 | 2001-06-13 22:45:27 +0000 | [diff] [blame] | 7 | import sys |
| 8 | ISBIGENDIAN = sys.byteorder == "big" |
| 9 | del sys |
Guido van Rossum | e625fd5 | 2007-05-27 09:19:04 +0000 | [diff] [blame] | 10 | verify((struct.pack('=i', 1)[0] == 0) == ISBIGENDIAN, |
Tim Peters | 17e17d4 | 2001-06-13 22:45:27 +0000 | [diff] [blame] | 11 | "bigendian determination appears wrong") |
| 12 | |
Thomas Wouters | 4d70c3d | 2006-06-08 14:42:34 +0000 | [diff] [blame] | 13 | try: |
| 14 | import _struct |
| 15 | except ImportError: |
| 16 | PY_STRUCT_RANGE_CHECKING = 0 |
| 17 | PY_STRUCT_OVERFLOW_MASKING = 1 |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 18 | PY_STRUCT_FLOAT_COERCE = 2 |
Thomas Wouters | 4d70c3d | 2006-06-08 14:42:34 +0000 | [diff] [blame] | 19 | else: |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 20 | PY_STRUCT_RANGE_CHECKING = getattr(_struct, '_PY_STRUCT_RANGE_CHECKING', 0) |
| 21 | PY_STRUCT_OVERFLOW_MASKING = getattr(_struct, '_PY_STRUCT_OVERFLOW_MASKING', 0) |
| 22 | PY_STRUCT_FLOAT_COERCE = getattr(_struct, '_PY_STRUCT_FLOAT_COERCE', 0) |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 23 | |
Tim Peters | 17e17d4 | 2001-06-13 22:45:27 +0000 | [diff] [blame] | 24 | def string_reverse(s): |
Guido van Rossum | e625fd5 | 2007-05-27 09:19:04 +0000 | [diff] [blame] | 25 | return s[::-1] |
Tim Peters | 17e17d4 | 2001-06-13 22:45:27 +0000 | [diff] [blame] | 26 | |
| 27 | def bigendian_to_native(value): |
| 28 | if ISBIGENDIAN: |
| 29 | return value |
| 30 | else: |
| 31 | return string_reverse(value) |
| 32 | |
Barry Warsaw | 07a0eec | 1996-12-12 23:34:06 +0000 | [diff] [blame] | 33 | def simple_err(func, *args): |
| 34 | try: |
Guido van Rossum | 68468eb | 2003-02-27 20:14:51 +0000 | [diff] [blame] | 35 | func(*args) |
Barry Warsaw | 07a0eec | 1996-12-12 23:34:06 +0000 | [diff] [blame] | 36 | except struct.error: |
Guido van Rossum | 41360a4 | 1998-03-26 19:42:58 +0000 | [diff] [blame] | 37 | pass |
Barry Warsaw | 07a0eec | 1996-12-12 23:34:06 +0000 | [diff] [blame] | 38 | else: |
Collin Winter | 3add4d7 | 2007-08-29 23:37:32 +0000 | [diff] [blame] | 39 | raise TestFailed("%s%s did not raise struct.error" % ( |
| 40 | func.__name__, args)) |
Barry Warsaw | 07a0eec | 1996-12-12 23:34:06 +0000 | [diff] [blame] | 41 | |
Tim Peters | 7a3bfc3 | 2001-06-12 01:22:22 +0000 | [diff] [blame] | 42 | def any_err(func, *args): |
| 43 | try: |
Guido van Rossum | 68468eb | 2003-02-27 20:14:51 +0000 | [diff] [blame] | 44 | func(*args) |
Thomas Wouters | 4d70c3d | 2006-06-08 14:42:34 +0000 | [diff] [blame] | 45 | except (struct.error, TypeError): |
Tim Peters | 7a3bfc3 | 2001-06-12 01:22:22 +0000 | [diff] [blame] | 46 | pass |
| 47 | else: |
Collin Winter | 3add4d7 | 2007-08-29 23:37:32 +0000 | [diff] [blame] | 48 | raise TestFailed("%s%s did not raise error" % ( |
| 49 | func.__name__, args)) |
Tim Peters | 7a3bfc3 | 2001-06-12 01:22:22 +0000 | [diff] [blame] | 50 | |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 51 | def with_warning_restore(func): |
| 52 | def _with_warning_restore(*args, **kw): |
Guido van Rossum | af554a0 | 2007-08-16 23:48:43 +0000 | [diff] [blame] | 53 | with test.test_support.catch_warning(): |
Thomas Wouters | 902d6eb | 2007-01-09 23:18:33 +0000 | [diff] [blame] | 54 | # Grrr, we need this function to warn every time. Without removing |
| 55 | # the warningregistry, running test_tarfile then test_struct would fail |
| 56 | # on 64-bit platforms. |
Neal Norwitz | 221085d | 2007-02-25 20:55:47 +0000 | [diff] [blame] | 57 | globals = func.__globals__ |
Thomas Wouters | 902d6eb | 2007-01-09 23:18:33 +0000 | [diff] [blame] | 58 | if '__warningregistry__' in globals: |
| 59 | del globals['__warningregistry__'] |
| 60 | warnings.filterwarnings("error", r"""^struct.*""", DeprecationWarning) |
| 61 | warnings.filterwarnings("error", r""".*format requires.*""", |
| 62 | DeprecationWarning) |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 63 | return func(*args, **kw) |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 64 | return _with_warning_restore |
| 65 | |
| 66 | def deprecated_err(func, *args): |
| 67 | try: |
| 68 | func(*args) |
| 69 | except (struct.error, TypeError): |
| 70 | pass |
| 71 | except DeprecationWarning: |
| 72 | if not PY_STRUCT_OVERFLOW_MASKING: |
Collin Winter | 3add4d7 | 2007-08-29 23:37:32 +0000 | [diff] [blame] | 73 | raise TestFailed("%s%s expected to raise struct.error" % ( |
| 74 | func.__name__, args)) |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 75 | else: |
Collin Winter | 3add4d7 | 2007-08-29 23:37:32 +0000 | [diff] [blame] | 76 | raise TestFailed("%s%s did not raise error" % ( |
| 77 | func.__name__, args)) |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 78 | deprecated_err = with_warning_restore(deprecated_err) |
| 79 | |
Tim Peters | 17e17d4 | 2001-06-13 22:45:27 +0000 | [diff] [blame] | 80 | |
Tim Peters | 7b9542a | 2001-06-10 23:40:19 +0000 | [diff] [blame] | 81 | simple_err(struct.calcsize, 'Z') |
Barry Warsaw | 07a0eec | 1996-12-12 23:34:06 +0000 | [diff] [blame] | 82 | |
| 83 | sz = struct.calcsize('i') |
Fred Drake | 132dce2 | 2000-12-12 23:11:42 +0000 | [diff] [blame] | 84 | if sz * 3 != struct.calcsize('iii'): |
Collin Winter | 3add4d7 | 2007-08-29 23:37:32 +0000 | [diff] [blame] | 85 | raise TestFailed('inconsistent sizes') |
Barry Warsaw | 07a0eec | 1996-12-12 23:34:06 +0000 | [diff] [blame] | 86 | |
Christian Heimes | dd15f6c | 2008-03-16 00:07:10 +0000 | [diff] [blame] | 87 | fmt = 'cbxxxxxxhhhhiillffd?' |
| 88 | fmt3 = '3c3b18x12h6i6l6f3d3?' |
Guido van Rossum | 04ebf5c | 1997-01-03 19:00:37 +0000 | [diff] [blame] | 89 | sz = struct.calcsize(fmt) |
| 90 | sz3 = struct.calcsize(fmt3) |
Fred Drake | 132dce2 | 2000-12-12 23:11:42 +0000 | [diff] [blame] | 91 | if sz * 3 != sz3: |
Collin Winter | 3add4d7 | 2007-08-29 23:37:32 +0000 | [diff] [blame] | 92 | raise TestFailed('inconsistent sizes (3*%r -> 3*%d = %d, %r -> %d)' % ( |
| 93 | fmt, sz, 3*sz, fmt3, sz3)) |
Barry Warsaw | 07a0eec | 1996-12-12 23:34:06 +0000 | [diff] [blame] | 94 | |
| 95 | simple_err(struct.pack, 'iii', 3) |
| 96 | simple_err(struct.pack, 'i', 3, 3, 3) |
| 97 | simple_err(struct.pack, 'i', 'foo') |
Armin Rigo | 9f90439 | 2004-09-27 19:27:51 +0000 | [diff] [blame] | 98 | simple_err(struct.pack, 'P', 'foo') |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 99 | simple_err(struct.unpack, 'd', b'flap') |
Barry Warsaw | 07a0eec | 1996-12-12 23:34:06 +0000 | [diff] [blame] | 100 | s = struct.pack('ii', 1, 2) |
| 101 | simple_err(struct.unpack, 'iii', s) |
| 102 | simple_err(struct.unpack, 'i', s) |
| 103 | |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 104 | c = b'a' |
Guido van Rossum | 2a37850 | 1996-12-31 17:25:47 +0000 | [diff] [blame] | 105 | b = 1 |
Barry Warsaw | 07a0eec | 1996-12-12 23:34:06 +0000 | [diff] [blame] | 106 | h = 255 |
| 107 | i = 65535 |
| 108 | l = 65536 |
| 109 | f = 3.1415 |
| 110 | d = 3.1415 |
Thomas Wouters | b213704 | 2007-02-01 18:02:27 +0000 | [diff] [blame] | 111 | t = True |
Barry Warsaw | 07a0eec | 1996-12-12 23:34:06 +0000 | [diff] [blame] | 112 | |
Guido van Rossum | 420c11c | 1997-01-03 00:09:46 +0000 | [diff] [blame] | 113 | for prefix in ('', '@', '<', '>', '=', '!'): |
Christian Heimes | dd15f6c | 2008-03-16 00:07:10 +0000 | [diff] [blame] | 114 | for format in ('xcbhilfd?', 'xcBHILfd?'): |
Guido van Rossum | 41360a4 | 1998-03-26 19:42:58 +0000 | [diff] [blame] | 115 | format = prefix + format |
| 116 | if verbose: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 117 | print("trying:", format) |
Thomas Wouters | b213704 | 2007-02-01 18:02:27 +0000 | [diff] [blame] | 118 | s = struct.pack(format, c, b, h, i, l, f, d, t) |
| 119 | cp, bp, hp, ip, lp, fp, dp, tp = struct.unpack(format, s) |
Fred Drake | 132dce2 | 2000-12-12 23:11:42 +0000 | [diff] [blame] | 120 | if (cp != c or bp != b or hp != h or ip != i or lp != l or |
Thomas Wouters | b213704 | 2007-02-01 18:02:27 +0000 | [diff] [blame] | 121 | int(100 * fp) != int(100 * f) or int(100 * dp) != int(100 * d) or |
Thomas Wouters | 9fe394c | 2007-02-05 01:24:16 +0000 | [diff] [blame] | 122 | tp != t): |
Guido van Rossum | 41360a4 | 1998-03-26 19:42:58 +0000 | [diff] [blame] | 123 | # ^^^ calculate only to two decimal places |
Collin Winter | 3add4d7 | 2007-08-29 23:37:32 +0000 | [diff] [blame] | 124 | raise TestFailed("unpack/pack not transitive (%s, %s)" % ( |
| 125 | str(format), str((cp, bp, hp, ip, lp, fp, dp, tp)))) |
Guido van Rossum | 2a37850 | 1996-12-31 17:25:47 +0000 | [diff] [blame] | 126 | |
Guido van Rossum | 420c11c | 1997-01-03 00:09:46 +0000 | [diff] [blame] | 127 | # Test some of the new features in detail |
Guido van Rossum | 2a37850 | 1996-12-31 17:25:47 +0000 | [diff] [blame] | 128 | |
| 129 | # (format, argument, big-endian result, little-endian result, asymmetric) |
| 130 | tests = [ |
| 131 | ('c', 'a', 'a', 'a', 0), |
| 132 | ('xc', 'a', '\0a', '\0a', 0), |
| 133 | ('cx', 'a', 'a\0', 'a\0', 0), |
| 134 | ('s', 'a', 'a', 'a', 0), |
| 135 | ('0s', 'helloworld', '', '', 1), |
| 136 | ('1s', 'helloworld', 'h', 'h', 1), |
| 137 | ('9s', 'helloworld', 'helloworl', 'helloworl', 1), |
| 138 | ('10s', 'helloworld', 'helloworld', 'helloworld', 0), |
| 139 | ('11s', 'helloworld', 'helloworld\0', 'helloworld\0', 1), |
| 140 | ('20s', 'helloworld', 'helloworld'+10*'\0', 'helloworld'+10*'\0', 1), |
| 141 | ('b', 7, '\7', '\7', 0), |
| 142 | ('b', -7, '\371', '\371', 0), |
| 143 | ('B', 7, '\7', '\7', 0), |
| 144 | ('B', 249, '\371', '\371', 0), |
| 145 | ('h', 700, '\002\274', '\274\002', 0), |
| 146 | ('h', -700, '\375D', 'D\375', 0), |
| 147 | ('H', 700, '\002\274', '\274\002', 0), |
| 148 | ('H', 0x10000-700, '\375D', 'D\375', 0), |
| 149 | ('i', 70000000, '\004,\035\200', '\200\035,\004', 0), |
| 150 | ('i', -70000000, '\373\323\342\200', '\200\342\323\373', 0), |
Guido van Rossum | e2a383d | 2007-01-15 16:59:06 +0000 | [diff] [blame] | 151 | ('I', 70000000, '\004,\035\200', '\200\035,\004', 0), |
| 152 | ('I', 0x100000000-70000000, '\373\323\342\200', '\200\342\323\373', 0), |
Guido van Rossum | 2a37850 | 1996-12-31 17:25:47 +0000 | [diff] [blame] | 153 | ('l', 70000000, '\004,\035\200', '\200\035,\004', 0), |
| 154 | ('l', -70000000, '\373\323\342\200', '\200\342\323\373', 0), |
Guido van Rossum | e2a383d | 2007-01-15 16:59:06 +0000 | [diff] [blame] | 155 | ('L', 70000000, '\004,\035\200', '\200\035,\004', 0), |
| 156 | ('L', 0x100000000-70000000, '\373\323\342\200', '\200\342\323\373', 0), |
Guido van Rossum | 420c11c | 1997-01-03 00:09:46 +0000 | [diff] [blame] | 157 | ('f', 2.0, '@\000\000\000', '\000\000\000@', 0), |
| 158 | ('d', 2.0, '@\000\000\000\000\000\000\000', |
| 159 | '\000\000\000\000\000\000\000@', 0), |
| 160 | ('f', -2.0, '\300\000\000\000', '\000\000\000\300', 0), |
| 161 | ('d', -2.0, '\300\000\000\000\000\000\000\000', |
| 162 | '\000\000\000\000\000\000\000\300', 0), |
Christian Heimes | dd15f6c | 2008-03-16 00:07:10 +0000 | [diff] [blame] | 163 | ('?', 0, '\0', '\0', 0), |
| 164 | ('?', 3, '\1', '\1', 1), |
| 165 | ('?', True, '\1', '\1', 0), |
| 166 | ('?', [], '\0', '\0', 1), |
| 167 | ('?', (1,), '\1', '\1', 1), |
Guido van Rossum | 2a37850 | 1996-12-31 17:25:47 +0000 | [diff] [blame] | 168 | ] |
| 169 | |
Guido van Rossum | 2a37850 | 1996-12-31 17:25:47 +0000 | [diff] [blame] | 170 | for fmt, arg, big, lil, asy in tests: |
Guido van Rossum | e625fd5 | 2007-05-27 09:19:04 +0000 | [diff] [blame] | 171 | big = bytes(big, "latin-1") |
| 172 | lil = bytes(lil, "latin-1") |
Guido van Rossum | 2a37850 | 1996-12-31 17:25:47 +0000 | [diff] [blame] | 173 | if verbose: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 174 | print("%r %r %r %r" % (fmt, arg, big, lil)) |
Guido van Rossum | 2a37850 | 1996-12-31 17:25:47 +0000 | [diff] [blame] | 175 | for (xfmt, exp) in [('>'+fmt, big), ('!'+fmt, big), ('<'+fmt, lil), |
Tim Peters | 17e17d4 | 2001-06-13 22:45:27 +0000 | [diff] [blame] | 176 | ('='+fmt, ISBIGENDIAN and big or lil)]: |
Guido van Rossum | 41360a4 | 1998-03-26 19:42:58 +0000 | [diff] [blame] | 177 | res = struct.pack(xfmt, arg) |
| 178 | if res != exp: |
Collin Winter | 3add4d7 | 2007-08-29 23:37:32 +0000 | [diff] [blame] | 179 | raise TestFailed("pack(%r, %r) -> %r # expected %r" % ( |
| 180 | fmt, arg, res, exp)) |
Guido van Rossum | 41360a4 | 1998-03-26 19:42:58 +0000 | [diff] [blame] | 181 | n = struct.calcsize(xfmt) |
| 182 | if n != len(res): |
Collin Winter | 3add4d7 | 2007-08-29 23:37:32 +0000 | [diff] [blame] | 183 | raise TestFailed("calcsize(%r) -> %d # expected %d" % ( |
| 184 | xfmt, n, len(res))) |
Guido van Rossum | 41360a4 | 1998-03-26 19:42:58 +0000 | [diff] [blame] | 185 | rev = struct.unpack(xfmt, res)[0] |
Brett Cannon | 4043001 | 2007-10-22 20:24:51 +0000 | [diff] [blame] | 186 | if isinstance(arg, str): |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 187 | # Strings are returned as bytes since you can't know the encoding of |
Brett Cannon | 4043001 | 2007-10-22 20:24:51 +0000 | [diff] [blame] | 188 | # the string when packed. |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 189 | arg = bytes(arg, 'latin1') |
Guido van Rossum | 41360a4 | 1998-03-26 19:42:58 +0000 | [diff] [blame] | 190 | if rev != arg and not asy: |
Collin Winter | 3add4d7 | 2007-08-29 23:37:32 +0000 | [diff] [blame] | 191 | raise TestFailed("unpack(%r, %r) -> (%r,) # expected (%r,)" % ( |
| 192 | fmt, res, rev, arg)) |
Tim Peters | 7b9542a | 2001-06-10 23:40:19 +0000 | [diff] [blame] | 193 | |
Tim Peters | 7a3bfc3 | 2001-06-12 01:22:22 +0000 | [diff] [blame] | 194 | ########################################################################### |
Tim Peters | 17e17d4 | 2001-06-13 22:45:27 +0000 | [diff] [blame] | 195 | # Simple native q/Q tests. |
Tim Peters | 7b9542a | 2001-06-10 23:40:19 +0000 | [diff] [blame] | 196 | |
| 197 | has_native_qQ = 1 |
| 198 | try: |
| 199 | struct.pack("q", 5) |
| 200 | except struct.error: |
| 201 | has_native_qQ = 0 |
| 202 | |
| 203 | if verbose: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 204 | print("Platform has native q/Q?", has_native_qQ and "Yes." or "No.") |
Tim Peters | 7b9542a | 2001-06-10 23:40:19 +0000 | [diff] [blame] | 205 | |
Tim Peters | 7a3bfc3 | 2001-06-12 01:22:22 +0000 | [diff] [blame] | 206 | any_err(struct.pack, "Q", -1) # can't pack -1 as unsigned regardless |
Tim Peters | 7b9542a | 2001-06-10 23:40:19 +0000 | [diff] [blame] | 207 | simple_err(struct.pack, "q", "a") # can't pack string as 'q' regardless |
| 208 | simple_err(struct.pack, "Q", "a") # ditto, but 'Q' |
| 209 | |
Tim Peters | 7a3bfc3 | 2001-06-12 01:22:22 +0000 | [diff] [blame] | 210 | def test_native_qQ(): |
Guido van Rossum | e625fd5 | 2007-05-27 09:19:04 +0000 | [diff] [blame] | 211 | nbytes = struct.calcsize('q') |
Tim Peters | 7b9542a | 2001-06-10 23:40:19 +0000 | [diff] [blame] | 212 | # The expected values here are in big-endian format, primarily because |
| 213 | # I'm on a little-endian machine and so this is the clearest way (for |
| 214 | # me) to force the code to get exercised. |
| 215 | for format, input, expected in ( |
Guido van Rossum | e625fd5 | 2007-05-27 09:19:04 +0000 | [diff] [blame] | 216 | ('q', -1, '\xff' * nbytes), |
| 217 | ('q', 0, '\x00' * nbytes), |
| 218 | ('Q', 0, '\x00' * nbytes), |
| 219 | ('q', 1, '\x00' * (nbytes-1) + '\x01'), |
| 220 | ('Q', (1 << (8*nbytes))-1, '\xff' * nbytes), |
| 221 | ('q', (1 << (8*nbytes-1))-1, '\x7f' + '\xff' * (nbytes - 1))): |
| 222 | expected = bytes(expected, "latin-1") |
Tim Peters | 7b9542a | 2001-06-10 23:40:19 +0000 | [diff] [blame] | 223 | got = struct.pack(format, input) |
Tim Peters | c533edc | 2001-06-10 23:52:59 +0000 | [diff] [blame] | 224 | native_expected = bigendian_to_native(expected) |
| 225 | verify(got == native_expected, |
Tim Peters | 7b9542a | 2001-06-10 23:40:19 +0000 | [diff] [blame] | 226 | "%r-pack of %r gave %r, not %r" % |
Tim Peters | c533edc | 2001-06-10 23:52:59 +0000 | [diff] [blame] | 227 | (format, input, got, native_expected)) |
Tim Peters | 7b9542a | 2001-06-10 23:40:19 +0000 | [diff] [blame] | 228 | retrieved = struct.unpack(format, got)[0] |
| 229 | verify(retrieved == input, |
| 230 | "%r-unpack of %r gave %r, not %r" % |
| 231 | (format, got, retrieved, input)) |
Tim Peters | 7a3bfc3 | 2001-06-12 01:22:22 +0000 | [diff] [blame] | 232 | |
| 233 | if has_native_qQ: |
| 234 | test_native_qQ() |
| 235 | |
Tim Peters | 17e17d4 | 2001-06-13 22:45:27 +0000 | [diff] [blame] | 236 | ########################################################################### |
| 237 | # Standard integer tests (bBhHiIlLqQ). |
Tim Peters | 7a3bfc3 | 2001-06-12 01:22:22 +0000 | [diff] [blame] | 238 | |
| 239 | import binascii |
Tim Peters | 7a3bfc3 | 2001-06-12 01:22:22 +0000 | [diff] [blame] | 240 | |
Tim Peters | 17e17d4 | 2001-06-13 22:45:27 +0000 | [diff] [blame] | 241 | class IntTester: |
Tim Peters | 7a3bfc3 | 2001-06-12 01:22:22 +0000 | [diff] [blame] | 242 | |
Tim Peters | 17e17d4 | 2001-06-13 22:45:27 +0000 | [diff] [blame] | 243 | # XXX Most std integer modes fail to test for out-of-range. |
Tim Peters | 3eec38a | 2001-06-18 22:27:39 +0000 | [diff] [blame] | 244 | # The "i" and "l" codes appear to range-check OK on 32-bit boxes, but |
| 245 | # fail to check correctly on some 64-bit ones (Tru64 Unix + Compaq C |
| 246 | # reported by Mark Favas). |
| 247 | BUGGY_RANGE_CHECK = "bBhHiIlL" |
Tim Peters | 7a3bfc3 | 2001-06-12 01:22:22 +0000 | [diff] [blame] | 248 | |
Tim Peters | 17e17d4 | 2001-06-13 22:45:27 +0000 | [diff] [blame] | 249 | def __init__(self, formatpair, bytesize): |
| 250 | assert len(formatpair) == 2 |
| 251 | self.formatpair = formatpair |
| 252 | for direction in "<>!=": |
| 253 | for code in formatpair: |
| 254 | format = direction + code |
| 255 | verify(struct.calcsize(format) == bytesize) |
| 256 | self.bytesize = bytesize |
| 257 | self.bitsize = bytesize * 8 |
| 258 | self.signed_code, self.unsigned_code = formatpair |
| 259 | self.unsigned_min = 0 |
Guido van Rossum | e2a383d | 2007-01-15 16:59:06 +0000 | [diff] [blame] | 260 | self.unsigned_max = 2**self.bitsize - 1 |
| 261 | self.signed_min = -(2**(self.bitsize-1)) |
| 262 | self.signed_max = 2**(self.bitsize-1) - 1 |
Tim Peters | 7a3bfc3 | 2001-06-12 01:22:22 +0000 | [diff] [blame] | 263 | |
Tim Peters | 17e17d4 | 2001-06-13 22:45:27 +0000 | [diff] [blame] | 264 | def test_one(self, x, pack=struct.pack, |
| 265 | unpack=struct.unpack, |
| 266 | unhexlify=binascii.unhexlify): |
| 267 | if verbose: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 268 | print("trying std", self.formatpair, "on", x, "==", hex(x)) |
Tim Peters | 7a3bfc3 | 2001-06-12 01:22:22 +0000 | [diff] [blame] | 269 | |
Tim Peters | 17e17d4 | 2001-06-13 22:45:27 +0000 | [diff] [blame] | 270 | # Try signed. |
| 271 | code = self.signed_code |
| 272 | if self.signed_min <= x <= self.signed_max: |
| 273 | # Try big-endian. |
Guido van Rossum | e2a383d | 2007-01-15 16:59:06 +0000 | [diff] [blame] | 274 | expected = int(x) |
Tim Peters | 17e17d4 | 2001-06-13 22:45:27 +0000 | [diff] [blame] | 275 | if x < 0: |
Guido van Rossum | e2a383d | 2007-01-15 16:59:06 +0000 | [diff] [blame] | 276 | expected += 1 << self.bitsize |
Tim Peters | 17e17d4 | 2001-06-13 22:45:27 +0000 | [diff] [blame] | 277 | assert expected > 0 |
Guido van Rossum | e2b70bc | 2006-08-18 22:13:04 +0000 | [diff] [blame] | 278 | expected = hex(expected)[2:] # chop "0x" |
Tim Peters | 17e17d4 | 2001-06-13 22:45:27 +0000 | [diff] [blame] | 279 | if len(expected) & 1: |
| 280 | expected = "0" + expected |
| 281 | expected = unhexlify(expected) |
Guido van Rossum | e625fd5 | 2007-05-27 09:19:04 +0000 | [diff] [blame] | 282 | expected = b"\x00" * (self.bytesize - len(expected)) + expected |
Tim Peters | 7a3bfc3 | 2001-06-12 01:22:22 +0000 | [diff] [blame] | 283 | |
Tim Peters | 17e17d4 | 2001-06-13 22:45:27 +0000 | [diff] [blame] | 284 | # Pack work? |
| 285 | format = ">" + code |
| 286 | got = pack(format, x) |
| 287 | verify(got == expected, |
| 288 | "'%s'-pack of %r gave %r, not %r" % |
| 289 | (format, x, got, expected)) |
Tim Peters | 7a3bfc3 | 2001-06-12 01:22:22 +0000 | [diff] [blame] | 290 | |
Tim Peters | 17e17d4 | 2001-06-13 22:45:27 +0000 | [diff] [blame] | 291 | # Unpack work? |
| 292 | retrieved = unpack(format, got)[0] |
| 293 | verify(x == retrieved, |
| 294 | "'%s'-unpack of %r gave %r, not %r" % |
| 295 | (format, got, retrieved, x)) |
Tim Peters | 7a3bfc3 | 2001-06-12 01:22:22 +0000 | [diff] [blame] | 296 | |
Tim Peters | 17e17d4 | 2001-06-13 22:45:27 +0000 | [diff] [blame] | 297 | # Adding any byte should cause a "too big" error. |
Guido van Rossum | e625fd5 | 2007-05-27 09:19:04 +0000 | [diff] [blame] | 298 | any_err(unpack, format, b'\x01' + got) |
Tim Peters | 7a3bfc3 | 2001-06-12 01:22:22 +0000 | [diff] [blame] | 299 | |
Tim Peters | 17e17d4 | 2001-06-13 22:45:27 +0000 | [diff] [blame] | 300 | # Try little-endian. |
| 301 | format = "<" + code |
| 302 | expected = string_reverse(expected) |
Tim Peters | 7a3bfc3 | 2001-06-12 01:22:22 +0000 | [diff] [blame] | 303 | |
Tim Peters | 17e17d4 | 2001-06-13 22:45:27 +0000 | [diff] [blame] | 304 | # Pack work? |
| 305 | got = pack(format, x) |
| 306 | verify(got == expected, |
| 307 | "'%s'-pack of %r gave %r, not %r" % |
| 308 | (format, x, got, expected)) |
Tim Peters | 7a3bfc3 | 2001-06-12 01:22:22 +0000 | [diff] [blame] | 309 | |
Tim Peters | 17e17d4 | 2001-06-13 22:45:27 +0000 | [diff] [blame] | 310 | # Unpack work? |
| 311 | retrieved = unpack(format, got)[0] |
| 312 | verify(x == retrieved, |
| 313 | "'%s'-unpack of %r gave %r, not %r" % |
| 314 | (format, got, retrieved, x)) |
Tim Peters | 7a3bfc3 | 2001-06-12 01:22:22 +0000 | [diff] [blame] | 315 | |
Tim Peters | 17e17d4 | 2001-06-13 22:45:27 +0000 | [diff] [blame] | 316 | # Adding any byte should cause a "too big" error. |
Guido van Rossum | e625fd5 | 2007-05-27 09:19:04 +0000 | [diff] [blame] | 317 | any_err(unpack, format, b'\x01' + got) |
Tim Peters | 7a3bfc3 | 2001-06-12 01:22:22 +0000 | [diff] [blame] | 318 | |
Tim Peters | 17e17d4 | 2001-06-13 22:45:27 +0000 | [diff] [blame] | 319 | else: |
| 320 | # x is out of range -- verify pack realizes that. |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 321 | if not PY_STRUCT_RANGE_CHECKING and code in self.BUGGY_RANGE_CHECK: |
Tim Peters | 17e17d4 | 2001-06-13 22:45:27 +0000 | [diff] [blame] | 322 | if verbose: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 323 | print("Skipping buggy range check for code", code) |
Tim Peters | 17e17d4 | 2001-06-13 22:45:27 +0000 | [diff] [blame] | 324 | else: |
Thomas Wouters | 4d70c3d | 2006-06-08 14:42:34 +0000 | [diff] [blame] | 325 | deprecated_err(pack, ">" + code, x) |
| 326 | deprecated_err(pack, "<" + code, x) |
Tim Peters | 7a3bfc3 | 2001-06-12 01:22:22 +0000 | [diff] [blame] | 327 | |
Tim Peters | 17e17d4 | 2001-06-13 22:45:27 +0000 | [diff] [blame] | 328 | # Much the same for unsigned. |
| 329 | code = self.unsigned_code |
| 330 | if self.unsigned_min <= x <= self.unsigned_max: |
| 331 | # Try big-endian. |
| 332 | format = ">" + code |
Guido van Rossum | e2a383d | 2007-01-15 16:59:06 +0000 | [diff] [blame] | 333 | expected = int(x) |
Guido van Rossum | e2b70bc | 2006-08-18 22:13:04 +0000 | [diff] [blame] | 334 | expected = hex(expected)[2:] # chop "0x" |
Tim Peters | 17e17d4 | 2001-06-13 22:45:27 +0000 | [diff] [blame] | 335 | if len(expected) & 1: |
| 336 | expected = "0" + expected |
| 337 | expected = unhexlify(expected) |
Guido van Rossum | e625fd5 | 2007-05-27 09:19:04 +0000 | [diff] [blame] | 338 | expected = b"\x00" * (self.bytesize - len(expected)) + expected |
Tim Peters | 7a3bfc3 | 2001-06-12 01:22:22 +0000 | [diff] [blame] | 339 | |
Tim Peters | 17e17d4 | 2001-06-13 22:45:27 +0000 | [diff] [blame] | 340 | # Pack work? |
| 341 | got = pack(format, x) |
| 342 | verify(got == expected, |
| 343 | "'%s'-pack of %r gave %r, not %r" % |
| 344 | (format, x, got, expected)) |
Tim Peters | 7a3bfc3 | 2001-06-12 01:22:22 +0000 | [diff] [blame] | 345 | |
Tim Peters | 17e17d4 | 2001-06-13 22:45:27 +0000 | [diff] [blame] | 346 | # Unpack work? |
| 347 | retrieved = unpack(format, got)[0] |
| 348 | verify(x == retrieved, |
| 349 | "'%s'-unpack of %r gave %r, not %r" % |
| 350 | (format, got, retrieved, x)) |
Tim Peters | 7a3bfc3 | 2001-06-12 01:22:22 +0000 | [diff] [blame] | 351 | |
Tim Peters | 17e17d4 | 2001-06-13 22:45:27 +0000 | [diff] [blame] | 352 | # Adding any byte should cause a "too big" error. |
Guido van Rossum | e625fd5 | 2007-05-27 09:19:04 +0000 | [diff] [blame] | 353 | any_err(unpack, format, b'\x01' + got) |
Tim Peters | 7a3bfc3 | 2001-06-12 01:22:22 +0000 | [diff] [blame] | 354 | |
Tim Peters | 17e17d4 | 2001-06-13 22:45:27 +0000 | [diff] [blame] | 355 | # Try little-endian. |
| 356 | format = "<" + code |
| 357 | expected = string_reverse(expected) |
Tim Peters | 7a3bfc3 | 2001-06-12 01:22:22 +0000 | [diff] [blame] | 358 | |
Tim Peters | 17e17d4 | 2001-06-13 22:45:27 +0000 | [diff] [blame] | 359 | # Pack work? |
| 360 | got = pack(format, x) |
| 361 | verify(got == expected, |
| 362 | "'%s'-pack of %r gave %r, not %r" % |
| 363 | (format, x, got, expected)) |
Tim Peters | 7a3bfc3 | 2001-06-12 01:22:22 +0000 | [diff] [blame] | 364 | |
Tim Peters | 17e17d4 | 2001-06-13 22:45:27 +0000 | [diff] [blame] | 365 | # Unpack work? |
| 366 | retrieved = unpack(format, got)[0] |
| 367 | verify(x == retrieved, |
| 368 | "'%s'-unpack of %r gave %r, not %r" % |
| 369 | (format, got, retrieved, x)) |
Tim Peters | 7a3bfc3 | 2001-06-12 01:22:22 +0000 | [diff] [blame] | 370 | |
Tim Peters | 17e17d4 | 2001-06-13 22:45:27 +0000 | [diff] [blame] | 371 | # Adding any byte should cause a "too big" error. |
Guido van Rossum | e625fd5 | 2007-05-27 09:19:04 +0000 | [diff] [blame] | 372 | any_err(unpack, format, b'\x01' + got) |
Tim Peters | 7a3bfc3 | 2001-06-12 01:22:22 +0000 | [diff] [blame] | 373 | |
Tim Peters | 17e17d4 | 2001-06-13 22:45:27 +0000 | [diff] [blame] | 374 | else: |
| 375 | # x is out of range -- verify pack realizes that. |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 376 | if not PY_STRUCT_RANGE_CHECKING and code in self.BUGGY_RANGE_CHECK: |
Tim Peters | 17e17d4 | 2001-06-13 22:45:27 +0000 | [diff] [blame] | 377 | if verbose: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 378 | print("Skipping buggy range check for code", code) |
Tim Peters | 17e17d4 | 2001-06-13 22:45:27 +0000 | [diff] [blame] | 379 | else: |
Thomas Wouters | 4d70c3d | 2006-06-08 14:42:34 +0000 | [diff] [blame] | 380 | deprecated_err(pack, ">" + code, x) |
| 381 | deprecated_err(pack, "<" + code, x) |
Tim Peters | 7a3bfc3 | 2001-06-12 01:22:22 +0000 | [diff] [blame] | 382 | |
Tim Peters | 17e17d4 | 2001-06-13 22:45:27 +0000 | [diff] [blame] | 383 | def run(self): |
| 384 | from random import randrange |
| 385 | |
| 386 | # Create all interesting powers of 2. |
| 387 | values = [] |
| 388 | for exp in range(self.bitsize + 3): |
Guido van Rossum | e2a383d | 2007-01-15 16:59:06 +0000 | [diff] [blame] | 389 | values.append(1 << exp) |
Tim Peters | 17e17d4 | 2001-06-13 22:45:27 +0000 | [diff] [blame] | 390 | |
| 391 | # Add some random values. |
| 392 | for i in range(self.bitsize): |
Guido van Rossum | e2a383d | 2007-01-15 16:59:06 +0000 | [diff] [blame] | 393 | val = 0 |
Tim Peters | 17e17d4 | 2001-06-13 22:45:27 +0000 | [diff] [blame] | 394 | for j in range(self.bytesize): |
| 395 | val = (val << 8) | randrange(256) |
| 396 | values.append(val) |
| 397 | |
| 398 | # Try all those, and their negations, and +-1 from them. Note |
| 399 | # that this tests all power-of-2 boundaries in range, and a few out |
| 400 | # of range, plus +-(2**n +- 1). |
| 401 | for base in values: |
| 402 | for val in -base, base: |
| 403 | for incr in -1, 0, 1: |
| 404 | x = val + incr |
| 405 | try: |
| 406 | x = int(x) |
| 407 | except OverflowError: |
| 408 | pass |
| 409 | self.test_one(x) |
| 410 | |
| 411 | # Some error cases. |
| 412 | for direction in "<>": |
| 413 | for code in self.formatpair: |
| 414 | for badobject in "a string", 3+42j, randrange: |
| 415 | any_err(struct.pack, direction + code, badobject) |
| 416 | |
| 417 | for args in [("bB", 1), |
| 418 | ("hH", 2), |
| 419 | ("iI", 4), |
| 420 | ("lL", 4), |
| 421 | ("qQ", 8)]: |
| 422 | t = IntTester(*args) |
| 423 | t.run() |
Tim Peters | 0891ac0 | 2001-09-15 02:35:15 +0000 | [diff] [blame] | 424 | |
| 425 | |
| 426 | ########################################################################### |
| 427 | # The p ("Pascal string") code. |
| 428 | |
| 429 | def test_p_code(): |
| 430 | for code, input, expected, expectedback in [ |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 431 | ('p','abc', '\x00', b''), |
| 432 | ('1p', 'abc', '\x00', b''), |
| 433 | ('2p', 'abc', '\x01a', b'a'), |
| 434 | ('3p', 'abc', '\x02ab', b'ab'), |
| 435 | ('4p', 'abc', '\x03abc', b'abc'), |
| 436 | ('5p', 'abc', '\x03abc\x00', b'abc'), |
| 437 | ('6p', 'abc', '\x03abc\x00\x00', b'abc'), |
| 438 | ('1000p', 'x'*1000, '\xff' + 'x'*999, b'x'*255)]: |
Guido van Rossum | e625fd5 | 2007-05-27 09:19:04 +0000 | [diff] [blame] | 439 | expected = bytes(expected, "latin-1") |
Tim Peters | 0891ac0 | 2001-09-15 02:35:15 +0000 | [diff] [blame] | 440 | got = struct.pack(code, input) |
| 441 | if got != expected: |
| 442 | raise TestFailed("pack(%r, %r) == %r but expected %r" % |
| 443 | (code, input, got, expected)) |
| 444 | (got,) = struct.unpack(code, got) |
| 445 | if got != expectedback: |
| 446 | raise TestFailed("unpack(%r, %r) == %r but expected %r" % |
| 447 | (code, input, got, expectedback)) |
| 448 | |
| 449 | test_p_code() |
Tim Peters | d50ade6 | 2003-03-20 18:32:13 +0000 | [diff] [blame] | 450 | |
| 451 | |
| 452 | ########################################################################### |
| 453 | # SF bug 705836. "<f" and ">f" had a severe rounding bug, where a carry |
| 454 | # from the low-order discarded bits could propagate into the exponent |
| 455 | # field, causing the result to be wrong by a factor of 2. |
| 456 | |
| 457 | def test_705836(): |
| 458 | import math |
| 459 | |
| 460 | for base in range(1, 33): |
| 461 | # smaller <- largest representable float less than base. |
| 462 | delta = 0.5 |
| 463 | while base - delta / 2.0 != base: |
| 464 | delta /= 2.0 |
| 465 | smaller = base - delta |
| 466 | # Packing this rounds away a solid string of trailing 1 bits. |
| 467 | packed = struct.pack("<f", smaller) |
| 468 | unpacked = struct.unpack("<f", packed)[0] |
| 469 | # This failed at base = 2, 4, and 32, with unpacked = 1, 2, and |
| 470 | # 16, respectively. |
| 471 | verify(base == unpacked) |
| 472 | bigpacked = struct.pack(">f", smaller) |
| 473 | verify(bigpacked == string_reverse(packed), |
| 474 | ">f pack should be byte-reversal of <f pack") |
| 475 | unpacked = struct.unpack(">f", bigpacked)[0] |
| 476 | verify(base == unpacked) |
| 477 | |
| 478 | # Largest finite IEEE single. |
| 479 | big = (1 << 24) - 1 |
| 480 | big = math.ldexp(big, 127 - 23) |
| 481 | packed = struct.pack(">f", big) |
| 482 | unpacked = struct.unpack(">f", packed)[0] |
| 483 | verify(big == unpacked) |
| 484 | |
| 485 | # The same, but tack on a 1 bit so it rounds up to infinity. |
| 486 | big = (1 << 25) - 1 |
| 487 | big = math.ldexp(big, 127 - 24) |
| 488 | try: |
| 489 | packed = struct.pack(">f", big) |
| 490 | except OverflowError: |
| 491 | pass |
| 492 | else: |
Christian Heimes | dd15f6c | 2008-03-16 00:07:10 +0000 | [diff] [blame] | 493 | raise TestFailed("expected OverflowError") |
Tim Peters | d50ade6 | 2003-03-20 18:32:13 +0000 | [diff] [blame] | 494 | |
| 495 | test_705836() |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 496 | |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 497 | ########################################################################### |
| 498 | # SF bug 1229380. No struct.pack exception for some out of range integers |
| 499 | |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 500 | def test_1229380(): |
| 501 | import sys |
| 502 | for endian in ('', '>', '<'): |
Walter Dörwald | aa97f04 | 2007-05-03 21:05:51 +0000 | [diff] [blame] | 503 | for fmt in ('B', 'H', 'I', 'L'): |
| 504 | deprecated_err(struct.pack, endian + fmt, -1) |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 505 | |
Walter Dörwald | aa97f04 | 2007-05-03 21:05:51 +0000 | [diff] [blame] | 506 | deprecated_err(struct.pack, endian + 'B', 300) |
| 507 | deprecated_err(struct.pack, endian + 'H', 70000) |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 508 | |
Christian Heimes | a37d4c6 | 2007-12-04 23:02:19 +0000 | [diff] [blame] | 509 | deprecated_err(struct.pack, endian + 'I', sys.maxsize * 4) |
| 510 | deprecated_err(struct.pack, endian + 'L', sys.maxsize * 4) |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 511 | |
| 512 | if PY_STRUCT_RANGE_CHECKING: |
| 513 | test_1229380() |
| 514 | |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 515 | ########################################################################### |
| 516 | # SF bug 1530559. struct.pack raises TypeError where it used to convert. |
| 517 | |
| 518 | def check_float_coerce(format, number): |
| 519 | if PY_STRUCT_FLOAT_COERCE == 2: |
| 520 | # Test for pre-2.5 struct module |
| 521 | packed = struct.pack(format, number) |
| 522 | floored = struct.unpack(format, packed)[0] |
| 523 | if floored != int(number): |
| 524 | raise TestFailed("did not correcly coerce float to int") |
| 525 | return |
| 526 | try: |
| 527 | func(*args) |
| 528 | except (struct.error, TypeError): |
| 529 | if PY_STRUCT_FLOAT_COERCE: |
| 530 | raise TestFailed("expected DeprecationWarning for float coerce") |
| 531 | except DeprecationWarning: |
| 532 | if not PY_STRUCT_FLOAT_COERCE: |
| 533 | raise TestFailed("expected to raise struct.error for float coerce") |
| 534 | else: |
| 535 | raise TestFailed("did not raise error for float coerce") |
| 536 | |
| 537 | check_float_coerce = with_warning_restore(deprecated_err) |
| 538 | |
| 539 | def test_1530559(): |
| 540 | for endian in ('', '>', '<'): |
| 541 | for fmt in ('B', 'H', 'I', 'L', 'b', 'h', 'i', 'l'): |
| 542 | check_float_coerce(endian + fmt, 1.0) |
| 543 | check_float_coerce(endian + fmt, 1.5) |
| 544 | |
| 545 | test_1530559() |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 546 | |
Thomas Wouters | 4d70c3d | 2006-06-08 14:42:34 +0000 | [diff] [blame] | 547 | ########################################################################### |
Guido van Rossum | bae07c9 | 2007-10-08 02:46:15 +0000 | [diff] [blame] | 548 | # Packing and unpacking to/from memory views. |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 549 | |
Thomas Wouters | 4d70c3d | 2006-06-08 14:42:34 +0000 | [diff] [blame] | 550 | # Copied and modified from unittest. |
| 551 | def assertRaises(excClass, callableObj, *args, **kwargs): |
| 552 | try: |
| 553 | callableObj(*args, **kwargs) |
| 554 | except excClass: |
| 555 | return |
| 556 | else: |
Thomas Wouters | 73e5a5b | 2006-06-08 15:35:45 +0000 | [diff] [blame] | 557 | raise TestFailed("%s not raised." % excClass) |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 558 | |
Thomas Wouters | 4d70c3d | 2006-06-08 14:42:34 +0000 | [diff] [blame] | 559 | def test_unpack_from(): |
Guido van Rossum | e625fd5 | 2007-05-27 09:19:04 +0000 | [diff] [blame] | 560 | test_string = b'abcd01234' |
Thomas Wouters | 4d70c3d | 2006-06-08 14:42:34 +0000 | [diff] [blame] | 561 | fmt = '4s' |
| 562 | s = struct.Struct(fmt) |
Guido van Rossum | 254348e | 2007-11-21 19:29:53 +0000 | [diff] [blame] | 563 | for cls in (bytes, bytearray): |
Guido van Rossum | e625fd5 | 2007-05-27 09:19:04 +0000 | [diff] [blame] | 564 | if verbose: |
| 565 | print("test_unpack_from using", cls.__name__) |
Thomas Wouters | 4d70c3d | 2006-06-08 14:42:34 +0000 | [diff] [blame] | 566 | data = cls(test_string) |
Guido van Rossum | 254348e | 2007-11-21 19:29:53 +0000 | [diff] [blame] | 567 | if not isinstance(data, (bytes, bytearray)): |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 568 | bytes_data = bytes(data, 'latin1') |
Georg Brandl | bd1c68c | 2007-10-24 18:55:37 +0000 | [diff] [blame] | 569 | else: |
| 570 | bytes_data = data |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 571 | vereq(s.unpack_from(data), (b'abcd',)) |
| 572 | vereq(s.unpack_from(data, 2), (b'cd01',)) |
| 573 | vereq(s.unpack_from(data, 4), (b'0123',)) |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 574 | for i in range(6): |
Georg Brandl | bd1c68c | 2007-10-24 18:55:37 +0000 | [diff] [blame] | 575 | vereq(s.unpack_from(data, i), (bytes_data[i:i+4],)) |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 576 | for i in range(6, len(test_string) + 1): |
Thomas Wouters | 4d70c3d | 2006-06-08 14:42:34 +0000 | [diff] [blame] | 577 | simple_err(s.unpack_from, data, i) |
Guido van Rossum | 254348e | 2007-11-21 19:29:53 +0000 | [diff] [blame] | 578 | for cls in (bytes, bytearray): |
Thomas Wouters | 4d70c3d | 2006-06-08 14:42:34 +0000 | [diff] [blame] | 579 | data = cls(test_string) |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 580 | vereq(struct.unpack_from(fmt, data), (b'abcd',)) |
| 581 | vereq(struct.unpack_from(fmt, data, 2), (b'cd01',)) |
| 582 | vereq(struct.unpack_from(fmt, data, 4), (b'0123',)) |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 583 | for i in range(6): |
Georg Brandl | bd1c68c | 2007-10-24 18:55:37 +0000 | [diff] [blame] | 584 | vereq(struct.unpack_from(fmt, data, i), (bytes_data[i:i+4],)) |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 585 | for i in range(6, len(test_string) + 1): |
Thomas Wouters | 4d70c3d | 2006-06-08 14:42:34 +0000 | [diff] [blame] | 586 | simple_err(struct.unpack_from, fmt, data, i) |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 587 | |
Thomas Wouters | 73e5a5b | 2006-06-08 15:35:45 +0000 | [diff] [blame] | 588 | def test_pack_into(): |
Guido van Rossum | 99c0c22 | 2007-07-03 16:28:47 +0000 | [diff] [blame] | 589 | test_string = b'Reykjavik rocks, eow!' |
| 590 | writable_buf = array.array('b', b' '*100) |
Thomas Wouters | 4d70c3d | 2006-06-08 14:42:34 +0000 | [diff] [blame] | 591 | fmt = '21s' |
| 592 | s = struct.Struct(fmt) |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 593 | |
Thomas Wouters | 4d70c3d | 2006-06-08 14:42:34 +0000 | [diff] [blame] | 594 | # Test without offset |
Thomas Wouters | 73e5a5b | 2006-06-08 15:35:45 +0000 | [diff] [blame] | 595 | s.pack_into(writable_buf, 0, test_string) |
Thomas Wouters | 4d70c3d | 2006-06-08 14:42:34 +0000 | [diff] [blame] | 596 | from_buf = writable_buf.tostring()[:len(test_string)] |
Thomas Wouters | 73e5a5b | 2006-06-08 15:35:45 +0000 | [diff] [blame] | 597 | vereq(from_buf, test_string) |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 598 | |
Thomas Wouters | 4d70c3d | 2006-06-08 14:42:34 +0000 | [diff] [blame] | 599 | # Test with offset. |
Thomas Wouters | 73e5a5b | 2006-06-08 15:35:45 +0000 | [diff] [blame] | 600 | s.pack_into(writable_buf, 10, test_string) |
Thomas Wouters | 4d70c3d | 2006-06-08 14:42:34 +0000 | [diff] [blame] | 601 | from_buf = writable_buf.tostring()[:len(test_string)+10] |
Thomas Wouters | 73e5a5b | 2006-06-08 15:35:45 +0000 | [diff] [blame] | 602 | vereq(from_buf, test_string[:10] + test_string) |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 603 | |
Thomas Wouters | 4d70c3d | 2006-06-08 14:42:34 +0000 | [diff] [blame] | 604 | # Go beyond boundaries. |
Guido van Rossum | 99c0c22 | 2007-07-03 16:28:47 +0000 | [diff] [blame] | 605 | small_buf = array.array('b', b' '*10) |
Thomas Wouters | 73e5a5b | 2006-06-08 15:35:45 +0000 | [diff] [blame] | 606 | assertRaises(struct.error, s.pack_into, small_buf, 0, test_string) |
| 607 | assertRaises(struct.error, s.pack_into, small_buf, 2, test_string) |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 608 | |
Thomas Wouters | 73e5a5b | 2006-06-08 15:35:45 +0000 | [diff] [blame] | 609 | def test_pack_into_fn(): |
Guido van Rossum | 99c0c22 | 2007-07-03 16:28:47 +0000 | [diff] [blame] | 610 | test_string = b'Reykjavik rocks, eow!' |
| 611 | writable_buf = array.array('b', b' '*100) |
Thomas Wouters | 4d70c3d | 2006-06-08 14:42:34 +0000 | [diff] [blame] | 612 | fmt = '21s' |
Thomas Wouters | 73e5a5b | 2006-06-08 15:35:45 +0000 | [diff] [blame] | 613 | pack_into = lambda *args: struct.pack_into(fmt, *args) |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 614 | |
Thomas Wouters | 73e5a5b | 2006-06-08 15:35:45 +0000 | [diff] [blame] | 615 | # Test without offset. |
| 616 | pack_into(writable_buf, 0, test_string) |
Thomas Wouters | 4d70c3d | 2006-06-08 14:42:34 +0000 | [diff] [blame] | 617 | from_buf = writable_buf.tostring()[:len(test_string)] |
Thomas Wouters | 73e5a5b | 2006-06-08 15:35:45 +0000 | [diff] [blame] | 618 | vereq(from_buf, test_string) |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 619 | |
Thomas Wouters | 4d70c3d | 2006-06-08 14:42:34 +0000 | [diff] [blame] | 620 | # Test with offset. |
Thomas Wouters | 73e5a5b | 2006-06-08 15:35:45 +0000 | [diff] [blame] | 621 | pack_into(writable_buf, 10, test_string) |
Thomas Wouters | 4d70c3d | 2006-06-08 14:42:34 +0000 | [diff] [blame] | 622 | from_buf = writable_buf.tostring()[:len(test_string)+10] |
Thomas Wouters | 73e5a5b | 2006-06-08 15:35:45 +0000 | [diff] [blame] | 623 | vereq(from_buf, test_string[:10] + test_string) |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 624 | |
Thomas Wouters | 4d70c3d | 2006-06-08 14:42:34 +0000 | [diff] [blame] | 625 | # Go beyond boundaries. |
Guido van Rossum | 99c0c22 | 2007-07-03 16:28:47 +0000 | [diff] [blame] | 626 | small_buf = array.array('b', b' '*10) |
Thomas Wouters | 73e5a5b | 2006-06-08 15:35:45 +0000 | [diff] [blame] | 627 | assertRaises(struct.error, pack_into, small_buf, 0, test_string) |
| 628 | assertRaises(struct.error, pack_into, small_buf, 2, test_string) |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 629 | |
Guido van Rossum | bae07c9 | 2007-10-08 02:46:15 +0000 | [diff] [blame] | 630 | def test_unpack_with_memoryview(): |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 631 | # SF bug 1563759: struct.unpack doens't support buffer protocol objects |
Guido van Rossum | e625fd5 | 2007-05-27 09:19:04 +0000 | [diff] [blame] | 632 | data1 = array.array('B', b'\x12\x34\x56\x78') |
Guido van Rossum | bae07c9 | 2007-10-08 02:46:15 +0000 | [diff] [blame] | 633 | data2 = memoryview(b'\x12\x34\x56\x78') # XXX b'......XXXX......', 6, 4 |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 634 | for data in [data1, data2]: |
| 635 | value, = struct.unpack('>I', data) |
| 636 | vereq(value, 0x12345678) |
Thomas Wouters | 73e5a5b | 2006-06-08 15:35:45 +0000 | [diff] [blame] | 637 | |
Guido van Rossum | bae07c9 | 2007-10-08 02:46:15 +0000 | [diff] [blame] | 638 | # Test methods to pack and unpack from memoryviews rather than strings. |
Thomas Wouters | 4d70c3d | 2006-06-08 14:42:34 +0000 | [diff] [blame] | 639 | test_unpack_from() |
Thomas Wouters | 73e5a5b | 2006-06-08 15:35:45 +0000 | [diff] [blame] | 640 | test_pack_into() |
| 641 | test_pack_into_fn() |
Guido van Rossum | bae07c9 | 2007-10-08 02:46:15 +0000 | [diff] [blame] | 642 | test_unpack_with_memoryview() |
Thomas Wouters | b213704 | 2007-02-01 18:02:27 +0000 | [diff] [blame] | 643 | |
| 644 | def test_bool(): |
Thomas Wouters | 9fe394c | 2007-02-05 01:24:16 +0000 | [diff] [blame] | 645 | for prefix in tuple("<>!=")+('',): |
| 646 | false = (), [], [], '', 0 |
| 647 | true = [1], 'test', 5, -1, 0xffffffff+1, 0xffffffff/2 |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 648 | |
Christian Heimes | dd15f6c | 2008-03-16 00:07:10 +0000 | [diff] [blame] | 649 | falseFormat = prefix + '?' * len(false) |
Thomas Wouters | 9fe394c | 2007-02-05 01:24:16 +0000 | [diff] [blame] | 650 | if verbose: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 651 | print('trying bool pack/unpack on', false, 'using format', falseFormat) |
Thomas Wouters | 9fe394c | 2007-02-05 01:24:16 +0000 | [diff] [blame] | 652 | packedFalse = struct.pack(falseFormat, *false) |
| 653 | unpackedFalse = struct.unpack(falseFormat, packedFalse) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 654 | |
Christian Heimes | dd15f6c | 2008-03-16 00:07:10 +0000 | [diff] [blame] | 655 | trueFormat = prefix + '?' * len(true) |
Thomas Wouters | 9fe394c | 2007-02-05 01:24:16 +0000 | [diff] [blame] | 656 | if verbose: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 657 | print('trying bool pack/unpack on', true, 'using format', trueFormat) |
Thomas Wouters | 9fe394c | 2007-02-05 01:24:16 +0000 | [diff] [blame] | 658 | packedTrue = struct.pack(trueFormat, *true) |
| 659 | unpackedTrue = struct.unpack(trueFormat, packedTrue) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 660 | |
Thomas Wouters | 9fe394c | 2007-02-05 01:24:16 +0000 | [diff] [blame] | 661 | if len(true) != len(unpackedTrue): |
| 662 | raise TestFailed('unpacked true array is not of same size as input') |
| 663 | if len(false) != len(unpackedFalse): |
| 664 | raise TestFailed('unpacked false array is not of same size as input') |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 665 | |
Thomas Wouters | 9fe394c | 2007-02-05 01:24:16 +0000 | [diff] [blame] | 666 | for t in unpackedFalse: |
| 667 | if t is not False: |
| 668 | raise TestFailed('%r did not unpack as False' % t) |
| 669 | for t in unpackedTrue: |
| 670 | if t is not True: |
| 671 | raise TestFailed('%r did not unpack as false' % t) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 672 | |
Thomas Wouters | 9fe394c | 2007-02-05 01:24:16 +0000 | [diff] [blame] | 673 | if prefix and verbose: |
Christian Heimes | dd15f6c | 2008-03-16 00:07:10 +0000 | [diff] [blame] | 674 | print('trying size of bool with format %r' % (prefix+'?')) |
| 675 | packed = struct.pack(prefix+'?', 1) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 676 | |
Christian Heimes | dd15f6c | 2008-03-16 00:07:10 +0000 | [diff] [blame] | 677 | if len(packed) != struct.calcsize(prefix+'?'): |
Thomas Wouters | 9fe394c | 2007-02-05 01:24:16 +0000 | [diff] [blame] | 678 | raise TestFailed('packed length is not equal to calculated size') |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 679 | |
Thomas Wouters | 9fe394c | 2007-02-05 01:24:16 +0000 | [diff] [blame] | 680 | if len(packed) != 1 and prefix: |
| 681 | raise TestFailed('encoded bool is not one byte: %r' % packed) |
| 682 | elif not prefix and verbose: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 683 | print('size of bool in native format is %i' % (len(packed))) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 684 | |
Mark Dickinson | 0eb6f69 | 2008-03-16 02:29:03 +0000 | [diff] [blame] | 685 | for c in [b'\x01', b'\x7f', b'\xff', b'\x0f', b'\xf0']: |
Christian Heimes | dd15f6c | 2008-03-16 00:07:10 +0000 | [diff] [blame] | 686 | if struct.unpack('>?', c)[0] is not True: |
Thomas Wouters | 9fe394c | 2007-02-05 01:24:16 +0000 | [diff] [blame] | 687 | raise TestFailed('%c did not unpack as True' % c) |
Thomas Wouters | b213704 | 2007-02-01 18:02:27 +0000 | [diff] [blame] | 688 | |
| 689 | test_bool() |