Named tuple support #331

tristanmenzel · 2024-10-18T18:18:31Z

Proposed Changes

Adds support for using native named tuples
Named tuples are automatically encoded as ARC4 Structs when used on ABI boundaries

…tr index

… the same for structs) - introduce pytypes.TupleLikeType that captures both native and ARC4Tuples - make a NamedTupleType subclass of TupleType that exposes a `fields` property which is easier to create & consume - use NamedTuple for pre-compiled data structures - correct implicit arc4 conversion to use iterate_static, which also ensure single evaluation - introduce pytype for NamedTupleBaseType - this is somewhat of a lie, since typing.NamedTuple is not actually part of MRO at runtime due to Python magic, but it's a good lie because it allows resolving expression and type builders for NamedTuple without any hackery - fixing some error messages to start with lower case - expose concrete types on WType and PyType classes, this simplifies some things and Sequence/Mapping was mostly used as shorthand - add some negative tests for NamedTuple scenarios - general refactoring of new NamedTuple feature

github-actions · 2024-10-22T09:06:18Z

Coverage Report

File	Stmts	Miss	Cover	Missing
src/puya_lib
arc4.py	126	126	0%	1–332
bytes.py	9	9	0%	1–15
util.py	16	16	0%	1–33
src/puya
__main__.py	30	30	0%	1–42
arc32.py	68	2	97%	77, 103
artifact_sorter.py	53	1	98%	84
compile.py	147	8	95%	89–90, 132–135, 155–158, 288, 309
context.py	31	1	97%	35
errors.py	35	8	77%	40–42, 44–46, 50–51
log.py	199	41	79%	32–35, 69, 89, 108, 123–124, 166–168, 171–173, 175, 188–197, 219, 288–289, 298, 326–328, 341–355
main.py	36	36	0%	1–49
parse.py	87	5	94%	31, 40, 50, 56, 87
utils.py	199	18	91%	50, 67–68, 77–78, 86–87, 171, 177, 195–197, 204, 226, 249, 251, 274, 309
src/puya/awst
function_traverser.py	285	3	99%	76, 367, 373
nodes.py	988	43	96%	99, 103–106, 146, 150–153, 351, 536, 552, 586, 627, 656–657, 707, 734–735, 884, 906, 938, 964, 969, 1124, 1209, 1225, 1274, 1347, 1418, 1472, 1476, 1722, 1733, 1735, 1740, 1748, 1753, 1758, 1767, 1772, 1777
serialize.py	64	4	94%	24, 95–97
to_code_visitor.py	439	7	98%	131, 315, 365, 621, 646, 674, 678
txn_fields.py	98	1	99%	48
wtypes.py	323	19	94%	170–173, 187–188, 192, 210, 223, 229, 234, 239–240, 274, 328, 342, 392, 463, 514
src/puya/awst/validation
base_invoker.py	47	4	91%	55, 62, 69–73
inner_transactions.py	187	1	99%	160
labels.py	30	8	73%	25–27, 32, 36–41
scratch_slots.py	39	4	90%	19, 33, 49, 51
src/puya/ir
arc4_router.py	283	19	93%	110, 173, 229, 307, 355, 426, 439, 497–498, 510, 515, 520, 525, 530, 535, 555–559, 699, 736
avm_ops.py	315	1	99%	46
avm_ops_models.py	48	3	94%	21, 30, 38
context.py	107	8	93%	78, 85, 88, 90, 128–129, 141, 147
main.py	299	13	96%	74–80, 90–96, 122, 135, 163, 221, 565
models.py	529	22	96%	74, 182, 189, 338, 408–409, 414, 420–424, 437, 481, 510, 566, 612, 692, 708, 749, 752, 759, 762, 851–852
ssa.py	130	5	96%	51–52, 150, 212, 223
to_text_visitor.py	152	7	95%	123, 212, 219–224
types_.py	101	10	90%	50, 57, 91–95, 116, 152, 157–159
visitor.py	129	17	87%	145, 193, 205, 220, 223, 236, 239, 245, 248, 259, 262, 265, 268, 271, 274, 277, 280
visitor_mutator.py	105	2	98%	174–175
vla.py	72	1	99%	87
src/puya/ir/builder
_utils.py	58	3	95%	175–177
arc4.py	530	25	95%	103, 164–169, 449, 474, 477, 535–538, 803–804, 1050, 1074, 1155, 1162, 1198, 1246, 1256, 1311, 1356, 1375, 1395, 1456–1463
assignment.py	83	6	93%	51, 98, 112, 188, 206, 222
blocks.py	140	7	95%	55, 92–96, 158, 166, 231
bytes.py	64	14	78%	13–45, 129
callsub.py	77	5	94%	30–31, 51, 101–102
flow_control.py	95	1	99%	56
iteration.py	198	5	97%	91–92, 107, 144, 206
itxn.py	323	37	89%	139–140, 142, 156, 164–169, 197, 204, 226–227, 560, 579–597, 666, 670, 684, 693–706
main.py	547	65	88%	106, 244, 248, 253–271, 276–294, 349, 373, 397–398, 436, 624, 656, 669–670, 726, 751, 788–790, 801, 866, 944, 957, 990, 1045, 1048, 1056, 1059, 1067, 1096, 1107, 1116, 1195, 1212, 1255–1265
storage.py	83	2	98%	101, 154
src/puya/ir/destructure
coalesce_locals.py	101	19	81%	119, 128–129, 132–135, 138–147, 163–166
parcopy.py	84	2	98%	47, 83
src/puya/ir/optimize
collapse_blocks.py	92	5	95%	65–69
compiled_reference.py	79	5	94%	53, 87, 158–163
control_op_simplification.py	104	7	93%	47–48, 171, 245–252
inner_txn.py	36	1	97%	38
intrinsic_simplification.py	483	31	94%	76, 166–168, 173, 255, 267, 302, 313–314, 338–339, 363, 430, 617, 619, 634, 674, 697, 727, 733, 735, 737, 742, 744, 746, 748, 750, 802–803, 810
main.py	87	2	98%	116–117
src/puya/ir/validation
_base.py	29	1	97%	24
compile_reference_validator.py	20	3	85%	24, 30, 37
min_avm_version_validator.py	11	1	91%	15
op_run_mode_validator.py	19	5	74%	19–29
src/puya/mir
annotaters.py	159	2	99%	62, 212
builder.py	140	10	93%	139, 248–249, 302, 305, 308, 311, 314, 317, 320
models.py	328	15	95%	40, 52, 68, 77, 88, 99, 110, 260, 291, 328, 340, 365–371
output.py	63	2	97%	29, 33
stack.py	250	19	92%	72, 119, 135, 146, 157, 167, 184, 201, 211, 230, 250, 256, 258, 297, 310, 334, 366, 371, 409
src/puya/mir/stack_allocation
baileys.py	205	3	99%	31, 330–334
frame_allocation.py	80	2	98%	21, 68
koopmans.py	61	1	98%	55
peephole.py	100	5	95%	75, 89, 103, 105, 149
src/puya/teal/optimize
peephole.py	112	2	98%	139, 145
repeated_rotations.py	42	1	98%	13
repeated_rotations_search.py	88	6	93%	34, 40–41, 57, 67–68
src/puya/ussemble
build.py	73	10	86%	37, 52–53, 58–61, 65–68, 85–86, 115
op_spec_models.py	22	1	95%	20
optimize.py	76	1	99%	77
output.py	115	1	99%	71
validate.py	17	1	94%	19
src/puyapy
__main__.py	58	16	72%	163–177, 181
client_gen.py	115	15	87%	55–56, 65–69, 73, 165–166, 174–175, 190, 194–195, 204
compile.py	150	22	85%	59–68, 82, 162–163, 174, 181–182, 199–209, 219–221, 226, 242
parse.py	180	13	93%	49–50, 86, 158–163, 167, 265, 269–270, 317, 329, 354
template.py	32	8	75%	10–11, 18–19, 27–28, 34, 37
utils.py	21	5	76%	16–17, 25–28
src/puyapy/awst_build
arc4_client.py	70	19	73%	45, 54, 60, 63, 66, 72, 75, 78–83, 86, 89, 92, 95, 98, 101, 104, 107, 110
arc4_utils.py	324	47	85%	45, 48–49, 51, 92, 104–106, 133, 144–148, 164, 166, 169–170, 193, 234–236, 245, 250, 255–256, 284, 288, 300, 307, 309, 323–324, 327–331, 336–337, 343–346, 354, 372, 384, 395, 403, 510, 515, 534
arc32_client_gen.py	68	2	97%	34, 130
base_mypy_visitor.py	127	39	69%	70–76, 94, 102–115, 129, 131, 133, 145, 150, 154, 157, 160, 166, 188, 191, 194, 201, 205, 208, 211, 215, 233, 237, 241, 245, 249, 253, 257, 261, 265, 269, 273, 277, 281
context.py	233	47	80%	65, 95, 98, 108–109, 127–128, 168, 228, 233, 239–243, 250, 259, 261, 264–266, 268, 275, 277, 288–289, 294–296, 299, 314, 338–339, 351, 365, 368–380
contract.py	238	27	89%	182, 224–225, 227–230, 242, 254, 345, 349, 371, 374, 386, 394, 397, 400, 403, 406, 409, 412, 415, 418, 421, 435, 458–464
contract_data.py	58	1	98%	37
intrinsic_factory.py	32	3	91%	47, 56, 65
intrinsic_models.py	40	1	98%	49
main.py	50	1	98%	33
module.py	413	58	86%	115, 129–131, 146–147, 154, 163–164, 172–176, 194–198, 207, 245–246, 257, 279–282, 292–294, 300, 317–320, 333, 367, 374, 396–397, 420–425, 479–480, 508, 519, 522, 528, 534, 544, 550, 553, 565, 568, 590, 610, 615, 619, 623–626, 652, 700, 720, 728, 730
pytypes.py	527	51	90%	85–87, 101–102, 142, 158–164, 187, 207, 249, 357, 366, 385, 404, 424–425, 464, 557–559, 573–574, 643–644, 750, 761–762, 807–808, 813, 862–863, 884–885, 1014–1015, 1039, 1067, 1101–1103, 1143, 1153–1154, 1190–1192
subroutine.py	603	54	91%	134, 249, 255, 313–316, 322, 374, 381, 384–390, 455, 610, 612–613, 631, 633, 643–644, 653–654, 658, 679, 752, 759, 779–780, 862, 888–889, 906, 922, 946, 954, 965, 990, 1095–1096, 1116, 1126, 1133, 1142, 1158, 1168–1169, 1177, 1196, 1199, 1202, 1205, 1208, 1228–1230
utils.py	184	24	87%	34, 51–55, 73, 108–109, 111, 155–156, 207, 215, 220, 233–237, 242–245, 287, 295, 338
src/puyapy/awst_build/eb
_base.py	131	19	85%	53, 58–60, 65, 72, 77, 82–84, 143, 154, 184, 189, 194, 199, 210, 225, 230–232
_bytes_backed.py	48	2	96%	30–31
_expect.py	122	21	83%	26, 37, 87–90, 102–105, 108, 160–161, 219–222, 232–235
_literals.py	144	29	80%	44, 73, 92, 121, 138, 152, 156, 160–166, 176–190, 195
_type_registry.py	40	4	90%	252–253, 265–266
utils.py	47	3	94%	29–31, 100
array.py	26	9	65%	23, 28–33, 43, 49
biguint.py	96	6	94%	56, 98, 135, 150–151, 153
binary_bool_op.py	104	3	97%	152, 160, 170
bool.py	56	9	84%	39–43, 59, 70, 85, 99
bytes.py	168	18	89%	103–104, 131–132, 137–138, 144–145, 148, 156, 199, 234, 266, 270, 287–288, 303–304
compiled.py	70	9	87%	86–90, 127–131, 154
conditional_literal.py	129	31	76%	100, 104, 164, 168–171, 180–182, 205–208, 217, 221, 225–228, 243–255, 264–265
contracts.py	83	6	93%	58, 64, 76, 101, 122, 126
dict.py	27	5	81%	25, 33–35, 39
ensure_budget.py	31	1	97%	47
interface.py	84	3	96%	311–313, 317
intrinsics.py	97	6	94%	43, 62, 69, 82, 89, 160
log.py	43	4	91%	46–47, 52, 61
logicsig.py	15	1	93%	26
none.py	27	1	96%	38
string.py	144	13	91%	72, 116–117, 136, 140, 183, 190, 194, 206, 280–282, 302
struct.py	16	5	69%	14–16, 25, 31
subroutine.py	80	16	80%	46, 50–53, 68, 71–78, 93, 101–102, 104–107, 112
template_variables.py	37	2	95%	30, 58
tuple.py	305	12	96%	76, 124, 225–226, 238, 324–325, 444, 472, 483–484, 547
uint64.py	110	5	95%	57, 118–119, 167–168
uint64_enums.py	40	2	95%	41, 46
unsigned_builtins.py	155	22	86%	74, 81, 105, 129, 133, 137, 141, 149, 153, 157, 161, 165, 175, 179, 185, 196, 202, 208, 247, 279, 291, 303
src/puyapy/awst_build/eb/arc4
_base.py	91	3	97%	186–189, 200
_utils.py	149	10	93%	102–103, 132, 137, 150, 190–193, 264, 268, 282
abi_call.py	321	20	94%	126, 132, 136, 160, 230, 247–248, 329, 346, 404, 432, 463, 486–487, 545, 582, 654, 739–740, 757
address.py	77	3	96%	57, 117–118
bool.py	57	3	95%	44, 86–87
dynamic_array.py	127	10	92%	57, 126–127, 147, 149, 154, 228, 249, 255–258
dynamic_bytes.py	68	3	96%	97–99
emit.py	36	1	97%	38
static_array.py	66	1	98%	45
string.py	100	7	93%	54–55, 103, 126, 131–134
struct.py	49	1	98%	49
tuple.py	92	16	83%	46–48, 72, 90–93, 96–97, 133–136, 141, 145–146, 156, 166
ufixed.py	70	2	97%	43, 102
src/puyapy/awst_build/eb/reference_types
account.py	81	2	98%	65, 176
application.py	45	1	98%	40
asset.py	65	1	98%	48
src/puyapy/awst_build/eb/storage
_common.py	69	3	96%	107, 122–123
_storage.py	103	18	83%	77, 85, 89, 93, 97, 101, 105, 109, 113, 123, 127, 131, 135, 141, 152, 158, 164, 176
_value_proxy.py	55	7	87%	38, 42, 50, 54, 91, 99, 103
box_map.py	143	1	99%	186
global_state.py	138	5	96%	108–109, 115, 171–172
local_state.py	148	11	93%	103–104, 108, 157, 161, 165, 175, 179, 203, 290, 314
src/puyapy/awst_build/eb/transaction
base.py	39	2	95%	23, 43
group.py	58	1	98%	51
inner.py	49	2	96%	89–90
inner_params.py	81	5	94%	69, 79, 83, 143, 145
itxn_args.py	60	1	98%	72
TOTAL	21677	1697	92%

