docs: add code re-use documentation (WIP)

[daniel-makerx]

No description provided.

[github-actions]

Coverage Report

File	Stmts	Miss	Cover	Missing
src/puya
__main__.py	31	1	97%	116
arc4_util.py	104	8	92%	30, 78–79, 93, 105, 107, 145, 164
arc32.py	125	3	98%	108, 119, 222
client_gen.py	106	106	0%	1–194
compile.py	200	21	90%	132, 146–149, 166–167, 176–177, 188, 195–196, 213–223, 230–232, 237, 308–309
context.py	40	1	98%	48
errors.py	51	20	61%	14–16, 45, 50–60, 72–78
log.py	210	31	85%	18–20, 36–39, 72, 74, 92, 111, 164–166, 169–171, 173, 186–195, 217, 287–289, 298–299, 333, 350
models.py	101	3	97%	10–13
options.py	30	2	93%	12–13
parse.py	229	17	93%	25, 96, 108, 135, 175, 229, 276, 286, 288, 292, 320–325, 329, 427–428, 431
utils.py	165	24	85%	12, 52, 56, 90, 96, 111, 114–116, 123, 145, 158–159, 163, 167–170, 199, 201, 224, 236, 241, 246, 257
src/puya/awst
function_traverser.py	190	3	98%	116, 146–147
nodes.py	927	69	93%	18–27, 43, 52, 86, 92, 96–99, 133, 139, 143–146, 280, 524, 727–728, 748, 760, 798, 804–805, 835, 861, 865–869, 881, 937, 979–980, 985, 1000, 1051, 1056, 1114, 1139, 1156, 1304, 1352, 1357–1358, 1365–1370, 1412, 1495, 1543, 1552, 1580, 1587, 1600, 1642, 1684, 1695, 1697, 1702, 1710, 1715, 1720, 1729, 1734, 1739, 1746
to_code_visitor.py	325	12	96%	83–84, 87–90, 114–115, 196, 331–332, 426–427, 498
visitors.py	223	73	67%	7, 15, 19, 23, 27, 31, 35, 39, 43, 47, 53, 59, 65, 69, 73, 77, 83, 87, 91, 95, 99, 103, 109, 113, 117, 121, 125, 129, 133, 137, 141, 147, 151, 155, 161, 167, 171, 177, 181, 185, 189, 193, 197, 201, 205, 209, 213, 217, 221, 225, 229, 233, 239, 242, 245, 251, 257, 261, 265, 269, 273, 277, 281, 285, 289, 293, 297, 301, 305, 309, 313, 317, 321
wtypes.py	301	33	89%	21, 185–196, 211–214, 231, 233, 278, 282, 312, 315, 317, 320, 345, 364, 400, 403, 452–453, 462–463, 471–472, 486, 545, 557, 573
src/puya/awst_build
arc4_utils.py	151	37	75%	50, 52, 55, 67, 94–95, 110, 114, 117, 123, 126, 129, 132, 138, 140, 148, 151, 154–166, 169, 178, 181, 264, 336, 343, 346
base_mypy_visitor.py	139	46	67%	39, 59, 71–77, 95, 103–116, 130, 132, 134, 143, 147, 152, 156, 159, 162, 168, 183, 189, 194, 197, 200, 207, 211, 214, 217, 221, 226, 232, 239, 243, 247, 251, 255, 259, 263, 267, 271, 275, 279, 283, 287
context.py	149	22	85%	62–63, 139–144, 152, 154–158, 161–162, 182, 187, 191, 204, 216–217
contract.py	226	58	74%	130–131, 133–136, 144–145, 148, 160, 171, 193, 211, 217, 219, 228, 238, 247, 275, 279, 295–299, 307–308, 313, 316, 319, 322, 327–328, 331, 339, 342, 345, 348, 351, 354, 357, 360, 363, 377, 391–398, 407–414, 421–422, 445, 455–456, 463, 469, 491–497
intrinsic_factory.py	33	2	94%	10, 83
intrinsic_models.py	32	5	84%	21, 26–29
main.py	48	3	94%	31, 48, 58
module.py	402	81	80%	75, 143, 157–159, 173–174, 181, 189, 195, 201–205, 210, 222, 246–247, 258, 288, 314–315, 338, 345, 367–368, 391–396, 450–451, 462, 479, 490, 493, 499, 507, 512, 518, 530, 533, 555, 576, 582, 591–594, 612–647, 671, 679–680, 694–696, 698, 700–701, 726, 734, 736
subroutine.py	617	70	89%	214, 225, 273, 279, 347, 351, 365, 373, 406–407, 547–562, 570, 578, 590, 622–623, 628, 633, 670, 690–691, 717–723, 776–777, 782, 798, 801, 804, 812–818, 872, 876–877, 881–882, 898, 900, 903–905, 930–931, 939, 975, 1017, 1045, 1049, 1080, 1153, 1181, 1188, 1198, 1209–1213, 1222, 1225, 1228, 1231, 1234, 1239, 1244, 1251, 1258
utils.py	164	17	90%	40, 77, 92, 95–96, 100, 140, 143–144, 161, 175, 188, 195, 233, 254, 307–308
src/puya/awst_build/eb
_utils.py	21	2	90%	13–14
app_account_state.py	128	28	78%	51–54, 62, 78, 80, 112–113, 134–141, 162–163, 168, 175–176, 178, 195–196, 203–204, 233, 238–239
app_state.py	123	26	79%	35–40, 51–58, 79–80, 85, 95–96, 101, 118–119, 126–127, 168–169, 192, 210
array.py	68	45	34%	26–27, 30–32, 37–44, 56–72, 77–79, 82, 85–88, 93–95, 100–102, 111–123
base.py	213	60	72%	25–32, 104, 108, 112, 118, 128, 134–139, 150–156, 161–167, 175, 181, 191, 201, 205, 211, 225, 230, 235, 238, 241, 244, 249, 252, 274, 295, 298, 303, 306, 309, 312, 315, 320, 323, 334, 347, 357, 360, 373, 394, 399, 408, 411, 415, 422, 425, 428, 433, 438, 449
biguint.py	91	22	76%	35–39, 62–63, 78, 93, 103–106, 128–131, 148–153, 170–178, 181–182
bool.py	40	6	85%	27–31, 53–54, 72
bytes.py	141	19	87%	55–59, 81–82, 93–94, 114–115, 119, 123, 128, 130–131, 151, 173, 287–288, 317
bytes_backed.py	30	4	87%	37–38, 50–51
contracts.py	44	2	95%	57, 61
ensure_budget.py	48	15	69%	25–29, 49–50, 70–71, 79, 91, 97–102
intrinsics.py	156	41	74%	31–33, 54–55, 63–64, 70–71, 88–89, 96, 125, 134, 136–160, 167–168, 212, 233–234, 253–254, 266, 271, 278, 281
log.py	52	9	83%	25–29, 79–85, 95, 97
named_int_constants.py	20	2	90%	23–24
string.py	119	15	87%	41–45, 66–67, 85–86, 99–100, 127–128, 180, 238–239, 254
struct.py	32	15	53%	21–22, 25, 35–41, 46–48, 51–56
subroutine.py	51	5	90%	48, 63, 89, 92, 107
template_variables.py	47	10	79%	25–26, 59–60, 64, 69, 72–73, 82–83
tuple.py	98	20	80%	38–39, 46, 57, 59–60, 82–83, 92–93, 106, 112, 130–131, 136–137, 149, 157, 165, 197
type_registry.py	28	2	93%	150–151
uint64.py	81	15	81%	37–41, 62–63, 85, 103, 126, 145–148, 162–170, 173–174
unsigned_builtins.py	70	11	84%	30–34, 51, 58, 92, 95–96, 126, 129–130
value_proxy.py	39	12	69%	24, 27, 30, 33, 36, 41, 56, 66, 75, 84, 87, 90
src/puya/awst_build/eb/arc4
utils.py	160	21	87%	25–28, 60–61, 63, 66–67, 89–90, 120, 125–126, 165, 200, 206, 211–213, 257, 262
abi_call.py	167	23	86%	51–54, 109, 118–119, 137–138, 142–143, 182, 194, 212–213, 275–281, 310–311, 372, 375, 377
arrays.py	242	30	88%	63–67, 80–81, 108, 138, 158–159, 194, 196, 229, 260, 276–277, 290, 339–340, 393–394, 416, 426–427, 443, 472, 491–492, 500, 546, 583
base.py	104	23	78%	35–39, 67–68, 73–74, 83–91, 146–147, 167, 176–177, 194–195, 205, 215, 220
bool.py	31	6	81%	18–25, 46–47
dynamic_bytes.py	42	5	88%	15–19, 60–61
emit.py	33	7	79%	26–30, 55–56, 64–65
numeric.py	125	17	86%	30–34, 46, 73, 80–81, 88, 111, 141–142, 148, 154, 210–213
string.py	66	11	83%	32–36, 58, 87, 106–107, 132–133, 151–152
struct.py	58	8	86%	25–32, 67, 70, 105–106
tuple.py	83	17	80%	28–32, 47, 51–52, 81, 90, 101, 110, 123, 127–128, 155–156, 165–166
src/puya/awst_build/eb/reference_types
account.py	69	6	91%	37–41, 88–89, 130
application.py	33	7	79%	15–19, 38–41
asset.py	53	9	83%	26–30, 49–52, 89–90
base.py	44	4	91%	25–27, 61, 87
src/puya/awst_build/eb/transaction
base.py	35	8	77%	17–18, 26, 30, 35–36, 43, 52
group.py	57	15	74%	33–37, 87–88, 141–154
inner.py	56	8	86%	27–32, 64–65, 115, 142
inner_params.py	104	11	89%	31–35, 43–44, 54, 110, 145, 169, 185, 217
src/puya/awst_build/validation
base_invoker.py	29	5	83%	31, 38, 47–52
inner_transactions.py	94	2	98%	112, 126
scratch_slots.py	39	4	90%	19, 33, 49, 51
src/puya/ir
arc4_router.py	246	20	92%	131, 149, 157, 307, 381, 427, 491–492, 506, 546–547, 559, 564, 569, 574, 579, 584, 604–609
avm_ops.py	316	2	99%	46–47
avm_ops_models.py	48	3	94%	21, 30, 38
context.py	92	12	87%	19, 72–73, 75, 93–99, 104, 115, 122, 132
main.py	221	6	97%	138, 141, 307, 309, 414, 425
models.py	470	26	94%	29, 45, 63, 79, 186, 196, 200, 374, 448, 490, 570, 586, 627, 630, 637, 640, 696, 705, 713, 719, 730–732, 742, 754, 791
ssa.py	136	9	93%	43, 51–52, 99, 105, 141, 145, 166, 170
to_text_visitor.py	143	9	94%	85, 90, 174–175, 181–186
types.py	50	7	86%	27–28, 58–61, 72
visitor.py	171	37	78%	10–12, 20, 24, 28, 32, 36, 40, 44, 48, 52, 56, 60, 64, 68, 72, 76, 80, 84, 88, 92, 96, 174, 186, 201, 204, 207, 213, 216, 222, 225, 228, 231, 234, 237, 240, 243
visitor_mutator.py	93	2	98%	138–139
vla.py	73	2	97%	50, 87
src/puya/ir/builder
_utils.py	71	8	89%	33, 44, 57, 79–80, 157, 203–204
arc4.py	426	46	89%	77–78, 127, 151–157, 221, 229, 452, 464, 467, 623–637, 966–980, 1006–1030, 1039–1055, 1078, 1242–1259, 1298–1299, 1352, 1385–1386, 1534–1535, 1598
assignment.py	45	5	89%	64, 80, 107, 138–139
blocks.py	92	10	89%	60, 70, 74, 110, 118, 122, 155–157, 163–165
callsub.py	57	1	98%	93
flow_control.py	98	4	96%	62, 116, 140, 154
iteration.py	192	6	97%	45, 65, 94, 144, 182–183
itxn.py	269	26	90%	123–124, 139–140, 150–151, 157–162, 188, 468–469, 474–475, 480–481, 487, 498, 515–516, 558–561
main.py	476	51	89%	93, 118, 144, 153, 157, 202–203, 219–220, 254, 262, 269–270, 341, 379, 391, 408, 429, 436, 470, 483, 521, 534–535, 599–600, 622, 670, 698, 716, 751–752, 827, 830, 836, 843–844, 874–875, 890, 936–937, 953–954, 988, 1003–1005, 1014, 1017–1018
src/puya/ir/destructure
coalesce_locals.py	94	15	84%	33, 36, 118, 127–128, 131–134, 137–139, 155–158
parcopy.py	84	2	98%	47, 83
src/puya/ir/optimize
_utils.py	28	1	96%	21
collapse_blocks.py	92	5	95%	65–69
control_op_simplification.py	101	11	89%	158–165, 239–246
dead_code_elimination.py	118	2	98%	289, 325
intrinsic_simplification.py	412	41	90%	67, 170, 182, 247, 316, 374, 380, 451, 473, 494, 496, 502, 511, 551, 555, 557, 559, 566, 596, 602, 604, 606, 611, 613, 615, 617, 619, 622–625, 632, 634, 636, 638, 640, 642, 646, 669–670, 677
main.py	85	3	96%	106–107, 123
src/puya/ir/validation
min_avm_version_validator.py	29	3	90%	24–25, 38
op_run_mode_validator.py	41	8	80%	22–23, 44–55
src/puya/mir
annotaters.py	172	7	96%	56, 62, 98, 102, 135, 139, 216
builder.py	120	5	96%	90, 138, 144, 251–252
context.py	39	1	97%	35
models.py	335	24	93%	14–18, 30, 41, 53, 69–70, 78, 89, 100, 111, 141, 251, 282, 319, 331, 348, 356–362, 368
output.py	61	2	97%	29, 31
stack.py	253	22	91%	68, 72, 115, 119, 125, 135, 146, 157, 167, 182, 199, 209, 228, 246, 252, 254, 293, 304, 328, 360, 365, 403
visitor.py	76	24	68%	7, 15, 19, 23, 27, 31, 35, 39, 43, 47, 51, 55, 59, 63, 67, 71, 75, 79, 83, 87, 91, 95, 99, 103
src/puya/mir/stack_allocation
baileys.py	208	6	97%	31, 103, 123, 330–334, 359
frame_allocation.py	80	3	96%	21, 64–65
koopmans.py	61	1	98%	55
peephole.py	100	6	94%	75, 89, 99, 101, 103, 145
src/puya/teal
models.py	229	2	99%	292, 298
src/puya/teal/optimize
peephole.py	112	4	96%	154–164, 172
repeated_rotations.py	30	1	97%	13
repeated_rotations_search.py	88	6	93%	34, 40–41, 57, 67–68
TOTAL	16637	1898	89%

Tests	Skipped	Failures	Errors	Time
278	4 💤	0 ❌	0 🔥	3m 8s ⏱️