algorand-python-testing 0.3.0b4__tar.gz → 0.3.0b5__tar.gz

{algorand_python_testing-0.3.0b4 → algorand_python_testing-0.3.0b5}/CHANGELOG.md

@@ -1,4 +1,22 @@
 # CHANGELOG
+## v0.3.0-beta.5 (2024-08-21)
+
+### Fix
+
+* ensure mutable types (ARC4 tuple, array and structs) have their changes propagated back to container-like types (global/local state, boxes, ARC4 mutable types) (#14) ([`1f1f2ea`](https://github.com/algorandfoundation/algorand-python-testing/commit/1f1f2ea43a2f4f906cbcd5709b8e86b5c1f2bc63))
+
+  * fix: add default __eq__ implementation for ARC4 types
+
+  * fix: ensure mutable types (ARC4 tuple, array and structs) have their changes propagated back to container-like types (global/local state, boxes, ARC4 mutable types)
+
+  * feat: add __str__ and __repr__ implementations for ARC4 types
+
+  * refactor: make ARC4 type_info private
+
+  * refactor: make ARC4 struct inherit _ABIEncoded
+
+  * refactor: removing get_app_for_contract; expanding get_app; parsing on_complete
+
 ## v0.3.0-beta.4 (2024-08-21)
 
 ### Feature

{algorand_python_testing-0.3.0b4 → algorand_python_testing-0.3.0b5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: algorand-python-testing
-Version: 0.3.0b4
+Version: 0.3.0b5
 Summary: Algorand Python testing library
 Project-URL: Documentation, https://github.com/algorandfoundation/puya/tree/main/algopy_testing#README.md
 Project-URL: Issues, https://github.com/algorandfoundation/puya/issues

{algorand_python_testing-0.3.0b4 → algorand_python_testing-0.3.0b5}/examples/auction/test_contract.py

@@ -26,7 +26,7 @@ def test_opt_into_asset(context: AlgopyTestContext) -> None:
     assert contract.asa.id == asset.id
     inner_txn = context.txn.last_group.last_itxn.asset_transfer
     assert (
-        inner_txn.asset_receiver == context.get_app_for_contract(contract).address
+        inner_txn.asset_receiver == context.ledger.get_app(contract).address
     ), "Asset receiver does not match"
     assert inner_txn.xfer_asset == asset, "Transferred asset does not match"
 
@@ -36,7 +36,7 @@ def test_start_auction(
 ) -> None:
     # Arrange
     contract = AuctionContract()
-    app = context.get_app_for_contract(contract)
+    app = context.ledger.get_app(contract)
     latest_timestamp = context.any.uint64(1, 1000)
     starting_price = context.any.uint64()
     auction_duration = context.any.uint64(100, 1000)

{algorand_python_testing-0.3.0b4 → algorand_python_testing-0.3.0b5}/examples/marketplace/test_contract.py

@@ -41,7 +41,7 @@ def test_first_deposit(
     test_nonce: arc4.UInt64,
 ) -> None:
     # Arrange
-    test_app = context.get_app_for_contract(contract)
+    test_app = context.ledger.get_app(contract)
 
     # Act
     contract.first_deposit(
@@ -74,7 +74,7 @@ def test_deposit(
     test_nonce: arc4.UInt64,
 ) -> None:
     # Arrange
-    test_app = context.get_app_for_contract(contract)
+    test_app = context.ledger.get_app(contract)
     listing_key = ListingKey(
         owner=arc4.Address(str(context.default_sender)),
         asset=arc4.UInt64(test_asset.id),
@@ -225,7 +225,7 @@ def test_bid(
     test_nonce: arc4.UInt64,
 ) -> None:
     # Arrange
-    app = context.get_app_for_contract(contract)
+    app = context.ledger.get_app(contract)
     owner = arc4.Address(str(context.default_sender))
     initial_price = context.any.arc4.uint64(max_value=int(10e6))
     initial_deposit = context.any.arc4.uint64(max_value=int(1e6))

{algorand_python_testing-0.3.0b4 → algorand_python_testing-0.3.0b5}/examples/scratch_storage/test_contract.py

@@ -35,7 +35,7 @@ def test_simple_contract(context: AlgopyTestContext) -> None:
     with context.txn.create_group(
         gtxns=[
             context.any.txn.application_call(
-                app_id=context.get_app_for_contract(contract), scratch_space=[0, 5, b"Hello World"]
+                app_id=context.ledger.get_app(contract), scratch_space=[0, 5, b"Hello World"]
             )
         ]
     ):

{algorand_python_testing-0.3.0b4 → algorand_python_testing-0.3.0b5}/examples/simple_voting/test_contract.py

@@ -36,7 +36,7 @@ def test_vote(context: AlgopyTestContext) -> None:
         gtxns=[
             context.any.txn.application_call(
                 sender=voter,
-                app_id=context.get_app_for_contract(contract),
+                app_id=context.ledger.get_app(contract),
                 app_args=[algopy.Bytes(b"vote"), voter.bytes],
             ),
             context.any.txn.payment(

{algorand_python_testing-0.3.0b4 → algorand_python_testing-0.3.0b5}/examples/zk_whitelist/test_contract.py

@@ -71,7 +71,7 @@ def test_add_address_to_whitelist_invalid_proof(
 @pytest.mark.usefixtures("context")
 def test_is_on_whitelist(context: AlgopyTestContext, contract: ZkWhitelistContract) -> None:
     # Arrange
-    dummy_account = context.any.account(opted_apps=[context.get_app_for_contract(contract)])
+    dummy_account = context.any.account(opted_apps=[context.ledger.get_app(contract)])
     contract.whitelist[dummy_account] = True
 
     # Act
@@ -84,7 +84,7 @@ def test_is_on_whitelist(context: AlgopyTestContext, contract: ZkWhitelistContra
 @pytest.mark.usefixtures("context")
 def test_is_not_on_whitelist(context: AlgopyTestContext, contract: ZkWhitelistContract) -> None:
     # Arrange
-    dummy_account = context.any.account(opted_apps=[context.get_app_for_contract(contract)])
+    dummy_account = context.any.account(opted_apps=[context.ledger.get_app(contract)])
     contract.whitelist[dummy_account] = False
 
     # Act

{algorand_python_testing-0.3.0b4 → algorand_python_testing-0.3.0b5}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "algorand-python-testing"
-version = "0.3.0-beta.4"
+version = "0.3.0-beta.5"
 description = 'Algorand Python testing library'
 readme = "README.md"
 requires-python = ">=3.12"

{algorand_python_testing-0.3.0b4 → algorand_python_testing-0.3.0b5}/src/algopy_testing/_context_helpers/ledger_context.py

@@ -138,18 +138,21 @@ class LedgerContext:
             raise ValueError("Asset not found in testing context!")
         self.asset_data[asset_id].update(asset_fields)
 
-    def get_app(self, app: algopy.UInt64 | int) -> algopy.Application:
-        """Get an application by ID.
+    def get_app(
+        self, app_id: algopy.Contract | algopy.Application | algopy.UInt64 | int
+    ) -> algopy.Application:
+        """Get an application by ID, contract or app reference.
 
         Args:
-            app (algopy.UInt64 | int): The application ID.
+            app_id (algopy.Contract | algopy.UInt64 | int): The application ID. If not provided as
+            int, auto extracts id from contract or app reference.
 
         Returns:
             algopy.Application: The application object.
         """
         import algopy
 
-        app_data = self._get_app_data(app)
+        app_data = self._get_app_data(app_id)
         return algopy.Application(app_data.app_id)
 
     def app_exists(self, app: algopy.UInt64 | int) -> bool:

{algorand_python_testing-0.3.0b4 → algorand_python_testing-0.3.0b5}/src/algopy_testing/_context_helpers/txn_context.py

@@ -118,6 +118,7 @@ class TransactionContext:
                 app_id=app_id,
                 arc4_signature=arc4_metadata.arc4_signature,
                 args=ordered_args,
+                allow_actions=arc4_metadata.allow_actions or [OnCompleteAction.NoOp],
             )
         # Handle bare methods
         else:

algorand_python_testing-0.3.0b5/src/algopy_testing/_mutable.py

@@ -0,0 +1,65 @@
+from __future__ import annotations
+
+import copy
+import typing
+
+if typing.TYPE_CHECKING:
+    from collections.abc import Callable
+
+TKey = typing.TypeVar("TKey")
+TItem = typing.TypeVar("TItem")
+
+
+class MutableBytes:
+    """Helper class to ensure mutable algopy types (currently ARC4 array, tuple and
+    structs) cascade their changes to parent container types (global/local state, boxes,
+    ARC4 array, tuple and structs)"""
+
+    def __init__(self) -> None:
+        # callback to call once when _value is modified
+        self._on_mutate: Callable[[typing.Any], None] | None = None
+
+    @property
+    def _value(self) -> bytes:
+        return self.__value
+
+    @_value.setter
+    def _value(self, value: bytes) -> None:
+        self.__value = value
+        if self._on_mutate:
+            self._on_mutate(self)
+        self._on_mutate = None
+
+    def copy(self) -> typing.Self:
+        # when copying a value discard the _on_mutate callback
+        clone = copy.deepcopy(self)
+        clone._on_mutate = None
+        return clone
+
+
+def set_item_on_mutate(container: object, index: object, value: TItem) -> TItem:
+    """Used to update a container-like type when an item is modified."""
+
+    def callback(new_value: TItem) -> None:
+        container[index] = new_value  # type: ignore[index]
+
+    return add_mutable_callback(callback, value)
+
+
+def set_attr_on_mutate(parent: object, name: str, value: TItem) -> TItem:
+    """Used to update an object-like type when an attr is modified."""
+
+    def callback(new_value: TItem) -> None:
+        setattr(parent, name, new_value)
+
+    return add_mutable_callback(callback, value)
+
+
+def add_mutable_callback(on_mutate: Callable[[typing.Any], None], value: TItem) -> TItem:
+    """Add on_mutate callback to value, if value is mutable.
+
+    Returns value to simplify usage
+    """
+    if isinstance(value, MutableBytes):
+        value._on_mutate = on_mutate
+    return value