Tests	Skipped	Failures	Errors	Time
1298	2 💤	0 ❌	0 🔥	7m 29s ⏱️

tristanmenzel and others added 7 commits October 21, 2024 14:57

feat: Named tuples

c02c518

feat: Named tuple support in contract to contract calls

2ce0c83

chore: Code cleanup

1548101

fix: Round trip serialization of names property on WTuple

3c5f3e1

chore: Lint fix

1a222fb

refactor: use index to look up tuple names

407c59b

refactor: use FieldExpression instead of TupleItemExpression with a s…

f59228f

…tr index

achidlow force-pushed the feat/named-tuples branch from fddc245 to 13bb575 Compare October 22, 2024 08:57

achidlow requested a review from daniel-makerx October 22, 2024 08:57

achidlow force-pushed the feat/named-tuples branch from 13bb575 to 8a9d495 Compare October 22, 2024 09:08

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Named tuple support #331

Named tuple support #331

tristanmenzel commented Oct 18, 2024

github-actions bot commented Oct 22, 2024 •

edited

Loading

Named tuple support #331

Are you sure you want to change the base?

Named tuple support #331

Conversation

tristanmenzel commented Oct 18, 2024

Proposed Changes

github-actions bot commented Oct 22, 2024 • edited Loading

github-actions bot commented Oct 22, 2024 •

edited

Loading