chore: align argument name in set signer from account with ts interface (#147)

Author: aorumbayev

docs/html/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 4f7050ca2baf67d0b4155492574876de
+config: ec069b93d02ecd85de7d7cee84c8e8ad
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/html/.buildinfo.bak

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: d1acb0d0270d6bf9bfbb3d142ec2b085
+config: a5e8f79f249a3478231c88d6f5755ce4
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/html/_sources/autoapi/algokit_utils/accounts/account_manager/index.rst.txt

@@ -363,20 +363,36 @@ Module Contents
 
 
    .. py:method:: set_signer_from_account(account: algokit_utils.protocols.account.TransactionSignerAccountProtocol) -> typing_extensions.Self
+                  set_signer_from_account(signer: algokit_utils.protocols.account.TransactionSignerAccountProtocol) -> typing_extensions.Self
 
       Tracks the given account for later signing.
 
       Note: If you are generating accounts via the various methods on `AccountManager`
       (like `random`, `from_mnemonic`, `logic_sig`, etc.) then they automatically get tracked.
 
-      :param account: The account to register
+      The method accepts either a positional argument or a keyword argument named 'account' or 'signer'.
+      The 'signer' parameter is deprecated and will show a warning when used.
+
+      :param *args: Variable positional arguments. The first argument should be a TransactionSignerAccountProtocol.
+      :param **kwargs: Variable keyword arguments. Can include 'account' or 'signer' (deprecated) as
+          TransactionSignerAccountProtocol.
       :returns: The `AccountManager` instance for method chaining
+      :raises ValueError: If no account or signer argument is provided
 
       :example:
           >>> account_manager = AccountManager(client_manager)
-          >>> account_manager.set_signer_from_account(SigningAccount(private_key=algosdk.account.generate_account()[0]))
-          >>> account_manager.set_signer_from_account(LogicSigAccount(AlgosdkLogicSigAccount(program, args)))
-          >>> account_manager.set_signer_from_account(MultiSigAccount(multisig_params, [account1, account2]))
+          >>> # Using positional argument
+          >>> account_manager.set_signer_from_account(
+          ...     SigningAccount(private_key=algosdk.account.generate_account()[0])
+          ... )
+          >>> # Using keyword argument 'account'
+          >>> account_manager.set_signer_from_account(
+          ...     account=LogicSigAccount(AlgosdkLogicSigAccount(program, args))
+          ... )
+          >>> # Using deprecated keyword argument 'signer'
+          >>> account_manager.set_signer_from_account(
+          ...     signer=MultiSigAccount(multisig_params, [account1, account2])
+          ... )
 
 
 

docs/html/autoapi/algokit_utils/accounts/account_manager/index.html

@@ -645,21 +645,43 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to
 <dl class="py method">
 <dt class="sig sig-object py" id="algokit_utils.accounts.account_manager.AccountManager.set_signer_from_account">
 <span class="sig-name descname"><span class="pre">set_signer_from_account</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">account</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../../protocols/account/index.html#algokit_utils.protocols.account.TransactionSignerAccountProtocol" title="algokit_utils.protocols.account.TransactionSignerAccountProtocol"><span class="pre">algokit_utils.protocols.account.TransactionSignerAccountProtocol</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">typing_extensions.Self</span></span></span><a class="headerlink" href="#algokit_utils.accounts.account_manager.AccountManager.set_signer_from_account" title="Link to this definition">¶</a></dt>
+<dt class="sig sig-object py">
+<span class="sig-name descname"><span class="pre">set_signer_from_account</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">signer</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../../protocols/account/index.html#algokit_utils.protocols.account.TransactionSignerAccountProtocol" title="algokit_utils.protocols.account.TransactionSignerAccountProtocol"><span class="pre">algokit_utils.protocols.account.TransactionSignerAccountProtocol</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">typing_extensions.Self</span></span></span></dt>
 <dd><p>Tracks the given account for later signing.</p>
 <p>Note: If you are generating accounts via the various methods on <cite>AccountManager</cite>
 (like <cite>random</cite>, <cite>from_mnemonic</cite>, <cite>logic_sig</cite>, etc.) then they automatically get tracked.</p>
+<p>The method accepts either a positional argument or a keyword argument named ‘account’ or ‘signer’.
+The ‘signer’ parameter is deprecated and will show a warning when used.</p>
 <dl class="field-list">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
-<dd class="field-odd"><p><strong>account</strong> – The account to register</p>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>*args</strong> – <p>Variable positional arguments. The first argument should be a TransactionSignerAccountProtocol.</p>
+</p></li>
+<li><p><strong>**kwargs</strong> – <p>Variable keyword arguments. Can include ‘account’ or ‘signer’ (deprecated) as
+TransactionSignerAccountProtocol.</p>
+</p></li>
+</ul>
 </dd>
 <dt class="field-even">Returns<span class="colon">:</span></dt>
 <dd class="field-even"><p>The <cite>AccountManager</cite> instance for method chaining</p>
 </dd>
-<dt class="field-odd">Example<span class="colon">:</span></dt>
-<dd class="field-odd"><div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">account_manager</span> <span class="o">=</span> <span class="n">AccountManager</span><span class="p">(</span><span class="n">client_manager</span><span class="p">)</span>
-<span class="gp">&gt;&gt;&gt; </span><span class="n">account_manager</span><span class="o">.</span><span class="n">set_signer_from_account</span><span class="p">(</span><span class="n">SigningAccount</span><span class="p">(</span><span class="n">private_key</span><span class="o">=</span><span class="n">algosdk</span><span class="o">.</span><span class="n">account</span><span class="o">.</span><span class="n">generate_account</span><span class="p">()[</span><span class="mi">0</span><span class="p">]))</span>
-<span class="gp">&gt;&gt;&gt; </span><span class="n">account_manager</span><span class="o">.</span><span class="n">set_signer_from_account</span><span class="p">(</span><span class="n">LogicSigAccount</span><span class="p">(</span><span class="n">AlgosdkLogicSigAccount</span><span class="p">(</span><span class="n">program</span><span class="p">,</span> <span class="n">args</span><span class="p">)))</span>
-<span class="gp">&gt;&gt;&gt; </span><span class="n">account_manager</span><span class="o">.</span><span class="n">set_signer_from_account</span><span class="p">(</span><span class="n">MultiSigAccount</span><span class="p">(</span><span class="n">multisig_params</span><span class="p">,</span> <span class="p">[</span><span class="n">account1</span><span class="p">,</span> <span class="n">account2</span><span class="p">]))</span>
+<dt class="field-odd">Raises<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>ValueError</strong> – If no account or signer argument is provided</p>
+</dd>
+<dt class="field-even">Example<span class="colon">:</span></dt>
+<dd class="field-even"><div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">account_manager</span> <span class="o">=</span> <span class="n">AccountManager</span><span class="p">(</span><span class="n">client_manager</span><span class="p">)</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="c1"># Using positional argument</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="n">account_manager</span><span class="o">.</span><span class="n">set_signer_from_account</span><span class="p">(</span>
+<span class="gp">... </span>    <span class="n">SigningAccount</span><span class="p">(</span><span class="n">private_key</span><span class="o">=</span><span class="n">algosdk</span><span class="o">.</span><span class="n">account</span><span class="o">.</span><span class="n">generate_account</span><span class="p">()[</span><span class="mi">0</span><span class="p">])</span>
+<span class="gp">... </span><span class="p">)</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="c1"># Using keyword argument &#39;account&#39;</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="n">account_manager</span><span class="o">.</span><span class="n">set_signer_from_account</span><span class="p">(</span>
+<span class="gp">... </span>    <span class="n">account</span><span class="o">=</span><span class="n">LogicSigAccount</span><span class="p">(</span><span class="n">AlgosdkLogicSigAccount</span><span class="p">(</span><span class="n">program</span><span class="p">,</span> <span class="n">args</span><span class="p">))</span>
+<span class="gp">... </span><span class="p">)</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="c1"># Using deprecated keyword argument &#39;signer&#39;</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="n">account_manager</span><span class="o">.</span><span class="n">set_signer_from_account</span><span class="p">(</span>
+<span class="gp">... </span>    <span class="n">signer</span><span class="o">=</span><span class="n">MultiSigAccount</span><span class="p">(</span><span class="n">multisig_params</span><span class="p">,</span> <span class="p">[</span><span class="n">account1</span><span class="p">,</span> <span class="n">account2</span><span class="p">])</span>
+<span class="gp">... </span><span class="p">)</span>
 </pre></div>
 </div>
 </dd>

