doc: update documentation regarding nested tuples, named tuples and immutability options

[daniel-makerx]

No description provided.

[github-actions]

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	158	8	95%	91–92, 134–137, 157–160, 302, 350
context.py	31	1	97%	35
errors.py	35	8	77%	40–42, 44–46, 50–51
log.py	199	40	80%	32–35, 69, 89, 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	201	18	91%	50, 67–68, 77–78, 86–87, 177, 195–197, 204, 212, 226, 249, 251, 274, 309
src/puya/awst
function_traverser.py	285	3	99%	76, 367, 373
nodes.py	975	39	96%	99, 103–106, 146, 150–153, 351, 539, 555, 589, 630, 659–660, 710, 737–738, 887, 909, 941, 967, 972, 1127, 1212, 1228, 1277, 1350, 1421, 1475, 1479, 1736, 1741, 1746, 1754, 1759, 1764
serialize.py	68	11	84%	24, 84–89, 95–98
to_code_visitor.py	420	8	98%	131, 242, 279, 325, 581, 606, 634, 638
txn_fields.py	98	1	99%	48
wtypes.py	323	19	94%	170–173, 187–188, 192, 223, 236, 242, 247, 252–253, 287, 325, 339, 389, 460, 510
src/puya/awst/validation
base_invoker.py	47	4	91%	55, 62, 72–76
inner_transactions.py	187	1	99%	160
labels.py	30	8	73%	25–27, 32, 36–41
scratch_slots.py	38	4	89%	18, 32, 47, 49
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	101	8	92%	68, 75, 78, 80, 118–119, 129, 135
main.py	276	12	96%	74–80, 90–96, 122, 135, 163, 511
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	528	24	95%	165–170, 450, 475, 478, 536–539, 801–802, 1048, 1072, 1153, 1160, 1196, 1244, 1254, 1309, 1354, 1373, 1393, 1454–1461
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	536	65	88%	102, 240, 244, 249–267, 272–290, 345, 369, 393–394, 432, 620, 652, 665–666, 722, 747, 784–786, 797, 862, 940, 953, 985, 1040, 1043, 1051, 1054, 1062, 1091, 1102, 1111, 1190, 1207, 1250–1260
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	2	90%	24, 30
min_avm_version_validator.py	11	1	91%	15
op_run_mode_validator.py	19	5	74%	19–29
src/puya/mir
aligned_writer.py	63	3	95%	21, 61, 80
builder.py	157	13	92%	71–73, 156, 268–269, 322, 325, 328, 331, 334, 337, 340
models.py	431	6	99%	97, 206, 250, 316, 333, 403
src/puya/mir/stack_allocation
f_stack.py	89	2	98%	23, 70
peephole.py	50	3	94%	41, 50, 52
x_stack.py	205	3	99%	32, 336–340
src/puya/teal
models.py	358	2	99%	367, 428
src/puya/teal/optimize
constant_block.py	104	4	96%	63, 152, 189, 206
peephole.py	127	3	98%	160, 166, 249
repeated_rotations.py	51	1	98%	16
repeated_rotations_search.py	90	6	93%	35, 41–42, 58, 68–69
src/puya/ussemble
assemble.py	169	5	97%	128, 196, 213–214, 254
models.py	23	1	96%	16
op_spec_models.py	22	1	95%	20
src/puyapy
__main__.py	63	17	73%	172, 184–198, 202
client_gen.py	116	15	87%	56–57, 66–70, 74, 166–167, 175–176, 191, 195–196, 205
compile.py	150	22	85%	59–68, 82, 162–163, 174, 181–182, 199–209, 219–221, 226, 242
models.py	98	4	96%	64, 76–78
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	104	26	75%	46–50, 58, 70, 76, 80, 109, 115–116, 122, 125, 128, 134, 137, 140–145, 148, 151, 154, 157, 160, 163, 166, 169, 172
arc4_utils.py	285	42	85%	42, 45–46, 48, 78, 89–93, 109, 111, 114–115, 138, 181–183, 192, 197, 202–203, 237, 241, 253, 260, 262, 276–277, 280–284, 289–290, 296–299, 307, 325, 337, 345, 452, 457, 476
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	218	47	78%	55, 58, 68–69, 87–88, 128, 188, 193, 199–203, 207, 210, 219, 221, 224–226, 228, 235, 237, 248–249, 254–256, 259, 274, 286–287, 299, 313, 316–328
contract.py	318	33	90%	128, 179, 192–196, 235, 237, 241, 245, 253, 261, 263, 283, 338, 341, 353, 361, 364, 367, 370, 373, 376, 379, 382, 385, 388, 448–452, 501–505, 585–589, 660, 683
intrinsic_models.py	40	1	98%	49
main.py	36	1	97%	31
module.py	408	58	86%	116, 130–132, 147–148, 155, 164–165, 173–177, 195–199, 209, 247–248, 259, 281–284, 294–296, 302, 319–322, 335, 369, 376, 398–399, 422–427, 481–482, 510, 521, 524, 530, 536, 546, 552, 555, 567, 570, 592, 612, 617, 621, 625–628, 647, 695, 715, 723, 725
pytypes.py	534	48	91%	85–87, 101–102, 142, 158–164, 187, 207, 249, 359, 368, 387, 406, 426–427, 466, 559–561, 575–576, 643–644, 750, 761–762, 807–808, 813, 862–863, 884–885, 1031–1032, 1056, 1084, 1118–1120, 1160, 1170–1171
subroutine.py	604	53	91%	135, 247, 253, 311–314, 320, 372, 379, 382–388, 479, 499, 654, 656–657, 675, 677, 687–688, 697–698, 702, 723, 798, 805, 825–826, 908, 934–935, 952, 968, 992, 1000, 1011, 1036, 1141–1142, 1162, 1172, 1174, 1183, 1201, 1209, 1223, 1226, 1229, 1232, 1235, 1255–1257
utils.py	174	25	86%	30, 47–51, 69, 104–105, 107, 151–152, 203, 211, 216, 229–233, 238–241, 250, 254, 262, 305
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	77	8	90%	55, 61, 63, 73, 99, 109, 111, 116
dict.py	27	5	81%	25, 33–35, 39
ensure_budget.py	31	1	97%	47
interface.py	90	3	97%	314–316, 320
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	79	16	80%	46, 50–53, 68, 71–78, 93, 101–102, 104–107, 112
template_variables.py	37	2	95%	30, 58
tuple.py	339	13	96%	85, 133, 149, 239–240, 252, 345–346, 465, 534, 545–546, 609
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	151	10	93%	102–103, 132, 140, 153, 193–196, 267, 271, 285
abi_call.py	316	19	94%	118, 124, 145, 215, 228–229, 310, 321, 379, 402, 433, 452–453, 511, 548, 620, 705–706, 723
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	108	20	81%	58, 66, 70, 74, 78, 82, 86, 90, 94, 104, 108, 112, 116, 122, 133, 139, 145, 157–159
_value_proxy.py	55	7	87%	38, 42, 50, 54, 91, 99, 103
box_map.py	148	1	99%	195
global_state.py	125	5	96%	104–105, 111, 163–164
local_state.py	137	11	92%	99–100, 104, 151, 155, 159, 169, 173, 197, 254, 278
src/puyapy/awst_build/eb/transaction
base.py	39	2	95%	23, 43
group.py	53	1	98%	48
inner.py	50	3	94%	89–91
inner_params.py	77	5	94%	64, 74, 78, 138, 140
itxn_args.py	60	1	98%	72
TOTAL	21932	1679	92%

Tests	Skipped	Failures	Errors	Time
859	2 💤	0 ❌	0 🔥	5m 38s ⏱️