Merge pull request #81 from pipermerriam/piper/allow-event-api-to-be-used-as-class-method-or-instance

Allow calling contract Event API using class or instance

requirements-dev.txt

@@ -1,8 +1,8 @@
 pytest>=2.8.2
 pytest-pythonpath>=0.3
 tox>=1.8.0
-eth-testrpc>=0.8.3
-ethereum-tester-client>=1.2.0
+eth-testrpc>=0.8.4
+ethereum-tester-client>=1.2.1
 py-geth>=1.2.0
 ethereum>=1.5.2
 secp256k1>=0.13.1

tests/filtering/test_contract_on_event_filtering.py

@@ -1,19 +1,55 @@
+import pytest
 import random
 import gevent
 from flaky import flaky
 
 
 @flaky(max_runs=3)
+@pytest.mark.parametrize('call_as_instance', (True, False))
+def test_on_filter_using_get_interface(web3_empty,
+                                       emitter,
+                                       Emitter,
+                                       wait_for_transaction,
+                                       emitter_log_topics,
+                                       emitter_event_ids,
+                                       call_as_instance):
+    web3 = web3_empty
+
+    if call_as_instance:
+        filter = emitter.on('LogNoArguments', {})
+    else:
+        filter = Emitter.on('LogNoArguments', {})
+
+    txn_hash = emitter.transact().logNoArgs(emitter_event_ids.LogNoArguments)
+    txn_receipt = wait_for_transaction(web3, txn_hash)
+
+    with gevent.Timeout(10):
+        while not filter.get(False):
+            gevent.sleep(random.random())
+
+    log_entries = filter.get()
+
+    assert len(log_entries) == 1
+    assert log_entries[0]['transactionHash'] == txn_hash
+
+
+@flaky(max_runs=3)
+@pytest.mark.parametrize('call_as_instance', (True, False))
 def test_on_filter_with_only_event_name(web3_empty,
                                         emitter,
+                                        Emitter,
                                         wait_for_transaction,
                                         emitter_log_topics,
-                                        emitter_event_ids):
+                                        emitter_event_ids,
+                                        call_as_instance):
     web3 = web3_empty
 
     seen_logs = []
 
-    filter = emitter.on('LogNoArguments', {}, seen_logs.append)
+    if call_as_instance:
+        filter = emitter.on('LogNoArguments', {}, seen_logs.append)
+    else:
+        filter = Emitter.on('LogNoArguments', {}, seen_logs.append)
 
     txn_hash = emitter.transact().logNoArgs(emitter_event_ids.LogNoArguments)
     txn_receipt = wait_for_transaction(web3, txn_hash)
@@ -29,18 +65,26 @@ def test_on_filter_with_only_event_name(web3_empty,
 
 
 @flaky(max_runs=3)
+@pytest.mark.parametrize('call_as_instance', (True, False))
 def test_on_filter_with_event_name_and_single_argument(web3_empty,
                                                        emitter,
+                                                       Emitter,
                                                        wait_for_transaction,
                                                        emitter_log_topics,
-                                                       emitter_event_ids):
+                                                       emitter_event_ids,
+                                                       call_as_instance):
     web3 = web3_empty
 
     seen_logs = []
 