docs/html/searchindex.js

@@ -220,21 +220,43 @@ Merges the given AccountManager into this one.
 
 #### set_signer_from_account(account: [algokit_utils.protocols.account.TransactionSignerAccountProtocol](../../protocols/account/index.md#algokit_utils.protocols.account.TransactionSignerAccountProtocol)) → typing_extensions.Self
 
+#### set_signer_from_account(signer: [algokit_utils.protocols.account.TransactionSignerAccountProtocol](../../protocols/account/index.md#algokit_utils.protocols.account.TransactionSignerAccountProtocol)) → typing_extensions.Self
+
 Tracks the given account for later signing.
 
 Note: If you are generating accounts via the various methods on AccountManager
 (like random, from_mnemonic, logic_sig, etc.) then they automatically get tracked.
 
+The method accepts either a positional argument or a keyword argument named ‘account’ or ‘signer’.
+The ‘signer’ parameter is deprecated and will show a warning when used.
+
 * **Parameters:**
-  **account** – The account to register
+  * **\*args** – 
+
+    Variable positional arguments. The first argument should be a TransactionSignerAccountProtocol.
+  * **\*\*kwargs** – 
+
+    Variable keyword arguments. Can include ‘account’ or ‘signer’ (deprecated) as
+    TransactionSignerAccountProtocol.
 * **Returns:**
   The AccountManager instance for method chaining
