Skip to content

Commit 88b269f

Browse files
author
pacrob
committed
change decode_tuples default from None to False, fix docs typos
1 parent 4fdc55f commit 88b269f

File tree

5 files changed

+12
-12
lines changed

5 files changed

+12
-12
lines changed

docs/web3.contract.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -152,14 +152,14 @@ Each Contract Factory exposes the following properties.
152152
If a Tuple/Struct is returned by a contract function, this flag defines whether
153153
to apply the field names from the ABI to the returned data.
154154
If False, the returned value will be a normal Python `Tuple`. If True, the returned
155-
value will be a Python `NamedTuple` of the name `ABIDecodedNamedTuple`.
155+
value will be a Python `NamedTuple` of the class `ABIDecodedNamedTuple`.
156156

157157
NamedTuples have some restrictions regarding field names.
158-
Web3.py sets `NamedTuple`'s `rename=True`, so disallowed field names my be
158+
Web3.py sets `NamedTuple`'s `rename=True`, so disallowed field names may be
159159
different than expected. See the [Python docs](https://docs.python.org/3/library/collections.html#collections.namedtuple)
160160
for more information.
161161

162-
May be ``None`` if not provided during factory creation.
162+
Defaults to ``False`` if not provided during factory creation.
163163

164164

165165
.. py:attribute:: Contract.functions

web3/contract/async_contract.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ def __init__(
7979
abi: ABI,
8080
w3: "Web3",
8181
address: Optional[ChecksumAddress] = None,
82-
decode_tuples: Optional[bool] = None,
82+
decode_tuples: Optional[bool] = False,
8383
) -> None:
8484
super().__init__(abi, w3, AsyncContractFunction, address, decode_tuples)
8585

@@ -474,7 +474,7 @@ def __init__(
474474
transaction: Optional[TxParams] = None,
475475
block_identifier: BlockIdentifier = "latest",
476476
ccip_read_enabled: Optional[bool] = None,
477-
decode_tuples: Optional[bool] = None,
477+
decode_tuples: Optional[bool] = False,
478478
) -> None:
479479
super().__init__(
480480
abi=abi,

web3/contract/base_contract.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -436,7 +436,7 @@ def __init__(
436436
w3: "Web3",
437437
contract_function_class: Type["BaseContractFunction"],
438438
address: Optional[ChecksumAddress] = None,
439-
decode_tuples: Optional[bool] = None,
439+
decode_tuples: Optional[bool] = False,
440440
) -> None:
441441
self.abi = abi
442442
self.w3 = w3
@@ -671,7 +671,7 @@ class BaseContractFunction:
671671
abi: ABIFunction = None
672672
transaction: TxParams = None
673673
arguments: Tuple[Any, ...] = None
674-
decode_tuples: Optional[bool] = None
674+
decode_tuples: Optional[bool] = False
675675
args: Any = None
676676
kwargs: Any = None
677677

@@ -1090,7 +1090,7 @@ def __init__(
10901090
transaction: Optional[TxParams] = None,
10911091
block_identifier: BlockIdentifier = "latest",
10921092
ccip_read_enabled: Optional[bool] = None,
1093-
decode_tuples: Optional[bool] = None,
1093+
decode_tuples: Optional[bool] = False,
10941094
) -> None:
10951095
self.w3 = w3
10961096
self.address = address

web3/contract/contract.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ def __init__(
7979
abi: ABI,
8080
w3: "Web3",
8181
address: Optional[ChecksumAddress] = None,
82-
decode_tuples: Optional[bool] = None,
82+
decode_tuples: Optional[bool] = False,
8383
) -> None:
8484
super().__init__(abi, w3, ContractFunction, address, decode_tuples)
8585

@@ -468,7 +468,7 @@ def __init__(
468468
transaction: Optional[TxParams] = None,
469469
block_identifier: BlockIdentifier = "latest",
470470
ccip_read_enabled: Optional[bool] = None,
471-
decode_tuples: Optional[bool] = None,
471+
decode_tuples: Optional[bool] = False,
472472
) -> None:
473473
super().__init__(
474474
abi=abi,

web3/contract/utils.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ def call_contract_function(
7272
fn_abi: Optional[ABIFunction] = None,
7373
state_override: Optional[CallOverride] = None,
7474
ccip_read_enabled: Optional[bool] = None,
75-
decode_tuples: Optional[bool] = None,
75+
decode_tuples: Optional[bool] = False,
7676
*args: Any,
7777
**kwargs: Any,
7878
) -> Any:
@@ -280,7 +280,7 @@ async def async_call_contract_function(
280280
fn_abi: Optional[ABIFunction] = None,
281281
state_override: Optional[CallOverride] = None,
282282
ccip_read_enabled: Optional[bool] = None,
283-
decode_tuples: Optional[bool] = None,
283+
decode_tuples: Optional[bool] = False,
284284
*args: Any,
285285
**kwargs: Any,
286286
) -> Any:

0 commit comments

Comments
 (0)