snake_case createFilter (#2692)

Author: Paul Robinson

docs/contracts.rst

@@ -235,9 +235,9 @@ Each Contract Factory exposes the following methods.
         >>> contract_data = token_contract.constructor(web3.eth.coinbase, 12345).build_transaction(transaction)
         >>> web3.eth.send_transaction(contract_data)
 
-.. _contract_createFilter:
+.. _contract_create_filter:
 
-.. py:classmethod:: Contract.events.your_event_name.createFilter(fromBlock=block, toBlock=block, \
+.. py:classmethod:: Contract.events.your_event_name.create_filter(fromBlock=block, toBlock=block, \
                     argument_filters={"arg1": "value"}, topics=[])
 
     Creates a new event filter, an instance of :py:class:`web3.utils.filters.LogFilter`.
@@ -1041,7 +1041,7 @@ Event Log Object
     * ``blockNumber``: Number - the block number where this log was in. null
       when it's pending.
 
-.. testsetup:: createFilter
+.. testsetup:: create_filter
 
     from web3 import Web3
     from hexbytes import HexBytes
@@ -1064,9 +1064,9 @@ Event Log Object
     tx_hash = contract.functions.transfer(alice, 10).transact({'gas': 899000, 'gasPrice': Web3.to_wei(1, 'gwei')})
     tx_receipt = w3.eth.wait_for_transaction_receipt(tx_hash)
 
-.. doctest:: createFilter
+.. doctest:: create_filter
 
-    >>> transfer_filter = my_token_contract.events.Transfer.createFilter(fromBlock="0x0", argument_filters={'from': '0x7E5F4552091A69125d5DfCb7b8C2659029395Bdf'})
+    >>> transfer_filter = my_token_contract.events.Transfer.create_filter(fromBlock="0x0", argument_filters={'from': '0x7E5F4552091A69125d5DfCb7b8C2659029395Bdf'})
     >>> transfer_filter.get_new_entries()
     [AttributeDict({'args': AttributeDict({'from': '0x7E5F4552091A69125d5DfCb7b8C2659029395Bdf',
      'to': '0x7E5F4552091A69125d5DfCb7b8C2659029395Bdf',

docs/examples.rst

@@ -1176,7 +1176,7 @@ The script can be run with: ``python ./eventscanner.py <your JSON-RPC API URL>``
 
         This method is detached from any contract instance.
 
-        This is a stateless method, as opposed to createFilter.
+        This is a stateless method, as opposed to create_filter.
         It can be safely called against nodes which do not provide `eth_newFilter` API, like Infura.
         """
 

docs/filters.rst

@@ -27,7 +27,7 @@ The :meth:`web3.eth.Eth.filter` method can be used to set up filters for:
 
     .. code-block:: python
 
-        event_filter = mycontract.events.myEvent.createFilter(fromBlock='latest', argument_filters={'arg1':10})
+        event_filter = mycontract.events.myEvent.create_filter(fromBlock='latest', argument_filters={'arg1':10})
 
     Or built manually by supplying `valid filter params <https://github.com/ethereum/execution-apis/blob/bea0266c42919a2fb3ee524fb91e624a23bc17c5/src/schemas/filter.json#L28>`_:
 
@@ -129,15 +129,15 @@ Event Log Filters
 -----------------
 
 You can set up a filter for event logs using the web3.py contract api:
-:meth:`web3.contract.Contract.events.your_event_name.createFilter`, which provides some conveniences for
+:meth:`web3.contract.Contract.events.your_event_name.create_filter`, which provides some conveniences for
 creating event log filters. Refer to the following example:
 
     .. code-block:: python
 
-        event_filter = myContract.events.<event_name>.createFilter(fromBlock="latest", argument_filters={'arg1':10})
+        event_filter = myContract.events.<event_name>.create_filter(fromBlock="latest", argument_filters={'arg1':10})
         event_filter.get_new_entries()
 
-See :meth:`web3.contract.Contract.events.your_event_name.createFilter()` documentation for more information.
+See :meth:`web3.contract.Contract.events.your_event_name.create_filter()` documentation for more information.
 
 You can set up an event log filter like the one above with ``web3.eth.filter`` by supplying a
 dictionary containing the standard filter parameters. Assuming that ``arg1`` is indexed, the

docs/overview.rst

@@ -264,7 +264,7 @@ a contract, you can leverage Web3.py filters.
    >>> new_filter = web3.eth.filter('latest')
 
    # Use case: filter for contract event "MyEvent"
-   >>> new_filter = deployed_contract.events.MyEvent.createFilter(fromBlock='latest')
+   >>> new_filter = deployed_contract.events.MyEvent.create_filter(fromBlock='latest')
 
    # retrieve filter results:
    >>> new_filter.get_all_entries()
@@ -282,7 +282,7 @@ API
 - :meth:`web3.eth.get_filter_logs() <web3.eth.Eth.get_filter_logs>`
 - :meth:`web3.eth.uninstall_filter() <web3.eth.Eth.uninstall_filter>`
 - :meth:`web3.eth.get_logs() <web3.eth.Eth.get_logs>`
-- :meth:`Contract.events.your_event_name.createFilter() <web3.contract.Contract.events.your_event_name.createFilter>`
+- :meth:`Contract.events.your_event_name.create_filter() <web3.contract.Contract.events.your_event_name.create_filter>`
 - :meth:`Contract.events.your_event_name.build_filter() <web3.contract.Contract.events.your_event_name.build_filter>`
 - :meth:`Filter.get_new_entries() <web3.utils.filters.Filter.get_new_entries>`
 - :meth:`Filter.get_all_entries() <web3.utils.filters.Filter.get_all_entries>`

docs/releases.rst

@@ -2363,7 +2363,7 @@ Released Mar 27, 2018
   until a third-party audit is complete & resolved.
 - New API for contract deployment, which enables gas estimation, local signing, etc.
   See :meth:`~web3.contract.Contract.constructor`.
-- Find contract events with :ref:`contract.events.$my_event.createFilter() <contract_createFilter>`
+- Find contract events with :ref:`contract.events.$my_event.createFilter() <contract_create_filter>`
 - Support auto-complete for contract methods.
 - Upgrade most dependencies to stable
 

newsfragments/2692.breaking.rst

@@ -0,0 +1 @@
+change instances of `createFilter` to `create_filter`

tests/core/contracts/test_extracting_event_data.py

@@ -730,7 +730,7 @@ def test_single_log_processing_with_errors(indexed_event_contract, dup_txn_recei
 
 
 def test_get_all_entries_with_nested_tuple_event(w3, emitter):
-    struct_args_filter = emitter.events.LogStructArgs.createFilter(fromBlock=0)
+    struct_args_filter = emitter.events.LogStructArgs.create_filter(fromBlock=0)
 
     tx_hash = emitter.functions.logStruct(1, (2, 3, (4,))).transact({"gas": 100000})
     w3.eth.wait_for_transaction_receipt(tx_hash)

tests/core/filtering/conftest.py

@@ -168,7 +168,7 @@ def return_filter(contract=None, args=[]):
     kwargs = apply_key_map({"filter": "argument_filters"}, args[1])
     if "fromBlock" not in kwargs:
         kwargs["fromBlock"] = "latest"
-    return contract.events[event_name].createFilter(**kwargs)
+    return contract.events[event_name].create_filter(**kwargs)
 
 
 @pytest.fixture(scope="module")

tests/core/filtering/test_contract_createFilter_topic_merging.py

@@ -9,7 +9,7 @@ def test_merged_topic_list_event(emitter):
         "0x0000000000000000000000000000000000000000000000000000000000000457",  # 1111
     ]
     with pytest.raises(TypeError):
-        emitter.events.LogTripleWithIndex().createFilter(
+        emitter.events.LogTripleWithIndex().create_filter(
             fromBlock="latest",
             topics=manual_topics,
             argument_filters={"arg0": 2222, "arg1": 2222, "arg2": 2222},

tests/core/filtering/test_contract_on_event_filtering.py

@@ -8,9 +8,9 @@
 @pytest.mark.parametrize("call_as_instance", (True, False))
 def test_create_filter_address_parameter(emitter, Emitter, call_as_instance):
     if call_as_instance:
-        event_filter = emitter.events.LogNoArguments.createFilter(fromBlock="latest")
+        event_filter = emitter.events.LogNoArguments.create_filter(fromBlock="latest")
     else:
-        event_filter = Emitter.events.LogNoArguments.createFilter(fromBlock="latest")
+        event_filter = Emitter.events.LogNoArguments.create_filter(fromBlock="latest")
 
     if call_as_instance:
         # Assert this is a single string value, and not a list of addresses
@@ -152,7 +152,7 @@ def test_on_sync_filter_with_event_name_and_non_indexed_argument(
     assert len(seen_logs) == 1
     assert seen_logs[0]["transactionHash"] == txn_hashes[1]
 
-    post_event_filter = contract.events.LogTripleWithIndex.createFilter(
+    post_event_filter = contract.events.LogTripleWithIndex.create_filter(
         argument_filters={"arg0": 1, "arg1": 2},
         fromBlock=0,
     )
@@ -205,7 +205,7 @@ def test_on_sync_filter_with_topic_filter_options_on_old_apis(
     seen_logs = event_filter.get_new_entries()
     assert len(seen_logs) == 4
 
-    post_event_filter = contract.events.LogTripleWithIndex.createFilter(
+    post_event_filter = contract.events.LogTripleWithIndex.create_filter(
         argument_filters={"arg1": [1, 2], "arg2": [1, 2]},
         fromBlock=0,
     )