+* **Raises:**
+  **ValueError** – If no account or signer argument is provided
 * **Example:**
   ```pycon
   >>> account_manager = AccountManager(client_manager)
-  >>> account_manager.set_signer_from_account(SigningAccount(private_key=algosdk.account.generate_account()[0]))
-  >>> account_manager.set_signer_from_account(LogicSigAccount(AlgosdkLogicSigAccount(program, args)))
-  >>> account_manager.set_signer_from_account(MultiSigAccount(multisig_params, [account1, account2]))
+  >>> # Using positional argument
+  >>> account_manager.set_signer_from_account(
+  ...     SigningAccount(private_key=algosdk.account.generate_account()[0])
+  ... )
+  >>> # Using keyword argument 'account'
+  >>> account_manager.set_signer_from_account(
+  ...     account=LogicSigAccount(AlgosdkLogicSigAccount(program, args))
+  ... )
+  >>> # Using deprecated keyword argument 'signer'
+  >>> account_manager.set_signer_from_account(
+  ...     signer=MultiSigAccount(multisig_params, [account1, account2])
+  ... )
   ```
 
 #### get_signer(sender: str | [algokit_utils.protocols.account.TransactionSignerAccountProtocol](../../protocols/account/index.md#algokit_utils.protocols.account.TransactionSignerAccountProtocol)) → algosdk.atomic_transaction_composer.TransactionSigner

docs/markdown/autoapi/algokit_utils/accounts/account_manager/index.md

@@ -1,14 +1,14 @@
 import os
 from collections.abc import Callable
 from dataclasses import dataclass
-from typing import Any
+from typing import Any, overload
 
 import algosdk
 from algosdk import mnemonic
 from algosdk.atomic_transaction_composer import TransactionSigner
 from algosdk.mnemonic import to_private_key
 from algosdk.transaction import SuggestedParams
-from typing_extensions import Self
+from typing_extensions import Self, deprecated
 
 from algokit_utils.accounts.kmd_account_manager import KmdAccountManager
 from algokit_utils.clients.client_manager import ClientManager
@@ -215,6 +215,7 @@ def set_signers(self, *, another_account_manager: "AccountManager", overwrite_ex
         )
         return self
 
