Expand logging configuration support in PennyLane, and also target Catalyst

pennylane/logging/__init__.py

@@ -13,8 +13,8 @@
 # limitations under the License.
 """This module enables support for log-level messaging throughout PennyLane, following the native Python logging framework interface. Please see the :doc:`PennyLane logging development guidelines</development/guide/logging>`, and the official Python documentation for details on usage https://docs.python.org/3/library/logging.html"""
 
-from .configuration import enable_logging
-from .configuration import config_path
+from .configuration import config_path, edit_system_config, enable_logging
 from .configuration import TRACE
 from .formatters.formatter import DefaultFormatter, SimpleFormatter
 from .filter import LocalProcessFilter, DebugOnlyFilter
+from .decorators import debug_logger

pennylane/logging/configuration.py

@@ -16,7 +16,7 @@
 """
 import logging
 import logging.config
-import os
+import os, platform, subprocess
 from importlib import import_module
 from importlib.util import find_spec
 
@@ -53,7 +53,7 @@
  lc.trace = trace
 
 
-def _configure_logging(config_file):
+def _configure_logging(config_file: str, config_override: dict = {}):
  """
  This method allows custom logging configuration throughout PennyLane.
  All configurations are read through the ``log_config.toml`` file.
@@ -71,7 +71,7 @@
  logging.config.dictConfig(pl_config)
 
 
-def enable_logging():
+def enable_logging(config_file: str = "log_config.toml"):
  """
  This method allows to selectively enable logging throughout PennyLane, following the configuration options defined in the ``log_config.toml`` file.
 
@@ -82,7 +82,7 @@
  >>> qml.logging.enable_logging()
  """
  _add_trace_level()
- _configure_logging("log_config.toml")
+ _configure_logging(config_file)
 
 
 def config_path():
