Skip to content
Algorand Python Testing

algopy_testing.decorators.arc4

Module Contents

Section titled “Module Contents”

Classes

Section titled “Classes”
MethodMetadata

Functions

Section titled “Functions”
set_arc4_metadata(→ None)
maybe_arc4_metadata(→ MethodMetadataNone)
get_arc4_metadata(→ MethodMetadata)
get_ordered_args(→ list[Any])
check_routing_conditions(→ None)
abimethod(…)
create_abimethod_txns(→ list[algopy.gtxn.TransactionBase])
get_active_txn_fields() → dict[str, Any])
create_baremethod_txns(→ list[algopy.gtxn.TransactionBase])
baremethod(…)

Data

Section titled “Data”
ARC4_METADATA_ATTR

ARC4_METADATA_ATTR = ‘arc4_metadata’

Section titled “ARC4_METADATA_ATTR = ‘arc4_metadata’”

class MethodMetadata

Section titled “class MethodMetadata”

create : _CreateValues

Section titled “create : _CreateValues”

allow_actions : Sequence[_AllowActions]

Section titled “allow_actions : Sequence[_AllowActions]”

arc4_signature : str | None = None

Section titled “arc4_signature : str | None = None”

resource_encoding : _ResourceEncoding = ‘value’

Section titled “resource_encoding : _ResourceEncoding = ‘value’”

property is_create : bool

Section titled “property is_create : bool”

set_arc4_metadata(fn: object, data: MethodMetadata) → None

Section titled “set_arc4_metadata(fn: object, data: MethodMetadata) → None”

maybe_arc4_metadata(fn: object) → MethodMetadata | None

Section titled “maybe_arc4_metadata(fn: object) → MethodMetadata | None”

get_arc4_metadata(fn: object) → MethodMetadata

Section titled “get_arc4_metadata(fn: object) → MethodMetadata”

get_ordered_args(_fn: Callable[Ellipsis, Any], app_args: Sequence[Any], kwargs: dict[str, Any]) → list[Any]

Section titled “get_ordered_args(_fn: Callable[Ellipsis, Any], app_args: Sequence[Any], kwargs: dict[str, Any]) → list[Any]”

check_routing_conditions(app_id: int, metadata: MethodMetadata) → None

Section titled “check_routing_conditions(app_id: int, metadata: MethodMetadata) → None”

abimethod(fn: Callable[_P, _R]) → Callable[_P, _R]

Section titled “abimethod(fn: Callable[_P, _R]) → Callable[_P, _R]”

abimethod(name: str | None = None, create: _CreateValues = ‘disallow’, allow_actions: Sequence[_AllowActions] = (‘NoOp’), readonly: bool = False, default_args: Mapping[str, str | object] | None = None) → Callable[[collections.abc.Callable[_P, _R]], Callable[_P, _R]]

Section titled “abimethod(name: str | None = None, create: _CreateValues = ‘disallow’, allow_actions: Sequence[_AllowActions] = (‘NoOp’), readonly: bool = False, default_args: Mapping[str, str | object] | None = None) → Callable[[collections.abc.Callable[_P, _R]], Callable[_P, _R]]”

create_abimethod_txns(app_id: int, arc4_signature: str, args: Sequence[object], allow_actions: Sequence[_AllowActions], resource_encoding: _ResourceEncoding) → list[algopy.gtxn.TransactionBase]

Section titled “create_abimethod_txns(app_id: int, arc4_signature: str, args: Sequence[object], allow_actions: Sequence[_AllowActions], resource_encoding: _ResourceEncoding) → list[algopy.gtxn.TransactionBase]”

get_active_txn_fields(app: algopy.Application, allow_actions: Sequence[_AllowActions] = ()) → dict[str, Any]

Section titled “get_active_txn_fields(app: algopy.Application, allow_actions: Sequence[_AllowActions] = ()) → dict[str, Any]”

create_baremethod_txns(app_id: int, allow_actions: Sequence[_AllowActions]) → list[algopy.gtxn.TransactionBase]

Section titled “create_baremethod_txns(app_id: int, allow_actions: Sequence[_AllowActions]) → list[algopy.gtxn.TransactionBase]”

baremethod(fn: Callable[_P, _R]) → Callable[_P, _R]

Section titled “baremethod(fn: Callable[_P, _R]) → Callable[_P, _R]”

baremethod(create: Literal[‘allow’, ‘require’, ‘disallow’] = ‘disallow’, allow_actions: Sequence[algopy.OnCompleteAction | Literal[‘NoOp’, ‘OptIn’, ‘CloseOut’, ‘UpdateApplication’, ‘DeleteApplication’]] = (‘NoOp’)) → Callable[[Callable[_P, _R]], Callable[_P, _R]]

Section titled “baremethod(create: Literal[‘allow’, ‘require’, ‘disallow’] = ‘disallow’, allow_actions: Sequence[algopy.OnCompleteAction | Literal[‘NoOp’, ‘OptIn’, ‘CloseOut’, ‘UpdateApplication’, ‘DeleteApplication’]] = (‘NoOp’)) → Callable[[Callable[_P, _R]], Callable[_P, _R]]”