PR review updates

Author: kclowes

docs/contracts.rst

@@ -741,11 +741,11 @@ For example:
      - ``DISCARD`` - silently discards any logs that have errors, and returns processed logs that don't have errors.
      - ``WARN`` - logs a warning to the console for the log that has an error, and discards the log. Returns any logs that are able to be processed.
 
-   An ``EventLogErrorFlag`` needs to be imported from web3/event_log_error_flags.py.
+   An event log error flag needs to be imported from web3/log.py.
 
    .. code-block:: python
 
-       >>> from web3.event_log_error_flags import STRICT, IGNORE, DISCARD, WARN
+       >>> from web3.logs import STRICT, IGNORE, DISCARD, WARN
 
        >>> tx_hash = contract.functions.myFunction(12345).transact({'to':contract_address})
        >>> tx_receipt = w3.eth.getTransactionReceipt(tx_hash)

tests/core/contracts/test_extracting_event_data.py

@@ -4,19 +4,22 @@
 from eth_utils import (
     is_same_address,
 )
+from eth_utils.toolz import (
+    dissoc,
+)
 
 from web3._utils.events import (
     get_event_data,
 )
-from web3.event_log_error_flags import (
+from web3.exceptions import (
+    LogTopicError,
+)
+from web3.logs import (
     DISCARD,
     IGNORE,
     STRICT,
     WARN,
 )
-from web3.exceptions import (
-    LogTopicError,
-)
 
 
 @pytest.fixture()
@@ -340,29 +343,22 @@ def test_event_processing_with_ignore_flag(
     returned_logs = event_instance.processReceipt(dup_txn_receipt, errors=IGNORE)
     assert len(returned_logs) == 2
 
-    first_log = dict(returned_logs[0])
-
     # Check that the correct error is appended to the log
-    expected_error = re.compile("Expected 1 log topics.  Got 0")
-    assert expected_error.search(str(first_log['errors'])) is not None
-
-    # Check that the returned log is the same as what got sent in,
-    # except the added errors field
-    del first_log['errors']
-    assert first_log == dup_txn_receipt['logs'][0]
-    assert is_same_address(first_log['address'], event_contract.address)
+    first_log = returned_logs[0]
+    log_error = re.compile("Expected 1 log topics.  Got 0")
+    assert log_error.search(str(first_log.errors)) is not None
 
     # Then, do the same with the other log:
-    second_log = dict(returned_logs[1])
-
+    second_log = returned_logs[1]
     abi_error = re.compile("The event signature did not match the provided ABI")
-    assert abi_error.search(str(second_log['errors'])) is not None
-
-    # Check that the returned log is the same as what got sent in,
-    # except the added errors field
-    del second_log['errors']
-    assert second_log == dup_txn_receipt['logs'][1]
-    assert is_same_address(second_log['address'], event_contract.address)
+    assert abi_error.search(str(second_log.errors)) is not None
+
+    for log in returned_logs:
+        # Check that the returned log is the same as what got sent in,
+        # except for the added errors field
+        orig_log = dissoc(dict(log), 'errors')
+        assert orig_log in dup_txn_receipt['logs']
+        assert is_same_address(log['address'], event_contract.address)
 
 
 def test_event_processing_with_warn_flag(

web3/_utils/events.py

@@ -2,6 +2,7 @@
     ABC,
     abstractmethod,
 )
+from enum import Enum
 import itertools
 
 from eth_abi import (
@@ -448,3 +449,14 @@ def _encode(self, value):
             return to_hex(keccak(encode_single_packed(self.arg_type, value)))
         else:
             return to_hex(encode_single(self.arg_type, value))
+
+
+class EventLogErrorFlags(Enum):
+    Discard = 'discard'
+    Ignore = 'ignore'
+    Strict = 'strict'
+    Warn = 'warn'
+
+    @classmethod
+    def flag_options(self):
+        return [key.upper() for key in self.__members__.keys()]

web3/contract.py

@@ -86,13 +86,6 @@
     AttributeDict,
     MutableAttributeDict,
 )
-from web3.event_log_error_flags import (
-    DISCARD,
-    IGNORE,
-    STRICT,
-    WARN,
-    EventLogErrorFlags,
-)
 from web3.exceptions import (
     BadFunctionCallOutput,
     BlockNumberOutofRange,
@@ -105,6 +98,13 @@
     NoABIFunctionsFound,
     ValidationError,
 )
+from web3.logs import (
+    DISCARD,
+    IGNORE,
+    STRICT,
+    WARN,
+    EventLogErrorFlags,
+)
 
 ACCEPTABLE_EMPTY_STRINGS = ["0x", b"0x", "", b""]
 

web3/event_log_error_flags.py

@@ -0,0 +1,8 @@
+from web3._utils.events import (
+    EventLogErrorFlags,
+)
+
+DISCARD = EventLogErrorFlags.Discard
+IGNORE = EventLogErrorFlags.Ignore
+STRICT = EventLogErrorFlags.Strict
+WARN = EventLogErrorFlags.Warn