Merge pull request #1158 from pipermerriam/piper/allow-granular-logging-config

Allow granular configuration of logging

Author: pipermerriam

eth/__init__.py

@@ -1,7 +1,7 @@
 import pkg_resources
 import sys
 
-from eth.utils.logging import (
+from eth.tools.logging import (
     setup_trace_logging
 )
 

eth/db/account.py

@@ -42,8 +42,7 @@
     validate_uint256,
     validate_canonical_address,
 )
-
-from eth.utils.logging import (
+from eth.tools.logging import (
     TraceLogger
 )
 from eth.utils.numeric import (

eth/tools/logging.py

@@ -0,0 +1,16 @@
+import logging
+from typing import Any
+
+TRACE_LEVEL_NUM = 5
+
+
+class TraceLogger(logging.Logger):
+
+    def trace(self, message: str, *args: Any, **kwargs: Any) -> None:
+        self.log(TRACE_LEVEL_NUM, message, *args, **kwargs)
+
+
+def setup_trace_logging() -> None:
+    logging.setLoggerClass(TraceLogger)
+    logging.addLevelName(TRACE_LEVEL_NUM, 'TRACE')
+    setattr(logging, 'TRACE', TRACE_LEVEL_NUM)  # typing: ignore

eth/utils/logging.py

@@ -1,15 +0,0 @@
-import logging
-from typing import Any
-
-TRACE_LEVEL_NUM = 5
-
-
-class TraceLogger(logging.Logger):
-
-    def trace(self, message: str, *args: Any, **kwargs: Any) -> None:
-        self.log(TRACE_LEVEL_NUM, message, *args, **kwargs)
-
-
-def setup_trace_logging() -> None:
-    logging.setLoggerClass(TraceLogger)
-    logging.addLevelName(TRACE_LEVEL_NUM, 'TRACE')

eth/vm/computation.py

@@ -26,6 +26,9 @@
     Halt,
     VMError,
 )
+from eth.tools.logging import (
+    TraceLogger
+)
 from eth.utils.datatypes import (
     Configurable,
 )
@@ -35,9 +38,6 @@
 from eth.utils.numeric import (
     ceil32,
 )
-from eth.utils.logging import (
-    TraceLogger
-)
 from eth.validation import (
     validate_canonical_address,
     validate_is_bytes,

eth/vm/gas_meter.py

@@ -10,7 +10,7 @@
 from eth.validation import (
     validate_uint256,
 )
-from eth.utils.logging import (
+from eth.tools.logging import (
     TraceLogger
 )
 

p2p/__init__.py

@@ -1,2 +1,2 @@
 # This is to ensure we call setup_trace_logging() before anything else.
-import eth as eth_module  # noqa: F401
+import eth as _eth_module  # noqa: F401

p2p/peer.py

@@ -1014,9 +1014,9 @@ def _test() -> None:
     """
     import argparse
     import signal
-    from eth.utils.logging import TRACE_LEVEL_NUM
     from eth.chains.ropsten import RopstenChain, ROPSTEN_GENESIS_HEADER, ROPSTEN_VM_CONFIGURATION
     from eth.db.backends.memory import MemoryDB
+    from eth.tools.logging import TRACE_LEVEL_NUM
     from trinity.protocol.eth.peer import ETHPeer
     from trinity.protocol.eth.requests import HeaderRequest as ETHHeaderRequest
     from trinity.protocol.les.peer import LESPeer

p2p/service.py

@@ -10,7 +10,7 @@
     cast,
 )
 
-from eth.utils.logging import TraceLogger
+from eth.tools.logging import TraceLogger
 
 from cancel_token import CancelToken, OperationCancelled
 

tests/trinity/core/cli/test_log_level_configuration.py

@@ -0,0 +1,48 @@
+import pytest
+
+from trinity.cli_parser import (
+    parser,
+    LOG_LEVEL_CHOICES,
+)
+
+
+def test_cli_log_level_not_specified():
+    ns = parser.parse_args([])
+    assert ns.log_levels is None
+
+
+@pytest.mark.parametrize(
+    'level,expected',
+    LOG_LEVEL_CHOICES.items(),
+)
+def test_cli_log_level_global_values(level, expected):
+    ns = parser.parse_args(['--log-level', level])
+    assert ns.log_levels == {None: expected}
+
+
+@pytest.mark.parametrize(
+    'level,expected',
+    LOG_LEVEL_CHOICES.items(),
+)
+def test_cli_log_level_module_value(level, expected):
+    ns = parser.parse_args(['--log-level', "module={0}".format(level)])
+    assert ns.log_levels == {'module': expected}
+
+
+def test_cli_log_level_error_for_multiple_globals():
+    with pytest.raises(SystemExit):
+        parser.parse_args([
+            '--log-level', 'DEBUG',
+            '--log-level', 'modue=DEBUG',
+            '--log-level', 'ERROR',
+        ])
+
+
+def test_cli_log_level_error_for_repeated_name():
+    with pytest.raises(SystemExit):
+        parser.parse_args([
+            '--log-level', 'DEBUG',
+            '--log-level', 'modue_a=DEBUG',
+            '--log-level', 'modue_b=DEBUG',
+            '--log-level', 'modue_a=DEBUG',
+        ])