feat: error transformers feature parity with utils-ts (#186)

* feat: error transformers feature parity with utils-ts

* chore: pip audit update for starlette

* ci: run check docs on 3.12

* chore: remove logging

* chore:  removes unused import

Removes an unused import from the transaction composer to address pr comment

Author: aorumbayev

.github/workflows/cd.yaml

@@ -26,10 +26,14 @@ jobs:
     name: Check Python
     uses: ./.github/workflows/check-python.yaml
 
+  ci-check-docs:
+    name: Check Documentation
+    uses: ./.github/workflows/check-docs.yaml
+
   ci-build-python:
     name: Build Python
     uses: ./.github/workflows/build-python.yaml
-    needs: ci-check-python
+    needs: [ci-check-python, ci-check-docs]
 
   release:
     name: Release Library

.github/workflows/check-docs.yaml

@@ -0,0 +1,30 @@
+name: Check Documentation
+
+on:
+  workflow_call:
+
+jobs:
+  check-docs:
+    runs-on: "ubuntu-latest"
+    steps:
+      - name: Checkout source code
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Set up Poetry
+        uses: ./.github/actions/setup-poetry
+
+      - name: Install dependencies
+        run: poetry install --no-interaction --no-root
+
+      - name: Check docstrings are up to date
+        run: poetry run poe docstrings-check
+
+      - name: Check docs are up to date
+        run: |
+          poetry run poe docs-md-only
+          git diff --exit-code ':!docs/markdown/autoapi/index.md' ':!docs/markdown/autoapi/algokit_utils/applications/app_factory/index.md' docs

.github/workflows/check-python.yaml

@@ -44,11 +44,3 @@ jobs:
 
       - name: Check types with mypy
         run: poetry run mypy
-
-      - name: Check docstrings are up to date
-        run: poetry run poe docstrings-check
-
-      - name: Check docs are up to date
-        run: |
-          poetry run poe docs-md-only
-          git diff --exit-code ':!docs/markdown/autoapi/index.md' ':!docs/markdown/autoapi/algokit_utils/applications/app_factory/index.md' docs

.github/workflows/pr.yaml

@@ -7,7 +7,11 @@ jobs:
     name: Check Python
     uses: ./.github/workflows/check-python.yaml
 
+  pr-check-docs:
+    name: Check Documentation
+    uses: ./.github/workflows/check-docs.yaml
+
   pr-build:
     name: Build and Test Python
-    needs: pr-check
+    needs: [pr-check, pr-check-docs]
     uses: ./.github/workflows/build-python.yaml

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: 2184a2c4a238de4631c46327e4a9da60
 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: ff13c5f34153f29e8728e11dcd3c0679
+config: 4f7050ca2baf67d0b4155492574876de
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/html/_sources/autoapi/algokit_utils/algorand/index.rst.txt

@@ -104,6 +104,25 @@ Module Contents
 
 
 
+   .. py:method:: register_error_transformer(transformer: algokit_utils.transactions.transaction_composer.ErrorTransformer) -> typing_extensions.Self
+
+      Register a function that will be used to transform an error caught when simulating or executing
+      composed transaction groups made from `new_group`
+
+      :param transformer: The error transformer function
+      :return: The AlgorandClient so you can chain method calls
+
+
+
+   .. py:method:: unregister_error_transformer(transformer: algokit_utils.transactions.transaction_composer.ErrorTransformer) -> typing_extensions.Self
+
+      Unregister an error transformer function
+
+      :param transformer: The error transformer function to remove
+      :return: The AlgorandClient so you can chain method calls
+
+
+
    .. py:method:: new_group() -> algokit_utils.transactions.transaction_composer.TransactionComposer
 
       Start a new `TransactionComposer` transaction group

docs/html/_sources/autoapi/algokit_utils/applications/enums/index.rst.txt

@@ -17,7 +17,7 @@ Classes
 Module Contents
 ---------------
 
-.. py:class:: OnSchemaBreak
+.. py:class:: OnSchemaBreak(*args, **kwds)
 
    Bases: :py:obj:`enum.Enum`
 
@@ -49,7 +49,7 @@ Module Contents
 
 
 
-.. py:class:: OnUpdate
+.. py:class:: OnUpdate(*args, **kwds)
 
    Bases: :py:obj:`enum.Enum`
 
@@ -89,7 +89,7 @@ Module Contents
 
 
 
-.. py:class:: OperationPerformed
+.. py:class:: OperationPerformed(*args, **kwds)
 
    Bases: :py:obj:`enum.Enum`
 

docs/html/_sources/autoapi/algokit_utils/protocols/typed_clients/index.rst.txt

@@ -30,7 +30,9 @@ Module Contents
                ...
 
    Such classes are primarily used with static type checkers that recognize
-   structural subtyping (static duck-typing), for example::
+   structural subtyping (static duck-typing).
+
+   For example::
 
        class C:
            def meth(self) -> int:
@@ -46,7 +48,7 @@ Module Contents
    only the presence of given attributes, ignoring their type signatures.
    Protocol classes can be generic, they are defined as::
 
-       class GenProto(Protocol[T]):
+       class GenProto[T](Protocol):
            def meth(self) -> T:
                ...
 
@@ -75,7 +77,9 @@ Module Contents
                ...
 
    Such classes are primarily used with static type checkers that recognize
-   structural subtyping (static duck-typing), for example::
+   structural subtyping (static duck-typing).
+
+   For example::
 
        class C:
            def meth(self) -> int:
@@ -91,7 +95,7 @@ Module Contents
    only the presence of given attributes, ignoring their type signatures.
    Protocol classes can be generic, they are defined as::
 
-       class GenProto(Protocol[T]):
+       class GenProto[T](Protocol):
            def meth(self) -> T:
                ...
 

docs/html/_sources/autoapi/algokit_utils/transactions/transaction_composer/index.rst.txt

@@ -9,6 +9,7 @@ Attributes
 
 .. autoapisummary::
 
+   algokit_utils.transactions.transaction_composer.ErrorTransformer
    algokit_utils.transactions.transaction_composer.MethodCallParams
    algokit_utils.transactions.transaction_composer.AppMethodCallTransactionArgument
    algokit_utils.transactions.transaction_composer.TxnParams
@@ -58,6 +59,8 @@ Functions
 Module Contents
 ---------------
 
+.. py:data:: ErrorTransformer
+
 .. py:class:: PaymentParams
 
    Bases: :py:obj:`_CommonTxnParams`
@@ -1118,7 +1121,7 @@ Module Contents
    :raises error: If there is an error from the Algorand node
 
 
-.. py:class:: TransactionComposer(algod: algosdk.v2client.algod.AlgodClient, get_signer: collections.abc.Callable[[str], algosdk.atomic_transaction_composer.TransactionSigner], get_suggested_params: collections.abc.Callable[[], algosdk.transaction.SuggestedParams] | None = None, default_validity_window: int | None = None, app_manager: algokit_utils.applications.app_manager.AppManager | None = None)
+.. py:class:: TransactionComposer(algod: algosdk.v2client.algod.AlgodClient, get_signer: collections.abc.Callable[[str], algosdk.atomic_transaction_composer.TransactionSigner], get_suggested_params: collections.abc.Callable[[], algosdk.transaction.SuggestedParams] | None = None, default_validity_window: int | None = None, app_manager: algokit_utils.applications.app_manager.AppManager | None = None, error_transformers: list[ErrorTransformer] | None = None)
 
    A class for composing and managing Algorand transactions.
 
@@ -1131,6 +1134,16 @@ Module Contents
        defaults to using algod.suggested_params()
    :param default_validity_window: Optional default validity window for transactions in rounds, defaults to 10
    :param app_manager: Optional AppManager instance for compiling TEAL programs, defaults to None
+   :param error_transformers: Optional list of error transformers to use when an error is caught in simulate or send
+
+
+   .. py:method:: register_error_transformer(transformer: ErrorTransformer) -> TransactionComposer
+
+      Register a function that will be used to transform an error caught when simulating or sending.
+
+      :param transformer: The error transformer function
+      :return: The composer so you can chain method calls
+
 
 
    .. py:method:: add_transaction(transaction: algosdk.transaction.Transaction, signer: algosdk.atomic_transaction_composer.TransactionSigner | None = None) -> TransactionComposer
@@ -1555,7 +1568,7 @@ Module Contents
 
       :param params: Parameters for the send operation
       :return: The transaction send results
-      :raises Exception: If the transaction fails
+      :raises self._transform_error: If the transaction fails (may be transformed by error transformers)