CLI: Fix error in aiida.cmdline.utils.log.CliFormatter

aiida/cmdline/utils/log.py

@@ -43,8 +43,7 @@ def emit(self, record):
 class CliFormatter(logging.Formatter):
     """Formatter that automatically prefixes log messages with a colored version of the log level."""
 
-    @staticmethod
-    def format(record):
+    def format(self, record):
         """Format the record using the style required for the command line interface."""
         try:
             fg = COLORS[record.levelname.lower()]
@@ -56,10 +55,9 @@ def format(record):
         except AttributeError:
             prefix = None
 
-        if prefix:
-            return f'{click.style(record.levelname.capitalize(), fg=fg, bold=True)}: {record.msg % record.args}'
+        formatted = super().format(record)
 
-        if record.args:
-            return f'{record.msg % record.args}'
+        if prefix:
+            return f'{click.style(record.levelname.capitalize(), fg=fg, bold=True)}: {formatted}'
 
-        return record.msg
+        return formatted

tests/cmdline/utils/test_log.py

@@ -19,25 +19,37 @@ def test_cli_formatter():
     Note that if it contains percentage signs but no arguments, it should not try to convert it.
     """
     message = 'message'
-    record = logging.LogRecord('name', logging.INFO, 'pathname', 0, message, (), 'exc_info')
-    assert log.CliFormatter.format(record) == message
+    record = logging.LogRecord('name', logging.INFO, 'pathname', 0, message, (), None)
+    assert log.CliFormatter().format(record) == message
 
 
 def test_cli_formatter_no_args():
     """Test the ``CliFormatter.format`` method for a message with percentage signs but no args."""
     message = 'PID    MEM %    CPU %  started'
-    record = logging.LogRecord('name', logging.INFO, 'pathname', 0, message, (), 'exc_info')
-    assert log.CliFormatter.format(record) == message
+    record = logging.LogRecord('name', logging.INFO, 'pathname', 0, message, (), None)
+    assert log.CliFormatter().format(record) == message
+
+
+def test_cli_formatter_named_parameters():
+    """Test the ``CliFormatter.format`` method for a message with named parameters but no args.
+
+    This can occur for example when logging prepared SQL queries. These contain named parameters, but are not actually
+    intended to be filled with arguments passed to the logging call but are supposed to be kept as is. When no arguments
+    are passed in the log record, this should not except.
+    """
+    message = 'SELECT t.pk FROM t WHERE t.pk = %(pk_1)s'
+    record = logging.LogRecord('name', logging.INFO, 'pathname', 0, message, (), None)
+    assert log.CliFormatter().format(record) == message
 
 
 def test_cli_formatter_args():
     """Test the ``CliFormatter.format`` method for a message with a single argument."""
-    record = logging.LogRecord('name', logging.INFO, 'pathname', 0, 'Some %s', ('value',), 'exc_info')
-    assert log.CliFormatter.format(record) == 'Some value'
+    record = logging.LogRecord('name', logging.INFO, 'pathname', 0, 'Some %s', ('value',), None)
+    assert log.CliFormatter().format(record) == 'Some value'
 
 
 def test_cli_formatter_prefix():
     """Test the ``CliFormatter.format`` method for a message with a single argument."""
-    record = logging.LogRecord('name', logging.INFO, 'pathname', 0, 'Some %s', ('value',), 'exc_info')
+    record = logging.LogRecord('name', logging.INFO, 'pathname', 0, 'Some %s', ('value',), None)
     record.prefix = True
-    assert log.CliFormatter.format(record) == '\x1b[34m\x1b[1mInfo\x1b[0m: Some value'
+    assert log.CliFormatter().format(record) == '\x1b[34m\x1b[1mInfo\x1b[0m: Some value'