-    filter = emitter.on('LogTripleWithIndex', {'filter': {
-        'arg1': 2,
-    }}, seen_logs.append)
+    if call_as_instance:
+        filter = emitter.on('LogTripleWithIndex', {'filter': {
+            'arg1': 2,
+        }}, seen_logs.append)
+    else:
+        filter = Emitter.on('LogTripleWithIndex', {'filter': {
+            'arg1': 2,
+        }}, seen_logs.append)
 
     txn_hashes = []
     txn_hashes.append(
@@ -66,18 +110,26 @@ def test_on_filter_with_event_name_and_single_argument(web3_empty,
 
 
 @flaky(max_runs=3)
+@pytest.mark.parametrize('call_as_instance', (True, False))
 def test_on_filter_with_event_name_and_non_indexed_argument(web3_empty,
                                                             emitter,
+                                                            Emitter,
                                                             wait_for_transaction,
                                                             emitter_log_topics,
-                                                            emitter_event_ids):
+                                                            emitter_event_ids,
+                                                            call_as_instance):
     web3 = web3_empty
 
     seen_logs = []
 
-    filter = emitter.on('LogTripleWithIndex', {'filter': {
-        'arg0': 1, 'arg1': 2,
-    }}, seen_logs.append)
+    if call_as_instance:
+        filter = emitter.on('LogTripleWithIndex', {'filter': {
+            'arg0': 1, 'arg1': 2,
+        }}, seen_logs.append)
+    else:
+        filter = Emitter.on('LogTripleWithIndex', {'filter': {
+            'arg0': 1, 'arg1': 2,
+        }}, seen_logs.append)
 
     txn_hashes = []
     txn_hashes.append(

tests/filtering/test_contract_past_event_filtering.py

@@ -1,15 +1,19 @@
+import pytest
 import random
 import gevent
 from flaky import flaky
 
 
 @flaky(max_runs=3)
-def test_past_events_filter_with_only_event_name(web3_empty,
-                                                 emitter,
-                                                 wait_for_transaction,
-                                                 emitter_log_topics,
-                                                 emitter_event_ids,
-                                                 LogTopics):
+@pytest.mark.parametrize('call_as_instance', (True, False))
+def test_past_events_filter_with_callback(web3_empty,
+                                          emitter,
+                                          Emitter,
+                                          wait_for_transaction,
+                                          emitter_log_topics,
+                                          emitter_event_ids,
+                                          LogTopics,
+                                          call_as_instance):
     web3 = web3_empty
 
     txn_hash = emitter.transact().logNoArgs(emitter_event_ids.LogNoArguments)
@@ -17,7 +21,10 @@ def test_past_events_filter_with_only_event_name(web3_empty,
 
     seen_logs = []
 
-    filter = emitter.pastEvents('LogNoArguments', {}, seen_logs.append)
+    if call_as_instance:
+        filter = emitter.pastEvents('LogNoArguments', {}, seen_logs.append)
+    else:
+        filter = Emitter.pastEvents('LogNoArguments', {}, seen_logs.append)
 
     with gevent.Timeout(5):
         while not seen_logs:
@@ -33,3 +40,39 @@ def test_past_events_filter_with_only_event_name(web3_empty,
     assert event_data['transactionIndex'] == txn_receipt['transactionIndex']
     assert event_data['address'] == emitter.address
     assert event_data['event'] == 'LogNoArguments'
+
+
+@flaky(max_runs=3)
+@pytest.mark.parametrize('call_as_instance', (True, False))
+def test_past_events_filter_using_get_api(web3_empty,
+                                          emitter,
+                                          Emitter,
+                                          wait_for_transaction,
+                                          emitter_log_topics,
+                                          emitter_event_ids,
+                                          LogTopics,
+                                          call_as_instance):
+    web3 = web3_empty
+
+    txn_hash = emitter.transact().logNoArgs(emitter_event_ids.LogNoArguments)
+    txn_receipt = wait_for_transaction(web3, txn_hash)
+
+    if call_as_instance:
+        filter = emitter.pastEvents('LogNoArguments')
+    else:
+        filter = Emitter.pastEvents('LogNoArguments')
+
+    with gevent.Timeout(10):
+        while not filter.get(False):
+            gevent.sleep(random.random())
+
+    log_entries = filter.get(False)
+
+    assert len(log_entries) == 1
+    event_data = log_entries[0]
+    assert event_data['args'] == {}
+    assert event_data['blockHash'] == txn_receipt['blockHash']
+    assert event_data['blockNumber'] == txn_receipt['blockNumber']
+    assert event_data['transactionIndex'] == txn_receipt['transactionIndex']
+    assert event_data['address'] == emitter.address
+    assert event_data['event'] == 'LogNoArguments'

web3/contract.py

@@ -36,6 +36,9 @@ from web3.utils.abi import (
     check_if_arguments_can_be_encoded,
     function_abi_to_4byte_selector,
 )
+from web3.utils.decorators import (
+    combomethod,
+)
 from web3.utils.transactions import (
     get_block_gas_limit,
 )
@@ -379,6 +382,7 @@ class Contract(object):
 
         return deploy_data
 
+    @combomethod
     def on(self, event_name, default_filter_params=None, *callbacks):
         """
         register a callback to be triggered on the appropriate events.
@@ -410,6 +414,7 @@ class Contract(object):
 
         return log_filter
 
+    @combomethod
     def pastEvents(self, event_name, default_filter_params=None, *callbacks):
         """
         register a callback to be triggered on all past events.

web3/utils/decorators.py

@@ -0,0 +1,15 @@
+import functools
+
+
+class combomethod(object):
+    def __init__(self, method):
+        self.method = method
+
+    def __get__(self, obj=None, objtype=None):
+        @functools.wraps(self.method)
+        def _wrapper(*args, **kwargs):
+            if obj is not None:
+                return self.method(obj, *args, **kwargs)
+            else:
+                return self.method(objtype, *args, **kwargs)
+        return _wrapper

web3/utils/filters.py

@@ -160,7 +160,7 @@ class LogFilter(BaseFilter):
         if only_changes:
             log_entries = self.web3.eth.getFilterChanges(self.filter_id)
         else:
-            log_entries = self.web3.eth.getFilterChanges(self.filter_id)
+            log_entries = self.web3.eth.getFilterLogs(self.filter_id)
 
         formatted_log_entries = [
             self.format_entry(log_entry) for log_entry in log_entries