PR feedback

Author: kclowes

docs/contracts.rst

@@ -735,7 +735,7 @@ For example:
    By default, an error will be raised if the log doesn't match the provided ABI.
    However, errors can be optionally ignored by passing in the ``ignore`` or
    ``discard`` flag located in the ``EventLogErrorFlags`` class. The ``discard``
-   flag will discard any logs that raise an error during processing, and return
+   flag will silently discard any logs that raise an error during processing, and return
    the rest. The ``ignore`` flag will return the raw log that caused the error,
    without any processing, and will process any logs that do not raise an error.
    An ``EventLogErrorFlag`` is imported from web3/_utils/events.py.

tests/core/contracts/test_extracting_event_data.py

@@ -5,7 +5,9 @@
 )
 
 from web3._utils.events import (
-    EventLogErrorFlags,
+    DISCARD,
+    IGNORE,
+    STRICT,
     get_event_data,
 )
 
@@ -271,7 +273,7 @@ def test_event_rich_log(
 @pytest.mark.parametrize(
     'errors',
     (
-        (EventLogErrorFlags.strict),
+        (STRICT),
         (),
     )
 )
@@ -298,8 +300,8 @@ def test_event_processing_with_strict_error_flag(
 @pytest.mark.parametrize(
     'errors,rich_log_length',
     (
-        (EventLogErrorFlags.discard, 0),
-        (EventLogErrorFlags.ignore, 1),
+        (DISCARD, 0),
+        (IGNORE, 1),
     )
 )
 def test_event_processing_with_caught_errors(
@@ -328,8 +330,10 @@ def test_event_processing_with_caught_errors(
     if len(returned_logs) == 0:
         assert returned_logs == ()
     elif len(returned_logs) == 1:
-        returned_log = returned_logs[0]
+        returned_log = dict(returned_logs[0])
 
+        assert repr(returned_log['errors']) == "ValueError('Expected 1 log topics.  Got 0')"
+        del returned_log['errors']
         assert returned_log == dup_txn_receipt['logs'][0]
         assert is_same_address(returned_log['address'], event_contract.address)
     else:

web3/_utils/events.py

@@ -450,6 +450,11 @@ def _encode(self, value):
 
 
 class EventLogErrorFlags(Enum):
-    strict = 'strict'
-    ignore = 'ignore'
-    discard = 'discard'
+    STRICT = 'strict'
+    IGNORE = 'ignore'
+    DISCARD = 'discard'
+
+
+STRICT = EventLogErrorFlags.STRICT
+IGNORE = EventLogErrorFlags.IGNORE
+DISCARD = EventLogErrorFlags.DISCARD

web3/contract.py

@@ -62,8 +62,10 @@
     to_hex,
 )
 from web3._utils.events import (
+    DISCARD,
+    IGNORE,
+    STRICT,
     EventFilterBuilder,
-    EventLogErrorFlags,
     get_event_data,
     is_dynamic_sized_type,
 )
@@ -82,6 +84,10 @@
 from web3._utils.transactions import (
     fill_transaction_defaults,
 )
+from web3.datastructures import (
+    AttributeDict,
+    MutableAttributeDict,
+)
 from web3.exceptions import (
     BadFunctionCallOutput,
     BlockNumberOutofRange,
@@ -984,24 +990,26 @@ def _get_event_abi(cls):
             event_name=cls.event_name)
 
     @combomethod
-    def processReceipt(self, txn_receipt, errors=EventLogErrorFlags.strict):
+    def processReceipt(self, txn_receipt, errors=STRICT):
         return self._parse_logs(txn_receipt, errors)
 
     @to_tuple
     def _parse_logs(self, txn_receipt, errors):
         for log in txn_receipt['logs']:
             try:
-                decoded_log = get_event_data(self.abi, log)
+                rich_log = get_event_data(self.abi, log)
             except MismatchedABI:
                 continue
             except ValueError as e:
-                if errors == EventLogErrorFlags.discard:
+                if errors == DISCARD:
                     continue
-                elif errors == EventLogErrorFlags.ignore:
-                    decoded_log = log
+                elif errors == IGNORE:
+                    new_log = MutableAttributeDict(log)
+                    new_log["errors"] = e
+                    rich_log = AttributeDict(new_log)
                 else:
                     raise e
-            yield decoded_log
+            yield rich_log
 
     @combomethod
     def createFilter(