fix: handle zero values for TemplateVar

boolean values are now also allowed as `True` or `False` also incorrect values will no longer result in a critical error, but a CLI usage error instead --------- PuyaOptions now contains a parsed set of key-values for template variables
algorandfoundation · Sep 13, 2024 · 6087dc2 · 6087dc2
1 parent b5d4eb8
commit 6087dc2
Show file tree

Hide file tree

Showing 84 changed files with 171 additions and 163 deletions.
diff --git a/examples/amm/puya.log b/examples/amm/puya.log
diff --git a/examples/arc_28/puya.log b/examples/arc_28/puya.log
diff --git a/examples/auction/puya.log b/examples/auction/puya.log
diff --git a/examples/box_storage/puya.log b/examples/box_storage/puya.log
diff --git a/examples/calculator/puya.log b/examples/calculator/puya.log
diff --git a/examples/global_state/puya.log b/examples/global_state/puya.log
diff --git a/examples/hello_world/puya.log b/examples/hello_world/puya.log
diff --git a/examples/hello_world_arc4/puya.log b/examples/hello_world_arc4/puya.log
diff --git a/examples/local_state/puya.log b/examples/local_state/puya.log
diff --git a/examples/merkle/puya.log b/examples/merkle/puya.log
diff --git a/examples/struct_in_box/puya.log b/examples/struct_in_box/puya.log
diff --git a/examples/tictactoe/puya.log b/examples/tictactoe/puya.log
diff --git a/examples/voting/puya.log b/examples/voting/puya.log
diff --git a/src/puya/options.py b/src/puya/options.py
@@ -4,7 +4,6 @@
 
 import attrs
 
-from puya import template
 from puya.algo_constants import MAINNET_TEAL_LANGUAGE_VERSION
 
 
@@ -27,14 +26,12 @@ class PuyaOptions:
     debug_level: int = 1
     optimization_level: int = 1
     target_avm_version: int = MAINNET_TEAL_LANGUAGE_VERSION
-    cli_template_definitions: list[str] = attrs.field(factory=list)
+    cli_template_definitions: Mapping[str, int | bytes] = attrs.field(factory=dict)
     template_vars_prefix: str = "TMPL_"
     # TODO: the below is probably not scalable as a set of optimisation on/off flags,
     #       but it'll do for now
     locals_coalescing_strategy: LocalsCoalescingStrategy = LocalsCoalescingStrategy.root_operand
 
     @cached_property
     def template_variables(self) -> Mapping[str, int | bytes]:
-        return template.parse_template_vars(
-            self.cli_template_definitions, self.template_vars_prefix
-        )
+        return {self.template_vars_prefix + k: v for k, v in self.cli_template_definitions.items()}
diff --git a/src/puya/template.py b/src/puya/template.py
diff --git a/src/puyapy/__main__.py b/src/puyapy/__main__.py
@@ -1,4 +1,6 @@
 import argparse
+import typing
+from collections.abc import Sequence
 from importlib.metadata import version
 from pathlib import Path
 
@@ -8,6 +10,7 @@
 
 from puyapy.compile import compile_to_teal
 from puyapy.options import PuyaPyOptions
+from puyapy.template import parse_template_key_value
 
 
 def main() -> None:
@@ -113,12 +116,11 @@ def main() -> None:
         "--template-var",
         dest="cli_template_definitions",
         metavar="VAR=VALUE",
-        action="append",
+        action=_ParseAndStoreTemplateVar,
+        nargs="+",
         help="Define template vars for use when assembling via --output-bytecode"
         " should be specified without the prefix (see --template-vars-prefix), e.g."
-        " -T=SOME_INT=1234"
-        " -T=SOME_BYTES=0x1A2B"
-        ' -T=SOME_STR=\\"hello\\"',
+        ' -T SOME_INT=1234 SOME_BYTES=0x1A2B SOME_BOOL=True SOME_STR=\\"hello\\"',
     )
     parser.add_argument(
         "--template-vars-prefix",
@@ -149,5 +151,31 @@ def main() -> None:
     compile_to_teal(options)
 
 
+class _ParseAndStoreTemplateVar(argparse.Action):
+    @typing.override
+    def __call__(
+        self,
+        parser: argparse.ArgumentParser,
+        namespace: argparse.Namespace,
+        values: str | Sequence[typing.Any] | None,
+        option_string: str | None = None,
+    ) -> None:
+        mapping: dict[str, int | bytes] = dict(getattr(namespace, self.dest, {}))
+        lst = []
+        if isinstance(values, str):
+            lst = [values]
+        elif values:
+            for value in values:
+                assert isinstance(value, str)
+                lst.append(value)
+        for kv in lst:
+            try:
+                name, value = parse_template_key_value(kv)
+            except Exception as ex:
+                parser.error(str(ex))
+            mapping[name] = value
+        setattr(namespace, self.dest, mapping)
+
+
 if __name__ == "__main__":
     main()