+    @overload
     def set_signer_from_account(self, account: TransactionSignerAccountProtocol) -> Self:
         """
         Tracks the given account for later signing.
@@ -227,11 +228,80 @@ def set_signer_from_account(self, account: TransactionSignerAccountProtocol) ->
 
         :example:
             >>> account_manager = AccountManager(client_manager)
-            >>> account_manager.set_signer_from_account(SigningAccount(private_key=algosdk.account.generate_account()[0]))
+            >>> account_manager.set_signer_from_account(
+            ...     SigningAccount(private_key=algosdk.account.generate_account()[0])
+            ... )
             >>> account_manager.set_signer_from_account(LogicSigAccount(AlgosdkLogicSigAccount(program, args)))
             >>> account_manager.set_signer_from_account(MultiSigAccount(multisig_params, [account1, account2]))
-        """  # noqa: E501
-        self._accounts[account.address] = account
+        """
+
+    @overload
+    @deprecated("Use set_signer_from_account(account) instead of set_signer_from_account(signer)")
+    def set_signer_from_account(self, signer: TransactionSignerAccountProtocol) -> Self:
+        """
+        Tracks the given account for later signing.
+
+        Note: If you are generating accounts via the various methods on `AccountManager`
+        (like `random`, `from_mnemonic`, `logic_sig`, etc.) then they automatically get tracked.
+
+        :param signer: The account to register (deprecated, use account parameter instead)
+        :returns: The `AccountManager` instance for method chaining
+
+        :example:
+            >>> account_manager = AccountManager(client_manager)
+            >>> account_manager.set_signer_from_account(
+            ...     SigningAccount(private_key=algosdk.account.generate_account()[0])
+            ... )
+            >>> account_manager.set_signer_from_account(LogicSigAccount(AlgosdkLogicSigAccount(program, args)))
+            >>> account_manager.set_signer_from_account(MultiSigAccount(multisig_params, [account1, account2]))
+        """
+
+    def set_signer_from_account(
+        self,
+        *args: TransactionSignerAccountProtocol,
+        **kwargs: TransactionSignerAccountProtocol,
+    ) -> Self:
+        """
+        Tracks the given account for later signing.
+
+        Note: If you are generating accounts via the various methods on `AccountManager`
+        (like `random`, `from_mnemonic`, `logic_sig`, etc.) then they automatically get tracked.
+
+        The method accepts either a positional argument or a keyword argument named 'account' or 'signer'.
+        The 'signer' parameter is deprecated and will show a warning when used.
+
+        :param *args: Variable positional arguments. The first argument should be a TransactionSignerAccountProtocol.
+        :param **kwargs: Variable keyword arguments. Can include 'account' or 'signer' (deprecated) as
+            TransactionSignerAccountProtocol.
+        :returns: The `AccountManager` instance for method chaining
+        :raises ValueError: If no account or signer argument is provided
+
+        :example:
+            >>> account_manager = AccountManager(client_manager)
+            >>> # Using positional argument
+            >>> account_manager.set_signer_from_account(
+            ...     SigningAccount(private_key=algosdk.account.generate_account()[0])
+            ... )
+            >>> # Using keyword argument 'account'
+            >>> account_manager.set_signer_from_account(
+            ...     account=LogicSigAccount(AlgosdkLogicSigAccount(program, args))
+            ... )
+            >>> # Using deprecated keyword argument 'signer'
+            >>> account_manager.set_signer_from_account(
+            ...     signer=MultiSigAccount(multisig_params, [account1, account2])
+            ... )
+        """
+        # Extract the account from either positional args or keyword args
+        if args:
+            account_obj = args[0]
+        elif "account" in kwargs:
+            account_obj = kwargs["account"]
+        elif "signer" in kwargs:
+            account_obj = kwargs["signer"]
+        else:
+            raise ValueError("Missing required argument: either 'account' or 'signer'")
+
+        self._accounts[account_obj.address] = account_obj
         return self
 
     def get_signer(self, sender: str | TransactionSignerAccountProtocol) -> TransactionSigner:

poetry.lock

@@ -144,8 +144,8 @@ def _process_dispenser_request(
     @overload
     def fund(self, address: str, amount: int) -> DispenserFundResponse: ...
 
-    @deprecated("Asset ID parameter is deprecated. Can now use `fund(address, amount)` instead.")
     @overload
+    @deprecated("Asset ID parameter is deprecated. Can now use `fund(address, amount)` instead.")
     def fund(self, address: str, amount: int, asset_id: int | None = None) -> DispenserFundResponse: ...
 
     def fund(self, address: str, amount: int, asset_id: int | None = None) -> DispenserFundResponse:  # noqa: ARG002