Implement more consistent logging behavior with ixmp4 (#830)

RELEASE_NOTES.md

@@ -1,5 +1,6 @@
 # Next release
 
+- [#830](https://github.com/IAMconsortium/pyam/pull/830) Implement more consistent logging behavior with **ixmp4**
 - [#829](https://github.com/IAMconsortium/pyam/pull/829) Add a `pyam.iiasa.platforms()` function for a list of available platforms
 - [#826](https://github.com/IAMconsortium/pyam/pull/826) Add `read_ixmp4()` function and extend integration test
 - [#825](https://github.com/IAMconsortium/pyam/pull/825) Add support for Python 3.12

pyam/__init__.py

@@ -24,9 +24,6 @@
 from pyam.unfccc import read_unfccc  # noqa: F401
 from pyam.utils import IAMC_IDX  # noqa: F401
 
-logger = logging.getLogger(__name__)
-
-# get version number either from git (preferred) or metadata
 try:
     __version__ = get_version(root=Path(__file__).parents[1])
 except LookupError:
@@ -36,31 +33,6 @@
     except PackageNotFoundError:
         __version__ = version("pyam")
 
-# special handling in Jupyter notebooks
-try:
-    from ipykernel.zmqshell import ZMQInteractiveShell
-    from IPython import get_ipython
-
-    shell = get_ipython()
-    if isinstance(shell, ZMQInteractiveShell):
-        # harmonize formatting of ixmp4 and pyam logging
-        ixmp4_logger = logging.getLogger("ixmp4")
-        ixmp4_logger.removeHandler(ixmp4_logger.handlers[0])
-
-        handler = logging.StreamHandler()
-        handler.setFormatter(logging.Formatter("%(name)s - %(levelname)s: %(message)s"))
-
-        for _logger in [logger, ixmp4_logger]:
-            _logger.addHandler(handler)
-
-        # deactivate in-cell scrolling in a Jupyter notebook
-        shell.run_cell_magic(
-            "javascript",
-            "",
-            "if (typeof IPython !== 'undefined') "
-            "{ IPython.OutputArea.prototype._should_scroll = function(lines)"
-            "{ return false; }}",
-        )
 
-except Exception:
-    pass
+# Set up logging consistent with the ixmp4 "production" logging configuration
+logging.configure_logging()

pyam/logging.conf

@@ -0,0 +1,30 @@
+# consistent logging with ixmp4 "production" configuration
+
+[loggers]
+keys = root,pyam_core
+
+[handlers]
+keys = console
+
+[formatters]
+keys = generic
+
+[logger_root]
+level = NOTSET
+handlers =
+qualname =
+
+[logger_pyam_core]
+level = INFO
+handlers = console
+qualname = pyam
+
+[handler_console]
+class = StreamHandler
+args = (sys.stderr,)
+level = NOTSET
+formatter = generic
+
+[formatter_generic]
+format = [%(levelname)s] %(asctime)s - %(name)s: %(message)s
+datefmt = %H:%M:%S

pyam/logging.py

@@ -1,12 +1,19 @@
 import warnings
 from contextlib import contextmanager
-from logging import getLogger
+from logging import config, getLogger
+from pathlib import Path
 
 import pandas as pd
 
+here = Path(__file__).parent
 logger = getLogger(__name__)
 
 
+def configure_logging():
+    """Configure logging"""
+    config.fileConfig(here / "logging.conf", disable_existing_loggers=False)
+
+
 @contextmanager
 def adjust_log_level(logger="pyam", level="ERROR"):
     """Context manager to change log level"""