fix subroutine args with no doc (#524)

algorand · Sep 7, 2022 · 1cb6c97 · 1cb6c97
1 parent f8911e7
commit 1cb6c97
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 17 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,8 @@
 # Unreleased
 
+## Fixed
+* ABI methods without a docstring now have their arguments in the output Contract object. ([#524](https://github.com/algorand/pyteal/pull/524))
+
 # 0.18.0
 
 ## Added

diff --git a/pyteal/ast/subroutine.py b/pyteal/ast/subroutine.py
@@ -651,22 +651,22 @@ def method_spec(self) -> sdk_abi.Method:
                 else docstring.returns.description.replace("\n", " ").strip()
             )
 
-            # Generate the ABI method object given the subroutine args
-            # Add in description if one is set
-            for name, val in self.subroutine.annotations.items():
-                # Skip annotations for `return` and `output` in the args list
-                if name in ["return", self.OUTPUT_ARG_NAME]:
-                    continue
-
-                arg_obj = {
-                    "type": str(abi.type_spec_from_annotation(val)),
-                    "name": name,
-                }
-
-                if name in arg_descs:
-                    arg_obj["desc"] = arg_descs[name]
-
-                args.append(arg_obj)
+        # Generate the ABI method object given the subroutine args
+        # Add in description if one is set
+        for name, val in self.subroutine.annotations.items():
+            # Skip annotations for `return` and `output` in the args list
+            if name in ["return", self.OUTPUT_ARG_NAME]:
+                continue
+
+            arg_obj = {
+                "type": str(abi.type_spec_from_annotation(val)),
+                "name": name,
+            }
+
+            if name in arg_descs:
+                arg_obj["desc"] = arg_descs[name]
+
+            args.append(arg_obj)
 
         # Create the return obj for the method, adding description if set
         return_obj = {"type": str(self.type_of())}

diff --git a/pyteal/ast/subroutine_test.py b/pyteal/ast/subroutine_test.py
@@ -1415,10 +1415,16 @@ def documented_method(a: pt.abi.Uint64, *, output: pt.abi.Uint64):
     :returns: {return_doc}
     """
     mspec_dict = ABIReturnSubroutine(documented_method).method_spec().dictify()
-    assert "descr" not in mspec_dict
+    assert "desc" not in mspec_dict
     assert mspec_dict["args"][0]["desc"] == a_doc
     assert mspec_dict["returns"]["desc"] == return_doc
 
+    # No doc
+    documented_method.__doc__ = None
+    mspec_dict = ABIReturnSubroutine(documented_method).method_spec().dictify()
+    assert "desc" not in mspec_dict
+    assert len(mspec_dict["args"]) == 1
+
     algobank_example = """Withdraw an amount of Algos held by this app.
 
     The sender of this method call will be the source of the Algos, and the destination will be