1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854
|
#!/usr/bin/env python3
import asyncio
import dis
import inspect
import opcode
import sys
import textwrap
import types
import unittest
from bytecode import (
UNSET,
Bytecode,
CellVar,
CompilerFlags,
ConcreteBytecode,
ConcreteInstr,
FreeVar,
Instr,
Label,
SetLineno,
)
from bytecode.concrete import OFFSET_AS_INSTRUCTION, ExceptionTableEntry
from bytecode.utils import PY313
from . import TestCase, get_code
class ConcreteInstrTests(TestCase):
def test_constructor(self):
with self.assertRaises(ValueError):
# need an argument
ConcreteInstr("LOAD_CONST")
with self.assertRaises(ValueError):
# must not have an argument
ConcreteInstr("ROT_TWO", 33)
# invalid argument
with self.assertRaises(TypeError):
ConcreteInstr("LOAD_CONST", 1.0)
with self.assertRaises(ValueError):
ConcreteInstr("LOAD_CONST", -1)
with self.assertRaises(TypeError):
ConcreteInstr("LOAD_CONST", 5, lineno=1.0)
with self.assertRaises(ValueError):
ConcreteInstr("LOAD_CONST", 5, lineno=-1)
# test maximum argument
with self.assertRaises(ValueError):
ConcreteInstr("LOAD_CONST", 2147483647 + 1)
instr = ConcreteInstr("LOAD_CONST", 2147483647)
self.assertEqual(instr.arg, 2147483647)
# test meaningless extended args
instr = ConcreteInstr("LOAD_FAST", 8, lineno=3, extended_args=1)
self.assertEqual(instr.name, "LOAD_FAST")
self.assertEqual(instr.arg, 8)
self.assertEqual(instr.lineno, 3)
self.assertEqual(instr.size, 4)
def test_attr(self):
instr = ConcreteInstr("LOAD_CONST", 5, lineno=12)
self.assertEqual(instr.name, "LOAD_CONST")
self.assertEqual(instr.opcode, opcode.opmap["LOAD_CONST"])
self.assertEqual(instr.arg, 5)
self.assertEqual(instr.lineno, 12)
self.assertEqual(instr.size, 2)
def test_set(self):
instr = ConcreteInstr("LOAD_CONST", 5, lineno=3)
instr.set("NOP")
self.assertEqual(instr.name, "NOP")
self.assertIs(instr.arg, UNSET)
self.assertEqual(instr.lineno, 3)
instr.set("LOAD_FAST", 8)
self.assertEqual(instr.name, "LOAD_FAST")
self.assertEqual(instr.arg, 8)
self.assertEqual(instr.lineno, 3)
# invalid
with self.assertRaises(ValueError):
instr.set("LOAD_CONST")
with self.assertRaises(ValueError):
instr.set("NOP", 5)
def test_set_attr(self):
instr = ConcreteInstr("LOAD_CONST", 5, lineno=12)
# operator name
instr.name = "LOAD_FAST"
self.assertEqual(instr.name, "LOAD_FAST")
self.assertEqual(instr.opcode, opcode.opmap["LOAD_FAST"])
self.assertRaises(TypeError, setattr, instr, "name", 3)
self.assertRaises(ValueError, setattr, instr, "name", "xxx")
# operator code
instr.opcode = opcode.opmap["LOAD_CONST"]
self.assertEqual(instr.name, "LOAD_CONST")
self.assertEqual(instr.opcode, opcode.opmap["LOAD_CONST"])
self.assertRaises(ValueError, setattr, instr, "opcode", -12)
self.assertRaises(TypeError, setattr, instr, "opcode", "abc")
# extended argument
instr.arg = 0x1234ABCD
self.assertEqual(instr.arg, 0x1234ABCD)
self.assertEqual(instr.size, 8)
# small argument
instr.arg = 0
self.assertEqual(instr.arg, 0)
self.assertEqual(instr.size, 2)
# invalid argument
self.assertRaises(ValueError, setattr, instr, "arg", -1)
self.assertRaises(ValueError, setattr, instr, "arg", 2147483647 + 1)
# size attribute is read-only
self.assertRaises(AttributeError, setattr, instr, "size", 3)
# lineno
instr.lineno = 33
self.assertEqual(instr.lineno, 33)
self.assertRaises(TypeError, setattr, instr, "lineno", 1.0)
self.assertRaises(ValueError, setattr, instr, "lineno", -1)
def test_size(self):
self.assertEqual(ConcreteInstr("LOAD_CONST", 3).size, 2)
self.assertEqual(ConcreteInstr("LOAD_CONST", 0x1234ABCD).size, 8)
def test_disassemble(self):
code = bytes((opcode.opmap["NOP"], 0, opcode.opmap["LOAD_CONST"], 3))
instr = ConcreteInstr.disassemble(1, code, 0)
self.assertEqual(instr, ConcreteInstr("NOP", lineno=1))
instr = ConcreteInstr.disassemble(2, code, 1 if OFFSET_AS_INSTRUCTION else 2)
self.assertEqual(instr, ConcreteInstr("LOAD_CONST", 3, lineno=2))
code = bytes(
(
opcode.EXTENDED_ARG,
0x12,
opcode.EXTENDED_ARG,
0x34,
opcode.EXTENDED_ARG,
0xAB,
instr.opcode,
0xCD,
)
)
instr = ConcreteInstr.disassemble(3, code, 0)
self.assertEqual(instr, ConcreteInstr("EXTENDED_ARG", 0x12, lineno=3))
def test_assemble(self):
instr = ConcreteInstr("NOP")
self.assertEqual(instr.assemble(), bytes((instr.opcode, 0)))
instr = ConcreteInstr("LOAD_CONST", 3)
self.assertEqual(instr.assemble(), bytes((instr.opcode, 3)))
instr = ConcreteInstr("LOAD_CONST", 0x1234ABCD)
self.assertEqual(
instr.assemble(),
bytes(
(
opcode.EXTENDED_ARG,
0x12,
opcode.EXTENDED_ARG,
0x34,
opcode.EXTENDED_ARG,
0xAB,
instr.opcode,
0xCD,
)
),
)
instr = ConcreteInstr("LOAD_CONST", 3, extended_args=1)
self.assertEqual(
instr.assemble(),
bytes((opcode.EXTENDED_ARG, 0, instr.opcode, 3)),
)
def test_get_jump_target(self):
if sys.version_info < (3, 11):
jump_abs = ConcreteInstr("JUMP_ABSOLUTE", 3)
self.assertEqual(jump_abs.get_jump_target(100), 3)
jump_forward = ConcreteInstr("JUMP_FORWARD", 5)
self.assertEqual(
jump_forward.get_jump_target(10), 16 if OFFSET_AS_INSTRUCTION else 17
)
class ConcreteBytecodeTests(TestCase):
def test_repr(self):
r = repr(ConcreteBytecode())
self.assertIn("ConcreteBytecode", r)
self.assertIn("0", r)
def test_exception_table_repr(self):
t = ExceptionTableEntry(0, 1, 2, 3, True)
self.assertSequenceEqual(
repr(t),
(
"ExceptionTableEntry("
"start_offset=0, "
"stop_offset=1, "
"target=2, "
"stack_depth=3, "
"push_lasti=True"
),
)
def test_eq(self):
code = ConcreteBytecode()
self.assertFalse(code == 1)
for name, val in (
("names", ["a"]),
("varnames", ["a"]),
("consts", [1]),
("argcount", 1),
("kwonlyargcount", 2),
("flags", CompilerFlags(CompilerFlags.GENERATOR)),
("first_lineno", 10),
("filename", "xxxx.py"),
("name", "__x"),
("docstring", "x-x-x"),
("cellvars", [CellVar("x")]),
("freevars", [FreeVar("x")]),
):
c = ConcreteBytecode()
setattr(c, name, val)
# For obscure reasons using assertNotEqual here fail
self.assertFalse(code == c)
c = ConcreteBytecode()
c.posonlyargcount = 10
self.assertFalse(code == c)
c = ConcreteBytecode()
c.consts = [1]
code.consts = [1]
c.append(ConcreteInstr("LOAD_CONST", 0))
self.assertFalse(code == c)
def test_attr(self):
code_obj = get_code("x = 5")
code = ConcreteBytecode.from_code(code_obj)
self.assertEqual(code.consts, [5, None])
self.assertEqual(code.names, ["x"])
self.assertEqual(code.varnames, [])
self.assertEqual(code.freevars, [])
self.assertInstructionListEqual(
list(code),
(
[ConcreteInstr("RESUME", 0, lineno=0)]
if sys.version_info >= (3, 11)
else []
)
+ [
ConcreteInstr("LOAD_CONST", 0, lineno=1),
ConcreteInstr("STORE_NAME", 0, lineno=1),
]
+ (
[ConcreteInstr("RETURN_CONST", 1, lineno=1)]
if sys.version_info >= (3, 12)
else [
ConcreteInstr("LOAD_CONST", 1, lineno=1),
ConcreteInstr("RETURN_VALUE", lineno=1),
]
),
)
# FIXME: test other attributes
def test_invalid_types(self):
code = ConcreteBytecode()
code.append(Label())
with self.assertRaises(ValueError):
list(code)
with self.assertRaises(ValueError):
code.legalize()
with self.assertRaises(ValueError):
ConcreteBytecode([Label()])
def test_to_code_lnotab(self):
# We use an actual function for the simple case to
# ensure we get lnotab right
def f():
#
#
x = 7 # noqa
y = 8 # noqa
z = 9 # noqa
fl = f.__code__.co_firstlineno
concrete = ConcreteBytecode()
concrete.consts = [None, 7, 8, 9]
concrete.varnames = ["x", "y", "z"]
concrete.first_lineno = fl
concrete.extend(
(
[ConcreteInstr("RESUME", 0), SetLineno(1)]
if sys.version_info >= (3, 11)
else []
)
+ [
SetLineno(fl + 3),
ConcreteInstr("LOAD_CONST", 1),
ConcreteInstr("STORE_FAST", 0),
SetLineno(fl + 4),
ConcreteInstr("LOAD_CONST", 2),
ConcreteInstr("STORE_FAST", 1),
SetLineno(fl + 5),
ConcreteInstr("LOAD_CONST", 3),
ConcreteInstr("STORE_FAST", 2),
]
+ (
[ConcreteInstr("RETURN_CONST", 0)]
if sys.version_info >= (3, 12)
else [
ConcreteInstr("LOAD_CONST", 0),
ConcreteInstr("RETURN_VALUE"),
]
)
)
code = concrete.to_code()
self.assertSequenceEqual(code.co_code, f.__code__.co_code)
if sys.version_info >= (3, 11):
# Offset cannot be right so only check the lines
self.assertSequenceEqual(
list(dis.findlinestarts(code)), list(dis.findlinestarts(f.__code__))
)
else:
self.assertEqual(code.co_lnotab, f.__code__.co_lnotab)
if sys.version_info >= (3, 10):
self.assertEqual(code.co_linetable, f.__code__.co_linetable)
def test_negative_lnotab(self):
# x = 7
# y = 8
concrete = ConcreteBytecode(
[
ConcreteInstr("LOAD_CONST", 0),
ConcreteInstr("STORE_NAME", 0),
# line number goes backward!
SetLineno(2),
ConcreteInstr("LOAD_CONST", 1),
ConcreteInstr("STORE_NAME", 1),
]
)
concrete.consts = [7, 8]
concrete.names = ["x", "y"]
concrete.first_lineno = 5
code = concrete.to_code()
expected = bytes(
(
opcode.opmap["LOAD_CONST"],
0,
opcode.opmap["STORE_NAME"],
0,
opcode.opmap["LOAD_CONST"],
1,
opcode.opmap["STORE_NAME"],
1,
)
)
self.assertEqual(code.co_code, expected)
self.assertEqual(code.co_firstlineno, 5)
if sys.version_info >= (3, 12):
self.skipTest("lnotab is deprecated in Python 3.12+")
self.assertEqual(code.co_lnotab, b"\x04\xfd")
def test_extended_lnotab(self):
# x = 7
# 200 blank lines
# y = 8
concrete = ConcreteBytecode(
[
ConcreteInstr("LOAD_CONST", 0),
SetLineno(1 + 128),
ConcreteInstr("STORE_NAME", 0),
# line number goes backward!
SetLineno(1 + 129),
ConcreteInstr("LOAD_CONST", 1),
SetLineno(1),
ConcreteInstr("STORE_NAME", 1),
]
)
concrete.consts = [7, 8]
concrete.names = ["x", "y"]
concrete.first_lineno = 1
code = concrete.to_code()
expected = bytes(
(
opcode.opmap["LOAD_CONST"],
0,
opcode.opmap["STORE_NAME"],
0,
opcode.opmap["LOAD_CONST"],
1,
opcode.opmap["STORE_NAME"],
1,
)
)
self.assertEqual(code.co_code, expected)
self.assertEqual(code.co_firstlineno, 1)
if sys.version_info >= (3, 11):
self.assertSequenceEqual(
list(code.co_positions()),
[
(1, 1, None, None),
(129, 129, None, None),
(130, 130, None, None),
(1, 1, None, None),
],
)
else:
self.assertEqual(
code.co_lnotab, b"\x02\x7f\x00\x01\x02\x01\x02\x80\x00\xff"
)
def test_extended_lnotab2(self):
# x = 7
# 200 blank lines
# y = 8
base_code = compile("x = 7" + "\n" * 200 + "y = 8", "", "exec")
concrete = ConcreteBytecode(
(
[ConcreteInstr("RESUME", 0, lineno=0), SetLineno(1)]
if sys.version_info >= (3, 11)
else []
)
+ [
ConcreteInstr("LOAD_CONST", 0),
ConcreteInstr("STORE_NAME", 0),
SetLineno(201),
ConcreteInstr("LOAD_CONST", 1),
ConcreteInstr("STORE_NAME", 1),
]
+ (
[ConcreteInstr("RETURN_CONST", 2)]
if sys.version_info >= (3, 12)
else [
ConcreteInstr("LOAD_CONST", 2),
ConcreteInstr("RETURN_VALUE"),
]
)
)
concrete.consts = [None, 7, 8]
concrete.names = ["x", "y"]
concrete.first_lineno = 1
code = concrete.to_code()
self.assertSequenceEqual(code.co_code, base_code.co_code)
self.assertEqual(code.co_firstlineno, base_code.co_firstlineno)
if sys.version_info >= (3, 11):
# Offset cannot be right so only check the lines
self.assertSequenceEqual(
list(dis.findlinestarts(code)), list(dis.findlinestarts(base_code))
)
else:
self.assertSequenceEqual(code.co_lnotab, base_code.co_lnotab)
if sys.version_info >= (3, 10):
self.assertSequenceEqual(code.co_linetable, base_code.co_linetable)
def test_to_bytecode_consts(self):
# x = -0.0
# x = +0.0
#
# code optimized by the CPython 3.6 peephole optimizer which emits
# duplicated constants (0.0 is twice in consts).
code = ConcreteBytecode()
code.consts = [0.0, None, -0.0, 0.0]
code.names = ["x", "y"]
code.extend(
[
ConcreteInstr("LOAD_CONST", 2, lineno=1),
ConcreteInstr("STORE_NAME", 0, lineno=1),
ConcreteInstr("LOAD_CONST", 3, lineno=2),
ConcreteInstr("STORE_NAME", 1, lineno=2),
ConcreteInstr("LOAD_CONST", 1, lineno=2),
ConcreteInstr("RETURN_VALUE", lineno=2),
]
)
code = code.to_bytecode().to_concrete_bytecode()
# the conversion changes the constant order: the order comes from
# the order of LOAD_CONST instructions
self.assertEqual(code.consts, [-0.0, 0.0, None])
code.names = ["x", "y"]
self.assertListEqual(
list(code),
[
ConcreteInstr("LOAD_CONST", 0, lineno=1),
ConcreteInstr("STORE_NAME", 0, lineno=1),
ConcreteInstr("LOAD_CONST", 1, lineno=2),
ConcreteInstr("STORE_NAME", 1, lineno=2),
ConcreteInstr("LOAD_CONST", 2, lineno=2),
ConcreteInstr("RETURN_VALUE", lineno=2),
],
)
def test_cellvar(self):
concrete = ConcreteBytecode()
concrete.cellvars = ["x"]
concrete.append(ConcreteInstr("LOAD_DEREF", 0))
code = concrete.to_code()
concrete = ConcreteBytecode.from_code(code)
self.assertEqual(concrete.cellvars, ["x"])
self.assertEqual(concrete.freevars, [])
self.assertInstructionListEqual(
list(concrete), [ConcreteInstr("LOAD_DEREF", 0, lineno=1)]
)
bytecode = concrete.to_bytecode()
self.assertEqual(bytecode.cellvars, ["x"])
self.assertInstructionListEqual(
list(bytecode), [Instr("LOAD_DEREF", CellVar("x"), lineno=1)]
)
def test_freevar(self):
concrete = ConcreteBytecode()
concrete.freevars = ["x"]
concrete.append(ConcreteInstr("LOAD_DEREF", 0))
code = concrete.to_code()
concrete = ConcreteBytecode.from_code(code)
self.assertEqual(concrete.cellvars, [])
self.assertEqual(concrete.freevars, ["x"])
self.assertInstructionListEqual(
list(concrete), [ConcreteInstr("LOAD_DEREF", 0, lineno=1)]
)
bytecode = concrete.to_bytecode()
self.assertEqual(bytecode.cellvars, [])
self.assertInstructionListEqual(
list(bytecode), [Instr("LOAD_DEREF", FreeVar("x"), lineno=1)]
)
def test_cellvar_freevar(self):
concrete = ConcreteBytecode()
concrete.cellvars = ["cell"]
concrete.freevars = ["free"]
concrete.append(ConcreteInstr("LOAD_DEREF", 0))
concrete.append(ConcreteInstr("LOAD_DEREF", 1))
code = concrete.to_code()
concrete = ConcreteBytecode.from_code(code)
self.assertEqual(concrete.cellvars, ["cell"])
self.assertEqual(concrete.freevars, ["free"])
self.assertInstructionListEqual(
list(concrete),
[
ConcreteInstr("LOAD_DEREF", 0, lineno=1),
ConcreteInstr("LOAD_DEREF", 1, lineno=1),
],
)
bytecode = concrete.to_bytecode()
self.assertEqual(bytecode.cellvars, ["cell"])
self.assertInstructionListEqual(
list(bytecode),
[
Instr("LOAD_DEREF", CellVar("cell"), lineno=1),
Instr("LOAD_DEREF", FreeVar("free"), lineno=1),
],
)
def test_load_classderef(self):
i_name = (
"LOAD_FROM_DICT_OR_DEREF"
if sys.version_info >= (3, 12)
else "LOAD_CLASSDEREF"
)
i_arg = 2 if sys.version_info >= (3, 11) else 1
concrete = ConcreteBytecode()
concrete.varnames = ["a"]
concrete.cellvars = ["__class__"]
concrete.freevars = ["__class__"]
concrete.extend(
[
ConcreteInstr("LOAD_FAST", 0, lineno=1),
ConcreteInstr(i_name, i_arg, lineno=1),
ConcreteInstr("STORE_DEREF", i_arg, lineno=1),
]
)
bytecode = concrete.to_bytecode()
self.assertEqual(bytecode.freevars, ["__class__"])
self.assertEqual(bytecode.cellvars, ["__class__"])
self.assertInstructionListEqual(
list(bytecode),
[
Instr("LOAD_FAST", "a", lineno=1),
Instr(i_name, FreeVar("__class__"), lineno=1),
Instr("STORE_DEREF", FreeVar("__class__"), lineno=1),
],
)
concrete = bytecode.to_concrete_bytecode()
self.assertEqual(concrete.freevars, ["__class__"])
self.assertEqual(concrete.cellvars, ["__class__"])
self.assertInstructionListEqual(
list(concrete),
[
ConcreteInstr("LOAD_FAST", 1, lineno=1),
ConcreteInstr(i_name, i_arg, lineno=1),
ConcreteInstr("STORE_DEREF", i_arg, lineno=1),
],
)
code = concrete.to_code()
self.assertEqual(code.co_freevars, ("__class__",))
self.assertEqual(code.co_cellvars, ("__class__",))
self.assertEqual(
code.co_code,
bytes(
[
opcode.opmap["LOAD_FAST"],
0,
opcode.opmap[i_name],
i_arg,
opcode.opmap["STORE_DEREF"],
i_arg,
]
),
)
def test_explicit_stacksize(self):
# Passing stacksize=... to ConcreteBytecode.to_code should result in a
# code object with the specified stacksize. We pass some silly values
# and assert that they are honored.
code_obj = get_code("print('%s' % (a,b,c))")
original_stacksize = code_obj.co_stacksize
concrete = ConcreteBytecode.from_code(code_obj)
# First with something bigger than necessary.
explicit_stacksize = original_stacksize + 42
new_code_obj = concrete.to_code(
stacksize=explicit_stacksize, compute_exception_stack_depths=False
)
self.assertEqual(new_code_obj.co_stacksize, explicit_stacksize)
# Then with something bogus. We probably don't want to advertise this
# in the documentation. If this fails then decide if it's for good
# reason, and remove if so.
explicit_stacksize = code_obj.co_stacksize - 1
new_code_obj = concrete.to_code(
stacksize=explicit_stacksize, compute_exception_stack_depths=False
)
self.assertEqual(new_code_obj.co_stacksize, explicit_stacksize)
def test_legalize(self):
concrete = ConcreteBytecode()
concrete.first_lineno = 3
concrete.consts = [7, 8, 9]
concrete.names = ["x", "y", "z"]
concrete.extend(
[
ConcreteInstr("LOAD_CONST", 0),
ConcreteInstr("STORE_NAME", 0),
ConcreteInstr("LOAD_CONST", 1, lineno=4),
ConcreteInstr("STORE_NAME", 1),
SetLineno(5),
ConcreteInstr("LOAD_CONST", 2, lineno=6),
ConcreteInstr("STORE_NAME", 2),
]
)
concrete.legalize()
self.assertInstructionListEqual(
list(concrete),
[
ConcreteInstr("LOAD_CONST", 0, lineno=3),
ConcreteInstr("STORE_NAME", 0, lineno=3),
ConcreteInstr("LOAD_CONST", 1, lineno=4),
ConcreteInstr("STORE_NAME", 1, lineno=4),
ConcreteInstr("LOAD_CONST", 2, lineno=5),
ConcreteInstr("STORE_NAME", 2, lineno=5),
],
)
def test_slice(self):
concrete = ConcreteBytecode()
concrete.first_lineno = 3
concrete.consts = [7, 8, 9]
concrete.names = ["x", "y", "z"]
concrete.extend(
[
ConcreteInstr("LOAD_CONST", 0),
ConcreteInstr("STORE_NAME", 0),
SetLineno(4),
ConcreteInstr("LOAD_CONST", 1),
ConcreteInstr("STORE_NAME", 1),
SetLineno(5),
ConcreteInstr("LOAD_CONST", 2),
ConcreteInstr("STORE_NAME", 2),
]
)
self.assertInstructionListEqual(concrete, concrete[:])
def test_copy(self):
concrete = ConcreteBytecode()
concrete.first_lineno = 3
concrete.consts = [7, 8, 9]
concrete.names = ["x", "y", "z"]
concrete.extend(
[
ConcreteInstr("LOAD_CONST", 0),
ConcreteInstr("STORE_NAME", 0),
SetLineno(4),
ConcreteInstr("LOAD_CONST", 1),
ConcreteInstr("STORE_NAME", 1),
SetLineno(5),
ConcreteInstr("LOAD_CONST", 2),
ConcreteInstr("STORE_NAME", 2),
]
)
self.assertInstructionListEqual(concrete, concrete.copy())
def test_encode_varint(self):
self.assertListEqual(list(ConcreteBytecode._encode_varint(0)), [0])
self.assertListEqual(list(ConcreteBytecode._encode_varint(0, True)), [128])
self.assertListEqual(list(ConcreteBytecode._encode_varint(64, False)), [65, 0])
class ConcreteFromCodeTests(TestCase):
def test_extended_arg(self):
# Create a code object from arbitrary bytecode
co_code = b"\x90\x12\x904\x90\xabd\xcd"
code = get_code("x=1")
if sys.version_info >= (3, 11):
self.skipTest("Under Python 3.11 we cannot easily disassemble invalid code")
else:
args = (
code.co_argcount,
code.co_posonlyargcount,
code.co_kwonlyargcount,
code.co_nlocals,
code.co_stacksize,
code.co_flags,
co_code,
code.co_consts,
code.co_names,
code.co_varnames,
code.co_filename,
code.co_name,
code.co_firstlineno,
code.co_linetable if sys.version_info >= (3, 10) else code.co_lnotab,
code.co_freevars,
code.co_cellvars,
)
new_code = types.CodeType(*args)
# without EXTENDED_ARG opcode
bytecode = ConcreteBytecode.from_code(new_code)
self.assertInstructionListEqual(
list(bytecode), [ConcreteInstr("LOAD_CONST", 0x1234ABCD, lineno=1)]
)
# with EXTENDED_ARG opcode
bytecode = ConcreteBytecode.from_code(new_code, extended_arg=True)
expected = [
ConcreteInstr("EXTENDED_ARG", 0x12, lineno=1),
ConcreteInstr("EXTENDED_ARG", 0x34, lineno=1),
ConcreteInstr("EXTENDED_ARG", 0xAB, lineno=1),
ConcreteInstr("LOAD_CONST", 0xCD, lineno=1),
]
self.assertInstructionListEqual(list(bytecode), expected)
def test_extended_arg_make_function(self):
if (3, 9) <= sys.version_info < (3, 10):
from .util_annotation import get_code as get_code_future
code_obj = get_code_future(
"""
def foo(x: int, y: int):
pass
"""
)
else:
code_obj = get_code(
"""
def foo(x: int, y: int):
pass
"""
)
# without EXTENDED_ARG
concrete = ConcreteBytecode.from_code(code_obj)
if sys.version_info >= (3, 11):
func_code = concrete.consts[2]
names = ["int", "foo"]
consts = ["x", "y", func_code, None]
const_offset = 1
name_offset = 1
first_instrs = [
ConcreteInstr("LOAD_CONST", 0, lineno=1),
ConcreteInstr("LOAD_NAME", 0, lineno=1),
ConcreteInstr("LOAD_CONST", 1, lineno=1),
ConcreteInstr("LOAD_NAME", 0, lineno=1),
ConcreteInstr("BUILD_TUPLE", 4, lineno=1),
]
elif sys.version_info >= (3, 10):
func_code = concrete.consts[2]
names = ["int", "foo"]
consts = ["x", "y", func_code, "foo", None]
const_offset = 1
name_offset = 1
first_instrs = [
ConcreteInstr("LOAD_CONST", 0, lineno=1),
ConcreteInstr("LOAD_NAME", 0, lineno=1),
ConcreteInstr("LOAD_CONST", 1, lineno=1),
ConcreteInstr("LOAD_NAME", 0, lineno=1),
ConcreteInstr("BUILD_TUPLE", 4, lineno=1),
]
elif (
sys.version_info >= (3, 7)
and concrete.flags & CompilerFlags.FUTURE_ANNOTATIONS
):
func_code = concrete.consts[2]
names = ["foo"]
consts = ["int", ("x", "y"), func_code, "foo", None]
const_offset = 1
name_offset = 0
first_instrs = [
ConcreteInstr("LOAD_CONST", 0, lineno=1),
ConcreteInstr("LOAD_CONST", 0, lineno=1),
ConcreteInstr("LOAD_CONST", 0 + const_offset, lineno=1),
ConcreteInstr("BUILD_CONST_KEY_MAP", 2, lineno=1),
]
else:
func_code = concrete.consts[1]
names = ["int", "foo"]
consts = [("x", "y"), func_code, "foo", None]
const_offset = 0
name_offset = 1
first_instrs = [
ConcreteInstr("LOAD_NAME", 0, lineno=1),
ConcreteInstr("LOAD_NAME", 0, lineno=1),
ConcreteInstr("LOAD_CONST", 0 + const_offset, lineno=1),
ConcreteInstr("BUILD_CONST_KEY_MAP", 2, lineno=1),
]
self.assertSequenceEqual(concrete.names, names)
self.assertSequenceEqual(concrete.consts, consts)
expected = (
first_instrs
+ [
ConcreteInstr("LOAD_CONST", 1 + const_offset, lineno=1),
ConcreteInstr("LOAD_CONST", 2 + const_offset, lineno=1),
*(
[
ConcreteInstr("MAKE_FUNCTION", lineno=1),
ConcreteInstr("SET_FUNCTION_ATTRIBUTE", 4, lineno=1),
]
if PY313
else [ConcreteInstr("MAKE_FUNCTION", 4, lineno=1)]
),
ConcreteInstr("STORE_NAME", name_offset, lineno=1),
]
+ (
[ConcreteInstr("RETURN_CONST", 3 + const_offset, lineno=1)]
if sys.version_info >= (3, 12)
else [
ConcreteInstr("LOAD_CONST", 3 + const_offset, lineno=1),
ConcreteInstr("RETURN_VALUE", lineno=1),
]
)
)
self.assertInstructionListEqual(list(concrete), expected)
# with EXTENDED_ARG
concrete = ConcreteBytecode.from_code(code_obj, extended_arg=True)
# With future annotation the int annotation is stringified and
# stored as constant this the default behavior under Python 3.10
if sys.version_info >= (3, 11):
func_code = concrete.consts[2]
names = ["int", "foo"]
consts = ["x", "y", func_code, None]
elif sys.version_info >= (3, 10):
func_code = concrete.consts[2]
names = ["int", "foo"]
consts = ["x", "y", func_code, "foo", None]
elif concrete.flags & CompilerFlags.FUTURE_ANNOTATIONS:
func_code = concrete.consts[2]
names = ["foo"]
consts = ["int", ("x", "y"), func_code, "foo", None]
else:
func_code = concrete.consts[1]
names = ["int", "foo"]
consts = [("x", "y"), func_code, "foo", None]
self.assertEqual(concrete.names, names)
self.assertEqual(concrete.consts, consts)
self.assertInstructionListEqual(list(concrete), expected)
# Ensure that concrete._remove_extended_args can handle extended_arg NOPs that get
# passed in from other to_code/from_code methods.
def test_extended_arg_nop(self):
constants = [None] * (0x000129 + 1)
constants[0x000129] = "Arbitrary String"
# EXTENDED_ARG 0x01, NOP 0xFF, EXTENDED_ARG 0x01,
# LOAD_CONST 0x29, RETURN_VALUE 0x00
codestring = bytes(
[
opcode.EXTENDED_ARG,
0x01,
opcode.opmap["NOP"],
0xFF,
opcode.EXTENDED_ARG,
0x01,
opcode.opmap["LOAD_CONST"],
0x29,
opcode.opmap["RETURN_VALUE"],
0x00,
]
)
codetype_list = [
0,
0,
0,
1,
64,
codestring,
tuple(constants),
(),
(),
"<no file>",
"code",
1,
b"",
(),
(),
]
if sys.version_info >= (3, 8):
codetype_list.insert(1, 0)
if sys.version_info >= (3, 11):
codetype_list.insert(12, "code")
codetype_list.insert(14, bytes())
codetype_args = tuple(codetype_list)
code = types.CodeType(*codetype_args)
# Check it can be encoded and decoded
codetype_output = Bytecode.from_code(code).to_code().co_consts
code = ConcreteBytecode()
code.consts = constants
code.extend(
[
ConcreteInstr("EXTENDED_ARG", 0x01),
ConcreteInstr("NOP"),
ConcreteInstr("EXTENDED_ARG", 0x01),
ConcreteInstr("LOAD_CONST", 0x29),
ConcreteInstr("RETURN_VALUE"),
]
)
concrete_output = ConcreteBytecode.to_code(code).co_consts
self.assertEqual(codetype_output, concrete_output)
# The next three tests ensure we can round trip ConcreteBytecode generated
# with extended_args=True
def test_extended_arg_unpack_ex(self):
def test():
p = [1, 2, 3, 4, 5, 6]
q, r, *s, t = p
return q, r, s, t
cpython_stacksize = test.__code__.co_stacksize
test.__code__ = ConcreteBytecode.from_code(
test.__code__, extended_arg=True
).to_code()
self.assertEqual(test.__code__.co_stacksize, cpython_stacksize)
self.assertEqual(test(), (1, 2, [3, 4, 5], 6))
def test_expected_arg_with_many_consts(self):
def test():
var = 0
var = 1
var = 2
var = 3
var = 4
var = 5
var = 6
var = 7
var = 8
var = 9
var = 10
var = 11
var = 12
var = 13
var = 14
var = 15
var = 16
var = 17
var = 18
var = 19
var = 20
var = 21
var = 22
var = 23
var = 24
var = 25
var = 26
var = 27
var = 28
var = 29
var = 30
var = 31
var = 32
var = 33
var = 34
var = 35
var = 36
var = 37
var = 38
var = 39
var = 40
var = 41
var = 42
var = 43
var = 44
var = 45
var = 46
var = 47
var = 48
var = 49
var = 50
var = 51
var = 52
var = 53
var = 54
var = 55
var = 56
var = 57
var = 58
var = 59
var = 60
var = 61
var = 62
var = 63
var = 64
var = 65
var = 66
var = 67
var = 68
var = 69
var = 70
var = 71
var = 72
var = 73
var = 74
var = 75
var = 76
var = 77
var = 78
var = 79
var = 80
var = 81
var = 82
var = 83
var = 84
var = 85
var = 86
var = 87
var = 88
var = 89
var = 90
var = 91
var = 92
var = 93
var = 94
var = 95
var = 96
var = 97
var = 98
var = 99
var = 100
var = 101
var = 102
var = 103
var = 104
var = 105
var = 106
var = 107
var = 108
var = 109
var = 110
var = 111
var = 112
var = 113
var = 114
var = 115
var = 116
var = 117
var = 118
var = 119
var = 120
var = 121
var = 122
var = 123
var = 124
var = 125
var = 126
var = 127
var = 128
var = 129
var = 130
var = 131
var = 132
var = 133
var = 134
var = 135
var = 136
var = 137
var = 138
var = 139
var = 140
var = 141
var = 142
var = 143
var = 144
var = 145
var = 146
var = 147
var = 148
var = 149
var = 150
var = 151
var = 152
var = 153
var = 154
var = 155
var = 156
var = 157
var = 158
var = 159
var = 160
var = 161
var = 162
var = 163
var = 164
var = 165
var = 166
var = 167
var = 168
var = 169
var = 170
var = 171
var = 172
var = 173
var = 174
var = 175
var = 176
var = 177
var = 178
var = 179
var = 180
var = 181
var = 182
var = 183
var = 184
var = 185
var = 186
var = 187
var = 188
var = 189
var = 190
var = 191
var = 192
var = 193
var = 194
var = 195
var = 196
var = 197
var = 198
var = 199
var = 200
var = 201
var = 202
var = 203
var = 204
var = 205
var = 206
var = 207
var = 208
var = 209
var = 210
var = 211
var = 212
var = 213
var = 214
var = 215
var = 216
var = 217
var = 218
var = 219
var = 220
var = 221
var = 222
var = 223
var = 224
var = 225
var = 226
var = 227
var = 228
var = 229
var = 230
var = 231
var = 232
var = 233
var = 234
var = 235
var = 236
var = 237
var = 238
var = 239
var = 240
var = 241
var = 242
var = 243
var = 244
var = 245
var = 246
var = 247
var = 248
var = 249
var = 250
var = 251
var = 252
var = 253
var = 254
var = 255
var = 256
var = 257
var = 258
var = 259
return var
test.__code__ = ConcreteBytecode.from_code(
test.__code__, extended_arg=True
).to_code()
self.assertEqual(test.__code__.co_stacksize, 1)
self.assertEqual(test(), 259)
def test_fail_extended_arg_jump(self):
def test():
var = None
for _ in range(0, 1):
var = 0
var = 1
var = 2
var = 3
var = 4
var = 5
var = 6
var = 7
var = 8
var = 9
var = 10
var = 11
var = 12
var = 13
var = 14
var = 15
var = 16
var = 17
var = 18
var = 19
var = 20
var = 21
var = 22
var = 23
var = 24
var = 25
var = 26
var = 27
var = 28
var = 29
var = 30
var = 31
var = 32
var = 33
var = 34
var = 35
var = 36
var = 37
var = 38
var = 39
var = 40
var = 41
var = 42
var = 43
var = 44
var = 45
var = 46
var = 47
var = 48
var = 49
var = 50
var = 51
var = 52
var = 53
var = 54
var = 55
var = 56
var = 57
var = 58
var = 59
var = 60
var = 61
var = 62
var = 63
var = 64
var = 65
var = 66
var = 67
var = 68
var = 69
var = 70
return var
# Generate the bytecode with extended arguments
bytecode = ConcreteBytecode.from_code(test.__code__, extended_arg=True)
bytecode.to_code()
# XXX add tests for linenumbers which are None
def test_packing_lines(self):
import dis
from .long_lines_example import long_lines
line_starts = list(dis.findlinestarts(long_lines.__code__))
concrete = ConcreteBytecode.from_code(long_lines.__code__)
as_code = concrete.to_code()
self.assertEqual(line_starts, list(dis.findlinestarts(as_code)))
def test_exception_table_round_trip(self):
from . import exception_handling_cases as ehc
for f in ehc.TEST_CASES:
print(f.__name__)
with self.subTest(f.__name__):
origin = f.__code__
concrete = ConcreteBytecode.from_code(f.__code__)
as_code = concrete.to_code(
stacksize=f.__code__.co_stacksize,
compute_exception_stack_depths=False,
)
self.assertCodeObjectEqual(origin, as_code)
f.__code__ = as_code
if inspect.iscoroutinefunction(f):
if sys.version_info >= (3, 10):
asyncio.run(f())
else:
f()
def test_cellvar_freevar_roundtrip(self):
from . import cell_free_vars_cases as cfc
def recompile_code_and_inner(code):
concrete = ConcreteBytecode.from_code(code)
for i, c in enumerate(concrete.consts):
if isinstance(c, types.CodeType):
concrete.consts[i] = recompile_code_and_inner(c)
as_code = concrete.to_code(
stacksize=code.co_stacksize, compute_exception_stack_depths=False
)
self.assertCodeObjectEqual(code, as_code)
return as_code
for f in cfc.TEST_CASES:
print(f.__name__)
with self.subTest(f.__name__):
origin = f.__code__
f.__code__ = recompile_code_and_inner(origin)
while callable(f := f()):
pass
class BytecodeToConcreteTests(TestCase):
def test_label(self):
code = Bytecode()
label = Label()
code.extend(
[
Instr("LOAD_CONST", "hello", lineno=1),
Instr("JUMP_FORWARD", label, lineno=1),
label,
Instr("POP_TOP", lineno=1),
]
)
code = code.to_concrete_bytecode()
expected = [
ConcreteInstr("LOAD_CONST", 0, lineno=1),
ConcreteInstr("JUMP_FORWARD", 0, lineno=1),
ConcreteInstr("POP_TOP", lineno=1),
]
self.assertInstructionListEqual(list(code), expected)
self.assertListEqual(code.consts, ["hello"])
def test_label2(self):
bytecode = Bytecode()
label = Label()
bytecode.extend(
[
Instr("LOAD_NAME", "test", lineno=1),
Instr(
"POP_JUMP_FORWARD_IF_FALSE"
if (3, 12) > sys.version_info >= (3, 11)
else "POP_JUMP_IF_FALSE",
label,
),
Instr("LOAD_CONST", 5, lineno=2),
Instr("STORE_NAME", "x"),
Instr("JUMP_FORWARD", label),
Instr("LOAD_CONST", 7, lineno=4),
Instr("STORE_NAME", "x"),
label,
Instr("LOAD_CONST", None),
Instr("RETURN_VALUE"),
]
)
concrete = bytecode.to_concrete_bytecode()
expected = [
ConcreteInstr("LOAD_NAME", 0, lineno=1),
ConcreteInstr(
"POP_JUMP_FORWARD_IF_FALSE"
if (3, 12) > sys.version_info >= (3, 11)
else "POP_JUMP_IF_FALSE",
7 if OFFSET_AS_INSTRUCTION else 14,
lineno=1,
),
*([ConcreteInstr("CACHE")] if PY313 else []),
ConcreteInstr("LOAD_CONST", 0, lineno=2),
ConcreteInstr("STORE_NAME", 1, lineno=2),
ConcreteInstr("JUMP_FORWARD", 2 if OFFSET_AS_INSTRUCTION else 4, lineno=2),
ConcreteInstr("LOAD_CONST", 1, lineno=4),
ConcreteInstr("STORE_NAME", 1, lineno=4),
ConcreteInstr("LOAD_CONST", 2, lineno=4),
ConcreteInstr("RETURN_VALUE", lineno=4),
]
self.assertInstructionListEqual(list(concrete), expected)
self.assertListEqual(concrete.consts, [5, 7, None])
self.assertListEqual(concrete.names, ["test", "x"])
self.assertListEqual(concrete.varnames, [])
def test_label3(self):
"""
CPython generates useless EXTENDED_ARG 0 in some cases. We need to
properly track them as otherwise we can end up with broken offset for
jumps.
"""
source = """
def func(x):
if x == 1:
return x + 0
elif x == 2:
return x + 1
elif x == 3:
return x + 2
elif x == 4:
return x + 3
elif x == 5:
return x + 4
elif x == 6:
return x + 5
elif x == 7:
return x + 6
elif x == 8:
return x + 7
elif x == 9:
return x + 8
elif x == 10:
return x + 9
elif x == 11:
return x + 10
elif x == 12:
return x + 11
elif x == 13:
return x + 12
elif x == 14:
return x + 13
elif x == 15:
return x + 14
elif x == 16:
return x + 15
elif x == 17:
return x + 16
return -1
"""
code = get_code(source, function=True)
bcode = Bytecode.from_code(code)
concrete = bcode.to_concrete_bytecode()
self.assertIsInstance(concrete, ConcreteBytecode)
# Ensure that we do not generate broken code
loc = {}
exec(textwrap.dedent(source), loc)
func = loc["func"]
func.__code__ = bcode.to_code()
for i, x in enumerate(range(1, 18)):
self.assertEqual(func(x), x + i)
self.assertEqual(func(18), -1)
# Ensure that we properly round trip in such cases
self.assertSequenceEqual(
ConcreteBytecode.from_code(code)
.to_code(stacksize=code.co_stacksize, compute_exception_stack_depths=False)
.co_code,
code.co_code,
)
def test_setlineno(self):
# x = 7
# y = 8
# z = 9
concrete = ConcreteBytecode()
concrete.consts = [7, 8, 9]
concrete.names = ["x", "y", "z"]
concrete.first_lineno = 3
concrete.extend(
[
ConcreteInstr("LOAD_CONST", 0),
ConcreteInstr("STORE_NAME", 0),
SetLineno(4),
ConcreteInstr("LOAD_CONST", 1),
ConcreteInstr("STORE_NAME", 1),
SetLineno(5),
ConcreteInstr("LOAD_CONST", 2),
ConcreteInstr("STORE_NAME", 2),
]
)
code = concrete.to_bytecode()
self.assertInstructionListEqual(
code,
[
Instr("LOAD_CONST", 7, lineno=3),
Instr("STORE_NAME", "x", lineno=3),
Instr("LOAD_CONST", 8, lineno=4),
Instr("STORE_NAME", "y", lineno=4),
Instr("LOAD_CONST", 9, lineno=5),
Instr("STORE_NAME", "z", lineno=5),
],
)
def test_extended_jump(self):
# code using jumps > 0xffff to test extended arg
nb_nop = 2**16 if OFFSET_AS_INSTRUCTION else 2**15
# The length of the jump is independent of the number of instruction
# per the above logic.
jump = 2**16
code = ConcreteBytecode(
[ConcreteInstr("JUMP_FORWARD", jump)]
+ [ConcreteInstr("NOP")] * nb_nop
+ [
ConcreteInstr("LOAD_CONST", 0),
ConcreteInstr("RETURN_VALUE"),
],
consts=(None,),
)
code_obj = code.to_code()
# We use 2 extended args out of the maximum 3 which are allowed
expected = bytes(
(
opcode.EXTENDED_ARG,
1,
opcode.EXTENDED_ARG,
0,
opcode.opmap["JUMP_FORWARD"],
0,
*([opcode.opmap["NOP"], 0] * nb_nop),
opcode.opmap["LOAD_CONST"],
0,
opcode.opmap["RETURN_VALUE"],
0,
)
)
self.assertSequenceEqual(code_obj.co_code, expected)
def test_jumps(self):
# if test:
# x = 12
# else:
# x = 37
code = Bytecode()
label_else = Label()
label_return = Label()
code.extend(
[
Instr("LOAD_NAME", "test", lineno=1),
Instr(
"POP_JUMP_FORWARD_IF_FALSE"
if (3, 12) > sys.version_info >= (3, 11)
else "POP_JUMP_IF_FALSE",
label_else,
),
Instr("LOAD_CONST", 12, lineno=2),
Instr("STORE_NAME", "x"),
Instr("JUMP_FORWARD", label_return),
label_else,
Instr("LOAD_CONST", 37, lineno=4),
Instr("STORE_NAME", "x"),
label_return,
Instr("LOAD_CONST", None, lineno=4),
Instr("RETURN_VALUE"),
]
)
code = code.to_concrete_bytecode()
expected = [
ConcreteInstr("LOAD_NAME", 0, lineno=1),
ConcreteInstr(
"POP_JUMP_FORWARD_IF_FALSE"
if (3, 12) > sys.version_info >= (3, 11)
else "POP_JUMP_IF_FALSE",
5 if OFFSET_AS_INSTRUCTION else 10,
lineno=1,
),
*([ConcreteInstr("CACHE")] if PY313 else []),
ConcreteInstr("LOAD_CONST", 0, lineno=2),
ConcreteInstr("STORE_NAME", 1, lineno=2),
ConcreteInstr("JUMP_FORWARD", 2 if OFFSET_AS_INSTRUCTION else 4, lineno=2),
ConcreteInstr("LOAD_CONST", 1, lineno=4),
ConcreteInstr("STORE_NAME", 1, lineno=4),
ConcreteInstr("LOAD_CONST", 2, lineno=4),
ConcreteInstr("RETURN_VALUE", lineno=4),
]
self.assertInstructionListEqual(list(code), expected)
self.assertListEqual(code.consts, [12, 37, None])
self.assertListEqual(code.names, ["test", "x"])
self.assertListEqual(code.varnames, [])
def test_dont_merge_constants(self):
# test two constants which are equal but have a different type
code = Bytecode()
code.extend(
[
Instr("LOAD_CONST", 5, lineno=1),
Instr("LOAD_CONST", 5.0, lineno=1),
Instr("LOAD_CONST", -0.0, lineno=1),
Instr("LOAD_CONST", +0.0, lineno=1),
]
)
code = code.to_concrete_bytecode()
expected = [
ConcreteInstr("LOAD_CONST", 0, lineno=1),
ConcreteInstr("LOAD_CONST", 1, lineno=1),
ConcreteInstr("LOAD_CONST", 2, lineno=1),
ConcreteInstr("LOAD_CONST", 3, lineno=1),
]
self.assertInstructionListEqual(list(code), expected)
self.assertListEqual(code.consts, [5, 5.0, -0.0, +0.0])
def test_cellvars(self):
code = Bytecode()
code.cellvars = ["x"]
code.freevars = ["y"]
code.extend(
[
Instr("LOAD_DEREF", CellVar("x"), lineno=1),
Instr("LOAD_DEREF", FreeVar("y"), lineno=1),
]
)
concrete = code.to_concrete_bytecode()
self.assertEqual(concrete.cellvars, ["x"])
self.assertEqual(concrete.freevars, ["y"])
def test_compute_jumps_convergence(self):
# Consider the following sequence of instructions:
#
# JUMP_FORWARD Label1
# JUMP_FORWARD Label2
# ...126 instructions...
# Label1: Offset 254 on first pass, 256 second pass
# NOP
# ... many more instructions ...
# Label2: Offset > 256 on first pass
#
# On first pass of compute_jumps(), Label2 will be at address 254, so
# that value encodes into the single byte arg of JUMP_ABSOLUTE.
#
# On second pass compute_jumps() the instr at Label1 will have offset
# of 256 so will also be given an EXTENDED_ARG.
#
# Thus we need to make an additional pass. This test only verifies
# case where 2 passes is insufficient but three is enough.
#
# On Python > 3.10 we need to double the number since the offset is now
# in term of instructions and not bytes.
# Create code from comment above.
code = Bytecode()
label1 = Label()
label2 = Label()
nop = "NOP"
code.append(Instr("JUMP_FORWARD", label1))
code.append(Instr("JUMP_FORWARD", label2))
# range excludes the last point ...
for _ in range(4, 511 if OFFSET_AS_INSTRUCTION else 255, 2):
code.append(Instr(nop))
code.append(label1)
code.append(Instr(nop))
for _ in range(
514 if OFFSET_AS_INSTRUCTION else 256,
600 if OFFSET_AS_INSTRUCTION else 300,
2,
):
code.append(Instr(nop))
code.append(label2)
code.append(Instr(nop))
# This should pass by default.
code.to_code()
# Try with max of two passes: it should raise
with self.assertRaises(RuntimeError):
code.to_code(compute_jumps_passes=2)
def test_extreme_compute_jumps_convergence(self):
"""Test of compute_jumps() requiring absurd number of passes.
NOTE: This test also serves to demonstrate that there is no worst
case: the number of passes can be unlimited (or, actually, limited by
the size of the provided code).
This is an extension of test_compute_jumps_convergence. Instead of
two jumps, where the earlier gets extended after the latter, we
instead generate a series of many jumps. Each pass of compute_jumps()
extends one more instruction, which in turn causes the one behind it
to be extended on the next pass.
"""
# N: the number of unextended instructions that can be squeezed into a
# set of bytes adressable by the arg of an unextended instruction.
# The answer is "128", but here's how we arrive at it.
max_unextended_offset = 1 << 8
unextended_branch_instr_size = 2
N = max_unextended_offset // unextended_branch_instr_size
# When using instruction rather than bytes in the offset multiply by 2
if OFFSET_AS_INSTRUCTION:
N *= 2
nop = "UNARY_NEGATIVE" # don't use NOP, dis.stack_effect will raise
# The number of jumps will be equal to the number of labels. The
# number of passes of compute_jumps() required will be one greater
# than this.
labels = [Label() for x in range(0, 3 * N)]
code = Bytecode()
code.extend(
Instr("JUMP_FORWARD", labels[len(labels) - x - 1])
for x in range(0, len(labels))
)
end_of_jumps = len(code)
code.extend(Instr(nop) for x in range(0, N))
# Now insert the labels. The first is N instructions (i.e. 256
# bytes) after the last jump. Then they proceed to earlier positions
# 4 bytes at a time. While the targets are in the range of the nop
# instructions, 4 bytes is two instructions. When the targets are in
# the range of JUMP_FORWARD instructions we have to allow for the fact
# that the instructions will have been extended to four bytes each, so
# working backwards 4 bytes per label means just one instruction per
# label.
offset = end_of_jumps + N
for index in range(0, len(labels)):
code.insert(offset, labels[index])
if offset <= end_of_jumps:
offset -= 1
else:
offset -= 2
code.insert(0, Instr("LOAD_CONST", 0))
del end_of_jumps
code.append(Instr("RETURN_VALUE"))
code.to_code(compute_jumps_passes=(len(labels) + 1))
def test_general_constants(self):
"""Test if general object could be linked as constants."""
class CustomObject:
pass
class UnHashableCustomObject:
__hash__ = None
obj1 = [1, 2, 3]
obj2 = {1, 2, 3}
obj3 = CustomObject()
obj4 = UnHashableCustomObject()
code = Bytecode(
[
Instr("LOAD_CONST", obj1, lineno=1),
Instr("LOAD_CONST", obj2, lineno=1),
Instr("LOAD_CONST", obj3, lineno=1),
Instr("LOAD_CONST", obj4, lineno=1),
Instr("BUILD_TUPLE", 4, lineno=1),
Instr("RETURN_VALUE", lineno=1),
]
)
self.assertEqual(code.to_code().co_consts, (obj1, obj2, obj3, obj4))
def f():
return # pragma: no cover
f.__code__ = code.to_code()
self.assertEqual(f(), (obj1, obj2, obj3, obj4))
# FIXME test more cases for line encoding in particular with extended args
@unittest.skipIf(sys.version_info < (3, 13), "Apply only to 3.13+")
def test_handling_dual_opcodes(self):
code = Bytecode()
code.extend(
[
Instr("LOAD_FAST_LOAD_FAST", ("a", "b"), lineno=1),
Instr("LOAD_FAST_LOAD_FAST", ("c", "d"), lineno=1),
Instr("LOAD_FAST_LOAD_FAST", ("e", "f"), lineno=1),
Instr("LOAD_FAST_LOAD_FAST", ("g", "h"), lineno=1),
Instr("LOAD_FAST_LOAD_FAST", ("i", "j"), lineno=1),
Instr("LOAD_FAST_LOAD_FAST", ("k", "l"), lineno=1),
Instr("LOAD_FAST_LOAD_FAST", ("m", "n"), lineno=1),
Instr("LOAD_FAST_LOAD_FAST", ("o", "p"), lineno=1),
Instr("LOAD_FAST_LOAD_FAST", ("q", "r"), lineno=1),
]
)
concrete = code.to_concrete_bytecode()
assert len(concrete) == 10
if __name__ == "__main__":
unittest.main() # pragma: no cover
|