Skip to content

Commit 0d9f493

Browse files
linda-le1linda-le1
committed
Snakecase more fromBlock and toBlock
1 parent 116f049 commit 0d9f493

File tree

6 files changed

+61
-57
lines changed

6 files changed

+61
-57
lines changed

‎tests/core/filtering/test_filters_against_many_blocks.py

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,9 @@ def test_event_filter_new_events(
5151
builder.fromBlock = "latest"
5252
event_filter = builder.deploy(w3)
5353
else:
54-
event_filter = emitter.events.LogNoArguments().create_filter(from_block="latest")
54+
event_filter = emitter.events.LogNoArguments().create_filter(
55+
from_block="latest"
56+
)
5557

5658
expected_match_counter = 0
5759

@@ -138,7 +140,9 @@ def gen_non_matching_transact():
138140
builder.fromBlock = "latest"
139141
event_filter = builder.deploy(w3)
140142
else:
141-
event_filter = emitter.events.LogNoArguments().create_filter(from_block="latest")
143+
event_filter = emitter.events.LogNoArguments().create_filter(
144+
from_block="latest"
145+
)
142146

143147
expected_match_counter = 0
144148

‎web3/_utils/events.py

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -312,8 +312,8 @@ def is_indexed(arg: Any) -> bool:
312312

313313
class EventFilterBuilder:
314314
formatter = None
315-
_fromBlock = None
316-
_toBlock = None
315+
_from_block = None
316+
_to_block = None
317317
_address = None
318318
_immutable = False
319319

@@ -333,30 +333,30 @@ def __init__(
333333
self._ordered_arg_names = tuple(arg["name"] for arg in event_abi["inputs"])
334334

335335
@property
336-
def fromBlock(self) -> BlockIdentifier:
337-
return self._fromBlock
336+
def from_block(self) -> BlockIdentifier:
337+
return self._from_block
338338

339-
@fromBlock.setter
340-
def fromBlock(self, value: BlockIdentifier) -> None:
341-
if self._fromBlock is None and not self._immutable:
342-
self._fromBlock = value
339+
@from_block.setter
340+
def from_block(self, value: BlockIdentifier) -> None:
341+
if self._from_block is None and not self._immutable:
342+
self._from_block = value
343343
else:
344344
raise ValueError(
345-
f"fromBlock is already set to {self._fromBlock!r}. "
345+
f"from_block is already set to {self._from_block!r}. "
346346
"Resetting filter parameters is not permitted"
347347
)
348348

349349
@property
350-
def toBlock(self) -> BlockIdentifier:
351-
return self._toBlock
350+
def to_block(self) -> BlockIdentifier:
351+
return self._to_block
352352

353-
@toBlock.setter
354-
def toBlock(self, value: BlockIdentifier) -> None:
355-
if self._toBlock is None and not self._immutable:
356-
self._toBlock = value
353+
@to_block.setter
354+
def to_block(self, value: BlockIdentifier) -> None:
355+
if self._to_block is None and not self._immutable:
356+
self._to_block = value
357357
else:
358358
raise ValueError(
359-
f"toBlock is already set to {self._toBlock!r}. "
359+
f"to_block is already set to {self._to_block!r}. "
360360
"Resetting filter parameters is not permitted"
361361
)
362362

@@ -404,8 +404,8 @@ def data_argument_values(self) -> Tuple[Any, ...]:
404404
def filter_params(self) -> FilterParams:
405405
params = {
406406
"topics": self.topics,
407-
"fromBlock": self.fromBlock,
408-
"toBlock": self.toBlock,
407+
"from_block": self.from_block,
408+
"to_block": self.to_block,
409409
"address": self.address,
410410
}
411411
return valfilter(lambda x: x is not None, params)

‎web3/_utils/filters.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -116,10 +116,10 @@ def construct_event_filter_params(
116116
validate_address(filter_params["address"])
117117

118118
if from_block is not None:
119-
filter_params["fromBlock"] = from_block
119+
filter_params["from_block"] = from_block
120120

121121
if to_block is not None:
122-
filter_params["toBlock"] = to_block
122+
filter_params["to_block"] = to_block
123123

124124
data_filters_set = construct_event_data_set(event_abi, abi_codec, argument_filters)
125125

‎web3/_utils/module_testing/eth_module.py

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1210,16 +1210,16 @@ async def test_async_eth_get_logs_without_logs(
12101210
# Test with block range
12111211

12121212
filter_params: FilterParams = {
1213-
"fromBlock": BlockNumber(0),
1214-
"toBlock": BlockNumber(block_with_txn_with_log["number"] - 1),
1213+
"from_block": BlockNumber(0),
1214+
"to_block": BlockNumber(block_with_txn_with_log["number"] - 1),
12151215
}
12161216
result = await async_w3.eth.get_logs(filter_params) # type: ignore
12171217
assert len(result) == 0
12181218

12191219
# the range is wrong
12201220
filter_params = {
1221-
"fromBlock": block_with_txn_with_log["number"],
1222-
"toBlock": BlockNumber(block_with_txn_with_log["number"] - 1),
1221+
"from_block": block_with_txn_with_log["number"],
1222+
"to_block": BlockNumber(block_with_txn_with_log["number"] - 1),
12231223
}
12241224
result = await async_w3.eth.get_logs(filter_params) # type: ignore
12251225
assert len(result) == 0
@@ -1228,7 +1228,7 @@ async def test_async_eth_get_logs_without_logs(
12281228

12291229
# filter with other address
12301230
filter_params = {
1231-
"fromBlock": BlockNumber(0),
1231+
"from_block": BlockNumber(0),
12321232
"address": UNKNOWN_ADDRESS,
12331233
}
12341234
result = await async_w3.eth.get_logs(filter_params) # type: ignore
@@ -1238,7 +1238,7 @@ async def test_async_eth_get_logs_without_logs(
12381238

12391239
# filter with other address
12401240
filter_params = {
1241-
"fromBlock": BlockNumber(0),
1241+
"from_block": BlockNumber(0),
12421242
"address": [UNKNOWN_ADDRESS, UNKNOWN_ADDRESS],
12431243
}
12441244
result = await async_w3.eth.get_logs(filter_params) # type: ignore
@@ -1257,8 +1257,8 @@ async def test_async_eth_get_logs_with_logs(
12571257

12581258
# the range includes the block where the log resides in
12591259
filter_params: FilterParams = {
1260-
"fromBlock": block_with_txn_with_log["number"],
1261-
"toBlock": block_with_txn_with_log["number"],
1260+
"from_block": block_with_txn_with_log["number"],
1261+
"to_block": block_with_txn_with_log["number"],
12621262
}
12631263
result = await async_w3.eth.get_logs(filter_params) # type: ignore
12641264
assert_contains_log(
@@ -1267,7 +1267,7 @@ async def test_async_eth_get_logs_with_logs(
12671267

12681268
# specify only `from_block`. by default `to_block` should be 'latest'
12691269
filter_params = {
1270-
"fromBlock": BlockNumber(0),
1270+
"from_block": BlockNumber(0),
12711271
}
12721272
result = await async_w3.eth.get_logs(filter_params) # type: ignore
12731273
assert_contains_log(
@@ -1278,7 +1278,7 @@ async def test_async_eth_get_logs_with_logs(
12781278

12791279
# filter with emitter_contract.address
12801280
filter_params = {
1281-
"fromBlock": BlockNumber(0),
1281+
"from_block": BlockNumber(0),
12821282
"address": emitter_contract_address,
12831283
}
12841284
result = await async_w3.eth.get_logs(filter_params) # type: ignore
@@ -1298,7 +1298,7 @@ async def test_async_eth_get_logs_with_logs_topic_args(
12981298
# Test with None event sig
12991299

13001300
filter_params: FilterParams = {
1301-
"fromBlock": BlockNumber(0),
1301+
"from_block": BlockNumber(0),
13021302
"topics": [
13031303
None,
13041304
HexStr(
@@ -1314,7 +1314,7 @@ async def test_async_eth_get_logs_with_logs_topic_args(
13141314

13151315
# Test with None indexed arg
13161316
filter_params = {
1317-
"fromBlock": BlockNumber(0),
1317+
"from_block": BlockNumber(0),
13181318
"topics": [
13191319
HexStr(
13201320
"0x057bc32826fbe161da1c110afcdcae7c109a8b69149f727fc37a603c60ef94ca"
@@ -1333,7 +1333,7 @@ async def test_async_eth_get_logs_with_logs_none_topic_args(
13331333
) -> None:
13341334
# Test with None overflowing
13351335
filter_params: FilterParams = {
1336-
"fromBlock": BlockNumber(0),
1336+
"from_block": BlockNumber(0),
13371337
"topics": [None, None, None],
13381338
}
13391339

@@ -3179,16 +3179,16 @@ def test_eth_get_logs_without_logs(
31793179
# Test with block range
31803180

31813181
filter_params: FilterParams = {
3182-
"fromBlock": BlockNumber(0),
3183-
"toBlock": BlockNumber(block_with_txn_with_log["number"] - 1),
3182+
"from_block": BlockNumber(0),
3183+
"to_block": BlockNumber(block_with_txn_with_log["number"] - 1),
31843184
}
31853185
result = w3.eth.get_logs(filter_params)
31863186
assert len(result) == 0
31873187

31883188
# the range is wrong
31893189
filter_params = {
3190-
"fromBlock": block_with_txn_with_log["number"],
3191-
"toBlock": BlockNumber(block_with_txn_with_log["number"] - 1),
3190+
"from_block": block_with_txn_with_log["number"],
3191+
"to_block": BlockNumber(block_with_txn_with_log["number"] - 1),
31923192
}
31933193
result = w3.eth.get_logs(filter_params)
31943194
assert len(result) == 0
@@ -3197,7 +3197,7 @@ def test_eth_get_logs_without_logs(
31973197

31983198
# filter with other address
31993199
filter_params = {
3200-
"fromBlock": BlockNumber(0),
3200+
"from_block": BlockNumber(0),
32013201
"address": UNKNOWN_ADDRESS,
32023202
}
32033203
result = w3.eth.get_logs(filter_params)
@@ -3207,7 +3207,7 @@ def test_eth_get_logs_without_logs(
32073207

32083208
# filter with other address
32093209
filter_params = {
3210-
"fromBlock": BlockNumber(0),
3210+
"from_block": BlockNumber(0),
32113211
"address": [UNKNOWN_ADDRESS, UNKNOWN_ADDRESS],
32123212
}
32133213
result = w3.eth.get_logs(filter_params)
@@ -3225,8 +3225,8 @@ def test_eth_get_logs_with_logs(
32253225

32263226
# the range includes the block where the log resides in
32273227
filter_params: FilterParams = {
3228-
"fromBlock": block_with_txn_with_log["number"],
3229-
"toBlock": block_with_txn_with_log["number"],
3228+
"from_block": block_with_txn_with_log["number"],
3229+
"to_block": block_with_txn_with_log["number"],
32303230
}
32313231
result = w3.eth.get_logs(filter_params)
32323232
assert_contains_log(
@@ -3235,7 +3235,7 @@ def test_eth_get_logs_with_logs(
32353235

32363236
# specify only `from_block`. by default `to_block` should be 'latest'
32373237
filter_params = {
3238-
"fromBlock": BlockNumber(0),
3238+
"from_block": BlockNumber(0),
32393239
}
32403240
result = w3.eth.get_logs(filter_params)
32413241
assert_contains_log(
@@ -3246,7 +3246,7 @@ def test_eth_get_logs_with_logs(
32463246

32473247
# filter with emitter_contract.address
32483248
filter_params = {
3249-
"fromBlock": BlockNumber(0),
3249+
"from_block": BlockNumber(0),
32503250
"address": emitter_contract_address,
32513251
}
32523252

@@ -3261,7 +3261,7 @@ def test_eth_get_logs_with_logs_topic_args(
32613261
# Test with None event sig
32623262

32633263
filter_params: FilterParams = {
3264-
"fromBlock": BlockNumber(0),
3264+
"from_block": BlockNumber(0),
32653265
"topics": [
32663266
None,
32673267
HexStr(
@@ -3277,7 +3277,7 @@ def test_eth_get_logs_with_logs_topic_args(
32773277

32783278
# Test with None indexed arg
32793279
filter_params = {
3280-
"fromBlock": BlockNumber(0),
3280+
"from_block": BlockNumber(0),
32813281
"topics": [
32823282
HexStr(
32833283
"0x057bc32826fbe161da1c110afcdcae7c109a8b69149f727fc37a603c60ef94ca"
@@ -3293,7 +3293,7 @@ def test_eth_get_logs_with_logs_topic_args(
32933293
def test_eth_get_logs_with_logs_none_topic_args(self, w3: "Web3") -> None:
32943294
# Test with None overflowing
32953295
filter_params: FilterParams = {
3296-
"fromBlock": BlockNumber(0),
3296+
"from_block": BlockNumber(0),
32973297
"topics": [None, None, None],
32983298
}
32993299

‎web3/contract.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1516,8 +1516,8 @@ def create_filter(
15161516
filter_builder.address = cast(
15171517
ChecksumAddress, event_filter_params.get("address")
15181518
)
1519-
filter_builder.fromBlock = event_filter_params.get("from_block")
1520-
filter_builder.toBlock = event_filter_params.get("to_block")
1519+
filter_builder.from_block = event_filter_params.get("from_block")
1520+
filter_builder.to_block = event_filter_params.get("to_block")
15211521
match_any_vals = {
15221522
arg: value
15231523
for arg, value in _filters.items()
@@ -1559,8 +1559,8 @@ def _get_event_filter_params(
15591559
self,
15601560
abi: ABIEvent,
15611561
argument_filters: Optional[Dict[str, Any]] = None,
1562-
fromBlock: Optional[BlockIdentifier] = None,
1563-
toBlock: Optional[BlockIdentifier] = None,
1562+
from_block: Optional[BlockIdentifier] = None,
1563+
to_block: Optional[BlockIdentifier] = None,
15641564
blockHash: Optional[HexBytes] = None,
15651565
) -> FilterParams:
15661566

@@ -1576,7 +1576,7 @@ def _get_event_filter_params(
15761576
_filters = dict(**argument_filters)
15771577

15781578
blkhash_set = blockHash is not None
1579-
blknum_set = fromBlock is not None or toBlock is not None
1579+
blknum_set = from_block is not None or to_block is not None
15801580
if blkhash_set and blknum_set:
15811581
raise ValidationError(
15821582
"blockHash cannot be set at the same time as fromBlock or toBlock"
@@ -1589,8 +1589,8 @@ def _get_event_filter_params(
15891589
self.w3.codec,
15901590
contract_address=self.address,
15911591
argument_filters=_filters,
1592-
from_block=fromBlock,
1593-
to_block=toBlock,
1592+
from_block=from_block,
1593+
to_block=to_block,
15941594
address=self.address,
15951595
)
15961596

‎web3/types.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -149,8 +149,8 @@ class FormattersDict(TypedDict, total=False):
149149
class FilterParams(TypedDict, total=False):
150150
address: Union[Address, ChecksumAddress, List[Address], List[ChecksumAddress]]
151151
blockHash: HexBytes
152-
fromBlock: BlockIdentifier
153-
toBlock: BlockIdentifier
152+
from_block: BlockIdentifier
153+
to_block: BlockIdentifier
154154
topics: Sequence[Optional[Union[_Hash32, Sequence[_Hash32]]]]
155155

156156

0 commit comments

Comments
 (0)