feat: Add abi property for ContractFunction #3664
Conversation
tibor-reiss
force-pushed
the
i3626_add_abi_attributes
branch
from
72d1592 to
a0cfd6d
Compare
web3/contract/base_contract.py
Outdated
| @property | ||
| def state_mutability(self) -> Optional[str]: | ||
| if self.abi is None: | ||
| return None |
There was a problem hiding this comment.
This or raise Web3TypeError?
web3/contract/base_contract.py
Outdated
| @@ -596,6 +596,12 @@ def __init__(self, abi: Optional[ABIFunction] = None) -> None: | |||
| self.argument_names = tuple([input.get("name", None) for input in event_inputs]) | |||
| self.argument_types = tuple([input["type"] for input in event_inputs]) | |||
|
|
|||
| @property | |||
| def state_mutability(self) -> Optional[str]: | |||
| if self.abi is None: | |||
There was a problem hiding this comment.
On l595, there is self.abi.get(...) which will fail if abi == None. Is this intended please? Because if we accept that abi cannot be None, I do not need this check here.
There was a problem hiding this comment.
Great callout here, it is expected that the class instance will always have a value for abi. This works because the contract initialization uses the ContractFunction factory method. I think it should be fine to remove this check and implement better error handling in the __init__ function itself.
Right now, if someone attempts to create a ContractFunction() without passing an abi, it will throw an AttributeError. While tangential to your change, it would be better to check if self.abi is None and raise a Web3AttributeError at that time.
There was a problem hiding this comment.
This seems to work in __init__ - let me know please if I should include it in this PR:
if abi:
self.abi = abi
if self.abi is None:
raise Web3AttributeError
|
Hi @reedsa, is this implementation on the right track please? If yes, I can try to add the others, except |
Looking good! Appreciate your contribution and it will be great to see all the other properties added. |
tibor-reiss
force-pushed
the
i3626_add_abi_attributes
branch
from
a0cfd6d to
72e9265
Compare
tibor-reiss
force-pushed
the
i3626_add_abi_attributes
branch
from
72e9265 to
8675245
Compare
tibor-reiss
force-pushed
the
i3626_add_abi_attributes
branch
2 times, most recently
from
0df8cd1 to
b16de95
Compare
Hi @reedsa, thanks for feedback, I added the non-deprecated attributes. The failing tests work locally - could this be a CI problem? |
What was wrong?
Before:
foo_contract.functions.setBar.abi["stateMutability"] == "nonpayable"After:
foo_contract.functions.setBar.state_mutability == "nonpayable"Related to Issue #3626
How was it fixed?
Add state_mutability property.
Todo:
Cute Animal Picture