@@ -99,3 +99,38 @@
  """
  path = os.path.join(_path, "log_config.toml")
  return path
+
+
+def show_system_config():
+ """
+ This function opens the logging configuration file in the system-default browser.
+ """
+ import webbrowser
+
+ webbrowser.open(config_path())
+
+
+def edit_system_config(wait_on_close=False):
+ """
+ This function opens the log configuration file using OS-specific editors.
+
+ Setting the `EDITOR` environment variable will override xdg-open/open on
+ Linux and MacOS, and allows use of `wait_on_close` for editor close before
+ continuing execution.
+
+ Warning: As each OS configuration differs user-to-user, you may wish to
+ instead open this file manually with the `config_path()` provided path.
+ """
+ if editor := os.getenv("EDITOR"):
+ p = subprocess.Popen((editor, config_path()))
+ if wait_on_close: # Only valid when editor is known
+ p.wait()
+ elif (s := platform.system()) in ["Linux", "Darwin"]:
+ f_cmd = None
+ if s == "Linux":
+ f_cmd = "xdg-open"
+ else:
+ f_cmd = "open"
+ subprocess.Popen((f_cmd, config_path()))
+ else: # Windows
+ os.startfile(config_path())

pennylane/logging/formatters/formatter.py

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 """The PennyLane log-level formatters are defined here with default options, and ANSI-terminal color-codes."""
+import inspect
 import logging
 from logging import Formatter
 from typing import NamedTuple, Tuple, Union
@@ -114,6 +115,54 @@ def format(self, record):
  return formatter.format(record)
 
 
+class DynamicFormatter(Formatter):
+ """This formatter has the default rules used for formatting PennyLane log messages, with a dynamically updated log format rule"""
+
+ # 0x000000 Background
+ _text_bg = (0, 0, 0)
+
+ cmap = ColorScheme(
+ debug=(220, 238, 200), # Grey 1
+ debug_bg=_text_bg,
+ info=(80, 125, 125), # Blue
+ info_bg=_text_bg,
+ warning=(208, 167, 133), # Orange
+ warning_bg=_text_bg,
+ error=(208, 133, 133), # Red 1
+ error_bg=_text_bg,
+ critical=(135, 53, 53), # Red 2
+ critical_bg=(210, 210, 210), # Grey 2
+ use_rgb=True,
+ )
+
+ def _build_formats(self, fmt_str):
+ cmap = DynamicFormatter.cmap
+ local_formats = {
+ logging.DEBUG: build_code_rgb(cmap.debug, cmap.debug_bg) + fmt_str + _ANSI_CODES["end"],
+ logging.INFO: build_code_rgb(cmap.info, cmap.info_bg) + fmt_str + _ANSI_CODES["end"],
+ logging.WARNING: build_code_rgb(cmap.warning, cmap.warning_bg)
+ + fmt_str
+ + _ANSI_CODES["end"],
+ logging.ERROR: build_code_rgb(cmap.error, cmap.error_bg) + fmt_str + _ANSI_CODES["end"],
+ logging.CRITICAL: build_code_rgb(cmap.critical, cmap.critical_bg)
+ + fmt_str
+ + _ANSI_CODES["end"],
+ }
+
+ return local_formats
+
+ def format(self, record):
+ f = inspect.getouterframes(inspect.currentframe())[
+ 8
+ ] # Stack depth from log-func call to format function
+
+ fmt_str = f'[%(asctime)s][%(levelname)s][<PID %(process)d:%(processName)s>] - %(name)s.{f.function}()::"%(message)s"'
+
+ log_fmt = self._build_formats(fmt_str).get(record.levelno)
+ formatter = logging.Formatter(log_fmt)
+ return formatter.format(record)
+
+
 class SimpleFormatter(Formatter):
  """This formatter has a simplified layout and rules used for formatting PennyLane log messages."""
 

pennylane/logging/log_config.toml

@@ -13,6 +13,9 @@ version = 1
 [formatters.qml_default_formatter]
 "()" = "pennylane.logging.formatters.formatter.DefaultFormatter"
 
+[formatters.qml_dynamic_formatter]
+"()" = "pennylane.logging.formatters.formatter.DynamicFormatter"
+
 [formatters.qml_alt_formatter]
 "()" = "pennylane.logging.formatters.formatter.SimpleFormatter"
 
@@ -46,12 +49,24 @@ formatter = "qml_default_formatter"
 level = "DEBUG"
 stream = "ext://sys.stdout"
 
+[handlers.qml_debug_stream_dyn]
+class = "logging.StreamHandler"
+formatter = "qml_dynamic_formatter"
+level = "DEBUG"
+stream = "ext://sys.stdout"
+
 [handlers.qml_debug_stream_alt]
 class = "logging.StreamHandler"
 formatter = "qml_alt_formatter"
 level = "DEBUG"
 stream = "ext://sys.stdout"
 
+[handlers.qml_debug_syslog]
+class = "logging.handlers.SysLogHandler"
+formatter = "local_standard"
+level = "DEBUG"
+address = "/dev/log"
+
 [handlers.qml_debug_file]
 class = "logging.handlers.RotatingFileHandler"
 formatter = "local_standard"
@@ -80,12 +95,24 @@ handlers = ["qml_debug_stream",]
 level = "WARN"
 propagate = false
 
+# Control JAXlib logging
+[loggers.jaxlib]
+handlers = ["qml_debug_stream",]
+level = "WARN"
+propagate = false
+
 # Control logging across pennylane
 [loggers.pennylane]
 handlers = ["qml_debug_stream",]
 level = "DEBUG" # Set to TRACE for highest verbosity
 propagate = false
 
+# Control logging across catalyst
+[loggers.catalyst]
+handlers = ["qml_debug_stream",]
+level = "TRACE" # Set to TRACE for highest verbosity
+propagate = false
+
 # Control logging specifically in the pennylane.qnode module
 # Note the required quotes to overcome TOML nesting issues
 [loggers."pennylane.qnode"]