fix: minor patches in dataclass inheritance; fixes for mypy errors; a…

…ddressing internal feedback (#37) * fix: minor patches in dataclass inheritance; fixes for mypy errors * refactor: ensure create, update, delete params in factory deploy only require args dataclass (to figure out signature)
algorandfoundation · Feb 5, 2025 · 82a1a1c · 82a1a1c · github-actions · Feb 5, 2025
1 parent 58f13aa
commit 82a1a1c
Show file tree

Hide file tree

Showing 18 changed files with 566 additions and 165 deletions.
diff --git a/examples/arc56_test/client.py b/examples/arc56_test/client.py
@@ -59,7 +59,7 @@ def _init_dataclass(cls: type, data: dict) -> object:
         field_value = data.get(field.name)
         # Check if the field expects another dataclass and the value is a dict.
         if dataclasses.is_dataclass(field.type) and isinstance(field_value, dict):
-            field_values[field.name] = _init_dataclass(field.type, field_value)
+            field_values[field.name] = _init_dataclass(typing.cast(type, field.type), field_value)
         else:
             field_values[field.name] = field_value
     return cls(**field_values)
@@ -100,6 +100,10 @@ class FooArgs:
     """Dataclass for foo arguments"""
     inputs: Inputs
 
+    @property
+    def abi_method_signature(self) -> str:
+        return "foo(((uint64,uint64),(uint64,uint64)))(uint64,uint64)"
+
 
 class _Arc56TestOptIn:
     def __init__(self, app_client: algokit_utils.AppClient):
@@ -679,17 +683,19 @@ def decode_return_value(
 class Arc56TestMethodCallCreateParams(
     algokit_utils.AppClientCreateSchema, algokit_utils.BaseAppClientMethodCallParams[
         typing.Any,
-        typing.Any,
+        str | None,
     ]
 ):
     """Parameters for creating Arc56Test contract using ABI"""
     on_complete: typing.Literal[OnComplete.NoOpOC] | None = None
+    method: str | None = None
 
     def to_algokit_utils_params(self) -> algokit_utils.AppClientMethodCallCreateParams:
         method_args = _parse_abi_args(self.args)
         return algokit_utils.AppClientMethodCallCreateParams(
             **{
                 **self.__dict__,
+                "method": self.method or getattr(self.args, "abi_method_signature", None),
                 "args": method_args,
             }
         )
@@ -911,7 +917,7 @@ def bare(
         """Updates an instance using a bare call"""
         params = params or algokit_utils.CommonAppCallCreateParams()
         return self.app_factory.params.bare.deploy_update(
-            algokit_utils.AppFactoryCreateParams(**dataclasses.asdict(params)),
+            algokit_utils.AppClientBareCallParams(**dataclasses.asdict(params)),
             )
 
 class Arc56TestFactoryDeleteParams:
@@ -929,7 +935,7 @@ def bare(
         """Deletes an instance using a bare call"""
         params = params or algokit_utils.CommonAppCallCreateParams()
         return self.app_factory.params.bare.deploy_delete(
-            algokit_utils.AppFactoryCreateParams(**dataclasses.asdict(params)),
+            algokit_utils.AppClientBareCallParams(**dataclasses.asdict(params)),
             )
 
 

diff --git a/examples/duplicate_structs/client.py b/examples/duplicate_structs/client.py
@@ -59,7 +59,7 @@ def _init_dataclass(cls: type, data: dict) -> object:
         field_value = data.get(field.name)
         # Check if the field expects another dataclass and the value is a dict.
         if dataclasses.is_dataclass(field.type) and isinstance(field_value, dict):
-            field_values[field.name] = _init_dataclass(field.type, field_value)
+            field_values[field.name] = _init_dataclass(typing.cast(type, field.type), field_value)
         else:
             field_values[field.name] = field_value
     return cls(**field_values)
@@ -584,7 +584,7 @@ def bare(
         """Updates an instance using a bare call"""
         params = params or algokit_utils.CommonAppCallCreateParams()
         return self.app_factory.params.bare.deploy_update(
-            algokit_utils.AppFactoryCreateParams(**dataclasses.asdict(params)),
+            algokit_utils.AppClientBareCallParams(**dataclasses.asdict(params)),
             )
 
 class DuplicateStructsContractFactoryDeleteParams:
@@ -602,7 +602,7 @@ def bare(
         """Deletes an instance using a bare call"""
         params = params or algokit_utils.CommonAppCallCreateParams()
         return self.app_factory.params.bare.deploy_delete(
-            algokit_utils.AppFactoryCreateParams(**dataclasses.asdict(params)),
+            algokit_utils.AppClientBareCallParams(**dataclasses.asdict(params)),
             )
 
 

diff --git a/examples/helloworld/client.py b/examples/helloworld/client.py
@@ -59,7 +59,7 @@ def _init_dataclass(cls: type, data: dict) -> object:
         field_value = data.get(field.name)
         # Check if the field expects another dataclass and the value is a dict.
         if dataclasses.is_dataclass(field.type) and isinstance(field_value, dict):
-            field_values[field.name] = _init_dataclass(field.type, field_value)
+            field_values[field.name] = _init_dataclass(typing.cast(type, field.type), field_value)
         else:
             field_values[field.name] = field_value
     return cls(**field_values)
@@ -69,11 +69,19 @@ class HelloArgs:
     """Dataclass for hello arguments"""
     name: str
 
+    @property
+    def abi_method_signature(self) -> str:
+        return "hello(string)string"
+
 @dataclasses.dataclass(frozen=True, kw_only=True)
 class HelloWorldCheckArgs:
     """Dataclass for hello_world_check arguments"""
     name: str
 
+    @property
+    def abi_method_signature(self) -> str:
+        return "hello_world_check(string)void"
+
 
 class _HelloWorldAppUpdate:
     def __init__(self, app_client: algokit_utils.AppClient):
@@ -498,15 +506,15 @@ def to_algokit_utils_params(self) -> algokit_utils.AppClientBareCallCreateParams
         return algokit_utils.AppClientBareCallCreateParams(**self.__dict__)
 
 @dataclasses.dataclass(frozen=True)
-class HelloWorldAppBareCallUpdateParams(algokit_utils.AppClientBareCallCreateParams):
+class HelloWorldAppBareCallUpdateParams(algokit_utils.AppClientBareCallParams):
     """Parameters for calling HelloWorldApp contract with bare calls"""
     on_complete: typing.Literal[OnComplete.UpdateApplicationOC] | None = None
 
     def to_algokit_utils_params(self) -> algokit_utils.AppClientBareCallParams:
         return algokit_utils.AppClientBareCallParams(**self.__dict__)
 
 @dataclasses.dataclass(frozen=True)
-class HelloWorldAppBareCallDeleteParams(algokit_utils.AppClientBareCallCreateParams):
+class HelloWorldAppBareCallDeleteParams(algokit_utils.AppClientBareCallParams):
     """Parameters for calling HelloWorldApp contract with bare calls"""
     on_complete: typing.Literal[OnComplete.DeleteApplicationOC] | None = None
 
@@ -712,7 +720,7 @@ def bare(
         """Updates an instance using a bare call"""
         params = params or algokit_utils.CommonAppCallCreateParams()
         return self.app_factory.params.bare.deploy_update(
-            algokit_utils.AppFactoryCreateParams(**dataclasses.asdict(params)),
+            algokit_utils.AppClientBareCallParams(**dataclasses.asdict(params)),
             )
 
 class HelloWorldAppFactoryDeleteParams:
@@ -730,7 +738,7 @@ def bare(
         """Deletes an instance using a bare call"""
         params = params or algokit_utils.CommonAppCallCreateParams()
         return self.app_factory.params.bare.deploy_delete(
-            algokit_utils.AppFactoryCreateParams(**dataclasses.asdict(params)),
+            algokit_utils.AppClientBareCallParams(**dataclasses.asdict(params)),
             )
 
 

diff --git a/examples/lifecycle/client.py b/examples/lifecycle/client.py
@@ -59,7 +59,7 @@ def _init_dataclass(cls: type, data: dict) -> object:
         field_value = data.get(field.name)
         # Check if the field expects another dataclass and the value is a dict.
         if dataclasses.is_dataclass(field.type) and isinstance(field_value, dict):
-            field_values[field.name] = _init_dataclass(field.type, field_value)
+            field_values[field.name] = _init_dataclass(typing.cast(type, field.type), field_value)
         else:
             field_values[field.name] = field_value
     return cls(**field_values)
@@ -69,17 +69,29 @@ class HelloStringStringArgs:
     """Dataclass for hello_string_string arguments"""
     name: str
 
+    @property
+    def abi_method_signature(self) -> str:
+        return "hello(string)string"
+
 @dataclasses.dataclass(frozen=True, kw_only=True)
 class CreateStringStringArgs:
     """Dataclass for create_string_string arguments"""
     greeting: str
 
+    @property
+    def abi_method_signature(self) -> str:
+        return "create(string)string"
+
 @dataclasses.dataclass(frozen=True, kw_only=True)
 class CreateStringUint32VoidArgs:
     """Dataclass for create_string_uint32_void arguments"""
     greeting: str
     times: int
 
+    @property
+    def abi_method_signature(self) -> str:
+        return "create(string,uint32)void"
+
 
 class _LifeCycleAppUpdate:
     def __init__(self, app_client: algokit_utils.AppClient):
@@ -592,18 +604,20 @@ def decode_return_value(
 @dataclasses.dataclass(frozen=True)
 class LifeCycleAppMethodCallCreateParams(
     algokit_utils.AppClientCreateSchema, algokit_utils.BaseAppClientMethodCallParams[
-        tuple[str] | CreateStringStringArgs | tuple[str, int] | CreateStringUint32VoidArgs,
-        typing.Literal["create(string)string"] | typing.Literal["create(string,uint32)void"],
+        CreateStringStringArgs | CreateStringUint32VoidArgs,
+        str | None,
     ]
 ):
     """Parameters for creating LifeCycleApp contract using ABI"""
     on_complete: typing.Literal[OnComplete.NoOpOC] | None = None
+    method: str | None = None
 
     def to_algokit_utils_params(self) -> algokit_utils.AppClientMethodCallCreateParams:
         method_args = _parse_abi_args(self.args)
         return algokit_utils.AppClientMethodCallCreateParams(
             **{
                 **self.__dict__,
+                "method": self.method or getattr(self.args, "abi_method_signature", None),
                 "args": method_args,
             }
         )
@@ -617,7 +631,7 @@ def to_algokit_utils_params(self) -> algokit_utils.AppClientBareCallCreateParams
         return algokit_utils.AppClientBareCallCreateParams(**self.__dict__)
 
 @dataclasses.dataclass(frozen=True)
-class LifeCycleAppBareCallUpdateParams(algokit_utils.AppClientBareCallCreateParams):
+class LifeCycleAppBareCallUpdateParams(algokit_utils.AppClientBareCallParams):
     """Parameters for calling LifeCycleApp contract with bare calls"""
     on_complete: typing.Literal[OnComplete.UpdateApplicationOC] | None = None
 
@@ -862,7 +876,7 @@ def bare(
         """Updates an instance using a bare call"""
         params = params or algokit_utils.CommonAppCallCreateParams()
         return self.app_factory.params.bare.deploy_update(
-            algokit_utils.AppFactoryCreateParams(**dataclasses.asdict(params)),
+            algokit_utils.AppClientBareCallParams(**dataclasses.asdict(params)),
             )
 
 class LifeCycleAppFactoryDeleteParams:
@@ -880,7 +894,7 @@ def bare(
         """Deletes an instance using a bare call"""
         params = params or algokit_utils.CommonAppCallCreateParams()
         return self.app_factory.params.bare.deploy_delete(
-            algokit_utils.AppFactoryCreateParams(**dataclasses.asdict(params)),
+            algokit_utils.AppClientBareCallParams(**dataclasses.asdict(params)),
             )
 
 

diff --git a/examples/lifecycle/test_client.py b/examples/lifecycle/test_client.py
@@ -93,8 +93,7 @@ def test_create_2arg(lifecycle_factory: LifeCycleAppFactory) -> None:
 def test_deploy_create_1arg(lifecycle_factory: LifeCycleAppFactory) -> None:
     client, response = lifecycle_factory.deploy(
         create_params=LifeCycleAppMethodCallCreateParams(
-            args=CreateStringStringArgs(greeting="greeting"),
-            method="create(string)string",
+            args=CreateStringStringArgs(greeting="greeting")
         )
     )
 

diff --git a/examples/minimal/client.py b/examples/minimal/client.py
@@ -59,7 +59,7 @@ def _init_dataclass(cls: type, data: dict) -> object:
         field_value = data.get(field.name)
         # Check if the field expects another dataclass and the value is a dict.
         if dataclasses.is_dataclass(field.type) and isinstance(field_value, dict):
-            field_values[field.name] = _init_dataclass(field.type, field_value)
+            field_values[field.name] = _init_dataclass(typing.cast(type, field.type), field_value)
         else:
             field_values[field.name] = field_value
     return cls(**field_values)
@@ -384,15 +384,15 @@ def to_algokit_utils_params(self) -> algokit_utils.AppClientBareCallCreateParams
         return algokit_utils.AppClientBareCallCreateParams(**self.__dict__)
 
 @dataclasses.dataclass(frozen=True)
-class AppBareCallUpdateParams(algokit_utils.AppClientBareCallCreateParams):
+class AppBareCallUpdateParams(algokit_utils.AppClientBareCallParams):
     """Parameters for calling App contract with bare calls"""
     on_complete: typing.Literal[OnComplete.UpdateApplicationOC] | None = None
 
     def to_algokit_utils_params(self) -> algokit_utils.AppClientBareCallParams:
         return algokit_utils.AppClientBareCallParams(**self.__dict__)
 
 @dataclasses.dataclass(frozen=True)
-class AppBareCallDeleteParams(algokit_utils.AppClientBareCallCreateParams):
+class AppBareCallDeleteParams(algokit_utils.AppClientBareCallParams):
     """Parameters for calling App contract with bare calls"""
     on_complete: typing.Literal[OnComplete.DeleteApplicationOC] | None = None
 
@@ -558,7 +558,7 @@ def bare(
         """Updates an instance using a bare call"""
         params = params or algokit_utils.CommonAppCallCreateParams()
         return self.app_factory.params.bare.deploy_update(
-            algokit_utils.AppFactoryCreateParams(**dataclasses.asdict(params)),
+            algokit_utils.AppClientBareCallParams(**dataclasses.asdict(params)),
             )
 
 class AppFactoryDeleteParams:
@@ -576,7 +576,7 @@ def bare(
         """Deletes an instance using a bare call"""
         params = params or algokit_utils.CommonAppCallCreateParams()
         return self.app_factory.params.bare.deploy_delete(
-            algokit_utils.AppFactoryCreateParams(**dataclasses.asdict(params)),
+            algokit_utils.AppClientBareCallParams(**dataclasses.asdict(params)),
             )
 
 

diff --git a/examples/nested/client.py b/examples/nested/client.py
@@ -59,7 +59,7 @@ def _init_dataclass(cls: type, data: dict) -> object:
         field_value = data.get(field.name)
         # Check if the field expects another dataclass and the value is a dict.
         if dataclasses.is_dataclass(field.type) and isinstance(field_value, dict):
-            field_values[field.name] = _init_dataclass(field.type, field_value)
+            field_values[field.name] = _init_dataclass(typing.cast(type, field.type), field_value)
         else:
             field_values[field.name] = field_value
     return cls(**field_values)
@@ -70,18 +70,30 @@ class AddArgs:
     a: int
     b: int
 
+    @property
+    def abi_method_signature(self) -> str:
+        return "add(uint64,uint64)uint64"
+
 @dataclasses.dataclass(frozen=True, kw_only=True)
 class GetPayTxnAmountArgs:
     """Dataclass for get_pay_txn_amount arguments"""
     pay_txn: algokit_utils.AppMethodCallTransactionArgument
 
+    @property
+    def abi_method_signature(self) -> str:
+        return "get_pay_txn_amount(pay)uint64"
+
 @dataclasses.dataclass(frozen=True, kw_only=True)
 class NestedMethodCallArgs:
     """Dataclass for nested_method_call arguments"""
     _: str
     _pay_txn: algokit_utils.AppMethodCallTransactionArgument | None = None
     method_call: algokit_utils.AppMethodCallTransactionArgument
 
+    @property
+    def abi_method_signature(self) -> str:
+        return "nested_method_call(string,pay,appl)byte[]"
+
 
 class NestedContractParams:
     def __init__(self, app_client: algokit_utils.AppClient):
@@ -678,7 +690,7 @@ def bare(
         """Updates an instance using a bare call"""
         params = params or algokit_utils.CommonAppCallCreateParams()
         return self.app_factory.params.bare.deploy_update(
-            algokit_utils.AppFactoryCreateParams(**dataclasses.asdict(params)),
+            algokit_utils.AppClientBareCallParams(**dataclasses.asdict(params)),
             )
 
 class NestedContractFactoryDeleteParams:
@@ -696,7 +708,7 @@ def bare(
         """Deletes an instance using a bare call"""
         params = params or algokit_utils.CommonAppCallCreateParams()
         return self.app_factory.params.bare.deploy_delete(
-            algokit_utils.AppFactoryCreateParams(**dataclasses.asdict(params)),
+            algokit_utils.AppClientBareCallParams(**dataclasses.asdict(params)),
             )
File	Stmts	Miss	Cover	Missing
src/algokit_client_generator
__main__.py	2	2	0%	1–3
cli.py	48	48	0%	1–87
document.py	82	7	91%	44, 47, 49–50, 55, 74–75
generator.py	31	1	97%	23
spec.py	207	16	92%	86, 116–119, 219–223, 253, 269, 350–351, 395, 410
utils.py	219	48	78%	11, 20, 24, 28, 32, 36, 40, 44, 55, 58, 63–64, 75–76, 82–84, 89–91, 94–96, 99, 102, 105, 108–110, 159–160, 194, 198, 201–202, 218, 220, 231–232, 249, 261–264, 268, 278, 281, 283
src/algokit_client_generator/generators
composer.py	51	1	98%	29
typed_client.py	328	8	98%	59, 188, 287, 590, 680, 690, 729, 840
typed_factory.py	213	3	99%	64, 94, 227
TOTAL	1252	134	89%